[GCM] Move registration info persistence from extension state store to GCM store

google_apis/gcm/engine/gcm_store_impl.cc

 // Copyright 2014 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 "google_apis/gcm/engine/gcm_store_impl.h"
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/file_util.h"
@@ skipping 17 matching lines @@
 namespace {
 
 // Limit to the number of outstanding messages per app.
 const int kMessagesPerAppLimit = 20;
 
 // ---- LevelDB keys. ----
 // Key for this device's android id.
 const char kDeviceAIDKey[] = "device_aid_key";
 // Key for this device's android security token.
 const char kDeviceTokenKey[] = "device_token_key";
+// Lowest lexicographically ordered app ids.
+// Used for prefixing app id.
+const char kRegistrationKeyStart[] = "reg1-";
+// Key guaranteed to be higher than all app ids.
+// Used for limiting iteration.
+const char kRegistrationKeyEnd[] = "reg2-";
 // Lowest lexicographically ordered incoming message key.
 // Used for prefixing messages.
 const char kIncomingMsgKeyStart[] = "incoming1-";
 // Key guaranteed to be higher than all incoming message keys.
 // Used for limiting iteration.
 const char kIncomingMsgKeyEnd[] = "incoming2-";
-// Key for next serial number assigned to the user.
-const char kNextSerialNumberKey[] = "next_serial_number_key";
 // Lowest lexicographically ordered outgoing message key.
 // Used for prefixing outgoing messages.
 const char kOutgoingMsgKeyStart[] = "outgoing1-";
 // Key guaranteed to be higher than all outgoing message keys.
 // Used for limiting iteration.
 const char kOutgoingMsgKeyEnd[] = "outgoing2-";
-// Lowest lexicographically ordered username.
-// Used for prefixing username to serial number mappings.
-const char kUserSerialNumberKeyStart[] = "user1-";
-// Key guaranteed to be higher than all usernames.
-// Used for limiting iteration.
-const char kUserSerialNumberKeyEnd[] = "user2-";
 
-// Value indicating that serial number was not assigned.
-const int64 kSerialNumberMissing = -1LL;
+std::string MakeRegistrationKey(const std::string& app_id) {
+  return kRegistrationKeyStart + app_id;
+}
+
+std::string ParseRegistrationKey(const std::string& key) {
+  return key.substr(arraysize(kRegistrationKeyStart) - 1);
+}
 
 std::string MakeIncomingKey(const std::string& persistent_id) {
   return kIncomingMsgKeyStart + persistent_id;
 }
 
 std::string MakeOutgoingKey(const std::string& persistent_id) {
   return kOutgoingMsgKeyStart + persistent_id;
 }
 
-std::string MakeUserSerialNumberKey(const std::string& username) {
-  return kUserSerialNumberKeyStart + username;
-}
-
 std::string ParseOutgoingKey(const std::string& key) {
   return key.substr(arraysize(kOutgoingMsgKeyStart) - 1);
 }
 
-std::string ParseUsername(const std::string& key) {
-  return key.substr(arraysize(kUserSerialNumberKeyStart) - 1);
-}
-
 // Note: leveldb::Slice keeps a pointer to the data in |s|, which must therefore
 // outlive the slice.
 // For example: MakeSlice(MakeOutgoingKey(x)) is invalid.
 leveldb::Slice MakeSlice(const base::StringPiece& s) {
   return leveldb::Slice(s.begin(), s.size());
 }
 
 }  // namespace
 
 class GCMStoreImpl::Backend
     : public base::RefCountedThreadSafe<GCMStoreImpl::Backend> {
  public:
   Backend(const base::FilePath& path,
           scoped_refptr<base::SequencedTaskRunner> foreground_runner);
 
   // Blocking implementations of GCMStoreImpl methods.
   void Load(const LoadCallback& callback);
   void Close();
   void Destroy(const UpdateCallback& callback);
   void SetDeviceCredentials(uint64 device_android_id,
                             uint64 device_security_token,
                             const UpdateCallback& callback);
+  void AddRegistration(const std::string& app_id,
+                       const linked_ptr<RegistrationInfo>& registration,
+                       const UpdateCallback& callback);
+  void RemoveRegistration(const std::string& app_id,
+                          const UpdateCallback& callback);
   void AddIncomingMessage(const std::string& persistent_id,
                           const UpdateCallback& callback);
   void RemoveIncomingMessages(const PersistentIdList& persistent_ids,
                               const UpdateCallback& callback);
   void AddOutgoingMessage(const std::string& persistent_id,
                           const MCSMessage& message,
                           const UpdateCallback& callback);
   void RemoveOutgoingMessages(
       const PersistentIdList& persistent_ids,
       const base::Callback<void(bool, const AppIdToMessageCountMap&)>
           callback);
   void AddUserSerialNumber(const std::string& username,
                            int64 serial_number,
                            const UpdateCallback& callback);
   void RemoveUserSerialNumber(const std::string& username,
                               const UpdateCallback& callback);
   void SetNextSerialNumber(int64 serial_number, const UpdateCallback& callback);
 
  private:
   friend class base::RefCountedThreadSafe<Backend>;
   ~Backend();
 
   bool LoadDeviceCredentials(uint64* android_id, uint64* security_token);
+  bool LoadRegistrations(RegistrationInfoMap* registrations);
   bool LoadIncomingMessages(std::vector<std::string>* incoming_messages);
   bool LoadOutgoingMessages(OutgoingMessageMap* outgoing_messages);
-  bool LoadNextSerialNumber(int64* next_serial_number);
-  bool LoadUserSerialNumberMap(
-      std::map<std::string, int64>* user_serial_number_map);
 
   const base::FilePath path_;
   scoped_refptr<base::SequencedTaskRunner> foreground_task_runner_;
 
   scoped_ptr<leveldb::DB> db_;
 };
 
 GCMStoreImpl::Backend::Backend(
     const base::FilePath& path,
     scoped_refptr<base::SequencedTaskRunner> foreground_task_runner)
