Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(595)

Unified Diff: net/http/http_response_headers.h

Issue 992733002: Remove //net (except for Android test stuff) and sdch (Closed) Base URL: git@github.com:domokit/mojo.git@master
Patch Set: Created 5 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « net/http/http_response_body_drainer_unittest.cc ('k') | net/http/http_response_headers.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: net/http/http_response_headers.h
diff --git a/net/http/http_response_headers.h b/net/http/http_response_headers.h
deleted file mode 100644
index 5b988950adb24b81a8628df85a7b8acdb0eaa227..0000000000000000000000000000000000000000
--- a/net/http/http_response_headers.h
+++ /dev/null
@@ -1,418 +0,0 @@
-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#ifndef NET_HTTP_HTTP_RESPONSE_HEADERS_H_
-#define NET_HTTP_HTTP_RESPONSE_HEADERS_H_
-
-#include <string>
-#include <vector>
-
-#include "base/basictypes.h"
-#include "base/containers/hash_tables.h"
-#include "base/memory/ref_counted.h"
-#include "base/strings/string_piece.h"
-#include "net/base/net_export.h"
-#include "net/base/net_log.h"
-#include "net/http/http_version.h"
-
-class Pickle;
-class PickleIterator;
-
-namespace base {
-class Time;
-class TimeDelta;
-}
-
-namespace net {
-
-class HttpByteRange;
-
-enum ValidationType {
- VALIDATION_NONE, // The resource is fresh.
- VALIDATION_ASYNCHRONOUS, // The resource requires async revalidation.
- VALIDATION_SYNCHRONOUS // The resource requires sync revalidation.
-};
-
-// HttpResponseHeaders: parses and holds HTTP response headers.
-class NET_EXPORT HttpResponseHeaders
- : public base::RefCountedThreadSafe<HttpResponseHeaders> {
- public:
- // Persist options.
- typedef int PersistOptions;
- static const PersistOptions PERSIST_RAW = -1; // Raw, unparsed headers.
- static const PersistOptions PERSIST_ALL = 0; // Parsed headers.
- static const PersistOptions PERSIST_SANS_COOKIES = 1 << 0;
- static const PersistOptions PERSIST_SANS_CHALLENGES = 1 << 1;
- static const PersistOptions PERSIST_SANS_HOP_BY_HOP = 1 << 2;
- static const PersistOptions PERSIST_SANS_NON_CACHEABLE = 1 << 3;
- static const PersistOptions PERSIST_SANS_RANGES = 1 << 4;
- static const PersistOptions PERSIST_SANS_SECURITY_STATE = 1 << 5;
-
- struct FreshnessLifetimes {
- // How long the resource will be fresh for.
- base::TimeDelta freshness;
- // How long after becoming not fresh that the resource will be stale but
- // usable (if async revalidation is enabled).
- base::TimeDelta staleness;
- };
-
- static const char kContentRange[];
-
- // Parses the given raw_headers. raw_headers should be formatted thus:
- // includes the http status response line, each line is \0-terminated, and
- // it's terminated by an empty line (ie, 2 \0s in a row).
- // (Note that line continuations should have already been joined;
- // see HttpUtil::AssembleRawHeaders)
- //
- // HttpResponseHeaders does not perform any encoding changes on the input.
- //
- explicit HttpResponseHeaders(const std::string& raw_headers);
-
- // Initializes from the representation stored in the given pickle. The data
- // for this object is found relative to the given pickle_iter, which should
- // be passed to the pickle's various Read* methods.
- explicit HttpResponseHeaders(PickleIterator* pickle_iter);
-
- // Appends a representation of this object to the given pickle.
- // The options argument can be a combination of PersistOptions.
- void Persist(Pickle* pickle, PersistOptions options);
-
- // Performs header merging as described in 13.5.3 of RFC 2616.
- void Update(const HttpResponseHeaders& new_headers);
-
- // Removes all instances of a particular header.
- void RemoveHeader(const std::string& name);
-
- // Removes a particular header line. The header name is compared
- // case-insensitively.
- void RemoveHeaderLine(const std::string& name, const std::string& value);
-
- // Adds a particular header. |header| has to be a single header without any
- // EOL termination, just [<header-name>: <header-values>]
- // If a header with the same name is already stored, the two headers are not
- // merged together by this method; the one provided is simply put at the
- // end of the list.
- void AddHeader(const std::string& header);
-
- // Replaces the current status line with the provided one (|new_status| should
- // not have any EOL).
- void ReplaceStatusLine(const std::string& new_status);
-
- // Updates headers (Content-Length and Content-Range) in the |headers| to
- // include the right content length and range for |byte_range|. This also
- // updates HTTP status line if |replace_status_line| is true.
- // |byte_range| must have a valid, bounded range (i.e. coming from a valid
- // response or should be usable for a response).
- void UpdateWithNewRange(const HttpByteRange& byte_range,
- int64 resource_size,
- bool replace_status_line);
-
- // Creates a normalized header string. The output will be formatted exactly
- // like so:
- // HTTP/<version> <status_code> <status_text>\n
- // [<header-name>: <header-values>\n]*
- // meaning, each line is \n-terminated, and there is no extra whitespace
- // beyond the single space separators shown (of course, values can contain
- // whitespace within them). If a given header-name appears more than once
- // in the set of headers, they are combined into a single line like so:
- // <header-name>: <header-value1>, <header-value2>, ...<header-valueN>\n
- //
- // DANGER: For some headers (e.g., "Set-Cookie"), the normalized form can be
- // a lossy format. This is due to the fact that some servers generate
- // Set-Cookie headers that contain unquoted commas (usually as part of the
- // value of an "expires" attribute). So, use this function with caution. Do
- // not expect to be able to re-parse Set-Cookie headers from this output.
- //
- // NOTE: Do not make any assumptions about the encoding of this output
- // string. It may be non-ASCII, and the encoding used by the server is not
- // necessarily known to us. Do not assume that this output is UTF-8!
- //
- // TODO(darin): remove this method
- //
- void GetNormalizedHeaders(std::string* output) const;
-
- // Fetch the "normalized" value of a single header, where all values for the
- // header name are separated by commas. See the GetNormalizedHeaders for
- // format details. Returns false if this header wasn't found.
- //
- // NOTE: Do not make any assumptions about the encoding of this output
- // string. It may be non-ASCII, and the encoding used by the server is not
- // necessarily known to us. Do not assume that this output is UTF-8!
- //
- // TODO(darin): remove this method
- //
- bool GetNormalizedHeader(const std::string& name, std::string* value) const;
-
- // Returns the normalized status line. For HTTP/0.9 responses (i.e.,
- // responses that lack a status line), this is the manufactured string
- // "HTTP/0.9 200 OK".
- std::string GetStatusLine() const;
-
- // Get the HTTP version of the normalized status line.
- HttpVersion GetHttpVersion() const {
- return http_version_;
- }
-
- // Get the HTTP version determined while parsing; or (0,0) if parsing failed
- HttpVersion GetParsedHttpVersion() const {
- return parsed_http_version_;
- }
-
- // Get the HTTP status text of the normalized status line.
- std::string GetStatusText() const;
-
- // Enumerate the "lines" of the response headers. This skips over the status
- // line. Use GetStatusLine if you are interested in that. Note that this
- // method returns the un-coalesced response header lines, so if a response
- // header appears on multiple lines, then it will appear multiple times in
- // this enumeration (in the order the header lines were received from the
- // server). Also, a given header might have an empty value. Initialize a
- // 'void*' variable to NULL and pass it by address to EnumerateHeaderLines.
- // Call EnumerateHeaderLines repeatedly until it returns false. The
- // out-params 'name' and 'value' are set upon success.
- bool EnumerateHeaderLines(void** iter,
- std::string* name,
- std::string* value) const;
-
- // Enumerate the values of the specified header. If you are only interested
- // in the first header, then you can pass NULL for the 'iter' parameter.
- // Otherwise, to iterate across all values for the specified header,
- // initialize a 'void*' variable to NULL and pass it by address to
- // EnumerateHeader. Note that a header might have an empty value. Call
- // EnumerateHeader repeatedly until it returns false.
- bool EnumerateHeader(void** iter,
- const base::StringPiece& name,
- std::string* value) const;
-
- // Returns true if the response contains the specified header-value pair.
- // Both name and value are compared case insensitively.
- bool HasHeaderValue(const base::StringPiece& name,
- const base::StringPiece& value) const;
-
- // Returns true if the response contains the specified header.
- // The name is compared case insensitively.
- bool HasHeader(const base::StringPiece& name) const;
-
- // Get the mime type and charset values in lower case form from the headers.
- // Empty strings are returned if the values are not present.
- void GetMimeTypeAndCharset(std::string* mime_type,
- std::string* charset) const;
-
- // Get the mime type in lower case from the headers. If there's no mime
- // type, returns false.
- bool GetMimeType(std::string* mime_type) const;
-
- // Get the charset in lower case from the headers. If there's no charset,
- // returns false.
- bool GetCharset(std::string* charset) const;
-
- // Returns true if this response corresponds to a redirect. The target
- // location of the redirect is optionally returned if location is non-null.
- bool IsRedirect(std::string* location) const;
-
- // Returns true if the HTTP response code passed in corresponds to a
- // redirect.
- static bool IsRedirectResponseCode(int response_code);
-
- // Returns VALIDATION_NONE if the response can be reused without
- // validation. VALIDATION_ASYNCHRONOUS means the response can be re-used, but
- // asynchronous revalidation must be performed. VALIDATION_SYNCHRONOUS means
- // that the result cannot be reused without revalidation.
- // The result is relative to the current_time parameter, which is
- // a parameter to support unit testing. The request_time parameter indicates
- // the time at which the request was made that resulted in this response,
- // which was received at response_time.
- ValidationType RequiresValidation(const base::Time& request_time,
- const base::Time& response_time,
- const base::Time& current_time) const;
-
- // Calculates the amount of time the server claims the response is fresh from
- // the time the response was generated. See section 13.2.4 of RFC 2616. See
- // RequiresValidation for a description of the response_time parameter. See
- // the definition of FreshnessLifetimes above for the meaning of the return
- // value. See RFC 5861 section 3 for the definition of
- // stale-while-revalidate.
- FreshnessLifetimes GetFreshnessLifetimes(
- const base::Time& response_time) const;
-
- // Returns the age of the response. See section 13.2.3 of RFC 2616.
- // See RequiresValidation for a description of this method's parameters.
- base::TimeDelta GetCurrentAge(const base::Time& request_time,
- const base::Time& response_time,
- const base::Time& current_time) const;
-
- // The following methods extract values from the response headers. If a
- // value is not present, then false is returned. Otherwise, true is returned
- // and the out param is assigned to the corresponding value.
- bool GetMaxAgeValue(base::TimeDelta* value) const;
- bool GetAgeValue(base::TimeDelta* value) const;
- bool GetDateValue(base::Time* value) const;
- bool GetLastModifiedValue(base::Time* value) const;
- bool GetExpiresValue(base::Time* value) const;
- bool GetStaleWhileRevalidateValue(base::TimeDelta* value) const;
-
- // Extracts the time value of a particular header. This method looks for the
- // first matching header value and parses its value as a HTTP-date.
- bool GetTimeValuedHeader(const std::string& name, base::Time* result) const;
-
- // Determines if this response indicates a keep-alive connection.
- bool IsKeepAlive() const;
-
- // Returns true if this response has a strong etag or last-modified header.
- // See section 13.3.3 of RFC 2616.
- bool HasStrongValidators() const;
-
- // Extracts the value of the Content-Length header or returns -1 if there is
- // no such header in the response.
- int64 GetContentLength() const;
-
- // Extracts the value of the specified header or returns -1 if there is no
- // such header in the response.
- int64 GetInt64HeaderValue(const std::string& header) const;
-
- // Extracts the values in a Content-Range header and returns true if they are
- // valid for a 206 response; otherwise returns false.
- // The following values will be outputted:
- // |*first_byte_position| = inclusive position of the first byte of the range
- // |*last_byte_position| = inclusive position of the last byte of the range
- // |*instance_length| = size in bytes of the object requested
- // If any of the above values is unknown, its value will be -1.
- bool GetContentRange(int64* first_byte_position,
- int64* last_byte_position,
- int64* instance_length) const;
-
- // Returns true if the response is chunk-encoded.
- bool IsChunkEncoded() const;
-
- // Creates a Value for use with the NetLog containing the response headers.
- base::Value* NetLogCallback(NetLog::LogLevel log_level) const;
-
- // Takes in a Value created by the above function, and attempts to create a
- // copy of the original headers. Returns true on success. On failure,
- // clears |http_response_headers|.
- // TODO(mmenke): Long term, we want to remove this, and migrate external
- // consumers to be NetworkDelegates.
- static bool FromNetLogParam(
- const base::Value* event_param,
- scoped_refptr<HttpResponseHeaders>* http_response_headers);
-
- // Returns the HTTP response code. This is 0 if the response code text seems
- // to exist but could not be parsed. Otherwise, it defaults to 200 if the
- // response code is not found in the raw headers.
- int response_code() const { return response_code_; }
-
- // Returns the raw header string.
- const std::string& raw_headers() const { return raw_headers_; }
-
- private:
- friend class base::RefCountedThreadSafe<HttpResponseHeaders>;
-
- typedef base::hash_set<std::string> HeaderSet;
-
- // The members of this structure point into raw_headers_.
- struct ParsedHeader;
- typedef std::vector<ParsedHeader> HeaderList;
-
- HttpResponseHeaders();
- ~HttpResponseHeaders();
-
- // Initializes from the given raw headers.
- void Parse(const std::string& raw_input);
-
- // Helper function for ParseStatusLine.
- // Tries to extract the "HTTP/X.Y" from a status line formatted like:
- // HTTP/1.1 200 OK
- // with line_begin and end pointing at the begin and end of this line. If the
- // status line is malformed, returns HttpVersion(0,0).
- static HttpVersion ParseVersion(std::string::const_iterator line_begin,
- std::string::const_iterator line_end);
-
- // Tries to extract the status line from a header block, given the first
- // line of said header block. If the status line is malformed, we'll
- // construct a valid one. Example input:
- // HTTP/1.1 200 OK
- // with line_begin and end pointing at the begin and end of this line.
- // Output will be a normalized version of this.
- void ParseStatusLine(std::string::const_iterator line_begin,
- std::string::const_iterator line_end,
- bool has_headers);
-
- // Find the header in our list (case-insensitive) starting with parsed_ at
- // index |from|. Returns string::npos if not found.
- size_t FindHeader(size_t from, const base::StringPiece& name) const;
-
- // Search the Cache-Control header for a directive matching |directive|. If
- // present, treat its value as a time offset in seconds, write it to |result|,
- // and return true.
- bool GetCacheControlDirective(const base::StringPiece& directive,
- base::TimeDelta* result) const;
-
- // Add a header->value pair to our list. If we already have header in our
- // list, append the value to it.
- void AddHeader(std::string::const_iterator name_begin,
- std::string::const_iterator name_end,
- std::string::const_iterator value_begin,
- std::string::const_iterator value_end);
-
- // Add to parsed_ given the fields of a ParsedHeader object.
- void AddToParsed(std::string::const_iterator name_begin,
- std::string::const_iterator name_end,
- std::string::const_iterator value_begin,
- std::string::const_iterator value_end);
-
- // Replaces the current headers with the merged version of |raw_headers| and
- // the current headers without the headers in |headers_to_remove|. Note that
- // |headers_to_remove| are removed from the current headers (before the
- // merge), not after the merge.
- void MergeWithHeaders(const std::string& raw_headers,
- const HeaderSet& headers_to_remove);
-
- // Adds the values from any 'cache-control: no-cache="foo,bar"' headers.
- void AddNonCacheableHeaders(HeaderSet* header_names) const;
-
- // Adds the set of header names that contain cookie values.
- static void AddSensitiveHeaders(HeaderSet* header_names);
-
- // Adds the set of rfc2616 hop-by-hop response headers.
- static void AddHopByHopHeaders(HeaderSet* header_names);
-
- // Adds the set of challenge response headers.
- static void AddChallengeHeaders(HeaderSet* header_names);
-
- // Adds the set of cookie response headers.
- static void AddCookieHeaders(HeaderSet* header_names);
-
- // Adds the set of content range response headers.
- static void AddHopContentRangeHeaders(HeaderSet* header_names);
-
- // Adds the set of transport security state headers.
- static void AddSecurityStateHeaders(HeaderSet* header_names);
-
- // We keep a list of ParsedHeader objects. These tell us where to locate the
- // header-value pairs within raw_headers_.
- HeaderList parsed_;
-
- // The raw_headers_ consists of the normalized status line (terminated with a
- // null byte) and then followed by the raw null-terminated headers from the
- // input that was passed to our constructor. We preserve the input [*] to
- // maintain as much ancillary fidelity as possible (since it is sometimes
- // hard to tell what may matter down-stream to a consumer of XMLHttpRequest).
- // [*] The status line may be modified.
- std::string raw_headers_;
-
- // This is the parsed HTTP response code.
- int response_code_;
-
- // The normalized http version (consistent with what GetStatusLine() returns).
- HttpVersion http_version_;
-
- // The parsed http version number (not normalized).
- HttpVersion parsed_http_version_;
-
- DISALLOW_COPY_AND_ASSIGN(HttpResponseHeaders);
-};
-
-} // namespace net
-
-#endif // NET_HTTP_HTTP_RESPONSE_HEADERS_H_
« no previous file with comments | « net/http/http_response_body_drainer_unittest.cc ('k') | net/http/http_response_headers.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698