From 5263a4c4c9bef5e53e13042ba764e75bdae95d3f Mon Sep 17 00:00:00 2001
From: Paul Rouget <me@paulrouget.com>
Date: Thu, 12 Nov 2015 12:10:22 +0100
Subject: [PATCH] [Browser API] implement mozbrowsericonchange event

---
 components/msg/constellation_msg.rs           | 15 +-----
 components/script/dom/htmliframeelement.rs    | 45 ++++++++++++++--
 components/script/dom/htmllinkelement.rs      | 33 +++++++++---
 .../script/dom/webidls/BrowserElement.webidl  |  6 +++
 tests/wpt/mozilla/meta/MANIFEST.json          |  6 +++
 .../meta/mozilla/mozbrowser/__dir__.ini       |  1 +
 .../mozbrowsericonchange_event.html           | 51 +++++++++++++++++++
 .../mozbrowsericonchange_event_test.html      | 22 ++++++++
 8 files changed, 154 insertions(+), 25 deletions(-)
 create mode 100644 tests/wpt/mozilla/meta/mozilla/mozbrowser/__dir__.ini
 create mode 100644 tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event.html
 create mode 100644 tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event_test.html

diff --git a/components/msg/constellation_msg.rs b/components/msg/constellation_msg.rs
index 26fcb842d0e..009016e1433 100644
--- a/components/msg/constellation_msg.rs
+++ b/components/msg/constellation_msg.rs
@@ -313,7 +313,7 @@ pub enum MozBrowserEvent {
     /// Sent when an error occurred while trying to load content within a browser `<iframe>`.
     Error,
     /// Sent when the favicon of a browser `<iframe>` changes.
-    IconChange,
+    IconChange(String, String, String),
     /// Sent when the browser `<iframe>` has finished loading all its assets.
     LoadEnd,
     /// Sent when the browser `<iframe>` starts to load a new page.
@@ -341,7 +341,7 @@ impl MozBrowserEvent {
             MozBrowserEvent::Close => "mozbrowserclose",
             MozBrowserEvent::ContextMenu => "mozbrowsercontextmenu",
             MozBrowserEvent::Error => "mozbrowsererror",
-            MozBrowserEvent::IconChange => "mozbrowsericonchange",
+            MozBrowserEvent::IconChange(_, _, _) => "mozbrowsericonchange",
             MozBrowserEvent::LoadEnd => "mozbrowserloadend",
             MozBrowserEvent::LoadStart => "mozbrowserloadstart",
             MozBrowserEvent::LocationChange(_) => "mozbrowserlocationchange",
@@ -353,17 +353,6 @@ impl MozBrowserEvent {
             MozBrowserEvent::OpenSearch => "mozbrowseropensearch"
         }
     }
-    pub fn detail(&self) -> Option<String> {
-        match *self {
-            MozBrowserEvent::AsyncScroll | MozBrowserEvent::Close | MozBrowserEvent::ContextMenu |
-            MozBrowserEvent::Error | MozBrowserEvent::IconChange | MozBrowserEvent::LoadEnd |
-            MozBrowserEvent::LoadStart | MozBrowserEvent::OpenWindow | MozBrowserEvent::SecurityChange |
-            MozBrowserEvent::ShowModalPrompt | MozBrowserEvent::UsernameAndPasswordRequired |
-            MozBrowserEvent::OpenSearch => None,
-            MozBrowserEvent::LocationChange(ref new_location) => Some(new_location.clone()),
-            MozBrowserEvent::TitleChange(ref new_title) => Some(new_title.clone()),
-        }
-    }
 }
 
 #[derive(Deserialize, Serialize)]
diff --git a/components/script/dom/htmliframeelement.rs b/components/script/dom/htmliframeelement.rs
index 2281c9e371f..edb45fbb14b 100644
--- a/components/script/dom/htmliframeelement.rs
+++ b/components/script/dom/htmliframeelement.rs
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 use dom::attr::{Attr, AttrValue};
+use dom::bindings::codegen::Bindings::BrowserElementBinding::BrowserElementIconChangeEventDetail;
 use dom::bindings::codegen::Bindings::HTMLIFrameElementBinding;
 use dom::bindings::codegen::Bindings::HTMLIFrameElementBinding::HTMLIFrameElementMethods;
 use dom::bindings::codegen::Bindings::WindowBinding::WindowMethods;
