0590d699b67157aa69d90d03c9614d167c64ccbf
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.
36 * TODO: it would be really nice if the Username entry could be removed and new
37 * user names entered in the list, rather off in the details panel. This may
38 * be possible with a sufficiently clever GtkCellRenderer.
41 #include "disobedience.h"
44 static GtkWidget
*users_window
;
45 static GtkListStore
*users_list
;
46 static GtkTreeSelection
*users_selection
;
48 static GtkWidget
*users_details_table
;
49 static GtkWidget
*users_apply_button
;
50 static GtkWidget
*users_delete_button
;
51 static GtkWidget
*users_details_name
;
52 static GtkWidget
*users_details_email
;
53 static GtkWidget
*users_details_password
;
54 static GtkWidget
*users_details_password2
;
55 static GtkWidget
*users_details_rights
[32];
56 static int users_details_row
;
57 static const char *users_selected
;
58 static const char *users_deferred_select
;
60 static int users_mode
;
65 #define mode(X) do { \
66 users_mode = MODE_##X; \
67 if(0) fprintf(stderr, "%s:%d: %s(): mode -> %s\n", \
68 __FILE__, __LINE__, __FUNCTION__, #X); \
69 users_details_sensitize_all(); \
72 static const char *users_email
, *users_rights
, *users_password
;
74 /** @brief qsort() callback for username comparison */
75 static int usercmp(const void *a
, const void *b
) {
76 return strcmp(*(char **)a
, *(char **)b
);
79 /** @brief Find a user
80 * @param user User to find
81 * @param iter Iterator to point at user
82 * @return 0 on success, -1 if not found
84 static int users_find_user(const char *user
,
89 if(!gtk_tree_model_get_iter_first(GTK_TREE_MODEL(users_list
), iter
))
92 gtk_tree_model_get(GTK_TREE_MODEL(users_list
), iter
,
94 if(!strcmp(who
, user
)) {
99 } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(users_list
), iter
));
103 /** @brief Called with the list of users
106 * - at startup to populate the initial list
107 * - when we add a user
108 * - maybe in the future when we delete a user
110 * If users_deferred_select is set then that user is selected.
112 static void users_got_list(void attribute((unused
)) *v
,
114 int nvec
, char **vec
) {
119 popup_protocol_error(0, error
);
122 /* Present users in alphabetical order */
123 qsort(vec
, nvec
, sizeof (char *), usercmp
);
124 /* Set the list contents */
125 gtk_list_store_clear(users_list
);
126 for(n
= 0; n
< nvec
; ++n
)
127 gtk_list_store_insert_with_values(users_list
, &iter
, n
/*position*/,
128 0, vec
[n
], /* column 0 */
129 -1); /* no more columns */
130 /* Only show the window when the list is populated */
131 gtk_widget_show_all(users_window
);
132 if(users_deferred_select
) {
133 if(!users_find_user(users_deferred_select
, &iter
))
134 gtk_tree_selection_select_iter(users_selection
, &iter
);
135 users_deferred_select
= 0;
139 /** @brief Text should be visible */
140 #define DETAIL_VISIBLE 1
142 /** @brief Text should be editable */
143 #define DETAIL_EDITABLE 2
145 /** @brief Add a row to the user detail table */
146 static void users_detail_generic(const char *title
,
147 GtkWidget
*selector
) {
148 const int row
= users_details_row
++;
149 GtkWidget
*const label
= gtk_label_new(title
);
150 gtk_misc_set_alignment(GTK_MISC(label
), 1, 0);
151 gtk_table_attach(GTK_TABLE(users_details_table
),
153 0, 1, /* left/right_attach */
154 row
, row
+1, /* top/bottom_attach */
155 GTK_FILL
, /* xoptions */
157 1, 1); /* x/ypadding */
158 gtk_table_attach(GTK_TABLE(users_details_table
),
160 1, 2, /* left/right_attach */
161 row
, row
+ 1, /* top/bottom_attach */
162 GTK_EXPAND
|GTK_FILL
, /* xoptions */
163 GTK_FILL
, /* yoptions */
164 1, 1); /* x/ypadding */
167 /** @brief Add a row to the user details table
168 * @param entryp Where to put GtkEntry
169 * @param title Label for this row
170 * @param value Initial value or NULL
171 * @param flags Flags word
173 static void users_add_detail(GtkWidget
**entryp
,
179 if(!(entry
= *entryp
)) {
180 *entryp
= entry
= gtk_entry_new();
181 users_detail_generic(title
, entry
);
183 gtk_entry_set_visibility(GTK_ENTRY(entry
),
184 !!(flags
& DETAIL_VISIBLE
));
185 gtk_editable_set_editable(GTK_EDITABLE(entry
),
186 !!(flags
& DETAIL_EDITABLE
));
187 gtk_entry_set_text(GTK_ENTRY(entry
), value ? value
: "");
190 /** @brief Add a checkbox for a right
191 * @param title Label for this row
192 * @param value Current value
193 * @param right Right bit
195 static void users_add_right(const char *title
,
199 GtkWidget
**checkp
= &users_details_rights
[leftmost_bit(right
)];
201 if(!(check
= *checkp
)) {
202 *checkp
= check
= gtk_check_button_new_with_label("");
203 users_detail_generic(title
, check
);
205 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(check
), !!(value
& right
));
208 /** @brief Set sensitivity of particular mine/random rights bits */
209 static void users_details_sensitize(rights_type r
) {
210 const int bit
= leftmost_bit(r
);
211 const GtkWidget
*all
= users_details_rights
[bit
];
212 const int sensitive
= (!gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(all
))
213 && users_mode
!= MODE_NONE
);
215 gtk_widget_set_sensitive(users_details_rights
[bit
+ 1], sensitive
);
216 gtk_widget_set_sensitive(users_details_rights
[bit
+ 2], sensitive
);
219 /** @brief Set sensitivity of everything in sight */
220 static void users_details_sensitize_all(void) {
223 for(n
= 0; n
< 32; ++n
)
224 if(users_details_rights
[n
])
225 gtk_widget_set_sensitive(users_details_rights
[n
], users_mode
!= MODE_NONE
);
226 gtk_widget_set_sensitive(users_details_name
, users_mode
!= MODE_NONE
);
227 gtk_widget_set_sensitive(users_details_email
, users_mode
!= MODE_NONE
);
228 gtk_widget_set_sensitive(users_details_password
, users_mode
!= MODE_NONE
);
229 gtk_widget_set_sensitive(users_details_password2
, users_mode
!= MODE_NONE
);
230 users_details_sensitize(RIGHT_MOVE_ANY
);
231 users_details_sensitize(RIGHT_REMOVE_ANY
);
232 users_details_sensitize(RIGHT_SCRATCH_ANY
);
233 gtk_widget_set_sensitive(users_apply_button
, users_mode
!= MODE_NONE
);
234 gtk_widget_set_sensitive(users_delete_button
, !!users_selected
);
237 /** @brief Called when an _ALL widget is toggled
239 * Modifies sensitivity of the corresponding _MINE and _RANDOM widgets. We
240 * just do the lot rather than trying to figure out which one changed,
242 static void users_any_toggled(GtkToggleButton
attribute((unused
)) *togglebutton
,
243 gpointer
attribute((unused
)) user_data
) {
244 users_details_sensitize_all();
247 /** @brief Add a checkbox for a three-right group
248 * @param title Label for this row
249 * @param bits Rights bits (not masked or normalized)
250 * @param mask Mask for this group (must be 7*2^n)
252 static void users_add_right_group(const char *title
,
255 const uint32_t first
= mask
/ 7;
256 const int bit
= leftmost_bit(first
);
257 GtkWidget
**widgets
= &users_details_rights
[bit
], *any
, *mine
, *rnd
;
260 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 2);
262 any
= widgets
[0] = gtk_check_button_new_with_label("Any");
263 mine
= widgets
[1] = gtk_check_button_new_with_label("Own");
264 rnd
= widgets
[2] = gtk_check_button_new_with_label("Random");
265 gtk_box_pack_start(GTK_BOX(hbox
), any
, FALSE
, FALSE
, 0);
266 gtk_box_pack_start(GTK_BOX(hbox
), mine
, FALSE
, FALSE
, 0);
267 gtk_box_pack_start(GTK_BOX(hbox
), rnd
, FALSE
, FALSE
, 0);
268 users_detail_generic(title
, hbox
);
269 g_signal_connect(any
, "toggled", G_CALLBACK(users_any_toggled
), NULL
);
270 users_details_rights
[bit
] = any
;
271 users_details_rights
[bit
+ 1] = mine
;
272 users_details_rights
[bit
+ 2] = rnd
;
278 /* Discard irrelevant bits */
280 /* Shift down to bits 0-2; the mask is always 3 contiguous bits */
282 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(any
), !!(bits
& 1));
283 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(mine
), !!(bits
& 2));
284 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(rnd
), !!(bits
& 4));
287 /** @brief Called when the details table is destroyed */
288 static void users_details_destroyed(GtkWidget
attribute((unused
)) *widget
,
289 GtkWidget
attribute((unused
)) **wp
) {
290 users_details_table
= 0;
291 g_object_unref(users_list
);
293 users_details_name
= 0;
294 users_details_email
= 0;
295 users_details_password
= 0;
296 users_details_password2
= 0;
297 memset(users_details_rights
, 0, sizeof users_details_rights
);
298 /* also users_selection? Not AFAICT; _get_selection does upref */
301 /** @brief Create or modify the user details table
302 * @param name User name (users_edit()) or NULL (users_add())
303 * @param email Email address
304 * @param rights User rights string
305 * @param password Password
307 static void users_makedetails(const char *name
,
310 const char *password
,
315 /* Create the table if it doesn't already exist */
316 if(!users_details_table
) {
317 users_details_table
= gtk_table_new(4, 2, FALSE
/*!homogeneous*/);
318 g_signal_connect(users_details_table
, "destroy",
319 G_CALLBACK(users_details_destroyed
), 0);
322 /* Create or update the widgets */
323 users_add_detail(&users_details_name
, "Username", name
,
324 (DETAIL_EDITABLE
|DETAIL_VISIBLE
) & nameflags
);
326 users_add_detail(&users_details_email
, "Email", email
,
327 (DETAIL_EDITABLE
|DETAIL_VISIBLE
) & flags
);
329 users_add_detail(&users_details_password
, "Password", password
,
330 DETAIL_EDITABLE
& flags
);
331 users_add_detail(&users_details_password2
, "Password", password
,
332 DETAIL_EDITABLE
& flags
);
334 parse_rights(rights
, &r
, 0);
335 users_add_right("Read operations", r
, RIGHT_READ
);
336 users_add_right("Play track", r
, RIGHT_PLAY
);
337 users_add_right_group("Move", r
, RIGHT_MOVE__MASK
);
338 users_add_right_group("Remove", r
, RIGHT_REMOVE__MASK
);
339 users_add_right_group("Scratch", r
, RIGHT_SCRATCH__MASK
);
340 users_add_right("Set volume", r
, RIGHT_VOLUME
);
341 users_add_right("Admin operations", r
, RIGHT_ADMIN
);
342 users_add_right("Rescan", r
, RIGHT_RESCAN
);
343 users_add_right("Register new users", r
, RIGHT_REGISTER
);
344 users_add_right("Modify own userinfo", r
, RIGHT_USERINFO
);
345 users_add_right("Modify track preferences", r
, RIGHT_PREFS
);
346 users_add_right("Modify global preferences", r
, RIGHT_GLOBAL_PREFS
);
347 users_add_right("Pause/resume tracks", r
, RIGHT_PAUSE
);
348 users_details_sensitize_all();
351 /** @brief Called when the 'add' button is pressed */
352 static void users_add(GtkButton
attribute((unused
)) *button
,
353 gpointer
attribute((unused
)) userdata
) {
354 /* Unselect whatever is selected */
355 gtk_tree_selection_unselect_all(users_selection
);
357 /* TODO it would be better to use the server default_rights if there's no
359 users_makedetails("",
361 config
->default_rights
,
363 DETAIL_EDITABLE
|DETAIL_VISIBLE
,
364 DETAIL_EDITABLE
|DETAIL_VISIBLE
);
365 /* Remember we're adding a user */
369 static rights_type
users_get_rights(void) {
373 /* Extract the rights value */
374 for(n
= 0; n
< 32; ++n
) {
375 if(users_details_rights
[n
])
376 if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(users_details_rights
[n
])))
379 /* Throw out redundant bits */
380 if(r
& RIGHT_REMOVE_ANY
)
381 r
&= ~(rights_type
)(RIGHT_REMOVE_MINE
|RIGHT_REMOVE_RANDOM
);
382 if(r
& RIGHT_MOVE_ANY
)
383 r
&= ~(rights_type
)(RIGHT_MOVE_MINE
|RIGHT_MOVE_RANDOM
);
384 if(r
& RIGHT_SCRATCH_ANY
)
385 r
&= ~(rights_type
)(RIGHT_SCRATCH_MINE
|RIGHT_SCRATCH_RANDOM
);
389 /** @brief Called when a user setting has been edited */
390 static void users_edituser_completed(void attribute((unused
)) *v
,
393 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, error
);
396 /** @brief Called when a new user has been created */
397 static void users_adduser_completed(void *v
,
400 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, error
);
401 mode(ADD
); /* Let the user try again */
403 const struct kvp
*const kvp
= v
;
404 const char *user
= kvp_get(kvp
, "user");
405 const char *email
= kvp_get(kvp
, "email"); /* maybe NULL */
407 /* Now the user is created we can go ahead and set the email address */
409 disorder_eclient_edituser(client
, users_edituser_completed
, user
,
410 "email", email
, NULL
);
411 /* Refresh the list of users */
412 disorder_eclient_users(client
, users_got_list
, 0);
413 /* We'll select the newly created user */
414 users_deferred_select
= user
;
418 /** @brief Called when the 'Apply' button is pressed */
419 static void users_apply(GtkButton
attribute((unused
)) *button
,
420 gpointer
attribute((unused
)) userdata
) {
421 const char *password
;
422 const char *password2
;
430 name
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_name
)));
431 email
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_email
)));
432 password
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password
)));
433 password2
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password2
)));
435 /* No username. Really we wanted to desensitize the Apply button when
436 * there's no userame but there doesn't seem to be a signal to detect
437 * changes to the entry text. Consequently we have error messages
439 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Must enter a username");
442 if(strcmp(password
, password2
)) {
443 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Passwords do not match");
446 if(*email
&& !strchr(email
, '@')) {
447 /* The server will complain about this but we can give a better error
448 * message this way */
449 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Invalid email address");
452 disorder_eclient_adduser(client
,
453 users_adduser_completed
,
456 rights_string(users_get_rights()),
457 kvp_make("user", name
,
460 /* We switch to no-op mode while creating the user */
464 /* Ugh, can we de-dupe with above? */
465 email
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_email
)));
466 password
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password
)));
467 password2
= xstrdup(gtk_entry_get_text(GTK_ENTRY(users_details_password2
)));
468 if(strcmp(password
, password2
)) {
469 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Passwords do not match");
472 if(*email
&& !strchr(email
, '@')) {
473 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, "Invalid email address");
476 disorder_eclient_edituser(client
, users_edituser_completed
, users_selected
,
477 "email", email
, NULL
);
478 disorder_eclient_edituser(client
, users_edituser_completed
, users_selected
,
479 "password", password
, NULL
);
480 disorder_eclient_edituser(client
, users_edituser_completed
, users_selected
,
481 "rights", rights_string(users_get_rights()), NULL
);
482 /* We remain in edit mode */
487 /** @brief Called when a user has been deleted */
488 static void users_delete_completed(void *v
,
491 popup_submsg(users_window
, GTK_MESSAGE_ERROR
, error
);
493 const struct kvp
*const kvp
= v
;
494 const char *const user
= kvp_get(kvp
, "user");
497 if(!users_find_user(user
, iter
)) /* Find the user... */
498 gtk_list_store_remove(users_list
, iter
); /* ...and remove them */
502 /** @brief Called when the 'Delete' button is pressed */
503 static void users_delete(GtkButton
attribute((unused
)) *button
,
504 gpointer
attribute((unused
)) userdata
) {
510 yesno
= gtk_message_dialog_new(GTK_WINDOW(users_window
),
512 GTK_MESSAGE_QUESTION
,
514 "Do you really want to delete user %s?"
515 " This action cannot be undone.",
517 res
= gtk_dialog_run(GTK_DIALOG(yesno
));
518 gtk_widget_destroy(yesno
);
519 if(res
== GTK_RESPONSE_YES
) {
520 disorder_eclient_deluser(client
, users_delete_completed
, users_selected
,
521 kvp_make("user", users_selected
,
526 static void users_got_email(void attribute((unused
)) *v
,
530 popup_protocol_error(0, error
);
534 static void users_got_rights(void attribute((unused
)) *v
,
538 popup_protocol_error(0, error
);
539 users_rights
= value
;
542 static void users_got_password(void attribute((unused
)) *v
,
546 popup_protocol_error(0, error
);
547 /* TODO if an error occurred gathering user info, we should react in some
549 users_password
= value
;
550 users_makedetails(users_selected
,
555 DETAIL_EDITABLE
|DETAIL_VISIBLE
);
559 /** @brief Called when the selection MIGHT have changed */
560 static void users_selection_changed(GtkTreeSelection
attribute((unused
)) *treeselection
,
561 gpointer
attribute((unused
)) user_data
) {
563 char *gselected
, *selected
;
565 /* Identify the current selection */
566 if(gtk_tree_selection_get_selected(users_selection
, 0, &iter
)) {
567 gtk_tree_model_get(GTK_TREE_MODEL(users_list
), &iter
,
569 selected
= xstrdup(gselected
);
573 /* Eliminate no-change cases */
574 if(!selected
&& !users_selected
)
576 if(selected
&& users_selected
&& !strcmp(selected
, users_selected
))
578 /* There's been a change; junk the old data and fetch new data in
580 users_selected
= selected
;
581 users_makedetails("", "", "", "",
585 disorder_eclient_userinfo(client
, users_got_email
, users_selected
,
587 disorder_eclient_userinfo(client
, users_got_rights
, users_selected
,
589 disorder_eclient_userinfo(client
, users_got_password
, users_selected
,
592 mode(NONE
); /* not editing *yet* */
595 /** @brief Table of buttons below the user list */
596 static struct button users_buttons
[] = {
610 #define NUSERS_BUTTONS (sizeof users_buttons / sizeof *users_buttons)
612 /** @brief Pop up the user management window */
613 void manage_users(void) {
614 GtkWidget
*tree
, *buttons
, *hbox
, *hbox2
, *vbox
, *vbox2
;
616 GtkTreeViewColumn
*col
;
618 /* If the window already exists just raise it */
620 gtk_window_present(GTK_WINDOW(users_window
));
623 /* Create the window */
624 users_window
= gtk_window_new(GTK_WINDOW_TOPLEVEL
);
625 gtk_widget_set_style(users_window
, tool_style
);
626 g_signal_connect(users_window
, "destroy",
627 G_CALLBACK(gtk_widget_destroyed
), &users_window
);
628 gtk_window_set_title(GTK_WINDOW(users_window
), "User Management");
629 /* default size is too small */
630 gtk_window_set_default_size(GTK_WINDOW(users_window
), 240, 240);
632 /* Create the list of users and populate it asynchronously */
633 users_list
= gtk_list_store_new(1, G_TYPE_STRING
);
634 disorder_eclient_users(client
, users_got_list
, 0);
635 /* Create the view */
636 tree
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(users_list
));
637 /* ...and the renderers for it */
638 cr
= gtk_cell_renderer_text_new();
639 col
= gtk_tree_view_column_new_with_attributes("Username",
643 gtk_tree_view_append_column(GTK_TREE_VIEW(tree
), col
);
644 /* Get the selection for the view; set its mode; arrange for a callback when
646 users_selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tree
));
647 gtk_tree_selection_set_mode(users_selection
, GTK_SELECTION_BROWSE
);
648 g_signal_connect(users_selection
, "changed",
649 G_CALLBACK(users_selection_changed
), NULL
);
651 /* Create the control buttons */
652 buttons
= create_buttons_box(users_buttons
,
654 gtk_hbox_new(FALSE
, 1));
655 users_delete_button
= users_buttons
[1].widget
;
657 /* Buttons live below the list */
658 vbox
= gtk_vbox_new(FALSE
, 0);
659 gtk_box_pack_start(GTK_BOX(vbox
), scroll_widget(tree
), TRUE
/*expand*/, TRUE
/*fill*/, 0);
660 gtk_box_pack_start(GTK_BOX(vbox
), buttons
, FALSE
/*expand*/, FALSE
, 0);
662 /* Create an empty user details table, and put an apply button below it */
663 users_apply_button
= gtk_button_new_from_stock(GTK_STOCK_APPLY
);
664 users_makedetails("", "", "", "",
667 g_signal_connect(users_apply_button
, "clicked",
668 G_CALLBACK(users_apply
), NULL
);
669 hbox2
= gtk_hbox_new(FALSE
, 0);
670 gtk_box_pack_end(GTK_BOX(hbox2
), users_apply_button
,
671 FALSE
/*expand*/, FALSE
, 0);
673 vbox2
= gtk_vbox_new(FALSE
, 0);
674 gtk_box_pack_start(GTK_BOX(vbox2
), users_details_table
,
675 TRUE
/*expand*/, TRUE
/*fill*/, 0);
676 gtk_box_pack_start(GTK_BOX(vbox2
), hbox2
,
677 FALSE
/*expand*/, FALSE
, 0);
679 /* User details are to the right of the list. We put in a pointless event
680 * box as as spacer, so that the longest label in the user details isn't
681 * cuddled up to the user list. */
682 hbox
= gtk_hbox_new(FALSE
, 0);
683 gtk_box_pack_start(GTK_BOX(hbox
), vbox
, FALSE
/*expand*/, FALSE
, 0);
684 gtk_box_pack_start(GTK_BOX(hbox
), gtk_event_box_new(), FALSE
/*expand*/, FALSE
, 2);
685 gtk_box_pack_start(GTK_BOX(hbox
), vbox2
, TRUE
/*expand*/, TRUE
/*fill*/, 0);
686 gtk_container_add(GTK_CONTAINER(users_window
), frame_widget(hbox
, NULL
));