content/browser/notifications/platform_notification_context_impl.cc

   1 // Copyright 2015 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.
   4
   5 #include "content/browser/notifications/platform_notification_context_impl.h"
   6
   7 #include "base/bind_helpers.h"
   8 #include "base/files/file_util.h"
   9 #include "base/metrics/histogram_macros.h"
  10 #include "base/threading/sequenced_worker_pool.h"
  11 #include "content/browser/notifications/notification_database.h"
  12 #include "content/browser/service_worker/service_worker_context_wrapper.h"
  13 #include "content/public/browser/browser_thread.h"
  14 #include "content/public/browser/content_browser_client.h"
  15 #include "content/public/browser/notification_database_data.h"
  16 #include "content/public/browser/platform_notification_service.h"
  17
  18 using base::DoNothing;
  19
  20 namespace content {
  21
  22 // Name of the directory in the user's profile directory where the notification
  23 // database files should be stored.
  24 const base::FilePath::CharType kPlatformNotificationsDirectory[] =
  25     FILE_PATH_LITERAL("Platform Notifications");
  26
  27 PlatformNotificationContextImpl::PlatformNotificationContextImpl(
  28     const base::FilePath& path,
  29     BrowserContext* browser_context,
  30     const scoped_refptr<ServiceWorkerContextWrapper>& service_worker_context)
  31     : path_(path),
  32       browser_context_(browser_context),
  33       service_worker_context_(service_worker_context) {
  34   DCHECK_CURRENTLY_ON(BrowserThread::UI);
  35 }
  36
  37 PlatformNotificationContextImpl::~PlatformNotificationContextImpl() {
  38   DCHECK_CURRENTLY_ON(BrowserThread::UI);
  39
  40   // If the database has been initialized, it must be deleted on the task runner
  41   // thread as closing it may cause file I/O.
  42   if (database_) {
  43     DCHECK(task_runner_);
  44     task_runner_->DeleteSoon(FROM_HERE, database_.release());
  45   }
  46 }
  47
  48 void PlatformNotificationContextImpl::Initialize() {
  49   DCHECK_CURRENTLY_ON(BrowserThread::UI);
  50   PlatformNotificationService* service =
  51       GetContentClient()->browser()->GetPlatformNotificationService();
  52   if (service) {
  53     std::set<std::string> displayed_notifications;
  54
  55     bool notification_synchronization_supported =
  56         service->GetDisplayedPersistentNotifications(browser_context_,
  57                                                      &displayed_notifications);
  58
  59     // Synchronize the notifications stored in the database with the set of
  60     // displaying notifications in |displayed_notifications|. This is necessary
  61     // because flakiness may cause a platform to inform Chrome of a notification
  62     // that has since been closed, or because the platform does not support
  63     // notifications that exceed the lifetime of the browser process.
  64
  65     // TODO(peter): Synchronizing the actual notifications will be done when the
  66     // persistent notification ids are stable. For M44 we need to support the
  67     // case where there may be no notifications after a Chrome restart.
  68     if (notification_synchronization_supported &&
  69         !displayed_notifications.size()) {
  70       prune_database_on_open_ = true;
  71     }
  72   }
  73
  74   BrowserThread::PostTask(
  75       BrowserThread::IO,
  76       FROM_HERE,
  77       base::Bind(&PlatformNotificationContextImpl::InitializeOnIO, this));
  78 }
  79
  80 void PlatformNotificationContextImpl::InitializeOnIO() {
  81   DCHECK_CURRENTLY_ON(BrowserThread::IO);
  82
  83   // |service_worker_context_| may be NULL in tests.
  84   if (service_worker_context_)
  85     service_worker_context_->AddObserver(this);
  86 }
  87
  88 void PlatformNotificationContextImpl::Shutdown() {
  89   DCHECK_CURRENTLY_ON(BrowserThread::UI);
  90   BrowserThread::PostTask(
  91       BrowserThread::IO,
  92       FROM_HERE,
  93       base::Bind(&PlatformNotificationContextImpl::ShutdownOnIO, this));
  94 }
  95
  96 void PlatformNotificationContextImpl::ShutdownOnIO() {
  97   DCHECK_CURRENTLY_ON(BrowserThread::IO);
  98
  99   // |service_worker_context_| may be NULL in tests.
 100   if (service_worker_context_)
 101     service_worker_context_->RemoveObserver(this);
 102 }
 103
 104 void PlatformNotificationContextImpl::ReadNotificationData(
 105     int64_t notification_id,
 106     const GURL& origin,
 107     const ReadResultCallback& callback) {
 108   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 109   LazyInitialize(
 110        base::Bind(&PlatformNotificationContextImpl::DoReadNotificationData,
 111                   this, notification_id, origin, callback),
 112        base::Bind(callback, false /* success */, NotificationDatabaseData()));
 113 }
 114
 115 void PlatformNotificationContextImpl::DoReadNotificationData(
 116     int64_t notification_id,
 117     const GURL& origin,
 118     const ReadResultCallback& callback) {
 119   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 120
 121   NotificationDatabaseData database_data;
 122   NotificationDatabase::Status status =
 123       database_->ReadNotificationData(notification_id,
 124                                       origin,
 125                                       &database_data);
 126
 127   UMA_HISTOGRAM_ENUMERATION("Notifications.Database.ReadResult",
 128                             status, NotificationDatabase::STATUS_COUNT);
 129
 130   if (status == NotificationDatabase::STATUS_OK) {
 131     BrowserThread::PostTask(BrowserThread::IO,
 132                             FROM_HERE,
 133                             base::Bind(callback,
 134                                        true /* success */,
 135                                        database_data));
 136     return;
 137   }
 138
 139   // Blow away the database if reading data failed due to corruption.
 140   if (status == NotificationDatabase::STATUS_ERROR_CORRUPTED)
 141     DestroyDatabase();
 142
 143   BrowserThread::PostTask(
 144       BrowserThread::IO,
 145       FROM_HERE,
 146       base::Bind(callback, false /* success */, NotificationDatabaseData()));
 147 }
 148
 149 void PlatformNotificationContextImpl::
 150     ReadAllNotificationDataForServiceWorkerRegistration(
 151     const GURL& origin,
 152     int64_t service_worker_registration_id,
 153     const ReadAllResultCallback& callback) {
 154   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 155   LazyInitialize(
 156        base::Bind(&PlatformNotificationContextImpl::
 157                       DoReadAllNotificationDataForServiceWorkerRegistration,
 158                   this, origin, service_worker_registration_id, callback),
 159        base::Bind(callback,
 160                   false /* success */,
 161                   std::vector<NotificationDatabaseData>()));
 162 }
 163
 164 void PlatformNotificationContextImpl::
 165     DoReadAllNotificationDataForServiceWorkerRegistration(
 166     const GURL& origin,
 167     int64_t service_worker_registration_id,
 168     const ReadAllResultCallback& callback) {
 169   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 170
 171   std::vector<NotificationDatabaseData> notification_datas;
 172
 173   NotificationDatabase::Status status =
 174       database_->ReadAllNotificationDataForServiceWorkerRegistration(
 175           origin, service_worker_registration_id, &notification_datas);
 176
 177   UMA_HISTOGRAM_ENUMERATION("Notifications.Database.ReadForServiceWorkerResult",
 178                             status, NotificationDatabase::STATUS_COUNT);
 179
 180   if (status == NotificationDatabase::STATUS_OK) {
 181     BrowserThread::PostTask(BrowserThread::IO,
 182                             FROM_HERE,
 183                             base::Bind(callback,
 184                                        true /* success */,
 185                                        notification_datas));
 186     return;
 187   }
 188
 189   // Blow away the database if reading data failed due to corruption.
 190   if (status == NotificationDatabase::STATUS_ERROR_CORRUPTED)
 191     DestroyDatabase();
 192
 193   BrowserThread::PostTask(
 194       BrowserThread::IO,
 195       FROM_HERE,
 196       base::Bind(callback,
 197                  false /* success */,
 198                  std::vector<NotificationDatabaseData>()));
 199 }
 200
 201 void PlatformNotificationContextImpl::WriteNotificationData(
 202     const GURL& origin,
 203     const NotificationDatabaseData& database_data,
 204     const WriteResultCallback& callback) {
 205   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 206   LazyInitialize(
 207        base::Bind(&PlatformNotificationContextImpl::DoWriteNotificationData,
 208                   this, origin, database_data, callback),
 209        base::Bind(callback, false /* success */, 0 /* notification_id */));
 210 }
 211
 212 void PlatformNotificationContextImpl::DoWriteNotificationData(
 213     const GURL& origin,
 214     const NotificationDatabaseData& database_data,
 215     const WriteResultCallback& callback) {
 216   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 217
 218   int64_t notification_id = 0;
 219   NotificationDatabase::Status status =
 220       database_->WriteNotificationData(origin,
 221                                        database_data,
 222                                        &notification_id);
 223
 224   UMA_HISTOGRAM_ENUMERATION("Notifications.Database.WriteResult",
 225                             status, NotificationDatabase::STATUS_COUNT);
 226
 227   if (status == NotificationDatabase::STATUS_OK) {
 228     DCHECK_GT(notification_id, 0);
 229     BrowserThread::PostTask(BrowserThread::IO,
 230                             FROM_HERE,
 231                             base::Bind(callback,
 232                                        true /* success */,
 233                                        notification_id));
 234     return;
 235   }
 236
 237   // Blow away the database if writing data failed due to corruption.
 238   if (status == NotificationDatabase::STATUS_ERROR_CORRUPTED)
 239     DestroyDatabase();
 240
 241   BrowserThread::PostTask(
 242       BrowserThread::IO,
 243       FROM_HERE,
 244       base::Bind(callback, false /* success */, 0 /* notification_id */));
 245 }
 246
 247 void PlatformNotificationContextImpl::DeleteNotificationData(
 248     int64_t notification_id,
 249     const GURL& origin,
 250     const DeleteResultCallback& callback) {
 251   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 252   LazyInitialize(
 253        base::Bind(&PlatformNotificationContextImpl::DoDeleteNotificationData,
 254                   this, notification_id, origin, callback),
 255        base::Bind(callback, false /* success */));
 256 }
 257
 258 void PlatformNotificationContextImpl::DoDeleteNotificationData(
 259     int64_t notification_id,
 260     const GURL& origin,
 261     const DeleteResultCallback& callback) {
 262   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 263
 264   NotificationDatabase::Status status =
 265       database_->DeleteNotificationData(notification_id, origin);
 266
 267   UMA_HISTOGRAM_ENUMERATION("Notifications.Database.DeleteResult",
 268                             status, NotificationDatabase::STATUS_COUNT);
 269
 270   bool success = status == NotificationDatabase::STATUS_OK;
 271
 272   // Blow away the database if deleting data failed due to corruption. Following
 273   // the contract of the delete methods, consider this to be a success as the
 274   // caller's goal has been achieved: the data is gone.
 275   if (status == NotificationDatabase::STATUS_ERROR_CORRUPTED) {
 276     DestroyDatabase();
 277     success = true;
 278   }
 279
 280   BrowserThread::PostTask(BrowserThread::IO,
 281                           FROM_HERE,
 282                           base::Bind(callback, success));
 283 }
 284
 285 void PlatformNotificationContextImpl::OnRegistrationDeleted(
 286     int64_t registration_id,
 287     const GURL& pattern) {
 288   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 289   LazyInitialize(
 290       base::Bind(&PlatformNotificationContextImpl::
 291                      DoDeleteNotificationsForServiceWorkerRegistration,
 292                  this, pattern.GetOrigin(), registration_id),
 293       base::Bind(&DoNothing));
 294 }
 295
 296 void PlatformNotificationContextImpl::
 297     DoDeleteNotificationsForServiceWorkerRegistration(
 298         const GURL& origin,
 299         int64_t service_worker_registration_id) {
 300   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 301
 302   std::set<int64_t> deleted_notifications_set;
 303   NotificationDatabase::Status status =
 304       database_->DeleteAllNotificationDataForServiceWorkerRegistration(
 305             origin, service_worker_registration_id, &deleted_notifications_set);
 306
 307   UMA_HISTOGRAM_ENUMERATION(
 308       "Notifications.Database.DeleteServiceWorkerRegistrationResult",
 309       status, NotificationDatabase::STATUS_COUNT);
 310
 311   // Blow away the database if a corruption error occurred during the deletion.
 312   if (status == NotificationDatabase::STATUS_ERROR_CORRUPTED)
 313     DestroyDatabase();
 314
 315   // TODO(peter): Close the notifications in |deleted_notifications_set|.
 316 }
 317
 318 void PlatformNotificationContextImpl::OnStorageWiped() {
 319   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 320   LazyInitialize(
 321       base::Bind(base::IgnoreResult(
 322           &PlatformNotificationContextImpl::DestroyDatabase), this),
 323       base::Bind(&DoNothing));
 324 }
 325
 326 void PlatformNotificationContextImpl::LazyInitialize(
 327     const base::Closure& success_closure,
 328     const base::Closure& failure_closure) {
 329   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 330
 331   if (!task_runner_) {
 332     base::SequencedWorkerPool* pool = BrowserThread::GetBlockingPool();
 333     base::SequencedWorkerPool::SequenceToken token = pool->GetSequenceToken();
 334
 335     task_runner_ = pool->GetSequencedTaskRunner(token);
 336   }
 337
 338   task_runner_->PostTask(
 339       FROM_HERE,
 340       base::Bind(&PlatformNotificationContextImpl::OpenDatabase,
 341                  this, success_closure, failure_closure));
 342 }
 343
 344 void PlatformNotificationContextImpl::OpenDatabase(
 345     const base::Closure& success_closure,
 346     const base::Closure& failure_closure) {
 347   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 348
 349   if (database_) {
 350     success_closure.Run();
 351     return;
 352   }
 353
 354   database_.reset(new NotificationDatabase(GetDatabasePath()));
 355   NotificationDatabase::Status status =
 356       database_->Open(true /* create_if_missing */);
 357
 358   UMA_HISTOGRAM_ENUMERATION("Notifications.Database.OpenResult",
 359                             status, NotificationDatabase::STATUS_COUNT);
 360
 361   // TODO(peter): Do finer-grained synchronization here.
 362   if (prune_database_on_open_) {
 363     prune_database_on_open_ = false;
 364     DestroyDatabase();
 365
 366     database_.reset(new NotificationDatabase(GetDatabasePath()));
 367     status = database_->Open(true /* create_if_missing */);
 368
 369     // TODO(peter): Find the appropriate UMA to cover in regards to
 370     // synchronizing notifications after the implementation is complete.
 371   }
 372
 373   // When the database could not be opened due to corruption, destroy it, blow
 374   // away the contents of the directory and try re-opening the database.
 375   if (status == NotificationDatabase::STATUS_ERROR_CORRUPTED) {
 376     if (DestroyDatabase()) {
 377       database_.reset(new NotificationDatabase(GetDatabasePath()));
 378       status = database_->Open(true /* create_if_missing */);
 379
 380       UMA_HISTOGRAM_ENUMERATION(
 381           "Notifications.Database.OpenAfterCorruptionResult",
 382           status, NotificationDatabase::STATUS_COUNT);
 383     }
 384   }
 385
 386   if (status == NotificationDatabase::STATUS_OK) {
 387     success_closure.Run();
 388     return;
 389   }
 390
 391   database_.reset();
 392
 393   BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, failure_closure);
 394 }
 395
 396 bool PlatformNotificationContextImpl::DestroyDatabase() {
 397   DCHECK(task_runner_->RunsTasksOnCurrentThread());
 398   DCHECK(database_);
 399
 400   NotificationDatabase::Status status = database_->Destroy();
 401   UMA_HISTOGRAM_ENUMERATION("Notifications.Database.DestroyResult",
 402                             status, NotificationDatabase::STATUS_COUNT);
 403
 404   database_.reset();
 405
 406   // TODO(peter): Close any existing persistent notifications on the platform.
 407
 408   // Remove all files in the directory that the database was previously located
 409   // in, to make sure that any left-over files are gone as well.
 410   base::FilePath database_path = GetDatabasePath();
 411   if (!database_path.empty())
 412     return base::DeleteFile(database_path, true);
 413
 414   return true;
 415 }
 416
 417 base::FilePath PlatformNotificationContextImpl::GetDatabasePath() const {
 418   if (path_.empty())
 419     return path_;
 420
 421   return path_.Append(kPlatformNotificationsDirectory);
 422 }
 423
 424 void PlatformNotificationContextImpl::SetTaskRunnerForTesting(
 425     const scoped_refptr<base::SequencedTaskRunner>& task_runner) {
 426   task_runner_ = task_runner;
 427 }
 428
 429 }  // namespace content