In the last couple checkins, introduced a bug where when a SD is popped out
[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     // NOTE: Oh right, I remember now -- inotify will spam when a card is inserted, and it will not be instantaneoous..
239     // the events will dribble in over a second. So this sleep is a lame trick that generally works. I really should
240     // do select(), and then when it returns just spin for a couple seconds slurping up events until no more and a thresh-hold
241     // time is hit, but this will do for now. I suck.
242     sleep ( interval_secs );
243
244   } // while
245
246   /* shutdown
247    */
248   pnd_notify_shutdown ( nh );
249
250   return ( 0 );
251 }
252
253 void consume_configuration ( void ) {
254
255   // attempt to fetch a sensible default searchpath for configs
256   configpath = pnd_conf_query_searchpath();
257
258   // attempt to fetch the apps config to pick up a searchpath
259   pnd_conf_handle apph;
260
261   apph = pnd_conf_fetch_by_id ( pnd_conf_apps, configpath );
262
263   if ( apph ) {
264
265     overridespath = pnd_conf_get_as_char ( apph, PND_PXML_OVERRIDE_KEY );
266
267     if ( ! overridespath ) {
268       overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
269     }
270
271     notifypath = pnd_conf_get_as_char ( apph, PND_APPS_NOTIFY_KEY );
272
273     if ( ! notifypath ) {
274       notifypath = PND_APPS_NOTIFYPATH;
275     }
276
277   } else {
278     // couldn't find a useful app search path so use the default
279     overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
280     notifypath = PND_APPS_NOTIFYPATH;
281   }
282
283   // attempt to figure out where to drop dotfiles .. now that we're going
284   // multi-target we see the limit of my rudimentary conf-file parser; should
285   // just parse to an array of targets, rather that hardcoding two, but
286   // on the other hand, don't likely see the need for more than two? (famous
287   // last words.)
288   pnd_conf_handle desktoph;
289
290   desktoph = pnd_conf_fetch_by_id ( pnd_conf_desktop, configpath );
291
292   // for 'desktop' main applications
293   if ( desktoph ) {
294     desktop_dotdesktoppath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_DOTDESKTOP_PATH_KEY );
295     desktop_iconpath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_ICONS_PATH_KEY );
296     desktop_appspath = pnd_conf_get_as_char ( desktoph, PND_DESKTOP_SEARCH_KEY );
297   }
298
299   if ( ! desktop_dotdesktoppath ) {
300     desktop_dotdesktoppath = PND_DESKTOP_DOTDESKTOP_PATH_DEFAULT;
301   }
302
303   if ( ! desktop_iconpath ) {
304     desktop_iconpath = PND_DESKTOP_ICONS_PATH_DEFAULT;
305   }
306
307   if ( ! desktop_appspath ) {
308     desktop_appspath = PND_DESKTOP_SEARCH_PATH_DEFAULT;
309   }
310
311   // for 'menu' applications
312   if ( desktoph ) {
313     menu_dotdesktoppath = pnd_conf_get_as_char ( desktoph, PND_MENU_DOTDESKTOP_PATH_KEY );
314     menu_iconpath = pnd_conf_get_as_char ( desktoph, PND_MENU_ICONS_PATH_KEY );
315     menu_appspath = pnd_conf_get_as_char ( desktoph, PND_MENU_SEARCH_KEY );
316   }
317
318   /* try to locate a runscript and optional hupscript
319    */
320
321   if ( apph ) {
322     run_searchpath = pnd_conf_get_as_char ( apph, PND_PNDRUN_SEARCHPATH_KEY );
323     run_script = pnd_conf_get_as_char ( apph, PND_PNDRUN_KEY );
324     pndrun = NULL;
325
326     if ( ! run_searchpath ) {
327       run_searchpath = PND_APPS_SEARCHPATH;
328       run_script = PND_PNDRUN_FILENAME;
329     }
330
331     if ( pnd_conf_get_as_int ( apph, PNDNOTIFYD_LOGLEVEL ) != PND_CONF_BADNUM ) {
332       pnd_log_set_filter ( pnd_conf_get_as_int ( apph, PNDNOTIFYD_LOGLEVEL ) );
333       pnd_log ( pndn_rem, "config file causes loglevel to change to %u", pnd_log_get_filter() );
334     }
335
336   } else {
337     run_searchpath = NULL;
338     run_script = NULL;
339     pndrun = PND_PNDRUN_DEFAULT;
340   }
341
342   if ( ! pndrun ) {
343     pndrun = pnd_locate_filename ( run_searchpath, run_script );
344
345     if ( pndrun ) {
346       pndrun = strdup ( pndrun ); // so we don't just use the built in buffer; next locate will overwrite it
347     } else {
348       pndrun = PND_PNDRUN_DEFAULT;
349     }
350
351   }
352
353   if ( desktoph && run_searchpath ) {
354     char *t;
355
356     if ( ( t = pnd_conf_get_as_char ( desktoph, PND_PNDHUP_KEY ) ) ) {
357       pndhup = pnd_locate_filename ( run_searchpath, t );
358
359       if ( pndhup ) {
360         pndhup = strdup ( pndhup ); // so we don't just use the built in buffer; next locate will overwrite it
361       }
362
363 #if 0 // don't enable this; if no key in config, we don't want to bother hupping
364     } else {
365       pndhup = pnd_locate_filename ( run_searchpath, PND_PNDHUP_FILENAME );
366 #endif
367     }
368
369   }
370
371   // debug
372   if ( run_searchpath ) pnd_log ( pndn_rem, "Locating pnd run in %s\n", run_searchpath );
373   if ( run_script ) pnd_log ( pndn_rem, "Locating pnd runscript as %s\n", run_script );
374   if ( pndrun ) pnd_log ( pndn_rem, "pndrun is %s\n", pndrun );
375   if ( pndhup ) {
376     pnd_log ( pndn_rem, "pndhup is %s\n", pndhup );
377   } else {
378     pnd_log ( pndn_rem, "No pndhup found (which is fine.)\n" );
379   }
380
381   /* handle globbing or variable substitution
382    */
383   desktop_dotdesktoppath = pnd_expand_tilde ( strdup ( desktop_dotdesktoppath ) );
384   desktop_iconpath = pnd_expand_tilde ( strdup ( desktop_iconpath ) );
385   mkdir ( desktop_dotdesktoppath, 0777 );
386   mkdir ( desktop_iconpath, 0777 );
387
388   if ( menu_dotdesktoppath ) {
389     menu_dotdesktoppath = pnd_expand_tilde ( strdup ( menu_dotdesktoppath ) );
390     mkdir ( menu_dotdesktoppath, 0777 );
391   }
392   if ( menu_iconpath ) {
393     menu_iconpath = pnd_expand_tilde ( strdup ( menu_iconpath ) );
394     mkdir ( menu_iconpath, 0777 );
395   }
396
397   // done
398   return;
399 }
400
401 void setup_notifications ( void ) {
402   searchpath = notifypath;
403
404   // if this is first time through, we can just set it up; for subsequent times
405   // through, we need to close existing fd and re-open it, since we're too lame
406   // to store the list of watches and 'rm' them
407 #if 1
408   if ( nh ) {
409     pnd_notify_shutdown ( nh );
410     nh = 0;
411   }
412 #endif
413
414   // set up a new set of notifies
415   if ( ! nh ) {
416     nh = pnd_notify_init();
417   }
418
419   if ( ! nh ) {
420     pnd_log ( pndn_rem, "INOTIFY failed to init.\n" );
421     exit ( -1 );
422   }
423
424 #if 0
425   pnd_log ( pndn_rem, "INOTIFY is up.\n" );
426 #endif
427
428   SEARCHPATH_PRE
429   {
430
431     pnd_log ( pndn_rem, "Watching path '%s' and its descendents.\n", buffer );
432     pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
433
434   }
435   SEARCHPATH_POST
436
437   return;
438 }
439
440 void sighup_handler ( int n ) {
441
442   pnd_log ( pndn_rem, "---[ SIGHUP received ]---\n" );
443
444   // reparse config files
445   consume_configuration();
446
447   // re set up the notifier watches
448   setup_notifications();
449
450   return;
451 }
452
453 // This very recently was inline code; just slight refactor to functionize it so that it can be
454 // reused in a couple of places. Simple code with simple design quickly became too large for
455 // its simple design; should revisit a lot of these little things..
456 void process_discoveries ( pnd_box_handle applist, char *emitdesktoppath, char *emiticonpath ) {
457   pnd_disco_t *d = pnd_box_get_head ( applist );
458
459   while ( d ) {
460
461     pnd_log ( pndn_rem, "Found app: %s\n", pnd_box_get_key ( d ) );
462
463     // check if icon already exists (from a previous extraction say); if so, we needn't
464     // do it again
465     char existingpath [ FILENAME_MAX ];
466     sprintf ( existingpath, "%s/%s.png", emiticonpath, d -> unique_id );
467
468     struct stat dirs;
469     if ( stat ( existingpath, &dirs ) == 0 ) {
470       // icon seems to exist, so just crib the location into the .desktop
471
472       pnd_log ( pndn_rem, "  Found icon already existed, so reusing it! %s\n", existingpath );
473
474       if ( d -> icon ) {
475         free ( d -> icon );
476       }
477       d -> icon = strdup ( existingpath );
478
479     } else {
480       // icon seems unreadable or does not exist; lets try to create it..
481
482       pnd_log ( pndn_debug, "  Icon not already present, so trying to write it! %s\n", existingpath );
483
484       // attempt to create icon files; if successful, alter the disco struct to contain new
485       // path, otherwise leave it alone (since it could be a generic icon reference..)
486       if ( pnd_emit_icon ( emiticonpath, d ) ) {
487         // success; fix up icon path to new one..
488         if ( d -> icon ) {
489           free ( d -> icon );
490         }
491         d -> icon = strdup ( existingpath );
492       } else {
493         pnd_log ( pndn_debug, "  WARN: Couldn't write out icon %s\n", existingpath );
494       }
495
496     } // icon already exists?
497
498     // create the .desktop file
499     if ( pnd_emit_dotdesktop ( emitdesktoppath, pndrun, d ) ) {
500       // add a watch onto the newly created .desktop?
501 #if 0
502       char buffer [ FILENAME_MAX ];
503       sprintf ( buffer, "%s/%s", emitdesktoppath, d -> unique_id );
504       pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
505 #endif
506     } else {
507       pnd_log ( pndn_rem, "ERROR: Error creating .desktop file for app: %s\n", pnd_box_get_key ( d ) );
508     }
509
510     // next!
511     d = pnd_box_get_next ( d );
512
513   } // while applist
514
515   return;
516 }
517
518 // returns true if any applications were found
519 unsigned char perform_discoveries ( char *appspath, char *overridespath,              // args to do discovery
520                                     char *emitdesktoppath, char *emiticonpath )       // args to do emitting
521 {
522   pnd_box_handle applist;
523
524   // attempt to auto-discover applications in the given path
525   applist = pnd_disco_search ( appspath, overridespath );
526
527   if ( applist ) {
528     process_discoveries ( applist, emitdesktoppath, emiticonpath );
529   }
530
531   // run a clean up, to remove any dotdesktop files that we didn't
532   // just now create (that seem to have been created by pndnotifyd
533   // previously.) This allows SD eject (or .pnd remove) to remove
534   // an app from the launcher
535   //   NOTE: Could opendir and iterate across all .desktop files,
536   // removing any that have Source= something else, and that the
537   // app name is not in the list found in applist box above. But
538   // a cheesy simple way right now is to just remove .desktop files
539   // that have a last mod time prior to the time we stored above.
540   {
541     DIR *dir;
542
543     if ( ( dir = opendir ( emitdesktoppath ) ) ) {
544       struct dirent *dirent;
545       struct stat dirs;
546       char buffer [ FILENAME_MAX ];
547
548       while ( ( dirent = readdir ( dir ) ) ) {
549
550         // file is a .desktop?
551         if ( strstr ( dirent -> d_name, ".desktop" ) == NULL ) {
552           continue;
553         }
554
555         // figure out full path
556         sprintf ( buffer, "%s/%s", emitdesktoppath, dirent -> d_name );
557
558         // file was previously created by libpnd; check Source= line
559         // logic: default to 'yes' (in case we can't open the file for some reason)
560         //        if we can open the file, default to no and look for the source flag we added; if
561         //          that matches then we know its libpnd created, otherwise assume not.
562         unsigned char source_libpnd = 1;
563         {
564           char line [ 256 ];
565           FILE *grep = fopen ( buffer, "r" );
566           if ( grep ) {
567             source_libpnd = 0;
568             while ( fgets ( line, 255, grep ) ) {
569               if ( strcasestr ( line, PND_DOTDESKTOP_SOURCE ) ) {
570                 source_libpnd = 2;
571               }
572             } // while
573             fclose ( grep );
574           }
575         }
576         if ( source_libpnd ) {
577 #if 0
578           pnd_log ( pndn_rem,
579                     "File '%s' appears to have been created by libpnd so candidate for delete: %u\n", buffer, source_libpnd );
580 #endif
581         } else {
582 #if 0
583           pnd_log ( pndn_rem, "File '%s' appears NOT to have been created by libpnd, so leave it alone\n", buffer );
584 #endif
585           continue; // skip deleting it
586         }
587
588         // file is 'new'?
589         if ( stat ( buffer, &dirs ) == 0 ) {
590           if ( dirs.st_mtime >= createtime ) {
591 #if 0
592             pnd_log ( pndn_rem, "File '%s' seems 'new', so leave it alone.\n", buffer );
593 #endif
594             continue; // skip deleting it
595           }
596         }
597
598         // by this point, the .desktop file must be 'old' and created by pndnotifyd
599         // previously, so can remove it
600         pnd_log ( pndn_rem, "File '%s' seems nolonger relevent; removing it.\n", dirent -> d_name );
601         unlink ( buffer );
602
603       } // while getting filenames from dir
604
605       closedir ( dir );
606     }
607
608   } // purge old .desktop files
609
610   //WARN: MEMORY LEAK HERE
611   pnd_log ( pndn_debug, "pndnotifyd - memory leak here - perform_discoveries()\n" );
612   pnd_box_delete ( applist ); // does not free the disco_t contents!
613
614   return ( 1 );
615 }