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