Mercurial > hg > orthanc-python
annotate Sources/OnChangeCallback.cpp @ 95:c17cdaf687e3
use debian:buster-slim to compile Windows binaries
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 15 Sep 2021 11:52:30 +0200 |
parents | 55c41aa7053b |
children | eb6ac5a801d1 |
rev | line source |
---|---|
0 | 1 /** |
2 * Python plugin for Orthanc | |
56
23f3099bed47
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
45
diff
changeset
|
3 * Copyright (C) 2020-2021 Osimis S.A., Belgium |
0 | 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 | |
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
22 #include "../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
23 #include "ICallbackRegistration.h" |
45
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
24 #include "PythonString.h" |
0 | 25 |
36
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 | |
57
46fe70776d61
Fix possible deadlock with "orthanc.RegisterOnChangeCallback()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
56
diff
changeset
|
73 // This corresponds to a simplified, standalone version of |
46fe70776d61
Fix possible deadlock with "orthanc.RegisterOnChangeCallback()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
56
diff
changeset
|
74 // "Orthanc::SharedMessageQueue" from the Orthanc framework |
0 | 75 class PendingChanges : public boost::noncopyable |
76 { | |
77 private: | |
78 typedef std::list<PendingChange*> Queue; | |
79 | |
80 boost::mutex mutex_; | |
81 Queue queue_; | |
82 boost::condition_variable elementAvailable_; | |
91
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
83 boost::condition_variable emptied_; |
0 | 84 |
85 public: | |
86 ~PendingChanges() | |
87 { | |
88 for (Queue::iterator it = queue_.begin(); it != queue_.end(); ++it) | |
89 { | |
90 assert(*it != NULL); | |
91 delete *it; | |
92 } | |
93 } | |
94 | |
95 void Enqueue(OrthancPluginChangeType changeType, | |
96 OrthancPluginResourceType resourceType, | |
97 const char* resourceId) | |
98 { | |
99 boost::mutex::scoped_lock lock(mutex_); | |
100 queue_.push_back(new PendingChange(changeType, resourceType, resourceId)); | |
101 elementAvailable_.notify_one(); | |
102 } | |
103 | |
104 PendingChange* Dequeue(unsigned int millisecondsTimeout) | |
105 { | |
13 | 106 if (millisecondsTimeout == 0) |
0 | 107 { |
108 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
109 } | |
110 | |
111 boost::mutex::scoped_lock lock(mutex_); | |
112 | |
113 // Wait for a message to arrive in the FIFO queue | |
114 while (queue_.empty()) | |
115 { | |
116 bool success = elementAvailable_.timed_wait | |
117 (lock, boost::posix_time::milliseconds(millisecondsTimeout)); | |
118 if (!success) | |
119 { | |
120 return NULL; | |
121 } | |
122 } | |
123 | |
36
fd58eb5749ed
CMake simplification using DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
13
diff
changeset
|
124 std::unique_ptr<PendingChange> change(queue_.front()); |
0 | 125 queue_.pop_front(); |
126 | |
91
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
127 if (queue_.empty()) |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
128 { |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
129 emptied_.notify_all(); |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
130 } |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
131 |
0 | 132 return change.release(); |
133 } | |
91
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
134 |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
135 void WaitEmpty() |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
136 { |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
137 boost::mutex::scoped_lock lock(mutex_); |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
138 |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
139 while (!queue_.empty()) |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
140 { |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
141 emptied_.wait(lock); |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
142 } |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
143 } |
0 | 144 }; |
145 | |
146 | |
147 | |
148 static PendingChanges pendingChanges_; | |
149 static bool stopping_ = false; | |
150 static boost::thread changesThread_; | |
151 static PyObject* changesCallback_ = NULL; | |
152 | |
153 | |
58
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
154 static void StopThread() |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
155 { |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
156 stopping_ = true; |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
157 |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
158 if (changesThread_.joinable()) |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
159 { |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
160 changesThread_.join(); |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
161 } |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
162 } |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
163 |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
164 |
0 | 165 static void ChangesWorker() |
166 { | |
167 while (!stopping_) | |
168 { | |
169 for (;;) | |
170 { | |
171 std::unique_ptr<PendingChange> change(pendingChanges_.Dequeue(100)); | |
172 if (change.get() == NULL) | |
173 { | |
174 break; | |
175 } | |
176 else if (changesCallback_ != NULL) | |
177 { | |
178 try | |
179 { | |
180 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
|
181 |
ee76cced46a5
Fix issue #185 (segfaults on non-UTF8 special characters in request URI)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
36
diff
changeset
|
182 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
|
183 |
0 | 184 PythonObject args(lock, PyTuple_New(3)); |
185 PyTuple_SetItem(args.GetPyObject(), 0, PyLong_FromLong(change->GetChangeType())); | |
186 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
|
187 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
|
188 |
0 | 189 PythonObject result(lock, PyObject_CallObject(changesCallback_, args.GetPyObject())); |
3
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 std::string traceback; |
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
192 if (lock.HasErrorOccurred(traceback)) |
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
193 { |
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
194 OrthancPlugins::LogError("Error in the Python on-change callback, " |
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
195 "traceback:\n" + traceback); |
26762eb9d704
reporting of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
196 } |
0 | 197 } |
198 catch (OrthancPlugins::PluginException& e) | |
199 { | |
200 OrthancPlugins::LogError("Error during Python on-change callback: " + | |
201 std::string(e.What(OrthancPlugins::GetGlobalContext()))); | |
202 } | |
203 } | |
204 } | |
205 } | |
206 } | |
207 | |
208 | |
209 static OrthancPluginErrorCode OnChangeCallback(OrthancPluginChangeType changeType, | |
210 OrthancPluginResourceType resourceType, | |
211 const char* resourceId) | |
212 { | |
57
46fe70776d61
Fix possible deadlock with "orthanc.RegisterOnChangeCallback()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
56
diff
changeset
|
213 pendingChanges_.Enqueue(changeType, resourceType, resourceId); |
58
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
214 |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
215 if (changeType == OrthancPluginChangeType_OrthancStopped) |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
216 { |
91
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
217 // If stopping, make sure to have processed all the events that |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
218 // are pending in the queue before returning (new in 3.4) |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
219 pendingChanges_.WaitEmpty(); |
55c41aa7053b
On Orthanc stopping, wait for all the queued events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
68
diff
changeset
|
220 |
58
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
221 StopThread(); |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
222 } |
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
223 |
0 | 224 return OrthancPluginErrorCode_Success; |
225 } | |
226 | |
227 | |
228 PyObject* RegisterOnChangeCallback(PyObject* module, PyObject* args) | |
229 { | |
230 // The GIL is locked at this point (no need to create "PythonLock") | |
231 | |
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
232 class Registration : public ICallbackRegistration |
0 | 233 { |
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
234 public: |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
235 virtual void Register() ORTHANC_OVERRIDE |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
236 { |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
237 OrthancPluginRegisterOnChangeCallback(OrthancPlugins::GetGlobalContext(), OnChangeCallback); |
0 | 238 |
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
239 stopping_ = false; |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
240 changesThread_ = boost::thread(ChangesWorker); |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
241 } |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
242 }; |
0 | 243 |
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
244 Registration registration; |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
245 return ICallbackRegistration::Apply( |
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
246 registration, args, changesCallback_, "Python on-changes callback"); |
0 | 247 } |
248 | |
249 | |
250 void FinalizeOnChangeCallback() | |
251 { | |
58
ef1a1ce0c1e3
During Orthanc shutdown, wait for all the pending events to have been processed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
57
diff
changeset
|
252 StopThread(); |
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
58
diff
changeset
|
253 ICallbackRegistration::Unregister(changesCallback_); |
0 | 254 } |