2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @file widget_location.h
18 * @author Iwanek Tomasz (t.iwanek@smasung.com)
20 #ifndef WRT_INSTALLER_SRC_MISC_WIDGET_LOCATION_H
21 #define WRT_INSTALLER_SRC_MISC_WIDGET_LOCATION_H
26 #include <dpl/wrt-dao-ro/common_dao_types.h>
27 #include <dpl/wrt-dao-ro/widget_dao_read_only.h>
30 * @brief The WidgetLocation class
32 * Object that stores locations of several files/directories according
35 * Current package layout (of installed package) is following:
37 * /opt/apps/[package_name]
38 * \_____________ /data
39 * \_____________ /share
41 * \_____________ /bin/[id_of_installed_package]
42 * \_____________ /res/wgt/
44 * \___ [widgets_archive_content]
47 * Developer provides content of res/wgt directory (package contains that directory as root).
49 * 2) For OSP Service Hybrid App is actually a bit different:
50 * Root is OSP Service directory, WebApp content is located in [root]/res/wgt
52 * Temporary directory is directory when widget is placed at the begining
53 * of installation process. After parsing process of config.xml, destination directory is created.
57 class DirectoryDeletor
61 DirectoryDeletor(std::string tempPath);
63 std::string getTempPath() const;
65 std::string m_dirpath;
69 DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
70 DECLARE_EXCEPTION_TYPE(Base, NoTemporaryPath)
72 * @brief WidgetLocation
74 * Creates useless object. Needed by DPL::Optional
78 * @brief WidgetLocation Builds paths for widget location during uninstallation
80 * Uninstallation process needs only installed package directory.
82 * @param widgetname name of widget
84 WidgetLocation(const std::string & widgetname);
86 * @brief WidgetLocation Builds paths for widget location during installation
88 * @param widgetname name of widget
89 * @param sourcePath given source path
90 * @param t declaraced type of widget if type is needed
92 * In destruction removes temporary directory
94 WidgetLocation(const std::string & widgetname, std::string sourcePath,
95 WrtDB::PackagingType t = WrtDB::PKG_TYPE_NOMAL_WEB_APP,
96 bool preload = false);
98 WidgetLocation(const std::string & widgetname, std::string sourcePath,
100 WrtDB::PackagingType t = WrtDB::PKG_TYPE_NOMAL_WEB_APP,
101 bool preload = false);
106 std::string getInstallationDir() const; // /opt/apps or /usr/apps
107 std::string getPackageInstallationDir() const; // /opt/apps/[package]
108 std::string getSourceDir() const; // /opt/apps/[package]/res/wgt
109 std::string getBinaryDir() const; // /opt/apps/[package]/bin
110 std::string getExecFile() const; // /opt/apps/[package]/bin/[package]
111 std::string getBackupDir() const; // /opt/apps/[package]/backup
112 std::string getBackupSourceDir() const; // /opt/apps/[package]/backup/res/wgt
113 std::string getBackupBinaryDir() const; // /opt/apps/[package]/backup/bin
114 std::string getBackupExecFile() const; // /opt/apps/[package]/backup/bin/[package]
115 std::string getUserDataRootDir() const; // /opt/usr/apps/[package]
116 std::string getPrivateStorageDir() const; // /opt/usr/apps/[package]/data
117 std::string getShareDir() const; // /opt/usr/apps/[package]/share
121 * @brief getTemporaryRootDir
122 * @return value of root for developer's provide package (root of unpacked .wgt file)
124 std::string getTemporaryPackageDir() const;
126 * @brief getTemporaryRootDir
128 * Value of this will differs according to type of installed widget.
130 * @return value of root for content in temporary directory to be copied into 'res/wgt'
132 std::string getTemporaryRootDir() const;
134 * @brief getConfigurationDir Returns rott directory for configuration requirements
136 * 1) For packed widgets it is just root of unpacked sources
137 * 2) For browser installation it is directory name of widget passed to installer
139 * @return configuration directory
141 std::string getConfigurationDir() const;
145 * @brief setIconTargetFilenameForLocale set installed ion path according to locale
146 * @param icon path of application icon
148 void setIconTargetFilenameForLocale(const std::string &icon);
150 * @brief getIconTargetFilename gets icon path suffix for locale
151 * @param languageTag language tag
152 * @return value of suffix of path
154 DPL::String getIconTargetFilename(const DPL::String& languageTag) const;
156 * @brief getIconTargetFilename gets icon full path
157 * @param languageTag language tag
158 * @return value of full path
160 std::string getInstalledIconPath() const;
163 * @brief getWidgetSourcePath return widget's source path given to installer
164 * @return value of source path
166 std::string getWidgetSource() const;
168 * @brief pkgname Returns pkgname
171 DPL::String getPkgname() const;
175 * @brief registerExternalFile Registers file for database registration
178 * Registered file will be stored in database and removed automatically a
182 void registerExternalLocation(const std::string & file);
184 * @brief listExternalFile list all file to be registered
186 WrtDB::ExternalLocationList listExternalLocations() const;
189 std::string m_widgetSource; // Source widget zip file/widget url
190 std::string m_pkgname; //name of package
191 std::string m_iconPath; //installed icon path
192 WrtDB::PackagingType m_type;
193 std::shared_ptr<DirectoryDeletor> m_temp; //directory
194 WrtDB::ExternalLocationList m_externals;
195 std::string m_installedPath;
198 #endif // WRT_INSTALLER_SRC_MISC_WIDGET_LOCATION_H