Push API: Include origin in generated app_ids

chrome/browser/push_messaging/push_messaging_app_identifier.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 "chrome/browser/push_messaging/push_messaging_app_identifier.h"
 
+#include <string.h>

[Peter Beverloo, 2015/05/14 11:26:29]

<vector>?

[johnme, 2015/05/14 13:18:20]

push_messaging_app_identifier.h already includes <vector>.

+
 #include "base/guid.h"
 #include "base/logging.h"
 #include "base/prefs/pref_service.h"
 #include "base/prefs/scoped_user_pref_update.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_split.h"
 #include "base/strings/string_util.h"
 #include "base/values.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/pref_names.h"
 #include "components/pref_registry/pref_registry_syncable.h"
 
 namespace {
+
 const char kSeparator = '#';  // Ok as only the origin of the url is used.
+const int kGuidLength = 36;  // "%08X-%04X-%04X-%04X-%012llX"
+
+std::string MakePrefValue(const GURL& origin,
+                          int64_t service_worker_registration_id) {
+  return origin.spec() + kSeparator
+                       + base::Int64ToString(service_worker_registration_id);
+}
+
+bool GetOriginAndSWRFromPrefValue(
+    const std::string& pref_value, GURL* origin,
+    int64_t* service_worker_registration_id) {
+  std::vector<std::string> parts;
+  base::SplitString(pref_value, kSeparator, &parts);
+  if (parts.size() != 2)
+    return false;
+
+  if (!base::StringToInt64(parts[1], service_worker_registration_id))
+    return false;
+
+  *origin = GURL(parts[0]);

[Peter Beverloo, 2015/05/14 11:26:29]

Do we need to validate here that the origin is valid and return FALSE if it
isn't?

[johnme, 2015/05/14 13:18:20]

Done.

+
+  return true;
+}
+
 }  // namespace
 
 const char kPushMessagingAppIdentifierPrefix[] = "wp:";
 
 // static
 void PushMessagingAppIdentifier::RegisterProfilePrefs(
     user_prefs::PrefRegistrySyncable* registry) {
   registry->RegisterDictionaryPref(prefs::kPushMessagingAppIdentifierMap);
 }
 
 // static
 PushMessagingAppIdentifier PushMessagingAppIdentifier::Generate(
     const GURL& origin, int64_t service_worker_registration_id)
 {
   std::string guid = base::GenerateGUID();
   CHECK(!guid.empty());
-  std::string app_id = kPushMessagingAppIdentifierPrefix + guid;
+  std::string app_id = kPushMessagingAppIdentifierPrefix + origin.spec()
+                     + kSeparator + guid;
 
   PushMessagingAppIdentifier app_identifier(app_id, origin,
                                             service_worker_registration_id);
   app_identifier.DCheckValid();
   return app_identifier;
 }
 
 // static
