SyncFS: Factor out DriveMetadataDB migration functions

chrome/browser/sync_file_system/drive/metadata_db_migration_util.cc

 // Copyright 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.
 
 #include "chrome/browser/sync_file_system/drive/metadata_db_migration_util.h"
 
 #include "base/files/file_path.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string_util.h"
 #include "googleurl/src/gurl.h"
 #include "third_party/leveldatabase/src/include/leveldb/write_batch.h"
+#include "webkit/browser/fileapi/file_system_url.h"
+#include "webkit/common/fileapi/file_system_types.h"
 
 namespace sync_file_system {
 namespace drive {
 
 namespace {
 
+const base::FilePath::CharType kV0FormatPathPrefix[] =
+    FILE_PATH_LITERAL("drive/");
 const char kWapiFileIdPrefix[] = "file:";
 const char kWapiFolderIdPrefix[] = "folder:";
 
 std::string RemovePrefix(const std::string& str, const std::string& prefix) {
   if (StartsWithASCII(str, prefix, true))
     return std::string(str.begin() + prefix.size(), str.end());
   return str;
 }
 
 }  // namespace
 
+bool ParseV0FormatFileSystemURL(const GURL& url,
+                                GURL* origin,
+                                base::FilePath* path) {
+  fileapi::FileSystemType mount_type;
+  base::FilePath virtual_path;
+
+  if (!fileapi::FileSystemURL::ParseFileSystemSchemeURL(
+          url, origin, &mount_type, &virtual_path) ||
+      mount_type != fileapi::kFileSystemTypeExternal) {
+    NOTREACHED() << "Failed to parse filesystem scheme URL";
+    return false;
+  }
+
+  base::FilePath::StringType prefix =
+      base::FilePath(kV0FormatPathPrefix).NormalizePathSeparators().value();
+  if (virtual_path.value().substr(0, prefix.size()) != prefix)
+    return false;
+
+  *path = base::FilePath(virtual_path.value().substr(prefix.size()));
+  return true;
+}
+
 std::string AddWapiFilePrefix(const std::string& resource_id) {
   DCHECK(!StartsWithASCII(resource_id, kWapiFileIdPrefix, true));
   DCHECK(!StartsWithASCII(resource_id, kWapiFolderIdPrefix, true));
 
   if (resource_id.empty() ||
       StartsWithASCII(resource_id, kWapiFileIdPrefix, true) ||
       StartsWithASCII(resource_id, kWapiFolderIdPrefix, true))
     return resource_id;
   return kWapiFileIdPrefix + resource_id;
 }
@@ skipping 22 matching lines @@
 }
 
 std::string RemoveWapiIdPrefix(const std::string& resource_id) {
   if (StartsWithASCII(resource_id, kWapiFileIdPrefix, true))
     return RemovePrefix(resource_id, kWapiFileIdPrefix);
   if (StartsWithASCII(resource_id, kWapiFolderIdPrefix, true))
     return RemovePrefix(resource_id, kWapiFolderIdPrefix);
   return resource_id;
 }
 
+SyncStatusCode MigrateDatabaseFromV0ToV1(leveldb::DB* db) {
+  // Version 0 database format:
+  //   key: "CHANGE_STAMP"
+  //   value: <Largest Changestamp>
+  //
+  //   key: "SYNC_ROOT_DIR"
+  //   value: <Resource ID of the sync root directory>
+  //
+  //   key: "METADATA: " +
+  //        <FileSystemURL serialized by SerializeSyncableFileSystemURL>
+  //   value: <Serialized DriveMetadata>
+  //
+  //   key: "BSYNC_ORIGIN: " + <URL string of a batch sync origin>
+  //   value: <Resource ID of the drive directory for the origin>
+  //
+  //   key: "ISYNC_ORIGIN: " + <URL string of a incremental sync origin>
+  //   value: <Resource ID of the drive directory for the origin>
+  //
+  // Version 1 database format (changed keys/fields are marked with '*'):
+  // * key: "VERSION" (new)
+  // * value: 1
+  //
+  //   key: "CHANGE_STAMP"
+  //   value: <Largest Changestamp>
+  //
+  //   key: "SYNC_ROOT_DIR"
+  //   value: <Resource ID of the sync root directory>
+  //
+  // * key: "METADATA: " + <Origin and URL> (changed)
+  // * value: <Serialized DriveMetadata>
+  //
+  //   key: "BSYNC_ORIGIN: " + <URL string of a batch sync origin>
+  //   value: <Resource ID of the drive directory for the origin>
+  //
+  //   key: "ISYNC_ORIGIN: " + <URL string of a incremental sync origin>
+  //   value: <Resource ID of the drive directory for the origin>
+  //
+  //   key: "DISABLED_ORIGIN: " + <URL string of a disabled origin>
+  //   value: <Resource ID of the drive directory for the origin>
+
+  const char kDatabaseVersionKey[] = "VERSION";
+  const char kDriveMetadataKeyPrefix[] = "METADATA: ";
+  const char kMetadataKeySeparator = ' ';
+
+  leveldb::WriteBatch write_batch;
+  write_batch.Put(kDatabaseVersionKey, "1");
+
+  scoped_ptr<leveldb::Iterator> itr(db->NewIterator(leveldb::ReadOptions()));
+  for (itr->Seek(kDriveMetadataKeyPrefix); itr->Valid(); itr->Next()) {
+    std::string key = itr->key().ToString();
+    if (!StartsWithASCII(key, kDriveMetadataKeyPrefix, true))
+      break;
+    std::string serialized_url(RemovePrefix(key, kDriveMetadataKeyPrefix));
+
+    GURL origin;
+    base::FilePath path;
+    bool success = ParseV0FormatFileSystemURL(
+        GURL(serialized_url), &origin, &path);
+    DCHECK(success) << serialized_url;
+    std::string new_key = kDriveMetadataKeyPrefix + origin.spec() +
+        kMetadataKeySeparator + path.AsUTF8Unsafe();
+
+    write_batch.Put(new_key, itr->value());
+    write_batch.Delete(key);
+  }
+
+  return LevelDBStatusToSyncStatusCode(
+      db->Write(leveldb::WriteOptions(), &write_batch));
+}
+
 SyncStatusCode MigrateDatabaseFromV1ToV2(leveldb::DB* db) {
-  // Strips prefix of WAPI resource ID.
+  // Strips prefix of WAPI resource ID, and discards batch sync origins.
   // (i.e. "file:xxxx" => "xxxx", "folder:yyyy" => "yyyy")
   //
   // Version 2 database format (changed keys/fields are marked with '*'):
   //   key: "VERSION"
   // * value: 2
   //
   //   key: "CHANGE_STAMP"
   //   value: <Largest Changestamp>
   //
   //   key: "SYNC_ROOT_DIR"
   // * value: <Resource ID of the sync root directory> (striped)
   //
   //   key: "METADATA: " + <Origin and URL>
-  // * value: <Serialized DriveMetadata> (striped)
+  // * value: <Serialized DriveMetadata> (stripped)
+  //
+  // * key: "BSYNC_ORIGIN: " + <URL string of a batch sync origin> (deleted)
+  // * value: <Resource ID of the drive directory for the origin> (deleted)
   //
   //   key: "ISYNC_ORIGIN: " + <URL string of a incremental sync origin>
-  // * value: <Resource ID of the drive directory for the origin> (striped)
+  // * value: <Resource ID of the drive directory for the origin> (stripped)
   //
   //   key: "DISABLED_ORIGIN: " + <URL string of a disabled origin>
-  // * value: <Resource ID of the drive directory for the origin> (striped)
+  // * value: <Resource ID of the drive directory for the origin> (stripped)
 
   const char kDatabaseVersionKey[] = "VERSION";
   const char kSyncRootDirectoryKey[] = "SYNC_ROOT_DIR";
   const char kDriveMetadataKeyPrefix[] = "METADATA: ";
+  const char kDriveBatchSyncOriginKeyPrefix[] = "BSYNC_ORIGIN: ";
   const char kDriveIncrementalSyncOriginKeyPrefix[] = "ISYNC_ORIGIN: ";
   const char kDriveDisabledOriginKeyPrefix[] = "DISABLED_ORIGIN: ";
 
   leveldb::WriteBatch write_batch;
   write_batch.Put(kDatabaseVersionKey, "2");
 
   scoped_ptr<leveldb::Iterator> itr(db->NewIterator(leveldb::ReadOptions()));
   for (itr->SeekToFirst(); itr->Valid(); itr->Next()) {
     std::string key = itr->key().ToString();
 
@@ skipping 10 matching lines @@
       DCHECK(success);
 
       metadata.set_resource_id(RemoveWapiIdPrefix(metadata.resource_id()));
       std::string metadata_string;
       metadata.SerializeToString(&metadata_string);
 
       write_batch.Put(key, metadata_string);
       continue;
     }
 
+    // Deprecate legacy batch sync origin entries that are no longer needed.
+    if (StartsWithASCII(key, kDriveBatchSyncOriginKeyPrefix, true)) {
+      write_batch.Delete(key);
+      continue;
+    }
+
     // Strip resource ids of the incremental sync origins.
     if (StartsWithASCII(key, kDriveIncrementalSyncOriginKeyPrefix, true)) {
       write_batch.Put(key, RemoveWapiIdPrefix(itr->value().ToString()));
       continue;
     }
 
     // Strip resource ids of the disabled sync origins.
     if (StartsWithASCII(key, kDriveDisabledOriginKeyPrefix, true)) {
       write_batch.Put(key, RemoveWapiIdPrefix(itr->value().ToString()));
       continue;
     }
   }
 
   return LevelDBStatusToSyncStatusCode(
       db->Write(leveldb::WriteOptions(), &write_batch));
 }
 
 }  // namespace drive
 }  // namespace sync_file_system