headers.h

Go to the documentation of this file.

// Copyright 2011 Google Inc.


#ifndef PAGESPEED_KERNEL_HTTP_HEADERS_H_
#define PAGESPEED_KERNEL_HTTP_HEADERS_H_

#include <map>
#include <utility>

#include "pagespeed/kernel/base/basictypes.h"
#include "pagespeed/kernel/base/proto_util.h"
#include "pagespeed/kernel/base/scoped_ptr.h"
#include "pagespeed/kernel/base/string.h"
#include "pagespeed/kernel/base/string_util.h"

namespace net_instaweb {

class MessageHandler;
class NameValue;
class StringMultiMapInsensitive;
class Writer;

template<class Proto> class Headers {
 public:
  typedef std::pair<StringPiece, StringPiece> ValueAndAttributes;
  typedef std::multimap<StringPiece, ValueAndAttributes> CookieMultimap;
  typedef std::multimap<StringPiece, ValueAndAttributes>::const_iterator
      CookieMultimapConstIter;

  Headers();
  virtual ~Headers();

  virtual void Clear();

  int major_version() const;
  bool has_major_version() const;
  int minor_version() const;
  void set_major_version(int major_version);
  void set_minor_version(int major_version);

  int NumAttributes() const;
  const GoogleString& Name(int i) const;
  const GoogleString& Value(int i) const;
  void SetValue(int i, StringPiece value);

  bool Lookup(const StringPiece& name, ConstStringStarVector* values) const;

  GoogleString LookupJoined(StringPiece name) const;

  const char* Lookup1(const StringPiece& name) const;

  bool Has(const StringPiece& name) const;

  bool HasValue(const StringPiece& name, const StringPiece& value) const;

  int NumAttributeNames() const;

  void RemoveCookie(const StringPiece& cookie_name);

  void Add(const StringPiece& name, const StringPiece& value);

  bool Remove(const StringPiece& name, const StringPiece& value);

  bool RemoveAll(const StringPiece& name);

  bool RemoveAllFromSortedArray(const StringPiece* names,
                                int names_size);

  template<class StringType>
  static bool RemoveFromHeaders(const StringType* names,
                                int names_size,
                                protobuf::RepeatedPtrField<NameValue>* headers);

  bool RemoveAllWithPrefix(const StringPiece& prefix);

  bool RemoveIfNotIn(const Headers& keep);

  virtual void Replace(const StringPiece& name, const StringPiece& value);

  virtual void UpdateFrom(const Headers<Proto>& other);

  virtual bool WriteAsBinary(Writer* writer, MessageHandler* message_handler);

  virtual bool ReadFromBinary(const StringPiece& buf, MessageHandler* handler);

  virtual bool WriteAsHttp(Writer* writer, MessageHandler* handler) const;

  void CopyToProto(Proto* proto) const;

  static bool FindValueForName(const StringPieceVector& name_equals_value_vec,
                               StringPiece name_to_find,
                               StringPiece* optional_retval);

  static bool ExtractNameAndValue(StringPiece input, StringPiece* name,
                                  StringPiece* optional_retval);

 protected:
  void SetProto(Proto* proto); 
  void CopyProto(const Proto& proto);

  void PopulateMap() const; 

  const CookieMultimap* PopulateCookieMap(StringPiece header_name) const;

  virtual void UpdateHook();

  const Proto* proto() const { return proto_.get(); }
  Proto* mutable_proto() { return proto_.get(); }

 private:
  void AddToMap(const StringPiece& name, const StringPiece& value) const;

  mutable scoped_ptr<StringMultiMapInsensitive> map_;
  scoped_ptr<Proto> proto_;

  mutable scoped_ptr<CookieMultimap> cookies_;

  
};

}  

#endif