@@ skipping 22 matching lines @@
                << status.ToString();
     foreground_task_runner_->PostTask(FROM_HERE,
                                       base::Bind(callback,
                                                  base::Passed(&result)));
     return;
   }
   db_.reset(db);
 
   if (!LoadDeviceCredentials(&result->device_android_id,
                              &result->device_security_token) ||
+      !LoadRegistrations(&result->registrations) ||
       !LoadIncomingMessages(&result->incoming_messages) ||
-      !LoadOutgoingMessages(&result->outgoing_messages) ||
-      !LoadNextSerialNumber(
-           &result->serial_number_mappings.next_serial_number) ||
-      !LoadUserSerialNumberMap(
-           &result->serial_number_mappings.user_serial_numbers)) {
+      !LoadOutgoingMessages(&result->outgoing_messages)) {
     result->device_android_id = 0;
     result->device_security_token = 0;
+    result->registrations.clear();
     result->incoming_messages.clear();
     result->outgoing_messages.clear();
     foreground_task_runner_->PostTask(FROM_HERE,
                                       base::Bind(callback,
                                                  base::Passed(&result)));
     return;
   }
 
   // Only record histograms if GCM had already been set up for this device.
   if (result->device_android_id != 0 && result->device_security_token != 0) {
     int64 file_size = 0;
     if (base::GetFileSize(path_, &file_size)) {
       UMA_HISTOGRAM_COUNTS("GCM.StoreSizeKB",
                            static_cast<int>(file_size / 1024));
     }
+    UMA_HISTOGRAM_COUNTS("GCM.RestoredRegistrations",
+                         result->registrations.size());
     UMA_HISTOGRAM_COUNTS("GCM.RestoredOutgoingMessages",
                          result->outgoing_messages.size());
     UMA_HISTOGRAM_COUNTS("GCM.RestoredIncomingMessages",
                          result->incoming_messages.size());
-    UMA_HISTOGRAM_COUNTS(
-        "GCM.NumUsers",
-        result->serial_number_mappings.user_serial_numbers.size());
   }
 
-  DVLOG(1) << "Succeeded in loading " << result->incoming_messages.size()
+  DVLOG(1) << "Succeeded in loading " << result->registrations.size()
+           << " registrations, "
+           << result->incoming_messages.size()
            << " unacknowledged incoming messages and "
            << result->outgoing_messages.size()
            << " unacknowledged outgoing messages.";
   result->success = true;
   foreground_task_runner_->PostTask(FROM_HERE,
                                     base::Bind(callback,
                                                base::Passed(&result)));
   return;
 }
 
@@ skipping 42 matching lines @@
         write_options, MakeSlice(kDeviceTokenKey), MakeSlice(encrypted_token));
   }
   if (s.ok()) {
     foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, true));
     return;
   }
   LOG(ERROR) << "LevelDB put failed: " << s.ToString();
   foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
 }
 
