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

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestSystem.cpp @ 5227:988dab8deb1c db-protobuf

"/tools/find" accepts the "WithLabels" and "WithoutLabels" arguments

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 04 Apr 2023 09:16:12 +0200
parents	08e0c9c0ab39
children	367e8af46cfd

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
5185 0ea402b4d901 upgrade to year 2023 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5144 diff changeset	5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
0ea402b4d901 upgrade to year 2023 Sebastien Jodogne <s.jodogne@gmail.com> parents: 5144 diff changeset	6 * Copyright (C) 2021-2023 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";
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	90 static const char* const MAXIMUM_STORAGE_MODE = "MaximumStorageMode";
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	91 static const char* const USER_METADATA = "UserMetadata";
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	92
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	93 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	94 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	95 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	96 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	97 .SetSummary("Get system information")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	98 .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	99 .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	100 .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	101 .SetAnswerField(DATABASE_VERSION, RestApiCallDocumentation::Type_Number,
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	102 "Version of the database: https://book.orthanc-server.com/developers/db-versioning.html")
5024 c2ebc47f4f18 wip: adding DelayedDeletion plugin Alain Mazy <am@osimis.io> parents: 4988 diff changeset	103 .SetAnswerField(DATABASE_SERVER_IDENTIFIER, RestApiCallDocumentation::Type_String,
c2ebc47f4f18 wip: adding DelayedDeletion plugin Alain Mazy <am@osimis.io> parents: 4988 diff changeset	104 "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	105 .SetAnswerField(IS_HTTP_SERVER_SECURE, RestApiCallDocumentation::Type_Boolean,
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	106 "Whether the REST API is properly secured (assuming no reverse proxy is in use): https://book.orthanc-server.com/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	107 .SetAnswerField(STORAGE_AREA_PLUGIN, RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	108 "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	109 .SetAnswerField(DATABASE_BACKEND_PLUGIN, RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	110 "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	111 .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	112 .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	113 .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	114 .SetAnswerField(NAME, RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	115 "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	116 .SetAnswerField(PLUGINS_ENABLED, RestApiCallDocumentation::Type_Boolean,
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	117 "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	118 .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	119 "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	120 .SetAnswerField(MAIN_DICOM_TAGS, RestApiCallDocumentation::Type_JsonObject,
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	121 "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	122 .SetAnswerField(STORAGE_COMPRESSION, RestApiCallDocumentation::Type_Boolean,
f316413027fd renamed DbOptizer into Housekeeper + add Scheduler & triggers Alain Mazy <am@osimis.io> parents: 4961 diff changeset	123 "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	124 .SetAnswerField(OVERWRITE_INSTANCES, RestApiCallDocumentation::Type_Boolean,
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	125 "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	126 .SetAnswerField(INGEST_TRANSCODING, RestApiCallDocumentation::Type_String,
8fba26292a9f Housekeeper plugin: finalizing + integration tests ok Alain Mazy <am@osimis.io> parents: 4979 diff changeset	127 "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	128 .SetAnswerField(MAXIMUM_STORAGE_SIZE, RestApiCallDocumentation::Type_Number,
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	129 "The configured MaximumStorageSize in MB (new in Orthanc 1.11.3)")
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	130 .SetAnswerField(MAXIMUM_STORAGE_MODE, RestApiCallDocumentation::Type_String,
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	131 "The configured MaximumStorageMode (new in Orthanc 1.11.3)")
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	132 .SetAnswerField(USER_METADATA, RestApiCallDocumentation::Type_JsonObject,
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	133 "The configured UserMetadata (new in Orthanc 1.12.0)")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	134 .SetHttpGetSample("https://demo.orthanc-server.com/system", true);
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	135 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	136 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	137
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	138 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	139
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	140 Json::Value result = Json::objectValue;
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	141
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	142 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	143 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	144 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	145 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	146
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	147 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	148 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	149 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	150 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	151 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	152 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	153 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	154 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	155 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	156 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	157 result[DATABASE_SERVER_IDENTIFIER] = lock.GetConfiguration().GetDatabaseServerIdentifier();
5120 a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	158 result[MAXIMUM_STORAGE_SIZE] = lock.GetConfiguration().GetUnsignedIntegerParameter(MAXIMUM_STORAGE_SIZE, 0); // New in Orthanc 1.11.3
a6fa660ec26e /system: added MaximumStorageMode and MaximumStorageSize Alain Mazy <am@osimis.io> parents: 5111 diff changeset	159 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	160 }
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161
4628 5fabef29c4ff added new primitive "hasRevisionsSupport" in database SDK, added "CheckRevisions" to URI "/system" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4474 diff changeset	162 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	163 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	164
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	165 #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	166 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	167 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	168
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	169 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	170 {
1631 0d074f5f6069 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	171 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	172 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	173 }
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	174
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 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	176 {
1631 0d074f5f6069 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	177 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	178 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	179 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	180 #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	181 result[PLUGINS_ENABLED] = false;
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	182 #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	183
4950 3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	184 result[MAIN_DICOM_TAGS] = Json::objectValue;
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	185 GetMainDicomTagsConfiguration(result[MAIN_DICOM_TAGS]);
3778a0433dd3 new field 'MainDicomTags' in the /system response Alain Mazy <am@osimis.io> parents: 4892 diff changeset	186
5204 08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	187 result[USER_METADATA] = Json::objectValue;
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	188 GetUserMetadataConfiguration(result[USER_METADATA]);
08e0c9c0ab39 added UserMetadata in /system Alain Mazy <am@osimis.io> parents: 5200 diff changeset	189
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	190 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	191 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	192
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	193 static void GetStatistics(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	194 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	195 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	196 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	197 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	198 .SetTag("System")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	199 .SetSummary("Get database statistics")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	200 .SetDescription("Get statistics related to the database of Orthanc")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	201 .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	202 .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	203 .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	204 .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	205 .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	206 .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	207 .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	208 .SetAnswerField("TotalUncompressedSizeMB", RestApiCallDocumentation::Type_Number, "Total size of all the files once uncompressed (in megabytes)")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	209 .SetHttpGetSample("https://demo.orthanc-server.com/statistics", true);
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	210 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	211 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	212
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	213 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	214
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	215 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	216 OrthancRestApi::GetIndex(call).GetGlobalStatistics(diskSize, uncompressedSize, countPatients,
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	217 countStudies, countSeries, countInstances);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	218
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219 Json::Value result = Json::objectValue;
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	220 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	221 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	222 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	223 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	224 result["CountPatients"] = static_cast<unsigned int>(countPatients);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	225 result["CountStudies"] = static_cast<unsigned int>(countStudies);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	226 result["CountSeries"] = static_cast<unsigned int>(countSeries);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	227 result["CountInstances"] = static_cast<unsigned int>(countInstances);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	228
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	229 call.GetOutput().AnswerJson(result);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	230 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	231
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	232 static void GenerateUid(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	233 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	234 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	235 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	236 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	237 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	238 .SetSummary("Generate an identifier")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	239 .SetDescription("Generate a random DICOM identifier")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	240 .SetHttpGetArgument("level", RestApiCallDocumentation::Type_String,
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	241 "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	242 .AddAnswerType(MimeType_PlainText, "The generated identifier");
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	243 return;
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
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	246 std::string level = call.GetArgument("level", "");
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	247 if (level == "patient")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	248 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	249 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Patient), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	250 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	251 else if (level == "study")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	252 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	253 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Study), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	254 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	255 else if (level == "series")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	256 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	257 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Series), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	258 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	259 else if (level == "instance")
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	260 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	261 call.GetOutput().AnswerBuffer(FromDcmtkBridge::GenerateUniqueIdentifier(ResourceType_Instance), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	262 }
5144 9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	263 else
9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	264 {
9fc5bf6f3c75 error message if level not specified in /tools/generate-uid Alain Mazy <am@osimis.io> parents: 5120 diff changeset	265 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	266 }
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
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	269 static void ExecuteScript(RestApiPostCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	270 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	271 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	272 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	273 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	274 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	275 .SetSummary("Execute Lua script")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	276 .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	277 "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	278 "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	279 .AddRequestType(MimeType_PlainText, "The Lua script to be executed")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	280 .AddAnswerType(MimeType_PlainText, "Output of the Lua script");
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	281 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	282 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	283
3535 41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	284 ServerContext& context = OrthancRestApi::GetContext(call);
3526 f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	285
3535 41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	286 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	287 {
41365091a41e display a security warning in the logs at startup when ExecuteLuaEnabled is true Alain Mazy <alain@mazy.be> parents: 3534 diff changeset	288 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	289 << "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	290 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	291 return;
3526 f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	292 }
f07352e0375c new configuration option ExecuteLuaEnabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	293
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	294 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	295 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	296 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	297
996 cf52f3bcb2b3 clarification of Lua classes wrt multithreading Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	298 {
2617 912a767911b0 back to a single Lua context Sebastien Jodogne <s.jodogne@gmail.com> parents: 2616 diff changeset	299 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	300 lock.GetLua().Execute(result, command);
996 cf52f3bcb2b3 clarification of Lua classes wrt multithreading Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	301 }
cf52f3bcb2b3 clarification of Lua classes wrt multithreading Sebastien Jodogne <s.jodogne@gmail.com> parents: 974 diff changeset	302
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	303 call.GetOutput().AnswerBuffer(result, MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	305
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	306 template <bool UTC>
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 831 diff changeset	307 static void GetNowIsoString(RestApiGetCall& call)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	308 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	309 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	310 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	311 std::string type(UTC ? "UTC" : "local");
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	312 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	313 .SetTag("System")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	314 .SetSummary("Get " + type + " time")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	315 .AddAnswerType(MimeType_PlainText, "The " + type + " time")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	316 .SetHttpGetSample("https://demo.orthanc-server.com" + call.FlattenUri(), false);
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	317 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	318 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	319
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	320 call.GetOutput().AnswerBuffer(SystemToolbox::GetNowIsoString(UTC), MimeType_PlainText);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	321 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	322
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	323
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	324 static void GetDicomConformanceStatement(RestApiGetCall& call)
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	325 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	326 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	327 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	328 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	329 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	330 .SetSummary("Get DICOM conformance")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	331 .SetDescription("Get the DICOM conformance statement of Orthanc")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	332 .AddAnswerType(MimeType_PlainText, "The DICOM conformance statement");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	333 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	334 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	335
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	336 std::string statement;
4031 e3b3af80732d ServerResources, and moving EmbeddedResourceHttpHandler from Core to OrthancServer Sebastien Jodogne <s.jodogne@gmail.com> parents: 3672 diff changeset	337 GetFileResource(statement, ServerResources::DICOM_CONFORMANCE_STATEMENT);
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	338 call.GetOutput().AnswerBuffer(statement, MimeType_PlainText);
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	339 }
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	340
01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	341
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	342 static void GetDefaultEncoding(RestApiGetCall& call)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	343 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	344 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	345 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	346 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	347 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	348 .SetSummary("Get default encoding")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	349 .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	350 "a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	351 "This corresponds to the configuration option `DefaultEncoding`.")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	352 .AddAnswerType(MimeType_PlainText, "The name of the encoding");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	353 return;
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
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	356 Encoding encoding = GetDefaultDicomEncoding();
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	357 call.GetOutput().AnswerBuffer(EnumerationToString(encoding), MimeType_PlainText);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	358 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	359
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	360
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	361 static void SetDefaultEncoding(RestApiPutCall& call)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	362 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	363 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	364 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	365 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	366 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	367 .SetSummary("Set default encoding")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	368 .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	369 "a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	370 "This corresponds to the configuration option `DefaultEncoding`.")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	371 .AddRequestType(MimeType_PlainText, "The name of the encoding. Check out configuration "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	372 "option `DefaultEncoding` for the allowed values.");
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	373 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	374 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	375
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	376 std::string body;
962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	377 call.BodyToString(body);
962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	378
962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3179 diff changeset	379 Encoding encoding = StringToEncoding(body.c_str());
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	380
2940 4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	381 {
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	382 OrthancConfiguration::WriterLock lock;
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	383 lock.GetConfiguration().SetDefaultEncoding(encoding);
4767d36679ed refactoring access to Orthanc configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 2908 diff changeset	384 }
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	385
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	386 call.GetOutput().AnswerBuffer(EnumerationToString(encoding), MimeType_PlainText);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	387 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	388
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	389
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	390 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	391 {
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	392 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	393 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	394
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	395 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	396 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	397 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	398 {
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 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	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
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 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	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
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
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 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	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 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	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 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	411 .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	412 .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	413 .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	414 "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	415 "`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	416 .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	417 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	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
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 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	421 }
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
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
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 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	425 {
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 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	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 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	429 .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	430 .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	431 .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	432 .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	433 "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	434 .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	435 "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	436 .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	437 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	438 }
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
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	440 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	441
4474 f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	442 Json::Value json;
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	443 if (call.ParseJsonRequest(json))
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	444 {
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	445 OrthancConfiguration::ParseAcceptedTransferSyntaxes(syntaxes, json);
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	446 }
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	447 else
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	448 {
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	449 std::string body;
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	450 call.BodyToString(body);
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	451 OrthancConfiguration::ParseAcceptedTransferSyntaxes(syntaxes, body);
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	452 }
f8c1d94363b6 new configuration options: "AcceptedTransferSyntaxes" and "H265TransferSyntaxAccepted" Sebastien Jodogne <s.jodogne@gmail.com> parents: 4473 diff changeset	453
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	454 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	455
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	456 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	457 }
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	458
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	459
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	460 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	461 {
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	462 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	463 {
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 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	465 .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	466 .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	467 .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	468 .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	469 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	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
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 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	473 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	474 }
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
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
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 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	478 {
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 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	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 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	482 .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	483 .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	484 .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	485 .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	486 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	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
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 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	490 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	491 }
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
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
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	494
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	495 // Plugins information ------------------------------------------------------
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	496
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	497 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	498 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	499 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	500 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	501 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	502 .SetTag("System")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	503 .SetSummary("List plugins")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	504 .SetDescription("List all the installed plugins")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	505 .AddAnswerType(MimeType_Json, "JSON array containing the identifiers of the installed plugins")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	506 .SetHttpGetSample("https://demo.orthanc-server.com/plugins", true);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	507 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	508 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	509
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	510 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	511
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	512 v.append("explorer.js");
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	513
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	514 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	515 {
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	516 #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	517 std::list<std::string> plugins;
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	518 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	519
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	520 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	521 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	522 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	523 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	524 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	525 #endif
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	526 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	527
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	528 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	529 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	530
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 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	533 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	534 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	535 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	536 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	537 .SetTag("System")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	538 .SetSummary("Get plugin")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	539 .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	540 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	541 .AddAnswerType(MimeType_Json, "JSON object containing information about the plugin")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	542 .SetHttpGetSample("https://demo.orthanc-server.com/plugins/dicom-web", true);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	543 return;
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
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	546 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	547 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	548 return;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	549 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	550
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	551 #if ORTHANC_ENABLE_PLUGINS == 1
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	552 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	553 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	554
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	555 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	556 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	557 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	558 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	559 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	560
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	561 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	562 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	563 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	564 {
1597 415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	565 std::string root = c;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	566 if (!root.empty())
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	567 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	568 // 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	569 if (root[0] == '/')
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	570 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	571 root = ".." + root;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	572 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	573
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	574 v["RootUri"] = root;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	575 }
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	576 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	577
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	578 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	579 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	580 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	581 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	582 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	583
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	584 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	585 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	586
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	587 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	588 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	589 #endif
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	590 }
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 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	594 {
4418 9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	595 if (call.IsDocumentation())
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	596 {
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	597 call.GetDocumentation()
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	598 .SetTag("System")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	599 .SetSummary("JavaScript extensions to Orthanc Explorer")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	600 .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	601 "`OrthancPluginExtendOrthancExplorer()` function of the plugin SDK. "
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	602 "This route is for internal use of Orthanc Explorer.")
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	603 .AddAnswerType(MimeType_JavaScript, "The JavaScript extensions");
9d6fa3da8f00 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4417 diff changeset	604 return;
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
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	607 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	608
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	609 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	610 {
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 2069 diff changeset	611 #if ORTHANC_ENABLE_PLUGINS == 1
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	612 const OrthancPlugins& plugins = OrthancRestApi::GetContext(call).GetPlugins();
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	613 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	614
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	615 std::list<std::string> lst;
1434 f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders Sebastien Jodogne <s.jodogne@gmail.com> parents: 1433 diff changeset	616 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	617
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	618 for (std::list<std::string>::const_iterator
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	619 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	620 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	621 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	622 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	623 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	624 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	625 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	626 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	627 }
1632 eb8fbcf008b5 fix build with plugins disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1631 diff changeset	628 #endif
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
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	631 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	632 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	633
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	634
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	635
9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	636
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	637 // Jobs information ------------------------------------------------------
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	638
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	639 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	640 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	641 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	642 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	643 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	644 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	645 .SetSummary("List jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	646 .SetDescription("List all the available jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	647 .SetHttpGetArgument("expand", RestApiCallDocumentation::Type_String,
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	648 "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	649 .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	650 "about the reported jobs (if `expand` argument is provided)")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	651 .SetTruncatedJsonHttpGetSample("https://demo.orthanc-server.com/jobs", 3);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	652 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	653 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	654
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	655 bool expand = call.HasArgument("expand");
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	656
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	657 Json::Value v = Json::arrayValue;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	658
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	659 std::set<std::string> jobs;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	660 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	661
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	662 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	663 it != jobs.end(); ++it)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	664 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	665 if (expand)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	666 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	667 JobInfo info;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	668 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	669 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	670 Json::Value tmp;
2647 73d7d95dd75e removal of internal job information Sebastien Jodogne <s.jodogne@gmail.com> parents: 2617 diff changeset	671 info.Format(tmp);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	672 v.append(tmp);
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 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	675 else
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	676 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	677 v.append(*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 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	680
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	681 call.GetOutput().AnswerJson(v);
2202 9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	682 }
9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	683
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	684 static void GetJobInfo(RestApiGetCall& call)
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	685 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	686 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	687 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	688 Json::Value sample;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	689 sample["CompletionTime"] = "20201227T161842.520129";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	690 sample["Content"]["ArchiveSizeMB"] = 22;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	691 sample["Content"]["Description"] = "REST API";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	692 sample["Content"]["InstancesCount"] = 232;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	693 sample["Content"]["UncompressedSizeMB"] = 64;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	694 sample["CreationTime"] = "20201227T161836.428311";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	695 sample["EffectiveRuntime"] = 6.0810000000000004;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	696 sample["ErrorCode"] = 0;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	697 sample["ErrorDescription"] = "Success";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	698 sample["ID"] = "645ecb02-7c0e-4465-b767-df873222dcfb";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	699 sample["Priority"] = 0;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	700 sample["Progress"] = 100;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	701 sample["State"] = "Success";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	702 sample["Timestamp"] = "20201228T160340.253201";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	703 sample["Type"] = "Media";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	704
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	705 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	706 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	707 .SetSummary("Get job")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	708 .SetDescription("Retrieve detailed information about the job whose identifier is provided in the URL: "
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	709 "https://book.orthanc-server.com/users/advanced-rest.html#jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	710 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	711 .AddAnswerType(MimeType_Json, "JSON object detailing the job")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	712 .SetSample(sample);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	713 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	714 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	715
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	716 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	717
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	718 JobInfo info;
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	719 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	720 {
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	721 Json::Value json;
2647 73d7d95dd75e removal of internal job information Sebastien Jodogne <s.jodogne@gmail.com> parents: 2617 diff changeset	722 info.Format(json);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	723 call.GetOutput().AnswerJson(json);
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	724 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	725 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	726
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	727
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	728 static void GetJobOutput(RestApiGetCall& call)
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	729 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	730 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	731 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	732 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	733 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	734 .SetSummary("Get job output")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	735 .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	736 "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	737 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	738 .SetUriArgument("key", "Name of the output of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	739 .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	740 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	741 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	742
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	743 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	744 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	745
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	746 std::string value;
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	747 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	748 std::string filename;
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	749
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	750 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	751 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	752 {
4805 0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	753 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	754 {
0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	755 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	756 }
0a38000b086d Archive jobs response now contains a header Content-Disposition:filename='archive.zip' Alain Mazy <am@osimis.io> parents: 4730 diff changeset	757
2976 cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	758 call.GetOutput().AnswerBuffer(value, mime);
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	759 }
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	760 else
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	761 {
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	762 throw OrthancException(ErrorCode_InexistentItem,
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	763 "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	764 }
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	765 }
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	766
cb5d75143da0 Asynchronous generation of ZIP archives and DICOM medias Sebastien Jodogne <s.jodogne@gmail.com> parents: 2940 diff changeset	767
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	768 enum JobAction
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	769 {
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	770 JobAction_Cancel,
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	771 JobAction_Pause,
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	772 JobAction_Resubmit,
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	773 JobAction_Resume
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	774 };
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	775
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	776 template <JobAction action>
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	777 static void ApplyJobAction(RestApiPostCall& call)
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	778 {
4417 a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	779 if (call.IsDocumentation())
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	780 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	781 std::string verb;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	782 switch (action)
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	783 {
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	784 case JobAction_Cancel:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	785 verb = "Cancel";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	786 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	787
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	788 case JobAction_Pause:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	789 verb = "Pause";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	790 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	791
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	792 case JobAction_Resubmit:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	793 verb = "Resubmit";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	794 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	795
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	796 case JobAction_Resume:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	797 verb = "Resume";
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	798 break;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	799
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	800 default:
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	801 throw OrthancException(ErrorCode_InternalError);
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	802 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	803
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	804 call.GetDocumentation()
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	805 .SetTag("Jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	806 .SetSummary(verb + " job")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	807 .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	808 "Orthanc Book for more information about the state machine applicable to jobs: "
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	809 "https://book.orthanc-server.com/users/advanced-rest.html#jobs")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	810 .SetUriArgument("id", "Identifier of the job of interest")
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	811 .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	812 return;
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	813 }
a4518adede59 openapi for plugins and jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 4403 diff changeset	814
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	815 std::string id = call.GetUriComponent("id", "");
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	816
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	817 bool ok = false;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	818
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	819 switch (action)
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	820 {
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	821 case JobAction_Cancel:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	822 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Cancel(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	823 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	824
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	825 case JobAction_Pause:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	826 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Pause(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	827 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	828
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	829 case JobAction_Resubmit:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	830 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Resubmit(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	831 break;
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	832
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	833 case JobAction_Resume:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	834 ok = OrthancRestApi::GetContext(call).GetJobsEngine().GetRegistry().Resume(id);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	835 break;
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 default:
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	838 throw OrthancException(ErrorCode_InternalError);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	839 }
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	840
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	841 if (ok)
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	842 {
2908 9d277f8ad698 new enumeration: MimeType Sebastien Jodogne <s.jodogne@gmail.com> parents: 2905 diff changeset	843 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	844 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	845 }
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	846
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	847
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	848 static void GetMetricsPrometheus(RestApiGetCall& call)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	849 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	850 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	851 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	852 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	853 .SetTag("System")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	854 .SetSummary("Get usage metrics")
4424 83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4418 diff changeset	855 .SetDescription("Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): "
83371ccdfe80 openapi documentation is now completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 4418 diff changeset	856 "https://book.orthanc-server.com/users/advanced-rest.html#instrumentation-with-prometheus")
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	857 .SetHttpGetSample("https://demo.orthanc-server.com/tools/metrics-prometheus", false);
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	858 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	859 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	860
3179 fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	861 #if ORTHANC_ENABLE_PLUGINS == 1
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	862 OrthancRestApi::GetContext(call).GetPlugins().RefreshMetrics();
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	863 #endif
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	864
3177 053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	865 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	866
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	867 ServerContext& context = OrthancRestApi::GetContext(call);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	868
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	869 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	870 context.GetIndex().GetGlobalStatistics(diskSize, uncompressedSize, countPatients,
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	871 countStudies, countSeries, countInstances);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	872
3179 fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	873 unsigned int jobsPending, jobsRunning, jobsSuccess, jobsFailed;
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	874 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	875
5111 7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	876 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	877 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	878 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	879
3177 053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	880 MetricsRegistry& registry = context.GetMetricsRegistry();
053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	881 registry.SetValue("orthanc_disk_size_mb", static_cast<float>(diskSize) / MEGA_BYTES);
053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	882 registry.SetValue("orthanc_uncompressed_size_mb", static_cast<float>(diskSize) / MEGA_BYTES);
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	883 registry.SetValue("orthanc_count_patients", static_cast<unsigned int>(countPatients));
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	884 registry.SetValue("orthanc_count_studies", static_cast<unsigned int>(countStudies));
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	885 registry.SetValue("orthanc_count_series", static_cast<unsigned int>(countSeries));
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	886 registry.SetValue("orthanc_count_instances", static_cast<unsigned int>(countInstances));
3177 053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	887 registry.SetValue("orthanc_jobs_pending", jobsPending);
053e72ff9fc5 new metrics: orthanc_jobs_[pending\|running\|completed] Sebastien Jodogne <s.jodogne@gmail.com> parents: 3174 diff changeset	888 registry.SetValue("orthanc_jobs_running", jobsRunning);
3179 fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	889 registry.SetValue("orthanc_jobs_completed", jobsSuccess + jobsFailed);
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	890 registry.SetValue("orthanc_jobs_success", jobsSuccess);
fca730c267d7 New primitives to set and refresh metrics Sebastien Jodogne <s.jodogne@gmail.com> parents: 3177 diff changeset	891 registry.SetValue("orthanc_jobs_failed", jobsFailed);
5111 7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	892 registry.SetValue("orthanc_up_time_s", serverUpTime);
7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	893 registry.SetValue("orthanc_last_change", lastChange["Last"].asInt64());
7547c7dfd017 /tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s Alain Mazy <am@osimis.io> parents: 5024 diff changeset	894
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	895 std::string s;
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	896 registry.ExportPrometheusText(s);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	897
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	898 call.GetOutput().AnswerBuffer(s, MimeType_PrometheusText);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	899 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	900
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	901
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	902 static void GetMetricsEnabled(RestApiGetCall& call)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	903 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	904 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	905 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	906 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	907 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	908 .SetSummary("Are metrics collected?")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	909 .SetDescription("Returns a Boolean specifying whether Prometheus metrics "
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	910 "are collected and exposed at `/tools/metrics-prometheus`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	911 .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	912 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	913 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	914
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	915 bool enabled = OrthancRestApi::GetContext(call).GetMetricsRegistry().IsEnabled();
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	916 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	917 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	918
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	919
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	920 static void PutMetricsEnabled(RestApiPutCall& call)
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	921 {
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	922 if (call.IsDocumentation())
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	923 {
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	924 call.GetDocumentation()
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	925 .SetTag("System")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	926 .SetSummary("Enable collection of metrics")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	927 .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	928 .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	929 return;
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	930 }
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	931
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	932 const bool enabled = call.ParseBooleanBody();
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 // Success
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	935 OrthancRestApi::GetContext(call).GetMetricsRegistry().SetEnabled(enabled);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	936 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	937 }
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	938
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	939
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	940 static void GetLogLevel(RestApiGetCall& call)
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	941 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	942 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	943 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	944 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	945 .SetTag("Logs")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	946 .SetSummary("Get main log level")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	947 .SetDescription("Get the main log level of Orthanc")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	948 .AddAnswerType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	949 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	950 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	951
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	952 const std::string s = EnumerationToString(GetGlobalVerbosity());
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	953 call.GetOutput().AnswerBuffer(s, MimeType_PlainText);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	954 }
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	955
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	956
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	957 static void PutLogLevel(RestApiPutCall& call)
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	958 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	959 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	960 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	961 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	962 .SetTag("Logs")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	963 .SetSummary("Set main log level")
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	964 .SetDescription("Set the main log level of Orthanc")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	965 .AddRequestType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	966 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	967 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	968
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	969 std::string body;
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	970 call.BodyToString(body);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	971
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	972 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	973
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	974 // Success
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	975 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	976 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	977 }
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	978
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	979
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	980 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	981 {
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	982 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	983
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	984 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	985 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	986 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	987 {
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	988 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	989 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	990 {
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	991 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	992 }
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	993 }
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	994
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	995 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	996 }
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	997
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	998
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	999 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	1000 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1001 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1002 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1003 std::string category = Logging::GetCategoryName(GetCategory(call));
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1004 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1005 .SetTag("Logs")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1006 .SetSummary("Get log level for `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1007 .SetDescription("Get the log level of the log category `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1008 .AddAnswerType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1009 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1010 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1011
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	1012 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	1013 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	1014 }
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	1015
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	1016
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	1017 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	1018 {
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1019 if (call.IsDocumentation())
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1020 {
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1021 std::string category = Logging::GetCategoryName(GetCategory(call));
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1022 call.GetDocumentation()
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1023 .SetTag("Logs")
4403 ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1024 .SetSummary("Set log level for `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1025 .SetDescription("Set the log level of the log category `" + category + "`")
ad646ff506d0 cont openapi Sebastien Jodogne <s.jodogne@gmail.com> parents: 4401 diff changeset	1026 .AddRequestType(MimeType_PlainText, "Possible values: `default`, `verbose` or `trace`");
4401 354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1027 return;
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1028 }
354ea95b294a documenting system calls Sebastien Jodogne <s.jodogne@gmail.com> parents: 4379 diff changeset	1029
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	1030 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	1031 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	1032
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	1033 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	1034 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	1035 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	1036
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	1037 // 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	1038 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	1039 << 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	1040 << 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	1041 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	1042 }
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	1043
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	1044
4378 9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1045 void OrthancRestApi::RegisterSystem(bool orthancExplorerEnabled)
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1046 {
4378 9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1047 if (orthancExplorerEnabled)
9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1048 {
9e2fc6911ac8 adding option to disable orthance explorer when http server is enabled Andrew Wallis <andrew.wallis@varian.com>> parents: 4275 diff changeset	1049 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	1050 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	1051 }
4379 85b5b0e1bac9 added NEWS about "OrthancExplorerEnabled" option Sebastien Jodogne <s.jodogne@gmail.com> parents: 4378 diff changeset	1052
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1053 Register("/system", GetSystemInformation);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1054 Register("/statistics", GetStatistics);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1055 Register("/tools/generate-uid", GenerateUid);
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1056 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	1057 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	1058 Register("/tools/now-local", GetNowIsoString<false>);
1073 01414536c930 complete DICOM conformance Sebastien Jodogne <s.jodogne@gmail.com> parents: 996 diff changeset	1059 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	1060 Register("/tools/default-encoding", GetDefaultEncoding);
9b373b7d6713 Fix handling of encodings in C-FIND requests Sebastien Jodogne <s.jodogne@gmail.com> parents: 2140 diff changeset	1061 Register("/tools/default-encoding", SetDefaultEncoding);
3174 8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1062 Register("/tools/metrics", GetMetricsEnabled);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1063 Register("/tools/metrics", PutMetricsEnabled);
8ea7c4546c3a primitives to collect metrics in Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 3097 diff changeset	1064 Register("/tools/metrics-prometheus", GetMetricsPrometheus);
3672 ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1065 Register("/tools/log-level", GetLogLevel);
ea8c1c0e81eb Fix issue #65 (Logging improvements) Sebastien Jodogne <s.jodogne@gmail.com> parents: 3640 diff changeset	1066 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	1067
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	1068 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	1069 {
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	1070 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	1071 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	1072 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	1073 }
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	1074
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1218 diff changeset	1075 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	1076 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	1077 Register("/plugins/explorer.js", GetOrthancExplorerPlugins);
2573 3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	1078
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	1079 Register("/jobs", ListJobs);
3372c5255333 StoreScuJob, Orthanc Explorer for jobs Sebastien Jodogne <s.jodogne@gmail.com> parents: 2475 diff changeset	1080 Register("/jobs/{id}", GetJobInfo);
2582 b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1081 Register("/jobs/{id}/cancel", ApplyJobAction<JobAction_Cancel>);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1082 Register("/jobs/{id}/pause", ApplyJobAction<JobAction_Pause>);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1083 Register("/jobs/{id}/resubmit", ApplyJobAction<JobAction_Resubmit>);
b3da733d984c job actions in Orthanc Explorer Sebastien Jodogne <s.jodogne@gmail.com> parents: 2573 diff changeset	1084 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	1085 Register("/jobs/{id}/{key}", GetJobOutput);
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	1086
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	1087 // 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	1088 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	1089 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	1090 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	1091 Register("/tools/unknown-sop-class-accepted", SetUnknownSopClassAccepted);
751 5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1092 }
5197fd35333c refactoring of OrthancRestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1093 }

Mercurial > hg > orthanc

annotate OrthancServer/Sources/OrthancRestApi/OrthancRestSystem.cpp @ 5227:988dab8deb1c db-protobuf