include.preload.js - Issue 5666188336037888: Issue 581 - Fixed element hiding/collapsing in anonymous frames on Chrome

Side by Side Diff: include.preload.js

Issue 5666188336037888: Issue 581 - Fixed element hiding/collapsing in anonymous frames on Chrome (Closed)

Patch Set: Handle Chrome 37+ where this issue has been addressed Created June 2, 2014, 10:22 a.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

View unified diff | Download patch

OLD	NEW
1 /*	1 /*

2 * This file is part of Adblock Plus <http://adblockplus.org/>,	2 * This file is part of Adblock Plus <http://adblockplus.org/>,

3 * Copyright (C) 2006-2014 Eyeo GmbH	3 * Copyright (C) 2006-2014 Eyeo GmbH

4 *	4 *

5 * Adblock Plus is free software: you can redistribute it and/or modify	5 * Adblock Plus is free software: you can redistribute it and/or modify

6 * it under the terms of the GNU General Public License version 3 as	6 * it under the terms of the GNU General Public License version 3 as

7 * published by the Free Software Foundation.	7 * published by the Free Software Foundation.

8 *	8 *

9 * Adblock Plus is distributed in the hope that it will be useful,	9 * Adblock Plus is distributed in the hope that it will be useful,

10 * but WITHOUT ANY WARRANTY; without even the implied warranty of	10 * but WITHOUT ANY WARRANTY; without even the implied warranty of

11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

12 * GNU General Public License for more details.	12 * GNU General Public License for more details.

13 *	13 *

14 * You should have received a copy of the GNU General Public License	14 * You should have received a copy of the GNU General Public License

15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>.	15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>.

16 */	16 */

17	17

18 var SELECTOR_GROUP_SIZE = 20;	18 var SELECTOR_GROUP_SIZE = 20;

19	19

20 // use Shadow DOM if available to don't mess with web pages that

21 // rely on the order of their own <style> tags. However

22 // the <shadow> element is broken in some Chrome 32 builds (#309)

23 //

24 // also Chrome 31-33 crashes in some situations on some pages when using

25 // ShadowDOM, e.g. when pressing tab key on Wikipedia and Facebook (#498)

26 //

27 // also we must not create the shadow root in the response callback passed

28 // to sendMessage(), otherwise Chrome breaks some websites (#450)

29 var shadow = null;

30 if ("webkitCreateShadowRoot" in document.documentElement && !/\bChrome\/3[1-3]\b /.test(navigator.userAgent))

31 {

32 shadow = document.documentElement.webkitCreateShadowRoot();

33 shadow.appendChild(document.createElement("shadow"));

34 }

35

36 // Sets the currently used CSS rules for elemhide filters

37 function setElemhideCSSRules(selectors)

38 {

39 if (selectors.length == 0)

40 return;

41

42 var style = document.createElement("style");

43 style.setAttribute("type", "text/css");

44

45 if (shadow)

46 {

47 shadow.appendChild(style);

48

49 try

50 {

51 document.querySelector("::content");

52

53 for (var i = 0; i < selectors.length; i++)

54 selectors[i] = "::content " + selectors[i];

55 }

56 catch (e)

57 {

58 for (var i = 0; i < selectors.length; i++)

59 selectors[i] = "::-webkit-distributed(" + selectors[i] + ")";

60 }

61 }

62 else

63 {

64 // Try to insert the style into the <head> tag, inserting directly under the

65 // document root breaks dev tools functionality:

66 // http://code.google.com/p/chromium/issues/detail?id=178109

67 (document.head \|\| document.documentElement).appendChild(style);

68 }

69

70 // WebKit apparently chokes when the selector list in a CSS rule is huge.

71 // So we split the elemhide selectors into groups.

72 for (var i = 0; selectors.length > 0; i++)

73 {

74 var selector = selectors.splice(0, SELECTOR_GROUP_SIZE).join(", ");

75 style.sheet.insertRule(selector + " { display: none !important; }", i);

76 }

77 }

78

79 var typeMap = {	20 var typeMap = {

80 "img": "IMAGE",	21 "img": "IMAGE",

81 "input": "IMAGE",	22 "input": "IMAGE",

82 "audio": "MEDIA",	23 "audio": "MEDIA",

83 "video": "MEDIA",	24 "video": "MEDIA",

84 "frame": "SUBDOCUMENT",	25 "frame": "SUBDOCUMENT",

85 "iframe": "SUBDOCUMENT"	26 "iframe": "SUBDOCUMENT"

86 };	27 };

