include/pkgmgrinfo_type.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 __PKGMGRINFO_TYPE_H__
  24 #define __PKGMGRINFO_TYPE_H__
  25
  26 #include <sys/types.h>
  27
  28 /* app background category value */
  29 #define APP_BG_CATEGORY_USER_DISABLE_FALSE_VAL          0x00000
  30 #define APP_BG_CATEGORY_USER_DISABLE_TRUE_VAL           0x00001
  31 #define APP_BG_CATEGORY_MEDIA_VAL                       0x00002
  32 #define APP_BG_CATEGORY_DOWNLOAD_VAL                    0x00004
  33 #define APP_BG_CATEGORY_BGNETWORK_VAL                   0x00008
  34 #define APP_BG_CATEGORY_LOCATION_VAL                    0x00010
  35 #define APP_BG_CATEGORY_SENSOR_VAL                      0x00020
  36 #define APP_BG_CATEGORY_IOTCOMM_VAL                     0x00040
  37 #define APP_BG_CATEGORY_SYSTEM_VAL                      0x00080
  38
  39 #define APP_BG_CATEGORY_USER_DISABLE_FALSE_STR          "enable"
  40 #define APP_BG_CATEGORY_USER_DISABLE_TRUE_STR           "disable"
  41 #define APP_BG_CATEGORY_MEDIA_STR                       "media"
  42 #define APP_BG_CATEGORY_DOWNLOAD_STR                    "download"
  43 #define APP_BG_CATEGORY_BGNETWORK_STR                   "background-network"
  44 #define APP_BG_CATEGORY_LOCATION_STR                    "location"
  45 #define APP_BG_CATEGORY_SENSOR_STR                      "sensor"
  46 #define APP_BG_CATEGORY_IOTCOMM_STR                     "iot-communication"
  47 #define APP_BG_CATEGORY_SYSTEM                          "system"
  48
  49 /**
  50  * @brief A type to retrieve uid information from the manifest handle
  51  */
  52 typedef struct {
  53         uid_t uid;
  54 } pkgmgrinfo_uidinfo_t;
  55
  56 /**
  57  * @brief A handle to insert certificate information
  58  */
  59 typedef void *pkgmgrinfo_instcertinfo_h;
  60
  61 /**
  62  * @brief Certificate Types to be used for setting information
  63  */
  64 typedef enum {
  65         PMINFO_SET_AUTHOR_ROOT_CERT = 0,                /**< Author Root Certificate*/
  66         PMINFO_SET_AUTHOR_INTERMEDIATE_CERT = 1,                /**< Author Intermediate Certificate*/
  67         PMINFO_SET_AUTHOR_SIGNER_CERT = 2,              /**< Author Signer Certificate*/
  68         PMINFO_SET_DISTRIBUTOR_ROOT_CERT = 3,           /**< Distributor Root Certificate*/
  69         PMINFO_SET_DISTRIBUTOR_INTERMEDIATE_CERT = 4,           /**< Distributor Intermediate Certificate*/
  70         PMINFO_SET_DISTRIBUTOR_SIGNER_CERT = 5,         /**< Distributor Signer Certificate*/
  71         PMINFO_SET_DISTRIBUTOR2_ROOT_CERT = 6,          /**< End Entity Root Certificate*/
  72         PMINFO_SET_DISTRIBUTOR2_INTERMEDIATE_CERT = 7,          /**< End Entity Intermediate Certificate*/
  73         PMINFO_SET_DISTRIBUTOR2_SIGNER_CERT = 8,                /**< End Entity Signer Certificate*/
  74 } pkgmgrinfo_instcert_type;
  75
  76 typedef enum {
  77         PMINFO_CERT_COMPARE_MATCH,
  78         PMINFO_CERT_COMPARE_MISMATCH,
  79         PMINFO_CERT_COMPARE_LHS_NO_CERT,
  80         PMINFO_CERT_COMPARE_RHS_NO_CERT,
  81         PMINFO_CERT_COMPARE_BOTH_NO_CERT,
  82         PMINFO_CERT_COMPARE_ERROR,
  83 } pkgmgrinfo_cert_compare_result_type_e;
  84
  85 typedef enum {
  86         PMINFO_APPINFO_GET_LABEL = 0x0001,
  87         PMINFO_APPINFO_GET_ICON = 0x0002,
  88         PMINFO_APPINFO_GET_CATEGORY = 0x0004,
  89         PMINFO_APPINFO_GET_APP_CONTROL = 0x0008,
  90         PMINFO_APPINFO_GET_DATA_CONTROL = 0x0010,
  91         PMINFO_APPINFO_GET_METADATA = 0x0020,
  92         PMINFO_APPINFO_GET_SPLASH_SCREEN = 0x0040,
  93         PMINFO_APPINFO_GET_ALL = 0x007F
  94 } pkgmgrinfo_appinfo_get_option;
  95
  96 typedef enum {
  97         PMINFO_PKGINFO_GET_LABEL = 0x0001,
  98         PMINFO_PKGINFO_GET_ICON = 0x0002,
  99         PMINFO_PKGINFO_GET_AUTHOR = 0x0004,
 100         PMINFO_PKGINFO_GET_DESCRIPTION = 0x0008,
 101         PMINFO_PKGINFO_GET_PRIVILEGE = 0x0010,
 102         PMINFO_PKGINFO_GET_ALL = 0x001F
 103 } pkgmgrinfo_pkginfo_get_option;
 104
 105 /**
 106  * @brief API return values
 107  */
 108 enum {
 109         PMINFO_R_ENOENT = -3,           /**< No result */
 110         PMINFO_R_EINVAL = -2,           /**< Invalid argument */
 111         PMINFO_R_ERROR = -1,            /**< General error */
 112         PMINFO_R_OK = 0                 /**< General success */
 113 };
 114
 115 /**
 116  * @brief Value to be used when filtering based on install location
 117  */
 118 #define PMINFO_PKGINFO_INSTALL_LOCATION_AUTO            "LOCATION_AUTO"
 119
 120 /**
 121  * @brief Value to be used when filtering based on install location
 122  */
 123 #define PMINFO_PKGINFO_INSTALL_LOCATION_INTERNAL        "LOCATION_INTERNAL"
 124
 125 /**
 126  * @brief Value to be used when filtering based on install location
 127  */
 128 #define PMINFO_PKGINFO_INSTALL_LOCATION_EXTERNAL        "LOCATION_EXTERNAL"
 129
 130 typedef enum {
 131         PMINFO_HWACCELERATION_OFF = 0,          /**< Don't use hardware acceleration*/
 132         PMINFO_HWACCELERATION_ON = 1,           /**< Use hardware acceleration*/
 133         PMINFO_HWACCELERATION_DEFAULT = 2               /**< Follow system setting for hardware acceleration */
 134 } pkgmgrinfo_app_hwacceleration;
 135
 136 typedef enum {
 137         PMINFO_SCREENREADER_OFF = 0,            /**< Don't use screen reader*/
 138         PMINFO_SCREENREADER_ON = 1,             /**< Use screen reader*/
 139         PMINFO_SCREENREADER_USE_SYSTEM_SETTING = 2              /**< Follow system setting for screen reader */
 140 } pkgmgrinfo_app_screenreader;
 141
 142 typedef enum {
 143         PMINFO_RECENTIMAGE_USE_ICON = 0,                /**<Use icon for recent image*/
 144         PMINFO_RECENTIMAGE_USE_CAPTURE = 1,             /**< Use capture for recent image*/
 145         PMINFO_RECENTIMAGE_USE_NOTHING = 2              /**< Don't use recent image */
 146 } pkgmgrinfo_app_recentimage;
 147
 148 /**
 149  * @brief A handle to get package information
 150  */
 151 typedef void *pkgmgrinfo_pkginfo_h;
 152
 153 /**
 154  * @brief A handle to get application information
 155  */
 156 typedef void *pkgmgrinfo_appinfo_h;
 157
 158 /**
 159  * @brief A handle to get certificate information
 160  */
 161 typedef void *pkgmgrinfo_certinfo_h;
 162
 163 /**
 164  * @brief A handle to filter package information
 165  */
 166 typedef void *pkgmgrinfo_pkginfo_filter_h;
 167
 168 /**
 169  * @brief A handle to filter application information
 170  */
 171 typedef void *pkgmgrinfo_appinfo_filter_h;
 172
 173 /**
 174  * @brief A handle to filter application metadata  information
 175  */
 176 typedef void *pkgmgrinfo_appinfo_metadata_filter_h;
 177
 178 /**
 179  * @brief A handle to get appcontrol information
 180  */
 181 typedef void *pkgmgrinfo_appcontrol_h;
 182
 183 /**
 184  * @brief type definition.
 185  */
 186 typedef void pkgmgrinfo_client;
 187
 188 /**
 189  * @fn int (*pkgmgrinfo_pkg_list_cb) (const pkgmgrinfo_pkginfo_h handle, void *user_data)
 190  *
 191  * @brief Specifies the type of function passed to pkgmgrinfo_pkginfo_get_list(), pkgmgrinfo_pkginfo_filter_foreach_pkginfo()
 192  *
 193  * @param[in] handle the pkginfo handle
 194  * @param[in] user_data user data passed to pkgmgrinfo_pkginfo_get_list(), pkgmgrinfo_pkginfo_filter_foreach_pkginfo()
 195  *
 196  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 197  *
 198  * @see  pkgmgrinfo_pkginfo_get_list()
 199  * @see  pkgmgrinfo_pkginfo_filter_foreach_pkginfo()
 200  */
 201 typedef int (*pkgmgrinfo_pkg_list_cb) (const pkgmgrinfo_pkginfo_h handle,
 202                                                         void *user_data);
 203
 204 /**
 205  * @fn int (*pkgmgrinfo_app_list_cb) (const pkgmgrinfo_appinfo_h handle, void *user_data)
 206  *
 207  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_get_list(), pkgmgrinfo_appinfo_filter_foreach_appinfo(), pkgmgrinfo_appinfo_metadata_filter_foreach()
 208  *
 209  * @param[in] handle the appinfo handle
 210  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_get_list(), pkgmgrinfo_appinfo_filter_foreach_appinfo(), pkgmgrinfo_appinfo_metadata_filter_foreach()
 211  *
 212  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 213  *
 214  * @see  pkgmgrinfo_appinfo_get_list()
 215  * @see  pkgmgrinfo_appinfo_filter_foreach_appinfo()
 216  * @see  pkgmgrinfo_appinfo_metadata_filter_foreach()
 217  */
 218 typedef int (*pkgmgrinfo_app_list_cb) (const pkgmgrinfo_appinfo_h handle,
 219                                                         void *user_data);
 220
 221 /**
 222  * @fn int (*pkgmgrinfo_app_category_list_cb) (const char *category_name, void *user_data)
 223  *
 224  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_category()
 225  *
 226  * @param[in] category_name the name of the category
 227  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_category()
 228  *
 229  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 230  *
 231  * @see  pkgmgrinfo_appinfo_foreach_category()
 232  */
 233 typedef int (*pkgmgrinfo_app_category_list_cb) (const char *category_name,
 234                                                         void *user_data);
 235
 236 /**
 237  * @fn int (*pkgmgrinfo_app_permission_list_cb) (const char *permission_type, void *user_data)
 238  *
 239  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_category()
 240  *
 241  * @param[in] permission_name the name of the permission
 242  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_category()
 243  *
 244  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 245  *
 246  * @see  pkgmgrinfo_appinfo_foreach_category()
 247  */
 248 typedef int (*pkgmgrinfo_app_permission_list_cb) (const char *permission_type,
 249                                                         void *user_data);
 250
 251 /**
 252  * @fn int (*pkgmgrinfo_pkg_privilege_list_cb) (const char *privilege_name, void *user_data)
 253  *
 254  * @brief Specifies the type of function passed to pkgmgrinfo_pkginfo_foreach_privilege()
 255  *
 256  * @param[in] privilege_name the name of the privilege
 257  * @param[in] user_data user data passed to pkgmgrinfo_pkginfo_foreach_privilege()
 258  *
 259  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 260  *
 261  * @see  pkgmgrinfo_pkginfo_foreach_privilege()
 262  */
 263 typedef int (*pkgmgrinfo_pkg_privilege_list_cb) (const char *privilege_name,
 264                                                         void *user_data);
 265
 266 /**
 267  * @fn int (*pkgmgrinfo_app_metadata_list_cb) (const char *metadata_key, const char *metadata_value, void *user_data)
 268  *
 269  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_metadata()
 270  *
 271  * @param[in] metadata_name the name of the metadata
 272  * @param[in] metadata_value the value of the metadata
 273  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_metadata()
 274  *
 275  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 276  *
 277  * @see  pkgmgrinfo_appinfo_foreach_metadata()
 278  */
 279 typedef int (*pkgmgrinfo_app_metadata_list_cb) (const char *metadata_key,
 280                                                         const char *metadata_value, void *user_data);
 281
 282 /**
 283  * @fn int (*pkgmgrinfo_app_control_list_cb) (pkgmgrinfo_appcontrol_h handle, void *user_data)
 284  *
 285  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_appcontrol()
 286  *
 287  * @param[in] handle the appcontrol handle to be used to get operation, uri and mime info
 288  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_appcontrol()
 289  *
 290  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 291  *
 292  * @see  pkgmgrinfo_appinfo_foreach_appcontrol()
 293  */
 294 typedef int (*pkgmgrinfo_app_control_list_cb) (const char *operation, const char *uri, const char *mime,
 295                                                         void *user_data);
 296
 297 /**
 298  * @fn int (*pkgmgrinfo_app_background_category_list_cb) (const char *category_name, void *user_data)
 299  *
 300  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_background_category()
 301  *
 302  * @param[in] category_name retrieved background category name
 303  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_background_category
 304  *
 305  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 306  *
 307  * @see  pkgmgrinfo_appinfo_foreach_background_category()
 308  */
 309 typedef int (*pkgmgrinfo_app_background_category_list_cb) (const char *category_name, void *user_data);
 310
 311 /**
 312  * @fn int (*pkgmgrinfo_app_splash_screen_list_cb)(const char *src,
 313  *              const char *type, const char *orientation,
 314  *              const char *indicatordisplay, const char *color_depth,
 315  *              void *user_data);
 316  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_splash_screen()
 317  *
 318  * @param[in] src the source of the splashscreen
 319  * @param[in] type the type of the splashscreen
 320  * @param[in] orientation the orientation of the splashscreen
 321  * @param[in] indicatordisplay the indicator-display of the splashscreen
 322  * @param[in] operation the app-control operation of the splashscreen
 323  * @param[in] color_depth the color-depth of the splashscreen
 324  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_splash_screen()
 325  *
 326  * @return 0 if success, negative value(<0) if fail, Callback is not called if return value is negative.\n
 327  *
 328  * @see pkgmgrinfo_appinfo_foreach_splash_screen()
 329  */
 330 typedef int (*pkgmgrinfo_app_splash_screen_list_cb)(const char *src,
 331                 const char *type, const char *orientation,
 332                 const char *indicatordisplay, const char *operation,
 333                 const char *color_depth, void *user_data);
 334
 335 typedef int (*pkgmgrinfo_handler)(uid_t target_uid, int req_id, const char *pkg_type,
 336                                 const char *pkgid, const char *key,
 337                                 const char *val, const void *pmsg, void *data);
 338
 339
 340 /**
 341  * @brief Install Location Types
 342  */
 343 typedef enum {
 344         PMINFO_INSTALL_LOCATION_AUTO = 0,               /**< Auto*/
 345         PMINFO_INSTALL_LOCATION_INTERNAL_ONLY,          /**< Internal Installation*/
 346         PMINFO_INSTALL_LOCATION_PREFER_EXTERNAL,                /**< External Installation*/
 347 } pkgmgrinfo_install_location;
 348
 349 /**
 350  * @brief Application Component Types
 351  */
 352 typedef enum {
 353         PMINFO_ALL_APP = 0,     /**< All Application*/
 354         PMINFO_UI_APP,          /**< UI Application*/
 355         PMINFO_SVC_APP,         /**< Service Application*/
 356         PMINFO_WIDGET_APP,      /**< Widget Application*/
 357         PMINFO_WATCH_APP,  /**< Watch Application*/
 358 } pkgmgrinfo_app_component;
 359
 360 /**
 361  * @brief Application Storage Types
 362  */
 363 typedef enum {
 364         PMINFO_INTERNAL_STORAGE = 0,            /**< Internal Storage*/
 365         PMINFO_EXTERNAL_STORAGE = 1,            /**< External Storage*/
 366 } pkgmgrinfo_installed_storage;
 367
 368 /**
 369  * @brief Certificate Types to be used for getting information
 370  */
 371 typedef enum {
 372         PMINFO_AUTHOR_ROOT_CERT = 0,            /**< Author Root Certificate*/
 373         PMINFO_AUTHOR_INTERMEDIATE_CERT = 1,            /**< Author Intermediate Certificate*/
 374         PMINFO_AUTHOR_SIGNER_CERT = 2,          /**< Author Signer Certificate*/
 375         PMINFO_DISTRIBUTOR_ROOT_CERT = 3,               /**< Distributor Root Certificate*/
 376         PMINFO_DISTRIBUTOR_INTERMEDIATE_CERT = 4,               /**< Distributor Intermediate Certificate*/
 377         PMINFO_DISTRIBUTOR_SIGNER_CERT = 5,             /**< Distributor Signer Certificate*/
 378         PMINFO_DISTRIBUTOR2_ROOT_CERT = 6,              /**< End Entity Root Certificate*/
 379         PMINFO_DISTRIBUTOR2_INTERMEDIATE_CERT = 7,              /**< End Entity Intermediate Certificate*/
 380         PMINFO_DISTRIBUTOR2_SIGNER_CERT = 8,            /**< End Entity Signer Certificate*/
 381 } pkgmgrinfo_cert_type;
 382
 383 /**
 384  * @brief Install Location Types to be used when setting data in DB
 385  */
 386 typedef enum {
 387         INSTALL_INTERNAL = 0,           /**< Internal Installation*/
 388         INSTALL_EXTERNAL,               /**< External Installation*/
 389 } INSTALL_LOCATION;
 390
 391  /**
 392   * @brief permission Types
 393   */
 394 typedef enum {
 395         PMINFO_PERMISSION_NORMAL = 0,           /**< permission normal*/
 396         PMINFO_PERMISSION_SIGNATURE,            /**< permission type is signature*/
 397         PMINFO_PERMISSION_PRIVILEGE,            /**< permission type is privilege*/
 398 } pkgmgrinfo_permission_type;
 399
 400 typedef enum {
 401         PMINFO_REQUEST = 0,
 402         PMINFO_LISTENING,
 403         PMINFO_BROADCAST,
 404 } pkgmgrinfo_client_type;
 405
 406 #endif