fune/netwerk/protocol/http/PHttpChannelParams.h
Tim Huang 949f77d58f Bug 1877405 - Adding a eVarietyRequestEnforceDefault to nsHttpHeaderArray::HeaderVariety r=necko-reviewers,devtools-reviewers,bomsy,kershaw
Adding a new HeaderVariety called eVarietyRequestEnforceDefault. It
allows setting request header value as default even even if the header
exists.

We need this to setting default header value without changing the order
of the header.

Differential Revision: https://phabricator.services.mozilla.com/D199991
2024-01-31 22:09:11 +00:00

290 lines
9.6 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 ts=8 et tw=80 : */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_net_PHttpChannelParams_h
#define mozilla_net_PHttpChannelParams_h
#define ALLOW_LATE_NSHTTP_H_INCLUDE 1
#include "base/basictypes.h"
#include "ipc/IPCMessageUtils.h"
#include "ipc/IPCMessageUtilsSpecializations.h"
#include "nsHttp.h"
#include "nsHttpHeaderArray.h"
#include "nsHttpRequestHead.h"
#include "nsHttpResponseHead.h"
namespace mozilla {
namespace net {
struct RequestHeaderTuple {
nsCString mHeader;
nsCString mValue;
bool mMerge;
bool mEmpty;
bool operator==(const RequestHeaderTuple& other) const {
return mHeader.Equals(other.mHeader) && mValue.Equals(other.mValue) &&
mMerge == other.mMerge && mEmpty == other.mEmpty;
}
};
typedef CopyableTArray<RequestHeaderTuple> RequestHeaderTuples;
} // namespace net
} // namespace mozilla
namespace IPC {
template <>
struct ParamTraits<mozilla::net::RequestHeaderTuple> {
typedef mozilla::net::RequestHeaderTuple paramType;
static void Write(MessageWriter* aWriter, const paramType& aParam) {
WriteParam(aWriter, aParam.mHeader);
WriteParam(aWriter, aParam.mValue);
WriteParam(aWriter, aParam.mMerge);
WriteParam(aWriter, aParam.mEmpty);
}
static bool Read(MessageReader* aReader, paramType* aResult) {
if (!ReadParam(aReader, &aResult->mHeader) ||
!ReadParam(aReader, &aResult->mValue) ||
!ReadParam(aReader, &aResult->mMerge) ||
!ReadParam(aReader, &aResult->mEmpty))
return false;
return true;
}
};
template <>
struct ParamTraits<mozilla::net::nsHttpAtom> {
typedef mozilla::net::nsHttpAtom paramType;
static void Write(MessageWriter* aWriter, const paramType& aParam) {
// aParam.get() cannot be null.
MOZ_ASSERT(aParam.get(), "null nsHTTPAtom value");
nsAutoCString value(aParam.get());
WriteParam(aWriter, value);
}
static bool Read(MessageReader* aReader, paramType* aResult) {
nsAutoCString value;
if (!ReadParam(aReader, &value)) return false;
*aResult = mozilla::net::nsHttp::ResolveAtom(value);
MOZ_ASSERT(aResult->get(), "atom table not initialized");
return true;
}
};
template <>
struct ParamTraits<mozilla::net::nsHttpHeaderArray::nsEntry> {
typedef mozilla::net::nsHttpHeaderArray::nsEntry paramType;
static void Write(MessageWriter* aWriter, const paramType& aParam) {
if (aParam.headerNameOriginal.IsEmpty()) {
WriteParam(aWriter, aParam.header);
} else {
WriteParam(aWriter, aParam.headerNameOriginal);
}
WriteParam(aWriter, aParam.value);
switch (aParam.variety) {
case mozilla::net::nsHttpHeaderArray::eVarietyUnknown:
WriteParam(aWriter, (uint8_t)0);
break;
case mozilla::net::nsHttpHeaderArray::eVarietyRequestOverride:
WriteParam(aWriter, (uint8_t)1);
break;
case mozilla::net::nsHttpHeaderArray::eVarietyRequestDefault:
WriteParam(aWriter, (uint8_t)2);
break;
case mozilla::net::nsHttpHeaderArray::eVarietyRequestEnforceDefault:
WriteParam(aWriter, (uint8_t)3);
break;
case mozilla::net::nsHttpHeaderArray::
eVarietyResponseNetOriginalAndResponse:
WriteParam(aWriter, (uint8_t)4);
break;
case mozilla::net::nsHttpHeaderArray::eVarietyResponseNetOriginal:
WriteParam(aWriter, (uint8_t)5);
break;
case mozilla::net::nsHttpHeaderArray::eVarietyResponse:
WriteParam(aWriter, (uint8_t)6);
}
}
static bool Read(MessageReader* aReader, paramType* aResult) {
uint8_t variety;
nsAutoCString header;
if (!ReadParam(aReader, &header) || !ReadParam(aReader, &aResult->value) ||
!ReadParam(aReader, &variety))
return false;
mozilla::net::nsHttpAtom atom = mozilla::net::nsHttp::ResolveAtom(header);
aResult->header = atom;
if (!header.Equals(atom.get())) {
aResult->headerNameOriginal = header;
}
switch (variety) {
case 0:
aResult->variety = mozilla::net::nsHttpHeaderArray::eVarietyUnknown;
break;
case 1:
aResult->variety =
mozilla::net::nsHttpHeaderArray::eVarietyRequestOverride;
break;
case 2:
aResult->variety =
mozilla::net::nsHttpHeaderArray::eVarietyRequestDefault;
break;
case 3:
aResult->variety =
mozilla::net::nsHttpHeaderArray::eVarietyRequestEnforceDefault;
break;
case 4:
aResult->variety = mozilla::net::nsHttpHeaderArray::
eVarietyResponseNetOriginalAndResponse;
break;
case 5:
aResult->variety =
mozilla::net::nsHttpHeaderArray::eVarietyResponseNetOriginal;
break;
case 6:
aResult->variety = mozilla::net::nsHttpHeaderArray::eVarietyResponse;
break;
default:
return false;
}
return true;
}
};
template <>
struct ParamTraits<mozilla::net::nsHttpHeaderArray> {
typedef mozilla::net::nsHttpHeaderArray paramType;
static void Write(MessageWriter* aWriter, const paramType& aParam) {
paramType& p = const_cast<paramType&>(aParam);
WriteParam(aWriter, p.mHeaders);
}
static bool Read(MessageReader* aReader, paramType* aResult) {
if (!ReadParam(aReader, &aResult->mHeaders)) return false;
return true;
}
};
template <>
struct ParamTraits<mozilla::net::nsHttpRequestHead> {
typedef mozilla::net::nsHttpRequestHead paramType;
static void Write(MessageWriter* aWriter,
const paramType& aParam) MOZ_NO_THREAD_SAFETY_ANALYSIS {
aParam.Enter();
WriteParam(aWriter, aParam.mHeaders);
WriteParam(aWriter, aParam.mMethod);
WriteParam(aWriter, static_cast<uint32_t>(aParam.mVersion));
WriteParam(aWriter, aParam.mRequestURI);
WriteParam(aWriter, aParam.mPath);
WriteParam(aWriter, aParam.mOrigin);
WriteParam(aWriter, static_cast<uint8_t>(aParam.mParsedMethod));
WriteParam(aWriter, aParam.mHTTPS);
aParam.Exit();
}
static bool Read(MessageReader* aReader, paramType* aResult) {
uint32_t version;
uint8_t method;
aResult->Enter();
if (!ReadParam(aReader, &aResult->mHeaders) ||
!ReadParam(aReader, &aResult->mMethod) ||
!ReadParam(aReader, &version) ||
!ReadParam(aReader, &aResult->mRequestURI) ||
!ReadParam(aReader, &aResult->mPath) ||
!ReadParam(aReader, &aResult->mOrigin) ||
!ReadParam(aReader, &method) || !ReadParam(aReader, &aResult->mHTTPS)) {
aResult->Exit();
return false;
}
aResult->mVersion = static_cast<mozilla::net::HttpVersion>(version);
aResult->mParsedMethod =
static_cast<mozilla::net::nsHttpRequestHead::ParsedMethodType>(method);
aResult->Exit();
return true;
}
};
// Note that the code below MUST be synchronized with the code in
// nsHttpRequestHead's copy constructor.
template <>
struct ParamTraits<mozilla::net::nsHttpResponseHead> {
typedef mozilla::net::nsHttpResponseHead paramType;
static void Write(MessageWriter* aWriter,
const paramType& aParam) MOZ_NO_THREAD_SAFETY_ANALYSIS {
aParam.Enter();
WriteParam(aWriter, aParam.mHeaders);
WriteParam(aWriter, static_cast<uint32_t>(aParam.mVersion));
WriteParam(aWriter, aParam.mStatus);
WriteParam(aWriter, aParam.mStatusText);
WriteParam(aWriter, aParam.mContentLength);
WriteParam(aWriter, aParam.mContentType);
WriteParam(aWriter, aParam.mContentCharset);
WriteParam(aWriter, aParam.mHasCacheControl);
WriteParam(aWriter, aParam.mCacheControlPublic);
WriteParam(aWriter, aParam.mCacheControlPrivate);
WriteParam(aWriter, aParam.mCacheControlNoStore);
WriteParam(aWriter, aParam.mCacheControlNoCache);
WriteParam(aWriter, aParam.mCacheControlImmutable);
WriteParam(aWriter, aParam.mCacheControlStaleWhileRevalidateSet);
WriteParam(aWriter, aParam.mCacheControlStaleWhileRevalidate);
WriteParam(aWriter, aParam.mCacheControlMaxAgeSet);
WriteParam(aWriter, aParam.mCacheControlMaxAge);
WriteParam(aWriter, aParam.mPragmaNoCache);
aParam.Exit();
}
static bool Read(MessageReader* aReader, paramType* aResult) {
uint32_t version;
aResult->Enter();
if (!ReadParam(aReader, &aResult->mHeaders) ||
!ReadParam(aReader, &version) ||
!ReadParam(aReader, &aResult->mStatus) ||
!ReadParam(aReader, &aResult->mStatusText) ||
!ReadParam(aReader, &aResult->mContentLength) ||
!ReadParam(aReader, &aResult->mContentType) ||
!ReadParam(aReader, &aResult->mContentCharset) ||
!ReadParam(aReader, &aResult->mHasCacheControl) ||
!ReadParam(aReader, &aResult->mCacheControlPublic) ||
!ReadParam(aReader, &aResult->mCacheControlPrivate) ||
!ReadParam(aReader, &aResult->mCacheControlNoStore) ||
!ReadParam(aReader, &aResult->mCacheControlNoCache) ||
!ReadParam(aReader, &aResult->mCacheControlImmutable) ||
!ReadParam(aReader, &aResult->mCacheControlStaleWhileRevalidateSet) ||
!ReadParam(aReader, &aResult->mCacheControlStaleWhileRevalidate) ||
!ReadParam(aReader, &aResult->mCacheControlMaxAgeSet) ||
!ReadParam(aReader, &aResult->mCacheControlMaxAge) ||
!ReadParam(aReader, &aResult->mPragmaNoCache)) {
aResult->Exit();
return false;
}
aResult->mVersion = static_cast<mozilla::net::HttpVersion>(version);
aResult->Exit();
return true;
}
};
} // namespace IPC
#endif // mozilla_net_PHttpChannelParams_h