RetroZilla/netwerk/base/src/nsStandardURL.h
2015-10-20 23:03:22 -04:00

368 lines
13 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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 mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Darin Fisher <darin@netscape.com> (original author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsStandardURL_h__
#define nsStandardURL_h__
#include "nsString.h"
#include "nsDependentString.h"
#include "nsDependentSubstring.h"
#include "nsISerializable.h"
#include "nsIFileURL.h"
#include "nsIStandardURL.h"
#include "nsIFile.h"
#include "nsIURLParser.h"
#include "nsIUnicodeEncoder.h"
#include "nsIObserver.h"
#include "nsIIOService.h"
#include "nsCOMPtr.h"
#include "nsURLHelper.h"
class nsIBinaryInputStream;
class nsIBinaryOutputStream;
class nsIIDNService;
class nsICharsetConverterManager;
class nsIPrefBranch;
//-----------------------------------------------------------------------------
// standard URL implementation
//-----------------------------------------------------------------------------
class nsStandardURL : public nsIFileURL
, public nsIStandardURL
, public nsISerializable
, public nsIClassInfo
{
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIURI
NS_DECL_NSIURL
NS_DECL_NSIFILEURL
NS_DECL_NSISTANDARDURL
NS_DECL_NSISERIALIZABLE
NS_DECL_NSICLASSINFO
nsStandardURL(PRBool aSupportsFileURL = PR_FALSE);
virtual ~nsStandardURL();
static void InitGlobalObjects();
static void ShutdownGlobalObjects();
public: /* internal -- HPUX compiler can't handle this being private */
//
// location and length of an url segment relative to mSpec
//
struct URLSegment
{
PRUint32 mPos;
PRInt32 mLen;
URLSegment() : mPos(0), mLen(-1) {}
URLSegment(PRUint32 pos, PRInt32 len) : mPos(pos), mLen(len) {}
void Reset() { mPos = 0; mLen = -1; }
};
//
// Pref observer
//
class nsPrefObserver : public nsIObserver
{
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIOBSERVER
nsPrefObserver() { }
};
friend class nsPrefObserver;
//
// URL segment encoder : performs charset conversion and URL escaping.
//
class nsSegmentEncoder
{
public:
nsSegmentEncoder(const char *charset);
// Encode the given segment if necessary, and return the length of
// the encoded segment. The encoded segment is appended to |buf|
// if and only if encoding is required.
PRInt32 EncodeSegmentCount(const char *str,
const URLSegment &segment,
PRInt16 mask,
nsAFlatCString &buf,
PRBool& appended);
// Encode the given string if necessary, and return a reference to
// the encoded string. Returns a reference to |buf| if encoding
// is required. Otherwise, a reference to |str| is returned.
const nsACString &EncodeSegment(const nsASingleFragmentCString &str,
PRInt16 mask,
nsAFlatCString &buf);
private:
PRBool InitUnicodeEncoder();
const char* mCharset; // Caller should keep this alive for
// the life of the segment encoder
nsCOMPtr<nsIUnicodeEncoder> mEncoder;
};
friend class nsSegmentEncoder;
protected:
virtual nsStandardURL* StartClone();
// Helper for subclass implementation of GetFile(). Subclasses that map
// URIs to files in a special way should implement this method. It should
// ensure that our mFile is initialized, if it's possible.
virtual nsresult EnsureFile();
private:
PRInt32 Port() { return mPort == -1 ? mDefaultPort : mPort; }
void Clear();
void InvalidateCache(PRBool invalidateCachedFile = PR_TRUE);
PRBool EscapeIPv6(const char *host, nsCString &result);
PRBool NormalizeIDN(const nsCSubstring &host, nsCString &result);
void CoalescePath(netCoalesceFlags coalesceFlag, char *path);
PRUint32 AppendSegmentToBuf(char *, PRUint32, const char *, URLSegment &, const nsCString *esc=nsnull, PRBool useEsc = PR_FALSE);
PRUint32 AppendToBuf(char *, PRUint32, const char *, PRUint32);
nsresult BuildNormalizedSpec(const char *spec);
PRBool SegmentIs(const URLSegment &s1, const char *val);
PRBool SegmentIs(const char* spec, const URLSegment &s1, const char *val);
PRBool SegmentIs(const URLSegment &s1, const char *val, const URLSegment &s2);
PRInt32 ReplaceSegment(PRUint32 pos, PRUint32 len, const char *val, PRUint32 valLen);
PRInt32 ReplaceSegment(PRUint32 pos, PRUint32 len, const nsACString &val);
nsresult ParseURL(const char *spec, PRInt32 specLen);
nsresult ParsePath(const char *spec, PRUint32 pathPos, PRInt32 pathLen = -1);
char *AppendToSubstring(PRUint32 pos, PRInt32 len, const char *tail, PRInt32 tailLen = -1);
// dependent substring helpers
const nsDependentCSubstring Segment(PRUint32 pos, PRInt32 len); // see below
const nsDependentCSubstring Segment(const URLSegment &s) { return Segment(s.mPos, s.mLen); }
// dependent substring getters
const nsDependentCSubstring Prepath(); // see below
const nsDependentCSubstring Scheme() { return Segment(mScheme); }
const nsDependentCSubstring Userpass(PRBool includeDelim = PR_FALSE); // see below
const nsDependentCSubstring Username() { return Segment(mUsername); }
const nsDependentCSubstring Password() { return Segment(mPassword); }
const nsDependentCSubstring Hostport(); // see below
const nsDependentCSubstring Host(); // see below
const nsDependentCSubstring Path() { return Segment(mPath); }
const nsDependentCSubstring Filepath() { return Segment(mFilepath); }
const nsDependentCSubstring Directory() { return Segment(mDirectory); }
const nsDependentCSubstring Filename(); // see below
const nsDependentCSubstring Basename() { return Segment(mBasename); }
const nsDependentCSubstring Extension() { return Segment(mExtension); }
const nsDependentCSubstring Param() { return Segment(mParam); }
const nsDependentCSubstring Query() { return Segment(mQuery); }
const nsDependentCSubstring Ref() { return Segment(mRef); }
// shift the URLSegments to the right by diff
void ShiftFromAuthority(PRInt32 diff) { mAuthority.mPos += diff; ShiftFromUsername(diff); }
void ShiftFromUsername(PRInt32 diff) { mUsername.mPos += diff; ShiftFromPassword(diff); }
void ShiftFromPassword(PRInt32 diff) { mPassword.mPos += diff; ShiftFromHost(diff); }
void ShiftFromHost(PRInt32 diff) { mHost.mPos += diff; ShiftFromPath(diff); }
void ShiftFromPath(PRInt32 diff) { mPath.mPos += diff; ShiftFromFilepath(diff); }
void ShiftFromFilepath(PRInt32 diff) { mFilepath.mPos += diff; ShiftFromDirectory(diff); }
void ShiftFromDirectory(PRInt32 diff) { mDirectory.mPos += diff; ShiftFromBasename(diff); }
void ShiftFromBasename(PRInt32 diff) { mBasename.mPos += diff; ShiftFromExtension(diff); }
void ShiftFromExtension(PRInt32 diff) { mExtension.mPos += diff; ShiftFromParam(diff); }
void ShiftFromParam(PRInt32 diff) { mParam.mPos += diff; ShiftFromQuery(diff); }
void ShiftFromQuery(PRInt32 diff) { mQuery.mPos += diff; ShiftFromRef(diff); }
void ShiftFromRef(PRInt32 diff) { mRef.mPos += diff; }
// fastload helper functions
nsresult ReadSegment(nsIBinaryInputStream *, URLSegment &);
nsresult WriteSegment(nsIBinaryOutputStream *, const URLSegment &);
static void PrefsChanged(nsIPrefBranch *prefs, const char *pref);
// IDN routines
static nsresult ACEtoDisplayIDN(const nsCSubstring &in, nsCString &out);
static nsresult UTF8toDisplayIDN(const nsCSubstring &in, nsCString &out);
static PRBool IsInWhitelist(const nsCSubstring &host);
// mSpec contains the normalized version of the URL spec (UTF-8 encoded).
nsCString mSpec;
PRInt32 mDefaultPort;
PRInt32 mPort;
// url parts (relative to mSpec)
URLSegment mScheme;
URLSegment mAuthority;
URLSegment mUsername;
URLSegment mPassword;
URLSegment mHost;
URLSegment mPath;
URLSegment mFilepath;
URLSegment mDirectory;
URLSegment mBasename;
URLSegment mExtension;
URLSegment mParam;
URLSegment mQuery;
URLSegment mRef;
nsCString mOriginCharset;
nsCOMPtr<nsIURLParser> mParser;
// mFile is protected so subclasses can access it directly
protected:
nsCOMPtr<nsIFile> mFile; // cached result for nsIFileURL::GetFile
private:
char *mHostA; // cached result for nsIURI::GetHostA
enum {
eEncoding_Unknown,
eEncoding_ASCII,
eEncoding_UTF8
};
PRUint32 mHostEncoding : 2; // eEncoding_xxx
PRUint32 mSpecEncoding : 2; // eEncoding_xxx
PRUint32 mURLType : 2; // nsIStandardURL::URLTYPE_xxx
PRUint32 mMutable : 1; // nsIStandardURL::mutable
PRUint32 mSupportsFileURL : 1; // QI to nsIFileURL?
// global objects. don't use COMPtr as its destructor will cause a
// coredump if we leak it.
static nsIIDNService *gIDN;
static nsICharsetConverterManager *gCharsetMgr;
static PRBool gInitialized;
static PRBool gEscapeUTF8;
static PRBool gAlwaysEncodeInUTF8;
static PRBool gShowPunycode;
static nsIPrefBranch *gIDNWhitelistPrefBranch;
};
#define NS_THIS_STANDARDURL_IMPL_CID \
{ /* b8e3e97b-1ccd-4b45-af5a-79596770f5d7 */ \
0xb8e3e97b, \
0x1ccd, \
0x4b45, \
{0xaf, 0x5a, 0x79, 0x59, 0x67, 0x70, 0xf5, 0xd7} \
}
//-----------------------------------------------------------------------------
// Dependent substring getters
//-----------------------------------------------------------------------------
inline const nsDependentCSubstring
nsStandardURL::Segment(PRUint32 pos, PRInt32 len)
{
if (len < 0) {
pos = 0;
len = 0;
}
return Substring(mSpec, pos, PRUint32(len));
}
inline const nsDependentCSubstring
nsStandardURL::Prepath()
{
PRUint32 len = 0;
if (mAuthority.mLen >= 0)
len = mAuthority.mPos + mAuthority.mLen;
return Substring(mSpec, 0, len);
}
inline const nsDependentCSubstring
nsStandardURL::Userpass(int includeDelim)
{
PRUint32 pos=0, len=0;
// if there is no username, then there can be no password
if (mUsername.mLen > 0) {
pos = mUsername.mPos;
len = mUsername.mLen;
if (mPassword.mLen >= 0)
len += (mPassword.mLen + 1);
if (includeDelim)
len++;
}
return Substring(mSpec, pos, len);
}
inline const nsDependentCSubstring
nsStandardURL::Hostport()
{
PRUint32 pos=0, len=0;
if (mAuthority.mLen > 0) {
pos = mHost.mPos;
len = mAuthority.mPos + mAuthority.mLen - pos;
}
return Substring(mSpec, pos, len);
}
inline const nsDependentCSubstring
nsStandardURL::Host()
{
PRUint32 pos=0, len=0;
if (mHost.mLen > 0) {
pos = mHost.mPos;
len = mHost.mLen;
if (mSpec.CharAt(pos) == '[' && mSpec.CharAt(pos + len - 1) == ']') {
pos++;
len -= 2;
}
}
return Substring(mSpec, pos, len);
}
inline const nsDependentCSubstring
nsStandardURL::Filename()
{
PRUint32 pos=0, len=0;
// if there is no basename, then there can be no extension
if (mBasename.mLen > 0) {
pos = mBasename.mPos;
len = mBasename.mLen;
if (mExtension.mLen >= 0)
len += (mExtension.mLen + 1);
}
return Substring(mSpec, pos, len);
}
#endif // nsStandardURL_h__