Mercurial > hg > orthanc

comparison OrthancServer/Plugins/Engine/PluginsErrorDictionary.cpp @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Plugins/Engine/PluginsErrorDictionary.cpp@2a170a8f1faf
children 05b8fd21089c
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 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 General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #include "../../OrthancServer/PrecompiledHeadersServer.h"
35 #include "PluginsErrorDictionary.h"
36
37 #if ORTHANC_ENABLE_PLUGINS != 1
38 #error The plugin support is disabled
39 #endif
40
41
42
43 #include "PluginsEnumerations.h"
44 #include "PluginsManager.h"
45 #include "../../Core/Logging.h"
46
47 #include <memory>
48
49
50 namespace Orthanc
51 {
52 PluginsErrorDictionary::PluginsErrorDictionary() :
53 pos_(ErrorCode_START_PLUGINS)
54 {
55 }
56
57
58 PluginsErrorDictionary::~PluginsErrorDictionary()
59 {
60 for (Errors::iterator it = errors_.begin(); it != errors_.end(); ++it)
61 {
62 delete it->second;
63 }
64 }
65
66
67 OrthancPluginErrorCode PluginsErrorDictionary::Register(SharedLibrary& library,
68 int32_t pluginCode,
69 uint16_t httpStatus,
70 const char* message)
71 {
72 std::unique_ptr<Error> error(new Error);
73
74 error->pluginName_ = PluginsManager::GetPluginName(library);
75 error->pluginCode_ = pluginCode;
76 error->message_ = message;
77 error->httpStatus_ = static_cast<HttpStatus>(httpStatus);
78
79 OrthancPluginErrorCode code;
80
81 {
82 boost::mutex::scoped_lock lock(mutex_);
83 errors_[pos_] = error.release();
84 code = static_cast<OrthancPluginErrorCode>(pos_);
85 pos_ += 1;
86 }
87
88 return code;
89 }
90
91
92 void PluginsErrorDictionary::LogError(ErrorCode code,
93 bool ignoreBuiltinErrors)
94 {
95 if (code >= ErrorCode_START_PLUGINS)
96 {
97 boost::mutex::scoped_lock lock(mutex_);
98 Errors::const_iterator error = errors_.find(static_cast<int32_t>(code));
99
100 if (error != errors_.end())
101 {
102 LOG(ERROR) << "Error code " << error->second->pluginCode_
103 << " inside plugin \"" << error->second->pluginName_
104 << "\": " << error->second->message_;
105 return;
106 }
107 }
108
109 if (!ignoreBuiltinErrors)
110 {
111 LOG(ERROR) << "Exception inside the plugin engine: "
112 << EnumerationToString(code);
113 }
114 }
115
116
117 bool PluginsErrorDictionary::Format(Json::Value& message, /* out */
118 HttpStatus& httpStatus, /* out */
119 const OrthancException& exception)
120 {
121 if (exception.GetErrorCode() >= ErrorCode_START_PLUGINS)
122 {
123 boost::mutex::scoped_lock lock(mutex_);
124 Errors::const_iterator error = errors_.find(static_cast<int32_t>(exception.GetErrorCode()));
125
126 if (error != errors_.end())
127 {
128 httpStatus = error->second->httpStatus_;
129 message["PluginName"] = error->second->pluginName_;
130 message["PluginCode"] = error->second->pluginCode_;
131 message["Message"] = error->second->message_;
132
133 return true;
134 }
135 }
136
137 return false;
138 }
139 }