2 #include <stdio.h> /* for FILE etc */
3 #include <stdlib.h> /* for malloc */
4 #include <unistd.h> /* for unlink */
5 #include <limits.h> /* for PATH_MAX */
9 #define __USE_GNU /* for strcasestr */
10 #include <string.h> /* for making ftw.h happy */
12 #define _XOPEN_SOURCE 500
13 #define __USE_XOPEN_EXTENDED
15 #include <ftw.h> /* for nftw, tree walker */
17 #include "pnd_container.h"
19 #include "pnd_discovery.h"
20 #include "pnd_pathiter.h"
22 #include "pnd_pndfiles.h"
23 #include "pnd_logger.h"
26 // need these 'globals' due to the way nftw and ftw work :/
27 static pnd_box_handle disco_box;
28 static char *disco_overrides = NULL;
30 void pnd_disco_destroy ( pnd_disco_t *p ) {
31 if ( p -> package_id ) { free ( p -> package_id); }
32 if ( p -> title_en ) { free ( p -> title_en ); }
33 if ( p -> desc_en ) { free ( p -> desc_en ); }
34 if ( p -> unique_id ) { free ( p -> unique_id ); }
35 if ( p -> appdata_dirname ) { free ( p -> appdata_dirname ); }
36 if ( p -> icon ) { free ( p -> icon ); }
37 if ( p -> exec ) { free ( p -> exec ); }
38 if ( p -> execargs ) { free ( p -> execargs ); }
39 if ( p -> clockspeed ) { free ( p -> clockspeed ); }
40 if ( p -> startdir ) { free ( p -> startdir ); }
41 if ( p -> option_no_x11 ) { free ( p -> option_no_x11 ); }
42 if ( p -> main_category ) { free ( p -> main_category ); }
43 if ( p -> main_category1 ) { free ( p -> main_category1 ); }
44 if ( p -> main_category2 ) { free ( p -> main_category2 ); }
45 if ( p -> alt_category ) { free ( p -> alt_category ); }
46 if ( p -> alt_category1 ) { free ( p -> alt_category1 ); }
47 if ( p -> alt_category2 ) { free ( p -> alt_category2 ); }
48 if ( p -> object_filename ) { free ( p -> object_filename ); }
49 if ( p -> object_path ) { free ( p -> object_path ); }
50 if ( p -> mkdir_sp ) { free ( p -> mkdir_sp ); }
51 if ( p -> info_name ) { free ( p -> info_name ); }
52 if ( p -> info_type ) { free ( p -> info_type ); }
53 if ( p -> info_filename ) { free ( p -> info_filename ); }
54 if ( p -> preview_pic1 ) { free ( p -> preview_pic1 ); }
55 if ( p -> preview_pic2 ) { free ( p -> preview_pic2 ); }
56 if ( p -> version_major ) { free ( p -> version_major ); }
57 if ( p -> version_minor ) { free ( p -> version_minor ); }
58 if ( p -> version_release ) {free ( p -> version_release ); }
59 if ( p -> version_build ) { free ( p -> version_build ); }
60 if ( p -> package_version_major ) { free ( p -> package_version_major ); }
61 if ( p -> package_version_minor ) { free ( p -> package_version_minor ); }
62 if ( p -> package_version_release ) { free ( p -> package_version_release ); }
63 if ( p -> package_version_build ) { free ( p -> package_version_build ); }
64 if ( p -> associationitem1_name ) { free ( p -> associationitem1_name ); }
65 if ( p -> associationitem1_filetype ) { free ( p -> associationitem1_filetype ); }
66 if ( p -> exec_dashdash_args ) { free ( p -> exec_dashdash_args ); }
71 static int pnd_disco_callback ( const char *fpath, const struct stat *sb,
72 int typeflag, struct FTW *ftwbuf )
74 unsigned char valid = pnd_object_type_unknown;
75 pnd_pxml_handle pxmlh = 0;
76 pnd_pxml_handle *pxmlapps = NULL;
77 pnd_pxml_handle *pxmlappiter;
78 off_t pxml_close_pos = 0;
79 unsigned char logit = pnd_log_do_buried_logging();
82 pnd_log ( PND_LOG_DEFAULT, "disco callback encountered '%s'\n", fpath );
85 // PXML.xml is a possible application candidate (and not a dir named PXML.xml :)
86 if ( typeflag & FTW_D ) {
88 pnd_log ( PND_LOG_DEFAULT, " .. is dir, skipping\n" );
90 if ( ftwbuf -> level >= pathiter_depthlimit ) {
91 return ( FTW_SKIP_SUBTREE );
93 return ( FTW_CONTINUE ); // skip directories and other non-regular files
96 // PND/PNZ file and others may be valid as well .. but lets leave that for now
97 // printf ( "%s %s\n", fpath + ftwbuf -> base, PND_PACKAGE_FILEEXT );
98 if ( strcasecmp ( fpath + ftwbuf -> base, PXML_FILENAME ) == 0 ) {
99 valid = pnd_object_type_directory;
100 } else if ( strcasestr ( fpath + ftwbuf -> base, PND_PACKAGE_FILEEXT "\0" ) ) {
101 valid = pnd_object_type_pnd;
104 // if not a file of interest, just keep looking until we run out
107 pnd_log ( PND_LOG_DEFAULT, " .. bad filename, skipping\n" );
109 return ( FTW_CONTINUE );
112 // potentially a valid application
113 if ( valid == pnd_object_type_directory ) {
114 // Plaintext PXML file
115 //printf ( "PXML: disco callback encountered '%s'\n", fpath );
117 // pick up the PXML if we can
118 pxmlapps = pnd_pxml_fetch ( (char*) fpath );
120 } else if ( valid == pnd_object_type_pnd ) {
123 char pxmlbuf [ 32 * 1024 ]; // TBD: assuming 32k pxml accrual buffer is a little lame
125 //printf ( "PND: disco callback encountered '%s'\n", fpath );
127 // is this a valid .pnd file? The filename is a candidate already, but verify..
128 // .. presence of PXML appended, or at least contained within?
129 // .. presence of an icon appended after PXML?
132 f = fopen ( fpath, "r" );
134 // try to locate the PXML portion
135 if ( ! pnd_pnd_seek_pxml ( f ) ) {
137 return ( FTW_CONTINUE ); // pnd or not, but not to spec. Pwn'd the pnd?
140 // accrue it into a buffer
141 if ( ! pnd_pnd_accrue_pxml ( f, pxmlbuf, 32 * 1024 ) ) {
143 return ( FTW_CONTINUE );
146 //printf ( "buffer is %s\n", pxmlbuf );
150 // for convenience, lets skip along past trailing newlines/CR's in hopes of finding icon data?
152 char pngbuffer [ 16 ]; // \211 P N G \r \n \032 \n
153 pngbuffer [ 0 ] = 137; pngbuffer [ 1 ] = 80; pngbuffer [ 2 ] = 78; pngbuffer [ 3 ] = 71;
154 pngbuffer [ 4 ] = 13; pngbuffer [ 5 ] = 10; pngbuffer [ 6 ] = 26; pngbuffer [ 7 ] = 10;
156 unsigned char padtests = 20;
157 off_t padstart = ftello ( f );
159 // seek back 10 (should be back into the /PXML> part) to catch any appending-icon-no-line-endings funny business
160 fseek ( f, -10, SEEK_CUR );
164 if ( fread ( pngbuffer + 8, 8, 1, f ) == 1 ) {
165 if ( memcmp ( pngbuffer, pngbuffer + 8, 8 ) == 0 ) {
166 pxml_close_pos = ftello ( f ) - 8;
169 fseek ( f, -7, SEEK_CUR ); // seek back 7 (so we're 1 further than we started, since PNG header is 8b)
176 // no icon found, so back to where we started looking
177 fseeko ( f, padstart, SEEK_SET );
183 // by now, we have <PXML> .. </PXML>, try to parse..
184 pxmlapps = pnd_pxml_fetch_buffer ( (char*) fpath, pxmlbuf );
193 return ( FTW_CONTINUE ); // continue tree walk
197 char ovrfile [ PATH_MAX ];
198 pnd_box_handle ovrh = 0; // 0 didn't try, -1 tried and failed, >0 tried and got
200 // iterate across apps in the PXML
201 pxmlappiter = pxmlapps;
203 pxmlh = *pxmlappiter;
210 // check for validity and add to resultset if it looks executable
211 if ( pnd_is_pxml_valid_app ( pxmlh ) ) {
216 //pnd_log ( PND_LOG_DEFAULT, "Setting up discovered app %u\n", ((pnd_pxml_t*) pxmlh) -> subapp_number );
218 p = pnd_box_allocinsert ( disco_box, (char*) fpath, sizeof(pnd_disco_t) );
221 p -> object_path = strdup ( fpath );
223 if ( ( fixpxml = strcasestr ( p -> object_path, PXML_FILENAME ) ) ) {
224 *fixpxml = '\0'; // if this is not a .pnd, lop off the PXML.xml at the end
225 } else if ( ( fixpxml = strrchr ( p -> object_path, '/' ) ) ) {
226 *(fixpxml+1) = '\0'; // for pnd, lop off to last /
229 if ( ( fixpxml = strrchr ( fpath, '/' ) ) ) {
230 p -> object_filename = strdup ( fixpxml + 1 );
234 p -> subapp_number = ((pnd_pxml_t*) pxmlh) -> subapp_number;
237 p -> pnd_icon_pos64 = pxml_close_pos;
238 p -> pnd_icon_pos = pxml_close_pos;
239 if ( (off_t) p -> pnd_icon_pos != pxml_close_pos ) {
240 // pnd_icon_pos is an int and the offset doesn't fit, bad luck...
241 p -> pnd_icon_pos = 0;
245 p -> object_type = valid;
248 if ( pnd_pxml_get_package_id ( pxmlh ) ) {
249 p -> package_id = strdup ( pnd_pxml_get_package_id ( pxmlh ) );
251 char *name_en = pnd_pxml_get_app_name_en ( pxmlh );
253 p -> title_en = name_en; /* already strdupped */
255 char *desc_en = pnd_pxml_get_description_en ( pxmlh );
257 p -> desc_en = desc_en; /* already strdupped */
259 if ( pnd_pxml_get_icon ( pxmlh ) ) {
260 p -> icon = strdup ( pnd_pxml_get_icon ( pxmlh ) );
262 if ( pnd_pxml_get_exec ( pxmlh ) ) {
263 p -> exec = strdup ( pnd_pxml_get_exec ( pxmlh ) );
265 if ( pnd_pxml_get_execargs ( pxmlh ) ) {
266 p -> execargs = strdup ( pnd_pxml_get_execargs ( pxmlh ) );
268 if ( pnd_pxml_get_exec_option_no_x11 ( pxmlh ) ) {
269 p -> option_no_x11 = strdup ( pnd_pxml_get_exec_option_no_x11 ( pxmlh ) );
271 if ( pnd_pxml_get_unique_id ( pxmlh ) ) {
272 p -> unique_id = strdup ( pnd_pxml_get_unique_id ( pxmlh ) );
274 if ( pnd_pxml_get_appdata_dirname ( pxmlh ) ) {
275 p -> appdata_dirname = strdup ( pnd_pxml_get_appdata_dirname ( pxmlh ) );
277 if ( pnd_pxml_get_clockspeed ( pxmlh ) ) {
278 p -> clockspeed = strdup ( pnd_pxml_get_clockspeed ( pxmlh ) );
280 if ( pnd_pxml_get_startdir ( pxmlh ) ) {
281 p -> startdir = strdup ( pnd_pxml_get_startdir ( pxmlh ) );
284 if ( pnd_pxml_get_main_category ( pxmlh ) ) {
285 p -> main_category = strdup ( pnd_pxml_get_main_category ( pxmlh ) );
287 if ( pnd_pxml_get_subcategory1 ( pxmlh ) ) {
288 p -> main_category1 = strdup ( pnd_pxml_get_subcategory1 ( pxmlh ) );
290 if ( pnd_pxml_get_subcategory2 ( pxmlh ) ) {
291 p -> main_category2 = strdup ( pnd_pxml_get_subcategory2 ( pxmlh ) );
293 if ( pnd_pxml_get_altcategory ( pxmlh ) ) {
294 p -> alt_category = strdup ( pnd_pxml_get_altcategory ( pxmlh ) );
296 if ( pnd_pxml_get_altsubcategory1 ( pxmlh ) ) {
297 p -> alt_category1 = strdup ( pnd_pxml_get_altsubcategory1 ( pxmlh ) );
299 if ( pnd_pxml_get_altsubcategory2 ( pxmlh ) ) {
300 p -> alt_category2 = strdup ( pnd_pxml_get_altsubcategory2 ( pxmlh ) );
303 if ( ( z = pnd_pxml_get_previewpic1 ( pxmlh ) ) ) {
304 p -> preview_pic1 = strdup ( z );
306 if ( ( z = pnd_pxml_get_previewpic2 ( pxmlh ) ) ) {
307 p -> preview_pic2 = strdup ( z );
310 if ( pnd_pxml_get_mkdir ( pxmlh ) ) {
311 p -> mkdir_sp = strdup ( pnd_pxml_get_mkdir ( pxmlh ) );
314 if ( pnd_pxml_get_info_src ( pxmlh ) ) {
315 p -> info_filename = strdup ( pnd_pxml_get_info_src ( pxmlh ) );
317 if ( pnd_pxml_get_info_name ( pxmlh ) ) {
318 p -> info_name = strdup ( pnd_pxml_get_info_name ( pxmlh ) );
320 if ( pnd_pxml_get_info_type ( pxmlh ) ) {
321 p -> info_type = strdup ( pnd_pxml_get_info_type ( pxmlh ) );
323 if ( pnd_pxml_get_version_major ( pxmlh ) ) {
324 p -> version_major = strdup ( pnd_pxml_get_version_major ( pxmlh ) );
326 if ( pnd_pxml_get_version_minor ( pxmlh ) ) {
327 p -> version_minor = strdup ( pnd_pxml_get_version_minor ( pxmlh ) );
329 if ( pnd_pxml_get_version_release ( pxmlh ) ) {
330 p -> version_release = strdup ( pnd_pxml_get_version_release ( pxmlh ) );
332 if ( pnd_pxml_get_version_build ( pxmlh ) ) {
333 p -> version_build = strdup ( pnd_pxml_get_version_build ( pxmlh ) );
335 if ( pnd_pxml_get_package_version_major ( pxmlh ) ) {
336 p -> package_version_major = strdup ( pnd_pxml_get_package_version_major ( pxmlh ) );
338 if ( pnd_pxml_get_package_version_minor ( pxmlh ) ) {
339 p -> package_version_minor = strdup ( pnd_pxml_get_package_version_minor ( pxmlh ) );
341 if ( pnd_pxml_get_package_version_release ( pxmlh ) ) {
342 p -> package_version_release = strdup ( pnd_pxml_get_package_version_release ( pxmlh ) );
344 if ( pnd_pxml_get_package_version_build ( pxmlh ) ) {
345 p -> package_version_build = strdup ( pnd_pxml_get_package_version_build ( pxmlh ) );
349 if ( pnd_pxml_get_associationitem1_name ( pxmlh ) ) {
350 p -> associationitem1_name = strdup ( pnd_pxml_get_associationitem1_name ( pxmlh ) );
351 p -> associationitem1_filetype = strdup ( pnd_pxml_get_associationitem1_filetype ( pxmlh ) );
352 //pnd_log ( PND_LOG_DEFAULT, " Disco: Found file association request in PXML (%s)\n", p -> title_en );
355 if ( pnd_pxml_get_execdashdashargs ( pxmlh ) ) {
356 p -> exec_dashdash_args = strdup ( pnd_pxml_get_execdashdashargs ( pxmlh ) );
359 // look for any PXML overrides, if requested
360 if ( disco_overrides ) {
361 pnd_pxml_merge_override ( pxmlh, disco_overrides );
364 // handle ovr overrides
365 // try to load a same-path-as-pnd override file
367 sprintf ( ovrfile, "%s/%s", p -> object_path, p -> object_filename );
368 fixpxml = strcasestr ( ovrfile, PND_PACKAGE_FILEEXT );
370 strcpy ( fixpxml, PXML_SAMEPATH_OVERRIDE_FILEEXT );
372 if ( stat ( ovrfile, &statbuf ) == 0 ) {
373 ovrh = pnd_conf_fetch_by_path ( ovrfile );
376 // couldn't pull conf out of file, so don't try again
381 ovrh = (void*)(-1); // not found, don't try again
387 if ( ovrh != 0 && ovrh != (void*)(-1) ) {
388 // pull in appropriate values
392 // set the flag regardless, so its for all subapps
393 p -> object_flags |= PND_DISCO_FLAG_OVR;
396 snprintf ( key, 100, "Application-%u.title", p -> subapp_number );
397 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
398 if ( p -> title_en ) {
399 free ( p -> title_en );
401 p -> title_en = strdup ( v );
405 snprintf ( key, 100, "Application-%u.clockspeed", p -> subapp_number );
406 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
407 if ( p -> clockspeed ) {
408 free ( p -> clockspeed );
410 p -> clockspeed = strdup ( v );
414 snprintf ( key, 100, "Application-%u.appdata", p -> subapp_number );
415 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
416 if ( p -> appdata_dirname ) {
417 free ( p -> appdata_dirname );
419 p -> appdata_dirname = strdup ( v );
423 snprintf ( key, 100, "Application-%u.maincategory", p -> subapp_number );
424 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
425 if ( p -> main_category ) {
426 free ( p -> main_category );
428 // the override file cannot suppress the main category
429 p -> main_category = strdup ( v );
431 snprintf ( key, 100, "Application-%u.maincategorysub1", p -> subapp_number );
432 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
433 if ( p -> main_category1 ) {
434 free ( p -> main_category1 );
435 p -> main_category1 = NULL;
437 if ( strcasecmp ( v, "NoSubcategory" ) != 0 ) {
438 p -> main_category1 = strdup ( v );
441 snprintf ( key, 100, "Application-%u.maincategorysub2", p -> subapp_number );
442 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
443 if ( p -> main_category2 ) {
444 free ( p -> main_category2 );
445 p -> main_category2 = NULL;
447 if ( strcasecmp ( v, "NoSubcategory" ) != 0 ) {
448 p -> main_category2 = strdup ( v );
452 snprintf ( key, 100, "Application-%u.altcategory", p -> subapp_number );
453 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
454 if ( p -> alt_category ) {
455 free ( p -> alt_category );
456 p -> alt_category = NULL;
458 // but it makes sense to allow full suppression of the alternate category
459 if ( strcasecmp ( v, "NoCategory" ) != 0 ) {
460 p -> alt_category = strdup ( v );
463 snprintf ( key, 100, "Application-%u.altcategorysub1", p -> subapp_number );
464 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
465 if ( p -> alt_category1 ) {
466 free ( p -> alt_category1 );
467 p -> alt_category1 = NULL;
469 if ( strcasecmp ( v, "NoSubcategory" ) != 0 ) {
470 p -> alt_category1 = strdup ( v );
473 snprintf ( key, 100, "Application-%u.altcategorysub2", p -> subapp_number );
474 if ( ( v = pnd_conf_get_as_char ( ovrh, key ) ) ) {
475 if ( p -> alt_category2 ) {
476 free ( p -> alt_category2 );
477 p -> alt_category2 = NULL;
479 if ( strcasecmp ( v, "NoSubcategory" ) != 0 ) {
480 p -> alt_category2 = strdup ( v );
484 } // got ovr conf loaded?
487 //printf ( "Invalid PXML; skipping.\n" );
491 pnd_pxml_delete ( pxmlh );
493 } // while pxmlh is good
496 if ( ovrh != 0 && ovrh != (void*)(-1) ) {
497 pnd_box_delete ( ovrh );
500 // free up the applist
503 return ( FTW_CONTINUE ); // continue the tree walk
506 pnd_box_handle pnd_disco_search ( char *searchpath, char *overridespath ) {
508 //printf ( "Searchpath to discover: '%s'\n", searchpath );
510 // alloc a container for the result set
511 disco_box = pnd_box_new ( "discovery" );
512 disco_overrides = overridespath;
514 /* iterate across the paths within the searchpath, attempting to locate applications
520 // invoke the dir walking function; thankfully Linux includes a pretty good one
521 nftw ( buffer, // path to descend
522 pnd_disco_callback, // callback to do processing
523 10, // no more than X open fd's at once
524 FTW_PHYS | FTW_ACTIONRETVAL ); // do not follow symlinks
529 // return whatever we found, or NULL if nada
530 if ( ! pnd_box_get_head ( disco_box ) ) {
531 pnd_box_delete ( disco_box );
535 return ( disco_box );
538 pnd_box_handle pnd_disco_file ( char *path, char *filename ) {
542 disco_overrides = NULL;
543 disco_box = pnd_box_new ( "discovery" );
546 char fullpath [ PATH_MAX ];
547 sprintf ( fullpath, "%s/%s", path, filename );
550 if ( stat ( fullpath, &statbuf ) < 0 ) {
555 ftw.base = strlen ( path );
558 pnd_disco_callback ( fullpath, &statbuf, FTW_F, &ftw );
560 // return whatever we found, or NULL if nada
561 if ( ! pnd_box_get_head ( disco_box ) ) {
562 pnd_box_delete ( disco_box );
566 return ( disco_box );