00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114
00115
00116
00117
00118
00119
00120
00121
00122
00123
00124
00125
00126
00127
00128 #ifndef _PURL
00129 #define _PURL
00130
00131 #ifdef P_USE_PRAGMA
00132 #pragma interface
00133 #endif
00134
00135 #include <ptlib.h>
00136
00137
00139
00140
00141 class PURLLegacyScheme;
00142
00148 class PURL : public PObject
00149 {
00150 PCLASSINFO(PURL, PObject)
00151 public:
00153 PURL();
00155 PURL(
00156 const char * cstr,
00157 const char * defaultScheme = NULL
00158 );
00160 PURL(
00161 const PString & str,
00162 const char * defaultScheme = NULL
00163 );
00165 PURL(
00166 const PFilePath & path
00167 );
00168
00177 virtual Comparison Compare(
00178 const PObject & obj
00179 ) const;
00180
00192 virtual PINDEX HashFunction() const;
00193
00196 virtual void PrintOn(
00197 ostream &strm
00198 ) const;
00199
00203 virtual void ReadFrom(
00204 istream &strm
00205 );
00207
00211 inline BOOL Parse(
00212 const char * cstr,
00213 const char * defaultScheme = NULL
00214 ) { return InternalParse(cstr, defaultScheme); }
00216 inline BOOL Parse(
00217 const PString & str,
00218 const char * defaultScheme = NULL
00219 ) { return InternalParse((const char *)str, defaultScheme); }
00220
00222 enum UrlFormat {
00224 FullURL,
00226 PathOnly,
00228 URIOnly,
00230 HostPortOnly
00231 };
00232
00239 PString AsString(
00240 UrlFormat fmt = FullURL
00241 ) const;
00242
00246 PFilePath AsFilePath() const;
00247
00249 enum TranslationType {
00251 LoginTranslation,
00253 PathTranslation,
00255 QueryTranslation
00256 };
00257
00265 static PString TranslateString(
00266 const PString & str,
00267 TranslationType type
00268 );
00269
00277 static PString UntranslateString(
00278 const PString & str,
00279 TranslationType type
00280 );
00281
00283 static void SplitQueryVars(
00284 const PString & queryStr,
00285 PStringToString & queryVars
00286 );
00287
00288
00290 const PCaselessString & GetScheme() const { return scheme; }
00291
00293 void SetScheme(const PString & scheme);
00294
00296 const PString & GetUserName() const { return username; }
00297
00299 void SetUserName(const PString & username);
00300
00302 const PString & GetPassword() const { return password; }
00303
00305 void SetPassword(const PString & password);
00306
00308 const PCaselessString & GetHostName() const { return hostname; }
00309
00311 void SetHostName(const PString & hostname);
00312
00314 WORD GetPort() const { return port; }
00315
00317 void SetPort(WORD newPort);
00318
00320 BOOL GetRelativePath() const { return relativePath; }
00321
00323 const PString & GetPathStr() const { return pathStr; }
00324
00326 void SetPathStr(const PString & pathStr);
00327
00329 const PStringArray & GetPath() const { return path; }
00330
00332 void SetPath(const PStringArray & path);
00333
00335 PString GetParameters() const;
00336
00338 void SetParameters(const PString & parameters);
00339
00341 const PStringToString & GetParamVars() const { return paramVars; }
00342
00344 void SetParamVars(const PStringToString & paramVars);
00345
00347 void SetParamVar(const PString & key, const PString & data);
00348
00350 const PString & GetFragment() const { return fragment; }
00351
00353 PString GetQuery() const;
00354
00356 void SetQuery(const PString & query);
00357
00359 const PStringToString & GetQueryVars() const { return queryVars; }
00360
00362 void SetQueryVars(const PStringToString & queryVars);
00363
00365 void SetQueryVar(const PString & key, const PString & data);
00366
00368 BOOL IsEmpty() const { return urlString.IsEmpty(); }
00369
00370
00377 static BOOL OpenBrowser(
00378 const PString & url
00379 );
00381
00382 BOOL LegacyParse(const PString & _url, const PURLLegacyScheme * schemeInfo);
00383 PString LegacyAsString(PURL::UrlFormat fmt, const PURLLegacyScheme * schemeInfo) const;
00384
00385 protected:
00386 virtual BOOL InternalParse(
00387 const char * cstr,
00388 const char * defaultScheme
00389 );
00390 void Recalculate();
00391 PString urlString;
00392
00393 PCaselessString scheme;
00394 PString username;
00395 PString password;
00396 PCaselessString hostname;
00397 WORD port;
00398 BOOL relativePath;
00399 PString pathStr;
00400 PStringArray path;
00401 PStringToString paramVars;
00402 PString fragment;
00403 PStringToString queryVars;
00404 };
00405
00406
00408
00409
00410 class PURLScheme : public PObject
00411 {
00412 PCLASSINFO(PURLScheme, PObject);
00413 public:
00414 virtual PString GetName() const = 0;
00415 virtual BOOL Parse(const PString & url, PURL & purl) const = 0;
00416 virtual PString AsString(PURL::UrlFormat fmt, const PURL & purl) const = 0;
00417 };
00418
00420
00421
00422 class PURLLegacyScheme : public PURLScheme
00423 {
00424 public:
00425 PURLLegacyScheme(const char * _scheme)
00426 : scheme(_scheme) { }
00427
00428 BOOL Parse(const PString & url, PURL & purl) const
00429 { return purl.LegacyParse(url, this); }
00430
00431 PString AsString(PURL::UrlFormat fmt, const PURL & purl) const
00432 { return purl.LegacyAsString(fmt, this); }
00433
00434 PString GetName() const
00435 { return scheme; }
00436
00437 PString scheme;
00438 BOOL hasUsername;
00439 BOOL hasPassword;
00440 BOOL hasHostPort;
00441 BOOL defaultToUserIfNoAt;
00442 BOOL defaultHostToLocal;
00443 BOOL hasQuery;
00444 BOOL hasParameters;
00445 BOOL hasFragments;
00446 BOOL hasPath;
00447 BOOL relativeImpliesScheme;
00448 WORD defaultPort;
00449 };
00450
00451
00452
00453 #ifdef _WIN32
00454 # ifndef P_DISABLE_FACTORY_INSTANCES
00455 # ifndef P_FACTORY_INSTANCE_PURLScheme
00456 # define P_FACTORY_INSTANCE_PURLScheme 1
00457 # pragma message("Including PURLScheme factory loader")
00458 PLOAD_FACTORY(PURLScheme, PString)
00459 # endif
00460 # endif
00461 #endif
00462
00463 #endif
00464
00465