Preserve playlist selection when list changes
[disorder] / disobedience / playlists.c
index 7e0eec1..31576ad 100644 (file)
@@ -30,6 +30,7 @@
 #include "disobedience.h"
 #include "queue-generic.h"
 #include "popup.h"
+#include "validity.h"
 
 #if PLAYLISTS
 
@@ -194,6 +195,259 @@ static void menu_playlists_changed(const char attribute((unused)) *event,
                            nplaylists >= 0);
 }
 
+/* Popup to create a new playlist ------------------------------------------- */
+
+/** @brief New-playlist popup */
+static GtkWidget *playlist_new_window;
+
+/** @brief Text entry in new-playlist popup */
+static GtkWidget *playlist_new_entry;
+
+static GtkWidget *playlist_new_info;
+
+static GtkWidget *playlist_new_shared;
+static GtkWidget *playlist_new_public;
+static GtkWidget *playlist_new_private;
+
+/** @brief Get entered new-playlist details */
+static void playlist_new_details(char **namep,
+                                 char **fullnamep,
+                                 gboolean *sharedp,
+                                 gboolean *publicp,
+                                 gboolean *privatep) {
+  gboolean shared, public, private;
+  g_object_get(playlist_new_shared, "active", &shared, (char *)NULL);
+  g_object_get(playlist_new_public, "active", &public, (char *)NULL);
+  g_object_get(playlist_new_private, "active", &private, (char *)NULL);
+  char *gname = gtk_editable_get_chars(GTK_EDITABLE(playlist_new_entry),
+                                       0, -1); /* name owned by calle */
+  char *name = xstrdup(gname);
+  g_free(gname);
+  if(sharedp) *sharedp = shared;
+  if(publicp) *publicp = public;
+  if(privatep) *privatep = private;
+  if(namep) *namep = name;
+  if(fullnamep) {
+    if(*sharedp) *fullnamep = *namep;
+    else byte_xasprintf(fullnamep, "%s.%s", config->username, name);
+  }
+}
+
+/** @brief Called when the newly created playlist has unlocked */
+static void playlist_new_unlocked(void attribute((unused)) *v, const char *err) {
+  if(err)
+    popup_protocol_error(0, err);
+  gtk_widget_destroy(playlist_new_window);
+}
+
+/** @brief Called when the new playlist has been created */
+static void playlist_new_created(void attribute((unused)) *v, const char *err) {
+  if(err) {
+    popup_protocol_error(0, err);
+    return;
+  }
+  disorder_eclient_playlist_unlock(client, playlist_new_unlocked, NULL);
+  // TODO arrange for the new playlist to be selected
+}
+
+/** @brief Called when the proposed new playlist's contents have been retrieved
+ *
+ * ...or rather, normally, when it's been reported that it does not exist.
+ */
+static void playlist_new_retrieved(void *v, const char *err,
+                                   int nvec,
+                                   char attribute((unused)) **vec) {
+  char *fullname = v;
+  if(!err && nvec != -1)
+    /* A rare case but not in principle impossible */
+    err = "A playlist with that name already exists.";
+  if(err) {
+    popup_protocol_error(0, err);
+    disorder_eclient_playlist_unlock(client, playlist_new_unlocked, fullname);
+    return;
+  }
+  gboolean shared, public, private;
+  playlist_new_details(0, 0, &shared, &public, &private);
+  disorder_eclient_playlist_set_share(client, playlist_new_created, fullname,
+                                      public ? "public"
+                                      : private ? "private"
+                                      : "shared",
+                                      fullname);
+}
+
+/** @brief Called when the proposed new playlist has been locked */
+static void playlist_new_locked(void *v, const char *err) {
+  char *fullname = v;
+  if(err) {
+    popup_protocol_error(0, err);
+    return;
+  }
+  disorder_eclient_playlist_get(client, playlist_new_retrieved,
+                                fullname, fullname);
+}
+
+/** @brief Called when 'ok' is clicked in new-playlist popup */
+static void playlist_new_ok(GtkButton attribute((unused)) *button,
+                            gpointer attribute((unused)) userdata) {
+  gboolean shared, public, private;
+  char *name, *fullname;
+  playlist_new_details(&name, &fullname, &shared, &public, &private);
+
+  /* We need to:
+   * - lock the playlist
+   * - check it doesn't exist
+   * - set sharing (which will create it empty
+   * - unlock it
+   *
+   * TODO we should freeze the window while this is going on
+   */
+  disorder_eclient_playlist_lock(client, playlist_new_locked, fullname,
+                                 fullname);
+}
+
+/** @brief Called when 'cancel' is clicked in new-playlist popup */
+static void playlist_new_cancel(GtkButton attribute((unused)) *button,
+                                gpointer attribute((unused)) userdata) {
+  gtk_widget_destroy(playlist_new_window);
+}
+
+/** @brief Buttons for new-playlist popup */
+static struct button playlist_new_buttons[] = {
+  {
+    .stock = GTK_STOCK_OK,
+    .clicked = playlist_new_ok,
+    .tip = "Create new playlist"
+  },
+  {
+    .stock = GTK_STOCK_CANCEL,
+    .clicked = playlist_new_cancel,
+    .tip = "Do not create new playlist"
+  }
+};
+#define NPLAYLIST_NEW_BUTTONS (sizeof playlist_new_buttons / sizeof *playlist_new_buttons)
+
+/** @brief Test whether the new-playlist window settings are valid
+ * @return NULL on success or an error string if not
+ */
+static const char *playlist_new_valid(void) {
+  gboolean shared, public, private;
+  char *name, *fullname;
+  playlist_new_details(&name, &fullname, &shared, &public, &private);
+  if(!(shared || public || private))
+    return "No type set.";
+  if(!*name)
+    return "";
+  /* See if the result is valid */
+  if(!valid_username(name)
+     || playlist_parse_name(fullname, NULL, NULL))
+    return "Not a valid playlist name.";
+  /* See if the result clashes with an existing name */
+  for(int n = 0; n < nplaylists; ++n)
+    if(!strcmp(playlists[n], fullname)) {
+      if(shared)
+        return "A shared playlist with that name already exists.";
+      else
+        return "You already have a playlist with that name.";
+    }
+  /* As far as we can tell creation would work */
+  return NULL;
+}
+
+/** @brief Called to update new playlist window state
+ *
+ * This is called whenever one the text entry or radio buttons changed, and
+ * also when the set of known playlists changes.  It determines whether the new
+ * playlist would be creatable and sets the sensitivity of the OK button
+ * and info display accordingly.
+ */
+static void playlist_new_changed(const char attribute((unused)) *event,
+                                 void attribute((unused)) *eventdata,
+                                 void attribute((unused)) *callbackdata) {
+  if(!playlist_new_window)
+    return;
+  const char *reason = playlist_new_valid();
+  gtk_widget_set_sensitive(playlist_new_buttons[0].widget,
+                           !reason);
+  gtk_label_set_text(GTK_LABEL(playlist_new_info), reason);
+}
+
+/** @brief Called when some radio button in the new-playlist popup changes */
+static void playlist_new_button_toggled(GtkToggleButton attribute((unused)) tb,
+                                        gpointer attribute((unused)) userdata) {
+  playlist_new_changed(0,0,0);
+}
+
+/** @brief Called when the text entry field in the new-playlist popup changes */
+static void playlist_new_entry_edited(GtkEditable attribute((unused)) *editable,
+                                      gpointer attribute((unused)) user_data) {
+  playlist_new_changed(0,0,0);
+}
+
+/** @brief Pop up a new window to enter the playlist name and details */
+static void playlist_new(void) {
+  assert(playlist_new_window == NULL);
+  playlist_new_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
+  g_signal_connect(playlist_new_window, "destroy",
+                  G_CALLBACK(gtk_widget_destroyed), &playlist_new_window);
+  gtk_window_set_title(GTK_WINDOW(playlist_new_window), "Create new playlist");
+  /* Window will be modal, suppressing access to other windows */
+  gtk_window_set_modal(GTK_WINDOW(playlist_new_window), TRUE);
+  gtk_window_set_transient_for(GTK_WINDOW(playlist_new_window),
+                               GTK_WINDOW(playlists_window));
+
+  /* Window contents will use a table (grid) layout */
+  GtkWidget *table = gtk_table_new(3, 3, FALSE/*!homogeneous*/);
+
+  /* First row: playlist name */
+  gtk_table_attach_defaults(GTK_TABLE(table),
+                            gtk_label_new("Playlist name"),
+                            0, 1, 0, 1);
+  playlist_new_entry = gtk_entry_new();
+  g_signal_connect(playlist_new_entry, "changed",
+                   G_CALLBACK(playlist_new_entry_edited), NULL);
+  gtk_table_attach_defaults(GTK_TABLE(table),
+                            playlist_new_entry,
+                            1, 3, 0, 1);
+
+  /* Second row: radio buttons to choose type */
+  playlist_new_shared = gtk_radio_button_new_with_label(NULL, "shared");
+  playlist_new_public
+    = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared),
+                                                  "public");
+  playlist_new_private
+    = gtk_radio_button_new_with_label_from_widget(GTK_RADIO_BUTTON(playlist_new_shared),
+                                                  "private");
+  g_signal_connect(playlist_new_shared, "toggled",
+                   G_CALLBACK(playlist_new_button_toggled), NULL);
+  g_signal_connect(playlist_new_public, "toggled",
+                   G_CALLBACK(playlist_new_button_toggled), NULL);
+  g_signal_connect(playlist_new_private, "toggled",
+                   G_CALLBACK(playlist_new_button_toggled), NULL);
+  gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_shared, 0, 1, 1, 2);
+  gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_public, 1, 2, 1, 2);
+  gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_private, 2, 3, 1, 2);
+
+  /* Third row: info bar saying why not */
+  playlist_new_info = gtk_label_new("");
+  gtk_table_attach_defaults(GTK_TABLE(table), playlist_new_info,
+                            0, 3, 2, 3);
+
+  /* Fourth row: ok/cancel buttons */
+  GtkWidget *hbox = create_buttons_box(playlist_new_buttons,
+                                       NPLAYLIST_NEW_BUTTONS,
+                                       gtk_hbox_new(FALSE, 0));
+  gtk_table_attach_defaults(GTK_TABLE(table), hbox, 0, 3, 3, 4);
+
+  gtk_container_add(GTK_CONTAINER(playlist_new_window),
+                    frame_widget(table, NULL));
+
+  /* Set initial state of OK button */
+  playlist_new_changed(0,0,0);
+
+  /* Display the window */
+  gtk_widget_show_all(playlist_new_window);
+}
+
 /* Playlists window (list of playlists) ------------------------------------- */
 
 /** @brief (Re-)populate the playlist tree model */
