modules/widget_dao/include/dpl/wrt-dao-ro/plugin_dao_read_only.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    plugin_dao_read_only.h
  18  * @author  Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
  19  * @version 1.0
  20  * @brief   This file contains the declaration of plugin dao read only
  21  */
  22
  23 #ifndef WRT_SRC_CONFIGURATION_PLUGIN_DAO_READ_ONLY_H_
  24 #define WRT_SRC_CONFIGURATION_PLUGIN_DAO_READ_ONLY_H_
  25
  26 #include <ctime>
  27 #include <string>
  28 #include <list>
  29 #include <memory>
  30 #include <dpl/exception.h>
  31 #include <dpl/wrt-dao-ro/common_dao_types.h>
  32
  33 namespace WrtDB {
  34 typedef std::list<DbPluginHandle> PluginHandleList;
  35 typedef std::set<DbPluginHandle> PluginHandleSet;
  36 typedef std::list<std::string> ImplementedObjectsList;
  37 typedef std::shared_ptr<PluginHandleSet> PluginHandleSetPtr;
  38
  39 //TODO make it friend to FeatureDAO or inherit
  40 class PluginDAOReadOnly
  41 {
  42   public:
  43     enum PluginInstallationState
  44     {
  45         INSTALLATION_DEFAULT,
  46         //when plugin data are up to date and plugin model may be created
  47         INSTALLATION_COMPLETED,
  48         //installation is in progress, some data may not be valid
  49         INSTALLATION_IN_PROGRESS,
  50         //installation not completed due to missing dependency
  51         INSTALLATION_WAITING,
  52
  53         UNKNOWN_ERROR
  54     };
  55
  56     static int ToInt(PluginInstallationState state)
  57     {
  58         return static_cast<int>(state);
  59     }
  60
  61     static PluginInstallationState ToState(int state)
  62     {
  63         return static_cast<PluginDAOReadOnly::PluginInstallationState>(state);
  64     }
  65
  66     /**
  67      * PluginDAO Exception classes
  68      */
  69     class Exception
  70     {
  71       public:
  72         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  73         DECLARE_EXCEPTION_TYPE(Base, DatabaseError)
  74         DECLARE_EXCEPTION_TYPE(Base, PluginNotExist)
  75     };
  76
  77   public:
  78     PluginDAOReadOnly(DbPluginHandle pluginHandle);
  79     PluginDAOReadOnly(const std::string &libraryName);
  80
  81     static PluginHandleList getPluginHandleList();
  82     static PluginHandleList getRootPluginHandleList();
  83
  84     static bool isPluginInstalled(const std::string &libraryName);
  85     static bool isPluginInstalled(DbPluginHandle pluginHandle);
  86
  87     static PluginHandleSetPtr getPluginHandleByStatus(
  88         PluginInstallationState state);
  89
  90     static DbPluginHandle getPluginHandleForImplementedObject(
  91         const std::string& objectName);
  92
  93     static ImplementedObjectsList getImplementedObjects();
  94     static ImplementedObjectsList getImplementedObjectsForPluginHandle(
  95         DbPluginHandle handle);
  96
  97     static PluginObjectsDAO::ObjectsPtr getRequiredObjectsForPluginHandle(
  98         DbPluginHandle handle);
  99
 100     static PluginInstallationState getInstallationStateForHandle(
 101         DbPluginHandle handle);
 102
 103     DbPluginHandle getPluginHandle() const;
 104     PluginInstallationState getInstallationStatus() const;
 105     std::string  getLibraryPath() const;
 106     std::string  getLibraryName() const;
 107     std::time_t getLibraryTimestamp() const;
 108     PluginHandleSetPtr getLibraryDependencies() const;
 109     PluginHandleSetPtr getLibraryDependentPlugins() const;
 110
 111   private:
 112     DbPluginHandle m_pluginHandle;
 113
 114     void checkInstallationCompleted();
 115 };
 116 } // namespace WrtDB
 117
 118 #endif /* WRT_SRC_CONFIGURATION_PLUGIN_DAO_READ_ONLY_H_ */