home *** CD-ROM | disk | FTP | other *** search
/ Chip 2002 January / 01_02.iso / linux / mozilla-installer_linux / xpi / browser.xpi / bin / components / nsSidebar.js < prev    next >
Text File  |  2001-11-20  |  16KB  |  427 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2.  * The contents of this file are subject to the Mozilla Public
  3.  * License Version 1.1 (the "License"); you may not use this file
  4.  * except in compliance with the License. You may obtain a copy of
  5.  * the License at http://www.mozilla.org/MPL/
  6.  * 
  7.  * Software distributed under the License is distributed on an "AS
  8.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  9.  * implied. See the License for the specific language governing
  10.  * rights and limitations under the License.
  11.  * 
  12.  * The Original Code is mozilla.org code.
  13.  * 
  14.  * The Initial Developer of the Original Code is Netscape
  15.  * Communications Corporation.  Portions created by Netscape are
  16.  * Copyright (C) 1999 Netscape Communications Corporation.  All
  17.  * Rights Reserved.
  18.  * 
  19.  * Contributor(s): Stephen Lamm            <slamm@netscape.com>
  20.  *                 Robert John Churchill   <rjc@netscape.com>
  21.  */
  22.  
  23. /*
  24.  * No magic constructor behaviour, as is de rigeur for XPCOM.
  25.  * If you must perform some initialization, and it could possibly fail (even
  26.  * due to an out-of-memory condition), you should use an Init method, which
  27.  * can convey failure appropriately (thrown exception in JS,
  28.  * NS_FAILED(nsresult) return in C++).
  29.  *
  30.  * In JS, you can actually cheat, because a thrown exception will cause the
  31.  * CreateInstance call to fail in turn, but not all languages are so lucky.
  32.  * (Though ANSI C++ provides exceptions, they are verboten in Mozilla code
  33.  * for portability reasons -- and even when you're building completely
  34.  * platform-specific code, you can't throw across an XPCOM method boundary.)
  35.  */
  36.  
  37. const DEBUG = false; /* set to false to suppress debug messages */
  38. const PANELS_RDF_FILE  = "UPnls"; /* directory services property to find panels.rdf */
  39.  
  40. const SIDEBAR_CONTRACTID   = "@mozilla.org/sidebar;1";
  41. const SIDEBAR_CID      = Components.ID("{22117140-9c6e-11d3-aaf1-00805f8a4905}");
  42. const CONTAINER_CONTRACTID = "@mozilla.org/rdf/container;1";
  43. const DIR_SERV_CONTRACTID  = "@mozilla.org/file/directory_service;1"
  44. const NETSEARCH_CONTRACTID = "@mozilla.org/rdf/datasource;1?name=internetsearch"
  45. const nsISupports      = Components.interfaces.nsISupports;
  46. const nsIFactory       = Components.interfaces.nsIFactory;
  47. const nsISidebar       = Components.interfaces.nsISidebar;
  48. const nsIRDFContainer  = Components.interfaces.nsIRDFContainer;
  49. const nsIProperties    = Components.interfaces.nsIProperties;
  50. const nsIFileURL       = Components.interfaces.nsIFileURL;
  51. const nsIRDFRemoteDataSource = Components.interfaces.nsIRDFRemoteDataSource;
  52. const nsIInternetSearchService = Components.interfaces.nsIInternetSearchService;
  53. const nsIClassInfo = Components.interfaces.nsIClassInfo;
  54.  
  55. function nsSidebar()
  56. {
  57.     const RDF_CONTRACTID = "@mozilla.org/rdf/rdf-service;1";
  58.     const nsIRDFService = Components.interfaces.nsIRDFService;
  59.     
  60.     this.rdf = Components.classes[RDF_CONTRACTID].getService(nsIRDFService);
  61.     this.datasource_uri = getSidebarDatasourceURI(PANELS_RDF_FILE);
  62.     debug('datasource_uri is ' + this.datasource_uri);
  63.     this.resource = 'urn:sidebar:current-panel-list';
  64.     this.datasource = this.rdf.GetDataSource(this.datasource_uri);
  65. }
  66.  
  67. nsSidebar.prototype.nc = "http://home.netscape.com/NC-rdf#";
  68.  
  69. nsSidebar.prototype.setWindow =
  70. function (aWindow)
  71. {    
  72.     this.window = aWindow;    
  73. }
  74.  
  75. nsSidebar.prototype.isPanel =
  76. function (aContentURL)
  77. {
  78.     var container = 
  79.         Components.classes[CONTAINER_CONTRACTID].createInstance(nsIRDFContainer);
  80.  
  81.     container.Init(this.datasource, this.rdf.GetResource(this.resource));
  82.     
  83.     /* Create a resource for the new panel and add it to the list */
  84.     var panel_resource = 
  85.         this.rdf.GetResource("urn:sidebar:3rdparty-panel:" + aContentURL);
  86.  
  87.     return (container.IndexOf(panel_resource) != -1);
  88. }
  89.  
  90. function sidebarURLSecurityCheck(url)
  91. {
  92.     if (url.search(/(^http:|^ftp:|^https:)/) == -1)
  93.         throw "Script attempted to add sidebar panel from illegal source";
  94. }
  95.  
  96. /* decorate prototype to provide ``class'' methods and property accessors */
  97. nsSidebar.prototype.addPanel =
  98. function (aTitle, aContentURL, aCustomizeURL)
  99. {
  100.     debug("addPanel(" + aTitle + ", " + aContentURL + ", " +
  101.           aCustomizeURL + ")");
  102.  
  103.     if (!this.window)
  104.     {
  105.         debug ("no window object set, bailing out.");
  106.         throw Components.results.NS_ERROR_NOT_INITIALIZED;
  107.     }
  108.  
  109.     sidebarURLSecurityCheck(aContentURL);
  110.  
  111.     // Create a "container" wrapper around the current panels to
  112.     // manipulate the RDF:Seq more easily.
  113.     var panel_list = this.datasource.GetTarget(this.rdf.GetResource(this.resource), this.rdf.GetResource(nsSidebar.prototype.nc+"panel-list"), true);
  114.     if (panel_list) {
  115.         panel_list.QueryInterface(Components.interfaces.nsIRDFResource);
  116.     } else {
  117.         // Datasource is busted. Start over.
  118.         debug("Sidebar datasource is busted\n");
  119.   }
  120.  
  121.     var container = Components.classes[CONTAINER_CONTRACTID].createInstance(nsIRDFContainer);
  122.     container.Init(this.datasource, panel_list);
  123.  
  124.     /* Create a resource for the new panel and add it to the list */
  125.     var panel_resource = 
  126.         this.rdf.GetResource("urn:sidebar:3rdparty-panel:" + aContentURL);
  127.     var panel_index = container.IndexOf(panel_resource);
  128.     var stringBundle, brandStringBundle, titleMessage, dialogMessage, promptService;
  129.     if (panel_index != -1)
  130.     {
  131.         try {
  132.             stringBundle = srGetStrBundle("chrome://communicator/locale/sidebar/sidebar.properties");
  133.             brandStringBundle = srGetStrBundle("chrome://global/locale/brand.properties");
  134.             if (stringBundle) {
  135.                 sidebarName = brandStringBundle.GetStringFromName("sidebarName");
  136.                 titleMessage = stringBundle.GetStringFromName("dupePanelAlertTitle");
  137.                 dialogMessage = stringBundle.GetStringFromName("dupePanelAlertMessage");
  138.                 dialogMessage = dialogMessage.replace(/%url%/, aContentURL);
  139.                 dialogMessage = dialogMessage.replace(/%name%/, sidebarName);
  140.             }
  141.         }
  142.         catch (e) {
  143.             titleMessage = "Sidebar";
  144.             dialogMessage = aContentURL + " already exists in Sidebar.  No string bundle";
  145.         }
  146.           
  147.         promptService = Components.classes["@mozilla.org/embedcomp/prompt-service;1"].getService();
  148.         if (promptService) {
  149.           promptService = promptService.QueryInterface(Components.interfaces.nsIPromptService);
  150.           promptService.alert(this.window, titleMessage, dialogMessage);
  151.         }
  152.  
  153.         return;
  154.     }
  155.  
  156.     try {
  157.         stringBundle = srGetStrBundle("chrome://communicator/locale/sidebar/sidebar.properties");
  158.         brandStringBundle = srGetStrBundle("chrome://global/locale/brand.properties");
  159.         if (stringBundle) {
  160.             sidebarName = brandStringBundle.GetStringFromName("sidebarName");
  161.             titleMessage = stringBundle.GetStringFromName("addPanelConfirmTitle");
  162.             dialogMessage = stringBundle.GetStringFromName("addPanelConfirmMessage");
  163.             dialogMessage = dialogMessage.replace(/%title%/, aTitle);
  164.             dialogMessage = dialogMessage.replace(/%url%/, aContentURL);
  165.             dialogMessage = dialogMessage.replace(/#/g, "\n");
  166.             dialogMessage = dialogMessage.replace(/%name%/, sidebarName);
  167.         }
  168.     }
  169.     catch (e) {
  170.         titleMessage = "Add Tab to Sidebar";
  171.         dialogMessage = "No string bundle.  Add the Tab '" + aTitle + "' to Sidebar?\n\n" + "Source: " + aContentURL;
  172.     }
  173.           
  174.     promptService = Components.classes["@mozilla.org/embedcomp/prompt-service;1"].getService();
  175.     promptService = promptService.QueryInterface(Components.interfaces.nsIPromptService);
  176.     var rv = promptService.confirm(this.window, titleMessage, dialogMessage);
  177.       
  178.     if (!rv)
  179.         return;
  180.  
  181.     /* Now make some sidebar-ish assertions about it... */
  182.     this.datasource.Assert(panel_resource,
  183.                            this.rdf.GetResource(this.nc + "title"),
  184.                            this.rdf.GetLiteral(aTitle),
  185.                            true);
  186.     this.datasource.Assert(panel_resource,
  187.                            this.rdf.GetResource(this.nc + "content"),
  188.                            this.rdf.GetLiteral(aContentURL),
  189.                            true);
  190.     if (aCustomizeURL)
  191.         this.datasource.Assert(panel_resource,
  192.                                this.rdf.GetResource(this.nc + "customize"),
  193.                                this.rdf.GetLiteral(aCustomizeURL),
  194.                                true);
  195.         
  196.     container.AppendElement(panel_resource);
  197.  
  198.     // Use an assertion to pass a "refresh" event to all the sidebars.
  199.     // They use observers to watch for this assertion (in sidebarOverlay.js).
  200.     this.datasource.Assert(this.rdf.GetResource(this.resource),
  201.                            this.rdf.GetResource(this.nc + "refresh"),
  202.                            this.rdf.GetLiteral("true"),
  203.                            true);
  204.     this.datasource.Unassert(this.rdf.GetResource(this.resource),
  205.                              this.rdf.GetResource(this.nc + "refresh"),
  206.                              this.rdf.GetLiteral("true"));
  207.  
  208.     /* Write the modified panels out. */
  209.     this.datasource.QueryInterface(nsIRDFRemoteDataSource).Flush();
  210.  
  211. }
  212.  
  213. /* decorate prototype to provide ``class'' methods and property accessors */
  214. nsSidebar.prototype.addSearchEngine =
  215. function (engineURL, iconURL, suggestedTitle, suggestedCategory)
  216. {
  217.     debug("addSearchEngine(" + engineURL + ", " + iconURL + ", " +
  218.           suggestedCategory + ", " + suggestedTitle + ")");
  219.  
  220.     if (!this.window)
  221.     {
  222.         debug ("no window object set, bailing out.");
  223.         throw Components.results.NS_ERROR_NOT_INITIALIZED;
  224.     }
  225.  
  226.     try
  227.     {
  228.         // make sure using HTTP (for both engine as well as icon URLs)
  229.  
  230.         if (engineURL.search(/^http:\/\//i) == -1)
  231.         {
  232.             debug ("must use HTTP to fetch search engine file");
  233.             throw Components.results.NS_ERROR_INVALID_ARG;
  234.         }
  235.  
  236.         if (iconURL.search(/^http:\/\//i) == -1)
  237.         {
  238.             debug ("must use HTTP to fetch search icon file");
  239.             throw Components.results.NS_ERROR_INVALID_ARG;
  240.         }
  241.  
  242.         // make sure engineURL refers to a .src file
  243.         if (engineURL.search(/\.src$/i) == -1)
  244.         {
  245.             debug ("engineURL doesn't reference a .src file");
  246.             throw Components.results.NS_ERROR_INVALID_ARG;
  247.         }
  248.  
  249.         // make sure iconURL refers to a .gif/.jpg/.jpeg/.png file
  250.         if (iconURL.search(/\.(gif|jpg|jpeg|png)$/i) == -1)
  251.         {
  252.             debug ("iconURL doesn't reference a supported image file");
  253.             throw Components.results.NS_ERROR_INVALID_ARG;
  254.         }
  255.  
  256.     }
  257.     catch(ex)
  258.     {
  259.         this.window.alert("Failed to add the search engine.\n");
  260.         throw Components.results.NS_ERROR_INVALID_ARG;
  261.     }
  262.  
  263.     var titleMessage, dialogMessage;
  264.     try {
  265.         var stringBundle = srGetStrBundle("chrome://communicator/locale/sidebar/sidebar.properties");
  266.         var brandStringBundle = srGetStrBundle("chrome://global/locale/brand.properties");
  267.         if (stringBundle) {
  268.             sidebarName = brandStringBundle.GetStringFromName("sidebarName");            
  269.             titleMessage = stringBundle.GetStringFromName("addEngineConfirmTitle");
  270.             dialogMessage = stringBundle.GetStringFromName("addEngineConfirmMessage");
  271.             dialogMessage = dialogMessage.replace(/%title%/, suggestedTitle);
  272.             dialogMessage = dialogMessage.replace(/%category%/, suggestedCategory);
  273.             dialogMessage = dialogMessage.replace(/%url%/, engineURL);
  274.             dialogMessage = dialogMessage.replace(/#/g, "\n");
  275.             dialogMessage = dialogMessage.replace(/%name%/, sidebarName);
  276.         }
  277.     }
  278.     catch (e) {
  279.         titleMessage = "Add Search Engine";
  280.         dialogMessage = "Add the following search engine?\n\nName: " + suggestedTitle;
  281.         dialogMessage += "\nSearch Category: " + suggestedCategory;
  282.         dialogMessage += "\nSource: " + engineURL;
  283.     }
  284.           
  285.     var promptService = Components.classes["@mozilla.org/embedcomp/prompt-service;1"].getService();
  286.     promptService = promptService.QueryInterface(Components.interfaces.nsIPromptService);
  287.     var rv = promptService.confirm(this.window, titleMessage, dialogMessage);
  288.       
  289.     if (!rv)
  290.         return;
  291.  
  292.     var internetSearch = Components.classes[NETSEARCH_CONTRACTID].getService();
  293.     if (internetSearch)    
  294.         internetSearch = internetSearch.QueryInterface(nsIInternetSearchService);
  295.     if (internetSearch)
  296.     {
  297.         internetSearch.AddSearchEngine(engineURL, iconURL, suggestedTitle,
  298.                                        suggestedCategory);
  299.     }
  300. }
  301.  
  302. // property of nsIClassInfo
  303. nsSidebar.prototype.flags = nsIClassInfo.DOM_OBJECT;
  304.  
  305. // property of nsIClassInfo
  306. nsSidebar.prototype.classDescription = "Sidebar";
  307.  
  308. nsSidebar.prototype.QueryInterface =
  309. function (iid) {
  310.     if (!iid.equals(nsISidebar) && 
  311.         !iid.equals(nsIClassInfo) &&
  312.         !iid.equals(nsISupports))
  313.         throw Components.results.NS_ERROR_NO_INTERFACE;
  314.     return this;
  315. }
  316.  
  317. var sidebarModule = new Object();
  318.  
  319. sidebarModule.registerSelf =
  320. function (compMgr, fileSpec, location, type)
  321. {
  322.     debug("registering (all right -- a JavaScript module!)");
  323.     compMgr.registerComponentWithType(SIDEBAR_CID, "Sidebar JS Component",
  324.                                       SIDEBAR_CONTRACTID, fileSpec, location,
  325.                                       true, true, type);
  326. }
  327.  
  328. sidebarModule.getClassObject =
  329. function (compMgr, cid, iid) {
  330.     if (!cid.equals(SIDEBAR_CID))
  331.         throw Components.results.NS_ERROR_NO_INTERFACE;
  332.     
  333.     if (!iid.equals(Components.interfaces.nsIFactory))
  334.         throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
  335.     
  336.     return sidebarFactory;
  337. }
  338.  
  339. sidebarModule.canUnload =
  340. function(compMgr)
  341. {
  342.     debug("Unloading component.");
  343.     return true;
  344. }
  345.     
  346. /* factory object */
  347. var sidebarFactory = new Object();
  348.  
  349. sidebarFactory.createInstance =
  350. function (outer, iid) {
  351.     debug("CI: " + iid);
  352.     if (outer != null)
  353.         throw Components.results.NS_ERROR_NO_AGGREGATION;
  354.  
  355.     return (new nsSidebar()).QueryInterface(iid);
  356. }
  357.  
  358. /* entrypoint */
  359. function NSGetModule(compMgr, fileSpec) {
  360.     return sidebarModule;
  361. }
  362.  
  363. /* static functions */
  364. if (DEBUG)
  365.     debug = function (s) { dump("-*- sidebar component: " + s + "\n"); }
  366. else
  367.     debug = function (s) {}
  368.  
  369. function getSidebarDatasourceURI(panels_file_id)
  370. {
  371.     try 
  372.     {
  373.         /* use the fileLocator to look in the profile directory 
  374.          * to find 'panels.rdf', which is the
  375.          * database of the user's currently selected panels. */
  376.         var directory_service = Components.classes[DIR_SERV_CONTRACTID].getService();
  377.         if (directory_service)
  378.             directory_service = directory_service.QueryInterface(Components.interfaces.nsIProperties);
  379.  
  380.         /* if <profile>/panels.rdf doesn't exist, get will copy
  381.          *bin/defaults/profile/panels.rdf to <profile>/panels.rdf */
  382.         var sidebar_file = directory_service.get(panels_file_id, Components.interfaces.nsIFile);
  383.  
  384.         if (!sidebar_file.exists())
  385.         {
  386.             /* this should not happen, as GetFileLocation() should copy
  387.              * defaults/panels.rdf to the users profile directory */
  388.             debug("sidebar file does not exist");
  389.             return null;
  390.         }
  391.  
  392.         debug("sidebar uri is " + sidebar_file.URL);
  393.         return sidebar_file.URL;
  394.     }
  395.     catch (ex)
  396.     {
  397.         /* this should not happen */
  398.         debug("caught " + ex + " getting sidebar datasource uri");
  399.         return null;
  400.     }
  401. }
  402.  
  403.  
  404. var strBundleService = null;
  405. function srGetStrBundle(path)
  406. {
  407.    var strBundle = null;
  408.    if (!strBundleService) {
  409.        try {
  410.           strBundleService =
  411.           Components.classes["@mozilla.org/intl/stringbundle;1"].getService(); 
  412.           strBundleService = 
  413.           strBundleService.QueryInterface(Components.interfaces.nsIStringBundleService);
  414.        } catch (ex) {
  415.           dump("\n--** strBundleService failed: " + ex + "\n");
  416.           return null;
  417.       }
  418.    }
  419.    strBundle = strBundleService.createBundle(path); 
  420.    if (!strBundle) {
  421.        dump("\n--** strBundle createInstance failed **--\n");
  422.    }
  423.    return strBundle;
  424. }
  425.  
  426.  
  427.