Large change, to support multiple applications within a single PXML.xml file.
[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 handle this
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, p -> unique_id );
108     } else if ( p -> object_type == pnd_object_type_pnd ) {
109       snprintf ( buffer, 1020, "Exec=%s%s -p %s/%s -e %s -b %s",
110                  nohup, pndrun, p -> object_path, p -> object_filename, p -> exec, p -> unique_id );
111     }
112
113     // start dir
114     if ( p -> startdir ) {
115       strncat ( buffer, " -s ", 1020 );
116       strncat ( buffer, p -> startdir, 1020 );
117     }
118
119     // clockspeed
120     if ( p -> clockspeed && atoi ( p -> clockspeed ) != 0 ) {
121       strncat ( buffer, " -c ", 1020 );
122       strncat ( buffer, p -> clockspeed, 1020 );
123     }
124
125     // exec options
126     if ( pnd_pxml_is_affirmative ( p -> option_no_x11 ) ) {
127       strncat ( buffer, " -x ", 1020 );
128     }
129
130     // newline
131     strncat ( buffer, "\n", 1020 );
132
133     // emit
134     fprintf ( f, "%s", buffer );
135   }
136
137   // categories
138   {
139     char cats [ 512 ] = "";
140     int n;
141     pnd_conf_handle c;
142     char *confpath;
143
144     // uuuuh, defaults?
145     // "Application" used to be in the standard and is commonly supported still
146     // Utility and Network should ensure the app is visible 'somewhere' :/
147     char *defaults = PND_DOTDESKTOP_DEFAULT_CATEGORY;
148
149     // determine searchpath (for conf, not for apps)
150     confpath = pnd_conf_query_searchpath();
151
152     // inhale the conf file
153     c = pnd_conf_fetch_by_id ( pnd_conf_categories, confpath );
154
155     // if we can find a default category set, pull it in; otherwise assume
156     // the hardcoded one
157     if ( pnd_conf_get_as_char ( c, "default" ) ) {
158       defaults = pnd_conf_get_as_char ( c, "default" );
159     }
160
161     // ditch the confpath
162     free ( confpath );
163
164     // attempt mapping
165     if ( c ) {
166
167       n = pnd_map_dotdesktop_categories ( c, cats, 511, p );
168
169       if ( n ) {
170         fprintf ( f, "Categories=%s\n", cats );
171       } else {
172         fprintf ( f, "Categories=%s\n", defaults );
173       }
174
175     } else {
176       fprintf ( f, "Categories=%s\n", defaults );
177     }
178
179   }
180
181   fprintf ( f, "%s\n", PND_DOTDESKTOP_SOURCE ); // should we need to know 'who' created the file during trimming
182
183   fclose ( f );
184
185   return ( 1 );
186 }
187
188 unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
189   char buffer [ FILENAME_MAX ]; // target filename
190   char from [ FILENAME_MAX ];   // source filename
191   char bits [ 8 * 1024 ];
192   unsigned int bitlen;
193   FILE *pnd, *target;
194
195   // prelim .. if a pnd file, and no offset found, discovery code didn't locate icon.. so bail.
196   if ( ( p -> object_type == pnd_object_type_pnd ) &&
197        ( ! p -> pnd_icon_pos ) )
198   {
199     return ( 0 ); // discover code didn't find it, so FAIL
200   }
201
202   // determine filename for target
203   sprintf ( buffer, "%s/%s#%u.png", targetpath, p -> unique_id, p -> subapp_number ); // target
204
205   /* first.. open the source file, by type of application:
206    * are we looking through a pnd file or a dir?
207    */
208   if ( p -> object_type == pnd_object_type_directory ) {
209     sprintf ( from, "%s/%s", p -> object_path, p -> icon );
210   } else if ( p -> object_type == pnd_object_type_pnd ) {
211     sprintf ( from, "%s/%s", p -> object_path, p -> object_filename );
212   }
213
214   pnd = fopen ( from, "r" );
215
216   if ( ! pnd ) {
217     return ( 0 );
218   }
219
220   unsigned int len;
221
222   target = fopen ( buffer, "wb" );
223
224   if ( ! target ) {
225     fclose ( pnd );
226     return ( 0 );
227   }
228
229   fseek ( pnd, 0, SEEK_END );
230   len = ftell ( pnd );
231   //fseek ( pnd, 0, SEEK_SET );
232
233   fseek ( pnd, p -> pnd_icon_pos, SEEK_SET );
234
235   len -= p -> pnd_icon_pos;
236
237   while ( len ) {
238
239     if ( len > (8*1024) ) {
240       bitlen = (8*1024);
241     } else {
242       bitlen = len;
243     }
244
245     if ( fread ( bits, bitlen, 1, pnd ) != 1 ) {
246       fclose ( pnd );
247       fclose ( target );
248       unlink ( buffer );
249       return ( 0 );
250     }
251
252     if ( fwrite ( bits, bitlen, 1, target ) != 1 ) {
253       fclose ( pnd );
254       fclose ( target );
255       unlink ( buffer );
256       return ( 0 );
257     }
258
259     len -= bitlen;
260   } // while
261
262   fclose ( pnd );
263   fclose ( target );
264
265   return ( 1 );
266 }
267
268 #if 1 // we switched direction to freedesktop standard categories
269 // if no categories herein, return 0; otherwise, if some category-like-text, return 1
270 int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_disco_t *d ) {
271   char *t;
272   char *match;
273
274   // clear target so we can easily append
275   memset ( target_buffer, '\0', len );
276
277   // for each main-cat and sub-cat, including alternates, just append them all together
278   // we'll try mapping them, since the categories file is there, but we'll default to
279   // copying over; this lets the conf file do merging or renaming of cagtegories, which
280   // could still be useful, but we can leave the conf file empty to effect a pure
281   // trusted-PXML-copying
282
283   // it would be sort of cumbersome to copy all the freedesktop.org defined categories (as
284   // there are hundreds), and would also mean new ones and peoples custom ones would
285   // flop
286
287   /* attempt primary category chain
288    */
289   #define MAPCAT(field)                                     \
290     if ( ( t = d -> field ) ) {                             \
291       match = pnd_map_dotdesktop_category ( c, t );         \
292       strncat ( target_buffer, match ? match : t, len );    \
293       strncat ( target_buffer, ";", len );                  \
294     }
295
296   MAPCAT(main_category);
297   MAPCAT(main_category1);
298   MAPCAT(main_category2);
299   MAPCAT(alt_category);
300   MAPCAT(alt_category1);
301   MAPCAT(alt_category2);
302
303   if ( target_buffer [ 0 ] ) {
304     return ( 1 ); // I guess its 'good'?
305   }
306
307 #if 0
308   if ( ( t = d -> main_category ) ) {
309     match = pnd_map_dotdesktop_category ( c, t );
310     strncat ( target_buffer, match ? match : t, len );
311     strncat ( target_buffer, ";", len );
312   }
313 #endif
314
315   return ( 0 );
316 }
317 #endif
318
319 #if 0 // we switched direction
320 //int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_pxml_handle h ) {
321 int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_disco_t *d ) {
322   unsigned short int n = 0; // no. matches
323   char *t;
324   char *match;
325
326   // clear target so we can easily append
327   memset ( target_buffer, '\0', len );
328
329   /* attempt primary category chain
330    */
331   match = NULL;
332
333   if ( ( t = d -> main_category ) ) {
334     match = pnd_map_dotdesktop_category ( c, t );
335   }
336
337   if ( ( ! match ) &&
338        ( t = d -> main_category1 ) )
339   {
340     match = pnd_map_dotdesktop_category ( c, t );
341   }
342
343   if ( ( ! match ) &&
344        ( t = d -> main_category2 ) )
345   {
346     match = pnd_map_dotdesktop_category ( c, t );
347   }
348   
349   if ( match ) {
350     strncat ( target_buffer, match, len );
351     len -= strlen ( target_buffer );
352     n += 1;
353   }
354
355   /* attempt secondary category chain
356    */
357   match = NULL;
358
359   if ( ( t = d -> alt_category ) ) {
360     match = pnd_map_dotdesktop_category ( c, t );
361   }
362
363   if ( ( ! match ) &&
364        ( t = d -> alt_category1 ) )
365   {
366     match = pnd_map_dotdesktop_category ( c, t );
367   }
368
369   if ( ( ! match ) &&
370        ( t = d -> alt_category2 ) )
371   {
372     match = pnd_map_dotdesktop_category ( c, t );
373   }
374   
375   if ( match ) {
376     if ( target_buffer [ 0 ] != '\0' && len > 0 ) {
377       strcat ( target_buffer, ";" );
378       len -= 1;
379     }
380     strncat ( target_buffer, match, len );
381     len -= strlen ( target_buffer );
382     n += 1;
383   }
384
385 #if 0 // doh, originally I was using pxml-t till I realized I pre-boned myself on that one
386   match = NULL;
387
388   if ( ( t = pnd_pxml_get_main_category ( h ) ) ) {
389     match = pnd_map_dotdesktop_category ( c, t );
390   }
391
392   if ( ( ! match ) &&
393        ( t = pnd_pxml_get_subcategory1 ( h ) ) )
394   {
395     match = pnd_map_dotdesktop_category ( c, t );
396   }
397
398   if ( ( ! match ) &&
399        ( t = pnd_pxml_get_subcategory2 ( h ) ) )
400   {
401     match = pnd_map_dotdesktop_category ( c, t );
402   }
403   
404   if ( match ) {
405     strncat ( target_buffer, match, len );
406     len -= strlen ( target_buffer );
407     n += 1;
408   }
409
410   /* attempt secondary category chain
411    */
412   match = NULL;
413
414   if ( ( t = pnd_pxml_get_altcategory ( h ) ) ) {
415     match = pnd_map_dotdesktop_category ( c, t );
416   }
417
418   if ( ( ! match ) &&
419        ( t = pnd_pxml_get_altsubcategory1 ( h ) ) )
420   {
421     match = pnd_map_dotdesktop_category ( c, t );
422   }
423
424   if ( ( ! match ) &&
425        ( t = pnd_pxml_get_altsubcategory2 ( h ) ) )
426   {
427     match = pnd_map_dotdesktop_category ( c, t );
428   }
429   
430   if ( match ) {
431     if ( target_buffer [ 0 ] != '\0' && len > 0 ) {
432       strcat ( target_buffer, ";" );
433       len -= 1;
434     }
435     strncat ( target_buffer, match, len );
436     len -= strlen ( target_buffer );
437     n += 1;
438   }
439 #endif
440
441   if ( n && len ) {
442     strcat ( target_buffer, ";" );
443   }
444
445   return ( n );
446 }
447 #endif
448
449 // given category 'foo', look it up in the provided config map. return the char* reference, or NULL
450 char *pnd_map_dotdesktop_category ( pnd_conf_handle c, char *single_category ) {
451   char *key;
452   char *ret;
453
454   key = malloc ( strlen ( single_category ) + 4 + 1 );
455
456   sprintf ( key, "map.%s", single_category );
457
458   ret = pnd_conf_get_as_char ( c, key );
459
460   free ( key );
461
462   return ( ret );
463 }
464
465 unsigned char *pnd_emit_icon_to_buffer ( pnd_disco_t *p, unsigned int *r_buflen ) {
466   // this is shamefully mostly a copy of emit_icon() above; really, need to refactor that to use this routine
467   // with a fwrite at the end...
468   char from [ FILENAME_MAX ];   // source filename
469   char bits [ 8 * 1024 ];
470   unsigned int bitlen;
471   FILE *pnd = NULL;
472   unsigned char *target = NULL, *targiter = NULL;
473
474   // prelim .. if a pnd file, and no offset found, discovery code didn't locate icon.. so bail.
475   if ( ( p -> object_type == pnd_object_type_pnd ) &&
476        ( ! p -> pnd_icon_pos ) )
477   {
478     return ( NULL ); // discover code didn't find it, so FAIL
479   }
480
481   /* first.. open the source file, by type of application:
482    * are we looking through a pnd file or a dir?
483    */
484   if ( p -> object_type == pnd_object_type_directory ) {
485     sprintf ( from, "%s/%s", p -> object_path, p -> icon );
486   } else if ( p -> object_type == pnd_object_type_pnd ) {
487     sprintf ( from, "%s/%s", p -> object_path, p -> object_filename );
488   }
489
490   pnd = fopen ( from, "r" );
491
492   if ( ! pnd ) {
493     return ( NULL );
494   }
495
496   // determine length of file, then adjust by icon position to find begin of icon
497   unsigned int len;
498
499   fseek ( pnd, 0, SEEK_END );
500   len = ftell ( pnd );
501   //fseek ( pnd, 0, SEEK_SET );
502
503   fseek ( pnd, p -> pnd_icon_pos, SEEK_SET );
504
505   len -= p -> pnd_icon_pos;
506
507   // create target buffer
508   target = malloc ( len );
509
510   if ( ! target ) {
511     fclose ( pnd );
512     return ( 0 );
513   }
514
515   targiter = target;
516
517   if ( r_buflen ) {
518     *r_buflen = len;
519   }
520
521   // copy over icon to target
522   while ( len ) {
523
524     if ( len > (8*1024) ) {
525       bitlen = (8*1024);
526     } else {
527       bitlen = len;
528     }
529
530     if ( fread ( bits, bitlen, 1, pnd ) != 1 ) {
531       fclose ( pnd );
532       free ( target );
533       return ( NULL );
534     }
535
536     memmove ( targiter, bits, bitlen );
537     targiter += bitlen;
538
539     len -= bitlen;
540   } // while
541
542   fclose ( pnd );
543
544   return ( target );
545 }