Mercurial > hg > orthanc
annotate Plugins/Engine/PluginsManager.cpp @ 888:d44b845c1c89 plugins
recursive scan for plugins
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Sat, 14 Jun 2014 19:47:51 +0200 |
| parents | 4066e6f2d134 |
| children | d2a393061eb6 |
| rev | line source |
|---|---|
| 887 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, | |
| 4 * Belgium | |
| 5 * | |
| 6 * This program is free software: you can redistribute it and/or | |
| 7 * modify it under the terms of the GNU General Public License as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 10 * | |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 22 * | |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
| 33 #include "PluginsManager.h" | |
| 34 | |
| 35 #include <glog/logging.h> | |
| 36 #include <cassert> | |
| 37 #include <memory> | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
38 #include <boost/filesystem.hpp> |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
39 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
40 #ifdef WIN32 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
41 #define PLUGIN_EXTENSION ".dll" |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
42 #elif defined(__linux) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
43 #define PLUGIN_EXTENSION ".so" |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
44 #else |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
45 #error Support your platform here |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
46 #endif |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
47 |
| 887 | 48 |
| 49 namespace Orthanc | |
| 50 { | |
| 51 static void CallInitialize(SharedLibrary& plugin, | |
| 52 const OrthancPluginContext& context) | |
| 53 { | |
| 54 typedef int32_t (*Initialize) (const OrthancPluginContext*); | |
| 55 | |
| 56 /** | |
| 57 * gcc would complain about "ISO C++ forbids casting between | |
| 58 * pointer-to-function and pointer-to-object" without the trick | |
| 59 * below, that is known as "the POSIX.1-2003 (Technical Corrigendum | |
| 60 * 1) workaround". See the man page of "dlsym()". | |
| 61 * http://www.trilithium.com/johan/2004/12/problem-with-dlsym/ | |
| 62 * http://stackoverflow.com/a/14543811/881731 | |
| 63 **/ | |
| 64 | |
| 65 Initialize initialize; | |
| 66 *(void **) (&initialize) = plugin.GetFunction("OrthancPluginInitialize"); | |
| 67 assert(initialize != NULL); | |
| 68 | |
| 69 int32_t error = initialize(&context); | |
| 70 | |
| 71 if (error != 0) | |
| 72 { | |
| 73 LOG(ERROR) << "Error while initializing plugin " << plugin.GetPath() | |
| 74 << " (code " << error << ")"; | |
| 75 throw OrthancException(ErrorCode_SharedLibrary); | |
| 76 } | |
| 77 } | |
| 78 | |
| 79 | |
| 80 static void CallFinalize(SharedLibrary& plugin) | |
| 81 { | |
| 82 typedef void (*Finalize) (); | |
| 83 | |
| 84 Finalize finalize; | |
| 85 *(void **) (&finalize) = plugin.GetFunction("OrthancPluginFinalize"); | |
| 86 assert(finalize != NULL); | |
| 87 | |
| 88 finalize(); | |
| 89 } | |
| 90 | |
| 91 | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
92 static const char* CallGetName(SharedLibrary& plugin) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
93 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
94 typedef const char* (*GetName) (); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
95 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
96 GetName getName; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
97 *(void **) (&getName) = plugin.GetFunction("OrthancPluginGetName"); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
98 assert(getName != NULL); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
99 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
100 return getName(); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
101 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
102 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
103 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
104 static const char* CallGetVersion(SharedLibrary& plugin) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
105 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
106 typedef const char* (*GetVersion) (); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
107 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
108 GetVersion getVersion; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
109 *(void **) (&getVersion) = plugin.GetFunction("OrthancPluginGetVersion"); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
110 assert(getVersion != NULL); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
111 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
112 return getVersion(); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
113 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
114 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
115 |
| 887 | 116 static void LogError(const char* str) |
| 117 { | |
| 118 LOG(ERROR) << str; | |
| 119 } | |
| 120 | |
| 121 static void LogWarning(const char* str) | |
| 122 { | |
| 123 LOG(WARNING) << str; | |
| 124 } | |
| 125 | |
| 126 static void LogInfo(const char* str) | |
| 127 { | |
| 128 LOG(INFO) << str; | |
| 129 } | |
| 130 | |
| 131 static int32_t InvokeService(const char* serviceName, | |
| 132 const void* serviceParameters) | |
| 133 { | |
| 134 // TODO | |
| 135 return 0; | |
| 136 } | |
| 137 | |
| 138 PluginsManager::PluginsManager() | |
| 139 { | |
| 140 context_.orthancVersion = ORTHANC_VERSION; | |
| 141 context_.InvokeService = InvokeService; | |
| 142 context_.LogError = LogError; | |
| 143 context_.LogWarning = LogWarning; | |
| 144 context_.LogInfo = LogInfo; | |
| 145 } | |
| 146 | |
| 147 PluginsManager::~PluginsManager() | |
| 148 { | |
| 149 for (Plugins::iterator it = plugins_.begin(); it != plugins_.end(); it++) | |
| 150 { | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
151 if (it->second != NULL) |
| 887 | 152 { |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
153 CallFinalize(*(it->second)); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
154 delete it->second; |
| 887 | 155 } |
| 156 } | |
| 157 } | |
| 158 | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
159 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
160 static bool IsOrthancPlugin(SharedLibrary& library) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
161 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
162 return (library.HasFunction("OrthancPluginInitialize") && |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
163 library.HasFunction("OrthancPluginFinalize") && |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
164 library.HasFunction("OrthancPluginGetName") && |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
165 library.HasFunction("OrthancPluginGetVersion")); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
166 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
167 |
| 887 | 168 |
| 169 void PluginsManager::RegisterPlugin(const std::string& path) | |
| 170 { | |
| 171 std::auto_ptr<SharedLibrary> plugin(new SharedLibrary(path)); | |
| 172 | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
173 if (!IsOrthancPlugin(*plugin)) |
| 887 | 174 { |
| 175 LOG(ERROR) << "Plugin " << plugin->GetPath() | |
| 176 << " does not declare the proper entry functions"; | |
| 177 throw OrthancException(ErrorCode_SharedLibrary); | |
| 178 } | |
| 179 | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
180 std::string name(CallGetName(*plugin)); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
181 if (plugins_.find(name) != plugins_.end()) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
182 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
183 LOG(ERROR) << "Plugin '" << name << "' already registered"; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
184 throw OrthancException(ErrorCode_SharedLibrary); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
185 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
186 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
187 LOG(WARNING) << "Registering plugin '" << name |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
188 << "' (version " << CallGetVersion(*plugin) << ")"; |
| 887 | 189 |
| 190 CallInitialize(*plugin, context_); | |
| 191 | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
192 plugins_[name] = plugin.release(); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
193 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
194 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
195 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
196 void PluginsManager::ScanFolderForPlugins(const std::string& path, |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
197 bool isRecursive) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
198 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
199 using namespace boost::filesystem; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
200 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
201 if (!exists(path)) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
202 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
203 return; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
204 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
205 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
206 LOG(INFO) << "Scanning folder " << path << " for plugins"; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
207 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
208 directory_iterator end_it; // default construction yields past-the-end |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
209 for (directory_iterator it(path); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
210 it != end_it; |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
211 ++it) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
212 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
213 if (is_directory(it->status())) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
214 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
215 if (isRecursive) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
216 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
217 ScanFolderForPlugins(it->path().string(), true); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
218 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
219 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
220 else |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
221 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
222 if (boost::filesystem::extension(it->path()) == PLUGIN_EXTENSION) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
223 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
224 LOG(INFO) << "Found a shared library: " << it->path(); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
225 |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
226 try |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
227 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
228 SharedLibrary plugin(it->path().string()); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
229 if (IsOrthancPlugin(plugin)) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
230 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
231 RegisterPlugin(it->path().string()); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
232 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
233 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
234 catch (OrthancException&) |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
235 { |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
236 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
237 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
238 } |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
887
diff
changeset
|
239 } |
| 887 | 240 } |
| 241 | |
| 242 } |