Mercurial > hg > orthanc-python
annotate Sources/OnChangeCallback.cpp @ 45:ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 03 Aug 2020 18:13:10 +0200 |
| parents | fd58eb5749ed |
| children | 23f3099bed47 |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 2 * Python plugin for Orthanc | |
| 3 * Copyright (C) 2017-2020 Osimis S.A., Belgium | |
| 4 * | |
| 5 * This program is free software: you can redistribute it and/or | |
| 6 * modify it under the terms of the GNU Affero General Public License | |
| 7 * as published by the Free Software Foundation, either version 3 of | |
| 8 * the License, or (at your option) any later version. | |
| 9 * | |
| 10 * This program is distributed in the hope that it will be useful, but | |
| 11 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 * Affero General Public License for more details. | |
| 14 * | |
| 15 * You should have received a copy of the GNU Affero General Public License | |
| 16 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 17 **/ | |
| 18 | |
| 19 | |
| 20 #include "OnChangeCallback.h" | |
| 21 | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
22 #include "PythonString.h" |
| 0 | 23 |
|
36
fd58eb5749ed
CMake simplification using DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
13
diff
changeset
|
24 #include "../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
|
fd58eb5749ed
CMake simplification using DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
13
diff
changeset
|
25 |
|
fd58eb5749ed
CMake simplification using DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
13
diff
changeset
|
26 #include <Compatibility.h> // For std::unique_ptr<> |
| 0 | 27 |
| 28 #include <boost/thread.hpp> | |
| 29 | |
| 30 | |
| 31 class PendingChange : public boost::noncopyable | |
| 32 { | |
| 33 private: | |
| 34 OrthancPluginChangeType changeType_; | |
| 35 OrthancPluginResourceType resourceType_; | |
| 36 std::string resourceId_; | |
| 37 | |
| 38 public: | |
| 39 PendingChange(OrthancPluginChangeType changeType, | |
| 40 OrthancPluginResourceType resourceType, | |
| 41 const char* resourceId) : | |
| 42 changeType_(changeType), | |
| 43 resourceType_(resourceType) | |
| 44 { | |
| 45 if (resourceId == NULL) | |
| 46 { | |
| 47 resourceId_.clear(); | |
| 48 } | |
| 49 else | |
| 50 { | |
| 51 resourceId_.assign(resourceId); | |
| 52 } | |
| 53 } | |
| 54 | |
| 55 OrthancPluginChangeType GetChangeType() const | |
| 56 { | |
| 57 return changeType_; | |
| 58 } | |
| 59 | |
| 60 OrthancPluginResourceType GetResourceType() const | |
| 61 { | |
| 62 return resourceType_; | |
| 63 } | |
| 64 | |
| 65 const std::string& GetResourceId() const | |
| 66 { | |
| 67 return resourceId_; | |
| 68 } | |
| 69 }; | |
| 70 | |
| 71 | |
| 72 | |
| 73 class PendingChanges : public boost::noncopyable | |
| 74 { | |
| 75 private: | |
| 76 typedef std::list<PendingChange*> Queue; | |
| 77 | |
| 78 boost::mutex mutex_; | |
| 79 Queue queue_; | |
| 80 boost::condition_variable elementAvailable_; | |
| 81 | |
| 82 public: | |
| 83 ~PendingChanges() | |
| 84 { | |
| 85 for (Queue::iterator it = queue_.begin(); it != queue_.end(); ++it) | |
| 86 { | |
| 87 assert(*it != NULL); | |
| 88 delete *it; | |
| 89 } | |
| 90 } | |
| 91 | |
| 92 void Enqueue(OrthancPluginChangeType changeType, | |
| 93 OrthancPluginResourceType resourceType, | |
| 94 const char* resourceId) | |
| 95 { | |
| 96 boost::mutex::scoped_lock lock(mutex_); | |
| 97 queue_.push_back(new PendingChange(changeType, resourceType, resourceId)); | |
| 98 elementAvailable_.notify_one(); | |
| 99 } | |
| 100 | |
| 101 PendingChange* Dequeue(unsigned int millisecondsTimeout) | |
| 102 { | |
| 13 | 103 if (millisecondsTimeout == 0) |
| 0 | 104 { |
| 105 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
| 106 } | |
| 107 | |
| 108 boost::mutex::scoped_lock lock(mutex_); | |
| 109 | |
| 110 // Wait for a message to arrive in the FIFO queue | |
| 111 while (queue_.empty()) | |
| 112 { | |
| 113 bool success = elementAvailable_.timed_wait | |
| 114 (lock, boost::posix_time::milliseconds(millisecondsTimeout)); | |
| 115 if (!success) | |
| 116 { | |
| 117 return NULL; | |
| 118 } | |
| 119 } | |
| 120 | |
|
36
fd58eb5749ed
CMake simplification using DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
13
diff
changeset
|
121 std::unique_ptr<PendingChange> change(queue_.front()); |
| 0 | 122 queue_.pop_front(); |
| 123 | |
| 124 return change.release(); | |
| 125 } | |
| 126 }; | |
| 127 | |
| 128 | |
| 129 | |
| 130 static PendingChanges pendingChanges_; | |
| 131 static bool stopping_ = false; | |
| 132 static boost::thread changesThread_; | |
| 133 static PyObject* changesCallback_ = NULL; | |
| 134 | |
| 135 | |
| 136 static void ChangesWorker() | |
| 137 { | |
| 138 while (!stopping_) | |
| 139 { | |
| 140 for (;;) | |
| 141 { | |
| 142 std::unique_ptr<PendingChange> change(pendingChanges_.Dequeue(100)); | |
| 143 if (change.get() == NULL) | |
| 144 { | |
| 145 break; | |
| 146 } | |
| 147 else if (changesCallback_ != NULL) | |
| 148 { | |
| 149 try | |
| 150 { | |
| 151 PythonLock lock; | |
|
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 |
|
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 resourceId(lock, change->GetResourceId()); |
|
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
154 |
| 0 | 155 PythonObject args(lock, PyTuple_New(3)); |
| 156 PyTuple_SetItem(args.GetPyObject(), 0, PyLong_FromLong(change->GetChangeType())); | |
| 157 PyTuple_SetItem(args.GetPyObject(), 1, PyLong_FromLong(change->GetResourceType())); | |
|
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
158 PyTuple_SetItem(args.GetPyObject(), 2, resourceId.Release()); |
|
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
159 |
| 0 | 160 PythonObject result(lock, PyObject_CallObject(changesCallback_, args.GetPyObject())); |
|
3
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
161 |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
162 std::string traceback; |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
163 if (lock.HasErrorOccurred(traceback)) |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
164 { |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
165 OrthancPlugins::LogError("Error in the Python on-change callback, " |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
166 "traceback:\n" + traceback); |
|
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
167 } |
| 0 | 168 } |
| 169 catch (OrthancPlugins::PluginException& e) | |
| 170 { | |
| 171 OrthancPlugins::LogError("Error during Python on-change callback: " + | |
| 172 std::string(e.What(OrthancPlugins::GetGlobalContext()))); | |
| 173 } | |
| 174 } | |
| 175 } | |
| 176 } | |
| 177 } | |
| 178 | |
| 179 | |
| 180 static OrthancPluginErrorCode OnChangeCallback(OrthancPluginChangeType changeType, | |
| 181 OrthancPluginResourceType resourceType, | |
| 182 const char* resourceId) | |
| 183 { | |
| 184 { | |
| 185 PythonLock lock; | |
| 186 pendingChanges_.Enqueue(changeType, resourceType, resourceId); | |
| 187 } | |
| 188 | |
| 189 return OrthancPluginErrorCode_Success; | |
| 190 } | |
| 191 | |
| 192 | |
| 193 PyObject* RegisterOnChangeCallback(PyObject* module, PyObject* args) | |
| 194 { | |
| 195 // The GIL is locked at this point (no need to create "PythonLock") | |
| 196 | |
| 197 // https://docs.python.org/3/extending/extending.html#calling-python-functions-from-c | |
| 198 PyObject* callback = NULL; | |
| 199 | |
| 200 if (!PyArg_ParseTuple(args, "O", &callback) || | |
| 201 callback == NULL) | |
| 202 { | |
| 203 PyErr_SetString(PyExc_ValueError, "Expected a callback function"); | |
| 204 return NULL; | |
| 205 } | |
| 206 | |
| 207 if (changesCallback_ != NULL) | |
| 208 { | |
| 209 PyErr_SetString(PyExc_RuntimeError, "Can only register one Python on-changes callback"); | |
| 210 return NULL; | |
| 211 } | |
| 212 | |
| 213 OrthancPlugins::LogInfo("Registering a Python on-changes callback"); | |
| 214 | |
| 215 OrthancPluginRegisterOnChangeCallback(OrthancPlugins::GetGlobalContext(), OnChangeCallback); | |
| 216 | |
| 217 stopping_ = false; | |
| 218 changesThread_ = boost::thread(ChangesWorker); | |
| 219 | |
| 220 changesCallback_ = callback; | |
| 221 Py_XINCREF(changesCallback_); | |
| 222 | |
| 223 Py_INCREF(Py_None); | |
| 224 return Py_None; | |
| 225 } | |
| 226 | |
| 227 | |
| 228 | |
| 229 | |
| 230 void FinalizeOnChangeCallback() | |
| 231 { | |
| 232 stopping_ = true; | |
| 233 | |
| 234 if (changesThread_.joinable()) | |
| 235 { | |
| 236 changesThread_.join(); | |
| 237 } | |
| 238 | |
| 239 { | |
| 240 PythonLock lock; | |
| 241 | |
| 242 if (changesCallback_ != NULL) | |
| 243 { | |
| 244 Py_XDECREF(changesCallback_); | |
| 245 } | |
| 246 } | |
| 247 } |