Mercurial > hg > orthanc
changeset 887:4066e6f2d134 plugins
PluginsManager
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 14 Jun 2014 19:20:38 +0200 |
parents | 29087d728e0a |
children | d44b845c1c89 |
files | CMakeLists.txt Plugins/Engine/PluginsManager.cpp Plugins/Engine/PluginsManager.h Plugins/Engine/SharedLibrary.cpp Plugins/Engine/SharedLibrary.h UnitTestsSources/PluginsTests.cpp |
diffstat | 6 files changed, 217 insertions(+), 62 deletions(-) [+] |
line wrap: on
line diff
--- a/CMakeLists.txt Sat Jun 14 18:50:14 2014 +0200 +++ b/CMakeLists.txt Sat Jun 14 19:20:38 2014 +0200 @@ -116,6 +116,7 @@ OrthancCppClient/Patient.cpp Plugins/Engine/SharedLibrary.cpp + Plugins/Engine/PluginsManager.cpp )
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Engine/PluginsManager.cpp Sat Jun 14 19:20:38 2014 +0200 @@ -0,0 +1,145 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, + * Belgium + * + * This program is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * In addition, as a special exception, the copyright holders of this + * program give permission to link the code of its release with the + * OpenSSL project's "OpenSSL" library (or with modified versions of it + * that use the same license as the "OpenSSL" library), and distribute + * the linked executables. You must obey the GNU General Public License + * in all respects for all of the code used other than "OpenSSL". If you + * modify file(s) with this exception, you may extend this exception to + * your version of the file(s), but you are not obligated to do so. If + * you do not wish to do so, delete this exception statement from your + * version. If you delete this exception statement from all source files + * in the program, then also delete it here. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + **/ + + +#include "PluginsManager.h" + +#include <glog/logging.h> +#include <cassert> +#include <memory> + +namespace Orthanc +{ + static void CallInitialize(SharedLibrary& plugin, + const OrthancPluginContext& context) + { + typedef int32_t (*Initialize) (const OrthancPluginContext*); + + /** + * gcc would complain about "ISO C++ forbids casting between + * pointer-to-function and pointer-to-object" without the trick + * below, that is known as "the POSIX.1-2003 (Technical Corrigendum + * 1) workaround". See the man page of "dlsym()". + * http://www.trilithium.com/johan/2004/12/problem-with-dlsym/ + * http://stackoverflow.com/a/14543811/881731 + **/ + + Initialize initialize; + *(void **) (&initialize) = plugin.GetFunction("OrthancPluginInitialize"); + assert(initialize != NULL); + + int32_t error = initialize(&context); + + if (error != 0) + { + LOG(ERROR) << "Error while initializing plugin " << plugin.GetPath() + << " (code " << error << ")"; + throw OrthancException(ErrorCode_SharedLibrary); + } + } + + + static void CallFinalize(SharedLibrary& plugin) + { + typedef void (*Finalize) (); + + Finalize finalize; + *(void **) (&finalize) = plugin.GetFunction("OrthancPluginFinalize"); + assert(finalize != NULL); + + finalize(); + } + + + static void LogError(const char* str) + { + LOG(ERROR) << str; + } + + static void LogWarning(const char* str) + { + LOG(WARNING) << str; + } + + static void LogInfo(const char* str) + { + LOG(INFO) << str; + } + + static int32_t InvokeService(const char* serviceName, + const void* serviceParameters) + { + // TODO + return 0; + } + + PluginsManager::PluginsManager() + { + context_.orthancVersion = ORTHANC_VERSION; + context_.InvokeService = InvokeService; + context_.LogError = LogError; + context_.LogWarning = LogWarning; + context_.LogInfo = LogInfo; + } + + PluginsManager::~PluginsManager() + { + for (Plugins::iterator it = plugins_.begin(); it != plugins_.end(); it++) + { + if (*it != NULL) + { + CallFinalize(**it); + delete *it; + } + } + } + + + void PluginsManager::RegisterPlugin(const std::string& path) + { + std::auto_ptr<SharedLibrary> plugin(new SharedLibrary(path)); + + if (!plugin->HasFunction("OrthancPluginInitialize") || + !plugin->HasFunction("OrthancPluginFinalize")) + { + LOG(ERROR) << "Plugin " << plugin->GetPath() + << " does not declare the proper entry functions"; + throw OrthancException(ErrorCode_SharedLibrary); + } + + LOG(WARNING) << "Registering plugin " << path; + + CallInitialize(*plugin, context_); + + plugins_.push_back(plugin.release()); + } + +}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Engine/PluginsManager.h Sat Jun 14 19:20:38 2014 +0200 @@ -0,0 +1,57 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, + * Belgium + * + * This program is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * In addition, as a special exception, the copyright holders of this + * program give permission to link the code of its release with the + * OpenSSL project's "OpenSSL" library (or with modified versions of it + * that use the same license as the "OpenSSL" library), and distribute + * the linked executables. You must obey the GNU General Public License + * in all respects for all of the code used other than "OpenSSL". If you + * modify file(s) with this exception, you may extend this exception to + * your version of the file(s), but you are not obligated to do so. If + * you do not wish to do so, delete this exception statement from your + * version. If you delete this exception statement from all source files + * in the program, then also delete it here. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + **/ + + +#pragma once + +#include "SharedLibrary.h" +#include "../OrthancCPlugin/OrthancCPlugin.h" + +#include <list> + +namespace Orthanc +{ + class PluginsManager : boost::noncopyable + { + private: + typedef std::list<SharedLibrary*> Plugins; + + OrthancPluginContext context_; + Plugins plugins_; + + public: + PluginsManager(); + + ~PluginsManager(); + + void RegisterPlugin(const std::string& path); + }; +}
--- a/Plugins/Engine/SharedLibrary.cpp Sat Jun 14 18:50:14 2014 +0200 +++ b/Plugins/Engine/SharedLibrary.cpp Sat Jun 14 19:20:38 2014 +0200 @@ -46,7 +46,9 @@ namespace Orthanc { - SharedLibrary::SharedLibrary(const std::string& path) : handle_(NULL) + SharedLibrary::SharedLibrary(const std::string& path) : + path_(path), + handle_(NULL) { #if defined(_WIN32) handle_ = ::LoadLibraryA(path.c_str());
--- a/Plugins/Engine/SharedLibrary.h Sat Jun 14 18:50:14 2014 +0200 +++ b/Plugins/Engine/SharedLibrary.h Sat Jun 14 19:20:38 2014 +0200 @@ -41,6 +41,7 @@ class SharedLibrary : boost::noncopyable { private: + std::string path_; void *handle_; void* GetFunctionInternal(const std::string& name); @@ -50,6 +51,11 @@ ~SharedLibrary(); + const std::string& GetPath() const + { + return path_; + } + bool HasFunction(const std::string& name); void* GetFunction(const std::string& name);
--- a/UnitTestsSources/PluginsTests.cpp Sat Jun 14 18:50:14 2014 +0200 +++ b/UnitTestsSources/PluginsTests.cpp Sat Jun 14 19:20:38 2014 +0200 @@ -35,8 +35,7 @@ #include <glog/logging.h> -#include "../Plugins/Engine/SharedLibrary.h" -#include "../Plugins/OrthancCPlugin/OrthancCPlugin.h" +#include "../Plugins/Engine/PluginsManager.h" using namespace Orthanc; @@ -59,72 +58,17 @@ } - -static void LogError(const char* str) -{ - LOG(ERROR) << str; -} - -static void LogWarning(const char* str) -{ - LOG(WARNING) << str; -} - -static void LogInfo(const char* str) -{ - LOG(INFO) << str; -} - -static int32_t InvokeService(const char* serviceName, - const void* serviceParameters) -{ - return 0; -} - - - TEST(SharedLibrary, Development) { + PluginsManager manager; + #if defined(_WIN32) #error Support your platform here #elif defined(__linux) - SharedLibrary l("./libPluginTest.so"); - ASSERT_TRUE(l.HasFunction("OrthancPluginFinalize")); - ASSERT_TRUE(l.HasFunction("OrthancPluginInitialize")); - - OrthancPluginContext context; - context.orthancVersion = ORTHANC_VERSION; - context.InvokeService = InvokeService; - context.LogError = LogError; - context.LogWarning = LogWarning; - context.LogInfo = LogInfo; - - typedef void (*Finalize) (); - typedef int32_t (*Initialize) (const OrthancPluginContext*); - - /** - * gcc would complain about "ISO C++ forbids casting between - * pointer-to-function and pointer-to-object" without the trick - * below, that is known as "the POSIX.1-2003 (Technical Corrigendum - * 1) workaround". See the man page of "dlsym()". - * http://www.trilithium.com/johan/2004/12/problem-with-dlsym/ - * http://stackoverflow.com/a/14543811/881731 - **/ - - Finalize finalize; - *(void **) (&finalize) = l.GetFunction("OrthancPluginFinalize"); - assert(finalize != NULL); - - Initialize initialize; - *(void **) (&initialize) = l.GetFunction("OrthancPluginInitialize"); - assert(initialize != NULL); - - initialize(&context); - finalize(); + manager.RegisterPlugin("./libPluginTest.so"); #else #error Support your platform here -#endif - +#endif }