@@ -21,8 +22,8 @@ use dom::node::{Node, window_from_node};
 use dom::urlhelper::UrlHelper;
 use dom::virtualmethods::VirtualMethods;
 use dom::window::Window;
-use js::jsapi::{JSAutoCompartment, JSAutoRequest, RootedValue};
-use js::jsval::UndefinedValue;
+use js::jsapi::{JSAutoCompartment, JSAutoRequest, RootedValue, JSContext, MutableHandleValue};
+use js::jsval::{UndefinedValue, NullValue};
 use msg::constellation_msg::IFrameSandboxState::{IFrameSandboxed, IFrameUnsandboxed};
 use msg::constellation_msg::Msg as ConstellationMsg;
 use msg::constellation_msg::{ConstellationChan, IframeLoadInfo, MozBrowserEvent};
@@ -143,9 +144,10 @@ impl HTMLIFrameElement {
                 let _ar = JSAutoRequest::new(cx);
                 let _ac = JSAutoCompartment::new(cx, window.reflector().get_jsobject().get());
                 let mut detail = RootedValue::new(cx, UndefinedValue());
-                event.detail().to_jsval(cx, detail.handle_mut());
+                let event_name = DOMString::from(event.name().to_owned());
+                self.build_mozbrowser_event_detail(event, cx, detail.handle_mut());
                 CustomEvent::new(GlobalRef::Window(window.r()),
-                                 DOMString::from(event.name()),
+                                 event_name,
                                  true,
                                  true,
                                  detail.handle())
@@ -225,6 +227,41 @@ impl HTMLIFrameElementLayoutMethods for LayoutJS<HTMLIFrameElement> {
     }
 }
 
