Cgicc.h

Go to the documentation of this file.

/* -*-mode:c++; c-file-style: "gnu";-*- */
/*
 *  $Id: Cgicc.h,v 1.19 2009/01/03 17:12:07 sebdiaz Exp $
 *
 *  Copyright (C) 1996 - 2004 Stephen F. Booth <sbooth@gnu.org>
 *                       2007 Sebastien DIAZ <sebastien.diaz@gmail.com>
 *  Part of the GNU cgicc library, http://www.gnu.org/software/cgicc
 *
 *  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 3 of the License, or (at your option) any later version.
 *
 *  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, USA
 */

#ifndef _CGICC_H_
#define _CGICC_H_ 1

#ifdef __GNUG__
#  pragma interface
#endif

/*
 * The GNU cgicc library, by Stephen F. Booth <sbooth@gnu.org>
 * http://www.cgicc.org
 *
 * The latest version can be found on your closest GNU mirror site.
 * Please mail bug reports to <bug-cgicc@gnu.org>
 */

#include <vector>
#include <string>

#include "cgicc/CgiDefs.h"
#include "cgicc/FormEntry.h"
#include "cgicc/FormFile.h"
#include "cgicc/CgiInput.h"
#include "cgicc/CgiEnvironment.h"

namespace cgicc {
  
#ifdef WIN32
  template class CGICC_API std::vector<FormEntry>;
  template class CGICC_API std::vector<FormFile>;
#endif
  
  class MultipartHeader;
  
  // ============================================================
  // Iterator typedefs
  // ============================================================
  
  typedef std::vector<FormEntry>::iterator      form_iterator;
  typedef std::vector<FormEntry>::const_iterator const_form_iterator;
  
  typedef std::vector<FormFile>::iterator       file_iterator;
  typedef std::vector<FormFile>::const_iterator const_file_iterator;
  
  // ============================================================
  // Class Cgicc
  // ============================================================
  
  class CGICC_API Cgicc {
  public:
    
    // ============================================================
    
    
    Cgicc(CgiInput *input = 0);
    
    inline
    Cgicc(const Cgicc& cgi)
      : fEnvironment(cgi.fEnvironment)
    { operator=(cgi); }

    ~Cgicc();
    
    // ============================================================
    
    
    inline bool 
    operator== (const Cgicc& cgi)               const
    { return this->fEnvironment == cgi.fEnvironment; }
    
    inline bool
    operator!= (const Cgicc& cgi)               const
    { return ! operator==(cgi); }
    
#ifdef WIN32
    /* Dummy operator for MSVC++ */
    inline bool
    operator< (const Cgicc& cgi)                const
    { return false; }
#endif
    
    Cgicc& 
    operator= (const Cgicc& cgi);

    // ============================================================
    
    
    const char*
    getCompileDate()                                    const;
    
    const char*
    getCompileTime()                                    const;
    
    const char*
    getVersion()                                        const;
    
    const char*
    getHost()                                           const;
    
    // ============================================================
    
    
    bool 
    queryCheckbox(const std::string& elementName)       const;
    
    inline form_iterator 
    operator[] (const std::string& name)
    { return getElement(name); }

    std::string
    operator() (const std::string& name)                const;
    
    inline const_form_iterator 
    operator[] (const std::string& name)                const
    { return getElement(name); }
    
    form_iterator 
    getElement(const std::string& name);
    
    const_form_iterator 
    getElement(const std::string& name)                 const;
    
    bool 
    getElement(const std::string& name,
               std::vector<FormEntry>& result)          const;
    
    form_iterator 
    getElementByValue(const std::string& value);
    
    const_form_iterator 
    getElementByValue(const std::string& value)         const;
    
    bool 
    getElementByValue(const std::string& value,
                      std::vector<FormEntry>& result)   const;
    
    inline const std::vector<FormEntry>& 
    operator* ()                                        const
    { return fFormData; }
    
    inline const std::vector<FormEntry>&
    getElements()                                       const
    { return fFormData; }
    
    // ============================================================
    
    
    file_iterator 
    getFile(const std::string& name);
    
    const_file_iterator 
    getFile(const std::string& name)                    const;
    
    inline const std::vector<FormFile>&
    getFiles()                                          const
    { return fFormFiles; }
    
    // ============================================================
    
    
    inline const CgiEnvironment&
    getEnvironment()                                    const
    { return fEnvironment;}
    
    // ============================================================
    
    
    void 
    save(const std::string& filename)                   const;
    
    void 
    restore(const std::string& filename);
    
  private:
    CgiEnvironment              fEnvironment;
    std::vector<FormEntry>      fFormData;
    std::vector<FormFile>       fFormFiles;

    // Convert query string into a list of FormEntries
    void 
    parseFormInput(const std::string& data, const std::string& content_type = "application/x-www-form-urlencoded");
    
    // Parse a multipart/form-data header
    MultipartHeader
    parseHeader(const std::string& data);
    
    // Parse a (name=value) form entry
    void 
    parsePair(const std::string& data);
    
    // Parse a MIME entry for ENCTYPE=""
    void
    parseMIME(const std::string& data);
    
    // Find elements in the list of entries
    bool 
    findEntries(const std::string& param, 
                bool byName,
                std::vector<FormEntry>& result)         const;
  };
  
} // namespace cgicc

#endif /* ! _CGICC_H_ */