CgiEnvironment.h

Go to the documentation of this file.

/* -*-mode:c++; c-file-style: "gnu";-*- */
/*
 *  $Id: CgiEnvironment_8h-source.html,v 1.3 2008/01/19 21:53:39 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 _CGIENVIRONMENT_H_
#define _CGIENVIRONMENT_H_ 1

#ifdef __GNUG__
#  pragma interface
#endif

#include <string>
#include <vector>
#include <cstdlib>

#include "cgicc/CgiDefs.h"
#include "cgicc/CgiUtils.h"
#include "cgicc/CgiInput.h"
#include "cgicc/HTTPCookie.h"

namespace cgicc {

#ifdef WIN32
  template class CGICC_API std::vector<HTTPCookie>;
#endif
  
  // ============================================================
  // Iterator typedefs
  // ============================================================
  
  typedef std::vector<HTTPCookie>::iterator     cookie_iterator;
  typedef std::vector<HTTPCookie>::const_iterator const_cookie_iterator;
  
  // ============================================================
  // Class CgiEnvironment
  // ============================================================
  
  class CGICC_API CgiEnvironment
  {
  public:
    
    friend class Cgicc;
    
    // ============================================================
    
    
    CgiEnvironment(CgiInput *input);
    
    inline
    CgiEnvironment(const CgiEnvironment& env)
    { operator=(env); }

    ~CgiEnvironment();
    
    // ============================================================
    
    
    bool 
    operator== (const CgiEnvironment& env)              const;
    
    inline bool
    operator!= (const CgiEnvironment& env)              const
    { return ! operator==(env); }
    
#ifdef WIN32
    /* Dummy operator for MSVC++ */
    inline bool
    operator< (const CgiEnvironment& env)               const
    { return false; }
#endif
    
    CgiEnvironment& 
    operator= (const CgiEnvironment& env);

    // ============================================================
    
    
    inline std::string 
    getServerSoftware()                         const
    { return fServerSoftware; }
    
    inline std::string 
    getServerName()                             const
    { return fServerName; }
    
    inline std::string 
    getGatewayInterface()                       const
    { return fGatewayInterface;}
    
    inline std::string 
    getServerProtocol()                         const
    { return fServerProtocol; }
    
    inline unsigned long
    getServerPort()                             const
    { return fServerPort; }
    
    inline bool
    usingHTTPS()                                const
    { return fUsingHTTPS; }
    
    // ============================================================
    
    
    inline std::string 
    getCookies()                                const
    { return fCookie; }
    
    inline const std::vector<HTTPCookie>& 
    getCookieList()                             const
    { return fCookies; }
    
    inline std::string 
    getRequestMethod()                          const
    { return fRequestMethod; }
    
    inline std::string
    getPathInfo()                               const
    { return fPathInfo; }
    
    inline std::string 
    getPathTranslated()                         const
    { return fPathTranslated; }
    
    inline std::string 
    getScriptName()                             const
    { return fScriptName; }
    
    inline std::string 
    getQueryString()                            const
    { return fQueryString; }
    
    inline unsigned long
    getContentLength()                          const
    { return fContentLength; }
    
    inline std::string 
    getContentType()                            const
    { return fContentType; }
    
    inline std::string
    getPostData()                               const
    { return fPostData; }
    
    // ============================================================
    
    
    inline std::string 
    getReferrer()                               const
    { return fReferrer; }
    
    // ============================================================
    
    
    inline std::string 
    getRemoteHost()                             const
    { return fRemoteHost; }
    
    inline std::string 
    getRemoteAddr()                             const
    { return fRemoteAddr; }
    
    inline std::string 
    getAuthType()                               const
    { return fAuthType; }
    
    inline std::string 
    getRemoteUser()                             const
    { return fRemoteUser; }
    
    inline std::string 
    getRemoteIdent()                            const
    { return fRemoteIdent; }
    
    inline std::string 
    getAccept()                                 const
    { return fAccept; }
    
    inline std::string 
    getUserAgent()                              const
    { return fUserAgent; }
    
    // ============================================================
    
    
    inline std::string 
    getRedirectRequest()                        const
    { return fRedirectRequest; }
    
    inline std::string 
    getRedirectURL()                            const
    { return fRedirectURL; }
    
    inline std::string 
    getRedirectStatus()                         const
    { return fRedirectStatus; }
    
  protected:
    
    // ============================================================
    
    
    void 
    save(const std::string& filename)           const;
    
    // Implementation of restore
    void 
    restore(const std::string& filename);
    
    // ============================================================
    
  private:
    
    // Parse the list of cookies from a string to a vector
    void 
    parseCookies();
    
    // Parse a single cookie string (name=value) pair
    void
    parseCookie(const std::string& data);
    
    // Read in all the environment variables
    void 
    readEnvironmentVariables(CgiInput *input);
    
    unsigned long               fServerPort;
    unsigned long               fContentLength;
    bool                        fUsingHTTPS;
    std::string                 fServerSoftware;
    std::string                 fServerName;
    std::string                 fGatewayInterface;
    std::string                 fServerProtocol;
    std::string                 fRequestMethod;
    std::string                 fPathInfo;
    std::string                 fPathTranslated;
    std::string                 fScriptName;
    std::string                 fQueryString;
    std::string                 fRemoteHost;
    std::string                 fRemoteAddr;
    std::string                 fAuthType;
    std::string                 fRemoteUser;
    std::string                 fRemoteIdent;
    std::string                 fContentType;
    std::string                 fAccept;
    std::string                 fUserAgent;
    std::string                 fPostData;
    std::string                 fRedirectRequest;
    std::string                 fRedirectURL;
    std::string                 fRedirectStatus;
    std::string                 fReferrer;
    std::string                 fCookie;
    std::vector<HTTPCookie>     fCookies;
  };
  
} // namespace cgicc

#endif /* ! _CGIENVIRONMENT_H_ */

---