+void GCMStoreImpl::Backend::AddRegistration(
+    const std::string& app_id,
+    const linked_ptr<RegistrationInfo>& registration,
+    const UpdateCallback& callback) {
+  DVLOG(1) << "Saving registration info for app: " << app_id;
+  if (!db_.get()) {
+    LOG(ERROR) << "GCMStore db doesn't exist.";
+    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
+    return;
+  }
+  leveldb::WriteOptions write_options;
+  write_options.sync = true;
+
+  std::string key = MakeRegistrationKey(app_id);
+  std::string value = registration->SerializeAsString();
+  const leveldb::Status status = db_->Put(write_options,
+                                          MakeSlice(key),
+                                          MakeSlice(value));
+  if (status.ok()) {
+    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, true));
+    return;
+  }
+  LOG(ERROR) << "LevelDB put failed: " << status.ToString();
+  foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
+}
+
+void GCMStoreImpl::Backend::RemoveRegistration(const std::string& app_id,
+                                               const UpdateCallback& callback) {
+  if (!db_.get()) {
+    LOG(ERROR) << "GCMStore db doesn't exist.";
+    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
+    return;
+  }
+  leveldb::WriteOptions write_options;
+  write_options.sync = true;
+
+  leveldb::Status status = db_->Delete(write_options, MakeSlice(app_id));
+  if (status.ok()) {
+    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, true));
+    return;
+  }
+  LOG(ERROR) << "LevelDB remove failed: " << status.ToString();
+  foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
+}
+
 void GCMStoreImpl::Backend::AddIncomingMessage(const std::string& persistent_id,
                                                const UpdateCallback& callback) {
   DVLOG(1) << "Saving incoming message with id " << persistent_id;
   if (!db_.get()) {
     LOG(ERROR) << "GCMStore db doesn't exist.";
     foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
     return;
   }
 
   leveldb::WriteOptions write_options;
@@ skipping 117 matching lines @@
                                                  removed_message_counts));
     return;
   }
   LOG(ERROR) << "LevelDB remove failed: " << s.ToString();
   foreground_task_runner_->PostTask(FROM_HERE,
                                     base::Bind(callback,
                                                false,
                                                AppIdToMessageCountMap()));
 }
 
