chiark / gitweb /
Update copyright dates
[disorder] / disobedience / disobedience.c
index 7c6ef3dc9d6e0a7d1a03eb724785d8b359f22305..38fc6eb33ef8708fe690a47d11f9c3cd40ba90fc 100644 (file)
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2006, 2007 Richard Kettlewell
+ * Copyright (C) 2006-2009 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file disobedience/disobedience.c
+ * @brief Main Disobedience program
  */
 
 #include "disobedience.h"
+#include "version.h"
 
 #include <getopt.h>
 #include <locale.h>
+#include <pcre.h>
+#include <gcrypt.h>
 
 /* Apologies for the numerous de-consting casts, but GLib et al do not seem to
  * have heard of const. */
 
-#include "style.h"                      /* generated style */
+/* Variables --------------------------------------------------------------- */
+
+/** @brief Event loop */
+GMainLoop *mainloop;
 
-/* Functions --------------------------------------------------------------- */
+/** @brief Top-level window */
+GtkWidget *toplevel;
 
-static void log_connected(void *v);
-static void log_completed(void *v, const char *track);
-static void log_failed(void *v, const char *track, const char *status);
-static void log_moved(void *v, const char *user);
-static void log_playing(void *v, const char *track, const char *user);
-static void log_queue(void *v, struct queue_entry *q);
-static void log_recent_added(void *v, struct queue_entry *q);
-static void log_recent_removed(void *v, const char *id);
-static void log_removed(void *v, const char *id, const char *user);
-static void log_scratched(void *v, const char *track, const char *user);
-static void log_state(void *v, unsigned long state);
-static void log_volume(void *v, int l, int r);
+/** @brief Label for progress indicator */
+GtkWidget *report_label;
 
-/* Variables --------------------------------------------------------------- */
+/** @brief Main tab group */
+GtkWidget *tabs;
+
+/** @brief Main client */
+disorder_eclient *client;
 
-GMainLoop *mainloop;                    /* event loop */
-GtkWidget *toplevel;                    /* top level window */
-GtkWidget *report_label;                /* label for progress indicator */
-GtkWidget *tabs;                        /* main tabs */
+/** @brief Log client */
+disorder_eclient *logclient;
 
-disorder_eclient *client;               /* main client */
+/** @brief Last reported state
+ *
+ * This is updated by log_state().
+ */
+unsigned long last_state;
+
+/** @brief True if some track is playing
+ *
+ * This ought to be removed in favour of last_state & DISORDER_PLAYING
+ */
+int playing;
+
+/** @brief Left channel volume */
+int volume_l;
+
+/** @brief Right channel volume */
+int volume_r;
+
+/** @brief Audio backend */
+const struct uaudio *backend;
 
-unsigned long last_state;               /* last reported state */
-int playing;                            /* true if playing some track */
-int volume_l, volume_r;                 /* volume */
 double goesupto = 10;                   /* volume upper bound */
-int choosealpha;                        /* break up choose by letter */
-
-static const disorder_eclient_log_callbacks gdisorder_log_callbacks = {
-  log_connected,
-  log_completed,
-  log_failed,
-  log_moved,
-  log_playing,
-  log_queue,
-  log_recent_added,
-  log_recent_removed,
-  log_removed,
-  log_scratched,
-  log_state,
-  log_volume
-};
+
+/** @brief True if a NOP is in flight */
+static int nop_in_flight;
+
+/** @brief True if an rtp-address command is in flight */
+static int rtp_address_in_flight;
+
+/** @brief True if a rights lookup is in flight */
+static int rights_lookup_in_flight;
+
+/** @brief Current rights bitmap */
+rights_type last_rights;
+
+/** @brief Global tooltip group */
+GtkTooltips *tips;
+
+/** @brief True if RTP play is available
+ *
+ * This is a bit of a bodge...
+ */
+int rtp_supported;
+
+/** @brief True if RTP play is enabled */
+int rtp_is_running;
+
+/** @brief Server version */
+const char *server_version;
+
+/** @brief Parsed server version */
+long server_version_bytes;
+
+static void check_rtp_address(const char *event,
+                              void *eventdata,
+                              void *callbackdata);
 
 /* Window creation --------------------------------------------------------- */
 
 /* Note that all the client operations kicked off from here will only complete
  * after we've entered the event loop. */
 
