src/jobs/widget_install/task_widget_config.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    task_widget_config.h
  18  * @author  Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  19  * @version 1.0
  20  * @brief   Implementation file for installer task widget config
  21  */
  22 #ifndef INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_WIDGET_CONFIG_H
  23 #define INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_WIDGET_CONFIG_H
  24
  25 #include <set>
  26 #include <list>
  27
  28 #include <dpl/task.h>
  29 #include <dpl/task_list.h>
  30 #include <dpl/string.h>
  31 #include <dpl/optional.h>
  32 #include <dpl/wrt-dao-ro/config_parser_data.h>
  33 #include <dpl/wrt-dao-ro/widget_dao_read_only.h>
  34 #include <dpl/wrt-dao-ro/global_config.h>
  35
  36 #include <wrt_common_types.h>
  37
  38 class InstallerContext;
  39
  40 namespace Jobs {
  41 namespace WidgetInstall {
  42
  43 class TaskWidgetConfig :
  44     public DPL::TaskDecl<TaskWidgetConfig>
  45 {
  46   private:
  47     class Exception
  48     {
  49       public:
  50         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  51         DECLARE_EXCEPTION_TYPE(Base, ConfigParseFailed)
  52     };
  53
  54     typedef std::list<std::pair<DPL::String, DPL::String> > StringPairList;
  55
  56     InstallerContext& m_installContext;
  57     WrtDB::LocaleSet m_localeFolders;
  58     std::set<DPL::String> m_processedIconSet;
  59
  60     void StepProcessConfigurationFile();
  61     void ReadLocaleFolders();
  62     void ProcessLocalizedStartFiles();
  63     void ProcessStartFile(
  64         const DPL::OptionalString& path,
  65         const DPL::OptionalString& type,
  66         const DPL::OptionalString& encoding =
  67             DPL::OptionalString::Null,
  68         bool typeForcedInConfig = false);
  69     void ProcessBackgroundPageFile();
  70     void ProcessLocalizedIcons();
  71     void ProcessIcon(const WrtDB::ConfigParserData::Icon& icon);
  72     void ProcessWidgetInstalledPath();
  73     void ProcessAppControlInfo();
  74     void ProcessSecurityModel();
  75     void StepVerifyFeatures();
  76     void StepVerifyLivebox();
  77     void StepCheckMinVersionInfo();
  78
  79     template <typename Ex, const char* Msg>
  80     void StepCancelInstallation();
  81
  82     void StartStep();
  83     void EndStep();
  84
  85     DPL::String createAuthorWidgetInfo() const;
  86     bool isFeatureAllowed(
  87         WrtDB::AppType appType, DPL::String featureName);
  88     bool isMinVersionCompatible(
  89         WrtDB::AppType appType,
  90         const DPL::OptionalString &widgetVersion) const;
  91     /**
  92      * @brief Parses version string in format "major.minor.micro anything"
  93      * Returns false if format is invalid
  94      */
  95     bool isTizenWebApp() const;
  96     bool parseVersionString(const std::string &version, long &majorVersion,
  97                             long &minorVersion, long &microVersion) const;
  98     /**
  99      * This method is used to process the config.xml of widget, get
 100      * the corresponding configuration to pWidgetConfigInfo
 101      *
 102      * @param[in] path Specified the widget archive file path (absolute path).
 103      * @return         Configuration information of  widget
 104      */
 105     void processFile(const std::string& path,
 106                      WrtDB::WidgetRegisterInfo &wConfig);
 107
 108     bool locateAndParseConfigurationFile(
 109         const std::string& currentPath,
 110         WrtDB::WidgetRegisterInfo&
 111         pWidgetConfigInfo,
 112         const std::string& baseFolder);
 113     bool parseConfigurationFileBrowser(WrtDB::ConfigParserData& configInfo,
 114                                        const std::string& _currentPath);
 115     bool parseConfigurationFileWidget(WrtDB::ConfigParserData& configInfo,
 116                                       const std::string& _currentPath);
 117     bool fillWidgetConfig(WrtDB::WidgetRegisterInfo& pWidgetConfigInfo,
 118                           WrtDB::ConfigParserData& configInfo);
 119
 120   public:
 121     TaskWidgetConfig(InstallerContext& installTaskContext);
 122 };
 123 } //namespace WidgetInstall
 124 } //namespace Jobs
 125
 126 #endif // INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_WIDGET_CONFIG_H