4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
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>
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
13 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 #ifndef __PKGMGR_PARSER_H__
24 #define __PKGMGR_PARSER_H__
27 * @file pkgmgr_parser.h
28 * @author Sewook Park <sewook7.park@samsung.com>
29 * @author Shobhit Srivastava <shobhit.s@samsung.com>
31 * @brief This file declares API of pkgmgr_parser
32 * @addtogroup APPLICATION_FRAMEWORK
35 * @defgroup PackageManagerParser
36 * @section Header Header file to include:
38 * #include <pkgmgr_parser.h>
44 #include <libxml/xmlreader.h>
46 /* For multi-user support */
47 #include <tzplatform_config.h>
48 #include "pkgmgrinfo_basic.h"
55 #define DEPRECATED __attribute__ ((__deprecated__))
58 #define DEFAULT_LOCALE "No Locale"
60 #define PKG_PARSERLIB "parserlib:"
61 #define PKG_PARSER_CONF_PATH SYSCONFDIR "/package-manager/parser_path.conf"
63 #define PKG_STRING_LEN_MAX 1024
65 #define GLOBAL_USER tzplatform_getuid(TZ_SYS_GLOBALAPP_USER)
68 * @brief Structure which is used by metadata plugin
77 * @brief Structure which is used by category plugin
93 * @brief API return values
96 PM_PARSER_R_EINVAL = -2, /**< Invalid argument */
97 PM_PARSER_R_ERROR = -1, /**< General error */
98 PM_PARSER_R_OK = 0 /**< General success */
102 * @fn int pkgmgr_parser_parse_manifest_for_installation(const char *manifest, char *const tagv[])
103 * @fn int pkgmgr_parser_parse_usr_manifest_for_installation(const char *manifest, uid_t uid, char *const tagv[])
104 * @brief This API parses the manifest file of the package after installation and stores the data in DB.
106 * @par This API is for package-manager installer backends.
107 * @par Sync (or) Async : Synchronous API
109 * @param[in] manifest pointer to package manifest file
110 * @param[in] uid the addressee user id of the instruction
111 * @param[in] tagv array of xml tags or NULL
112 * @return 0 if success, error code(<0) if fail
113 * @retval PMINFO_R_OK success
114 * @retval PMINFO_R_EINVAL invalid argument
115 * @retval PMINFO_R_ERROR internal error
119 static int parse_manifest_file_for_installation(const char *manifest)
122 ret = pkgmgr_parser_parse_manifest_for_installation(manifest, NULL);
129 int pkgmgr_parser_parse_manifest_for_installation(const char *manifest, char *const tagv[]) DEPRECATED;
130 int pkgmgr_parser_parse_usr_manifest_for_installation(const char *manifest, uid_t uid, char *const tagv[]) DEPRECATED;
131 int pkgmgr_parser_process_manifest_x_for_installation(manifest_x* mfx, const char *manifest);
132 int pkgmgr_parser_process_usr_manifest_x_for_installation(manifest_x* mfx, const char *manifest, uid_t uid);
135 * @fn int pkgmgr_parser_update_tep(const char* pkgid, const char * tep_path)
136 * @fn int pkgmgr_parser_usr_update_tep(const char* pkgid, const char* tep_path, uid_t uid)
137 * @brief This API updates tep path information stored in DB.
139 * @par This API is for package-manager installer backends.
140 * @par Sync (or) Async : Synchronous API
142 * @param[in] pkgid pointer to package ID
143 * @param[in]tep_path pointer to path of TEP file
144 * @param[in] uid the addressee user id of the instruction
145 * @return 0 if success, error code(<0) if fail
146 * @retval PMINFO_R_OK success
147 * @retval PMINFO_R_EINVAL invalid argument
148 * @retval PMINFO_R_ERROR internal error
152 static int update_tep_info_for_upgrade(const char *pkgid, const char *tep_path)
155 ret = pkgmgr_parser_update_tep(pkgid, tep_path);
162 int pkgmgr_parser_update_tep(const char* pkgid, const char* tep_path);
163 int pkgmgr_parser_usr_update_tep(const char* pkgid, const char* tep_path, uid_t uid);
166 * @fn int pkgmgr_parser_parse_usr_manifest_for_upgrade(const char *manifest, uid_t uid, char *const tagv[])
167 * @fn int pkgmgr_parser_parse_manifest_for_upgrade(const char *manifest, char *const tagv[])
168 * @brief This API parses the manifest file of the package after upgrade and stores the data in DB.
170 * @par This API is for package-manager installer backends.
171 * @par Sync (or) Async : Synchronous API
173 * @param[in] manifest pointer to package manifest file
174 * @param[in] uid the addressee user id of the instruction
175 * @param[in] tagv array of xml tags or NULL
176 * @return 0 if success, error code(<0) if fail
177 * @retval PMINFO_R_OK success
178 * @retval PMINFO_R_EINVAL invalid argument
179 * @retval PMINFO_R_ERROR internal error
183 static int parse_manifest_file_for_upgrade(const char *manifest)
186 ret = pkgmgr_parser_parse_manifest_for_upgrade(manifest, NULL);
193 int pkgmgr_parser_parse_manifest_for_upgrade(const char *manifest, char *const tagv[]) DEPRECATED;
194 int pkgmgr_parser_parse_usr_manifest_for_upgrade(const char *manifest, uid_t uid, char *const tagv[]) DEPRECATED;
195 int pkgmgr_parser_process_manifest_x_for_upgrade(manifest_x* mfx, const char *manifest);
196 int pkgmgr_parser_process_usr_manifest_x_for_upgrade(manifest_x* mfx, const char *manifest, uid_t uid);
199 * @fn int pkgmgr_parser_parse_manifest_for_uninstallation(const char *manifest, char *const tagv[])
200 * @fn int pkgmgr_parser_parse_usr_manifest_for_uninstallation(const char *manifest, uid_t uid, char *const tagv[])
201 * @brief This API parses the manifest file of the package after uninstallation and deletes the data from DB.
203 * @par This API is for package-manager installer backends.
204 * @par Sync (or) Async : Synchronous API
206 * @param[in] manifest pointer to package manifest file
207 * @param[in] uid the addressee user id of the instruction
208 * @param[in] tagv array of xml tags or NULL
209 * @return 0 if success, error code(<0) if fail
210 * @retval PMINFO_R_OK success
211 * @retval PMINFO_R_EINVAL invalid argument
212 * @retval PMINFO_R_ERROR internal error
216 static int parse_manifest_file_for_uninstallation(const char *manifest)
219 ret = pkgmgr_parser_parse_manifest_for_uninstallation(manifest, NULL);
226 int pkgmgr_parser_parse_manifest_for_uninstallation(const char *manifest, char *const tagv[]) DEPRECATED;
227 int pkgmgr_parser_parse_usr_manifest_for_uninstallation(const char *manifest, uid_t uid, char *const tagv[]) DEPRECATED;
228 int pkgmgr_parser_process_manifest_x_for_uninstallation(manifest_x* mfx, const char *manifest);
229 int pkgmgr_parser_process_usr_manifest_x_for_uninstallation(manifest_x* mfx, const char *manifest, uid_t uid);
232 * @fn int pkgmgr_parser_check_manifest_validation(const char *manifest)
233 * @brief This API validates the manifest file against the manifest schema.
235 * @par This API is for package-manager installer backends.
236 * @par Sync (or) Async : Synchronous API
238 * @param[in] manifest pointer to package manifest file
239 * @return 0 if success, error code(<0) if fail
240 * @retval PMINFO_R_OK success
241 * @retval PMINFO_R_EINVAL invalid argument
242 * @retval PMINFO_R_ERROR internal error
246 static int validate_manifest_file(const char *manifest)
249 ret = pkgmgr_parser_check_manifest_validation(manifest);
256 int pkgmgr_parser_check_manifest_validation(const char *manifest);
259 * @fn void pkgmgr_parser_free_manifest_xml(manifest_x *mfx)
260 * @brief This API will free the manifest pointer by recursively freeing all sub elements.
262 * @par This API is for package-manager installer backends.
263 * @par Sync (or) Async : Synchronous API
265 * @param[in] mfx pointer to parsed manifest data
266 * @pre pkgmgr_parser_process_manifest_xml()
269 static int parse_manifest_file(const char *manifest)
271 manifest_x *mfx = NULL
272 mfx = pkgmgr_parser_process_manifest_xml(manifest);
275 printf("Parsing Manifest Success\n");
276 pkgmgr_parser_free_manifest_xml(mfx);
281 void pkgmgr_parser_free_manifest_xml(manifest_x *mfx);
284 * @fn manifest_x *pkgmgr_parser_process_manifest_xml(const char *manifest)
285 * @fn manifest_x *pkgmgr_parser_usr_process_manifest_xml(const char *manifest, uid_t uid)
286 * @brief This API parses the manifest file and stores all the data in the manifest structure.
288 * @par This API is for package-manager installer backends.
289 * @par Sync (or) Async : Synchronous API
291 * @param[in] manifest pointer to package manifest file
292 * @param[in] uid the addressee user id of the instruction
293 * @return manifest pointer on success, NULL on failure
295 * @post pkgmgr_parser_free_manifest_xml()
297 static int parse_manifest_file(const char *manifest)
299 manifest_x *mfx = NULL
300 mfx = pkgmgr_parser_process_manifest_xml(manifest);
303 printf("Parsing Manifest Success\n");
304 pkgmgr_parser_free_manifest_xml(mfx);
309 manifest_x *pkgmgr_parser_process_manifest_xml(const char *manifest) DEPRECATED;
310 manifest_x *pkgmgr_parser_usr_process_manifest_xml(const char *manifest, uid_t uid) DEPRECATED;
316 #endif /* __PKGMGR_PARSER_H__ */