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 / nsSidebar.js < prev    next >
Text File  |  2007-12-21  |  15KB  |  383 lines
  1. /*
  2. # -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  3. # ***** BEGIN LICENSE BLOCK *****
  4. # Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5. #
  6. # The contents of this file are subject to the Mozilla Public License Version
  7. # 1.1 (the "License"); you may not use this file except in compliance with
  8. # the License. You may obtain a copy of the License at
  9. # http://www.mozilla.org/MPL/
  10. #
  11. # Software distributed under the License is distributed on an "AS IS" basis,
  12. # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13. # for the specific language governing rights and limitations under the
  14. # License.
  15. #
  16. # The Original Code is mozilla.org code.
  17. #
  18. # The Initial Developer of the Original Code is
  19. # Netscape Communications Corporation.
  20. # Portions created by the Initial Developer are Copyright (C) 1999
  21. # the Initial Developer. All Rights Reserved.
  22. #
  23. # Contributor(s):
  24. #   Stephen Lamm            <slamm@netscape.com>
  25. #   Robert John Churchill   <rjc@netscape.com>
  26. #   David Hyatt             <hyatt@mozilla.org>
  27. #   Christopher A. Aillon   <christopher@aillon.com>
  28. #   Myk Melez               <myk@mozilla.org>
  29. #   Pamela Greene           <pamg.bugs@gmail.com>
  30. #
  31. # Alternatively, the contents of this file may be used under the terms of
  32. # either the GNU General Public License Version 2 or later (the "GPL"), or
  33. # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  34. # in which case the provisions of the GPL or the LGPL are applicable instead
  35. # of those above. If you wish to allow use of your version of this file only
  36. # under the terms of either the GPL or the LGPL, and not to allow others to
  37. # use your version of this file under the terms of the MPL, indicate your
  38. # decision by deleting the provisions above and replace them with the notice
  39. # and other provisions required by the GPL or the LGPL. If you do not delete
  40. # the provisions above, a recipient may use your version of this file under
  41. # the terms of any one of the MPL, the GPL or the LGPL.
  42. #
  43. # ***** END LICENSE BLOCK *****  
  44. */
  45.  
  46. /*
  47.  * No magic constructor behaviour, as is de rigeur for XPCOM.
  48.  * If you must perform some initialization, and it could possibly fail (even
  49.  * due to an out-of-memory condition), you should use an Init method, which
  50.  * can convey failure appropriately (thrown exception in JS,
  51.  * NS_FAILED(nsresult) return in C++).
  52.  *
  53.  * In JS, you can actually cheat, because a thrown exception will cause the
  54.  * CreateInstance call to fail in turn, but not all languages are so lucky.
  55.  * (Though ANSI C++ provides exceptions, they are verboten in Mozilla code
  56.  * for portability reasons -- and even when you're building completely
  57.  * platform-specific code, you can't throw across an XPCOM method boundary.)
  58.  */
  59.  
  60. const DEBUG = false; /* set to false to suppress debug messages */
  61.  
  62. const SIDEBAR_CONTRACTID        = "@mozilla.org/sidebar;1";
  63. const SIDEBAR_CID               = Components.ID("{22117140-9c6e-11d3-aaf1-00805f8a4905}");
  64. const nsISupports               = Components.interfaces.nsISupports;
  65. const nsIFactory                = Components.interfaces.nsIFactory;
  66. const nsISidebar                = Components.interfaces.nsISidebar;
  67. const nsISidebarExternal        = Components.interfaces.nsISidebarExternal;
  68. const nsIClassInfo              = Components.interfaces.nsIClassInfo;
  69.  
  70. // File extension for Sherlock search plugin description files
  71. const SHERLOCK_FILE_EXT_REGEXP = /\.src$/i;
  72.  
  73. function nsSidebar()
  74. {
  75.     const PROMPTSERVICE_CONTRACTID = "@mozilla.org/embedcomp/prompt-service;1";
  76.     const nsIPromptService = Components.interfaces.nsIPromptService;
  77.     this.promptService =
  78.         Components.classes[PROMPTSERVICE_CONTRACTID].getService(nsIPromptService);
  79.  
  80.     const SEARCHSERVICE_CONTRACTID = "@mozilla.org/browser/search-service;1";
  81.     const nsIBrowserSearchService = Components.interfaces.nsIBrowserSearchService;
  82.     this.searchService =
  83.       Components.classes[SEARCHSERVICE_CONTRACTID].getService(nsIBrowserSearchService);
  84. }
  85.  
  86. nsSidebar.prototype.nc = "http://home.netscape.com/NC-rdf#";
  87.  
  88. function sidebarURLSecurityCheck(url)
  89. {
  90.     if (!/^(https?:|ftp:)/i.test(url)) {
  91.         Components.utils.reportError("Invalid argument passed to window.sidebar.addPanel: Unsupported panel URL." );
  92.         return false;
  93.     }
  94.     return true;
  95. }
  96.  
  97. /* decorate prototype to provide ``class'' methods and property accessors */
  98. /*
  99. nsSidebar.prototype.addPanel =
  100. function (aTitle, aContentURL, aCustomizeURL)
  101. {
  102.     debug("addPanel(" + aTitle + ", " + aContentURL + ", " +
  103.           aCustomizeURL + ")");
  104.    
  105.     return this.addPanelInternal(aTitle, aContentURL, aCustomizeURL, false);
  106. }
  107.  
  108. nsSidebar.prototype.addPersistentPanel = 
  109. function(aTitle, aContentURL, aCustomizeURL)
  110. {
  111.     debug("addPersistentPanel(" + aTitle + ", " + aContentURL + ", " +
  112.            aCustomizeURL + ")\n");
  113.  
  114.     return this.addPanelInternal(aTitle, aContentURL, aCustomizeURL, true);
  115. }
  116.  
  117. nsSidebar.prototype.addPanelInternal =
  118. function (aTitle, aContentURL, aCustomizeURL, aPersist)
  119. {
  120.     var WINMEDSVC = Components.classes['@mozilla.org/appshell/window-mediator;1']
  121.                               .getService(Components.interfaces.nsIWindowMediator);
  122.     var win = WINMEDSVC.getMostRecentWindow( "navigator:browser" );
  123.                                                                                 
  124.     if (!sidebarURLSecurityCheck(aContentURL))
  125.       return;
  126.  
  127.     var uri = null;
  128.     var ioService = Components.classes["@mozilla.org/network/io-service;1"]
  129.                               .getService(Components.interfaces.nsIIOService);
  130.     try {
  131.       uri = ioService.newURI(aContentURL, null, null);
  132.     }
  133.     catch(ex) { return; }
  134.  
  135.     win.PlacesUtils.showMinimalAddBookmarkUI(uri, aTitle, null, null, true, true);
  136. }
  137. */
  138. nsSidebar.prototype.validateSearchEngine =
  139. function (engineURL, iconURL)
  140. {
  141.   try
  142.   {
  143.     // Make sure we're using HTTP, HTTPS, or FTP.
  144.     if (! /^(https?|ftp):\/\//i.test(engineURL))
  145.       throw "Unsupported search engine URL";
  146.   
  147.     // Make sure we're using HTTP, HTTPS, or FTP and refering to a
  148.     // .gif/.jpg/.jpeg/.png/.ico file for the icon.
  149.     if (iconURL &&
  150.         ! /^(https?|ftp):\/\/.+\.(gif|jpg|jpeg|png|ico)$/i.test(iconURL))
  151.       throw "Unsupported search icon URL.";
  152.   }
  153.   catch(ex)
  154.   {
  155.     debug(ex);
  156.     Components.utils.reportError("Invalid argument passed to window.sidebar.addSearchEngine: " + ex);
  157.     
  158.     var searchBundle = srGetStrBundle("chrome://browser/locale/search.properties");
  159.     var brandBundle = srGetStrBundle("chrome://branding/locale/brand.properties");
  160.     var brandName = brandBundle.GetStringFromName("brandShortName");
  161.     var title = searchBundle.GetStringFromName("error_invalid_engine_title");
  162.     var msg = searchBundle.formatStringFromName("error_invalid_engine_msg",
  163.                                                 [brandName], 1);
  164.     var ww = Components.classes["@mozilla.org/embedcomp/window-watcher;1"].
  165.              getService(Components.interfaces.nsIWindowWatcher);
  166.     ww.getNewPrompter(null).alert(title, msg);
  167.     return false;
  168.   }
  169.   
  170.   return true;
  171. }
  172.  
  173. // The suggestedTitle and suggestedCategory parameters are ignored, but remain
  174. // for backward compatibility.
  175. nsSidebar.prototype.addSearchEngine =
  176. function (engineURL, iconURL, suggestedTitle, suggestedCategory)
  177. {
  178.   debug("addSearchEngine(" + engineURL + ", " + iconURL + ", " +
  179.         suggestedCategory + ", " + suggestedTitle + ")");
  180.  
  181.   if (!this.validateSearchEngine(engineURL, iconURL))
  182.     return;
  183.  
  184.   // OpenSearch files will likely be far more common than Sherlock files, and
  185.   // have less consistent suffixes, so we assume that ".src" is a Sherlock
  186.   // (text) file, and anything else is OpenSearch (XML).
  187.   var dataType;
  188.   if (SHERLOCK_FILE_EXT_REGEXP.test(engineURL))
  189.     dataType = Components.interfaces.nsISearchEngine.DATA_TEXT;
  190.   else
  191.     dataType = Components.interfaces.nsISearchEngine.DATA_XML;
  192.  
  193.   this.searchService.addEngine(engineURL, dataType, iconURL, true);
  194. }
  195.  
  196. // This function exists largely to implement window.external.AddSearchProvider(),
  197. // to match other browsers' APIs.  The capitalization, although nonstandard here,
  198. // is therefore important.
  199. nsSidebar.prototype.AddSearchProvider =
  200. function (aDescriptionURL)
  201. {
  202.   // Get the favicon URL for the current page, or our best guess at the current
  203.   // page since we don't have easy access to the active document.  Most search
  204.   // engines will override this with an icon specified in the OpenSearch
  205.   // description anyway.
  206.   var WINMEDSVC = Components.classes['@mozilla.org/appshell/window-mediator;1']
  207.                             .getService(Components.interfaces.nsIWindowMediator);
  208.   var win = WINMEDSVC.getMostRecentWindow("Songbird:Main");
  209.   var browser = win.document.getElementById("content");
  210.   var iconURL = "";
  211.   if (browser.shouldLoadFavIcon(browser.selectedBrowser.currentURI))  {
  212.     //iconURL = win.gProxyFavIcon.getAttribute("src");
  213.     if (win.gBrowser) 
  214.       iconURL = win.gBrowser.mCurrentBrowser.mIconURL;
  215.   }
  216.   if (!this.validateSearchEngine(aDescriptionURL, iconURL))
  217.     return;
  218.  
  219.   const typeXML = Components.interfaces.nsISearchEngine.DATA_XML;
  220.   this.searchService.addEngine(aDescriptionURL, typeXML, iconURL, true);
  221. }
  222.  
  223. // This function exists to implement window.external.IsSearchProviderInstalled(),
  224. // for compatibility with other browsers.  It will return an integer value
  225. // indicating whether the given engine is installed for the current user.
  226. // However, it is currently stubbed out due to security/privacy concerns
  227. // stemming from difficulties in determining what domain issued the request.
  228. // See bug 340604 and
  229. // http://msdn.microsoft.com/workshop/author/dhtml/reference/methods/issearchproviderinstalled.asp .
  230. // XXX Implement this!
  231. nsSidebar.prototype.IsSearchProviderInstalled =
  232. function (aSearchURL)
  233. {
  234.   return 0;
  235. }
  236. /*
  237. nsSidebar.prototype.addMicrosummaryGenerator =
  238. function (generatorURL)
  239. {
  240.     debug("addMicrosummaryGenerator(" + generatorURL + ")");
  241.  
  242.     if (!/^https?:/i.test(generatorURL))
  243.       return;
  244.  
  245.     var stringBundle = srGetStrBundle("chrome://browser/locale/sidebar/sidebar.properties");
  246.     var titleMessage = stringBundle.GetStringFromName("addMicsumGenConfirmTitle");
  247.     var dialogMessage = stringBundle.formatStringFromName("addMicsumGenConfirmText", [generatorURL], 1);
  248.       
  249.     if (!this.promptService.confirm(null, titleMessage, dialogMessage))
  250.         return;
  251.  
  252.     var ioService = Components.classes["@mozilla.org/network/io-service;1"].
  253.                     getService(Components.interfaces.nsIIOService);
  254.     var generatorURI = ioService.newURI(generatorURL, null, null);
  255.  
  256.     var microsummaryService = Components.classes["@mozilla.org/microsummary/service;1"].
  257.                               getService(Components.interfaces.nsIMicrosummaryService);
  258.     if (microsummaryService)
  259.       microsummaryService.addGenerator(generatorURI);
  260. }
  261. */
  262. // property of nsIClassInfo
  263. nsSidebar.prototype.flags = nsIClassInfo.DOM_OBJECT;
  264.  
  265. // property of nsIClassInfo
  266. nsSidebar.prototype.classDescription = "Sidebar";
  267.  
  268. // method of nsIClassInfo
  269. nsSidebar.prototype.getInterfaces = function(count) {
  270.     var interfaceList = [nsISidebar, nsISidebarExternal, nsIClassInfo];
  271.     count.value = interfaceList.length;
  272.     return interfaceList;
  273. }
  274.  
  275. // method of nsIClassInfo
  276. nsSidebar.prototype.getHelperForLanguage = function(count) {return null;}
  277.  
  278. nsSidebar.prototype.QueryInterface =
  279. function (iid) {
  280.     if (!iid.equals(nsISidebar) &&
  281.         !iid.equals(nsISidebarExternal) &&
  282.         !iid.equals(nsIClassInfo) &&
  283.         !iid.equals(nsISupports))
  284.         throw Components.results.NS_ERROR_NO_INTERFACE;
  285.     return this;
  286. }
  287.  
  288. var sidebarModule = new Object();
  289.  
  290. sidebarModule.registerSelf =
  291. function (compMgr, fileSpec, location, type)
  292. {
  293.     debug("registering (all right -- a JavaScript module!)");
  294.     compMgr = compMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar);
  295.  
  296.     compMgr.registerFactoryLocation(SIDEBAR_CID, 
  297.                                     "Sidebar JS Component",
  298.                                     SIDEBAR_CONTRACTID, 
  299.                                     fileSpec, 
  300.                                     location,
  301.                                     type);
  302.     const CATMAN_CONTRACTID = "@mozilla.org/categorymanager;1";
  303.     const nsICategoryManager = Components.interfaces.nsICategoryManager;
  304.     var catman = Components.classes[CATMAN_CONTRACTID].
  305.                             getService(nsICategoryManager);
  306.                             
  307.     const JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY = "JavaScript global property";
  308.     catman.addCategoryEntry(JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY,
  309.                             "sidebar",
  310.                             SIDEBAR_CONTRACTID,
  311.                             true,
  312.                             true);
  313.                             
  314.     catman.addCategoryEntry(JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY,
  315.                             "external",
  316.                             SIDEBAR_CONTRACTID,
  317.                             true,
  318.                             true);
  319. }
  320.  
  321. sidebarModule.getClassObject =
  322. function (compMgr, cid, iid) {
  323.     if (!cid.equals(SIDEBAR_CID))
  324.         throw Components.results.NS_ERROR_NO_INTERFACE;
  325.     
  326.     if (!iid.equals(Components.interfaces.nsIFactory))
  327.         throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
  328.     
  329.     return sidebarFactory;
  330. }
  331.  
  332. sidebarModule.canUnload =
  333. function(compMgr)
  334. {
  335.     debug("Unloading component.");
  336.     return true;
  337. }
  338.     
  339. /* factory object */
  340. var sidebarFactory = new Object();
  341.  
  342. sidebarFactory.createInstance =
  343. function (outer, iid) {
  344.     debug("CI: " + iid);
  345.     if (outer != null)
  346.         throw Components.results.NS_ERROR_NO_AGGREGATION;
  347.  
  348.     return (new nsSidebar()).QueryInterface(iid);
  349. }
  350.  
  351. /* entrypoint */
  352. function NSGetModule(compMgr, fileSpec) {
  353.     return sidebarModule;
  354. }
  355.  
  356. /* static functions */
  357. if (DEBUG)
  358.     debug = function (s) { dump("-*- sidebar component: " + s + "\n"); }
  359. else
  360.     debug = function (s) {}
  361.  
  362. var strBundleService = null;
  363. function srGetStrBundle(path)
  364. {
  365.    var strBundle = null;
  366.    if (!strBundleService) {
  367.        try {
  368.           strBundleService =
  369.           Components.classes["@mozilla.org/intl/stringbundle;1"].getService(); 
  370.           strBundleService = 
  371.           strBundleService.QueryInterface(Components.interfaces.nsIStringBundleService);
  372.        } catch (ex) {
  373.           dump("\n--** strBundleService failed: " + ex + "\n");
  374.           return null;
  375.       }
  376.    }
  377.    strBundle = strBundleService.createBundle(path); 
  378.    if (!strBundle) {
  379.        dump("\n--** strBundle createInstance failed **--\n");
  380.    }
  381.    return strBundle;
  382. }
  383.