mozilla
/
gecko-dev
зеркало из https://github.com/mozilla/gecko-dev.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Bug 862148 - stop supporting installation of Sherlock plugins through Services.search.addEngine, r=adw.

This commit is contained in:
Florian Quèze 2015-09-23 12:05:36 +02:00
Родитель 5eee2c7669
Коммит 7f751627bc
14 изменённых файлов: 48 добавлений и 192 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

1
browser/components/search/test/browser.ini
Просмотреть файл

@ -7,7 +7,6 @@ support-files =
head.js
opensearch.html
test.html
testEngine.src
testEngine.xml
testEngine_diacritics.xml
testEngine_dupe.xml

31
browser/components/search/test/browser_addEngine.js
Просмотреть файл

@ -77,37 +77,6 @@ var gTests = [
ok(currentEngine, "An engine is present.");
isnot(currentEngine.name, this.engine.name, "Current engine reset after removal");
nextTest();
}
},
{
name: "sherlock install",
engine: {
name: "Test Sherlock",
alias: null,
description: "Test Description",
searchForm: "http://example.com/searchform",
type: Ci.nsISearchEngine.TYPE_SHERLOCK
},
run: function () {
gSS.addEngine("http://mochi.test:8888/browser/browser/components/search/test/testEngine.src",
Ci.nsISearchEngine.DATA_TEXT, "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABGklEQVQoz2NgGB6AnZ1dUlJSXl4eSDIyMhLW4Ovr%2B%2Fr168uXL69Zs4YoG%2BLi4i5dusTExMTGxsbNzd3f37937976%2BnpmZmagbHR09J49e5YvX66kpATVEBYW9ubNm2nTphkbG7e2tp44cQLIuHfvXm5urpaWFlDKysqqu7v73LlzECMYIiIiHj58mJCQoKKicvXq1bS0NKBgW1vbjh074uPjgeqAXE1NzSdPnvDz84M0AEUvXLgAsW379u1z5swBen3jxo2zZ892cHB4%2BvQp0KlAfwI1cHJyghQFBwfv2rULokFXV%2FfixYu7d%2B8GGqGgoMDKyrpu3br9%2B%2FcDuXl5eVA%2FAEWBfoWHAdAYoNuAYQ0XAeoUERFhGDYAAPoUaT2dfWJuAAAAAElFTkSuQmCC",
false);
},
added: function (engine) {
ok(engine, "engine was added.");
checkEngine(this.engine, engine);
let engineFromSS = gSS.getEngineByName(this.engine.name);
is(engineFromSS, engine, "engine is obtainable via getEngineByName");
gSS.removeEngine(engine);
},
removed: function (engine) {
let currentEngine = gSS.currentEngine;
ok(currentEngine, "An engine is present.");
isnot(currentEngine.name, this.engine.name, "Current engine reset after removal");
nextTest();
}
}

11
browser/components/search/test/testEngine.src
Просмотреть файл

@ -1,11 +0,0 @@
<search
name="Test Sherlock"
description="Test Description"
method="GET"
searchform="http://example.com/searchform"
action="http://example.com/action"
queryCharset="UTF-8"
>
<input name="userParam" user>
<input name="param" value="value">
</search>

3
netwerk/base/nsIBrowserSearchService.idl
Просмотреть файл

@ -296,8 +296,7 @@ interface nsIBrowserSearchService : nsISupports
* The URL to the search engine's description file.
*
* @param dataType
* An integer representing the plugin file format. Must be one
* of the supported search engine data types defined above.
* Obsolete, the value is ignored.
*
* @param iconURL
* A URL string to an icon file to be used as the search engine's

4
toolkit/components/processsingleton/MainProcessSingleton.js
Просмотреть файл

