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