Elide origins displayed on web notifications.

ui/message_center/notification.h

 // Copyright (c) 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.
 
 #ifndef UI_MESSAGE_CENTER_NOTIFICATION_H_
 #define UI_MESSAGE_CENTER_NOTIFICATION_H_
 
 #include <string>
 #include <vector>
 
 #include "base/strings/string16.h"
 #include "base/time/time.h"
 #include "base/values.h"
 #include "ui/gfx/image/image.h"
 #include "ui/message_center/message_center_export.h"
 #include "ui/message_center/notification_delegate.h"
 #include "ui/message_center/notification_types.h"
 #include "ui/message_center/notifier_settings.h"
+#include "url/gurl.h"
 
 namespace message_center {
 
 struct MESSAGE_CENTER_EXPORT NotificationItem {
   base::string16 title;
   base::string16 message;
 
   NotificationItem(const base::string16& title, const base::string16& message);
 };
 
 struct MESSAGE_CENTER_EXPORT ButtonInfo {
   base::string16 title;
   gfx::Image icon;
 
   ButtonInfo(const base::string16& title);
 };
 
+struct MESSAGE_CENTER_EXPORT ContextMessage {
+  ContextMessage(base::string16 msg, bool use_origin)
+      : message(msg), use_origin_as_context(use_origin) {}
+  base::string16 message;
+  bool use_origin_as_context;

[Jun Mukai, 2015/08/18 18:28:48]

I really want to eliminate this flag (and the struct), I want to keep
|context_message| as a simple string16 if possible.
So, question -- when is this flag required?  I mean, which notification wants to
have empty context_message but don't want to show the origin URL?

One thing I noticed is the extensions. So question here is how we can suppress
the context message for extensions?  A few ideas I have:
- specifying invisible text (whitespace, " ") in notification_api.cc: ugly, but
working well
- allowing only certain scheme origins (file, http, and https) for the context
message: special case rules isn't very preferable, but less ugly
- specifying meaningful default context message in notification_api.cc (the
extension's name): clean, but changes the UX

[Miguel Garcia, 2015/08/19 15:02:59]

Following our chat yesterday I implemented the change you suggested

So now we display the origin iff
- context_message is empty
- and origin_url is valid
- and origin_url is http or https

That should cover everything and I added tests to enforce this behavior.

PTAL

On 2015/08/18 18:28:48, Jun Mukai wrote:

+};
+
 class MESSAGE_CENTER_EXPORT RichNotificationData {
  public:
   RichNotificationData();
   RichNotificationData(const RichNotificationData& other);
   ~RichNotificationData();
 
   int priority;
   bool never_timeout;
   base::Time timestamp;
-  base::string16 context_message;
+  ContextMessage context_message;
   gfx::Image image;
   gfx::Image small_image;
   std::vector<NotificationItem> items;
   int progress;
   std::vector<ButtonInfo> buttons;
   bool should_make_spoken_feedback_for_popup_updates;
   bool clickable;
   std::vector<int> vibration_pattern;
   bool silent;
 };
 
 class MESSAGE_CENTER_EXPORT Notification {
  public:
   Notification(NotificationType type,
                const std::string& id,
                const base::string16& title,
                const base::string16& message,
                const gfx::Image& icon,
                const base::string16& display_source,
+               const GURL& origin_url,
                const NotifierId& notifier_id,
                const RichNotificationData& optional_fields,
                NotificationDelegate* delegate);
 
   Notification(const std::string& id, const Notification& other);
 
   Notification(const Notification& other);
 
   virtual ~Notification();
 
@@ skipping 10 matching lines @@
   // Use this id against the MessageCenter interface but not the
   // NotificationUIManager interface.
   const std::string& id() const { return id_; }
 
   const base::string16& title() const { return title_; }
   void set_title(const base::string16& title) { title_ = title; }
 
   const base::string16& message() const { return message_; }
   void set_message(const base::string16& message) { message_ = message; }
 
+  // The origin URL of the script which requested the notification.
+  // Can be empty if the notification is requested by an extension or
+  // Chrome app.
+  const GURL& origin_url() const { return origin_url_; }
+
   // A display string for the source of the notification.
   const base::string16& display_source() const { return display_source_; }
 
   const NotifierId& notifier_id() const { return notifier_id_; }
 
   void set_profile_id(const std::string& profile_id) {
     notifier_id_.profile_id = profile_id;
   }
 
   // Begin unpacked values from optional_fields.
@@ skipping 11 matching lines @@
 
   // This property currently has no effect on non-Android platforms.
   bool silent() const { return optional_fields_.silent; }
   void set_silent(bool silent) { optional_fields_.silent = silent; }
 
   base::Time timestamp() const { return optional_fields_.timestamp; }
   void set_timestamp(const base::Time& timestamp) {
     optional_fields_.timestamp = timestamp;
   }
 
-  const base::string16& context_message() const {
+  const ContextMessage context_message() const {
     return optional_fields_.context_message;
   }
-  void set_context_message(const base::string16& context_message) {
-    optional_fields_.context_message = context_message;
+
+  void set_context_message(const base::string16& context_message,
+                           bool use_origin_as_context) {
+    optional_fields_.context_message.message = context_message;
+    optional_fields_.context_message.use_origin_as_context =
+        use_origin_as_context;
   }
 
   const std::vector<NotificationItem>& items() const {
     return optional_fields_.items;
   }
   void set_items(const std::vector<NotificationItem>& items) {
     optional_fields_.items = items;
   }
 
   int progress() const { return optional_fields_.progress; }
@@ skipping 85 matching lines @@
   base::string16 message_;
 
   // Image data for the associated icon, used by Ash when available.
   gfx::Image icon_;
 
   // The display string for the source of the notification.  Could be
   // the same as origin_url_, or the name of an extension.
   base::string16 display_source_;
 
  private:
+  // The origin URL of the script which requested the notification.
+  // Can be empty if requested through a chrome app or extension or if
+  // it's a system notification.
+  GURL origin_url_;
   NotifierId notifier_id_;
   unsigned serial_number_;
   RichNotificationData optional_fields_;
   bool shown_as_popup_;  // True if this has been shown as a popup.
   bool is_read_;  // True if this has been seen in the message center.
 
   // A proxy object that allows access back to the JavaScript object that
   // represents the notification, for firing events.
   scoped_refptr<NotificationDelegate> delegate_;
 };
 
 }  // namespace message_center
 
 #endif  // UI_MESSAGE_CENTER_NOTIFICATION_H_