parser/pkgmgr_parser.h

   1 /*
   2  * pkgmgr-info
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Jayoun Lee <airjany@samsung.com>, Sewook Park <sewook7.park@samsung.com>,
   7  * Jaeho Lee <jaeho81.lee@samsung.com>, Shobhit Srivastava <shobhit.s@samsung.com>
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  */
  22
  23 #ifndef __PKGMGR_PARSER_H__
  24 #define __PKGMGR_PARSER_H__
  25
  26 /**
  27  * @file pkgmgr_parser.h
  28  * @author Sewook Park <sewook7.park@samsung.com>
  29  * @author Shobhit Srivastava <shobhit.s@samsung.com>
  30  * @version 0.1
  31  * @brief    This file declares API of pkgmgr_parser
  32  * @addtogroup          APPLICATION_FRAMEWORK
  33  * @{
  34  *
  35  * @defgroup            PackageManagerParser
  36  * @section             Header Header file to include:
  37  * @code
  38  * #include             <pkgmgr_parser.h>
  39  * @endcode
  40  *
  41  * @}
  42  */
  43
  44 #include <libxml/xmlreader.h>
  45
  46 /* For multi-user support */
  47 #include <tzplatform_config.h>
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52 #define DEFAULT_LOCALE          "No Locale"
  53
  54 #define PKG_PARSERLIB   "parserlib:"
  55 #define PKG_PARSER_CONF_PATH    SYSCONFDIR "/package-manager/parser_path.conf"
  56
  57 #define PKG_STRING_LEN_MAX 1024
  58
  59 #define PKGMGR_PARSER_EMPTY_STR         ""
  60 #define GLOBAL_USER tzplatform_getuid(TZ_SYS_GLOBALAPP_USER)
  61
  62
  63 /**
  64  * @brief List definitions.
  65  * All lists are doubly-linked, the last element is stored to list pointer,
  66  * which means that lists must be looped using the prev pointer, or by
  67  * calling LISTHEAD first to go to start in order to use the next pointer.
  68  */
  69
  70  /**
  71  * @brief Convinience Macro to add node in list
  72  */
  73
  74 #define LISTADD(list, node)                     \
  75     do {                                        \
  76         (node)->prev = (list);                  \
  77         if (list) (node)->next = (list)->next;  \
  78         else (node)->next = NULL;               \
  79         if (list) (list)->next = (node);        \
  80         (list) = (node);                        \
  81     } while (0);
  82
  83  /**
  84  * @brief Convinience Macro to add one node to another node
  85  */
  86 #define NODEADD(node1, node2)                                   \
  87     do {                                                        \
  88         (node2)->prev = (node1);                                \
  89         (node2)->next = (node1)->next;                          \
  90         if ((node1)->next) (node1)->next->prev = (node2);       \
  91         (node1)->next = (node2);                                \
  92     } while (0);
  93
  94  /**
  95  * @brief Convinience Macro to concatenate two lists
  96  */
  97 #define LISTCAT(list, first, last)              \
  98     if ((first) && (last)) {                    \
  99         (first)->prev = (list);                 \
 100         (list) = (last);                        \
 101     }
 102
 103  /**
 104  * @brief Convinience Macro to delete node from list
 105  */
 106 #define LISTDEL(list, node)                                     \
 107     do {                                                        \
 108         if ((node)->prev) (node)->prev->next = (node)->next;    \
 109         if ((node)->next) (node)->next->prev = (node)->prev;    \
 110         if (!((node)->prev) && !((node)->next)) (list) = NULL;  \
 111     } while (0);
 112
 113  /**
 114  * @brief Convinience Macro to get list head
 115  */
 116 #define LISTHEAD(list, node)                                    \
 117     for ((node) = (list); (node)->prev; (node) = (node)->prev)
 118
 119  /**
 120  * @brief Convinience Macro to get list tail
 121  */
 122 #define LISTTAIL(list, node)                                    \
 123     for ((node) = (list); (node)->next; (node) = (node)->next)
 124
 125 typedef struct metadata_x {
 126         const char *key;
 127         const char *value;
 128         struct metadata_x *prev;
 129         struct metadata_x *next;
 130 } metadata_x;
 131
 132 typedef struct privilege_x {
 133         const char *text;
 134         struct privilege_x *prev;
 135         struct privilege_x *next;
 136 } privilege_x;
 137
 138 typedef struct privileges_x {
 139         struct privilege_x *privilege;
 140         struct privileges_x *prev;
 141         struct privileges_x *next;
 142 } privileges_x;
 143
 144 typedef struct permission_x {
 145         const char *type;
 146         const char *value;
 147         struct permission_x *prev;
 148         struct permission_x *next;
 149 } permission_x;
 150
 151 typedef struct icon_x {
 152         const char *name;
 153         const char *text;
 154         const char *lang;
 155         const char *section;
 156         const char *size;
 157         const char *resolution;
 158         struct icon_x *prev;
 159         struct icon_x *next;
 160 } icon_x;
 161
 162 typedef struct image_x {
 163         const char *name;
 164         const char *text;
 165         const char *lang;
 166         const char *section;
 167         struct image_x *prev;
 168         struct image_x *next;
 169 } image_x;
 170
 171 typedef struct allowed_x {
 172         const char *name;
 173         const char *text;
 174         struct allowed_x *prev;
 175         struct allowed_x *next;
 176 } allowed_x;
 177
 178 typedef struct request_x {
 179         const char *text;
 180         struct request_x *prev;
 181         struct request_x *next;
 182 } request_x;
 183
 184 typedef struct define_x {
 185         const char *path;
 186         struct allowed_x *allowed;
 187         struct request_x *request;
 188         struct define_x *prev;
 189         struct define_x *next;
 190 } define_x;
 191
 192 typedef struct datashare_x {
 193         struct define_x *define;
 194         struct request_x *request;
 195         struct datashare_x *prev;
 196         struct datashare_x *next;
 197 } datashare_x;
 198
 199 typedef struct description_x {
 200         const char *name;
 201         const char *text;
 202         const char *lang;
 203         struct description_x *prev;
 204         struct description_x *next;
 205 } description_x;
 206
 207 typedef struct registry_x {
 208         const char *name;
 209         const char *text;
 210         struct registry_x *prev;
 211         struct registry_x *next;
 212 } registry_x;
 213
 214 typedef struct database_x {
 215         const char *name;
 216         const char *text;
 217         struct database_x *prev;
 218         struct database_x *next;
 219 } database_x;
 220
 221 typedef struct layout_x {
 222         const char *name;
 223         const char *text;
 224         struct layout_x *prev;
 225         struct layout_x *next;
 226 } layout_x;
 227
 228 typedef struct label_x {
 229         const char *name;
 230         const char *text;
 231         const char *lang;
 232         struct label_x *prev;
 233         struct label_x *next;
 234 } label_x;
 235
 236 typedef struct author_x {
 237         const char *email;
 238         const char *href;
 239         const char *text;
 240         const char *lang;
 241         struct author_x *prev;
 242         struct author_x *next;
 243 } author_x;
 244
 245 typedef struct license_x {
 246         const char *text;
 247         const char *lang;
 248         struct license_x *prev;
 249         struct license_x *next;
 250 } license_x;
 251
 252 typedef struct operation_x {
 253         const char *name;
 254         const char *text;
 255         struct operation_x *prev;
 256         struct operation_x *next;
 257 } operation_x;
 258
 259 typedef struct uri_x {
 260         const char *name;
 261         const char *text;
 262         struct uri_x *prev;
 263         struct uri_x *next;
 264 } uri_x;
 265
 266 typedef struct mime_x {
 267         const char *name;
 268         const char *text;
 269         struct mime_x *prev;
 270         struct mime_x *next;
 271 } mime_x;
 272
 273 typedef struct subapp_x {
 274         const char *name;
 275         const char *text;
 276         struct subapp_x *prev;
 277         struct subapp_x *next;
 278 } subapp_x;
 279
 280 typedef struct condition_x {
 281         const char *name;
 282         const char *text;
 283         struct condition_x *prev;
 284         struct condition_x *next;
 285 } condition_x;
 286
 287 typedef struct notification_x {
 288         const char *name;
 289         const char *text;
 290         struct notification_x *prev;
 291         struct notification_x *next;
 292 } notification_x;
 293
 294 typedef struct appsvc_x {
 295         const char *text;
 296         struct operation_x *operation;
 297         struct uri_x *uri;
 298         struct mime_x *mime;
 299         struct subapp_x *subapp;
 300         struct appsvc_x *prev;
 301         struct appsvc_x *next;
 302 } appsvc_x;
 303
 304 typedef struct appcontrol_x {
 305         const char *text;
 306         struct operation_x *operation;
 307         struct uri_x *uri;
 308         struct mime_x *mime;
 309         struct subapp_x *subapp;
 310         struct appcontrol_x *prev;
 311         struct appcontrol_x *next;
 312 } appcontrol_x;
 313
 314 typedef struct category_x{
 315         const char *name;
 316         struct category_x *prev;
 317         struct category_x *next;
 318 } category_x;
 319
 320 typedef struct launchconditions_x {
 321         const char *text;
 322         struct condition_x *condition;
 323         struct launchconditions_x *prev;
 324         struct launchconditions_x *next;
 325 } launchconditions_x;
 326
 327 typedef struct compatibility_x {
 328         const char *name;
 329         const char *text;
 330         struct compatibility_x *prev;
 331         struct compatibility_x *next;
 332 }compatibility_x;
 333
 334 typedef struct deviceprofile_x {
 335         const char *name;
 336         const char *text;
 337         struct deviceprofile_x *prev;
 338         struct deviceprofile_x *next;
 339 }deviceprofile_x;
 340
 341 typedef struct resolution_x {
 342         const char *mimetype;
 343         const char *urischeme;
 344         struct resolution_x *prev;
 345         struct resolution_x *next;
 346 } resolution_x;
 347
 348 typedef struct capability_x {
 349         const char *operationid;
 350         const char *access;
 351         struct resolution_x *resolution;
 352         struct capability_x *prev;
 353         struct capability_x *next;
 354 } capability_x;
 355
 356 typedef struct datacontrol_x {
 357         const char *providerid;
 358         const char *access;
 359         const char *type;
 360         struct datacontrol_x *prev;
 361         struct datacontrol_x *next;
 362 } datacontrol_x;
 363
 364 typedef struct uiapplication_x {
 365         const char *appid;
 366         const char *exec;
 367         const char *nodisplay;
 368         const char *multiple;
 369         const char *taskmanage;
 370         const char *enabled;
 371         const char *type;
 372         const char *categories;
 373         const char *extraid;
 374         const char *hwacceleration;
 375         const char *screenreader;
 376         const char *mainapp;
 377         const char *package;
 378         const char *recentimage;
 379         const char *launchcondition;
 380         const char *indicatordisplay;
 381         const char *portraitimg;
 382         const char *landscapeimg;
 383         const char *guestmode_visibility;
 384         const char *app_component;
 385         const char *permission_type;
 386         const char *component_type;
 387         const char *preload;
 388         const char *submode;
 389         const char *submode_mainid;
 390         const char *launch_mode;
 391         struct label_x *label;
 392         struct icon_x *icon;
 393         struct image_x *image;
 394         struct appsvc_x *appsvc;
 395         struct appcontrol_x *appcontrol;
 396         struct category_x *category;
 397         struct metadata_x *metadata;
 398         struct permission_x *permission;
 399         struct launchconditions_x *launchconditions;
 400         struct notification_x *notification;
 401         struct datashare_x *datashare;
 402         struct datacontrol_x *datacontrol;
 403         struct uiapplication_x *prev;
 404         struct uiapplication_x *next;
 405
 406 } uiapplication_x;
 407
 408 typedef struct serviceapplication_x {
 409         const char *appid;
 410         const char *exec;
 411         const char *onboot;
 412         const char *autorestart;
 413         const char *enabled;
 414         const char *type;
 415         const char *package;
 416         const char *permission_type;
 417         struct label_x *label;
 418         struct icon_x *icon;
 419         struct appsvc_x *appsvc;
 420         struct appcontrol_x *appcontrol;
 421         struct category_x *category;
 422         struct metadata_x *metadata;
 423         struct permission_x *permission;
 424         struct datacontrol_x *datacontrol;
 425         struct launchconditions_x *launchconditions;
 426         struct notification_x *notification;
 427         struct datashare_x *datashare;
 428         struct serviceapplication_x *prev;
 429         struct serviceapplication_x *next;
 430 } serviceapplication_x;
 431
 432 typedef struct daemon_x {
 433         const char *name;
 434         const char *text;
 435         struct daemon_x *prev;
 436         struct daemon_x *next;
 437 } daemon_x;
 438
 439 typedef struct theme_x {
 440         const char *name;
 441         const char *text;
 442         struct theme_x *prev;
 443         struct theme_x *next;
 444 } theme_x;
 445
 446 typedef struct font_x {
 447         const char *name;
 448         const char *text;
 449         struct font_x *prev;
 450         struct font_x *next;
 451 } font_x;
 452
 453 typedef struct ime_x {
 454         const char *name;
 455         const char *text;
 456         struct ime_x *prev;
 457         struct ime_x *next;
 458 } ime_x;
 459
 460 typedef struct manifest_x {
 461         const char *for_all_users;              /**< Flag that indicates if the package is available for everyone or for current user only*/
 462         const char *package;            /**< package name*/
 463         const char *version;            /**< package version*/
 464         const char *installlocation;            /**< package install location*/
 465         const char *ns;         /**<name space*/
 466         const char *removable;          /**< package removable flag*/
 467         const char *preload;            /**< package preload flag*/
 468         const char *readonly;           /**< package readonly flag*/
 469         const char *update;                     /**< package update flag*/
 470         const char *appsetting;         /**< package app setting flag*/
 471         const char *system;             /**< package system flag*/
 472         const char *type;               /**< package type*/
 473         const char *package_size;               /**< package size for external installation*/
 474         const char *installed_time;             /**< installed time after finishing of installation*/
 475         const char *installed_storage;          /**< package currently installed storage*/
 476         const char *storeclient_id;             /**< id of store client for installed package*/
 477         const char *mainapp_id;         /**< app id of main application*/
 478         const char *package_url;                /**< app id of main application*/
 479         const char *root_path;          /**< package root path*/
 480         const char *csc_path;           /**< package csc path*/
 481         const char *nodisplay_setting;          /**< package no display setting menu*/
 482         const char *main_package;               /**< main package id for sub-package(ug)*/
 483         struct icon_x *icon;            /**< package icon*/
 484         struct label_x *label;          /**< package label*/
 485         struct author_x *author;                /**< package author*/
 486         struct description_x *description;              /**< package description*/
 487         struct license_x *license;              /**< package license*/
 488         struct privileges_x *privileges;        /**< package privileges*/
 489         struct uiapplication_x *uiapplication;          /**< package's ui application*/
 490         struct serviceapplication_x *serviceapplication;                /**< package's service application*/
 491         struct daemon_x *daemon;                /**< package daemon*/
 492         struct theme_x *theme;          /**< package theme*/
 493         struct font_x *font;            /**< package font*/
 494         struct ime_x *ime;              /**< package ime*/
 495         struct compatibility_x *compatibility;          /**< package compatibility*/
 496         struct deviceprofile_x *deviceprofile;          /**< package device profile*/
 497 } manifest_x;
 498
 499 /*enum uid_value {
 500         ROOT,
 501         GLOBAL,
 502         USER
 503 };*/
 504
 505 /**uid check
 506  *
 507  */
 508 /* int check_uid(uid_t uid)
 509  {
 510          switch(uid)
 511          {
 512                 case GLOBAL_USER: return GLOBAL;
 513                 case 0: return ROOT;
 514                 default: goto user; break;
 515         }
 516 user:
 517 cf getdbpath
 518 */
 519
 520
 521 /**
 522  * @fn char *pkgmgr_parser_get_manifest_file(const char *pkgid)
 523  * @brief       This API gets the manifest file of the package.
 524  *
 525  * @par         This API is for package-manager installer backends.
 526  * @par Sync (or) Async : Synchronous API
 527  *
 528  * @param[in]   pkgid   pointer to package ID
 529  * @return      manifest file path on success, NULL on failure
 530  * @pre         None
 531  * @post                Free the manifest file pointer that is returned by API
 532  * @code
 533 static int get_manifest_file(const char *pkgid)
 534 {
 535         char *manifest = NULL;
 536         manifest = pkgmgr_parser_get_manifest_file(pkgid);
 537         if (manifest == NULL)
 538                 return -1;
 539         printf("Manifest File Path is %s\n", manifest);
 540         free(manifest);
 541         return 0;
 542 }
 543  * @endcode
 544  */
 545 char *pkgmgr_parser_get_manifest_file(const char *pkgid);
 546 char *pkgmgr_parser_get_usr_manifest_file(const char *pkgid, uid_t uid);
 547
 548 /**
 549  * @fn int pkgmgr_parser_parse_manifest_for_installation(const char *manifest, char *const tagv[])
 550  * @fn int pkgmgr_parser_parse_usr_manifest_for_installation(const char *manifest, uid_t uid, char *const tagv[])
 551  * @brief       This API parses the manifest file of the package after installation and stores the data in DB.
 552  *
 553  * @par         This API is for package-manager installer backends.
 554  * @par Sync (or) Async : Synchronous API
 555  *
 556  * @param[in]   manifest        pointer to package manifest file
 557  * @param[in]   uid     the addressee user id of the instruction
 558  * @param[in]   tagv            array of xml tags or NULL
 559  * @return      0 if success, error code(<0) if fail
 560  * @retval      PMINFO_R_OK     success
 561  * @retval      PMINFO_R_EINVAL invalid argument
 562  * @retval      PMINFO_R_ERROR  internal error
 563  * @pre         None
 564  * @post                None
 565  * @code
 566 static int parse_manifest_file_for_installation(const char *manifest)
 567 {
 568         int ret = 0;
 569         ret = pkgmgr_parser_parse_manifest_for_installation(manifest, NULL);
 570         if (ret)
 571                 return -1;
 572         return 0;
 573 }
 574  * @endcode
 575  */
 576 int pkgmgr_parser_parse_manifest_for_installation(const char *manifest, char *const tagv[]);
 577 int pkgmgr_parser_parse_usr_manifest_for_installation(const char *manifest, uid_t uid, char *const tagv[]);
 578
 579 /**
 580  * @fn int pkgmgr_parser_parse_usr_manifest_for_upgrade(const char *manifest,  uid_t uid, char *const tagv[])
 581  * @fn int pkgmgr_parser_parse_manifest_for_upgrade(const char *manifest, char *const tagv[])
 582  * @brief       This API parses the manifest file of the package after upgrade and stores the data in DB.
 583  *
 584  * @par         This API is for package-manager installer backends.
 585  * @par Sync (or) Async : Synchronous API
 586  *
 587  * @param[in]   manifest        pointer to package manifest file
 588  * @param[in]   uid     the addressee user id of the instruction
 589  * @param[in]   tagv            array of xml tags or NULL
 590  * @return      0 if success, error code(<0) if fail
 591  * @retval      PMINFO_R_OK     success
 592  * @retval      PMINFO_R_EINVAL invalid argument
 593  * @retval      PMINFO_R_ERROR  internal error
 594  * @pre         None
 595  * @post                None
 596  * @code
 597 static int parse_manifest_file_for_upgrade(const char *manifest)
 598 {
 599         int ret = 0;
 600         ret = pkgmgr_parser_parse_manifest_for_upgrade(manifest, NULL);
 601         if (ret)
 602                 return -1;
 603         return 0;
 604 }
 605  * @endcode
 606  */
 607 int pkgmgr_parser_parse_manifest_for_upgrade(const char *manifest, char *const tagv[]);
 608 int pkgmgr_parser_parse_usr_manifest_for_upgrade(const char *manifest, uid_t uid, char *const tagv[]);
 609 /**
 610  * @fn int pkgmgr_parser_parse_manifest_for_uninstallation(const char *manifest, char *const tagv[])
 611  * @fn int pkgmgr_parser_parse_usr_manifest_for_uninstallation(const char *manifest, uid_t uid, char *const tagv[])
 612  * @brief       This API parses the manifest file of the package after uninstallation and deletes the data from DB.
 613  *
 614  * @par         This API is for package-manager installer backends.
 615  * @par Sync (or) Async : Synchronous API
 616  *
 617  * @param[in]   manifest        pointer to package manifest file
 618  * @param[in]   uid     the addressee user id of the instruction
 619  * @param[in]   tagv            array of xml tags or NULL
 620  * @return      0 if success, error code(<0) if fail
 621  * @retval      PMINFO_R_OK     success
 622  * @retval      PMINFO_R_EINVAL invalid argument
 623  * @retval      PMINFO_R_ERROR  internal error
 624  * @pre         None
 625  * @post                None
 626  * @code
 627 static int parse_manifest_file_for_uninstallation(const char *manifest)
 628 {
 629         int ret = 0;
 630         ret = pkgmgr_parser_parse_manifest_for_uninstallation(manifest, NULL);
 631         if (ret)
 632                 return -1;
 633         return 0;
 634 }
 635  * @endcode
 636  */
 637 int pkgmgr_parser_parse_manifest_for_uninstallation(const char *manifest, char *const tagv[]);
 638 int pkgmgr_parser_parse_usr_manifest_for_uninstallation(const char *manifest, uid_t uid, char *const tagv[]);
 639 /**
 640  * @fn int pkgmgr_parser_parse_manifest_for_preload()
 641  * @fn int pkgmgr_parser_parse_usr_manifest_for_preload(uid_t uid)
 642  * @brief       This API update  preload information to DB.
 643  *
 644  * @par         This API is for package-manager installer backends.
 645  * @par Sync (or) Async : Synchronous API
 646  *
 647  * @return      0 if success, error code(<0) if fail
 648  * @retval      PMINFO_R_OK     success
 649  * @retval      PMINFO_R_EINVAL invalid argument
 650  * @retval      PMINFO_R_ERROR  internal error
 651  * @pre         None
 652  * @post                None
 653  * @code
 654 static int parser_parse_manifest_for_preload()
 655 {
 656         int ret = 0;
 657         ret = pkgmgr_parser_parse_manifest_for_preload();
 658         if (ret)
 659                 return -1;
 660         return 0;
 661 }
 662  * @endcode
 663  */
 664 int pkgmgr_parser_parse_manifest_for_preload();
 665 int pkgmgr_parser_parse_usr_manifest_for_preload(uid_t uid);
 666
 667 /**
 668  * @fn int pkgmgr_parser_check_manifest_validation(const char *manifest)
 669  * @brief       This API validates the manifest file against the manifest schema.
 670  *
 671  * @par         This API is for package-manager installer backends.
 672  * @par Sync (or) Async : Synchronous API
 673  *
 674  * @param[in]   manifest        pointer to package manifest file
 675  * @return      0 if success, error code(<0) if fail
 676  * @retval      PMINFO_R_OK     success
 677  * @retval      PMINFO_R_EINVAL invalid argument
 678  * @retval      PMINFO_R_ERROR  internal error
 679  * @pre         None
 680  * @post                None
 681  * @code
 682 static int validate_manifest_file(const char *manifest)
 683 {
 684         int ret = 0;
 685         ret = pkgmgr_parser_check_manifest_validation(manifest);
 686         if (ret)
 687                 return -1;
 688         return 0;
 689 }
 690  * @endcode
 691  */
 692 int pkgmgr_parser_check_manifest_validation(const char *manifest);
 693
 694 /**
 695  * @fn void pkgmgr_parser_free_manifest_xml(manifest_x *mfx)
 696  * @brief       This API will free the manifest pointer by recursively freeing all sub elements.
 697  *
 698  * @par         This API is for package-manager installer backends.
 699  * @par Sync (or) Async : Synchronous API
 700  *
 701  * @param[in]   mfx     pointer to parsed manifest data
 702  * @pre         pkgmgr_parser_process_manifest_xml()
 703  * @post                None
 704  * @code
 705 static int parse_manifest_file(const char *manifest)
 706 {
 707         manifest_x *mfx = NULL
 708         mfx = pkgmgr_parser_process_manifest_xml(manifest);
 709         if (mfx == NULL)
 710                 return -1;
 711         printf("Parsing Manifest Success\n");
 712         pkgmgr_parser_free_manifest_xml(mfx);
 713         return 0;
 714 }
 715  * @endcode
 716  */
 717 void pkgmgr_parser_free_manifest_xml(manifest_x *mfx);
 718
 719 /**
 720  * @fn manifest_x *pkgmgr_parser_process_manifest_xml(const char *manifest)
 721  * @fn manifest_x *pkgmgr_parser_usr_process_manifest_xml(const char *manifest, uid_t uid)
 722  * @brief       This API parses the manifest file and stores all the data in the manifest structure.
 723  *
 724  * @par         This API is for package-manager installer backends.
 725  * @par Sync (or) Async : Synchronous API
 726  *
 727  * @param[in]   manifest        pointer to package manifest file
 728  * @param[in]   uid     the addressee user id of the instruction
 729  * @return      manifest pointer on success, NULL on failure
 730  * @pre         None
 731  * @post                pkgmgr_parser_free_manifest_xml()
 732  * @code
 733 static int parse_manifest_file(const char *manifest)
 734 {
 735         manifest_x *mfx = NULL
 736         mfx = pkgmgr_parser_process_manifest_xml(manifest);
 737         if (mfx == NULL)
 738                 return -1;
 739         printf("Parsing Manifest Success\n");
 740         pkgmgr_parser_free_manifest_xml(mfx);
 741         return 0;
 742 }
 743  * @endcode
 744  */
 745 manifest_x *pkgmgr_parser_process_manifest_xml(const char *manifest);
 746 manifest_x *pkgmgr_parser_usr_process_manifest_xml(const char *manifest, uid_t uid);
 747
 748 /**
 749  * @fn int pkgmgr_parser_run_parser_for_installation(xmlDocPtr docPtr, const char *tag, const char *pkgid)
 750  * @brief       This API calls the parser directly by supplying the xml docptr. It is used during package installation
 751  *
 752  * @par         This API is for package-manager installer backends.
 753  * @par Sync (or) Async : Synchronous API
 754  *
 755  * @param[in]   docPtr  XML doxument pointer
 756  * @param[in]   tag             the xml tag corresponding to the parser that will parse the docPtr
 757  * @param[in]   pkgid           the package id
 758  * @return      0 if success, error code(<0) if fail
 759  * @retval      PMINFO_R_OK     success
 760  * @retval      PMINFO_R_EINVAL invalid argument
 761  * @retval      PMINFO_R_ERROR  internal error
 762  * @pre         None
 763  * @post                None
 764  * @code
 765 static int parse_docptr_for_installation(xmlDocPtr docPtr)
 766 {
 767         int ret = 0;
 768         ret = pkgmgr_parser_run_parser_for_installation(docPtr, "theme", "com.samsung.test");
 769         if (ret)
 770                 return -1;
 771         return 0;
 772 }
 773  * @endcode
 774  */
 775 int pkgmgr_parser_run_parser_for_installation(xmlDocPtr docPtr, const char *tag, const char *pkgid);
 776
 777 /**
 778  * @fn int pkgmgr_parser_run_parser_for_upgrade(xmlDocPtr docPtr, const char *tag, const char *pkgid)
 779  * @brief       This API calls the parser directly by supplying the xml docptr. It is used during package upgrade
 780  *
 781  * @par         This API is for package-manager installer backends.
 782  * @par Sync (or) Async : Synchronous API
 783  *
 784  * @param[in]   docPtr  XML doxument pointer
 785  * @param[in]   tag             the xml tag corresponding to the parser that will parse the docPtr
 786  * @param[in]   pkgid           the package id
 787  * @return      0 if success, error code(<0) if fail
 788  * @retval      PMINFO_R_OK     success
 789  * @retval      PMINFO_R_EINVAL invalid argument
 790  * @retval      PMINFO_R_ERROR  internal error
 791  * @pre         None
 792  * @post                None
 793  * @code
 794 static int parse_docptr_for_upgrade(xmlDocPtr docPtr)
 795 {
 796         int ret = 0;
 797         ret = pkgmgr_parser_run_parser_for_upgrade(docPtr, "theme", "com.samsung.test");
 798         if (ret)
 799                 return -1;
 800         return 0;
 801 }
 802  * @endcode
 803  */
 804 int pkgmgr_parser_run_parser_for_upgrade(xmlDocPtr docPtr, const char *tag, const char *pkgid);
 805
 806 /**
 807  * @fn int pkgmgr_parser_run_parser_for_uninstallation(xmlDocPtr docPtr, const char *tag, const char *pkgid)
 808  * @brief       This API calls the parser directly by supplying the xml docptr. It is used during package uninstallation
 809  *
 810  * @par         This API is for package-manager installer backends.
 811  * @par Sync (or) Async : Synchronous API
 812  *
 813  * @param[in]   docPtr  XML doxument pointer
 814  * @param[in]   tag             the xml tag corresponding to the parser that will parse the docPtr
 815  * @param[in]   pkgid           the package id
 816  * @return      0 if success, error code(<0) if fail
 817  * @retval      PMINFO_R_OK     success
 818  * @retval      PMINFO_R_EINVAL invalid argument
 819  * @retval      PMINFO_R_ERROR  internal error
 820  * @pre         None
 821  * @post                None
 822  * @code
 823 static int parse_docptr_for_uninstallation(xmlDocPtr docPtr)
 824 {
 825         int ret = 0;
 826         ret = pkgmgr_parser_run_parser_for_uninstallation(docPtr, "theme", "com.samsung.test");
 827         if (ret)
 828                 return -1;
 829         return 0;
 830 }
 831  * @endcode
 832  */
 833 int pkgmgr_parser_run_parser_for_uninstallation(xmlDocPtr docPtr, const char *tag, const char *pkgid);
 834
 835
 836
 837 /**
 838  * @fn int pkgmgr_parser_create_desktop_file(manifest_x *mfx)
 839  * @fn int pkgmgr_parser_create_usr_desktop_file(manifest_x *mfx, uid_t uid)
 840  * @brief       This API generates the application desktop file
 841  *
 842  * @par         This API is for package-manager installer backends.
 843  * @par Sync (or) Async : Synchronous API
 844  *
 845  * @param[in]   mfx     manifest pointer
 846  * @param[in]   uid     the addressee user id of the instruction
 847  * @return      0 if success, error code(<0) if fail
 848  * @retval      PMINFO_R_OK     success
 849  * @retval      PMINFO_R_EINVAL invalid argument
 850  * @retval      PMINFO_R_ERROR  internal error
 851  * @pre         pkgmgr_parser_process_manifest_xml()
 852  * @post        pkgmgr_parser_free_manifest_xml()
 853  * @code
 854 static int create_desktop_file(char *manifest)
 855 {
 856         int ret = 0;
 857         manifest_x *mfx = NULL;
 858         mfx = pkgmgr_parser_process_manifest_xml(manifest);
 859         ret = pkgmgr_parser_create_desktop_file(mfx);
 860         if (ret)
 861                 return -1;
 862         pkgmgr_parser_free_manifest_xml(mfx);
 863         return 0;
 864 }
 865  * @endcode
 866  */
 867 int pkgmgr_parser_create_desktop_file(manifest_x *mfx);
 868 int pkgmgr_parser_create_usr_desktop_file(manifest_x *mfx, uid_t uid);
 869
 870 /** @} */
 871 #ifdef __cplusplus
 872 }
 873 #endif
 874 #endif                          /* __PKGMGR_PARSER_H__ */