// Copyright (c) 2012 The Chromium Embedded Framework Authors. All rights // reserved. Use of this source code is governed by a BSD-style license that can // be found in the LICENSE file. #include "libcef/browser/cookie_manager_impl.h" #include #include #include #include "libcef/browser/content_browser_client.h" #include "libcef/browser/context.h" #include "libcef/browser/thread_util.h" #include "libcef/common/time_util.h" #include "base/bind.h" #include "base/files/file_util.h" #include "base/format_macros.h" #include "base/logging.h" #include "base/threading/thread_restrictions.h" #include "content/browser/net/sqlite_persistent_cookie_store.h" #include "net/cookies/cookie_util.h" #include "net/cookies/parsed_cookie.h" #include "net/url_request/url_request_context.h" #include "url/gurl.h" using content::BrowserThread; namespace { // Callback class for visiting cookies. class VisitCookiesCallback : public base::RefCounted { public: explicit VisitCookiesCallback( scoped_refptr cookie_monster, CefRefPtr visitor) : cookie_monster_(cookie_monster), visitor_(visitor) { } void Run(const net::CookieList& list) { CEF_REQUIRE_IOT(); int total = list.size(), count = 0; net::CookieList::const_iterator it = list.begin(); for (; it != list.end(); ++it, ++count) { CefCookie cookie; const net::CanonicalCookie& cc = *(it); CefCookieManagerImpl::GetCefCookie(cc, cookie); bool deleteCookie = false; bool keepLooping = visitor_->Visit(cookie, count, total, deleteCookie); if (deleteCookie) { cookie_monster_->DeleteCanonicalCookieAsync(cc, net::CookieMonster::DeleteCookieCallback()); } if (!keepLooping) break; } } private: friend class base::RefCounted; ~VisitCookiesCallback() {} scoped_refptr cookie_monster_; CefRefPtr visitor_; }; // Methods extracted from net/cookies/cookie_monster.cc // Determine the cookie domain to use for setting the specified cookie. bool GetCookieDomain(const GURL& url, const net::ParsedCookie& pc, std::string* result) { std::string domain_string; if (pc.HasDomain()) domain_string = pc.Domain(); return net::cookie_util::GetCookieDomainWithString(url, domain_string, result); } // Always execute the callback asynchronously. void RunAsyncCompletionOnIOThread(CefRefPtr callback) { if (!callback.get()) return; CEF_POST_TASK(CEF_IOT, base::Bind(&CefCompletionCallback::OnComplete, callback.get())); } // Always execute the callback asynchronously. void DeleteCookiesCallbackImpl(CefRefPtr callback, int num_deleted) { if (!callback.get()) return; CEF_POST_TASK(CEF_IOT, base::Bind(&CefDeleteCookiesCallback::OnComplete, callback.get(), num_deleted)); } // Always execute the callback asynchronously. void SetCookieCallbackImpl(CefRefPtr callback, bool success) { if (!callback.get()) return; CEF_POST_TASK(CEF_IOT, base::Bind(&CefSetCookieCallback::OnComplete, callback.get(), success)); } } // namespace CefCookieManagerImpl::CefCookieManagerImpl() { } CefCookieManagerImpl::~CefCookieManagerImpl() { } void CefCookieManagerImpl::Initialize( CefRefPtr request_context, const CefString& path, bool persist_session_cookies, CefRefPtr callback) { if (request_context.get()) { request_context_ = request_context; request_context_->GetRequestContextImpl( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), base::Bind(&CefCookieManagerImpl::InitWithContext, this, callback)); } else { SetStoragePath(path, persist_session_cookies, callback); } } void CefCookieManagerImpl::GetCookieMonster( scoped_refptr task_runner, const CookieMonsterCallback& callback) { if (!task_runner.get()) task_runner = base::MessageLoop::current()->task_runner(); if (!CEF_CURRENTLY_ON_IOT()) { CEF_POST_TASK(CEF_IOT, base::Bind(&CefCookieManagerImpl::GetCookieMonster, this, task_runner, callback)); return; } if (HasContext()) { RunMethodWithContext( base::Bind(&CefCookieManagerImpl::GetCookieMonsterWithContext, this, task_runner, callback)); return; } DCHECK(cookie_monster_.get()); if (cookie_monster_.get()) { if (task_runner->BelongsToCurrentThread()) { // Execute the callback immediately. callback.Run(cookie_monster_); } else { // Execute the callback on the target thread. task_runner->PostTask(FROM_HERE, base::Bind(callback, cookie_monster_)); } return; } } scoped_refptr CefCookieManagerImpl::GetExistingCookieMonster() { CEF_REQUIRE_IOT(); if (cookie_monster_.get()) { return cookie_monster_; } else if (request_context_impl_.get()) { scoped_refptr cookie_monster = request_context_impl_->GetURLRequestContext()->cookie_store()-> GetCookieMonster(); DCHECK(cookie_monster.get()); return cookie_monster; } LOG(ERROR) << "Cookie manager backing store does not exist yet"; return NULL; } void CefCookieManagerImpl::SetSupportedSchemes( const std::vector& schemes, CefRefPtr callback) { if (!CEF_CURRENTLY_ON_IOT()) { CEF_POST_TASK(CEF_IOT, base::Bind(&CefCookieManagerImpl::SetSupportedSchemes, this, schemes, callback)); return; } if (HasContext()) { RunMethodWithContext( base::Bind(&CefCookieManagerImpl::SetSupportedSchemesWithContext, this, schemes, callback)); return; } DCHECK(cookie_monster_.get()); if (!cookie_monster_.get()) return; supported_schemes_ = schemes; if (supported_schemes_.empty()) { supported_schemes_.push_back("http"); supported_schemes_.push_back("https"); } std::set scheme_set; std::vector::const_iterator it = supported_schemes_.begin(); for (; it != supported_schemes_.end(); ++it) scheme_set.insert(*it); const char** arr = new const char*[scheme_set.size()]; std::set::const_iterator it2 = scheme_set.begin(); for (int i = 0; it2 != scheme_set.end(); ++it2, ++i) arr[i] = it2->c_str(); cookie_monster_->SetCookieableSchemes(arr, scheme_set.size()); delete [] arr; RunAsyncCompletionOnIOThread(callback); } bool CefCookieManagerImpl::VisitAllCookies( CefRefPtr visitor) { GetCookieMonster( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), base::Bind(&CefCookieManagerImpl::VisitAllCookiesInternal, this, visitor)); return true; } bool CefCookieManagerImpl::VisitUrlCookies( const CefString& url, bool includeHttpOnly, CefRefPtr visitor) { GetCookieMonster( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), base::Bind(&CefCookieManagerImpl::VisitUrlCookiesInternal, this, url, includeHttpOnly, visitor)); return true; } bool CefCookieManagerImpl::SetCookie( const CefString& url, const CefCookie& cookie, CefRefPtr callback) { GURL gurl = GURL(url.ToString()); if (!gurl.is_valid()) return false; GetCookieMonster( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), base::Bind(&CefCookieManagerImpl::SetCookieInternal, this, gurl, cookie, callback)); return true; } bool CefCookieManagerImpl::DeleteCookies( const CefString& url, const CefString& cookie_name, CefRefPtr callback) { // Empty URLs are allowed but not invalid URLs. GURL gurl = GURL(url.ToString()); if (!gurl.is_empty() && !gurl.is_valid()) return false; GetCookieMonster( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), base::Bind(&CefCookieManagerImpl::DeleteCookiesInternal, this, gurl, cookie_name, callback)); return true; } bool CefCookieManagerImpl::SetStoragePath( const CefString& path, bool persist_session_cookies, CefRefPtr callback) { if (!CEF_CURRENTLY_ON_IOT()) { CEF_POST_TASK(CEF_IOT, base::Bind(base::IgnoreResult(&CefCookieManagerImpl::SetStoragePath), this, path, persist_session_cookies, callback)); return true; } if (HasContext()) { RunMethodWithContext( base::Bind(&CefCookieManagerImpl::SetStoragePathWithContext, this, path, persist_session_cookies, callback)); return true; } base::FilePath new_path; if (!path.empty()) new_path = base::FilePath(path); if (cookie_monster_.get() && ((storage_path_.empty() && path.empty()) || storage_path_ == new_path)) { // The path has not changed so don't do anything. RunAsyncCompletionOnIOThread(callback); return true; } scoped_refptr persistent_store; if (!new_path.empty()) { // TODO(cef): Move directory creation to the blocking pool instead of // allowing file IO on this thread. base::ThreadRestrictions::ScopedAllowIO allow_io; if (base::DirectoryExists(new_path) || base::CreateDirectory(new_path)) { const base::FilePath& cookie_path = new_path.AppendASCII("Cookies"); persistent_store = new content::SQLitePersistentCookieStore( cookie_path, BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), BrowserThread::GetMessageLoopProxyForThread(BrowserThread::DB), persist_session_cookies, NULL, NULL); } else { NOTREACHED() << "The cookie storage directory could not be created"; storage_path_.clear(); } } // Set the new cookie store that will be used for all new requests. The old // cookie store, if any, will be automatically flushed and closed when no // longer referenced. cookie_monster_ = new net::CookieMonster(persistent_store.get(), NULL); if (persistent_store.get() && persist_session_cookies) cookie_monster_->SetPersistSessionCookies(true); storage_path_ = new_path; // Restore the previously supported schemes. SetSupportedSchemes(supported_schemes_, callback); return true; } bool CefCookieManagerImpl::FlushStore( CefRefPtr callback) { GetCookieMonster( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), base::Bind(&CefCookieManagerImpl::FlushStoreInternal, this, callback)); return true; } // static bool CefCookieManagerImpl::GetCefCookie(const net::CanonicalCookie& cc, CefCookie& cookie) { CefString(&cookie.name).FromString(cc.Name()); CefString(&cookie.value).FromString(cc.Value()); CefString(&cookie.domain).FromString(cc.Domain()); CefString(&cookie.path).FromString(cc.Path()); cookie.secure = cc.IsSecure(); cookie.httponly = cc.IsHttpOnly(); cef_time_from_basetime(cc.CreationDate(), cookie.creation); cef_time_from_basetime(cc.LastAccessDate(), cookie.last_access); cookie.has_expires = cc.IsPersistent(); if (cookie.has_expires) cef_time_from_basetime(cc.ExpiryDate(), cookie.expires); return true; } // static bool CefCookieManagerImpl::GetCefCookie(const GURL& url, const std::string& cookie_line, CefCookie& cookie) { // Parse the cookie. net::ParsedCookie pc(cookie_line); if (!pc.IsValid()) return false; std::string cookie_domain; if (!GetCookieDomain(url, pc, &cookie_domain)) return false; std::string cookie_path = net::CanonicalCookie::CanonPath(url, pc); base::Time creation_time = base::Time::Now(); base::Time cookie_expires = net::CanonicalCookie::CanonExpiration(pc, creation_time, creation_time); CefString(&cookie.name).FromString(pc.Name()); CefString(&cookie.value).FromString(pc.Value()); CefString(&cookie.domain).FromString(cookie_domain); CefString(&cookie.path).FromString(cookie_path); cookie.secure = pc.IsSecure(); cookie.httponly = pc.IsHttpOnly(); cef_time_from_basetime(creation_time, cookie.creation); cef_time_from_basetime(creation_time, cookie.last_access); cookie.has_expires = !cookie_expires.is_null(); if (cookie.has_expires) cef_time_from_basetime(cookie_expires, cookie.expires); return true; } bool CefCookieManagerImpl::HasContext() { CEF_REQUIRE_IOT(); return (request_context_impl_.get() || request_context_.get()); } void CefCookieManagerImpl::RunMethodWithContext( const CefRequestContextImpl::RequestContextCallback& method) { CEF_REQUIRE_IOT(); if (request_context_impl_.get()) { method.Run(request_context_impl_); } else if (request_context_.get()) { // Try again after the request context is initialized. request_context_->GetRequestContextImpl( BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO), method); } else { NOTREACHED(); } } void CefCookieManagerImpl::InitWithContext( CefRefPtr callback, scoped_refptr request_context) { CEF_REQUIRE_IOT(); DCHECK(!request_context_impl_.get()); request_context_impl_ = request_context; // Clear the CefRequestContextImpl reference here to avoid a potential // reference loop between CefRequestContextImpl (which has a reference to // CefRequestContextHandler), CefRequestContextHandler (which may keep a // reference to this object) and this object. request_context_ = NULL; RunAsyncCompletionOnIOThread(callback); } void CefCookieManagerImpl::SetStoragePathWithContext( const CefString& path, bool persist_session_cookies, CefRefPtr callback, scoped_refptr request_context) { CEF_REQUIRE_IOT(); base::FilePath new_path; if (!path.empty()) new_path = base::FilePath(path); request_context->SetCookieStoragePath(new_path, persist_session_cookies); RunAsyncCompletionOnIOThread(callback); } void CefCookieManagerImpl::SetSupportedSchemesWithContext( const std::vector& schemes, CefRefPtr callback, scoped_refptr request_context) { CEF_REQUIRE_IOT(); std::vector scheme_vec; std::vector::const_iterator it = schemes.begin(); for (; it != schemes.end(); ++it) scheme_vec.push_back(it->ToString()); request_context->SetCookieSupportedSchemes(scheme_vec); RunAsyncCompletionOnIOThread(callback); } void CefCookieManagerImpl::GetCookieMonsterWithContext( scoped_refptr task_runner, const CookieMonsterCallback& callback, scoped_refptr request_context) { CEF_REQUIRE_IOT(); scoped_refptr cookie_monster = request_context->GetURLRequestContext()->cookie_store()-> GetCookieMonster(); if (task_runner->BelongsToCurrentThread()) { // Execute the callback immediately. callback.Run(cookie_monster); } else { // Execute the callback on the target thread. task_runner->PostTask(FROM_HERE, base::Bind(callback, cookie_monster)); } } void CefCookieManagerImpl::VisitAllCookiesInternal( CefRefPtr visitor, scoped_refptr cookie_monster) { CEF_REQUIRE_IOT(); scoped_refptr callback( new VisitCookiesCallback(cookie_monster, visitor)); cookie_monster->GetAllCookiesAsync( base::Bind(&VisitCookiesCallback::Run, callback.get())); } void CefCookieManagerImpl::VisitUrlCookiesInternal( const CefString& url, bool includeHttpOnly, CefRefPtr visitor, scoped_refptr cookie_monster) { CEF_REQUIRE_IOT(); net::CookieOptions options; if (includeHttpOnly) options.set_include_httponly(); scoped_refptr callback( new VisitCookiesCallback(cookie_monster, visitor)); GURL gurl = GURL(url.ToString()); cookie_monster->GetAllCookiesForURLWithOptionsAsync(gurl, options, base::Bind(&VisitCookiesCallback::Run, callback.get())); } void CefCookieManagerImpl::SetCookieInternal( const GURL& url, const CefCookie& cookie, CefRefPtr callback, scoped_refptr cookie_monster) { CEF_REQUIRE_IOT(); std::string name = CefString(&cookie.name).ToString(); std::string value = CefString(&cookie.value).ToString(); std::string domain = CefString(&cookie.domain).ToString(); std::string path = CefString(&cookie.path).ToString(); base::Time expiration_time; if (cookie.has_expires) cef_time_to_basetime(cookie.expires, expiration_time); cookie_monster->SetCookieWithDetailsAsync( url, name, value, domain, path, expiration_time, cookie.secure ? true : false, cookie.httponly ? true : false, false, // First-party only. net::COOKIE_PRIORITY_DEFAULT, base::Bind(SetCookieCallbackImpl, callback)); } void CefCookieManagerImpl::DeleteCookiesInternal( const GURL& url, const CefString& cookie_name, CefRefPtr callback, scoped_refptr cookie_monster) { CEF_REQUIRE_IOT(); if (url.is_empty()) { // Delete all cookies. cookie_monster->DeleteAllAsync( base::Bind(DeleteCookiesCallbackImpl, callback)); } else if (cookie_name.empty()) { // Delete all matching host cookies. cookie_monster->DeleteAllForHostAsync(url, base::Bind(DeleteCookiesCallbackImpl, callback)); } else { // Delete all matching host and domain cookies. cookie_monster->DeleteCookieAsync(url, cookie_name, base::Bind(DeleteCookiesCallbackImpl, callback, -1)); } } void CefCookieManagerImpl::FlushStoreInternal( CefRefPtr callback, scoped_refptr cookie_monster) { CEF_REQUIRE_IOT(); cookie_monster->FlushStore( base::Bind(RunAsyncCompletionOnIOThread, callback)); } // CefCookieManager methods ---------------------------------------------------- // static CefRefPtr CefCookieManager::GetGlobalManager( CefRefPtr callback) { // Verify that the context is in a valid state. if (!CONTEXT_STATE_VALID()) { NOTREACHED() << "context not valid"; return NULL; } return CefRequestContext::GetGlobalContext()->GetDefaultCookieManager( callback); } // static CefRefPtr CefCookieManager::CreateManager( const CefString& path, bool persist_session_cookies, CefRefPtr callback) { // Verify that the context is in a valid state. if (!CONTEXT_STATE_VALID()) { NOTREACHED() << "context not valid"; return NULL; } CefRefPtr cookie_manager = new CefCookieManagerImpl(); cookie_manager->Initialize(NULL, path, persist_session_cookies, callback); return cookie_manager.get(); }