src/logic/installer_controller.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 #ifndef WRT_SRC_INSTALLER_CORE_INSTALLER_CONTROLLER_H_
  17 #define WRT_SRC_INSTALLER_CORE_INSTALLER_CONTROLLER_H_
  18
  19 #include <dpl/singleton.h>
  20 #include <dpl/event/controller.h>
  21 #include <dpl/generic_event.h>
  22 #include <string>
  23 #include <map>
  24 #include <dpl/task_list.h>
  25 #include <dpl/task.h>
  26 #include <dpl/type_list.h>
  27 #include <widget_install/widget_installer_struct.h>
  28 #include <installer_logic.h>
  29 #include <job.h>
  30
  31 /**
  32  * @brief holds events send to InstallControler
  33  */
  34 namespace InstallerControllerEvents {
  35 /**
  36  * @brief Event for inicieting instalation process.
  37  *
  38  * This event holds std::string witch should be path to widget package
  39  */
  40 DECLARE_GENERIC_EVENT_2(InstallWidgetEvent,
  41                         std::string,
  42                         WidgetInstallationStruct)                                  // (zipFileName, installerStruct)
  43
  44 /**
  45  * @brief Event for iniciating plugin instalation process.
  46  * This event holds std::string witch should be path to plugin directory
  47  * and PluginInstallerStruct which contain
  48  * StatusCallack, progressCallback and private data for callbacks
  49  */
  50 DECLARE_GENERIC_EVENT_2(InstallPluginEvent, std::string, PluginInstallerStruct)
  51
  52 /**
  53  * @brief Event for inicietig widget uninstallation.
  54  *
  55  * WidgetHandler is used to point witch widget shuld be uninstalled
  56  */
  57 DECLARE_GENERIC_EVENT_2(UninstallWidgetEvent,
  58                         WidgetHandle,
  59                         WidgetUninstallationStruct)
  60
  61 /**
  62  * @brief Event for pushing installation process forward.
  63  */
  64 DECLARE_GENERIC_EVENT_1(NextStepEvent, Jobs::Job *)
  65
  66 DECLARE_GENERIC_EVENT_0(InstallDeferredWidgetPackagesEvent)
  67
  68 DECLARE_GENERIC_EVENT_0(InitializeEvent)
  69 DECLARE_GENERIC_EVENT_0(TerminateEvent)
  70
  71 } // namespace InstallerEvents
  72
  73 /**
  74  * @brief Controls Widget installation
  75  *
  76  * Main Controler of wiget installation/uninstallation, this is also used
  77  * for pushing forward each of processes.
  78  * It waits for three events:
  79  * <ul>
  80  *     <li>InstallWidgetEvent</li>
  81  *     <li>UninstallWidgetEvent</li>
  82  *     <li>NextStepEvent</li>
  83  * </ul>
  84  */
  85
  86 typedef DPL::TypeListDecl<
  87     InstallerControllerEvents::InstallWidgetEvent,
  88     InstallerControllerEvents::InstallPluginEvent,
  89     InstallerControllerEvents::UninstallWidgetEvent,
  90     InstallerControllerEvents::NextStepEvent,
  91     InstallerControllerEvents::InstallDeferredWidgetPackagesEvent,
  92     InstallerControllerEvents::InitializeEvent,
  93     InstallerControllerEvents::TerminateEvent>::Type
  94 InstallerControllerEventsSet;
  95
  96 class InstallerController : public DPL::Event::Controller<InstallerControllerEventsSet>
  97 {
  98   protected:
  99     /**
 100      * @brief Executed on InstallWidgetEvent received.
 101      */
 102     virtual void OnEventReceived(
 103             const InstallerControllerEvents::InstallWidgetEvent &event);
 104
 105     /**
 106      * @brief Executed on InstallPluginEvent received.
 107      */
 108     virtual void OnEventReceived(
 109             const InstallerControllerEvents::InstallPluginEvent &event);
 110
 111     /**
 112      * @brief Executed on UninstallWidgetEvent received.
 113      */
 114     virtual void OnEventReceived(
 115             const InstallerControllerEvents::UninstallWidgetEvent &event);
 116     /**
 117      * @brief Executed on NextStepEvent received.
 118      */
 119     virtual void OnEventReceived(
 120             const InstallerControllerEvents::NextStepEvent &event);
 121
 122     virtual void OnEventReceived(
 123             const InstallerControllerEvents::InstallDeferredWidgetPackagesEvent
 124             &event);
 125
 126     virtual void OnEventReceived(
 127             const InstallerControllerEvents::InitializeEvent &event);
 128     virtual void OnEventReceived(
 129             const InstallerControllerEvents::TerminateEvent &event);
 130
 131   private:
 132     // Embedded logic
 133     InstallerLogic m_installerLogic;
 134
 135     InstallerController();
 136
 137     static Eina_Bool AddNextStep(void *data);
 138
 139     friend class DPL::Singleton<InstallerController>;
 140 };
 141
 142 typedef DPL::Singleton<InstallerController> InstallerControllerSingleton;
 143
 144 #endif // INSTALLER_CONTROLLER_H