Add a couple things to TODO list so I don't forget (TODO.txt)
[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   // basic daemon set up
122   if ( g_daemon_mode ) {
123
124     // set a CWD somewhere else
125 #if 0
126     chdir ( "/tmp" );
127 #endif
128
129     // detach from terminal
130     if ( ( i = fork() ) < 0 ) {
131       pnd_log ( pndn_error, "ERROR: Couldn't fork()\n" );
132       exit ( i );
133     }
134     if ( i ) {
135       exit ( 0 ); // exit parent
136     }
137     setsid();
138
139     // umask
140     umask ( 022 ); // emitted files can be rwxr-xr-x
141     
142   } // set up daemon
143
144   /* parse configs
145    */
146
147   consume_configuration();
148
149   /* startup
150    */
151
152   pnd_log ( pndn_rem, "PXML overrides searchpath is '%s'\n", overridespath );
153   pnd_log ( pndn_rem, "Notify searchpath is '%s'\n", notifypath );
154
155   pnd_log ( pndn_rem, "Desktop apps ---------------------------------\n" );
156   pnd_log ( pndn_rem, "Apps searchpath is '%s'\n", desktop_appspath );
157   pnd_log ( pndn_rem, ".desktop files emit to '%s'\n", desktop_dotdesktoppath );
158   pnd_log ( pndn_rem, ".desktop icon files emit to '%s'\n", desktop_iconpath );
159
160   pnd_log ( pndn_rem, "Menu apps ---------------------------------\n" );
161   pnd_log ( pndn_rem, "Apps searchpath is '%s'\n", menu_appspath );
162   pnd_log ( pndn_rem, ".desktop files emit to '%s'\n", menu_dotdesktoppath );
163   pnd_log ( pndn_rem, ".desktop icon files emit to '%s'\n", menu_iconpath );
164
165   /* set up signal handler
166    */
167   sigset_t ss;
168   sigemptyset ( &ss );
169
170   struct sigaction siggy;
171   siggy.sa_handler = sighup_handler;
172   siggy.sa_mask = ss; /* implicitly blocks the origin signal */
173   siggy.sa_flags = 0; /* don't need anything */
174
175   sigaction ( SIGHUP, &siggy, NULL );
176
177   /* set up notifies
178    */
179
180   // if we're gong to scan on launch, it'll set things right up and then set up notifications.
181   // if no scan on launch, we need to set the notif's up now.
182   //if ( ! scanonlaunch ) {
183   setup_notifications();
184   //}
185
186   /* daemon main loop
187    */
188   while ( 1 ) {
189
190     // need to rediscover?
191     if ( scanonlaunch ||
192          pnd_notify_rediscover_p ( nh ) )
193     {
194       createtime = time ( NULL ); // all 'new' .destops are created at or after this time; prev are old.
195
196       // if this was a forced scan, lets not do that next iteration
197       if ( scanonlaunch ) {
198         scanonlaunch = 0;
199       }
200
201       // by this point, the watched directories have notified us that something of relevent
202       // has occurred; we should be clever, but we're not, so just re-brute force the
203       // discovery and spit out .desktop files..
204       pnd_log ( pndn_rem, "------------------------------------------------------\n" );
205       pnd_log ( pndn_rem, "Changes within watched paths .. performing re-discover!\n" );
206
207       /* run the discovery
208        */
209
210       pnd_log ( pndn_rem, "Scanning desktop paths----------------------------\n" );
211       if ( ! perform_discoveries ( desktop_appspath, overridespath, desktop_dotdesktoppath, desktop_iconpath ) ) {
212         pnd_log ( pndn_rem, "No applications found in desktop search path\n" );
213       }
214
215       if ( menu_appspath && menu_dotdesktoppath && menu_iconpath ) {
216         pnd_log ( pndn_rem, "Scanning menu paths----------------------------\n" );
217         if ( ! perform_discoveries ( menu_appspath, overridespath, menu_dotdesktoppath, menu_iconpath ) ) {
218           pnd_log ( pndn_rem, "No applications found in menu search path\n" );
219         }
220       }
221
222       // if we've got a hup script located, lets invoke it
223       if ( pndhup ) {
224         pnd_log ( pndn_rem, "Invoking hup script '%s'.\n", pndhup );
225         pnd_exec_no_wait_1 ( pndhup, NULL );
226       }
227
228       // since its entirely likely new directories have been found (ie: SD with a directory structure was inserted)
229       // we should re-apply watches to catch all these new directories; ie: user might use on-device browser to
230       // drop in new applications, or use the shell to juggle them around, or any number of activities.
231       //setup_notifications();
232
233     } // need to rediscover?
234
235     // lets not eat up all the CPU
236     // should use an alarm or select() or something -- I mean really, why aren't I putting interval_secs into
237     // the select() call above in pnd_notify_whatsitcalled()? -- but lets not break this right before release shall we
238     sleep ( interval_secs );
239
240   } // while
241
242   /* shutdown
243    */
244   pnd_notify_shutdown ( nh );
245
246   return ( 0 );
247 }
248
249 void consume_configuration ( void ) {
250
251   // attempt to fetch a sensible default searchpath for configs
252   configpath = pnd_conf_query_searchpath();
253
254   // attempt to fetch the apps config to pick up a searchpath
255   pnd_conf_handle apph;
256
257   apph = pnd_conf_fetch_by_id ( pnd_conf_apps, configpath );
258
259   if ( apph ) {
260
261     overridespath = pnd_conf_get_as_char ( apph, PND_PXML_OVERRIDE_KEY );
262
263     if ( ! overridespath ) {
264       overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
265     }
266
267     notifypath = pnd_conf_get_as_char ( apph, PND_APPS_NOTIFY_KEY );
268
269     if ( ! notifypath ) {
270       notifypath = PND_APPS_NOTIFYPATH;
271     }
272
273   } else {
274     // couldn't find a useful app search path so use the default
275     overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
276     notifypath = PND_APPS_NOTIFYPATH;
277   }
278
279   // attempt to figure out where to drop dotfiles .. now that we're going
280   // multi-target we see the limit of my rudimentary conf-file parser; should
281   // just parse to an array of targets, rather that hardcoding two, but
282   // on the other hand, don't likely see the need for more than two? (famous
283   // last words.)
284   pnd_conf_handle desktoph;
285
286   desktoph = pnd_conf_fetch_by_id ( pnd_conf_desktop, configpath );
287
288   // for 'desktop' main applications
289   if ( desktoph ) {
290     desktop_dotdesktoppath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_DOTDESKTOP_PATH_KEY );
291     desktop_iconpath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_ICONS_PATH_KEY );
292     desktop_appspath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_SEARCH_KEY );
293   }
294
295   if ( ! desktop_dotdesktoppath ) {
296     desktop_dotdesktoppath = PND_DESKTOP_DOTDESKTOP_PATH_DEFAULT;
297   }
298
299   if ( ! desktop_iconpath ) {
300     desktop_iconpath = PND_DESKTOP_ICONS_PATH_DEFAULT;
301   }
302
303   if ( ! desktop_appspath ) {
304     desktop_appspath = PND_DESKTOP_SEARCH_PATH_DEFAULT;
305   }
306
307   // for 'menu' applications
308   if ( desktoph ) {
309     menu_dotdesktoppath = pnd_conf_get_as_char ( desktoph, PND_MENU_DOTDESKTOP_PATH_KEY );
310     menu_iconpath = pnd_conf_get_as_char ( desktoph, PND_MENU_ICONS_PATH_KEY );
311     menu_appspath = pnd_conf_get_as_char ( desktoph, PND_MENU_SEARCH_KEY );
312   }
313
314   /* try to locate a runscript and optional hupscript
315    */
316
317   if ( apph ) {
318     run_searchpath = pnd_conf_get_as_char ( apph, PND_PNDRUN_SEARCHPATH_KEY );
319     run_script = pnd_conf_get_as_char ( apph, PND_PNDRUN_KEY );
320     pndrun = NULL;
321
322     if ( ! run_searchpath ) {
323       run_searchpath = PND_APPS_SEARCHPATH;
324       run_script = PND_PNDRUN_FILENAME;
325     }
326
327     if ( pnd_conf_get_as_int ( apph, PNDNOTIFYD_LOGLEVEL ) != PND_CONF_BADNUM ) {
328       pnd_log_set_filter ( pnd_conf_get_as_int ( apph, PNDNOTIFYD_LOGLEVEL ) );
329       pnd_log ( pndn_rem, "config file causes loglevel to change to %u", pnd_log_get_filter() );
330     }
331
332   } else {
333     run_searchpath = NULL;
334     run_script = NULL;
335     pndrun = PND_PNDRUN_DEFAULT;
336   }
337
338   if ( ! pndrun ) {
339     pndrun = pnd_locate_filename ( run_searchpath, run_script );
340
341     if ( pndrun ) {
342       pndrun = strdup ( pndrun ); // so we don't just use the built in buffer; next locate will overwrite it
343     } else {
344       pndrun = PND_PNDRUN_DEFAULT;
345     }
346
347   }
348
349   if ( desktoph && run_searchpath ) {
350     char *t;
351
352     if ( ( t = pnd_conf_get_as_char ( desktoph, PND_PNDHUP_KEY ) ) ) {
353       pndhup = pnd_locate_filename ( run_searchpath, t );
354
355       if ( pndhup ) {
356         pndhup = strdup ( pndhup ); // so we don't just use the built in buffer; next locate will overwrite it
357       }
358
359 #if 0 // don't enable this; if no key in config, we don't want to bother hupping
360     } else {
361       pndhup = pnd_locate_filename ( run_searchpath, PND_PNDHUP_FILENAME );
362 #endif
363     }
364
365   }
366
367   // debug
368   if ( run_searchpath ) pnd_log ( pndn_rem, "Locating pnd run in %s\n", run_searchpath );
369   if ( run_script ) pnd_log ( pndn_rem, "Locating pnd runscript as %s\n", run_script );
370   if ( pndrun ) pnd_log ( pndn_rem, "pndrun is %s\n", pndrun );
371   if ( pndhup ) {
372     pnd_log ( pndn_rem, "pndhup is %s\n", pndhup );
373   } else {
374     pnd_log ( pndn_rem, "No pndhup found (which is fine.)\n" );
375   }
376
377   /* handle globbing or variable substitution
378    */
379   desktop_dotdesktoppath = pnd_expand_tilde ( strdup ( desktop_dotdesktoppath ) );
380   desktop_iconpath = pnd_expand_tilde ( strdup ( desktop_iconpath ) );
381   mkdir ( desktop_dotdesktoppath, 0777 );
382   mkdir ( desktop_iconpath, 0777 );
383
384   if ( menu_dotdesktoppath ) {
385     menu_dotdesktoppath = pnd_expand_tilde ( strdup ( menu_dotdesktoppath ) );
386     mkdir ( menu_dotdesktoppath, 0777 );
387   }
388   if ( menu_iconpath ) {
389     menu_iconpath = pnd_expand_tilde ( strdup ( menu_iconpath ) );
390     mkdir ( menu_iconpath, 0777 );
391   }
392
393   // done
394   return;
395 }
396
397 void setup_notifications ( void ) {
398   searchpath = notifypath;
399
400   // if this is first time through, we can just set it up; for subsequent times
401   // through, we need to close existing fd and re-open it, since we're too lame
402   // to store the list of watches and 'rm' them
403 #if 1
404   if ( nh ) {
405     pnd_notify_shutdown ( nh );
406     nh = 0;
407   }
408 #endif
409
410   // set up a new set of notifies
411   if ( ! nh ) {
412     nh = pnd_notify_init();
413   }
414
415   if ( ! nh ) {
416     pnd_log ( pndn_rem, "INOTIFY failed to init.\n" );
417     exit ( -1 );
418   }
419
420 #if 0
421   pnd_log ( pndn_rem, "INOTIFY is up.\n" );
422 #endif
423
424   SEARCHPATH_PRE
425   {
426
427     pnd_log ( pndn_rem, "Watching path '%s' and its descendents.\n", buffer );
428     pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
429
430   }
431   SEARCHPATH_POST
432
433   return;
434 }
435
436 void sighup_handler ( int n ) {
437
438   pnd_log ( pndn_rem, "---[ SIGHUP received ]---\n" );
439
440   // reparse config files
441   consume_configuration();
442
443   // re set up the notifier watches
444   setup_notifications();
445
446   return;
447 }
448
449 // This very recently was inline code; just slight refactor to functionize it so that it can be
450 // reused in a couple of places. Simple code with simple design quickly became too large for
451 // its simple design; should revisit a lot of these little things..
452 void process_discoveries ( pnd_box_handle applist, char *emitdesktoppath, char *emiticonpath ) {
453   pnd_disco_t *d = pnd_box_get_head ( applist );
454
455   while ( d ) {
456
457     pnd_log ( pndn_rem, "Found app: %s\n", pnd_box_get_key ( d ) );
458
459     // check if icon already exists (from a previous extraction say); if so, we needn't
460     // do it again
461     char existingpath [ FILENAME_MAX ];
462     sprintf ( existingpath, "%s/%s.png", emiticonpath, d -> unique_id );
463
464     struct stat dirs;
465     if ( stat ( existingpath, &dirs ) == 0 ) {
466       // icon seems to exist, so just crib the location into the .desktop
467
468       pnd_log ( pndn_rem, "  Found icon already existed, so reusing it! %s\n", existingpath );
469
470       if ( d -> icon ) {
471         free ( d -> icon );
472       }
473       d -> icon = strdup ( existingpath );
474
475     } else {
476       // icon seems unreadable or does not exist; lets try to create it..
477
478       pnd_log ( pndn_debug, "  Icon not already present, so trying to write it! %s\n", existingpath );
479
480       // attempt to create icon files; if successful, alter the disco struct to contain new
481       // path, otherwise leave it alone (since it could be a generic icon reference..)
482       if ( pnd_emit_icon ( emiticonpath, d ) ) {
483         // success; fix up icon path to new one..
484         if ( d -> icon ) {
485           free ( d -> icon );
486         }
487         d -> icon = strdup ( existingpath );
488       } else {
489         pnd_log ( pndn_debug, "  WARN: Couldn't write out icon %s\n", existingpath );
490       }
491
492     } // icon already exists?
493
494     // create the .desktop file
495     if ( pnd_emit_dotdesktop ( emitdesktoppath, pndrun, d ) ) {
496       // add a watch onto the newly created .desktop?
497 #if 0
498       char buffer [ FILENAME_MAX ];
499       sprintf ( buffer, "%s/%s", emitdesktoppath, d -> unique_id );
500       pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
501 #endif
502     } else {
503       pnd_log ( pndn_rem, "ERROR: Error creating .desktop file for app: %s\n", pnd_box_get_key ( d ) );
504     }
505
506     // next!
507     d = pnd_box_get_next ( d );
508
509   } // while applist
510
511   return;
512 }
513
514 // returns true if any applications were found
515 unsigned char perform_discoveries ( char *appspath, char *overridespath,              // args to do discovery
516                                     char *emitdesktoppath, char *emiticonpath )       // args to do emitting
517 {
518   pnd_box_handle applist;
519
520   // attempt to auto-discover applications in the given path
521   applist = pnd_disco_search ( appspath, overridespath );
522
523   if ( ! applist ) {
524     return ( 0 );
525   }
526
527   process_discoveries ( applist, emitdesktoppath, emiticonpath );
528
529   // run a clean up, to remove any dotdesktop files that we didn't
530   // just now create (that seem to have been created by pndnotifyd
531   // previously.) This allows SD eject (or .pnd remove) to remove
532   // an app from the launcher
533   //   NOTE: Could opendir and iterate across all .desktop files,
534   // removing any that have Source= something else, and that the
535   // app name is not in the list found in applist box above. But
536   // a cheesy simple way right now is to just remove .desktop files
537   // that have a last mod time prior to the time we stored above.
538   {
539     DIR *dir;
540
541     if ( ( dir = opendir ( emitdesktoppath ) ) ) {
542       struct dirent *dirent;
543       struct stat dirs;
544       char buffer [ FILENAME_MAX ];
545
546       while ( ( dirent = readdir ( dir ) ) ) {
547
548         // file is a .desktop?
549         if ( strstr ( dirent -> d_name, ".desktop" ) == NULL ) {
550           continue;
551         }
552
553         // figure out full path
554         sprintf ( buffer, "%s/%s", emitdesktoppath, dirent -> d_name );
555
556         // file was previously created by libpnd; check Source= line
557         // logic: default to 'yes' (in case we can't open the file for some reason)
558         //        if we can open the file, default to no and look for the source flag we added; if
559         //          that matches then we know its libpnd created, otherwise assume not.
560         unsigned char source_libpnd = 1;
561         {
562           char line [ 256 ];
563           FILE *grep = fopen ( buffer, "r" );
564           if ( grep ) {
565             source_libpnd = 0;
566             while ( fgets ( line, 255, grep ) ) {
567               if ( strcasestr ( line, PND_DOTDESKTOP_SOURCE ) ) {
568                 source_libpnd = 2;
569               }
570             } // while
571             fclose ( grep );
572           }
573         }
574         if ( source_libpnd ) {
575 #if 0
576           pnd_log ( pndn_rem,
577                     "File '%s' appears to have been created by libpnd so candidate for delete: %u\n", buffer, source_libpnd );
578 #endif
579         } else {
580 #if 0
581           pnd_log ( pndn_rem, "File '%s' appears NOT to have been created by libpnd, so leave it alone\n", buffer );
582 #endif
583           continue; // skip deleting it
584         }
585
586         // file is 'new'?
587         if ( stat ( buffer, &dirs ) == 0 ) {
588           if ( dirs.st_mtime >= createtime ) {
589 #if 0
590             pnd_log ( pndn_rem, "File '%s' seems 'new', so leave it alone.\n", buffer );
591 #endif
592             continue; // skip deleting it
593           }
594         }
595
596         // by this point, the .desktop file must be 'old' and created by pndnotifyd
597         // previously, so can remove it
598         pnd_log ( pndn_rem, "File '%s' seems nolonger relevent; removing it.\n", dirent -> d_name );
599         unlink ( buffer );
600
601       } // while getting filenames from dir
602
603       closedir ( dir );
604     }
605
606   } // purge old .desktop files
607
608   //WARN: MEMORY LEAK HERE
609   pnd_log ( pndn_debug, "pndnotifyd - memory leak here - perform_discoveries()\n" );
610   pnd_box_delete ( applist ); // does not free the disco_t contents!
611
612   return ( 1 );
613 }