common/modules/services.jsm

   1 // Copyright (c) 2008-2011 by Kris Maglione <maglione.k at Gmail>
   2 //
   3 // This work is licensed for reuse under an MIT license. Details are
   4 // given in the LICENSE.txt file included with this file.
   5 /* use strict */
   6
   7 try {
   8
   9 var global = this;
  10 Components.utils.import("resource://dactyl/bootstrap.jsm");
  11 defineModule("services", {
  12     exports: ["services"]
  13 }, this);
  14
  15 /**
  16  * A lazily-instantiated XPCOM class and service cache.
  17  */
  18 var Services = Module("Services", {
  19     ABOUT: "@mozilla.org/network/protocol/about;1?what=",
  20     AUTOCOMPLETE: "@mozilla.org/autocomplete/search;1?name=",
  21     PROTOCOL: "@mozilla.org/network/protocol;1?name=",
  22
  23     init: function () {
  24         this.services = {};
  25
  26         this.add("annotation",          "@mozilla.org/browser/annotation-service;1",        "nsIAnnotationService");
  27         this.add("appShell",            "@mozilla.org/appshell/appShellService;1",          "nsIAppShellService");
  28         this.add("appStartup",          "@mozilla.org/toolkit/app-startup;1",               "nsIAppStartup");
  29         this.add("bookmarks",           "@mozilla.org/browser/nav-bookmarks-service;1",     "nsINavBookmarksService");
  30         this.add("bootstrap",           "@dactyl.googlecode.com/base/bootstrap");
  31         this.add("browserSearch",       "@mozilla.org/browser/search-service;1",            "nsIBrowserSearchService");
  32         this.add("cache",               "@mozilla.org/network/cache-service;1",             "nsICacheService");
  33         this.add("charset",             "@mozilla.org/charset-converter-manager;1",         "nsICharsetConverterManager");
  34         this.add("chromeRegistry",      "@mozilla.org/chrome/chrome-registry;1",            "nsIXULChromeRegistry");
  35         this.add("clipboard",           "@mozilla.org/widget/clipboard;1",                  "nsIClipboard");
  36         this.add("clipboardHelper",     "@mozilla.org/widget/clipboardhelper;1",            "nsIClipboardHelper");
  37         this.add("commandLineHandler",  "@mozilla.org/commandlinehandler/general-startup;1?type=dactyl");
  38         this.add("console",             "@mozilla.org/consoleservice;1",                    "nsIConsoleService");
  39         this.add("contentPrefs",        "@mozilla.org/content-pref/service;1",              "nsIContentPrefService");
  40         this.add("dactyl",              "@dactyl.googlecode.com/extra/utils",               "dactylIUtils");
  41         this.add("dactyl:",             this.PROTOCOL + "dactyl");
  42         this.add("debugger",            "@mozilla.org/js/jsd/debugger-service;1",           "jsdIDebuggerService");
  43         this.add("directory",           "@mozilla.org/file/directory_service;1",            "nsIProperties");
  44         this.add("downloadManager",     "@mozilla.org/download-manager;1",                  "nsIDownloadManager");
  45         this.add("environment",         "@mozilla.org/process/environment;1",               "nsIEnvironment");
  46         this.add("extensionManager",    "@mozilla.org/extensions/manager;1",                "nsIExtensionManager");
  47         this.add("externalApp",         "@mozilla.org/uriloader/external-helper-app-service;1", "nsPIExternalAppLauncher")
  48         this.add("externalProtocol",    "@mozilla.org/uriloader/external-protocol-service;1", "nsIExternalProtocolService");
  49         this.add("favicon",             "@mozilla.org/browser/favicon-service;1",           "nsIFaviconService");
  50         this.add("file:",               this.PROTOCOL + "file",                             "nsIFileProtocolHandler");
  51         this.add("focus",               "@mozilla.org/focus-manager;1",                     "nsIFocusManager");
  52         this.add("history",             "@mozilla.org/browser/global-history;2",
  53                  ["nsIBrowserHistory", "nsIGlobalHistory2", "nsINavHistoryService", "nsPIPlacesDatabase"]);
  54         this.add("io",                  "@mozilla.org/network/io-service;1",                "nsIIOService");
  55         this.add("json",                "@mozilla.org/dom/json;1",                          "nsIJSON", "createInstance");
  56         this.add("listeners",           "@mozilla.org/eventlistenerservice;1",              "nsIEventListenerService");
  57         this.add("livemark",            "@mozilla.org/browser/livemark-service;2",          "nsILivemarkService");
  58         this.add("messages",            "@mozilla.org/globalmessagemanager;1",              "nsIChromeFrameMessageManager");
  59         this.add("mime",                "@mozilla.org/mime;1",                              "nsIMIMEService");
  60         this.add("observer",            "@mozilla.org/observer-service;1",                  "nsIObserverService");
  61         this.add("pref",                "@mozilla.org/preferences-service;1",               ["nsIPrefBranch2", "nsIPrefService"]);
  62         this.add("privateBrowsing",     "@mozilla.org/privatebrowsing;1",                   "nsIPrivateBrowsingService");
  63         this.add("profile",             "@mozilla.org/toolkit/profile-service;1",           "nsIToolkitProfileService");
  64         this.add("resource:",           this.PROTOCOL + "resource",                         ["nsIProtocolHandler", "nsIResProtocolHandler"]);
  65         this.add("runtime",             "@mozilla.org/xre/runtime;1",                       ["nsIXULAppInfo", "nsIXULRuntime"]);
  66         this.add("rdf",                 "@mozilla.org/rdf/rdf-service;1",                   "nsIRDFService");
  67         this.add("security",            "@mozilla.org/scriptsecuritymanager;1",             "nsIScriptSecurityManager");
  68         this.add("sessionStore",        "@mozilla.org/browser/sessionstore;1",              "nsISessionStore");
  69         this.add("spell",               "@mozilla.org/spellchecker/engine;1",               "mozISpellCheckingEngine");
  70         this.add("stringBundle",        "@mozilla.org/intl/stringbundle;1",                 "nsIStringBundleService");
  71         this.add("stylesheet",          "@mozilla.org/content/style-sheet-service;1",       "nsIStyleSheetService");
  72         this.add("subscriptLoader",     "@mozilla.org/moz/jssubscript-loader;1",            "mozIJSSubScriptLoader");
  73         this.add("tagging",             "@mozilla.org/browser/tagging-service;1",           "nsITaggingService");
  74         this.add("tld",                 "@mozilla.org/network/effective-tld-service;1",     "nsIEffectiveTLDService");
  75         this.add("threading",           "@mozilla.org/thread-manager;1",                    "nsIThreadManager");
  76         this.add("urifixup",            "@mozilla.org/docshell/urifixup;1",                 "nsIURIFixup");
  77         this.add("versionCompare",      "@mozilla.org/xpcom/version-comparator;1",          "nsIVersionComparator");
  78         this.add("windowMediator",      "@mozilla.org/appshell/window-mediator;1",          "nsIWindowMediator");
  79         this.add("windowWatcher",       "@mozilla.org/embedcomp/window-watcher;1",          "nsIWindowWatcher");
  80         this.add("zipReader",           "@mozilla.org/libjar/zip-reader-cache;1",           "nsIZipReaderCache");
  81
  82         this.addClass("CharsetConv",  "@mozilla.org/intl/scriptableunicodeconverter", "nsIScriptableUnicodeConverter", "charset");
  83         this.addClass("CharsetStream","@mozilla.org/intl/converter-input-stream;1",   ["nsIConverterInputStream",
  84                                                                                        "nsIUnicharLineInputStream"], "init");
  85         this.addClass("ConvOutStream","@mozilla.org/intl/converter-output-stream;1", "nsIConverterOutputStream", "init", false);
  86         this.addClass("File",         "@mozilla.org/file/local;1",                 "nsILocalFile");
  87         this.addClass("FileInStream", "@mozilla.org/network/file-input-stream;1",  "nsIFileInputStream", "init", false);
  88         this.addClass("FileOutStream","@mozilla.org/network/file-output-stream;1", "nsIFileOutputStream", "init", false);
  89         this.addClass("Find",         "@mozilla.org/embedcomp/rangefind;1",        "nsIFind");
  90         this.addClass("FormData",     "@mozilla.org/files/formdata;1",             "nsIDOMFormData");
  91         this.addClass("HtmlConverter","@mozilla.org/widget/htmlformatconverter;1", "nsIFormatConverter");
  92         this.addClass("HtmlEncoder",  "@mozilla.org/layout/htmlCopyEncoder;1",     "nsIDocumentEncoder");
  93         this.addClass("InterfacePointer", "@mozilla.org/supports-interface-pointer;1", "nsISupportsInterfacePointer", "data");
  94         this.addClass("InputStream",  "@mozilla.org/scriptableinputstream;1",      "nsIScriptableInputStream", "init");
  95         this.addClass("MIMEStream",   "@mozilla.org/network/mime-input-stream;1",  "nsIMIMEInputStream", "setData");
  96         this.addClass("Persist",      "@mozilla.org/embedding/browser/nsWebBrowserPersist;1", "nsIWebBrowserPersist");
  97         this.addClass("Pipe",         "@mozilla.org/pipe;1",                       "nsIPipe", "init");
  98         this.addClass("Process",      "@mozilla.org/process/util;1",               "nsIProcess", "init");
  99         this.addClass("Pump",         "@mozilla.org/network/input-stream-pump;1",  "nsIInputStreamPump", "init")
 100         this.addClass("StreamChannel","@mozilla.org/network/input-stream-channel;1",
 101                       ["nsIInputStreamChannel", "nsIChannel"], "setURI");
 102         this.addClass("StreamCopier", "@mozilla.org/network/async-stream-copier;1","nsIAsyncStreamCopier", "init");
 103         this.addClass("String",       "@mozilla.org/supports-string;1",            "nsISupportsString", "data");
 104         this.addClass("StringStream", "@mozilla.org/io/string-input-stream;1",     "nsIStringInputStream", "data");
 105         this.addClass("Transfer",     "@mozilla.org/transfer;1",                   "nsITransfer", "init");
 106         this.addClass("Transferable", "@mozilla.org/widget/transferable;1",        "nsITransferable");
 107         this.addClass("Timer",        "@mozilla.org/timer;1",                      "nsITimer", "initWithCallback");
 108         this.addClass("URL",          "@mozilla.org/network/standard-url;1",       ["nsIStandardURL", "nsIURL"], "init");
 109         this.addClass("Xmlhttp",      "@mozilla.org/xmlextras/xmlhttprequest;1",   [], "open");
 110         this.addClass("XPathEvaluator", "@mozilla.org/dom/xpath-evaluator;1",      "nsIDOMXPathEvaluator");
 111         this.addClass("XMLDocument",  "@mozilla.org/xml/xml-document;1",           ["nsIDOMXMLDocument", "nsIDOMNodeSelector"]);
 112         this.addClass("ZipReader",    "@mozilla.org/libjar/zip-reader;1",          "nsIZipReader", "open", false);
 113         this.addClass("ZipWriter",    "@mozilla.org/zipwriter;1",                  "nsIZipWriter", "open", false);
 114     },
 115     reinit: function () {},
 116
 117     _create: function (name, args) {
 118         try {
 119             var service = this.services[name];
 120
 121             let res = Cc[service.class][service.method || "getService"]();
 122             if (!service.interfaces.length)
 123                 return res.wrappedJSObject || res;
 124
 125             service.interfaces.forEach(function (iface) res.QueryInterface(Ci[iface]));
 126             if (service.init && args.length) {
 127                 if (service.callable)
 128                     res[service.init].apply(res, args);
 129                 else
 130                     res[service.init] = args[0];
 131             }
 132             return res;
 133         }
 134         catch (e if service.quiet !== false) {
 135             if (typeof util !== "undefined")
 136                 util.reportError(e);
 137             else
 138                 dump("dactyl: Service creation failed for '" + service.class + "': " + e + "\n" + (e.stack || Error(e).stack));
 139             return null;
 140         }
 141     },
 142
 143     /**
 144      * Adds a new XPCOM service to the cache.
 145      *
 146      * @param {string} name The service's cache key.
 147      * @param {string} class The class's contract ID.
 148      * @param {string|[string]} ifaces The interface or array of
 149      *     interfaces implemented by this service.
 150      * @param {string} meth The name of the function used to instantiate
 151      *     the service.
 152      */
 153     add: function (name, class_, ifaces, meth) {
 154         const self = this;
 155         this.services[name] = { method: meth, class: class_, interfaces: Array.concat(ifaces || []) };
 156         if (name in this && ifaces && !this.__lookupGetter__(name) && !(this[name] instanceof Ci.nsISupports))
 157             throw TypeError();
 158         memoize(this, name, function () self._create(name));
 159     },
 160
 161     /**
 162      * Adds a new XPCOM class to the cache.
 163      *
 164      * @param {string} name The class's cache key.
 165      * @param {string} class_ The class's contract ID.
 166      * @param {string|[string]} ifaces The interface or array of
 167      *     interfaces implemented by this class.
 168      * @param {string} init Name of a property or method used to initialize the
 169      *     class.
 170      */
 171     addClass: function (name, class_, ifaces, init, quiet) {
 172         const self = this;
 173         this.services[name] = { class: class_, interfaces: Array.concat(ifaces || []), method: "createInstance", init: init, quiet: quiet };
 174         if (init)
 175             memoize(this.services[name], "callable",
 176                     function () callable(XPCOMShim(this.interfaces)[this.init]));
 177
 178         this[name] = function () self._create(name, arguments);
 179         update.apply(null, [this[name]].concat([Ci[i] for each (i in Array.concat(ifaces))]));
 180         return this[name];
 181     },
 182
 183     /**
 184      * Returns a new instance of the cached class with the specified name.
 185      *
 186      * @param {string} name The class's cache key.
 187      */
 188     create: deprecated("services.*name*()", function create(name) this[util.capitalize(name)]()),
 189
 190     /**
 191      * Returns the cached service with the specified name.
 192      *
 193      * @param {string} name The service's cache key.
 194      */
 195     get: deprecated("services.*name*", function get(name) this[name]),
 196
 197     /**
 198      * Returns true if the given service is available.
 199      *
 200      * @param {string} name The service's cache key.
 201      */
 202     has: function (name) Set.has(this.services, name) && this.services[name].class in Cc &&
 203         this.services[name].interfaces.every(function (iface) iface in Ci)
 204 });
 205
 206 endModule();
 207
 208 } catch(e){dump(e.fileName+":"+e.lineNumber+": "+e+"\n" + e.stack);}
 209
 210 // vim: set fdm=marker sw=4 sts=4 et ft=javascript: