changeset 6189:33f88747fe68 attach-custom-data

simplifying OrthancPluginAdoptAttachment() as OrthancPluginAdoptDicomInstance()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 12 Jun 2025 19:55:57 +0200
parents da92d3af3c5d
children e1168108e57f
files OrthancServer/Plugins/Engine/OrthancPlugins.cpp OrthancServer/Plugins/Engine/OrthancPlugins.h OrthancServer/Plugins/Include/orthanc/OrthancCDatabasePlugin.h OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h OrthancServer/Sources/ServerContext.cpp OrthancServer/Sources/ServerContext.h
diffstat 6 files changed, 99 insertions(+), 129 deletions(-) [+]
line wrap: on
line diff
--- a/OrthancServer/Plugins/Engine/OrthancPlugins.cpp	Thu Jun 12 16:06:27 2025 +0200
+++ b/OrthancServer/Plugins/Engine/OrthancPlugins.cpp	Thu Jun 12 19:55:57 2025 +0200
@@ -2258,16 +2258,16 @@
         sizeof(int32_t) != sizeof(OrthancPluginContentType) ||
         sizeof(int32_t) != sizeof(OrthancPluginResourceType) ||
         sizeof(int32_t) != sizeof(OrthancPluginChangeType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginCompressionType) ||
         sizeof(int32_t) != sizeof(OrthancPluginImageFormat) ||
-        sizeof(int32_t) != sizeof(OrthancPluginCompressionType) ||
         sizeof(int32_t) != sizeof(OrthancPluginValueRepresentation) ||
         sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFlags) ||
         sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFormat) ||
         sizeof(int32_t) != sizeof(OrthancPluginCreateDicomFlags) ||
-        sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType) ||
         sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint) ||
         sizeof(int32_t) != sizeof(OrthancPluginInstanceOrigin) ||
         sizeof(int32_t) != sizeof(OrthancPluginJobStepStatus) ||
+        sizeof(int32_t) != sizeof(OrthancPluginJobStopReason) ||
         sizeof(int32_t) != sizeof(OrthancPluginConstraintType) ||
         sizeof(int32_t) != sizeof(OrthancPluginMetricsType) ||
         sizeof(int32_t) != sizeof(OrthancPluginDicomWebBinaryMode) ||
@@ -2276,6 +2276,14 @@
         sizeof(int32_t) != sizeof(OrthancPluginLoadDicomInstanceMode) ||
         sizeof(int32_t) != sizeof(OrthancPluginLogLevel) ||
         sizeof(int32_t) != sizeof(OrthancPluginLogCategory) ||
+        sizeof(int32_t) != sizeof(OrthancPluginStoreStatus) ||
+        sizeof(int32_t) != sizeof(OrthancPluginQueueOrigin) ||
+
+        // From OrthancCDatabasePlugin.h
+        sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseTransactionType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseEventType) ||
+
         static_cast<int>(OrthancPluginDicomToJsonFlags_IncludeBinary) != static_cast<int>(DicomToJsonFlags_IncludeBinary) ||
         static_cast<int>(OrthancPluginDicomToJsonFlags_IncludePrivateTags) != static_cast<int>(DicomToJsonFlags_IncludePrivateTags) ||
         static_cast<int>(OrthancPluginDicomToJsonFlags_IncludeUnknownTags) != static_cast<int>(DicomToJsonFlags_IncludeUnknownTags) ||
@@ -4532,61 +4540,30 @@
     reinterpret_cast<PImpl::PluginHttpOutput*>(p.output)->SendMultipartItem(p.answer, p.answerSize, headers);
   }
 
