Mercurial > hg > orthanc

annotate OrthancServer/Resources/Samples/Python/RestToolbox.py @ 5640:f7adfb22e20e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated copyright, as Orthanc Team now replaces Osimis
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 30 May 2024 21:19:57 +0200
parents 48b8dae6dc77
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
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
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 import httplib2
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 import json
1184
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
24 import sys
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
25
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
26 if (sys.version_info >= (3, 0)):
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
27 from urllib.parse import urlencode
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
28 else:
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
29 from urllib import urlencode
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
30
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
346
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
32 _credentials = None
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
33
1184
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
34
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
35 def _DecodeJson(s):
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
36 try:
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
37 if (sys.version_info >= (3, 0)):
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
38 return json.loads(s.decode())
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
39 else:
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
40 return json.loads(s)
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
41 except:
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
42 return s
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
43
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
44
346
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
45 def SetCredentials(username, password):
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
46 global _credentials
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
47 _credentials = (username, password)
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
48
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
49 def _SetupCredentials(h):
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
50 global _credentials
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
51 if _credentials != None:
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
52 h.add_credentials(_credentials[0], _credentials[1])
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
53
2795
f2e49b953e86 RestToolbox.DoRawGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
54 def _ComputeGetUri(uri, data):
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 d = ''
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 if len(data.keys()) > 0:
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 d = '?' + urlencode(data)
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 h = httplib2.Http()
346
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
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
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 if not (resp.status in [ 200 ]):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 raise Exception(resp.status)
424
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 354
diff changeset
67 elif not interpretAsJson:
1184
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
68 return content.decode()
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 else:
1184
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
70 return _DecodeJson(content)
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 def _DoPutOrPost(uri, method, data, contentType):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 h = httplib2.Http()
346
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
85 _SetupCredentials(h)
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 if isinstance(data, str):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 body = data
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 if len(contentType) != 0:
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 headers = { 'content-type' : contentType }
354
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 346
diff changeset
91 else:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 346
diff changeset
92 headers = { 'content-type' : 'text/plain' }
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 else:
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 body = json.dumps(data)
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 headers = { 'content-type' : 'application/json' }
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 resp, content = h.request(
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 uri, method,
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 body = body,
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 headers = headers)
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 if not (resp.status in [ 200, 302 ]):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 raise Exception(resp.status)
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 else:
1184
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
105 return _DecodeJson(content)
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 def DoDelete(uri):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 h = httplib2.Http()
346
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
110 _SetupCredentials(h)
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 resp, content = h.request(uri, 'DELETE')
346
107da6a8c630 credentials in python rest toolbox
jodogne
parents: 341
diff changeset
112
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 if not (resp.status in [ 200 ]):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 raise Exception(resp.status)
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 else:
1184
4e9d517503ae port to Python3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
116 return _DecodeJson(content)
340
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 def DoPut(uri, data = {}, contentType = ''):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 return _DoPutOrPost(uri, 'PUT', data, contentType)
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 def DoPost(uri, data = {}, contentType = ''):
61f6a3d66b85 changes loop sample
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 return _DoPutOrPost(uri, 'POST', data, contentType)