# HG changeset patch # User Sebastien Jodogne # Date 1447834530 -3600 # Node ID dbb07eb1a2f33450664b5afe7c43ebc0151cb365 # Parent 9f2df9bb2cdfa18b85f5f843dbe329df1dca24c4 reorganization diff -r 9f2df9bb2cdf -r dbb07eb1a2f3 CMakeLists.txt --- a/CMakeLists.txt Wed Nov 18 09:05:43 2015 +0100 +++ b/CMakeLists.txt Wed Nov 18 09:15:30 2015 +0100 @@ -110,6 +110,7 @@ Core/HttpServer/MongooseServer.cpp Core/HttpServer/HttpFileSender.cpp Core/HttpServer/FilesystemHttpSender.cpp + Core/HttpServer/HttpContentNegociation.cpp Core/HttpServer/HttpStreamTranscoder.cpp Core/Logging.cpp Core/RestApi/RestApiCall.cpp diff -r 9f2df9bb2cdf -r dbb07eb1a2f3 Core/HttpServer/HttpContentNegociation.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Core/HttpServer/HttpContentNegociation.cpp Wed Nov 18 09:15:30 2015 +0100 @@ -0,0 +1,265 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics + * Department, University Hospital 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 . + **/ + + +#include "../PrecompiledHeaders.h" +#include "HttpContentNegociation.h" + +#include "../Logging.h" +#include "../OrthancException.h" +#include "../Toolbox.h" + +#include + +namespace Orthanc +{ + HttpContentNegociation::Handler::Handler(const std::string& type, + const std::string& subtype, + IHandler& handler) : + type_(type), + subtype_(subtype), + handler_(handler) + { + } + + + bool HttpContentNegociation::Handler::IsMatch(const std::string& type, + const std::string& subtype) const + { + if (type == "*" && subtype == "*") + { + return true; + } + + if (subtype == "*" && type == type_) + { + return true; + } + + return type == type_ && subtype == subtype_; + } + + + struct HttpContentNegociation::Reference : public boost::noncopyable + { + const Handler& handler_; + uint8_t level_; + float quality_; + + Reference(const Handler& handler, + const std::string& type, + const std::string& subtype, + float quality) : + handler_(handler), + quality_(quality) + { + if (type == "*" && subtype == "*") + { + level_ = 0; + } + else if (subtype == "*") + { + level_ = 1; + } + else + { + level_ = 2; + } + } + + bool operator< (const Reference& other) const + { + if (level_ < other.level_) + { + return true; + } + + if (level_ > other.level_) + { + return false; + } + + return quality_ < other.quality_; + } + }; + + + bool HttpContentNegociation::SplitPair(std::string& first /* out */, + std::string& second /* out */, + const std::string& source, + char separator) + { + size_t pos = source.find(separator); + + if (pos == std::string::npos) + { + return false; + } + else + { + first = Toolbox::StripSpaces(source.substr(0, pos)); + second = Toolbox::StripSpaces(source.substr(pos + 1)); + return true; + } + } + + + float HttpContentNegociation::GetQuality(const Tokens& parameters) + { + for (size_t i = 1; i < parameters.size(); i++) + { + std::string key, value; + if (SplitPair(key, value, parameters[i], '=') && + key == "q") + { + float quality; + bool ok = false; + + try + { + quality = boost::lexical_cast(value); + ok = (quality >= 0.0f && quality <= 1.0f); + } + catch (boost::bad_lexical_cast&) + { + } + + if (ok) + { + return quality; + } + else + { + LOG(ERROR) << "Quality parameter out of range in a HTTP request (must be between 0 and 1): " << value; + throw OrthancException(ErrorCode_BadRequest); + } + } + } + + return 1.0f; // Default quality + } + + + void HttpContentNegociation::SelectBestMatch(std::auto_ptr& best, + const Handler& handler, + const std::string& type, + const std::string& subtype, + float quality) + { + std::auto_ptr match(new Reference(handler, type, subtype, quality)); + + if (best.get() == NULL || + *best < *match) + { + best = match; + } + } + + + void HttpContentNegociation::Register(const std::string& mime, + IHandler& handler) + { + std::string type, subtype; + + if (SplitPair(type, subtype, mime, '/') && + type != "*" && + subtype != "*") + { + handlers_.push_back(Handler(type, subtype, handler)); + } + else + { + throw OrthancException(ErrorCode_ParameterOutOfRange); + } + } + + + bool HttpContentNegociation::Apply(const HttpHeaders& headers) + { + HttpHeaders::const_iterator accept = headers.find("accept"); + if (accept != headers.end()) + { + return Apply(accept->second); + } + else + { + return Apply("*/*"); + } + } + + + bool HttpContentNegociation::Apply(const std::string& accept) + { + // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1 + // https://en.wikipedia.org/wiki/Content_negotiation + // http://www.newmediacampaigns.com/blog/browser-rest-http-accept-headers + + Tokens mediaRanges; + Toolbox::TokenizeString(mediaRanges, accept, ','); + + std::auto_ptr bestMatch; + + for (Tokens::const_iterator it = mediaRanges.begin(); + it != mediaRanges.end(); ++it) + { + Tokens parameters; + Toolbox::TokenizeString(parameters, *it, ';'); + + if (parameters.size() > 0) + { + float quality = GetQuality(parameters); + + std::string type, subtype; + if (SplitPair(type, subtype, parameters[0], '/')) + { + for (Handlers::const_iterator it2 = handlers_.begin(); + it2 != handlers_.end(); ++it2) + { + if (it2->IsMatch(type, subtype)) + { + SelectBestMatch(bestMatch, *it2, type, subtype, quality); + } + } + } + } + } + + if (bestMatch.get() == NULL) // No match was found + { + return false; + } + else + { + bestMatch->handler_.Call(); + return true; + } + } +} diff -r 9f2df9bb2cdf -r dbb07eb1a2f3 Core/HttpServer/HttpContentNegociation.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Core/HttpServer/HttpContentNegociation.h Wed Nov 18 09:15:30 2015 +0100 @@ -0,0 +1,111 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics + * Department, University Hospital 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 . + **/ + +#pragma once + +#include +#include +#include +#include +#include +#include +#include + + +namespace Orthanc +{ + class HttpContentNegociation : public boost::noncopyable + { + public: + typedef std::map HttpHeaders; + + class IHandler : public boost::noncopyable + { + public: + virtual ~IHandler() + { + } + + virtual void Handle(const std::string& type, + const std::string& subtype) = 0; + }; + + private: + struct Handler + { + std::string type_; + std::string subtype_; + IHandler& handler_; + + Handler(const std::string& type, + const std::string& subtype, + IHandler& handler); + + bool IsMatch(const std::string& type, + const std::string& subtype) const; + + void Call() const + { + handler_.Handle(type_, subtype_); + } + }; + + + struct Reference; + + typedef std::vector Tokens; + typedef std::list Handlers; + + Handlers handlers_; + + + static bool SplitPair(std::string& first /* out */, + std::string& second /* out */, + const std::string& source, + char separator); + + static float GetQuality(const Tokens& parameters); + + static void SelectBestMatch(std::auto_ptr& best, + const Handler& handler, + const std::string& type, + const std::string& subtype, + float quality); + + public: + void Register(const std::string& mime, + IHandler& handler); + + bool Apply(const HttpHeaders& headers); + + bool Apply(const std::string& accept); + }; +} diff -r 9f2df9bb2cdf -r dbb07eb1a2f3 UnitTestsSources/RestApiTests.cpp --- a/UnitTestsSources/RestApiTests.cpp Wed Nov 18 09:05:43 2015 +0100 +++ b/UnitTestsSources/RestApiTests.cpp Wed Nov 18 09:15:30 2015 +0100 @@ -45,6 +45,7 @@ #include "../Core/OrthancException.h" #include "../Core/Compression/ZlibCompressor.h" #include "../Core/RestApi/RestApiHierarchy.h" +#include "../Core/HttpServer/HttpContentNegociation.h" using namespace Orthanc; @@ -341,268 +342,6 @@ -namespace Orthanc -{ - class HttpContentNegociation : public boost::noncopyable - { - public: - typedef std::map HttpHeaders; - - class IHandler : public boost::noncopyable - { - public: - virtual ~IHandler() - { - } - - virtual void Handle(const std::string& type, - const std::string& subtype) = 0; - }; - - private: - struct Handler - { - std::string type_; - std::string subtype_; - IHandler& handler_; - - Handler(const std::string& type, - const std::string& subtype, - IHandler& handler) : - type_(type), - subtype_(subtype), - handler_(handler) - { - } - - bool IsMatch(const std::string& type, - const std::string& subtype) const - { - if (type == "*" && subtype == "*") - { - return true; - } - - if (subtype == "*" && type == type_) - { - return true; - } - - return type == type_ && subtype == subtype_; - } - - void Call() const - { - handler_.Handle(type_, subtype_); - } - }; - - - struct Reference : public boost::noncopyable - { - const Handler& handler_; - uint8_t level_; - float quality_; - - Reference(const Handler& handler, - const std::string& type, - const std::string& subtype, - float quality) : - handler_(handler), - quality_(quality) - { - if (type == "*" && subtype == "*") - { - level_ = 0; - } - else if (subtype == "*") - { - level_ = 1; - } - else - { - level_ = 2; - } - } - - bool operator< (const Reference& other) const - { - if (level_ < other.level_) - { - return true; - } - - if (level_ > other.level_) - { - return false; - } - - return quality_ < other.quality_; - } - }; - - - typedef std::vector Tokens; - typedef std::list Handlers; - - Handlers handlers_; - - - static bool SplitPair(std::string& first /* out */, - std::string& second /* out */, - const std::string& source, - char separator) - { - size_t pos = source.find(separator); - - if (pos == std::string::npos) - { - return false; - } - else - { - first = Toolbox::StripSpaces(source.substr(0, pos)); - second = Toolbox::StripSpaces(source.substr(pos + 1)); - return true; - } - } - - - static float GetQuality(const Tokens& parameters) - { - for (size_t i = 1; i < parameters.size(); i++) - { - std::string key, value; - if (SplitPair(key, value, parameters[i], '=') && - key == "q") - { - float quality; - bool ok = false; - - try - { - quality = boost::lexical_cast(value); - ok = (quality >= 0.0f && quality <= 1.0f); - } - catch (boost::bad_lexical_cast&) - { - } - - if (ok) - { - return quality; - } - else - { - LOG(ERROR) << "Quality parameter out of range in a HTTP request (must be between 0 and 1): " << value; - throw OrthancException(ErrorCode_BadRequest); - } - } - } - - return 1.0f; // Default quality - } - - - static void SelectBestMatch(std::auto_ptr& best, - const Handler& handler, - const std::string& type, - const std::string& subtype, - float quality) - { - std::auto_ptr match(new Reference(handler, type, subtype, quality)); - - if (best.get() == NULL || - *best < *match) - { - best = match; - } - } - - - public: - void Register(const std::string& mime, - IHandler& handler) - { - std::string type, subtype; - - if (SplitPair(type, subtype, mime, '/') && - type != "*" && - subtype != "*") - { - handlers_.push_back(Handler(type, subtype, handler)); - } - else - { - throw OrthancException(ErrorCode_ParameterOutOfRange); - } - } - - - bool Apply(const HttpHeaders& headers) - { - HttpHeaders::const_iterator accept = headers.find("accept"); - if (accept != headers.end()) - { - return Apply(accept->second); - } - else - { - return Apply("*/*"); - } - } - - - bool Apply(const std::string& accept) - { - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1 - // https://en.wikipedia.org/wiki/Content_negotiation - // http://www.newmediacampaigns.com/blog/browser-rest-http-accept-headers - - Tokens mediaRanges; - Toolbox::TokenizeString(mediaRanges, accept, ','); - - std::auto_ptr bestMatch; - - for (Tokens::const_iterator it = mediaRanges.begin(); - it != mediaRanges.end(); ++it) - { - Tokens parameters; - Toolbox::TokenizeString(parameters, *it, ';'); - - if (parameters.size() > 0) - { - float quality = GetQuality(parameters); - - std::string type, subtype; - if (SplitPair(type, subtype, parameters[0], '/')) - { - for (Handlers::const_iterator it2 = handlers_.begin(); - it2 != handlers_.end(); ++it2) - { - if (it2->IsMatch(type, subtype)) - { - SelectBestMatch(bestMatch, *it2, type, subtype, quality); - } - } - } - } - } - - if (bestMatch.get() == NULL) // No match was found - { - return false; - } - else - { - bestMatch->handler_.Call(); - return true; - } - } - }; -} - - namespace {