-  // static FileInfo CreateFileInfoFromPluginAttachment(OrthancPluginAttachment* attachment)
-  // {
-  //   return FileInfo(attachment->uuid,
-  //                   Orthanc::Plugins::Convert(attachment->contentType),
-  //                   attachment->uncompressedSize,
-  //                   attachment->uncompressedHash
-  //                                        )    fileInfo()
-  // }
-
-  static void Convert(FileInfo& info,
-                      const OrthancPluginAttachment2& attachment)
+  void OrthancPlugins::ApplyAdoptDicomInstance(const _OrthancPluginAdoptDicomInstance& parameters)
   {
-    std::string uuid;
-    if (attachment.uuid != NULL)
-    {
-      uuid = attachment.uuid;
-    }
-    else
-    {
-      uuid = Toolbox::GenerateUuid();
-    }
-
-    info = FileInfo(uuid,
-                    Orthanc::Plugins::Convert(static_cast<OrthancPluginContentType>(attachment.contentType)),
-                    attachment.uncompressedSize,
-                    attachment.uncompressedHash,
-                    Orthanc::Plugins::Convert(static_cast<OrthancPluginCompressionType>(attachment.compressionType)),
-                    attachment.compressedSize,
-                    attachment.compressedHash);
-
-    if (attachment.customData != NULL)
-    {
-      info.SetCustomData(attachment.customData, attachment.customDataSize);
-    }
-  }
-
-  void OrthancPlugins::ApplyAdoptAttachment(const _OrthancPluginAdoptAttachment& parameters)
-  {
-    PImpl::ServerContextReference lock(*pimpl_);
-    FileInfo adoptedFile;
-    Convert(adoptedFile, *parameters.attachmentInfo);
-
-    if (adoptedFile.GetContentType() == FileContentType_Dicom)
-    {
-      std::unique_ptr<DicomInstanceToStore> dicom(DicomInstanceToStore::CreateFromBuffer(parameters.buffer, parameters.bufferSize));
-      dicom->SetOrigin(DicomInstanceOrigin::FromPlugins());
-
-      std::string resultPublicId;
-
-      ServerContext::StoreResult result = lock.GetContext().AdoptAttachment(resultPublicId, *dicom, StoreInstanceMode_Default, adoptedFile);
-
-      CopyToMemoryBuffer(parameters.attachmentUuid, adoptedFile.GetUuid());
-      CopyToMemoryBuffer(parameters.createdResourceId, resultPublicId);
-      *(parameters.storeStatus) = Plugins::Convert(result.GetStatus());
-    }
+    std::string md5;
+    Toolbox::ComputeMD5(md5, parameters.buffer, parameters.bufferSize);
+
+    std::unique_ptr<DicomInstanceToStore> dicom(DicomInstanceToStore::CreateFromBuffer(parameters.buffer, parameters.bufferSize));
+    dicom->SetOrigin(DicomInstanceOrigin::FromPlugins());
+
+    const std::string attachmentUuid = Toolbox::GenerateUuid();
+
+    FileInfo adoptedFile(attachmentUuid, FileContentType_Dicom, parameters.bufferSize, md5);
+    adoptedFile.SetCustomData(parameters.customData, parameters.customDataSize);
+
+    std::string instanceId;
+    ServerContext::StoreResult result;
+
+    {
+      PImpl::ServerContextReference lock(*pimpl_);
+      result = lock.GetContext().AdoptDicomInstance(instanceId, *dicom, StoreInstanceMode_Default, adoptedFile);
+    }
+
+    CopyToMemoryBuffer(parameters.attachmentUuid, attachmentUuid);
+    CopyToMemoryBuffer(parameters.instanceId, instanceId);
+    *(parameters.storeStatus) = Plugins::Convert(result.GetStatus());
   }
 
   static void CheckAttachmentCustomDataSupport(ServerContext& context)
@@ -5740,10 +5717,10 @@
         return true;
       }
 
