Allow parse_dotdesktop() to mark libpnd origin or not, and convenience filter to...
[pandora-libraries.git] / lib / pnd_desktop.c
index 3760fba..dc7aa63 100644 (file)
@@ -3,6 +3,7 @@
 #include <string.h>
 #include <unistd.h> /* for unlink */
 #include <stdlib.h> /* for free */
+#include <sys/stat.h> /* for stat */
 
 #include "pnd_apps.h"
 #include "pnd_container.h"
@@ -11,6 +12,7 @@
 #include "pnd_pndfiles.h"
 #include "pnd_conf.h"
 #include "pnd_desktop.h"
+#include "pnd_logger.h"
 
 unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t *p ) {
   char filename [ FILENAME_MAX ];
@@ -23,24 +25,28 @@ unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t
   // validation
 
   if ( ! p -> unique_id ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing unique-id\n", targetpath );
     return ( 0 );
   }
 
   if ( ! p -> exec ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing exec\n", targetpath );
     return ( 0 );
   }
 
   if ( ! targetpath ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing target path\n", targetpath );
     return ( 0 );
   }
 
   if ( ! pndrun ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing pnd_run.sh\n", targetpath );
     return ( 0 );
   }
 
   // set up
 
-  sprintf ( filename, "%s/%s.desktop", targetpath, p -> unique_id );
+  sprintf ( filename, "%s/%s#%u.desktop", targetpath, p -> unique_id, p -> subapp_number );
 
   // emit
 
@@ -67,14 +73,18 @@ unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t
     fprintf ( f, "%s", buffer );
   }
 
