shibsp/util/CGIParser.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/util/CGIParser.h
  19  *
  20  * CGI GET/POST parameter parsing
  21  */
  22
  23 #ifndef __shibsp_cgi_h__
  24 #define __shibsp_cgi_h__
  25
  26 #include <shibsp/base.h>
  27 #include <xmltooling/io/HTTPRequest.h>
  28
  29 namespace shibsp {
  30
  31 #if defined (_MSC_VER)
  32     #pragma warning( push )
  33     #pragma warning( disable : 4251 )
  34 #endif
  35
  36     /**
  37      * CGI GET/POST parameter parsing
  38      */
  39     class SHIBSP_API CGIParser
  40     {
  41         MAKE_NONCOPYABLE(CGIParser);
  42     public:
  43         /**
  44          * Constructor
  45          *
  46          * @param request   HTTP request interface
  47          */
  48         CGIParser(const xmltooling::HTTPRequest& request);
  49
  50         ~CGIParser();
  51
  52         /** Alias for multimap iterator. */
  53         typedef std::multimap<std::string,char*>::const_iterator walker;
  54
  55         /**
  56          * Returns a pair of bounded iterators around the values of a parameter.
  57          *
  58          * @param name  name of parameter, or NULL to return all parameters
  59          * @return  a pair of multimap iterators surrounding the matching value(s)
  60          */
  61         std::pair<walker,walker> getParameters(const char* name) const;
  62
  63     private:
  64         char* fmakeword(char stop, size_t *cl, const char** ppch);
  65         char* makeword(char *line, char stop);
  66         void plustospace(char *str);
  67
  68         std::multimap<std::string,char*> kvp_map;
  69     };
  70
  71 #if defined (_MSC_VER)
  72     #pragma warning( pop )
  73 #endif
  74
  75 };
  76
  77 #endif /* __shibsp_cgi_h__ */