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 support for Disobedience
23 * The playlists management window contains:
24 * - the playlist picker (a list of all playlists) TODO should be a tree!
27 * - the playlist editor (a d+d-capable view of the currently picked playlist)
28 * - a close button TODO
30 * This file also maintains the playlist menu, allowing playlists to be
31 * activated from the main window's menu.
33 * Internally we maintain the playlist list, which is just the current list of
34 * playlists. Changes to this are reflected in the playlist menu and the
38 #include "disobedience.h"
39 #include "queue-generic.h"
45 static void playlist_list_received_playlists(void *v,
47 int nvec, char **vec);
48 static void playlist_editor_fill(const char *event,
51 static int playlist_playall_sensitive(void *extra);
52 static void playlist_playall_activate(GtkMenuItem *menuitem,
54 static int playlist_remove_sensitive(void *extra) ;
55 static void playlist_remove_activate(GtkMenuItem *menuitem,
57 static void playlist_new_locked(void *v, const char *err);
58 static void playlist_new_retrieved(void *v, const char *err,
61 static void playlist_new_created(void *v, const char *err);
62 static void playlist_new_unlocked(void *v, const char *err);
63 static void playlist_new_entry_edited(GtkEditable *editable,
65 static void playlist_new_button_toggled(GtkToggleButton *tb,
67 static void playlist_new_changed(const char *event,
70 static const char *playlist_new_valid(void);
71 static void playlist_new_details(char **namep,
76 static void playlist_new_ok(GtkButton *button,
78 static void playlist_new_cancel(GtkButton *button,
80 static void playlists_editor_received_tracks(void *v,
82 int nvec, char **vec);
83 static void playlist_window_destroyed(GtkWidget *widget,
84 GtkWidget **widget_pointer);
85 static gboolean playlist_window_keypress(GtkWidget *widget,
88 static int playlistcmp(const void *ap, const void *bp);
89 static void playlist_modify_locked(void *v, const char *err);
90 void playlist_modify_retrieved(void *v, const char *err,
93 static void playlist_modify_updated(void *v, const char *err);
94 static void playlist_modify_unlocked(void *v, const char *err);
95 static void playlist_drop(struct queuelike *ql,
97 char **tracks, char **ids,
98 struct queue_entry *after_me);
99 struct playlist_modify_data;
100 static void playlist_drop_modify(struct playlist_modify_data *mod,
101 int nvec, char **vec);
102 static void playlist_remove_modify(struct playlist_modify_data *mod,
103 int nvec, char **vec);
104 static gboolean playlist_new_keypress(GtkWidget *widget,
107 static gboolean playlist_picker_keypress(GtkWidget *widget,
110 static void playlist_editor_button_toggled(GtkToggleButton *tb,
112 static void playlist_editor_set_buttons(const char *event,
115 static void playlist_editor_got_share(void *v,
118 static void playlist_editor_share_set(void *v, const char *err);
120 /** @brief Playlist editing window */
121 static GtkWidget *playlist_window;
123 /** @brief Columns for the playlist editor */
124 static const struct queue_column playlist_columns[] = {
125 { "Artist", column_namepart, "artist", COL_EXPAND|COL_ELLIPSIZE },
126 { "Album", column_namepart, "album", COL_EXPAND|COL_ELLIPSIZE },
127 { "Title", column_namepart, "title", COL_EXPAND|COL_ELLIPSIZE },
130 /** @brief Pop-up menu for playlist editor
133 * - track properties works but, bizarrely, raises the main window
135 * - play playlist works
136 * - select/deselect all work
138 static struct menuitem playlist_menuitems[] = {
139 { "Track properties", ql_properties_activate, ql_properties_sensitive, 0, 0 },
140 { "Play track", ql_play_activate, ql_play_sensitive, 0, 0 },
141 { "Play playlist", playlist_playall_activate, playlist_playall_sensitive, 0, 0 },
142 { "Remove track from queue", playlist_remove_activate, playlist_remove_sensitive, 0, 0 },
143 { "Select all tracks", ql_selectall_activate, ql_selectall_sensitive, 0, 0 },
144 { "Deselect all tracks", ql_selectnone_activate, ql_selectnone_sensitive, 0, 0 },
147 static const GtkTargetEntry playlist_targets[] = {
149 PLAYLIST_TRACKS, /* drag type */
150 GTK_TARGET_SAME_WIDGET, /* rearrangement within a widget */
151 PLAYLIST_TRACKS_ID /* ID value */
154 PLAYABLE_TRACKS, /* drag type */
155 GTK_TARGET_SAME_APP|GTK_TARGET_OTHER_WIDGET, /* copying between widgets */
156 PLAYABLE_TRACKS_ID, /* ID value */
163 /** @brief Queuelike for editing a playlist */
164 static struct queuelike ql_playlist = {
166 .columns = playlist_columns,
167 .ncolumns = sizeof playlist_columns / sizeof *playlist_columns,
168 .menuitems = playlist_menuitems,
169 .nmenuitems = sizeof playlist_menuitems / sizeof *playlist_menuitems,
170 .drop = playlist_drop,
171 .drag_source_targets = playlist_targets,
172 .drag_source_actions = GDK_ACTION_MOVE|GDK_ACTION_COPY,
173 .drag_dest_targets = playlist_targets,
174 .drag_dest_actions = GDK_ACTION_MOVE|GDK_ACTION_COPY,
177 /* Maintaining the list of playlists ---------------------------------------- */
179 /** @brief Current list of playlists or NULL */
182 /** @brief Count of playlists */
185 /** @brief Schedule an update to the list of playlists
187 * Called periodically and when a playlist is created or deleted.
189 static void playlist_list_update(const char attribute((unused)) *event,
190 void attribute((unused)) *eventdata,
191 void attribute((unused)) *callbackdata) {
192 disorder_eclient_playlists(client, playlist_list_received_playlists, 0);
195 /** @brief Called with a new list of playlists */
196 static void playlist_list_received_playlists(void attribute((unused)) *v,
198 int nvec, char **vec) {
202 /* Probably means server does not support playlists */
206 qsort(playlists, nplaylists, sizeof (char *), playlistcmp);
208 /* Tell our consumers */
209 event_raise("playlists-updated", 0);
212 /** @brief qsort() callback for playlist name comparison */
213 static int playlistcmp(const void *ap, const void *bp) {
214 const char *a = *(char **)ap, *b = *(char **)bp;
215 const char *ad = strchr(a, '.'), *bd = strchr(b, '.');
218 /* Group owned playlists by owner */
220 const int adn = ad - a, bdn = bd - b;
221 if((c = strncmp(a, b, adn < bdn ? adn : bdn)))
223 /* Lexical order within playlists of a single owner */
224 return strcmp(ad + 1, bd + 1);
227 /* Owned playlists after shared ones */
234 /* Lexical order of shared playlists */
238 /* Playlists menu ----------------------------------------------------------- */
240 static void playlist_menu_playing(void attribute((unused)) *v,
243 popup_protocol_error(0, err);
246 /** @brief Play received playlist contents
248 * Passed as a completion callback by menu_activate_playlist().
250 static void playlist_menu_received_content(void attribute((unused)) *v,
252 int nvec, char **vec) {
254 popup_protocol_error(0, err);
257 for(int n = 0; n < nvec; ++n)
258 disorder_eclient_play(client, vec[n], playlist_menu_playing, NULL);
261 /** @brief Called to activate a playlist
263 * Called when the menu item for a playlist is clicked.
265 static void playlist_menu_activate(GtkMenuItem *menuitem,
266 gpointer attribute((unused)) user_data) {
267 GtkLabel *label = GTK_LABEL(GTK_BIN(menuitem)->child);
268 const char *playlist = gtk_label_get_text(label);
270 disorder_eclient_playlist_get(client, playlist_menu_received_content,
274 /** @brief Called when the playlists change
276 * Naively refills the menu. The results might be unsettling if the menu is
277 * currently open, but this is hopefuly fairly rare.
279 static void playlist_menu_changed(const char attribute((unused)) *event,
280 void attribute((unused)) *eventdata,
281 void attribute((unused)) *callbackdata) {
283 return; /* OMG too soon */
284 GtkMenuShell *menu = GTK_MENU_SHELL(playlists_menu);
285 while(menu->children)
286 gtk_container_remove(GTK_CONTAINER(menu), GTK_WIDGET(menu->children->data));
287 /* NB nplaylists can be -1 as well as 0 */
288 for(int n = 0; n < nplaylists; ++n) {
289 GtkWidget *w = gtk_menu_item_new_with_label(playlists[n]);
290 g_signal_connect(w, "activate", G_CALLBACK(playlist_menu_activate), 0);
292 gtk_menu_shell_append(menu, w);
294 gtk_widget_set_sensitive(menu_playlists_widget,
296 gtk_widget_set_sensitive(menu_editplaylists_widget,
300 /* Popup to create a new playlist ------------------------------------------- */
302 /** @brief New-playlist popup */
303 static GtkWidget *playlist_new_window;
305 /** @brief Text entry in new-playlist popup */
306 static GtkWidget *playlist_new_entry;
308 /** @brief Label for displaying feedback on what's wrong */
309 static GtkWidget *playlist_new_info;
311 /** @brief "Shared" radio button */
312 static GtkWidget *playlist_new_shared;
314 /** @brief "Public" radio button */
315 static GtkWidget *playlist_new_public;
317 /** @brief "Private" radio button */
318 static GtkWidget *playlist_new_private;
320 /** @brief Buttons for new-playlist popup */
321 static struct button playlist_new_buttons[] = {
323 .stock = GTK_STOCK_OK,
324 .clicked = playlist_new_ok,
325 .tip = "Create new playlist"
328 .stock = GTK_STOCK_CANCEL,
329 .clicked = playlist_new_cancel,
330 .tip = "Do not create new playlist"
333 #define NPLAYLIST_NEW_BUTTONS (sizeof playlist_new_buttons / sizeof *playlist_new_buttons)
335 /** @brief Pop up a new window to enter the playlist name and details */
336 static void playlist_new_playlist(void) {
337 assert(playlist_new_window == NULL);
338 playlist_new_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
339 g_signal_connect(playlist_new_window, "destroy",
340 G_CALLBACK(gtk_widget_destroyed), &playlist_new_window);
341 gtk_window_set_title(GTK_WINDOW(playlist_new_window), "Create new playlist");
342 /* Window will be modal, suppressing access to other windows */
343 gtk_window_set_modal(GTK_WINDOW(playlist_new_window), TRUE);
344 gtk_window_set_transient_for(GTK_WINDOW(playlist_new_window),
345 GTK_WINDOW(playlist_window));
347 /* Window contents will use a table (grid) layout */
348 GtkWidget *table = gtk_table_new(3, 3, FALSE/*!homogeneous*/);
350 /* First row: playlist name */
351 gtk_table_attach_defaults(GTK_TABLE(table),
352 gtk_label_new("Playlist name"),
354 playlist_new_entry = gtk_entry_new();
355 g_signal_connect(playlist_new_entry, "changed",
356 G_CALLBACK(playlist_new_entry_edited), NULL);
357 gtk_table_attach_defaults(GTK_TABLE(table),
361 /* Second row: radio buttons to choose type */
362 playlist_new_shared = gtk_radio_button_new_with_label(NULL, "shared");
364 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared),
367 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared),
369 g_signal_connect(playlist_new_shared, "toggled",
370 G_CALLBACK(playlist_new_button_toggled), NULL);
371 g_signal_connect(playlist_new_public, "toggled",
372 G_CALLBACK(playlist_new_button_toggled), NULL);
373 g_signal_connect(playlist_new_private, "toggled",
374 G_CALLBACK(playlist_new_button_toggled), NULL);
375 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_shared, 0, 1, 1, 2);
376 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_public, 1, 2, 1, 2);
377 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_private, 2, 3, 1, 2);
379 /* Third row: info bar saying why not */
380 playlist_new_info = gtk_label_new("");
381 gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_info,
384 /* Fourth row: ok/cancel buttons */
385 GtkWidget *hbox = create_buttons_box(playlist_new_buttons,
386 NPLAYLIST_NEW_BUTTONS,
387 gtk_hbox_new(FALSE, 0));
388 gtk_table_attach_defaults(GTK_TABLE(table), hbox, 0, 3, 3, 4);
390 gtk_container_add(GTK_CONTAINER(playlist_new_window),
391 frame_widget(table, NULL));
393 /* Set initial state of OK button */
394 playlist_new_changed(0,0,0);
396 g_signal_connect(playlist_new_window, "key-press-event",
397 G_CALLBACK(playlist_new_keypress), 0);
399 /* Display the window */
400 gtk_widget_show_all(playlist_new_window);
403 /** @brief Keypress handler */
404 static gboolean playlist_new_keypress(GtkWidget attribute((unused)) *widget,
406 gpointer attribute((unused)) user_data) {
409 switch(event->keyval) {
411 playlist_new_ok(NULL, NULL);
414 gtk_widget_destroy(playlist_new_window);
421 /** @brief Called when 'ok' is clicked in new-playlist popup */
422 static void playlist_new_ok(GtkButton attribute((unused)) *button,
423 gpointer attribute((unused)) userdata) {
424 if(playlist_new_valid())
426 gboolean shared, public, private;
427 char *name, *fullname;
428 playlist_new_details(&name, &fullname, &shared, &public, &private);
431 * - lock the playlist
432 * - check it doesn't exist
433 * - set sharing (which will create it empty
436 * TODO we should freeze the window while this is going on to stop a second
439 disorder_eclient_playlist_lock(client, playlist_new_locked, fullname,
443 /** @brief Called when the proposed new playlist has been locked */
444 static void playlist_new_locked(void *v, const char *err) {
447 popup_protocol_error(0, err);
450 disorder_eclient_playlist_get(client, playlist_new_retrieved,
454 /** @brief Called when the proposed new playlist's contents have been retrieved
456 * ...or rather, normally, when it's been reported that it does not exist.
458 static void playlist_new_retrieved(void *v, const char *err,
460 char attribute((unused)) **vec) {
462 if(!err && nvec != -1)
463 /* A rare case but not in principle impossible */
464 err = "A playlist with that name already exists.";
466 popup_protocol_error(0, err);
467 disorder_eclient_playlist_unlock(client, playlist_new_unlocked, fullname);
470 gboolean shared, public, private;
471 playlist_new_details(0, 0, &shared, &public, &private);
472 disorder_eclient_playlist_set_share(client, playlist_new_created, fullname,
474 : private ? "private"
479 /** @brief Called when the new playlist has been created */
480 static void playlist_new_created(void attribute((unused)) *v, const char *err) {
482 popup_protocol_error(0, err);
485 disorder_eclient_playlist_unlock(client, playlist_new_unlocked, NULL);
486 // TODO arrange for the new playlist to be selected
489 /** @brief Called when the newly created playlist has unlocked */
490 static void playlist_new_unlocked(void attribute((unused)) *v, const char *err) {
492 popup_protocol_error(0, err);
493 /* Pop down the creation window */
494 gtk_widget_destroy(playlist_new_window);
497 /** @brief Called when 'cancel' is clicked in new-playlist popup */
498 static void playlist_new_cancel(GtkButton attribute((unused)) *button,
499 gpointer attribute((unused)) userdata) {
500 gtk_widget_destroy(playlist_new_window);
503 /** @brief Called when some radio button in the new-playlist popup changes */
504 static void playlist_new_button_toggled(GtkToggleButton attribute((unused)) *tb,
505 gpointer attribute((unused)) userdata) {
506 playlist_new_changed(0,0,0);
509 /** @brief Called when the text entry field in the new-playlist popup changes */
510 static void playlist_new_entry_edited(GtkEditable attribute((unused)) *editable,
511 gpointer attribute((unused)) user_data) {
512 playlist_new_changed(0,0,0);
515 /** @brief Called to update new playlist window state
517 * This is called whenever one the text entry or radio buttons changed, and
518 * also when the set of known playlists changes. It determines whether the new
519 * playlist would be creatable and sets the sensitivity of the OK button
520 * and info display accordingly.
522 static void playlist_new_changed(const char attribute((unused)) *event,
523 void attribute((unused)) *eventdata,
524 void attribute((unused)) *callbackdata) {
525 if(!playlist_new_window)
527 const char *reason = playlist_new_valid();
528 gtk_widget_set_sensitive(playlist_new_buttons[0].widget,
530 gtk_label_set_text(GTK_LABEL(playlist_new_info), reason);
533 /** @brief Test whether the new-playlist window settings are valid
534 * @return NULL on success or an error string if not
536 static const char *playlist_new_valid(void) {
537 gboolean shared, public, private;
538 char *name, *fullname;
539 playlist_new_details(&name, &fullname, &shared, &public, &private);
540 if(!(shared || public || private))
541 return "No type set.";
544 /* See if the result is valid */
545 if(!valid_username(name)
546 || playlist_parse_name(fullname, NULL, NULL))
547 return "Not a valid playlist name.";
548 /* See if the result clashes with an existing name. This is not a perfect
549 * check, the playlist might be created after this point but before we get a
550 * chance to disable the "OK" button. However when we try to create the
551 * playlist we will first try to retrieve it, with a lock held, so we
552 * shouldn't end up overwriting anything. */
553 for(int n = 0; n < nplaylists; ++n)
554 if(!strcmp(playlists[n], fullname)) {
556 return "A shared playlist with that name already exists.";
558 return "You already have a playlist with that name.";
560 /* As far as we can tell creation would work */
564 /** @brief Get entered new-playlist details
565 * @param namep Where to store entered name (or NULL)
566 * @param fullnamep Where to store computed full name (or NULL)
567 * @param sharep Where to store 'shared' flag (or NULL)
568 * @param publicp Where to store 'public' flag (or NULL)
569 * @param privatep Where to store 'private' flag (or NULL)
571 static void playlist_new_details(char **namep,
575 gboolean *privatep) {
576 gboolean shared, public, private;
577 g_object_get(playlist_new_shared, "active", &shared, (char *)NULL);
578 g_object_get(playlist_new_public, "active", &public, (char *)NULL);
579 g_object_get(playlist_new_private, "active", &private, (char *)NULL);
580 char *gname = gtk_editable_get_chars(GTK_EDITABLE(playlist_new_entry),
581 0, -1); /* name owned by calle */
582 char *name = xstrdup(gname);
584 if(sharedp) *sharedp = shared;
585 if(publicp) *publicp = public;
586 if(privatep) *privatep = private;
587 if(namep) *namep = name;
589 if(*sharedp) *fullnamep = *namep;
590 else byte_xasprintf(fullnamep, "%s.%s", config->username, name);
594 /* Playlist picker ---------------------------------------------------------- */
596 /** @brief Delete button */
597 static GtkWidget *playlist_picker_delete_button;
599 /** @brief Tree model for list of playlists */
600 static GtkListStore *playlist_picker_list;
602 /** @brief Selection for list of playlists */
603 static GtkTreeSelection *playlist_picker_selection;
605 /** @brief Currently selected playlist */
606 static const char *playlist_picker_selected;
608 /** @brief (Re-)populate the playlist picker tree model */
609 static void playlist_picker_fill(const char attribute((unused)) *event,
610 void attribute((unused)) *eventdata,
611 void attribute((unused)) *callbackdata) {
616 if(!playlist_picker_list)
617 playlist_picker_list = gtk_list_store_new(1, G_TYPE_STRING);
618 const char *was_selected = playlist_picker_selected;
619 gtk_list_store_clear(playlist_picker_list); /* clears playlists_selected */
620 for(int n = 0; n < nplaylists; ++n) {
621 gtk_list_store_insert_with_values(playlist_picker_list, iter,
623 0, playlists[n], /* column 0 */
624 -1); /* no more cols */
625 /* Reselect the selected playlist */
626 if(was_selected && !strcmp(was_selected, playlists[n]))
627 gtk_tree_selection_select_iter(playlist_picker_selection, iter);
629 /* TODO deselecting then reselecting the current playlist resets the playlist
630 * editor, which trashes the user's selection. */
633 /** @brief Called when the selection might have changed */
634 static void playlist_picker_selection_changed(GtkTreeSelection attribute((unused)) *treeselection,
635 gpointer attribute((unused)) user_data) {
637 char *gselected, *selected;
639 /* Identify the current selection */
640 if(gtk_tree_selection_get_selected(playlist_picker_selection, 0, &iter)) {
641 gtk_tree_model_get(GTK_TREE_MODEL(playlist_picker_list), &iter,
643 selected = xstrdup(gselected);
647 /* Set button sensitivity according to the new state */
649 gtk_widget_set_sensitive(playlist_picker_delete_button, 1);
651 gtk_widget_set_sensitive(playlist_picker_delete_button, 0);
652 /* TODO delete should not be sensitive for public playlists owned by other
654 /* Eliminate no-change cases */
655 if(!selected && !playlist_picker_selected)
658 && playlist_picker_selected
659 && !strcmp(selected, playlist_picker_selected))
661 /* Record the new state */
662 playlist_picker_selected = selected;
663 /* Re-initalize the queue */
664 ql_new_queue(&ql_playlist, NULL);
665 /* Synthesize a playlist-modified to re-initialize the editor etc */
666 event_raise("playlist-modified", (void *)playlist_picker_selected);
669 /** @brief Called when the 'add' button is pressed */
670 static void playlist_picker_add(GtkButton attribute((unused)) *button,
671 gpointer attribute((unused)) userdata) {
672 /* Unselect whatever is selected TODO why?? */
673 gtk_tree_selection_unselect_all(playlist_picker_selection);
674 playlist_new_playlist();
677 /** @brief Called when playlist deletion completes */
678 static void playlists_picker_delete_completed(void attribute((unused)) *v,
681 popup_protocol_error(0, err);
684 /** @brief Called when the 'Delete' button is pressed */
685 static void playlist_picker_delete(GtkButton attribute((unused)) *button,
686 gpointer attribute((unused)) userdata) {
690 if(!playlist_picker_selected)
692 yesno = gtk_message_dialog_new(GTK_WINDOW(playlist_window),
694 GTK_MESSAGE_QUESTION,
696 "Do you really want to delete playlist %s?"
697 " This action cannot be undone.",
698 playlist_picker_selected);
699 res = gtk_dialog_run(GTK_DIALOG(yesno));
700 gtk_widget_destroy(yesno);
701 if(res == GTK_RESPONSE_YES) {
702 disorder_eclient_playlist_delete(client,
703 playlists_picker_delete_completed,
704 playlist_picker_selected,
709 /** @brief Table of buttons below the playlist list */
710 static struct button playlist_picker_buttons[] = {
714 "Create a new playlist",
719 playlist_picker_delete,
724 #define NPLAYLIST_PICKER_BUTTONS (sizeof playlist_picker_buttons / sizeof *playlist_picker_buttons)
726 /** @brief Create the list of playlists for the edit playlists window */
727 static GtkWidget *playlist_picker_create(void) {
728 /* Create the list of playlist and populate it */
729 playlist_picker_fill(NULL, NULL, NULL);
730 /* Create the tree view */
731 GtkWidget *tree = gtk_tree_view_new_with_model(GTK_TREE_MODEL(playlist_picker_list));
732 /* ...and the renderers for it */
733 GtkCellRenderer *cr = gtk_cell_renderer_text_new();
734 GtkTreeViewColumn *col = gtk_tree_view_column_new_with_attributes("Playlist",
738 gtk_tree_view_append_column(GTK_TREE_VIEW(tree), col);
739 /* Get the selection for the view; set its mode; arrange for a callback when
741 playlist_picker_selected = NULL;
742 playlist_picker_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tree));
743 gtk_tree_selection_set_mode(playlist_picker_selection, GTK_SELECTION_BROWSE);
744 g_signal_connect(playlist_picker_selection, "changed",
745 G_CALLBACK(playlist_picker_selection_changed), NULL);
747 /* Create the control buttons */
748 GtkWidget *buttons = create_buttons_box(playlist_picker_buttons,
749 NPLAYLIST_PICKER_BUTTONS,
750 gtk_hbox_new(FALSE, 1));
751 playlist_picker_delete_button = playlist_picker_buttons[1].widget;
753 playlist_picker_selection_changed(NULL, NULL);
755 /* Buttons live below the list */
756 GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
757 gtk_box_pack_start(GTK_BOX(vbox), scroll_widget(tree), TRUE/*expand*/, TRUE/*fill*/, 0);
758 gtk_box_pack_start(GTK_BOX(vbox), buttons, FALSE/*expand*/, FALSE, 0);
760 g_signal_connect(tree, "key-press-event",
761 G_CALLBACK(playlist_picker_keypress), 0);
766 static gboolean playlist_picker_keypress(GtkWidget attribute((unused)) *widget,
768 gpointer attribute((unused)) user_data) {
771 switch(event->keyval) {
774 playlist_picker_delete(NULL, NULL);
781 static void playlist_picker_destroy(void) {
782 playlist_picker_delete_button = NULL;
783 g_object_unref(playlist_picker_list);
784 playlist_picker_list = NULL;
785 playlist_picker_selection = NULL;
786 playlist_picker_selected = NULL;
789 /* Playlist editor ---------------------------------------------------------- */
791 static GtkWidget *playlist_editor_shared;
792 static GtkWidget *playlist_editor_public;
793 static GtkWidget *playlist_editor_private;
794 static int playlist_editor_setting_buttons;
796 static GtkWidget *playlists_editor_create(void) {
797 assert(ql_playlist.view == NULL); /* better not be set up already */
799 GtkWidget *hbox = gtk_hbox_new(FALSE, 0);
800 playlist_editor_shared = gtk_radio_button_new_with_label(NULL, "shared");
801 playlist_editor_public
802 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_editor_shared),
804 playlist_editor_private
805 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_editor_shared),
807 g_signal_connect(playlist_editor_public, "toggled",
808 G_CALLBACK(playlist_editor_button_toggled),
810 g_signal_connect(playlist_editor_private, "toggled",
811 G_CALLBACK(playlist_editor_button_toggled),
813 gtk_box_pack_start(GTK_BOX(hbox), playlist_editor_shared,
814 FALSE/*expand*/, FALSE/*fill*/, 0);
815 gtk_box_pack_start(GTK_BOX(hbox), playlist_editor_public,
816 FALSE/*expand*/, FALSE/*fill*/, 0);
817 gtk_box_pack_start(GTK_BOX(hbox), playlist_editor_private,
818 FALSE/*expand*/, FALSE/*fill*/, 0);
819 playlist_editor_set_buttons(0,0,0);
821 GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
822 gtk_box_pack_start(GTK_BOX(vbox), init_queuelike(&ql_playlist),
823 TRUE/*expand*/, TRUE/*fill*/, 0);
824 gtk_box_pack_start(GTK_BOX(vbox), hbox,
825 FALSE/*expand*/, FALSE/*fill*/, 0);
829 /** @brief Called when the public/private buttons are set */
830 static void playlist_editor_button_toggled(GtkToggleButton *tb,
832 const char *state = userdata;
833 if(!gtk_toggle_button_get_active(tb)
834 || !playlist_picker_selected
835 || playlist_editor_setting_buttons)
837 disorder_eclient_playlist_set_share(client, playlist_editor_share_set,
838 playlist_picker_selected, state, NULL);
841 static void playlist_editor_share_set(void attribute((unused)) *v,
842 const attribute((unused)) char *err) {
844 popup_protocol_error(0, err);
847 /** @brief Set the editor button state and sensitivity */
848 static void playlist_editor_set_buttons(const char attribute((unused)) *event,
850 void attribute((unused)) *callbackdata) {
851 /* If this event is for a non-selected playlist do nothing */
853 && playlist_picker_selected
854 && strcmp(eventdata, playlist_picker_selected))
856 if(playlist_picker_selected) {
857 if(strchr(playlist_picker_selected, '.'))
858 disorder_eclient_playlist_get_share(client,
859 playlist_editor_got_share,
860 playlist_picker_selected,
861 (void *)playlist_picker_selected);
863 playlist_editor_got_share((void *)playlist_picker_selected, NULL,
866 playlist_editor_got_share(NULL, NULL, NULL);
869 /** @brief Called with playlist sharing details */
870 static void playlist_editor_got_share(void *v,
873 const char *playlist = v;
875 popup_protocol_error(0, err);
878 /* Set the currently active button */
879 ++playlist_editor_setting_buttons;
880 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(playlist_editor_shared),
881 value && !strcmp(value, "shared"));
882 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(playlist_editor_public),
883 value && !strcmp(value, "public"));
884 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(playlist_editor_private),
885 value && !strcmp(value, "private"));
886 /* Set button sensitivity */
887 gtk_widget_set_sensitive(playlist_editor_shared, FALSE);
888 int sensitive = (playlist
889 && strchr(playlist, '.')
890 && !strncmp(playlist, config->username,
891 strlen(config->username)));
892 gtk_widget_set_sensitive(playlist_editor_public, sensitive);
893 gtk_widget_set_sensitive(playlist_editor_private, sensitive);
894 --playlist_editor_setting_buttons;
897 /** @brief (Re-)populate the playlist tree model */
898 static void playlist_editor_fill(const char attribute((unused)) *event,
900 void attribute((unused)) *callbackdata) {
901 const char *modified_playlist = eventdata;
904 if(!playlist_picker_selected)
906 if(!strcmp(playlist_picker_selected, modified_playlist))
907 disorder_eclient_playlist_get(client, playlists_editor_received_tracks,
908 playlist_picker_selected,
909 (void *)playlist_picker_selected);
912 /** @brief Called with new tracks for the playlist */
913 static void playlists_editor_received_tracks(void *v,
915 int nvec, char **vec) {
916 const char *playlist = v;
918 popup_protocol_error(0, err);
921 if(!playlist_picker_selected
922 || strcmp(playlist, playlist_picker_selected)) {
923 /* The tracks are for the wrong playlist - something must have changed
924 * while the fetch command was in flight. We just ignore this callback,
925 * the right answer will be requested and arrive in due course. */
929 /* No such playlist, presumably we'll get a deleted event shortly */
931 /* Translate the list of tracks into queue entries */
932 struct queue_entry *newq, **qq = &newq, *qprev = NULL;
933 hash *h = hash_new(sizeof(int));
934 for(int n = 0; n < nvec; ++n) {
935 struct queue_entry *q = xmalloc(sizeof *q);
938 /* Synthesize a unique ID so that the selection survives updates. Tracks
939 * can appear more than once in the queue so we can't use raw track names,
940 * so we add a serial number to the start. */
941 int *serialp = hash_find(h, vec[n]), serial = serialp ? *serialp : 0;
942 byte_xasprintf((char **)&q->id, "%d-%s", serial++, vec[n]);
943 hash_add(h, vec[n], &serial, HASH_INSERT_OR_REPLACE);
949 ql_new_queue(&ql_playlist, newq);
952 /* Playlist mutation -------------------------------------------------------- */
954 /** @brief State structure for guarded playlist modification
956 * To safely move, insert or delete rows we must:
958 * - fetch the playlist
959 * - verify it's not changed
960 * - update the playlist contents
961 * - store the playlist
964 * The playlist_modify_ functions do just that.
966 * To kick things off create one of these and disorder_eclient_playlist_lock()
967 * with playlist_modify_locked() as its callback. @c modify will be called; it
968 * should disorder_eclient_playlist_set() to set the new state with
969 * playlist_modify_updated() as its callback.
971 struct playlist_modify_data {
972 /** @brief Affected playlist */
973 const char *playlist;
974 /** @brief Modification function
975 * @param mod Pointer back to state structure
976 * @param ntracks Length of playlist
977 * @param tracks Tracks in playlist
979 void (*modify)(struct playlist_modify_data *mod,
980 int ntracks, char **tracks);
982 /** @brief Number of tracks dropped */
984 /** @brief Track names dropped */
986 /** @brief Track IDs dropped */
988 /** @brief Drop after this point */
989 struct queue_entry *after_me;
992 /** @brief Called with playlist locked
994 * This is the entry point for guarded modification ising @ref
995 * playlist_modify_data.
997 static void playlist_modify_locked(void *v, const char *err) {
998 struct playlist_modify_data *mod = v;
1000 popup_protocol_error(0, err);
1003 disorder_eclient_playlist_get(client, playlist_modify_retrieved,
1004 mod->playlist, mod);
1007 /** @brief Called with current playlist contents
1008 * Checks that the playlist is still current and has not changed.
1010 void playlist_modify_retrieved(void *v, const char *err,
1013 struct playlist_modify_data *mod = v;
1015 popup_protocol_error(0, err);
1016 disorder_eclient_playlist_unlock(client, playlist_modify_unlocked, NULL);
1020 || !playlist_picker_selected
1021 || strcmp(mod->playlist, playlist_picker_selected)) {
1022 disorder_eclient_playlist_unlock(client, playlist_modify_unlocked, NULL);
1025 /* We check that the contents haven't changed. If they have we just abandon
1026 * the operation. The user will have to try again. */
1027 struct queue_entry *q;
1029 for(n = 0, q = ql_playlist.q; q && n < nvec; ++n, q = q->next)
1030 if(strcmp(q->track, vec[n]))
1032 if(n != nvec || q != NULL) {
1033 disorder_eclient_playlist_unlock(client, playlist_modify_unlocked, NULL);
1036 mod->modify(mod, nvec, vec);
1039 /** @brief Called when the playlist has been updated */
1040 static void playlist_modify_updated(void attribute((unused)) *v,
1043 popup_protocol_error(0, err);
1044 disorder_eclient_playlist_unlock(client, playlist_modify_unlocked, NULL);
1047 /** @brief Called when the playlist has been unlocked */
1048 static void playlist_modify_unlocked(void attribute((unused)) *v,
1051 popup_protocol_error(0, err);
1054 /* Drop tracks into a playlist ---------------------------------------------- */
1056 static void playlist_drop(struct queuelike attribute((unused)) *ql,
1058 char **tracks, char **ids,
1059 struct queue_entry *after_me) {
1060 struct playlist_modify_data *mod = xmalloc(sizeof *mod);
1062 mod->playlist = playlist_picker_selected;
1063 mod->modify = playlist_drop_modify;
1064 mod->ntracks = ntracks;
1065 mod->tracks = tracks;
1067 mod->after_me = after_me;
1068 disorder_eclient_playlist_lock(client, playlist_modify_locked,
1069 mod->playlist, mod);
1072 /** @brief Return true if track @p i is in the moved set */
1073 static int playlist_drop_is_moved(struct playlist_modify_data *mod,
1075 struct queue_entry *q;
1077 /* Find the q corresponding to i, so we can get the ID */
1078 for(q = ql_playlist.q; i; q = q->next, --i)
1080 /* See if track i matches any of the moved set by ID */
1081 for(int n = 0; n < mod->ntracks; ++n)
1082 if(!strcmp(q->id, mod->ids[n]))
1087 static void playlist_drop_modify(struct playlist_modify_data *mod,
1088 int nvec, char **vec) {
1092 //fprintf(stderr, "\nplaylist_drop_modify\n");
1093 /* after_me is the queue_entry to insert after, or NULL to insert at the
1094 * beginning (including the case when the playlist is empty) */
1095 //fprintf(stderr, "after_me = %s\n",
1096 // mod->after_me ? mod->after_me->track : "NULL");
1097 struct queue_entry *q = ql_playlist.q;
1101 while(q && q != mod->after_me) {
1106 /* Now ins is the index to insert at; equivalently, the row to insert before,
1107 * and so equal to nvec to append. */
1109 fprintf(stderr, "ins = %d = %s\n",
1110 ins, ins < nvec ? vec[ins] : "NULL");
1111 for(int n = 0; n < nvec; ++n)
1112 fprintf(stderr, "%d: %s %s\n", n, n == ins ? "->" : " ", vec[n]);
1113 fprintf(stderr, "nvec = %d\n", nvec);
1116 /* This is a rearrangement */
1118 * - vec[], the current layout
1119 * - ins, pointing into vec
1120 * - mod->tracks[], a subset of vec[] which is to be moved
1122 * ins is the insertion point BUT it is in terms of the whole
1123 * array, i.e. before mod->tracks[] have been removed. The first
1124 * step then is to remove everything in mod->tracks[] and adjust
1125 * ins downwards as necessary.
1127 /* First zero out anything that's moved */
1129 for(int n = 0; n < nvec; ++n) {
1130 if(playlist_drop_is_moved(mod, n)) {
1136 /* Now collapse down the array */
1138 for(int n = 0; n < nvec; ++n) {
1142 assert(i + mod->ntracks == nvec);
1144 /* Adjust the insertion point to take account of things moved from before
1147 /* The effect is now the same as an insertion */
1149 /* This is (now) an insertion */
1150 nnewvec = nvec + mod->ntracks;
1151 newvec = xcalloc(nnewvec, sizeof (char *));
1153 ins * sizeof (char *));
1154 memcpy(newvec + ins, mod->tracks,
1155 mod->ntracks * sizeof (char *));
1156 memcpy(newvec + ins + mod->ntracks, vec + ins,
1157 (nvec - ins) * sizeof (char *));
1158 disorder_eclient_playlist_set(client, playlist_modify_updated, mod->playlist,
1159 newvec, nnewvec, mod);
1162 /* Playlist editor right-click menu ---------------------------------------- */
1164 /** @brief Called to determine whether the playlist is playable */
1165 static int playlist_playall_sensitive(void attribute((unused)) *extra) {
1166 /* If there's no playlist obviously we can't play it */
1167 if(!playlist_picker_selected)
1169 /* If it's empty we can't play it */
1172 /* Otherwise we can */
1176 /** @brief Called to play the selected playlist */
1177 static void playlist_playall_activate(GtkMenuItem attribute((unused)) *menuitem,
1178 gpointer attribute((unused)) user_data) {
1179 if(!playlist_picker_selected)
1181 /* Re-use the menu-based activation callback */
1182 disorder_eclient_playlist_get(client, playlist_menu_received_content,
1183 playlist_picker_selected, NULL);
1186 /** @brief Called to determine whether the playlist is playable */
1187 static int playlist_remove_sensitive(void attribute((unused)) *extra) {
1188 /* If there's no playlist obviously we can't remove from it */
1189 if(!playlist_picker_selected)
1191 /* If no tracks are selected we cannot remove them */
1192 if(!gtk_tree_selection_count_selected_rows(ql_playlist.selection))
1194 /* We're good to go */
1198 /** @brief Called to remove the selected playlist */
1199 static void playlist_remove_activate(GtkMenuItem attribute((unused)) *menuitem,
1200 gpointer attribute((unused)) user_data) {
1201 if(!playlist_picker_selected)
1203 struct playlist_modify_data *mod = xmalloc(sizeof *mod);
1205 mod->playlist = playlist_picker_selected;
1206 mod->modify = playlist_remove_modify;
1207 disorder_eclient_playlist_lock(client, playlist_modify_locked,
1208 mod->playlist, mod);
1211 static void playlist_remove_modify(struct playlist_modify_data *mod,
1212 int attribute((unused)) nvec, char **vec) {
1213 GtkTreeIter iter[1];
1214 gboolean it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql_playlist.store),
1218 if(!gtk_tree_selection_iter_is_selected(ql_playlist.selection, iter))
1219 vec[m++] = vec[n++];
1222 it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_playlist.store), iter);
1224 disorder_eclient_playlist_set(client, playlist_modify_updated, mod->playlist,
1228 /* Playlists window --------------------------------------------------------- */
1230 /** @brief Pop up the playlists window
1232 * Called when the playlists menu item is selected
1234 void playlist_window_create(gpointer attribute((unused)) callback_data,
1235 guint attribute((unused)) callback_action,
1236 GtkWidget attribute((unused)) *menu_item) {
1237 /* If the window already exists, raise it */
1238 if(playlist_window) {
1239 gtk_window_present(GTK_WINDOW(playlist_window));
1242 /* Create the window */
1243 playlist_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
1244 gtk_widget_set_style(playlist_window, tool_style);
1245 g_signal_connect(playlist_window, "destroy",
1246 G_CALLBACK(playlist_window_destroyed), &playlist_window);
1247 gtk_window_set_title(GTK_WINDOW(playlist_window), "Playlists Management");
1248 /* TODO loads of this is very similar to (copied from!) users.c - can we
1250 /* Keyboard shortcuts */
1251 g_signal_connect(playlist_window, "key-press-event",
1252 G_CALLBACK(playlist_window_keypress), 0);
1253 /* default size is too small */
1254 gtk_window_set_default_size(GTK_WINDOW(playlist_window), 640, 320);
1256 GtkWidget *hbox = gtk_hbox_new(FALSE, 0);
1257 gtk_box_pack_start(GTK_BOX(hbox), playlist_picker_create(),
1258 FALSE/*expand*/, FALSE, 0);
1259 gtk_box_pack_start(GTK_BOX(hbox), gtk_event_box_new(),
1260 FALSE/*expand*/, FALSE, 2);
1261 gtk_box_pack_start(GTK_BOX(hbox), playlists_editor_create(),
1262 TRUE/*expand*/, TRUE/*fill*/, 0);
1264 gtk_container_add(GTK_CONTAINER(playlist_window), frame_widget(hbox, NULL));
1265 gtk_widget_show_all(playlist_window);
1268 /** @brief Keypress handler */
1269 static gboolean playlist_window_keypress(GtkWidget attribute((unused)) *widget,
1271 gpointer attribute((unused)) user_data) {
1274 switch(event->keyval) {
1276 gtk_widget_destroy(playlist_window);
1283 /** @brief Called when the playlist window is destroyed */
1284 static void playlist_window_destroyed(GtkWidget attribute((unused)) *widget,
1285 GtkWidget **widget_pointer) {
1286 destroy_queuelike(&ql_playlist);
1287 playlist_picker_destroy();
1288 *widget_pointer = NULL;
1291 /** @brief Initialize playlist support */
1292 void playlists_init(void) {
1293 /* We re-get all playlists upon any change... */
1294 event_register("playlist-created", playlist_list_update, 0);
1295 event_register("playlist-deleted", playlist_list_update, 0);
1296 /* ...and on reconnection */
1297 event_register("log-connected", playlist_list_update, 0);
1298 /* ...and from time to time */
1299 event_register("periodic-slow", playlist_list_update, 0);
1300 /* ...and at startup */
1301 playlist_list_update(0, 0, 0);
1303 /* Update the playlists menu when the set of playlists changes */
1304 event_register("playlists-updated", playlist_menu_changed, 0);
1305 /* Update the new-playlist OK button when the set of playlists changes */
1306 event_register("playlists-updated", playlist_new_changed, 0);
1307 /* Update the list of playlists in the edit window when the set changes */
1308 event_register("playlists-updated", playlist_picker_fill, 0);
1309 /* Update the displayed playlist when it is modified */
1310 event_register("playlist-modified", playlist_editor_fill, 0);
1311 /* Update the shared/public/etc buttons when a playlist is modified */
1312 event_register("playlist-modified", playlist_editor_set_buttons, 0);
1322 indent-tabs-mode:nil