File: httpmessage.h

package info (click to toggle)
tntnet 3.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,488 kB
  • sloc: cpp: 16,636; javascript: 8,109; ansic: 2,189; makefile: 861; sh: 317; xml: 258; perl: 159; sql: 14
file content (138 lines) | stat: -rw-r--r-- 4,751 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Copyright (C) 2003-2005 Tommi Maekitalo
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */


#ifndef TNT_HTTPMESSAGE_H
#define TNT_HTTPMESSAGE_H

#include <tnt/messageheader.h>
#include <tnt/httpheader.h>
#include <tnt/cookie.h>
#include <time.h>

namespace tnt
{
  /// Base class for HTTP messages
  class HttpMessage
  {
    public:
      typedef Messageheader header_type;

    private:
      unsigned short _majorVersion;
      unsigned short _minorVersion;

    protected:
      header_type header;
      Cookies httpcookies;

    public:
      HttpMessage()
        : _majorVersion(1),
          _minorVersion(0)
        { }
      virtual ~HttpMessage()
        { }

      /// Remove all request-specific content
      virtual void clear();

      /// @{
      /// Check whether the message has the specified header
      bool hasHeader(const char* key) const        { return header.hasHeader(key); }
      bool hasHeader(const std::string& key) const { return header.hasHeader(key); }
      /// @}

      /// Get the content of the specified header if it is set,
      /// the passed default otherwise
      const char* getHeader(const char* key, const char* def = "") const;

      /// Get the major http version number
      unsigned short getMajorVersion() const
        { return _majorVersion; }

      /// Get the minor http version number
      unsigned short getMinorVersion() const
        { return _minorVersion; }

      /// Set the http version number
      void setVersion(unsigned short majorVersion, unsigned short minorVersion)
        { _majorVersion = majorVersion; _minorVersion = minorVersion; }

      /** Get a constant iterator which points to the first header

          The value type of the iterator is std::pair<std::string, std::string>
       */
      header_type::const_iterator header_begin() const
        { return header.begin(); }

      /// Get a constant iterator which points past the last header
      header_type::const_iterator header_end() const
        { return header.end(); }

      /// Add the specified header to the message
      void setHeader(const std::string& key, const std::string& value, bool replace = true)
        { header.setHeader(key, value, replace); }

      /// Remove the specified header from the message
      void removeHeader(const std::string& key)
        { header.removeHeader(key); }

      /// Get all headers in one string
      std::string dumpHeader() const;

      /// Print all headers to the specified output stream
      void dumpHeader(std::ostream& out) const;

      /// @{
      /// Get a date string, formatted as needed in http
      static std::string htdate(time_t t);
      static std::string htdate(const struct ::tm* tm);

      // date buffer must be at least 30 bytes long
      static void htdate(char* date, time_t t);
      static void htdate(char* date, const struct ::tm* tm);
      /// @}

      /// Get a string for the current time, formatted as needed in http
      static std::string htdateCurrent();
      /// Get a string for the current time, formatted as needed in http
      /// buffer must point to at least 30 bytes
      static void htdateCurrent(char* current);

      // TODO: Documentation revision: Is this meant to check for absolute URLs?
      /** Check for double-dot-url

          @return false if the url used as a filename would escape from the basedir
       */
      static bool checkUrl(const std::string& url);
  };
}

#endif // TNT_HTTPMESSAGE_H