-void GCMStoreImpl::Backend::AddUserSerialNumber(
-    const std::string& username,
-    int64 serial_number,
-    const UpdateCallback& callback) {
-  DVLOG(1) << "Saving username to serial number mapping for user: " << username;
-  if (!db_.get()) {
-    LOG(ERROR) << "GCMStore db doesn't exist.";
-    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
-    return;
-  }
-  leveldb::WriteOptions write_options;
-  write_options.sync = true;
-
-  std::string key = MakeUserSerialNumberKey(username);
-  std::string serial_number_str = base::Int64ToString(serial_number);
-  const leveldb::Status status =
-      db_->Put(write_options,
-               MakeSlice(key),
-               MakeSlice(serial_number_str));
-  if (status.ok()) {
-    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, true));
-    return;
-  }
-  LOG(ERROR) << "LevelDB put failed: " << status.ToString();
-  foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
-}
-
-void GCMStoreImpl::Backend::RemoveUserSerialNumber(
-    const std::string& username,
-    const UpdateCallback& callback) {
-  if (!db_.get()) {
-    LOG(ERROR) << "GCMStore db doesn't exist.";
-    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
-    return;
-  }
-  leveldb::WriteOptions write_options;
-  write_options.sync = true;
-
-  leveldb::Status status = db_->Delete(write_options, MakeSlice(username));
-  if (status.ok()) {
-    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, true));
-    return;
-  }
-  LOG(ERROR) << "LevelDB remove failed: " << status.ToString();
-  foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
-}
-
-void GCMStoreImpl::Backend::SetNextSerialNumber(
-    int64 next_serial_number,
-    const UpdateCallback& callback) {
-  DVLOG(1) << "Updating the value of next user serial number to: "
-           << next_serial_number;
-  if (!db_.get()) {
-    LOG(ERROR) << "GCMStore db doesn't exist.";
-    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
-    return;
-  }
-  leveldb::WriteOptions write_options;
-  write_options.sync = true;
-
-  std::string serial_number_str = base::Int64ToString(next_serial_number);
-  const leveldb::Status status =
-      db_->Put(write_options,
-               MakeSlice(kNextSerialNumberKey),
-               MakeSlice(serial_number_str));
-  if (status.ok()) {
-    foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, true));
-    return;
-  }
-  LOG(ERROR) << "LevelDB put failed: " << status.ToString();
-  foreground_task_runner_->PostTask(FROM_HERE, base::Bind(callback, false));
-}
-
 bool GCMStoreImpl::Backend::LoadDeviceCredentials(uint64* android_id,
                                                   uint64* security_token) {
   leveldb::ReadOptions read_options;
   read_options.verify_checksums = true;
 
   std::string result;
   leveldb::Status s = db_->Get(read_options, MakeSlice(kDeviceAIDKey), &result);
   if (s.ok()) {
     if (!base::StringToUint64(result, android_id)) {
       LOG(ERROR) << "Failed to restore device id.";
@@ skipping 14 matching lines @@
 
   if (s.IsNotFound()) {
     DVLOG(1) << "No credentials found.";
     return true;
   }
 
   LOG(ERROR) << "Error reading credentials from store.";
   return false;
 }
 
+bool GCMStoreImpl::Backend::LoadRegistrations(
+    RegistrationInfoMap* registrations) {
+  leveldb::ReadOptions read_options;
+  read_options.verify_checksums = true;
+
+  scoped_ptr<leveldb::Iterator> iter(db_->NewIterator(read_options));
+  for (iter->Seek(MakeSlice(kRegistrationKeyStart));
+       iter->Valid() && iter->key().ToString() < kRegistrationKeyEnd;
+       iter->Next()) {
+    leveldb::Slice s = iter->value();
+    if (s.size() <= 1) {
+      LOG(ERROR) << "Error reading registration with key " << s.ToString();
+      return false;
+    }
+    std::string app_id = ParseRegistrationKey(iter->key().ToString());
+    linked_ptr<RegistrationInfo> registration(new RegistrationInfo);
+    if (!registration->ParseFromString(iter->value().ToString())) {
+      LOG(ERROR) << "Failed to parse registration with app id " << app_id;
+      return false;
+    }
+    DVLOG(1) << "Found registration with app id " << app_id;
+    (*registrations)[app_id] = registration;
+  }
+
+  return true;
+}
+
 bool GCMStoreImpl::Backend::LoadIncomingMessages(
     std::vector<std::string>* incoming_messages) {
   leveldb::ReadOptions read_options;
   read_options.verify_checksums = true;
 
   scoped_ptr<leveldb::Iterator> iter(db_->NewIterator(read_options));
   for (iter->Seek(MakeSlice(kIncomingMsgKeyStart));
        iter->Valid() && iter->key().ToString() < kIncomingMsgKeyEnd;
        iter->Next()) {
     leveldb::Slice s = iter->value();
@@ skipping 34 matching lines @@
       return false;
     }
     DVLOG(1) << "Found outgoing message with id " << id << " of type "
              << base::IntToString(tag);
     (*outgoing_messages)[id] = make_linked_ptr(message.release());
   }
 
   return true;
 }
 
-bool GCMStoreImpl::Backend::LoadNextSerialNumber(int64* next_serial_number) {
-  leveldb::ReadOptions read_options;
-  read_options.verify_checksums = true;
-
-  std::string result;
-  leveldb::Status status =
-      db_->Get(read_options, MakeSlice(kNextSerialNumberKey), &result);
-  if (status.ok()) {
-    if (!base::StringToInt64(result, next_serial_number)) {
-      LOG(ERROR) << "Failed to restore the next serial number.";
-      return false;
-    }
-    return true;
-  }
-
-  if (status.IsNotFound()) {
-    DVLOG(1) << "No next serial number found.";
-    return true;
-  }
-
-  LOG(ERROR) << "Error when reading the next serial number.";
-  return false;
-}
-
-bool GCMStoreImpl::Backend::LoadUserSerialNumberMap(
-    std::map<std::string, int64>* user_serial_number_map) {
-  leveldb::ReadOptions read_options;
-  read_options.verify_checksums = true;
-
-  scoped_ptr<leveldb::Iterator> iter(db_->NewIterator(read_options));
-  for (iter->Seek(MakeSlice(kUserSerialNumberKeyStart));
-       iter->Valid() && iter->key().ToString() < kUserSerialNumberKeyEnd;
-       iter->Next()) {
-    std::string username = ParseUsername(iter->key().ToString());
-    if (username.empty()) {
-      LOG(ERROR) << "Error reading username. It should not be empty.";
-      return false;
-    }
-    std::string serial_number_string = iter->value().ToString();
-    int64 serial_number = kSerialNumberMissing;
-    if (!base::StringToInt64(serial_number_string, &serial_number)) {
-      LOG(ERROR) << "Error reading user serial number for user: " << username;
-      return false;
-    }
-
-    (*user_serial_number_map)[username] = serial_number;
-  }
-
-  return true;
-}
-
 GCMStoreImpl::GCMStoreImpl(
     bool use_mock_keychain,
     const base::FilePath& path,
     scoped_refptr<base::SequencedTaskRunner> blocking_task_runner)
     : backend_(new Backend(path, base::MessageLoopProxy::current())),
       blocking_task_runner_(blocking_task_runner),
       weak_ptr_factory_(this) {
 // On OSX, prevent the Keychain permissions popup during unit tests.
 #if defined(OS_MACOSX)
   OSCrypt::UseMockKeychain(use_mock_keychain);
@@ skipping 29 matching lines @@
                                         const UpdateCallback& callback) {
   blocking_task_runner_->PostTask(
       FROM_HERE,
       base::Bind(&GCMStoreImpl::Backend::SetDeviceCredentials,
                  backend_,
                  device_android_id,
                  device_security_token,
                  callback));
 }
 
+void GCMStoreImpl::AddRegistration(
+    const std::string& app_id,
+    const linked_ptr<RegistrationInfo>& registration,
+    const UpdateCallback& callback) {
+  blocking_task_runner_->PostTask(
+      FROM_HERE,
+      base::Bind(&GCMStoreImpl::Backend::AddRegistration,
+                 backend_,
+                 app_id,
+                 registration,
+                 callback));
+}
+
+void GCMStoreImpl::RemoveRegistration(const std::string& app_id,
+                                          const UpdateCallback& callback) {
+  blocking_task_runner_->PostTask(
+      FROM_HERE,
+      base::Bind(&GCMStoreImpl::Backend::RemoveRegistration,
+                 backend_,
+                 app_id,
+                 callback));
+}
+
 void GCMStoreImpl::AddIncomingMessage(const std::string& persistent_id,
                                       const UpdateCallback& callback) {
   blocking_task_runner_->PostTask(
       FROM_HERE,
       base::Bind(&GCMStoreImpl::Backend::AddIncomingMessage,
                  backend_,
                  persistent_id,
                  callback));
 }
 
@@ skipping 82 matching lines @@
   blocking_task_runner_->PostTask(
       FROM_HERE,
       base::Bind(&GCMStoreImpl::Backend::RemoveOutgoingMessages,
                  backend_,
                  persistent_ids,
                  base::Bind(&GCMStoreImpl::RemoveOutgoingMessagesContinuation,
                             weak_ptr_factory_.GetWeakPtr(),
                             callback)));
 }
 
