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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Defines the Chrome Extensions Cookies API functions for accessing internet
// cookies, as specified in the extension API JSON.
#ifndef CHROME_BROWSER_EXTENSIONS_API_COOKIES_COOKIES_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_COOKIES_COOKIES_API_H_
#include <string>
#include "base/compiler_specific.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "chrome/browser/extensions/chrome_extension_function.h"
#include "chrome/browser/net/chrome_cookie_notification_details.h"
#include "chrome/common/extensions/api/cookies.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "extensions/browser/browser_context_keyed_api_factory.h"
#include "extensions/browser/event_router.h"
#include "net/cookies/canonical_cookie.h"
#include "url/gurl.h"
namespace net {
class URLRequestContextGetter;
}
namespace extensions {
// Observes CookieMonster notifications and routes them as events to the
// extension system.
class CookiesEventRouter : public content::NotificationObserver {
public:
explicit CookiesEventRouter(content::BrowserContext* context);
~CookiesEventRouter() override;
private:
// content::NotificationObserver implementation.
void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) override;
// Handler for the COOKIE_CHANGED event. The method takes the details of such
// an event and constructs a suitable JSON formatted extension event from it.
void CookieChanged(Profile* profile, ChromeCookieDetails* details);
// This method dispatches events to the extension message service.
void DispatchEvent(content::BrowserContext* context,
const std::string& event_name,
scoped_ptr<base::ListValue> event_args,
GURL& cookie_domain);
// Used for tracking registrations to CookieMonster notifications.
content::NotificationRegistrar registrar_;
Profile* profile_;
DISALLOW_COPY_AND_ASSIGN(CookiesEventRouter);
};
// Implements the cookies.get() extension function.
class CookiesGetFunction : public ChromeAsyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("cookies.get", COOKIES_GET)
CookiesGetFunction();
protected:
~CookiesGetFunction() override;
// ExtensionFunction:
bool RunAsync() override;
private:
void GetCookieOnIOThread();
void RespondOnUIThread();
void GetCookieCallback(const net::CookieList& cookie_list);
GURL url_;
scoped_refptr<net::URLRequestContextGetter> store_browser_context_;
scoped_ptr<extensions::api::cookies::Get::Params> parsed_args_;
};
// Implements the cookies.getAll() extension function.
class CookiesGetAllFunction : public ChromeAsyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("cookies.getAll", COOKIES_GETALL)
CookiesGetAllFunction();
protected:
~CookiesGetAllFunction() override;
// ExtensionFunction:
bool RunAsync() override;
private:
void GetAllCookiesOnIOThread();
void RespondOnUIThread();
void GetAllCookiesCallback(const net::CookieList& cookie_list);
GURL url_;
scoped_refptr<net::URLRequestContextGetter> store_browser_context_;
scoped_ptr<extensions::api::cookies::GetAll::Params> parsed_args_;
};
// Implements the cookies.set() extension function.
class CookiesSetFunction : public ChromeAsyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("cookies.set", COOKIES_SET)
CookiesSetFunction();
protected:
~CookiesSetFunction() override;
bool RunAsync() override;
private:
void SetCookieOnIOThread();
void RespondOnUIThread();
void PullCookie(bool set_cookie_);
void PullCookieCallback(const net::CookieList& cookie_list);
GURL url_;
bool success_;
scoped_refptr<net::URLRequestContextGetter> store_browser_context_;
scoped_ptr<extensions::api::cookies::Set::Params> parsed_args_;
};
// Implements the cookies.remove() extension function.
class CookiesRemoveFunction : public ChromeAsyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("cookies.remove", COOKIES_REMOVE)
CookiesRemoveFunction();
protected:
~CookiesRemoveFunction() override;
// ExtensionFunction:
bool RunAsync() override;
private:
void RemoveCookieOnIOThread();
void RespondOnUIThread();
void RemoveCookieCallback();
GURL url_;
scoped_refptr<net::URLRequestContextGetter> store_browser_context_;
scoped_ptr<extensions::api::cookies::Remove::Params> parsed_args_;
};
// Implements the cookies.getAllCookieStores() extension function.
class CookiesGetAllCookieStoresFunction : public ChromeSyncExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("cookies.getAllCookieStores",
COOKIES_GETALLCOOKIESTORES)
protected:
~CookiesGetAllCookieStoresFunction() override {}
// ExtensionFunction:
bool RunSync() override;
};
class CookiesAPI : public BrowserContextKeyedAPI,
public extensions::EventRouter::Observer {
public:
explicit CookiesAPI(content::BrowserContext* context);
~CookiesAPI() override;
// KeyedService implementation.
void Shutdown() override;
// BrowserContextKeyedAPI implementation.
static BrowserContextKeyedAPIFactory<CookiesAPI>* GetFactoryInstance();
// EventRouter::Observer implementation.
void OnListenerAdded(const extensions::EventListenerInfo& details) override;
private:
friend class BrowserContextKeyedAPIFactory<CookiesAPI>;
content::BrowserContext* browser_context_;
// BrowserContextKeyedAPI implementation.
static const char* service_name() {
return "CookiesAPI";
}
static const bool kServiceIsNULLWhileTesting = true;
// Created lazily upon OnListenerAdded.
scoped_ptr<CookiesEventRouter> cookies_event_router_;
DISALLOW_COPY_AND_ASSIGN(CookiesAPI);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_COOKIES_COOKIES_API_H_
|