# HG changeset patch # User Alain Mazy # Date 1758182030 -7200 # Node ID e90b9d76ff6d5f0c2b5c2b2a85af6648162a266c # Parent 72f74eba36fbeb7e072ca4f6fc55e6e9557af156 DimseErrorStatus in jobs and Rest API for C-Store + C-Get diff -r 72f74eba36fb -r e90b9d76ff6d NEWS --- a/NEWS Fri Sep 12 12:33:19 2025 +0200 +++ b/NEWS Thu Sep 18 09:53:50 2025 +0200 @@ -8,6 +8,12 @@ HTTP server listens. By default, this list is empty and the HTTP server listens on all network interfaces. +REST API +-------- + +* C-Store and C-Get jobs and HTTP responses now include a new "DimseErrorStatus" field if + the operation fails. + Maintenance ----------- diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.cpp --- a/OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -51,6 +51,12 @@ } } + static std::string DimseToHexString(uint16_t dimseStatus) + { + char buf[16]; + sprintf(buf, "0x%04X", dimseStatus); + return buf; + } namespace { @@ -372,23 +378,20 @@ response.DimseStatus != 0xFF00 && // Pending - Matches are continuing response.DimseStatus != 0xFF01) // Pending - Matches are continuing { - char buf[16]; - sprintf(buf, "%04X", response.DimseStatus); - if (response.DimseStatus == STATUS_FIND_Failed_UnableToProcess) { throw OrthancException(ErrorCode_NetworkProtocol, HttpStatus_422_UnprocessableEntity, "C-FIND SCU to AET \"" + parameters_.GetRemoteModality().GetApplicationEntityTitle() + - "\" has failed with DIMSE status 0x" + buf + + "\" has failed with DIMSE status " + DimseToHexString(response.DimseStatus) + " (unable to process - invalid query ?)"); } else { throw OrthancException(ErrorCode_NetworkProtocol, "C-FIND SCU to AET \"" + parameters_.GetRemoteModality().GetApplicationEntityTitle() + - "\" has failed with DIMSE status 0x" + buf); + "\" has failed with DIMSE status " + DimseToHexString(response.DimseStatus)); } } } @@ -487,32 +490,31 @@ * http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_C.4.2.html#table_C.4-2 **/ - if (response.DimseStatus != 0x0000 && // Success - response.DimseStatus != 0xFF00) // Pending - Sub-operations are continuing + if (response.DimseStatus != STATUS_MOVE_Success_SubOperationsCompleteNoFailures && + response.DimseStatus != STATUS_MOVE_Pending_SubOperationsAreContinuing) { - char buf[16]; - sprintf(buf, "%04X", response.DimseStatus); - if (response.DimseStatus == STATUS_MOVE_Failed_UnableToProcess) { throw OrthancException(ErrorCode_NetworkProtocol, HttpStatus_422_UnprocessableEntity, "C-MOVE SCU to AET \"" + parameters_.GetRemoteModality().GetApplicationEntityTitle() + - "\" has failed with DIMSE status 0x" + buf + - " (unable to process - resource not found ?)"); + "\" has failed with DIMSE status " + DimseToHexString(response.DimseStatus) + + " (unable to process - resource not found ?)", + response.DimseStatus); } else { throw OrthancException(ErrorCode_NetworkProtocol, "C-MOVE SCU to AET \"" + parameters_.GetRemoteModality().GetApplicationEntityTitle() + - "\" has failed with DIMSE status 0x" + buf); + "\" has failed with DIMSE status " + DimseToHexString(response.DimseStatus), + response.DimseStatus); } } } - void DicomControlUserConnection::Get(const DicomMap& findResult, + void DicomControlUserConnection::Get(const DicomMap& getQuery, CGetInstanceReceivedCallback instanceReceivedCallback, void* callbackContext) { @@ -520,7 +522,7 @@ association_->Open(parameters_); std::unique_ptr query( - ConvertQueryFields(findResult, parameters_.GetRemoteModality().GetManufacturer())); + ConvertQueryFields(getQuery, parameters_.GetRemoteModality().GetManufacturer())); DcmDataset* queryDataset = query->GetDcmtkObject().getDataset(); std::string remoteAet; @@ -530,7 +532,7 @@ association_->GetAssociationParameters(remoteAet, remoteIp, calledAet); const char* sopClass = NULL; - const std::string tmp = findResult.GetValue(DICOM_TAG_QUERY_RETRIEVE_LEVEL).GetContent(); + const std::string tmp = getQuery.GetValue(DICOM_TAG_QUERY_RETRIEVE_LEVEL).GetContent(); ResourceType level = StringToResourceType(tmp.c_str()); switch (level) { @@ -578,7 +580,11 @@ { OFString tempStr; CLOG(TRACE, DICOM) << "Failed sending C-GET request: " << DimseCondition::dump(tempStr, cond); - // return cond; + + throw OrthancException(ErrorCode_NetworkProtocol, "C-GET SCU to AET \"" + + parameters_.GetRemoteModality().GetApplicationEntityTitle() + + "\" has failed to send the C-GET request"); + } // equivalent to handleCGETSession in DCMTK @@ -607,8 +613,9 @@ { OFString tempStr; CLOG(TRACE, DICOM) << "Failed receiving DIMSE command: " << DimseCondition::dump(tempStr, result); - // delete statusDetail; - break; // TODO: return value + throw OrthancException(ErrorCode_NetworkProtocol, "C-GET SCU to AET \"" + + parameters_.GetRemoteModality().GetApplicationEntityTitle() + + "\" has failed to receive DIMSE command"); } // Handle C-GET Response if (rsp.CommandField == DIMSE_C_GET_RSP) @@ -627,10 +634,18 @@ rsp.msg.CGetRSP.NumberOfWarningSubOperations); } - if (rsp.msg.CGetRSP.DimseStatus == 0x0000) // final success message + if (rsp.msg.CGetRSP.DimseStatus == STATUS_GET_Success) // final success message { continueSession = false; } + else if (rsp.msg.CGetRSP.DimseStatus != STATUS_GET_Pending_SubOperationsAreContinuing) + { + throw OrthancException(ErrorCode_NetworkProtocol, + "C-GET SCU to AET \"" + + parameters_.GetRemoteModality().GetApplicationEntityTitle() + + "\" has failed with DIMSE status " + DimseToHexString(rsp.msg.CGetRSP.DimseStatus), + rsp.msg.CGetRSP.DimseStatus); + } } // Handle C-STORE Request else if (rsp.CommandField == DIMSE_C_STORE_RQ) @@ -695,7 +710,9 @@ NULL, NULL, NULL /* commandSet */); if (result.bad()) { - continueSession = false; + throw OrthancException(ErrorCode_NetworkProtocol, "C-GET SCU to AET \"" + + parameters_.GetRemoteModality().GetApplicationEntityTitle() + + "\" has failed to send response message"); } else { @@ -712,16 +729,13 @@ << std::hex << std::setfill('0') << std::setw(4) << static_cast(rsp.CommandField); - result = DIMSE_BADCOMMANDTYPE; - continueSession = false; + throw OrthancException(ErrorCode_NetworkProtocol, "C-GET SCU to AET \"" + + parameters_.GetRemoteModality().GetApplicationEntityTitle() + + "\": Expected C-GET response or C-STORE request but received DIMSE command " + DimseToHexString(rsp.CommandField)); } - // delete statusDetail; // should be NULL if not existing or added to response list - // statusDetail = NULL; } /* All responses received or break signal occurred */ - - // return result; } @@ -881,28 +895,28 @@ void DicomControlUserConnection::Move(const std::string& targetAet, ResourceType level, - const DicomMap& findResult) + const DicomMap& moveQuery) { DicomMap move; switch (level) { case ResourceType_Patient: - TestAndCopyTag(move, findResult, DICOM_TAG_PATIENT_ID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_PATIENT_ID); break; case ResourceType_Study: - TestAndCopyTag(move, findResult, DICOM_TAG_STUDY_INSTANCE_UID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_STUDY_INSTANCE_UID); break; case ResourceType_Series: - TestAndCopyTag(move, findResult, DICOM_TAG_STUDY_INSTANCE_UID); - TestAndCopyTag(move, findResult, DICOM_TAG_SERIES_INSTANCE_UID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_STUDY_INSTANCE_UID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_SERIES_INSTANCE_UID); break; case ResourceType_Instance: - TestAndCopyTag(move, findResult, DICOM_TAG_STUDY_INSTANCE_UID); - TestAndCopyTag(move, findResult, DICOM_TAG_SERIES_INSTANCE_UID); - TestAndCopyTag(move, findResult, DICOM_TAG_SOP_INSTANCE_UID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_STUDY_INSTANCE_UID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_SERIES_INSTANCE_UID); + TestAndCopyTag(move, moveQuery, DICOM_TAG_SOP_INSTANCE_UID); break; default: @@ -914,17 +928,17 @@ void DicomControlUserConnection::Move(const std::string& targetAet, - const DicomMap& findResult) + const DicomMap& moveQuery) { - if (!findResult.HasTag(DICOM_TAG_QUERY_RETRIEVE_LEVEL)) + if (!moveQuery.HasTag(DICOM_TAG_QUERY_RETRIEVE_LEVEL)) { throw OrthancException(ErrorCode_InternalError); } - const std::string tmp = findResult.GetValue(DICOM_TAG_QUERY_RETRIEVE_LEVEL).GetContent(); + const std::string tmp = moveQuery.GetValue(DICOM_TAG_QUERY_RETRIEVE_LEVEL).GetContent(); ResourceType level = StringToResourceType(tmp.c_str()); - Move(targetAet, level, findResult); + Move(targetAet, level, moveQuery); } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.h --- a/OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/DicomNetworking/DicomControlUserConnection.h Thu Sep 18 09:53:50 2025 +0200 @@ -126,10 +126,10 @@ void Move(const std::string& targetAet, ResourceType level, - const DicomMap& findResult); + const DicomMap& moveQuery); void Move(const std::string& targetAet, - const DicomMap& findResult); + const DicomMap& moveQuery); void MovePatient(const std::string& targetAet, const std::string& patientId); diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/DicomNetworking/DicomStoreUserConnection.cpp --- a/OrthancFramework/Sources/DicomNetworking/DicomStoreUserConnection.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/DicomNetworking/DicomStoreUserConnection.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -38,6 +38,13 @@ namespace Orthanc { + static std::string DimseToHexString(uint16_t dimseStatus) + { + char buf[16]; + sprintf(buf, "0x%04X", dimseStatus); + return buf; + } + static void ProgressCallback(void * /*callbackData*/, T_DIMSE_StoreProgress *progress, T_DIMSE_C_StoreRQ * req) @@ -453,12 +460,11 @@ response.DimseStatus != 0xB006 && // Warning - Elements Discarded response.DimseStatus != 0x0111) // Warning - Duplicate SOPInstanceUID (https://discourse.orthanc-server.org/t/ignore-dimse-status-0x0111-when-sending-partial-duplicate-studies/4555/3) { - char buf[16]; - sprintf(buf, "%04X", response.DimseStatus); throw OrthancException(ErrorCode_NetworkProtocol, "C-STORE SCU to AET \"" + GetParameters().GetRemoteModality().GetApplicationEntityTitle() + - "\" has failed with DIMSE status 0x" + buf); + "\" has failed with DIMSE status " + DimseToHexString(response.DimseStatus), + response.DimseStatus); } } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/IJob.h --- a/OrthancFramework/Sources/JobsEngine/IJob.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/IJob.h Thu Sep 18 09:53:50 2025 +0200 @@ -77,6 +77,9 @@ // "success" state virtual void DeleteAllOutputs() {} + // UserData are provided by the user when creating the job and they are carried along the job virtual bool GetUserData(Json::Value& userData) const = 0; + + virtual void SetUserData(const Json::Value& userData) = 0; }; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobInfo.cpp --- a/OrthancFramework/Sources/JobsEngine/JobInfo.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobInfo.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -196,6 +196,11 @@ target["UserData"] = status_.GetUserData(); } + if (status_.HasDimseErrorStatus()) + { + target["DimseErrorStatus"] = status_.GetDimseErrorStatus(); + } + target["Type"] = status_.GetJobType(); target["Content"] = status_.GetPublicContent(); diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobStatus.cpp --- a/OrthancFramework/Sources/JobsEngine/JobStatus.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobStatus.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -34,18 +34,13 @@ progress_(0), jobType_("Invalid"), publicContent_(Json::objectValue), - hasSerialized_(false) + hasSerialized_(false), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) { } - - JobStatus::JobStatus(ErrorCode code, - const std::string& details, - const IJob& job) : - errorCode_(code), - progress_(job.GetProgress()), - publicContent_(Json::objectValue), - details_(details) + void JobStatus::InitInternal(const IJob& job) { if (progress_ < 0) { @@ -64,6 +59,36 @@ hasSerialized_ = job.Serialize(serialized_); } + JobStatus::JobStatus(ErrorCode code, + const std::string& details, + const IJob& job, + uint16_t dimseErrorStatus) : + errorCode_(code), + progress_(job.GetProgress()), + publicContent_(Json::objectValue), + hasSerialized_(false), + details_(details), + hasDimseErrorStatus_(true), + dimseErrorStatus_(dimseErrorStatus) + { + InitInternal(job); + } + + + JobStatus::JobStatus(ErrorCode code, + const std::string& details, + const IJob& job) : + errorCode_(code), + progress_(job.GetProgress()), + publicContent_(Json::objectValue), + hasSerialized_(false), + details_(details), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) + { + InitInternal(job); + } + const Json::Value& JobStatus::GetSerialized() const { diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobStatus.h --- a/OrthancFramework/Sources/JobsEngine/JobStatus.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobStatus.h Thu Sep 18 09:53:50 2025 +0200 @@ -25,6 +25,7 @@ #pragma once #include "IJob.h" +#include "../OrthancException.h" namespace Orthanc { @@ -38,13 +39,22 @@ Json::Value serialized_; bool hasSerialized_; std::string details_; + bool hasDimseErrorStatus_; + uint16_t dimseErrorStatus_; Json::Value userData_; + void InitInternal(const IJob& job); + public: JobStatus(); JobStatus(ErrorCode code, const std::string& details, + const IJob& job, + uint16_t dimseErrorStatus); + + JobStatus(ErrorCode code, + const std::string& details, const IJob& job); ErrorCode GetErrorCode() const @@ -98,5 +108,20 @@ { return userData_; } + + bool HasDimseErrorStatus() const + { + return hasDimseErrorStatus_; + } + + uint16_t GetDimseErrorStatus() const + { + if (!hasDimseErrorStatus_) + { + throw OrthancException(ErrorCode_BadSequenceOfCalls); + } + + return dimseErrorStatus_; + } }; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobStepResult.cpp --- a/OrthancFramework/Sources/JobsEngine/JobStepResult.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobStepResult.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -32,7 +32,9 @@ JobStepResult::JobStepResult() : code_(JobStepCode_Failure), timeout_(0), - error_(ErrorCode_InternalError) + error_(ErrorCode_InternalError), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) { } @@ -68,11 +70,32 @@ return result; } + JobStepResult JobStepResult::Failure(const ErrorCode& error, + const char* details, + uint16_t dimseErrorStatus) + { + JobStepResult result = Failure(error, details); + + result.hasDimseErrorStatus_ = true; + result.dimseErrorStatus_ = dimseErrorStatus; + + return result; + } + JobStepResult JobStepResult::Failure(const OrthancException& exception) { - return Failure(exception.GetErrorCode(), - exception.HasDetails() ? exception.GetDetails() : NULL); + if (exception.HasDimseErrorStatus()) + { + return Failure(exception.GetErrorCode(), + exception.HasDetails() ? exception.GetDetails() : NULL, + exception.GetDimseErrorStatus()); + } + else + { + return Failure(exception.GetErrorCode(), + exception.HasDetails() ? exception.GetDetails() : NULL); + } } JobStepCode JobStepResult::GetCode() const @@ -118,4 +141,20 @@ throw OrthancException(ErrorCode_BadSequenceOfCalls); } } + + bool JobStepResult::HasDimseErrorStatus() const + { + return hasDimseErrorStatus_; + } + + uint16_t JobStepResult::GetDimseErrorStatus() const + { + if (!hasDimseErrorStatus_) + { + throw OrthancException(ErrorCode_BadSequenceOfCalls); + } + + return dimseErrorStatus_; + } + } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobStepResult.h --- a/OrthancFramework/Sources/JobsEngine/JobStepResult.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobStepResult.h Thu Sep 18 09:53:50 2025 +0200 @@ -25,6 +25,7 @@ #pragma once #include "../Enumerations.h" +#include namespace Orthanc { @@ -37,11 +38,16 @@ unsigned int timeout_; ErrorCode error_; std::string failureDetails_; + bool hasDimseErrorStatus_; + uint16_t dimseErrorStatus_; + explicit JobStepResult(JobStepCode code) : code_(code), timeout_(0), - error_(ErrorCode_Success) + error_(ErrorCode_Success), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) { } @@ -57,6 +63,10 @@ static JobStepResult Failure(const ErrorCode& error, const char* details); + static JobStepResult Failure(const ErrorCode& error, + const char* details, + uint16_t dimseErrorStatus); + static JobStepResult Failure(const OrthancException& exception); JobStepCode GetCode() const; @@ -66,5 +76,9 @@ ErrorCode GetFailureCode() const; const std::string& GetFailureDetails() const; + + bool HasDimseErrorStatus() const; + + uint16_t GetDimseErrorStatus() const; }; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobsEngine.cpp --- a/OrthancFramework/Sources/JobsEngine/JobsEngine.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobsEngine.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -87,7 +87,14 @@ case JobStepCode_Failure: running.GetJob().Stop(JobStopReason_Failure); - running.UpdateStatus(result.GetFailureCode(), result.GetFailureDetails()); + if (result.HasDimseErrorStatus()) + { + running.UpdateStatus(result.GetFailureCode(), result.GetFailureDetails(), result.GetDimseErrorStatus()); + } + else + { + running.UpdateStatus(result.GetFailureCode(), result.GetFailureDetails()); + } running.MarkFailure(); return false; diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobsRegistry.cpp --- a/OrthancFramework/Sources/JobsEngine/JobsRegistry.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobsRegistry.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -44,6 +44,7 @@ static const char* ERROR_CODE = "ErrorCode"; static const char* ERROR_DETAILS = "ErrorDetails"; static const char* USER_DATA = "UserData"; + static const char* DIMSE_ERROR_STATUS = "DimseErrorStatus"; class JobsRegistry::JobHandler : public boost::noncopyable @@ -304,6 +305,11 @@ target[USER_DATA] = userData; } + if (lastStatus_.HasDimseErrorStatus()) + { + target[DIMSE_ERROR_STATUS] = lastStatus_.GetDimseErrorStatus(); + } + return true; } else @@ -333,7 +339,6 @@ job_.reset(unserializer.UnserializeJob(serialized[JOB])); job_->GetJobType(jobType_); - job_->Start(); ErrorCode errorCode; if (serialized.isMember(ERROR_CODE)) @@ -351,7 +356,21 @@ details = SerializationToolbox::ReadString(serialized, ERROR_DETAILS); } - lastStatus_ = JobStatus(errorCode, details, *job_); + if (serialized.isMember(USER_DATA)) + { + job_->SetUserData(serialized[USER_DATA]); + } + + if (serialized.isMember(DIMSE_ERROR_STATUS)) + { + lastStatus_ = JobStatus(errorCode, details, *job_, static_cast(serialized[DIMSE_ERROR_STATUS].asUInt())); + } + else + { + lastStatus_ = JobStatus(errorCode, details, *job_); + } + + job_->Start(); } }; @@ -876,14 +895,18 @@ { ErrorCode code = it->second->GetLastStatus().GetErrorCode(); const std::string& details = it->second->GetLastStatus().GetDetails(); - - if (details.empty()) + + if (it->second->GetLastStatus().HasDimseErrorStatus()) { - throw OrthancException(code); + throw OrthancException(code, details, it->second->GetLastStatus().GetDimseErrorStatus()); + } + else if (!details.empty()) + { + throw OrthancException(code, details); } else { - throw OrthancException(code, details); + throw OrthancException(code); } } else @@ -1446,6 +1469,27 @@ void JobsRegistry::RunningJob::UpdateStatus(ErrorCode code, + const std::string& details, + uint16_t dimseErrorStatus) + { + if (!IsValid()) + { + throw OrthancException(ErrorCode_BadSequenceOfCalls); + } + else + { + JobStatus status(code, details, *job_, dimseErrorStatus); + + boost::mutex::scoped_lock lock(registry_.mutex_); + registry_.CheckInvariants(); + assert(handler_->GetState() == JobState_Running); + + handler_->SetLastStatus(status); + } + } + + + void JobsRegistry::RunningJob::UpdateStatus(ErrorCode code, const std::string& details) { if (!IsValid()) diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/JobsRegistry.h --- a/OrthancFramework/Sources/JobsEngine/JobsRegistry.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/JobsRegistry.h Thu Sep 18 09:53:50 2025 +0200 @@ -243,6 +243,10 @@ void UpdateStatus(ErrorCode code, const std::string& details); + + void UpdateStatus(ErrorCode code, + const std::string& details, + uint16_t dimseErrorStatus); }; }; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/Operations/SequenceOfOperationsJob.h --- a/OrthancFramework/Sources/JobsEngine/Operations/SequenceOfOperationsJob.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/Operations/SequenceOfOperationsJob.h Thu Sep 18 09:53:50 2025 +0200 @@ -28,6 +28,7 @@ #include "IJobOperation.h" #include "../../Compatibility.h" // For ORTHANC_OVERRIDE +#include "../../OrthancException.h" #include #include @@ -140,6 +141,11 @@ void AwakeTrailingSleep(); + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE + { + throw OrthancException(ErrorCode_NotImplemented); + } + virtual bool GetUserData(Json::Value& userData) const ORTHANC_OVERRIDE { return false; diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/JobsEngine/SetOfCommandsJob.h --- a/OrthancFramework/Sources/JobsEngine/SetOfCommandsJob.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/JobsEngine/SetOfCommandsJob.h Thu Sep 18 09:53:50 2025 +0200 @@ -118,7 +118,7 @@ return false; } - void SetUserData(const Json::Value& userData) + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE { userData_ = userData; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/OrthancException.cpp --- a/OrthancFramework/Sources/OrthancException.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/OrthancException.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -33,7 +33,9 @@ OrthancException::OrthancException(const OrthancException& other) : errorCode_(other.errorCode_), httpStatus_(other.httpStatus_), - logged_(false) + logged_(false), + hasDimseErrorStatus_(other.hasDimseErrorStatus_), + dimseErrorStatus_(other.dimseErrorStatus_) { if (other.details_.get() != NULL) { @@ -44,7 +46,9 @@ OrthancException::OrthancException(ErrorCode errorCode) : errorCode_(errorCode), httpStatus_(ConvertErrorCodeToHttpStatus(errorCode)), - logged_(false) + logged_(false), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) { } @@ -54,7 +58,28 @@ errorCode_(errorCode), httpStatus_(ConvertErrorCodeToHttpStatus(errorCode)), logged_(log), - details_(new std::string(details)) + details_(new std::string(details)), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) + { +#if ORTHANC_ENABLE_LOGGING == 1 + if (log) + { + LOG(ERROR) << EnumerationToString(errorCode_) << ": " << details; + } +#endif + } + + OrthancException::OrthancException(ErrorCode errorCode, + const std::string& details, + uint16_t dimseErrorStatus, + bool log) : + errorCode_(errorCode), + httpStatus_(ConvertErrorCodeToHttpStatus(errorCode)), + logged_(log), + details_(new std::string(details)), + hasDimseErrorStatus_(true), + dimseErrorStatus_(dimseErrorStatus) { #if ORTHANC_ENABLE_LOGGING == 1 if (log) @@ -68,7 +93,9 @@ HttpStatus httpStatus) : errorCode_(errorCode), httpStatus_(httpStatus), - logged_(false) + logged_(false), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) { } @@ -79,7 +106,9 @@ errorCode_(errorCode), httpStatus_(httpStatus), logged_(log), - details_(new std::string(details)) + details_(new std::string(details)), + hasDimseErrorStatus_(false), + dimseErrorStatus_(0x0000) { #if ORTHANC_ENABLE_LOGGING == 1 if (log) @@ -121,6 +150,21 @@ } } + bool OrthancException::HasDimseErrorStatus() const + { + return hasDimseErrorStatus_; + } + + uint16_t OrthancException::GetDimseErrorStatus() const + { + if (!hasDimseErrorStatus_) + { + throw OrthancException(ErrorCode_BadSequenceOfCalls); + } + + return dimseErrorStatus_; + } + bool OrthancException::HasBeenLogged() const { return logged_; diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/Sources/OrthancException.h --- a/OrthancFramework/Sources/OrthancException.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/Sources/OrthancException.h Thu Sep 18 09:53:50 2025 +0200 @@ -44,6 +44,10 @@ // New in Orthanc 1.5.0 std::unique_ptr details_; + // New in Orthanc 1.12.10 + bool hasDimseErrorStatus_; + uint16_t dimseErrorStatus_; + public: OrthancException(const OrthancException& other); @@ -54,6 +58,11 @@ bool log = true); OrthancException(ErrorCode errorCode, + const std::string& details, + uint16_t dimseErrorStatus, + bool log = true); + + OrthancException(ErrorCode errorCode, HttpStatus httpStatus); OrthancException(ErrorCode errorCode, @@ -72,5 +81,9 @@ const char* GetDetails() const; bool HasBeenLogged() const; + + bool HasDimseErrorStatus() const; + + uint16_t GetDimseErrorStatus() const; }; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancFramework/UnitTestsSources/JobsTests.cpp --- a/OrthancFramework/UnitTestsSources/JobsTests.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancFramework/UnitTestsSources/JobsTests.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -137,6 +137,12 @@ { return false; } + + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE + { + throw OrthancException(ErrorCode_NotImplemented); + } + virtual bool GetUserData(Json::Value& userData) const ORTHANC_OVERRIDE { return false; diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Plugins/Engine/PluginsJob.h --- a/OrthancServer/Plugins/Engine/PluginsJob.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Plugins/Engine/PluginsJob.h Thu Sep 18 09:53:50 2025 +0200 @@ -26,6 +26,7 @@ #if ORTHANC_ENABLE_PLUGINS == 1 #include "../../../OrthancFramework/Sources/Compatibility.h" // For ORTHANC_OVERRIDE +#include "../../../OrthancFramework/Sources/OrthancException.h" #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" #include "../Include/orthanc/OrthancCPlugin.h" @@ -84,6 +85,11 @@ return false; } + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE + { + throw OrthancException(ErrorCode_NotImplemented); + } + virtual bool GetUserData(Json::Value& userData) const ORTHANC_OVERRIDE { return false; diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/OrthancMoveRequestHandler.cpp --- a/OrthancServer/Sources/OrthancMoveRequestHandler.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/OrthancMoveRequestHandler.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -109,8 +109,8 @@ } std::string sopClassUid, sopInstanceUid; // Unused - context_.StoreWithTranscoding(sopClassUid, sopInstanceUid, *connection_, dicom, - true, originatorAet_, originatorId_); + context_.PerformCStoreWithTranscoding(sopClassUid, sopInstanceUid, *connection_, dicom, + true, originatorAet_, originatorId_); return Status_Success; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/ServerContext.cpp --- a/OrthancServer/Sources/ServerContext.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/ServerContext.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -1974,13 +1974,13 @@ } - void ServerContext::StoreWithTranscoding(std::string& sopClassUid, - std::string& sopInstanceUid, - DicomStoreUserConnection& connection, - const std::string& dicom, - bool hasMoveOriginator, - const std::string& moveOriginatorAet, - uint16_t moveOriginatorId) + void ServerContext::PerformCStoreWithTranscoding(std::string& sopClassUid, + std::string& sopInstanceUid, + DicomStoreUserConnection& connection, + const std::string& dicom, + bool hasMoveOriginator, + const std::string& moveOriginatorAet, + uint16_t moveOriginatorId) { const void* data = dicom.empty() ? NULL : dicom.c_str(); const RemoteModalityParameters& modality = connection.GetParameters().GetRemoteModality(); diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/ServerContext.h --- a/OrthancServer/Sources/ServerContext.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/ServerContext.h Thu Sep 18 09:53:50 2025 +0200 @@ -577,13 +577,13 @@ size_t size, unsigned int frameIndex); - void StoreWithTranscoding(std::string& sopClassUid, - std::string& sopInstanceUid, - DicomStoreUserConnection& connection, - const std::string& dicom, - bool hasMoveOriginator, - const std::string& moveOriginatorAet, - uint16_t moveOriginatorId); + void PerformCStoreWithTranscoding(std::string& sopClassUid, + std::string& sopInstanceUid, + DicomStoreUserConnection& connection, + const std::string& dicom, + bool hasMoveOriginator, + const std::string& moveOriginatorAet, + uint16_t moveOriginatorId); // This method can be used even if the global option // "TranscodeDicomProtocol" is set to "false" diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/ServerJobs/ArchiveJob.h --- a/OrthancServer/Sources/ServerJobs/ArchiveJob.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/ServerJobs/ArchiveJob.h Thu Sep 18 09:53:50 2025 +0200 @@ -139,7 +139,7 @@ virtual void DeleteAllOutputs() ORTHANC_OVERRIDE; - void SetUserData(const Json::Value& userData) + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE { userData_ = userData; } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/ServerJobs/DicomModalityStoreJob.cpp --- a/OrthancServer/Sources/ServerJobs/DicomModalityStoreJob.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/ServerJobs/DicomModalityStoreJob.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -64,8 +64,8 @@ } std::string sopClassUid, sopInstanceUid; - context_.StoreWithTranscoding(sopClassUid, sopInstanceUid, *connection_, dicom, - HasMoveOriginator(), moveOriginatorAet_, moveOriginatorId_); + context_.PerformCStoreWithTranscoding(sopClassUid, sopInstanceUid, *connection_, dicom, + HasMoveOriginator(), moveOriginatorAet_, moveOriginatorId_); if (storageCommitment_) { diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/ServerJobs/Operations/StoreScuOperation.cpp --- a/OrthancServer/Sources/ServerJobs/Operations/StoreScuOperation.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/ServerJobs/Operations/StoreScuOperation.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -55,8 +55,8 @@ instance.ReadDicom(dicom); std::string sopClassUid, sopInstanceUid; // Unused - context_.StoreWithTranscoding(sopClassUid, sopInstanceUid, lock.GetConnection(), dicom, - false /* Not a C-MOVE */, "", 0); + context_.PerformCStoreWithTranscoding(sopClassUid, sopInstanceUid, lock.GetConnection(), dicom, + false /* Not a C-MOVE */, "", 0); } catch (OrthancException& e) { diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/ServerJobs/ThreadedSetOfInstancesJob.h --- a/OrthancServer/Sources/ServerJobs/ThreadedSetOfInstancesJob.h Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/ServerJobs/ThreadedSetOfInstancesJob.h Thu Sep 18 09:53:50 2025 +0200 @@ -171,7 +171,7 @@ return context_; } - void SetUserData(const Json::Value& userData); + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE; virtual bool GetUserData(Json::Value& userData) const ORTHANC_OVERRIDE; }; diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/Sources/main.cpp --- a/OrthancServer/Sources/main.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/Sources/main.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -704,6 +704,11 @@ message["Details"] = exception.GetDetails(); } + if (exception.HasDimseErrorStatus()) + { + message["DimseErrorStatus"] = exception.GetDimseErrorStatus(); + } + std::string info = message.toStyledString(); output.SendStatus(httpStatus, info); } diff -r 72f74eba36fb -r e90b9d76ff6d OrthancServer/UnitTestsSources/ServerJobsTests.cpp --- a/OrthancServer/UnitTestsSources/ServerJobsTests.cpp Fri Sep 12 12:33:19 2025 +0200 +++ b/OrthancServer/UnitTestsSources/ServerJobsTests.cpp Thu Sep 18 09:53:50 2025 +0200 @@ -141,6 +141,12 @@ { return false; } + + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE + { + throw OrthancException(ErrorCode_NotImplemented); + } + virtual bool GetUserData(Json::Value& userData) const ORTHANC_OVERRIDE { return false; @@ -210,6 +216,12 @@ { s = "DummyInstancesJob"; } + + virtual void SetUserData(const Json::Value& userData) ORTHANC_OVERRIDE + { + throw OrthancException(ErrorCode_NotImplemented); + } + virtual bool GetUserData(Json::Value& userData) const ORTHANC_OVERRIDE { return false;