@@ -202,15 +456,20 @@ static void playlists_fill(const char attribute((unused)) *event,
                            void attribute((unused)) *callbackdata) {
   GtkTreeIter iter[1];
 
+  if(!playlists_window)
+    return;
   if(!playlists_list)
     playlists_list = gtk_list_store_new(1, G_TYPE_STRING);
-  gtk_list_store_clear(playlists_list);
-  for(int n = 0; n < nplaylists; ++n)
+  const char *was_selected = playlists_selected;
+  gtk_list_store_clear(playlists_list); /* clears playlists_selected */
+  for(int n = 0; n < nplaylists; ++n) {
     gtk_list_store_insert_with_values(playlists_list, iter, n/*position*/,
                                       0, playlists[n],        /* column 0 */
                                       -1);                    /* no more cols */
-  // TODO reselect whatever was formerly selected if possible, if not then
-  // zap the contents view
+    /* Reselect the selected playlist */
+    if(was_selected && !strcmp(was_selected, playlists[n]))
+      gtk_tree_selection_select_iter(playlists_selection, iter);
+  }
 }
 
 /** @brief Called when the selection might have changed */
@@ -227,32 +486,33 @@ static void playlists_selection_changed(GtkTreeSelection attribute((unused)) *tr
     g_free(gselected);
   } else
     selected = 0;
