Mercurial > hg > orthanc-book
annotate Sphinx/source/users/lua.rst @ 783:0fbe952b2906
list more lua functions
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Fri, 01 Oct 2021 16:53:46 +0200 |
| parents | 15a0635eef4b |
| children | e7de02760b59 |
| 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 | |
| 202 The Lua engine offers a few function to modify and route DICOM instances. | |
| 203 :ref:`See this section <lua-auto-routing>` | |
| 204 | |
| 205 * ``ModifyInstance(instanceId, replacements, removals, removePrivateTags)`` | |
| 206 modifies an instance. Returns the instanceId of the modified instance | |
| 207 * ``SendToModality(instanceId, modality)`` performs a C-Store to the | |
| 208 target modality. Returns the instanceId. | |
| 209 * ``SendToPeer(instanceId, peer)`` sends the instance to a remote Orthanc peer. | |
| 210 Returns the instanceId. | |
| 211 * ``Delete(instanceId)`` deletes the instance. | |
| 212 | |
| 213 | |
| 0 | 214 General-purpose functions |
| 215 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
| 216 | |
| 217 The Lua engine of Orthanc contain several general-purpose ancillary | |
| 218 functions: | |
| 219 | |
| 220 * ``PrintRecursive(v)`` recursively prints the content of a `Lua table | |
| 221 <http://www.lua.org/pil/2.5.html>`__ to the log file of Orthanc. | |
| 222 * ``ParseJson(s)`` converts a string encoded in the `JSON format | |
| 223 <https://en.wikipedia.org/wiki/JSON>`__ to a Lua table. | |
| 224 * ``DumpJson(v, keepStrings)`` encodes a Lua table as a JSON string. | |
| 225 Setting the optional argument ``keepStrings`` (available from | |
| 226 release 0.9.5) to ``true`` prevents the automatic conversion of | |
| 227 strings to integers. | |
| 228 * ``GetOrthancConfiguration()`` returns a Lua table containing the | |
| 229 content of the :ref:`configuration files <configuration>` of | |
| 230 Orthanc. | |
| 231 | |
| 232 | |
| 233 Similarly to the functions to :ref:`call the REST API of Orthanc | |
| 234 <lua-rest>`, several functions are available to make generic HTTP | |
| 235 requests to Web services: | |
| 236 | |
| 90 | 237 * ``HttpGet(url, headers)`` |
| 238 * ``HttpPost(url, body, headers)`` | |
| 239 * ``HttpPut(url, body, headers)`` | |
| 240 * ``HttpDelete(url, headers)`` | |
| 0 | 241 * ``SetHttpCredentials(username, password)`` can be used to setup the |
| 242 HTTP credentials. | |
| 243 | |
|
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
244 The ``headers`` argument is optional and was added in release |
| 91 | 245 1.2.1. It allows to set the HTTP headers for the HTTP client request. |
| 0 | 246 |
| 283 | 247 Example:: |
| 248 | |
| 249 local preview = RestApiGet('/instances/' .. instanceId .. '/preview') | |
| 250 local headers = { | |
| 251 ["content-type"] = "image/png", | |
| 252 } | |
| 253 HttpPost("http://localhost/my-web-service/instance-preview", preview, headers) | |
| 254 | |
| 0 | 255 .. _lua-origin: |
| 256 | |
| 257 Origin of the instances | |
| 258 ^^^^^^^^^^^^^^^^^^^^^^^ | |
| 259 | |
| 260 Whenever Orthanc decides whether it should should store a new instance | |
| 261 (cf. the ``ReceivedInstanceFilter()`` callback), or whenever it has | |
| 262 actually stored a new instance (cf. the ``OnStoredInstance`` | |
| 263 callback), an ``origin`` parameter is provided. This parameter is a | |
| 264 `Lua table <http://www.lua.org/pil/2.5.html>`__ that describes from | |
| 265 which Orthanc subsystem the new instance comes from. | |
| 266 | |
| 267 There are 4 possible subsystems, that can be distinguished according | |
| 268 to the value of ``origin["RequestOrigin"]``: | |
| 269 | |
| 270 * ``RestApi``: The instance originates from some HTTP request to the REST | |
| 271 API. In this case, the ``RemoteIp`` and ``Username`` fields are | |
| 272 available in ``origin``. They respectively describe the IP address | |
| 273 of the HTTP client, and the username that was used for HTTP | |
| 274 authentication (as defined in the ``RegisteredUsers`` | |
| 275 :ref:`configuration variable <configuration>`). | |
| 276 * ``DicomProtocol``: The instance originates from a DICOM C-Store. | |
| 277 The fields ``RemoteIp``, ``RemoteAet`` and ``CalledAet`` | |
| 278 respectively provide the IP address of the DICOM SCU (client), the | |
| 279 application entity title of the DICOM SCU client, and the | |
| 280 application entity title of the Orthanc SCP server. The | |
| 281 ``CalledAet`` can be used for :ref:`advanced auto-routing scenarios | |
| 282 <lua-auto-routing>`, when a single instance of Orthanc acts as a | |
| 283 proxy for several DICOM SCU clients. | |
| 284 * ``Lua``: The instance originates from a Lua script. | |
| 285 * ``Plugins``: The instance originates from a plugin. | |
| 286 | |
| 287 | |
| 288 .. _lua-filter-dicom: | |
| 289 | |
| 75 | 290 Filtering incoming DICOM instances |
| 0 | 291 ---------------------------------- |
| 292 | |
| 293 .. highlight:: lua | |
| 294 | |
| 295 Each time a DICOM instance is received by Orthanc (either through the | |
| 296 DICOM protocol or through the REST API), the | |
| 297 ``ReceivedInstanceFilter()`` Lua function is invoked. If this callback | |
| 298 returns ``true``, the instance is accepted for storage. If it returns | |
| 299 ``false``, the instance is discarded. This mechanism can be used to | |
| 300 filter the incoming DICOM instances. Here is an example of a Lua | |
| 301 filter that only allows incoming instances of MR modality:: | |
| 302 | |
|
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
303 function ReceivedInstanceFilter(dicom, origin, info) |
| 0 | 304 -- Only allow incoming MR images |
| 305 if dicom.Modality == 'MR' then | |
| 306 return true | |
| 307 else | |
| 308 return false | |
| 309 end | |
| 310 end | |
| 311 | |
|
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
312 The argument ``dicom`` corresponds to a `Lua table |
| 0 | 313 <http://www.lua.org/pil/2.5.html>`__ (i.e. an associative array) that |
| 314 contains the DICOM tags of the incoming instance. For debugging | |
| 315 purpose, you can print this structure as follows:: | |
| 316 | |
|
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
317 function ReceivedInstanceFilter(dicom, origin, info) |
| 0 | 318 PrintRecursive(dicom) |
| 319 -- Accept all incoming instances (default behavior) | |
| 320 return true | |
| 321 end | |
| 322 | |
| 323 The argument ``origin`` is :ref:`documented separately <lua-origin>`. | |
| 324 | |
|
387
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
325 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
|
326 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
|
327 notably: |
|
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
328 |
|
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
329 * ``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
|
330 present. |
|
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
331 * ``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
|
332 dataset of the instance (if applicable). |
|
1974913fd28a
documenting "info" argument in Lua ReceivedInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
360
diff
changeset
|
333 |
| 0 | 334 |
| 335 .. _lua-filter-rest: | |
| 336 | |
| 75 | 337 Filtering incoming REST requests |
| 0 | 338 -------------------------------- |
| 339 | |
| 340 .. highlight:: lua | |
| 341 | |
| 342 Lua scripting can be used to control the access to the various URI of | |
| 343 the REST API. Each time an incoming HTTP request is received, the | |
| 344 ``IncomingHttpRequestFilter()`` Lua function is called. The access to | |
| 345 the resource is granted if and only if this callback script returns | |
| 346 ``true``. | |
| 347 | |
| 348 This mechanism can be used to implement fine-grained `access control | |
| 25 | 349 lists <https://en.wikipedia.org/wiki/Access_control_list>`__. Here is |
| 0 | 350 an example of a Lua script that limits POST, PUT and DELETE requests |
| 351 to an user that is called "admin":: | |
| 352 | |
| 353 function IncomingHttpRequestFilter(method, uri, ip, username, httpHeaders) | |
| 354 -- Only allow GET requests for non-admin users | |
| 355 | |
| 356 if method == 'GET' then | |
| 357 return true | |
| 358 elseif username == 'admin' then | |
| 359 return true | |
| 360 else | |
| 361 return false | |
| 362 end | |
| 363 end | |
| 364 | |
| 365 Here is a description of the arguments of this Lua callback: | |
| 366 | |
| 367 * ``method``: The HTTP method (GET, POST, PUT or DELETE). | |
| 368 * ``uri``: The path to the resource (e.g. ``/tools/generate-uid``). | |
| 369 * ``ip``: The IP address of the host that has issued the HTTP request (e.g. ``127.0.0.1``). | |
| 370 * ``username``: If HTTP Basic Authentication is enabled in the | |
| 371 :ref:`configuration file <configuration>`, the name of the user that | |
| 372 has issued the HTTP request (as defined in the ``RegisteredUsers`` | |
| 373 configuration variable). If the authentication is disabled, this | |
| 374 argument is set to the empty string. | |
| 375 * ``httpHeaders``: The HTTP headers of the incoming request. This | |
| 376 argument is available since Orthanc 1.0.1. It is useful if the | |
| 377 authentication should be achieved through tokens, for instance | |
| 378 against a `LDAP | |
| 379 <https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol>`__ | |
| 380 or `OAuth2 <https://en.wikipedia.org/wiki/OAuth>`__ server. | |
| 381 | |
| 382 | |
| 383 .. _lua-auto-routing: | |
| 384 | |
| 75 | 385 Auto-routing of DICOM images |
| 0 | 386 ---------------------------- |
| 387 | |
| 388 .. highlight:: lua | |
| 389 | |
| 390 Since release 0.8.0, the routing of DICOM flows can be very easily | |
| 391 automated with Orthanc. All you have to do is to declare your | |
| 392 destination modality in the :ref:`configuration file <configuration>` | |
| 393 (section ``DicomModalities``), then to create and install a Lua | |
| 394 script. For instance, here is a sample script:: | |
| 395 | |
| 396 function OnStoredInstance(instanceId, tags, metadata) | |
| 397 Delete(SendToModality(instanceId, 'sample')) | |
| 398 end | |
| 399 | |
| 400 If this script is loaded into Orthanc, whenever a new DICOM instance | |
| 401 is received by Orthanc, it will be routed to the modality whose | |
| 402 symbolic name is ``sample`` (through a Store-SCU command), then it | |
| 403 will be removed from Orthanc. In other words, this is a **one-liner | |
| 404 script to implement DICOM auto-routing**. | |
| 405 | |
| 406 Very importantly, thanks to this feature, you do not have to use the | |
| 407 REST API or to create external scripts in order to automate simple | |
| 408 imaging flows. The scripting engine is entirely contained inside the | |
| 409 Orthanc core system. | |
| 410 | |
| 411 Thanks to Lua expressiveness, you can also implement conditional | |
| 412 auto-routing. For instance, if you wish to route only patients whose | |
| 413 name contains "David", you would simply write:: | |
| 414 | |
| 415 function OnStoredInstance(instanceId, tags, metadata) | |
| 416 -- Extract the value of the "PatientName" DICOM tag | |
| 417 local patientName = string.lower(tags['PatientName']) | |
| 418 | |
| 419 if string.find(patientName, 'david') ~= nil then | |
| 420 -- Only route patients whose name contains "David" | |
| 421 Delete(SendToModality(instanceId, 'sample')) | |
| 422 | |
| 423 else | |
| 424 -- Delete the patients that are not called "David" | |
| 425 Delete(instanceId) | |
| 426 end | |
| 427 end | |
| 428 | |
| 429 Besides ``SendToModality()``, a mostly identical function with the | |
| 430 same arguments called ``SendToPeer()`` can be used to route instances | |
| 431 to :ref:`Orthanc peers <peers>`. It is also possible to modify the | |
| 432 received instances before routing them. For instance, here is how you | |
| 433 would replace the ``StationName`` DICOM tag:: | |
| 434 | |
| 435 function OnStoredInstance(instanceId, tags, metadata) | |
| 436 -- Ignore the instances that result from a modification to avoid | |
| 437 -- infinite loops | |
| 438 if (metadata['ModifiedFrom'] == nil and | |
| 439 metadata['AnonymizedFrom'] == nil) then | |
| 440 | |
| 441 -- The tags to be replaced | |
| 442 local replace = {} | |
| 443 replace['StationName'] = 'My Medical Device' | |
| 444 | |
| 445 -- The tags to be removed | |
| 446 local remove = { 'MilitaryRank' } | |
| 447 | |
| 448 -- Modify the instance, send it, then delete the modified instance | |
| 449 Delete(SendToModality(ModifyInstance(instanceId, replace, remove, true), 'sample')) | |
| 450 | |
| 451 -- Delete the original instance | |
| 452 Delete(instanceId) | |
| 453 end | |
| 454 end | |
| 455 | |
| 456 | |
| 75 | 457 Important remarks about auto-routing |
| 458 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
|
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
459 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
460 The ``SendToModality()``, ``SendToPeer()``, ``ModifyInstance()`` and |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
461 ``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
|
462 (implying a single DICOM instance, and possibly a basic modification |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
463 of this instance). The ``ModifyInstance()`` function `could also lead |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
464 to problems |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
465 <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
|
466 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
|
467 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
468 For more evolved auto-routing scenarios, remember that Lua scripts |
| 191 | 469 :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
|
470 illustrated by the ``AutoroutingModification.lua`` sample available in |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
471 the source distribution of Orthanc:: |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
472 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
473 function OnStoredInstance(instanceId, tags, metadata, origin) |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
474 -- 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
|
475 -- avoid infinite loops |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
476 if origin['RequestOrigin'] ~= 'Lua' then |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
477 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
478 -- The tags to be replaced |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
479 local replace = {} |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
480 replace['StationName'] = 'My Medical Device' |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
481 replace['0031-1020'] = 'Some private tag' |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
482 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
483 -- The tags to be removed |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
484 local remove = { 'MilitaryRank' } |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
485 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
486 -- Modify the instance |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
487 local command = {} |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
488 command['Replace'] = replace |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
489 command['Remove'] = remove |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
490 local modifiedFile = RestApiPost('/instances/' .. instanceId .. '/modify', DumpJson(command, true)) |
|
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 -- Upload the modified instance to the Orthanc database so that |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
493 -- it can be sent by Orthanc to other modalities |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
494 local modifiedId = ParseJson(RestApiPost('/instances/', modifiedFile)) ['ID'] |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
495 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
496 -- Send the modified instance to another modality |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
497 RestApiPost('/modalities/sample/store', modifiedId) |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
498 |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
499 -- Delete the original and the modified instances |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
500 RestApiDelete('/instances/' .. instanceId) |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
501 RestApiDelete('/instances/' .. modifiedId) |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
502 end |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
503 end |
|
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 Also note that :ref:`other callbacks are available <lua-callbacks>` |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
506 (``OnStablePatient()``, ``OnStableStudy()`` and ``OnStableSeries()``) |
|
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
507 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
|
508 with ``OnStoredInstance()``. |
| 75 | 509 |
|
99
e83da2f99e45
added 'troubleshooting C-Find queries' in the worklist section
amazy
parents:
91
diff
changeset
|
510 .. _lua-fix-cfind: |
| 75 | 511 |
|
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
512 Fixing C-Find requests |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
513 ---------------------- |
| 75 | 514 |
| 515 :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
|
516 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
|
517 `reported by users |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
518 <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
|
519 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
|
520 (cf. `this real-world example |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
521 <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
|
522 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
|
523 outgoing C-Find queries using a Lua script. |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
524 |
|
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
525 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
|
526 ``IncomingFindRequestFilter(query, origin)`` callback that is called |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
527 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
|
528 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
|
529 by some manufacturer:: |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
530 |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
531 function IncomingFindRequestFilter(query, origin) |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
532 -- First display the content of the C-Find query |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
533 PrintRecursive(query) |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
534 PrintRecursive(origin) |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
535 |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
536 -- Remove the "PrivateCreator" tag from the query |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
537 local v = query |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
538 v['5555,0010'] = nil |
|
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 return v |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
541 end |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
542 |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
543 The ``origin`` argument contains information about which modality has |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
544 issued the request. |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
545 |
|
443
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
546 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
|
547 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
|
548 |
|
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
549 Also note that the ``IncomingFindRequestFilter`` callback is not applied to |
|
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
550 C-Find requests targeting :ref:`modality worklists |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
551 <worklists-plugin>`. Since Orthanc 1.4.2, the corresponding |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
552 ``IncomingWorklistRequestFilter`` callback can be used to sanitize |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
553 C-FIND requests against worklists:: |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
554 |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
555 function IncomingWorklistRequestFilter(query, origin) |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
556 PrintRecursive(query) |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
557 PrintRecursive(origin) |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
558 |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
559 -- Implements the same behavior as the "FilterIssuerAet" |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
560 -- option of the sample worklist plugin |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
561 query['0040,0100'][1]['0040,0001'] = origin['RemoteAet'] |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
562 |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
563 return query |
|
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
564 end |
|
105
268ec482f051
IncomingFindRequestFilter not applied to worklist plugin
amazy
parents:
99
diff
changeset
|
565 |
|
443
c66d8b7b1a13
more info about IncomingFindRequestFilter
Alain Mazy <alain@mazy.be>
parents:
387
diff
changeset
|
566 |
|
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
567 Similarly, the callback ``OutgoingFindRequestFilter(query, modality)`` |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
568 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
|
569 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
|
570 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
|
571 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
|
572 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
|
573 from Orthanc Explorer):: |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
574 |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
575 function OutgoingFindRequestFilter(query, modality) |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
576 for key, value in pairs(query) do |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
577 if value == '*' then |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
578 query[key] = '' |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
579 end |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
580 end |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
581 |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
582 return query |
|
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
583 end |
| 668 | 584 |
| 585 | |
| 586 .. _lua-external-modules: | |
| 587 | |
| 588 Using external modules | |
| 589 ---------------------- | |
| 590 | |
| 591 Starting with Orthanc 1.3.2, it is possible to use external Lua | |
| 592 modules if Orthanc was compiled with the ``-DENABLE_LUA_MODULES=ON`` | |
| 593 while invoking CMake. | |
| 594 | |
| 595 Importantly, the modules and the Orthanc server must use the same | |
| 596 version of Lua for external modules to be properly loaded. | |
| 597 | |
| 598 Check out the Orthanc Users forum for old discussions about this | |
| 599 topic: `reference 1 | |
| 600 <https://groups.google.com/g/orthanc-users/c/BXfmwU786B0/m/M47slt5GFwAJ>`__, | |
| 601 `reference 2 | |
| 602 <https://groups.google.com/g/orthanc-users/c/BXfmwU786B0/m/qpVe8UvGAwAJ>`__, | |
| 603 `reference 3 | |
| 604 <https://groups.google.com/g/orthanc-users/c/LDAN5jA0X8M/m/4zrk0_AaBAAJ>`__. |