2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @file plugin_logic.cpp
18 * @author Piotr Fatyga (p.fatyga@samsung.com)
19 * @author Grzegorz Krawczyk (g.krawczyk@samsung.com)
20 * @author Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
22 * @brief This file is the implementation file of plugin and
23 * feature loading routines
24 * @brief This code is intended to work behind view controller
27 #include "plugin_logic.h"
29 #include <dpl/assert.h>
30 #include <dpl/scoped_array.h>
31 #include <dpl/log/log.h>
32 #include <dpl/foreach.h>
33 #include <dpl/singleton_impl.h>
34 #include <dpl/wrt-dao-ro/widget_dao_read_only.h>
35 #include <dpl/wrt-dao-ro/common_dao_types.h>
36 #include <dpl/wrt-dao-ro/global_config.h>
38 #include <JavaScriptCore/JavaScript.h>
41 #include <sys/types.h>
52 #include <wrt_plugin_export.h>
53 #include <js_overlay_types.h>
57 #include "plugin_model.h"
58 #include "javascript_interface.h"
59 #include "js_function_manager.h"
60 #include "plugin_container_support.h"
62 #include "js_page_session.h"
65 using namespace WrtDB;
66 using namespace WrtPlugins::W3C;
69 const char *LIBRARY_PATH_SEPARATOR = "/";
70 const char* FEATURE_WAC20_DEVICAPIS_NAME = "http://wacapps.net/api/deviceapis";
73 class PluginLogic::Impl
75 PluginContainerSupportPtr m_pluginsSupport;
77 typedef std::map<JSContextRef, JSPageSessionPtr> PagesSessionsSet;
78 PagesSessionsSet m_sessions;
86 void startSession(int widgetHandle,
87 JSGlobalContextRef context,
89 const char* encodedBundle,
92 void stopSession(JSGlobalContextRef context);
94 void performLibrariesUnload();
96 bool loadPluginOnDemand(const WrtDB::DbPluginHandle &pluginHandle,
97 JavaScriptObject& parentObject,
98 JSGlobalContextRef context);
100 void loadFrame(JSGlobalContextRef context);
101 void unloadFrame(JSGlobalContextRef context);
103 void setCustomProperties(JSGlobalContextRef ctx,
105 const char* encodedBundle,
108 void dispatchJavaScriptEvent(JSGlobalContextRef ctx,
109 CustomEventType eventType,
112 static bool s_sanityCheck;
115 IMPLEMENT_SINGLETON(PluginLogic);
117 bool PluginLogic::Impl::s_sanityCheck = false;
119 #define PLUGIN_LOGIC_SANITY_CHECK \
122 LogError("Object is not available. Wrong flow occured");\
126 PluginLogic::Impl::Impl()
128 s_sanityCheck = true;
130 DPL::Log::LogSystemSingleton::Instance().SetTag("WRT_PLUGINS");
131 LogDebug("Initializing Plugin Logic...");
132 m_pluginsSupport = PluginContainerSupportPtr(new PluginContainerSupport());
134 // explicit call to keep singleton's lifetime until calling destructor.
135 JsFunctionManagerSingleton::Instance();
136 JavaScriptInterfaceSingleton::Instance();
139 PluginLogic::Impl::~Impl()
143 s_sanityCheck = false;
145 FOREACH(it, m_sessions)
147 LogError("Must stop widget session before exit!");
148 it->second->stopSession();
151 LogDebug("Deinitializing plugin Logic...");
155 void PluginLogic::startSession(int widgetHandle,
156 JSGlobalContextRef ctx,
158 const char* encodedBundle,
161 m_impl->startSession(widgetHandle, ctx, scaleFactor, encodedBundle, theme);
164 void PluginLogic::stopSession(JSGlobalContextRef context)
166 m_impl->stopSession(context);
169 void PluginLogic::performLibrariesUnload()
171 LogError("Libraries unload TURNED OFF");
172 // m_impl->performLibrariesUnload();
175 bool PluginLogic::loadPluginOnDemand(
176 const WrtDB::DbPluginHandle &pluginHandle,
177 JavaScriptObject& parentObject,
178 JSGlobalContextRef context)
180 return m_impl->loadPluginOnDemand(pluginHandle, parentObject, context);
183 void PluginLogic::loadPluginsIntoIframes(JSGlobalContextRef context)
185 LogError("This function is Deprecated");
188 void PluginLogic::setCustomProperties(double scaleFactor,
189 const char* encodedBundle,
192 LogError("This function is DEPRECATED");
195 void PluginLogic::setCustomProperties(JSGlobalContextRef context,
197 const char* encodedBundle,
200 m_impl->setCustomProperties(context, scaleFactor, encodedBundle, theme);
203 void PluginLogic::dispatchJavaScriptEvent(CustomEventType eventType)
205 LogError("This function is DEPRECATED");
208 void PluginLogic::dispatchJavaScriptEvent(JSGlobalContextRef context,
209 CustomEventType eventType,
212 m_impl->dispatchJavaScriptEvent(context, eventType, data);
215 void PluginLogic::loadFrame(JSGlobalContextRef context)
217 m_impl->loadFrame(context);
220 void PluginLogic::unloadFrame(JSGlobalContextRef context)
222 m_impl->unloadFrame(context);
225 PluginLogic::PluginLogic() : m_impl(new PluginLogic::Impl())
229 PluginLogic::~PluginLogic()
233 void PluginLogic::Impl::startSession(int widgetHandle,
234 JSGlobalContextRef context,
236 const char* encodedBundle,
239 LogInfo("Starting widget session...");
241 if (!m_pluginsSupport->isInitialized()) {
242 m_pluginsSupport->readRootPlugins(widgetHandle);
243 m_pluginsSupport->readAllowedPlugins(widgetHandle);
245 auto sessionIt = m_sessions.find(context);
247 // Check if corresponding session if not already created
248 if (sessionIt != m_sessions.end())
250 LogWarning("Session already started!");
254 auto newSession = JSPageSessionPtr(new JSPageSession(m_pluginsSupport));
255 newSession->startSession(widgetHandle,
261 m_sessions[context] = newSession;
264 void PluginLogic::Impl::stopSession(JSGlobalContextRef context)
266 LogInfo("Stopping widget session...");
268 auto sessionIt = m_sessions.find(context);
269 if (sessionIt == m_sessions.end())
271 LogError("Session not exist!");
275 sessionIt->second->stopSession();
276 m_sessions.erase(sessionIt);
278 LogInfo("Widget session stopped.");
281 bool PluginLogic::Impl::loadPluginOnDemand(
282 const WrtDB::DbPluginHandle &pluginHandle,
283 JavaScriptObject& parentObject,
284 JSGlobalContextRef context
287 LogInfo("Load plugin on demand");
289 auto sessionIt = m_sessions.find(context);
290 if (sessionIt == m_sessions.end())
292 LogWarning("Session not exist!");
296 return sessionIt->second->loadPluginOnDemand(pluginHandle,
301 void PluginLogic::Impl::loadFrame(JSGlobalContextRef context)
303 LogDebug("Load a frame");
305 PLUGIN_LOGIC_SANITY_CHECK
307 auto sessionIt = m_sessions.find(context);
308 if (sessionIt == m_sessions.end())
310 LogWarning("Session not exist!");
314 sessionIt->second->loadFrame(context);
317 void PluginLogic::Impl::unloadFrame(JSGlobalContextRef context)
319 LogDebug("Unload a frame");
321 PLUGIN_LOGIC_SANITY_CHECK
323 auto sessionIt = m_sessions.find(context);
324 if (sessionIt == m_sessions.end())
326 LogWarning("Session not exist!");
330 sessionIt->second->unloadFrame(context);
331 m_sessions.erase(sessionIt);
334 void PluginLogic::Impl::setCustomProperties(JSGlobalContextRef context,
336 const char* encodedBundle,
339 LogInfo("set properties of window object " << scaleFactor << ", "
340 << encodedBundle << ", " << theme);
342 PLUGIN_LOGIC_SANITY_CHECK
344 auto sessionIt = m_sessions.find(context);
345 if (sessionIt == m_sessions.end())
347 LogWarning("Session not exist!");
351 sessionIt->second->setCustomProperties(scaleFactor,
357 void PluginLogic::Impl::dispatchJavaScriptEvent(JSGlobalContextRef context,
358 CustomEventType eventType,
361 LogDebug("Dispatch event");
363 PLUGIN_LOGIC_SANITY_CHECK
365 auto sessionIt = m_sessions.find(context);
366 if (sessionIt == m_sessions.end())
368 LogWarning("Session not exist!");
372 sessionIt->second->dispatchJavaScriptEvent(eventType, data);