Blob support for IDB [Chromium]

content/browser/indexed_db/indexed_db_backing_store.h

 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_BACKING_STORE_H_
 #define CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_BACKING_STORE_H_
 
+#include <set>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/files/file_path.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/timer/timer.h"
 #include "content/browser/indexed_db/indexed_db.h"
+#include "content/browser/indexed_db/indexed_db_active_blob_registry.h"
+#include "content/browser/indexed_db/indexed_db_blob_info.h"
+#include "content/browser/indexed_db/indexed_db_leveldb_coding.h"
 #include "content/browser/indexed_db/indexed_db_metadata.h"
 #include "content/browser/indexed_db/leveldb/leveldb_iterator.h"
 #include "content/browser/indexed_db/leveldb/leveldb_transaction.h"
 #include "content/common/content_export.h"
 #include "content/common/indexed_db/indexed_db_key.h"
 #include "content/common/indexed_db/indexed_db_key_path.h"
 #include "content/common/indexed_db/indexed_db_key_range.h"
 #include "third_party/leveldatabase/src/include/leveldb/status.h"
 #include "url/gurl.h"
+#include "webkit/browser/blob/blob_data_handle.h"
+
+class GURL;
+
+namespace base {
+class TaskRunner;
+}
+
+namespace fileapi {
+class FileWriterDelegate;
+}
+
+namespace net {
+class URLRequestContext;
+}
 
 namespace content {
 
+class IndexedDBFactory;
 class LevelDBComparator;
 class LevelDBDatabase;
+struct IndexedDBValue;
 
 class LevelDBFactory {
  public:
   virtual ~LevelDBFactory() {}
   virtual leveldb::Status OpenLevelDB(const base::FilePath& file_name,
                                       const LevelDBComparator* comparator,
                                       scoped_ptr<LevelDBDatabase>* db,
                                       bool* is_disk_full) = 0;
   virtual bool DestroyLevelDB(const base::FilePath& file_name) = 0;
 };
 
 class CONTENT_EXPORT IndexedDBBackingStore
     : public base::RefCounted<IndexedDBBackingStore> {
  public:
   class CONTENT_EXPORT Transaction;
 
   const GURL& origin_url() const { return origin_url_; }
   base::OneShotTimer<IndexedDBBackingStore>* close_timer() {
     return &close_timer_;
   }
+  IndexedDBFactory* factory() const { return indexed_db_factory_; }
 
   static scoped_refptr<IndexedDBBackingStore> Open(
+      IndexedDBFactory* indexed_db_factory,
       const GURL& origin_url,
       const base::FilePath& path_base,
-      blink::WebIDBDataLoss* data_loss,
-      std::string* data_loss_message,
-      bool* disk_full);
-
-  static scoped_refptr<IndexedDBBackingStore> Open(
-      const GURL& origin_url,
-      const base::FilePath& path_base,
+      net::URLRequestContext* request_context,
       blink::WebIDBDataLoss* data_loss,
       std::string* data_loss_message,
       bool* disk_full,
-      LevelDBFactory* factory);
-  static scoped_refptr<IndexedDBBackingStore> OpenInMemory(
-      const GURL& origin_url);
+      base::TaskRunner* task_runner,
+      bool clean_journal);
+
+  static scoped_refptr<IndexedDBBackingStore> Open(
+      IndexedDBFactory* indexed_db_factory,
+      const GURL& origin_url,
+      const base::FilePath& path_base,
+      net::URLRequestContext* request_context,
+      blink::WebIDBDataLoss* data_loss,
+      std::string* data_loss_message,
+      bool* disk_full,
+      LevelDBFactory* factory,
+      base::TaskRunner* task_runner,
+      bool clean_journal);
   static scoped_refptr<IndexedDBBackingStore> OpenInMemory(
       const GURL& origin_url,
-      LevelDBFactory* factory);
+      base::TaskRunner* task_runner);
+  static scoped_refptr<IndexedDBBackingStore> OpenInMemory(
+      const GURL& origin_url,
+      LevelDBFactory* factory,
+      base::TaskRunner* task_runner);
+
+  void GrantChildProcessPermissions(int child_process_id);
 
   virtual std::vector<string16> GetDatabaseNames();
   virtual bool GetIDBDatabaseMetaData(const string16& name,
                                       IndexedDBDatabaseMetadata* metadata,
                                       bool* success) WARN_UNUSED_RESULT;
   virtual bool CreateIDBDatabaseMetaData(const string16& name,
                                          const string16& version,
                                          int64 int_version,
                                          int64* row_id);
   virtual bool UpdateIDBDatabaseIntVersion(
@@ skipping 31 matching lines @@
     }
 
    private:
     // TODO(jsbell): Make it more clear that this is the *encoded* version of
     // the key.
     std::string primary_key_;
     int64 version_;
     DISALLOW_COPY_AND_ASSIGN(RecordIdentifier);
   };
 
