src/misc/widget_location.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        widget_location.h
  18  * @author      Iwanek Tomasz (t.iwanek@smasung.com)
  19  */
  20 #ifndef WRT_INSTALLER_SRC_MISC_WIDGET_LOCATION_H
  21 #define WRT_INSTALLER_SRC_MISC_WIDGET_LOCATION_H
  22
  23 #include <string>
  24 #include <memory>
  25
  26 #include <dpl/wrt-dao-ro/common_dao_types.h>
  27 #include <dpl/wrt-dao-ro/widget_dao_read_only.h>
  28 #include <wrt_common_types.h>
  29
  30 /**
  31  * @brief The WidgetLocation class
  32  *
  33  * Object that stores locations of several files/directories according
  34  * to package name
  35  *
  36  * Current package layout (of installed package) is following:
  37  *
  38  * /opt/apps/[package_name]
  39  *           \_____________ /data
  40  *           \_____________ /share
  41  *           \_____________ /bin
  42  *           \_____________ /bin/[id_of_installed_package]
  43  *           \_____________ /res/wgt/
  44  *                               \___ config.xml
  45  *                               \___ [widgets_archive_content]
  46  *
  47  * 1) Normal Widget
  48  *  Developer provides content of res/wgt directory (package contains that
  49  * directory as root).
  50  *
  51  * 2) For OSP Service Hybrid App is actually a bit different:
  52  *  Root is OSP Service directory, WebApp content is located in [root]/res/wgt
  53  *
  54  * Temporary directory is directory when widget is placed at the begining
  55  * of installation process. After parsing process of config.xml, destination
  56  * directory is created.
  57  */
  58 class WidgetLocation
  59 {
  60     class DirectoryDeletor
  61     {
  62       public:
  63         DirectoryDeletor();
  64         DirectoryDeletor(std::string tempPath);
  65         DirectoryDeletor(bool isPreload);
  66
  67         ~DirectoryDeletor();
  68         std::string getTempPath() const;
  69
  70       private:
  71         std::string m_dirpath;
  72     };
  73
  74   public:
  75     DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  76     DECLARE_EXCEPTION_TYPE(Base, NoTemporaryPath)
  77     /**
  78      * @brief WidgetLocation
  79      *
  80      * Creates useless object. Needed by DPL::Optional
  81      */
  82     WidgetLocation();
  83     /**
  84      * @brief WidgetLocation Builds paths for widget location during
  85      * uninstallation
  86      *
  87      * Uninstallation process needs only installed package directory.
  88      *
  89      * @param widgetname name of widget
  90      */
  91     explicit WidgetLocation(const std::string & widgetname);
  92     /**
  93      * @brief WidgetLocation Builds paths for widget location during
  94      * installation
  95      *
  96      * @param widgetname name of widget
  97      * @param sourcePath given source path
  98      * @param t declaraced type of widget if type is needed
  99      *
 100      * In destruction removes temporary directory
 101      */
 102     WidgetLocation(const std::string & widgetname, std::string sourcePath,
 103                    WrtDB::PackagingType t = WrtDB::PKG_TYPE_NOMAL_WEB_APP,
 104                    InstallLocationType ltype =
 105                        INSTALL_LOCATION_TYPE_NOMAL);
 106
 107     WidgetLocation(const std::string & widgetname, std::string sourcePath,
 108                    std::string dirPath,
 109                    WrtDB::PackagingType t = WrtDB::PKG_TYPE_NOMAL_WEB_APP,
 110                    InstallLocationType ltype =
 111                        INSTALL_LOCATION_TYPE_NOMAL);
 112
 113     ~WidgetLocation();
 114
 115     // Installed paths
 116     std::string getInstallationDir() const; // /opt/apps or /usr/apps
 117     std::string getPackageInstallationDir() const; // /opt/apps/[package]
 118     std::string getSourceDir() const;  // /opt/apps/[package]/res/wgt
 119     std::string getBinaryDir() const;  // /opt/apps/[package]/bin
 120     std::string getExecFile() const;   // /opt/apps/[package]/bin/[package]
 121     std::string getBackupDir() const;  // /opt/apps/[package]/backup
 122     std::string getBackupSourceDir() const; // /opt/apps/[pkg]/backup/res/wgt
 123     std::string getBackupBinaryDir() const; // /opt/apps/[pkg]/backup/bin
 124     std::string getBackupExecFile() const;  // /opt/apps/[pkg]/backup/bin/[pkg]
 125     std::string getUserDataRootDir() const; // /opt/usr/apps/[package]
 126     std::string getPrivateStorageDir() const; // /opt/usr/apps/[package]/data
 127
 128     // Temporary paths
 129     /**
 130      * @brief getTemporaryRootDir
 131      * @return value of root for developer's provide package (root of unpacked
 132      * .wgt file)
 133      */
 134     std::string getTemporaryPackageDir() const;
 135     /**
 136      * @brief getTemporaryRootDir
 137      *
 138      * Value of this will differs according to type of installed widget.
 139      *
 140      * @return value of root for content in temporary directory to be copied
 141      * into 'res/wgt'
 142      */
 143     std::string getTemporaryRootDir() const;
 144     /**
 145      * @brief getConfigurationDir Returns rott directory for configuration
 146      * requirements
 147      *
 148      * 1) For packed widgets it is just root of unpacked sources
 149      * 2) For browser installation it is directory name of widget passed to
 150      * installer
 151      *
 152      * @return configuration directory
 153      */
 154     std::string getConfigurationDir() const;
 155
 156     //icons
 157     /**
 158      * @brief setIconTargetFilenameForLocale set installed ion path according to
 159      * locale
 160      * @param icon path of application icon
 161      */
 162     void setIconTargetFilenameForLocale(const std::string &icon);
 163
 164     /**
 165      * @brief getIconTargetFilename gets icon full path
 166      * @param languageTag language tag
 167      * @return value of full path
 168      */
 169     std::string getInstalledIconPath() const;
 170
 171     /**
 172      * @brief getWidgetSourcePath return widget's source path given to installer
 173      * @return value of source path
 174      */
 175     std::string getWidgetSource() const;
 176     /**
 177      * @brief pkgid Returns pkgid
 178      * @return pkgid
 179      */
 180     DPL::String getPkgId() const;
 181
 182     //external files
 183     /**
 184      * @brief registerExternalFile Registers file for database registration
 185      * @param file
 186      *
 187      * Registered file will be stored in database and removed automatically a
 188      *
 189      * @return
 190      */
 191     void registerExternalLocation(const std::string & file);
 192     /**
 193      * @brief listExternalFile list all file to be registered
 194      */
 195     WrtDB::ExternalLocationList listExternalLocations() const;
 196
 197     /*
 198      * @brief set appid
 199      */
 200     void registerAppid(const std::string & appid);
 201
 202   private:
 203     std::string m_pkgid;                        //id of package
 204     std::string m_widgetSource;                   // Source widget zip
 205                                                   // file/widget url
 206     std::string m_appid;                        //id of app
 207     std::string m_iconPath;                       //installed icon path
 208     WrtDB::PackagingType m_type;
 209     std::shared_ptr<DirectoryDeletor> m_temp;      //directory
 210     WrtDB::ExternalLocationList m_externals;
 211     std::string m_installedPath;
 212 };
 213
 214 #endif // WRT_INSTALLER_SRC_MISC_WIDGET_LOCATION_H