httpCookie.h

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file httpCookie.h
 * @author drose
 * @date 2004-08-26
 */

#ifndef HTTPCOOKIE_H
#define HTTPCOOKIE_H

#include "pandabase.h"

// This module requires OpenSSL to compile, even if you do not intend to use
// this to establish https connections; this is because it uses the OpenSSL
// library to portably handle all of the socket communications.

#ifdef HAVE_OPENSSL

#include "httpDate.h"
#include "urlSpec.h"

/**
 * A cookie sent from an HTTP server to be stored on the client and returned
 * when the path and/or domain matches.
 */
class EXPCL_PANDA_DOWNLOADER HTTPCookie {
PUBLISHED:
  INLINE HTTPCookie();
  INLINE explicit HTTPCookie(const std::string &format, const URLSpec &url);
  INLINE explicit HTTPCookie(const std::string &name, const std::string &path,
                             const std::string &domain);
  INLINE ~HTTPCookie();

  INLINE void set_name(const std::string &name);
  INLINE const std::string &get_name() const;

  INLINE void set_value(const std::string &value);
  INLINE const std::string &get_value() const;

  INLINE void set_domain(const std::string &domain);
  INLINE const std::string &get_domain() const;

  INLINE void set_path(const std::string &path);
  INLINE const std::string &get_path() const;

  INLINE void set_expires(const HTTPDate &expires);
  INLINE void clear_expires();
  INLINE bool has_expires() const;
  INLINE HTTPDate get_expires() const;

  INLINE void set_secure(bool flag);
  INLINE bool get_secure() const;

  bool operator < (const HTTPCookie &other) const;
  void update_from(const HTTPCookie &other);

  bool parse_set_cookie(const std::string &format, const URLSpec &url);
  INLINE bool is_expired(const HTTPDate &now = HTTPDate::now()) const;
  bool matches_url(const URLSpec &url) const;

  void output(std::ostream &out) const;

private:
  bool parse_cookie_param(const std::string &param, bool first_param);

  std::string _name;
  std::string _value;
  std::string _path;
  std::string _domain;
  HTTPDate _expires;
  bool _secure;
};

INLINE std::ostream &operator << (std::ostream &out, const HTTPCookie &cookie);

#include "httpCookie.I"

#endif  // HAVE_OPENSSL

#endif