-      case _OrthancPluginService_AdoptAttachment:
-      {
-        const _OrthancPluginAdoptAttachment& p = *reinterpret_cast<const _OrthancPluginAdoptAttachment*>(parameters);
-        ApplyAdoptAttachment(p);
+      case _OrthancPluginService_AdoptDicomInstance:
+      {
+        const _OrthancPluginAdoptDicomInstance& p = *reinterpret_cast<const _OrthancPluginAdoptDicomInstance*>(parameters);
+        ApplyAdoptDicomInstance(p);
         return true;
       }
 
--- a/OrthancServer/Plugins/Engine/OrthancPlugins.h	Thu Jun 12 16:06:27 2025 +0200
+++ b/OrthancServer/Plugins/Engine/OrthancPlugins.h	Thu Jun 12 19:55:57 2025 +0200
@@ -224,7 +224,7 @@
 
     void ApplyLoadDicomInstance(const _OrthancPluginLoadDicomInstance& parameters);
 
-    void ApplyAdoptAttachment(const _OrthancPluginAdoptAttachment& parameters);
+    void ApplyAdoptDicomInstance(const _OrthancPluginAdoptDicomInstance& parameters);
 
     void ApplyGetAttachmentCustomData(const _OrthancPluginGetAttachmentCustomData& parameters);
 
--- a/OrthancServer/Plugins/Include/orthanc/OrthancCDatabasePlugin.h	Thu Jun 12 16:06:27 2025 +0200
+++ b/OrthancServer/Plugins/Include/orthanc/OrthancCDatabasePlugin.h	Thu Jun 12 19:55:57 2025 +0200
@@ -80,6 +80,23 @@
   } _OrthancPluginDatabaseAnswerType;
 
 
+  typedef enum
+  {
+    OrthancPluginDatabaseTransactionType_ReadOnly = 1,
+    OrthancPluginDatabaseTransactionType_ReadWrite = 2,
+    OrthancPluginDatabaseTransactionType_INTERNAL = 0x7fffffff
+  } OrthancPluginDatabaseTransactionType;
+
+
+  typedef enum
+  {
+    OrthancPluginDatabaseEventType_DeletedAttachment = 1,
+    OrthancPluginDatabaseEventType_DeletedResource = 2,
+    OrthancPluginDatabaseEventType_RemainingAncestor = 3,
+    OrthancPluginDatabaseEventType_INTERNAL = 0x7fffffff
+  } OrthancPluginDatabaseEventType;
+
+
   typedef struct
   {
     const char* uuid;
@@ -899,7 +916,9 @@
     OrthancPluginDatabaseContext* result = NULL;
     _OrthancPluginRegisterDatabaseBackend params;
 
-    if (sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType))
+    if (sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseTransactionType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseEventType))
     {
       return NULL;
     }
@@ -951,7 +970,9 @@
     OrthancPluginDatabaseContext* result = NULL;
     _OrthancPluginRegisterDatabaseBackendV2 params;
 
-    if (sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType))
+    if (sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseTransactionType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseEventType))
     {
       return NULL;
     }
@@ -982,23 +1003,6 @@
    **/
 
 /*<! @cond Doxygen_Suppress */
