annotate OrthancServer/Resources/Samples/ImportDicomFiles/ImportDicomFiles.py @ 4748:4336642b8cff

ignore JSON files in sample Python upload scripts
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 08 Jul 2021 14:42:20 +0200
parents d9473bd5ed43
children 7053502fbf97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2276
b85f68a98474 ImportDicomFiles: Look for Python interpreter in PATH
Thibault Nélis <tn@osimis.io>
parents: 2244
diff changeset
1 #!/usr/bin/env python
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
747
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
diff changeset
3 # Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1766
diff changeset
4 # Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 747
diff changeset
5 # Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
6 # Copyright (C) 2017-2021 Osimis S.A., Belgium
747
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
diff changeset
7 #
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
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: 733
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: 733
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: 733
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: 733
diff changeset
12 #
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
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: 733
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: 733
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: 733
diff changeset
16 # General Public License for more details.
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
diff changeset
17 #
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
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: 733
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: 733
diff changeset
20
44382c8bcd15 added explicit licensing terms for samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 733
diff changeset
21
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
22 import base64
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
23 import httplib2
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
24 import json
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 import os
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 import os.path
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
27 import sys
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
370
22bb88181e06 credentials
jodogne
parents: 280
diff changeset
29 if len(sys.argv) != 4 and len(sys.argv) != 6:
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 print("""
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 Sample script to recursively import in Orthanc all the DICOM files
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 that are stored in some path. Please make sure that Orthanc is running
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 before starting this script. The files are uploaded through the REST
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 API.
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 Usage: %s [hostname] [HTTP port] [path]
370
22bb88181e06 credentials
jodogne
parents: 280
diff changeset
37 Usage: %s [hostname] [HTTP port] [path] [username] [password]
2032
65b1ce7cb84f Replaced "localhost" by "127.0.0.1", as it might impact performance on Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
38 For instance: %s 127.0.0.1 8042 .
370
22bb88181e06 credentials
jodogne
parents: 280
diff changeset
39 """ % (sys.argv[0], sys.argv[0], sys.argv[0]))
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 exit(-1)
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 URL = 'http://%s:%d/instances' % (sys.argv[1], int(sys.argv[2]))
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
44 dicom_count = 0
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
45 json_count = 0
733
29982cfc5009 improvements to ImportDicomFiles tx Karsten Hilbert
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 373
diff changeset
46 total_file_count = 0
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
49 def IsJson(content):
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
50 try:
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
51 if (sys.version_info >= (3, 0)):
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
52 json.loads(content.decode())
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
53 return True
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
54 else:
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
55 json.loads(content)
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
56 return True
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
57 except:
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
58 return False
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
59
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
60
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 # This function will upload a single file to Orthanc through the REST API
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 def UploadFile(path):
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
63 global dicom_count
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
64 global json_count
733
29982cfc5009 improvements to ImportDicomFiles tx Karsten Hilbert
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 373
diff changeset
65 global total_file_count
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
67 f = open(path, 'rb')
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 content = f.read()
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 f.close()
733
29982cfc5009 improvements to ImportDicomFiles tx Karsten Hilbert
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 373
diff changeset
70 total_file_count += 1
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
72 sys.stdout.write('Importing %s' % path)
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
73
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
74 if IsJson(content):
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
75 sys.stdout.write(' => ignored JSON file\n')
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
76 json_count += 1
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
77 return
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
78
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 try:
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 h = httplib2.Http()
370
22bb88181e06 credentials
jodogne
parents: 280
diff changeset
81
373
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
82 headers = { 'content-type' : 'application/dicom' }
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
83
370
22bb88181e06 credentials
jodogne
parents: 280
diff changeset
84 if len(sys.argv) == 6:
373
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
85 username = sys.argv[4]
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
86 password = sys.argv[5]
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
87
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
88 # h.add_credentials(username, password)
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
89
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
90 # This is a custom reimplementation of the
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
91 # "Http.add_credentials()" method for Basic HTTP Access
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
92 # Authentication (for some weird reason, this method does
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
93 # not always work)
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
94 # http://en.wikipedia.org/wiki/Basic_access_authentication
3815
c81ac6ff232b ImportDicomFiles.py is now compatible
Benjamin Golinvaux <bgo@osimis.io>
parents: 3640
diff changeset
95 creds_str = username + ':' + password
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
96 creds_str_bytes = creds_str.encode('ascii')
3815
c81ac6ff232b ImportDicomFiles.py is now compatible
Benjamin Golinvaux <bgo@osimis.io>
parents: 3640
diff changeset
97 creds_str_bytes_b64 = b'Basic ' + base64.b64encode(creds_str_bytes)
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
98 headers['authorization'] = creds_str_bytes_b64.decode('ascii')
733
29982cfc5009 improvements to ImportDicomFiles tx Karsten Hilbert
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 373
diff changeset
99
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 resp, content = h.request(URL, 'POST',
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 body = content,
373
7000726bade7 fix ImportDicomFiles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 370
diff changeset
102 headers = headers)
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 if resp.status == 200:
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
105 sys.stdout.write(' => success\n')
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
106 dicom_count += 1
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 else:
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
108 sys.stdout.write(' => failure (Is it a DICOM file? Is there a password?)\n')
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 except:
3815
c81ac6ff232b ImportDicomFiles.py is now compatible
Benjamin Golinvaux <bgo@osimis.io>
parents: 3640
diff changeset
111 type, value, traceback = sys.exc_info()
c81ac6ff232b ImportDicomFiles.py is now compatible
Benjamin Golinvaux <bgo@osimis.io>
parents: 3640
diff changeset
112 sys.stderr.write(str(value))
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
113 sys.stdout.write(' => unable to connect (Is Orthanc running? Is there a password?)\n')
280
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 if os.path.isfile(sys.argv[3]):
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 # Upload a single file
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 UploadFile(sys.argv[3])
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 else:
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 # Recursively upload a directory
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 for root, dirs, files in os.walk(sys.argv[3]):
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 for f in files:
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 UploadFile(os.path.join(root, f))
77e526e6fdf8 sample script to import DICOM files in Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
125
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
126 if dicom_count + json_count == total_file_count:
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
127 print('\nSUCCESS: %d DICOM file(s) have been successfully imported' % dicom_count)
733
29982cfc5009 improvements to ImportDicomFiles tx Karsten Hilbert
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 373
diff changeset
128 else:
4748
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
129 print('\nWARNING: Only %d out of %d file(s) have been successfully imported as DICOM instance(s)' % (dicom_count, total_file_count - json_count))
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
130
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
131 if json_count != 0:
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
132 print('NB: %d JSON file(s) have been ignored' % json_count)
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
133
4336642b8cff ignore JSON files in sample Python upload scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
134 print('')