Mercurial > hg > orthanc-webviewer
changeset 191:993dd140bd30
Resort to Orthanc framework
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 16 Apr 2018 21:29:30 +0200 |
parents | 7151dbac8d5e |
children | afaa2e133e7d |
files | CMakeLists.txt NEWS Orthanc/Core/ChunkedBuffer.cpp Orthanc/Core/ChunkedBuffer.h Orthanc/Core/DicomFormat/DicomMap.cpp Orthanc/Core/DicomFormat/DicomMap.h Orthanc/Core/DicomFormat/DicomTag.cpp Orthanc/Core/DicomFormat/DicomTag.h Orthanc/Core/DicomFormat/DicomValue.cpp Orthanc/Core/DicomFormat/DicomValue.h Orthanc/Core/Endianness.h Orthanc/Core/Enumerations.cpp Orthanc/Core/Enumerations.h Orthanc/Core/FileStorage/FilesystemStorage.cpp Orthanc/Core/FileStorage/FilesystemStorage.h Orthanc/Core/FileStorage/IStorageArea.h Orthanc/Core/IDynamicObject.h Orthanc/Core/Images/ImageAccessor.cpp Orthanc/Core/Images/ImageAccessor.h Orthanc/Core/Images/ImageBuffer.cpp Orthanc/Core/Images/ImageBuffer.h Orthanc/Core/Images/ImageProcessing.cpp Orthanc/Core/Images/ImageProcessing.h Orthanc/Core/Images/PixelTraits.h Orthanc/Core/Logging.h Orthanc/Core/MultiThreading/SharedMessageQueue.cpp Orthanc/Core/MultiThreading/SharedMessageQueue.h Orthanc/Core/OrthancException.h Orthanc/Core/PrecompiledHeaders.cpp Orthanc/Core/PrecompiledHeaders.h Orthanc/Core/SQLite/Connection.cpp Orthanc/Core/SQLite/Connection.h Orthanc/Core/SQLite/FunctionContext.cpp Orthanc/Core/SQLite/FunctionContext.h Orthanc/Core/SQLite/IScalarFunction.h Orthanc/Core/SQLite/ITransaction.h Orthanc/Core/SQLite/NonCopyable.h Orthanc/Core/SQLite/OrthancSQLiteException.h Orthanc/Core/SQLite/SQLiteTypes.h Orthanc/Core/SQLite/Statement.cpp Orthanc/Core/SQLite/Statement.h Orthanc/Core/SQLite/StatementId.cpp Orthanc/Core/SQLite/StatementId.h Orthanc/Core/SQLite/StatementReference.cpp Orthanc/Core/SQLite/StatementReference.h Orthanc/Core/SQLite/Transaction.cpp Orthanc/Core/SQLite/Transaction.h Orthanc/Core/SystemToolbox.cpp Orthanc/Core/SystemToolbox.h Orthanc/Core/Toolbox.cpp Orthanc/Core/Toolbox.h Orthanc/NEWS Orthanc/Plugins/Samples/Common/ExportedSymbols.list Orthanc/Plugins/Samples/Common/VersionScript.map Orthanc/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.cpp Orthanc/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.h Orthanc/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.cpp Orthanc/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.h Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.cpp Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h Orthanc/Plugins/Samples/GdcmDecoder/README Orthanc/README.txt Orthanc/Resources/CMake/AutoGeneratedCode.cmake Orthanc/Resources/CMake/BoostConfiguration.cmake Orthanc/Resources/CMake/Compiler.cmake Orthanc/Resources/CMake/DownloadPackage.cmake Orthanc/Resources/CMake/GoogleTestConfiguration.cmake Orthanc/Resources/CMake/JsonCppConfiguration.cmake Orthanc/Resources/CMake/SQLiteConfiguration.cmake Orthanc/Resources/CMake/UuidConfiguration.cmake Orthanc/Resources/EmbedResources.py Orthanc/Resources/LinuxStandardBaseToolchain.cmake Orthanc/Resources/MinGW-W64-Toolchain32.cmake Orthanc/Resources/MinGW-W64-Toolchain64.cmake Orthanc/Resources/MinGWToolchain.cmake Orthanc/Resources/Patches/boost-1.66.0-linux-standard-base.patch Orthanc/Resources/ThirdParty/VisualStudio/stdint.h Orthanc/Resources/ThirdParty/base64/base64.cpp Orthanc/Resources/ThirdParty/base64/base64.h Orthanc/Resources/WindowsResources.py Orthanc/Resources/WindowsResources.rc Orthanc/Sdk-0.9.5/orthanc/OrthancCPlugin.h Plugin/Cache/CacheIndex.h Plugin/Cache/CacheManager.cpp Plugin/Cache/CacheManager.h Plugin/Cache/CacheScheduler.cpp Plugin/Cache/CacheScheduler.h Plugin/DecodedImageAdapter.cpp Plugin/DecodedImageAdapter.h Plugin/Plugin.cpp Plugin/ViewerToolbox.cpp Plugin/ViewerToolbox.h Resources/CMake/GdcmConfiguration.cmake Resources/CMake/LinuxStandardBaseToolchain.cmake Resources/Orthanc/README.txt Resources/SyncOrthancFolder.py UnitTestsSources/UnitTestsMain.cpp |
diffstat | 97 files changed, 81 insertions(+), 21886 deletions(-) [+] |
line wrap: on
line diff
--- a/CMakeLists.txt Wed Apr 11 16:23:44 2018 +0200 +++ b/CMakeLists.txt Mon Apr 16 21:29:30 2018 +0200 @@ -29,40 +29,31 @@ set(ALLOW_DOWNLOADS OFF CACHE BOOL "Allow CMake to download packages") # Advanced parameters to fine-tune linking against system libraries -set(USE_SYSTEM_BOOST ON CACHE BOOL "Use the system version of Boost") set(USE_SYSTEM_GDCM ON CACHE BOOL "Use the system version of Grassroot DICOM (GDCM)") -set(USE_SYSTEM_GOOGLE_TEST ON CACHE BOOL "Use the system version of Google Test") -set(USE_SYSTEM_JSONCPP ON CACHE BOOL "Use the system version of JsonCpp") set(USE_SYSTEM_ORTHANC_SDK ON CACHE BOOL "Use the system version of the Orthanc plugin SDK") -set(USE_SYSTEM_SQLITE ON CACHE BOOL "Use the system version of SQLite") -set(USE_SYSTEM_UUID ON CACHE BOOL "Use the system version of the uuid library from e2fsprogs") -# Distribution-specific settings -set(USE_GOOGLE_TEST_DEBIAN_PACKAGE OFF CACHE BOOL "Use the sources of Google Test shipped with libgtest-dev (Debian only)") -mark_as_advanced(USE_GOOGLE_TEST_DEBIAN_PACKAGE) - -set(ORTHANC_ROOT ${CMAKE_SOURCE_DIR}/Orthanc) -set(ENABLE_LOCALE OFF) # Disable support for locales (notably in Boost) - -if (NOT "${CMAKE_SYSTEM_VERSION}" STREQUAL "LinuxStandardBase") - # The "patch" command-line tool is only needed for Boost and LSB - set(ORTHANC_DISABLE_PATCH ON) +# Download the Orthanc framework +if (ORTHANC_WEBVIEWER_VERSION STREQUAL "mainline") + set(ORTHANC_FRAMEWORK_SOURCE "hg") + set(ORTHANC_FRAMEWORK_VERSION "mainline") +else() + set(ORTHANC_FRAMEWORK_SOURCE "web") + set(ORTHANC_FRAMEWORK_VERSION "1.3.1") endif() -include(CheckIncludeFile) -include(CheckIncludeFiles) -include(CheckIncludeFileCXX) -include(CheckLibraryExists) -include(FindPythonInterp) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/Compiler.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/AutoGeneratedCode.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/DownloadPackage.cmake) +include(${CMAKE_SOURCE_DIR}/Resources/Orthanc/DownloadOrthancFramework.cmake) + + +# Initialize the Orthanc framework +include(${ORTHANC_ROOT}/Resources/CMake/OrthancFrameworkParameters.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/BoostConfiguration.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/GoogleTestConfiguration.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/JsonCppConfiguration.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/SQLiteConfiguration.cmake) -include(${CMAKE_SOURCE_DIR}/Orthanc/Resources/CMake/UuidConfiguration.cmake) +set(ENABLE_LOCALE OFF) # Disable support for locales (notably in Boost) +set(ENABLE_GOOGLE_TEST ON) +set(ENABLE_SQLITE ON) + +include(${ORTHANC_ROOT}/Resources/CMake/OrthancFrameworkConfiguration.cmake) +include_directories(${ORTHANC_ROOT}) + include(${CMAKE_SOURCE_DIR}/Resources/CMake/GdcmConfiguration.cmake) include(${CMAKE_SOURCE_DIR}/Resources/CMake/JavaScriptLibraries.cmake) @@ -70,7 +61,7 @@ # Check that the Orthanc SDK headers are available if (STATIC_BUILD OR NOT USE_SYSTEM_ORTHANC_SDK) - include_directories(${ORTHANC_ROOT}/Sdk-0.9.5) + include_directories(${CMAKE_SOURCE_DIR}/Resources/Orthanc/Sdk-0.9.5) else () CHECK_INCLUDE_FILE_CXX(orthanc/OrthancCPlugin.h HAVE_ORTHANC_H) if (NOT HAVE_ORTHANC_H) @@ -99,15 +90,6 @@ ${EMBEDDED_RESOURCES} ) -add_definitions( - -DORTHANC_DEFAULT_DICOM_ENCODING=Encoding_Latin1 - -DORTHANC_ENABLE_LOCALE=0 - -DORTHANC_ENABLE_PUGIXML=0 - -DORTHANC_ENABLE_SQLITE=1 - -DORTHANC_SQLITE_STANDALONE=1 - ) - - if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" OR ${CMAKE_SYSTEM_NAME} STREQUAL "kFreeBSD" OR ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD") @@ -136,44 +118,17 @@ endif() add_definitions( - -DORTHANC_ENABLE_MD5=0 - -DORTHANC_ENABLE_BASE64=0 - -DORTHANC_ENABLE_LOGGING=0 -DORTHANC_SANDBOXED=0 ) set(CORE_SOURCES - ${BOOST_SOURCES} - ${JSONCPP_SOURCES} - ${SQLITE_SOURCES} - ${UUID_SOURCES} - - # Sources inherited from Orthanc core - ${CMAKE_SOURCE_DIR}/Orthanc/Core/ChunkedBuffer.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/Enumerations.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/FileStorage/FilesystemStorage.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/Images/ImageAccessor.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/Images/ImageBuffer.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/Images/ImageProcessing.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/MultiThreading/SharedMessageQueue.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SQLite/Connection.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SQLite/FunctionContext.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SQLite/Statement.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SQLite/StatementId.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SQLite/StatementReference.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SQLite/Transaction.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/SystemToolbox.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/Toolbox.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/DicomFormat/DicomMap.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/DicomFormat/DicomTag.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Core/DicomFormat/DicomValue.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Resources/ThirdParty/base64/base64.cpp - ${CMAKE_SOURCE_DIR}/Plugin/Cache/CacheManager.cpp ${CMAKE_SOURCE_DIR}/Plugin/Cache/CacheScheduler.cpp ${CMAKE_SOURCE_DIR}/Plugin/ViewerToolbox.cpp ${CMAKE_SOURCE_DIR}/Plugin/ViewerPrefetchPolicy.cpp ${CMAKE_SOURCE_DIR}/Plugin/SeriesInformationAdapter.cpp + + ${ORTHANC_CORE_SOURCES} ) add_library(OrthancWebViewer @@ -184,9 +139,9 @@ # The following files depend on GDCM ${CMAKE_SOURCE_DIR}/Plugin/DecodedImageAdapter.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.cpp - ${CMAKE_SOURCE_DIR}/Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.cpp + ${ORTHANC_ROOT}/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.cpp + ${ORTHANC_ROOT}/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.cpp + ${ORTHANC_ROOT}/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.cpp ) @@ -213,7 +168,6 @@ add_executable(UnitTests ${CORE_SOURCES} ${GOOGLE_TEST_SOURCES} - ${JSONCPP_SOURCES} UnitTestsSources/UnitTestsMain.cpp )
--- a/NEWS Wed Apr 11 16:23:44 2018 +0200 +++ b/NEWS Mon Apr 16 21:29:30 2018 +0200 @@ -7,6 +7,7 @@ * Support of rendering RGB48 lookup tables (palette), if Orthanc SDK >= 1.3.1 * Support of OpenBSD * Support of Linux Standard Base +* Resort to Orthanc framework * Upgrade to GDCM 2.8.4 for static builds
--- a/Orthanc/Core/ChunkedBuffer.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,103 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "PrecompiledHeaders.h" -#include "ChunkedBuffer.h" - -#include <cassert> -#include <string.h> - - -namespace Orthanc -{ - void ChunkedBuffer::Clear() - { - numBytes_ = 0; - - for (Chunks::iterator it = chunks_.begin(); - it != chunks_.end(); ++it) - { - delete *it; - } - } - - - void ChunkedBuffer::AddChunk(const void* chunkData, - size_t chunkSize) - { - if (chunkSize == 0) - { - return; - } - else - { - assert(chunkData != NULL); - chunks_.push_back(new std::string(reinterpret_cast<const char*>(chunkData), chunkSize)); - numBytes_ += chunkSize; - } - } - - - void ChunkedBuffer::AddChunk(const std::string& chunk) - { - if (chunk.size() > 0) - { - AddChunk(&chunk[0], chunk.size()); - } - } - - - void ChunkedBuffer::Flatten(std::string& result) - { - result.resize(numBytes_); - - size_t pos = 0; - for (Chunks::iterator it = chunks_.begin(); - it != chunks_.end(); ++it) - { - assert(*it != NULL); - - size_t s = (*it)->size(); - if (s != 0) - { - memcpy(&result[pos], (*it)->c_str(), s); - pos += s; - } - - delete *it; - } - - chunks_.clear(); - numBytes_ = 0; - } -}
--- a/Orthanc/Core/ChunkedBuffer.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,72 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <list> -#include <string> - -namespace Orthanc -{ - class ChunkedBuffer - { - private: - typedef std::list<std::string*> Chunks; - size_t numBytes_; - Chunks chunks_; - - void Clear(); - - public: - ChunkedBuffer() : numBytes_(0) - { - } - - ~ChunkedBuffer() - { - Clear(); - } - - size_t GetNumBytes() const - { - return numBytes_; - } - - void AddChunk(const void* chunkData, - size_t chunkSize); - - void AddChunk(const std::string& chunk); - - void Flatten(std::string& result); - }; -}
--- a/Orthanc/Core/DicomFormat/DicomMap.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,975 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "DicomMap.h" - -#include <stdio.h> -#include <memory> - -#include "../Endianness.h" -#include "../Logging.h" -#include "../OrthancException.h" - - -namespace Orthanc -{ - static DicomTag patientTags[] = - { - //DicomTag(0x0010, 0x1010), // PatientAge - //DicomTag(0x0010, 0x1040) // PatientAddress - DicomTag(0x0010, 0x0010), // PatientName - DicomTag(0x0010, 0x0030), // PatientBirthDate - DicomTag(0x0010, 0x0040), // PatientSex - DicomTag(0x0010, 0x1000), // OtherPatientIDs - DICOM_TAG_PATIENT_ID - }; - - static DicomTag studyTags[] = - { - //DicomTag(0x0010, 0x1020), // PatientSize - //DicomTag(0x0010, 0x1030) // PatientWeight - DICOM_TAG_STUDY_DATE, - DicomTag(0x0008, 0x0030), // StudyTime - DicomTag(0x0020, 0x0010), // StudyID - DICOM_TAG_STUDY_DESCRIPTION, - DICOM_TAG_ACCESSION_NUMBER, - DICOM_TAG_STUDY_INSTANCE_UID, - DICOM_TAG_REQUESTED_PROCEDURE_DESCRIPTION, // New in db v6 - DICOM_TAG_INSTITUTION_NAME, // New in db v6 - DICOM_TAG_REQUESTING_PHYSICIAN, // New in db v6 - DICOM_TAG_REFERRING_PHYSICIAN_NAME // New in db v6 - }; - - static DicomTag seriesTags[] = - { - //DicomTag(0x0010, 0x1080), // MilitaryRank - DicomTag(0x0008, 0x0021), // SeriesDate - DicomTag(0x0008, 0x0031), // SeriesTime - DICOM_TAG_MODALITY, - DicomTag(0x0008, 0x0070), // Manufacturer - DicomTag(0x0008, 0x1010), // StationName - DICOM_TAG_SERIES_DESCRIPTION, - DicomTag(0x0018, 0x0015), // BodyPartExamined - DicomTag(0x0018, 0x0024), // SequenceName - DicomTag(0x0018, 0x1030), // ProtocolName - DicomTag(0x0020, 0x0011), // SeriesNumber - DICOM_TAG_CARDIAC_NUMBER_OF_IMAGES, - DICOM_TAG_IMAGES_IN_ACQUISITION, - DICOM_TAG_NUMBER_OF_TEMPORAL_POSITIONS, - DICOM_TAG_NUMBER_OF_SLICES, - DICOM_TAG_NUMBER_OF_TIME_SLICES, - DICOM_TAG_SERIES_INSTANCE_UID, - DICOM_TAG_IMAGE_ORIENTATION_PATIENT, // New in db v6 - DICOM_TAG_SERIES_TYPE, // New in db v6 - DICOM_TAG_OPERATOR_NAME, // New in db v6 - DICOM_TAG_PERFORMED_PROCEDURE_STEP_DESCRIPTION, // New in db v6 - DICOM_TAG_ACQUISITION_DEVICE_PROCESSING_DESCRIPTION, // New in db v6 - DICOM_TAG_CONTRAST_BOLUS_AGENT // New in db v6 - }; - - static DicomTag instanceTags[] = - { - DicomTag(0x0008, 0x0012), // InstanceCreationDate - DicomTag(0x0008, 0x0013), // InstanceCreationTime - DicomTag(0x0020, 0x0012), // AcquisitionNumber - DICOM_TAG_IMAGE_INDEX, - DICOM_TAG_INSTANCE_NUMBER, - DICOM_TAG_NUMBER_OF_FRAMES, - DICOM_TAG_TEMPORAL_POSITION_IDENTIFIER, - DICOM_TAG_SOP_INSTANCE_UID, - DICOM_TAG_IMAGE_POSITION_PATIENT, // New in db v6 - DICOM_TAG_IMAGE_COMMENTS // New in db v6 - }; - - - void DicomMap::LoadMainDicomTags(const DicomTag*& tags, - size_t& size, - ResourceType level) - { - switch (level) - { - case ResourceType_Patient: - tags = patientTags; - size = sizeof(patientTags) / sizeof(DicomTag); - break; - - case ResourceType_Study: - tags = studyTags; - size = sizeof(studyTags) / sizeof(DicomTag); - break; - - case ResourceType_Series: - tags = seriesTags; - size = sizeof(seriesTags) / sizeof(DicomTag); - break; - - case ResourceType_Instance: - tags = instanceTags; - size = sizeof(instanceTags) / sizeof(DicomTag); - break; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - void DicomMap::SetValue(uint16_t group, - uint16_t element, - DicomValue* value) - { - DicomTag tag(group, element); - Map::iterator it = map_.find(tag); - - if (it != map_.end()) - { - delete it->second; - it->second = value; - } - else - { - map_.insert(std::make_pair(tag, value)); - } - } - - void DicomMap::SetValue(DicomTag tag, - DicomValue* value) - { - SetValue(tag.GetGroup(), tag.GetElement(), value); - } - - - - - void DicomMap::Clear() - { - for (Map::iterator it = map_.begin(); it != map_.end(); ++it) - { - delete it->second; - } - - map_.clear(); - } - - - void DicomMap::ExtractTags(DicomMap& result, - const DicomTag* tags, - size_t count) const - { - result.Clear(); - - for (unsigned int i = 0; i < count; i++) - { - Map::const_iterator it = map_.find(tags[i]); - if (it != map_.end()) - { - result.SetValue(it->first, it->second->Clone()); - } - } - } - - - void DicomMap::ExtractPatientInformation(DicomMap& result) const - { - ExtractTags(result, patientTags, sizeof(patientTags) / sizeof(DicomTag)); - } - - void DicomMap::ExtractStudyInformation(DicomMap& result) const - { - ExtractTags(result, studyTags, sizeof(studyTags) / sizeof(DicomTag)); - } - - void DicomMap::ExtractSeriesInformation(DicomMap& result) const - { - ExtractTags(result, seriesTags, sizeof(seriesTags) / sizeof(DicomTag)); - } - - void DicomMap::ExtractInstanceInformation(DicomMap& result) const - { - ExtractTags(result, instanceTags, sizeof(instanceTags) / sizeof(DicomTag)); - } - - - - DicomMap* DicomMap::Clone() const - { - std::auto_ptr<DicomMap> result(new DicomMap); - - for (Map::const_iterator it = map_.begin(); it != map_.end(); ++it) - { - result->map_.insert(std::make_pair(it->first, it->second->Clone())); - } - - return result.release(); - } - - - void DicomMap::Assign(const DicomMap& other) - { - Clear(); - - for (Map::const_iterator it = other.map_.begin(); it != other.map_.end(); ++it) - { - map_.insert(std::make_pair(it->first, it->second->Clone())); - } - } - - - const DicomValue& DicomMap::GetValue(const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value) - { - return *value; - } - else - { - throw OrthancException(ErrorCode_InexistentTag); - } - } - - - const DicomValue* DicomMap::TestAndGetValue(const DicomTag& tag) const - { - Map::const_iterator it = map_.find(tag); - - if (it == map_.end()) - { - return NULL; - } - else - { - return it->second; - } - } - - - void DicomMap::Remove(const DicomTag& tag) - { - Map::iterator it = map_.find(tag); - if (it != map_.end()) - { - delete it->second; - map_.erase(it); - } - } - - - static void SetupFindTemplate(DicomMap& result, - const DicomTag* tags, - size_t count) - { - result.Clear(); - - for (size_t i = 0; i < count; i++) - { - result.SetValue(tags[i], "", false); - } - } - - void DicomMap::SetupFindPatientTemplate(DicomMap& result) - { - SetupFindTemplate(result, patientTags, sizeof(patientTags) / sizeof(DicomTag)); - } - - void DicomMap::SetupFindStudyTemplate(DicomMap& result) - { - SetupFindTemplate(result, studyTags, sizeof(studyTags) / sizeof(DicomTag)); - result.SetValue(DICOM_TAG_ACCESSION_NUMBER, "", false); - result.SetValue(DICOM_TAG_PATIENT_ID, "", false); - - // These main DICOM tags are only indirectly related to the - // General Study Module, remove them - result.Remove(DICOM_TAG_INSTITUTION_NAME); - result.Remove(DICOM_TAG_REQUESTING_PHYSICIAN); - result.Remove(DICOM_TAG_REQUESTED_PROCEDURE_DESCRIPTION); - } - - void DicomMap::SetupFindSeriesTemplate(DicomMap& result) - { - SetupFindTemplate(result, seriesTags, sizeof(seriesTags) / sizeof(DicomTag)); - result.SetValue(DICOM_TAG_ACCESSION_NUMBER, "", false); - result.SetValue(DICOM_TAG_PATIENT_ID, "", false); - result.SetValue(DICOM_TAG_STUDY_INSTANCE_UID, "", false); - - // These tags are considered as "main" by Orthanc, but are not in the Series module - result.Remove(DicomTag(0x0008, 0x0070)); // Manufacturer - result.Remove(DicomTag(0x0008, 0x1010)); // Station name - result.Remove(DicomTag(0x0018, 0x0024)); // Sequence name - result.Remove(DICOM_TAG_CARDIAC_NUMBER_OF_IMAGES); - result.Remove(DICOM_TAG_IMAGES_IN_ACQUISITION); - result.Remove(DICOM_TAG_NUMBER_OF_SLICES); - result.Remove(DICOM_TAG_NUMBER_OF_TEMPORAL_POSITIONS); - result.Remove(DICOM_TAG_NUMBER_OF_TIME_SLICES); - result.Remove(DICOM_TAG_IMAGE_ORIENTATION_PATIENT); - result.Remove(DICOM_TAG_SERIES_TYPE); - result.Remove(DICOM_TAG_ACQUISITION_DEVICE_PROCESSING_DESCRIPTION); - result.Remove(DICOM_TAG_CONTRAST_BOLUS_AGENT); - } - - void DicomMap::SetupFindInstanceTemplate(DicomMap& result) - { - SetupFindTemplate(result, instanceTags, sizeof(instanceTags) / sizeof(DicomTag)); - result.SetValue(DICOM_TAG_ACCESSION_NUMBER, "", false); - result.SetValue(DICOM_TAG_PATIENT_ID, "", false); - result.SetValue(DICOM_TAG_STUDY_INSTANCE_UID, "", false); - result.SetValue(DICOM_TAG_SERIES_INSTANCE_UID, "", false); - } - - - void DicomMap::CopyTagIfExists(const DicomMap& source, - const DicomTag& tag) - { - if (source.HasTag(tag)) - { - SetValue(tag, source.GetValue(tag)); - } - } - - - bool DicomMap::IsMainDicomTag(const DicomTag& tag, ResourceType level) - { - DicomTag *tags = NULL; - size_t size; - - switch (level) - { - case ResourceType_Patient: - tags = patientTags; - size = sizeof(patientTags) / sizeof(DicomTag); - break; - - case ResourceType_Study: - tags = studyTags; - size = sizeof(studyTags) / sizeof(DicomTag); - break; - - case ResourceType_Series: - tags = seriesTags; - size = sizeof(seriesTags) / sizeof(DicomTag); - break; - - case ResourceType_Instance: - tags = instanceTags; - size = sizeof(instanceTags) / sizeof(DicomTag); - break; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - for (size_t i = 0; i < size; i++) - { - if (tags[i] == tag) - { - return true; - } - } - - return false; - } - - bool DicomMap::IsMainDicomTag(const DicomTag& tag) - { - return (IsMainDicomTag(tag, ResourceType_Patient) || - IsMainDicomTag(tag, ResourceType_Study) || - IsMainDicomTag(tag, ResourceType_Series) || - IsMainDicomTag(tag, ResourceType_Instance)); - } - - - void DicomMap::GetMainDicomTagsInternal(std::set<DicomTag>& result, ResourceType level) - { - DicomTag *tags = NULL; - size_t size; - - switch (level) - { - case ResourceType_Patient: - tags = patientTags; - size = sizeof(patientTags) / sizeof(DicomTag); - break; - - case ResourceType_Study: - tags = studyTags; - size = sizeof(studyTags) / sizeof(DicomTag); - break; - - case ResourceType_Series: - tags = seriesTags; - size = sizeof(seriesTags) / sizeof(DicomTag); - break; - - case ResourceType_Instance: - tags = instanceTags; - size = sizeof(instanceTags) / sizeof(DicomTag); - break; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - for (size_t i = 0; i < size; i++) - { - result.insert(tags[i]); - } - } - - - void DicomMap::GetMainDicomTags(std::set<DicomTag>& result, ResourceType level) - { - result.clear(); - GetMainDicomTagsInternal(result, level); - } - - - void DicomMap::GetMainDicomTags(std::set<DicomTag>& result) - { - result.clear(); - GetMainDicomTagsInternal(result, ResourceType_Patient); - GetMainDicomTagsInternal(result, ResourceType_Study); - GetMainDicomTagsInternal(result, ResourceType_Series); - GetMainDicomTagsInternal(result, ResourceType_Instance); - } - - - void DicomMap::GetTags(std::set<DicomTag>& tags) const - { - tags.clear(); - - for (Map::const_iterator it = map_.begin(); - it != map_.end(); ++it) - { - tags.insert(it->first); - } - } - - - static uint16_t ReadUnsignedInteger16(const char* dicom) - { - return le16toh(*reinterpret_cast<const uint16_t*>(dicom)); - } - - - static uint32_t ReadUnsignedInteger32(const char* dicom) - { - return le32toh(*reinterpret_cast<const uint32_t*>(dicom)); - } - - - static bool ValidateTag(const ValueRepresentation& vr, - const std::string& value) - { - switch (vr) - { - case ValueRepresentation_ApplicationEntity: - return value.size() <= 16; - - case ValueRepresentation_AgeString: - return (value.size() == 4 && - isdigit(value[0]) && - isdigit(value[1]) && - isdigit(value[2]) && - (value[3] == 'D' || value[3] == 'W' || value[3] == 'M' || value[3] == 'Y')); - - case ValueRepresentation_AttributeTag: - return value.size() == 4; - - case ValueRepresentation_CodeString: - return value.size() <= 16; - - case ValueRepresentation_Date: - return value.size() <= 18; - - case ValueRepresentation_DecimalString: - return value.size() <= 16; - - case ValueRepresentation_DateTime: - return value.size() <= 54; - - case ValueRepresentation_FloatingPointSingle: - return value.size() == 4; - - case ValueRepresentation_FloatingPointDouble: - return value.size() == 8; - - case ValueRepresentation_IntegerString: - return value.size() <= 12; - - case ValueRepresentation_LongString: - return value.size() <= 64; - - case ValueRepresentation_LongText: - return value.size() <= 10240; - - case ValueRepresentation_OtherByte: - return true; - - case ValueRepresentation_OtherDouble: - return value.size() <= (static_cast<uint64_t>(1) << 32) - 8; - - case ValueRepresentation_OtherFloat: - return value.size() <= (static_cast<uint64_t>(1) << 32) - 4; - - case ValueRepresentation_OtherLong: - return true; - - case ValueRepresentation_OtherWord: - return true; - - case ValueRepresentation_PersonName: - return true; - - case ValueRepresentation_ShortString: - return value.size() <= 16; - - case ValueRepresentation_SignedLong: - return value.size() == 4; - - case ValueRepresentation_Sequence: - return true; - - case ValueRepresentation_SignedShort: - return value.size() == 2; - - case ValueRepresentation_ShortText: - return value.size() <= 1024; - - case ValueRepresentation_Time: - return value.size() <= 28; - - case ValueRepresentation_UnlimitedCharacters: - return value.size() <= (static_cast<uint64_t>(1) << 32) - 2; - - case ValueRepresentation_UniqueIdentifier: - return value.size() <= 64; - - case ValueRepresentation_UnsignedLong: - return value.size() == 4; - - case ValueRepresentation_Unknown: - return true; - - case ValueRepresentation_UniversalResource: - return value.size() <= (static_cast<uint64_t>(1) << 32) - 2; - - case ValueRepresentation_UnsignedShort: - return value.size() == 2; - - case ValueRepresentation_UnlimitedText: - return value.size() <= (static_cast<uint64_t>(1) << 32) - 2; - - default: - // Assume unsupported tags are OK - return true; - } - } - - - static void RemoveTagPadding(std::string& value, - const ValueRepresentation& vr) - { - /** - * Remove padding from character strings, if need be. For the time - * being, only the UI VR is supported. - * http://dicom.nema.org/medical/dicom/current/output/chtml/part05/sect_6.2.html - **/ - - switch (vr) - { - case ValueRepresentation_UniqueIdentifier: - { - /** - * "Values with a VR of UI shall be padded with a single - * trailing NULL (00H) character when necessary to achieve even - * length." - **/ - - if (!value.empty() && - value[value.size() - 1] == '\0') - { - value.resize(value.size() - 1); - } - - break; - } - - /** - * TODO implement other VR - **/ - - default: - // No padding is applicable to this VR - break; - } - } - - - static bool ReadNextTag(DicomTag& tag, - ValueRepresentation& vr, - std::string& value, - const char* dicom, - size_t size, - size_t& position) - { - /** - * http://dicom.nema.org/medical/dicom/current/output/chtml/part05/chapter_7.html#sect_7.1.2 - * This function reads a data element with Explicit VR encoded using Little-Endian. - **/ - - if (position + 6 > size) - { - return false; - } - - tag = DicomTag(ReadUnsignedInteger16(dicom + position), - ReadUnsignedInteger16(dicom + position + 2)); - - vr = StringToValueRepresentation(std::string(dicom + position + 4, 2), true); - if (vr == ValueRepresentation_NotSupported) - { - return false; - } - - if (vr == ValueRepresentation_OtherByte || - vr == ValueRepresentation_OtherDouble || - vr == ValueRepresentation_OtherFloat || - vr == ValueRepresentation_OtherLong || - vr == ValueRepresentation_OtherWord || - vr == ValueRepresentation_Sequence || - vr == ValueRepresentation_UnlimitedCharacters || - vr == ValueRepresentation_UniversalResource || - vr == ValueRepresentation_UnlimitedText || - vr == ValueRepresentation_Unknown) // Note that "UN" should never appear in the Meta Information - { - if (position + 12 > size) - { - return false; - } - - uint32_t length = ReadUnsignedInteger32(dicom + position + 8); - - if (position + 12 + length > size) - { - return false; - } - - value.assign(dicom + position + 12, length); - position += (12 + length); - } - else - { - if (position + 8 > size) - { - return false; - } - - uint16_t length = ReadUnsignedInteger16(dicom + position + 6); - - if (position + 8 + length > size) - { - return false; - } - - value.assign(dicom + position + 8, length); - position += (8 + length); - } - - if (!ValidateTag(vr, value)) - { - return false; - } - - RemoveTagPadding(value, vr); - - return true; - } - - - bool DicomMap::ParseDicomMetaInformation(DicomMap& result, - const char* dicom, - size_t size) - { - /** - * http://dicom.nema.org/medical/dicom/current/output/chtml/part10/chapter_7.html - * According to Table 7.1-1, besides the "DICM" DICOM prefix, the - * file preamble (i.e. dicom[0..127]) should not be taken into - * account to determine whether the file is or is not a DICOM file. - **/ - - if (size < 132 || - dicom[128] != 'D' || - dicom[129] != 'I' || - dicom[130] != 'C' || - dicom[131] != 'M') - { - return false; - } - - - /** - * The DICOM File Meta Information must be encoded using the - * Explicit VR Little Endian Transfer Syntax - * (UID=1.2.840.10008.1.2.1). - **/ - - result.Clear(); - - // First, we read the "File Meta Information Group Length" tag - // (0002,0000) to know where to stop reading the meta header - size_t position = 132; - - DicomTag tag(0x0000, 0x0000); // Dummy initialization - ValueRepresentation vr; - std::string value; - if (!ReadNextTag(tag, vr, value, dicom, size, position) || - tag.GetGroup() != 0x0002 || - tag.GetElement() != 0x0000 || - vr != ValueRepresentation_UnsignedLong || - value.size() != 4) - { - return false; - } - - size_t stopPosition = position + ReadUnsignedInteger32(value.c_str()); - if (stopPosition > size) - { - return false; - } - - while (position < stopPosition) - { - if (ReadNextTag(tag, vr, value, dicom, size, position)) - { - result.SetValue(tag, value, IsBinaryValueRepresentation(vr)); - } - else - { - return false; - } - } - - return true; - } - - - static std::string ValueAsString(const DicomMap& summary, - const DicomTag& tag) - { - const DicomValue& value = summary.GetValue(tag); - if (value.IsNull()) - { - return "(null)"; - } - else - { - return value.GetContent(); - } - } - - - void DicomMap::LogMissingTagsForStore() const - { - std::string s, t; - - if (HasTag(DICOM_TAG_PATIENT_ID)) - { - if (t.size() > 0) - t += ", "; - t += "PatientID=" + ValueAsString(*this, DICOM_TAG_PATIENT_ID); - } - else - { - if (s.size() > 0) - s += ", "; - s += "PatientID"; - } - - if (HasTag(DICOM_TAG_STUDY_INSTANCE_UID)) - { - if (t.size() > 0) - t += ", "; - t += "StudyInstanceUID=" + ValueAsString(*this, DICOM_TAG_STUDY_INSTANCE_UID); - } - else - { - if (s.size() > 0) - s += ", "; - s += "StudyInstanceUID"; - } - - if (HasTag(DICOM_TAG_SERIES_INSTANCE_UID)) - { - if (t.size() > 0) - t += ", "; - t += "SeriesInstanceUID=" + ValueAsString(*this, DICOM_TAG_SERIES_INSTANCE_UID); - } - else - { - if (s.size() > 0) - s += ", "; - s += "SeriesInstanceUID"; - } - - if (HasTag(DICOM_TAG_SOP_INSTANCE_UID)) - { - if (t.size() > 0) - t += ", "; - t += "SOPInstanceUID=" + ValueAsString(*this, DICOM_TAG_SOP_INSTANCE_UID); - } - else - { - if (s.size() > 0) - s += ", "; - s += "SOPInstanceUID"; - } - - if (t.size() == 0) - { - LOG(ERROR) << "Store has failed because all the required tags (" << s << ") are missing (is it a DICOMDIR file?)"; - } - else - { - LOG(ERROR) << "Store has failed because required tags (" << s << ") are missing for the following instance: " << t; - } - } - - - bool DicomMap::CopyToString(std::string& result, - const DicomTag& tag, - bool allowBinary) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->CopyToString(result, allowBinary); - } - } - - bool DicomMap::ParseInteger32(int32_t& result, - const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->ParseInteger32(result); - } - } - - bool DicomMap::ParseInteger64(int64_t& result, - const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->ParseInteger64(result); - } - } - - bool DicomMap::ParseUnsignedInteger32(uint32_t& result, - const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->ParseUnsignedInteger32(result); - } - } - - bool DicomMap::ParseUnsignedInteger64(uint64_t& result, - const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->ParseUnsignedInteger64(result); - } - } - - bool DicomMap::ParseFloat(float& result, - const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->ParseFloat(result); - } - } - - bool DicomMap::ParseDouble(double& result, - const DicomTag& tag) const - { - const DicomValue* value = TestAndGetValue(tag); - - if (value == NULL) - { - return false; - } - else - { - return value->ParseDouble(result); - } - } -}
--- a/Orthanc/Core/DicomFormat/DicomMap.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,209 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "DicomTag.h" -#include "DicomValue.h" -#include "../Enumerations.h" - -#include <set> -#include <map> -#include <json/json.h> - -namespace Orthanc -{ - class DicomMap : public boost::noncopyable - { - private: - friend class DicomArray; - friend class FromDcmtkBridge; - friend class ParsedDicomFile; - - typedef std::map<DicomTag, DicomValue*> Map; - - Map map_; - - // Warning: This takes the ownership of "value" - void SetValue(uint16_t group, - uint16_t element, - DicomValue* value); - - void SetValue(DicomTag tag, - DicomValue* value); - - void ExtractTags(DicomMap& source, - const DicomTag* tags, - size_t count) const; - - static void GetMainDicomTagsInternal(std::set<DicomTag>& result, ResourceType level); - - public: - DicomMap() - { - } - - ~DicomMap() - { - Clear(); - } - - size_t GetSize() const - { - return map_.size(); - } - - DicomMap* Clone() const; - - void Assign(const DicomMap& other); - - void Clear(); - - void SetValue(uint16_t group, - uint16_t element, - const DicomValue& value) - { - SetValue(group, element, value.Clone()); - } - - void SetValue(const DicomTag& tag, - const DicomValue& value) - { - SetValue(tag, value.Clone()); - } - - void SetValue(const DicomTag& tag, - const std::string& str, - bool isBinary) - { - SetValue(tag, new DicomValue(str, isBinary)); - } - - void SetValue(uint16_t group, - uint16_t element, - const std::string& str, - bool isBinary) - { - SetValue(group, element, new DicomValue(str, isBinary)); - } - - bool HasTag(uint16_t group, uint16_t element) const - { - return HasTag(DicomTag(group, element)); - } - - bool HasTag(const DicomTag& tag) const - { - return map_.find(tag) != map_.end(); - } - - const DicomValue& GetValue(uint16_t group, uint16_t element) const - { - return GetValue(DicomTag(group, element)); - } - - const DicomValue& GetValue(const DicomTag& tag) const; - - // DO NOT delete the returned value! - const DicomValue* TestAndGetValue(uint16_t group, uint16_t element) const - { - return TestAndGetValue(DicomTag(group, element)); - } - - // DO NOT delete the returned value! - const DicomValue* TestAndGetValue(const DicomTag& tag) const; - - void Remove(const DicomTag& tag); - - void ExtractPatientInformation(DicomMap& result) const; - - void ExtractStudyInformation(DicomMap& result) const; - - void ExtractSeriesInformation(DicomMap& result) const; - - void ExtractInstanceInformation(DicomMap& result) const; - - static void SetupFindPatientTemplate(DicomMap& result); - - static void SetupFindStudyTemplate(DicomMap& result); - - static void SetupFindSeriesTemplate(DicomMap& result); - - static void SetupFindInstanceTemplate(DicomMap& result); - - void CopyTagIfExists(const DicomMap& source, - const DicomTag& tag); - - static bool IsMainDicomTag(const DicomTag& tag, ResourceType level); - - static bool IsMainDicomTag(const DicomTag& tag); - - static void GetMainDicomTags(std::set<DicomTag>& result, ResourceType level); - - static void GetMainDicomTags(std::set<DicomTag>& result); - - void GetTags(std::set<DicomTag>& tags) const; - - static void LoadMainDicomTags(const DicomTag*& tags, - size_t& size, - ResourceType level); - - static bool ParseDicomMetaInformation(DicomMap& result, - const char* dicom, - size_t size); - - void LogMissingTagsForStore() const; - - bool CopyToString(std::string& result, - const DicomTag& tag, - bool allowBinary) const; - - bool ParseInteger32(int32_t& result, - const DicomTag& tag) const; - - bool ParseInteger64(int64_t& result, - const DicomTag& tag) const; - - bool ParseUnsignedInteger32(uint32_t& result, - const DicomTag& tag) const; - - bool ParseUnsignedInteger64(uint64_t& result, - const DicomTag& tag) const; - - bool ParseFloat(float& result, - const DicomTag& tag) const; - - bool ParseDouble(double& result, - const DicomTag& tag) const; - }; -}
--- a/Orthanc/Core/DicomFormat/DicomTag.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,253 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "DicomTag.h" - -#include "../OrthancException.h" - -#include <iostream> -#include <iomanip> -#include <stdio.h> - -namespace Orthanc -{ - bool DicomTag::operator< (const DicomTag& other) const - { - if (group_ < other.group_) - return true; - - if (group_ > other.group_) - return false; - - return element_ < other.element_; - } - - - std::ostream& operator<< (std::ostream& o, const DicomTag& tag) - { - using namespace std; - ios_base::fmtflags state = o.flags(); - o.flags(ios::right | ios::hex); - o << "(" << setfill('0') << setw(4) << tag.GetGroup() - << "," << setw(4) << tag.GetElement() << ")"; - o.flags(state); - return o; - } - - - std::string DicomTag::Format() const - { - char b[16]; - sprintf(b, "%04x,%04x", group_, element_); - return std::string(b); - } - - - const char* DicomTag::GetMainTagsName() const - { - if (*this == DICOM_TAG_ACCESSION_NUMBER) - return "AccessionNumber"; - - if (*this == DICOM_TAG_SOP_INSTANCE_UID) - return "SOPInstanceUID"; - - if (*this == DICOM_TAG_PATIENT_ID) - return "PatientID"; - - if (*this == DICOM_TAG_SERIES_INSTANCE_UID) - return "SeriesInstanceUID"; - - if (*this == DICOM_TAG_STUDY_INSTANCE_UID) - return "StudyInstanceUID"; - - if (*this == DICOM_TAG_PIXEL_DATA) - return "PixelData"; - - if (*this == DICOM_TAG_IMAGE_INDEX) - return "ImageIndex"; - - if (*this == DICOM_TAG_INSTANCE_NUMBER) - return "InstanceNumber"; - - if (*this == DICOM_TAG_NUMBER_OF_SLICES) - return "NumberOfSlices"; - - if (*this == DICOM_TAG_NUMBER_OF_FRAMES) - return "NumberOfFrames"; - - if (*this == DICOM_TAG_CARDIAC_NUMBER_OF_IMAGES) - return "CardiacNumberOfImages"; - - if (*this == DICOM_TAG_IMAGES_IN_ACQUISITION) - return "ImagesInAcquisition"; - - if (*this == DICOM_TAG_PATIENT_NAME) - return "PatientName"; - - if (*this == DICOM_TAG_IMAGE_POSITION_PATIENT) - return "ImagePositionPatient"; - - if (*this == DICOM_TAG_IMAGE_ORIENTATION_PATIENT) - return "ImageOrientationPatient"; - - return ""; - } - - - void DicomTag::AddTagsForModule(std::set<DicomTag>& target, - DicomModule module) - { - // REFERENCE: 11_03pu.pdf, DICOM PS 3.3 2011 - Information Object Definitions - - switch (module) - { - case DicomModule_Patient: - // This is Table C.7-1 "Patient Module Attributes" (p. 373) - target.insert(DicomTag(0x0010, 0x0010)); // Patient's name - target.insert(DicomTag(0x0010, 0x0020)); // Patient ID - target.insert(DicomTag(0x0010, 0x0030)); // Patient's birth date - target.insert(DicomTag(0x0010, 0x0040)); // Patient's sex - target.insert(DicomTag(0x0008, 0x1120)); // Referenced patient sequence - target.insert(DicomTag(0x0010, 0x0032)); // Patient's birth time - target.insert(DicomTag(0x0010, 0x1000)); // Other patient IDs - target.insert(DicomTag(0x0010, 0x1002)); // Other patient IDs sequence - target.insert(DicomTag(0x0010, 0x1001)); // Other patient names - target.insert(DicomTag(0x0010, 0x2160)); // Ethnic group - target.insert(DicomTag(0x0010, 0x4000)); // Patient comments - target.insert(DicomTag(0x0010, 0x2201)); // Patient species description - target.insert(DicomTag(0x0010, 0x2202)); // Patient species code sequence - target.insert(DicomTag(0x0010, 0x2292)); // Patient breed description - target.insert(DicomTag(0x0010, 0x2293)); // Patient breed code sequence - target.insert(DicomTag(0x0010, 0x2294)); // Breed registration sequence - target.insert(DicomTag(0x0010, 0x2297)); // Responsible person - target.insert(DicomTag(0x0010, 0x2298)); // Responsible person role - target.insert(DicomTag(0x0010, 0x2299)); // Responsible organization - target.insert(DicomTag(0x0012, 0x0062)); // Patient identity removed - target.insert(DicomTag(0x0012, 0x0063)); // De-identification method - target.insert(DicomTag(0x0012, 0x0064)); // De-identification method code sequence - - // Table 10-18 ISSUER OF PATIENT ID MACRO (p. 112) - target.insert(DicomTag(0x0010, 0x0021)); // Issuer of Patient ID - target.insert(DicomTag(0x0010, 0x0024)); // Issuer of Patient ID qualifiers sequence - break; - - case DicomModule_Study: - // This is Table C.7-3 "General Study Module Attributes" (p. 378) - target.insert(DicomTag(0x0020, 0x000d)); // Study instance UID - target.insert(DicomTag(0x0008, 0x0020)); // Study date - target.insert(DicomTag(0x0008, 0x0030)); // Study time - target.insert(DicomTag(0x0008, 0x0090)); // Referring physician's name - target.insert(DicomTag(0x0008, 0x0096)); // Referring physician identification sequence - target.insert(DicomTag(0x0020, 0x0010)); // Study ID - target.insert(DicomTag(0x0008, 0x0050)); // Accession number - target.insert(DicomTag(0x0008, 0x0051)); // Issuer of accession number sequence - target.insert(DicomTag(0x0008, 0x1030)); // Study description - target.insert(DicomTag(0x0008, 0x1048)); // Physician(s) of record - target.insert(DicomTag(0x0008, 0x1049)); // Physician(s) of record identification sequence - target.insert(DicomTag(0x0008, 0x1060)); // Name of physician(s) reading study - target.insert(DicomTag(0x0008, 0x1062)); // Physician(s) reading study identification sequence - target.insert(DicomTag(0x0032, 0x1034)); // Requesting service code sequence - target.insert(DicomTag(0x0008, 0x1110)); // Referenced study sequence - target.insert(DicomTag(0x0008, 0x1032)); // Procedure code sequence - target.insert(DicomTag(0x0040, 0x1012)); // Reason for performed procedure code sequence - break; - - case DicomModule_Series: - // This is Table C.7-5 "General Series Module Attributes" (p. 385) - target.insert(DicomTag(0x0008, 0x0060)); // Modality - target.insert(DicomTag(0x0020, 0x000e)); // Series Instance UID - target.insert(DicomTag(0x0020, 0x0011)); // Series Number - target.insert(DicomTag(0x0020, 0x0060)); // Laterality - target.insert(DicomTag(0x0008, 0x0021)); // Series Date - target.insert(DicomTag(0x0008, 0x0031)); // Series Time - target.insert(DicomTag(0x0008, 0x1050)); // Performing Physicians’ Name - target.insert(DicomTag(0x0008, 0x1052)); // Performing Physician Identification Sequence - target.insert(DicomTag(0x0018, 0x1030)); // Protocol Name - target.insert(DicomTag(0x0008, 0x103e)); // Series Description - target.insert(DicomTag(0x0008, 0x103f)); // Series Description Code Sequence - target.insert(DicomTag(0x0008, 0x1070)); // Operators' Name - target.insert(DicomTag(0x0008, 0x1072)); // Operator Identification Sequence - target.insert(DicomTag(0x0008, 0x1111)); // Referenced Performed Procedure Step Sequence - target.insert(DicomTag(0x0008, 0x1250)); // Related Series Sequence - target.insert(DicomTag(0x0018, 0x0015)); // Body Part Examined - target.insert(DicomTag(0x0018, 0x5100)); // Patient Position - target.insert(DicomTag(0x0028, 0x0108)); // Smallest Pixel Value in Series - target.insert(DicomTag(0x0029, 0x0109)); // Largest Pixel Value in Series - target.insert(DicomTag(0x0040, 0x0275)); // Request Attributes Sequence - target.insert(DicomTag(0x0010, 0x2210)); // Anatomical Orientation Type - - // Table 10-16 PERFORMED PROCEDURE STEP SUMMARY MACRO ATTRIBUTES - target.insert(DicomTag(0x0040, 0x0253)); // Performed Procedure Step ID - target.insert(DicomTag(0x0040, 0x0244)); // Performed Procedure Step Start Date - target.insert(DicomTag(0x0040, 0x0245)); // Performed Procedure Step Start Time - target.insert(DicomTag(0x0040, 0x0254)); // Performed Procedure Step Description - target.insert(DicomTag(0x0040, 0x0260)); // Performed Protocol Code Sequence - target.insert(DicomTag(0x0040, 0x0280)); // Comments on the Performed Procedure Step - break; - - case DicomModule_Instance: - // This is Table C.12-1 "SOP Common Module Attributes" (p. 1207) - target.insert(DicomTag(0x0008, 0x0016)); // SOP Class UID - target.insert(DicomTag(0x0008, 0x0018)); // SOP Instance UID - target.insert(DicomTag(0x0008, 0x0005)); // Specific Character Set - target.insert(DicomTag(0x0008, 0x0012)); // Instance Creation Date - target.insert(DicomTag(0x0008, 0x0013)); // Instance Creation Time - target.insert(DicomTag(0x0008, 0x0014)); // Instance Creator UID - target.insert(DicomTag(0x0008, 0x001a)); // Related General SOP Class UID - target.insert(DicomTag(0x0008, 0x001b)); // Original Specialized SOP Class UID - target.insert(DicomTag(0x0008, 0x0110)); // Coding Scheme Identification Sequence - target.insert(DicomTag(0x0008, 0x0201)); // Timezone Offset From UTC - target.insert(DicomTag(0x0018, 0xa001)); // Contributing Equipment Sequence - target.insert(DicomTag(0x0020, 0x0013)); // Instance Number - target.insert(DicomTag(0x0100, 0x0410)); // SOP Instance Status - target.insert(DicomTag(0x0100, 0x0420)); // SOP Authorization DateTime - target.insert(DicomTag(0x0100, 0x0424)); // SOP Authorization Comment - target.insert(DicomTag(0x0100, 0x0426)); // Authorization Equipment Certification Number - target.insert(DicomTag(0x0400, 0x0500)); // Encrypted Attributes Sequence - target.insert(DicomTag(0x0400, 0x0561)); // Original Attributes Sequence - target.insert(DicomTag(0x0040, 0xa390)); // HL7 Structured Document Reference Sequence - target.insert(DicomTag(0x0028, 0x0303)); // Longitudinal Temporal Information Modified - - // Table C.12-6 "DIGITAL SIGNATURES MACRO ATTRIBUTES" (p. 1216) - target.insert(DicomTag(0x4ffe, 0x0001)); // MAC Parameters sequence - target.insert(DicomTag(0xfffa, 0xfffa)); // Digital signatures sequence - break; - - // TODO IMAGE MODULE? - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } -}
--- a/Orthanc/Core/DicomFormat/DicomTag.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,206 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <string> -#include <set> -#include <stdint.h> - -#include "../Enumerations.h" - -namespace Orthanc -{ - class DicomTag - { - // This must stay a POD (plain old data structure) - - private: - uint16_t group_; - uint16_t element_; - - public: - DicomTag(uint16_t group, - uint16_t element) : - group_(group), - element_(element) - { - } - - uint16_t GetGroup() const - { - return group_; - } - - uint16_t GetElement() const - { - return element_; - } - - bool IsPrivate() const - { - return group_ % 2 == 1; - } - - const char* GetMainTagsName() const; - - bool operator< (const DicomTag& other) const; - - bool operator== (const DicomTag& other) const - { - return group_ == other.group_ && element_ == other.element_; - } - - bool operator!= (const DicomTag& other) const - { - return !(*this == other); - } - - std::string Format() const; - - friend std::ostream& operator<< (std::ostream& o, const DicomTag& tag); - - static void AddTagsForModule(std::set<DicomTag>& target, - DicomModule module); - }; - - // Aliases for the most useful tags - static const DicomTag DICOM_TAG_ACCESSION_NUMBER(0x0008, 0x0050); - static const DicomTag DICOM_TAG_SOP_INSTANCE_UID(0x0008, 0x0018); - static const DicomTag DICOM_TAG_PATIENT_ID(0x0010, 0x0020); - static const DicomTag DICOM_TAG_SERIES_INSTANCE_UID(0x0020, 0x000e); - static const DicomTag DICOM_TAG_STUDY_INSTANCE_UID(0x0020, 0x000d); - static const DicomTag DICOM_TAG_PIXEL_DATA(0x7fe0, 0x0010); - static const DicomTag DICOM_TAG_TRANSFER_SYNTAX_UID(0x0002, 0x0010); - - static const DicomTag DICOM_TAG_IMAGE_INDEX(0x0054, 0x1330); - static const DicomTag DICOM_TAG_INSTANCE_NUMBER(0x0020, 0x0013); - - static const DicomTag DICOM_TAG_NUMBER_OF_SLICES(0x0054, 0x0081); - static const DicomTag DICOM_TAG_NUMBER_OF_TIME_SLICES(0x0054, 0x0101); - static const DicomTag DICOM_TAG_NUMBER_OF_FRAMES(0x0028, 0x0008); - static const DicomTag DICOM_TAG_CARDIAC_NUMBER_OF_IMAGES(0x0018, 0x1090); - static const DicomTag DICOM_TAG_IMAGES_IN_ACQUISITION(0x0020, 0x1002); - static const DicomTag DICOM_TAG_PATIENT_NAME(0x0010, 0x0010); - static const DicomTag DICOM_TAG_ENCAPSULATED_DOCUMENT(0x0042, 0x0011); - - static const DicomTag DICOM_TAG_STUDY_DESCRIPTION(0x0008, 0x1030); - static const DicomTag DICOM_TAG_SERIES_DESCRIPTION(0x0008, 0x103e); - static const DicomTag DICOM_TAG_MODALITY(0x0008, 0x0060); - - // The following is used for "modify/anonymize" operations - static const DicomTag DICOM_TAG_SOP_CLASS_UID(0x0008, 0x0016); - static const DicomTag DICOM_TAG_MEDIA_STORAGE_SOP_CLASS_UID(0x0002, 0x0002); - static const DicomTag DICOM_TAG_MEDIA_STORAGE_SOP_INSTANCE_UID(0x0002, 0x0003); - static const DicomTag DICOM_TAG_DEIDENTIFICATION_METHOD(0x0012, 0x0063); - - // DICOM tags used for fMRI (thanks to Will Ryder) - static const DicomTag DICOM_TAG_NUMBER_OF_TEMPORAL_POSITIONS(0x0020, 0x0105); - static const DicomTag DICOM_TAG_TEMPORAL_POSITION_IDENTIFIER(0x0020, 0x0100); - - // Tags for C-FIND and C-MOVE - static const DicomTag DICOM_TAG_MESSAGE_ID(0x0000, 0x0110); - static const DicomTag DICOM_TAG_SPECIFIC_CHARACTER_SET(0x0008, 0x0005); - static const DicomTag DICOM_TAG_QUERY_RETRIEVE_LEVEL(0x0008, 0x0052); - static const DicomTag DICOM_TAG_MODALITIES_IN_STUDY(0x0008, 0x0061); - - // Tags for images - static const DicomTag DICOM_TAG_COLUMNS(0x0028, 0x0011); - static const DicomTag DICOM_TAG_ROWS(0x0028, 0x0010); - static const DicomTag DICOM_TAG_SAMPLES_PER_PIXEL(0x0028, 0x0002); - static const DicomTag DICOM_TAG_BITS_ALLOCATED(0x0028, 0x0100); - static const DicomTag DICOM_TAG_BITS_STORED(0x0028, 0x0101); - static const DicomTag DICOM_TAG_HIGH_BIT(0x0028, 0x0102); - static const DicomTag DICOM_TAG_PIXEL_REPRESENTATION(0x0028, 0x0103); - static const DicomTag DICOM_TAG_PLANAR_CONFIGURATION(0x0028, 0x0006); - static const DicomTag DICOM_TAG_PHOTOMETRIC_INTERPRETATION(0x0028, 0x0004); - static const DicomTag DICOM_TAG_IMAGE_ORIENTATION_PATIENT(0x0020, 0x0037); - static const DicomTag DICOM_TAG_IMAGE_POSITION_PATIENT(0x0020, 0x0032); - - // Tags related to date and time - static const DicomTag DICOM_TAG_ACQUISITION_DATE(0x0008, 0x0022); - static const DicomTag DICOM_TAG_ACQUISITION_TIME(0x0008, 0x0032); - static const DicomTag DICOM_TAG_CONTENT_DATE(0x0008, 0x0023); - static const DicomTag DICOM_TAG_CONTENT_TIME(0x0008, 0x0033); - static const DicomTag DICOM_TAG_INSTANCE_CREATION_DATE(0x0008, 0x0012); - static const DicomTag DICOM_TAG_INSTANCE_CREATION_TIME(0x0008, 0x0013); - static const DicomTag DICOM_TAG_PATIENT_BIRTH_DATE(0x0010, 0x0030); - static const DicomTag DICOM_TAG_PATIENT_BIRTH_TIME(0x0010, 0x0032); - static const DicomTag DICOM_TAG_SERIES_DATE(0x0008, 0x0021); - static const DicomTag DICOM_TAG_SERIES_TIME(0x0008, 0x0031); - static const DicomTag DICOM_TAG_STUDY_DATE(0x0008, 0x0020); - static const DicomTag DICOM_TAG_STUDY_TIME(0x0008, 0x0030); - - // Various tags - static const DicomTag DICOM_TAG_SERIES_TYPE(0x0054, 0x1000); - static const DicomTag DICOM_TAG_REQUESTED_PROCEDURE_DESCRIPTION(0x0032, 0x1060); - static const DicomTag DICOM_TAG_INSTITUTION_NAME(0x0008, 0x0080); - static const DicomTag DICOM_TAG_REQUESTING_PHYSICIAN(0x0032, 0x1032); - static const DicomTag DICOM_TAG_REFERRING_PHYSICIAN_NAME(0x0008, 0x0090); - static const DicomTag DICOM_TAG_OPERATOR_NAME(0x0008, 0x1070); - static const DicomTag DICOM_TAG_PERFORMED_PROCEDURE_STEP_DESCRIPTION(0x0040, 0x0254); - static const DicomTag DICOM_TAG_IMAGE_COMMENTS(0x0020, 0x4000); - static const DicomTag DICOM_TAG_ACQUISITION_DEVICE_PROCESSING_DESCRIPTION(0x0018, 0x1400); - static const DicomTag DICOM_TAG_CONTRAST_BOLUS_AGENT(0x0018, 0x0010); - - // Tags used within the Stone of Orthanc - static const DicomTag DICOM_TAG_FRAME_INCREMENT_POINTER(0x0028, 0x0009); - static const DicomTag DICOM_TAG_GRID_FRAME_OFFSET_VECTOR(0x3004, 0x000c); - static const DicomTag DICOM_TAG_PIXEL_SPACING(0x0028, 0x0030); - static const DicomTag DICOM_TAG_RESCALE_INTERCEPT(0x0028, 0x1052); - static const DicomTag DICOM_TAG_RESCALE_SLOPE(0x0028, 0x1053); - static const DicomTag DICOM_TAG_SLICE_THICKNESS(0x0018, 0x0050); - static const DicomTag DICOM_TAG_WINDOW_CENTER(0x0028, 0x1050); - static const DicomTag DICOM_TAG_WINDOW_WIDTH(0x0028, 0x1051); - static const DicomTag DICOM_TAG_DOSE_GRID_SCALING(0x3004, 0x000e); - - // Counting patients, studies and series - // https://www.medicalconnections.co.uk/kb/Counting_Studies_Series_and_Instances - static const DicomTag DICOM_TAG_NUMBER_OF_PATIENT_RELATED_STUDIES(0x0020, 0x1200); - static const DicomTag DICOM_TAG_NUMBER_OF_PATIENT_RELATED_SERIES(0x0020, 0x1202); - static const DicomTag DICOM_TAG_NUMBER_OF_PATIENT_RELATED_INSTANCES(0x0020, 0x1204); - static const DicomTag DICOM_TAG_NUMBER_OF_STUDY_RELATED_SERIES(0x0020, 0x1206); - static const DicomTag DICOM_TAG_NUMBER_OF_STUDY_RELATED_INSTANCES(0x0020, 0x1208); - static const DicomTag DICOM_TAG_NUMBER_OF_SERIES_RELATED_INSTANCES(0x0020, 0x1209); - static const DicomTag DICOM_TAG_SOP_CLASSES_IN_STUDY(0x0008, 0x0062); - - // Tags to preserve relationships during anonymization - static const DicomTag DICOM_TAG_REFERENCED_IMAGE_SEQUENCE(0x0008, 0x1140); - static const DicomTag DICOM_TAG_REFERENCED_SOP_INSTANCE_UID(0x0008, 0x1155); - static const DicomTag DICOM_TAG_SOURCE_IMAGE_SEQUENCE(0x0008, 0x2112); - static const DicomTag DICOM_TAG_FRAME_OF_REFERENCE_UID(0x0020, 0x0052); - static const DicomTag DICOM_TAG_REFERENCED_FRAME_OF_REFERENCE_UID(0x3006, 0x0024); - static const DicomTag DICOM_TAG_RELATED_FRAME_OF_REFERENCE_UID(0x3006, 0x00c2); - static const DicomTag DICOM_TAG_CURRENT_REQUESTED_PROCEDURE_EVIDENCE_SEQUENCE(0x0040, 0xa375); - static const DicomTag DICOM_TAG_REFERENCED_SERIES_SEQUENCE(0x0008, 0x1115); -}
--- a/Orthanc/Core/DicomFormat/DicomValue.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,196 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "DicomValue.h" - -#include "../OrthancException.h" -#include "../Toolbox.h" - -#include <boost/lexical_cast.hpp> - -namespace Orthanc -{ - DicomValue::DicomValue(const DicomValue& other) : - type_(other.type_), - content_(other.content_) - { - } - - - DicomValue::DicomValue(const std::string& content, - bool isBinary) : - type_(isBinary ? Type_Binary : Type_String), - content_(content) - { - } - - - DicomValue::DicomValue(const char* data, - size_t size, - bool isBinary) : - type_(isBinary ? Type_Binary : Type_String) - { - content_.assign(data, size); - } - - - const std::string& DicomValue::GetContent() const - { - if (type_ == Type_Null) - { - throw OrthancException(ErrorCode_BadParameterType); - } - else - { - return content_; - } - } - - - DicomValue* DicomValue::Clone() const - { - return new DicomValue(*this); - } - - -#if ORTHANC_ENABLE_BASE64 == 1 - void DicomValue::FormatDataUriScheme(std::string& target, - const std::string& mime) const - { - Toolbox::EncodeBase64(target, GetContent()); - target.insert(0, "data:" + mime + ";base64,"); - } -#endif - - - template <typename T, - bool allowSigned> - static bool ParseValue(T& result, - const DicomValue& source) - { - if (source.IsBinary() || - source.IsNull()) - { - return false; - } - - try - { - std::string value = Toolbox::StripSpaces(source.GetContent()); - if (value.empty()) - { - return false; - } - - if (!allowSigned && - value[0] == '-') - { - return false; - } - - result = boost::lexical_cast<T>(value); - return true; - } - catch (boost::bad_lexical_cast&) - { - return false; - } - } - - bool DicomValue::ParseInteger32(int32_t& result) const - { - int64_t tmp; - if (ParseValue<int64_t, true>(tmp, *this)) - { - result = static_cast<int32_t>(tmp); - return (tmp == static_cast<int64_t>(result)); // Check no overflow occurs - } - else - { - return false; - } - } - - bool DicomValue::ParseInteger64(int64_t& result) const - { - return ParseValue<int64_t, true>(result, *this); - } - - bool DicomValue::ParseUnsignedInteger32(uint32_t& result) const - { - uint64_t tmp; - if (ParseValue<uint64_t, false>(tmp, *this)) - { - result = static_cast<uint32_t>(tmp); - return (tmp == static_cast<uint64_t>(result)); // Check no overflow occurs - } - else - { - return false; - } - } - - bool DicomValue::ParseUnsignedInteger64(uint64_t& result) const - { - return ParseValue<uint64_t, false>(result, *this); - } - - bool DicomValue::ParseFloat(float& result) const - { - return ParseValue<float, true>(result, *this); - } - - bool DicomValue::ParseDouble(double& result) const - { - return ParseValue<double, true>(result, *this); - } - - bool DicomValue::CopyToString(std::string& result, - bool allowBinary) const - { - if (IsNull()) - { - return false; - } - else if (IsBinary() && !allowBinary) - { - return false; - } - else - { - result.assign(content_); - return true; - } - } -}
--- a/Orthanc/Core/DicomFormat/DicomValue.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,113 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <stdint.h> -#include <string> -#include <boost/noncopyable.hpp> - -#if !defined(ORTHANC_ENABLE_BASE64) -# error The macro ORTHANC_ENABLE_BASE64 must be defined -#endif - - -namespace Orthanc -{ - class DicomValue : public boost::noncopyable - { - private: - enum Type - { - Type_Null, - Type_String, - Type_Binary - }; - - Type type_; - std::string content_; - - DicomValue(const DicomValue& other); - - public: - DicomValue() : type_(Type_Null) - { - } - - DicomValue(const std::string& content, - bool isBinary); - - DicomValue(const char* data, - size_t size, - bool isBinary); - - const std::string& GetContent() const; - - bool IsNull() const - { - return type_ == Type_Null; - } - - bool IsBinary() const - { - return type_ == Type_Binary; - } - - DicomValue* Clone() const; - -#if ORTHANC_ENABLE_BASE64 == 1 - void FormatDataUriScheme(std::string& target, - const std::string& mime) const; - - void FormatDataUriScheme(std::string& target) const - { - FormatDataUriScheme(target, "application/octet-stream"); - } -#endif - - bool CopyToString(std::string& result, - bool allowBinary) const; - - bool ParseInteger32(int32_t& result) const; - - bool ParseInteger64(int64_t& result) const; - - bool ParseUnsignedInteger32(uint32_t& result) const; - - bool ParseUnsignedInteger64(uint64_t& result) const; - - bool ParseFloat(float& result) const; - - bool ParseDouble(double& result) const; - }; -}
--- a/Orthanc/Core/Endianness.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,207 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - - -/******************************************************************** - ** LINUX-LIKE ARCHITECTURES - ********************************************************************/ - -#if defined(__LSB_VERSION__) -// Linux Standard Base (LSB) does not come with be16toh, be32toh, and -// be64toh -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 0 -# include <endian.h> -#elif defined(__linux__) || defined(__EMSCRIPTEN__) -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 1 -# include <endian.h> -#endif - - -/******************************************************************** - ** WINDOWS ARCHITECTURES - ** - ** On Windows x86, "host" will always be little-endian ("le"). - ********************************************************************/ - -#if defined(_WIN32) -# if defined(_MSC_VER) -// Visual Studio - http://msdn.microsoft.com/en-us/library/a3140177.aspx -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 1 -# define be16toh(x) _byteswap_ushort(x) -# define be32toh(x) _byteswap_ulong(x) -# define be64toh(x) _byteswap_uint64(x) -# elif (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) -// MinGW >= 4.3 - Use builtin intrinsic for byte swapping -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 1 -# define be16toh(x) __builtin_bswap16(x) -# define be32toh(x) __builtin_bswap32(x) -# define be64toh(x) __builtin_bswap64(x) -# else -// MinGW <= 4.2, we must manually implement the byte swapping -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 0 -# define be16toh(x) __orthanc_bswap16(x) -# define be32toh(x) __orthanc_bswap32(x) -# define be64toh(x) __orthanc_bswap64(x) -# endif - -# define htobe16(x) be16toh(x) -# define htobe32(x) be32toh(x) -# define htobe64(x) be64toh(x) - -# define htole16(x) x -# define htole32(x) x -# define htole64(x) x - -# define le16toh(x) x -# define le32toh(x) x -# define le64toh(x) x -#endif - - -/******************************************************************** - ** FREEBSD ARCHITECTURES - ********************************************************************/ - -#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 1 -# include <arpa/inet.h> -#endif - - -/******************************************************************** - ** OPENBSD ARCHITECTURES - ********************************************************************/ - -#if defined(__OpenBSD__) -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 1 -# include <endian.h> -#endif - - -/******************************************************************** - ** APPLE ARCHITECTURES (including OS X) - ********************************************************************/ - -#if defined(__APPLE__) -# define ORTHANC_HAS_BUILTIN_BYTE_SWAP 1 -# include <libkern/OSByteOrder.h> -# define be16toh(x) OSSwapBigToHostInt16(x) -# define be32toh(x) OSSwapBigToHostInt32(x) -# define be64toh(x) OSSwapBigToHostInt64(x) - -# define htobe16(x) OSSwapHostToBigInt16(x) -# define htobe32(x) OSSwapHostToBigInt32(x) -# define htobe64(x) OSSwapHostToBigInt64(x) - -# define htole16(x) OSSwapHostToLittleInt16(x) -# define htole32(x) OSSwapHostToLittleInt32(x) -# define htole64(x) OSSwapHostToLittleInt64(x) - -# define le16toh(x) OSSwapLittleToHostInt16(x) -# define le32toh(x) OSSwapLittleToHostInt32(x) -# define le64toh(x) OSSwapLittleToHostInt64(x) -#endif - - -/******************************************************************** - ** PORTABLE (BUT SLOW) IMPLEMENTATION OF BYTE-SWAPPING - ********************************************************************/ - -#if ORTHANC_HAS_BUILTIN_BYTE_SWAP != 1 - -#include <stdint.h> - -static inline uint16_t __orthanc_bswap16(uint16_t a) -{ - return (a << 8) | (a >> 8); -} - -static inline uint32_t __orthanc_bswap32(uint32_t a) -{ - const uint8_t* p = reinterpret_cast<const uint8_t*>(&a); - return (static_cast<uint32_t>(p[0]) << 24 | - static_cast<uint32_t>(p[1]) << 16 | - static_cast<uint32_t>(p[2]) << 8 | - static_cast<uint32_t>(p[3])); -} - -static inline uint64_t __orthanc_bswap64(uint64_t a) -{ - const uint8_t* p = reinterpret_cast<const uint8_t*>(&a); - return (static_cast<uint64_t>(p[0]) << 56 | - static_cast<uint64_t>(p[1]) << 48 | - static_cast<uint64_t>(p[2]) << 40 | - static_cast<uint64_t>(p[3]) << 32 | - static_cast<uint64_t>(p[4]) << 24 | - static_cast<uint64_t>(p[5]) << 16 | - static_cast<uint64_t>(p[6]) << 8 | - static_cast<uint64_t>(p[7])); -} - -#if defined(__BYTE_ORDER) && defined(__LITTLE_ENDIAN) && defined(__BIG_ENDIAN) -# if __BYTE_ORDER == __LITTLE_ENDIAN -# define be16toh(x) __orthanc_bswap16(x) -# define be32toh(x) __orthanc_bswap32(x) -# define be64toh(x) __orthanc_bswap64(x) -# define htobe16(x) __orthanc_bswap16(x) -# define htobe32(x) __orthanc_bswap32(x) -# define htobe64(x) __orthanc_bswap64(x) -# define htole16(x) x -# define htole32(x) x -# define htole64(x) x -# define le16toh(x) x -# define le32toh(x) x -# define le64toh(x) x -# elif __BYTE_ORDER == __BIG_ENDIAN -# define be16toh(x) x -# define be32toh(x) x -# define be64toh(x) x -# define htobe16(x) x -# define htobe32(x) x -# define htobe64(x) x -# define htole16(x) __orthanc_bswap16(x) -# define htole32(x) __orthanc_bswap32(x) -# define htole64(x) __orthanc_bswap64(x) -# define le16toh(x) __orthanc_bswap16(x) -# define le32toh(x) __orthanc_bswap32(x) -# define le64toh(x) __orthanc_bswap64(x) -# else -# error Please support your platform here -# endif -#else -# error Please support your platform here -#endif - -#endif
--- a/Orthanc/Core/Enumerations.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1822 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "PrecompiledHeaders.h" -#include "Enumerations.h" - -#include "OrthancException.h" -#include "Toolbox.h" -#include "Logging.h" - -#include <boost/thread/mutex.hpp> -#include <string.h> -#include <cassert> - -namespace Orthanc -{ - // This function is autogenerated by the script - // "Resources/GenerateErrorCodes.py" - const char* EnumerationToString(ErrorCode error) - { - switch (error) - { - case ErrorCode_InternalError: - return "Internal error"; - - case ErrorCode_Success: - return "Success"; - - case ErrorCode_Plugin: - return "Error encountered within the plugin engine"; - - case ErrorCode_NotImplemented: - return "Not implemented yet"; - - case ErrorCode_ParameterOutOfRange: - return "Parameter out of range"; - - case ErrorCode_NotEnoughMemory: - return "The server hosting Orthanc is running out of memory"; - - case ErrorCode_BadParameterType: - return "Bad type for a parameter"; - - case ErrorCode_BadSequenceOfCalls: - return "Bad sequence of calls"; - - case ErrorCode_InexistentItem: - return "Accessing an inexistent item"; - - case ErrorCode_BadRequest: - return "Bad request"; - - case ErrorCode_NetworkProtocol: - return "Error in the network protocol"; - - case ErrorCode_SystemCommand: - return "Error while calling a system command"; - - case ErrorCode_Database: - return "Error with the database engine"; - - case ErrorCode_UriSyntax: - return "Badly formatted URI"; - - case ErrorCode_InexistentFile: - return "Inexistent file"; - - case ErrorCode_CannotWriteFile: - return "Cannot write to file"; - - case ErrorCode_BadFileFormat: - return "Bad file format"; - - case ErrorCode_Timeout: - return "Timeout"; - - case ErrorCode_UnknownResource: - return "Unknown resource"; - - case ErrorCode_IncompatibleDatabaseVersion: - return "Incompatible version of the database"; - - case ErrorCode_FullStorage: - return "The file storage is full"; - - case ErrorCode_CorruptedFile: - return "Corrupted file (e.g. inconsistent MD5 hash)"; - - case ErrorCode_InexistentTag: - return "Inexistent tag"; - - case ErrorCode_ReadOnly: - return "Cannot modify a read-only data structure"; - - case ErrorCode_IncompatibleImageFormat: - return "Incompatible format of the images"; - - case ErrorCode_IncompatibleImageSize: - return "Incompatible size of the images"; - - case ErrorCode_SharedLibrary: - return "Error while using a shared library (plugin)"; - - case ErrorCode_UnknownPluginService: - return "Plugin invoking an unknown service"; - - case ErrorCode_UnknownDicomTag: - return "Unknown DICOM tag"; - - case ErrorCode_BadJson: - return "Cannot parse a JSON document"; - - case ErrorCode_Unauthorized: - return "Bad credentials were provided to an HTTP request"; - - case ErrorCode_BadFont: - return "Badly formatted font file"; - - case ErrorCode_DatabasePlugin: - return "The plugin implementing a custom database back-end does not fulfill the proper interface"; - - case ErrorCode_StorageAreaPlugin: - return "Error in the plugin implementing a custom storage area"; - - case ErrorCode_EmptyRequest: - return "The request is empty"; - - case ErrorCode_NotAcceptable: - return "Cannot send a response which is acceptable according to the Accept HTTP header"; - - case ErrorCode_NullPointer: - return "Cannot handle a NULL pointer"; - - case ErrorCode_DatabaseUnavailable: - return "The database is currently not available (probably a transient situation)"; - - case ErrorCode_SQLiteNotOpened: - return "SQLite: The database is not opened"; - - case ErrorCode_SQLiteAlreadyOpened: - return "SQLite: Connection is already open"; - - case ErrorCode_SQLiteCannotOpen: - return "SQLite: Unable to open the database"; - - case ErrorCode_SQLiteStatementAlreadyUsed: - return "SQLite: This cached statement is already being referred to"; - - case ErrorCode_SQLiteExecute: - return "SQLite: Cannot execute a command"; - - case ErrorCode_SQLiteRollbackWithoutTransaction: - return "SQLite: Rolling back a nonexistent transaction (have you called Begin()?)"; - - case ErrorCode_SQLiteCommitWithoutTransaction: - return "SQLite: Committing a nonexistent transaction"; - - case ErrorCode_SQLiteRegisterFunction: - return "SQLite: Unable to register a function"; - - case ErrorCode_SQLiteFlush: - return "SQLite: Unable to flush the database"; - - case ErrorCode_SQLiteCannotRun: - return "SQLite: Cannot run a cached statement"; - - case ErrorCode_SQLiteCannotStep: - return "SQLite: Cannot step over a cached statement"; - - case ErrorCode_SQLiteBindOutOfRange: - return "SQLite: Bing a value while out of range (serious error)"; - - case ErrorCode_SQLitePrepareStatement: - return "SQLite: Cannot prepare a cached statement"; - - case ErrorCode_SQLiteTransactionAlreadyStarted: - return "SQLite: Beginning the same transaction twice"; - - case ErrorCode_SQLiteTransactionCommit: - return "SQLite: Failure when committing the transaction"; - - case ErrorCode_SQLiteTransactionBegin: - return "SQLite: Cannot start a transaction"; - - case ErrorCode_DirectoryOverFile: - return "The directory to be created is already occupied by a regular file"; - - case ErrorCode_FileStorageCannotWrite: - return "Unable to create a subdirectory or a file in the file storage"; - - case ErrorCode_DirectoryExpected: - return "The specified path does not point to a directory"; - - case ErrorCode_HttpPortInUse: - return "The TCP port of the HTTP server is privileged or already in use"; - - case ErrorCode_DicomPortInUse: - return "The TCP port of the DICOM server is privileged or already in use"; - - case ErrorCode_BadHttpStatusInRest: - return "This HTTP status is not allowed in a REST API"; - - case ErrorCode_RegularFileExpected: - return "The specified path does not point to a regular file"; - - case ErrorCode_PathToExecutable: - return "Unable to get the path to the executable"; - - case ErrorCode_MakeDirectory: - return "Cannot create a directory"; - - case ErrorCode_BadApplicationEntityTitle: - return "An application entity title (AET) cannot be empty or be longer than 16 characters"; - - case ErrorCode_NoCFindHandler: - return "No request handler factory for DICOM C-FIND SCP"; - - case ErrorCode_NoCMoveHandler: - return "No request handler factory for DICOM C-MOVE SCP"; - - case ErrorCode_NoCStoreHandler: - return "No request handler factory for DICOM C-STORE SCP"; - - case ErrorCode_NoApplicationEntityFilter: - return "No application entity filter"; - - case ErrorCode_NoSopClassOrInstance: - return "DicomUserConnection: Unable to find the SOP class and instance"; - - case ErrorCode_NoPresentationContext: - return "DicomUserConnection: No acceptable presentation context for modality"; - - case ErrorCode_DicomFindUnavailable: - return "DicomUserConnection: The C-FIND command is not supported by the remote SCP"; - - case ErrorCode_DicomMoveUnavailable: - return "DicomUserConnection: The C-MOVE command is not supported by the remote SCP"; - - case ErrorCode_CannotStoreInstance: - return "Cannot store an instance"; - - case ErrorCode_CreateDicomNotString: - return "Only string values are supported when creating DICOM instances"; - - case ErrorCode_CreateDicomOverrideTag: - return "Trying to override a value inherited from a parent module"; - - case ErrorCode_CreateDicomUseContent: - return "Use \"Content\" to inject an image into a new DICOM instance"; - - case ErrorCode_CreateDicomNoPayload: - return "No payload is present for one instance in the series"; - - case ErrorCode_CreateDicomUseDataUriScheme: - return "The payload of the DICOM instance must be specified according to Data URI scheme"; - - case ErrorCode_CreateDicomBadParent: - return "Trying to attach a new DICOM instance to an inexistent resource"; - - case ErrorCode_CreateDicomParentIsInstance: - return "Trying to attach a new DICOM instance to an instance (must be a series, study or patient)"; - - case ErrorCode_CreateDicomParentEncoding: - return "Unable to get the encoding of the parent resource"; - - case ErrorCode_UnknownModality: - return "Unknown modality"; - - case ErrorCode_BadJobOrdering: - return "Bad ordering of filters in a job"; - - case ErrorCode_JsonToLuaTable: - return "Cannot convert the given JSON object to a Lua table"; - - case ErrorCode_CannotCreateLua: - return "Cannot create the Lua context"; - - case ErrorCode_CannotExecuteLua: - return "Cannot execute a Lua command"; - - case ErrorCode_LuaAlreadyExecuted: - return "Arguments cannot be pushed after the Lua function is executed"; - - case ErrorCode_LuaBadOutput: - return "The Lua function does not give the expected number of outputs"; - - case ErrorCode_NotLuaPredicate: - return "The Lua function is not a predicate (only true/false outputs allowed)"; - - case ErrorCode_LuaReturnsNoString: - return "The Lua function does not return a string"; - - case ErrorCode_StorageAreaAlreadyRegistered: - return "Another plugin has already registered a custom storage area"; - - case ErrorCode_DatabaseBackendAlreadyRegistered: - return "Another plugin has already registered a custom database back-end"; - - case ErrorCode_DatabaseNotInitialized: - return "Plugin trying to call the database during its initialization"; - - case ErrorCode_SslDisabled: - return "Orthanc has been built without SSL support"; - - case ErrorCode_CannotOrderSlices: - return "Unable to order the slices of the series"; - - case ErrorCode_NoWorklistHandler: - return "No request handler factory for DICOM C-Find Modality SCP"; - - case ErrorCode_AlreadyExistingTag: - return "Cannot override the value of a tag that already exists"; - - default: - if (error >= ErrorCode_START_PLUGINS) - { - return "Error encountered within some plugin"; - } - else - { - return "Unknown error code"; - } - } - } - - - const char* EnumerationToString(HttpMethod method) - { - switch (method) - { - case HttpMethod_Get: - return "GET"; - - case HttpMethod_Post: - return "POST"; - - case HttpMethod_Delete: - return "DELETE"; - - case HttpMethod_Put: - return "PUT"; - - default: - return "?"; - } - } - - - const char* EnumerationToString(HttpStatus status) - { - switch (status) - { - case HttpStatus_100_Continue: - return "Continue"; - - case HttpStatus_101_SwitchingProtocols: - return "Switching Protocols"; - - case HttpStatus_102_Processing: - return "Processing"; - - case HttpStatus_200_Ok: - return "OK"; - - case HttpStatus_201_Created: - return "Created"; - - case HttpStatus_202_Accepted: - return "Accepted"; - - case HttpStatus_203_NonAuthoritativeInformation: - return "Non-Authoritative Information"; - - case HttpStatus_204_NoContent: - return "No Content"; - - case HttpStatus_205_ResetContent: - return "Reset Content"; - - case HttpStatus_206_PartialContent: - return "Partial Content"; - - case HttpStatus_207_MultiStatus: - return "Multi-Status"; - - case HttpStatus_208_AlreadyReported: - return "Already Reported"; - - case HttpStatus_226_IMUsed: - return "IM Used"; - - case HttpStatus_300_MultipleChoices: - return "Multiple Choices"; - - case HttpStatus_301_MovedPermanently: - return "Moved Permanently"; - - case HttpStatus_302_Found: - return "Found"; - - case HttpStatus_303_SeeOther: - return "See Other"; - - case HttpStatus_304_NotModified: - return "Not Modified"; - - case HttpStatus_305_UseProxy: - return "Use Proxy"; - - case HttpStatus_307_TemporaryRedirect: - return "Temporary Redirect"; - - case HttpStatus_400_BadRequest: - return "Bad Request"; - - case HttpStatus_401_Unauthorized: - return "Unauthorized"; - - case HttpStatus_402_PaymentRequired: - return "Payment Required"; - - case HttpStatus_403_Forbidden: - return "Forbidden"; - - case HttpStatus_404_NotFound: - return "Not Found"; - - case HttpStatus_405_MethodNotAllowed: - return "Method Not Allowed"; - - case HttpStatus_406_NotAcceptable: - return "Not Acceptable"; - - case HttpStatus_407_ProxyAuthenticationRequired: - return "Proxy Authentication Required"; - - case HttpStatus_408_RequestTimeout: - return "Request Timeout"; - - case HttpStatus_409_Conflict: - return "Conflict"; - - case HttpStatus_410_Gone: - return "Gone"; - - case HttpStatus_411_LengthRequired: - return "Length Required"; - - case HttpStatus_412_PreconditionFailed: - return "Precondition Failed"; - - case HttpStatus_413_RequestEntityTooLarge: - return "Request Entity Too Large"; - - case HttpStatus_414_RequestUriTooLong: - return "Request-URI Too Long"; - - case HttpStatus_415_UnsupportedMediaType: - return "Unsupported Media Type"; - - case HttpStatus_416_RequestedRangeNotSatisfiable: - return "Requested Range Not Satisfiable"; - - case HttpStatus_417_ExpectationFailed: - return "Expectation Failed"; - - case HttpStatus_422_UnprocessableEntity: - return "Unprocessable Entity"; - - case HttpStatus_423_Locked: - return "Locked"; - - case HttpStatus_424_FailedDependency: - return "Failed Dependency"; - - case HttpStatus_426_UpgradeRequired: - return "Upgrade Required"; - - case HttpStatus_500_InternalServerError: - return "Internal Server Error"; - - case HttpStatus_501_NotImplemented: - return "Not Implemented"; - - case HttpStatus_502_BadGateway: - return "Bad Gateway"; - - case HttpStatus_503_ServiceUnavailable: - return "Service Unavailable"; - - case HttpStatus_504_GatewayTimeout: - return "Gateway Timeout"; - - case HttpStatus_505_HttpVersionNotSupported: - return "HTTP Version Not Supported"; - - case HttpStatus_506_VariantAlsoNegotiates: - return "Variant Also Negotiates"; - - case HttpStatus_507_InsufficientStorage: - return "Insufficient Storage"; - - case HttpStatus_509_BandwidthLimitExceeded: - return "Bandwidth Limit Exceeded"; - - case HttpStatus_510_NotExtended: - return "Not Extended"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(ResourceType type) - { - switch (type) - { - case ResourceType_Patient: - return "Patient"; - - case ResourceType_Study: - return "Study"; - - case ResourceType_Series: - return "Series"; - - case ResourceType_Instance: - return "Instance"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(ImageFormat format) - { - switch (format) - { - case ImageFormat_Png: - return "Png"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(Encoding encoding) - { - switch (encoding) - { - case Encoding_Ascii: - return "Ascii"; - - case Encoding_Utf8: - return "Utf8"; - - case Encoding_Latin1: - return "Latin1"; - - case Encoding_Latin2: - return "Latin2"; - - case Encoding_Latin3: - return "Latin3"; - - case Encoding_Latin4: - return "Latin4"; - - case Encoding_Latin5: - return "Latin5"; - - case Encoding_Cyrillic: - return "Cyrillic"; - - case Encoding_Windows1251: - return "Windows1251"; - - case Encoding_Arabic: - return "Arabic"; - - case Encoding_Greek: - return "Greek"; - - case Encoding_Hebrew: - return "Hebrew"; - - case Encoding_Thai: - return "Thai"; - - case Encoding_Japanese: - return "Japanese"; - - case Encoding_Chinese: - return "Chinese"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(PhotometricInterpretation photometric) - { - switch (photometric) - { - case PhotometricInterpretation_RGB: - return "RGB"; - - case PhotometricInterpretation_Monochrome1: - return "MONOCHROME1"; - - case PhotometricInterpretation_Monochrome2: - return "MONOCHROME2"; - - case PhotometricInterpretation_ARGB: - return "ARGB"; - - case PhotometricInterpretation_CMYK: - return "CMYK"; - - case PhotometricInterpretation_HSV: - return "HSV"; - - case PhotometricInterpretation_Palette: - return "PALETTE COLOR"; - - case PhotometricInterpretation_YBRFull: - return "YBR_FULL"; - - case PhotometricInterpretation_YBRFull422: - return "YBR_FULL_422"; - - case PhotometricInterpretation_YBRPartial420: - return "YBR_PARTIAL_420"; - - case PhotometricInterpretation_YBRPartial422: - return "YBR_PARTIAL_422"; - - case PhotometricInterpretation_YBR_ICT: - return "YBR_ICT"; - - case PhotometricInterpretation_YBR_RCT: - return "YBR_RCT"; - - case PhotometricInterpretation_Unknown: - return "Unknown"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(RequestOrigin origin) - { - switch (origin) - { - case RequestOrigin_Unknown: - return "Unknown"; - - case RequestOrigin_DicomProtocol: - return "DicomProtocol"; - - case RequestOrigin_RestApi: - return "RestApi"; - - case RequestOrigin_Plugins: - return "Plugins"; - - case RequestOrigin_Lua: - return "Lua"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(LogLevel level) - { - switch (level) - { - case LogLevel_Error: - return "ERROR"; - - case LogLevel_Warning: - return "WARNING"; - - case LogLevel_Info: - return "INFO"; - - case LogLevel_Trace: - return "TRACE"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(PixelFormat format) - { - switch (format) - { - case PixelFormat_RGB24: - return "RGB24"; - - case PixelFormat_RGBA32: - return "RGBA32"; - - case PixelFormat_BGRA32: - return "BGRA32"; - - case PixelFormat_Grayscale8: - return "Grayscale (unsigned 8bpp)"; - - case PixelFormat_Grayscale16: - return "Grayscale (unsigned 16bpp)"; - - case PixelFormat_SignedGrayscale16: - return "Grayscale (signed 16bpp)"; - - case PixelFormat_Float32: - return "Grayscale (float 32bpp)"; - - case PixelFormat_Grayscale32: - return "Grayscale (unsigned 32bpp)"; - - case PixelFormat_RGB48: - return "RGB48"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(ModalityManufacturer manufacturer) - { - switch (manufacturer) - { - case ModalityManufacturer_Generic: - return "Generic"; - - case ModalityManufacturer_GenericNoWildcardInDates: - return "GenericNoWildcardInDates"; - - case ModalityManufacturer_GenericNoUniversalWildcard: - return "GenericNoUniversalWildcard"; - - case ModalityManufacturer_StoreScp: - return "StoreScp"; - - case ModalityManufacturer_ClearCanvas: - return "ClearCanvas"; - - case ModalityManufacturer_Dcm4Chee: - return "Dcm4Chee"; - - case ModalityManufacturer_Vitrea: - return "Vitrea"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(DicomRequestType type) - { - switch (type) - { - case DicomRequestType_Echo: - return "Echo"; - break; - - case DicomRequestType_Find: - return "Find"; - break; - - case DicomRequestType_Get: - return "Get"; - break; - - case DicomRequestType_Move: - return "Move"; - break; - - case DicomRequestType_Store: - return "Store"; - break; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(TransferSyntax syntax) - { - switch (syntax) - { - case TransferSyntax_Deflated: - return "Deflated"; - - case TransferSyntax_Jpeg: - return "JPEG"; - - case TransferSyntax_Jpeg2000: - return "JPEG2000"; - - case TransferSyntax_JpegLossless: - return "JPEG Lossless"; - - case TransferSyntax_Jpip: - return "JPIP"; - - case TransferSyntax_Mpeg2: - return "MPEG2"; - - case TransferSyntax_Rle: - return "RLE"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(DicomVersion version) - { - switch (version) - { - case DicomVersion_2008: - return "2008"; - break; - - case DicomVersion_2017c: - return "2017c"; - break; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - const char* EnumerationToString(ValueRepresentation vr) - { - switch (vr) - { - case ValueRepresentation_ApplicationEntity: // AE - return "AE"; - - case ValueRepresentation_AgeString: // AS - return "AS"; - - case ValueRepresentation_AttributeTag: // AT (2 x uint16_t) - return "AT"; - - case ValueRepresentation_CodeString: // CS - return "CS"; - - case ValueRepresentation_Date: // DA - return "DA"; - - case ValueRepresentation_DecimalString: // DS - return "DS"; - - case ValueRepresentation_DateTime: // DT - return "DT"; - - case ValueRepresentation_FloatingPointSingle: // FL (float) - return "FL"; - - case ValueRepresentation_FloatingPointDouble: // FD (double) - return "FD"; - - case ValueRepresentation_IntegerString: // IS - return "IS"; - - case ValueRepresentation_LongString: // LO - return "LO"; - - case ValueRepresentation_LongText: // LT - return "LT"; - - case ValueRepresentation_OtherByte: // OB - return "OB"; - - case ValueRepresentation_OtherDouble: // OD - return "OD"; - - case ValueRepresentation_OtherFloat: // OF - return "OF"; - - case ValueRepresentation_OtherLong: // OL - return "OL"; - - case ValueRepresentation_OtherWord: // OW - return "OW"; - - case ValueRepresentation_PersonName: // PN - return "PN"; - - case ValueRepresentation_ShortString: // SH - return "SH"; - - case ValueRepresentation_SignedLong: // SL (int32_t) - return "SL"; - - case ValueRepresentation_Sequence: // SQ - return "SQ"; - - case ValueRepresentation_SignedShort: // SS (int16_t) - return "SS"; - - case ValueRepresentation_ShortText: // ST - return "ST"; - - case ValueRepresentation_Time: // TM - return "TM"; - - case ValueRepresentation_UnlimitedCharacters: // UC - return "UC"; - - case ValueRepresentation_UniqueIdentifier: // UI (UID) - return "UI"; - - case ValueRepresentation_UnsignedLong: // UL (uint32_t) - return "UL"; - - case ValueRepresentation_Unknown: // UN - return "UN"; - - case ValueRepresentation_UniversalResource: // UR (URI or URL) - return "UR"; - - case ValueRepresentation_UnsignedShort: // US (uint16_t) - return "US"; - - case ValueRepresentation_UnlimitedText: // UT - return "UT"; - - case ValueRepresentation_NotSupported: - return "Not supported"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - Encoding StringToEncoding(const char* encoding) - { - std::string s(encoding); - Toolbox::ToUpperCase(s); - - if (s == "UTF8") - { - return Encoding_Utf8; - } - - if (s == "ASCII") - { - return Encoding_Ascii; - } - - if (s == "LATIN1") - { - return Encoding_Latin1; - } - - if (s == "LATIN2") - { - return Encoding_Latin2; - } - - if (s == "LATIN3") - { - return Encoding_Latin3; - } - - if (s == "LATIN4") - { - return Encoding_Latin4; - } - - if (s == "LATIN5") - { - return Encoding_Latin5; - } - - if (s == "CYRILLIC") - { - return Encoding_Cyrillic; - } - - if (s == "WINDOWS1251") - { - return Encoding_Windows1251; - } - - if (s == "ARABIC") - { - return Encoding_Arabic; - } - - if (s == "GREEK") - { - return Encoding_Greek; - } - - if (s == "HEBREW") - { - return Encoding_Hebrew; - } - - if (s == "THAI") - { - return Encoding_Thai; - } - - if (s == "JAPANESE") - { - return Encoding_Japanese; - } - - if (s == "CHINESE") - { - return Encoding_Chinese; - } - - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - - ResourceType StringToResourceType(const char* type) - { - std::string s(type); - Toolbox::ToUpperCase(s); - - if (s == "PATIENT" || s == "PATIENTS") - { - return ResourceType_Patient; - } - else if (s == "STUDY" || s == "STUDIES") - { - return ResourceType_Study; - } - else if (s == "SERIES") - { - return ResourceType_Series; - } - else if (s == "INSTANCE" || s == "IMAGE" || - s == "INSTANCES" || s == "IMAGES") - { - return ResourceType_Instance; - } - - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - - ImageFormat StringToImageFormat(const char* format) - { - std::string s(format); - Toolbox::ToUpperCase(s); - - if (s == "PNG") - { - return ImageFormat_Png; - } - - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - - LogLevel StringToLogLevel(const char *level) - { - if (strcmp(level, "ERROR") == 0) - { - return LogLevel_Error; - } - else if (strcmp(level, "WARNING") == 0) - { - return LogLevel_Warning; - } - else if (strcmp(level, "INFO") == 0) - { - return LogLevel_Info; - } - else if (strcmp(level, "TRACE") == 0) - { - return LogLevel_Trace; - } - else - { - throw OrthancException(ErrorCode_InternalError); - } - } - - - ValueRepresentation StringToValueRepresentation(const std::string& vr, - bool throwIfUnsupported) - { - if (vr == "AE") - { - return ValueRepresentation_ApplicationEntity; - } - else if (vr == "AS") - { - return ValueRepresentation_AgeString; - } - else if (vr == "AT") - { - return ValueRepresentation_AttributeTag; - } - else if (vr == "CS") - { - return ValueRepresentation_CodeString; - } - else if (vr == "DA") - { - return ValueRepresentation_Date; - } - else if (vr == "DS") - { - return ValueRepresentation_DecimalString; - } - else if (vr == "DT") - { - return ValueRepresentation_DateTime; - } - else if (vr == "FL") - { - return ValueRepresentation_FloatingPointSingle; - } - else if (vr == "FD") - { - return ValueRepresentation_FloatingPointDouble; - } - else if (vr == "IS") - { - return ValueRepresentation_IntegerString; - } - else if (vr == "LO") - { - return ValueRepresentation_LongString; - } - else if (vr == "LT") - { - return ValueRepresentation_LongText; - } - else if (vr == "OB") - { - return ValueRepresentation_OtherByte; - } - else if (vr == "OD") - { - return ValueRepresentation_OtherDouble; - } - else if (vr == "OF") - { - return ValueRepresentation_OtherFloat; - } - else if (vr == "OL") - { - return ValueRepresentation_OtherLong; - } - else if (vr == "OW") - { - return ValueRepresentation_OtherWord; - } - else if (vr == "PN") - { - return ValueRepresentation_PersonName; - } - else if (vr == "SH") - { - return ValueRepresentation_ShortString; - } - else if (vr == "SL") - { - return ValueRepresentation_SignedLong; - } - else if (vr == "SQ") - { - return ValueRepresentation_Sequence; - } - else if (vr == "SS") - { - return ValueRepresentation_SignedShort; - } - else if (vr == "ST") - { - return ValueRepresentation_ShortText; - } - else if (vr == "TM") - { - return ValueRepresentation_Time; - } - else if (vr == "UC") - { - return ValueRepresentation_UnlimitedCharacters; - } - else if (vr == "UI") - { - return ValueRepresentation_UniqueIdentifier; - } - else if (vr == "UL") - { - return ValueRepresentation_UnsignedLong; - } - else if (vr == "UN") - { - return ValueRepresentation_Unknown; - } - else if (vr == "UR") - { - return ValueRepresentation_UniversalResource; - } - else if (vr == "US") - { - return ValueRepresentation_UnsignedShort; - } - else if (vr == "UT") - { - return ValueRepresentation_UnlimitedText; - } - else - { - std::string s = "Unsupported value representation encountered: " + vr; - - if (throwIfUnsupported) - { - LOG(ERROR) << s; - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - else - { - LOG(INFO) << s; - return ValueRepresentation_NotSupported; - } - } - } - - - PhotometricInterpretation StringToPhotometricInterpretation(const char* value) - { - // http://dicom.nema.org/medical/dicom/2017a/output/chtml/part03/sect_C.7.6.3.html#sect_C.7.6.3.1.2 - std::string s(value); - - if (s == "MONOCHROME1") - { - return PhotometricInterpretation_Monochrome1; - } - - if (s == "MONOCHROME2") - { - return PhotometricInterpretation_Monochrome2; - } - - if (s == "PALETTE COLOR") - { - return PhotometricInterpretation_Palette; - } - - if (s == "RGB") - { - return PhotometricInterpretation_RGB; - } - - if (s == "HSV") - { - return PhotometricInterpretation_HSV; - } - - if (s == "ARGB") - { - return PhotometricInterpretation_ARGB; - } - - if (s == "CMYK") - { - return PhotometricInterpretation_CMYK; - } - - if (s == "YBR_FULL") - { - return PhotometricInterpretation_YBRFull; - } - - if (s == "YBR_FULL_422") - { - return PhotometricInterpretation_YBRFull422; - } - - if (s == "YBR_PARTIAL_422") - { - return PhotometricInterpretation_YBRPartial422; - } - - if (s == "YBR_PARTIAL_420") - { - return PhotometricInterpretation_YBRPartial420; - } - - if (s == "YBR_ICT") - { - return PhotometricInterpretation_YBR_ICT; - } - - if (s == "YBR_RCT") - { - return PhotometricInterpretation_YBR_RCT; - } - - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - - ModalityManufacturer StringToModalityManufacturer(const std::string& manufacturer) - { - ModalityManufacturer result; - bool obsolete = false; - - if (manufacturer == "Generic") - { - return ModalityManufacturer_Generic; - } - else if (manufacturer == "GenericNoWildcardInDates") - { - return ModalityManufacturer_GenericNoWildcardInDates; - } - else if (manufacturer == "GenericNoUniversalWildcard") - { - return ModalityManufacturer_GenericNoUniversalWildcard; - } - else if (manufacturer == "ClearCanvas") - { - return ModalityManufacturer_ClearCanvas; - } - else if (manufacturer == "StoreScp") - { - return ModalityManufacturer_StoreScp; - } - else if (manufacturer == "Dcm4Chee") - { - return ModalityManufacturer_Dcm4Chee; - } - else if (manufacturer == "Vitrea") - { - return ModalityManufacturer_Vitrea; - } - else if (manufacturer == "AgfaImpax" || - manufacturer == "SyngoVia") - { - result = ModalityManufacturer_GenericNoWildcardInDates; - obsolete = true; - } - else if (manufacturer == "EFilm2" || - manufacturer == "MedInria") - { - result = ModalityManufacturer_Generic; - obsolete = true; - } - else - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - if (obsolete) - { - LOG(WARNING) << "The \"" << manufacturer << "\" manufacturer is obsolete since " - << "Orthanc 1.3.0. To guarantee compatibility with future Orthanc " - << "releases, you should replace it by \"" - << EnumerationToString(result) - << "\" in your configuration file."; - } - - return result; - } - - - DicomVersion StringToDicomVersion(const std::string& version) - { - if (version == "2008") - { - return DicomVersion_2008; - } - else if (version == "2017c") - { - return DicomVersion_2017c; - } - else - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - unsigned int GetBytesPerPixel(PixelFormat format) - { - switch (format) - { - case PixelFormat_Grayscale8: - return 1; - - case PixelFormat_Grayscale16: - case PixelFormat_SignedGrayscale16: - return 2; - - case PixelFormat_RGB24: - return 3; - - case PixelFormat_RGBA32: - case PixelFormat_BGRA32: - case PixelFormat_Grayscale32: - return 4; - - case PixelFormat_Float32: - assert(sizeof(float) == 4); - return 4; - - case PixelFormat_RGB48: - return 6; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - bool GetDicomEncoding(Encoding& encoding, - const char* specificCharacterSet) - { - std::string s = Toolbox::StripSpaces(specificCharacterSet); - Toolbox::ToUpperCase(s); - - // http://dicom.nema.org/medical/dicom/current/output/html/part03.html#sect_C.12.1.1.2 - // https://github.com/dcm4che/dcm4che/blob/master/dcm4che-core/src/main/java/org/dcm4che3/data/SpecificCharacterSet.java - if (s == "ISO_IR 6" || - s == "ISO 2022 IR 6") - { - encoding = Encoding_Ascii; - } - else if (s == "ISO_IR 192") - { - encoding = Encoding_Utf8; - } - else if (s == "ISO_IR 100" || - s == "ISO 2022 IR 100") - { - encoding = Encoding_Latin1; - } - else if (s == "ISO_IR 101" || - s == "ISO 2022 IR 101") - { - encoding = Encoding_Latin2; - } - else if (s == "ISO_IR 109" || - s == "ISO 2022 IR 109") - { - encoding = Encoding_Latin3; - } - else if (s == "ISO_IR 110" || - s == "ISO 2022 IR 110") - { - encoding = Encoding_Latin4; - } - else if (s == "ISO_IR 148" || - s == "ISO 2022 IR 148") - { - encoding = Encoding_Latin5; - } - else if (s == "ISO_IR 144" || - s == "ISO 2022 IR 144") - { - encoding = Encoding_Cyrillic; - } - else if (s == "ISO_IR 127" || - s == "ISO 2022 IR 127") - { - encoding = Encoding_Arabic; - } - else if (s == "ISO_IR 126" || - s == "ISO 2022 IR 126") - { - encoding = Encoding_Greek; - } - else if (s == "ISO_IR 138" || - s == "ISO 2022 IR 138") - { - encoding = Encoding_Hebrew; - } - else if (s == "ISO_IR 166" || s == "ISO 2022 IR 166") - { - encoding = Encoding_Thai; - } - else if (s == "ISO_IR 13" || s == "ISO 2022 IR 13") - { - encoding = Encoding_Japanese; - } - else if (s == "GB18030" || s == "GBK") - { - /** - * According to tumashu@163.com, "In China, many dicom file's - * 0008,0005 tag is set as "GBK", instead of "GB18030", GBK is a - * subset of GB18030, and which is used frequently in China, - * suggest support it." - * https://groups.google.com/d/msg/orthanc-users/WMM8LMbjpUc/02-1f_yFCgAJ - **/ - encoding = Encoding_Chinese; - } - /* - else if (s == "ISO 2022 IR 149") - { - TODO - } - else if (s == "ISO 2022 IR 159") - { - TODO - } - else if (s == "ISO 2022 IR 87") - { - TODO - } - */ - else - { - return false; - } - - // The encoding was properly detected - return true; - } - - - ResourceType GetChildResourceType(ResourceType type) - { - switch (type) - { - case ResourceType_Patient: - return ResourceType_Study; - - case ResourceType_Study: - return ResourceType_Series; - - case ResourceType_Series: - return ResourceType_Instance; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - ResourceType GetParentResourceType(ResourceType type) - { - switch (type) - { - case ResourceType_Study: - return ResourceType_Patient; - - case ResourceType_Series: - return ResourceType_Study; - - case ResourceType_Instance: - return ResourceType_Series; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - DicomModule GetModule(ResourceType type) - { - switch (type) - { - case ResourceType_Patient: - return DicomModule_Patient; - - case ResourceType_Study: - return DicomModule_Study; - - case ResourceType_Series: - return DicomModule_Series; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - - const char* GetDicomSpecificCharacterSet(Encoding encoding) - { - // http://dicom.nema.org/medical/dicom/current/output/html/part03.html#sect_C.12.1.1.2 - switch (encoding) - { - case Encoding_Ascii: - return "ISO_IR 6"; - - case Encoding_Utf8: - return "ISO_IR 192"; - - case Encoding_Latin1: - return "ISO_IR 100"; - - case Encoding_Latin2: - return "ISO_IR 101"; - - case Encoding_Latin3: - return "ISO_IR 109"; - - case Encoding_Latin4: - return "ISO_IR 110"; - - case Encoding_Latin5: - return "ISO_IR 148"; - - case Encoding_Cyrillic: - return "ISO_IR 144"; - - case Encoding_Arabic: - return "ISO_IR 127"; - - case Encoding_Greek: - return "ISO_IR 126"; - - case Encoding_Hebrew: - return "ISO_IR 138"; - - case Encoding_Japanese: - return "ISO_IR 13"; - - case Encoding_Chinese: - return "GB18030"; - - case Encoding_Thai: - return "ISO_IR 166"; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - // This function is autogenerated by the script - // "Resources/GenerateErrorCodes.py" - HttpStatus ConvertErrorCodeToHttpStatus(ErrorCode error) - { - switch (error) - { - case ErrorCode_Success: - return HttpStatus_200_Ok; - - case ErrorCode_ParameterOutOfRange: - return HttpStatus_400_BadRequest; - - case ErrorCode_BadParameterType: - return HttpStatus_400_BadRequest; - - case ErrorCode_InexistentItem: - return HttpStatus_404_NotFound; - - case ErrorCode_BadRequest: - return HttpStatus_400_BadRequest; - - case ErrorCode_UriSyntax: - return HttpStatus_400_BadRequest; - - case ErrorCode_InexistentFile: - return HttpStatus_404_NotFound; - - case ErrorCode_BadFileFormat: - return HttpStatus_400_BadRequest; - - case ErrorCode_UnknownResource: - return HttpStatus_404_NotFound; - - case ErrorCode_InexistentTag: - return HttpStatus_404_NotFound; - - case ErrorCode_BadJson: - return HttpStatus_400_BadRequest; - - case ErrorCode_Unauthorized: - return HttpStatus_401_Unauthorized; - - case ErrorCode_NotAcceptable: - return HttpStatus_406_NotAcceptable; - - case ErrorCode_DatabaseUnavailable: - return HttpStatus_503_ServiceUnavailable; - - default: - return HttpStatus_500_InternalServerError; - } - } - - - bool IsUserContentType(FileContentType type) - { - return (type >= FileContentType_StartUser && - type <= FileContentType_EndUser); - } - - - bool IsBinaryValueRepresentation(ValueRepresentation vr) - { - // http://dicom.nema.org/medical/dicom/current/output/chtml/part05/sect_6.2.html - - switch (vr) - { - case ValueRepresentation_ApplicationEntity: // AE - case ValueRepresentation_AgeString: // AS - case ValueRepresentation_CodeString: // CS - case ValueRepresentation_Date: // DA - case ValueRepresentation_DecimalString: // DS - case ValueRepresentation_DateTime: // DT - case ValueRepresentation_IntegerString: // IS - case ValueRepresentation_LongString: // LO - case ValueRepresentation_LongText: // LT - case ValueRepresentation_PersonName: // PN - case ValueRepresentation_ShortString: // SH - case ValueRepresentation_ShortText: // ST - case ValueRepresentation_Time: // TM - case ValueRepresentation_UnlimitedCharacters: // UC - case ValueRepresentation_UniqueIdentifier: // UI (UID) - case ValueRepresentation_UniversalResource: // UR (URI or URL) - case ValueRepresentation_UnlimitedText: // UT - { - return false; - } - - /** - * Below are all the VR whose character repertoire is tagged as - * "not applicable" - **/ - case ValueRepresentation_AttributeTag: // AT (2 x uint16_t) - case ValueRepresentation_FloatingPointSingle: // FL (float) - case ValueRepresentation_FloatingPointDouble: // FD (double) - case ValueRepresentation_OtherByte: // OB - case ValueRepresentation_OtherDouble: // OD - case ValueRepresentation_OtherFloat: // OF - case ValueRepresentation_OtherLong: // OL - case ValueRepresentation_OtherWord: // OW - case ValueRepresentation_SignedLong: // SL (int32_t) - case ValueRepresentation_Sequence: // SQ - case ValueRepresentation_SignedShort: // SS (int16_t) - case ValueRepresentation_UnsignedLong: // UL (uint32_t) - case ValueRepresentation_Unknown: // UN - case ValueRepresentation_UnsignedShort: // US (uint16_t) - { - return true; - } - - case ValueRepresentation_NotSupported: - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - static boost::mutex defaultEncodingMutex_; // Should not be necessary - static Encoding defaultEncoding_ = ORTHANC_DEFAULT_DICOM_ENCODING; - - Encoding GetDefaultDicomEncoding() - { - boost::mutex::scoped_lock lock(defaultEncodingMutex_); - return defaultEncoding_; - } - - void SetDefaultDicomEncoding(Encoding encoding) - { - std::string name = EnumerationToString(encoding); - - { - boost::mutex::scoped_lock lock(defaultEncodingMutex_); - defaultEncoding_ = encoding; - } - - LOG(INFO) << "Default encoding for DICOM was changed to: " << name; - } - -}
--- a/Orthanc/Core/Enumerations.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,664 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <string> - - -#if defined(_MSC_VER) -# define ORTHANC_FORCE_INLINE __forceinline -#elif defined(__GNUC__) || defined(__clang__) || defined(__EMSCRIPTEN__) -# define ORTHANC_FORCE_INLINE inline __attribute((always_inline)) -#else -# error Please support your compiler here -#endif - - -namespace Orthanc -{ - enum Endianness - { - Endianness_Unknown, - Endianness_Big, - Endianness_Little - }; - - // This enumeration is autogenerated by the script - // "Resources/GenerateErrorCodes.py" - enum ErrorCode - { - ErrorCode_InternalError = -1 /*!< Internal error */, - ErrorCode_Success = 0 /*!< Success */, - ErrorCode_Plugin = 1 /*!< Error encountered within the plugin engine */, - ErrorCode_NotImplemented = 2 /*!< Not implemented yet */, - ErrorCode_ParameterOutOfRange = 3 /*!< Parameter out of range */, - ErrorCode_NotEnoughMemory = 4 /*!< The server hosting Orthanc is running out of memory */, - ErrorCode_BadParameterType = 5 /*!< Bad type for a parameter */, - ErrorCode_BadSequenceOfCalls = 6 /*!< Bad sequence of calls */, - ErrorCode_InexistentItem = 7 /*!< Accessing an inexistent item */, - ErrorCode_BadRequest = 8 /*!< Bad request */, - ErrorCode_NetworkProtocol = 9 /*!< Error in the network protocol */, - ErrorCode_SystemCommand = 10 /*!< Error while calling a system command */, - ErrorCode_Database = 11 /*!< Error with the database engine */, - ErrorCode_UriSyntax = 12 /*!< Badly formatted URI */, - ErrorCode_InexistentFile = 13 /*!< Inexistent file */, - ErrorCode_CannotWriteFile = 14 /*!< Cannot write to file */, - ErrorCode_BadFileFormat = 15 /*!< Bad file format */, - ErrorCode_Timeout = 16 /*!< Timeout */, - ErrorCode_UnknownResource = 17 /*!< Unknown resource */, - ErrorCode_IncompatibleDatabaseVersion = 18 /*!< Incompatible version of the database */, - ErrorCode_FullStorage = 19 /*!< The file storage is full */, - ErrorCode_CorruptedFile = 20 /*!< Corrupted file (e.g. inconsistent MD5 hash) */, - ErrorCode_InexistentTag = 21 /*!< Inexistent tag */, - ErrorCode_ReadOnly = 22 /*!< Cannot modify a read-only data structure */, - ErrorCode_IncompatibleImageFormat = 23 /*!< Incompatible format of the images */, - ErrorCode_IncompatibleImageSize = 24 /*!< Incompatible size of the images */, - ErrorCode_SharedLibrary = 25 /*!< Error while using a shared library (plugin) */, - ErrorCode_UnknownPluginService = 26 /*!< Plugin invoking an unknown service */, - ErrorCode_UnknownDicomTag = 27 /*!< Unknown DICOM tag */, - ErrorCode_BadJson = 28 /*!< Cannot parse a JSON document */, - ErrorCode_Unauthorized = 29 /*!< Bad credentials were provided to an HTTP request */, - ErrorCode_BadFont = 30 /*!< Badly formatted font file */, - ErrorCode_DatabasePlugin = 31 /*!< The plugin implementing a custom database back-end does not fulfill the proper interface */, - ErrorCode_StorageAreaPlugin = 32 /*!< Error in the plugin implementing a custom storage area */, - ErrorCode_EmptyRequest = 33 /*!< The request is empty */, - ErrorCode_NotAcceptable = 34 /*!< Cannot send a response which is acceptable according to the Accept HTTP header */, - ErrorCode_NullPointer = 35 /*!< Cannot handle a NULL pointer */, - ErrorCode_DatabaseUnavailable = 36 /*!< The database is currently not available (probably a transient situation) */, - ErrorCode_SQLiteNotOpened = 1000 /*!< SQLite: The database is not opened */, - ErrorCode_SQLiteAlreadyOpened = 1001 /*!< SQLite: Connection is already open */, - ErrorCode_SQLiteCannotOpen = 1002 /*!< SQLite: Unable to open the database */, - ErrorCode_SQLiteStatementAlreadyUsed = 1003 /*!< SQLite: This cached statement is already being referred to */, - ErrorCode_SQLiteExecute = 1004 /*!< SQLite: Cannot execute a command */, - ErrorCode_SQLiteRollbackWithoutTransaction = 1005 /*!< SQLite: Rolling back a nonexistent transaction (have you called Begin()?) */, - ErrorCode_SQLiteCommitWithoutTransaction = 1006 /*!< SQLite: Committing a nonexistent transaction */, - ErrorCode_SQLiteRegisterFunction = 1007 /*!< SQLite: Unable to register a function */, - ErrorCode_SQLiteFlush = 1008 /*!< SQLite: Unable to flush the database */, - ErrorCode_SQLiteCannotRun = 1009 /*!< SQLite: Cannot run a cached statement */, - ErrorCode_SQLiteCannotStep = 1010 /*!< SQLite: Cannot step over a cached statement */, - ErrorCode_SQLiteBindOutOfRange = 1011 /*!< SQLite: Bing a value while out of range (serious error) */, - ErrorCode_SQLitePrepareStatement = 1012 /*!< SQLite: Cannot prepare a cached statement */, - ErrorCode_SQLiteTransactionAlreadyStarted = 1013 /*!< SQLite: Beginning the same transaction twice */, - ErrorCode_SQLiteTransactionCommit = 1014 /*!< SQLite: Failure when committing the transaction */, - ErrorCode_SQLiteTransactionBegin = 1015 /*!< SQLite: Cannot start a transaction */, - ErrorCode_DirectoryOverFile = 2000 /*!< The directory to be created is already occupied by a regular file */, - ErrorCode_FileStorageCannotWrite = 2001 /*!< Unable to create a subdirectory or a file in the file storage */, - ErrorCode_DirectoryExpected = 2002 /*!< The specified path does not point to a directory */, - ErrorCode_HttpPortInUse = 2003 /*!< The TCP port of the HTTP server is privileged or already in use */, - ErrorCode_DicomPortInUse = 2004 /*!< The TCP port of the DICOM server is privileged or already in use */, - ErrorCode_BadHttpStatusInRest = 2005 /*!< This HTTP status is not allowed in a REST API */, - ErrorCode_RegularFileExpected = 2006 /*!< The specified path does not point to a regular file */, - ErrorCode_PathToExecutable = 2007 /*!< Unable to get the path to the executable */, - ErrorCode_MakeDirectory = 2008 /*!< Cannot create a directory */, - ErrorCode_BadApplicationEntityTitle = 2009 /*!< An application entity title (AET) cannot be empty or be longer than 16 characters */, - ErrorCode_NoCFindHandler = 2010 /*!< No request handler factory for DICOM C-FIND SCP */, - ErrorCode_NoCMoveHandler = 2011 /*!< No request handler factory for DICOM C-MOVE SCP */, - ErrorCode_NoCStoreHandler = 2012 /*!< No request handler factory for DICOM C-STORE SCP */, - ErrorCode_NoApplicationEntityFilter = 2013 /*!< No application entity filter */, - ErrorCode_NoSopClassOrInstance = 2014 /*!< DicomUserConnection: Unable to find the SOP class and instance */, - ErrorCode_NoPresentationContext = 2015 /*!< DicomUserConnection: No acceptable presentation context for modality */, - ErrorCode_DicomFindUnavailable = 2016 /*!< DicomUserConnection: The C-FIND command is not supported by the remote SCP */, - ErrorCode_DicomMoveUnavailable = 2017 /*!< DicomUserConnection: The C-MOVE command is not supported by the remote SCP */, - ErrorCode_CannotStoreInstance = 2018 /*!< Cannot store an instance */, - ErrorCode_CreateDicomNotString = 2019 /*!< Only string values are supported when creating DICOM instances */, - ErrorCode_CreateDicomOverrideTag = 2020 /*!< Trying to override a value inherited from a parent module */, - ErrorCode_CreateDicomUseContent = 2021 /*!< Use \"Content\" to inject an image into a new DICOM instance */, - ErrorCode_CreateDicomNoPayload = 2022 /*!< No payload is present for one instance in the series */, - ErrorCode_CreateDicomUseDataUriScheme = 2023 /*!< The payload of the DICOM instance must be specified according to Data URI scheme */, - ErrorCode_CreateDicomBadParent = 2024 /*!< Trying to attach a new DICOM instance to an inexistent resource */, - ErrorCode_CreateDicomParentIsInstance = 2025 /*!< Trying to attach a new DICOM instance to an instance (must be a series, study or patient) */, - ErrorCode_CreateDicomParentEncoding = 2026 /*!< Unable to get the encoding of the parent resource */, - ErrorCode_UnknownModality = 2027 /*!< Unknown modality */, - ErrorCode_BadJobOrdering = 2028 /*!< Bad ordering of filters in a job */, - ErrorCode_JsonToLuaTable = 2029 /*!< Cannot convert the given JSON object to a Lua table */, - ErrorCode_CannotCreateLua = 2030 /*!< Cannot create the Lua context */, - ErrorCode_CannotExecuteLua = 2031 /*!< Cannot execute a Lua command */, - ErrorCode_LuaAlreadyExecuted = 2032 /*!< Arguments cannot be pushed after the Lua function is executed */, - ErrorCode_LuaBadOutput = 2033 /*!< The Lua function does not give the expected number of outputs */, - ErrorCode_NotLuaPredicate = 2034 /*!< The Lua function is not a predicate (only true/false outputs allowed) */, - ErrorCode_LuaReturnsNoString = 2035 /*!< The Lua function does not return a string */, - ErrorCode_StorageAreaAlreadyRegistered = 2036 /*!< Another plugin has already registered a custom storage area */, - ErrorCode_DatabaseBackendAlreadyRegistered = 2037 /*!< Another plugin has already registered a custom database back-end */, - ErrorCode_DatabaseNotInitialized = 2038 /*!< Plugin trying to call the database during its initialization */, - ErrorCode_SslDisabled = 2039 /*!< Orthanc has been built without SSL support */, - ErrorCode_CannotOrderSlices = 2040 /*!< Unable to order the slices of the series */, - ErrorCode_NoWorklistHandler = 2041 /*!< No request handler factory for DICOM C-Find Modality SCP */, - ErrorCode_AlreadyExistingTag = 2042 /*!< Cannot override the value of a tag that already exists */, - ErrorCode_START_PLUGINS = 1000000 - }; - - enum LogLevel - { - LogLevel_Error, - LogLevel_Warning, - LogLevel_Info, - LogLevel_Trace - }; - - - /** - * {summary}{The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image.} - **/ - enum PixelFormat - { - /** - * {summary}{Color image in RGB24 format.} - * {description}{This format describes a color image. The pixels are stored in 3 - * consecutive bytes. The memory layout is RGB.} - **/ - PixelFormat_RGB24 = 1, - - /** - * {summary}{Color image in RGBA32 format.} - * {description}{This format describes a color image. The pixels are stored in 4 - * consecutive bytes. The memory layout is RGBA.} - **/ - PixelFormat_RGBA32 = 2, - - /** - * {summary}{Graylevel 8bpp image.} - * {description}{The image is graylevel. Each pixel is unsigned and stored in one byte.} - **/ - PixelFormat_Grayscale8 = 3, - - /** - * {summary}{Graylevel, unsigned 16bpp image.} - * {description}{The image is graylevel. Each pixel is unsigned and stored in two bytes.} - **/ - PixelFormat_Grayscale16 = 4, - - /** - * {summary}{Graylevel, signed 16bpp image.} - * {description}{The image is graylevel. Each pixel is signed and stored in two bytes.} - **/ - PixelFormat_SignedGrayscale16 = 5, - - /** - * {summary}{Graylevel, floating-point image.} - * {description}{The image is graylevel. Each pixel is floating-point and stored in 4 bytes.} - **/ - PixelFormat_Float32 = 6, - - // This is the memory layout for Cairo (for internal use in Stone of Orthanc) - PixelFormat_BGRA32 = 7, - - /** - * {summary}{Graylevel, unsigned 32bpp image.} - * {description}{The image is graylevel. Each pixel is unsigned and stored in 4 bytes.} - **/ - PixelFormat_Grayscale32 = 8, - - /** - * {summary}{Color image in RGB48 format.} - * {description}{This format describes a color image. The pixels are stored in 6 - * consecutive bytes. The memory layout is RGB.} - **/ - PixelFormat_RGB48 = 9 - }; - - - /** - * {summary}{The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image.} - **/ - enum ImageExtractionMode - { - /** - * {summary}{Rescaled to 8bpp.} - * {description}{The minimum value of the image is set to 0, and its maximum value is set to 255.} - **/ - ImageExtractionMode_Preview = 1, - - /** - * {summary}{Truncation to the [0, 255] range.} - **/ - ImageExtractionMode_UInt8 = 2, - - /** - * {summary}{Truncation to the [0, 65535] range.} - **/ - ImageExtractionMode_UInt16 = 3, - - /** - * {summary}{Truncation to the [-32768, 32767] range.} - **/ - ImageExtractionMode_Int16 = 4 - }; - - - /** - * Most common, non-joke and non-experimental HTTP status codes - * http://en.wikipedia.org/wiki/List_of_HTTP_status_codes - **/ - enum HttpStatus - { - HttpStatus_None = -1, - - // 1xx Informational - HttpStatus_100_Continue = 100, - HttpStatus_101_SwitchingProtocols = 101, - HttpStatus_102_Processing = 102, - - // 2xx Success - HttpStatus_200_Ok = 200, - HttpStatus_201_Created = 201, - HttpStatus_202_Accepted = 202, - HttpStatus_203_NonAuthoritativeInformation = 203, - HttpStatus_204_NoContent = 204, - HttpStatus_205_ResetContent = 205, - HttpStatus_206_PartialContent = 206, - HttpStatus_207_MultiStatus = 207, - HttpStatus_208_AlreadyReported = 208, - HttpStatus_226_IMUsed = 226, - - // 3xx Redirection - HttpStatus_300_MultipleChoices = 300, - HttpStatus_301_MovedPermanently = 301, - HttpStatus_302_Found = 302, - HttpStatus_303_SeeOther = 303, - HttpStatus_304_NotModified = 304, - HttpStatus_305_UseProxy = 305, - HttpStatus_307_TemporaryRedirect = 307, - - // 4xx Client Error - HttpStatus_400_BadRequest = 400, - HttpStatus_401_Unauthorized = 401, - HttpStatus_402_PaymentRequired = 402, - HttpStatus_403_Forbidden = 403, - HttpStatus_404_NotFound = 404, - HttpStatus_405_MethodNotAllowed = 405, - HttpStatus_406_NotAcceptable = 406, - HttpStatus_407_ProxyAuthenticationRequired = 407, - HttpStatus_408_RequestTimeout = 408, - HttpStatus_409_Conflict = 409, - HttpStatus_410_Gone = 410, - HttpStatus_411_LengthRequired = 411, - HttpStatus_412_PreconditionFailed = 412, - HttpStatus_413_RequestEntityTooLarge = 413, - HttpStatus_414_RequestUriTooLong = 414, - HttpStatus_415_UnsupportedMediaType = 415, - HttpStatus_416_RequestedRangeNotSatisfiable = 416, - HttpStatus_417_ExpectationFailed = 417, - HttpStatus_422_UnprocessableEntity = 422, - HttpStatus_423_Locked = 423, - HttpStatus_424_FailedDependency = 424, - HttpStatus_426_UpgradeRequired = 426, - - // 5xx Server Error - HttpStatus_500_InternalServerError = 500, - HttpStatus_501_NotImplemented = 501, - HttpStatus_502_BadGateway = 502, - HttpStatus_503_ServiceUnavailable = 503, - HttpStatus_504_GatewayTimeout = 504, - HttpStatus_505_HttpVersionNotSupported = 505, - HttpStatus_506_VariantAlsoNegotiates = 506, - HttpStatus_507_InsufficientStorage = 507, - HttpStatus_509_BandwidthLimitExceeded = 509, - HttpStatus_510_NotExtended = 510 - }; - - - enum HttpMethod - { - HttpMethod_Get = 0, - HttpMethod_Post = 1, - HttpMethod_Delete = 2, - HttpMethod_Put = 3 - }; - - - enum ImageFormat - { - ImageFormat_Png = 1 - }; - - - // https://en.wikipedia.org/wiki/HTTP_compression - enum HttpCompression - { - HttpCompression_None, - HttpCompression_Deflate, - HttpCompression_Gzip - }; - - - // Specific Character Sets - // http://dicom.nema.org/medical/dicom/current/output/html/part03.html#sect_C.12.1.1.2 - enum Encoding - { - Encoding_Ascii, - Encoding_Utf8, - Encoding_Latin1, - Encoding_Latin2, - Encoding_Latin3, - Encoding_Latin4, - Encoding_Latin5, // Turkish - Encoding_Cyrillic, - Encoding_Windows1251, // Windows-1251 (commonly used for Cyrillic) - Encoding_Arabic, - Encoding_Greek, - Encoding_Hebrew, - Encoding_Thai, // TIS 620-2533 - Encoding_Japanese, // JIS X 0201 (Shift JIS): Katakana - Encoding_Chinese // GB18030 - Chinese simplified - //Encoding_JapaneseKanji, // Multibyte - JIS X 0208: Kanji - //Encoding_JapaneseSupplementaryKanji, // Multibyte - JIS X 0212: Supplementary Kanji set - //Encoding_Korean, // Multibyte - KS X 1001: Hangul and Hanja - }; - - - // http://dicom.nema.org/medical/dicom/current/output/html/part03.html#sect_C.7.6.3.1.2 - enum PhotometricInterpretation - { - PhotometricInterpretation_ARGB, // Retired - PhotometricInterpretation_CMYK, // Retired - PhotometricInterpretation_HSV, // Retired - PhotometricInterpretation_Monochrome1, - PhotometricInterpretation_Monochrome2, - PhotometricInterpretation_Palette, - PhotometricInterpretation_RGB, - PhotometricInterpretation_YBRFull, - PhotometricInterpretation_YBRFull422, - PhotometricInterpretation_YBRPartial420, - PhotometricInterpretation_YBRPartial422, - PhotometricInterpretation_YBR_ICT, - PhotometricInterpretation_YBR_RCT, - PhotometricInterpretation_Unknown - }; - - enum DicomModule - { - DicomModule_Patient, - DicomModule_Study, - DicomModule_Series, - DicomModule_Instance, - DicomModule_Image - }; - - enum RequestOrigin - { - RequestOrigin_Unknown, - RequestOrigin_DicomProtocol, - RequestOrigin_RestApi, - RequestOrigin_Plugins, - RequestOrigin_Lua - }; - - enum ServerBarrierEvent - { - ServerBarrierEvent_Stop, - ServerBarrierEvent_Reload // SIGHUP signal: reload configuration file - }; - - enum FileMode - { - FileMode_ReadBinary, - FileMode_WriteBinary - }; - - /** - * The value representations Orthanc knows about. They correspond to - * the DICOM 2016b version of the standard. - * http://dicom.nema.org/medical/dicom/current/output/chtml/part05/sect_6.2.html - **/ - enum ValueRepresentation - { - ValueRepresentation_ApplicationEntity = 1, // AE - ValueRepresentation_AgeString = 2, // AS - ValueRepresentation_AttributeTag = 3, // AT (2 x uint16_t) - ValueRepresentation_CodeString = 4, // CS - ValueRepresentation_Date = 5, // DA - ValueRepresentation_DecimalString = 6, // DS - ValueRepresentation_DateTime = 7, // DT - ValueRepresentation_FloatingPointSingle = 8, // FL (float) - ValueRepresentation_FloatingPointDouble = 9, // FD (double) - ValueRepresentation_IntegerString = 10, // IS - ValueRepresentation_LongString = 11, // LO - ValueRepresentation_LongText = 12, // LT - ValueRepresentation_OtherByte = 13, // OB - ValueRepresentation_OtherDouble = 14, // OD - ValueRepresentation_OtherFloat = 15, // OF - ValueRepresentation_OtherLong = 16, // OL - ValueRepresentation_OtherWord = 17, // OW - ValueRepresentation_PersonName = 18, // PN - ValueRepresentation_ShortString = 19, // SH - ValueRepresentation_SignedLong = 20, // SL (int32_t) - ValueRepresentation_Sequence = 21, // SQ - ValueRepresentation_SignedShort = 22, // SS (int16_t) - ValueRepresentation_ShortText = 23, // ST - ValueRepresentation_Time = 24, // TM - ValueRepresentation_UnlimitedCharacters = 25, // UC - ValueRepresentation_UniqueIdentifier = 26, // UI (UID) - ValueRepresentation_UnsignedLong = 27, // UL (uint32_t) - ValueRepresentation_Unknown = 28, // UN - ValueRepresentation_UniversalResource = 29, // UR (URI or URL) - ValueRepresentation_UnsignedShort = 30, // US (uint16_t) - ValueRepresentation_UnlimitedText = 31, // UT - ValueRepresentation_NotSupported // Not supported by Orthanc, or tag not in dictionary - }; - - enum DicomReplaceMode - { - DicomReplaceMode_InsertIfAbsent, - DicomReplaceMode_ThrowIfAbsent, - DicomReplaceMode_IgnoreIfAbsent - }; - - enum DicomToJsonFormat - { - DicomToJsonFormat_Full, - DicomToJsonFormat_Short, - DicomToJsonFormat_Human - }; - - enum DicomToJsonFlags - { - DicomToJsonFlags_IncludeBinary = (1 << 0), - DicomToJsonFlags_IncludePrivateTags = (1 << 1), - DicomToJsonFlags_IncludeUnknownTags = (1 << 2), - DicomToJsonFlags_IncludePixelData = (1 << 3), - DicomToJsonFlags_ConvertBinaryToAscii = (1 << 4), - DicomToJsonFlags_ConvertBinaryToNull = (1 << 5), - - // Some predefined combinations - DicomToJsonFlags_None = 0, - DicomToJsonFlags_Default = (DicomToJsonFlags_IncludeBinary | - DicomToJsonFlags_IncludePixelData | - DicomToJsonFlags_IncludePrivateTags | - DicomToJsonFlags_IncludeUnknownTags | - DicomToJsonFlags_ConvertBinaryToNull) - }; - - enum DicomFromJsonFlags - { - DicomFromJsonFlags_DecodeDataUriScheme = (1 << 0), - DicomFromJsonFlags_GenerateIdentifiers = (1 << 1) - }; - - enum DicomVersion - { - DicomVersion_2008, - DicomVersion_2017c - }; - - enum ModalityManufacturer - { - ModalityManufacturer_Generic, - ModalityManufacturer_GenericNoWildcardInDates, - ModalityManufacturer_GenericNoUniversalWildcard, - ModalityManufacturer_StoreScp, - ModalityManufacturer_ClearCanvas, - ModalityManufacturer_Dcm4Chee, - ModalityManufacturer_Vitrea - }; - - enum DicomRequestType - { - DicomRequestType_Echo, - DicomRequestType_Find, - DicomRequestType_Get, - DicomRequestType_Move, - DicomRequestType_Store - }; - - enum TransferSyntax - { - TransferSyntax_Deflated, - TransferSyntax_Jpeg, - TransferSyntax_Jpeg2000, - TransferSyntax_JpegLossless, - TransferSyntax_Jpip, - TransferSyntax_Mpeg2, - TransferSyntax_Rle - }; - - - /** - * WARNING: Do not change the explicit values in the enumerations - * below this point. This would result in incompatible databases - * between versions of Orthanc! - **/ - - enum CompressionType - { - /** - * Buffer/file that is stored as-is, in a raw fashion, without - * compression. - **/ - CompressionType_None = 1, - - /** - * Buffer that is compressed using the "deflate" algorithm (RFC - * 1951), wrapped inside the zlib data format (RFC 1950), prefixed - * with a "uint64_t" (8 bytes) that encodes the size of the - * uncompressed buffer. If the compressed buffer is empty, its - * represents an empty uncompressed buffer. This format is - * internal to Orthanc. If the 8 first bytes are skipped AND the - * buffer is non-empty, the buffer is compatible with the - * "deflate" HTTP compression. - **/ - CompressionType_ZlibWithSize = 2 - }; - - enum FileContentType - { - // If you add a value below, insert it in "PluginStorageArea" in - // the file "Plugins/Engine/OrthancPlugins.cpp" - FileContentType_Unknown = 0, - FileContentType_Dicom = 1, - FileContentType_DicomAsJson = 2, - - // Make sure that the value "65535" can be stored into this enumeration - FileContentType_StartUser = 1024, - FileContentType_EndUser = 65535 - }; - - enum ResourceType - { - ResourceType_Patient = 1, - ResourceType_Study = 2, - ResourceType_Series = 3, - ResourceType_Instance = 4 - }; - - - const char* EnumerationToString(ErrorCode code); - - const char* EnumerationToString(HttpMethod method); - - const char* EnumerationToString(HttpStatus status); - - const char* EnumerationToString(ResourceType type); - - const char* EnumerationToString(ImageFormat format); - - const char* EnumerationToString(Encoding encoding); - - const char* EnumerationToString(PhotometricInterpretation photometric); - - const char* EnumerationToString(LogLevel level); - - const char* EnumerationToString(RequestOrigin origin); - - const char* EnumerationToString(PixelFormat format); - - const char* EnumerationToString(ModalityManufacturer manufacturer); - - const char* EnumerationToString(DicomRequestType type); - - const char* EnumerationToString(TransferSyntax syntax); - - const char* EnumerationToString(DicomVersion version); - - const char* EnumerationToString(ValueRepresentation vr); - - Encoding StringToEncoding(const char* encoding); - - ResourceType StringToResourceType(const char* type); - - ImageFormat StringToImageFormat(const char* format); - - LogLevel StringToLogLevel(const char* level); - - ValueRepresentation StringToValueRepresentation(const std::string& vr, - bool throwIfUnsupported); - - PhotometricInterpretation StringToPhotometricInterpretation(const char* value); - - ModalityManufacturer StringToModalityManufacturer(const std::string& manufacturer); - - DicomVersion StringToDicomVersion(const std::string& version); - - unsigned int GetBytesPerPixel(PixelFormat format); - - bool GetDicomEncoding(Encoding& encoding, - const char* specificCharacterSet); - - ResourceType GetChildResourceType(ResourceType type); - - ResourceType GetParentResourceType(ResourceType type); - - DicomModule GetModule(ResourceType type); - - const char* GetDicomSpecificCharacterSet(Encoding encoding); - - HttpStatus ConvertErrorCodeToHttpStatus(ErrorCode error); - - bool IsUserContentType(FileContentType type); - - bool IsBinaryValueRepresentation(ValueRepresentation vr); - - Encoding GetDefaultDicomEncoding(); - - void SetDefaultDicomEncoding(Encoding encoding); -}
--- a/Orthanc/Core/FileStorage/FilesystemStorage.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,274 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "FilesystemStorage.h" - -// http://stackoverflow.com/questions/1576272/storing-large-number-of-files-in-file-system -// http://stackoverflow.com/questions/446358/storing-a-large-number-of-images - -#include "../Logging.h" -#include "../OrthancException.h" -#include "../Toolbox.h" -#include "../SystemToolbox.h" - -#include <boost/filesystem/fstream.hpp> - - -static std::string ToString(const boost::filesystem::path& p) -{ -#if BOOST_HAS_FILESYSTEM_V3 == 1 - return p.filename().string(); -#else - return p.filename(); -#endif -} - - -namespace Orthanc -{ - boost::filesystem::path FilesystemStorage::GetPath(const std::string& uuid) const - { - namespace fs = boost::filesystem; - - if (!Toolbox::IsUuid(uuid)) - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - fs::path path = root_; - - path /= std::string(&uuid[0], &uuid[2]); - path /= std::string(&uuid[2], &uuid[4]); - path /= uuid; - -#if BOOST_HAS_FILESYSTEM_V3 == 1 - path.make_preferred(); -#endif - - return path; - } - - FilesystemStorage::FilesystemStorage(std::string root) - { - //root_ = boost::filesystem::absolute(root).string(); - root_ = root; - - SystemToolbox::MakeDirectory(root); - } - - - - static const char* GetDescriptionInternal(FileContentType content) - { - // This function is for logging only (internal use), a more - // fully-featured version is available in ServerEnumerations.cpp - switch (content) - { - case FileContentType_Unknown: - return "Unknown"; - - case FileContentType_Dicom: - return "DICOM"; - - case FileContentType_DicomAsJson: - return "JSON summary of DICOM"; - - default: - return "User-defined"; - } - } - - - void FilesystemStorage::Create(const std::string& uuid, - const void* content, - size_t size, - FileContentType type) - { - LOG(INFO) << "Creating attachment \"" << uuid << "\" of \"" << GetDescriptionInternal(type) - << "\" type (size: " << (size / (1024 * 1024) + 1) << "MB)"; - - boost::filesystem::path path; - - path = GetPath(uuid); - - if (boost::filesystem::exists(path)) - { - // Extremely unlikely case: This Uuid has already been created - // in the past. - throw OrthancException(ErrorCode_InternalError); - } - - if (boost::filesystem::exists(path.parent_path())) - { - if (!boost::filesystem::is_directory(path.parent_path())) - { - throw OrthancException(ErrorCode_DirectoryOverFile); - } - } - else - { - if (!boost::filesystem::create_directories(path.parent_path())) - { - throw OrthancException(ErrorCode_FileStorageCannotWrite); - } - } - - SystemToolbox::WriteFile(content, size, path.string()); - } - - - void FilesystemStorage::Read(std::string& content, - const std::string& uuid, - FileContentType type) - { - LOG(INFO) << "Reading attachment \"" << uuid << "\" of \"" << GetDescriptionInternal(type) - << "\" content type"; - - content.clear(); - SystemToolbox::ReadFile(content, GetPath(uuid).string()); - } - - - uintmax_t FilesystemStorage::GetSize(const std::string& uuid) const - { - boost::filesystem::path path = GetPath(uuid); - return boost::filesystem::file_size(path); - } - - - - void FilesystemStorage::ListAllFiles(std::set<std::string>& result) const - { - namespace fs = boost::filesystem; - - result.clear(); - - if (fs::exists(root_) && fs::is_directory(root_)) - { - for (fs::recursive_directory_iterator current(root_), end; current != end ; ++current) - { - if (SystemToolbox::IsRegularFile(current->path().string())) - { - try - { - fs::path d = current->path(); - std::string uuid = ToString(d); - if (Toolbox::IsUuid(uuid)) - { - fs::path p0 = d.parent_path().parent_path().parent_path(); - std::string p1 = ToString(d.parent_path().parent_path()); - std::string p2 = ToString(d.parent_path()); - if (p1.length() == 2 && - p2.length() == 2 && - p1 == uuid.substr(0, 2) && - p2 == uuid.substr(2, 2) && - p0 == root_) - { - result.insert(uuid); - } - } - } - catch (fs::filesystem_error) - { - } - } - } - } - } - - - void FilesystemStorage::Clear() - { - namespace fs = boost::filesystem; - typedef std::set<std::string> List; - - List result; - ListAllFiles(result); - - for (List::const_iterator it = result.begin(); it != result.end(); ++it) - { - Remove(*it, FileContentType_Unknown /*ignored in this class*/); - } - } - - - void FilesystemStorage::Remove(const std::string& uuid, - FileContentType type) - { - LOG(INFO) << "Deleting attachment \"" << uuid << "\" of type " << static_cast<int>(type); - - namespace fs = boost::filesystem; - - fs::path p = GetPath(uuid); - - try - { - fs::remove(p); - } - catch (...) - { - // Ignore the error - } - - // Remove the two parent directories, ignoring the error code if - // these directories are not empty - - try - { -#if BOOST_HAS_FILESYSTEM_V3 == 1 - boost::system::error_code err; - fs::remove(p.parent_path(), err); - fs::remove(p.parent_path().parent_path(), err); -#else - fs::remove(p.parent_path()); - fs::remove(p.parent_path().parent_path()); -#endif - } - catch (...) - { - // Ignore the error - } - } - - - uintmax_t FilesystemStorage::GetCapacity() const - { - return boost::filesystem::space(root_).capacity; - } - - uintmax_t FilesystemStorage::GetAvailableSpace() const - { - return boost::filesystem::space(root_).available; - } -}
--- a/Orthanc/Core/FileStorage/FilesystemStorage.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,88 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#if !defined(ORTHANC_SANDBOXED) -# error The macro ORTHANC_SANDBOXED must be defined -#endif - -#if ORTHANC_SANDBOXED == 1 -# error The class FilesystemStorage cannot be used in sandboxed environments -#endif - -#include "IStorageArea.h" - -#include <stdint.h> -#include <boost/filesystem.hpp> -#include <set> - -namespace Orthanc -{ - class FilesystemStorage : public IStorageArea - { - // TODO REMOVE THIS - friend class FilesystemHttpSender; - friend class FileStorageAccessor; - - private: - boost::filesystem::path root_; - - boost::filesystem::path GetPath(const std::string& uuid) const; - - public: - explicit FilesystemStorage(std::string root); - - virtual void Create(const std::string& uuid, - const void* content, - size_t size, - FileContentType type); - - virtual void Read(std::string& content, - const std::string& uuid, - FileContentType type); - - virtual void Remove(const std::string& uuid, - FileContentType type); - - void ListAllFiles(std::set<std::string>& result) const; - - uintmax_t GetSize(const std::string& uuid) const; - - void Clear(); - - uintmax_t GetCapacity() const; - - uintmax_t GetAvailableSpace() const; - }; -}
--- a/Orthanc/Core/FileStorage/IStorageArea.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,62 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "../Enumerations.h" - -#include <string> -#include <boost/noncopyable.hpp> - -namespace Orthanc -{ - class IStorageArea : public boost::noncopyable - { - public: - virtual ~IStorageArea() - { - } - - virtual void Create(const std::string& uuid, - const void* content, - size_t size, - FileContentType type) = 0; - - virtual void Read(std::string& content, - const std::string& uuid, - FileContentType type) = 0; - - virtual void Remove(const std::string& uuid, - FileContentType type) = 0; - }; -}
--- a/Orthanc/Core/IDynamicObject.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,53 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <boost/noncopyable.hpp> - -namespace Orthanc -{ - /** - * This class should be the ancestor to any class whose type is - * determined at the runtime, and that can be dynamically allocated. - * Being a child of IDynamicObject only implies the existence of a - * virtual destructor. - **/ - class IDynamicObject : public boost::noncopyable - { - public: - virtual ~IDynamicObject() - { - } - }; -}
--- a/Orthanc/Core/Images/ImageAccessor.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,301 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "ImageAccessor.h" - -#include "../Logging.h" -#include "../OrthancException.h" -#include "../ChunkedBuffer.h" - -#include <stdint.h> -#include <cassert> -#include <boost/lexical_cast.hpp> - - - -namespace Orthanc -{ - template <typename PixelType> - static void ToMatlabStringInternal(ChunkedBuffer& target, - const ImageAccessor& source) - { - target.AddChunk("double([ "); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const PixelType* p = reinterpret_cast<const PixelType*>(source.GetConstRow(y)); - - std::string s; - if (y > 0) - { - s = "; "; - } - - s.reserve(source.GetWidth() * 8); - - for (unsigned int x = 0; x < source.GetWidth(); x++, p++) - { - s += boost::lexical_cast<std::string>(static_cast<double>(*p)) + " "; - } - - target.AddChunk(s); - } - - target.AddChunk("])"); - } - - - static void RGB24ToMatlabString(ChunkedBuffer& target, - const ImageAccessor& source) - { - assert(source.GetFormat() == PixelFormat_RGB24); - - target.AddChunk("double(permute(reshape([ "); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - - std::string s; - s.reserve(source.GetWidth() * 3 * 8); - - for (unsigned int x = 0; x < 3 * source.GetWidth(); x++, p++) - { - s += boost::lexical_cast<std::string>(static_cast<int>(*p)) + " "; - } - - target.AddChunk(s); - } - - target.AddChunk("], [ 3 " + boost::lexical_cast<std::string>(source.GetHeight()) + - " " + boost::lexical_cast<std::string>(source.GetWidth()) + " ]), [ 3 2 1 ]))"); - } - - - void* ImageAccessor::GetBuffer() const - { - if (readOnly_) - { -#if ORTHANC_ENABLE_LOGGING == 1 - LOG(ERROR) << "Trying to write on a read-only image"; -#endif - - throw OrthancException(ErrorCode_ReadOnly); - } - - return buffer_; - } - - - const void* ImageAccessor::GetConstRow(unsigned int y) const - { - if (buffer_ != NULL) - { - return buffer_ + y * pitch_; - } - else - { - return NULL; - } - } - - - void* ImageAccessor::GetRow(unsigned int y) const - { - if (readOnly_) - { -#if ORTHANC_ENABLE_LOGGING == 1 - LOG(ERROR) << "Trying to write on a read-only image"; -#endif - - throw OrthancException(ErrorCode_ReadOnly); - } - - if (buffer_ != NULL) - { - return buffer_ + y * pitch_; - } - else - { - return NULL; - } - } - - - void ImageAccessor::AssignEmpty(PixelFormat format) - { - readOnly_ = false; - format_ = format; - width_ = 0; - height_ = 0; - pitch_ = 0; - buffer_ = NULL; - } - - - void ImageAccessor::AssignReadOnly(PixelFormat format, - unsigned int width, - unsigned int height, - unsigned int pitch, - const void *buffer) - { - readOnly_ = true; - format_ = format; - width_ = width; - height_ = height; - pitch_ = pitch; - buffer_ = reinterpret_cast<uint8_t*>(const_cast<void*>(buffer)); - - if (GetBytesPerPixel() * width_ > pitch_) - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - void ImageAccessor::AssignWritable(PixelFormat format, - unsigned int width, - unsigned int height, - unsigned int pitch, - void *buffer) - { - readOnly_ = false; - format_ = format; - width_ = width; - height_ = height; - pitch_ = pitch; - buffer_ = reinterpret_cast<uint8_t*>(buffer); - - if (GetBytesPerPixel() * width_ > pitch_) - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - void ImageAccessor::ToMatlabString(std::string& target) const - { - ChunkedBuffer buffer; - - switch (GetFormat()) - { - case PixelFormat_Grayscale8: - ToMatlabStringInternal<uint8_t>(buffer, *this); - break; - - case PixelFormat_Grayscale16: - ToMatlabStringInternal<uint16_t>(buffer, *this); - break; - - case PixelFormat_Grayscale32: - ToMatlabStringInternal<uint32_t>(buffer, *this); - break; - - case PixelFormat_SignedGrayscale16: - ToMatlabStringInternal<int16_t>(buffer, *this); - break; - - case PixelFormat_Float32: - ToMatlabStringInternal<float>(buffer, *this); - break; - - case PixelFormat_RGB24: - RGB24ToMatlabString(buffer, *this); - break; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - - buffer.Flatten(target); - } - - - - ImageAccessor ImageAccessor::GetRegion(unsigned int x, - unsigned int y, - unsigned int width, - unsigned int height) const - { - if (x + width > width_ || - y + height > height_) - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - ImageAccessor result; - - if (width == 0 || - height == 0) - { - result.AssignWritable(format_, 0, 0, 0, NULL); - } - else - { - uint8_t* p = (buffer_ + - y * pitch_ + - x * GetBytesPerPixel()); - - if (readOnly_) - { - result.AssignReadOnly(format_, width, height, pitch_, p); - } - else - { - result.AssignWritable(format_, width, height, pitch_, p); - } - } - - return result; - } - - - void ImageAccessor::SetFormat(PixelFormat format) - { - if (readOnly_) - { -#if ORTHANC_ENABLE_LOGGING == 1 - LOG(ERROR) << "Trying to modify the format of a read-only image"; -#endif - throw OrthancException(ErrorCode_ReadOnly); - } - - if (::Orthanc::GetBytesPerPixel(format) != ::Orthanc::GetBytesPerPixel(format_)) - { - throw OrthancException(ErrorCode_IncompatibleImageFormat); - } - - format_ = format; - } -}
--- a/Orthanc/Core/Images/ImageAccessor.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,152 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "../Enumerations.h" - -#include <string> -#include <stdint.h> - -namespace Orthanc -{ - class ImageAccessor - { - private: - template <Orthanc::PixelFormat Format> - friend struct ImageTraits; - - bool readOnly_; - PixelFormat format_; - unsigned int width_; - unsigned int height_; - unsigned int pitch_; - uint8_t *buffer_; - - template <typename T> - const T& GetPixelUnchecked(unsigned int x, - unsigned int y) const - { - const uint8_t* row = reinterpret_cast<const uint8_t*>(buffer_) + y * pitch_; - return reinterpret_cast<const T*>(row) [x]; - } - - - template <typename T> - T& GetPixelUnchecked(unsigned int x, - unsigned int y) - { - uint8_t* row = reinterpret_cast<uint8_t*>(buffer_) + y * pitch_; - return reinterpret_cast<T*>(row) [x]; - } - - public: - ImageAccessor() - { - AssignEmpty(PixelFormat_Grayscale8); - } - - virtual ~ImageAccessor() - { - } - - bool IsReadOnly() const - { - return readOnly_; - } - - PixelFormat GetFormat() const - { - return format_; - } - - unsigned int GetBytesPerPixel() const - { - return ::Orthanc::GetBytesPerPixel(format_); - } - - unsigned int GetWidth() const - { - return width_; - } - - unsigned int GetHeight() const - { - return height_; - } - - unsigned int GetPitch() const - { - return pitch_; - } - - unsigned int GetSize() const - { - return GetHeight() * GetPitch(); - } - - const void* GetConstBuffer() const - { - return buffer_; - } - - void* GetBuffer() const; - - const void* GetConstRow(unsigned int y) const; - - void* GetRow(unsigned int y) const; - - void AssignEmpty(PixelFormat format); - - void AssignReadOnly(PixelFormat format, - unsigned int width, - unsigned int height, - unsigned int pitch, - const void *buffer); - - void AssignWritable(PixelFormat format, - unsigned int width, - unsigned int height, - unsigned int pitch, - void *buffer); - - void ToMatlabString(std::string& target) const; - - ImageAccessor GetRegion(unsigned int x, - unsigned int y, - unsigned int width, - unsigned int height) const; - - void SetFormat(PixelFormat format); - }; -}
--- a/Orthanc/Core/Images/ImageBuffer.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,185 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "ImageBuffer.h" - -#include "../OrthancException.h" - -#include <stdio.h> -#include <stdlib.h> - -namespace Orthanc -{ - void ImageBuffer::Allocate() - { - if (changed_) - { - Deallocate(); - - /* - if (forceMinimalPitch_) - { - TODO: Align pitch and memory buffer to optimal size for SIMD. - } - */ - - pitch_ = GetBytesPerPixel() * width_; - size_t size = pitch_ * height_; - - if (size == 0) - { - buffer_ = NULL; - } - else - { - buffer_ = malloc(size); - if (buffer_ == NULL) - { - throw OrthancException(ErrorCode_NotEnoughMemory); - } - } - - changed_ = false; - } - } - - - void ImageBuffer::Deallocate() - { - if (buffer_ != NULL) - { - free(buffer_); - buffer_ = NULL; - changed_ = true; - } - } - - - ImageBuffer::ImageBuffer(PixelFormat format, - unsigned int width, - unsigned int height, - bool forceMinimalPitch) : - forceMinimalPitch_(forceMinimalPitch) - { - Initialize(); - SetWidth(width); - SetHeight(height); - SetFormat(format); - } - - - void ImageBuffer::Initialize() - { - changed_ = false; - forceMinimalPitch_ = true; - format_ = PixelFormat_Grayscale8; - width_ = 0; - height_ = 0; - pitch_ = 0; - buffer_ = NULL; - } - - - void ImageBuffer::SetFormat(PixelFormat format) - { - if (format != format_) - { - changed_ = true; - format_ = format; - } - } - - - void ImageBuffer::SetWidth(unsigned int width) - { - if (width != width_) - { - changed_ = true; - width_ = width; - } - } - - - void ImageBuffer::SetHeight(unsigned int height) - { - if (height != height_) - { - changed_ = true; - height_ = height; - } - } - - - ImageAccessor ImageBuffer::GetAccessor() - { - Allocate(); - - ImageAccessor accessor; - accessor.AssignWritable(format_, width_, height_, pitch_, buffer_); - return accessor; - } - - - ImageAccessor ImageBuffer::GetConstAccessor() - { - Allocate(); - - ImageAccessor accessor; - accessor.AssignReadOnly(format_, width_, height_, pitch_, buffer_); - return accessor; - } - - - void ImageBuffer::AcquireOwnership(ImageBuffer& other) - { - // Remove the content of the current image - Deallocate(); - - // Force the allocation of the other image (if not already - // allocated) - other.Allocate(); - - // Transfer the content of the other image - changed_ = false; - forceMinimalPitch_ = other.forceMinimalPitch_; - format_ = other.format_; - width_ = other.width_; - height_ = other.height_; - pitch_ = other.pitch_; - buffer_ = other.buffer_; - - // Force the reinitialization of the other image - other.Initialize(); - } -}
--- a/Orthanc/Core/Images/ImageBuffer.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,115 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "ImageAccessor.h" - -#include <vector> -#include <stdint.h> -#include <boost/noncopyable.hpp> - -namespace Orthanc -{ - class ImageBuffer : public boost::noncopyable - { - private: - bool changed_; - - bool forceMinimalPitch_; // Currently unused - PixelFormat format_; - unsigned int width_; - unsigned int height_; - unsigned int pitch_; - void *buffer_; - - void Initialize(); - - void Allocate(); - - void Deallocate(); - - public: - ImageBuffer(PixelFormat format, - unsigned int width, - unsigned int height, - bool forceMinimalPitch); - - ImageBuffer() - { - Initialize(); - } - - ~ImageBuffer() - { - Deallocate(); - } - - PixelFormat GetFormat() const - { - return format_; - } - - void SetFormat(PixelFormat format); - - unsigned int GetWidth() const - { - return width_; - } - - void SetWidth(unsigned int width); - - unsigned int GetHeight() const - { - return height_; - } - - void SetHeight(unsigned int height); - - unsigned int GetBytesPerPixel() const - { - return ::Orthanc::GetBytesPerPixel(format_); - } - - ImageAccessor GetAccessor(); - - ImageAccessor GetConstAccessor(); - - bool IsMinimalPitchForced() const - { - return forceMinimalPitch_; - } - - void AcquireOwnership(ImageBuffer& other); - }; -}
--- a/Orthanc/Core/Images/ImageProcessing.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1226 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "ImageProcessing.h" - -#include "PixelTraits.h" - -#include <boost/math/special_functions/round.hpp> - -#include <cassert> -#include <string.h> -#include <limits> -#include <stdint.h> - -namespace Orthanc -{ - template <typename TargetType, typename SourceType> - static void ConvertInternal(ImageAccessor& target, - const ImageAccessor& source) - { - const TargetType minValue = std::numeric_limits<TargetType>::min(); - const TargetType maxValue = std::numeric_limits<TargetType>::max(); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - TargetType* t = reinterpret_cast<TargetType*>(target.GetRow(y)); - const SourceType* s = reinterpret_cast<const SourceType*>(source.GetConstRow(y)); - - for (unsigned int x = 0; x < source.GetWidth(); x++, t++, s++) - { - if (static_cast<int32_t>(*s) < static_cast<int32_t>(minValue)) - { - *t = minValue; - } - else if (static_cast<int32_t>(*s) > static_cast<int32_t>(maxValue)) - { - *t = maxValue; - } - else - { - *t = static_cast<TargetType>(*s); - } - } - } - } - - - template <typename SourceType> - static void ConvertGrayscaleToFloat(ImageAccessor& target, - const ImageAccessor& source) - { - assert(sizeof(float) == 4); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - float* t = reinterpret_cast<float*>(target.GetRow(y)); - const SourceType* s = reinterpret_cast<const SourceType*>(source.GetConstRow(y)); - - for (unsigned int x = 0; x < source.GetWidth(); x++, t++, s++) - { - *t = static_cast<float>(*s); - } - } - } - - - template <typename TargetType> - static void ConvertColorToGrayscale(ImageAccessor& target, - const ImageAccessor& source) - { - assert(source.GetFormat() == PixelFormat_RGB24); - - const TargetType minValue = std::numeric_limits<TargetType>::min(); - const TargetType maxValue = std::numeric_limits<TargetType>::max(); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - TargetType* t = reinterpret_cast<TargetType*>(target.GetRow(y)); - const uint8_t* s = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - - for (unsigned int x = 0; x < source.GetWidth(); x++, t++, s += 3) - { - // Y = 0.2126 R + 0.7152 G + 0.0722 B - int32_t v = (2126 * static_cast<int32_t>(s[0]) + - 7152 * static_cast<int32_t>(s[1]) + - 0722 * static_cast<int32_t>(s[2])) / 10000; - - if (static_cast<int32_t>(v) < static_cast<int32_t>(minValue)) - { - *t = minValue; - } - else if (static_cast<int32_t>(v) > static_cast<int32_t>(maxValue)) - { - *t = maxValue; - } - else - { - *t = static_cast<TargetType>(v); - } - } - } - } - - - template <typename PixelType> - static void SetInternal(ImageAccessor& image, - int64_t constant) - { - for (unsigned int y = 0; y < image.GetHeight(); y++) - { - PixelType* p = reinterpret_cast<PixelType*>(image.GetRow(y)); - - for (unsigned int x = 0; x < image.GetWidth(); x++, p++) - { - *p = static_cast<PixelType>(constant); - } - } - } - - - template <typename PixelType> - static void GetMinMaxValueInternal(PixelType& minValue, - PixelType& maxValue, - const ImageAccessor& source) - { - // Deal with the special case of empty image - if (source.GetWidth() == 0 || - source.GetHeight() == 0) - { - minValue = 0; - maxValue = 0; - return; - } - - minValue = std::numeric_limits<PixelType>::max(); - maxValue = std::numeric_limits<PixelType>::min(); - - const unsigned int width = source.GetWidth(); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const PixelType* p = reinterpret_cast<const PixelType*>(source.GetConstRow(y)); - - for (unsigned int x = 0; x < width; x++, p++) - { - if (*p < minValue) - { - minValue = *p; - } - - if (*p > maxValue) - { - maxValue = *p; - } - } - } - } - - - - template <typename PixelType> - static void AddConstantInternal(ImageAccessor& image, - int64_t constant) - { - if (constant == 0) - { - return; - } - - const int64_t minValue = std::numeric_limits<PixelType>::min(); - const int64_t maxValue = std::numeric_limits<PixelType>::max(); - - for (unsigned int y = 0; y < image.GetHeight(); y++) - { - PixelType* p = reinterpret_cast<PixelType*>(image.GetRow(y)); - - for (unsigned int x = 0; x < image.GetWidth(); x++, p++) - { - int64_t v = static_cast<int64_t>(*p) + constant; - - if (v > maxValue) - { - *p = std::numeric_limits<PixelType>::max(); - } - else if (v < minValue) - { - *p = std::numeric_limits<PixelType>::min(); - } - else - { - *p = static_cast<PixelType>(v); - } - } - } - } - - - - template <typename PixelType, - bool UseRound> - static void MultiplyConstantInternal(ImageAccessor& image, - float factor) - { - if (std::abs(factor - 1.0f) <= std::numeric_limits<float>::epsilon()) - { - return; - } - - const int64_t minValue = std::numeric_limits<PixelType>::min(); - const int64_t maxValue = std::numeric_limits<PixelType>::max(); - const unsigned int width = image.GetWidth(); - - for (unsigned int y = 0; y < image.GetHeight(); y++) - { - PixelType* p = reinterpret_cast<PixelType*>(image.GetRow(y)); - - for (unsigned int x = 0; x < width; x++, p++) - { - int64_t v; - if (UseRound) - { - // The "round" operation is very costly - v = boost::math::llround(static_cast<float>(*p) * factor); - } - else - { - v = static_cast<int64_t>(static_cast<float>(*p) * factor); - } - - if (v > maxValue) - { - *p = std::numeric_limits<PixelType>::max(); - } - else if (v < minValue) - { - *p = std::numeric_limits<PixelType>::min(); - } - else - { - *p = static_cast<PixelType>(v); - } - } - } - } - - - template <typename PixelType, - bool UseRound> - static void ShiftScaleInternal(ImageAccessor& image, - float offset, - float scaling) - { - const float minFloatValue = static_cast<float>(std::numeric_limits<PixelType>::min()); - const float maxFloatValue = static_cast<float>(std::numeric_limits<PixelType>::max()); - const PixelType minPixelValue = std::numeric_limits<PixelType>::min(); - const PixelType maxPixelValue = std::numeric_limits<PixelType>::max(); - - const unsigned int height = image.GetHeight(); - const unsigned int width = image.GetWidth(); - - for (unsigned int y = 0; y < height; y++) - { - PixelType* p = reinterpret_cast<PixelType*>(image.GetRow(y)); - - for (unsigned int x = 0; x < width; x++, p++) - { - float v = (static_cast<float>(*p) + offset) * scaling; - - if (v > maxFloatValue) - { - *p = maxPixelValue; - } - else if (v < minFloatValue) - { - *p = minPixelValue; - } - else if (UseRound) - { - // The "round" operation is very costly - *p = static_cast<PixelType>(boost::math::iround(v)); - } - else - { - *p = static_cast<PixelType>(v); - } - } - } - } - - - void ImageProcessing::Copy(ImageAccessor& target, - const ImageAccessor& source) - { - if (target.GetWidth() != source.GetWidth() || - target.GetHeight() != source.GetHeight()) - { - throw OrthancException(ErrorCode_IncompatibleImageSize); - } - - if (target.GetFormat() != source.GetFormat()) - { - throw OrthancException(ErrorCode_IncompatibleImageFormat); - } - - unsigned int lineSize = GetBytesPerPixel(source.GetFormat()) * source.GetWidth(); - - assert(source.GetPitch() >= lineSize && target.GetPitch() >= lineSize); - - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - memcpy(target.GetRow(y), source.GetConstRow(y), lineSize); - } - } - - - void ImageProcessing::Convert(ImageAccessor& target, - const ImageAccessor& source) - { - if (target.GetWidth() != source.GetWidth() || - target.GetHeight() != source.GetHeight()) - { - throw OrthancException(ErrorCode_IncompatibleImageSize); - } - - if (source.GetFormat() == target.GetFormat()) - { - Copy(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale16 && - source.GetFormat() == PixelFormat_Grayscale8) - { - ConvertInternal<uint16_t, uint8_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_SignedGrayscale16 && - source.GetFormat() == PixelFormat_Grayscale8) - { - ConvertInternal<int16_t, uint8_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale8 && - source.GetFormat() == PixelFormat_Grayscale16) - { - ConvertInternal<uint8_t, uint16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_SignedGrayscale16 && - source.GetFormat() == PixelFormat_Grayscale16) - { - ConvertInternal<int16_t, uint16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale8 && - source.GetFormat() == PixelFormat_SignedGrayscale16) - { - ConvertInternal<uint8_t, int16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale16 && - source.GetFormat() == PixelFormat_SignedGrayscale16) - { - ConvertInternal<uint16_t, int16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale8 && - source.GetFormat() == PixelFormat_RGB24) - { - ConvertColorToGrayscale<uint8_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale16 && - source.GetFormat() == PixelFormat_RGB24) - { - ConvertColorToGrayscale<uint16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_SignedGrayscale16 && - source.GetFormat() == PixelFormat_RGB24) - { - ConvertColorToGrayscale<int16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Float32 && - source.GetFormat() == PixelFormat_Grayscale8) - { - ConvertGrayscaleToFloat<uint8_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Float32 && - source.GetFormat() == PixelFormat_Grayscale16) - { - ConvertGrayscaleToFloat<uint16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Float32 && - source.GetFormat() == PixelFormat_Grayscale32) - { - ConvertGrayscaleToFloat<uint32_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Float32 && - source.GetFormat() == PixelFormat_SignedGrayscale16) - { - ConvertGrayscaleToFloat<int16_t>(target, source); - return; - } - - if (target.GetFormat() == PixelFormat_Grayscale8 && - source.GetFormat() == PixelFormat_RGBA32) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++, q++) - { - *q = static_cast<uint8_t>((2126 * static_cast<uint32_t>(p[0]) + - 7152 * static_cast<uint32_t>(p[1]) + - 0722 * static_cast<uint32_t>(p[2])) / 10000); - p += 4; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_RGB24 && - source.GetFormat() == PixelFormat_RGBA32) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = p[0]; - q[1] = p[1]; - q[2] = p[2]; - p += 4; - q += 3; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_RGB24 && - source.GetFormat() == PixelFormat_BGRA32) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = p[2]; - q[1] = p[1]; - q[2] = p[0]; - p += 4; - q += 3; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_RGBA32 && - source.GetFormat() == PixelFormat_RGB24) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = p[0]; - q[1] = p[1]; - q[2] = p[2]; - q[3] = 255; // Set the alpha channel to full opacity - p += 3; - q += 4; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_RGB24 && - source.GetFormat() == PixelFormat_Grayscale8) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = *p; - q[1] = *p; - q[2] = *p; - p += 1; - q += 3; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_RGBA32 && - source.GetFormat() == PixelFormat_Grayscale8) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = *p; - q[1] = *p; - q[2] = *p; - q[3] = 255; - p += 1; - q += 4; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_BGRA32 && - source.GetFormat() == PixelFormat_Grayscale16) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint16_t* p = reinterpret_cast<const uint16_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - uint8_t value = (*p < 256 ? *p : 255); - q[0] = value; - q[1] = value; - q[2] = value; - q[3] = 255; - p += 1; - q += 4; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_BGRA32 && - source.GetFormat() == PixelFormat_SignedGrayscale16) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const int16_t* p = reinterpret_cast<const int16_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - uint8_t value; - if (*p < 0) - { - value = 0; - } - else if (*p > 255) - { - value = 255; - } - else - { - value = static_cast<uint8_t>(*p); - } - - q[0] = value; - q[1] = value; - q[2] = value; - q[3] = 255; - p += 1; - q += 4; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_BGRA32 && - source.GetFormat() == PixelFormat_RGB24) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = p[2]; - q[1] = p[1]; - q[2] = p[0]; - q[3] = 255; - p += 3; - q += 4; - } - } - - return; - } - - if (target.GetFormat() == PixelFormat_RGB24 && - source.GetFormat() == PixelFormat_RGB48) - { - for (unsigned int y = 0; y < source.GetHeight(); y++) - { - const uint16_t* p = reinterpret_cast<const uint16_t*>(source.GetConstRow(y)); - uint8_t* q = reinterpret_cast<uint8_t*>(target.GetRow(y)); - for (unsigned int x = 0; x < source.GetWidth(); x++) - { - q[0] = p[0] >> 8; - q[1] = p[1] >> 8; - q[2] = p[2] >> 8; - p += 3; - q += 3; - } - } - - return; - } - - throw OrthancException(ErrorCode_NotImplemented); - } - - - - void ImageProcessing::Set(ImageAccessor& image, - int64_t value) - { - switch (image.GetFormat()) - { - case PixelFormat_Grayscale8: - memset(image.GetBuffer(), static_cast<uint8_t>(value), image.GetPitch() * image.GetHeight()); - return; - - case PixelFormat_Grayscale16: - if (value == 0) - { - memset(image.GetBuffer(), 0, image.GetPitch() * image.GetHeight()); - } - else - { - SetInternal<uint16_t>(image, value); - } - return; - - case PixelFormat_Grayscale32: - if (value == 0) - { - memset(image.GetBuffer(), 0, image.GetPitch() * image.GetHeight()); - } - else - { - SetInternal<uint32_t>(image, value); - } - return; - - case PixelFormat_SignedGrayscale16: - if (value == 0) - { - memset(image.GetBuffer(), 0, image.GetPitch() * image.GetHeight()); - } - else - { - SetInternal<int16_t>(image, value); - } - return; - - case PixelFormat_Float32: - assert(sizeof(float) == 4); - SetInternal<float>(image, value); - return; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - void ImageProcessing::Set(ImageAccessor& image, - uint8_t red, - uint8_t green, - uint8_t blue, - uint8_t alpha) - { - uint8_t p[4]; - unsigned int size; - - switch (image.GetFormat()) - { - case PixelFormat_RGBA32: - p[0] = red; - p[1] = green; - p[2] = blue; - p[3] = alpha; - size = 4; - break; - - case PixelFormat_BGRA32: - p[0] = blue; - p[1] = green; - p[2] = red; - p[3] = alpha; - size = 4; - break; - - case PixelFormat_RGB24: - p[0] = red; - p[1] = green; - p[2] = blue; - size = 3; - break; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - - for (unsigned int y = 0; y < image.GetHeight(); y++) - { - uint8_t* q = reinterpret_cast<uint8_t*>(image.GetRow(y)); - - for (unsigned int x = 0; x < image.GetWidth(); x++) - { - for (unsigned int i = 0; i < size; i++) - { - q[i] = p[i]; - } - - q += size; - } - } - } - - - void ImageProcessing::ShiftRight(ImageAccessor& image, - unsigned int shift) - { - if (image.GetWidth() == 0 || - image.GetHeight() == 0 || - shift == 0) - { - // Nothing to do - return; - } - - throw OrthancException(ErrorCode_NotImplemented); - } - - - void ImageProcessing::GetMinMaxIntegerValue(int64_t& minValue, - int64_t& maxValue, - const ImageAccessor& image) - { - switch (image.GetFormat()) - { - case PixelFormat_Grayscale8: - { - uint8_t a, b; - GetMinMaxValueInternal<uint8_t>(a, b, image); - minValue = a; - maxValue = b; - break; - } - - case PixelFormat_Grayscale16: - { - uint16_t a, b; - GetMinMaxValueInternal<uint16_t>(a, b, image); - minValue = a; - maxValue = b; - break; - } - - case PixelFormat_Grayscale32: - { - uint32_t a, b; - GetMinMaxValueInternal<uint32_t>(a, b, image); - minValue = a; - maxValue = b; - break; - } - - case PixelFormat_SignedGrayscale16: - { - int16_t a, b; - GetMinMaxValueInternal<int16_t>(a, b, image); - minValue = a; - maxValue = b; - break; - } - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - void ImageProcessing::GetMinMaxFloatValue(float& minValue, - float& maxValue, - const ImageAccessor& image) - { - switch (image.GetFormat()) - { - case PixelFormat_Float32: - { - assert(sizeof(float) == 32); - float a, b; - GetMinMaxValueInternal<float>(a, b, image); - minValue = a; - maxValue = b; - break; - } - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - - void ImageProcessing::AddConstant(ImageAccessor& image, - int64_t value) - { - switch (image.GetFormat()) - { - case PixelFormat_Grayscale8: - AddConstantInternal<uint8_t>(image, value); - return; - - case PixelFormat_Grayscale16: - AddConstantInternal<uint16_t>(image, value); - return; - - case PixelFormat_SignedGrayscale16: - AddConstantInternal<int16_t>(image, value); - return; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - void ImageProcessing::MultiplyConstant(ImageAccessor& image, - float factor, - bool useRound) - { - switch (image.GetFormat()) - { - case PixelFormat_Grayscale8: - if (useRound) - { - MultiplyConstantInternal<uint8_t, true>(image, factor); - } - else - { - MultiplyConstantInternal<uint8_t, false>(image, factor); - } - return; - - case PixelFormat_Grayscale16: - if (useRound) - { - MultiplyConstantInternal<uint16_t, true>(image, factor); - } - else - { - MultiplyConstantInternal<uint16_t, false>(image, factor); - } - return; - - case PixelFormat_SignedGrayscale16: - if (useRound) - { - MultiplyConstantInternal<int16_t, true>(image, factor); - } - else - { - MultiplyConstantInternal<int16_t, false>(image, factor); - } - return; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - void ImageProcessing::ShiftScale(ImageAccessor& image, - float offset, - float scaling, - bool useRound) - { - switch (image.GetFormat()) - { - case PixelFormat_Grayscale8: - if (useRound) - { - ShiftScaleInternal<uint8_t, true>(image, offset, scaling); - } - else - { - ShiftScaleInternal<uint8_t, false>(image, offset, scaling); - } - return; - - case PixelFormat_Grayscale16: - if (useRound) - { - ShiftScaleInternal<uint16_t, true>(image, offset, scaling); - } - else - { - ShiftScaleInternal<uint16_t, false>(image, offset, scaling); - } - return; - - case PixelFormat_SignedGrayscale16: - if (useRound) - { - ShiftScaleInternal<int16_t, true>(image, offset, scaling); - } - else - { - ShiftScaleInternal<int16_t, false>(image, offset, scaling); - } - return; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - void ImageProcessing::Invert(ImageAccessor& image) - { - switch (image.GetFormat()) - { - case PixelFormat_Grayscale8: - { - for (unsigned int y = 0; y < image.GetHeight(); y++) - { - uint8_t* p = reinterpret_cast<uint8_t*>(image.GetRow(y)); - - for (unsigned int x = 0; x < image.GetWidth(); x++, p++) - { - *p = 255 - (*p); - } - } - - return; - } - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - - namespace - { - template <Orthanc::PixelFormat Format> - class BresenhamPixelWriter - { - private: - typedef typename PixelTraits<Format>::PixelType PixelType; - - Orthanc::ImageAccessor& image_; - PixelType value_; - - void PlotLineLow(int x0, - int y0, - int x1, - int y1) - { - int dx = x1 - x0; - int dy = y1 - y0; - int yi = 1; - - if (dy < 0) - { - yi = -1; - dy = -dy; - } - - int d = 2 * dy - dx; - int y = y0; - - for (int x = x0; x <= x1; x++) - { - Write(x, y); - - if (d > 0) - { - y = y + yi; - d = d - 2 * dx; - } - - d = d + 2*dy; - } - } - - void PlotLineHigh(int x0, - int y0, - int x1, - int y1) - { - int dx = x1 - x0; - int dy = y1 - y0; - int xi = 1; - - if (dx < 0) - { - xi = -1; - dx = -dx; - } - - int d = 2 * dx - dy; - int x = x0; - - for (int y = y0; y <= y1; y++) - { - Write(x, y); - - if (d > 0) - { - x = x + xi; - d = d - 2 * dy; - } - - d = d + 2 * dx; - } - } - - public: - BresenhamPixelWriter(Orthanc::ImageAccessor& image, - int64_t value) : - image_(image), - value_(PixelTraits<Format>::IntegerToPixel(value)) - { - } - - BresenhamPixelWriter(Orthanc::ImageAccessor& image, - const PixelType& value) : - image_(image), - value_(value) - { - } - - void Write(int x, - int y) - { - if (x >= 0 && - y >= 0 && - static_cast<unsigned int>(x) < image_.GetWidth() && - static_cast<unsigned int>(y) < image_.GetHeight()) - { - PixelType* p = reinterpret_cast<PixelType*>(image_.GetRow(y)); - p[x] = value_; - } - } - - void DrawSegment(int x0, - int y0, - int x1, - int y1) - { - // This is an implementation of Bresenham's line algorithm - // https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm#All_cases - - if (abs(y1 - y0) < abs(x1 - x0)) - { - if (x0 > x1) - { - PlotLineLow(x1, y1, x0, y0); - } - else - { - PlotLineLow(x0, y0, x1, y1); - } - } - else - { - if (y0 > y1) - { - PlotLineHigh(x1, y1, x0, y0); - } - else - { - PlotLineHigh(x0, y0, x1, y1); - } - } - } - }; - } - - - void ImageProcessing::DrawLineSegment(ImageAccessor& image, - int x0, - int y0, - int x1, - int y1, - int64_t value) - { - switch (image.GetFormat()) - { - case Orthanc::PixelFormat_Grayscale8: - { - BresenhamPixelWriter<Orthanc::PixelFormat_Grayscale8> writer(image, value); - writer.DrawSegment(x0, y0, x1, y1); - break; - } - - case Orthanc::PixelFormat_Grayscale16: - { - BresenhamPixelWriter<Orthanc::PixelFormat_Grayscale16> writer(image, value); - writer.DrawSegment(x0, y0, x1, y1); - break; - } - - case Orthanc::PixelFormat_SignedGrayscale16: - { - BresenhamPixelWriter<Orthanc::PixelFormat_SignedGrayscale16> writer(image, value); - writer.DrawSegment(x0, y0, x1, y1); - break; - } - - default: - throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); - } - } - - - void ImageProcessing::DrawLineSegment(ImageAccessor& image, - int x0, - int y0, - int x1, - int y1, - uint8_t red, - uint8_t green, - uint8_t blue, - uint8_t alpha) - { - switch (image.GetFormat()) - { - case Orthanc::PixelFormat_BGRA32: - { - PixelTraits<Orthanc::PixelFormat_BGRA32>::PixelType pixel; - pixel.red_ = red; - pixel.green_ = green; - pixel.blue_ = blue; - pixel.alpha_ = alpha; - - BresenhamPixelWriter<Orthanc::PixelFormat_BGRA32> writer(image, pixel); - writer.DrawSegment(x0, y0, x1, y1); - break; - } - - case Orthanc::PixelFormat_RGB24: - { - PixelTraits<Orthanc::PixelFormat_RGB24>::PixelType pixel; - pixel.red_ = red; - pixel.green_ = green; - pixel.blue_ = blue; - - BresenhamPixelWriter<Orthanc::PixelFormat_RGB24> writer(image, pixel); - writer.DrawSegment(x0, y0, x1, y1); - break; - } - - default: - throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); - } - } -}
--- a/Orthanc/Core/Images/ImageProcessing.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,103 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "ImageAccessor.h" - -#include <stdint.h> - -namespace Orthanc -{ - namespace ImageProcessing - { - void Copy(ImageAccessor& target, - const ImageAccessor& source); - - void Convert(ImageAccessor& target, - const ImageAccessor& source); - - void Set(ImageAccessor& image, - int64_t value); - - void Set(ImageAccessor& image, - uint8_t red, - uint8_t green, - uint8_t blue, - uint8_t alpha); - - void ShiftRight(ImageAccessor& target, - unsigned int shift); - - void GetMinMaxIntegerValue(int64_t& minValue, - int64_t& maxValue, - const ImageAccessor& image); - - void GetMinMaxFloatValue(float& minValue, - float& maxValue, - const ImageAccessor& image); - - void AddConstant(ImageAccessor& image, - int64_t value); - - // "useRound" is expensive - void MultiplyConstant(ImageAccessor& image, - float factor, - bool useRound); - - // "useRound" is expensive - void ShiftScale(ImageAccessor& image, - float offset, - float scaling, - bool useRound); - - void Invert(ImageAccessor& image); - - void DrawLineSegment(ImageAccessor& image, - int x0, - int y0, - int x1, - int y1, - int64_t value); - - void DrawLineSegment(ImageAccessor& image, - int x0, - int y0, - int x1, - int y1, - uint8_t red, - uint8_t green, - uint8_t blue, - uint8_t alpha); - }; -}
--- a/Orthanc/Core/Images/PixelTraits.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,267 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "../Enumerations.h" -#include "../OrthancException.h" - -#include <limits> - -namespace Orthanc -{ - template <PixelFormat format, - typename _PixelType> - struct IntegerPixelTraits - { - typedef _PixelType PixelType; - - ORTHANC_FORCE_INLINE - static PixelFormat GetPixelFormat() - { - return format; - } - - ORTHANC_FORCE_INLINE - static PixelType IntegerToPixel(int64_t value) - { - if (value < static_cast<int64_t>(std::numeric_limits<PixelType>::min()) || - value > static_cast<int64_t>(std::numeric_limits<PixelType>::max())) - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - else - { - return static_cast<PixelType>(value); - } - } - - ORTHANC_FORCE_INLINE - static void SetZero(PixelType& target) - { - target = 0; - } - - ORTHANC_FORCE_INLINE - static void SetMinValue(PixelType& target) - { - target = std::numeric_limits<PixelType>::min(); - } - - ORTHANC_FORCE_INLINE - static void SetMaxValue(PixelType& target) - { - target = std::numeric_limits<PixelType>::max(); - } - - ORTHANC_FORCE_INLINE - static void Copy(PixelType& target, - const PixelType& source) - { - target = source; - } - - ORTHANC_FORCE_INLINE - static float PixelToFloat(const PixelType& source) - { - return static_cast<float>(source); - } - - ORTHANC_FORCE_INLINE - static void FloatToPixel(PixelType& target, - float value) - { - if (value < static_cast<float>(std::numeric_limits<PixelType>::min())) - { - target = std::numeric_limits<PixelType>::min(); - } - else if (value > static_cast<float>(std::numeric_limits<PixelType>::max())) - { - target = std::numeric_limits<PixelType>::max(); - } - else - { - target = static_cast<PixelType>(value); - } - } - - ORTHANC_FORCE_INLINE - static bool IsEqual(const PixelType& a, - const PixelType& b) - { - return a == b; - } - }; - - - template <PixelFormat Format> - struct PixelTraits; - - - template <> - struct PixelTraits<PixelFormat_Grayscale8> : - public IntegerPixelTraits<PixelFormat_Grayscale8, uint8_t> - { - }; - - - template <> - struct PixelTraits<PixelFormat_Grayscale16> : - public IntegerPixelTraits<PixelFormat_Grayscale16, uint16_t> - { - }; - - - template <> - struct PixelTraits<PixelFormat_SignedGrayscale16> : - public IntegerPixelTraits<PixelFormat_SignedGrayscale16, int16_t> - { - }; - - - template <> - struct PixelTraits<PixelFormat_RGB24> - { - struct PixelType - { - uint8_t red_; - uint8_t green_; - uint8_t blue_; - }; - - ORTHANC_FORCE_INLINE - static PixelFormat GetPixelFormat() - { - return PixelFormat_RGB24; - } - - ORTHANC_FORCE_INLINE - static void SetZero(PixelType& target) - { - target.red_ = 0; - target.green_ = 0; - target.blue_ = 0; - } - - ORTHANC_FORCE_INLINE - static void Copy(PixelType& target, - const PixelType& source) - { - target.red_ = source.red_; - target.green_ = source.green_; - target.blue_ = source.blue_; - } - - ORTHANC_FORCE_INLINE - static bool IsEqual(const PixelType& a, - const PixelType& b) - { - return (a.red_ == b.red_ && - a.green_ == b.green_ && - a.blue_ == b.blue_); - } - - ORTHANC_FORCE_INLINE - static void FloatToPixel(PixelType& target, - float value) - { - uint8_t v; - PixelTraits<PixelFormat_Grayscale8>::FloatToPixel(v, value); - - target.red_ = v; - target.green_ = v; - target.blue_ = v; - } - }; - - - template <> - struct PixelTraits<PixelFormat_BGRA32> - { - struct PixelType - { - uint8_t blue_; - uint8_t green_; - uint8_t red_; - uint8_t alpha_; - }; - - ORTHANC_FORCE_INLINE - static PixelFormat GetPixelFormat() - { - return PixelFormat_BGRA32; - } - - ORTHANC_FORCE_INLINE - static void SetZero(PixelType& target) - { - target.blue_ = 0; - target.green_ = 0; - target.red_ = 0; - target.alpha_ = 0; - } - - ORTHANC_FORCE_INLINE - static void Copy(PixelType& target, - const PixelType& source) - { - target.blue_ = source.blue_; - target.green_ = source.green_; - target.red_ = source.red_; - target.alpha_ = source.alpha_; - } - - ORTHANC_FORCE_INLINE - static bool IsEqual(const PixelType& a, - const PixelType& b) - { - return (a.blue_ == b.blue_ && - a.green_ == b.green_ && - a.red_ == b.red_ && - a.alpha_ == b.alpha_); - } - - ORTHANC_FORCE_INLINE - static void FloatToPixel(PixelType& target, - float value) - { - uint8_t v; - PixelTraits<PixelFormat_Grayscale8>::FloatToPixel(v, value); - - target.blue_ = v; - target.green_ = v; - target.red_ = v; - target.alpha_ = 255; - } - }; -}
--- a/Orthanc/Core/Logging.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,194 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <iostream> - -#if !defined(ORTHANC_ENABLE_LOGGING) -# error The macro ORTHANC_ENABLE_LOGGING must be defined -#endif - -#if !defined(ORTHANC_ENABLE_LOGGING_PLUGIN) -# if ORTHANC_ENABLE_LOGGING == 1 -# error The macro ORTHANC_ENABLE_LOGGING_PLUGIN must be defined -# else -# define ORTHANC_ENABLE_LOGGING_PLUGIN 0 -# endif -#endif - -#if !defined(ORTHANC_ENABLE_LOGGING_STDIO) -# if ORTHANC_ENABLE_LOGGING == 1 -# error The macro ORTHANC_ENABLE_LOGGING_STDIO must be defined -# else -# define ORTHANC_ENABLE_LOGGING_STDIO 0 -# endif -#endif - -#if ORTHANC_ENABLE_LOGGING_PLUGIN == 1 -# include <orthanc/OrthancCPlugin.h> -#endif - -#include <boost/lexical_cast.hpp> - -namespace Orthanc -{ - namespace Logging - { -#if ORTHANC_ENABLE_LOGGING_PLUGIN == 1 - void Initialize(OrthancPluginContext* context); -#else - void Initialize(); -#endif - - void Finalize(); - - void Reset(); - - void Flush(); - - void EnableInfoLevel(bool enabled); - - void EnableTraceLevel(bool enabled); - - void SetTargetFile(const std::string& path); - - void SetTargetFolder(const std::string& path); - - struct NullStream : public std::ostream - { - NullStream() : - std::ios(0), - std::ostream(0) - { - } - - template <typename T> - std::ostream& operator<< (const T& message) - { - return *this; - } - }; - } -} - - -#if ORTHANC_ENABLE_LOGGING != 1 - -# define LOG(level) ::Orthanc::Logging::NullStream() -# define VLOG(level) ::Orthanc::Logging::NullStream() - - -#elif (ORTHANC_ENABLE_LOGGING_PLUGIN == 1 || \ - ORTHANC_ENABLE_LOGGING_STDIO == 1) - -# include <boost/noncopyable.hpp> -# define LOG(level) ::Orthanc::Logging::InternalLogger \ - (::Orthanc::Logging::InternalLevel_ ## level, __FILE__, __LINE__) -# define VLOG(level) ::Orthanc::Logging::InternalLogger \ - (::Orthanc::Logging::InternalLevel_TRACE, __FILE__, __LINE__) - -namespace Orthanc -{ - namespace Logging - { - enum InternalLevel - { - InternalLevel_ERROR, - InternalLevel_WARNING, - InternalLevel_INFO, - InternalLevel_TRACE - }; - - class InternalLogger : public boost::noncopyable - { - private: - InternalLevel level_; - std::string message_; - - public: - InternalLogger(InternalLevel level, - const char* file, - int line); - - ~InternalLogger(); - - template <typename T> - InternalLogger& operator<< (const T& message) - { - message_ += boost::lexical_cast<std::string>(message); - return *this; - } - }; - } -} - - - - -#else /* ORTHANC_ENABLE_LOGGING_PLUGIN == 0 && - ORTHANC_ENABLE_LOGGING_STDIO == 0 && - ORTHANC_ENABLE_LOGGING == 1 */ - -# include <boost/thread/mutex.hpp> -# define LOG(level) ::Orthanc::Logging::InternalLogger(#level, __FILE__, __LINE__) -# define VLOG(level) ::Orthanc::Logging::InternalLogger("TRACE", __FILE__, __LINE__) - -namespace Orthanc -{ - namespace Logging - { - class InternalLogger - { - private: - boost::mutex::scoped_lock lock_; - NullStream null_; - std::ostream* stream_; - - public: - InternalLogger(const char* level, - const char* file, - int line); - - ~InternalLogger(); - - template <typename T> - std::ostream& operator<< (const T& message) - { - return (*stream_) << boost::lexical_cast<std::string>(message); - } - }; - } -} - -#endif // ORTHANC_ENABLE_LOGGING
--- a/Orthanc/Core/MultiThreading/SharedMessageQueue.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,209 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "../PrecompiledHeaders.h" -#include "SharedMessageQueue.h" - - - -/** - * FIFO (queue): - * - * back front - * +--+--+--+--+--+--+--+--+--+--+--+ - * Enqueue -> | | | | | | | | | | | | - * | | | | | | | | | | | | -> Dequeue - * +--+--+--+--+--+--+--+--+--+--+--+ - * ^ - * | - * Make room here - * - * - * LIFO (stack): - * - * back front - * +--+--+--+--+--+--+--+--+--+--+--+ - * | | | | | | | | | | | | <- Enqueue - * | | | | | | | | | | | | -> Dequeue - * +--+--+--+--+--+--+--+--+--+--+--+ - * ^ - * | - * Make room here - **/ - - -namespace Orthanc -{ - SharedMessageQueue::SharedMessageQueue(unsigned int maxSize) : - isFifo_(true), - maxSize_(maxSize) - { - } - - - SharedMessageQueue::~SharedMessageQueue() - { - for (Queue::iterator it = queue_.begin(); it != queue_.end(); ++it) - { - delete *it; - } - } - - - void SharedMessageQueue::Enqueue(IDynamicObject* message) - { - boost::mutex::scoped_lock lock(mutex_); - - if (maxSize_ != 0 && queue_.size() > maxSize_) - { - if (isFifo_) - { - // Too many elements in the queue: Make room - delete queue_.front(); - queue_.pop_front(); - } - else - { - // Too many elements in the stack: Make room - delete queue_.back(); - queue_.pop_back(); - } - } - - if (isFifo_) - { - // Queue policy (FIFO) - queue_.push_back(message); - } - else - { - // Stack policy (LIFO) - queue_.push_front(message); - } - - elementAvailable_.notify_one(); - } - - - IDynamicObject* SharedMessageQueue::Dequeue(int32_t millisecondsTimeout) - { - boost::mutex::scoped_lock lock(mutex_); - - // Wait for a message to arrive in the FIFO queue - while (queue_.empty()) - { - if (millisecondsTimeout == 0) - { - elementAvailable_.wait(lock); - } - else - { - bool success = elementAvailable_.timed_wait - (lock, boost::posix_time::milliseconds(millisecondsTimeout)); - if (!success) - { - return NULL; - } - } - } - - std::auto_ptr<IDynamicObject> message(queue_.front()); - queue_.pop_front(); - - if (queue_.empty()) - { - emptied_.notify_all(); - } - - return message.release(); - } - - - - bool SharedMessageQueue::WaitEmpty(int32_t millisecondsTimeout) - { - boost::mutex::scoped_lock lock(mutex_); - - // Wait for the queue to become empty - while (!queue_.empty()) - { - if (millisecondsTimeout == 0) - { - emptied_.wait(lock); - } - else - { - if (!emptied_.timed_wait - (lock, boost::posix_time::milliseconds(millisecondsTimeout))) - { - return false; - } - } - } - - return true; - } - - - void SharedMessageQueue::SetFifoPolicy() - { - boost::mutex::scoped_lock lock(mutex_); - isFifo_ = true; - } - - void SharedMessageQueue::SetLifoPolicy() - { - boost::mutex::scoped_lock lock(mutex_); - isFifo_ = false; - } - - void SharedMessageQueue::Clear() - { - boost::mutex::scoped_lock lock(mutex_); - - if (queue_.empty()) - { - return; - } - else - { - while (!queue_.empty()) - { - std::auto_ptr<IDynamicObject> message(queue_.front()); - queue_.pop_front(); - } - - emptied_.notify_all(); - } - } -}
--- a/Orthanc/Core/MultiThreading/SharedMessageQueue.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,85 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "../IDynamicObject.h" - -#include <stdint.h> -#include <list> -#include <boost/thread.hpp> - -namespace Orthanc -{ - class SharedMessageQueue : public boost::noncopyable - { - private: - typedef std::list<IDynamicObject*> Queue; - - bool isFifo_; - unsigned int maxSize_; - Queue queue_; - boost::mutex mutex_; - boost::condition_variable elementAvailable_; - boost::condition_variable emptied_; - - public: - explicit SharedMessageQueue(unsigned int maxSize = 0); - - ~SharedMessageQueue(); - - // This transfers the ownership of the message - void Enqueue(IDynamicObject* message); - - // The caller is responsible to delete the dequeud message! - IDynamicObject* Dequeue(int32_t millisecondsTimeout); - - bool WaitEmpty(int32_t millisecondsTimeout); - - bool IsFifoPolicy() const - { - return isFifo_; - } - - bool IsLifoPolicy() const - { - return !isFifo_; - } - - void SetFifoPolicy(); - - void SetLifoPolicy(); - - void Clear(); - }; -}
--- a/Orthanc/Core/OrthancException.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,77 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <stdint.h> -#include <string> -#include "Enumerations.h" - -namespace Orthanc -{ - class OrthancException - { - protected: - ErrorCode errorCode_; - HttpStatus httpStatus_; - - public: - explicit OrthancException(ErrorCode errorCode) : - errorCode_(errorCode), - httpStatus_(ConvertErrorCodeToHttpStatus(errorCode)) - { - } - - OrthancException(ErrorCode errorCode, - HttpStatus httpStatus) : - errorCode_(errorCode), - httpStatus_(httpStatus) - { - } - - ErrorCode GetErrorCode() const - { - return errorCode_; - } - - HttpStatus GetHttpStatus() const - { - return httpStatus_; - } - - const char* What() const - { - return EnumerationToString(errorCode_); - } - }; -}
--- a/Orthanc/Core/PrecompiledHeaders.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,34 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "PrecompiledHeaders.h"
--- a/Orthanc/Core/PrecompiledHeaders.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,76 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#if defined(_WIN32) && !defined(NOMINMAX) -#define NOMINMAX -#endif - -#if ORTHANC_USE_PRECOMPILED_HEADERS == 1 - -#include <boost/date_time/posix_time/posix_time.hpp> -#include <boost/filesystem.hpp> -#include <boost/lexical_cast.hpp> -#include <boost/locale.hpp> -#include <boost/regex.hpp> -#include <boost/thread.hpp> -#include <boost/thread/shared_mutex.hpp> - -#include <json/value.h> - -#if ORTHANC_ENABLE_PUGIXML == 1 -# include <pugixml.hpp> -#endif - -#include "Enumerations.h" -#include "Logging.h" -#include "OrthancException.h" -#include "Toolbox.h" - -#if ORTHANC_ENABLE_DCMTK == 1 -// Headers from DCMTK used in Orthanc headers -# include <dcmtk/dcmdata/dcdatset.h> -# include <dcmtk/dcmdata/dcfilefo.h> -# include <dcmtk/dcmdata/dcmetinf.h> -# include <dcmtk/dcmdata/dcpixseq.h> -#endif - -#if ORTHANC_ENABLE_DCMTK_NETWORKING == 1 -# include "DicomNetworking/DicomServer.h" - -// Headers from DCMTK used in Orthanc headers -# include <dcmtk/dcmnet/dimse.h> -#endif - -#endif
--- a/Orthanc/Core/SQLite/Connection.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,399 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../PrecompiledHeaders.h" -#endif - -#include "Connection.h" -#include "OrthancSQLiteException.h" - -#include <memory> -#include <cassert> -#include <string.h> - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../Logging.h" -#endif - -#include "sqlite3.h" - - -namespace Orthanc -{ - namespace SQLite - { - Connection::Connection() : - db_(NULL), - transactionNesting_(0), - needsRollback_(false) - { - } - - - Connection::~Connection() - { - Close(); - } - - - void Connection::CheckIsOpen() const - { - if (!db_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteNotOpened); - } - } - - void Connection::Open(const std::string& path) - { - if (db_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteAlreadyOpened); - } - - int err = sqlite3_open(path.c_str(), &db_); - if (err != SQLITE_OK) - { - Close(); - db_ = NULL; - throw OrthancSQLiteException(ErrorCode_SQLiteCannotOpen); - } - - // Execute PRAGMAs at this point - // http://www.sqlite.org/pragma.html - Execute("PRAGMA FOREIGN_KEYS=ON;"); - Execute("PRAGMA RECURSIVE_TRIGGERS=ON;"); - } - - void Connection::OpenInMemory() - { - Open(":memory:"); - } - - void Connection::Close() - { - ClearCache(); - - if (db_) - { - sqlite3_close(db_); - db_ = NULL; - } - } - - void Connection::ClearCache() - { - for (CachedStatements::iterator - it = cachedStatements_.begin(); - it != cachedStatements_.end(); ++it) - { - delete it->second; - } - - cachedStatements_.clear(); - } - - - StatementReference& Connection::GetCachedStatement(const StatementId& id, - const char* sql) - { - CachedStatements::iterator i = cachedStatements_.find(id); - if (i != cachedStatements_.end()) - { - if (i->second->GetReferenceCount() >= 1) - { - throw OrthancSQLiteException(ErrorCode_SQLiteStatementAlreadyUsed); - } - - return *i->second; - } - else - { - StatementReference* statement = new StatementReference(db_, sql); - cachedStatements_[id] = statement; - return *statement; - } - } - - - bool Connection::Execute(const char* sql) - { -#if ORTHANC_SQLITE_STANDALONE != 1 - VLOG(1) << "SQLite::Connection::Execute " << sql; -#endif - - CheckIsOpen(); - - int error = sqlite3_exec(db_, sql, NULL, NULL, NULL); - if (error == SQLITE_ERROR) - { -#if ORTHANC_SQLITE_STANDALONE != 1 - LOG(ERROR) << "SQLite execute error: " << sqlite3_errmsg(db_) - << " (" << sqlite3_extended_errcode(db_) << ")"; -#endif - - throw OrthancSQLiteException(ErrorCode_SQLiteExecute); - } - else - { - return error == SQLITE_OK; - } - } - - int Connection::ExecuteAndReturnErrorCode(const char* sql) - { - CheckIsOpen(); - return sqlite3_exec(db_, sql, NULL, NULL, NULL); - } - - // Info querying ------------------------------------------------------------- - - bool Connection::IsSQLValid(const char* sql) - { - sqlite3_stmt* stmt = NULL; - if (sqlite3_prepare_v2(db_, sql, -1, &stmt, NULL) != SQLITE_OK) - return false; - - sqlite3_finalize(stmt); - return true; - } - - bool Connection::DoesTableOrIndexExist(const char* name, - const char* type) const - { - // Our SQL is non-mutating, so this cast is OK. - Statement statement(const_cast<Connection&>(*this), - "SELECT name FROM sqlite_master WHERE type=? AND name=?"); - statement.BindString(0, type); - statement.BindString(1, name); - return statement.Step(); // Table exists if any row was returned. - } - - bool Connection::DoesTableExist(const char* table_name) const - { - return DoesTableOrIndexExist(table_name, "table"); - } - - bool Connection::DoesIndexExist(const char* index_name) const - { - return DoesTableOrIndexExist(index_name, "index"); - } - - bool Connection::DoesColumnExist(const char* table_name, const char* column_name) const - { - std::string sql("PRAGMA TABLE_INFO("); - sql.append(table_name); - sql.append(")"); - - // Our SQL is non-mutating, so this cast is OK. - Statement statement(const_cast<Connection&>(*this), sql.c_str()); - - while (statement.Step()) { - if (!statement.ColumnString(1).compare(column_name)) - return true; - } - return false; - } - - int64_t Connection::GetLastInsertRowId() const - { - return sqlite3_last_insert_rowid(db_); - } - - int Connection::GetLastChangeCount() const - { - return sqlite3_changes(db_); - } - - int Connection::GetErrorCode() const - { - return sqlite3_errcode(db_); - } - - int Connection::GetLastErrno() const - { - int err = 0; - if (SQLITE_OK != sqlite3_file_control(db_, NULL, SQLITE_LAST_ERRNO, &err)) - return -2; - - return err; - } - - const char* Connection::GetErrorMessage() const - { - return sqlite3_errmsg(db_); - } - - - bool Connection::BeginTransaction() - { - if (needsRollback_) - { - assert(transactionNesting_ > 0); - - // When we're going to rollback, fail on this begin and don't actually - // mark us as entering the nested transaction. - return false; - } - - bool success = true; - if (!transactionNesting_) - { - needsRollback_ = false; - - Statement begin(*this, SQLITE_FROM_HERE, "BEGIN TRANSACTION"); - if (!begin.Run()) - return false; - } - transactionNesting_++; - return success; - } - - void Connection::RollbackTransaction() - { - if (!transactionNesting_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteRollbackWithoutTransaction); - } - - transactionNesting_--; - - if (transactionNesting_ > 0) - { - // Mark the outermost transaction as needing rollback. - needsRollback_ = true; - return; - } - - DoRollback(); - } - - bool Connection::CommitTransaction() - { - if (!transactionNesting_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteCommitWithoutTransaction); - } - transactionNesting_--; - - if (transactionNesting_ > 0) - { - // Mark any nested transactions as failing after we've already got one. - return !needsRollback_; - } - - if (needsRollback_) - { - DoRollback(); - return false; - } - - Statement commit(*this, SQLITE_FROM_HERE, "COMMIT"); - return commit.Run(); - } - - void Connection::DoRollback() - { - Statement rollback(*this, SQLITE_FROM_HERE, "ROLLBACK"); - rollback.Run(); - needsRollback_ = false; - } - - - - - - - static void ScalarFunctionCaller(sqlite3_context* rawContext, - int argc, - sqlite3_value** argv) - { - FunctionContext context(rawContext, argc, argv); - - void* payload = sqlite3_user_data(rawContext); - assert(payload != NULL); - - IScalarFunction& func = *reinterpret_cast<IScalarFunction*>(payload); - func.Compute(context); - } - - - static void ScalarFunctionDestroyer(void* payload) - { - assert(payload != NULL); - delete reinterpret_cast<IScalarFunction*>(payload); - } - - - IScalarFunction* Connection::Register(IScalarFunction* func) - { - int err = sqlite3_create_function_v2(db_, - func->GetName(), - func->GetCardinality(), - SQLITE_UTF8, - func, - ScalarFunctionCaller, - NULL, - NULL, - ScalarFunctionDestroyer); - - if (err != SQLITE_OK) - { - delete func; - throw OrthancSQLiteException(ErrorCode_SQLiteRegisterFunction); - } - - return func; - } - - - void Connection::FlushToDisk() - { -#if ORTHANC_SQLITE_STANDALONE != 1 - VLOG(1) << "SQLite::Connection::FlushToDisk"; -#endif - - int err = sqlite3_wal_checkpoint(db_, NULL); - - if (err != SQLITE_OK) - { - throw OrthancSQLiteException(ErrorCode_SQLiteFlush); - } - } - } -}
--- a/Orthanc/Core/SQLite/Connection.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,175 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "Statement.h" -#include "IScalarFunction.h" -#include "SQLiteTypes.h" - -#include <string> -#include <map> - -#define SQLITE_FROM_HERE ::Orthanc::SQLite::StatementId(__FILE__, __LINE__) - -namespace Orthanc -{ - namespace SQLite - { - class Connection : NonCopyable - { - friend class Statement; - friend class Transaction; - - private: - // All cached statements. Keeping a reference to these statements means that - // they'll remain active. - typedef std::map<StatementId, StatementReference*> CachedStatements; - CachedStatements cachedStatements_; - - // The actual sqlite database. Will be NULL before Init has been called or if - // Init resulted in an error. - sqlite3* db_; - - // Number of currently-nested transactions. - int transactionNesting_; - - // True if any of the currently nested transactions have been rolled back. - // When we get to the outermost transaction, this will determine if we do - // a rollback instead of a commit. - bool needsRollback_; - - void ClearCache(); - - void CheckIsOpen() const; - - sqlite3* GetWrappedObject() - { - return db_; - } - - StatementReference& GetCachedStatement(const StatementId& id, - const char* sql); - - bool DoesTableOrIndexExist(const char* name, - const char* type) const; - - void DoRollback(); - - public: - // The database is opened by calling Open[InMemory](). Any uncommitted - // transactions will be rolled back when this object is deleted. - Connection(); - ~Connection(); - - void Open(const std::string& path); - - void OpenInMemory(); - - void Close(); - - bool Execute(const char* sql); - - bool Execute(const std::string& sql) - { - return Execute(sql.c_str()); - } - - void FlushToDisk(); - - IScalarFunction* Register(IScalarFunction* func); // Takes the ownership of the function - - // Info querying ------------------------------------------------------------- - - // Used to check a |sql| statement for syntactic validity. If the - // statement is valid SQL, returns true. - bool IsSQLValid(const char* sql); - - // Returns true if the given table exists. - bool DoesTableExist(const char* table_name) const; - - // Returns true if the given index exists. - bool DoesIndexExist(const char* index_name) const; - - // Returns true if a column with the given name exists in the given table. - bool DoesColumnExist(const char* table_name, const char* column_name) const; - - // Returns sqlite's internal ID for the last inserted row. Valid only - // immediately after an insert. - int64_t GetLastInsertRowId() const; - - // Returns sqlite's count of the number of rows modified by the last - // statement executed. Will be 0 if no statement has executed or the database - // is closed. - int GetLastChangeCount() const; - - // Errors -------------------------------------------------------------------- - - // Returns the error code associated with the last sqlite operation. - int GetErrorCode() const; - - // Returns the errno associated with GetErrorCode(). See - // SQLITE_LAST_ERRNO in SQLite documentation. - int GetLastErrno() const; - - // Returns a pointer to a statically allocated string associated with the - // last sqlite operation. - const char* GetErrorMessage() const; - - - // Diagnostics (for unit tests) ---------------------------------------------- - - int ExecuteAndReturnErrorCode(const char* sql); - - bool HasCachedStatement(const StatementId& id) const - { - return cachedStatements_.find(id) != cachedStatements_.end(); - } - - int GetTransactionNesting() const - { - return transactionNesting_; - } - - // Transactions -------------------------------------------------------------- - - bool BeginTransaction(); - void RollbackTransaction(); - bool CommitTransaction(); - }; - } -}
--- a/Orthanc/Core/SQLite/FunctionContext.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,127 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of the CHU of Liege, nor the names of its - * contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../PrecompiledHeaders.h" -#endif - -#include "FunctionContext.h" -#include "OrthancSQLiteException.h" - -#include <string> - -#include "sqlite3.h" - -namespace Orthanc -{ - namespace SQLite - { - FunctionContext::FunctionContext(struct sqlite3_context* context, - int argc, - Internals::SQLiteValue** argv) - { - assert(context != NULL); - assert(argc >= 0); - assert(argv != NULL); - - context_ = context; - argc_ = static_cast<unsigned int>(argc); - argv_ = argv; - } - - void FunctionContext::CheckIndex(unsigned int index) const - { - if (index >= argc_) - { - throw OrthancSQLiteException(ErrorCode_ParameterOutOfRange); - } - } - - ColumnType FunctionContext::GetColumnType(unsigned int index) const - { - CheckIndex(index); - return static_cast<SQLite::ColumnType>(sqlite3_value_type(argv_[index])); - } - - int FunctionContext::GetIntValue(unsigned int index) const - { - CheckIndex(index); - return sqlite3_value_int(argv_[index]); - } - - int64_t FunctionContext::GetInt64Value(unsigned int index) const - { - CheckIndex(index); - return sqlite3_value_int64(argv_[index]); - } - - double FunctionContext::GetDoubleValue(unsigned int index) const - { - CheckIndex(index); - return sqlite3_value_double(argv_[index]); - } - - std::string FunctionContext::GetStringValue(unsigned int index) const - { - CheckIndex(index); - return std::string(reinterpret_cast<const char*>(sqlite3_value_text(argv_[index]))); - } - - bool FunctionContext::IsNullValue(unsigned int index) const - { - CheckIndex(index); - return sqlite3_value_type(argv_[index]) == SQLITE_NULL; - } - - void FunctionContext::SetNullResult() - { - sqlite3_result_null(context_); - } - - void FunctionContext::SetIntResult(int value) - { - sqlite3_result_int(context_, value); - } - - void FunctionContext::SetDoubleResult(double value) - { - sqlite3_result_double(context_, value); - } - - void FunctionContext::SetStringResult(const std::string& str) - { - sqlite3_result_text(context_, str.data(), str.size(), SQLITE_TRANSIENT); - } - } -}
--- a/Orthanc/Core/SQLite/FunctionContext.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,85 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of the CHU of Liege, nor the names of its - * contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "Statement.h" - -namespace Orthanc -{ - namespace SQLite - { - class FunctionContext : public NonCopyable - { - friend class Connection; - - private: - struct sqlite3_context* context_; - unsigned int argc_; - Internals::SQLiteValue** argv_; - - void CheckIndex(unsigned int index) const; - - public: - FunctionContext(struct sqlite3_context* context, - int argc, - Internals::SQLiteValue** argv); - - ColumnType GetColumnType(unsigned int index) const; - - unsigned int GetParameterCount() const - { - return argc_; - } - - int GetIntValue(unsigned int index) const; - - int64_t GetInt64Value(unsigned int index) const; - - double GetDoubleValue(unsigned int index) const; - - std::string GetStringValue(unsigned int index) const; - - bool IsNullValue(unsigned int index) const; - - void SetNullResult(); - - void SetIntResult(int value); - - void SetDoubleResult(double value); - - void SetStringResult(const std::string& str); - }; - } -}
--- a/Orthanc/Core/SQLite/IScalarFunction.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,58 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of the CHU of Liege, nor the names of its - * contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "NonCopyable.h" -#include "FunctionContext.h" - -namespace Orthanc -{ - namespace SQLite - { - class IScalarFunction : public NonCopyable - { - public: - virtual ~IScalarFunction() - { - } - - virtual const char* GetName() const = 0; - - virtual unsigned int GetCardinality() const = 0; - - virtual void Compute(FunctionContext& context) = 0; - }; - } -}
--- a/Orthanc/Core/SQLite/ITransaction.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "NonCopyable.h" - -namespace Orthanc -{ - namespace SQLite - { - class ITransaction : public NonCopyable - { - public: - virtual ~ITransaction() - { - } - - // Begins the transaction. This uses the default sqlite "deferred" transaction - // type, which means that the DB lock is lazily acquired the next time the - // database is accessed, not in the begin transaction command. - virtual void Begin() = 0; - - // Rolls back the transaction. This will happen automatically if you do - // nothing when the transaction goes out of scope. - virtual void Rollback() = 0; - - // Commits the transaction, returning true on success. - virtual void Commit() = 0; - }; - } -}
--- a/Orthanc/Core/SQLite/NonCopyable.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,60 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -namespace Orthanc -{ - namespace SQLite - { - // This class mimics "boost::noncopyable" - class NonCopyable - { - private: - NonCopyable(const NonCopyable&); - - NonCopyable& operator= (const NonCopyable&); - - protected: - NonCopyable() - { - } - - ~NonCopyable() - { - } - }; - } -}
--- a/Orthanc/Core/SQLite/OrthancSQLiteException.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,154 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - - -#if ORTHANC_ENABLE_SQLITE != 1 -# error Macro ORTHANC_ENABLE_SQLITE must be set to 1 to use SQLite -#endif - - -#if ORTHANC_SQLITE_STANDALONE == 1 -#include <stdexcept> - -namespace Orthanc -{ - namespace SQLite - { - // Auto-generated by "Resources/GenerateErrorCodes.py" - enum ErrorCode - { - ErrorCode_ParameterOutOfRange, - ErrorCode_BadParameterType, - ErrorCode_SQLiteNotOpened, - ErrorCode_SQLiteAlreadyOpened, - ErrorCode_SQLiteCannotOpen, - ErrorCode_SQLiteStatementAlreadyUsed, - ErrorCode_SQLiteExecute, - ErrorCode_SQLiteRollbackWithoutTransaction, - ErrorCode_SQLiteCommitWithoutTransaction, - ErrorCode_SQLiteRegisterFunction, - ErrorCode_SQLiteFlush, - ErrorCode_SQLiteCannotRun, - ErrorCode_SQLiteCannotStep, - ErrorCode_SQLiteBindOutOfRange, - ErrorCode_SQLitePrepareStatement, - ErrorCode_SQLiteTransactionAlreadyStarted, - ErrorCode_SQLiteTransactionCommit, - ErrorCode_SQLiteTransactionBegin - }; - - class OrthancSQLiteException : public ::std::runtime_error - { - public: - OrthancSQLiteException(ErrorCode error) : - ::std::runtime_error(EnumerationToString(error)) - { - } - - // Auto-generated by "Resources/GenerateErrorCodes.py" - static const char* EnumerationToString(ErrorCode code) - { - switch (code) - { - case ErrorCode_ParameterOutOfRange: - return "Parameter out of range"; - - case ErrorCode_BadParameterType: - return "Bad type for a parameter"; - - case ErrorCode_SQLiteNotOpened: - return "SQLite: The database is not opened"; - - case ErrorCode_SQLiteAlreadyOpened: - return "SQLite: Connection is already open"; - - case ErrorCode_SQLiteCannotOpen: - return "SQLite: Unable to open the database"; - - case ErrorCode_SQLiteStatementAlreadyUsed: - return "SQLite: This cached statement is already being referred to"; - - case ErrorCode_SQLiteExecute: - return "SQLite: Cannot execute a command"; - - case ErrorCode_SQLiteRollbackWithoutTransaction: - return "SQLite: Rolling back a nonexistent transaction (have you called Begin()?)"; - - case ErrorCode_SQLiteCommitWithoutTransaction: - return "SQLite: Committing a nonexistent transaction"; - - case ErrorCode_SQLiteRegisterFunction: - return "SQLite: Unable to register a function"; - - case ErrorCode_SQLiteFlush: - return "SQLite: Unable to flush the database"; - - case ErrorCode_SQLiteCannotRun: - return "SQLite: Cannot run a cached statement"; - - case ErrorCode_SQLiteCannotStep: - return "SQLite: Cannot step over a cached statement"; - - case ErrorCode_SQLiteBindOutOfRange: - return "SQLite: Bing a value while out of range (serious error)"; - - case ErrorCode_SQLitePrepareStatement: - return "SQLite: Cannot prepare a cached statement"; - - case ErrorCode_SQLiteTransactionAlreadyStarted: - return "SQLite: Beginning the same transaction twice"; - - case ErrorCode_SQLiteTransactionCommit: - return "SQLite: Failure when committing the transaction"; - - case ErrorCode_SQLiteTransactionBegin: - return "SQLite: Cannot start a transaction"; - - default: - return "Unknown error code"; - } - } - }; - } -} - -#else -# include "../OrthancException.h" -# define OrthancSQLiteException ::Orthanc::OrthancException -#endif
--- a/Orthanc/Core/SQLite/SQLiteTypes.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,73 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of the CHU of Liege, nor the names of its - * contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -struct sqlite3; -struct sqlite3_context; -struct sqlite3_stmt; - -#if !defined(ORTHANC_SQLITE_VERSION) -#error Please define macro ORTHANC_SQLITE_VERSION -#endif - - -/** - * "sqlite3_value" is defined as: - * - "typedef struct Mem sqlite3_value;" up to SQLite <= 3.18.2 - * - "typedef struct sqlite3_value sqlite3_value;" since SQLite >= 3.19.0. - * We create our own copy of this typedef to get around this API incompatibility. - * https://github.com/mackyle/sqlite/commit/db1d90df06a78264775a14d22c3361eb5b42be17 - **/ - -#if ORTHANC_SQLITE_VERSION < 3019000 -struct Mem; -#else -struct sqlite3_value; -#endif - -namespace Orthanc -{ - namespace SQLite - { - namespace Internals - { -#if ORTHANC_SQLITE_VERSION < 3019000 - typedef struct ::Mem SQLiteValue; -#else - typedef struct ::sqlite3_value SQLiteValue; -#endif - } - } -}
--- a/Orthanc/Core/SQLite/Statement.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,356 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../PrecompiledHeaders.h" -#endif - -#include "Statement.h" -#include "Connection.h" - -#include <string.h> -#include <stdio.h> -#include <algorithm> - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../Logging.h" -#endif - -#include "sqlite3.h" - -#if defined(_MSC_VER) -#define snprintf _snprintf -#endif - -namespace Orthanc -{ - namespace SQLite - { - int Statement::CheckError(int err, ErrorCode code) const - { - bool succeeded = (err == SQLITE_OK || err == SQLITE_ROW || err == SQLITE_DONE); - if (!succeeded) - { -#if ORTHANC_SQLITE_STANDALONE != 1 - char buffer[128]; - snprintf(buffer, sizeof(buffer) - 1, "SQLite error code %d", err); - LOG(ERROR) << buffer; -#endif - - throw OrthancSQLiteException(code); - } - - return err; - } - - void Statement::CheckOk(int err, ErrorCode code) const - { - if (err == SQLITE_RANGE) - { - // Binding to a non-existent variable is evidence of a serious error. - throw OrthancSQLiteException(ErrorCode_SQLiteBindOutOfRange); - } - else if (err != SQLITE_OK) - { -#if ORTHANC_SQLITE_STANDALONE != 1 - char buffer[128]; - snprintf(buffer, sizeof(buffer) - 1, "SQLite error code %d", err); - LOG(ERROR) << buffer; -#endif - - throw OrthancSQLiteException(code); - } - } - - - Statement::Statement(Connection& database, - const StatementId& id, - const std::string& sql) : - reference_(database.GetCachedStatement(id, sql.c_str())) - { - Reset(true); - } - - - Statement::Statement(Connection& database, - const StatementId& id, - const char* sql) : - reference_(database.GetCachedStatement(id, sql)) - { - Reset(true); - } - - - Statement::Statement(Connection& database, - const std::string& sql) : - reference_(database.GetWrappedObject(), sql.c_str()) - { - } - - - Statement::Statement(Connection& database, - const char* sql) : - reference_(database.GetWrappedObject(), sql) - { - } - - - bool Statement::Run() - { -#if ORTHANC_SQLITE_STANDALONE != 1 - VLOG(1) << "SQLite::Statement::Run " << sqlite3_sql(GetStatement()); -#endif - - return CheckError(sqlite3_step(GetStatement()), ErrorCode_SQLiteCannotRun) == SQLITE_DONE; - } - - bool Statement::Step() - { -#if ORTHANC_SQLITE_STANDALONE != 1 - VLOG(1) << "SQLite::Statement::Step " << sqlite3_sql(GetStatement()); -#endif - - return CheckError(sqlite3_step(GetStatement()), ErrorCode_SQLiteCannotStep) == SQLITE_ROW; - } - - void Statement::Reset(bool clear_bound_vars) - { - // We don't call CheckError() here because sqlite3_reset() returns - // the last error that Step() caused thereby generating a second - // spurious error callback. - if (clear_bound_vars) - sqlite3_clear_bindings(GetStatement()); - //VLOG(1) << "SQLite::Statement::Reset"; - sqlite3_reset(GetStatement()); - } - - std::string Statement::GetOriginalSQLStatement() - { - return std::string(sqlite3_sql(GetStatement())); - } - - - void Statement::BindNull(int col) - { - CheckOk(sqlite3_bind_null(GetStatement(), col + 1), - ErrorCode_BadParameterType); - } - - void Statement::BindBool(int col, bool val) - { - BindInt(col, val ? 1 : 0); - } - - void Statement::BindInt(int col, int val) - { - CheckOk(sqlite3_bind_int(GetStatement(), col + 1, val), - ErrorCode_BadParameterType); - } - - void Statement::BindInt64(int col, int64_t val) - { - CheckOk(sqlite3_bind_int64(GetStatement(), col + 1, val), - ErrorCode_BadParameterType); - } - - void Statement::BindDouble(int col, double val) - { - CheckOk(sqlite3_bind_double(GetStatement(), col + 1, val), - ErrorCode_BadParameterType); - } - - void Statement::BindCString(int col, const char* val) - { - CheckOk(sqlite3_bind_text(GetStatement(), col + 1, val, -1, SQLITE_TRANSIENT), - ErrorCode_BadParameterType); - } - - void Statement::BindString(int col, const std::string& val) - { - CheckOk(sqlite3_bind_text(GetStatement(), - col + 1, - val.data(), - val.size(), - SQLITE_TRANSIENT), - ErrorCode_BadParameterType); - } - - /*void Statement::BindString16(int col, const string16& value) - { - BindString(col, UTF16ToUTF8(value)); - }*/ - - void Statement::BindBlob(int col, const void* val, int val_len) - { - CheckOk(sqlite3_bind_blob(GetStatement(), col + 1, val, val_len, SQLITE_TRANSIENT), - ErrorCode_BadParameterType); - } - - - int Statement::ColumnCount() const - { - return sqlite3_column_count(GetStatement()); - } - - - ColumnType Statement::GetColumnType(int col) const - { - // Verify that our enum matches sqlite's values. - assert(COLUMN_TYPE_INTEGER == SQLITE_INTEGER); - assert(COLUMN_TYPE_FLOAT == SQLITE_FLOAT); - assert(COLUMN_TYPE_TEXT == SQLITE_TEXT); - assert(COLUMN_TYPE_BLOB == SQLITE_BLOB); - assert(COLUMN_TYPE_NULL == SQLITE_NULL); - - return static_cast<ColumnType>(sqlite3_column_type(GetStatement(), col)); - } - - ColumnType Statement::GetDeclaredColumnType(int col) const - { - std::string column_type(sqlite3_column_decltype(GetStatement(), col)); - std::transform(column_type.begin(), column_type.end(), column_type.begin(), tolower); - - if (column_type == "integer") - return COLUMN_TYPE_INTEGER; - else if (column_type == "float") - return COLUMN_TYPE_FLOAT; - else if (column_type == "text") - return COLUMN_TYPE_TEXT; - else if (column_type == "blob") - return COLUMN_TYPE_BLOB; - - return COLUMN_TYPE_NULL; - } - - bool Statement::ColumnIsNull(int col) const - { - return sqlite3_column_type(GetStatement(), col) == SQLITE_NULL; - } - - bool Statement::ColumnBool(int col) const - { - return !!ColumnInt(col); - } - - int Statement::ColumnInt(int col) const - { - return sqlite3_column_int(GetStatement(), col); - } - - int64_t Statement::ColumnInt64(int col) const - { - return sqlite3_column_int64(GetStatement(), col); - } - - double Statement::ColumnDouble(int col) const - { - return sqlite3_column_double(GetStatement(), col); - } - - std::string Statement::ColumnString(int col) const - { - const char* str = reinterpret_cast<const char*>( - sqlite3_column_text(GetStatement(), col)); - int len = sqlite3_column_bytes(GetStatement(), col); - - std::string result; - if (str && len > 0) - result.assign(str, len); - return result; - } - - /*string16 Statement::ColumnString16(int col) const - { - std::string s = ColumnString(col); - return !s.empty() ? UTF8ToUTF16(s) : string16(); - }*/ - - int Statement::ColumnByteLength(int col) const - { - return sqlite3_column_bytes(GetStatement(), col); - } - - const void* Statement::ColumnBlob(int col) const - { - return sqlite3_column_blob(GetStatement(), col); - } - - bool Statement::ColumnBlobAsString(int col, std::string* blob) - { - const void* p = ColumnBlob(col); - size_t len = ColumnByteLength(col); - blob->resize(len); - if (blob->size() != len) { - return false; - } - blob->assign(reinterpret_cast<const char*>(p), len); - return true; - } - - /*bool Statement::ColumnBlobAsString16(int col, string16* val) const - { - const void* data = ColumnBlob(col); - size_t len = ColumnByteLength(col) / sizeof(char16); - val->resize(len); - if (val->size() != len) - return false; - val->assign(reinterpret_cast<const char16*>(data), len); - return true; - }*/ - - /*bool Statement::ColumnBlobAsVector(int col, std::vector<char>* val) const - { - val->clear(); - - const void* data = sqlite3_column_blob(GetStatement(), col); - int len = sqlite3_column_bytes(GetStatement(), col); - if (data && len > 0) { - val->resize(len); - memcpy(&(*val)[0], data, len); - } - return true; - }*/ - - /*bool Statement::ColumnBlobAsVector( - int col, - std::vector<unsigned char>* val) const - { - return ColumnBlobAsVector(col, reinterpret_cast< std::vector<char>* >(val)); - }*/ - - } -}
--- a/Orthanc/Core/SQLite/Statement.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,174 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "NonCopyable.h" -#include "OrthancSQLiteException.h" -#include "StatementId.h" -#include "StatementReference.h" - -#include <vector> -#include <stdint.h> - -#if ORTHANC_BUILD_UNIT_TESTS == 1 -# include <gtest/gtest_prod.h> -#endif - - -namespace Orthanc -{ - namespace SQLite - { - class Connection; - - // Possible return values from ColumnType in a statement. These - // should match the values in sqlite3.h. - enum ColumnType - { - COLUMN_TYPE_INTEGER = 1, - COLUMN_TYPE_FLOAT = 2, - COLUMN_TYPE_TEXT = 3, - COLUMN_TYPE_BLOB = 4, - COLUMN_TYPE_NULL = 5 - }; - - class Statement : public NonCopyable - { - friend class Connection; - -#if ORTHANC_BUILD_UNIT_TESTS == 1 - FRIEND_TEST(SQLStatementTest, Run); - FRIEND_TEST(SQLStatementTest, Reset); -#endif - - private: - StatementReference reference_; - - int CheckError(int err, - ErrorCode code) const; - - void CheckOk(int err, - ErrorCode code) const; - - struct sqlite3_stmt* GetStatement() const - { - return reference_.GetWrappedObject(); - } - - public: - Statement(Connection& database, - const std::string& sql); - - Statement(Connection& database, - const StatementId& id, - const std::string& sql); - - Statement(Connection& database, - const char* sql); - - Statement(Connection& database, - const StatementId& id, - const char* sql); - - ~Statement() - { - Reset(); - } - - bool Run(); - - bool Step(); - - // Diagnostics -------------------------------------------------------------- - - std::string GetOriginalSQLStatement(); - - - // Binding ------------------------------------------------------------------- - - // These all take a 0-based argument index - void BindNull(int col); - void BindBool(int col, bool val); - void BindInt(int col, int val); - void BindInt64(int col, int64_t val); - void BindDouble(int col, double val); - void BindCString(int col, const char* val); - void BindString(int col, const std::string& val); - //void BindString16(int col, const string16& value); - void BindBlob(int col, const void* value, int value_len); - - - // Retrieving ---------------------------------------------------------------- - - // Returns the number of output columns in the result. - int ColumnCount() const; - - // Returns the type associated with the given column. - // - // Watch out: the type may be undefined if you've done something to cause a - // "type conversion." This means requesting the value of a column of a type - // where that type is not the native type. For safety, call ColumnType only - // on a column before getting the value out in any way. - ColumnType GetColumnType(int col) const; - ColumnType GetDeclaredColumnType(int col) const; - - // These all take a 0-based argument index. - bool ColumnIsNull(int col) const ; - bool ColumnBool(int col) const; - int ColumnInt(int col) const; - int64_t ColumnInt64(int col) const; - double ColumnDouble(int col) const; - std::string ColumnString(int col) const; - //string16 ColumnString16(int col) const; - - // When reading a blob, you can get a raw pointer to the underlying data, - // along with the length, or you can just ask us to copy the blob into a - // vector. Danger! ColumnBlob may return NULL if there is no data! - int ColumnByteLength(int col) const; - const void* ColumnBlob(int col) const; - bool ColumnBlobAsString(int col, std::string* blob); - //bool ColumnBlobAsString16(int col, string16* val) const; - //bool ColumnBlobAsVector(int col, std::vector<char>* val) const; - //bool ColumnBlobAsVector(int col, std::vector<unsigned char>* val) const; - - // Resets the statement to its initial condition. This includes any current - // result row, and also the bound variables if the |clear_bound_vars| is true. - void Reset(bool clear_bound_vars = true); - }; - } -}
--- a/Orthanc/Core/SQLite/StatementId.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,58 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../PrecompiledHeaders.h" -#endif - -#include "StatementId.h" - -#include <string.h> - -namespace Orthanc -{ - namespace SQLite - { - bool StatementId::operator< (const StatementId& other) const - { - if (line_ != other.line_) - return line_ < other.line_; - - return strcmp(file_, other.file_) < 0; - } - } -}
--- a/Orthanc/Core/SQLite/StatementId.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,60 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -namespace Orthanc -{ - namespace SQLite - { - class StatementId - { - private: - const char* file_; - int line_; - - StatementId(); // Forbidden - - public: - StatementId(const char* file, int line) : file_(file), line_(line) - { - } - - bool operator< (const StatementId& other) const; - }; - } -}
--- a/Orthanc/Core/SQLite/StatementReference.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,157 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../PrecompiledHeaders.h" -#endif - -#include "StatementReference.h" -#include "OrthancSQLiteException.h" - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../Logging.h" -#endif - -#include <string> -#include <cassert> -#include "sqlite3.h" - -namespace Orthanc -{ - namespace SQLite - { - bool StatementReference::IsRoot() const - { - return root_ == NULL; - } - - StatementReference::StatementReference() - { - root_ = NULL; - refCount_ = 0; - statement_ = NULL; - assert(IsRoot()); - } - - StatementReference::StatementReference(sqlite3* database, - const char* sql) - { - if (database == NULL || sql == NULL) - { - throw OrthancSQLiteException(ErrorCode_ParameterOutOfRange); - } - - root_ = NULL; - refCount_ = 0; - - int error = sqlite3_prepare_v2(database, sql, -1, &statement_, NULL); - if (error != SQLITE_OK) - { -#if ORTHANC_SQLITE_STANDALONE != 1 - LOG(ERROR) << "SQLite: " << sqlite3_errmsg(database) - << " (" << sqlite3_extended_errcode(database) << ")"; -#endif - - throw OrthancSQLiteException(ErrorCode_SQLitePrepareStatement); - } - - assert(IsRoot()); - } - - StatementReference::StatementReference(StatementReference& other) - { - refCount_ = 0; - - if (other.IsRoot()) - { - root_ = &other; - } - else - { - root_ = other.root_; - } - - root_->refCount_++; - statement_ = root_->statement_; - - assert(!IsRoot()); - } - - StatementReference::~StatementReference() - { - if (IsRoot()) - { - if (refCount_ != 0) - { - // There remain references to this object. We cannot throw - // an exception because: - // http://www.parashift.com/c++-faq/dtors-shouldnt-throw.html - -#if ORTHANC_SQLITE_STANDALONE != 1 - LOG(ERROR) << "Bad value of the reference counter"; -#endif - } - else if (statement_ != NULL) - { - sqlite3_finalize(statement_); - } - } - else - { - if (root_->refCount_ == 0) - { - // There remain references to this object. We cannot throw - // an exception because: - // http://www.parashift.com/c++-faq/dtors-shouldnt-throw.html - -#if ORTHANC_SQLITE_STANDALONE != 1 - LOG(ERROR) << "Bad value of the reference counter"; -#endif - } - else - { - root_->refCount_--; - } - } - } - - uint32_t StatementReference::GetReferenceCount() const - { - return refCount_; - } - } -}
--- a/Orthanc/Core/SQLite/StatementReference.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,80 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "NonCopyable.h" -#include "SQLiteTypes.h" - -#include <stdint.h> -#include <cassert> -#include <stdlib.h> - - -namespace Orthanc -{ - namespace SQLite - { - class StatementReference : NonCopyable - { - private: - StatementReference* root_; // Only used for non-root nodes - uint32_t refCount_; // Only used for root node - struct sqlite3_stmt* statement_; - - bool IsRoot() const; - - public: - StatementReference(); - - StatementReference(sqlite3* database, - const char* sql); - - StatementReference(StatementReference& other); - - ~StatementReference(); - - uint32_t GetReferenceCount() const; - - struct sqlite3_stmt* GetWrappedObject() const - { - assert(statement_ != NULL); - return statement_; - } - }; - } -}
--- a/Orthanc/Core/SQLite/Transaction.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,104 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#if ORTHANC_SQLITE_STANDALONE != 1 -#include "../PrecompiledHeaders.h" -#endif - -#include "Transaction.h" -#include "OrthancSQLiteException.h" - -namespace Orthanc -{ - namespace SQLite - { - Transaction::Transaction(Connection& connection) : - connection_(connection), - isOpen_(false) - { - } - - Transaction::~Transaction() - { - if (isOpen_) - { - connection_.RollbackTransaction(); - } - } - - void Transaction::Begin() - { - if (isOpen_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteTransactionAlreadyStarted); - } - - isOpen_ = connection_.BeginTransaction(); - if (!isOpen_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteTransactionBegin); - } - } - - void Transaction::Rollback() - { - if (!isOpen_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteRollbackWithoutTransaction); - } - - isOpen_ = false; - - connection_.RollbackTransaction(); - } - - void Transaction::Commit() - { - if (!isOpen_) - { - throw OrthancSQLiteException(ErrorCode_SQLiteRollbackWithoutTransaction); - } - - isOpen_ = false; - - if (!connection_.CommitTransaction()) - { - throw OrthancSQLiteException(ErrorCode_SQLiteTransactionCommit); - } - } - } -}
--- a/Orthanc/Core/SQLite/Transaction.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,71 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * - * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@gmail.com>, - * Medical Physics Department, CHU of Liege, Belgium - * - * Copyright (c) 2012 The Chromium Authors. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following disclaimer - * in the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Google Inc., the name of the CHU of Liege, - * nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written - * permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - **/ - - -#pragma once - -#include "Connection.h" -#include "ITransaction.h" - -namespace Orthanc -{ - namespace SQLite - { - class Transaction : public ITransaction - { - private: - Connection& connection_; - - // True when the transaction is open, false when it's already been committed - // or rolled back. - bool isOpen_; - - public: - explicit Transaction(Connection& connection); - - virtual ~Transaction(); - - // Returns true when there is a transaction that has been successfully begun. - bool IsOpen() const { return isOpen_; } - - virtual void Begin(); - - virtual void Rollback(); - - virtual void Commit(); - }; - } -}
--- a/Orthanc/Core/SystemToolbox.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,563 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "PrecompiledHeaders.h" -#include "SystemToolbox.h" - - -#if defined(_WIN32) -# include <windows.h> -# include <process.h> // For "_spawnvp()" and "_getpid()" -#else -# include <unistd.h> // For "execvp()" -# include <sys/wait.h> // For "waitpid()" -#endif - - -#if defined(__APPLE__) && defined(__MACH__) -# include <mach-o/dyld.h> /* _NSGetExecutablePath */ -# include <limits.h> /* PATH_MAX */ -#endif - - -#if defined(__linux__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) -# include <limits.h> /* PATH_MAX */ -# include <signal.h> -# include <unistd.h> -#endif - - -#if defined(__OpenBSD__) -# include <sys/sysctl.h> // For "sysctl", "CTL_KERN" and "KERN_PROC_ARGS" -#endif - - -#include "Logging.h" -#include "OrthancException.h" -#include "Toolbox.h" - -#include <boost/filesystem.hpp> -#include <boost/filesystem/fstream.hpp> -#include <boost/date_time/posix_time/posix_time.hpp> - - -namespace Orthanc -{ - static bool finish_; - static ServerBarrierEvent barrierEvent_; - -#if defined(_WIN32) - static BOOL WINAPI ConsoleControlHandler(DWORD dwCtrlType) - { - // http://msdn.microsoft.com/en-us/library/ms683242(v=vs.85).aspx - finish_ = true; - return true; - } -#else - static void SignalHandler(int signal) - { - if (signal == SIGHUP) - { - barrierEvent_ = ServerBarrierEvent_Reload; - } - - finish_ = true; - } -#endif - - - static ServerBarrierEvent ServerBarrierInternal(const bool* stopFlag) - { -#if defined(_WIN32) - SetConsoleCtrlHandler(ConsoleControlHandler, true); -#else - signal(SIGINT, SignalHandler); - signal(SIGQUIT, SignalHandler); - signal(SIGTERM, SignalHandler); - signal(SIGHUP, SignalHandler); -#endif - - // Active loop that awakens every 100ms - finish_ = false; - barrierEvent_ = ServerBarrierEvent_Stop; - while (!(*stopFlag || finish_)) - { - SystemToolbox::USleep(100 * 1000); - } - -#if defined(_WIN32) - SetConsoleCtrlHandler(ConsoleControlHandler, false); -#else - signal(SIGINT, NULL); - signal(SIGQUIT, NULL); - signal(SIGTERM, NULL); - signal(SIGHUP, NULL); -#endif - - return barrierEvent_; - } - - - ServerBarrierEvent SystemToolbox::ServerBarrier(const bool& stopFlag) - { - return ServerBarrierInternal(&stopFlag); - } - - - ServerBarrierEvent SystemToolbox::ServerBarrier() - { - const bool stopFlag = false; - return ServerBarrierInternal(&stopFlag); - } - - - void SystemToolbox::USleep(uint64_t microSeconds) - { -#if defined(_WIN32) - ::Sleep(static_cast<DWORD>(microSeconds / static_cast<uint64_t>(1000))); -#elif defined(__linux__) || defined(__APPLE__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__native_client__) - usleep(microSeconds); -#else -#error Support your platform here -#endif - } - - - static std::streamsize GetStreamSize(std::istream& f) - { - // http://www.cplusplus.com/reference/iostream/istream/tellg/ - f.seekg(0, std::ios::end); - std::streamsize size = f.tellg(); - f.seekg(0, std::ios::beg); - - return size; - } - - - void SystemToolbox::ReadFile(std::string& content, - const std::string& path) - { - if (!IsRegularFile(path)) - { - LOG(ERROR) << "The path does not point to a regular file: " << path; - throw OrthancException(ErrorCode_RegularFileExpected); - } - - boost::filesystem::ifstream f; - f.open(path, std::ifstream::in | std::ifstream::binary); - if (!f.good()) - { - throw OrthancException(ErrorCode_InexistentFile); - } - - std::streamsize size = GetStreamSize(f); - content.resize(static_cast<size_t>(size)); - if (size != 0) - { - f.read(reinterpret_cast<char*>(&content[0]), size); - } - - f.close(); - } - - - bool SystemToolbox::ReadHeader(std::string& header, - const std::string& path, - size_t headerSize) - { - if (!IsRegularFile(path)) - { - LOG(ERROR) << "The path does not point to a regular file: " << path; - throw OrthancException(ErrorCode_RegularFileExpected); - } - - boost::filesystem::ifstream f; - f.open(path, std::ifstream::in | std::ifstream::binary); - if (!f.good()) - { - throw OrthancException(ErrorCode_InexistentFile); - } - - bool full = true; - - { - std::streamsize size = GetStreamSize(f); - if (size <= 0) - { - headerSize = 0; - full = false; - } - else if (static_cast<size_t>(size) < headerSize) - { - headerSize = static_cast<size_t>(size); // Truncate to the size of the file - full = false; - } - } - - header.resize(headerSize); - if (headerSize != 0) - { - f.read(reinterpret_cast<char*>(&header[0]), headerSize); - } - - f.close(); - - return full; - } - - - void SystemToolbox::WriteFile(const void* content, - size_t size, - const std::string& path) - { - boost::filesystem::ofstream f; - f.open(path, std::ofstream::out | std::ofstream::binary); - if (!f.good()) - { - throw OrthancException(ErrorCode_CannotWriteFile); - } - - if (size != 0) - { - f.write(reinterpret_cast<const char*>(content), size); - - if (!f.good()) - { - f.close(); - throw OrthancException(ErrorCode_FileStorageCannotWrite); - } - } - - f.close(); - } - - - void SystemToolbox::WriteFile(const std::string& content, - const std::string& path) - { - WriteFile(content.size() > 0 ? content.c_str() : NULL, - content.size(), path); - } - - - void SystemToolbox::RemoveFile(const std::string& path) - { - if (boost::filesystem::exists(path)) - { - if (IsRegularFile(path)) - { - boost::filesystem::remove(path); - } - else - { - throw OrthancException(ErrorCode_RegularFileExpected); - } - } - } - - - uint64_t SystemToolbox::GetFileSize(const std::string& path) - { - try - { - return static_cast<uint64_t>(boost::filesystem::file_size(path)); - } - catch (boost::filesystem::filesystem_error&) - { - throw OrthancException(ErrorCode_InexistentFile); - } - } - - - void SystemToolbox::MakeDirectory(const std::string& path) - { - if (boost::filesystem::exists(path)) - { - if (!boost::filesystem::is_directory(path)) - { - throw OrthancException(ErrorCode_DirectoryOverFile); - } - } - else - { - if (!boost::filesystem::create_directories(path)) - { - throw OrthancException(ErrorCode_MakeDirectory); - } - } - } - - - bool SystemToolbox::IsExistingFile(const std::string& path) - { - return boost::filesystem::exists(path); - } - - -#if defined(_WIN32) - static std::string GetPathToExecutableInternal() - { - // Yes, this is ugly, but there is no simple way to get the - // required buffer size, so we use a big constant - std::vector<char> buffer(32768); - /*int bytes =*/ GetModuleFileNameA(NULL, &buffer[0], static_cast<DWORD>(buffer.size() - 1)); - return std::string(&buffer[0]); - } - -#elif defined(__linux__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) - static std::string GetPathToExecutableInternal() - { - // NOTE: For FreeBSD, using KERN_PROC_PATHNAME might be a better alternative - - std::vector<char> buffer(PATH_MAX + 1); - ssize_t bytes = readlink("/proc/self/exe", &buffer[0], buffer.size() - 1); - if (bytes == 0) - { - throw OrthancException(ErrorCode_PathToExecutable); - } - - return std::string(&buffer[0]); - } - -#elif defined(__APPLE__) && defined(__MACH__) - static std::string GetPathToExecutableInternal() - { - char pathbuf[PATH_MAX + 1]; - unsigned int bufsize = static_cast<int>(sizeof(pathbuf)); - - _NSGetExecutablePath( pathbuf, &bufsize); - - return std::string(pathbuf); - } - -#elif defined(__OpenBSD__) - static std::string GetPathToExecutableInternal() - { - // This is an adapted version of the patch proposed in issue #64 - // without an explicit call to "malloc()" to prevent memory leak - // https://bitbucket.org/sjodogne/orthanc/issues/64/add-openbsd-support - // https://stackoverflow.com/q/31494901/881731 - - const int mib[4] = { CTL_KERN, KERN_PROC_ARGS, getpid(), KERN_PROC_ARGV }; - - size_t len; - if (sysctl(mib, 4, NULL, &len, NULL, 0) == -1) - { - throw OrthancException(ErrorCode_PathToExecutable); - } - - std::string tmp; - tmp.resize(len); - - char** buffer = reinterpret_cast<char**>(&tmp[0]); - - if (sysctl(mib, 4, buffer, &len, NULL, 0) == -1) - { - throw OrthancException(ErrorCode_PathToExecutable); - } - else - { - return std::string(buffer[0]); - } - } - -#else -#error Support your platform here -#endif - - - std::string SystemToolbox::GetPathToExecutable() - { - boost::filesystem::path p(GetPathToExecutableInternal()); - return boost::filesystem::absolute(p).string(); - } - - - std::string SystemToolbox::GetDirectoryOfExecutable() - { - boost::filesystem::path p(GetPathToExecutableInternal()); - return boost::filesystem::absolute(p.parent_path()).string(); - } - - - void SystemToolbox::ExecuteSystemCommand(const std::string& command, - const std::vector<std::string>& arguments) - { - // Convert the arguments as a C array - std::vector<char*> args(arguments.size() + 2); - - args.front() = const_cast<char*>(command.c_str()); - - for (size_t i = 0; i < arguments.size(); i++) - { - args[i + 1] = const_cast<char*>(arguments[i].c_str()); - } - - args.back() = NULL; - - int status; - -#if defined(_WIN32) - // http://msdn.microsoft.com/en-us/library/275khfab.aspx - status = static_cast<int>(_spawnvp(_P_OVERLAY, command.c_str(), &args[0])); - -#else - int pid = fork(); - - if (pid == -1) - { - // Error in fork() -#if ORTHANC_ENABLE_LOGGING == 1 - LOG(ERROR) << "Cannot fork a child process"; -#endif - - throw OrthancException(ErrorCode_SystemCommand); - } - else if (pid == 0) - { - // Execute the system command in the child process - execvp(command.c_str(), &args[0]); - - // We should never get here - _exit(1); - } - else - { - // Wait for the system command to exit - waitpid(pid, &status, 0); - } -#endif - - if (status != 0) - { -#if ORTHANC_ENABLE_LOGGING == 1 - LOG(ERROR) << "System command failed with status code " << status; -#endif - - throw OrthancException(ErrorCode_SystemCommand); - } - } - - - int SystemToolbox::GetProcessId() - { -#if defined(_WIN32) - return static_cast<int>(_getpid()); -#else - return static_cast<int>(getpid()); -#endif - } - - - bool SystemToolbox::IsRegularFile(const std::string& path) - { - namespace fs = boost::filesystem; - - try - { - if (fs::exists(path)) - { - fs::file_status status = fs::status(path); - return (status.type() == boost::filesystem::regular_file || - status.type() == boost::filesystem::reparse_file); // Fix BitBucket issue #11 - } - } - catch (fs::filesystem_error&) - { - } - - return false; - } - - - FILE* SystemToolbox::OpenFile(const std::string& path, - FileMode mode) - { -#if defined(_WIN32) - // TODO Deal with special characters by converting to the current locale -#endif - - const char* m; - switch (mode) - { - case FileMode_ReadBinary: - m = "rb"; - break; - - case FileMode_WriteBinary: - m = "wb"; - break; - - default: - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - - return fopen(path.c_str(), m); - } - - - static boost::posix_time::ptime GetNow(bool utc) - { - if (utc) - { - return boost::posix_time::second_clock::universal_time(); - } - else - { - return boost::posix_time::second_clock::local_time(); - } - } - - - std::string SystemToolbox::GetNowIsoString(bool utc) - { - return boost::posix_time::to_iso_string(GetNow(utc)); - } - - - void SystemToolbox::GetNowDicom(std::string& date, - std::string& time, - bool utc) - { - boost::posix_time::ptime now = GetNow(utc); - tm tm = boost::posix_time::to_tm(now); - - char s[32]; - sprintf(s, "%04d%02d%02d", tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday); - date.assign(s); - - // TODO milliseconds - sprintf(s, "%02d%02d%02d.%06d", tm.tm_hour, tm.tm_min, tm.tm_sec, 0); - time.assign(s); - } -}
--- a/Orthanc/Core/SystemToolbox.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,102 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#if !defined(ORTHANC_SANDBOXED) -# error The macro ORTHANC_SANDBOXED must be defined -#endif - -#if ORTHANC_SANDBOXED == 1 -# error The namespace SystemToolbox cannot be used in sandboxed environments -#endif - -#include "Enumerations.h" - -#include <vector> -#include <string> -#include <stdint.h> - -namespace Orthanc -{ - namespace SystemToolbox - { - void USleep(uint64_t microSeconds); - - ServerBarrierEvent ServerBarrier(const bool& stopFlag); - - ServerBarrierEvent ServerBarrier(); - - void ReadFile(std::string& content, - const std::string& path); - - bool ReadHeader(std::string& header, - const std::string& path, - size_t headerSize); - - void WriteFile(const void* content, - size_t size, - const std::string& path); - - void WriteFile(const std::string& content, - const std::string& path); - - void RemoveFile(const std::string& path); - - uint64_t GetFileSize(const std::string& path); - - void MakeDirectory(const std::string& path); - - bool IsExistingFile(const std::string& path); - - std::string GetPathToExecutable(); - - std::string GetDirectoryOfExecutable(); - - void ExecuteSystemCommand(const std::string& command, - const std::vector<std::string>& arguments); - - int GetProcessId(); - - bool IsRegularFile(const std::string& path); - - FILE* OpenFile(const std::string& path, - FileMode mode); - - std::string GetNowIsoString(bool utc); - - void GetNowDicom(std::string& date, - std::string& time, - bool utc); - } -}
--- a/Orthanc/Core/Toolbox.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1526 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "PrecompiledHeaders.h" -#include "Toolbox.h" - -#include "OrthancException.h" -#include "Logging.h" - -#include <boost/algorithm/string/case_conv.hpp> -#include <boost/algorithm/string/replace.hpp> -#include <boost/lexical_cast.hpp> -#include <boost/regex.hpp> -#include <boost/uuid/sha1.hpp> - -#include <string> -#include <stdint.h> -#include <string.h> -#include <algorithm> -#include <ctype.h> - - -#if ORTHANC_ENABLE_MD5 == 1 -# include "../Resources/ThirdParty/md5/md5.h" -#endif - -#if ORTHANC_ENABLE_BASE64 == 1 -# include "../Resources/ThirdParty/base64/base64.h" -#endif - -#if ORTHANC_ENABLE_LOCALE == 1 -# include <boost/locale.hpp> -#endif - - -#if defined(_MSC_VER) && (_MSC_VER < 1800) -// Patch for the missing "_strtoll" symbol when compiling with Visual Studio < 2013 -extern "C" -{ - int64_t _strtoi64(const char *nptr, char **endptr, int base); - int64_t strtoll(const char *nptr, char **endptr, int base) - { - return _strtoi64(nptr, endptr, base); - } -} -#endif - - -#if defined(_WIN32) -# include <windows.h> // For ::Sleep -#endif - - -#if ORTHANC_ENABLE_PUGIXML == 1 -# include "ChunkedBuffer.h" -# include <pugixml.hpp> -#endif - - -// Inclusions for UUID -// http://stackoverflow.com/a/1626302 - -extern "C" -{ -#if defined(_WIN32) -# include <rpc.h> -#else -# include <uuid/uuid.h> -#endif -} - - - -namespace Orthanc -{ - void Toolbox::LinesIterator::FindEndOfLine() - { - lineEnd_ = lineStart_; - - while (lineEnd_ < content_.size() && - content_[lineEnd_] != '\n' && - content_[lineEnd_] != '\r') - { - lineEnd_ += 1; - } - } - - - Toolbox::LinesIterator::LinesIterator(const std::string& content) : - content_(content), - lineStart_(0) - { - FindEndOfLine(); - } - - - bool Toolbox::LinesIterator::GetLine(std::string& target) const - { - assert(lineStart_ <= content_.size() && - lineEnd_ <= content_.size() && - lineStart_ <= lineEnd_); - - if (lineStart_ == content_.size()) - { - return false; - } - else - { - target = content_.substr(lineStart_, lineEnd_ - lineStart_); - return true; - } - } - - - void Toolbox::LinesIterator::Next() - { - lineStart_ = lineEnd_; - - if (lineStart_ != content_.size()) - { - assert(content_[lineStart_] == '\r' || - content_[lineStart_] == '\n'); - - char second; - - if (content_[lineStart_] == '\r') - { - second = '\n'; - } - else - { - second = '\r'; - } - - lineStart_ += 1; - - if (lineStart_ < content_.size() && - content_[lineStart_] == second) - { - lineStart_ += 1; - } - - FindEndOfLine(); - } - } - - - void Toolbox::ToUpperCase(std::string& s) - { - std::transform(s.begin(), s.end(), s.begin(), toupper); - } - - - void Toolbox::ToLowerCase(std::string& s) - { - std::transform(s.begin(), s.end(), s.begin(), tolower); - } - - - void Toolbox::ToUpperCase(std::string& result, - const std::string& source) - { - result = source; - ToUpperCase(result); - } - - void Toolbox::ToLowerCase(std::string& result, - const std::string& source) - { - result = source; - ToLowerCase(result); - } - - - void Toolbox::SplitUriComponents(UriComponents& components, - const std::string& uri) - { - static const char URI_SEPARATOR = '/'; - - components.clear(); - - if (uri.size() == 0 || - uri[0] != URI_SEPARATOR) - { - throw OrthancException(ErrorCode_UriSyntax); - } - - // Count the number of slashes in the URI to make an assumption - // about the number of components in the URI - unsigned int estimatedSize = 0; - for (unsigned int i = 0; i < uri.size(); i++) - { - if (uri[i] == URI_SEPARATOR) - estimatedSize++; - } - - components.reserve(estimatedSize - 1); - - unsigned int start = 1; - unsigned int end = 1; - while (end < uri.size()) - { - // This is the loop invariant - assert(uri[start - 1] == '/' && (end >= start)); - - if (uri[end] == '/') - { - components.push_back(std::string(&uri[start], end - start)); - end++; - start = end; - } - else - { - end++; - } - } - - if (start < uri.size()) - { - components.push_back(std::string(&uri[start], end - start)); - } - - for (size_t i = 0; i < components.size(); i++) - { - if (components[i].size() == 0) - { - // Empty component, as in: "/coucou//e" - throw OrthancException(ErrorCode_UriSyntax); - } - } - } - - - void Toolbox::TruncateUri(UriComponents& target, - const UriComponents& source, - size_t fromLevel) - { - target.clear(); - - if (source.size() > fromLevel) - { - target.resize(source.size() - fromLevel); - - size_t j = 0; - for (size_t i = fromLevel; i < source.size(); i++, j++) - { - target[j] = source[i]; - } - - assert(j == target.size()); - } - } - - - - bool Toolbox::IsChildUri(const UriComponents& baseUri, - const UriComponents& testedUri) - { - if (testedUri.size() < baseUri.size()) - { - return false; - } - - for (size_t i = 0; i < baseUri.size(); i++) - { - if (baseUri[i] != testedUri[i]) - return false; - } - - return true; - } - - - std::string Toolbox::AutodetectMimeType(const std::string& path) - { - std::string contentType; - size_t lastDot = path.rfind('.'); - size_t lastSlash = path.rfind('/'); - - if (lastDot == std::string::npos || - (lastSlash != std::string::npos && lastDot < lastSlash)) - { - // No trailing dot, unable to detect the content type - } - else - { - const char* extension = &path[lastDot + 1]; - - // http://en.wikipedia.org/wiki/Mime_types - // Text types - if (!strcmp(extension, "txt")) - contentType = "text/plain"; - else if (!strcmp(extension, "html")) - contentType = "text/html"; - else if (!strcmp(extension, "xml")) - contentType = "text/xml"; - else if (!strcmp(extension, "css")) - contentType = "text/css"; - - // Application types - else if (!strcmp(extension, "js")) - contentType = "application/javascript"; - else if (!strcmp(extension, "json")) - contentType = "application/json"; - else if (!strcmp(extension, "pdf")) - contentType = "application/pdf"; - - // Images types - else if (!strcmp(extension, "jpg") || !strcmp(extension, "jpeg")) - contentType = "image/jpeg"; - else if (!strcmp(extension, "gif")) - contentType = "image/gif"; - else if (!strcmp(extension, "png")) - contentType = "image/png"; - } - - return contentType; - } - - - std::string Toolbox::FlattenUri(const UriComponents& components, - size_t fromLevel) - { - if (components.size() <= fromLevel) - { - return "/"; - } - else - { - std::string r; - - for (size_t i = fromLevel; i < components.size(); i++) - { - r += "/" + components[i]; - } - - return r; - } - } - - -#if ORTHANC_ENABLE_MD5 == 1 - static char GetHexadecimalCharacter(uint8_t value) - { - assert(value < 16); - - if (value < 10) - { - return value + '0'; - } - else - { - return (value - 10) + 'a'; - } - } - - - void Toolbox::ComputeMD5(std::string& result, - const std::string& data) - { - if (data.size() > 0) - { - ComputeMD5(result, &data[0], data.size()); - } - else - { - ComputeMD5(result, NULL, 0); - } - } - - - void Toolbox::ComputeMD5(std::string& result, - const void* data, - size_t size) - { - md5_state_s state; - md5_init(&state); - - if (size > 0) - { - md5_append(&state, - reinterpret_cast<const md5_byte_t*>(data), - static_cast<int>(size)); - } - - md5_byte_t actualHash[16]; - md5_finish(&state, actualHash); - - result.resize(32); - for (unsigned int i = 0; i < 16; i++) - { - result[2 * i] = GetHexadecimalCharacter(static_cast<uint8_t>(actualHash[i] / 16)); - result[2 * i + 1] = GetHexadecimalCharacter(static_cast<uint8_t>(actualHash[i] % 16)); - } - } -#endif - - -#if ORTHANC_ENABLE_BASE64 == 1 - void Toolbox::EncodeBase64(std::string& result, - const std::string& data) - { - result = base64_encode(data); - } - - void Toolbox::DecodeBase64(std::string& result, - const std::string& data) - { - for (size_t i = 0; i < data.length(); i++) - { - if (!isalnum(data[i]) && - data[i] != '+' && - data[i] != '/' && - data[i] != '=') - { - // This is not a valid character for a Base64 string - throw OrthancException(ErrorCode_BadFileFormat); - } - } - - result = base64_decode(data); - } - - - bool Toolbox::DecodeDataUriScheme(std::string& mime, - std::string& content, - const std::string& source) - { - boost::regex pattern("data:([^;]+);base64,([a-zA-Z0-9=+/]*)", - boost::regex::icase /* case insensitive search */); - - boost::cmatch what; - if (regex_match(source.c_str(), what, pattern)) - { - mime = what[1]; - DecodeBase64(content, what[2]); - return true; - } - else - { - return false; - } - } - - - void Toolbox::EncodeDataUriScheme(std::string& result, - const std::string& mime, - const std::string& content) - { - result = "data:" + mime + ";base64," + base64_encode(content); - } - -#endif - - -#if ORTHANC_ENABLE_LOCALE == 1 - static const char* GetBoostLocaleEncoding(const Encoding sourceEncoding) - { - switch (sourceEncoding) - { - case Encoding_Utf8: - return "UTF-8"; - - case Encoding_Ascii: - return "ASCII"; - - case Encoding_Latin1: - return "ISO-8859-1"; - break; - - case Encoding_Latin2: - return "ISO-8859-2"; - break; - - case Encoding_Latin3: - return "ISO-8859-3"; - break; - - case Encoding_Latin4: - return "ISO-8859-4"; - break; - - case Encoding_Latin5: - return "ISO-8859-9"; - break; - - case Encoding_Cyrillic: - return "ISO-8859-5"; - break; - - case Encoding_Windows1251: - return "WINDOWS-1251"; - break; - - case Encoding_Arabic: - return "ISO-8859-6"; - break; - - case Encoding_Greek: - return "ISO-8859-7"; - break; - - case Encoding_Hebrew: - return "ISO-8859-8"; - break; - - case Encoding_Japanese: - return "SHIFT-JIS"; - break; - - case Encoding_Chinese: - return "GB18030"; - break; - - case Encoding_Thai: - return "TIS620.2533-0"; - break; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } -#endif - - -#if ORTHANC_ENABLE_LOCALE == 1 - std::string Toolbox::ConvertToUtf8(const std::string& source, - Encoding sourceEncoding) - { - if (sourceEncoding == Encoding_Utf8) - { - // Already in UTF-8: No conversion is required - return source; - } - - if (sourceEncoding == Encoding_Ascii) - { - return ConvertToAscii(source); - } - - const char* encoding = GetBoostLocaleEncoding(sourceEncoding); - - try - { - return boost::locale::conv::to_utf<char>(source, encoding); - } - catch (std::runtime_error&) - { - // Bad input string or bad encoding - return ConvertToAscii(source); - } - } -#endif - - -#if ORTHANC_ENABLE_LOCALE == 1 - std::string Toolbox::ConvertFromUtf8(const std::string& source, - Encoding targetEncoding) - { - if (targetEncoding == Encoding_Utf8) - { - // Already in UTF-8: No conversion is required - return source; - } - - if (targetEncoding == Encoding_Ascii) - { - return ConvertToAscii(source); - } - - const char* encoding = GetBoostLocaleEncoding(targetEncoding); - - try - { - return boost::locale::conv::from_utf<char>(source, encoding); - } - catch (std::runtime_error&) - { - // Bad input string or bad encoding - return ConvertToAscii(source); - } - } -#endif - - - bool Toolbox::IsAsciiString(const void* data, - size_t size) - { - const uint8_t* p = reinterpret_cast<const uint8_t*>(data); - - for (size_t i = 0; i < size; i++, p++) - { - if (*p > 127 || *p == 0 || iscntrl(*p)) - { - return false; - } - } - - return true; - } - - - bool Toolbox::IsAsciiString(const std::string& s) - { - return IsAsciiString(s.c_str(), s.size()); - } - - - std::string Toolbox::ConvertToAscii(const std::string& source) - { - std::string result; - - result.reserve(source.size() + 1); - for (size_t i = 0; i < source.size(); i++) - { - if (source[i] <= 127 && source[i] >= 0 && !iscntrl(source[i])) - { - result.push_back(source[i]); - } - } - - return result; - } - - - void Toolbox::ComputeSHA1(std::string& result, - const void* data, - size_t size) - { - boost::uuids::detail::sha1 sha1; - - if (size > 0) - { - sha1.process_bytes(data, size); - } - - unsigned int digest[5]; - - // Sanity check for the memory layout: A SHA-1 digest is 160 bits wide - assert(sizeof(unsigned int) == 4 && sizeof(digest) == (160 / 8)); - - sha1.get_digest(digest); - - result.resize(8 * 5 + 4); - sprintf(&result[0], "%08x-%08x-%08x-%08x-%08x", - digest[0], - digest[1], - digest[2], - digest[3], - digest[4]); - } - - void Toolbox::ComputeSHA1(std::string& result, - const std::string& data) - { - if (data.size() > 0) - { - ComputeSHA1(result, data.c_str(), data.size()); - } - else - { - ComputeSHA1(result, NULL, 0); - } - } - - - bool Toolbox::IsSHA1(const char* str, - size_t size) - { - if (size == 0) - { - return false; - } - - const char* start = str; - const char* end = str + size; - - // Trim the beginning of the string - while (start < end) - { - if (*start == '\0' || - isspace(*start)) - { - start++; - } - else - { - break; - } - } - - // Trim the trailing of the string - while (start < end) - { - if (*(end - 1) == '\0' || - isspace(*(end - 1))) - { - end--; - } - else - { - break; - } - } - - if (end - start != 44) - { - return false; - } - - for (unsigned int i = 0; i < 44; i++) - { - if (i == 8 || - i == 17 || - i == 26 || - i == 35) - { - if (start[i] != '-') - return false; - } - else - { - if (!isalnum(start[i])) - return false; - } - } - - return true; - } - - - bool Toolbox::IsSHA1(const std::string& s) - { - if (s.size() == 0) - { - return false; - } - else - { - return IsSHA1(s.c_str(), s.size()); - } - } - - - std::string Toolbox::StripSpaces(const std::string& source) - { - size_t first = 0; - - while (first < source.length() && - isspace(source[first])) - { - first++; - } - - if (first == source.length()) - { - // String containing only spaces - return ""; - } - - size_t last = source.length(); - while (last > first && - isspace(source[last - 1])) - { - last--; - } - - assert(first <= last); - return source.substr(first, last - first); - } - - - static char Hex2Dec(char c) - { - return ((c >= '0' && c <= '9') ? c - '0' : - ((c >= 'a' && c <= 'f') ? c - 'a' + 10 : c - 'A' + 10)); - } - - void Toolbox::UrlDecode(std::string& s) - { - // http://en.wikipedia.org/wiki/Percent-encoding - // http://www.w3schools.com/tags/ref_urlencode.asp - // http://stackoverflow.com/questions/154536/encode-decode-urls-in-c - - if (s.size() == 0) - { - return; - } - - size_t source = 0; - size_t target = 0; - - while (source < s.size()) - { - if (s[source] == '%' && - source + 2 < s.size() && - isalnum(s[source + 1]) && - isalnum(s[source + 2])) - { - s[target] = (Hex2Dec(s[source + 1]) << 4) | Hex2Dec(s[source + 2]); - source += 3; - target += 1; - } - else - { - if (s[source] == '+') - s[target] = ' '; - else - s[target] = s[source]; - - source++; - target++; - } - } - - s.resize(target); - } - - - Endianness Toolbox::DetectEndianness() - { - // http://sourceforge.net/p/predef/wiki/Endianness/ - - uint8_t buffer[4]; - - buffer[0] = 0x00; - buffer[1] = 0x01; - buffer[2] = 0x02; - buffer[3] = 0x03; - - switch (*((uint32_t *)buffer)) - { - case 0x00010203: - return Endianness_Big; - - case 0x03020100: - return Endianness_Little; - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - std::string Toolbox::WildcardToRegularExpression(const std::string& source) - { - // TODO - Speed up this with a regular expression - - std::string result = source; - - // Escape all special characters - boost::replace_all(result, "\\", "\\\\"); - boost::replace_all(result, "^", "\\^"); - boost::replace_all(result, ".", "\\."); - boost::replace_all(result, "$", "\\$"); - boost::replace_all(result, "|", "\\|"); - boost::replace_all(result, "(", "\\("); - boost::replace_all(result, ")", "\\)"); - boost::replace_all(result, "[", "\\["); - boost::replace_all(result, "]", "\\]"); - boost::replace_all(result, "+", "\\+"); - boost::replace_all(result, "/", "\\/"); - boost::replace_all(result, "{", "\\{"); - boost::replace_all(result, "}", "\\}"); - - // Convert wildcards '*' and '?' to their regex equivalents - boost::replace_all(result, "?", "."); - boost::replace_all(result, "*", ".*"); - - return result; - } - - - void Toolbox::TokenizeString(std::vector<std::string>& result, - const std::string& value, - char separator) - { - result.clear(); - - std::string currentItem; - - for (size_t i = 0; i < value.size(); i++) - { - if (value[i] == separator) - { - result.push_back(currentItem); - currentItem.clear(); - } - else - { - currentItem.push_back(value[i]); - } - } - - result.push_back(currentItem); - } - - -#if ORTHANC_ENABLE_PUGIXML == 1 - class ChunkedBufferWriter : public pugi::xml_writer - { - private: - ChunkedBuffer buffer_; - - public: - virtual void write(const void *data, size_t size) - { - if (size > 0) - { - buffer_.AddChunk(reinterpret_cast<const char*>(data), size); - } - } - - void Flatten(std::string& s) - { - buffer_.Flatten(s); - } - }; - - - static void JsonToXmlInternal(pugi::xml_node& target, - const Json::Value& source, - const std::string& arrayElement) - { - // http://jsoncpp.sourceforge.net/value_8h_source.html#l00030 - - switch (source.type()) - { - case Json::nullValue: - { - target.append_child(pugi::node_pcdata).set_value("null"); - break; - } - - case Json::intValue: - { - std::string s = boost::lexical_cast<std::string>(source.asInt()); - target.append_child(pugi::node_pcdata).set_value(s.c_str()); - break; - } - - case Json::uintValue: - { - std::string s = boost::lexical_cast<std::string>(source.asUInt()); - target.append_child(pugi::node_pcdata).set_value(s.c_str()); - break; - } - - case Json::realValue: - { - std::string s = boost::lexical_cast<std::string>(source.asFloat()); - target.append_child(pugi::node_pcdata).set_value(s.c_str()); - break; - } - - case Json::stringValue: - { - target.append_child(pugi::node_pcdata).set_value(source.asString().c_str()); - break; - } - - case Json::booleanValue: - { - target.append_child(pugi::node_pcdata).set_value(source.asBool() ? "true" : "false"); - break; - } - - case Json::arrayValue: - { - for (Json::Value::ArrayIndex i = 0; i < source.size(); i++) - { - pugi::xml_node node = target.append_child(); - node.set_name(arrayElement.c_str()); - JsonToXmlInternal(node, source[i], arrayElement); - } - break; - } - - case Json::objectValue: - { - Json::Value::Members members = source.getMemberNames(); - - for (size_t i = 0; i < members.size(); i++) - { - pugi::xml_node node = target.append_child(); - node.set_name(members[i].c_str()); - JsonToXmlInternal(node, source[members[i]], arrayElement); - } - - break; - } - - default: - throw OrthancException(ErrorCode_NotImplemented); - } - } - - - void Toolbox::JsonToXml(std::string& target, - const Json::Value& source, - const std::string& rootElement, - const std::string& arrayElement) - { - pugi::xml_document doc; - - pugi::xml_node n = doc.append_child(rootElement.c_str()); - JsonToXmlInternal(n, source, arrayElement); - - pugi::xml_node decl = doc.prepend_child(pugi::node_declaration); - decl.append_attribute("version").set_value("1.0"); - decl.append_attribute("encoding").set_value("utf-8"); - - ChunkedBufferWriter writer; - doc.save(writer, " ", pugi::format_default, pugi::encoding_utf8); - writer.Flatten(target); - } - -#endif - - - - bool Toolbox::IsInteger(const std::string& str) - { - std::string s = StripSpaces(str); - - if (s.size() == 0) - { - return false; - } - - size_t pos = 0; - if (s[0] == '-') - { - if (s.size() == 1) - { - return false; - } - - pos = 1; - } - - while (pos < s.size()) - { - if (!isdigit(s[pos])) - { - return false; - } - - pos++; - } - - return true; - } - - - void Toolbox::CopyJsonWithoutComments(Json::Value& target, - const Json::Value& source) - { - switch (source.type()) - { - case Json::nullValue: - target = Json::nullValue; - break; - - case Json::intValue: - target = source.asInt64(); - break; - - case Json::uintValue: - target = source.asUInt64(); - break; - - case Json::realValue: - target = source.asDouble(); - break; - - case Json::stringValue: - target = source.asString(); - break; - - case Json::booleanValue: - target = source.asBool(); - break; - - case Json::arrayValue: - { - target = Json::arrayValue; - for (Json::Value::ArrayIndex i = 0; i < source.size(); i++) - { - Json::Value& item = target.append(Json::nullValue); - CopyJsonWithoutComments(item, source[i]); - } - - break; - } - - case Json::objectValue: - { - target = Json::objectValue; - Json::Value::Members members = source.getMemberNames(); - for (Json::Value::ArrayIndex i = 0; i < members.size(); i++) - { - const std::string item = members[i]; - CopyJsonWithoutComments(target[item], source[item]); - } - - break; - } - - default: - break; - } - } - - - bool Toolbox::StartsWith(const std::string& str, - const std::string& prefix) - { - if (str.size() < prefix.size()) - { - return false; - } - else - { - return str.compare(0, prefix.size(), prefix) == 0; - } - } - - - static bool IsUnreservedCharacter(char c) - { - // This function checks whether "c" is an unserved character - // wrt. an URI percent-encoding - // https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding%5Fin%5Fa%5FURI - - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || - c == '_' || - c == '.' || - c == '~'); - } - - void Toolbox::UriEncode(std::string& target, - const std::string& source) - { - // Estimate the length of the percent-encoded URI - size_t length = 0; - - for (size_t i = 0; i < source.size(); i++) - { - if (IsUnreservedCharacter(source[i])) - { - length += 1; - } - else - { - // This character must be percent-encoded - length += 3; - } - } - - target.clear(); - target.reserve(length); - - for (size_t i = 0; i < source.size(); i++) - { - if (IsUnreservedCharacter(source[i])) - { - target.push_back(source[i]); - } - else - { - // This character must be percent-encoded - uint8_t byte = static_cast<uint8_t>(source[i]); - uint8_t a = byte >> 4; - uint8_t b = byte & 0x0f; - - target.push_back('%'); - target.push_back(a < 10 ? a + '0' : a - 10 + 'A'); - target.push_back(b < 10 ? b + '0' : b - 10 + 'A'); - } - } - } - - - static bool HasField(const Json::Value& json, - const std::string& key, - Json::ValueType expectedType) - { - if (json.type() != Json::objectValue || - !json.isMember(key)) - { - return false; - } - else if (json[key].type() == expectedType) - { - return true; - } - else - { - throw OrthancException(ErrorCode_BadParameterType); - } - } - - - std::string Toolbox::GetJsonStringField(const Json::Value& json, - const std::string& key, - const std::string& defaultValue) - { - if (HasField(json, key, Json::stringValue)) - { - return json[key].asString(); - } - else - { - return defaultValue; - } - } - - - bool Toolbox::GetJsonBooleanField(const ::Json::Value& json, - const std::string& key, - bool defaultValue) - { - if (HasField(json, key, Json::booleanValue)) - { - return json[key].asBool(); - } - else - { - return defaultValue; - } - } - - - int Toolbox::GetJsonIntegerField(const ::Json::Value& json, - const std::string& key, - int defaultValue) - { - if (HasField(json, key, Json::intValue)) - { - return json[key].asInt(); - } - else - { - return defaultValue; - } - } - - - unsigned int Toolbox::GetJsonUnsignedIntegerField(const ::Json::Value& json, - const std::string& key, - unsigned int defaultValue) - { - int v = GetJsonIntegerField(json, key, defaultValue); - - if (v < 0) - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - else - { - return static_cast<unsigned int>(v); - } - } - - - bool Toolbox::IsUuid(const std::string& str) - { - if (str.size() != 36) - { - return false; - } - - for (size_t i = 0; i < str.length(); i++) - { - if (i == 8 || i == 13 || i == 18 || i == 23) - { - if (str[i] != '-') - return false; - } - else - { - if (!isalnum(str[i])) - return false; - } - } - - return true; - } - - - bool Toolbox::StartsWithUuid(const std::string& str) - { - if (str.size() < 36) - { - return false; - } - - if (str.size() == 36) - { - return IsUuid(str); - } - - assert(str.size() > 36); - if (!isspace(str[36])) - { - return false; - } - - return IsUuid(str.substr(0, 36)); - } - - -#if ORTHANC_ENABLE_LOCALE == 1 - static std::auto_ptr<std::locale> globalLocale_; - - static bool SetGlobalLocale(const char* locale) - { - globalLocale_.reset(NULL); - - try - { - if (locale == NULL) - { - LOG(WARNING) << "Falling back to system-wide default locale"; - globalLocale_.reset(new std::locale()); - } - else - { - LOG(INFO) << "Using locale: \"" << locale << "\" for case-insensitive comparison of strings"; - globalLocale_.reset(new std::locale(locale)); - } - } - catch (std::runtime_error&) - { - } - - return (globalLocale_.get() != NULL); - } - - void Toolbox::InitializeGlobalLocale(const char* locale) - { - // Make Orthanc use English, United States locale - // Linux: use "en_US.UTF-8" - // Windows: use "" - // Wine: use NULL - -#if defined(__MINGW32__) - // Visibly, there is no support of locales in MinGW yet - // http://mingw.5.n7.nabble.com/How-to-use-std-locale-global-with-MinGW-correct-td33048.html - static const char* DEFAULT_LOCALE = NULL; -#elif defined(_WIN32) - // For Windows: use default locale (using "en_US" does not work) - static const char* DEFAULT_LOCALE = ""; -#else - // For Linux & cie - static const char* DEFAULT_LOCALE = "en_US.UTF-8"; -#endif - - bool ok; - - if (locale == NULL) - { - ok = SetGlobalLocale(DEFAULT_LOCALE); - -#if defined(__MINGW32__) - LOG(WARNING) << "This is a MinGW build, case-insensitive comparison of " - << "strings with accents will not work outside of Wine"; -#endif - } - else - { - ok = SetGlobalLocale(locale); - } - - if (!ok && - !SetGlobalLocale(NULL)) - { - LOG(ERROR) << "Cannot initialize global locale"; - throw OrthancException(ErrorCode_InternalError); - } - - } - - - void Toolbox::FinalizeGlobalLocale() - { - globalLocale_.reset(); - } - - - std::string Toolbox::ToUpperCaseWithAccents(const std::string& source) - { - if (globalLocale_.get() == NULL) - { - LOG(ERROR) << "No global locale was set, call Toolbox::InitializeGlobalLocale()"; - throw OrthancException(ErrorCode_BadSequenceOfCalls); - } - - /** - * A few notes about locales: - * - * (1) We don't use "case folding": - * http://www.boost.org/doc/libs/1_64_0/libs/locale/doc/html/conversions.html - * - * Characters are made uppercase one by one. This is because, in - * static builds, we are using iconv, which is visibly not - * supported correctly (TODO: Understand why). Case folding seems - * to be working correctly if using the default backend under - * Linux (ICU or POSIX?). If one wishes to use case folding, one - * would use: - * - * boost::locale::generator gen; - * std::locale::global(gen(DEFAULT_LOCALE)); - * return boost::locale::to_upper(source); - * - * (2) The function "boost::algorithm::to_upper_copy" does not - * make use of the "std::locale::global()". We therefore create a - * global variable "globalLocale_". - * - * (3) The variant of "boost::algorithm::to_upper_copy()" that - * uses std::string does not work properly. We need to apply it - * one wide strings (std::wstring). This explains the two calls to - * "utf_to_utf" in order to convert to/from std::wstring. - **/ - - std::wstring w = boost::locale::conv::utf_to_utf<wchar_t>(source); - w = boost::algorithm::to_upper_copy<std::wstring>(w, *globalLocale_); - return boost::locale::conv::utf_to_utf<char>(w); - } -#endif - - - std::string Toolbox::GenerateUuid() - { -#ifdef WIN32 - UUID uuid; - UuidCreate ( &uuid ); - - unsigned char * str; - UuidToStringA ( &uuid, &str ); - - std::string s( ( char* ) str ); - - RpcStringFreeA ( &str ); -#else - uuid_t uuid; - uuid_generate_random ( uuid ); - char s[37]; - uuid_unparse ( uuid, s ); -#endif - return s; - } -} - - - -OrthancLinesIterator* OrthancLinesIterator_Create(const std::string& content) -{ - return reinterpret_cast<OrthancLinesIterator*>(new Orthanc::Toolbox::LinesIterator(content)); -} - - -bool OrthancLinesIterator_GetLine(std::string& target, - const OrthancLinesIterator* iterator) -{ - if (iterator != NULL) - { - return reinterpret_cast<const Orthanc::Toolbox::LinesIterator*>(iterator)->GetLine(target); - } - else - { - return false; - } -} - - -void OrthancLinesIterator_Next(OrthancLinesIterator* iterator) -{ - if (iterator != NULL) - { - reinterpret_cast<Orthanc::Toolbox::LinesIterator*>(iterator)->Next(); - } -} - - -void OrthancLinesIterator_Free(OrthancLinesIterator* iterator) -{ - if (iterator != NULL) - { - delete reinterpret_cast<const Orthanc::Toolbox::LinesIterator*>(iterator); - } -}
--- a/Orthanc/Core/Toolbox.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,259 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "Enumerations.h" - -#include <stdint.h> -#include <vector> -#include <string> -#include <json/json.h> - - -#if !defined(ORTHANC_ENABLE_BASE64) -# error The macro ORTHANC_ENABLE_BASE64 must be defined -#endif - -#if !defined(ORTHANC_ENABLE_LOCALE) -# error The macro ORTHANC_ENABLE_LOCALE must be defined -#endif - -#if !defined(ORTHANC_ENABLE_MD5) -# error The macro ORTHANC_ENABLE_MD5 must be defined -#endif - -#if !defined(ORTHANC_ENABLE_PUGIXML) -# error The macro ORTHANC_ENABLE_PUGIXML must be defined -#endif - - -/** - * NOTE: GUID vs. UUID - * The simple answer is: no difference, they are the same thing. Treat - * them as a 16 byte (128 bits) value that is used as a unique - * value. In Microsoft-speak they are called GUIDs, but call them - * UUIDs when not using Microsoft-speak. - * http://stackoverflow.com/questions/246930/is-there-any-difference-between-a-guid-and-a-uuid - **/ - - - -namespace Orthanc -{ - typedef std::vector<std::string> UriComponents; - - class NullType - { - }; - - namespace Toolbox - { - class LinesIterator - { - private: - const std::string& content_; - size_t lineStart_; - size_t lineEnd_; - - void FindEndOfLine(); - - public: - LinesIterator(const std::string& content); - - bool GetLine(std::string& target) const; - - void Next(); - }; - - - void ToUpperCase(std::string& s); // Inplace version - - void ToLowerCase(std::string& s); // Inplace version - - void ToUpperCase(std::string& result, - const std::string& source); - - void ToLowerCase(std::string& result, - const std::string& source); - - void SplitUriComponents(UriComponents& components, - const std::string& uri); - - void TruncateUri(UriComponents& target, - const UriComponents& source, - size_t fromLevel); - - bool IsChildUri(const UriComponents& baseUri, - const UriComponents& testedUri); - - std::string AutodetectMimeType(const std::string& path); - - std::string FlattenUri(const UriComponents& components, - size_t fromLevel = 0); - -#if ORTHANC_ENABLE_MD5 == 1 - void ComputeMD5(std::string& result, - const std::string& data); - - void ComputeMD5(std::string& result, - const void* data, - size_t size); -#endif - - void ComputeSHA1(std::string& result, - const std::string& data); - - void ComputeSHA1(std::string& result, - const void* data, - size_t size); - - bool IsSHA1(const char* str, - size_t size); - - bool IsSHA1(const std::string& s); - -#if ORTHANC_ENABLE_BASE64 == 1 - void DecodeBase64(std::string& result, - const std::string& data); - - void EncodeBase64(std::string& result, - const std::string& data); - - bool DecodeDataUriScheme(std::string& mime, - std::string& content, - const std::string& source); - - void EncodeDataUriScheme(std::string& result, - const std::string& mime, - const std::string& content); -#endif - -#if ORTHANC_ENABLE_LOCALE == 1 - std::string ConvertToUtf8(const std::string& source, - Encoding sourceEncoding); - - std::string ConvertFromUtf8(const std::string& source, - Encoding targetEncoding); -#endif - - bool IsAsciiString(const void* data, - size_t size); - - bool IsAsciiString(const std::string& s); - - std::string ConvertToAscii(const std::string& source); - - std::string StripSpaces(const std::string& source); - - // In-place percent-decoding for URL - void UrlDecode(std::string& s); - - Endianness DetectEndianness(); - - std::string WildcardToRegularExpression(const std::string& s); - - void TokenizeString(std::vector<std::string>& result, - const std::string& source, - char separator); - -#if ORTHANC_ENABLE_PUGIXML == 1 - void JsonToXml(std::string& target, - const Json::Value& source, - const std::string& rootElement = "root", - const std::string& arrayElement = "item"); -#endif - - bool IsInteger(const std::string& str); - - void CopyJsonWithoutComments(Json::Value& target, - const Json::Value& source); - - bool StartsWith(const std::string& str, - const std::string& prefix); - - void UriEncode(std::string& target, - const std::string& source); - - std::string GetJsonStringField(const ::Json::Value& json, - const std::string& key, - const std::string& defaultValue); - - bool GetJsonBooleanField(const ::Json::Value& json, - const std::string& key, - bool defaultValue); - - int GetJsonIntegerField(const ::Json::Value& json, - const std::string& key, - int defaultValue); - - unsigned int GetJsonUnsignedIntegerField(const ::Json::Value& json, - const std::string& key, - unsigned int defaultValue); - - bool IsUuid(const std::string& str); - - bool StartsWithUuid(const std::string& str); - -#if ORTHANC_ENABLE_LOCALE == 1 - void InitializeGlobalLocale(const char* locale); - - void FinalizeGlobalLocale(); - - std::string ToUpperCaseWithAccents(const std::string& source); -#endif - - std::string GenerateUuid(); - } -} - - - - -/** - * The plain C, opaque data structure "OrthancLinesIterator" is a thin - * wrapper around Orthanc::Toolbox::LinesIterator, and is only used by - * "../Resources/WebAssembly/dcdict.cc", in order to avoid code - * duplication - **/ - -struct OrthancLinesIterator; - -OrthancLinesIterator* OrthancLinesIterator_Create(const std::string& content); - -bool OrthancLinesIterator_GetLine(std::string& target, - const OrthancLinesIterator* iterator); - -void OrthancLinesIterator_Next(OrthancLinesIterator* iterator); - -void OrthancLinesIterator_Free(OrthancLinesIterator* iterator);
--- a/Orthanc/NEWS Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,946 +0,0 @@ -Pending changes in the mainline -=============================== - -REST API --------- - -* "/system" URI returns the version of the Orthanc REST API -* "/tools/now" returns the current UTC (universal) time -* "/tools/now-local" returns the curent local time. - This was the behavior of "/tools/now" until release 1.3.1. -* Added "?expand" GET argument to "/peers" and "/modalities" routes -* New URI: "/tools/create-media-extended" to generate a DICOMDIR - archive from several resources, including additional type-3 tags -* Preservation of UID relationships while anonymizing - -Lua ---- - -* New CMake option: "-DENABLE_LUA_MODULES=ON" to enable support for - loading external Lua modules if the Lua engine is statically linked - -Plugins -------- - -* New error code: DatabaseUnavailable - -Maintenance ------------ - -* Orthanc now uses UTC (universal time) instead of local time in its database -* Fix to allow creating DICOM instances with empty Specific Character Set (0008,0005) -* Support of Linux Standard Base -* Static linking against libuuid (from e2fsprogs) -* Fix static build on CentOS 6 -* Possibility of using JsonCpp 0.10.6 if the compiler does not support C++11 - with the "-DUSE_LEGACY_JSONCPP=ON" CMake option -* Upgraded dependencies for static and Windows builds: - - boost 1.66.0 - - curl 7.57.0 - - jsoncpp 1.8.4 - - zlib 1.2.11 - - -Version 1.3.1 (2017-11-29) -========================== - -General -------- - -* Built-in decoding of palette images - -REST API --------- - -* New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip -* New argument "ignore-length" to force the inclusion of too long tags in JSON -* New argument "/.../media?extended" to include additional type-3 tags in DICOMDIR - -Plugins -------- - -* New pixel formats exposed in SDK: BGRA32, Float32, Grayscale32, RGB48 - -Maintenance ------------ - -* Creation of ./Resources/CMake/OrthancFramework*.cmake to reuse the Orthanc - C++ framework in other projects -* New security-related options: "DicomAlwaysAllowEcho" -* Use "GBK" (frequently used in China) as an alias for "GB18030" -* Experimental support of actively maintained Civetweb to replace Mongoose 3.8 -* Fix issue 31 for good (create new modality types for Philips ADW, GE Xeleris, GE AWServer) -* Fix issue 64 (OpenBSD support) -* Fix static compilation of DCMTK 3.6.2 on Fedora -* Upgrade to Boost 1.65.1 in static builds -* Upgrade to SQLite amalgamation 3.21.0 in static builds - - -Version 1.3.0 (2017-07-19) -========================== - -General -------- - -* Orthanc now anonymizes according to Basic Profile of PS 3.15-2017c Table E.1-1 -* In the "DicomModalities" configuration: - - Manufacturer type MedInria is now obsolete - - Manufacturer types AgfaImpax and SyngoVia are obsolete too - (use GenericNoWildcardInDates instead) - - Obsolete manufacturers are still accepted but might disappear in the future - - Added new manufacturer: GenericNoUniversalWildcard to replace all '*' by '' in - outgoing C-Find requests -* New security-related options: "DicomAlwaysAllowStore" and "DicomCheckModalityHost" - -REST API --------- - -* Argument "Since" in URI "/tools/find" (related to issue 53) -* Argument "DicomVersion" in URIs "/{...}/{...}/anonymization" - -Plugins -------- - -* New function: "OrthancPluginRegisterIncomingHttpRequestFilter2()" - -Lua ---- - -* Added HTTP headers support for Lua HttpPost/HttpGet/HttpPut/HttpDelete - -Orthanc Explorer ----------------- - -* Query/retrieve: Added button for "DR" modality - -Maintenance ------------ - -* Ability to retrieve raw frames encoded as unsigned 32-bits integers -* Fix issue 29 (more consistent handling of the "--upgrade" argument) -* Fix issue 31 (create new modality types for Philips ADW, GE Xeleris, GE AWServer) -* Fix issue 35 (AET name is not transferred to Orthanc using DCMTK 3.6.0) -* Fix issue 44 (bad interpretation of photometric interpretation MONOCHROME1) -* Fix issue 45 (crash when providing a folder to "--config" command-line option) -* Fix issue 46 (PHI remaining after anonymization) -* Fix issue 49 (worklists: accentuated characters are removed from C-Find responses) -* Fix issue 52 (DICOM level security association problems) -* Fix issue 55 (modification/anonymization of tags that might break the database - model now requires the "Force" parameter to be set to "true" in the query) -* Fix issue 56 (case-insensitive matching over accents) -* Fix Debian #865606 (orthanc FTBFS with libdcmtk-dev 3.6.1~20170228-2) -* Fix XSS inside DICOM in Orthanc Explorer (as reported by Victor Pasnkel, Morphus Labs) -* Upgrade to DCMTK 3.6.2 in static builds (released on 2017-07-17) -* Upgrade to Boost 1.64.0 in static builds -* New advanced "Locale" configuration option -* Removed configuration option "USE_DCMTK_361_PRIVATE_DIC" - - -Version 1.2.0 (2016/12/13) -========================== - -General -------- - -* Handling of private tags/creators in the "Dictionary" configuration option -* New configuration options: "LoadPrivateDictionary", "DicomScuTimeout" and "DicomScpTimeout" -* New metadata automatically computed at the instance level: "TransferSyntax" and "SopClassUid" - -REST API --------- - -* "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files - (useful if private tags are registered, or if changing the default encoding) -* "Permissive" flag for URI "/modalities/{...}/store" to ignore C-STORE transfer errors -* "Asynchronous" flag for URIs "/modalities/{...}/store" and "/peers/{...}/store" - to avoid waiting for the completion of image transfers -* Possibility to DELETE "dicom-as-json" attachments to reconstruct the JSON summaries - (useful if "Dictionary" has changed) -* "Keep" option for modifications to keep original DICOM identifiers (advanced feature) -* "/tools/default-encoding" to get or temporarily change the default encoding -* "/{resource}/{id}/reconstruct" to reconstruct the main DICOM tags, the JSON summary and - the metadata of a resource (useful to compute new metadata, or if using "Keep" above) - -Plugins -------- - -* New function: "OrthancPluginRegisterPrivateDictionaryTag()" to register private tags -* More control over client cache in the ServeFolders plugin -* New C++ help wrappers in "Plugins/Samples/Common/" to read DICOM datasets from REST API -* New data structure: "OrthancPluginFindMatcher" to match DICOM against C-FIND queries - -Maintenance ------------ - -* Fix handling of encodings in C-FIND requests (including for worklists) -* Use of DCMTK 3.6.1 dictionary of private tags in standalone builds -* Avoid hard crash if not enough memory (handling of std::bad_alloc) -* Improved robustness of Orthanc Explorer wrt. query/retrieve (maybe fix issue 24) -* Fix serious performance issue with C-FIND -* Fix extraction of the symbolic name of the private tags -* Performance warning if runtime debug assertions are turned on -* Improved robustness against files with no PatientID -* Upgrade to curl 7.50.3 for static and Windows builds -* Content-Type for JSON documents is now "application/json; charset=utf-8" -* Ignore "Group Length" tags in C-FIND queries -* Fix handling of worklist SCP with ReferencedStudySequence and ReferencedPatientSequence -* Fix handling of Move Originator AET and ID in C-MOVE SCP -* Fix vulnerability ZSL-2016-5379 "Unquoted Service Path Privilege Escalation" in the - Windows service -* Fix vulnerability ZSL-2016-5380 "Remote Memory Corruption Vulnerability" in DCMTK 3.6.0 - - -Version 1.1.0 (2016/06/27) -========================== - -General -------- - -* HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet -* Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers -* New command-line option "--logfile" to output the Orthanc log to the given file -* Support of SIGHUP signal (restart Orthanc only if the configuration files have changed) - -REST API --------- - -* New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) -* New URI "/modalities/.../move" to issue C-MOVE SCU requests -* "MoveOriginatorID" can be specified for "/modalities/.../store" - -Dicom protocol --------------- - -* Support of optional tags for counting resources in C-FIND: - 0008-0061, 0008-0062, 0020-1200, 0020-1202, 0020-1204, 0020-1206, 0020-1208, 0020-1209 -* Support of Move Originator Message ID (0000,1031) in C-STORE responses driven by C-MOVE - -Plugins -------- - -* Speedup in plugins by removing unnecessary locks -* New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter() -* New callback to handle non-worklists C-FIND requests: OrthancPluginRegisterFindCallback() -* New callback to handle C-MOVE requests: OrthancPluginRegisterMoveCallback() -* New function: "OrthancPluginHttpClient()" to do HTTP requests with full control -* New function: "OrthancPluginGenerateUuid()" to generate a UUID -* More than one custom image decoder can be installed (e.g. to handle different transfer syntaxes) - -Lua ---- - -* Possibility to dynamically fix outgoing C-FIND requests using "OutgoingFindRequestFilter()" -* Access to the HTTP headers in the "IncomingHttpRequestFilter()" callback - -Image decoding --------------- - -* Huge speedup if decoding the family of JPEG transfer syntaxes -* Refactoring leading to speedups with custom image decoders (including Web viewer plugin) -* Support decoding of RLE Lossless transfer syntax -* Support of signed 16bpp images in ParsedDicomFile - -Maintenance ------------ - -* New logo of Orthanc -* Fix issue 11 (is_regular_file() fails for FILE_ATTRIBUTE_REPARSE_POINT) -* Fix issue 16 ("Limit" parameter error in REST API /tools/find method) -* Fix of Debian bug #818512 ("FTBFS: Please install libdcmtk*-dev") -* Fix of Debian bug #823139 ("orthanc: Please provide RecoverCompressedFile.cpp") -* Replaced "localhost" by "127.0.0.1", as it might impact performance on Windows -* Compatibility with CMake >= 3.5.0 -* Possibility to use forthcoming DCMTK 3.6.1 in static builds (instead of 3.6.0) -* Upgrade to Boost 1.60.0 for static builds -* Use of HTTP status 403 Forbidden (instead of 401) if access to a REST resource is disallowed -* Option "HttpsVerifyPeers" can be used to connect against self-signed HTTPS certificates -* New configuration option "AllowFindSopClassesInStudy" -* Macro "__linux" (now obsolete) replaced by macro "__linux__" (maybe solves Debian bug #821011) -* Modification of instances can now replace PixelData (resp. EncapsulatedDocument) with - provided a PNG/JPEG image (resp. PDF file) if it is encoded using Data URI Scheme -* Dropped support of Google Log - - -Version 1.0.0 (2015/12/15) -========================== - -* Lua: "IncomingFindRequestFilter()" to apply filters to incoming C-FIND requests -* New function in plugin SDK: "OrthancPluginSendMultipartItem2()" -* Fix of DICOMDIR generation with DCMTK 3.6.1, support of encodings -* Fix range search if the lower or upper limit is absent -* Fix modality worklists lookups if tags with UN (unknown) VR are present -* Warn about badly formatted modality/peer definitions in configuration file at startup - - -Version 0.9.6 (2015/12/08) -========================== - -* Promiscuous mode (accept unknown SOP class UID) is now turned off by default -* Fix serialization of DICOM buffers that might contain garbage trailing -* Fix modality worklists server if some fields are null -* More tolerant "/series/.../ordered-slices" with broken series -* Improved logging information if upgrade fails -* Fix formatting of multipart HTTP answers (bis) - - -Version 0.9.5 (2015/12/02) -========================== - -Major ------ - -* Experimental support of DICOM C-FIND SCP for modality worklists through plugins -* Support of DICOM C-FIND SCU for modality worklists ("/modalities/{dicom}/find-worklist") - -REST API --------- - -* New URIs: - - "/series/.../ordered-slices" to order the slices of a 2D+t or 3D series - - "/tools/shutdown" to stop Orthanc from the REST API - - ".../compress", ".../uncompress" and ".../is-compressed" for attachments - - "/tools/create-archive" to create ZIP from a set of resources - - "/tools/create-media" to create ZIP+DICOMDIR from a set of resources - - "/instances/.../header" to get the meta information (header) of the DICOM instance -* "/tools/create-dicom": - - Support of binary tags encoded using data URI scheme - - Support of hierarchical structures (creation of sequences) - - Create tags with unknown VR -* "/modify" can insert/modify sequences -* ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so -* "Origin" metadata for the instances - -Minor ------ - -* New configuration options: - - "UnknownSopClassAccepted" to disable promiscuous mode (accept unknown SOP class UID) - - New configuration option: "Dictionary" to declare custom DICOM tags -* Add ".dcm" suffix to files in ZIP archives (cf. URI ".../archive") -* MIME content type can be associated to custom attachments (cf. "UserContentType") - -Plugins -------- - -* New functions: - - "OrthancPluginRegisterDecodeImageCallback()" to replace the built-in image decoder - - "OrthancPluginDicomInstanceToJson()" to convert DICOM to JSON - - "OrthancPluginDicomBufferToJson()" to convert DICOM to JSON - - "OrthancPluginRegisterErrorCode()" to declare custom error codes - - "OrthancPluginRegisterDictionaryTag()" to declare custom DICOM tags - - "OrthancPluginLookupDictionary()" to get information about some DICOM tag - - "OrthancPluginRestApiGet2()" to provide HTTP headers when calling Orthanc API - - "OrthancPluginGetInstanceOrigin()" to know through which mechanism an instance was received - - "OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images - - "OrthancPluginDecodeDicomImage()" to decode DICOM images - - "OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash -* New events in change callbacks: - - "OrthancStarted" - - "OrthancStopped" - - "UpdatedAttachment" - - "UpdatedMetadata" -* "/system" URI gives information about the plugins used for storage area and DB back-end -* Plugin callbacks must now return explicit "OrthancPluginErrorCode" (instead of integers) - -Lua ---- - -* Optional argument "keepStrings" in "DumpJson()" - -Maintenance ------------ - -* Full indexation of the patient/study tags to speed up searches and C-FIND -* Many refactorings, notably of the searching features and of the image decoding -* C-MOVE SCP for studies using AccessionNumber tag -* Fix issue 4 (C-STORE Association not renegotiated on Specific-to-specific transfer syntax change) -* Fix formatting of multipart HTTP answers -* "--logdir" flag creates a single log file instead of 3 separate files for errors/warnings/infos -* "--errors" flag lists the error codes that could be returned by Orthanc -* Under Windows, the exit status of Orthanc corresponds to the encountered error code -* New "AgfaImpax", "EFilm2" and "Vitrea" modality manufacturers -* C-FIND SCP will return tags with sequence value representation -* Upgrade to Boost 1.59.0 for static builds - - -Version 0.9.4 (2015/09/16) -========================== - -* Preview of PDF files encapsulated in DICOM from Orthanc Explorer -* Creation of DICOM files with encapsulated PDF through "/tools/create-dicom" -* "limit" and "since" arguments while retrieving DICOM resources in the REST API -* Support of "deflate" and "gzip" content-types in HTTP requests -* Options to validate peers against CA certificates in HTTPS requests -* New configuration option: "HttpTimeout" to set the default timeout for HTTP requests - -Lua ---- - -* More information about the origin request in the "OnStoredInstance()" and - "ReceivedInstanceFilter()" callbacks. WARNING: This can result in - incompatibilities wrt. previous versions of Orthanc. -* New function "GetOrthancConfiguration()" to get the Orthanc configuration - -Plugins -------- - -* New functions to compress/uncompress images using PNG and JPEG -* New functions to issue HTTP requests from plugins -* New function "OrthancPluginBufferCompression()" to (un)compress memory buffers -* New function "OrthancPluginReadFile()" to read files from the filesystem -* New function "OrthancPluginWriteFile()" to write files to the filesystem -* New function "OrthancPluginGetErrorDescription()" to convert error codes to strings -* New function "OrthancPluginSendHttpStatus()" to send HTTP status with a body -* New function "OrthancPluginRegisterRestCallbackNoLock()" for high-performance plugins -* Plugins have access to explicit error codes -* Improvements to the sample "ServeFolders" plugin -* Primitives to upgrade the database version in plugins - -Maintenance ------------ - -* Many code refactorings -* Improved error codes (no more custom descriptions in exceptions) -* If error while calling the REST API, the answer body contains description of the error - (this feature can be disabled with the "HttpDescribeErrors" option) -* Upgrade to curl 7.44.0 for static and Windows builds -* Upgrade to libcurl 1.0.2d for static and Windows builds -* Depends on libjpeg 9a -* Bypass zlib uncompression if "StorageCompression" is enabled and HTTP client supports deflate - - -Version 0.9.3 (2015/08/07) -========================== - -* C-Echo testing can be triggered from Orthanc Explorer (in the query/retrieve page) -* Removal of the dependency upon Google Log, Orthanc now uses its internal logger - (use -DENABLE_GOOGLE_LOG=ON to re-enable Google Log) -* Upgrade to JsonCpp 0.10.5 for static and Windows builds - - -Version 0.9.2 (2015/08/02) -========================== - -* Upgrade to Boost 1.58.0 for static and Windows builds -* Source code repository moved from Google Code to BitBucket -* Inject version information into Windows binaries -* Fix access to binary data in HTTP/REST requests by Lua scripts -* Fix potential deadlock in the callbacks of plugins - - -Version 0.9.1 (2015/07/02) -========================== - -General -------- - -* The configuration can be splitted into several files stored inside the same folder -* Custom setting of the local AET during C-STORE SCU (both in Lua and in the REST API) -* Many code refactorings - -Lua ---- - -* Access to the REST API of Orthanc (RestApiGet, RestApiPost, RestApiPut, RestApiDelete) -* Functions to convert between Lua values and JSON strings: "ParseJson" and "DumpJson" -* New events: "OnStablePatient", "OnStableStudy", "OnStableSeries", "Initialize", "Finalize" - -Plugins -------- - -* Plugins can retrieve the configuration file directly as a JSON string -* Plugins can send answers as multipart messages - -Fixes ------ - -* Fix compatibility issues for C-FIND SCU to Siemens Syngo.Via modalities SCP -* Fix issue 15 (Lua scripts making HTTP requests) -* Fix issue 35 (Characters in PatientID string are not protected for C-FIND) -* Fix issue 37 (Hyphens trigger range query even if datatype does not support ranges) - - -Version 0.9.0 (2015/06/03) -========================== - -Major ------ - -* DICOM Query/Retrieve available from Orthanc Explorer -* C-MOVE SCU and C-FIND SCU are accessible through the REST API -* "?expand" flag for URIs "/patients", "/studies" and "/series" -* "/tools/find" URI to search for DICOM resources from REST -* Support of FreeBSD -* The "Orthanc Client" SDK is now a separate project - -Minor ------ - -* Speed-up in Orthanc Explorer for large amount of images -* Speed-up of the C-FIND SCP server of Orthanc -* Allow replacing PatientID/StudyInstanceUID/SeriesInstanceUID from Lua scripts -* Option "CaseSensitivePN" to enable case-insensitive C-FIND SCP - -Fixes ------ - -* Prevent freeze on C-FIND if no DICOM tag is to be returned -* Fix slow C-STORE SCP on recent versions of GNU/Linux, if - USE_SYSTEM_DCMTK is set to OFF (http://forum.dcmtk.org/viewtopic.php?f=1&t=4009) -* Fix issue 30 (QR response missing "Query/Retrieve Level" (008,0052)) -* Fix issue 32 (Cyrillic symbols): Introduction of the "Windows1251" encoding -* Plugins now receive duplicated GET arguments in their REST callbacks - - -Version 0.8.6 (2015/02/12) -========================== - -Major ------ - -* URIs to get all the parents of a given resource in a single REST call -* Instances without PatientID are now allowed -* Support of HTTP proxy to access Orthanc peers - -Minor ------ - -* Support of Tudor DICOM in Query/Retrieve -* More flexible "/modify" and "/anonymize" for single instance -* Access to called AET and remote AET from Lua scripts ("OnStoredInstance") -* Option "DicomAssociationCloseDelay" to set delay before closing DICOM association -* ZIP archives now display the accession number of the studies - -Plugins -------- - -* Introspection of plugins (cf. the "/plugins" URI) -* Plugins can access the command-line arguments used to launch Orthanc -* Plugins can extend Orthanc Explorer with custom JavaScript -* Plugins can get/set global properties to save their configuration -* Plugins can do REST calls to other plugins (cf. "xxxAfterPlugins()") -* Scan of folders for plugins - -Fixes ------ - -* Code refactorings -* Fix issue 25 (AET with underscore not allowed) -* Fix replacement and insertion of private DICOM tags -* Fix anonymization generating non-portable DICOM files - - -Version 0.8.5 (2014/11/04) -========================== - -General -------- - -* Major speed-up thanks to a new database schema -* Plugins can monitor changes through callbacks -* Download ZIP + DICOMDIR from Orthanc Explorer -* Sample plugin framework to serve static resources (./Plugins/Samples/WebSkeleton/) - -Fixes ------ - -* Fix issue 19 (YBR_FULL are decoded incorrectly) -* Fix issue 21 (Microsoft Visual Studio precompiled headers) -* Fix issue 22 (Error decoding multi-frame instances) -* Fix issue 24 (Build fails on OSX when directory has .DS_Store files) -* Fix crash when bad HTTP credentials are provided - - -Version 0.8.4 (2014/09/19) -========================== - -* "/instances-tags" to get the tags of all the child instances of a - patient/study/series with a single REST call (bulk tags retrieval) -* Configuration/Lua to select the accepted C-STORE SCP transfer syntaxes -* Fix reporting of errors in Orthanc Explorer when sending images to peers/modalities -* Installation of plugin SDK in CMake - - -Version 0.8.3 (2014/09/11) -========================== - -Major ------ - -* Creation of ZIP archives for media storage, with DICOMDIR -* URIs to get all the children of a given resource in a single REST call -* "/tools/lookup" URI to map DICOM UIDs to Orthanc identifiers -* Support of index-only mode (using the "StoreDicom" option) -* Plugins can implement a custom storage area - -Minor ------ - -* Configuration option to enable HTTP Keep-Alive -* Configuration option to disable the logging of exported resources in "/exports" -* Plugins can retrieve the path to Orthanc and to its configuration file -* "/tools/create-dicom" now accepts the "PatientID" DICOM tag (+ updated sample) -* Possibility to set HTTP headers from plugins -* "LastUpdate" metadata is now always returned for patients, studies and series - -Maintenance ------------ - -* Refactoring of HttpOutput ("Content-Length" header is now always sent) -* Upgrade to Mongoose 3.8 -* Fixes for Visual Studio 2013 and Windows 64bit -* Fix issue 16: Handling of "AT" value representations in JSON -* Fix issue 17 - - -Version 0.8.2 (2014/08/07) -========================== - -* Support of the standard text encodings -* Hot restart of Orthanc by posting to "/tools/reset" -* More fault-tolerant commands in Lua scripts -* Parameter to set the default encoding for DICOM files without SpecificCharacterSet -* Fix of issue #14 (support of XCode 5.1) -* Upgrade to Google Test 1.7.0 - - -Version 0.8.1 (2014/07/29) -========================== - -General -------- - -* Access patient module at the study level to cope with PatientID collisions -* On-the-fly conversion of JSON to XML according to the HTTP Accept header -* C-Echo SCU in the REST API -* DICOM conformance statement available at URI "/tools/dicom-conformance" - -Lua scripts ------------ - -* Lua scripts can do HTTP requests, and thus can call Web services -* Lua scripts can invoke system commands, with CallSystem() - -Plugins -------- - -* Lookup for DICOM UIDs in the plugin SDK -* Plugins have access to the HTTP headers and can answer with HTTP status codes -* Callback to react to the incoming of DICOM instances - -Fixes ------ - -* Fix build of Google Log with Visual Studio >= 11.0 -* Fix automated generation of the list of resource children in the REST API - - -Version 0.8.0 (2014/07/10) -========================== - -Major changes -------------- - -* Routing images with Lua scripts -* Introduction of the Orthanc Plugin SDK -* Official support of OS X (Darwin) 10.8 - -Minor changes -------------- - -* Extraction of tags for the patient/study/series/instance DICOM modules -* Extraction of the tags shared by all the instances of a patient/study/series -* Options to limit the number of results for an incoming C-FIND query -* Support of kFreeBSD -* Several code refactorings -* Fix OrthancCppClient::GetVoxelSizeZ() - - -Version 0.7.6 (2014/06/11) -========================== - -* Support of JPEG and JPEG-LS decompression -* Download DICOM images as Matlab/Octave arrays -* Precompiled headers for Microsoft Visual Studio - - -Version 0.7.5 (2014/05/08) -========================== - -* Dynamic negotiation of SOP classes for C-STORE SCU -* Creation of DICOM instances using the REST API -* Embedding of images within DICOM instances -* Adding/removal/modification of remote modalities/peers through REST -* Reuse of the previous SCU connection to avoid unnecessary handshakes -* Fix problems with anonymization and modification -* Fix missing licensing terms about reuse of some code from DCMTK -* Various code refactorings - - -Version 0.7.4 (2014/04/16) -========================== - -* Switch to openssl-1.0.1g in static builds (cf. Heartbleed exploit) -* Switch to boost 1.55.0 in static builds (to solve compiling errors) -* Better logging about nonexistent tags -* Dcm4Chee manufacturer -* Automatic discovering of the path to the DICOM dictionaries -* In the "DicomModalities" config, the port number can be a string - - -Version 0.7.3 (2014/02/14) -========================== - -Major changes -------------- - -* Fixes in the implementation of the C-FIND handler for Query/Retrieve -* Custom attachment of files to patients, studies, series or instances -* Access to lowlevel info about the attached files through the REST API -* Recover pixel data for more transfer syntaxes (notably JPEG) - -Minor changes -------------- - -* AET comparison is now case-insensitive by default -* Possibility to disable the HTTP server or the DICOM server -* Automatic computation of MD5 hashes for the stored DICOM files -* Maintenance tool to recover DICOM files compressed by Orthanc -* The newline characters in the configuration file are fixed for GNU/Linux -* Capture of the SIGTERM signal in GNU/Linux - - -Version 0.7.2 (2013/11/08) -========================== - -* Support of Query/Retrieve from medInria -* Accept more transfer syntaxes for C-STORE SCP and SCU (notably JPEG) -* Create the meta-header when receiving files through C-STORE SCP -* Fixes and improvements thanks to the static analyzer cppcheck - - -Version 0.7.1 (2013/10/30) -========================== - -* Use ZIP64 only when required to improve compatibility (cf. issue #7) -* Refactoring of the CMake options -* Fix for big-endian architectures (RedHat bug #985748) -* Use filenames with 8 characters in ZIP files for maximum compatibility -* Possibility to build Orthanc inplace (in the source directory) - - -Version 0.7.0 (2013/10/25) -========================== - -Major changes -------------- - -* DICOM Query/Retrieve is supported - -Minor changes -------------- - -* Possibility to keep the PatientID during an anonymization -* Check whether "unzip", "tar" and/or "7-zip" are installed from CMake - - -Version 0.6.2 (2013/10/04) -========================== - -* Build of the C++ client as a shared library -* Improvements and documentation of the C++ client API -* Fix of Debian bug #724947 (licensing issue with the SHA-1 library) -* Switch to Boost 1.54.0 (cf. issue #9) -* "make uninstall" is now possible - - -Version 0.6.1 (2013/09/16) -========================== - -* Detection of stable patients/studies/series -* C-FIND SCU at the instance level -* Link from modified to original resource in Orthanc Explorer -* Fix of issue #8 -* Anonymization of the medical alerts tag (0010,2000) - - -Version 0.6.0 (2013/07/16) -========================== - -Major changes -------------- - -* Introduction of the C++ client -* Send DICOM resources to other Orthanc instances through HTTP -* Access to signed images (instances/.../image-int16) - (Closes: Debian #716958) - -Minor changes -------------- - -* Export of DICOM files to the host filesystem (instances/.../export) -* Statistics about patients, studies, series and instances -* Link from anonymized to original resource in Orthanc Explorer -* Fixes for Red Hat and Debian packaging -* Fixes for history in Orthanc Explorer -* Fixes for boost::thread, as reported by Cyril Paulus -* Fix licensing (Closes: Debian #712038) - -Metadata --------- - -* Access to the metadata through the REST API (.../metadata) -* Support of user-defined metadata -* "LastUpdate" metadata for patients, studies and series -* "/tools/now" to be used in combination with "LastUpdate" -* Improved support of series with temporal positions - - -Version 0.5.2 (2013/05/07) -========================== - -* "Bulk" Store-SCU (send several DICOM instances with the same - DICOM connection) -* Store-SCU for patients and studies in Orthanc Explorer -* Filtering of incoming DICOM instances (through Lua scripting) -* Filtering of incoming HTTP requests (through Lua scripting) -* Clearing of "/exports" and "/changes" -* Check MD5 of third party downloads -* Faking of the HTTP methods PUT and DELETE - - -Version 0.5.1 (2013/04/17) -========================== - -* Support of RGB images -* Fix of store SCU in release builds -* Possibility to store the SQLite index at another place than the - DICOM instances (for performance) - - -Version 0.5.0 (2013/01/31) -========================== - -Major changes -------------- - -* Download of modified or anonymized DICOM instances -* Inplace modification and anonymization of DICOM series, studies and patients - -Minor changes -------------- - -* Support of private tags -* Implementation of the PMSCT_RLE1 image decoding for Philips modalities -* Generation of random DICOM UID through the REST API (/tools/generate-uid) - - -Version 0.4.0 (2012/12/14) -========================== - -Major changes -------------- - -* Recycling of disk space -* Raw access to the value of the DICOM tags in the REST API - -Minor changes -------------- - -* Protection of patients against recycling (also in Orthanc Explorer) -* The DICOM dictionaries are embedded in Windows builds - - -Version 0.3.1 (2012/12/05) -========================== - -* Download archives of patients, studies and series as ZIP files -* Orthanc now checks the version of its database schema before starting - - -Version 0.3.0 (2012/11/30) -========================== - -Major changes -------------- - -* Transparent compression of the DICOM instances on the disk -* The patient/study/series/instances are now indexed by SHA-1 digests - of their DICOM Instance IDs (and not by UUIDs anymore): The same - DICOM objects are thus always identified by the same Orthanc IDs -* Log of exported instances through DICOM C-STORE SCU ("/exported" URI) -* Full refactoring of the DB schema and of the REST API -* Introduction of generic classes for REST APIs (in Core/RestApi) - -Minor changes -------------- - -* "/statistics" URI -* "last" flag to retrieve the last change from the "/changes" URI -* Generate a sample configuration file from command line -* "CompletedSeries" event in the changes API -* Thread to continuously flush DB to disk (SQLite checkpoints for - improved robustness) - - -Version 0.2.3 (2012/10/26) -========================== - -* Use HTTP Content-Disposition to set a filename when downloading JSON/DCM -* URI "/system" for general information about Orthanc -* Versioning info and help on the command line -* Improved logging -* Possibility of dynamic linking against jsoncpp, sqlite, boost and dmctk - for Debian packaging -* Fix some bugs -* Switch to default 8042 port for HTTP - - -Version 0.2.2 (2012/10/04) -========================== - -* Switch to Google Log -* Fixes to Debian packaging - - -Version 0.2.1 (2012/09/28) -========================== - -* Status of series -* Continuous Integration Server is up and running -* Ready for Debian packaging - - -Version 0.2.0 (2012/09/16) -========================== - -Major changes -------------- - -* Renaming to "Orthanc" -* Focus on security: Support of SSL, HTTP Basic Authentication and - interdiction of remote access -* Access to multi-frame images (for nuclear medicine) -* Access to the raw PNG images (in 8bpp and 16bpp) - -Minor changes -------------- - -* Change of the licensing of the "Core/SQLite" folder to BSD (to - reflect the original licensing terms of Chromium, from which the - code derives) -* Standalone build for cross-compilation - - -Version 0.1.1 (2012/07/20) -========================== - -* Fix Windows version -* Native Windows build with Microsoft Visual Studio 2005 -* Add path to storage in Configuration.json - - -Version 0.1.0 (2012/07/19) -========================== - -* Initial release
--- a/Orthanc/Plugins/Samples/Common/ExportedSymbols.list Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,7 +0,0 @@ -# This is the list of the symbols that must be exported by Orthanc -# plugins, if targeting OS X - -_OrthancPluginInitialize -_OrthancPluginFinalize -_OrthancPluginGetName -_OrthancPluginGetVersion
--- a/Orthanc/Plugins/Samples/Common/VersionScript.map Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,12 +0,0 @@ -# This is a version-script for Orthanc plugins - -{ -global: - OrthancPluginInitialize; - OrthancPluginFinalize; - OrthancPluginGetName; - OrthancPluginGetVersion; - -local: - *; -};
--- a/Orthanc/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,99 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "GdcmDecoderCache.h" - -#include "OrthancImageWrapper.h" - -namespace OrthancPlugins -{ - std::string GdcmDecoderCache::ComputeMd5(OrthancPluginContext* context, - const void* dicom, - size_t size) - { - std::string result; - - char* md5 = OrthancPluginComputeMd5(context, dicom, size); - - if (md5 == NULL) - { - throw std::runtime_error("Cannot compute MD5 hash"); - } - - bool ok = false; - try - { - result.assign(md5); - ok = true; - } - catch (...) - { - } - - OrthancPluginFreeString(context, md5); - - if (!ok) - { - throw std::runtime_error("Not enough memory"); - } - else - { - return result; - } - } - - - OrthancImageWrapper* GdcmDecoderCache::Decode(OrthancPluginContext* context, - const void* dicom, - const uint32_t size, - uint32_t frameIndex) - { - std::string md5 = ComputeMd5(context, dicom, size); - - // First check whether the previously decoded image is the same - // as this one - { - boost::mutex::scoped_lock lock(mutex_); - - if (decoder_.get() != NULL && - size_ == size && - md5_ == md5) - { - // This is the same image: Reuse the previous decoding - return new OrthancImageWrapper(context, decoder_->Decode(context, frameIndex)); - } - } - - // This is not the same image - std::auto_ptr<GdcmImageDecoder> decoder(new GdcmImageDecoder(dicom, size)); - std::auto_ptr<OrthancImageWrapper> image(new OrthancImageWrapper(context, decoder->Decode(context, frameIndex))); - - { - // Cache the newly created decoder for further use - boost::mutex::scoped_lock lock(mutex_); - decoder_ = decoder; - size_ = size; - md5_ = md5; - } - - return image.release(); - } -}
--- a/Orthanc/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include "GdcmImageDecoder.h" -#include "OrthancImageWrapper.h" - -#include <boost/thread.hpp> - - -namespace OrthancPlugins -{ - class GdcmDecoderCache : public boost::noncopyable - { - private: - boost::mutex mutex_; - std::auto_ptr<OrthancPlugins::GdcmImageDecoder> decoder_; - size_t size_; - std::string md5_; - - static std::string ComputeMd5(OrthancPluginContext* context, - const void* dicom, - size_t size); - - public: - GdcmDecoderCache() : size_(0) - { - } - - OrthancImageWrapper* Decode(OrthancPluginContext* context, - const void* dicom, - const uint32_t size, - uint32_t frameIndex); - }; -}
--- a/Orthanc/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,403 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "GdcmImageDecoder.h" - -#include "OrthancImageWrapper.h" - -#include <gdcmImageReader.h> -#include <gdcmImageApplyLookupTable.h> -#include <gdcmImageChangePlanarConfiguration.h> -#include <gdcmImageChangePhotometricInterpretation.h> -#include <stdexcept> -#include <boost/iostreams/stream.hpp> -#include <boost/iostreams/device/array.hpp> - - -namespace OrthancPlugins -{ - struct GdcmImageDecoder::PImpl - { - const void* dicom_; - size_t size_; - - gdcm::ImageReader reader_; - std::auto_ptr<gdcm::ImageApplyLookupTable> lut_; - std::auto_ptr<gdcm::ImageChangePhotometricInterpretation> photometric_; - std::auto_ptr<gdcm::ImageChangePlanarConfiguration> interleaved_; - std::string decoded_; - - PImpl(const void* dicom, - size_t size) : - dicom_(dicom), - size_(size) - { - } - - - const gdcm::DataSet& GetDataSet() const - { - return reader_.GetFile().GetDataSet(); - } - - - const gdcm::Image& GetImage() const - { - if (interleaved_.get() != NULL) - { - return interleaved_->GetOutput(); - } - - if (lut_.get() != NULL) - { - return lut_->GetOutput(); - } - - if (photometric_.get() != NULL) - { - return photometric_->GetOutput(); - } - - return reader_.GetImage(); - } - - - void Decode() - { - // Change photometric interpretation or apply LUT, if required - { - const gdcm::Image& image = GetImage(); - if (image.GetPixelFormat().GetSamplesPerPixel() == 1 && - image.GetPhotometricInterpretation() == gdcm::PhotometricInterpretation::PALETTE_COLOR) - { - lut_.reset(new gdcm::ImageApplyLookupTable()); - lut_->SetInput(image); - if (!lut_->Apply()) - { - throw std::runtime_error( "GDCM cannot apply the lookup table"); - } - } - else if (image.GetPixelFormat().GetSamplesPerPixel() == 1) - { - if (image.GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::MONOCHROME1 && - image.GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::MONOCHROME2) - { - photometric_.reset(new gdcm::ImageChangePhotometricInterpretation()); - photometric_->SetInput(image); - photometric_->SetPhotometricInterpretation(gdcm::PhotometricInterpretation::MONOCHROME2); - if (!photometric_->Change() || - GetImage().GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::MONOCHROME2) - { - throw std::runtime_error("GDCM cannot change the photometric interpretation"); - } - } - } - else - { - if (image.GetPixelFormat().GetSamplesPerPixel() == 3 && - image.GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::RGB && - image.GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::YBR_FULL && - (image.GetTransferSyntax() != gdcm::TransferSyntax::JPEG2000Lossless || - image.GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::YBR_RCT)) - { - photometric_.reset(new gdcm::ImageChangePhotometricInterpretation()); - photometric_->SetInput(image); - photometric_->SetPhotometricInterpretation(gdcm::PhotometricInterpretation::RGB); - if (!photometric_->Change() || - GetImage().GetPhotometricInterpretation() != gdcm::PhotometricInterpretation::RGB) - { - throw std::runtime_error("GDCM cannot change the photometric interpretation"); - } - } - } - } - - // Possibly convert planar configuration to interleaved - { - const gdcm::Image& image = GetImage(); - if (image.GetPlanarConfiguration() != 0 && - image.GetPixelFormat().GetSamplesPerPixel() != 1) - { - interleaved_.reset(new gdcm::ImageChangePlanarConfiguration()); - interleaved_->SetInput(image); - if (!interleaved_->Change() || - GetImage().GetPlanarConfiguration() != 0) - { - throw std::runtime_error("GDCM cannot change the planar configuration to interleaved"); - } - } - } - } - }; - - GdcmImageDecoder::GdcmImageDecoder(const void* dicom, - size_t size) : - pimpl_(new PImpl(dicom, size)) - { - // Setup a stream to the memory buffer - using namespace boost::iostreams; - basic_array_source<char> source(reinterpret_cast<const char*>(dicom), size); - stream<basic_array_source<char> > stream(source); - - // Parse the DICOM instance using GDCM - pimpl_->reader_.SetStream(stream); - if (!pimpl_->reader_.Read()) - { - throw std::runtime_error("Bad file format"); - } - - pimpl_->Decode(); - } - - - OrthancPluginPixelFormat GdcmImageDecoder::GetFormat() const - { - const gdcm::Image& image = pimpl_->GetImage(); - - if (image.GetPixelFormat().GetSamplesPerPixel() == 1 && - (image.GetPhotometricInterpretation() == gdcm::PhotometricInterpretation::MONOCHROME1 || - image.GetPhotometricInterpretation() == gdcm::PhotometricInterpretation::MONOCHROME2)) - { - switch (image.GetPixelFormat()) - { - case gdcm::PixelFormat::UINT16: - return OrthancPluginPixelFormat_Grayscale16; - - case gdcm::PixelFormat::INT16: - return OrthancPluginPixelFormat_SignedGrayscale16; - - case gdcm::PixelFormat::UINT8: - return OrthancPluginPixelFormat_Grayscale8; - - default: - throw std::runtime_error("Unsupported pixel format"); - } - } - else if (image.GetPixelFormat().GetSamplesPerPixel() == 3 && - (image.GetPhotometricInterpretation() == gdcm::PhotometricInterpretation::RGB || - image.GetPhotometricInterpretation() == gdcm::PhotometricInterpretation::YBR_FULL || - image.GetPhotometricInterpretation() == gdcm::PhotometricInterpretation::YBR_RCT)) - { - switch (image.GetPixelFormat()) - { - case gdcm::PixelFormat::UINT8: - return OrthancPluginPixelFormat_RGB24; - - case gdcm::PixelFormat::UINT16: -#if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 3, 1) - return OrthancPluginPixelFormat_RGB48; -#else - throw std::runtime_error("RGB48 pixel format is only supported if compiled against Orthanc SDK >= 1.3.1"); -#endif - - default: - break; - } - } - - throw std::runtime_error("Unsupported pixel format"); - } - - - unsigned int GdcmImageDecoder::GetWidth() const - { - return pimpl_->GetImage().GetColumns(); - } - - - unsigned int GdcmImageDecoder::GetHeight() const - { - return pimpl_->GetImage().GetRows(); - } - - - unsigned int GdcmImageDecoder::GetFramesCount() const - { - return pimpl_->GetImage().GetDimension(2); - } - - - size_t GdcmImageDecoder::GetBytesPerPixel(OrthancPluginPixelFormat format) - { - switch (format) - { - case OrthancPluginPixelFormat_Grayscale8: - return 1; - - case OrthancPluginPixelFormat_Grayscale16: - case OrthancPluginPixelFormat_SignedGrayscale16: - return 2; - - case OrthancPluginPixelFormat_RGB24: - return 3; - -#if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 3, 1) - case OrthancPluginPixelFormat_RGB48: - return 6; -#endif - - default: - throw std::runtime_error("Unsupport pixel format"); - } - } - - static void ConvertYbrToRgb(uint8_t rgb[3], - const uint8_t ybr[3]) - { - // http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.6.3.html#sect_C.7.6.3.1.2 - // https://en.wikipedia.org/wiki/YCbCr#JPEG_conversion - - // TODO - Check out the outcome of Mathieu's discussion about - // truncation of YCbCr-to-RGB conversion: - // https://groups.google.com/forum/#!msg/comp.protocols.dicom/JHuGeyWbTz8/ARoTWrJzAQAJ - - const float Y = ybr[0]; - const float Cb = ybr[1]; - const float Cr = ybr[2]; - - const float result[3] = { - Y + 1.402f * (Cr - 128.0f), - Y - 0.344136f * (Cb - 128.0f) - 0.714136f * (Cr - 128.0f), - Y + 1.772f * (Cb - 128.0f) - }; - - for (uint8_t i = 0; i < 3 ; i++) - { - if (result[i] < 0) - { - rgb[i] = 0; - } - else if (result[i] > 255) - { - rgb[i] = 255; - } - else - { - rgb[i] = static_cast<uint8_t>(result[i]); - } - } - } - - - static void FixPhotometricInterpretation(OrthancImageWrapper& image, - gdcm::PhotometricInterpretation interpretation) - { - switch (interpretation) - { - case gdcm::PhotometricInterpretation::RGB: - return; - - case gdcm::PhotometricInterpretation::YBR_FULL: - { - // Fix for Osimis issue WVB-319: Some images are not loading in US_MF - - uint32_t width = image.GetWidth(); - uint32_t height = image.GetHeight(); - uint32_t pitch = image.GetPitch(); - uint8_t* buffer = reinterpret_cast<uint8_t*>(image.GetBuffer()); - - if (image.GetFormat() != OrthancPluginPixelFormat_RGB24 || - pitch < 3 * width) - { - throw std::runtime_error("Internal error"); - } - - for (uint32_t y = 0; y < height; y++) - { - uint8_t* p = buffer + y * pitch; - for (uint32_t x = 0; x < width; x++, p += 3) - { - const uint8_t ybr[3] = { p[0], p[1], p[2] }; - uint8_t rgb[3]; - ConvertYbrToRgb(rgb, ybr); - p[0] = rgb[0]; - p[1] = rgb[1]; - p[2] = rgb[2]; - } - } - - return; - } - - default: - throw std::runtime_error("Unsupported output photometric interpretation"); - } - } - - - OrthancPluginImage* GdcmImageDecoder::Decode(OrthancPluginContext* context, - unsigned int frameIndex) const - { - unsigned int frames = GetFramesCount(); - unsigned int width = GetWidth(); - unsigned int height = GetHeight(); - OrthancPluginPixelFormat format = GetFormat(); - size_t bpp = GetBytesPerPixel(format); - - if (frameIndex >= frames) - { - throw std::runtime_error("Inexistent frame index"); - } - - std::string& decoded = pimpl_->decoded_; - OrthancImageWrapper target(context, format, width, height); - - if (width == 0 || - height == 0) - { - return target.Release(); - } - - if (decoded.empty()) - { - decoded.resize(pimpl_->GetImage().GetBufferLength()); - pimpl_->GetImage().GetBuffer(&decoded[0]); - } - - const void* sourceBuffer = &decoded[0]; - - if (target.GetPitch() == bpp * width && - frames == 1) - { - assert(decoded.size() == target.GetPitch() * target.GetHeight()); - memcpy(target.GetBuffer(), sourceBuffer, decoded.size()); - } - else - { - size_t targetPitch = target.GetPitch(); - size_t sourcePitch = width * bpp; - - const char* a = &decoded[sourcePitch * height * frameIndex]; - char* b = target.GetBuffer(); - - for (uint32_t y = 0; y < height; y++) - { - memcpy(b, a, sourcePitch); - a += sourcePitch; - b += targetPitch; - } - } - - FixPhotometricInterpretation(target, pimpl_->GetImage().GetPhotometricInterpretation()); - - return target.Release(); - } -}
--- a/Orthanc/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <orthanc/OrthancCPlugin.h> -#include <stdint.h> -#include <boost/noncopyable.hpp> -#include <boost/shared_ptr.hpp> - - -// This is for compatibility with Orthanc SDK <= 1.3.0 -#if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) -#define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \ - (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \ - (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \ - (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \ - (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \ - ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision)))) -#endif - - -namespace OrthancPlugins -{ - class GdcmImageDecoder : public boost::noncopyable - { - private: - struct PImpl; - boost::shared_ptr<PImpl> pimpl_; - - public: - GdcmImageDecoder(const void* dicom, - size_t size); - - OrthancPluginPixelFormat GetFormat() const; - - unsigned int GetWidth() const; - - unsigned int GetHeight() const; - - unsigned int GetFramesCount() const; - - static size_t GetBytesPerPixel(OrthancPluginPixelFormat format); - - OrthancPluginImage* Decode(OrthancPluginContext* context, - unsigned int frameIndex) const; - }; -}
--- a/Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,100 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#include "OrthancImageWrapper.h" - -#include <stdexcept> - -namespace OrthancPlugins -{ - OrthancImageWrapper::OrthancImageWrapper(OrthancPluginContext* context, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height) : - context_(context) - { - image_ = OrthancPluginCreateImage(context_, format, width, height); - if (image_ == NULL) - { - throw std::runtime_error("Cannot create an image"); - } - } - - - OrthancImageWrapper::OrthancImageWrapper(OrthancPluginContext* context, - OrthancPluginImage* image) : - context_(context), - image_(image) - { - if (image_ == NULL) - { - throw std::runtime_error("Invalid image returned by the core of Orthanc"); - } - } - - - - OrthancImageWrapper::~OrthancImageWrapper() - { - if (image_ != NULL) - { - OrthancPluginFreeImage(context_, image_); - } - } - - - OrthancPluginImage* OrthancImageWrapper::Release() - { - OrthancPluginImage* tmp = image_; - image_ = NULL; - return tmp; - } - - - uint32_t OrthancImageWrapper::GetWidth() - { - return OrthancPluginGetImageWidth(context_, image_); - } - - - uint32_t OrthancImageWrapper::GetHeight() - { - return OrthancPluginGetImageHeight(context_, image_); - } - - - uint32_t OrthancImageWrapper::GetPitch() - { - return OrthancPluginGetImagePitch(context_, image_); - } - - - OrthancPluginPixelFormat OrthancImageWrapper::GetFormat() - { - return OrthancPluginGetImagePixelFormat(context_, image_); - } - - - char* OrthancImageWrapper::GetBuffer() - { - return reinterpret_cast<char*>(OrthancPluginGetImageBuffer(context_, image_)); - } -}
--- a/Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,64 +0,0 @@ -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * Copyright (C) 2017-2018 Osimis S.A., Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - -#pragma once - -#include <orthanc/OrthancCPlugin.h> - -#include "GdcmImageDecoder.h" - -namespace OrthancPlugins -{ - class OrthancImageWrapper - { - private: - OrthancPluginContext* context_; - OrthancPluginImage* image_; - - public: - OrthancImageWrapper(OrthancPluginContext* context, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height); - - OrthancImageWrapper(OrthancPluginContext* context, - OrthancPluginImage* image); // Takes ownership - - ~OrthancImageWrapper(); - - OrthancPluginContext* GetContext() - { - return context_; - } - - OrthancPluginImage* Release(); - - uint32_t GetWidth(); - - uint32_t GetHeight(); - - uint32_t GetPitch(); - - OrthancPluginPixelFormat GetFormat(); - - char* GetBuffer(); - }; -}
--- a/Orthanc/Plugins/Samples/GdcmDecoder/README Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,6 +0,0 @@ -This sample shows how to replace the decoder of DICOM images that is -built in Orthanc, by the GDCM library. - -A production-ready version of this sample, is available in the -offical Web viewer plugin: -http://www.orthanc-server.com/static.php?page=web-viewer
--- a/Orthanc/README.txt Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,3 +0,0 @@ -This folder contains an excerpt of the source code of Orthanc. It is -automatically generated using the "../Resources/SyncOrthancFolder.py" -script.
--- a/Orthanc/Resources/CMake/AutoGeneratedCode.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,53 +0,0 @@ -set(AUTOGENERATED_DIR "${CMAKE_CURRENT_BINARY_DIR}/AUTOGENERATED") -set(AUTOGENERATED_SOURCES) - -file(MAKE_DIRECTORY ${AUTOGENERATED_DIR}) -include_directories(${AUTOGENERATED_DIR}) - -macro(EmbedResources) - # Convert a semicolon separated list to a whitespace separated string - set(SCRIPT_OPTIONS) - set(SCRIPT_ARGUMENTS) - set(DEPENDENCIES) - set(IS_PATH_NAME false) - - # Loop over the arguments of the function - foreach(arg ${ARGN}) - # Extract the first character of the argument - string(SUBSTRING "${arg}" 0 1 FIRST_CHAR) - if (${FIRST_CHAR} STREQUAL "-") - # If the argument starts with a dash "-", this is an option to - # EmbedResources.py - list(APPEND SCRIPT_OPTIONS ${arg}) - else() - if (${IS_PATH_NAME}) - list(APPEND SCRIPT_ARGUMENTS "${arg}") - list(APPEND DEPENDENCIES "${arg}") - set(IS_PATH_NAME false) - else() - list(APPEND SCRIPT_ARGUMENTS "${arg}") - set(IS_PATH_NAME true) - endif() - endif() - endforeach() - - set(TARGET_BASE "${AUTOGENERATED_DIR}/EmbeddedResources") - add_custom_command( - OUTPUT - "${TARGET_BASE}.h" - "${TARGET_BASE}.cpp" - COMMAND - ${PYTHON_EXECUTABLE} - "${ORTHANC_ROOT}/Resources/EmbedResources.py" - ${SCRIPT_OPTIONS} - "${AUTOGENERATED_DIR}/EmbeddedResources" - ${SCRIPT_ARGUMENTS} - DEPENDS - "${ORTHANC_ROOT}/Resources/EmbedResources.py" - ${DEPENDENCIES} - ) - - list(APPEND AUTOGENERATED_SOURCES - "${AUTOGENERATED_DIR}/EmbeddedResources.cpp" - ) -endmacro()
--- a/Orthanc/Resources/CMake/BoostConfiguration.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,310 +0,0 @@ -if (STATIC_BUILD OR NOT USE_SYSTEM_BOOST) - set(BOOST_STATIC 1) -else() - include(FindBoost) - - set(BOOST_STATIC 0) - #set(Boost_DEBUG 1) - #set(Boost_USE_STATIC_LIBS ON) - - if (ENABLE_LOCALE) - list(APPEND ORTHANC_BOOST_COMPONENTS locale) - endif() - - list(APPEND ORTHANC_BOOST_COMPONENTS filesystem thread system date_time regex) - find_package(Boost COMPONENTS "${ORTHANC_BOOST_COMPONENTS}") - - if (NOT Boost_FOUND) - foreach (item ${ORTHANC_BOOST_COMPONENTS}) - string(TOUPPER ${item} tmp) - - if (Boost_${tmp}_FOUND) - set(tmp2 "found") - else() - set(tmp2 "missing") - endif() - - message("Boost component ${item} - ${tmp2}") - endforeach() - - message(FATAL_ERROR "Unable to locate Boost on this system") - endif() - - # Boost releases 1.44 through 1.47 supply both V2 and V3 filesystem - # http://www.boost.org/doc/libs/1_46_1/libs/filesystem/v3/doc/index.htm - if (${Boost_VERSION} LESS 104400) - add_definitions( - -DBOOST_HAS_FILESYSTEM_V3=0 - ) - else() - add_definitions( - -DBOOST_HAS_FILESYSTEM_V3=1 - -DBOOST_FILESYSTEM_VERSION=3 - ) - endif() - - include_directories(${Boost_INCLUDE_DIRS}) - link_libraries(${Boost_LIBRARIES}) -endif() - - -if (BOOST_STATIC) - ## - ## Parameters for static compilation of Boost - ## - - set(BOOST_NAME boost_1_66_0) - set(BOOST_BCP_SUFFIX bcpdigest-1.3.2) - set(BOOST_MD5 "e509e66140e8f2fd4d326b0052825f52") - set(BOOST_URL "http://www.orthanc-server.com/downloads/third-party/${BOOST_NAME}_${BOOST_BCP_SUFFIX}.tar.gz") - set(BOOST_SOURCES_DIR ${CMAKE_BINARY_DIR}/${BOOST_NAME}) - - if (IS_DIRECTORY "${BOOST_SOURCES_DIR}") - set(FirstRun OFF) - else() - set(FirstRun ON) - endif() - - DownloadPackage(${BOOST_MD5} ${BOOST_URL} "${BOOST_SOURCES_DIR}") - - - ## - ## Generic configuration of Boost - ## - - if (CMAKE_COMPILER_IS_GNUCXX) - add_definitions(-isystem ${BOOST_SOURCES_DIR}) - endif() - - include_directories( - ${BOOST_SOURCES_DIR} - ) - - add_definitions( - # Static build of Boost - -DBOOST_ALL_NO_LIB - -DBOOST_ALL_NOLIB - -DBOOST_DATE_TIME_NO_LIB - -DBOOST_THREAD_BUILD_LIB - -DBOOST_PROGRAM_OPTIONS_NO_LIB - -DBOOST_REGEX_NO_LIB - -DBOOST_SYSTEM_NO_LIB - -DBOOST_LOCALE_NO_LIB - ) - - set(BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/system/src/error_code.cpp - ) - - if ("${CMAKE_SYSTEM_VERSION}" STREQUAL "LinuxStandardBase") - add_definitions( - -DBOOST_SYSTEM_USE_STRERROR=1 - ) - - execute_process( - COMMAND ${PATCH_EXECUTABLE} -p0 -N -i - ${ORTHANC_ROOT}/Resources/Patches/boost-1.66.0-linux-standard-base.patch - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - ) - - if (FirstRun AND Failure) - message(FATAL_ERROR "Error while patching a file") - endif() - endif() - - - ## - ## Configuration of boost::thread - ## - - if (CMAKE_SYSTEM_NAME STREQUAL "Linux" OR - CMAKE_SYSTEM_NAME STREQUAL "Darwin" OR - CMAKE_SYSTEM_NAME STREQUAL "FreeBSD" OR - CMAKE_SYSTEM_NAME STREQUAL "kFreeBSD" OR - CMAKE_SYSTEM_NAME STREQUAL "OpenBSD" OR - CMAKE_SYSTEM_NAME STREQUAL "PNaCl" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl32" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl64") - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/atomic/src/lockpool.cpp - ${BOOST_SOURCES_DIR}/libs/thread/src/pthread/once.cpp - ${BOOST_SOURCES_DIR}/libs/thread/src/pthread/thread.cpp - ) - - if ("${CMAKE_SYSTEM_VERSION}" STREQUAL "LinuxStandardBase" OR - CMAKE_SYSTEM_NAME STREQUAL "PNaCl" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl32" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl64") - add_definitions(-DBOOST_HAS_SCHED_YIELD=1) - endif() - - elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows") - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/thread/src/win32/tss_dll.cpp - ${BOOST_SOURCES_DIR}/libs/thread/src/win32/thread.cpp - ${BOOST_SOURCES_DIR}/libs/thread/src/win32/tss_pe.cpp - ) - - elseif (CMAKE_SYSTEM_NAME STREQUAL "Emscripten") - # No support for threads in WebAssembly - - else() - message(FATAL_ERROR "Support your platform here") - endif() - - - ## - ## Configuration of boost::regex - ## - - aux_source_directory(${BOOST_SOURCES_DIR}/libs/regex/src BOOST_REGEX_SOURCES) - - list(APPEND BOOST_SOURCES - ${BOOST_REGEX_SOURCES} - ) - - - ## - ## Configuration of boost::datetime - ## - - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/date_time/src/gregorian/greg_month.cpp - ) - - - ## - ## Configuration of boost::filesystem - ## - - if (CMAKE_SYSTEM_NAME STREQUAL "PNaCl" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl32" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl64") - # boost::filesystem is not available on PNaCl - add_definitions( - -DBOOST_HAS_FILESYSTEM_V3=0 - -D__INTEGRITY=1 - ) - else() - add_definitions( - -DBOOST_HAS_FILESYSTEM_V3=1 - ) - list(APPEND BOOST_SOURCES - ${BOOST_NAME}/libs/filesystem/src/codecvt_error_category.cpp - ${BOOST_NAME}/libs/filesystem/src/operations.cpp - ${BOOST_NAME}/libs/filesystem/src/path.cpp - ${BOOST_NAME}/libs/filesystem/src/path_traits.cpp - ) - - if (CMAKE_SYSTEM_NAME STREQUAL "Darwin" OR - CMAKE_SYSTEM_NAME STREQUAL "OpenBSD" OR - CMAKE_SYSTEM_NAME STREQUAL "FreeBSD") - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/filesystem/src/utf8_codecvt_facet.cpp - ) - - elseif (CMAKE_SYSTEM_NAME STREQUAL "Windows") - list(APPEND BOOST_SOURCES - ${BOOST_NAME}/libs/filesystem/src/windows_file_codecvt.cpp - ) - endif() - endif() - - - ## - ## Configuration of boost::locale - ## - - if (NOT ENABLE_LOCALE) - message("boost::locale is disabled") - else() - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/locale/src/encoding/codepage.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/generator.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/date_time.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/formatting.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/ids.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/localization_backend.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/message.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/shared/mo_lambda.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/util/codecvt_converter.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/util/default_locale.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/util/gregorian.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/util/info.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/util/locale_data.cpp - ) - - if (CMAKE_SYSTEM_NAME STREQUAL "OpenBSD" OR - CMAKE_SYSTEM_VERSION STREQUAL "LinuxStandardBase") - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/locale/src/std/codecvt.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/std/collate.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/std/converter.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/std/numeric.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/std/std_backend.cpp - ) - - add_definitions( - -DBOOST_LOCALE_WITH_ICONV=1 - -DBOOST_LOCALE_NO_WINAPI_BACKEND=1 - -DBOOST_LOCALE_NO_POSIX_BACKEND=1 - ) - - elseif (CMAKE_SYSTEM_NAME STREQUAL "Linux" OR - CMAKE_SYSTEM_NAME STREQUAL "Darwin" OR - CMAKE_SYSTEM_NAME STREQUAL "FreeBSD" OR - CMAKE_SYSTEM_NAME STREQUAL "kFreeBSD" OR - CMAKE_SYSTEM_NAME STREQUAL "PNaCl" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl32" OR - CMAKE_SYSTEM_NAME STREQUAL "NaCl64" OR - CMAKE_SYSTEM_NAME STREQUAL "Emscripten") # For WebAssembly or asm.js - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/locale/src/posix/codecvt.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/posix/collate.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/posix/converter.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/posix/numeric.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/posix/posix_backend.cpp - ) - - add_definitions( - -DBOOST_LOCALE_WITH_ICONV=1 - -DBOOST_LOCALE_NO_WINAPI_BACKEND=1 - -DBOOST_LOCALE_NO_STD_BACKEND=1 - ) - - elseif (CMAKE_SYSTEM_NAME STREQUAL "Windows") - list(APPEND BOOST_SOURCES - ${BOOST_SOURCES_DIR}/libs/locale/src/win32/collate.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/win32/converter.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/win32/lcid.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/win32/numeric.cpp - ${BOOST_SOURCES_DIR}/libs/locale/src/win32/win_backend.cpp - ) - - add_definitions( - -DBOOST_LOCALE_NO_POSIX_BACKEND=1 - -DBOOST_LOCALE_NO_STD_BACKEND=1 - ) - - # Starting with release 0.8.2, Orthanc statically links against - # libiconv, even on Windows. Indeed, the "WCONV" library of - # Windows XP seems not to support properly several codepages - # (notably "Latin3", "Hebrew", and "Arabic"). Set - # "USE_BOOST_ICONV" to "OFF" to use WCONV anyway. - - if (USE_BOOST_ICONV) - add_definitions(-DBOOST_LOCALE_WITH_ICONV=1) - else() - add_definitions(-DBOOST_LOCALE_WITH_WCONV=1) - endif() - - else() - message(FATAL_ERROR "Support your platform here") - endif() - endif() - - - source_group(ThirdParty\\boost REGULAR_EXPRESSION ${BOOST_SOURCES_DIR}/.*) - -endif()
--- a/Orthanc/Resources/CMake/Compiler.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,220 +0,0 @@ -# This file sets all the compiler-related flags - -if (CMAKE_CROSSCOMPILING OR - "${CMAKE_SYSTEM_VERSION}" STREQUAL "LinuxStandardBase") - # Cross-compilation necessarily implies standalone and static build - SET(STATIC_BUILD ON) - SET(STANDALONE_BUILD ON) -endif() - -if (CMAKE_COMPILER_IS_GNUCXX) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wno-long-long") - - # --std=c99 makes libcurl not to compile - # -pedantic gives a lot of warnings on OpenSSL - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wno-long-long -Wno-variadic-macros") - - if (CMAKE_CROSSCOMPILING) - # http://stackoverflow.com/a/3543845/881731 - set(CMAKE_RC_COMPILE_OBJECT "<CMAKE_RC_COMPILER> -O coff -I<CMAKE_CURRENT_SOURCE_DIR> <SOURCE> <OBJECT>") - endif() - -elseif (MSVC) - # Use static runtime under Visual Studio - # http://www.cmake.org/Wiki/CMake_FAQ#Dynamic_Replace - # http://stackoverflow.com/a/6510446 - foreach(flag_var - CMAKE_C_FLAGS_DEBUG - CMAKE_CXX_FLAGS_DEBUG - CMAKE_C_FLAGS_RELEASE - CMAKE_CXX_FLAGS_RELEASE - CMAKE_C_FLAGS_MINSIZEREL - CMAKE_CXX_FLAGS_MINSIZEREL - CMAKE_C_FLAGS_RELWITHDEBINFO - CMAKE_CXX_FLAGS_RELWITHDEBINFO) - string(REGEX REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}") - string(REGEX REPLACE "/MDd" "/MTd" ${flag_var} "${${flag_var}}") - endforeach(flag_var) - - # Add /Zm256 compiler option to Visual Studio to fix PCH errors - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Zm256") - - add_definitions( - -D_CRT_SECURE_NO_WARNINGS=1 - -D_CRT_SECURE_NO_DEPRECATE=1 - ) - - if (MSVC_VERSION LESS 1600) - # Starting with Visual Studio >= 2010 (i.e. macro _MSC_VER >= - # 1600), Microsoft ships a standard-compliant <stdint.h> - # header. For earlier versions of Visual Studio, give access to a - # compatibility header. - # http://stackoverflow.com/a/70630/881731 - # https://en.wikibooks.org/wiki/C_Programming/C_Reference/stdint.h#External_links - include_directories(${ORTHANC_ROOT}/Resources/ThirdParty/VisualStudio) - endif() - - link_libraries(netapi32) -endif() - - -if (${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD" OR - ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - # In FreeBSD/OpenBSD, the "/usr/local/" folder contains the ports and need to be imported - SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -I/usr/local/include") - SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I/usr/local/include") - SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -L/usr/local/lib") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -L/usr/local/lib") -endif() - - -if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" OR - ${CMAKE_SYSTEM_NAME} STREQUAL "kFreeBSD" OR - ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD" OR - ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - - if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - # The "--no-undefined" linker flag makes the shared libraries - # (plugins ModalityWorklists and ServeFolders) fail to compile on OpenBSD - set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -Wl,--no-undefined") - set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined") - endif() - - if (NOT DEFINED ENABLE_PLUGINS_VERSION_SCRIPT OR - ENABLE_PLUGINS_VERSION_SCRIPT) - set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--version-script=${ORTHANC_ROOT}/Plugins/Samples/Common/VersionScript.map") - endif() - - # Remove the "-rdynamic" option - # http://www.mail-archive.com/cmake@cmake.org/msg08837.html - set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "") - link_libraries(pthread) - - if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - link_libraries(rt) - endif() - - if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD" AND - NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - link_libraries(dl) - endif() - - if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD" AND - NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - # The "--as-needed" linker flag is not available on FreeBSD and OpenBSD - set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--as-needed") - set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -Wl,--as-needed") - set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--as-needed") - endif() - - if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD" AND - NOT ${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD") - # FreeBSD/OpenBSD have just one single interface for file - # handling, which is 64bit clean, so there is no need to define macro - # for LFS (Large File Support). - # https://ohse.de/uwe/articles/lfs.html - add_definitions( - -D_LARGEFILE64_SOURCE=1 - -D_FILE_OFFSET_BITS=64 - ) - endif() - -elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Windows") - if (MSVC) - message("MSVC compiler version = " ${MSVC_VERSION} "\n") - # Starting Visual Studio 2013 (version 1800), it is not possible - # to target Windows XP anymore - if (MSVC_VERSION LESS 1800) - add_definitions( - -DWINVER=0x0501 - -D_WIN32_WINNT=0x0501 - ) - endif() - else() - add_definitions( - -DWINVER=0x0501 - -D_WIN32_WINNT=0x0501 - ) - endif() - - add_definitions( - -D_CRT_SECURE_NO_WARNINGS=1 - ) - link_libraries(rpcrt4 ws2_32) - - if (CMAKE_COMPILER_IS_GNUCXX) - # Some additional C/C++ compiler flags for MinGW - SET(MINGW_NO_WARNINGS "-Wno-unused-function -Wno-unused-variable") - SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${MINGW_NO_WARNINGS} -Wno-pointer-to-int-cast -Wno-int-to-pointer-cast") - SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${MINGW_NO_WARNINGS}") - - # This is a patch for MinGW64 - SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--allow-multiple-definition -static-libgcc -static-libstdc++") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--allow-multiple-definition -static-libgcc -static-libstdc++") - - CHECK_LIBRARY_EXISTS(winpthread pthread_create "" HAVE_WIN_PTHREAD) - if (HAVE_WIN_PTHREAD) - # This line is necessary to compile with recent versions of MinGW, - # otherwise "libwinpthread-1.dll" is not statically linked. - SET(CMAKE_CXX_STANDARD_LIBRARIES "${CMAKE_CXX_STANDARD_LIBRARIES} -Wl,-Bstatic -lstdc++ -lpthread -Wl,-Bdynamic") - add_definitions(-DHAVE_WIN_PTHREAD=1) - else() - add_definitions(-DHAVE_WIN_PTHREAD=0) - endif() - endif() - -elseif (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -exported_symbols_list ${ORTHANC_ROOT}/Plugins/Samples/Common/ExportedSymbols.list") - - add_definitions( - -D_XOPEN_SOURCE=1 - ) - link_libraries(iconv) - -elseif (CMAKE_SYSTEM_NAME STREQUAL "Emscripten") - message("Building using Emscripten (for WebAssembly or asm.js targets)") - - # The BINARYEN_TRAP_MODE specifies what to do when divisions per - # zero (and similar conditions like integer overflows) are - # encountered: The "clamp" mode avoids throwing errors, as they - # cannot be properly catched by "try {} catch (...)" constructions. - set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -s EXTRA_EXPORTED_RUNTIME_METHODS='[\"ccall\", \"cwrap\"]' -s BINARYEN_TRAP_MODE='\"clamp\"'") - -else() - message(FATAL_ERROR "Support your platform here") -endif() - - -if (DEFINED ENABLE_PROFILING AND ENABLE_PROFILING) - if (CMAKE_COMPILER_IS_GNUCXX) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pg") - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -pg") - set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -pg") - set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -pg") - set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -pg") - else() - message(FATAL_ERROR "Don't know how to enable profiling on your configuration") - endif() -endif() - - -if (CMAKE_COMPILER_IS_GNUCXX) - # "When creating a static library using binutils (ar) and there - # exist a duplicate object name (e.g. a/Foo.cpp.o, b/Foo.cpp.o), the - # resulting static library can end up having only one of the - # duplicate objects. [...] This bug only happens if there are many - # objects." The trick consists in replacing the "r" argument - # ("replace") provided to "ar" (as used in CMake < 3.1) by the "q" - # argument ("quick append"). This is because of the fact that CMake - # will invoke "ar" several times with several batches of ".o" - # objects, and using "r" would overwrite symbols defined in - # preceding batches. https://cmake.org/Bug/view.php?id=14874 - set(CMAKE_CXX_ARCHIVE_APPEND "<CMAKE_AR> <LINK_FLAGS> q <TARGET> <OBJECTS>") -endif() - - -if (STATIC_BUILD) - add_definitions(-DORTHANC_STATIC=1) -else() - add_definitions(-DORTHANC_STATIC=0) -endif()
--- a/Orthanc/Resources/CMake/DownloadPackage.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,172 +0,0 @@ -macro(GetUrlFilename TargetVariable Url) - string(REGEX REPLACE "^.*/" "" ${TargetVariable} "${Url}") -endmacro() - - -macro(GetUrlExtension TargetVariable Url) - #string(REGEX REPLACE "^.*/[^.]*\\." "" TMP "${Url}") - string(REGEX REPLACE "^.*\\." "" TMP "${Url}") - string(TOLOWER "${TMP}" "${TargetVariable}") -endmacro() - - - -## -## Setup the patch command-line tool -## - -if (NOT ORTHANC_DISABLE_PATCH) - if ("${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "Windows") - set(PATCH_EXECUTABLE ${CMAKE_CURRENT_LIST_DIR}/../ThirdParty/patch/patch.exe) - if (NOT EXISTS ${PATCH_EXECUTABLE}) - message(FATAL_ERROR "Unable to find the patch.exe tool that is shipped with Orthanc") - endif() - - else () - find_program(PATCH_EXECUTABLE patch) - if (${PATCH_EXECUTABLE} MATCHES "PATCH_EXECUTABLE-NOTFOUND") - message(FATAL_ERROR "Please install the 'patch' standard command-line tool") - endif() - endif() -endif() - - - -## -## Check the existence of the required decompression tools -## - -if ("${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "Windows") - find_program(ZIP_EXECUTABLE 7z - PATHS - "$ENV{ProgramFiles}/7-Zip" - "$ENV{ProgramW6432}/7-Zip" - ) - - if (${ZIP_EXECUTABLE} MATCHES "ZIP_EXECUTABLE-NOTFOUND") - message(FATAL_ERROR "Please install the '7-zip' software (http://www.7-zip.org/)") - endif() - -else() - find_program(UNZIP_EXECUTABLE unzip) - if (${UNZIP_EXECUTABLE} MATCHES "UNZIP_EXECUTABLE-NOTFOUND") - message(FATAL_ERROR "Please install the 'unzip' package") - endif() - - find_program(TAR_EXECUTABLE tar) - if (${TAR_EXECUTABLE} MATCHES "TAR_EXECUTABLE-NOTFOUND") - message(FATAL_ERROR "Please install the 'tar' package") - endif() -endif() - - -macro(DownloadPackage MD5 Url TargetDirectory) - if (NOT IS_DIRECTORY "${TargetDirectory}") - GetUrlFilename(TMP_FILENAME "${Url}") - - set(TMP_PATH "${CMAKE_SOURCE_DIR}/ThirdPartyDownloads/${TMP_FILENAME}") - if (NOT EXISTS "${TMP_PATH}") - message("Downloading ${Url}") - - # This fixes issue 6: "I think cmake shouldn't download the - # packages which are not in the system, it should stop and let - # user know." - # https://code.google.com/p/orthanc/issues/detail?id=6 - if (NOT STATIC_BUILD AND NOT ALLOW_DOWNLOADS) - message(FATAL_ERROR "CMake is not allowed to download from Internet. Please set the ALLOW_DOWNLOADS option to ON") - endif() - - file(DOWNLOAD "${Url}" "${TMP_PATH}" - SHOW_PROGRESS EXPECTED_MD5 "${MD5}" - TIMEOUT 60 INACTIVITY_TIMEOUT 60) - else() - message("Using local copy of ${Url}") - endif() - - GetUrlExtension(TMP_EXTENSION "${Url}") - #message(${TMP_EXTENSION}) - message("Uncompressing ${TMP_FILENAME}") - - if ("${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "Windows") - # How to silently extract files using 7-zip - # http://superuser.com/questions/331148/7zip-command-line-extract-silently-quietly - - if (("${TMP_EXTENSION}" STREQUAL "gz") OR - ("${TMP_EXTENSION}" STREQUAL "tgz") OR - ("${TMP_EXTENSION}" STREQUAL "xz")) - execute_process( - COMMAND ${ZIP_EXECUTABLE} e -y ${TMP_PATH} - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - OUTPUT_QUIET - ) - - if (Failure) - message(FATAL_ERROR "Error while running the uncompression tool") - endif() - - if ("${TMP_EXTENSION}" STREQUAL "tgz") - string(REGEX REPLACE ".tgz$" ".tar" TMP_FILENAME2 "${TMP_FILENAME}") - elseif ("${TMP_EXTENSION}" STREQUAL "gz") - string(REGEX REPLACE ".gz$" "" TMP_FILENAME2 "${TMP_FILENAME}") - elseif ("${TMP_EXTENSION}" STREQUAL "xz") - string(REGEX REPLACE ".xz" "" TMP_FILENAME2 "${TMP_FILENAME}") - endif() - - execute_process( - COMMAND ${ZIP_EXECUTABLE} x -y ${TMP_FILENAME2} - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - OUTPUT_QUIET - ) - elseif ("${TMP_EXTENSION}" STREQUAL "zip") - execute_process( - COMMAND ${ZIP_EXECUTABLE} x -y ${TMP_PATH} - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - OUTPUT_QUIET - ) - else() - message(FATAL_ERROR "Support your platform here") - endif() - - else() - if ("${TMP_EXTENSION}" STREQUAL "zip") - execute_process( - COMMAND sh -c "${UNZIP_EXECUTABLE} -q ${TMP_PATH}" - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - ) - elseif (("${TMP_EXTENSION}" STREQUAL "gz") OR ("${TMP_EXTENSION}" STREQUAL "tgz")) - #message("tar xvfz ${TMP_PATH}") - execute_process( - COMMAND sh -c "${TAR_EXECUTABLE} xfz ${TMP_PATH}" - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - ) - elseif ("${TMP_EXTENSION}" STREQUAL "bz2") - execute_process( - COMMAND sh -c "${TAR_EXECUTABLE} xfj ${TMP_PATH}" - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - ) - elseif ("${TMP_EXTENSION}" STREQUAL "xz") - execute_process( - COMMAND sh -c "${TAR_EXECUTABLE} xf ${TMP_PATH}" - WORKING_DIRECTORY ${CMAKE_BINARY_DIR} - RESULT_VARIABLE Failure - ) - else() - message(FATAL_ERROR "Unknown package format.") - endif() - endif() - - if (Failure) - message(FATAL_ERROR "Error while running the uncompression tool") - endif() - - if (NOT IS_DIRECTORY "${TargetDirectory}") - message(FATAL_ERROR "The package was not uncompressed at the proper location. Check the CMake instructions.") - endif() - endif() -endmacro()
--- a/Orthanc/Resources/CMake/GoogleTestConfiguration.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,68 +0,0 @@ -if (USE_GOOGLE_TEST_DEBIAN_PACKAGE) - find_path(GOOGLE_TEST_DEBIAN_SOURCES_DIR - NAMES src/gtest-all.cc - PATHS - /usr/src/gtest - /usr/src/googletest/googletest - PATH_SUFFIXES src - ) - - find_path(GOOGLE_TEST_DEBIAN_INCLUDE_DIR - NAMES gtest.h - PATHS - /usr/include/gtest - ) - - message("Path to the Debian Google Test sources: ${GOOGLE_TEST_DEBIAN_SOURCES_DIR}") - message("Path to the Debian Google Test includes: ${GOOGLE_TEST_DEBIAN_INCLUDE_DIR}") - - set(GOOGLE_TEST_SOURCES - ${GOOGLE_TEST_DEBIAN_SOURCES_DIR}/src/gtest-all.cc - ) - - include_directories(${GOOGLE_TEST_DEBIAN_SOURCES_DIR}) - - if (NOT EXISTS ${GOOGLE_TEST_SOURCES} OR - NOT EXISTS ${GOOGLE_TEST_DEBIAN_INCLUDE_DIR}/gtest.h) - message(FATAL_ERROR "Please install the libgtest-dev package") - endif() - -elseif (STATIC_BUILD OR NOT USE_SYSTEM_GOOGLE_TEST) - set(GOOGLE_TEST_SOURCES_DIR ${CMAKE_BINARY_DIR}/gtest-1.7.0) - set(GOOGLE_TEST_URL "http://www.orthanc-server.com/downloads/third-party/gtest-1.7.0.zip") - set(GOOGLE_TEST_MD5 "2d6ec8ccdf5c46b05ba54a9fd1d130d7") - - DownloadPackage(${GOOGLE_TEST_MD5} ${GOOGLE_TEST_URL} "${GOOGLE_TEST_SOURCES_DIR}") - - include_directories( - ${GOOGLE_TEST_SOURCES_DIR}/include - ${GOOGLE_TEST_SOURCES_DIR} - ) - - set(GOOGLE_TEST_SOURCES - ${GOOGLE_TEST_SOURCES_DIR}/src/gtest-all.cc - ) - - # https://code.google.com/p/googletest/issues/detail?id=412 - if (MSVC) # VS2012 does not support tuples correctly yet - add_definitions(/D _VARIADIC_MAX=10) - endif() - - if ("${CMAKE_SYSTEM_VERSION}" STREQUAL "LinuxStandardBase") - add_definitions(-DGTEST_HAS_CLONE=0) - endif() - - source_group(ThirdParty\\GoogleTest REGULAR_EXPRESSION ${GOOGLE_TEST_SOURCES_DIR}/.*) - -else() - include(FindGTest) - if (NOT GTEST_FOUND) - message(FATAL_ERROR "Unable to find GoogleTest") - endif() - - include_directories(${GTEST_INCLUDE_DIRS}) - - # The variable GTEST_LIBRARIES contains the shared library of - # Google Test, create an alias for more uniformity - set(GOOGLE_TEST_LIBRARIES ${GTEST_LIBRARIES}) -endif()
--- a/Orthanc/Resources/CMake/JsonCppConfiguration.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,82 +0,0 @@ -set(JSONCPP_CXX11 OFF) - -if (STATIC_BUILD OR NOT USE_SYSTEM_JSONCPP) - if (USE_LEGACY_JSONCPP) - set(JSONCPP_SOURCES_DIR ${CMAKE_BINARY_DIR}/jsoncpp-0.10.6) - set(JSONCPP_URL "http://www.orthanc-server.com/downloads/third-party/jsoncpp-0.10.6.tar.gz") - set(JSONCPP_MD5 "13d1991d79697df8cadbc25c93e37c83") - add_definitions(-DORTHANC_LEGACY_JSONCPP=1) - else() - set(JSONCPP_SOURCES_DIR ${CMAKE_BINARY_DIR}/jsoncpp-1.8.4) - set(JSONCPP_URL "http://www.orthanc-server.com/downloads/third-party/jsoncpp-1.8.4.tar.gz") - set(JSONCPP_MD5 "fa47a3ab6b381869b6a5f20811198662") - add_definitions(-DORTHANC_LEGACY_JSONCPP=0) - set(JSONCPP_CXX11 ON) - endif() - - DownloadPackage(${JSONCPP_MD5} ${JSONCPP_URL} "${JSONCPP_SOURCES_DIR}") - - set(JSONCPP_SOURCES - ${JSONCPP_SOURCES_DIR}/src/lib_json/json_reader.cpp - ${JSONCPP_SOURCES_DIR}/src/lib_json/json_value.cpp - ${JSONCPP_SOURCES_DIR}/src/lib_json/json_writer.cpp - ) - - include_directories( - ${JSONCPP_SOURCES_DIR}/include - ) - - source_group(ThirdParty\\JsonCpp REGULAR_EXPRESSION ${JSONCPP_SOURCES_DIR}/.*) - -else() - find_path(JSONCPP_INCLUDE_DIR json/reader.h - /usr/include/jsoncpp - /usr/local/include/jsoncpp - ) - - message("JsonCpp include dir: ${JSONCPP_INCLUDE_DIR}") - include_directories(${JSONCPP_INCLUDE_DIR}) - link_libraries(jsoncpp) - - CHECK_INCLUDE_FILE_CXX(${JSONCPP_INCLUDE_DIR}/json/reader.h HAVE_JSONCPP_H) - if (NOT HAVE_JSONCPP_H) - message(FATAL_ERROR "Please install the libjsoncpp-dev package") - endif() - - # Switch to the C++11 standard if the version of JsonCpp is 1.y.z - if (EXISTS ${JSONCPP_INCLUDE_DIR}/json/version.h) - file(STRINGS - "${JSONCPP_INCLUDE_DIR}/json/version.h" - JSONCPP_VERSION_MAJOR1 REGEX - ".*define JSONCPP_VERSION_MAJOR.*") - - if (NOT JSONCPP_VERSION_MAJOR1) - message(FATAL_ERROR "Unable to extract the major version of JsonCpp") - endif() - - string(REGEX REPLACE - ".*JSONCPP_VERSION_MAJOR.*([0-9]+)$" "\\1" - JSONCPP_VERSION_MAJOR ${JSONCPP_VERSION_MAJOR1}) - message("JsonCpp major version: ${JSONCPP_VERSION_MAJOR}") - - if (JSONCPP_VERSION_MAJOR GREATER 0) - set(JSONCPP_CXX11 ON) - endif() - else() - message("Unable to detect the major version of JsonCpp, assuming < 1.0.0") - endif() -endif() - - -if (JSONCPP_CXX11) - # Osimis has encountered problems when this macro is left at its - # default value (1000), so we increase this limit - # https://gitlab.kitware.com/third-party/jsoncpp/commit/56df2068470241f9043b676bfae415ed62a0c172 - add_definitions(-DJSONCPP_DEPRECATED_STACK_LIMIT=5000) - - if (CMAKE_COMPILER_IS_GNUCXX OR - "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") - message("Switching to C++11 standard in gcc/clang, as version of JsonCpp is >= 1.0.0") - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wno-deprecated-declarations") - endif() -endif()
--- a/Orthanc/Resources/CMake/SQLiteConfiguration.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,72 +0,0 @@ -if (APPLE) - # Under OS X, the binaries must always be linked against the - # system-wide version of SQLite. Otherwise, if some Orthanc plugin - # also uses its own version of SQLite (such as orthanc-webviewer), - # this results in a crash in "sqlite3_mutex_enter(db->mutex);" (the - # mutex is not initialized), probably because the EXE and the DYNLIB - # share the same memory location for this mutex. - set(SQLITE_STATIC OFF) - -elseif (STATIC_BUILD OR NOT USE_SYSTEM_SQLITE) - set(SQLITE_STATIC ON) -else() - set(SQLITE_STATIC OFF) -endif() - - -if (SQLITE_STATIC) - SET(SQLITE_SOURCES_DIR ${CMAKE_BINARY_DIR}/sqlite-amalgamation-3210000) - SET(SQLITE_MD5 "fe330e88d81e77e1e61554a370ae5001") - SET(SQLITE_URL "http://www.orthanc-server.com/downloads/third-party/sqlite-amalgamation-3210000.zip") - - add_definitions(-DORTHANC_SQLITE_VERSION=3021000) - - DownloadPackage(${SQLITE_MD5} ${SQLITE_URL} "${SQLITE_SOURCES_DIR}") - - set(SQLITE_SOURCES - ${SQLITE_SOURCES_DIR}/sqlite3.c - ) - - add_definitions( - # For SQLite to run in the "Serialized" thread-safe mode - # http://www.sqlite.org/threadsafe.html - -DSQLITE_THREADSAFE=1 - -DSQLITE_OMIT_LOAD_EXTENSION # Disable SQLite plugins - ) - - include_directories( - ${SQLITE_SOURCES_DIR} - ) - - source_group(ThirdParty\\SQLite REGULAR_EXPRESSION ${SQLITE_SOURCES_DIR}/.*) - -else() - CHECK_INCLUDE_FILE_CXX(sqlite3.h HAVE_SQLITE_H) - if (NOT HAVE_SQLITE_H) - message(FATAL_ERROR "Please install the libsqlite3-dev package") - endif() - - find_path(SQLITE_INCLUDE_DIR sqlite3.h - /usr/include - /usr/local/include - ) - message("SQLite include dir: ${SQLITE_INCLUDE_DIR}") - - # Autodetection of the version of SQLite - file(STRINGS "${SQLITE_INCLUDE_DIR}/sqlite3.h" SQLITE_VERSION_NUMBER1 REGEX "#define SQLITE_VERSION_NUMBER.*$") - string(REGEX REPLACE "#define SQLITE_VERSION_NUMBER(.*)$" "\\1" SQLITE_VERSION_NUMBER2 ${SQLITE_VERSION_NUMBER1}) - - # Remove the trailing spaces to convert the string to a proper integer - string(STRIP ${SQLITE_VERSION_NUMBER2} SQLITE_VERSION_NUMBER) - - message("Detected version of SQLite: ${SQLITE_VERSION_NUMBER}") - - IF (${SQLITE_VERSION_NUMBER} LESS 3007000) - # "sqlite3_create_function_v2" is not defined in SQLite < 3.7.0 - message(FATAL_ERROR "SQLite version must be above 3.7.0. Please set the CMake variable USE_SYSTEM_SQLITE to OFF.") - ENDIF() - - add_definitions(-DORTHANC_SQLITE_VERSION=${SQLITE_VERSION_NUMBER}) - - link_libraries(sqlite3) -endif()
--- a/Orthanc/Resources/CMake/UuidConfiguration.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,102 +0,0 @@ -if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "Windows") - - if (STATIC_BUILD OR NOT USE_SYSTEM_UUID) - SET(E2FSPROGS_SOURCES_DIR ${CMAKE_BINARY_DIR}/e2fsprogs-1.43.8) - SET(E2FSPROGS_URL "http://www.orthanc-server.com/downloads/third-party/e2fsprogs-1.43.8.tar.gz") - SET(E2FSPROGS_MD5 "670b7a74a8ead5333acf21b9afc92b3c") - - DownloadPackage(${E2FSPROGS_MD5} ${E2FSPROGS_URL} "${E2FSPROGS_SOURCES_DIR}") - - include_directories( - ${E2FSPROGS_SOURCES_DIR}/lib - ) - - set(UUID_SOURCES - #${E2FSPROGS_SOURCES_DIR}/lib/uuid/tst_uuid.c - #${E2FSPROGS_SOURCES_DIR}/lib/uuid/uuid_time.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/clear.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/compare.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/copy.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/gen_uuid.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/isnull.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/pack.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/parse.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/unpack.c - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/unparse.c - ) - - check_include_file("net/if.h" HAVE_NET_IF_H) - check_include_file("net/if_dl.h" HAVE_NET_IF_DL_H) - check_include_file("netinet/in.h" HAVE_NETINET_IN_H) - check_include_file("stdlib.h" HAVE_STDLIB_H) - check_include_file("sys/file.h" HAVE_SYS_FILE_H) - check_include_file("sys/ioctl.h" HAVE_SYS_IOCTL_H) - check_include_file("sys/resource.h" HAVE_SYS_RESOURCE_H) - check_include_file("sys/socket.h" HAVE_SYS_SOCKET_H) - check_include_file("sys/sockio.h" HAVE_SYS_SOCKIO_H) - check_include_file("sys/syscall.h" HAVE_SYS_SYSCALL_H) - check_include_file("sys/time.h" HAVE_SYS_TIME_H) - check_include_file("sys/un.h" HAVE_SYS_UN_H) - check_include_file("unistd.h" HAVE_UNISTD_H) - - if (NOT HAVE_NET_IF_H) # This is the case of OpenBSD - unset(HAVE_NET_IF_H CACHE) - check_include_files("sys/socket.h;net/if.h" HAVE_NET_IF_H) - endif() - - if (NOT HAVE_NETINET_TCP_H) # This is the case of OpenBSD - unset(HAVE_NETINET_TCP_H CACHE) - check_include_files("sys/socket.h;netinet/tcp.h" HAVE_NETINET_TCP_H) - endif() - - if (NOT EXISTS ${E2FSPROGS_SOURCES_DIR}/lib/uuid/config.h) - file(WRITE ${E2FSPROGS_SOURCES_DIR}/lib/uuid/config.h.cmake " -#cmakedefine HAVE_NET_IF_H \@HAVE_NET_IF_H\@ -#cmakedefine HAVE_NET_IF_DL_H \@HAVE_NET_IF_DL_H\@ -#cmakedefine HAVE_NETINET_IN_H \@HAVE_NETINET_IN_H\@ -#cmakedefine HAVE_STDLIB_H \@HAVE_STDLIB_H \@ -#cmakedefine HAVE_SYS_FILE_H \@HAVE_SYS_FILE_H\@ -#cmakedefine HAVE_SYS_IOCTL_H \@HAVE_SYS_IOCTL_H\@ -#cmakedefine HAVE_SYS_RESOURCE_H \@HAVE_SYS_RESOURCE_H\@ -#cmakedefine HAVE_SYS_SOCKET_H \@HAVE_SYS_SOCKET_H\@ -#cmakedefine HAVE_SYS_SOCKIO_H \@HAVE_SYS_SOCKIO_H\@ -#cmakedefine HAVE_SYS_SYSCALL_H \@HAVE_SYS_SYSCALL_H\@ -#cmakedefine HAVE_SYS_TIME_H \@HAVE_SYS_TIME_H\@ -#cmakedefine HAVE_SYS_UN_H \@HAVE_SYS_UN_H\@ -#cmakedefine HAVE_UNISTD_H \@HAVE_UNISTD_H\@ -") - endif() - - configure_file( - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/config.h.cmake - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/config.h - ) - - configure_file( - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/uuid.h.in - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/uuid.h - ) - - if (NOT EXISTS ${E2FSPROGS_SOURCES_DIR}/lib/uuid/uuid_types.h) - file(WRITE - ${E2FSPROGS_SOURCES_DIR}/lib/uuid/uuid_types.h - "#include <stdint.h>\n") - endif() - - source_group(ThirdParty\\uuid REGULAR_EXPRESSION ${E2FSPROGS_SOURCES_DIR}/.*) - - else() - CHECK_INCLUDE_FILE(uuid/uuid.h HAVE_UUID_H) - if (NOT HAVE_UUID_H) - message(FATAL_ERROR "Please install uuid-dev, e2fsprogs (OpenBSD) or e2fsprogs-libuuid (FreeBSD)") - endif() - - check_library_exists(uuid uuid_generate_random "" HAVE_UUID_LIB) - if (NOT HAVE_UUID_LIB) - message(FATAL_ERROR "Unable to find the uuid library") - endif() - - link_libraries(uuid) - endif() - -endif()
--- a/Orthanc/Resources/EmbedResources.py Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,431 +0,0 @@ -#!/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-2018 Osimis S.A., Belgium -# -# This program is free software: you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# In addition, as a special exception, the copyright holders of this -# program give permission to link the code of its release with the -# OpenSSL project's "OpenSSL" library (or with modified versions of it -# that use the same license as the "OpenSSL" library), and distribute -# the linked executables. You must obey the GNU General Public License -# in all respects for all of the code used other than "OpenSSL". If you -# modify file(s) with this exception, you may extend this exception to -# your version of the file(s), but you are not obligated to do so. If -# you do not wish to do so, delete this exception statement from your -# version. If you delete this exception statement from all source files -# in the program, then also delete it here. -# -# 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 -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - - -import sys -import os -import os.path -import pprint -import re - -UPCASE_CHECK = True -USE_SYSTEM_EXCEPTION = False -EXCEPTION_CLASS = 'OrthancException' -OUT_OF_RANGE_EXCEPTION = 'OrthancException(ErrorCode_ParameterOutOfRange)' -INEXISTENT_PATH_EXCEPTION = 'OrthancException(ErrorCode_InexistentItem)' -NAMESPACE = 'Orthanc' - -ARGS = [] -for i in range(len(sys.argv)): - if not sys.argv[i].startswith('--'): - ARGS.append(sys.argv[i]) - elif sys.argv[i].lower() == '--no-upcase-check': - UPCASE_CHECK = False - elif sys.argv[i].lower() == '--system-exception': - USE_SYSTEM_EXCEPTION = True - EXCEPTION_CLASS = '::std::runtime_error' - OUT_OF_RANGE_EXCEPTION = '%s("Parameter out of range")' % EXCEPTION_CLASS - INEXISTENT_PATH_EXCEPTION = '%s("Unknown path in a directory resource")' % EXCEPTION_CLASS - elif sys.argv[i].startswith('--namespace='): - NAMESPACE = sys.argv[i][sys.argv[i].find('=') + 1 : ] - -if len(ARGS) < 2 or len(ARGS) % 2 != 0: - print ('Usage:') - print ('python %s [--no-upcase-check] [--system-exception] [--namespace=<Namespace>] <TargetBaseFilename> [ <Name> <Source> ]*' % sys.argv[0]) - exit(-1) - -TARGET_BASE_FILENAME = ARGS[1] -SOURCES = ARGS[2:] - -try: - # Make sure the destination directory exists - os.makedirs(os.path.normpath(os.path.join(TARGET_BASE_FILENAME, '..'))) -except: - pass - - -##################################################################### -## Read each resource file -##################################################################### - -def CheckNoUpcase(s): - global UPCASE_CHECK - if (UPCASE_CHECK and - re.search('[A-Z]', s) != None): - raise Exception("Path in a directory with an upcase letter: %s" % s) - -resources = {} - -counter = 0 -i = 0 -while i < len(SOURCES): - resourceName = SOURCES[i].upper() - pathName = SOURCES[i + 1] - - if not os.path.exists(pathName): - raise Exception("Non existing path: %s" % pathName) - - if resourceName in resources: - raise Exception("Twice the same resource: " + resourceName) - - if os.path.isdir(pathName): - # The resource is a directory: Recursively explore its files - content = {} - for root, dirs, files in os.walk(pathName): - base = os.path.relpath(root, pathName) - - # Fix issue #24 (Build fails on OSX when directory has .DS_Store files): - # Ignore folders whose name starts with a dot (".") - if base.find('/.') != -1: - print('Ignoring folder: %s' % root) - continue - - for f in files: - if f.find('~') == -1: # Ignore Emacs backup files - if base == '.': - r = f - else: - r = os.path.join(base, f) - - CheckNoUpcase(r) - r = '/' + r.replace('\\', '/') - if r in content: - raise Exception("Twice the same filename (check case): " + r) - - content[r] = { - 'Filename' : os.path.join(root, f), - 'Index' : counter - } - counter += 1 - - resources[resourceName] = { - 'Type' : 'Directory', - 'Files' : content - } - - elif os.path.isfile(pathName): - resources[resourceName] = { - 'Type' : 'File', - 'Index' : counter, - 'Filename' : pathName - } - counter += 1 - - else: - raise Exception("Not a regular file, nor a directory: " + pathName) - - i += 2 - -#pprint.pprint(resources) - - -##################################################################### -## Write .h header -##################################################################### - -header = open(TARGET_BASE_FILENAME + '.h', 'w') - -header.write(""" -#pragma once - -#include <string> -#include <list> - -#if defined(_MSC_VER) -# pragma warning(disable: 4065) // "Switch statement contains 'default' but no 'case' labels" -#endif - -namespace %s -{ - namespace EmbeddedResources - { - enum FileResourceId - { -""" % NAMESPACE) - -isFirst = True -for name in resources: - if resources[name]['Type'] == 'File': - if isFirst: - isFirst = False - else: - header.write(',\n') - header.write(' %s' % name) - -header.write(""" - }; - - enum DirectoryResourceId - { -""") - -isFirst = True -for name in resources: - if resources[name]['Type'] == 'Directory': - if isFirst: - isFirst = False - else: - header.write(',\n') - header.write(' %s' % name) - -header.write(""" - }; - - const void* GetFileResourceBuffer(FileResourceId id); - size_t GetFileResourceSize(FileResourceId id); - void GetFileResource(std::string& result, FileResourceId id); - - const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path); - size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path); - void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path); - - void ListResources(std::list<std::string>& result, DirectoryResourceId id); - } -} -""") -header.close() - - - -##################################################################### -## Write the resource content in the .cpp source -##################################################################### - -PYTHON_MAJOR_VERSION = sys.version_info[0] - -def WriteResource(cpp, item): - cpp.write(' static const uint8_t resource%dBuffer[] = {' % item['Index']) - - f = open(item['Filename'], "rb") - content = f.read() - f.close() - - # http://stackoverflow.com/a/1035360 - pos = 0 - for b in content: - if PYTHON_MAJOR_VERSION == 2: - c = ord(b[0]) - else: - c = b - - if pos > 0: - cpp.write(', ') - - if (pos % 16) == 0: - cpp.write('\n ') - - if c < 0: - raise Exception("Internal error") - - cpp.write("0x%02x" % c) - pos += 1 - - # Zero-size array are disallowed, so we put one single void character in it. - if pos == 0: - cpp.write(' 0') - - cpp.write(' };\n') - cpp.write(' static const size_t resource%dSize = %d;\n' % (item['Index'], pos)) - - -cpp = open(TARGET_BASE_FILENAME + '.cpp', 'w') - -cpp.write('#include "%s.h"\n' % os.path.basename(TARGET_BASE_FILENAME)) - -if USE_SYSTEM_EXCEPTION: - cpp.write('#include <stdexcept>') -else: - cpp.write('#include "%s/Core/OrthancException.h"' % os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) - -cpp.write(""" -#include <stdint.h> -#include <string.h> - -namespace %s -{ - namespace EmbeddedResources - { -""" % NAMESPACE) - - -for name in resources: - if resources[name]['Type'] == 'File': - WriteResource(cpp, resources[name]) - else: - for f in resources[name]['Files']: - WriteResource(cpp, resources[name]['Files'][f]) - - - -##################################################################### -## Write the accessors to the file resources in .cpp -##################################################################### - -cpp.write(""" - const void* GetFileResourceBuffer(FileResourceId id) - { - switch (id) - { -""") -for name in resources: - if resources[name]['Type'] == 'File': - cpp.write(' case %s:\n' % name) - cpp.write(' return resource%dBuffer;\n' % resources[name]['Index']) - -cpp.write(""" - default: - throw %s; - } - } - - size_t GetFileResourceSize(FileResourceId id) - { - switch (id) - { -""" % OUT_OF_RANGE_EXCEPTION) - -for name in resources: - if resources[name]['Type'] == 'File': - cpp.write(' case %s:\n' % name) - cpp.write(' return resource%dSize;\n' % resources[name]['Index']) - -cpp.write(""" - default: - throw %s; - } - } -""" % OUT_OF_RANGE_EXCEPTION) - - - -##################################################################### -## Write the accessors to the directory resources in .cpp -##################################################################### - -cpp.write(""" - const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path) - { - switch (id) - { -""") - -for name in resources: - if resources[name]['Type'] == 'Directory': - cpp.write(' case %s:\n' % name) - isFirst = True - for path in resources[name]['Files']: - cpp.write(' if (!strcmp(path, "%s"))\n' % path) - cpp.write(' return resource%dBuffer;\n' % resources[name]['Files'][path]['Index']) - cpp.write(' throw %s;\n\n' % INEXISTENT_PATH_EXCEPTION) - -cpp.write(""" default: - throw %s; - } - } - - size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path) - { - switch (id) - { -""" % OUT_OF_RANGE_EXCEPTION) - -for name in resources: - if resources[name]['Type'] == 'Directory': - cpp.write(' case %s:\n' % name) - isFirst = True - for path in resources[name]['Files']: - cpp.write(' if (!strcmp(path, "%s"))\n' % path) - cpp.write(' return resource%dSize;\n' % resources[name]['Files'][path]['Index']) - cpp.write(' throw %s;\n\n' % INEXISTENT_PATH_EXCEPTION) - -cpp.write(""" default: - throw %s; - } - } -""" % OUT_OF_RANGE_EXCEPTION) - - - - -##################################################################### -## List the resources in a directory -##################################################################### - -cpp.write(""" - void ListResources(std::list<std::string>& result, DirectoryResourceId id) - { - result.clear(); - - switch (id) - { -""") - -for name in resources: - if resources[name]['Type'] == 'Directory': - cpp.write(' case %s:\n' % name) - for path in sorted(resources[name]['Files']): - cpp.write(' result.push_back("%s");\n' % path) - cpp.write(' break;\n\n') - -cpp.write(""" default: - throw %s; - } - } -""" % OUT_OF_RANGE_EXCEPTION) - - - - -##################################################################### -## Write the convenience wrappers in .cpp -##################################################################### - -cpp.write(""" - void GetFileResource(std::string& result, FileResourceId id) - { - size_t size = GetFileResourceSize(id); - result.resize(size); - if (size > 0) - memcpy(&result[0], GetFileResourceBuffer(id), size); - } - - void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path) - { - size_t size = GetDirectoryResourceSize(id, path); - result.resize(size); - if (size > 0) - memcpy(&result[0], GetDirectoryResourceBuffer(id, path), size); - } - } -} -""") -cpp.close()
--- a/Orthanc/Resources/LinuxStandardBaseToolchain.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -# LSB_CC=gcc-4.8 LSB_CXX=g++-4.8 cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=../Resources/LinuxStandardBaseToolchain.cmake -DUSE_LEGACY_JSONCPP=ON - -INCLUDE(CMakeForceCompiler) - -SET(LSB_PATH $ENV{LSB_PATH}) -SET(LSB_CC $ENV{LSB_CC}) -SET(LSB_CXX $ENV{LSB_CXX}) -SET(LSB_TARGET_VERSION "4.0") - -IF ("${LSB_PATH}" STREQUAL "") - SET(LSB_PATH "/opt/lsb") -ENDIF() - -IF (EXISTS ${LSB_PATH}/lib64) - SET(LSB_TARGET_PROCESSOR "x86_64") - SET(LSB_LIBPATH ${LSB_PATH}/lib64-${LSB_TARGET_VERSION}) -ELSEIF (EXISTS ${LSB_PATH}/lib) - SET(LSB_TARGET_PROCESSOR "x86") - SET(LSB_LIBPATH ${LSB_PATH}/lib-${LSB_TARGET_VERSION}) -ELSE() - MESSAGE(FATAL_ERROR "Unable to detect the target processor architecture. Check the LSB_PATH environment variable.") -ENDIF() - -SET(LSB_CPPPATH ${LSB_PATH}/include) -SET(PKG_CONFIG_PATH ${LSB_LIBPATH}/pkgconfig/) - -# the name of the target operating system -SET(CMAKE_SYSTEM_NAME Linux) -SET(CMAKE_SYSTEM_VERSION LinuxStandardBase) -SET(CMAKE_SYSTEM_PROCESSOR ${LSB_TARGET_PROCESSOR}) - -# which compilers to use for C and C++ -SET(CMAKE_C_COMPILER ${LSB_PATH}/bin/lsbcc) -CMAKE_FORCE_CXX_COMPILER(${LSB_PATH}/bin/lsbc++ GNU) - -# here is the target environment located -SET(CMAKE_FIND_ROOT_PATH ${LSB_PATH}) - -# adjust the default behaviour of the FIND_XXX() commands: -# search headers and libraries in the target environment, search -# programs in the host environment -SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) -SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY NEVER) -SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE NEVER) - -SET(CMAKE_CROSSCOMPILING OFF) - - -SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -I${LSB_PATH}/include" CACHE INTERNAL "" FORCE) -SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -nostdinc++ -I${LSB_PATH}/include -I${LSB_PATH}/include/c++ -I${LSB_PATH}/include/c++/backward" CACHE INTERNAL "" FORCE) -SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -L${LSB_LIBPATH} --lsb-besteffort" CACHE INTERNAL "" FORCE) -SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -L${LSB_LIBPATH} --lsb-besteffort" CACHE INTERNAL "" FORCE) - -if (NOT "${LSB_CXX}" STREQUAL "") - SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --lsb-cxx=${LSB_CXX}") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --lsb-cxx=${LSB_CXX}") - SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --lsb-cxx=${LSB_CXX}") -endif() - -if (NOT "${LSB_CC}" STREQUAL "") - SET(CMAKE_C_FLAGS "${CMAKE_CC_FLAGS} --lsb-cc=${LSB_CC}") - SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --lsb-cc=${LSB_CC}") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --lsb-cc=${LSB_CC}") - SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --lsb-cc=${LSB_CC}") -endif() -
--- a/Orthanc/Resources/MinGW-W64-Toolchain32.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -# the name of the target operating system -set(CMAKE_SYSTEM_NAME Windows) - -# which compilers to use for C and C++ -set(CMAKE_C_COMPILER i686-w64-mingw32-gcc) -set(CMAKE_CXX_COMPILER i686-w64-mingw32-g++) -set(CMAKE_RC_COMPILER i686-w64-mingw32-windres) - -# here is the target environment located -set(CMAKE_FIND_ROOT_PATH /usr/i686-w64-mingw32) - -# adjust the default behaviour of the FIND_XXX() commands: -# search headers and libraries in the target environment, search -# programs in the host environment -set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) -set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) -set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
--- a/Orthanc/Resources/MinGW-W64-Toolchain64.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -# the name of the target operating system -set(CMAKE_SYSTEM_NAME Windows) - -# which compilers to use for C and C++ -set(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc) -set(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++) -set(CMAKE_RC_COMPILER x86_64-w64-mingw32-windres) - -# here is the target environment located -set(CMAKE_FIND_ROOT_PATH /usr/i686-w64-mingw32) - -# adjust the default behaviour of the FIND_XXX() commands: -# search headers and libraries in the target environment, search -# programs in the host environment -set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) -set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) -set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
--- a/Orthanc/Resources/MinGWToolchain.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -# the name of the target operating system -set(CMAKE_SYSTEM_NAME Windows) - -# which compilers to use for C and C++ -set(CMAKE_C_COMPILER i586-mingw32msvc-gcc) -set(CMAKE_CXX_COMPILER i586-mingw32msvc-g++) -set(CMAKE_RC_COMPILER i586-mingw32msvc-windres) - -# here is the target environment located -set(CMAKE_FIND_ROOT_PATH /usr/i586-mingw32msvc) - -# adjust the default behaviour of the FIND_XXX() commands: -# search headers and libraries in the target environment, search -# programs in the host environment -set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) -set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) -set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
--- a/Orthanc/Resources/Patches/boost-1.66.0-linux-standard-base.patch Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -diff -urEb boost_1_66_0.orig/boost/move/adl_move_swap.hpp boost_1_66_0/boost/move/adl_move_swap.hpp ---- boost_1_66_0.orig/boost/move/adl_move_swap.hpp 2018-04-11 11:56:16.761768726 +0200 -+++ boost_1_66_0/boost/move/adl_move_swap.hpp 2018-04-11 11:57:01.073881330 +0200 -@@ -28,6 +28,8 @@ - //Try to avoid including <algorithm>, as it's quite big - #if defined(_MSC_VER) && defined(BOOST_DINKUMWARE_STDLIB) - #include <utility> //Dinkum libraries define std::swap in utility which is lighter than algorithm -+#elif defined(__LSB_VERSION__) -+# include <utility> - #elif defined(BOOST_GNU_STDLIB) - //For non-GCC compilers, where GNUC version is not very reliable, or old GCC versions - //use the good old stl_algobase header, which is quite lightweight -Only in boost_1_66_0/boost/move: adl_move_swap.hpp~
--- a/Orthanc/Resources/ThirdParty/VisualStudio/stdint.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,259 +0,0 @@ -// ISO C9x compliant stdint.h for Microsoft Visual Studio -// Based on ISO/IEC 9899:TC2 Committee draft (May 6, 2005) WG14/N1124 -// -// Copyright (c) 2006-2013 Alexander Chemeris -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// 1. Redistributions of source code must retain the above copyright notice, -// this list of conditions and the following disclaimer. -// -// 2. Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// -// 3. Neither the name of the product nor the names of its contributors may -// be used to endorse or promote products derived from this software -// without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED -// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO -// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; -// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, -// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR -// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF -// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -// -/////////////////////////////////////////////////////////////////////////////// - -#ifndef _MSC_VER // [ -#error "Use this header only with Microsoft Visual C++ compilers!" -#endif // _MSC_VER ] - -#ifndef _MSC_STDINT_H_ // [ -#define _MSC_STDINT_H_ - -#if _MSC_VER > 1000 -#pragma once -#endif - -#if _MSC_VER >= 1600 // [ -#include <stdint.h> -#else // ] _MSC_VER >= 1600 [ - -#include <limits.h> - -// For Visual Studio 6 in C++ mode and for many Visual Studio versions when -// compiling for ARM we should wrap <wchar.h> include with 'extern "C++" {}' -// or compiler give many errors like this: -// error C2733: second C linkage of overloaded function 'wmemchr' not allowed -#ifdef __cplusplus -extern "C" { -#endif -# include <wchar.h> -#ifdef __cplusplus -} -#endif - -// Define _W64 macros to mark types changing their size, like intptr_t. -#ifndef _W64 -# if !defined(__midl) && (defined(_X86_) || defined(_M_IX86)) && _MSC_VER >= 1300 -# define _W64 __w64 -# else -# define _W64 -# endif -#endif - - -// 7.18.1 Integer types - -// 7.18.1.1 Exact-width integer types - -// Visual Studio 6 and Embedded Visual C++ 4 doesn't -// realize that, e.g. char has the same size as __int8 -// so we give up on __intX for them. -#if (_MSC_VER < 1300) - typedef signed char int8_t; - typedef signed short int16_t; - typedef signed int int32_t; - typedef unsigned char uint8_t; - typedef unsigned short uint16_t; - typedef unsigned int uint32_t; -#else - typedef signed __int8 int8_t; - typedef signed __int16 int16_t; - typedef signed __int32 int32_t; - typedef unsigned __int8 uint8_t; - typedef unsigned __int16 uint16_t; - typedef unsigned __int32 uint32_t; -#endif -typedef signed __int64 int64_t; -typedef unsigned __int64 uint64_t; - - -// 7.18.1.2 Minimum-width integer types -typedef int8_t int_least8_t; -typedef int16_t int_least16_t; -typedef int32_t int_least32_t; -typedef int64_t int_least64_t; -typedef uint8_t uint_least8_t; -typedef uint16_t uint_least16_t; -typedef uint32_t uint_least32_t; -typedef uint64_t uint_least64_t; - -// 7.18.1.3 Fastest minimum-width integer types -typedef int8_t int_fast8_t; -typedef int16_t int_fast16_t; -typedef int32_t int_fast32_t; -typedef int64_t int_fast64_t; -typedef uint8_t uint_fast8_t; -typedef uint16_t uint_fast16_t; -typedef uint32_t uint_fast32_t; -typedef uint64_t uint_fast64_t; - -// 7.18.1.4 Integer types capable of holding object pointers -#ifdef _WIN64 // [ - typedef signed __int64 intptr_t; - typedef unsigned __int64 uintptr_t; -#else // _WIN64 ][ - typedef _W64 signed int intptr_t; - typedef _W64 unsigned int uintptr_t; -#endif // _WIN64 ] - -// 7.18.1.5 Greatest-width integer types -typedef int64_t intmax_t; -typedef uint64_t uintmax_t; - - -// 7.18.2 Limits of specified-width integer types - -#if !defined(__cplusplus) || defined(__STDC_LIMIT_MACROS) // [ See footnote 220 at page 257 and footnote 221 at page 259 - -// 7.18.2.1 Limits of exact-width integer types -#define INT8_MIN ((int8_t)_I8_MIN) -#define INT8_MAX _I8_MAX -#define INT16_MIN ((int16_t)_I16_MIN) -#define INT16_MAX _I16_MAX -#define INT32_MIN ((int32_t)_I32_MIN) -#define INT32_MAX _I32_MAX -#define INT64_MIN ((int64_t)_I64_MIN) -#define INT64_MAX _I64_MAX -#define UINT8_MAX _UI8_MAX -#define UINT16_MAX _UI16_MAX -#define UINT32_MAX _UI32_MAX -#define UINT64_MAX _UI64_MAX - -// 7.18.2.2 Limits of minimum-width integer types -#define INT_LEAST8_MIN INT8_MIN -#define INT_LEAST8_MAX INT8_MAX -#define INT_LEAST16_MIN INT16_MIN -#define INT_LEAST16_MAX INT16_MAX -#define INT_LEAST32_MIN INT32_MIN -#define INT_LEAST32_MAX INT32_MAX -#define INT_LEAST64_MIN INT64_MIN -#define INT_LEAST64_MAX INT64_MAX -#define UINT_LEAST8_MAX UINT8_MAX -#define UINT_LEAST16_MAX UINT16_MAX -#define UINT_LEAST32_MAX UINT32_MAX -#define UINT_LEAST64_MAX UINT64_MAX - -// 7.18.2.3 Limits of fastest minimum-width integer types -#define INT_FAST8_MIN INT8_MIN -#define INT_FAST8_MAX INT8_MAX -#define INT_FAST16_MIN INT16_MIN -#define INT_FAST16_MAX INT16_MAX -#define INT_FAST32_MIN INT32_MIN -#define INT_FAST32_MAX INT32_MAX -#define INT_FAST64_MIN INT64_MIN -#define INT_FAST64_MAX INT64_MAX -#define UINT_FAST8_MAX UINT8_MAX -#define UINT_FAST16_MAX UINT16_MAX -#define UINT_FAST32_MAX UINT32_MAX -#define UINT_FAST64_MAX UINT64_MAX - -// 7.18.2.4 Limits of integer types capable of holding object pointers -#ifdef _WIN64 // [ -# define INTPTR_MIN INT64_MIN -# define INTPTR_MAX INT64_MAX -# define UINTPTR_MAX UINT64_MAX -#else // _WIN64 ][ -# define INTPTR_MIN INT32_MIN -# define INTPTR_MAX INT32_MAX -# define UINTPTR_MAX UINT32_MAX -#endif // _WIN64 ] - -// 7.18.2.5 Limits of greatest-width integer types -#define INTMAX_MIN INT64_MIN -#define INTMAX_MAX INT64_MAX -#define UINTMAX_MAX UINT64_MAX - -// 7.18.3 Limits of other integer types - -#ifdef _WIN64 // [ -# define PTRDIFF_MIN _I64_MIN -# define PTRDIFF_MAX _I64_MAX -#else // _WIN64 ][ -# define PTRDIFF_MIN _I32_MIN -# define PTRDIFF_MAX _I32_MAX -#endif // _WIN64 ] - -#define SIG_ATOMIC_MIN INT_MIN -#define SIG_ATOMIC_MAX INT_MAX - -#ifndef SIZE_MAX // [ -# ifdef _WIN64 // [ -# define SIZE_MAX _UI64_MAX -# else // _WIN64 ][ -# define SIZE_MAX _UI32_MAX -# endif // _WIN64 ] -#endif // SIZE_MAX ] - -// WCHAR_MIN and WCHAR_MAX are also defined in <wchar.h> -#ifndef WCHAR_MIN // [ -# define WCHAR_MIN 0 -#endif // WCHAR_MIN ] -#ifndef WCHAR_MAX // [ -# define WCHAR_MAX _UI16_MAX -#endif // WCHAR_MAX ] - -#define WINT_MIN 0 -#define WINT_MAX _UI16_MAX - -#endif // __STDC_LIMIT_MACROS ] - - -// 7.18.4 Limits of other integer types - -#if !defined(__cplusplus) || defined(__STDC_CONSTANT_MACROS) // [ See footnote 224 at page 260 - -// 7.18.4.1 Macros for minimum-width integer constants - -#define INT8_C(val) val##i8 -#define INT16_C(val) val##i16 -#define INT32_C(val) val##i32 -#define INT64_C(val) val##i64 - -#define UINT8_C(val) val##ui8 -#define UINT16_C(val) val##ui16 -#define UINT32_C(val) val##ui32 -#define UINT64_C(val) val##ui64 - -// 7.18.4.2 Macros for greatest-width integer constants -// These #ifndef's are needed to prevent collisions with <boost/cstdint.hpp>. -// Check out Issue 9 for the details. -#ifndef INTMAX_C // [ -# define INTMAX_C INT64_C -#endif // INTMAX_C ] -#ifndef UINTMAX_C // [ -# define UINTMAX_C UINT64_C -#endif // UINTMAX_C ] - -#endif // __STDC_CONSTANT_MACROS ] - -#endif // _MSC_VER >= 1600 ] - -#endif // _MSC_STDINT_H_ ]
--- a/Orthanc/Resources/ThirdParty/base64/base64.cpp Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,128 +0,0 @@ -/* - base64.cpp and base64.h - - Copyright (C) 2004-2008 René Nyffenegger - - This source code is provided 'as-is', without any express or implied - warranty. In no event will the author be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this source code must not be misrepresented; you must not - claim that you wrote the original source code. If you use this source code - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original source code. - - 3. This notice may not be removed or altered from any source distribution. - - René Nyffenegger rene.nyffenegger@adp-gmbh.ch - -*/ - -#include "base64.h" -#include <string.h> - -static const std::string base64_chars = - "ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "abcdefghijklmnopqrstuvwxyz" - "0123456789+/"; - - -static inline bool is_base64(unsigned char c) { - return (isalnum(c) || (c == '+') || (c == '/')); -} - -std::string base64_encode(const std::string& stringToEncode) -{ - const unsigned char* bytes_to_encode = reinterpret_cast<const unsigned char*> - (stringToEncode.size() > 0 ? &stringToEncode[0] : NULL); - unsigned int in_len = stringToEncode.size(); - - std::string ret; - int i = 0; - int j = 0; - unsigned char char_array_3[3]; - unsigned char char_array_4[4]; - - while (in_len--) { - char_array_3[i++] = *(bytes_to_encode++); - if (i == 3) { - char_array_4[0] = (char_array_3[0] & 0xfc) >> 2; - char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4); - char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6); - char_array_4[3] = char_array_3[2] & 0x3f; - - for(i = 0; (i <4) ; i++) - ret += base64_chars[char_array_4[i]]; - i = 0; - } - } - - if (i) - { - for(j = i; j < 3; j++) - char_array_3[j] = '\0'; - - char_array_4[0] = (char_array_3[0] & 0xfc) >> 2; - char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4); - char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6); - char_array_4[3] = char_array_3[2] & 0x3f; - - for (j = 0; (j < i + 1); j++) - ret += base64_chars[char_array_4[j]]; - - while((i++ < 3)) - ret += '='; - - } - - return ret; -} - - -std::string base64_decode(const std::string& encoded_string) { - int in_len = encoded_string.size(); - int i = 0; - int j = 0; - int in_ = 0; - unsigned char char_array_4[4], char_array_3[3]; - std::string ret; - - while (in_len-- && ( encoded_string[in_] != '=') && is_base64(encoded_string[in_])) { - char_array_4[i++] = encoded_string[in_]; in_++; - if (i ==4) { - for (i = 0; i <4; i++) - char_array_4[i] = base64_chars.find(char_array_4[i]); - - char_array_3[0] = (char_array_4[0] << 2) + ((char_array_4[1] & 0x30) >> 4); - char_array_3[1] = ((char_array_4[1] & 0xf) << 4) + ((char_array_4[2] & 0x3c) >> 2); - char_array_3[2] = ((char_array_4[2] & 0x3) << 6) + char_array_4[3]; - - for (i = 0; (i < 3); i++) - ret += char_array_3[i]; - i = 0; - } - } - - if (i) { - for (j = i; j <4; j++) - char_array_4[j] = 0; - - for (j = 0; j <4; j++) - char_array_4[j] = base64_chars.find(char_array_4[j]); - - char_array_3[0] = (char_array_4[0] << 2) + ((char_array_4[1] & 0x30) >> 4); - char_array_3[1] = ((char_array_4[1] & 0xf) << 4) + ((char_array_4[2] & 0x3c) >> 2); - char_array_3[2] = ((char_array_4[2] & 0x3) << 6) + char_array_4[3]; - - for (j = 0; (j < i - 1); j++) ret += char_array_3[j]; - } - - return ret; -}
--- a/Orthanc/Resources/ThirdParty/base64/base64.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,4 +0,0 @@ -#include <string> - -std::string base64_encode(const std::string& stringToEncode); -std::string base64_decode(const std::string& s);
--- a/Orthanc/Resources/WindowsResources.py Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,90 +0,0 @@ -#!/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-2018 Osimis S.A., Belgium -# -# This program is free software: you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# In addition, as a special exception, the copyright holders of this -# program give permission to link the code of its release with the -# OpenSSL project's "OpenSSL" library (or with modified versions of it -# that use the same license as the "OpenSSL" library), and distribute -# the linked executables. You must obey the GNU General Public License -# in all respects for all of the code used other than "OpenSSL". If you -# modify file(s) with this exception, you may extend this exception to -# your version of the file(s), but you are not obligated to do so. If -# you do not wish to do so, delete this exception statement from your -# version. If you delete this exception statement from all source files -# in the program, then also delete it here. -# -# 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 -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - - -import os -import sys -import datetime - -if len(sys.argv) != 5: - sys.stderr.write('Usage: %s <Version> <ProductName> <Filename> <Description>\n\n' % sys.argv[0]) - sys.stderr.write('Example: %s 0.9.1 Orthanc Orthanc.exe "Lightweight, RESTful DICOM server for medical imaging"\n' % sys.argv[0]) - sys.exit(-1) - -SOURCE = os.path.join(os.path.dirname(__file__), 'WindowsResources.rc') - -VERSION = sys.argv[1] -PRODUCT = sys.argv[2] -FILENAME = sys.argv[3] -DESCRIPTION = sys.argv[4] - -if VERSION == 'mainline': - VERSION = '999.999.999' - RELEASE = 'This is a mainline build, not an official release' -else: - RELEASE = 'Release %s' % VERSION - -v = VERSION.split('.') -if len(v) != 2 and len(v) != 3: - sys.stderr.write('Bad version number: %s\n' % VERSION) - sys.exit(-1) - -if len(v) == 2: - v.append('0') - -extension = os.path.splitext(FILENAME)[1] -if extension.lower() == '.dll': - BLOCK = '040904E4' - TYPE = 'VFT_DLL' -elif extension.lower() == '.exe': - #BLOCK = '040904B0' # LANG_ENGLISH/SUBLANG_ENGLISH_US, - BLOCK = '040904E4' # Lang=US English, CharSet=Windows Multilingual - TYPE = 'VFT_APP' -else: - sys.stderr.write('Unsupported extension (.EXE or .DLL only): %s\n' % extension) - sys.exit(-1) - - -with open(SOURCE, 'r') as source: - content = source.read() - content = content.replace('${VERSION_MAJOR}', v[0]) - content = content.replace('${VERSION_MINOR}', v[1]) - content = content.replace('${VERSION_PATCH}', v[2]) - content = content.replace('${RELEASE}', RELEASE) - content = content.replace('${DESCRIPTION}', DESCRIPTION) - content = content.replace('${PRODUCT}', PRODUCT) - content = content.replace('${FILENAME}', FILENAME) - content = content.replace('${YEAR}', str(datetime.datetime.now().year)) - content = content.replace('${BLOCK}', BLOCK) - content = content.replace('${TYPE}', TYPE) - - sys.stdout.write(content)
--- a/Orthanc/Resources/WindowsResources.rc Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -#include <winver.h> - -VS_VERSION_INFO VERSIONINFO - FILEVERSION ${VERSION_MAJOR},${VERSION_MINOR},0,${VERSION_PATCH} - PRODUCTVERSION ${VERSION_MAJOR},${VERSION_MINOR},0,0 - FILEOS VOS_NT_WINDOWS32 - FILETYPE ${TYPE} - BEGIN - BLOCK "StringFileInfo" - BEGIN - BLOCK "${BLOCK}" - BEGIN - VALUE "Comments", "${RELEASE}" - VALUE "CompanyName", "University Hospital of Liege, Belgium" - VALUE "FileDescription", "${DESCRIPTION}" - VALUE "FileVersion", "${VERSION_MAJOR}.${VERSION_MINOR}.0.${VERSION_PATCH}" - VALUE "InternalName", "${PRODUCT}" - VALUE "LegalCopyright", "(c) 2012-${YEAR}, Sebastien Jodogne, University Hospital of Liege, Belgium" - VALUE "LegalTrademarks", "Licensing information is available at http://www.orthanc-server.com/" - VALUE "OriginalFilename", "${FILENAME}" - VALUE "ProductName", "${PRODUCT}" - VALUE "ProductVersion", "${VERSION_MAJOR}.${VERSION_MINOR}" - END - END - - BLOCK "VarFileInfo" - BEGIN - VALUE "Translation", 0x409, 1252 // U.S. English - END - END
--- a/Orthanc/Sdk-0.9.5/orthanc/OrthancCPlugin.h Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,4686 +0,0 @@ -/** - * \mainpage - * - * This C/C++ SDK allows external developers to create plugins that - * can be loaded into Orthanc to extend its functionality. Each - * Orthanc plugin must expose 4 public functions with the following - * signatures: - * - * -# <tt>int32_t OrthancPluginInitialize(const OrthancPluginContext* context)</tt>: - * This function is invoked by Orthanc when it loads the plugin on startup. - * The plugin must: - * - Check its compatibility with the Orthanc version using - * ::OrthancPluginCheckVersion(). - * - Store the context pointer so that it can use the plugin - * services of Orthanc. - * - Register all its REST callbacks using ::OrthancPluginRegisterRestCallback(). - * - Possibly register its callback for received DICOM instances using ::OrthancPluginRegisterOnStoredInstanceCallback(). - * - Possibly register its callback for changes to the DICOM store using ::OrthancPluginRegisterOnChangeCallback(). - * - Possibly register a custom storage area using ::OrthancPluginRegisterStorageArea(). - * - Possibly register a custom database back-end area using OrthancPluginRegisterDatabaseBackendV2(). - * - Possibly register a handler for C-Find SCP against DICOM worklists using OrthancPluginRegisterWorklistCallback(). - * - Possibly register a custom decoder for DICOM images using OrthancPluginRegisterDecodeImageCallback(). - * -# <tt>void OrthancPluginFinalize()</tt>: - * This function is invoked by Orthanc during its shutdown. The plugin - * must free all its memory. - * -# <tt>const char* OrthancPluginGetName()</tt>: - * The plugin must return a short string to identify itself. - * -# <tt>const char* OrthancPluginGetVersion()</tt>: - * The plugin must return a string containing its version number. - * - * The name and the version of a plugin is only used to prevent it - * from being loaded twice. Note that, in C++, it is mandatory to - * declare these functions within an <tt>extern "C"</tt> section. - * - * To ensure multi-threading safety, the various REST callbacks are - * guaranteed to be executed in mutual exclusion since Orthanc - * 0.8.5. If this feature is undesired (notably when developing - * high-performance plugins handling simultaneous requests), use - * ::OrthancPluginRegisterRestCallbackNoLock(). - **/ - - - -/** - * @defgroup Images Images and compression - * @brief Functions to deal with images and compressed buffers. - * - * @defgroup REST REST - * @brief Functions to answer REST requests in a callback. - * - * @defgroup Callbacks Callbacks - * @brief Functions to register and manage callbacks by the plugins. - * - * @defgroup Worklists Worklists - * @brief Functions to register and manage worklists. - * - * @defgroup Orthanc Orthanc - * @brief Functions to access the content of the Orthanc server. - **/ - - - -/** - * @defgroup Toolbox Toolbox - * @brief Generic functions to help with the creation of plugins. - **/ - - - -/** - * Orthanc - A Lightweight, RESTful DICOM Store - * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics - * Department, University Hospital of Liege, Belgium - * - * This program is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * In addition, as a special exception, the copyright holders of this - * program give permission to link the code of its release with the - * OpenSSL project's "OpenSSL" library (or with modified versions of it - * that use the same license as the "OpenSSL" library), and distribute - * the linked executables. You must obey the GNU General Public License - * in all respects for all of the code used other than "OpenSSL". If you - * modify file(s) with this exception, you may extend this exception to - * your version of the file(s), but you are not obligated to do so. If - * you do not wish to do so, delete this exception statement from your - * version. If you delete this exception statement from all source files - * in the program, then also delete it here. - * - * 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 - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - **/ - - - -#pragma once - - -#include <stdio.h> -#include <string.h> - -#ifdef WIN32 -#define ORTHANC_PLUGINS_API __declspec(dllexport) -#else -#define ORTHANC_PLUGINS_API -#endif - -#define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0 -#define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9 -#define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 5 - - - -/******************************************************************** - ** Check that function inlining is properly supported. The use of - ** inlining is required, to avoid the duplication of object code - ** between two compilation modules that would use the Orthanc Plugin - ** API. - ********************************************************************/ - -/* If the auto-detection of the "inline" keyword below does not work - automatically and that your compiler is known to properly support - inlining, uncomment the following #define and adapt the definition - of "static inline". */ - -/* #define ORTHANC_PLUGIN_INLINE static inline */ - -#ifndef ORTHANC_PLUGIN_INLINE -# if __STDC_VERSION__ >= 199901L -/* This is C99 or above: http://predef.sourceforge.net/prestd.html */ -# define ORTHANC_PLUGIN_INLINE static inline -# elif defined(__cplusplus) -/* This is C++ */ -# define ORTHANC_PLUGIN_INLINE static inline -# elif defined(__GNUC__) -/* This is GCC running in C89 mode */ -# define ORTHANC_PLUGIN_INLINE static __inline -# elif defined(_MSC_VER) -/* This is Visual Studio running in C89 mode */ -# define ORTHANC_PLUGIN_INLINE static __inline -# else -# error Your compiler is not known to support the "inline" keyword -# endif -#endif - - - -/******************************************************************** - ** Inclusion of standard libraries. - ********************************************************************/ - -/** - * For Microsoft Visual Studio, a compatibility "stdint.h" can be - * downloaded at the following URL: - * https://orthanc.googlecode.com/hg/Resources/ThirdParty/VisualStudio/stdint.h - **/ -#include <stdint.h> - -#include <stdlib.h> - - - -/******************************************************************** - ** Definition of the Orthanc Plugin API. - ********************************************************************/ - -/** @{ */ - -#ifdef __cplusplus -extern "C" -{ -#endif - - /** - * The various error codes that can be returned by the Orthanc core. - **/ - typedef enum - { - OrthancPluginErrorCode_InternalError = -1 /*!< Internal error */, - OrthancPluginErrorCode_Success = 0 /*!< Success */, - OrthancPluginErrorCode_Plugin = 1 /*!< Error encountered within the plugin engine */, - OrthancPluginErrorCode_NotImplemented = 2 /*!< Not implemented yet */, - OrthancPluginErrorCode_ParameterOutOfRange = 3 /*!< Parameter out of range */, - OrthancPluginErrorCode_NotEnoughMemory = 4 /*!< Not enough memory */, - OrthancPluginErrorCode_BadParameterType = 5 /*!< Bad type for a parameter */, - OrthancPluginErrorCode_BadSequenceOfCalls = 6 /*!< Bad sequence of calls */, - OrthancPluginErrorCode_InexistentItem = 7 /*!< Accessing an inexistent item */, - OrthancPluginErrorCode_BadRequest = 8 /*!< Bad request */, - OrthancPluginErrorCode_NetworkProtocol = 9 /*!< Error in the network protocol */, - OrthancPluginErrorCode_SystemCommand = 10 /*!< Error while calling a system command */, - OrthancPluginErrorCode_Database = 11 /*!< Error with the database engine */, - OrthancPluginErrorCode_UriSyntax = 12 /*!< Badly formatted URI */, - OrthancPluginErrorCode_InexistentFile = 13 /*!< Inexistent file */, - OrthancPluginErrorCode_CannotWriteFile = 14 /*!< Cannot write to file */, - OrthancPluginErrorCode_BadFileFormat = 15 /*!< Bad file format */, - OrthancPluginErrorCode_Timeout = 16 /*!< Timeout */, - OrthancPluginErrorCode_UnknownResource = 17 /*!< Unknown resource */, - OrthancPluginErrorCode_IncompatibleDatabaseVersion = 18 /*!< Incompatible version of the database */, - OrthancPluginErrorCode_FullStorage = 19 /*!< The file storage is full */, - OrthancPluginErrorCode_CorruptedFile = 20 /*!< Corrupted file (e.g. inconsistent MD5 hash) */, - OrthancPluginErrorCode_InexistentTag = 21 /*!< Inexistent tag */, - OrthancPluginErrorCode_ReadOnly = 22 /*!< Cannot modify a read-only data structure */, - OrthancPluginErrorCode_IncompatibleImageFormat = 23 /*!< Incompatible format of the images */, - OrthancPluginErrorCode_IncompatibleImageSize = 24 /*!< Incompatible size of the images */, - OrthancPluginErrorCode_SharedLibrary = 25 /*!< Error while using a shared library (plugin) */, - OrthancPluginErrorCode_UnknownPluginService = 26 /*!< Plugin invoking an unknown service */, - OrthancPluginErrorCode_UnknownDicomTag = 27 /*!< Unknown DICOM tag */, - OrthancPluginErrorCode_BadJson = 28 /*!< Cannot parse a JSON document */, - OrthancPluginErrorCode_Unauthorized = 29 /*!< Bad credentials were provided to an HTTP request */, - OrthancPluginErrorCode_BadFont = 30 /*!< Badly formatted font file */, - OrthancPluginErrorCode_DatabasePlugin = 31 /*!< The plugin implementing a custom database back-end does not fulfill the proper interface */, - OrthancPluginErrorCode_StorageAreaPlugin = 32 /*!< Error in the plugin implementing a custom storage area */, - OrthancPluginErrorCode_EmptyRequest = 33 /*!< The request is empty */, - OrthancPluginErrorCode_NotAcceptable = 34 /*!< Cannot send a response which is acceptable according to the Accept HTTP header */, - OrthancPluginErrorCode_SQLiteNotOpened = 1000 /*!< SQLite: The database is not opened */, - OrthancPluginErrorCode_SQLiteAlreadyOpened = 1001 /*!< SQLite: Connection is already open */, - OrthancPluginErrorCode_SQLiteCannotOpen = 1002 /*!< SQLite: Unable to open the database */, - OrthancPluginErrorCode_SQLiteStatementAlreadyUsed = 1003 /*!< SQLite: This cached statement is already being referred to */, - OrthancPluginErrorCode_SQLiteExecute = 1004 /*!< SQLite: Cannot execute a command */, - OrthancPluginErrorCode_SQLiteRollbackWithoutTransaction = 1005 /*!< SQLite: Rolling back a nonexistent transaction (have you called Begin()?) */, - OrthancPluginErrorCode_SQLiteCommitWithoutTransaction = 1006 /*!< SQLite: Committing a nonexistent transaction */, - OrthancPluginErrorCode_SQLiteRegisterFunction = 1007 /*!< SQLite: Unable to register a function */, - OrthancPluginErrorCode_SQLiteFlush = 1008 /*!< SQLite: Unable to flush the database */, - OrthancPluginErrorCode_SQLiteCannotRun = 1009 /*!< SQLite: Cannot run a cached statement */, - OrthancPluginErrorCode_SQLiteCannotStep = 1010 /*!< SQLite: Cannot step over a cached statement */, - OrthancPluginErrorCode_SQLiteBindOutOfRange = 1011 /*!< SQLite: Bing a value while out of range (serious error) */, - OrthancPluginErrorCode_SQLitePrepareStatement = 1012 /*!< SQLite: Cannot prepare a cached statement */, - OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted = 1013 /*!< SQLite: Beginning the same transaction twice */, - OrthancPluginErrorCode_SQLiteTransactionCommit = 1014 /*!< SQLite: Failure when committing the transaction */, - OrthancPluginErrorCode_SQLiteTransactionBegin = 1015 /*!< SQLite: Cannot start a transaction */, - OrthancPluginErrorCode_DirectoryOverFile = 2000 /*!< The directory to be created is already occupied by a regular file */, - OrthancPluginErrorCode_FileStorageCannotWrite = 2001 /*!< Unable to create a subdirectory or a file in the file storage */, - OrthancPluginErrorCode_DirectoryExpected = 2002 /*!< The specified path does not point to a directory */, - OrthancPluginErrorCode_HttpPortInUse = 2003 /*!< The TCP port of the HTTP server is already in use */, - OrthancPluginErrorCode_DicomPortInUse = 2004 /*!< The TCP port of the DICOM server is already in use */, - OrthancPluginErrorCode_BadHttpStatusInRest = 2005 /*!< This HTTP status is not allowed in a REST API */, - OrthancPluginErrorCode_RegularFileExpected = 2006 /*!< The specified path does not point to a regular file */, - OrthancPluginErrorCode_PathToExecutable = 2007 /*!< Unable to get the path to the executable */, - OrthancPluginErrorCode_MakeDirectory = 2008 /*!< Cannot create a directory */, - OrthancPluginErrorCode_BadApplicationEntityTitle = 2009 /*!< An application entity title (AET) cannot be empty or be longer than 16 characters */, - OrthancPluginErrorCode_NoCFindHandler = 2010 /*!< No request handler factory for DICOM C-FIND SCP */, - OrthancPluginErrorCode_NoCMoveHandler = 2011 /*!< No request handler factory for DICOM C-MOVE SCP */, - OrthancPluginErrorCode_NoCStoreHandler = 2012 /*!< No request handler factory for DICOM C-STORE SCP */, - OrthancPluginErrorCode_NoApplicationEntityFilter = 2013 /*!< No application entity filter */, - OrthancPluginErrorCode_NoSopClassOrInstance = 2014 /*!< DicomUserConnection: Unable to find the SOP class and instance */, - OrthancPluginErrorCode_NoPresentationContext = 2015 /*!< DicomUserConnection: No acceptable presentation context for modality */, - OrthancPluginErrorCode_DicomFindUnavailable = 2016 /*!< DicomUserConnection: The C-FIND command is not supported by the remote SCP */, - OrthancPluginErrorCode_DicomMoveUnavailable = 2017 /*!< DicomUserConnection: The C-MOVE command is not supported by the remote SCP */, - OrthancPluginErrorCode_CannotStoreInstance = 2018 /*!< Cannot store an instance */, - OrthancPluginErrorCode_CreateDicomNotString = 2019 /*!< Only string values are supported when creating DICOM instances */, - OrthancPluginErrorCode_CreateDicomOverrideTag = 2020 /*!< Trying to override a value inherited from a parent module */, - OrthancPluginErrorCode_CreateDicomUseContent = 2021 /*!< Use \"Content\" to inject an image into a new DICOM instance */, - OrthancPluginErrorCode_CreateDicomNoPayload = 2022 /*!< No payload is present for one instance in the series */, - OrthancPluginErrorCode_CreateDicomUseDataUriScheme = 2023 /*!< The payload of the DICOM instance must be specified according to Data URI scheme */, - OrthancPluginErrorCode_CreateDicomBadParent = 2024 /*!< Trying to attach a new DICOM instance to an inexistent resource */, - OrthancPluginErrorCode_CreateDicomParentIsInstance = 2025 /*!< Trying to attach a new DICOM instance to an instance (must be a series, study or patient) */, - OrthancPluginErrorCode_CreateDicomParentEncoding = 2026 /*!< Unable to get the encoding of the parent resource */, - OrthancPluginErrorCode_UnknownModality = 2027 /*!< Unknown modality */, - OrthancPluginErrorCode_BadJobOrdering = 2028 /*!< Bad ordering of filters in a job */, - OrthancPluginErrorCode_JsonToLuaTable = 2029 /*!< Cannot convert the given JSON object to a Lua table */, - OrthancPluginErrorCode_CannotCreateLua = 2030 /*!< Cannot create the Lua context */, - OrthancPluginErrorCode_CannotExecuteLua = 2031 /*!< Cannot execute a Lua command */, - OrthancPluginErrorCode_LuaAlreadyExecuted = 2032 /*!< Arguments cannot be pushed after the Lua function is executed */, - OrthancPluginErrorCode_LuaBadOutput = 2033 /*!< The Lua function does not give the expected number of outputs */, - OrthancPluginErrorCode_NotLuaPredicate = 2034 /*!< The Lua function is not a predicate (only true/false outputs allowed) */, - OrthancPluginErrorCode_LuaReturnsNoString = 2035 /*!< The Lua function does not return a string */, - OrthancPluginErrorCode_StorageAreaAlreadyRegistered = 2036 /*!< Another plugin has already registered a custom storage area */, - OrthancPluginErrorCode_DatabaseBackendAlreadyRegistered = 2037 /*!< Another plugin has already registered a custom database back-end */, - OrthancPluginErrorCode_DatabaseNotInitialized = 2038 /*!< Plugin trying to call the database during its initialization */, - OrthancPluginErrorCode_SslDisabled = 2039 /*!< Orthanc has been built without SSL support */, - OrthancPluginErrorCode_CannotOrderSlices = 2040 /*!< Unable to order the slices of the series */, - OrthancPluginErrorCode_NoWorklistHandler = 2041 /*!< No request handler factory for DICOM C-Find Modality SCP */, - - _OrthancPluginErrorCode_INTERNAL = 0x7fffffff - } OrthancPluginErrorCode; - - - /** - * Forward declaration of one of the mandatory functions for Orthanc - * plugins. - **/ - ORTHANC_PLUGINS_API const char* OrthancPluginGetName(); - - - /** - * The various HTTP methods for a REST call. - **/ - typedef enum - { - OrthancPluginHttpMethod_Get = 1, /*!< GET request */ - OrthancPluginHttpMethod_Post = 2, /*!< POST request */ - OrthancPluginHttpMethod_Put = 3, /*!< PUT request */ - OrthancPluginHttpMethod_Delete = 4, /*!< DELETE request */ - - _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff - } OrthancPluginHttpMethod; - - - /** - * @brief The parameters of a REST request. - * @ingroup Callbacks - **/ - typedef struct - { - /** - * @brief The HTTP method. - **/ - OrthancPluginHttpMethod method; - - /** - * @brief The number of groups of the regular expression. - **/ - uint32_t groupsCount; - - /** - * @brief The matched values for the groups of the regular expression. - **/ - const char* const* groups; - - /** - * @brief For a GET request, the number of GET parameters. - **/ - uint32_t getCount; - - /** - * @brief For a GET request, the keys of the GET parameters. - **/ - const char* const* getKeys; - - /** - * @brief For a GET request, the values of the GET parameters. - **/ - const char* const* getValues; - - /** - * @brief For a PUT or POST request, the content of the body. - **/ - const char* body; - - /** - * @brief For a PUT or POST request, the number of bytes of the body. - **/ - uint32_t bodySize; - - - /* -------------------------------------------------- - New in version 0.8.1 - -------------------------------------------------- */ - - /** - * @brief The number of HTTP headers. - **/ - uint32_t headersCount; - - /** - * @brief The keys of the HTTP headers (always converted to low-case). - **/ - const char* const* headersKeys; - - /** - * @brief The values of the HTTP headers. - **/ - const char* const* headersValues; - - } OrthancPluginHttpRequest; - - - typedef enum - { - /* Generic services */ - _OrthancPluginService_LogInfo = 1, - _OrthancPluginService_LogWarning = 2, - _OrthancPluginService_LogError = 3, - _OrthancPluginService_GetOrthancPath = 4, - _OrthancPluginService_GetOrthancDirectory = 5, - _OrthancPluginService_GetConfigurationPath = 6, - _OrthancPluginService_SetPluginProperty = 7, - _OrthancPluginService_GetGlobalProperty = 8, - _OrthancPluginService_SetGlobalProperty = 9, - _OrthancPluginService_GetCommandLineArgumentsCount = 10, - _OrthancPluginService_GetCommandLineArgument = 11, - _OrthancPluginService_GetExpectedDatabaseVersion = 12, - _OrthancPluginService_GetConfiguration = 13, - _OrthancPluginService_BufferCompression = 14, - _OrthancPluginService_ReadFile = 15, - _OrthancPluginService_WriteFile = 16, - _OrthancPluginService_GetErrorDescription = 17, - _OrthancPluginService_CallHttpClient = 18, - _OrthancPluginService_RegisterErrorCode = 19, - _OrthancPluginService_RegisterDictionaryTag = 20, - _OrthancPluginService_DicomBufferToJson = 21, - _OrthancPluginService_DicomInstanceToJson = 22, - _OrthancPluginService_CreateDicom = 23, - _OrthancPluginService_ComputeMd5 = 24, - _OrthancPluginService_ComputeSha1 = 25, - _OrthancPluginService_LookupDictionary = 26, - - /* Registration of callbacks */ - _OrthancPluginService_RegisterRestCallback = 1000, - _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001, - _OrthancPluginService_RegisterStorageArea = 1002, - _OrthancPluginService_RegisterOnChangeCallback = 1003, - _OrthancPluginService_RegisterRestCallbackNoLock = 1004, - _OrthancPluginService_RegisterWorklistCallback = 1005, - _OrthancPluginService_RegisterDecodeImageCallback = 1006, - - /* Sending answers to REST calls */ - _OrthancPluginService_AnswerBuffer = 2000, - _OrthancPluginService_CompressAndAnswerPngImage = 2001, /* Unused as of Orthanc 0.9.4 */ - _OrthancPluginService_Redirect = 2002, - _OrthancPluginService_SendHttpStatusCode = 2003, - _OrthancPluginService_SendUnauthorized = 2004, - _OrthancPluginService_SendMethodNotAllowed = 2005, - _OrthancPluginService_SetCookie = 2006, - _OrthancPluginService_SetHttpHeader = 2007, - _OrthancPluginService_StartMultipartAnswer = 2008, - _OrthancPluginService_SendMultipartItem = 2009, - _OrthancPluginService_SendHttpStatus = 2010, - _OrthancPluginService_CompressAndAnswerImage = 2011, - - /* Access to the Orthanc database and API */ - _OrthancPluginService_GetDicomForInstance = 3000, - _OrthancPluginService_RestApiGet = 3001, - _OrthancPluginService_RestApiPost = 3002, - _OrthancPluginService_RestApiDelete = 3003, - _OrthancPluginService_RestApiPut = 3004, - _OrthancPluginService_LookupPatient = 3005, - _OrthancPluginService_LookupStudy = 3006, - _OrthancPluginService_LookupSeries = 3007, - _OrthancPluginService_LookupInstance = 3008, - _OrthancPluginService_LookupStudyWithAccessionNumber = 3009, - _OrthancPluginService_RestApiGetAfterPlugins = 3010, - _OrthancPluginService_RestApiPostAfterPlugins = 3011, - _OrthancPluginService_RestApiDeleteAfterPlugins = 3012, - _OrthancPluginService_RestApiPutAfterPlugins = 3013, - _OrthancPluginService_ReconstructMainDicomTags = 3014, - _OrthancPluginService_RestApiGet2 = 3015, - - /* Access to DICOM instances */ - _OrthancPluginService_GetInstanceRemoteAet = 4000, - _OrthancPluginService_GetInstanceSize = 4001, - _OrthancPluginService_GetInstanceData = 4002, - _OrthancPluginService_GetInstanceJson = 4003, - _OrthancPluginService_GetInstanceSimplifiedJson = 4004, - _OrthancPluginService_HasInstanceMetadata = 4005, - _OrthancPluginService_GetInstanceMetadata = 4006, - _OrthancPluginService_GetInstanceOrigin = 4007, - - /* Services for plugins implementing a database back-end */ - _OrthancPluginService_RegisterDatabaseBackend = 5000, - _OrthancPluginService_DatabaseAnswer = 5001, - _OrthancPluginService_RegisterDatabaseBackendV2 = 5002, - _OrthancPluginService_StorageAreaCreate = 5003, - _OrthancPluginService_StorageAreaRead = 5004, - _OrthancPluginService_StorageAreaRemove = 5005, - - /* Primitives for handling images */ - _OrthancPluginService_GetImagePixelFormat = 6000, - _OrthancPluginService_GetImageWidth = 6001, - _OrthancPluginService_GetImageHeight = 6002, - _OrthancPluginService_GetImagePitch = 6003, - _OrthancPluginService_GetImageBuffer = 6004, - _OrthancPluginService_UncompressImage = 6005, - _OrthancPluginService_FreeImage = 6006, - _OrthancPluginService_CompressImage = 6007, - _OrthancPluginService_ConvertPixelFormat = 6008, - _OrthancPluginService_GetFontsCount = 6009, - _OrthancPluginService_GetFontInfo = 6010, - _OrthancPluginService_DrawText = 6011, - _OrthancPluginService_CreateImage = 6012, - _OrthancPluginService_CreateImageAccessor = 6013, - _OrthancPluginService_DecodeDicomImage = 6014, - - /* Primitives for handling worklists */ - _OrthancPluginService_WorklistAddAnswer = 7000, - _OrthancPluginService_WorklistMarkIncomplete = 7001, - _OrthancPluginService_WorklistIsMatch = 7002, - _OrthancPluginService_WorklistGetDicomQuery = 7003, - - _OrthancPluginService_INTERNAL = 0x7fffffff - } _OrthancPluginService; - - - typedef enum - { - _OrthancPluginProperty_Description = 1, - _OrthancPluginProperty_RootUri = 2, - _OrthancPluginProperty_OrthancExplorer = 3, - - _OrthancPluginProperty_INTERNAL = 0x7fffffff - } _OrthancPluginProperty; - - - - /** - * The memory layout of the pixels of an image. - * @ingroup Images - **/ - typedef enum - { - /** - * @brief Graylevel 8bpp image. - * - * The image is graylevel. Each pixel is unsigned and stored in - * one byte. - **/ - OrthancPluginPixelFormat_Grayscale8 = 1, - - /** - * @brief Graylevel, unsigned 16bpp image. - * - * The image is graylevel. Each pixel is unsigned and stored in - * two bytes. - **/ - OrthancPluginPixelFormat_Grayscale16 = 2, - - /** - * @brief Graylevel, signed 16bpp image. - * - * The image is graylevel. Each pixel is signed and stored in two - * bytes. - **/ - OrthancPluginPixelFormat_SignedGrayscale16 = 3, - - /** - * @brief Color image in RGB24 format. - * - * This format describes a color image. The pixels are stored in 3 - * consecutive bytes. The memory layout is RGB. - **/ - OrthancPluginPixelFormat_RGB24 = 4, - - /** - * @brief Color image in RGBA32 format. - * - * This format describes a color image. The pixels are stored in 4 - * consecutive bytes. The memory layout is RGBA. - **/ - OrthancPluginPixelFormat_RGBA32 = 5, - - OrthancPluginPixelFormat_Unknown = 6, /*!< Unknown pixel format */ - - _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff - } OrthancPluginPixelFormat; - - - - /** - * The content types that are supported by Orthanc plugins. - **/ - typedef enum - { - OrthancPluginContentType_Unknown = 0, /*!< Unknown content type */ - OrthancPluginContentType_Dicom = 1, /*!< DICOM */ - OrthancPluginContentType_DicomAsJson = 2, /*!< JSON summary of a DICOM file */ - - _OrthancPluginContentType_INTERNAL = 0x7fffffff - } OrthancPluginContentType; - - - - /** - * The supported types of DICOM resources. - **/ - typedef enum - { - OrthancPluginResourceType_Patient = 0, /*!< Patient */ - OrthancPluginResourceType_Study = 1, /*!< Study */ - OrthancPluginResourceType_Series = 2, /*!< Series */ - OrthancPluginResourceType_Instance = 3, /*!< Instance */ - OrthancPluginResourceType_None = 4, /*!< Unavailable resource type */ - - _OrthancPluginResourceType_INTERNAL = 0x7fffffff - } OrthancPluginResourceType; - - - - /** - * The supported types of changes that can happen to DICOM resources. - * @ingroup Callbacks - **/ - typedef enum - { - OrthancPluginChangeType_CompletedSeries = 0, /*!< Series is now complete */ - OrthancPluginChangeType_Deleted = 1, /*!< Deleted resource */ - OrthancPluginChangeType_NewChildInstance = 2, /*!< A new instance was added to this resource */ - OrthancPluginChangeType_NewInstance = 3, /*!< New instance received */ - OrthancPluginChangeType_NewPatient = 4, /*!< New patient created */ - OrthancPluginChangeType_NewSeries = 5, /*!< New series created */ - OrthancPluginChangeType_NewStudy = 6, /*!< New study created */ - OrthancPluginChangeType_StablePatient = 7, /*!< Timeout: No new instance in this patient */ - OrthancPluginChangeType_StableSeries = 8, /*!< Timeout: No new instance in this series */ - OrthancPluginChangeType_StableStudy = 9, /*!< Timeout: No new instance in this study */ - OrthancPluginChangeType_OrthancStarted = 10, /*!< Orthanc has started */ - OrthancPluginChangeType_OrthancStopped = 11, /*!< Orthanc is stopping */ - OrthancPluginChangeType_UpdatedAttachment = 12, /*!< Some user-defined attachment has changed for this resource */ - OrthancPluginChangeType_UpdatedMetadata = 13, /*!< Some user-defined metadata has changed for this resource */ - - _OrthancPluginChangeType_INTERNAL = 0x7fffffff - } OrthancPluginChangeType; - - - /** - * The compression algorithms that are supported by the Orthanc core. - * @ingroup Images - **/ - typedef enum - { - OrthancPluginCompressionType_Zlib = 0, /*!< Standard zlib compression */ - OrthancPluginCompressionType_ZlibWithSize = 1, /*!< zlib, prefixed with uncompressed size (uint64_t) */ - OrthancPluginCompressionType_Gzip = 2, /*!< Standard gzip compression */ - OrthancPluginCompressionType_GzipWithSize = 3, /*!< gzip, prefixed with uncompressed size (uint64_t) */ - - _OrthancPluginCompressionType_INTERNAL = 0x7fffffff - } OrthancPluginCompressionType; - - - /** - * The image formats that are supported by the Orthanc core. - * @ingroup Images - **/ - typedef enum - { - OrthancPluginImageFormat_Png = 0, /*!< Image compressed using PNG */ - OrthancPluginImageFormat_Jpeg = 1, /*!< Image compressed using JPEG */ - OrthancPluginImageFormat_Dicom = 2, /*!< Image compressed using DICOM */ - - _OrthancPluginImageFormat_INTERNAL = 0x7fffffff - } OrthancPluginImageFormat; - - - /** - * The value representations present in the DICOM standard (version 2013). - * @ingroup Toolbox - **/ - typedef enum - { - OrthancPluginValueRepresentation_AE = 1, /*!< Application Entity */ - OrthancPluginValueRepresentation_AS = 2, /*!< Age String */ - OrthancPluginValueRepresentation_AT = 3, /*!< Attribute Tag */ - OrthancPluginValueRepresentation_CS = 4, /*!< Code String */ - OrthancPluginValueRepresentation_DA = 5, /*!< Date */ - OrthancPluginValueRepresentation_DS = 6, /*!< Decimal String */ - OrthancPluginValueRepresentation_DT = 7, /*!< Date Time */ - OrthancPluginValueRepresentation_FD = 8, /*!< Floating Point Double */ - OrthancPluginValueRepresentation_FL = 9, /*!< Floating Point Single */ - OrthancPluginValueRepresentation_IS = 10, /*!< Integer String */ - OrthancPluginValueRepresentation_LO = 11, /*!< Long String */ - OrthancPluginValueRepresentation_LT = 12, /*!< Long Text */ - OrthancPluginValueRepresentation_OB = 13, /*!< Other Byte String */ - OrthancPluginValueRepresentation_OF = 14, /*!< Other Float String */ - OrthancPluginValueRepresentation_OW = 15, /*!< Other Word String */ - OrthancPluginValueRepresentation_PN = 16, /*!< Person Name */ - OrthancPluginValueRepresentation_SH = 17, /*!< Short String */ - OrthancPluginValueRepresentation_SL = 18, /*!< Signed Long */ - OrthancPluginValueRepresentation_SQ = 19, /*!< Sequence of Items */ - OrthancPluginValueRepresentation_SS = 20, /*!< Signed Short */ - OrthancPluginValueRepresentation_ST = 21, /*!< Short Text */ - OrthancPluginValueRepresentation_TM = 22, /*!< Time */ - OrthancPluginValueRepresentation_UI = 23, /*!< Unique Identifier (UID) */ - OrthancPluginValueRepresentation_UL = 24, /*!< Unsigned Long */ - OrthancPluginValueRepresentation_UN = 25, /*!< Unknown */ - OrthancPluginValueRepresentation_US = 26, /*!< Unsigned Short */ - OrthancPluginValueRepresentation_UT = 27, /*!< Unlimited Text */ - - _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff - } OrthancPluginValueRepresentation; - - - /** - * The possible output formats for a DICOM-to-JSON conversion. - * @ingroup Toolbox - * @see OrthancPluginDicomToJson() - **/ - typedef enum - { - OrthancPluginDicomToJsonFormat_Full = 1, /*!< Full output, with most details */ - OrthancPluginDicomToJsonFormat_Short = 2, /*!< Tags output as hexadecimal numbers */ - OrthancPluginDicomToJsonFormat_Human = 3, /*!< Human-readable JSON */ - - _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff - } OrthancPluginDicomToJsonFormat; - - - /** - * Flags to customize a DICOM-to-JSON conversion. By default, binary - * tags are formatted using Data URI scheme. - * @ingroup Toolbox - **/ - typedef enum - { - OrthancPluginDicomToJsonFlags_IncludeBinary = (1 << 0), /*!< Include the binary tags */ - OrthancPluginDicomToJsonFlags_IncludePrivateTags = (1 << 1), /*!< Include the private tags */ - OrthancPluginDicomToJsonFlags_IncludeUnknownTags = (1 << 2), /*!< Include the tags unknown by the dictionary */ - OrthancPluginDicomToJsonFlags_IncludePixelData = (1 << 3), /*!< Include the pixel data */ - OrthancPluginDicomToJsonFlags_ConvertBinaryToAscii = (1 << 4), /*!< Output binary tags as-is, dropping non-ASCII */ - OrthancPluginDicomToJsonFlags_ConvertBinaryToNull = (1 << 5), /*!< Signal binary tags as null values */ - - _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff - } OrthancPluginDicomToJsonFlags; - - - /** - * Flags to the creation of a DICOM file. - * @ingroup Toolbox - * @see OrthancPluginCreateDicom() - **/ - typedef enum - { - OrthancPluginCreateDicomFlags_DecodeDataUriScheme = (1 << 0), /*!< Decode fields encoded using data URI scheme */ - OrthancPluginCreateDicomFlags_GenerateIdentifiers = (1 << 1), /*!< Automatically generate DICOM identifiers */ - - _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff - } OrthancPluginCreateDicomFlags; - - - /** - * The constraints on the DICOM identifiers that must be supported - * by the database plugins. - **/ - typedef enum - { - OrthancPluginIdentifierConstraint_Equal = 1, /*!< Equal */ - OrthancPluginIdentifierConstraint_SmallerOrEqual = 2, /*!< Less or equal */ - OrthancPluginIdentifierConstraint_GreaterOrEqual = 3, /*!< More or equal */ - OrthancPluginIdentifierConstraint_Wildcard = 4, /*!< Case-sensitive wildcard matching (with * and ?) */ - - _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff - } OrthancPluginIdentifierConstraint; - - - /** - * The origin of a DICOM instance that has been received by Orthanc. - **/ - typedef enum - { - OrthancPluginInstanceOrigin_Unknown = 1, /*!< Unknown origin */ - OrthancPluginInstanceOrigin_DicomProtocol = 2, /*!< Instance received through DICOM protocol */ - OrthancPluginInstanceOrigin_RestApi = 3, /*!< Instance received through REST API of Orthanc */ - OrthancPluginInstanceOrigin_Plugin = 4, /*!< Instance added to Orthanc by a plugin */ - OrthancPluginInstanceOrigin_Lua = 5, /*!< Instance added to Orthanc by a Lua script */ - - _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff - } OrthancPluginInstanceOrigin; - - - /** - * @brief A memory buffer allocated by the core system of Orthanc. - * - * A memory buffer allocated by the core system of Orthanc. When the - * content of the buffer is not useful anymore, it must be free by a - * call to ::OrthancPluginFreeMemoryBuffer(). - **/ - typedef struct - { - /** - * @brief The content of the buffer. - **/ - void* data; - - /** - * @brief The number of bytes in the buffer. - **/ - uint32_t size; - } OrthancPluginMemoryBuffer; - - - - - /** - * @brief Opaque structure that represents the HTTP connection to the client application. - * @ingroup Callback - **/ - typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput; - - - - /** - * @brief Opaque structure that represents a DICOM instance received by Orthanc. - **/ - typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance; - - - - /** - * @brief Opaque structure that represents an image that is uncompressed in memory. - * @ingroup Images - **/ - typedef struct _OrthancPluginImage_t OrthancPluginImage; - - - - /** - * @brief Opaque structure that represents the storage area that is actually used by Orthanc. - * @ingroup Images - **/ - typedef struct _OrthancPluginStorageArea_t OrthancPluginStorageArea; - - - - /** - * @brief Opaque structure to an object that represents a C-Find query. - * @ingroup Worklists - **/ - typedef struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery; - - - - /** - * @brief Opaque structure to an object that represents the answers to a C-Find query. - * @ingroup Worklists - **/ - typedef struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers; - - - - /** - * @brief Signature of a callback function that answers to a REST request. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginRestCallback) ( - OrthancPluginRestOutput* output, - const char* url, - const OrthancPluginHttpRequest* request); - - - - /** - * @brief Signature of a callback function that is triggered when Orthanc receives a DICOM instance. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginOnStoredInstanceCallback) ( - OrthancPluginDicomInstance* instance, - const char* instanceId); - - - - /** - * @brief Signature of a callback function that is triggered when a change happens to some DICOM resource. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginOnChangeCallback) ( - OrthancPluginChangeType changeType, - OrthancPluginResourceType resourceType, - const char* resourceId); - - - - /** - * @brief Signature of a callback function to decode a DICOM instance as an image. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginDecodeImageCallback) ( - OrthancPluginImage** target, - const void* dicom, - const uint32_t size, - uint32_t frameIndex); - - - - /** - * @brief Signature of a function to free dynamic memory. - **/ - typedef void (*OrthancPluginFree) (void* buffer); - - - - /** - * @brief Callback for writing to the storage area. - * - * Signature of a callback function that is triggered when Orthanc writes a file to the storage area. - * - * @param uuid The UUID of the file. - * @param content The content of the file. - * @param size The size of the file. - * @param type The content type corresponding to this file. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginStorageCreate) ( - const char* uuid, - const void* content, - int64_t size, - OrthancPluginContentType type); - - - - /** - * @brief Callback for reading from the storage area. - * - * Signature of a callback function that is triggered when Orthanc reads a file from the storage area. - * - * @param content The content of the file (output). - * @param size The size of the file (output). - * @param uuid The UUID of the file of interest. - * @param type The content type corresponding to this file. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginStorageRead) ( - void** content, - int64_t* size, - const char* uuid, - OrthancPluginContentType type); - - - - /** - * @brief Callback for removing a file from the storage area. - * - * Signature of a callback function that is triggered when Orthanc deletes a file from the storage area. - * - * @param uuid The UUID of the file to be removed. - * @param type The content type corresponding to this file. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - typedef OrthancPluginErrorCode (*OrthancPluginStorageRemove) ( - const char* uuid, - OrthancPluginContentType type); - - - - /** - * @brief Callback to handle the C-Find SCP requests received by Orthanc. - * - * Signature of a callback function that is triggered when Orthanc - * receives a C-Find SCP request against modality worklists. - * - * @param answers The target structure where answers must be stored. - * @param query The worklist query. - * @param remoteAet The Application Entity Title (AET) of the modality from which the request originates. - * @param calledAet The Application Entity Title (AET) of the modality that is called by the request. - * @return 0 if success, other value if error. - * @ingroup Worklists - **/ - typedef OrthancPluginErrorCode (*OrthancPluginWorklistCallback) ( - OrthancPluginWorklistAnswers* answers, - const OrthancPluginWorklistQuery* query, - const char* remoteAet, - const char* calledAet); - - - - /** - * @brief Data structure that contains information about the Orthanc core. - **/ - typedef struct _OrthancPluginContext_t - { - void* pluginsManager; - const char* orthancVersion; - OrthancPluginFree Free; - OrthancPluginErrorCode (*InvokeService) (struct _OrthancPluginContext_t* context, - _OrthancPluginService service, - const void* params); - } OrthancPluginContext; - - - - /** - * @brief An entry in the dictionary of DICOM tags. - **/ - typedef struct - { - uint16_t group; /*!< The group of the tag */ - uint16_t element; /*!< The element of the tag */ - OrthancPluginValueRepresentation vr; /*!< The value representation of the tag */ - uint32_t minMultiplicity; /*!< The minimum multiplicity of the tag */ - uint32_t maxMultiplicity; /*!< The maximum multiplicity of the tag (0 means arbitrary) */ - } OrthancPluginDictionaryEntry; - - - - /** - * @brief Free a string. - * - * Free a string that was allocated by the core system of Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param str The string to be freed. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString( - OrthancPluginContext* context, - char* str) - { - if (str != NULL) - { - context->Free(str); - } - } - - - /** - * @brief Check the compatibility of the plugin wrt. the version of its hosting Orthanc. - * - * This function checks whether the version of this C header is - * compatible with the current version of Orthanc. The result of - * this function should always be checked in the - * OrthancPluginInitialize() entry point of the plugin. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return 1 if and only if the versions are compatible. If the - * result is 0, the initialization of the plugin should fail. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion( - OrthancPluginContext* context) - { - int major, minor, revision; - - if (sizeof(int32_t) != sizeof(OrthancPluginErrorCode) || - sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) || - sizeof(int32_t) != sizeof(_OrthancPluginService) || - sizeof(int32_t) != sizeof(_OrthancPluginProperty) || - sizeof(int32_t) != sizeof(OrthancPluginPixelFormat) || - sizeof(int32_t) != sizeof(OrthancPluginContentType) || - sizeof(int32_t) != sizeof(OrthancPluginResourceType) || - sizeof(int32_t) != sizeof(OrthancPluginChangeType) || - sizeof(int32_t) != sizeof(OrthancPluginCompressionType) || - sizeof(int32_t) != sizeof(OrthancPluginImageFormat) || - sizeof(int32_t) != sizeof(OrthancPluginValueRepresentation) || - sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFormat) || - sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFlags) || - sizeof(int32_t) != sizeof(OrthancPluginCreateDicomFlags) || - sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint) || - sizeof(int32_t) != sizeof(OrthancPluginInstanceOrigin)) - { - /* Mismatch in the size of the enumerations */ - return 0; - } - - /* Assume compatibility with the mainline */ - if (!strcmp(context->orthancVersion, "mainline")) - { - return 1; - } - - /* Parse the version of the Orthanc core */ - if ( -#ifdef _MSC_VER - sscanf_s -#else - sscanf -#endif - (context->orthancVersion, "%4d.%4d.%4d", &major, &minor, &revision) != 3) - { - return 0; - } - - /* Check the major number of the version */ - - if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER) - { - return 1; - } - - if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER) - { - return 0; - } - - /* Check the minor number of the version */ - - if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER) - { - return 1; - } - - if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER) - { - return 0; - } - - /* Check the revision number of the version */ - - if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER) - { - return 1; - } - else - { - return 0; - } - } - - - /** - * @brief Free a memory buffer. - * - * Free a memory buffer that was allocated by the core system of Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param buffer The memory buffer to release. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* buffer) - { - context->Free(buffer->data); - } - - - /** - * @brief Log an error. - * - * Log an error message using the Orthanc logging system. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param message The message to be logged. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginLogError( - OrthancPluginContext* context, - const char* message) - { - context->InvokeService(context, _OrthancPluginService_LogError, message); - } - - - /** - * @brief Log a warning. - * - * Log a warning message using the Orthanc logging system. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param message The message to be logged. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning( - OrthancPluginContext* context, - const char* message) - { - context->InvokeService(context, _OrthancPluginService_LogWarning, message); - } - - - /** - * @brief Log an information. - * - * Log an information message using the Orthanc logging system. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param message The message to be logged. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo( - OrthancPluginContext* context, - const char* message) - { - context->InvokeService(context, _OrthancPluginService_LogInfo, message); - } - - - - typedef struct - { - const char* pathRegularExpression; - OrthancPluginRestCallback callback; - } _OrthancPluginRestCallback; - - /** - * @brief Register a REST callback. - * - * This function registers a REST callback against a regular - * expression for a URI. This function must be called during the - * initialization of the plugin, i.e. inside the - * OrthancPluginInitialize() public function. - * - * Each REST callback is guaranteed to run in mutual exclusion. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param pathRegularExpression Regular expression for the URI. May contain groups. - * @param callback The callback function to handle the REST call. - * @see OrthancPluginRegisterRestCallbackNoLock() - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback( - OrthancPluginContext* context, - const char* pathRegularExpression, - OrthancPluginRestCallback callback) - { - _OrthancPluginRestCallback params; - params.pathRegularExpression = pathRegularExpression; - params.callback = callback; - context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms); - } - - - - /** - * @brief Register a REST callback, without locking. - * - * This function registers a REST callback against a regular - * expression for a URI. This function must be called during the - * initialization of the plugin, i.e. inside the - * OrthancPluginInitialize() public function. - * - * Contrarily to OrthancPluginRegisterRestCallback(), the callback - * will NOT be invoked in mutual exclusion. This can be useful for - * high-performance plugins that must handle concurrent requests - * (Orthanc uses a pool of threads, one thread being assigned to - * each incoming HTTP request). Of course, it is up to the plugin to - * implement the required locking mechanisms. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param pathRegularExpression Regular expression for the URI. May contain groups. - * @param callback The callback function to handle the REST call. - * @see OrthancPluginRegisterRestCallback() - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock( - OrthancPluginContext* context, - const char* pathRegularExpression, - OrthancPluginRestCallback callback) - { - _OrthancPluginRestCallback params; - params.pathRegularExpression = pathRegularExpression; - params.callback = callback; - context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms); - } - - - - typedef struct - { - OrthancPluginOnStoredInstanceCallback callback; - } _OrthancPluginOnStoredInstanceCallback; - - /** - * @brief Register a callback for received instances. - * - * This function registers a callback function that is called - * whenever a new DICOM instance is stored into the Orthanc core. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param callback The callback function. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback( - OrthancPluginContext* context, - OrthancPluginOnStoredInstanceCallback callback) - { - _OrthancPluginOnStoredInstanceCallback params; - params.callback = callback; - - context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms); - } - - - - typedef struct - { - OrthancPluginRestOutput* output; - const char* answer; - uint32_t answerSize; - const char* mimeType; - } _OrthancPluginAnswerBuffer; - - /** - * @brief Answer to a REST request. - * - * This function answers to a REST request with the content of a memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param answer Pointer to the memory buffer containing the answer. - * @param answerSize Number of bytes of the answer. - * @param mimeType The MIME type of the answer. - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* answer, - uint32_t answerSize, - const char* mimeType) - { - _OrthancPluginAnswerBuffer params; - params.output = output; - params.answer = answer; - params.answerSize = answerSize; - params.mimeType = mimeType; - context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms); - } - - - typedef struct - { - OrthancPluginRestOutput* output; - OrthancPluginPixelFormat format; - uint32_t width; - uint32_t height; - uint32_t pitch; - const void* buffer; - } _OrthancPluginCompressAndAnswerPngImage; - - typedef struct - { - OrthancPluginRestOutput* output; - OrthancPluginImageFormat imageFormat; - OrthancPluginPixelFormat pixelFormat; - uint32_t width; - uint32_t height; - uint32_t pitch; - const void* buffer; - uint8_t quality; - } _OrthancPluginCompressAndAnswerImage; - - - /** - * @brief Answer to a REST request with a PNG image. - * - * This function answers to a REST request with a PNG image. The - * parameters of this function describe a memory buffer that - * contains an uncompressed image. The image will be automatically compressed - * as a PNG image by the core system of Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param format The memory layout of the uncompressed image. - * @param width The width of the image. - * @param height The height of the image. - * @param pitch The pitch of the image (i.e. the number of bytes - * between 2 successive lines of the image in the memory buffer). - * @param buffer The memory buffer containing the uncompressed image. - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height, - uint32_t pitch, - const void* buffer) - { - _OrthancPluginCompressAndAnswerImage params; - params.output = output; - params.imageFormat = OrthancPluginImageFormat_Png; - params.pixelFormat = format; - params.width = width; - params.height = height; - params.pitch = pitch; - params.buffer = buffer; - params.quality = 0; /* No quality for PNG */ - context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms); - } - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const char* instanceId; - } _OrthancPluginGetDicomForInstance; - - /** - * @brief Retrieve a DICOM instance using its Orthanc identifier. - * - * Retrieve a DICOM instance using its Orthanc identifier. The DICOM - * file is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param instanceId The Orthanc identifier of the DICOM instance of interest. - * @return 0 if success, or the error code if failure. - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* instanceId) - { - _OrthancPluginGetDicomForInstance params; - params.target = target; - params.instanceId = instanceId; - return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms); - } - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const char* uri; - } _OrthancPluginRestApiGet; - - /** - * @brief Make a GET call to the built-in Orthanc REST API. - * - * Make a GET call to the built-in Orthanc REST API. The result to - * the query is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiGetAfterPlugins - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri) - { - _OrthancPluginRestApiGet params; - params.target = target; - params.uri = uri; - return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms); - } - - - - /** - * @brief Make a GET call to the REST API, as tainted by the plugins. - * - * Make a GET call to the Orthanc REST API, after all the plugins - * are applied. In other words, if some plugin overrides or adds the - * called URI to the built-in Orthanc REST API, this call will - * return the result provided by this plugin. The result to the - * query is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiGet - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGetAfterPlugins( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri) - { - _OrthancPluginRestApiGet params; - params.target = target; - params.uri = uri; - return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms); - } - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const char* uri; - const char* body; - uint32_t bodySize; - } _OrthancPluginRestApiPostPut; - - /** - * @brief Make a POST call to the built-in Orthanc REST API. - * - * Make a POST call to the built-in Orthanc REST API. The result to - * the query is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @param body The body of the POST request. - * @param bodySize The size of the body. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiPostAfterPlugins - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri, - const char* body, - uint32_t bodySize) - { - _OrthancPluginRestApiPostPut params; - params.target = target; - params.uri = uri; - params.body = body; - params.bodySize = bodySize; - return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms); - } - - - /** - * @brief Make a POST call to the REST API, as tainted by the plugins. - * - * Make a POST call to the Orthanc REST API, after all the plugins - * are applied. In other words, if some plugin overrides or adds the - * called URI to the built-in Orthanc REST API, this call will - * return the result provided by this plugin. The result to the - * query is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @param body The body of the POST request. - * @param bodySize The size of the body. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiPost - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri, - const char* body, - uint32_t bodySize) - { - _OrthancPluginRestApiPostPut params; - params.target = target; - params.uri = uri; - params.body = body; - params.bodySize = bodySize; - return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms); - } - - - - /** - * @brief Make a DELETE call to the built-in Orthanc REST API. - * - * Make a DELETE call to the built-in Orthanc REST API. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param uri The URI to delete in the built-in Orthanc API. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiDeleteAfterPlugins - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete( - OrthancPluginContext* context, - const char* uri) - { - return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri); - } - - - /** - * @brief Make a DELETE call to the REST API, as tainted by the plugins. - * - * Make a DELETE call to the Orthanc REST API, after all the plugins - * are applied. In other words, if some plugin overrides or adds the - * called URI to the built-in Orthanc REST API, this call will - * return the result provided by this plugin. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param uri The URI to delete in the built-in Orthanc API. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiDelete - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins( - OrthancPluginContext* context, - const char* uri) - { - return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri); - } - - - - /** - * @brief Make a PUT call to the built-in Orthanc REST API. - * - * Make a PUT call to the built-in Orthanc REST API. The result to - * the query is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @param body The body of the PUT request. - * @param bodySize The size of the body. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiPutAfterPlugins - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri, - const char* body, - uint32_t bodySize) - { - _OrthancPluginRestApiPostPut params; - params.target = target; - params.uri = uri; - params.body = body; - params.bodySize = bodySize; - return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms); - } - - - - /** - * @brief Make a PUT call to the REST API, as tainted by the plugins. - * - * Make a PUT call to the Orthanc REST API, after all the plugins - * are applied. In other words, if some plugin overrides or adds the - * called URI to the built-in Orthanc REST API, this call will - * return the result provided by this plugin. The result to the - * query is stored into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @param body The body of the PUT request. - * @param bodySize The size of the body. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiPut - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri, - const char* body, - uint32_t bodySize) - { - _OrthancPluginRestApiPostPut params; - params.target = target; - params.uri = uri; - params.body = body; - params.bodySize = bodySize; - return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms); - } - - - - typedef struct - { - OrthancPluginRestOutput* output; - const char* argument; - } _OrthancPluginOutputPlusArgument; - - /** - * @brief Redirect a REST request. - * - * This function answers to a REST request by redirecting the user - * to another URI using HTTP status 301. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param redirection Where to redirect. - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* redirection) - { - _OrthancPluginOutputPlusArgument params; - params.output = output; - params.argument = redirection; - context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms); - } - - - - typedef struct - { - char** result; - const char* argument; - } _OrthancPluginRetrieveDynamicString; - - /** - * @brief Look for a patient. - * - * Look for a patient stored in Orthanc, using its Patient ID tag (0x0010, 0x0020). - * This function uses the database index to run as fast as possible (it does not loop - * over all the stored patients). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param patientID The Patient ID of interest. - * @return The NULL value if the patient is non-existent, or a string containing the - * Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString(). - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient( - OrthancPluginContext* context, - const char* patientID) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = patientID; - - if (context->InvokeService(context, _OrthancPluginService_LookupPatient, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Look for a study. - * - * Look for a study stored in Orthanc, using its Study Instance UID tag (0x0020, 0x000d). - * This function uses the database index to run as fast as possible (it does not loop - * over all the stored studies). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param studyUID The Study Instance UID of interest. - * @return The NULL value if the study is non-existent, or a string containing the - * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString(). - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy( - OrthancPluginContext* context, - const char* studyUID) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = studyUID; - - if (context->InvokeService(context, _OrthancPluginService_LookupStudy, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Look for a study, using the accession number. - * - * Look for a study stored in Orthanc, using its Accession Number tag (0x0008, 0x0050). - * This function uses the database index to run as fast as possible (it does not loop - * over all the stored studies). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param accessionNumber The Accession Number of interest. - * @return The NULL value if the study is non-existent, or a string containing the - * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString(). - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber( - OrthancPluginContext* context, - const char* accessionNumber) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = accessionNumber; - - if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Look for a series. - * - * Look for a series stored in Orthanc, using its Series Instance UID tag (0x0020, 0x000e). - * This function uses the database index to run as fast as possible (it does not loop - * over all the stored series). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param seriesUID The Series Instance UID of interest. - * @return The NULL value if the series is non-existent, or a string containing the - * Orthanc ID of the series. This string must be freed by OrthancPluginFreeString(). - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries( - OrthancPluginContext* context, - const char* seriesUID) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = seriesUID; - - if (context->InvokeService(context, _OrthancPluginService_LookupSeries, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Look for an instance. - * - * Look for an instance stored in Orthanc, using its SOP Instance UID tag (0x0008, 0x0018). - * This function uses the database index to run as fast as possible (it does not loop - * over all the stored instances). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param sopInstanceUID The SOP Instance UID of interest. - * @return The NULL value if the instance is non-existent, or a string containing the - * Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString(). - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance( - OrthancPluginContext* context, - const char* sopInstanceUID) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = sopInstanceUID; - - if (context->InvokeService(context, _OrthancPluginService_LookupInstance, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginRestOutput* output; - uint16_t status; - } _OrthancPluginSendHttpStatusCode; - - /** - * @brief Send a HTTP status code. - * - * This function answers to a REST request by sending a HTTP status - * code (such as "400 - Bad Request"). Note that: - * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). - * - Redirections (status 301) must use ::OrthancPluginRedirect(). - * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). - * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param status The HTTP status code to be sent. - * @ingroup REST - * @see OrthancPluginSendHttpStatus() - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - uint16_t status) - { - _OrthancPluginSendHttpStatusCode params; - params.output = output; - params.status = status; - context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms); - } - - - /** - * @brief Signal that a REST request is not authorized. - * - * This function answers to a REST request by signaling that it is - * not authorized. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param realm The realm for the authorization process. - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* realm) - { - _OrthancPluginOutputPlusArgument params; - params.output = output; - params.argument = realm; - context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms); - } - - - /** - * @brief Signal that this URI does not support this HTTP method. - * - * This function answers to a REST request by signaling that the - * queried URI does not support this method. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param allowedMethods The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request). - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* allowedMethods) - { - _OrthancPluginOutputPlusArgument params; - params.output = output; - params.argument = allowedMethods; - context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms); - } - - - typedef struct - { - OrthancPluginRestOutput* output; - const char* key; - const char* value; - } _OrthancPluginSetHttpHeader; - - /** - * @brief Set a cookie. - * - * This function sets a cookie in the HTTP client. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param cookie The cookie to be set. - * @param value The value of the cookie. - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* cookie, - const char* value) - { - _OrthancPluginSetHttpHeader params; - params.output = output; - params.key = cookie; - params.value = value; - context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms); - } - - - /** - * @brief Set some HTTP header. - * - * This function sets a HTTP header in the HTTP answer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param key The HTTP header to be set. - * @param value The value of the HTTP header. - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* key, - const char* value) - { - _OrthancPluginSetHttpHeader params; - params.output = output; - params.key = key; - params.value = value; - context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms); - } - - - typedef struct - { - char** resultStringToFree; - const char** resultString; - int64_t* resultInt64; - const char* key; - OrthancPluginDicomInstance* instance; - OrthancPluginInstanceOrigin* resultOrigin; /* New in Orthanc 0.9.5 SDK */ - } _OrthancPluginAccessDicomInstance; - - - /** - * @brief Get the AET of a DICOM instance. - * - * This function returns the Application Entity Title (AET) of the - * DICOM modality from which a DICOM instance originates. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @return The AET if success, NULL if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance) - { - const char* result; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultString = &result; - params.instance = instance; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Get the size of a DICOM file. - * - * This function returns the number of bytes of the given DICOM instance. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @return The size of the file, -1 in case of error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance) - { - int64_t size; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultInt64 = &size; - params.instance = instance; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return -1; - } - else - { - return size; - } - } - - - /** - * @brief Get the data of a DICOM file. - * - * This function returns a pointer to the content of the given DICOM instance. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @return The pointer to the DICOM data, NULL in case of error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance) - { - const char* result; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultString = &result; - params.instance = instance; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Get the DICOM tag hierarchy as a JSON file. - * - * This function returns a pointer to a newly created string - * containing a JSON file. This JSON file encodes the tag hierarchy - * of the given DICOM instance. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @return The NULL value in case of error, or a string containing the JSON file. - * This string must be freed by OrthancPluginFreeString(). - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance) - { - char* result; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultStringToFree = &result; - params.instance = instance; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Get the DICOM tag hierarchy as a JSON file (with simplification). - * - * This function returns a pointer to a newly created string - * containing a JSON file. This JSON file encodes the tag hierarchy - * of the given DICOM instance. In contrast with - * ::OrthancPluginGetInstanceJson(), the returned JSON file is in - * its simplified version. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @return The NULL value in case of error, or a string containing the JSON file. - * This string must be freed by OrthancPluginFreeString(). - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance) - { - char* result; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultStringToFree = &result; - params.instance = instance; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Check whether a DICOM instance is associated with some metadata. - * - * This function checks whether the DICOM instance of interest is - * associated with some metadata. As of Orthanc 0.8.1, in the - * callbacks registered by - * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only - * possibly available metadata are "ReceptionDate", "RemoteAET" and - * "IndexInSeries". - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @param metadata The metadata of interest. - * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance, - const char* metadata) - { - int64_t result; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultInt64 = &result; - params.instance = instance; - params.key = metadata; - - if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return -1; - } - else - { - return (result != 0); - } - } - - - /** - * @brief Get the value of some metadata associated with a given DICOM instance. - * - * This functions returns the value of some metadata that is associated with the DICOM instance of interest. - * Before calling this function, the existence of the metadata must have been checked with - * ::OrthancPluginHasInstanceMetadata(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @param metadata The metadata of interest. - * @return The metadata value if success, NULL if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance, - const char* metadata) - { - const char* result; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultString = &result; - params.instance = instance; - params.key = metadata; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginStorageCreate create; - OrthancPluginStorageRead read; - OrthancPluginStorageRemove remove; - OrthancPluginFree free; - } _OrthancPluginRegisterStorageArea; - - /** - * @brief Register a custom storage area. - * - * This function registers a custom storage area, to replace the - * built-in way Orthanc stores its files on the filesystem. This - * function must be called during the initialization of the plugin, - * i.e. inside the OrthancPluginInitialize() public function. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param create The callback function to store a file on the custom storage area. - * @param read The callback function to read a file from the custom storage area. - * @param remove The callback function to remove a file from the custom storage area. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea( - OrthancPluginContext* context, - OrthancPluginStorageCreate create, - OrthancPluginStorageRead read, - OrthancPluginStorageRemove remove) - { - _OrthancPluginRegisterStorageArea params; - params.create = create; - params.read = read; - params.remove = remove; - -#ifdef __cplusplus - params.free = ::free; -#else - params.free = free; -#endif - - context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms); - } - - - - /** - * @brief Return the path to the Orthanc executable. - * - * This function returns the path to the Orthanc executable. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return NULL in the case of an error, or a newly allocated string - * containing the path. This string must be freed by - * OrthancPluginFreeString(). - **/ - ORTHANC_PLUGIN_INLINE char *OrthancPluginGetOrthancPath(OrthancPluginContext* context) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = NULL; - - if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Return the directory containing the Orthanc. - * - * This function returns the path to the directory containing the Orthanc executable. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return NULL in the case of an error, or a newly allocated string - * containing the path. This string must be freed by - * OrthancPluginFreeString(). - **/ - ORTHANC_PLUGIN_INLINE char *OrthancPluginGetOrthancDirectory(OrthancPluginContext* context) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = NULL; - - if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Return the path to the configuration file(s). - * - * This function returns the path to the configuration file(s) that - * was specified when starting Orthanc. Since version 0.9.1, this - * path can refer to a folder that stores a set of configuration - * files. This function is deprecated in favor of - * OrthancPluginGetConfiguration(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return NULL in the case of an error, or a newly allocated string - * containing the path. This string must be freed by - * OrthancPluginFreeString(). - * @see OrthancPluginGetConfiguration() - **/ - ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfigurationPath(OrthancPluginContext* context) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = NULL; - - if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginOnChangeCallback callback; - } _OrthancPluginOnChangeCallback; - - /** - * @brief Register a callback to monitor changes. - * - * This function registers a callback function that is called - * whenever a change happens to some DICOM resource. - * - * @warning If your change callback has to call the REST API of - * Orthanc, you should make these calls in a separate thread (with - * the events passing through a message queue). Otherwise, this - * could result in deadlocks in the presence of other plugins or Lua - * script. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param callback The callback function. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback( - OrthancPluginContext* context, - OrthancPluginOnChangeCallback callback) - { - _OrthancPluginOnChangeCallback params; - params.callback = callback; - - context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms); - } - - - - typedef struct - { - const char* plugin; - _OrthancPluginProperty property; - const char* value; - } _OrthancPluginSetPluginProperty; - - - /** - * @brief Set the URI where the plugin provides its Web interface. - * - * For plugins that come with a Web interface, this function - * declares the entry path where to find this interface. This - * information is notably used in the "Plugins" page of Orthanc - * Explorer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param uri The root URI for this plugin. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri( - OrthancPluginContext* context, - const char* uri) - { - _OrthancPluginSetPluginProperty params; - params.plugin = OrthancPluginGetName(); - params.property = _OrthancPluginProperty_RootUri; - params.value = uri; - - context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); - } - - - /** - * @brief Set a description for this plugin. - * - * Set a description for this plugin. It is displayed in the - * "Plugins" page of Orthanc Explorer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param description The description. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription( - OrthancPluginContext* context, - const char* description) - { - _OrthancPluginSetPluginProperty params; - params.plugin = OrthancPluginGetName(); - params.property = _OrthancPluginProperty_Description; - params.value = description; - - context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); - } - - - /** - * @brief Extend the JavaScript code of Orthanc Explorer. - * - * Add JavaScript code to customize the default behavior of Orthanc - * Explorer. This can for instance be used to add new buttons. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param javascript The custom JavaScript code. - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer( - OrthancPluginContext* context, - const char* javascript) - { - _OrthancPluginSetPluginProperty params; - params.plugin = OrthancPluginGetName(); - params.property = _OrthancPluginProperty_OrthancExplorer; - params.value = javascript; - - context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); - } - - - typedef struct - { - char** result; - int32_t property; - const char* value; - } _OrthancPluginGlobalProperty; - - - /** - * @brief Get the value of a global property. - * - * Get the value of a global property that is stored in the Orthanc database. Global - * properties whose index is below 1024 are reserved by Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param property The global property of interest. - * @param defaultValue The value to return, if the global property is unset. - * @return The value of the global property, or NULL in the case of an error. This - * string must be freed by OrthancPluginFreeString(). - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginGetGlobalProperty( - OrthancPluginContext* context, - int32_t property, - const char* defaultValue) - { - char* result; - - _OrthancPluginGlobalProperty params; - params.result = &result; - params.property = property; - params.value = defaultValue; - - if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Set the value of a global property. - * - * Set the value of a global property into the Orthanc - * database. Setting a global property can be used by plugins to - * save their internal parameters. Plugins are only allowed to set - * properties whose index are above or equal to 1024 (properties - * below 1024 are read-only and reserved by Orthanc). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param property The global property of interest. - * @param value The value to be set in the global property. - * @return 0 if success, or the error code if failure. - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetGlobalProperty( - OrthancPluginContext* context, - int32_t property, - const char* value) - { - _OrthancPluginGlobalProperty params; - params.result = NULL; - params.property = property; - params.value = value; - - return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms); - } - - - - typedef struct - { - int32_t *resultInt32; - uint32_t *resultUint32; - int64_t *resultInt64; - uint64_t *resultUint64; - } _OrthancPluginReturnSingleValue; - - /** - * @brief Get the number of command-line arguments. - * - * Retrieve the number of command-line arguments that were used to launch Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return The number of arguments. - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetCommandLineArgumentsCount( - OrthancPluginContext* context) - { - uint32_t count = 0; - - _OrthancPluginReturnSingleValue params; - memset(¶ms, 0, sizeof(params)); - params.resultUint32 = &count; - - if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return 0; - } - else - { - return count; - } - } - - - - /** - * @brief Get the value of a command-line argument. - * - * Get the value of one of the command-line arguments that were used - * to launch Orthanc. The number of available arguments can be - * retrieved by OrthancPluginGetCommandLineArgumentsCount(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param argument The index of the argument. - * @return The value of the argument, or NULL in the case of an error. This - * string must be freed by OrthancPluginFreeString(). - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginGetCommandLineArgument( - OrthancPluginContext* context, - uint32_t argument) - { - char* result; - - _OrthancPluginGlobalProperty params; - params.result = &result; - params.property = (int32_t) argument; - params.value = NULL; - - if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Get the expected version of the database schema. - * - * Retrieve the expected version of the database schema. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return The version. - * @ingroup Callbacks - * @deprecated Please instead use IDatabaseBackend::UpgradeDatabase() - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion( - OrthancPluginContext* context) - { - uint32_t count = 0; - - _OrthancPluginReturnSingleValue params; - memset(¶ms, 0, sizeof(params)); - params.resultUint32 = &count; - - if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return 0; - } - else - { - return count; - } - } - - - - /** - * @brief Return the content of the configuration file(s). - * - * This function returns the content of the configuration that is - * used by Orthanc, formatted as a JSON string. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return NULL in the case of an error, or a newly allocated string - * containing the configuration. This string must be freed by - * OrthancPluginFreeString(). - **/ - ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfiguration(OrthancPluginContext* context) - { - char* result; - - _OrthancPluginRetrieveDynamicString params; - params.result = &result; - params.argument = NULL; - - if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginRestOutput* output; - const char* subType; - const char* contentType; - } _OrthancPluginStartMultipartAnswer; - - /** - * @brief Start an HTTP multipart answer. - * - * Initiates a HTTP multipart answer, as the result of a REST request. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param subType The sub-type of the multipart answer ("mixed" or "related"). - * @param contentType The MIME type of the items in the multipart answer. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginSendMultipartItem() - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* subType, - const char* contentType) - { - _OrthancPluginStartMultipartAnswer params; - params.output = output; - params.subType = subType; - params.contentType = contentType; - return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms); - } - - - /** - * @brief Send an item as a part of some HTTP multipart answer. - * - * This function sends an item as a part of some HTTP multipart - * answer that was initiated by OrthancPluginStartMultipartAnswer(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param answer Pointer to the memory buffer containing the item. - * @param answerSize Number of bytes of the item. - * @return 0 if success, or the error code if failure (this notably happens - * if the connection is closed by the client). - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - const char* answer, - uint32_t answerSize) - { - _OrthancPluginAnswerBuffer params; - params.output = output; - params.answer = answer; - params.answerSize = answerSize; - params.mimeType = NULL; - return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms); - } - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const void* source; - uint32_t size; - OrthancPluginCompressionType compression; - uint8_t uncompress; - } _OrthancPluginBufferCompression; - - - /** - * @brief Compress or decompress a buffer. - * - * This function compresses or decompresses a buffer, using the - * version of the zlib library that is used by the Orthanc core. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param source The source buffer. - * @param size The size in bytes of the source buffer. - * @param compression The compression algorithm. - * @param uncompress If set to "0", the buffer must be compressed. - * If set to "1", the buffer must be uncompressed. - * @return 0 if success, or the error code if failure. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginBufferCompression( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const void* source, - uint32_t size, - OrthancPluginCompressionType compression, - uint8_t uncompress) - { - _OrthancPluginBufferCompression params; - params.target = target; - params.source = source; - params.size = size; - params.compression = compression; - params.uncompress = uncompress; - - return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms); - } - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const char* path; - } _OrthancPluginReadFile; - - /** - * @brief Read a file. - * - * Read the content of a file on the filesystem, and returns it into - * a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param path The path of the file to be read. - * @return 0 if success, or the error code if failure. - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReadFile( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* path) - { - _OrthancPluginReadFile params; - params.target = target; - params.path = path; - return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms); - } - - - - typedef struct - { - const char* path; - const void* data; - uint32_t size; - } _OrthancPluginWriteFile; - - /** - * @brief Write a file. - * - * Write the content of a memory buffer to the filesystem. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param path The path of the file to be written. - * @param data The content of the memory buffer. - * @param size The size of the memory buffer. - * @return 0 if success, or the error code if failure. - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWriteFile( - OrthancPluginContext* context, - const char* path, - const void* data, - uint32_t size) - { - _OrthancPluginWriteFile params; - params.path = path; - params.data = data; - params.size = size; - return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms); - } - - - - typedef struct - { - const char** target; - OrthancPluginErrorCode error; - } _OrthancPluginGetErrorDescription; - - /** - * @brief Get the description of a given error code. - * - * This function returns the description of a given error code. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param error The error code of interest. - * @return The error description. This is a statically-allocated - * string, do not free it. - **/ - ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription( - OrthancPluginContext* context, - OrthancPluginErrorCode error) - { - const char* result = NULL; - - _OrthancPluginGetErrorDescription params; - params.target = &result; - params.error = error; - - if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, ¶ms) != OrthancPluginErrorCode_Success || - result == NULL) - { - return "Unknown error code"; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginRestOutput* output; - uint16_t status; - const char* body; - uint32_t bodySize; - } _OrthancPluginSendHttpStatus; - - /** - * @brief Send a HTTP status, with a custom body. - * - * This function answers to a HTTP request by sending a HTTP status - * code (such as "400 - Bad Request"), together with a body - * describing the error. The body will only be returned if the - * configuration option "HttpDescribeErrors" of Orthanc is set to "true". - * - * Note that: - * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). - * - Redirections (status 301) must use ::OrthancPluginRedirect(). - * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). - * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param status The HTTP status code to be sent. - * @param body The body of the answer. - * @param bodySize The size of the body. - * @see OrthancPluginSendHttpStatusCode() - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - uint16_t status, - const char* body, - uint32_t bodySize) - { - _OrthancPluginSendHttpStatus params; - params.output = output; - params.status = status; - params.body = body; - params.bodySize = bodySize; - context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms); - } - - - - typedef struct - { - const OrthancPluginImage* image; - uint32_t* resultUint32; - OrthancPluginPixelFormat* resultPixelFormat; - void** resultBuffer; - } _OrthancPluginGetImageInfo; - - - /** - * @brief Return the pixel format of an image. - * - * This function returns the type of memory layout for the pixels of the given image. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image of interest. - * @return The pixel format. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat( - OrthancPluginContext* context, - const OrthancPluginImage* image) - { - OrthancPluginPixelFormat target; - - _OrthancPluginGetImageInfo params; - memset(¶ms, 0, sizeof(params)); - params.image = image; - params.resultPixelFormat = ⌖ - - if (context->InvokeService(context, _OrthancPluginService_GetImagePixelFormat, ¶ms) != OrthancPluginErrorCode_Success) - { - return OrthancPluginPixelFormat_Unknown; - } - else - { - return (OrthancPluginPixelFormat) target; - } - } - - - - /** - * @brief Return the width of an image. - * - * This function returns the width of the given image. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image of interest. - * @return The width. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth( - OrthancPluginContext* context, - const OrthancPluginImage* image) - { - uint32_t width; - - _OrthancPluginGetImageInfo params; - memset(¶ms, 0, sizeof(params)); - params.image = image; - params.resultUint32 = &width; - - if (context->InvokeService(context, _OrthancPluginService_GetImageWidth, ¶ms) != OrthancPluginErrorCode_Success) - { - return 0; - } - else - { - return width; - } - } - - - - /** - * @brief Return the height of an image. - * - * This function returns the height of the given image. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image of interest. - * @return The height. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight( - OrthancPluginContext* context, - const OrthancPluginImage* image) - { - uint32_t height; - - _OrthancPluginGetImageInfo params; - memset(¶ms, 0, sizeof(params)); - params.image = image; - params.resultUint32 = &height; - - if (context->InvokeService(context, _OrthancPluginService_GetImageHeight, ¶ms) != OrthancPluginErrorCode_Success) - { - return 0; - } - else - { - return height; - } - } - - - - /** - * @brief Return the pitch of an image. - * - * This function returns the pitch of the given image. The pitch is - * defined as the number of bytes between 2 successive lines of the - * image in the memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image of interest. - * @return The pitch. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch( - OrthancPluginContext* context, - const OrthancPluginImage* image) - { - uint32_t pitch; - - _OrthancPluginGetImageInfo params; - memset(¶ms, 0, sizeof(params)); - params.image = image; - params.resultUint32 = &pitch; - - if (context->InvokeService(context, _OrthancPluginService_GetImagePitch, ¶ms) != OrthancPluginErrorCode_Success) - { - return 0; - } - else - { - return pitch; - } - } - - - - /** - * @brief Return a pointer to the content of an image. - * - * This function returns a pointer to the memory buffer that - * contains the pixels of the image. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image of interest. - * @return The pointer. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE void* OrthancPluginGetImageBuffer( - OrthancPluginContext* context, - const OrthancPluginImage* image) - { - void* target = NULL; - - _OrthancPluginGetImageInfo params; - memset(¶ms, 0, sizeof(params)); - params.resultBuffer = ⌖ - params.image = image; - - if (context->InvokeService(context, _OrthancPluginService_GetImageBuffer, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return target; - } - } - - - typedef struct - { - OrthancPluginImage** target; - const void* data; - uint32_t size; - OrthancPluginImageFormat format; - } _OrthancPluginUncompressImage; - - - /** - * @brief Decode a compressed image. - * - * This function decodes a compressed image from a memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param data Pointer to a memory buffer containing the compressed image. - * @param size Size of the memory buffer containing the compressed image. - * @param format The file format of the compressed image. - * @return The uncompressed image. It must be freed with OrthancPluginFreeImage(). - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage( - OrthancPluginContext* context, - const void* data, - uint32_t size, - OrthancPluginImageFormat format) - { - OrthancPluginImage* target = NULL; - - _OrthancPluginUncompressImage params; - memset(¶ms, 0, sizeof(params)); - params.target = ⌖ - params.data = data; - params.size = size; - params.format = format; - - if (context->InvokeService(context, _OrthancPluginService_UncompressImage, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return target; - } - } - - - - - typedef struct - { - OrthancPluginImage* image; - } _OrthancPluginFreeImage; - - /** - * @brief Free an image. - * - * This function frees an image that was decoded with OrthancPluginUncompressImage(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage( - OrthancPluginContext* context, - OrthancPluginImage* image) - { - _OrthancPluginFreeImage params; - params.image = image; - - context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms); - } - - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - OrthancPluginImageFormat imageFormat; - OrthancPluginPixelFormat pixelFormat; - uint32_t width; - uint32_t height; - uint32_t pitch; - const void* buffer; - uint8_t quality; - } _OrthancPluginCompressImage; - - - /** - * @brief Encode a PNG image. - * - * This function compresses the given memory buffer containing an - * image using the PNG specification, and stores the result of the - * compression into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param format The memory layout of the uncompressed image. - * @param width The width of the image. - * @param height The height of the image. - * @param pitch The pitch of the image (i.e. the number of bytes - * between 2 successive lines of the image in the memory buffer). - * @param buffer The memory buffer containing the uncompressed image. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginCompressAndAnswerPngImage() - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height, - uint32_t pitch, - const void* buffer) - { - _OrthancPluginCompressImage params; - memset(¶ms, 0, sizeof(params)); - params.target = target; - params.imageFormat = OrthancPluginImageFormat_Png; - params.pixelFormat = format; - params.width = width; - params.height = height; - params.pitch = pitch; - params.buffer = buffer; - params.quality = 0; /* Unused for PNG */ - - return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms); - } - - - /** - * @brief Encode a JPEG image. - * - * This function compresses the given memory buffer containing an - * image using the JPEG specification, and stores the result of the - * compression into a newly allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param format The memory layout of the uncompressed image. - * @param width The width of the image. - * @param height The height of the image. - * @param pitch The pitch of the image (i.e. the number of bytes - * between 2 successive lines of the image in the memory buffer). - * @param buffer The memory buffer containing the uncompressed image. - * @param quality The quality of the JPEG encoding, between 1 (worst - * quality, best compression) and 100 (best quality, worst - * compression). - * @return 0 if success, or the error code if failure. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height, - uint32_t pitch, - const void* buffer, - uint8_t quality) - { - _OrthancPluginCompressImage params; - memset(¶ms, 0, sizeof(params)); - params.target = target; - params.imageFormat = OrthancPluginImageFormat_Jpeg; - params.pixelFormat = format; - params.width = width; - params.height = height; - params.pitch = pitch; - params.buffer = buffer; - params.quality = quality; - - return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms); - } - - - - /** - * @brief Answer to a REST request with a JPEG image. - * - * This function answers to a REST request with a JPEG image. The - * parameters of this function describe a memory buffer that - * contains an uncompressed image. The image will be automatically compressed - * as a JPEG image by the core system of Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param output The HTTP connection to the client application. - * @param format The memory layout of the uncompressed image. - * @param width The width of the image. - * @param height The height of the image. - * @param pitch The pitch of the image (i.e. the number of bytes - * between 2 successive lines of the image in the memory buffer). - * @param buffer The memory buffer containing the uncompressed image. - * @param quality The quality of the JPEG encoding, between 1 (worst - * quality, best compression) and 100 (best quality, worst - * compression). - * @ingroup REST - **/ - ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage( - OrthancPluginContext* context, - OrthancPluginRestOutput* output, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height, - uint32_t pitch, - const void* buffer, - uint8_t quality) - { - _OrthancPluginCompressAndAnswerImage params; - params.output = output; - params.imageFormat = OrthancPluginImageFormat_Jpeg; - params.pixelFormat = format; - params.width = width; - params.height = height; - params.pitch = pitch; - params.buffer = buffer; - params.quality = quality; - context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms); - } - - - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - OrthancPluginHttpMethod method; - const char* url; - const char* username; - const char* password; - const char* body; - uint32_t bodySize; - } _OrthancPluginCallHttpClient; - - - /** - * @brief Issue a HTTP GET call. - * - * Make a HTTP GET call to the given URL. The result to the query is - * stored into a newly allocated memory buffer. Favor - * OrthancPluginRestApiGet() if calling the built-in REST API of the - * Orthanc instance that hosts this plugin. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param url The URL of interest. - * @param username The username (can be <tt>NULL</tt> if no password protection). - * @param password The password (can be <tt>NULL</tt> if no password protection). - * @return 0 if success, or the error code if failure. - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpGet( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* url, - const char* username, - const char* password) - { - _OrthancPluginCallHttpClient params; - memset(¶ms, 0, sizeof(params)); - - params.target = target; - params.method = OrthancPluginHttpMethod_Get; - params.url = url; - params.username = username; - params.password = password; - - return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); - } - - - /** - * @brief Issue a HTTP POST call. - * - * Make a HTTP POST call to the given URL. The result to the query - * is stored into a newly allocated memory buffer. Favor - * OrthancPluginRestApiPost() if calling the built-in REST API of - * the Orthanc instance that hosts this plugin. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param url The URL of interest. - * @param body The content of the body of the request. - * @param bodySize The size of the body of the request. - * @param username The username (can be <tt>NULL</tt> if no password protection). - * @param password The password (can be <tt>NULL</tt> if no password protection). - * @return 0 if success, or the error code if failure. - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPost( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* url, - const char* body, - uint32_t bodySize, - const char* username, - const char* password) - { - _OrthancPluginCallHttpClient params; - memset(¶ms, 0, sizeof(params)); - - params.target = target; - params.method = OrthancPluginHttpMethod_Post; - params.url = url; - params.body = body; - params.bodySize = bodySize; - params.username = username; - params.password = password; - - return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); - } - - - /** - * @brief Issue a HTTP PUT call. - * - * Make a HTTP PUT call to the given URL. The result to the query is - * stored into a newly allocated memory buffer. Favor - * OrthancPluginRestApiPut() if calling the built-in REST API of the - * Orthanc instance that hosts this plugin. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param url The URL of interest. - * @param body The content of the body of the request. - * @param bodySize The size of the body of the request. - * @param username The username (can be <tt>NULL</tt> if no password protection). - * @param password The password (can be <tt>NULL</tt> if no password protection). - * @return 0 if success, or the error code if failure. - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPut( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* url, - const char* body, - uint32_t bodySize, - const char* username, - const char* password) - { - _OrthancPluginCallHttpClient params; - memset(¶ms, 0, sizeof(params)); - - params.target = target; - params.method = OrthancPluginHttpMethod_Put; - params.url = url; - params.body = body; - params.bodySize = bodySize; - params.username = username; - params.password = password; - - return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); - } - - - /** - * @brief Issue a HTTP DELETE call. - * - * Make a HTTP DELETE call to the given URL. Favor - * OrthancPluginRestApiDelete() if calling the built-in REST API of - * the Orthanc instance that hosts this plugin. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param url The URL of interest. - * @param username The username (can be <tt>NULL</tt> if no password protection). - * @param password The password (can be <tt>NULL</tt> if no password protection). - * @return 0 if success, or the error code if failure. - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpDelete( - OrthancPluginContext* context, - const char* url, - const char* username, - const char* password) - { - _OrthancPluginCallHttpClient params; - memset(¶ms, 0, sizeof(params)); - - params.method = OrthancPluginHttpMethod_Delete; - params.url = url; - params.username = username; - params.password = password; - - return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); - } - - - - typedef struct - { - OrthancPluginImage** target; - const OrthancPluginImage* source; - OrthancPluginPixelFormat targetFormat; - } _OrthancPluginConvertPixelFormat; - - - /** - * @brief Change the pixel format of an image. - * - * This function creates a new image, changing the memory layout of the pixels. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param source The source image. - * @param targetFormat The target pixel format. - * @return The resulting image. It must be freed with OrthancPluginFreeImage(). - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginConvertPixelFormat( - OrthancPluginContext* context, - const OrthancPluginImage* source, - OrthancPluginPixelFormat targetFormat) - { - OrthancPluginImage* target = NULL; - - _OrthancPluginConvertPixelFormat params; - params.target = ⌖ - params.source = source; - params.targetFormat = targetFormat; - - if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return target; - } - } - - - - /** - * @brief Return the number of available fonts. - * - * This function returns the number of fonts that are built in the - * Orthanc core. These fonts can be used to draw texts on images - * through OrthancPluginDrawText(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @return The number of fonts. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontsCount( - OrthancPluginContext* context) - { - uint32_t count = 0; - - _OrthancPluginReturnSingleValue params; - memset(¶ms, 0, sizeof(params)); - params.resultUint32 = &count; - - if (context->InvokeService(context, _OrthancPluginService_GetFontsCount, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return 0; - } - else - { - return count; - } - } - - - - - typedef struct - { - uint32_t fontIndex; /* in */ - const char** name; /* out */ - uint32_t* size; /* out */ - } _OrthancPluginGetFontInfo; - - /** - * @brief Return the name of a font. - * - * This function returns the name of a font that is built in the Orthanc core. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount(). - * @return The font name. This is a statically-allocated string, do not free it. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetFontName( - OrthancPluginContext* context, - uint32_t fontIndex) - { - const char* result = NULL; - - _OrthancPluginGetFontInfo params; - memset(¶ms, 0, sizeof(params)); - params.name = &result; - params.fontIndex = fontIndex; - - if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Return the size of a font. - * - * This function returns the size of a font that is built in the Orthanc core. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount(). - * @return The font size. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontSize( - OrthancPluginContext* context, - uint32_t fontIndex) - { - uint32_t result; - - _OrthancPluginGetFontInfo params; - memset(¶ms, 0, sizeof(params)); - params.size = &result; - params.fontIndex = fontIndex; - - if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, ¶ms) != OrthancPluginErrorCode_Success) - { - return 0; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginImage* image; - uint32_t fontIndex; - const char* utf8Text; - int32_t x; - int32_t y; - uint8_t r; - uint8_t g; - uint8_t b; - } _OrthancPluginDrawText; - - - /** - * @brief Draw text on an image. - * - * This function draws some text on some image. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param image The image upon which to draw the text. - * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount(). - * @param utf8Text The text to be drawn, encoded as an UTF-8 zero-terminated string. - * @param x The X position of the text over the image. - * @param y The Y position of the text over the image. - * @param r The value of the red color channel of the text. - * @param g The value of the green color channel of the text. - * @param b The value of the blue color channel of the text. - * @return 0 if success, other value if error. - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDrawText( - OrthancPluginContext* context, - OrthancPluginImage* image, - uint32_t fontIndex, - const char* utf8Text, - int32_t x, - int32_t y, - uint8_t r, - uint8_t g, - uint8_t b) - { - _OrthancPluginDrawText params; - memset(¶ms, 0, sizeof(params)); - params.image = image; - params.fontIndex = fontIndex; - params.utf8Text = utf8Text; - params.x = x; - params.y = y; - params.r = r; - params.g = g; - params.b = b; - - return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms); - } - - - - typedef struct - { - OrthancPluginStorageArea* storageArea; - const char* uuid; - const void* content; - uint64_t size; - OrthancPluginContentType type; - } _OrthancPluginStorageAreaCreate; - - - /** - * @brief Create a file inside the storage area. - * - * This function creates a new file inside the storage area that is - * currently used by Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param storageArea The storage area. - * @param uuid The identifier of the file to be created. - * @param content The content to store in the newly created file. - * @param size The size of the content. - * @param type The type of the file content. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaCreate( - OrthancPluginContext* context, - OrthancPluginStorageArea* storageArea, - const char* uuid, - const void* content, - uint64_t size, - OrthancPluginContentType type) - { - _OrthancPluginStorageAreaCreate params; - params.storageArea = storageArea; - params.uuid = uuid; - params.content = content; - params.size = size; - params.type = type; - - return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms); - } - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - OrthancPluginStorageArea* storageArea; - const char* uuid; - OrthancPluginContentType type; - } _OrthancPluginStorageAreaRead; - - - /** - * @brief Read a file from the storage area. - * - * This function reads the content of a given file from the storage - * area that is currently used by Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param storageArea The storage area. - * @param uuid The identifier of the file to be read. - * @param type The type of the file content. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRead( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - OrthancPluginStorageArea* storageArea, - const char* uuid, - OrthancPluginContentType type) - { - _OrthancPluginStorageAreaRead params; - params.target = target; - params.storageArea = storageArea; - params.uuid = uuid; - params.type = type; - - return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms); - } - - - typedef struct - { - OrthancPluginStorageArea* storageArea; - const char* uuid; - OrthancPluginContentType type; - } _OrthancPluginStorageAreaRemove; - - /** - * @brief Remove a file from the storage area. - * - * This function removes a given file from the storage area that is - * currently used by Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param storageArea The storage area. - * @param uuid The identifier of the file to be removed. - * @param type The type of the file content. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRemove( - OrthancPluginContext* context, - OrthancPluginStorageArea* storageArea, - const char* uuid, - OrthancPluginContentType type) - { - _OrthancPluginStorageAreaRemove params; - params.storageArea = storageArea; - params.uuid = uuid; - params.type = type; - - return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms); - } - - - - typedef struct - { - OrthancPluginErrorCode* target; - int32_t code; - uint16_t httpStatus; - const char* message; - } _OrthancPluginRegisterErrorCode; - - /** - * @brief Declare a custom error code for this plugin. - * - * This function declares a custom error code that can be generated - * by this plugin. This declaration is used to enrich the body of - * the HTTP answer in the case of an error, and to set the proper - * HTTP status code. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param code The error code that is internal to this plugin. - * @param httpStatus The HTTP status corresponding to this error. - * @param message The description of the error. - * @return The error code that has been assigned inside the Orthanc core. - * @ingroup Toolbox - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterErrorCode( - OrthancPluginContext* context, - int32_t code, - uint16_t httpStatus, - const char* message) - { - OrthancPluginErrorCode target; - - _OrthancPluginRegisterErrorCode params; - params.target = ⌖ - params.code = code; - params.httpStatus = httpStatus; - params.message = message; - - if (context->InvokeService(context, _OrthancPluginService_RegisterErrorCode, ¶ms) == OrthancPluginErrorCode_Success) - { - return target; - } - else - { - /* There was an error while assigned the error. Use a generic code. */ - return OrthancPluginErrorCode_Plugin; - } - } - - - - typedef struct - { - uint16_t group; - uint16_t element; - OrthancPluginValueRepresentation vr; - const char* name; - uint32_t minMultiplicity; - uint32_t maxMultiplicity; - } _OrthancPluginRegisterDictionaryTag; - - /** - * @brief Register a new tag into the DICOM dictionary. - * - * This function declares a new tag in the dictionary of DICOM tags - * that are known to Orthanc. This function should be used in the - * OrthancPluginInitialize() callback. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param group The group of the tag. - * @param element The element of the tag. - * @param vr The value representation of the tag. - * @param name The nickname of the tag. - * @param minMultiplicity The minimum multiplicity of the tag (must be above 0). - * @param maxMultiplicity The maximum multiplicity of the tag. A value of 0 means - * an arbitrary multiplicity ("<tt>n</tt>"). - * @return 0 if success, other value if error. - * @ingroup Toolbox - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDictionaryTag( - OrthancPluginContext* context, - uint16_t group, - uint16_t element, - OrthancPluginValueRepresentation vr, - const char* name, - uint32_t minMultiplicity, - uint32_t maxMultiplicity) - { - _OrthancPluginRegisterDictionaryTag params; - params.group = group; - params.element = element; - params.vr = vr; - params.name = name; - params.minMultiplicity = minMultiplicity; - params.maxMultiplicity = maxMultiplicity; - - return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms); - } - - - - - typedef struct - { - OrthancPluginStorageArea* storageArea; - OrthancPluginResourceType level; - } _OrthancPluginReconstructMainDicomTags; - - /** - * @brief Reconstruct the main DICOM tags. - * - * This function requests the Orthanc core to reconstruct the main - * DICOM tags of all the resources of the given type. This function - * can only be used as a part of the upgrade of a custom database - * back-end - * (cf. OrthancPlugins::IDatabaseBackend::UpgradeDatabase). A - * database transaction will be automatically setup. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param storageArea The storage area. - * @param level The type of the resources of interest. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags( - OrthancPluginContext* context, - OrthancPluginStorageArea* storageArea, - OrthancPluginResourceType level) - { - _OrthancPluginReconstructMainDicomTags params; - params.level = level; - params.storageArea = storageArea; - - return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms); - } - - - typedef struct - { - char** result; - const char* instanceId; - const char* buffer; - uint32_t size; - OrthancPluginDicomToJsonFormat format; - OrthancPluginDicomToJsonFlags flags; - uint32_t maxStringLength; - } _OrthancPluginDicomToJson; - - - /** - * @brief Format a DICOM memory buffer as a JSON string. - * - * This function takes as input a memory buffer containing a DICOM - * file, and outputs a JSON string representing the tags of this - * DICOM file. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param buffer The memory buffer containing the DICOM file. - * @param size The size of the memory buffer. - * @param format The output format. - * @param flags Flags governing the output. - * @param maxStringLength The maximum length of a field. Too long fields will - * be output as "null". The 0 value means no maximum length. - * @return The NULL value if the case of an error, or the JSON - * string. This string must be freed by OrthancPluginFreeString(). - * @ingroup Toolbox - * @see OrthancPluginDicomInstanceToJson - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomBufferToJson( - OrthancPluginContext* context, - const char* buffer, - uint32_t size, - OrthancPluginDicomToJsonFormat format, - OrthancPluginDicomToJsonFlags flags, - uint32_t maxStringLength) - { - char* result; - - _OrthancPluginDicomToJson params; - memset(¶ms, 0, sizeof(params)); - params.result = &result; - params.buffer = buffer; - params.size = size; - params.format = format; - params.flags = flags; - params.maxStringLength = maxStringLength; - - if (context->InvokeService(context, _OrthancPluginService_DicomBufferToJson, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Format a DICOM instance as a JSON string. - * - * This function formats a DICOM instance that is stored in Orthanc, - * and outputs a JSON string representing the tags of this DICOM - * instance. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instanceId The Orthanc identifier of the instance. - * @param format The output format. - * @param flags Flags governing the output. - * @param maxStringLength The maximum length of a field. Too long fields will - * be output as "null". The 0 value means no maximum length. - * @return The NULL value if the case of an error, or the JSON - * string. This string must be freed by OrthancPluginFreeString(). - * @ingroup Toolbox - * @see OrthancPluginDicomInstanceToJson - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomInstanceToJson( - OrthancPluginContext* context, - const char* instanceId, - OrthancPluginDicomToJsonFormat format, - OrthancPluginDicomToJsonFlags flags, - uint32_t maxStringLength) - { - char* result; - - _OrthancPluginDicomToJson params; - memset(¶ms, 0, sizeof(params)); - params.result = &result; - params.instanceId = instanceId; - params.format = format; - params.flags = flags; - params.maxStringLength = maxStringLength; - - if (context->InvokeService(context, _OrthancPluginService_DicomInstanceToJson, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const char* uri; - uint32_t headersCount; - const char* const* headersKeys; - const char* const* headersValues; - int32_t afterPlugins; - } _OrthancPluginRestApiGet2; - - /** - * @brief Make a GET call to the Orthanc REST API, with custom HTTP headers. - * - * Make a GET call to the Orthanc REST API with extended - * parameters. The result to the query is stored into a newly - * allocated memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param uri The URI in the built-in Orthanc API. - * @param headersCount The number of HTTP headers. - * @param headersKeys Array containing the keys of the HTTP headers. - * @param headersValues Array containing the values of the HTTP headers. - * @param afterPlugins If 0, the built-in API of Orthanc is used. - * If 1, the API is tainted by the plugins. - * @return 0 if success, or the error code if failure. - * @see OrthancPluginRestApiGet, OrthancPluginRestApiGetAfterPlugins - * @ingroup Orthanc - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet2( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* uri, - uint32_t headersCount, - const char* const* headersKeys, - const char* const* headersValues, - int32_t afterPlugins) - { - _OrthancPluginRestApiGet2 params; - params.target = target; - params.uri = uri; - params.headersCount = headersCount; - params.headersKeys = headersKeys; - params.headersValues = headersValues; - params.afterPlugins = afterPlugins; - - return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms); - } - - - - typedef struct - { - OrthancPluginWorklistCallback callback; - } _OrthancPluginWorklistCallback; - - /** - * @brief Register a callback to handle modality worklists requests. - * - * This function registers a callback to handle C-Find SCP requests - * on modality worklists. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param callback The callback. - * @return 0 if success, other value if error. - * @ingroup Worklists - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback( - OrthancPluginContext* context, - OrthancPluginWorklistCallback callback) - { - _OrthancPluginWorklistCallback params; - params.callback = callback; - - return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms); - } - - - - typedef struct - { - OrthancPluginWorklistAnswers* answers; - const OrthancPluginWorklistQuery* query; - const void* dicom; - uint32_t size; - } _OrthancPluginWorklistAnswersOperation; - - /** - * @brief Add one answer to some modality worklist request. - * - * This function adds one worklist (encoded as a DICOM file) to the - * set of answers corresponding to some C-Find SCP request against - * modality worklists. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param answers The set of answers. - * @param query The worklist query, as received by the callback. - * @param dicom The worklist to answer, encoded as a DICOM file. - * @param size The size of the DICOM file. - * @return 0 if success, other value if error. - * @ingroup Worklists - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistAddAnswer( - OrthancPluginContext* context, - OrthancPluginWorklistAnswers* answers, - const OrthancPluginWorklistQuery* query, - const void* dicom, - uint32_t size) - { - _OrthancPluginWorklistAnswersOperation params; - params.answers = answers; - params.query = query; - params.dicom = dicom; - params.size = size; - - return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms); - } - - - /** - * @brief Mark the set of worklist answers as incomplete. - * - * This function marks as incomplete the set of answers - * corresponding to some C-Find SCP request against modality - * worklists. This must be used if canceling the handling of a - * request when too many answers are to be returned. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param answers The set of answers. - * @return 0 if success, other value if error. - * @ingroup Worklists - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete( - OrthancPluginContext* context, - OrthancPluginWorklistAnswers* answers) - { - _OrthancPluginWorklistAnswersOperation params; - params.answers = answers; - params.query = NULL; - params.dicom = NULL; - params.size = 0; - - return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms); - } - - - typedef struct - { - const OrthancPluginWorklistQuery* query; - const void* dicom; - uint32_t size; - int32_t* isMatch; - OrthancPluginMemoryBuffer* target; - } _OrthancPluginWorklistQueryOperation; - - /** - * @brief Test whether a worklist matches the query. - * - * This function checks whether one worklist (encoded as a DICOM - * file) matches the C-Find SCP query against modality - * worklists. This function must be called before adding the - * worklist as an answer through OrthancPluginWorklistAddAnswer(). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param query The worklist query, as received by the callback. - * @param dicom The worklist to answer, encoded as a DICOM file. - * @param size The size of the DICOM file. - * @return 1 if the worklist matches the query, 0 otherwise. - * @ingroup Worklists - **/ - ORTHANC_PLUGIN_INLINE int32_t OrthancPluginWorklistIsMatch( - OrthancPluginContext* context, - const OrthancPluginWorklistQuery* query, - const void* dicom, - uint32_t size) - { - int32_t isMatch = 0; - - _OrthancPluginWorklistQueryOperation params; - params.query = query; - params.dicom = dicom; - params.size = size; - params.isMatch = &isMatch; - params.target = NULL; - - if (context->InvokeService(context, _OrthancPluginService_WorklistIsMatch, ¶ms) == OrthancPluginErrorCode_Success) - { - return isMatch; - } - else - { - /* Error: Assume non-match */ - return 0; - } - } - - - /** - * @brief Retrieve the worklist query as a DICOM file. - * - * This function retrieves the DICOM file that underlies a C-Find - * SCP query against modality worklists. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target Memory buffer where to store the DICOM file. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param query The worklist query, as received by the callback. - * @return 0 if success, other value if error. - * @ingroup Worklists - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const OrthancPluginWorklistQuery* query) - { - _OrthancPluginWorklistQueryOperation params; - params.query = query; - params.dicom = NULL; - params.size = 0; - params.isMatch = NULL; - params.target = target; - - return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms); - } - - - /** - * @brief Get the origin of a DICOM file. - * - * This function returns the origin of a DICOM instance that has been received by Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param instance The instance of interest. - * @return The origin of the instance. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin( - OrthancPluginContext* context, - OrthancPluginDicomInstance* instance) - { - OrthancPluginInstanceOrigin origin; - - _OrthancPluginAccessDicomInstance params; - memset(¶ms, 0, sizeof(params)); - params.resultOrigin = &origin; - params.instance = instance; - - if (context->InvokeService(context, _OrthancPluginService_GetInstanceOrigin, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return OrthancPluginInstanceOrigin_Unknown; - } - else - { - return origin; - } - } - - - typedef struct - { - OrthancPluginMemoryBuffer* target; - const char* json; - const OrthancPluginImage* pixelData; - OrthancPluginCreateDicomFlags flags; - } _OrthancPluginCreateDicom; - - /** - * @brief Create a DICOM instance from a JSON string and an image. - * - * This function takes as input a string containing a JSON file - * describing the content of a DICOM instance. As an output, it - * writes the corresponding DICOM instance to a newly allocated - * memory buffer. Additionally, an image to be encoded within the - * DICOM instance can also be provided. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). - * @param json The input JSON file. - * @param pixelData The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme. - * @param flags Flags governing the output. - * @return 0 if success, other value if error. - * @ingroup Toolbox - * @see OrthancPluginDicomBufferToJson - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCreateDicom( - OrthancPluginContext* context, - OrthancPluginMemoryBuffer* target, - const char* json, - const OrthancPluginImage* pixelData, - OrthancPluginCreateDicomFlags flags) - { - _OrthancPluginCreateDicom params; - params.target = target; - params.json = json; - params.pixelData = pixelData; - params.flags = flags; - - return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms); - } - - - typedef struct - { - OrthancPluginDecodeImageCallback callback; - } _OrthancPluginDecodeImageCallback; - - /** - * @brief Register a callback to handle the decoding of DICOM images. - * - * This function registers a custom callback to the decoding of - * DICOM images, replacing the built-in decoder of Orthanc. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param callback The callback. - * @return 0 if success, other value if error. - * @ingroup Callbacks - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback( - OrthancPluginContext* context, - OrthancPluginDecodeImageCallback callback) - { - _OrthancPluginDecodeImageCallback params; - params.callback = callback; - - return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms); - } - - - - typedef struct - { - OrthancPluginImage** target; - OrthancPluginPixelFormat format; - uint32_t width; - uint32_t height; - uint32_t pitch; - void* buffer; - const void* constBuffer; - uint32_t bufferSize; - uint32_t frameIndex; - } _OrthancPluginCreateImage; - - - /** - * @brief Create an image. - * - * This function creates an image of given size and format. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param format The format of the pixels. - * @param width The width of the image. - * @param height The height of the image. - * @return The newly allocated image. It must be freed with OrthancPluginFreeImage(). - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginCreateImage( - OrthancPluginContext* context, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height) - { - OrthancPluginImage* target = NULL; - - _OrthancPluginCreateImage params; - memset(¶ms, 0, sizeof(params)); - params.target = ⌖ - params.format = format; - params.width = width; - params.height = height; - - if (context->InvokeService(context, _OrthancPluginService_CreateImage, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return target; - } - } - - - /** - * @brief Create an image pointing to a memory buffer. - * - * This function creates an image whose content points to a memory - * buffer managed by the plugin. Note that the buffer is directly - * accessed, no memory is allocated and no data is copied. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param format The format of the pixels. - * @param width The width of the image. - * @param height The height of the image. - * @param pitch The pitch of the image (i.e. the number of bytes - * between 2 successive lines of the image in the memory buffer). - * @param buffer The memory buffer. - * @return The newly allocated image. It must be freed with OrthancPluginFreeImage(). - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginCreateImageAccessor( - OrthancPluginContext* context, - OrthancPluginPixelFormat format, - uint32_t width, - uint32_t height, - uint32_t pitch, - void* buffer) - { - OrthancPluginImage* target = NULL; - - _OrthancPluginCreateImage params; - memset(¶ms, 0, sizeof(params)); - params.target = ⌖ - params.format = format; - params.width = width; - params.height = height; - params.pitch = pitch; - params.buffer = buffer; - - if (context->InvokeService(context, _OrthancPluginService_CreateImageAccessor, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return target; - } - } - - - - /** - * @brief Decode one frame from a DICOM instance. - * - * This function decodes one frame of a DICOM image that is stored - * in a memory buffer. This function will give the same result as - * OrthancPluginUncompressImage() for single-frame DICOM images. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param buffer Pointer to a memory buffer containing the DICOM image. - * @param bufferSize Size of the memory buffer containing the DICOM image. - * @param frameIndex The index of the frame of interest in a multi-frame image. - * @return The uncompressed image. It must be freed with OrthancPluginFreeImage(). - * @ingroup Images - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginDecodeDicomImage( - OrthancPluginContext* context, - const void* buffer, - uint32_t bufferSize, - uint32_t frameIndex) - { - OrthancPluginImage* target = NULL; - - _OrthancPluginCreateImage params; - memset(¶ms, 0, sizeof(params)); - params.target = ⌖ - params.constBuffer = buffer; - params.bufferSize = bufferSize; - params.frameIndex = frameIndex; - - if (context->InvokeService(context, _OrthancPluginService_DecodeDicomImage, ¶ms) != OrthancPluginErrorCode_Success) - { - return NULL; - } - else - { - return target; - } - } - - - - typedef struct - { - char** result; - const void* buffer; - uint32_t size; - } _OrthancPluginComputeHash; - - /** - * @brief Compute an MD5 hash. - * - * This functions computes the MD5 cryptographic hash of the given memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param buffer The source memory buffer. - * @param size The size in bytes of the source buffer. - * @return The NULL value in case of error, or a string containing the cryptographic hash. - * This string must be freed by OrthancPluginFreeString(). - * @ingroup Toolbox - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeMd5( - OrthancPluginContext* context, - const void* buffer, - uint32_t size) - { - char* result; - - _OrthancPluginComputeHash params; - params.result = &result; - params.buffer = buffer; - params.size = size; - - if (context->InvokeService(context, _OrthancPluginService_ComputeMd5, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - /** - * @brief Compute a SHA-1 hash. - * - * This functions computes the SHA-1 cryptographic hash of the given memory buffer. - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param buffer The source memory buffer. - * @param size The size in bytes of the source buffer. - * @return The NULL value in case of error, or a string containing the cryptographic hash. - * This string must be freed by OrthancPluginFreeString(). - * @ingroup Toolbox - **/ - ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeSha1( - OrthancPluginContext* context, - const void* buffer, - uint32_t size) - { - char* result; - - _OrthancPluginComputeHash params; - params.result = &result; - params.buffer = buffer; - params.size = size; - - if (context->InvokeService(context, _OrthancPluginService_ComputeSha1, ¶ms) != OrthancPluginErrorCode_Success) - { - /* Error */ - return NULL; - } - else - { - return result; - } - } - - - - typedef struct - { - OrthancPluginDictionaryEntry* target; - const char* name; - } _OrthancPluginLookupDictionary; - - /** - * @brief Get information about the given DICOM tag. - * - * This functions makes a lookup in the dictionary of DICOM tags - * that are known to Orthanc, and returns information about this - * tag. The tag can be specified using its human-readable name - * (e.g. "PatientName") or a set of two hexadecimal numbers - * (e.g. "0010-0020"). - * - * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). - * @param target Where to store the information about the tag. - * @param name The name of the DICOM tag. - * @return 0 if success, other value if error. - * @ingroup Toolbox - **/ - ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginLookupDictionary( - OrthancPluginContext* context, - OrthancPluginDictionaryEntry* target, - const char* name) - { - _OrthancPluginLookupDictionary params; - params.target = target; - params.name = name; - return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms); - } - - -#ifdef __cplusplus -} -#endif - - -/** @} */ -
--- a/Plugin/Cache/CacheIndex.h Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/Cache/CacheIndex.h Mon Apr 16 21:29:30 2018 +0200 @@ -21,7 +21,7 @@ #pragma once -#include "../../Orthanc/Core/IDynamicObject.h" +#include <Core/IDynamicObject.h> #include <string>
--- a/Plugin/Cache/CacheManager.cpp Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/Cache/CacheManager.cpp Mon Apr 16 21:29:30 2018 +0200 @@ -21,8 +21,8 @@ #include "CacheManager.h" -#include "../../Orthanc/Core/Toolbox.h" -#include "../../Orthanc/Core/SQLite/Transaction.h" +#include <Core/Toolbox.h> +#include <Core/SQLite/Transaction.h> #include <boost/lexical_cast.hpp>
--- a/Plugin/Cache/CacheManager.h Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/Cache/CacheManager.h Mon Apr 16 21:29:30 2018 +0200 @@ -21,8 +21,8 @@ #pragma once -#include "../../Orthanc/Core/SQLite/Connection.h" -#include "../../Orthanc/Core/FileStorage/FilesystemStorage.h" +#include <Core/SQLite/Connection.h> +#include <Core/FileStorage/FilesystemStorage.h> #include <orthanc/OrthancCPlugin.h>
--- a/Plugin/Cache/CacheScheduler.cpp Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/Cache/CacheScheduler.cpp Mon Apr 16 21:29:30 2018 +0200 @@ -23,7 +23,7 @@ #include "CacheIndex.h" -#include "../../Orthanc/Core/OrthancException.h" +#include <Core/OrthancException.h> #include <stdio.h> namespace OrthancPlugins
--- a/Plugin/Cache/CacheScheduler.h Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/Cache/CacheScheduler.h Mon Apr 16 21:29:30 2018 +0200 @@ -24,7 +24,7 @@ #include "CacheManager.h" #include "ICacheFactory.h" #include "IPrefetchPolicy.h" -#include "../../Orthanc/Core/MultiThreading/SharedMessageQueue.h" +#include <Core/MultiThreading/SharedMessageQueue.h> #include <boost/thread.hpp> #include <stdio.h>
--- a/Plugin/DecodedImageAdapter.cpp Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/DecodedImageAdapter.cpp Mon Apr 16 21:29:30 2018 +0200 @@ -21,14 +21,15 @@ #include "DecodedImageAdapter.h" -#include "../Orthanc/Core/Images/ImageBuffer.h" -#include "../Orthanc/Core/Images/ImageProcessing.h" -#include "../Orthanc/Core/OrthancException.h" -#include "../Orthanc/Core/Toolbox.h" -#include "../Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h" -#include "../Orthanc/Resources/ThirdParty/base64/base64.h" #include "ViewerToolbox.h" +#include <Core/Images/ImageBuffer.h> +#include <Core/Images/ImageProcessing.h> +#include <Core/OrthancException.h> +#include <Core/Toolbox.h> +#include <Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h> +#include <Resources/ThirdParty/base64/base64.h> + #include <boost/lexical_cast.hpp> #include <boost/algorithm/string/predicate.hpp> #include <json/writer.h>
--- a/Plugin/DecodedImageAdapter.h Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/DecodedImageAdapter.h Mon Apr 16 21:29:30 2018 +0200 @@ -27,7 +27,7 @@ #include <stdint.h> #include <json/value.h> -#include "../Orthanc/Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h" +#include <Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h> namespace OrthancPlugins
--- a/Plugin/Plugin.cpp Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/Plugin.cpp Mon Apr 16 21:29:30 2018 +0200 @@ -19,21 +19,22 @@ **/ +#include "ViewerToolbox.h" +#include "ViewerPrefetchPolicy.h" +#include "DecodedImageAdapter.h" +#include "SeriesInformationAdapter.h" + +#include <Core/DicomFormat/DicomMap.h> +#include <Core/OrthancException.h> +#include <Core/SystemToolbox.h> +#include <Core/Toolbox.h> +#include <Plugins/Samples/GdcmDecoder/GdcmDecoderCache.h> + #include <boost/thread.hpp> #include <boost/lexical_cast.hpp> #include <EmbeddedResources.h> #include <boost/filesystem.hpp> -#include "../Orthanc/Core/OrthancException.h" -#include "../Orthanc/Core/DicomFormat/DicomMap.h" -#include "ViewerToolbox.h" -#include "ViewerPrefetchPolicy.h" -#include "DecodedImageAdapter.h" -#include "SeriesInformationAdapter.h" -#include "../Orthanc/Plugins/Samples/GdcmDecoder/GdcmDecoderCache.h" -#include "../Orthanc/Core/Toolbox.h" -#include "../Orthanc/Core/SystemToolbox.h" - static OrthancPluginContext* context_ = NULL; static bool restrictTransferSyntaxes_ = false;
--- a/Plugin/ViewerToolbox.cpp Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/ViewerToolbox.cpp Mon Apr 16 21:29:30 2018 +0200 @@ -21,11 +21,11 @@ #include "ViewerToolbox.h" -#include "../Orthanc/Core/OrthancException.h" -#include "../Orthanc/Core/Toolbox.h" +#include <Core/OrthancException.h> +#include <Core/Toolbox.h> // Gain access to ORTHANC_PLUGINS_VERSION_IS_ABOVE if Orthanc SDK <= 1.3.0 -#include "../Orthanc/Plugins/Samples/GdcmDecoder/GdcmImageDecoder.h" +#include <Plugins/Samples/GdcmDecoder/GdcmImageDecoder.h> #include <json/reader.h> #include <stdexcept>
--- a/Plugin/ViewerToolbox.h Wed Apr 11 16:23:44 2018 +0200 +++ b/Plugin/ViewerToolbox.h Mon Apr 16 21:29:30 2018 +0200 @@ -25,7 +25,7 @@ #include <json/value.h> #include <orthanc/OrthancCPlugin.h> -#include "../Orthanc/Core/Images/ImageAccessor.h" +#include <Core/Images/ImageAccessor.h> namespace OrthancPlugins {
--- a/Resources/CMake/GdcmConfiguration.cmake Wed Apr 11 16:23:44 2018 +0200 +++ b/Resources/CMake/GdcmConfiguration.cmake Mon Apr 16 21:29:30 2018 +0200 @@ -44,7 +44,9 @@ ) if (CMAKE_TOOLCHAIN_FILE) - list(APPEND Flags -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}) + # Take absolute path to the toolchain + get_filename_component(TMP ${CMAKE_TOOLCHAIN_FILE} REALPATH BASE ${CMAKE_SOURCE_DIR}) + list(APPEND Flags -DCMAKE_TOOLCHAIN_FILE=${TMP}) endif() # Don't build manpages (since gdcm 2.8.4)
--- a/Resources/CMake/LinuxStandardBaseToolchain.cmake Wed Apr 11 16:23:44 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -# LSB_CC=gcc-4.8 LSB_CXX=g++-4.8 cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=../Resources/LinuxStandardBaseToolchain.cmake -DUSE_LEGACY_JSONCPP=ON - -INCLUDE(CMakeForceCompiler) - -SET(LSB_PATH $ENV{LSB_PATH}) -SET(LSB_CC $ENV{LSB_CC}) -SET(LSB_CXX $ENV{LSB_CXX}) -SET(LSB_TARGET_VERSION "4.0") - -IF ("${LSB_PATH}" STREQUAL "") - SET(LSB_PATH "/opt/lsb") -ENDIF() - -IF (EXISTS ${LSB_PATH}/lib64) - SET(LSB_TARGET_PROCESSOR "x86_64") - SET(LSB_LIBPATH ${LSB_PATH}/lib64-${LSB_TARGET_VERSION}) -ELSEIF (EXISTS ${LSB_PATH}/lib) - SET(LSB_TARGET_PROCESSOR "x86") - SET(LSB_LIBPATH ${LSB_PATH}/lib-${LSB_TARGET_VERSION}) -ELSE() - MESSAGE(FATAL_ERROR "Unable to detect the target processor architecture. Check the LSB_PATH environment variable.") -ENDIF() - -SET(LSB_CPPPATH ${LSB_PATH}/include) -SET(PKG_CONFIG_PATH ${LSB_LIBPATH}/pkgconfig/) - -# the name of the target operating system -SET(CMAKE_SYSTEM_NAME Linux) -SET(CMAKE_SYSTEM_VERSION LinuxStandardBase) -SET(CMAKE_SYSTEM_PROCESSOR ${LSB_TARGET_PROCESSOR}) - -# which compilers to use for C and C++ -SET(CMAKE_C_COMPILER ${LSB_PATH}/bin/lsbcc) -CMAKE_FORCE_CXX_COMPILER(${LSB_PATH}/bin/lsbc++ GNU) - -# here is the target environment located -SET(CMAKE_FIND_ROOT_PATH ${LSB_PATH}) - -# adjust the default behaviour of the FIND_XXX() commands: -# search headers and libraries in the target environment, search -# programs in the host environment -SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) -SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY NEVER) -SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE NEVER) - -SET(CMAKE_CROSSCOMPILING OFF) - - -SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -I${LSB_PATH}/include" CACHE INTERNAL "" FORCE) -SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -nostdinc++ -I${LSB_PATH}/include -I${LSB_PATH}/include/c++ -I${LSB_PATH}/include/c++/backward" CACHE INTERNAL "" FORCE) -SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -L${LSB_LIBPATH} --lsb-besteffort" CACHE INTERNAL "" FORCE) -SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --lsb-target-version=${LSB_TARGET_VERSION} -L${LSB_LIBPATH} --lsb-besteffort" CACHE INTERNAL "" FORCE) - -if (NOT "${LSB_CXX}" STREQUAL "") - SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --lsb-cxx=${LSB_CXX}") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --lsb-cxx=${LSB_CXX}") - SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --lsb-cxx=${LSB_CXX}") -endif() - -if (NOT "${LSB_CC}" STREQUAL "") - SET(CMAKE_C_FLAGS "${CMAKE_CC_FLAGS} --lsb-cc=${LSB_CC}") - SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --lsb-cc=${LSB_CC}") - SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --lsb-cc=${LSB_CC}") - SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --lsb-cc=${LSB_CC}") -endif() -
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Resources/Orthanc/README.txt Mon Apr 16 21:29:30 2018 +0200 @@ -0,0 +1,3 @@ +This folder contains an excerpt of the source code of Orthanc. It is +automatically generated using the "../Resources/SyncOrthancFolder.py" +script.
--- a/Resources/SyncOrthancFolder.py Wed Apr 11 16:23:44 2018 +0200 +++ b/Resources/SyncOrthancFolder.py Mon Apr 16 21:29:30 2018 +0200 @@ -10,98 +10,22 @@ import stat import urllib2 -TARGET = os.path.join(os.path.dirname(__file__), '..', 'Orthanc') +TARGET = os.path.join(os.path.dirname(__file__), 'Orthanc') PLUGIN_SDK_VERSION = '0.9.5' REPOSITORY = 'https://bitbucket.org/sjodogne/orthanc/raw' FILES = [ - 'NEWS', - 'Core/ChunkedBuffer.cpp', - 'Core/ChunkedBuffer.h', - 'Core/Enumerations.cpp', - 'Core/Enumerations.h', - 'Core/Endianness.h', - 'Core/DicomFormat/DicomMap.h', - 'Core/DicomFormat/DicomMap.cpp', - 'Core/DicomFormat/DicomTag.h', - 'Core/DicomFormat/DicomTag.cpp', - 'Core/DicomFormat/DicomValue.h', - 'Core/DicomFormat/DicomValue.cpp', - 'Core/FileStorage/FilesystemStorage.cpp', - 'Core/FileStorage/FilesystemStorage.h', - 'Core/FileStorage/IStorageArea.h', - 'Core/IDynamicObject.h', - 'Core/Images/ImageAccessor.cpp', - 'Core/Images/ImageAccessor.h', - 'Core/Images/ImageBuffer.cpp', - 'Core/Images/ImageBuffer.h', - 'Core/Images/ImageProcessing.cpp', - 'Core/Images/ImageProcessing.h', - 'Core/Images/PixelTraits.h', - 'Core/Logging.h', - 'Core/MultiThreading/SharedMessageQueue.cpp', - 'Core/MultiThreading/SharedMessageQueue.h', - 'Core/OrthancException.h', - 'Core/PrecompiledHeaders.cpp', - 'Core/PrecompiledHeaders.h', - 'Core/SQLite/Connection.cpp', - 'Core/SQLite/Connection.h', - 'Core/SQLite/FunctionContext.cpp', - 'Core/SQLite/FunctionContext.h', - 'Core/SQLite/IScalarFunction.h', - 'Core/SQLite/ITransaction.h', - 'Core/SQLite/NonCopyable.h', - 'Core/SQLite/OrthancSQLiteException.h', - 'Core/SQLite/SQLiteTypes.h', - 'Core/SQLite/Statement.cpp', - 'Core/SQLite/Statement.h', - 'Core/SQLite/StatementId.cpp', - 'Core/SQLite/StatementId.h', - 'Core/SQLite/StatementReference.cpp', - 'Core/SQLite/StatementReference.h', - 'Core/SQLite/Transaction.cpp', - 'Core/SQLite/Transaction.h', - 'Core/SystemToolbox.cpp', - 'Core/SystemToolbox.h', - 'Core/Toolbox.cpp', - 'Core/Toolbox.h', - 'Plugins/Samples/Common/ExportedSymbols.list', - 'Plugins/Samples/Common/VersionScript.map', - 'Plugins/Samples/GdcmDecoder/README', - 'Plugins/Samples/GdcmDecoder/GdcmImageDecoder.h', - 'Plugins/Samples/GdcmDecoder/GdcmImageDecoder.cpp', - 'Plugins/Samples/GdcmDecoder/GdcmDecoderCache.h', - 'Plugins/Samples/GdcmDecoder/GdcmDecoderCache.cpp', - 'Plugins/Samples/GdcmDecoder/OrthancImageWrapper.h', - 'Plugins/Samples/GdcmDecoder/OrthancImageWrapper.cpp', - 'Resources/CMake/AutoGeneratedCode.cmake', - 'Resources/CMake/BoostConfiguration.cmake', - 'Resources/CMake/Compiler.cmake', - 'Resources/CMake/DownloadPackage.cmake', - 'Resources/CMake/GoogleTestConfiguration.cmake', - 'Resources/CMake/JsonCppConfiguration.cmake', - 'Resources/CMake/SQLiteConfiguration.cmake', - 'Resources/CMake/UuidConfiguration.cmake', - 'Resources/Patches/boost-1.66.0-linux-standard-base.patch', - 'Resources/EmbedResources.py', - 'Resources/MinGW-W64-Toolchain32.cmake', - 'Resources/MinGW-W64-Toolchain64.cmake', - 'Resources/MinGWToolchain.cmake', - 'Resources/LinuxStandardBaseToolchain.cmake', - 'Resources/ThirdParty/VisualStudio/stdint.h', - 'Resources/ThirdParty/base64/base64.cpp', - 'Resources/ThirdParty/base64/base64.h', - 'Resources/WindowsResources.py', - 'Resources/WindowsResources.rc', + 'DownloadOrthancFramework.cmake', + 'LinuxStandardBaseToolchain.cmake', + 'MinGW-W64-Toolchain32.cmake', + 'MinGW-W64-Toolchain64.cmake', + 'MinGWToolchain.cmake', ] SDK = [ 'orthanc/OrthancCPlugin.h', -] - -EXE = [ - 'Resources/EmbedResources.py', - 'Resources/WindowsResources.py', + 'orthanc/OrthancCDatabasePlugin.h', + 'orthanc/OrthancCppDatabasePlugin.h', ] @@ -125,10 +49,12 @@ commands = [] for f in FILES: - commands.append([ 'default', f, f ]) + commands.append([ 'default', + os.path.join('Resources', f), + f ]) for f in SDK: - commands.append([ + commands.append([ 'Orthanc-%s' % PLUGIN_SDK_VERSION, 'Plugins/Include/%s' % f, 'Sdk-%s/%s' % (PLUGIN_SDK_VERSION, f) @@ -137,10 +63,3 @@ pool = multiprocessing.Pool(10) # simultaneous downloads pool.map(Download, commands) - - -for exe in EXE: - path = os.path.join(TARGET, exe) - st = os.stat(path) - os.chmod(path, st.st_mode | stat.S_IEXEC) -
--- a/UnitTestsSources/UnitTestsMain.cpp Wed Apr 11 16:23:44 2018 +0200 +++ b/UnitTestsSources/UnitTestsMain.cpp Mon Apr 16 21:29:30 2018 +0200 @@ -25,13 +25,15 @@ static int argc_; static char** argv_; -#include "../Orthanc/Core/OrthancException.h" -#include "../Orthanc/Core/SystemToolbox.h" #include "../Plugin/Cache/CacheManager.h" #include "../Plugin/Cache/CacheScheduler.h" #include "../Plugin/Cache/ICacheFactory.h" #include "../Plugin/Cache/ICacheFactory.h" +#include <Core/Logging.h> +#include <Core/OrthancException.h> +#include <Core/SystemToolbox.h> + using namespace OrthancPlugins; @@ -194,5 +196,8 @@ ::testing::InitGoogleTest(&argc, argv); + Orthanc::Logging::Initialize(); + Orthanc::Logging::EnableInfoLevel(true); + return RUN_ALL_TESTS(); }