-#if 0
-  if ( p -> description_en ) {
-    snprintf ( buffer, 1020, "Comment=%s\n", p -> description_en );
+  if ( p -> unique_id ) {
+    fprintf ( f, "X-Pandora-UID=%s\n", p -> unique_id );
+  }
+
+#if 1
+  if ( p -> desc_en && p -> desc_en [ 0 ] ) {
+    snprintf ( buffer, 1020, "Comment=%s\n", p -> desc_en ); // no [en] needed I suppose, yet
     fprintf ( f, "%s", buffer );
   }
 #endif
 
-#if 0 // we let pnd_run.sh handle this
+#if 0 // we let pnd_run.sh command line handle this instead of in .desktop
   if ( p -> startdir ) {
     snprintf ( buffer, 1020, "Path=%s\n", p -> startdir );
     fprintf ( f, "%s", buffer );
@@ -94,11 +104,13 @@ unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t
 
     // basics
     if ( p -> object_type == pnd_object_type_directory ) {
-      snprintf ( buffer, 1020, "Exec=%s%s -p %s -e %s -b %s",
-                nohup, pndrun, p -> object_path, p -> exec, p -> unique_id );
+      snprintf ( buffer, 1020, "Exec=%s%s -p \"%s\" -e \"%s\" -b \"%s\"",
+                nohup, pndrun, p -> object_path, p -> exec,
+                p -> appdata_dirname ? p -> appdata_dirname : p -> unique_id );
     } else if ( p -> object_type == pnd_object_type_pnd ) {
-      snprintf ( buffer, 1020, "Exec=%s%s -p %s/%s -e %s -b %s",
-                nohup, pndrun, p -> object_path, p -> object_filename, p -> exec, p -> unique_id );
+      snprintf ( buffer, 1020, "Exec=%s%s -p \"%s/%s\" -e \"%s\" -b \"%s\"",
+                nohup, pndrun, p -> object_path, p -> object_filename, p -> exec,
+                p -> appdata_dirname ? p -> appdata_dirname : p -> unique_id );
     }
 
     // start dir
@@ -107,8 +119,21 @@ unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t
       strncat ( buffer, p -> startdir, 1020 );
     }
 
+    // args
+    if ( p -> execargs ) {
+      char argbuf [ 1024 ];
+      snprintf ( argbuf, 1000, " -a \"%s\"", p -> execargs );
+      strncat ( buffer, argbuf, 1020 );
+    }
+
+    // clockspeed
+    if ( p -> clockspeed && atoi ( p -> clockspeed ) != 0 ) {
+      strncat ( buffer, " -c ", 1020 );
+      strncat ( buffer, p -> clockspeed, 1020 );
+    }
+
     // exec options
-    if ( p -> option_no_x11 ) {
+    if ( pnd_pxml_get_x11 ( p -> option_no_x11 ) == pnd_pxml_x11_stop ) {
       strncat ( buffer, " -x ", 1020 );
     }
 
@@ -170,10 +195,158 @@ unsigned char pnd_emit_dotdesktop ( char *targetpath, char *pndrun, pnd_disco_t
   return ( 1 );
 }
 
+unsigned char pnd_emit_dotinfo ( char *targetpath, char *pndrun, pnd_disco_t *p ) {
+  char filename [ FILENAME_MAX ];
+  char buffer [ 1024 ];
+  FILE *f;
+  char *viewer, *searchpath;
+  pnd_conf_handle desktoph;
+
+  // specification
+  // http://standards.freedesktop.org/desktop-entry-spec
+
+  // validation
+  //
+
+  // viewer
+  searchpath = pnd_conf_query_searchpath();
+
+  desktoph = pnd_conf_fetch_by_id ( pnd_conf_desktop, searchpath );
+
+  if ( ! desktoph ) {
+    return ( 0 );
+  }
+
+  viewer = pnd_conf_get_as_char ( desktoph, "info.viewer" );
+
+  if ( ! viewer ) {
+    return ( 0 ); // no way to view the file
+  }
+
+  // etc
+  if ( ! p -> unique_id ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing unique-id\n", targetpath );
+    return ( 0 );
+  }
+
+  if ( ! p -> info_filename ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing info_filename\n", targetpath );
+    return ( 0 );
+  }
+
+  if ( ! p -> info_name ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing info_name\n", targetpath );
+    return ( 0 );
+  }
+
+  if ( ! targetpath ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing target path\n", targetpath );
+    return ( 0 );
+  }
+
+  if ( ! pndrun ) {
+    pnd_log ( PND_LOG_DEFAULT, "Can't emit dotdesktop for %s, missing pnd_run.sh\n", targetpath );
+    return ( 0 );
+  }
+
+  // set up
+
+  sprintf ( filename, "%s/%s#%uinfo.desktop", targetpath, p -> unique_id, p -> subapp_number );
+
+  // emit
+
+  f = fopen ( filename, "w" );
+
+  if ( ! f ) {
+    return ( 0 );
+  }
+
+  fprintf ( f, "%s\n", PND_DOTDESKTOP_HEADER );
+
+  if ( p -> info_name ) {
+    snprintf ( buffer, 1020, "Name=%s\n", p -> info_name );
+    fprintf ( f, "%s", buffer );
+  }
+
+  fprintf ( f, "Type=Application\n" );
+  fprintf ( f, "Version=1.0\n" );
+
+#if 0
+  if ( p -> icon ) {
+    snprintf ( buffer, 1020, "Icon=%s\n", p -> icon );
+    fprintf ( f, "%s", buffer );
+  }
+#endif
+
+  if ( p -> unique_id ) {
+    fprintf ( f, "X-Pandora-UID=%s\n", p -> unique_id );
+  }
+
+  if ( p -> title_en && p -> title_en [ 0 ] ) {
+    snprintf ( buffer, 1020, "Comment=Automatic menu info entry for %s\n", p -> title_en );
+    fprintf ( f, "%s", buffer );
+  }
+
+#if 0 // we let pnd_run.sh command line handle this instead of in .desktop
+  if ( p -> startdir ) {
+    snprintf ( buffer, 1020, "Path=%s\n", p -> startdir );
+    fprintf ( f, "%s", buffer );
+  } else {
+    fprintf ( f, "Path=%s\n", PND_DEFAULT_WORKDIR );
+  }
+#endif
+
+  // exec line
+  char args [ 1001 ];
+  char *pargs = args;
+  char *viewerargs = pnd_conf_get_as_char ( desktoph, "info.viewer_args" );
+  if ( viewerargs && viewerargs [ 0 ] ) {
+    snprintf ( pargs, 1001, "%s %s",
+              pnd_conf_get_as_char ( desktoph, "info.viewer_args" ), p -> info_filename );
+  } else {
+    pargs = NULL;
+    // WARNING: This might not be quite right; if no viewer-args, shouldn't we still append the info-filename? likewise,
+    //          even if we do have view-args, shouldn't we check if filename is present?
+  }
+
+  char pndfile [ 1024 ];
+  if ( p -> object_type == pnd_object_type_directory ) {
+    // for PXML-app-dir, pnd_run.sh doesn't want the PXML.xml.. it just wants the dir-name
+    strncpy ( pndfile, p -> object_path, 1000 );
+  } else if ( p -> object_type == pnd_object_type_pnd ) {
+    // pnd_run.sh wants the full path and filename for the .pnd file
+    snprintf ( pndfile, 1020, "%s/%s", p -> object_path, p -> object_filename );
+  }
+
+  pnd_apps_exec_info_t info;
+  info.viewer = viewer;
+  info.args = pargs;
+
+  if ( ! pnd_apps_exec_disco ( pndrun, p, PND_EXEC_OPTION_NORUN | PND_EXEC_OPTION_INFO, &info ) ) {
+    return ( 0 );
+  }
+
+  fprintf ( f, "Exec=%s\n", pnd_apps_exec_runline() );
+
+  if ( pnd_conf_get_as_char ( desktoph, "info.category" ) ) {
+    fprintf ( f, "Categories=%s\n", pnd_conf_get_as_char ( desktoph, "info.category" ) );
+  } else {
+    fprintf ( f, "Categories=Documentation\n" );
+  }
+
+  fprintf ( f, "%s\n", PND_DOTDESKTOP_SOURCE ); // should we need to know 'who' created the file during trimming
+
+  fclose ( f );
+
+  return ( 1 );
+}
+
 unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
+  //#define BITLEN (8*1024)
+#define BITLEN (64*1024)
   char buffer [ FILENAME_MAX ]; // target filename
   char from [ FILENAME_MAX ];   // source filename
-  char bits [ 8 * 1024 ];
+  unsigned char bits [ BITLEN ];
   unsigned int bitlen;
   FILE *pnd, *target;
 
@@ -185,7 +358,7 @@ unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
   }
 
   // determine filename for target
-  sprintf ( buffer, "%s/%s.png", targetpath, p -> unique_id ); // target
+  sprintf ( buffer, "%s/%s.png", targetpath, p -> unique_id /*, p -> subapp_number*/ ); // target
 
   /* first.. open the source file, by type of application:
    * are we looking through a pnd file or a dir?
@@ -196,9 +369,10 @@ unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
     sprintf ( from, "%s/%s", p -> object_path, p -> object_filename );
   }
 
-  pnd = fopen ( from, "r" );
+  pnd = fopen ( from, "rb" );
 
   if ( ! pnd ) {
+    pnd_log ( PND_LOG_DEFAULT, "    Emit icon, couldn't open source\n" );
     return ( 0 );
   }
 
@@ -208,6 +382,7 @@ unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
 
   if ( ! target ) {
     fclose ( pnd );
+    pnd_log ( PND_LOG_DEFAULT, "    Emit icon, couldn't open target\n" );
     return ( 0 );
   }
 
@@ -219,10 +394,12 @@ unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
 
   len -= p -> pnd_icon_pos;
 
+  pnd_log ( PND_LOG_DEFAULT, "    Emit icon, length: %u\n", len );
+
   while ( len ) {
 
-    if ( len > (8*1024) ) {
-      bitlen = (8*1024);
+    if ( len > (BITLEN) ) {
+      bitlen = (BITLEN);
     } else {
       bitlen = len;
     }
@@ -231,25 +408,97 @@ unsigned char pnd_emit_icon ( char *targetpath, pnd_disco_t *p ) {
       fclose ( pnd );
       fclose ( target );
       unlink ( buffer );
+      pnd_log ( PND_LOG_DEFAULT, "    Emit icon, bad read\n" );
       return ( 0 );
     }
 
+#if 0
+    {
+      unsigned int i = 0;
+      char bigbuffer [ 200 * 1024 ] = "\0";
+      char b [ 10 ];
+      pnd_log ( PND_LOG_DEFAULT, "    Read hexdump\n" );
+      while ( i < bitlen ) {
+       sprintf ( b, "%x,", bits [ i ] );
+       strcat ( bigbuffer, b );
+       i++;
+      }
+      pnd_log ( PND_LOG_DEFAULT, bigbuffer );
+    }
+#endif
+
     if ( fwrite ( bits, bitlen, 1, target ) != 1 ) {
       fclose ( pnd );
       fclose ( target );
       unlink ( buffer );
+      pnd_log ( PND_LOG_DEFAULT, "    Emit icon, bad write\n" );
       return ( 0 );
     }
 
     len -= bitlen;
+    //pnd_log ( PND_LOG_DEFAULT, "    Emit icon, next block, length: %u\n", len );
   } // while
 
   fclose ( pnd );
   fclose ( target );
 
+  //pnd_log ( PND_LOG_DEFAULT, "    Emit icon, done.\n" );
+
   return ( 1 );
 }
 
+#if 1 // we switched direction to freedesktop standard categories
+// if no categories herein, return 0; otherwise, if some category-like-text, return 1
+int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_disco_t *d ) {
+  char *t;
+  char *match;
+
+  // clear target so we can easily append
+  memset ( target_buffer, '\0', len );
+
+  // for each main-cat and sub-cat, including alternates, just append them all together
+  // we'll try mapping them, since the categories file is there, but we'll default to
+  // copying over; this lets the conf file do merging or renaming of cagtegories, which
+  // could still be useful, but we can leave the conf file empty to effect a pure
+  // trusted-PXML-copying
+
+  // it would be sort of cumbersome to copy all the freedesktop.org defined categories (as
+  // there are hundreds), and would also mean new ones and peoples custom ones would
+  // flop
+
+  /* attempt primary category chain
+   */
+  #define MAPCAT(field)                                            \
+    if ( ( t = d -> field ) ) {                             \
+      match = pnd_map_dotdesktop_category ( c, t );         \
+      strncat ( target_buffer, match ? match : t, len );    \
+      strncat ( target_buffer, ";", len );                  \
+    }
+
+  MAPCAT(main_category);
+  MAPCAT(main_category1);
+  MAPCAT(main_category2);
+  MAPCAT(alt_category);
+  MAPCAT(alt_category1);
+  MAPCAT(alt_category2);
+
+  if ( target_buffer [ 0 ] ) {
+    return ( 1 ); // I guess its 'good'?
+  }
+
+#if 0
+  if ( ( t = d -> main_category ) ) {
+    match = pnd_map_dotdesktop_category ( c, t );
+    strncat ( target_buffer, match ? match : t, len );
+    strncat ( target_buffer, ";", len );
+  }
+#endif
+
+  return ( 0 );
+}
+#endif
+
+#if 0 // we switched direction
 //int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_pxml_handle h ) {
 int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsigned short int len, pnd_disco_t *d ) {
   unsigned short int n = 0; // no. matches
@@ -278,7 +527,7 @@ int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsi
   {
     match = pnd_map_dotdesktop_category ( c, t );
   }
-  
+
   if ( match ) {
     strncat ( target_buffer, match, len );
     len -= strlen ( target_buffer );
@@ -304,7 +553,7 @@ int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsi
   {
     match = pnd_map_dotdesktop_category ( c, t );
   }
-  
+
   if ( match ) {
     if ( target_buffer [ 0 ] != '\0' && len > 0 ) {
       strcat ( target_buffer, ";" );
@@ -333,7 +582,7 @@ int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsi
   {
     match = pnd_map_dotdesktop_category ( c, t );
   }
-  
+
   if ( match ) {
     strncat ( target_buffer, match, len );
     len -= strlen ( target_buffer );
@@ -359,7 +608,7 @@ int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsi
   {
     match = pnd_map_dotdesktop_category ( c, t );
   }
-  
+
   if ( match ) {
     if ( target_buffer [ 0 ] != '\0' && len > 0 ) {
       strcat ( target_buffer, ";" );
@@ -377,6 +626,7 @@ int pnd_map_dotdesktop_categories ( pnd_conf_handle c, char *target_buffer, unsi
 
   return ( n );
 }
+#endif
 
 // given category 'foo', look it up in the provided config map. return the char* reference, or NULL
 char *pnd_map_dotdesktop_category ( pnd_conf_handle c, char *single_category ) {
@@ -475,3 +725,135 @@ unsigned char *pnd_emit_icon_to_buffer ( pnd_disco_t *p, unsigned int *r_buflen
 
   return ( target );
 }
+
+// parse_dotdesktop() can be used to read a libpnd generated .desktop and return a limited
+// but useful disco-t structure back; possibly useful for scanning .desktops rather than
+// scanning pnd-files?
+pnd_disco_t *pnd_parse_dotdesktop ( char *ddpath, unsigned int flags ) {
+
+  // will verify the .desktop has the libpnd-marking on it (X-Pandora-Source): PND_DOTDESKTOP_SOURCE
+
+  // attempt to extract..
+  // - unique-id (from filename or field)
+  // - subapp number (from filename)
+  // - exec required info
+  // - icon path
+  // - name (title-en)
+  // - comment (desc-en)
+  // - option_no_x11
+  // - object path
+  // - appdata name (or unique-id if not present)
+  // - start dir
+  // - args
+  // - clockspeed
+  // - categories
+
+  // determine file length
+  struct stat statbuf;
+
+  if ( stat ( ddpath, &statbuf) < 0 ) {
+    return ( NULL ); // couldn't open
+  }
+
+  // buffers..
+  char dd [ 1024 ];
+  unsigned char libpnd_origin = 0;
+
+  // disco
+  pnd_disco_t *p = malloc ( sizeof(pnd_disco_t) );
+  if ( ! p ) {
+    return ( NULL );
+  }
+  bzero ( p, sizeof(pnd_disco_t) );
+
+  // inhale file
+  FILE *f = fopen ( ddpath, "r" );
+
+  if ( ! f ) {
+    return ( NULL ); // not up or shut up!
+  }
+
+  while ( fgets ( dd, 1024, f ) ) {
+    char *nl = strchr ( dd, '\n' );
+    if ( nl ) {
+      *nl = '\0';
+    }
+
+    // grep
+    //
+
+    if ( strncmp ( dd, "Name=", 5 ) == 0 ) {
+      p -> title_en = strdup ( dd + 5 );
+    } else if ( strncmp ( dd, "Icon=", 5 ) == 0 ) {
+      p -> icon = strdup ( dd + 5 );
+    } else if ( strcmp ( dd, PND_DOTDESKTOP_SOURCE ) == 0 ) {
+      libpnd_origin = 1;
+    } else if ( strncmp ( dd, "X-Pandora-UID=", 14 ) == 0 ) {
+      p -> unique_id = strdup ( dd + 14 );
+    } else if ( strncmp ( dd, "Comment=", 8 ) == 0 ) {
+      p -> desc_en = strdup ( dd + 8 );
+    } else if ( strncmp ( dd, "Exec=", 5 ) == 0 ) {
+
+      char *e = strstr ( dd, " -e " );
+      if ( e ) {
+       e += 5;
+
+       char *space = strchr ( e, ' ' );
+       p -> exec = strndup ( e, space - e - 1 );
+      }
+
+      char *b = strstr ( dd, " -b " );
+      if ( b ) {
+       b += 5;
+       char *space = strchr ( b, '\0' );
+       p -> appdata_dirname = strndup ( b, space - b - 1 );
+      }
+
+    } else if ( strncmp ( dd, "Categories=", 11 ) == 0 ) {
+      // HACK; only honours first category
+      char *semi = strchr ( dd, ';' );
+      if ( semi ) {
+       p -> main_category = strndup ( dd + 11, semi - dd + 11 );
+      } else {
+       p -> main_category = strdup ( dd + 11 );
+      }
+      semi = strchr ( p -> main_category, ';' );
+      if ( semi ) {
+       *semi = '\0';
+      }
+    }
+
+    //
+    // /grep
+
+  } // while
+
+  fclose ( f );
+
+  // filter
+  if ( ! libpnd_origin ) {
+    p -> object_flags |= PND_DISCO_CUSTOM1; // so caller can do something if it wishes
+
+    // convenience flag
+    if ( flags & PND_DOTDESKTOP_LIBPND_ONLY ) {
+      pnd_disco_destroy ( p );
+      free ( p );
+      return ( NULL );
+    }
+
+  }
+
+  // additional
+  p -> object_type = pnd_object_type_pnd;
+  char *slash = strrchr ( ddpath, '/' );
+  if ( slash ) {
+    p -> object_path = strndup ( ddpath, slash - ddpath );
+    p -> object_filename = strdup ( slash + 1 );
+  } else {
+    p -> object_path = "./";
+    p -> object_filename = strdup ( ddpath );
+  }
+
+  // return disco-t
+  return ( p );
+}