cgiEnvironment Class Reference
#include <cgiClass.h>
Public Member Functions | |
| cgiEnvironment (const char *uploadPath=NULL) | |
| ~cgiEnvironment () | |
| aString & | ContentLength (void) |
| cgiEnvironment & setUploadPath( string path ); sets the path for uploaded files. | |
| aString & | ContentType (void) |
| aString & ContentType(void); Indicates the MIME type of user supplied info. | |
| aString & | GatewayInterface (void) |
| aString & GatewayInterface(void); Indicates the name of the gateway interface. | |
| aString & | HttpAccept (void) |
| aString & HttpAccept(void); Provides a list of browser acceptible mime types. | |
| aString & | HttpUserAgent (void) |
| aString & HttpUserAgent(void); Indicates the name of the browser. | |
| aString & | HttpReferer (void) |
| aString & HttpReferer(void); Indicates the refering page. | |
| aString & | PathInfo (void) |
| aString & PathInfo(void); holds additional path passed beyond this cgi location. | |
| aString & | PathTranslated (void) |
| aString & | QueryString (void) |
| aString & QueryString(void); The user passed info, used only if the method is GET.<d/d> | |
| aString & | RemoteAddr (void) |
| aString & RemoteAddr(void); indicates the IP address of the browser. | |
| aString & | RemoteHost (void) |
| aString & RemoteHost(void); indicates the hostname of the browser. | |
| aString & | RemoteIdent (void) |
| aString & | RequestMethod (void) |
| aString & | RemoteUser (void) |
| aString & RemoteUser(void); Indicates the authentication name of the user. | |
| aString & | ScriptName (void) |
| aString & ScriptName(void); Indicates the cgi filename. | |
| aString & | ServerName (void) |
| aString & ServerName(void); indicates the host server name | |
| aString & | ServerPort (void) |
| aString & ServerPort(void); indicates the server port - typically 80. | |
| aString & | ServerProtocol (void) |
| aString & ServerProtocol(void); Indicates the server protocol | |
| aString & | ServerSoftware (void) |
| aString & ServerSoftware(void); Indicates the name and version of the sever software | |
| aString & | ContentBoundary (void) |
| ContentBoundary returns the boundary demarcing multipart. | |
| cgiInput & | ClientArguments (void) |
| ClientArguments returns the associateive arra of the client input. | |
| bool | readInput (void) |
| manual read here for when ReadOnCreateMode is false | |
| cgiEnvironment (const char *uploadPath=NULL) | |
| ~cgiEnvironment () | |
| aString & | ContentLength (void) |
| cgiEnvironment & setUploadPath( string path ); sets the path for uploaded files. | |
| aString & | ContentType (void) |
| aString & ContentType(void); Indicates the MIME type of user supplied info. | |
| aString & | GatewayInterface (void) |
| aString & GatewayInterface(void); Indicates the name of the gateway interface. | |
| aString & | HttpAccept (void) |
| aString & HttpAccept(void); Provides a list of browser acceptible mime types. | |
| aString & | HttpUserAgent (void) |
| aString & HttpUserAgent(void); Indicates the name of the browser. | |
| aString & | HttpReferer (void) |
| aString & HttpReferer(void); Indicates the refering page. | |
| aString & | PathInfo (void) |
| aString & PathInfo(void); holds additional path passed beyond this cgi location. | |
| aString & | PathTranslated (void) |
| aString & | QueryString (void) |
| aString & QueryString(void); The user passed info, used only if the method is GET.<d/d> | |
| aString & | RemoteAddr (void) |
| aString & RemoteAddr(void); indicates the IP address of the browser. | |
| aString & | RemoteHost (void) |
| aString & RemoteHost(void); indicates the hostname of the browser. | |
| aString & | RemoteIdent (void) |
| aString & | RequestMethod (void) |
| aString & | RemoteUser (void) |
| aString & RemoteUser(void); Indicates the authentication name of the user. | |
| aString & | ScriptName (void) |
| aString & ScriptName(void); Indicates the cgi filename. | |
| aString & | ServerName (void) |
| aString & ServerName(void); indicates the host server name | |
| aString & | ServerPort (void) |
| aString & ServerPort(void); indicates the server port - typically 80. | |
| aString & | ServerProtocol (void) |
| aString & ServerProtocol(void); Indicates the server protocol | |
| aString & | ServerSoftware (void) |
| aString & ServerSoftware(void); Indicates the name and version of the sever software | |
| aString & | ContentBoundary (void) |
| ContentBoundary returns the boundary demarcing multipart. | |
| cgiInput & | ClientArguments (void) |
| ClientArguments returns the associateive arra of the client input. | |
| bool | readInput (void) |
| manual read here for when ReadOnCreateMode is false | |
Static Public Member Functions | |
| static void | ReadOnCreateMode (bool doRead) |
| controls when input is read | |
| static void | ReadOnCreateMode (bool doRead) |
| controls when input is read | |
Private Attributes | |
| aString | contentLength |
| aString | contentType |
| aString | contentBoundary |
| aString | gatewayInterface |
| aString | httpAccept |
| aString | httpUserAgent |
| aString | httpReferer |
| aString | pathInfo |
| aString | pathTranslated |
| aString | queryString |
| aString | remoteAddr |
| aString | remoteHost |
| aString | remoteIdent |
| aString | requestMethod |
| aString | remoteUser |
| aString | scriptName |
| aString | serverName |
| aString | serverPort |
| aString | serverProtocol |
| aString | serverSoftware |
| cgiInput | clientArguments |
| int | contentSize |
Static Private Attributes | |
| static bool | readOnCreateMode = true |
| Do we read on create or give the user caller more control over this? | |
Detailed Description
class cgiEnvironmentclass that holds the information coming from the user, as well as information about the browser and server. You would not use this directly, but should keep in mind that cgiScript IS-A cgiEnvironment through public inheritance.
Definition at line 114 of file cgiClass.h.
Constructor & Destructor Documentation
| cgiEnvironment::cgiEnvironment | ( | const char * | uploadPath = NULL |
) |
public methods:
cgiEnvironment(uploadPath) Constructor (upload path is for file uploads, defaults to null) ~cgiEnvironment() Destructor
Definition at line 530 of file cgiClass.cpp.
References clientArguments, contentBoundary, contentLength, contentSize, contentType, gatewayInterface, httpAccept, httpReferer, httpUserAgent, aString::lower(), pathInfo, pathTranslated, queryString, readInput(), readOnCreateMode, aString::remainder(), aString::remainderPosition(), remoteAddr, remoteHost, remoteIdent, remoteUser, requestMethod, scriptName, serverName, serverPort, serverProtocol, serverSoftware, aString::str(), aString::token(), cgiInput::uploadPath, and writelog.
| cgiEnvironment::~cgiEnvironment | ( | ) |
Definition at line 573 of file cgiClass.cpp.
| cgiEnvironment::cgiEnvironment | ( | const char * | uploadPath = NULL |
) |
public methods:
cgiEnvironment(uploadPath) Constructor (upload path is for file uploads, defaults to null) ~cgiEnvironment() Destructor
| cgiEnvironment::~cgiEnvironment | ( | ) |
Member Function Documentation
| aString & cgiEnvironment::ContentLength | ( | void | ) |
cgiEnvironment & setUploadPath( string path ); sets the path for uploaded files.
Definition at line 578 of file cgiClass.cpp.
References contentLength.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::ContentType | ( | void | ) |
aString & ContentType(void); Indicates the MIME type of user supplied info.
Definition at line 582 of file cgiClass.cpp.
References contentType.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::GatewayInterface | ( | void | ) |
aString & GatewayInterface(void); Indicates the name of the gateway interface.
Definition at line 586 of file cgiClass.cpp.
References gatewayInterface.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::HttpAccept | ( | void | ) |
aString & HttpAccept(void); Provides a list of browser acceptible mime types.
Definition at line 590 of file cgiClass.cpp.
References httpAccept.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::HttpUserAgent | ( | void | ) |
aString & HttpUserAgent(void); Indicates the name of the browser.
Definition at line 594 of file cgiClass.cpp.
References httpUserAgent.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::HttpReferer | ( | void | ) |
aString & HttpReferer(void); Indicates the refering page.
Definition at line 598 of file cgiClass.cpp.
References httpReferer.
Referenced by main().
| aString & cgiEnvironment::PathInfo | ( | void | ) |
aString & PathInfo(void); holds additional path passed beyond this cgi location.
Definition at line 602 of file cgiClass.cpp.
References pathInfo.
Referenced by virtualStore::baseCategoryFixup(), cgiScript::DebugString(), page::emitMenu(), intraMain(), page::load(), main(), and form_functor::operator()().
| aString & cgiEnvironment::PathTranslated | ( | void | ) |
aString & PathTranslated(void); holds the same info as the path info, but translated to a whole path from the server document root.
Definition at line 606 of file cgiClass.cpp.
References pathTranslated.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::QueryString | ( | void | ) |
aString & QueryString(void); The user passed info, used only if the method is GET.<d/d>
Definition at line 610 of file cgiClass.cpp.
References queryString.
Referenced by virtualStore::baseCategoryFixup(), cgiScript::DebugString(), qrystr_content_functor::emit(), show_page::emitDetail(), Designer_form::form_display(), redirectToHTMLDoc(), and Report_List::sendHotField().
| aString & cgiEnvironment::RemoteAddr | ( | void | ) |
aString & RemoteAddr(void); indicates the IP address of the browser.
Definition at line 614 of file cgiClass.cpp.
References remoteAddr.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::RemoteHost | ( | void | ) |
aString & RemoteHost(void); indicates the hostname of the browser.
Definition at line 618 of file cgiClass.cpp.
References remoteHost.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::RemoteIdent | ( | void | ) |
aString & RemoteIdent(void); Indicates the users name if set in the users browsers configuration.
Definition at line 622 of file cgiClass.cpp.
References remoteIdent.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::RequestMethod | ( | void | ) |
aString & RequestMethod(void); Indicates the method used in the request, usually GET or POST.
Definition at line 626 of file cgiClass.cpp.
References requestMethod.
Referenced by cgiScript::DebugString(), Scheme_Table_form::form_display(), imagePicker::makeThumb(), mail_functor::operator()(), imagePicker::scaleSource(), mailpage::send(), and list_base::setFilter().
| aString & cgiEnvironment::RemoteUser | ( | void | ) |
aString & RemoteUser(void); Indicates the authentication name of the user.
Definition at line 630 of file cgiClass.cpp.
References remoteUser.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::ScriptName | ( | void | ) |
aString & ScriptName(void); Indicates the cgi filename.
Definition at line 634 of file cgiClass.cpp.
References scriptName.
Referenced by currentSite(), cgiScript::DebugString(), page::load(), main(), redirectToHTMLDoc(), and ReportEmitter::ReportEmitter().
| aString & cgiEnvironment::ServerName | ( | void | ) |
aString & ServerName(void); indicates the host server name
Definition at line 638 of file cgiClass.cpp.
References serverName.
Referenced by currentSite(), cgiScript::DebugString(), servicelist_functor::fixURI(), page::load(), main(), and reporter::referer().
| aString & cgiEnvironment::ServerPort | ( | void | ) |
aString & ServerPort(void); indicates the server port - typically 80.
Definition at line 642 of file cgiClass.cpp.
References serverPort.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::ServerProtocol | ( | void | ) |
aString & ServerProtocol(void); Indicates the server protocol
Definition at line 646 of file cgiClass.cpp.
References serverProtocol.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::ServerSoftware | ( | void | ) |
aString & ServerSoftware(void); Indicates the name and version of the sever software
Definition at line 650 of file cgiClass.cpp.
References serverSoftware.
Referenced by cgiScript::DebugString().
| aString & cgiEnvironment::ContentBoundary | ( | void | ) |
ContentBoundary returns the boundary demarcing multipart.
Definition at line 658 of file cgiClass.cpp.
References contentBoundary.
Referenced by cgiScript::DebugString().
| cgiInput & cgiEnvironment::ClientArguments | ( | void | ) |
ClientArguments returns the associateive arra of the client input.
Definition at line 654 of file cgiClass.cpp.
References clientArguments.
Referenced by uiShoppingCart::AddProduct(), Payment_Form_Complete::addUserElement(), uiShoppingCart::AlwaysAddProduct(), authMain(), xml_form::boolFXfer(), forms_base::boolFXfer(), check(), filePicker::checkForfilesToDelete(), imagePicker::checkForImagesToDelete(), virtualCheckout::confirmOrderPanel(), virtualCheckout::createOrderPanel(), crtidFixup(), xml_form::dateFXfer(), forms_base::dateFXfer(), cgiScript::DebugString(), reporter::detail(), mail_functor::doMail(), xml_form::doubleFXfer(), forms_base::doubleFXfer(), show_page::emitDetail(), list_base::emitFilter(), list_base::emitFilters(), show_page::emitSlides(), filePicker::fileList(), Report_Parameters_form::filterList(), list_base::filtersValue(), Session_form::form_data_transfer(), menu_item_form::form_display(), Scheme_Table_form::form_display(), Report_Parameters_form::get(), xml_form::getInstructions(), forms_base::getInstructions(), group_siteForm(), imagePicker::imageList(), xml_form::intFXfer(), forms_base::intFXfer(), linkForm(), links_Form::links_Form(), list_base::list_base(), xml_form::llongFXfer(), forms_base::llongFXfer(), xml_form::longFXfer(), forms_base::longFXfer(), main(), imagePicker::makeThumb(), menu_form::menu_form(), xml_form::moneyFXfer(), forms_base::moneyFXfer(), free_form_functor::operator()(), pageForm(), Report_Parameters_form::paramFilters(), mailpage::parseItem(), virtualCheckout::paymentForm(), presentation(), redirectToHTMLDoc(), imagePicker::scaleSource(), mailpage::send(), proofs::setArgs(), virtualStore::setArgs(), imagePicker::setArgs(), virtualCheckout::setKey(), xml_form::shortFXfer(), forms_base::shortFXfer(), slides_functor::shouldShow(), detail_functor::shouldShow(), results_functor::shouldShow(), virtualCheckout::show(), virtualStore::showDesigner(), site_pick::site_pick(), xml_form::stringFXfer(), forms_base::stringFXfer(), tagList(), templateList(), templateTests(), xml_form::timeFXfer(), forms_base::timeFXfer(), uiShoppingCart::uiShoppingCart(), xml_form::unfmtLongFXfer(), and forms_base::unfmtLongFXfer().
| void cgiEnvironment::ReadOnCreateMode | ( | bool | doRead | ) | [static] |
controls when input is read
Definition at line 484 of file cgiClass.cpp.
References readOnCreateMode.
| bool cgiEnvironment::readInput | ( | void | ) |
manual read here for when ReadOnCreateMode is false
Definition at line 490 of file cgiClass.cpp.
References clientArguments, contentBoundary, contentSize, contentType, aString::length(), aString::match(), queryString, requestMethod, cgiInput::set(), cgiInput::setMultipart(), aString::str(), writelog, and writelog2.
Referenced by cgiEnvironment().
| aString& cgiEnvironment::ContentLength | ( | void | ) |
cgiEnvironment & setUploadPath( string path ); sets the path for uploaded files.
| aString& cgiEnvironment::ContentType | ( | void | ) |
aString & ContentType(void); Indicates the MIME type of user supplied info.
| aString& cgiEnvironment::GatewayInterface | ( | void | ) |
aString & GatewayInterface(void); Indicates the name of the gateway interface.
| aString& cgiEnvironment::HttpAccept | ( | void | ) |
aString & HttpAccept(void); Provides a list of browser acceptible mime types.
| aString& cgiEnvironment::HttpUserAgent | ( | void | ) |
aString & HttpUserAgent(void); Indicates the name of the browser.
| aString& cgiEnvironment::HttpReferer | ( | void | ) |
aString & HttpReferer(void); Indicates the refering page.
| aString& cgiEnvironment::PathInfo | ( | void | ) |
aString & PathInfo(void); holds additional path passed beyond this cgi location.
| aString& cgiEnvironment::PathTranslated | ( | void | ) |
aString & PathTranslated(void); holds the same info as the path info, but translated to a whole path from the server document root.
| aString& cgiEnvironment::QueryString | ( | void | ) |
aString & QueryString(void); The user passed info, used only if the method is GET.<d/d>
| aString& cgiEnvironment::RemoteAddr | ( | void | ) |
aString & RemoteAddr(void); indicates the IP address of the browser.
| aString& cgiEnvironment::RemoteHost | ( | void | ) |
aString & RemoteHost(void); indicates the hostname of the browser.
| aString& cgiEnvironment::RemoteIdent | ( | void | ) |
aString & RemoteIdent(void); Indicates the users name if set in the users browsers configuration.
| aString& cgiEnvironment::RequestMethod | ( | void | ) |
aString & RequestMethod(void); Indicates the method used in the request, usually GET or POST.
| aString& cgiEnvironment::RemoteUser | ( | void | ) |
aString & RemoteUser(void); Indicates the authentication name of the user.
| aString& cgiEnvironment::ScriptName | ( | void | ) |
aString & ScriptName(void); Indicates the cgi filename.
| aString& cgiEnvironment::ServerName | ( | void | ) |
aString & ServerName(void); indicates the host server name
| aString& cgiEnvironment::ServerPort | ( | void | ) |
aString & ServerPort(void); indicates the server port - typically 80.
| aString& cgiEnvironment::ServerProtocol | ( | void | ) |
aString & ServerProtocol(void); Indicates the server protocol
| aString& cgiEnvironment::ServerSoftware | ( | void | ) |
aString & ServerSoftware(void); Indicates the name and version of the sever software
| aString& cgiEnvironment::ContentBoundary | ( | void | ) |
ContentBoundary returns the boundary demarcing multipart.
| cgiInput& cgiEnvironment::ClientArguments | ( | void | ) |
ClientArguments returns the associateive arra of the client input.
| static void cgiEnvironment::ReadOnCreateMode | ( | bool | doRead | ) | [static] |
controls when input is read
| bool cgiEnvironment::readInput | ( | void | ) |
manual read here for when ReadOnCreateMode is false
Member Data Documentation
aString cgiEnvironment::contentLength [private] |
private member variables: aString contentLength aString contentType aString gatewayInterface aString httpAccept aString httpUserAgent aString pathInfo aString pathTranslated aString queryString aString remoteAddr aString remoteHost aString remoteIdent; aString requestMethod; aString remoteUser; aString scriptName; aString serverName; aString serverPort; aString serverProtocol; aString serverSoftware; cgiInput clientArguments; int contentSize;
Definition at line 132 of file cgiClass.h.
Referenced by cgiEnvironment(), and ContentLength().
aString cgiEnvironment::contentType [private] |
Definition at line 133 of file cgiClass.h.
Referenced by cgiEnvironment(), ContentType(), and readInput().
aString cgiEnvironment::contentBoundary [private] |
Definition at line 134 of file cgiClass.h.
Referenced by cgiEnvironment(), ContentBoundary(), and readInput().
aString cgiEnvironment::gatewayInterface [private] |
aString cgiEnvironment::httpAccept [private] |
aString cgiEnvironment::httpUserAgent [private] |
aString cgiEnvironment::httpReferer [private] |
aString cgiEnvironment::pathInfo [private] |
aString cgiEnvironment::pathTranslated [private] |
aString cgiEnvironment::queryString [private] |
Definition at line 141 of file cgiClass.h.
Referenced by cgiEnvironment(), QueryString(), and readInput().
aString cgiEnvironment::remoteAddr [private] |
aString cgiEnvironment::remoteHost [private] |
aString cgiEnvironment::remoteIdent [private] |
aString cgiEnvironment::requestMethod [private] |
Definition at line 145 of file cgiClass.h.
Referenced by cgiEnvironment(), readInput(), and RequestMethod().
aString cgiEnvironment::remoteUser [private] |
aString cgiEnvironment::scriptName [private] |
aString cgiEnvironment::serverName [private] |
aString cgiEnvironment::serverPort [private] |
aString cgiEnvironment::serverProtocol [private] |
aString cgiEnvironment::serverSoftware [private] |
cgiInput cgiEnvironment::clientArguments [private] |
Definition at line 152 of file cgiClass.h.
Referenced by cgiEnvironment(), ClientArguments(), and readInput().
int cgiEnvironment::contentSize [private] |
static bool cgiEnvironment::readOnCreateMode = true [static, private] |
Do we read on create or give the user caller more control over this?
Definition at line 156 of file cgiClass.h.
Referenced by cgiEnvironment(), and ReadOnCreateMode().
The documentation for this class was generated from the following files:
- include/cgiClass.h
- openCore/cgiClass.h
- openCore/cgiClass.cpp
