14e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 54e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#ifndef NET_TOOLS_BALSA_BALSA_HEADERS_H_ 64e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#define NET_TOOLS_BALSA_BALSA_HEADERS_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <algorithm> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <iosfwd> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <iterator> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <utility> 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "base/port.h" 17c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "base/strings/string_piece.h" 184e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "net/tools/balsa/balsa_enums.h" 194e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "net/tools/balsa/string_piece_utils.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// WARNING: 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Note that -no- char* returned by any function in this 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// file is null-terminated. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class exists to service the specific needs of BalsaHeaders. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Functional goals: 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 1) provide a backing-store for all of the StringPieces that BalsaHeaders 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// returns. Every StringPiece returned from BalsaHeaders should remain 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// valid until the BalsaHeader's object is cleared, or the header-line is 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// erased. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 2) provide a backing-store for BalsaFrame, which requires contiguous memory 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// for its fast-path parsing functions. Note that the cost of copying is 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// less than the cost of requiring the parser to do slow-path parsing, as 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// it would have to check for bounds every byte, instead of every 16 bytes. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class is optimized for the case where headers are stored in one of two 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// buffers. It doesn't make a lot of effort to densely pack memory-- in fact, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// it -may- be somewhat memory inefficient. This possible inefficiency allows a 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// certain simplicity of implementation and speed which makes it worthwhile. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// If, in the future, better memory density is required, it should be possible 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to reuse the abstraction presented by this object to achieve those goals. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// In the most common use-case, this memory inefficiency should be relatively 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// small. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Alternate implementations of BalsaBuffer may include: 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - vector of strings, one per header line (similar to HTTPHeaders) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - densely packed strings: 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - keep a sorted array/map of free-space linked lists or numbers. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - use the entry that most closely first your needs. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - at this point, perhaps just use a vector of strings, and let 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the allocator do the right thing. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BalsaBuffer { 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const size_t kDefaultBlocksize = 4096; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We have two friends here. These exist as friends as we 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // want to allow access to the constructors for the test 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // class and the Balsa* classes. We put this into the 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // header file as we want this class to be inlined into the 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BalsaHeaders implementation, yet be testable. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaBufferTestSpouse; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaHeaders; 67ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch friend class BalsaBufferTest; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The BufferBlock is a structure used internally by the 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BalsaBuffer class to store the base buffer pointers to 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // each block, as well as the important metadata for buffer 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // sizes and bytes free. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct BufferBlock { 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* buffer; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t buffer_size; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bytes_free; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bytes_used() const { 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return buffer_size - bytes_free; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* start_of_unused_bytes() const { 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return buffer + bytes_used(); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BufferBlock() : buffer(NULL), buffer_size(0), bytes_free(0) {} 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~BufferBlock() {} 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BufferBlock(char* buf, size_t size, size_t free) : 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer(buf), buffer_size(size), bytes_free(free) {} 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Yes we want this to be copyable (it gets stuck into vectors). 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For this reason, we don't use scoped ptrs, etc. here-- it 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is more efficient to manage this memory externally to this 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // object. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<BufferBlock> Blocks; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~BalsaBuffer(); 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the total amount of memory used by the buffer blocks. 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetTotalBufferBlockSize() const; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* GetPtr(Blocks::size_type block_idx) const { 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_LT(block_idx, blocks_.size()) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) << block_idx << ", " << blocks_.size(); 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return blocks_[block_idx].buffer; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* GetPtr(Blocks::size_type block_idx) { 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_LT(block_idx, blocks_.size()) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) << block_idx << ", " << blocks_.size(); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return blocks_[block_idx].buffer; 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function is different from Write(), as it ensures that the data 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // stored via subsequent calls to this function are all contiguous (and in 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the order in which these writes happened). This is essentially the same 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // as a string append. 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // You may call this function at any time between object 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // construction/Clear(), and the calling of the 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NoMoreWriteToContiguousBuffer() function. 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // You must not call this function after the NoMoreWriteToContiguousBuffer() 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // function is called, unless a Clear() has been called since. 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If you do, the program will abort(). 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This condition is placed upon this code so that calls to Write() can 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // append to the buffer in the first block safely, and without invaliding 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the StringPiece which it returns. 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function's main intended user is the BalsaFrame class, which, 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for reasons of efficiency, requires that the buffer from which it parses 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the headers be contiguous. 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteToContiguousBuffer(const base::StringPiece& sp); 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void NoMoreWriteToContiguousBuffer() { 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) can_write_to_contiguous_buffer_ = false; 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Takes a StringPiece and writes it to "permanent" storage, then returns a 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // StringPiece which points to that data. If block_idx != NULL, it will be 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // assigned the index of the block into which the data was stored. 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that the 'permanent' storage in which it stores data may be in 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the first block IFF the NoMoreWriteToContiguousBuffer function has 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // been called since the last Clear/Construction. 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece Write(const base::StringPiece& sp, 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Blocks::size_type* block_buffer_idx); 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Reserves "permanent" storage of the size indicated. Returns a pointer to 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the beginning of that storage, and assigns the index of the block used to 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // block_buffer_idx. This function uses the first block IFF the 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NoMoreWriteToContiguousBuffer function has been called since the last 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Clear/Construction. 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* Reserve(size_t size, Blocks::size_type* block_buffer_idx); 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Clear(); 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Swap(BalsaBuffer* b); 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyFrom(const BalsaBuffer& b); 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* StartOfFirstBlock() const { 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return blocks_[0].buffer; 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* EndOfFirstBlock() const { 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return blocks_[0].buffer + blocks_[0].bytes_used(); 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool can_write_to_contiguous_buffer() const { 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return can_write_to_contiguous_buffer_; 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t blocksize() const { return blocksize_; } 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Blocks::size_type num_blocks() const { return blocks_.size(); } 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t buffer_size(size_t idx) const { return blocks_[idx].buffer_size; } 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bytes_used(size_t idx) const { return blocks_[idx].bytes_used(); } 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaBuffer(); 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit BalsaBuffer(size_t blocksize); 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BufferBlock AllocBlock(); 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BufferBlock AllocCustomBlock(size_t blocksize); 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BufferBlock CopyBlock(const BufferBlock& b); 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Cleans up the object. 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The block at start_idx, and all subsequent blocks 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be cleared and have associated memory deleted. 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CleanupBlocksStartingFrom(Blocks::size_type start_idx); 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A container of BufferBlocks 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Blocks blocks_; 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The default allocation size for a block. 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In general, blocksize_ bytes will be allocated for 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // each buffer. 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t blocksize_; 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If set to true, then the first block cannot be used for Write() calls as 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the WriteToContiguous... function will modify the base pointer for this 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // block, and the Write() calls need to be sure that the base pointer will 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // not be changing in order to provide the user with StringPieces which 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // continue to be valid. 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool can_write_to_contiguous_buffer_; 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All of the functions in the BalsaHeaders class use string pieces, by either 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// using the StringPiece class, or giving an explicit size and char* (as these 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// are the native representation for these string pieces). 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This is done for several reasons. 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 1) This minimizes copying/allocation/deallocation as compared to using 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// string parameters 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 2) This reduces the number of strlen() calls done (as the length of any 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// string passed in is relatively likely to be known at compile time, and for 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// those strings passed back we obviate the need for a strlen() to determine 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the size of new storage allocations if a new allocation is required. 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 3) This class attempts to store all of its data in two linear buffers in 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// order to enhance the speed of parsing and writing out to a buffer. As a 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// result, many string pieces are -not- terminated by '\0', and are not 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// c-strings. Since this is the case, we must delineate the length of the 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// string explicitly via a length. 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// WARNING: The side effect of using StringPiece is that if the underlying 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// buffer changes (due to modifying the headers) the StringPieces which point 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to the data which was modified, may now contain "garbage", and should not 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// be dereferenced. 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For example, If you fetch some component of the first-line, (request or 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// response), and then you modify the first line, the StringPieces you 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// originally received from the original first-line may no longer be valid). 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// StringPieces pointing to pieces of header lines which have not been 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// erased() or modified should be valid until the object is cleared or 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// destroyed. 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BalsaHeaders { 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct HeaderLineDescription { 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLineDescription(size_t first_character_index, 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t key_end_index, 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t value_begin_index, 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t last_character_index, 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t buffer_base_index) : 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) first_char_idx(first_character_index), 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) key_end_idx(key_end_index), 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value_begin_idx(value_begin_index), 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) last_char_idx(last_character_index), 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer_base_idx(buffer_base_index), 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) skip(false) {} 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLineDescription() : 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) first_char_idx(0), 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) key_end_idx(0), 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value_begin_idx(0), 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) last_char_idx(0), 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer_base_idx(0), 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) skip(false) {} 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t first_char_idx; 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t key_end_idx; 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t value_begin_idx; 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t last_char_idx; 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaBuffer::Blocks::size_type buffer_base_idx; 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool skip; 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<base::StringPiece> HeaderTokenList; 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend bool ParseHTTPFirstLine(const char* begin, 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* end, 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_request, 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t max_request_uri_length, 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaHeaders* headers, 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaFrameEnums::ErrorCode* error_code); 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<HeaderLineDescription> HeaderLines; 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Why these base classes (iterator_base, reverse_iterator_base)? Well, if 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // we do want to export both iterator and const_iterator types (currently we 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // only have const_iterator), then this is useful to avoid code duplication. 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Additionally, having this base class makes comparisons of iterators of 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // different types (they're different types to ensure that operator= and 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // constructors do not work in the places where they're expected to not work) 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // work properly. There could be as many as 4 iterator types, all based on 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the same data as iterator_base... so it makes sense to simply have some 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // base classes. 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class iterator_base { 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaHeaders; 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class reverse_iterator_base; 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::pair<base::StringPiece, base::StringPiece> StringPiecePair; 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef StringPiecePair value_type; 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef value_type& reference; 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef value_type* pointer; 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::forward_iterator_tag iterator_category; 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef ptrdiff_t difference_type; 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef iterator_base self; 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // default constructor. 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(); 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // copy constructor. 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(const iterator_base& it); 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reference operator*() const { 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return Lookup(idx_); 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) pointer operator->() const { 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return &(this->operator*()); 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator==(const self& it) const { 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return idx_ == it.idx_; 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator<(const self& it) const { 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return idx_ < it.idx_; 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator<=(const self& it) const { 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return idx_ <= it.idx_; 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator!=(const self& it) const { 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return !(*this == it); 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator>(const self& it) const { 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return it < *this; 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator>=(const self& it) const { 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return it <= *this; 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This mainly exists so that we can have interesting output for 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // unittesting. The EXPECT_EQ, EXPECT_NE functions require that 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // operator<< work for the classes it sees. It would be better if there 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // was an additional traits-like system for the gUnit output... but oh 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // well. 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::ostream& operator<<(std::ostream& os) const; 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(const BalsaHeaders* headers, HeaderLines::size_type index); 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void increment() { 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines& header_lines = headers_->header_lines_; 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type header_lines_size = header_lines.size(); 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type original_idx = idx_; 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++idx_; 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (idx_ < header_lines_size && header_lines[idx_].skip == true); 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The condition below exists so that ++(end() - 1) == end(), even 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if there are only 'skip == true' elements between the end() iterator 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and the end of the vector of HeaderLineDescriptions. 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(fenix): refactor this list so that we don't have to do 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // linear scanning through skipped headers (and this condition is 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // then unnecessary) 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (idx_ == header_lines_size) { 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) idx_ = original_idx + 1; 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void decrement() { 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines& header_lines = headers_->header_lines_; 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type header_lines_size = header_lines.size(); 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type original_idx = idx_; 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) --idx_; 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (idx_ < header_lines_size && header_lines[idx_].skip == true); 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The condition below exists so that --(rbegin() + 1) == rbegin(), even 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if there are only 'skip == true' elements between the rbegin() iterator 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and the beginning of the vector of HeaderLineDescriptions. 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(fenix): refactor this list so that we don't have to do 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // linear scanning through skipped headers (and this condition is 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // then unnecessary) 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (idx_ > header_lines_size) { 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) idx_ = original_idx - 1; 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reference Lookup(HeaderLines::size_type index) const { 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_LT(index, headers_->header_lines_.size()); 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLineDescription& line = headers_->header_lines_[index]; 3965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* stream_begin = headers_->GetPtr(line.buffer_base_idx); 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value_ = value_type( 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece(stream_begin + line.first_char_idx, 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) line.key_end_idx - line.first_char_idx), 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece(stream_begin + line.value_begin_idx, 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) line.last_char_idx - line.value_begin_idx)); 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(line.key_end_idx, line.first_char_idx); 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(line.last_char_idx, line.value_begin_idx); 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return value_; 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BalsaHeaders* headers_; 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type idx_; 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) mutable StringPiecePair value_; 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class reverse_iterator_base : public iterator_base { 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef reverse_iterator_base self; 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef iterator_base::reference reference; 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef iterator_base::pointer pointer; 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) using iterator_base::headers_; 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) using iterator_base::idx_; 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base() : iterator_base() {} 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This constructor is no explicit purposely. 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base(const iterator_base& it) : // NOLINT 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(it) { 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator=(const iterator_base& it) { 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) idx_ = it.idx_; 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) headers_ = it.headers_; 4305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 4315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator=(const reverse_iterator_base& it) { 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) idx_ = it.idx_; 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) headers_ = it.headers_; 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reference operator*() const { 4405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return Lookup(idx_ - 1); 4415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) pointer operator->() const { 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return &(this->operator*()); 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base(const reverse_iterator_base& it) : 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(it) { } 4495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 4515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void increment() { 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) --idx_; 4535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base::decrement(); 4545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++idx_; 4555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void decrement() { 4585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++idx_; 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base::increment(); 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) --idx_; 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base(const BalsaHeaders* headers, 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type index) : 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(headers, index) {} 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 4695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class const_header_lines_iterator : public iterator_base { 4705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaHeaders; 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 4725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef const_header_lines_iterator self; 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator() : iterator_base() {} 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator(const const_header_lines_iterator& it) : 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(it.headers_, it.idx_) {} 4775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator++() { 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base::increment(); 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator--() { 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base::decrement(); 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator(const BalsaHeaders* headers, 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type index) : 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base(headers, index) {} 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class const_reverse_header_lines_iterator : public reverse_iterator_base { 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef const_reverse_header_lines_iterator self; 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator() : reverse_iterator_base() {} 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator( 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const const_header_lines_iterator& it) : 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base(it.headers_, it.idx_) {} 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator( 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const const_reverse_header_lines_iterator& it) : 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base(it.headers_, it.idx_) {} 5055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator base() { 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return const_header_lines_iterator(headers_, idx_); 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator++() { 5115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base::increment(); 5125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator--() { 5165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base::decrement(); 5175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 5205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator(const BalsaHeaders* headers, 5215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type index) : 5225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reverse_iterator_base(headers, index) {} 5235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaHeaders; 5255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 5265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // An iterator that only stops at lines with a particular key. 5285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See also GetIteratorForKey. 5295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 5305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Check against header_lines_key_end() to determine when iteration is 5315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // finished. header_lines_end() will also work. 5325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class const_header_lines_key_iterator : public iterator_base { 5335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaHeaders; 5345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 5355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef const_header_lines_key_iterator self; 5365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_key_iterator(const const_header_lines_key_iterator&); 5375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self& operator++() { 5395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { 5405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iterator_base::increment(); 5415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (!AtEnd() && 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) !StringPieceUtils::EqualIgnoreCase(key_, (**this).first)); 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void operator++(int ignore) { 5475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++(*this); 5485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Only forward-iteration makes sense, so no operator-- defined. 5515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 5535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_key_iterator(const BalsaHeaders* headers, 5545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type index, 5555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key); 5565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Should only be used for creating an end iterator. 5585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_key_iterator(const BalsaHeaders* headers, 5595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type index); 5605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AtEnd() const { 5625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this >= headers_->header_lines_end(); 5635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece key_; 5665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 5675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(fenix): Revisit the amount of bytes initially allocated to the second 5695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // block of the balsa_buffer_. It may make sense to pre-allocate some amount 5705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (roughly the amount we'd append in new headers such as X-User-Ip, etc.) 5715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaHeaders(); 5725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~BalsaHeaders(); 5735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator header_lines_begin() { 5755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return HeaderLinesBeginHelper<const_header_lines_iterator>(); 5765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator header_lines_begin() const { 5795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return HeaderLinesBeginHelper<const_header_lines_iterator>(); 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator header_lines_end() { 5835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return HeaderLinesEndHelper<const_header_lines_iterator>(); 5845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator header_lines_end() const { 5875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return HeaderLinesEndHelper<const_header_lines_iterator>(); 5885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator header_lines_rbegin() { 5915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return const_reverse_header_lines_iterator(header_lines_end()); 5925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator header_lines_rbegin() const { 5955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return const_reverse_header_lines_iterator(header_lines_end()); 5965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 5975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator header_lines_rend() { 5995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return const_reverse_header_lines_iterator(header_lines_begin()); 6005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_reverse_header_lines_iterator header_lines_rend() const { 6035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return const_reverse_header_lines_iterator(header_lines_begin()); 6045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_key_iterator header_lines_key_end() const { 6075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return HeaderLinesEndHelper<const_header_lines_key_iterator>(); 6085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void erase(const const_header_lines_iterator& it) { 6115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_EQ(it.headers_, this); 6125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_LT(it.idx_, header_lines_.size()); 6135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(it.idx_, 0u); 6145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) header_lines_[it.idx_].skip = true; 6155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Clear(); 6185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Swap(BalsaHeaders* other); 6205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyFrom(const BalsaHeaders& other); 6225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void HackHeader(const base::StringPiece& key, const base::StringPiece& value); 6245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Same as AppendToHeader, except that it will attempt to preserve 6265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // header ordering. 6275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that this will always append to an existing header, if available, 6285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // without moving the header around, or collapsing multiple header lines 6295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // with the same key together. For this reason, it only 'attempts' to 6305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // preserve header ordering. 6315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(fenix): remove this function and rename all occurances 6325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of it in the code to AppendToHeader when the condition above 6335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // has been satisified. 6345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void HackAppendToHeader(const base::StringPiece& key, 6355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value); 6365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Replaces header entries with key 'key' if they exist, or appends 6385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a new header if none exist. See 'AppendHeader' below for additional 6395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // comments about ContentLength and TransferEncoding headers. Note that this 6405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will allocate new storage every time that it is called. 6415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(fenix): modify this function to reuse existing storage 6425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if it is available. 6435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ReplaceOrAppendHeader(const base::StringPiece& key, 6445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value); 6455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Append a new header entry to the header object. Clients who wish to append 6475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Content-Length header should use SetContentLength() method instead of 6485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // adding the content length header using AppendHeader (manually adding the 6495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content length header will not update the content_length_ and 6505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content_length_status_ values). 6515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Similarly, clients who wish to add or remove the transfer encoding header 6525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in order to apply or remove chunked encoding should use SetChunkEncoding() 6535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // instead. 6545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AppendHeader(const base::StringPiece& key, 6555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value); 6565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Appends ',value' to an existing header named 'key'. If no header with the 6585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // correct key exists, it will call AppendHeader(key, value). Calling this 6595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // function on a key which exists several times in the headers will produce 6605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // unpredictable results. 6615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AppendToHeader(const base::StringPiece& key, 6625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value); 6635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Prepends 'value,' to an existing header named 'key'. If no header with the 6655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // correct key exists, it will call AppendHeader(key, value). Calling this 6665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // function on a key which exists several times in the headers will produce 6675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // unpredictable results. 6685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void PrependToHeader(const base::StringPiece& key, 6695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value); 6705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece GetHeader(const base::StringPiece& key) const; 6725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Iterates over all currently valid header lines, appending their 6745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // values into the vector 'out', in top-to-bottom order. 6755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Header-lines which have been erased are not currently valid, and 6765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will not have their values appended. Empty values will be 6775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // represented as empty string. If 'key' doesn't exist in the headers at 6785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // all, out will not be changed. We do not clear the vector out 6795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // before adding new entries. If there are header lines with matching 6805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // key but empty value then they are also added to the vector out. 6815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (Basically empty values are not treated in any special manner). 6825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 6835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Example: 6845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Input header: 6855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "GET / HTTP/1.0\r\n" 6865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "key1: v1\r\n" 6875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "key1: \r\n" 6885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "key1:\r\n" 6895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "key1: v1\r\n" 6905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "key1:v2\r\n" 6915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 6925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // vector out is initially: ["foo"] 6935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // vector out after GetAllOfHeader("key1", &out) is: 6945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ["foo", "v1", "", "", "v2", "v1", "v2"] 6955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void GetAllOfHeader(const base::StringPiece& key, 6975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<base::StringPiece>* out) const; 6985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Joins all values for key into a comma-separated string in out. 7005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // More efficient than calling JoinStrings on result of GetAllOfHeader if 7015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // you don't need the intermediate vector<StringPiece>. 7025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void GetAllOfHeaderAsString(const base::StringPiece& key, 7035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* out) const; 7045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if RFC 2616 Section 14 indicates that header can 7065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // have multiple values. 7075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsMultivaluedHeader(const base::StringPiece& header); 7085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Determine if a given header is present. 7105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline bool HasHeader(const base::StringPiece& key) const { 7115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return (GetConstHeaderLinesIterator(key, header_lines_.begin()) != 7125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) header_lines_.end()); 7135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true iff any header 'key' exists with non-empty value. 7165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool HasNonEmptyHeader(const base::StringPiece& key) const; 7175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_iterator GetHeaderPosition( 7195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key) const; 7205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a forward-only iterator that only stops at lines matching key. 7225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // String backing 'key' must remain valid for lifetime of iterator. 7235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 7245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Check returned iterator against header_lines_key_end() to determine when 7255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // iteration is finished. 7265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_header_lines_key_iterator GetIteratorForKey( 7275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key) const; 7285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAllOfHeader(const base::StringPiece& key); 7305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all headers starting with 'key' [case insensitive] 7325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAllHeadersWithPrefix(const base::StringPiece& key); 7335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the lower bound of memory used by this header object, including 7355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // all internal buffers and data structure. Some of the memory used cannot be 7365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // directly measure. For example, memory used for bookkeeping by standard 7375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // containers. 7385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetMemoryUsedLowerBound() const; 7395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the upper bound on the required buffer space to fully write out 7415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the header object (this include the first line, all header lines, and the 7425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // final CRLF that marks the ending of the header). 7435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetSizeForWriteBuffer() const; 7445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The following WriteHeader* methods are template member functions that 7465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // place one requirement on the Buffer class: it must implement a Write 7475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // method that takes a pointer and a length. The buffer passed in is not 7485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // required to be stretchable. For non-stretchable buffers, the user must 7495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // call GetSizeForWriteBuffer() to find out the upper bound on the output 7505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buffer space required to make sure that the entire header is serialized. 7515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BalsaHeaders will not check that there is adequate space in the buffer 7525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // object during the write. 7535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Writes the entire header and the final CRLF that marks the end of the HTTP 7555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // header section to the buffer. After this method returns, no more header 7565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // data should be written to the buffer. 7575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template <typename Buffer> 7585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteHeaderAndEndingToBuffer(Buffer* buffer) const { 7595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WriteToBuffer(buffer); 7605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WriteHeaderEndingToBuffer(buffer); 7615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Writes the final CRLF to the buffer to terminate the HTTP header section. 7645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // After this method returns, no more header data should be written to the 7655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buffer. 7665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template <typename Buffer> 7675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void WriteHeaderEndingToBuffer(Buffer* buffer) { 7685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write("\r\n", 2); 7695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Writes the entire header to the buffer without the CRLF that terminates 7725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the HTTP header. This lets users append additional header lines using 7735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WriteHeaderLineToBuffer and then terminate the header with 7745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WriteHeaderEndingToBuffer as the header is serialized to the 7755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buffer, without having to first copy the header. 7765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template <typename Buffer> 7775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteToBuffer(Buffer* buffer) const { 7785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // write the first line. 7795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const size_t firstline_len = whitespace_4_idx_ - non_whitespace_1_idx_; 7805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* stream_begin = GetPtr(firstline_buffer_base_idx_); 7815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write(stream_begin + non_whitespace_1_idx_, firstline_len); 7825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write("\r\n", 2); 7835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type end = header_lines_.size(); 7845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (HeaderLines::size_type i = 0; i < end; ++i) { 7855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLineDescription& line = header_lines_[i]; 7865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (line.skip) { 7875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) continue; 7885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* line_ptr = GetPtr(line.buffer_base_idx); 7905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WriteHeaderLineToBuffer( 7915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer, 7925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece(line_ptr + line.first_char_idx, 7935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) line.key_end_idx - line.first_char_idx), 7945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece(line_ptr + line.value_begin_idx, 7955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) line.last_char_idx - line.value_begin_idx)); 7965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 7985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Takes a header line in the form of a key/value pair and append it to the 8005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buffer. This function should be called after WriteToBuffer to 8015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // append additional header lines to the header without copying the header. 8025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When the user is done with appending to the buffer, 8035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WriteHeaderEndingToBuffer must be used to terminate the HTTP 8045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // header in the buffer. This method is a no-op if key is empty. 8055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template <typename Buffer> 8065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void WriteHeaderLineToBuffer(Buffer* buffer, 8075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key, 8085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value) { 8095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if the key is empty, we don't want to write the rest because it 8105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will not be a well-formed header line. 8115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!key.empty()) { 8125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write(key.data(), key.size()); 8135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write(": ", 2); 8145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write(value.data(), value.size()); 8155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) buffer->Write("\r\n", 2); 8165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dump the textural representation of the header object to a string, which 8205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is suitable for writing out to logs. All CRLF will be printed out as \n. 8215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function can be called on a header object in any state. Raw header 8225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // data will be printed out if the header object is not completely parsed, 8235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // e.g., when there was an error in the middle of parsing. 8245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The header content is appended to the string; the original content is not 8255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cleared. 8265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DumpToString(std::string* str) const; 8275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece first_line() const { 8295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(whitespace_4_idx_, non_whitespace_1_idx_); 8305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::StringPiece(BeginningOfFirstLine() + non_whitespace_1_idx_, 8315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) whitespace_4_idx_ - non_whitespace_1_idx_); 8325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the parsed value of the response code if it has been parsed. 8355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Guaranteed to return 0 when unparsed (though it is a much better idea to 8365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // verify that the BalsaFrame had no errors while parsing). 8375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This may return response codes which are outside the normal bounds of 8385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // HTTP response codes-- it is up to the user of this class to ensure that 8395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the response code is one which is interpretable. 8405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t parsed_response_code() const { return parsed_response_code_; } 8415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece request_method() const { 8435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(whitespace_2_idx_, non_whitespace_1_idx_); 8445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::StringPiece(BeginningOfFirstLine() + non_whitespace_1_idx_, 8455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) whitespace_2_idx_ - non_whitespace_1_idx_); 8465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece response_version() const { 8495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note: There is no difference between request_method() and 8505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // response_version(). They both could be called 8515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // GetFirstTokenFromFirstline()... but that wouldn't be anywhere near as 8525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptive. 8535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return request_method(); 8545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece request_uri() const { 8575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(whitespace_3_idx_, non_whitespace_2_idx_); 8585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::StringPiece(BeginningOfFirstLine() + non_whitespace_2_idx_, 8595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) whitespace_3_idx_ - non_whitespace_2_idx_); 8605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece response_code() const { 8635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note: There is no difference between request_uri() and response_code(). 8645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // They both could be called GetSecondtTokenFromFirstline(), but, as noted 8655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in an earlier comment, that wouldn't be as descriptive. 8665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return request_uri(); 8675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece request_version() const { 8705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_GE(whitespace_4_idx_, non_whitespace_3_idx_); 8715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::StringPiece(BeginningOfFirstLine() + non_whitespace_3_idx_, 8725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) whitespace_4_idx_ - non_whitespace_3_idx_); 8735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece response_reason_phrase() const { 8765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note: There is no difference between request_version() and 8775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // response_reason_phrase(). They both could be called 8785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // GetThirdTokenFromFirstline(), but, as noted in an earlier comment, that 8795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // wouldn't be as descriptive. 8805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return request_version(); 8815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that SetFirstLine will not update the internal indices for the 8845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // various bits of the first-line (and may set them all to zero). 8855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If you'd like to use the accessors for the various bits of the firstline, 8865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // then you should use the Set* functions, or SetFirstlineFromStringPieces, 8875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // below, instead. 8885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 8895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetFirstlineFromStringPieces(const base::StringPiece& firstline_a, 8905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& firstline_b, 8915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& firstline_c); 8925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetRequestFirstlineFromStringPieces(const base::StringPiece& method, 8945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& uri, 8955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& version) { 8965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SetFirstlineFromStringPieces(method, uri, version); 8975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 8985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetResponseFirstlineFromStringPieces( 9005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& version, 9015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& code, 9025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& reason_phrase) { 9035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SetFirstlineFromStringPieces(version, code, reason_phrase); 9045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These functions are exactly the same, except that their names are 9075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // different. This is done so that the code using this class is more 9085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // expressive. 9095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetRequestMethod(const base::StringPiece& method); 9105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetResponseVersion(const base::StringPiece& version); 9115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetRequestUri(const base::StringPiece& uri); 9135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetResponseCode(const base::StringPiece& code); 9145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_parsed_response_code(size_t parsed_response_code) { 9155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) parsed_response_code_ = parsed_response_code; 9165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetParsedResponseCodeAndUpdateFirstline(size_t parsed_response_code); 9185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These functions are exactly the same, except that their names are 9205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // different. This is done so that the code using this class is more 9215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // expressive. 9225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetRequestVersion(const base::StringPiece& version); 9235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetResponseReasonPhrase(const base::StringPiece& reason_phrase); 9245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The biggest problem with SetFirstLine is that we don't want to use a 9265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // separate buffer for it. The second biggest problem with it is that the 9275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // first biggest problem requires that we store offsets into a buffer instead 9285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of pointers into a buffer. Cuteness aside, SetFirstLine doesn't parse 9295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the individual fields of the firstline, and so accessors to those fields 9305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will not work properly after calling SetFirstLine. If you want those 9315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // accessors to work, use the Set* functions above this one. 9325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SetFirstLine is stuff useful, however, if all you care about is correct 9335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // serialization with the rest of the header object. 9345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetFirstLine(const base::StringPiece& line); 9355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Simple accessors to some of the internal state 9375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool transfer_encoding_is_chunked() const { 9385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return transfer_encoding_is_chunked_; 9395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 941f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) static bool ResponseCodeImpliesNoBody(size_t code) { 9425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // From HTTP spec section 6.1.1 all 1xx responses must not have a body, 9435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // as well as 204 No Content and 304 Not Modified. 9445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ((code >= 100) && (code <= 199)) || (code == 204) || (code == 304); 9455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note: never check this for requests. Nothing bad will happen if you do, 9485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but spec does not allow requests framed by connection close. 9495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(vitaliyl): refactor. 9505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_framed_by_connection_close() const { 9515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We declare that response is framed by connection close if it has no 9525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content-length, no transfer encoding, and is allowed to have a body by 9535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the HTTP spec. 9545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // parsed_response_code_ is 0 for requests, so ResponseCodeImpliesNoBody 9555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will return false. 9565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return (content_length_status_ == BalsaHeadersEnums::NO_CONTENT_LENGTH) && 9575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) !transfer_encoding_is_chunked_ && 9585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) !ResponseCodeImpliesNoBody(parsed_response_code_); 9595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t content_length() const { return content_length_; } 9625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaHeadersEnums::ContentLengthStatus content_length_status() const { 9635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return content_length_status_; 9645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // SetContentLength and SetChunkEncoding modifies the header object to use 9675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content-length and transfer-encoding headers in a consistent manner. They 9685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // set all internal flags and status so client can get a consistent view from 9695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // various accessors. 9705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetContentLength(size_t length); 9715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetChunkEncoding(bool chunk_encode); 9725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 9745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaFrame; 9755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class SpdyFrame; 9765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class HTTPMessage; 9775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BalsaHeadersTokenUtils; 9785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* BeginningOfFirstLine() const { 9805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return GetPtr(firstline_buffer_base_idx_); 9815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* GetPtr(BalsaBuffer::Blocks::size_type block_idx) { 9845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return balsa_buffer_.GetPtr(block_idx); 9855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* GetPtr(BalsaBuffer::Blocks::size_type block_idx) const { 9885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return balsa_buffer_.GetPtr(block_idx); 9895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteFromFramer(const char* ptr, size_t size) { 9925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) balsa_buffer_.WriteToContiguousBuffer(base::StringPiece(ptr, size)); 9935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DoneWritingFromFramer() { 9965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) balsa_buffer_.NoMoreWriteToContiguousBuffer(); 9975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 9985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* OriginalHeaderStreamBegin() const { 10005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return balsa_buffer_.StartOfFirstBlock(); 10015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* OriginalHeaderStreamEnd() const { 10045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return balsa_buffer_.EndOfFirstBlock(); 10055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetReadableBytesFromHeaderStream() const { 10085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return OriginalHeaderStreamEnd() - OriginalHeaderStreamBegin(); 10095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void GetReadablePtrFromHeaderStream(const char** p, size_t* s) { 10125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *p = OriginalHeaderStreamBegin(); 10135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *s = GetReadableBytesFromHeaderStream(); 10145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece GetValueFromHeaderLineDescription( 10175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLineDescription& line) const; 10185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddAndMakeDescription(const base::StringPiece& key, 10205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value, 10215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLineDescription* d); 10225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AppendOrPrependAndMakeDescription(const base::StringPiece& key, 10245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value, 10255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool append, 10265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLineDescription* d); 10275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all header lines with the given key starting at start. 10295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAllOfHeaderStartingAt(const base::StringPiece& key, 10305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::iterator start); 10315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the 'key' does not exist in the headers, calls 10335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // AppendHeader(key, value). Otherwise if append is true, appends ',value' 10345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to the first existing header with key 'key'. If append is false, prepends 10355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 'value,' to the first existing header with key 'key'. 10365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AppendOrPrependToHeader(const base::StringPiece& key, 10375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& value, 10385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool append); 10395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::const_iterator GetConstHeaderLinesIterator( 10415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key, 10425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::const_iterator start) const; 10435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::iterator GetHeaderLinesIteratorNoSkip( 10455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key, 10465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::iterator start); 10475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::iterator GetHeaderLinesIterator( 10495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& key, 10505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::iterator start); 10515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template <typename IteratorType> 10535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IteratorType HeaderLinesBeginHelper() const { 10545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (header_lines_.empty()) { 10555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return IteratorType(this, 0); 10565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type header_lines_size = header_lines_.size(); 10585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (HeaderLines::size_type i = 0; i < header_lines_size; ++i) { 10595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (header_lines_[i].skip == false) { 10605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return IteratorType(this, i); 10615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return IteratorType(this, 0); 10645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) template <typename IteratorType> 10675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IteratorType HeaderLinesEndHelper() const { 10685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (header_lines_.empty()) { 10695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return IteratorType(this, 0); 10705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HeaderLines::size_type header_lines_size = header_lines_.size(); 10725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines::size_type i = header_lines_size; 10735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { 10745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) --i; 10755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (header_lines_[i].skip == false) { 10765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return IteratorType(this, i + 1); 10775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (i != 0); 10795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return IteratorType(this, 0); 10805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // At the moment, this function will always return the original headers. 10835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In the future, it may not do so after erasing header lines, modifying 10845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // header lines, or modifying the first line. 10855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For this reason, it is strongly suggested that use of this function is 10865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // only acceptable for the purpose of debugging parse errors seen by the 10875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BalsaFrame class. 10885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece OriginalHeadersForDebugging() const { 10895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::StringPiece(OriginalHeaderStreamBegin(), 10905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) OriginalHeaderStreamEnd() - OriginalHeaderStreamBegin()); 10915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 10925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaBuffer balsa_buffer_; 10945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t content_length_; 10965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaHeadersEnums::ContentLengthStatus content_length_status_; 10975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t parsed_response_code_; 10985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // HTTP firstlines all have the following structure: 10995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // LWS NONWS LWS NONWS LWS NONWS NOTCRLF CRLF 11005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // [\t \r\n]+ [^\t ]+ [\t ]+ [^\t ]+ [\t ]+ [^\t ]+ [^\r\n]+ "\r\n" 11015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ws1 nws1 ws2 nws2 ws3 nws3 ws4 11025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // | [-------) [-------) [----------------) 11035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // REQ: method request_uri version 11045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // RESP: version statuscode reason 11055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 11065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The first NONWS->LWS component we'll call firstline_a. 11075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The second firstline_b, and the third firstline_c. 11085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 11095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // firstline_a goes from nws1 to (but not including) ws2 11105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // firstline_b goes from nws2 to (but not including) ws3 11115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // firstline_c goes from nws3 to (but not including) ws4 11125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 11135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In the code: 11145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ws1 == whitespace_1_idx_ 11155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // nws1 == non_whitespace_1_idx_ 11165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ws2 == whitespace_2_idx_ 11175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // nws2 == non_whitespace_2_idx_ 11185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ws3 == whitespace_3_idx_ 11195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // nws3 == non_whitespace_3_idx_ 11205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ws4 == whitespace_4_idx_ 11215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BalsaBuffer::Blocks::size_type firstline_buffer_base_idx_; 11225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t whitespace_1_idx_; 11235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t non_whitespace_1_idx_; 11245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t whitespace_2_idx_; 11255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t non_whitespace_2_idx_; 11265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t whitespace_3_idx_; 11275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t non_whitespace_3_idx_; 11285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t whitespace_4_idx_; 11295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t end_of_firstline_idx_; 11305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool transfer_encoding_is_chunked_; 11325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HeaderLines header_lines_; 11345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 11355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 11375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11384e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#endif // NET_TOOLS_BALSA_BALSA_HEADERS_H_ 1139