src/jobs/widget_install/job_widget_install.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    job_widget_install.h
  18  * @author  Radoslaw Wicik r.wicik@samsung.com
  19  * @author  Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  20  * @version 1.0
  21  * @brief   Implementation file for main installer task
  22  */
  23 #ifndef WRT_SRC_INSTALLER_CORE_JOB_JOB_WIDGET_INSTALL_H_
  24 #define WRT_SRC_INSTALLER_CORE_JOB_JOB_WIDGET_INSTALL_H_
  25
  26 #include <dpl/optional.h>
  27 #include <dpl/string.h>
  28 #include <job.h>
  29 #include <job_base.h>
  30 #include <dpl/utils/widget_version.h>
  31 #include <widget_install/widget_install_context.h>
  32 #include <widget_install/widget_update_info.h>
  33 #include <dpl/wrt-dao-ro/config_parser_data.h>
  34 #include "widget_installer_struct.h"
  35
  36 namespace Jobs {
  37 namespace WidgetInstall {
  38 class JobWidgetInstall :
  39     public Job,
  40     public JobProgressBase<InstallerContext::InstallStep,
  41                            InstallerContext::INSTALL_END>,
  42     public JobContextBase<WidgetInstallationStruct>   //TODO typedef
  43 {
  44   private:
  45     InstallerContext m_installerContext;
  46
  47     //TODO move it to base class of all jobs -> make it base template class??
  48     Exceptions::Type m_exceptionCaught;
  49     std::string m_exceptionMessage;
  50     WidgetUpdateInfo m_widgetUpdateInfo;
  51
  52     enum class ConfigureResult
  53     {
  54         Ok, Failed, Deferred, Updated
  55     };
  56
  57     ConfigureResult ConfigureInstallation(const std::string &widgetSource,
  58                                           const WrtDB::ConfigParserData
  59                                           &configData,
  60                                           const WidgetUpdateInfo &update,
  61                                           bool browserRequest);
  62     static WrtDB::ConfigParserData getWidgetDataFromXML(
  63             const std::string &widgetSource,
  64             bool fromBrowser, WrtDB::PkgType isOspsvc);
  65     static WidgetUpdateInfo detectWidgetUpdate(
  66             const WrtDB::ConfigParserData &configInfo);
  67     WidgetUpdateMode::Type CalcWidgetUpdatePolicy(
  68             const OptionalWidgetVersion &existingVersion,
  69             const OptionalWidgetVersion &incomingVersion) const;
  70     bool setTizenId(const WrtDB::ConfigParserData &configInfo,
  71                     ConfigureResult result);
  72     void displayWidgetInfo();
  73     void configureWidgetLocation(const std::string & widgetPath, bool browserRequest);
  74
  75     WrtDB::PackagingType checkPackageType(
  76             const std::string &widgetSorce);
  77     bool detectResourceEncryption(const WrtDB::ConfigParserData &configData);
  78     std::string generateTizenId();
  79
  80   public:
  81     /**
  82      * @brief Automaticaly sets installation process
  83      */
  84     JobWidgetInstall(std::string const & widgetPath,
  85             const WidgetInstallationStruct &installerStruct);
  86
  87     DPL::OptionalString getNewTizenId() const;
  88
  89     //overrides
  90     void SendProgress();
  91     void SendFinishedSuccess();
  92     void SendFinishedFailure();
  93     void SaveExceptionData(const Jobs::JobExceptionBase&);
  94 };
  95 } //namespace WidgetInstall
  96 } //namespace Jobs
  97
  98 #endif // WRT_SRC_INSTALLER_CORE_JOB_JOB_WIDGET_INSTALL_H_