---

CgiEnvironment.h

Go to the documentation of this file.

/* -*-c++-*- */
/*
 *  $Id: CgiEnvironment.h,v 1.12 2002/03/06 02:46:21 sbooth Exp $
 *
 *  Copyright (C) 1996 - 2002 Stephen F. Booth
 *
 *  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.
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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"

CGICC_BEGIN_NAMESPACE

#ifdef WIN32
  template class CGICC_API STDNS vector<HTTPCookie>;
#endif

// ============================================================
// Iterator typedefs
// ============================================================

typedef STDNS vector<HTTPCookie>::iterator      cookie_iterator;
typedef STDNS vector<HTTPCookie>::const_iterator const_cookie_iterator;

// ============================================================
// Class CgiEnvironment
// ============================================================

class CGICC_API CgiEnvironment
{
public:
  
  friend class Cgicc;
    
  // ============================================================


  CgiEnvironment(CgiInput *input);
  
  ~CgiEnvironment();

  // ============================================================


  inline STDNS string 
  getServerSoftware()                           const
    { return fServerSoftware; }
  
  inline STDNS string 
  getServerName()                               const
    { return fServerName; }
  
  inline STDNS string 
  getGatewayInterface()                         const
    { return fGatewayInterface;}
  
  inline STDNS string 
  getServerProtocol()                           const
    { return fServerProtocol; }
  
  inline unsigned long
  getServerPort()                               const
    { return fServerPort; }

  inline bool
  usingHTTPS()                                  const
  { return fUsingHTTPS; }
  
  // ============================================================


  inline STDNS string 
  getCookies()                                  const
    { return fCookie; }
  
  inline const STDNS vector<HTTPCookie>& 
  getCookieList()                               const
    { return fCookies; }
  
  inline STDNS string 
  getRequestMethod()                            const
    { return fRequestMethod; }
  
  inline STDNS string
  getPathInfo()                                 const
    { return fPathInfo; }
  
  inline STDNS string 
  getPathTranslated()                           const
    { return fPathTranslated; }
  
  inline STDNS string 
  getScriptName()                               const
    { return fScriptName; }
  
  inline STDNS string 
  getQueryString()                              const
    { return fQueryString; }
  
  inline unsigned long
  getContentLength()                            const
    { return fContentLength; }
  
  inline STDNS string 
  getContentType()                              const
    { return fContentType; }
  
  inline STDNS string
  getPostData()                                 const
    { return fPostData; }

  // ============================================================
  

  inline STDNS string 
  getReferrer()                                 const
    { return fReferrer; }

  // ============================================================


  inline STDNS string 
  getRemoteHost()                               const
    { return fRemoteHost; }
  
  inline STDNS string 
  getRemoteAddr()                               const
    { return fRemoteAddr; }
  
  inline STDNS string 
  getAuthType()                                 const
    { return fAuthType; }
  
  inline STDNS string 
  getRemoteUser()                               const
    { return fRemoteUser; }
  
  inline STDNS string 
  getRemoteIdent()                              const
    { return fRemoteIdent; }
  
  inline STDNS string 
  getAccept()                                   const
    { return fAccept; }
  
  inline STDNS string 
  getUserAgent()                                const
    { return fUserAgent; }
  
  // ============================================================


  inline STDNS string 
  getRedirectRequest()                          const
    { return fRedirectRequest; }
  
  inline STDNS string 
  getRedirectURL()                              const
    { return fRedirectURL; }
  
  inline STDNS string 
  getRedirectStatus()                           const
    { return fRedirectStatus; }

protected:
  
  // ============================================================


  void 
  save(const STDNS string& filename)            const;
  
  // Implementation of restore
  void 
  restore(const STDNS 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 STDNS string& data);
  
  // Read in all the environment variables
  void 
  readEnvironmentVariables(CgiInput *input);
  
  unsigned long                 fServerPort;
  unsigned long                 fContentLength;
  bool                          fUsingHTTPS;
  STDNS string                  fServerSoftware;
  STDNS string                  fServerName;
  STDNS string                  fGatewayInterface;
  STDNS string                  fServerProtocol;
  STDNS string                  fRequestMethod;
  STDNS string                  fPathInfo;
  STDNS string                  fPathTranslated;
  STDNS string                  fScriptName;
  STDNS string                  fQueryString;
  STDNS string                  fRemoteHost;
  STDNS string                  fRemoteAddr;
  STDNS string                  fAuthType;
  STDNS string                  fRemoteUser;
  STDNS string                  fRemoteIdent;
  STDNS string                  fContentType;
  STDNS string                  fAccept;
  STDNS string                  fUserAgent;
  STDNS string                  fPostData;
  STDNS string                  fRedirectRequest;
  STDNS string                  fRedirectURL;
  STDNS string                  fRedirectStatus;
  STDNS string                  fReferrer;
  STDNS string                  fCookie;
  STDNS vector<HTTPCookie>      fCookies;
};

CGICC_END_NAMESPACE

#endif /* ! _CGIENVIRONMENT_H_ */

---