Mercurial > hg > orthanc-python
annotate Sources/RestCallbacks.cpp @ 191:30ed49f2487f java-code-model
removed pointless function orthanc.CreateMemoryBuffer()
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 02 Jul 2024 18:00:52 +0200 |
| parents | c8de83fe7faa |
| children | 3757a7b9e6f1 |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 2 * Python plugin for Orthanc | |
|
166
6fada29b6759
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
3 * Copyright (C) 2020-2023 Osimis S.A., Belgium |
|
6fada29b6759
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
4 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
|
155
71d305c29cfa
updated year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
131
diff
changeset
|
5 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 0 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
| 21 | |
| 22 #include "RestCallbacks.h" | |
| 23 | |
|
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
24 #include "../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
| 0 | 25 #include "Autogenerated/sdk.h" |
|
123
5f0b7795afaf
fixing the first leak
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
101
diff
changeset
|
26 #include "PythonBytes.h" |
|
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
27 #include "PythonString.h" |
| 0 | 28 |
| 29 #include <boost/regex.hpp> | |
| 30 | |
| 31 | |
| 32 class RestCallback : public boost::noncopyable | |
| 33 { | |
| 34 private: | |
| 35 boost::regex regex_; | |
| 36 PyObject* callback_; | |
| 37 | |
| 38 public: | |
| 39 RestCallback(const std::string& uri, | |
| 40 PyObject* callback) : | |
| 41 regex_(uri), | |
| 42 callback_(callback) | |
| 43 { | |
| 44 Py_XINCREF(callback_); | |
| 45 } | |
| 46 | |
| 47 ~RestCallback() | |
| 48 { | |
| 49 Py_XDECREF(callback_); | |
| 50 } | |
| 51 | |
| 52 bool IsMatch(const std::string& uri) const | |
| 53 { | |
| 54 return boost::regex_match(uri, regex_); | |
| 55 } | |
| 56 | |
| 57 PyObject* GetCallback() | |
| 58 { | |
| 59 return callback_; | |
| 60 } | |
| 61 }; | |
| 62 | |
| 63 | |
| 64 // Concurrent accesses to the callbacks are protected by the | |
| 65 // "PythonLock" (GIL mutex) | |
| 66 static std::list<RestCallback*> restCallbacks_; | |
| 67 | |
| 68 | |
|
98
62f2731094ae
fix build on ubuntu 16.04
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
69 void RestCallbackHandler(OrthancPluginRestOutput* output, |
|
62f2731094ae
fix build on ubuntu 16.04
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
70 const char* uri, |
|
62f2731094ae
fix build on ubuntu 16.04
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
71 const OrthancPluginHttpRequest* request) |
| 0 | 72 { |
| 73 PythonLock lock; | |
| 74 | |
| 75 for (std::list<RestCallback*>::const_iterator it = restCallbacks_.begin(); | |
| 76 it != restCallbacks_.end(); ++it) | |
| 77 { | |
| 78 assert(*it != NULL); | |
| 79 if ((*it)->IsMatch(uri)) | |
| 80 { | |
| 81 /** | |
| 82 * Construct an instance object of the "orthanc.RestOutput" | |
| 83 * class. This is done by calling the constructor function | |
| 84 * "sdk_OrthancPluginRestOutput_Type". | |
| 85 **/ | |
| 86 PythonObject args(lock, PyTuple_New(2)); | |
| 87 PyTuple_SetItem(args.GetPyObject(), 0, PyLong_FromSsize_t((intptr_t) output)); | |
| 88 PyTuple_SetItem(args.GetPyObject(), 1, PyBool_FromLong(true /* borrowed, don't destruct */)); | |
|
63
32de70a1e4c7
New functions from the SDK wrapped in Python: CreateDicom, RegisterFindCallback, RegisterMoveCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
56
diff
changeset
|
89 PyObject *pInst = PyObject_CallObject((PyObject*) GetOrthancPluginRestOutputType(), args.GetPyObject()); |
| 0 | 90 |
| 91 | |
| 92 /** | |
| 93 * Construct the arguments tuple (output, uri) | |
| 94 **/ | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
95 PythonString str(lock, uri); |
|
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
96 |
| 0 | 97 PythonObject args2(lock, PyTuple_New(2)); |
| 98 PyTuple_SetItem(args2.GetPyObject(), 0, pInst); | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
99 PyTuple_SetItem(args2.GetPyObject(), 1, str.Release()); |
| 0 | 100 // No need to decrement refcount with "PyTuple_SetItem()" |
| 101 | |
| 102 /** | |
| 103 * Construct the named arguments from the "request" argument | |
| 104 **/ | |
| 105 const char* method; | |
| 106 switch (request->method) | |
| 107 { | |
| 108 case OrthancPluginHttpMethod_Get: | |
| 109 method = "GET"; | |
| 110 break; | |
| 111 | |
| 112 case OrthancPluginHttpMethod_Post: | |
| 113 method = "POST"; | |
| 114 break; | |
| 115 | |
| 116 case OrthancPluginHttpMethod_Put: | |
| 117 method = "PUT"; | |
| 118 break; | |
| 119 | |
| 120 case OrthancPluginHttpMethod_Delete: | |
| 121 method = "DELETE"; | |
| 122 break; | |
| 123 | |
| 124 default: | |
| 125 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
| 126 } | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
127 |
| 0 | 128 PythonObject kw(lock, PyDict_New()); |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
129 |
|
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
130 { |
| 53 | 131 PythonString tmp(lock, method); |
|
126
9ffe8881f856
fixing more PyDict_SetItemString()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
123
diff
changeset
|
132 PyDict_SetItemString(kw.GetPyObject(), "method", tmp.GetPyObject()); |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
133 } |
| 0 | 134 |
| 135 { | |
| 136 PythonObject groups(lock, PyTuple_New(request->groupsCount)); | |
| 137 | |
| 138 for (uint32_t i = 0; i < request->groupsCount; i++) | |
| 139 { | |
| 53 | 140 PythonString tmp(lock, request->groups[i]); |
| 141 PyTuple_SetItem(groups.GetPyObject(), i, tmp.Release()); | |
| 0 | 142 } |
| 143 | |
|
126
9ffe8881f856
fixing more PyDict_SetItemString()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
123
diff
changeset
|
144 PyDict_SetItemString(kw.GetPyObject(), "groups", groups.GetPyObject()); |
| 0 | 145 } |
| 146 | |
| 147 if (request->method == OrthancPluginHttpMethod_Get) | |
| 148 { | |
| 149 PythonObject get(lock, PyDict_New()); | |
| 150 | |
| 151 for (uint32_t i = 0; i < request->getCount; i++) | |
| 152 { | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
153 PythonString value(lock, request->getValues[i]); |
|
126
9ffe8881f856
fixing more PyDict_SetItemString()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
123
diff
changeset
|
154 PyDict_SetItemString(get.GetPyObject(), request->getKeys[i], value.GetPyObject()); |
| 0 | 155 } |
| 156 | |
|
126
9ffe8881f856
fixing more PyDict_SetItemString()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
123
diff
changeset
|
157 PyDict_SetItemString(kw.GetPyObject(), "get", get.GetPyObject()); |
| 0 | 158 } |
| 159 | |
| 160 { | |
| 161 PythonObject headers(lock, PyDict_New()); | |
| 162 | |
| 163 for (uint32_t i = 0; i < request->headersCount; i++) | |
| 164 { | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
165 PythonString value(lock, request->headersValues[i]); |
|
126
9ffe8881f856
fixing more PyDict_SetItemString()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
123
diff
changeset
|
166 PyDict_SetItemString(headers.GetPyObject(), request->headersKeys[i], value.GetPyObject()); |
| 0 | 167 } |
| 168 | |
|
126
9ffe8881f856
fixing more PyDict_SetItemString()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
123
diff
changeset
|
169 PyDict_SetItemString(kw.GetPyObject(), "headers", headers.GetPyObject()); |
| 0 | 170 } |
| 171 | |
| 172 if (request->method == OrthancPluginHttpMethod_Post || | |
| 173 request->method == OrthancPluginHttpMethod_Put) | |
| 174 { | |
|
123
5f0b7795afaf
fixing the first leak
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
101
diff
changeset
|
175 PythonBytes bytes(lock, request->body, request->bodySize); |
|
5f0b7795afaf
fixing the first leak
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
101
diff
changeset
|
176 PyDict_SetItemString(kw.GetPyObject(), "body", bytes.GetPyObject()); |
| 0 | 177 } |
| 178 | |
| 179 /** | |
| 180 * Call the user-defined function | |
| 181 **/ | |
| 182 PythonObject result(lock, PyObject_Call( | |
| 183 (*it)->GetCallback(), args2.GetPyObject(), kw.GetPyObject())); | |
|
3
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
184 |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
185 std::string traceback; |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
186 if (lock.HasErrorOccurred(traceback)) |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
187 { |
|
171
c8de83fe7faa
removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
188 ORTHANC_PLUGINS_LOG_ERROR("Error in the REST callback, traceback:\n" + traceback); |
|
3
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
189 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
190 } |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
191 |
| 0 | 192 return; |
| 193 } | |
| 194 } | |
| 195 | |
| 196 // Should never happen | |
|
171
c8de83fe7faa
removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
197 ORTHANC_PLUGINS_LOG_ERROR("Unable to find the Python handler for URI: " + std::string(uri)); |
| 0 | 198 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); |
| 199 } | |
| 200 | |
| 201 | |
| 202 | |
| 203 PyObject* RegisterRestCallback(PyObject* module, PyObject* args) | |
| 204 { | |
| 205 // The GIL is locked at this point (no need to create "PythonLock") | |
| 206 | |
| 207 // https://docs.python.org/3/extending/extending.html#calling-python-functions-from-c | |
| 208 const char* uri = NULL; | |
| 209 PyObject* callback = NULL; | |
| 210 | |
| 211 if (!PyArg_ParseTuple(args, "sO", &uri, &callback) || | |
| 212 uri == NULL || | |
| 213 callback == NULL) | |
| 214 { | |
| 215 PyErr_SetString(PyExc_ValueError, "Expected a string (URI) and a callback function"); | |
| 216 return NULL; | |
| 217 } | |
| 218 | |
|
171
c8de83fe7faa
removed deprecation warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
219 ORTHANC_PLUGINS_LOG_INFO("Registering a Python REST callback on URI: " + std::string(uri)); |
| 0 | 220 OrthancPlugins::RegisterRestCallback<RestCallbackHandler>(uri, true /* thread safe */); |
| 221 | |
| 222 restCallbacks_.push_back(new RestCallback(uri, callback)); | |
| 223 | |
| 224 Py_INCREF(Py_None); | |
| 225 return Py_None; | |
| 226 } | |
| 227 | |
| 228 | |
| 229 | |
| 230 void FinalizeRestCallbacks() | |
| 231 { | |
| 232 PythonLock lock; | |
| 233 | |
| 234 for (std::list<RestCallback*>::iterator it = restCallbacks_.begin(); | |
| 235 it != restCallbacks_.end(); ++it) | |
| 236 { | |
| 237 assert(*it != NULL); | |
| 238 delete *it; | |
| 239 } | |
| 240 | |
| 241 restCallbacks_.clear(); | |
| 242 } |