-  typedef enum
-  {
-    OrthancPluginDatabaseTransactionType_ReadOnly = 1,
-    OrthancPluginDatabaseTransactionType_ReadWrite = 2,
-    OrthancPluginDatabaseTransactionType_INTERNAL = 0x7fffffff
-  } OrthancPluginDatabaseTransactionType;
-
-
-  typedef enum
-  {
-    OrthancPluginDatabaseEventType_DeletedAttachment = 1,
-    OrthancPluginDatabaseEventType_DeletedResource = 2,
-    OrthancPluginDatabaseEventType_RemainingAncestor = 3,
-    OrthancPluginDatabaseEventType_INTERNAL = 0x7fffffff
-  } OrthancPluginDatabaseEventType;
-
-
   typedef struct
   {
     OrthancPluginDatabaseEventType type;
@@ -1346,7 +1350,9 @@
   {
     _OrthancPluginRegisterDatabaseBackendV3 params;
 
-    if (sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType))
+    if (sizeof(int32_t) != sizeof(_OrthancPluginDatabaseAnswerType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseTransactionType) ||
+        sizeof(int32_t) != sizeof(OrthancPluginDatabaseEventType))
     {
       return OrthancPluginErrorCode_Plugin;
     }
--- a/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h	Thu Jun 12 16:06:27 2025 +0200
+++ b/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h	Thu Jun 12 19:55:57 2025 +0200
@@ -469,7 +469,7 @@
     _OrthancPluginService_SetMetricsIntegerValue = 43,              /* New in Orthanc 1.12.1 */
     _OrthancPluginService_SetCurrentThreadName = 44,                /* New in Orthanc 1.12.2 */
     _OrthancPluginService_LogMessage = 45,                          /* New in Orthanc 1.12.4 */
-    _OrthancPluginService_AdoptAttachment = 46,                     /* New in Orthanc 1.12.8 */
+    _OrthancPluginService_AdoptDicomInstance = 46,                  /* New in Orthanc 1.12.8 */
     _OrthancPluginService_GetAttachmentCustomData = 47,             /* New in Orthanc 1.12.8 */
     _OrthancPluginService_SetAttachmentCustomData = 48,             /* New in Orthanc 1.12.8 */
     _OrthancPluginService_StoreKeyValue = 49,                       /* New in Orthanc 1.12.8 */
@@ -1145,7 +1145,7 @@
 
 
   /**
-   * The store status response to AdoptAttachment.
+   * The store status response to AdoptDicomInstance.
    **/
   typedef enum
   {
@@ -2132,13 +2132,17 @@
         sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint) ||
         sizeof(int32_t) != sizeof(OrthancPluginInstanceOrigin) ||
         sizeof(int32_t) != sizeof(OrthancPluginJobStepStatus) ||
+        sizeof(int32_t) != sizeof(OrthancPluginJobStopReason) ||
         sizeof(int32_t) != sizeof(OrthancPluginConstraintType) ||
         sizeof(int32_t) != sizeof(OrthancPluginMetricsType) ||
         sizeof(int32_t) != sizeof(OrthancPluginDicomWebBinaryMode) ||
         sizeof(int32_t) != sizeof(OrthancPluginStorageCommitmentFailureReason) ||
+        sizeof(int32_t) != sizeof(OrthancPluginReceivedInstanceAction) ||
         sizeof(int32_t) != sizeof(OrthancPluginLoadDicomInstanceMode) ||
         sizeof(int32_t) != sizeof(OrthancPluginLogLevel) ||
-        sizeof(int32_t) != sizeof(OrthancPluginLogCategory))
+        sizeof(int32_t) != sizeof(OrthancPluginLogCategory) ||
+        sizeof(int32_t) != sizeof(OrthancPluginStoreStatus) ||
+        sizeof(int32_t) != sizeof(OrthancPluginQueueOrigin))
     {
       /* Mismatch in the size of the enumerations */
       return 0;
@@ -9796,29 +9800,14 @@
 
   typedef struct
   {
-    const char* uuid;
-    int32_t     contentType;
-    uint64_t    uncompressedSize;
-    const char* uncompressedHash;
-    int32_t     compressionType;
-    uint64_t    compressedSize;
-    const char* compressedHash;
-    const void* customData;
-    uint32_t    customDataSize;
-  } OrthancPluginAttachment2;
-
-
-  typedef struct
-  {
-    OrthancPluginMemoryBuffer*    createdResourceId;    /* out, in case the attachment is actually a new instance */
-    OrthancPluginMemoryBuffer*    attachmentUuid;       /* out */
-    OrthancPluginStoreStatus*     storeStatus;          /* out */
-    const void*                   buffer;               /* in */
-    uint64_t                      bufferSize;           /* in */
-    OrthancPluginAttachment2*     attachmentInfo;       /* in, note: uuid may not be defined */
-    OrthancPluginResourceType     attachToResourceType; /* in */
-    const char*                   attachToResourceId;   /* in, can be null in case the attachment is a new instance */
-  } _OrthancPluginAdoptAttachment;
+    OrthancPluginMemoryBuffer*    instanceId;
+    OrthancPluginMemoryBuffer*    attachmentUuid;
+    OrthancPluginStoreStatus*     storeStatus;
+    const void*                   buffer;
+    uint64_t                      bufferSize;
+    const void*                   customData;
+    uint32_t                      customDataSize;
+  } _OrthancPluginAdoptDicomInstance;
 
   /**
    * @brief Request Orthanc to adopt an existing attachment.
@@ -9826,28 +9815,26 @@
    * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
 TODO_ATTACH_CUSTOM_DATA TODO TODO
    **/