-void GCMStoreImpl::SetNextSerialNumber(int64 next_serial_number,
-                                       const UpdateCallback& callback) {
-  blocking_task_runner_->PostTask(
-      FROM_HERE,
-      base::Bind(&GCMStoreImpl::Backend::SetNextSerialNumber,
-                 backend_,
-                 next_serial_number,
-                 callback));
-}
-
-void GCMStoreImpl::AddUserSerialNumber(const std::string& username,
-                                       int64 serial_number,
-                                       const UpdateCallback& callback) {
-  blocking_task_runner_->PostTask(
-      FROM_HERE,
-      base::Bind(&GCMStoreImpl::Backend::AddUserSerialNumber,
-                 backend_,
-                 username,
-                 serial_number,
-                 callback));
-}
-
-void GCMStoreImpl::RemoveUserSerialNumber(const std::string& username,
-                                          const UpdateCallback& callback) {
-  blocking_task_runner_->PostTask(
-      FROM_HERE,
-      base::Bind(&GCMStoreImpl::Backend::RemoveUserSerialNumber,
-                 backend_,
-                 username,
-                 callback));
-}
-
 void GCMStoreImpl::LoadContinuation(const LoadCallback& callback,
                                     scoped_ptr<LoadResult> result) {
   if (!result->success) {
     callback.Run(result.Pass());
     return;
   }
   int num_throttled_apps = 0;
   for (OutgoingMessageMap::const_iterator
            iter = result->outgoing_messages.begin();
        iter != result->outgoing_messages.end(); ++iter) {
@@ skipping 34 matching lines @@
            removed_message_counts.begin();
        iter != removed_message_counts.end(); ++iter) {
     DCHECK_NE(app_message_counts_.count(iter->first), 0U);
     app_message_counts_[iter->first] -= iter->second;
     DCHECK_GE(app_message_counts_[iter->first], 0);
   }
   callback.Run(true);
 }
 
 }  // namespace gcm