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

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestSystem.cpp @ 5621:732ec9feeea8 find-refactoring

introduction of FindRequest::ChildrenRetrieveSpecification

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Sat, 11 May 2024 15:43:07 +0200
parents	7c372a95c7e9
children	28cc06e4859a f7adfb22e20e

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: 1668 diff changeset	3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288 6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	4 * Department, University Hospital of Liege, Belgium
5485 48b8dae6dc77 upgrade to year 2024 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5433 diff changeset	5 * Copyright (C) 2017-2024 Osimis S.A., Belgium
48b8dae6dc77 upgrade to year 2024 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5433 diff changeset	6 * Copyright (C) 2021-2024 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/DicomParsing/FromDcmtkBridge.h"
05b8fd21089c fix path Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	27 #include "../../../OrthancFramework/Sources/MetricsRegistry.h"
3097 ac72032d69a2 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	28 #include "../../Plugins/Engine/OrthancPlugins.h"
ac72032d69a2 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	29 #include "../../Plugins/Engine/PluginsManager.h"
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	30 #include "../OrthancConfiguration.h"
4273 0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4143 diff changeset	31 #include "../OrthancInitialization.h"
1437 02f5a3f5c0a0 access to the REST API from Lua Sebastien Jodogne <s.jodogne@gmail.com> parents: 1434 diff changeset	32 #include "../ServerContext.h"
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	33
4275 d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	34 #include <boost/algorithm/string/predicate.hpp>
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	35
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	36
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	37 namespace Orthanc
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	38 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	39 // System information -------------------------------------------------------
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	40
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	41 static void ServeRoot(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	42 {
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	43 call.GetOutput().Redirect("app/explorer.html");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	44 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	45
4461 22abc6851191 The DICOM meta-header and the transfer syntax are displayed at the "Instance" level Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	46 static void ServeFavicon(RestApiGetCall& call)
22abc6851191 The DICOM meta-header and the transfer syntax are displayed at the "Instance" level Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	47 {
22abc6851191 The DICOM meta-header and the transfer syntax are displayed at the "Instance" level Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	48 call.GetOutput().Redirect("app/images/favicon.ico");
22abc6851191 The DICOM meta-header and the transfer syntax are displayed at the "Instance" level Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	49 }
4950 3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	50
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	51 static void GetMainDicomTagsConfiguration(Json::Value& result)
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	52 {
4961 1b76853e1797 DbOptimizer plugin Alain Mazy <am@osimis.io> parents: 4950 diff changeset	53 result["Patient"] = DicomMap::GetMainDicomTagsSignature(ResourceType_Patient);
1b76853e1797 DbOptimizer plugin Alain Mazy <am@osimis.io> parents: 4950 diff changeset	54 result["Study"] = DicomMap::GetMainDicomTagsSignature(ResourceType_Study);
1b76853e1797 DbOptimizer plugin Alain Mazy <am@osimis.io> parents: 4950 diff changeset	55 result["Series"] = DicomMap::GetMainDicomTagsSignature(ResourceType_Series);
1b76853e1797 DbOptimizer plugin Alain Mazy <am@osimis.io> parents: 4950 diff changeset	56 result["Instance"] = DicomMap::GetMainDicomTagsSignature(ResourceType_Instance);
4950 3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	57 }
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	58
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	59 static void GetUserMetadataConfiguration(Json::Value& result)
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	60 {
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	61 std::map<std::string, int> userMetadata;
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	62 Orthanc::GetRegisteredUserMetadata(userMetadata);
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	63
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	64 for (std::map<std::string, int>::const_iterator it = userMetadata.begin(); it != userMetadata.end(); ++it)
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	65 {
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	66 result[it->first] = it->second;
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	67 }
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	68 }
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	69
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	70 static void GetSystemInformation(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 {
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	72 static const char* const API_VERSION = "ApiVersion";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	73 static const char* const CHECK_REVISIONS = "CheckRevisions";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	74 static const char* const DATABASE_BACKEND_PLUGIN = "DatabaseBackendPlugin";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	75 static const char* const DATABASE_VERSION = "DatabaseVersion";
5024 c2ebc47f4f18 wip: adding DelayedDeletion plugin Alain Mazy <am@osimis.io> parents: 4988 diff changeset	76 static const char* const DATABASE_SERVER_IDENTIFIER = "DatabaseServerIdentifier";
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	77 static const char* const DICOM_AET = "DicomAet";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	78 static const char* const DICOM_PORT = "DicomPort";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	79 static const char* const HTTP_PORT = "HttpPort";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	80 static const char* const IS_HTTP_SERVER_SECURE = "IsHttpServerSecure";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	81 static const char* const NAME = "Name";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	82 static const char* const PLUGINS_ENABLED = "PluginsEnabled";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	83 static const char* const STORAGE_AREA_PLUGIN = "StorageAreaPlugin";
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	84 static const char* const VERSION = "Version";
4950 3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	85 static const char* const MAIN_DICOM_TAGS = "MainDicomTags";
4979 f316413027fd renamed DbOptizer into Housekeeper + add Scheduler & triggers Alain Mazy <am@osimis.io> parents: 4961 diff changeset	86 static const char* const STORAGE_COMPRESSION = "StorageCompression";
4988 8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	87 static const char* const OVERWRITE_INSTANCES = "OverwriteInstances";
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	88 static const char* const INGEST_TRANSCODING = "IngestTranscoding";
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	89 static const char* const MAXIMUM_STORAGE_SIZE = "MaximumStorageSize";
5533 72511fbd1605 Added MaximumPatientCount in /system Alain Mazy <am@osimis.io> parents: 5485 diff changeset	90 static const char* const MAXIMUM_PATIENT_COUNT = "MaximumPatientCount";
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	91 static const char* const MAXIMUM_STORAGE_MODE = "MaximumStorageMode";
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	92 static const char* const USER_METADATA = "UserMetadata";
5238 367e8af46cfd added "HasLabels" in /system Sebastien Jodogne <s.jodogne@gmail.com> parents: 5204 diff changeset	93 static const char* const HAS_LABELS = "HasLabels";
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	94
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	95 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	96 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	97 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	98 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	99 .SetSummary("Get system information")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	100 .SetDescription("Get system information about Orthanc")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	101 .SetAnswerField(API_VERSION, RestApiCallDocumentation::Type_Number, "Version of the REST API")
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	102 .SetAnswerField(VERSION, RestApiCallDocumentation::Type_String, "Version of Orthanc")
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	103 .SetAnswerField(DATABASE_VERSION, RestApiCallDocumentation::Type_Number,
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	104 "Version of the database: https://orthanc.uclouvain.be/book/developers/db-versioning.html")
5024 c2ebc47f4f18 wip: adding DelayedDeletion plugin Alain Mazy <am@osimis.io> parents: 4988 diff changeset	105 .SetAnswerField(DATABASE_SERVER_IDENTIFIER, RestApiCallDocumentation::Type_String,
c2ebc47f4f18 wip: adding DelayedDeletion plugin Alain Mazy <am@osimis.io> parents: 4988 diff changeset	106 "ID of the server in the database (when running multiple Orthanc on the same DB)")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	107 .SetAnswerField(IS_HTTP_SERVER_SECURE, RestApiCallDocumentation::Type_Boolean,
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	108 "Whether the REST API is properly secured (assuming no reverse proxy is in use): https://orthanc.uclouvain.be/book/faq/security.html#securing-the-http-server")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	109 .SetAnswerField(STORAGE_AREA_PLUGIN, RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	110 "Information about the installed storage area plugin (`null` if no such plugin is installed)")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	111 .SetAnswerField(DATABASE_BACKEND_PLUGIN, RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	112 "Information about the installed database index plugin (`null` if no such plugin is installed)")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	113 .SetAnswerField(DICOM_AET, RestApiCallDocumentation::Type_String, "The DICOM AET of Orthanc")
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	114 .SetAnswerField(DICOM_PORT, RestApiCallDocumentation::Type_Number, "The port to the DICOM server of Orthanc")
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	115 .SetAnswerField(HTTP_PORT, RestApiCallDocumentation::Type_Number, "The port to the HTTP server of Orthanc")
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	116 .SetAnswerField(NAME, RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	117 "The name of the Orthanc server, cf. the `Name` configuration option")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	118 .SetAnswerField(PLUGINS_ENABLED, RestApiCallDocumentation::Type_Boolean,
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	119 "Whether Orthanc was built with support for plugins")
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	120 .SetAnswerField(CHECK_REVISIONS, RestApiCallDocumentation::Type_Boolean,
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	121 "Whether Orthanc handle revisions of metadata and attachments to deal with multiple writers (new in Orthanc 1.9.2)")
4950 3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	122 .SetAnswerField(MAIN_DICOM_TAGS, RestApiCallDocumentation::Type_JsonObject,
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	123 "The list of MainDicomTags saved in DB for each resource level (new in Orthanc 1.11.0)")
4979 f316413027fd renamed DbOptizer into Housekeeper + add Scheduler & triggers Alain Mazy <am@osimis.io> parents: 4961 diff changeset	124 .SetAnswerField(STORAGE_COMPRESSION, RestApiCallDocumentation::Type_Boolean,
f316413027fd renamed DbOptizer into Housekeeper + add Scheduler & triggers Alain Mazy <am@osimis.io> parents: 4961 diff changeset	125 "Whether storage compression is enabled (new in Orthanc 1.11.0)")
4988 8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	126 .SetAnswerField(OVERWRITE_INSTANCES, RestApiCallDocumentation::Type_Boolean,
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	127 "Whether instances are overwritten when re-ingested (new in Orthanc 1.11.0)")
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	128 .SetAnswerField(INGEST_TRANSCODING, RestApiCallDocumentation::Type_String,
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	129 "Whether instances are transcoded when ingested into Orthanc (`""` if no transcoding is performed) (new in Orthanc 1.11.0)")
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	130 .SetAnswerField(MAXIMUM_STORAGE_SIZE, RestApiCallDocumentation::Type_Number,
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	131 "The configured MaximumStorageSize in MB (new in Orthanc 1.11.3)")
5533 72511fbd1605 Added MaximumPatientCount in /system Alain Mazy <am@osimis.io> parents: 5485 diff changeset	132 .SetAnswerField(MAXIMUM_PATIENT_COUNT, RestApiCallDocumentation::Type_Number,
72511fbd1605 Added MaximumPatientCount in /system Alain Mazy <am@osimis.io> parents: 5485 diff changeset	133 "The configured MaximumPatientCount (new in Orthanc 1.12.4)")
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	134 .SetAnswerField(MAXIMUM_STORAGE_MODE, RestApiCallDocumentation::Type_String,
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	135 "The configured MaximumStorageMode (new in Orthanc 1.11.3)")
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	136 .SetAnswerField(USER_METADATA, RestApiCallDocumentation::Type_JsonObject,
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	137 "The configured UserMetadata (new in Orthanc 1.12.0)")
5238 367e8af46cfd added "HasLabels" in /system Sebastien Jodogne <s.jodogne@gmail.com> parents: 5204 diff changeset	138 .SetAnswerField(HAS_LABELS, RestApiCallDocumentation::Type_Boolean,
367e8af46cfd added "HasLabels" in /system Sebastien Jodogne <s.jodogne@gmail.com> parents: 5204 diff changeset	139 "Whether the database back-end supports labels (new in Orthanc 1.12.0)")
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	140 .SetHttpGetSample("https://orthanc.uclouvain.be/demo/system", true);
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	141 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	142 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	143
3533 2090ec6a83a5 create a default user if none is provided, while issuing a warning in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 3526 diff changeset	144 ServerContext& context = OrthancRestApi::GetContext(call);
2090ec6a83a5 create a default user if none is provided, while issuing a warning in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 3526 diff changeset	145
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	146 Json::Value result = Json::objectValue;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	147
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	148 result[API_VERSION] = ORTHANC_API_VERSION;
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	149 result[VERSION] = ORTHANC_VERSION;
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	150 result[DATABASE_VERSION] = OrthancRestApi::GetIndex(call).GetDatabaseVersion();
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	151 result[IS_HTTP_SERVER_SECURE] = context.IsHttpServerSecure(); // New in Orthanc 1.5.8
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	152
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	153 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	154 OrthancConfiguration::ReaderLock lock;
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	155 result[DICOM_AET] = lock.GetConfiguration().GetOrthancAET();
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	156 result[DICOM_PORT] = lock.GetConfiguration().GetUnsignedIntegerParameter(DICOM_PORT, 4242);
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	157 result[HTTP_PORT] = lock.GetConfiguration().GetUnsignedIntegerParameter(HTTP_PORT, 8042);
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	158 result[NAME] = lock.GetConfiguration().GetStringParameter(NAME, "");
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	159 result[CHECK_REVISIONS] = lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false); // New in Orthanc 1.9.2
4979 f316413027fd renamed DbOptizer into Housekeeper + add Scheduler & triggers Alain Mazy <am@osimis.io> parents: 4961 diff changeset	160 result[STORAGE_COMPRESSION] = lock.GetConfiguration().GetBooleanParameter(STORAGE_COMPRESSION, false); // New in Orthanc 1.11.0
4988 8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	161 result[OVERWRITE_INSTANCES] = lock.GetConfiguration().GetBooleanParameter(OVERWRITE_INSTANCES, false); // New in Orthanc 1.11.0
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	162 result[INGEST_TRANSCODING] = lock.GetConfiguration().GetStringParameter(INGEST_TRANSCODING, ""); // New in Orthanc 1.11.0
5024 c2ebc47f4f18 wip: adding DelayedDeletion plugin Alain Mazy <am@osimis.io> parents: 4988 diff changeset	163 result[DATABASE_SERVER_IDENTIFIER] = lock.GetConfiguration().GetDatabaseServerIdentifier();
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	164 result[MAXIMUM_STORAGE_SIZE] = lock.GetConfiguration().GetUnsignedIntegerParameter(MAXIMUM_STORAGE_SIZE, 0); // New in Orthanc 1.11.3
5536 7c372a95c7e9 fix comment Sebastien Jodogne <s.jodogne@gmail.com> parents: 5533 diff changeset	165 result[MAXIMUM_PATIENT_COUNT] = lock.GetConfiguration().GetUnsignedIntegerParameter(MAXIMUM_PATIENT_COUNT, 0); // New in Orthanc 1.12.4
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	166 result[MAXIMUM_STORAGE_MODE] = lock.GetConfiguration().GetStringParameter(MAXIMUM_STORAGE_MODE, "Recycle"); // New in Orthanc 1.11.3
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	167 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	168
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	169 result[STORAGE_AREA_PLUGIN] = Json::nullValue;
5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	170 result[DATABASE_BACKEND_PLUGIN] = Json::nullValue;
1630 ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	171
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	172 #if ORTHANC_ENABLE_PLUGINS == 1
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	173 result[PLUGINS_ENABLED] = true;
3533 2090ec6a83a5 create a default user if none is provided, while issuing a warning in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 3526 diff changeset	174 const OrthancPlugins& plugins = context.GetPlugins();
1630 ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	175
ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	176 if (plugins.HasStorageArea())
ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	177 {
1631 0d074f5f6069 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	178 std::string p = plugins.GetStorageAreaLibrary().GetPath();
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	179 result[STORAGE_AREA_PLUGIN] = boost::filesystem::canonical(p).string();
1630 ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	180 }
ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	181
ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	182 if (plugins.HasDatabaseBackend())
ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	183 {
1631 0d074f5f6069 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	184 std::string p = plugins.GetDatabaseBackendLibrary().GetPath();
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	185 result[DATABASE_BACKEND_PLUGIN] = boost::filesystem::canonical(p).string();
1630 ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	186 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	187 #else
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	188 result[PLUGINS_ENABLED] = false;
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	189 #endif
1630 ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1597 diff changeset	190
4950 3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	191 result[MAIN_DICOM_TAGS] = Json::objectValue;
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	192 GetMainDicomTagsConfiguration(result[MAIN_DICOM_TAGS]);
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	193
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	194 result[USER_METADATA] = Json::objectValue;
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	195 GetUserMetadataConfiguration(result[USER_METADATA]);
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	196
5238 367e8af46cfd added "HasLabels" in /system Sebastien Jodogne <s.jodogne@gmail.com> parents: 5204 diff changeset	197 result[HAS_LABELS] = OrthancRestApi::GetIndex(call).HasLabelsSupport();
367e8af46cfd added "HasLabels" in /system Sebastien Jodogne <s.jodogne@gmail.com> parents: 5204 diff changeset	198
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	199 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	200 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	201
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	202 static void GetStatistics(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	203 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	204 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	205 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	206 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	207 .SetTag("System")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	208 .SetSummary("Get database statistics")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	209 .SetDescription("Get statistics related to the database of Orthanc")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	210 .SetAnswerField("CountInstances", RestApiCallDocumentation::Type_Number, "Number of DICOM instances stored in Orthanc")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	211 .SetAnswerField("CountSeries", RestApiCallDocumentation::Type_Number, "Number of DICOM series stored in Orthanc")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	212 .SetAnswerField("CountStudies", RestApiCallDocumentation::Type_Number, "Number of DICOM studies stored in Orthanc")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	213 .SetAnswerField("CountPatients", RestApiCallDocumentation::Type_Number, "Number of patients stored in Orthanc")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	214 .SetAnswerField("TotalDiskSize", RestApiCallDocumentation::Type_String, "Size of the storage area (in bytes)")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	215 .SetAnswerField("TotalDiskSizeMB", RestApiCallDocumentation::Type_Number, "Size of the storage area (in megabytes)")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	216 .SetAnswerField("TotalUncompressedSize", RestApiCallDocumentation::Type_String, "Total size of all the files once uncompressed (in bytes). This corresponds to `TotalDiskSize` if no compression is enabled, cf. `StorageCompression` configuration option")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	217 .SetAnswerField("TotalUncompressedSizeMB", RestApiCallDocumentation::Type_Number, "Total size of all the files once uncompressed (in megabytes)")
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	218 .SetHttpGetSample("https://orthanc.uclouvain.be/demo/statistics", true);
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	219 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	220 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	221
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	222 static const uint64_t MEGA_BYTES = 1024 * 1024;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	223
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	224 uint64_t diskSize, uncompressedSize, countPatients, countStudies, countSeries, countInstances;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	225 OrthancRestApi::GetIndex(call).GetGlobalStatistics(diskSize, uncompressedSize, countPatients,
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	226 countStudies, countSeries, countInstances);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	227
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	228 Json::Value result = Json::objectValue;
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	229 result["TotalDiskSize"] = boost::lexical_cast<std::string>(diskSize);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	230 result["TotalUncompressedSize"] = boost::lexical_cast<std::string>(uncompressedSize);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	231 result["TotalDiskSizeMB"] = static_cast<unsigned int>(diskSize / MEGA_BYTES);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	232 result["TotalUncompressedSizeMB"] = static_cast<unsigned int>(uncompressedSize / MEGA_BYTES);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	233 result["CountPatients"] = static_cast<unsigned int>(countPatients);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	234 result["CountStudies"] = static_cast<unsigned int>(countStudies);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	235 result["CountSeries"] = static_cast<unsigned int>(countSeries);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	236 result["CountInstances"] = static_cast<unsigned int>(countInstances);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	237
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	238 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	239 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	240
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	241 static void GenerateUid(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	242 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	243 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	244 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	245 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	246 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	247 .SetSummary("Generate an identifier")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	248 .SetDescription("Generate a random DICOM identifier")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	249 .SetHttpGetArgument("level", RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	250 "Type of DICOM resource among: `patient`, `study`, `series` or `instance`", true)
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	251 .AddAnswerType(MimeType_PlainText, "The generated identifier");
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	252 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	253 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	254
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	255 std::string level = call.GetArgument("level", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	256 if (level == "patient")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	257 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	258 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Patient), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	259 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	260 else if (level == "study")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	261 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	262 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Study), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	263 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	264 else if (level == "series")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	265 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	266 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Series), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	267 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	268 else if (level == "instance")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	269 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	270 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Instance), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	271 }
5144 9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	272 else
9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	273 {
9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	274 LOG(ERROR) << "No 'level' or invalid GET argument specified in /tools/generate-uid";
9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	275 }
751 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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	278 static void ExecuteScript(RestApiPostCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	279 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	280 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	281 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	282 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	283 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	284 .SetSummary("Execute Lua script")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	285 .SetDescription("Execute the provided Lua script by the Orthanc server. This is very insecure for "
5200 f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5185 diff changeset	286 "Orthanc servers that are remotely accessible. Since Orthanc 1.5.8, this route "
f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5185 diff changeset	287 "is disabled by default and can be enabled thanks to the `ExecuteLuaEnabled` configuration.")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	288 .AddRequestType(MimeType_PlainText, "The Lua script to be executed")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	289 .AddAnswerType(MimeType_PlainText, "Output of the Lua script");
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	290 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	291 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	292
3535 41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	293 ServerContext& context = OrthancRestApi::GetContext(call);
3526 f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	294
3535 41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	295 if (!context.IsExecuteLuaEnabled())
41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	296 {
41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	297 LOG(ERROR) << "The URI /tools/execute-script is disallowed for security, "
5200 f8f1c4a9a216 New configuration option 'RestApiWriteToFileSystemEnabled' Alain Mazy <am@osimis.io> parents: 5185 diff changeset	298 << "check your configuration option `ExecuteLuaEnabled`";
3535 41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	299 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	300 return;
3526 f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	301 }
f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	302
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	303 std::string result;
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	304 std::string command;
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	305 call.BodyToString(command);
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1437 diff changeset	306
996 cf52f3bcb2b3 clarification of Lua classes wrt multithreading Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	307 {
2617 912a767911b0 back to a single Lua context Sebastien Jodogne <s.jodogne@gmail.com> parents: 2616 diff changeset	308 LuaScripting::Lock lock(context.GetLuaScripting());
2616 2f3007bf0708 event queues in Lua, serialization of sequence of operations Sebastien Jodogne <s.jodogne@gmail.com> parents: 2612 diff changeset	309 lock.GetLua().Execute(result, command);
996 cf52f3bcb2b3 clarification of Lua classes wrt multithreading Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	310 }
cf52f3bcb2b3 clarification of Lua classes wrt multithreading Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	311
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	312 call.GetOutput().AnswerBuffer(result, MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314
2475 8cc3ca64a534 Orthanc now uses UTC (universal time) instead of local time in its database Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	315 template <bool UTC>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	316 static void GetNowIsoString(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	317 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	318 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	319 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	320 std::string type(UTC ? "UTC" : "local");
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	321 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	322 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	323 .SetSummary("Get " + type + " time")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	324 .AddAnswerType(MimeType_PlainText, "The " + type + " time")
5433 38403e13c1ca cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 5432 diff changeset	325 .SetHttpGetSample("https://orthanc.uclouvain.be/demo" + call.FlattenUri(), false);
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	326 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	327 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	328
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	329 call.GetOutput().AnswerBuffer(SystemToolbox::GetNowIsoString(UTC), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	330 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	331
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	332
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	333 static void GetDicomConformanceStatement(RestApiGetCall& call)
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	334 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	335 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	336 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	337 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	338 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	339 .SetSummary("Get DICOM conformance")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	340 .SetDescription("Get the DICOM conformance statement of Orthanc")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	341 .AddAnswerType(MimeType_PlainText, "The DICOM conformance statement");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	342 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	343 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	344
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	345 std::string statement;
4031 e3b3af80732d ServerResources, and moving EmbeddedResourceHttpHandler from Core to OrthancServer Sebastien Jodogne <s.jodogne@gmail.com> parents: 3672 diff changeset	346 GetFileResource(statement, ServerResources::DICOM_CONFORMANCE_STATEMENT);
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	347 call.GetOutput().AnswerBuffer(statement, MimeType_PlainText);
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	348 }
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	349
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	350
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	351 static void GetDefaultEncoding(RestApiGetCall& call)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	352 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	353 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	354 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	355 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	356 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	357 .SetSummary("Get default encoding")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	358 .SetDescription("Get the default encoding that is used by Orthanc if parsing "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	359 "a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	360 "This corresponds to the configuration option `DefaultEncoding`.")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	361 .AddAnswerType(MimeType_PlainText, "The name of the encoding");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	362 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	363 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	364
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	365 Encoding encoding = GetDefaultDicomEncoding();
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	366 call.GetOutput().AnswerBuffer(EnumerationToString(encoding), MimeType_PlainText);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	367 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	368
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	369
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	370 static void SetDefaultEncoding(RestApiPutCall& call)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	371 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	372 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	373 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	374 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	375 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	376 .SetSummary("Set default encoding")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	377 .SetDescription("Change the default encoding that is used by Orthanc if parsing "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	378 "a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	379 "This corresponds to the configuration option `DefaultEncoding`.")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	380 .AddRequestType(MimeType_PlainText, "The name of the encoding. Check out configuration "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	381 "option `DefaultEncoding` for the allowed values.");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	382 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	383 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	384
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	385 std::string body;
962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	386 call.BodyToString(body);
962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	387
962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	388 Encoding encoding = StringToEncoding(body.c_str());
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	389
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	390 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	391 OrthancConfiguration::WriterLock lock;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	392 lock.GetConfiguration().SetDefaultEncoding(encoding);
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	393 }
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	394
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	395 call.GetOutput().AnswerBuffer(EnumerationToString(encoding), MimeType_PlainText);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	396 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	397
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	398
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: 4461 diff changeset	399 static void AnswerAcceptedTransferSyntaxes(RestApiCall& call)
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: 4461 diff changeset	400 {
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: 4461 diff changeset	401 std::set<DicomTransferSyntax> syntaxes;
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: 4461 diff changeset	402 OrthancRestApi::GetContext(call).GetAcceptedTransferSyntaxes(syntaxes);
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: 4461 diff changeset	403
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: 4461 diff changeset	404 Json::Value json = Json::arrayValue;
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: 4461 diff changeset	405 for (std::set<DicomTransferSyntax>::const_iterator
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: 4461 diff changeset	406 syntax = syntaxes.begin(); syntax != syntaxes.end(); ++syntax)
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: 4461 diff changeset	407 {
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: 4461 diff changeset	408 json.append(GetTransferSyntaxUid(*syntax));
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: 4461 diff changeset	409 }
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: 4461 diff changeset	410
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: 4461 diff changeset	411 call.GetOutput().AnswerJson(json);
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: 4461 diff changeset	412 }
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: 4461 diff changeset	413
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: 4461 diff changeset	414
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: 4461 diff changeset	415 static void GetAcceptedTransferSyntaxes(RestApiGetCall& call)
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: 4461 diff changeset	416 {
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: 4461 diff changeset	417 if (call.IsDocumentation())
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: 4461 diff changeset	418 {
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: 4461 diff changeset	419 call.GetDocumentation()
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: 4461 diff changeset	420 .SetTag("System")
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: 4461 diff changeset	421 .SetSummary("Get accepted transfer syntaxes")
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: 4461 diff changeset	422 .SetDescription("Get the list of UIDs of the DICOM transfer syntaxes that are accepted "
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: 4461 diff changeset	423 "by Orthanc C-STORE SCP. This corresponds to the configuration options "
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: 4461 diff changeset	424 "`AcceptedTransferSyntaxes` and `XXXTransferSyntaxAccepted`.")
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: 4461 diff changeset	425 .AddAnswerType(MimeType_Json, "JSON array containing the transfer syntax UIDs");
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: 4461 diff changeset	426 return;
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: 4461 diff changeset	427 }
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: 4461 diff changeset	428
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: 4461 diff changeset	429 AnswerAcceptedTransferSyntaxes(call);
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: 4461 diff changeset	430 }
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: 4461 diff changeset	431
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: 4461 diff changeset	432
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: 4461 diff changeset	433 static void SetAcceptedTransferSyntaxes(RestApiPutCall& call)
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: 4461 diff changeset	434 {
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: 4461 diff changeset	435 if (call.IsDocumentation())
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: 4461 diff changeset	436 {
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: 4461 diff changeset	437 call.GetDocumentation()
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: 4461 diff changeset	438 .SetTag("System")
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: 4461 diff changeset	439 .SetSummary("Set accepted transfer syntaxes")
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: 4461 diff changeset	440 .SetDescription("Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP")
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: 4461 diff changeset	441 .AddRequestType(MimeType_PlainText, "UID of the transfer syntax to be accepted. "
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: 4461 diff changeset	442 "Wildcards `?` and `*` are accepted.")
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: 4461 diff changeset	443 .AddRequestType(MimeType_Json, "JSON array containing a list of transfer syntax "
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: 4461 diff changeset	444 "UIDs to be accepted. Wildcards `?` and `*` are accepted.")
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: 4461 diff changeset	445 .AddAnswerType(MimeType_Json, "JSON array containing the now-accepted transfer syntax UIDs");
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: 4461 diff changeset	446 return;
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: 4461 diff changeset	447 }
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: 4461 diff changeset	448
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	449 std::set<DicomTransferSyntax> syntaxes;
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: 4461 diff changeset	450
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	451 Json::Value json;
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	452 if (call.ParseJsonRequest(json))
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	453 {
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	454 OrthancConfiguration::ParseAcceptedTransferSyntaxes(syntaxes, json);
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	455 }
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	456 else
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	457 {
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	458 std::string body;
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	459 call.BodyToString(body);
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	460 OrthancConfiguration::ParseAcceptedTransferSyntaxes(syntaxes, body);
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	461 }
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	462
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: 4461 diff changeset	463 OrthancRestApi::GetContext(call).SetAcceptedTransferSyntaxes(syntaxes);
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: 4461 diff changeset	464
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: 4461 diff changeset	465 AnswerAcceptedTransferSyntaxes(call);
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: 4461 diff changeset	466 }
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: 4461 diff changeset	467
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: 4461 diff changeset	468
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: 4461 diff changeset	469 static void GetUnknownSopClassAccepted(RestApiGetCall& call)
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: 4461 diff changeset	470 {
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: 4461 diff changeset	471 if (call.IsDocumentation())
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: 4461 diff changeset	472 {
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: 4461 diff changeset	473 call.GetDocumentation()
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: 4461 diff changeset	474 .SetTag("System")
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: 4461 diff changeset	475 .SetSummary("Is unknown SOP class accepted?")
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: 4461 diff changeset	476 .SetDescription("Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?")
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: 4461 diff changeset	477 .AddAnswerType(MimeType_PlainText, "`1` if accepted, `0` if not accepted");
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: 4461 diff changeset	478 return;
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: 4461 diff changeset	479 }
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: 4461 diff changeset	480
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: 4461 diff changeset	481 const bool accepted = OrthancRestApi::GetContext(call).IsUnknownSopClassAccepted();
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: 4461 diff changeset	482 call.GetOutput().AnswerBuffer(accepted ? "1" : "0", MimeType_PlainText);
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: 4461 diff changeset	483 }
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: 4461 diff changeset	484
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: 4461 diff changeset	485
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: 4461 diff changeset	486 static void SetUnknownSopClassAccepted(RestApiPutCall& call)
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: 4461 diff changeset	487 {
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: 4461 diff changeset	488 if (call.IsDocumentation())
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: 4461 diff changeset	489 {
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: 4461 diff changeset	490 call.GetDocumentation()
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: 4461 diff changeset	491 .SetTag("System")
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: 4461 diff changeset	492 .SetSummary("Set unknown SOP class accepted")
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: 4461 diff changeset	493 .SetDescription("Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID")
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: 4461 diff changeset	494 .AddRequestType(MimeType_PlainText, "`1` if accepted, `0` if not accepted");
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: 4461 diff changeset	495 return;
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: 4461 diff changeset	496 }
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: 4461 diff changeset	497
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: 4461 diff changeset	498 OrthancRestApi::GetContext(call).SetUnknownSopClassAccepted(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: 4461 diff changeset	499 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
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: 4461 diff changeset	500 }
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: 4461 diff changeset	501
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: 4461 diff changeset	502
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	503
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	504 // Plugins information ------------------------------------------------------
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	505
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	506 static void ListPlugins(RestApiGetCall& call)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	507 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	508 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	509 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	510 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	511 .SetTag("System")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	512 .SetSummary("List plugins")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	513 .SetDescription("List all the installed plugins")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	514 .AddAnswerType(MimeType_Json, "JSON array containing the identifiers of the installed plugins")
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	515 .SetHttpGetSample("https://orthanc.uclouvain.be/demo/plugins", true);
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	516 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	517 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	518
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	519 Json::Value v = Json::arrayValue;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	520
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	521 v.append("explorer.js");
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	522
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	523 if (OrthancRestApi::GetContext(call).HasPlugins())
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	524 {
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	525 #if ORTHANC_ENABLE_PLUGINS == 1
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	526 std::list<std::string> plugins;
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	527 OrthancRestApi::GetContext(call).GetPlugins().GetManager().ListPlugins(plugins);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	528
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	529 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	530 it = plugins.begin(); it != plugins.end(); ++it)
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	531 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	532 v.append(*it);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	533 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	534 #endif
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	535 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	536
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	537 call.GetOutput().AnswerJson(v);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	538 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	539
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	540
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	541 static void GetPlugin(RestApiGetCall& call)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	542 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	543 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	544 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	545 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	546 .SetTag("System")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	547 .SetSummary("Get plugin")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	548 .SetDescription("Get system information about the plugin whose identifier is provided in the URL")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	549 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	550 .AddAnswerType(MimeType_Json, "JSON object containing information about the plugin")
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	551 .SetHttpGetSample("https://orthanc.uclouvain.be/demo/plugins/dicom-web", true);
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	552 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	553 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	554
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	555 if (!OrthancRestApi::GetContext(call).HasPlugins())
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	556 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	557 return;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	558 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	559
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	560 #if ORTHANC_ENABLE_PLUGINS == 1
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	561 const PluginsManager& manager = OrthancRestApi::GetContext(call).GetPlugins().GetManager();
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	562 std::string id = call.GetUriComponent("id", "");
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	563
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	564 if (manager.HasPlugin(id))
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	565 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	566 Json::Value v = Json::objectValue;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	567 v["ID"] = id;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	568 v["Version"] = manager.GetPluginVersion(id);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	569
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	570 const OrthancPlugins& plugins = OrthancRestApi::GetContext(call).GetPlugins();
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	571 const char *c = plugins.GetProperty(id.c_str(), _OrthancPluginProperty_RootUri);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	572 if (c != NULL)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	573 {
1597 415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	574 std::string root = c;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	575 if (!root.empty())
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	576 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	577 // Turn the root URI into a URI relative to "/app/explorer.js"
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	578 if (root[0] == '/')
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	579 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	580 root = ".." + root;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	581 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	582
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	583 v["RootUri"] = root;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	584 }
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	585 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	586
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	587 c = plugins.GetProperty(id.c_str(), _OrthancPluginProperty_Description);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	588 if (c != NULL)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	589 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	590 v["Description"] = c;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	591 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	592
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	593 c = plugins.GetProperty(id.c_str(), _OrthancPluginProperty_OrthancExplorer);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	594 v["ExtendsOrthancExplorer"] = (c != NULL);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	595
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	596 call.GetOutput().AnswerJson(v);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	597 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	598 #endif
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	599 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	600
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	601
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	602 static void GetOrthancExplorerPlugins(RestApiGetCall& call)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	603 {
4418 9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	604 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	605 {
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	606 call.GetDocumentation()
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	607 .SetTag("System")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	608 .SetSummary("JavaScript extensions to Orthanc Explorer")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	609 .SetDescription("Get the JavaScript extensions that are installed by all the plugins using the "
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	610 "`OrthancPluginExtendOrthancExplorer()` function of the plugin SDK. "
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	611 "This route is for internal use of Orthanc Explorer.")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	612 .AddAnswerType(MimeType_JavaScript, "The JavaScript extensions");
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	613 return;
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	614 }
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	615
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	616 std::string s = "// Extensions to Orthanc Explorer by the registered plugins\n\n";
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	617
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	618 if (OrthancRestApi::GetContext(call).HasPlugins())
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	619 {
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	620 #if ORTHANC_ENABLE_PLUGINS == 1
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	621 const OrthancPlugins& plugins = OrthancRestApi::GetContext(call).GetPlugins();
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	622 const PluginsManager& manager = plugins.GetManager();
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	623
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	624 std::list<std::string> lst;
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	625 manager.ListPlugins(lst);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	626
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	627 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	628 it = lst.begin(); it != lst.end(); ++it)
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	629 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	630 const char* tmp = plugins.GetProperty(it->c_str(), _OrthancPluginProperty_OrthancExplorer);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	631 if (tmp != NULL)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	632 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	633 s += "/*\n From plugin: " + it + " (version " + manager.GetPluginVersion(it) + ")\n **/\n\n";
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	634 s += std::string(tmp) + "\n\n";
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	635 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	636 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	637 #endif
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	638 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	639
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	640 call.GetOutput().AnswerBuffer(s, MimeType_JavaScript);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	641 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	642
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	643
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	644
9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	645
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	646 // Jobs information ------------------------------------------------------
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	647
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	648 static void ListJobs(RestApiGetCall& call)
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	649 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	650 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	651 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	652 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	653 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	654 .SetSummary("List jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	655 .SetDescription("List all the available jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	656 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	657 "If present, retrieve detailed information about the individual jobs", false)
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	658 .AddAnswerType(MimeType_Json, "JSON array containing either the jobs identifiers, or detailed information "
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	659 "about the reported jobs (if `expand` argument is provided)")
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	660 .SetTruncatedJsonHttpGetSample("https://orthanc.uclouvain.be/demo/jobs", 3);
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	661 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	662 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	663
5405 62bb63346185 All 'expand' GET arguments now accepts expand=true and expand=false values + /studies/../instances now supports expand=false Alain Mazy <am@osimis.io> parents: 5364 diff changeset	664 bool expand = call.HasArgument("expand") && call.GetBooleanArgument("expand", true);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	665
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	666 Json::Value v = Json::arrayValue;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	667
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	668 std::set<std::string> jobs;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	669 OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().ListJobs(jobs);
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	670
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	671 for (std::set<std::string>::const_iterator it = jobs.begin();
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	672 it != jobs.end(); ++it)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	673 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	674 if (expand)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	675 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	676 JobInfo info;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	677 if (OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().GetJobInfo(info, *it))
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	678 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	679 Json::Value tmp;
2647 73d7d95dd75e removal of internal job information Sebastien Jodogne <s.jodogne@gmail.com> parents: 2617 diff changeset	680 info.Format(tmp);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	681 v.append(tmp);
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	682 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	683 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	684 else
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	685 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	686 v.append(*it);
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	687 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	688 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	689
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	690 call.GetOutput().AnswerJson(v);
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	691 }
9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	692
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	693 static void GetJobInfo(RestApiGetCall& call)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	694 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	695 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	696 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	697 Json::Value sample;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	698 sample["CompletionTime"] = "20201227T161842.520129";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	699 sample["Content"]["ArchiveSizeMB"] = 22;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	700 sample["Content"]["Description"] = "REST API";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	701 sample["Content"]["InstancesCount"] = 232;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	702 sample["Content"]["UncompressedSizeMB"] = 64;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	703 sample["CreationTime"] = "20201227T161836.428311";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	704 sample["EffectiveRuntime"] = 6.0810000000000004;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	705 sample["ErrorCode"] = 0;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	706 sample["ErrorDescription"] = "Success";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	707 sample["ID"] = "645ecb02-7c0e-4465-b767-df873222dcfb";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	708 sample["Priority"] = 0;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	709 sample["Progress"] = 100;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	710 sample["State"] = "Success";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	711 sample["Timestamp"] = "20201228T160340.253201";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	712 sample["Type"] = "Media";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	713
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	714 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	715 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	716 .SetSummary("Get job")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	717 .SetDescription("Retrieve detailed information about the job whose identifier is provided in the URL: "
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	718 "https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs")
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	719 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	720 .AddAnswerType(MimeType_Json, "JSON object detailing the job")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	721 .SetSample(sample);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	722 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	723 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	724
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	725 std::string id = call.GetUriComponent("id", "");
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	726
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	727 JobInfo info;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	728 if (OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().GetJobInfo(info, id))
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	729 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	730 Json::Value json;
2647 73d7d95dd75e removal of internal job information Sebastien Jodogne <s.jodogne@gmail.com> parents: 2617 diff changeset	731 info.Format(json);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	732 call.GetOutput().AnswerJson(json);
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	733 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	734 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	735
5364 b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	736 static void DeleteJobInfo(RestApiDeleteCall& call)
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	737 {
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	738 if (call.IsDocumentation())
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	739 {
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	740 call.GetDocumentation()
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	741 .SetTag("Jobs")
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	742 .SetSummary("Delete a job from history")
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	743 .SetDescription("Delete the job from the jobs history. Only a completed job can be deleted. "
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	744 "If the job has not run or not completed yet, you must cancel it first. "
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	745 "If the job has outputs, all outputs will be deleted as well. ")
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	746 .SetUriArgument("id", "Identifier of the job of interest");
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	747 return;
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	748 }
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	749
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	750 std::string job = call.GetUriComponent("id", "");
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	751
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	752 if (OrthancRestApi::GetContext(call).GetJobsEngine().
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	753 GetRegistry().DeleteJobInfo(job))
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	754 {
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	755 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	756 }
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	757 else
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	758 {
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	759 throw OrthancException(ErrorCode_InexistentItem,
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	760 "No job found with this id: " + job);
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	761 }
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	762 }
b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	763
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	764
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	765 static void GetJobOutput(RestApiGetCall& call)
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	766 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	767 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	768 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	769 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	770 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	771 .SetSummary("Get job output")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	772 .SetDescription("Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a "
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	773 "DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	774 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	775 .SetUriArgument("key", "Name of the output of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	776 .AddAnswerType(MimeType_Binary, "Content of the output of the job");
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	777 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	778 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	779
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	780 std::string job = call.GetUriComponent("id", "");
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	781 std::string key = call.GetUriComponent("key", "");
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	782
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	783 std::string value;
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	784 MimeType mime;
4805 0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	785 std::string filename;
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	786
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	787 if (OrthancRestApi::GetContext(call).GetJobsEngine().
4805 0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	788 GetRegistry().GetJobOutput(value, mime, filename, job, key))
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	789 {
4805 0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	790 if (!filename.empty())
0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	791 {
0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	792 call.GetOutput().SetContentFilename(filename.c_str());
0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	793 }
0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	794
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	795 call.GetOutput().AnswerBuffer(value, mime);
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	796 }
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	797 else
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	798 {
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	799 throw OrthancException(ErrorCode_InexistentItem,
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	800 "Job has no such output: " + key);
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	801 }
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	802 }
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	803
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	804
5310 b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	805 static void DeleteJobOutput(RestApiDeleteCall& call)
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	806 {
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	807 if (call.IsDocumentation())
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	808 {
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	809 call.GetDocumentation()
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	810 .SetTag("Jobs")
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	811 .SetSummary("Delete a job output")
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	812 .SetDescription("Delete the output produced by a job. As of Orthanc 1.12.1, only the jobs that generate a "
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	813 "DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).")
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	814 .SetUriArgument("id", "Identifier of the job of interest")
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	815 .SetUriArgument("key", "Name of the output of interest");
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	816 return;
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	817 }
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	818
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	819 std::string job = call.GetUriComponent("id", "");
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	820 std::string key = call.GetUriComponent("key", "");
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	821
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	822 if (OrthancRestApi::GetContext(call).GetJobsEngine().
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	823 GetRegistry().DeleteJobOutput(job, key))
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	824 {
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	825 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	826 }
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	827 else
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	828 {
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	829 throw OrthancException(ErrorCode_InexistentItem,
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	830 "Job has no such output: " + key);
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	831 }
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	832 }
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	833
b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	834
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	835 enum JobAction
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	836 {
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	837 JobAction_Cancel,
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	838 JobAction_Pause,
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	839 JobAction_Resubmit,
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	840 JobAction_Resume
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	841 };
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	842
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	843 template <JobAction action>
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	844 static void ApplyJobAction(RestApiPostCall& call)
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	845 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	846 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	847 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	848 std::string verb;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	849 switch (action)
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	850 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	851 case JobAction_Cancel:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	852 verb = "Cancel";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	853 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	854
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	855 case JobAction_Pause:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	856 verb = "Pause";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	857 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	858
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	859 case JobAction_Resubmit:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	860 verb = "Resubmit";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	861 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	862
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	863 case JobAction_Resume:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	864 verb = "Resume";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	865 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	866
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	867 default:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	868 throw OrthancException(ErrorCode_InternalError);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	869 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	870
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	871 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	872 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	873 .SetSummary(verb + " job")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	874 .SetDescription(verb + " the job whose identifier is provided in the URL. Check out the "
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	875 "Orthanc Book for more information about the state machine applicable to jobs: "
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	876 "https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs")
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	877 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	878 .AddAnswerType(MimeType_Json, "Empty JSON object in the case of a success");
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	879 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	880 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	881
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	882 std::string id = call.GetUriComponent("id", "");
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	883
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	884 bool ok = false;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	885
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	886 switch (action)
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	887 {
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	888 case JobAction_Cancel:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	889 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Cancel(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	890 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	891
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	892 case JobAction_Pause:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	893 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Pause(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	894 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	895
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	896 case JobAction_Resubmit:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	897 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Resubmit(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	898 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	899
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	900 case JobAction_Resume:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	901 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Resume(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	902 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	903
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	904 default:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	905 throw OrthancException(ErrorCode_InternalError);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	906 }
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	907
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	908 if (ok)
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	909 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	910 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	911 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	912 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	913
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	914
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	915 static void GetMetricsPrometheus(RestApiGetCall& call)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	916 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	917 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	918 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	919 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	920 .SetTag("System")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	921 .SetSummary("Get usage metrics")
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4418 diff changeset	922 .SetDescription("Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): "
5432 59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	923 "https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus")
59e3b6f8c5be migration to UCLouvain servers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5431 diff changeset	924 .SetHttpGetSample("https://orthanc.uclouvain.be/demo/tools/metrics-prometheus", false);
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	925 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	926 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	927
3179 fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	928 #if ORTHANC_ENABLE_PLUGINS == 1
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	929 OrthancRestApi::GetContext(call).GetPlugins().RefreshMetrics();
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	930 #endif
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	931
3177 053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	932 static const float MEGA_BYTES = 1024 * 1024;
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	933
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	934 ServerContext& context = OrthancRestApi::GetContext(call);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	935
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	936 uint64_t diskSize, uncompressedSize, countPatients, countStudies, countSeries, countInstances;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	937 context.GetIndex().GetGlobalStatistics(diskSize, uncompressedSize, countPatients,
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	938 countStudies, countSeries, countInstances);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	939
3179 fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	940 unsigned int jobsPending, jobsRunning, jobsSuccess, jobsFailed;
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	941 context.GetJobsEngine().GetRegistry().GetStatistics(jobsPending, jobsRunning, jobsSuccess, jobsFailed);
3177 053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	942
5111 7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	943 int64_t serverUpTime = context.GetServerUpTime();
7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	944 Json::Value lastChange;
7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	945 context.GetIndex().GetLastChange(lastChange);
7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	946
3177 053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	947 MetricsRegistry& registry = context.GetMetricsRegistry();
5337 b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	948 registry.SetFloatValue("orthanc_disk_size_mb", static_cast<float>(diskSize) / MEGA_BYTES);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	949 registry.SetFloatValue("orthanc_uncompressed_size_mb", static_cast<float>(diskSize) / MEGA_BYTES);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	950 registry.SetIntegerValue("orthanc_count_patients", static_cast<int64_t>(countPatients));
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	951 registry.SetIntegerValue("orthanc_count_studies", static_cast<int64_t>(countStudies));
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	952 registry.SetIntegerValue("orthanc_count_series", static_cast<int64_t>(countSeries));
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	953 registry.SetIntegerValue("orthanc_count_instances", static_cast<int64_t>(countInstances));
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	954 registry.SetIntegerValue("orthanc_jobs_pending", jobsPending);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	955 registry.SetIntegerValue("orthanc_jobs_running", jobsRunning);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	956 registry.SetIntegerValue("orthanc_jobs_completed", jobsSuccess + jobsFailed);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	957 registry.SetIntegerValue("orthanc_jobs_success", jobsSuccess);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	958 registry.SetIntegerValue("orthanc_jobs_failed", jobsFailed);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	959 registry.SetIntegerValue("orthanc_up_time_s", serverUpTime);
b376abae664a Metrics can be stored either as floating-point numbers, or as integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 5330 diff changeset	960 registry.SetIntegerValue("orthanc_last_change", lastChange["Last"].asInt64());
5111 7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	961
5431 4be5f117aa0d metrics Alain Mazy <am@osimis.io> parents: 5405 diff changeset	962 context.PublishCacheMetrics();
4be5f117aa0d metrics Alain Mazy <am@osimis.io> parents: 5405 diff changeset	963
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	964 std::string s;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	965 registry.ExportPrometheusText(s);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	966
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	967 call.GetOutput().AnswerBuffer(s, MimeType_PrometheusText);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	968 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	969
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	970
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	971 static void GetMetricsEnabled(RestApiGetCall& call)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	972 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	973 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	974 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	975 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	976 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	977 .SetSummary("Are metrics collected?")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	978 .SetDescription("Returns a Boolean specifying whether Prometheus metrics "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	979 "are collected and exposed at `/tools/metrics-prometheus`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	980 .AddAnswerType(MimeType_PlainText, "`1` if metrics are collected, `0` if metrics are disabled");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	981 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	982 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	983
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	984 bool enabled = OrthancRestApi::GetContext(call).GetMetricsRegistry().IsEnabled();
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	985 call.GetOutput().AnswerBuffer(enabled ? "1" : "0", MimeType_PlainText);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	986 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	987
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	988
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	989 static void PutMetricsEnabled(RestApiPutCall& call)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	990 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	991 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	992 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	993 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	994 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	995 .SetSummary("Enable collection of metrics")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	996 .SetDescription("Enable or disable the collection and publication of metrics at `/tools/metrics-prometheus`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	997 .AddRequestType(MimeType_PlainText, "`1` if metrics are collected, `0` if metrics are disabled");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	998 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	999 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1000
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: 4461 diff changeset	1001 const bool enabled = call.ParseBooleanBody();
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1002
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1003 // Success
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1004 OrthancRestApi::GetContext(call).GetMetricsRegistry().SetEnabled(enabled);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1005 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1006 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1007
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1008
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1009 static void GetLogLevel(RestApiGetCall& call)
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1010 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1011 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1012 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1013 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1014 .SetTag("Logs")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1015 .SetSummary("Get main log level")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1016 .SetDescription("Get the main log level of Orthanc")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1017 .AddAnswerType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1018 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1019 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1020
4273 0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4143 diff changeset	1021 const std::string s = EnumerationToString(GetGlobalVerbosity());
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1022 call.GetOutput().AnswerBuffer(s, MimeType_PlainText);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1023 }
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1024
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1025
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1026 static void PutLogLevel(RestApiPutCall& call)
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1027 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1028 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1029 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1030 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1031 .SetTag("Logs")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1032 .SetSummary("Set main log level")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1033 .SetDescription("Set the main log level of Orthanc")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1034 .AddRequestType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1035 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1036 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1037
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1038 std::string body;
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1039 call.BodyToString(body);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1040
4273 0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4143 diff changeset	1041 SetGlobalVerbosity(StringToVerbosity(body));
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 4143 diff changeset	1042
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1043 // Success
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1044 LOG(WARNING) << "REST API call has switched the log level to: " << body;
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1045 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1046 }
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1047
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1048
4275 d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1049 static Logging::LogCategory GetCategory(const RestApiCall& call)
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1050 {
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1051 static const std::string PREFIX = "log-level-";
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1052
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1053 if (call.GetFullUri().size() == 2 &&
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1054 call.GetFullUri() [0] == "tools" &&
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1055 boost::starts_with(call.GetFullUri() [1], PREFIX))
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1056 {
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1057 Logging::LogCategory category;
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1058 if (Logging::LookupCategory(category, call.GetFullUri() [1].substr(PREFIX.size())))
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1059 {
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1060 return category;
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1061 }
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1062 }
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1063
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1064 throw OrthancException(ErrorCode_InternalError);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1065 }
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1066
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1067
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1068 static void GetLogLevelCategory(RestApiGetCall& call)
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1069 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1070 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1071 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1072 std::string category = Logging::GetCategoryName(GetCategory(call));
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1073 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1074 .SetTag("Logs")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1075 .SetSummary("Get log level for `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1076 .SetDescription("Get the log level of the log category `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1077 .AddAnswerType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1078 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1079 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1080
4275 d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1081 const std::string s = EnumerationToString(GetCategoryVerbosity(GetCategory(call)));
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1082 call.GetOutput().AnswerBuffer(s, MimeType_PlainText);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1083 }
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1084
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1085
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1086 static void PutLogLevelCategory(RestApiPutCall& call)
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1087 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1088 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1089 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1090 std::string category = Logging::GetCategoryName(GetCategory(call));
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1091 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1092 .SetTag("Logs")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1093 .SetSummary("Set log level for `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1094 .SetDescription("Set the log level of the log category `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1095 .AddRequestType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1096 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1097 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1098
4275 d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1099 std::string body;
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1100 call.BodyToString(body);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1101
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1102 Verbosity verbosity = StringToVerbosity(body);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1103 Logging::LogCategory category = GetCategory(call);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1104 SetCategoryVerbosity(category, verbosity);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1105
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1106 // Success
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1107 LOG(WARNING) << "REST API call has switched the log level of category \""
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1108 << Logging::GetCategoryName(category) << "\" to \""
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1109 << EnumerationToString(verbosity) << "\"";
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1110 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1111 }
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1112
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1113
5249 f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1114 static void ListAllLabels(RestApiGetCall& call)
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1115 {
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1116 if (call.IsDocumentation())
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1117 {
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1118 call.GetDocumentation()
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1119 .SetTag("System")
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1120 .SetSummary("Get all the used labels")
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1121 .SetDescription("List all the labels that are associated with any resource of the Orthanc database")
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1122 .AddAnswerType(MimeType_Json, "JSON array containing the labels");
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1123 return;
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1124 }
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1125
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1126 std::set<std::string> labels;
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1127 OrthancRestApi::GetIndex(call).ListAllLabels(labels);
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1128
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1129 Json::Value json = Json::arrayValue;
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1130 for (std::set<std::string>::const_iterator it = labels.begin(); it != labels.end(); ++it)
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1131 {
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1132 json.append(*it);
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1133 }
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1134
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1135 call.GetOutput().AnswerJson(json);
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1136 }
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1137
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1138
4378 9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1139 void OrthancRestApi::RegisterSystem(bool orthancExplorerEnabled)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1140 {
4378 9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1141 if (orthancExplorerEnabled)
9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1142 {
9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1143 Register("/", ServeRoot);
4461 22abc6851191 The DICOM meta-header and the transfer syntax are displayed at the "Instance" level Sebastien Jodogne <s.jodogne@gmail.com> parents: 4437 diff changeset	1144 Register("/favicon.ico", ServeFavicon); // New in Orthanc 1.9.0
4378 9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1145 }
4379 85b5b0e1bac9 added NEWS about "OrthancExplorerEnabled" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4378 diff changeset	1146
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1147 Register("/system", GetSystemInformation);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1148 Register("/statistics", GetStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1149 Register("/tools/generate-uid", GenerateUid);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1150 Register("/tools/execute-script", ExecuteScript);
2475 8cc3ca64a534 Orthanc now uses UTC (universal time) instead of local time in its database Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	1151 Register("/tools/now", GetNowIsoString<true>);
8cc3ca64a534 Orthanc now uses UTC (universal time) instead of local time in its database Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	1152 Register("/tools/now-local", GetNowIsoString<false>);
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	1153 Register("/tools/dicom-conformance", GetDicomConformanceStatement);
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	1154 Register("/tools/default-encoding", GetDefaultEncoding);
9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	1155 Register("/tools/default-encoding", SetDefaultEncoding);
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1156 Register("/tools/metrics", GetMetricsEnabled);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1157 Register("/tools/metrics", PutMetricsEnabled);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1158 Register("/tools/metrics-prometheus", GetMetricsPrometheus);
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1159 Register("/tools/log-level", GetLogLevel);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1160 Register("/tools/log-level", PutLogLevel);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	1161
4275 d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1162 for (size_t i = 0; i < Logging::GetCategoriesCount(); i++)
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1163 {
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1164 const std::string name(Logging::GetCategoryName(i));
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1165 Register("/tools/log-level-" + name, GetLogLevelCategory);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1166 Register("/tools/log-level-" + name, PutLogLevelCategory);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1167 }
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 4273 diff changeset	1168
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	1169 Register("/plugins", ListPlugins);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	1170 Register("/plugins/{id}", GetPlugin);
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	1171 Register("/plugins/explorer.js", GetOrthancExplorerPlugins);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	1172
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	1173 Register("/jobs", ListJobs);
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	1174 Register("/jobs/{id}", GetJobInfo);
5364 b5f2122a1334 Added a route to delete completed jobs from history: DELETE /jobs/{id} Alain Mazy <am@osimis.io> parents: 5337 diff changeset	1175 Register("/jobs/{id}", DeleteJobInfo);
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1176 Register("/jobs/{id}/cancel", ApplyJobAction<JobAction_Cancel>);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1177 Register("/jobs/{id}/pause", ApplyJobAction<JobAction_Pause>);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1178 Register("/jobs/{id}/resubmit", ApplyJobAction<JobAction_Resubmit>);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1179 Register("/jobs/{id}/resume", ApplyJobAction<JobAction_Resume>);
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	1180 Register("/jobs/{id}/{key}", GetJobOutput);
5310 b5c502bcaf99 added a route to DELETE /jobs/../archive Alain Mazy <am@osimis.io> parents: 5249 diff changeset	1181 Register("/jobs/{id}/{key}", DeleteJobOutput);
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: 4461 diff changeset	1182
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: 4461 diff changeset	1183 // New in Orthanc 1.9.0
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: 4461 diff changeset	1184 Register("/tools/accepted-transfer-syntaxes", GetAcceptedTransferSyntaxes);
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: 4461 diff changeset	1185 Register("/tools/accepted-transfer-syntaxes", SetAcceptedTransferSyntaxes);
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: 4461 diff changeset	1186 Register("/tools/unknown-sop-class-accepted", GetUnknownSopClassAccepted);
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: 4461 diff changeset	1187 Register("/tools/unknown-sop-class-accepted", SetUnknownSopClassAccepted);
5249 f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1188
f22c8fac764b added "/tools/labels" to list all the labels that are associated with any resource Sebastien Jodogne <s.jodogne@gmail.com> parents: 5238 diff changeset	1189 Register("/tools/labels", ListAllLabels); // New in Orthanc 1.12.0
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1190 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1191 }

Mercurial > hg > orthanc

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestSystem.cpp @ 5621:732ec9feeea8 find-refactoring