Widen Data Pipes and newer protobufs

chrome/browser/notifications/sync_notifier/synced_notification.cc

 // 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.
 
 #include "chrome/browser/notifications/sync_notifier/synced_notification.h"
 
 #include "sync/protocol/sync.pb.h"
 #include "sync/protocol/synced_notification_specifics.pb.h"
 
 namespace {
@@ skipping 15 matching lines @@
                sync_pb::CoalescedSyncedNotification_ReadState_DISMISSED,
                local_enum_must_match_protobuf_enum);
 
 SyncedNotification::SyncedNotification(const syncer::SyncData& sync_data) {
   Update(sync_data);
 }
 
 SyncedNotification::~SyncedNotification() {}
 
 void SyncedNotification::Update(const syncer::SyncData& sync_data) {
+  // TODO(petewil): Let's add checking that the notification looks valid.
   specifics_.CopyFrom(sync_data.GetSpecifics().synced_notification());
 }
 
 sync_pb::EntitySpecifics SyncedNotification::GetEntitySpecifics() const {
   sync_pb::EntitySpecifics entity_specifics;
   entity_specifics.mutable_synced_notification()->CopyFrom(specifics_);
   return entity_specifics;
 }
 
 std::string SyncedNotification::title() const {
@@ skipping 21 matching lines @@
 }
 
 GURL SyncedNotification::app_icon_url() const {
   return ExtractAppIconUrl();
 }
 
 GURL SyncedNotification::image_url() const {
   return ExtractImageUrl();
 }
 
-std::string SyncedNotification::first_external_id() const {
-  return ExtractFirstExternalId();
-}
-
-std::string SyncedNotification::notification_id() const {
-  return ExtractNotificationId();
-}
-
 std::string SyncedNotification::text() const {
   return ExtractText();
 }
 
 SyncedNotification::ReadState SyncedNotification::read_state() const {
   return ExtractReadState();
+

[dcheng, 2013/03/26 07:48:50]

Remove extra newline.

[Pete Williamson, 2013/03/26 17:18:30]

Done.

+}
+
+double SyncedNotification::creation_time() const {
+  return ExtractCreationTime();
+}
+
+std::string SyncedNotification::default_destination_title() const {
+  return ExtractDefaultDestinationTitle();
+}
+
+std::string SyncedNotification::default_destination_icon_url() const {
+  return ExtractDefaultDestinationIconUrl();
+}
+
+std::string SyncedNotification::default_destination_url() const {
+  return ExtractDefaultDestinationUrl();
+}
+
+std::string SyncedNotification::button_one_title() const {
+  return ExtractButtonOneTitle();
+}
+
+std::string SyncedNotification::button_one_icon_url() const {
+  return ExtractButtonOneIconUrl();
+}
+
+std::string SyncedNotification::button_one_url() const {
+  return ExtractButtonOneUrl();
+}
+
+std::string SyncedNotification::button_two_title() const {
+  return ExtractButtonTwoTitle();
+}
+
+std::string SyncedNotification::button_two_icon_url() const {
+  return ExtractButtonTwoIconUrl();
+}
+
+std::string SyncedNotification::button_two_url() const {
+  return ExtractButtonTwoUrl();
+}
+
+int SyncedNotification::priority() const {
+  return ExtractPriority();
+}
+
+int SyncedNotification::button_count() const {
+  return ExtractButtonCount();
+}
+
+int SyncedNotification::notification_count() const {
+  return ExtractNotificationCount();
+}
+
+std::string SyncedNotification::contained_notification_title(int index) const {
+  return ExtractContainedNotificationTitle(index);
+}
+
+std::string SyncedNotification::contained_notification_message(
+    int index) const {
+  return ExtractContainedNotificationMessage(index);
 }
 
 // TODO(petewil): Consider the timestamp too once it gets added to the protobuf.
+// TODO: add more fields in here
 bool SyncedNotification::EqualsIgnoringReadState(
     const SyncedNotification& other) const {
   return (title() == other.title() &&
           app_id() == other.app_id() &&
           key() == other.key() &&
           text() == other.text() &&
           origin_url() == other.origin_url() &&
           app_icon_url() == other.app_icon_url() &&
           image_url() == other.image_url() );
 }
 
