Mercurial > hg > orthanc-transfers
annotate Framework/PushMode/PushJob.cpp @ 68:43f3d9f1985d
fixed handling of DefineSourceBasenameForTarget
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 20 Dec 2023 22:14:25 +0100 |
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 "PushJob.h" | |
21 | |
22 #include "BucketPushQuery.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 PushJob::FinalState : public IState | |
33 { | |
34 private: | |
35 const PushJob& job_; | |
36 JobInfo& info_; | |
37 std::string transactionUri_; | |
38 bool isCommit_; | |
39 | |
40 public: | |
41 FinalState(const PushJob& job, | |
42 JobInfo& info, | |
43 const std::string& transactionUri, | |
44 bool isCommit) : | |
45 job_(job), | |
46 info_(info), | |
47 transactionUri_(transactionUri), | |
48 isCommit_(isCommit) | |
49 { | |
50 } | |
51 | |
52 virtual StateUpdate* Step() | |
53 { | |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
54 Json::Value answer; |
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
55 bool success = false; |
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
|
56 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
|
57 job_.query_.GetHttpHeaders(headers); |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
58 |
0 | 59 if (isCommit_) |
60 { | |
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
|
61 success = DoPostPeer(answer, job_.peers_, job_.peerIndex_, transactionUri_ + "/commit", "", job_.maxHttpRetries_, headers); |
0 | 62 } |
63 else | |
64 { | |
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
|
65 success = DoDeletePeer(job_.peers_, job_.peerIndex_, transactionUri_, job_.maxHttpRetries_, headers); |
0 | 66 } |
67 | |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
68 if (!success) |
0 | 69 { |
70 if (isCommit_) | |
71 { | |
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
|
72 LOG(ERROR) << "Cannot commit push transaction on remote peer: " // TODO: add job ID |
0 | 73 << job_.query_.GetPeer(); |
74 } | |
75 | |
76 return StateUpdate::Failure(); | |
77 } | |
78 else if (isCommit_) | |
79 { | |
80 return StateUpdate::Success(); | |
81 } | |
82 else | |
83 { | |
84 return StateUpdate::Failure(); | |
85 } | |
86 } | |
87 | |
88 virtual void Stop(OrthancPluginJobStopReason reason) | |
89 { | |
90 } | |
91 }; | |
92 | |
93 | |
94 class PushJob::PushBucketsState : public IState | |
95 { | |
96 private: | |
97 const PushJob& job_; | |
98 JobInfo& info_; | |
99 std::string transactionUri_; | |
100 HttpQueriesQueue queue_; | |
25
dfc43678aecb
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
20
diff
changeset
|
101 std::unique_ptr<HttpQueriesRunner> runner_; |
0 | 102 |
103 void UpdateInfo() | |
104 { | |
105 size_t scheduledQueriesCount, completedQueriesCount; | |
106 uint64_t uploadedSize, downloadedSize; | |
107 queue_.GetStatistics(scheduledQueriesCount, completedQueriesCount, downloadedSize, uploadedSize); | |
108 | |
109 info_.SetContent("UploadedSizeMB", ConvertToMegabytes(uploadedSize)); | |
110 info_.SetContent("CompletedHttpQueries", static_cast<unsigned int>(completedQueriesCount)); | |
111 | |
112 if (runner_.get() != NULL) | |
113 { | |
114 float speed; | |
115 runner_->GetSpeed(speed); | |
116 info_.SetContent("NetworkSpeedKBs", static_cast<unsigned int>(speed)); | |
117 } | |
118 | |
119 // The "2" below corresponds to the "CreateTransactionState" | |
120 // and "FinalState" steps (which prevents division by zero) | |
121 info_.SetProgress(static_cast<float>(1 /* CreateTransactionState */ + completedQueriesCount) / | |
122 static_cast<float>(2 + scheduledQueriesCount)); | |
123 } | |
124 | |
125 public: | |
126 PushBucketsState(const PushJob& job, | |
127 JobInfo& info, | |
128 const std::string& transactionUri, | |
129 const std::vector<TransferBucket>& buckets) : | |
130 job_(job), | |
131 info_(info), | |
8
4c3437217518
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
132 transactionUri_(transactionUri) |
0 | 133 { |
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
|
134 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
|
135 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
|
136 |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
137 queue_.SetMaxRetries(job.maxHttpRetries_); |
0 | 138 queue_.Reserve(buckets.size()); |
139 | |
140 for (size_t i = 0; i < buckets.size(); i++) | |
141 { | |
142 queue_.Enqueue(new BucketPushQuery(job.cache_, buckets[i], job.query_.GetPeer(), | |
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
|
143 transactionUri_, i, job.query_.GetCompression(), headers)); |
0 | 144 } |
145 | |
146 UpdateInfo(); | |
147 } | |
148 | |
149 virtual StateUpdate* Step() | |
150 { | |
151 if (runner_.get() == NULL) | |
152 { | |
153 runner_.reset(new HttpQueriesRunner(queue_, job_.threadsCount_)); | |
154 } | |
155 | |
156 HttpQueriesQueue::Status status = queue_.WaitComplete(200); | |
157 | |
158 UpdateInfo(); | |
159 | |
160 switch (status) | |
161 { | |
162 case HttpQueriesQueue::Status_Running: | |
163 return StateUpdate::Continue(); | |
164 | |
165 case HttpQueriesQueue::Status_Success: | |
166 // Commit transaction on remote peer | |
167 return StateUpdate::Next(new FinalState(job_, info_, transactionUri_, true)); | |
168 | |
169 case HttpQueriesQueue::Status_Failure: | |
170 // Discard transaction on remote peer | |
171 return StateUpdate::Next(new FinalState(job_, info_, transactionUri_, false)); | |
172 | |
173 default: | |
174 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
175 } | |
176 } | |
177 | |
178 virtual void Stop(OrthancPluginJobStopReason reason) | |
179 { | |
180 // Cancel the running download threads | |
181 runner_.reset(); | |
182 } | |
183 }; | |
184 | |
185 | |
186 class PushJob::CreateTransactionState : public IState | |
187 { | |
188 private: | |
189 const PushJob& job_; | |
190 JobInfo& info_; | |
191 std::string createTransaction_; | |
192 std::vector<TransferBucket> buckets_; | |
193 | |
194 public: | |
195 CreateTransactionState(const PushJob& job, | |
196 JobInfo& info) : | |
197 job_(job), | |
198 info_(info) | |
199 { | |
200 TransferScheduler scheduler; | |
201 scheduler.ParseListOfResources(job_.cache_, job_.query_.GetResources()); | |
202 | |
203 Json::Value push; | |
204 scheduler.FormatPushTransaction(push, buckets_, | |
205 job.targetBucketSize_, 2 * job.targetBucketSize_, | |
206 job_.query_.GetCompression()); | |
207 | |
31
cfeda58d0c8e
remove calls to deprecated classes of JsonCpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
208 Orthanc::Toolbox::WriteFastJson(createTransaction_, push); |
0 | 209 |
37
9708addb5a87
added 'Resources' and 'Originator' in the jobs 'Content'
Alain Mazy <am@osimis.io>
parents:
33
diff
changeset
|
210 info_.SetContent("Resources", job_.query_.GetResources()); |
0 | 211 info_.SetContent("Peer", job_.query_.GetPeer()); |
212 info_.SetContent("Compression", EnumerationToString(job_.query_.GetCompression())); | |
213 info_.SetContent("TotalInstances", static_cast<unsigned int>(scheduler.GetInstancesCount())); | |
214 info_.SetContent("TotalSizeMB", ConvertToMegabytes(scheduler.GetTotalSize())); | |
215 } | |
216 | |
217 virtual StateUpdate* Step() | |
218 { | |
219 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
|
220 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
|
221 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
|
222 |
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
|
223 if (!DoPostPeer(answer, job_.peers_, job_.peerIndex_, URI_PUSH, createTransaction_, job_.maxHttpRetries_, headers)) |
0 | 224 { |
225 LOG(ERROR) << "Cannot create a push transaction to peer \"" | |
226 << job_.query_.GetPeer() | |
227 << "\" (check that it has the transfers accelerator plugin installed)"; | |
228 return StateUpdate::Failure(); | |
229 } | |
230 | |
231 if (answer.type() != Json::objectValue || | |
232 !answer.isMember(KEY_PATH) || | |
233 answer[KEY_PATH].type() != Json::stringValue) | |
234 { | |
235 LOG(ERROR) << "Bad network protocol from peer: " << job_.query_.GetPeer(); | |
236 return StateUpdate::Failure(); | |
237 } | |
238 | |
239 std::string transactionUri = answer[KEY_PATH].asString(); | |
240 | |
241 return StateUpdate::Next(new PushBucketsState(job_, info_, transactionUri, buckets_)); | |
242 } | |
243 | |
244 virtual void Stop(OrthancPluginJobStopReason reason) | |
245 { | |
246 } | |
247 }; | |
248 | |
249 | |
250 StatefulOrthancJob::StateUpdate* PushJob::CreateInitialState(JobInfo& info) | |
251 { | |
252 return StateUpdate::Next(new CreateTransactionState(*this, info)); | |
253 } | |
254 | |
255 | |
8
4c3437217518
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
256 PushJob::PushJob(const TransferQuery& query, |
0 | 257 OrthancInstancesCache& cache, |
258 size_t threadsCount, | |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
259 size_t targetBucketSize, |
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
260 unsigned int maxHttpRetries) : |
0 | 261 StatefulOrthancJob(JOB_TYPE_PUSH), |
262 cache_(cache), | |
263 query_(query), | |
264 threadsCount_(threadsCount), | |
10
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
265 targetBucketSize_(targetBucketSize), |
c9e28e31262e
new option: MaxHttpRetries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
9
diff
changeset
|
266 maxHttpRetries_(maxHttpRetries) |
0 | 267 { |
268 if (!peers_.LookupName(peerIndex_, query_.GetPeer())) | |
269 { | |
270 LOG(ERROR) << "Unknown Orthanc peer: " << query_.GetPeer(); | |
271 throw Orthanc::OrthancException(Orthanc::ErrorCode_UnknownResource); | |
272 } | |
273 | |
274 Json::Value serialized; | |
275 query.Serialize(serialized); | |
276 UpdateSerialized(serialized); | |
277 } | |
278 } |