353 lines
13 KiB
JavaScript
353 lines
13 KiB
JavaScript
/* -*- indent-tabs-mode: nil; js-indent-level: 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/. */
|
|
|
|
/**
|
|
* The Feed Handler object manages discovery of RSS/ATOM feeds in web pages
|
|
* and shows UI when they are discovered.
|
|
*/
|
|
var FeedHandler = {
|
|
/** Called when the user clicks on the Subscribe to This Page... menu item,
|
|
* or when the user clicks the feed button when the page contains multiple
|
|
* feeds.
|
|
* Builds a menu of unique feeds associated with the page, and if there
|
|
* is only one, shows the feed inline in the browser window.
|
|
* @param container
|
|
* The feed list container (menupopup or subview) to be populated.
|
|
* @param isSubview
|
|
* Whether we're creating a subview (true) or menu (false/undefined)
|
|
* @return true if the menu/subview should be shown, false if there was only
|
|
* one feed and the feed should be shown inline in the browser
|
|
* window (do not show the menupopup/subview).
|
|
*/
|
|
buildFeedList(container, isSubview) {
|
|
let feeds = gBrowser.selectedBrowser.feeds;
|
|
if (!isSubview && feeds == null) {
|
|
// XXX hack -- menu opening depends on setting of an "open"
|
|
// attribute, and the menu refuses to open if that attribute is
|
|
// set (because it thinks it's already open). onpopupshowing gets
|
|
// called after the attribute is unset, and it doesn't get unset
|
|
// if we return false. so we unset it here; otherwise, the menu
|
|
// refuses to work past this point.
|
|
container.parentNode.removeAttribute("open");
|
|
return false;
|
|
}
|
|
|
|
for (let i = container.childNodes.length - 1; i >= 0; --i) {
|
|
let node = container.childNodes[i];
|
|
if (isSubview && node.localName == "label")
|
|
continue;
|
|
container.removeChild(node);
|
|
}
|
|
|
|
if (!feeds || feeds.length <= 1)
|
|
return false;
|
|
|
|
// Build the menu showing the available feed choices for viewing.
|
|
let itemNodeType = isSubview ? "toolbarbutton" : "menuitem";
|
|
for (let feedInfo of feeds) {
|
|
let item = document.createElement(itemNodeType);
|
|
let baseTitle = feedInfo.title || feedInfo.href;
|
|
let labelStr = gNavigatorBundle.getFormattedString("feedShowFeedNew", [baseTitle]);
|
|
item.setAttribute("label", labelStr);
|
|
item.setAttribute("feed", feedInfo.href);
|
|
item.setAttribute("tooltiptext", feedInfo.href);
|
|
item.setAttribute("crop", "center");
|
|
let className = "feed-" + itemNodeType;
|
|
if (isSubview) {
|
|
className += " subviewbutton";
|
|
}
|
|
item.setAttribute("class", className);
|
|
container.appendChild(item);
|
|
}
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Subscribe to a given feed. Called when
|
|
* 1. Page has a single feed and user clicks feed icon in location bar
|
|
* 2. Page has a single feed and user selects Subscribe menu item
|
|
* 3. Page has multiple feeds and user selects from feed icon popup (or subview)
|
|
* 4. Page has multiple feeds and user selects from Subscribe submenu
|
|
* @param href
|
|
* The feed to subscribe to. May be null, in which case the
|
|
* event target's feed attribute is examined.
|
|
* @param event
|
|
* The event this method is handling. Used to decide where
|
|
* to open the preview UI. (Optional, unless href is null)
|
|
*/
|
|
subscribeToFeed(href, event) {
|
|
// Just load the feed in the content area to either subscribe or show the
|
|
// preview UI
|
|
if (!href)
|
|
href = event.target.getAttribute("feed");
|
|
urlSecurityCheck(href, gBrowser.contentPrincipal,
|
|
Ci.nsIScriptSecurityManager.DISALLOW_INHERIT_PRINCIPAL);
|
|
let feedURI = makeURI(href, document.characterSet);
|
|
// Use the feed scheme so X-Moz-Is-Feed will be set
|
|
// The value doesn't matter
|
|
if (/^https?$/.test(feedURI.scheme))
|
|
href = "feed:" + href;
|
|
this.loadFeed(href, event);
|
|
},
|
|
|
|
loadFeed(href, event) {
|
|
let feeds = gBrowser.selectedBrowser.feeds;
|
|
try {
|
|
openUILink(href, event, { ignoreAlt: true });
|
|
}
|
|
finally {
|
|
// We might default to a livebookmarks modal dialog,
|
|
// so reset that if the user happens to click it again
|
|
gBrowser.selectedBrowser.feeds = feeds;
|
|
}
|
|
},
|
|
|
|
get _feedMenuitem() {
|
|
delete this._feedMenuitem;
|
|
return this._feedMenuitem = document.getElementById("singleFeedMenuitemState");
|
|
},
|
|
|
|
get _feedMenupopup() {
|
|
delete this._feedMenupopup;
|
|
return this._feedMenupopup = document.getElementById("multipleFeedsMenuState");
|
|
},
|
|
|
|
/**
|
|
* Update the browser UI to show whether or not feeds are available when
|
|
* a page is loaded or the user switches tabs to a page that has feeds.
|
|
*/
|
|
updateFeeds() {
|
|
if (this._updateFeedTimeout)
|
|
clearTimeout(this._updateFeedTimeout);
|
|
|
|
let feeds = gBrowser.selectedBrowser.feeds;
|
|
let haveFeeds = feeds && feeds.length > 0;
|
|
|
|
let feedButton = document.getElementById("feed-button");
|
|
if (feedButton) {
|
|
if (haveFeeds) {
|
|
feedButton.removeAttribute("disabled");
|
|
} else {
|
|
feedButton.setAttribute("disabled", "true");
|
|
}
|
|
}
|
|
|
|
if (!haveFeeds) {
|
|
this._feedMenuitem.setAttribute("disabled", "true");
|
|
this._feedMenuitem.removeAttribute("hidden");
|
|
this._feedMenupopup.setAttribute("hidden", "true");
|
|
return;
|
|
}
|
|
|
|
if (feeds.length > 1) {
|
|
this._feedMenuitem.setAttribute("hidden", "true");
|
|
this._feedMenupopup.removeAttribute("hidden");
|
|
} else {
|
|
this._feedMenuitem.setAttribute("feed", feeds[0].href);
|
|
this._feedMenuitem.removeAttribute("disabled");
|
|
this._feedMenuitem.removeAttribute("hidden");
|
|
this._feedMenupopup.setAttribute("hidden", "true");
|
|
}
|
|
},
|
|
|
|
addFeed(link, browserForLink) {
|
|
if (!browserForLink.feeds)
|
|
browserForLink.feeds = [];
|
|
|
|
browserForLink.feeds.push({ href: link.href, title: link.title });
|
|
|
|
// If this addition was for the current browser, update the UI. For
|
|
// background browsers, we'll update on tab switch.
|
|
if (browserForLink == gBrowser.selectedBrowser) {
|
|
// Batch updates to avoid updating the UI for multiple onLinkAdded events
|
|
// fired within 100ms of each other.
|
|
if (this._updateFeedTimeout)
|
|
clearTimeout(this._updateFeedTimeout);
|
|
this._updateFeedTimeout = setTimeout(this.updateFeeds.bind(this), 100);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Get the human-readable display name of a file. This could be the
|
|
* application name.
|
|
* @param file
|
|
* A nsIFile to look up the name of
|
|
* @return The display name of the application represented by the file.
|
|
*/
|
|
_getFileDisplayName(file) {
|
|
switch (AppConstants.platform) {
|
|
case "win":
|
|
if (file instanceof Ci.nsILocalFileWin) {
|
|
try {
|
|
return file.getVersionInfoField("FileDescription");
|
|
} catch (e) {}
|
|
}
|
|
break;
|
|
case "macosx":
|
|
if (file instanceof Ci.nsILocalFileMac) {
|
|
try {
|
|
return file.bundleDisplayName;
|
|
} catch (e) {}
|
|
}
|
|
break;
|
|
}
|
|
|
|
return file.leafName;
|
|
},
|
|
|
|
chooseClientApp(aTitle, aPrefName, aBrowser) {
|
|
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
|
|
|
|
fp.init(window, aTitle, Ci.nsIFilePicker.modeOpen);
|
|
fp.appendFilters(Ci.nsIFilePicker.filterApps);
|
|
|
|
fp.open((aResult) => {
|
|
if (aResult == Ci.nsIFilePicker.returnOK) {
|
|
let selectedApp = fp.file;
|
|
if (selectedApp) {
|
|
// XXXben - we need to compare this with the running instance
|
|
// executable just don't know how to do that via script
|
|
// XXXmano TBD: can probably add this to nsIShellService
|
|
let appName = "";
|
|
switch (AppConstants.platform) {
|
|
case "win":
|
|
appName = AppConstants.MOZ_APP_NAME + ".exe";
|
|
break;
|
|
case "macosx":
|
|
appName = AppConstants.MOZ_MACBUNDLE_NAME;
|
|
break;
|
|
default:
|
|
appName = AppConstants.MOZ_APP_NAME + "-bin";
|
|
break;
|
|
}
|
|
|
|
if (fp.file.leafName != appName) {
|
|
Services.prefs.setComplexValue(aPrefName, Ci.nsILocalFile, selectedApp);
|
|
aBrowser.messageManager.sendAsyncMessage("FeedWriter:SetApplicationLauncherMenuItem",
|
|
{ name: this._getFileDisplayName(selectedApp),
|
|
type: "SelectedAppMenuItem" });
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
},
|
|
|
|
executeClientApp(aSpec, aTitle, aSubtitle, aFeedHandler) {
|
|
// aFeedHandler is either "default", indicating the system default reader, or a pref-name containing
|
|
// an nsILocalFile pointing to the feed handler's executable.
|
|
|
|
let clientApp = null;
|
|
if (aFeedHandler == "default") {
|
|
clientApp = Cc["@mozilla.org/browser/shell-service;1"]
|
|
.getService(Ci.nsIShellService)
|
|
.defaultFeedReader;
|
|
} else {
|
|
clientApp = Services.prefs.getComplexValue(aFeedHandler, Ci.nsILocalFile);
|
|
}
|
|
|
|
// For the benefit of applications that might know how to deal with more
|
|
// URLs than just feeds, send feed: URLs in the following format:
|
|
//
|
|
// http urls: replace scheme with feed, e.g.
|
|
// http://foo.com/index.rdf -> feed://foo.com/index.rdf
|
|
// other urls: prepend feed: scheme, e.g.
|
|
// https://foo.com/index.rdf -> feed:https://foo.com/index.rdf
|
|
let feedURI = NetUtil.newURI(aSpec);
|
|
if (feedURI.schemeIs("http")) {
|
|
feedURI.scheme = "feed";
|
|
aSpec = feedURI.spec;
|
|
} else {
|
|
aSpec = "feed:" + aSpec;
|
|
}
|
|
|
|
// Retrieving the shell service might fail on some systems, most
|
|
// notably systems where GNOME is not installed.
|
|
try {
|
|
let ss = Cc["@mozilla.org/browser/shell-service;1"]
|
|
.getService(Ci.nsIShellService);
|
|
ss.openApplicationWithURI(clientApp, aSpec);
|
|
} catch(e) {
|
|
// If we couldn't use the shell service, fallback to using a
|
|
// nsIProcess instance
|
|
let p = Cc["@mozilla.org/process/util;1"]
|
|
.createInstance(Ci.nsIProcess);
|
|
p.init(clientApp);
|
|
p.run(false, [aSpec], 1);
|
|
}
|
|
},
|
|
|
|
init() {
|
|
window.messageManager.addMessageListener("FeedWriter:ChooseClientApp", this);
|
|
window.messageManager.addMessageListener("FeedWriter:RequestClientAppName", this);
|
|
window.messageManager.addMessageListener("FeedWriter:SetFeedCharPref", this);
|
|
window.messageManager.addMessageListener("FeedWriter:SetFeedComplexString", this);
|
|
window.messageManager.addMessageListener("FeedWriter:ShownFirstRun", this);
|
|
|
|
Services.ppmm.addMessageListener("FeedConverter:ExecuteClientApp", this);
|
|
},
|
|
|
|
uninit() {
|
|
Services.ppmm.removeMessageListener("FeedConverter:ExecuteClientApp", this);
|
|
},
|
|
|
|
receiveMessage(msg) {
|
|
switch (msg.name) {
|
|
case "FeedWriter:ChooseClientApp":
|
|
this.chooseClientApp(msg.data.title, msg.data.prefName, msg.target);
|
|
break;
|
|
case "FeedWriter:RequestClientAppName":
|
|
let selectedClientApp;
|
|
try {
|
|
selectedClientApp = Services.prefs.getComplexValue(msg.data.feedTypePref, Ci.nsILocalFile);
|
|
} catch (ex) {
|
|
// Just do nothing, then we won't bother populating
|
|
}
|
|
|
|
let defaultClientApp = null;
|
|
try {
|
|
// This can sometimes not exist
|
|
defaultClientApp = Cc["@mozilla.org/browser/shell-service;1"]
|
|
.getService(Ci.nsIShellService)
|
|
.defaultFeedReader;
|
|
} catch(ex) {
|
|
// Just do nothing, then we don't bother populating
|
|
}
|
|
|
|
if (selectedClientApp && selectedClientApp.exists()) {
|
|
if (defaultClientApp && selectedClientApp.path != defaultClientApp.path) {
|
|
// Only set the default menu item if it differs from the selected one
|
|
msg.target.messageManager
|
|
.sendAsyncMessage("FeedWriter:SetApplicationLauncherMenuItem",
|
|
{ name: this._getFileDisplayName(defaultClientApp),
|
|
type: "DefaultAppMenuItem" });
|
|
}
|
|
msg.target.messageManager
|
|
.sendAsyncMessage("FeedWriter:SetApplicationLauncherMenuItem",
|
|
{ name: this._getFileDisplayName(selectedClientApp),
|
|
type: "SelectedAppMenuItem" });
|
|
}
|
|
break;
|
|
case "FeedWriter:ShownFirstRun":
|
|
Services.prefs.setBoolPref("browser.feeds.showFirstRunUI", false);
|
|
break;
|
|
case "FeedWriter:SetFeedCharPref":
|
|
Services.prefs.setCharPref(msg.data.pref, msg.data.value);
|
|
break;
|
|
case "FeedWriter:SetFeedComplexString": {
|
|
let supportsString = Cc["@mozilla.org/supports-string;1"].
|
|
createInstance(Ci.nsISupportsString);
|
|
supportsString.data = msg.data.value;
|
|
Services.prefs.setComplexValue(msg.data.pref, Ci.nsISupportsString, supportsString);
|
|
break;
|
|
}
|
|
case "FeedConverter:ExecuteClientApp":
|
|
this.executeClientApp(msg.data.spec, msg.data.title,
|
|
msg.data.subtitle, msg.data.feedHandler);
|
|
break;
|
|
}
|
|
},
|
|
};
|