87	28

88 function checkCollapse(event)	29 function checkCollapse(element)

89 {	30 {

90 var target = event.target;	31 var tag = element.localName;

91 var tag = target.localName;	32 if (tag in typeMap)

92 var expectedEvent = (tag == "iframe" \|\| tag == "frame" ? "load" : "error");

93 if (tag in typeMap && event.type == expectedEvent)

94 {	33 {

95 // This element failed loading, did we block it?	34 // This element failed loading, did we block it?

96 var url = target.src;	35 var url = element.src;

97 if (!url)	36 if (!url)

98 return;	37 return;

99	38

100 ext.backgroundPage.sendMessage(	39 ext.backgroundPage.sendMessage(

101 {	40 {

102 type: "should-collapse",	41 type: "should-collapse",

103 url: url,	42 url: url,

104 mediatype: typeMap[tag]	43 mediatype: typeMap[tag]

105 },	44 },

106	45

107 function(response)	46 function(response)

108 {	47 {

109 if (response && target.parentNode)	48 if (response && element.parentNode)

110 {	49 {

111 // <frame> cannot be removed, doing that will mess up the frameset	50 // <frame> cannot be removed, doing that will mess up the frameset

112 if (tag == "frame")	51 if (tag == "frame")

113 target.style.setProperty("visibility", "hidden", "important");	52 element.style.setProperty("visibility", "hidden", "important");

114 else	53 else

115 target.style.setProperty("display", "none", "important");	54 element.style.setProperty("display", "none", "important");

116 }	55 }

117 }	56 }

118 );	57 );

119 }	58 }

120 }	59 }

121	60

	61 function checkExceptionKey()

	62 {

	63 var attr = document.documentElement.getAttribute("data-adblockkey");

	64 if (attr)

	65 ext.backgroundPage.sendMessage({type: "add-key-exception", token: attr});

	66 }
	Wladimir Palant 2014/06/02 11:20:40 Why read the signature from a tag in Chrome? We re Why read the signature from a tag in Chrome? We read it from the headers, that's the better approach anyway. And an anonymous frame cannot be expected to have a signature anyway, only higher-level frames. Sebastian Noack 2014/06/03 06:55:27 This function isn't called for anonymous frames. H Show quoted text On 2014/06/02 11:20:40, Wladimir Palant wrote: > Why read the signature from a tag in Chrome? We read it from the headers, that's > the better approach anyway. And an anonymous frame cannot be expected to have a > signature anyway, only higher-level frames. This function isn't called for anonymous frames. However that code is used on Chrome since we have added it for Safari. Nothing new here actually. Feel free to file a separate issue if you think we must not support that way to provide a site key on Chrome. But IMO its not worth adding yet another browser switch.
	67

122 // Converts relative to absolute URL	68 // Converts relative to absolute URL

123 // e.g.: foo.swf on http://example.com/whatever/bar.html	69 // e.g.: foo.swf on http://example.com/whatever/bar.html

124 // -> http://example.com/whatever/foo.swf	70 // -> http://example.com/whatever/foo.swf

125 function relativeToAbsoluteUrl(url)	71 function relativeToAbsoluteUrl(url)