-PushMessagingAppIdentifier PushMessagingAppIdentifier::Get(
+PushMessagingAppIdentifier PushMessagingAppIdentifier::FindByAppId(
     Profile* profile, const std::string& app_id) {
-  // Workaround crbug.com/461867 in GCM where it converts subtypes to lowercase.

[Peter Beverloo, 2015/05/14 11:26:29]

Please add 461867 to the BUG= line. Should we DCHECK on casing to make sure that
we get *some* information if this goes wrong again, given that it is external
input?

[johnme, 2015/05/14 13:18:20]

Done. I factored out a DCheckAppIdValid method from DCheckValid, incorporated a
case check into that, and call it from here.

-  // TODO(johnme): Remove this when obsolete
-  const size_t prefix_len = strlen(kPushMessagingAppIdentifierPrefix);
-  if (app_id.size() < prefix_len)
-    return PushMessagingAppIdentifier();
-  std::string uppercase_app_id =
-      app_id.substr(0, prefix_len) +
-      StringToUpperASCII(app_id.substr(prefix_len, std::string::npos));
-
   const base::DictionaryValue* map =
       profile->GetPrefs()->GetDictionary(prefs::kPushMessagingAppIdentifierMap);
 
-  std::string origin_and_sw_id;
-  if (!map->GetStringWithoutPathExpansion(uppercase_app_id, &origin_and_sw_id))
+  std::string map_value;
+  if (!map->GetStringWithoutPathExpansion(app_id, &map_value))
     return PushMessagingAppIdentifier();
 
-  std::vector<std::string> parts;
-  base::SplitString(origin_and_sw_id, kSeparator, &parts);
-  if (parts.size() != 2)
+  GURL origin;
+  int64_t service_worker_registration_id;
+  if (!GetOriginAndSWRFromPrefValue(map_value, &origin,
+                                    &service_worker_registration_id)) {
+    NOTREACHED();
     return PushMessagingAppIdentifier();
+  }
 
-  GURL origin = GURL(parts[0]);
-
-  int64_t service_worker_registration_id;
-  if (!base::StringToInt64(parts[1], &service_worker_registration_id))
-    return PushMessagingAppIdentifier();
-
-  PushMessagingAppIdentifier app_identifier(uppercase_app_id, origin,
+  PushMessagingAppIdentifier app_identifier(app_id, origin,
                                             service_worker_registration_id);
   app_identifier.DCheckValid();
   return app_identifier;
 }
 
 // static
-PushMessagingAppIdentifier PushMessagingAppIdentifier::Get(
+PushMessagingAppIdentifier PushMessagingAppIdentifier::FindByServiceWorker(
     Profile* profile, const GURL& origin,
     int64_t service_worker_registration_id)
 {
-  base::StringValue origin_and_sw_id = base::StringValue(origin.spec() +
-      kSeparator + base::Int64ToString(service_worker_registration_id));
+  const base::StringValue pref_value =
+      base::StringValue(MakePrefValue(origin, service_worker_registration_id));
 
   const base::DictionaryValue* map =
       profile->GetPrefs()->GetDictionary(prefs::kPushMessagingAppIdentifierMap);
   for (auto it = base::DictionaryValue::Iterator(*map); !it.IsAtEnd();
        it.Advance()) {
-    if (it.value().Equals(&origin_and_sw_id))
-      return Get(profile, it.key());
+    if (it.value().Equals(&pref_value))
+      return FindByAppId(profile, it.key());
   }
   return PushMessagingAppIdentifier();
 }
 
 // static
 std::vector<PushMessagingAppIdentifier> PushMessagingAppIdentifier::GetAll(
     Profile* profile) {
   std::vector<PushMessagingAppIdentifier> result;
 
   const base::DictionaryValue* map =
       profile->GetPrefs()->GetDictionary(prefs::kPushMessagingAppIdentifierMap);
   for (auto it = base::DictionaryValue::Iterator(*map); !it.IsAtEnd();
        it.Advance()) {
-    result.push_back(Get(profile, it.key()));
+    result.push_back(FindByAppId(profile, it.key()));
   }
 
   return result;
 }
 
 PushMessagingAppIdentifier::PushMessagingAppIdentifier()
     : origin_(GURL::EmptyGURL()),
       service_worker_registration_id_(-1) {
 }
 
@@ skipping 11 matching lines @@
 
 void PushMessagingAppIdentifier::PersistToPrefs(Profile* profile) const {
   DCheckValid();
 
   DictionaryPrefUpdate update(profile->GetPrefs(),
                               prefs::kPushMessagingAppIdentifierMap);
   base::DictionaryValue* map = update.Get();
 
   // Delete any stale entry with the same origin and Service Worker
   // registration id (hence we ensure there is a 1:1 not 1:many mapping).
-  PushMessagingAppIdentifier old = Get(profile, origin_,
-                                       service_worker_registration_id_);
+  PushMessagingAppIdentifier old = FindByServiceWorker(
+      profile, origin_, service_worker_registration_id_);
   if (!old.is_null())
-    map->RemoveWithoutPathExpansion(old.app_id_, nullptr);
+    map->RemoveWithoutPathExpansion(old.app_id_, nullptr /* out_value */);
 
-  std::string origin_and_sw_id = origin_.spec() + kSeparator +
-      base::Int64ToString(service_worker_registration_id_);
-  map->SetStringWithoutPathExpansion(app_id_, origin_and_sw_id);
+  map->SetStringWithoutPathExpansion(
+      app_id_, MakePrefValue(origin_, service_worker_registration_id_));
 }
 
 void PushMessagingAppIdentifier::DeleteFromPrefs(Profile* profile) const {
   DCheckValid();
 
   DictionaryPrefUpdate update(profile->GetPrefs(),
                               prefs::kPushMessagingAppIdentifierMap);
   base::DictionaryValue* map = update.Get();
-  map->RemoveWithoutPathExpansion(app_id_, nullptr);
+  map->RemoveWithoutPathExpansion(app_id_, nullptr /* out_value */);
 }
 
 void PushMessagingAppIdentifier::DCheckValid() const {
-  const size_t prefix_len = strlen(kPushMessagingAppIdentifierPrefix);
   DCHECK_GE(service_worker_registration_id_, 0);
+
   DCHECK(origin_.is_valid());
   DCHECK_EQ(origin_.GetOrigin(), origin_);
+
+  // "wp:"
+  const size_t prefix_len = strlen(kPushMessagingAppIdentifierPrefix);
   DCHECK_EQ(app_id_.substr(0, prefix_len), kPushMessagingAppIdentifierPrefix);
-  DCHECK(base::IsValidGUID(app_id_.substr(prefix_len, std::string::npos)));
+  // Optional (origin.spec() + '#')
+  if (app_id_.size() != prefix_len + kGuidLength) {
+    const size_t suffix_len = 1 /* kSeparator */ + kGuidLength;
+    DCHECK(app_id_.size() > prefix_len + suffix_len);
+    DCHECK_EQ(origin_,
+              GURL(app_id_.substr(prefix_len,
+                                  app_id_.size() - prefix_len - suffix_len)));
+    DCHECK_EQ(std::string(1, kSeparator),
+              app_id_.substr(app_id_.size() - suffix_len, 1));
+  }
+  // GUID
+  DCHECK(base::IsValidGUID(app_id_.substr(app_id_.size() - kGuidLength)));
 }