home *** CD-ROM | disk | FTP | other *** search
/ PC World 2008 February / PCWorld_2008-02_cd.bin / temacd / songbird / Songbird_0.4_windows-i686.exe / components / nsSearchService.js < prev    next >
Text File  |  2007-12-21  |  112KB  |  3,261 lines
  1. /*
  2. # ***** BEGIN LICENSE BLOCK *****
  3. # Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4. #
  5. # The contents of this file are subject to the Mozilla Public License Version
  6. # 1.1 (the "License"); you may not use this file except in compliance with
  7. # the License. You may obtain a copy of the License at
  8. # http://www.mozilla.org/MPL/
  9. #
  10. # Software distributed under the License is distributed on an "AS IS" basis,
  11. # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12. # for the specific language governing rights and limitations under the
  13. # License.
  14. #
  15. # The Original Code is the Browser Search Service.
  16. #
  17. # The Initial Developer of the Original Code is
  18. # Google Inc.
  19. # Portions created by the Initial Developer are Copyright (C) 2005-2006
  20. # the Initial Developer. All Rights Reserved.
  21. #
  22. # Contributor(s):
  23. #   Ben Goodger <beng@google.com> (Original author)
  24. #   Gavin Sharp <gavin@gavinsharp.com>
  25. #   Joe Hughes  <joe@retrovirus.com>
  26. #   Pamela Greene <pamg.bugs@gmail.com>
  27. #
  28. # Alternatively, the contents of this file may be used under the terms of
  29. # either the GNU General Public License Version 2 or later (the "GPL"), or
  30. # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  31. # in which case the provisions of the GPL or the LGPL are applicable instead
  32. # of those above. If you wish to allow use of your version of this file only
  33. # under the terms of either the GPL or the LGPL, and not to allow others to
  34. # use your version of this file under the terms of the MPL, indicate your
  35. # decision by deleting the provisions above and replace them with the notice
  36. # and other provisions required by the GPL or the LGPL. If you do not delete
  37. # the provisions above, a recipient may use your version of this file under
  38. # the terms of any one of the MPL, the GPL or the LGPL.
  39. #
  40. # ***** END LICENSE BLOCK *****
  41. */
  42. const Ci = Components.interfaces;
  43. const Cc = Components.classes;
  44. const Cr = Components.results;
  45.  
  46. const PERMS_FILE      = 0644;
  47. const PERMS_DIRECTORY = 0755;
  48.  
  49. const MODE_RDONLY   = 0x01;
  50. const MODE_WRONLY   = 0x02;
  51. const MODE_CREATE   = 0x08;
  52. const MODE_APPEND   = 0x10;
  53. const MODE_TRUNCATE = 0x20;
  54.  
  55. // Directory service keys
  56. const NS_APP_SEARCH_DIR_LIST  = "SrchPluginsDL";
  57. const NS_APP_USER_SEARCH_DIR  = "UsrSrchPlugns";
  58. const NS_APP_SEARCH_DIR       = "SrchPlugns";
  59. const NS_APP_USER_PROFILE_50_DIR = "ProfD";
  60.  
  61. // Search engine "locations". If this list is changed, be sure to update
  62. // the engine's _isDefault function accordingly.
  63. const SEARCH_APP_DIR = 1;
  64. const SEARCH_PROFILE_DIR = 2;
  65. const SEARCH_IN_EXTENSION = 3;
  66.  
  67. // See documentation in nsIBrowserSearchService.idl.
  68. const SEARCH_ENGINE_TOPIC        = "browser-search-engine-modified";
  69. const QUIT_APPLICATION_TOPIC     = "quit-application";
  70.  
  71. const SEARCH_ENGINE_REMOVED      = "engine-removed";
  72. const SEARCH_ENGINE_ADDED        = "engine-added";
  73. const SEARCH_ENGINE_CHANGED      = "engine-changed";
  74. const SEARCH_ENGINE_LOADED       = "engine-loaded";
  75. const SEARCH_ENGINE_CURRENT      = "engine-current";
  76.  
  77. const SEARCH_TYPE_MOZSEARCH      = Ci.nsISearchEngine.TYPE_MOZSEARCH;
  78. const SEARCH_TYPE_OPENSEARCH     = Ci.nsISearchEngine.TYPE_OPENSEARCH;
  79. const SEARCH_TYPE_SHERLOCK       = Ci.nsISearchEngine.TYPE_SHERLOCK;
  80.  
  81. const SEARCH_DATA_XML            = Ci.nsISearchEngine.DATA_XML;
  82. const SEARCH_DATA_TEXT           = Ci.nsISearchEngine.DATA_TEXT;
  83.  
  84. // File extensions for search plugin description files
  85. const XML_FILE_EXT      = "xml";
  86. const SHERLOCK_FILE_EXT = "src";
  87.  
  88. // Delay for lazy serialization (ms)
  89. const LAZY_SERIALIZE_DELAY = 100;
  90.  
  91. const ICON_DATAURL_PREFIX = "data:image/x-icon;base64,";
  92.  
  93. // Supported extensions for Sherlock plugin icons
  94. const SHERLOCK_ICON_EXTENSIONS = [".gif", ".png", ".jpg", ".jpeg"];
  95.  
  96. const NEW_LINES = /(\r\n|\r|\n)/;
  97.  
  98. // Set an arbitrary cap on the maximum icon size. Without this, large icons can
  99. // cause big delays when loading them at startup.
  100. const MAX_ICON_SIZE   = 10000;
  101.  
  102. // Default charset to use for sending search parameters. ISO-8859-1 is used to
  103. // match previous nsInternetSearchService behavior.
  104. const DEFAULT_QUERY_CHARSET = "ISO-8859-1";
  105.  
  106. const SEARCH_BUNDLE = "chrome://browser/locale/search.properties";
  107. const BRAND_BUNDLE = "chrome://branding/locale/brand.properties";
  108.  
  109. const OPENSEARCH_NS_10  = "http://a9.com/-/spec/opensearch/1.0/";
  110. const OPENSEARCH_NS_11  = "http://a9.com/-/spec/opensearch/1.1/";
  111.  
  112. // Although the specification at http://opensearch.a9.com/spec/1.1/description/
  113. // gives the namespace names defined above, many existing OpenSearch engines
  114. // are using the following versions.  We therefore allow either.
  115. const OPENSEARCH_NAMESPACES = [
  116.   OPENSEARCH_NS_11, OPENSEARCH_NS_10,
  117.   "http://a9.com/-/spec/opensearchdescription/1.1/",
  118.   "http://a9.com/-/spec/opensearchdescription/1.0/"
  119. ];
  120.  
  121. const OPENSEARCH_LOCALNAME = "OpenSearchDescription";
  122.  
  123. const MOZSEARCH_NS_10     = "http://www.mozilla.org/2006/browser/search/";
  124. const MOZSEARCH_LOCALNAME = "SearchPlugin";
  125.  
  126. const URLTYPE_SUGGEST_JSON = "application/x-suggestions+json";
  127. const URLTYPE_SEARCH_HTML  = "text/html";
  128.  
  129. // Empty base document used to serialize engines to file.
  130. const EMPTY_DOC = "<?xml version=\"1.0\"?>\n" +
  131.                   "<" + MOZSEARCH_LOCALNAME +
  132.                   " xmlns=\"" + MOZSEARCH_NS_10 + "\"" +
  133.                   " xmlns:os=\"" + OPENSEARCH_NS_11 + "\"" +
  134.                   "/>";
  135.  
  136. const BROWSER_SEARCH_PREF = "browser.search.";
  137.  
  138. const USER_DEFINED = "{searchTerms}";
  139.  
  140. // Custom search parameters
  141. /*
  142. #ifdef OFFICIAL_BUILD
  143. const MOZ_OFFICIAL = "official";
  144. #else
  145. */
  146. const MOZ_OFFICIAL = "unofficial";
  147. /*
  148. #endif
  149. #expand const MOZ_DISTRIBUTION_ID = __MOZ_DISTRIBUTION_ID__;
  150. */
  151.  
  152. /**************************
  153.  XXX - What should this be?
  154.  **************************/
  155. const MOZ_DISTRIBUTION_ID = "Songbird";
  156.  
  157. const MOZ_PARAM_LOCALE         = /\{moz:locale\}/g;
  158. const MOZ_PARAM_DIST_ID        = /\{moz:distributionID\}/g;
  159. const MOZ_PARAM_OFFICIAL       = /\{moz:official\}/g;
  160.  
  161. // Supported OpenSearch parameters
  162. // See http://opensearch.a9.com/spec/1.1/querysyntax/#core
  163. const OS_PARAM_USER_DEFINED    = /\{searchTerms\??\}/g;
  164. const OS_PARAM_INPUT_ENCODING  = /\{inputEncoding\??\}/g;
  165. const OS_PARAM_LANGUAGE        = /\{language\??\}/g;
  166. const OS_PARAM_OUTPUT_ENCODING = /\{outputEncoding\??\}/g;
  167.  
  168. // Default values
  169. const OS_PARAM_LANGUAGE_DEF         = "*";
  170. const OS_PARAM_OUTPUT_ENCODING_DEF  = "UTF-8";
  171. const OS_PARAM_INPUT_ENCODING_DEF   = "UTF-8";
  172.  
  173. // "Unsupported" OpenSearch parameters. For example, we don't support
  174. // page-based results, so if the engine requires that we send the "page index"
  175. // parameter, we'll always send "1".
  176. const OS_PARAM_COUNT        = /\{count\??\}/g;
  177. const OS_PARAM_START_INDEX  = /\{startIndex\??\}/g;
  178. const OS_PARAM_START_PAGE   = /\{startPage\??\}/g;
  179.  
  180. // Default values
  181. const OS_PARAM_COUNT_DEF        = "20"; // 20 results
  182. const OS_PARAM_START_INDEX_DEF  = "1";  // start at 1st result
  183. const OS_PARAM_START_PAGE_DEF   = "1";  // 1st page
  184.  
  185. // Optional parameter
  186. const OS_PARAM_OPTIONAL     = /\{(?:\w+:)?\w+\?\}/g;
  187.  
  188. // A array of arrays containing parameters that we don't fully support, and
  189. // their default values. We will only send values for these parameters if
  190. // required, since our values are just really arbitrary "guesses" that should
  191. // give us the output we want.
  192. var OS_UNSUPPORTED_PARAMS = [
  193.   [OS_PARAM_COUNT, OS_PARAM_COUNT_DEF],
  194.   [OS_PARAM_START_INDEX, OS_PARAM_START_INDEX_DEF],
  195.   [OS_PARAM_START_PAGE, OS_PARAM_START_PAGE_DEF],
  196. ];
  197.  
  198. // The default engine update interval, in days. This is only used if an engine
  199. // specifies an updateURL, but not an updateInterval.
  200. const SEARCH_DEFAULT_UPDATE_INTERVAL = 7;
  201.  
  202. // Returns false for whitespace-only or commented out lines in a
  203. // Sherlock file, true otherwise.
  204. function isUsefulLine(aLine) {
  205.   return !(/^\s*($|#)/i.test(aLine));
  206. }
  207.  
  208. /**
  209.  * Prefixed to all search debug output.
  210.  */
  211. const SEARCH_LOG_PREFIX = "*** Search: ";
  212.  
  213. /**
  214.  * Outputs aText to the JavaScript console as well as to stdout, if the search
  215.  * logging pref (browser.search.log) is set to true.
  216.  */
  217. function LOG(aText) {
  218.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  219.               getService(Ci.nsIPrefBranch);
  220.   var shouldLog = false;
  221.   try {
  222.     shouldLog = prefB.getBoolPref(BROWSER_SEARCH_PREF + "log");
  223.   } catch (ex) {}
  224.  
  225.   if (shouldLog) {
  226.     dump(SEARCH_LOG_PREFIX + aText + "\n");
  227.     var consoleService = Cc["@mozilla.org/consoleservice;1"].
  228.                          getService(Ci.nsIConsoleService);
  229.     consoleService.logStringMessage(aText);
  230.   }
  231. }
  232.  
  233. function ERROR(message, resultCode) {
  234.   NS_ASSERT(false, SEARCH_LOG_PREFIX + message);
  235.   throw resultCode;
  236. }
  237.  
  238. /**
  239.  * Ensures an assertion is met before continuing. Should be used to indicate
  240.  * fatal errors.
  241.  * @param  assertion
  242.  *         An assertion that must be met
  243.  * @param  message
  244.  *         A message to display if the assertion is not met
  245.  * @param  resultCode
  246.  *         The NS_ERROR_* value to throw if the assertion is not met
  247.  * @throws resultCode
  248.  */
  249. function ENSURE_WARN(assertion, message, resultCode) {
  250.   NS_ASSERT(assertion, SEARCH_LOG_PREFIX + message);
  251.   if (!assertion)
  252.     throw resultCode;
  253. }
  254.  
  255. /**
  256.  * Ensures an assertion is met before continuing, but does not warn the user.
  257.  * Used to handle normal failure conditions.
  258.  * @param  assertion
  259.  *         An assertion that must be met
  260.  * @param  message
  261.  *         A message to display if the assertion is not met
  262.  * @param  resultCode
  263.  *         The NS_ERROR_* value to throw if the assertion is not met
  264.  * @throws resultCode
  265.  */
  266. function ENSURE(assertion, message, resultCode) {
  267.   if (!assertion) {
  268.     LOG(message);
  269.     throw resultCode;
  270.   }
  271. }
  272.  
  273. /**
  274.  * Ensures an argument assertion is met before continuing.
  275.  * @param  assertion
  276.  *         An argument assertion that must be met
  277.  * @param  message
  278.  *         A message to display if the assertion is not met
  279.  * @throws NS_ERROR_INVALID_ARG for invalid arguments
  280.  */
  281. function ENSURE_ARG(assertion, message) {
  282.   ENSURE(assertion, message, Cr.NS_ERROR_INVALID_ARG);
  283. }
  284.  
  285. function loadListener(aChannel, aEngine, aCallback) {
  286.   this._channel = aChannel;
  287.   this._bytes = [];
  288.   this._engine = aEngine;
  289.   this._callback = aCallback;
  290. }
  291. loadListener.prototype = {
  292.   _callback: null,
  293.   _channel: null,
  294.   _countRead: 0,
  295.   _engine: null,
  296.   _stream: null,
  297.  
  298.   QueryInterface: function SRCH_loadQI(aIID) {
  299.     if (aIID.equals(Ci.nsISupports)           ||
  300.         aIID.equals(Ci.nsIRequestObserver)    ||
  301.         aIID.equals(Ci.nsIStreamListener)     ||
  302.         aIID.equals(Ci.nsIChannelEventSink)   ||
  303.         aIID.equals(Ci.nsIInterfaceRequestor) ||
  304.         aIID.equals(Ci.nsIBadCertListener)    ||
  305.         // See FIXME comment below
  306.         aIID.equals(Ci.nsIHttpEventSink)      ||
  307.         aIID.equals(Ci.nsIProgressEventSink)  ||
  308.         false)
  309.       return this;
  310.  
  311.     throw Cr.NS_ERROR_NO_INTERFACE;
  312.   },
  313.  
  314.   // nsIRequestObserver
  315.   onStartRequest: function SRCH_loadStartR(aRequest, aContext) {
  316.     LOG("loadListener: Starting request: " + aRequest.name);
  317.     this._stream = Cc["@mozilla.org/binaryinputstream;1"].
  318.                    createInstance(Ci.nsIBinaryInputStream);
  319.   },
  320.  
  321.   onStopRequest: function SRCH_loadStopR(aRequest, aContext, aStatusCode) {
  322.     LOG("loadListener: Stopping request: " + aRequest.name);
  323.  
  324.     var requestFailed = !Components.isSuccessCode(aStatusCode);
  325.     if (!requestFailed && (aRequest instanceof Ci.nsIHttpChannel))
  326.       requestFailed = !aRequest.requestSucceeded;
  327.  
  328.     if (requestFailed || this._countRead == 0) {
  329.       LOG("loadListener: request failed!");
  330.       // send null so the callback can deal with the failure
  331.       this._callback(null, this._engine);
  332.     } else
  333.       this._callback(this._bytes, this._engine);
  334.     this._channel = null;
  335.     this._engine  = null;
  336.   },
  337.  
  338.   // nsIStreamListener
  339.   onDataAvailable: function SRCH_loadDAvailable(aRequest, aContext,
  340.                                                 aInputStream, aOffset,
  341.                                                 aCount) {
  342.     this._stream.setInputStream(aInputStream);
  343.  
  344.     // Get a byte array of the data
  345.     this._bytes = this._bytes.concat(this._stream.readByteArray(aCount));
  346.     this._countRead += aCount;
  347.   },
  348.  
  349.   // nsIChannelEventSink
  350.   onChannelRedirect: function SRCH_loadCRedirect(aOldChannel, aNewChannel,
  351.                                                  aFlags) {
  352.     this._channel = aNewChannel;
  353.   },
  354.  
  355.   // nsIInterfaceRequestor
  356.   getInterface: function SRCH_load_GI(aIID) {
  357.     return this.QueryInterface(aIID);
  358.   },
  359.  
  360.   // nsIBadCertListener
  361.   confirmUnknownIssuer: function SRCH_load_CUI(aSocketInfo, aCert,
  362.                                                aCertAddType) {
  363.     return false;
  364.   },
  365.  
  366.   confirmMismatchDomain: function SRCH_load_CMD(aSocketInfo, aTargetURL,
  367.                                                 aCert) {
  368.     return false;
  369.   },
  370.  
  371.   confirmCertExpired: function SRCH_load_CCE(aSocketInfo, aCert) {
  372.     return false;
  373.   },
  374.  
  375.   notifyCrlNextupdate: function SRCH_load_NCN(aSocketInfo, aTargetURL, aCert) {
  376.   },
  377.  
  378.   // FIXME: bug 253127
  379.   // nsIHttpEventSink
  380.   onRedirect: function (aChannel, aNewChannel) {},
  381.   // nsIProgressEventSink
  382.   onProgress: function (aRequest, aContext, aProgress, aProgressMax) {},
  383.   onStatus: function (aRequest, aContext, aStatus, aStatusArg) {}
  384. }
  385.  
  386.  
  387. /**
  388.  * Used to verify a given DOM node's localName and namespaceURI.
  389.  * @param aElement
  390.  *        The element to verify.
  391.  * @param aLocalNameArray
  392.  *        An array of strings to compare against aElement's localName.
  393.  * @param aNameSpaceArray
  394.  *        An array of strings to compare against aElement's namespaceURI.
  395.  *
  396.  * @returns false if aElement is null, or if its localName or namespaceURI
  397.  *          does not match one of the elements in the aLocalNameArray or
  398.  *          aNameSpaceArray arrays, respectively.
  399.  * @throws NS_ERROR_INVALID_ARG if aLocalNameArray or aNameSpaceArray are null.
  400.  */
  401. function checkNameSpace(aElement, aLocalNameArray, aNameSpaceArray) {
  402.   ENSURE_ARG(aLocalNameArray && aNameSpaceArray, "missing aLocalNameArray or \
  403.              aNameSpaceArray for checkNameSpace");
  404.   return (aElement                                                &&
  405.           (aLocalNameArray.indexOf(aElement.localName)    != -1)  &&
  406.           (aNameSpaceArray.indexOf(aElement.namespaceURI) != -1));
  407. }
  408.  
  409. /**
  410.  * Safely close a nsISafeOutputStream.
  411.  * @param aFOS
  412.  *        The file output stream to close.
  413.  */
  414. function closeSafeOutputStream(aFOS) {
  415.   if (aFOS instanceof Ci.nsISafeOutputStream) {
  416.     try {
  417.       aFOS.finish();
  418.       return;
  419.     } catch (e) { }
  420.   }
  421.   aFOS.close();
  422. }
  423.  
  424. /**
  425.  * Wrapper function for nsIIOService::newURI.
  426.  * @param aURLSpec
  427.  *        The URL string from which to create an nsIURI.
  428.  * @returns an nsIURI object, or null if the creation of the URI failed.
  429.  */
  430. function makeURI(aURLSpec, aCharset) {
  431.   var ios = Cc["@mozilla.org/network/io-service;1"].
  432.             getService(Ci.nsIIOService);
  433.   try {
  434.     return ios.newURI(aURLSpec, aCharset, null);
  435.   } catch (ex) { }
  436.  
  437.   return null;
  438. }
  439.  
  440. /**
  441.  * Gets a directory from the directory service.
  442.  * @param aKey
  443.  *        The directory service key indicating the directory to get.
  444.  */
  445. function getDir(aKey) {
  446.   ENSURE_ARG(aKey, "getDir requires a directory key!");
  447.  
  448.   var fileLocator = Cc["@mozilla.org/file/directory_service;1"].
  449.                     getService(Ci.nsIProperties);
  450.   var dir = fileLocator.get(aKey, Ci.nsIFile);
  451.   return dir;
  452. }
  453.  
  454. /**
  455.  * The following two functions are essentially copied from
  456.  * nsInternetSearchService. They are required for backwards compatibility.
  457.  */
  458. function queryCharsetFromCode(aCode) {
  459.   const codes = [];
  460.   codes[0] = "x-mac-roman";
  461.   codes[6] = "x-mac-greek";
  462.   codes[35] = "x-mac-turkish";
  463.   codes[513] = "ISO-8859-1";
  464.   codes[514] = "ISO-8859-2";
  465.   codes[517] = "ISO-8859-5";
  466.   codes[518] = "ISO-8859-6";
  467.   codes[519] = "ISO-8859-7";
  468.   codes[520] = "ISO-8859-8";
  469.   codes[521] = "ISO-8859-9";
  470.   codes[1049] = "IBM864";
  471.   codes[1280] = "windows-1252";
  472.   codes[1281] = "windows-1250";
  473.   codes[1282] = "windows-1251";
  474.   codes[1283] = "windows-1253";
  475.   codes[1284] = "windows-1254";
  476.   codes[1285] = "windows-1255";
  477.   codes[1286] = "windows-1256";
  478.   codes[1536] = "us-ascii";
  479.   codes[1584] = "GB2312";
  480.   codes[1585] = "x-gbk";
  481.   codes[1600] = "EUC-KR";
  482.   codes[2080] = "ISO-2022-JP";
  483.   codes[2096] = "ISO-2022-CN";
  484.   codes[2112] = "ISO-2022-KR";
  485.   codes[2336] = "EUC-JP";
  486.   codes[2352] = "GB2312";
  487.   codes[2353] = "x-euc-tw";
  488.   codes[2368] = "EUC-KR";
  489.   codes[2561] = "Shift_JIS";
  490.   codes[2562] = "KOI8-R";
  491.   codes[2563] = "Big5";
  492.   codes[2565] = "HZ-GB-2312";
  493.  
  494.   if (codes[aCode])
  495.     return codes[aCode];
  496.  
  497.   return getLocalizedPref("intl.charset.default", DEFAULT_QUERY_CHARSET);
  498. }
  499. function fileCharsetFromCode(aCode) {
  500.   const codes = [
  501.     "x-mac-roman",           // 0
  502.     "Shift_JIS",             // 1
  503.     "Big5",                  // 2
  504.     "EUC-KR",                // 3
  505.     "X-MAC-ARABIC",          // 4
  506.     "X-MAC-HEBREW",          // 5
  507.     "X-MAC-GREEK",           // 6
  508.     "X-MAC-CYRILLIC",        // 7
  509.     "X-MAC-DEVANAGARI" ,     // 9
  510.     "X-MAC-GURMUKHI",        // 10
  511.     "X-MAC-GUJARATI",        // 11
  512.     "X-MAC-ORIYA",           // 12
  513.     "X-MAC-BENGALI",         // 13
  514.     "X-MAC-TAMIL",           // 14
  515.     "X-MAC-TELUGU",          // 15
  516.     "X-MAC-KANNADA",         // 16
  517.     "X-MAC-MALAYALAM",       // 17
  518.     "X-MAC-SINHALESE",       // 18
  519.     "X-MAC-BURMESE",         // 19
  520.     "X-MAC-KHMER",           // 20
  521.     "X-MAC-THAI",            // 21
  522.     "X-MAC-LAOTIAN",         // 22
  523.     "X-MAC-GEORGIAN",        // 23
  524.     "X-MAC-ARMENIAN",        // 24
  525.     "GB2312",                // 25
  526.     "X-MAC-TIBETAN",         // 26
  527.     "X-MAC-MONGOLIAN",       // 27
  528.     "X-MAC-ETHIOPIC",        // 28
  529.     "X-MAC-CENTRALEURROMAN", // 29
  530.     "X-MAC-VIETNAMESE",      // 30
  531.     "X-MAC-EXTARABIC"        // 31
  532.   ];
  533.   // Sherlock files have always defaulted to x-mac-roman, so do that here too
  534.   return codes[aCode] || codes[0];
  535. }
  536.  
  537. /**
  538.  * Returns a string interpretation of aBytes using aCharset, or null on
  539.  * failure.
  540.  */
  541. function bytesToString(aBytes, aCharset) {
  542.   var converter = Cc["@mozilla.org/intl/scriptableunicodeconverter"].
  543.                   createInstance(Ci.nsIScriptableUnicodeConverter);
  544.   LOG("bytesToString: converting using charset: " + aCharset);
  545.  
  546.   try {
  547.     converter.charset = aCharset;
  548.     return converter.convertFromByteArray(aBytes, aBytes.length);
  549.   } catch (ex) {}
  550.  
  551.   return null;
  552. }
  553.  
  554. /**
  555.  * Converts an array of bytes representing a Sherlock file into an array of
  556.  * lines representing the useful data from the file.
  557.  *
  558.  * @param aBytes
  559.  *        The array of bytes representing the Sherlock file.
  560.  * @param aCharsetCode
  561.  *        An integer value representing a character set code to be passed to
  562.  *        fileCharsetFromCode, or null for the default Sherlock encoding.
  563.  */
  564. function sherlockBytesToLines(aBytes, aCharsetCode) {
  565.   // fileCharsetFromCode returns the default encoding if aCharsetCode is null
  566.   var charset = fileCharsetFromCode(aCharsetCode);
  567.  
  568.   var dataString = bytesToString(aBytes, charset);
  569.   ENSURE(dataString, "sherlockBytesToLines: Couldn't convert byte array!",
  570.          Cr.NS_ERROR_FAILURE);
  571.  
  572.   // Split the string into lines, and filter out comments and
  573.   // whitespace-only lines
  574.   return dataString.split(NEW_LINES).filter(isUsefulLine);
  575. }
  576.  
  577. /**
  578.  * Gets the current value of the locale.  It's possible for this preference to
  579.  * be localized, so we have to do a little extra work here.  Similar code
  580.  * exists in nsHttpHandler.cpp when building the UA string.
  581.  */
  582. function getLocale() {
  583.   const localePref = "general.useragent.locale";
  584.   var locale = getLocalizedPref(localePref);
  585.   if (locale)
  586.     return locale;
  587.  
  588.   // Not localized
  589.   var prefs = Cc["@mozilla.org/preferences-service;1"].
  590.               getService(Ci.nsIPrefBranch);
  591.   return prefs.getCharPref(localePref);
  592. }
  593.  
  594. /**
  595.  * Wrapper for nsIPrefBranch::getComplexValue.
  596.  * @param aPrefName
  597.  *        The name of the pref to get.
  598.  * @returns aDefault if the requested pref doesn't exist.
  599.  */
  600. function getLocalizedPref(aPrefName, aDefault) {
  601.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  602.               getService(Ci.nsIPrefBranch);
  603.   const nsIPLS = Ci.nsIPrefLocalizedString;
  604.   try {
  605.     return prefB.getComplexValue(aPrefName, nsIPLS).data;
  606.   } catch (ex) {}
  607.  
  608.   return aDefault;
  609. }
  610.  
  611. /**
  612.  * Wrapper for nsIPrefBranch::setComplexValue.
  613.  * @param aPrefName
  614.  *        The name of the pref to set.
  615.  */
  616. function setLocalizedPref(aPrefName, aValue) {
  617.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  618.               getService(Ci.nsIPrefBranch);
  619.   const nsIPLS = Ci.nsIPrefLocalizedString;
  620.   try {
  621.     var pls = Components.classes["@mozilla.org/pref-localizedstring;1"]
  622.                         .createInstance(Ci.nsIPrefLocalizedString);
  623.     pls.data = aValue;
  624.     prefB.setComplexValue(aPrefName, nsIPLS, pls);
  625.   } catch (ex) {}
  626. }
  627.  
  628. /**
  629.  * Wrapper for nsIPrefBranch::getBoolPref.
  630.  * @param aPrefName
  631.  *        The name of the pref to get.
  632.  * @returns aDefault if the requested pref doesn't exist.
  633.  */
  634. function getBoolPref(aName, aDefault) {
  635.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  636.               getService(Ci.nsIPrefBranch);
  637.   try {
  638.     return prefB.getBoolPref(aName);
  639.   } catch (ex) {
  640.     return aDefault;
  641.   }
  642. }
  643.  
  644. /**
  645.  * Get a unique nsIFile object with a sanitized name, based on the engine name.
  646.  * @param aName
  647.  *        A name to "sanitize". Can be an empty string, in which case a random
  648.  *        8 character filename will be produced.
  649.  * @returns A nsIFile object in the user's search engines directory with a
  650.  *          unique sanitized name.
  651.  */
  652. function getSanitizedFile(aName) {
  653.   var fileName = sanitizeName(aName) + "." + XML_FILE_EXT;
  654.   var file = getDir(NS_APP_USER_SEARCH_DIR);
  655.   file.append(fileName);
  656.   file.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, PERMS_FILE);
  657.   return file;
  658. }
  659.  
  660. /**
  661.  * Removes all characters not in the "chars" string from aName.
  662.  *
  663.  * @returns a sanitized name to be used as a filename, or a random name
  664.  *          if a sanitized name cannot be obtained (if aName contains
  665.  *          no valid characters).
  666.  */
  667. function sanitizeName(aName) {
  668.   const chars = "-abcdefghijklmnopqrstuvwxyz0123456789";
  669.   const maxLength = 60;
  670.  
  671.   var name = aName.toLowerCase();
  672.   name = name.replace(/ /g, "-");
  673.   name = name.split("").filter(function (el) {
  674.                                  return chars.indexOf(el) != -1;
  675.                                }).join("");
  676.  
  677.   if (!name) {
  678.     // Our input had no valid characters - use a random name
  679.     var cl = chars.length - 1;
  680.     for (var i = 0; i < 8; ++i)
  681.       name += chars.charAt(Math.round(Math.random() * cl));
  682.   }
  683.  
  684.   if (name.length > maxLength)
  685.     name = name.substring(0, maxLength);
  686.  
  687.   return name;
  688. }
  689.  
  690. /**
  691.  * Notifies watchers of SEARCH_ENGINE_TOPIC about changes to an engine or to
  692.  * the state of the search service.
  693.  *
  694.  * @param aEngine
  695.  *        The nsISearchEngine object to which the change applies.
  696.  * @param aVerb
  697.  *        A verb describing the change.
  698.  *
  699.  * @see nsIBrowserSearchService.idl
  700.  */
  701. function notifyAction(aEngine, aVerb) {
  702.   var os = Cc["@mozilla.org/observer-service;1"].
  703.            getService(Ci.nsIObserverService);
  704.   LOG("NOTIFY: Engine: \"" + aEngine.name + "\"; Verb: \"" + aVerb + "\"");
  705.   os.notifyObservers(aEngine, SEARCH_ENGINE_TOPIC, aVerb);
  706. }
  707.  
  708. /**
  709.  * Simple object representing a name/value pair.
  710.  */
  711. function QueryParameter(aName, aValue) {
  712.   ENSURE_ARG(aName && (aValue != null),
  713.              "missing name or value for QueryParameter!");
  714.  
  715.   this.name = aName;
  716.   this.value = aValue;
  717. }
  718.  
  719. /**
  720.  * Perform OpenSearch parameter substitution on aParamValue.
  721.  *
  722.  * @param aParamValue
  723.  *        A string containing OpenSearch search parameters.
  724.  * @param aSearchTerms
  725.  *        The user-provided search terms. This string will inserted into
  726.  *        aParamValue as the value of the OS_PARAM_USER_DEFINED parameter.
  727.  *        This value must already be escaped appropriately - it is inserted
  728.  *        as-is.
  729.  * @param aQueryEncoding
  730.  *        The value to use for the OS_PARAM_INPUT_ENCODING parameter. See
  731.  *        definition in the OpenSearch spec.
  732.  *
  733.  * @see http://opensearch.a9.com/spec/1.1/querysyntax/#core
  734.  */
  735. function ParamSubstitution(aParamValue, aSearchTerms, aEngine) {
  736.   var value = aParamValue;
  737.  
  738.   var distributionID = MOZ_DISTRIBUTION_ID;
  739.   try {
  740.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  741.                 getService(Ci.nsIPrefBranch);
  742.     distributionID = prefB.getCharPref(BROWSER_SEARCH_PREF + "distributionID");
  743.   }
  744.   catch (ex) { }
  745.  
  746.   // Custom search parameters. These are only available to default search
  747.   // engines.
  748.   if (aEngine._isDefault) {
  749.     value = value.replace(MOZ_PARAM_LOCALE, getLocale());
  750.     value = value.replace(MOZ_PARAM_DIST_ID, distributionID);
  751.     value = value.replace(MOZ_PARAM_OFFICIAL, MOZ_OFFICIAL);
  752.   }
  753.  
  754.   // Insert the OpenSearch parameters we're confident about
  755.   value = value.replace(OS_PARAM_USER_DEFINED, aSearchTerms);
  756.   value = value.replace(OS_PARAM_INPUT_ENCODING, aEngine.queryCharset);
  757.   value = value.replace(OS_PARAM_LANGUAGE,
  758.                         getLocale() || OS_PARAM_LANGUAGE_DEF);
  759.   value = value.replace(OS_PARAM_OUTPUT_ENCODING,
  760.                         OS_PARAM_OUTPUT_ENCODING_DEF);
  761.  
  762.   // Replace any optional parameters
  763.   value = value.replace(OS_PARAM_OPTIONAL, "");
  764.  
  765.   // Insert any remaining required params with our default values
  766.   for (var i = 0; i < OS_UNSUPPORTED_PARAMS.length; ++i) {
  767.     value = value.replace(OS_UNSUPPORTED_PARAMS[i][0],
  768.                           OS_UNSUPPORTED_PARAMS[i][1]);
  769.   }
  770.  
  771.   return value;
  772. }
  773.  
  774. /**
  775.  * Creates a mozStorage statement that can be used to access the database we
  776.  * use to hold metadata.
  777.  *
  778.  * @param dbconn  the database that the statement applies to
  779.  * @param sql     a string specifying the sql statement that should be created
  780.  */
  781. function createStatement (dbconn, sql) {
  782.   var stmt = dbconn.createStatement(sql);
  783.   var wrapper = Cc["@mozilla.org/storage/statement-wrapper;1"].
  784.                 createInstance(Ci.mozIStorageStatementWrapper);
  785.  
  786.   wrapper.initialize(stmt);
  787.   return wrapper;
  788. }
  789.  
  790. /**
  791.  * Creates an engineURL object, which holds the query URL and all parameters.
  792.  *
  793.  * @param aType
  794.  *        A string containing the name of the MIME type of the search results
  795.  *        returned by this URL.
  796.  * @param aMethod
  797.  *        The HTTP request method. Must be a case insensitive value of either
  798.  *        "GET" or "POST".
  799.  * @param aTemplate
  800.  *        The URL to which search queries should be sent. For GET requests,
  801.  *        must contain the string "{searchTerms}", to indicate where the user
  802.  *        entered search terms should be inserted.
  803.  *
  804.  * @see http://opensearch.a9.com/spec/1.1/querysyntax/#urltag
  805.  *
  806.  * @throws NS_ERROR_NOT_IMPLEMENTED if aType is unsupported.
  807.  */
  808. function EngineURL(aType, aMethod, aTemplate) {
  809.   ENSURE_ARG(aType && aMethod && aTemplate,
  810.              "missing type, method or template for EngineURL!");
  811.  
  812.   var method = aMethod.toUpperCase();
  813.   var type   = aType.toLowerCase();
  814.  
  815.   ENSURE_ARG(method == "GET" || method == "POST",
  816.              "method passed to EngineURL must be \"GET\" or \"POST\"");
  817.  
  818.   this.type     = type;
  819.   this.method   = method;
  820.   this.params   = [];
  821.  
  822.   var templateURI = makeURI(aTemplate);
  823.   ENSURE(templateURI, "new EngineURL: template is not a valid URI!",
  824.          Cr.NS_ERROR_FAILURE);
  825.  
  826.   switch (templateURI.scheme) {
  827.     case "http":
  828.     case "https":
  829.     // Disable these for now, see bug 295018
  830.     // case "file":
  831.     // case "resource":
  832.       this.template = aTemplate;
  833.       break;
  834.     default:
  835.       ENSURE(false, "new EngineURL: template uses invalid scheme!",
  836.              Cr.NS_ERROR_FAILURE);
  837.   }
  838. }
  839. EngineURL.prototype = {
  840.  
  841.   addParam: function SRCH_EURL_addParam(aName, aValue) {
  842.     this.params.push(new QueryParameter(aName, aValue));
  843.   },
  844.  
  845.   getSubmission: function SRCH_EURL_getSubmission(aSearchTerms, aEngine) {
  846.     var url = ParamSubstitution(this.template, aSearchTerms, aEngine);
  847.  
  848.     // Create an application/x-www-form-urlencoded representation of our params
  849.     // (name=value&name=value&name=value)
  850.     var dataString = "";
  851.     for (var i = 0; i < this.params.length; ++i) {
  852.       var param = this.params[i];
  853.       var value = ParamSubstitution(param.value, aSearchTerms, aEngine);
  854.  
  855.       dataString += (i > 0 ? "&" : "") + param.name + "=" + value;
  856.     }
  857.  
  858.     var postData = null;
  859.     if (this.method == "GET") {
  860.       // GET method requests have no post data, and append the encoded
  861.       // query string to the url...
  862.       if (url.indexOf("?") == -1 && dataString)
  863.         url += "?";
  864.       url += dataString;
  865.     } else if (this.method == "POST") {
  866.       // POST method requests must wrap the encoded text in a MIME
  867.       // stream and supply that as POSTDATA.
  868.       var stringStream = Cc["@mozilla.org/io/string-input-stream;1"].
  869.                          createInstance(Ci.nsIStringInputStream);
  870. /*
  871. #ifdef MOZILLA_1_8_BRANCH
  872. # bug 318193
  873.       stringStream.setData(dataString, dataString.length);
  874. #else
  875. */
  876.       stringStream.data = dataString;
  877. /*
  878. #endif
  879. */
  880.       postData = Cc["@mozilla.org/network/mime-input-stream;1"].
  881.                  createInstance(Ci.nsIMIMEInputStream);
  882.       postData.addHeader("Content-Type", "application/x-www-form-urlencoded");
  883.       postData.addContentLength = true;
  884.       postData.setData(stringStream);
  885.     }
  886.  
  887.     return new Submission(makeURI(url), postData);
  888.   },
  889.  
  890.   /**
  891.    * Serializes the engine object to a OpenSearch Url element.
  892.    * @param aDoc
  893.    *        The document to use to create the Url element.
  894.    * @param aElement
  895.    *        The element to which the created Url element is appended.
  896.    *
  897.    * @see http://opensearch.a9.com/spec/1.1/querysyntax/#urltag
  898.    */
  899.   _serializeToElement: function SRCH_EURL_serializeToEl(aDoc, aElement) {
  900.     var url = aDoc.createElementNS(OPENSEARCH_NS_11, "Url");
  901.     url.setAttribute("type", this.type);
  902.     url.setAttribute("method", this.method);
  903.     url.setAttribute("template", this.template);
  904.  
  905.     for (var i = 0; i < this.params.length; ++i) {
  906.       var param = aDoc.createElementNS(OPENSEARCH_NS_11, "Param");
  907.       param.setAttribute("name", this.params[i].name);
  908.       param.setAttribute("value", this.params[i].value);
  909.       url.appendChild(aDoc.createTextNode("\n  "));
  910.       url.appendChild(param);
  911.     }
  912.     url.appendChild(aDoc.createTextNode("\n"));
  913.     aElement.appendChild(url);
  914.   }
  915. };
  916.  
  917. /**
  918.  * nsISearchEngine constructor.
  919.  * @param aLocation
  920.  *        A nsILocalFile or nsIURI object representing the location of the
  921.  *        search engine data file.
  922.  * @param aSourceDataType
  923.  *        The data type of the file used to describe the engine. Must be either
  924.  *        DATA_XML or DATA_TEXT.
  925.  * @param aIsReadOnly
  926.  *        Boolean indicating whether the engine should be treated as read-only.
  927.  *        Read only engines cannot be serialized to file.
  928.  */
  929. function Engine(aLocation, aSourceDataType, aIsReadOnly) {
  930.   this._dataType = aSourceDataType;
  931.   this._readOnly = aIsReadOnly;
  932.   this._urls = [];
  933.  
  934.   if (aLocation instanceof Ci.nsILocalFile) {
  935.     // we already have a file (e.g. loading engines from disk)
  936.     this._file = aLocation;
  937.   } else if (aLocation instanceof Ci.nsIURI) {
  938.     this._uri = aLocation;
  939.     switch (aLocation.scheme) {
  940.       case "https":
  941.       case "http":
  942.       case "ftp":
  943.       case "data":
  944.       case "file":
  945.       case "resource":
  946.       case "chrome":
  947.         this._uri = aLocation;
  948.         break;
  949.       default:
  950.         ERROR("Invalid URI passed to the nsISearchEngine constructor",
  951.               Cr.NS_ERROR_INVALID_ARG);
  952.     }
  953.   } else
  954.     ERROR("Engine location is neither a File nor a URI object",
  955.           Cr.NS_ERROR_INVALID_ARG);
  956. }
  957.  
  958. Engine.prototype = {
  959.   // The engine's alias.
  960.   _alias: null,
  961.   // The data describing the engine. Is either an array of bytes, for Sherlock
  962.   // files, or an XML document element, for XML plugins.
  963.   _data: null,
  964.   // The engine's data type. See data types (DATA_) defined above.
  965.   _dataType: null,
  966.   // Whether or not the engine is readonly.
  967.   _readOnly: true,
  968.   // The engine's description
  969.   _description: "",
  970.   // Used to store the engine to replace, if we're an update to an existing
  971.   // engine.
  972.   _engineToUpdate: null,
  973.   // The file from which the plugin was loaded.
  974.   _file: null,
  975.   // Set to true if the engine has a preferred icon (an icon that should not be
  976.   // overridden by a non-preferred icon).
  977.   _hasPreferredIcon: null,
  978.   // Whether the engine is hidden from the user.
  979.   _hidden: null,
  980.   // The engine's name.
  981.   _name: null,
  982.   // The engine type. See engine types (TYPE_) defined above.
  983.   _type: null,
  984.   // Space delimited keyword string
  985.   _tags: "",
  986.   // The name of the charset used to submit the search terms.
  987.   _queryCharset: null,
  988.   // A URL string pointing to the engine's search form.
  989.   _searchForm: null,
  990.   // The URI object from which the engine was retrieved.
  991.   // This is null for local plugins, and is used for error messages and logging.
  992.   _uri: null,
  993.   // Whether to obtain user confirmation before adding the engine. This is only
  994.   // used when the engine is first added to the list.
  995.   _confirm: false,
  996.   // Whether to set this as the current engine as soon as it is loaded.  This
  997.   // is only used when the engine is first added to the list.
  998.   _useNow: true,
  999.   // Where the engine was loaded from. Can be one of: SEARCH_APP_DIR,
  1000.   // SEARCH_PROFILE_DIR, SEARCH_IN_EXTENSION.
  1001.   __installLocation: null,
  1002.   // The number of days between update checks for new versions
  1003.   _updateInterval: null,
  1004.   // The url to check at for a new update
  1005.   _updateURL: null,
  1006.   // The url to check for a new icon
  1007.   _iconUpdateURL: null,
  1008.   // A reference to the timer used for lazily serializing the engine to file
  1009.   _serializeTimer: null,
  1010.  
  1011.   /**
  1012.    * Retrieves the data from the engine's file. If the engine's dataType is
  1013.    * XML, the document element is placed in the engine's data field. For text
  1014.    * engines, the data is just read directly from file and placed as an array
  1015.    * of lines in the engine's data field.
  1016.    */
  1017.   _initFromFile: function SRCH_ENG_initFromFile() {
  1018.     ENSURE(this._file && this._file.exists(),
  1019.            "File must exist before calling initFromFile!",
  1020.            Cr.NS_ERROR_UNEXPECTED);
  1021.  
  1022.     var fileInStream = Cc["@mozilla.org/network/file-input-stream;1"].
  1023.                        createInstance(Ci.nsIFileInputStream);
  1024.  
  1025.     fileInStream.init(this._file, MODE_RDONLY, PERMS_FILE, false);
  1026.  
  1027.     switch (this._dataType) {
  1028.       case SEARCH_DATA_XML:
  1029.         var domParser = Cc["@mozilla.org/xmlextras/domparser;1"].
  1030.                         createInstance(Ci.nsIDOMParser);
  1031.         var doc = domParser.parseFromStream(fileInStream, "UTF-8",
  1032.                                             this._file.fileSize,
  1033.                                             "text/xml");
  1034.  
  1035.         this._data = doc.documentElement;
  1036.         break;
  1037.       case SEARCH_DATA_TEXT:
  1038.         var binaryInStream = Cc["@mozilla.org/binaryinputstream;1"].
  1039.                              createInstance(Ci.nsIBinaryInputStream);
  1040.         binaryInStream.setInputStream(fileInStream);
  1041.  
  1042.         var bytes = binaryInStream.readByteArray(binaryInStream.available());
  1043.         this._data = bytes;
  1044.  
  1045.         break;
  1046.       default:
  1047.         ERROR("Bogus engine _dataType: \"" + this._dataType + "\"",
  1048.               Cr.NS_ERROR_UNEXPECTED);
  1049.     }
  1050.     fileInStream.close();
  1051.  
  1052.     // Now that the data is loaded, initialize the engine object
  1053.     this._initFromData();
  1054.   },
  1055.  
  1056.   /**
  1057.    * Retrieves the engine data from a URI.
  1058.    */
  1059.   _initFromURI: function SRCH_ENG_initFromURI() {
  1060.     ENSURE_WARN(this._uri instanceof Ci.nsIURI,
  1061.                 "Must have URI when calling _initFromURI!",
  1062.                 Cr.NS_ERROR_UNEXPECTED);
  1063.  
  1064.     LOG("_initFromURI: Downloading engine from: \"" + this._uri.spec + "\".");
  1065.  
  1066.     var ios = Cc["@mozilla.org/network/io-service;1"].
  1067.               getService(Ci.nsIIOService);
  1068.     var chan = ios.newChannelFromURI(this._uri);
  1069.  
  1070.     if (this._engineToUpdate && (chan instanceof Ci.nsIHttpChannel)) {
  1071.       var lastModified = engineMetadataService.getAttr(this._engineToUpdate,
  1072.                                                        "updatelastmodified");
  1073.       if (lastModified)
  1074.         chan.setRequestHeader("If-Modified-Since", lastModified, false);
  1075.     }
  1076.     var listener = new loadListener(chan, this, this._onLoad);
  1077.     chan.notificationCallbacks = listener;
  1078.     chan.asyncOpen(listener, null);
  1079.   },
  1080.  
  1081.   /**
  1082.    * Attempts to find an EngineURL object in the set of EngineURLs for
  1083.    * this Engine that has the given type string.  (This corresponds to the
  1084.    * "type" attribute in the "Url" node in the OpenSearch spec.)
  1085.    * This method will return the first matching URL object found, or null
  1086.    * if no matching URL is found.
  1087.    *
  1088.    * @param aType string to match the EngineURL's type attribute
  1089.    */
  1090.   _getURLOfType: function SRCH_ENG__getURLOfType(aType) {
  1091.     for (var i = 0; i < this._urls.length; ++i) {
  1092.       if (this._urls[i].type == aType)
  1093.         return this._urls[i];
  1094.     }
  1095.  
  1096.     return null;
  1097.   },
  1098.  
  1099.   _confirmAddEngine: function SRCH_SVC_confirmAddEngine() {
  1100.     var sbs = Cc["@mozilla.org/intl/stringbundle;1"].
  1101.               getService(Ci.nsIStringBundleService);
  1102.     var stringBundle = sbs.createBundle(SEARCH_BUNDLE);
  1103.     var titleMessage = stringBundle.GetStringFromName("addEngineConfirmTitle");
  1104.  
  1105.     // Display only the hostname portion of the URL.
  1106.     var dialogMessage =
  1107.         stringBundle.formatStringFromName("addEngineConfirmation",
  1108.                                           [this._name, this._uri.host], 2);
  1109.     var checkboxMessage = stringBundle.GetStringFromName("addEngineUseNowText");
  1110.     var addButtonLabel =
  1111.         stringBundle.GetStringFromName("addEngineAddButtonLabel");
  1112.  
  1113.     var ps = Cc["@mozilla.org/embedcomp/prompt-service;1"].
  1114.              getService(Ci.nsIPromptService);
  1115.     var buttonFlags = (ps.BUTTON_TITLE_IS_STRING * ps.BUTTON_POS_0) +
  1116.                       (ps.BUTTON_TITLE_CANCEL    * ps.BUTTON_POS_1) +
  1117.                        ps.BUTTON_POS_0_DEFAULT;
  1118.  
  1119.     var checked = {value: false};
  1120.     // confirmEx returns the index of the button that was pressed.  Since "Add"
  1121.     // is button 0, we want to return the negation of that value.
  1122.     var confirm = !ps.confirmEx(null,
  1123.                                 titleMessage,
  1124.                                 dialogMessage,
  1125.                                 buttonFlags,
  1126.                                 addButtonLabel,
  1127.                                 null, null, // button 1 & 2 names not used
  1128.                                 checkboxMessage,
  1129.                                 checked);
  1130.  
  1131.     return {confirmed: confirm, useNow: checked.value};
  1132.   },
  1133.  
  1134.   /**
  1135.    * Handle the successful download of an engine. Initializes the engine and
  1136.    * triggers parsing of the data. The engine is then flushed to disk. Notifies
  1137.    * the search service once initialization is complete.
  1138.    */
  1139.   _onLoad: function SRCH_ENG_onLoad(aBytes, aEngine) {
  1140.     /**
  1141.      * Handle an error during the load of an engine by prompting the user to
  1142.      * notify him that the load failed.
  1143.      */
  1144.     function onError(aErrorString, aTitleString) {
  1145.       if (aEngine._engineToUpdate) {
  1146.         // We're in an update, so just fail quietly
  1147.         LOG("updating " + aEngine._engineToUpdate.name + " failed");
  1148.         return;
  1149.       }
  1150.       var sbs = Cc["@mozilla.org/intl/stringbundle;1"].
  1151.                 getService(Ci.nsIStringBundleService);
  1152.  
  1153.       var brandBundle = sbs.createBundle(BRAND_BUNDLE);
  1154.       var brandName = brandBundle.GetStringFromName("brandShortName");
  1155.  
  1156.       var searchBundle = sbs.createBundle(SEARCH_BUNDLE);
  1157.       var msgStringName = aErrorString || "error_loading_engine_msg2";
  1158.       var titleStringName = aTitleString || "error_loading_engine_title";
  1159.       var title = searchBundle.GetStringFromName(titleStringName);
  1160.       var text = searchBundle.formatStringFromName(msgStringName,
  1161.                                                    [brandName, aEngine._location],
  1162.                                                    2);
  1163.  
  1164.       var ww = Cc["@mozilla.org/embedcomp/window-watcher;1"].
  1165.                getService(Ci.nsIWindowWatcher);
  1166.       ww.getNewPrompter(null).alert(title, text);
  1167.     }
  1168.  
  1169.     if (!aBytes) {
  1170.       onError();
  1171.       return;
  1172.     }
  1173.  
  1174.     var engineToUpdate = null;
  1175.     if (aEngine._engineToUpdate) {
  1176.       engineToUpdate = aEngine._engineToUpdate.wrappedJSObject;
  1177.  
  1178.       // Make this new engine use the old engine's file.
  1179.       aEngine._file = engineToUpdate._file;
  1180.     }
  1181.  
  1182.     switch (aEngine._dataType) {
  1183.       case SEARCH_DATA_XML:
  1184.         var parser = Cc["@mozilla.org/xmlextras/domparser;1"].
  1185.                      createInstance(Ci.nsIDOMParser);
  1186.         var doc = parser.parseFromBuffer(aBytes, aBytes.length, "text/xml");
  1187.         aEngine._data = doc.documentElement;
  1188.         break;
  1189.       case SEARCH_DATA_TEXT:
  1190.         aEngine._data = aBytes;
  1191.         break;
  1192.       default:
  1193.         onError();
  1194.         LOG("_onLoad: Bogus engine _dataType: \"" + this._dataType + "\"");
  1195.         return;
  1196.     }
  1197.  
  1198.     try {
  1199.       // Initialize the engine from the obtained data
  1200.       aEngine._initFromData();
  1201.     } catch (ex) {
  1202.       LOG("_onLoad: Failed to init engine!\n" + ex);
  1203.       // Report an error to the user
  1204.       onError();
  1205.       return;
  1206.     }
  1207.  
  1208.     // Check to see if this is a duplicate engine. If we're confirming the
  1209.     // engine load, then we display a "this is a duplicate engine" prompt,
  1210.     // otherwise we fail silently.
  1211.     if (!engineToUpdate) {
  1212.       var ss = Cc["@mozilla.org/browser/search-service;1"].
  1213.                getService(Ci.nsIBrowserSearchService);
  1214.       if (ss.getEngineByName(aEngine.name)) {
  1215.         if (aEngine._confirm)
  1216.           onError("error_duplicate_engine_msg", "error_invalid_engine_title");
  1217.  
  1218.         LOG("_onLoad: duplicate engine found, bailing");
  1219.         return;
  1220.       }
  1221.     }
  1222.  
  1223.     // If requested, confirm the addition now that we have the title.
  1224.     // This property is only ever true for engines added via
  1225.     // nsIBrowserSearchService::addEngine.
  1226.     if (aEngine._confirm) {
  1227.       var confirmation = aEngine._confirmAddEngine();
  1228.       LOG("_onLoad: confirm is " + confirmation.confirmed +
  1229.           "; useNow is " + confirmation.useNow);
  1230.       if (!confirmation.confirmed)
  1231.         return;
  1232.       aEngine._useNow = confirmation.useNow;
  1233.     }
  1234.  
  1235.     // If we don't yet have a file, get one now. The only case where we would
  1236.     // already have a file is if this is an update and _file was set above.
  1237.     if (!aEngine._file)
  1238.       aEngine._file = getSanitizedFile(aEngine.name);
  1239.  
  1240.     if (engineToUpdate) {
  1241.       // Keep track of the last modified date, so that we can make conditional
  1242.       // requests for future updates.
  1243.       engineMetadataService.setAttr(aEngine, "updatelastmodified",
  1244.                                     (new Date()).toUTCString());
  1245.  
  1246.       // Set the new engine's icon, if it doesn't yet have one.
  1247.       if (!aEngine._iconURI && engineToUpdate._iconURI)
  1248.         aEngine._iconURI = engineToUpdate._iconURI;
  1249.  
  1250.       // Clear the "use now" flag since we don't want to be changing the
  1251.       // current engine for an update.
  1252.       aEngine._useNow = false;
  1253.     }
  1254.  
  1255.     // Write the engine to file
  1256.     aEngine._serializeToFile();
  1257.  
  1258.     // Notify the search service of the sucessful load. It will deal with
  1259.     // updates by checking aEngine._engineToUpdate.
  1260.     notifyAction(aEngine, SEARCH_ENGINE_LOADED);
  1261.   },
  1262.  
  1263.   /**
  1264.    * Sets the .iconURI property of the engine.
  1265.    *
  1266.    *  @param aIconURL
  1267.    *         A URI string pointing to the engine's icon. Must have a http[s],
  1268.    *         ftp, or data scheme. Icons with HTTP[S] or FTP schemes will be
  1269.    *         downloaded and converted to data URIs for storage in the engine
  1270.    *         XML files, if the engine is not readonly.
  1271.    *  @param aIsPreferred
  1272.    *         Whether or not this icon is to be preferred. Preferred icons can
  1273.    *         override non-preferred icons.
  1274.    */
  1275.   _setIcon: function SRCH_ENG_setIcon(aIconURL, aIsPreferred) {
  1276.     // If we already have a preferred icon, and this isn't a preferred icon,
  1277.     // just ignore it.
  1278.     if (this._hasPreferredIcon && !aIsPreferred)
  1279.       return;
  1280.  
  1281.     var uri = makeURI(aIconURL);
  1282.  
  1283.     // Ignore bad URIs
  1284.     if (!uri)
  1285.       return;
  1286.  
  1287.     LOG("_setIcon: Setting icon url \"" + uri.spec + "\" for engine \""
  1288.         + this.name + "\".");
  1289.     // Only accept remote icons from http[s] or ftp
  1290.     switch (uri.scheme) {
  1291.       // Songbird: Accept chrome icons. Needed for library stub.
  1292.       case "chrome":
  1293.       case "data":
  1294.         this._iconURI = uri;
  1295.         notifyAction(this, SEARCH_ENGINE_CHANGED);
  1296.         this._hasPreferredIcon = aIsPreferred;
  1297.         break;
  1298.       case "http":
  1299.       case "https":
  1300.       case "ftp":
  1301.         // No use downloading the icon if the engine file is read-only
  1302.         if (!this._readOnly) {
  1303.           LOG("_setIcon: Downloading icon: \"" + uri.spec +
  1304.               "\" for engine: \"" + this.name + "\"");
  1305.           var ios = Cc["@mozilla.org/network/io-service;1"].
  1306.                     getService(Ci.nsIIOService);
  1307.           var chan = ios.newChannelFromURI(uri);
  1308.  
  1309.           function iconLoadCallback(aByteArray, aEngine) {
  1310.             // This callback may run after we've already set a preferred icon,
  1311.             // so check again.
  1312.             if (aEngine._hasPreferredIcon && !aIsPreferred)
  1313.               return;
  1314.  
  1315.             if (!aByteArray || aByteArray.length > MAX_ICON_SIZE) {
  1316.               LOG("iconLoadCallback: load failed, or the icon was too large!");
  1317.               return;
  1318.             }
  1319.  
  1320.             var str = btoa(String.fromCharCode.apply(null, aByteArray));
  1321.             aEngine._iconURI = makeURI(ICON_DATAURL_PREFIX + str);
  1322.  
  1323.             // The engine might not have a file yet, if it's being downloaded,
  1324.             // because the request for the engine file itself (_onLoad) may not
  1325.             // yet be complete. In that case, this change will be written to
  1326.             // file when _onLoad is called.
  1327.             if (aEngine._file)
  1328.               aEngine._serializeToFile();
  1329.  
  1330.             notifyAction(aEngine, SEARCH_ENGINE_CHANGED);
  1331.             aEngine._hasPreferredIcon = aIsPreferred;
  1332.           }
  1333.  
  1334.           // If we're currently acting as an "update engine", then the callback
  1335.           // should set the icon on the engine we're updating and not us, since
  1336.           // |this| might be gone by the time the callback runs.
  1337.           var engineToSet = this._engineToUpdate || this;
  1338.  
  1339.           var listener = new loadListener(chan, engineToSet, iconLoadCallback);
  1340.           chan.notificationCallbacks = listener;
  1341.           chan.asyncOpen(listener, null);
  1342.         }
  1343.         break;
  1344.     }
  1345.   },
  1346.  
  1347.   /**
  1348.    * Initialize this Engine object from the collected data.
  1349.    */
  1350.   _initFromData: function SRCH_ENG_initFromData() {
  1351.  
  1352.     ENSURE_WARN(this._data, "Can't init an engine with no data!",
  1353.                 Cr.NS_ERROR_UNEXPECTED);
  1354.  
  1355.     // Find out what type of engine we are
  1356.     switch (this._dataType) {
  1357.       case SEARCH_DATA_XML:
  1358.         if (checkNameSpace(this._data, [MOZSEARCH_LOCALNAME],
  1359.             [MOZSEARCH_NS_10])) {
  1360.  
  1361.           LOG("_init: Initing MozSearch plugin from " + this._location);
  1362.  
  1363.           this._type = SEARCH_TYPE_MOZSEARCH;
  1364.           this._parseAsMozSearch();
  1365.  
  1366.         } else if (checkNameSpace(this._data, [OPENSEARCH_LOCALNAME],
  1367.                                   OPENSEARCH_NAMESPACES)) {
  1368.  
  1369.           LOG("_init: Initing OpenSearch plugin from " + this._location);
  1370.  
  1371.           this._type = SEARCH_TYPE_OPENSEARCH;
  1372.           this._parseAsOpenSearch();
  1373.  
  1374.         } else
  1375.           ENSURE(false, this._location + " is not a valid search plugin.",
  1376.                  Cr.NS_ERROR_FAILURE);
  1377.  
  1378.         break;
  1379.       case SEARCH_DATA_TEXT:
  1380.         LOG("_init: Initing Sherlock plugin from " + this._location);
  1381.  
  1382.         // the only text-based format we support is Sherlock
  1383.         this._type = SEARCH_TYPE_SHERLOCK;
  1384.         this._parseAsSherlock();
  1385.     }
  1386.  
  1387.     // No need to keep a ref to our data (which in some cases can be a document
  1388.     // element) past this point
  1389.     this._data = null;
  1390.   },
  1391.  
  1392.   /**
  1393.    * Initialize this Engine object from a collection of metadata.
  1394.    */
  1395.   _initFromMetadata: function SRCH_ENG_initMetaData(aName, aIconURL, aAlias,
  1396.                                                     aDescription, aMethod,
  1397.                                                     aTemplate) {
  1398.     ENSURE_WARN(!this._readOnly,
  1399.                 "Can't call _initFromMetaData on a readonly engine!",
  1400.                 Cr.NS_ERROR_FAILURE);
  1401.  
  1402.     this._urls.push(new EngineURL("text/html", aMethod, aTemplate));
  1403.  
  1404.     this._name = aName;
  1405.     this._alias = aAlias;
  1406.     this._description = aDescription;
  1407.     this._setIcon(aIconURL, true);
  1408.  
  1409.     this._serializeToFile();
  1410.   },
  1411.  
  1412.   /**
  1413.    * Extracts data from an OpenSearch URL element and creates an EngineURL
  1414.    * object which is then added to the engine's list of URLs.
  1415.    *
  1416.    * @throws NS_ERROR_FAILURE if a URL object could not be created.
  1417.    *
  1418.    * @see http://opensearch.a9.com/spec/1.1/querysyntax/#urltag.
  1419.    * @see EngineURL()
  1420.    */
  1421.   _parseURL: function SRCH_ENG_parseURL(aElement) {
  1422.     var type     = aElement.getAttribute("type");
  1423.     // According to the spec, method is optional, defaulting to "GET" if not
  1424.     // specified
  1425.     var method   = aElement.getAttribute("method") || "GET";
  1426.     var template = aElement.getAttribute("template");
  1427.  
  1428.     try {
  1429.       var url = new EngineURL(type, method, template);
  1430.     } catch (ex) {
  1431.       LOG("_parseURL: failed to add " + template + " as a URL");
  1432.       throw Cr.NS_ERROR_FAILURE;
  1433.     }
  1434.  
  1435.     for (var i = 0; i < aElement.childNodes.length; ++i) {
  1436.       var param = aElement.childNodes[i];
  1437.       if (param.localName == "Param") {
  1438.         try {
  1439.           url.addParam(param.getAttribute("name"), param.getAttribute("value"));
  1440.         } catch (ex) {
  1441.           // Ignore failure
  1442.           LOG("_parseURL: Url element has an invalid param");
  1443.         }
  1444.       } else if (param.localName == "MozParam" &&
  1445.                  // We only support MozParams for default search engines
  1446.                  this._isDefault) {
  1447.         var value;
  1448.         switch (param.getAttribute("condition")) {
  1449.           case "defaultEngine":
  1450.             const defPref = BROWSER_SEARCH_PREF + "defaultenginename";
  1451.             var defaultPrefB = Cc["@mozilla.org/preferences-service;1"].
  1452.                                getService(Ci.nsIPrefService).
  1453.                                getDefaultBranch(null);
  1454.             const nsIPLS = Ci.nsIPrefLocalizedString;
  1455.             var defaultName;
  1456.             try {
  1457.               defaultName = defaultPrefB.getComplexValue(defPref, nsIPLS).data;
  1458.             } catch (ex) {}
  1459.  
  1460.             // If this engine was the default search engine, use the true value
  1461.             if (this.name == defaultName)
  1462.               value = param.getAttribute("trueValue");
  1463.             else
  1464.               value = param.getAttribute("falseValue");
  1465.             url.addParam(param.getAttribute("name"), value);
  1466.             break;
  1467.  
  1468.           case "pref":
  1469.             try {
  1470.               var prefB = Cc["@mozilla.org/preferences-service;1"].
  1471.                           getService(Ci.nsIPrefBranch);
  1472.               value = prefB.getCharPref(BROWSER_SEARCH_PREF + "param." +
  1473.                                         param.getAttribute("pref"));
  1474.               url.addParam(param.getAttribute("name"), value);
  1475.             } catch (e) { }
  1476.             break;
  1477.         }
  1478.       }
  1479.     }
  1480.  
  1481.     this._urls.push(url);
  1482.   },
  1483.  
  1484.   /**
  1485.    * Get the icon from an OpenSearch Image element.
  1486.    * @see http://opensearch.a9.com/spec/1.1/description/#image
  1487.    */
  1488.   _parseImage: function SRCH_ENG_parseImage(aElement) {
  1489.     LOG("_parseImage: Image textContent: \"" + aElement.textContent + "\"");
  1490.     if (aElement.getAttribute("width")  == "16" &&
  1491.         aElement.getAttribute("height") == "16") {
  1492.       this._setIcon(aElement.textContent, true);
  1493.     }
  1494.   },
  1495.  
  1496.   _parseAsMozSearch: function SRCH_ENG_parseAsMoz() {
  1497.     //forward to the OpenSearch parser
  1498.     this._parseAsOpenSearch();
  1499.   },
  1500.  
  1501.   /**
  1502.    * Extract search engine information from the collected data to initialize
  1503.    * the engine object.
  1504.    */
  1505.   _parseAsOpenSearch: function SRCH_ENG_parseAsOS() {
  1506.     var doc = this._data;
  1507.  
  1508.     // The OpenSearch spec sets a default value for the input encoding.
  1509.     this._queryCharset = OS_PARAM_INPUT_ENCODING_DEF;
  1510.  
  1511.     for (var i = 0; i < doc.childNodes.length; ++i) {
  1512.       var child = doc.childNodes[i];
  1513.       switch (child.localName) {
  1514.         case "ShortName":
  1515.           this._name = child.textContent;
  1516.           break;
  1517.         case "Description":
  1518.           this._description = child.textContent;
  1519.           break;
  1520.         case "Url":
  1521.           try {
  1522.             this._parseURL(child);
  1523.           } catch (ex) {
  1524.             // Parsing of the element failed, just skip it.
  1525.           }
  1526.           break;
  1527.         case "Image":
  1528.           this._parseImage(child);
  1529.           break;
  1530.         case "InputEncoding":
  1531.           this._queryCharset = child.textContent.toUpperCase();
  1532.           break;
  1533.         case "Tags":
  1534.           this._tags = child.textContent;
  1535.           break;          
  1536.  
  1537.         // Non-OpenSearch elements
  1538.         case "Alias":
  1539.           this._alias = child.textContent;
  1540.           break;
  1541.         case "SearchForm":
  1542.           this._searchForm = child.textContent;
  1543.           break;
  1544.         case "UpdateUrl":
  1545.           this._updateURL = child.textContent;
  1546.           break;
  1547.         case "UpdateInterval":
  1548.           this._updateInterval = parseInt(child.textContent);
  1549.           break;
  1550.         case "IconUpdateUrl":
  1551.           this._iconUpdateURL = child.textContent;
  1552.           break;
  1553.       }
  1554.     }
  1555.     ENSURE(this.name && (this._urls.length > 0),
  1556.            "_parseAsOpenSearch: No name, or missing URL!",
  1557.            Cr.NS_ERROR_FAILURE);
  1558.     ENSURE(this.supportsResponseType(URLTYPE_SEARCH_HTML),
  1559.            "_parseAsOpenSearch: No text/html result type!",
  1560.            Cr.NS_ERROR_FAILURE);
  1561.   },
  1562.  
  1563.   /**
  1564.    * Extract search engine information from the collected data to initialize
  1565.    * the engine object.
  1566.    */
  1567.   _parseAsSherlock: function SRCH_ENG_parseAsSherlock() {
  1568.     /**
  1569.      * Trims leading and trailing whitespace from aStr.
  1570.      */
  1571.     function sTrim(aStr) {
  1572.       return aStr.replace(/^\s+/g, "").replace(/\s+$/g, "");
  1573.     }
  1574.  
  1575.     /**
  1576.      * Extracts one Sherlock "section" from aSource. A section is essentially
  1577.      * an HTML element with attributes, but each attribute must be on a new
  1578.      * line, by definition.
  1579.      *
  1580.      * @param aLines
  1581.      *        An array of lines from the sherlock file.
  1582.      * @param aSection
  1583.      *        The name of the section (e.g. "search" or "browser"). This value
  1584.      *        is not case sensitive.
  1585.      * @returns an object whose properties correspond to the section's
  1586.      *          attributes.
  1587.      */
  1588.     function getSection(aLines, aSection) {
  1589.       LOG("_parseAsSherlock::getSection: Sherlock lines:\n" +
  1590.           aLines.join("\n"));
  1591.       var lines = aLines;
  1592.       var startMark = new RegExp("^\\s*<" + aSection.toLowerCase() + "\\s*",
  1593.                                  "gi");
  1594.       var endMark   = /\s*>\s*$/gi;
  1595.  
  1596.       var foundStart = false;
  1597.       var startLine, numberOfLines;
  1598.       // Find the beginning and end of the section
  1599.       for (var i = 0; i < lines.length; i++) {
  1600.         if (foundStart) {
  1601.           if (endMark.test(lines[i])) {
  1602.             numberOfLines = i - startLine;
  1603.             // Remove the end marker
  1604.             lines[i] = lines[i].replace(endMark, "");
  1605.             // If the endmarker was not the only thing on the line, include
  1606.             // this line in the results
  1607.             if (lines[i])
  1608.               numberOfLines++;
  1609.             break;
  1610.           }
  1611.         } else {
  1612.           if (startMark.test(lines[i])) {
  1613.             foundStart = true;
  1614.             // Remove the start marker
  1615.             lines[i] = lines[i].replace(startMark, "");
  1616.             startLine = i;
  1617.             // If the line is empty, don't include it in the result
  1618.             if (!lines[i])
  1619.               startLine++;
  1620.           }
  1621.         }
  1622.       }
  1623.       LOG("_parseAsSherlock::getSection: Start index: " + startLine +
  1624.           "\nNumber of lines: " + numberOfLines);
  1625.       lines = lines.splice(startLine, numberOfLines);
  1626.       LOG("_parseAsSherlock::getSection: Section lines:\n" +
  1627.           lines.join("\n"));
  1628.  
  1629.       var section = {};
  1630.       for (var i = 0; i < lines.length; i++) {
  1631.         var line = sTrim(lines[i]);
  1632.  
  1633.         var els = line.split("=");
  1634.         var name = sTrim(els.shift().toLowerCase());
  1635.         var value = sTrim(els.join("="));
  1636.  
  1637.         if (!name || !value)
  1638.           continue;
  1639.  
  1640.         // Strip leading and trailing whitespace, remove quotes from the
  1641.         // value, and remove any trailing slashes or ">" characters
  1642.         value = value.replace(/^["']/, "")
  1643.                      .replace(/["']\s*[\\\/]?>?\s*$/, "") || "";
  1644.         value = sTrim(value);
  1645.  
  1646.         // Don't clobber existing attributes
  1647.         if (!(name in section))
  1648.           section[name] = value;
  1649.       }
  1650.       return section;
  1651.     }
  1652.  
  1653.     /**
  1654.      * Returns an array of name-value pair arrays representing the Sherlock
  1655.      * file's input elements. User defined inputs return USER_DEFINED
  1656.      * as the value. Elements are returned in the order they appear in the
  1657.      * source file.
  1658.      *
  1659.      *   Example:
  1660.      *      <input name="foo" value="bar">
  1661.      *      <input name="foopy" user>
  1662.      *   Returns:
  1663.      *      [["foo", "bar"], ["foopy", "{searchTerms}"]]
  1664.      *
  1665.      * @param aLines
  1666.      *        An array of lines from the source file.
  1667.      */
  1668.     function getInputs(aLines) {
  1669.  
  1670.       /**
  1671.        * Extracts an attribute value from a given a line of text.
  1672.        *    Example: <input value="foo" name="bar">
  1673.        *      Extracts the string |foo| or |bar| given an input aAttr of
  1674.        *      |value| or |name|.
  1675.        * Attributes may be quoted or unquoted. If unquoted, any whitespace
  1676.        * indicates the end of the attribute value.
  1677.        *    Example: < value=22 33 name=44\334 >
  1678.        *      Returns |22| for "value" and |44\334| for "name".
  1679.        *
  1680.        * @param aAttr
  1681.        *        The name of the attribute for which to obtain the value. This
  1682.        *        value is not case sensitive.
  1683.        * @param aLine
  1684.        *        The line containing the attribute.
  1685.        *
  1686.        * @returns the attribute value, or an empty string if the attribute
  1687.        *          doesn't exist.
  1688.        */
  1689.       function getAttr(aAttr, aLine) {
  1690.         // Used to determine whether an "input" line from a Sherlock file is a
  1691.         // "user defined" input.
  1692.         const userInput = /(\s|["'=])user(\s|[>="'\/\\+]|$)/i;
  1693.  
  1694.         LOG("_parseAsSherlock::getAttr: Getting attr: \"" +
  1695.             aAttr + "\" for line: \"" + aLine + "\"");
  1696.         // We're not case sensitive, but we want to return the attribute value
  1697.         // in its original case, so create a copy of the source
  1698.         var lLine = aLine.toLowerCase();
  1699.         var attr = aAttr.toLowerCase();
  1700.  
  1701.         var attrStart = lLine.search(new RegExp("\\s" + attr, "i"));
  1702.         if (attrStart == -1) {
  1703.  
  1704.           // If this is the "user defined input" (i.e. contains the empty
  1705.           // "user" attribute), return our special keyword
  1706.           if (userInput.test(lLine) && attr == "value") {
  1707.             LOG("_parseAsSherlock::getAttr: Found user input!\nLine:\"" + lLine
  1708.                 + "\"");
  1709.             return USER_DEFINED;
  1710.           }
  1711.           // The attribute doesn't exist - ignore
  1712.           LOG("_parseAsSherlock::getAttr: Failed to find attribute:\nLine:\""
  1713.               + lLine + "\"\nAttr:\"" + attr + "\"");
  1714.           return "";
  1715.         }
  1716.  
  1717.         var valueStart = lLine.indexOf("=", attrStart) + "=".length;
  1718.         if (valueStart == -1)
  1719.           return "";
  1720.  
  1721.         var quoteStart = lLine.indexOf("\"", valueStart);
  1722.         if (quoteStart == -1) {
  1723.  
  1724.           // Unquoted attribute, get the rest of the line, trimmed at the first
  1725.           // sign of whitespace. If the rest of the line is only whitespace,
  1726.           // returns a blank string.
  1727.           return lLine.substr(valueStart).replace(/\s.*$/, "");
  1728.  
  1729.         } else {
  1730.           // Make sure that there's only whitespace between the start of the
  1731.           // value and the first quote. If there is, end the attribute value at
  1732.           // the first sign of whitespace. This prevents us from falling into
  1733.           // the next attribute if this is an unquoted attribute followed by a
  1734.           // quoted attribute.
  1735.           var betweenEqualAndQuote = lLine.substring(valueStart, quoteStart);
  1736.           if (/\S/.test(betweenEqualAndQuote))
  1737.             return lLine.substr(valueStart).replace(/\s.*$/, "");
  1738.  
  1739.           // Adjust the start index to account for the opening quote
  1740.           valueStart = quoteStart + "\"".length;
  1741.           // Find the closing quote
  1742.           valueEnd = lLine.indexOf("\"", valueStart);
  1743.           // If there is no closing quote, just go to the end of the line
  1744.           if (valueEnd == -1)
  1745.             valueEnd = aLine.length;
  1746.         }
  1747.         return aLine.substring(valueStart, valueEnd);
  1748.       }
  1749.  
  1750.       var inputs = [];
  1751.  
  1752.       LOG("_parseAsSherlock::getInputs: Lines:\n" + aLines);
  1753.       // Filter out everything but non-inputs
  1754.       lines = aLines.filter(function (line) {
  1755.         return /^\s*<input/i.test(line);
  1756.       });
  1757.       LOG("_parseAsSherlock::getInputs: Filtered lines:\n" + lines);
  1758.  
  1759.       lines.forEach(function (line) {
  1760.         // Strip leading/trailing whitespace and remove the surrounding markup
  1761.         // ("<input" and ">")
  1762.         line = sTrim(line).replace(/^<input/i, "").replace(/>$/, "");
  1763.  
  1764.         // If this is one of the "directional" inputs (<inputnext>/<inputprev>)
  1765.         const directionalInput = /^(prev|next)/i;
  1766.         if (directionalInput.test(line)) {
  1767.  
  1768.           // Make it look like a normal input by removing "prev" or "next"
  1769.           line = line.replace(directionalInput, "");
  1770.  
  1771.           // If it has a name, give it a dummy value to match previous
  1772.           // nsInternetSearchService behavior
  1773.           if (/name\s*=/i.test(line)) {
  1774.             line += " value=\"0\"";
  1775.           } else
  1776.             return; // Line has no name, skip it
  1777.         }
  1778.  
  1779.         var attrName = getAttr("name", line);
  1780.         var attrValue = getAttr("value", line);
  1781.         LOG("_parseAsSherlock::getInputs: Got input:\nName:\"" + attrName +
  1782.             "\"\nValue:\"" + attrValue + "\"");
  1783.         if (attrValue)
  1784.           inputs.push([attrName, attrValue]);
  1785.       });
  1786.       return inputs;
  1787.     }
  1788.  
  1789.     function err(aErr) {
  1790.       LOG("_parseAsSherlock::err: Sherlock param error:\n" + aErr);
  1791.       throw Cr.NS_ERROR_FAILURE;
  1792.     }
  1793.  
  1794.     // First try converting our byte array using the default Sherlock encoding.
  1795.     // If this fails, or if we find a sourceTextEncoding attribute, we need to
  1796.     // reconvert the byte array using the specified encoding.
  1797.     var sherlockLines, searchSection, sourceTextEncoding, browserSection;
  1798.     try {
  1799.       sherlockLines = sherlockBytesToLines(this._data);
  1800.       searchSection = getSection(sherlockLines, "search");
  1801.       browserSection = getSection(sherlockLines, "browser");
  1802.       sourceTextEncoding = parseInt(searchSection["sourcetextencoding"]);
  1803.       if (sourceTextEncoding) {
  1804.         // Re-convert the bytes using the found sourceTextEncoding
  1805.         sherlockLines = sherlockBytesToLines(this._data, sourceTextEncoding);
  1806.         searchSection = getSection(sherlockLines, "search");
  1807.         browserSection = getSection(sherlockLines, "browser");
  1808.       }
  1809.     } catch (ex) {
  1810.       // The conversion using the default charset failed. Remove any non-ascii
  1811.       // bytes and try to find a sourceTextEncoding.
  1812.       var asciiBytes = this._data.filter(function (n) {return !(0x80 & n);});
  1813.       var asciiString = String.fromCharCode.apply(null, asciiBytes);
  1814.       sherlockLines = asciiString.split(NEW_LINES).filter(isUsefulLine);
  1815.       searchSection = getSection(sherlockLines, "search");
  1816.       sourceTextEncoding = parseInt(searchSection["sourcetextencoding"]);
  1817.       if (sourceTextEncoding) {
  1818.         sherlockLines = sherlockBytesToLines(this._data, sourceTextEncoding);
  1819.         searchSection = getSection(sherlockLines, "search");
  1820.         browserSection = getSection(sherlockLines, "browser");
  1821.       } else
  1822.         ERROR("Couldn't find a working charset", Cr.NS_ERROR_FAILURE);
  1823.     }
  1824.  
  1825.     LOG("_parseAsSherlock: Search section:\n" + searchSection.toSource());
  1826.  
  1827.     this._name = searchSection["name"] || err("Missing name!");
  1828.     this._description = searchSection["description"] || "";
  1829.     this._queryCharset = searchSection["querycharset"] ||
  1830.                          queryCharsetFromCode(searchSection["queryencoding"]);
  1831.     this._searchForm = searchSection["searchform"];
  1832.  
  1833.     this._updateInterval = parseInt(browserSection["updatecheckdays"]);
  1834.  
  1835.     this._updateURL = browserSection["update"];
  1836.     this._iconUpdateURL = browserSection["updateicon"];
  1837.  
  1838.     var method = (searchSection["method"] || "GET").toUpperCase();
  1839.     var template = searchSection["action"] || err("Missing action!");
  1840.  
  1841.     var inputs = getInputs(sherlockLines);
  1842.     LOG("_parseAsSherlock: Inputs:\n" + inputs.toSource());
  1843.  
  1844.     var url = null;
  1845.  
  1846.     if (method == "GET") {
  1847.       // Here's how we construct the input string:
  1848.       // <input> is first:  Name Attr:  Prefix      Data           Example:
  1849.       // YES                EMPTY       None        <value>        TEMPLATE<value>
  1850.       // YES                NON-EMPTY   ?           <name>=<value> TEMPLATE?<name>=<value>
  1851.       // NO                 EMPTY       ------------- <ignored> --------------
  1852.       // NO                 NON-EMPTY   &           <name>=<value> TEMPLATE?<n1>=<v1>&<n2>=<v2>
  1853.       for (var i = 0; i < inputs.length; i++) {
  1854.         var name  = inputs[i][0];
  1855.         var value = inputs[i][1];
  1856.         if (i==0) {
  1857.           if (name == "")
  1858.             template += USER_DEFINED;
  1859.           else
  1860.             template += "?" + name + "=" + value;
  1861.         } else if (name != "")
  1862.           template += "&" + name + "=" + value;
  1863.       }
  1864.       url = new EngineURL("text/html", method, template);
  1865.  
  1866.     } else if (method == "POST") {
  1867.       // Create the URL object and just add the parameters directly
  1868.       url = new EngineURL("text/html", method, template);
  1869.       for (var i = 0; i < inputs.length; i++) {
  1870.         var name  = inputs[i][0];
  1871.         var value = inputs[i][1];
  1872.         if (name)
  1873.           url.addParam(name, value);
  1874.       }
  1875.     } else
  1876.       err("Invalid method!");
  1877.  
  1878.     this._urls.push(url);
  1879.   },
  1880.  
  1881.   /**
  1882.    * Returns an XML document object containing the search plugin information,
  1883.    * which can later be used to reload the engine.
  1884.    */
  1885.   _serializeToElement: function SRCH_ENG_serializeToEl() {
  1886.     function appendTextNode(aNameSpace, aLocalName, aValue) {
  1887.       if (!aValue)
  1888.         return null;
  1889.       var node = doc.createElementNS(aNameSpace, aLocalName);
  1890.       node.appendChild(doc.createTextNode(aValue));
  1891.       docElem.appendChild(node);
  1892.       docElem.appendChild(doc.createTextNode("\n"));
  1893.       return node;
  1894.     }
  1895.  
  1896.     var parser = Cc["@mozilla.org/xmlextras/domparser;1"].
  1897.                  createInstance(Ci.nsIDOMParser);
  1898.  
  1899.     var doc = parser.parseFromString(EMPTY_DOC, "text/xml");
  1900.     docElem = doc.documentElement;
  1901.  
  1902.     docElem.appendChild(doc.createTextNode("\n"));
  1903.  
  1904.     appendTextNode(OPENSEARCH_NS_11, "ShortName", this.name);
  1905.     appendTextNode(OPENSEARCH_NS_11, "Description", this._description);
  1906.     appendTextNode(OPENSEARCH_NS_11, "InputEncoding", this._queryCharset);
  1907.  
  1908.     if (this._iconURI) {
  1909.       var imageNode = appendTextNode(OPENSEARCH_NS_11, "Image",
  1910.                                      this._iconURI.spec);
  1911.       if (imageNode) {
  1912.         imageNode.setAttribute("width", "16");
  1913.         imageNode.setAttribute("height", "16");
  1914.       }
  1915.     }
  1916.  
  1917.     appendTextNode(MOZSEARCH_NS_10, "Alias", this.alias);
  1918.     appendTextNode(MOZSEARCH_NS_10, "UpdateInterval", this._updateInterval);
  1919.     appendTextNode(MOZSEARCH_NS_10, "UpdateUrl", this._updateURL);
  1920.     appendTextNode(MOZSEARCH_NS_10, "IconUpdateUrl", this._iconUpdateURL);
  1921.     appendTextNode(MOZSEARCH_NS_10, "SearchForm", this._searchForm);
  1922.  
  1923.     for (var i = 0; i < this._urls.length; ++i)
  1924.       this._urls[i]._serializeToElement(doc, docElem);
  1925.     docElem.appendChild(doc.createTextNode("\n"));
  1926.  
  1927.     return doc;
  1928.   },
  1929.  
  1930.   _lazySerializeToFile: function SRCH_ENG_serializeToFile() {
  1931.     if (this._serializeTimer) {
  1932.       // Reset the timer
  1933.       this._serializeTimer.delay = LAZY_SERIALIZE_DELAY;
  1934.     } else {
  1935.       this._serializeTimer = Cc["@mozilla.org/timer;1"].
  1936.                              createInstance(Ci.nsITimer);
  1937.       var timerCallback = {
  1938.         self: this,
  1939.         notify: function SRCH_ENG_notify(aTimer) {
  1940.           try {
  1941.             this.self._serializeToFile();
  1942.           } catch (ex) {
  1943.             LOG("Serialization from timer callback failed:\n" + ex);
  1944.           }
  1945.           this.self._serializeTimer = null;
  1946.         }
  1947.       };
  1948.       this._serializeTimer.initWithCallback(timerCallback,
  1949.                                             LAZY_SERIALIZE_DELAY,
  1950.                                             Ci.nsITimer.TYPE_ONE_SHOT);
  1951.     }
  1952.   },
  1953.  
  1954.   /**
  1955.    * Serializes the engine object to file.
  1956.    */
  1957.   _serializeToFile: function SRCH_ENG_serializeToFile() {
  1958.     var file = this._file;
  1959.     ENSURE_WARN(!this._readOnly, "Can't serialize a read only engine!",
  1960.                 Cr.NS_ERROR_FAILURE);
  1961.     ENSURE_WARN(file && file.exists(), "Can't serialize: file doesn't exist!",
  1962.                 Cr.NS_ERROR_UNEXPECTED);
  1963.  
  1964.     var fos = Cc["@mozilla.org/network/safe-file-output-stream;1"].
  1965.               createInstance(Ci.nsIFileOutputStream);
  1966.  
  1967.     // Serialize the engine first - we don't want to overwrite a good file
  1968.     // if this somehow fails.
  1969.     doc = this._serializeToElement();
  1970.  
  1971.     fos.init(file, (MODE_WRONLY | MODE_TRUNCATE), PERMS_FILE, 0);
  1972.  
  1973.     try {
  1974.       var serializer = Cc["@mozilla.org/xmlextras/xmlserializer;1"].
  1975.                        createInstance(Ci.nsIDOMSerializer);
  1976.       serializer.serializeToStream(doc.documentElement, fos, null);
  1977.     } catch (e) {
  1978.       LOG("_serializeToFile: Error serializing engine:\n" + e);
  1979.     }
  1980.  
  1981.     closeSafeOutputStream(fos);
  1982.   },
  1983.  
  1984.   /**
  1985.    * Remove the engine's file from disk. The search service calls this once it
  1986.    * removes the engine from its internal store. This function will throw if
  1987.    * the file cannot be removed.
  1988.    */
  1989.   _remove: function SRCH_ENG_remove() {
  1990.     ENSURE(!this._readOnly, "Can't remove read only engine!",
  1991.            Cr.NS_ERROR_FAILURE);
  1992.     ENSURE(this._file && this._file.exists(),
  1993.            "Can't remove engine: file doesn't exist!",
  1994.            Cr.NS_ERROR_FILE_NOT_FOUND);
  1995.  
  1996.     this._file.remove(false);
  1997.   },
  1998.  
  1999.   // nsISearchEngine
  2000.   get alias() {
  2001.     if (this._alias === null)
  2002.       this._alias = engineMetadataService.getAttr(this, "alias");
  2003.  
  2004.     return this._alias;
  2005.   },
  2006.   set alias(val) {
  2007.     this._alias = val;
  2008.     engineMetadataService.setAttr(this, "alias", val);
  2009.     notifyAction(this, SEARCH_ENGINE_CHANGED);
  2010.   },
  2011.  
  2012.   get description() {
  2013.     return this._description;
  2014.   },
  2015.  
  2016.   get hidden() {
  2017.     if (this._hidden === null)
  2018.       this._hidden = engineMetadataService.getAttr(this, "hidden");
  2019.     return this._hidden;
  2020.   },
  2021.   set hidden(val) {
  2022.     var value = !!val;
  2023.     if (value != this._hidden) {
  2024.       this._hidden = value;
  2025.       engineMetadataService.setAttr(this, "hidden", value);
  2026.       notifyAction(this, SEARCH_ENGINE_CHANGED);
  2027.     }
  2028.   },
  2029.  
  2030.   get iconURI() {
  2031.     return this._iconURI;
  2032.   },
  2033.  
  2034.   get _iconURL() {
  2035.     if (!this._iconURI)
  2036.       return "";
  2037.     return this._iconURI.spec;
  2038.   },
  2039.  
  2040.   // Where the engine is being loaded from: will return the URI's spec if the
  2041.   // engine is being downloaded and does not yet have a file. This is only used
  2042.   // for logging.
  2043.   get _location() {
  2044.     if (this._file)
  2045.       return this._file.path;
  2046.  
  2047.     if (this._uri)
  2048.       return this._uri.spec;
  2049.  
  2050.     return "";
  2051.   },
  2052.  
  2053.   // The file that the plugin is loaded from is a unique identifier for it.  We
  2054.   // use this as the identifier to store data in the sqlite database
  2055.   get _id() {
  2056.     ENSURE_WARN(this._file, "No _file for id!", Cr.NS_ERROR_FAILURE);
  2057.  
  2058.     if (this._isInProfile)
  2059.       return "[profile]/" + this._file.leafName;
  2060.  
  2061.     if (this._isInAppDir)
  2062.       return "[app]/" + this._file.leafName;
  2063.  
  2064.     // We're not in the profile or appdir, so this must be an extension-shipped
  2065.     // plugin. Use the full path.
  2066.     return this._file.path;
  2067.   },
  2068.  
  2069.   get _installLocation() {
  2070.     ENSURE_WARN(this._file && this._file.exists(),
  2071.                 "_installLocation: engine has no file!",
  2072.                 Cr.NS_ERROR_FAILURE);
  2073.  
  2074.     if (this.__installLocation === null) {
  2075.       if (this._file.parent.equals(getDir(NS_APP_SEARCH_DIR)))
  2076.         this.__installLocation = SEARCH_APP_DIR;
  2077.       else if (this._file.parent.equals(getDir(NS_APP_USER_SEARCH_DIR)))
  2078.         this.__installLocation = SEARCH_PROFILE_DIR;
  2079.       else
  2080.         this.__installLocation = SEARCH_IN_EXTENSION;
  2081.     }
  2082.  
  2083.     return this.__installLocation;
  2084.   },
  2085.  
  2086.   get _isInAppDir() {
  2087.     return this._installLocation == SEARCH_APP_DIR;
  2088.   },
  2089.   get _isInProfile() {
  2090.     return this._installLocation == SEARCH_PROFILE_DIR;
  2091.   },
  2092.  
  2093.   get _isDefault() {
  2094.     // For now, our concept of a "default engine" is "one that is not in the
  2095.     // user's profile directory", which is currently equivalent to "is app- or
  2096.     // extension-shipped".
  2097.     return !this._isInProfile;
  2098.   },
  2099.  
  2100.   get _hasUpdates() {
  2101.     // Whether or not the engine has an update URL
  2102.     return !!(this._updateURL || this._iconUpdateURL);
  2103.   },
  2104.  
  2105.   get name() {
  2106.     return this._name;
  2107.   },
  2108.  
  2109.   get type() {
  2110.     return this._type;
  2111.   },
  2112.  
  2113.   get tags() {
  2114.     return this._tags;
  2115.   },
  2116.  
  2117.   get searchForm() {
  2118.     if (!this._searchForm) {
  2119.       // No searchForm specified in the engine definition file, use the prePath
  2120.       // (e.g. https://foo.com for https://foo.com/search.php?q=bar).
  2121.       var htmlUrl = this._getURLOfType(URLTYPE_SEARCH_HTML);
  2122.       ENSURE_WARN(htmlUrl, "Engine has no HTML URL!", Cr.NS_ERROR_UNEXPECTED);
  2123.       this._searchForm = makeURI(htmlUrl.template).prePath;
  2124.     }
  2125.  
  2126.     return this._searchForm;
  2127.   },
  2128.  
  2129.   get queryCharset() {
  2130.     if (this._queryCharset)
  2131.       return this._queryCharset;
  2132.     return this._queryCharset = queryCharsetFromCode(/* get the default */);
  2133.   },
  2134.  
  2135.   // from nsISearchEngine
  2136.   addParam: function SRCH_ENG_addParam(aName, aValue, aResponseType) {
  2137.     ENSURE_ARG(aName && (aValue != null),
  2138.                "missing name or value for nsISearchEngine::addParam!");
  2139.     ENSURE_WARN(!this._readOnly,
  2140.                 "called nsISearchEngine::addParam on a read-only engine!",
  2141.                 Cr.NS_ERROR_FAILURE);
  2142.     if (!aResponseType)
  2143.       aResponseType = URLTYPE_SEARCH_HTML;
  2144.  
  2145.     var url = this._getURLOfType(aResponseType);
  2146.  
  2147.     ENSURE(url, "Engine object has no URL for response type " + aResponseType,
  2148.            Cr.NS_ERROR_FAILURE);
  2149.  
  2150.     url.addParam(aName, aValue);
  2151.  
  2152.     // Serialize the changes to file lazily
  2153.     this._lazySerializeToFile();
  2154.   },
  2155.  
  2156.   // from nsISearchEngine
  2157.   getSubmission: function SRCH_ENG_getSubmission(aData, aResponseType) {
  2158.     if (!aResponseType)
  2159.       aResponseType = URLTYPE_SEARCH_HTML;
  2160.  
  2161.     var url = this._getURLOfType(aResponseType);
  2162.  
  2163.     if (!url)
  2164.       return null;
  2165.  
  2166.     if (!aData) {
  2167.       // Return a dummy submission object with our searchForm attribute
  2168.       return new Submission(makeURI(this.searchForm), null);
  2169.     }
  2170.  
  2171.     LOG("getSubmission: In data: \"" + aData + "\"");
  2172.     var textToSubURI = Cc["@mozilla.org/intl/texttosuburi;1"].
  2173.                        getService(Ci.nsITextToSubURI);
  2174.     var data = "";
  2175.     try {
  2176.       data = textToSubURI.ConvertAndEscape(this.queryCharset, aData);
  2177.     } catch (ex) {
  2178.       LOG("getSubmission: Falling back to default queryCharset!");
  2179.       data = textToSubURI.ConvertAndEscape(DEFAULT_QUERY_CHARSET, aData);
  2180.     }
  2181.     LOG("getSubmission: Out data: \"" + data + "\"");
  2182.     return url.getSubmission(data, this);
  2183.   },
  2184.  
  2185.   // from nsISearchEngine
  2186.   supportsResponseType: function SRCH_ENG_supportsResponseType(type) {
  2187.     return (this._getURLOfType(type) != null);
  2188.   },
  2189.  
  2190.   // nsISupports
  2191.   QueryInterface: function SRCH_ENG_QI(aIID) {
  2192.     if (aIID.equals(Ci.nsISearchEngine) ||
  2193.         aIID.equals(Ci.nsISupports))
  2194.       return this;
  2195.     throw Cr.NS_ERROR_NO_INTERFACE;
  2196.   },
  2197.  
  2198.   get wrappedJSObject() {
  2199.     return this;
  2200.   }
  2201.  
  2202. };
  2203.  
  2204. // nsISearchSubmission
  2205. function Submission(aURI, aPostData) {
  2206.   this._uri = aURI;
  2207.   this._postData = aPostData;
  2208. }
  2209. Submission.prototype = {
  2210.   get uri() {
  2211.     return this._uri;
  2212.   },
  2213.   get postData() {
  2214.     return this._postData;
  2215.   },
  2216.   QueryInterface: function SRCH_SUBM_QI(aIID) {
  2217.     if (aIID.equals(Ci.nsISearchSubmission) ||
  2218.         aIID.equals(Ci.nsISupports))
  2219.       return this;
  2220.     throw Cr.NS_ERROR_NO_INTERFACE;
  2221.   }
  2222. }
  2223.  
  2224. // nsIBrowserSearchService
  2225. function SearchService() {
  2226.   this._init();
  2227. }
  2228. SearchService.prototype = {
  2229.   _engines: { },
  2230.   _sortedEngines: null,
  2231.   // Whether or not we need to write the order of engines on shutdown. This
  2232.   // needs to happen anytime _sortedEngines is modified after initial startup. 
  2233.   _needToSetOrderPrefs: false,
  2234.  
  2235.   _init: function() {
  2236.     engineMetadataService.init();
  2237.     engineUpdateService.init();
  2238.  
  2239.     this._addObservers();
  2240.  
  2241.     var fileLocator = Cc["@mozilla.org/file/directory_service;1"].
  2242.                       getService(Ci.nsIProperties);
  2243.     var locations = fileLocator.get(NS_APP_SEARCH_DIR_LIST,
  2244.                                     Ci.nsISimpleEnumerator);
  2245.  
  2246.     while (locations.hasMoreElements()) {
  2247.       var location = locations.getNext().QueryInterface(Ci.nsIFile);
  2248.       this._loadEngines(location);
  2249.     }
  2250.  
  2251.     // Now that all engines are loaded, build the sorted engine list
  2252.     this._buildSortedEngineList();
  2253.  
  2254.     selectedEngineName = getLocalizedPref(BROWSER_SEARCH_PREF +
  2255.                                           "selectedEngine");
  2256.     this._currentEngine = this.getEngineByName(selectedEngineName) ||
  2257.                           this.defaultEngine;
  2258.   },
  2259.  
  2260.   _addEngineToStore: function SRCH_SVC_addEngineToStore(aEngine) {
  2261.     LOG("_addEngineToStore: Adding engine: \"" + aEngine.name + "\"");
  2262.  
  2263.     // Songbird HACK
  2264.     // For now any engines with special songbird tags should be hidden by default
  2265.     // This is to ensure that if an extension adds a programmatic search engine
  2266.     // the search engine will not show up after the extension is uninstalled
  2267.     if (aEngine.tags.indexOf("songbird") > -1) {
  2268.       aEngine.hidden = true;
  2269.     }
  2270.  
  2271.  
  2272.     // See if there is an existing engine with the same name. However, if this
  2273.     // engine is updating another engine, it's allowed to have the same name.
  2274.     var hasSameNameAsUpdate = (aEngine._engineToUpdate &&
  2275.                                aEngine.name == aEngine._engineToUpdate.name);
  2276.     if (aEngine.name in this._engines && !hasSameNameAsUpdate) {
  2277.       LOG("_addEngineToStore: Duplicate engine found, aborting!");
  2278.       return;
  2279.     }
  2280.  
  2281.     if (aEngine._engineToUpdate) {
  2282.       // We need to replace engineToUpdate with the engine that just loaded.
  2283.       var oldEngine = aEngine._engineToUpdate;
  2284.  
  2285.       // Remove the old engine from the hash, since it's keyed by name, and our
  2286.       // name might change (the update might have a new name).
  2287.       delete this._engines[oldEngine.name];
  2288.  
  2289.       // Hack: we want to replace the old engine with the new one, but since
  2290.       // people may be holding refs to the nsISearchEngine objects themselves,
  2291.       // we'll just copy over all "private" properties (those without a getter
  2292.       // or setter) from one object to the other.
  2293.       for (var p in aEngine) {
  2294.         if (!(aEngine.__lookupGetter__(p) || aEngine.__lookupSetter__(p)))
  2295.           oldEngine[p] = aEngine[p];
  2296.       }
  2297.       aEngine = oldEngine;
  2298.       aEngine._engineToUpdate = null;
  2299.  
  2300.       // Add the engine back
  2301.       this._engines[aEngine.name] = aEngine;
  2302.       notifyAction(aEngine, SEARCH_ENGINE_CHANGED);
  2303.     } else {
  2304.       // Not an update, just add the new engine.
  2305.       this._engines[aEngine.name] = aEngine;
  2306.       // Only add the engine to the list of sorted engines if the initial list
  2307.       // has already been built (i.e. if this._sortedEngines is non-null). If
  2308.       // it hasn't, we're still loading engines from disk, and will build the
  2309.       // sorted engine list when that initial loading is done.
  2310.       if (this._sortedEngines) {
  2311.         this._sortedEngines.push(aEngine);
  2312.         this._needToSetOrderPrefs = true;
  2313.       }
  2314.       notifyAction(aEngine, SEARCH_ENGINE_ADDED);
  2315.     }
  2316.  
  2317.     if (aEngine._hasUpdates) {
  2318.       // Schedule the engine's next update, if it isn't already.
  2319.       if (!engineMetadataService.getAttr(aEngine, "updateexpir"))
  2320.         engineUpdateService.scheduleNextUpdate(aEngine);
  2321.   
  2322.       // We need to save the engine's _dataType, if this is the first time the
  2323.       // engine is added to the dataStore, since ._dataType isn't persisted
  2324.       // and will change on the next startup (since the engine will then be
  2325.       // XML). We need this so that we know how to load any future updates from
  2326.       // this engine.
  2327.       if (!engineMetadataService.getAttr(aEngine, "updatedatatype"))
  2328.         engineMetadataService.setAttr(aEngine, "updatedatatype",
  2329.                                       aEngine._dataType);
  2330.     }
  2331.   },
  2332.  
  2333.   _loadEngines: function SRCH_SVC_loadEngines(aDir) {
  2334.     LOG("_loadEngines: Searching in " + aDir.path + " for search engines.");
  2335.  
  2336.     // Check whether aDir is the user profile dir
  2337.     var isInProfile = aDir.equals(getDir(NS_APP_USER_SEARCH_DIR));
  2338.  
  2339.     var files = aDir.directoryEntries
  2340.                     .QueryInterface(Ci.nsIDirectoryEnumerator);
  2341.     var ios = Cc["@mozilla.org/network/io-service;1"].
  2342.               getService(Ci.nsIIOService);
  2343.  
  2344.     while (files.hasMoreElements()) {
  2345.       var file = files.nextFile;
  2346.  
  2347.       // Ignore hidden and empty files, and directories
  2348.       if (!file.isFile() || file.fileSize == 0 || file.isHidden())
  2349.         continue;
  2350.  
  2351.       var fileURL = ios.newFileURI(file).QueryInterface(Ci.nsIURL);
  2352.       var fileExtension = fileURL.fileExtension.toLowerCase();
  2353.       var isWritable = isInProfile && file.isWritable();
  2354.  
  2355.       var dataType;
  2356.       switch (fileExtension) {
  2357.         case XML_FILE_EXT:
  2358.           dataType = SEARCH_DATA_XML;
  2359.           break;
  2360.         case SHERLOCK_FILE_EXT:
  2361.           dataType = SEARCH_DATA_TEXT;
  2362.           break;
  2363.         default:
  2364.           // Not an engine
  2365.           continue;
  2366.       }
  2367.  
  2368.       var addedEngine = null;
  2369.       try {
  2370.         addedEngine = new Engine(file, dataType, !isWritable);
  2371.         addedEngine._initFromFile();
  2372.       } catch (ex) {
  2373.         LOG("_loadEngines: Failed to load " + file.path + "!\n" + ex);
  2374.         continue;
  2375.       }
  2376.  
  2377.       if (fileExtension == SHERLOCK_FILE_EXT) {
  2378.         if (isWritable) {
  2379.           try {
  2380.             this._convertSherlockFile(addedEngine, fileURL.fileBaseName);
  2381.           } catch (ex) {
  2382.             LOG("_loadEngines: Failed to convert: " + fileURL.path + "\n" + ex);
  2383.             // The engine couldn't be converted, mark it as read-only
  2384.             addedEngine._readOnly = true;
  2385.           }
  2386.         }
  2387.  
  2388.         // If the engine still doesn't have an icon, see if we can find one
  2389.         if (!addedEngine._iconURI) {
  2390.           var icon = this._findSherlockIcon(file, fileURL.fileBaseName);
  2391.           if (icon)
  2392.             addedEngine._iconURI = ios.newFileURI(icon);
  2393.         }
  2394.       }
  2395.  
  2396.       this._addEngineToStore(addedEngine);
  2397.     }
  2398.   },
  2399.  
  2400.   _saveSortedEngineList: function SRCH_SVC_saveSortedEngineList() {
  2401.     // We only need to write the prefs. if something has changed.
  2402.     if (!this._needToSetOrderPrefs)
  2403.       return;
  2404.  
  2405.     // Set the useDB pref to indicate that from now on we should use the order
  2406.     // information stored in the database.
  2407.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  2408.                 getService(Ci.nsIPrefBranch);
  2409.     prefB.setBoolPref(BROWSER_SEARCH_PREF + "useDBForOrder", true);
  2410.  
  2411.     var engines = this._getSortedEngines(true);
  2412.     var values = [];
  2413.     var names = [];
  2414.  
  2415.     for (var i = 0; i < engines.length; ++i) {
  2416.       names[i] = "order";
  2417.       values[i] = i + 1;
  2418.     }
  2419.  
  2420.     engineMetadataService.setAttrs(engines, names, values);
  2421.   },
  2422.  
  2423.   _buildSortedEngineList: function SRCH_SVC_buildSortedEngineList() {
  2424.     var addedEngines = { };
  2425.     this._sortedEngines = [];
  2426.     var engine;
  2427.  
  2428.     // If the user has specified a custom engine order, read the order
  2429.     // information from the engineMetadataService instead of the default
  2430.     // prefs.
  2431.     if (getBoolPref(BROWSER_SEARCH_PREF + "useDBForOrder", false)) {
  2432.       for each (engine in this._engines) {
  2433.         var orderNumber = engineMetadataService.getAttr(engine, "order");
  2434.  
  2435.         // Since the DB isn't regularly cleared, and engine files may disappear
  2436.         // without us knowing, we may already have an engine in this slot. If
  2437.         // that happens, we just skip it - it will be added later on as an
  2438.         // unsorted engine. This problem will sort itself out when we call
  2439.         // _saveSortedEngineList at shutdown.
  2440.         if (orderNumber && !this._sortedEngines[orderNumber-1]) {
  2441.           this._sortedEngines[orderNumber-1] = engine;
  2442.           addedEngines[engine.name] = engine;
  2443.         } else {
  2444.           // We need to call _saveSortedEngines so this gets sorted out.
  2445.           this._needToSetOrderPrefs = true;
  2446.         }
  2447.       }
  2448.  
  2449.       // Filter out any nulls for engines that may have been removed
  2450.       var filteredEngines = this._sortedEngines.filter(function(a) { return !!a; });
  2451.       if (this._sortedEngines.length != filteredEngines.length)
  2452.         this._needToSetOrderPrefs = true;
  2453.       this._sortedEngines = filteredEngines;
  2454.  
  2455.     } else {
  2456.       // The DB isn't being used, so just read the engine order from the prefs
  2457.       var i = 0;
  2458.       var engineName;
  2459.       var prefName;
  2460.  
  2461.       try {
  2462.         var prefB = Cc["@mozilla.org/preferences-service;1"].
  2463.                     getService(Ci.nsIPrefBranch);
  2464.         var extras =
  2465.           prefB.getChildList(BROWSER_SEARCH_PREF + "order.extra.", { });
  2466.  
  2467.         for each (prefName in extras) {
  2468.           engineName = prefB.getCharPref(prefName);
  2469.  
  2470.           engine = this._engines[engineName];
  2471.           if (!engine || engine.name in addedEngines)
  2472.             continue;
  2473.  
  2474.           this._sortedEngines.push(engine);
  2475.           addedEngines[engine.name] = engine;
  2476.         }
  2477.       }
  2478.       catch (e) { }
  2479.  
  2480.       while (true) {
  2481.         engineName = getLocalizedPref(BROWSER_SEARCH_PREF + "order." + (++i));
  2482.         if (!engineName)
  2483.           break;
  2484.  
  2485.         engine = this._engines[engineName];
  2486.         if (!engine || engine.name in addedEngines)
  2487.           continue;
  2488.         
  2489.         this._sortedEngines.push(engine);
  2490.         addedEngines[engine.name] = engine;
  2491.       }
  2492.     }
  2493.  
  2494.     // Array for the remaining engines, alphabetically sorted
  2495.     var alphaEngines = [];
  2496.  
  2497.     for each (engine in this._engines) {
  2498.       if (!(engine.name in addedEngines))
  2499.         alphaEngines.push(this._engines[engine.name]);
  2500.     }
  2501.     alphaEngines = alphaEngines.sort(function (a, b) {
  2502.                                        return a.name.localeCompare(b.name);
  2503.                                      });
  2504.     this._sortedEngines = this._sortedEngines.concat(alphaEngines);
  2505.   },
  2506.  
  2507.   /**
  2508.    * Converts a Sherlock file and its icon into the custom XML format used by
  2509.    * the Search Service. Saves the engine's icon (if present) into the XML as a
  2510.    * data: URI and changes the extension of the source file from ".src" to
  2511.    * ".xml". The engine data is then written to the file as XML.
  2512.    * @param aEngine
  2513.    *        The Engine object that needs to be converted.
  2514.    * @param aBaseName
  2515.    *        The basename of the Sherlock file.
  2516.    *          Example: "foo" for file "foo.src".
  2517.    *
  2518.    * @throws NS_ERROR_FAILURE if the file could not be converted.
  2519.    *
  2520.    * @see nsIURL::fileBaseName
  2521.    */
  2522.   _convertSherlockFile: function SRCH_SVC_convertSherlock(aEngine, aBaseName) {
  2523.     var oldSherlockFile = aEngine._file;
  2524.  
  2525.     // Back up the old file
  2526.     try {
  2527.       var backupDir = oldSherlockFile.parent;
  2528.       backupDir.append("searchplugins-backup");
  2529.  
  2530.       if (!backupDir.exists())
  2531.         backupDir.create(Ci.nsIFile.DIRECTORY_TYPE, PERMS_DIRECTORY);
  2532.  
  2533.       oldSherlockFile.copyTo(backupDir, null);
  2534.     } catch (ex) {
  2535.       // Just bail. Engines that can't be backed up won't be converted, but
  2536.       // engines that aren't converted are loaded as readonly.
  2537.       LOG("_convertSherlockFile: Couldn't back up " + oldSherlockFile.path +
  2538.           ":\n" + ex);
  2539.       throw Cr.NS_ERROR_FAILURE;
  2540.     }
  2541.  
  2542.     // Rename the file, but don't clobber existing files
  2543.     var newXMLFile = oldSherlockFile.parent.clone();
  2544.     newXMLFile.append(aBaseName + "." + XML_FILE_EXT);
  2545.  
  2546.     if (newXMLFile.exists()) {
  2547.       // There is an existing file with this name, create a unique file
  2548.       newXMLFile.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, PERMS_FILE);
  2549.     }
  2550.  
  2551.     // Rename the .src file to .xml
  2552.     oldSherlockFile.moveTo(null, newXMLFile.leafName);
  2553.  
  2554.     aEngine._file = newXMLFile;
  2555.  
  2556.     // Write the converted engine to disk
  2557.     aEngine._serializeToFile();
  2558.  
  2559.     // Update the engine's _type.
  2560.     aEngine._type = SEARCH_TYPE_MOZSEARCH;
  2561.  
  2562.     // See if it has a corresponding icon
  2563.     try {
  2564.       var icon = this._findSherlockIcon(aEngine._file, aBaseName);
  2565.       if (icon && icon.fileSize < MAX_ICON_SIZE) {
  2566.         // Use this as the engine's icon
  2567.         var bStream = Cc["@mozilla.org/binaryinputstream;1"].
  2568.                         createInstance(Ci.nsIBinaryInputStream);
  2569.         var fileInStream = Cc["@mozilla.org/network/file-input-stream;1"].
  2570.                            createInstance(Ci.nsIFileInputStream);
  2571.  
  2572.         fileInStream.init(icon, MODE_RDONLY, PERMS_FILE, 0);
  2573.         bStream.setInputStream(fileInStream);
  2574.  
  2575.         var bytes = [];
  2576.         while (bStream.available() != 0)
  2577.           bytes = bytes.concat(bStream.readByteArray(bStream.available()));
  2578.         bStream.close();
  2579.  
  2580.         // Convert the byte array to a base64-encoded string
  2581.         var str = b64(bytes);
  2582.  
  2583.         aEngine._iconURI = makeURI(ICON_DATAURL_PREFIX + str);
  2584.         LOG("_importSherlockEngine: Set sherlock iconURI to: \"" +
  2585.             aEngine._iconURL + "\"");
  2586.  
  2587.         // Write the engine to disk to save changes
  2588.         aEngine._serializeToFile();
  2589.  
  2590.         // Delete the icon now that we're sure everything's been saved
  2591.         icon.remove(false);
  2592.       }
  2593.     } catch (ex) { LOG("_convertSherlockFile: Error setting icon:\n" + ex); }
  2594.   },
  2595.  
  2596.   /**
  2597.    * Finds an icon associated to a given Sherlock file. Searches the provided
  2598.    * file's parent directory looking for files with the same base name and one
  2599.    * of the file extensions in SHERLOCK_ICON_EXTENSIONS.
  2600.    * @param aEngineFile
  2601.    *        The Sherlock plugin file.
  2602.    * @param aBaseName
  2603.    *        The basename of the Sherlock file.
  2604.    *          Example: "foo" for file "foo.src".
  2605.    * @see nsIURL::fileBaseName
  2606.    */
  2607.   _findSherlockIcon: function SRCH_SVC_findSherlock(aEngineFile, aBaseName) {
  2608.     for (var i = 0; i < SHERLOCK_ICON_EXTENSIONS.length; i++) {
  2609.       var icon = aEngineFile.parent.clone();
  2610.       icon.append(aBaseName + SHERLOCK_ICON_EXTENSIONS[i]);
  2611.       if (icon.exists() && icon.isFile())
  2612.         return icon;
  2613.     }
  2614.     return null;
  2615.   },
  2616.  
  2617.   /**
  2618.    * Get a sorted array of engines.
  2619.    * @param aWithHidden
  2620.    *        True if hidden plugins should be included in the result.
  2621.    */
  2622.   _getSortedEngines: function SRCH_SVC_getSorted(aWithHidden) {
  2623.     if (aWithHidden)
  2624.       return this._sortedEngines;
  2625.  
  2626.     return this._sortedEngines.filter(function (engine) {
  2627.                                         return !engine.hidden;
  2628.                                       });
  2629.   },
  2630.  
  2631.   // nsIBrowserSearchService
  2632.   getEngines: function SRCH_SVC_getEngines(aCount) {
  2633.     LOG("getEngines: getting all engines");
  2634.     var engines = this._getSortedEngines(true);
  2635.     aCount.value = engines.length;
  2636.     return engines;
  2637.   },
  2638.  
  2639.   getVisibleEngines: function SRCH_SVC_getVisible(aCount) {
  2640.     LOG("getVisibleEngines: getting all visible engines");
  2641.     var engines = this._getSortedEngines(false);
  2642.     aCount.value = engines.length;
  2643.     return engines;
  2644.   },
  2645.  
  2646.   getDefaultEngines: function SRCH_SVC_getDefault(aCount) {
  2647.     function isDefault(engine) {
  2648.       return engine._isDefault;
  2649.     };
  2650.     var engines = this._sortedEngines.filter(isDefault);
  2651.     var engineOrder = {};
  2652.     var engineName;
  2653.     var i = 1;
  2654.  
  2655.     // Build a list of engines which we have ordering information for.
  2656.     // We're rebuilding the list here because _sortedEngines contain the
  2657.     // current order, but we want the original order.
  2658.  
  2659.     // First, look at the "browser.search.order.extra" branch.
  2660.     try {
  2661.       var prefB = Cc["@mozilla.org/preferences-service;1"].
  2662.                   getService(Ci.nsIPrefBranch);
  2663.       var extras = prefB.getChildList(BROWSER_SEARCH_PREF + "order.extra.",
  2664.                                       {});
  2665.  
  2666.       for each (var prefName in extras) {
  2667.         engineName = prefB.getCharPref(prefName);
  2668.  
  2669.         if (!(engineName in engineOrder))
  2670.           engineOrder[engineName] = i++;
  2671.       }
  2672.     } catch (e) {
  2673.       LOG("Getting extra order prefs failed: " + e);
  2674.     }
  2675.  
  2676.     // Now look through the "browser.search.order" branch.
  2677.     for (var j = 1; ; j++) {
  2678.       engineName = getLocalizedPref(BROWSER_SEARCH_PREF + "order." + j);
  2679.       if (!engineName)
  2680.         break;
  2681.  
  2682.       if (!(engineName in engineOrder))
  2683.         engineOrder[engineName] = i++;
  2684.     }
  2685.  
  2686.     LOG("getDefaultEngines: engineOrder: " + engineOrder.toSource());
  2687.  
  2688.     function compareEngines (a, b) {
  2689.       var aIdx = engineOrder[a.name];
  2690.       var bIdx = engineOrder[b.name];
  2691.  
  2692.       if (aIdx && bIdx)
  2693.         return aIdx - bIdx;
  2694.       if (aIdx)
  2695.         return -1;
  2696.       if (bIdx)
  2697.         return 1;
  2698.  
  2699.       return a.name.localeCompare(b.name);
  2700.     }
  2701.     engines.sort(compareEngines);
  2702.  
  2703.     aCount.value = engines.length;
  2704.     return engines;
  2705.   },
  2706.   
  2707.   getEngineByName: function SRCH_SVC_getEngineByName(aEngineName) {
  2708.     return this._engines[aEngineName] || null;
  2709.   },
  2710.  
  2711.   getEngineByAlias: function SRCH_SVC_getEngineByAlias(aAlias) {
  2712.     for (var engineName in this._engines) {
  2713.       var engine = this._engines[engineName];
  2714.       if (engine && engine.alias == aAlias)
  2715.         return engine;
  2716.     }
  2717.     return null;
  2718.   },
  2719.  
  2720.   addEngineWithDetails: function SRCH_SVC_addEWD(aName, aIconURL, aAlias,
  2721.                                                  aDescription, aMethod,
  2722.                                                  aTemplate) {
  2723.     ENSURE_ARG(aName, "Invalid name passed to addEngineWithDetails!");
  2724.     ENSURE_ARG(aMethod, "Invalid method passed to addEngineWithDetails!");
  2725.     ENSURE_ARG(aTemplate, "Invalid template passed to addEngineWithDetails!");
  2726.  
  2727.     ENSURE(!this._engines[aName], "An engine with that name already exists!",
  2728.            Cr.NS_ERROR_FILE_ALREADY_EXISTS);
  2729.  
  2730.     var engine = new Engine(getSanitizedFile(aName), SEARCH_DATA_XML, false);
  2731.     engine._initFromMetadata(aName, aIconURL, aAlias, aDescription,
  2732.                              aMethod, aTemplate);
  2733.     this._addEngineToStore(engine);
  2734.   },
  2735.  
  2736.   addEngine: function SRCH_SVC_addEngine(aEngineURL, aDataType, aIconURL,
  2737.                                          aConfirm) {
  2738.     LOG("addEngine: Adding \"" + aEngineURL + "\".");
  2739.     try {
  2740.       var uri = makeURI(aEngineURL);
  2741.       var engine = new Engine(uri, aDataType, false);
  2742.       engine._initFromURI();
  2743.     } catch (ex) {
  2744.       LOG("addEngine: Error adding engine:\n" + ex);
  2745.       throw Cr.NS_ERROR_FAILURE;
  2746.     }
  2747.     engine._setIcon(aIconURL, false);
  2748.     engine._confirm = aConfirm;
  2749.   },
  2750.  
  2751.   removeEngine: function SRCH_SVC_removeEngine(aEngine) {
  2752.     ENSURE_ARG(aEngine, "no engine passed to removeEngine!");
  2753.  
  2754.     var engineToRemove = null;
  2755.     for (var e in this._engines)
  2756.       if (aEngine.wrappedJSObject == this._engines[e])
  2757.         engineToRemove = this._engines[e];
  2758.  
  2759.     ENSURE(engineToRemove, "removeEngine: Can't find engine to remove!",
  2760.            Cr.NS_ERROR_FILE_NOT_FOUND);
  2761.  
  2762.     if (engineToRemove == this.currentEngine)
  2763.       this._currentEngine = null;
  2764.  
  2765.     if (engineToRemove._readOnly) {
  2766.       // Just hide it (the "hidden" setter will notify) and remove its alias to
  2767.       // avoid future conflicts with other engines.
  2768.       engineToRemove.hidden = true;
  2769.       engineToRemove.alias = null;
  2770.     } else {
  2771.       // Remove the engine file from disk (this might throw)
  2772.       engineToRemove._remove();
  2773.       engineToRemove._file = null;
  2774.  
  2775.       // Remove the engine from _sortedEngines
  2776.       var index = this._sortedEngines.indexOf(engineToRemove);
  2777.       ENSURE(index != -1, "Can't find engine to remove in _sortedEngines!",
  2778.              Cr.NS_ERROR_FAILURE);
  2779.       this._sortedEngines.splice(index, 1);
  2780.  
  2781.       // Remove the engine from the internal store
  2782.       delete this._engines[engineToRemove.name];
  2783.  
  2784.       notifyAction(engineToRemove, SEARCH_ENGINE_REMOVED);
  2785.  
  2786.       // Since we removed an engine, we need to update the preferences.
  2787.       this._needToSetOrderPrefs = true;
  2788.     }
  2789.   },
  2790.  
  2791.   moveEngine: function SRCH_SVC_moveEngine(aEngine, aNewIndex) {
  2792.     ENSURE_ARG((aNewIndex < this._sortedEngines.length) && (aNewIndex >= 0),
  2793.                "SRCH_SVC_moveEngine: Index out of bounds!");
  2794.     ENSURE_ARG(aEngine instanceof Ci.nsISearchEngine,
  2795.                "SRCH_SVC_moveEngine: Invalid engine passed to moveEngine!");
  2796.     ENSURE(!aEngine.hidden, "moveEngine: Can't move a hidden engine!",
  2797.            Cr.NS_ERROR_FAILURE);
  2798.  
  2799.     var engine = aEngine.wrappedJSObject;
  2800.  
  2801.     var currentIndex = this._sortedEngines.indexOf(engine);
  2802.     ENSURE(currentIndex != -1, "moveEngine: Can't find engine to move!",
  2803.            Cr.NS_ERROR_UNEXPECTED);
  2804.  
  2805.     // Our callers only take into account non-hidden engines when calculating
  2806.     // aNewIndex, but we need to move it in the array of all engines, so we
  2807.     // need to adjust aNewIndex accordingly. To do this, we count the number
  2808.     // of hidden engines in the list before the engine that we're taking the
  2809.     // place of. We do this by first finding newIndexEngine (the engine that
  2810.     // we were supposed to replace) and then iterating through the complete 
  2811.     // engine list until we reach it, increasing aNewIndex for each hidden
  2812.     // engine we find on our way there.
  2813.     //
  2814.     // This could be further simplified by having our caller pass in
  2815.     // newIndexEngine directly instead of aNewIndex.
  2816.     var newIndexEngine = this._getSortedEngines(false)[aNewIndex];
  2817.     ENSURE(newIndexEngine, "moveEngine: Can't find engine to replace!",
  2818.            Cr.NS_ERROR_UNEXPECTED);
  2819.  
  2820.     for (var i = 0; i < this._sortedEngines.length; ++i) {
  2821.       if (newIndexEngine == this._sortedEngines[i])
  2822.         break;
  2823.       if (this._sortedEngines[i].hidden)
  2824.         aNewIndex++;
  2825.     }
  2826.  
  2827.     if (currentIndex == aNewIndex)
  2828.       return; // nothing to do!
  2829.  
  2830.     // Move the engine
  2831.     var movedEngine = this._sortedEngines.splice(currentIndex, 1)[0];
  2832.     this._sortedEngines.splice(aNewIndex, 0, movedEngine);
  2833.  
  2834.     notifyAction(engine, SEARCH_ENGINE_CHANGED);
  2835.  
  2836.     // Since we moved an engine, we need to update the preferences.
  2837.     this._needToSetOrderPrefs = true;
  2838.   },
  2839.  
  2840.   restoreDefaultEngines: function SRCH_SVC_resetDefaultEngines() {
  2841.     for each (var e in this._engines) {
  2842.       // Unhide all default engines
  2843.       if (e.hidden && e._isDefault)
  2844.         e.hidden = false;
  2845.     }
  2846.   },
  2847.  
  2848.   get defaultEngine() {
  2849.     const defPref = BROWSER_SEARCH_PREF + "defaultenginename";
  2850.     // Get the default engine - this pref should always exist, but the engine
  2851.     // might be hidden
  2852.     this._defaultEngine = this.getEngineByName(getLocalizedPref(defPref, ""));
  2853.     if (!this._defaultEngine || this._defaultEngine.hidden)
  2854.       this._defaultEngine = this._getSortedEngines(false)[0] || null;
  2855.     return this._defaultEngine;
  2856.   },
  2857.  
  2858.   get currentEngine() {
  2859.     if (!this._currentEngine || this._currentEngine.hidden)
  2860.       this._currentEngine = this.defaultEngine;
  2861.     return this._currentEngine;
  2862.   },
  2863.   set currentEngine(val) {
  2864.     ENSURE_ARG(val instanceof Ci.nsISearchEngine,
  2865.                "Invalid argument passed to currentEngine setter");
  2866.  
  2867.     var newCurrentEngine = this.getEngineByName(val.name);
  2868.     ENSURE(newCurrentEngine, "Can't find engine in store!",
  2869.            Cr.NS_ERROR_UNEXPECTED);
  2870.  
  2871.     this._currentEngine = newCurrentEngine;
  2872.  
  2873.     var currentEnginePref = BROWSER_SEARCH_PREF + "selectedEngine";
  2874.  
  2875.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  2876.       getService(Ci.nsIPrefService).QueryInterface(Ci.nsIPrefBranch);
  2877.  
  2878.     if (this._currentEngine == this.defaultEngine) {
  2879.       if (prefB.prefHasUserValue(currentEnginePref))
  2880.         prefB.clearUserPref(currentEnginePref);
  2881.     }
  2882.     else {
  2883.       setLocalizedPref(currentEnginePref, this._currentEngine.name);
  2884.     }
  2885.  
  2886.     notifyAction(this._currentEngine, SEARCH_ENGINE_CURRENT);
  2887.   },
  2888.  
  2889.   // nsIObserver
  2890.   observe: function SRCH_SVC_observe(aEngine, aTopic, aVerb) {
  2891.     switch (aTopic) {
  2892.       case SEARCH_ENGINE_TOPIC:
  2893.         if (aVerb == SEARCH_ENGINE_LOADED) {
  2894.           var engine = aEngine.QueryInterface(Ci.nsISearchEngine);
  2895.           LOG("nsSearchService::observe: Done installation of " + engine.name
  2896.               + ".");
  2897.           this._addEngineToStore(engine.wrappedJSObject);
  2898.           if (engine.wrappedJSObject._useNow) {
  2899.             LOG("nsSearchService::observe: setting current");
  2900.             this.currentEngine = aEngine;
  2901.           }
  2902.         }
  2903.         break;
  2904.       case QUIT_APPLICATION_TOPIC:
  2905.         this._removeObservers();
  2906.         this._saveSortedEngineList();
  2907.         break;
  2908.     }
  2909.   },
  2910.  
  2911.   _addObservers: function SRCH_SVC_addObservers() {
  2912.     var os = Cc["@mozilla.org/observer-service;1"].
  2913.              getService(Ci.nsIObserverService);
  2914.     os.addObserver(this, SEARCH_ENGINE_TOPIC, false);
  2915.     os.addObserver(this, QUIT_APPLICATION_TOPIC, false);
  2916.   },
  2917.  
  2918.   _removeObservers: function SRCH_SVC_removeObservers() {
  2919.     var os = Cc["@mozilla.org/observer-service;1"].
  2920.              getService(Ci.nsIObserverService);
  2921.     os.removeObserver(this, SEARCH_ENGINE_TOPIC);
  2922.     os.removeObserver(this, QUIT_APPLICATION_TOPIC);
  2923.   },
  2924.  
  2925.   QueryInterface: function SRCH_SVC_QI(aIID) {
  2926.     if (aIID.equals(Ci.nsIBrowserSearchService) ||
  2927.         aIID.equals(Ci.nsIObserver)             ||
  2928.         aIID.equals(Ci.nsISupports))
  2929.       return this;
  2930.     throw Cr.NS_ERROR_NO_INTERFACE;
  2931.   }
  2932. };
  2933.  
  2934. var engineMetadataService = {
  2935.   init: function epsInit() {
  2936.     var engineDataTable = "id INTEGER PRIMARY KEY, engineid STRING, name STRING, value STRING";
  2937.     var file = getDir(NS_APP_USER_PROFILE_50_DIR);
  2938.     file.append("search.sqlite");
  2939.     var dbService = Cc["@mozilla.org/storage/service;1"].
  2940.                     getService(Ci.mozIStorageService);
  2941.     try {
  2942.         this.mDB = dbService.openDatabase(file);
  2943.     } catch (ex) {
  2944.         if (ex.result == 0x8052000b) { /* NS_ERROR_FILE_CORRUPTED */
  2945.             // delete and try again
  2946.             file.remove(false);
  2947.             this.mDB = dbService.openDatabase(file);
  2948.         } else {
  2949.             throw ex;
  2950.         }
  2951.     }
  2952.  
  2953.     try {
  2954.       this.mDB.createTable("engine_data", engineDataTable);
  2955.     } catch (ex) {
  2956.       // Fails if the table already exists, which is fine
  2957.     }
  2958.  
  2959.     this.mGetData = createStatement (
  2960.       this.mDB,
  2961.       "SELECT value FROM engine_data WHERE engineid = :engineid AND name = :name");
  2962.     this.mDeleteData = createStatement (
  2963.       this.mDB,
  2964.       "DELETE FROM engine_data WHERE engineid = :engineid AND name = :name");
  2965.     this.mInsertData = createStatement (
  2966.       this.mDB,
  2967.       "INSERT INTO engine_data (engineid, name, value) " +
  2968.       "VALUES (:engineid, :name, :value)");
  2969.   },
  2970.   getAttr: function epsGetAttr(engine, name) {
  2971.      // attr names must be lower case
  2972.      name = name.toLowerCase();
  2973.  
  2974.     var stmt = this.mGetData;
  2975.     stmt.reset();
  2976.     var pp = stmt.params;
  2977.     pp.engineid = engine._id;
  2978.     pp.name = name;
  2979.  
  2980.     var value = null;
  2981.     if (stmt.step())
  2982.       value = stmt.row.value;
  2983.     stmt.reset();
  2984.     return value;
  2985.   },
  2986.  
  2987.   setAttr: function epsSetAttr(engine, name, value) {
  2988.     // attr names must be lower case
  2989.     name = name.toLowerCase();
  2990.  
  2991.     this.mDB.beginTransaction();
  2992.  
  2993.     var pp = this.mDeleteData.params;
  2994.     pp.engineid = engine._id;
  2995.     pp.name = name;
  2996.     this.mDeleteData.step();
  2997.     this.mDeleteData.reset();
  2998.  
  2999.     pp = this.mInsertData.params;
  3000.     pp.engineid = engine._id;
  3001.     pp.name = name;
  3002.     pp.value = value;
  3003.     this.mInsertData.step();
  3004.     this.mInsertData.reset();
  3005.  
  3006.     this.mDB.commitTransaction();
  3007.   },
  3008.  
  3009.   setAttrs: function epsSetAttrs(engines, names, values) {
  3010.     this.mDB.beginTransaction();
  3011.  
  3012.     for (var i = 0; i < engines.length; i++) {
  3013.       // attr names must be lower case
  3014.       var name = names[i].toLowerCase();
  3015.  
  3016.       var pp = this.mDeleteData.params;
  3017.       pp.engineid = engines[i]._id;
  3018.       pp.name = names[i];
  3019.       this.mDeleteData.step();
  3020.       this.mDeleteData.reset();
  3021.  
  3022.       pp = this.mInsertData.params;
  3023.       pp.engineid = engines[i]._id;
  3024.       pp.name = names[i];
  3025.       pp.value = values[i];
  3026.       this.mInsertData.step();
  3027.       this.mInsertData.reset();
  3028.     }
  3029.  
  3030.     this.mDB.commitTransaction();
  3031.   },
  3032.  
  3033.   deleteEngineData: function epsDelData(engine, name) {
  3034.     // attr names must be lower case
  3035.     name = name.toLowerCase();
  3036.  
  3037.     var pp = this.mDeleteData.params;
  3038.     pp.engineid = engine._id;
  3039.     pp.name = name;
  3040.     this.mDeleteData.step();
  3041.     this.mDeleteData.reset();
  3042.   }
  3043. }
  3044.  
  3045. const SEARCH_UPDATE_LOG_PREFIX = "*** Search update: ";
  3046.  
  3047. /**
  3048.  * Outputs aText to the JavaScript console as well as to stdout, if the search
  3049.  * logging pref (browser.search.update.log) is set to true.
  3050.  */
  3051. function ULOG(aText) {
  3052.   var prefB = Cc["@mozilla.org/preferences-service;1"].
  3053.               getService(Ci.nsIPrefBranch);
  3054.   var shouldLog = false;
  3055.   try {
  3056.     shouldLog = prefB.getBoolPref(BROWSER_SEARCH_PREF + "update.log");
  3057.   } catch (ex) {}
  3058.  
  3059.   if (shouldLog) {
  3060.     dump(SEARCH_UPDATE_LOG_PREFIX + aText + "\n");
  3061.     var consoleService = Cc["@mozilla.org/consoleservice;1"].
  3062.                          getService(Ci.nsIConsoleService);
  3063.     consoleService.logStringMessage(aText);
  3064.   }
  3065. }
  3066.  
  3067. var engineUpdateService = {
  3068.   init: function eus_init() {
  3069.     var tm = Cc["@mozilla.org/updates/timer-manager;1"].
  3070.              getService(Ci.nsIUpdateTimerManager);
  3071.     // figure out how often to check for any expired engines
  3072.     var prefB = Cc["@mozilla.org/preferences-service;1"].
  3073.                 getService(Ci.nsIPrefBranch);
  3074.     var interval = prefB.getIntPref(BROWSER_SEARCH_PREF + "updateinterval");
  3075.  
  3076.     // Interval is stored in hours
  3077.     var seconds = interval * 3600;
  3078.     tm.registerTimer("search-engine-update-timer", engineUpdateService,
  3079.                      seconds);
  3080.   },
  3081.  
  3082.   scheduleNextUpdate: function eus_scheduleNextUpdate(aEngine) {
  3083.     var interval = aEngine._updateInterval || SEARCH_DEFAULT_UPDATE_INTERVAL;
  3084.     var milliseconds = interval * 86400000; // |interval| is in days
  3085.     engineMetadataService.setAttr(aEngine, "updateexpir",
  3086.                                   Date.now() + milliseconds);
  3087.   },
  3088.  
  3089.   notify: function eus_Notify(aTimer) {
  3090.     ULOG("notify called");
  3091.  
  3092.     if (!getBoolPref(BROWSER_SEARCH_PREF + "update", true))
  3093.       return;
  3094.  
  3095.     // Our timer has expired, but unfortunately, we can't get any data from it.
  3096.     // Therefore, we need to walk our engine-list, looking for expired engines
  3097.     var searchService = Cc["@mozilla.org/browser/search-service;1"].
  3098.                         getService(Ci.nsIBrowserSearchService);
  3099.     var currentTime = Date.now();
  3100.     ULOG("currentTime: " + currentTime);
  3101.     for each (engine in searchService.getEngines({})) {
  3102.       engine = engine.wrappedJSObject;
  3103.       if (!engine._hasUpdates || engine._readOnly)
  3104.         continue;
  3105.  
  3106.       ULOG("checking " + engine.name);
  3107.  
  3108.       var expirTime = engineMetadataService.getAttr(engine, "updateexpir");
  3109.       var updateURL = engine._updateURL;
  3110.       var iconUpdateURL = engine._iconUpdateURL;
  3111.       ULOG("expirTime: " + expirTime + "\nupdateURL: " + updateURL +
  3112.            "\niconUpdateURL: " + iconUpdateURL);
  3113.  
  3114.       var engineExpired = expirTime <= currentTime;
  3115.  
  3116.       if (!expirTime || !engineExpired) {
  3117.         ULOG("skipping engine");
  3118.         continue;
  3119.       }
  3120.  
  3121.       ULOG(engine.name + " has expired");
  3122.  
  3123.       var testEngine = null;
  3124.  
  3125.       var updateURI = makeURI(updateURL);
  3126.       if (updateURI) {
  3127.         var dataType = engineMetadataService.getAttr(engine, "updatedatatype")
  3128.         if (!dataType) {
  3129.           ULOG("No loadtype to update engine!");
  3130.           continue;
  3131.         }
  3132.  
  3133.         testEngine = new Engine(updateURI, dataType, false);
  3134.         testEngine._engineToUpdate = engine;
  3135.         testEngine._initFromURI();
  3136.       } else
  3137.         ULOG("invalid updateURI");
  3138.  
  3139.       if (iconUpdateURL) {
  3140.         // If we're updating the engine too, use the new engine object,
  3141.         // otherwise use the existing engine object.
  3142.         (testEngine || engine)._setIcon(iconUpdateURL, true);
  3143.       }
  3144.  
  3145.       // Schedule the next update
  3146.       this.scheduleNextUpdate(engine);
  3147.  
  3148.     } // end engine iteration
  3149.   }
  3150. };
  3151.  
  3152. const kClassID    = Components.ID("{7319788a-fe93-4db3-9f39-818cf08f4256}");
  3153. const kClassName  = "Browser Search Service";
  3154. const kContractID = "@mozilla.org/browser/search-service;1";
  3155.  
  3156. // nsIFactory
  3157. const kFactory = {
  3158.   createInstance: function (outer, iid) {
  3159.     if (outer != null)
  3160.       throw Cr.NS_ERROR_NO_AGGREGATION;
  3161.     return (new SearchService()).QueryInterface(iid);
  3162.   }
  3163. };
  3164.  
  3165. // nsIModule
  3166. const gModule = {
  3167.   registerSelf: function (componentManager, fileSpec, location, type) {
  3168.     componentManager.QueryInterface(Ci.nsIComponentRegistrar);
  3169.     componentManager.registerFactoryLocation(kClassID,
  3170.                                              kClassName,
  3171.                                              kContractID,
  3172.                                              fileSpec, location, type);
  3173.   },
  3174.  
  3175.   unregisterSelf: function(componentManager, fileSpec, location) {
  3176.     componentManager.QueryInterface(Ci.nsIComponentRegistrar);
  3177.     componentManager.unregisterFactoryLocation(kClassID, fileSpec);
  3178.   },
  3179.  
  3180.   getClassObject: function (componentManager, cid, iid) {
  3181.     if (!cid.equals(kClassID))
  3182.       throw Cr.NS_ERROR_NO_INTERFACE;
  3183.     if (!iid.equals(Ci.nsIFactory))
  3184.       throw Cr.NS_ERROR_NOT_IMPLEMENTED;
  3185.     return kFactory;
  3186.   },
  3187.  
  3188.   canUnload: function (componentManager) {
  3189.     return true;
  3190.   }
  3191. };
  3192.  
  3193. function NSGetModule(componentManager, fileSpec) {
  3194.   return gModule;
  3195. }
  3196.  
  3197. /*
  3198. #include ../../../toolkit/content/debug.js
  3199. */
  3200.  
  3201. // Direct copy of debug.js, as apparently we aren't allowed 
  3202. // to use the preprocessor on JS components.
  3203.  
  3204. var gTraceOnAssert = true;
  3205.  
  3206. /**
  3207.  * This function provides a simple assertion function for JavaScript.
  3208.  * If the condition is true, this function will do nothing.  If the
  3209.  * condition is false, then the message will be printed to the console
  3210.  * and an alert will appear showing a stack trace, so that the (alpha
  3211.  * or nightly) user can file a bug containing it.  For future enhancements, 
  3212.  * see bugs 330077 and 330078.
  3213.  *
  3214.  * To suppress the dialogs, you can run with the environment variable
  3215.  * XUL_ASSERT_PROMPT set to 0 (if unset, this defaults to 1).
  3216.  *
  3217.  * @param condition represents the condition that we're asserting to be
  3218.  *                  true when we call this function--should be
  3219.  *                  something that can be evaluated as a boolean.
  3220.  * @param message   a string to be displayed upon failure of the assertion
  3221.  */
  3222.  
  3223. function NS_ASSERT(condition, message) {
  3224.   if (condition)
  3225.     return;
  3226.  
  3227.   var caller = arguments.callee.caller;
  3228.   var assertionText = "ASSERT: " + message + "\n";
  3229.   dump(assertionText);
  3230.  
  3231.   var stackText = "";
  3232.   if (gTraceOnAssert) {
  3233.     stackText = "Stack Trace: \n";
  3234.     var count = 0;
  3235.     while (caller) {
  3236.       stackText += count++ + ":" + caller.name + "(";
  3237.       for (var i = 0; i < caller.arguments.length; ++i) {
  3238.         var arg = caller.arguments[i];
  3239.         stackText += arg;
  3240.         if (i < caller.arguments.length - 1)
  3241.           stackText += ",";
  3242.       }
  3243.       stackText += ")\n";
  3244.       caller = caller.arguments.callee.caller;
  3245.     }
  3246.   }
  3247.  
  3248.   var environment = Components.classes["@mozilla.org/process/environment;1"].
  3249.                     getService(Components.interfaces.nsIEnvironment);
  3250.   if (environment.exists("XUL_ASSERT_PROMPT") &&
  3251.       !parseInt(environment.get("XUL_ASSERT_PROMPT")))
  3252.     return;
  3253.  
  3254.   var source = null;
  3255.   if (this.window)
  3256.     source = window;
  3257.   var ps = Components.classes["@mozilla.org/embedcomp/prompt-service;1"].
  3258.            getService(Components.interfaces.nsIPromptService);
  3259.   ps.alert(source, "Assertion Failed", assertionText + stackText);
  3260. }
  3261.