126 {	72 {

127 // If URL is already absolute, don't mess with it	73 // If URL is already absolute, don't mess with it

128 if (!url \|\| /^[\w\-]+:/i.test(url))	74 if (!url \|\| /^[\w\-]+:/i.test(url))

129 return url;	75 return url;

130	76

131 // Leading / means absolute path	77 // Leading / means absolute path

132 // Leading // means network path	78 // Leading // means network path

133 if (url[0] == '/')	79 if (url[0] == '/')

134 {	80 {

135 if (url[1] == '/')	81 if (url[1] == '/')

136 return document.location.protocol + url;	82 return document.location.protocol + url;

137 else	83 else

138 return document.location.protocol + "//" + document.location.host + url;	84 return document.location.protocol + "//" + document.location.host + url;

139 }	85 }

140	86

141 // Remove filename and add relative URL to it	87 // Remove filename and add relative URL to it

142 var base = document.baseURI.match(/.+\//);	88 var base = document.baseURI.match(/.+\//);

143 if (!base)	89 if (!base)

144 return document.baseURI + "/" + url;	90 return document.baseURI + "/" + url;

145 return base[0] + url;	91 return base[0] + url;

146 }	92 }

147	93

148 function init()	94 function init(document)

149 {	95 {

150 // Make sure this is really an HTML page, as Chrome runs these scripts on just about everything	96 var canUseShadow = "webkitCreateShadowRoot" in document.documentElement;

151 if (!(document.documentElement instanceof HTMLElement))	97 var fixAnonymousFrames = false;

152 return;

153	98

154 document.addEventListener("error", checkCollapse, true);	99 var match = navigator.userAgent.match(/\bChrome\/(\d+)/);

155 document.addEventListener("load", checkCollapse, true);	100 if (match)

	101 {

	102 var chromeVersion = parseInt(match[1]);

156	103

157 var attr = document.documentElement.getAttribute("data-adblockkey");	104 // the <shadow> element is ignored in Chrome 32 (#309). Also Chrome 31-33

158 if (attr)	105 // crashes in some situations on some pages when using shadow DOM (#498).

159 ext.backgroundPage.sendMessage({type: "add-key-exception", token: attr});	106 // So we must not use Shadow DOM on those versions of Chrome.

	107 if (chromeVersion >= 31 && chromeVersion <= 33)

	108 canUseShadow = false;

	109

	110 // prior to Chrome 37, content scripts don't run in anonymous frames.

	111 // So we have to apply element hiding and collapsing from

	112 // the parent frame, when an anonymous sub frame loaded.

	113 if (chromeVersion < 37)

	114 fixAnonymousFrames = true;

	115 }

	116

	117 // use Shadow DOM if available to don't mess with web pages that

	118 // rely on the order of their own <style> tags (#309). However we

	119 // must not create the shadow root in the response callback passed

	120 // to sendMessage(), otherwise Chrome breaks some websites (#450).

	121 if (canUseShadow)

	122 {

	123 var shadow = document.documentElement.webkitCreateShadowRoot();

	124 shadow.appendChild(document.createElement("shadow"));

	125 }

	126

	127 // Sets the currently used CSS rules for elemhide filters

	128 var setElemhideCSSRules = function(selectors)

	129 {

	130 if (selectors.length == 0)

	131 return;

	132

	133 var style = document.createElement("style");

	134 style.setAttribute("type", "text/css");

	135

	136 if (canUseShadow)

	137 {

	138 shadow.appendChild(style);

	139

	140 try

	141 {

	142 document.querySelector("::content");

	143

	144 for (var i = 0; i < selectors.length; i++)

	145 selectors[i] = "::content " + selectors[i];

	146 }

	147 catch (e)

	148 {

	149 for (var i = 0; i < selectors.length; i++)

	150 selectors[i] = "::-webkit-distributed(" + selectors[i] + ")";

	151 }

	152 }

	153 else

	154 {

	155 // Try to insert the style into the <head> tag, inserting directly under t he

	156 // document root breaks dev tools functionality:

	157 // http://code.google.com/p/chromium/issues/detail?id=178109

	158 (document.head \|\| document.documentElement).appendChild(style);

	159 }

	160

	161 var setRules = function()

	162 {

	163 // The sheet property might not exist yet if the

	164 // <style> element was created for a sub frame

	165 if (!style.sheet)

	166 {

	167 setTimeout(setRules, 0);

	168 return;

	169 }

	170

	171 // WebKit apparently chokes when the selector list in a CSS rule is huge.

	172 // So we split the elemhide selectors into groups.

	173 for (var i = 0; selectors.length > 0; i++)

	174 {

	175 var selector = selectors.splice(0, SELECTOR_GROUP_SIZE).join(", ");

	176 style.sheet.insertRule(selector + " { display: none !important; }", i);

	177 }

	178 };

	179

	180 setRules();

	181 };

	182

	183 document.addEventListener("error", function(event)

	184 {

	185 checkCollapse(event.target);

	186 }, true);

	187

	188 document.addEventListener("load", function(event)

	189 {

	190 if (/^i?frame$/.test(event.target.localName))

	191 {

	192 checkCollapse(event.target);

	193

	194 if (fixAnonymousFrames && /^(javascript:\|$)/.test(event.target.src))
	Wladimir Palant 2014/06/02 11:20:40 I think you want to check event.target.contentWind I think you want to check event.target.contentWindow.location.href, this will give you a real URL rather than something bogus (e.g. multiple spaces). It will also throw an exception for frames you aren't allowed to access so you can ignore those. The frames that we need to handle here are: * about:blank * about:srcdoc * javascript:* (is that their document URL or rather about:blank?) * data:* It is likely that we still have to handle at the very least data:* "manually" in Chrome 37, this is something you should check. Sebastian Noack 2014/06/03 06:55:27 I thought it would be simpler to check for the src Show quoted text On 2014/06/02 11:20:40, Wladimir Palant wrote: > I think you want to check event.target.contentWindow.location.href, this will > give you a real URL rather than something bogus (e.g. multiple spaces). It will > also throw an exception for frames you aren't allowed to access so you can > ignore those. I thought it would be simpler to check for the src attribute. So I don't have to handle cross-domain-policy violations. But you are right, that approach isn't really reliable. Show quoted text > The frames that we need to handle here are: > > * about:blank > * about:srcdoc Done. Show quoted text > * javascript:* (is that their document URL or rather about:blank?) In case of javascript: URLs, the frame's src attribute returns the given javascript: URL, while the document's URL will be "about:blank". Show quoted text > * data:* > > It is likely that we still have to handle at the very least data:* "manually" in > Chrome 37, this is something you should check. Content scripts don't run on data: URLs, not even on Chrome 37 with "match_about_blank". However the workaround this path implements doesn't work for data: URLs due to cross-domain-policy. Sebastian Noack 2014/06/03 07:40:35 It seems that checking for the document's URL inst It seems that checking for the document's URL instead frame's src attribute don't work in cases like: <iframe onload="document.location.replace(...)"> However this case seems to be pretty common. :(
	195 {

	196 var contentDocument = event.target.contentDocument;

	197

	198 if (contentDocument.documentElement instanceof HTMLElement)

	199 {

	200 init(contentDocument);

	201

	202 for (var tagName in typeMap)

	203 Array.prototype.forEach.call(contentDocument.getElementsByTagName(ta gName), checkCollapse);

	204 }

	205 }

	206 }

	207 }, true);

160	208

161 ext.backgroundPage.sendMessage({type: "get-selectors"}, setElemhideCSSRules);	209 ext.backgroundPage.sendMessage({type: "get-selectors"}, setElemhideCSSRules);
	Wladimir Palant 2014/06/02 11:20:40 In the background page, who will be the sender of In the background page, who will be the sender of this message in case of an anonymous frame? Its parent window I guess? That should work correctly then. What about Chrome 37? Won't the background page see a request coming in from about:blank URL? That should break element hiding then. Sebastian Noack 2014/06/03 06:55:27 Correct. Show quoted text On 2014/06/02 11:20:40, Wladimir Palant wrote: > In the background page, who will be the sender of this message in case of an > anonymous frame? Its parent window I guess? That should work correctly then. Correct. Show quoted text > What about Chrome 37? Won't the background page see a request coming in from > about:blank URL? That should break element hiding then. I can confirm your concern. This also affects Safari, which behaves like Chrome 37 with "match_about_blank". In order to address that, I'm falling back to the parent's frame URL now, when attempting to get the host of the URL of an anonymous frame.
162 }	210 }

163	211

164 // In Chrome 18 the document might not be initialized yet	212 if (document.documentElement instanceof HTMLElement)
Wladimir Palant 2014/06/02 11:20:40 For reference: https://adblockplus.org/forum/viewt For reference: https://adblockplus.org/forum/viewtopic.php?t=9234 is why the fallback was introduced. It seems that the issue was reproducible reliable and it doesn't look like Chromium devs introduced it intentionally. So it was likely fixed a few versions later.
165 if (document.documentElement)	213 {

166 init();	214 checkExceptionKey();

167 else	215 init(document);

168 window.setTimeout(init, 0);	216 }

OLD	NEW

« no previous file with comments | « no previous file | no next file » | no next file with comments »