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 * This file contains the declaration of widget dao class.
19 * @file widget_dao_read_only.h
20 * @author Yang Jie (jie2.yang@samsung.com)
21 * @author Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
22 * @author Pawel Sikorski (p.sikorski@samsung.com)
24 * @brief This file contains the declaration of widget dao
27 #ifndef _WRT_SRC_CONFIGURATION_WIDGET_DAO_READ_ONLY_H_
28 #define _WRT_SRC_CONFIGURATION_WIDGET_DAO_READ_ONLY_H_
33 #include <dpl/string.h>
34 #include <dpl/exception.h>
35 #include <dpl/db/orm.h>
36 #include <dpl/optional_typedefs.h>
37 #include <dpl/wrt-dao-ro/config_parser_data.h>
38 #include <dpl/wrt-dao-ro/property_dao_read_only.h>
39 #include <dpl/wrt-dao-ro/common_dao_types.h>
44 * Widget's signature enum.
45 * This enumerates signature type of widget.
47 enum WidgetSignatureType
49 SIGNATURE_TYPE_CARRIER = 0,
50 SIGNATURE_TYPE_IDENTIFIED,
51 SIGNATURE_TYPE_UNIDENTIFIED
54 enum CertificateSource {
55 SIGNATURE_DISTRIBUTOR = 0,
59 typedef std::list<DPL::String> StringList;
61 struct WidgetLocalizedInfo
63 DPL::OptionalString name;
64 DPL::OptionalString shortName;
65 DPL::OptionalString description;
66 DPL::OptionalString license;
67 DPL::OptionalString licenseHref;
72 * A structure to hold certificate fingerprints.
74 struct WidgetCertificateData
76 enum Owner { AUTHOR, DISTRIBUTOR, UNKNOWN };
77 enum Type { ROOT, ENDENTITY };
79 // type of signature: author/distributor
81 // indicates whether this is ca certificate
84 // chain id number: relative BASE, where BASE is signatureBASE.xml
86 // certificate fingerprint digested by md5
87 std::string strMD5Fingerprint;
88 // certificate fingerprint digestef by sha1
89 std::string strSHA1Fingerprint;
90 // Common name field in certificate
91 DPL::String strCommonName;
93 bool operator== (const WidgetCertificateData& certData) const {
94 return certData.chainId == chainId &&
95 certData.owner == owner &&
96 certData.strCommonName == strCommonName &&
97 certData.strMD5Fingerprint == strMD5Fingerprint &&
98 certData.strSHA1Fingerprint == strSHA1Fingerprint;
102 typedef std::list<WidgetCertificateData> WidgetCertificateDataList;
104 typedef DPL::String Locale;
105 typedef std::set<Locale> LocaleSet;
106 typedef std::list<std::string> ExternalLocationList;
110 * A structure to hold widget's information needed to be registered.
111 * @see WidgetConfigurationInfo
113 struct WidgetRegisterInfo
115 struct LocalizedIcon : public ConfigParserData::Icon
117 LocalizedIcon(const ConfigParserData::Icon& icon,
118 const LocaleSet& _availableLocales) :
119 ConfigParserData::Icon(icon),
120 availableLocales(_availableLocales)
124 LocaleSet availableLocales;
127 struct StartFileProperties
129 DPL::String encoding;
133 typedef std::map<Locale,
134 StartFileProperties> StartFilePropertiesForLocalesMap;
135 struct LocalizedStartFile
138 StartFilePropertiesForLocalesMap propertiesForLocales;
141 typedef std::list<LocalizedIcon> LocalizedIconList;
142 typedef std::list<LocalizedStartFile> LocalizedStartFileList;
143 struct LocalizationData
145 LocalizedIconList icons;
146 LocalizedStartFileList startFiles;
158 WidgetRegisterInfo() :
159 webAppType(APP_TYPE_UNKNOWN),
160 signatureType(SIGNATURE_TYPE_UNIDENTIFIED),
163 packagingType(PKG_TYPE_UNKNOWN)
167 WidgetType webAppType;
168 WidgetType type; // TODO : This type will be removed.
169 DPL::OptionalString guid;
170 DPL::OptionalString version;
171 DPL::OptionalString minVersion;
172 std::string shareHref;
173 std::string baseFolder;
174 WidgetSignatureType signatureType;
176 ConfigParserData configInfo;
177 LocalizationData localizationData;
179 DPL::OptionalString pkgname;
180 DPL::String pkgname_NOTNULL;
182 time_t installedTime;
183 PackagingType packagingType;
184 EncryptedFileList encryptedFiles;
185 ExternalLocationList externalLocations;
186 DPL::OptionalString widgetInstalledPath;
189 typedef std::list<std::string> CertificateChainList;
193 virtual ~IWacSecurity();
195 virtual const WidgetCertificateDataList& getCertificateList() const = 0;
197 virtual bool isRecognized() const = 0;
199 virtual bool isDistributorSigned() const = 0;
201 virtual bool isWacSigned() const = 0;
203 virtual void getCertificateChainList(CertificateChainList& list,
204 CertificateSource source) const = 0;
209 * Structure to hold the information of widget's author.
211 struct WidgetAuthorInfo
213 DPL::OptionalString name;
214 DPL::OptionalString email;
215 DPL::OptionalString href;
219 * Widget update policy
221 enum WidgetUpdatePolicy
223 WIDGET_UPDATE_MONTHLY = 0, //< monthly update
224 WIDGET_UPDATE_WEEKLY, //< weekly update
225 WIDGET_UPDATE_DAILY, //< daily update
226 WIDGET_UPDATE_STARTUP, //< update when cell phone boots
227 WIDGET_UPDATE_NEVER //< never update
230 typedef std::list <std::string> WidgetCertificateCNList;
231 typedef std::list<DPL::String> LanguageTagList;
232 typedef std::list<std::string> HostList;
233 typedef std::list<std::string> FingerPrintList;
234 typedef std::list<std::string> ResourceAttributeList;
236 class WidgetDAOReadOnly
240 * WidgetDAO Exception classes
245 DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
246 DECLARE_EXCEPTION_TYPE(Base, DatabaseError)
247 DECLARE_EXCEPTION_TYPE(Base, ReadOnlyProperty)
248 DECLARE_EXCEPTION_TYPE(Base, GUIDisNull)
249 DECLARE_EXCEPTION_TYPE(Base, UnexpectedEmptyResult)
250 DECLARE_EXCEPTION_TYPE(Base, WidgetNotExist)
251 DECLARE_EXCEPTION_TYPE(Base, AlreadyRegistered)
255 DbWidgetHandle m_widgetHandle;
258 struct WidgetLocalizedIconRow
262 DPL::String widgetLocale;
264 typedef std::list<WidgetLocalizedIconRow> WidgetLocalizedIconList;
271 DPL::OptionalInt iconWidth;
272 DPL::OptionalInt iconHeight;
274 typedef std::list<WidgetIconRow> WidgetIconList;
276 struct WidgetStartFileRow
282 typedef std::list<WidgetStartFileRow> WidgetStartFileList;
284 struct WidgetLocalizedStartFileRow
288 DPL::String widgetLocale;
290 DPL::String encoding;
292 typedef std::list<WidgetLocalizedStartFileRow> LocalizedStartFileList;
295 * This is a constructor.
297 * @param[in] widgetHandle application id of widget.
299 WidgetDAOReadOnly(DbWidgetHandle widgetHandle);
300 WidgetDAOReadOnly(DPL::OptionalString widgetGUID);
301 WidgetDAOReadOnly(DPL::String pkgName);
306 virtual ~WidgetDAOReadOnly();
309 * This method returns widget handle(m_widgetHandle).
311 * @return widget handle(m_widgetHandle).
312 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
313 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in DB table.
315 DbWidgetHandle getHandle() const;
316 static DbWidgetHandle getHandle(const WidgetGUID GUID);
317 static DbWidgetHandle getHandle(const DPL::String pkgName);
320 * This method returns the root directory of widget resource.
322 * @return path name of root directory.
323 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
324 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
327 DPL::String getPath() const;
329 DPL::String getFullPath() const;
332 * This method returns the preferred size of the widget,
333 * including width and height.
336 * @return An structure type variable to hold widget's size.
337 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
338 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching
341 DbWidgetSize getPreferredSize() const;
344 * This method returns the type of the widget.
347 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
348 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching
351 WidgetType getWidgetType() const;
354 * This method returns the id of the widget.
357 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
358 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
361 WidgetGUID getGUID() const;
364 * This method returns the Package name of the widget.
367 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
368 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in DB table.
370 DPL::OptionalString getPkgname() const;
372 DPL::String getPkgname_NOTNULL() const;
375 * This method returns the defaultlocale for the widget.
377 * @return defaultlocale
378 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
379 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
382 DPL::OptionalString getDefaultlocale() const;
385 * This method returns list of localized icons files;
387 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
388 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
391 WidgetLocalizedIconList getLocalizedIconList() const;
394 * This method returns list of icons files;
396 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
397 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
400 WidgetIconList getIconList() const;
403 * This method returns list of localized start files;
405 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
406 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
409 LocalizedStartFileList getLocalizedStartFileList() const;
412 * This method returns list of start files;
414 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
415 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
418 WidgetStartFileList getStartFileList() const;
421 * @param[out] outAccessInfoList list filled with access info structures
423 void getWidgetAccessInfo(WidgetAccessInfoList& outAccessInfoList) const;
427 * @return recognized status
429 bool isRecognized() const;
435 bool isWacSigned() const;
441 bool isDistributorSigned() const;
445 * @return trusted status
447 bool isTrusted() const;
451 * @return is WAC test widget
453 bool isTestWidget() const;
456 * This method returns window mode of widget.
458 * @return window modes of widget
459 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
460 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
463 WindowModeList getWindowModes() const;
466 * This method returns the version of the widget.
468 * @return version of widget
469 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
470 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
473 DPL::OptionalString getVersion() const;
476 * This method returns list filed with Common Name entries from certificate.
478 * @return Common Name of Distribuotor End Entity certificate.
479 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
480 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
483 WidgetCertificateCNList getKeyCommonNameList(
484 WidgetCertificateData::Owner owner,
485 WidgetCertificateData::Type type) const;
488 * given a certificate owner (author / distributor) and type of certificate
490 * function returns list of matching fingerprints
492 FingerPrintList getKeyFingerprints(
493 WidgetCertificateData::Owner owner,
494 WidgetCertificateData::Type type) const;
497 * This method gets certificate data list for a widget from database.
499 WidgetCertificateDataList getCertificateDataList() const;
502 * This method returns a list of widget features.
505 * @see FreeFeatureList()
506 * @return list of widget features, type of list element is structure
508 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
509 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
512 DbWidgetFeatureSet getFeaturesList() const;
514 static WidgetParamMap getFeatureParams(int widgetFeatureId);
516 * This method checks whether widget has specified feature.
518 * @return true if has, false if has not
519 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
521 bool hasFeature(const std::string& featureName) const;
524 * This method gets host list that widget can connect to.
526 * @return See above comment
527 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
529 HostList getAccessHostList() const;
532 * This method gets widget's access on network: true or false.
534 * @return true: widget can access network; false: widget can not access
536 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
537 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
540 bool getAccessNetworkMode() const;
543 * This method gets if widget needs webkit plugins enabled
545 * @return true: widget needs webkit plugins enabled
546 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
547 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
550 bool getWebkitPluginsRequired() const;
553 * This method returns a list of all the installed widgets' app id.
555 * @return list of installed widgets' app id.
556 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
557 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
560 static DbWidgetHandleList getHandleList();
563 * This method returns list of pkgname of installed packages
564 * @return list of pkgname of installed packages
566 static WidgetPkgNameList getPkgnameList();
567 static WidgetPkgNameList_NOTNULL getPkgnameList_NOTNULL();
570 * This method returns a list of all the installed widgets.
572 * @return list of installed widgets.
573 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
574 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
577 static DbWidgetDAOReadOnlyList getWidgetList();
579 * This method removes a widget's information from EmDB.
581 * @see RegisterWidget()
582 * @param[in] widgetHandle widget's app id
583 * @return true if succeed, false if fail.
585 static void unregisterWidget(DbWidgetHandle widgetHandle);
588 * This method gets author's infomation of a widget which is parsed from
589 * configiration document.
591 * @see WidgetAuthorInfo
592 * @param[out] pAuthorInfo
593 * @return true if succeed, false if fail.
595 WidgetAuthorInfo getAuthorInfo() const;
598 * This method gets author's name of a widget which is parsed from
599 * configiration document.
601 * @param[out] pAuthorInfo
602 * @return author's name.
603 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
604 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
607 DPL::OptionalString getAuthorName() const;
610 * This method gets author's email of a widget which is parsed from
611 * configiration document.
613 * @param[out] pAuthorInfo
614 * @return author's email.
615 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
616 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
619 DPL::OptionalString getAuthorEmail() const;
622 * This method gets author's email of a widget which is parsed from
623 * configiration document.
625 * @param[out] pAuthorInfo
626 * @return author's email.
627 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
628 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
631 DPL::OptionalString getAuthorHref() const;
634 * This method returns minimum version of WAC that WRT has to be compliant
635 * to to run this widget
637 * @return Minimum version
638 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
639 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
642 DPL::OptionalString getMinimumWacVersion() const;
644 /* This method get widget' share href.
646 * @return widget's share href
648 std::string getShareHref() const;
651 * This method get widget installed time
653 * @return time_t : return widget's install time
655 time_t getInstallTime() const;
658 * This method gets widget base folder.
660 * @return widget base folder.
661 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
662 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
665 std::string getBaseFolder() const;
667 /* This method gets the parameter list for resource.
669 ResourceAttributeList getResourceAttribute(
670 const std::string &resourceId) const;
672 /* This method checks read only flag for given property
674 DPL::OptionalInt checkPropertyReadFlag(
675 const PropertyDAOReadOnly::WidgetPropertyKey &key) const;
677 /* This method gets widget property key list
679 PropertyDAOReadOnly::WidgetPropertyKeyList getPropertyKeyList() const;
681 /* This method gets widget property list
683 PropertyDAOReadOnly::WidgetPreferenceList getPropertyList() const;
685 /* This method get widget property value
687 PropertyDAOReadOnly::WidgetPropertyValue getPropertyValue(
688 const PropertyDAOReadOnly::WidgetPropertyKey &key) const;
690 LanguageTagList getLanguageTags() const;
691 LanguageTagList getIconLanguageTags() const;
695 WidgetLocalizedInfo getLocalizedInfo(const DPL::String& languageTag) const;
696 std::string getCookieDatabasePath() const;
698 std::string getPrivateLocalStoragePath() const;
700 bool getBackSupported() const;
702 static bool isWidgetInstalled(DbWidgetHandle handle);
703 static bool isWidgetInstalled(const WidgetPkgName & pkgName);
705 /* This method get path of the splash image.
707 * @return path of the widget's splash image
709 DPL::OptionalString getSplashImgSrc() const;
711 ExternalLocationList getWidgetExternalLocations() const;
714 * Default value is required to keep compatibility with
715 * wrt-installer and wrt.
717 CertificateChainList getWidgetCertificate(
718 CertificateSource source = SIGNATURE_DISTRIBUTOR) const;
720 void getWidgetSettings(WidgetSettings& outWidgetSettings) const;
723 * This method gets application service list that define AUL value
725 * @return See above comment
726 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
728 void getAppServiceList(
729 WidgetApplicationServiceList& outAppServiceList) const;
732 * This method returns the type of the package.
734 * @return PackagingType
735 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
736 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching
739 PackagingType getPackagingType() const;
741 void getEncryptedFileList(EncryptedFileList& filesList) const;
744 * This method returns widget's background page filename.
746 * @return Name of file containing background page
748 DPL::OptionalString getBackgroundPage() const;
751 * @brief generateTizenId generates new tizen id
753 * If widget do not supplies it's own tizen id, this method can be used,
754 * although it should be removed in future.
756 * @return new tizen id
758 static WidgetPkgName generateTizenId();
761 * @brief This method return each value for security setting
763 * @return SettingsType
764 * SETTINGS_TYPE_UNKNOWN : unknow value
765 * SETTINGS_TYPE_ON : enable
766 * SETTINGS_TYPE_ALWAYS_ASK : ask by popup
767 * SETTINGS_TYPE_OFF : disable
769 SettingsType getSecurityPopupUsage() const;
770 SettingsType getGeolocationUsage() const;
771 SettingsType getWebNotificationUsage() const;
772 SettingsType getWebDatabaseUsage() const;
773 SettingsType getFileSystemUsage() const;
776 * This method returns widget's installed path
778 * @return path of widget installed
780 DPL::OptionalString getWidgetInstalledPath() const;
785 #endif // _WRT_SRC_CONFIGURATION_WIDGET_DAO_READ_ONLY_H_