CGI Request/Response APIs
[CGI]

Collaboration diagram for CGI Request/Response APIs:

Classes
class	CCgiEntryReader
class	CCgiEntryReaderContext
class	CCgiCookie
	CCgiCookie::. More...
class	CCgiCookies
	CCgiCookies::. More...
class	CCgiEntry
class	CCgiRequest
	CCgiRequest::. More...
class	CCgiResponse
class	CRefArgs
	CRefArgs::. More...
Defines
#define	HTTP_EOL   "\r\n"
Typedefs
typedef map< string, string >	TCgiProperties
typedef multimap< string, CCgiEntry, PNocase_Conditional >	TCgiEntries
typedef TCgiEntries::iterator	TCgiEntriesI
typedef TCgiEntries::const_iterator	TCgiEntriesCI
typedef list< string >	TCgiIndexes
typedef multimap< string, string >	CRefArgs::THostMap
Enumerations
enum	ECgiProp {   eCgi_ServerSoftware = 0, eCgi_ServerName, eCgi_GatewayInterface, eCgi_ServerProtocol,   eCgi_ServerPort, eCgi_RemoteHost, eCgi_RemoteAddr, eCgi_ContentType,   eCgi_ContentLength, eCgi_RequestMethod, eCgi_PathInfo, eCgi_PathTranslated,   eCgi_ScriptName, eCgi_QueryString, eCgi_AuthType, eCgi_RemoteUser,   eCgi_RemoteIdent, eCgi_HttpAccept, eCgi_HttpCookie, eCgi_HttpIfModifiedSince,   eCgi_HttpReferer, eCgi_HttpUserAgent, eCgi_NProperties }
	Set of "standard" HTTP request properties. More...
Functions
	CRefArgs::~CRefArgs (void)
void	CRefArgs::AddDefinitions (const string &definitions)
	Add mappings between host mask and CGI argument name for query string.
void	CRefArgs::AddDefinitions (const string &host_mask, const string &arg_names)
string	CRefArgs::GetQueryString (const string &referrer) const
	Find query string in the referrer.
static string	CRefArgs::GetDefaultDefinitions (void)
	Get default set of search engine definitions.
bool	CRefArgs::IsListedHost (const string &referrer) const
	Check if the host from the referrer string is listed in definitions.
Variables
	NCBI_XCGI_EXPORT
	Parameter to control error handling of incoming cookies.
	CGI
	On_Bad_Cookie
THostMap	CRefArgs::m_HostMap

---

Define Documentation

#define HTTP_EOL   "\r\n"

Definition at line 50 of file ncbicgi.hpp. Referenced by CCgiCookie::Write(), and CCgiResponse::WriteHeader().

---

Typedef Documentation

typedef multimap<string, CCgiEntry, PNocase_Conditional> TCgiEntries

Definition at line 597 of file ncbicgi.hpp.

typedef TCgiEntries::const_iterator TCgiEntriesCI

Definition at line 599 of file ncbicgi.hpp.

typedef TCgiEntries::iterator TCgiEntriesI

Definition at line 598 of file ncbicgi.hpp.

typedef list<string> TCgiIndexes

Definition at line 600 of file ncbicgi.hpp.

typedef map<string, string> TCgiProperties

Definition at line 596 of file ncbicgi.hpp.

typedef multimap<string, string> CRefArgs::THostMap [private, inherited]

Definition at line 86 of file ref_args.hpp.

---

Enumeration Type Documentation

enum ECgiProp

Set of "standard" HTTP request properties. See also: CCgiRequest Enumerator: eCgi_ServerSoftware  eCgi_ServerName  eCgi_GatewayInterface  eCgi_ServerProtocol  eCgi_ServerPort  eCgi_RemoteHost  eCgi_RemoteAddr  eCgi_ContentType  eCgi_ContentLength  eCgi_RequestMethod  eCgi_PathInfo  eCgi_PathTranslated  eCgi_ScriptName  eCgi_QueryString  eCgi_AuthType  eCgi_RemoteUser  eCgi_RemoteIdent  eCgi_HttpAccept  eCgi_HttpCookie  eCgi_HttpIfModifiedSince  eCgi_HttpReferer  eCgi_HttpUserAgent  eCgi_NProperties  Definition at line 338 of file ncbicgi.hpp.

---

Function Documentation

void CRefArgs::AddDefinitions (  const string &  host_mask, const string &  arg_names )  [inherited]

Definition at line 86 of file ref_args.cpp. References multimap_checker< Container >::insert(), ITERATE, CRefArgs::m_HostMap, NStr::Split(), and NStr::TruncateSpaces().

void CRefArgs::AddDefinitions (  const string &  definitions  )  [inherited]

Add mappings between host mask and CGI argument name for query string. See also: CRefArgs::CRefArgs Definition at line 72 of file ref_args.cpp. References ITERATE, NStr::Split(), and NStr::SplitInTwo(). Referenced by CRefArgs::CRefArgs().

string CRefArgs::GetDefaultDefinitions (  void   )  [static, inherited]

Get default set of search engine definitions. Definition at line 45 of file ref_args.cpp.

string CRefArgs::GetQueryString (  const string &  referrer  )  const [inherited]

Find query string in the referrer. Parameters: referrer  Full HTTP referrer Returns: Query string assigned to one of the names associated with the host in the referrer or empty string. Definition at line 99 of file ref_args.cpp. References NStr::FindNoCase(), CUrl::GetArgs(), CUrl::GetHost(), CCgiArgs::GetValue(), CUrl::HaveArgs(), CCgiArgs::IsSetValue(), ITERATE, CRefArgs::m_HostMap, and NPOS.

bool CRefArgs::IsListedHost (  const string &  referrer  )  const [inherited]

Check if the host from the referrer string is listed in definitions. Definition at line 118 of file ref_args.cpp. References NStr::Find(), NStr::FindNoCase(), ITERATE, CRefArgs::m_HostMap, NPOS, and pos.

CRefArgs::~CRefArgs (  void   )  [inherited]

Definition at line 66 of file ref_args.cpp.

---

Variable Documentation

CGI

Definition at line 317 of file ncbicgi.hpp. Referenced by CCgiUserAgent::IsBot().

THostMap CRefArgs::m_HostMap [private, inherited]

Definition at line 88 of file ref_args.hpp. Referenced by CRefArgs::AddDefinitions(), CRefArgs::GetQueryString(), and CRefArgs::IsListedHost().

NCBI_XCGI_EXPORT

Parameter to control error handling of incoming cookies. Does not affect error handling of outgoing cookies set by the application. Definition at line 317 of file ncbicgi.hpp.

On_Bad_Cookie

Definition at line 317 of file ncbicgi.hpp.

---