annotate OrthancServer/Sources/ServerJobs/ResourceModificationJob.h @ 4740:c1d6ce00be3f openssl-3.x

integration mainline->openssl-3.x
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 06 Jul 2021 08:40:43 +0200
parents f0038043fb97
children 2e71a08eea15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4205
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * General Public License for more details.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
24 #include "../../../OrthancFramework/Sources/DicomParsing/DicomModification.h"
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
25 #include "../DicomInstanceOrigin.h"
3942
5b882ad2ffd0 "/{patients|studies|series}/.../modify": New option "KeepSource"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
26 #include "CleaningInstancesJob.h"
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 namespace Orthanc
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 {
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
30 class ServerContext;
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
31
3942
5b882ad2ffd0 "/{patients|studies|series}/.../modify": New option "KeepSource"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
32 class ResourceModificationJob : public CleaningInstancesJob
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
2868
abce036683cd sharing code within OrthancRestAnonymizeModify
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2860
diff changeset
34 private:
4693
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
35 class IOutput : public boost::noncopyable
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
36 {
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
37 public:
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
38 virtual ~IOutput()
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
39 {
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
40 }
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
41
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
42 virtual void Update(DicomInstanceHasher& hasher) = 0;
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
43
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
44 virtual void Format(Json::Value& target) const = 0;
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
45
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
46 virtual bool IsSingleResource() const = 0;
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
47 };
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
48
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
49 class SingleOutput;
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
50 class MultipleOutputs;
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
52 std::unique_ptr<DicomModification> modification_;
4693
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
53 boost::shared_ptr<IOutput> output_;
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
54 bool isAnonymization_;
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
55 DicomInstanceOrigin origin_;
3943
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
56 bool transcode_;
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
57 DicomTransferSyntax transferSyntax_;
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 protected:
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4204
diff changeset
60 virtual bool HandleInstance(const std::string& instance) ORTHANC_OVERRIDE;
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 public:
4204
318c16cfccab cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
63 explicit ResourceModificationJob(ServerContext& context);
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
65 ResourceModificationJob(ServerContext& context,
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
66 const Json::Value& serialized);
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
67
4693
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
68 // NB: The "outputLevel" only controls the output format, and
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
69 // might *not* be the same as "modification->GetLevel()"
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
70 void SetSingleResourceModification(DicomModification* modification, // Takes ownership
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
71 ResourceType outputLevel,
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
72 bool isAnonymization);
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
73
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
74 void SetMultipleResourcesModification(DicomModification* modification, // Takes ownership
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
75 bool isAnonymization);
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 void SetOrigin(const DicomInstanceOrigin& origin);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 void SetOrigin(const RestApiCall& call);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
81 const DicomModification& GetModification() const;
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
82
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
83 bool IsAnonymization() const
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
84 {
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
85 return isAnonymization_;
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
86 }
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
87
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
88 const DicomInstanceOrigin& GetOrigin() const
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
89 {
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
90 return origin_;
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
91 }
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
92
3943
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
93 bool IsTranscode() const
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
94 {
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
95 return transcode_;
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
96 }
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
97
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
98 DicomTransferSyntax GetTransferSyntax() const;
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
99
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
100 void SetTranscode(DicomTransferSyntax syntax);
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
101
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
102 void SetTranscode(const std::string& transferSyntaxUid);
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
103
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
104 void ClearTranscode();
b26d25d3c1c7 "/{patients|studies|series}/.../modify": New option "Transcode"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3942
diff changeset
105
4693
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
106 bool IsSingleResourceModification() const;
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
107
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
108 // Only possible if "IsSingleResourceModification()"
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
109 ResourceType GetOutputLevel() const;
45bce660ce3a added routes for bulk anonymization/modification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
110
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4204
diff changeset
111 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 }
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4204
diff changeset
115 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 target = "ResourceModification";
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 }
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4204
diff changeset
120 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4204
diff changeset
122 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE;
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 };
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 }