Mercurial > hg > orthanc-stone
annotate Framework/Loaders/LoaderStateMachine.cpp @ 964:91f827272c1f toa2019082701
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
| author | Benjamin Golinvaux <bgo@osimis.io> |
|---|---|
| date | Tue, 27 Aug 2019 14:28:19 +0200 |
| parents | a7351ad54960 |
| children | 38409549db43 |
| rev | line source |
|---|---|
| 815 | 1 /** |
| 2 * Stone of Orthanc | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2019 Osimis S.A., Belgium | |
| 6 * | |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
| 21 | |
| 22 #include "LoaderStateMachine.h" | |
| 23 | |
| 24 #include <Core/OrthancException.h> | |
| 25 | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
26 #if 0 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
27 extern bool logbgo233; |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
28 extern bool logbgo115; |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
29 #endif |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
30 |
| 815 | 31 namespace OrthancStone |
| 32 { | |
| 33 void LoaderStateMachine::State::Handle(const OrthancRestApiCommand::SuccessMessage& message) | |
| 34 { | |
| 35 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
| 36 } | |
| 37 | |
| 38 | |
| 39 void LoaderStateMachine::State::Handle(const GetOrthancImageCommand::SuccessMessage& message) | |
| 40 { | |
| 41 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
| 42 } | |
| 43 | |
| 44 | |
| 45 void LoaderStateMachine::State::Handle(const GetOrthancWebViewerJpegCommand::SuccessMessage& message) | |
| 46 { | |
| 47 throw Orthanc::OrthancException(Orthanc::ErrorCode_NotImplemented); | |
| 48 } | |
| 49 | |
| 50 | |
| 51 void LoaderStateMachine::Schedule(OracleCommandWithPayload* command) | |
| 52 { | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
53 #if 0 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
54 if (logbgo233) { |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
55 if (logbgo115) |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
56 LOG(TRACE) << " LoaderStateMachine::Schedule()"; |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
57 } |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
58 #endif |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
59 |
| 815 | 60 std::auto_ptr<OracleCommandWithPayload> protection(command); |
| 61 | |
| 62 if (command == NULL) | |
| 63 { | |
| 64 throw Orthanc::OrthancException(Orthanc::ErrorCode_NullPointer); | |
| 65 } | |
| 66 | |
| 67 if (!command->HasPayload()) | |
| 68 { | |
| 69 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange, | |
| 70 "The payload must contain the next state"); | |
| 71 } | |
| 72 | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
73 #if 0 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
74 if (logbgo233) { |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
75 if (logbgo115) |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
76 LOG(TRACE) << " * LoaderStateMachine::Schedule(): adding command with addr: " << std::hex << protection.get() << std::dec << " pendingCommands_.size() is now : " << pendingCommands_.size()+1; |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
77 } |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
78 #endif |
| 815 | 79 pendingCommands_.push_back(protection.release()); |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
80 |
| 815 | 81 Step(); |
| 82 } | |
| 83 | |
| 84 | |
| 85 void LoaderStateMachine::Start() | |
| 86 { | |
| 87 if (active_) | |
| 88 { | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
89 LOG(TRACE) << "LoaderStateMachine::Start() called while active_ is true"; |
| 815 | 90 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
| 91 } | |
| 92 | |
| 93 active_ = true; | |
| 94 | |
| 95 for (size_t i = 0; i < simultaneousDownloads_; i++) | |
| 96 { | |
| 97 Step(); | |
| 98 } | |
| 99 } | |
| 100 | |
| 101 | |
| 102 void LoaderStateMachine::Step() | |
| 103 { | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
104 #if 0 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
105 if (logbgo115) |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
106 LOG(TRACE) << " LoaderStateMachine::Step(): pendingCommands_.size() = " << pendingCommands_.size(); |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
107 #endif |
| 815 | 108 if (!pendingCommands_.empty() && |
| 109 activeCommands_ < simultaneousDownloads_) | |
| 110 { | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
111 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
112 IOracleCommand* nextCommand = pendingCommands_.front(); |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
113 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
114 #if 0 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
115 if (logbgo233) { |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
116 if (logbgo115) |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
117 LOG(TRACE) << " * LoaderStateMachine::Step(): activeCommands_ (" << activeCommands_ << ") < simultaneousDownloads_ (" << simultaneousDownloads_ << ") --> will Schedule command addr " << std::hex << nextCommand << std::dec; |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
118 } |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
119 #endif |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
120 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
121 oracle_.Schedule(*this, nextCommand); |
| 815 | 122 pendingCommands_.pop_front(); |
| 123 | |
| 124 activeCommands_++; | |
| 125 } | |
|
964
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
126 else |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
127 { |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
128 #if 0 |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
129 if (logbgo233) { |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
130 if (logbgo115) |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
131 LOG(TRACE) << " * pendingCommands_.size() == " << pendingCommands_.size() << " LoaderStateMachine::Step(): activeCommands_ (" << activeCommands_ << ") >= simultaneousDownloads_ (" << simultaneousDownloads_ << ") --> will NOT Schedule anything"; |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
132 } |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
133 #endif |
|
91f827272c1f
Added cache-control headers for POST requests + #ifdef'd tracing logs + trace on context restored
Benjamin Golinvaux <bgo@osimis.io>
parents:
956
diff
changeset
|
134 } |
| 815 | 135 } |
| 136 | |
| 137 | |
| 138 void LoaderStateMachine::Clear() | |
| 139 { | |
| 140 for (PendingCommands::iterator it = pendingCommands_.begin(); | |
| 141 it != pendingCommands_.end(); ++it) | |
| 142 { | |
| 143 delete *it; | |
| 144 } | |
| 145 | |
| 146 pendingCommands_.clear(); | |
| 147 } | |
| 148 | |
| 149 | |
| 150 void LoaderStateMachine::HandleExceptionMessage(const OracleCommandExceptionMessage& message) | |
| 151 { | |
|
956
a7351ad54960
Made IsContextLost automatically set the flag by checking with the emscripten
Benjamin Golinvaux <bgo@osimis.io>
parents:
840
diff
changeset
|
152 LOG(ERROR) << "LoaderStateMachine::HandleExceptionMessage: error in the state machine, stopping all processing"; |
|
840
47fc7919977d
Added details on errors in LoaderStateMachine + dummy change in loader.cpp
Benjamin Golinvaux <bgo@osimis.io>
parents:
815
diff
changeset
|
153 LOG(ERROR) << "Error: " << message.GetException().What() << " Details: " << |
|
47fc7919977d
Added details on errors in LoaderStateMachine + dummy change in loader.cpp
Benjamin Golinvaux <bgo@osimis.io>
parents:
815
diff
changeset
|
154 message.GetException().GetDetails(); |
|
47fc7919977d
Added details on errors in LoaderStateMachine + dummy change in loader.cpp
Benjamin Golinvaux <bgo@osimis.io>
parents:
815
diff
changeset
|
155 Clear(); |
| 815 | 156 } |
| 157 | |
| 158 template <typename T> | |
| 159 void LoaderStateMachine::HandleSuccessMessage(const T& message) | |
| 160 { | |
| 161 assert(activeCommands_ > 0); | |
| 162 activeCommands_--; | |
| 163 | |
| 164 try | |
| 165 { | |
| 166 dynamic_cast<State&>(message.GetOrigin().GetPayload()).Handle(message); | |
| 167 Step(); | |
| 168 } | |
| 169 catch (Orthanc::OrthancException& e) | |
| 170 { | |
|
840
47fc7919977d
Added details on errors in LoaderStateMachine + dummy change in loader.cpp
Benjamin Golinvaux <bgo@osimis.io>
parents:
815
diff
changeset
|
171 LOG(ERROR) << "Error in the state machine, stopping all processing: " << |
|
47fc7919977d
Added details on errors in LoaderStateMachine + dummy change in loader.cpp
Benjamin Golinvaux <bgo@osimis.io>
parents:
815
diff
changeset
|
172 e.What() << " Details: " << e.GetDetails(); |
| 815 | 173 Clear(); |
| 174 } | |
| 175 } | |
| 176 | |
| 177 | |
| 178 LoaderStateMachine::LoaderStateMachine(IOracle& oracle, | |
| 179 IObservable& oracleObservable) : | |
| 180 IObserver(oracleObservable.GetBroker()), | |
| 181 oracle_(oracle), | |
| 182 active_(false), | |
| 183 simultaneousDownloads_(4), | |
| 184 activeCommands_(0) | |
| 185 { | |
| 186 oracleObservable.RegisterObserverCallback( | |
| 187 new Callable<LoaderStateMachine, OrthancRestApiCommand::SuccessMessage> | |
| 188 (*this, &LoaderStateMachine::HandleSuccessMessage)); | |
| 189 | |
| 190 oracleObservable.RegisterObserverCallback( | |
| 191 new Callable<LoaderStateMachine, GetOrthancImageCommand::SuccessMessage> | |
| 192 (*this, &LoaderStateMachine::HandleSuccessMessage)); | |
| 193 | |
| 194 oracleObservable.RegisterObserverCallback( | |
| 195 new Callable<LoaderStateMachine, GetOrthancWebViewerJpegCommand::SuccessMessage> | |
| 196 (*this, &LoaderStateMachine::HandleSuccessMessage)); | |
| 197 | |
| 198 oracleObservable.RegisterObserverCallback( | |
| 199 new Callable<LoaderStateMachine, OracleCommandExceptionMessage> | |
| 200 (*this, &LoaderStateMachine::HandleExceptionMessage)); | |
| 201 } | |
| 202 | |
| 203 | |
| 204 void LoaderStateMachine::SetSimultaneousDownloads(unsigned int count) | |
| 205 { | |
| 206 if (active_) | |
| 207 { | |
|
956
a7351ad54960
Made IsContextLost automatically set the flag by checking with the emscripten
Benjamin Golinvaux <bgo@osimis.io>
parents:
840
diff
changeset
|
208 LOG(ERROR) << "LoaderStateMachine::SetSimultaneousDownloads called while active_ is true"; |
| 815 | 209 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
| 210 } | |
| 211 else if (count == 0) | |
| 212 { | |
| 213 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 214 } | |
| 215 else | |
| 216 { | |
| 217 simultaneousDownloads_ = count; | |
| 218 } | |
| 219 } | |
| 220 } |