2007-03-22 10:30:00 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* vim:set ts=4 sw=4 sts=4 et cin: */
|
|
|
|
/* ***** 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.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2001
|
|
|
|
* 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 nsHttp_h__
|
|
|
|
#define nsHttp_h__
|
|
|
|
|
|
|
|
#if defined(MOZ_LOGGING)
|
|
|
|
#define FORCE_PR_LOG
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include "plstr.h"
|
|
|
|
#include "prlog.h"
|
|
|
|
#include "prtime.h"
|
|
|
|
#include "nsISupportsUtils.h"
|
|
|
|
#include "nsPromiseFlatString.h"
|
|
|
|
#include "nsURLHelper.h"
|
|
|
|
#include "netCore.h"
|
|
|
|
|
|
|
|
#if defined(PR_LOGGING)
|
|
|
|
//
|
|
|
|
// Log module for HTTP Protocol logging...
|
|
|
|
//
|
|
|
|
// To enable logging (see prlog.h for full details):
|
|
|
|
//
|
|
|
|
// set NSPR_LOG_MODULES=nsHttp:5
|
|
|
|
// set NSPR_LOG_FILE=http.log
|
|
|
|
//
|
|
|
|
// this enables PR_LOG_ALWAYS level information and places all output in
|
|
|
|
// the file http.log
|
|
|
|
//
|
|
|
|
extern PRLogModuleInfo *gHttpLog;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
// http logging
|
|
|
|
#define LOG1(args) PR_LOG(gHttpLog, 1, args)
|
|
|
|
#define LOG2(args) PR_LOG(gHttpLog, 2, args)
|
|
|
|
#define LOG3(args) PR_LOG(gHttpLog, 3, args)
|
|
|
|
#define LOG4(args) PR_LOG(gHttpLog, 4, args)
|
|
|
|
#define LOG(args) LOG4(args)
|
|
|
|
|
|
|
|
#define LOG1_ENABLED() PR_LOG_TEST(gHttpLog, 1)
|
|
|
|
#define LOG2_ENABLED() PR_LOG_TEST(gHttpLog, 2)
|
|
|
|
#define LOG3_ENABLED() PR_LOG_TEST(gHttpLog, 3)
|
|
|
|
#define LOG4_ENABLED() PR_LOG_TEST(gHttpLog, 4)
|
|
|
|
#define LOG_ENABLED() LOG4_ENABLED()
|
|
|
|
|
|
|
|
// http version codes
|
|
|
|
#define NS_HTTP_VERSION_UNKNOWN 0
|
|
|
|
#define NS_HTTP_VERSION_0_9 9
|
|
|
|
#define NS_HTTP_VERSION_1_0 10
|
|
|
|
#define NS_HTTP_VERSION_1_1 11
|
|
|
|
|
|
|
|
typedef PRUint8 nsHttpVersion;
|
|
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// http connection capabilities
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
#define NS_HTTP_ALLOW_KEEPALIVE (1<<0)
|
|
|
|
#define NS_HTTP_ALLOW_PIPELINING (1<<1)
|
|
|
|
|
|
|
|
// a transaction with this caps flag will continue to own the connection,
|
|
|
|
// preventing it from being reclaimed, even after the transaction completes.
|
|
|
|
#define NS_HTTP_STICKY_CONNECTION (1<<2)
|
|
|
|
|
2008-11-04 08:05:46 -08:00
|
|
|
// a transaction with this caps flag will, upon opening a new connection,
|
|
|
|
// bypass the local DNS cache
|
|
|
|
#define NS_HTTP_REFRESH_DNS (1<<3)
|
|
|
|
|
2009-02-17 14:06:52 -08:00
|
|
|
// a transaction with this caps flag will not pass SSL client-certificates
|
|
|
|
// to the server (see bug #466080), but is may also be used for other things
|
|
|
|
#define NS_HTTP_LOAD_ANONYMOUS (1<<4)
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// some default values
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
// hard upper limit on the number of requests that can be pipelined
|
|
|
|
#define NS_HTTP_MAX_PIPELINED_REQUESTS 8
|
|
|
|
|
|
|
|
#define NS_HTTP_DEFAULT_PORT 80
|
|
|
|
#define NS_HTTPS_DEFAULT_PORT 443
|
|
|
|
|
|
|
|
#define NS_HTTP_HEADER_SEPS ", \t"
|
|
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// http atoms...
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
struct nsHttpAtom
|
|
|
|
{
|
|
|
|
operator const char *() const { return _val; }
|
|
|
|
const char *get() const { return _val; }
|
|
|
|
|
|
|
|
void operator=(const char *v) { _val = v; }
|
|
|
|
void operator=(const nsHttpAtom &a) { _val = a._val; }
|
|
|
|
|
|
|
|
// private
|
|
|
|
const char *_val;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct nsHttp
|
|
|
|
{
|
|
|
|
static nsresult CreateAtomTable();
|
|
|
|
static void DestroyAtomTable();
|
|
|
|
|
|
|
|
// will dynamically add atoms to the table if they don't already exist
|
|
|
|
static nsHttpAtom ResolveAtom(const char *);
|
|
|
|
static nsHttpAtom ResolveAtom(const nsACString &s)
|
|
|
|
{
|
|
|
|
return ResolveAtom(PromiseFlatCString(s).get());
|
|
|
|
}
|
|
|
|
|
|
|
|
// returns true if the specified token [start,end) is valid per RFC 2616
|
|
|
|
// section 2.2
|
|
|
|
static PRBool IsValidToken(const char *start, const char *end);
|
|
|
|
|
|
|
|
static inline PRBool IsValidToken(const nsCString &s) {
|
|
|
|
const char *start = s.get();
|
|
|
|
return IsValidToken(start, start + s.Length());
|
|
|
|
}
|
|
|
|
|
|
|
|
// find the first instance (case-insensitive comparison) of the given
|
|
|
|
// |token| in the |input| string. the |token| is bounded by elements of
|
|
|
|
// |separators| and may appear at the beginning or end of the |input|
|
|
|
|
// string. null is returned if the |token| is not found. |input| may be
|
|
|
|
// null, in which case null is returned.
|
|
|
|
static const char *FindToken(const char *input, const char *token,
|
|
|
|
const char *separators);
|
|
|
|
|
|
|
|
// This function parses a string containing a decimal-valued, non-negative
|
|
|
|
// 64-bit integer. If the value would exceed LL_MAXINT, then PR_FALSE is
|
|
|
|
// returned. Otherwise, this function returns PR_TRUE and stores the
|
|
|
|
// parsed value in |result|. The next unparsed character in |input| is
|
|
|
|
// optionally returned via |next| if |next| is non-null.
|
|
|
|
//
|
|
|
|
// TODO(darin): Replace this with something generic.
|
|
|
|
//
|
|
|
|
static PRBool ParseInt64(const char *input, const char **next,
|
|
|
|
PRInt64 *result);
|
|
|
|
|
|
|
|
// Variant on ParseInt64 that expects the input string to contain nothing
|
|
|
|
// more than the value being parsed.
|
|
|
|
static inline PRBool ParseInt64(const char *input, PRInt64 *result) {
|
|
|
|
const char *next;
|
|
|
|
return ParseInt64(input, &next, result) && *next == '\0';
|
|
|
|
}
|
|
|
|
|
|
|
|
// Declare all atoms
|
|
|
|
//
|
|
|
|
// The atom names and values are stored in nsHttpAtomList.h and are brought
|
|
|
|
// to you by the magic of C preprocessing. Add new atoms to nsHttpAtomList
|
|
|
|
// and all support logic will be auto-generated.
|
|
|
|
//
|
|
|
|
#define HTTP_ATOM(_name, _value) static nsHttpAtom _name;
|
|
|
|
#include "nsHttpAtomList.h"
|
|
|
|
#undef HTTP_ATOM
|
|
|
|
};
|
|
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// utilities...
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
static inline PRUint32
|
|
|
|
PRTimeToSeconds(PRTime t_usec)
|
|
|
|
{
|
|
|
|
return PRUint32( t_usec / PR_USEC_PER_SEC );
|
|
|
|
}
|
|
|
|
|
|
|
|
#define NowInSeconds() PRTimeToSeconds(PR_Now())
|
|
|
|
|
|
|
|
// round q-value to one decimal place; return most significant digit as uint.
|
|
|
|
#define QVAL_TO_UINT(q) ((unsigned int) ((q + 0.05) * 10.0))
|
|
|
|
|
|
|
|
#define HTTP_LWS " \t"
|
|
|
|
#define HTTP_HEADER_VALUE_SEPS HTTP_LWS ","
|
|
|
|
|
|
|
|
#endif // nsHttp_h__
|