Supervised user import: Listen for profile creation/deletion
[chromium-blink-merge.git] / content / browser / net / sqlite_persistent_cookie_store.cc
blob61cb329463948f066b963d8079642729402cf477
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "content/browser/net/sqlite_persistent_cookie_store.h"
7 #include <list>
8 #include <map>
9 #include <set>
10 #include <utility>
12 #include "base/basictypes.h"
13 #include "base/bind.h"
14 #include "base/callback.h"
15 #include "base/files/file_path.h"
16 #include "base/files/file_util.h"
17 #include "base/location.h"
18 #include "base/logging.h"
19 #include "base/memory/ref_counted.h"
20 #include "base/memory/scoped_ptr.h"
21 #include "base/metrics/field_trial.h"
22 #include "base/metrics/histogram.h"
23 #include "base/profiler/scoped_tracker.h"
24 #include "base/sequenced_task_runner.h"
25 #include "base/strings/string_util.h"
26 #include "base/strings/stringprintf.h"
27 #include "base/synchronization/lock.h"
28 #include "base/threading/sequenced_worker_pool.h"
29 #include "base/time/time.h"
30 #include "content/public/browser/browser_thread.h"
31 #include "content/public/browser/cookie_store_factory.h"
32 #include "net/base/registry_controlled_domains/registry_controlled_domain.h"
33 #include "net/cookies/canonical_cookie.h"
34 #include "net/cookies/cookie_constants.h"
35 #include "net/cookies/cookie_util.h"
36 #include "net/extras/sqlite/cookie_crypto_delegate.h"
37 #include "sql/error_delegate_util.h"
38 #include "sql/meta_table.h"
39 #include "sql/statement.h"
40 #include "sql/transaction.h"
41 #include "storage/browser/quota/special_storage_policy.h"
42 #include "third_party/sqlite/sqlite3.h"
43 #include "url/gurl.h"
45 using base::Time;
47 namespace {
49 // The persistent cookie store is loaded into memory on eTLD at a time. This
50 // variable controls the delay between loading eTLDs, so as to not overload the
51 // CPU or I/O with these low priority requests immediately after start up.
52 const int kLoadDelayMilliseconds = 0;
54 } // namespace
56 namespace content {
58 // This class is designed to be shared between any client thread and the
59 // background task runner. It batches operations and commits them on a timer.
61 // SQLitePersistentCookieStore::Load is called to load all cookies. It
62 // delegates to Backend::Load, which posts a Backend::LoadAndNotifyOnDBThread
63 // task to the background runner. This task calls Backend::ChainLoadCookies(),
64 // which repeatedly posts itself to the BG runner to load each eTLD+1's cookies
65 // in separate tasks. When this is complete, Backend::CompleteLoadOnIOThread is
66 // posted to the client runner, which notifies the caller of
67 // SQLitePersistentCookieStore::Load that the load is complete.
69 // If a priority load request is invoked via SQLitePersistentCookieStore::
70 // LoadCookiesForKey, it is delegated to Backend::LoadCookiesForKey, which posts
71 // Backend::LoadKeyAndNotifyOnDBThread to the BG runner. That routine loads just
72 // that single domain key (eTLD+1)'s cookies, and posts a Backend::
73 // CompleteLoadForKeyOnIOThread to the client runner to notify the caller of
74 // SQLitePersistentCookieStore::LoadCookiesForKey that that load is complete.
76 // Subsequent to loading, mutations may be queued by any thread using
77 // AddCookie, UpdateCookieAccessTime, and DeleteCookie. These are flushed to
78 // disk on the BG runner every 30 seconds, 512 operations, or call to Flush(),
79 // whichever occurs first.
80 class SQLitePersistentCookieStore::Backend
81 : public base::RefCountedThreadSafe<SQLitePersistentCookieStore::Backend> {
82 public:
83 Backend(
84 const base::FilePath& path,
85 const scoped_refptr<base::SequencedTaskRunner>& client_task_runner,
86 const scoped_refptr<base::SequencedTaskRunner>& background_task_runner,
87 bool restore_old_session_cookies,
88 storage::SpecialStoragePolicy* special_storage_policy,
89 net::CookieCryptoDelegate* crypto_delegate)
90 : path_(path),
91 num_pending_(0),
92 force_keep_session_state_(false),
93 initialized_(false),
94 corruption_detected_(false),
95 restore_old_session_cookies_(restore_old_session_cookies),
96 special_storage_policy_(special_storage_policy),
97 num_cookies_read_(0),
98 client_task_runner_(client_task_runner),
99 background_task_runner_(background_task_runner),
100 num_priority_waiting_(0),
101 total_priority_requests_(0),
102 crypto_(crypto_delegate) {}
104 // Creates or loads the SQLite database.
105 void Load(const LoadedCallback& loaded_callback);
107 // Loads cookies for the domain key (eTLD+1).
108 void LoadCookiesForKey(const std::string& domain,
109 const LoadedCallback& loaded_callback);
111 // Steps through all results of |smt|, makes a cookie from each, and adds the
112 // cookie to |cookies|. This method also updates |cookies_per_origin_| and
113 // |num_cookies_read_|.
114 void MakeCookiesFromSQLStatement(std::vector<net::CanonicalCookie*>* cookies,
115 sql::Statement* statement);
117 // Batch a cookie addition.
118 void AddCookie(const net::CanonicalCookie& cc);
120 // Batch a cookie access time update.
121 void UpdateCookieAccessTime(const net::CanonicalCookie& cc);
123 // Batch a cookie deletion.
124 void DeleteCookie(const net::CanonicalCookie& cc);
126 // Commit pending operations as soon as possible.
127 void Flush(const base::Closure& callback);
129 // Commit any pending operations and close the database. This must be called
130 // before the object is destructed.
131 void Close();
133 void SetForceKeepSessionState();
135 private:
136 friend class base::RefCountedThreadSafe<SQLitePersistentCookieStore::Backend>;
138 // You should call Close() before destructing this object.
139 ~Backend() {
140 DCHECK(!db_.get()) << "Close should have already been called.";
141 DCHECK(num_pending_ == 0 && pending_.empty());
143 for (net::CanonicalCookie* cookie : cookies_) {
144 delete cookie;
148 // Database upgrade statements.
149 bool EnsureDatabaseVersion();
151 class PendingOperation {
152 public:
153 typedef enum {
154 COOKIE_ADD,
155 COOKIE_UPDATEACCESS,
156 COOKIE_DELETE,
157 } OperationType;
159 PendingOperation(OperationType op, const net::CanonicalCookie& cc)
160 : op_(op), cc_(cc) { }
162 OperationType op() const { return op_; }
163 const net::CanonicalCookie& cc() const { return cc_; }
165 private:
166 OperationType op_;
167 net::CanonicalCookie cc_;
170 private:
171 // Creates or loads the SQLite database on background runner.
172 void LoadAndNotifyInBackground(const LoadedCallback& loaded_callback,
173 const base::Time& posted_at);
175 // Loads cookies for the domain key (eTLD+1) on background runner.
176 void LoadKeyAndNotifyInBackground(const std::string& domains,
177 const LoadedCallback& loaded_callback,
178 const base::Time& posted_at);
180 // Notifies the CookieMonster when loading completes for a specific domain key
181 // or for all domain keys. Triggers the callback and passes it all cookies
182 // that have been loaded from DB since last IO notification.
183 void Notify(const LoadedCallback& loaded_callback, bool load_success);
185 // Sends notification when the entire store is loaded, and reports metrics
186 // for the total time to load and aggregated results from any priority loads
187 // that occurred.
188 void CompleteLoadInForeground(const LoadedCallback& loaded_callback,
189 bool load_success);
191 // Sends notification when a single priority load completes. Updates priority
192 // load metric data. The data is sent only after the final load completes.
193 void CompleteLoadForKeyInForeground(const LoadedCallback& loaded_callback,
194 bool load_success,
195 const base::Time& requested_at);
197 // Sends all metrics, including posting a ReportMetricsInBackground task.
198 // Called after all priority and regular loading is complete.
199 void ReportMetrics();
201 // Sends background-runner owned metrics (i.e., the combined duration of all
202 // BG-runner tasks).
203 void ReportMetricsInBackground();
205 // Initialize the data base.
206 bool InitializeDatabase();
208 // Loads cookies for the next domain key from the DB, then either reschedules
209 // itself or schedules the provided callback to run on the client runner (if
210 // all domains are loaded).
211 void ChainLoadCookies(const LoadedCallback& loaded_callback);
213 // Load all cookies for a set of domains/hosts
214 bool LoadCookiesForDomains(const std::set<std::string>& key);
216 // Batch a cookie operation (add or delete)
217 void BatchOperation(PendingOperation::OperationType op,
218 const net::CanonicalCookie& cc);
219 // Commit our pending operations to the database.
220 void Commit();
221 // Close() executed on the background runner.
222 void InternalBackgroundClose();
224 void DeleteSessionCookiesOnStartup();
226 void DeleteSessionCookiesOnShutdown();
228 void DatabaseErrorCallback(int error, sql::Statement* stmt);
229 void KillDatabase();
231 void PostBackgroundTask(const tracked_objects::Location& origin,
232 const base::Closure& task);
233 void PostClientTask(const tracked_objects::Location& origin,
234 const base::Closure& task);
236 // Shared code between the different load strategies to be used after all
237 // cookies have been loaded.
238 void FinishedLoadingCookies(const LoadedCallback& loaded_callback,
239 bool success);
241 base::FilePath path_;
242 scoped_ptr<sql::Connection> db_;
243 sql::MetaTable meta_table_;
245 typedef std::list<PendingOperation*> PendingOperationsList;
246 PendingOperationsList pending_;
247 PendingOperationsList::size_type num_pending_;
248 // True if the persistent store should skip delete on exit rules.
249 bool force_keep_session_state_;
250 // Guard |cookies_|, |pending_|, |num_pending_|, |force_keep_session_state_|
251 base::Lock lock_;
253 // Temporary buffer for cookies loaded from DB. Accumulates cookies to reduce
254 // the number of messages sent to the client runner. Sent back in response to
255 // individual load requests for domain keys or when all loading completes.
256 // Ownership of the cookies in this vector is transferred to the client in
257 // response to individual load requests or when all loading completes.
258 std::vector<net::CanonicalCookie*> cookies_;
260 // Map of domain keys(eTLD+1) to domains/hosts that are to be loaded from DB.
261 std::map<std::string, std::set<std::string> > keys_to_load_;
263 // Map of (domain keys(eTLD+1), is secure cookie) to number of cookies in the
264 // database.
265 typedef std::pair<std::string, bool> CookieOrigin;
266 typedef std::map<CookieOrigin, int> CookiesPerOriginMap;
267 CookiesPerOriginMap cookies_per_origin_;
269 // Indicates if DB has been initialized.
270 bool initialized_;
272 // Indicates if the kill-database callback has been scheduled.
273 bool corruption_detected_;
275 // If false, we should filter out session cookies when reading the DB.
276 bool restore_old_session_cookies_;
278 // Policy defining what data is deleted on shutdown.
279 scoped_refptr<storage::SpecialStoragePolicy> special_storage_policy_;
281 // The cumulative time spent loading the cookies on the background runner.
282 // Incremented and reported from the background runner.
283 base::TimeDelta cookie_load_duration_;
285 // The total number of cookies read. Incremented and reported on the
286 // background runner.
287 int num_cookies_read_;
289 scoped_refptr<base::SequencedTaskRunner> client_task_runner_;
290 scoped_refptr<base::SequencedTaskRunner> background_task_runner_;
292 // Guards the following metrics-related properties (only accessed when
293 // starting/completing priority loads or completing the total load).
294 base::Lock metrics_lock_;
295 int num_priority_waiting_;
296 // The total number of priority requests.
297 int total_priority_requests_;
298 // The time when |num_priority_waiting_| incremented to 1.
299 base::Time current_priority_wait_start_;
300 // The cumulative duration of time when |num_priority_waiting_| was greater
301 // than 1.
302 base::TimeDelta priority_wait_duration_;
303 // Class with functions that do cryptographic operations (for protecting
304 // cookies stored persistently).
306 // Not owned.
307 net::CookieCryptoDelegate* crypto_;
309 DISALLOW_COPY_AND_ASSIGN(Backend);
312 namespace {
314 // Version number of the database.
316 // Version 9 adds a partial index to track non-persistent cookies.
317 // Non-persistent cookies sometimes need to be deleted on startup. There are
318 // frequently few or no non-persistent cookies, so the partial index allows the
319 // deletion to be sped up or skipped, without having to page in the DB.
321 // Version 8 adds "first-party only" cookies.
323 // Version 7 adds encrypted values. Old values will continue to be used but
324 // all new values written will be encrypted on selected operating systems. New
325 // records read by old clients will simply get an empty cookie value while old
326 // records read by new clients will continue to operate with the unencrypted
327 // version. New and old clients alike will always write/update records with
328 // what they support.
330 // Version 6 adds cookie priorities. This allows developers to influence the
331 // order in which cookies are evicted in order to meet domain cookie limits.
333 // Version 5 adds the columns has_expires and is_persistent, so that the
334 // database can store session cookies as well as persistent cookies. Databases
335 // of version 5 are incompatible with older versions of code. If a database of
336 // version 5 is read by older code, session cookies will be treated as normal
337 // cookies. Currently, these fields are written, but not read anymore.
339 // In version 4, we migrated the time epoch. If you open the DB with an older
340 // version on Mac or Linux, the times will look wonky, but the file will likely
341 // be usable. On Windows version 3 and 4 are the same.
343 // Version 3 updated the database to include the last access time, so we can
344 // expire them in decreasing order of use when we've reached the maximum
345 // number of cookies.
346 const int kCurrentVersionNumber = 9;
347 const int kCompatibleVersionNumber = 5;
349 // Possible values for the 'priority' column.
350 enum DBCookiePriority {
351 kCookiePriorityLow = 0,
352 kCookiePriorityMedium = 1,
353 kCookiePriorityHigh = 2,
356 DBCookiePriority CookiePriorityToDBCookiePriority(net::CookiePriority value) {
357 switch (value) {
358 case net::COOKIE_PRIORITY_LOW:
359 return kCookiePriorityLow;
360 case net::COOKIE_PRIORITY_MEDIUM:
361 return kCookiePriorityMedium;
362 case net::COOKIE_PRIORITY_HIGH:
363 return kCookiePriorityHigh;
366 NOTREACHED();
367 return kCookiePriorityMedium;
370 net::CookiePriority DBCookiePriorityToCookiePriority(DBCookiePriority value) {
371 switch (value) {
372 case kCookiePriorityLow:
373 return net::COOKIE_PRIORITY_LOW;
374 case kCookiePriorityMedium:
375 return net::COOKIE_PRIORITY_MEDIUM;
376 case kCookiePriorityHigh:
377 return net::COOKIE_PRIORITY_HIGH;
380 NOTREACHED();
381 return net::COOKIE_PRIORITY_DEFAULT;
384 // Increments a specified TimeDelta by the duration between this object's
385 // constructor and destructor. Not thread safe. Multiple instances may be
386 // created with the same delta instance as long as their lifetimes are nested.
387 // The shortest lived instances have no impact.
388 class IncrementTimeDelta {
389 public:
390 explicit IncrementTimeDelta(base::TimeDelta* delta) :
391 delta_(delta),
392 original_value_(*delta),
393 start_(base::Time::Now()) {}
395 ~IncrementTimeDelta() {
396 *delta_ = original_value_ + base::Time::Now() - start_;
399 private:
400 base::TimeDelta* delta_;
401 base::TimeDelta original_value_;
402 base::Time start_;
404 DISALLOW_COPY_AND_ASSIGN(IncrementTimeDelta);
407 // Initializes the cookies table, returning true on success.
408 bool InitTable(sql::Connection* db) {
409 if (db->DoesTableExist("cookies"))
410 return true;
412 std::string stmt(base::StringPrintf(
413 "CREATE TABLE cookies ("
414 "creation_utc INTEGER NOT NULL UNIQUE PRIMARY KEY,"
415 "host_key TEXT NOT NULL,"
416 "name TEXT NOT NULL,"
417 "value TEXT NOT NULL,"
418 "path TEXT NOT NULL,"
419 "expires_utc INTEGER NOT NULL,"
420 "secure INTEGER NOT NULL,"
421 "httponly INTEGER NOT NULL,"
422 "last_access_utc INTEGER NOT NULL, "
423 "has_expires INTEGER NOT NULL DEFAULT 1, "
424 "persistent INTEGER NOT NULL DEFAULT 1,"
425 "priority INTEGER NOT NULL DEFAULT %d,"
426 "encrypted_value BLOB DEFAULT '',"
427 "firstpartyonly INTEGER NOT NULL DEFAULT 0)",
428 CookiePriorityToDBCookiePriority(net::COOKIE_PRIORITY_DEFAULT)));
429 if (!db->Execute(stmt.c_str()))
430 return false;
432 if (!db->Execute("CREATE INDEX domain ON cookies(host_key)"))
433 return false;
435 #if defined(OS_IOS)
436 // iOS 8.1 and older doesn't support partial indices. iOS 8.2 supports
437 // partial indices.
438 if (!db->Execute("CREATE INDEX is_transient ON cookies(persistent)")) {
439 #else
440 if (!db->Execute(
441 "CREATE INDEX is_transient ON cookies(persistent) "
442 "where persistent != 1")) {
443 #endif
444 return false;
447 return true;
450 } // namespace
452 void SQLitePersistentCookieStore::Backend::Load(
453 const LoadedCallback& loaded_callback) {
454 // This function should be called only once per instance.
455 DCHECK(!db_.get());
456 PostBackgroundTask(FROM_HERE, base::Bind(
457 &Backend::LoadAndNotifyInBackground, this,
458 loaded_callback, base::Time::Now()));
461 void SQLitePersistentCookieStore::Backend::LoadCookiesForKey(
462 const std::string& key,
463 const LoadedCallback& loaded_callback) {
465 base::AutoLock locked(metrics_lock_);
466 if (num_priority_waiting_ == 0)
467 current_priority_wait_start_ = base::Time::Now();
468 num_priority_waiting_++;
469 total_priority_requests_++;
472 PostBackgroundTask(FROM_HERE, base::Bind(
473 &Backend::LoadKeyAndNotifyInBackground,
474 this, key, loaded_callback, base::Time::Now()));
477 void SQLitePersistentCookieStore::Backend::LoadAndNotifyInBackground(
478 const LoadedCallback& loaded_callback, const base::Time& posted_at) {
479 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
480 IncrementTimeDelta increment(&cookie_load_duration_);
482 UMA_HISTOGRAM_CUSTOM_TIMES(
483 "Cookie.TimeLoadDBQueueWait",
484 base::Time::Now() - posted_at,
485 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
486 50);
488 if (!InitializeDatabase()) {
489 PostClientTask(FROM_HERE, base::Bind(
490 &Backend::CompleteLoadInForeground, this, loaded_callback, false));
491 } else {
492 ChainLoadCookies(loaded_callback);
496 void SQLitePersistentCookieStore::Backend::LoadKeyAndNotifyInBackground(
497 const std::string& key,
498 const LoadedCallback& loaded_callback,
499 const base::Time& posted_at) {
500 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
501 IncrementTimeDelta increment(&cookie_load_duration_);
503 UMA_HISTOGRAM_CUSTOM_TIMES(
504 "Cookie.TimeKeyLoadDBQueueWait",
505 base::Time::Now() - posted_at,
506 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
507 50);
509 bool success = false;
510 if (InitializeDatabase()) {
511 std::map<std::string, std::set<std::string> >::iterator
512 it = keys_to_load_.find(key);
513 if (it != keys_to_load_.end()) {
514 success = LoadCookiesForDomains(it->second);
515 keys_to_load_.erase(it);
516 } else {
517 success = true;
521 PostClientTask(FROM_HERE, base::Bind(
522 &SQLitePersistentCookieStore::Backend::CompleteLoadForKeyInForeground,
523 this, loaded_callback, success, posted_at));
526 void SQLitePersistentCookieStore::Backend::CompleteLoadForKeyInForeground(
527 const LoadedCallback& loaded_callback,
528 bool load_success,
529 const::Time& requested_at) {
530 DCHECK(client_task_runner_->RunsTasksOnCurrentThread());
532 UMA_HISTOGRAM_CUSTOM_TIMES(
533 "Cookie.TimeKeyLoadTotalWait",
534 base::Time::Now() - requested_at,
535 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
536 50);
538 Notify(loaded_callback, load_success);
541 base::AutoLock locked(metrics_lock_);
542 num_priority_waiting_--;
543 if (num_priority_waiting_ == 0) {
544 priority_wait_duration_ +=
545 base::Time::Now() - current_priority_wait_start_;
551 void SQLitePersistentCookieStore::Backend::ReportMetricsInBackground() {
552 UMA_HISTOGRAM_CUSTOM_TIMES(
553 "Cookie.TimeLoad",
554 cookie_load_duration_,
555 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
556 50);
559 void SQLitePersistentCookieStore::Backend::ReportMetrics() {
560 PostBackgroundTask(FROM_HERE, base::Bind(
561 &SQLitePersistentCookieStore::Backend::ReportMetricsInBackground, this));
564 base::AutoLock locked(metrics_lock_);
565 UMA_HISTOGRAM_CUSTOM_TIMES(
566 "Cookie.PriorityBlockingTime",
567 priority_wait_duration_,
568 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
569 50);
571 UMA_HISTOGRAM_COUNTS_100(
572 "Cookie.PriorityLoadCount",
573 total_priority_requests_);
575 UMA_HISTOGRAM_COUNTS_10000(
576 "Cookie.NumberOfLoadedCookies",
577 num_cookies_read_);
581 void SQLitePersistentCookieStore::Backend::CompleteLoadInForeground(
582 const LoadedCallback& loaded_callback, bool load_success) {
583 // TODO(pkasting): Remove ScopedTracker below once crbug.com/457528 is fixed.
584 tracked_objects::ScopedTracker tracking_profile(
585 FROM_HERE_WITH_EXPLICIT_FUNCTION(
586 "457528 "
587 "SQLitePersistentCookieStore::Backend::CompleteLoadInForeground"));
588 Notify(loaded_callback, load_success);
590 if (load_success)
591 ReportMetrics();
594 void SQLitePersistentCookieStore::Backend::Notify(
595 const LoadedCallback& loaded_callback,
596 bool load_success) {
597 DCHECK(client_task_runner_->RunsTasksOnCurrentThread());
599 std::vector<net::CanonicalCookie*> cookies;
601 base::AutoLock locked(lock_);
602 cookies.swap(cookies_);
605 loaded_callback.Run(cookies);
608 bool SQLitePersistentCookieStore::Backend::InitializeDatabase() {
609 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
611 if (initialized_ || corruption_detected_) {
612 // Return false if we were previously initialized but the DB has since been
613 // closed, or if corruption caused a database reset during initialization.
614 return db_ != NULL;
617 base::Time start = base::Time::Now();
619 const base::FilePath dir = path_.DirName();
620 if (!base::PathExists(dir) && !base::CreateDirectory(dir)) {
621 return false;
624 int64 db_size = 0;
625 if (base::GetFileSize(path_, &db_size))
626 UMA_HISTOGRAM_COUNTS("Cookie.DBSizeInKB", db_size / 1024 );
628 db_.reset(new sql::Connection);
629 db_->set_histogram_tag("Cookie");
631 // Unretained to avoid a ref loop with |db_|.
632 db_->set_error_callback(
633 base::Bind(&SQLitePersistentCookieStore::Backend::DatabaseErrorCallback,
634 base::Unretained(this)));
636 if (!db_->Open(path_)) {
637 NOTREACHED() << "Unable to open cookie DB.";
638 if (corruption_detected_)
639 db_->Raze();
640 meta_table_.Reset();
641 db_.reset();
642 return false;
645 if (!EnsureDatabaseVersion() || !InitTable(db_.get())) {
646 NOTREACHED() << "Unable to open cookie DB.";
647 if (corruption_detected_)
648 db_->Raze();
649 meta_table_.Reset();
650 db_.reset();
651 return false;
654 UMA_HISTOGRAM_CUSTOM_TIMES(
655 "Cookie.TimeInitializeDB",
656 base::Time::Now() - start,
657 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
658 50);
660 start = base::Time::Now();
662 // Retrieve all the domains
663 sql::Statement smt(db_->GetUniqueStatement(
664 "SELECT DISTINCT host_key FROM cookies"));
666 if (!smt.is_valid()) {
667 if (corruption_detected_)
668 db_->Raze();
669 meta_table_.Reset();
670 db_.reset();
671 return false;
674 std::vector<std::string> host_keys;
675 while (smt.Step())
676 host_keys.push_back(smt.ColumnString(0));
678 UMA_HISTOGRAM_CUSTOM_TIMES(
679 "Cookie.TimeLoadDomains",
680 base::Time::Now() - start,
681 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
682 50);
684 base::Time start_parse = base::Time::Now();
686 // Build a map of domain keys (always eTLD+1) to domains.
687 for (size_t idx = 0; idx < host_keys.size(); ++idx) {
688 const std::string& domain = host_keys[idx];
689 std::string key =
690 net::registry_controlled_domains::GetDomainAndRegistry(
691 domain,
692 net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES);
694 keys_to_load_[key].insert(domain);
697 UMA_HISTOGRAM_CUSTOM_TIMES(
698 "Cookie.TimeParseDomains",
699 base::Time::Now() - start_parse,
700 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
701 50);
703 UMA_HISTOGRAM_CUSTOM_TIMES(
704 "Cookie.TimeInitializeDomainMap",
705 base::Time::Now() - start,
706 base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromMinutes(1),
707 50);
709 initialized_ = true;
711 if (!restore_old_session_cookies_)
712 DeleteSessionCookiesOnStartup();
713 return true;
716 void SQLitePersistentCookieStore::Backend::ChainLoadCookies(
717 const LoadedCallback& loaded_callback) {
718 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
719 IncrementTimeDelta increment(&cookie_load_duration_);
721 bool load_success = true;
723 if (!db_) {
724 // Close() has been called on this store.
725 load_success = false;
726 } else if (keys_to_load_.size() > 0) {
727 // Load cookies for the first domain key.
728 std::map<std::string, std::set<std::string> >::iterator
729 it = keys_to_load_.begin();
730 load_success = LoadCookiesForDomains(it->second);
731 keys_to_load_.erase(it);
734 // If load is successful and there are more domain keys to be loaded,
735 // then post a background task to continue chain-load;
736 // Otherwise notify on client runner.
737 if (load_success && keys_to_load_.size() > 0) {
738 bool success = background_task_runner_->PostDelayedTask(
739 FROM_HERE,
740 base::Bind(&Backend::ChainLoadCookies, this, loaded_callback),
741 base::TimeDelta::FromMilliseconds(kLoadDelayMilliseconds));
742 if (!success) {
743 LOG(WARNING) << "Failed to post task from " << FROM_HERE.ToString()
744 << " to background_task_runner_.";
746 } else {
747 FinishedLoadingCookies(loaded_callback, load_success);
751 bool SQLitePersistentCookieStore::Backend::LoadCookiesForDomains(
752 const std::set<std::string>& domains) {
753 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
755 sql::Statement smt;
756 if (restore_old_session_cookies_) {
757 smt.Assign(db_->GetCachedStatement(
758 SQL_FROM_HERE,
759 "SELECT creation_utc, host_key, name, value, encrypted_value, path, "
760 "expires_utc, secure, httponly, firstpartyonly, last_access_utc, "
761 "has_expires, persistent, priority FROM cookies WHERE host_key = ?"));
762 } else {
763 smt.Assign(db_->GetCachedStatement(
764 SQL_FROM_HERE,
765 "SELECT creation_utc, host_key, name, value, encrypted_value, path, "
766 "expires_utc, secure, httponly, firstpartyonly, last_access_utc, "
767 "has_expires, persistent, priority FROM cookies WHERE host_key = ? "
768 "AND persistent = 1"));
770 if (!smt.is_valid()) {
771 smt.Clear(); // Disconnect smt_ref from db_.
772 meta_table_.Reset();
773 db_.reset();
774 return false;
777 std::vector<net::CanonicalCookie*> cookies;
778 std::set<std::string>::const_iterator it = domains.begin();
779 for (; it != domains.end(); ++it) {
780 smt.BindString(0, *it);
781 MakeCookiesFromSQLStatement(&cookies, &smt);
782 smt.Reset(true);
785 base::AutoLock locked(lock_);
786 cookies_.insert(cookies_.end(), cookies.begin(), cookies.end());
788 return true;
791 void SQLitePersistentCookieStore::Backend::MakeCookiesFromSQLStatement(
792 std::vector<net::CanonicalCookie*>* cookies,
793 sql::Statement* statement) {
794 sql::Statement& smt = *statement;
795 while (smt.Step()) {
796 std::string value;
797 std::string encrypted_value = smt.ColumnString(4);
798 if (!encrypted_value.empty() && crypto_) {
799 crypto_->DecryptString(encrypted_value, &value);
800 } else {
801 DCHECK(encrypted_value.empty());
802 value = smt.ColumnString(3);
804 scoped_ptr<net::CanonicalCookie> cc(new net::CanonicalCookie(
805 // The "source" URL is not used with persisted cookies.
806 GURL(), // Source
807 smt.ColumnString(2), // name
808 value, // value
809 smt.ColumnString(1), // domain
810 smt.ColumnString(5), // path
811 Time::FromInternalValue(smt.ColumnInt64(0)), // creation_utc
812 Time::FromInternalValue(smt.ColumnInt64(6)), // expires_utc
813 Time::FromInternalValue(smt.ColumnInt64(10)), // last_access_utc
814 smt.ColumnInt(7) != 0, // secure
815 smt.ColumnInt(8) != 0, // httponly
816 smt.ColumnInt(9) != 0, // firstpartyonly
817 DBCookiePriorityToCookiePriority(
818 static_cast<DBCookiePriority>(smt.ColumnInt(13))))); // priority
819 DLOG_IF(WARNING, cc->CreationDate() > Time::Now())
820 << L"CreationDate too recent";
821 cookies_per_origin_[CookieOrigin(cc->Domain(), cc->IsSecure())]++;
822 cookies->push_back(cc.release());
823 ++num_cookies_read_;
827 bool SQLitePersistentCookieStore::Backend::EnsureDatabaseVersion() {
828 // Version check.
829 if (!meta_table_.Init(
830 db_.get(), kCurrentVersionNumber, kCompatibleVersionNumber)) {
831 return false;
834 if (meta_table_.GetCompatibleVersionNumber() > kCurrentVersionNumber) {
835 LOG(WARNING) << "Cookie database is too new.";
836 return false;
839 int cur_version = meta_table_.GetVersionNumber();
840 if (cur_version == 2) {
841 sql::Transaction transaction(db_.get());
842 if (!transaction.Begin())
843 return false;
844 if (!db_->Execute("ALTER TABLE cookies ADD COLUMN last_access_utc "
845 "INTEGER DEFAULT 0") ||
846 !db_->Execute("UPDATE cookies SET last_access_utc = creation_utc")) {
847 LOG(WARNING) << "Unable to update cookie database to version 3.";
848 return false;
850 ++cur_version;
851 meta_table_.SetVersionNumber(cur_version);
852 meta_table_.SetCompatibleVersionNumber(
853 std::min(cur_version, kCompatibleVersionNumber));
854 transaction.Commit();
857 if (cur_version == 3) {
858 // The time epoch changed for Mac & Linux in this version to match Windows.
859 // This patch came after the main epoch change happened, so some
860 // developers have "good" times for cookies added by the more recent
861 // versions. So we have to be careful to only update times that are under
862 // the old system (which will appear to be from before 1970 in the new
863 // system). The magic number used below is 1970 in our time units.
864 sql::Transaction transaction(db_.get());
865 transaction.Begin();
866 #if !defined(OS_WIN)
867 ignore_result(db_->Execute(
868 "UPDATE cookies "
869 "SET creation_utc = creation_utc + 11644473600000000 "
870 "WHERE rowid IN "
871 "(SELECT rowid FROM cookies WHERE "
872 "creation_utc > 0 AND creation_utc < 11644473600000000)"));
873 ignore_result(db_->Execute(
874 "UPDATE cookies "
875 "SET expires_utc = expires_utc + 11644473600000000 "
876 "WHERE rowid IN "
877 "(SELECT rowid FROM cookies WHERE "
878 "expires_utc > 0 AND expires_utc < 11644473600000000)"));
879 ignore_result(db_->Execute(
880 "UPDATE cookies "
881 "SET last_access_utc = last_access_utc + 11644473600000000 "
882 "WHERE rowid IN "
883 "(SELECT rowid FROM cookies WHERE "
884 "last_access_utc > 0 AND last_access_utc < 11644473600000000)"));
885 #endif
886 ++cur_version;
887 meta_table_.SetVersionNumber(cur_version);
888 transaction.Commit();
891 if (cur_version == 4) {
892 const base::TimeTicks start_time = base::TimeTicks::Now();
893 sql::Transaction transaction(db_.get());
894 if (!transaction.Begin())
895 return false;
896 if (!db_->Execute("ALTER TABLE cookies "
897 "ADD COLUMN has_expires INTEGER DEFAULT 1") ||
898 !db_->Execute("ALTER TABLE cookies "
899 "ADD COLUMN persistent INTEGER DEFAULT 1")) {
900 LOG(WARNING) << "Unable to update cookie database to version 5.";
901 return false;
903 ++cur_version;
904 meta_table_.SetVersionNumber(cur_version);
905 meta_table_.SetCompatibleVersionNumber(
906 std::min(cur_version, kCompatibleVersionNumber));
907 transaction.Commit();
908 UMA_HISTOGRAM_TIMES("Cookie.TimeDatabaseMigrationToV5",
909 base::TimeTicks::Now() - start_time);
912 if (cur_version == 5) {
913 const base::TimeTicks start_time = base::TimeTicks::Now();
914 sql::Transaction transaction(db_.get());
915 if (!transaction.Begin())
916 return false;
917 // Alter the table to add the priority column with a default value.
918 std::string stmt(base::StringPrintf(
919 "ALTER TABLE cookies ADD COLUMN priority INTEGER DEFAULT %d",
920 CookiePriorityToDBCookiePriority(net::COOKIE_PRIORITY_DEFAULT)));
921 if (!db_->Execute(stmt.c_str())) {
922 LOG(WARNING) << "Unable to update cookie database to version 6.";
923 return false;
925 ++cur_version;
926 meta_table_.SetVersionNumber(cur_version);
927 meta_table_.SetCompatibleVersionNumber(
928 std::min(cur_version, kCompatibleVersionNumber));
929 transaction.Commit();
930 UMA_HISTOGRAM_TIMES("Cookie.TimeDatabaseMigrationToV6",
931 base::TimeTicks::Now() - start_time);
934 if (cur_version == 6) {
935 const base::TimeTicks start_time = base::TimeTicks::Now();
936 sql::Transaction transaction(db_.get());
937 if (!transaction.Begin())
938 return false;
939 // Alter the table to add empty "encrypted value" column.
940 if (!db_->Execute("ALTER TABLE cookies "
941 "ADD COLUMN encrypted_value BLOB DEFAULT ''")) {
942 LOG(WARNING) << "Unable to update cookie database to version 7.";
943 return false;
945 ++cur_version;
946 meta_table_.SetVersionNumber(cur_version);
947 meta_table_.SetCompatibleVersionNumber(
948 std::min(cur_version, kCompatibleVersionNumber));
949 transaction.Commit();
950 UMA_HISTOGRAM_TIMES("Cookie.TimeDatabaseMigrationToV7",
951 base::TimeTicks::Now() - start_time);
954 if (cur_version == 7) {
955 const base::TimeTicks start_time = base::TimeTicks::Now();
956 sql::Transaction transaction(db_.get());
957 if (!transaction.Begin())
958 return false;
959 // Alter the table to add a 'firstpartyonly' column.
960 if (!db_->Execute(
961 "ALTER TABLE cookies "
962 "ADD COLUMN firstpartyonly INTEGER DEFAULT 0")) {
963 LOG(WARNING) << "Unable to update cookie database to version 8.";
964 return false;
966 ++cur_version;
967 meta_table_.SetVersionNumber(cur_version);
968 meta_table_.SetCompatibleVersionNumber(
969 std::min(cur_version, kCompatibleVersionNumber));
970 transaction.Commit();
971 UMA_HISTOGRAM_TIMES("Cookie.TimeDatabaseMigrationToV8",
972 base::TimeTicks::Now() - start_time);
975 if (cur_version == 8) {
976 const base::TimeTicks start_time = base::TimeTicks::Now();
977 sql::Transaction transaction(db_.get());
978 if (!transaction.Begin())
979 return false;
981 if (!db_->Execute("DROP INDEX IF EXISTS cookie_times")) {
982 LOG(WARNING)
983 << "Unable to drop table cookie_times in update to version 9.";
984 return false;
987 if (!db_->Execute(
988 "CREATE INDEX IF NOT EXISTS domain ON cookies(host_key)")) {
989 LOG(WARNING) << "Unable to create index domain in update to version 9.";
990 return false;
993 #if defined(OS_IOS)
994 // iOS 8.1 and older doesn't support partial indices. iOS 8.2 supports
995 // partial indices.
996 if (!db_->Execute(
997 "CREATE INDEX IF NOT EXISTS is_transient ON cookies(persistent)")) {
998 #else
999 if (!db_->Execute(
1000 "CREATE INDEX IF NOT EXISTS is_transient ON cookies(persistent) "
1001 "where persistent != 1")) {
1002 #endif
1003 LOG(WARNING)
1004 << "Unable to create index is_transient in update to version 9.";
1005 return false;
1007 ++cur_version;
1008 meta_table_.SetVersionNumber(cur_version);
1009 meta_table_.SetCompatibleVersionNumber(
1010 std::min(cur_version, kCompatibleVersionNumber));
1011 transaction.Commit();
1012 UMA_HISTOGRAM_TIMES("Cookie.TimeDatabaseMigrationToV9",
1013 base::TimeTicks::Now() - start_time);
1016 // Put future migration cases here.
1018 if (cur_version < kCurrentVersionNumber) {
1019 UMA_HISTOGRAM_COUNTS_100("Cookie.CorruptMetaTable", 1);
1021 meta_table_.Reset();
1022 db_.reset(new sql::Connection);
1023 if (!sql::Connection::Delete(path_) ||
1024 !db_->Open(path_) ||
1025 !meta_table_.Init(
1026 db_.get(), kCurrentVersionNumber, kCompatibleVersionNumber)) {
1027 UMA_HISTOGRAM_COUNTS_100("Cookie.CorruptMetaTableRecoveryFailed", 1);
1028 NOTREACHED() << "Unable to reset the cookie DB.";
1029 meta_table_.Reset();
1030 db_.reset();
1031 return false;
1035 return true;
1038 void SQLitePersistentCookieStore::Backend::AddCookie(
1039 const net::CanonicalCookie& cc) {
1040 BatchOperation(PendingOperation::COOKIE_ADD, cc);
1043 void SQLitePersistentCookieStore::Backend::UpdateCookieAccessTime(
1044 const net::CanonicalCookie& cc) {
1045 BatchOperation(PendingOperation::COOKIE_UPDATEACCESS, cc);
1048 void SQLitePersistentCookieStore::Backend::DeleteCookie(
1049 const net::CanonicalCookie& cc) {
1050 BatchOperation(PendingOperation::COOKIE_DELETE, cc);
1053 void SQLitePersistentCookieStore::Backend::BatchOperation(
1054 PendingOperation::OperationType op,
1055 const net::CanonicalCookie& cc) {
1056 // Commit every 30 seconds.
1057 static const int kCommitIntervalMs = 30 * 1000;
1058 // Commit right away if we have more than 512 outstanding operations.
1059 static const size_t kCommitAfterBatchSize = 512;
1060 DCHECK(!background_task_runner_->RunsTasksOnCurrentThread());
1062 // We do a full copy of the cookie here, and hopefully just here.
1063 scoped_ptr<PendingOperation> po(new PendingOperation(op, cc));
1065 PendingOperationsList::size_type num_pending;
1067 base::AutoLock locked(lock_);
1068 pending_.push_back(po.release());
1069 num_pending = ++num_pending_;
1072 if (num_pending == 1) {
1073 // We've gotten our first entry for this batch, fire off the timer.
1074 if (!background_task_runner_->PostDelayedTask(
1075 FROM_HERE, base::Bind(&Backend::Commit, this),
1076 base::TimeDelta::FromMilliseconds(kCommitIntervalMs))) {
1077 NOTREACHED() << "background_task_runner_ is not running.";
1079 } else if (num_pending == kCommitAfterBatchSize) {
1080 // We've reached a big enough batch, fire off a commit now.
1081 PostBackgroundTask(FROM_HERE, base::Bind(&Backend::Commit, this));
1085 void SQLitePersistentCookieStore::Backend::Commit() {
1086 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
1088 PendingOperationsList ops;
1090 base::AutoLock locked(lock_);
1091 pending_.swap(ops);
1092 num_pending_ = 0;
1095 // Maybe an old timer fired or we are already Close()'ed.
1096 if (!db_.get() || ops.empty())
1097 return;
1099 sql::Statement add_smt(db_->GetCachedStatement(
1100 SQL_FROM_HERE,
1101 "INSERT INTO cookies (creation_utc, host_key, name, value, "
1102 "encrypted_value, path, expires_utc, secure, httponly, firstpartyonly, "
1103 "last_access_utc, has_expires, persistent, priority) "
1104 "VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?)"));
1105 if (!add_smt.is_valid())
1106 return;
1108 sql::Statement update_access_smt(db_->GetCachedStatement(SQL_FROM_HERE,
1109 "UPDATE cookies SET last_access_utc=? WHERE creation_utc=?"));
1110 if (!update_access_smt.is_valid())
1111 return;
1113 sql::Statement del_smt(db_->GetCachedStatement(SQL_FROM_HERE,
1114 "DELETE FROM cookies WHERE creation_utc=?"));
1115 if (!del_smt.is_valid())
1116 return;
1118 sql::Transaction transaction(db_.get());
1119 if (!transaction.Begin())
1120 return;
1122 for (PendingOperationsList::iterator it = ops.begin();
1123 it != ops.end(); ++it) {
1124 // Free the cookies as we commit them to the database.
1125 scoped_ptr<PendingOperation> po(*it);
1126 switch (po->op()) {
1127 case PendingOperation::COOKIE_ADD:
1128 cookies_per_origin_[
1129 CookieOrigin(po->cc().Domain(), po->cc().IsSecure())]++;
1130 add_smt.Reset(true);
1131 add_smt.BindInt64(0, po->cc().CreationDate().ToInternalValue());
1132 add_smt.BindString(1, po->cc().Domain());
1133 add_smt.BindString(2, po->cc().Name());
1134 if (crypto_) {
1135 std::string encrypted_value;
1136 add_smt.BindCString(3, ""); // value
1137 crypto_->EncryptString(po->cc().Value(), &encrypted_value);
1138 // BindBlob() immediately makes an internal copy of the data.
1139 add_smt.BindBlob(4, encrypted_value.data(),
1140 static_cast<int>(encrypted_value.length()));
1141 } else {
1142 add_smt.BindString(3, po->cc().Value());
1143 add_smt.BindBlob(4, "", 0); // encrypted_value
1145 add_smt.BindString(5, po->cc().Path());
1146 add_smt.BindInt64(6, po->cc().ExpiryDate().ToInternalValue());
1147 add_smt.BindInt(7, po->cc().IsSecure());
1148 add_smt.BindInt(8, po->cc().IsHttpOnly());
1149 add_smt.BindInt(9, po->cc().IsFirstPartyOnly());
1150 add_smt.BindInt64(10, po->cc().LastAccessDate().ToInternalValue());
1151 add_smt.BindInt(11, po->cc().IsPersistent());
1152 add_smt.BindInt(12, po->cc().IsPersistent());
1153 add_smt.BindInt(13,
1154 CookiePriorityToDBCookiePriority(po->cc().Priority()));
1155 if (!add_smt.Run())
1156 NOTREACHED() << "Could not add a cookie to the DB.";
1157 break;
1159 case PendingOperation::COOKIE_UPDATEACCESS:
1160 update_access_smt.Reset(true);
1161 update_access_smt.BindInt64(0,
1162 po->cc().LastAccessDate().ToInternalValue());
1163 update_access_smt.BindInt64(1,
1164 po->cc().CreationDate().ToInternalValue());
1165 if (!update_access_smt.Run())
1166 NOTREACHED() << "Could not update cookie last access time in the DB.";
1167 break;
1169 case PendingOperation::COOKIE_DELETE:
1170 cookies_per_origin_[
1171 CookieOrigin(po->cc().Domain(), po->cc().IsSecure())]--;
1172 del_smt.Reset(true);
1173 del_smt.BindInt64(0, po->cc().CreationDate().ToInternalValue());
1174 if (!del_smt.Run())
1175 NOTREACHED() << "Could not delete a cookie from the DB.";
1176 break;
1178 default:
1179 NOTREACHED();
1180 break;
1183 bool succeeded = transaction.Commit();
1184 UMA_HISTOGRAM_ENUMERATION("Cookie.BackingStoreUpdateResults",
1185 succeeded ? 0 : 1, 2);
1188 void SQLitePersistentCookieStore::Backend::Flush(
1189 const base::Closure& callback) {
1190 DCHECK(!background_task_runner_->RunsTasksOnCurrentThread());
1191 PostBackgroundTask(FROM_HERE, base::Bind(&Backend::Commit, this));
1193 if (!callback.is_null()) {
1194 // We want the completion task to run immediately after Commit() returns.
1195 // Posting it from here means there is less chance of another task getting
1196 // onto the message queue first, than if we posted it from Commit() itself.
1197 PostBackgroundTask(FROM_HERE, callback);
1201 // Fire off a close message to the background runner. We could still have a
1202 // pending commit timer or Load operations holding references on us, but if/when
1203 // this fires we will already have been cleaned up and it will be ignored.
1204 void SQLitePersistentCookieStore::Backend::Close() {
1205 if (background_task_runner_->RunsTasksOnCurrentThread()) {
1206 InternalBackgroundClose();
1207 } else {
1208 // Must close the backend on the background runner.
1209 PostBackgroundTask(FROM_HERE,
1210 base::Bind(&Backend::InternalBackgroundClose, this));
1214 void SQLitePersistentCookieStore::Backend::InternalBackgroundClose() {
1215 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
1216 // Commit any pending operations
1217 Commit();
1219 if (!force_keep_session_state_ && special_storage_policy_.get() &&
1220 special_storage_policy_->HasSessionOnlyOrigins()) {
1221 DeleteSessionCookiesOnShutdown();
1224 meta_table_.Reset();
1225 db_.reset();
1228 void SQLitePersistentCookieStore::Backend::DeleteSessionCookiesOnShutdown() {
1229 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
1231 if (!db_)
1232 return;
1234 if (!special_storage_policy_.get())
1235 return;
1237 sql::Statement del_smt(db_->GetCachedStatement(
1238 SQL_FROM_HERE, "DELETE FROM cookies WHERE host_key=? AND secure=?"));
1239 if (!del_smt.is_valid()) {
1240 LOG(WARNING) << "Unable to delete cookies on shutdown.";
1241 return;
1244 sql::Transaction transaction(db_.get());
1245 if (!transaction.Begin()) {
1246 LOG(WARNING) << "Unable to delete cookies on shutdown.";
1247 return;
1250 for (CookiesPerOriginMap::iterator it = cookies_per_origin_.begin();
1251 it != cookies_per_origin_.end(); ++it) {
1252 if (it->second <= 0) {
1253 DCHECK_EQ(0, it->second);
1254 continue;
1256 const GURL url(net::cookie_util::CookieOriginToURL(it->first.first,
1257 it->first.second));
1258 if (!url.is_valid() || !special_storage_policy_->IsStorageSessionOnly(url))
1259 continue;
1261 del_smt.Reset(true);
1262 del_smt.BindString(0, it->first.first);
1263 del_smt.BindInt(1, it->first.second);
1264 if (!del_smt.Run())
1265 NOTREACHED() << "Could not delete a cookie from the DB.";
1268 if (!transaction.Commit())
1269 LOG(WARNING) << "Unable to delete cookies on shutdown.";
1272 void SQLitePersistentCookieStore::Backend::DatabaseErrorCallback(
1273 int error,
1274 sql::Statement* stmt) {
1275 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
1277 if (!sql::IsErrorCatastrophic(error))
1278 return;
1280 // TODO(shess): Running KillDatabase() multiple times should be
1281 // safe.
1282 if (corruption_detected_)
1283 return;
1285 corruption_detected_ = true;
1287 // Don't just do the close/delete here, as we are being called by |db| and
1288 // that seems dangerous.
1289 // TODO(shess): Consider just calling RazeAndClose() immediately.
1290 // db_ may not be safe to reset at this point, but RazeAndClose()
1291 // would cause the stack to unwind safely with errors.
1292 PostBackgroundTask(FROM_HERE, base::Bind(&Backend::KillDatabase, this));
1295 void SQLitePersistentCookieStore::Backend::KillDatabase() {
1296 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
1298 if (db_) {
1299 // This Backend will now be in-memory only. In a future run we will recreate
1300 // the database. Hopefully things go better then!
1301 bool success = db_->RazeAndClose();
1302 UMA_HISTOGRAM_BOOLEAN("Cookie.KillDatabaseResult", success);
1303 meta_table_.Reset();
1304 db_.reset();
1308 void SQLitePersistentCookieStore::Backend::SetForceKeepSessionState() {
1309 base::AutoLock locked(lock_);
1310 force_keep_session_state_ = true;
1313 void SQLitePersistentCookieStore::Backend::DeleteSessionCookiesOnStartup() {
1314 DCHECK(background_task_runner_->RunsTasksOnCurrentThread());
1315 if (!db_->Execute("DELETE FROM cookies WHERE persistent != 1"))
1316 LOG(WARNING) << "Unable to delete session cookies.";
1319 void SQLitePersistentCookieStore::Backend::PostBackgroundTask(
1320 const tracked_objects::Location& origin, const base::Closure& task) {
1321 if (!background_task_runner_->PostTask(origin, task)) {
1322 LOG(WARNING) << "Failed to post task from " << origin.ToString()
1323 << " to background_task_runner_.";
1327 void SQLitePersistentCookieStore::Backend::PostClientTask(
1328 const tracked_objects::Location& origin, const base::Closure& task) {
1329 if (!client_task_runner_->PostTask(origin, task)) {
1330 LOG(WARNING) << "Failed to post task from " << origin.ToString()
1331 << " to client_task_runner_.";
1335 void SQLitePersistentCookieStore::Backend::FinishedLoadingCookies(
1336 const LoadedCallback& loaded_callback,
1337 bool success) {
1338 PostClientTask(FROM_HERE, base::Bind(&Backend::CompleteLoadInForeground, this,
1339 loaded_callback, success));
1342 SQLitePersistentCookieStore::SQLitePersistentCookieStore(
1343 const base::FilePath& path,
1344 const scoped_refptr<base::SequencedTaskRunner>& client_task_runner,
1345 const scoped_refptr<base::SequencedTaskRunner>& background_task_runner,
1346 bool restore_old_session_cookies,
1347 storage::SpecialStoragePolicy* special_storage_policy,
1348 net::CookieCryptoDelegate* crypto_delegate)
1349 : backend_(new Backend(path,
1350 client_task_runner,
1351 background_task_runner,
1352 restore_old_session_cookies,
1353 special_storage_policy,
1354 crypto_delegate)) {
1357 void SQLitePersistentCookieStore::Load(const LoadedCallback& loaded_callback) {
1358 backend_->Load(loaded_callback);
1361 void SQLitePersistentCookieStore::LoadCookiesForKey(
1362 const std::string& key,
1363 const LoadedCallback& loaded_callback) {
1364 backend_->LoadCookiesForKey(key, loaded_callback);
1367 void SQLitePersistentCookieStore::AddCookie(const net::CanonicalCookie& cc) {
1368 backend_->AddCookie(cc);
1371 void SQLitePersistentCookieStore::UpdateCookieAccessTime(
1372 const net::CanonicalCookie& cc) {
1373 backend_->UpdateCookieAccessTime(cc);
1376 void SQLitePersistentCookieStore::DeleteCookie(const net::CanonicalCookie& cc) {
1377 backend_->DeleteCookie(cc);
1380 void SQLitePersistentCookieStore::SetForceKeepSessionState() {
1381 backend_->SetForceKeepSessionState();
1384 void SQLitePersistentCookieStore::Flush(const base::Closure& callback) {
1385 backend_->Flush(callback);
1388 SQLitePersistentCookieStore::~SQLitePersistentCookieStore() {
1389 backend_->Close();
1390 // We release our reference to the Backend, though it will probably still have
1391 // a reference if the background runner has not run Close() yet.
1394 CookieStoreConfig::CookieStoreConfig()
1395 : session_cookie_mode(EPHEMERAL_SESSION_COOKIES),
1396 crypto_delegate(NULL) {
1397 // Default to an in-memory cookie store.
1400 CookieStoreConfig::CookieStoreConfig(
1401 const base::FilePath& path,
1402 SessionCookieMode session_cookie_mode,
1403 storage::SpecialStoragePolicy* storage_policy,
1404 net::CookieMonsterDelegate* cookie_delegate)
1405 : path(path),
1406 session_cookie_mode(session_cookie_mode),
1407 storage_policy(storage_policy),
1408 cookie_delegate(cookie_delegate),
1409 crypto_delegate(NULL) {
1410 CHECK(!path.empty() || session_cookie_mode == EPHEMERAL_SESSION_COOKIES);
1413 CookieStoreConfig::~CookieStoreConfig() {
1416 net::CookieStore* CreateCookieStore(const CookieStoreConfig& config) {
1417 net::CookieMonster* cookie_monster = NULL;
1419 if (config.path.empty()) {
1420 // Empty path means in-memory store.
1421 cookie_monster = new net::CookieMonster(NULL, config.cookie_delegate.get());
1422 } else {
1423 scoped_refptr<base::SequencedTaskRunner> client_task_runner =
1424 config.client_task_runner;
1425 scoped_refptr<base::SequencedTaskRunner> background_task_runner =
1426 config.background_task_runner;
1428 if (!client_task_runner.get()) {
1429 client_task_runner =
1430 BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO);
1433 if (!background_task_runner.get()) {
1434 background_task_runner =
1435 BrowserThread::GetBlockingPool()->GetSequencedTaskRunner(
1436 BrowserThread::GetBlockingPool()->GetSequenceToken());
1439 SQLitePersistentCookieStore* persistent_store =
1440 new SQLitePersistentCookieStore(
1441 config.path,
1442 client_task_runner,
1443 background_task_runner,
1444 (config.session_cookie_mode ==
1445 CookieStoreConfig::RESTORED_SESSION_COOKIES),
1446 config.storage_policy.get(),
1447 config.crypto_delegate);
1449 cookie_monster =
1450 new net::CookieMonster(persistent_store, config.cookie_delegate.get());
1451 if ((config.session_cookie_mode ==
1452 CookieStoreConfig::PERSISTANT_SESSION_COOKIES) ||
1453 (config.session_cookie_mode ==
1454 CookieStoreConfig::RESTORED_SESSION_COOKIES)) {
1455 cookie_monster->SetPersistSessionCookies(true);
1459 return cookie_monster;
1462 } // namespace content