+pub trait MozBrowserEventDetailBuilder {
+    #[allow(unsafe_code)]
+    unsafe fn build_mozbrowser_event_detail(&self,
+                                            event: MozBrowserEvent,
+                                            cx: *mut JSContext,
+                                            rval: MutableHandleValue);
+}
+
+impl MozBrowserEventDetailBuilder for HTMLIFrameElement {
+    #[allow(unsafe_code)]
+    unsafe fn build_mozbrowser_event_detail(&self,
+                                            event: MozBrowserEvent,
+                                            cx: *mut JSContext,
+                                            rval: MutableHandleValue) {
+        match event {
+            MozBrowserEvent::AsyncScroll | MozBrowserEvent::Close | MozBrowserEvent::ContextMenu |
+            MozBrowserEvent::Error | MozBrowserEvent::LoadEnd | MozBrowserEvent::LoadStart |
+            MozBrowserEvent::OpenWindow | MozBrowserEvent::SecurityChange | MozBrowserEvent::OpenSearch  |
+            MozBrowserEvent::ShowModalPrompt | MozBrowserEvent::UsernameAndPasswordRequired => {
+                rval.set(NullValue());
+            }
+            MozBrowserEvent::LocationChange(ref string) | MozBrowserEvent::TitleChange(ref string) => {
+                string.to_jsval(cx, rval);
+            }
+            MozBrowserEvent::IconChange(rel, href, sizes) => {
+                BrowserElementIconChangeEventDetail {
+                    rel: Some(DOMString::from(rel)),
+                    href: Some(DOMString::from(href)),
+                    sizes: Some(DOMString::from(sizes)),
+                }.to_jsval(cx, rval);
+            }
+        }
+    }
+}
+
 pub fn Navigate(iframe: &HTMLIFrameElement, direction: NavigationDirection) -> Fallible<()> {
     if iframe.Mozbrowser() {
         if iframe.upcast::<Node>().is_in_doc() {
diff --git a/components/script/dom/htmllinkelement.rs b/components/script/dom/htmllinkelement.rs
index 2860c98dd5c..c9bf7815e49 100644
--- a/components/script/dom/htmllinkelement.rs
+++ b/components/script/dom/htmllinkelement.rs
@@ -24,8 +24,8 @@ use encoding::all::UTF_8;
 use ipc_channel::ipc;
 use ipc_channel::router::ROUTER;
 use layout_interface::{LayoutChan, Msg};
-use msg::constellation_msg::ConstellationChan;
 use msg::constellation_msg::Msg as ConstellationMsg;
+use msg::constellation_msg::{ConstellationChan, MozBrowserEvent};
 use net_traits::{AsyncResponseListener, AsyncResponseTarget, Metadata};
 use network_listener::{NetworkListener, PreInvoke};
 use std::ascii::AsciiExt;
@@ -102,7 +102,7 @@ fn is_favicon(value: &Option<String>) -> bool {
     match *value {
         Some(ref value) => {
             value.split(HTML_SPACE_CHARACTERS)
-                .any(|s| s.eq_ignore_ascii_case("icon"))
+                .any(|s| s.eq_ignore_ascii_case("icon") || s.eq_ignore_ascii_case("apple-touch-icon"))
         },
         None => false,
     }
@@ -118,13 +118,23 @@ impl VirtualMethods for HTMLLinkElement {
         if !self.upcast::<Node>().is_in_doc() || mutation == AttributeMutation::Removed {
             return;
         }
+
+        let sizes_atom = &Atom::from_slice("sizes");
         let rel = get_attr(self.upcast(), &atom!(rel));
         match attr.local_name() {
             &atom!(href) => {
                 if string_is_stylesheet(&rel) {
                     self.handle_stylesheet_url(&attr.value());
                 } else if is_favicon(&rel) {
-                    self.handle_favicon_url(&attr.value());
+                    let sizes = get_attr(self.upcast(), sizes_atom);
+                    self.handle_favicon_url(rel.as_ref().unwrap(), &attr.value(), &sizes);
+                }
+            },
+            atom if atom == sizes_atom => {
+                if is_favicon(&rel) {
+                    if let Some(ref href) = get_attr(self.upcast(), &atom!("href")) {
+                        self.handle_favicon_url(rel.as_ref().unwrap(), href, &Some(attr.value().to_string()));
+                    }
                 }
             },
             &atom!(media) => {
@@ -153,13 +163,14 @@ impl VirtualMethods for HTMLLinkElement {
 
             let rel = get_attr(element, &atom!("rel"));
             let href = get_attr(element, &atom!("href"));
+            let sizes = get_attr(self.upcast(), &Atom::from_slice("sizes"));
 
-            match (rel, href) {
-                (ref rel, Some(ref href)) if string_is_stylesheet(rel) => {
+            match href {
+                Some(ref href) if string_is_stylesheet(&rel) => {
                     self.handle_stylesheet_url(href);
                 }
-                (ref rel, Some(ref href)) if is_favicon(rel) => {
-                    self.handle_favicon_url(href);
+                Some(ref href) if is_favicon(&rel) => {
+                    self.handle_favicon_url(rel.as_ref().unwrap(), href, &sizes);
                 }
                 _ => {}
             }
@@ -219,7 +230,7 @@ impl HTMLLinkElement {
         }
     }
 
-    fn handle_favicon_url(&self, href: &str) {
+    fn handle_favicon_url(&self, rel: &str, href: &str, sizes: &Option<String>) {
         let window = window_from_node(self);
         let window = window.r();
         match UrlParser::new().base_url(&window.get_url()).parse(href) {
@@ -227,6 +238,12 @@ impl HTMLLinkElement {
                 let ConstellationChan(ref chan) = window.constellation_chan();
                 let event = ConstellationMsg::NewFavicon(url.clone());
                 chan.send(event).unwrap();
+
+                let mozbrowser_event = match *sizes {
+                    Some(ref sizes) => MozBrowserEvent::IconChange(rel.to_owned(), url.to_string(), sizes.to_owned()),
+                    None => MozBrowserEvent::IconChange(rel.to_owned(), url.to_string(), "".to_owned())
+                };
+                window.Document().trigger_mozbrowser_event(mozbrowser_event);
             }
             Err(e) => debug!("Parsing url {} failed: {}", href, e)
         }
diff --git a/components/script/dom/webidls/BrowserElement.webidl b/components/script/dom/webidls/BrowserElement.webidl
index 6b4e9a8cf04..2ba6ceb1a01 100644
--- a/components/script/dom/webidls/BrowserElement.webidl
+++ b/components/script/dom/webidls/BrowserElement.webidl
@@ -24,6 +24,12 @@ callback BrowserElementNextPaintEventCallback = void ();
 interface BrowserElement {
 };
 
+dictionary BrowserElementIconChangeEventDetail {
+  DOMString rel;
+  DOMString href;
+  DOMString sizes;
+};
+
 BrowserElement implements BrowserElementCommon;
 BrowserElement implements BrowserElementPrivileged;
 
diff --git a/tests/wpt/mozilla/meta/MANIFEST.json b/tests/wpt/mozilla/meta/MANIFEST.json
index 40aabbdb3f6..8e2c6bc9065 100644
--- a/tests/wpt/mozilla/meta/MANIFEST.json
+++ b/tests/wpt/mozilla/meta/MANIFEST.json
@@ -5009,6 +5009,12 @@
             "url": "/_mozilla/mozilla/load_event.html"
           }
         ],
+        "mozilla/mozbrowser/mozbrowsericonchange_event.html": [
+          {
+            "path": "mozilla/mozbrowser/mozbrowsericonchange_event.html",
+            "url": "/_mozilla/mozilla/mozbrowser/mozbrowsericonchange_event.html"
+          }
+        ],
         "mozilla/navigator.html": [
           {
             "path": "mozilla/navigator.html",
diff --git a/tests/wpt/mozilla/meta/mozilla/mozbrowser/__dir__.ini b/tests/wpt/mozilla/meta/mozilla/mozbrowser/__dir__.ini
new file mode 100644
index 00000000000..6a4996ca794
--- /dev/null
+++ b/tests/wpt/mozilla/meta/mozilla/mozbrowser/__dir__.ini
@@ -0,0 +1 @@
+prefs: ["dom.mozbrowser.enabled:true"]
diff --git a/tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event.html b/tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event.html
new file mode 100644
index 00000000000..eea0b431928
--- /dev/null
+++ b/tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event.html
@@ -0,0 +1,51 @@
+<head>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+</head>
+<body>
+<script>
+
+async_test(function(t) {
+
+  var expectedEvents = [
+    {rel: "icon", href: "http://web-platform.test:8000/test1.ico", sizes: "any"},
+    {rel: "icon", href: "http://web-platform.test:8000/_mozilla/mozilla/mozbrowser/test2.ico", sizes: "16x16 24x24"},
+    {rel: "shortcut icon", href: "http://example.com/test3.ico", sizes: ""},
+    {rel: "apple-touch-icon", href: "http://web-platform.test:8000/test4.ico", sizes: ""},
+    {rel: "icon", href: "http://web-platform.test:8000/test5.ico", sizes: ""},
+    {rel: "icon", href: "http://web-platform.test:8000/test6.ico", sizes: "any"},
+    {rel: "icon", href: "http://web-platform.test:8000/test6.ico", sizes: "32x32"},
+  ];
+
+  var receivedEvents = [];
+
+  var iframe = document.createElement("iframe");
+  iframe.mozbrowser = "true";
+  iframe.src = "mozbrowsericonchange_event_test.html";
+
+  iframe.addEventListener("mozbrowsericonchange", t.step_func(e => {
+
+    receivedEvents.push({
+      rel: e.detail.rel,
+      href: e.detail.href,
+      sizes: e.detail.sizes,
+    });
+
+    if (receivedEvents.length == expectedEvents.length) {
+      for (var i = 0; i < expectedEvents.length; i++) {
+        var e1 = expectedEvents[i];
+        var e2 = receivedEvents[i];
+        assert_equals(e1.rel, e2.rel);
+        assert_equals(e1.href, e2.href);
+        assert_equals(e1.sizes, e2.sizes);
+      }
+      t.done();
+    }
+  }));
+
+
+  document.body.appendChild(iframe);
+});
+
+</script>
+</body>
diff --git a/tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event_test.html b/tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event_test.html
new file mode 100644
index 00000000000..6693605e1e8
--- /dev/null
+++ b/tests/wpt/mozilla/tests/mozilla/mozbrowser/mozbrowsericonchange_event_test.html
@@ -0,0 +1,22 @@
+<html>
+  <head>
+    <link rel="icon" href="/test1.ico" sizes="any">
+    <link rel="icon" href="./test2.ico" sizes="16x16 24x24">
+    <link rel="shortcut icon" href="http://example.com/test3.ico">
+    <link rel="not-icon" href="xxx">
+    <link rel="icon no-href">
+    <link rel="apple-touch-icon" href="/test4.ico">
+    <script>
+      setTimeout(function() {
+        var link = document.createElement("link");
+        link.rel = "icon";
+        link.href = "/test5.ico"
+        document.head.appendChild(link);
+        link = document.querySelector('link[href="/test1.ico"]');
+        link.href = "/test6.ico";
+        setTimeout(() => link.setAttribute("sizes", "32x32"), 0);
+      }, 0);
+    </script>
+  </head>
+  <body>123</body>
+</html>