Collaboration diagram for CGI:
|
Modules | |
| CGI Base Classes | |
| CGI Command APIs | |
| CGI Exception | |
| CGI Request/Response APIs | |
| Cookie Affinity Services | |
Classes | |
| class | CCgiSession |
| CCgiSession --. More... | |
| class | ICgiSessionStorage |
| ICgiSessionStorage --. More... | |
| class | IUrlEncoder |
| IUrlEncoder::. More... | |
| class | CEmptyUrlEncoder |
| Primitive encoder - all methods return the argument value. More... | |
| class | CDefaultUrlEncoder |
| Default encoder, uses the selected encoding for argument names/values and eUrlEncode_Path for document path. More... | |
| class | CCgiArgs_Parser |
| CCgiArgs_Parser::. More... | |
| class | CCgiArgs |
| CCgiArgs::. More... | |
| struct | CCgiArgs::SCgiArg |
| Name-value pair. More... | |
| class | CUrl |
| CUrl::. More... | |
| class | CCgiUserAgent |
| CCgiUserAgent --. More... | |
Typedefs | |
| typedef SCgiArg | CCgiArgs::TArg |
| typedef list< TArg > | CCgiArgs::TArgs |
| typedef TArgs::iterator | CCgiArgs::iterator |
| typedef TArgs::const_iterator | CCgiArgs::const_iterator |
| typedef CVersionInfo | TUserAgentVersion |
| User agent version info. | |
| typedef unsigned int | CCgiUserAgent::TBotFlags |
| Binary OR of "EBotFlags". | |
Enumerations | |
| enum | EUrlEncode { eUrlEncode_None = NStr::eUrlEnc_None, eUrlEncode_SkipMarkChars = NStr::eUrlEnc_SkipMarkChars, eUrlEncode_ProcessMarkChars = NStr::eUrlEnc_ProcessMarkChars, eUrlEncode_PercentOnly = NStr::eUrlEnc_PercentOnly, eUrlEncode_Path = NStr::eUrlEnc_Path } |
| URL encode flags. More... | |
| enum | EUrlDecode { eUrlDecode_All = NStr::eUrlDec_All, eUrlDecode_Percent = NStr::eUrlDec_Percent } |
| URL decode flags. More... | |
| enum | CCgiArgs_Parser::EArgType { CCgiArgs_Parser::eArg_Value, CCgiArgs_Parser::eArg_Index } |
| Query type flag. More... | |
| enum | CCgiArgs::EAmpEncoding { CCgiArgs::eAmp_Char, CCgiArgs::eAmp_Entity } |
| Ampersand encoding for composed URLs. More... | |
| enum | CCgiUserAgent::EBrowser { CCgiUserAgent::eUnknown = 0, CCgiUserAgent::eIE, CCgiUserAgent::eiCab, CCgiUserAgent::eKonqueror, CCgiUserAgent::eLynx, CCgiUserAgent::eNetscape, CCgiUserAgent::eOpera, CCgiUserAgent::eOregano, CCgiUserAgent::eW3m, CCgiUserAgent::eNagios, CCgiUserAgent::eBeonex, CCgiUserAgent::eCamino, CCgiUserAgent::eChimera, CCgiUserAgent::eEpiphany, CCgiUserAgent::eFirefox, CCgiUserAgent::eFlock, CCgiUserAgent::eIceCat, CCgiUserAgent::eIceweasel, CCgiUserAgent::eGaleon, CCgiUserAgent::eKMeleon, CCgiUserAgent::eMadfox, CCgiUserAgent::eMinimo, CCgiUserAgent::eMultiZilla, CCgiUserAgent::eSeaMonkey, CCgiUserAgent::eAvantBrowser, CCgiUserAgent::eCrazyBrowser, CCgiUserAgent::eEnigmaBrowser, CCgiUserAgent::eIRider, CCgiUserAgent::eMaxthon, CCgiUserAgent::eNetCaptor, CCgiUserAgent::eChrome, CCgiUserAgent::eOmniWeb, CCgiUserAgent::eNetNewsWire, CCgiUserAgent::eSafari, CCgiUserAgent::eShiira, CCgiUserAgent::eCrawler, CCgiUserAgent::eOfflineBrowser, CCgiUserAgent::eScript, CCgiUserAgent::eLinkChecker, CCgiUserAgent::eWebValidator, CCgiUserAgent::eMozilla, CCgiUserAgent::eMozillaCompatible } |
| Browser types. More... | |
| enum | CCgiUserAgent::EBrowserEngine { CCgiUserAgent::eEngine_Unknown = eUnknown, CCgiUserAgent::eEngine_IE = eIE, CCgiUserAgent::eEngine_Gecko = eMozilla, CCgiUserAgent::eEngine_KHTML = eSafari, CCgiUserAgent::eEngine_Bot = eCrawler } |
| Browser engine types. More... | |
| enum | CCgiUserAgent::EBrowserPlatform { CCgiUserAgent::ePlatform_Unknown = eUnknown, CCgiUserAgent::ePlatform_Windows, CCgiUserAgent::ePlatform_Mac, CCgiUserAgent::ePlatform_Unix } |
| Platform types. More... | |
| enum | CCgiUserAgent::EBotFlags { CCgiUserAgent::fBotCrawler = (1<<1), CCgiUserAgent::fBotOfflineBrowser = (1<<2), CCgiUserAgent::fBotScript = (1<<3), CCgiUserAgent::fBotLinkChecker = (1<<4), CCgiUserAgent::fBotWebValidator = (1<<5), CCgiUserAgent::fBotAll = 0xFF } |
| Bots check flags (what consider to be a bot). More... | |
Functions | |
| NCBI_DEPRECATED string | URL_DecodeString (const string &str, EUrlEncode encode_flag=eUrlEncode_SkipMarkChars) |
| Decode the URL-encoded string "str"; return the result of decoding If "str" format is invalid then throw CParseException. | |
| NCBI_DEPRECATED SIZE_TYPE | URL_DecodeInPlace (string &str, EUrlDecode decode_flag=eUrlDecode_All) |
| URL-decode string "str" into itself Return 0 on success; otherwise, return 1-based error position. | |
| NCBI_DEPRECATED string | URL_EncodeString (const string &str, EUrlEncode encode_flag=eUrlEncode_SkipMarkChars) |
| URL-encode a string "str" to the "x-www-form-urlencoded" form; return the result of encoding. | |
| virtual string | IUrlEncoder::EncodeUser (const string &user) const =0 |
| Encode user name. | |
| virtual string | IUrlEncoder::DecodeUser (const string &user) const =0 |
| Decode user name. | |
| virtual string | IUrlEncoder::EncodePassword (const string &password) const =0 |
| Encode password. | |
| virtual string | IUrlEncoder::DecodePassword (const string &password) const =0 |
| Decode password. | |
| virtual string | IUrlEncoder::EncodePath (const string &path) const =0 |
| Encode path on server. | |
| virtual string | IUrlEncoder::DecodePath (const string &path) const =0 |
| Decode path on server. | |
| virtual string | IUrlEncoder::EncodeArgName (const string &name) const =0 |
| Encode CGI argument name. | |
| virtual string | IUrlEncoder::DecodeArgName (const string &name) const =0 |
| Decode CGI argument name. | |
| virtual string | IUrlEncoder::EncodeArgValue (const string &value) const =0 |
| Encode CGI argument value. | |
| virtual string | IUrlEncoder::DecodeArgValue (const string &value) const =0 |
| Decode CGI argument value. | |
| virtual string | IUrlEncoder::EncodeFragment (const string &value) const =0 |
| Encode fragment. | |
| virtual string | IUrlEncoder::DecodeFragment (const string &value) const =0 |
| Decode fragment. | |
| virtual string | CEmptyUrlEncoder::DecodeUser (const string &user) const |
| Decode user name. | |
| virtual string | CEmptyUrlEncoder::EncodePassword (const string &password) const |
| Encode password. | |
| virtual string | CEmptyUrlEncoder::DecodePassword (const string &password) const |
| Decode password. | |
| virtual string | CEmptyUrlEncoder::EncodePath (const string &path) const |
| Encode path on server. | |
| virtual string | CEmptyUrlEncoder::DecodePath (const string &path) const |
| Decode path on server. | |
| virtual string | CEmptyUrlEncoder::EncodeArgName (const string &name) const |
| Encode CGI argument name. | |
| virtual string | CEmptyUrlEncoder::DecodeArgName (const string &name) const |
| Decode CGI argument name. | |
| virtual string | CEmptyUrlEncoder::EncodeArgValue (const string &value) const |
| Encode CGI argument value. | |
| virtual string | CEmptyUrlEncoder::DecodeArgValue (const string &value) const |
| Decode CGI argument value. | |
| virtual string | CEmptyUrlEncoder::EncodeFragment (const string &value) const |
| Encode fragment. | |
| virtual string | CEmptyUrlEncoder::DecodeFragment (const string &value) const |
| Decode fragment. | |
| virtual string | CDefaultUrlEncoder::EncodePath (const string &path) const |
| Encode path on server. | |
| virtual string | CDefaultUrlEncoder::DecodePath (const string &path) const |
| Decode path on server. | |
| virtual string | CDefaultUrlEncoder::EncodeArgName (const string &name) const |
| Encode CGI argument name. | |
| virtual string | CDefaultUrlEncoder::DecodeArgName (const string &name) const |
| Decode CGI argument name. | |
| virtual string | CDefaultUrlEncoder::EncodeArgValue (const string &value) const |
| Encode CGI argument value. | |
| virtual string | CDefaultUrlEncoder::DecodeArgValue (const string &value) const |
| Decode CGI argument value. | |
| virtual string | CDefaultUrlEncoder::EncodeFragment (const string &value) const |
| Encode fragment. | |
| virtual string | CDefaultUrlEncoder::DecodeFragment (const string &value) const |
| Decode fragment. | |
| virtual | CCgiArgs_Parser::~CCgiArgs_Parser (void) |
| void | CCgiArgs_Parser::SetQueryString (const string &query, EUrlEncode encode) |
| Parse query string, call AddArgument() to store each value. | |
| void | CCgiArgs_Parser::SetQueryString (const string &query, const IUrlEncoder *encoder=0) |
| Parse query string, call AddArgument() to store each value. | |
| void | CCgiArgs_Parser::SetSemicolonIsNotArgDelimiter (bool enable=true) |
| Treat semicolon as query string argument separator. | |
| virtual void | CCgiArgs_Parser::AddArgument (unsigned int position, const string &name, const string &value, EArgType arg_type=eArg_Index)=0 |
| Process next query argument. | |
| void | CCgiArgs_Parser::x_SetIndexString (const string &query, const IUrlEncoder &encoder) |
| CCgiArgs::CCgiArgs (const string &query, EUrlEncode decode) | |
| Parse the query string, store the arguments. | |
| CCgiArgs::CCgiArgs (const string &query, const IUrlEncoder *encoder=0) | |
| Parse the query string, store the arguments. | |
| string | CCgiArgs::GetQueryString (EAmpEncoding amp_enc, EUrlEncode encode) const |
| Construct and return complete query string. | |
| string | CCgiArgs::GetQueryString (EAmpEncoding amp_enc, const IUrlEncoder *encoder=0) const |
| Construct and return complete query string. | |
| bool | CCgiArgs::IsSetValue (const string &name) const |
| Check if an argument with the given name exists. | |
| const string & | CCgiArgs::GetValue (const string &name, bool *is_found=0) const |
| Get value for the given name. | |
| void | CCgiArgs::SetValue (const string &name, const string &value) |
| Set new value for the first argument with the given name or add a new argument. | |
| const TArgs & | CCgiArgs::GetArgs (void) const |
| Get the const list of arguments. | |
| TArgs & | CCgiArgs::GetArgs (void) |
| Get the list of arguments. | |
| iterator | CCgiArgs::FindFirst (const string &name) |
| Find the first argument with the given name. | |
| iterator | CCgiArgs::FindNext (const iterator &iter) |
| Take argument name from the iterator, find next argument with the same name, return GetArgs().end() if not found. | |
| const_iterator | CCgiArgs::FindFirst (const string &name) const |
| Find the first argument with the given name. | |
| const_iterator | CCgiArgs::FindNext (const const_iterator &iter) const |
| Take argument name from the iterator, find next argument with the same name, return GetArgs().end() if not found. | |
| void | CCgiArgs::SetCase (NStr::ECase name_case) |
| Select case sensitivity of arguments' names. | |
| virtual void | CCgiArgs::AddArgument (unsigned int position, const string &name, const string &value, EArgType arg_type) |
| Process next query argument. | |
| iterator | CCgiArgs::x_Find (const string &name, const iterator &start) |
| const_iterator | CCgiArgs::x_Find (const string &name, const const_iterator &start) const |
| CUrl::CUrl (const string &url, const IUrlEncoder *encoder=0) | |
| Parse the URL. | |
| void | CUrl::SetUrl (const string &url, const IUrlEncoder *encoder=0) |
| Parse the URL. | |
| string | CUrl::ComposeUrl (CCgiArgs::EAmpEncoding amp_enc, const IUrlEncoder *encoder=0) const |
| Compose the URL. | |
| string | CUrl::GetScheme (void) const |
| void | CUrl::SetScheme (const string &value) |
| string | CUrl::GetUser (void) const |
| void | CUrl::SetUser (const string &value) |
| string | CUrl::GetPassword (void) const |
| void | CUrl::SetPassword (const string &value) |
| string | CUrl::GetHost (void) const |
| void | CUrl::SetHost (const string &value) |
| string | CUrl::GetPort (void) const |
| void | CUrl::SetPort (const string &value) |
| string | CUrl::GetPath (void) const |
| void | CUrl::SetPath (const string &value) |
| string | CUrl::GetFragment (void) const |
| void | CUrl::SetFragment (const string &value) |
| string | CUrl::GetOriginalArgsString (void) const |
| Get the original (unparsed and undecoded) CGI query string. | |
| bool | CUrl::HaveArgs (void) const |
| Check if the URL contains any arguments. | |
| const CCgiArgs & | CUrl::GetArgs (void) const |
| Get const list of arguments. | |
| CCgiArgs & | CUrl::GetArgs (void) |
| Get list of arguments. | |
| CUrl::CUrl (const CUrl &url) | |
| CUrl & | CUrl::operator= (const CUrl &url) |
| static IUrlEncoder * | CUrl::GetDefaultEncoder (void) |
| Return default URL encoder. | |
| void | CUrl::x_SetScheme (const string &scheme, const IUrlEncoder &encoder) |
| void | CUrl::x_SetUser (const string &user, const IUrlEncoder &encoder) |
| void | CUrl::x_SetPassword (const string &password, const IUrlEncoder &encoder) |
| void | CUrl::x_SetHost (const string &host, const IUrlEncoder &encoder) |
| void | CUrl::x_SetPort (const string &port, const IUrlEncoder &encoder) |
| void | CUrl::x_SetPath (const string &path, const IUrlEncoder &encoder) |
| void | CUrl::x_SetArgs (const string &args, const IUrlEncoder &encoder) |
| void | CUrl::x_SetFragment (const string &fragment, const IUrlEncoder &encoder) |
| CCgiUserAgent::CCgiUserAgent (const string &user_agent) | |
| Constructor. | |
| void | CCgiUserAgent::Reset (const string &user_agent) |
| Parse new user agent string. | |
| string | CCgiUserAgent::GetUserAgentStr (void) const |
| Get user agent string. | |
| EBrowser | CCgiUserAgent::GetBrowser (void) const |
| Get browser type. | |
| const string & | CCgiUserAgent::GetBrowserName (void) const |
| Get browser name. | |
| EBrowserEngine | CCgiUserAgent::GetEngine (void) const |
| Get browser engine type. | |
| EBrowserPlatform | CCgiUserAgent::GetPlatform (void) const |
| Get platform (OS) type. | |
| const TUserAgentVersion & | CCgiUserAgent::GetBrowserVersion (void) const |
| Get browser version information. | |
| const TUserAgentVersion & | CCgiUserAgent::GetEngineVersion (void) const |
| const TUserAgentVersion & | CCgiUserAgent::GetMozillaVersion (void) const |
| bool | CCgiUserAgent::IsBot (TBotFlags flags=fBotAll, const string &patterns=kEmptyStr) const |
| Check that this is known search robot/bot. | |
| void | CCgiUserAgent::x_Init (void) |
| Init class members. | |
| void | CCgiUserAgent::x_Parse (const string &user_agent) |
| Parse user agent string. | |
| bool | CCgiUserAgent::x_ParseToken (const string &token, int where) |
| Parse token with browser name and version. | |
| bool | CCgiSession::Exists (void) const |
| Check if this session object is valid. | |
| EStatus | CCgiSession::GetStatus (void) const |
| Get current status of the session. | |
| const string & | CCgiSession::GetSessionIdName (void) const |
| Get name for session ID. | |
| void | CCgiSession::SetSessionIdName (const string &name) |
| Set name for session ID. | |
| void | CCgiSession::SetSessionCookieDomain (const string &domain) |
| Set session cookie domain. | |
| void | CCgiSession::SetSessionCookiePath (const string &path) |
| Set session cookie path. | |
| void | CCgiSession::SetSessionCookieExpTime (const CTime &exp_time) |
| Set session cookie expiration time. | |
Variables | |
| NStr::EUrlEncode | CDefaultUrlEncoder::m_Encode |
| bool | CCgiArgs_Parser::m_SemicolonIsNotArgDelimiter |
| string | CCgiArgs::SCgiArg::name |
| string | CCgiArgs::SCgiArg::value |
| NStr::ECase | CCgiArgs::m_Case |
| bool | CCgiArgs::m_IsIndex |
| TArgs | CCgiArgs::m_Args |
| string | CUrl::m_Scheme |
| bool | CUrl::m_IsGeneric |
| string | CUrl::m_User |
| string | CUrl::m_Password |
| string | CUrl::m_Host |
| string | CUrl::m_Port |
| string | CUrl::m_Path |
| string | CUrl::m_Fragment |
| string | CUrl::m_OrigArgs |
| auto_ptr< CCgiArgs > | CUrl::m_ArgsList |
| string | CCgiUserAgent::m_UserAgent |
| User-Agent string. | |
| EBrowser | CCgiUserAgent::m_Browser |
| Browser type. | |
| string | CCgiUserAgent::m_BrowserName |
| Browser name. | |
| TUserAgentVersion | CCgiUserAgent::m_BrowserVersion |
| Browser version info. | |
| EBrowserEngine | CCgiUserAgent::m_Engine |
| Browser engine type. | |
| TUserAgentVersion | CCgiUserAgent::m_EngineVersion |
| Browser engine version. | |
| TUserAgentVersion | CCgiUserAgent::m_MozillaVersion |
| Browser mozilla version. | |
| EBrowserPlatform | CCgiUserAgent::m_Platform |
| Platform type. | |
|
|
Definition at line 298 of file cgi_util.hpp. |
|
|
Definition at line 297 of file cgi_util.hpp. |
|
|
Definition at line 295 of file cgi_util.hpp. |
|
|
Definition at line 296 of file cgi_util.hpp. |
|
|
Binary OR of "EBotFlags".
Definition at line 617 of file cgi_util.hpp. |
|
|
User agent version info.
Definition at line 467 of file cgi_util.hpp. |
|
|
Ampersand encoding for composed URLs.
Definition at line 273 of file cgi_util.hpp. |
|
|
Query type flag.
Definition at line 227 of file cgi_util.hpp. |
|
|
Bots check flags (what consider to be a bot).
Definition at line 609 of file cgi_util.hpp. |
|
|
Browser types.
Definition at line 491 of file cgi_util.hpp. |
|
|
Browser engine types.
Definition at line 553 of file cgi_util.hpp. |
|
|
Platform types.
Definition at line 562 of file cgi_util.hpp. |
|
|
URL decode flags.
Definition at line 61 of file cgi_util.hpp. |
|
|
URL encode flags.
Definition at line 52 of file cgi_util.hpp. |
|
||||||||||||||||||||
|
Process next query argument. Must be overriden to process and store the arguments.
Implements CCgiArgs_Parser. Definition at line 212 of file cgi_util.cpp. References _ASSERT, CCgiArgs_Parser::eArg_Index, CCgiArgs::m_Args, and CCgiArgs::m_IsIndex. |
|
||||||||||||||||||||
|
Process next query argument. Must be overriden to process and store the arguments.
Implemented in CCgiArgs, and CCgiEntries_Parser. Referenced by CCgiArgs_Parser::x_SetIndexString(). |
|
||||||||||||
|
Parse the query string, store the arguments.
Definition at line 204 of file cgi_util.cpp. References CCgiArgs_Parser::SetQueryString(). |
|
||||||||||||
|
Parse the query string, store the arguments.
Definition at line 196 of file cgi_util.cpp. References CCgiArgs_Parser::SetQueryString(). |
|
|
Constructor. Parse the user agent string passed into the constructor. Definition at line 596 of file cgi_util.cpp. References CCgiUserAgent::x_Parse(). |
|
||||||||||||
|
Compose the URL.
Definition at line 491 of file cgi_util.cpp. References CUrl::GetDefaultEncoder(), CUrl::m_IsGeneric, and CUrl::m_Scheme. Referenced by CCgiResponse::SetLocation(). |
|
|
Definition at line 328 of file cgi_util.cpp. |
|
||||||||||||
|
Parse the URL.
Definition at line 321 of file cgi_util.cpp. References CUrl::SetUrl(). |
|
|
Decode CGI argument name.
Reimplemented from CEmptyUrlEncoder. Definition at line 180 of file cgi_util.hpp. References NStr::eUrlDec_All, NStr::eUrlDec_Percent, NStr::eUrlEnc_PercentOnly, CDefaultUrlEncoder::m_Encode, and NStr::URLDecode(). |
|
|
Decode CGI argument name.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 153 of file cgi_util.hpp. |
|
|
Decode CGI argument name.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. Referenced by CCgiArgs_Parser::x_SetIndexString(). |
|
|
Decode CGI argument value.
Reimplemented from CEmptyUrlEncoder. Definition at line 186 of file cgi_util.hpp. References NStr::eUrlDec_All, NStr::eUrlDec_Percent, NStr::eUrlEnc_PercentOnly, CDefaultUrlEncoder::m_Encode, and NStr::URLDecode(). |
|
|
Decode CGI argument value.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 157 of file cgi_util.hpp. |
|
|
Decode CGI argument value.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. |
|
|
Decode fragment.
Reimplemented from CEmptyUrlEncoder. Definition at line 192 of file cgi_util.hpp. References NStr::eUrlDec_All, and NStr::URLDecode(). |
|
|
Decode fragment.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 161 of file cgi_util.hpp. |
|
|
Decode fragment.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. Referenced by CUrl::x_SetFragment(). |
|
|
Decode password.
Implements IUrlEncoder. Definition at line 145 of file cgi_util.hpp. |
|
|
Decode password.
Implemented in CEmptyUrlEncoder. Referenced by CUrl::x_SetPassword(). |
|
|
Decode path on server.
Reimplemented from CEmptyUrlEncoder. Definition at line 176 of file cgi_util.hpp. References NStr::URLDecode(). |
|
|
Decode path on server.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 149 of file cgi_util.hpp. |
|
|
Decode path on server.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. Referenced by CUrl::x_SetPath(). |
|
|
Decode user name.
Implements IUrlEncoder. Definition at line 141 of file cgi_util.hpp. |
|
|
Decode user name.
Implemented in CEmptyUrlEncoder. Referenced by CUrl::x_SetUser(). |
|
|
Encode CGI argument name.
Reimplemented from CEmptyUrlEncoder. Definition at line 178 of file cgi_util.hpp. References CDefaultUrlEncoder::m_Encode, and NStr::URLEncode(). |
|
|
Encode CGI argument name.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 151 of file cgi_util.hpp. |
|
|
Encode CGI argument name.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. |
|
|
Encode CGI argument value.
Reimplemented from CEmptyUrlEncoder. Definition at line 184 of file cgi_util.hpp. References CDefaultUrlEncoder::m_Encode, and NStr::URLEncode(). |
|
|
Encode CGI argument value.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 155 of file cgi_util.hpp. |
|
|
Encode CGI argument value.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. |
|
|
Encode fragment.
Reimplemented from CEmptyUrlEncoder. Definition at line 190 of file cgi_util.hpp. References NStr::eUrlEnc_URIFragment, and NStr::URLEncode(). |
|
|
Encode fragment.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 159 of file cgi_util.hpp. |
|
|
Encode fragment.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. |
|
|
Encode password.
Implements IUrlEncoder. Definition at line 143 of file cgi_util.hpp. |
|
|
Encode password.
Implemented in CEmptyUrlEncoder. |
|
|
Encode path on server.
Reimplemented from CEmptyUrlEncoder. Definition at line 174 of file cgi_util.hpp. References NStr::eUrlEnc_URIPath, and NStr::URLEncode(). |
|
|
Encode path on server.
Implements IUrlEncoder. Reimplemented in CDefaultUrlEncoder. Definition at line 147 of file cgi_util.hpp. |
|
|
Encode path on server.
Implemented in CEmptyUrlEncoder, and CDefaultUrlEncoder. |
|
|
Encode user name.
Implemented in CEmptyUrlEncoder. |
|
|
Check if this session object is valid.
Definition at line 232 of file cgi_session.hpp. References CCgiSession::eLoaded, CCgiSession::eNew, and CCgiSession::m_Status. Referenced by CCgiSession::CreateNewSession(), CCgiSession::GetSessionCookie(), CCgiSession::Load(), CCgiSession::ModifyId(), CCgiSession::SetId(), and CCgiSession::~CCgiSession(). |
|
|
Find the first argument with the given name. If not found, return GetArgs().end(). Definition at line 735 of file cgi_util.hpp. References CCgiArgs::m_Args, and CCgiArgs::x_Find(). |
|
|
Find the first argument with the given name. If not found, return GetArgs().end(). Definition at line 742 of file cgi_util.hpp. References CCgiArgs::m_Args, and CCgiArgs::x_Find(). Referenced by CCgiArgs::GetValue(), CCgiArgs::IsSetValue(), and CCgiArgs::SetValue(). |
|
|
Take argument name from the iterator, find next argument with the same name, return GetArgs().end() if not found.
Definition at line 749 of file cgi_util.hpp. References CCgiArgs::x_Find(). |
|
|
Take argument name from the iterator, find next argument with the same name, return GetArgs().end() if not found.
Definition at line 756 of file cgi_util.hpp. References CCgiArgs::x_Find(). |
|
|
Get list of arguments.
Definition at line 725 of file cgi_util.hpp. References auto_ptr< X >::get(), CUrl::GetDefaultEncoder(), kEmptyStr, CUrl::m_ArgsList, and CUrl::x_SetArgs(). |
|
|
Get const list of arguments.
Definition at line 524 of file cgi_util.cpp. References auto_ptr< X >::get(), CUrl::m_ArgsList, and NCBI_THROW. Referenced by CRefArgs::GetQueryString(). |
|
|
Get the list of arguments.
Definition at line 318 of file cgi_util.hpp. References CCgiArgs::m_Args. |
|
|
Get the const list of arguments.
Definition at line 314 of file cgi_util.hpp. References CCgiArgs::m_Args. Referenced by CCgiApplication::x_OnEvent(). |
|
|
Get browser type.
Definition at line 574 of file cgi_util.hpp. References CCgiUserAgent::m_Browser. Referenced by CCgiUserAgent::IsBot(). |
|
|
Get browser name.
Definition at line 582 of file cgi_util.hpp. References CCgiUserAgent::m_BrowserName. |
|
|
Get browser version information. If version field (major, minor, patch level) equal -1 that it is not defined. Definition at line 599 of file cgi_util.hpp. References CCgiUserAgent::m_BrowserVersion. |
|
|
Return default URL encoder.
Definition at line 565 of file cgi_util.cpp. Referenced by CUrl::ComposeUrl(), CUrl::GetArgs(), CCgiArgs_Parser::SetQueryString(), and CUrl::SetUrl(). |
|
|
Get browser engine type.
Definition at line 587 of file cgi_util.hpp. References CCgiUserAgent::m_Engine. Referenced by CCgiUserAgent::IsBot(). |
|
|
Definition at line 601 of file cgi_util.hpp. References CCgiUserAgent::m_EngineVersion. |
|
|
Definition at line 416 of file cgi_util.hpp. References CUrl::m_Fragment. |
|
|
Definition at line 407 of file cgi_util.hpp. References CUrl::m_Host. Referenced by CRefArgs::GetQueryString(). |
|
|
Definition at line 603 of file cgi_util.hpp. References CCgiUserAgent::m_MozillaVersion. |
|
|
Get the original (unparsed and undecoded) CGI query string.
Definition at line 420 of file cgi_util.hpp. References CUrl::m_OrigArgs. |
|
|
Definition at line 404 of file cgi_util.hpp. References CUrl::m_Password. |
|
|
Definition at line 413 of file cgi_util.hpp. References CUrl::m_Path. |
|
|
Get platform (OS) type.
Definition at line 592 of file cgi_util.hpp. References CCgiUserAgent::m_Platform. |
|
|
Definition at line 410 of file cgi_util.hpp. References CUrl::m_Port. |
|
||||||||||||
|
Construct and return complete query string. Use selected amp and name/value encodings. |
|
||||||||||||
|
Construct and return complete query string. Use selected amp and name/value encodings. |
|
|
Definition at line 398 of file cgi_util.hpp. References CUrl::m_Scheme. |
|
|
Get name for session ID.
Definition at line 333 of file cgi_session.hpp. References CCgiSession::m_SessionIdName. |
|
|
Get current status of the session.
Definition at line 328 of file cgi_session.hpp. References CCgiSession::m_Status. |
|
|
Definition at line 401 of file cgi_util.hpp. References CUrl::m_User. |
|
|
Get user agent string.
Definition at line 570 of file cgi_util.hpp. References CCgiUserAgent::m_UserAgent. |
|
||||||||||||
|
Get value for the given name. finds first of the arguments with the given name. If the name does not exist, is_found is set to false. If is_found is null, CCgiArgsException is thrown. Definition at line 258 of file cgi_util.cpp. References CCgiArgs::FindFirst(), kEmptyStr, and CCgiArgs::m_Args. Referenced by CRefArgs::GetQueryString(). |
|
|
Check if the URL contains any arguments.
Definition at line 424 of file cgi_util.hpp. References auto_ptr< X >::get(), and CUrl::m_ArgsList. Referenced by CRefArgs::GetQueryString(). |
|
||||||||||||
|
Check that this is known search robot/bot. By default it use GetBrowser() value to check on known bots, and only here 'flags' parameter can be used. If standard check fails, additonal parsing parameters from string and/or registry/environment parameter (section 'CGI', name 'Bots') will be used. String value should have patterns for search in the user agent string, and should looks like: "Googlebot Scooter WebCrawler Slurp" You can use any delimeters from next list " ;|~\t". All patterns are case sensitive. For details how to define registry/environment parameter see CParam description.
Definition at line 630 of file cgi_util.cpp. References CGI, CCgiUserAgent::eCrawler, CCgiUserAgent::eEngine_Bot, CCgiUserAgent::eLinkChecker, CCgiUserAgent::eOfflineBrowser, CCgiUserAgent::eScript, CCgiUserAgent::eWebValidator, CCgiUserAgent::fBotAll, CCgiUserAgent::fBotCrawler, CCgiUserAgent::fBotLinkChecker, CCgiUserAgent::fBotOfflineBrowser, CCgiUserAgent::fBotScript, CCgiUserAgent::fBotWebValidator, CCgiUserAgent::GetBrowser(), CCgiUserAgent::GetEngine(), NCBI_PARAM_TYPE, and NStr::Split(). |
|
|
Check if an argument with the given name exists.
Definition at line 301 of file cgi_util.hpp. References CCgiArgs::FindFirst(), and CCgiArgs::m_Args. Referenced by CRefArgs::GetQueryString(). |
|
|
Definition at line 334 of file cgi_util.cpp. References auto_ptr< X >::get(), CUrl::m_ArgsList, CUrl::m_Fragment, CUrl::m_Host, CUrl::m_IsGeneric, CUrl::m_OrigArgs, CUrl::m_Password, CUrl::m_Path, CUrl::m_Port, CUrl::m_Scheme, CUrl::m_User, and auto_ptr< X >::reset(). |
|
|
Parse new user agent string.
Definition at line 613 of file cgi_util.cpp. References CCgiUserAgent::x_Parse(). |
|
|
Select case sensitivity of arguments' names.
Definition at line 338 of file cgi_util.hpp. References CCgiArgs::m_Case. |
|
|
Definition at line 417 of file cgi_util.hpp. References CUrl::m_Fragment. |
|
|
Definition at line 408 of file cgi_util.hpp. References CUrl::m_Host. |
|
|
Definition at line 405 of file cgi_util.hpp. References CUrl::m_Password. |
|
|
Definition at line 414 of file cgi_util.hpp. References CUrl::m_Path. |
|
|
Definition at line 411 of file cgi_util.hpp. References CUrl::m_Port. |
|
||||||||||||
|
Parse query string, call AddArgument() to store each value.
Definition at line 89 of file cgi_util.cpp. References CUrl::GetDefaultEncoder(), len, NCBI_THROW2, NPOS, and CCgiArgs_Parser::x_SetIndexString(). |
|
||||||||||||
|
Parse query string, call AddArgument() to store each value.
Definition at line 49 of file cgi_util.cpp. Referenced by CCgiArgs::CCgiArgs(), CCgiRequest::ParseEntries(), CCgiRequest::ParseIndexes(), CCgiApplication::x_OnEvent(), and CCgiRequest::x_ProcessQueryString(). |
|
|
Definition at line 399 of file cgi_util.hpp. References CUrl::m_Scheme. |
|
|
Treat semicolon as query string argument separator.
Definition at line 220 of file cgi_util.hpp. References CCgiArgs_Parser::m_SemicolonIsNotArgDelimiter. Referenced by CCgiRequest::x_ProcessQueryString(). |
|
|
Set session cookie domain.
Definition at line 343 of file cgi_session.hpp. References CCgiSession::m_SessionCookieDomain. |
|
|
Set session cookie expiration time.
Definition at line 353 of file cgi_session.hpp. References CCgiSession::m_SessionCookieExpTime. |
|
|
Set session cookie path.
Definition at line 348 of file cgi_session.hpp. References CCgiSession::m_SessionCookiePath. |
|
|
Set name for session ID. This name is used as a cookie name for a session cookie. Definition at line 338 of file cgi_session.hpp. References CCgiSession::m_SessionIdName. |
|
||||||||||||
|
Parse the URL.
Definition at line 354 of file cgi_util.cpp. References CUrl::GetDefaultEncoder(), kEmptyStr, CUrl::m_ArgsList, CUrl::m_Fragment, CUrl::m_Host, CUrl::m_IsGeneric, CUrl::m_OrigArgs, CUrl::m_Password, CUrl::m_Path, CUrl::m_Port, CUrl::m_Scheme, CUrl::m_User, NCBI_THROW2, NPOS, pos, auto_ptr< X >::reset(), CUrl::x_SetArgs(), CUrl::x_SetFragment(), CUrl::x_SetHost(), CUrl::x_SetPassword(), CUrl::x_SetPath(), CUrl::x_SetPort(), CUrl::x_SetScheme(), and CUrl::x_SetUser(). Referenced by CUrl::CUrl(), and CUrl::operator=(). |
|
|
Definition at line 402 of file cgi_util.hpp. References CUrl::m_User. |
|
||||||||||||
|
Set new value for the first argument with the given name or add a new argument.
Definition at line 272 of file cgi_util.cpp. References CCgiArgs::FindFirst(), CCgiArgs::m_Args, and CCgiArgs::m_IsIndex. Referenced by CCgiApplication::x_OnEvent(). |
|
||||||||||||
|
URL-decode string "str" into itself Return 0 on success; otherwise, return 1-based error position.
Definition at line 540 of file cgi_util.cpp. References NStr::URLDecodeInPlace(). |
|
||||||||||||
|
Decode the URL-encoded string "str"; return the result of decoding If "str" format is invalid then throw CParseException.
Definition at line 547 of file cgi_util.cpp. References NStr::eUrlDec_All, NStr::eUrlDec_Percent, eUrlEncode_None, eUrlEncode_PercentOnly, and NStr::URLDecode(). |
|
||||||||||||
|
URL-encode a string "str" to the "x-www-form-urlencoded" form; return the result of encoding. If Definition at line 558 of file cgi_util.cpp. References NStr::URLEncode(). |
|
||||||||||||
|
Definition at line 297 of file cgi_util.cpp. References NStr::Equal(), CCgiArgs::m_Args, and CCgiArgs::m_Case. |
|
||||||||||||
|
Definition at line 285 of file cgi_util.cpp. References NStr::Equal(), CCgiArgs::m_Args, and CCgiArgs::m_Case. Referenced by CCgiArgs::FindFirst(), and CCgiArgs::FindNext(). |
|
|
Init class members.
Definition at line 601 of file cgi_util.cpp. References CCgiUserAgent::eEngine_Unknown, CCgiUserAgent::ePlatform_Unknown, CCgiUserAgent::eUnknown, kEmptyStr, CCgiUserAgent::m_Browser, CCgiUserAgent::m_BrowserName, CCgiUserAgent::m_BrowserVersion, CCgiUserAgent::m_Engine, CCgiUserAgent::m_EngineVersion, CCgiUserAgent::m_MozillaVersion, CCgiUserAgent::m_Platform, CCgiUserAgent::m_UserAgent, and CVersionInfo::SetVersion(). Referenced by CCgiUserAgent::x_Parse(). |
|
|
Parse user agent string.
Definition at line 997 of file cgi_util.cpp. References CCgiUserAgent::ePlatform_Windows, CCgiUserAgent::m_Platform, CCgiUserAgent::m_UserAgent, NPOS, NStr::TruncateSpaces(), and CCgiUserAgent::x_Init(). Referenced by CCgiUserAgent::CCgiUserAgent(), and CCgiUserAgent::Reset(). |
|
||||||||||||
|
Parse token with browser name and version.
Definition at line 1190 of file cgi_util.cpp. |
|
||||||||||||
|
Definition at line 716 of file cgi_util.hpp. References CUrl::m_ArgsList, CUrl::m_OrigArgs, and auto_ptr< X >::reset(). Referenced by CUrl::GetArgs(), and CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 709 of file cgi_util.hpp. References IUrlEncoder::DecodeFragment(), and CUrl::m_Fragment. Referenced by CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 687 of file cgi_util.hpp. References CUrl::m_Host. Referenced by CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 57 of file cgi_util.cpp. References _ASSERT, CCgiArgs_Parser::AddArgument(), IUrlEncoder::DecodeArgName(), CCgiArgs_Parser::eArg_Index, kEmptyStr, len, NCBI_THROW2, and NPOS. Referenced by CCgiArgs_Parser::SetQueryString(). |
|
||||||||||||
|
Definition at line 680 of file cgi_util.hpp. References IUrlEncoder::DecodePassword(), and CUrl::m_Password. Referenced by CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 702 of file cgi_util.hpp. References IUrlEncoder::DecodePath(), and CUrl::m_Path. Referenced by CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 694 of file cgi_util.hpp. References CUrl::m_Port, and NStr::StringToInt(). Referenced by CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 666 of file cgi_util.hpp. References CUrl::m_Scheme. Referenced by CUrl::SetUrl(). |
|
||||||||||||
|
Definition at line 673 of file cgi_util.hpp. References IUrlEncoder::DecodeUser(), and CUrl::m_User. Referenced by CUrl::SetUrl(). |
|
|
Definition at line 211 of file cgi_util.hpp. |
|
|
Definition at line 353 of file cgi_util.hpp. Referenced by CCgiArgs::AddArgument(), CCgiArgs::FindFirst(), CCgiArgs::GetArgs(), CCgiArgs::GetValue(), CCgiArgs::IsSetValue(), CCgiArgs::SetValue(), and CCgiArgs::x_Find(). |
|
|
Definition at line 461 of file cgi_util.hpp. Referenced by CUrl::GetArgs(), CUrl::HaveArgs(), CUrl::operator=(), CUrl::SetUrl(), and CUrl::x_SetArgs(). |
|
|
Browser type.
Definition at line 645 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetBrowser(), and CCgiUserAgent::x_Init(). |
|
|
Browser name.
Definition at line 646 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetBrowserName(), and CCgiUserAgent::x_Init(). |
|
|
Browser version info.
Definition at line 647 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetBrowserVersion(), and CCgiUserAgent::x_Init(). |
|
|
Definition at line 351 of file cgi_util.hpp. Referenced by CCgiArgs::SetCase(), and CCgiArgs::x_Find(). |
|
|
Definition at line 195 of file cgi_util.hpp. Referenced by CDefaultUrlEncoder::DecodeArgName(), CDefaultUrlEncoder::DecodeArgValue(), CDefaultUrlEncoder::EncodeArgName(), and CDefaultUrlEncoder::EncodeArgValue(). |
|
|
Browser engine type.
Definition at line 648 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetEngine(), and CCgiUserAgent::x_Init(). |
|
|
Browser engine version.
Definition at line 649 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetEngineVersion(), and CCgiUserAgent::x_Init(). |
|
|
Definition at line 459 of file cgi_util.hpp. Referenced by CUrl::GetFragment(), CUrl::operator=(), CUrl::SetFragment(), CUrl::SetUrl(), and CUrl::x_SetFragment(). |
|
|
Definition at line 456 of file cgi_util.hpp. Referenced by CUrl::GetHost(), CUrl::operator=(), CUrl::SetHost(), CUrl::SetUrl(), and CUrl::x_SetHost(). |
|
|
Definition at line 453 of file cgi_util.hpp. Referenced by CUrl::ComposeUrl(), CUrl::operator=(), and CUrl::SetUrl(). |
|
|
Definition at line 352 of file cgi_util.hpp. Referenced by CCgiArgs::AddArgument(), and CCgiArgs::SetValue(). |
|
|
Browser mozilla version.
Definition at line 650 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetMozillaVersion(), and CCgiUserAgent::x_Init(). |
|
|
Definition at line 460 of file cgi_util.hpp. Referenced by CUrl::GetOriginalArgsString(), CUrl::operator=(), CUrl::SetUrl(), and CUrl::x_SetArgs(). |
|
|
Definition at line 455 of file cgi_util.hpp. Referenced by CUrl::GetPassword(), CUrl::operator=(), CUrl::SetPassword(), CUrl::SetUrl(), and CUrl::x_SetPassword(). |
|
|
Definition at line 458 of file cgi_util.hpp. Referenced by CUrl::GetPath(), CUrl::operator=(), CUrl::SetPath(), CUrl::SetUrl(), and CUrl::x_SetPath(). |
|
|
Platform type.
Definition at line 651 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetPlatform(), CCgiUserAgent::x_Init(), and CCgiUserAgent::x_Parse(). |
|
|
Definition at line 457 of file cgi_util.hpp. Referenced by CUrl::GetPort(), CUrl::operator=(), CUrl::SetPort(), CUrl::SetUrl(), and CUrl::x_SetPort(). |
|
|
Definition at line 452 of file cgi_util.hpp. Referenced by CUrl::ComposeUrl(), CUrl::GetScheme(), CUrl::operator=(), CUrl::SetScheme(), CUrl::SetUrl(), and CUrl::x_SetScheme(). |
|
|
Definition at line 251 of file cgi_util.hpp. Referenced by CCgiArgs_Parser::SetSemicolonIsNotArgDelimiter(). |
|
|
Definition at line 454 of file cgi_util.hpp. Referenced by CUrl::GetUser(), CUrl::operator=(), CUrl::SetUrl(), CUrl::SetUser(), and CUrl::x_SetUser(). |
|
|
User-Agent string.
Definition at line 644 of file cgi_util.hpp. Referenced by CCgiUserAgent::GetUserAgentStr(), CCgiUserAgent::x_Init(), and CCgiUserAgent::x_Parse(). |
|
|
Definition at line 292 of file cgi_util.hpp. |
|
|
Definition at line 293 of file cgi_util.hpp. |
1.4.6
Modified on Mon Dec 07 16:24:36 2009 by modify_doxy.py rev. 173732