src/jobs/widget_install/task_manifest_file.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_manifest_file.h
  18  * @author  Pawel Sikorski (p.sikorski@samgsung.com)
  19  * @version
  20  * @brief
  21  */
  22
  23 #ifndef INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_DESKTOP_FILE_H
  24 #define INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_DESKTOP_FILE_H
  25
  26 //SYSTEM INCLUDES
  27 #include <fstream>
  28
  29 //WRT INCLUDES
  30 #include <dpl/platform.h>
  31 #include <dpl/task.h>
  32 #include <dpl/localization/localization_utils.h>
  33 #include <dpl/optional_typedefs.h>
  34
  35 #include <libxml2/libxml/xmlwriter.h>
  36
  37 #include <libxml_utils.h>
  38 #include <widget_install/manifest.h>
  39 #include <widget_install/job_widget_install.h>
  40 #include <dpl/localization/localization_utils.h>
  41
  42 #include <dpl/wrt-dao-ro/widget_dao_read_only.h>
  43
  44 class InstallerContext;
  45
  46 namespace Jobs {
  47 namespace WidgetInstall {
  48 class TaskManifestFile :
  49     public DPL::TaskDecl<TaskManifestFile>
  50 {
  51   public:
  52
  53     DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  54     DECLARE_EXCEPTION_TYPE(Base, ManifestValidationError)
  55     DECLARE_EXCEPTION_TYPE(Base, ManifestParsingError)
  56
  57     TaskManifestFile(JobWidgetInstall * const &jobContext);
  58     virtual ~TaskManifestFile();
  59
  60   private:
  61     JobWidgetInstall *m_jobContext;
  62
  63     //TODO stepAbort
  64     //steps
  65     void stepCreateExecFile();
  66     void stepCopyIconFiles();
  67 #if USE(WEB_PROVIDER)
  68     void stepCopyLiveboxFiles();
  69 #endif
  70     void stepCopyAccountIconFiles();
  71 #ifdef SERVICE_ENABLED
  72     void stepCopyServiceIconFiles();
  73 #endif
  74     void stepGenerateManifest();
  75     void stepCreateLinkNPPluginsFile();
  76
  77     void stepAbortParseManifest();
  78
  79     void StartStep();
  80     void EndStep();
  81
  82     //private data
  83     std::list<std::string> icon_list; //TODO: this should be registered as
  84                                       // external files
  85     std::ostringstream backup_dir;
  86     xmlTextWriterPtr writer;
  87     DPL::String manifest_name;
  88     DPL::String manifest_file;
  89     std::string commit_manifest;
  90
  91     //private methods
  92
  93     void writeManifest(const DPL::String & path);
  94     void commitManifest();
  95
  96     void setWidgetExecPath(UiApplication & uiApp,
  97                            const std::string &postfix = std::string());
  98     void setWidgetName(Manifest & manifest,
  99                        UiApplication & uiApp);
 100     void setWidgetIds(Manifest & manifest,
 101                        UiApplication & uiApp,
 102                        const std::string &postfix = std::string());
 103     void setWidgetIcons(UiApplication & uiApp);
 104     void setWidgetDescription(Manifest & manifest);
 105     void setWidgetManifest(Manifest & manifest);
 106     void setWidgetOtherInfo(UiApplication & uiApp);
 107     void setAppControlsInfo(UiApplication & uiApp);
 108     void setAppControlInfo(UiApplication & uiApp,
 109                            const WrtDB::ConfigParserData::AppControlInfo & service);
 110     void setAppCategory(UiApplication & uiApp);
 111     void setMetadata(UiApplication & uiApp);
 112 #if USE(WEB_PROVIDER)
 113     void setLiveBoxInfo(Manifest& manifest);
 114 #endif
 115     void setAccount(Manifest& uiApp);
 116     void setPrivilege(Manifest& manifest);
 117
 118     void generateWidgetName(Manifest & manifest,
 119                             UiApplication &uiApp,
 120                             const DPL::OptionalString& tag,
 121                             DPL::OptionalString name,
 122                             bool & defaultNameSaved);
 123     void generateWidgetDescription(Manifest & manifest,
 124                                    const DPL::OptionalString& tag,
 125                                    DPL::OptionalString description);
 126     void generateWidgetIcon(UiApplication & uiApp,
 127                             const DPL::OptionalString& tag,
 128                             const DPL::String& language, const std::string &extension,
 129                             bool isSmall, bool & defaultIconSaved);
 130     void copyFile(const std::string& sourceFile,
 131                   const std::string& targetFile);
 132     bool addBoxUiApplication(Manifest& manifest);
 133
 134     //for widget update
 135     DPL::String getIconTargetFilename(const DPL::String& languageTag,
 136                                       const std::string & ext) const;
 137
 138     static void saveLocalizedKey(std::ofstream &file,
 139                                  const DPL::String& key,
 140                                  const DPL::String& languageTag);
 141
 142     static const char * encoding;
 143
 144 #ifdef IME_ENABLED
 145     void extractImeInfo(ImeApplication& imeApp);
 146     void setWidgetNameIME(ImeApplication& imeApp);
 147     void setWidgetIdsIME(ImeApplication& imeApp, const std::string& postfix = std::string());
 148     void generateWidgetNameIME(ImeApplication& imeApp, const DPL::OptionalString& tag, DPL::OptionalString name, bool& defaultNameSaved);
 149     void setWidgetUuidIME(ImeApplication& imeApp);
 150     void setWidgetLanguageIME(ImeApplication& imeApp);
 151     void setWidgetTypeIME(ImeApplication& imeApp);
 152     void setWidgetOptionIME(ImeApplication& imeApp);
 153 #endif
 154
 155 #ifdef SERVICE_ENABLED
 156     void setServiceInfo(ServiceApplication& serviceApp, WrtDB::ConfigParserData::ServiceAppInfo & service);
 157     void setWidgetExecPathService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 158     void setWidgetIdsService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 159     void setWidgetNameService(ServiceApplication & serviceApp, WrtDB::ConfigParserData::ServiceAppInfo & service);
 160     void setWidgetIconService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 161     void setWidgetOtherInfoService(ServiceApplication & serviceApp);
 162     void setWidgetComponentService(ServiceApplication & serviceApp);
 163     void setWidgetAutoRestartService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 164     void setWidgetOnBootService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 165     void setAppCategoryService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 166     void setMetadataService(ServiceApplication & serviceApp, const WrtDB::ConfigParserData::ServiceAppInfo & service);
 167 #endif
 168 };
 169 } //namespace WidgetInstall
 170 } //namespace Jobs
 171
 172 #endif /* INSTALLER_CORE_JOS_WIDGET_INSTALL_TASK_DESKTOP_FILE_H */