-  ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginAdoptAttachment(
+  ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginAdoptDicomInstance(
     OrthancPluginContext*         context,
-    OrthancPluginMemoryBuffer*    createdResourceId, /* out */
+    OrthancPluginMemoryBuffer*    instanceId,        /* out */
     OrthancPluginMemoryBuffer*    attachmentUuid,    /* out */
-    OrthancPluginStoreStatus*     storeStatus        /* out */,
+    OrthancPluginStoreStatus*     storeStatus,       /* out */
     const void*                   buffer,
     uint64_t                      bufferSize,
-    OrthancPluginAttachment2*     attachmentInfo,
-    OrthancPluginResourceType     attachToResourceType,
-    const char*                   attachToResourceId)
-  {
-    _OrthancPluginAdoptAttachment params;
-    params.createdResourceId = createdResourceId;
+    const void*                   customData,
+    uint32_t                      customDataSize)
+  {
+    _OrthancPluginAdoptDicomInstance params;
+    params.instanceId = instanceId;
     params.attachmentUuid = attachmentUuid;
     params.storeStatus = storeStatus;
     params.buffer = buffer;
     params.bufferSize = bufferSize;
-    params.attachmentInfo = attachmentInfo;
-    params.attachToResourceType = attachToResourceType;
-    params.attachToResourceId = attachToResourceId;
-
-    return context->InvokeService(context, _OrthancPluginService_AdoptAttachment, &params);
+    params.customData = customData;
+    params.customDataSize = customDataSize;
+
+    return context->InvokeService(context, _OrthancPluginService_AdoptDicomInstance, &params);
   }
 
 
--- a/OrthancServer/Sources/ServerContext.cpp	Thu Jun 12 16:06:27 2025 +0200
+++ b/OrthancServer/Sources/ServerContext.cpp	Thu Jun 12 19:55:57 2025 +0200
@@ -636,10 +636,10 @@
                                  adoptedFileNotUsed);
   }
 
-  ServerContext::StoreResult ServerContext::AdoptAttachment(std::string& resultPublicId,
-                                                            DicomInstanceToStore& dicom,
-                                                            StoreInstanceMode mode,
-                                                            const FileInfo& adoptedFile)
+  ServerContext::StoreResult ServerContext::AdoptDicomInstance(std::string& resultPublicId,
+                                                               DicomInstanceToStore& dicom,
+                                                               StoreInstanceMode mode,
+                                                               const FileInfo& adoptedFile)
   {
     return StoreAfterTranscoding(resultPublicId,
                                  dicom,
--- a/OrthancServer/Sources/ServerContext.h	Thu Jun 12 16:06:27 2025 +0200
+++ b/OrthancServer/Sources/ServerContext.h	Thu Jun 12 19:55:57 2025 +0200
@@ -364,10 +364,10 @@
                       DicomInstanceToStore& dicom,
                       StoreInstanceMode mode);
 
-    StoreResult AdoptAttachment(std::string& resultPublicId,
-                                DicomInstanceToStore& dicom,
-                                StoreInstanceMode mode,
-                                const FileInfo& adoptedFile);
+    StoreResult AdoptDicomInstance(std::string& resultPublicId,
+                                   DicomInstanceToStore& dicom,
+                                   StoreInstanceMode mode,
+                                   const FileInfo& adoptedFile);
 
     StoreResult TranscodeAndStore(std::string& resultPublicId,
                                   DicomInstanceToStore* dicom,