orthanc: OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp annotate

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4883:504624b0a062

Added "/patients|studies|series|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID)

author	Alain Mazy <am@osimis.io>
date	Wed, 09 Feb 2022 13:10:11 +0100
parents	81dfdcf16e16
children	6eff25f70121

rev	line source
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1 /**
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2 * Orthanc - A Lightweight, RESTful DICOM Store
1900 b1291df2f780 2016 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1860 diff changeset	3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288 6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1281 diff changeset	4 * Department, University Hospital of Liege, Belgium
4870 43e613a7756b upgrade to year 2022 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4858 diff changeset	5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
43e613a7756b upgrade to year 2022 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4858 diff changeset	6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	7 *
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	8 * This program is free software: you can redistribute it and/or
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	9 * modify it under the terms of the GNU General Public License as
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	10 * published by the Free Software Foundation, either version 3 of the
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	11 * License, or (at your option) any later version.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	12 *
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	13 * In addition, as a special exception, the copyright holders of this
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	14 * program give permission to link the code of its release with the
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	15 * OpenSSL project's "OpenSSL" library (or with modified versions of it
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 * that use the same license as the "OpenSSL" library), and distribute
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	17 * the linked executables. You must obey the GNU General Public License
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	18 * in all respects for all of the code used other than "OpenSSL". If you
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	19 * modify file(s) with this exception, you may extend this exception to
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	20 * your version of the file(s), but you are not obligated to do so. If
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	21 * you do not wish to do so, delete this exception statement from your
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	22 * version. If you delete this exception statement from all source files
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	23 * in the program, then also delete it here.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	24 *
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	25 * This program is distributed in the hope that it will be useful, but
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	26 * WITHOUT ANY WARRANTY; without even the implied warranty of
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	28 * General Public License for more details.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	29 *
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	30 * You should have received a copy of the GNU General Public License
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	32 **/
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	33
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	34
831 84513f2ee1f3 pch for unit tests and server Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	35 #include "../PrecompiledHeadersServer.h"
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	36 #include "OrthancRestApi.h"
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	37
4045 05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	38 #include "../../../OrthancFramework/Sources/Compression/GzipCompressor.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	39 #include "../../../OrthancFramework/Sources/DicomFormat/DicomImageInformation.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	40 #include "../../../OrthancFramework/Sources/DicomParsing/DicomWebJsonVisitor.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	41 #include "../../../OrthancFramework/Sources/DicomParsing/FromDcmtkBridge.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	42 #include "../../../OrthancFramework/Sources/DicomParsing/Internals/DicomImageDecoder.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	43 #include "../../../OrthancFramework/Sources/HttpServer/HttpContentNegociation.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	44 #include "../../../OrthancFramework/Sources/Images/Image.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	45 #include "../../../OrthancFramework/Sources/Images/ImageProcessing.h"
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	46 #include "../../../OrthancFramework/Sources/Images/NumpyWriter.h"
4045 05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	47 #include "../../../OrthancFramework/Sources/Logging.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	48 #include "../../../OrthancFramework/Sources/MultiThreading/Semaphore.h"
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	49 #include "../../../OrthancFramework/Sources/SerializationToolbox.h"
4045 05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	50
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	51 #include "../OrthancConfiguration.h"
3094 61da3c9b4121 cont reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 3085 diff changeset	52 #include "../Search/DatabaseLookup.h"
1437 02f5a3f5c0a0 access to the REST API from Lua Sebastien Jodogne <s.jodogne@gmail.com> parents: 1385 diff changeset	53 #include "../ServerContext.h"
2131 bb199bccdc45 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	54 #include "../ServerToolbox.h"
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	55 #include "../SliceOrdering.h"
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	56
3687 e6d6f8d23d02 fix linking Sebastien Jodogne <s.jodogne@gmail.com> parents: 3686 diff changeset	57 // This "include" is mandatory for Release builds using Linux Standard Base
e6d6f8d23d02 fix linking Sebastien Jodogne <s.jodogne@gmail.com> parents: 3686 diff changeset	58 #include <boost/math/special_functions/round.hpp>
e6d6f8d23d02 fix linking Sebastien Jodogne <s.jodogne@gmail.com> parents: 3686 diff changeset	59
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	60
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	61 /**
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	62 * This semaphore is used to limit the number of concurrent HTTP
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	63 * requests on CPU-intensive routes of the REST API, in order to
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	64 * prevent exhaustion of resources (new in Orthanc 1.7.0).
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	65 **/
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	66 static Orthanc::Semaphore throttlingSemaphore_(4); // TODO => PARAMETER?
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	67
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	68
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	69 static const std::string CHECK_REVISIONS = "CheckRevisions";
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	70
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	71 static const char* const IGNORE_LENGTH = "ignore-length";
2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	72
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	73
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 namespace Orthanc
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 {
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	76 static std::string GetDocumentationSampleResource(ResourceType type)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	77 {
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	78 switch (type)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	79 {
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	80 case Orthanc::ResourceType_Instance:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	81 return "https://demo.orthanc-server.com/instances/d94d9a03-3003b047-a4affc69-322313b2-680530a2";
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	82 break;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	83
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	84 case Orthanc::ResourceType_Series:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	85 return "https://demo.orthanc-server.com/series/37836232-d13a2350-fa1dedc5-962b31aa-010f8e52";
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	86 break;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	87
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	88 case Orthanc::ResourceType_Study:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	89 return "https://demo.orthanc-server.com/studies/27f7126f-4f66fb14-03f4081b-f9341db2-53925988";
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	90 break;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	91
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	92 case Orthanc::ResourceType_Patient:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	93 return "https://demo.orthanc-server.com/patients/46e6332c-677825b6-202fcf7c-f787bc5f-7b07c382";
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	94 break;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	95
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	96 default:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	97 throw OrthancException(ErrorCode_ParameterOutOfRange);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	98 }
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	99 }
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	100
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	101
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	102 static void AnswerDicomAsJson(RestApiCall& call,
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	103 const Json::Value& dicom,
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	104 DicomToJsonFormat mode)
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	105 {
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	106 if (mode != DicomToJsonFormat_Full)
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	107 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	108 Json::Value simplified;
4055 9214e3a7b0a2 moving FromDcmtkTests.cpp from OrthancServer to OrthancFramework Sebastien Jodogne <s.jodogne@gmail.com> parents: 4045 diff changeset	109 Toolbox::SimplifyDicomAsJson(simplified, dicom, mode);
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	110 call.GetOutput().AnswerJson(simplified);
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	111 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	112 else
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	113 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	114 call.GetOutput().AnswerJson(dicom);
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	115 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	116 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	117
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	118
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	119 static void ParseSetOfTags(std::set<DicomTag>& target,
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	120 const RestApiGetCall& call,
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	121 const std::string& argument)
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	122 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	123 target.clear();
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	124
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	125 if (call.HasArgument(argument))
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	126 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	127 std::vector<std::string> tags;
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	128 Toolbox::TokenizeString(tags, call.GetArgument(argument, ""), ',');
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	129
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	130 for (size_t i = 0; i < tags.size(); i++)
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	131 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	132 target.insert(FromDcmtkBridge::ParseTag(tags[i]));
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	133 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	134 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	135 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	136
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	137
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	138 // List all the patients, studies, series or instances ----------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	139
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	140 static void AnswerListOfResources(RestApiOutput& output,
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	141 ServerIndex& index,
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	142 const std::list<std::string>& resources,
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	143 ResourceType level,
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	144 bool expand,
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	145 DicomToJsonFormat format)
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	146 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	147 Json::Value answer = Json::arrayValue;
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	148
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	149 for (std::list<std::string>::const_iterator
1384 d6971e18a324 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1374 diff changeset	150 resource = resources.begin(); resource != resources.end(); ++resource)
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	151 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	152 if (expand)
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	153 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	154 Json::Value expanded;
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	155 if (index.ExpandResource(expanded, *resource, level, format))
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	156 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	157 answer.append(expanded);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	158 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	159 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	160 else
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	161 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	162 answer.append(*resource);
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	163 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	164 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	165
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	166 output.AnswerJson(answer);
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	167 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	168
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	169
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	170 template <enum ResourceType resourceType>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	171 static void ListResources(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	172 {
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	173 if (call.IsDocumentation())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	174 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	175 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	176
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	177 const std::string resources = GetResourceTypeText(resourceType, true /* plural /, false / lower case */);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	178 call.GetDocumentation()
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	179 .SetTag(GetResourceTypeText(resourceType, true /* plural /, true / upper case */))
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	180 .SetSummary("List the available " + resources)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	181 .SetDescription("List the Orthanc identifiers of all the available DICOM " + resources)
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	182 .SetHttpGetArgument("limit", RestApiCallDocumentation::Type_Number, "Limit the number of results", false)
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	183 .SetHttpGetArgument("since", RestApiCallDocumentation::Type_Number, "Show only the resources since the provided index", false)
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	184 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	185 "If present, retrieve detailed information about the individual " + resources, false)
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	186 .AddAnswerType(MimeType_Json, "JSON array containing either the Orthanc identifiers, or detailed information "
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	187 "about the reported " + resources + " (if `expand` argument is provided)")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	188 .SetHttpGetSample("https://demo.orthanc-server.com/" + resources + "?since=0&limit=2", true);
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	189 return;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	190 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	191
1342 9ec7ac03152d "?expand" flag for URIs "/patients", "/studies" and "/series" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	192 ServerIndex& index = OrthancRestApi::GetIndex(call);
9ec7ac03152d "?expand" flag for URIs "/patients", "/studies" and "/series" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	193
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	194 std::list<std::string> result;
1509 0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	195
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	196 if (call.HasArgument("limit") \|\|
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	197 call.HasArgument("since"))
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	198 {
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	199 if (!call.HasArgument("limit"))
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	200 {
2955 bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	201 throw OrthancException(ErrorCode_BadRequest,
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	202 "Missing \"limit\" argument for GET request against: " +
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	203 call.FlattenUri());
1509 0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	204 }
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	205
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	206 if (!call.HasArgument("since"))
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	207 {
2955 bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	208 throw OrthancException(ErrorCode_BadRequest,
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	209 "Missing \"since\" argument for GET request against: " +
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	210 call.FlattenUri());
1509 0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	211 }
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	212
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	213 size_t since = boost::lexical_cast<size_t>(call.GetArgument("since", ""));
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	214 size_t limit = boost::lexical_cast<size_t>(call.GetArgument("limit", ""));
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	215 index.GetAllUuids(result, resourceType, since, limit);
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	216 }
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	217 else
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	218 {
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	219 index.GetAllUuids(result, resourceType);
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	220 }
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	221
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	222 AnswerListOfResources(call.GetOutput(), index, result, resourceType, call.HasArgument("expand"),
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	223 OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Human));
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	224 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	225
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	226
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	227
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	228 template <enum ResourceType resourceType>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	229 static void GetSingleResource(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	230 {
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	231 if (call.IsDocumentation())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	232 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	233 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	234
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	235 const std::string resource = GetResourceTypeText(resourceType, false /* plural /, false / lower case */);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	236 call.GetDocumentation()
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	237 .SetTag(GetResourceTypeText(resourceType, true /* plural /, true / upper case */))
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	238 .SetSummary("Get information about some " + resource)
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	239 .SetDescription("Get detailed information about the DICOM " + resource + " whose Orthanc identifier is provided in the URL")
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	240 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	241 .AddAnswerType(MimeType_Json, "Information about the DICOM " + resource)
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	242 .SetHttpGetSample(GetDocumentationSampleResource(resourceType), true);
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	243 return;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	244 }
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	245
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	246 const DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	247
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	248 Json::Value json;
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	249 if (OrthancRestApi::GetIndex(call).ExpandResource(
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	250 json, call.GetUriComponent("id", ""), resourceType, format))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	251 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	252 call.GetOutput().AnswerJson(json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	253 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	254 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	255
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	256 template <enum ResourceType resourceType>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	257 static void DeleteSingleResource(RestApiDeleteCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	258 {
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	259 if (call.IsDocumentation())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	260 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	261 const std::string resource = GetResourceTypeText(resourceType, false /* plural /, false / lower case */);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	262 call.GetDocumentation()
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	263 .SetTag(GetResourceTypeText(resourceType, true /* plural /, true / upper case */))
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	264 .SetSummary("Delete some " + resource)
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	265 .SetDescription("Delete the DICOM " + resource + " whose Orthanc identifier is provided in the URL")
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	266 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest");
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	267 return;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	268 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	269
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	270 Json::Value remainingAncestor;
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	271 if (OrthancRestApi::GetContext(call).DeleteResource(remainingAncestor, call.GetUriComponent("id", ""), resourceType))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	272 {
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	273 call.GetOutput().AnswerJson(remainingAncestor);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	274 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	275 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	276
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	277
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	278 // Get information about a single patient -----------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	279
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	280 static void IsProtectedPatient(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	281 {
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	282 if (call.IsDocumentation())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	283 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	284 call.GetDocumentation()
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	285 .SetTag("Patients")
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	286 .SetSummary("Is the patient protected against recycling?")
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	287 .SetUriArgument("id", "Orthanc identifier of the patient of interest")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	288 .AddAnswerType(MimeType_PlainText, "`1` if protected, `0` if not protected");
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	289 return;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	290 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	291
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	292 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	293 bool isProtected = OrthancRestApi::GetIndex(call).IsProtectedPatient(publicId);
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	294 call.GetOutput().AnswerBuffer(isProtected ? "1" : "0", MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	295 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	296
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	297
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	298 static void SetPatientProtection(RestApiPutCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	299 {
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	300 if (call.IsDocumentation())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	301 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	302 call.GetDocumentation()
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	303 .SetTag("Patients")
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	304 .SetSummary("Protect one patient against recycling")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	305 .SetDescription("Check out configuration options `MaximumStorageSize` and `MaximumPatientCount`")
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	306 .SetUriArgument("id", "Orthanc identifier of the patient of interest");
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	307 return;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	308 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	309
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	310 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313
4473 68f52897c119 new URIs: /tools/accepted-transfer-syntaxes and /tools/unknown-sop-class-accepted to replace Lua callbacks for transfer syntaxes Sebastien Jodogne <s.jodogne@gmail.com> parents: 4460 diff changeset	314 context.GetIndex().SetProtectedPatient(publicId, call.ParseBooleanBody());
68f52897c119 new URIs: /tools/accepted-transfer-syntaxes and /tools/unknown-sop-class-accepted to replace Lua callbacks for transfer syntaxes Sebastien Jodogne <s.jodogne@gmail.com> parents: 4460 diff changeset	315 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	316 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	317
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	318
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319 // Get information about a single instance ----------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	320
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	321 static void GetInstanceFile(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	322 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	323 if (call.IsDocumentation())
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	324 {
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	325 call.GetDocumentation()
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	326 .SetTag("Instances")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	327 .SetSummary("Download DICOM")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	328 .SetDescription("Download one DICOM instance")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	329 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	330 .SetHttpHeader("Accept", "This HTTP header can be set to retrieve the DICOM instance in DICOMweb format")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	331 .AddAnswerType(MimeType_Dicom, "The DICOM instance")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	332 .AddAnswerType(MimeType_DicomWebJson, "The DICOM instance, in DICOMweb JSON format")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	333 .AddAnswerType(MimeType_DicomWebXml, "The DICOM instance, in DICOMweb XML format");
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	334 return;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	335 }
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	336
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	337 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	339 std::string publicId = call.GetUriComponent("id", "");
3203 810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	340
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4294 diff changeset	341 HttpToolbox::Arguments::const_iterator accept = call.GetHttpHeaders().find("accept");
3203 810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	342 if (accept != call.GetHttpHeaders().end())
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	343 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	344 // New in Orthanc 1.5.4
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	345 try
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	346 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	347 MimeType mime = StringToMimeType(accept->second.c_str());
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	348
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	349 if (mime == MimeType_DicomWebJson \|\|
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	350 mime == MimeType_DicomWebXml)
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	351 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	352 DicomWebJsonVisitor visitor;
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	353
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	354 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	355 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), publicId);
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	356 locker.GetDicom().Apply(visitor);
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	357 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	358
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	359 if (mime == MimeType_DicomWebJson)
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	360 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	361 std::string s = visitor.GetResult().toStyledString();
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	362 call.GetOutput().AnswerBuffer(s, MimeType_DicomWebJson);
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	363 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	364 else
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	365 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	366 std::string xml;
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	367 visitor.FormatXml(xml);
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	368 call.GetOutput().AnswerBuffer(xml, MimeType_DicomWebXml);
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	369 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	370
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	371 return;
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	372 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	373 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	374 catch (OrthancException&)
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	375 {
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	376 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	377 }
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header Sebastien Jodogne <s.jodogne@gmail.com> parents: 3187 diff changeset	378
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	379 context.AnswerAttachment(call.GetOutput(), publicId, FileContentType_Dicom);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	380 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	381
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	382
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	383 static void ExportInstanceFile(RestApiPostCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	384 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	385 if (call.IsDocumentation())
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	386 {
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	387 call.GetDocumentation()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	388 .SetTag("Instances")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	389 .SetSummary("Write DICOM onto filesystem")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	390 .SetDescription("Write the DICOM file onto the filesystem where Orthanc is running")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	391 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	392 .AddRequestType(MimeType_PlainText, "Target path on the filesystem");
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	393 return;
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	394 }
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	395
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	396 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	397
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	398 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	399
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	400 std::string dicom;
2124 2b1520efa282 cleaning up Sebastien Jodogne <s.jodogne@gmail.com> parents: 2122 diff changeset	401 context.ReadDicom(dicom, publicId);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	402
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	403 std::string target;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	404 call.BodyToString(target);
2140 aa4b8895cd23 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 2136 diff changeset	405 SystemToolbox::WriteFile(dicom, target);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	406
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	407 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	408 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	409
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	410
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	411 template <DicomToJsonFormat format>
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	412 static void GetInstanceTagsInternal(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	413 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	414 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	415
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	416 std::string publicId = call.GetUriComponent("id", "");
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	417
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	418 std::set<DicomTag> ignoreTagLength;
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	419 ParseSetOfTags(ignoreTagLength, call, IGNORE_LENGTH);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	420
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	421 if (format != DicomToJsonFormat_Full \|\|
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	422 !ignoreTagLength.empty())
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	423 {
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	424 Json::Value full;
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	425 context.ReadDicomAsJson(full, publicId, ignoreTagLength);
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	426 AnswerDicomAsJson(call, full, format);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	427 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	428 else
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	429 {
3973 d86bddb50972 fix spelling errors according to debian Sebastien Jodogne <s.jodogne@gmail.com> parents: 3928 diff changeset	430 // This path allows one to avoid the JSON decoding if no
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	431 // simplification is asked, and if no "ignore-length" argument
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	432 // is present
4513 1f455b86b054 simplification in ServerContext Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	433 Json::Value full;
2127 bfa92c9328d7 cleaning up Sebastien Jodogne <s.jodogne@gmail.com> parents: 2124 diff changeset	434 context.ReadDicomAsJson(full, publicId);
4513 1f455b86b054 simplification in ServerContext Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	435 call.GetOutput().AnswerJson(full);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	436 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	437 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	438
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	439
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	440 static void GetInstanceTags(RestApiGetCall& call)
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	441 {
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	442 if (call.IsDocumentation())
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	443 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	444 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	445 call.GetDocumentation()
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	446 .SetTag("Instances")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	447 .SetSummary("Get DICOM tags")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	448 .SetDescription("Get the DICOM tags in the specified format. By default, the `full` format is used, which "
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	449 "combines hexadecimal tags with human-readable description.")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	450 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	451 .SetHttpGetArgument(IGNORE_LENGTH, RestApiCallDocumentation::Type_JsonListOfStrings,
2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	452 "Also include the DICOM tags that are provided in this list, even if their associated value is long", false)
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	453 .AddAnswerType(MimeType_Json, "JSON object containing the DICOM tags and their associated value")
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	454 .SetTruncatedJsonHttpGetSample("https://demo.orthanc-server.com/instances/7c92ce8e-bbf67ed2-ffa3b8c1-a3b35d94-7ff3ae26/tags", 10);
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	455 return;
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	456 }
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	457
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	458 switch (OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full))
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	459 {
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	460 case DicomToJsonFormat_Human:
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	461 GetInstanceTagsInternal<DicomToJsonFormat_Human>(call);
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	462 break;
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	463
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	464 case DicomToJsonFormat_Short:
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	465 GetInstanceTagsInternal<DicomToJsonFormat_Short>(call);
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	466 break;
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	467
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	468 case DicomToJsonFormat_Full:
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	469 GetInstanceTagsInternal<DicomToJsonFormat_Full>(call);
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	470 break;
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	471
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	472 default:
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	473 throw OrthancException(ErrorCode_InternalError);
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	474 }
cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	475 }
cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	476
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	477
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	478 static void GetInstanceSimplifiedTags(RestApiGetCall& call)
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	479 {
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	480 if (call.IsDocumentation())
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	481 {
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	482 call.GetDocumentation()
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	483 .SetTag("Instances")
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	484 .SetSummary("Get human-readable tags")
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	485 .SetDescription("Get the DICOM tags in human-readable format (same as the `/instances/{id}/tags?simplify` route)")
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	486 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	487 .SetHttpGetArgument(IGNORE_LENGTH, RestApiCallDocumentation::Type_JsonListOfStrings,
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	488 "Also include the DICOM tags that are provided in this list, even if their associated value is long", false)
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	489 .AddAnswerType(MimeType_Json, "JSON object containing the DICOM tags and their associated value")
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	490 .SetTruncatedJsonHttpGetSample("https://demo.orthanc-server.com/instances/7c92ce8e-bbf67ed2-ffa3b8c1-a3b35d94-7ff3ae26/simplified-tags", 10);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	491 return;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	492 }
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	493 else
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	494 {
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	495 GetInstanceTagsInternal<DicomToJsonFormat_Human>(call);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	496 }
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	497 }
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	498
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	499
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	500 static void ListFrames(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	501 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	502 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	503 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	504 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	505 .SetTag("Instances")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	506 .SetSummary("List available frames")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	507 .SetDescription("List the frames that are available in the DICOM instance of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	508 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	509 .AddAnswerType(MimeType_Json, "The list of the indices of the available frames")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	510 .SetHttpGetSample("https://demo.orthanc-server.com/instances/7c92ce8e-bbf67ed2-ffa3b8c1-a3b35d94-7ff3ae26/frames", true);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	511 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	512 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	513
1950 533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	514 std::string publicId = call.GetUriComponent("id", "");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	515
1950 533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	516 unsigned int numberOfFrames;
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	517
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	518 {
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	519 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), publicId);
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	520 numberOfFrames = locker.GetDicom().GetFramesCount();
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	521 }
1950 533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	522
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	523 Json::Value result = Json::arrayValue;
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	524 for (unsigned int i = 0; i < numberOfFrames; i++)
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	525 {
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	526 result.append(i);
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	527 }
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	528
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	529 call.GetOutput().AnswerJson(result);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	530 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	531
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	532
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	533 namespace
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	534 {
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	535 class ImageToEncode
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	536 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	537 private:
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	538 std::unique_ptr<ImageAccessor>& image_;
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	539 ImageExtractionMode mode_;
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	540 bool invert_;
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	541 MimeType format_;
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	542 std::string answer_;
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	543
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	544 public:
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	545 ImageToEncode(std::unique_ptr<ImageAccessor>& image,
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	546 ImageExtractionMode mode,
e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	547 bool invert) :
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	548 image_(image),
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	549 mode_(mode),
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	550 invert_(invert),
d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	551 format_(MimeType_Binary)
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	552 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	553 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	554
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	555 void Answer(RestApiOutput& output)
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	556 {
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	557 output.AnswerBuffer(answer_, format_);
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	558 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	559
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	560 void EncodeUsingPng()
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	561 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	562 format_ = MimeType_Png;
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	563 DicomImageDecoder::ExtractPngImage(answer_, image_, mode_, invert_);
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	564 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	565
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	566 void EncodeUsingPam()
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	567 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	568 format_ = MimeType_Pam;
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	569 DicomImageDecoder::ExtractPamImage(answer_, image_, mode_, invert_);
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	570 }
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	571
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	572 void EncodeUsingJpeg(uint8_t quality)
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	573 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	574 format_ = MimeType_Jpeg;
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	575 DicomImageDecoder::ExtractJpegImage(answer_, image_, mode_, invert_, quality);
1824 b530c3dfe2a6 refactoring image decoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 1784 diff changeset	576 }
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	577 };
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	578
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	579 class EncodePng : public HttpContentNegociation::IHandler
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	580 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	581 private:
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	582 ImageToEncode& image_;
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	583
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	584 public:
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	585 explicit EncodePng(ImageToEncode& image) : image_(image)
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	586 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	587 }
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	588
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	589 virtual void Handle(const std::string& type,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	590 const std::string& subtype) ORTHANC_OVERRIDE
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	591 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	592 assert(type == "image");
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	593 assert(subtype == "png");
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	594 image_.EncodeUsingPng();
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	595 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	596 };
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	597
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	598 class EncodePam : public HttpContentNegociation::IHandler
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	599 {
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	600 private:
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	601 ImageToEncode& image_;
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	602
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	603 public:
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	604 explicit EncodePam(ImageToEncode& image) : image_(image)
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	605 {
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	606 }
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	607
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	608 virtual void Handle(const std::string& type,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	609 const std::string& subtype) ORTHANC_OVERRIDE
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	610 {
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	611 assert(type == "image");
2780 d4e81e0a8324 fix am@osimis.io parents: 2726 diff changeset	612 assert(subtype == "x-portable-arbitrarymap");
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	613 image_.EncodeUsingPam();
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	614 }
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	615 };
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	616
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	617 class EncodeJpeg : public HttpContentNegociation::IHandler
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	618 {
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	619 private:
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	620 ImageToEncode& image_;
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	621 unsigned int quality_;
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	622
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	623 public:
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	624 EncodeJpeg(ImageToEncode& image,
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	625 const RestApiGetCall& call) :
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	626 image_(image)
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	627 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	628 std::string v = call.GetArgument("quality", "90" /* default JPEG quality */);
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	629 bool ok = false;
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	630
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	631 try
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	632 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	633 quality_ = boost::lexical_cast<unsigned int>(v);
1847 559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	634 ok = (quality_ >= 1 && quality_ <= 100);
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	635 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	636 catch (boost::bad_lexical_cast&)
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	637 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	638 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	639
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	640 if (!ok)
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	641 {
2955 bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	642 throw OrthancException(
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	643 ErrorCode_BadRequest,
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	644 "Bad quality for a JPEG encoding (must be a number between 0 and 100): " + v);
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	645 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	646 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	647
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	648 virtual void Handle(const std::string& type,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	649 const std::string& subtype) ORTHANC_OVERRIDE
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	650 {
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	651 assert(type == "image");
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	652 assert(subtype == "jpeg");
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	653 image_.EncodeUsingJpeg(quality_);
1784 2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	654 }
2dbf25006f88 ".../preview" and ".../image-uint8" can return JPEG images if the HTTP Accept Header asks so Sebastien Jodogne <s.jodogne@gmail.com> parents: 1781 diff changeset	655 };
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	656 }
5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	657
5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	658
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	659 namespace
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	660 {
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	661 class IDecodedFrameHandler : public boost::noncopyable
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	662 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	663 public:
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	664 virtual ~IDecodedFrameHandler()
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	665 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	666 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	667
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	668 // "dicom" is non-NULL iff. "RequiresDicomTags() == true"
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	669 virtual void Handle(RestApiGetCall& call,
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	670 std::unique_ptr<ImageAccessor>& decoded,
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	671 const ParsedDicomFile* dicom,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	672 unsigned int frame) = 0;
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	673
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	674 virtual bool RequiresDicomTags() const = 0;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	675
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	676 static void Apply(RestApiGetCall& call,
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	677 IDecodedFrameHandler& handler,
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	678 ImageExtractionMode mode /* for generation of documentation */,
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	679 bool isRendered /* for generation of documentation */)
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	680 {
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	681 if (call.IsDocumentation())
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	682 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	683 std::string m;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	684 if (!isRendered)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	685 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	686 switch (mode)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	687 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	688 case ImageExtractionMode_Preview:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	689 m = "preview";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	690 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	691 case ImageExtractionMode_UInt8:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	692 m = "uint8";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	693 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	694 case ImageExtractionMode_UInt16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	695 m = "uint16";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	696 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	697 case ImageExtractionMode_Int16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	698 m = "int16";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	699 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	700 default:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	701 throw OrthancException(ErrorCode_ParameterOutOfRange);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	702 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	703 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	704
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	705 std::string description;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	706 std::string verb = (isRendered ? "Render" : "Decode");
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	707
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	708 if (call.HasUriComponent("frame"))
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	709 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	710 description = verb + " one frame of interest from the given DICOM instance.";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	711 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	712 .SetSummary(verb + " a frame" + (m.empty() ? "" : " (" + m + ")"))
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	713 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	714 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	715 else
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	716 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	717 description = verb + " the first frame of the given DICOM instance.";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	718 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	719 .SetSummary(verb + " an image" + (m.empty() ? "" : " (" + m + ")"));
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	720 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	721
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	722 if (isRendered)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	723 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	724 description += (" This function takes scaling into account (`RescaleSlope` and `RescaleIntercept` tags), "
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	725 "as well as the default windowing stored in the DICOM file (`WindowCenter` and `WindowWidth`tags), "
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	726 "and can be used to resize the resulting image. Color images are not affected by windowing.");
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	727 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	728 .SetHttpGetArgument("window-center",RestApiCallDocumentation::Type_Number, "Windowing center", false)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	729 .SetHttpGetArgument("window-width",RestApiCallDocumentation::Type_Number, "Windowing width", false)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	730 .SetHttpGetArgument("width",RestApiCallDocumentation::Type_Number, "Width of the resized image", false)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	731 .SetHttpGetArgument("height",RestApiCallDocumentation::Type_Number, "Height of the resized image", false)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	732 .SetHttpGetArgument("smooth",RestApiCallDocumentation::Type_Boolean, "Whether to smooth image on resize", false);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	733 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	734 else
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	735 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	736 switch (mode)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	737 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	738 case ImageExtractionMode_Preview:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	739 description += " The full dynamic range of grayscale images is rescaled to the [0,255] range.";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	740 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	741 case ImageExtractionMode_UInt8:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	742 description += " Pixels of grayscale images are truncated to the [0,255] range.";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	743 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	744 case ImageExtractionMode_UInt16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	745 description += " Pixels of grayscale images are truncated to the [0,65535] range.";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	746 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	747 case ImageExtractionMode_Int16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	748 description += (" Pixels of grayscale images are truncated to the [-32768,32767] range. "
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	749 "Negative values must be interpreted according to two's complement.");
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	750 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	751 default:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	752 throw OrthancException(ErrorCode_ParameterOutOfRange);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	753 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	754 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	755
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	756 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	757 .SetTag("Instances")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	758 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	759 .SetHttpGetArgument("quality", RestApiCallDocumentation::Type_Number, "Quality for JPEG images (between 1 and 100, defaults to 90)", false)
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	760 .SetHttpGetArgument("returnUnsupportedImage", RestApiCallDocumentation::Type_Boolean, "Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false)", false)
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	761 .SetHttpHeader("Accept", "Format of the resulting image. Can be `image/png` (default), `image/jpeg` or `image/x-portable-arbitrarymap`")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	762 .AddAnswerType(MimeType_Png, "PNG image")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	763 .AddAnswerType(MimeType_Jpeg, "JPEG image")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	764 .AddAnswerType(MimeType_Pam, "PAM image (Portable Arbitrary Map)")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	765 .SetDescription(description);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	766
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	767 return;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	768 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	769
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	770 ServerContext& context = OrthancRestApi::GetContext(call);
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	771
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	772 std::string frameId = call.GetUriComponent("frame", "0");
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	773
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	774 unsigned int frame;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	775 try
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	776 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	777 frame = boost::lexical_cast<unsigned int>(frameId);
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	778 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	779 catch (boost::bad_lexical_cast&)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	780 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	781 return;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	782 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	783
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	784 std::unique_ptr<ImageAccessor> decoded;
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	785
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	786 try
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	787 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	788 std::string publicId = call.GetUriComponent("id", "");
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	789
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	790 decoded.reset(context.DecodeDicomFrame(publicId, frame));
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	791
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	792 if (decoded.get() == NULL)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	793 {
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	794 throw OrthancException(ErrorCode_NotImplemented,
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	795 "Cannot decode DICOM instance with ID: " + publicId);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	796 }
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	797
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	798 if (handler.RequiresDicomTags())
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	799 {
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	800 /**
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	801 * Retrieve a summary of the DICOM tags, which is
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	802 * necessary to deal with MONOCHROME1 photometric
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	803 * interpretation, and with windowing parameters.
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	804 **/
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	805 ServerContext::DicomCacheLocker locker(context, publicId);
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	806 handler.Handle(call, decoded, &locker.GetDicom(), frame);
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	807 }
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	808 else
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	809 {
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	810 handler.Handle(call, decoded, NULL, frame);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	811 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	812 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	813 catch (OrthancException& e)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	814 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	815 if (e.GetErrorCode() == ErrorCode_ParameterOutOfRange \|\|
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	816 e.GetErrorCode() == ErrorCode_UnknownResource)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	817 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	818 // The frame number is out of the range for this DICOM
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	819 // instance, the resource is not existent
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	820 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	821 else
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	822 {
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	823 if (call.HasArgument("returnUnsupportedImage"))
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	824 {
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	825 std::string root = "";
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	826 for (size_t i = 1; i < call.GetFullUri().size(); i++)
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	827 {
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	828 root += "../";
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	829 }
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	830
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	831 call.GetOutput().Redirect(root + "app/images/unsupported.png");
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	832 }
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	833 else
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	834 {
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	835 call.GetOutput().SignalError(HttpStatus_415_UnsupportedMediaType);
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	836 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	837 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	838 return;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	839 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	840
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	841 }
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	842
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	843
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	844 static void DefaultHandler(RestApiGetCall& call,
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	845 std::unique_ptr<ImageAccessor>& decoded,
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	846 ImageExtractionMode mode,
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	847 bool invert)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	848 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	849 ImageToEncode image(decoded, mode, invert);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	850
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	851 HttpContentNegociation negociation;
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	852 EncodePng png(image);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	853 negociation.Register(MIME_PNG, png);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	854
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	855 EncodeJpeg jpeg(image, call);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	856 negociation.Register(MIME_JPEG, jpeg);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	857
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	858 EncodePam pam(image);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	859 negociation.Register(MIME_PAM, pam);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	860
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	861 if (negociation.Apply(call.GetHttpHeaders()))
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	862 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	863 image.Answer(call.GetOutput());
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	864 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	865 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	866 };
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	867
4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	868
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	869 class GetImageHandler : public IDecodedFrameHandler
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	870 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	871 private:
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	872 ImageExtractionMode mode_;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	873
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	874 public:
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	875 explicit GetImageHandler(ImageExtractionMode mode) :
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	876 mode_(mode)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	877 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	878 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	879
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	880 virtual void Handle(RestApiGetCall& call,
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	881 std::unique_ptr<ImageAccessor>& decoded,
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	882 const ParsedDicomFile* dicom,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	883 unsigned int frame) ORTHANC_OVERRIDE
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	884 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	885 bool invert = false;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	886
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	887 if (mode_ == ImageExtractionMode_Preview)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	888 {
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	889 if (dicom == NULL)
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	890 {
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	891 throw OrthancException(ErrorCode_InternalError);
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	892 }
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	893
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	894 DicomMap tags;
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	895 OrthancConfiguration::DefaultExtractDicomSummary(tags, *dicom);
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	896
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	897 DicomImageInformation info(tags);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	898 invert = (info.GetPhotometricInterpretation() == PhotometricInterpretation_Monochrome1);
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	899 }
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	900
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	901 DefaultHandler(call, decoded, mode_, invert);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	902 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	903
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	904 virtual bool RequiresDicomTags() const ORTHANC_OVERRIDE
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	905 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	906 return mode_ == ImageExtractionMode_Preview;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	907 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	908 };
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	909
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	910
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	911 class RenderedFrameHandler : public IDecodedFrameHandler
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	912 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	913 private:
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	914 static void GetUserArguments(double& windowWidth /* inout */,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	915 double& windowCenter /* inout */,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	916 unsigned int& argWidth,
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	917 unsigned int& argHeight,
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	918 bool& smooth,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	919 const RestApiGetCall& call)
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	920 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	921 static const char* ARG_WINDOW_CENTER = "window-center";
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	922 static const char* ARG_WINDOW_WIDTH = "window-width";
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	923 static const char* ARG_WIDTH = "width";
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	924 static const char* ARG_HEIGHT = "height";
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	925 static const char* ARG_SMOOTH = "smooth";
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	926
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	927 if (call.HasArgument(ARG_WINDOW_WIDTH) &&
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	928 !SerializationToolbox::ParseDouble(windowWidth, call.GetArgument(ARG_WINDOW_WIDTH, "")))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	929 {
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	930 throw OrthancException(ErrorCode_ParameterOutOfRange,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	931 "Bad value for argument: " + std::string(ARG_WINDOW_WIDTH));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	932 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	933
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	934 if (call.HasArgument(ARG_WINDOW_CENTER) &&
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	935 !SerializationToolbox::ParseDouble(windowCenter, call.GetArgument(ARG_WINDOW_CENTER, "")))
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	936 {
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	937 throw OrthancException(ErrorCode_ParameterOutOfRange,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	938 "Bad value for argument: " + std::string(ARG_WINDOW_CENTER));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	939 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	940
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	941 argWidth = 0;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	942 argHeight = 0;
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	943
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	944 if (call.HasArgument(ARG_WIDTH))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	945 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	946 try
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	947 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	948 int tmp = boost::lexical_cast<int>(call.GetArgument(ARG_WIDTH, ""));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	949 if (tmp < 0)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	950 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	951 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	952 "Argument cannot be negative: " + std::string(ARG_WIDTH));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	953 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	954 else
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	955 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	956 argWidth = static_cast<unsigned int>(tmp);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	957 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	958 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	959 catch (boost::bad_lexical_cast&)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	960 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	961 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	962 "Bad value for argument: " + std::string(ARG_WIDTH));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	963 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	964 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	965
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	966 if (call.HasArgument(ARG_HEIGHT))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	967 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	968 try
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	969 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	970 int tmp = boost::lexical_cast<int>(call.GetArgument(ARG_HEIGHT, ""));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	971 if (tmp < 0)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	972 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	973 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	974 "Argument cannot be negative: " + std::string(ARG_HEIGHT));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	975 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	976 else
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	977 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	978 argHeight = static_cast<unsigned int>(tmp);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	979 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	980 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	981 catch (boost::bad_lexical_cast&)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	982 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	983 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	984 "Bad value for argument: " + std::string(ARG_HEIGHT));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	985 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	986 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	987
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	988 smooth = false;
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	989
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	990 if (call.HasArgument(ARG_SMOOTH))
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	991 {
4473 68f52897c119 new URIs: /tools/accepted-transfer-syntaxes and /tools/unknown-sop-class-accepted to replace Lua callbacks for transfer syntaxes Sebastien Jodogne <s.jodogne@gmail.com> parents: 4460 diff changeset	992 smooth = RestApiCall::ParseBoolean(call.GetArgument(ARG_SMOOTH, ""));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	993 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	994 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	995
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	996
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	997 public:
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	998 virtual void Handle(RestApiGetCall& call,
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	999 std::unique_ptr<ImageAccessor>& decoded,
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1000 const ParsedDicomFile* dicom,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1001 unsigned int frame) ORTHANC_OVERRIDE
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1002 {
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1003 if (dicom == NULL)
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1004 {
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1005 throw OrthancException(ErrorCode_InternalError);
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1006 }
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1007
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1008 PhotometricInterpretation photometric;
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1009 const bool invert = (dicom->LookupPhotometricInterpretation(photometric) &&
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1010 photometric == PhotometricInterpretation_Monochrome1);
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1011
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1012 double rescaleIntercept, rescaleSlope, windowCenter, windowWidth;
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1013 dicom->GetRescale(rescaleIntercept, rescaleSlope, frame);
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1014 dicom->GetDefaultWindowing(windowCenter, windowWidth, frame);
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1015
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1016 unsigned int argWidth, argHeight;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1017 bool smooth;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1018 GetUserArguments(windowWidth, windowCenter, argWidth, argHeight, smooth, call);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1019
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1020 unsigned int targetWidth = decoded->GetWidth();
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1021 unsigned int targetHeight = decoded->GetHeight();
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1022
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1023 if (decoded->GetWidth() != 0 &&
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1024 decoded->GetHeight() != 0)
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1025 {
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1026 float ratio = 1;
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1027
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1028 if (argWidth != 0 &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1029 argHeight != 0)
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1030 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1031 float ratioX = static_cast<float>(argWidth) / static_cast<float>(decoded->GetWidth());
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1032 float ratioY = static_cast<float>(argHeight) / static_cast<float>(decoded->GetHeight());
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1033 ratio = std::min(ratioX, ratioY);
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1034 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1035 else if (argWidth != 0)
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1036 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1037 ratio = static_cast<float>(argWidth) / static_cast<float>(decoded->GetWidth());
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1038 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1039 else if (argHeight != 0)
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1040 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1041 ratio = static_cast<float>(argHeight) / static_cast<float>(decoded->GetHeight());
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1042 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1043
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1044 targetWidth = boost::math::iround(ratio * static_cast<float>(decoded->GetWidth()));
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1045 targetHeight = boost::math::iround(ratio * static_cast<float>(decoded->GetHeight()));
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1046 }
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1047
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1048 if (decoded->GetFormat() == PixelFormat_RGB24)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1049 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1050 if (targetWidth == decoded->GetWidth() &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1051 targetHeight == decoded->GetHeight())
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1052 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1053 DefaultHandler(call, decoded, ImageExtractionMode_Preview, false);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1054 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1055 else
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1056 {
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	1057 std::unique_ptr<ImageAccessor> resized(
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1058 new Image(decoded->GetFormat(), targetWidth, targetHeight, false));
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1059
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1060 if (smooth &&
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1061 (targetWidth < decoded->GetWidth() \|\|
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1062 targetHeight < decoded->GetHeight()))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1063 {
4065 d6362b2c4b61 export dcmdata in shared library, rounding in convolution tests Sebastien Jodogne <s.jodogne@gmail.com> parents: 4055 diff changeset	1064 ImageProcessing::SmoothGaussian5x5(decoded, false / be fast, don't round */);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1065 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1066
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1067 ImageProcessing::Resize(resized, decoded);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1068 DefaultHandler(call, resized, ImageExtractionMode_Preview, false);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1069 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1070 }
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1071 else
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1072 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1073 // Grayscale image: (1) convert to Float32, (2) apply
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1074 // windowing to get a Grayscale8, (3) possibly resize
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1075
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1076 Image converted(PixelFormat_Float32, decoded->GetWidth(), decoded->GetHeight(), false);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1077 ImageProcessing::Convert(converted, *decoded);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1078
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1079 // Avoid divisions by zero
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1080 if (windowWidth <= 1.0f)
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1081 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1082 windowWidth = 1;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1083 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1084
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1085 if (std::abs(rescaleSlope) <= 0.0001)
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1086 {
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1087 rescaleSlope = 0.0001;
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1088 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1089
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1090 const double scaling = 255.0 * rescaleSlope / windowWidth;
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1091 const double offset = (rescaleIntercept - windowCenter + windowWidth / 2.0) / rescaleSlope;
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1092
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	1093 std::unique_ptr<ImageAccessor> rescaled(new Image(PixelFormat_Grayscale8, decoded->GetWidth(), decoded->GetHeight(), false));
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1094 ImageProcessing::ShiftScale(*rescaled, converted, static_cast<float>(offset), static_cast<float>(scaling), false);
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1095
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1096 if (targetWidth == decoded->GetWidth() &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1097 targetHeight == decoded->GetHeight())
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1098 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1099 DefaultHandler(call, rescaled, ImageExtractionMode_UInt8, invert);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1100 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1101 else
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1102 {
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	1103 std::unique_ptr<ImageAccessor> resized(
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1104 new Image(PixelFormat_Grayscale8, targetWidth, targetHeight, false));
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1105
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1106 if (smooth &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1107 (targetWidth < decoded->GetWidth() \|\|
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1108 targetHeight < decoded->GetHeight()))
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1109 {
4065 d6362b2c4b61 export dcmdata in shared library, rounding in convolution tests Sebastien Jodogne <s.jodogne@gmail.com> parents: 4055 diff changeset	1110 ImageProcessing::SmoothGaussian5x5(rescaled, false / be fast, don't round */);
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1111 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1112
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1113 ImageProcessing::Resize(resized, rescaled);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1114 DefaultHandler(call, resized, ImageExtractionMode_UInt8, invert);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1115 }
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1116 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1117 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1118
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1119 virtual bool RequiresDicomTags() const ORTHANC_OVERRIDE
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1120 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1121 return true;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1122 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1123 };
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	1124 }
4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	1125
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1126
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1127 template <enum ImageExtractionMode mode>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1128 static void GetImage(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1129 {
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1130 Semaphore::Locker locker(throttlingSemaphore_);
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1131
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1132 GetImageHandler handler(mode);
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	1133 IDecodedFrameHandler::Apply(call, handler, mode, false /* not rendered */);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1134 }
1906 d7c1cb559431 optimization for multi-frame images Sebastien Jodogne <s.jodogne@gmail.com> parents: 1902 diff changeset	1135
1826 ac5b0b4e2434 refactoring of DicomImageDecoder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1824 diff changeset	1136
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1137 static void GetRenderedFrame(RestApiGetCall& call)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1138 {
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1139 Semaphore::Locker locker(throttlingSemaphore_);
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1140
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1141 RenderedFrameHandler handler;
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	1142 IDecodedFrameHandler::Apply(call, handler, ImageExtractionMode_Preview /* arbitrary value */, true);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1143 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1144
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1145
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1146 static void DocumentSharedNumpy(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1147 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1148 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1149 .SetUriArgument("id", "Orthanc identifier of the DICOM resource of interest")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1150 .SetHttpGetArgument("compress", RestApiCallDocumentation::Type_Boolean, "Compress the file as `.npz`", false)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1151 .SetHttpGetArgument("rescale", RestApiCallDocumentation::Type_Boolean,
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1152 "On grayscale images, apply the rescaling and return floating-point values", false)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1153 .AddAnswerType(MimeType_PlainText, "Numpy file: https://numpy.org/devdocs/reference/generated/numpy.lib.format.html");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1154 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1155
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1156
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1157 namespace
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1158 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1159 class NumpyVisitor : public boost::noncopyable
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1160 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1161 private:
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1162 bool rescale_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1163 unsigned int depth_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1164 unsigned int currentDepth_;
4858 8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1165 unsigned int width_;
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1166 unsigned int height_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1167 PixelFormat format_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1168 ChunkedBuffer buffer_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1169
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1170 public:
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1171 NumpyVisitor(unsigned int depth /* can be zero if 2D frame */,
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1172 bool rescale) :
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1173 rescale_(rescale),
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1174 depth_(depth),
4858 8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1175 currentDepth_(0),
8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1176 width_(0), // dummy initialization
8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1177 height_(0), // dummy initialization
8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1178 format_(PixelFormat_Grayscale8) // dummy initialization
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1179 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1180 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1181
4858 8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1182 void WriteFrame(const ParsedDicomFile& dicom,
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1183 unsigned int frame)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1184 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1185 std::unique_ptr<ImageAccessor> decoded(dicom.DecodeFrame(frame));
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1186
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1187 if (decoded.get() == NULL)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1188 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1189 throw OrthancException(ErrorCode_NotImplemented, "Cannot decode DICOM instance");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1190 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1191
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1192 if (currentDepth_ == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1193 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1194 width_ = decoded->GetWidth();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1195 height_ = decoded->GetHeight();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1196 format_ = decoded->GetFormat();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1197 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1198 else if (width_ != decoded->GetWidth() \|\|
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1199 height_ != decoded->GetHeight())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1200 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1201 throw OrthancException(ErrorCode_IncompatibleImageSize, "The size of the frames varies across the instance(s)");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1202 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1203 else if (format_ != decoded->GetFormat())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1204 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1205 throw OrthancException(ErrorCode_IncompatibleImageFormat, "The pixel format of the frames varies across the instance(s)");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1206 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1207
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1208 if (rescale_ &&
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1209 decoded->GetFormat() != PixelFormat_RGB24)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1210 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1211 if (currentDepth_ == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1212 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1213 NumpyWriter::WriteHeader(buffer_, depth_, width_, height_, PixelFormat_Float32);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1214 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1215
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1216 double rescaleIntercept, rescaleSlope;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1217 dicom.GetRescale(rescaleIntercept, rescaleSlope, frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1218
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1219 Image converted(PixelFormat_Float32, decoded->GetWidth(), decoded->GetHeight(), false);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1220 ImageProcessing::Convert(converted, *decoded);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1221 ImageProcessing::ShiftScale2(converted, static_cast<float>(rescaleIntercept), static_cast<float>(rescaleSlope), false);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1222
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1223 NumpyWriter::WritePixels(buffer_, converted);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1224 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1225 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1226 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1227 if (currentDepth_ == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1228 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1229 NumpyWriter::WriteHeader(buffer_, depth_, width_, height_, format_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1230 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1231
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1232 NumpyWriter::WritePixels(buffer_, *decoded);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1233 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1234
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1235 currentDepth_ ++;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1236 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1237
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1238 void Answer(RestApiOutput& output,
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1239 bool compress)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1240 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1241 if ((depth_ == 0 && currentDepth_ != 1) \|\|
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1242 (depth_ != 0 && currentDepth_ != depth_))
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1243 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1244 throw OrthancException(ErrorCode_BadSequenceOfCalls);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1245 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1246 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1247 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1248 std::string answer;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1249 NumpyWriter::Finalize(answer, buffer_, compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1250 output.AnswerBuffer(answer, MimeType_Binary);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1251 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1252 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1253 };
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1254 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1255
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1256
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1257 static void GetNumpyFrame(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1258 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1259 if (call.IsDocumentation())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1260 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1261 DocumentSharedNumpy(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1262 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1263 .SetTag("Instances")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1264 .SetSummary("Decode frame for numpy")
4836 ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1265 .SetDescription("Decode one frame of interest from the given DICOM instance, for use with numpy in Python. "
ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1266 "The numpy array has 3 dimensions: (height, width, color channel).")
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1267 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1268 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1269 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1270 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1271 const std::string instanceId = call.GetUriComponent("id", "");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1272 const bool compress = call.GetBooleanArgument("compress", false);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1273 const bool rescale = call.GetBooleanArgument("rescale", true);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1274
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1275 uint32_t frame;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1276 if (!SerializationToolbox::ParseUnsignedInteger32(frame, call.GetUriComponent("frame", "0")))
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1277 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1278 throw OrthancException(ErrorCode_ParameterOutOfRange, "Expected an unsigned integer for the \"frame\" argument");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1279 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1280
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1281 NumpyVisitor visitor(0 /* no depth, 2D frame */, rescale);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1282
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1283 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1284 Semaphore::Locker throttling(throttlingSemaphore_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1285 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), instanceId);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1286
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1287 visitor.WriteFrame(locker.GetDicom(), frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1288 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1289
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1290 visitor.Answer(call.GetOutput(), compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1291 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1292 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1293
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1294
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1295 static void GetNumpyInstance(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1296 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1297 if (call.IsDocumentation())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1298 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1299 DocumentSharedNumpy(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1300 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1301 .SetTag("Instances")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1302 .SetSummary("Decode instance for numpy")
4836 ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1303 .SetDescription("Decode the given DICOM instance, for use with numpy in Python. "
ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1304 "The numpy array has 4 dimensions: (frame, height, width, color channel).");
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1305 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1306 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1307 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1308 const std::string instanceId = call.GetUriComponent("id", "");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1309 const bool compress = call.GetBooleanArgument("compress", false);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1310 const bool rescale = call.GetBooleanArgument("rescale", true);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1311
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1312 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1313 Semaphore::Locker throttling(throttlingSemaphore_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1314 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), instanceId);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1315
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1316 const unsigned int depth = locker.GetDicom().GetFramesCount();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1317 if (depth == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1318 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1319 throw OrthancException(ErrorCode_BadFileFormat, "Empty DICOM instance");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1320 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1321
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1322 NumpyVisitor visitor(depth, rescale);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1323
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1324 for (unsigned int frame = 0; frame < depth; frame++)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1325 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1326 visitor.WriteFrame(locker.GetDicom(), frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1327 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1328
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1329 visitor.Answer(call.GetOutput(), compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1330 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1331 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1332 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1333
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1334
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1335 static void GetNumpySeries(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1336 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1337 if (call.IsDocumentation())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1338 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1339 DocumentSharedNumpy(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1340 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1341 .SetTag("Series")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1342 .SetSummary("Decode series for numpy")
4836 ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1343 .SetDescription("Decode the given DICOM series, for use with numpy in Python. "
ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1344 "The numpy array has 4 dimensions: (frame, height, width, color channel).");
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1345 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1346 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1347 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1348 const std::string seriesId = call.GetUriComponent("id", "");
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1349 const bool compress = call.GetBooleanArgument("compress", false);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1350 const bool rescale = call.GetBooleanArgument("rescale", true);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1351
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1352 Semaphore::Locker throttling(throttlingSemaphore_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1353
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1354 ServerIndex& index = OrthancRestApi::GetIndex(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1355 SliceOrdering ordering(index, seriesId);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1356
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1357 unsigned int depth = 0;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1358 for (size_t i = 0; i < ordering.GetInstancesCount(); i++)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1359 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1360 depth += ordering.GetFramesCount(i);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1361 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1362
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1363 ServerContext& context = OrthancRestApi::GetContext(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1364
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1365 NumpyVisitor visitor(depth, rescale);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1366
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1367 for (size_t i = 0; i < ordering.GetInstancesCount(); i++)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1368 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1369 const std::string& instanceId = ordering.GetInstanceId(i);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1370 unsigned int framesCount = ordering.GetFramesCount(i);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1371
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1372 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1373 ServerContext::DicomCacheLocker locker(context, instanceId);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1374
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1375 for (unsigned int frame = 0; frame < framesCount; frame++)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1376 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1377 visitor.WriteFrame(locker.GetDicom(), frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1378 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1379 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1380 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1381
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1382 visitor.Answer(call.GetOutput(), compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1383 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1384 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1385
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1386
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1387 static void GetMatlabImage(RestApiGetCall& call)
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1388 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1389 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1390 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1391 std::string description;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1392
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1393 if (call.HasUriComponent("frame"))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1394 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1395 description = "Decode one frame of interest from the given DICOM instance";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1396 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1397 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1398 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1399 else
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1400 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1401 description = "Decode the first frame of the given DICOM instance.";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1402 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1403
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1404 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1405 .SetTag("Instances")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1406 .SetSummary("Decode frame for Matlab")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1407 .SetDescription(description + ", and export this frame as a Octave/Matlab matrix to be imported with `eval()`: "
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1408 "https://book.orthanc-server.com/faq/matlab.html")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1409 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1410 .AddAnswerType(MimeType_PlainText, "Octave/Matlab matrix");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1411 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1412 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1413
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1414 Semaphore::Locker locker(throttlingSemaphore_);
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1415
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1416 ServerContext& context = OrthancRestApi::GetContext(call);
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1417
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1418 std::string frameId = call.GetUriComponent("frame", "0");
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1419
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1420 unsigned int frame;
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1421 try
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1422 {
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1423 frame = boost::lexical_cast<unsigned int>(frameId);
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1424 }
2836 7133ad478eea fix Debian warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2804 diff changeset	1425 catch (boost::bad_lexical_cast&)
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1426 {
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1427 return;
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1428 }
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1429
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1430 std::string publicId = call.GetUriComponent("id", "");
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1431 std::unique_ptr<ImageAccessor> decoded(context.DecodeDicomFrame(publicId, frame));
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1432
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1433 if (decoded.get() == NULL)
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1434 {
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1435 throw OrthancException(ErrorCode_NotImplemented,
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1436 "Cannot decode DICOM instance with ID: " + publicId);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1437 }
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1438 else
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1439 {
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1440 std::string result;
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1441 decoded->ToMatlabString(result);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1442 call.GetOutput().AnswerBuffer(result, MimeType_PlainText);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1443 }
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1444 }
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1445
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1446
2408 26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1447 template <bool GzipCompression>
1924 6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1448 static void GetRawFrame(RestApiGetCall& call)
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1449 {
4408 d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1450 if (call.IsDocumentation())
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1451 {
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1452 call.GetDocumentation()
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1453 .SetTag("Instances")
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1454 .SetSummary("Access raw frame" + std::string(GzipCompression ? " (compressed)" : ""))
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1455 .SetDescription("Access the raw content of one individual frame of the DICOM instance of interest, "
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1456 "bypassing image decoding. This is notably useful to access the source files "
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1457 "in compressed transfer syntaxes." +
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1458 std::string(GzipCompression ? " The image is compressed using gzip" : ""))
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4422 diff changeset	1459 .SetUriArgument("id", "Orthanc identifier of the instance of interest")
4408 d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1460 .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1461
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1462 if (GzipCompression)
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1463 {
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1464 call.GetDocumentation().AddAnswerType(MimeType_Gzip, "The raw frame, compressed using gzip");
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1465 }
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1466 else
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1467 {
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1468 call.GetDocumentation().AddAnswerType(MimeType_Binary, "The raw frame");
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1469 }
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1470 return;
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1471 }
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1472
1924 6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1473 std::string frameId = call.GetUriComponent("frame", "0");
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1474
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1475 unsigned int frame;
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1476 try
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1477 {
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1478 frame = boost::lexical_cast<unsigned int>(frameId);
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1479 }
2836 7133ad478eea fix Debian warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2804 diff changeset	1480 catch (boost::bad_lexical_cast&)
1924 6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1481 {
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1482 return;
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1483 }
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1484
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1485 std::string publicId = call.GetUriComponent("id", "");
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	1486 std::string raw;
9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	1487 MimeType mime;
1924 6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1488
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1489 {
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1490 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), publicId);
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1491 locker.GetDicom().GetRawFrame(raw, mime, frame);
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1492 }
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1493
2408 26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1494 if (GzipCompression)
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1495 {
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1496 GzipCompressor gzip;
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1497 std::string compressed;
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1498 gzip.Compress(compressed, raw.empty() ? NULL : raw.c_str(), raw.size());
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	1499 call.GetOutput().AnswerBuffer(compressed, MimeType_Gzip);
2408 26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1500 }
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1501 else
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1502 {
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1503 call.GetOutput().AnswerBuffer(raw, mime);
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1504 }
1924 6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1505 }
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1506
6c73df12ca51 New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1906 diff changeset	1507
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1508 static void GetResourceStatistics(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1509 {
4418 9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1510 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1511 {
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1512 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1513 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1514 call.GetDocumentation()
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1515 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1516 .SetSummary("Get " + r + " statistics")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1517 .SetDescription("Get statistics about the given " + r)
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1518 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1519 .SetAnswerField("DiskSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1520 "Size of the " + r + " on the disk in bytes, expressed as a string for 64bit compatibility with JSON")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1521 .SetAnswerField("DiskSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1522 "Size of the " + r + " on the disk, expressed in megabytes (MB)")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1523 .SetAnswerField("UncompressedSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1524 "Size of the " + r + " after decompression in bytes, expressed as a string for 64bit compatibility with JSON")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1525 .SetAnswerField("UncompressedSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1526 "Size of the " + r + " after decompression, expressed in megabytes (MB). "
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1527 "This is different from `DiskSizeMB` iff `StorageCompression` is `true`.")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1528 .SetAnswerField("DicomDiskSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1529 "Size on the disk of the DICOM instances associated with the " + r + ", expressed in bytes")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1530 .SetAnswerField("DicomDiskSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1531 "Size on the disk of the DICOM instances associated with the " + r + ", expressed in megabytes (MB)")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1532 .SetAnswerField("DicomUncompressedSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1533 "Size on the disk of the uncompressed DICOM instances associated with the " + r + ", expressed in bytes")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1534 .SetAnswerField("DicomUncompressedSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1535 "Size on the disk of the uncompressed DICOM instances associated with the " + r + ", expressed in megabytes (MB)")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1536 .SetHttpGetSample(GetDocumentationSampleResource(t) + "/statistics", true);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1537
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1538 switch (t)
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1539 {
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1540 // Do NOT add "break" below this point!
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1541 case ResourceType_Patient:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1542 call.GetDocumentation().SetAnswerField("CountStudies", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1543 "Number of child studies within this " + r);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1544
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1545 case ResourceType_Study:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1546 call.GetDocumentation().SetAnswerField("CountSeries", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1547 "Number of child series within this " + r);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1548
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1549 case ResourceType_Series:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1550 call.GetDocumentation().SetAnswerField("CountInstances", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1551 "Number of child instances within this " + r);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1552
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1553 case ResourceType_Instance:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1554 default:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1555 break;
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1556 }
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1557
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1558 return;
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1559 }
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1560
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1561 static const uint64_t MEGA_BYTES = 1024 * 1024;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1562
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1563 std::string publicId = call.GetUriComponent("id", "");
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1564
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1565 ResourceType type;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1566 uint64_t diskSize, uncompressedSize, dicomDiskSize, dicomUncompressedSize;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1567 unsigned int countStudies, countSeries, countInstances;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1568 OrthancRestApi::GetIndex(call).GetResourceStatistics(
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1569 type, diskSize, uncompressedSize, countStudies, countSeries,
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1570 countInstances, dicomDiskSize, dicomUncompressedSize, publicId);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1571
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1572 Json::Value result = Json::objectValue;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1573 result["DiskSize"] = boost::lexical_cast<std::string>(diskSize);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1574 result["DiskSizeMB"] = static_cast<unsigned int>(diskSize / MEGA_BYTES);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1575 result["UncompressedSize"] = boost::lexical_cast<std::string>(uncompressedSize);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1576 result["UncompressedSizeMB"] = static_cast<unsigned int>(uncompressedSize / MEGA_BYTES);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1577
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1578 result["DicomDiskSize"] = boost::lexical_cast<std::string>(dicomDiskSize);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1579 result["DicomDiskSizeMB"] = static_cast<unsigned int>(dicomDiskSize / MEGA_BYTES);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1580 result["DicomUncompressedSize"] = boost::lexical_cast<std::string>(dicomUncompressedSize);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1581 result["DicomUncompressedSizeMB"] = static_cast<unsigned int>(dicomUncompressedSize / MEGA_BYTES);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1582
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1583 switch (type)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1584 {
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1585 // Do NOT add "break" below this point!
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1586 case ResourceType_Patient:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1587 result["CountStudies"] = countStudies;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1588
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1589 case ResourceType_Study:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1590 result["CountSeries"] = countSeries;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1591
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1592 case ResourceType_Series:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1593 result["CountInstances"] = countInstances;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1594
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1595 case ResourceType_Instance:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1596 default:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1597 break;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1598 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1599
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1600 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1601 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1602
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1603
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1604
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1605 // Handling of metadata -----------------------------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1606
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	1607 static void CheckValidResourceType(const RestApiCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1608 {
4460 6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1609 assert(!call.GetFullUri().empty());
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1610 const std::string resourceType = call.GetFullUri() [0];
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1611 StringToResourceType(resourceType.c_str());
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1612 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1613
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1614
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1615 static void ListMetadata(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1616 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1617 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1618 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1619 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1620 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1621 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1622 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1623 .SetSummary("List metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1624 .SetDescription("Get the list of metadata that are associated with the given " + r)
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1625 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1626 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1627 "If present, also retrieve the value of the individual metadata", false)
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1628 .AddAnswerType(MimeType_Json, "JSON array containing the names of the available metadata, "
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1629 "or JSON associative array mapping metadata to their values (if `expand` argument is provided)")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1630 .SetHttpGetSample(GetDocumentationSampleResource(t) + "/metadata", true);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1631 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1632 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1633
4460 6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1634 assert(!call.GetFullUri().empty());
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	1635 const std::string publicId = call.GetUriComponent("id", "");
efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	1636 ResourceType level = StringToResourceType(call.GetFullUri() [0].c_str());
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1637
350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1638 typedef std::map<MetadataType, std::string> Metadata;
350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1639
350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1640 Metadata metadata;
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	1641 OrthancRestApi::GetIndex(call).GetAllMetadata(metadata, publicId, level);
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1642
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1643 Json::Value result;
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1644
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1645 if (call.HasArgument("expand"))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1646 {
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1647 result = Json::objectValue;
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1648
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1649 for (Metadata::const_iterator it = metadata.begin(); it != metadata.end(); ++it)
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1650 {
3187 4bbadcd03966 refactoring retrieval of metadata from database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	1651 std::string key = EnumerationToString(it->first);
4bbadcd03966 refactoring retrieval of metadata from database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	1652 result[key] = it->second;
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1653 }
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1654 }
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1655 else
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1656 {
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1657 result = Json::arrayValue;
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1658
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1659 for (Metadata::const_iterator it = metadata.begin(); it != metadata.end(); ++it)
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1660 {
3187 4bbadcd03966 refactoring retrieval of metadata from database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	1661 result.append(EnumerationToString(it->first));
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1662 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1663 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1664
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1665 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1666 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1667
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1668
4657 e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1669 static void SetStringContentETag(const RestApiOutput& output,
e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1670 int64_t revision,
e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1671 const std::string& value)
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1672 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1673 std::string md5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1674 Toolbox::ComputeMD5(md5, value);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1675 const std::string etag = "\"" + boost::lexical_cast<std::string>(revision) + "-" + md5 + "\"";
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1676 output.GetLowLevelOutput().AddHeader("ETag", etag);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1677 }
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1678
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1679
4657 e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1680 static void SetBufferContentETag(const RestApiOutput& output,
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1681 int64_t revision,
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1682 const void* data,
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1683 size_t size)
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1684 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1685 std::string md5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1686 Toolbox::ComputeMD5(md5, data, size);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1687 const std::string etag = "\"" + boost::lexical_cast<std::string>(revision) + "-" + md5 + "\"";
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1688 output.GetLowLevelOutput().AddHeader("ETag", etag);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1689 }
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1690
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1691
4657 e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1692 static void SetAttachmentETag(const RestApiOutput& output,
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1693 int64_t revision,
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1694 const FileInfo& info)
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1695 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1696 const std::string etag = ("\"" + boost::lexical_cast<std::string>(revision) + "-" +
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1697 info.GetUncompressedMD5() + "\"");
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1698 output.GetLowLevelOutput().AddHeader("ETag", etag);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1699 }
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1700
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1701
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1702 static std::string GetMD5(const std::string& value)
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1703 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1704 std::string md5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1705 Toolbox::ComputeMD5(md5, value);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1706 return md5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1707 }
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1708
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1709
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1710 static bool GetRevisionHeader(int64_t& revision /* out */,
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1711 std::string& md5 /* out */,
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1712 const RestApiCall& call,
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1713 const std::string& header)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1714 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1715 std::string lower;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1716 Toolbox::ToLowerCase(lower, header);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1717
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1718 HttpToolbox::Arguments::const_iterator found = call.GetHttpHeaders().find(lower);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1719 if (found == call.GetHttpHeaders().end())
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1720 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1721 return false;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1722 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1723 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1724 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1725 std::string value = Toolbox::StripSpaces(found->second);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1726 Toolbox::RemoveSurroundingQuotes(value);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1727
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1728 try
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1729 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1730 size_t comma = value.find('-');
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1731 if (comma != std::string::npos)
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1732 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1733 revision = boost::lexical_cast<int64_t>(value.substr(0, comma));
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1734 md5 = value.substr(comma + 1);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1735 return true;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1736 }
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1737 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1738 catch (boost::bad_lexical_cast&)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1739 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1740 }
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1741
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1742 throw OrthancException(ErrorCode_ParameterOutOfRange, "The \"" + header +
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1743 "\" HTTP header should contain the ETag (revision followed by MD5 hash), but found: " + value);
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1744 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1745 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1746
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1747
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1748 static void GetMetadata(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1749 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1750 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1751 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1752 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1753 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1754 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1755 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1756 .SetSummary("Get metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1757 .SetDescription("Get the value of a metadata that is associated with the given " + r)
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1758 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1759 .SetUriArgument("name", "The name of the metadata, or its index (cf. `UserMetadata` configuration option)")
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1760 .AddAnswerType(MimeType_PlainText, "Value of the metadata")
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1761 .SetAnswerHeader("ETag", "Revision of the metadata, to be used in further `PUT` or `DELETE` operations")
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1762 .SetHttpHeader("If-None-Match", "Optional revision of the metadata, to check if its content has changed");
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1763 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1764 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1765
4460 6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1766 assert(!call.GetFullUri().empty());
6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1767 const std::string publicId = call.GetUriComponent("id", "");
6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1768 const ResourceType level = StringToResourceType(call.GetFullUri() [0].c_str());
6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1769
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1770 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1771 MetadataType metadata = StringToMetadata(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1772
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1773 std::string value;
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1774 int64_t revision;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1775 if (OrthancRestApi::GetIndex(call).LookupMetadata(value, revision, publicId, level, metadata))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1776 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1777 SetStringContentETag(call.GetOutput(), revision, value); // New in Orthanc 1.9.2
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1778
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1779 int64_t userRevision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1780 std::string userMD5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1781 if (GetRevisionHeader(userRevision, userMD5, call, "If-None-Match") &&
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1782 userRevision == revision &&
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1783 userMD5 == GetMD5(value))
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1784 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1785 call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1786 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1787 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1788 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1789 call.GetOutput().AnswerBuffer(value, MimeType_PlainText);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1790 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1791 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1792 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1793
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1794
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1795 static void DeleteMetadata(RestApiDeleteCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1796 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1797 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1798 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1799 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1800 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1801 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1802 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1803 .SetSummary("Delete metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1804 .SetDescription("Delete some metadata associated with the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1805 ". This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1806 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1807 .SetUriArgument("name", "The name of the metadata, or its index (cf. `UserMetadata` configuration option)")
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1808 .SetHttpHeader("If-Match", "Revision of the metadata, to check if its content has not changed and can "
4661 b1d87d41874e typo: replaced "CheckRevision" by "CheckRevisions" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4657 diff changeset	1809 "be deleted. This header is mandatory if `CheckRevisions` option is `true`.");
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1810 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1811 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1812
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1813 CheckValidResourceType(call);
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1814 const std::string publicId = call.GetUriComponent("id", "");
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1815
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1816 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1817 MetadataType metadata = StringToMetadata(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1818
1773 613df4362575 New UpdatedAttachment and UpdatedMetadata events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1759 diff changeset	1819 if (IsUserMetadata(metadata)) // It is forbidden to modify internal metadata
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1820 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1821 bool found;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1822 int64_t revision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1823 std::string md5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1824 if (GetRevisionHeader(revision, md5, call, "if-match"))
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1825 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1826 found = OrthancRestApi::GetIndex(call).DeleteMetadata(publicId, metadata, true, revision, md5);
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1827 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1828 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1829 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1830 OrthancConfiguration::ReaderLock lock;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1831 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1832 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1833 throw OrthancException(ErrorCode_Revision,
4661 b1d87d41874e typo: replaced "CheckRevision" by "CheckRevisions" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4657 diff changeset	1834 "HTTP header \"If-Match\" is missing, as \"CheckRevisions\" is \"true\"");
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1835 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1836 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1837 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1838 found = OrthancRestApi::GetIndex(call).DeleteMetadata(publicId, metadata, false, -1 /* dummy value */, "");
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1839 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1840 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1841
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1842 if (found)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1843 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1844 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1845 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1846 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1847 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1848 throw OrthancException(ErrorCode_UnknownResource);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1849 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1850 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1851 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1852 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1853 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1854 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1855 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1856
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1857
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1858 static void SetMetadata(RestApiPutCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1859 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1860 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1861 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1862 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1863 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1864 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1865 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1866 .SetSummary("Set metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1867 .SetDescription("Set the value of some metadata in the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1868 ". This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1869 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1870 .SetUriArgument("name", "The name of the metadata, or its index (cf. `UserMetadata` configuration option)")
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1871 .AddRequestType(MimeType_PlainText, "String value of the metadata")
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1872 .SetHttpHeader("If-Match", "Revision of the metadata, if this is not the first time this metadata is set.");
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1873 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1874 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1875
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1876 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1877
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1878 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1879 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1880 MetadataType metadata = StringToMetadata(name);
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	1881
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	1882 std::string value;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	1883 call.BodyToString(value);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1884
1773 613df4362575 New UpdatedAttachment and UpdatedMetadata events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1759 diff changeset	1885 if (IsUserMetadata(metadata)) // It is forbidden to modify internal metadata
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1886 {
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1887 int64_t oldRevision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1888 std::string oldMD5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1889 bool hasOldRevision = GetRevisionHeader(oldRevision, oldMD5, call, "if-match");
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1890
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1891 if (!hasOldRevision)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1892 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1893 OrthancConfiguration::ReaderLock lock;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1894 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1895 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1896 // "StatelessDatabaseOperations::SetMetadata()" will ignore
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1897 // the actual value of "oldRevision" if the metadata is
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1898 // inexistent as expected
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1899 hasOldRevision = true;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1900 oldRevision = -1; // dummy value
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1901 oldMD5.clear(); // dummy value
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1902 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1903 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1904
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1905 int64_t newRevision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1906 OrthancRestApi::GetIndex(call).SetMetadata(newRevision, publicId, metadata, value,
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1907 hasOldRevision, oldRevision, oldMD5);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1908
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1909 SetStringContentETag(call.GetOutput(), newRevision, value); // New in Orthanc 1.9.2
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	1910 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1911 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1912 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1913 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1914 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1915 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1916 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1917
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1918
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1919
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1920
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1921 // Handling of attached files -----------------------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1922
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1923 static void ListAttachments(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1924 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1925 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1926 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1927 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1928 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1929 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1930 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1931 .SetSummary("List attachments")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1932 .SetDescription("Get the list of attachments that are associated with the given " + r)
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1933 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4853 b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1934 .SetHttpGetArgument("full", RestApiCallDocumentation::Type_String,
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1935 "If present, retrieve the attachments list and their numerical ids", false)
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1936 .AddAnswerType(MimeType_Json, "JSON array containing the names of the attachments")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1937 .SetHttpGetSample(GetDocumentationSampleResource(t) + "/attachments", true);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1938 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1939 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1940
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1941 const std::string resourceType = call.GetFullUri() [0];
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1942 const std::string publicId = call.GetUriComponent("id", "");
4514 5b929e6b3c36 removal of "dicom-as-json" attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4513 diff changeset	1943 std::set<FileContentType> attachments;
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1944 OrthancRestApi::GetIndex(call).ListAvailableAttachments(attachments, publicId, StringToResourceType(resourceType.c_str()));
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1945
4853 b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1946 Json::Value result;
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1947
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1948 if (call.HasArgument("full"))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1949 {
4853 b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1950 result = Json::objectValue;
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1951
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1952 for (std::set<FileContentType>::const_iterator
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1953 it = attachments.begin(); it != attachments.end(); ++it)
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1954 {
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1955 std::string key = EnumerationToString(*it);
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1956 result[key] = static_cast<uint16_t>(*it);
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1957 }
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1958 }
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1959 else
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1960 {
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1961 result = Json::arrayValue;
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1962
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1963 for (std::set<FileContentType>::const_iterator
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1964 it = attachments.begin(); it != attachments.end(); ++it)
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1965 {
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1966 result.append(EnumerationToString(*it));
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1967 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1968 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1969
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1970 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1971 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1972
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1973
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1974 static void AddAttachmentDocumentation(RestApiGetCall& call,
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1975 const std::string& resourceType)
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1976 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1977 call.GetDocumentation()
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1978 .SetUriArgument("id", "Orthanc identifier of the " + resourceType + " of interest")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1979 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1980 .SetAnswerHeader("ETag", "Revision of the attachment, to be used in further `PUT` or `DELETE` operations")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1981 .SetHttpHeader("If-None-Match", "Optional revision of the attachment, to check if its content has changed");
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1982 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1983
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1984
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1985 static bool GetAttachmentInfo(FileInfo& info,
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1986 RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1987 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1988 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1989
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1990 const std::string publicId = call.GetUriComponent("id", "");
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1991 const std::string name = call.GetUriComponent("name", "");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1992 FileContentType contentType = StringToContentType(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1993
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1994 int64_t revision;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1995 if (OrthancRestApi::GetIndex(call).LookupAttachment(info, revision, publicId, contentType))
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1996 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	1997 SetAttachmentETag(call.GetOutput(), revision, info); // New in Orthanc 1.9.2
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1998
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1999 int64_t userRevision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2000 std::string userMD5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2001 if (GetRevisionHeader(userRevision, userMD5, call, "If-None-Match") &&
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2002 revision == userRevision &&
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2003 info.GetUncompressedMD5() == userMD5)
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2004 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2005 call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2006 return false;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2007 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2008 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2009 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2010 return true;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2011 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2012 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2013 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2014 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2015 throw OrthancException(ErrorCode_UnknownResource);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2016 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2017 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2018
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2019
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2020 static void GetAttachmentOperations(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2021 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2022 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2023 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2024 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2025 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2026 AddAttachmentDocumentation(call, r);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2027 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2028 .SetTag("Other")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2029 .SetSummary("List operations on attachments")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2030 .SetDescription("Get the list of the operations that are available for attachments associated with the given " + r)
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2031 .AddAnswerType(MimeType_Json, "List of the available operations")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2032 .SetHttpGetSample("https://demo.orthanc-server.com/instances/d94d9a03-3003b047-a4affc69-322313b2-680530a2/attachments/dicom", true);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2033 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2034 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2035
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2036 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2037 if (GetAttachmentInfo(info, call))
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2038 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2039 Json::Value operations = Json::arrayValue;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2040
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2041 operations.append("compress");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2042 operations.append("compressed-data");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2043
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2044 if (info.GetCompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2045 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2046 operations.append("compressed-md5");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2047 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2048
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2049 operations.append("compressed-size");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2050 operations.append("data");
4883 504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2051 operations.append("info");
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2052 operations.append("is-compressed");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2053
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2054 if (info.GetUncompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2055 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2056 operations.append("md5");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2057 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2058
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2059 operations.append("size");
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2060 operations.append("uncompress");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2061
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2062 if (info.GetCompressedMD5() != "" &&
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2063 info.GetUncompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2064 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2065 operations.append("verify-md5");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2066 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2067
4883 504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2068 operations.append("uuid");
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2069
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2070 call.GetOutput().AnswerJson(operations);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2071 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2072 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2073
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2074
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2075 template <int uncompress>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2076 static void GetAttachmentData(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2077 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2078 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2079 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2080 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2081 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2082 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2083 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2084 .SetSummary("Get attachment" + std::string(uncompress ? "" : " (no decompression)"))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2085 .SetDescription("Get the (binary) content of one attachment associated with the given " + r +
4418 9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	2086 std::string(uncompress ? "" : ". The attachment will not be decompressed if `StorageCompression` is `true`."))
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2087 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2088 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2089 .AddAnswerType(MimeType_Binary, "The attachment")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2090 .SetAnswerHeader("ETag", "Revision of the attachment, to be used in further `PUT` or `DELETE` operations")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2091 .SetHttpHeader("If-None-Match", "Optional revision of the metadata, to check if its content has changed");
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2092 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2093 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2094
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2095 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2096
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2097 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2098
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2099 std::string publicId = call.GetUriComponent("id", "");
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2100 FileContentType type = StringToContentType(call.GetUriComponent("name", ""));
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2101
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2102 FileInfo info;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2103 if (GetAttachmentInfo(info, call))
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2104 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2105 // NB: "SetAttachmentETag()" is already invoked by "GetAttachmentInfo()"
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2106
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2107 if (uncompress)
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2108 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2109 context.AnswerAttachment(call.GetOutput(), publicId, type);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2110 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2111 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2112 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2113 // Return the raw data (possibly compressed), as stored on the filesystem
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2114 std::string content;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2115 int64_t revision;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2116 context.ReadAttachment(content, revision, publicId, type, false);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2117
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2118 int64_t userRevision;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2119 std::string userMD5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2120 if (GetRevisionHeader(userRevision, userMD5, call, "If-None-Match") &&
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2121 revision == userRevision &&
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2122 info.GetUncompressedMD5() == userMD5)
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2123 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2124 call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2125 }
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2126 else
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2127 {
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2128 call.GetOutput().AnswerBuffer(content, MimeType_Binary);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2129 }
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2130 }
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2131 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2132 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2133
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2134
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2135 static void GetAttachmentSize(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2136 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2137 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2138 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2139 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2140 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2141 AddAttachmentDocumentation(call, r);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2142 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2143 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2144 .SetSummary("Get size of attachment")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2145 .SetDescription("Get the size of one attachment associated with the given " + r)
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2146 .AddAnswerType(MimeType_PlainText, "The size of the attachment");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2147 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2148 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2149
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2150 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2151 if (GetAttachmentInfo(info, call))
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2152 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2153 call.GetOutput().AnswerBuffer(boost::lexical_cast<std::string>(info.GetUncompressedSize()), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2154 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2155 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2156
4883 504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2157 static void GetAttachmentInfo(RestApiGetCall& call)
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2158 {
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2159 if (call.IsDocumentation())
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2160 {
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2161 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2162 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2163 AddAttachmentDocumentation(call, r);
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2164 call.GetDocumentation()
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2165 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2166 .SetSummary("Get info about the attachment")
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2167 .SetDescription("Get all the information about the attachment associated with the given " + r)
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2168 .AddAnswerType(MimeType_Json, "JSON object containing the information about the attachment")
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2169 .SetHttpGetSample("https://demo.orthanc-server.com/instances/7c92ce8e-bbf67ed2-ffa3b8c1-a3b35d94-7ff3ae26/dicom/info", true);
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2170 return;
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2171 }
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2172
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2173 FileInfo info;
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2174 if (GetAttachmentInfo(info, call))
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2175 {
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2176 Json::Value result = Json::objectValue;
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2177 result["Uuid"] = info.GetUuid();
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2178 result["ContentType"] = info.GetContentType();
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2179 result["UncompressedSize"] = Json::Value::UInt64(info.GetUncompressedSize());
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2180 result["CompressedSize"] = Json::Value::UInt64(info.GetCompressedSize());
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2181 result["UncompressedMD5"] = info.GetUncompressedMD5();
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2182 result["CompressedMD5"] = info.GetCompressedMD5();
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2183
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2184 call.GetOutput().AnswerJson(result);
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2185 }
504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	2186 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2187
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2188 static void GetAttachmentCompressedSize(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2189 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2190 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2191 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2192 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2193 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2194 AddAttachmentDocumentation(call, r);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2195 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2196 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2197 .SetSummary("Get size of attachment on disk")
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2198 .SetDescription("Get the size of one attachment associated with the given " + r + ", as stored on the disk. "
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2199 "This is different from `.../size` iff `EnableStorage` is `true`.")
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2200 .AddAnswerType(MimeType_PlainText, "The size of the attachment, as stored on the disk");
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2201 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2202 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2203
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2204 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2205 if (GetAttachmentInfo(info, call))
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2206 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2207 call.GetOutput().AnswerBuffer(boost::lexical_cast<std::string>(info.GetCompressedSize()), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2208 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2209 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2210
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2211
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2212 static void GetAttachmentMD5(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2213 {
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2214 if (call.IsDocumentation())
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2215 {
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2216 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2217 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2218 AddAttachmentDocumentation(call, r);
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2219 call.GetDocumentation()
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2220 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2221 .SetSummary("Get MD5 of attachment")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2222 .SetDescription("Get the MD5 hash of one attachment associated with the given " + r)
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2223 .AddAnswerType(MimeType_PlainText, "The MD5 of the attachment");
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2224 return;
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2225 }
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2226
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2227 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2228 if (GetAttachmentInfo(info, call) &&
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2229 info.GetUncompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2230 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2231 call.GetOutput().AnswerBuffer(boost::lexical_cast<std::string>(info.GetUncompressedMD5()), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2232 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2233 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2234
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2235
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2236 static void GetAttachmentCompressedMD5(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2237 {
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2238 if (call.IsDocumentation())
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2239 {
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2240 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2241 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2242 AddAttachmentDocumentation(call, r);
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2243 call.GetDocumentation()
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2244 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2245 .SetSummary("Get MD5 of attachment on disk")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2246 .SetDescription("Get the MD5 hash of one attachment associated with the given " + r + ", as stored on the disk. "
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2247 "This is different from `.../md5` iff `EnableStorage` is `true`.")
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2248 .AddAnswerType(MimeType_PlainText, "The MD5 of the attachment, as stored on the disk");
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2249 return;
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2250 }
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2251
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2252 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2253 if (GetAttachmentInfo(info, call) &&
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2254 info.GetCompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2255 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2256 call.GetOutput().AnswerBuffer(boost::lexical_cast<std::string>(info.GetCompressedMD5()), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2257 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2258 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2259
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2260
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2261 static void VerifyAttachment(RestApiPostCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2262 {
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2263 if (call.IsDocumentation())
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2264 {
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2265 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2266 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2267 call.GetDocumentation()
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2268 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2269 .SetSummary("Verify attachment")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2270 .SetDescription("Verify that the attachment is not corrupted, by validating its MD5 hash")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2271 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2272 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2273 .AddAnswerType(MimeType_Json, "On success, a valid JSON object is returned");
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2274 return;
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2275 }
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2276
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2277 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2278 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2279
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2280 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2281 std::string name = call.GetUriComponent("name", "");
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2282 FileContentType contentType = StringToContentType(name);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2283
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2284 FileInfo info;
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2285 int64_t revision; // Ignored
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2286 if (!OrthancRestApi::GetIndex(call).LookupAttachment(info, revision, publicId, contentType) \|\|
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2287 info.GetCompressedMD5() == "" \|\|
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2288 info.GetUncompressedMD5() == "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2289 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2290 // Inexistent resource, or no MD5 available
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2291 return;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2292 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2293
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2294 bool ok = false;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2295
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2296 // First check whether the compressed data is correctly stored in the disk
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2297 std::string data;
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2298 context.ReadAttachment(data, revision, publicId, StringToContentType(name), false);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2299
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2300 std::string actualMD5;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2301 Toolbox::ComputeMD5(actualMD5, data);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2302
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2303 if (actualMD5 == info.GetCompressedMD5())
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2304 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2305 // The compressed data is OK. If a compression algorithm was
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2306 // applied to it, now check the MD5 of the uncompressed data.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2307 if (info.GetCompressionType() == CompressionType_None)
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2308 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2309 ok = true;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2310 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2311 else
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2312 {
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2313 context.ReadAttachment(data, revision, publicId, StringToContentType(name), true);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2314 Toolbox::ComputeMD5(actualMD5, data);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2315 ok = (actualMD5 == info.GetUncompressedMD5());
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2316 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2317 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2318
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2319 if (ok)
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2320 {
4294 0923247e69f6 log categories: rest -> http + added lua & jobs Alain Mazy <alain@mazy.be> parents: 4272 diff changeset	2321 CLOG(INFO, HTTP) << "The attachment " << name << " of resource " << publicId << " has the right MD5";
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2322 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2323 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2324 else
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2325 {
4294 0923247e69f6 log categories: rest -> http + added lua & jobs Alain Mazy <alain@mazy.be> parents: 4272 diff changeset	2326 CLOG(INFO, HTTP) << "The attachment " << name << " of resource " << publicId << " has bad MD5!";
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2327 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2328 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2329
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2330
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2331 static void UploadAttachment(RestApiPutCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2332 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2333 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2334 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2335 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2336 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2337 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2338 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2339 .SetSummary("Set attachment")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2340 .SetDescription("Attach a file to the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2341 ". This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2342 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2343 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2344 .AddRequestType(MimeType_Binary, "Binary data containing the attachment")
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2345 .AddAnswerType(MimeType_Json, "Empty JSON object in the case of a success")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2346 .SetHttpHeader("If-Match", "Revision of the attachment, if this is not the first time this attachment is set.");
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2347 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2348 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2349
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2350 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2351 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2352
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2353 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2354 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2355
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2356 FileContentType contentType = StringToContentType(name);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2357 if (IsUserContentType(contentType)) // It is forbidden to modify internal attachments
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2358 {
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2359 int64_t oldRevision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2360 std::string oldMD5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2361 bool hasOldRevision = GetRevisionHeader(oldRevision, oldMD5, call, "if-match");
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2362
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2363 if (!hasOldRevision)
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2364 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2365 OrthancConfiguration::ReaderLock lock;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2366 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2367 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2368 // "StatelessDatabaseOperations::AddAttachment()" will ignore
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2369 // the actual value of "oldRevision" if the metadata is
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2370 // inexistent as expected
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2371 hasOldRevision = true;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2372 oldRevision = -1; // dummy value
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2373 oldMD5.clear(); // dummy value
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2374 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2375 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2376
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2377 int64_t newRevision;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2378 context.AddAttachment(newRevision, publicId, StringToContentType(name), call.GetBodyData(),
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2379 call.GetBodySize(), hasOldRevision, oldRevision, oldMD5);
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2380
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2381 SetBufferContentETag(call.GetOutput(), newRevision, call.GetBodyData(), call.GetBodySize()); // New in Orthanc 1.9.2
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2382 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2383 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2384 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2385 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2386 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2387 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2388 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2389
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2390
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2391 static void DeleteAttachment(RestApiDeleteCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2392 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2393 if (call.IsDocumentation())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2394 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2395 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2396 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2397 call.GetDocumentation()
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2398 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2399 .SetSummary("Delete attachment")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2400 .SetDescription("Delete an attachment associated with the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2401 ". This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).")
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2402 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2403 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2404 .SetHttpHeader("If-Match", "Revision of the attachment, to check if its content has not changed and can "
4661 b1d87d41874e typo: replaced "CheckRevision" by "CheckRevisions" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4657 diff changeset	2405 "be deleted. This header is mandatory if `CheckRevisions` option is `true`.");
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2406 return;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2407 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2408
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2409 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2410
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2411 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2412 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2413 FileContentType contentType = StringToContentType(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2414
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2415 bool allowed;
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2416 if (IsUserContentType(contentType))
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2417 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2418 allowed = true;
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2419 }
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2420 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2421 {
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2422 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2423
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2424 if (lock.GetConfiguration().GetBooleanParameter("StoreDicom", true) &&
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2425 contentType == FileContentType_DicomAsJson)
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2426 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2427 allowed = true;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2428 }
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2429 else
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2430 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2431 // It is forbidden to delete internal attachments, except for
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2432 // the "DICOM as JSON" summary as of Orthanc 1.2.0 (this summary
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2433 // would be automatically reconstructed on the next GET call)
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2434 allowed = false;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2435 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2436 }
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2437
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2438 if (allowed)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2439 {
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2440 bool found;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2441 int64_t revision;
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2442 std::string md5;
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2443 if (GetRevisionHeader(revision, md5, call, "if-match"))
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2444 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2445 found = OrthancRestApi::GetIndex(call).DeleteAttachment(publicId, contentType, true, revision, md5);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2446 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2447 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2448 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2449 OrthancConfiguration::ReaderLock lock;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2450 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2451 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2452 throw OrthancException(ErrorCode_Revision,
4661 b1d87d41874e typo: replaced "CheckRevision" by "CheckRevisions" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4657 diff changeset	2453 "HTTP header \"If-Match\" is missing, as \"CheckRevisions\" is \"true\"");
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2454 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2455 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2456 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2457 found = OrthancRestApi::GetIndex(call).DeleteAttachment(publicId, contentType,
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	2458 false, -1 /* dummy value /, "" / dummy value */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2459 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2460 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2461
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2462 if (found)
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2463 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2464 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2465 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2466 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2467 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2468 throw OrthancException(ErrorCode_UnknownResource);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2469 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2470 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2471 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2472 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2473 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2474 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2475 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2476
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2477
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2478 template <enum CompressionType compression>
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2479 static void ChangeAttachmentCompression(RestApiPostCall& call)
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2480 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2481 if (call.IsDocumentation())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2482 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2483 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2484 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2485 call.GetDocumentation()
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2486 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2487 .SetSummary(compression == CompressionType_None ? "Uncompress attachment" : "Compress attachment")
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2488 .SetDescription("Change the compression scheme that is used to store an attachment.")
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2489 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2490 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)");
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2491 return;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2492 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2493
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2494 CheckValidResourceType(call);
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2495
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2496 std::string publicId = call.GetUriComponent("id", "");
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2497 std::string name = call.GetUriComponent("name", "");
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2498 FileContentType contentType = StringToContentType(name);
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2499
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2500 OrthancRestApi::GetContext(call).ChangeAttachmentCompression(publicId, contentType, compression);
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2501 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2502 }
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2503
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2504
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2505 static void IsAttachmentCompressed(RestApiGetCall& call)
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2506 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2507 if (call.IsDocumentation())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2508 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2509 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2510 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2511 AddAttachmentDocumentation(call, r);
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2512 call.GetDocumentation()
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2513 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2514 .SetSummary("Is attachment compressed?")
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2515 .SetDescription("Test whether the attachment has been stored as a compressed file on the disk.")
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2516 .AddAnswerType(MimeType_PlainText, "`0` if the attachment was stored uncompressed, `1` if it was compressed");
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2517 return;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2518 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2519
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2520 FileInfo info;
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2521 if (GetAttachmentInfo(info, call))
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2522 {
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2523 std::string answer = (info.GetCompressionType() == CompressionType_None) ? "0" : "1";
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2524 call.GetOutput().AnswerBuffer(answer, MimeType_PlainText);
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2525 }
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2526 }
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2527
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2528
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2529 // Raw access to the DICOM tags of an instance ------------------------------
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2530
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2531 static void GetRawContent(RestApiGetCall& call)
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2532 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2533 if (call.IsDocumentation())
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2534 {
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2535 call.GetDocumentation()
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2536 .SetTag("Instances")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2537 .SetSummary("Get raw tag")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2538 .SetDescription("Get the raw content of one DICOM tag in the hierarchy of DICOM dataset")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2539 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2540 .SetUriArgument("...", "Path to the DICOM tag. This is the interleaving of one DICOM tag, possibly followed "
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2541 "by an index for sequences. Sequences are accessible as, for instance, `/0008-1140/1/0008-1150`")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2542 .AddAnswerType(MimeType_Binary, "The raw value of the tag of intereset "
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2543 "(binary data, whose memory layout depends on the underlying transfer syntax), "
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2544 "or JSON array containing the list of available tags if accessing a dataset");
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2545 return;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2546 }
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2547
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2548 std::string id = call.GetUriComponent("id", "");
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2549
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2550 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), id);
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2551
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2552 locker.GetDicom().SendPathValue(call.GetOutput(), call.GetTrailingUri());
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2553 }
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2554
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2555
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2556
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2557 static bool ExtractSharedTags(Json::Value& shared,
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2558 ServerContext& context,
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2559 const std::string& publicId)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2560 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2561 // Retrieve all the instances of this patient/study/series
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2562 typedef std::list<std::string> Instances;
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2563 Instances instances;
959 bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2564 context.GetIndex().GetChildInstances(instances, publicId); // (*)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2565
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2566 // Loop over the instances
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2567 bool isFirst = true;
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2568 shared = Json::objectValue;
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2569
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2570 for (Instances::const_iterator it = instances.begin();
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2571 it != instances.end(); ++it)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2572 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2573 // Get the tags of the current instance, in the simplified format
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2574 Json::Value tags;
959 bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2575
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2576 try
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2577 {
2124 2b1520efa282 cleaning up Sebastien Jodogne <s.jodogne@gmail.com> parents: 2122 diff changeset	2578 context.ReadDicomAsJson(tags, *it);
959 bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2579 }
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2580 catch (OrthancException&)
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2581 {
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2582 // Race condition: This instance has been removed since
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2583 // (*). Ignore this instance.
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2584 continue;
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2585 }
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2586
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2587 if (tags.type() != Json::objectValue)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2588 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2589 return false; // Error
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2590 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2591
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2592 // Only keep the tags that are mapped to a string
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2593 Json::Value::Members members = tags.getMemberNames();
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2594 for (size_t i = 0; i < members.size(); i++)
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2595 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2596 const Json::Value& tag = tags[members[i]];
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2597 if (tag.type() != Json::objectValue \|\|
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2598 tag["Type"].type() != Json::stringValue \|\|
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2599 tag["Type"].asString() != "String")
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2600 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2601 tags.removeMember(members[i]);
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2602 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2603 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2604
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2605 if (isFirst)
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2606 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2607 // This is the first instance, keep its tags as such
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2608 shared = tags;
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2609 isFirst = false;
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2610 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2611 else
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2612 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2613 // Loop over all the members of the shared tags extracted so
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2614 // far. If the value of one of these tags does not match its
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2615 // value in the current instance, remove it.
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2616 members = shared.getMemberNames();
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2617 for (size_t i = 0; i < members.size(); i++)
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2618 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2619 if (!tags.isMember(members[i]) \|\|
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2620 tags[members[i]]["Value"].asString() != shared[members[i]]["Value"].asString())
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2621 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2622 shared.removeMember(members[i]);
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2623 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2624 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2625 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2626 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2627
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2628 return true;
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2629 }
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2630
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2631
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2632 static void GetSharedTags(RestApiGetCall& call)
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2633 {
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2634 if (call.IsDocumentation())
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2635 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2636 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2637
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2638 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2639 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2640 call.GetDocumentation()
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2641 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2642 .SetSummary("Get shared tags")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2643 .SetDescription("Extract the DICOM tags whose value is constant across all the child instances of "
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2644 "the DICOM " + r + " whose Orthanc identifier is provided in the URL")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2645 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2646 .AddAnswerType(MimeType_Json, "JSON object containing the values of the DICOM tags")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2647 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(t) + "/shared-tags", 5);
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2648 return;
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2649 }
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2650
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2651 ServerContext& context = OrthancRestApi::GetContext(call);
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2652 std::string publicId = call.GetUriComponent("id", "");
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2653
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2654 Json::Value sharedTags;
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2655 if (ExtractSharedTags(sharedTags, context, publicId))
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2656 {
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2657 // Success: Send the value of the shared tags
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2658 AnswerDicomAsJson(call, sharedTags, OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full));
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2659 }
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2660 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2661
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2662
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2663 template <enum ResourceType resourceType,
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2664 enum DicomModule module>
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2665 static void GetModule(RestApiGetCall& call)
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2666 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2667 if (call.IsDocumentation())
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2668 {
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2669 const std::string resource = GetResourceTypeText(resourceType, false /* plural /, false / lower case */);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2670 std::string m;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2671 switch (module)
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2672 {
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2673 case DicomModule_Patient:
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2674 m = "patient";
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2675 break;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2676 case DicomModule_Study:
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2677 m = "study";
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2678 break;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2679 case DicomModule_Series:
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2680 m = "series";
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2681 break;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2682 case DicomModule_Instance:
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2683 m = "instance";
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2684 break;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2685 default:
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2686 throw OrthancException(ErrorCode_ParameterOutOfRange);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2687 }
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2688
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2689 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2690
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2691 call.GetDocumentation()
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2692 .SetTag(GetResourceTypeText(resourceType, true /* plural /, true / upper case */))
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2693 .SetSummary("Get " + m + " module" + std::string(resource == m ? "" : " of " + resource))
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2694 .SetDescription("Get the " + m + " module of the DICOM " + resource + " whose Orthanc identifier is provided in the URL")
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2695 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	2696 .SetHttpGetArgument(IGNORE_LENGTH, RestApiCallDocumentation::Type_JsonListOfStrings,
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2697 "Also include the DICOM tags that are provided in this list, even if their associated value is long", false)
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2698 .AddAnswerType(MimeType_Json, "Information about the DICOM " + resource)
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2699 .SetHttpGetSample(GetDocumentationSampleResource(resourceType) + "/" + (*call.GetFullUri().rbegin()), true);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2700 return;
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2701 }
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2702
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2703 if (!((resourceType == ResourceType_Patient && module == DicomModule_Patient) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2704 (resourceType == ResourceType_Study && module == DicomModule_Patient) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2705 (resourceType == ResourceType_Study && module == DicomModule_Study) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2706 (resourceType == ResourceType_Series && module == DicomModule_Series) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2707 (resourceType == ResourceType_Instance && module == DicomModule_Instance) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2708 (resourceType == ResourceType_Instance && module == DicomModule_Image)))
1054 1701dcb6f554 Access patient module at the study level to cope with PatientID collisions Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	2709 {
1701dcb6f554 Access patient module at the study level to cope with PatientID collisions Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	2710 throw OrthancException(ErrorCode_NotImplemented);
1701dcb6f554 Access patient module at the study level to cope with PatientID collisions Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	2711 }
1701dcb6f554 Access patient module at the study level to cope with PatientID collisions Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	2712
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2713 ServerContext& context = OrthancRestApi::GetContext(call);
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2714 std::string publicId = call.GetUriComponent("id", "");
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2715
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	2716 std::set<DicomTag> ignoreTagLength;
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	2717 ParseSetOfTags(ignoreTagLength, call, IGNORE_LENGTH);
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	2718
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2719 typedef std::set<DicomTag> ModuleTags;
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2720 ModuleTags moduleTags;
1368 b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2721 DicomTag::AddTagsForModule(moduleTags, module);
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2722
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2723 Json::Value tags;
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2724
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2725 if (resourceType != ResourceType_Instance)
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2726 {
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2727 // Retrieve all the instances of this patient/study/series
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2728 typedef std::list<std::string> Instances;
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2729 Instances instances;
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2730 context.GetIndex().GetChildInstances(instances, publicId);
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2731
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2732 if (instances.empty())
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2733 {
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2734 return; // Error: No instance (should never happen)
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2735 }
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2736
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2737 // Select one child instance
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2738 publicId = instances.front();
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2739 }
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2740
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	2741 context.ReadDicomAsJson(tags, publicId, ignoreTagLength);
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2742
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2743 // Filter the tags of the instance according to the module
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2744 Json::Value result = Json::objectValue;
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2745 for (ModuleTags::const_iterator tag = moduleTags.begin(); tag != moduleTags.end(); ++tag)
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2746 {
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2747 std::string s = tag->Format();
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2748 if (tags.isMember(s))
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2749 {
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2750 result[s] = tags[s];
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2751 }
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2752 }
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2753
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2754 AnswerDicomAsJson(call, result, OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full));
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2755 }
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2756
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2757
1722 f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2758 namespace
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2759 {
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2760 typedef std::list< std::pair<ResourceType, std::string> > LookupResults;
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2761 }
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2762
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2763
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2764 static void AccumulateLookupResults(LookupResults& result,
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2765 ServerIndex& index,
2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2766 const DicomTag& tag,
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2767 const std::string& value,
3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2768 ResourceType level)
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2769 {
3034 54e422fe31ce moving LookupResource to graveyard Sebastien Jodogne <s.jodogne@gmail.com> parents: 3033 diff changeset	2770 std::vector<std::string> tmp;
1728 4941494b5dd8 rename LookupIdentifier as LookupIdentifierExact Sebastien Jodogne <s.jodogne@gmail.com> parents: 1727 diff changeset	2771 index.LookupIdentifierExact(tmp, level, tag, value);
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2772
3034 54e422fe31ce moving LookupResource to graveyard Sebastien Jodogne <s.jodogne@gmail.com> parents: 3033 diff changeset	2773 for (size_t i = 0; i < tmp.size(); i++)
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2774 {
3034 54e422fe31ce moving LookupResource to graveyard Sebastien Jodogne <s.jodogne@gmail.com> parents: 3033 diff changeset	2775 result.push_back(std::make_pair(level, tmp[i]));
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2776 }
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2777 }
2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2778
2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2779
1139 f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2780 static void Lookup(RestApiPostCall& call)
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2781 {
4422 48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2782 if (call.IsDocumentation())
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2783 {
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2784 call.GetDocumentation()
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2785 .SetTag("System")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2786 .SetSummary("Look for DICOM identifiers")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2787 .SetDescription("This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2788 .AddRequestType(MimeType_PlainText, "The DICOM identifier of interest (i.e. the value of `PatientID`, "
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2789 "`StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`)")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2790 .AddAnswerType(MimeType_Json, "JSON array containing a list of matching Orthanc resources, each item in the "
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2791 "list corresponding to a JSON object with the fields `Type`, `ID` and `Path` identifying one "
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2792 "DICOM resource that is stored by Orthanc");
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2793 return;
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2794 }
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2795
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	2796 std::string tag;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	2797 call.BodyToString(tag);
1139 f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2798
1722 f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2799 LookupResults resources;
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2800 ServerIndex& index = OrthancRestApi::GetIndex(call);
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2801 AccumulateLookupResults(resources, index, DICOM_TAG_PATIENT_ID, tag, ResourceType_Patient);
3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2802 AccumulateLookupResults(resources, index, DICOM_TAG_STUDY_INSTANCE_UID, tag, ResourceType_Study);
3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2803 AccumulateLookupResults(resources, index, DICOM_TAG_SERIES_INSTANCE_UID, tag, ResourceType_Series);
3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2804 AccumulateLookupResults(resources, index, DICOM_TAG_SOP_INSTANCE_UID, tag, ResourceType_Instance);
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2805
2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2806 Json::Value result = Json::arrayValue;
1722 f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2807 for (LookupResults::const_iterator
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2808 it = resources.begin(); it != resources.end(); ++it)
1139 f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2809 {
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2810 ResourceType type = it->first;
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2811 const std::string& id = it->second;
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2812
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2813 Json::Value item = Json::objectValue;
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2814 item["Type"] = EnumerationToString(type);
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2815 item["ID"] = id;
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2816 item["Path"] = GetBasePath(type, id);
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2817
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2818 result.append(item);
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2819 }
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2820
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2821 call.GetOutput().AnswerJson(result);
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2822 }
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2823
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2824
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2825 namespace
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2826 {
3021 2cbafb5d5a62 renamed LookupResource::IVisitor as ServerContext::ILookupVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 3012 diff changeset	2827 class FindVisitor : public ServerContext::ILookupVisitor
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2828 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2829 private:
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2830 bool isComplete_;
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2831 std::list<std::string> resources_;
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2832 DicomToJsonFormat format_;
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2833
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2834 public:
4716 758fe3ffb336 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4714 diff changeset	2835 explicit FindVisitor(DicomToJsonFormat format) :
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2836 isComplete_(false),
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2837 format_(format)
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2838 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2839 }
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2840
d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2841 virtual bool IsDicomAsJsonNeeded() const ORTHANC_OVERRIDE
3012 af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient Sebastien Jodogne <s.jodogne@gmail.com> parents: 3003 diff changeset	2842 {
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient Sebastien Jodogne <s.jodogne@gmail.com> parents: 3003 diff changeset	2843 return false; // (*)
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient Sebastien Jodogne <s.jodogne@gmail.com> parents: 3003 diff changeset	2844 }
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient Sebastien Jodogne <s.jodogne@gmail.com> parents: 3003 diff changeset	2845
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2846 virtual void MarkAsComplete() ORTHANC_OVERRIDE
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2847 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2848 isComplete_ = true; // Unused information as of Orthanc 1.5.0
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2849 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2850
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2851 virtual void Visit(const std::string& publicId,
3012 af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient Sebastien Jodogne <s.jodogne@gmail.com> parents: 3003 diff changeset	2852 const std::string& instanceId /* unused */,
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient Sebastien Jodogne <s.jodogne@gmail.com> parents: 3003 diff changeset	2853 const DicomMap& mainDicomTags /* unused */,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2854 const Json::Value* dicomAsJson /* unused () /) ORTHANC_OVERRIDE
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2855 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2856 resources_.push_back(publicId);
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2857 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2858
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2859 void Answer(RestApiOutput& output,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2860 ServerIndex& index,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2861 ResourceType level,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2862 bool expand) const
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2863 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2864 AnswerListOfResources(output, index, resources_, level, expand, format_);
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2865 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2866 };
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2867 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2868
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2869
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2870 static void Find(RestApiPostCall& call)
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2871 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2872 static const char* const KEY_CASE_SENSITIVE = "CaseSensitive";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2873 static const char* const KEY_EXPAND = "Expand";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2874 static const char* const KEY_LEVEL = "Level";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2875 static const char* const KEY_LIMIT = "Limit";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2876 static const char* const KEY_QUERY = "Query";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2877 static const char* const KEY_SINCE = "Since";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2878
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2879 if (call.IsDocumentation())
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2880 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2881 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	2882
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2883 call.GetDocumentation()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2884 .SetTag("System")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2885 .SetSummary("Look for local resources")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2886 .SetDescription("This URI can be used to perform a search on the content of the local Orthanc server, "
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2887 "in a way that is similar to querying remote DICOM modalities using C-FIND SCU: "
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2888 "https://book.orthanc-server.com/users/rest.html#performing-finds-within-orthanc")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2889 .SetRequestField(KEY_CASE_SENSITIVE, RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2890 "Enable case-sensitive search for PN value representations (defaults to configuration option `CaseSensitivePN`)", false)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2891 .SetRequestField(KEY_EXPAND, RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2892 "Also retrieve the content of the matching resources, not only their Orthanc identifiers", false)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2893 .SetRequestField(KEY_LEVEL, RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2894 "Level of the query (`Patient`, `Study`, `Series` or `Instance`)", true)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2895 .SetRequestField(KEY_LIMIT, RestApiCallDocumentation::Type_Number,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2896 "Limit the number of reported resources", false)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2897 .SetRequestField(KEY_SINCE, RestApiCallDocumentation::Type_Number,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2898 "Show only the resources since the provided index (in conjunction with `Limit`)", false)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2899 .SetRequestField(KEY_QUERY, RestApiCallDocumentation::Type_JsonObject,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2900 "Associative array containing the filter on the values of the DICOM tags", true)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2901 .AddAnswerType(MimeType_Json, "JSON array containing either the Orthanc identifiers, or detailed information "
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2902 "about the reported resources (if `Expand` argument is `true`)");
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2903 return;
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2904 }
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2905
1358 62d2d35b725e cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1356 diff changeset	2906 ServerContext& context = OrthancRestApi::GetContext(call);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2907
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2908 Json::Value request;
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2909 if (!call.ParseJsonRequest(request) \|\|
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2910 request.type() != Json::objectValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2911 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2912 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2913 "The body must contain a JSON object");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2914 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2915 else if (!request.isMember(KEY_LEVEL) \|\|
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2916 request[KEY_LEVEL].type() != Json::stringValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2917 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2918 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2919 "Field \"" + std::string(KEY_LEVEL) + "\" is missing, or should be a string");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2920 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2921 else if (!request.isMember(KEY_QUERY) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2922 request[KEY_QUERY].type() != Json::objectValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2923 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2924 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2925 "Field \"" + std::string(KEY_QUERY) + "\" is missing, or should be a JSON object");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2926 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2927 else if (request.isMember(KEY_CASE_SENSITIVE) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2928 request[KEY_CASE_SENSITIVE].type() != Json::booleanValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2929 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2930 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2931 "Field \"" + std::string(KEY_CASE_SENSITIVE) + "\" should be a Boolean");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2932 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2933 else if (request.isMember(KEY_LIMIT) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2934 request[KEY_LIMIT].type() != Json::intValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2935 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2936 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2937 "Field \"" + std::string(KEY_LIMIT) + "\" should be an integer");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2938 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2939 else if (request.isMember(KEY_SINCE) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2940 request[KEY_SINCE].type() != Json::intValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2941 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2942 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2943 "Field \"" + std::string(KEY_SINCE) + "\" should be an integer");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2944 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2945 else
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2946 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2947 bool expand = false;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2948 if (request.isMember(KEY_EXPAND))
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2949 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2950 expand = request[KEY_EXPAND].asBool();
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2951 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2952
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2953 bool caseSensitive = false;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2954 if (request.isMember(KEY_CASE_SENSITIVE))
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2955 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2956 caseSensitive = request[KEY_CASE_SENSITIVE].asBool();
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2957 }
a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2958
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2959 size_t limit = 0;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2960 if (request.isMember(KEY_LIMIT))
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2961 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2962 int tmp = request[KEY_LIMIT].asInt();
1847 559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	2963 if (tmp < 0)
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2964 {
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2965 throw OrthancException(ErrorCode_ParameterOutOfRange,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2966 "Field \"" + std::string(KEY_LIMIT) + "\" should be a positive integer");
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2967 }
1847 559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	2968
559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	2969 limit = static_cast<size_t>(tmp);
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2970 }
318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2971
2304 563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2972 size_t since = 0;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2973 if (request.isMember(KEY_SINCE))
2304 563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2974 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2975 int tmp = request[KEY_SINCE].asInt();
2304 563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2976 if (tmp < 0)
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2977 {
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2978 throw OrthancException(ErrorCode_ParameterOutOfRange,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2979 "Field \"" + std::string(KEY_SINCE) + "\" should be a positive integer");
2304 563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2980 }
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2981
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2982 since = static_cast<size_t>(tmp);
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2983 }
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2984
3033 5da6d1063d8f effectively replacing LookupResource by DatabaseLookup in searches Sebastien Jodogne <s.jodogne@gmail.com> parents: 3027 diff changeset	2985 ResourceType level = StringToResourceType(request[KEY_LEVEL].asCString());
1360 0649c5aef34a DicomFindQuery Sebastien Jodogne <s.jodogne@gmail.com> parents: 1358 diff changeset	2986
3033 5da6d1063d8f effectively replacing LookupResource by DatabaseLookup in searches Sebastien Jodogne <s.jodogne@gmail.com> parents: 3027 diff changeset	2987 DatabaseLookup query;
1358 62d2d35b725e cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1356 diff changeset	2988
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2989 Json::Value::Members members = request[KEY_QUERY].getMemberNames();
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2990 for (size_t i = 0; i < members.size(); i++)
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2991 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2992 if (request[KEY_QUERY][members[i]].type() != Json::stringValue)
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2993 {
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2994 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2995 "Tag \"" + members[i] + "\" should be associated with a string");
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2996 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2997
3163 cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	2998 const std::string value = request[KEY_QUERY][members[i]].asString();
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	2999
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3000 if (!value.empty())
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3001 {
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3002 // An empty string corresponds to an universal constraint,
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3003 // so we ignore it. This mimics the behavior of class
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3004 // "OrthancFindRequestHandler"
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3005 query.AddRestConstraint(FromDcmtkBridge::ParseTag(members[i]),
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3006 value, caseSensitive, true);
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3007 }
1361 94ffb597d297 refactoring of C-Find SCP Sebastien Jodogne <s.jodogne@gmail.com> parents: 1360 diff changeset	3008 }
2876 ae8e72009e64 notes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2836 diff changeset	3009
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3010 FindVisitor visitor(OrthancRestApi::GetDicomFormat(request, DicomToJsonFormat_Human));
3033 5da6d1063d8f effectively replacing LookupResource by DatabaseLookup in searches Sebastien Jodogne <s.jodogne@gmail.com> parents: 3027 diff changeset	3011 context.Apply(visitor, query, level, since, limit);
5da6d1063d8f effectively replacing LookupResource by DatabaseLookup in searches Sebastien Jodogne <s.jodogne@gmail.com> parents: 3027 diff changeset	3012 visitor.Answer(call.GetOutput(), context.GetIndex(), level, expand);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3013 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3014 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3015
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3016
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3017 template <enum ResourceType start,
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3018 enum ResourceType end>
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3019 static void GetChildResources(RestApiGetCall& call)
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3020 {
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3021 if (call.IsDocumentation())
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3022 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3023 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3024
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3025 const std::string children = GetResourceTypeText(end, true /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3026 const std::string resource = GetResourceTypeText(start, false /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3027 call.GetDocumentation()
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3028 .SetTag(GetResourceTypeText(start, true /* plural /, true / upper case */))
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3029 .SetSummary("Get child " + children)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3030 .SetDescription("Get detailed information about the child " + children + " of the DICOM " +
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3031 resource + " whose Orthanc identifier is provided in the URL")
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3032 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3033 .AddAnswerType(MimeType_Json, "JSON array containing information about the child DICOM " + children)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3034 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(start) + "/" + children, 5);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3035 return;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3036 }
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3037
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3038 ServerIndex& index = OrthancRestApi::GetIndex(call);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3039
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3040 std::list<std::string> a, b, c;
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3041 a.push_back(call.GetUriComponent("id", ""));
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3042
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3043 ResourceType type = start;
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3044 while (type != end)
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3045 {
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3046 b.clear();
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3047
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3048 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	3049 it = a.begin(); it != a.end(); ++it)
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3050 {
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3051 index.GetChildren(c, *it);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3052 b.splice(b.begin(), c);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3053 }
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3054
1555 d6a93e12b1c1 Creation of DICOM files with encapsulated PDF Sebastien Jodogne <s.jodogne@gmail.com> parents: 1509 diff changeset	3055 type = GetChildResourceType(type);
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3056
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3057 a.clear();
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3058 a.splice(a.begin(), b);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3059 }
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3060
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3061 Json::Value result = Json::arrayValue;
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3062
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3063 const DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3064
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3065 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	3066 it = a.begin(); it != a.end(); ++it)
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3067 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3068 Json::Value resource;
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3069 if (OrthancRestApi::GetIndex(call).ExpandResource(resource, *it, end, format))
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3070 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3071 result.append(resource);
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3072 }
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3073 }
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3074
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3075 call.GetOutput().AnswerJson(result);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3076 }
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3077
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3078
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3079 static void GetChildInstancesTags(RestApiGetCall& call)
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3080 {
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3081 if (call.IsDocumentation())
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3082 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3083 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3084
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3085 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3086 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3087 call.GetDocumentation()
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3088 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3089 .SetSummary("Get tags of instances")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3090 .SetDescription("Get the tags of all the child instances of the DICOM " + r +
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3091 " whose Orthanc identifier is provided in the URL")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3092 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	3093 .SetHttpGetArgument(IGNORE_LENGTH, RestApiCallDocumentation::Type_JsonListOfStrings,
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3094 "Also include the DICOM tags that are provided in this list, even if their associated value is long", false)
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3095 .AddAnswerType(MimeType_Json, "JSON object associating the Orthanc identifiers of the instances, with the values of their DICOM tags")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3096 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(t) + "/instances-tags", 5);
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3097 return;
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3098 }
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3099
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3100 ServerContext& context = OrthancRestApi::GetContext(call);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3101 std::string publicId = call.GetUriComponent("id", "");
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3102 DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full);
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3103
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	3104 std::set<DicomTag> ignoreTagLength;
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	3105 ParseSetOfTags(ignoreTagLength, call, IGNORE_LENGTH);
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	3106
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3107 // Retrieve all the instances of this patient/study/series
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3108 typedef std::list<std::string> Instances;
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3109 Instances instances;
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3110
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3111 context.GetIndex().GetChildInstances(instances, publicId); // (*)
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3112
1201 09aa7c126be9 URIs 'instance-tags' now indexed by the instance IDs Sebastien Jodogne <s.jodogne@gmail.com> parents: 1172 diff changeset	3113 Json::Value result = Json::objectValue;
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3114
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3115 for (Instances::const_iterator it = instances.begin();
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	3116 it != instances.end(); ++it)
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3117 {
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3118 Json::Value full;
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	3119 context.ReadDicomAsJson(full, *it, ignoreTagLength);
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3120
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	3121 if (format != DicomToJsonFormat_Full)
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3122 {
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3123 Json::Value simplified;
4055 9214e3a7b0a2 moving FromDcmtkTests.cpp from OrthancServer to OrthancFramework Sebastien Jodogne <s.jodogne@gmail.com> parents: 4045 diff changeset	3124 Toolbox::SimplifyDicomAsJson(simplified, full, format);
1201 09aa7c126be9 URIs 'instance-tags' now indexed by the instance IDs Sebastien Jodogne <s.jodogne@gmail.com> parents: 1172 diff changeset	3125 result[*it] = simplified;
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3126 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3127 else
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3128 {
1201 09aa7c126be9 URIs 'instance-tags' now indexed by the instance IDs Sebastien Jodogne <s.jodogne@gmail.com> parents: 1172 diff changeset	3129 result[*it] = full;
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3130 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3131 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3132
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3133 call.GetOutput().AnswerJson(result);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3134 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3135
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3136
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3137
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3138 template <enum ResourceType start,
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3139 enum ResourceType end>
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3140 static void GetParentResource(RestApiGetCall& call)
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3141 {
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3142 assert(start > end);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3143
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3144 if (call.IsDocumentation())
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3145 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3146 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3147
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3148 const std::string parent = GetResourceTypeText(end, false /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3149 const std::string resource = GetResourceTypeText(start, false /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3150 call.GetDocumentation()
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3151 .SetTag(GetResourceTypeText(start, true /* plural /, true / upper case */))
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3152 .SetSummary("Get parent " + parent)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3153 .SetDescription("Get detailed information about the parent " + parent + " of the DICOM " +
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3154 resource + " whose Orthanc identifier is provided in the URL")
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3155 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3156 .AddAnswerType(MimeType_Json, "Information about the parent DICOM " + parent)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3157 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(start) + "/" + parent, 10);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3158 return;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3159 }
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3160
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3161 ServerIndex& index = OrthancRestApi::GetIndex(call);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3162
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3163 std::string current = call.GetUriComponent("id", "");
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3164 ResourceType currentType = start;
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3165 while (currentType > end)
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3166 {
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3167 std::string parent;
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3168 if (!index.LookupParent(parent, current))
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3169 {
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3170 // Error that could happen if the resource gets deleted by
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3171 // another concurrent call
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3172 return;
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3173 }
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3174
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3175 current = parent;
1555 d6a93e12b1c1 Creation of DICOM files with encapsulated PDF Sebastien Jodogne <s.jodogne@gmail.com> parents: 1509 diff changeset	3176 currentType = GetParentResourceType(currentType);
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3177 }
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3178
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3179 assert(currentType == end);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3180
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3181 const DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Human);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3182
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3183 Json::Value resource;
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3184 if (OrthancRestApi::GetIndex(call).ExpandResource(resource, current, end, format))
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3185 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3186 call.GetOutput().AnswerJson(resource);
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3187 }
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3188 }
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3189
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3190
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3191 static void ExtractPdf(RestApiGetCall& call)
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3192 {
4407 2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3193 if (call.IsDocumentation())
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3194 {
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3195 call.GetDocumentation()
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3196 .SetTag("Instances")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3197 .SetSummary("Get embedded PDF")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3198 .SetDescription("Get the PDF file that is embedded in one DICOM instance. "
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3199 "If the DICOM instance doesn't contain the `EncapsulatedDocument` tag or if the "
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3200 "`MIMETypeOfEncapsulatedDocument` tag doesn't correspond to the PDF type, a `404` HTTP error is raised.")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3201 .SetUriArgument("id", "Orthanc identifier of the instance interest")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3202 .AddAnswerType(MimeType_Pdf, "PDF file");
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3203 return;
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3204 }
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3205
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3206 const std::string id = call.GetUriComponent("id", "");
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3207 std::string pdf;
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3208 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), id);
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3209
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3210 if (locker.GetDicom().ExtractPdf(pdf))
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3211 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3212 call.GetOutput().AnswerBuffer(pdf, MimeType_Pdf);
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3213 return;
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3214 }
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3215 }
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3216
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3217
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3218 static void OrderSlices(RestApiGetCall& call)
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3219 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3220 if (call.IsDocumentation())
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3221 {
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3222 call.GetDocumentation()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3223 .SetDeprecated()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3224 .SetTag("Series")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3225 .SetSummary("Order the slices")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3226 .SetDescription("Sort the instances and frames (slices) of the DICOM series whose Orthanc identifier is provided in the URL. "
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3227 "This URI is essentially used by the Orthanc Web viewer and by the Osimis Web viewer.")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3228 .SetUriArgument("id", "Orthanc identifier of the series of interest")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3229 .SetAnswerField("Dicom", RestApiCallDocumentation::Type_JsonListOfStrings,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3230 "Ordered list of paths to DICOM instances")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3231 .SetAnswerField("Slices", RestApiCallDocumentation::Type_JsonListOfStrings,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3232 "Ordered list of paths to frames. It is recommended to use this field, as it is also valid "
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3233 "in the case of multiframe images.")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3234 .SetAnswerField("SlicesShort", RestApiCallDocumentation::Type_JsonListOfObjects,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3235 "Same information as the `Slices` field, but in a compact form")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3236 .SetAnswerField("Type", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3237 "Can be `Volume` (for 3D volumes) or `Sequence` (notably for cine images)")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3238 .SetTruncatedJsonHttpGetSample("https://demo.orthanc-server.com/series/1e2c125c-411b8e86-3f4fe68e-a7584dd3-c6da78f0/ordered-slices", 10);
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3239 return;
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3240 }
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3241
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3242 const std::string id = call.GetUriComponent("id", "");
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3243
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3244 ServerIndex& index = OrthancRestApi::GetIndex(call);
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3245 SliceOrdering ordering(index, id);
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3246
1703 b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1702 diff changeset	3247 Json::Value result;
b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1702 diff changeset	3248 ordering.Format(result);
b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1702 diff changeset	3249 call.GetOutput().AnswerJson(result);
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3250 }
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3251
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3252
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3253 static void GetInstanceHeader(RestApiGetCall& call)
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3254 {
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3255 if (call.IsDocumentation())
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3256 {
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3257 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3258 call.GetDocumentation()
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3259 .SetTag("Instances")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3260 .SetSummary("Get DICOM meta-header")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3261 .SetDescription("Get the DICOM tags in the meta-header of the DICOM instance. By default, the `full` format is used, which "
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3262 "combines hexadecimal tags with human-readable description.")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3263 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3264 .AddAnswerType(MimeType_Json, "JSON object containing the DICOM tags and their associated value")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3265 .SetHttpGetSample("https://demo.orthanc-server.com/instances/7c92ce8e-bbf67ed2-ffa3b8c1-a3b35d94-7ff3ae26/header", true);
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3266 return;
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3267 }
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3268
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3269 ServerContext& context = OrthancRestApi::GetContext(call);
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3270
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3271 std::string publicId = call.GetUriComponent("id", "");
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3272
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3273 std::string dicomContent;
4792 434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4777 diff changeset	3274 context.ReadDicomForHeader(dicomContent, publicId);
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3275
2007 655489d9165d DicomMap::ParseDicomMetaInformation() Sebastien Jodogne <s.jodogne@gmail.com> parents: 2003 diff changeset	3276 // TODO Consider using "DicomMap::ParseDicomMetaInformation()" to
655489d9165d DicomMap::ParseDicomMetaInformation() Sebastien Jodogne <s.jodogne@gmail.com> parents: 2003 diff changeset	3277 // speed up things here
655489d9165d DicomMap::ParseDicomMetaInformation() Sebastien Jodogne <s.jodogne@gmail.com> parents: 2003 diff changeset	3278
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3279 ParsedDicomFile dicom(dicomContent);
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3280
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3281 Json::Value header;
4140 0ddc5297a8ab centralization of default parameters for JSON/DicomMap conversions from DCMTK Sebastien Jodogne <s.jodogne@gmail.com> parents: 4139 diff changeset	3282 OrthancConfiguration::DefaultDicomHeaderToJson(header, dicom);
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3283
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3284 AnswerDicomAsJson(call, header, OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full));
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3285 }
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3286
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3287
2129 0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3288 static void InvalidateTags(RestApiPostCall& call)
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3289 {
4420 f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3290 if (call.IsDocumentation())
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3291 {
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3292 call.GetDocumentation()
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3293 .SetTag("System")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3294 .SetSummary("Invalidate DICOM-as-JSON summaries")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3295 .SetDescription("Remove all the attachments of the type \"DICOM-as-JSON\" that are associated will all the "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3296 "DICOM instances stored in Orthanc. These summaries will be automatically re-created on the next access. "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3297 "This is notably useful after changes to the `Dictionary` configuration option. "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3298 "https://book.orthanc-server.com/faq/orthanc-storage.html#storage-area");
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3299 return;
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3300 }
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3301
2129 0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3302 ServerIndex& index = OrthancRestApi::GetIndex(call);
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3303
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3304 // Loop over the instances, grouping them by parent studies so as
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3305 // to avoid large memory consumption
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3306 std::list<std::string> studies;
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3307 index.GetAllUuids(studies, ResourceType_Study);
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3308
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3309 for (std::list<std::string>::const_iterator
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3310 study = studies.begin(); study != studies.end(); ++study)
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3311 {
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3312 std::list<std::string> instances;
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3313 index.GetChildInstances(instances, *study);
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3314
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3315 for (std::list<std::string>::const_iterator
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3316 instance = instances.begin(); instance != instances.end(); ++instance)
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3317 {
4640 66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	3318 index.DeleteAttachment(*instance, FileContentType_DicomAsJson,
66109d24d26e "ETag" headers for metadata and attachments now allow strong comparison (MD5 is included) Sebastien Jodogne <s.jodogne@gmail.com> parents: 4627 diff changeset	3319 false /* no revision checks /, -1 / dummy /, "" / dummy */);
2129 0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3320 }
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3321 }
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3322
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3323 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
2129 0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3324 }
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3325
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3326
2209 e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3327 template <enum ResourceType type>
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3328 static void ReconstructResource(RestApiPostCall& call)
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3329 {
4420 f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3330 if (call.IsDocumentation())
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3331 {
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3332 const std::string resource = GetResourceTypeText(type, false /* plural /, false / lower case */);
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3333 call.GetDocumentation()
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3334 .SetTag(GetResourceTypeText(type, true /* plural /, true / upper case */))
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3335 .SetSummary("Reconstruct tags of " + resource)
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3336 .SetDescription("Reconstruct the main DICOM tags of the " + resource + " whose Orthanc identifier is provided "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3337 "in the URL. This is useful if child studies/series/instances have inconsistent values for "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3338 "higher-level tags, in order to force Orthanc to use the value from the resource of interest. "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3339 "Beware that this is a time-consuming operation, as all the children DICOM instances will be "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3340 "parsed again, and the Orthanc index will be updated accordingly.")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3341 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest");
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3342 return;
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3343 }
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3344
2209 e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3345 ServerContext& context = OrthancRestApi::GetContext(call);
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3346 ServerToolbox::ReconstructResource(context, call.GetUriComponent("id", ""));
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3347 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
2209 e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3348 }
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3349
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3350
2804 d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3351 static void ReconstructAllResources(RestApiPostCall& call)
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3352 {
4420 f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3353 if (call.IsDocumentation())
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3354 {
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3355 call.GetDocumentation()
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3356 .SetTag("System")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3357 .SetSummary("Reconstruct all the index")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3358 .SetDescription("Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3359 "This is notably useful after the deletion of resources whose children resources have inconsistent "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3360 "values with their sibling resources. Beware that this is a highly time-consuming operation, "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3361 "as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated.");
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3362 return;
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3363 }
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3364
2804 d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3365 ServerContext& context = OrthancRestApi::GetContext(call);
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3366
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3367 std::list<std::string> studies;
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3368 context.GetIndex().GetAllUuids(studies, ResourceType_Study);
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3369
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3370 for (std::list<std::string>::const_iterator
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3371 study = studies.begin(); study != studies.end(); ++study)
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3372 {
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3373 ServerToolbox::ReconstructResource(context, *study);
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3374 }
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3375
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3376 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
2804 d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3377 }
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3378
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3379
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3380 static void GetBulkChildren(std::set<std::string>& target,
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3381 ServerIndex& index,
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3382 const std::set<std::string>& source)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3383 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3384 target.clear();
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3385
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3386 for (std::set<std::string>::const_iterator
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3387 it = source.begin(); it != source.end(); ++it)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3388 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3389 std::list<std::string> children;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3390 index.GetChildren(children, *it);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3391
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3392 for (std::list<std::string>::const_iterator
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3393 child = children.begin(); child != children.end(); ++child)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3394 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3395 target.insert(*child);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3396 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3397 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3398 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3399
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3400
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3401 static void AddMetadata(Json::Value& target,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3402 ServerIndex& index,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3403 const std::string& resource,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3404 ResourceType level)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3405 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3406 target = Json::objectValue;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3407
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3408 std::map<MetadataType, std::string> content;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3409 index.GetAllMetadata(content, resource, level);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3410
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3411 for (std::map<MetadataType, std::string>::const_iterator
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3412 it = content.begin(); it != content.end(); ++it)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3413 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3414 target[EnumerationToString(it->first)] = it->second;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3415 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3416 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3417
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3418
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3419 static void BulkContent(RestApiPostCall& call)
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3420 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3421 static const char* const LEVEL = "Level";
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3422 static const char* const METADATA = "Metadata";
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3423
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3424 if (call.IsDocumentation())
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3425 {
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3426 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3427
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3428 call.GetDocumentation()
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3429 .SetTag("System")
4879 c728d8f25e5a fix doc Alain Mazy <am@osimis.io> parents: 4858 diff changeset	3430 .SetSummary("Describe a set of resources")
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3431 .SetRequestField("Resources", RestApiCallDocumentation::Type_JsonListOfStrings,
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3432 "List of the Orthanc identifiers of the patients/studies/series/instances of interest.", true)
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3433 .SetRequestField(LEVEL, RestApiCallDocumentation::Type_String,
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3434 "This optional argument specifies the level of interest (can be `Patient`, `Study`, `Series` or "
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3435 "`Instance`). Orthanc will loop over the items inside `Resources`, and explorer upward or "
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3436 "downward in the DICOM hierarchy in order to find the level of interest.", false)
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3437 .SetRequestField(METADATA, RestApiCallDocumentation::Type_Boolean,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3438 "If set to `true` (default value), the metadata associated with the resources will also be retrieved.", false)
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3439 .SetDescription("Get the content all the DICOM patients, studies, series or instances "
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3440 "whose identifiers are provided in the `Resources` field, in one single call.");
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3441 return;
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3442 }
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3443
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3444 Json::Value request;
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3445 if (!call.ParseJsonRequest(request) \|\|
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3446 request.type() != Json::objectValue)
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3447 {
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3448 throw OrthancException(ErrorCode_BadRequest,
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3449 "The body must contain a JSON object");
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3450 }
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3451 else
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3452 {
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3453 const DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(request, DicomToJsonFormat_Human);
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3454
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3455 bool metadata = true;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3456 if (request.isMember(METADATA))
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3457 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3458 metadata = SerializationToolbox::ReadBoolean(request, METADATA);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3459 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3460
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3461 ServerIndex& index = OrthancRestApi::GetIndex(call);
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3462
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3463 Json::Value answer = Json::arrayValue;
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3464
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3465 if (request.isMember(LEVEL))
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3466 {
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3467 // Complex case: Need to explore the DICOM hierarchy
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3468 ResourceType level = StringToResourceType(SerializationToolbox::ReadString(request, LEVEL).c_str());
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3469
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3470 std::set<std::string> resources;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3471 SerializationToolbox::ReadSetOfStrings(resources, request, "Resources");
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3472
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3473 std::set<std::string> interest;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3474
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3475 assert(ResourceType_Patient < ResourceType_Study &&
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3476 ResourceType_Study < ResourceType_Series &&
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3477 ResourceType_Series < ResourceType_Instance);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3478
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3479 for (std::set<std::string>::const_iterator
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3480 it = resources.begin(); it != resources.end(); ++it)
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3481 {
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3482 ResourceType type;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3483 if (index.LookupResourceType(type, *it))
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3484 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3485 if (type == level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3486 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3487 // This resource is already from the level of interest
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3488 interest.insert(*it);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3489 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3490 else if (type < level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3491 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3492 // Need to explore children
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3493 std::set<std::string> current;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3494 current.insert(*it);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3495
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3496 for (;;)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3497 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3498 std::set<std::string> children;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3499 GetBulkChildren(children, index, current);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3500
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3501 type = GetChildResourceType(type);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3502 if (type == level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3503 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3504 for (std::set<std::string>::const_iterator
4716 758fe3ffb336 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4714 diff changeset	3505 it2 = children.begin(); it2 != children.end(); ++it2)
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3506 {
4716 758fe3ffb336 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4714 diff changeset	3507 interest.insert(*it2);
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3508 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3509
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3510 break; // done
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3511 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3512 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3513 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3514 current.swap(children);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3515 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3516 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3517 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3518 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3519 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3520 // Need to explore parents
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3521 std::string current = *it;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3522
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3523 for (;;)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3524 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3525 std::string parent;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3526 if (index.LookupParent(parent, current))
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3527 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3528 type = GetParentResourceType(type);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3529 if (type == level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3530 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3531 interest.insert(parent);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3532 break; // done
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3533 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3534 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3535 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3536 current = parent;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3537 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3538 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3539 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3540 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3541 break; // The resource has been deleted during the exploration
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3542 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3543 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3544 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3545 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3546 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3547 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3548 CLOG(INFO, HTTP) << "Unknown resource during a bulk content retrieval: " << *it;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3549 }
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3550 }
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3551
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3552 for (std::set<std::string>::const_iterator
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3553 it = interest.begin(); it != interest.end(); ++it)
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3554 {
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3555 Json::Value item;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3556 if (index.ExpandResource(item, *it, level, format))
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3557 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3558 if (metadata)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3559 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3560 AddMetadata(item[METADATA], index, *it, level);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3561 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3562
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3563 answer.append(item);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3564 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3565 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3566 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3567 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3568 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3569 // Simple case: We return the queried resources as such
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3570 std::list<std::string> resources;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3571 SerializationToolbox::ReadListOfStrings(resources, request, "Resources");
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3572
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3573 for (std::list<std::string>::const_iterator
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3574 it = resources.begin(); it != resources.end(); ++it)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3575 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3576 ResourceType level;
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3577 Json::Value item;
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3578 if (index.LookupResourceType(level, *it) &&
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3579 index.ExpandResource(item, *it, level, format))
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3580 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3581 if (metadata)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3582 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3583 AddMetadata(item[METADATA], index, *it, level);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3584 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3585
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3586 answer.append(item);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3587 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3588 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3589 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3590 CLOG(INFO, HTTP) << "Unknown resource during a bulk content retrieval: " << *it;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3591 }
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3592 }
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3593 }
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3594
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3595 call.GetOutput().AnswerJson(answer);
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3596 }
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3597 }
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3598
d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3599
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3600 static void BulkDelete(RestApiPostCall& call)
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3601 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3602 if (call.IsDocumentation())
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3603 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3604 call.GetDocumentation()
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3605 .SetTag("System")
4879 c728d8f25e5a fix doc Alain Mazy <am@osimis.io> parents: 4858 diff changeset	3606 .SetSummary("Delete a set of resources")
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3607 .SetRequestField("Resources", RestApiCallDocumentation::Type_JsonListOfStrings,
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3608 "List of the Orthanc identifiers of the patients/studies/series/instances of interest.", true)
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3609 .SetDescription("Delete all the DICOM patients, studies, series or instances "
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3610 "whose identifiers are provided in the `Resources` field.");
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3611 return;
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3612 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3613
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3614 ServerContext& context = OrthancRestApi::GetContext(call);
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3615
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3616 Json::Value request;
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3617 if (!call.ParseJsonRequest(request) \|\|
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3618 request.type() != Json::objectValue)
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3619 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3620 throw OrthancException(ErrorCode_BadRequest,
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3621 "The body must contain a JSON object");
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3622 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3623 else
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3624 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3625 std::set<std::string> resources;
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3626 SerializationToolbox::ReadSetOfStrings(resources, request, "Resources");
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3627
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3628 for (std::set<std::string>::const_iterator
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3629 it = resources.begin(); it != resources.end(); ++it)
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3630 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3631 ResourceType type;
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3632 Json::Value remainingAncestor; // Unused
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3633
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3634 if (!context.GetIndex().LookupResourceType(type, *it) \|\|
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3635 !context.DeleteResource(remainingAncestor, *it, type))
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3636 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3637 CLOG(INFO, HTTP) << "Unknown resource during a bulk deletion: " << *it;
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3638 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3639 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3640
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3641 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3642 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3643 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3644
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3645
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3646 void OrthancRestApi::RegisterResources()
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3647 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3648 Register("/instances", ListResources<ResourceType_Instance>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3649 Register("/patients", ListResources<ResourceType_Patient>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3650 Register("/series", ListResources<ResourceType_Series>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3651 Register("/studies", ListResources<ResourceType_Study>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3652
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3653 Register("/instances/{id}", DeleteSingleResource<ResourceType_Instance>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3654 Register("/instances/{id}", GetSingleResource<ResourceType_Instance>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3655 Register("/patients/{id}", DeleteSingleResource<ResourceType_Patient>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3656 Register("/patients/{id}", GetSingleResource<ResourceType_Patient>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3657 Register("/series/{id}", DeleteSingleResource<ResourceType_Series>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3658 Register("/series/{id}", GetSingleResource<ResourceType_Series>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3659 Register("/studies/{id}", DeleteSingleResource<ResourceType_Study>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3660 Register("/studies/{id}", GetSingleResource<ResourceType_Study>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3661
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3662 Register("/instances/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3663 Register("/patients/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3664 Register("/studies/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3665 Register("/series/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3666
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	3667 Register("/patients/{id}/shared-tags", GetSharedTags);
cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	3668 Register("/series/{id}/shared-tags", GetSharedTags);
cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	3669 Register("/studies/{id}/shared-tags", GetSharedTags);
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	3670
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3671 Register("/instances/{id}/module", GetModule<ResourceType_Instance, DicomModule_Instance>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3672 Register("/patients/{id}/module", GetModule<ResourceType_Patient, DicomModule_Patient>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3673 Register("/series/{id}/module", GetModule<ResourceType_Series, DicomModule_Series>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3674 Register("/studies/{id}/module", GetModule<ResourceType_Study, DicomModule_Study>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3675 Register("/studies/{id}/module-patient", GetModule<ResourceType_Study, DicomModule_Patient>);
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	3676
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3677 Register("/instances/{id}/file", GetInstanceFile);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3678 Register("/instances/{id}/export", ExportInstanceFile);
4697 569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3679 Register("/instances/{id}/tags", GetInstanceTags);
569d9ef165b1 Added "short", "simplify" and/or "full" options to control the format of DICOM tags wherever possible Sebastien Jodogne <s.jodogne@gmail.com> parents: 4694 diff changeset	3680 Register("/instances/{id}/simplified-tags", GetInstanceSimplifiedTags);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3681 Register("/instances/{id}/frames", ListFrames);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3682
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4422 diff changeset	3683 Register("/instances/{id}/frames/{frame}", RestApi::AutoListChildren);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3684 Register("/instances/{id}/frames/{frame}/preview", GetImage<ImageExtractionMode_Preview>);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	3685 Register("/instances/{id}/frames/{frame}/rendered", GetRenderedFrame);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3686 Register("/instances/{id}/frames/{frame}/image-uint8", GetImage<ImageExtractionMode_UInt8>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3687 Register("/instances/{id}/frames/{frame}/image-uint16", GetImage<ImageExtractionMode_UInt16>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3688 Register("/instances/{id}/frames/{frame}/image-int16", GetImage<ImageExtractionMode_Int16>);
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	3689 Register("/instances/{id}/frames/{frame}/matlab", GetMatlabImage);
2408 26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	3690 Register("/instances/{id}/frames/{frame}/raw", GetRawFrame<false>);
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	3691 Register("/instances/{id}/frames/{frame}/raw.gz", GetRawFrame<true>);
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	3692 Register("/instances/{id}/frames/{frame}/numpy", GetNumpyFrame); // New in Orthanc 1.9.8
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3693 Register("/instances/{id}/pdf", ExtractPdf);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3694 Register("/instances/{id}/preview", GetImage<ImageExtractionMode_Preview>);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	3695 Register("/instances/{id}/rendered", GetRenderedFrame);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3696 Register("/instances/{id}/image-uint8", GetImage<ImageExtractionMode_UInt8>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3697 Register("/instances/{id}/image-uint16", GetImage<ImageExtractionMode_UInt16>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3698 Register("/instances/{id}/image-int16", GetImage<ImageExtractionMode_Int16>);
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	3699 Register("/instances/{id}/matlab", GetMatlabImage);
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3700 Register("/instances/{id}/header", GetInstanceHeader);
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	3701 Register("/instances/{id}/numpy", GetNumpyInstance); // New in Orthanc 1.9.8
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3702
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3703 Register("/patients/{id}/protected", IsProtectedPatient);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3704 Register("/patients/{id}/protected", SetPatientProtection);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3705
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3706 std::vector<std::string> resourceTypes;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3707 resourceTypes.push_back("patients");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3708 resourceTypes.push_back("studies");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3709 resourceTypes.push_back("series");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3710 resourceTypes.push_back("instances");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3711
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3712 for (size_t i = 0; i < resourceTypes.size(); i++)
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3713 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3714 Register("/" + resourceTypes[i] + "/{id}/metadata", ListMetadata);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3715 Register("/" + resourceTypes[i] + "/{id}/metadata/{name}", DeleteMetadata);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3716 Register("/" + resourceTypes[i] + "/{id}/metadata/{name}", GetMetadata);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3717 Register("/" + resourceTypes[i] + "/{id}/metadata/{name}", SetMetadata);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3718
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3719 Register("/" + resourceTypes[i] + "/{id}/attachments", ListAttachments);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3720 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}", DeleteAttachment);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3721 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}", GetAttachmentOperations);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3722 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}", UploadAttachment);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3723 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compress", ChangeAttachmentCompression<CompressionType_ZlibWithSize>);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3724 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compressed-data", GetAttachmentData<0>);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3725 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compressed-md5", GetAttachmentCompressedMD5);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3726 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compressed-size", GetAttachmentCompressedSize);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3727 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/data", GetAttachmentData<1>);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3728 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/is-compressed", IsAttachmentCompressed);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3729 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/md5", GetAttachmentMD5);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3730 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/size", GetAttachmentSize);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3731 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/uncompress", ChangeAttachmentCompression<CompressionType_None>);
4883 504624b0a062 Added "/patients\|studies\|series\|instances/{...}/attachments/{...}/info" route to retrieve the full information about an attachment (size, type, MD5 and UUID) Alain Mazy <am@osimis.io> parents: 4880 diff changeset	3732 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/info", GetAttachmentInfo);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3733 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/verify-md5", VerifyAttachment);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3734 }
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	3735
2129 0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3736 Register("/tools/invalidate-tags", InvalidateTags);
1139 f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	3737 Register("/tools/lookup", Lookup);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3738 Register("/tools/find", Find);
1139 f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	3739
1140 94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3740 Register("/patients/{id}/studies", GetChildResources<ResourceType_Patient, ResourceType_Study>);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3741 Register("/patients/{id}/series", GetChildResources<ResourceType_Patient, ResourceType_Series>);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3742 Register("/patients/{id}/instances", GetChildResources<ResourceType_Patient, ResourceType_Instance>);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3743 Register("/studies/{id}/series", GetChildResources<ResourceType_Study, ResourceType_Series>);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3744 Register("/studies/{id}/instances", GetChildResources<ResourceType_Study, ResourceType_Instance>);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3745 Register("/series/{id}/instances", GetChildResources<ResourceType_Series, ResourceType_Instance>);
94c5f6623b3a URIs to get all the children of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1139 diff changeset	3746
1281 8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3747 Register("/studies/{id}/patient", GetParentResource<ResourceType_Study, ResourceType_Patient>);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3748 Register("/series/{id}/patient", GetParentResource<ResourceType_Series, ResourceType_Patient>);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3749 Register("/series/{id}/study", GetParentResource<ResourceType_Series, ResourceType_Study>);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3750 Register("/instances/{id}/patient", GetParentResource<ResourceType_Instance, ResourceType_Patient>);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3751 Register("/instances/{id}/study", GetParentResource<ResourceType_Instance, ResourceType_Study>);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3752 Register("/instances/{id}/series", GetParentResource<ResourceType_Instance, ResourceType_Series>);
8dac11c78d71 URIs to get all the parents of a given resource in a single REST call Sebastien Jodogne <s.jodogne@gmail.com> parents: 1276 diff changeset	3753
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3754 Register("/patients/{id}/instances-tags", GetChildInstancesTags);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3755 Register("/studies/{id}/instances-tags", GetChildInstancesTags);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3756 Register("/series/{id}/instances-tags", GetChildInstancesTags);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3757
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	3758 Register("/instances/{id}/content/*", GetRawContent);
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3759
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3760 Register("/series/{id}/ordered-slices", OrderSlices);
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	3761 Register("/series/{id}/numpy", GetNumpySeries); // New in Orthanc 1.9.8
2209 e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3762
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3763 Register("/patients/{id}/reconstruct", ReconstructResource<ResourceType_Patient>);
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3764 Register("/studies/{id}/reconstruct", ReconstructResource<ResourceType_Study>);
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3765 Register("/series/{id}/reconstruct", ReconstructResource<ResourceType_Series>);
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3766 Register("/instances/{id}/reconstruct", ReconstructResource<ResourceType_Instance>);
2804 d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3767 Register("/tools/reconstruct", ReconstructAllResources);
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3768
4698 d16c3c7f11ef new route "/tools/bulk-content" to get the content of a set of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 4697 diff changeset	3769 Register("/tools/bulk-content", BulkContent);
4694 da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3770 Register("/tools/bulk-delete", BulkDelete);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3771 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3772 }

Mercurial > hg > orthanc

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4883:504624b0a062