File: query_params.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 (403 lines) | stat: -rw-r--r-- 11,523 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
/*
 * 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_QUERY_PARAMS_H
#define TNT_QUERY_PARAMS_H

#include <cxxtools/query_params.h>
#include <cxxtools/serializationinfo.h>
#include <cxxtools/serializationerror.h>
#include <tnt/scope.h>
#include <stdexcept>
#include <vector>
#include <sstream>

namespace tnt
{
  class QueryParams;

  /// @cond internal
  namespace qhelper
  {
    ////////////////////////////////////////////////////////////////////////
    // generic helper functions
    //
    template <typename Type>
    class QArg
    {
      public:
        static Type get(const QueryParams& q, const std::string& name, const Type& def = Type());
        static std::vector<Type> getvector(const QueryParams& q, const std::string& name);
    };

    ////////////////////////////////////////////////////////////////////////
    // specialization for std::string
    //
    template <>
    class QArg<std::string>
    {
      public:
        static std::string get(const QueryParams& q, const std::string& name, const std::string& def = std::string());
        static std::vector<std::string> getvector(const QueryParams& q, const std::string& name);
    };

    ////////////////////////////////////////////////////////////////////////
    // specialization for char
    //
    template <>
    class QArg<char>
    {
      public:
        static char get(const QueryParams& q, const std::string& name, char def = '\0');
        static std::vector<char> getvector(const QueryParams& q, const std::string& name);
    };

    ////////////////////////////////////////////////////////////////////////
    // specialization for bool
    //
    template <>
    class QArg<bool>
    {
      public:
        static bool get(const QueryParams& q, const std::string& name);
        static bool get(const QueryParams& q, const std::string& name, bool def);
    };

    template <typename Type>
    class QAdd
    {
      public:
        static void add(QueryParams& q, const std::string& name, const Type& value);
    };

    template <>
    class QAdd<std::string>
    {
      public:
        static void add(QueryParams& q, const std::string& name, const std::string& value);
    };

    template <>
    class QAdd<char>
    {
      public:
        static void add(QueryParams& q, const std::string& name, char value);
    };

    template <>
    class QAdd<bool>
    {
      public:
        static void add(QueryParams& q, const std::string& name, bool value);
    };

  }
  /// @endcond internal

  /// Container for GET and POST parameters
  class QueryParams : public cxxtools::QueryParams
  {
      template <typename T> friend class qhelper::QAdd;

      Scope* _paramScope;
      mutable cxxtools::SerializationInfo _si;
      mutable bool _siInit;

    public:
      /// Create an empty %QueryParams object
      QueryParams()
        : _paramScope(0),
          _siInit(false)
        { }

      QueryParams(const QueryParams& src)
        : cxxtools::QueryParams(src),
          _paramScope(src._paramScope),
          _siInit(false)
        {
          if (_paramScope)
            _paramScope->addRef();
        }

      explicit QueryParams(const std::string& url)
        : cxxtools::QueryParams(url),
          _paramScope(0),
          _siInit(false)
        { }

      QueryParams& operator= (const QueryParams& src)
      {
        if (this == &src)
          return *this;

        cxxtools::QueryParams::operator=(src);
        if (_paramScope != src._paramScope)
        {
          if (_paramScope->release() == 0)
            delete _paramScope;
          _paramScope = src._paramScope;
          if (_paramScope)
            _paramScope->addRef();
        }

        _siInit = false;

        return *this;
      }

      ~QueryParams()
      {
        if (_paramScope && _paramScope->release() == 0)
          delete _paramScope;
      }

      void clear()
      {
        cxxtools::QueryParams::clear();
        _si.clear();
        _siInit = false;
      }

      cxxtools::SerializationInfo& si()
      {
        if (!_siInit)
        {
          _si <<= *this;
          _siInit = true;
        }
        return _si;
      }

      const cxxtools::SerializationInfo& si() const
      {
        if (!_siInit)
        {
          _si <<= *this;
          _siInit = true;
        }
        return _si;
      }

      Scope& getScope()
      {
        if (!_paramScope)
          _paramScope = new Scope();
        return *_paramScope;
      }

      /// Get parameter with name `name` if available. Returns `def` if not found.
      /// For string type the value is returned.
      /// Boolean returns `true` if it is found, `false` otherwise.
      /// Other types are converted using the cxxtools serialization framework.
      template <typename Type>
      Type get(const std::string& name, const Type& def) const
        { return qhelper::QArg<Type>::get(*this, name, def); }

      /// Get parameter with name `name` if available. Returns default value if not found.
      /// For string type the value is returned.
      /// Boolean returns `true` if it is found, `false` otherwise.
      /// Other types are converted using the cxxtools serialization framework.
      template <typename Type>
      Type get(const std::string& name) const
        { return qhelper::QArg<Type>::get(*this, name); }

      /// alias for `get`
      /// @deprecated
      template <typename Type>
      Type arg(const std::string& name, const Type& def) const
        { return qhelper::QArg<Type>::get(*this, name, def); }

      /// alias for `get`
      /// @deprecated
      template <typename Type>
      Type arg(const std::string& name) const
        { return qhelper::QArg<Type>::get(*this, name); }

      template <typename Type>
      std::vector<Type> getvector(const std::string& name) const
        { return qhelper::QArg<Type>::getvector(*this, name); }

      /// alias for `getvector`
      /// @deprecated
      template <typename Type>
      std::vector<Type> args(const std::string& name) const
        { return qhelper::QArg<Type>::getvector(*this, name); }


      template <typename Type>
      QueryParams& add(const std::string& name, const Type& value)
        { qhelper::QAdd<Type>::add(*this, name, value); return *this; }

      QueryParams& add(const std::string& name, const char* value)
      {
        cxxtools::QueryParams::add(name, value);
        return *this;
      }

      QueryParams& add(const cxxtools::QueryParams& q)
      {
        cxxtools::QueryParams::add(q);
        return *this;
      }
  };

  namespace qhelper
  {
    ////////////////////////////////////////////////////////////////////////
    // generic helper functions
    //
    template <typename Type>
    Type QArg<Type>::get(const QueryParams& q, const std::string& name, const Type& def)
    {
      const cxxtools::SerializationInfo* pi;
      try
      {
        pi = &q.si().getMember(name);
      }
      catch (const cxxtools::SerializationMemberNotFound&)
      {
        return def;
      }

      Type ret;
      *pi >>= ret;
      return ret;
    }

    template <typename Type>
    std::vector<Type> QArg<Type>::getvector(const QueryParams& q, const std::string& name)
    {
      std::vector<Type> ret;

      const cxxtools::SerializationInfo* pi;
      try
      {
        pi = &q.si().getMember(name);
      }
      catch (const cxxtools::SerializationMemberNotFound&)
      {
        return ret;
      }

      *pi >>= ret;
      return ret;
    }


    ////////////////////////////////////////////////////////////////////////
    // specialization for std::string
    //
    inline std::string QArg<std::string>::get(const QueryParams& q, const std::string& name, const std::string& def)
    {
      return q.param(name, def);
    }

    inline std::vector<std::string> QArg<std::string>::getvector(const QueryParams& q, const std::string& name)
    {
      return std::vector<std::string>(q.begin(name + "[]"), q.end());
    }


    ////////////////////////////////////////////////////////////////////////
    // specialization for char
    //
    inline char QArg<char>::get(const QueryParams& q, const std::string& name, char def)
    {
      std::string p = q.param(name);
      return p.empty() ? def : p[0];
    }

    inline std::vector<char> QArg<char>::getvector(const QueryParams& q, const std::string& name)
    {
      std::vector<char> ret;
      for (QueryParams::const_iterator it = q.begin(name + "[]"); it != q.end(); ++it)
        ret.push_back(it->empty() ? '\0' : (*it)[0]);
      return ret;
    }


    ////////////////////////////////////////////////////////////////////////
    // specialization for bool
    //
    inline bool QArg<bool>::get(const QueryParams& q, const std::string& name)
    {
      return !q.param(name).empty();
    }

    inline bool QArg<bool>::get(const QueryParams& q, const std::string& name, bool def)
    {
      try
      {
        bool ret;
        q.si().getMember(name) >>= ret;
        return ret;
      }
      catch (const cxxtools::SerializationMemberNotFound&)
      {
        return def;
      }
    }

    ////////////////////////////////////////////////////////////////////////

    template <typename Type>
    void QAdd<Type>::add(QueryParams& q, const std::string& name, const Type& value)
    {
      std::ostringstream s;
      s << value;
      static_cast<cxxtools::QueryParams&>(q).add(name, s.str());
      q._si.clear();
      q._siInit = false;
    }

    inline void QAdd<std::string>::add(QueryParams& q, const std::string& name, const std::string& value)
    {
      static_cast<cxxtools::QueryParams&>(q).add(name, value);
      q._si.clear();
      q._siInit = false;
    }

    inline void QAdd<char>::add(QueryParams& q, const std::string& name, char value)
    {
      static_cast<cxxtools::QueryParams&>(q).add(name, std::string(1, value));
      q._si.clear();
      q._siInit = false;
    }

    inline void QAdd<bool>::add(QueryParams& q, const std::string& name, bool value)
    {
      static_cast<cxxtools::QueryParams&>(q).add(name, value ? std::string(1, '1') : std::string());
      q._si.clear();
      q._siInit = false;
    }
  }
}

#endif // TNT_QUERY_PARAMS_H