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 namespace InstallerTaskWidgetPopupData {
  43 struct PopupData
  44 {
  45     DPL::String widgetInfo;
  46     void addWidgetInfo(const DPL::String &info);
  47 };
  48 } // InstalllerTaskWidgetPopupData
  49
  50 class TaskWidgetConfig :
  51     public DPL::TaskDecl<TaskWidgetConfig>
  52 {
  53   private:
  54     class Exception
  55     {
  56       public:
  57         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  58         DECLARE_EXCEPTION_TYPE(Base, ConfigParseFailed)
  59     };
  60
  61     typedef std::list<std::pair<DPL::String, DPL::String> > StringPairList;
  62
  63     InstallerContext& m_installContext;
  64     WrtDB::LocaleSet m_localeFolders;
  65     std::set<DPL::String> m_processedIconSet;
  66     InstallerTaskWidgetPopupData::PopupData m_popupData;
  67
  68     void StepProcessConfigurationFile();
  69     void ReadLocaleFolders();
  70     void ProcessLocalizedStartFiles();
  71     void ProcessStartFile(
  72         const DPL::OptionalString& path,
  73         const DPL::OptionalString& type,
  74         const DPL::OptionalString& encoding =
  75             DPL::OptionalString::Null,
  76         bool typeForcedInConfig = false);
  77     void ProcessBackgroundPageFile();
  78     void ProcessLocalizedIcons();
  79     void ProcessIcon(const WrtDB::ConfigParserData::Icon& icon);
  80     void ProcessWidgetInstalledPath();
  81     void StepVerifyFeatures();
  82     void StepCheckMinVersionInfo();
  83
  84     template <typename Ex, const char* Msg>
  85     void StepCancelInstallation();
  86
  87     DPL::String createAuthorWidgetInfo() const;
  88     bool isFeatureAllowed(
  89         WrtDB::AppType appType, DPL::String featureName);
  90     bool isMinVersionCompatible(
  91         WrtDB::AppType appType,
  92         const DPL::OptionalString &widgetVersion) const;
  93     /**
  94      * @brief Parses version string in format "major.minor.micro anything"
  95      * Returns false if format is invalid
  96      */
  97     bool isTizenWebApp() const;
  98     bool parseVersionString(const std::string &version, long &majorVersion,
  99                             long &minorVersion, long &microVersion) const;
 100     /**
 101      * This method is used to process the config.xml of widget, get
 102      * the corresponding configuration to pWidgetConfigInfo
 103      *
 104      * @param[in] path Specified the widget archive file path (absolute path).
 105      * @return         Configuration information of  widget
 106      */
 107     void processFile(const std::string& path,
 108                      WrtDB::WidgetRegisterInfo &wConfig);
 109
 110     bool locateAndParseConfigurationFile(
 111         const std::string& currentPath,
 112         WrtDB::WidgetRegisterInfo&
 113         pWidgetConfigInfo,
 114         const std::string& baseFolder);
 115     bool parseConfigurationFileBrowser(WrtDB::ConfigParserData& configInfo,
 116                                        const std::string& _currentPath);
 117     bool parseConfigurationFileWidget(WrtDB::ConfigParserData& configInfo,
 118                                       const std::string& _currentPath);
 119     bool fillWidgetConfig(WrtDB::WidgetRegisterInfo& pWidgetConfigInfo,
 120                           WrtDB::ConfigParserData& configInfo);
 121
 122   public:
 123     TaskWidgetConfig(InstallerContext& installTaskContext);
 124 };
 125 } //namespace WidgetInstall
 126 } //namespace Jobs
 127
 128 #endif // INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_WIDGET_CONFIG_H