/usr/include/ptclib/url.h is in libpt2.4.5-dev 2.4.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 | /*
* url.h
*
* Universal Resource Locator (for HTTP/HTML) class.
*
* Portable Windows Library
*
* Copyright (c) 1993-2002 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Portable Windows Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Contributor(s): ______________________________________.
*
* $Revision: 21572 $
* $Author: csoutheren $
* $Date: 2008-11-20 04:36:24 +0000 (Thu, 20 Nov 2008) $
*/
#ifndef _PURL_H
#define _PURL_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#ifndef _PTLIB_H
#include <ptlib.h>
#endif
#if P_URL
//////////////////////////////////////////////////////////////////////////////
// PURL
class PURLLegacyScheme;
/**
This class describes a Universal Resource Locator.
This is the desciption of a resource location as used by the World Wide
Web and the #PHTTPSocket# class.
*/
class PURL : public PObject
{
PCLASSINFO(PURL, PObject)
public:
/**Construct a new URL object from the URL string. */
PURL();
/**Construct a new URL object from the URL string. */
PURL(
const char * cstr, ///< C string representation of the URL.
const char * defaultScheme = NULL ///< Default scheme for URL
);
/**Construct a new URL object from the URL string. */
PURL(
const PString & str, ///< String representation of the URL.
const char * defaultScheme = NULL ///< Default scheme for URL
);
/**Construct a new URL object from the file path. */
PURL(
const PFilePath & path ///< File path to turn into a "file:" URL.
);
PURL(const PURL & other);
PURL & operator=(const PURL & other);
/**@name Overrides from class PObject */
//@{
/**Compare the two URLs and return their relative rank.
@return
#LessThan#, #EqualTo# or #GreaterThan#
according to the relative rank of the objects.
*/
virtual Comparison Compare(
const PObject & obj ///< Object to compare against.
) const;
/**This function yields a hash value required by the #PDictionary#
class. A descendent class that is required to be the key of a dictionary
should override this function. The precise values returned is dependent
on the semantics of the class. For example, the #PString# class
overrides it to provide a hash function for distinguishing text strings.
The default behaviour is to return the value zero.
@return
hash function value for class instance.
*/
virtual PINDEX HashFunction() const;
/**Output the contents of the URL to the stream as a string.
*/
virtual void PrintOn(
ostream &strm ///< Stream to print the object into.
) const;
/**Input the contents of the URL from the stream. The input is a URL in
string form.
*/
virtual void ReadFrom(
istream &strm ///< Stream to read the objects contents from.
);
//@}
/**@name New functions for class. */
//@{
/**Parse the URL string into the fields in the object instance. */
inline PBoolean Parse(
const char * cstr, ///< URL as a string to parse.
const char * defaultScheme = NULL ///< Default scheme for URL
) { return InternalParse(cstr, defaultScheme); }
/**Parse the URL string into the fields in the object instance. */
inline PBoolean Parse(
const PString & str, ///< URL as a string to parse.
const char * defaultScheme = NULL ///< Default scheme for URL
) { return InternalParse((const char *)str, defaultScheme); }
/**Print/String output representation formats. */
enum UrlFormat {
/// Translate to a string as a full URL
FullURL,
/// Translate to a string as only path
PathOnly,
/// Translate to a string with no scheme or host
URIOnly,
/// Translate to a string with scheme and host/port
HostPortOnly
};
/**Convert the URL object into its string representation. The parameter
indicates whether a full or partial representation os to be produced.
@return
String representation of the URL.
*/
PString AsString(
UrlFormat fmt = FullURL ///< The type of string to be returned.
) const;
/**Get the "file:" URL as a file path.
If the URL is not a "file:" URL then returns an empty string.
*/
PFilePath AsFilePath() const;
/// Type for translation of strings to URL format,
enum TranslationType {
/// Translate a username/password field for a URL.
LoginTranslation,
/// Translate the path field for a URL.
PathTranslation,
/// Translate the query parameters field for a URL.
QueryTranslation
};
/**Translate a string from general form to one that can be included into
a URL. All reserved characters for the particular field type are
escaped.
@return
String for the URL ready translation.
*/
static PString TranslateString(
const PString & str, ///< String to be translated.
TranslationType type ///< Type of translation.
);
/**Untranslate a string from a form that was included into a URL into a
normal string. All reserved characters for the particular field type
are unescaped.
@return
String from the URL untranslated.
*/
static PString UntranslateString(
const PString & str, ///< String to be translated.
TranslationType type ///< Type of translation.
);
/** Split a string to a dictionary of names and values. */
static void SplitVars(
const PString & str, ///< String to split into variables.
PStringToString & vars, ///< Dictionary of variable names and values.
char sep1, ///< Separater between pairs
char sep2 ///< Separater between key and value
);
/** Split a string in &= form to a dictionary of names and values. */
static void SplitQueryVars(
const PString & queryStr, ///< String to split into variables.
PStringToString & queryVars ///< Dictionary of variable names and values.
) { SplitVars(queryStr, queryVars, '&', '='); }
/// Get the scheme field of the URL.
const PCaselessString & GetScheme() const { return scheme; }
/// Set the scheme field of the URL
void SetScheme(const PString & scheme);
/// Get the username field of the URL.
const PString & GetUserName() const { return username; }
/// Set the username field of the URL.
void SetUserName(const PString & username);
/// Get the password field of the URL.
const PString & GetPassword() const { return password; }
/// Set the password field of the URL.
void SetPassword(const PString & password);
/// Get the hostname field of the URL.
const PCaselessString & GetHostName() const { return hostname; }
/// Set the hostname field of the URL.
void SetHostName(const PString & hostname);
/// Get the port field of the URL.
WORD GetPort() const { return port; }
/// Set the port field in the URL.
void SetPort(WORD newPort);
/// Get if explicit port is specified.
PBoolean GetPortSupplied() const { return portSupplied; }
/// Get if path is relative or absolute
PBoolean GetRelativePath() const { return relativePath; }
/// Get the path field of the URL as a string.
const PString & GetPathStr() const { return pathStr; }
/// Set the path field of the URL as a string.
void SetPathStr(const PString & pathStr);
/// Get the path field of the URL as a string array.
const PStringArray & GetPath() const { return path; }
/// Set the path field of the URL as a string array.
void SetPath(const PStringArray & path);
/// Get the parameter (;) field of the URL.
PString GetParameters() const;
/// Set the parameter (;) field of the URL.
void SetParameters(const PString & parameters);
/// Get the parameter (;) field(s) of the URL as a string dictionary.
const PStringToString & GetParamVars() const { return paramVars; }
/// Set the parameter (;) field(s) of the URL as a string dictionary.
void SetParamVars(const PStringToString & paramVars);
/// Set the parameter (;) field of the URL as a string dictionary.
void SetParamVar(const PString & key, const PString & data);
/// Get the fragment (##) field of the URL.
const PString & GetFragment() const { return fragment; }
/// Get the Query (?) field of the URL as a string.
PString GetQuery() const;
/// Set the Query (?) field of the URL as a string.
void SetQuery(const PString & query);
/// Get the Query (?) field of the URL as a string dictionary.
const PStringToString & GetQueryVars() const { return queryVars; }
/// Set the Query (?) field(s) of the URL as a string dictionary.
void SetQueryVars(const PStringToString & queryVars);
/// Set the Query (?) field of the URL as a string dictionary.
void SetQueryVar(const PString & key, const PString & data);
/// Return PTrue if the URL is an empty string.
PBoolean IsEmpty() const { return urlString.IsEmpty(); }
/**Open the URL in a browser.
@return
The browser was successfully opened. This does not mean the URL exists and was
displayed.
*/
static PBoolean OpenBrowser(
const PString & url ///< URL to open
);
//@}
PBoolean LegacyParse(const PString & _url, const PURLLegacyScheme * schemeInfo);
PString LegacyAsString(PURL::UrlFormat fmt, const PURLLegacyScheme * schemeInfo) const;
protected:
void CopyContents(const PURL & other);
virtual PBoolean InternalParse(
const char * cstr, ///< URL as a string to parse.
const char * defaultScheme ///< Default scheme for URL
);
void Recalculate();
PString urlString;
PCaselessString scheme;
PString username;
PString password;
PCaselessString hostname;
WORD port;
PBoolean portSupplied; /// port was supplied in string input
PBoolean relativePath;
PString pathStr;
PStringArray path;
PStringToString paramVars;
PString fragment;
PStringToString queryVars;
};
//////////////////////////////////////////////////////////////////////////////
// PURLScheme
class PURLScheme : public PObject
{
PCLASSINFO(PURLScheme, PObject);
public:
virtual PString GetName() const = 0;
virtual PBoolean Parse(const PString & url, PURL & purl) const = 0;
virtual PString AsString(PURL::UrlFormat fmt, const PURL & purl) const = 0;
};
//////////////////////////////////////////////////////////////////////////////
// PURLLegacyScheme
class PURLLegacyScheme : public PURLScheme
{
public:
PURLLegacyScheme(const char * _scheme)
: scheme(_scheme) { }
PBoolean Parse(const PString & url, PURL & purl) const
{ return purl.LegacyParse(url, this); }
PString AsString(PURL::UrlFormat fmt, const PURL & purl) const
{ return purl.LegacyAsString(fmt, this); }
PString GetName() const
{ return scheme; }
PString scheme;
PBoolean hasUsername;
PBoolean hasPassword;
PBoolean hasHostPort;
PBoolean defaultToUserIfNoAt;
PBoolean defaultHostToLocal;
PBoolean hasQuery;
PBoolean hasParameters;
PBoolean hasFragments;
PBoolean hasPath;
PBoolean relativeImpliesScheme;
WORD defaultPort;
};
#endif // P_URL
#endif // _PURL_H
// End Of File ///////////////////////////////////////////////////////////////
|