1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Brought to you by number 42.
#ifndef NET_BASE_COOKIE_STORE_H_
#define NET_BASE_COOKIE_STORE_H_
#pragma once
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/time.h"
#include "net/base/cookie_options.h"
#include "net/base/net_api.h"
class GURL;
namespace net {
class CookieMonster;
// An interface for storing and retrieving cookies. Implementations need to
// be thread safe as its methods can be accessed from IO as well as UI threads.
class NET_API CookieStore : public base::RefCountedThreadSafe<CookieStore> {
public:
// This struct contains additional consumer-specific information that might
// be stored with cookies; currently just MAC information, see:
// http://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac
struct NET_API CookieInfo {
CookieInfo();
~CookieInfo();
// The name of the cookie.
std::string name;
// TODO(abarth): Add value if any clients need it.
// The time at which the cookie was created.
base::Time creation_date;
// The value of the MAC-Key and MAC-Algorithm attributes, if present.
std::string mac_key;
std::string mac_algorithm;
};
// Sets a single cookie. Expects a cookie line, like "a=1; domain=b.com".
//
// Fails either if the cookie is invalid or if this is a non-HTTPONLY cookie
// and it would overwrite an existing HTTPONLY cookie.
// Returns true if the cookie is successfully set.
virtual bool SetCookieWithOptions(const GURL& url,
const std::string& cookie_line,
const CookieOptions& options) = 0;
typedef base::Callback<void(bool)> SetCookiesCallback;
virtual void SetCookieWithOptionsAsync(
const GURL& url,
const std::string& cookie_line,
const CookieOptions& options,
const SetCookiesCallback& callback) = 0;
// TODO(???): what if the total size of all the cookies >4k, can we have a
// header that big or do we need multiple Cookie: headers?
// Note: Some sites, such as Facebook, occationally use Cookie headers >4k.
//
// Simple interface, gets a cookie string "a=b; c=d" for the given URL.
// Use options to access httponly cookies.
virtual std::string GetCookiesWithOptions(const GURL& url,
const CookieOptions& options) = 0;
typedef base::Callback<void(const std::string& cookie)>
GetCookiesCallback;
virtual void GetCookiesWithOptionsAsync(
const GURL& url, const CookieOptions& options,
const GetCookiesCallback& callback) = 0;
// This function is similar to GetCookiesWithOptions same functionality as
// GetCookiesWithOptions except that it additionaly provides detailed
// information about the cookie contained in the cookie line. See |struct
// CookieInfo| above for details.
virtual void GetCookiesWithInfo(const GURL& url,
const CookieOptions& options,
std::string* cookie_line,
std::vector<CookieInfo>* cookie_info) = 0;
// Using for complete the asyn interface
typedef base::Callback <void(
std::string* cookie_line,
std::vector<CookieInfo>* cookie_infos)> GetCookieInfoCallback;
virtual void GetCookiesWithInfoAsync(
const GURL& url,
const CookieOptions& options,
const GetCookieInfoCallback& callback) = 0;
// Deletes the passed in cookie for the specified URL.
virtual void DeleteCookie(const GURL& url,
const std::string& cookie_name) = 0;
virtual void DeleteCookieAsync(const GURL& url,
const std::string& cookie_name,
const base::Closure& callback) = 0;
// Returns the underlying CookieMonster.
virtual CookieMonster* GetCookieMonster() = 0;
// --------------------------------------------------------------------------
// Helpers to make the above interface simpler for some cases.
// Sets a cookie for the given URL using default options.
bool SetCookie(const GURL& url, const std::string& cookie_line);
// Gets cookies for the given URL using default options.
std::string GetCookies(const GURL& url);
void GetCookiesAsync(const GURL& url,
const GetCookiesCallback& callback);
// Sets a vector of response cookie values for the same URL.
void SetCookiesWithOptions(const GURL& url,
const std::vector<std::string>& cookie_lines,
const CookieOptions& options);
void SetCookies(const GURL& url,
const std::vector<std::string>& cookie_lines);
protected:
friend class base::RefCountedThreadSafe<CookieStore>;
CookieStore();
virtual ~CookieStore();
};
} // namespace net
#endif // NET_BASE_COOKIE_STORE_H_
|
