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 /**
  86  * @brief API return values
  87  */
  88 enum {
  89         PMINFO_R_ENOENT = -3,           /**< No result */
  90         PMINFO_R_EINVAL = -2,           /**< Invalid argument */
  91         PMINFO_R_ERROR = -1,            /**< General error */
  92         PMINFO_R_OK = 0                 /**< General success */
  93 };
  94
  95 /**
  96  * @brief Value to be used when filtering based on install location
  97  */
  98 #define PMINFO_PKGINFO_INSTALL_LOCATION_AUTO            "LOCATION_AUTO"
  99
 100 /**
 101  * @brief Value to be used when filtering based on install location
 102  */
 103 #define PMINFO_PKGINFO_INSTALL_LOCATION_INTERNAL        "LOCATION_INTERNAL"
 104
 105 /**
 106  * @brief Value to be used when filtering based on install location
 107  */
 108 #define PMINFO_PKGINFO_INSTALL_LOCATION_EXTERNAL        "LOCATION_EXTERNAL"
 109
 110 /**
 111  * @brief Value to be used when filtering based on app-component
 112  */
 113 #define PMINFO_APPINFO_UI_APP                           "UI_APP"
 114
 115 /**
 116  * @brief Value to be used when filtering based on app-component
 117  */
 118 #define PMINFO_APPINFO_SVC_APP                          "SVC_APP"
 119
 120 typedef enum {
 121         PMINFO_HWACCELERATION_NOT_USE_GL = 0,           /**< Don't use hardware acceleration*/
 122         PMINFO_HWACCELERATION_USE_GL = 1,               /**< Use hardware acceleration*/
 123         PMINFO_HWACCELERATION_USE_SYSTEM_SETTING = 2            /**< Follow system setting for hardware acceleration */
 124 }pkgmgrinfo_app_hwacceleration;
 125
 126 typedef enum {
 127         PMINFO_SCREENREADER_OFF = 0,            /**< Don't use screen reader*/
 128         PMINFO_SCREENREADER_ON = 1,             /**< Use screen reader*/
 129         PMINFO_SCREENREADER_USE_SYSTEM_SETTING = 2              /**< Follow system setting for screen reader */
 130 }pkgmgrinfo_app_screenreader;
 131
 132 typedef enum {
 133         PMINFO_RECENTIMAGE_USE_ICON = 0,                /**<Use icon for recent image*/
 134         PMINFO_RECENTIMAGE_USE_CAPTURE = 1,             /**< Use capture for recent image*/
 135         PMINFO_RECENTIMAGE_USE_NOTHING = 2              /**< Don't use recent image */
 136 }pkgmgrinfo_app_recentimage;
 137
 138 /**
 139  * @brief A handle to get package information
 140  */
 141 typedef void* pkgmgrinfo_pkginfo_h;
 142
 143 /**
 144  * @brief A handle to get application information
 145  */
 146 typedef void* pkgmgrinfo_appinfo_h;
 147
 148 /**
 149  * @brief A handle to get certificate information
 150  */
 151 typedef void* pkgmgrinfo_certinfo_h;
 152
 153 /**
 154  * @brief A handle to filter package information
 155  */
 156 typedef void* pkgmgrinfo_pkginfo_filter_h;
 157
 158 /**
 159  * @brief A handle to filter application information
 160  */
 161 typedef void* pkgmgrinfo_appinfo_filter_h;
 162
 163 /**
 164  * @brief A handle to filter application metadata  information
 165  */
 166 typedef void* pkgmgrinfo_appinfo_metadata_filter_h;
 167
 168 /**
 169  * @brief A handle to get appcontrol information
 170  */
 171 typedef void* pkgmgrinfo_appcontrol_h;
 172
 173 /**
 174  * @brief type definition.
 175  */
 176 typedef void pkgmgrinfo_client;
 177
 178 /**
 179  * @fn int (*pkgmgrinfo_pkg_list_cb ) (const pkgmgrinfo_pkginfo_h handle, void *user_data)
 180  *
 181  * @brief Specifies the type of function passed to pkgmgrinfo_pkginfo_get_list(), pkgmgrinfo_pkginfo_filter_foreach_pkginfo()
 182  *
 183  * @param[in] handle the pkginfo handle
 184  * @param[in] user_data user data passed to pkgmgrinfo_pkginfo_get_list(), pkgmgrinfo_pkginfo_filter_foreach_pkginfo()
 185  *
 186  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 187  *
 188  * @see  pkgmgrinfo_pkginfo_get_list()
 189  * @see  pkgmgrinfo_pkginfo_filter_foreach_pkginfo()
 190  */
 191 typedef int (*pkgmgrinfo_pkg_list_cb ) (const pkgmgrinfo_pkginfo_h handle,
 192                                                         void *user_data);
 193
 194 /**
 195  * @fn int (*pkgmgrinfo_app_list_cb ) (const pkgmgrinfo_appinfo_h handle, void *user_data)
 196  *
 197  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_get_list(), pkgmgrinfo_appinfo_filter_foreach_appinfo(), pkgmgrinfo_appinfo_metadata_filter_foreach()
 198  *
 199  * @param[in] handle the appinfo handle
 200  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_get_list(), pkgmgrinfo_appinfo_filter_foreach_appinfo(), pkgmgrinfo_appinfo_metadata_filter_foreach()
 201  *
 202  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 203  *
 204  * @see  pkgmgrinfo_appinfo_get_list()
 205  * @see  pkgmgrinfo_appinfo_filter_foreach_appinfo()
 206  * @see  pkgmgrinfo_appinfo_metadata_filter_foreach()
 207  */
 208 typedef int (*pkgmgrinfo_app_list_cb ) (const pkgmgrinfo_appinfo_h handle,
 209                                                         void *user_data);
 210
 211 /**
 212  * @fn int (*pkgmgrinfo_app_category_list_cb ) (const char *category_name, void *user_data)
 213  *
 214  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_category()
 215  *
 216  * @param[in] category_name the name of the category
 217  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_category()
 218  *
 219  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 220  *
 221  * @see  pkgmgrinfo_appinfo_foreach_category()
 222  */
 223 typedef int (*pkgmgrinfo_app_category_list_cb ) (const char *category_name,
 224                                                         void *user_data);
 225
 226 /**
 227  * @fn int (*pkgmgrinfo_app_permission_list_cb ) (const char *permission_type, void *user_data)
 228  *
 229  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_category()
 230  *
 231  * @param[in] permission_name the name of the permission
 232  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_category()
 233  *
 234  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 235  *
 236  * @see  pkgmgrinfo_appinfo_foreach_category()
 237  */
 238 typedef int (*pkgmgrinfo_app_permission_list_cb ) (const char *permission_type,
 239                                                         void *user_data);
 240
 241 /**
 242  * @fn int (*pkgmgrinfo_pkg_privilege_list_cb ) (const char *privilege_name, void *user_data)
 243  *
 244  * @brief Specifies the type of function passed to pkgmgrinfo_pkginfo_foreach_privilege()
 245  *
 246  * @param[in] privilege_name the name of the privilege
 247  * @param[in] user_data user data passed to pkgmgrinfo_pkginfo_foreach_privilege()
 248  *
 249  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 250  *
 251  * @see  pkgmgrinfo_pkginfo_foreach_privilege()
 252  */
 253 typedef int (*pkgmgrinfo_pkg_privilege_list_cb ) (const char *privilege_name,
 254                                                         void *user_data);
 255
 256 /**
 257  * @fn int (*pkgmgrinfo_app_metadata_list_cb ) (const char *metadata_key, const char *metadata_value, void *user_data)
 258  *
 259  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_metadata()
 260  *
 261  * @param[in] metadata_name the name of the metadata
 262  * @param[in] metadata_value the value of the metadata
 263  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_metadata()
 264  *
 265  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 266  *
 267  * @see  pkgmgrinfo_appinfo_foreach_metadata()
 268  */
 269 typedef int (*pkgmgrinfo_app_metadata_list_cb ) (const char *metadata_key,
 270                                                         const char *metadata_value, void *user_data);
 271
 272 /**
 273  * @fn int (*pkgmgrinfo_app_control_list_cb ) (pkgmgrinfo_appcontrol_h handle, void *user_data)
 274  *
 275  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_appcontrol()
 276  *
 277  * @param[in] handle the appcontrol handle to be used to get operation, uri and mime info
 278  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_appcontrol()
 279  *
 280  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 281  *
 282  * @see  pkgmgrinfo_appinfo_foreach_appcontrol()
 283  */
 284 typedef int (*pkgmgrinfo_app_control_list_cb ) (const char *operation, const char *uri, const char *mime,
 285                                                         void *user_data);
 286
 287 /**
 288  * @fn int (*pkgmgrinfo_app_background_category_list_cb ) (const char *category_name, void *user_data)
 289  *
 290  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_background_category()
 291  *
 292  * @param[in] category_name retrieved background category name
 293  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_background_category
 294  *
 295  * @return 0 if success, negative value(<0) if fail. Callback is not called if return value is negative.\n
 296  *
 297  * @see  pkgmgrinfo_appinfo_foreach_background_category()
 298  */
 299 typedef int (*pkgmgrinfo_app_background_category_list_cb ) (const char *category_name, void *user_data);
 300
 301 /**
 302  * @fn int (*pkgmgrinfo_app_splash_screen_list_cb) (const char *src,
 303  *              const char *type, const char *orientation,
 304  *              const char *indicatordisplay, void *user_data);
 305  * @brief Specifies the type of function passed to pkgmgrinfo_appinfo_foreach_splash_screen()
 306  *
 307  * @param[in] src the source of the splashscreen
 308  * @param[in] type the type of the splashscreen
 309  * @param[in] orientation the orientation of the splashscreen
 310  * @param[in] indicatordisplay the indicator-display of the splashscreen
 311  * @param[in] operation the app-control operation of the splashscreen
 312  * @param[in] user_data user data passed to pkgmgrinfo_appinfo_foreach_splash_screen()
 313  *
 314  * @return 0 if success, negative value(<0) if fail, Callback is not called if return value is negative.\n
 315  *
 316  * @see pkgmgrinfo_appinfo_foreach_splash_screen()
 317  */
 318 typedef int (*pkgmgrinfo_app_splash_screen_list_cb) (const char *src,
 319                 const char *type, const char *orientation,
 320                 const char *indicatordisplay, const char *operation,
 321                 void *user_data);
 322
 323 typedef int (*pkgmgrinfo_handler)(uid_t target_uid, int req_id, const char *pkg_type,
 324                                 const char *pkgid, const char *key,
 325                                 const char *val, const void *pmsg, void *data);
 326
 327
 328 /**
 329  * @brief Install Location Types
 330  */
 331 typedef enum {
 332         PMINFO_INSTALL_LOCATION_AUTO = 0,               /**< Auto*/
 333         PMINFO_INSTALL_LOCATION_INTERNAL_ONLY,          /**< Internal Installation*/
 334         PMINFO_INSTALL_LOCATION_PREFER_EXTERNAL,                /**< External Installation*/
 335 } pkgmgrinfo_install_location;
 336
 337 /**
 338  * @brief Application Component Types
 339  */
 340 typedef enum {
 341         PMINFO_ALL_APP = 0,     /**< All Application*/
 342         PMINFO_UI_APP,          /**< UI Application*/
 343         PMINFO_SVC_APP,         /**< Service Application*/
 344         PMINFO_WIDGET_APP,      /**< Widget Application*/
 345 } pkgmgrinfo_app_component;
 346
 347 /**
 348  * @brief Application Storage Types
 349  */
 350 typedef enum {
 351         PMINFO_INTERNAL_STORAGE = 0,            /**< Internal Storage*/
 352         PMINFO_EXTERNAL_STORAGE = 1,            /**< External Storage*/
 353 } pkgmgrinfo_installed_storage;
 354
 355 /**
 356  * @brief Certificate Types to be used for getting information
 357  */
 358 typedef enum {
 359         PMINFO_AUTHOR_ROOT_CERT = 0,            /**< Author Root Certificate*/
 360         PMINFO_AUTHOR_INTERMEDIATE_CERT = 1,            /**< Author Intermediate Certificate*/
 361         PMINFO_AUTHOR_SIGNER_CERT = 2,          /**< Author Signer Certificate*/
 362         PMINFO_DISTRIBUTOR_ROOT_CERT = 3,               /**< Distributor Root Certificate*/
 363         PMINFO_DISTRIBUTOR_INTERMEDIATE_CERT = 4,               /**< Distributor Intermediate Certificate*/
 364         PMINFO_DISTRIBUTOR_SIGNER_CERT = 5,             /**< Distributor Signer Certificate*/
 365         PMINFO_DISTRIBUTOR2_ROOT_CERT = 6,              /**< End Entity Root Certificate*/
 366         PMINFO_DISTRIBUTOR2_INTERMEDIATE_CERT = 7,              /**< End Entity Intermediate Certificate*/
 367         PMINFO_DISTRIBUTOR2_SIGNER_CERT = 8,            /**< End Entity Signer Certificate*/
 368 } pkgmgrinfo_cert_type;
 369
 370 /**
 371  * @brief Install Location Types to be used when setting data in DB
 372  */
 373 typedef enum {
 374         INSTALL_INTERNAL = 0,           /**< Internal Installation*/
 375         INSTALL_EXTERNAL,               /**< External Installation*/
 376 } INSTALL_LOCATION;
 377
 378  /**
 379   * @brief permission Types
 380   */
 381 typedef enum {
 382         PMINFO_PERMISSION_NORMAL = 0,            /**< permission normal*/
 383         PMINFO_PERMISSION_SIGNATURE,     /**< permission type is signature*/
 384         PMINFO_PERMISSION_PRIVILEGE,     /**< permission type is privilege*/
 385 } pkgmgrinfo_permission_type;
 386
 387 typedef enum {
 388         PMINFO_REQUEST = 0,
 389         PMINFO_LISTENING,
 390         PMINFO_BROADCAST,
 391 } pkgmgrinfo_client_type;
 392
 393 #endif