+  class BlobWriteCallback : public RefCounted<BlobWriteCallback> {
+   public:
+    virtual ~BlobWriteCallback() {}
+    virtual void didSucceed() = 0;
+    virtual void didFail() = 0;
+  };
+
   virtual bool GetRecord(IndexedDBBackingStore::Transaction* transaction,
                          int64 database_id,
                          int64 object_store_id,
                          const IndexedDBKey& key,
-                         std::string* record) WARN_UNUSED_RESULT;
+                         IndexedDBValue* record) WARN_UNUSED_RESULT;
   virtual bool PutRecord(IndexedDBBackingStore::Transaction* transaction,
                          int64 database_id,
                          int64 object_store_id,
                          const IndexedDBKey& key,
-                         const std::string& value,
+                         IndexedDBValue& value,
+                         ScopedVector<webkit_blob::BlobDataHandle>* handles,
                          RecordIdentifier* record) WARN_UNUSED_RESULT;
   virtual bool ClearObjectStore(IndexedDBBackingStore::Transaction* transaction,
                                 int64 database_id,
                                 int64 object_store_id) WARN_UNUSED_RESULT;
   virtual bool DeleteRecord(IndexedDBBackingStore::Transaction* transaction,
                             int64 database_id,
                             int64 object_store_id,
                             const RecordIdentifier& record) WARN_UNUSED_RESULT;
+  virtual bool DeleteRange(IndexedDBBackingStore::Transaction* transaction,
+                           int64 database_id,
+                           int64 object_store_id,
+                           const IndexedDBKeyRange&) WARN_UNUSED_RESULT;
   virtual bool GetKeyGeneratorCurrentNumber(
       IndexedDBBackingStore::Transaction* transaction,
       int64 database_id,
       int64 object_store_id,
       int64* current_number) WARN_UNUSED_RESULT;
   virtual bool MaybeUpdateKeyGeneratorCurrentNumber(
       IndexedDBBackingStore::Transaction* transaction,
       int64 database_id,
       int64 object_store_id,
       int64 new_state,
@@ skipping 33 matching lines @@
       const IndexedDBKey& key,
       scoped_ptr<IndexedDBKey>* primary_key) WARN_UNUSED_RESULT;
   virtual bool KeyExistsInIndex(IndexedDBBackingStore::Transaction* transaction,
                                 int64 database_id,
                                 int64 object_store_id,
                                 int64 index_id,
                                 const IndexedDBKey& key,
                                 scoped_ptr<IndexedDBKey>* found_primary_key,
                                 bool* exists) WARN_UNUSED_RESULT;
 
