New exec(disco-t) for more flexible pnd exec. PXML may specify appdata dirname, and...
[pandora-libraries.git] / lib / pnd_desktop.c
1
2 #include <stdio.h> /* for FILE etc */
3 #include <string.h>
4 #include <unistd.h> /* for unlink */
5 #include <stdlib.h> /* for free */
6
7 #include "pnd_apps.h"
8 #include "pnd_container.h"
9 #include "pnd_pxml.h"
10 #include "pnd_discovery.h"
11 #include "pnd_pndfiles.h"
12 #include "pnd_conf.h"
13 #include "pnd_desktop.h"
14 #include "pnd_logger.h"
15
16 unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t *p ) {
17   char filename [ FILENAME_MAX ];
18   char buffer [ 1024 ];
19   FILE *f;
20
21   // specification
22   // http://standards.freedesktop.org/desktop-entry-spec
23
24   // validation
25
26   if ( ! p -> unique_id ) {
27     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing unique-id\n", targetpath );
28     return ( 0 );
29   }
30
31   if ( ! p -> exec ) {
32     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing exec\n", targetpath );
33     return ( 0 );
34   }
35
36   if ( ! targetpath ) {
37     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing target path\n", targetpath );
38     return ( 0 );
39   }
40
41   if ( ! pndrun ) {
42     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing pnd_run.sh\n", targetpath );
43     return ( 0 );
44   }
45
46   // set up
47
48   sprintf ( filename, "%s/%s#%u.desktop", targetpath, p -> unique_id, p -> subapp_number );
49
50   // emit
51
52   //printf ( "EMIT DOTDESKTOP '%s'\n", filename );
53
54   f = fopen ( filename, "w" );
55
56   if ( ! f ) {
57     return ( 0 );
58   }
59
60   fprintf ( f, "%s\n", PND_DOTDESKTOP_HEADER );
61
62   if ( p -> title_en ) {
63     snprintf ( buffer, 1020, "Name=%s\n", p -> title_en );
64     fprintf ( f, "%s", buffer );
65   }
66
67   fprintf ( f, "Type=Application\n" );
68   fprintf ( f, "Version=1.0\n" );
69
70   if ( p -> icon ) {
71     snprintf ( buffer, 1020, "Icon=%s\n", p -> icon );
72     fprintf ( f, "%s", buffer );
73   }
74
75   if ( p -> unique_id ) {
76     fprintf ( f, "X-Pandora-UID=%s\n", p -> unique_id );
77   }
78
79 #if 1
80   if ( p -> desc_en && p -> desc_en [ 0 ] ) {
81     snprintf ( buffer, 1020, "Comment=%s\n", p -> desc_en ); // no [en] needed I suppose, yet
82     fprintf ( f, "%s", buffer );
83   }
84 #endif
85
86 #if 0 // we let pnd_run.sh command line handle this instead of in .desktop
87   if ( p -> startdir ) {
88     snprintf ( buffer, 1020, "Path=%s\n", p -> startdir );
89     fprintf ( f, "%s", buffer );
90   } else {
91     fprintf ( f, "Path=%s\n", PND_DEFAULT_WORKDIR );
92   }
93 #endif
94
95   if ( p -> exec ) {
96     char *nohup;
97
98     if ( p -> option_no_x11 ) {
99       nohup = "/usr/bin/nohup ";
100     } else {
101       nohup = "";
102     }
103
104     // basics
105     if ( p -> object_type == pnd_object_type_directory ) {
106       snprintf ( buffer, 1020, "Exec=%s%s -p %s -e %s -b %s",
107                  nohup, pndrun, p -> object_path, p -> exec,
108                  p -> appdata_dirname ? p -> appdata_dirname : p -> unique_id );
109     } else if ( p -> object_type == pnd_object_type_pnd ) {
110       snprintf ( buffer, 1020, "Exec=%s%s -p %s/%s -e %s -b %s",
111                  nohup, pndrun, p -> object_path, p -> object_filename, p -> exec,
112                  p -> appdata_dirname ? p -> appdata_dirname : p -> unique_id );
113     }
114
115     // start dir
116     if ( p -> startdir ) {
117       strncat ( buffer, " -s ", 1020 );
118       strncat ( buffer, p -> startdir, 1020 );
119     }
120
121     // args
122     if ( p -> execargs ) {
123       char argbuf [ 1024 ];
124       snprintf ( argbuf, 1000, " -a \"%s\"", p -> execargs );
125       strncat ( buffer, argbuf, 1020 );
126     }
127
128     // clockspeed
129     if ( p -> clockspeed && atoi ( p -> clockspeed ) != 0 ) {
130       strncat ( buffer, " -c ", 1020 );
131       strncat ( buffer, p -> clockspeed, 1020 );
132     }
133
134     // exec options
135     if ( pnd_pxml_get_x11 ( p -> option_no_x11 ) == pnd_pxml_x11_stop ) {
136       strncat ( buffer, " -x ", 1020 );
137     }
138
139     // newline
140     strncat ( buffer, "\n", 1020 );
141
142     // emit
143     fprintf ( f, "%s", buffer );
144   }
145
146   // categories
147   {
148     char cats [ 512 ] = "";
149     int n;
150     pnd_conf_handle c;
151     char *confpath;
152
153     // uuuuh, defaults?
154     // "Application" used to be in the standard and is commonly supported still
155     // Utility and Network should ensure the app is visible 'somewhere' :/
156     char *defaults = PND_DOTDESKTOP_DEFAULT_CATEGORY;
157
158     // determine searchpath (for conf, not for apps)
159     confpath = pnd_conf_query_searchpath();
160
161     // inhale the conf file
162     c = pnd_conf_fetch_by_id ( pnd_conf_categories, confpath );
163
164     // if we can find a default category set, pull it in; otherwise assume
165     // the hardcoded one
166     if ( pnd_conf_get_as_char ( c, "default" ) ) {
167       defaults = pnd_conf_get_as_char ( c, "default" );
168     }
169
170     // ditch the confpath
171     free ( confpath );
172
173     // attempt mapping
174     if ( c ) {
175
176       n = pnd_map_dotdesktop_categories ( c, cats, 511, p );
177
178       if ( n ) {
179         fprintf ( f, "Categories=%s\n", cats );
180       } else {
181         fprintf ( f, "Categories=%s\n", defaults );
182       }
183
184     } else {
185       fprintf ( f, "Categories=%s\n", defaults );
186     }
187
188   }
189
190   fprintf ( f, "%s\n", PND_DOTDESKTOP_SOURCE ); // should we need to know 'who' created the file during trimming
191
192   fclose ( f );
193
194   return ( 1 );
195 }
196
197 unsigned char pnd_emit_dotinfo ( char *targetpath, char *pndrun, pnd_disco_t *p ) {
198   char filename [ FILENAME_MAX ];
199   char buffer [ 1024 ];
200   FILE *f;
201   char *viewer, *searchpath;
202   pnd_conf_handle desktoph;
203
204   // specification
205   // http://standards.freedesktop.org/desktop-entry-spec
206
207   // validation
208   //
209
210   // viewer
211   searchpath = pnd_conf_query_searchpath();
212
213   desktoph = pnd_conf_fetch_by_id ( pnd_conf_desktop, searchpath );
214
215   if ( ! desktoph ) {
216     return ( 0 );
217   }
218
219   viewer = pnd_conf_get_as_char ( desktoph, "info.viewer" );
220
221   if ( ! viewer ) {
222     return ( 0 ); // no way to view the file
223   }
224
225   // etc
226   if ( ! p -> unique_id ) {
227     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing unique-id\n", targetpath );
228     return ( 0 );
229   }
230
231   if ( ! p -> info_filename ) {
232     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing info_filename\n", targetpath );
233     return ( 0 );
234   }
235
236   if ( ! p -> info_name ) {
237     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing info_name\n", targetpath );
238     return ( 0 );
239   }
240
241   if ( ! targetpath ) {
242     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing target path\n", targetpath );
243     return ( 0 );
244   }
245
246   if ( ! pndrun ) {
247     pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing pnd_run.sh\n", targetpath );
248     return ( 0 );
249   }
250
251   // set up
252
253   sprintf ( filename, "%s/%s#%uinfo.desktop", targetpath, p -> unique_id, p -> subapp_number );
254
255   // emit
256
257   f = fopen ( filename, "w" );
258
259   if ( ! f ) {
260     return ( 0 );
261   }
262
263   fprintf ( f, "%s\n", PND_DOTDESKTOP_HEADER );
264
265   if ( p -> info_name ) {
266     snprintf ( buffer, 1020, "Name=%s\n", p -> info_name );
267     fprintf ( f, "%s", buffer );
268   }
269
270   fprintf ( f, "Type=Application\n" );
271   fprintf ( f, "Version=1.0\n" );
272
273 #if 0
274   if ( p -> icon ) {
275     snprintf ( buffer, 1020, "Icon=%s\n", p -> icon );
276     fprintf ( f, "%s", buffer );
277   }
278 #endif
279
280   if ( p -> unique_id ) {
281     fprintf ( f, "X-Pandora-UID=%s\n", p -> unique_id );
282   }
283
284   if ( p -> title_en && p -> title_en [ 0 ] ) {
285     snprintf ( buffer, 1020, "Comment=Automatic menu info entry for %s\n", p -> title_en );
286     fprintf ( f, "%s", buffer );
287   }
288
289 #if 0 // we let pnd_run.sh command line handle this instead of in .desktop
290   if ( p -> startdir ) {
291     snprintf ( buffer, 1020, "Path=%s\n", p -> startdir );
292     fprintf ( f, "%s", buffer );
293   } else {
294     fprintf ( f, "Path=%s\n", PND_DEFAULT_WORKDIR );
295   }
296 #endif
297
298   // exec line
299   char args [ 1001 ];
300   char *pargs = args;
301   if ( pnd_conf_get_as_char ( desktoph, "info.viewer_args" ) ) {
302     snprintf ( pargs, 1001, "%s %s",
303                pnd_conf_get_as_char ( desktoph, "info.viewer_args" ), p -> info_filename );
304   } else {
305     pargs = NULL;
306   }
307
308   char pndfile [ 1024 ];
309   if ( p -> object_type == pnd_object_type_directory ) {
310     // for PXML-app-dir, pnd_run.sh doesn't want the PXML.xml.. it just wants the dir-name
311     strncpy ( pndfile, p -> object_path, 1000 );
312   } else if ( p -> object_type == pnd_object_type_pnd ) {
313     // pnd_run.sh wants the full path and filename for the .pnd file
314     snprintf ( pndfile, 1020, "%s/%s", p -> object_path, p -> object_filename );
315   }
316
317   if ( ! pnd_apps_exec ( pndrun, pndfile, p -> unique_id, viewer, p -> startdir, pargs,
318                          p -> clockspeed ? atoi ( p -> clockspeed ) : 0, PND_EXEC_OPTION_NORUN ) )
319   {
320     return ( 0 );
321   }
322
323   fprintf ( f, "Exec=%s\n", pnd_apps_exec_runline() );
324
325   if ( pnd_conf_get_as_char ( desktoph, "info.category" ) ) {
326     fprintf ( f, "Categories=%s\n", pnd_conf_get_as_char ( desktoph, "info.category" ) );
327   } else {
328     fprintf ( f, "Categories=Documentation\n" );
329   }
330
331   fprintf ( f, "%s\n", PND_DOTDESKTOP_SOURCE ); // should we need to know 'who' created the file during trimming
332
333   fclose ( f );
334
335   return ( 1 );
336 }
337
338 unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
339   //#define BITLEN (8*1024)
340 #define BITLEN (64*1024)
341   char buffer [ FILENAME_MAX ]; // target filename
342   char from [ FILENAME_MAX ];   // source filename
343   unsigned char bits [ BITLEN ];
344   unsigned int bitlen;
345   FILE *pnd, *target;
346
347   // prelim .. if a pnd file, and no offset found, discovery code didn't locate icon.. so bail.
348   if ( ( p -> object_type == pnd_object_type_pnd ) &&
349        ( ! p -> pnd_icon_pos ) )
350   {
351     return ( 0 ); // discover code didn't find it, so FAIL
352   }
353
354   // determine filename for target
355   sprintf ( buffer, "%s/%s.png", targetpath, p -> unique_id /*, p -> subapp_number*/ ); // target
356
357   /* first.. open the source file, by type of application:
358    * are we looking through a pnd file or a dir?
359    */
360   if ( p -> object_type == pnd_object_type_directory ) {
361     sprintf ( from, "%s/%s", p -> object_path, p -> icon );
362   } else if ( p -> object_type == pnd_object_type_pnd ) {
363     sprintf ( from, "%s/%s", p -> object_path, p -> object_filename );
364   }
365
366   pnd = fopen ( from, "rb" );
367
368   if ( ! pnd ) {
369     pnd_log ( PND_LOG_DEFAULT, "    Emit icon, couldn't open source\n" );
370     return ( 0 );
371   }
372
373   unsigned int len;
374
375   target = fopen ( buffer, "wb" );
376
377   if ( ! target ) {
378     fclose ( pnd );
379     pnd_log ( PND_LOG_DEFAULT, "    Emit icon, couldn't open target\n" );
380     return ( 0 );
381   }
382
383   fseek ( pnd, 0, SEEK_END );
384   len = ftell ( pnd );
385   //fseek ( pnd, 0, SEEK_SET );
386
387   fseek ( pnd, p -> pnd_icon_pos, SEEK_SET );
388
389   len -= p -> pnd_icon_pos;
390
391   pnd_log ( PND_LOG_DEFAULT, "    Emit icon, length: %u\n", len );
392
393   while ( len ) {
394
395     if ( len > (BITLEN) ) {
396       bitlen = (BITLEN);
397     } else {
398       bitlen = len;
399     }
400
401     if ( fread ( bits, bitlen, 1, pnd ) != 1 ) {
402       fclose ( pnd );
403       fclose ( target );
404       unlink ( buffer );
405       pnd_log ( PND_LOG_DEFAULT, "    Emit icon, bad read\n" );
406       return ( 0 );
407     }
408
409 #if 0
410     {
411       unsigned int i = 0;
412       char bigbuffer [ 200 * 1024 ] = "\0";
413       char b [ 10 ];
414       pnd_log ( PND_LOG_DEFAULT, "    Read hexdump\n" );
415       while ( i < bitlen ) {
416         sprintf ( b, "%x,", bits [ i ] );
417         strcat ( bigbuffer, b );
418         i++;
419       }
420       pnd_log ( PND_LOG_DEFAULT, bigbuffer );
421     }
422 #endif
423
424     if ( fwrite ( bits, bitlen, 1, target ) != 1 ) {
425       fclose ( pnd );
426       fclose ( target );
427       unlink ( buffer );
428       pnd_log ( PND_LOG_DEFAULT, "    Emit icon, bad write\n" );
429       return ( 0 );
430     }
431
432     len -= bitlen;
433     //pnd_log ( PND_LOG_DEFAULT, "    Emit icon, next block, length: %u\n", len );
434   } // while
435
436   fclose ( pnd );
437   fclose ( target );
438
439   //pnd_log ( PND_LOG_DEFAULT, "    Emit icon, done.\n" );
440
441   return ( 1 );
442 }
443
444 #if 1 // we switched direction to freedesktop standard categories
445 // if no categories herein, return 0; otherwise, if some category-like-text, return 1
446 int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_disco_t *d ) {
447   char *t;
448   char *match;
449
450   // clear target so we can easily append
451   memset ( target_buffer, '\0', len );
452
453   // for each main-cat and sub-cat, including alternates, just append them all together
454   // we'll try mapping them, since the categories file is there, but we'll default to
455   // copying over; this lets the conf file do merging or renaming of cagtegories, which
456   // could still be useful, but we can leave the conf file empty to effect a pure
457   // trusted-PXML-copying
458
459   // it would be sort of cumbersome to copy all the freedesktop.org defined categories (as
460   // there are hundreds), and would also mean new ones and peoples custom ones would
461   // flop
462
463   /* attempt primary category chain
464    */
465   #define MAPCAT(field)                                     \
466     if ( ( t = d -> field ) ) {                             \
467       match = pnd_map_dotdesktop_category ( c, t );         \
468       strncat ( target_buffer, match ? match : t, len );    \
469       strncat ( target_buffer, ";", len );                  \
470     }
471
472   MAPCAT(main_category);
473   MAPCAT(main_category1);
474   MAPCAT(main_category2);
475   MAPCAT(alt_category);
476   MAPCAT(alt_category1);
477   MAPCAT(alt_category2);
478
479   if ( target_buffer [ 0 ] ) {
480     return ( 1 ); // I guess its 'good'?
481   }
482
483 #if 0
484   if ( ( t = d -> main_category ) ) {
485     match = pnd_map_dotdesktop_category ( c, t );
486     strncat ( target_buffer, match ? match : t, len );
487     strncat ( target_buffer, ";", len );
488   }
489 #endif
490
491   return ( 0 );
492 }
493 #endif
494
495 #if 0 // we switched direction
496 //int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_pxml_handle h ) {
497 int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_disco_t *d ) {
498   unsigned short int n = 0; // no. matches
499   char *t;
500   char *match;
501
502   // clear target so we can easily append
503   memset ( target_buffer, '\0', len );
504
505   /* attempt primary category chain
506    */
507   match = NULL;
508
509   if ( ( t = d -> main_category ) ) {
510     match = pnd_map_dotdesktop_category ( c, t );
511   }
512
513   if ( ( ! match ) &&
514        ( t = d -> main_category1 ) )
515   {
516     match = pnd_map_dotdesktop_category ( c, t );
517   }
518
519   if ( ( ! match ) &&
520        ( t = d -> main_category2 ) )
521   {
522     match = pnd_map_dotdesktop_category ( c, t );
523   }
524   
525   if ( match ) {
526     strncat ( target_buffer, match, len );
527     len -= strlen ( target_buffer );
528     n += 1;
529   }
530
531   /* attempt secondary category chain
532    */
533   match = NULL;
534
535   if ( ( t = d -> alt_category ) ) {
536     match = pnd_map_dotdesktop_category ( c, t );
537   }
538
539   if ( ( ! match ) &&
540        ( t = d -> alt_category1 ) )
541   {
542     match = pnd_map_dotdesktop_category ( c, t );
543   }
544
545   if ( ( ! match ) &&
546        ( t = d -> alt_category2 ) )
547   {
548     match = pnd_map_dotdesktop_category ( c, t );
549   }
550   
551   if ( match ) {
552     if ( target_buffer [ 0 ] != '\0' && len > 0 ) {
553       strcat ( target_buffer, ";" );
554       len -= 1;
555     }
556     strncat ( target_buffer, match, len );
557     len -= strlen ( target_buffer );
558     n += 1;
559   }
560
561 #if 0 // doh, originally I was using pxml-t till I realized I pre-boned myself on that one
562   match = NULL;
563
564   if ( ( t = pnd_pxml_get_main_category ( h ) ) ) {
565     match = pnd_map_dotdesktop_category ( c, t );
566   }
567
568   if ( ( ! match ) &&
569        ( t = pnd_pxml_get_subcategory1 ( h ) ) )
570   {
571     match = pnd_map_dotdesktop_category ( c, t );
572   }
573
574   if ( ( ! match ) &&
575        ( t = pnd_pxml_get_subcategory2 ( h ) ) )
576   {
577     match = pnd_map_dotdesktop_category ( c, t );
578   }
579   
580   if ( match ) {
581     strncat ( target_buffer, match, len );
582     len -= strlen ( target_buffer );
583     n += 1;
584   }
585
586   /* attempt secondary category chain
587    */
588   match = NULL;
589
590   if ( ( t = pnd_pxml_get_altcategory ( h ) ) ) {
591     match = pnd_map_dotdesktop_category ( c, t );
592   }
593
594   if ( ( ! match ) &&
595        ( t = pnd_pxml_get_altsubcategory1 ( h ) ) )
596   {
597     match = pnd_map_dotdesktop_category ( c, t );
598   }
599
600   if ( ( ! match ) &&
601        ( t = pnd_pxml_get_altsubcategory2 ( h ) ) )
602   {
603     match = pnd_map_dotdesktop_category ( c, t );
604   }
605   
606   if ( match ) {
607     if ( target_buffer [ 0 ] != '\0' && len > 0 ) {
608       strcat ( target_buffer, ";" );
609       len -= 1;
610     }
611     strncat ( target_buffer, match, len );
612     len -= strlen ( target_buffer );
613     n += 1;
614   }
615 #endif
616
617   if ( n && len ) {
618     strcat ( target_buffer, ";" );
619   }
620
621   return ( n );
622 }
623 #endif
624
625 // given category 'foo', look it up in the provided config map. return the char* reference, or NULL
626 char *pnd_map_dotdesktop_category ( pnd_conf_handle c, char *single_category ) {
627   char *key;
628   char *ret;
629
630   key = malloc ( strlen ( single_category ) + 4 + 1 );
631
632   sprintf ( key, "map.%s", single_category );
633
634   ret = pnd_conf_get_as_char ( c, key );
635
636   free ( key );
637
638   return ( ret );
639 }
640
641 unsigned char *pnd_emit_icon_to_buffer ( pnd_disco_t *p, unsigned int *r_buflen ) {
642   // this is shamefully mostly a copy of emit_icon() above; really, need to refactor that to use this routine
643   // with a fwrite at the end...
644   char from [ FILENAME_MAX ];   // source filename
645   char bits [ 8 * 1024 ];
646   unsigned int bitlen;
647   FILE *pnd = NULL;
648   unsigned char *target = NULL, *targiter = NULL;
649
650   // prelim .. if a pnd file, and no offset found, discovery code didn't locate icon.. so bail.
651   if ( ( p -> object_type == pnd_object_type_pnd ) &&
652        ( ! p -> pnd_icon_pos ) )
653   {
654     return ( NULL ); // discover code didn't find it, so FAIL
655   }
656
657   /* first.. open the source file, by type of application:
658    * are we looking through a pnd file or a dir?
659    */
660   if ( p -> object_type == pnd_object_type_directory ) {
661     sprintf ( from, "%s/%s", p -> object_path, p -> icon );
662   } else if ( p -> object_type == pnd_object_type_pnd ) {
663     sprintf ( from, "%s/%s", p -> object_path, p -> object_filename );
664   }
665
666   pnd = fopen ( from, "r" );
667
668   if ( ! pnd ) {
669     return ( NULL );
670   }
671
672   // determine length of file, then adjust by icon position to find begin of icon
673   unsigned int len;
674
675   fseek ( pnd, 0, SEEK_END );
676   len = ftell ( pnd );
677   //fseek ( pnd, 0, SEEK_SET );
678
679   fseek ( pnd, p -> pnd_icon_pos, SEEK_SET );
680
681   len -= p -> pnd_icon_pos;
682
683   // create target buffer
684   target = malloc ( len );
685
686   if ( ! target ) {
687     fclose ( pnd );
688     return ( 0 );
689   }
690
691   targiter = target;
692
693   if ( r_buflen ) {
694     *r_buflen = len;
695   }
696
697   // copy over icon to target
698   while ( len ) {
699
700     if ( len > (8*1024) ) {
701       bitlen = (8*1024);
702     } else {
703       bitlen = len;
704     }
705
706     if ( fread ( bits, bitlen, 1, pnd ) != 1 ) {
707       fclose ( pnd );
708       free ( target );
709       return ( NULL );
710     }
711
712     memmove ( targiter, bits, bitlen );
713     targiter += bitlen;
714
715     len -= bitlen;
716   } // while
717
718   fclose ( pnd );
719
720   return ( target );
721 }