lib/pnd_tinyxml.cpp

   1
   2 #include <stdio.h>
   3 #include "tinyxml/tinyxml.h"
   4 #include "../include/pnd_pxml.h"
   5 #include "pnd_tinyxml.h"
   6 #include "pnd_logger.h"
   7
   8 //Easily change the tag names if required (globally in this file):
   9 #include "pnd_pxml_names.h"
  10
  11 extern "C" {
  12
  13 char *pnd_pxml_get_attribute(TiXmlElement *elem, const char *name)
  14 {
  15         const char *value = elem->Attribute(name);
  16         if (value)
  17                 return strdup(value);
  18         else
  19                 return NULL;
  20 }
  21
  22 unsigned char pnd_pxml_parse_titles(const TiXmlHandle hRoot, pnd_pxml_t *app) {
  23   TiXmlElement *pElem;
  24   app->titles_alloc_c = 4;  //TODO: adjust this based on how many titles a PXML usually has. Power of 2.
  25
  26   app->titles = (pnd_localized_string_t *)malloc(sizeof(pnd_localized_string_t) * app->titles_alloc_c);
  27   if (!app->titles) return (0); //errno = NOMEM
  28
  29   // Go through all title tags and load them.
  30   // - Check if newer style titles sub-block exists; if so, use that.
  31   //   - if not, fall back to old style
  32   //     - failing that, crash earth into sun
  33   if ( (pElem = hRoot.FirstChild(PND_PXML_NODENAME_TITLES).Element()) ) {
  34     // newer <titles> block
  35
  36     pElem = pElem -> FirstChildElement ( PND_PXML_ENAME_TITLE );
  37
  38     while ( pElem ) {
  39
  40       // handle <title lang="en_US">Program Title</title>
  41       //
  42
  43       // parse out the text and lang
  44       char *text, *lang;
  45
  46       if ( ! ( text = strdup ( pElem -> GetText() ) ) ) {
  47         continue;
  48       }
  49
  50       if ( ! ( lang = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_TITLELANG ) ) ) {
  51         continue;
  52       }
  53
  54       // increment counter; if we're running out of buffers, grow to handle the new strings
  55       app -> titles_c++;
  56
  57       if ( app -> titles_c > app -> titles_alloc_c ) {
  58         // we don't have enough strings allocated
  59         app -> titles_alloc_c <<= 1;
  60         app -> titles = (pnd_localized_string_t *)realloc((void*)app->titles, app->titles_alloc_c);
  61         if (!app->titles) return (0); //errno = ENOMEM
  62       }
  63
  64       // populate the stringbuf
  65       pnd_localized_string_t *title = &app->titles[app->titles_c - 1];
  66       title->language = lang;
  67       title->string = text;
  68
  69       // next
  70       pElem = pElem -> NextSiblingElement ( PND_PXML_ENAME_TITLE );
  71
  72     } // foreach
  73
  74   } else {
  75     // older style <title> entry series
  76
  77     for ( pElem = hRoot.FirstChild(PND_PXML_ENAME_TITLE).Element(); pElem;
  78           pElem = pElem->NextSiblingElement(PND_PXML_ENAME_TITLE))
  79     {
  80
  81       if ( ! pElem->GetText() ) {
  82         continue;
  83       }
  84
  85       char *text = strdup(pElem->GetText());
  86       if (!text) continue;
  87
  88       char *lang = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_TITLELANG);
  89       if (!lang) continue;
  90
  91       app->titles_c++;
  92       if (app->titles_c > app->titles_alloc_c) //we don't have enough strings allocated
  93       {
  94         app->titles_alloc_c <<= 1;
  95         app->titles = (pnd_localized_string_t *)realloc((void*)app->titles, app->titles_alloc_c);
  96         if (!app->titles) return (0); //errno = ENOMEM
  97       }
  98
  99       pnd_localized_string_t *title = &app->titles[app->titles_c - 1];
 100       title->language = lang;
 101       title->string = text;
 102
 103       //pnd_log ( PND_LOG_DEFAULT, (char*)"    Title/Lang: %s/%s\n", text, lang );
 104
 105     } // for
 106
 107   } // new or old style <title(s)>
 108
 109   return ( 1 );
 110 }
 111
 112 unsigned char pnd_pxml_parse_descriptions(const TiXmlHandle hRoot, pnd_pxml_t *app) {
 113   TiXmlElement *pElem;
 114   app->descriptions_alloc_c = 4; //TODO: adjust this based on how many descriptions a PXML usually has. Power of 2.
 115
 116   app->descriptions = (pnd_localized_string_t *)malloc(sizeof(pnd_localized_string_t) * app->descriptions_alloc_c);
 117   if (!app->descriptions)
 118   {
 119     app->descriptions_alloc_c = 0;
 120     return (0); //errno = NOMEM
 121   }
 122
 123   // similar logic to how <titles> or <title> is parsed
 124   // - if <titles> block is found, use that; otherwise fall back to <title> deprecated form
 125   if ( (pElem = hRoot.FirstChild ( PND_PXML_NODENAME_DESCRIPTIONS).Element() ) ) {
 126     // newer style <descriptions> block
 127
 128     pElem = pElem -> FirstChildElement ( PND_PXML_ENAME_DESCRIPTION );
 129
 130     while ( pElem ) {
 131
 132       char *text, *lang;
 133
 134       if ( ! ( text = strdup ( pElem -> GetText() ) ) ) {
 135         continue;
 136       }
 137
 138       if ( ! ( lang = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_DESCRLANG ) ) ) {
 139        if(text) free(text); text = NULL;
 140         continue;
 141       }
 142
 143       app->descriptions_c++;
 144       if (app->descriptions_c > app->descriptions_alloc_c) //we don't have enough strings allocated
 145       {
 146         app->descriptions_alloc_c <<= 1;
 147         app->descriptions = (pnd_localized_string_t*)realloc((void*)app->descriptions, app->descriptions_alloc_c * sizeof(pnd_localized_string_t) );
 148         if (!app->descriptions) { if(text) free(text); if(lang) free(lang); return (0); } //errno = ENOMEM
 149       }
 150
 151       pnd_localized_string_t *description = &app->descriptions[app->descriptions_c - 1];
 152       description->language = lang;
 153       description->string = text;
 154
 155       // next
 156       pElem = pElem -> NextSiblingElement ( PND_PXML_ENAME_DESCRIPTION );
 157
 158     } // foreach
 159
 160   } else {
 161     // fallback to older approach
 162
 163     for (pElem = hRoot.FirstChild(PND_PXML_ENAME_DESCRIPTION).Element(); pElem;
 164          pElem = pElem->NextSiblingElement(PND_PXML_ENAME_DESCRIPTION))
 165     {
 166
 167       if ( ! pElem->GetText() ) {
 168         continue;
 169       }
 170
 171       char *text = strdup(pElem->GetText());
 172       if (!text) continue;
 173
 174       char *lang = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_DESCRLANG);
 175       if (!lang) { if(text) free(text); text = NULL;  continue; }
 176
 177       app->descriptions_c++;
 178       if (app->descriptions_c > app->descriptions_alloc_c) //we don't have enough strings allocated
 179       {
 180         app->descriptions_alloc_c <<= 1;
 181         app->descriptions = (pnd_localized_string_t*)realloc((void*)app->descriptions, app->descriptions_alloc_c * sizeof(pnd_localized_string_t) );
 182         if (!app->descriptions) { if(text) free(text); if(lang) free(lang); return (0); } //errno = ENOMEM
 183       }
 184
 185       pnd_localized_string_t *description = &app->descriptions[app->descriptions_c - 1];
 186       description->language = lang;
 187       description->string = text;
 188     } // for
 189
 190   } // new form or old form?
 191
 192   return ( 1 );
 193 }
 194
 195 unsigned char pnd_pxml_parse ( const char *pFilename, char *buffer, unsigned int length, pnd_pxml_t **apps ) {
 196
 197   //Load the XML document
 198   TiXmlDocument doc;
 199   doc.Parse(buffer);
 200
 201   unsigned char appwrappermode = 0; // >=1 -> using <application>...</application> wrapper
 202   unsigned char appcount = 0;
 203   pnd_pxml_t *app = NULL;
 204
 205   TiXmlElement *pElem = NULL;
 206   TiXmlElement *appElem = NULL;
 207
 208   //Find the root element
 209   TiXmlHandle hDoc(&doc);
 210   TiXmlHandle hRoot(0);
 211
 212   pElem = hDoc.FirstChild("PXML").Element();
 213   if (!pElem) return (0);
 214
 215   // new Strategy; really, we want multiple app support within a PXML, without the lameness of
 216   // multiple <PXML>..</PXML> within a single PXML.xml file. As such, we should have an app within
 217   // an <application>..</application> wrapper level, with the ID on that. Further, the icon and
 218   // .desktop filenames can have a # appended which is the application-count-# within the PXML,
 219   // so that they can have their own .desktop and icon without collisions, but still use the
 220   // same unique-id if they want to.
 221   //   To avoid breaking existing PXML's (even though we're pre-launch), can detect if ID
 222   // is present in PXML line or not; if not, assume application mode?
 223   hRoot = TiXmlHandle(pElem);
 224
 225   // workaround for package ID's used by some package managers
 226   // get the package ID and store it for each application
 227   char* package_id = NULL;
 228   pElem = hRoot.FirstChild ( PND_PXML_ENAME_PACKAGE ).Element();
 229   if ( pElem ) {
 230         package_id = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_PACKAGE_ID );
 231   }
 232
 233   // move to applications element then
 234   if ( hRoot.FirstChild(PND_PXML_APP).Element() != NULL ) {
 235     appwrappermode = 1;
 236     appElem = hRoot.FirstChild(PND_PXML_APP).Element();
 237     hRoot = TiXmlHandle ( appElem );
 238   }
 239
 240   // until we run out of applications in the PXML..
 241   while ( 1 ) {
 242
 243     //pnd_log ( PND_LOG_DEFAULT, (char*)"  App #%u inside of PXML %s\n", appcount, pFilename );
 244
 245     // create the buffer to hold the pxml
 246     apps [ appcount ] = (pnd_pxml_t*) malloc ( sizeof(pnd_pxml_t) );
 247     memset ( apps [ appcount ], '\0', sizeof(pnd_pxml_t) );
 248
 249     // due to old code, just make life easier a minute..
 250     app = apps [ appcount ];
 251     if ( appwrappermode ) {
 252       app -> subapp_number = appcount;
 253     } else {
 254       app -> subapp_number = 0;
 255     }
 256
 257     // give application the package id, if there is one
 258     if( package_id )
 259       app -> package_id               = strdup(package_id);
 260
 261     //Get unique ID first.
 262     if ( appwrappermode ) {
 263       app->unique_id = pnd_pxml_get_attribute(appElem, PND_PXML_ATTRNAME_UID);
 264       //pnd_log ( PND_LOG_DEFAULT, (char*)"  Subapp #%u has unique_id %s\n", appcount, app -> unique_id );
 265       app->appdata_dirname = pnd_pxml_get_attribute(appElem, PND_PXML_ATTRNAME_APPDATANAME);
 266     } else {
 267       app->unique_id = pnd_pxml_get_attribute(hRoot.Element(), PND_PXML_ATTRNAME_UID);
 268       //pnd_log ( PND_LOG_DEFAULT, (char*)"  Only-app #%u has unique_id %s\n", appcount, app -> unique_id );
 269     }
 270
 271     //Everything related to the title:
 272     pnd_pxml_parse_titles(hRoot, app);
 273
 274     //Everything description-related:
 275     pnd_pxml_parse_descriptions(hRoot, app);
 276
 277     //Everything launcher-related in one tag:
 278     if ( (pElem = hRoot.FirstChild(PND_PXML_ENAME_EXEC).Element()) )
 279      {
 280        app->background = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_EXECBG); //if this returns NULL, the struct is filled with NULL. No need to check.
 281        app->standalone = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_EXECSTAL);
 282        app->exec       = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_EXECCMD);
 283        app->startdir   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_EXECWD);
 284        app->exec_no_x11     = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_EXECNOX11);
 285        app->execargs   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_EXECARGS);
 286      }
 287
 288     //The app icon:
 289     if ( (pElem = hRoot.FirstChild(PND_PXML_ENAME_ICON).Element()) ) {
 290       app->icon       = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_ICONSRC);
 291     }
 292
 293     // <info>
 294     if ( (pElem = hRoot.FirstChild(PND_PXML_ENAME_INFO).Element()) )
 295      {
 296        app-> info_name = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_INFONAME );
 297        app-> info_filename = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_INFOSRC );
 298        app-> info_type = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_INFOTYPE );
 299      }
 300
 301     //The preview pics:
 302     if ( (pElem = hRoot.FirstChild(PND_PXML_NODENAME_PREVPICS).Element()) )
 303     {
 304       //TODO: Change this if pnd_pxml_t gains the feature of more pics than 2.
 305       if ( (pElem = pElem->FirstChildElement(PND_PXML_ENAME_PREVPIC)) )
 306       {
 307         app->previewpic1 = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_PREVPICSRC);
 308
 309         if ( (pElem = pElem->NextSiblingElement(PND_PXML_ENAME_PREVPIC)) )
 310         {
 311           app->previewpic2 = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_PREVPICSRC);
 312         }
 313       }
 314     } //previewpic
 315
 316     //The author info:
 317     if ( (pElem = hRoot.FirstChild(PND_PXML_ENAME_AUTHOR).Element()) )
 318     {
 319       app->author_name    = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_AUTHORNAME);
 320       app->author_website = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_AUTHORWWW);
 321       //TODO: Uncomment this if the author gets email support.
 322       //app->author_email = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_AUTHOREMAIL));
 323     }
 324
 325     //The version info:
 326     if ( (pElem = hRoot.FirstChild(PND_PXML_ENAME_VERSION).Element()) )
 327     {
 328       app->version_major   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_VERMAJOR);
 329       app->version_minor   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_VERMINOR);
 330       app->version_release = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_VERREL);
 331       app->version_build   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_VERBUILD);
 332     }
 333
 334     //The OS version info:
 335     if ( (pElem = hRoot.FirstChild(PND_PXML_ENAME_OSVERSION).Element()) )
 336     {
 337       app->osversion_major   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_OSVERMAJOR);
 338       app->osversion_minor   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_OSVERMINOR);
 339       app->osversion_release = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_OSVERREL);
 340       app->osversion_build   = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_OSVERBUILD);
 341     }
 342
 343     int i; //For now, we need to keep track of the index of categories.
 344     //Categories:
 345     if ( (pElem = hRoot.FirstChildElement(PND_PXML_NODENAME_CATS).Element()) ) //First, enter the "categories" node.
 346     {
 347       i = 0;
 348
 349       //Goes through all the top-level categories and their sub-categories. i helps limit these to 2.
 350       for (pElem = pElem->FirstChildElement(PND_PXML_ENAME_CAT); pElem && i < 2;
 351            pElem = pElem->NextSiblingElement(PND_PXML_ENAME_CAT), i++)
 352       {
 353         //TODO: Fix pnd_pxml_t so that there can be more than 2 category 'trees' and more than 2 subcategories. Then this can be removed.
 354         switch (i)
 355         {
 356         case 0: //first category counts as the main cat for now
 357           app->main_category = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_CATNAME);
 358           break;
 359
 360         case 1: //...second as the alternative
 361           app->altcategory = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_CATNAME);
 362         }
 363
 364         TiXmlElement *pSubCatElem; //the sub-elements for a main category.
 365         int j = 0; //the subcategory index within this category
 366
 367         //Goes through all the subcategories within this category. j helps limit these to 2.
 368         for (pSubCatElem = pElem->FirstChildElement(PND_PXML_ENAME_SUBCAT); pSubCatElem && j < 2;
 369              pSubCatElem = pSubCatElem->NextSiblingElement(PND_PXML_ENAME_SUBCAT), j++)
 370         {
 371           char *subcat = pnd_pxml_get_attribute(pSubCatElem, PND_PXML_ATTRNAME_SUBCATNAME);
 372           if (!(subcat)) continue;
 373
 374           //TODO: This is ugly. Fix pnd_pxml_t so that there can be more than 2 category 'trees' and more than 2 subcategories. Then this can be removed.
 375           switch (j | (i << 1))
 376           {
 377           case 0:
 378             app->subcategory1 = subcat;
 379             break;
 380           case 1:
 381             app->subcategory2 = subcat;
 382             break;
 383           case 2:
 384             app->altsubcategory1 = subcat;
 385             break;
 386           case 3:
 387             app->altsubcategory2 = subcat;
 388           }
 389         }
 390       }
 391     }
 392
 393     //All file associations:
 394     //Step into the associations node
 395     if ( (pElem = hRoot.FirstChild(PND_PXML_NODENAME_ASSOCS).Element()) )
 396     {
 397       i = 0;
 398       //Go through all associations. i serves as index; since the format only supports 3 associations we need to keep track of the number.
 399       for (pElem = pElem->FirstChildElement(PND_PXML_ENAME_ASSOC); pElem && i < 3;
 400            pElem = pElem->NextSiblingElement(PND_PXML_ENAME_ASSOC), i++)
 401       {
 402         char *name = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_ASSOCNAME);
 403         char *filetype = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_ASSOCFTYPE);
 404         char *paramter = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_ASSOCARGS);
 405
 406         if (!(name && filetype && paramter)) continue;
 407
 408         switch(i) //TODO: same problem here: only 3 associations supported
 409         {
 410         case 0:
 411         {
 412           app->associationitem1_name      = name;
 413           app->associationitem1_filetype  = filetype;
 414           app->associationitem1_parameter = paramter;
 415           break;
 416         }
 417         case 1:
 418         {
 419           app->associationitem2_name      = name;
 420           app->associationitem2_filetype  = filetype;
 421           app->associationitem2_parameter = paramter;
 422           break;
 423         }
 424         case 2:
 425         {
 426           app->associationitem3_name      = name;
 427           app->associationitem3_filetype  = filetype;
 428           app->associationitem3_parameter = paramter;
 429         }
 430         }
 431       }
 432     }
 433
 434     //Performance related things (aka: Clockspeed XD):
 435     pElem = hRoot.FirstChild(PND_PXML_ENAME_CLOCK).Element();
 436     if (pElem)
 437     {
 438       app->clockspeed = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_CLOCKFREQ);
 439     }
 440
 441     // Package
 442     pElem = hRoot.FirstChild ( PND_PXML_ENAME_PACKAGE ).Element();
 443     if ( pElem ) {
 444       app -> package_name = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_PACKAGE_NAME );
 445       app -> package_release_date = pnd_pxml_get_attribute ( pElem, PND_PXML_ATTRNAME_PACKAGE_DATE );
 446     }
 447
 448     // mkdir request
 449     if ( (pElem = hRoot.FirstChild(PND_PXML_NODENAME_MKDIR).Element()) ) {
 450
 451       // seek <dir>
 452       if ( (pElem = pElem->FirstChildElement(PND_PXML_ENAME_MKDIR)) ) {
 453         char *t;
 454
 455         if ( ( t = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_MKDIRPATH) ) ) {
 456           // first <dir>, so just replace it wholesale; we use strdup so we can free() easily later, consistently. Mmm, leak seems imminent.
 457           app -> mkdir_sp = strdup ( t );
 458         }
 459
 460         while ( ( pElem = pElem -> NextSiblingElement ( PND_PXML_ENAME_MKDIR ) ) ) {
 461
 462           if ( ( t = pnd_pxml_get_attribute(pElem, PND_PXML_ATTRNAME_MKDIRPATH) ) ) {
 463             char *foo = (char*) malloc ( strlen ( app -> mkdir_sp ) + strlen ( t ) + 1 /*:*/ + 1 /*\0*/ );
 464
 465             if ( foo ) {
 466               sprintf ( foo, "%s:%s", app -> mkdir_sp, t );
 467               free ( app -> mkdir_sp );
 468               app -> mkdir_sp = foo;
 469             } // assuming we got ram, lets cat it all together
 470
 471           } // got another elem?
 472
 473         } // while
 474
 475       } // found a <dir>
 476
 477 #if 0
 478       if ( app -> mkdir_sp ) {
 479         printf ( "mkdir: %s\n", app -> mkdir_sp );
 480       }
 481 #endif
 482
 483     } // mkdir
 484
 485     // if in <application> mode, do we find another app?
 486     if ( appwrappermode ) {
 487       appElem = appElem -> NextSiblingElement ( PND_PXML_APP );
 488       if ( ! appElem ) {
 489         //pnd_log ( PND_LOG_DEFAULT, (char*)"  No more applications within PXML\n" );
 490         break; // no more applications
 491       }
 492       // got another application..
 493       //pnd_log ( PND_LOG_DEFAULT, "  Found another applications within PXML\n" );
 494       appwrappermode++;
 495       hRoot = TiXmlHandle ( appElem );
 496
 497       appcount++;
 498
 499       if ( appcount == PXML_MAXAPPS ) {
 500         return ( 1 ); // thats all we can handle; we're not going to auto-extend this
 501       }
 502
 503     } else {
 504       break; // single-app old PXML
 505     }
 506
 507   } // while finding apps
 508
 509   if( package_id )
 510      free(package_id);
 511
 512   return (1);
 513 }
 514
 515 } // extern C