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
7 #include <stdio.h> // for stdio
8 #include <unistd.h> // for exit()
9 #include <stdlib.h> // for exit()
10 #define __USE_GNU /* for strcasestr */
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
20 #include "pnd_container.h"
22 #include "pnd_notify.h"
23 #include "../lib/pnd_pathiter.h"
24 #include "pnd_discovery.h"
25 #include "pnd_locate.h"
27 #include "pnd_utility.h"
28 #include "pnd_desktop.h"
29 #include "pnd_logger.h"
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..
34 // op mode; emitting stdout or no?
35 static unsigned char g_daemon_mode = 0;
39 pndn_rem, // will set default log level to here, so 'debug' is omitted
43 } pndnotify_loglevels_e;
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;
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
65 pnd_notify_handle nh = 0;
68 #define PNDNOTIFYD_LOGLEVEL "pndnotifyd.loglevel"
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 );
78 int main ( int argc, char *argv[] ) {
80 unsigned char scanonlaunch = 1;
81 unsigned int interval_secs = 5;
85 /* iterate across args
87 for ( i = 1; i < argc; i++ ) {
89 if ( argv [ i ][ 0 ] == '-' && argv [ i ][ 1 ] == 'd' ) {
90 //printf ( "Going daemon mode. Silent running.\n" );
92 } else if ( isdigit ( argv [ i ][ 0 ] ) ) {
93 interval_secs = atoi ( argv [ i ] );
94 } else if ( argv [ i ][ 0 ] == '-' && argv [ i ][ 1 ] == 'n' ) {
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",
102 printf ( "Signal: HUP the process to force reload of configuration and reset the notifier watch paths\n" );
110 if ( g_daemon_mode ) {
113 pnd_log_set_filter ( pndn_rem );
114 pnd_log_set_pretext ( "pndnotifyd" );
116 pnd_log ( pndn_rem, "log level starting as %u", pnd_log_get_filter() );
119 pnd_log ( pndn_rem, "Interval between checks is %u seconds\n", interval_secs );
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" );
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" );
129 pnd_log ( pndn_rem, "INOTIFY seems to be useful, whew.\n" );
131 // basic daemon set up
132 if ( g_daemon_mode ) {
134 // set a CWD somewhere else
139 // detach from terminal
140 if ( ( i = fork() ) < 0 ) {
141 pnd_log ( pndn_error, "ERROR: Couldn't fork()\n" );
145 exit ( 0 ); // exit parent
150 umask ( 022 ); // emitted files can be rwxr-xr-x
157 consume_configuration();
162 pnd_log ( pndn_rem, "PXML overrides searchpath is '%s'\n", overridespath );
163 pnd_log ( pndn_rem, "Notify searchpath is '%s'\n", notifypath );
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 );
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 );
175 /* set up signal handler
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 */
185 sigaction ( SIGHUP, &siggy, NULL );
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();
200 // need to rediscover?
202 pnd_notify_rediscover_p ( nh ) )
204 createtime = time ( NULL ); // all 'new' .destops are created at or after this time; prev are old.
206 // if this was a forced scan, lets not do that next iteration
207 if ( scanonlaunch ) {
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" );
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" );
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" );
232 // if we've got a hup script located, lets invoke it
234 pnd_log ( pndn_rem, "Invoking hup script '%s'.\n", pndhup );
235 pnd_exec_no_wait_1 ( pndhup, NULL );
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();
243 } // need to rediscover?
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 );
258 pnd_notify_shutdown ( nh );
263 void consume_configuration ( void ) {
265 // attempt to fetch a sensible default searchpath for configs
266 configpath = pnd_conf_query_searchpath();
268 // attempt to fetch the apps config to pick up a searchpath
269 pnd_conf_handle apph;
271 apph = pnd_conf_fetch_by_id ( pnd_conf_apps, configpath );
275 overridespath = pnd_conf_get_as_char ( apph, PND_PXML_OVERRIDE_KEY );
277 if ( ! overridespath ) {
278 overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
281 notifypath = pnd_conf_get_as_char ( apph, PND_APPS_NOTIFY_KEY );
283 if ( ! notifypath ) {
284 notifypath = PND_APPS_NOTIFYPATH;
288 // couldn't find a useful app search path so use the default
289 overridespath = PND_PXML_OVERRIDE_SEARCHPATH;
290 notifypath = PND_APPS_NOTIFYPATH;
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
298 pnd_conf_handle desktoph;
300 desktoph = pnd_conf_fetch_by_id ( pnd_conf_desktop, configpath );
302 // for 'desktop' main applications
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 );
309 if ( ! desktop_dotdesktoppath ) {
310 desktop_dotdesktoppath = PND_DESKTOP_DOTDESKTOP_PATH_DEFAULT;
313 if ( ! desktop_iconpath ) {
314 desktop_iconpath = PND_DESKTOP_ICONS_PATH_DEFAULT;
317 if ( ! desktop_appspath ) {
318 desktop_appspath = PND_DESKTOP_SEARCH_PATH_DEFAULT;
321 // for 'menu' applications
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 );
328 /* try to locate a runscript and optional hupscript
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 );
336 if ( ! run_searchpath ) {
337 run_searchpath = PND_APPS_SEARCHPATH;
338 run_script = PND_PNDRUN_FILENAME;
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() );
347 run_searchpath = NULL;
349 pndrun = PND_PNDRUN_DEFAULT;
353 pndrun = pnd_locate_filename ( run_searchpath, run_script );
356 pndrun = strdup ( pndrun ); // so we don't just use the built in buffer; next locate will overwrite it
358 pndrun = PND_PNDRUN_DEFAULT;
363 if ( desktoph && run_searchpath ) {
366 if ( ( t = pnd_conf_get_as_char ( desktoph, PND_PNDHUP_KEY ) ) ) {
367 pndhup = pnd_locate_filename ( run_searchpath, t );
370 pndhup = strdup ( pndhup ); // so we don't just use the built in buffer; next locate will overwrite it
373 #if 0 // don't enable this; if no key in config, we don't want to bother hupping
375 pndhup = pnd_locate_filename ( run_searchpath, PND_PNDHUP_FILENAME );
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 );
386 pnd_log ( pndn_rem, "pndhup is %s\n", pndhup );
388 pnd_log ( pndn_rem, "No pndhup found (which is fine.)\n" );
391 /* handle globbing or variable substitution
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 );
398 if ( menu_dotdesktoppath ) {
399 menu_dotdesktoppath = pnd_expand_tilde ( strdup ( menu_dotdesktoppath ) );
400 mkdir ( menu_dotdesktoppath, 0777 );
402 if ( menu_iconpath ) {
403 menu_iconpath = pnd_expand_tilde ( strdup ( menu_iconpath ) );
404 mkdir ( menu_iconpath, 0777 );
411 void setup_notifications ( void ) {
412 searchpath = notifypath;
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
419 pnd_notify_shutdown ( nh );
424 // set up a new set of notifies
426 nh = pnd_notify_init();
430 pnd_log ( pndn_rem, "INOTIFY failed to init.\n" );
435 pnd_log ( pndn_rem, "INOTIFY is up.\n" );
441 pnd_log ( pndn_rem, "Watching path '%s' and its descendents.\n", buffer );
442 pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
450 void sighup_handler ( int n ) {
452 pnd_log ( pndn_rem, "---[ SIGHUP received ]---\n" );
454 // reparse config files
455 consume_configuration();
457 // re set up the notifier watches
458 setup_notifications();
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 );
471 pnd_log ( pndn_rem, "Found app: %s\n", pnd_box_get_key ( d ) );
473 // check if icon already exists (from a previous extraction say); if so, we needn't
475 char existingpath [ FILENAME_MAX ];
476 sprintf ( existingpath, "%s/%s.png", emiticonpath, d -> unique_id );
479 if ( stat ( existingpath, &dirs ) == 0 ) {
480 // icon seems to exist, so just crib the location into the .desktop
482 pnd_log ( pndn_rem, " Found icon already existed, so reusing it! %s\n", existingpath );
487 d -> icon = strdup ( existingpath );
490 // icon seems unreadable or does not exist; lets try to create it..
492 pnd_log ( pndn_debug, " Icon not already present, so trying to write it! %s\n", existingpath );
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..
501 d -> icon = strdup ( existingpath );
503 pnd_log ( pndn_debug, " WARN: Couldn't write out icon %s\n", existingpath );
506 } // icon already exists?
508 // create the .desktop file
509 if ( pnd_emit_dotdesktop ( emitdesktoppath, pndrun, d ) ) {
510 // add a watch onto the newly created .desktop?
512 char buffer [ FILENAME_MAX ];
513 sprintf ( buffer, "%s/%s", emitdesktoppath, d -> unique_id );
514 pnd_notify_watch_path ( nh, buffer, PND_NOTIFY_RECURSE );
517 pnd_log ( pndn_rem, "ERROR: Error creating .desktop file for app: %s\n", pnd_box_get_key ( d ) );
521 d = pnd_box_get_next ( d );
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
532 pnd_box_handle applist;
534 // attempt to auto-discover applications in the given path
535 applist = pnd_disco_search ( appspath, overridespath );
538 process_discoveries ( applist, emitdesktoppath, emiticonpath );
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.
553 if ( ( dir = opendir ( emitdesktoppath ) ) ) {
554 struct dirent *dirent;
556 char buffer [ FILENAME_MAX ];
558 while ( ( dirent = readdir ( dir ) ) ) {
560 // file is a .desktop?
561 if ( strstr ( dirent -> d_name, ".desktop" ) == NULL ) {
565 // figure out full path
566 sprintf ( buffer, "%s/%s", emitdesktoppath, dirent -> d_name );
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;
575 FILE *grep = fopen ( buffer, "r" );
578 while ( fgets ( line, 255, grep ) ) {
579 if ( strcasestr ( line, PND_DOTDESKTOP_SOURCE ) ) {
586 if ( source_libpnd ) {
589 "File '%s' appears to have been created by libpnd so candidate for delete: %u\n", buffer, source_libpnd );
593 pnd_log ( pndn_rem, "File '%s' appears NOT to have been created by libpnd, so leave it alone\n", buffer );
595 continue; // skip deleting it
599 if ( stat ( buffer, &dirs ) == 0 ) {
600 if ( dirs.st_mtime >= createtime ) {
602 pnd_log ( pndn_rem, "File '%s' seems 'new', so leave it alone.\n", buffer );
604 continue; // skip deleting it
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 );
613 } // while getting filenames from dir
618 } // purge old .desktop files
620 //WARN: MEMORY LEAK HERE
621 pnd_log ( pndn_debug, "pndnotifyd - memory leak here - perform_discoveries()\n" );
623 pnd_box_delete ( applist ); // does not free the disco_t contents!