better plugin wrapper

[johnd0e]

Use unsafeWindow, thus no need to 'inject script in site context' anymore.

• wrapper is simpler now
  Just modernized a bit.
  Main goal: avoid script re-injection if main context is directly accessible (like in Tampermonkey, Violentmonkey, and mobile app).

  • Direct script execution make debug easier:
    To set breakpoints switch to Web Developer Tools' Debugger/Sources tab
    and find related script in Tampermonkey's list of userscript.html?id=<guid>
  • no need to cut wrapper out in mobile app (see IITC-Mobile: depends on exact plugin wrapper code #298)
    (but we keep that code for all legacy plugins)
  • it's possible to use GM_* functions directly (can't put code outside of wrapper with new build system #354)
    still not possible in some environments, so stick to build_plugin.py: some code can be placed outside of wrapper #356

• in unsupported environments (Greasemonkey, IITC-Button) nothing changed - previous injection-method is used

• whole scriptMetaStr is added to plugin_info, to be able to analyse more properties (Scripts metadata processing (proof-of-concept) #242)

• New wrapper is checked with major usescript managers (Tampermonkey, Greasemonkey, Violentmonkey), and is compatible with plugins embedding old wrapper.

TODO:

• Make sure that mobile app is ready
• More tests needed with misc plugins, testing different apis (such as XHR)
  https://web.archive.org/web/20141008055234/http://www.oreillynet.com/lpt/a/6257
• IITC Button is not ready yet: Expose unsafeWindow to plugins IITC-Button#32
• May be we need some markers in code, to define exact places of different wrapper parts.
  That can be used for easy updating of embedded wrapper.
• May be we need some additional property to pass additional data from userscript manager
• May be pick another name for plugin_info
• It's possible to keep reference to original sandboxed window.
  But this also can be done manually, so probably not
• May be it's time to introduce setup arguments.
  We could pass iitc api as argument. And may be something other, e.g. logger object
• Some more improvements pending (see below)

---

This change is 

[johnd0e]

Perhaps better expose this:

ingress-intel-total-conversion/core/code/boot.js

Line 689 in ea9cb98

function safeSetup (setup) {

Otherwise we would need special handling to see such plugins in About:

ingress-intel-total-conversion/core/code/utils_misc.js

Line 3 in ea9cb98

window.aboutIITC = function () {

[johnd0e]

We can avoid this, if we add this info to meta block, see #242.

[johnd0e]

Actually we should rely on GM_info definition, but iOS is not ready: HubertZhang/IITC-Mobile#1

[johnd0e]

Unfortunately we still cannot avoid script injecting for Greasemonkey (and IITC-Button).
As appeared, such code is just ignored:

window = ...

It'd be possible to replace it with local variable, but it's not enough for good compatibility with all existing 3rd-party plugins: we also need to replace global.

I do not know it it ever possible.
I've tried to apply with (unsafeWindow) statement, but then we get other issues (Error: Permission denied to access property [...])

So for Greasemonkey I have to restore previous method involving script injection.

[le-jeu]

* Direct script execution make debug easier:
  To set breakpoints switch to Web Developer Tools' Debugger/Sources tab
  and find related script in Tampermonkey's list of `userscript.html?id=<guid>`

I tried to use sourceURL to name script and make them appear in the source tree

// ...
script.appendChild(document.createTextNode('('+ wrapper +')('+JSON.stringify(info)+');'));
if (info.script && info.script.name)
  script.appendChild(document.createTextNode(`//# sourceURL=${encodeURIComponent(info.script.name)}`));
(document.body || document.head || document.documentElement).appendChild(script);

I guess this is not compatible with IITC Mobile but the inserted script is correctly listed in source (from intel.ingress.com) (firefox: violent/grease monkey)

I used info.script.name but this can also be done by the build system
Sadly, the //# has to be added before the script is inserted in the DOM (wtr to iitc mobile)

Edit: Possible workaround for mobile

// if on last IITC mobile, will be replaced by wrapper(info)
var mobile = `script.appendChild(document.createTextNode('('+ wrapper +')('+JSON.stringify(info)+');'));
(document.body || document.head || document.documentElement).appendChild(script);`;

if (mobile.startsWith('script')) {
  script.appendChild(document.createTextNode('('+ wrapper +')('+JSON.stringify(info)+');'));
  if (info.script && info.script.name)
    script.appendChild(document.createTextNode('//# sourceURL=' + encodeURIComponent(info.script.name)));
  (document.body || document.head || document.documentElement).appendChild(script);
} else {
  // mobile string
  wrapper(info);
}