-bool SyncedNotification::IdMatches(const SyncedNotification& other) const {
-  // Two notifications have the same ID if the <appId/coalescingKey> pair
-  // matches.
-  return (notification_id() == other.notification_id());
+bool SyncedNotification::KeyMatches(const SyncedNotification& other) const {
+  // Two notifications that have the same key match.
+  return (key() == other.key());
 }
 
 // Set the read state on the notification, returns true for success.
 void SyncedNotification::SetReadState(const ReadState& read_state) {
 
   // convert the read state to the protobuf type for read state
   if (kDismissed == read_state)
     specifics_.mutable_coalesced_notification()->set_read_state(
         sync_pb::CoalescedSyncedNotification_ReadState_DISMISSED);
   else if (kUnread == read_state)
     specifics_.mutable_coalesced_notification()->set_read_state(
         sync_pb::CoalescedSyncedNotification_ReadState_UNREAD);
   else if (kRead == read_state)
     specifics_.mutable_coalesced_notification()->set_read_state(
         sync_pb::CoalescedSyncedNotification_ReadState_READ);
   else
     NOTREACHED();
 }
 
-void SyncedNotification::NotificationHasBeenRead() {
-  SetReadState(kRead);
-}
-
 void SyncedNotification::NotificationHasBeenDismissed() {
   SetReadState(kDismissed);
 }
 
-std::string SyncedNotification::ExtractFirstExternalId() const {
-  if (!specifics_.has_coalesced_notification() ||
-      specifics_.coalesced_notification().notification_size() < 1 ||
-      !specifics_.coalesced_notification().notification(0).has_external_id())
-    return std::string();
-
-  return specifics_.coalesced_notification().notification(0).external_id();
-}
-
 std::string SyncedNotification::ExtractTitle() const {
   if (!specifics_.coalesced_notification().render_info().expanded_info().
       simple_expanded_layout().has_title())
-    return "";
+    return std::string();
 
   return specifics_.coalesced_notification().render_info().expanded_info().
       simple_expanded_layout().title();
 }
 
 std::string SyncedNotification::ExtractHeading() const {
   if (!specifics_.coalesced_notification().render_info().collapsed_info().
       simple_collapsed_layout().has_heading())
-    return "";
+    return std::string();
 
   return specifics_.coalesced_notification().render_info().collapsed_info().
       simple_collapsed_layout().heading();
 }
 
 std::string SyncedNotification::ExtractDescription() const {
   if (!specifics_.coalesced_notification().render_info().collapsed_info().
       simple_collapsed_layout().has_description())
-    return "";
+    return std::string();
 
   return specifics_.coalesced_notification().render_info().collapsed_info().
       simple_collapsed_layout().description();
 }
 
 std::string SyncedNotification::ExtractAppId() const {
   if (!specifics_.coalesced_notification().has_app_id())
-    return "";
+    return std::string();
   return specifics_.coalesced_notification().app_id();
 }
 
 std::string SyncedNotification::ExtractKey() const {
   if (!specifics_.coalesced_notification().has_key())
-    return "";
+    return std::string();
   return specifics_.coalesced_notification().key();
 }
 
 GURL SyncedNotification::ExtractOriginUrl() const {
   std::string origin_url(kExtensionScheme);
   origin_url += app_id();
   return GURL(origin_url);
 }
 
+// TODO(petewil): This only returns the first icon. We should make all the
+// icons available.
 GURL SyncedNotification::ExtractAppIconUrl() const {
   if (specifics_.coalesced_notification().render_info().expanded_info().
       collapsed_info_size() == 0)
     return GURL();
 
   if (!specifics_.coalesced_notification().render_info().expanded_info().
       collapsed_info(0).simple_collapsed_layout().has_app_icon())
     return GURL();
 
   return GURL(specifics_.coalesced_notification().render_info().
@@ skipping 12 matching lines @@
       simple_expanded_layout().media(0).image().has_url())
     return GURL();
 
   return GURL(specifics_.coalesced_notification().render_info().
               expanded_info().simple_expanded_layout().media(0).image().url());
 }
 
 std::string SyncedNotification::ExtractText() const {
   if (!specifics_.coalesced_notification().render_info().expanded_info().
       simple_expanded_layout().has_text())
-    return "";
+    return std::string();
 
   return specifics_.coalesced_notification().render_info().expanded_info().
       simple_expanded_layout().text();
 }
 
 SyncedNotification::ReadState SyncedNotification::ExtractReadState() const {
   DCHECK(specifics_.coalesced_notification().has_read_state());
 
   sync_pb::CoalescedSyncedNotification_ReadState found_read_state =
       specifics_.coalesced_notification().read_state();
 
   if (found_read_state ==
       sync_pb::CoalescedSyncedNotification_ReadState_DISMISSED) {
     return kDismissed;
   } else if (found_read_state ==
              sync_pb::CoalescedSyncedNotification_ReadState_UNREAD) {
     return kUnread;
   } else if (found_read_state ==
              sync_pb::CoalescedSyncedNotification_ReadState_READ) {
     return kRead;
   } else {
     NOTREACHED();
     return static_cast<SyncedNotification::ReadState>(found_read_state);
   }
 }
 
-std::string SyncedNotification::ExtractNotificationId() const {
-  return key();
+// Time in milliseconds since the unix epoch, or 0.0 if not available.
+double SyncedNotification::ExtractCreationTime() const {

[dcheng, 2013/03/26 07:48:50]

It'd probably be better to return a uint64 here for clarity. It's not clear why
a double is needed here (I assume it's because uint64's can't be directly passed
into JS through DictionaryValue, but that's not a detail that should be exposed
here).

[Pete Williamson, 2013/03/26 17:18:30]

Done.

+  uint64 creation_time_milliseconds;
+
+  if (!specifics_.coalesced_notification().has_creation_time_msec())
+    return 0.0;
+
+  creation_time_milliseconds = specifics_.coalesced_notification().
+      creation_time_msec();
+
+  return static_cast<double>(creation_time_milliseconds);
+}
+
+int SyncedNotification::ExtractPriority() const {
+  if (!specifics_.coalesced_notification().has_priority())
+    return 0;
+  return static_cast<int>(specifics_.coalesced_notification().
+                          priority());
+}
+
+int SyncedNotification::ExtractNotificationCount() const {
+  return specifics_.coalesced_notification().render_info().
+      expanded_info().collapsed_info_size();
+}
+
+int SyncedNotification::ExtractButtonCount() const {
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target_size();
+}
+
+std::string SyncedNotification::ExtractDefaultDestinationTitle() const {
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      default_destination().icon().has_alt_text()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      default_destination().icon().alt_text();
+}
+
+std::string SyncedNotification::ExtractDefaultDestinationIconUrl() const {
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      default_destination().icon().has_url()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      default_destination().icon().url();
+}
+
+std::string SyncedNotification::ExtractDefaultDestinationUrl() const {
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      default_destination().has_url()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      default_destination().url();
+}
+
+std::string SyncedNotification::ExtractButtonOneTitle() const {
+  // Must ensure that we have a target before trying to access it.
+  if (ExtractButtonCount() < 1)
+    return std::string();
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      target(0).action().icon().has_alt_text()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target(0).action().icon().alt_text();
+}
+
+std::string SyncedNotification::ExtractButtonOneIconUrl() const {
+  // Must ensure that we have a target before trying to access it.
+  if (ExtractButtonCount() < 1)
+    return std::string();
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      target(0).action().icon().has_url()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target(0).action().icon().url();
+}
+
+std::string SyncedNotification::ExtractButtonOneUrl() const {
+  // Must ensure that we have a target before trying to access it.
+  if (ExtractButtonCount() < 1)
+    return std::string();
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      target(0).action().has_url()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target(0).action().url();
+}
+
+std::string SyncedNotification::ExtractButtonTwoTitle() const {
+  // Must ensure that we have a target before trying to access it.
+  if (ExtractButtonCount() < 2)
+    return std::string();
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      target(1).action().icon().has_alt_text()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target(1).action().icon().alt_text();
+}
+
+std::string SyncedNotification::ExtractButtonTwoIconUrl() const {
+  // Must ensure that we have a target before trying to access it.
+  if (ExtractButtonCount() < 2)
+    return std::string();
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      target(1).action().icon().has_url()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target(1).action().icon().url();
+}
+
+std::string SyncedNotification::ExtractButtonTwoUrl() const {
+  // Must ensure that we have a target before trying to access it.
+  if (ExtractButtonCount() < 2)
+    return std::string();
+  if (!specifics_.coalesced_notification().render_info().collapsed_info().
+      target(1).action().has_url()) {
+    return std::string();
+  }
+  return specifics_.coalesced_notification().render_info().collapsed_info().
+      target(1).action().url();
+}
+
+std::string SyncedNotification::ExtractContainedNotificationTitle(
+    int index) const {
+  if (specifics_.coalesced_notification().render_info().expanded_info().
+      collapsed_info_size() < index + 1)
+    return std::string();
+
+  return specifics_.coalesced_notification().render_info().expanded_info().
+      collapsed_info(index).simple_collapsed_layout().heading();
+}
+
+std::string SyncedNotification::ExtractContainedNotificationMessage(
+    int index) const {
+  if (specifics_.coalesced_notification().render_info().expanded_info().
+      collapsed_info_size() < index + 1)
+    return std::string();
+
+  return specifics_.coalesced_notification().render_info().expanded_info().
+      collapsed_info(index).simple_collapsed_layout().description();
 }
 
 }  // namespace notifier