Server/include/plaqui/server/httprequest.h

   1 // vim: set noexpandtab tabstop=4 shiftwidth=4:
   2 //----------------------------------------------------------------------------
   3 //                                  PlaQui
   4 //----------------------------------------------------------------------------
   5 // This file is part of PlaQui.
   6 //
   7 // PlaQui is free software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the Free Software
   9 // Foundation; either version 2 of the License, or (at your option) any later
  10 // version.
  11 //
  12 // PlaQui is distributed in the hope that it will be useful, but WITHOUT ANY
  13 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15 // details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with PlaQui; if not, write to the Free Software Foundation, Inc., 59 Temple
  19 // Place, Suite 330, Boston, MA  02111-1307  USA
  20 //----------------------------------------------------------------------------
  21 // Creado:  dom oct 26 18:54:30 ART 2003
  22 // Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23 //----------------------------------------------------------------------------
  24 //
  25 // $Id$
  26 //
  27
  28 #ifndef PLAQUI_HTTPREQUEST_H
  29 #define PLAQUI_HTTPREQUEST_H
  30
  31 #include "plaqui/server/httperror.h"
  32 #include "plaqui/server/httpmessage.h"
  33 #include <string>
  34 #include <istream>
  35 #include <ostream>
  36
  37 namespace PlaQui {
  38
  39 namespace Server {
  40
  41         /// Pedido HTTP.
  42         class HTTPRequest: public HTTPMessage {
  43
  44                 // Constantes.
  45
  46                 protected:
  47
  48                         /// Caracteres dígitos para URIs (RFC 2396).
  49                         static const std::string CHARS_DIGIT;
  50
  51                         /// Caracteres alfabéticos en minúsculas para URIs (RFC 2396).
  52                         static const std::string CHARS_LOWALPHA;
  53
  54                         /// Caracteres alfabéticos en mayúsculas para URIs (RFC 2396).
  55                         static const std::string CHARS_UPALPHA;
  56
  57                         /// Caracteres alfabéticos para URIs (RFC 2396).
  58                         static const std::string CHARS_ALPHA;
  59
  60                         /// Caracteres alfabnuméricos para URIs (RFC 2396).
  61                         static const std::string CHARS_ALPHANUM;
  62
  63                         /// Caracteres reservados para URIs (RFC 2396).
  64                         static const std::string CHARS_RESERVED;
  65
  66                         /// Caracteres de marca para URIs (RFC 2396).
  67                         static const std::string CHARS_MARK;
  68
  69                         /// Caracteres no reservados para URIs (RFC 2396).
  70                         static const std::string CHARS_UNRESERVED;
  71
  72                         /// Caracteres no hexa para URIs (RFC 2396).
  73                         static const std::string CHARS_HEX;
  74
  75                 // Tipos.
  76
  77                 public:
  78
  79                         /// Tipo de métodos HTTP reconocidos.
  80                         typedef enum {GET, POST} HTTPMethod;
  81
  82                 // Atributos.
  83
  84                 protected: // TODO hacer privados con get() y set() ???
  85
  86                 public:
  87
  88                         /// Método HTTP.
  89                         /// @todo TODO - convertirlo a string? Hace todo más fácil (y más ineficiente :)
  90                         HTTPMethod method;
  91
  92                         /// URI.
  93                         std::string uri;
  94
  95                         /// Query string.
  96                         std::string query;
  97
  98                 // Métodos.
  99
 100                 public:
 101
 102                         /**
 103                          * Destructor.
 104                          */
 105                         virtual ~HTTPRequest(void);
 106
 107                         /**
 108                          * Constructor.
 109                          */
 110                         HTTPRequest(const std::string& uri = "/",
 111                                         const HTTPMethod& method = GET,
 112                                         const std::string& query = "",
 113                                         const std::string& body = "",
 114                                         const std::string& version = "1.1");
 115
 116                         /**
 117                          * Obtiene el método como un string.
 118                          */
 119                         std::string method_str(void) const;
 120
 121                         /**
 122                          * Obtiene los datos del pedido HTTP desde un texto.
 123                          */
 124                         friend std::istream& operator>>(std::istream& is, HTTPRequest& req)
 125                                 throw(HTTPError, std::ios::failure);
 126
 127                         /**
 128                          * Convierte el pedido HTTP en texto.
 129                          */
 130                         friend std::ostream& operator<<(std::ostream& os,
 131                                         const HTTPRequest& req);
 132
 133         };
 134
 135 }
 136
 137 }
 138
 139 #endif // PLAQUI_HTTPREQUEST_H