} app2ext_move_type;
/**
+ * Enum for command type
+ * @see app2sd_move_installed_app()
+ */
+typedef enum app2sd_cmd_t {
+ APP2SD_PRE_INSTALL = 1,
+ APP2SD_POST_INSTALL,
+ APP2SD_PRE_UNINSTALL,
+ APP2SD_POST_UNINSTALL,
+ APP2SD_PRE_UPGRADE,
+ APP2SD_POST_UPGRADE,
+ APP2SD_APP_LAUNCH,
+ APP2SD_APP_TERMINATE,
+ APP2SD_MOVE_APP_TO_MMC,
+ APP2SD_MOVE_APP_TO_PHONE,
+ APP2SD_MIGRATE_LEGACY
+} app2sd_cmd;
+
+/**
* Enum for error codes
*/
typedef enum app2ext_error_t {
APP2EXT_ERROR_STRCMP_FAILED,
APP2EXT_ERROR_INVALID_PACKAGE,
APP2EXT_ERROR_CREATE_DIR_ENTRY,
- APP2EXT_ERROR_PASSWORD_GENERATION,
APP2EXT_ERROR_COPY_DIRECTORY,
APP2EXT_ERROR_INVALID_CASE,
APP2EXT_ERROR_SYMLINK_ALREADY_EXISTS,
APP2EXT_ERROR_MEMORY_ALLOC_FAILED,
APP2EXT_ERROR_OPERATION_NOT_PERMITTED,
APP2EXT_ERROR_SAME_LOOPBACK_DEVICE_EXISTS,
- APP2EXT_ERROR_PKGMGR_ERROR
+ APP2EXT_ERROR_PKGMGR_ERROR,
+ APP2EXT_ERROR_KILLAPP_ERROR,
+ APP2EXT_ERROR_NOENTRY,
+ APP2EXT_ERROR_SETUP_DMCRYPT_DEVICE,
+ APP2EXT_ERROR_OPEN_DMCRYPT_DEVICE,
+ APP2EXT_ERROR_CLOSE_DMCRYPT_DEVICE,
+ APP2EXT_ERROR_FIND_ASSOCIATED_DMCRYPT_DEVICE_NODE,
+ APP2EXT_ERROR_DMCRYPT_DEVICE_UNAVAILABLE,
+ APP2EXT_ERROR_ENUM_MAX
} app2ext_error;
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called before application is to be installed.
*
- * @param[in] appname application package name which is to be installed
- * @param[in] dir_list directory structure of the application
+ * @param[in] appname application package name which is to be installed
+ * @param[in] dir_list directory structure of the application
* This should be polulated by the package manager
* before calling pre_install and should be freed after
* pre_install returns.
* which has members Name(dirname) and Type (RO/RW)
* For eg for rpm the dir_list should be populated with
* nodes like : (lib, APP2EXT_DIR_RO), (res, APP2EXT_DIR_RO),
- (bin, APP2EXT_DIR_RO), (data, APP2EXT_DIR_RW)
- * @param[in] size Size of the application
- * @return 0 if success, error code(>0) if fail
+ * (bin, APP2EXT_DIR_RO), (data, APP2EXT_DIR_RW)
+ * @param[in] size Size of the application
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_pre_install)(const char *appname, GList* dir_list,
int size, uid_t uid);
int size);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called after application installation.
*
- * @param[in] appname application package name which is to be installed
- * @param[in] install_status Installation status (Success/Failure)
- * [ Enum :APP2EXT_STATUS_SUCCESS,
- * APP2EXT_STATUS_FAILED]
- * @return 0 if success, error code(>0) if fail
+ * @param[in] appname application package name which is to be installed
+ * @param[in] install_status Installation status (Success/Failure)
+ * [ Enum :APP2EXT_STATUS_SUCCESS,
+ * APP2EXT_STATUS_FAILED]
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_post_install)(const char *appname,
app2ext_status install_status, uid_t uid);
app2ext_status install_status);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called before application upgrade.
*
- * @param[in] appname application package name which is to be upgraded
- * @param[in] dir_list directory structure of the application
+ * @param[in] appname application package name which is to be upgraded
+ * @param[in] dir_list directory structure of the application
* This should be polulated by the package manager
* before calling pre_upgrade and should be freed after
* pre_upgrade returns.
* which has members Name(dirname) and Type (RO/RW)
* For eg for rpm the dir_list should be populated with
* nodes like : (lib, APP2EXT_DIR_RO), (res, APP2EXT_DIR_RO),
- (bin, APP2EXT_DIR_RO), (data, APP2EXT_DIR_RW)
- * @param[in] size Size of the application
- * @return 0 if success, error code(>0) if fail
+ * (bin, APP2EXT_DIR_RO), (data, APP2EXT_DIR_RW)
+ * @param[in] size Size of the application
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_pre_upgrade)(const char *appname, GList* dir_list,
int size, uid_t uid);
int size);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called before application upgradation.
*
- * @param[in] appname application package name which is to be upgraded
- * @param[in] upgrade_status Upgrade status (Success/Failure)
- * [ Enum :APP2EXT_STATUS_SUCCESS,
- * APP2EXT_STATUS_FAILED]
- * @return 0 if success, error code(>0) if fail
+ * @param[in] appname application package name which is to be upgraded
+ * @param[in] upgrade_status Upgrade status (Success/Failure)
+ * [ Enum :APP2EXT_STATUS_SUCCESS,
+ * APP2EXT_STATUS_FAILED]
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_post_upgrade)(const char *appname,
app2ext_status upgrade_status, uid_t uid);
app2ext_status upgrade_status);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called before application uninstallation.
*
- * @param[in] appname application package name which is to be uninstalled
- * @return 0 if success, error code(>0) if fail
+ * @param[in] appname application package name which is to be uninstalled
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_pre_uninstall)(const char *appname, uid_t uid);
typedef int (*app2ext_client_pre_uninstall)(const char *appname);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called after application uninstallation.
*
- * @param[in] appname application package name which is to be uninstalled
- * @return 0 if success, error code(>0) if fail
+ * @param[in] appname application package name which is to be uninstalled
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_post_uninstall)(const char *appname, uid_t uid);
typedef int (*app2ext_client_post_uninstall)(const char *appname);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called when application is to be moved from extrenal memory
*to internal memory or vice versa.
*
- * @param[in] appname application package name which is to be moved
- * @param[in] dir_list directory structure of the application
+ * @param[in] appname application package name which is to be moved
+ * @param[in] dir_list directory structure of the application
* This should be polulated by the package manager
* before calling move and should be freed after
* move returns.
* which has members Name(dirname) and Type (RO/RW)
* For eg for rpm the dir_list should be populated with
* nodes like : (lib, APP2EXT_DIR_RO), (res, APP2EXT_DIR_RO),
- (bin, APP2EXT_DIR_RO), (data, APP2EXT_DIR_RW)
- * @param[in] move_type move type
- * [Enum: APP2EXT_MOVE_TO_EXT, APP2EXT_MOVE_TO_PHONE]
- * @return 0 if success, error code(>0) if fail
+ * (bin, APP2EXT_DIR_RO), (data, APP2EXT_DIR_RW)
+ * @param[in] move_type move type
+ * [Enum: APP2EXT_MOVE_TO_EXT, APP2EXT_MOVE_TO_PHONE]
+ * @return 0 if success, error code(>0) if fail
*/
-typedef int (*app2ext_client_usr_move)(const char *appname, GList* dir_list,
+typedef int (*app2ext_client_usr_pre_move)(const char *appname, GList* dir_list,
+ app2ext_move_type move_type, uid_t uid);
+typedef int (*app2ext_client_pre_move)(const char *appname, GList* dir_list,
+ app2ext_move_type move_type);
+typedef int (*app2ext_client_usr_post_move)(const char *appname,
app2ext_move_type move_type, uid_t uid);
-typedef int (*app2ext_client_move)(const char *appname, GList* dir_list,
+typedef int (*app2ext_client_post_move)(const char *appname,
app2ext_move_type move_type);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called to enable application before application launch.
*
- * @param[in] appname application package name which is to be enabled
- * @return 0 if success, error code(>0) if fail
+ * @param[in] appname application package name which is to be enabled
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_enable)(const char *appname, uid_t uid);
typedef int (*app2ext_client_enable)(const char *appname);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
+ * and called to enable/disable entire application packages.
+ *
+ * @return 0 if success, error code(>0) if fail
+ */
+typedef int (*app2ext_client_enable_full_pkg)(void);
+typedef int (*app2ext_client_disable_full_pkg)(void);
+
+/**
+ * @brief : This function type is for a function that is implemented by plugin
* and called to disable application before application exit.
*
- * @param[in] appname application package name which is to be disabled
- * @return 0 if success, error code(>0) if fail
+ * @param[in] appname application package name which is to be disabled
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_disable)(const char *appname, uid_t uid);
typedef int (*app2ext_client_disable)(const char *appname);
/**
- * @brief :This function type is for a function that is implemented by plugin
+ * @brief : This function type is for a function that is implemented by plugin
* and called after application uninstallation.
*
- * @param[in] pkgid application package name which is to be uninstalled
- * @return 0 if success, error code(>0) if fail
+ * @param[in] pkgid application package name which is to be uninstalled
+ * @return 0 if success, error code(>0) if fail
*/
typedef int (*app2ext_client_usr_force_clean)(const char *pkgid, uid_t uid);
typedef int (*app2ext_client_force_clean)(const char *pkgid);
/**
- * This structure defines the app2ext interfaces. Plugins have to implement these functions
+ * @brief : This function type is for a function that is implemented by plugin
+ * and called before migration of legacy mount image.
+ *
+ * @param[in] pkgid application package name which is to be migrated
+ * @return 0 if success, error code(>0) if fail
+ */
+typedef int (*app2ext_client_usr_pre_migrate_legacy)(const char *pkgid,
+ uid_t uid);
+
+/**
+ * @brief : This function type is for a function that is implemented by plugin
+ * and called after migration of legacy mount image.
+ *
+ * @param[in] pkgid application package name which is to be migrated
+ * @return 0 if success, error code(>0) if fail
+ */
+typedef int (*app2ext_client_usr_post_migrate_legacy)(const char *pkgid,
+ uid_t uid);
+
+/**
+ * @brief : This function type is for a function that is implemented by plugin
+ * and called to migrate legacy mount image.
+ *
+ * @param[in] pkgid application package name which is to be migrated
+ * @return 0 if success, error code(>0) if fail
+ */
+typedef int (*app2ext_client_migrate_legacy_all)(void);
+
+/**
+ * @brief : This function type is for a function that is implemented by plugin
+ * and called to get the external image name.
+ *
+ * @param[in] pkgid application package name
+ * @param[in] uid target user id
+ * @return the name of external image
+ * @remark the name should be freed after the use.
+ */
+typedef char *(*app2ext_client_usr_getname_image)(const char *pkgid,
+ uid_t uid);
+
+/**
+ * @brief : This function type is for a function that is implemented by plugin
+ * and called to get the external image path.
+ *
+ * @param[in] pkgid application package name
+ * @param[in] uid target user id
+ * @return the path of external image
+ * @remark the path should be freed after the use.
+ */
+typedef char *(*app2ext_client_usr_get_image_path)(const char *pkgid,
+ uid_t uid);
+
+/**
+ * This structure defines the app2ext interfaces.
+ * Plugins have to implement these functions
*/
typedef struct app2ext_interface_t {
/* for library function */
app2ext_client_force_clean client_force_clean;
app2ext_client_enable client_enable;
app2ext_client_disable client_disable;
- app2ext_client_move client_move;
+ app2ext_client_enable_full_pkg client_enable_full_pkg;
+ app2ext_client_disable_full_pkg client_disable_full_pkg;
+ app2ext_client_pre_move client_pre_move;
+ app2ext_client_post_move client_post_move;
+ app2ext_client_migrate_legacy_all client_migrate_legacy_all;
app2ext_client_usr_pre_install client_usr_pre_install;
app2ext_client_usr_post_install client_usr_post_install;
app2ext_client_usr_force_clean client_usr_force_clean;
app2ext_client_usr_enable client_usr_enable;
app2ext_client_usr_disable client_usr_disable;
- app2ext_client_usr_move client_usr_move;
+ app2ext_client_usr_pre_move client_usr_pre_move;
+ app2ext_client_usr_post_move client_usr_post_move;
+ app2ext_client_usr_getname_image client_usr_getname_image;
+ app2ext_client_usr_pre_migrate_legacy client_usr_pre_migrate_legacy;
+ app2ext_client_usr_post_migrate_legacy client_usr_post_migrate_legacy;
+ app2ext_client_usr_get_image_path client_usr_get_image_path;
} app2ext_interface;
/**
* This structure defines app2ext handle .Each storage type maps to a different plugin
- * type : storage type,
- * plugin_handle : plugin handle, need to close dlopen handle
- * interface : inteface with plugin library
+ * type : storage type,
+ * plugin_handle : plugin handle, need to close dlopen handle
+ * interface : inteface with plugin library
*/
typedef struct {
- app2ext_install_location type;
+ app2ext_install_location type;
void *plugin_handle;
- app2ext_interface interface;
+ app2ext_interface interface;
} app2ext_handle;
/**
* This structure defines directory details
- * name : directory name
- * type : permission (rw/ro)
+ * name : directory name
+ * type : permission (rw/ro)
*/
typedef struct {
char *name;
/**
* @brief : This API initializes the appropriate plugin based on storage type.
- * It should be called before installation/uninstallation/upgrade
- * @param[in] storage_type Location where package should be installed
- * [Ex: SD card, MicroUSB, Cloud]
- * @return app2ext_handle pointer if success, NULL if fail
+ * It should be called before installation/uninstallation/upgrade
+ * @param[in] storage_type Location where package should be installed
+ * [Ex: SD card, MicroUSB, Cloud]
+ * @return app2ext_handle pointer if success, NULL if fail
*
*/
API app2ext_handle *app2ext_init(int storage_type);
/**
* @brief : This API deinitializes the plugin
- * This should be called when use of the plugin is completed
- * @param[in] handle pointer to app2ext_handle which is to be deinitialized
- * @pre Initialization is done for the storage handle
- * @return 0 if success, error < 0 if fail
+ * This should be called when use of the plugin is completed
+ * @param[in] handle pointer to app2ext_handle which is to be deinitialized
+ * @pre Initialization is done for the storage handle
+ * @return 0 if success, error < 0 if fail
*
*/
API int app2ext_deinit(app2ext_handle *handle);
/**
- * @brief : This API returns the application location by refering to package manager DB
- * This should be called to know location of an application package
- * @param[in] pkgid package id
- * @param[in] uid target user id of this instruction
- * @return APP2EXT_SD_CARD if pkg is in SD card,
- * APP2EXT_INTERNAL_MEM if pkg is in internal memory,
- * APP2EXT_NOT_INSTALLED if there is no valid pkg path
- * error < 0 if fail
- *@remarks see app2ext_install_location for more details
- */
-API int app2ext_get_app_location(const char *pkgid);
-API int app2ext_usr_get_app_location(const char *pkgid, uid_t uid);
-
-/**
* @brief : This API enable the package which is located in external memory
- * @param[in] pkgid package id
- * @param[in] uid target user id of this instruction
- * @return error < 0 if pkg enable fail ,
+ * @param[in] pkgid package id
+ * @param[in] uid target user id of this instruction
+ * @return error < 0 if pkg enable fail
*/
API int app2ext_enable_external_pkg(const char *pkgid);
API int app2ext_usr_enable_external_pkg(const char *pkgid, uid_t uid);
/**
* @brief : This API disable the package which is located in external memory
- * @param[in] pkgid package id
- * @param[in] uid target user id of this instruction
- * @return error < 0 if pkg enable fail ,
+ * @param[in] pkgid package id
+ * @param[in] uid target user id of this instruction
+ * @return error < 0 if pkg disable fail
*/
API int app2ext_disable_external_pkg(const char *pkgid);
API int app2ext_usr_disable_external_pkg(const char *pkgid, uid_t uid);
/**
* @brief : This API clean the directory and symbolic link which are made by app2ext
- * @param[in] pkgid package id
- * @param[in] uid target user id of this instruction
- * @return error < 0 if pkg enable fail ,
+ * @param[in] pkgid package id
+ * @param[in] uid target user id of this instruction
+ * @return error < 0 if pkg clean fail
*/
API int app2ext_force_clean_pkg(const char *pkgid);
API int app2ext_usr_force_clean_pkg(const char *pkgid, uid_t uid);
+/**
+ * @brief : This API mount/unmount all entries which are located in external memory
+ * @return error < 0 if fail to start enable/disable
+ */
+API int app2ext_enable_all_external_pkgs(void);
+API int app2ext_disable_all_external_pkgs(void);
+
+/**
+ * @brief : This API migrate all legacy entries which are located in external memory
+ * @return error < 0 if fail to migrate legacy
+ */
+API int app2ext_migrate_legacy_all(void);
+
+/**
+ * @brief : This API get the external image name
+ * @param[in] pkgid application package name
+ * @param[in] uid target user id
+ * @return the name of external image
+ * @remark the name should be freed after the use.
+ */
+API char *app2ext_usr_getname_image(const char *pkgid, uid_t uid);
+
+/**
+ * @brief : This API get the external image path
+ * @param[in] pkgid application package name
+ * @param[in] uid target user id
+ * @return the path of external image
+ * @remark the path should be freed after the use.
+ */
+API char *app2ext_usr_get_image_path(const char *pkgid, uid_t uid);
+
#ifdef __cplusplus
}
#endif
projects / platform / core / appfw / app2sd.git / blobdiff