|
145
|
1 #!/usr/bin/python
|
|
|
2
|
|
|
3 # Orthanc - A Lightweight, RESTful DICOM Store
|
|
|
4 # Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
|
|
|
5 # Department, University Hospital of Liege, Belgium
|
|
153
|
6 # Copyright (C) 2017-2024 Osimis S.A., Belgium
|
|
|
7 # Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
|
|
145
|
8 #
|
|
|
9 # This program is free software: you can redistribute it and/or
|
|
|
10 # modify it under the terms of the GNU Lesser General Public License
|
|
|
11 # as published by the Free Software Foundation, either version 3 of
|
|
|
12 # the License, or (at your option) any later version.
|
|
|
13 #
|
|
|
14 # This program is distributed in the hope that it will be useful, but
|
|
|
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
17 # Lesser General Public License for more details.
|
|
|
18 #
|
|
|
19 # You should have received a copy of the GNU Lesser General Public
|
|
|
20 # License along with this program. If not, see
|
|
|
21 # <http://www.gnu.org/licenses/>.
|
|
|
22
|
|
|
23
|
|
|
24 import sys
|
|
|
25 import os
|
|
|
26 import os.path
|
|
|
27 import pprint
|
|
|
28 import re
|
|
|
29
|
|
|
30 UPCASE_CHECK = True
|
|
|
31 USE_SYSTEM_EXCEPTION = False
|
|
|
32 EXCEPTION_CLASS = 'OrthancException'
|
|
|
33 OUT_OF_RANGE_EXCEPTION = '::Orthanc::OrthancException(::Orthanc::ErrorCode_ParameterOutOfRange)'
|
|
|
34 INEXISTENT_PATH_EXCEPTION = '::Orthanc::OrthancException(::Orthanc::ErrorCode_InexistentItem)'
|
|
|
35 NAMESPACE = 'Orthanc.EmbeddedResources'
|
|
|
36 FRAMEWORK_PATH = None
|
|
|
37
|
|
|
38 ARGS = []
|
|
|
39 for i in range(len(sys.argv)):
|
|
|
40 if not sys.argv[i].startswith('--'):
|
|
|
41 ARGS.append(sys.argv[i])
|
|
|
42 elif sys.argv[i].lower() == '--no-upcase-check':
|
|
|
43 UPCASE_CHECK = False
|
|
|
44 elif sys.argv[i].lower() == '--system-exception':
|
|
|
45 USE_SYSTEM_EXCEPTION = True
|
|
|
46 EXCEPTION_CLASS = '::std::runtime_error'
|
|
|
47 OUT_OF_RANGE_EXCEPTION = '%s("Parameter out of range")' % EXCEPTION_CLASS
|
|
|
48 INEXISTENT_PATH_EXCEPTION = '%s("Unknown path in a directory resource")' % EXCEPTION_CLASS
|
|
|
49 elif sys.argv[i].startswith('--namespace='):
|
|
|
50 NAMESPACE = sys.argv[i][sys.argv[i].find('=') + 1 : ]
|
|
|
51 elif sys.argv[i].startswith('--framework-path='):
|
|
|
52 FRAMEWORK_PATH = sys.argv[i][sys.argv[i].find('=') + 1 : ]
|
|
|
53
|
|
|
54 if len(ARGS) < 2 or len(ARGS) % 2 != 0:
|
|
|
55 print ('Usage:')
|
|
|
56 print ('python %s [--no-upcase-check] [--system-exception] [--namespace=<Namespace>] <TargetBaseFilename> [ <Name> <Source> ]*' % sys.argv[0])
|
|
|
57 exit(-1)
|
|
|
58
|
|
|
59 TARGET_BASE_FILENAME = ARGS[1]
|
|
|
60 SOURCES = ARGS[2:]
|
|
|
61
|
|
|
62 try:
|
|
|
63 # Make sure the destination directory exists
|
|
|
64 os.makedirs(os.path.normpath(os.path.join(TARGET_BASE_FILENAME, '..')))
|
|
|
65 except:
|
|
|
66 pass
|
|
|
67
|
|
|
68
|
|
|
69 #####################################################################
|
|
|
70 ## Read each resource file
|
|
|
71 #####################################################################
|
|
|
72
|
|
|
73 def CheckNoUpcase(s):
|
|
|
74 global UPCASE_CHECK
|
|
|
75 if (UPCASE_CHECK and
|
|
|
76 re.search('[A-Z]', s) != None):
|
|
|
77 raise Exception("Path in a directory with an upcase letter: %s" % s)
|
|
|
78
|
|
|
79 resources = {}
|
|
|
80
|
|
|
81 counter = 0
|
|
|
82 i = 0
|
|
|
83 while i < len(SOURCES):
|
|
|
84 resourceName = SOURCES[i].upper()
|
|
|
85 pathName = SOURCES[i + 1]
|
|
|
86
|
|
|
87 if not os.path.exists(pathName):
|
|
|
88 raise Exception("Non existing path: %s" % pathName)
|
|
|
89
|
|
|
90 if resourceName in resources:
|
|
|
91 raise Exception("Twice the same resource: " + resourceName)
|
|
|
92
|
|
|
93 if os.path.isdir(pathName):
|
|
|
94 # The resource is a directory: Recursively explore its files
|
|
|
95 content = {}
|
|
|
96 for root, dirs, files in os.walk(pathName):
|
|
|
97 dirs.sort()
|
|
|
98 files.sort()
|
|
|
99 base = os.path.relpath(root, pathName)
|
|
|
100
|
|
|
101 # Fix issue #24 (Build fails on OSX when directory has .DS_Store files):
|
|
|
102 # Ignore folders whose name starts with a dot (".")
|
|
|
103 if base.find('/.') != -1:
|
|
|
104 print('Ignoring folder: %s' % root)
|
|
|
105 continue
|
|
|
106
|
|
|
107 for f in files:
|
|
|
108 if f.find('~') == -1: # Ignore Emacs backup files
|
|
|
109 if base == '.':
|
|
|
110 r = f
|
|
|
111 else:
|
|
|
112 r = os.path.join(base, f)
|
|
|
113
|
|
|
114 CheckNoUpcase(r)
|
|
|
115 r = '/' + r.replace('\\', '/')
|
|
|
116 if r in content:
|
|
|
117 raise Exception("Twice the same filename (check case): " + r)
|
|
|
118
|
|
|
119 content[r] = {
|
|
|
120 'Filename' : os.path.join(root, f),
|
|
|
121 'Index' : counter
|
|
|
122 }
|
|
|
123 counter += 1
|
|
|
124
|
|
|
125 resources[resourceName] = {
|
|
|
126 'Type' : 'Directory',
|
|
|
127 'Files' : content
|
|
|
128 }
|
|
|
129
|
|
|
130 elif os.path.isfile(pathName):
|
|
|
131 resources[resourceName] = {
|
|
|
132 'Type' : 'File',
|
|
|
133 'Index' : counter,
|
|
|
134 'Filename' : pathName
|
|
|
135 }
|
|
|
136 counter += 1
|
|
|
137
|
|
|
138 else:
|
|
|
139 raise Exception("Not a regular file, nor a directory: " + pathName)
|
|
|
140
|
|
|
141 i += 2
|
|
|
142
|
|
|
143 #pprint.pprint(resources)
|
|
|
144
|
|
|
145
|
|
|
146 #####################################################################
|
|
|
147 ## Write .h header
|
|
|
148 #####################################################################
|
|
|
149
|
|
|
150 header = open(TARGET_BASE_FILENAME + '.h', 'w')
|
|
|
151
|
|
|
152 header.write("""
|
|
|
153 #pragma once
|
|
|
154
|
|
|
155 #include <string>
|
|
|
156 #include <list>
|
|
|
157
|
|
|
158 #if defined(_MSC_VER)
|
|
|
159 # pragma warning(disable: 4065) // "Switch statement contains 'default' but no 'case' labels"
|
|
|
160 #endif
|
|
|
161
|
|
|
162 """)
|
|
|
163
|
|
|
164
|
|
|
165 for ns in NAMESPACE.split('.'):
|
|
|
166 header.write('namespace %s {\n' % ns)
|
|
|
167
|
|
|
168
|
|
|
169 header.write("""
|
|
|
170 enum FileResourceId
|
|
|
171 {
|
|
|
172 """)
|
|
|
173
|
|
|
174 isFirst = True
|
|
|
175 for name in resources:
|
|
|
176 if resources[name]['Type'] == 'File':
|
|
|
177 if isFirst:
|
|
|
178 isFirst = False
|
|
|
179 else:
|
|
|
180 header.write(',\n')
|
|
|
181 header.write(' %s' % name)
|
|
|
182
|
|
|
183 header.write("""
|
|
|
184 };
|
|
|
185
|
|
|
186 enum DirectoryResourceId
|
|
|
187 {
|
|
|
188 """)
|
|
|
189
|
|
|
190 isFirst = True
|
|
|
191 for name in resources:
|
|
|
192 if resources[name]['Type'] == 'Directory':
|
|
|
193 if isFirst:
|
|
|
194 isFirst = False
|
|
|
195 else:
|
|
|
196 header.write(',\n')
|
|
|
197 header.write(' %s' % name)
|
|
|
198
|
|
|
199 header.write("""
|
|
|
200 };
|
|
|
201
|
|
|
202 const void* GetFileResourceBuffer(FileResourceId id);
|
|
|
203 size_t GetFileResourceSize(FileResourceId id);
|
|
|
204 void GetFileResource(std::string& result, FileResourceId id);
|
|
|
205
|
|
|
206 const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path);
|
|
|
207 size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path);
|
|
|
208 void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path);
|
|
|
209
|
|
|
210 void ListResources(std::list<std::string>& result, DirectoryResourceId id);
|
|
|
211
|
|
|
212 """)
|
|
|
213
|
|
|
214
|
|
|
215 for ns in NAMESPACE.split('.'):
|
|
|
216 header.write('}\n')
|
|
|
217
|
|
|
218 header.close()
|
|
|
219
|
|
|
220
|
|
|
221
|
|
|
222 #####################################################################
|
|
|
223 ## Write the resource content in the .cpp source
|
|
|
224 #####################################################################
|
|
|
225
|
|
|
226 PYTHON_MAJOR_VERSION = sys.version_info[0]
|
|
|
227
|
|
|
228 def WriteResource(cpp, item):
|
|
|
229 cpp.write(' static const uint8_t resource%dBuffer[] = {' % item['Index'])
|
|
|
230
|
|
|
231 f = open(item['Filename'], "rb")
|
|
|
232 content = f.read()
|
|
|
233 f.close()
|
|
|
234
|
|
|
235 # http://stackoverflow.com/a/1035360
|
|
|
236 pos = 0
|
|
|
237 buffer = [] # instead of appending a few bytes at a time to the cpp file,
|
|
|
238 # we first append each chunk to a list, join it and write it
|
|
|
239 # to the file. We've measured that it was 2-3 times faster in python3.
|
|
|
240 # Note that speed is important since if generation is too slow,
|
|
|
241 # cmake might try to compile the EmbeddedResources.cpp file while it is
|
|
|
242 # still being generated !
|
|
|
243 for b in content:
|
|
|
244 if PYTHON_MAJOR_VERSION == 2:
|
|
|
245 c = ord(b[0])
|
|
|
246 else:
|
|
|
247 c = b
|
|
|
248
|
|
|
249 if pos > 0:
|
|
|
250 buffer.append(",")
|
|
|
251
|
|
|
252 if (pos % 16) == 0:
|
|
|
253 buffer.append("\n")
|
|
|
254
|
|
|
255 if c < 0:
|
|
|
256 raise Exception("Internal error")
|
|
|
257
|
|
|
258 buffer.append("0x%02x" % c)
|
|
|
259 pos += 1
|
|
|
260
|
|
|
261 cpp.write("".join(buffer))
|
|
|
262 # Zero-size array are disallowed, so we put one single void character in it.
|
|
|
263 if pos == 0:
|
|
|
264 cpp.write(' 0')
|
|
|
265
|
|
|
266 cpp.write(' };\n')
|
|
|
267 cpp.write(' static const size_t resource%dSize = %d;\n' % (item['Index'], pos))
|
|
|
268
|
|
|
269
|
|
|
270 cpp = open(TARGET_BASE_FILENAME + '.cpp', 'w')
|
|
|
271
|
|
|
272 cpp.write('#include "%s.h"\n' % os.path.basename(TARGET_BASE_FILENAME))
|
|
|
273
|
|
|
274 if USE_SYSTEM_EXCEPTION:
|
|
|
275 cpp.write('#include <stdexcept>')
|
|
|
276 elif FRAMEWORK_PATH != None:
|
|
|
277 cpp.write('#include "%s/OrthancException.h"' % FRAMEWORK_PATH)
|
|
|
278 else:
|
|
|
279 cpp.write('#include <OrthancException.h>')
|
|
|
280
|
|
|
281 cpp.write("""
|
|
|
282 #include <stdint.h>
|
|
|
283 #include <string.h>
|
|
|
284
|
|
|
285 """)
|
|
|
286
|
|
|
287 for ns in NAMESPACE.split('.'):
|
|
|
288 cpp.write('namespace %s {\n' % ns)
|
|
|
289
|
|
|
290
|
|
|
291 for name in resources:
|
|
|
292 if resources[name]['Type'] == 'File':
|
|
|
293 WriteResource(cpp, resources[name])
|
|
|
294 else:
|
|
|
295 for f in resources[name]['Files']:
|
|
|
296 WriteResource(cpp, resources[name]['Files'][f])
|
|
|
297
|
|
|
298
|
|
|
299
|
|
|
300 #####################################################################
|
|
|
301 ## Write the accessors to the file resources in .cpp
|
|
|
302 #####################################################################
|
|
|
303
|
|
|
304 cpp.write("""
|
|
|
305 const void* GetFileResourceBuffer(FileResourceId id)
|
|
|
306 {
|
|
|
307 switch (id)
|
|
|
308 {
|
|
|
309 """)
|
|
|
310 for name in resources:
|
|
|
311 if resources[name]['Type'] == 'File':
|
|
|
312 cpp.write(' case %s:\n' % name)
|
|
|
313 cpp.write(' return resource%dBuffer;\n' % resources[name]['Index'])
|
|
|
314
|
|
|
315 cpp.write("""
|
|
|
316 default:
|
|
|
317 throw %s;
|
|
|
318 }
|
|
|
319 }
|
|
|
320
|
|
|
321 size_t GetFileResourceSize(FileResourceId id)
|
|
|
322 {
|
|
|
323 switch (id)
|
|
|
324 {
|
|
|
325 """ % OUT_OF_RANGE_EXCEPTION)
|
|
|
326
|
|
|
327 for name in resources:
|
|
|
328 if resources[name]['Type'] == 'File':
|
|
|
329 cpp.write(' case %s:\n' % name)
|
|
|
330 cpp.write(' return resource%dSize;\n' % resources[name]['Index'])
|
|
|
331
|
|
|
332 cpp.write("""
|
|
|
333 default:
|
|
|
334 throw %s;
|
|
|
335 }
|
|
|
336 }
|
|
|
337 """ % OUT_OF_RANGE_EXCEPTION)
|
|
|
338
|
|
|
339
|
|
|
340
|
|
|
341 #####################################################################
|
|
|
342 ## Write the accessors to the directory resources in .cpp
|
|
|
343 #####################################################################
|
|
|
344
|
|
|
345 cpp.write("""
|
|
|
346 const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path)
|
|
|
347 {
|
|
|
348 switch (id)
|
|
|
349 {
|
|
|
350 """)
|
|
|
351
|
|
|
352 for name in resources:
|
|
|
353 if resources[name]['Type'] == 'Directory':
|
|
|
354 cpp.write(' case %s:\n' % name)
|
|
|
355 isFirst = True
|
|
|
356 for path in resources[name]['Files']:
|
|
|
357 cpp.write(' if (!strcmp(path, "%s"))\n' % path)
|
|
|
358 cpp.write(' return resource%dBuffer;\n' % resources[name]['Files'][path]['Index'])
|
|
|
359 cpp.write(' throw %s;\n\n' % INEXISTENT_PATH_EXCEPTION)
|
|
|
360
|
|
|
361 cpp.write(""" default:
|
|
|
362 throw %s;
|
|
|
363 }
|
|
|
364 }
|
|
|
365
|
|
|
366 size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path)
|
|
|
367 {
|
|
|
368 switch (id)
|
|
|
369 {
|
|
|
370 """ % OUT_OF_RANGE_EXCEPTION)
|
|
|
371
|
|
|
372 for name in resources:
|
|
|
373 if resources[name]['Type'] == 'Directory':
|
|
|
374 cpp.write(' case %s:\n' % name)
|
|
|
375 isFirst = True
|
|
|
376 for path in resources[name]['Files']:
|
|
|
377 cpp.write(' if (!strcmp(path, "%s"))\n' % path)
|
|
|
378 cpp.write(' return resource%dSize;\n' % resources[name]['Files'][path]['Index'])
|
|
|
379 cpp.write(' throw %s;\n\n' % INEXISTENT_PATH_EXCEPTION)
|
|
|
380
|
|
|
381 cpp.write(""" default:
|
|
|
382 throw %s;
|
|
|
383 }
|
|
|
384 }
|
|
|
385 """ % OUT_OF_RANGE_EXCEPTION)
|
|
|
386
|
|
|
387
|
|
|
388
|
|
|
389
|
|
|
390 #####################################################################
|
|
|
391 ## List the resources in a directory
|
|
|
392 #####################################################################
|
|
|
393
|
|
|
394 cpp.write("""
|
|
|
395 void ListResources(std::list<std::string>& result, DirectoryResourceId id)
|
|
|
396 {
|
|
|
397 result.clear();
|
|
|
398
|
|
|
399 switch (id)
|
|
|
400 {
|
|
|
401 """)
|
|
|
402
|
|
|
403 for name in resources:
|
|
|
404 if resources[name]['Type'] == 'Directory':
|
|
|
405 cpp.write(' case %s:\n' % name)
|
|
|
406 for path in sorted(resources[name]['Files']):
|
|
|
407 cpp.write(' result.push_back("%s");\n' % path)
|
|
|
408 cpp.write(' break;\n\n')
|
|
|
409
|
|
|
410 cpp.write(""" default:
|
|
|
411 throw %s;
|
|
|
412 }
|
|
|
413 }
|
|
|
414 """ % OUT_OF_RANGE_EXCEPTION)
|
|
|
415
|
|
|
416
|
|
|
417
|
|
|
418
|
|
|
419 #####################################################################
|
|
|
420 ## Write the convenience wrappers in .cpp
|
|
|
421 #####################################################################
|
|
|
422
|
|
|
423 cpp.write("""
|
|
|
424 void GetFileResource(std::string& result, FileResourceId id)
|
|
|
425 {
|
|
|
426 size_t size = GetFileResourceSize(id);
|
|
|
427 result.resize(size);
|
|
|
428 if (size > 0)
|
|
|
429 memcpy(&result[0], GetFileResourceBuffer(id), size);
|
|
|
430 }
|
|
|
431
|
|
|
432 void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path)
|
|
|
433 {
|
|
|
434 size_t size = GetDirectoryResourceSize(id, path);
|
|
|
435 result.resize(size);
|
|
|
436 if (size > 0)
|
|
|
437 memcpy(&result[0], GetDirectoryResourceBuffer(id, path), size);
|
|
|
438 }
|
|
|
439 """)
|
|
|
440
|
|
|
441
|
|
|
442 for ns in NAMESPACE.split('.'):
|
|
|
443 cpp.write('}\n')
|
|
|
444
|
|
|
445 cpp.close()
|
