Mercurial > hg > orthanc-book
annotate Sphinx/source/users/lua.rst @ 829:6787e8af4316
point to the TODO of orthanc-stone
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 25 Mar 2022 17:00:43 +0100 |
parents | e7de02760b59 |
children | a9c35bf108fa |
rev | line source |
---|---|
0 | 1 .. _lua: |
2 | |
3 Server-side scripting with Lua | |
4 ============================== | |
5 | |
6 .. contents:: | |
7 | |
8 Since release 0.5.2, Orthanc supports server-side scripting through | |
25 | 9 the `Lua <https://en.wikipedia.org/wiki/Lua_(programming_language)>`__ |
0 | 10 scripting language. Thanks to this major feature, Orthanc can be tuned |
11 to specific medical workflows without being driven by an external | |
12 script. This page summarizes the possibilities of Orthanc server-side | |
13 scripting. | |
14 | |
15 Many other examples are `available in the source distribution | |
449 | 16 <https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Resources/Samples/Lua/>`__. |
0 | 17 |
606
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
18 A more expressive alternative to Lua scripts is provided by |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
19 :ref:`Python plugins <python-plugins>`. |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
20 |
0 | 21 |
75 | 22 Installing a Lua script |
0 | 23 ----------------------- |
24 | |
25 .. highlight:: bash | |
26 | |
27 A custom Lua script can be installed either by the :ref:`configuration | |
28 file <configuration>`, or by uploading it | |
29 through the :ref:`REST API <rest-samples>`. | |
30 | |
31 To install it by the **configuration file** method, you just have to | |
32 specify the path to the file containing the Lua script in the | |
357 | 33 ``LuaScripts`` variable. A comma-separated list of paths can be |
34 specified to install multiple scripts. | |
0 | 35 |
36 To upload a script stored in the file "``script.lua``" through the | |
37 **REST API**, use the following command:: | |
38 | |
39 $ curl -X POST http://localhost:8042/tools/execute-script --data-binary @script.lua | |
40 | |
41 Pay attention to the fact that, contrarily to the scripts installed | |
42 from the configuration file, the scripts installed through the REST | |
43 API are non-persistent: They are discarded after a restart of Orthanc, | |
44 which makes them useful for script prototyping. You can also interpret | |
45 a single Lua command through the REST API:: | |
46 | |
47 $ curl -X POST http://localhost:8042/tools/execute-script --data-binary "print(42)" | |
48 | |
49 *Note:* The ``--data-binary`` cURL option is used instead of | |
50 ``--data`` to prevent the interpretation of newlines by cURL, which is | |
51 `mandatory for the proper evaluation | |
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
357
diff
changeset
|
52 <https://stackoverflow.com/questions/3872427/how-to-send-line-break-with-curl>`__ |
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
357
diff
changeset
|
53 of the possible comments inside the Lua script. |
0 | 54 |
55 Lua API | |
56 ------- | |
57 | |
58 | |
59 .. _lua-callbacks: | |
60 | |
61 Callbacks to react to events | |
62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
63 | |
355
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
64 The Lua engine of Orthanc invokes the following callbacks that |
0 | 65 are triggered on various events. Here are the **generic events**: |
66 | |
67 * ``function Initialize()``: Invoked as soon as the Orthanc server is started. | |
68 * ``function Finalize()``: Invoked just before the Orthanc server is stopped. | |
69 | |
70 Some **permission-related events** allow to filter incoming requests: | |
71 | |
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
72 * ``function ReceivedInstanceFilter(dicom, origin, info)``: Invoked to |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
73 known whether an incoming DICOM instance should be |
0 | 74 accepted. :ref:`See this section <lua-filter-dicom>`. The ``origin`` |
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
75 parameter is :ref:`documented separately <lua-origin>`. The ``info`` |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
76 parameter contains additional information and was added in Orthanc |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
77 1.6.1. |
0 | 78 * ``function IncomingHttpRequestFilter(method, uri, ip, username, |
79 httpHeaders)``: Invoked to known whether a REST request should be | |
80 accepted. :ref:`See this section <lua-filter-rest>`. | |
81 | |
232 | 82 Some **job-related events** allow to react to :ref:`job <jobs>` completion/failure: |
83 | |
84 * ``function OnJobSubmitted(jobId)``: | |
85 Invoked when a new job has been submitted. Note that this does not | |
86 mean the the job execution has started. | |
87 * ``function OnJobFailure(jobId)``: | |
88 Invoked when a job has failed. | |
89 * ``function OnJobSuccess(jobId)``: | |
90 Invoked when a job has completed successfully. | |
91 | |
0 | 92 Some **DICOM-related events** allow to react to the reception of |
93 new medical images: | |
94 | |
95 * ``function OnStoredInstance(instanceId, tags, metadata, origin)``: | |
96 Invoked whenever a new instance has been stored into Orthanc. | |
97 This is especially useful for :ref:`lua-auto-routing`. The ``origin`` | |
98 parameter is :ref:`documented separately <lua-origin>`. | |
99 * ``function OnStablePatient(patientId, tags, metadata)``: Invoked | |
100 whenever a patient has not received any new instance for a certain | |
101 amount of time (cf. the option ``StableAge`` in the | |
102 :ref:`configuration file <configuration>`). The :ref:`identifier | |
103 <orthanc-ids>` of the patient is provided, together with her DICOM | |
78 | 104 tags and her :ref:`metadata <metadata>`. |
0 | 105 * ``function OnStableSeries(seriesId, tags, metadata)``: Invoked |
106 whenever a series has not received any new instance for a certain | |
107 amount of time. | |
108 * ``function OnStableStudy(studyId, tags, metadata)``: Invoked | |
109 whenever a study has not received any new instance for a certain | |
110 amount of time. | |
111 * ``function IncomingFindRequestFilter(source, origin)``: Invoked | |
112 whenever Orthanc receives an incoming C-Find query through the DICOM | |
113 protocol. This allows to inspect the content of the C-Find query, | |
114 and possibly modify it if a patch is needed for some manufacturer. A | |
115 `sample script is available | |
449 | 116 <https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Resources/Samples/Lua/IncomingFindRequestFilter.lua>`__. |
0 | 117 |
319
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
118 Some other **resource-related events** are available: |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
119 |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
120 * ``function OnDeletedPatient(patientId)``: Invoked when a patient has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
121 been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
122 * ``function OnDeletedStudy(studyId)``: Invoked when a study has been |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
123 removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
124 * ``function OnDeletedSeries(seriesId)``: Invoked when a series has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
125 been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
126 * ``function OnDeletedInstance(instanceId)``: Invoked when a instance |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
127 has been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
128 * ``function OnUpdatedPatient(patientId)``: Invoked when some metadata |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
129 or some attachment associated with the given patient has been |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
130 updated (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
131 * ``function OnUpdatedStudy(studyId)``: Invoked when some metadata or |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
132 some attachment associated with the given study has been updated |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
133 (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
134 * ``function OnUpdatedSeries(seriesId)``: Invoked when some metadata |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
135 or some attachment associated with the given series has been updated |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
136 (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
137 * ``function OnUpdatedInstance(instanceId)``: Invoked when some |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
138 metadata or some attachment associated with the given instance has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
139 been updated (new in Orthanc 1.6.0). |
606
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
140 |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
141 Furthermore, in versions of Orthanc <= 1.8.2, whenever a DICOM |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
142 association is negotiated for C-Store SCP, several callbacks are |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
143 successively invoked to specify which **transfer syntaxes** are |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
144 accepted for the association. These callbacks are listed in `this |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
145 sample script |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
146 <https://hg.orthanc-server.com/orthanc/file/Orthanc-1.8.2/OrthancServer/Resources/Samples/Lua/TransferSyntaxEnable.lua>`__. |
2f000ee9b20d
removal of Lua callbacks for transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
449
diff
changeset
|
147 These callbacks were removed in Orthanc 1.9.0. |
0 | 148 |
149 *Note:* All of these callbacks are guaranteed to be **invoked in | |
150 mutual exclusion**. This implies that Lua scripting in Orthanc does | |
357 | 151 not support any kind of concurrency. |
152 | |
153 If a callback is specified multiple times in separate scripts, the | |
154 event handler of the latest loaded script is used. | |
0 | 155 |
156 | |
157 .. _lua-rest: | |
158 | |
159 Calling the REST API of Orthanc | |
160 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
161 | |
162 Lua scripts have :ref:`full access to the REST API <rest>` of Orthanc | |
163 through the following functions: | |
164 | |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
165 * ``RestApiGet(uri, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
166 * ``RestApiPost(uri, body, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
167 * ``RestApiPut(uri, body, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
168 * ``RestApiDelete(uri, builtin, headers)`` |
0 | 169 |
237 | 170 Here is a description of the parameters: |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
171 |
237 | 172 * ``uri`` specifies the resource being accessed |
173 (e.g. ``/instances``). It must not include the URL schema | |
174 (protocol), hostname or port. | |
0 | 175 |
237 | 176 * In the context of a POST or PUT request, ``body`` is a string |
177 containing the body of the request | |
178 (e.g. ``{"Keep":"StudyDate"}``). This string will often correspond | |
179 to a JSON-formatted version of a `Lua table | |
180 <http://lua-users.org/wiki/TablesTutorial>`__. The ``DumpJson()`` | |
181 function (see below) is very useful to achieve this conversion from | |
182 a Lua table to a plain string. | |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
183 |
237 | 184 * ``builtin`` is an optional Boolean that specifies whether the |
185 request targets only the built-in REST API of Orthanc (if set to | |
186 ``true``), or the full the REST API after being tainted by plugins | |
187 (if set to ``false``). | |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
188 |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
189 * ``headers`` is an optional argument and was added in release |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
190 1.5.7. It allows to provide the REST API endpoint with HTTP headers. |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
191 |
237 | 192 .. highlight:: bash |
193 | |
194 For instance:: | |
195 | |
196 RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}') | |
197 | |
0 | 198 |
783 | 199 Instance modification/routing |
200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
201 | |
804
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
202 The Lua engine offers the following special functions to modify and |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
203 route DICOM instances: |
783 | 204 |
205 * ``ModifyInstance(instanceId, replacements, removals, removePrivateTags)`` | |
804
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
206 modifies an instance. |
783 | 207 * ``SendToModality(instanceId, modality)`` performs a C-Store to the |
804
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
208 target modality. |
783 | 209 * ``SendToPeer(instanceId, peer)`` sends the instance to a remote Orthanc peer. |
210 * ``Delete(instanceId)`` deletes the instance. | |
211 | |
804
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
212 :ref:`See this section <lua-auto-routing>` for examples. As can be |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
213 seen in those examples, these special functions can be chained |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
214 together, although they return no explicit value. |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
215 |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
216 Note that these special functions should only be used for basic use |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
217 cases: Calls to the REST API :ref:`should always be favored for |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
218 auto-routing <lua-auto-routing-better>`. |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
219 |
783 | 220 |
0 | 221 General-purpose functions |
222 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
223 | |
224 The Lua engine of Orthanc contain several general-purpose ancillary | |
225 functions: | |
226 | |
227 * ``PrintRecursive(v)`` recursively prints the content of a `Lua table | |
228 <http://www.lua.org/pil/2.5.html>`__ to the log file of Orthanc. | |
229 * ``ParseJson(s)`` converts a string encoded in the `JSON format | |
230 <https://en.wikipedia.org/wiki/JSON>`__ to a Lua table. | |
231 * ``DumpJson(v, keepStrings)`` encodes a Lua table as a JSON string. | |
232 Setting the optional argument ``keepStrings`` (available from | |
233 release 0.9.5) to ``true`` prevents the automatic conversion of | |
234 strings to integers. | |
235 * ``GetOrthancConfiguration()`` returns a Lua table containing the | |
236 content of the :ref:`configuration files <configuration>` of | |
237 Orthanc. | |
238 | |
239 | |
240 Similarly to the functions to :ref:`call the REST API of Orthanc | |
241 <lua-rest>`, several functions are available to make generic HTTP | |
242 requests to Web services: | |
243 | |
90 | 244 * ``HttpGet(url, headers)`` |
245 * ``HttpPost(url, body, headers)`` | |
246 * ``HttpPut(url, body, headers)`` | |
247 * ``HttpDelete(url, headers)`` | |
0 | 248 * ``SetHttpCredentials(username, password)`` can be used to setup the |
249 HTTP credentials. | |
250 | |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
251 The ``headers`` argument is optional and was added in release |
91 | 252 1.2.1. It allows to set the HTTP headers for the HTTP client request. |
0 | 253 |
283 | 254 Example:: |
255 | |
256 local preview = RestApiGet('/instances/' .. instanceId .. '/preview') | |
257 local headers = { | |
258 ["content-type"] = "image/png", | |
259 } | |
260 HttpPost("http://localhost/my-web-service/instance-preview", preview, headers) | |
261 | |
0 | 262 .. _lua-origin: |
263 | |
264 Origin of the instances | |
265 ^^^^^^^^^^^^^^^^^^^^^^^ | |
266 | |
267 Whenever Orthanc decides whether it should should store a new instance | |
268 (cf. the ``ReceivedInstanceFilter()`` callback), or whenever it has | |
269 actually stored a new instance (cf. the ``OnStoredInstance`` | |
270 callback), an ``origin`` parameter is provided. This parameter is a | |
271 `Lua table <http://www.lua.org/pil/2.5.html>`__ that describes from | |
272 which Orthanc subsystem the new instance comes from. | |
273 | |
274 There are 4 possible subsystems, that can be distinguished according | |
275 to the value of ``origin["RequestOrigin"]``: | |
276 | |
277 * ``RestApi``: The instance originates from some HTTP request to the REST | |
278 API. In this case, the ``RemoteIp`` and ``Username`` fields are | |
279 available in ``origin``. They respectively describe the IP address | |
280 of the HTTP client, and the username that was used for HTTP | |
281 authentication (as defined in the ``RegisteredUsers`` | |
282 :ref:`configuration variable <configuration>`). | |
283 * ``DicomProtocol``: The instance originates from a DICOM C-Store. | |
284 The fields ``RemoteIp``, ``RemoteAet`` and ``CalledAet`` | |
285 respectively provide the IP address of the DICOM SCU (client), the | |
286 application entity title of the DICOM SCU client, and the | |
287 application entity title of the Orthanc SCP server. The | |
288 ``CalledAet`` can be used for :ref:`advanced auto-routing scenarios | |
289 <lua-auto-routing>`, when a single instance of Orthanc acts as a | |
290 proxy for several DICOM SCU clients. | |
291 * ``Lua``: The instance originates from a Lua script. | |
292 * ``Plugins``: The instance originates from a plugin. | |
293 | |
294 | |
295 .. _lua-filter-dicom: | |
296 | |
75 | 297 Filtering incoming DICOM instances |
0 | 298 ---------------------------------- |
299 | |
300 .. highlight:: lua | |
301 | |
302 Each time a DICOM instance is received by Orthanc (either through the | |
303 DICOM protocol or through the REST API), the | |
304 ``ReceivedInstanceFilter()`` Lua function is invoked. If this callback | |
305 returns ``true``, the instance is accepted for storage. If it returns | |
306 ``false``, the instance is discarded. This mechanism can be used to | |
307 filter the incoming DICOM instances. Here is an example of a Lua | |
308 filter that only allows incoming instances of MR modality:: | |
309 | |
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
310 function ReceivedInstanceFilter(dicom, origin, info) |
0 | 311 -- Only allow incoming MR images |
312 if dicom.Modality == 'MR' then | |
313 return true | |
314 else | |
315 return false | |
316 end | |
317 end | |
318 | |
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
319 The argument ``dicom`` corresponds to a `Lua table |
0 | 320 <http://www.lua.org/pil/2.5.html>`__ (i.e. an associative array) that |
321 contains the DICOM tags of the incoming instance. For debugging | |
322 purpose, you can print this structure as follows:: | |
323 | |
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
324 function ReceivedInstanceFilter(dicom, origin, info) |
0 | 325 PrintRecursive(dicom) |
326 -- Accept all incoming instances (default behavior) | |
327 return true | |
328 end | |
329 | |
330 The argument ``origin`` is :ref:`documented separately <lua-origin>`. | |
331 | |
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
332 The argument ``info`` was introduced in Orthanc 1.6.1. It contains |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
333 some additional information about the received DICOM instance, |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
334 notably: |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
335 |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
336 * ``HasPixelData`` is ``true`` iff. the Pixel Data (7FE0,0010) tag is |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
337 present. |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
338 * ``TransferSyntaxUID`` contains the transfer syntax UID of the |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
339 dataset of the instance (if applicable). |
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
340 |
0 | 341 |
342 .. _lua-filter-rest: | |
343 | |
75 | 344 Filtering incoming REST requests |
0 | 345 -------------------------------- |
346 | |
347 .. highlight:: lua | |
348 | |
349 Lua scripting can be used to control the access to the various URI of | |
350 the REST API. Each time an incoming HTTP request is received, the | |
351 ``IncomingHttpRequestFilter()`` Lua function is called. The access to | |
352 the resource is granted if and only if this callback script returns | |
353 ``true``. | |
354 | |
355 This mechanism can be used to implement fine-grained `access control | |
25 | 356 lists <https://en.wikipedia.org/wiki/Access_control_list>`__. Here is |
0 | 357 an example of a Lua script that limits POST, PUT and DELETE requests |
358 to an user that is called "admin":: | |
359 | |
360 function IncomingHttpRequestFilter(method, uri, ip, username, httpHeaders) | |
361 -- Only allow GET requests for non-admin users | |
362 | |
363 if method == 'GET' then | |
364 return true | |
365 elseif username == 'admin' then | |
366 return true | |
367 else | |
368 return false | |
369 end | |
370 end | |
371 | |
372 Here is a description of the arguments of this Lua callback: | |
373 | |
374 * ``method``: The HTTP method (GET, POST, PUT or DELETE). | |
375 * ``uri``: The path to the resource (e.g. ``/tools/generate-uid``). | |
376 * ``ip``: The IP address of the host that has issued the HTTP request (e.g. ``127.0.0.1``). | |
377 * ``username``: If HTTP Basic Authentication is enabled in the | |
378 :ref:`configuration file <configuration>`, the name of the user that | |
379 has issued the HTTP request (as defined in the ``RegisteredUsers`` | |
380 configuration variable). If the authentication is disabled, this | |
381 argument is set to the empty string. | |
382 * ``httpHeaders``: The HTTP headers of the incoming request. This | |
383 argument is available since Orthanc 1.0.1. It is useful if the | |
384 authentication should be achieved through tokens, for instance | |
385 against a `LDAP | |
386 <https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol>`__ | |
387 or `OAuth2 <https://en.wikipedia.org/wiki/OAuth>`__ server. | |
388 | |
389 | |
390 .. _lua-auto-routing: | |
391 | |
75 | 392 Auto-routing of DICOM images |
0 | 393 ---------------------------- |
394 | |
395 .. highlight:: lua | |
396 | |
397 Since release 0.8.0, the routing of DICOM flows can be very easily | |
398 automated with Orthanc. All you have to do is to declare your | |
399 destination modality in the :ref:`configuration file <configuration>` | |
400 (section ``DicomModalities``), then to create and install a Lua | |
401 script. For instance, here is a sample script:: | |
402 | |
403 function OnStoredInstance(instanceId, tags, metadata) | |
404 Delete(SendToModality(instanceId, 'sample')) | |
405 end | |
406 | |
407 If this script is loaded into Orthanc, whenever a new DICOM instance | |
408 is received by Orthanc, it will be routed to the modality whose | |
409 symbolic name is ``sample`` (through a Store-SCU command), then it | |
410 will be removed from Orthanc. In other words, this is a **one-liner | |
411 script to implement DICOM auto-routing**. | |
412 | |
413 Very importantly, thanks to this feature, you do not have to use the | |
414 REST API or to create external scripts in order to automate simple | |
415 imaging flows. The scripting engine is entirely contained inside the | |
416 Orthanc core system. | |
417 | |
418 Thanks to Lua expressiveness, you can also implement conditional | |
419 auto-routing. For instance, if you wish to route only patients whose | |
420 name contains "David", you would simply write:: | |
421 | |
422 function OnStoredInstance(instanceId, tags, metadata) | |
423 -- Extract the value of the "PatientName" DICOM tag | |
424 local patientName = string.lower(tags['PatientName']) | |
425 | |
426 if string.find(patientName, 'david') ~= nil then | |
427 -- Only route patients whose name contains "David" | |
428 Delete(SendToModality(instanceId, 'sample')) | |
429 | |
430 else | |
431 -- Delete the patients that are not called "David" | |
432 Delete(instanceId) | |
433 end | |
434 end | |
435 | |
436 Besides ``SendToModality()``, a mostly identical function with the | |
437 same arguments called ``SendToPeer()`` can be used to route instances | |
438 to :ref:`Orthanc peers <peers>`. It is also possible to modify the | |
439 received instances before routing them. For instance, here is how you | |
440 would replace the ``StationName`` DICOM tag:: | |
441 | |
442 function OnStoredInstance(instanceId, tags, metadata) | |
443 -- Ignore the instances that result from a modification to avoid | |
444 -- infinite loops | |
445 if (metadata['ModifiedFrom'] == nil and | |
446 metadata['AnonymizedFrom'] == nil) then | |
447 | |
448 -- The tags to be replaced | |
449 local replace = {} | |
450 replace['StationName'] = 'My Medical Device' | |
451 | |
452 -- The tags to be removed | |
453 local remove = { 'MilitaryRank' } | |
454 | |
455 -- Modify the instance, send it, then delete the modified instance | |
456 Delete(SendToModality(ModifyInstance(instanceId, replace, remove, true), 'sample')) | |
457 | |
458 -- Delete the original instance | |
459 Delete(instanceId) | |
460 end | |
461 end | |
462 | |
463 | |
804
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
464 .. _lua-auto-routing-better: |
e7de02760b59
fix revision 783, to solve bug #203
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
783
diff
changeset
|
465 |
75 | 466 Important remarks about auto-routing |
467 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
468 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
469 The ``SendToModality()``, ``SendToPeer()``, ``ModifyInstance()`` and |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
470 ``Delete()`` functions are for the most basic cases of auto-routing |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
471 (implying a single DICOM instance, and possibly a basic modification |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
472 of this instance). The ``ModifyInstance()`` function `could also lead |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
473 to problems |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
474 <https://groups.google.com/d/msg/orthanc-users/hmv2y-LgKm8/oMAuGJWMBgAJ>`__ |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
475 if it deals with tags wrongly interpreted as numbers by Lua. |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
476 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
477 For more evolved auto-routing scenarios, remember that Lua scripts |
191 | 478 :ref:`have full access to the REST API of Orthanc <lua-rest>`. This is |
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
479 illustrated by the ``AutoroutingModification.lua`` sample available in |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
480 the source distribution of Orthanc:: |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
481 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
482 function OnStoredInstance(instanceId, tags, metadata, origin) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
483 -- Ignore the instances that result from the present Lua script to |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
484 -- avoid infinite loops |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
485 if origin['RequestOrigin'] ~= 'Lua' then |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
486 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
487 -- The tags to be replaced |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
488 local replace = {} |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
489 replace['StationName'] = 'My Medical Device' |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
490 replace['0031-1020'] = 'Some private tag' |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
491 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
492 -- The tags to be removed |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
493 local remove = { 'MilitaryRank' } |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
494 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
495 -- Modify the instance |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
496 local command = {} |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
497 command['Replace'] = replace |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
498 command['Remove'] = remove |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
499 local modifiedFile = RestApiPost('/instances/' .. instanceId .. '/modify', DumpJson(command, true)) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
500 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
501 -- Upload the modified instance to the Orthanc database so that |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
502 -- it can be sent by Orthanc to other modalities |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
503 local modifiedId = ParseJson(RestApiPost('/instances/', modifiedFile)) ['ID'] |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
504 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
505 -- Send the modified instance to another modality |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
506 RestApiPost('/modalities/sample/store', modifiedId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
507 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
508 -- Delete the original and the modified instances |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
509 RestApiDelete('/instances/' .. instanceId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
510 RestApiDelete('/instances/' .. modifiedId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
511 end |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
512 end |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
513 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
514 Also note that :ref:`other callbacks are available <lua-callbacks>` |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
515 (``OnStablePatient()``, ``OnStableStudy()`` and ``OnStableSeries()``) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
516 to react to other events than the reception of a single instance |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
517 with ``OnStoredInstance()``. |
75 | 518 |
99
e83da2f99e45
added 'troubleshooting C-Find queries' in the worklist section
amazy
parents:
91
diff
changeset
|
519 .. _lua-fix-cfind: |
75 | 520 |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
521 Fixing C-Find requests |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
522 ---------------------- |
75 | 523 |
524 :ref:`C-Find requests <dicom-find>` are sometimes interpreted | |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
525 differently by different DICOM servers (e.g. the ``*`` wildcard, as |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
526 `reported by users |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
527 <https://groups.google.com/d/msg/orthanc-users/3g7V7kqr3g0/IREL88RWAwAJ>`__), |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
528 and sometimes a querying modality might set unexpected DICOM tags |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
529 (cf. `this real-world example |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
530 <https://groups.google.com/d/msg/orthanc-users/PLWKqVVaXLs/n_0x4vKhAgAJ>`__). In |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
531 such situations, it is possible to dynamically fix incoming or |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
532 outgoing C-Find queries using a Lua script. |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
533 |
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
534 Sanitizing incoming C-Find requests can be done by implementing the |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
535 ``IncomingFindRequestFilter(query, origin)`` callback that is called |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
536 whenever the Orthanc C-Find SCP is queried by a remote modality. For |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
537 instance, here is Lua script to remove a private tag that is specified |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
538 by some manufacturer:: |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
539 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
540 function IncomingFindRequestFilter(query, origin) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
541 -- First display the content of the C-Find query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
542 PrintRecursive(query) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
543 PrintRecursive(origin) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
544 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
545 -- Remove the "PrivateCreator" tag from the query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
546 local v = query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
547 v['5555,0010'] = nil |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
548 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
549 return v |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
550 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
551 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
552 The ``origin`` argument contains information about which modality has |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
553 issued the request. |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
554 |
443
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
555 Note that this callback allows you to modify the incoming request |
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
556 but will not modify the list of tags that Orthanc will return. |
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
557 |
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
558 Also note that the ``IncomingFindRequestFilter`` callback is not applied to |
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
559 C-Find requests targeting :ref:`modality worklists |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
560 <worklists-plugin>`. Since Orthanc 1.4.2, the corresponding |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
561 ``IncomingWorklistRequestFilter`` callback can be used to sanitize |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
562 C-FIND requests against worklists:: |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
563 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
564 function IncomingWorklistRequestFilter(query, origin) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
565 PrintRecursive(query) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
566 PrintRecursive(origin) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
567 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
568 -- Implements the same behavior as the "FilterIssuerAet" |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
569 -- option of the sample worklist plugin |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
570 query['0040,0100'][1]['0040,0001'] = origin['RemoteAet'] |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
571 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
572 return query |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
573 end |
105
268ec482f051
IncomingFindRequestFilter not applied to worklist plugin
amazy
parents:
99
diff
changeset
|
574 |
443
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
575 |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
576 Similarly, the callback ``OutgoingFindRequestFilter(query, modality)`` |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
577 is invoked whenever Orthanc acts as a C-Find SCU, which gives the |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
578 opportunity to dynamically fix outgoing C-Find requests before they |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
579 are actually sent to the queried modality. For instance, here is a |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
580 sample Lua callback that would replace asterisk wildcards (i.e. ``*``) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
581 by an empty string for any query/retrieve issued by Orthanc (including |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
582 from Orthanc Explorer):: |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
583 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
584 function OutgoingFindRequestFilter(query, modality) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
585 for key, value in pairs(query) do |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
586 if value == '*' then |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
587 query[key] = '' |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
588 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
589 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
590 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
591 return query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
592 end |
668 | 593 |
594 | |
595 .. _lua-external-modules: | |
596 | |
597 Using external modules | |
598 ---------------------- | |
599 | |
600 Starting with Orthanc 1.3.2, it is possible to use external Lua | |
601 modules if Orthanc was compiled with the ``-DENABLE_LUA_MODULES=ON`` | |
602 while invoking CMake. | |
603 | |
604 Importantly, the modules and the Orthanc server must use the same | |
605 version of Lua for external modules to be properly loaded. | |
606 | |
607 Check out the Orthanc Users forum for old discussions about this | |
608 topic: `reference 1 | |
609 <https://groups.google.com/g/orthanc-users/c/BXfmwU786B0/m/M47slt5GFwAJ>`__, | |
610 `reference 2 | |
611 <https://groups.google.com/g/orthanc-users/c/BXfmwU786B0/m/qpVe8UvGAwAJ>`__, | |
612 `reference 3 | |
613 <https://groups.google.com/g/orthanc-users/c/LDAN5jA0X8M/m/4zrk0_AaBAAJ>`__. |