The Tor Browser: toolkit/components/printing/content/printUtils.js@6474c204b198 (annotated)

toolkit/components/printing/content/printUtils.js@6474c204b198 (annotated)

toolkit/components/printing/content/printUtils.js

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 // -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 var gPrintSettingsAreGlobal = false;
 var gSavePrintSettings = false;
 var gFocusedElement = null;
 var PrintUtils = {
   showPageSetup: function ()
   {
     try {
       var printSettings = this.getPrintSettings();
       var PRINTPROMPTSVC = Components.classes["@mozilla.org/embedcomp/printingprompt-service;1"]
                                      .getService(Components.interfaces.nsIPrintingPromptService);
       PRINTPROMPTSVC.showPageSetup(window, printSettings, null);
       if (gSavePrintSettings) {
         // Page Setup data is a "native" setting on the Mac
         var PSSVC = Components.classes["@mozilla.org/gfx/printsettings-service;1"]
                               .getService(Components.interfaces.nsIPrintSettingsService);
         PSSVC.savePrintSettingsToPrefs(printSettings, true, printSettings.kInitSaveNativeData);
       }
     } catch (e) {
       dump("showPageSetup "+e+"\n");
       return false;
     }
     return true;
   },
   print: function (aWindow)
   {
     var webBrowserPrint = this.getWebBrowserPrint(aWindow);
     var printSettings = this.getPrintSettings();
     try {
       webBrowserPrint.print(printSettings, null);
       if (gPrintSettingsAreGlobal && gSavePrintSettings) {
         var PSSVC = Components.classes["@mozilla.org/gfx/printsettings-service;1"]
                               .getService(Components.interfaces.nsIPrintSettingsService);
         PSSVC.savePrintSettingsToPrefs(printSettings, true,
                                        printSettings.kInitSaveAll);
         PSSVC.savePrintSettingsToPrefs(printSettings, false,
                                        printSettings.kInitSavePrinterName);
       }
     } catch (e) {
       // Pressing cancel is expressed as an NS_ERROR_ABORT return value,
       // causing an exception to be thrown which we catch here.
       // Unfortunately this will also consume helpful failures, so add a
       // dump("print: "+e+"\n"); // if you need to debug
     }
   },
   // If aCallback is not null, it must be an object which has the following methods:
   // getPrintPreviewBrowser(), getSourceBrowser(),
   // getNavToolbox(), onEnter() and onExit().
   // If aCallback is null, then printPreview must previously have been called with
   // non-null aCallback and that object will be reused.
   printPreview: function (aCallback)
   {
     // if we're already in PP mode, don't set the callback; chances
     // are it is null because someone is calling printPreview() to
     // get us to refresh the display.
     if (!document.getElementById("print-preview-toolbar")) {
       this._callback = aCallback;
       this._sourceBrowser = aCallback.getSourceBrowser();
       this._originalTitle = this._sourceBrowser.contentDocument.title;
       this._originalURL = this._sourceBrowser.currentURI.spec;
     } else {
       // collapse the browser here -- it will be shown in
       // enterPrintPreview; this forces a reflow which fixes display
       // issues in bug 267422.
       this._sourceBrowser = this._callback.getPrintPreviewBrowser();
       this._sourceBrowser.collapsed = true;
     }
     this._webProgressPP = {};
     var ppParams        = {};
     var notifyOnOpen    = {};
     var webBrowserPrint = this.getWebBrowserPrint();
     var printSettings   = this.getPrintSettings();
     // Here we get the PrintingPromptService so we can display the PP Progress from script
     // For the browser implemented via XUL with the PP toolbar we cannot let it be
     // automatically opened from the print engine because the XUL scrollbars in the PP window
     // will layout before the content window and a crash will occur.
     // Doing it all from script, means it lays out before hand and we can let printing do its own thing
     var PPROMPTSVC = Components.classes["@mozilla.org/embedcomp/printingprompt-service;1"]
                                .getService(Components.interfaces.nsIPrintingPromptService);
     // just in case we are already printing,
     // an error code could be returned if the Prgress Dialog is already displayed
     try {
       PPROMPTSVC.showProgress(window, webBrowserPrint, printSettings, this._obsPP, false,
                               this._webProgressPP, ppParams, notifyOnOpen);
       if (ppParams.value) {
         ppParams.value.docTitle = this._originalTitle;
         ppParams.value.docURL   = this._originalURL;
       }
       // this tells us whether we should continue on with PP or
       // wait for the callback via the observer
       if (!notifyOnOpen.value.valueOf() || this._webProgressPP.value == null)
         this.enterPrintPreview();
     } catch (e) {
       this.enterPrintPreview();
     }
   },
   getWebBrowserPrint: function (aWindow)
   {
     var contentWindow = aWindow || window.content;
     return contentWindow.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
                         .getInterface(Components.interfaces.nsIWebBrowserPrint);
   },
   getPrintPreview: function() {
     return this._callback.getPrintPreviewBrowser().docShell.printPreview;
   },
   ////////////////////////////////////////
   // "private" methods. Don't use them. //
   ////////////////////////////////////////
   setPrinterDefaultsForSelectedPrinter: function (aPSSVC, aPrintSettings)
   {
     if (!aPrintSettings.printerName)
       aPrintSettings.printerName = aPSSVC.defaultPrinterName;
     // First get any defaults from the printer
     aPSSVC.initPrintSettingsFromPrinter(aPrintSettings.printerName, aPrintSettings);
     // now augment them with any values from last time
     aPSSVC.initPrintSettingsFromPrefs(aPrintSettings, true,  aPrintSettings.kInitSaveAll);
   },
   getPrintSettings: function ()
   {
     var pref = Components.classes["@mozilla.org/preferences-service;1"]
                          .getService(Components.interfaces.nsIPrefBranch);
     if (pref) {
       gPrintSettingsAreGlobal = pref.getBoolPref("print.use_global_printsettings", false);
       gSavePrintSettings = pref.getBoolPref("print.save_print_settings", false);
     }
     var printSettings;
     try {
       var PSSVC = Components.classes["@mozilla.org/gfx/printsettings-service;1"]
                             .getService(Components.interfaces.nsIPrintSettingsService);
       if (gPrintSettingsAreGlobal) {
         printSettings = PSSVC.globalPrintSettings;
         this.setPrinterDefaultsForSelectedPrinter(PSSVC, printSettings);
       } else {
         printSettings = PSSVC.newPrintSettings;
       }
     } catch (e) {
       dump("getPrintSettings: "+e+"\n");
     }
     return printSettings;
   },
   _closeHandlerPP: null,
   _webProgressPP: null,
   _callback: null,
   _sourceBrowser: null,
   _originalTitle: "",
   _originalURL: "",
   // This observer is called once the progress dialog has been "opened"
   _obsPP:
   {
     observe: function(aSubject, aTopic, aData)
     {
       // delay the print preview to show the content of the progress dialog
       setTimeout(function () { PrintUtils.enterPrintPreview(); }, 0);
     },
     QueryInterface : function(iid)
     {
       if (iid.equals(Components.interfaces.nsIObserver) ||
           iid.equals(Components.interfaces.nsISupportsWeakReference) ||
           iid.equals(Components.interfaces.nsISupports))
         return this;
       throw Components.results.NS_NOINTERFACE;
     }
   },
   enterPrintPreview: function ()
   {
     gFocusedElement = document.commandDispatcher.focusedElement;
     var webBrowserPrint;
     var printSettings  = this.getPrintSettings();
     var originalWindow = this._sourceBrowser.contentWindow;
     try {
       webBrowserPrint = this.getPrintPreview();
       webBrowserPrint.printPreview(printSettings, originalWindow,
                                    this._webProgressPP.value);
     } catch (e) {
       // Pressing cancel is expressed as an NS_ERROR_ABORT return value,
       // causing an exception to be thrown which we catch here.
       // Unfortunately this will also consume helpful failures, so add a
       // dump(e); // if you need to debug
       // Need to call enter and exit so that UI gets back to normal.
       this._callback.onEnter();
       this._callback.onExit();
       return;
     }
     var printPreviewTB = document.getElementById("print-preview-toolbar");
     if (printPreviewTB) {
       printPreviewTB.updateToolbar();
       var browser = this._callback.getPrintPreviewBrowser();
       browser.collapsed = false;
       browser.contentWindow.focus();
       return;
     }
     // Set the original window as an active window so any mozPrintCallbacks can
     // run without delayed setTimeouts.
     var docShell = originalWindow.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
                                  .getInterface(Components.interfaces.nsIWebNavigation)
                                  .QueryInterface(Components.interfaces.nsIDocShell);
     docShell.isActive = true;
     // show the toolbar after we go into print preview mode so
     // that we can initialize the toolbar with total num pages
     var XUL_NS =
       "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
     printPreviewTB = document.createElementNS(XUL_NS, "toolbar");
     printPreviewTB.setAttribute("printpreview", true);
     printPreviewTB.id = "print-preview-toolbar";
     printPreviewTB.className = "toolbar-primary";
     var navToolbox = this._callback.getNavToolbox();
     navToolbox.parentNode.insertBefore(printPreviewTB, navToolbox);
     // copy the window close handler
     if (document.documentElement.hasAttribute("onclose"))
       this._closeHandlerPP = document.documentElement.getAttribute("onclose");
     else
       this._closeHandlerPP = null;
     document.documentElement.setAttribute("onclose", "PrintUtils.exitPrintPreview(); return false;");
     // disable chrome shortcuts...
     window.addEventListener("keydown", this.onKeyDownPP, true);
     window.addEventListener("keypress", this.onKeyPressPP, true);
     var browser = this._callback.getPrintPreviewBrowser();
     browser.collapsed = false;
     browser.contentWindow.focus();
     // on Enter PP Call back
     this._callback.onEnter();
   },
   exitPrintPreview: function ()
   {
     window.removeEventListener("keydown", this.onKeyDownPP, true);
     window.removeEventListener("keypress", this.onKeyPressPP, true);
     // restore the old close handler
     document.documentElement.setAttribute("onclose", this._closeHandlerPP);
     this._closeHandlerPP = null;
     var webBrowserPrint = this.getPrintPreview();
     webBrowserPrint.exitPrintPreview();
     // remove the print preview toolbar
     var printPreviewTB = document.getElementById("print-preview-toolbar");
     this._callback.getNavToolbox().parentNode.removeChild(printPreviewTB);
     var fm = Components.classes["@mozilla.org/focus-manager;1"]
                        .getService(Components.interfaces.nsIFocusManager);
     if (gFocusedElement)
       fm.setFocus(gFocusedElement, fm.FLAG_NOSCROLL);
     else
       window.content.focus();
     gFocusedElement = null;
     this._callback.onExit();
   },
   onKeyDownPP: function (aEvent)
   {
     // Esc exits the PP
     if (aEvent.keyCode == aEvent.DOM_VK_ESCAPE) {
       PrintUtils.exitPrintPreview();
     }
   },
   onKeyPressPP: function (aEvent)
   {
     var closeKey;
     try {
       closeKey = document.getElementById("key_close")
                          .getAttribute("key");
       closeKey = aEvent["DOM_VK_"+closeKey];
     } catch (e) {}
     var isModif = aEvent.ctrlKey || aEvent.metaKey;
     // Ctrl-W exits the PP
     if (isModif &&
         (aEvent.charCode == closeKey || aEvent.charCode == closeKey + 32)) {
       PrintUtils.exitPrintPreview();
     }
     else if (isModif) {
       var printPreviewTB = document.getElementById("print-preview-toolbar");
       var printKey = document.getElementById("printKb").getAttribute("key").toUpperCase();
       var pressedKey = String.fromCharCode(aEvent.charCode).toUpperCase();
       if (printKey == pressedKey) {
 	  PrintUtils.print();
       }
     }
     // cancel shortkeys
     if (isModif) {
       aEvent.preventDefault();
       aEvent.stopPropagation();
     }
   }
 }