content/browser/indexed_db/indexed_db_context_impl.h

   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.
   4
   5 #ifndef CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_CONTEXT_IMPL_H_
   6 #define CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_CONTEXT_IMPL_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <vector>
  11
  12 #include "base/compiler_specific.h"
  13 #include "base/files/file_path.h"
  14 #include "base/gtest_prod_util.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "content/browser/browser_main_loop.h"
  17 #include "content/browser/indexed_db/indexed_db_factory.h"
  18 #include "content/public/browser/indexed_db_context.h"
  19 #include "url/gurl.h"
  20 #include "webkit/common/quota/quota_types.h"
  21
  22 class GURL;
  23
  24 namespace base {
  25 class ListValue;
  26 class FilePath;
  27 class SequencedTaskRunner;
  28 }
  29
  30 namespace quota {
  31 class QuotaManagerProxy;
  32 class SpecialStoragePolicy;
  33 }
  34
  35 namespace content {
  36
  37 class IndexedDBConnection;
  38
  39 class CONTENT_EXPORT IndexedDBContextImpl
  40     : NON_EXPORTED_BASE(public IndexedDBContext) {
  41  public:
  42   // If |data_path| is empty, nothing will be saved to disk.
  43   IndexedDBContextImpl(const base::FilePath& data_path,
  44                        quota::SpecialStoragePolicy* special_storage_policy,
  45                        quota::QuotaManagerProxy* quota_manager_proxy,
  46                        base::SequencedTaskRunner* task_runner);
  47
  48   IndexedDBFactory* GetIDBFactory();
  49
  50   // The indexed db directory.
  51   static const base::FilePath::CharType kIndexedDBDirectory[];
  52
  53   // Disables the exit-time deletion of session-only data.
  54   void SetForceKeepSessionState() { force_keep_session_state_ = true; }
  55
  56   // IndexedDBContext implementation:
  57   virtual base::TaskRunner* TaskRunner() const OVERRIDE;
  58   virtual std::vector<IndexedDBInfo> GetAllOriginsInfo() OVERRIDE;
  59   virtual int64 GetOriginDiskUsage(const GURL& origin_url) OVERRIDE;
  60   virtual void DeleteForOrigin(const GURL& origin_url) OVERRIDE;
  61   virtual base::FilePath GetFilePathForTesting(
  62       const std::string& origin_id) const OVERRIDE;
  63   virtual void SetTaskRunnerForTesting(base::SequencedTaskRunner* task_runner)
  64       OVERRIDE;
  65
  66   // Methods called by IndexedDBDispatcherHost for quota support.
  67   void ConnectionOpened(const GURL& origin_url, IndexedDBConnection* db);
  68   void ConnectionClosed(const GURL& origin_url, IndexedDBConnection* db);
  69   void TransactionComplete(const GURL& origin_url);
  70   void DatabaseDeleted(const GURL& origin_url);
  71   bool WouldBeOverQuota(const GURL& origin_url, int64 additional_bytes);
  72   bool IsOverQuota(const GURL& origin_url);
  73
  74   quota::QuotaManagerProxy* quota_manager_proxy();
  75
  76   std::vector<GURL> GetAllOrigins();
  77   base::Time GetOriginLastModified(const GURL& origin_url);
  78   base::ListValue* GetAllOriginsDetails();
  79
  80   // Recorded in histograms, so append only.
  81   enum ForceCloseReason {
  82     FORCE_CLOSE_DELETE_ORIGIN = 0,
  83     FORCE_CLOSE_BACKING_STORE_FAILURE,
  84     FORCE_CLOSE_INTERNALS_PAGE,
  85     FORCE_CLOSE_REASON_MAX
  86   };
  87
  88   // ForceClose takes a value rather than a reference since it may release the
  89   // owning object.
  90   void ForceClose(const GURL origin_url, ForceCloseReason reason);
  91
  92   base::FilePath GetFilePath(const GURL& origin_url) const;
  93   base::FilePath data_path() const { return data_path_; }
  94   bool IsInOriginSet(const GURL& origin_url) {
  95     std::set<GURL>* set = GetOriginSet();
  96     return set->find(origin_url) != set->end();
  97   }
  98   size_t GetConnectionCount(const GURL& origin_url);
  99
 100   // For unit tests allow to override the |data_path_|.
 101   void set_data_path_for_testing(const base::FilePath& data_path) {
 102     data_path_ = data_path;
 103   }
 104
 105  protected:
 106   virtual ~IndexedDBContextImpl();
 107
 108  private:
 109   FRIEND_TEST_ALL_PREFIXES(IndexedDBTest, ClearLocalState);
 110   FRIEND_TEST_ALL_PREFIXES(IndexedDBTest, ClearSessionOnlyDatabases);
 111   FRIEND_TEST_ALL_PREFIXES(IndexedDBTest, SetForceKeepSessionState);
 112   FRIEND_TEST_ALL_PREFIXES(IndexedDBTest, ForceCloseOpenDatabasesOnDelete);
 113   friend class IndexedDBQuotaClientTest;
 114
 115   typedef std::map<GURL, int64> OriginToSizeMap;
 116   class IndexedDBGetUsageAndQuotaCallback;
 117
 118   base::FilePath GetIndexedDBFilePath(const std::string& origin_id) const;
 119   int64 ReadUsageFromDisk(const GURL& origin_url) const;
 120   void EnsureDiskUsageCacheInitialized(const GURL& origin_url);
 121   void QueryDiskAndUpdateQuotaUsage(const GURL& origin_url);
 122   void GotUsageAndQuota(const GURL& origin_url,
 123                         quota::QuotaStatusCode,
 124                         int64 usage,
 125                         int64 quota);
 126   void GotUpdatedQuota(const GURL& origin_url, int64 usage, int64 quota);
 127   void QueryAvailableQuota(const GURL& origin_url);
 128
 129   std::set<GURL>* GetOriginSet();
 130   bool AddToOriginSet(const GURL& origin_url) {
 131     return GetOriginSet()->insert(origin_url).second;
 132   }
 133   void RemoveFromOriginSet(const GURL& origin_url) {
 134     GetOriginSet()->erase(origin_url);
 135   }
 136
 137   // Only for testing.
 138   void ResetCaches();
 139
 140   scoped_refptr<IndexedDBFactory> factory_;
 141   base::FilePath data_path_;
 142   // If true, nothing (not even session-only data) should be deleted on exit.
 143   bool force_keep_session_state_;
 144   scoped_refptr<quota::SpecialStoragePolicy> special_storage_policy_;
 145   scoped_refptr<quota::QuotaManagerProxy> quota_manager_proxy_;
 146   base::SequencedTaskRunner* task_runner_;
 147   scoped_ptr<std::set<GURL> > origin_set_;
 148   OriginToSizeMap origin_size_map_;
 149   OriginToSizeMap space_available_map_;
 150
 151   DISALLOW_COPY_AND_ASSIGN(IndexedDBContextImpl);
 152 };
 153
 154 }  // namespace content
 155
 156 #endif  // CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_CONTEXT_IMPL_H_