Mercurial > hg > orthanc
view OrthancServer/OrthancRestApi/OrthancRestModalities.cpp @ 1389:c236a8b35a3b
integration query-retrieve->default
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 29 May 2015 15:31:46 +0200 |
parents | b22ba8c5edbe |
children | d710ea64f0fd |
line wrap: on
line source
/** * Orthanc - A Lightweight, RESTful DICOM Store * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics * Department, University Hospital of Liege, Belgium * * This program is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * In addition, as a special exception, the copyright holders of this * program give permission to link the code of its release with the * OpenSSL project's "OpenSSL" library (or with modified versions of it * that use the same license as the "OpenSSL" library), and distribute * the linked executables. You must obey the GNU General Public License * in all respects for all of the code used other than "OpenSSL". If you * modify file(s) with this exception, you may extend this exception to * your version of the file(s), but you are not obligated to do so. If * you do not wish to do so, delete this exception statement from your * version. If you delete this exception statement from all source files * in the program, then also delete it here. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. **/ #include "../PrecompiledHeadersServer.h" #include "OrthancRestApi.h" #include "../OrthancInitialization.h" #include "../../Core/HttpClient.h" #include "../FromDcmtkBridge.h" #include "../Scheduler/ServerJob.h" #include "../Scheduler/StoreScuCommand.h" #include "../Scheduler/StorePeerCommand.h" #include "../QueryRetrieveHandler.h" #include "../ServerToolbox.h" #include <glog/logging.h> namespace Orthanc { /*************************************************************************** * DICOM C-Echo SCU ***************************************************************************/ static void DicomEcho(RestApiPostCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); RemoteModalityParameters remote = Configuration::GetModalityUsingSymbolicName(call.GetUriComponent("id", "")); ReusableDicomUserConnection::Locker locker(context.GetReusableDicomUserConnection(), remote); try { if (locker.GetConnection().Echo()) { // Echo has succeeded call.GetOutput().AnswerBuffer("{}", "application/json"); return; } } catch (OrthancException&) { } // Echo has failed call.GetOutput().SignalError(HttpStatus_500_InternalServerError); } /*************************************************************************** * DICOM C-Find SCU => DEPRECATED! ***************************************************************************/ static bool MergeQueryAndTemplate(DicomMap& result, const std::string& postData) { Json::Value query; Json::Reader reader; if (!reader.parse(postData, query) || query.type() != Json::objectValue) { return false; } Json::Value::Members members = query.getMemberNames(); for (size_t i = 0; i < members.size(); i++) { DicomTag t = FromDcmtkBridge::ParseTag(members[i]); result.SetValue(t, query[members[i]].asString()); } return true; } static void FindPatient(DicomFindAnswers& result, DicomUserConnection& connection, const DicomMap& fields) { // Only keep the filters from "fields" that are related to the patient DicomMap s; fields.ExtractPatientInformation(s); connection.Find(result, ResourceType_Patient, s); } static void FindStudy(DicomFindAnswers& result, DicomUserConnection& connection, const DicomMap& fields) { // Only keep the filters from "fields" that are related to the study DicomMap s; fields.ExtractStudyInformation(s); s.CopyTagIfExists(fields, DICOM_TAG_PATIENT_ID); s.CopyTagIfExists(fields, DICOM_TAG_ACCESSION_NUMBER); s.CopyTagIfExists(fields, DICOM_TAG_MODALITIES_IN_STUDY); connection.Find(result, ResourceType_Study, s); } static void FindSeries(DicomFindAnswers& result, DicomUserConnection& connection, const DicomMap& fields) { // Only keep the filters from "fields" that are related to the series DicomMap s; fields.ExtractSeriesInformation(s); s.CopyTagIfExists(fields, DICOM_TAG_PATIENT_ID); s.CopyTagIfExists(fields, DICOM_TAG_ACCESSION_NUMBER); s.CopyTagIfExists(fields, DICOM_TAG_STUDY_INSTANCE_UID); connection.Find(result, ResourceType_Series, s); } static void FindInstance(DicomFindAnswers& result, DicomUserConnection& connection, const DicomMap& fields) { // Only keep the filters from "fields" that are related to the instance DicomMap s; fields.ExtractInstanceInformation(s); s.CopyTagIfExists(fields, DICOM_TAG_PATIENT_ID); s.CopyTagIfExists(fields, DICOM_TAG_ACCESSION_NUMBER); s.CopyTagIfExists(fields, DICOM_TAG_STUDY_INSTANCE_UID); s.CopyTagIfExists(fields, DICOM_TAG_SERIES_INSTANCE_UID); connection.Find(result, ResourceType_Instance, s); } static void DicomFindPatient(RestApiPostCall& call) { LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri(); ServerContext& context = OrthancRestApi::GetContext(call); DicomMap fields; DicomMap::SetupFindPatientTemplate(fields); if (!MergeQueryAndTemplate(fields, call.GetPostBody())) { return; } RemoteModalityParameters remote = Configuration::GetModalityUsingSymbolicName(call.GetUriComponent("id", "")); ReusableDicomUserConnection::Locker locker(context.GetReusableDicomUserConnection(), remote); DicomFindAnswers answers; FindPatient(answers, locker.GetConnection(), fields); Json::Value result; answers.ToJson(result, true); call.GetOutput().AnswerJson(result); } static void DicomFindStudy(RestApiPostCall& call) { LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri(); ServerContext& context = OrthancRestApi::GetContext(call); DicomMap fields; DicomMap::SetupFindStudyTemplate(fields); if (!MergeQueryAndTemplate(fields, call.GetPostBody())) { return; } if (fields.GetValue(DICOM_TAG_ACCESSION_NUMBER).AsString().size() <= 2 && fields.GetValue(DICOM_TAG_PATIENT_ID).AsString().size() <= 2) { return; } RemoteModalityParameters remote = Configuration::GetModalityUsingSymbolicName(call.GetUriComponent("id", "")); ReusableDicomUserConnection::Locker locker(context.GetReusableDicomUserConnection(), remote); DicomFindAnswers answers; FindStudy(answers, locker.GetConnection(), fields); Json::Value result; answers.ToJson(result, true); call.GetOutput().AnswerJson(result); } static void DicomFindSeries(RestApiPostCall& call) { LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri(); ServerContext& context = OrthancRestApi::GetContext(call); DicomMap fields; DicomMap::SetupFindSeriesTemplate(fields); if (!MergeQueryAndTemplate(fields, call.GetPostBody())) { return; } if ((fields.GetValue(DICOM_TAG_ACCESSION_NUMBER).AsString().size() <= 2 && fields.GetValue(DICOM_TAG_PATIENT_ID).AsString().size() <= 2) || fields.GetValue(DICOM_TAG_STUDY_INSTANCE_UID).AsString().size() <= 2) { return; } RemoteModalityParameters remote = Configuration::GetModalityUsingSymbolicName(call.GetUriComponent("id", "")); ReusableDicomUserConnection::Locker locker(context.GetReusableDicomUserConnection(), remote); DicomFindAnswers answers; FindSeries(answers, locker.GetConnection(), fields); Json::Value result; answers.ToJson(result, true); call.GetOutput().AnswerJson(result); } static void DicomFindInstance(RestApiPostCall& call) { LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri(); ServerContext& context = OrthancRestApi::GetContext(call); DicomMap fields; DicomMap::SetupFindInstanceTemplate(fields); if (!MergeQueryAndTemplate(fields, call.GetPostBody())) { return; } if ((fields.GetValue(DICOM_TAG_ACCESSION_NUMBER).AsString().size() <= 2 && fields.GetValue(DICOM_TAG_PATIENT_ID).AsString().size() <= 2) || fields.GetValue(DICOM_TAG_STUDY_INSTANCE_UID).AsString().size() <= 2 || fields.GetValue(DICOM_TAG_SERIES_INSTANCE_UID).AsString().size() <= 2) { return; } RemoteModalityParameters remote = Configuration::GetModalityUsingSymbolicName(call.GetUriComponent("id", "")); ReusableDicomUserConnection::Locker locker(context.GetReusableDicomUserConnection(), remote); DicomFindAnswers answers; FindInstance(answers, locker.GetConnection(), fields); Json::Value result; answers.ToJson(result, true); call.GetOutput().AnswerJson(result); } static void DicomFind(RestApiPostCall& call) { LOG(WARNING) << "This URI is deprecated: " << call.FlattenUri(); ServerContext& context = OrthancRestApi::GetContext(call); DicomMap m; DicomMap::SetupFindPatientTemplate(m); if (!MergeQueryAndTemplate(m, call.GetPostBody())) { return; } RemoteModalityParameters remote = Configuration::GetModalityUsingSymbolicName(call.GetUriComponent("id", "")); ReusableDicomUserConnection::Locker locker(context.GetReusableDicomUserConnection(), remote); DicomFindAnswers patients; FindPatient(patients, locker.GetConnection(), m); // Loop over the found patients Json::Value result = Json::arrayValue; for (size_t i = 0; i < patients.GetSize(); i++) { Json::Value patient(Json::objectValue); FromDcmtkBridge::ToJson(patient, patients.GetAnswer(i), true); DicomMap::SetupFindStudyTemplate(m); if (!MergeQueryAndTemplate(m, call.GetPostBody())) { return; } m.CopyTagIfExists(patients.GetAnswer(i), DICOM_TAG_PATIENT_ID); DicomFindAnswers studies; FindStudy(studies, locker.GetConnection(), m); patient["Studies"] = Json::arrayValue; // Loop over the found studies for (size_t j = 0; j < studies.GetSize(); j++) { Json::Value study(Json::objectValue); FromDcmtkBridge::ToJson(study, studies.GetAnswer(j), true); DicomMap::SetupFindSeriesTemplate(m); if (!MergeQueryAndTemplate(m, call.GetPostBody())) { return; } m.CopyTagIfExists(studies.GetAnswer(j), DICOM_TAG_PATIENT_ID); m.CopyTagIfExists(studies.GetAnswer(j), DICOM_TAG_STUDY_INSTANCE_UID); DicomFindAnswers series; FindSeries(series, locker.GetConnection(), m); // Loop over the found series study["Series"] = Json::arrayValue; for (size_t k = 0; k < series.GetSize(); k++) { Json::Value series2(Json::objectValue); FromDcmtkBridge::ToJson(series2, series.GetAnswer(k), true); study["Series"].append(series2); } patient["Studies"].append(study); } result.append(patient); } call.GetOutput().AnswerJson(result); } /*************************************************************************** * DICOM C-Find and C-Move SCU => Recommended since Orthanc 0.9.0 ***************************************************************************/ static void DicomQuery(RestApiPostCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); Json::Value request; if (call.ParseJsonRequest(request) && request.type() == Json::objectValue && request.isMember("Level") && request["Level"].type() == Json::stringValue && (!request.isMember("Query") || request["Query"].type() == Json::objectValue)) { std::auto_ptr<QueryRetrieveHandler> handler(new QueryRetrieveHandler(context)); handler->SetModality(call.GetUriComponent("id", "")); handler->SetLevel(StringToResourceType(request["Level"].asString().c_str())); if (request.isMember("Query")) { Json::Value::Members tags = request["Query"].getMemberNames(); for (size_t i = 0; i < tags.size(); i++) { handler->SetQuery(FromDcmtkBridge::ParseTag(tags[i].c_str()), request["Query"][tags[i]].asString()); } } handler->Run(); std::string s = context.GetQueryRetrieveArchive().Add(handler.release()); Json::Value result = Json::objectValue; result["ID"] = s; result["Path"] = "/queries/" + s; call.GetOutput().AnswerJson(result); } } static void ListQueries(RestApiGetCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); std::list<std::string> queries; context.GetQueryRetrieveArchive().List(queries); Json::Value result = Json::arrayValue; for (std::list<std::string>::const_iterator it = queries.begin(); it != queries.end(); ++it) { result.append(*it); } call.GetOutput().AnswerJson(result); } namespace { class QueryAccessor { private: ServerContext& context_; SharedArchive::Accessor accessor_; QueryRetrieveHandler& handler_; public: QueryAccessor(RestApiCall& call) : context_(OrthancRestApi::GetContext(call)), accessor_(context_.GetQueryRetrieveArchive(), call.GetUriComponent("id", "")), handler_(dynamic_cast<QueryRetrieveHandler&>(accessor_.GetItem())) { } QueryRetrieveHandler* operator->() { return &handler_; } }; static void AnswerDicomMap(RestApiCall& call, const DicomMap& value, bool simplify) { Json::Value full = Json::objectValue; FromDcmtkBridge::ToJson(full, value, simplify); call.GetOutput().AnswerJson(full); } } static void ListQueryAnswers(RestApiGetCall& call) { QueryAccessor query(call); size_t count = query->GetAnswerCount(); Json::Value result = Json::arrayValue; for (size_t i = 0; i < count; i++) { result.append(boost::lexical_cast<std::string>(i)); } call.GetOutput().AnswerJson(result); } static void GetQueryOneAnswer(RestApiGetCall& call) { size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", "")); QueryAccessor query(call); AnswerDicomMap(call, query->GetAnswer(index), call.HasArgument("simplify")); } static void RetrieveOneAnswer(RestApiPostCall& call) { size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", "")); LOG(WARNING) << "Driving C-Move SCU on modality: " << call.GetPostBody(); QueryAccessor query(call); query->Retrieve(call.GetPostBody(), index); // Retrieve has succeeded call.GetOutput().AnswerBuffer("{}", "application/json"); } static void RetrieveAllAnswers(RestApiPostCall& call) { LOG(WARNING) << "Driving C-Move SCU on modality: " << call.GetPostBody(); QueryAccessor query(call); query->Retrieve(call.GetPostBody()); // Retrieve has succeeded call.GetOutput().AnswerBuffer("{}", "application/json"); } static void GetQueryArguments(RestApiGetCall& call) { QueryAccessor query(call); AnswerDicomMap(call, query->GetQuery(), call.HasArgument("simplify")); } static void GetQueryLevel(RestApiGetCall& call) { QueryAccessor query(call); call.GetOutput().AnswerBuffer(EnumerationToString(query->GetLevel()), "text/plain"); } static void GetQueryModality(RestApiGetCall& call) { QueryAccessor query(call); call.GetOutput().AnswerBuffer(query->GetModalitySymbolicName(), "text/plain"); } static void DeleteQuery(RestApiDeleteCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); context.GetQueryRetrieveArchive().Remove(call.GetUriComponent("id", "")); call.GetOutput().AnswerBuffer("", "text/plain"); } static void ListQueryOperations(RestApiGetCall& call) { // Ensure that the query of interest does exist QueryAccessor query(call); RestApi::AutoListChildren(call); } static void ListQueryAnswerOperations(RestApiGetCall& call) { // Ensure that the query of interest does exist QueryAccessor query(call); // Ensure that the answer of interest does exist size_t index = boost::lexical_cast<size_t>(call.GetUriComponent("index", "")); query->GetAnswer(index); RestApi::AutoListChildren(call); } /*************************************************************************** * DICOM C-Store SCU ***************************************************************************/ static bool GetInstancesToExport(std::list<std::string>& instances, const std::string& remote, RestApiPostCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); std::string stripped = Toolbox::StripSpaces(call.GetPostBody()); Json::Value request; if (Toolbox::IsSHA1(stripped)) { // This is for compatibility with Orthanc <= 0.5.1. request = stripped; } else if (!call.ParseJsonRequest(request)) { // Bad JSON request return false; } if (request.isString()) { if (Configuration::GetGlobalBoolParameter("LogExportedResources", true)) { context.GetIndex().LogExportedResource(request.asString(), remote); } context.GetIndex().GetChildInstances(instances, request.asString()); } else if (request.isArray()) { for (Json::Value::ArrayIndex i = 0; i < request.size(); i++) { if (!request[i].isString()) { return false; } std::string stripped = Toolbox::StripSpaces(request[i].asString()); if (!Toolbox::IsSHA1(stripped)) { return false; } if (Configuration::GetGlobalBoolParameter("LogExportedResources", true)) { context.GetIndex().LogExportedResource(stripped, remote); } std::list<std::string> tmp; context.GetIndex().GetChildInstances(tmp, stripped); for (std::list<std::string>::const_iterator it = tmp.begin(); it != tmp.end(); ++it) { instances.push_back(*it); } } } else { // Neither a string, nor a list of strings. Bad request. return false; } return true; } static void DicomStore(RestApiPostCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); std::string remote = call.GetUriComponent("id", ""); std::list<std::string> instances; if (!GetInstancesToExport(instances, remote, call)) { return; } RemoteModalityParameters p = Configuration::GetModalityUsingSymbolicName(remote); ServerJob job; for (std::list<std::string>::const_iterator it = instances.begin(); it != instances.end(); ++it) { job.AddCommand(new StoreScuCommand(context, p, false)).AddInput(*it); } job.SetDescription("HTTP request: Store-SCU to peer \"" + remote + "\""); if (context.GetScheduler().SubmitAndWait(job)) { // Success call.GetOutput().AnswerBuffer("{}", "application/json"); } else { call.GetOutput().SignalError(HttpStatus_500_InternalServerError); } } /*************************************************************************** * Orthanc Peers => Store client ***************************************************************************/ static bool IsExistingPeer(const OrthancRestApi::SetOfStrings& peers, const std::string& id) { return peers.find(id) != peers.end(); } static void ListPeers(RestApiGetCall& call) { OrthancRestApi::SetOfStrings peers; Configuration::GetListOfOrthancPeers(peers); Json::Value result = Json::arrayValue; for (OrthancRestApi::SetOfStrings::const_iterator it = peers.begin(); it != peers.end(); ++it) { result.append(*it); } call.GetOutput().AnswerJson(result); } static void ListPeerOperations(RestApiGetCall& call) { OrthancRestApi::SetOfStrings peers; Configuration::GetListOfOrthancPeers(peers); std::string id = call.GetUriComponent("id", ""); if (IsExistingPeer(peers, id)) { RestApi::AutoListChildren(call); } } static void PeerStore(RestApiPostCall& call) { ServerContext& context = OrthancRestApi::GetContext(call); std::string remote = call.GetUriComponent("id", ""); std::list<std::string> instances; if (!GetInstancesToExport(instances, remote, call)) { return; } OrthancPeerParameters peer; Configuration::GetOrthancPeer(peer, remote); ServerJob job; for (std::list<std::string>::const_iterator it = instances.begin(); it != instances.end(); ++it) { job.AddCommand(new StorePeerCommand(context, peer, false)).AddInput(*it); } job.SetDescription("HTTP request: POST to peer \"" + remote + "\""); if (context.GetScheduler().SubmitAndWait(job)) { // Success call.GetOutput().AnswerBuffer("{}", "application/json"); } else { call.GetOutput().SignalError(HttpStatus_500_InternalServerError); } } // DICOM bridge ------------------------------------------------------------- static bool IsExistingModality(const OrthancRestApi::SetOfStrings& modalities, const std::string& id) { return modalities.find(id) != modalities.end(); } static void ListModalities(RestApiGetCall& call) { OrthancRestApi::SetOfStrings modalities; Configuration::GetListOfDicomModalities(modalities); Json::Value result = Json::arrayValue; for (OrthancRestApi::SetOfStrings::const_iterator it = modalities.begin(); it != modalities.end(); ++it) { result.append(*it); } call.GetOutput().AnswerJson(result); } static void ListModalityOperations(RestApiGetCall& call) { OrthancRestApi::SetOfStrings modalities; Configuration::GetListOfDicomModalities(modalities); std::string id = call.GetUriComponent("id", ""); if (IsExistingModality(modalities, id)) { RestApi::AutoListChildren(call); } } static void UpdateModality(RestApiPutCall& call) { Json::Value json; Json::Reader reader; if (reader.parse(call.GetPutBody(), json)) { RemoteModalityParameters modality; modality.FromJson(json); Configuration::UpdateModality(call.GetUriComponent("id", ""), modality); call.GetOutput().AnswerBuffer("", "text/plain"); } } static void DeleteModality(RestApiDeleteCall& call) { Configuration::RemoveModality(call.GetUriComponent("id", "")); call.GetOutput().AnswerBuffer("", "text/plain"); } static void UpdatePeer(RestApiPutCall& call) { Json::Value json; Json::Reader reader; if (reader.parse(call.GetPutBody(), json)) { OrthancPeerParameters peer; peer.FromJson(json); Configuration::UpdatePeer(call.GetUriComponent("id", ""), peer); call.GetOutput().AnswerBuffer("", "text/plain"); } } static void DeletePeer(RestApiDeleteCall& call) { Configuration::RemovePeer(call.GetUriComponent("id", "")); call.GetOutput().AnswerBuffer("", "text/plain"); } void OrthancRestApi::RegisterModalities() { Register("/modalities", ListModalities); Register("/modalities/{id}", ListModalityOperations); Register("/modalities/{id}", UpdateModality); Register("/modalities/{id}", DeleteModality); Register("/modalities/{id}/echo", DicomEcho); Register("/modalities/{id}/find-patient", DicomFindPatient); Register("/modalities/{id}/find-study", DicomFindStudy); Register("/modalities/{id}/find-series", DicomFindSeries); Register("/modalities/{id}/find-instance", DicomFindInstance); Register("/modalities/{id}/find", DicomFind); Register("/modalities/{id}/store", DicomStore); // For Query/Retrieve Register("/modalities/{id}/query", DicomQuery); Register("/queries", ListQueries); Register("/queries/{id}", DeleteQuery); Register("/queries/{id}", ListQueryOperations); Register("/queries/{id}/answers", ListQueryAnswers); Register("/queries/{id}/answers/{index}", ListQueryAnswerOperations); Register("/queries/{id}/answers/{index}/content", GetQueryOneAnswer); Register("/queries/{id}/answers/{index}/retrieve", RetrieveOneAnswer); Register("/queries/{id}/level", GetQueryLevel); Register("/queries/{id}/modality", GetQueryModality); Register("/queries/{id}/query", GetQueryArguments); Register("/queries/{id}/retrieve", RetrieveAllAnswers); Register("/peers", ListPeers); Register("/peers/{id}", ListPeerOperations); Register("/peers/{id}", UpdatePeer); Register("/peers/{id}", DeletePeer); Register("/peers/{id}/store", PeerStore); } }