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