2 * This file is part of DisOrder
3 * Copyright (C) 2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file disobedience/users.c
21 * @brief User management for Disobedience
23 * The user management window contains:
24 * - a list of all the users
27 * - a user details panel
30 * When you select a user that user's details are displayed to the right of the
31 * list. Hit the Apply button and any changes are applied.
33 * When you select 'add' a new empty set of details are displayed to be edited.
34 * Again Apply will commit them.
37 * - enter new username in the GtkTreeView
38 * - escape and enter keys should work
39 * - should have a cancel or close button, consistent with properties and login
42 #include "disobedience.h"
45 static GtkWidget
*users_window
;
46 static GtkListStore
*users_list
;
47 static GtkTreeSelection
*users_selection
;
49 static GtkWidget
*users_details_table
;
50 static GtkWidget
*users_apply_button
;
51 static GtkWidget
*users_delete_button
;
52 static GtkWidget
*users_details_name
;
53 static GtkWidget
*users_details_email
;
54 static GtkWidget
*users_details_password
;
55 static GtkWidget
*users_details_password2
;
56 static GtkWidget
*users_details_rights
[32];
57 static int users_details_row
;
58 static const char *users_selected
;
59 static const char *users_deferred_select
;
61 static int users_mode
;
66 #define mode(X) do { \
67 users_mode = MODE_##X; \
68 if(0) fprintf(stderr, "%s:%d: %s(): mode -> %s\n", \
69 __FILE__, __LINE__, __FUNCTION__, #X); \
70 users_details_sensitize_all(); \
73 static const char *users_email
, *users_rights
, *users_password
;
75 /** @brief qsort() callback for username comparison */
76 static int usercmp(const void *a
, const void *b
) {
77 return strcmp(*(char **)a
, *(char **)b
);
80 /** @brief Find a user
81 * @param user User to find
82 * @param iter Iterator to point at user
83 * @return 0 on success, -1 if not found
85 static int users_find_user(const char *user
,
90 if(!gtk_tree_model_get_iter_first(GTK_TREE_MODEL(users_list
), iter
))
93 gtk_tree_model_get(GTK_TREE_MODEL(users_list
), iter
,
95 if(!strcmp(who
, user
)) {
100 } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(users_list
), iter
));
104 /** @brief Called with the list of users
107 * - at startup to populate the initial list
108 * - when we add a user
109 * - maybe in the future when we delete a user
111 * If users_deferred_select is set then that user is selected.
113 static void users_got_list(void attribute((unused
)) *v
,
115 int nvec
, char **vec
) {
120 popup_protocol_error(0, error
);
123 /* Present users in alphabetical order */
124 qsort(vec
, nvec
, sizeof (char *), usercmp
);
125 /* Set the list contents */
126 gtk_list_store_clear(users_list
);
127 for(n
= 0; n
< nvec
; ++n
)
128 gtk_list_store_insert_with_values(users_list
, &iter
, n
/*position*/,
129 0, vec
[n
], /* column 0 */
130 -1); /* no more columns */
131 /* Only show the window when the list is populated */
132 gtk_widget_show_all(users_window
);
133 if(users_deferred_select
) {
134 if(!users_find_user(users_deferred_select
, &iter
))
135 gtk_tree_selection_select_iter(users_selection
, &iter
);
136 users_deferred_select
= 0;
140 /** @brief Text should be visible */
141 #define DETAIL_VISIBLE 1
143 /** @brief Text should be editable */
144 #define DETAIL_EDITABLE 2
146 /** @brief Add a row to the user detail table */
147 static void users_detail_generic(const char *title
,
148 GtkWidget
*selector
) {
149 const int row
= users_details_row
++;
150 GtkWidget
*const label
= gtk_label_new(title
);
151 gtk_misc_set_alignment(GTK_MISC(label
), 1, 0);
152 gtk_table_attach(GTK_TABLE(users_details_table
),
154 0, 1, /* left/right_attach */
155 row
, row
+1, /* top/bottom_attach */
156 GTK_FILL
, /* xoptions */
158 1, 1); /* x/ypadding */
159 gtk_table_attach(GTK_TABLE(users_details_table
),
161 1, 2, /* left/right_attach */
162 row
, row
+ 1, /* top/bottom_attach */
163 GTK_EXPAND
|GTK_FILL
, /* xoptions */
164 GTK_FILL
, /* yoptions */
165 1, 1); /* x/ypadding */
168 /** @brief Add a row to the user details table
169 * @param entryp Where to put GtkEntry
170 * @param title Label for this row
171 * @param value Initial value or NULL
172 * @param flags Flags word
174 static void users_add_detail(GtkWidget
**entryp
,
180 if(!(entry
= *entryp
)) {
181 *entryp
= entry
= gtk_entry_new();
182 users_detail_generic(title
, entry
);
184 gtk_entry_set_visibility(GTK_ENTRY(entry
),
185 !!(flags
& DETAIL_VISIBLE
));
186 gtk_editable_set_editable(GTK_EDITABLE(entry
),
187 !!(flags
& DETAIL_EDITABLE
));
188 gtk_entry_set_text(GTK_ENTRY(entry
), value ? value
: "");
191 /** @brief Add a checkbox for a right
192 * @param title Label for this row
193 * @param value Current value
194 * @param right Right bit
196 static void users_add_right(const char *title
,
200 GtkWidget
**checkp
= &users_details_rights
[leftmost_bit(right
)];
202 if(!(check
= *checkp
)) {
203 *checkp
= check
= gtk_check_button_new_with_label("");
204 users_detail_generic(title
, check
);
206 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(check
), !!(value
& right
));
209 /** @brief Set sensitivity of particular mine/random rights bits */
210 static void users_details_sensitize(rights_type r
) {
211 const int bit
= leftmost_bit(r
);
212 const GtkWidget
*all
= users_details_rights
[bit
];
213 const int sensitive
= (!gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(all
))
214 && users_mode
!= MODE_NONE
);
216 gtk_widget_set_sensitive(users_details_rights
[bit
+ 1], sensitive
);
217 gtk_widget_set_sensitive(users_details_rights
[bit
+ 2], sensitive
);
220 /** @brief Set sensitivity of everything in sight */
221 static void users_details_sensitize_all(void) {
224 for(n
= 0; n
< 32; ++n
)
225 if(users_details_rights
[n
])
226 gtk_widget_set_sensitive(users_details_rights
[n
], users_mode
!= MODE_NONE
);
227 gtk_widget_set_sensitive(users_details_name
, users_mode
!= MODE_NONE
);
228 gtk_widget_set_sensitive(users_details_email
, users_mode
!= MODE_NONE
);
229 gtk_widget_set_sensitive(users_details_password
, users_mode
!= MODE_NONE
);
230 gtk_widget_set_sensitive(users_details_password2
, users_mode
!= MODE_NONE
);
231 users_details_sensitize(RIGHT_MOVE_ANY
);
232 users_details_sensitize(RIGHT_REMOVE_ANY
);
233 users_details_sensitize(RIGHT_SCRATCH_ANY
);
234 gtk_widget_set_sensitive(users_apply_button
, users_mode
!= MODE_NONE
);
235 gtk_widget_set_sensitive(users_delete_button
, !!users_selected
);
238 /** @brief Called when an _ALL widget is toggled
240 * Modifies sensitivity of the corresponding _MINE and _RANDOM widgets. We
241 * just do the lot rather than trying to figure out which one changed,
243 static void users_any_toggled(GtkToggleButton
attribute((unused
)) *togglebutton
,
244 gpointer
attribute((unused
)) user_data
) {
245 users_details_sensitize_all();
248 /** @brief Add a checkbox for a three-right group
249 * @param title Label for this row
250 * @param bits Rights bits (not masked or normalized)
251 * @param mask Mask for this group (must be 7*2^n)
253 static void users_add_right_group(const char *title
,
256 const uint32_t first
= mask
/ 7;
257 const int bit
= leftmost_bit(first
);
258 GtkWidget
**widgets
= &users_details_rights
[bit
], *any
, *mine
, *rnd
;
261 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 2);
263 any
= widgets
[0] = gtk_check_button_new_with_label("Any");
264 mine
= widgets
[1] = gtk_check_button_new_with_label("Own");
265 rnd
= widgets
[2] = gtk_check_button_new_with_label("Random");
266 gtk_box_pack_start(GTK_BOX(hbox
), any
, FALSE
, FALSE
, 0);
267 gtk_box_pack_start(GTK_BOX(hbox
), mine
, FALSE
, FALSE
, 0);
268 gtk_box_pack_start(GTK_BOX(hbox
), rnd
, FALSE
, FALSE
, 0);
269 users_detail_generic(title
, hbox
);
270 g_signal_connect(any
, "toggled", G_CALLBACK(users_any_toggled
), NULL
);
271 users_details_rights
[bit
] = any
;
272 users_details_rights
[bit
+ 1] = mine
;
273 users_details_rights
[bit
+ 2] = rnd
;
279 /* Discard irrelevant bits */
281 /* Shift down to bits 0-2; the mask is always 3 contiguous bits */
283 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(any
), !!(bits
& 1));
284 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mine
), !!(bits
& 2));
285 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(rnd
), !!(bits
& 4));
288 /** @brief Called when the details table is destroyed */
289 static void users_details_destroyed(GtkWidget
attribute((unused
)) *widget
,
290 GtkWidget
attribute((unused
)) **wp
) {
291 users_details_table
= 0;
292 g_object_unref(users_list
);
294 users_details_name
= 0;
295 users_details_email
= 0;
296 users_details_password
= 0;
297 users_details_password2
= 0;
298 memset(users_details_rights
, 0, sizeof users_details_rights
);
299 /* also users_selection? Not AFAICT; _get_selection does upref */
302 /** @brief Create or modify the user details table
303 * @param name User name (users_edit()) or NULL (users_add())
304 * @param email Email address
305 * @param rights User rights string
306 * @param password Password
308 static void users_makedetails(const char *name
,
311 const char *password
,
316 /* Create the table if it doesn't already exist */
317 if(!users_details_table
) {
318 users_details_table
= gtk_table_new(4, 2, FALSE
/*!homogeneous*/);
319 g_signal_connect(users_details_table
, "destroy",
320 G_CALLBACK(users_details_destroyed
), 0);
323 /* Create or update the widgets */
324 users_add_detail(&users_details_name
, "Username", name
,
325 (DETAIL_EDITABLE
|DETAIL_VISIBLE
) & nameflags
);
327 users_add_detail(&users_details_email
, "Email", email
,
328 (DETAIL_EDITABLE
|DETAIL_VISIBLE
) & flags
);
330 users_add_detail(&users_details_password
, "Password", password
,
331 DETAIL_EDITABLE
& flags
);
332 users_add_detail(&users_details_password2
, "Password", password
,
333 DETAIL_EDITABLE
& flags
);
335 parse_rights(rights
, &r
, 0);
336 users_add_right("Read operations", r
, RIGHT_READ
);
337 users_add_right("Play track", r
, RIGHT_PLAY
);
338 users_add_right_group("Move", r
, RIGHT_MOVE__MASK
);
339 users_add_right_group("Remove", r
, RIGHT_REMOVE__MASK
);
340 users_add_right_group("Scratch", r
, RIGHT_SCRATCH__MASK
);
341 users_add_right("Set volume", r
, RIGHT_VOLUME
);
342 users_add_right("Admin operations", r
, RIGHT_ADMIN
);
343 users_add_right("Rescan", r
, RIGHT_RESCAN
);
344 users_add_right("Register new users", r
, RIGHT_REGISTER
);
345 users_add_right("Modify own userinfo", r
, RIGHT_USERINFO
);
346 users_add_right("Modify track preferences", r
, RIGHT_PREFS
);
347 users_add_right("Modify global preferences", r
, RIGHT_GLOBAL_PREFS
);
348 users_add_right("Pause/resume tracks", r
, RIGHT_PAUSE
);
349 users_details_sensitize_all();
352 /** @brief Called when the 'add' button is pressed */
353 static void users_add(GtkButton
attribute((unused
)) *button
,
354 gpointer
attribute((unused
)) userdata
) {
355 /* Unselect whatever is selected */
356 gtk_tree_selection_unselect_all(users_selection
);
358 /* TODO it would be better to use the server default_rights if there's no
360 users_makedetails("",
362 config
->default_rights
,
364 DETAIL_EDITABLE
|DETAIL_VISIBLE
,
365 DETAIL_EDITABLE
|DETAIL_VISIBLE
);
366 /* Remember we're adding a user */
370 static rights_type
users_get_rights(void) {
374 /* Extract the rights value */
375 for(n
= 0; n
< 32; ++n
) {
376 if(users_details_rights
[n
])
377 if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(users_details_rights
[n
])))
380 /* Throw out redundant bits */
381 if(r
& RIGHT_REMOVE_ANY
)
382 r
&= ~(rights_type
)(RIGHT_REMOVE_MINE
|RIGHT_REMOVE_RANDOM
);
383 if(r
& RIGHT_MOVE_ANY
)
384 r
&= ~(rights_type
)(RIGHT_MOVE_MINE
|RIGHT_MOVE_RANDOM
);
385 if(r
& RIGHT_SCRATCH_ANY
)
386 r
&= ~(rights_type
)(RIGHT_SCRATCH_MINE
|RIGHT_SCRATCH_RANDOM
);
390 /** @brief Called when a user setting has been edited */
391 static void users_edituser_completed(void attribute((unused
)) *v
,
394 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, error
);
397 /** @brief Called when a new user has been created */
398 static void users_adduser_completed(void *v
,
401 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, error
);
402 mode(ADD
); /* Let the user try again */
404 const struct kvp
*const kvp
= v
;
405 const char *user
= kvp_get(kvp
, "user");
406 const char *email
= kvp_get(kvp
, "email"); /* maybe NULL */
408 /* Now the user is created we can go ahead and set the email address */
410 disorder_eclient_edituser(client
, users_edituser_completed
, user
,
411 "email", email
, NULL
);
412 /* Refresh the list of users */
413 disorder_eclient_users(client
, users_got_list
, 0);
414 /* We'll select the newly created user */
415 users_deferred_select
= user
;
419 /** @brief Called when the 'Apply' button is pressed */
420 static void users_apply(GtkButton
attribute((unused
)) *button
,
421 gpointer
attribute((unused
)) userdata
) {
422 const char *password
;
423 const char *password2
;
431 name
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_name
)));
432 email
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_email
)));
433 password
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password
)));
434 password2
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password2
)));
436 /* No username. Really we wanted to desensitize the Apply button when
437 * there's no userame but there doesn't seem to be a signal to detect
438 * changes to the entry text. Consequently we have error messages
440 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Must enter a username");
443 if(strcmp(password
, password2
)) {
444 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Passwords do not match");
447 if(*email
&& !strchr(email
, '@')) {
448 /* The server will complain about this but we can give a better error
449 * message this way */
450 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Invalid email address");
453 disorder_eclient_adduser(client
,
454 users_adduser_completed
,
457 rights_string(users_get_rights()),
458 kvp_make("user", name
,
461 /* We switch to no-op mode while creating the user */
465 /* Ugh, can we de-dupe with above? */
466 email
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_email
)));
467 password
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password
)));
468 password2
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password2
)));
469 if(strcmp(password
, password2
)) {
470 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Passwords do not match");
473 if(*email
&& !strchr(email
, '@')) {
474 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Invalid email address");
477 disorder_eclient_edituser(client
, users_edituser_completed
, users_selected
,
478 "email", email
, NULL
);
479 disorder_eclient_edituser(client
, users_edituser_completed
, users_selected
,
480 "password", password
, NULL
);
481 disorder_eclient_edituser(client
, users_edituser_completed
, users_selected
,
482 "rights", rights_string(users_get_rights()), NULL
);
483 /* We remain in edit mode */
488 /** @brief Called when a user has been deleted */
489 static void users_delete_completed(void *v
,
492 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, error
);
494 const struct kvp
*const kvp
= v
;
495 const char *const user
= kvp_get(kvp
, "user");
498 if(!users_find_user(user
, iter
)) /* Find the user... */
499 gtk_list_store_remove(users_list
, iter
); /* ...and remove them */
503 /** @brief Called when the 'Delete' button is pressed */
504 static void users_delete(GtkButton
attribute((unused
)) *button
,
505 gpointer
attribute((unused
)) userdata
) {
511 yesno
= gtk_message_dialog_new(GTK_WINDOW(users_window
),
513 GTK_MESSAGE_QUESTION
,
515 "Do you really want to delete user %s?"
516 " This action cannot be undone.",
518 res
= gtk_dialog_run(GTK_DIALOG(yesno
));
519 gtk_widget_destroy(yesno
);
520 if(res
== GTK_RESPONSE_YES
) {
521 disorder_eclient_deluser(client
, users_delete_completed
, users_selected
,
522 kvp_make("user", users_selected
,
527 static void users_got_email(void attribute((unused
)) *v
,
531 popup_protocol_error(0, error
);
535 static void users_got_rights(void attribute((unused
)) *v
,
539 popup_protocol_error(0, error
);
540 users_rights
= value
;
543 static void users_got_password(void attribute((unused
)) *v
,
547 popup_protocol_error(0, error
);
548 /* TODO if an error occurred gathering user info, we should react in some
550 users_password
= value
;
551 users_makedetails(users_selected
,
556 DETAIL_EDITABLE
|DETAIL_VISIBLE
);
560 /** @brief Called when the selection MIGHT have changed */
561 static void users_selection_changed(GtkTreeSelection
attribute((unused
)) *treeselection
,
562 gpointer
attribute((unused
)) user_data
) {
564 char *gselected
, *selected
;
566 /* Identify the current selection */
567 if(gtk_tree_selection_get_selected(users_selection
, 0, &iter
)) {
568 gtk_tree_model_get(GTK_TREE_MODEL(users_list
), &iter
,
570 selected
= xstrdup(gselected
);
574 /* Eliminate no-change cases */
575 if(!selected
&& !users_selected
)
577 if(selected
&& users_selected
&& !strcmp(selected
, users_selected
))
579 /* There's been a change; junk the old data and fetch new data in
581 users_selected
= selected
;
582 users_makedetails("", "", "", "",
586 disorder_eclient_userinfo(client
, users_got_email
, users_selected
,
588 disorder_eclient_userinfo(client
, users_got_rights
, users_selected
,
590 disorder_eclient_userinfo(client
, users_got_password
, users_selected
,
593 mode(NONE
); /* not editing *yet* */
596 /** @brief Table of buttons below the user list */
597 static struct button users_buttons
[] = {
611 #define NUSERS_BUTTONS (sizeof users_buttons / sizeof *users_buttons)
613 /** @brief Pop up the user management window */
614 void manage_users(void) {
615 GtkWidget
*tree
, *buttons
, *hbox
, *hbox2
, *vbox
, *vbox2
;
617 GtkTreeViewColumn
*col
;
619 /* If the window already exists just raise it */
621 gtk_window_present(GTK_WINDOW(users_window
));
624 /* Create the window */
625 users_window
= gtk_window_new(GTK_WINDOW_TOPLEVEL
);
626 gtk_widget_set_style(users_window
, tool_style
);
627 g_signal_connect(users_window
, "destroy",
628 G_CALLBACK(gtk_widget_destroyed
), &users_window
);
629 gtk_window_set_title(GTK_WINDOW(users_window
), "User Management");
630 /* default size is too small */
631 gtk_window_set_default_size(GTK_WINDOW(users_window
), 240, 240);
633 /* Create the list of users and populate it asynchronously */
634 users_list
= gtk_list_store_new(1, G_TYPE_STRING
);
635 disorder_eclient_users(client
, users_got_list
, 0);
636 /* Create the view */
637 tree
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(users_list
));
638 /* ...and the renderers for it */
639 cr
= gtk_cell_renderer_text_new();
640 col
= gtk_tree_view_column_new_with_attributes("Username",
644 gtk_tree_view_append_column(GTK_TREE_VIEW(tree
), col
);
645 /* Get the selection for the view; set its mode; arrange for a callback when
647 users_selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tree
));
648 gtk_tree_selection_set_mode(users_selection
, GTK_SELECTION_BROWSE
);
649 g_signal_connect(users_selection
, "changed",
650 G_CALLBACK(users_selection_changed
), NULL
);
652 /* Create the control buttons */
653 buttons
= create_buttons_box(users_buttons
,
655 gtk_hbox_new(FALSE
, 1));
656 users_delete_button
= users_buttons
[1].widget
;
658 /* Buttons live below the list */
659 vbox
= gtk_vbox_new(FALSE
, 0);
660 gtk_box_pack_start(GTK_BOX(vbox
), scroll_widget(tree
), TRUE
/*expand*/, TRUE
/*fill*/, 0);
661 gtk_box_pack_start(GTK_BOX(vbox
), buttons
, FALSE
/*expand*/, FALSE
, 0);
663 /* Create an empty user details table, and put an apply button below it */
664 users_apply_button
= gtk_button_new_from_stock(GTK_STOCK_APPLY
);
665 users_makedetails("", "", "", "",
668 g_signal_connect(users_apply_button
, "clicked",
669 G_CALLBACK(users_apply
), NULL
);
670 hbox2
= gtk_hbox_new(FALSE
, 0);
671 gtk_box_pack_end(GTK_BOX(hbox2
), users_apply_button
,
672 FALSE
/*expand*/, FALSE
, 0);
674 vbox2
= gtk_vbox_new(FALSE
, 0);
675 gtk_box_pack_start(GTK_BOX(vbox2
), users_details_table
,
676 TRUE
/*expand*/, TRUE
/*fill*/, 0);
677 gtk_box_pack_start(GTK_BOX(vbox2
), hbox2
,
678 FALSE
/*expand*/, FALSE
, 0);
680 /* User details are to the right of the list. We put in a pointless event
681 * box as as spacer, so that the longest label in the user details isn't
682 * cuddled up to the user list. */
683 hbox
= gtk_hbox_new(FALSE
, 0);
684 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, FALSE
/*expand*/, FALSE
, 0);
685 gtk_box_pack_start(GTK_BOX(hbox
), gtk_event_box_new(), FALSE
/*expand*/, FALSE
, 2);
686 gtk_box_pack_start(GTK_BOX(hbox
), vbox2
, TRUE
/*expand*/, TRUE
/*fill*/, 0);
687 gtk_container_add(GTK_CONTAINER(users_window
), frame_widget(hbox
, NULL
));