orthanc: OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp comparison

comparison OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4627:f7d5372b59b3 db-changes

handling revisions of attachments

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 20 Apr 2021 15:11:59 +0200
parents	95ffe3b6ef7c
children	66109d24d26e

comparison

equal deleted inserted replaced

-:686f189a903d
+:f7d5372b59b3
 .SetDescription("Delete some metadata associated with the given DICOM " + r +
 ". This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).")
 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
 .SetUriArgument("name", "The name of the metadata, or its index (cf. `UserMetadata` configuration option)")
 .SetHttpHeader("If-Match", "Revision of the metadata, to check if its content has not changed and can "
-"be deleted. This option is mandatory if `CheckRevision` option is `true`.");
+"be deleted. This header is mandatory if `CheckRevision` option is `true`.");
 return;
 }
 CheckValidResourceType(call);
 const std::string publicId = call.GetUriComponent("id", "");
 call.GetOutput().AnswerJson(result);
 }
-static bool GetAttachmentInfo(FileInfo& info, RestApiCall& call)
+static void AddAttachmentDocumentation(RestApiGetCall& call,
+const std::string& resourceType)
+{
+call.GetDocumentation()
+.SetUriArgument("id", "Orthanc identifier of the " + resourceType + " of interest")
+.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
+.SetAnswerHeader("ETag", "Revision of the attachment, to be used in further `PUT` or `DELETE` operations")
+.SetHttpHeader("If-None-Match", "Optional revision of the attachment, to check if its content has changed");
+}
+static bool GetAttachmentInfo(FileInfo& info,
+RestApiGetCall& call)
 {
 CheckValidResourceType(call);
-std::string publicId = call.GetUriComponent("id", "");
+const std::string publicId = call.GetUriComponent("id", "");
-std::string name = call.GetUriComponent("name", "");
+const std::string name = call.GetUriComponent("name", "");
 FileContentType contentType = StringToContentType(name);
-return OrthancRestApi::GetIndex(call).LookupAttachment(info, publicId, contentType);
+int64_t revision;
+if (OrthancRestApi::GetIndex(call).LookupAttachment(info, revision, publicId, contentType))
+{
+call.GetOutput().GetLowLevelOutput().
+AddHeader("ETag", "\"" + boost::lexical_cast<std::string>(revision) + "\"");  // New in Orthanc 1.9.2
+int64_t userRevision;
+if (GetRevisionHeader(userRevision, call, "If-None-Match") &&
+revision == userRevision)
+{
+call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
+return false;
+}
+else
+{
+return true;
+}
+}
+else
+{
+throw OrthancException(ErrorCode_UnknownResource);
+}
 }
 static void GetAttachmentOperations(RestApiGetCall& call)
 {
 if (call.IsDocumentation())
 {
 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
 std::string r = GetResourceTypeText(t, false /* plural */, false /* upper case */);
+AddAttachmentDocumentation(call, r);
 call.GetDocumentation()
 .SetTag("Other")
 .SetSummary("List operations on attachments")
 .SetDescription("Get the list of the operations that are available for attachments associated with the given " + r)
-.SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddAnswerType(MimeType_Json, "List of the available operations")
 .SetHttpGetSample("https://demo.orthanc-server.com/instances/d94d9a03-3003b047-a4affc69-322313b2-680530a2/attachments/dicom", true);
 return;
 }
 .SetSummary("Get attachment" + std::string(uncompress ? "" : " (no decompression)"))
 .SetDescription("Get the (binary) content of one attachment associated with the given " + r +
 std::string(uncompress ? "" : ". The attachment will not be decompressed if `StorageCompression` is `true`."))
 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
-.AddAnswerType(MimeType_Binary, "The attachment");
+.AddAnswerType(MimeType_Binary, "The attachment")
+.SetAnswerHeader("ETag", "Revision of the attachment, to be used in further `PUT` or `DELETE` operations")
+.SetHttpHeader("If-None-Match", "Optional revision of the metadata, to check if its content has changed");
 return;
 }
 ServerContext& context = OrthancRestApi::GetContext(call);
 std::string publicId = call.GetUriComponent("id", "");
 FileContentType type = StringToContentType(call.GetUriComponent("name", ""));
 if (uncompress)
 {
-context.AnswerAttachment(call.GetOutput(), publicId, type);
+FileInfo info;
+if (GetAttachmentInfo(info, call))
+{
+context.AnswerAttachment(call.GetOutput(), publicId, type);
+}
 }
 else
 {
 // Return the raw data (possibly compressed), as stored on the filesystem
 std::string content;
-context.ReadAttachment(content, publicId, type, false);
+int64_t revision;
-call.GetOutput().AnswerBuffer(content, MimeType_Binary);
+context.ReadAttachment(content, revision, publicId, type, false);
+call.GetOutput().GetLowLevelOutput().
+AddHeader("ETag", "\"" + boost::lexical_cast<std::string>(revision) + "\"");  // New in Orthanc 1.9.2
+int64_t userRevision;
+if (GetRevisionHeader(userRevision, call, "If-None-Match") &&
+revision == userRevision)
+{
+call.GetOutput().GetLowLevelOutput().SendStatus(HttpStatus_304_NotModified);
+}
+else
+{
+call.GetOutput().AnswerBuffer(content, MimeType_Binary);
+}
 }
 }
 static void GetAttachmentSize(RestApiGetCall& call)
 {
 if (call.IsDocumentation())
 {
 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
 std::string r = GetResourceTypeText(t, false /* plural */, false /* upper case */);
+AddAttachmentDocumentation(call, r);
 call.GetDocumentation()
 .SetTag(GetResourceTypeText(t, true /* plural */, true /* upper case */))
 .SetSummary("Get size of attachment")
 .SetDescription("Get the size of one attachment associated with the given " + r)
-.SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddAnswerType(MimeType_PlainText, "The size of the attachment");
 return;
 }
 FileInfo info;
 {
 if (call.IsDocumentation())
 {
 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
 std::string r = GetResourceTypeText(t, false /* plural */, false /* upper case */);
+AddAttachmentDocumentation(call, r);
 call.GetDocumentation()
 .SetTag(GetResourceTypeText(t, true /* plural */, true /* upper case */))
 .SetSummary("Get size of attachment on disk")
 .SetDescription("Get the size of one attachment associated with the given " + r + ", as stored on the disk. "
 "This is different from `.../size` iff `EnableStorage` is `true`.")
-.SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddAnswerType(MimeType_PlainText, "The size of the attachment, as stored on the disk");
 return;
 }
 FileInfo info;
 {
 if (call.IsDocumentation())
 {
 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
 std::string r = GetResourceTypeText(t, false /* plural */, false /* upper case */);
+AddAttachmentDocumentation(call, r);
 call.GetDocumentation()
 .SetTag(GetResourceTypeText(t, true /* plural */, true /* upper case */))
 .SetSummary("Get MD5 of attachment")
 .SetDescription("Get the MD5 hash of one attachment associated with the given " + r)
-.SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddAnswerType(MimeType_PlainText, "The MD5 of the attachment");
 return;
 }
 FileInfo info;
 {
 if (call.IsDocumentation())
 {
 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
 std::string r = GetResourceTypeText(t, false /* plural */, false /* upper case */);
+AddAttachmentDocumentation(call, r);
 call.GetDocumentation()
 .SetTag(GetResourceTypeText(t, true /* plural */, true /* upper case */))
 .SetSummary("Get MD5 of attachment on disk")
 .SetDescription("Get the MD5 hash of one attachment associated with the given " + r + ", as stored on the disk. "
 "This is different from `.../md5` iff `EnableStorage` is `true`.")
-.SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddAnswerType(MimeType_PlainText, "The MD5 of the attachment, as stored on the disk");
 return;
 }
 FileInfo info;
 ServerContext& context = OrthancRestApi::GetContext(call);
 CheckValidResourceType(call);
 std::string publicId = call.GetUriComponent("id", "");
 std::string name = call.GetUriComponent("name", "");
+FileContentType contentType = StringToContentType(name);
 FileInfo info;
-if (!GetAttachmentInfo(info, call) ||
+int64_t revision;  // Ignored
+if (!OrthancRestApi::GetIndex(call).LookupAttachment(info, revision, publicId, contentType) ||
 info.GetCompressedMD5() == "" ||
 info.GetUncompressedMD5() == "")
 {
 // Inexistent resource, or no MD5 available
 return;
 bool ok = false;
 // First check whether the compressed data is correctly stored in the disk
 std::string data;
-context.ReadAttachment(data, publicId, StringToContentType(name), false);
+context.ReadAttachment(data, revision, publicId, StringToContentType(name), false);
 std::string actualMD5;
 Toolbox::ComputeMD5(actualMD5, data);
 if (actualMD5 == info.GetCompressedMD5())
 {
 ok = true;
 }
 else
 {
-context.ReadAttachment(data, publicId, StringToContentType(name), true);
+context.ReadAttachment(data, revision, publicId, StringToContentType(name), true);
 Toolbox::ComputeMD5(actualMD5, data);
 ok = (actualMD5 == info.GetUncompressedMD5());
 }
 }
 .SetDescription("Attach a file to the given DICOM " + r +
 ". This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).")
 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
 .SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddRequestType(MimeType_Binary, "Binary data containing the attachment")
-.AddAnswerType(MimeType_Json, "Empty JSON object in the case of a success");
+.AddAnswerType(MimeType_Json, "Empty JSON object in the case of a success")
+.SetHttpHeader("If-Match", "Revision of the attachment, if this is not the first time this attachment is set.");
 return;
 }
 ServerContext& context = OrthancRestApi::GetContext(call);
 CheckValidResourceType(call);
 std::string publicId = call.GetUriComponent("id", "");
 std::string name = call.GetUriComponent("name", "");
 FileContentType contentType = StringToContentType(name);
-if (IsUserContentType(contentType) &&  // It is forbidden to modify internal attachments
+if (IsUserContentType(contentType))  // It is forbidden to modify internal attachments
-context.AddAttachment(publicId, StringToContentType(name), call.GetBodyData(), call.GetBodySize()))
+{
-{
+int64_t oldRevision;
+bool hasOldRevision = GetRevisionHeader(oldRevision, call, "if-match");
+if (!hasOldRevision)
+{
+OrthancConfiguration::ReaderLock lock;
+if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
+{
+// "StatelessDatabaseOperations::AddAttachment()" will ignore
+// the actual value of "oldRevision" if the metadata is
+// inexistent as expected
+hasOldRevision = true;
+oldRevision = -1;  // dummy value
+}
+}
+int64_t newRevision;
+context.AddAttachment(newRevision, publicId, StringToContentType(name), call.GetBodyData(),
+call.GetBodySize(), hasOldRevision, oldRevision);
+call.GetOutput().GetLowLevelOutput().
+AddHeader("ETag", "\"" + boost::lexical_cast<std::string>(newRevision) + "\"");  // New in Orthanc 1.9.2
 call.GetOutput().AnswerBuffer("{}", MimeType_Json);
 }
 else
 {
 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
 .SetTag(GetResourceTypeText(t, true /* plural */, true /* upper case */))
 .SetSummary("Delete attachment")
 .SetDescription("Delete an attachment associated with the given DICOM " + r +
 ". This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).")
 .SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)");
+.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
+.SetHttpHeader("If-Match", "Revision of the attachment, to check if its content has not changed and can "
+"be deleted. This header is mandatory if `CheckRevision` option is `true`.");
 return;
 }
 CheckValidResourceType(call);
 }
 }
 if (allowed)
 {
-OrthancRestApi::GetIndex(call).DeleteAttachment(publicId, contentType);
+bool found;
-call.GetOutput().AnswerBuffer("{}", MimeType_Json);
+int64_t revision;
+if (GetRevisionHeader(revision, call, "if-match"))
+{
+found = OrthancRestApi::GetIndex(call).DeleteAttachment(publicId, contentType, true, revision);
+}
+else
+{
+OrthancConfiguration::ReaderLock lock;
+if (lock.GetConfiguration().GetBooleanParameter(CHECK_REVISIONS, false))
+{
+throw OrthancException(ErrorCode_Revision,
+"HTTP header \"If-Match\" is missing, as \"CheckRevision\" is \"true\"");
+}
+else
+{
+found = OrthancRestApi::GetIndex(call).DeleteAttachment(publicId, contentType, false, -1 /* dummy value */);
+}
+}
+if (found)
+{
+call.GetOutput().AnswerBuffer("", MimeType_PlainText);
+}
+else
+{
+throw OrthancException(ErrorCode_UnknownResource);
+}
 }
 else
 {
 call.GetOutput().SignalError(HttpStatus_403_Forbidden);
 }
 {
 if (call.IsDocumentation())
 {
 ResourceType t = StringToResourceType(call.GetFullUri()[0].c_str());
 std::string r = GetResourceTypeText(t, false /* plural */, false /* upper case */);
+AddAttachmentDocumentation(call, r);
 call.GetDocumentation()
 .SetTag(GetResourceTypeText(t, true /* plural */, true /* upper case */))
 .SetSummary("Is attachment compressed?")
 .SetDescription("Test whether the attachment has been stored as a compressed file on the disk.")
-.SetUriArgument("id", "Orthanc identifier of the " + r + " of interest")
-.SetUriArgument("name", "The name of the attachment, or its index (cf. `UserContentType` configuration option)")
 .AddAnswerType(MimeType_PlainText, "`0` if the attachment was stored uncompressed, `1` if it was compressed");
 return;
 }
 FileInfo info;
 index.GetChildInstances(instances, *study);
 for (std::list<std::string>::const_iterator
 instance = instances.begin(); instance != instances.end(); ++instance)
 {
-index.DeleteAttachment(*instance, FileContentType_DicomAsJson);
+index.DeleteAttachment(*instance, FileContentType_DicomAsJson, false /* no revision checks */, -1 /* dummy */);
 }
 }
 call.GetOutput().AnswerBuffer("", MimeType_PlainText);
 }

Mercurial > hg > orthanc

comparison OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp @ 4627:f7d5372b59b3 db-changes