The Tor Browser: toolkit/components/viewsource/content/viewSource.js@b8a032363ba2 (annotated)

toolkit/components/viewsource/content/viewSource.js@b8a032363ba2 (annotated)

toolkit/components/viewsource/content/viewSource.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 // -*- 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/. */
 Components.utils.import("resource://gre/modules/Services.jsm");
 Components.utils.import("resource://gre/modules/CharsetMenu.jsm");
 const Cc = Components.classes;
 const Ci = Components.interfaces;
 var gLastLineFound = '';
 var gGoToLine = 0;
 [
   ["gBrowser",          "content"],
   ["gViewSourceBundle", "viewSourceBundle"],
   ["gContextMenu",      "viewSourceContextMenu"]
 ].forEach(function ([name, id]) {
   window.__defineGetter__(name, function () {
     var element = document.getElementById(id);
     if (!element)
       return null;
     delete window[name];
     return window[name] = element;
   });
 });
 // viewZoomOverlay.js uses this
 function getBrowser() {
   return gBrowser;
 }
 this.__defineGetter__("gPageLoader", function () {
   var webnav = getWebNavigation();
   if (!webnav)
     return null;
   delete this.gPageLoader;
   return this.gPageLoader = webnav.QueryInterface(Ci.nsIWebPageDescriptor);
 });
 var gSelectionListener = {
   timeout: 0,
   attached: false,
   notifySelectionChanged: function(doc, sel, reason)
   {
     // Coalesce notifications within 100ms intervals.
     if (!this.timeout)
       this.timeout = setTimeout(updateStatusBar, 100);
   }
 }
 function onLoadViewSource()
 {
   viewSource(window.arguments[0]);
   document.commandDispatcher.focusedWindow = content;
   gBrowser.droppedLinkHandler = function (event, url, name) {
     viewSource(url)
     event.preventDefault();
   }
   if (!isHistoryEnabled()) {
     // Disable the BACK and FORWARD commands and hide the related menu items.
     var viewSourceNavigation = document.getElementById("viewSourceNavigation");
     viewSourceNavigation.setAttribute("disabled", "true");
     viewSourceNavigation.setAttribute("hidden", "true");
   }
 }
 function isHistoryEnabled() {
   return !gBrowser.hasAttribute("disablehistory");
 }
 function getSelectionController() {
   return gBrowser.docShell
                  .QueryInterface(Ci.nsIInterfaceRequestor)
                  .getInterface(Ci.nsISelectionDisplay)
                  .QueryInterface(Ci.nsISelectionController);
 }
 function viewSource(url)
 {
   if (!url)
     return; // throw Components.results.NS_ERROR_FAILURE;
   var viewSrcUrl = "view-source:" + url;
   gBrowser.addEventListener("pagehide", onUnloadContent, true);
   gBrowser.addEventListener("pageshow", onLoadContent, true);
   gBrowser.addEventListener("click", onClickContent, false);
   var loadFromURL = true;
   // Parse the 'arguments' supplied with the dialog.
   //    arg[0] - URL string.
   //    arg[1] - Charset value in the form 'charset=xxx'.
   //    arg[2] - Page descriptor used to load content from the cache.
   //    arg[3] - Line number to go to.
   //    arg[4] - Whether charset was forced by the user
   if ("arguments" in window) {
     var arg;
     // Set the charset of the viewsource window...
     var charset;
     if (window.arguments.length >= 2) {
       arg = window.arguments[1];
       try {
         if (typeof(arg) == "string" && arg.indexOf('charset=') != -1) {
           var arrayArgComponents = arg.split('=');
           if (arrayArgComponents) {
             // Remember the charset here so that it can be used below in case
             // the document had a forced charset.
             charset = arrayArgComponents[1];
           }
         }
       } catch (ex) {
         // Ignore the failure and keep processing arguments...
       }
     }
     // If the document had a forced charset, set it here also
     if (window.arguments.length >= 5) {
       arg = window.arguments[4];
       try {
         if (arg === true) {
           gBrowser.docShell.charset = charset;
         }
       } catch (ex) {
         // Ignore the failure and keep processing arguments...
       }
     }
     // Get any specified line to jump to.
     if (window.arguments.length >= 4) {
       arg = window.arguments[3];
       gGoToLine = parseInt(arg);
     }
     // Use the page descriptor to load the content from the cache (if
     // available).
     if (window.arguments.length >= 3) {
       arg = window.arguments[2];
       try {
         if (typeof(arg) == "object" && arg != null) {
           // Load the page using the page descriptor rather than the URL.
           // This allows the content to be fetched from the cache (if
           // possible) rather than the network...
           gPageLoader.loadPage(arg, gPageLoader.DISPLAY_AS_SOURCE);
           // The content was successfully loaded.
           loadFromURL = false;
           // Record the page load in the session history so <back> will work.
           var shEntrySource = arg.QueryInterface(Ci.nsISHEntry);
           var shEntry = Cc["@mozilla.org/browser/session-history-entry;1"].createInstance(Ci.nsISHEntry);
           shEntry.setURI(makeURI(viewSrcUrl, null, null));
           shEntry.setTitle(viewSrcUrl);
           shEntry.loadType = Ci.nsIDocShellLoadInfo.loadHistory;
           shEntry.cacheKey = shEntrySource.cacheKey;
           gBrowser.sessionHistory
                   .QueryInterface(Ci.nsISHistoryInternal)
                   .addEntry(shEntry, true);
         }
       } catch(ex) {
         // Ignore the failure.  The content will be loaded via the URL
         // that was supplied in arg[0].
       }
     }
   }
   if (loadFromURL) {
     // Currently, an exception is thrown if the URL load fails...
     var loadFlags = Ci.nsIWebNavigation.LOAD_FLAGS_NONE;
     getWebNavigation().loadURI(viewSrcUrl, loadFlags, null, null, null);
   }
   // Check the view_source.wrap_long_lines pref and set the menuitem's checked
   // attribute accordingly.
   var wraplonglinesPrefValue = Services.prefs.getBoolPref("view_source.wrap_long_lines");
   if (wraplonglinesPrefValue)
     document.getElementById("menu_wrapLongLines").setAttribute("checked", "true");
   document.getElementById("menu_highlightSyntax")
           .setAttribute("checked",
                         Services.prefs.getBoolPref("view_source.syntax_highlight"));
   window.addEventListener("AppCommand", HandleAppCommandEvent, true);
   window.addEventListener("MozSwipeGesture", HandleSwipeGesture, true);
   window.content.focus();
 }
 function onLoadContent()
 {
   // If the view source was opened with a "go to line" argument.
   if (gGoToLine > 0) {
     goToLine(gGoToLine);
     gGoToLine = 0;
   }
   document.getElementById('cmd_goToLine').removeAttribute('disabled');
   // Register a listener so that we can show the caret position on the status bar.
   window.content.getSelection()
    .QueryInterface(Ci.nsISelectionPrivate)
    .addSelectionListener(gSelectionListener);
   gSelectionListener.attached = true;
   if (isHistoryEnabled())
     UpdateBackForwardCommands();
 }
 function onUnloadContent()
 {
   // Disable "go to line" while reloading due to e.g. change of charset
   // or toggling of syntax highlighting.
   document.getElementById('cmd_goToLine').setAttribute('disabled', 'true');
   // If we're not just unloading the initial "about:blank" which doesn't have
   // a selection listener, get rid of it so it doesn't try to fire after the
   // window has gone away.
   if (gSelectionListener.attached) {
     window.content.getSelection().QueryInterface(Ci.nsISelectionPrivate)
           .removeSelectionListener(gSelectionListener);
     gSelectionListener.attached = false;
   }
 }
 /**
  * Handle click events bubbling up from error page content
  */
 function onClickContent(event) {
   // Don't trust synthetic events
   if (!event.isTrusted || event.target.localName != "button")
     return;
   var target = event.originalTarget;
   var errorDoc = target.ownerDocument;
   if (/^about:blocked/.test(errorDoc.documentURI)) {
     // The event came from a button on a malware/phishing block page
     // First check whether it's malware or phishing, so that we can
     // use the right strings/links
     var isMalware = /e=malwareBlocked/.test(errorDoc.documentURI);
     if (target == errorDoc.getElementById('getMeOutButton')) {
       // Instead of loading some safe page, just close the window
       window.close();
     } else if (target == errorDoc.getElementById('reportButton')) {
       // This is the "Why is this site blocked" button.  For malware,
       // we can fetch a site-specific report, for phishing, we redirect
       // to the generic page describing phishing protection.
       if (isMalware) {
         // Get the stop badware "why is this blocked" report url,
         // append the current url, and go there.
         try {
           let reportURL = Services.urlFormatter.formatURLPref("browser.safebrowsing.malware.reportURL", true);
           reportURL += errorDoc.location.href.slice(12);
           openURL(reportURL);
         } catch (e) {
           Components.utils.reportError("Couldn't get malware report URL: " + e);
         }
       } else {
         // It's a phishing site, just link to the generic information page
         let url = Services.urlFormatter.formatURLPref("app.support.baseURL");
         openURL(url + "phishing-malware");
       }
     } else if (target == errorDoc.getElementById('ignoreWarningButton')) {
       // Allow users to override and continue through to the site
       gBrowser.loadURIWithFlags(content.location.href,
                                 Ci.nsIWebNavigation.LOAD_FLAGS_BYPASS_CLASSIFIER,
                                 null, null, null);
     }
   }
 }
 function HandleAppCommandEvent(evt)
 {
   evt.stopPropagation();
   switch (evt.command) {
     case "Back":
       BrowserBack();
       break;
     case "Forward":
       BrowserForward();
       break;
   }
 }
 function HandleSwipeGesture(evt) {
   evt.stopPropagation();
   switch (evt.direction) {
     case SimpleGestureEvent.DIRECTION_LEFT:
       BrowserBack();
       break;
     case SimpleGestureEvent.DIRECTION_RIGHT:
       BrowserForward();
       break;
     case SimpleGestureEvent.DIRECTION_UP:
       goDoCommand("cmd_scrollTop");
       break;
     case SimpleGestureEvent.DIRECTION_DOWN:
       goDoCommand("cmd_scrollBottom");
       break;
   }
 }
 function ViewSourceClose()
 {
   window.close();
 }
 function ViewSourceReload()
 {
   gBrowser.reloadWithFlags(Ci.nsIWebNavigation.LOAD_FLAGS_BYPASS_PROXY |
                            Ci.nsIWebNavigation.LOAD_FLAGS_BYPASS_CACHE);
 }
 // Strips the |view-source:| for internalSave()
 function ViewSourceSavePage()
 {
   internalSave(window.content.location.href.substring(12),
                null, null, null, null, null, "SaveLinkTitle",
                null, null, window.content.document, null, gPageLoader);
 }
 var PrintPreviewListener = {
   getPrintPreviewBrowser: function () {
     var browser = document.getElementById("ppBrowser");
     if (!browser) {
       browser = document.createElement("browser");
       browser.setAttribute("id", "ppBrowser");
       browser.setAttribute("flex", "1");
       document.getElementById("appcontent").
         insertBefore(browser, document.getElementById("FindToolbar"));
     }
     return browser;
   },
   getSourceBrowser: function () {
     return gBrowser;
   },
   getNavToolbox: function () {
     return document.getElementById("appcontent");
   },
   onEnter: function () {
     var toolbox = document.getElementById("viewSource-toolbox");
     toolbox.hidden = true;
     gBrowser.collapsed = true;
   },
   onExit: function () {
     document.getElementById("ppBrowser").collapsed = true;
     gBrowser.collapsed = false;
     document.getElementById("viewSource-toolbox").hidden = false;
   }
 }
 function getWebNavigation()
 {
   try {
     return gBrowser.webNavigation;
   } catch (e) {
     return null;
   }
 }
 function ViewSourceGoToLine()
 {
   var input = {value:gLastLineFound};
   for (;;) {
     var ok = Services.prompt.prompt(
         window,
         gViewSourceBundle.getString("goToLineTitle"),
         gViewSourceBundle.getString("goToLineText"),
         input,
         null,
         {value:0});
     if (!ok)
       return;
     var line = parseInt(input.value, 10);
     if (!(line > 0)) {
       Services.prompt.alert(window,
                             gViewSourceBundle.getString("invalidInputTitle"),
                             gViewSourceBundle.getString("invalidInputText"));
       continue;
     }
     var found = goToLine(line);
     if (found)
       break;
     Services.prompt.alert(window,
                           gViewSourceBundle.getString("outOfRangeTitle"),
                           gViewSourceBundle.getString("outOfRangeText"));
   }
 }
 function goToLine(line)
 {
   var viewsource = window.content.document.body;
   // The source document is made up of a number of pre elements with
   // id attributes in the format <pre id="line123">, meaning that
   // the first line in the pre element is number 123.
   // Do binary search to find the pre element containing the line.
   // However, in the plain text case, we have only one pre without an
   // attribute, so assume it begins on line 1.
   var pre;
   for (var lbound = 0, ubound = viewsource.childNodes.length; ; ) {
     var middle = (lbound + ubound) >> 1;
     pre = viewsource.childNodes[middle];
     var firstLine = pre.id ? parseInt(pre.id.substring(4)) : 1;
     if (lbound == ubound - 1) {
       break;
     }
     if (line >= firstLine) {
       lbound = middle;
     } else {
       ubound = middle;
     }
   }
   var result = {};
   var found = findLocation(pre, line, null, -1, false, result);
   if (!found) {
     return false;
   }
   var selection = window.content.getSelection();
   selection.removeAllRanges();
   // In our case, the range's startOffset is after "\n" on the previous line.
   // Tune the selection at the beginning of the next line and do some tweaking
   // to position the focusNode and the caret at the beginning of the line.
   selection.QueryInterface(Ci.nsISelectionPrivate)
     .interlinePosition = true;
   selection.addRange(result.range);
   if (!selection.isCollapsed) {
     selection.collapseToEnd();
     var offset = result.range.startOffset;
     var node = result.range.startContainer;
     if (offset < node.data.length) {
       // The same text node spans across the "\n", just focus where we were.
       selection.extend(node, offset);
     }
     else {
       // There is another tag just after the "\n", hook there. We need
       // to focus a safe point because there are edgy cases such as
       // <span>...\n</span><span>...</span> vs.
       // <span>...\n<span>...</span></span><span>...</span>
       node = node.nextSibling ? node.nextSibling : node.parentNode.nextSibling;
       selection.extend(node, 0);
     }
   }
   var selCon = getSelectionController();
   selCon.setDisplaySelection(Ci.nsISelectionController.SELECTION_ON);
   selCon.setCaretVisibilityDuringSelection(true);
   // Scroll the beginning of the line into view.
   selCon.scrollSelectionIntoView(
     Ci.nsISelectionController.SELECTION_NORMAL,
     Ci.nsISelectionController.SELECTION_FOCUS_REGION,
     true);
   gLastLineFound = line;
   document.getElementById("statusbar-line-col").label =
     gViewSourceBundle.getFormattedString("statusBarLineCol", [line, 1]);
   return true;
 }
 function updateStatusBar()
 {
   // Reset the coalesce flag.
   gSelectionListener.timeout = 0;
   var statusBarField = document.getElementById("statusbar-line-col");
   var selection = window.content.getSelection();
   if (!selection.focusNode) {
     statusBarField.label = '';
     return;
   }
   if (selection.focusNode.nodeType != Node.TEXT_NODE) {
     return;
   }
   var selCon = getSelectionController();
   selCon.setDisplaySelection(Ci.nsISelectionController.SELECTION_ON);
   selCon.setCaretVisibilityDuringSelection(true);
   var interlinePosition = selection.QueryInterface(Ci.nsISelectionPrivate)
                                    .interlinePosition;
   var result = {};
   findLocation(null, -1,
       selection.focusNode, selection.focusOffset, interlinePosition, result);
   statusBarField.label = gViewSourceBundle.getFormattedString(
                            "statusBarLineCol", [result.line, result.col]);
 }
 // Loops through the text lines in the pre element. The arguments are either
 // (pre, line) or (node, offset, interlinePosition). result is an out
 // argument. If (pre, line) are specified (and node == null), result.range is
 // a range spanning the specified line. If the (node, offset,
 // interlinePosition) are specified, result.line and result.col are the line
 // and column number of the specified offset in the specified node relative to
 // the whole file.
 function findLocation(pre, line, node, offset, interlinePosition, result)
 {
   if (node && !pre) {
     // Look upwards to find the current pre element.
     for (pre = node;
          pre.nodeName != "PRE";
          pre = pre.parentNode);
   }
   // The source document is made up of a number of pre elements with
   // id attributes in the format <pre id="line123">, meaning that
   // the first line in the pre element is number 123.
   // However, in the plain text case, there is only one <pre> without an id,
   // so assume line 1.
   var curLine = pre.id ? parseInt(pre.id.substring(4)) : 1;
   // Walk through each of the text nodes and count newlines.
   var treewalker = window.content.document
       .createTreeWalker(pre, NodeFilter.SHOW_TEXT, null);
   // The column number of the first character in the current text node.
   var firstCol = 1;
   var found = false;
   for (var textNode = treewalker.firstChild();
        textNode && !found;
        textNode = treewalker.nextNode()) {
     // \r is not a valid character in the DOM, so we only check for \n.
     var lineArray = textNode.data.split(/\n/);
     var lastLineInNode = curLine + lineArray.length - 1;
     // Check if we can skip the text node without further inspection.
     if (node ? (textNode != node) : (lastLineInNode < line)) {
       if (lineArray.length > 1) {
         firstCol = 1;
       }
       firstCol += lineArray[lineArray.length - 1].length;
       curLine = lastLineInNode;
       continue;
     }
     // curPos is the offset within the current text node of the first
     // character in the current line.
     for (var i = 0, curPos = 0;
          i < lineArray.length;
          curPos += lineArray[i++].length + 1) {
       if (i > 0) {
         curLine++;
       }
       if (node) {
         if (offset >= curPos && offset <= curPos + lineArray[i].length) {
           // If we are right after the \n of a line and interlinePosition is
           // false, the caret looks as if it were at the end of the previous
           // line, so we display that line and column instead.
           if (i > 0 && offset == curPos && !interlinePosition) {
             result.line = curLine - 1;
             var prevPos = curPos - lineArray[i - 1].length;
             result.col = (i == 1 ? firstCol : 1) + offset - prevPos;
           } else {
             result.line = curLine;
             result.col = (i == 0 ? firstCol : 1) + offset - curPos;
           }
           found = true;
           break;
         }
       } else {
         if (curLine == line && !("range" in result)) {
           result.range = document.createRange();
           result.range.setStart(textNode, curPos);
           // This will always be overridden later, except when we look for
           // the very last line in the file (this is the only line that does
           // not end with \n).
           result.range.setEndAfter(pre.lastChild);
         } else if (curLine == line + 1) {
           result.range.setEnd(textNode, curPos - 1);
           found = true;
           break;
         }
       }
     }
   }
   return found || ("range" in result);
 }
 // Toggle long-line wrapping and sets the view_source.wrap_long_lines
 // pref to persist the last state.
 function wrapLongLines()
 {
   var myWrap = window.content.document.body;
   myWrap.classList.toggle("wrap");
   // Since multiple viewsource windows are possible, another window could have
   // affected the pref, so instead of determining the new pref value via the current
   // pref value, we use myWrap.classList.
   Services.prefs.setBoolPref("view_source.wrap_long_lines", myWrap.classList.contains("wrap"));
 }
 // Toggles syntax highlighting and sets the view_source.syntax_highlight
 // pref to persist the last state.
 function highlightSyntax()
 {
   var highlightSyntaxMenu = document.getElementById("menu_highlightSyntax");
   var highlightSyntax = (highlightSyntaxMenu.getAttribute("checked") == "true");
   Services.prefs.setBoolPref("view_source.syntax_highlight", highlightSyntax);
   gPageLoader.loadPage(gPageLoader.currentDescriptor, gPageLoader.DISPLAY_NORMAL);
 }
 // Reload after change to character encoding or autodetection
 //
 // Fix for bug 136322: this function overrides the function in
 // browser.js to call PageLoader.loadPage() instead of BrowserReloadWithFlags()
 function BrowserCharsetReload()
 {
   if (isHistoryEnabled()) {
     gPageLoader.loadPage(gPageLoader.currentDescriptor,
                          gPageLoader.DISPLAY_NORMAL);
   } else {
     gBrowser.reloadWithFlags(Ci.nsIWebNavigation.LOAD_FLAGS_CHARSET_CHANGE);
   }
 }
 function BrowserSetCharacterSet(aEvent)
 {
   if (aEvent.target.hasAttribute("charset"))
     gBrowser.docShell.charset = aEvent.target.getAttribute("charset");
   BrowserCharsetReload();
 }
 function BrowserForward(aEvent) {
   try {
     gBrowser.goForward();
   }
   catch(ex) {
   }
 }
 function BrowserBack(aEvent) {
   try {
     gBrowser.goBack();
   }
   catch(ex) {
   }
 }
 function UpdateBackForwardCommands() {
   var backBroadcaster = document.getElementById("Browser:Back");
   var forwardBroadcaster = document.getElementById("Browser:Forward");
   if (getWebNavigation().canGoBack)
     backBroadcaster.removeAttribute("disabled");
   else
     backBroadcaster.setAttribute("disabled", "true");
   if (getWebNavigation().canGoForward)
     forwardBroadcaster.removeAttribute("disabled");
   else
     forwardBroadcaster.setAttribute("disabled", "true");
 }
 function contextMenuShowing() {
   var isLink = false;
   var isEmail = false;
   if (gContextMenu.triggerNode && gContextMenu.triggerNode.localName == 'a') {
     if (gContextMenu.triggerNode.href.indexOf('view-source:') == 0)
       isLink = true;
     if (gContextMenu.triggerNode.href.indexOf('mailto:') == 0)
       isEmail = true;
   }
   document.getElementById('context-copyLink').hidden = !isLink;
   document.getElementById('context-copyEmail').hidden = !isEmail;
 }
 function contextMenuCopyLinkOrEmail() {
   if (!gContextMenu.triggerNode)
     return;
   var href = gContextMenu.triggerNode.href;
   var clipboard = Cc['@mozilla.org/widget/clipboardhelper;1'].
                   getService(Ci.nsIClipboardHelper);
   clipboard.copyString(href.substring(href.indexOf(':') + 1), document);
 }