annotate OrthancServer/Plugins/Samples/Sanitizer/Plugin.cpp @ 5809:023a99146dd0 attach-custom-data tip

merged find-refactoring -> attach-custom-data
author Alain Mazy <am@orthanc.team>
date Tue, 24 Sep 2024 12:53:43 +0200
parents f7adfb22e20e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
1 /**
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5572
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5572
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
8 *
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
9 * This program is free software: you can redistribute it and/or
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
10 * modify it under the terms of the GNU General Public License as
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
11 * published by the Free Software Foundation, either version 3 of the
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
12 * License, or (at your option) any later version.
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
13 *
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
17 * General Public License for more details.
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
18 *
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
21 **/
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
22
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
23
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
24 #include "../../../../OrthancFramework/Sources/Compatibility.h"
4849
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
25 #include "../../../../OrthancFramework/Sources/DicomParsing/ParsedDicomFile.h"
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
26 #include "../../../../OrthancFramework/Sources/OrthancFramework.h"
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
27 #include "../Common/OrthancPluginCppWrapper.h"
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
28
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
29 #include <boost/filesystem.hpp>
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
30 #include <json/value.h>
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
31 #include <string.h>
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
32 #include <iostream>
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
33
5543
cd698247b029 fix deprecated calls
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
34 #define ORTHANC_PLUGIN_NAME "sanitizer"
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
35
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
36
4919
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
37 OrthancPluginReceivedInstanceAction ReceivedInstanceCallback(OrthancPluginMemoryBuffer64* modifiedDicomBuffer,
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
38 const void* receivedDicomBuffer,
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
39 uint64_t receivedDicomBufferSize,
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
40 OrthancPluginInstanceOrigin origin)
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
41 {
4849
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
42 Orthanc::ParsedDicomFile dicom(receivedDicomBuffer, receivedDicomBufferSize);
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
43 std::string institutionName = "My institution";
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
44
4849
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
45 dicom.Replace(Orthanc::DICOM_TAG_INSTITUTION_NAME, institutionName, false, Orthanc::DicomReplaceMode_InsertIfAbsent, "");
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
46
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
47 std::string modifiedDicom;
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
48 dicom.SaveToMemoryBuffer(modifiedDicom);
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
49
4913
c1b19f95e166 fix signature of OrthancPluginReceivedInstanceCallback for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4912
diff changeset
50 OrthancPluginCreateMemoryBuffer64(OrthancPlugins::GetGlobalContext(), modifiedDicomBuffer, modifiedDicom.size());
c1b19f95e166 fix signature of OrthancPluginReceivedInstanceCallback for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4912
diff changeset
51 memcpy(modifiedDicomBuffer->data, modifiedDicom.c_str(), modifiedDicom.size());
c1b19f95e166 fix signature of OrthancPluginReceivedInstanceCallback for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4912
diff changeset
52
4919
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
53 return OrthancPluginReceivedInstanceAction_Modify;
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
54 }
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
55
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
56
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
57 extern "C"
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
58 {
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
59 ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* c)
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
60 {
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
61 OrthancPlugins::SetGlobalContext(c);
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
62
4849
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
63 Orthanc::InitializeFramework("", true);
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
64
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
65 /* Check the version of the Orthanc core */
4919
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
66 if (OrthancPluginCheckVersion(c) == 0)
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
67 {
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
68 OrthancPlugins::ReportMinimalOrthancVersion(ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
69 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
70 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
71 return -1;
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
72 }
676e03e69703 added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4915
diff changeset
73
5572
f0dc99bc811c removed circular dependency of OrthancPluginsCppWrapper with Orthanc::Logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5543
diff changeset
74 ORTHANC_PLUGINS_LOG_WARNING("Sanitizer plugin is initializing");
5543
cd698247b029 fix deprecated calls
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
75 OrthancPlugins::SetDescription(ORTHANC_PLUGIN_NAME, "Sample plugin to sanitize incoming DICOM instances.");
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
76
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
77 OrthancPluginRegisterReceivedInstanceCallback(c, ReceivedInstanceCallback);
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
78
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
79 return 0;
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
80 }
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
81
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
82
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
83 ORTHANC_PLUGINS_API void OrthancPluginFinalize()
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
84 {
5572
f0dc99bc811c removed circular dependency of OrthancPluginsCppWrapper with Orthanc::Logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5543
diff changeset
85 ORTHANC_PLUGINS_LOG_WARNING("Sanitizer plugin is finalizing");
4849
4addabcab158 use ParsedDicomFile in Sanitizer sample plugin
Alain Mazy <am@osimis.io>
parents: 4845
diff changeset
86 Orthanc::FinalizeFramework();
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
87 }
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
88
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
89
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
90 ORTHANC_PLUGINS_API const char* OrthancPluginGetName()
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
91 {
5543
cd698247b029 fix deprecated calls
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
92 return ORTHANC_PLUGIN_NAME;
4845
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
93 }
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
94
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
95
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
96 ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion()
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
97 {
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
98 return "0.1";
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
99 }
02d77189d8ba added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
diff changeset
100 }