view Core/HttpServer/HttpOutput.cpp @ 2766:20c2c6fdfe6e templating

close old branch
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 17 Jul 2018 09:42:52 +0200
parents 306afd58a0b3
children 8d1845feb277
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 "../PrecompiledHeaders.h"
#include "HttpOutput.h"

#include <iostream>
#include <vector>
#include <stdio.h>
#include <boost/lexical_cast.hpp>
#include "../OrthancException.h"
#include "../Toolbox.h"

namespace Orthanc
{
  void HttpOutput::StateMachine::SendHttpStatus(HttpStatus status)
  {
    if (state_ != State_WaitingHttpStatus)
    {
      throw OrthancException(ErrorCode_BadSequenceOfCalls);
    }

    stream_.OnHttpStatusReceived(status);
    state_ = State_WritingHeader;

    std::string s = "HTTP/1.1 " + 
      boost::lexical_cast<std::string>(status) +
      " " + std::string(EnumerationToString(status)) +
      "\r\n";

    stream_.Send(true, &s[0], s.size());
  }

  void HttpOutput::StateMachine::SendHeaderData(const void* buffer, size_t length)
  {
    if (state_ != State_WritingHeader)
    {
      throw OrthancException(ErrorCode_BadSequenceOfCalls);
    }

    stream_.Send(true, buffer, length);
  }

  void HttpOutput::StateMachine::SendHeaderString(const std::string& str)
  {
    if (str.size() > 0)
    {
      SendHeaderData(&str[0], str.size());
    }
  }

  void HttpOutput::StateMachine::SendBodyData(const void* buffer, size_t length)
  {
    if (state_ == State_WaitingHttpStatus)
    {
      throw OrthancException(ErrorCode_BadSequenceOfCalls);
    }

    if (state_ == State_WritingHeader)
    {
      // Close the HTTP header before writing the body
      stream_.Send(true, "\r\n", 2);
      state_ = State_WritingBody;
    }

    if (length > 0)
    {
      stream_.Send(false, buffer, length);
    }
  }

  void HttpOutput::StateMachine::SendBodyString(const std::string& str)
  {
    if (str.size() > 0)
    {
      SendBodyData(&str[0], str.size());
    }
  }


  void HttpOutput::PrepareOkHeader(Header& header,
                                   const char* contentType,
                                   bool hasContentLength,
                                   uint64_t contentLength,
                                   const char* contentFilename)
  {
    header.clear();

    if (contentType && contentType[0] != '\0')
    {
      header.push_back(std::make_pair("Content-Type", std::string(contentType)));
    }

    if (hasContentLength)
    {
      header.push_back(std::make_pair("Content-Length", boost::lexical_cast<std::string>(contentLength)));
    }

    if (contentFilename && contentFilename[0] != '\0')
    {
      std::string attachment = "attachment; filename=\"" + std::string(contentFilename) + "\"";
      header.push_back(std::make_pair("Content-Disposition", attachment));
    }
  }

  void HttpOutput::SendOkHeader(const char* contentType,
                                bool hasContentLength,
                                uint64_t contentLength,
                                const char* contentFilename)
  {
    Header header;
    PrepareOkHeader(header, contentType, hasContentLength, contentLength, contentFilename);
    SendOkHeader(header);
  }

  void HttpOutput::SendOkHeader(const Header& header)
  {
    stateMachine_.SendHttpStatus(HttpStatus_200_Ok);

    std::string s;
    for (Header::const_iterator 
           it = header.begin(); it != header.end(); ++it)
    {
      s += it->first + ": " + it->second + "\r\n";
    }

    stateMachine_.SendHeaderString(s);
  }


  void HttpOutput::SendMethodNotAllowedError(const std::string& allowed)
  {
    stateMachine_.SendHttpStatus(HttpStatus_405_MethodNotAllowed);
    stateMachine_.SendHeaderString("Allow: " + allowed + "\r\n");
  }


  void HttpOutput::SendHeader(HttpStatus status)
  {
    if (status == HttpStatus_200_Ok ||
        status == HttpStatus_301_MovedPermanently ||
        status == HttpStatus_401_Unauthorized ||
        status == HttpStatus_405_MethodNotAllowed)
    {
      throw OrthancException("Please use the dedicated methods to this HTTP status code in HttpOutput");
    }
    
    stateMachine_.SendHttpStatus(status);
  }


  void HttpOutput::AnswerBufferWithContentType(const std::string& buffer,
                                               const std::string& contentType)
  {
    SendOkHeader(contentType.c_str(), true, buffer.size(), NULL);
    SendBodyString(buffer);
  }


  void HttpOutput::PrepareCookies(Header& header,
                                  const HttpHandler::Arguments& cookies)
  {
    for (HttpHandler::Arguments::const_iterator it = cookies.begin();
         it != cookies.end(); ++it)
    {
      header.push_back(std::make_pair("Set-Cookie", it->first + "=" + it->second));
    }
  }


  void HttpOutput::AnswerBufferWithContentType(const std::string& buffer,
                                               const std::string& contentType,
                                               const HttpHandler::Arguments& cookies)
  {
    Header header;
    PrepareOkHeader(header, contentType.c_str(), true, buffer.size(), NULL);
    PrepareCookies(header, cookies);
    SendOkHeader(header);
    SendBodyString(buffer);
  }


  void HttpOutput::AnswerBufferWithContentType(const void* buffer,
                                               size_t size,
                                               const std::string& contentType)
  {
    SendOkHeader(contentType.c_str(), true, size, NULL);
    SendBodyData(buffer, size);
  }


  void HttpOutput::AnswerBufferWithContentType(const void* buffer,
                                               size_t size,
                                               const std::string& contentType,
                                               const HttpHandler::Arguments& cookies)
  {
    Header header;
    PrepareOkHeader(header, contentType.c_str(), true, size, NULL);
    PrepareCookies(header, cookies);
    SendOkHeader(header);
    SendBodyData(buffer, size);
  }


  void HttpOutput::Redirect(const std::string& path)
  {
    stateMachine_.SendHttpStatus(HttpStatus_301_MovedPermanently);
    stateMachine_.SendHeaderString("Location: " + path + "\r\n");
  }


  void HttpOutput::SendUnauthorized(const std::string& realm)
  {
    stateMachine_.SendHttpStatus(HttpStatus_401_Unauthorized);
    stateMachine_.SendHeaderString("WWW-Authenticate: Basic realm=\"" + realm + "\"\r\n");
  }

}