bes
Updated for version 3.19.1
|
Classes | |
struct | url |
Static Public Member Functions | |
MIME utility functions | |
These functions are used to create the MIME headers for a message from a server to a client. NB: These functions actually write both the response status line and the header.
| |
static void | set_mime_text (ostream &strm) |
Generate an HTTP 1.0 response header for a text document. More... | |
static void | set_mime_html (ostream &strm) |
Generate an HTTP 1.0 response header for a html document. More... | |
static string | www2id (const string &in, const string &escape="%", const string &except="") |
static string | unhexstring (string s) |
static string | lowercase (const string &s) |
static string | unescape (const string &s) |
static void | check_path (const string &path, const string &root, bool follow_sym_links) |
static char * | fastpidconverter (char *buf, int base) |
static char * | fastpidconverter (long val, char *buf, int base) |
static void | removeLeadingAndTrailingBlanks (string &key) |
static string | id2xml (string in, const string ¬_allowed="><&'\"") |
static string | xml2id (string in) |
static void | explode (char delim, const string &str, list< string > &values) |
static string | implode (const list< string > &values, char delim) |
static void | url_explode (const string &url_str, BESUtil::url &url_parts) |
Given a url, break the url into its different parts. More... | |
static string | url_create (BESUtil::url &url_parts) |
static string | assemblePath (const string &firstPart, const string &secondPart, bool addLeadingSlash=false) |
Assemble path fragments making sure that they are separated by a single '/' character. More... | |
static bool | endsWith (std::string const &fullString, std::string const &ending) |
static void | conditional_timeout_cancel () |
|
static |
Assemble path fragments making sure that they are separated by a single '/' character.
If the parameter ensureLeadingSlash is true then the returned string will begin with a single '/' character followed by the string firstPart, a single '/' character, and the string secondPart.
Definition at line 757 of file BESUtil.cc.
|
static |
Check if the specified path is valid
Check if the specified path is valid
Checks to see if the specified path is a valid path or not. The root directory specified is assumed to be valid, so we don't check that part of the path. The path parameter is relative to the root directory.
If follow_sym_links is false, then if any part of the specified path is a symbolic link, this function will return false, set the passed has_sym_link parameter. No error message is specified.
If there is a problem accessing the specified path then the error string will be filled with whatever system error message is provided.
param path path to check param root root directory path, assumed to be valid param follow_sym_links specifies whether allowed to follow symbolic links throws BESForbiddenError if the user is not allowed to traverse the path throws BESNotFoundError if there is a problem accessing the path or the path does not exist.
Definition at line 242 of file BESUtil.cc.
|
static |
If the value of the BES Key BES.CancelTimeoutOnSend is true, cancel the timeout. The intent of this is to stop the timeout counter once the BES starts sending data back since, the network link used by a remote client may be low-bandwidth and data providers might want to ensure those users get their data (and don't submit second, third, ..., requests when/if the first one fails). The timeout is initiated in the BES framework when it first processes the request.
Definition at line 878 of file BESUtil.cc.
|
static |
Returns true if (the value of) 'fullString' ends with (the value of) 'ending', false otherwise.
Definition at line 852 of file BESUtil.cc.
|
static |
explode a string into an array given a delimiter
Given a string of values separated by a delimiter, break out the values and store in the list.
Quoted values must be escaped.
If values contain the delimiter then the value must be wrapped in quotes.
delim | delimiter separating the values |
str | the original string |
values | list of the delimited values returned to caller |
BESInternalError | if missing ending quote or delimiter does not follow end quote |
Definition at line 545 of file BESUtil.cc.
|
static |
convert pid and place in provided buffer
Definition at line 420 of file BESUtil.cc.
|
static |
convert characters not allowed in xml to escaped characters
Replace characters that are not allowed in XML
in | The string in which to replace characters. |
not_allowed | The set of characters that are not allowed in XML. default: ><&'(single quote)"(double quote) |
Definition at line 489 of file BESUtil.cc.
|
static |
implode a list of values into a single string delimited by delim
Given a list of string values create a single string of values delimited by delim
If the delimiter exists in a value in the list then that value must be enclosed in quotes
values | list of string values to implode |
delim | the delimiter to use in creating the resulting string |
Definition at line 622 of file BESUtil.cc.
|
static |
Convert a string to all lower case
Definition at line 189 of file BESUtil.cc.
|
static |
remove leading and trailing blanks from a string
Definition at line 450 of file BESUtil.cc.
|
static |
Generate an HTTP 1.0 response header for a html document.
strm | Write the MIME header to this ostream. |
Definition at line 91 of file BESUtil.cc.
|
static |
Generate an HTTP 1.0 response header for a text document.
strm | Write the MIME header to this ostream. |
Definition at line 72 of file BESUtil.cc.
|
static |
Unescape characters with backslash before them
Definition at line 199 of file BESUtil.cc.
|
static |
Given a url, break the url into its different parts.
The different parts are the protocol, the domain name, a username if specified, a password if specified, a port if specified, and a path if specified.
struct url { string protocol ; string domain ; string uname ; string psswd ; string port ; string path ; } ;
url | string representation of the URL |
Definition at line 662 of file BESUtil.cc.
|
static |
This functions are used to unescape hex characters from strings
Definition at line 174 of file BESUtil.cc.
|
static |
unescape xml escaped characters
Given a string that contains XML escape sequences (i.e., entities), translate those back into ASCII characters. Return the modified string.
in | The string to modify. |
Definition at line 506 of file BESUtil.cc.