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

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4936:8422e4f99a18 more-tags

Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok

author	Alain Mazy <am@osimis.io>
date	Fri, 11 Mar 2022 17:38:16 +0100
parents	acd3f72e2a21
children	3f9b9865c8cc

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 * 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	14 * WITHOUT ANY WARRANTY; without even the implied warranty of
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 * General Public License for more details.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	17 *
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	18 * 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	19 * 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	20 **/
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	21
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	22
831 84513f2ee1f3 pch for unit tests and server Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	23 #include "../PrecompiledHeadersServer.h"
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	24 #include "OrthancRestApi.h"
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	25
4045 05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	26 #include "../../../OrthancFramework/Sources/Compression/GzipCompressor.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	27 #include "../../../OrthancFramework/Sources/DicomFormat/DicomImageInformation.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	28 #include "../../../OrthancFramework/Sources/DicomParsing/DicomWebJsonVisitor.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	29 #include "../../../OrthancFramework/Sources/DicomParsing/FromDcmtkBridge.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	30 #include "../../../OrthancFramework/Sources/DicomParsing/Internals/DicomImageDecoder.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	31 #include "../../../OrthancFramework/Sources/HttpServer/HttpContentNegociation.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	32 #include "../../../OrthancFramework/Sources/Images/Image.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	33 #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	34 #include "../../../OrthancFramework/Sources/Images/NumpyWriter.h"
4045 05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	35 #include "../../../OrthancFramework/Sources/Logging.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	36 #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	37 #include "../../../OrthancFramework/Sources/SerializationToolbox.h"
4045 05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	38
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	39 #include "../OrthancConfiguration.h"
3094 61da3c9b4121 cont reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 3085 diff changeset	40 #include "../Search/DatabaseLookup.h"
1437 02f5a3f5c0a0 access to the REST API from Lua Sebastien Jodogne <s.jodogne@gmail.com> parents: 1385 diff changeset	41 #include "../ServerContext.h"
2131 bb199bccdc45 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 2129 diff changeset	42 #include "../ServerToolbox.h"
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	43 #include "../SliceOrdering.h"
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	44
3687 e6d6f8d23d02 fix linking Sebastien Jodogne <s.jodogne@gmail.com> parents: 3686 diff changeset	45 // This "include" is mandatory for Release builds using Linux Standard Base
e6d6f8d23d02 fix linking Sebastien Jodogne <s.jodogne@gmail.com> parents: 3686 diff changeset	46 #include <boost/math/special_functions/round.hpp>
e6d6f8d23d02 fix linking Sebastien Jodogne <s.jodogne@gmail.com> parents: 3686 diff changeset	47
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	48
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	49 /**
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	50 * 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	51 * 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	52 * 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	53 **/
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	54 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	55
2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	56
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	57 static const std::string CHECK_REVISIONS = "CheckRevisions";
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	58
4722 2b4da0ee6b73 added missing documentation of "ignore-length" in "/instances/{id}/tags" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4716 diff changeset	59 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	60
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	61
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	62 namespace Orthanc
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	63 {
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	64 static std::string GetDocumentationSampleResource(ResourceType type)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	65 {
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	66 switch (type)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	67 {
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	68 case Orthanc::ResourceType_Instance:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	69 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	70 break;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	71
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	72 case Orthanc::ResourceType_Series:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	73 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	74 break;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	75
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	76 case Orthanc::ResourceType_Study:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	77 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	78 break;
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_Patient:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	81 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	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 default:
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	85 throw OrthancException(ErrorCode_ParameterOutOfRange);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	86 }
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
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	89
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	90 static void AnswerDicomAsJson(RestApiCall& call,
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	91 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	92 DicomToJsonFormat mode)
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	93 {
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	94 if (mode != DicomToJsonFormat_Full)
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	95 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	96 Json::Value simplified;
4055 9214e3a7b0a2 moving FromDcmtkTests.cpp from OrthancServer to OrthancFramework Sebastien Jodogne <s.jodogne@gmail.com> parents: 4045 diff changeset	97 Toolbox::SimplifyDicomAsJson(simplified, dicom, mode);
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	98 call.GetOutput().AnswerJson(simplified);
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	99 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	100 else
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	101 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	102 call.GetOutput().AnswerJson(dicom);
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	103 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	104 }
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	105
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	106
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	107 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	108 const RestApiGetCall& call,
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	109 const std::string& argument)
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	110 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	111 target.clear();
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	112
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	113 if (call.HasArgument(argument))
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	114 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	115 std::vector<std::string> tags;
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	116 Toolbox::TokenizeString(tags, call.GetArgument(argument, ""), ',');
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 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	119 {
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	120 target.insert(FromDcmtkBridge::ParseTag(tags[i]));
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	121 }
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 }
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
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	126 // List all the patients, studies, series or instances ----------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	127
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	128 static void AnswerListOfResources(RestApiOutput& output,
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	129 ServerContext& context,
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	130 const std::list<std::string>& resources,
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	131 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	132 bool expand,
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	133 DicomToJsonFormat format,
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	134 const std::set<DicomTag>& requestedTags)
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	135 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	136 Json::Value answer = Json::arrayValue;
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	137
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	138 for (std::list<std::string>::const_iterator
1384 d6971e18a324 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1374 diff changeset	139 resource = resources.begin(); resource != resources.end(); ++resource)
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	140 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	141 if (expand)
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	142 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	143 Json::Value expanded;
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	144 if (context.ExpandResource(expanded, *resource, level, format, requestedTags))
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	145 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	146 answer.append(expanded);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	147 }
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 else
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	150 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	151 answer.append(*resource);
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	152 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	153 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	154
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	155 output.AnswerJson(answer);
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	156 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	157
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	158
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	159 template <enum ResourceType resourceType>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	160 static void ListResources(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161 {
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	162 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	163 {
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	164 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	165 OrthancRestApi::DocumentRequestedTags(call);
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	166
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	167 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	168 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	169 .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	170 .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	171 .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	172 .SetHttpGetArgument("limit", RestApiCallDocumentation::Type_Number, "Limit the number of results", false)
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	173 .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	174 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	175 "If present, retrieve detailed information about the individual " + resources, false)
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	176 .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	177 "about the reported " + resources + " (if `expand` argument is provided)")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	178 .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	179 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	180 }
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
1342 9ec7ac03152d "?expand" flag for URIs "/patients", "/studies" and "/series" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	182 ServerIndex& index = OrthancRestApi::GetIndex(call);
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	183 ServerContext& context = OrthancRestApi::GetContext(call);
1342 9ec7ac03152d "?expand" flag for URIs "/patients", "/studies" and "/series" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	184
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	185 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	186
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	187 std::set<DicomTag> requestedTags;
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	188 OrthancRestApi::GetRequestedTags(requestedTags, call);
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	189
1509 0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	190 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	191 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	192 {
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	193 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	194 {
2955 bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	195 throw OrthancException(ErrorCode_BadRequest,
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	196 "Missing \"limit\" argument for GET request against: " +
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	197 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	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
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	200 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	201 {
2955 bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	202 throw OrthancException(ErrorCode_BadRequest,
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	203 "Missing \"since\" argument for GET request against: " +
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	204 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	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
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	207 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	208 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	209 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	210 }
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	211 else
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 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	214 }
0586ed8897f1 limit and since arguments while retrieving DICOM resources in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	215
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	216 AnswerListOfResources(call.GetOutput(), context, result, resourceType, call.HasArgument("expand"),
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	217 OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Human),
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	218 requestedTags);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	220
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	221
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	222
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	223 template <enum ResourceType resourceType>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	224 static void GetSingleResource(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	225 {
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	226 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	227 {
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	228 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	229 OrthancRestApi::DocumentRequestedTags(call);
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	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 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	232 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	233 .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	234 .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	235 .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	236 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	237 .AddAnswerType(MimeType_Json, "Information about the DICOM " + resource)
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	238 .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	239 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	240 }
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	241
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	242 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	243
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	244 std::set<DicomTag> requestedTags;
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	245 OrthancRestApi::GetRequestedTags(requestedTags, call);
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	246
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	247 Json::Value json;
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	248 if (OrthancRestApi::GetContext(call).ExpandResource(
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	249 json, call.GetUriComponent("id", ""), resourceType, format, requestedTags))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	250 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	251 call.GetOutput().AnswerJson(json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	252 }
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 template <enum ResourceType resourceType>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	256 static void DeleteSingleResource(RestApiDeleteCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	257 {
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	258 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	259 {
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 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	261 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	262 .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	263 .SetSummary("Delete some " + resource)
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	264 .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	265 .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	266 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	267 }
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
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	269 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	270 if (OrthancRestApi::GetContext(call).DeleteResource(remainingAncestor, call.GetUriComponent("id", ""), resourceType))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	271 {
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	272 call.GetOutput().AnswerJson(remainingAncestor);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	273 }
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 // Get information about a single patient -----------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	278
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	279 static void IsProtectedPatient(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	280 {
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	281 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	282 {
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 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	284 .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	285 .SetSummary("Is the patient protected against recycling?")
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	286 .SetUriArgument("id", "Orthanc identifier of the patient of interest")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	287 .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	288 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	289 }
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
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	291 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	292 bool isProtected = OrthancRestApi::GetIndex(call).IsProtectedPatient(publicId);
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	293 call.GetOutput().AnswerBuffer(isProtected ? "1" : "0", MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	294 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	297 static void SetPatientProtection(RestApiPutCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	298 {
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	299 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	300 {
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 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	302 .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	303 .SetSummary("Protect one patient against recycling")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	304 .SetDescription("Check out configuration options `MaximumStorageSize` and `MaximumPatientCount`")
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	305 .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	306 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	307 }
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
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	310
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312
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	313 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	314 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	315 }
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 // Get information about a single instance ----------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	320 static void GetInstanceFile(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	321 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	322 if (call.IsDocumentation())
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	323 {
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	324 call.GetDocumentation()
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	325 .SetTag("Instances")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	326 .SetSummary("Download DICOM")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	327 .SetDescription("Download one DICOM instance")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	328 .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	329 .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	330 .AddAnswerType(MimeType_Dicom, "The DICOM instance")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	331 .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	332 .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	333 return;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	334 }
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	335
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	336 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	337
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338 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	339
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4294 diff changeset	340 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	341 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	342 {
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 // 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	344 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	345 {
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 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	347
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 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	349 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	350 {
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 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	352
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 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	355 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	356 }
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 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	359 {
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 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	361 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	362 }
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 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	364 {
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 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	366 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	367 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	368 }
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 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	371 }
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 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	374 {
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
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	378 context.AnswerAttachment(call.GetOutput(), publicId, FileContentType_Dicom);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	379 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	382 static void ExportInstanceFile(RestApiPostCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	383 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	384 if (call.IsDocumentation())
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	385 {
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	386 call.GetDocumentation()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	387 .SetTag("Instances")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	388 .SetSummary("Write DICOM onto filesystem")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	389 .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	390 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	391 .AddRequestType(MimeType_PlainText, "Target path on the filesystem");
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	392 return;
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	393 }
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	394
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	395 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	396
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	397 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	398
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	399 std::string dicom;
2124 2b1520efa282 cleaning up Sebastien Jodogne <s.jodogne@gmail.com> parents: 2122 diff changeset	400 context.ReadDicom(dicom, publicId);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	401
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	402 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	403 call.BodyToString(target);
2140 aa4b8895cd23 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 2136 diff changeset	404 SystemToolbox::WriteFile(dicom, target);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	405
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	406 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	407 }
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
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	410 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	411 static void GetInstanceTagsInternal(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	412 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	413 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	414
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	415 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	416
e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	417 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	418 ParseSetOfTags(ignoreTagLength, call, IGNORE_LENGTH);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	419
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	420 if (format != DicomToJsonFormat_Full \|\|
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	421 !ignoreTagLength.empty())
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	422 {
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	423 Json::Value full;
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	424 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	425 AnswerDicomAsJson(call, full, format);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	426 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	427 else
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	428 {
3973 d86bddb50972 fix spelling errors according to debian Sebastien Jodogne <s.jodogne@gmail.com> parents: 3928 diff changeset	429 // 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	430 // 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	431 // is present
4513 1f455b86b054 simplification in ServerContext Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	432 Json::Value full;
2127 bfa92c9328d7 cleaning up Sebastien Jodogne <s.jodogne@gmail.com> parents: 2124 diff changeset	433 context.ReadDicomAsJson(full, publicId);
4513 1f455b86b054 simplification in ServerContext Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	434 call.GetOutput().AnswerJson(full);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	435 }
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
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	438
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	439 static void GetInstanceTags(RestApiGetCall& call)
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	440 {
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	441 if (call.IsDocumentation())
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	442 {
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	443 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	444 call.GetDocumentation()
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	445 .SetTag("Instances")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	446 .SetSummary("Get DICOM tags")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	447 .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	448 "combines hexadecimal tags with human-readable description.")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	449 .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	450 .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	451 "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	452 .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	453 .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	454 return;
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	455 }
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	456
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	457 switch (OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full))
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	458 {
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	459 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	460 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	461 break;
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	462
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	463 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	464 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	465 break;
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	466
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	467 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	468 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	469 break;
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	470
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	471 default:
3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	472 throw OrthancException(ErrorCode_InternalError);
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	473 }
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
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	476
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	477 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	478 {
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 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	480 {
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 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	482 .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	483 .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	484 .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	485 .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	486 .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	487 "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	488 .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	489 .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	490 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	491 }
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 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	493 {
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 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	495 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	499 static void ListFrames(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	500 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	501 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	502 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	503 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	504 .SetTag("Instances")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	505 .SetSummary("List available frames")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	506 .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	507 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	508 .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	509 .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	510 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	511 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	512
1950 533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	513 std::string publicId = call.GetUriComponent("id", "");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	514
1950 533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	515 unsigned int numberOfFrames;
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	516
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 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	519 numberOfFrames = locker.GetDicom().GetFramesCount();
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	520 }
1950 533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	521
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	522 Json::Value result = Json::arrayValue;
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	523 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	524 {
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	525 result.append(i);
533ff46e944b return a single raw frame from DICOM videos Sebastien Jodogne <s.jodogne@gmail.com> parents: 1929 diff changeset	526 }
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 call.GetOutput().AnswerJson(result);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	529 }
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
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	532 namespace
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	533 {
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	534 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	535 {
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 private:
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	537 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	538 ImageExtractionMode mode_;
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	539 bool invert_;
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	540 MimeType format_;
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	541 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	542
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 public:
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	544 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	545 ImageExtractionMode mode,
e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	546 bool invert) :
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	547 image_(image),
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	548 mode_(mode),
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	549 invert_(invert),
d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	550 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	551 {
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
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	554 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	555 {
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	556 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	557 }
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
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	559 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	560 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	561 format_ = MimeType_Png;
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	562 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	563 }
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
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	565 void EncodeUsingPam()
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	566 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	567 format_ = MimeType_Pam;
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	568 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	569 }
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	570
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	571 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	572 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	573 format_ = MimeType_Jpeg;
2281 e002430baa41 Fix issue #44 (Bad interpretation of photometric interpretation MONOCHROME1) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2244 diff changeset	574 DicomImageDecoder::ExtractJpegImage(answer_, image_, mode_, invert_, quality);
1824 b530c3dfe2a6 refactoring image decoding Sebastien Jodogne <s.jodogne@gmail.com> parents: 1784 diff changeset	575 }
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	576 };
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	577
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	578 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	579 {
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 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	581 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	582
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 public:
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	584 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	585 {
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 }
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	587
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	588 virtual void Handle(const std::string& type,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	589 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	590 {
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 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	592 assert(subtype == "png");
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	593 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	594 }
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
2699 52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	597 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	598 {
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	599 private:
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	600 ImageToEncode& image_;
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	601
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	602 public:
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	603 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	604 {
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 virtual void Handle(const std::string& type,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	608 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	609 {
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	610 assert(type == "image");
2780 d4e81e0a8324 fix am@osimis.io parents: 2726 diff changeset	611 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	612 image_.EncodeUsingPam();
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes am@osimis.io parents: 2622 diff changeset	613 }
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
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	616 class EncodeJpeg : public HttpContentNegociation::IHandler
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	617 {
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	618 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	619 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	620 unsigned int quality_;
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	621
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	622 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	623 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	624 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	625 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	626 {
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 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	628 bool ok = false;
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	629
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	630 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	631 {
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 quality_ = boost::lexical_cast<unsigned int>(v);
1847 559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	633 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	634 }
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 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	636 {
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 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	640 {
2955 bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	641 throw OrthancException(
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	642 ErrorCode_BadRequest,
bbfd95a0c429 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	643 "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	644 }
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 virtual void Handle(const std::string& type,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	648 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	649 {
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 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	651 assert(subtype == "jpeg");
1902 8b0ee8d5e6d0 Refactoring leading to speedups with custom image decoders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	652 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	653 }
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 };
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	655 }
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
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	658 namespace
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	659 {
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	660 class IDecodedFrameHandler : public boost::noncopyable
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	661 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	662 public:
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	663 virtual ~IDecodedFrameHandler()
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	664 {
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
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	667 // "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	668 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	669 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	670 const ParsedDicomFile* dicom,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	671 unsigned int frame) = 0;
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	672
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	673 virtual bool RequiresDicomTags() const = 0;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	674
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	675 static void Apply(RestApiGetCall& call,
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	676 IDecodedFrameHandler& handler,
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	677 ImageExtractionMode mode /* for generation of documentation */,
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	678 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	679 {
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	680 if (call.IsDocumentation())
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	681 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	682 std::string m;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	683 if (!isRendered)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	684 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	685 switch (mode)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	686 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	687 case ImageExtractionMode_Preview:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	688 m = "preview";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	689 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	690 case ImageExtractionMode_UInt8:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	691 m = "uint8";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	692 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	693 case ImageExtractionMode_UInt16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	694 m = "uint16";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	695 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	696 case ImageExtractionMode_Int16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	697 m = "int16";
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	698 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	699 default:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	700 throw OrthancException(ErrorCode_ParameterOutOfRange);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	701 }
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 std::string description;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	705 std::string verb = (isRendered ? "Render" : "Decode");
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	706
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	707 if (call.HasUriComponent("frame"))
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	708 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	709 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	710 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	711 .SetSummary(verb + " a frame" + (m.empty() ? "" : " (" + m + ")"))
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	712 .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	713 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	714 else
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	715 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	716 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	717 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	718 .SetSummary(verb + " an image" + (m.empty() ? "" : " (" + m + ")"));
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	719 }
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 if (isRendered)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	722 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	723 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	724 "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	725 "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	726 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	727 .SetHttpGetArgument("window-center",RestApiCallDocumentation::Type_Number, "Windowing center", false)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	728 .SetHttpGetArgument("window-width",RestApiCallDocumentation::Type_Number, "Windowing width", false)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	729 .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	730 .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	731 .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	732 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	733 else
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	734 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	735 switch (mode)
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	736 {
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	737 case ImageExtractionMode_Preview:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	738 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	739 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	740 case ImageExtractionMode_UInt8:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	741 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	742 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	743 case ImageExtractionMode_UInt16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	744 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	745 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	746 case ImageExtractionMode_Int16:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	747 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	748 "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	749 break;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	750 default:
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	751 throw OrthancException(ErrorCode_ParameterOutOfRange);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	752 }
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 call.GetDocumentation()
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	756 .SetTag("Instances")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	757 .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	758 .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	759 .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	760 .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	761 .AddAnswerType(MimeType_Png, "PNG image")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	762 .AddAnswerType(MimeType_Jpeg, "JPEG image")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	763 .AddAnswerType(MimeType_Pam, "PAM image (Portable Arbitrary Map)")
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	764 .SetDescription(description);
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	765
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	766 return;
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	767 }
4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	768
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	769 ServerContext& context = OrthancRestApi::GetContext(call);
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	770
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	771 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	772
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	773 unsigned int frame;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	774 try
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	775 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	776 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	777 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	778 catch (boost::bad_lexical_cast&)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	779 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	780 return;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	781 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	782
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	783 std::unique_ptr<ImageAccessor> decoded;
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	784
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	785 try
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	786 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	787 std::string publicId = call.GetUriComponent("id", "");
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	788
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	789 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	790
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	791 if (decoded.get() == NULL)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	792 {
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	793 throw OrthancException(ErrorCode_NotImplemented,
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	794 "Cannot decode DICOM instance with ID: " + publicId);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	795 }
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 if (handler.RequiresDicomTags())
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	798 {
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 * Retrieve a summary of the DICOM tags, which is
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	801 * necessary to deal with MONOCHROME1 photometric
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	802 * interpretation, and with windowing parameters.
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	803 **/
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	804 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	805 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	806 }
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	807 else
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	808 {
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	809 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	810 }
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 catch (OrthancException& e)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	813 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	814 if (e.GetErrorCode() == ErrorCode_ParameterOutOfRange \|\|
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	815 e.GetErrorCode() == ErrorCode_UnknownResource)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	816 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	817 // 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	818 // instance, the resource is not existent
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	819 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	820 else
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	821 {
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	822 if (call.HasArgument("returnUnsupportedImage"))
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	823 {
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	824 std::string root = "";
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	825 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	826 {
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	827 root += "../";
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	828 }
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 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	831 }
4804 ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	832 else
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	833 {
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	834 call.GetOutput().SignalError(HttpStatus_415_UnsupportedMediaType);
ae643f664628 new option returnUnsupportedImage for /preview & /rendered routes Alain Mazy <am@osimis.io> parents: 4777 diff changeset	835 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	836 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	837 return;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	838 }
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 }
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	841
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 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	844 std::unique_ptr<ImageAccessor>& decoded,
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	845 ImageExtractionMode mode,
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	846 bool invert)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	847 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	848 ImageToEncode image(decoded, mode, invert);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	849
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	850 HttpContentNegociation negociation;
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	851 EncodePng png(image);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	852 negociation.Register(MIME_PNG, png);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	853
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	854 EncodeJpeg jpeg(image, call);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	855 negociation.Register(MIME_JPEG, jpeg);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	856
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	857 EncodePam pam(image);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	858 negociation.Register(MIME_PAM, pam);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	859
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	860 if (negociation.Apply(call.GetHttpHeaders()))
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	861 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	862 image.Answer(call.GetOutput());
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	863 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	864 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	865 };
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	866
4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	867
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	868 class GetImageHandler : public IDecodedFrameHandler
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	869 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	870 private:
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	871 ImageExtractionMode mode_;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	872
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	873 public:
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	874 explicit GetImageHandler(ImageExtractionMode mode) :
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	875 mode_(mode)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	876 {
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 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	880 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	881 const ParsedDicomFile* dicom,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	882 unsigned int frame) ORTHANC_OVERRIDE
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	883 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	884 bool invert = false;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	885
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	886 if (mode_ == ImageExtractionMode_Preview)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	887 {
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	888 if (dicom == NULL)
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	889 {
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	890 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	891 }
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 DicomMap tags;
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	894 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	895
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	896 DicomImageInformation info(tags);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	897 invert = (info.GetPhotometricInterpretation() == PhotometricInterpretation_Monochrome1);
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	898 }
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	899
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	900 DefaultHandler(call, decoded, mode_, invert);
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	901 }
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 virtual bool RequiresDicomTags() const ORTHANC_OVERRIDE
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	904 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	905 return mode_ == ImageExtractionMode_Preview;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	906 }
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
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	909
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	910 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	911 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	912 private:
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	913 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	914 double& windowCenter /* inout */,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	915 unsigned int& argWidth,
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	916 unsigned int& argHeight,
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	917 bool& smooth,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	918 const RestApiGetCall& call)
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	919 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	920 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	921 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	922 static const char* ARG_WIDTH = "width";
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	923 static const char* ARG_HEIGHT = "height";
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	924 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	925
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	926 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	927 !SerializationToolbox::ParseDouble(windowWidth, call.GetArgument(ARG_WINDOW_WIDTH, "")))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	928 {
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	929 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	930 "Bad value for argument: " + std::string(ARG_WINDOW_WIDTH));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	931 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	932
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	933 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	934 !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	935 {
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	936 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	937 "Bad value for argument: " + std::string(ARG_WINDOW_CENTER));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	938 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	939
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	940 argWidth = 0;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	941 argHeight = 0;
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	942
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	943 if (call.HasArgument(ARG_WIDTH))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	944 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	945 try
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	946 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	947 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	948 if (tmp < 0)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	949 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	950 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	951 "Argument cannot be negative: " + std::string(ARG_WIDTH));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	952 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	953 else
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	954 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	955 argWidth = static_cast<unsigned int>(tmp);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	956 }
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 catch (boost::bad_lexical_cast&)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	959 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	960 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	961 "Bad value for argument: " + std::string(ARG_WIDTH));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	962 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	963 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	964
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	965 if (call.HasArgument(ARG_HEIGHT))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	966 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	967 try
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	968 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	969 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	970 if (tmp < 0)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	971 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	972 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	973 "Argument cannot be negative: " + std::string(ARG_HEIGHT));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	974 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	975 else
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	976 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	977 argHeight = static_cast<unsigned int>(tmp);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	978 }
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 catch (boost::bad_lexical_cast&)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	981 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	982 throw OrthancException(ErrorCode_ParameterOutOfRange,
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	983 "Bad value for argument: " + std::string(ARG_HEIGHT));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	984 }
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
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	987 smooth = false;
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	988
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	989 if (call.HasArgument(ARG_SMOOTH))
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	990 {
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	991 smooth = RestApiCall::ParseBoolean(call.GetArgument(ARG_SMOOTH, ""));
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	992 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	993 }
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 public:
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	997 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	998 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	999 const ParsedDicomFile* dicom,
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1000 unsigned int frame) ORTHANC_OVERRIDE
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1001 {
4769 9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1002 if (dicom == NULL)
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1003 {
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1004 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	1005 }
9da6ca57a977 IDecodedFrameHandler can access full ParsedDicomFile instead of the DicomMap summary Sebastien Jodogne <s.jodogne@gmail.com> parents: 4722 diff changeset	1006
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1007 PhotometricInterpretation photometric;
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1008 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	1009 photometric == PhotometricInterpretation_Monochrome1);
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1010
3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1011 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	1012 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	1013 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	1014
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1015 unsigned int argWidth, argHeight;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1016 bool smooth;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1017 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	1018
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1019 unsigned int targetWidth = decoded->GetWidth();
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1020 unsigned int targetHeight = decoded->GetHeight();
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1021
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1022 if (decoded->GetWidth() != 0 &&
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1023 decoded->GetHeight() != 0)
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1024 {
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1025 float ratio = 1;
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1026
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1027 if (argWidth != 0 &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1028 argHeight != 0)
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1029 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1030 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	1031 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	1032 ratio = std::min(ratioX, ratioY);
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1033 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1034 else if (argWidth != 0)
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1035 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1036 ratio = static_cast<float>(argWidth) / static_cast<float>(decoded->GetWidth());
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1037 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1038 else if (argHeight != 0)
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1039 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1040 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	1041 }
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 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	1044 targetHeight = boost::math::iround(ratio * static_cast<float>(decoded->GetHeight()));
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1045 }
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1046
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1047 if (decoded->GetFormat() == PixelFormat_RGB24)
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1048 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1049 if (targetWidth == decoded->GetWidth() &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1050 targetHeight == decoded->GetHeight())
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1051 {
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1052 DefaultHandler(call, decoded, ImageExtractionMode_Preview, false);
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1053 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1054 else
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1055 {
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	1056 std::unique_ptr<ImageAccessor> resized(
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1057 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	1058
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1059 if (smooth &&
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1060 (targetWidth < decoded->GetWidth() \|\|
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1061 targetHeight < decoded->GetHeight()))
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1062 {
4065 d6362b2c4b61 export dcmdata in shared library, rounding in convolution tests Sebastien Jodogne <s.jodogne@gmail.com> parents: 4055 diff changeset	1063 ImageProcessing::SmoothGaussian5x5(decoded, false / be fast, don't round */);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1064 }
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1065
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1066 ImageProcessing::Resize(resized, decoded);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1067 DefaultHandler(call, resized, ImageExtractionMode_Preview, false);
3685 2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1068 }
2cc34837d694 rendering of RGB24 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3683 diff changeset	1069 }
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1070 else
a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1071 {
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1072 // 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	1073 // 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	1074
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1075 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	1076 ImageProcessing::Convert(converted, *decoded);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1077
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1078 // Avoid divisions by zero
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1079 if (windowWidth <= 1.0f)
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1080 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1081 windowWidth = 1;
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1082 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1083
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1084 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	1085 {
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1086 rescaleSlope = 0.0001;
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1087 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1088
4777 3b78ba359db3 Support detection of windowing and rescale in Philips multiframe images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4769 diff changeset	1089 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	1090 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	1091
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	1092 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	1093 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	1094
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1095 if (targetWidth == decoded->GetWidth() &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1096 targetHeight == decoded->GetHeight())
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1097 {
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1098 DefaultHandler(call, rescaled, ImageExtractionMode_UInt8, invert);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1099 }
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1100 else
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1101 {
3712 2a170a8f1faf replacing std::auto_ptr by std::unique_ptr Sebastien Jodogne <s.jodogne@gmail.com> parents: 3690 diff changeset	1102 std::unique_ptr<ImageAccessor> resized(
3690 a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1103 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	1104
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1105 if (smooth &&
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1106 (targetWidth < decoded->GetWidth() \|\|
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1107 targetHeight < decoded->GetHeight()))
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1108 {
4065 d6362b2c4b61 export dcmdata in shared library, rounding in convolution tests Sebastien Jodogne <s.jodogne@gmail.com> parents: 4055 diff changeset	1109 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	1110 }
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 ImageProcessing::Resize(resized, rescaled);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1113 DefaultHandler(call, resized, ImageExtractionMode_UInt8, invert);
a9ce35d67c3c implementation of "/instances/.../rendered" for grayscale images Sebastien Jodogne <s.jodogne@gmail.com> parents: 3687 diff changeset	1114 }
3686 a79aecf1f9ae cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3685 diff changeset	1115 }
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1116 }
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 virtual bool RequiresDicomTags() const ORTHANC_OVERRIDE
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1119 {
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1120 return true;
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1121 }
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1122 };
3600 4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	1123 }
4066998150ef /instances/{id}/preview route now takes the windowing into account Alain Mazy <alain@mazy.be> parents: 3203 diff changeset	1124
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1125
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1126 template <enum ImageExtractionMode mode>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1127 static void GetImage(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1128 {
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1129 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	1130
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1131 GetImageHandler handler(mode);
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	1132 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	1133 }
1906 d7c1cb559431 optimization for multi-frame images Sebastien Jodogne <s.jodogne@gmail.com> parents: 1902 diff changeset	1134
1826 ac5b0b4e2434 refactoring of DicomImageDecoder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1824 diff changeset	1135
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1136 static void GetRenderedFrame(RestApiGetCall& call)
12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1137 {
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1138 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	1139
3683 12253ddefe5a skeleton for new route: /instances/{id}/rendered Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1140 RenderedFrameHandler handler;
4406 4cb9f66a1c7c documenting generation of images Sebastien Jodogne <s.jodogne@gmail.com> parents: 4405 diff changeset	1141 IDecodedFrameHandler::Apply(call, handler, ImageExtractionMode_Preview /* arbitrary value */, true);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1142 }
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
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1145 static void DocumentSharedNumpy(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1146 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1147 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1148 .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	1149 .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	1150 .SetHttpGetArgument("rescale", RestApiCallDocumentation::Type_Boolean,
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1151 "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	1152 .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	1153 }
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 namespace
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1157 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1158 class NumpyVisitor : public boost::noncopyable
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1159 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1160 private:
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1161 bool rescale_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1162 unsigned int depth_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1163 unsigned int currentDepth_;
4858 8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1164 unsigned int width_;
4834 bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1165 unsigned int height_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1166 PixelFormat format_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1167 ChunkedBuffer buffer_;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1168
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1169 public:
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1170 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	1171 bool rescale) :
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1172 rescale_(rescale),
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1173 depth_(depth),
4858 8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1174 currentDepth_(0),
8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1175 width_(0), // dummy initialization
8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1176 height_(0), // dummy initialization
8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1177 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	1178 {
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
4858 8b51d65584f0 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4853 diff changeset	1181 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	1182 unsigned int frame)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1183 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1184 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	1185
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1186 if (decoded.get() == NULL)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1187 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1188 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	1189 }
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 if (currentDepth_ == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1192 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1193 width_ = decoded->GetWidth();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1194 height_ = decoded->GetHeight();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1195 format_ = decoded->GetFormat();
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1196 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1197 else if (width_ != decoded->GetWidth() \|\|
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1198 height_ != decoded->GetHeight())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1199 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1200 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	1201 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1202 else if (format_ != decoded->GetFormat())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1203 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1204 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	1205 }
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 if (rescale_ &&
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1208 decoded->GetFormat() != PixelFormat_RGB24)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1209 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1210 if (currentDepth_ == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1211 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1212 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	1213 }
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 double rescaleIntercept, rescaleSlope;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1216 dicom.GetRescale(rescaleIntercept, rescaleSlope, frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1217
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1218 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	1219 ImageProcessing::Convert(converted, *decoded);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1220 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	1221
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1222 NumpyWriter::WritePixels(buffer_, converted);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1223 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1224 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1225 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1226 if (currentDepth_ == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1227 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1228 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	1229 }
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 NumpyWriter::WritePixels(buffer_, *decoded);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1232 }
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 currentDepth_ ++;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1235 }
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 void Answer(RestApiOutput& output,
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1238 bool compress)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1239 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1240 if ((depth_ == 0 && currentDepth_ != 1) \|\|
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1241 (depth_ != 0 && currentDepth_ != depth_))
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1242 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1243 throw OrthancException(ErrorCode_BadSequenceOfCalls);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1244 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1245 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1246 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1247 std::string answer;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1248 NumpyWriter::Finalize(answer, buffer_, compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1249 output.AnswerBuffer(answer, MimeType_Binary);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1250 }
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 static void GetNumpyFrame(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1257 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1258 if (call.IsDocumentation())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1259 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1260 DocumentSharedNumpy(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1261 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1262 .SetTag("Instances")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1263 .SetSummary("Decode frame for numpy")
4836 ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1264 .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	1265 "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	1266 .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	1267 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1268 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1269 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1270 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	1271 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	1272 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	1273
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1274 uint32_t frame;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1275 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	1276 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1277 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	1278 }
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 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	1281
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 Semaphore::Locker throttling(throttlingSemaphore_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1284 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	1285
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1286 visitor.WriteFrame(locker.GetDicom(), frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1287 }
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 visitor.Answer(call.GetOutput(), compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1290 }
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 static void GetNumpyInstance(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1295 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1296 if (call.IsDocumentation())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1297 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1298 DocumentSharedNumpy(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1299 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1300 .SetTag("Instances")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1301 .SetSummary("Decode instance for numpy")
4836 ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1302 .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	1303 "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	1304 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1305 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1306 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1307 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	1308 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	1309 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	1310
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 Semaphore::Locker throttling(throttlingSemaphore_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1313 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	1314
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1315 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	1316 if (depth == 0)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1317 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1318 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	1319 }
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 NumpyVisitor visitor(depth, rescale);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1322
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1323 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	1324 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1325 visitor.WriteFrame(locker.GetDicom(), frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1326 }
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 visitor.Answer(call.GetOutput(), compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1329 }
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 static void GetNumpySeries(RestApiGetCall& call)
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1335 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1336 if (call.IsDocumentation())
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1337 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1338 DocumentSharedNumpy(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1339 call.GetDocumentation()
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1340 .SetTag("Series")
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1341 .SetSummary("Decode series for numpy")
4836 ec1e9571b645 document number of dimensions in numpy arrays Sebastien Jodogne <s.jodogne@gmail.com> parents: 4834 diff changeset	1342 .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	1343 "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	1344 }
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1345 else
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1346 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1347 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	1348 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	1349 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	1350
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1351 Semaphore::Locker throttling(throttlingSemaphore_);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1352
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1353 ServerIndex& index = OrthancRestApi::GetIndex(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1354 SliceOrdering ordering(index, seriesId);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1355
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1356 unsigned int depth = 0;
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1357 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	1358 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1359 depth += ordering.GetFramesCount(i);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1360 }
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 ServerContext& context = OrthancRestApi::GetContext(call);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1363
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1364 NumpyVisitor visitor(depth, rescale);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1365
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1366 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	1367 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1368 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	1369 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	1370
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 ServerContext::DicomCacheLocker locker(context, instanceId);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1373
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1374 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	1375 {
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1376 visitor.WriteFrame(locker.GetDicom(), frame);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1377 }
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 visitor.Answer(call.GetOutput(), compress);
bec432ee1094 download of numpy arrays from the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4831 diff changeset	1382 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1386 static void GetMatlabImage(RestApiGetCall& call)
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1387 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1388 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1389 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1390 std::string description;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1391
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1392 if (call.HasUriComponent("frame"))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1393 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1394 description = "Decode one frame of interest from the given DICOM instance";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1395 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1396 .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	1397 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1398 else
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1399 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1400 description = "Decode the first frame of the given DICOM instance.";
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1401 }
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 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1404 .SetTag("Instances")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1405 .SetSummary("Decode frame for Matlab")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1406 .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	1407 "https://book.orthanc-server.com/faq/matlab.html")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1408 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1409 .AddAnswerType(MimeType_PlainText, "Octave/Matlab matrix");
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1410 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1411 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1412
3926 2910b0d30fe0 Allow concurrent calls to the custom image decoders provided by the plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 3816 diff changeset	1413 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	1414
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1415 ServerContext& context = OrthancRestApi::GetContext(call);
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1416
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1417 std::string frameId = call.GetUriComponent("frame", "0");
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1418
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1419 unsigned int frame;
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1420 try
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1421 {
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1422 frame = boost::lexical_cast<unsigned int>(frameId);
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1423 }
2836 7133ad478eea fix Debian warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2804 diff changeset	1424 catch (boost::bad_lexical_cast&)
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1425 {
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1426 return;
87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1427 }
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 std::string publicId = call.GetUriComponent("id", "");
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1430 std::unique_ptr<ImageAccessor> decoded(context.DecodeDicomFrame(publicId, frame));
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1431
3928 4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1432 if (decoded.get() == NULL)
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1433 {
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1434 throw OrthancException(ErrorCode_NotImplemented,
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1435 "Cannot decode DICOM instance with ID: " + publicId);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1436 }
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1437 else
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1438 {
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1439 std::string result;
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1440 decoded->ToMatlabString(result);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1441 call.GetOutput().AnswerBuffer(result, MimeType_PlainText);
4cdc875510d1 ServerContext::DecodeDicomFrame() Sebastien Jodogne <s.jodogne@gmail.com> parents: 3926 diff changeset	1442 }
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	1443 }
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
2408 26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1446 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	1447 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	1448 {
4408 d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1449 if (call.IsDocumentation())
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1450 {
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1451 call.GetDocumentation()
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1452 .SetTag("Instances")
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1453 .SetSummary("Access raw frame" + std::string(GzipCompression ? " (compressed)" : ""))
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1454 .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	1455 "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	1456 "in compressed transfer syntaxes." +
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1457 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	1458 .SetUriArgument("id", "Orthanc identifier of the instance of interest")
4408 d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1459 .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	1460
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1461 if (GzipCompression)
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1462 {
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1463 call.GetDocumentation().AddAnswerType(MimeType_Gzip, "The raw frame, compressed using gzip");
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1464 }
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1465 else
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1466 {
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1467 call.GetDocumentation().AddAnswerType(MimeType_Binary, "The raw frame");
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1468 }
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1469 return;
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1470 }
d2bfadc2948b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4407 diff changeset	1471
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	1472 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	1473
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 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	1475 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	1476 {
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 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	1478 }
2836 7133ad478eea fix Debian warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2804 diff changeset	1479 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	1480 {
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 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	1482 }
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 std::string publicId = call.GetUriComponent("id", "");
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	1485 std::string raw;
9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	1486 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	1487
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 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	1490 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	1491 }
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
2408 26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1493 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	1494 {
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1495 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	1496 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	1497 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	1498 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	1499 }
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1500 else
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1501 {
26a0cc24d48d New URI: "/instances/.../frames/.../raw.gz" to compress raw frames using gzip Sebastien Jodogne <s.jodogne@gmail.com> parents: 2382 diff changeset	1502 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	1503 }
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	1504 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1507 static void GetResourceStatistics(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1508 {
4418 9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1509 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1510 {
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1511 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1512 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1513 call.GetDocumentation()
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1514 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1515 .SetSummary("Get " + r + " statistics")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1516 .SetDescription("Get statistics about the given " + r)
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1517 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1518 .SetAnswerField("DiskSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1519 "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	1520 .SetAnswerField("DiskSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1521 "Size of the " + r + " on the disk, expressed in megabytes (MB)")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1522 .SetAnswerField("UncompressedSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1523 "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	1524 .SetAnswerField("UncompressedSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1525 "Size of the " + r + " after decompression, expressed in megabytes (MB). "
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1526 "This is different from `DiskSizeMB` iff `StorageCompression` is `true`.")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1527 .SetAnswerField("DicomDiskSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1528 "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	1529 .SetAnswerField("DicomDiskSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1530 "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	1531 .SetAnswerField("DicomUncompressedSize", RestApiCallDocumentation::Type_String,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1532 "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	1533 .SetAnswerField("DicomUncompressedSizeMB", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1534 "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	1535 .SetHttpGetSample(GetDocumentationSampleResource(t) + "/statistics", true);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1536
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1537 switch (t)
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1538 {
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1539 // Do NOT add "break" below this point!
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1540 case ResourceType_Patient:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1541 call.GetDocumentation().SetAnswerField("CountStudies", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1542 "Number of child studies within this " + r);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1543
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1544 case ResourceType_Study:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1545 call.GetDocumentation().SetAnswerField("CountSeries", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1546 "Number of child series within this " + r);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1547
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1548 case ResourceType_Series:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1549 call.GetDocumentation().SetAnswerField("CountInstances", RestApiCallDocumentation::Type_Number,
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1550 "Number of child instances within this " + r);
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1551
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1552 case ResourceType_Instance:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1553 default:
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1554 break;
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1555 }
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 return;
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1558 }
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4416 diff changeset	1559
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1560 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	1561
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1562 std::string publicId = call.GetUriComponent("id", "");
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1563
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1564 ResourceType type;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1565 uint64_t diskSize, uncompressedSize, dicomDiskSize, dicomUncompressedSize;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1566 unsigned int countStudies, countSeries, countInstances;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1567 OrthancRestApi::GetIndex(call).GetResourceStatistics(
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1568 type, diskSize, uncompressedSize, countStudies, countSeries,
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1569 countInstances, dicomDiskSize, dicomUncompressedSize, publicId);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1570
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1571 Json::Value result = Json::objectValue;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1572 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	1573 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	1574 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	1575 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	1576
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1577 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	1578 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	1579 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	1580 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	1581
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1582 switch (type)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1583 {
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1584 // Do NOT add "break" below this point!
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1585 case ResourceType_Patient:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1586 result["CountStudies"] = countStudies;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1587
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1588 case ResourceType_Study:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1589 result["CountSeries"] = countSeries;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1590
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1591 case ResourceType_Series:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1592 result["CountInstances"] = countInstances;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1593
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1594 case ResourceType_Instance:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1595 default:
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1596 break;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1597 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3163 diff changeset	1598
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1599 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1600 }
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 // Handling of metadata -----------------------------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1605
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	1606 static void CheckValidResourceType(const RestApiCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1607 {
4460 6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1608 assert(!call.GetFullUri().empty());
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1609 const std::string resourceType = call.GetFullUri() [0];
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1610 StringToResourceType(resourceType.c_str());
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1611 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1614 static void ListMetadata(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1615 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1616 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1617 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1618 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1619 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1620 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1621 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1622 .SetSummary("List metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1623 .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	1624 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1625 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1626 "If present, also retrieve the value of the individual metadata", false)
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1627 .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	1628 "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	1629 .SetHttpGetSample(GetDocumentationSampleResource(t) + "/metadata", true);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1630 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1631 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1632
4460 6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1633 assert(!call.GetFullUri().empty());
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	1634 const std::string publicId = call.GetUriComponent("id", "");
efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	1635 ResourceType level = StringToResourceType(call.GetFullUri() [0].c_str());
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1636
350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1637 typedef std::map<MetadataType, std::string> Metadata;
350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1638
350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1639 Metadata metadata;
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	1640 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	1641
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1642 Json::Value result;
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1643
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1644 if (call.HasArgument("expand"))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1645 {
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1646 result = Json::objectValue;
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1647
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1648 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	1649 {
3187 4bbadcd03966 refactoring retrieval of metadata from database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	1650 std::string key = EnumerationToString(it->first);
4bbadcd03966 refactoring retrieval of metadata from database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	1651 result[key] = it->second;
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1652 }
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 else
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1655 {
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1656 result = Json::arrayValue;
46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1657
4551 350a22c094f2 testing replay of transactions Sebastien Jodogne <s.jodogne@gmail.com> parents: 4514 diff changeset	1658 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	1659 {
3187 4bbadcd03966 refactoring retrieval of metadata from database Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	1660 result.append(EnumerationToString(it->first));
2726 46061a91c88a new metadata (RemoteIP, CalledAET, HttpUsername), "?expand" metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2704 diff changeset	1661 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1662 }
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 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1665 }
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
4657 e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1668 static void SetStringContentETag(const RestApiOutput& output,
e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1669 int64_t revision,
e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1670 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	1671 {
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 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	1673 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	1674 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	1675 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	1676 }
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
4657 e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1679 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	1680 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	1681 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	1682 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	1683 {
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 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	1685 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	1686 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	1687 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	1688 }
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
4657 e8967149d87a cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4640 diff changeset	1691 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	1692 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	1693 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	1694 {
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 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	1696 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	1697 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	1698 }
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 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	1702 {
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 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	1704 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	1705 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	1706 }
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
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1709 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	1710 std::string& md5 /* out */,
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1711 const RestApiCall& call,
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1712 const std::string& header)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1713 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1714 std::string lower;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1715 Toolbox::ToLowerCase(lower, header);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1716
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1717 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	1718 if (found == call.GetHttpHeaders().end())
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1719 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1720 return false;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1721 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1722 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1723 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1724 std::string value = Toolbox::StripSpaces(found->second);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1725 Toolbox::RemoveSurroundingQuotes(value);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1726
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1727 try
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1728 {
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	1729 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	1730 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	1731 {
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 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	1733 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	1734 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	1735 }
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1736 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1737 catch (boost::bad_lexical_cast&)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1738 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1739 }
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	1740
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 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	1742 "\" 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	1743 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1747 static void GetMetadata(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1748 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1749 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1750 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1751 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1752 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1753 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1754 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1755 .SetSummary("Get metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1756 .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	1757 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1758 .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	1759 .AddAnswerType(MimeType_PlainText, "Value of the metadata")
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1760 .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	1761 .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	1762 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1763 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1764
4460 6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1765 assert(!call.GetFullUri().empty());
6831de40acd9 New metadata automatically computed at the series level: "RemoteAET" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1766 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	1767 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	1768
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1769 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1770 MetadataType metadata = StringToMetadata(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1771
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1772 std::string value;
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1773 int64_t revision;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1774 if (OrthancRestApi::GetIndex(call).LookupMetadata(value, revision, publicId, level, metadata))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1775 {
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	1776 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	1777
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1778 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	1779 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	1780 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	1781 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	1782 userMD5 == GetMD5(value))
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1783 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1784 call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1785 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1786 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1787 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1788 call.GetOutput().AnswerBuffer(value, MimeType_PlainText);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1789 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1790 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1794 static void DeleteMetadata(RestApiDeleteCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1795 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1796 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1797 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1798 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1799 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1800 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1801 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1802 .SetSummary("Delete metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1803 .SetDescription("Delete some metadata associated with the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1804 ". 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	1805 .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	1806 .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	1807 .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	1808 "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	1809 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1810 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1811
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1812 CheckValidResourceType(call);
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1813 const std::string publicId = call.GetUriComponent("id", "");
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1814
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1815 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1816 MetadataType metadata = StringToMetadata(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1817
1773 613df4362575 New UpdatedAttachment and UpdatedMetadata events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1759 diff changeset	1818 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	1819 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1820 bool found;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1821 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	1822 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	1823 if (GetRevisionHeader(revision, md5, call, "if-match"))
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1824 {
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	1825 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	1826 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1827 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1828 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1829 OrthancConfiguration::ReaderLock lock;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1830 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1831 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1832 throw OrthancException(ErrorCode_Revision,
4661 b1d87d41874e typo: replaced "CheckRevision" by "CheckRevisions" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4657 diff changeset	1833 "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	1834 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1835 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1836 {
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	1837 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	1838 }
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 if (found)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1842 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1843 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1844 }
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1845 else
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1846 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1847 throw OrthancException(ErrorCode_UnknownResource);
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1848 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1849 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1850 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1851 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1852 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	1853 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1854 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1857 static void SetMetadata(RestApiPutCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1858 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1859 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1860 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1861 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1862 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1863 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1864 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1865 .SetSummary("Set metadata")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1866 .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	1867 ". 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	1868 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1869 .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	1870 .AddRequestType(MimeType_PlainText, "String value of the metadata")
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1871 .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	1872 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1873 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	1874
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1875 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1876
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1877 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1878 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1879 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	1880
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	1881 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	1882 call.BodyToString(value);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1883
1773 613df4362575 New UpdatedAttachment and UpdatedMetadata events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1759 diff changeset	1884 if (IsUserMetadata(metadata)) // It is forbidden to modify internal metadata
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1885 {
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1886 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	1887 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	1888 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	1889
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1890 if (!hasOldRevision)
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1891 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1892 OrthancConfiguration::ReaderLock lock;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1893 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1894 {
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1895 // "StatelessDatabaseOperations::SetMetadata()" will ignore
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1896 // 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	1897 // inexistent as expected
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1898 hasOldRevision = true;
95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1899 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	1900 oldMD5.clear(); // dummy value
4623 95ffe3b6ef7c handling of revisions for metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 4589 diff changeset	1901 }
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 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	1905 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	1906 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	1907
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 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	1909 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1910 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1911 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1912 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	1913 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	1914 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1915 }
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 // Handling of attached files -----------------------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1921
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	1922 static void ListAttachments(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1923 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1924 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1925 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1926 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1927 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1928 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1929 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1930 .SetSummary("List attachments")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1931 .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	1932 .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	1933 .SetHttpGetArgument("full", RestApiCallDocumentation::Type_String,
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1934 "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	1935 .AddAnswerType(MimeType_Json, "JSON array containing the names of the attachments")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1936 .SetHttpGetSample(GetDocumentationSampleResource(t) + "/attachments", true);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1937 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1938 }
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 const std::string resourceType = call.GetFullUri() [0];
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	1941 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	1942 std::set<FileContentType> attachments;
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1943 OrthancRestApi::GetIndex(call).ListAvailableAttachments(attachments, publicId, StringToResourceType(resourceType.c_str()));
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1944
4853 b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1945 Json::Value result;
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1946
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1947 if (call.HasArgument("full"))
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1948 {
4853 b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1949 result = Json::objectValue;
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1950
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1951 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	1952 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	1953 {
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1954 std::string key = EnumerationToString(*it);
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1955 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	1956 }
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 else
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1959 {
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1960 result = Json::arrayValue;
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1961
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1962 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	1963 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	1964 {
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1965 result.append(EnumerationToString(*it));
b3d0a3a4d890 Added links to download attachments from the Orthanc Explorer Alain Mazy <am@osimis.io> parents: 4836 diff changeset	1966 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1967 }
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 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1970 }
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
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1973 static void AddAttachmentDocumentation(RestApiGetCall& call,
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1974 const std::string& resourceType)
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1975 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1976 call.GetDocumentation()
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1977 .SetUriArgument("id", "Orthanc identifier of the " + resourceType + " of interest")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1978 .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	1979 .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	1980 .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	1981 }
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 static bool GetAttachmentInfo(FileInfo& info,
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1985 RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1986 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1987 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1988
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1989 const std::string publicId = call.GetUriComponent("id", "");
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1990 const std::string name = call.GetUriComponent("name", "");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1991 FileContentType contentType = StringToContentType(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1992
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1993 int64_t revision;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1994 if (OrthancRestApi::GetIndex(call).LookupAttachment(info, revision, publicId, contentType))
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1995 {
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	1996 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	1997
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	1998 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	1999 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	2000 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	2001 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	2002 info.GetUncompressedMD5() == userMD5)
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2003 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2004 call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2005 return false;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2006 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2007 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2008 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2009 return true;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2010 }
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 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2013 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2014 throw OrthancException(ErrorCode_UnknownResource);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2015 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2016 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2019 static void GetAttachmentOperations(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2020 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2021 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2022 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2023 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2024 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	2025 AddAttachmentDocumentation(call, r);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2026 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2027 .SetTag("Other")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2028 .SetSummary("List operations on attachments")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2029 .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	2030 .AddAnswerType(MimeType_Json, "List of the available operations")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2031 .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	2032 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2033 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2034
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2035 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2036 if (GetAttachmentInfo(info, call))
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2037 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2038 Json::Value operations = Json::arrayValue;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2039
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2040 operations.append("compress");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2041 operations.append("compressed-data");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2042
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2043 if (info.GetCompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2044 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2045 operations.append("compressed-md5");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2046 }
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 operations.append("compressed-size");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2049 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	2050 operations.append("info");
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2051 operations.append("is-compressed");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2052
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2053 if (info.GetUncompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2054 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2055 operations.append("md5");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2056 }
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 operations.append("size");
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2059 operations.append("uncompress");
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2060
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2061 if (info.GetCompressedMD5() != "" &&
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2062 info.GetUncompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2063 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2064 operations.append("verify-md5");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2065 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2066
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	2067 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	2068
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2069 call.GetOutput().AnswerJson(operations);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2070 }
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 template <int uncompress>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2075 static void GetAttachmentData(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2076 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2077 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2078 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2079 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2080 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2081 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2082 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2083 .SetSummary("Get attachment" + std::string(uncompress ? "" : " (no decompression)"))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2084 .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	2085 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	2086 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2087 .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	2088 .AddAnswerType(MimeType_Binary, "The attachment")
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2089 .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	2090 .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	2091 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2092 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2093
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2094 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2095
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2096 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2097
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2098 std::string publicId = call.GetUriComponent("id", "");
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2099 FileContentType type = StringToContentType(call.GetUriComponent("name", ""));
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2100
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	2101 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	2102 if (GetAttachmentInfo(info, call))
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2103 {
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	2104 // 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	2105
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 if (uncompress)
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2107 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2108 context.AnswerAttachment(call.GetOutput(), publicId, type);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2109 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2110 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2111 {
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	2112 // 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	2113 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	2114 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	2115 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	2116
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 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	2118 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	2119 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	2120 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	2121 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	2122 {
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 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	2124 }
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 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	2126 {
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 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	2128 }
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2129 }
1146 200fcac0deb4 optimization for access to attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2130 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2131 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2134 static void GetAttachmentSize(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2135 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2136 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2137 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2138 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2139 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	2140 AddAttachmentDocumentation(call, r);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2141 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2142 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2143 .SetSummary("Get size of attachment")
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2144 .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	2145 .AddAnswerType(MimeType_PlainText, "The size of the attachment");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2146 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2147 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2148
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2149 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2150 if (GetAttachmentInfo(info, call))
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2151 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2152 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	2153 }
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
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	2156 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	2157 {
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 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	2159 {
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 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	2161 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	2162 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	2163 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	2164 .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	2165 .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	2166 .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	2167 .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	2168 .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	2169 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	2170 }
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 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	2173 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	2174 {
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 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	2176 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	2177 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	2178 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	2179 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	2180 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	2181 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	2182
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 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	2184 }
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 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2186
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2187 static void GetAttachmentCompressedSize(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2188 {
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2189 if (call.IsDocumentation())
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2190 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2191 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2192 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	2193 AddAttachmentDocumentation(call, r);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2194 call.GetDocumentation()
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2195 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2196 .SetSummary("Get size of attachment on disk")
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2197 .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	2198 "This is different from `.../size` iff `EnableStorage` is `true`.")
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2199 .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	2200 return;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2201 }
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	2202
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2203 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2204 if (GetAttachmentInfo(info, call))
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2205 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2206 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	2207 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2211 static void GetAttachmentMD5(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2212 {
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2213 if (call.IsDocumentation())
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2214 {
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2215 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2216 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	2217 AddAttachmentDocumentation(call, r);
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2218 call.GetDocumentation()
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2219 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2220 .SetSummary("Get MD5 of attachment")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2221 .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	2222 .AddAnswerType(MimeType_PlainText, "The MD5 of the attachment");
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2223 return;
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2224 }
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2225
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2226 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2227 if (GetAttachmentInfo(info, call) &&
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2228 info.GetUncompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2229 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2230 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	2231 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2235 static void GetAttachmentCompressedMD5(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2236 {
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2237 if (call.IsDocumentation())
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2238 {
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2239 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2240 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	2241 AddAttachmentDocumentation(call, r);
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2242 call.GetDocumentation()
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2243 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2244 .SetSummary("Get MD5 of attachment on disk")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2245 .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	2246 "This is different from `.../md5` iff `EnableStorage` is `true`.")
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2247 .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	2248 return;
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2249 }
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2250
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2251 FileInfo info;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2252 if (GetAttachmentInfo(info, call) &&
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2253 info.GetCompressedMD5() != "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2254 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2255 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	2256 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2260 static void VerifyAttachment(RestApiPostCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2261 {
4410 a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2262 if (call.IsDocumentation())
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2263 {
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2264 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2265 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2266 call.GetDocumentation()
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2267 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2268 .SetSummary("Verify attachment")
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2269 .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	2270 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2271 .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	2272 .AddAnswerType(MimeType_Json, "On success, a valid JSON object is returned");
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2273 return;
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2274 }
a6abe5f512db cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4409 diff changeset	2275
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2276 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2277 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2278
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2279 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2280 std::string name = call.GetUriComponent("name", "");
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2281 FileContentType contentType = StringToContentType(name);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2282
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2283 FileInfo info;
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2284 int64_t revision; // Ignored
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2285 if (!OrthancRestApi::GetIndex(call).LookupAttachment(info, revision, publicId, contentType) \|\|
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2286 info.GetCompressedMD5() == "" \|\|
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2287 info.GetUncompressedMD5() == "")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2288 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2289 // Inexistent resource, or no MD5 available
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2290 return;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2291 }
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 bool ok = false;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2294
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2295 // 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	2296 std::string data;
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2297 context.ReadAttachment(data, revision, publicId, StringToContentType(name), false);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2298
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2299 std::string actualMD5;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2300 Toolbox::ComputeMD5(actualMD5, data);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2301
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2302 if (actualMD5 == info.GetCompressedMD5())
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2303 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2304 // The compressed data is OK. If a compression algorithm was
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2305 // applied to it, now check the MD5 of the uncompressed data.
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2306 if (info.GetCompressionType() == CompressionType_None)
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2307 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2308 ok = true;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2309 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2310 else
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2311 {
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2312 context.ReadAttachment(data, revision, publicId, StringToContentType(name), true);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2313 Toolbox::ComputeMD5(actualMD5, data);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2314 ok = (actualMD5 == info.GetUncompressedMD5());
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2315 }
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 if (ok)
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2319 {
4294 0923247e69f6 log categories: rest -> http + added lua & jobs Alain Mazy <alain@mazy.be> parents: 4272 diff changeset	2320 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	2321 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2322 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2323 else
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2324 {
4294 0923247e69f6 log categories: rest -> http + added lua & jobs Alain Mazy <alain@mazy.be> parents: 4272 diff changeset	2325 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	2326 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2330 static void UploadAttachment(RestApiPutCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2331 {
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2332 if (call.IsDocumentation())
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2333 {
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2334 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2335 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2336 call.GetDocumentation()
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2337 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2338 .SetSummary("Set attachment")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2339 .SetDescription("Attach a file to the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2340 ". 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	2341 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2342 .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	2343 .AddRequestType(MimeType_Binary, "Binary data containing the attachment")
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2344 .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	2345 .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	2346 return;
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2347 }
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2348
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2349 ServerContext& context = OrthancRestApi::GetContext(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2350 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2351
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2352 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2353 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2354
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2355 FileContentType contentType = StringToContentType(name);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2356 if (IsUserContentType(contentType)) // It is forbidden to modify internal attachments
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2357 {
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2358 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	2359 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	2360 bool hasOldRevision = GetRevisionHeader(oldRevision, oldMD5, call, "if-match");
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2361
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2362 if (!hasOldRevision)
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2363 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2364 OrthancConfiguration::ReaderLock lock;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2365 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2366 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2367 // "StatelessDatabaseOperations::AddAttachment()" will ignore
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2368 // the actual value of "oldRevision" if the metadata is
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2369 // inexistent as expected
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2370 hasOldRevision = true;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2371 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	2372 oldMD5.clear(); // dummy value
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2373 }
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 int64_t newRevision;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2377 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	2378 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	2379
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 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	2381 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2382 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2383 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2384 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2385 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	2386 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2387 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2390 static void DeleteAttachment(RestApiDeleteCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2391 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2392 if (call.IsDocumentation())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2393 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2394 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2395 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2396 call.GetDocumentation()
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2397 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2398 .SetSummary("Delete attachment")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2399 .SetDescription("Delete an attachment associated with the given DICOM " + r +
d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2400 ". 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	2401 .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	2402 .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	2403 .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	2404 "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	2405 return;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2406 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2407
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2408 CheckValidResourceType(call);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2409
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2410 std::string publicId = call.GetUriComponent("id", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2411 std::string name = call.GetUriComponent("name", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2412 FileContentType contentType = StringToContentType(name);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2413
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2414 bool allowed;
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2415 if (IsUserContentType(contentType))
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2416 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2417 allowed = true;
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2418 }
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2419 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2420 {
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2421 OrthancConfiguration::ReaderLock lock;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2422
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2423 if (lock.GetConfiguration().GetBooleanParameter("StoreDicom", true) &&
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2424 contentType == FileContentType_DicomAsJson)
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2425 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2426 allowed = true;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2427 }
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2428 else
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2429 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2430 // 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	2431 // 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	2432 // 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	2433 allowed = false;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2935 diff changeset	2434 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2435 }
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 if (allowed)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2438 {
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2439 bool found;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2440 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	2441 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	2442 if (GetRevisionHeader(revision, md5, call, "if-match"))
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2443 {
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	2444 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	2445 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2446 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2447 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2448 OrthancConfiguration::ReaderLock lock;
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2449 if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2450 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2451 throw OrthancException(ErrorCode_Revision,
4661 b1d87d41874e typo: replaced "CheckRevision" by "CheckRevisions" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4657 diff changeset	2452 "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	2453 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2454 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2455 {
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	2456 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	2457 false, -1 /* dummy value /, "" / dummy value */);
4627 f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2458 }
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 if (found)
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2462 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2463 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2464 }
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2465 else
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2466 {
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2467 throw OrthancException(ErrorCode_UnknownResource);
f7d5372b59b3 handling revisions of attachments Sebastien Jodogne <s.jodogne@gmail.com> parents: 4623 diff changeset	2468 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2469 }
2128 9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2470 else
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2471 {
9329ba17a069 Possibility to DELETE "dicom-as-json" attachments to reconstruct them Sebastien Jodogne <s.jodogne@gmail.com> parents: 2127 diff changeset	2472 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	2473 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2474 }
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
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2477 template <enum CompressionType compression>
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2478 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	2479 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2480 if (call.IsDocumentation())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2481 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2482 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2483 std::string r = GetResourceTypeText(t, false /* plural /, false / upper case */);
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2484 call.GetDocumentation()
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2485 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2486 .SetSummary(compression == CompressionType_None ? "Uncompress attachment" : "Compress attachment")
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2487 .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	2488 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
4414 d928dfcacb4b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4413 diff changeset	2489 .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	2490 return;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2491 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2492
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2493 CheckValidResourceType(call);
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2494
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2495 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	2496 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	2497 FileContentType contentType = StringToContentType(name);
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2498
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2499 OrthancRestApi::GetContext(call).ChangeAttachmentCompression(publicId, contentType, compression);
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2500 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	2501 }
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 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	2505 {
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2506 if (call.IsDocumentation())
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2507 {
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2508 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2509 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	2510 AddAttachmentDocumentation(call, r);
4413 22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2511 call.GetDocumentation()
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2512 .SetTag(GetResourceTypeText(t, true /* plural /, true / upper case */))
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2513 .SetSummary("Is attachment compressed?")
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2514 .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	2515 .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	2516 return;
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2517 }
22a1352a0823 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4410 diff changeset	2518
1700 f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2519 FileInfo info;
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2520 if (GetAttachmentInfo(info, call))
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2521 {
f5ddbd9239dd New URIs for attachments: ".../compress", ".../uncompress" and ".../is-compressed" Sebastien Jodogne <s.jodogne@gmail.com> parents: 1556 diff changeset	2522 std::string answer = (info.GetCompressionType() == CompressionType_None) ? "0" : "1";
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	2523 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	2524 }
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
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2528 // Raw access to the DICOM tags of an instance ------------------------------
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2529
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2530 static void GetRawContent(RestApiGetCall& call)
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2531 {
4405 5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2532 if (call.IsDocumentation())
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2533 {
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2534 call.GetDocumentation()
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2535 .SetTag("Instances")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2536 .SetSummary("Get raw tag")
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2537 .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	2538 .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	2539 .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	2540 "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	2541 .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	2542 "(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	2543 "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	2544 return;
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2545 }
5466f336b09f gathering statistics about progress of api documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 4404 diff changeset	2546
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2547 std::string id = call.GetUriComponent("id", "");
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2548
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2549 ServerContext::DicomCacheLocker locker(OrthancRestApi::GetContext(call), id);
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2550
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2551 locker.GetDicom().SendPathValue(call.GetOutput(), call.GetTrailingUri());
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2552 }
a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	2553
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2554
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2555
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2556 static bool ExtractSharedTags(Json::Value& shared,
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2557 ServerContext& context,
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2558 const std::string& publicId)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2559 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2560 // 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	2561 typedef std::list<std::string> Instances;
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2562 Instances instances;
959 bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2563 context.GetIndex().GetChildInstances(instances, publicId); // (*)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2564
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2565 // Loop over the instances
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2566 bool isFirst = true;
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2567 shared = Json::objectValue;
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2568
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2569 for (Instances::const_iterator it = instances.begin();
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2570 it != instances.end(); ++it)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2571 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2572 // 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	2573 Json::Value tags;
959 bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2574
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2575 try
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2576 {
2124 2b1520efa282 cleaning up Sebastien Jodogne <s.jodogne@gmail.com> parents: 2122 diff changeset	2577 context.ReadDicomAsJson(tags, *it);
959 bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2578 }
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2579 catch (OrthancException&)
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2580 {
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2581 // Race condition: This instance has been removed since
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2582 // (*). Ignore this instance.
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2583 continue;
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2584 }
bd5659f2a50a fix possible race condition Sebastien Jodogne <s.jodogne@gmail.com> parents: 958 diff changeset	2585
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2586 if (tags.type() != Json::objectValue)
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2587 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2588 return false; // Error
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2589 }
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 // 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	2592 Json::Value::Members members = tags.getMemberNames();
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2593 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	2594 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2595 const Json::Value& tag = tags[members[i]];
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2596 if (tag.type() != Json::objectValue \|\|
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2597 tag["Type"].type() != Json::stringValue \|\|
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2598 tag["Type"].asString() != "String")
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2599 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2600 tags.removeMember(members[i]);
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2601 }
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 if (isFirst)
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2605 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2606 // 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	2607 shared = tags;
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2608 isFirst = false;
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2609 }
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2610 else
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2611 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2612 // 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	2613 // 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	2614 // value in the current instance, remove it.
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2615 members = shared.getMemberNames();
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2616 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	2617 {
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2618 if (!tags.isMember(members[i]) \|\|
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2619 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	2620 {
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2621 shared.removeMember(members[i]);
1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2622 }
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
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2627 return true;
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2628 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 964 diff changeset	2631 static void GetSharedTags(RestApiGetCall& call)
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2632 {
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2633 if (call.IsDocumentation())
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2634 {
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	2635 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	2636
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2637 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	2638 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	2639 call.GetDocumentation()
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2640 .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	2641 .SetSummary("Get shared tags")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2642 .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	2643 "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	2644 .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	2645 .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	2646 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(t) + "/shared-tags", 5);
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2647 return;
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2648 }
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	2649
960 abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2650 ServerContext& context = OrthancRestApi::GetContext(call);
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2651 std::string publicId = call.GetUriComponent("id", "");
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2652
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2653 Json::Value sharedTags;
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2654 if (ExtractSharedTags(sharedTags, context, publicId))
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2655 {
abac5c83134f simplified and extensive shared-tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 959 diff changeset	2656 // 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	2657 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	2658 }
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	2659 }
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
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	2662 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	2663 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	2664 static void GetModule(RestApiGetCall& call)
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2665 {
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	2666 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	2667 {
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 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	2669 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	2670 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	2671 {
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 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	2673 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	2674 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	2675 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	2676 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	2677 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	2678 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	2679 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	2680 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	2681 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	2682 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	2683 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	2684 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	2685 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	2686 }
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 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	2689
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 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	2691 .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	2692 .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	2693 .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	2694 .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	2695 .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	2696 "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	2697 .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	2698 .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	2699 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	2700 }
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
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2702 if (!((resourceType == ResourceType_Patient && module == DicomModule_Patient) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2703 (resourceType == ResourceType_Study && module == DicomModule_Patient) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2704 (resourceType == ResourceType_Study && module == DicomModule_Study) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2705 (resourceType == ResourceType_Series && module == DicomModule_Series) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2706 (resourceType == ResourceType_Instance && module == DicomModule_Instance) \|\|
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2707 (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	2708 {
1701dcb6f554 Access patient module at the study level to cope with PatientID collisions Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	2709 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	2710 }
1701dcb6f554 Access patient module at the study level to cope with PatientID collisions Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	2711
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2712 ServerContext& context = OrthancRestApi::GetContext(call);
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2713 std::string publicId = call.GetUriComponent("id", "");
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2714
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	2715 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	2716 ParseSetOfTags(ignoreTagLength, call, IGNORE_LENGTH);
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	2717
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2718 typedef std::set<DicomTag> ModuleTags;
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2719 ModuleTags moduleTags;
1368 b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2720 DicomTag::AddTagsForModule(moduleTags, module);
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2721
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2722 Json::Value tags;
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2723
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2724 if (resourceType != ResourceType_Instance)
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2725 {
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2726 // Retrieve all the instances of this patient/study/series
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2727 typedef std::list<std::string> Instances;
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2728 Instances instances;
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2729 context.GetIndex().GetChildInstances(instances, publicId);
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2730
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2731 if (instances.empty())
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2732 {
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2733 return; // Error: No instance (should never happen)
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2734 }
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 // Select one child instance
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2737 publicId = instances.front();
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2738 }
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2739
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	2740 context.ReadDicomAsJson(tags, publicId, ignoreTagLength);
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2741
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2742 // 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	2743 Json::Value result = Json::objectValue;
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2744 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	2745 {
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	2746 std::string s = tag->Format();
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2747 if (tags.isMember(s))
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2748 {
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2749 result[s] = tags[s];
81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2750 }
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
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	2753 AnswerDicomAsJson(call, result, OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full));
963 81134ea872ff retrieve values of modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 960 diff changeset	2754 }
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
1722 f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2757 namespace
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2758 {
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2759 typedef std::list< std::pair<ResourceType, std::string> > LookupResults;
f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2760 }
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 static void AccumulateLookupResults(LookupResults& result,
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2764 ServerIndex& index,
2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2765 const DicomTag& tag,
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2766 const std::string& value,
3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2767 ResourceType level)
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2768 {
3034 54e422fe31ce moving LookupResource to graveyard Sebastien Jodogne <s.jodogne@gmail.com> parents: 3033 diff changeset	2769 std::vector<std::string> tmp;
1728 4941494b5dd8 rename LookupIdentifier as LookupIdentifierExact Sebastien Jodogne <s.jodogne@gmail.com> parents: 1727 diff changeset	2770 index.LookupIdentifierExact(tmp, level, tag, value);
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2771
3034 54e422fe31ce moving LookupResource to graveyard Sebastien Jodogne <s.jodogne@gmail.com> parents: 3033 diff changeset	2772 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	2773 {
3034 54e422fe31ce moving LookupResource to graveyard Sebastien Jodogne <s.jodogne@gmail.com> parents: 3033 diff changeset	2774 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	2775 }
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2776 }
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
1139 f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2779 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	2780 {
4422 48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2781 if (call.IsDocumentation())
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2782 {
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2783 call.GetDocumentation()
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2784 .SetTag("System")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2785 .SetSummary("Look for DICOM identifiers")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2786 .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	2787 .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	2788 "`StudyInstanceUID`, `SeriesInstanceUID`, or `SOPInstanceUID`)")
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2789 .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	2790 "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	2791 "DICOM resource that is stored by Orthanc");
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2792 return;
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2793 }
48303e493135 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4421 diff changeset	2794
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	2795 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	2796 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	2797
1722 f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2798 LookupResults resources;
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2799 ServerIndex& index = OrthancRestApi::GetIndex(call);
1719 3b1f7e706d38 fix Orthanc.test_lookup Sebastien Jodogne <s.jodogne@gmail.com> parents: 1718 diff changeset	2800 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	2801 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	2802 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	2803 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	2804
2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2805 Json::Value result = Json::arrayValue;
1722 f1901004f3e4 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1719 diff changeset	2806 for (LookupResults::const_iterator
1718 2b812969e136 getting rid of an IDatabaseWrapper::LookupIdentifier flavor Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	2807 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	2808 {
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2809 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	2810 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	2811
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2812 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	2813 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	2814 item["ID"] = id;
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2815 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	2816
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2817 result.append(item);
f167b672db94 /tools/lookup URI to map DICOM UIDs to Orthanc identifiers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1054 diff changeset	2818 }
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 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	2821 }
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
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2824 namespace
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2825 {
3021 2cbafb5d5a62 renamed LookupResource::IVisitor as ServerContext::ILookupVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 3012 diff changeset	2826 class FindVisitor : public ServerContext::ILookupVisitor
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2827 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2828 private:
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2829 bool isComplete_;
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2830 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	2831 DicomToJsonFormat format_;
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2832
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2833 public:
4716 758fe3ffb336 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4714 diff changeset	2834 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	2835 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	2836 format_(format)
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2837 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2838 }
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2839
d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2840 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	2841 {
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 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	2843 }
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
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2845 virtual void MarkAsComplete() ORTHANC_OVERRIDE
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2846 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2847 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	2848 }
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 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	2851 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	2852 const DicomMap& mainDicomTags /* unused */,
4205 d962a2996637 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4140 diff changeset	2853 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	2854 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2855 resources_.push_back(publicId);
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2856 }
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 void Answer(RestApiOutput& output,
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2859 ServerContext& context,
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2860 ResourceType level,
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2861 bool expand,
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2862 const std::set<DicomTag>& requestedTags) const
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2863 {
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2864 AnswerListOfResources(output, context, resources_, level, expand, format_, requestedTags);
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";
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2877 static const char* const KEY_REQUESTED_TAGS = "RequestedTags";
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2878 static const char* const KEY_SINCE = "Since";
0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2879
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2880 if (call.IsDocumentation())
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2881 {
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	2882 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	2883
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2884 call.GetDocumentation()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2885 .SetTag("System")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2886 .SetSummary("Look for local resources")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2887 .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	2888 "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	2889 "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	2890 .SetRequestField(KEY_CASE_SENSITIVE, RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2891 "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	2892 .SetRequestField(KEY_EXPAND, RestApiCallDocumentation::Type_Boolean,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2893 "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	2894 .SetRequestField(KEY_LEVEL, RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2895 "Level of the query (`Patient`, `Study`, `Series` or `Instance`)", true)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2896 .SetRequestField(KEY_LIMIT, RestApiCallDocumentation::Type_Number,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2897 "Limit the number of reported resources", false)
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2898 .SetRequestField(KEY_SINCE, RestApiCallDocumentation::Type_Number,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2899 "Show only the resources since the provided index (in conjunction with `Limit`)", false)
4935 acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2900 .SetRequestField(KEY_REQUESTED_TAGS, RestApiCallDocumentation::Type_JsonListOfStrings,
acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2901 "A list of DICOM tags to include in the response (applicable only if \"Expand\" is set to true). "
acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2902 "The tags requested tags are returned in the 'RequestedTags' field in the response. "
acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2903 "Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response "
acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2904 "might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return "
acd3f72e2a21 split ExpandResource in 2: read from DB and serialize to json. This will allow us to merge requested tags from both the DB and the file system Alain Mazy <am@osimis.io> parents: 4902 diff changeset	2905 "all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.", false)
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2906 .SetRequestField(KEY_QUERY, RestApiCallDocumentation::Type_JsonObject,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2907 "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	2908 .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	2909 "about the reported resources (if `Expand` argument is `true`)");
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2910 return;
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2911 }
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	2912
1358 62d2d35b725e cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1356 diff changeset	2913 ServerContext& context = OrthancRestApi::GetContext(call);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2914
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2915 Json::Value request;
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2916 if (!call.ParseJsonRequest(request) \|\|
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2917 request.type() != Json::objectValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2918 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2919 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2920 "The body must contain a JSON object");
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2921 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2922 else if (!request.isMember(KEY_LEVEL) \|\|
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2923 request[KEY_LEVEL].type() != Json::stringValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2924 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2925 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2926 "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	2927 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2928 else if (!request.isMember(KEY_QUERY) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2929 request[KEY_QUERY].type() != Json::objectValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2930 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2931 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2932 "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	2933 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2934 else if (request.isMember(KEY_CASE_SENSITIVE) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2935 request[KEY_CASE_SENSITIVE].type() != Json::booleanValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2936 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2937 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2938 "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	2939 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2940 else if (request.isMember(KEY_LIMIT) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2941 request[KEY_LIMIT].type() != Json::intValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2942 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2943 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2944 "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	2945 }
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2946 else if (request.isMember(KEY_SINCE) &&
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2947 request[KEY_SINCE].type() != Json::intValue)
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2948 {
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2949 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2950 "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	2951 }
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2952 else if (request.isMember(KEY_REQUESTED_TAGS) &&
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2953 request[KEY_REQUESTED_TAGS].type() != Json::arrayValue)
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2954 {
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2955 throw OrthancException(ErrorCode_BadRequest,
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2956 "Field \"" + std::string(KEY_REQUESTED_TAGS) + "\" should be an array");
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2957 }
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2958 else
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2959 {
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2960 bool expand = false;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2961 if (request.isMember(KEY_EXPAND))
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2962 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2963 expand = request[KEY_EXPAND].asBool();
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2964 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	2965
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2966 bool caseSensitive = false;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2967 if (request.isMember(KEY_CASE_SENSITIVE))
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2968 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2969 caseSensitive = request[KEY_CASE_SENSITIVE].asBool();
1374 a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2970 }
a1745d9be6e9 CaseSensitivePN configuration option Sebastien Jodogne <s.jodogne@gmail.com> parents: 1361 diff changeset	2971
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2972 size_t limit = 0;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2973 if (request.isMember(KEY_LIMIT))
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2974 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2975 int tmp = request[KEY_LIMIT].asInt();
1847 559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	2976 if (tmp < 0)
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 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_LIMIT) + "\" should be a positive integer");
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2980 }
1847 559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	2981
559956d5ceb2 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1831 diff changeset	2982 limit = static_cast<size_t>(tmp);
1758 318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2983 }
318c2e83c2bd fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1728 diff changeset	2984
2304 563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2985 size_t since = 0;
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2986 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	2987 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	2988 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	2989 if (tmp < 0)
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2990 {
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2991 throw OrthancException(ErrorCode_ParameterOutOfRange,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	2992 "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	2993 }
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2994
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2995 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	2996 }
563bf878407a Argument "Since" in URI "/tools/find" (related to issue 53) Sebastien Jodogne <s.jodogne@gmail.com> parents: 2281 diff changeset	2997
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2998 std::set<DicomTag> requestedTags;
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	2999
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3000 if (request.isMember(KEY_REQUESTED_TAGS))
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3001 {
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3002 FromDcmtkBridge::ParseListOfTags(requestedTags, request[KEY_REQUESTED_TAGS]);
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3003 }
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3004
3033 5da6d1063d8f effectively replacing LookupResource by DatabaseLookup in searches Sebastien Jodogne <s.jodogne@gmail.com> parents: 3027 diff changeset	3005 ResourceType level = StringToResourceType(request[KEY_LEVEL].asCString());
1360 0649c5aef34a DicomFindQuery Sebastien Jodogne <s.jodogne@gmail.com> parents: 1358 diff changeset	3006
3033 5da6d1063d8f effectively replacing LookupResource by DatabaseLookup in searches Sebastien Jodogne <s.jodogne@gmail.com> parents: 3027 diff changeset	3007 DatabaseLookup query;
1358 62d2d35b725e cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1356 diff changeset	3008
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	3009 Json::Value::Members members = request[KEY_QUERY].getMemberNames();
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3010 for (size_t i = 0; i < members.size(); i++)
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3011 {
2998 0a52af0c66e7 sharing strings Sebastien Jodogne <s.jodogne@gmail.com> parents: 2955 diff changeset	3012 if (request[KEY_QUERY][members[i]].type() != Json::stringValue)
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3013 {
3001 7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	3014 throw OrthancException(ErrorCode_BadRequest,
7695a9c81099 refactoring /tools/find using LookupResource::IVisitor Sebastien Jodogne <s.jodogne@gmail.com> parents: 2998 diff changeset	3015 "Tag \"" + members[i] + "\" should be associated with a string");
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3016 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3017
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	3018 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	3019
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3020 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	3021 {
cf91b6f22278 Fix issue #90 (C-Find shall match missing tags to null/empty string) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3094 diff changeset	3022 // 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	3023 // 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	3024 // "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	3025 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	3026 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	3027 }
1361 94ffb597d297 refactoring of C-Find SCP Sebastien Jodogne <s.jodogne@gmail.com> parents: 1360 diff changeset	3028 }
2876 ae8e72009e64 notes Sebastien Jodogne <s.jodogne@gmail.com> parents: 2836 diff changeset	3029
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	3030 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	3031 context.Apply(visitor, query, level, since, limit);
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3032 visitor.Answer(call.GetOutput(), context, level, expand, requestedTags);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3033 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3034 }
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3035
3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3036
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	3037 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	3038 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	3039 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	3040 {
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3041 if (call.IsDocumentation())
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3042 {
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	3043 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3044 OrthancRestApi::DocumentRequestedTags(call);
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	3045
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3046 const std::string children = GetResourceTypeText(end, true /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3047 const std::string resource = GetResourceTypeText(start, false /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3048 call.GetDocumentation()
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3049 .SetTag(GetResourceTypeText(start, true /* plural /, true / upper case */))
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3050 .SetSummary("Get child " + children)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3051 .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	3052 resource + " whose Orthanc identifier is provided in the URL")
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3053 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3054 .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	3055 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(start) + "/" + children, 5);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3056 return;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3057 }
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3058
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	3059 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	3060
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3061 std::set<DicomTag> requestedTags;
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3062 OrthancRestApi::GetRequestedTags(requestedTags, call);
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3063
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	3064 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	3065 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	3066
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 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	3068 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	3069 {
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 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	3071
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 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	3073 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	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 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	3076 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	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
1555 d6a93e12b1c1 Creation of DICOM files with encapsulated PDF Sebastien Jodogne <s.jodogne@gmail.com> parents: 1509 diff changeset	3079 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	3080
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	3081 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	3082 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	3083 }
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	3084
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	3085 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	3086
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	3087 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	3088
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	3089 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	3090 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	3091 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3092 Json::Value resource;
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3093 if (OrthancRestApi::GetContext(call).ExpandResource(resource, *it, end, format, requestedTags))
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	3094 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3095 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	3096 }
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	3097 }
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	3098
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	3099 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	3100 }
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	3101
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	3102
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3103 static void GetChildInstancesTags(RestApiGetCall& call)
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3104 {
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3105 if (call.IsDocumentation())
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3106 {
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	3107 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	3108
4416 0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3109 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	3110 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	3111 call.GetDocumentation()
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3112 .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	3113 .SetSummary("Get tags of instances")
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3114 .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	3115 " 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	3116 .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	3117 .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	3118 "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	3119 .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	3120 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(t) + "/instances-tags", 5);
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3121 return;
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3122 }
0b27841950d5 openapi about creation of zip/media archives Sebastien Jodogne <s.jodogne@gmail.com> parents: 4415 diff changeset	3123
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3124 ServerContext& context = OrthancRestApi::GetContext(call);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3125 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	3126 DicomToJsonFormat format = OrthancRestApi::GetDicomFormat(call, DicomToJsonFormat_Full);
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3127
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	3128 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	3129 ParseSetOfTags(ignoreTagLength, call, IGNORE_LENGTH);
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	3130
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3131 // Retrieve all the instances of this patient/study/series
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3132 typedef std::list<std::string> Instances;
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3133 Instances instances;
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 context.GetIndex().GetChildInstances(instances, publicId); // (*)
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3136
1201 09aa7c126be9 URIs 'instance-tags' now indexed by the instance IDs Sebastien Jodogne <s.jodogne@gmail.com> parents: 1172 diff changeset	3137 Json::Value result = Json::objectValue;
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3138
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3139 for (Instances::const_iterator it = instances.begin();
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	3140 it != instances.end(); ++it)
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3141 {
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3142 Json::Value full;
2409 e4045b3c9772 ignore-length argument if retrieving DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 2408 diff changeset	3143 context.ReadDicomAsJson(full, *it, ignoreTagLength);
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3144
2622 3603a2e14592 New option "?short" to list DICOM tags using their hexadecimal ID Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	3145 if (format != DicomToJsonFormat_Full)
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3146 {
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3147 Json::Value simplified;
4055 9214e3a7b0a2 moving FromDcmtkTests.cpp from OrthancServer to OrthancFramework Sebastien Jodogne <s.jodogne@gmail.com> parents: 4045 diff changeset	3148 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	3149 result[*it] = simplified;
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3150 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3151 else
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3152 {
1201 09aa7c126be9 URIs 'instance-tags' now indexed by the instance IDs Sebastien Jodogne <s.jodogne@gmail.com> parents: 1172 diff changeset	3153 result[*it] = full;
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3154 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3155 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3156
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3157 call.GetOutput().AnswerJson(result);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3158 }
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3159
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3160
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	3161
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	3162 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	3163 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	3164 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	3165 {
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 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	3167
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3168 if (call.IsDocumentation())
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3169 {
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	3170 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Human);
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3171 OrthancRestApi::DocumentRequestedTags(call);
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	3172
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3173 const std::string parent = GetResourceTypeText(end, false /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3174 const std::string resource = GetResourceTypeText(start, false /* plural /, false / lower case */);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3175 call.GetDocumentation()
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3176 .SetTag(GetResourceTypeText(start, true /* plural /, true / upper case */))
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3177 .SetSummary("Get parent " + parent)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3178 .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	3179 resource + " whose Orthanc identifier is provided in the URL")
4415 b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3180 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest")
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3181 .AddAnswerType(MimeType_Json, "Information about the parent DICOM " + parent)
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3182 .SetTruncatedJsonHttpGetSample(GetDocumentationSampleResource(start) + "/" + parent, 10);
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3183 return;
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3184 }
b50410d0e98c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4414 diff changeset	3185
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	3186 ServerIndex& index = OrthancRestApi::GetIndex(call);
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3187
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3188 std::set<DicomTag> requestedTags;
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3189 OrthancRestApi::GetRequestedTags(requestedTags, call);
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3190
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	3191 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	3192 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	3193 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	3194 {
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	3195 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	3196 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	3197 {
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	3198 // 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	3199 // 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	3200 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	3201 }
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	3202
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	3203 current = parent;
1555 d6a93e12b1c1 Creation of DICOM files with encapsulated PDF Sebastien Jodogne <s.jodogne@gmail.com> parents: 1509 diff changeset	3204 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	3205 }
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	3206
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	3207 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	3208
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	3209 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	3210
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3211 Json::Value resource;
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3212 if (OrthancRestApi::GetContext(call).ExpandResource(resource, current, end, format, requestedTags))
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	3213 {
4554 efd90f778cd2 simplification Sebastien Jodogne <s.jodogne@gmail.com> parents: 4551 diff changeset	3214 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	3215 }
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	3216 }
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
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	3218
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3219 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	3220 {
4407 2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3221 if (call.IsDocumentation())
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3222 {
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3223 call.GetDocumentation()
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3224 .SetTag("Instances")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3225 .SetSummary("Get embedded PDF")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3226 .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	3227 "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	3228 "`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	3229 .SetUriArgument("id", "Orthanc identifier of the instance interest")
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3230 .AddAnswerType(MimeType_Pdf, "PDF file");
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3231 return;
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3232 }
2412601cd24b cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4406 diff changeset	3233
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3234 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	3235 std::string pdf;
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3236 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	3237
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3238 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	3239 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3240 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	3241 return;
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3242 }
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3243 }
b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3244
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	3245
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3246 static void OrderSlices(RestApiGetCall& call)
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3247 {
4421 a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3248 if (call.IsDocumentation())
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3249 {
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3250 call.GetDocumentation()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3251 .SetDeprecated()
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3252 .SetTag("Series")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3253 .SetSummary("Order the slices")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3254 .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	3255 "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	3256 .SetUriArgument("id", "Orthanc identifier of the series of interest")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3257 .SetAnswerField("Dicom", RestApiCallDocumentation::Type_JsonListOfStrings,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3258 "Ordered list of paths to DICOM instances")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3259 .SetAnswerField("Slices", RestApiCallDocumentation::Type_JsonListOfStrings,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3260 "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	3261 "in the case of multiframe images.")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3262 .SetAnswerField("SlicesShort", RestApiCallDocumentation::Type_JsonListOfObjects,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3263 "Same information as the `Slices` field, but in a compact form")
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3264 .SetAnswerField("Type", RestApiCallDocumentation::Type_String,
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3265 "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	3266 .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	3267 return;
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3268 }
a7d72378e1cb cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4420 diff changeset	3269
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3270 const std::string id = call.GetUriComponent("id", "");
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3271
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3272 ServerIndex& index = OrthancRestApi::GetIndex(call);
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3273 SliceOrdering ordering(index, id);
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3274
1703 b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1702 diff changeset	3275 Json::Value result;
b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1702 diff changeset	3276 ordering.Format(result);
b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1702 diff changeset	3277 call.GetOutput().AnswerJson(result);
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3278 }
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3279
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3280
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3281 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	3282 {
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3283 if (call.IsDocumentation())
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3284 {
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	3285 OrthancRestApi::DocumentDicomFormat(call, DicomToJsonFormat_Full);
4404 f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3286 call.GetDocumentation()
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3287 .SetTag("Instances")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3288 .SetSummary("Get DICOM meta-header")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3289 .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	3290 "combines hexadecimal tags with human-readable description.")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3291 .SetUriArgument("id", "Orthanc identifier of the DICOM instance of interest")
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3292 .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	3293 .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	3294 return;
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3295 }
f34634916d8c cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	3296
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3297 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	3298
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3299 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	3300
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3301 std::string dicomContent;
4792 434843934307 Added a StorageCache in the StorageAccessor Alain Mazy <am@osimis.io> parents: 4777 diff changeset	3302 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	3303
2007 655489d9165d DicomMap::ParseDicomMetaInformation() Sebastien Jodogne <s.jodogne@gmail.com> parents: 2003 diff changeset	3304 // TODO Consider using "DicomMap::ParseDicomMetaInformation()" to
655489d9165d DicomMap::ParseDicomMetaInformation() Sebastien Jodogne <s.jodogne@gmail.com> parents: 2003 diff changeset	3305 // speed up things here
655489d9165d DicomMap::ParseDicomMetaInformation() Sebastien Jodogne <s.jodogne@gmail.com> parents: 2003 diff changeset	3306
1831 3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3307 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	3308
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3309 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	3310 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	3311
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	3312 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	3313 }
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3314
3ae2ff249675 "/instances/.../header" to get the meta information (header) of the DICOM instance Sebastien Jodogne <s.jodogne@gmail.com> parents: 1826 diff changeset	3315
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	3316 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	3317 {
4420 f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3318 if (call.IsDocumentation())
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3319 {
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3320 call.GetDocumentation()
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3321 .SetTag("System")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3322 .SetSummary("Invalidate DICOM-as-JSON summaries")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3323 .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	3324 "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	3325 "This is notably useful after changes to the `Dictionary` configuration option. "
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3326 "https://book.orthanc-server.com/faq/orthanc-storage.html#storage-area");
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3327 return;
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3328 }
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3329
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	3330 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	3331
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3332 // 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	3333 // 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	3334 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	3335 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	3336
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3337 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	3338 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	3339 {
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3340 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	3341 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	3342
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3343 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	3344 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	3345 {
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	3346 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	3347 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	3348 }
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3349 }
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3350
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3351 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	3352 }
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3353
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files Sebastien Jodogne <s.jodogne@gmail.com> parents: 2128 diff changeset	3354
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	3355 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	3356 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	3357 {
4420 f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3358 if (call.IsDocumentation())
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3359 {
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3360 const std::string resource = GetResourceTypeText(type, false /* plural /, false / lower case */);
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3361 call.GetDocumentation()
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3362 .SetTag(GetResourceTypeText(type, true /* plural /, true / upper case */))
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3363 .SetSummary("Reconstruct tags of " + resource)
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3364 .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	3365 "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	3366 "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	3367 "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	3368 "parsed again, and the Orthanc index will be updated accordingly.")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3369 .SetUriArgument("id", "Orthanc identifier of the " + resource + " of interest");
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3370 return;
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3371 }
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3372
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	3373 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	3374 ServerToolbox::ReconstructResource(context, call.GetUriComponent("id", ""));
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3375 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	3376 }
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3377
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3378
2804 d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3379 static void ReconstructAllResources(RestApiPostCall& call)
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3380 {
4420 f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3381 if (call.IsDocumentation())
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3382 {
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3383 call.GetDocumentation()
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3384 .SetTag("System")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3385 .SetSummary("Reconstruct all the index")
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3386 .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	3387 "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	3388 "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	3389 "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	3390 return;
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3391 }
f95ad769e671 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4419 diff changeset	3392
2804 d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3393 ServerContext& context = OrthancRestApi::GetContext(call);
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3394
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3395 std::list<std::string> studies;
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3396 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	3397
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3398 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	3399 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	3400 {
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3401 ServerToolbox::ReconstructResource(context, *study);
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3402 }
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3403
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	3404 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	3405 }
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3406
d88970f1ffbf fix ordering of non-parallel slices + /tools/reconstruct Sebastien Jodogne <s.jodogne@gmail.com> parents: 2780 diff changeset	3407
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3408 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	3409 ServerIndex& index,
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3410 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	3411 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3412 target.clear();
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3413
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3414 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	3415 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	3416 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3417 std::list<std::string> children;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3418 index.GetChildren(children, *it);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3419
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3420 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	3421 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	3422 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3423 target.insert(*child);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3424 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3425 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3426 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3427
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3428
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3429 static void AddMetadata(Json::Value& target,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3430 ServerIndex& index,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3431 const std::string& resource,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3432 ResourceType level)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3433 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3434 target = Json::objectValue;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3435
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3436 std::map<MetadataType, std::string> content;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3437 index.GetAllMetadata(content, resource, level);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3438
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3439 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	3440 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	3441 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3442 target[EnumerationToString(it->first)] = it->second;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3443 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3444 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3445
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3446
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	3447 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	3448 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3449 static const char* const LEVEL = "Level";
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3450 static const char* const METADATA = "Metadata";
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3451
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	3452 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	3453 {
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 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	3455
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	3456 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	3457 .SetTag("System")
4879 c728d8f25e5a fix doc Alain Mazy <am@osimis.io> parents: 4858 diff changeset	3458 .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	3459 .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	3460 "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	3461 .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	3462 "This optional argument specifies the level of interest (can be `Patient`, `Study`, `Series` or "
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3463 "`Instance`). Orthanc will loop over the items inside `Resources`, and explore upward or "
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3464 "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	3465 .SetRequestField(METADATA, RestApiCallDocumentation::Type_Boolean,
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3466 "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	3467 .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	3468 "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	3469 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	3470 }
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	3471
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	3472 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	3473 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	3474 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	3475 {
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	3476 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	3477 "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	3478 }
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	3479 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	3480 {
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 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	3482
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3483 bool metadata = true;
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3484 if (request.isMember(METADATA))
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3485 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3486 metadata = SerializationToolbox::ReadBoolean(request, METADATA);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3487 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3488
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	3489 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	3490
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	3491 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	3492
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3493 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	3494 {
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3495 // 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	3496 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	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> resources;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3499 SerializationToolbox::ReadSetOfStrings(resources, request, "Resources");
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 std::set<std::string> interest;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3502
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3503 assert(ResourceType_Patient < ResourceType_Study &&
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3504 ResourceType_Study < ResourceType_Series &&
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3505 ResourceType_Series < ResourceType_Instance);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3506
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3507 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	3508 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	3509 {
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3510 ResourceType type;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3511 if (index.LookupResourceType(type, *it))
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3512 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3513 if (type == level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3514 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3515 // 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	3516 interest.insert(*it);
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 if (type < level)
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 children
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3521 std::set<std::string> current;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3522 current.insert(*it);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3523
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3524 for (;;)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3525 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3526 std::set<std::string> children;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3527 GetBulkChildren(children, index, current);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3528
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3529 type = GetChildResourceType(type);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3530 if (type == level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3531 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3532 for (std::set<std::string>::const_iterator
4716 758fe3ffb336 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4714 diff changeset	3533 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	3534 {
4716 758fe3ffb336 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4714 diff changeset	3535 interest.insert(*it2);
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3536 }
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 break; // done
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3539 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3540 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3541 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3542 current.swap(children);
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 // Need to explore parents
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3549 std::string current = *it;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3550
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3551 for (;;)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3552 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3553 std::string parent;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3554 if (index.LookupParent(parent, current))
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3555 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3556 type = GetParentResourceType(type);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3557 if (type == level)
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3558 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3559 interest.insert(parent);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3560 break; // done
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3561 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3562 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3563 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3564 current = parent;
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 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	3570 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3571 }
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 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3574 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3575 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3576 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	3577 }
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	3578 }
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3579
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3580 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	3581 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	3582 {
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3583 Json::Value item;
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3584 std::set<DicomTag> emptyRequestedTags; // not supported for bulk content
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3585
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3586 if (OrthancRestApi::GetContext(call).ExpandResource(item, *it, level, format, emptyRequestedTags))
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3587 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3588 if (metadata)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3589 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3590 AddMetadata(item[METADATA], index, *it, level);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3591 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3592
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3593 answer.append(item);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3594 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3595 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3596 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3597 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3598 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3599 // 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	3600 std::list<std::string> resources;
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3601 SerializationToolbox::ReadListOfStrings(resources, request, "Resources");
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3602
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3603 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	3604 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	3605 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3606 ResourceType level;
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3607 Json::Value item;
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3608 std::set<DicomTag> emptyRequestedTags; // not supported for bulk content
8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3609
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3610 if (index.LookupResourceType(level, *it) &&
4936 8422e4f99a18 Handling RequestedTags in ExpandResource -> read parent main dicom tags if required. Not yet getting missing tags from file. Integration tests ok Alain Mazy <am@osimis.io> parents: 4935 diff changeset	3611 OrthancRestApi::GetContext(call).ExpandResource(item, *it, level, format, emptyRequestedTags))
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3612 {
4714 8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3613 if (metadata)
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3614 {
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3615 AddMetadata(item[METADATA], index, *it, level);
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3616 }
8ffe2fdb541f added argument "Metadata" to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4699 diff changeset	3617
4699 facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3618 answer.append(item);
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3619 }
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3620 else
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3621 {
facea16b055b added the "Level" argument to "/tools/bulk-content" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4698 diff changeset	3622 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	3623 }
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	3624 }
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	3625 }
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	3626
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	3627 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	3628 }
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	3629 }
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	3630
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	3631
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	3632 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	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 (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	3635 {
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 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	3637 .SetTag("System")
4879 c728d8f25e5a fix doc Alain Mazy <am@osimis.io> parents: 4858 diff changeset	3638 .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	3639 .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	3640 "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	3641 .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	3642 "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	3643 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	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
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3646 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	3647
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3648 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	3649 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	3650 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	3651 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3652 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	3653 "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	3654 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3655 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	3656 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3657 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	3658 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	3659
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3660 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	3661 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	3662 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3663 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	3664 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	3665
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3666 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	3667 !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	3668 {
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3669 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	3670 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3671 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3672
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3673 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	3674 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3675 }
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3676
da1edb7d6332 "/tools/bulk-delete" to delete a group of multiple, unrelated resources at once Sebastien Jodogne <s.jodogne@gmail.com> parents: 4661 diff changeset	3677
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3678 void OrthancRestApi::RegisterResources()
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3679 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3680 Register("/instances", ListResources<ResourceType_Instance>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3681 Register("/patients", ListResources<ResourceType_Patient>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3682 Register("/series", ListResources<ResourceType_Series>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3683 Register("/studies", ListResources<ResourceType_Study>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3684
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3685 Register("/instances/{id}", DeleteSingleResource<ResourceType_Instance>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3686 Register("/instances/{id}", GetSingleResource<ResourceType_Instance>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3687 Register("/patients/{id}", DeleteSingleResource<ResourceType_Patient>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3688 Register("/patients/{id}", GetSingleResource<ResourceType_Patient>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3689 Register("/series/{id}", DeleteSingleResource<ResourceType_Series>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3690 Register("/series/{id}", GetSingleResource<ResourceType_Series>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3691 Register("/studies/{id}", DeleteSingleResource<ResourceType_Study>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3692 Register("/studies/{id}", GetSingleResource<ResourceType_Study>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3693
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3694 Register("/instances/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3695 Register("/patients/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3696 Register("/studies/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3697 Register("/series/{id}/statistics", GetResourceStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3698
964 cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	3699 Register("/patients/{id}/shared-tags", GetSharedTags);
cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	3700 Register("/series/{id}/shared-tags", GetSharedTags);
cc7a4ae474c1 simplify has a GET argument Sebastien Jodogne <s.jodogne@gmail.com> parents: 963 diff changeset	3701 Register("/studies/{id}/shared-tags", GetSharedTags);
958 1fbe89dc18b5 extraction of the shared tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 874 diff changeset	3702
1276 6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3703 Register("/instances/{id}/module", GetModule<ResourceType_Instance, DicomModule_Instance>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3704 Register("/patients/{id}/module", GetModule<ResourceType_Patient, DicomModule_Patient>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3705 Register("/series/{id}/module", GetModule<ResourceType_Series, DicomModule_Series>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3706 Register("/studies/{id}/module", GetModule<ResourceType_Study, DicomModule_Study>);
6164f7200c43 refactoring modules Sebastien Jodogne <s.jodogne@gmail.com> parents: 1201 diff changeset	3707 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	3708
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3709 Register("/instances/{id}/file", GetInstanceFile);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3710 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	3711 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	3712 Register("/instances/{id}/simplified-tags", GetInstanceSimplifiedTags);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3713 Register("/instances/{id}/frames", ListFrames);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3714
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4422 diff changeset	3715 Register("/instances/{id}/frames/{frame}", RestApi::AutoListChildren);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3716 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	3717 Register("/instances/{id}/frames/{frame}/rendered", GetRenderedFrame);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3718 Register("/instances/{id}/frames/{frame}/image-uint8", GetImage<ImageExtractionMode_UInt8>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3719 Register("/instances/{id}/frames/{frame}/image-uint16", GetImage<ImageExtractionMode_UInt16>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3720 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	3721 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	3722 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	3723 Register("/instances/{id}/frames/{frame}/raw.gz", GetRawFrame<true>);
4902 df86d2505df8 Orthanc 1.9.8 is now known as Orthanc 1.10.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4892 diff changeset	3724 Register("/instances/{id}/frames/{frame}/numpy", GetNumpyFrame); // New in Orthanc 1.10.0
1556 b8dc2f855a83 Preview of PDF files encapsulated in DICOM from Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 1555 diff changeset	3725 Register("/instances/{id}/pdf", ExtractPdf);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3726 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	3727 Register("/instances/{id}/rendered", GetRenderedFrame);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3728 Register("/instances/{id}/image-uint8", GetImage<ImageExtractionMode_UInt8>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3729 Register("/instances/{id}/image-uint16", GetImage<ImageExtractionMode_UInt16>);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3730 Register("/instances/{id}/image-int16", GetImage<ImageExtractionMode_Int16>);
874 87791ebc1f50 download matlab images Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	3731 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	3732 Register("/instances/{id}/header", GetInstanceHeader);
4902 df86d2505df8 Orthanc 1.9.8 is now known as Orthanc 1.10.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4892 diff changeset	3733 Register("/instances/{id}/numpy", GetNumpyInstance); // New in Orthanc 1.10.0
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3734
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3735 Register("/patients/{id}/protected", IsProtectedPatient);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3736 Register("/patients/{id}/protected", SetPatientProtection);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3737
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3738 std::vector<std::string> resourceTypes;
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3739 resourceTypes.push_back("patients");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3740 resourceTypes.push_back("studies");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3741 resourceTypes.push_back("series");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3742 resourceTypes.push_back("instances");
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3743
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3744 for (size_t i = 0; i < resourceTypes.size(); i++)
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3745 {
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3746 Register("/" + resourceTypes[i] + "/{id}/metadata", ListMetadata);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3747 Register("/" + resourceTypes[i] + "/{id}/metadata/{name}", DeleteMetadata);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3748 Register("/" + resourceTypes[i] + "/{id}/metadata/{name}", GetMetadata);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3749 Register("/" + resourceTypes[i] + "/{id}/metadata/{name}", SetMetadata);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3750
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3751 Register("/" + resourceTypes[i] + "/{id}/attachments", ListAttachments);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3752 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}", DeleteAttachment);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3753 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}", GetAttachmentOperations);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3754 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}", UploadAttachment);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3755 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compress", ChangeAttachmentCompression<CompressionType_ZlibWithSize>);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3756 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compressed-data", GetAttachmentData<0>);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3757 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compressed-md5", GetAttachmentCompressedMD5);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3758 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/compressed-size", GetAttachmentCompressedSize);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3759 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/data", GetAttachmentData<1>);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3760 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/is-compressed", IsAttachmentCompressed);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3761 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/md5", GetAttachmentMD5);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3762 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/size", GetAttachmentSize);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3763 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	3764 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/info", GetAttachmentInfo);
4409 5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3765 Register("/" + resourceTypes[i] + "/{id}/attachments/{name}/verify-md5", VerifyAttachment);
5784a9eaf502 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4408 diff changeset	3766 }
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	3767
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	3768 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	3769 Register("/tools/lookup", Lookup);
1354 3dd494f201a1 ResourceFinder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1342 diff changeset	3770 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	3771
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	3772 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	3773 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	3774 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	3775 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	3776 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	3777 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	3778
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	3779 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	3780 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	3781 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	3782 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	3783 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	3784 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	3785
1166 a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3786 Register("/patients/{id}/instances-tags", GetChildInstancesTags);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3787 Register("/studies/{id}/instances-tags", GetChildInstancesTags);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3788 Register("/series/{id}/instances-tags", GetChildInstancesTags);
a921e3b5e763 bulk tags retrieval Sebastien Jodogne <s.jodogne@gmail.com> parents: 1146 diff changeset	3789
782 a60040857ce6 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 751 diff changeset	3790 Register("/instances/{id}/content/*", GetRawContent);
1702 9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3791
9980875edc7c started work on SliceOrdering Sebastien Jodogne <s.jodogne@gmail.com> parents: 1701 diff changeset	3792 Register("/series/{id}/ordered-slices", OrderSlices);
4902 df86d2505df8 Orthanc 1.9.8 is now known as Orthanc 1.10.0 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4892 diff changeset	3793 Register("/series/{id}/numpy", GetNumpySeries); // New in Orthanc 1.10.0
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	3794
e3fd5bc429a2 URI to reconstruct the main DICOM tags, the JSON summary and the metadata Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	3795 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	3796 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	3797 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	3798 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	3799 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	3800
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	3801 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	3802 Register("/tools/bulk-delete", BulkDelete);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3803 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3804 }

Mercurial > hg > orthanc

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4936:8422e4f99a18 more-tags