view OrthancFramework/Sources/HttpServer/HttpToolbox.h @ 4290:fa5c5d3c8e75

improving manpage
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 05 Nov 2020 07:21:43 +0100
parents bf7b9edf6b81
children 83c5bd439fcc
line wrap: on
line source

/**
 * 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 Lesser General Public License
 * as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "../OrthancFramework.h"
#include "IHttpHandler.h"

namespace Orthanc
{
  class ORTHANC_PUBLIC HttpToolbox : public boost::noncopyable
  {
  public:
    static void ParseGetArguments(IHttpHandler::GetArguments& result, 
                                  const char* query);

    static void ParseGetQuery(UriComponents& uri,
                              IHttpHandler::GetArguments& getArguments, 
                              const char* query);

    static std::string GetArgument(const IHttpHandler::Arguments& getArguments,
                                   const std::string& name,
                                   const std::string& defaultValue);

    static std::string GetArgument(const IHttpHandler::GetArguments& getArguments,
                                   const std::string& name,
                                   const std::string& defaultValue);

    static void ParseCookies(IHttpHandler::Arguments& result, 
                             const IHttpHandler::Arguments& httpHeaders);

    static void CompileGetArguments(IHttpHandler::Arguments& compiled,
                                    const IHttpHandler::GetArguments& source);

    static bool SimpleGet(std::string& result,
                          IHttpHandler& handler,
                          RequestOrigin origin,
                          const std::string& uri,
                          const IHttpHandler::Arguments& httpHeaders);

    static bool SimplePost(std::string& result,
                           IHttpHandler& handler,
                           RequestOrigin origin,
                           const std::string& uri,
                           const void* bodyData,
                           size_t bodySize,
                          const IHttpHandler::Arguments& httpHeaders);

    static bool SimplePut(std::string& result,
                          IHttpHandler& handler,
                          RequestOrigin origin,
                          const std::string& uri,
                          const void* bodyData,
                          size_t bodySize,
                          const IHttpHandler::Arguments& httpHeaders);

    static bool SimpleDelete(IHttpHandler& handler,
                             RequestOrigin origin,
                             const std::string& uri,
                             const IHttpHandler::Arguments& httpHeaders);
  };
}