shibsp/util/CGIParser.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file shibsp/util/CGIParser.h
  23  *
  24  * CGI GET/POST parameter parsing.
  25  */
  26
  27 #ifndef __shibsp_cgi_h__
  28 #define __shibsp_cgi_h__
  29
  30 #include <shibsp/base.h>
  31
  32 #include <map>
  33 #include <string>
  34
  35 namespace xmltooling {
  36     class XMLTOOL_API HTTPRequest;
  37 };
  38
  39 namespace shibsp {
  40
  41 #if defined (_MSC_VER)
  42     #pragma warning( push )
  43     #pragma warning( disable : 4251 )
  44 #endif
  45
  46     /**
  47      * CGI GET/POST parameter parsing
  48      */
  49     class SHIBSP_API CGIParser
  50     {
  51         MAKE_NONCOPYABLE(CGIParser);
  52     public:
  53         /**
  54          * Constructor.
  55          *
  56          * @param request   HTTP request interface
  57          * @param queryOnly true iff the POST body should be ignored
  58          */
  59         CGIParser(const xmltooling::HTTPRequest& request, bool queryOnly=false);
  60
  61         ~CGIParser();
  62
  63         /** Alias for multimap iterator. */
  64         typedef std::multimap<std::string,char*>::const_iterator walker;
  65
  66         /**
  67          * Returns a pair of bounded iterators around the values of a parameter.
  68          *
  69          * @param name  name of parameter, or nullptr to return all parameters
  70          * @return  a pair of multimap iterators surrounding the matching value(s)
  71          */
  72         std::pair<walker,walker> getParameters(const char* name) const;
  73
  74     private:
  75         void parse(const char* pch);
  76         std::multimap<std::string,char*> kvp_map;
  77     };
  78
  79 #if defined (_MSC_VER)
  80     #pragma warning( pop )
  81 #endif
  82
  83 };
  84
  85 #endif /* __shibsp_cgi_h__ */