Add blob-writing functionality [as yet un-called] to IDB's backend.

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/strings/string_piece.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"
 
 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() {}
@@ skipping 23 matching lines @@
     return &close_timer_;
   }
   IndexedDBActiveBlobRegistry* active_blob_registry() {
     return &active_blob_registry_;
   }
 
   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,
       base::TaskRunner* task_runner);
 
   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* leveldb_factory,
       base::TaskRunner* task_runner);
   static scoped_refptr<IndexedDBBackingStore> OpenInMemory(
       const GURL& origin_url,
       base::TaskRunner* task_runner);
   static scoped_refptr<IndexedDBBackingStore> OpenInMemory(
       const GURL& origin_url,
@@ skipping 55 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 leveldb::Status GetRecord(
       IndexedDBBackingStore::Transaction* transaction,
       int64 database_id,
       int64 object_store_id,
       const IndexedDBKey& key,
       IndexedDBValue* record) WARN_UNUSED_RESULT;
   virtual leveldb::Status PutRecord(
       IndexedDBBackingStore::Transaction* transaction,
       int64 database_id,
       int64 object_store_id,
@@ skipping 62 matching lines @@
       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.
   virtual 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 92 matching lines @@
       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_; }
 
+    // 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,

[cmumford, 2014/04/18 17:19:06]

Nit: This class has a completion callback with a succeeded param, but
BlobWriteCallback has two functions for success/failure. Would it be clearer if
they were consistent?

I'd like to go one further with a failure reason. It'd be great to give API's
enough information tell user cause of failure (disk full, network disconnect,
etc.)

[ericu, 2014/04/21 20:54:19]

Done; I'm not sure why I had that difference...it may date back to the
in-process webkit.
Added a TODO.

+                                         int64 bytes_written) = 0;
+
+      virtual void Abort() = 0;
+
+     protected:
+      virtual ~ChainedBlobWriter() {}
+      friend class base::RefCounted<ChainedBlobWriter>;
+    };
+    class ChainedBlobWriterImpl;

[cmumford, 2014/04/18 17:19:06]

ChainedBlobWriterImpl doesn't seem to be used in this file.

[ericu, 2014/04/21 20:54:19]

It has to be declared as a member of 
IndexedDBBackingStore::Transaction in order to call WriteBlobFile.

+
+    typedef std::vector<WriteDescriptor> WriteDescriptorVec;
+
    private:
     class BlobChangeRecord {
      public:
       BlobChangeRecord(const std::string& key, int64 object_store_id);
       ~BlobChangeRecord();
       const std::string& key() const { return key_; }
       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;
 
+    // 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);
+
     IndexedDBBackingStore* backing_store_;
     scoped_refptr<LevelDBTransaction> transaction_;
     BlobChangeMap blob_change_map_;
     int64 database_id_;
+    scoped_refptr<ChainedBlobWriter> chained_blob_writer_;
   };
 
  protected:
   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,
                         base::TaskRunner* task_runner);
   virtual ~IndexedDBBackingStore();
   friend class base::RefCounted<IndexedDBBackingStore>;
 
+  virtual bool WriteBlobFile(
+      int64 database_id,
+      const Transaction::WriteDescriptor& descriptor,
+      Transaction::ChainedBlobWriter* chained_blob_writer);
+  virtual bool RemoveBlobFile(int64 database_id, int64 key);
+
  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,
       base::TaskRunner* task_runner);
 
   static bool ReadCorruptionInfo(const base::FilePath& path_base,
                                  const GURL& origin_url,
                                  std::string& message);
 
   leveldb::Status 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);
   leveldb::Status GetIndexes(int64 database_id,
                              int64 object_store_id,
                              IndexedDBObjectStoreMetadata::IndexMap* map)
       WARN_UNUSED_RESULT;
+  bool RemoveBlobDirectory(int64 database_id);
 
   IndexedDBFactory* indexed_db_factory_;
   const GURL origin_url_;
   base::FilePath blob_path_;
 
   // 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_;
+
+  net::URLRequestContext* request_context_;
   base::TaskRunner* task_runner_;
   std::set<int> child_process_ids_granted_;
 
   scoped_ptr<LevelDBDatabase> db_;
   scoped_ptr<LevelDBComparator> comparator_;
   // Whenever blobs are registered in active_blob_registry_, indexed_db_factory_
   // will hold a reference to this backing store.
   IndexedDBActiveBlobRegistry active_blob_registry_;
   base::OneShotTimer<IndexedDBBackingStore> close_timer_;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_BACKING_STORE_H_