Mercurial > hg > orthanc
annotate OrthancServer/Resources/Samples/Python/RestToolbox.py @ 5836:618d44e0e714 find-refactoring tip
renamed QueryMetadata into MetadataQuery
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Mon, 14 Oct 2024 16:00:55 +0200 |
parents | f7adfb22e20e |
children |
rev | line source |
---|---|
747
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
1 # Orthanc - A Lightweight, RESTful DICOM Store |
1900 | 2 # Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1184
diff
changeset
|
3 # Department, University Hospital of Liege, Belgium |
5640
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
4 # Copyright (C) 2017-2023 Osimis S.A., Belgium |
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
5 # Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
6 # Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
747
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
7 # |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
8 # This program is free software: you can redistribute it and/or |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
9 # modify it under the terms of the GNU General Public License as |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
10 # published by the Free Software Foundation, either version 3 of the |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
11 # License, or (at your option) any later version. |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
12 # |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
13 # This program is distributed in the hope that it will be useful, but |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
14 # WITHOUT ANY WARRANTY; without even the implied warranty of |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
16 # General Public License for more details. |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
17 # |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
18 # You should have received a copy of the GNU General Public License |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
19 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
20 |
44382c8bcd15
added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
424
diff
changeset
|
21 |
340 | 22 import httplib2 |
23 import json | |
1184 | 24 import sys |
25 | |
26 if (sys.version_info >= (3, 0)): | |
27 from urllib.parse import urlencode | |
28 else: | |
29 from urllib import urlencode | |
30 | |
340 | 31 |
346 | 32 _credentials = None |
33 | |
1184 | 34 |
35 def _DecodeJson(s): | |
36 try: | |
37 if (sys.version_info >= (3, 0)): | |
38 return json.loads(s.decode()) | |
39 else: | |
40 return json.loads(s) | |
41 except: | |
42 return s | |
43 | |
44 | |
346 | 45 def SetCredentials(username, password): |
46 global _credentials | |
47 _credentials = (username, password) | |
48 | |
49 def _SetupCredentials(h): | |
50 global _credentials | |
51 if _credentials != None: | |
52 h.add_credentials(_credentials[0], _credentials[1]) | |
53 | |
2795
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
54 def _ComputeGetUri(uri, data): |
340 | 55 d = '' |
56 if len(data.keys()) > 0: | |
57 d = '?' + urlencode(data) | |
58 | |
2795
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
59 return uri + d |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
60 |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
61 def DoGet(uri, data = {}, interpretAsJson = True): |
340 | 62 h = httplib2.Http() |
346 | 63 _SetupCredentials(h) |
2795
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
64 resp, content = h.request(_ComputeGetUri(uri, data), 'GET') |
340 | 65 if not (resp.status in [ 200 ]): |
66 raise Exception(resp.status) | |
424 | 67 elif not interpretAsJson: |
1184 | 68 return content.decode() |
340 | 69 else: |
1184 | 70 return _DecodeJson(content) |
340 | 71 |
72 | |
2795
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
73 def DoRawGet(uri, data = {}): |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
74 h = httplib2.Http() |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
75 _SetupCredentials(h) |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
76 resp, content = h.request(_ComputeGetUri(uri, data), 'GET') |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
77 if not (resp.status in [ 200 ]): |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
78 raise Exception(resp.status) |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
79 else: |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
80 return content |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
81 |
f2e49b953e86
RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
82 |
340 | 83 def _DoPutOrPost(uri, method, data, contentType): |
84 h = httplib2.Http() | |
346 | 85 _SetupCredentials(h) |
340 | 86 |
87 if isinstance(data, str): | |
88 body = data | |
89 if len(contentType) != 0: | |
90 headers = { 'content-type' : contentType } | |
354 | 91 else: |
92 headers = { 'content-type' : 'text/plain' } | |
340 | 93 else: |
94 body = json.dumps(data) | |
95 headers = { 'content-type' : 'application/json' } | |
96 | |
97 resp, content = h.request( | |
98 uri, method, | |
99 body = body, | |
100 headers = headers) | |
101 | |
102 if not (resp.status in [ 200, 302 ]): | |
103 raise Exception(resp.status) | |
104 else: | |
1184 | 105 return _DecodeJson(content) |
340 | 106 |
107 | |
108 def DoDelete(uri): | |
109 h = httplib2.Http() | |
346 | 110 _SetupCredentials(h) |
340 | 111 resp, content = h.request(uri, 'DELETE') |
346 | 112 |
340 | 113 if not (resp.status in [ 200 ]): |
114 raise Exception(resp.status) | |
115 else: | |
1184 | 116 return _DecodeJson(content) |
340 | 117 |
118 | |
119 def DoPut(uri, data = {}, contentType = ''): | |
120 return _DoPutOrPost(uri, 'PUT', data, contentType) | |
121 | |
122 | |
123 def DoPost(uri, data = {}, contentType = ''): | |
124 return _DoPutOrPost(uri, 'POST', data, contentType) |