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>
43 * Widget's signature enum.
44 * This enumerates signature type of widget.
46 enum WidgetSignatureType
48 SIGNATURE_TYPE_CARRIER = 0,
49 SIGNATURE_TYPE_IDENTIFIED,
50 SIGNATURE_TYPE_UNIDENTIFIED
53 enum CertificateSource {
54 SIGNATURE_DISTRIBUTOR = 0,
58 typedef std::list<DPL::String> StringList;
60 struct WidgetLocalizedInfo
62 DPL::OptionalString name;
63 DPL::OptionalString shortName;
64 DPL::OptionalString description;
65 DPL::OptionalString license;
66 DPL::OptionalString licenseHref;
71 * A structure to hold certificate fingerprints.
73 struct WidgetCertificateData
75 enum Owner { AUTHOR, DISTRIBUTOR, UNKNOWN };
76 enum Type { ROOT, ENDENTITY };
78 // type of signature: author/distributor
80 // indicates whether this is ca certificate
83 // chain id number: relative BASE, where BASE is signatureBASE.xml
85 // certificate fingerprint digested by md5
86 std::string strMD5Fingerprint;
87 // certificate fingerprint digestef by sha1
88 std::string strSHA1Fingerprint;
89 // Common name field in certificate
90 DPL::String strCommonName;
92 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)
123 LocaleSet availableLocales;
126 struct StartFileProperties
128 DPL::String encoding;
132 typedef std::map<Locale,
133 StartFileProperties> StartFilePropertiesForLocalesMap;
134 struct LocalizedStartFile
137 StartFilePropertiesForLocalesMap propertiesForLocales;
140 typedef std::list<LocalizedIcon> LocalizedIconList;
141 typedef std::list<LocalizedStartFile> LocalizedStartFileList;
142 struct LocalizationData
144 LocalizedIconList icons;
145 LocalizedStartFileList startFiles;
157 WidgetRegisterInfo() :
158 webAppType(APP_TYPE_UNKNOWN),
159 signatureType(SIGNATURE_TYPE_UNIDENTIFIED),
162 packagingType(PKG_TYPE_UNKNOWN)
165 WidgetType webAppType;
166 DPL::OptionalString guid;
167 DPL::OptionalString version;
168 DPL::OptionalString minVersion;
169 std::string shareHref;
170 std::string baseFolder;
171 WidgetSignatureType signatureType;
173 ConfigParserData configInfo;
174 LocalizationData localizationData;
179 time_t installedTime;
180 PackagingType packagingType;
181 EncryptedFileList encryptedFiles;
182 ExternalLocationList externalLocations;
183 DPL::OptionalString widgetInstalledPath;
186 typedef std::list<std::string> CertificateChainList;
190 virtual ~IWacSecurity();
192 virtual const WidgetCertificateDataList& getCertificateList() const = 0;
194 virtual bool isRecognized() const = 0;
196 virtual bool isDistributorSigned() const = 0;
198 virtual bool isWacSigned() const = 0;
200 virtual void getCertificateChainList(CertificateChainList& list,
201 CertificateSource source) const = 0;
206 * Structure to hold the information of widget's author.
208 struct WidgetAuthorInfo
210 DPL::OptionalString name;
211 DPL::OptionalString email;
212 DPL::OptionalString href;
216 * Widget update policy
218 enum WidgetUpdatePolicy
220 WIDGET_UPDATE_MONTHLY = 0, //< monthly update
221 WIDGET_UPDATE_WEEKLY, //< weekly update
222 WIDGET_UPDATE_DAILY, //< daily update
223 WIDGET_UPDATE_STARTUP, //< update when cell phone boots
224 WIDGET_UPDATE_NEVER //< never update
227 typedef std::list <std::string> WidgetCertificateCNList;
228 typedef std::list<DPL::String> LanguageTagList;
229 typedef std::list<std::string> HostList;
230 typedef std::list<std::string> FingerPrintList;
231 typedef std::list<std::string> ResourceAttributeList;
233 class WidgetDAOReadOnly
237 * WidgetDAO Exception classes
242 DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
243 DECLARE_EXCEPTION_TYPE(Base, DatabaseError)
244 DECLARE_EXCEPTION_TYPE(Base, ReadOnlyProperty)
245 DECLARE_EXCEPTION_TYPE(Base, GUIDisNull)
246 DECLARE_EXCEPTION_TYPE(Base, UnexpectedEmptyResult)
247 DECLARE_EXCEPTION_TYPE(Base, WidgetNotExist)
248 DECLARE_EXCEPTION_TYPE(Base, AlreadyRegistered)
252 DbWidgetHandle m_widgetHandle;
255 struct WidgetLocalizedIconRow
259 DPL::String widgetLocale;
261 typedef std::list<WidgetLocalizedIconRow> WidgetLocalizedIconList;
268 DPL::OptionalInt iconWidth;
269 DPL::OptionalInt iconHeight;
271 typedef std::list<WidgetIconRow> WidgetIconList;
273 struct WidgetStartFileRow
279 typedef std::list<WidgetStartFileRow> WidgetStartFileList;
281 struct WidgetLocalizedStartFileRow
285 DPL::String widgetLocale;
287 DPL::String encoding;
289 typedef std::list<WidgetLocalizedStartFileRow> LocalizedStartFileList;
292 * This is a constructor.
294 * @param[in] widgetHandle application id of widget.
296 WidgetDAOReadOnly(DbWidgetHandle widgetHandle);
297 WidgetDAOReadOnly(DPL::OptionalString widgetGUID);
298 WidgetDAOReadOnly(WrtDB::TizenAppId tzAppid);
303 virtual ~WidgetDAOReadOnly();
306 * This method returns widget handle(m_widgetHandle).
308 * @return widget handle(m_widgetHandle).
309 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
310 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
313 DbWidgetHandle getHandle() const;
314 static DbWidgetHandle getHandle(const WidgetGUID GUID);
315 static DbWidgetHandle getHandle(const DPL::String pkgName);
318 * Returns tizenAppId for the specified widget
321 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
322 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
326 TizenAppId getTzAppId() const;
327 static TizenAppId getTzAppId(const WidgetGUID GUID);
328 static TizenAppId getTzAppId(const DbWidgetHandle handle);
329 static TizenAppId getTzAppId(const TizenPkgId tzPkgid);
332 * Returns TizenPkgId for the specified widget
334 * @return TizenPkgId;
335 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
336 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
340 TizenPkgId getTzPkgId() const;
343 * This method returns the root directory of widget resource.
345 * @return path name of root directory.
346 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
347 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
350 virtual DPL::String getPath() const;
352 DPL::String getFullPath() const;
355 * This method returns the preferred size of the widget,
356 * including width and height.
359 * @return An structure type variable to hold widget's size.
360 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
361 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching
364 DbWidgetSize getPreferredSize() const;
367 * This method returns the type of the widget.
370 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
371 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching
372 * records in DB table.
374 WidgetType getWidgetType() const;
377 * This method returns the id of the widget.
380 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
381 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
384 WidgetGUID getGUID() const;
387 * This method returns the App id of the widget.
390 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
391 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
394 DPL::OptionalString getTizenAppId() const;
397 * This method returns the defaultlocale for the widget.
399 * @return defaultlocale
400 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
401 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
404 DPL::OptionalString getDefaultlocale() const;
407 * This method returns list of localized icons files;
409 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
410 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
413 WidgetLocalizedIconList getLocalizedIconList() const;
416 * This method returns list of icons files;
418 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
419 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
422 WidgetIconList getIconList() const;
425 * This method returns list of localized start files;
427 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
428 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
431 LocalizedStartFileList getLocalizedStartFileList() const;
434 * This method returns list of start files;
436 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
437 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
440 WidgetStartFileList getStartFileList() const;
443 * @param[out] outAccessInfoList list filled with access info structures
445 void getWidgetAccessInfo(WidgetAccessInfoList& outAccessInfoList) const;
449 * @return recognized status
451 bool isRecognized() const;
457 bool isWacSigned() const;
463 bool isDistributorSigned() const;
467 * @return trusted status
469 bool isTrusted() const;
473 * @return is WAC test widget
475 bool isTestWidget() const;
478 * This method returns window mode of widget.
480 * @return window modes of widget
481 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
482 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
485 WindowModeList getWindowModes() const;
488 * This method returns the version of the widget.
490 * @return version of widget
491 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
492 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
495 DPL::OptionalString getVersion() const;
498 * This method is used as a getter for csp policy of widget. It should be
499 * provided in configuration file.
500 * @return global csp policy for widget
502 DPL::OptionalString getCspPolicy() const;
505 * This method is used as a getter for report only csp policy of widget.
506 * It may be provided in configuration file.
507 * @return global csp report only policy for widget
509 DPL::OptionalString getCspPolicyReportOnly() const;
512 * This method returns list filed with Common Name entries from certificate.
514 * @return Common Name of Distribuotor End Entity certificate.
515 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
516 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
519 WidgetCertificateCNList getKeyCommonNameList(
520 WidgetCertificateData::Owner owner,
521 WidgetCertificateData::Type type) const;
524 * given a certificate owner (author / distributor) and type of certificate
526 * function returns list of matching fingerprints
528 FingerPrintList getKeyFingerprints(
529 WidgetCertificateData::Owner owner,
530 WidgetCertificateData::Type type) const;
533 * This method gets certificate data list for a widget from database.
535 WidgetCertificateDataList getCertificateDataList() const;
538 * This method returns a list of widget features.
541 * @see FreeFeatureList()
542 * @return list of widget features, type of list element is structure
544 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
545 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
548 DbWidgetFeatureSet getFeaturesList() const;
551 * This method checks whether widget has specified feature.
553 * @return true if has, false if has not
554 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
556 bool hasFeature(const std::string& featureName) const;
559 * This method gets host list that widget can connect to.
561 * @return See above comment
562 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
564 HostList getAccessHostList() const;
567 * This method gets widget's access on network: true or false.
569 * @return true: widget can access network; false: widget can not access
571 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
572 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
575 bool getAccessNetworkMode() const;
578 * This method gets if widget needs webkit plugins enabled
580 * @return true: widget needs webkit plugins enabled
581 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
582 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
585 bool getWebkitPluginsRequired() const;
588 * This method returns a list of all the installed widgets' app id.
590 * @return list of installed widgets' app id.
591 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
592 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
595 static DbWidgetHandleList getHandleList();
598 * This method returns list of tizen application list of installed packages
599 * @return list of TizenAppIdList of installed packages
601 static TizenAppIdList getTizenAppidList();
604 * This method returns a list of all the installed widgets.
606 * @return list of installed widgets.
607 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
608 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
611 static DbWidgetDAOReadOnlyList getWidgetList();
614 * This method removes a widget's information from EmDB.
616 * @see RegisterWidget()
617 * @param[in] widgetHandle widget's app id
618 * @return true if succeed, false if fail.
620 static void unregisterWidget(DbWidgetHandle widgetHandle);
623 * This method gets author's infomation of a widget which is parsed from
624 * configiration document.
626 * @see WidgetAuthorInfo
627 * @param[out] pAuthorInfo
628 * @return true if succeed, false if fail.
630 WidgetAuthorInfo getAuthorInfo() const;
633 * This method gets author's name of a widget which is parsed from
634 * configiration document.
636 * @param[out] pAuthorInfo
637 * @return author's name.
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 getAuthorName() const;
645 * This method gets author's email of a widget which is parsed from
646 * configiration document.
648 * @param[out] pAuthorInfo
649 * @return author's email.
650 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
651 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
654 DPL::OptionalString getAuthorEmail() const;
657 * This method gets author's email of a widget which is parsed from
658 * configiration document.
660 * @param[out] pAuthorInfo
661 * @return author's email.
662 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
663 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
666 DPL::OptionalString getAuthorHref() const;
669 * This method returns minimum version of WAC that WRT has to be compliant
670 * to to run this widget
672 * @return Minimum version
673 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
674 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
677 DPL::OptionalString getMinimumWacVersion() const;
679 /* This method get widget' share href.
681 * @return widget's share href
683 std::string getShareHref() const;
686 * This method get widget installed time
688 * @return time_t : return widget's install time
690 time_t getInstallTime() const;
693 * This method gets widget base folder.
695 * @return widget base folder.
696 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
697 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching records in
700 std::string getBaseFolder() const;
702 /* This method checks read only flag for given property
704 DPL::OptionalInt checkPropertyReadFlag(
705 const PropertyDAOReadOnly::WidgetPropertyKey &key) const;
707 /* This method gets widget property key list
709 PropertyDAOReadOnly::WidgetPropertyKeyList getPropertyKeyList() const;
711 /* This method gets widget property list
713 PropertyDAOReadOnly::WidgetPreferenceList getPropertyList() const;
715 /* This method get widget property value
717 PropertyDAOReadOnly::WidgetPropertyValue getPropertyValue(
718 const PropertyDAOReadOnly::WidgetPropertyKey &key) const;
720 LanguageTagList getLanguageTags() const;
721 LanguageTagList getIconLanguageTags() const;
723 WidgetLocalizedInfo getLocalizedInfo(const DPL::String& languageTag) const;
724 std::string getCookieDatabasePath() const;
726 std::string getPrivateLocalStoragePath() const;
728 bool getBackSupported() const;
730 static bool isWidgetInstalled(DbWidgetHandle handle);
731 static bool isWidgetInstalled(const TizenAppId & tzAppId);
733 /* This method get path of the splash image.
735 * @return path of the widget's splash image
737 DPL::OptionalString getSplashImgSrc() const;
739 ExternalLocationList getWidgetExternalLocations() const;
742 * Default value is required to keep compatibility with
743 * wrt-installer and wrt.
745 CertificateChainList getWidgetCertificate(
746 CertificateSource source = SIGNATURE_DISTRIBUTOR) const;
748 void getWidgetSettings(WidgetSettings& outWidgetSettings) const;
751 * This method gets application service list that define AUL value
753 * @return See above comment
754 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
756 void getAppServiceList(
757 WidgetApplicationServiceList& outAppServiceList) const;
760 * This method returns the type of the package.
762 * @return PackagingType
763 * @exception WRT_CONF_ERR_EMDB_FAILURE - Fail to query DB table.
764 * @exception WRT_CONF_ERR_EMDB_NO_RECORD - Can not find matching
765 * records in DB table.
767 PackagingType getPackagingType() const;
769 void getEncryptedFileList(EncryptedFileList& filesList) const;
772 * This method returns widget's background page filename.
774 * @return Name of file containing background page
776 DPL::OptionalString getBackgroundPage() const;
779 * @brief generateTizenId generates new package id
781 * If widget do not supplies it's own tizen package id, this method can be
783 * although it should be removed in future.
785 * @return new tizen package id
787 static TizenPkgId generatePkgId();
788 static TizenPkgId generateTizenId()
790 return generatePkgId();
794 * @brief This method return each value for security setting
796 * @return SettingsType
797 * SETTINGS_TYPE_UNKNOWN : unknow value
798 * SETTINGS_TYPE_ON : enable
799 * SETTINGS_TYPE_ALWAYS_ASK : ask by popup
800 * SETTINGS_TYPE_OFF : disable
802 SettingsType getSecurityPopupUsage() const;
803 SettingsType getGeolocationUsage() const;
804 SettingsType getWebNotificationUsage() const;
805 SettingsType getWebDatabaseUsage() const;
806 SettingsType getFileSystemUsage() const;
809 * This method returns widget's installed path
811 * @return path of widget installed
813 DPL::OptionalString getWidgetInstalledPath() const;
816 * This method returns tizen package id
818 * @return tizen package id
820 TizenPkgId getTizenPkgId() const;
821 PrivilegeList getWidgetPrivilege() const;
825 #endif // _WRT_SRC_CONFIGURATION_WIDGET_DAO_READ_ONLY_H_