+  // Public for IndexedDBActiveBlobRegistry::ReleaseBlobRef.
+  void ReportBlobUnused(int64 database_id, int64 blob_key);
+
+  base::FilePath GetBlobFileName(int64 database_id, int64 key);
+
   class Cursor {
    public:
     virtual ~Cursor();
 
     enum IteratorState {
       READY = 0,
       SEEK
     };
 
     struct CursorOptions {
@@ skipping 16 matching lines @@
       return Continue(key, NULL, state);
     }
     bool Continue(const IndexedDBKey* key,
                   const IndexedDBKey* primary_key,
                   IteratorState state);
     bool Advance(uint32 count);
     bool FirstSeek();
 
     virtual Cursor* Clone() = 0;
     virtual const IndexedDBKey& primary_key() const;
-    virtual std::string* Value() = 0;
+    virtual IndexedDBValue* Value() = 0;
     virtual const RecordIdentifier& record_identifier() const;
     virtual bool LoadCurrentRow() = 0;
 
    protected:
-    Cursor(LevelDBTransaction* transaction,
+    Cursor(scoped_refptr<IndexedDBBackingStore> backing_store,
+           LevelDBTransaction* transaction,
+           int64 database_id,
            const CursorOptions& cursor_options);
     explicit Cursor(const IndexedDBBackingStore::Cursor* other);
 
     virtual std::string EncodeKey(const IndexedDBKey& key) = 0;
     virtual std::string EncodeKey(const IndexedDBKey& key,
                                   const IndexedDBKey& primary_key) = 0;
 
     bool IsPastBounds() const;
     bool HaveEnteredRange() const;
 
+    scoped_refptr<IndexedDBBackingStore> backing_store_;
     LevelDBTransaction* transaction_;
+    int64 database_id_;
     const CursorOptions cursor_options_;
     scoped_ptr<LevelDBIterator> iterator_;
     scoped_ptr<IndexedDBKey> current_key_;
     IndexedDBBackingStore::RecordIdentifier record_identifier_;
   };
 
   virtual scoped_ptr<Cursor> OpenObjectStoreKeyCursor(
       IndexedDBBackingStore::Transaction* transaction,
       int64 database_id,
       int64 object_store_id,
@@ skipping 18 matching lines @@
       int64 object_store_id,
       int64 index_id,
       const IndexedDBKeyRange& key_range,
       indexed_db::CursorDirection);
 
   class Transaction {
    public:
     explicit Transaction(IndexedDBBackingStore* backing_store);
     ~Transaction();
     void Begin();
-    bool Commit();
+    // The callback will be called eventually on success or failure, or
+    // immediately if phase one is complete due to lack of any blobs to write.
+    bool CommitPhaseOne(scoped_refptr<BlobWriteCallback>);
+    bool CommitPhaseTwo();
     void Rollback();
     void Reset() {
       backing_store_ = NULL;
       transaction_ = NULL;
     }
+    void PutBlobInfo(int64 database_id,
+                     int64 object_store_id,
+                     const std::string& key,
+                     std::vector<IndexedDBBlobInfo>*,
+                     ScopedVector<webkit_blob::BlobDataHandle>* handles);
 
     LevelDBTransaction* transaction() { return transaction_; }
 
+    // DatabaseId, BlobKey
+    typedef std::pair<int64_t, int64_t> BlobJournalEntryType;
+    typedef std::vector<BlobJournalEntryType> BlobJournalType;
+    // This holds a BlobEntryKey and the encoded IndexedDBBlobInfo vector stored
+    // under that key.
+    typedef std::vector<std::pair<BlobEntryKey, std::string> >
+        BlobEntryKeyValuePairVec;
+
+    class WriteDescriptor {
+     public:
+      WriteDescriptor(const GURL& url, int64_t key);
+      WriteDescriptor(const base::FilePath& path, int64_t key);
+
+      bool is_file() const { return is_file_; }
+      const GURL& url() const {
+        DCHECK(!is_file_);
+        return url_;
+      }
+      const base::FilePath& file_path() const {
+        DCHECK(is_file_);
+        return file_path_;
+      }
+      int64_t key() const { return key_; }
+
+     private:
+      bool is_file_;
+      GURL url_;
+      base::FilePath file_path_;
+      int64_t key_;
+    };
+
+    class ChainedBlobWriter : public base::RefCounted<ChainedBlobWriter> {
+     public:
+      virtual void set_delegate(
+          scoped_ptr<fileapi::FileWriterDelegate> delegate) = 0;
+
+      virtual void ReportWriteCompletion(bool succeeded,
+                                         int64 bytes_written) = 0;
+
+      virtual void Abort() = 0;
+
+     protected:
+      virtual ~ChainedBlobWriter() {}
+      friend class base::RefCounted<ChainedBlobWriter>;
+    };
+    class ChainedBlobWriterImpl;
+
+    typedef std::vector<WriteDescriptor> WriteDescriptorVec;
+
    private:
+    class BlobChangeRecord {
+     public:
+      BlobChangeRecord() {}
+      void set_key(const std::string& key) { key_ = key; }
+      const std::string& key() const { return key_; }
+      void set_object_store_id(int64 object_store_id) {
+        object_store_id_ = object_store_id;
+      }
+      int64 object_store_id() const { return object_store_id_; }
+      void SetBlobInfo(std::vector<IndexedDBBlobInfo>* blob_info);
+      std::vector<IndexedDBBlobInfo>& mutable_blob_info() { return blob_info_; }
+      void SetHandles(ScopedVector<webkit_blob::BlobDataHandle>* handles);
+
+     private:
+      std::string key_;
+      int64 object_store_id_;
+      std::vector<IndexedDBBlobInfo> blob_info_;
+      ScopedVector<webkit_blob::BlobDataHandle> handles_;
+    };
+    class BlobWriteCallbackWrapper;
+    typedef std::map<std::string, BlobChangeRecord*> BlobChangeMap;
+
+    // These return true on success, false on failure.
+    bool HandleBlobPreTransaction(BlobEntryKeyValuePairVec* new_blob_entries,
+                                  WriteDescriptorVec* new_files_to_write);
+    bool CollectBlobFilesToRemove();
+    // The callback will be called eventually on success or failure.
+    void WriteNewBlobs(BlobEntryKeyValuePairVec& new_blob_entries,
+                       WriteDescriptorVec& new_files_to_write,
+                       scoped_refptr<BlobWriteCallback> callback);
+    bool SortBlobsToRemove();
+
     IndexedDBBackingStore* backing_store_;
     scoped_refptr<LevelDBTransaction> transaction_;
+    BlobChangeMap blob_change_map_;
+    int64 database_id_;
+    BlobJournalType blobs_to_remove_;
+    scoped_refptr<ChainedBlobWriter> chained_blob_writer_;
   };
 
+  LevelDBComparator* comparator() { return comparator_.get(); }
+  IndexedDBActiveBlobRegistry* active_blob_registry() {
+    return &active_blob_registry_;
+  }
+
+  base::TaskRunner* task_runner() { return task_runner_; }
+
  protected:
-  IndexedDBBackingStore(const GURL& origin_url,
+  IndexedDBBackingStore(IndexedDBFactory* indexed_db_factory,
+                        const GURL& origin_url,
+                        const base::FilePath& blob_path,
+                        net::URLRequestContext* request_context,
                         scoped_ptr<LevelDBDatabase> db,
-                        scoped_ptr<LevelDBComparator> comparator);
+                        scoped_ptr<LevelDBComparator> comparator,
+                        base::TaskRunner* task_runner);
   virtual ~IndexedDBBackingStore();
   friend class base::RefCounted<IndexedDBBackingStore>;
 
+  bool SetUpMetadata();
+
+  virtual bool WriteBlobFile(
+      int64 database_id,
+      const Transaction::WriteDescriptor& descriptor,
+      Transaction::ChainedBlobWriter* chained_blob_writer);
+  virtual bool RemoveBlobFile(int64 database_id, int64 key);
+  virtual void StartJournalCleaningTimer();
+  void CleanPrimaryJournalIgnoreReturn();
+
  private:
   static scoped_refptr<IndexedDBBackingStore> Create(
+      IndexedDBFactory* indexed_db_factory,
       const GURL& origin_url,
+      const base::FilePath& blob_path,
+      net::URLRequestContext* request_context,
       scoped_ptr<LevelDBDatabase> db,
-      scoped_ptr<LevelDBComparator> comparator);
+      scoped_ptr<LevelDBComparator> comparator,
+      base::TaskRunner* task_runner);
 
   bool FindKeyInIndex(IndexedDBBackingStore::Transaction* transaction,
                       int64 database_id,
                       int64 object_store_id,
                       int64 index_id,
                       const IndexedDBKey& key,
                       std::string* found_encoded_primary_key,
                       bool* found);
   bool GetIndexes(int64 database_id,
                   int64 object_store_id,
                   IndexedDBObjectStoreMetadata::IndexMap* map)
       WARN_UNUSED_RESULT;
