Mercurial > hg > orthanc
changeset 2463:be5c0f4155f6
move SharedLibrary into OrthancFramework
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 05 Jan 2018 10:10:07 +0100 |
| parents | d61e73357674 |
| children | 61fc5133e5d5 |
| files | CMakeLists.txt Core/SharedLibrary.cpp Core/SharedLibrary.h Plugins/Engine/IPluginServiceProvider.h Plugins/Engine/OrthancPluginDatabase.h Plugins/Engine/PluginsErrorDictionary.h Plugins/Engine/PluginsManager.cpp Plugins/Engine/PluginsManager.h Plugins/Engine/SharedLibrary.cpp Plugins/Engine/SharedLibrary.h Resources/CMake/OrthancFrameworkConfiguration.cmake UnitTestsSources/PluginsTests.cpp |
| diffstat | 12 files changed, 225 insertions(+), 227 deletions(-) [+] |
line wrap: on
line diff
--- a/CMakeLists.txt Fri Jan 05 09:35:56 2018 +0100 +++ b/CMakeLists.txt Fri Jan 05 10:10:07 2018 +0100 @@ -124,7 +124,6 @@ Plugins/Engine/PluginsEnumerations.cpp Plugins/Engine/PluginsErrorDictionary.cpp Plugins/Engine/PluginsManager.cpp - Plugins/Engine/SharedLibrary.cpp ) list(APPEND ORTHANC_UNIT_TESTS_SOURCES
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Core/SharedLibrary.cpp Fri Jan 05 10:10:07 2018 +0100 @@ -0,0 +1,136 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics + * Department, University Hospital of Liege, Belgium + * Copyright (C) 2017-2018 Osimis S.A., 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 "PrecompiledHeaders.h" +#include "SharedLibrary.h" + +#include "Logging.h" +#include "OrthancException.h" + +#include <boost/filesystem.hpp> + +#if defined(_WIN32) +#include <windows.h> +#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) +#include <dlfcn.h> +#else +#error Support your platform here +#endif + +namespace Orthanc +{ + SharedLibrary::SharedLibrary(const std::string& path) : + path_(path), + handle_(NULL) + { +#if defined(_WIN32) + handle_ = ::LoadLibraryA(path_.c_str()); + if (handle_ == NULL) + { + LOG(ERROR) << "LoadLibrary(" << path_ << ") failed: Error " << ::GetLastError(); + throw OrthancException(ErrorCode_SharedLibrary); + } + +#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) + handle_ = ::dlopen(path_.c_str(), RTLD_NOW); + if (handle_ == NULL) + { + std::string explanation; + const char *tmp = ::dlerror(); + if (tmp) + { + explanation = ": Error " + std::string(tmp); + } + + LOG(ERROR) << "dlopen(" << path_ << ") failed" << explanation; + throw OrthancException(ErrorCode_SharedLibrary); + } + +#else +#error Support your platform here +#endif + } + + SharedLibrary::~SharedLibrary() + { + if (handle_) + { +#if defined(_WIN32) + ::FreeLibrary((HMODULE)handle_); +#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) + ::dlclose(handle_); +#else +#error Support your platform here +#endif + } + } + + + SharedLibrary::FunctionPointer SharedLibrary::GetFunctionInternal(const std::string& name) + { + if (!handle_) + { + throw OrthancException(ErrorCode_InternalError); + } + +#if defined(_WIN32) + return ::GetProcAddress((HMODULE)handle_, name.c_str()); +#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) + return ::dlsym(handle_, name.c_str()); +#else +#error Support your platform here +#endif + } + + + SharedLibrary::FunctionPointer SharedLibrary::GetFunction(const std::string& name) + { + SharedLibrary::FunctionPointer result = GetFunctionInternal(name); + + if (result == NULL) + { + LOG(ERROR) << "Shared library does not expose function \"" << name << "\""; + throw OrthancException(ErrorCode_SharedLibrary); + } + else + { + return result; + } + } + + + bool SharedLibrary::HasFunction(const std::string& name) + { + return GetFunctionInternal(name) != NULL; + } +}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Core/SharedLibrary.h Fri Jan 05 10:10:07 2018 +0100 @@ -0,0 +1,82 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics + * Department, University Hospital of Liege, Belgium + * Copyright (C) 2017-2018 Osimis S.A., 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 + +#if !defined(ORTHANC_SANDBOXED) +# error The macro ORTHANC_SANDBOXED must be defined +#endif + +#if ORTHANC_SANDBOXED == 1 +# error The namespace SystemToolbox cannot be used in sandboxed environments +#endif + +#if defined(_WIN32) +#include <windows.h> +#endif + +#include <string> +#include <boost/noncopyable.hpp> + +namespace Orthanc +{ + class SharedLibrary : public boost::noncopyable + { + public: +#if defined(_WIN32) + typedef FARPROC FunctionPointer; +#else + typedef void* FunctionPointer; +#endif + + private: + std::string path_; + void *handle_; + + FunctionPointer GetFunctionInternal(const std::string& name); + + public: + explicit SharedLibrary(const std::string& path); + + ~SharedLibrary(); + + const std::string& GetPath() const + { + return path_; + } + + bool HasFunction(const std::string& name); + + FunctionPointer GetFunction(const std::string& name); + }; +}
--- a/Plugins/Engine/IPluginServiceProvider.h Fri Jan 05 09:35:56 2018 +0100 +++ b/Plugins/Engine/IPluginServiceProvider.h Fri Jan 05 10:10:07 2018 +0100 @@ -37,7 +37,7 @@ #include "../Include/orthanc/OrthancCPlugin.h" -#include "SharedLibrary.h" +#include "../../Core/SharedLibrary.h" namespace Orthanc {
--- a/Plugins/Engine/OrthancPluginDatabase.h Fri Jan 05 09:35:56 2018 +0100 +++ b/Plugins/Engine/OrthancPluginDatabase.h Fri Jan 05 10:10:07 2018 +0100 @@ -35,10 +35,10 @@ #if ORTHANC_ENABLE_PLUGINS == 1 +#include "../../Core/SharedLibrary.h" #include "../../OrthancServer/IDatabaseWrapper.h" #include "../Include/orthanc/OrthancCDatabasePlugin.h" #include "PluginsErrorDictionary.h" -#include "SharedLibrary.h" namespace Orthanc {
--- a/Plugins/Engine/PluginsErrorDictionary.h Fri Jan 05 09:35:56 2018 +0100 +++ b/Plugins/Engine/PluginsErrorDictionary.h Fri Jan 05 10:10:07 2018 +0100 @@ -37,7 +37,7 @@ #include "../Include/orthanc/OrthancCPlugin.h" #include "../../Core/OrthancException.h" -#include "SharedLibrary.h" +#include "../../Core/SharedLibrary.h" #include <map> #include <string>
--- a/Plugins/Engine/PluginsManager.cpp Fri Jan 05 09:35:56 2018 +0100 +++ b/Plugins/Engine/PluginsManager.cpp Fri Jan 05 10:10:07 2018 +0100 @@ -38,10 +38,10 @@ #error The plugin support is disabled #endif - -#include "../../Core/Toolbox.h" #include "../../Core/HttpServer/HttpOutput.h" #include "../../Core/Logging.h" +#include "../../Core/OrthancException.h" +#include "../../Core/Toolbox.h" #include <cassert> #include <memory>
--- a/Plugins/Engine/PluginsManager.h Fri Jan 05 09:35:56 2018 +0100 +++ b/Plugins/Engine/PluginsManager.h Fri Jan 05 10:10:07 2018 +0100 @@ -35,7 +35,6 @@ #if ORTHANC_ENABLE_PLUGINS == 1 -#include "SharedLibrary.h" #include "IPluginServiceProvider.h" #include <map>
--- a/Plugins/Engine/SharedLibrary.cpp Fri Jan 05 09:35:56 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,141 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., 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 "../../OrthancServer/PrecompiledHeadersServer.h" -#include "SharedLibrary.h" - -#if ORTHANC_ENABLE_PLUGINS != 1 -#error The plugin support is disabled -#endif - - -#include "../../Core/Logging.h" -#include "../../Core/Toolbox.h" - -#include <boost/filesystem.hpp> - -#if defined(_WIN32) -#include <windows.h> -#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) -#include <dlfcn.h> -#else -#error Support your platform here -#endif - -namespace Orthanc -{ - SharedLibrary::SharedLibrary(const std::string& path) : - path_(path), - handle_(NULL) - { -#if defined(_WIN32) - handle_ = ::LoadLibraryA(path_.c_str()); - if (handle_ == NULL) - { - LOG(ERROR) << "LoadLibrary(" << path_ << ") failed: Error " << ::GetLastError(); - throw OrthancException(ErrorCode_SharedLibrary); - } - -#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) - handle_ = ::dlopen(path_.c_str(), RTLD_NOW); - if (handle_ == NULL) - { - std::string explanation; - const char *tmp = ::dlerror(); - if (tmp) - { - explanation = ": Error " + std::string(tmp); - } - - LOG(ERROR) << "dlopen(" << path_ << ") failed" << explanation; - throw OrthancException(ErrorCode_SharedLibrary); - } - -#else -#error Support your platform here -#endif - } - - SharedLibrary::~SharedLibrary() - { - if (handle_) - { -#if defined(_WIN32) - ::FreeLibrary((HMODULE)handle_); -#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) - ::dlclose(handle_); -#else -#error Support your platform here -#endif - } - } - - - SharedLibrary::FunctionPointer SharedLibrary::GetFunctionInternal(const std::string& name) - { - if (!handle_) - { - throw OrthancException(ErrorCode_InternalError); - } - -#if defined(_WIN32) - return ::GetProcAddress((HMODULE)handle_, name.c_str()); -#elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) - return ::dlsym(handle_, name.c_str()); -#else -#error Support your platform here -#endif - } - - - SharedLibrary::FunctionPointer SharedLibrary::GetFunction(const std::string& name) - { - SharedLibrary::FunctionPointer result = GetFunctionInternal(name); - - if (result == NULL) - { - LOG(ERROR) << "Shared library does not expose function \"" << name << "\""; - throw OrthancException(ErrorCode_SharedLibrary); - } - else - { - return result; - } - } - - - bool SharedLibrary::HasFunction(const std::string& name) - { - return GetFunctionInternal(name) != NULL; - } -}
--- a/Plugins/Engine/SharedLibrary.h Fri Jan 05 09:35:56 2018 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,79 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., 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 - -#if ORTHANC_ENABLE_PLUGINS == 1 - -#include "../../Core/OrthancException.h" - -#include <boost/noncopyable.hpp> - -#if defined(_WIN32) -#include <windows.h> -#endif - -namespace Orthanc -{ - class SharedLibrary : public boost::noncopyable - { - public: -#if defined(_WIN32) - typedef FARPROC FunctionPointer; -#else - typedef void* FunctionPointer; -#endif - - private: - std::string path_; - void *handle_; - - FunctionPointer GetFunctionInternal(const std::string& name); - - public: - explicit SharedLibrary(const std::string& path); - - ~SharedLibrary(); - - const std::string& GetPath() const - { - return path_; - } - - bool HasFunction(const std::string& name); - - FunctionPointer GetFunction(const std::string& name); - }; -} - -#endif
--- a/Resources/CMake/OrthancFrameworkConfiguration.cmake Fri Jan 05 09:35:56 2018 +0100 +++ b/Resources/CMake/OrthancFrameworkConfiguration.cmake Fri Jan 05 10:10:07 2018 +0100 @@ -446,6 +446,7 @@ ${ORTHANC_ROOT}/Core/MultiThreading/RunnableWorkersPool.cpp ${ORTHANC_ROOT}/Core/MultiThreading/Semaphore.cpp ${ORTHANC_ROOT}/Core/MultiThreading/SharedMessageQueue.cpp + ${ORTHANC_ROOT}/Core/SharedLibrary.cpp ${ORTHANC_ROOT}/Core/SystemToolbox.cpp ${ORTHANC_ROOT}/Core/TemporaryFile.cpp )
--- a/UnitTestsSources/PluginsTests.cpp Fri Jan 05 09:35:56 2018 +0100 +++ b/UnitTestsSources/PluginsTests.cpp Fri Jan 05 10:10:07 2018 +0100 @@ -34,6 +34,7 @@ #include "PrecompiledHeadersUnitTests.h" #include "gtest/gtest.h" +#include "../../Core/OrthancException.h" #include "../Plugins/Engine/PluginsManager.h" using namespace Orthanc;