New IPC message parameters for IDB/Blob support.

content/common/indexed_db/indexed_db_messages.h

 // Copyright (c) 2012 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.
 
 // Message definition file, included multiple times, hence no include guard.
 
 #include <utility>
 #include <vector>
 
 #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 "content/common/indexed_db/indexed_db_param_traits.h"
 #include "ipc/ipc_message_macros.h"
 #include "ipc/ipc_param_traits.h"
 #include "third_party/WebKit/public/platform/WebIDBCursor.h"
 #include "third_party/WebKit/public/platform/WebIDBDatabase.h"
+#include "url/gurl.h"

[cmumford, 2014/04/08 21:47:26]

Is gurl.h needed?

[ericu, 2014/04/08 22:07:11]

No, that's old.  Removed.

 
 #undef IPC_MESSAGE_EXPORT
 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
 #define IPC_MESSAGE_START IndexedDBMsgStart
 
 // Argument structures used in messages
 
 IPC_ENUM_TRAITS_MAX_VALUE(blink::WebIDBCursor::Direction,
                           blink::WebIDBCursor::DirectionLast)
 IPC_ENUM_TRAITS_MAX_VALUE(blink::WebIDBDatabase::PutMode,
@@ skipping 86 matching lines @@
   // The object store's id.
   IPC_STRUCT_MEMBER(int64, object_store_id)
   // The index's id.
   IPC_STRUCT_MEMBER(int64, index_id)
   // The serialized key range.
   IPC_STRUCT_MEMBER(content::IndexedDBKeyRange, key_range)
   // If this is just retrieving the key
   IPC_STRUCT_MEMBER(bool, key_only)
 IPC_STRUCT_END()
 
+IPC_STRUCT_BEGIN(IndexedDBMsg_BlobOrFileInfo)
+IPC_STRUCT_MEMBER(bool, is_file)
+IPC_STRUCT_MEMBER(std::string, uuid)
+IPC_STRUCT_MEMBER(base::string16, mime_type)
+IPC_STRUCT_MEMBER(uint64, size)
+IPC_STRUCT_MEMBER(base::string16, file_path)
+IPC_STRUCT_MEMBER(base::string16, file_name)
+IPC_STRUCT_MEMBER(double, last_modified)
+IPC_STRUCT_END()
+
 // Used to set a value in an object store.
 IPC_STRUCT_BEGIN(IndexedDBHostMsg_DatabasePut_Params)
   // The id any response should contain.
   IPC_STRUCT_MEMBER(int32, ipc_thread_id)
   IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
   // The database the object store belongs to.
   IPC_STRUCT_MEMBER(int32, ipc_database_id)
   // The transaction it's associated with.
   IPC_STRUCT_MEMBER(int64, transaction_id)
   // The object store's id.
   IPC_STRUCT_MEMBER(int64, object_store_id)
   // The index's id.
   IPC_STRUCT_MEMBER(int64, index_id)
   // The value to set.
   IPC_STRUCT_MEMBER(std::string, value)
   // The key to set it on (may not be "valid"/set in some cases).
   IPC_STRUCT_MEMBER(content::IndexedDBKey, key)
   // Whether this is an add or a put.
   IPC_STRUCT_MEMBER(blink::WebIDBDatabase::PutMode, put_mode)
   // The index ids and the list of keys for each index.
   IPC_STRUCT_MEMBER(std::vector<IndexKeys>, index_keys)
+  // Sideband data for any blob or file encoded in value.
+  IPC_STRUCT_MEMBER(std::vector<IndexedDBMsg_BlobOrFileInfo>, blob_or_file_info)
 IPC_STRUCT_END()
 
 // Used to open both cursors and object cursors in IndexedDB.
 IPC_STRUCT_BEGIN(IndexedDBHostMsg_DatabaseOpenCursor_Params)
   // The response should have these ids.
   IPC_STRUCT_MEMBER(int32, ipc_thread_id)
   IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
   // The database the object store belongs to.
   IPC_STRUCT_MEMBER(int32, ipc_database_id)
   // The transaction this request belongs to.
@@ skipping 76 matching lines @@
   IPC_STRUCT_MEMBER(bool, multi_entry)
 IPC_STRUCT_END()
 
 IPC_STRUCT_BEGIN(IndexedDBMsg_CallbacksSuccessIDBCursor_Params)
   IPC_STRUCT_MEMBER(int32, ipc_thread_id)
   IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
   IPC_STRUCT_MEMBER(int32, ipc_cursor_id)
   IPC_STRUCT_MEMBER(content::IndexedDBKey, key)
   IPC_STRUCT_MEMBER(content::IndexedDBKey, primary_key)
   IPC_STRUCT_MEMBER(std::string, value)
+  // Sideband data for any blob or file encoded in value.
+  IPC_STRUCT_MEMBER(std::vector<IndexedDBMsg_BlobOrFileInfo>, blob_or_file_info)
 IPC_STRUCT_END()
 
 IPC_STRUCT_BEGIN(IndexedDBMsg_CallbacksSuccessCursorContinue_Params)
   IPC_STRUCT_MEMBER(int32, ipc_thread_id)
   IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
   IPC_STRUCT_MEMBER(int32, ipc_cursor_id)
   IPC_STRUCT_MEMBER(content::IndexedDBKey, key)
   IPC_STRUCT_MEMBER(content::IndexedDBKey, primary_key)
   IPC_STRUCT_MEMBER(std::string, value)
+  // Sideband data for any blob or file encoded in value.
+  IPC_STRUCT_MEMBER(std::vector<IndexedDBMsg_BlobOrFileInfo>, blob_or_file_info)
 IPC_STRUCT_END()
 
 IPC_STRUCT_BEGIN(IndexedDBMsg_CallbacksSuccessCursorPrefetch_Params)
   IPC_STRUCT_MEMBER(int32, ipc_thread_id)
   IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
   IPC_STRUCT_MEMBER(int32, ipc_cursor_id)
   IPC_STRUCT_MEMBER(std::vector<content::IndexedDBKey>, keys)
   IPC_STRUCT_MEMBER(std::vector<content::IndexedDBKey>, primary_keys)
   IPC_STRUCT_MEMBER(std::vector<std::string>, values)
+  // Sideband data for any blob or file encoded in value.
+  IPC_STRUCT_MEMBER(std::vector<std::vector<IndexedDBMsg_BlobOrFileInfo> >,
+                    blob_or_file_infos)
+IPC_STRUCT_END()
+
+IPC_STRUCT_BEGIN(IndexedDBMsg_CallbacksSuccessValue_Params)
+  IPC_STRUCT_MEMBER(int32, ipc_thread_id)
+  IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
+  IPC_STRUCT_MEMBER(std::string, value)
+  // Sideband data for any blob or file encoded in value.
+  IPC_STRUCT_MEMBER(std::vector<IndexedDBMsg_BlobOrFileInfo>, blob_or_file_info)
+IPC_STRUCT_END()
+
+IPC_STRUCT_BEGIN(IndexedDBMsg_CallbacksSuccessValueWithKey_Params)
+  IPC_STRUCT_MEMBER(int32, ipc_thread_id)
+  IPC_STRUCT_MEMBER(int32, ipc_callbacks_id)
+  IPC_STRUCT_MEMBER(std::string, value)
+  IPC_STRUCT_MEMBER(content::IndexedDBKey, primary_key)

[cmumford, 2014/04/08 21:47:26]

The other messages only use primary_key when there is another key(s) member.
Might this be better named as "key"?

[ericu, 2014/04/08 22:07:11]

I used primary_key as that was the name of the parameter that got rolled in [see
OnSuccessValueWithKey].  I don't see an example of a parameter object for an
onsuccess method that uses key and has no primary_key, so this seems consistent
to me too.

The closest I see to a counterexample is key vs. index_key in
IndexedDBHostMsg_DatabasePut_Params, but then
IndexedDBHostMsg_DatabaseSetIndexKeys_Params uses primary_key vs. index_keys, so
maybe that one should be fixed to be primary_key.

+  IPC_STRUCT_MEMBER(content::IndexedDBKeyPath, key_path)
+  // Sideband data for any blob or file encoded in value.
+  IPC_STRUCT_MEMBER(std::vector<IndexedDBMsg_BlobOrFileInfo>, blob_or_file_info)
 IPC_STRUCT_END()
 
 IPC_STRUCT_BEGIN(IndexedDBIndexMetadata)
   IPC_STRUCT_MEMBER(int64, id)
   IPC_STRUCT_MEMBER(base::string16, name)
   IPC_STRUCT_MEMBER(content::IndexedDBKeyPath, keyPath)
   IPC_STRUCT_MEMBER(bool, unique)
   IPC_STRUCT_MEMBER(bool, multiEntry)
 IPC_STRUCT_END()
 
@@ skipping 48 matching lines @@
 IPC_MESSAGE_CONTROL5(IndexedDBMsg_CallbacksSuccessIDBDatabase,
                      int32 /* ipc_thread_id */,
                      int32 /* ipc_callbacks_id */,
                      int32 /* ipc_database_callbacks_id */,
                      int32 /* ipc_database_id */,
                      IndexedDBDatabaseMetadata)
 IPC_MESSAGE_CONTROL3(IndexedDBMsg_CallbacksSuccessIndexedDBKey,
                      int32 /* ipc_thread_id */,
                      int32 /* ipc_callbacks_id */,
                      content::IndexedDBKey /* indexed_db_key */)
-IPC_MESSAGE_CONTROL3(IndexedDBMsg_CallbacksSuccessValue,
-                     int32 /* ipc_thread_id */,
-                     int32 /* ipc_callbacks_id */,
-                     std::string /* value */)
-IPC_MESSAGE_CONTROL5(IndexedDBMsg_CallbacksSuccessValueWithKey,
-                     int32 /* ipc_thread_id */,
-                     int32 /* ipc_callbacks_id */,
-                     std::string /* value */,
-                     content::IndexedDBKey /* indexed_db_key */,
-                     content::IndexedDBKeyPath /* indexed_db_keypath */)
+
+IPC_MESSAGE_CONTROL1(IndexedDBMsg_CallbacksSuccessValue,
+                     IndexedDBMsg_CallbacksSuccessValue_Params)
+
+IPC_MESSAGE_CONTROL1(IndexedDBMsg_CallbacksSuccessValueWithKey,
+                     IndexedDBMsg_CallbacksSuccessValueWithKey_Params)
+
 IPC_MESSAGE_CONTROL3(IndexedDBMsg_CallbacksSuccessInteger,
                      int32 /* ipc_thread_id */,
                      int32 /* ipc_callbacks_id */,
                      int64 /* value */)
 IPC_MESSAGE_CONTROL2(IndexedDBMsg_CallbacksSuccessUndefined,
                      int32 /* ipc_thread_id */,
                      int32 /* ipc_callbacks_id */)
 IPC_MESSAGE_CONTROL3(IndexedDBMsg_CallbacksSuccessStringList,
                      int32 /* ipc_thread_id */,
                      int32 /* ipc_callbacks_id */,
@@ skipping 156 matching lines @@
                      int64) /* transaction_id */
 
 // WebIDBDatabase::commit() message.
 IPC_MESSAGE_CONTROL2(IndexedDBHostMsg_DatabaseCommit,
                      int32, /* ipc_database_id */
                      int64) /* transaction_id */
 
 // WebIDBDatabase::~WebIDBCursor() message.
 IPC_MESSAGE_CONTROL1(IndexedDBHostMsg_CursorDestroyed,
                      int32 /* ipc_cursor_id */)