+/** @brief Called when main window is deleted
+ *
+ * Terminates the program.
+ */
 static gboolean delete_event(GtkWidget attribute((unused)) *widget,
                              GdkEvent attribute((unused)) *event,
                              gpointer attribute((unused)) data) {
@@ -85,14 +123,22 @@ static gboolean delete_event(GtkWidget attribute((unused)) *widget,
   exit(0);                              /* die immediately */
 }
 
-/* Called when the current tab is switched. */
-static void tab_switched(GtkNotebook attribute((unused)) *notebook,
+/** @brief Called when the current tab is switched
+ *
+ * Updates the menu settings to correspond to the new page.
+ */
+static void tab_switched(GtkNotebook *notebook,
                          GtkNotebookPage attribute((unused)) *page,
                          guint page_num,
                          gpointer attribute((unused)) user_data) {
-  menu_update(page_num);
+  GtkWidget *const tab = gtk_notebook_get_nth_page(notebook, page_num);
+  const struct tabtype *const t = g_object_get_data(G_OBJECT(tab), "type");
+  assert(t != 0);
+  if(t->selected)
+    t->selected();
 }
 
+/** @brief Create the report box */
 static GtkWidget *report_box(void) {
   GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
 
@@ -104,8 +150,12 @@ static GtkWidget *report_box(void) {
   return vbox;
 }
 
+/** @brief Create and populate the main tab group */
 static GtkWidget *notebook(void) {
   tabs = gtk_notebook_new();
+  /* The current tab is _NORMAL, the rest are _ACTIVE, which is bizarre but
+   * produces not too dreadful appearance */
+  gtk_widget_set_style(tabs, tool_style);
   g_signal_connect(tabs, "switch-page", G_CALLBACK(tab_switched), 0);
   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), queue_widget(),
                            gtk_label_new("Queue"));
@@ -113,9 +163,12 @@ static GtkWidget *notebook(void) {
                            gtk_label_new("Recent"));
   gtk_notebook_append_page(GTK_NOTEBOOK(tabs), choose_widget(),
                            gtk_label_new("Choose"));
+  gtk_notebook_append_page(GTK_NOTEBOOK(tabs), added_widget(),
+                           gtk_label_new("Added"));
   return tabs;
 }
 
+/** @brief Create and populate the main window */
 static void make_toplevel_window(void) {
   GtkWidget *const vbox = gtk_vbox_new(FALSE, 1);
   GtkWidget *const rb = report_box();
@@ -147,121 +200,57 @@ static void make_toplevel_window(void) {
                    FALSE,             /* expand */
                    FALSE,             /* fill */
                    0);
-  gtk_widget_set_name(toplevel, "disobedience");
+  gtk_widget_set_style(toplevel, tool_style);
 }
 
-/* State monitoring -------------------------------------------------------- */
-
-static void all_update(void) {
-  playing_update();
-  queue_update();
-  recent_update();
-  control_update();
-}
-
-static void log_connected(void attribute((unused)) *v) {
-  struct callbackdata *cbd;
-
-  /* Don't know what we might have missed while disconnected so update
-   * everything.  We get this at startup too and this is how we do the initial
-   * state fetch. */
-  all_update();
-  /* Re-get the volume */
-  cbd = xmalloc(sizeof *cbd);
-  cbd->onerror = 0;
-  disorder_eclient_volume(client, log_volume, -1, -1, cbd);
-}
-
-static void log_completed(void attribute((unused)) *v,
-                          const char attribute((unused)) *track) {
-  playing = 0;
-  playing_update();
-  control_update();
-}
-
-static void log_failed(void attribute((unused)) *v,
-                       const char attribute((unused)) *track,
-                       const char attribute((unused)) *status) {
-  playing = 0;
-  playing_update();
-  control_update();
-}
-
-static void log_moved(void attribute((unused)) *v,
-                      const char attribute((unused)) *user) {
-   queue_update();
-}
-
-static void log_playing(void attribute((unused)) *v,
-                        const char attribute((unused)) *track,
-                        const char attribute((unused)) *user) {
-  playing = 1;
-  playing_update();
-  control_update();
-  /* we get a log_removed() anyway so we don't need to update_queue() from
-   * here */
-}
-
-static void log_queue(void attribute((unused)) *v,
-                      struct queue_entry attribute((unused)) *q) {
-  queue_update();
-}
-
-static void log_recent_added(void attribute((unused)) *v,
-                             struct queue_entry attribute((unused)) *q) {
-  recent_update();
-}
-
-static void log_recent_removed(void attribute((unused)) *v,
-                               const char attribute((unused)) *id) {
-  /* nothing - log_recent_added() will trigger the relevant update */
-}
-
-static void log_removed(void attribute((unused)) *v,
-                        const char attribute((unused)) *id,
-                        const char attribute((unused)) *user) {
-  queue_update();
-}
-
-static void log_scratched(void attribute((unused)) *v,
-                          const char attribute((unused)) *track,
-                          const char attribute((unused)) *user) {
-  playing = 0;
-  playing_update();
-  control_update();
-}
-
-static void log_state(void attribute((unused)) *v,
-                      unsigned long state) {
-  last_state = state;
-  control_update();
-  /* If the track is paused or resume then the currently playing track is
-   * refetched so that we can continue to correctly calculate the played so-far
-   * field */
-  playing_update();
+static void userinfo_rights_completed(void attribute((unused)) *v,
+                                      const char *err,
+                                      const char *value) {
+  rights_type r;
+
+  if(err) {
+    popup_protocol_error(0, err);
+    r = 0;
+  } else {
+    if(parse_rights(value, &r, 0))
+      r = 0;
+  }
+  /* If rights have changed, signal everything that cares */
+  if(r != last_rights) {
+    last_rights = r;
+    ++suppress_actions;
+    event_raise("rights-changed", 0);
+    --suppress_actions;
+  }
+  rights_lookup_in_flight = 0;
 }
 
-static void log_volume(void attribute((unused)) *v,
-                       int l, int r) {
-  if(volume_l != l || volume_r != r) {
-    volume_l = l;
-    volume_r = r;
-    control_update();
+static void check_rights(void) {
+  if(!rights_lookup_in_flight) {
+    rights_lookup_in_flight = 1;
+    disorder_eclient_userinfo(client,
+                              userinfo_rights_completed,
+                              config->username, "rights",
+                              0);
   }
 }
 
-/* Called once every 10 minutes */
-static gboolean periodic(gpointer attribute((unused)) data) {
-  D(("periodic"));
+/** @brief Called occasionally */
+static gboolean periodic_slow(gpointer attribute((unused)) data) {
+  D(("periodic_slow"));
   /* Expire cached data */
   cache_expire();
   /* Update everything to be sure that the connection to the server hasn't
    * mysteriously gone stale on us. */
   all_update();
+  /* Recheck RTP status too */
+  check_rtp_address(0, 0, 0);
   return TRUE;                          /* don't remove me */
 }
 
-static gboolean heartbeat(gpointer attribute((unused)) data) {
+/** @brief Called frequently */
+static gboolean periodic_fast(gpointer attribute((unused)) data) {
+#if 0                                   /* debugging hack */
   static struct timeval last;
   struct timeval now;
   double delta;
@@ -276,9 +265,91 @@ static gboolean heartbeat(gpointer attribute((unused)) data) {
               delta);
   }
   last = now;
+#endif
+  if(rtp_supported && backend && backend->get_volume) {
+    int nl, nr;
+    backend->get_volume(&nl, &nr);
+    if(nl != volume_l || nr != volume_r) {
+      volume_l = nl;
+      volume_r = nr;
+      event_raise("volume-changed", 0);
+    }
+  }
+  /* Periodically check what our rights are */
+  int recheck_rights = 1;
+  if(server_version_bytes >= 0x04010000)
+    /* Server versions after 4.1 will send updates */
+    recheck_rights = 0;
+  if((server_version_bytes & 0xFF) == 0x01)
+    /* Development servers might do regardless of their version number */
+    recheck_rights = 0;
+  if(recheck_rights)
+    check_rights();
   return TRUE;
 }
 
+/** @brief Called when a NOP completes */
+static void nop_completed(void attribute((unused)) *v,
+                          const char attribute((unused)) *err) {
+  /* TODO report the error somewhere */
+  nop_in_flight = 0;
+}
+
+/** @brief Called from time to time to arrange for a NOP to be sent
+ *
+ * At most one NOP remains in flight at any moment.  If the client is not
+ * currently connected then no NOP is sent.
+ */
+static gboolean maybe_send_nop(gpointer attribute((unused)) data) {
+  if(!nop_in_flight && (disorder_eclient_state(client) & DISORDER_CONNECTED)) {
+    nop_in_flight = 1;
+    disorder_eclient_nop(client, nop_completed, 0);
+  }
+  if(rtp_supported) {
+    const int rtp_was_running = rtp_is_running;
+    rtp_is_running = rtp_running();
+    if(rtp_was_running != rtp_is_running)
+      event_raise("rtp-changed", 0);
+  }
+  return TRUE;                          /* keep call me please */
+}
+
+/** @brief Called when a rtp-address command succeeds */
+static void got_rtp_address(void attribute((unused)) *v,
+                            const char *err,
+                            int attribute((unused)) nvec,
+                            char attribute((unused)) **vec) {
+  const int rtp_was_supported = rtp_supported;
+  const int rtp_was_running = rtp_is_running;
+
+  ++suppress_actions;
+  rtp_address_in_flight = 0;
+  if(err) {
+    /* An error just means that we're not using network play */
+    rtp_supported = 0;
+    rtp_is_running = 0;
+  } else {
+    rtp_supported = 1;
+    rtp_is_running = rtp_running();
+  }
+  /*fprintf(stderr, "rtp supported->%d, running->%d\n",
+          rtp_supported, rtp_is_running);*/
+  if(rtp_supported != rtp_was_supported
+     || rtp_is_running != rtp_was_running)
+    event_raise("rtp-changed", 0);
+  --suppress_actions;
+}
+
+/** @brief Called to check whether RTP play is available */
+static void check_rtp_address(const char attribute((unused)) *event,
+                              void attribute((unused)) *eventdata,
+                              void attribute((unused)) *callbackdata) {
+  if(!rtp_address_in_flight) {
+    //fprintf(stderr, "checking rtp\n");
+    disorder_eclient_rtp_address(client, got_rtp_address, NULL);
+  }
+}
+
 /* main -------------------------------------------------------------------- */
 
 static const struct option options[] = {
@@ -286,7 +357,6 @@ static const struct option options[] = {
   { "version", no_argument, 0, 'V' },
   { "config", required_argument, 0, 'c' },
   { "tufnel", no_argument, 0, 't' },
-  { "choosealpha", no_argument, 0, 'C' },
   { "debug", no_argument, 0, 'd' },
   { 0, 0, 0, 0 }
 };
@@ -308,52 +378,124 @@ static void help(void) {
   exit(0);
 }
 
-/* display version number and terminate */
-static void version(void) {
-  xprintf("disorder version %s\n", disorder_version_string);
-  xfclose(stdout);
-  exit(0);
+static void version_completed(void attribute((unused)) *v,
+                              const char attribute((unused)) *err,
+                              const char *ver) {
+  long major, minor, patch, dev;
+
+  if(!ver) {
+    server_version = 0;
+    server_version_bytes = 0;
+    return;
+  }
+  server_version = ver;
+  server_version_bytes = 0;
+  major = strtol(ver, (char **)&ver, 10);
+  if(*ver != '.')
+    return;
+  ++ver;
+  minor = strtol(ver, (char **)&ver, 10);
+  if(*ver == '.') {
+    ++ver;
+    patch = strtol(ver, (char **)&ver, 10);
+  } else
+    patch = 0;
+  if(*ver) {
+    if(*ver == '+') {
+      dev = 1;
+      ++ver;
+    }
+    if(*ver)
+      dev = 2;
+  } else
+    dev = 0;
+  server_version_bytes = (major << 24) + (minor << 16) + (patch << 8) + dev;
+}
+
+void logged_in(void) {
+  /* reset the clients */
+  disorder_eclient_close(client);
+  disorder_eclient_close(logclient);
+  rtp_supported = 0;
+  event_raise("logged-in", 0);
+  /* Force the periodic checks */
+  periodic_slow(0);
+  periodic_fast(0);
+  /* Recheck server version */
+  disorder_eclient_version(client, version_completed, 0);
+  disorder_eclient_enable_connect(client);
+  disorder_eclient_enable_connect(logclient);
 }
 
 int main(int argc, char **argv) {
   int n;
-  disorder_eclient *logclient;
+  gboolean gtkok;
 
-  mem_init(1);
+  mem_init();
+  /* garbage-collect PCRE's memory */
+  pcre_malloc = xmalloc;
+  pcre_free = xfree;
   if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
-  gtk_init(&argc, &argv);
-  gtk_rc_parse_string(style);
-  while((n = getopt_long(argc, argv, "hVc:dtH", options, 0)) >= 0) {
+  gtkok = gtk_init_check(&argc, &argv);
+  while((n = getopt_long(argc, argv, "hVc:dtHC", options, 0)) >= 0) {
     switch(n) {
     case 'h': help();
-    case 'V': version();
+    case 'V': version("disobedience");
     case 'c': configfile = optarg; break;
     case 'd': debugging = 1; break;
     case 't': goesupto = 11; break;
-    case 'C': choosealpha = 1; break;   /* not well tested any more */
     default: fatal(0, "invalid option");
     }
   }
+  if(!gtkok)
+    fatal(0, "failed to initialize GTK+");
+  /* gcrypt initialization */
+  if(!gcry_check_version(NULL))
+    disorder_fatal(0, "gcry_check_version failed");
+  gcry_control(GCRYCTL_INIT_SECMEM, 0);
+  gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
   signal(SIGPIPE, SIG_IGN);
+  init_styles();
+  load_settings();
   /* create the event loop */
   D(("create main loop"));
   mainloop = g_main_loop_new(0, 0);
-  if(config_read()) fatal(0, "cannot read configuration");
+  if(config_read(0, NULL)) fatal(0, "cannot read configuration");
+  /* we'll need mixer support */
+  backend = uaudio_apis[0];
+  if(backend->configure)
+    backend->configure();
+  if(backend->open_mixer)
+    backend->open_mixer();
   /* create the clients */
   if(!(client = gtkclient())
      || !(logclient = gtkclient()))
     return 1;                           /* already reported an error */
-  disorder_eclient_log(logclient, &gdisorder_log_callbacks, 0);
-  /* periodic operations (e.g. expiring the cache) */
-  g_timeout_add(600000/*milliseconds*/, periodic, 0);
-  /* The point of this is to try and get a handle on mysterious
-   * unresponsiveness.  It's not very useful in production use. */
-  if(0)
-    g_timeout_add(1000/*milliseconds*/, heartbeat, 0);
+  /* periodic operations (e.g. expiring the cache, checking local volume) */
+  g_timeout_add(600000/*milliseconds*/, periodic_slow, 0);
+  g_timeout_add(1000/*milliseconds*/, periodic_fast, 0);
+  /* global tooltips */
+  tips = gtk_tooltips_new();
   make_toplevel_window();
   /* reset styles now everything has its name */
   gtk_rc_reset_styles(gtk_settings_get_for_screen(gdk_screen_get_default()));
   gtk_widget_show_all(toplevel);
+  /* issue a NOP every so often */
+  g_timeout_add_full(G_PRIORITY_LOW,
+                     2000/*interval, ms*/,
+                     maybe_send_nop,
+                     0/*data*/,
+                     0/*notify*/);
+  /* Start monitoring the log */
+  disorder_eclient_log(logclient, &log_callbacks, 0);
+  /* Initiate all the checks */
+  periodic_fast(0);
+  disorder_eclient_version(client, version_completed, 0);
+  event_register("log-connected", check_rtp_address, 0);
+  suppress_actions = 0;
+  /* If no password is set yet pop up a login box */
+  if(!config->password)
+    login_box();
   D(("enter main loop"));
   g_main_loop_run(mainloop);
   return 0;