Sensitize icons according to current user rights. There's up to 10s
[disorder] / disobedience / disobedience.c
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007, 2008 Richard Kettlewell
4 *
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.
9 *
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.
14 *
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
18 * USA
19 */
20 /** @file disobedience/disobedience.c
21 * @brief Main Disobedience program
22 */
23
24 #include "disobedience.h"
25 #include "mixer.h"
26 #include "version.h"
27
28 #include <getopt.h>
29 #include <locale.h>
30 #include <pcre.h>
31
32 /* Apologies for the numerous de-consting casts, but GLib et al do not seem to
33 * have heard of const. */
34
35 /* Variables --------------------------------------------------------------- */
36
37 /** @brief Event loop */
38 GMainLoop *mainloop;
39
40 /** @brief Top-level window */
41 GtkWidget *toplevel;
42
43 /** @brief Label for progress indicator */
44 GtkWidget *report_label;
45
46 /** @brief Main tab group */
47 GtkWidget *tabs;
48
49 /** @brief Main client */
50 disorder_eclient *client;
51
52 /** @brief Log client */
53 disorder_eclient *logclient;
54
55 /** @brief Last reported state
56 *
57 * This is updated by log_state().
58 */
59 unsigned long last_state;
60
61 /** @brief True if some track is playing
62 *
63 * This ought to be removed in favour of last_state & DISORDER_PLAYING
64 */
65 int playing;
66
67 /** @brief Left channel volume */
68 int volume_l;
69
70 /** @brief Right channel volume */
71 int volume_r;
72
73 double goesupto = 10; /* volume upper bound */
74
75 /** @brief True if a NOP is in flight */
76 static int nop_in_flight;
77
78 /** @brief True if an rtp-address command is in flight */
79 static int rtp_address_in_flight;
80
81 /** @brief True if a rights lookup is in flight */
82 static int rights_lookup_in_flight;
83
84 /** @brief Current rights bitmap */
85 rights_type last_rights;
86
87 /** @brief Global tooltip group */
88 GtkTooltips *tips;
89
90 /** @brief True if RTP play is available
91 *
92 * This is a bit of a bodge...
93 */
94 int rtp_supported;
95
96 /** @brief True if RTP play is enabled */
97 int rtp_is_running;
98
99 /* Window creation --------------------------------------------------------- */
100
101 /* Note that all the client operations kicked off from here will only complete
102 * after we've entered the event loop. */
103
104 /** @brief Called when main window is deleted
105 *
106 * Terminates the program.
107 */
108 static gboolean delete_event(GtkWidget attribute((unused)) *widget,
109 GdkEvent attribute((unused)) *event,
110 gpointer attribute((unused)) data) {
111 D(("delete_event"));
112 exit(0); /* die immediately */
113 }
114
115 /** @brief Called when the current tab is switched
116 *
117 * Updates the menu settings to correspond to the new page.
118 */
119 static void tab_switched(GtkNotebook attribute((unused)) *notebook,
120 GtkNotebookPage attribute((unused)) *page,
121 guint page_num,
122 gpointer attribute((unused)) user_data) {
123 menu_update(page_num);
124 }
125
126 /** @brief Create the report box */
127 static GtkWidget *report_box(void) {
128 GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
129
130 report_label = gtk_label_new("");
131 gtk_label_set_ellipsize(GTK_LABEL(report_label), PANGO_ELLIPSIZE_END);
132 gtk_misc_set_alignment(GTK_MISC(report_label), 0, 0);
133 gtk_container_add(GTK_CONTAINER(vbox), gtk_hseparator_new());
134 gtk_container_add(GTK_CONTAINER(vbox), report_label);
135 return vbox;
136 }
137
138 /** @brief Create and populate the main tab group */
139 static GtkWidget *notebook(void) {
140 tabs = gtk_notebook_new();
141 /* The current tab is _NORMAL, the rest are _ACTIVE, which is bizarre but
142 * produces not too dreadful appearance */
143 gtk_widget_set_style(tabs, tool_style);
144 g_signal_connect(tabs, "switch-page", G_CALLBACK(tab_switched), 0);
145 gtk_notebook_append_page(GTK_NOTEBOOK(tabs), queue_widget(),
146 gtk_label_new("Queue"));
147 gtk_notebook_append_page(GTK_NOTEBOOK(tabs), recent_widget(),
148 gtk_label_new("Recent"));
149 gtk_notebook_append_page(GTK_NOTEBOOK(tabs), choose_widget(),
150 gtk_label_new("Choose"));
151 gtk_notebook_append_page(GTK_NOTEBOOK(tabs), added_widget(),
152 gtk_label_new("Added"));
153 return tabs;
154 }
155
156 /** @brief Create and populate the main window */
157 static void make_toplevel_window(void) {
158 GtkWidget *const vbox = gtk_vbox_new(FALSE, 1);
159 GtkWidget *const rb = report_box();
160
161 D(("top_window"));
162 toplevel = gtk_window_new(GTK_WINDOW_TOPLEVEL);
163 /* default size is too small */
164 gtk_window_set_default_size(GTK_WINDOW(toplevel), 640, 480);
165 /* terminate on close */
166 g_signal_connect(G_OBJECT(toplevel), "delete_event",
167 G_CALLBACK(delete_event), NULL);
168 /* lay out the window */
169 gtk_window_set_title(GTK_WINDOW(toplevel), "Disobedience");
170 gtk_container_add(GTK_CONTAINER(toplevel), vbox);
171 /* lay out the vbox */
172 gtk_box_pack_start(GTK_BOX(vbox),
173 menubar(toplevel),
174 FALSE, /* expand */
175 FALSE, /* fill */
176 0);
177 gtk_box_pack_start(GTK_BOX(vbox),
178 control_widget(),
179 FALSE, /* expand */
180 FALSE, /* fill */
181 0);
182 gtk_container_add(GTK_CONTAINER(vbox), notebook());
183 gtk_box_pack_end(GTK_BOX(vbox),
184 rb,
185 FALSE, /* expand */
186 FALSE, /* fill */
187 0);
188 gtk_widget_set_style(toplevel, tool_style);
189 }
190
191 #if MDEBUG
192 static int widget_count, container_count;
193
194 static void count_callback(GtkWidget *w,
195 gpointer attribute((unused)) data) {
196 ++widget_count;
197 if(GTK_IS_CONTAINER(w)) {
198 ++container_count;
199 gtk_container_foreach(GTK_CONTAINER(w), count_callback, 0);
200 }
201 }
202
203 static void count_widgets(void) {
204 widget_count = 0;
205 container_count = 1;
206 if(toplevel)
207 gtk_container_foreach(GTK_CONTAINER(toplevel), count_callback, 0);
208 fprintf(stderr, "widget count: %8d container count: %8d\n",
209 widget_count, container_count);
210 }
211 #endif
212
213 #if MTRACK
214 const char *mtag = "init";
215 static hash *mtrack_hash;
216
217 static int *mthfind(const char *tag) {
218 static const int zero = 0;
219 int *cp = hash_find(mtrack_hash, tag);
220 if(!cp) {
221 hash_add(mtrack_hash, tag, &zero, HASH_INSERT);
222 cp = hash_find(mtrack_hash, tag);
223 }
224 return cp;
225 }
226
227 static void *trap_malloc(size_t n) {
228 void *ptr = malloc(n + sizeof(char *));
229
230 *(const char **)ptr = mtag;
231 ++*mthfind(mtag);
232 return (char *)ptr + sizeof(char *);
233 }
234
235 static void trap_free(void *ptr) {
236 const char *tag;
237 if(!ptr)
238 return;
239 ptr = (char *)ptr - sizeof(char *);
240 tag = *(const char **)ptr;
241 --*mthfind(tag);
242 free(ptr);
243 }
244
245 static void *trap_realloc(void *ptr, size_t n) {
246 if(!ptr)
247 return trap_malloc(n);
248 if(!n) {
249 trap_free(ptr);
250 return 0;
251 }
252 ptr = (char *)ptr - sizeof(char *);
253 ptr = realloc(ptr, n + sizeof(char *));
254 *(const char **)ptr = mtag;
255 return (char *)ptr + sizeof(char *);
256 }
257
258 static int report_tags_callback(const char *key, void *value,
259 void attribute((unused)) *u) {
260 fprintf(stderr, "%16s: %d\n", key, *(int *)value);
261 return 0;
262 }
263
264 static void report_tags(void) {
265 hash_foreach(mtrack_hash, report_tags_callback, 0);
266 fprintf(stderr, "\n");
267 }
268
269 static const GMemVTable glib_memvtable = {
270 trap_malloc,
271 trap_realloc,
272 trap_free,
273 0,
274 0,
275 0
276 };
277 #endif
278
279 static void userinfo_rights_completed(void attribute((unused)) *v,
280 const char *error,
281 const char *value) {
282 rights_type r;
283
284 if(error) {
285 popup_protocol_error(0, error);
286 r = 0;
287 } else {
288 if(parse_rights(value, &r, 0))
289 r = 0;
290 }
291 /* If rights have changed, signal everything that cares */
292 if(r != last_rights) {
293 last_rights = r;
294 ++suppress_actions;
295 event_raise("rights-changed", 0);
296 --suppress_actions;
297 }
298 rights_lookup_in_flight = 0;
299 }
300
301 /** @brief Called occasionally */
302 static gboolean periodic_slow(gpointer attribute((unused)) data) {
303 D(("periodic_slow"));
304 /* Expire cached data */
305 cache_expire();
306 /* Update everything to be sure that the connection to the server hasn't
307 * mysteriously gone stale on us. */
308 all_update();
309 #if MDEBUG
310 count_widgets();
311 fprintf(stderr, "cache size: %zu\n", cache_count());
312 #endif
313 #if MTRACK
314 report_tags();
315 #endif
316 /* Periodically check what our rights are */
317 if(!rights_lookup_in_flight) {
318 rights_lookup_in_flight = 1;
319 disorder_eclient_userinfo(client,
320 userinfo_rights_completed,
321 config->username, "rights",
322 0);
323 }
324 return TRUE; /* don't remove me */
325 }
326
327 /** @brief Called frequently */
328 static gboolean periodic_fast(gpointer attribute((unused)) data) {
329 #if 0 /* debugging hack */
330 static struct timeval last;
331 struct timeval now;
332 double delta;
333
334 xgettimeofday(&now, 0);
335 if(last.tv_sec) {
336 delta = (now.tv_sec + now.tv_sec / 1.0E6)
337 - (last.tv_sec + last.tv_sec / 1.0E6);
338 if(delta >= 1.0625)
339 fprintf(stderr, "%f: %fs between 1s heartbeats\n",
340 now.tv_sec + now.tv_sec / 1.0E6,
341 delta);
342 }
343 last = now;
344 #endif
345 if(rtp_supported && mixer_supported(DEFAULT_BACKEND)) {
346 int nl, nr;
347 if(!mixer_control(DEFAULT_BACKEND, &nl, &nr, 0)
348 && (nl != volume_l || nr != volume_r)) {
349 volume_l = nl;
350 volume_r = nr;
351 event_raise("volume-changed", 0);
352 }
353 }
354 return TRUE;
355 }
356
357 /** @brief Called when a NOP completes */
358 static void nop_completed(void attribute((unused)) *v,
359 const char attribute((unused)) *error) {
360 /* TODO report the error somewhere */
361 nop_in_flight = 0;
362 }
363
364 /** @brief Called from time to time to arrange for a NOP to be sent
365 *
366 * At most one NOP remains in flight at any moment. If the client is not
367 * currently connected then no NOP is sent.
368 */
369 static gboolean maybe_send_nop(gpointer attribute((unused)) data) {
370 if(!nop_in_flight && (disorder_eclient_state(client) & DISORDER_CONNECTED)) {
371 nop_in_flight = 1;
372 disorder_eclient_nop(client, nop_completed, 0);
373 }
374 if(rtp_supported) {
375 const int rtp_was_running = rtp_is_running;
376 rtp_is_running = rtp_running();
377 if(rtp_was_running != rtp_is_running)
378 event_raise("rtp-changed", 0);
379 }
380 return TRUE; /* keep call me please */
381 }
382
383 /** @brief Called when a rtp-address command succeeds */
384 static void got_rtp_address(void attribute((unused)) *v,
385 const char *error,
386 int attribute((unused)) nvec,
387 char attribute((unused)) **vec) {
388 const int rtp_was_supported = rtp_supported;
389 const int rtp_was_running = rtp_is_running;
390
391 ++suppress_actions;
392 rtp_address_in_flight = 0;
393 if(error) {
394 /* An error just means that we're not using network play */
395 rtp_supported = 0;
396 rtp_is_running = 0;
397 } else {
398 rtp_supported = 1;
399 rtp_is_running = rtp_running();
400 }
401 if(rtp_supported != rtp_was_supported
402 || rtp_is_running != rtp_was_running)
403 event_raise("rtp-changed", 0);
404 --suppress_actions;
405 }
406
407 /** @brief Called to check whether RTP play is available */
408 static void check_rtp_address(void) {
409 if(!rtp_address_in_flight)
410 disorder_eclient_rtp_address(client, got_rtp_address, NULL);
411 }
412
413 /* main -------------------------------------------------------------------- */
414
415 static const struct option options[] = {
416 { "help", no_argument, 0, 'h' },
417 { "version", no_argument, 0, 'V' },
418 { "config", required_argument, 0, 'c' },
419 { "tufnel", no_argument, 0, 't' },
420 { "debug", no_argument, 0, 'd' },
421 { 0, 0, 0, 0 }
422 };
423
424 /* display usage message and terminate */
425 static void help(void) {
426 xprintf("Disobedience - GUI client for DisOrder\n"
427 "\n"
428 "Usage:\n"
429 " disobedience [OPTIONS]\n"
430 "Options:\n"
431 " --help, -h Display usage message\n"
432 " --version, -V Display version number\n"
433 " --config PATH, -c PATH Set configuration file\n"
434 " --debug, -d Turn on debugging\n"
435 "\n"
436 "Also GTK+ options will work.\n");
437 xfclose(stdout);
438 exit(0);
439 }
440
441 void logged_in(void) {
442 /* reset the clients */
443 disorder_eclient_close(client);
444 disorder_eclient_close(logclient);
445 rtp_supported = 0;
446 event_raise("logged-in", 0);
447 /* Force the periodic checks */
448 check_rtp_address();
449 periodic_slow(0);
450 periodic_fast(0);
451 }
452
453 int main(int argc, char **argv) {
454 int n;
455 gboolean gtkok;
456
457 mem_init();
458 /* garbage-collect PCRE's memory */
459 pcre_malloc = xmalloc;
460 pcre_free = xfree;
461 #if MTRACK
462 mtrack_hash = hash_new(sizeof (int));
463 g_mem_set_vtable((GMemVTable *)&glib_memvtable);
464 #endif
465 if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
466 gtkok = gtk_init_check(&argc, &argv);
467 while((n = getopt_long(argc, argv, "hVc:dtHC", options, 0)) >= 0) {
468 switch(n) {
469 case 'h': help();
470 case 'V': version("disobedience");
471 case 'c': configfile = optarg; break;
472 case 'd': debugging = 1; break;
473 case 't': goesupto = 11; break;
474 default: fatal(0, "invalid option");
475 }
476 }
477 if(!gtkok)
478 fatal(0, "failed to initialize GTK+");
479 signal(SIGPIPE, SIG_IGN);
480 init_styles();
481 load_settings();
482 /* create the event loop */
483 D(("create main loop"));
484 mainloop = g_main_loop_new(0, 0);
485 if(config_read(0)) fatal(0, "cannot read configuration");
486 /* create the clients */
487 if(!(client = gtkclient())
488 || !(logclient = gtkclient()))
489 return 1; /* already reported an error */
490 /* periodic operations (e.g. expiring the cache, checking local volume) */
491 g_timeout_add(10000/*milliseconds*/, periodic_slow, 0);
492 g_timeout_add(1000/*milliseconds*/, periodic_fast, 0);
493 /* global tooltips */
494 tips = gtk_tooltips_new();
495 make_toplevel_window();
496 /* reset styles now everything has its name */
497 gtk_rc_reset_styles(gtk_settings_get_for_screen(gdk_screen_get_default()));
498 gtk_widget_show_all(toplevel);
499 /* issue a NOP every so often */
500 g_timeout_add_full(G_PRIORITY_LOW,
501 2000/*interval, ms*/,
502 maybe_send_nop,
503 0/*data*/,
504 0/*notify*/);
505 /* Start monitoring the log */
506 disorder_eclient_log(logclient, &log_callbacks, 0);
507 /* Initiate all the checks */
508 check_rtp_address();
509 periodic_slow(0);
510 periodic_fast(0);
511 suppress_actions = 0;
512 /* If no password is set yet pop up a login box */
513 if(!config->password)
514 login_box();
515 D(("enter main loop"));
516 MTAG("misc");
517 g_main_loop_run(mainloop);
518 return 0;
519 }
520
521 /*
522 Local Variables:
523 c-basic-offset:2
524 comment-column:40
525 fill-column:79
526 indent-tabs-mode:nil
527 End:
528 */