+  bool RemoveBlobDirectory(int64 database_id);
+  bool CleanUpBlobJournal(const std::string& level_db_key);
 
+  IndexedDBFactory* indexed_db_factory_;
   const GURL origin_url_;
 
   // The origin identifier is a key prefix unique to the origin used in the
   // leveldb backing store to partition data by origin. It is a normalized
   // version of the origin URL with a versioning suffix appended, e.g.
   // "http_localhost_81@1" Since only one origin is stored per backing store
   // this is redundant but necessary for backwards compatibility; the suffix
   // provides for future flexibility.
   const std::string origin_identifier_;
 
+  base::FilePath blob_path_;
+  net::URLRequestContext* request_context_;
+  base::TaskRunner* task_runner_;
+  std::set<int> child_process_ids_granted_;
+  base::OneShotTimer<IndexedDBBackingStore> journal_cleaning_timer_;
+
   scoped_ptr<LevelDBDatabase> db_;
   scoped_ptr<LevelDBComparator> comparator_;
+  // The active_blob_registry_ will hold a refcount to this backing store
+  // whenever any live blobs are registered with it.
+  IndexedDBActiveBlobRegistry active_blob_registry_;
   base::OneShotTimer<IndexedDBBackingStore> close_timer_;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_BACKING_STORE_H_