2 * This file is part of DisOrder
3 * Copyright (C) 2008, 2009 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/playlists.c
21 * @brief Playlist for Disobedience
23 * The playlists management window contains:
24 * - a list of all playlists
27 * - a drag+drop capable view of the playlist
30 #include "disobedience.h"
31 #include "queue-generic.h"
37 static void playlists_updated(void *v,
39 int nvec, char **vec);
41 /** @brief Playlist editing window */
42 static GtkWidget *playlists_window;
44 /** @brief Tree model for list of playlists */
45 static GtkListStore *playlists_list;
47 /** @brief Selection for list of playlists */
48 static GtkTreeSelection *playlists_selection;
50 /** @brief Currently selected playlist */
51 static const char *playlists_selected;
53 /** @brief Delete button */
54 static GtkWidget *playlists_delete_button;
56 /** @brief Current list of playlists or NULL */
59 /** @brief Count of playlists */
62 /** @brief Columns for the playlist editor */
63 static const struct queue_column playlist_columns[] = {
64 { "Artist", column_namepart, "artist", COL_EXPAND|COL_ELLIPSIZE },
65 { "Album", column_namepart, "album", COL_EXPAND|COL_ELLIPSIZE },
66 { "Title", column_namepart, "title", COL_EXPAND|COL_ELLIPSIZE },
67 { "Length", column_length, 0, COL_RIGHT }
70 /** @brief Pop-up menu for playlist editor */
71 // TODO some of these may not be generic enough yet - check!
72 static struct menuitem playlist_menuitems[] = {
73 { "Track properties", ql_properties_activate, ql_properties_sensitive, 0, 0 },
74 { "Play track", ql_play_activate, ql_play_sensitive, 0, 0 },
75 //{ "Play playlist", ql_playall_activate, ql_playall_sensitive, 0, 0 },
76 { "Remove track from queue", ql_remove_activate, ql_remove_sensitive, 0, 0 },
77 { "Select all tracks", ql_selectall_activate, ql_selectall_sensitive, 0, 0 },
78 { "Deselect all tracks", ql_selectnone_activate, ql_selectnone_sensitive, 0, 0 },
81 /** @brief Queuelike for editing a playlist */
82 static struct queuelike ql_playlist = {
84 .columns = playlist_columns,
85 .ncolumns = sizeof playlist_columns / sizeof *playlist_columns,
86 .menuitems = playlist_menuitems,
87 .nmenuitems = sizeof playlist_menuitems / sizeof *playlist_menuitems,
88 //.drop = playlist_drop //TODO
91 /* Maintaining the list of playlists ---------------------------------------- */
93 /** @brief Schedule an update to the list of playlists */
94 static void playlists_update(const char attribute((unused)) *event,
95 void attribute((unused)) *eventdata,
96 void attribute((unused)) *callbackdata) {
97 disorder_eclient_playlists(client, playlists_updated, 0);
100 /** @brief qsort() callback for playlist name comparison */
101 static int playlistcmp(const void *ap, const void *bp) {
102 const char *a = *(char **)ap, *b = *(char **)bp;
103 const char *ad = strchr(a, '.'), *bd = strchr(b, '.');
106 /* Group owned playlists by owner */
108 const int adn = ad - a, bdn = bd - b;
109 if((c = strncmp(a, b, adn < bdn ? adn : bdn)))
111 /* Lexical order within playlists of a single owner */
112 return strcmp(ad + 1, bd + 1);
115 /* Owned playlists after shared ones */
122 /* Lexical order of shared playlists */
126 /** @brief Called with a new list of playlists */
127 static void playlists_updated(void attribute((unused)) *v,
129 int nvec, char **vec) {
133 /* Probably means server does not support playlists */
137 qsort(playlists, nplaylists, sizeof (char *), playlistcmp);
139 /* Tell our consumers */
140 event_raise("playlists-updated", 0);
143 /* Playlists menu ----------------------------------------------------------- */
145 /** @brief Play received playlist contents
147 * Passed as a completion callback by menu_activate_playlist().
149 static void playlist_play_content(void attribute((unused)) *v,
151 int nvec, char **vec) {
153 popup_protocol_error(0, err);
156 for(int n = 0; n < nvec; ++n)
157 disorder_eclient_play(client, vec[n], NULL, NULL);
160 /** @brief Called to activate a playlist
162 * Called when the menu item for a playlist is clicked.
164 static void menu_activate_playlist(GtkMenuItem *menuitem,
165 gpointer attribute((unused)) user_data) {
166 GtkLabel *label = GTK_LABEL(GTK_BIN(menuitem)->child);
167 const char *playlist = gtk_label_get_text(label);
169 disorder_eclient_playlist_get(client, playlist_play_content, playlist, NULL);
172 /** @brief Called when the playlists change */
173 static void menu_playlists_changed(const char attribute((unused)) *event,
174 void attribute((unused)) *eventdata,
175 void attribute((unused)) *callbackdata) {
177 return; /* OMG too soon */
178 GtkMenuShell *menu = GTK_MENU_SHELL(playlists_menu);
179 /* TODO: we could be more sophisticated and only insert/remove widgets as
180 * needed. The current logic trashes the selection which is not acceptable
181 * and interacts badly with one playlist being currently locked and
183 while(menu->children)
184 gtk_container_remove(GTK_CONTAINER(menu), GTK_WIDGET(menu->children->data));
185 /* NB nplaylists can be -1 as well as 0 */
186 for(int n = 0; n < nplaylists; ++n) {
187 GtkWidget *w = gtk_menu_item_new_with_label(playlists[n]);
188 g_signal_connect(w, "activate", G_CALLBACK(menu_activate_playlist), 0);
190 gtk_menu_shell_append(menu, w);
192 gtk_widget_set_sensitive(menu_playlists_widget,
194 gtk_widget_set_sensitive(menu_editplaylists_widget,
198 /* Popup to create a new playlist ------------------------------------------- */
200 /** @brief New-playlist popup */
201 static GtkWidget *playlist_new_window;
203 /** @brief Text entry in new-playlist popup */
204 static GtkWidget *playlist_new_entry;
206 static GtkWidget *playlist_new_info;
208 static GtkWidget *playlist_new_shared;
209 static GtkWidget *playlist_new_public;
210 static GtkWidget *playlist_new_private;
212 /** @brief Get entered new-playlist details */
213 static void playlist_new_details(char **namep,
217 gboolean *privatep) {
218 gboolean shared, public, private;
219 g_object_get(playlist_new_shared, "active", &shared, (char *)NULL);
220 g_object_get(playlist_new_public, "active", &public, (char *)NULL);
221 g_object_get(playlist_new_private, "active", &private, (char *)NULL);
222 char *gname = gtk_editable_get_chars(GTK_EDITABLE(playlist_new_entry),
223 0, -1); /* name owned by calle */
224 char *name = xstrdup(gname);
226 if(sharedp) *sharedp = shared;
227 if(publicp) *publicp = public;
228 if(privatep) *privatep = private;
229 if(namep) *namep = name;
231 if(*sharedp) *fullnamep = *namep;
232 else byte_xasprintf(fullnamep, "%s.%s", config->username, name);
236 /** @brief Called when the newly created playlist has unlocked */
237 static void playlist_new_unlocked(void attribute((unused)) *v, const char *err) {
239 popup_protocol_error(0, err);
240 gtk_widget_destroy(playlist_new_window);
243 /** @brief Called when the new playlist has been created */
244 static void playlist_new_created(void attribute((unused)) *v, const char *err) {
246 popup_protocol_error(0, err);
249 disorder_eclient_playlist_unlock(client, playlist_new_unlocked, NULL);
250 // TODO arrange for the new playlist to be selected
253 /** @brief Called when the proposed new playlist's contents have been retrieved
255 * ...or rather, normally, when it's been reported that it does not exist.
257 static void playlist_new_retrieved(void *v, const char *err,
259 char attribute((unused)) **vec) {
261 if(!err && nvec != -1)
262 /* A rare case but not in principle impossible */
263 err = "A playlist with that name already exists.";
265 popup_protocol_error(0, err);
266 disorder_eclient_playlist_unlock(client, playlist_new_unlocked, fullname);
269 gboolean shared, public, private;
270 playlist_new_details(0, 0, &shared, &public, &private);
271 disorder_eclient_playlist_set_share(client, playlist_new_created, fullname,
273 : private ? "private"
278 /** @brief Called when the proposed new playlist has been locked */
279 static void playlist_new_locked(void *v, const char *err) {
282 popup_protocol_error(0, err);
285 disorder_eclient_playlist_get(client, playlist_new_retrieved,
289 /** @brief Called when 'ok' is clicked in new-playlist popup */
290 static void playlist_new_ok(GtkButton attribute((unused)) *button,
291 gpointer attribute((unused)) userdata) {
292 gboolean shared, public, private;
293 char *name, *fullname;
294 playlist_new_details(&name, &fullname, &shared, &public, &private);
297 * - lock the playlist
298 * - check it doesn't exist
299 * - set sharing (which will create it empty
302 * TODO we should freeze the window while this is going on
304 disorder_eclient_playlist_lock(client, playlist_new_locked, fullname,
308 /** @brief Called when 'cancel' is clicked in new-playlist popup */
309 static void playlist_new_cancel(GtkButton attribute((unused)) *button,
310 gpointer attribute((unused)) userdata) {
311 gtk_widget_destroy(playlist_new_window);
314 /** @brief Buttons for new-playlist popup */
315 static struct button playlist_new_buttons[] = {
317 .stock = GTK_STOCK_OK,
318 .clicked = playlist_new_ok,
319 .tip = "Create new playlist"
322 .stock = GTK_STOCK_CANCEL,
323 .clicked = playlist_new_cancel,
324 .tip = "Do not create new playlist"
327 #define NPLAYLIST_NEW_BUTTONS (sizeof playlist_new_buttons / sizeof *playlist_new_buttons)
329 /** @brief Test whether the new-playlist window settings are valid
330 * @return NULL on success or an error string if not
332 static const char *playlist_new_valid(void) {
333 gboolean shared, public, private;
334 char *name, *fullname;
335 playlist_new_details(&name, &fullname, &shared, &public, &private);
336 if(!(shared || public || private))
337 return "No type set.";
340 /* See if the result is valid */
341 if(!valid_username(name)
342 || playlist_parse_name(fullname, NULL, NULL))
343 return "Not a valid playlist name.";
344 /* See if the result clashes with an existing name */
345 for(int n = 0; n < nplaylists; ++n)
346 if(!strcmp(playlists[n], fullname)) {
348 return "A shared playlist with that name already exists.";
350 return "You already have a playlist with that name.";
352 /* As far as we can tell creation would work */
356 /** @brief Called to update new playlist window state
358 * This is called whenever one the text entry or radio buttons changed, and
359 * also when the set of known playlists changes. It determines whether the new
360 * playlist would be creatable and sets the sensitivity of the OK button
361 * and info display accordingly.
363 static void playlist_new_changed(const char attribute((unused)) *event,
364 void attribute((unused)) *eventdata,
365 void attribute((unused)) *callbackdata) {
366 if(!playlist_new_window)
368 const char *reason = playlist_new_valid();
369 gtk_widget_set_sensitive(playlist_new_buttons[0].widget,
371 gtk_label_set_text(GTK_LABEL(playlist_new_info), reason);
374 /** @brief Called when some radio button in the new-playlist popup changes */
375 static void playlist_new_button_toggled(GtkToggleButton attribute((unused)) tb,
376 gpointer attribute((unused)) userdata) {
377 playlist_new_changed(0,0,0);
380 /** @brief Called when the text entry field in the new-playlist popup changes */
381 static void playlist_new_entry_edited(GtkEditable attribute((unused)) *editable,
382 gpointer attribute((unused)) user_data) {
383 playlist_new_changed(0,0,0);
386 /** @brief Pop up a new window to enter the playlist name and details */
387 static void playlist_new(void) {
388 assert(playlist_new_window == NULL);
389 playlist_new_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
390 g_signal_connect(playlist_new_window, "destroy",
391 G_CALLBACK(gtk_widget_destroyed), &playlist_new_window);
392 gtk_window_set_title(GTK_WINDOW(playlist_new_window), "Create new playlist");
393 /* Window will be modal, suppressing access to other windows */
394 gtk_window_set_modal(GTK_WINDOW(playlist_new_window), TRUE);
395 gtk_window_set_transient_for(GTK_WINDOW(playlist_new_window),
396 GTK_WINDOW(playlists_window));
398 /* Window contents will use a table (grid) layout */
399 GtkWidget *table = gtk_table_new(3, 3, FALSE/*!homogeneous*/);
401 /* First row: playlist name */
402 gtk_table_attach_defaults(GTK_TABLE(table),
403 gtk_label_new("Playlist name"),
405 playlist_new_entry = gtk_entry_new();
406 g_signal_connect(playlist_new_entry, "changed",
407 G_CALLBACK(playlist_new_entry_edited), NULL);
408 gtk_table_attach_defaults(GTK_TABLE(table),
412 /* Second row: radio buttons to choose type */
413 playlist_new_shared = gtk_radio_button_new_with_label(NULL, "shared");
415 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared),
418 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared),
420 g_signal_connect(playlist_new_shared, "toggled",
421 G_CALLBACK(playlist_new_button_toggled), NULL);
422 g_signal_connect(playlist_new_public, "toggled",
423 G_CALLBACK(playlist_new_button_toggled), NULL);
424 g_signal_connect(playlist_new_private, "toggled",
425 G_CALLBACK(playlist_new_button_toggled), NULL);
426 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_shared, 0, 1, 1, 2);
427 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_public, 1, 2, 1, 2);
428 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_private, 2, 3, 1, 2);
430 /* Third row: info bar saying why not */
431 playlist_new_info = gtk_label_new("");
432 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_info,
435 /* Fourth row: ok/cancel buttons */
436 GtkWidget *hbox = create_buttons_box(playlist_new_buttons,
437 NPLAYLIST_NEW_BUTTONS,
438 gtk_hbox_new(FALSE, 0));
439 gtk_table_attach_defaults(GTK_TABLE(table), hbox, 0, 3, 3, 4);
441 gtk_container_add(GTK_CONTAINER(playlist_new_window),
442 frame_widget(table, NULL));
444 /* Set initial state of OK button */
445 playlist_new_changed(0,0,0);
447 /* Display the window */
448 gtk_widget_show_all(playlist_new_window);
451 /* Playlists window (list of playlists) ------------------------------------- */
453 /** @brief (Re-)populate the playlist tree model */
454 static void playlists_fill(const char attribute((unused)) *event,
455 void attribute((unused)) *eventdata,
456 void attribute((unused)) *callbackdata) {
460 playlists_list = gtk_list_store_new(1, G_TYPE_STRING);
461 gtk_list_store_clear(playlists_list);
462 for(int n = 0; n < nplaylists; ++n)
463 gtk_list_store_insert_with_values(playlists_list, iter, n/*position*/,
464 0, playlists[n], /* column 0 */
465 -1); /* no more cols */
466 // TODO reselect whatever was formerly selected if possible, if not then
467 // zap the contents view
470 /** @brief Called when the selection might have changed */
471 static void playlists_selection_changed(GtkTreeSelection attribute((unused)) *treeselection,
472 gpointer attribute((unused)) user_data) {
474 char *gselected, *selected;
476 /* Identify the current selection */
477 if(gtk_tree_selection_get_selected(playlists_selection, 0, &iter)) {
478 gtk_tree_model_get(GTK_TREE_MODEL(playlists_list), &iter,
480 selected = xstrdup(gselected);
484 if(playlists_selected)
485 gtk_widget_set_sensitive(playlists_delete_button, 1);
487 gtk_widget_set_sensitive(playlists_delete_button, 0);
488 /* Eliminate no-change cases */
489 if(!selected && !playlists_selected)
491 if(selected && playlists_selected && !strcmp(selected, playlists_selected))
493 /* There's been a change */
496 /** @brief Called when the 'add' button is pressed */
497 static void playlists_add(GtkButton attribute((unused)) *button,
498 gpointer attribute((unused)) userdata) {
499 /* Unselect whatever is selected TODO why?? */
500 gtk_tree_selection_unselect_all(playlists_selection);
504 /** @brief Called when the 'Delete' button is pressed */
505 static void playlists_delete(GtkButton attribute((unused)) *button,
506 gpointer attribute((unused)) userdata) {
510 fprintf(stderr, "playlists_delete\n");
511 if(!playlists_selected)
512 return; /* shouldn't happen */
513 yesno = gtk_message_dialog_new(GTK_WINDOW(playlists_window),
515 GTK_MESSAGE_QUESTION,
517 "Do you really want to delete playlist %s?"
518 " This action cannot be undone.",
520 res = gtk_dialog_run(GTK_DIALOG(yesno));
521 gtk_widget_destroy(yesno);
522 if(res == GTK_RESPONSE_YES) {
523 disorder_eclient_playlist_delete(client,
524 NULL/*playlists_delete_completed*/,
530 /** @brief Table of buttons below the playlist list */
531 static struct button playlists_buttons[] = {
535 "Create a new playlist",
545 #define NPLAYLISTS_BUTTONS (sizeof playlists_buttons / sizeof *playlists_buttons)
547 /** @brief Create the list of playlists for the edit playlists window */
548 static GtkWidget *playlists_window_list(void) {
549 /* Create the list of playlist and populate it */
550 playlists_fill(NULL, NULL, NULL);
551 /* Create the tree view */
552 GtkWidget *tree = gtk_tree_view_new_with_model(GTK_TREE_MODEL(playlists_list));
553 /* ...and the renderers for it */
554 GtkCellRenderer *cr = gtk_cell_renderer_text_new();
555 GtkTreeViewColumn *col = gtk_tree_view_column_new_with_attributes("Playlist",
559 gtk_tree_view_append_column(GTK_TREE_VIEW(tree), col);
560 /* Get the selection for the view; set its mode; arrange for a callback when
562 playlists_selected = NULL;
563 playlists_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tree));
564 gtk_tree_selection_set_mode(playlists_selection, GTK_SELECTION_BROWSE);
565 g_signal_connect(playlists_selection, "changed",
566 G_CALLBACK(playlists_selection_changed), NULL);
568 /* Create the control buttons */
569 GtkWidget *buttons = create_buttons_box(playlists_buttons,
571 gtk_hbox_new(FALSE, 1));
572 playlists_delete_button = playlists_buttons[1].widget;
574 playlists_selection_changed(NULL, NULL);
576 /* Buttons live below the list */
577 GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
578 gtk_box_pack_start(GTK_BOX(vbox), scroll_widget(tree), TRUE/*expand*/, TRUE/*fill*/, 0);
579 gtk_box_pack_start(GTK_BOX(vbox), buttons, FALSE/*expand*/, FALSE, 0);
584 /* Playlists window (edit current playlist) --------------------------------- */
586 static GtkWidget *playlists_window_edit(void) {
587 assert(ql_playlist.view == NULL); /* better not be set up already */
588 GtkWidget *w = init_queuelike(&ql_playlist);
592 /* Playlists window --------------------------------------------------------- */
594 /** @brief Keypress handler */
595 static gboolean playlists_keypress(GtkWidget attribute((unused)) *widget,
597 gpointer attribute((unused)) user_data) {
600 switch(event->keyval) {
602 gtk_widget_destroy(playlists_window);
609 /** @brief Called when the playlist window is destroyed */
610 static void playlists_window_destroyed(GtkWidget attribute((unused)) *widget,
611 GtkWidget **widget_pointer) {
612 destroy_queuelike(&ql_playlist);
613 *widget_pointer = NULL;
616 /** @brief Pop up the playlists window
618 * Called when the playlists menu item is selected
620 void edit_playlists(gpointer attribute((unused)) callback_data,
621 guint attribute((unused)) callback_action,
622 GtkWidget attribute((unused)) *menu_item) {
623 /* If the window already exists, raise it */
624 if(playlists_window) {
625 gtk_window_present(GTK_WINDOW(playlists_window));
628 /* Create the window */
629 playlists_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
630 gtk_widget_set_style(playlists_window, tool_style);
631 g_signal_connect(playlists_window, "destroy",
632 G_CALLBACK(playlists_window_destroyed), &playlists_window);
633 gtk_window_set_title(GTK_WINDOW(playlists_window), "Playlists Management");
634 /* TODO loads of this is very similar to (copied from!) users.c - can we
636 /* Keyboard shortcuts */
637 g_signal_connect(playlists_window, "key-press-event",
638 G_CALLBACK(playlists_keypress), 0);
639 /* default size is too small */
640 gtk_window_set_default_size(GTK_WINDOW(playlists_window), 512, 240);
642 GtkWidget *hbox = gtk_hbox_new(FALSE, 0);
643 gtk_box_pack_start(GTK_BOX(hbox), playlists_window_list(),
644 FALSE/*expand*/, FALSE, 0);
645 gtk_box_pack_start(GTK_BOX(hbox), gtk_event_box_new(),
646 FALSE/*expand*/, FALSE, 2);
647 gtk_box_pack_start(GTK_BOX(hbox), playlists_window_edit(),
648 TRUE/*expand*/, TRUE/*fill*/, 0);
650 gtk_container_add(GTK_CONTAINER(playlists_window), frame_widget(hbox, NULL));
651 gtk_widget_show_all(playlists_window);
654 /** @brief Initialize playlist support */
655 void playlists_init(void) {
656 /* We re-get all playlists upon any change... */
657 event_register("playlist-created", playlists_update, 0);
658 event_register("playlist-modified", playlists_update, 0);
659 event_register("playlist-deleted", playlists_update, 0);
660 /* ...and on reconnection */
661 event_register("log-connected", playlists_update, 0);
662 /* ...and from time to time */
663 event_register("periodic-slow", playlists_update, 0);
664 /* ...and at startup */
666 /* Update the playlists menu when the set of playlists changes */
667 event_register("playlists-updated", menu_playlists_changed, 0);
668 /* Update the new-playlist OK button when the set of playlists changes */
669 event_register("playlists-updated", playlist_new_changed, 0);
670 playlists_update(0, 0, 0);