Mercurial > hg > orthanc
view OrthancServer/OrthancInitialization.cpp @ 905:89e3cc078df0 plugins
sample plugin configuration
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 19 Jun 2014 11:40:05 +0200 |
parents | 03ea55da7429 |
children | b3f6fb1130cd |
line wrap: on
line source
/** * Orthanc - A Lightweight, RESTful DICOM Store * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, * 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 "PrecompiledHeadersServer.h" #include "OrthancInitialization.h" #include "../Core/HttpClient.h" #include "../Core/OrthancException.h" #include "../Core/Toolbox.h" #include "DicomProtocol/DicomServer.h" #include "ServerEnumerations.h" #include <boost/lexical_cast.hpp> #include <boost/filesystem.hpp> #include <curl/curl.h> #include <boost/thread.hpp> #include <glog/logging.h> #if ORTHANC_JPEG_ENABLED == 1 #include <dcmtk/dcmjpeg/djdecode.h> #endif #if ORTHANC_JPEG_LOSSLESS_ENABLED == 1 #include <dcmtk/dcmjpls/djdecode.h> #endif namespace Orthanc { static boost::mutex globalMutex_; static std::auto_ptr<Json::Value> configuration_; static boost::filesystem::path defaultDirectory_; static void ReadGlobalConfiguration(const char* configurationFile) { configuration_.reset(new Json::Value); std::string content; if (configurationFile) { Toolbox::ReadFile(content, configurationFile); defaultDirectory_ = boost::filesystem::path(configurationFile).parent_path(); LOG(WARNING) << "Using the configuration from: " << configurationFile; } else { #if ORTHANC_STANDALONE == 1 // No default path for the standalone configuration LOG(WARNING) << "Using the default Orthanc configuration"; return; #else // In a non-standalone build, we use the // "Resources/Configuration.json" from the Orthanc source code try { boost::filesystem::path p = ORTHANC_PATH; p /= "Resources"; p /= "Configuration.json"; Toolbox::ReadFile(content, p.string()); LOG(WARNING) << "Using the configuration from: " << p.string(); } catch (OrthancException&) { // No configuration file found, give up with empty configuration LOG(WARNING) << "Using the default Orthanc configuration"; return; } #endif } Json::Reader reader; if (!reader.parse(content, *configuration_)) { throw OrthancException("Unable to read the configuration file"); } } static void RegisterUserMetadata() { if (configuration_->isMember("UserMetadata")) { const Json::Value& parameter = (*configuration_) ["UserMetadata"]; Json::Value::Members members = parameter.getMemberNames(); for (size_t i = 0; i < members.size(); i++) { std::string info = "\"" + members[i] + "\" = " + parameter[members[i]].toStyledString(); LOG(INFO) << "Registering user-defined metadata: " << info; if (!parameter[members[i]].asBool()) { LOG(ERROR) << "Not a number in this user-defined metadata: " << info; throw OrthancException(ErrorCode_BadParameterType); } int metadata = parameter[members[i]].asInt(); try { RegisterUserMetadata(metadata, members[i]); } catch (OrthancException&) { LOG(ERROR) << "Cannot register this user-defined metadata: " << info; throw; } } } } static void RegisterUserContentType() { if (configuration_->isMember("UserContentType")) { const Json::Value& parameter = (*configuration_) ["UserContentType"]; Json::Value::Members members = parameter.getMemberNames(); for (size_t i = 0; i < members.size(); i++) { std::string info = "\"" + members[i] + "\" = " + parameter[members[i]].toStyledString(); LOG(INFO) << "Registering user-defined attachment type: " << info; if (!parameter[members[i]].asBool()) { LOG(ERROR) << "Not a number in this user-defined attachment type: " << info; throw OrthancException(ErrorCode_BadParameterType); } int contentType = parameter[members[i]].asInt(); try { RegisterUserContentType(contentType, members[i]); } catch (OrthancException&) { LOG(ERROR) << "Cannot register this user-defined attachment type: " << info; throw; } } } } void OrthancInitialize(const char* configurationFile) { boost::mutex::scoped_lock lock(globalMutex_); InitializeServerEnumerations(); defaultDirectory_ = boost::filesystem::current_path(); ReadGlobalConfiguration(configurationFile); HttpClient::GlobalInitialize(); RegisterUserMetadata(); RegisterUserContentType(); DicomServer::InitializeDictionary(); #if ORTHANC_JPEG_LOSSLESS_ENABLED == 1 LOG(WARNING) << "Registering JPEG Lossless codecs"; DJLSDecoderRegistration::registerCodecs(); #endif #if ORTHANC_JPEG_ENABLED == 1 LOG(WARNING) << "Registering JPEG codecs"; DJDecoderRegistration::registerCodecs(); #endif } void OrthancFinalize() { boost::mutex::scoped_lock lock(globalMutex_); HttpClient::GlobalFinalize(); configuration_.reset(NULL); #if ORTHANC_JPEG_LOSSLESS_ENABLED == 1 // Unregister JPEG-LS codecs DJLSDecoderRegistration::cleanup(); #endif #if ORTHANC_JPEG_ENABLED == 1 // Unregister JPEG codecs DJDecoderRegistration::cleanup(); #endif } std::string Configuration::GetGlobalStringParameter(const std::string& parameter, const std::string& defaultValue) { boost::mutex::scoped_lock lock(globalMutex_); if (configuration_->isMember(parameter)) { return (*configuration_) [parameter].asString(); } else { return defaultValue; } } int Configuration::GetGlobalIntegerParameter(const std::string& parameter, int defaultValue) { boost::mutex::scoped_lock lock(globalMutex_); if (configuration_->isMember(parameter)) { return (*configuration_) [parameter].asInt(); } else { return defaultValue; } } bool Configuration::GetGlobalBoolParameter(const std::string& parameter, bool defaultValue) { boost::mutex::scoped_lock lock(globalMutex_); if (configuration_->isMember(parameter)) { return (*configuration_) [parameter].asBool(); } else { return defaultValue; } } void Configuration::GetDicomModalityUsingSymbolicName(RemoteModalityParameters& modality, const std::string& name) { boost::mutex::scoped_lock lock(globalMutex_); if (!configuration_->isMember("DicomModalities")) { throw OrthancException(ErrorCode_BadFileFormat); } const Json::Value& modalities = (*configuration_) ["DicomModalities"]; if (modalities.type() != Json::objectValue || !modalities.isMember(name)) { throw OrthancException(ErrorCode_BadFileFormat); } try { modality.FromJson(modalities[name]); } catch (OrthancException& e) { LOG(ERROR) << "Syntax error in the definition of modality \"" << name << "\". Please check your configuration file."; throw e; } } void Configuration::GetOrthancPeer(OrthancPeerParameters& peer, const std::string& name) { boost::mutex::scoped_lock lock(globalMutex_); if (!configuration_->isMember("OrthancPeers")) { throw OrthancException(ErrorCode_BadFileFormat); } try { const Json::Value& modalities = (*configuration_) ["OrthancPeers"]; if (modalities.type() != Json::objectValue || !modalities.isMember(name)) { throw OrthancException(ErrorCode_BadFileFormat); } peer.FromJson(modalities[name]); } catch (OrthancException& e) { LOG(ERROR) << "Syntax error in the definition of peer \"" << name << "\". Please check your configuration file."; throw e; } } static bool ReadKeys(std::set<std::string>& target, const char* parameter, bool onlyAlphanumeric) { boost::mutex::scoped_lock lock(globalMutex_); target.clear(); if (!configuration_->isMember(parameter)) { return true; } const Json::Value& modalities = (*configuration_) [parameter]; if (modalities.type() != Json::objectValue) { throw OrthancException(ErrorCode_BadFileFormat); } Json::Value::Members members = modalities.getMemberNames(); for (size_t i = 0; i < members.size(); i++) { if (onlyAlphanumeric) { for (size_t j = 0; j < members[i].size(); j++) { if (!isalnum(members[i][j]) && members[i][j] != '-') { return false; } } } target.insert(members[i]); } return true; } void Configuration::GetListOfDicomModalities(std::set<std::string>& target) { if (!ReadKeys(target, "DicomModalities", true)) { throw OrthancException("Only alphanumeric and dash characters are allowed in the names of the modalities"); } } void Configuration::GetListOfOrthancPeers(std::set<std::string>& target) { if (!ReadKeys(target, "OrthancPeers", true)) { throw OrthancException("Only alphanumeric and dash characters are allowed in the names of Orthanc peers"); } } void Configuration::SetupRegisteredUsers(MongooseServer& httpServer) { boost::mutex::scoped_lock lock(globalMutex_); httpServer.ClearUsers(); if (!configuration_->isMember("RegisteredUsers")) { return; } const Json::Value& users = (*configuration_) ["RegisteredUsers"]; if (users.type() != Json::objectValue) { throw OrthancException("Badly formatted list of users"); } Json::Value::Members usernames = users.getMemberNames(); for (size_t i = 0; i < usernames.size(); i++) { const std::string& username = usernames[i]; std::string password = users[username].asString(); httpServer.RegisterUser(username.c_str(), password.c_str()); } } std::string Configuration::InterpretRelativePath(const std::string& baseDirectory, const std::string& relativePath) { boost::filesystem::path base(baseDirectory); boost::filesystem::path relative(relativePath); /** The following lines should be equivalent to this one: return (base / relative).string(); However, for some unknown reason, some versions of Boost do not make the proper path resolution when "baseDirectory" is an absolute path. So, a hack is used below. **/ if (relative.is_absolute()) { return relative.string(); } else { return (base / relative).string(); } } std::string Configuration::InterpretStringParameterAsPath(const std::string& parameter) { boost::mutex::scoped_lock lock(globalMutex_); return InterpretRelativePath(defaultDirectory_.string(), parameter); } void Configuration::GetGlobalListOfStringsParameter(std::list<std::string>& target, const std::string& key) { boost::mutex::scoped_lock lock(globalMutex_); target.clear(); if (!configuration_->isMember(key)) { return; } const Json::Value& lst = (*configuration_) [key]; if (lst.type() != Json::arrayValue) { throw OrthancException("Badly formatted list of strings"); } for (Json::Value::ArrayIndex i = 0; i < lst.size(); i++) { target.push_back(lst[i].asString()); } } bool Configuration::IsSameAETitle(const std::string& aet1, const std::string& aet2) { if (GetGlobalBoolParameter("StrictAetComparison", false)) { // Case-sensitive matching return aet1 == aet2; } else { // Case-insensitive matching (default) std::string tmp1, tmp2; Toolbox::ToLowerCase(tmp1, aet1); Toolbox::ToLowerCase(tmp2, aet2); return tmp1 == tmp2; } } bool Configuration::LookupDicomModalityUsingAETitle(RemoteModalityParameters& modality, const std::string& aet) { std::set<std::string> modalities; GetListOfDicomModalities(modalities); for (std::set<std::string>::const_iterator it = modalities.begin(); it != modalities.end(); ++it) { try { GetDicomModalityUsingSymbolicName(modality, *it); if (IsSameAETitle(aet, modality.GetApplicationEntityTitle())) { return true; } } catch (OrthancException&) { } } return false; } bool Configuration::IsKnownAETitle(const std::string& aet) { RemoteModalityParameters modality; return LookupDicomModalityUsingAETitle(modality, aet); } RemoteModalityParameters Configuration::GetModalityUsingSymbolicName(const std::string& name) { RemoteModalityParameters modality; GetDicomModalityUsingSymbolicName(modality, name); return modality; } RemoteModalityParameters Configuration::GetModalityUsingAet(const std::string& aet) { RemoteModalityParameters modality; if (LookupDicomModalityUsingAETitle(modality, aet)) { return modality; } else { throw OrthancException("Unknown modality for AET: " + aet); } } void Configuration::UpdateModality(const std::string& symbolicName, const RemoteModalityParameters& modality) { boost::mutex::scoped_lock lock(globalMutex_); if (!configuration_->isMember("DicomModalities")) { (*configuration_) ["DicomModalities"] = Json::objectValue; } Json::Value& modalities = (*configuration_) ["DicomModalities"]; if (modalities.type() != Json::objectValue) { throw OrthancException(ErrorCode_BadFileFormat); } modalities.removeMember(symbolicName); Json::Value v; modality.ToJson(v); modalities[symbolicName] = v; } void Configuration::RemoveModality(const std::string& symbolicName) { boost::mutex::scoped_lock lock(globalMutex_); if (!configuration_->isMember("DicomModalities")) { throw OrthancException(ErrorCode_BadFileFormat); } Json::Value& modalities = (*configuration_) ["DicomModalities"]; if (modalities.type() != Json::objectValue) { throw OrthancException(ErrorCode_BadFileFormat); } modalities.removeMember(symbolicName.c_str()); } void Configuration::UpdatePeer(const std::string& symbolicName, const OrthancPeerParameters& peer) { boost::mutex::scoped_lock lock(globalMutex_); if (!configuration_->isMember("OrthancPeers")) { (*configuration_) ["OrthancPeers"] = Json::objectValue; } Json::Value& peers = (*configuration_) ["OrthancPeers"]; if (peers.type() != Json::objectValue) { throw OrthancException(ErrorCode_BadFileFormat); } peers.removeMember(symbolicName); Json::Value v; peer.ToJson(v); peers[symbolicName] = v; } void Configuration::RemovePeer(const std::string& symbolicName) { boost::mutex::scoped_lock lock(globalMutex_); if (!configuration_->isMember("OrthancPeers")) { throw OrthancException(ErrorCode_BadFileFormat); } Json::Value& peers = (*configuration_) ["OrthancPeers"]; if (peers.type() != Json::objectValue) { throw OrthancException(ErrorCode_BadFileFormat); } peers.removeMember(symbolicName.c_str()); } }