pjs/mail/base/content/nsContextMenu.js

569 строки
20 KiB
JavaScript

# -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is Mozilla Communicator client code, released
# March 31, 1998.
#
# The Initial Developer of the Original Code is
# Netscape Communications Corporation.
# Portions created by the Initial Developer are Copyright (C) 1998
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# William A. ("PowerGUI") Law <law@netscape.com>
# Blake Ross <blakeross@telocity.com>
# Gervase Markham <gerv@gerv.net>
# Phil Ringnalda <philringnalda@gmail.com>
#
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK *****
function nsContextMenu(aXulMenu) {
this.target = null;
this.menu = null;
this.onTextInput = false;
this.onImage = false;
this.onLoadedImage = false;
this.onLink = false;
this.onMailtoLink = false;
this.onSaveableLink = false;
this.onMetaDataItem = false;
this.onMathML = false;
this.link = false;
this.linkURL = "";
this.linkURI = null;
this.linkProtocol = null;
this.inFrame = false;
this.hasBGImage = false;
this.isTextSelected = false;
this.inDirList = false;
this.shouldDisplay = true;
this.initMenu(aXulMenu);
}
nsContextMenu.prototype = {
/**
* Init: set properties based on the clicked-on element and the state of
* the world, then determine which context menu items to show based on
* those properties.
*/
initMenu : function CM_initMenu(aPopup) {
this.menu = aPopup;
// Get contextual info.
this.setTarget(document.popupNode);
this.isTextSelected = this.isTextSelection();
this.initItems();
},
initItems : function CM_initItems() {
this.initSaveItems();
this.initClipboardItems();
},
initSaveItems : function CM_initSaveItems() {
this.showItem("context-savelink", this.onSaveableLink);
this.showItem("context-saveimage", this.onLoadedImage);
},
initClipboardItems : function CM_initClipboardItems() {
// Copy depends on whether there is selected text.
// Enabling this context menu item is now done through the global
// command updating system.
goUpdateGlobalEditMenuItems();
this.showItem("context-copy", this.isTextSelected || this.onTextInput);
this.showItem("context-selectall", true);
this.showItem("context-copyemail", this.onMailtoLink);
this.showItem("context-copylink", this.onLink);
this.showItem("context-copyimage", this.onImage);
},
/**
* Set the nsContextMenu properties based on the selected node and
* its ancestors.
*/
setTarget : function CM_setTarget(aNode) {
const xulNS =
"http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
if (aNode.namespaceURI == xulNS) {
this.shouldDisplay = false;
return;
}
this.onImage = false;
this.onLoadedImage = false;
this.onMetaDataItem = false;
this.onTextInput = false;
this.imageURL = "";
this.onLink = false;
this.linkURL = "";
this.linkURI = null;
this.linkProtocol = null;
this.onMathML = false;
this.inFrame = false;
this.hasBGImage = false;
this.bgImageURL = "";
this.target = aNode;
// First, do checks for nodes that never have children.
if (this.target.nodeType == Node.ELEMENT_NODE) {
if (this.target instanceof Components.interfaces.nsIImageLoadingContent &&
this.target.currentURI) {
this.onImage = true;
this.onMetaDataItem = true;
var request = this.target.getRequest(Components.interfaces.nsIImageLoadingContent.CURRENT_REQUEST);
if (request && (request.imageStatus & request.STATUS_SIZE_AVAILABLE))
this.onLoadedImage = true;
this.imageURL = this.target.currentURI.spec;
} else if (this.target instanceof HTMLInputElement) {
this.onTextInput = this.isTargetATextBox(this.target);
} else if (this.target instanceof HTMLTextAreaElement) {
this.onTextInput = true;
} else if (this.target instanceof HTMLHtmlElement) {
var bodyElt = this.target.ownerDocument.body;
if (bodyElt) {
var computedURL = this.getComputedURL(bodyElt, "background-image");
if (computedURL) {
this.hasBGImage = true;
this.bgImageURL = this.makeURLAbsolute(bodyElt.baseURI,
computedURL);
}
}
} else if ("HTTPIndex" in content &&
content.HTTPIndex instanceof Components.interfaces.nsIHTTPIndex) {
this.inDirList = true;
// Bubble outward till we get to an element with URL attribute
// (which should be the href).
var root = this.target;
while (root && !this.link) {
if (root.tagName == "tree") {
// Hit root of tree; must have clicked in empty space;
// thus, no link.
break;
}
if (root.getAttribute("URL")) {
// Build pseudo link object so link-related functions work.
this.onLink = true;
this.link = { href : root.getAttribute("URL"),
getAttribute: function (aAttr) {
if (aAttr == "title") {
return root.firstChild.firstChild
.getAttribute("label");
}
return "";
}
};
// If element is a directory, then you can't save it.
this.onSaveableLink = root.getAttribute("container") != "true";
} else {
root = root.parentNode;
}
}
}
}
// Second, bubble out, looking for items of interest that might be
// parents of the click target, picking the innermost of each.
const XMLNS = "http://www.w3.org/XML/1998/namespace";
var elem = this.target;
while (elem) {
if (elem.nodeType == Node.ELEMENT_NODE) {
// Link?
if (!this.onLink &&
((elem instanceof HTMLAnchorElement && elem.href) ||
elem instanceof HTMLAreaElement && elem.href ||
elem instanceof HTMLLinkElement ||
elem.getAttributeNS("http://www.w3.org/1999/xlink", "type") == "simple")) {
// Target is a link or a descendant of a link.
this.onLink = true;
this.onMetaDataItem = true;
// Remember corresponding element.
this.link = elem;
this.linkURL = this.getLinkURL();
this.linkURI = this.getLinkURI();
this.linkProtocol = this.getLinkProtocol();
this.onMailtoLink = (this.linkProtocol == "mailto");
this.onSaveableLink = this.isLinkSaveable();
}
// Text input?
if (!this.onTextInput) {
this.onTextInput = this.isTargetATextBox(elem);
}
// Metadata item?
if (!this.onMetaDataItem) {
if ((elem instanceof HTMLQuoteElement && elem.cite) ||
(elem instanceof HTMLTableElement && elem.summary) ||
(elem instanceof HTMLModElement &&
(elem.cite || elem.dateTime)) ||
(elem instanceof HTMLElement &&
(elem.title || elem.lang)) ||
(elem.getAttributeNS(XMLNS, "lang"))) {
this.onMetaDataItem = true;
}
}
// Background image? Don't bother if we've already found a
// background image further down the hierarchy. Otherwise,
// we look for the computed background-image style.
if (!this.hasBGImage) {
var bgImgUrl = this.getComputedURL(elem, "background-image");
if (bgImgUrl) {
this.hasBGImage = true;
this.bgImageURL = this.makeURLAbsolute(elem.baseURI, bgImgUrl);
}
}
}
elem = elem.parentNode;
}
// See if the user clicked on MathML.
const NS_MathML = "http://www.w3.org/1998/Math/MathML";
if ((this.target.nodeType == Node.TEXT_NODE &&
this.target.parentNode.namespaceURI == NS_MathML) ||
(this.target.namespaceURI == NS_MathML))
this.onMathML = true;
// See if the user clicked in a frame.
if (this.target.ownerDocument != window.content.document) {
this.inFrame = true;
}
},
/**
* Get a computed style property for an element.
* @param aElem
* A DOM node
* @param aProp
* The desired CSS property
* @return the value of the property
*/
getComputedStyle: function CM_getComputedStyle(aElem, aProp) {
return aElem.ownerDocument.defaultView.getComputedStyle(aElem, "")
.getPropertyValue(aProp);
},
/**
* Generate a URL string from a computed style property, for things like
* |style="background-image:url(...)"|
* @return a "url"-type computed style attribute value, with the "url(" and
* ")" stripped.
*/
getComputedURL: function CM_getComputedURL(aElem, aProp) {
var url = aElem.ownerDocument.defaultView.getComputedStyle(aElem, "")
.getPropertyCSSValue(aProp);
return (url.primitiveType == CSSPrimitiveValue.CSS_URI) ? url.getStringValue() : null;
},
/**
* Determine whether the clicked-on link can be saved, and whether it
* may be saved according to the ScriptSecurityManager.
* @return true if the protocol can be persisted and if the target has
* permission to link to the URL, false if not
*/
isLinkSaveable : function CM_isLinkSaveable() {
try {
const nsIScriptSecurityManager =
Components.interfaces.nsIScriptSecurityManager;
var secMan = Components.classes["@mozilla.org/scriptsecuritymanager;1"]
.getService(nsIScriptSecurityManager);
secMan.checkLoadURIWithPrincipal(this.target.nodePrincipal, this.linkURI,
nsIScriptSecurityManager.STANDARD);
} catch (e) {
// Don't save things we can't link to.
return false;
}
// We don't do the Right Thing for news/snews yet, so turn them off
// until we do.
return this.linkProtocol && !(
this.linkProtocol == "mailto" ||
this.linkProtocol == "javascript" ||
this.linkProtocol == "news" ||
this.linkProtocol == "snews");
},
/**
* Save URL of clicked-on link.
*/
saveLink : function CM_saveLink() {
saveURL(this.linkURL, this.linkText(), null, true);
},
/**
* Save a clicked-on image.
*/
saveImage : function CM_saveImage() {
saveURL(this.imageURL, null, "SaveImageTitle", false);
},
/**
* Extract email addresses from a mailto: link and put them on the
* clipboard.
*/
copyEmail : function CM_copyEmail() {
// Copy the comma-separated list of email addresses only.
// There are other ways of embedding email addresses in a mailto:
// link, but such complex parsing is beyond us.
const kMailToLength = 7; // length of "mailto:"
var url = this.linkURL;
var qmark = url.indexOf("?");
var addresses;
if (qmark > kMailToLength) {
addresses = url.substring(kMailToLength, qmark);
} else {
addresses = url.substr(kMailToLength);
}
// Let's try to unescape it using a character set.
try {
var characterSet = this.target.ownerDocument.characterSet;
const textToSubURI = Components.classes["@mozilla.org/intl/texttosuburi;1"]
.getService(Components.interfaces.nsITextToSubURI);
addresses = textToSubURI.unEscapeURIForUI(characterSet, addresses);
}
catch(ex) {
// Do nothing.
}
var clipboard = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
.getService(Components.interfaces.nsIClipboardHelper);
clipboard.copyString(addresses);
},
///////////////
// Utilities //
///////////////
/**
* Set a DOM node's hidden property by passing in the node's id or the
* element itself.
* @param aItemOrId
* a DOM node or the id of a DOM node
* @param aShow
* true to show, false to hide
*/
showItem : function CM_showItem(aItemOrId, aShow) {
var item = aItemOrId.constructor == String ? document.getElementById(aItemOrId) : aItemOrId;
if (item)
item.hidden = !aShow;
},
/**
* Set given attribute of specified context-menu item. If the
* value is null, then it removes the attribute (which works
* nicely for the disabled attribute).
* @param aId
* The id of an element
* @param aAttr
* The attribute name
* @param aVal
* The value to set the attribute to, or null to remove the attribute
*/
setItemAttr : function CM_setItemAttr(aId, aAttr, aVal) {
var elem = document.getElementById(aId);
if (elem) {
if (aVal == null) {
// null indicates attr should be removed.
elem.removeAttribute(aAttr);
} else {
// Set attr=val.
elem.setAttribute(aAttr, aVal);
}
}
},
/**
* Get an absolute URL for clicked-on link, from the href property or by
* resolving an XLink URL by hand.
* @return the string absolute URL for the clicked-on link
*/
getLinkURL : function CM_getLinkURL() {
if (this.link.href) {
return this.link.href;
}
var href = this.link.getAttributeNS("http://www.w3.org/1999/xlink","href");
if (!href || !href.match(/\S/)) {
// Without this we try to save as the current doc,
// for example, HTML case also throws if empty.
throw "Empty href";
}
href = this.makeURLAbsolute(this.link.baseURI,href);
return href;
},
/**
* Generate a URI object from the linkURL spec
* @return an nsIURI if possible, or null if not
*/
getLinkURI: function CM_getLinkURI() {
var ioService = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
try {
return ioService.newURI(this.linkURL, null, null);
} catch (ex) {
// e.g. empty URL string
}
return null;
},
/**
* Get the scheme for the clicked-on linkURI, if present.
* @return a scheme, possibly undefined, or null if there's no linkURI
*/
getLinkProtocol: function CM_getLinkProtocol() {
if (this.linkURI)
return this.linkURI.scheme; // can be |undefined|
return null;
},
/**
* Get some text, any text, for the clicked-on link.
* @return the link text, title, alt, href, or "" if everything fails
*/
linkText : function CM_linkText() {
var text = gatherTextUnder(this.link);
if (!text || !text.match(/\S/)) {
text = this.link.getAttribute("title");
if (!text || !text.match(/\S/)) {
text = this.link.getAttribute("alt");
if (!text || !text.match(/\S/)) {
if (this.link.href) {
text = this.link.href;
} else {
text = getAttributeNS("http://www.w3.org/1999/xlink", "href");
if (text && text.match(/\S/)) {
text = this.makeURLAbsolute(this.link.baseURI, text);
}
}
}
}
}
return text;
},
/**
* Determines whether the focused window has selected text, and if so
* formats the first 15 characters for the label of the context-searchselect
* element according to the searchText string.
* @return true if there is selected text, false if not
*/
isTextSelection : function CM_isTextSelection() {
var result = false;
var selection = this.searchSelected();
if (selection != "") {
var searchSelectText = selection.toString();
if (searchSelectText.length > 15)
searchSelectText = searchSelectText.substr(0,15) + "...";
result = true;
// Format "Search for <selection>" string to show in menu.
var sbs = Components.classes["@mozilla.org/intl/stringbundle;1"]
.getService(Components.interfaces.nsIStringBundleService);
var bundle = sbs.createBundle("chrome://communicator/locale/contentAreaCommands.properties");
searchSelectText = bundle.formatStringFromName("searchText",
[searchSelectText], 1);
this.setItemAttr("context-searchselect", "label", searchSelectText);
}
return result;
},
/**
* Get the currently selected text, with whitespace trimmed and
* newlines and tabs converted to spaces.
* @return the selection as a searchable string
*/
searchSelected : function CM_searchSelected() {
var focusedWindow = document.commandDispatcher.focusedWindow;
var searchStr = focusedWindow.getSelection();
searchStr = searchStr.toString();
searchStr = searchStr.replace(/^\s+/, "");
searchStr = searchStr.replace(/(\n|\r|\t)+/g, " ");
searchStr = searchStr.replace(/\s+$/,"");
return searchStr;
},
/**
* Convert relative URL to absolute, using a provided <base>.
* @param aBase
* The URL string to use as the base
* @param aUrl
* The possibly-relative URL string
* @return The string absolute URL
*/
makeURLAbsolute : function CM_makeURLAbsolute(aBase, aUrl) {
// Construct nsIURL.
var ioService = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
var baseURI = ioService.newURI(aBase, null, null);
return ioService.newURI(baseURI.resolve(aUrl), null, null).spec;
},
/**
* Determine whether a DOM node is a text or password input, or a textarea.
* @param aNode
* The DOM node to check
* @return true for textboxes, false for other elements
*/
isTargetATextBox : function CM_isTargetATextBox(aNode) {
if (aNode instanceof HTMLInputElement)
return (aNode.type == "text" || aNode.type == "password");
return (aNode instanceof HTMLTextAreaElement);
},
/**
* Determine whether a separator should be shown based on whether
* there are any non-hidden items between it and the previous separator.
* @param aSeparatorID
* The id of the separator element
* @return true if the separator should be shown, false if not
*/
shouldShowSeparator : function CM_shouldShowSeparator(aSeparatorID) {
var separator = document.getElementById(aSeparatorID);
if (separator) {
var sibling = separator.previousSibling;
while (sibling && sibling.localName != "menuseparator") {
if (sibling.getAttribute("hidden") != "true")
return true;
sibling = sibling.previousSibling;
}
}
return false;
}
};