+  /* Set button sensitivity according to the new state */
+  if(selected)
+    gtk_widget_set_sensitive(playlists_delete_button, 1);
+  else
+    gtk_widget_set_sensitive(playlists_delete_button, 0);
   /* Eliminate no-change cases */
   if(!selected && !playlists_selected)
     return;
   if(selected && playlists_selected && !strcmp(selected, playlists_selected))
     return;
-  /* There's been a change */
+  /* Record the new state */
   playlists_selected = selected;
-  if(playlists_selected) {
-    fprintf(stderr, "playlists selection changed\n'"); /* TODO */
-    gtk_widget_set_sensitive(playlists_delete_button, 1);
-  } else
-    gtk_widget_set_sensitive(playlists_delete_button, 0);
 }
 
 /** @brief Called when the 'add' button is pressed */
 static void playlists_add(GtkButton attribute((unused)) *button,
                           gpointer attribute((unused)) userdata) {
-  /* Unselect whatever is selected */
+  /* Unselect whatever is selected TODO why?? */
   gtk_tree_selection_unselect_all(playlists_selection);
-  fprintf(stderr, "playlists_add\n");/* TODO */
-  /* We need to pop up a window asking for:
-   * - the name for the playlist
-   * - whether it is to be a public, private or shared playlist
-   * Moreover we should keep track of the known playlists and grey out OK
-   * if the name is a clash (as well as if it's actually invalid).
-   */
+  playlist_new();
+}
+
+/** @brief Called when playlist deletion completes */
+static void playlists_delete_completed(void attribute((unused)) *v,
+                                       const char *err) {
+  if(err)
+    popup_protocol_error(0, err);
 }
 
 /** @brief Called when the 'Delete' button is pressed */
