annotate OrthancServer/Sources/ServerJobs/StorageCommitmentScpJob.h @ 5340:0854cc13b4d5

better error reporting if anonymizing a study whose files are missings
author Alain Mazy <am@osimis.io>
date Wed, 28 Jun 2023 11:11:34 +0200
parents 0ea402b4d901
children 48b8dae6dc77
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5185
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4892
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4892
diff changeset
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * General Public License for more details.
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
25 #include "../../../OrthancFramework/Sources/Compatibility.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
26 #include "../../../OrthancFramework/Sources/DicomNetworking/RemoteModalityParameters.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../../OrthancFramework/Sources/JobsEngine/SetOfCommandsJob.h"
3660
f159b731c47d IStorageCommitmentFactory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3659
diff changeset
28 #include "IStorageCommitmentFactory.h"
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
3660
f159b731c47d IStorageCommitmentFactory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3659
diff changeset
30 #include <memory>
3657
115f82775c46 handling of storage commitment failure reasons
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3642
diff changeset
31 #include <vector>
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 namespace Orthanc
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 class ServerContext;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 class StorageCommitmentScpJob : public SetOfCommandsJob
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 private:
3659
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
40 enum CommandType
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
41 {
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
42 CommandType_Setup,
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
43 CommandType_Lookup,
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
44 CommandType_Answer
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
45 };
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
46
3657
115f82775c46 handling of storage commitment failure reasons
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3642
diff changeset
47 class StorageCommitmentCommand;
3659
08eb0f93c491 setup step in StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3657
diff changeset
48 class SetupCommand;
3657
115f82775c46 handling of storage commitment failure reasons
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3642
diff changeset
49 class LookupCommand;
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 class AnswerCommand;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 class Unserializer;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 ServerContext& context_;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 bool ready_;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 std::string transactionUid_;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 RemoteModalityParameters remoteModality_;
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 std::string calledAet_;
3661
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
58 std::vector<std::string> sopClassUids_;
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
59 std::vector<std::string> sopInstanceUids_;
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
3767
c6658187e4b1 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3661
diff changeset
61 std::unique_ptr<IStorageCommitmentFactory::ILookupHandler> lookupHandler_;
3660
f159b731c47d IStorageCommitmentFactory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3659
diff changeset
62
3661
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
63 void CheckInvariants();
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
64
3660
f159b731c47d IStorageCommitmentFactory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3659
diff changeset
65 void Setup(const std::string& jobId);
f159b731c47d IStorageCommitmentFactory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3659
diff changeset
66
3661
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
67 StorageCommitmentFailureReason Lookup(size_t index);
3660
f159b731c47d IStorageCommitmentFactory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3659
diff changeset
68
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 void Answer();
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 public:
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 StorageCommitmentScpJob(ServerContext& context,
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 const std::string& transactionUid,
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 const std::string& remoteAet,
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 const std::string& calledAet);
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
3638
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
77 StorageCommitmentScpJob(ServerContext& context,
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
78 const Json::Value& serialized);
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
79
3661
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
80 void Reserve(size_t size);
25117919a36b simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3660
diff changeset
81
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 void AddInstance(const std::string& sopClassUid,
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 const std::string& sopInstanceUid);
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 void MarkAsReady();
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
3638
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
87 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 }
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
3638
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
91 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 {
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 target = "StorageCommitmentScp";
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
3638
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
96 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
97
ae866fc06df5 serialization of StorageCommitmentScpJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3636
diff changeset
98 virtual bool Serialize(Json::Value& target) ORTHANC_OVERRIDE;
3636
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 };
bce6ee64f2a4 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 }