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"
43 static void playlist_list_received_playlists(void *v
,
45 int nvec
, char **vec
);
46 static void playlist_editor_fill(const char *event
,
49 static int playlist_playall_sensitive(void *extra
);
50 static void playlist_playall_activate(GtkMenuItem
*menuitem
,
52 static int playlist_remove_sensitive(void *extra
) ;
53 static void playlist_remove_activate(GtkMenuItem
*menuitem
,
55 static void playlist_new_locked(void *v
, const char *err
);
56 static void playlist_new_retrieved(void *v
, const char *err
,
59 static void playlist_new_created(void *v
, const char *err
);
60 static void playlist_new_unlocked(void *v
, const char *err
);
61 static void playlist_new_entry_edited(GtkEditable
*editable
,
63 static void playlist_new_button_toggled(GtkToggleButton
*tb
,
65 static void playlist_new_changed(const char *event
,
68 static const char *playlist_new_valid(void);
69 static void playlist_new_details(char **namep
,
74 static void playlist_new_ok(GtkButton
*button
,
76 static void playlist_new_cancel(GtkButton
*button
,
78 static void playlists_editor_received_tracks(void *v
,
80 int nvec
, char **vec
);
81 static void playlist_window_destroyed(GtkWidget
*widget
,
82 GtkWidget
**widget_pointer
);
83 static gboolean
playlist_window_keypress(GtkWidget
*widget
,
86 static int playlistcmp(const void *ap
, const void *bp
);
87 static void playlist_modify_locked(void *v
, const char *err
);
88 void playlist_modify_retrieved(void *v
, const char *err
,
91 static void playlist_modify_updated(void *v
, const char *err
);
92 static void playlist_modify_unlocked(void *v
, const char *err
);
93 static void playlist_drop(struct queuelike
*ql
,
95 char **tracks
, char **ids
,
96 struct queue_entry
*after_me
);
97 struct playlist_modify_data
;
98 static void playlist_drop_modify(struct playlist_modify_data
*mod
,
99 int nvec
, char **vec
);
100 static void playlist_remove_modify(struct playlist_modify_data
*mod
,
101 int nvec
, char **vec
);
102 static gboolean
playlist_new_keypress(GtkWidget
*widget
,
105 static gboolean
playlist_picker_keypress(GtkWidget
*widget
,
108 static void playlist_editor_button_toggled(GtkToggleButton
*tb
,
110 static void playlist_editor_set_buttons(const char *event
,
113 static void playlist_editor_got_share(void *v
,
116 static void playlist_editor_share_set(void *v
, const char *err
);
118 /** @brief Playlist editing window */
119 static GtkWidget
*playlist_window
;
121 /** @brief Columns for the playlist editor */
122 static const struct queue_column playlist_columns
[] = {
123 { "Artist", column_namepart
, "artist", COL_EXPAND
|COL_ELLIPSIZE
},
124 { "Album", column_namepart
, "album", COL_EXPAND
|COL_ELLIPSIZE
},
125 { "Title", column_namepart
, "title", COL_EXPAND
|COL_ELLIPSIZE
},
128 /** @brief Pop-up menu for playlist editor
131 * - track properties works but, bizarrely, raises the main window
133 * - play playlist works
134 * - select/deselect all work
136 static struct menuitem playlist_menuitems
[] = {
137 { "Track properties", ql_properties_activate
, ql_properties_sensitive
, 0, 0 },
138 { "Play track", ql_play_activate
, ql_play_sensitive
, 0, 0 },
139 { "Play playlist", playlist_playall_activate
, playlist_playall_sensitive
, 0, 0 },
140 { "Remove track from queue", playlist_remove_activate
, playlist_remove_sensitive
, 0, 0 },
141 { "Select all tracks", ql_selectall_activate
, ql_selectall_sensitive
, 0, 0 },
142 { "Deselect all tracks", ql_selectnone_activate
, ql_selectnone_sensitive
, 0, 0 },
145 static const GtkTargetEntry playlist_targets
[] = {
147 PLAYLIST_TRACKS
, /* drag type */
148 GTK_TARGET_SAME_WIDGET
, /* rearrangement within a widget */
149 PLAYLIST_TRACKS_ID
/* ID value */
152 PLAYABLE_TRACKS
, /* drag type */
153 GTK_TARGET_SAME_APP
|GTK_TARGET_OTHER_WIDGET
, /* copying between widgets */
154 PLAYABLE_TRACKS_ID
, /* ID value */
161 /** @brief Queuelike for editing a playlist */
162 static struct queuelike ql_playlist
= {
164 .columns
= playlist_columns
,
165 .ncolumns
= sizeof playlist_columns
/ sizeof *playlist_columns
,
166 .menuitems
= playlist_menuitems
,
167 .nmenuitems
= sizeof playlist_menuitems
/ sizeof *playlist_menuitems
,
168 .drop
= playlist_drop
,
169 .drag_source_targets
= playlist_targets
,
170 .drag_source_actions
= GDK_ACTION_MOVE
|GDK_ACTION_COPY
,
171 .drag_dest_targets
= playlist_targets
,
172 .drag_dest_actions
= GDK_ACTION_MOVE
|GDK_ACTION_COPY
,
175 /* Maintaining the list of playlists ---------------------------------------- */
177 /** @brief Current list of playlists or NULL */
180 /** @brief Count of playlists */
183 /** @brief Schedule an update to the list of playlists
185 * Called periodically and when a playlist is created or deleted.
187 static void playlist_list_update(const char attribute((unused
)) *event
,
188 void attribute((unused
)) *eventdata
,
189 void attribute((unused
)) *callbackdata
) {
190 disorder_eclient_playlists(client
, playlist_list_received_playlists
, 0);
193 /** @brief Called with a new list of playlists */
194 static void playlist_list_received_playlists(void attribute((unused
)) *v
,
196 int nvec
, char **vec
) {
200 /* Probably means server does not support playlists */
204 qsort(playlists
, nplaylists
, sizeof (char *), playlistcmp
);
206 /* Tell our consumers */
207 event_raise("playlists-updated", 0);
210 /** @brief qsort() callback for playlist name comparison */
211 static int playlistcmp(const void *ap
, const void *bp
) {
212 const char *a
= *(char **)ap
, *b
= *(char **)bp
;
213 const char *ad
= strchr(a
, '.'), *bd
= strchr(b
, '.');
216 /* Group owned playlists by owner */
218 const int adn
= ad
- a
, bdn
= bd
- b
;
219 if((c
= strncmp(a
, b
, adn
< bdn ? adn
: bdn
)))
221 /* Lexical order within playlists of a single owner */
222 return strcmp(ad
+ 1, bd
+ 1);
225 /* Owned playlists after shared ones */
232 /* Lexical order of shared playlists */
236 /* Playlists menu ----------------------------------------------------------- */
238 static void playlist_menu_playing(void attribute((unused
)) *v
,
241 popup_protocol_error(0, err
);
244 /** @brief Play received playlist contents
246 * Passed as a completion callback by menu_activate_playlist().
248 static void playlist_menu_received_content(void attribute((unused
)) *v
,
250 int nvec
, char **vec
) {
252 popup_protocol_error(0, err
);
255 for(int n
= 0; n
< nvec
; ++n
)
256 disorder_eclient_play(client
, vec
[n
], playlist_menu_playing
, NULL
);
259 /** @brief Called to activate a playlist
261 * Called when the menu item for a playlist is clicked.
263 static void playlist_menu_activate(GtkMenuItem
*menuitem
,
264 gpointer
attribute((unused
)) user_data
) {
265 GtkLabel
*label
= GTK_LABEL(GTK_BIN(menuitem
)->child
);
266 const char *playlist
= gtk_label_get_text(label
);
268 disorder_eclient_playlist_get(client
, playlist_menu_received_content
,
272 /** @brief Called when the playlists change
274 * Naively refills the menu. The results might be unsettling if the menu is
275 * currently open, but this is hopefuly fairly rare.
277 static void playlist_menu_changed(const char attribute((unused
)) *event
,
278 void attribute((unused
)) *eventdata
,
279 void attribute((unused
)) *callbackdata
) {
281 return; /* OMG too soon */
282 GtkMenuShell
*menu
= GTK_MENU_SHELL(playlists_menu
);
283 while(menu
->children
)
284 gtk_container_remove(GTK_CONTAINER(menu
), GTK_WIDGET(menu
->children
->data
));
285 /* NB nplaylists can be -1 as well as 0 */
286 for(int n
= 0; n
< nplaylists
; ++n
) {
287 GtkWidget
*w
= gtk_menu_item_new_with_label(playlists
[n
]);
288 g_signal_connect(w
, "activate", G_CALLBACK(playlist_menu_activate
), 0);
290 gtk_menu_shell_append(menu
, w
);
292 gtk_widget_set_sensitive(menu_playlists_widget
,
294 gtk_widget_set_sensitive(menu_editplaylists_widget
,
298 /* Popup to create a new playlist ------------------------------------------- */
300 /** @brief New-playlist popup */
301 static GtkWidget
*playlist_new_window
;
303 /** @brief Text entry in new-playlist popup */
304 static GtkWidget
*playlist_new_entry
;
306 /** @brief Label for displaying feedback on what's wrong */
307 static GtkWidget
*playlist_new_info
;
309 /** @brief "Shared" radio button */
310 static GtkWidget
*playlist_new_shared
;
312 /** @brief "Public" radio button */
313 static GtkWidget
*playlist_new_public
;
315 /** @brief "Private" radio button */
316 static GtkWidget
*playlist_new_private
;
318 /** @brief Buttons for new-playlist popup */
319 static struct button playlist_new_buttons
[] = {
321 .stock
= GTK_STOCK_OK
,
322 .clicked
= playlist_new_ok
,
323 .tip
= "Create new playlist"
326 .stock
= GTK_STOCK_CANCEL
,
327 .clicked
= playlist_new_cancel
,
328 .tip
= "Do not create new playlist"
331 #define NPLAYLIST_NEW_BUTTONS (sizeof playlist_new_buttons / sizeof *playlist_new_buttons)
333 /** @brief Pop up a new window to enter the playlist name and details */
334 static void playlist_new_playlist(void) {
335 assert(playlist_new_window
== NULL
);
336 playlist_new_window
= gtk_window_new(GTK_WINDOW_TOPLEVEL
);
337 g_signal_connect(playlist_new_window
, "destroy",
338 G_CALLBACK(gtk_widget_destroyed
), &playlist_new_window
);
339 gtk_window_set_title(GTK_WINDOW(playlist_new_window
), "Create new playlist");
340 /* Window will be modal, suppressing access to other windows */
341 gtk_window_set_modal(GTK_WINDOW(playlist_new_window
), TRUE
);
342 gtk_window_set_transient_for(GTK_WINDOW(playlist_new_window
),
343 GTK_WINDOW(playlist_window
));
345 /* Window contents will use a table (grid) layout */
346 GtkWidget
*table
= gtk_table_new(3, 3, FALSE
/*!homogeneous*/);
348 /* First row: playlist name */
349 gtk_table_attach_defaults(GTK_TABLE(table
),
350 gtk_label_new("Playlist name"),
352 playlist_new_entry
= gtk_entry_new();
353 g_signal_connect(playlist_new_entry
, "changed",
354 G_CALLBACK(playlist_new_entry_edited
), NULL
);
355 gtk_table_attach_defaults(GTK_TABLE(table
),
359 /* Second row: radio buttons to choose type */
360 playlist_new_shared
= gtk_radio_button_new_with_label(NULL
, "shared");
362 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared
),
365 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared
),
367 g_signal_connect(playlist_new_shared
, "toggled",
368 G_CALLBACK(playlist_new_button_toggled
), NULL
);
369 g_signal_connect(playlist_new_public
, "toggled",
370 G_CALLBACK(playlist_new_button_toggled
), NULL
);
371 g_signal_connect(playlist_new_private
, "toggled",
372 G_CALLBACK(playlist_new_button_toggled
), NULL
);
373 gtk_table_attach_defaults(GTK_TABLE(table
), playlist_new_shared
, 0, 1, 1, 2);
374 gtk_table_attach_defaults(GTK_TABLE(table
), playlist_new_public
, 1, 2, 1, 2);
375 gtk_table_attach_defaults(GTK_TABLE(table
), playlist_new_private
, 2, 3, 1, 2);
377 /* Third row: info bar saying why not */
378 playlist_new_info
= gtk_label_new("");
379 gtk_table_attach_defaults(GTK_TABLE(table
), playlist_new_info
,
382 /* Fourth row: ok/cancel buttons */
383 GtkWidget
*hbox
= create_buttons_box(playlist_new_buttons
,
384 NPLAYLIST_NEW_BUTTONS
,
385 gtk_hbox_new(FALSE
, 0));
386 gtk_table_attach_defaults(GTK_TABLE(table
), hbox
, 0, 3, 3, 4);
388 gtk_container_add(GTK_CONTAINER(playlist_new_window
),
389 frame_widget(table
, NULL
));
391 /* Set initial state of OK button */
392 playlist_new_changed(0,0,0);
394 g_signal_connect(playlist_new_window
, "key-press-event",
395 G_CALLBACK(playlist_new_keypress
), 0);
397 /* Display the window */
398 gtk_widget_show_all(playlist_new_window
);
401 /** @brief Keypress handler */
402 static gboolean
playlist_new_keypress(GtkWidget
attribute((unused
)) *widget
,
404 gpointer
attribute((unused
)) user_data
) {
407 switch(event
->keyval
) {
409 playlist_new_ok(NULL
, NULL
);
412 gtk_widget_destroy(playlist_new_window
);
419 /** @brief Called when 'ok' is clicked in new-playlist popup */
420 static void playlist_new_ok(GtkButton
attribute((unused
)) *button
,
421 gpointer
attribute((unused
)) userdata
) {
422 if(playlist_new_valid())
424 gboolean shared
, public, private;
425 char *name
, *fullname
;
426 playlist_new_details(&name
, &fullname
, &shared
, &public, &private);
429 * - lock the playlist
430 * - check it doesn't exist
431 * - set sharing (which will create it empty
434 * TODO we should freeze the window while this is going on to stop a second
437 disorder_eclient_playlist_lock(client
, playlist_new_locked
, fullname
,
441 /** @brief Called when the proposed new playlist has been locked */
442 static void playlist_new_locked(void *v
, const char *err
) {
445 popup_protocol_error(0, err
);
448 disorder_eclient_playlist_get(client
, playlist_new_retrieved
,
452 /** @brief Called when the proposed new playlist's contents have been retrieved
454 * ...or rather, normally, when it's been reported that it does not exist.
456 static void playlist_new_retrieved(void *v
, const char *err
,
458 char attribute((unused
)) **vec
) {
460 if(!err
&& nvec
!= -1)
461 /* A rare case but not in principle impossible */
462 err
= "A playlist with that name already exists.";
464 popup_protocol_error(0, err
);
465 disorder_eclient_playlist_unlock(client
, playlist_new_unlocked
, fullname
);
468 gboolean shared
, public, private;
469 playlist_new_details(0, 0, &shared
, &public, &private);
470 disorder_eclient_playlist_set_share(client
, playlist_new_created
, fullname
,
472 : private ?
"private"
477 /** @brief Called when the new playlist has been created */
478 static void playlist_new_created(void attribute((unused
)) *v
, const char *err
) {
480 popup_protocol_error(0, err
);
483 disorder_eclient_playlist_unlock(client
, playlist_new_unlocked
, NULL
);
484 // TODO arrange for the new playlist to be selected
487 /** @brief Called when the newly created playlist has unlocked */
488 static void playlist_new_unlocked(void attribute((unused
)) *v
, const char *err
) {
490 popup_protocol_error(0, err
);
491 /* Pop down the creation window */
492 gtk_widget_destroy(playlist_new_window
);
495 /** @brief Called when 'cancel' is clicked in new-playlist popup */
496 static void playlist_new_cancel(GtkButton
attribute((unused
)) *button
,
497 gpointer
attribute((unused
)) userdata
) {
498 gtk_widget_destroy(playlist_new_window
);
501 /** @brief Called when some radio button in the new-playlist popup changes */
502 static void playlist_new_button_toggled(GtkToggleButton
attribute((unused
)) *tb
,
503 gpointer
attribute((unused
)) userdata
) {
504 playlist_new_changed(0,0,0);
507 /** @brief Called when the text entry field in the new-playlist popup changes */
508 static void playlist_new_entry_edited(GtkEditable
attribute((unused
)) *editable
,
509 gpointer
attribute((unused
)) user_data
) {
510 playlist_new_changed(0,0,0);
513 /** @brief Called to update new playlist window state
515 * This is called whenever one the text entry or radio buttons changed, and
516 * also when the set of known playlists changes. It determines whether the new
517 * playlist would be creatable and sets the sensitivity of the OK button
518 * and info display accordingly.
520 static void playlist_new_changed(const char attribute((unused
)) *event
,
521 void attribute((unused
)) *eventdata
,
522 void attribute((unused
)) *callbackdata
) {
523 if(!playlist_new_window
)
525 const char *reason
= playlist_new_valid();
526 gtk_widget_set_sensitive(playlist_new_buttons
[0].widget
,
528 gtk_label_set_text(GTK_LABEL(playlist_new_info
), reason
);
531 /** @brief Test whether the new-playlist window settings are valid
532 * @return NULL on success or an error string if not
534 static const char *playlist_new_valid(void) {
535 gboolean shared
, public, private;
536 char *name
, *fullname
;
537 playlist_new_details(&name
, &fullname
, &shared
, &public, &private);
538 if(!(shared
|| public || private))
539 return "No type set.";
542 /* See if the result is valid */
543 if(!valid_username(name
)
544 || playlist_parse_name(fullname
, NULL
, NULL
))
545 return "Not a valid playlist name.";
546 /* See if the result clashes with an existing name. This is not a perfect
547 * check, the playlist might be created after this point but before we get a
548 * chance to disable the "OK" button. However when we try to create the
549 * playlist we will first try to retrieve it, with a lock held, so we
550 * shouldn't end up overwriting anything. */
551 for(int n
= 0; n
< nplaylists
; ++n
)
552 if(!strcmp(playlists
[n
], fullname
)) {
554 return "A shared playlist with that name already exists.";
556 return "You already have a playlist with that name.";
558 /* As far as we can tell creation would work */
562 /** @brief Get entered new-playlist details
563 * @param namep Where to store entered name (or NULL)
564 * @param fullnamep Where to store computed full name (or NULL)
565 * @param sharep Where to store 'shared' flag (or NULL)
566 * @param publicp Where to store 'public' flag (or NULL)
567 * @param privatep Where to store 'private' flag (or NULL)
569 static void playlist_new_details(char **namep
,
573 gboolean
*privatep
) {
574 gboolean shared
, public, private;
575 g_object_get(playlist_new_shared
, "active", &shared
, (char *)NULL
);
576 g_object_get(playlist_new_public
, "active", &public, (char *)NULL
);
577 g_object_get(playlist_new_private
, "active", &private, (char *)NULL
);
578 char *gname
= gtk_editable_get_chars(GTK_EDITABLE(playlist_new_entry
),
579 0, -1); /* name owned by calle */
580 char *name
= xstrdup(gname
);
582 if(sharedp
) *sharedp
= shared
;
583 if(publicp
) *publicp
= public;
584 if(privatep
) *privatep
= private;
585 if(namep
) *namep
= name
;
587 if(*sharedp
) *fullnamep
= *namep
;
588 else byte_xasprintf(fullnamep
, "%s.%s", config
->username
, name
);
592 /* Playlist picker ---------------------------------------------------------- */
594 /** @brief Delete button */
595 static GtkWidget
*playlist_picker_delete_button
;
597 /** @brief Tree model for list of playlists */
598 static GtkListStore
*playlist_picker_list
;
600 /** @brief Selection for list of playlists */
601 static GtkTreeSelection
*playlist_picker_selection
;
603 /** @brief Currently selected playlist */
604 static const char *playlist_picker_selected
;
606 /** @brief (Re-)populate the playlist picker tree model */
607 static void playlist_picker_fill(const char attribute((unused
)) *event
,
608 void attribute((unused
)) *eventdata
,
609 void attribute((unused
)) *callbackdata
) {
614 if(!playlist_picker_list
)
615 playlist_picker_list
= gtk_list_store_new(1, G_TYPE_STRING
);
616 const char *was_selected
= playlist_picker_selected
;
617 gtk_list_store_clear(playlist_picker_list
); /* clears playlists_selected */
618 for(int n
= 0; n
< nplaylists
; ++n
) {
619 gtk_list_store_insert_with_values(playlist_picker_list
, iter
,
621 0, playlists
[n
], /* column 0 */
622 -1); /* no more cols */
623 /* Reselect the selected playlist */
624 if(was_selected
&& !strcmp(was_selected
, playlists
[n
]))
625 gtk_tree_selection_select_iter(playlist_picker_selection
, iter
);
627 /* TODO deselecting then reselecting the current playlist resets the playlist
628 * editor, which trashes the user's selection. */
631 /** @brief Called when the selection might have changed */
632 static void playlist_picker_selection_changed(GtkTreeSelection
attribute((unused
)) *treeselection
,
633 gpointer
attribute((unused
)) user_data
) {
635 char *gselected
, *selected
;
637 /* Identify the current selection */
638 if(gtk_tree_selection_get_selected(playlist_picker_selection
, 0, &iter
)) {
639 gtk_tree_model_get(GTK_TREE_MODEL(playlist_picker_list
), &iter
,
641 selected
= xstrdup(gselected
);
645 /* Set button sensitivity according to the new state */
647 gtk_widget_set_sensitive(playlist_picker_delete_button
, 1);
649 gtk_widget_set_sensitive(playlist_picker_delete_button
, 0);
650 /* TODO delete should not be sensitive for public playlists owned by other
652 /* Eliminate no-change cases */
653 if(!selected
&& !playlist_picker_selected
)
656 && playlist_picker_selected
657 && !strcmp(selected
, playlist_picker_selected
))
659 /* Record the new state */
660 playlist_picker_selected
= selected
;
661 /* Re-initalize the queue */
662 ql_new_queue(&ql_playlist
, NULL
);
663 /* Synthesize a playlist-modified to re-initialize the editor etc */
664 event_raise("playlist-modified", (void *)playlist_picker_selected
);
667 /** @brief Called when the 'add' button is pressed */
668 static void playlist_picker_add(GtkButton
attribute((unused
)) *button
,
669 gpointer
attribute((unused
)) userdata
) {
670 /* Unselect whatever is selected TODO why?? */
671 gtk_tree_selection_unselect_all(playlist_picker_selection
);
672 playlist_new_playlist();
675 /** @brief Called when playlist deletion completes */
676 static void playlists_picker_delete_completed(void attribute((unused
)) *v
,
679 popup_protocol_error(0, err
);
682 /** @brief Called when the 'Delete' button is pressed */
683 static void playlist_picker_delete(GtkButton
attribute((unused
)) *button
,
684 gpointer
attribute((unused
)) userdata
) {
688 if(!playlist_picker_selected
)
690 yesno
= gtk_message_dialog_new(GTK_WINDOW(playlist_window
),
692 GTK_MESSAGE_QUESTION
,
694 "Do you really want to delete playlist %s?"
695 " This action cannot be undone.",
696 playlist_picker_selected
);
697 res
= gtk_dialog_run(GTK_DIALOG(yesno
));
698 gtk_widget_destroy(yesno
);
699 if(res
== GTK_RESPONSE_YES
) {
700 disorder_eclient_playlist_delete(client
,
701 playlists_picker_delete_completed
,
702 playlist_picker_selected
,
707 /** @brief Table of buttons below the playlist list */
708 static struct button playlist_picker_buttons
[] = {
712 "Create a new playlist",
717 playlist_picker_delete
,
722 #define NPLAYLIST_PICKER_BUTTONS (sizeof playlist_picker_buttons / sizeof *playlist_picker_buttons)
724 /** @brief Create the list of playlists for the edit playlists window */
725 static GtkWidget
*playlist_picker_create(void) {
726 /* Create the list of playlist and populate it */
727 playlist_picker_fill(NULL
, NULL
, NULL
);
728 /* Create the tree view */
729 GtkWidget
*tree
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(playlist_picker_list
));
730 /* ...and the renderers for it */
731 GtkCellRenderer
*cr
= gtk_cell_renderer_text_new();
732 GtkTreeViewColumn
*col
= gtk_tree_view_column_new_with_attributes("Playlist",
736 gtk_tree_view_append_column(GTK_TREE_VIEW(tree
), col
);
737 /* Get the selection for the view; set its mode; arrange for a callback when
739 playlist_picker_selected
= NULL
;
740 playlist_picker_selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(tree
));
741 gtk_tree_selection_set_mode(playlist_picker_selection
, GTK_SELECTION_BROWSE
);
742 g_signal_connect(playlist_picker_selection
, "changed",
743 G_CALLBACK(playlist_picker_selection_changed
), NULL
);
745 /* Create the control buttons */
746 GtkWidget
*buttons
= create_buttons_box(playlist_picker_buttons
,
747 NPLAYLIST_PICKER_BUTTONS
,
748 gtk_hbox_new(FALSE
, 1));
749 playlist_picker_delete_button
= playlist_picker_buttons
[1].widget
;
751 playlist_picker_selection_changed(NULL
, NULL
);
753 /* Buttons live below the list */
754 GtkWidget
*vbox
= gtk_vbox_new(FALSE
, 0);
755 gtk_box_pack_start(GTK_BOX(vbox
), scroll_widget(tree
), TRUE
/*expand*/, TRUE
/*fill*/, 0);
756 gtk_box_pack_start(GTK_BOX(vbox
), buttons
, FALSE
/*expand*/, FALSE
, 0);
758 g_signal_connect(tree
, "key-press-event",
759 G_CALLBACK(playlist_picker_keypress
), 0);
764 static gboolean
playlist_picker_keypress(GtkWidget
attribute((unused
)) *widget
,
766 gpointer
attribute((unused
)) user_data
) {
769 switch(event
->keyval
) {
772 playlist_picker_delete(NULL
, NULL
);
779 static void playlist_picker_destroy(void) {
780 playlist_picker_delete_button
= NULL
;
781 g_object_unref(playlist_picker_list
);
782 playlist_picker_list
= NULL
;
783 playlist_picker_selection
= NULL
;
784 playlist_picker_selected
= NULL
;
787 /* Playlist editor ---------------------------------------------------------- */
789 static GtkWidget
*playlist_editor_shared
;
790 static GtkWidget
*playlist_editor_public
;
791 static GtkWidget
*playlist_editor_private
;
792 static int playlist_editor_setting_buttons
;
794 static GtkWidget
*playlists_editor_create(void) {
795 assert(ql_playlist
.view
== NULL
); /* better not be set up already */
797 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 0);
798 playlist_editor_shared
= gtk_radio_button_new_with_label(NULL
, "shared");
799 playlist_editor_public
800 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_editor_shared
),
802 playlist_editor_private
803 = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_editor_shared
),
805 g_signal_connect(playlist_editor_public
, "toggled",
806 G_CALLBACK(playlist_editor_button_toggled
),
808 g_signal_connect(playlist_editor_private
, "toggled",
809 G_CALLBACK(playlist_editor_button_toggled
),
811 gtk_box_pack_start(GTK_BOX(hbox
), playlist_editor_shared
,
812 FALSE
/*expand*/, FALSE
/*fill*/, 0);
813 gtk_box_pack_start(GTK_BOX(hbox
), playlist_editor_public
,
814 FALSE
/*expand*/, FALSE
/*fill*/, 0);
815 gtk_box_pack_start(GTK_BOX(hbox
), playlist_editor_private
,
816 FALSE
/*expand*/, FALSE
/*fill*/, 0);
817 playlist_editor_set_buttons(0,0,0);
819 GtkWidget
*vbox
= gtk_vbox_new(FALSE
, 0);
820 gtk_box_pack_start(GTK_BOX(vbox
), init_queuelike(&ql_playlist
),
821 TRUE
/*expand*/, TRUE
/*fill*/, 0);
822 gtk_box_pack_start(GTK_BOX(vbox
), hbox
,
823 FALSE
/*expand*/, FALSE
/*fill*/, 0);
827 /** @brief Called when the public/private buttons are set */
828 static void playlist_editor_button_toggled(GtkToggleButton
*tb
,
830 const char *state
= userdata
;
831 if(!gtk_toggle_button_get_active(tb
)
832 || !playlist_picker_selected
833 || playlist_editor_setting_buttons
)
835 disorder_eclient_playlist_set_share(client
, playlist_editor_share_set
,
836 playlist_picker_selected
, state
, NULL
);
839 static void playlist_editor_share_set(void attribute((unused
)) *v
,
840 const attribute((unused
)) char *err
) {
842 popup_protocol_error(0, err
);
845 /** @brief Set the editor button state and sensitivity */
846 static void playlist_editor_set_buttons(const char attribute((unused
)) *event
,
848 void attribute((unused
)) *callbackdata
) {
849 /* If this event is for a non-selected playlist do nothing */
851 && playlist_picker_selected
852 && strcmp(eventdata
, playlist_picker_selected
))
854 if(playlist_picker_selected
) {
855 if(strchr(playlist_picker_selected
, '.'))
856 disorder_eclient_playlist_get_share(client
,
857 playlist_editor_got_share
,
858 playlist_picker_selected
,
859 (void *)playlist_picker_selected
);
861 playlist_editor_got_share((void *)playlist_picker_selected
, NULL
,
864 playlist_editor_got_share(NULL
, NULL
, NULL
);
867 /** @brief Called with playlist sharing details */
868 static void playlist_editor_got_share(void *v
,
871 const char *playlist
= v
;
873 popup_protocol_error(0, err
);
876 /* Set the currently active button */
877 ++playlist_editor_setting_buttons
;
878 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(playlist_editor_shared
),
879 value
&& !strcmp(value
, "shared"));
880 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(playlist_editor_public
),
881 value
&& !strcmp(value
, "public"));
882 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(playlist_editor_private
),
883 value
&& !strcmp(value
, "private"));
884 /* Set button sensitivity */
885 gtk_widget_set_sensitive(playlist_editor_shared
, FALSE
);
886 int sensitive
= (playlist
887 && strchr(playlist
, '.')
888 && !strncmp(playlist
, config
->username
,
889 strlen(config
->username
)));
890 gtk_widget_set_sensitive(playlist_editor_public
, sensitive
);
891 gtk_widget_set_sensitive(playlist_editor_private
, sensitive
);
892 --playlist_editor_setting_buttons
;
895 /** @brief (Re-)populate the playlist tree model */
896 static void playlist_editor_fill(const char attribute((unused
)) *event
,
898 void attribute((unused
)) *callbackdata
) {
899 const char *modified_playlist
= eventdata
;
902 if(!playlist_picker_selected
)
904 if(!strcmp(playlist_picker_selected
, modified_playlist
))
905 disorder_eclient_playlist_get(client
, playlists_editor_received_tracks
,
906 playlist_picker_selected
,
907 (void *)playlist_picker_selected
);
910 /** @brief Called with new tracks for the playlist */
911 static void playlists_editor_received_tracks(void *v
,
913 int nvec
, char **vec
) {
914 const char *playlist
= v
;
916 popup_protocol_error(0, err
);
919 if(!playlist_picker_selected
920 || strcmp(playlist
, playlist_picker_selected
)) {
921 /* The tracks are for the wrong playlist - something must have changed
922 * while the fetch command was in flight. We just ignore this callback,
923 * the right answer will be requested and arrive in due course. */
927 /* No such playlist, presumably we'll get a deleted event shortly */
929 /* Translate the list of tracks into queue entries */
930 struct queue_entry
*newq
, **qq
= &newq
, *qprev
= NULL
;
931 hash
*h
= hash_new(sizeof(int));
932 for(int n
= 0; n
< nvec
; ++n
) {
933 struct queue_entry
*q
= xmalloc(sizeof *q
);
936 /* Synthesize a unique ID so that the selection survives updates. Tracks
937 * can appear more than once in the queue so we can't use raw track names,
938 * so we add a serial number to the start. */
939 int *serialp
= hash_find(h
, vec
[n
]), serial
= serialp ?
*serialp
: 0;
940 byte_xasprintf((char **)&q
->id
, "%d-%s", serial
++, vec
[n
]);
941 hash_add(h
, vec
[n
], &serial
, HASH_INSERT_OR_REPLACE
);
947 ql_new_queue(&ql_playlist
, newq
);
950 /* Playlist mutation -------------------------------------------------------- */
952 /** @brief State structure for guarded playlist modification
954 * To safely move, insert or delete rows we must:
956 * - fetch the playlist
957 * - verify it's not changed
958 * - update the playlist contents
959 * - store the playlist
962 * The playlist_modify_ functions do just that.
964 * To kick things off create one of these and disorder_eclient_playlist_lock()
965 * with playlist_modify_locked() as its callback. @c modify will be called; it
966 * should disorder_eclient_playlist_set() to set the new state with
967 * playlist_modify_updated() as its callback.
969 struct playlist_modify_data
{
970 /** @brief Affected playlist */
971 const char *playlist
;
972 /** @brief Modification function
973 * @param mod Pointer back to state structure
974 * @param ntracks Length of playlist
975 * @param tracks Tracks in playlist
977 void (*modify
)(struct playlist_modify_data
*mod
,
978 int ntracks
, char **tracks
);
980 /** @brief Number of tracks dropped */
982 /** @brief Track names dropped */
984 /** @brief Track IDs dropped */
986 /** @brief Drop after this point */
987 struct queue_entry
*after_me
;
990 /** @brief Called with playlist locked
992 * This is the entry point for guarded modification ising @ref
993 * playlist_modify_data.
995 static void playlist_modify_locked(void *v
, const char *err
) {
996 struct playlist_modify_data
*mod
= v
;
998 popup_protocol_error(0, err
);
1001 disorder_eclient_playlist_get(client
, playlist_modify_retrieved
,
1002 mod
->playlist
, mod
);
1005 /** @brief Called with current playlist contents
1006 * Checks that the playlist is still current and has not changed.
1008 void playlist_modify_retrieved(void *v
, const char *err
,
1011 struct playlist_modify_data
*mod
= v
;
1013 popup_protocol_error(0, err
);
1014 disorder_eclient_playlist_unlock(client
, playlist_modify_unlocked
, NULL
);
1018 || !playlist_picker_selected
1019 || strcmp(mod
->playlist
, playlist_picker_selected
)) {
1020 disorder_eclient_playlist_unlock(client
, playlist_modify_unlocked
, NULL
);
1023 /* We check that the contents haven't changed. If they have we just abandon
1024 * the operation. The user will have to try again. */
1025 struct queue_entry
*q
;
1027 for(n
= 0, q
= ql_playlist
.q
; q
&& n
< nvec
; ++n
, q
= q
->next
)
1028 if(strcmp(q
->track
, vec
[n
]))
1030 if(n
!= nvec
|| q
!= NULL
) {
1031 disorder_eclient_playlist_unlock(client
, playlist_modify_unlocked
, NULL
);
1034 mod
->modify(mod
, nvec
, vec
);
1037 /** @brief Called when the playlist has been updated */
1038 static void playlist_modify_updated(void attribute((unused
)) *v
,
1041 popup_protocol_error(0, err
);
1042 disorder_eclient_playlist_unlock(client
, playlist_modify_unlocked
, NULL
);
1045 /** @brief Called when the playlist has been unlocked */
1046 static void playlist_modify_unlocked(void attribute((unused
)) *v
,
1049 popup_protocol_error(0, err
);
1052 /* Drop tracks into a playlist ---------------------------------------------- */
1054 static void playlist_drop(struct queuelike
attribute((unused
)) *ql
,
1056 char **tracks
, char **ids
,
1057 struct queue_entry
*after_me
) {
1058 struct playlist_modify_data
*mod
= xmalloc(sizeof *mod
);
1060 mod
->playlist
= playlist_picker_selected
;
1061 mod
->modify
= playlist_drop_modify
;
1062 mod
->ntracks
= ntracks
;
1063 mod
->tracks
= tracks
;
1065 mod
->after_me
= after_me
;
1066 disorder_eclient_playlist_lock(client
, playlist_modify_locked
,
1067 mod
->playlist
, mod
);
1070 /** @brief Return true if track @p i is in the moved set */
1071 static int playlist_drop_is_moved(struct playlist_modify_data
*mod
,
1073 struct queue_entry
*q
;
1075 /* Find the q corresponding to i, so we can get the ID */
1076 for(q
= ql_playlist
.q
; i
; q
= q
->next
, --i
)
1078 /* See if track i matches any of the moved set by ID */
1079 for(int n
= 0; n
< mod
->ntracks
; ++n
)
1080 if(!strcmp(q
->id
, mod
->ids
[n
]))
1085 static void playlist_drop_modify(struct playlist_modify_data
*mod
,
1086 int nvec
, char **vec
) {
1090 //fprintf(stderr, "\nplaylist_drop_modify\n");
1091 /* after_me is the queue_entry to insert after, or NULL to insert at the
1092 * beginning (including the case when the playlist is empty) */
1093 //fprintf(stderr, "after_me = %s\n",
1094 // mod->after_me ? mod->after_me->track : "NULL");
1095 struct queue_entry
*q
= ql_playlist
.q
;
1099 while(q
&& q
!= mod
->after_me
) {
1104 /* Now ins is the index to insert at; equivalently, the row to insert before,
1105 * and so equal to nvec to append. */
1107 fprintf(stderr
, "ins = %d = %s\n",
1108 ins
, ins
< nvec ? vec
[ins
] : "NULL");
1109 for(int n
= 0; n
< nvec
; ++n
)
1110 fprintf(stderr
, "%d: %s %s\n", n
, n
== ins ?
"->" : " ", vec
[n
]);
1111 fprintf(stderr
, "nvec = %d\n", nvec
);
1114 /* This is a rearrangement */
1116 * - vec[], the current layout
1117 * - ins, pointing into vec
1118 * - mod->tracks[], a subset of vec[] which is to be moved
1120 * ins is the insertion point BUT it is in terms of the whole
1121 * array, i.e. before mod->tracks[] have been removed. The first
1122 * step then is to remove everything in mod->tracks[] and adjust
1123 * ins downwards as necessary.
1125 /* First zero out anything that's moved */
1127 for(int n
= 0; n
< nvec
; ++n
) {
1128 if(playlist_drop_is_moved(mod
, n
)) {
1134 /* Now collapse down the array */
1136 for(int n
= 0; n
< nvec
; ++n
) {
1140 assert(i
+ mod
->ntracks
== nvec
);
1142 /* Adjust the insertion point to take account of things moved from before
1145 /* The effect is now the same as an insertion */
1147 /* This is (now) an insertion */
1148 nnewvec
= nvec
+ mod
->ntracks
;
1149 newvec
= xcalloc(nnewvec
, sizeof (char *));
1151 ins
* sizeof (char *));
1152 memcpy(newvec
+ ins
, mod
->tracks
,
1153 mod
->ntracks
* sizeof (char *));
1154 memcpy(newvec
+ ins
+ mod
->ntracks
, vec
+ ins
,
1155 (nvec
- ins
) * sizeof (char *));
1156 disorder_eclient_playlist_set(client
, playlist_modify_updated
, mod
->playlist
,
1157 newvec
, nnewvec
, mod
);
1160 /* Playlist editor right-click menu ---------------------------------------- */
1162 /** @brief Called to determine whether the playlist is playable */
1163 static int playlist_playall_sensitive(void attribute((unused
)) *extra
) {
1164 /* If there's no playlist obviously we can't play it */
1165 if(!playlist_picker_selected
)
1167 /* If it's empty we can't play it */
1170 /* Otherwise we can */
1174 /** @brief Called to play the selected playlist */
1175 static void playlist_playall_activate(GtkMenuItem
attribute((unused
)) *menuitem
,
1176 gpointer
attribute((unused
)) user_data
) {
1177 if(!playlist_picker_selected
)
1179 /* Re-use the menu-based activation callback */
1180 disorder_eclient_playlist_get(client
, playlist_menu_received_content
,
1181 playlist_picker_selected
, NULL
);
1184 /** @brief Called to determine whether the playlist is playable */
1185 static int playlist_remove_sensitive(void attribute((unused
)) *extra
) {
1186 /* If there's no playlist obviously we can't remove from it */
1187 if(!playlist_picker_selected
)
1189 /* If no tracks are selected we cannot remove them */
1190 if(!gtk_tree_selection_count_selected_rows(ql_playlist
.selection
))
1192 /* We're good to go */
1196 /** @brief Called to remove the selected playlist */
1197 static void playlist_remove_activate(GtkMenuItem
attribute((unused
)) *menuitem
,
1198 gpointer
attribute((unused
)) user_data
) {
1199 if(!playlist_picker_selected
)
1201 struct playlist_modify_data
*mod
= xmalloc(sizeof *mod
);
1203 mod
->playlist
= playlist_picker_selected
;
1204 mod
->modify
= playlist_remove_modify
;
1205 disorder_eclient_playlist_lock(client
, playlist_modify_locked
,
1206 mod
->playlist
, mod
);
1209 static void playlist_remove_modify(struct playlist_modify_data
*mod
,
1210 int attribute((unused
)) nvec
, char **vec
) {
1211 GtkTreeIter iter
[1];
1212 gboolean it
= gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql_playlist
.store
),
1216 if(!gtk_tree_selection_iter_is_selected(ql_playlist
.selection
, iter
))
1217 vec
[m
++] = vec
[n
++];
1220 it
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_playlist
.store
), iter
);
1222 disorder_eclient_playlist_set(client
, playlist_modify_updated
, mod
->playlist
,
1226 /* Playlists window --------------------------------------------------------- */
1228 /** @brief Pop up the playlists window
1230 * Called when the playlists menu item is selected
1232 void playlist_window_create(gpointer
attribute((unused
)) callback_data
,
1233 guint
attribute((unused
)) callback_action
,
1234 GtkWidget
attribute((unused
)) *menu_item
) {
1235 /* If the window already exists, raise it */
1236 if(playlist_window
) {
1237 gtk_window_present(GTK_WINDOW(playlist_window
));
1240 /* Create the window */
1241 playlist_window
= gtk_window_new(GTK_WINDOW_TOPLEVEL
);
1242 gtk_widget_set_style(playlist_window
, tool_style
);
1243 g_signal_connect(playlist_window
, "destroy",
1244 G_CALLBACK(playlist_window_destroyed
), &playlist_window
);
1245 gtk_window_set_title(GTK_WINDOW(playlist_window
), "Playlists Management");
1246 /* TODO loads of this is very similar to (copied from!) users.c - can we
1248 /* Keyboard shortcuts */
1249 g_signal_connect(playlist_window
, "key-press-event",
1250 G_CALLBACK(playlist_window_keypress
), 0);
1251 /* default size is too small */
1252 gtk_window_set_default_size(GTK_WINDOW(playlist_window
), 640, 320);
1254 GtkWidget
*hbox
= gtk_hbox_new(FALSE
, 0);
1255 gtk_box_pack_start(GTK_BOX(hbox
), playlist_picker_create(),
1256 FALSE
/*expand*/, FALSE
, 0);
1257 gtk_box_pack_start(GTK_BOX(hbox
), gtk_event_box_new(),
1258 FALSE
/*expand*/, FALSE
, 2);
1259 gtk_box_pack_start(GTK_BOX(hbox
), playlists_editor_create(),
1260 TRUE
/*expand*/, TRUE
/*fill*/, 0);
1262 gtk_container_add(GTK_CONTAINER(playlist_window
), frame_widget(hbox
, NULL
));
1263 gtk_widget_show_all(playlist_window
);
1266 /** @brief Keypress handler */
1267 static gboolean
playlist_window_keypress(GtkWidget
attribute((unused
)) *widget
,
1269 gpointer
attribute((unused
)) user_data
) {
1272 switch(event
->keyval
) {
1274 gtk_widget_destroy(playlist_window
);
1281 /** @brief Called when the playlist window is destroyed */
1282 static void playlist_window_destroyed(GtkWidget
attribute((unused
)) *widget
,
1283 GtkWidget
**widget_pointer
) {
1284 destroy_queuelike(&ql_playlist
);
1285 playlist_picker_destroy();
1286 *widget_pointer
= NULL
;
1289 /** @brief Initialize playlist support */
1290 void playlists_init(void) {
1291 /* We re-get all playlists upon any change... */
1292 event_register("playlist-created", playlist_list_update
, 0);
1293 event_register("playlist-deleted", playlist_list_update
, 0);
1294 /* ...and on reconnection */
1295 event_register("log-connected", playlist_list_update
, 0);
1296 /* ...and from time to time */
1297 event_register("periodic-slow", playlist_list_update
, 0);
1298 /* ...and at startup */
1299 playlist_list_update(0, 0, 0);
1301 /* Update the playlists menu when the set of playlists changes */
1302 event_register("playlists-updated", playlist_menu_changed
, 0);
1303 /* Update the new-playlist OK button when the set of playlists changes */
1304 event_register("playlists-updated", playlist_new_changed
, 0);
1305 /* Update the list of playlists in the edit window when the set changes */
1306 event_register("playlists-updated", playlist_picker_fill
, 0);
1307 /* Update the displayed playlist when it is modified */
1308 event_register("playlist-modified", playlist_editor_fill
, 0);
1309 /* Update the shared/public/etc buttons when a playlist is modified */
1310 event_register("playlist-modified", playlist_editor_set_buttons
, 0);
1318 indent-tabs-mode:nil