@@ -261,6 +521,7 @@ static void playlists_delete(GtkButton attribute((unused)) *button,
   GtkWidget *yesno;
   int res;
 
+  fprintf(stderr, "playlists_delete\n");
   if(!playlists_selected)
     return;                             /* shouldn't happen */
   yesno = gtk_message_dialog_new(GTK_WINDOW(playlists_window),
@@ -274,7 +535,7 @@ static void playlists_delete(GtkButton attribute((unused)) *button,
   gtk_widget_destroy(yesno);
   if(res == GTK_RESPONSE_YES) {
     disorder_eclient_playlist_delete(client,
-                                     NULL/*playlists_delete_completed*/,
+                                     playlists_delete_completed,
                                      playlists_selected,
                                      NULL);
   }
@@ -324,6 +585,8 @@ static GtkWidget *playlists_window_list(void) {
                                           gtk_hbox_new(FALSE, 1));
   playlists_delete_button = playlists_buttons[1].widget;
 
+  playlists_selection_changed(NULL, NULL);
+
   /* Buttons live below the list */
   GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
   gtk_box_pack_start(GTK_BOX(vbox), scroll_widget(tree), TRUE/*expand*/, TRUE/*fill*/, 0);
@@ -360,18 +623,17 @@ static gboolean playlists_keypress(GtkWidget attribute((unused)) *widget,
 /** @brief Called when the playlist window is destroyed */
 static void playlists_window_destroyed(GtkWidget attribute((unused)) *widget,
                                        GtkWidget **widget_pointer) {
-  fprintf(stderr, "playlists_window_destroy\n");
   destroy_queuelike(&ql_playlist);
   *widget_pointer = NULL;
 }
 
-/** @BRIEF Pop up the playlists window
+/** @brief Pop up the playlists window
  *
  * Called when the playlists menu item is selected
  */
 void edit_playlists(gpointer attribute((unused)) callback_data,
-                     guint attribute((unused)) callback_action,
-                     GtkWidget attribute((unused)) *menu_item) {
+                    guint attribute((unused)) callback_action,
+                    GtkWidget attribute((unused)) *menu_item) {
   /* If the window already exists, raise it */
   if(playlists_window) {
     gtk_window_present(GTK_WINDOW(playlists_window));
@@ -389,7 +651,7 @@ void edit_playlists(gpointer attribute((unused)) callback_data,
   g_signal_connect(playlists_window, "key-press-event",
                    G_CALLBACK(playlists_keypress), 0);
   /* default size is too small */
-  gtk_window_set_default_size(GTK_WINDOW(playlists_window), 240, 240);
+  gtk_window_set_default_size(GTK_WINDOW(playlists_window), 512, 240);
 
   GtkWidget *hbox = gtk_hbox_new(FALSE, 0);
   gtk_box_pack_start(GTK_BOX(hbox), playlists_window_list(),
@@ -414,7 +676,13 @@ void playlists_init(void) {
   /* ...and from time to time */
   event_register("periodic-slow", playlists_update, 0);
   /* ...and at startup */
+
+  /* Update the playlists menu when the set of playlists changes */
   event_register("playlists-updated", menu_playlists_changed, 0);
+  /* Update the new-playlist OK button when the set of playlists changes */
+  event_register("playlists-updated", playlist_new_changed, 0);
+  /* Update the list of playlists in the edit window when the set changes */
+  event_register("playlists-updated", playlists_fill, 0);
   playlists_update(0, 0, 0);
 }