336 lines
11 KiB
JavaScript
336 lines
11 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/. */
|
|
"use strict";
|
|
|
|
this.EXPORTED_SYMBOLS = ["ReaderMode"];
|
|
|
|
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
|
|
|
|
// Constants for telemetry.
|
|
const DOWNLOAD_SUCCESS = 0;
|
|
const DOWNLOAD_ERROR_XHR = 1;
|
|
const DOWNLOAD_ERROR_NO_DOC = 2;
|
|
|
|
const PARSE_SUCCESS = 0;
|
|
const PARSE_ERROR_TOO_MANY_ELEMENTS = 1;
|
|
const PARSE_ERROR_WORKER = 2;
|
|
const PARSE_ERROR_NO_ARTICLE = 3;
|
|
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
|
|
Cu.importGlobalProperties(["XMLHttpRequest"]);
|
|
|
|
XPCOMUtils.defineLazyModuleGetter(this, "CommonUtils", "resource://services-common/utils.js");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "OS", "resource://gre/modules/osfile.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "ReaderWorker", "resource://gre/modules/reader/ReaderWorker.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "Task", "resource://gre/modules/Task.jsm");
|
|
//XPCOMUtils.defineLazyModuleGetter(this, "TelemetryStopwatch", "resource://gre/modules/TelemetryStopwatch.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "Readerable", "resource://gre/modules/Readerable.jsm");
|
|
|
|
this.ReaderMode = {
|
|
// Version of the cache schema.
|
|
CACHE_VERSION: 1,
|
|
|
|
DEBUG: 0,
|
|
|
|
/**
|
|
* Returns original URL from an about:reader URL.
|
|
*
|
|
* @param url An about:reader URL.
|
|
* @return The original URL for the article, or null if we did not find
|
|
* a properly formatted about:reader URL.
|
|
*/
|
|
getOriginalUrl: function(url) {
|
|
if (!url.startsWith("about:reader?")) {
|
|
return null;
|
|
}
|
|
|
|
let searchParams = new URLSearchParams(url.substring("about:reader?".length));
|
|
if (!searchParams.has("url")) {
|
|
return null;
|
|
}
|
|
let encodedURL = searchParams.get("url");
|
|
try {
|
|
return decodeURIComponent(encodedURL);
|
|
} catch (e) {
|
|
Cu.reportError("Error decoding original URL: " + e);
|
|
return encodedURL;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Gets an article from a loaded browser's document. This method will not attempt
|
|
* to parse certain URIs (e.g. about: URIs).
|
|
*
|
|
* @param doc A document to parse.
|
|
* @return {Promise}
|
|
* @resolves JS object representing the article, or null if no article is found.
|
|
*/
|
|
parseDocument: Task.async(function* (doc) {
|
|
let uri = Services.io.newURI(doc.documentURI, null, null);
|
|
if (!Readerable.shouldCheckUri(uri)) {
|
|
this.log("Reader mode disabled for URI");
|
|
return null;
|
|
}
|
|
|
|
return yield this._readerParse(uri, doc);
|
|
}),
|
|
|
|
/**
|
|
* Downloads and parses a document from a URL.
|
|
*
|
|
* @param url URL to download and parse.
|
|
* @return {Promise}
|
|
* @resolves JS object representing the article, or null if no article is found.
|
|
*/
|
|
downloadAndParseDocument: Task.async(function* (url) {
|
|
let uri = Services.io.newURI(url, null, null);
|
|
//TelemetryStopwatch.start("READER_MODE_DOWNLOAD_MS");
|
|
let doc = yield this._downloadDocument(url).catch(e => {
|
|
//TelemetryStopwatch.finish("READER_MODE_DOWNLOAD_MS");
|
|
throw e;
|
|
});
|
|
//TelemetryStopwatch.finish("READER_MODE_DOWNLOAD_MS");
|
|
return yield this._readerParse(uri, doc);
|
|
}),
|
|
|
|
_downloadDocument: function (url) {
|
|
let histogram = Services.telemetry.getHistogramById("READER_MODE_DOWNLOAD_RESULT");
|
|
return new Promise((resolve, reject) => {
|
|
let xhr = new XMLHttpRequest();
|
|
xhr.open("GET", url, true);
|
|
xhr.onerror = evt => reject(evt.error);
|
|
xhr.responseType = "document";
|
|
xhr.onload = evt => {
|
|
if (xhr.status !== 200) {
|
|
reject("Reader mode XHR failed with status: " + xhr.status);
|
|
histogram.add(DOWNLOAD_ERROR_XHR);
|
|
return;
|
|
}
|
|
|
|
let doc = xhr.responseXML;
|
|
if (!doc) {
|
|
reject("Reader mode XHR didn't return a document");
|
|
histogram.add(DOWNLOAD_ERROR_NO_DOC);
|
|
return;
|
|
}
|
|
|
|
// Manually follow a meta refresh tag if one exists.
|
|
let meta = doc.querySelector("meta[http-equiv=refresh]");
|
|
if (meta) {
|
|
let content = meta.getAttribute("content");
|
|
if (content) {
|
|
let urlIndex = content.toUpperCase().indexOf("URL=");
|
|
if (urlIndex > -1) {
|
|
let url = content.substring(urlIndex + 4);
|
|
let ssm = Services.scriptSecurityManager;
|
|
let flags = ssm.LOAD_IS_AUTOMATIC_DOCUMENT_REPLACEMENT |
|
|
ssm.DISALLOW_INHERIT_PRINCIPAL;
|
|
try {
|
|
ssm.checkLoadURIStrWithPrincipal(doc.nodePrincipal, url, flags);
|
|
} catch (ex) {
|
|
let errorMsg = "Reader mode disallowed meta refresh (reason: " + ex + ").";
|
|
|
|
if (Services.prefs.getBoolPref("reader.errors.includeURLs"))
|
|
errorMsg += " Refresh target URI: '" + url + "'.";
|
|
reject(errorMsg);
|
|
return;
|
|
}
|
|
// Otherwise, pass an object indicating our new URL:
|
|
reject({newURL: url});
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
let responseURL = xhr.responseURL;
|
|
let givenURL = url;
|
|
// Convert these to real URIs to make sure the escaping (or lack
|
|
// thereof) is identical:
|
|
try {
|
|
responseURL = Services.io.newURI(responseURL, null, null).spec;
|
|
} catch (ex) { /* Ignore errors - we'll use what we had before */ }
|
|
try {
|
|
givenURL = Services.io.newURI(givenURL, null, null).spec;
|
|
} catch (ex) { /* Ignore errors - we'll use what we had before */ }
|
|
|
|
if (responseURL != givenURL) {
|
|
// We were redirected without a meta refresh tag.
|
|
// Force redirect to the correct place:
|
|
reject({newURL: xhr.responseURL});
|
|
return;
|
|
}
|
|
resolve(doc);
|
|
histogram.add(DOWNLOAD_SUCCESS);
|
|
}
|
|
xhr.send();
|
|
});
|
|
},
|
|
|
|
|
|
/**
|
|
* Retrieves an article from the cache given an article URI.
|
|
*
|
|
* @param url The article URL.
|
|
* @return {Promise}
|
|
* @resolves JS object representing the article, or null if no article is found.
|
|
* @rejects OS.File.Error
|
|
*/
|
|
getArticleFromCache: Task.async(function* (url) {
|
|
let path = this._toHashedPath(url);
|
|
try {
|
|
let array = yield OS.File.read(path);
|
|
return JSON.parse(new TextDecoder().decode(array));
|
|
} catch (e) {
|
|
if (!(e instanceof OS.File.Error) || !e.becauseNoSuchFile)
|
|
throw e;
|
|
return null;
|
|
}
|
|
}),
|
|
|
|
/**
|
|
* Stores an article in the cache.
|
|
*
|
|
* @param article JS object representing article.
|
|
* @return {Promise}
|
|
* @resolves When the article is stored.
|
|
* @rejects OS.File.Error
|
|
*/
|
|
storeArticleInCache: Task.async(function* (article) {
|
|
let array = new TextEncoder().encode(JSON.stringify(article));
|
|
let path = this._toHashedPath(article.url);
|
|
yield this._ensureCacheDir();
|
|
yield OS.File.writeAtomic(path, array, { tmpPath: path + ".tmp" });
|
|
}),
|
|
|
|
/**
|
|
* Removes an article from the cache given an article URI.
|
|
*
|
|
* @param url The article URL.
|
|
* @return {Promise}
|
|
* @resolves When the article is removed.
|
|
* @rejects OS.File.Error
|
|
*/
|
|
removeArticleFromCache: Task.async(function* (url) {
|
|
let path = this._toHashedPath(url);
|
|
yield OS.File.remove(path);
|
|
}),
|
|
|
|
log: function(msg) {
|
|
if (this.DEBUG)
|
|
dump("Reader: " + msg);
|
|
},
|
|
|
|
/**
|
|
* Attempts to parse a document into an article. Heavy lifting happens
|
|
* in readerWorker.js.
|
|
*
|
|
* @param uri The article URI.
|
|
* @param doc The document to parse.
|
|
* @return {Promise}
|
|
* @resolves JS object representing the article, or null if no article is found.
|
|
*/
|
|
_readerParse: Task.async(function* (uri, doc) {
|
|
//let histogram = Services.telemetry.getHistogramById("READER_MODE_PARSE_RESULT");
|
|
if (this.parseNodeLimit) {
|
|
let numTags = doc.getElementsByTagName("*").length;
|
|
if (numTags > this.parseNodeLimit) {
|
|
this.log("Aborting parse for " + uri.spec + "; " + numTags + " elements found");
|
|
//histogram.add(PARSE_ERROR_TOO_MANY_ELEMENTS);
|
|
return null;
|
|
}
|
|
}
|
|
|
|
let { documentURI } = doc;
|
|
let uriParam = {
|
|
spec: uri.spec,
|
|
host: uri.host,
|
|
prePath: uri.prePath,
|
|
scheme: uri.scheme,
|
|
pathBase: Services.io.newURI(".", null, uri).spec
|
|
};
|
|
|
|
//TelemetryStopwatch.start("READER_MODE_SERIALIZE_DOM_MS");
|
|
let serializer = Cc["@mozilla.org/xmlextras/xmlserializer;1"].
|
|
createInstance(Ci.nsIDOMSerializer);
|
|
let serializedDoc = serializer.serializeToString(doc);
|
|
//TelemetryStopwatch.finish("READER_MODE_SERIALIZE_DOM_MS");
|
|
|
|
//TelemetryStopwatch.start("READER_MODE_WORKER_PARSE_MS");
|
|
let article = null;
|
|
try {
|
|
article = yield ReaderWorker.post("parseDocument", [uriParam, serializedDoc]);
|
|
} catch (e) {
|
|
Cu.reportError("Error in ReaderWorker: " + e);
|
|
//histogram.add(PARSE_ERROR_WORKER);
|
|
}
|
|
//TelemetryStopwatch.finish("READER_MODE_WORKER_PARSE_MS");
|
|
|
|
if (!article) {
|
|
this.log("Worker did not return an article");
|
|
//histogram.add(PARSE_ERROR_NO_ARTICLE);
|
|
return null;
|
|
}
|
|
|
|
// Readability returns a URI object based on the baseURI, but we only care
|
|
// about the original document's URL from now on. This also avoids spoofing
|
|
// attempts where the baseURI doesn't match the domain of the documentURI
|
|
article.url = documentURI;
|
|
delete article.uri;
|
|
|
|
let flags = Ci.nsIDocumentEncoder.OutputSelectionOnly | Ci.nsIDocumentEncoder.OutputAbsoluteLinks;
|
|
article.title = Cc["@mozilla.org/parserutils;1"].getService(Ci.nsIParserUtils)
|
|
.convertToPlainText(article.title, flags, 0);
|
|
|
|
//histogram.add(PARSE_SUCCESS);
|
|
return article;
|
|
}),
|
|
|
|
get _cryptoHash() {
|
|
delete this._cryptoHash;
|
|
return this._cryptoHash = Cc["@mozilla.org/security/hash;1"].createInstance(Ci.nsICryptoHash);
|
|
},
|
|
|
|
get _unicodeConverter() {
|
|
delete this._unicodeConverter;
|
|
this._unicodeConverter = Cc["@mozilla.org/intl/scriptableunicodeconverter"]
|
|
.createInstance(Ci.nsIScriptableUnicodeConverter);
|
|
this._unicodeConverter.charset = "utf8";
|
|
return this._unicodeConverter;
|
|
},
|
|
|
|
/**
|
|
* Calculate the hashed path for a stripped article URL.
|
|
*
|
|
* @param url The article URL. This should have referrers removed.
|
|
* @return The file path to the cached article.
|
|
*/
|
|
_toHashedPath: function (url) {
|
|
let value = this._unicodeConverter.convertToByteArray(url);
|
|
this._cryptoHash.init(this._cryptoHash.MD5);
|
|
this._cryptoHash.update(value, value.length);
|
|
|
|
let hash = CommonUtils.encodeBase32(this._cryptoHash.finish(false));
|
|
let fileName = hash.substring(0, hash.indexOf("=")) + ".json";
|
|
return OS.Path.join(OS.Constants.Path.profileDir, "readercache", fileName);
|
|
},
|
|
|
|
/**
|
|
* Ensures the cache directory exists.
|
|
*
|
|
* @return Promise
|
|
* @resolves When the cache directory exists.
|
|
* @rejects OS.File.Error
|
|
*/
|
|
_ensureCacheDir: function () {
|
|
let dir = OS.Path.join(OS.Constants.Path.profileDir, "readercache");
|
|
return OS.File.exists(dir).then(exists => {
|
|
if (!exists) {
|
|
return OS.File.makeDir(dir);
|
|
}
|
|
});
|
|
}
|
|
};
|