annotate Framework/Orthanc/Plugins/Engine/SharedLibrary.cpp @ 1:dc730d11b101

orthanc dependencies
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 22 Oct 2016 21:50:15 +0200
parents
children 533cbc4d520c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #include "../../OrthancServer/PrecompiledHeadersServer.h"
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #include "SharedLibrary.h"
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #if ORTHANC_PLUGINS_ENABLED != 1
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #error The plugin support is disabled
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #endif
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 #include "../../Core/Logging.h"
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 #include "../../Core/Toolbox.h"
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 #include <boost/filesystem.hpp>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 #if defined(_WIN32)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 #include <windows.h>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 #elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 #include <dlfcn.h>
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 #else
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 #error Support your platform here
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 #endif
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 namespace Orthanc
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 SharedLibrary::SharedLibrary(const std::string& path) :
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 path_(path),
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 handle_(NULL)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 #if defined(_WIN32)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 handle_ = ::LoadLibraryA(path_.c_str());
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 if (handle_ == NULL)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 LOG(ERROR) << "LoadLibrary(" << path_ << ") failed: Error " << ::GetLastError();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 throw OrthancException(ErrorCode_SharedLibrary);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 #elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 handle_ = ::dlopen(path_.c_str(), RTLD_NOW);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 if (handle_ == NULL)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 std::string explanation;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 const char *tmp = ::dlerror();
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 if (tmp)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 explanation = ": Error " + std::string(tmp);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 LOG(ERROR) << "dlopen(" << path_ << ") failed" << explanation;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 throw OrthancException(ErrorCode_SharedLibrary);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 #else
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 #error Support your platform here
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 #endif
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 SharedLibrary::~SharedLibrary()
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 if (handle_)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 #if defined(_WIN32)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 ::FreeLibrary((HMODULE)handle_);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 #elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 ::dlclose(handle_);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 #else
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 #error Support your platform here
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 #endif
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 SharedLibrary::FunctionPointer SharedLibrary::GetFunctionInternal(const std::string& name)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 if (!handle_)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 throw OrthancException(ErrorCode_InternalError);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 #if defined(_WIN32)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 return ::GetProcAddress((HMODULE)handle_, name.c_str());
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 #elif defined(__linux__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 return ::dlsym(handle_, name.c_str());
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 #else
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 #error Support your platform here
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 #endif
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 SharedLibrary::FunctionPointer SharedLibrary::GetFunction(const std::string& name)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 SharedLibrary::FunctionPointer result = GetFunctionInternal(name);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 if (result == NULL)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 LOG(ERROR) << "Shared library does not expose function \"" << name << "\"";
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 throw OrthancException(ErrorCode_SharedLibrary);
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 else
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 return result;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 bool SharedLibrary::HasFunction(const std::string& name)
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 {
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 return GetFunctionInternal(name) != NULL;
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 }
dc730d11b101 orthanc dependencies
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 }