third_party/blink/renderer/modules/webdatabase/database_tracker.h

/*
 * Copyright (C) 2007, 2008, 2013 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_WEBDATABASE_DATABASE_TRACKER_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_WEBDATABASE_DATABASE_TRACKER_H_

#include <memory>

#include "base/callback.h"
#include "base/macros.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/modules/webdatabase/database_error.h"
#include "third_party/blink/renderer/platform/heap/persistent.h"
#include "third_party/blink/renderer/platform/wtf/hash_map.h"
#include "third_party/blink/renderer/platform/wtf/hash_set.h"
#include "third_party/blink/renderer/platform/wtf/text/string_hash.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "third_party/blink/renderer/platform/wtf/threading_primitives.h"

namespace blink {

class Database;
class DatabaseContext;
class Page;
class SecurityOrigin;

class MODULES_EXPORT DatabaseTracker {
  USING_FAST_MALLOC(DatabaseTracker);

 public:
  static DatabaseTracker& Tracker();
  // This singleton will potentially be used from multiple worker threads and
  // the page's context thread simultaneously.  To keep this safe, it's
  // currently using 4 locks.  In order to avoid deadlock when taking multiple
  // locks, you must take them in the correct order:
  // m_databaseGuard before quotaManager if both locks are needed.
  // m_openDatabaseMapGuard before quotaManager if both locks are needed.
  // m_databaseGuard and m_openDatabaseMapGuard currently don't overlap.
  // notificationMutex() is currently independent of the other locks.

  bool CanEstablishDatabase(DatabaseContext*,
                            const String& name,
                            const String& display_name,
                            unsigned estimated_size,
                            DatabaseError&);
  String FullPathForDatabase(const SecurityOrigin*,
                             const String& name,
                             bool create_if_does_not_exist = true);

  void AddOpenDatabase(Database*);
  void RemoveOpenDatabase(Database*);

  unsigned long long GetMaxSizeForDatabase(const Database*);

  void CloseDatabasesImmediately(const SecurityOrigin*, const String& name);

  using DatabaseCallback = base::RepeatingCallback<void(Database*)>;
  void ForEachOpenDatabaseInPage(Page*, DatabaseCallback);

  void PrepareToOpenDatabase(Database*);
  void FailedToOpenDatabase(Database*);

 private:
  using DatabaseSet = HashSet<CrossThreadPersistent<Database>>;
  using DatabaseNameMap = HashMap<String, DatabaseSet*>;
  using DatabaseOriginMap = HashMap<String, DatabaseNameMap*>;

  DatabaseTracker();

  void CloseOneDatabaseImmediately(const String& origin_identifier,
                                   const String& name,
                                   Database*);

  Mutex open_database_map_guard_;

  mutable std::unique_ptr<DatabaseOriginMap> open_database_map_;

  DISALLOW_COPY_AND_ASSIGN(DatabaseTracker);
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_WEBDATABASE_DATABASE_TRACKER_H_