Orthanc/OrthancFramework/Resources/CodeGeneration/GenerateErrorCodes.py
2025-06-23 19:07:37 +05:30

152 lines
4.8 KiB
Python
Executable File

#!/usr/bin/python
# Orthanc - A Lightweight, RESTful DICOM Store
# Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
# Department, University Hospital of Liege, Belgium
# Copyright (C) 2017-2023 Osimis S.A., Belgium
# Copyright (C) 2024-2025 Orthanc Team SRL, Belgium
# Copyright (C) 2021-2025 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
#
# This program is free software: you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public License
# as published by the Free Software Foundation, either version 3 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program. If not, see
# <http://www.gnu.org/licenses/>.
import json
import os
import re
import sys
START_PLUGINS = 1000000
BASE = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..'))
##
## Read all the available error codes and HTTP status
##
with open(os.path.join(BASE, 'OrthancFramework', 'Resources', 'CodeGeneration', 'ErrorCodes.json'), 'r') as f:
ERRORS = json.loads(re.sub('/\*.*?\*/', '', f.read()))
for error in ERRORS:
if error['Code'] >= START_PLUGINS:
print('ERROR: Error code must be below %d, but "%s" is set to %d' % (START_PLUGINS, error['Name'], error['Code']))
sys.exit(-1)
with open(os.path.join(BASE, 'OrthancFramework', 'Sources', 'Enumerations.h'), 'r') as f:
a = f.read()
HTTP = {}
for i in re.findall('(HttpStatus_([0-9]+)_\w+)', a):
HTTP[int(i[1])] = i[0]
##
## Generate the "ErrorCode" enumeration in "Enumerations.h"
##
path = os.path.join(BASE, 'OrthancFramework', 'Sources', 'Enumerations.h')
with open(path, 'r') as f:
a = f.read()
s = ',\n'.join(map(lambda x: ' ErrorCode_%s = %d /*!< %s */' % (x['Name'], int(x['Code']), x['Description']), ERRORS))
s += ',\n ErrorCode_START_PLUGINS = %d' % START_PLUGINS
a = re.sub('(enum ErrorCode\s*{)[^}]*?(\s*};)', r'\1\n%s\2' % s, a, re.DOTALL)
with open(path, 'w') as f:
f.write(a)
##
## Generate the "OrthancPluginErrorCode" enumeration in "OrthancCPlugin.h"
##
path = os.path.join(BASE, 'OrthancServer', 'Plugins', 'Include', 'orthanc', 'OrthancCPlugin.h')
with open(path, 'r') as f:
a = f.read()
s = ',\n'.join(map(lambda x: ' OrthancPluginErrorCode_%s = %d /*!< %s */' % (x['Name'], int(x['Code']), x['Description']), ERRORS))
s += ',\n\n _OrthancPluginErrorCode_INTERNAL = 0x7fffffff\n '
a = re.sub('(typedef enum\s*{)[^}]*?(} OrthancPluginErrorCode;)', r'\1\n%s\2' % s, a, re.DOTALL)
with open(path, 'w') as f:
f.write(a)
##
## Generate the "EnumerationToString(ErrorCode)" and
## "ConvertErrorCodeToHttpStatus(ErrorCode)" functions in
## "Enumerations.cpp"
##
path = os.path.join(BASE, 'OrthancFramework', 'Sources', 'Enumerations.cpp')
with open(path, 'r') as f:
a = f.read()
s = '\n\n'.join(map(lambda x: ' case ErrorCode_%s:\n return "%s";' % (x['Name'], x['Description']), ERRORS))
a = re.sub('(EnumerationToString\(ErrorCode.*?\)\s*{\s*switch \([^)]*?\)\s*{)[^}]*?(\s*default:)',
r'\1\n%s\2' % s, a, re.DOTALL)
def GetHttpStatus(x):
s = HTTP[x['HttpStatus']]
return ' case ErrorCode_%s:\n return %s;' % (x['Name'], s)
s = '\n\n'.join(map(GetHttpStatus, filter(lambda x: 'HttpStatus' in x, ERRORS)))
a = re.sub('(ConvertErrorCodeToHttpStatus\(ErrorCode.*?\)\s*{\s*switch \([^)]*?\)\s*{)[^}]*?(\s*default:)',
r'\1\n%s\2' % s, a, re.DOTALL)
with open(path, 'w') as f:
f.write(a)
##
## Generate the "ErrorCode" enumeration in "OrthancSQLiteException.h"
##
path = os.path.join(BASE, 'OrthancFramework', 'Sources', 'SQLite', 'OrthancSQLiteException.h')
with open(path, 'r') as f:
a = f.read()
e = list(filter(lambda x: 'SQLite' in x and x['SQLite'], ERRORS))
s = ',\n'.join(map(lambda x: ' ErrorCode_%s' % x['Name'], e))
a = re.sub('(enum ErrorCode\s*{)[^}]*?(\s*};)', r'\1\n%s\2' % s, a, re.DOTALL)
s = '\n\n'.join(map(lambda x: ' case ErrorCode_%s:\n return "%s";' % (x['Name'], x['Description']), e))
a = re.sub('(EnumerationToString\(ErrorCode.*?\)\s*{\s*switch \([^)]*?\)\s*{)[^}]*?(\s*default:)',
r'\1\n%s\2' % s, a, re.DOTALL)
with open(path, 'w') as f:
f.write(a)
##
## Generate the "PrintErrors" function in "main.cpp"
##
path = os.path.join(BASE, 'OrthancServer', 'Sources', 'main.cpp')
with open(path, 'r') as f:
a = f.read()
s = '\n'.join(map(lambda x: ' PrintErrorCode(ErrorCode_%s, "%s");' % (x['Name'], x['Description']), ERRORS))
a = re.sub('(static void PrintErrors[^{}]*?{[^{}]*?{)([^}]*?)}', r'\1\n%s\n }' % s, a, re.DOTALL)
with open(path, 'w') as f:
f.write(a)