@ -25,7 +25,7 @@ MainProcessSingleton.prototype = {
},
// Called when a webpage calls window.external.AddSearchProvider
addSearchEngine: function({ target: browser, data: { pageURL, engineURL, type } }) {
addSearchEngine: function({ target: browser, data: { pageURL, engineURL } }) {
pageURL = NetUtil.newURI(pageURL);
engineURL = NetUtil.newURI(engineURL, null, pageURL);
@ -61,7 +61,7 @@ MainProcessSingleton.prototype = {
if (status != Cr.NS_OK)
return;
Services.search.addEngine(engineURL.spec, type, iconURL ? iconURL.spec : null, true);
Services.search.addEngine(engineURL.spec, null, iconURL ? iconURL.spec : null, true);
})
},

139
toolkit/components/search/nsSearchService.js
Просмотреть файл

@ -99,10 +99,6 @@ const SEARCH_SERVICE_CACHE_WRITTEN = "write-cache-to-disk-complete";
const SEARCH_TYPE_MOZSEARCH = Ci.nsISearchEngine.TYPE_MOZSEARCH;
const SEARCH_TYPE_OPENSEARCH = Ci.nsISearchEngine.TYPE_OPENSEARCH;
const SEARCH_TYPE_SHERLOCK = Ci.nsISearchEngine.TYPE_SHERLOCK;
const SEARCH_DATA_XML = Ci.nsISearchEngine.DATA_XML;
const SEARCH_DATA_TEXT = Ci.nsISearchEngine.DATA_TEXT;
// Delay for lazy serialization (ms)
const LAZY_SERIALIZE_DELAY = 100;
@ -1486,15 +1482,11 @@ EngineURL.prototype = {
* @param aLocation
* A nsILocalFile or nsIURI object representing the location of the
* search engine data file.
* @param aSourceDataType
* The data type of the file used to describe the engine. Must be either
* DATA_XML or DATA_TEXT.
* @param aIsReadOnly
* Boolean indicating whether the engine should be treated as read-only.
* Read only engines cannot be serialized to file.
*/
function Engine(aLocation, aSourceDataType, aIsReadOnly) {
this._dataType = aSourceDataType;
function Engine(aLocation, aIsReadOnly) {
this._readOnly = aIsReadOnly;
this._urls = [];
@ -1536,8 +1528,6 @@ Engine.prototype = {
// The data describing the engine. Is either an array of bytes, for Sherlock
// files, or an XML document element, for XML plugins.
_data: null,
// The engine's data type. See data types (DATA_) defined above.
_dataType: null,
// Whether or not the engine is readonly.
_readOnly: true,
// The engine's description
@ -1618,10 +1608,8 @@ Engine.prototype = {
_extensionID: null,
/**
* Retrieves the data from the engine's file. If the engine's dataType is
* XML, the document element is placed in the engine's data field. For text
* engines, the data is just read directly from file and placed as an array
* of lines in the engine's data field.
* Retrieves the data from the engine's file.
* The document element is placed in the engine's data field.
*/
_initFromFile: function SRCH_ENG_initFromFile() {
if (!this._file || !this._file.exists())
@ -1632,19 +1620,13 @@ Engine.prototype = {
fileInStream.init(this._file, MODE_RDONLY, FileUtils.PERMS_FILE, false);
if (this._dataType == SEARCH_DATA_XML) {
var domParser = Cc["@mozilla.org/xmlextras/domparser;1"].
createInstance(Ci.nsIDOMParser);
var doc = domParser.parseFromStream(fileInStream, "UTF-8",
this._file.fileSize,
"text/xml");
var domParser = Cc["@mozilla.org/xmlextras/domparser;1"].
createInstance(Ci.nsIDOMParser);
var doc = domParser.parseFromStream(fileInStream, "UTF-8",
this._file.fileSize,
"text/xml");
this._data = doc.documentElement;
} else {
ERROR("Unsuppored engine _dataType in _initFromFile: \"" +
this._dataType + "\"",
Cr.NS_ERROR_UNEXPECTED);
}
this._data = doc.documentElement;
fileInStream.close();
// Now that the data is loaded, initialize the engine object
@ -1652,8 +1634,8 @@ Engine.prototype = {
},
/**
* Retrieves the data from the engine's file asynchronously. If the engine's
* dataType is XML, the document element is placed in the engine's data field.
* Retrieves the data from the engine's file asynchronously.
* The document element is placed in the engine's data field.
*
* @returns {Promise} A promise, resolved successfully if initializing from
* data succeeds, rejected if it fails.
@ -1663,14 +1645,8 @@ Engine.prototype = {
if (!this._file || !(yield OS.File.exists(this._file.path)))
FAIL("File must exist before calling initFromFile!", Cr.NS_ERROR_UNEXPECTED);
if (this._dataType == SEARCH_DATA_XML) {
let fileURI = NetUtil.ioService.newFileURI(this._file);
yield this._retrieveSearchXMLData(fileURI.spec);
} else {
ERROR("Unsuppored engine _dataType in _initFromFile: \"" +
this._dataType + "\"",
Cr.NS_ERROR_UNEXPECTED);
}
let fileURI = NetUtil.ioService.newFileURI(this._file);
yield this._retrieveSearchXMLData(fileURI.spec);
// Now that the data is loaded, initialize the engine object
this._initFromData();
@ -1880,21 +1856,10 @@ Engine.prototype = {
aEngine._file = engineToUpdate._file;
}
switch (aEngine._dataType) {
case SEARCH_DATA_XML:
var parser = Cc["@mozilla.org/xmlextras/domparser;1"].
createInstance(Ci.nsIDOMParser);
var doc = parser.parseFromBuffer(aBytes, aBytes.length, "text/xml");
aEngine._data = doc.documentElement;
break;
case SEARCH_DATA_TEXT:
aEngine._data = aBytes;
break;
default:
promptError();
LOG("_onLoad: Bogus engine _dataType: \"" + this._dataType + "\"");
return;
}
var parser = Cc["@mozilla.org/xmlextras/domparser;1"].
createInstance(Ci.nsIDOMParser);
var doc = parser.parseFromBuffer(aBytes, aBytes.length, "text/xml");
aEngine._data = doc.documentElement;
try {
// Initialize the engine from the obtained data
@ -2134,35 +2099,24 @@ Engine.prototype = {
Cr.NS_ERROR_UNEXPECTED);
// Find out what type of engine we are
switch (this._dataType) {
case SEARCH_DATA_XML:
if (checkNameSpace(this._data, [MOZSEARCH_LOCALNAME],
[MOZSEARCH_NS_10])) {
if (checkNameSpace(this._data, [MOZSEARCH_LOCALNAME],
[MOZSEARCH_NS_10])) {
LOG("_init: Initing MozSearch plugin from " + this._location);
LOG("_init: Initing MozSearch plugin from " + this._location);
this._type = SEARCH_TYPE_MOZSEARCH;
this._parseAsMozSearch();
this._type = SEARCH_TYPE_MOZSEARCH;
this._parseAsMozSearch();
} else if (checkNameSpace(this._data, [OPENSEARCH_LOCALNAME],
OPENSEARCH_NAMESPACES)) {
} else if (checkNameSpace(this._data, [OPENSEARCH_LOCALNAME],
OPENSEARCH_NAMESPACES)) {
LOG("_init: Initing OpenSearch plugin from " + this._location);
LOG("_init: Initing OpenSearch plugin from " + this._location);
this._type = SEARCH_TYPE_OPENSEARCH;
this._parseAsOpenSearch();
this._type = SEARCH_TYPE_OPENSEARCH;
this._parseAsOpenSearch();
} else
FAIL(this._location + " is not a valid search plugin.", Cr.NS_ERROR_FAILURE);
break;
case SEARCH_DATA_TEXT:
LOG("_init: Initing Sherlock plugin from " + this._location);
// the only text-based format we support is Sherlock
this._type = SEARCH_TYPE_SHERLOCK;
this._parseAsSherlock();
}
} else
FAIL(this._location + " is not a valid search plugin.", Cr.NS_ERROR_FAILURE);
// No need to keep a ref to our data (which in some cases can be a document
// element) past this point
@ -2761,8 +2715,6 @@ Engine.prototype = {
json.type = this.type;
if (this.queryCharset != DEFAULT_QUERY_CHARSET || !aFilter)
json.queryCharset = this.queryCharset;
if (this._dataType != SEARCH_DATA_XML || !aFilter)
json._dataType = this._dataType;
if (!this._readOnly || !aFilter)
json._readOnly = this._readOnly;
if (this._extensionID) {
@ -4041,15 +3993,6 @@ SearchService.prototype = {
// Schedule the engine's next update, if it isn't already.
if (!engineMetadataService.getAttr(aEngine, "updateexpir"))
engineUpdateService.scheduleNextUpdate(aEngine);
// We need to save the engine's _dataType, if this is the first time the
// engine is added to the dataStore, since ._dataType isn't persisted
// and will change on the next startup (since the engine will then be
// XML). We need this so that we know how to load any future updates from
// this engine.
if (!engineMetadataService.getAttr(aEngine, "updatedatatype"))
engineMetadataService.setAttr(aEngine, "updatedatatype",
aEngine._dataType);
}
},
@ -4062,10 +4005,10 @@ SearchService.prototype = {
try {
let engine;
if (json.filePath)
engine = new Engine({type: "filePath", value: json.filePath}, json._dataType,
engine = new Engine({type: "filePath", value: json.filePath},
json._readOnly);
else if (json._url)
engine = new Engine({type: "uri", value: json._url}, json._dataType, json._readOnly);
engine = new Engine({type: "uri", value: json._url}, json._readOnly);
engine._initWithJSON(json);
this._addEngineToStore(engine);
@ -4103,7 +4046,7 @@ SearchService.prototype = {
var addedEngine = null;
try {
addedEngine = new Engine(file, SEARCH_DATA_XML, !isWritable);
addedEngine = new Engine(file, !isWritable);
addedEngine._initFromFile();
} catch (ex) {
LOG("_loadEnginesFromDir: Failed to load " + file.path + "!\n" + ex);
@ -4151,7 +4094,7 @@ SearchService.prototype = {
try {
let file = new FileUtils.File(osfile.path);
let isWritable = isInProfile;
addedEngine = new Engine(file, SEARCH_DATA_XML, !isWritable);
addedEngine = new Engine(file, !isWritable);
yield checkForSyncCompletion(addedEngine._asyncInitFromFile());
} catch (ex if ex.result != Cr.NS_ERROR_ALREADY_INITIALIZED) {
LOG("_asyncLoadEnginesFromDir: Failed to load " + osfile.path + "!\n" + ex);
@ -4168,7 +4111,7 @@ SearchService.prototype = {
try {
LOG("_loadFromChromeURLs: loading engine from chrome url: " + url);
let engine = new Engine(makeURI(url), SEARCH_DATA_XML, true);
let engine = new Engine(makeURI(url), true);
engine._initFromURISync();
@ -4193,7 +4136,7 @@ SearchService.prototype = {
for (let url of aURLs) {
try {
LOG("_asyncLoadFromChromeURLs: loading engine from chrome url: " + url);
let engine = new Engine(NetUtil.newURI(url), SEARCH_DATA_XML, true);
let engine = new Engine(NetUtil.newURI(url), true);
yield checkForSyncCompletion(engine._asyncInitFromURI());
engines.push(engine);
} catch (ex if ex.result != Cr.NS_ERROR_ALREADY_INITIALIZED) {
@ -4640,7 +4583,7 @@ SearchService.prototype = {
if (this._engines[aName])
FAIL("An engine with that name already exists!", Cr.NS_ERROR_FILE_ALREADY_EXISTS);
var engine = new Engine(getSanitizedFile(aName), SEARCH_DATA_XML, false);
var engine = new Engine(getSanitizedFile(aName), false);
engine._initFromMetadata(aName, aIconURL, aAlias, aDescription,
aMethod, aTemplate, aExtensionID);
this._addEngineToStore(engine);
@ -4652,7 +4595,7 @@ SearchService.prototype = {
this._ensureInitialized();
try {
var uri = makeURI(aEngineURL);
var engine = new Engine(uri, aDataType, false);
var engine = new Engine(uri, false);
if (aCallback) {
engine._installCallback = function (errorCode) {
try {
@ -5542,14 +5485,8 @@ var engineUpdateService = {
return;
}
let dataType = engineMetadataService.getAttr(engine, "updatedatatype");
if (!dataType) {
ULOG("No loadtype to update engine!");
return;
}
ULOG("updating " + engine.name + " from " + updateURI.spec);
testEngine = new Engine(updateURI, dataType, false);
testEngine = new Engine(updateURI, false);
testEngine._engineToUpdate = engine;
testEngine._initFromURIAndLoad();
} else

3
toolkit/components/search/nsSidebar.js
Просмотреть файл

@ -38,8 +38,7 @@ nsSidebar.prototype = {
AddSearchProvider: function(engineURL) {
this.mm.sendAsyncMessage("Search:AddEngine", {
pageURL: this.window.document.documentURIObject.spec,
engineURL,
type: Ci.nsISearchEngine.DATA_XML
engineURL
});
},

18
toolkit/components/search/tests/xpcshell/data/engine.src
Просмотреть файл

@ -1,18 +0,0 @@
<SEARCH
version="1"
name="Sherlock test search engine"
description="A test search engine for testing sherlock"
method="GET"
action="http://getfirefox.com"
searchform="http://getfirefox.com"
>
<input name="q" user>
</search>
<BROWSER
update="http://getfirefox.com"
updateIcon="http://getfirefox.com"
updatecheckdays="7"
>

6
toolkit/components/search/tests/xpcshell/head_search.js
Просмотреть файл

@ -391,8 +391,6 @@ function useHttpServer() {
* {
* name: Engine name, used to wait for it to be loaded.
* xmlFileName: Name of the XML file in the "data" folder.
* srcFileName: Name of the SRC file in the "data" folder.
* iconFileName: Name of the icon associated to the SRC file.
* details: Array containing the parameters of addEngineWithDetails,
* except for the engine name. Alternative to xmlFileName.
* }
@ -426,10 +424,6 @@ var addTestEngines = Task.async(function* (aItems) {
if (item.xmlFileName) {
Services.search.addEngine(gDataUrl + item.xmlFileName,
Ci.nsISearchEngine.DATA_XML, null, false);
} else if (item.srcFileName) {
Services.search.addEngine(gDataUrl + item.srcFileName,
Ci.nsISearchEngine.DATA_TEXT,
gDataUrl + item.iconFileName, false);
} else {
Services.search.addEngineWithDetails(item.name, ...item.details);
}

5
toolkit/components/search/tests/xpcshell/test_nodb_pluschanges.js
Просмотреть файл

@ -31,8 +31,7 @@ function run_test() {
add_task(function* test_nodb_pluschanges() {
let [engine1, engine2] = yield addTestEngines([
{ name: "Test search engine", xmlFileName: "engine.xml" },
{ name: "Sherlock test search engine", srcFileName: "engine.src",
iconFileName: "ico-size-16x16-png.ico" },
{ name: "A second test engine", xmlFileName: "engine2.xml"},
]);
let search = Services.search;
@ -54,7 +53,7 @@ add_task(function* test_nodb_pluschanges() {
// Check that the entries are placed as specified correctly
let json = getSearchMetadata();
do_check_eq(json["[app]/test-search-engine.xml"].order, 1);
do_check_eq(json["[profile]/sherlock-test-search-engine.xml"].order, 2);
do_check_eq(json["[profile]/a-second-test-engine.xml"].order, 2);
do_print("Cleaning up");
removeMetadata();

8
toolkit/components/search/tests/xpcshell/test_parseSubmissionURL.js
Просмотреть файл

@ -30,8 +30,6 @@ add_task(function* test_parseSubmissionURL() {
"GET", "http://www.xn--bcher-kva.ch/search"] },
// The following engines cannot identify the search parameter.
{ name: "A second test engine", xmlFileName: "engine2.xml" },
{ name: "Sherlock test search engine", srcFileName: "engine.src",
iconFileName: "ico-size-16x16-png.ico" },
{ name: "bacon", details: ["", "bacon", "Search Bacon", "GET",
"http://www.bacon.moz/search?q={searchTerms}"] },
]);
@ -107,12 +105,6 @@ add_task(function* test_parseSubmissionURL() {
do_check_eq(Services.search.parseSubmissionURL(
"https://duckduckgo.com/?q=test").engine, null);
// Sherlock engines are not supported.
do_check_eq(Services.search.parseSubmissionURL(
"http://getfirefox.com?q=test").engine, null);
do_check_eq(Services.search.parseSubmissionURL(
"http://getfirefox.com/?q=test").engine, null);
// HTTP and HTTPS schemes are interchangeable.
url = "https://www.google.com/search?q=caff%C3%A8";
result = Services.search.parseSubmissionURL(url);

7
toolkit/components/search/tests/xpcshell/test_save_sorted_engines.js
Просмотреть файл

@ -28,8 +28,7 @@ function run_test() {
add_task(function* test_save_sorted_engines() {
let [engine1, engine2] = yield addTestEngines([
{ name: "Test search engine", xmlFileName: "engine.xml" },
{ name: "Sherlock test search engine", srcFileName: "engine.src",
iconFileName: "ico-size-16x16-png.ico" },
{ name: "A second test engine", xmlFileName: "engine2.xml"},
]);
let search = Services.search;
@ -45,7 +44,7 @@ add_task(function* test_save_sorted_engines() {
// Check that the entries are placed as specified correctly
let json = getSearchMetadata();
do_check_eq(json["[app]/test-search-engine.xml"].order, 1);
do_check_eq(json["[profile]/sherlock-test-search-engine.xml"].order, 2);
do_check_eq(json["[profile]/a-second-test-engine.xml"].order, 2);
// Test removing an engine
search.removeEngine(engine1);
@ -54,7 +53,7 @@ add_task(function* test_save_sorted_engines() {
// Check that the order of the remaining engine was updated correctly
json = getSearchMetadata();
do_check_eq(json["[profile]/sherlock-test-search-engine.xml"].order, 1);
do_check_eq(json["[profile]/a-second-test-engine.xml"].order, 1);
// Test adding a new engine
search.addEngineWithDetails("foo", "", "foo", "", "GET",

3
toolkit/components/search/tests/xpcshell/test_serialize_file.js
Просмотреть файл

@ -20,8 +20,7 @@ function run_test() {
add_task(function test_batchTask() {
let [engine1, engine2] = yield addTestEngines([
{ name: "Test search engine", xmlFileName: "engine.xml" },
{ name: "Sherlock test search engine", srcFileName: "engine.src",
iconFileName: "ico-size-16x16-png.ico" },
{ name: "A second test engine", xmlFileName: "engine2.xml"},
]);
// Test that files are written correctly.

1
toolkit/components/search/tests/xpcshell/xpcshell.ini
Просмотреть файл

@ -5,7 +5,6 @@ firefox-appdir = browser
skip-if = toolkit == 'android' || toolkit == 'gonk'
support-files =
data/chrome.manifest
data/engine.src
data/engine.xml
data/engine2.xml
data/engine-addon.xml