e52d8e87ff69823c4f0be2cf1114e9c31398b7a3
[pandora-libraries.git] / apps / pndnotifyd.c
1
2 /* pndnotifyd - a daemon whose job is to monitor searchpaths for app changes (appearing, disappearing, changing).
3  * If a change is found, the discovery code is invoked and apps registered for the launchers to see
4  *
5  */
6
7 #include <stdio.h>     // for stdio
8 #include <unistd.h>    // for exit()
9 #include <stdlib.h>    // for exit()
10 #define __USE_GNU /* for strcasestr */
11 #include <string.h>
12 #include <time.h>      // for time()
13 #include <ctype.h>     // for isdigit()
14 #include <sys/types.h> // for umask
15 #include <sys/stat.h>  // for umask
16 #include <dirent.h>    // for opendir()
17 #include <signal.h>    // for sigaction
18
19 #include "pnd_conf.h"
20 #include "pnd_container.h"
21 #include "pnd_apps.h"
22 #include "pnd_notify.h"
23 #include "../lib/pnd_pathiter.h"
24 #include "pnd_discovery.h"
25 #include "pnd_locate.h"
26 #include "pnd_pxml.h"
27 #include "pnd_utility.h"
28 #include "pnd_desktop.h"
29 #include "pnd_logger.h"
30
31 // this piece of code was simpler once; but need to grow it a bit and in a rush
32 // moving all these to globals rather than refactor the code a bit; tsk tsk..
33
34 // op mode; emitting stdout or no?
35 static unsigned char g_daemon_mode = 0;
36
37 typedef enum {
38   pndn_debug = 0,
39   pndn_rem,          // will set default log level to here, so 'debug' is omitted
40   pndn_warning,
41   pndn_error,
42   pndn_none
43 } pndnotify_loglevels_e;
44
45 // like discotest
46 char *configpath;
47 char *overridespath;
48 // daemon stuff
49 char *searchpath = NULL;
50 char *notifypath = NULL;
51 time_t createtime = 0; // all 'new' .destops are created at or after this time; prev are old.
52 // dotfiles; this used to be a single pai .. now two pairs, a little unwieldy; pnd_box it up?
53 char *desktop_dotdesktoppath = NULL;
54 char *desktop_iconpath = NULL;
55 char *desktop_appspath = NULL;
56 char *menu_dotdesktoppath = NULL;
57 char *menu_iconpath = NULL;
58 char *menu_appspath = NULL;
59 // pnd runscript
60 char *run_searchpath; // searchpath to find pnd_run.sh
61 char *run_script;     // name of pnd_run.sh script from config
62 char *pndrun;         // full path to located pnd_run.sh
63 char *pndhup = NULL;  // full path to located pnd_hup.sh
64 // notifier handle
65 pnd_notify_handle nh = 0;
66
67 // constants
68 #define PNDNOTIFYD_LOGLEVEL "pndnotifyd.loglevel"
69
70 // decl's
71 void consume_configuration ( void );
72 void setup_notifications ( void );
73 void sighup_handler ( int n );
74 void process_discoveries ( pnd_box_handle applist, char *emitdesktoppath, char *emiticonpath );
75 unsigned char perform_discoveries ( char *appspath, char *overridespath,
76                                     char *emitdesktoppath, char *emiticonpath );
77
78 int main ( int argc, char *argv[] ) {
79   // behaviour
80   unsigned char scanonlaunch = 1;
81   unsigned int interval_secs = 5;
82   // misc
83   int i;
84
85   /* iterate across args
86    */
87   for ( i = 1; i < argc; i++ ) {
88
89     if ( argv [ i ][ 0 ] == '-' && argv [ i ][ 1 ] == 'd' ) {
90       //printf ( "Going daemon mode. Silent running.\n" );
91       g_daemon_mode = 1;
92     } else if ( isdigit ( argv [ i ][ 0 ] ) ) {
93       interval_secs = atoi ( argv [ i ] );
94     } else if ( argv [ i ][ 0 ] == '-' && argv [ i ][ 1 ] == 'n' ) {
95       scanonlaunch = 0;
96     } else {
97       printf ( "%s [-d] [##]\n", argv [ 0 ] );
98       printf ( "-d\tDaemon mode; detach from terminal, chdir to /tmp, suppress output. Optional.\n" );
99       printf ( "-n\tDo not scan on launch; default is to run a scan for apps when %s is invoked.\n", argv [ 0 ] );
100       printf ( "##\tA numeric value is interpreted as number of seconds between checking for filesystem changes. Default %u.\n",
101                interval_secs );
102       printf ( "Signal: HUP the process to force reload of configuration and reset the notifier watch paths\n" );
103       exit ( 0 );
104     }
105
106   } // for
107
108   /* enable logging?
109    */
110   if ( g_daemon_mode ) {
111     // nada
112   } else {
113     pnd_log_set_filter ( pndn_rem );
114     pnd_log_set_pretext ( "pndnotifyd" );
115     pnd_log_to_stdout();
116     pnd_log ( pndn_rem, "log level starting as %u", pnd_log_get_filter() );
117   }
118
119   pnd_log ( pndn_rem, "Interval between checks is %u seconds\n", interval_secs );
120
121   // check if inotify is awake yet; if not, try waiting for awhile to see if it does
122   pnd_log ( pndn_rem, "Starting INOTIFY test; should be instant, but may take awhile...\n" );
123
124   if ( ! pnd_notify_wait_until_ready ( 120 /* seconds */ ) ) {
125     pnd_log ( pndn_error, "ERROR: INOTIFY refuses to be useful and quite awhile has passed. Bailing out.\n" );
126     return ( -1 );
127   }
128
129   pnd_log ( pndn_rem, "INOTIFY seems to be useful, whew.\n" );
130
131   // basic daemon set up
132   if ( g_daemon_mode ) {
133
134     // set a CWD somewhere else
135 #if 0
136     chdir ( "/tmp" );
137 #endif
138
139     // detach from terminal
140     if ( ( i = fork() ) < 0 ) {
141       pnd_log ( pndn_error, "ERROR: Couldn't fork()\n" );
142       exit ( i );
143     }
144     if ( i ) {
145       exit ( 0 ); // exit parent
146     }
147     setsid();
148
149     // umask
150     umask ( 022 ); // emitted files can be rwxr-xr-x
151     
152   } // set up daemon
153
154   /* parse configs
155    */
156
157   consume_configuration();
158
159   /* startup
160    */
161
162   pnd_log ( pndn_rem, "PXML overrides searchpath is '%s'\n", overridespath );
163   pnd_log ( pndn_rem, "Notify searchpath is '%s'\n", notifypath );
164
165   pnd_log ( pndn_rem, "Desktop apps ---------------------------------\n" );
166   pnd_log ( pndn_rem, "Apps searchpath is '%s'\n", desktop_appspath );
167   pnd_log ( pndn_rem, ".desktop files emit to '%s'\n", desktop_dotdesktoppath );
168   pnd_log ( pndn_rem, ".desktop icon files emit to '%s'\n", desktop_iconpath );
169
170   pnd_log ( pndn_rem, "Menu apps ---------------------------------\n" );
171   pnd_log ( pndn_rem, "Apps searchpath is '%s'\n", menu_appspath );
172   pnd_log ( pndn_rem, ".desktop files emit to '%s'\n", menu_dotdesktoppath );
173   pnd_log ( pndn_rem, ".desktop icon files emit to '%s'\n", menu_iconpath );
174
175   /* set up signal handler
176    */
177   sigset_t ss;
178   sigemptyset ( &ss );
179
180   struct sigaction siggy;
181   siggy.sa_handler = sighup_handler;
182   siggy.sa_mask = ss; /* implicitly blocks the origin signal */
183   siggy.sa_flags = 0; /* don't need anything */
184
185   sigaction ( SIGHUP, &siggy, NULL );
186
187   /* set up notifies
188    */
189
190   // if we're gong to scan on launch, it'll set things right up and then set up notifications.
191   // if no scan on launch, we need to set the notif's up now.
192   //if ( ! scanonlaunch ) {
193   setup_notifications();
194   //}
195
196   /* daemon main loop
197    */
198   while ( 1 ) {
199
200     // need to rediscover?
201     if ( scanonlaunch ||
202          pnd_notify_rediscover_p ( nh ) )
203     {
204       createtime = time ( NULL ); // all 'new' .destops are created at or after this time; prev are old.
205
206       // if this was a forced scan, lets not do that next iteration
207       if ( scanonlaunch ) {
208         scanonlaunch = 0;
209       }
210
211       // by this point, the watched directories have notified us that something of relevent
212       // has occurred; we should be clever, but we're not, so just re-brute force the
213       // discovery and spit out .desktop files..
214       pnd_log ( pndn_rem, "------------------------------------------------------\n" );
215       pnd_log ( pndn_rem, "Changes within watched paths .. performing re-discover!\n" );
216
217       /* run the discovery
218        */
219
220       pnd_log ( pndn_rem, "Scanning desktop paths----------------------------\n" );
221       if ( ! perform_discoveries ( desktop_appspath, overridespath, desktop_dotdesktoppath, desktop_iconpath ) ) {
222         pnd_log ( pndn_rem, "No applications found in desktop search path\n" );
223       }
224
225       if ( menu_appspath && menu_dotdesktoppath && menu_iconpath ) {
226         pnd_log ( pndn_rem, "Scanning menu paths----------------------------\n" );
227         if ( ! perform_discoveries ( menu_appspath, overridespath, menu_dotdesktoppath, menu_iconpath ) ) {
228           pnd_log ( pndn_rem, "No applications found in menu search path\n" );
229         }
230       }
231
232       // if we've got a hup script located, lets invoke it
233       if ( pndhup ) {
234         pnd_log ( pndn_rem, "Invoking hup script '%s'.\n", pndhup );
235         pnd_exec_no_wait_1 ( pndhup, NULL );
236       }
237
238       // since its entirely likely new directories have been found (ie: SD with a directory structure was inserted)
239       // we should re-apply watches to catch all these new directories; ie: user might use on-device browser to
240       // drop in new applications, or use the shell to juggle them around, or any number of activities.
241       //setup_notifications();
242
243     } // need to rediscover?
244
245     // lets not eat up all the CPU
246     // should use an alarm or select() or something -- I mean really, why aren't I putting interval_secs into
247     // the select() call above in pnd_notify_whatsitcalled()? -- but lets not break this right before release shall we
248     // NOTE: Oh right, I remember now -- inotify will spam when a card is inserted, and it will not be instantaneoous..
249     // the events will dribble in over a second. So this sleep is a lame trick that generally works. I really should
250     // do select(), and then when it returns just spin for a couple seconds slurping up events until no more and a thresh-hold
251     // time is hit, but this will do for now. I suck.
252     sleep ( interval_secs );
253
254   } // while
255
256   /* shutdown
257    */
258   pnd_notify_shutdown ( nh );
259
260   return ( 0 );
261 }
262
263 void consume_configuration ( void ) {
264
265   // attempt to fetch a sensible default searchpath for configs
266   configpath = pnd_conf_query_searchpath();
267
268   // attempt to fetch the apps config to pick up a searchpath
269   pnd_conf_handle apph;
270
271   apph = pnd_conf_fetch_by_id ( pnd_conf_apps, configpath );
272
273   if ( apph ) {
274
275     overridespath = pnd_conf_get_as_char ( apph, PND_PXML_OVERRIDE_KEY );
276
277     if ( ! overridespath ) {
278       overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
279     }
280
281     notifypath = pnd_conf_get_as_char ( apph, PND_APPS_NOTIFY_KEY );
282
283     if ( ! notifypath ) {
284       notifypath = PND_APPS_NOTIFYPATH;
285     }
286
287   } else {
288     // couldn't find a useful app search path so use the default
289     overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
290     notifypath = PND_APPS_NOTIFYPATH;
291   }
292
293   // attempt to figure out where to drop dotfiles .. now that we're going
294   // multi-target we see the limit of my rudimentary conf-file parser; should
295   // just parse to an array of targets, rather that hardcoding two, but
296   // on the other hand, don't likely see the need for more than two? (famous
297   // last words.)
298   pnd_conf_handle desktoph;
299
300   desktoph = pnd_conf_fetch_by_id ( pnd_conf_desktop, configpath );
301
302   // for 'desktop' main applications
303   if ( desktoph ) {
304     desktop_dotdesktoppath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_DOTDESKTOP_PATH_KEY );
305     desktop_iconpath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_ICONS_PATH_KEY );
306     desktop_appspath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_SEARCH_KEY );
307   }
308
309   if ( ! desktop_dotdesktoppath ) {
310     desktop_dotdesktoppath = PND_DESKTOP_DOTDESKTOP_PATH_DEFAULT;
311   }
312
313   if ( ! desktop_iconpath ) {
314     desktop_iconpath = PND_DESKTOP_ICONS_PATH_DEFAULT;
315   }
316
317   if ( ! desktop_appspath ) {
318     desktop_appspath = PND_DESKTOP_SEARCH_PATH_DEFAULT;
319   }
320
321   // for 'menu' applications
322   if ( desktoph ) {
323     menu_dotdesktoppath = pnd_conf_get_as_char ( desktoph, PND_MENU_DOTDESKTOP_PATH_KEY );
324     menu_iconpath = pnd_conf_get_as_char ( desktoph, PND_MENU_ICONS_PATH_KEY );
325     menu_appspath = pnd_conf_get_as_char ( desktoph, PND_MENU_SEARCH_KEY );
326   }
327
328   /* try to locate a runscript and optional hupscript
329    */
330
331   if ( apph ) {
332     run_searchpath = pnd_conf_get_as_char ( apph, PND_PNDRUN_SEARCHPATH_KEY );
333     run_script = pnd_conf_get_as_char ( apph, PND_PNDRUN_KEY );
334     pndrun = NULL;
335
336     if ( ! run_searchpath ) {
337       run_searchpath = PND_APPS_SEARCHPATH;
338       run_script = PND_PNDRUN_FILENAME;
339     }
340
341     if ( pnd_conf_get_as_int ( apph, PNDNOTIFYD_LOGLEVEL ) != PND_CONF_BADNUM ) {
342       pnd_log_set_filter ( pnd_conf_get_as_int ( apph, PNDNOTIFYD_LOGLEVEL ) );
343       pnd_log ( pndn_rem, "config file causes loglevel to change to %u", pnd_log_get_filter() );
344     }
345
346   } else {
347     run_searchpath = NULL;
348     run_script = NULL;
349     pndrun = PND_PNDRUN_DEFAULT;
350   }
351
352   if ( ! pndrun ) {
353     pndrun = pnd_locate_filename ( run_searchpath, run_script );
354
355     if ( pndrun ) {
356       pndrun = strdup ( pndrun ); // so we don't just use the built in buffer; next locate will overwrite it
357     } else {
358       pndrun = PND_PNDRUN_DEFAULT;
359     }
360
361   }
362
363   if ( desktoph && run_searchpath ) {
364     char *t;
365
366     if ( ( t = pnd_conf_get_as_char ( desktoph, PND_PNDHUP_KEY ) ) ) {
367       pndhup = pnd_locate_filename ( run_searchpath, t );
368
369       if ( pndhup ) {
370         pndhup = strdup ( pndhup ); // so we don't just use the built in buffer; next locate will overwrite it
371       }
372
373 #if 0 // don't enable this; if no key in config, we don't want to bother hupping
374     } else {
375       pndhup = pnd_locate_filename ( run_searchpath, PND_PNDHUP_FILENAME );
376 #endif
377     }
378
379   }
380
381   // debug
382   if ( run_searchpath ) pnd_log ( pndn_rem, "Locating pnd run in %s\n", run_searchpath );
383   if ( run_script ) pnd_log ( pndn_rem, "Locating pnd runscript as %s\n", run_script );
384   if ( pndrun ) pnd_log ( pndn_rem, "pndrun is %s\n", pndrun );
385   if ( pndhup ) {
386     pnd_log ( pndn_rem, "pndhup is %s\n", pndhup );
387   } else {
388     pnd_log ( pndn_rem, "No pndhup found (which is fine.)\n" );
389   }
390
391   /* handle globbing or variable substitution
392    */
393   desktop_dotdesktoppath = pnd_expand_tilde ( strdup ( desktop_dotdesktoppath ) );
394   desktop_iconpath = pnd_expand_tilde ( strdup ( desktop_iconpath ) );
395   mkdir ( desktop_dotdesktoppath, 0777 );
396   mkdir ( desktop_iconpath, 0777 );
397
398   if ( menu_dotdesktoppath ) {
399     menu_dotdesktoppath = pnd_expand_tilde ( strdup ( menu_dotdesktoppath ) );
400     mkdir ( menu_dotdesktoppath, 0777 );
401   }
402   if ( menu_iconpath ) {
403     menu_iconpath = pnd_expand_tilde ( strdup ( menu_iconpath ) );
404     mkdir ( menu_iconpath, 0777 );
405   }
406
407   // done
408   return;
409 }
410
411 void setup_notifications ( void ) {
412   searchpath = notifypath;
413
414   // if this is first time through, we can just set it up; for subsequent times
415   // through, we need to close existing fd and re-open it, since we're too lame
416   // to store the list of watches and 'rm' them
417 #if 1
418   if ( nh ) {
419     pnd_notify_shutdown ( nh );
420     nh = 0;
421   }
422 #endif
423
424   // set up a new set of notifies
425   if ( ! nh ) {
426     nh = pnd_notify_init();
427   }
428
429   if ( ! nh ) {
430     pnd_log ( pndn_rem, "INOTIFY failed to init.\n" );
431     exit ( -1 );
432   }
433
434 #if 0
435   pnd_log ( pndn_rem, "INOTIFY is up.\n" );
436 #endif
437
438   SEARCHPATH_PRE
439   {
440
441     pnd_log ( pndn_rem, "Watching path '%s' and its descendents.\n", buffer );
442     pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
443
444   }
445   SEARCHPATH_POST
446
447   return;
448 }
449
450 void sighup_handler ( int n ) {
451
452   pnd_log ( pndn_rem, "---[ SIGHUP received ]---\n" );
453
454   // reparse config files
455   consume_configuration();
456
457   // re set up the notifier watches
458   setup_notifications();
459
460   return;
461 }
462
463 // This very recently was inline code; just slight refactor to functionize it so that it can be
464 // reused in a couple of places. Simple code with simple design quickly became too large for
465 // its simple design; should revisit a lot of these little things..
466 void process_discoveries ( pnd_box_handle applist, char *emitdesktoppath, char *emiticonpath ) {
467   pnd_disco_t *d = pnd_box_get_head ( applist );
468
469   while ( d ) {
470
471     pnd_log ( pndn_rem, "Found app: %s\n", pnd_box_get_key ( d ) );
472
473     // check if icon already exists (from a previous extraction say); if so, we needn't
474     // do it again
475     char existingpath [ FILENAME_MAX ];
476     sprintf ( existingpath, "%s/%s.png", emiticonpath, d -> unique_id );
477
478     struct stat dirs;
479     if ( stat ( existingpath, &dirs ) == 0 ) {
480       // icon seems to exist, so just crib the location into the .desktop
481
482       pnd_log ( pndn_rem, "  Found icon already existed, so reusing it! %s\n", existingpath );
483
484       if ( d -> icon ) {
485         free ( d -> icon );
486       }
487       d -> icon = strdup ( existingpath );
488
489     } else {
490       // icon seems unreadable or does not exist; lets try to create it..
491
492       pnd_log ( pndn_debug, "  Icon not already present, so trying to write it! %s\n", existingpath );
493
494       // attempt to create icon files; if successful, alter the disco struct to contain new
495       // path, otherwise leave it alone (since it could be a generic icon reference..)
496       if ( pnd_emit_icon ( emiticonpath, d ) ) {
497         // success; fix up icon path to new one..
498         if ( d -> icon ) {
499           free ( d -> icon );
500         }
501         d -> icon = strdup ( existingpath );
502       } else {
503         pnd_log ( pndn_debug, "  WARN: Couldn't write out icon %s\n", existingpath );
504       }
505
506     } // icon already exists?
507
508     // create the .desktop file
509     if ( pnd_emit_dotdesktop ( emitdesktoppath, pndrun, d ) ) {
510       // add a watch onto the newly created .desktop?
511 #if 0
512       char buffer [ FILENAME_MAX ];
513       sprintf ( buffer, "%s/%s", emitdesktoppath, d -> unique_id );
514       pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
515 #endif
516     } else {
517       pnd_log ( pndn_rem, "ERROR: Error creating .desktop file for app: %s\n", pnd_box_get_key ( d ) );
518     }
519
520     // next!
521     d = pnd_box_get_next ( d );
522
523   } // while applist
524
525   return;
526 }
527
528 // returns true if any applications were found
529 unsigned char perform_discoveries ( char *appspath, char *overridespath,              // args to do discovery
530                                     char *emitdesktoppath, char *emiticonpath )       // args to do emitting
531 {
532   pnd_box_handle applist;
533
534   // attempt to auto-discover applications in the given path
535   applist = pnd_disco_search ( appspath, overridespath );
536
537   if ( applist ) {
538     process_discoveries ( applist, emitdesktoppath, emiticonpath );
539   }
540
541   // run a clean up, to remove any dotdesktop files that we didn't
542   // just now create (that seem to have been created by pndnotifyd
543   // previously.) This allows SD eject (or .pnd remove) to remove
544   // an app from the launcher
545   //   NOTE: Could opendir and iterate across all .desktop files,
546   // removing any that have Source= something else, and that the
547   // app name is not in the list found in applist box above. But
548   // a cheesy simple way right now is to just remove .desktop files
549   // that have a last mod time prior to the time we stored above.
550   {
551     DIR *dir;
552
553     if ( ( dir = opendir ( emitdesktoppath ) ) ) {
554       struct dirent *dirent;
555       struct stat dirs;
556       char buffer [ FILENAME_MAX ];
557
558       while ( ( dirent = readdir ( dir ) ) ) {
559
560         // file is a .desktop?
561         if ( strstr ( dirent -> d_name, ".desktop" ) == NULL ) {
562           continue;
563         }
564
565         // figure out full path
566         sprintf ( buffer, "%s/%s", emitdesktoppath, dirent -> d_name );
567
568         // file was previously created by libpnd; check Source= line
569         // logic: default to 'yes' (in case we can't open the file for some reason)
570         //        if we can open the file, default to no and look for the source flag we added; if
571         //          that matches then we know its libpnd created, otherwise assume not.
572         unsigned char source_libpnd = 1;
573         {
574           char line [ 256 ];
575           FILE *grep = fopen ( buffer, "r" );
576           if ( grep ) {
577             source_libpnd = 0;
578             while ( fgets ( line, 255, grep ) ) {
579               if ( strcasestr ( line, PND_DOTDESKTOP_SOURCE ) ) {
580                 source_libpnd = 2;
581               }
582             } // while
583             fclose ( grep );
584           }
585         }
586         if ( source_libpnd ) {
587 #if 0
588           pnd_log ( pndn_rem,
589                     "File '%s' appears to have been created by libpnd so candidate for delete: %u\n", buffer, source_libpnd );
590 #endif
591         } else {
592 #if 0
593           pnd_log ( pndn_rem, "File '%s' appears NOT to have been created by libpnd, so leave it alone\n", buffer );
594 #endif
595           continue; // skip deleting it
596         }
597
598         // file is 'new'?
599         if ( stat ( buffer, &dirs ) == 0 ) {
600           if ( dirs.st_mtime >= createtime ) {
601 #if 0
602             pnd_log ( pndn_rem, "File '%s' seems 'new', so leave it alone.\n", buffer );
603 #endif
604             continue; // skip deleting it
605           }
606         }
607
608         // by this point, the .desktop file must be 'old' and created by pndnotifyd
609         // previously, so can remove it
610         pnd_log ( pndn_rem, "File '%s' seems nolonger relevent; removing it.\n", dirent -> d_name );
611         unlink ( buffer );
612
613       } // while getting filenames from dir
614
615       closedir ( dir );
616     }
617
618   } // purge old .desktop files
619
620   //WARN: MEMORY LEAK HERE
621   pnd_log ( pndn_debug, "pndnotifyd - memory leak here - perform_discoveries()\n" );
622   pnd_box_delete ( applist ); // does not free the disco_t contents!
623
624   return ( 1 );
625 }