mirrors/zotero
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

HiddenBrowser: Add print support

Browse source
This commit is contained in:
Abe Jellinek 2024-05-03 12:02:05 -04:00 committed by Dan Stillman
parent a473002663
commit 120d4cfacd
1 changed files with 47 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
chrome/content/zotero/HiddenBrowser.jsm
View file

@ -53,23 +53,41 @@ class HiddenBrowser {
* @param {Boolean} [options.allowJavaScript] * @param {Boolean} [options.allowJavaScript]
* @param {Object} [options.docShell] Fields to set on Browser.docShell * @param {Object} [options.docShell] Fields to set on Browser.docShell
* @param {Boolean} [options.blockRemoteResources] Block all remote (non-file:) resources * @param {Boolean} [options.blockRemoteResources] Block all remote (non-file:) resources
* @param {Boolean} [options.useHiddenFrame=true] Use a hidden frame to create the browser.
* Must be set to false if intending to call print().
* @param {Zotero.CookieSandbox} [options.cookieSandbox] * @param {Zotero.CookieSandbox} [options.cookieSandbox]
*/ */
constructor(options = {}) { constructor(options = {}) {
var frame = new HiddenFrame(); this._destroyed = false;
this._createdPromise = (async () => { this._createdPromise = (async () => {
var windowlessBrowser = await frame.get(); let doc;
windowlessBrowser.browsingContext.allowJavascript = options.allowJavaScript !== false; if (options.useHiddenFrame !== false) {
windowlessBrowser.docShell.allowImages = false; var frame = new HiddenFrame();
if (options.docShell) { this._frame = frame;
Object.assign(windowlessBrowser.docShell, options.docShell);
var windowlessBrowser = await frame.get();
windowlessBrowser.browsingContext.allowJavascript = options.allowJavaScript !== false;
windowlessBrowser.docShell.allowImages = false;
if (options.docShell) {
Object.assign(windowlessBrowser.docShell, options.docShell);
}
doc = windowlessBrowser.document;
}
else {
doc = Zotero.getMainWindow()?.document;
if (!doc) {
throw new Error("HiddenBrowser with useHiddenFrame: false requires the main window to be open");
}
if ('allowJavaScript' in options || 'docShell' in options) {
throw new Error("allowJavaScript and docShell options are only supported with useHiddenFrame: true");
}
} }
var doc = windowlessBrowser.document;
var browser = doc.createXULElement("browser"); var browser = doc.createXULElement("browser");
browser.setAttribute("type", "content"); browser.setAttribute("type", "content");
browser.setAttribute("remote", "true"); browser.setAttribute("remote", "true");
browser.setAttribute('maychangeremoteness', 'true'); browser.setAttribute('maychangeremoteness', 'true');
browser.setAttribute("disableglobalhistory", "true"); browser.setAttribute("disableglobalhistory", "true");
browser.style.display = "none";
doc.documentElement.appendChild(browser); doc.documentElement.appendChild(browser);
if (options.cookieSandbox) { if (options.cookieSandbox) {
@ -80,7 +98,7 @@ class HiddenBrowser {
let weakBrowser = new WeakRef(browser); let weakBrowser = new WeakRef(browser);
setTimeout(() => { setTimeout(() => {
let browser = weakBrowser.deref(); let browser = weakBrowser.deref();
if (browser && this._frame) { if (browser) {
Zotero.debug('Browser object still alive after 60 seconds - memory leak?'); Zotero.debug('Browser object still alive after 60 seconds - memory leak?');
Zotero.debug('Viewing URI ' + browser.currentURI?.spec) Zotero.debug('Viewing URI ' + browser.currentURI?.spec)
} }
@ -99,7 +117,6 @@ class HiddenBrowser {
this._browser = browser; this._browser = browser;
})(); })();
this._frame = frame;
return new Proxy(this, { return new Proxy(this, {
get(target, prop) { get(target, prop) {
if (prop in target) { if (prop in target) {
@ -252,13 +269,31 @@ class HiddenBrowser {
return actor.sendQuery('snapshot'); return actor.sendQuery('snapshot');
} }
destroy() { /**
* @param {Object} [options]
* @returns {Promise<void>}
*/
print(options) {
if (this._frame) { if (this._frame) {
throw new Error("Printing is not supported with useHiddenFrame: true");
}
let actor = this.browsingContext.currentWindowGlobal.getActor("ZoteroPrint");
return actor.zoteroPrint(options);
}
destroy() {
if (!this._destroyed) {
this._destroyed = true;
(async () => { (async () => {
await this._createdPromise; await this._createdPromise;
this._blockingObserver?.unregister(this._browser); this._blockingObserver?.unregister(this._browser);
this._frame.destroy(); if (this._frame) {
this._frame = null; this._frame.destroy();
this._frame = null;
}
else {
this._browser.remove();
}
Zotero.debug("Deleted hidden browser"); Zotero.debug("Deleted hidden browser");
})(); })();
} }