|
|
| (65 intermediate revisions by 13 users not shown) |
| Line 1: |
Line 1: |
| The '''location hack''' is an ugly but useful way to interact with the content scope of the page being [[user script]]ed. | | The location hack is an older technique for crossing the barrier between the user script scope and the content window scope, when it exists. |
| | The previous version of this page may be read [http://wiki.greasespot.net/index.php?title=Location_hack&oldid=7202 via history]. |
|
| |
|
| == Background ==
| | In Firefox version 39.0.3 Mozilla patched a known [https://www.mozilla.org/en-US/security/advisories/mfsa2015-78/ security vulnerability]. |
| | As a side effect, this broke the location hack. |
|
| |
|
| For [[security]] reasons, [[Greasemonkey]] uses [[XPCNativeWrapper]]s and [[sandbox]] to isolate it from the web page. Under this system, the user script can access and manipulate the page using event listeners, the DOM API, and [[API reference|GM_* functions]].
| | Thankfully in modern versions of Firefox and Greasemonkey, the location hack is no longer necessary. |
| | Read about how to execute code in the content scope, like previously possible with the location hack, at [[Content Script Injection]]. |
|
| |
|
| Sometimes the sandbox is too limiting, in which case the user script can access other parts of the page using [[unsafeWindow]]. As the name ''unsafe''Window implies, this can often be unsafe, and expose security holes.
| | [[Category:Coding Tips:Interacting With The Page]] |
| | |
| In December 2005, Jesse Ruderman [http://www.squarefree.com/2005/12/01/updated-greasemonkey-scripts/ came up with the location hack], to be an alternative to unsafeWindow in many cases.
| |
| | |
| == Basic usage: page functions ==
| |
| | |
| Suppose the page contains a function called <code>pageFunc</code>, or <code>window.pageFunc</code>. The user script knows this function as <code>unsafeWindow.pageFunc</code>.
| |
| | |
| The user script could simply call <code>unsafeWindow.pageFunc()</code>, but this can leak the sandbox. Instead, the user script can take advantage of javascript: URLs, which always run in the content scope. Just entering this URL into the browser's location bar does not leak a Greasemonkey sandbox:
| |
| | |
| javascript:void(pageFunc())
| |
| | |
| Similarly, a user script can set location.href to this URL to safely call the function:
| |
| | |
| location.href = "javascript:void(pageFunc())";
| |
| | |
| == Invoke onclick behavior ==
| |
| | |
| Sometimes a userscript wants to simulate the behavior of clicking a link that has an ''onclick'' handler. For example on YouTube video pages in the video description there is the link '''more''' with an ''onclick'' handler that as of this writing can be found with the XPath
| |
| | |
| "//div[@id='videoDetailsDiv']//a[text() = 'more']/@onclick"
| |
| | |
| and it contains
| |
| | |
| addClass(_gel('videoDetailsDiv'), 'expanded'); return false;
| |
| | |
| If the variable <code>onclick</code> is bound to the XPath result, then this handler can be invoked through location thusly:
| |
| | |
| location.href = "javascript:void((function(){" + onclick.nodeValue + "})());";
| |
| | |
| Note that the ''onclick'' has to be wrapped in a function so that its <code>return</code> has a scope and the whole needs to be wrapped in <code>void</code>.
| |
| | |
| This example is rather robust because it will still work if YouTube redefines the contents of its ''onclick''s.
| |
| | |
| == Trigger javascript: links ==
| |
| | |
| This hack can also be used to trigger <code>javascript:</code> links – simply do
| |
| | |
| location.href = someLink.href;
| |
| | |
| == Modifying the page ==
| |
| | |
| The location hack can do anything a page script or bookmarklet can do, so it can modify content variables and such as easily as it can access them. For example:
| |
| | |
| location.href = "javascript:void(window.someVariable = 'someValue')";
| |
| | |
| == Executing large blocks of code ==
| |
| | |
| Executing more than one statement can become unreadable very easily. Luckily, Javascript can convert functions to strings, so you can use:
| |
| | |
| location.href = "javascript:(" + function() {
| |
| // do something
| |
| } + ")()";
| |
| | |
| Even though the function is defined in the sandbox, it is not a closure of the sandbox scope. It is converted to a string and then back to a function in page scope. It cannot access anything in the sandbox scope, which is a limitation, but is also essential to making this technique secure.
| |
| | |
| == Percent encoding issue ==
| |
| | |
| Sometimes percent-encoding the percent symbol is required. For example,
| |
| | |
| location.href = ("javascript:(" + function() {
| |
| var n = 44;
| |
| if(!('''n%22''')) alert('n is a multiple of 22');
| |
| } + ")()");
| |
| | |
| The above code will cause error because %22 is interpreted as double quotation mark. The workaround is:
| |
| | |
| location.href = "javascript:(" + encodeURI(
| |
| function() {
| |
| var n = 44;
| |
| if(!(n%22)) alert('n is a multiple of 22');
| |
| }) + ")()";
| |
| | |
| See also [http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Functions:encodeURI encodeURI()].
| |
| | |
| == Returning values ==
| |
| | |
| Functions called through the location hack cannot return data directly to the user script scope. To communicate between location hack code and regular user script code, data must be placed where the user script can see it, for example, by writing it into the DOM, or by triggering an event. A simple example:
| |
| | |
| var oldBodyTitle = document.body.title;
| |
| location.href = "javascript:void(document.body.title = pageFunc())";
| |
| var fauxReturnValue = document.body.title;
| |
| document.body.title = oldBodyTitle;
| |
| | |
| === Function to get values of global variables ===
| |
| | |
| The following function can be used to access the values of global variables using <code>var value = GM_getGlobalElement('globalVariable');</code>. Please note that the returned value is converted to a string.
| |
| | |
| // function to get values of global variables using the "location hack"
| |
| window.GM_getGlobalElement = null;
| |
| window.getGlobalValue = function(name) {
| |
| if (GM_getGlobalElement == null) {
| |
| GM_getGlobalElement = document.createElement("textarea");
| |
| GM_getGlobalElement.id = "GM_getGlobalElement";
| |
| GM_getGlobalElement.style.visibility = "hidden";
| |
| GM_getGlobalElement.style.display = "none";
| |
| document.body.appendChild(GM_getGlobalElement);
| |
| }
| |
| location.href = "javascript:void(typeof("+ name + ")!=\"undefined\"?document.getElementById(\"GM_getGlobalElement\").value=" + name + ":null)";
| |
| return(GM_getGlobalElement.value);
| |
| }
| |
The location hack is an older technique for crossing the barrier between the user script scope and the content window scope, when it exists.
The previous version of this page may be read via history.
In Firefox version 39.0.3 Mozilla patched a known security vulnerability.
As a side effect, this broke the location hack.
Thankfully in modern versions of Firefox and Greasemonkey, the location hack is no longer necessary.
Read about how to execute code in the content scope, like previously possible with the location hack, at Content Script Injection.
