Mercurial > hg > orthanc
diff OrthancServer/Plugins/Engine/PluginsErrorDictionary.cpp @ 4044:d25f4c0fa160 framework
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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OrthancServer/Plugins/Engine/PluginsErrorDictionary.cpp Wed Jun 10 20:30:34 2020 +0200 @@ -0,0 +1,139 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics + * Department, University Hospital of Liege, Belgium + * Copyright (C) 2017-2020 Osimis S.A., Belgium + * + * This program is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * In addition, as a special exception, the copyright holders of this + * program give permission to link the code of its release with the + * OpenSSL project's "OpenSSL" library (or with modified versions of it + * that use the same license as the "OpenSSL" library), and distribute + * the linked executables. You must obey the GNU General Public License + * in all respects for all of the code used other than "OpenSSL". If you + * modify file(s) with this exception, you may extend this exception to + * your version of the file(s), but you are not obligated to do so. If + * you do not wish to do so, delete this exception statement from your + * version. If you delete this exception statement from all source files + * in the program, then also delete it here. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + **/ + + +#include "../../OrthancServer/PrecompiledHeadersServer.h" +#include "PluginsErrorDictionary.h" + +#if ORTHANC_ENABLE_PLUGINS != 1 +#error The plugin support is disabled +#endif + + + +#include "PluginsEnumerations.h" +#include "PluginsManager.h" +#include "../../Core/Logging.h" + +#include <memory> + + +namespace Orthanc +{ + PluginsErrorDictionary::PluginsErrorDictionary() : + pos_(ErrorCode_START_PLUGINS) + { + } + + + PluginsErrorDictionary::~PluginsErrorDictionary() + { + for (Errors::iterator it = errors_.begin(); it != errors_.end(); ++it) + { + delete it->second; + } + } + + + OrthancPluginErrorCode PluginsErrorDictionary::Register(SharedLibrary& library, + int32_t pluginCode, + uint16_t httpStatus, + const char* message) + { + std::unique_ptr<Error> error(new Error); + + error->pluginName_ = PluginsManager::GetPluginName(library); + error->pluginCode_ = pluginCode; + error->message_ = message; + error->httpStatus_ = static_cast<HttpStatus>(httpStatus); + + OrthancPluginErrorCode code; + + { + boost::mutex::scoped_lock lock(mutex_); + errors_[pos_] = error.release(); + code = static_cast<OrthancPluginErrorCode>(pos_); + pos_ += 1; + } + + return code; + } + + + void PluginsErrorDictionary::LogError(ErrorCode code, + bool ignoreBuiltinErrors) + { + if (code >= ErrorCode_START_PLUGINS) + { + boost::mutex::scoped_lock lock(mutex_); + Errors::const_iterator error = errors_.find(static_cast<int32_t>(code)); + + if (error != errors_.end()) + { + LOG(ERROR) << "Error code " << error->second->pluginCode_ + << " inside plugin \"" << error->second->pluginName_ + << "\": " << error->second->message_; + return; + } + } + + if (!ignoreBuiltinErrors) + { + LOG(ERROR) << "Exception inside the plugin engine: " + << EnumerationToString(code); + } + } + + + bool PluginsErrorDictionary::Format(Json::Value& message, /* out */ + HttpStatus& httpStatus, /* out */ + const OrthancException& exception) + { + if (exception.GetErrorCode() >= ErrorCode_START_PLUGINS) + { + boost::mutex::scoped_lock lock(mutex_); + Errors::const_iterator error = errors_.find(static_cast<int32_t>(exception.GetErrorCode())); + + if (error != errors_.end()) + { + httpStatus = error->second->httpStatus_; + message["PluginName"] = error->second->pluginName_; + message["PluginCode"] = error->second->pluginCode_; + message["Message"] = error->second->message_; + + return true; + } + } + + return false; + } +}