modules/widget_dao/include/dpl/wrt-dao-rw/widget_dao.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  * This file contains the declaration of widget dao class.
  18  *
  19  * @file    widget_dao.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)
  23  * @version 1.0
  24  * @brief   This file contains the declaration of widget dao
  25  */
  26 #ifndef WIDGET_DAO_H
  27 #define WIDGET_DAO_H
  28
  29 #include <dpl/wrt-dao-ro/widget_dao_read_only.h>
  30 #include <list>
  31 #include <string>
  32 #include <sys/time.h>
  33 #include <ctime>
  34 #include <cstdlib>
  35 #include <dpl/exception.h>
  36 #include <dpl/db/orm.h>
  37 #include <dpl/wrt-dao-ro/config_parser_data.h>
  38 #include <dpl/wrt-dao-rw/property_dao.h>
  39
  40 namespace WrtDB {
  41
  42 class WidgetDAO : public WidgetDAOReadOnly
  43 {
  44   public:
  45     typedef std::list<DPL::String> LanguageTagsList;
  46
  47     WidgetDAO(DbWidgetHandle handle);
  48     WidgetDAO(DPL::OptionalString widgetGUID);
  49     WidgetDAO(DPL::String pkgName);
  50
  51     /**
  52      * Destructor
  53      */
  54     virtual ~WidgetDAO();
  55
  56     /**
  57      * This method registers the widget information in the DB when it is installed.
  58      *
  59      * @see WidgetRegisterInfo
  60      * @see UnRegisterWidget()
  61      * @param[in] widgetPkgname Widget Pkgname that will be registered.
  62      * @param[in] pWidgetRegisterInfo    Specified the widget's information needed to be registered.
  63      * @param[in] wacSecurity   Widget's security certificates.
  64      */
  65     static void registerWidget(
  66             const WidgetPkgName & widgetPkgname,
  67             const WidgetRegisterInfo &widgetRegInfo,
  68             const IWacSecurity &wacSecurity);
  69
  70     static DbWidgetHandle registerWidget(
  71                 const WidgetRegisterInfo &pWidgetRegisterInfo,
  72                 const IWacSecurity &wacSecurity) __attribute__((deprecated));
  73
  74     /**
  75      * @brief registerWidgetGenerateTizenId Registers widget with auto-generated tizen id
  76      *
  77      * This function is disadviced and should be used only in tests.
  78      * Function is not thread-safe.
  79      *
  80      * @param pWidgetRegisterInfo registeration information
  81      * @param wacSecurity Widget's security certificates.
  82      * @return pkgname generated
  83      */
  84     static WidgetPkgName registerWidgetGenerateTizenId(
  85                 const WidgetRegisterInfo &pWidgetRegisterInfo,
  86                 const IWacSecurity &wacSecurity);
  87
  88     /**
  89      * This method re-registers the widget information to the DB when it is installed.
  90      *
  91      * It performs unregistration and new registration of widget in db in one transaction.
  92      *
  93      * @see WidgetRegisterInfo
  94      * @param[in] widgetName  Widget pkgname that will be registered.
  95      * @param[in] pWidgetRegisterInfo    Specified the widget's information needed to be registered.
  96      * @param[in] wacSecurity   Widget's security certificates.
  97      */
  98     static void registerOrUpdateWidget(
  99             const WidgetPkgName & widgetName,
 100             const WidgetRegisterInfo &widgetRegInfo,
 101             const IWacSecurity &wacSecurity);
 102
 103     static void registerWidget(
 104             WrtDB::DbWidgetHandle handle,
 105             const WidgetRegisterInfo &widgetRegInfo,
 106             const IWacSecurity &wacSecurity) __attribute__((deprecated));
 107
 108     /**
 109      * This method removes a widget's information from EmDB.
 110      *
 111      * @see RegisterWidget()
 112      * @param[in] pkgName widgets name to be unregistered
 113      */
 114     static void unregisterWidget(const WidgetPkgName & pkgName);
 115
 116     static void unregisterWidget(WrtDB::DbWidgetHandle handle) __attribute__((deprecated));
 117
 118     /* This method removes widget property
 119      */
 120     void removeProperty(const PropertyDAOReadOnly::WidgetPropertyKey &key);
 121
 122     /**
 123      * @brief registerExternalLocations Removes rows from WidgetExternalLocations
 124      */
 125     void unregisterAllExternalLocations();
 126
 127     /* This method sets widget property
 128      */
 129     void setProperty(const PropertyDAOReadOnly::WidgetPropertyKey &key,
 130             const PropertyDAOReadOnly::WidgetPropertyValue &value,
 131             bool readOnly = false);
 132
 133     /* set PkgName
 134      */
 135     void setPkgName(const DPL::OptionalString& pkgName);
 136
 137     /* This function will update of api-feature status.
 138      * If status is true (feature rejected) plugin connected with this
 139      * api feature mustn't be loaded durign widget launch.
 140      */
 141     void updateFeatureRejectStatus(const DbWidgetFeature &widgetFeature);
 142
 143      /*
 144       * This method change security settings value
 145       */
 146     void setSecurityPopupUsage(const SettingsType value);
 147     void setGeolocationUsage(const SettingsType value);
 148     void setWebNotificationUsage(const SettingsType value);
 149     void setWebDatabaseUsage(const SettingsType value);
 150     void setFileSystemUsage(const SettingsType value);
 151
 152   private:
 153     //Methods used during widget registering
 154     static DbWidgetHandle registerWidgetInfo(
 155             const WidgetPkgName & widgetName,
 156             const WidgetRegisterInfo &regInfo,
 157             const IWacSecurity &wacSecurity,
 158             const DPL::Optional<DbWidgetHandle> handle = DPL::Optional<DbWidgetHandle>());
 159     static void registerWidgetExtendedInfo(
 160             DbWidgetHandle widgetHandle,
 161             const WidgetRegisterInfo &regInfo);
 162     static void registerWidgetLocalizedInfo(
 163             DbWidgetHandle widgetHandle,
 164             const WidgetRegisterInfo &regInfo);
 165     static void registerWidgetIcons(
 166             DbWidgetHandle widgetHandle,
 167             const WidgetRegisterInfo &regInfo);
 168     static void registerWidgetStartFile(
 169             DbWidgetHandle widgetHandle,
 170             const WidgetRegisterInfo &regInfo);
 171     static void registerWidgetPreferences(
 172             DbWidgetHandle widgetHandle,
 173             const WidgetRegisterInfo &regInfo);
 174     static void registerWidgetFeatures(
 175             DbWidgetHandle widgetHandle,
 176             const WidgetRegisterInfo &regInfo);
 177     static void registerWidgetWindowModes(
 178             DbWidgetHandle widgetHandle,
 179             const WidgetRegisterInfo &regInfo);
 180     static void registerWidgetWarpInfo(
 181             DbWidgetHandle widgetHandle,
 182             const WidgetRegisterInfo &regInfo);
 183     static void registerWidgetCertificates(
 184             DbWidgetHandle widgetHandle,
 185             const IWacSecurity &wacSecurity);
 186     static void registerCertificatesChains(
 187             DbWidgetHandle widgetHandle,
 188             CertificateSource certificateSource,
 189             const CertificateChainList &list);
 190     static void registerWidgetSettings(
 191             DbWidgetHandle widgetHandle,
 192             const WidgetRegisterInfo &regInfo);
 193     static void registerAppService(
 194             DbWidgetHandle widgetHandle,
 195             const WidgetRegisterInfo &regInfo);
 196     static void registerEncryptedResouceInfo(
 197             DbWidgetHandle widgetHandle,
 198             const WidgetRegisterInfo &regInfo);
 199     /**
 200      * @brief registerExternalLocations Inserts new rows to WidgetExternalLocations
 201      * @param externals list of files
 202      */
 203     static void registerExternalLocations(DbWidgetHandle widgetHandle,
 204                                 const ExternalLocationList & externals);
 205     static void registerWidgetSecuritySettings(DbWidgetHandle widgetHandle);
 206
 207
 208     static void registerWidgetInternal(
 209             const WidgetPkgName & widgetName,
 210             const WidgetRegisterInfo &widgetRegInfo,
 211             const IWacSecurity &wacSecurity,
 212             const DPL::Optional<DbWidgetHandle> handle = DPL::Optional<DbWidgetHandle>());
 213     static void unregisterWidgetInternal(
 214             const WidgetPkgName & pkgName);
 215 };
 216
 217 } // namespace WrtDB
 218
 219 #endif // WIDGET_DAO_H