Mercurial > hg > orthanc-transfers
annotate Framework/PullMode/PullJob.cpp @ 78:0898578d5708 OrthancTransfers-1.3 tip
closing OrthancTransfers-1.3
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 30 May 2024 22:45:33 +0200 |
parents | f4e828607f02 |
children | 1e396fb509ca |
rev | line source |
---|---|
0 | 1 /** |
2 * Transfers accelerator plugin for Orthanc | |
33
44a0430d7899
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
31
diff
changeset
|
3 * Copyright (C) 2018-2021 Osimis S.A., Belgium |
0 | 4 * |
5 * This program is free software: you can redistribute it and/or | |
6 * modify it under the terms of the GNU Affero General Public License | |
7 * as published by the Free Software Foundation, either version 3 of | |
8 * the License, or (at your option) any later version. | |
9 * | |
10 * This program is distributed in the hope that it will be useful, but | |
11 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 * Affero General Public License for more details. | |
14 * | |
15 * You should have received a copy of the GNU Affero General Public License | |
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
17 **/ | |
18 | |
19 | |
20 #include "PullJob.h" | |
21 | |
22 #include "BucketPullQuery.h" | |
23 #include "../HttpQueries/HttpQueriesRunner.h" | |
24 #include "../TransferScheduler.h" | |
25 | |
25
dfc43678aecb
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
26 #include <Compatibility.h> // For std::unique_ptr |
20 | 27 #include <Logging.h> |
0 | 28 |
29 | |
30 namespace OrthancPlugins | |
31 { | |
32 class PullJob::CommitState : public IState | |
33 { | |
34 private: | |
35 const PullJob& job_; | |
25
dfc43678aecb
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
36 std::unique_ptr<DownloadArea> area_; |
0 | 37 |
38 public: | |
39 CommitState(const PullJob& job, | |
40 DownloadArea* area /* takes ownership */) : | |
41 job_(job), | |
42 area_(area) | |
43 { | |
44 } | |
45 | |
46 virtual StateUpdate* Step() | |
47 { | |
8
4c3437217518
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5
diff
changeset
|
48 area_->Commit(); |
0 | 49 return StateUpdate::Success(); |
50 } | |
51 | |
52 virtual void Stop(OrthancPluginJobStopReason reason) | |
53 { | |
54 } | |
55 }; | |
56 | |
57 | |
58 class PullJob::PullBucketsState : public IState | |
59 { | |
60 private: | |
61 const PullJob& job_; | |
62 JobInfo& info_; | |
63 HttpQueriesQueue queue_; | |
25
dfc43678aecb
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
64 std::unique_ptr<DownloadArea> area_; |
dfc43678aecb
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
65 std::unique_ptr<HttpQueriesRunner> runner_; |
0 | 66 |
67 void UpdateInfo() | |
68 { | |
69 size_t scheduledQueriesCount, completedQueriesCount; | |
70 uint64_t uploadedSize, downloadedSize; | |
71 queue_.GetStatistics(scheduledQueriesCount, completedQueriesCount, downloadedSize, uploadedSize); | |
72 | |
73 info_.SetContent("DownloadedSizeMB", ConvertToMegabytes(downloadedSize)); | |
74 info_.SetContent("CompletedHttpQueries", static_cast<unsigned int>(completedQueriesCount)); | |
75 | |
76 if (runner_.get() != NULL) | |
77 { | |
78 float speed; | |
79 runner_->GetSpeed(speed); | |
80 info_.SetContent("NetworkSpeedKBs", static_cast<unsigned int>(speed)); | |
81 } | |
82 | |
83 // The "2" below corresponds to the "LookupInstancesState" | |
84 // and "CommitState" steps (which prevents division by zero) | |
85 info_.SetProgress(static_cast<float>(1 /* LookupInstancesState */ + completedQueriesCount) / | |
86 static_cast<float>(2 + scheduledQueriesCount)); | |
87 } | |
88 | |
89 public: | |
90 PullBucketsState(const PullJob& job, | |
91 JobInfo& info, | |
92 const TransferScheduler& scheduler) : | |
93 job_(job), | |
94 info_(info), | |
95 area_(new DownloadArea(scheduler)) | |
96 { | |
97 const std::string baseUrl = job.peers_.GetPeerUrl(job.query_.GetPeer()); | |
98 | |
99 std::vector<TransferBucket> buckets; | |
100 scheduler.ComputePullBuckets(buckets, job.targetBucketSize_, 2 * job.targetBucketSize_, | |
101 baseUrl, job.query_.GetCompression()); | |
102 area_.reset(new DownloadArea(scheduler)); | |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
103 |
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
104 queue_.SetMaxRetries(job.maxHttpRetries_); |
0 | 105 queue_.Reserve(buckets.size()); |
106 | |
107 for (size_t i = 0; i < buckets.size(); i++) | |
108 { | |
109 queue_.Enqueue(new BucketPullQuery(*area_, buckets[i], job.query_.GetPeer(), job.query_.GetCompression())); | |
110 } | |
111 | |
112 info_.SetContent("TotalInstances", static_cast<unsigned int>(scheduler.GetInstancesCount())); | |
113 info_.SetContent("TotalSizeMB", ConvertToMegabytes(scheduler.GetTotalSize())); | |
114 UpdateInfo(); | |
115 } | |
116 | |
117 virtual StateUpdate* Step() | |
118 { | |
119 if (runner_.get() == NULL) | |
120 { | |
121 runner_.reset(new HttpQueriesRunner(queue_, job_.threadsCount_)); | |
122 } | |
123 | |
124 HttpQueriesQueue::Status status = queue_.WaitComplete(200); | |
125 | |
126 UpdateInfo(); | |
127 | |
128 switch (status) | |
129 { | |
130 case HttpQueriesQueue::Status_Running: | |
131 return StateUpdate::Continue(); | |
132 | |
133 case HttpQueriesQueue::Status_Success: | |
134 return StateUpdate::Next(new CommitState(job_, area_.release())); | |
135 | |
136 case HttpQueriesQueue::Status_Failure: | |
137 return StateUpdate::Failure(); | |
138 | |
139 default: | |
140 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
141 } | |
142 } | |
143 | |
144 virtual void Stop(OrthancPluginJobStopReason reason) | |
145 { | |
146 // Cancel the running download threads | |
147 runner_.reset(); | |
148 } | |
149 }; | |
150 | |
151 | |
152 class PullJob::LookupInstancesState : public IState | |
153 { | |
154 private: | |
155 const PullJob& job_; | |
156 JobInfo& info_; | |
157 | |
158 public: | |
159 LookupInstancesState(const PullJob& job, | |
160 JobInfo& info) : | |
161 job_(job), | |
162 info_(info) | |
163 { | |
37
9708addb5a87
added 'Resources' and 'Originator' in the jobs 'Content'
Alain Mazy <am@osimis.io>
parents:
33
diff
changeset
|
164 if (job_.query_.HasOriginator()) |
9708addb5a87
added 'Resources' and 'Originator' in the jobs 'Content'
Alain Mazy <am@osimis.io>
parents:
33
diff
changeset
|
165 { |
9708addb5a87
added 'Resources' and 'Originator' in the jobs 'Content'
Alain Mazy <am@osimis.io>
parents:
33
diff
changeset
|
166 info_.SetContent("Originator", job_.query_.GetOriginator()); |
9708addb5a87
added 'Resources' and 'Originator' in the jobs 'Content'
Alain Mazy <am@osimis.io>
parents:
33
diff
changeset
|
167 } |
9708addb5a87
added 'Resources' and 'Originator' in the jobs 'Content'
Alain Mazy <am@osimis.io>
parents:
33
diff
changeset
|
168 info_.SetContent("Resources", job_.query_.GetResources()); |
0 | 169 info_.SetContent("Peer", job_.query_.GetPeer()); |
170 info_.SetContent("Compression", EnumerationToString(job_.query_.GetCompression())); | |
171 } | |
172 | |
173 virtual StateUpdate* Step() | |
174 { | |
31
cfeda58d0c8e
remove calls to deprecated classes of JsonCpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
175 std::string lookup; |
cfeda58d0c8e
remove calls to deprecated classes of JsonCpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
176 Orthanc::Toolbox::WriteFastJson(lookup, job_.query_.GetResources()); |
0 | 177 |
178 Json::Value answer; | |
44
f4e828607f02
Added 'SenderTransferID' option that is added as an HTTP header in outgoing requests in PushMode
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
179 std::map<std::string, std::string> headers; |
f4e828607f02
Added 'SenderTransferID' option that is added as an HTTP header in outgoing requests in PushMode
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
180 job_.query_.GetHttpHeaders(headers); |
f4e828607f02
Added 'SenderTransferID' option that is added as an HTTP header in outgoing requests in PushMode
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
181 |
f4e828607f02
Added 'SenderTransferID' option that is added as an HTTP header in outgoing requests in PushMode
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
182 if (!DoPostPeer(answer, job_.peers_, job_.peerIndex_, URI_LOOKUP, lookup, job_.maxHttpRetries_, headers)) |
0 | 183 { |
184 LOG(ERROR) << "Cannot retrieve the list of instances to pull from peer \"" | |
185 << job_.query_.GetPeer() | |
186 << "\" (check that it has the transfers accelerator plugin installed)"; | |
187 return StateUpdate::Failure(); | |
188 } | |
189 | |
190 if (answer.type() != Json::objectValue || | |
191 !answer.isMember(KEY_INSTANCES) || | |
192 !answer.isMember(KEY_ORIGINATOR_UUID) || | |
193 answer[KEY_INSTANCES].type() != Json::arrayValue || | |
194 answer[KEY_ORIGINATOR_UUID].type() != Json::stringValue) | |
195 { | |
196 LOG(ERROR) << "Bad network protocol from peer: " << job_.query_.GetPeer(); | |
197 return StateUpdate::Failure(); | |
198 } | |
199 | |
200 if (job_.query_.HasOriginator() && | |
201 job_.query_.GetOriginator() != answer[KEY_ORIGINATOR_UUID].asString()) | |
202 { | |
5
5e6de82bb10f
use of user properties instead of BidirectionalPeers option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
203 LOG(ERROR) << "Invalid originator, check out the \"" << KEY_REMOTE_SELF |
5e6de82bb10f
use of user properties instead of BidirectionalPeers option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
204 << "\" configuration option of peer: " << job_.query_.GetPeer(); |
0 | 205 return StateUpdate::Failure(); |
206 } | |
207 | |
208 TransferScheduler scheduler; | |
209 | |
210 for (Json::Value::ArrayIndex i = 0; i < answer[KEY_INSTANCES].size(); i++) | |
211 { | |
212 DicomInstanceInfo instance(answer[KEY_INSTANCES][i]); | |
213 scheduler.AddInstance(instance); | |
214 } | |
215 | |
216 if (scheduler.GetInstancesCount() == 0) | |
217 { | |
218 // We're already done: No instance to be retrieved | |
219 return StateUpdate::Success(); | |
220 } | |
221 else | |
222 { | |
223 return StateUpdate::Next(new PullBucketsState(job_, info_, scheduler)); | |
224 } | |
225 } | |
226 | |
227 virtual void Stop(OrthancPluginJobStopReason reason) | |
228 { | |
229 } | |
230 }; | |
231 | |
232 | |
233 StatefulOrthancJob::StateUpdate* PullJob::CreateInitialState(JobInfo& info) | |
234 { | |
235 return StateUpdate::Next(new LookupInstancesState(*this, info)); | |
236 } | |
237 | |
238 | |
8
4c3437217518
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5
diff
changeset
|
239 PullJob::PullJob(const TransferQuery& query, |
0 | 240 size_t threadsCount, |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
241 size_t targetBucketSize, |
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
242 unsigned int maxHttpRetries) : |
0 | 243 StatefulOrthancJob(JOB_TYPE_PULL), |
244 query_(query), | |
245 threadsCount_(threadsCount), | |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
246 targetBucketSize_(targetBucketSize), |
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
247 maxHttpRetries_(maxHttpRetries) |
0 | 248 { |
249 if (!peers_.LookupName(peerIndex_, query_.GetPeer())) | |
250 { | |
251 LOG(ERROR) << "Unknown Orthanc peer: " << query_.GetPeer(); | |
252 throw Orthanc::OrthancException(Orthanc::ErrorCode_UnknownResource); | |
253 } | |
254 | |
255 Json::Value serialized; | |
256 query.Serialize(serialized); | |
257 UpdateSerialized(serialized); | |
258 } | |
259 } |