michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: "use strict";
michael@0: 
michael@0: let { components, Cc, Ci, Cu } = require("chrome");
michael@0: let Services = require("Services");
michael@0: 
michael@0: Cu.import("resource://gre/modules/XPCOMUtils.jsm");
michael@0: Cu.import("resource://gre/modules/NetUtil.jsm");
michael@0: Cu.import("resource://gre/modules/FileUtils.jsm");
michael@0: Cu.import("resource://gre/modules/devtools/SourceMap.jsm");
michael@0: Cu.import("resource://gre/modules/Task.jsm");
michael@0: 
michael@0: const {Promise: promise} = Cu.import("resource://gre/modules/Promise.jsm", {});
michael@0: const events = require("sdk/event/core");
michael@0: const protocol = require("devtools/server/protocol");
michael@0: const {Arg, Option, method, RetVal, types} = protocol;
michael@0: const {LongStringActor, ShortLongString} = require("devtools/server/actors/string");
michael@0: 
michael@0: loader.lazyGetter(this, "CssLogic", () => require("devtools/styleinspector/css-logic").CssLogic);
michael@0: 
michael@0: let TRANSITION_CLASS = "moz-styleeditor-transitioning";
michael@0: let TRANSITION_DURATION_MS = 500;
michael@0: let TRANSITION_BUFFER_MS = 1000;
michael@0: let TRANSITION_RULE = "\
michael@0: :root.moz-styleeditor-transitioning, :root.moz-styleeditor-transitioning * {\
michael@0: transition-duration: " + TRANSITION_DURATION_MS + "ms !important; \
michael@0: transition-delay: 0ms !important;\
michael@0: transition-timing-function: ease-out !important;\
michael@0: transition-property: all !important;\
michael@0: }";
michael@0: 
michael@0: let LOAD_ERROR = "error-load";
michael@0: 
michael@0: exports.register = function(handle) {
michael@0:   handle.addTabActor(StyleSheetsActor, "styleSheetsActor");
michael@0:   handle.addGlobalActor(StyleSheetsActor, "styleSheetsActor");
michael@0: };
michael@0: 
michael@0: exports.unregister = function(handle) {
michael@0:   handle.removeTabActor(StyleSheetsActor);
michael@0:   handle.removeGlobalActor(StyleSheetsActor);
michael@0: };
michael@0: 
michael@0: types.addActorType("stylesheet");
michael@0: types.addActorType("originalsource");
michael@0: 
michael@0: /**
michael@0:  * Creates a StyleSheetsActor. StyleSheetsActor provides remote access to the
michael@0:  * stylesheets of a document.
michael@0:  */
michael@0: let StyleSheetsActor = protocol.ActorClass({
michael@0:   typeName: "stylesheets",
michael@0: 
michael@0:   /**
michael@0:    * The window we work with, taken from the parent actor.
michael@0:    */
michael@0:   get window() this.parentActor.window,
michael@0: 
michael@0:   /**
michael@0:    * The current content document of the window we work with.
michael@0:    */
michael@0:   get document() this.window.document,
michael@0: 
michael@0:   form: function()
michael@0:   {
michael@0:     return { actor: this.actorID };
michael@0:   },
michael@0: 
michael@0:   initialize: function (conn, tabActor) {
michael@0:     protocol.Actor.prototype.initialize.call(this, null);
michael@0: 
michael@0:     this.parentActor = tabActor;
michael@0: 
michael@0:     // keep a map of sheets-to-actors so we don't create two actors for one sheet
michael@0:     this._sheets = new Map();
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Destroy the current StyleSheetsActor instance.
michael@0:    */
michael@0:   destroy: function()
michael@0:   {
michael@0:     this._sheets.clear();
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Protocol method for getting a list of StyleSheetActors representing
michael@0:    * all the style sheets in this document.
michael@0:    */
michael@0:   getStyleSheets: method(function() {
michael@0:     let deferred = promise.defer();
michael@0: 
michael@0:     let window = this.window;
michael@0:     var domReady = () => {
michael@0:       window.removeEventListener("DOMContentLoaded", domReady, true);
michael@0:       this._addAllStyleSheets().then(deferred.resolve, Cu.reportError);
michael@0:     };
michael@0: 
michael@0:     if (window.document.readyState === "loading") {
michael@0:       window.addEventListener("DOMContentLoaded", domReady, true);
michael@0:     } else {
michael@0:       domReady();
michael@0:     }
michael@0: 
michael@0:     return deferred.promise;
michael@0:   }, {
michael@0:     request: {},
michael@0:     response: { styleSheets: RetVal("array:stylesheet") }
michael@0:   }),
michael@0: 
michael@0:   /**
michael@0:    * Add all the stylesheets in this document and its subframes.
michael@0:    * Assumes the document is loaded.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         Promise that resolves with an array of StyleSheetActors
michael@0:    */
michael@0:   _addAllStyleSheets: function() {
michael@0:     return Task.spawn(function() {
michael@0:       let documents = [this.document];
michael@0:       let actors = [];
michael@0: 
michael@0:       for (let doc of documents) {
michael@0:         let sheets = yield this._addStyleSheets(doc.styleSheets);
michael@0:         actors = actors.concat(sheets);
michael@0: 
michael@0:         // Recursively handle style sheets of the documents in iframes.
michael@0:         for (let iframe of doc.getElementsByTagName("iframe")) {
michael@0:           if (iframe.contentDocument) {
michael@0:             // Sometimes, iframes don't have any document, like the
michael@0:             // one that are over deeply nested (bug 285395)
michael@0:             documents.push(iframe.contentDocument);
michael@0:           }
michael@0:         }
michael@0:       }
michael@0:       throw new Task.Result(actors);
michael@0:     }.bind(this));
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Add all the stylesheets to the map and create an actor for each one
michael@0:    * if not already created.
michael@0:    *
michael@0:    * @param {[DOMStyleSheet]} styleSheets
michael@0:    *        Stylesheets to add
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         Promise that resolves to an array of StyleSheetActors
michael@0:    */
michael@0:   _addStyleSheets: function(styleSheets)
michael@0:   {
michael@0:     return Task.spawn(function() {
michael@0:       let actors = [];
michael@0:       for (let i = 0; i < styleSheets.length; i++) {
michael@0:         let actor = this._createStyleSheetActor(styleSheets[i]);
michael@0:         actors.push(actor);
michael@0: 
michael@0:         // Get all sheets, including imported ones
michael@0:         let imports = yield this._getImported(actor);
michael@0:         actors = actors.concat(imports);
michael@0:       }
michael@0:       throw new Task.Result(actors);
michael@0:     }.bind(this));
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Get all the stylesheets @imported from a stylesheet.
michael@0:    *
michael@0:    * @param  {DOMStyleSheet} styleSheet
michael@0:    *         Style sheet to search
michael@0:    * @return {Promise}
michael@0:    *         A promise that resolves with an array of StyleSheetActors
michael@0:    */
michael@0:   _getImported: function(styleSheet) {
michael@0:     return Task.spawn(function() {
michael@0:       let rules = yield styleSheet.getCSSRules();
michael@0:       let imported = [];
michael@0: 
michael@0:       for (let i = 0; i < rules.length; i++) {
michael@0:         let rule = rules[i];
michael@0:         if (rule.type == Ci.nsIDOMCSSRule.IMPORT_RULE) {
michael@0:           // Associated styleSheet may be null if it has already been seen due
michael@0:           // to duplicate @imports for the same URL.
michael@0:           if (!rule.styleSheet) {
michael@0:             continue;
michael@0:           }
michael@0:           let actor = this._createStyleSheetActor(rule.styleSheet);
michael@0:           imported.push(actor);
michael@0: 
michael@0:           // recurse imports in this stylesheet as well
michael@0:           let children = yield this._getImported(actor);
michael@0:           imported = imported.concat(children);
michael@0:         }
michael@0:         else if (rule.type != Ci.nsIDOMCSSRule.CHARSET_RULE) {
michael@0:           // @import rules must precede all others except @charset
michael@0:           break;
michael@0:         }
michael@0:       }
michael@0: 
michael@0:       throw new Task.Result(imported);
michael@0:     }.bind(this));
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Create a new actor for a style sheet, if it hasn't already been created.
michael@0:    *
michael@0:    * @param  {DOMStyleSheet} styleSheet
michael@0:    *         The style sheet to create an actor for.
michael@0:    * @return {StyleSheetActor}
michael@0:    *         The actor for this style sheet
michael@0:    */
michael@0:   _createStyleSheetActor: function(styleSheet)
michael@0:   {
michael@0:     if (this._sheets.has(styleSheet)) {
michael@0:       return this._sheets.get(styleSheet);
michael@0:     }
michael@0:     let actor = new StyleSheetActor(styleSheet, this);
michael@0: 
michael@0:     this.manage(actor);
michael@0:     this._sheets.set(styleSheet, actor);
michael@0: 
michael@0:     return actor;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Clear all the current stylesheet actors in map.
michael@0:    */
michael@0:   _clearStyleSheetActors: function() {
michael@0:     for (let actor in this._sheets) {
michael@0:       this.unmanage(this._sheets[actor]);
michael@0:     }
michael@0:     this._sheets.clear();
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Create a new style sheet in the document with the given text.
michael@0:    * Return an actor for it.
michael@0:    *
michael@0:    * @param  {object} request
michael@0:    *         Debugging protocol request object, with 'text property'
michael@0:    * @return {object}
michael@0:    *         Object with 'styelSheet' property for form on new actor.
michael@0:    */
michael@0:   addStyleSheet: method(function(text) {
michael@0:     let parent = this.document.documentElement;
michael@0:     let style = this.document.createElementNS("http://www.w3.org/1999/xhtml", "style");
michael@0:     style.setAttribute("type", "text/css");
michael@0: 
michael@0:     if (text) {
michael@0:       style.appendChild(this.document.createTextNode(text));
michael@0:     }
michael@0:     parent.appendChild(style);
michael@0: 
michael@0:     let actor = this._createStyleSheetActor(style.sheet);
michael@0:     return actor;
michael@0:   }, {
michael@0:     request: { text: Arg(0, "string") },
michael@0:     response: { styleSheet: RetVal("stylesheet") }
michael@0:   })
michael@0: });
michael@0: 
michael@0: /**
michael@0:  * The corresponding Front object for the StyleSheetsActor.
michael@0:  */
michael@0: let StyleSheetsFront = protocol.FrontClass(StyleSheetsActor, {
michael@0:   initialize: function(client, tabForm) {
michael@0:     protocol.Front.prototype.initialize.call(this, client);
michael@0:     this.actorID = tabForm.styleSheetsActor;
michael@0: 
michael@0:     client.addActorPool(this);
michael@0:     this.manage(this);
michael@0:   }
michael@0: });
michael@0: 
michael@0: /**
michael@0:  * A StyleSheetActor represents a stylesheet on the server.
michael@0:  */
michael@0: let StyleSheetActor = protocol.ActorClass({
michael@0:   typeName: "stylesheet",
michael@0: 
michael@0:   events: {
michael@0:     "property-change" : {
michael@0:       type: "propertyChange",
michael@0:       property: Arg(0, "string"),
michael@0:       value: Arg(1, "json")
michael@0:     },
michael@0:     "style-applied" : {
michael@0:       type: "styleApplied"
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   /* List of original sources that generated this stylesheet */
michael@0:   _originalSources: null,
michael@0: 
michael@0:   toString: function() {
michael@0:     return "[StyleSheetActor " + this.actorID + "]";
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Window of target
michael@0:    */
michael@0:   get window() this._window || this.parentActor.window,
michael@0: 
michael@0:   /**
michael@0:    * Document of target.
michael@0:    */
michael@0:   get document() this.window.document,
michael@0: 
michael@0:   /**
michael@0:    * URL of underlying stylesheet.
michael@0:    */
michael@0:   get href() this.rawSheet.href,
michael@0: 
michael@0:   /**
michael@0:    * Retrieve the index (order) of stylesheet in the document.
michael@0:    *
michael@0:    * @return number
michael@0:    */
michael@0:   get styleSheetIndex()
michael@0:   {
michael@0:     if (this._styleSheetIndex == -1) {
michael@0:       for (let i = 0; i < this.document.styleSheets.length; i++) {
michael@0:         if (this.document.styleSheets[i] == this.rawSheet) {
michael@0:           this._styleSheetIndex = i;
michael@0:           break;
michael@0:         }
michael@0:       }
michael@0:     }
michael@0:     return this._styleSheetIndex;
michael@0:   },
michael@0: 
michael@0:   initialize: function(aStyleSheet, aParentActor, aWindow) {
michael@0:     protocol.Actor.prototype.initialize.call(this, null);
michael@0: 
michael@0:     this.rawSheet = aStyleSheet;
michael@0:     this.parentActor = aParentActor;
michael@0:     this.conn = this.parentActor.conn;
michael@0: 
michael@0:     this._window = aWindow;
michael@0: 
michael@0:     // text and index are unknown until source load
michael@0:     this.text = null;
michael@0:     this._styleSheetIndex = -1;
michael@0: 
michael@0:     this._transitionRefCount = 0;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Get the raw stylesheet's cssRules once the sheet has been loaded.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         Promise that resolves with a CSSRuleList
michael@0:    */
michael@0:   getCSSRules: function() {
michael@0:     let rules;
michael@0:     try {
michael@0:       rules = this.rawSheet.cssRules;
michael@0:     }
michael@0:     catch (e) {
michael@0:       // sheet isn't loaded yet
michael@0:     }
michael@0: 
michael@0:     if (rules) {
michael@0:       return promise.resolve(rules);
michael@0:     }
michael@0: 
michael@0:     let ownerNode = this.rawSheet.ownerNode;
michael@0:     if (!ownerNode) {
michael@0:       return promise.resolve([]);
michael@0:     }
michael@0: 
michael@0:     if (this._cssRules) {
michael@0:       return this._cssRules;
michael@0:     }
michael@0: 
michael@0:     let deferred = promise.defer();
michael@0: 
michael@0:     let onSheetLoaded = function(event) {
michael@0:       ownerNode.removeEventListener("load", onSheetLoaded, false);
michael@0: 
michael@0:       deferred.resolve(this.rawSheet.cssRules);
michael@0:     }.bind(this);
michael@0: 
michael@0:     ownerNode.addEventListener("load", onSheetLoaded, false);
michael@0: 
michael@0:     // cache so we don't add many listeners if this is called multiple times.
michael@0:     this._cssRules = deferred.promise;
michael@0: 
michael@0:     return this._cssRules;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Get the current state of the actor
michael@0:    *
michael@0:    * @return {object}
michael@0:    *         With properties of the underlying stylesheet, plus 'text',
michael@0:    *        'styleSheetIndex' and 'parentActor' if it's @imported
michael@0:    */
michael@0:   form: function(detail) {
michael@0:     if (detail === "actorid") {
michael@0:       return this.actorID;
michael@0:     }
michael@0: 
michael@0:     let docHref;
michael@0:     let ownerNode = this.rawSheet.ownerNode;
michael@0:     if (ownerNode) {
michael@0:       if (ownerNode instanceof Ci.nsIDOMHTMLDocument) {
michael@0:         docHref = ownerNode.location.href;
michael@0:       }
michael@0:       else if (ownerNode.ownerDocument && ownerNode.ownerDocument.location) {
michael@0:         docHref = ownerNode.ownerDocument.location.href;
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     let form = {
michael@0:       actor: this.actorID,  // actorID is set when this actor is added to a pool
michael@0:       href: this.href,
michael@0:       nodeHref: docHref,
michael@0:       disabled: this.rawSheet.disabled,
michael@0:       title: this.rawSheet.title,
michael@0:       system: !CssLogic.isContentStylesheet(this.rawSheet),
michael@0:       styleSheetIndex: this.styleSheetIndex
michael@0:     }
michael@0: 
michael@0:     try {
michael@0:       form.ruleCount = this.rawSheet.cssRules.length;
michael@0:     }
michael@0:     catch(e) {
michael@0:       // stylesheet had an @import rule that wasn't loaded yet
michael@0:       this.getCSSRules().then(() => {
michael@0:         this._notifyPropertyChanged("ruleCount");
michael@0:       });
michael@0:     }
michael@0:     return form;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Toggle the disabled property of the style sheet
michael@0:    *
michael@0:    * @return {object}
michael@0:    *         'disabled' - the disabled state after toggling.
michael@0:    */
michael@0:   toggleDisabled: method(function() {
michael@0:     this.rawSheet.disabled = !this.rawSheet.disabled;
michael@0:     this._notifyPropertyChanged("disabled");
michael@0: 
michael@0:     return this.rawSheet.disabled;
michael@0:   }, {
michael@0:     response: { disabled: RetVal("boolean")}
michael@0:   }),
michael@0: 
michael@0:   /**
michael@0:    * Send an event notifying that a property of the stylesheet
michael@0:    * has changed.
michael@0:    *
michael@0:    * @param  {string} property
michael@0:    *         Name of the changed property
michael@0:    */
michael@0:   _notifyPropertyChanged: function(property) {
michael@0:     events.emit(this, "property-change", property, this.form()[property]);
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Protocol method to get the text of this stylesheet.
michael@0:    */
michael@0:   getText: method(function() {
michael@0:     return this._getText().then((text) => {
michael@0:       return new LongStringActor(this.conn, text || "");
michael@0:     });
michael@0:   }, {
michael@0:     response: {
michael@0:       text: RetVal("longstring")
michael@0:     }
michael@0:   }),
michael@0: 
michael@0:   /**
michael@0:    * Fetch the text for this stylesheet from the cache or network. Return
michael@0:    * cached text if it's already been fetched.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         Promise that resolves with a string text of the stylesheet.
michael@0:    */
michael@0:   _getText: function() {
michael@0:     if (this.text) {
michael@0:       return promise.resolve(this.text);
michael@0:     }
michael@0: 
michael@0:     if (!this.href) {
michael@0:       // this is an inline <style> sheet
michael@0:       let content = this.rawSheet.ownerNode.textContent;
michael@0:       this.text = content;
michael@0:       return promise.resolve(content);
michael@0:     }
michael@0: 
michael@0:     let options = {
michael@0:       window: this.window,
michael@0:       charset: this._getCSSCharset()
michael@0:     };
michael@0: 
michael@0:     return fetch(this.href, options).then(({ content }) => {
michael@0:       this.text = content;
michael@0:       return content;
michael@0:     });
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Protocol method to get the original source (actors) for this
michael@0:    * stylesheet if it has uses source maps.
michael@0:    */
michael@0:   getOriginalSources: method(function() {
michael@0:     if (this._originalSources) {
michael@0:       return promise.resolve(this._originalSources);
michael@0:     }
michael@0:     return this._fetchOriginalSources();
michael@0:   }, {
michael@0:     request: {},
michael@0:     response: {
michael@0:       originalSources: RetVal("nullable:array:originalsource")
michael@0:     }
michael@0:   }),
michael@0: 
michael@0:   /**
michael@0:    * Fetch the original sources (actors) for this style sheet using its
michael@0:    * source map. If they've already been fetched, returns cached array.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         Promise that resolves with an array of OriginalSourceActors
michael@0:    */
michael@0:   _fetchOriginalSources: function() {
michael@0:     this._clearOriginalSources();
michael@0:     this._originalSources = [];
michael@0: 
michael@0:     return this.getSourceMap().then((sourceMap) => {
michael@0:       if (!sourceMap) {
michael@0:         return null;
michael@0:       }
michael@0:       for (let url of sourceMap.sources) {
michael@0:         let actor = new OriginalSourceActor(url, sourceMap, this);
michael@0: 
michael@0:         this.manage(actor);
michael@0:         this._originalSources.push(actor);
michael@0:       }
michael@0:       return this._originalSources;
michael@0:     })
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Get the SourceMapConsumer for this stylesheet's source map, if
michael@0:    * it exists. Saves the consumer for later queries.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         A promise that resolves with a SourceMapConsumer, or null.
michael@0:    */
michael@0:   getSourceMap: function() {
michael@0:     if (this._sourceMap) {
michael@0:       return this._sourceMap;
michael@0:     }
michael@0:     return this._fetchSourceMap();
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Fetch the source map for this stylesheet.
michael@0:    *
michael@0:    * @return {Promise}
michael@0:    *         A promise that resolves with a SourceMapConsumer, or null.
michael@0:    */
michael@0:   _fetchSourceMap: function() {
michael@0:     let deferred = promise.defer();
michael@0: 
michael@0:     this._getText().then((content) => {
michael@0:       let url = this._extractSourceMapUrl(content);
michael@0:       if (!url) {
michael@0:         // no source map for this stylesheet
michael@0:         deferred.resolve(null);
michael@0:         return;
michael@0:       };
michael@0: 
michael@0:       url = normalize(url, this.href);
michael@0: 
michael@0:       let map = fetch(url, { loadFromCache: false, window: this.window })
michael@0:         .then(({content}) => {
michael@0:           let map = new SourceMapConsumer(content);
michael@0:           this._setSourceMapRoot(map, url, this.href);
michael@0:           this._sourceMap = promise.resolve(map);
michael@0: 
michael@0:           deferred.resolve(map);
michael@0:           return map;
michael@0:         }, deferred.reject);
michael@0: 
michael@0:       this._sourceMap = map;
michael@0:     }, deferred.reject);
michael@0: 
michael@0:     return deferred.promise;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Clear and unmanage the original source actors for this stylesheet.
michael@0:    */
michael@0:   _clearOriginalSources: function() {
michael@0:     for (actor in this._originalSources) {
michael@0:       this.unmanage(actor);
michael@0:     }
michael@0:     this._originalSources = null;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Sets the source map's sourceRoot to be relative to the source map url.
michael@0:    */
michael@0:   _setSourceMapRoot: function(aSourceMap, aAbsSourceMapURL, aScriptURL) {
michael@0:     const base = dirname(
michael@0:       aAbsSourceMapURL.startsWith("data:")
michael@0:         ? aScriptURL
michael@0:         : aAbsSourceMapURL);
michael@0:     aSourceMap.sourceRoot = aSourceMap.sourceRoot
michael@0:       ? normalize(aSourceMap.sourceRoot, base)
michael@0:       : base;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Get the source map url specified in the text of a stylesheet.
michael@0:    *
michael@0:    * @param  {string} content
michael@0:    *         The text of the style sheet.
michael@0:    * @return {string}
michael@0:    *         Url of source map.
michael@0:    */
michael@0:   _extractSourceMapUrl: function(content) {
michael@0:     var matches = /sourceMappingURL\=([^\s\*]*)/.exec(content);
michael@0:     if (matches) {
michael@0:       return matches[1];
michael@0:     }
michael@0:     return null;
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Protocol method that gets the location in the original source of a
michael@0:    * line, column pair in this stylesheet, if its source mapped, otherwise
michael@0:    * a promise of the same location.
michael@0:    */
michael@0:   getOriginalLocation: method(function(line, column) {
michael@0:     return this.getSourceMap().then((sourceMap) => {
michael@0:       if (sourceMap) {
michael@0:         return sourceMap.originalPositionFor({ line: line, column: column });
michael@0:       }
michael@0:       return {
michael@0:         source: this.href,
michael@0:         line: line,
michael@0:         column: column
michael@0:       }
michael@0:     });
michael@0:   }, {
michael@0:     request: {
michael@0:       line: Arg(0, "number"),
michael@0:       column: Arg(1, "number")
michael@0:     },
michael@0:     response: RetVal(types.addDictType("originallocationresponse", {
michael@0:       source: "string",
michael@0:       line: "number",
michael@0:       column: "number"
michael@0:     }))
michael@0:   }),
michael@0: 
michael@0:   /**
michael@0:    * Get the charset of the stylesheet according to the character set rules
michael@0:    * defined in <http://www.w3.org/TR/CSS2/syndata.html#charset>.
michael@0:    *
michael@0:    * @param string channelCharset
michael@0:    *        Charset of the source string if set by the HTTP channel.
michael@0:    */
michael@0:   _getCSSCharset: function(channelCharset)
michael@0:   {
michael@0:     // StyleSheet's charset can be specified from multiple sources
michael@0:     if (channelCharset && channelCharset.length > 0) {
michael@0:       // step 1 of syndata.html: charset given in HTTP header.
michael@0:       return channelCharset;
michael@0:     }
michael@0: 
michael@0:     let sheet = this.rawSheet;
michael@0:     if (sheet) {
michael@0:       // Do we have a @charset rule in the stylesheet?
michael@0:       // step 2 of syndata.html (without the BOM check).
michael@0:       if (sheet.cssRules) {
michael@0:         let rules = sheet.cssRules;
michael@0:         if (rules.length
michael@0:             && rules.item(0).type == Ci.nsIDOMCSSRule.CHARSET_RULE) {
michael@0:           return rules.item(0).encoding;
michael@0:         }
michael@0:       }
michael@0: 
michael@0:       // step 3: charset attribute of <link> or <style> element, if it exists
michael@0:       if (sheet.ownerNode && sheet.ownerNode.getAttribute) {
michael@0:         let linkCharset = sheet.ownerNode.getAttribute("charset");
michael@0:         if (linkCharset != null) {
michael@0:           return linkCharset;
michael@0:         }
michael@0:       }
michael@0: 
michael@0:       // step 4 (1 of 2): charset of referring stylesheet.
michael@0:       let parentSheet = sheet.parentStyleSheet;
michael@0:       if (parentSheet && parentSheet.cssRules &&
michael@0:           parentSheet.cssRules[0].type == Ci.nsIDOMCSSRule.CHARSET_RULE) {
michael@0:         return parentSheet.cssRules[0].encoding;
michael@0:       }
michael@0: 
michael@0:       // step 4 (2 of 2): charset of referring document.
michael@0:       if (sheet.ownerNode && sheet.ownerNode.ownerDocument.characterSet) {
michael@0:         return sheet.ownerNode.ownerDocument.characterSet;
michael@0:       }
michael@0:     }
michael@0: 
michael@0:     // step 5: default to utf-8.
michael@0:     return "UTF-8";
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Update the style sheet in place with new text.
michael@0:    *
michael@0:    * @param  {object} request
michael@0:    *         'text' - new text
michael@0:    *         'transition' - whether to do CSS transition for change.
michael@0:    */
michael@0:   update: method(function(text, transition) {
michael@0:     DOMUtils.parseStyleSheet(this.rawSheet, text);
michael@0: 
michael@0:     this.text = text;
michael@0: 
michael@0:     this._notifyPropertyChanged("ruleCount");
michael@0: 
michael@0:     if (transition) {
michael@0:       this._insertTransistionRule();
michael@0:     }
michael@0:     else {
michael@0:       this._notifyStyleApplied();
michael@0:     }
michael@0:   }, {
michael@0:     request: {
michael@0:       text: Arg(0, "string"),
michael@0:       transition: Arg(1, "boolean")
michael@0:     }
michael@0:   }),
michael@0: 
michael@0:   /**
michael@0:    * Insert a catch-all transition rule into the document. Set a timeout
michael@0:    * to remove the rule after a certain time.
michael@0:    */
michael@0:   _insertTransistionRule: function() {
michael@0:     // Insert the global transition rule
michael@0:     // Use a ref count to make sure we do not add it multiple times.. and remove
michael@0:     // it only when all pending StyleSheets-generated transitions ended.
michael@0:     if (this._transitionRefCount == 0) {
michael@0:       this.rawSheet.insertRule(TRANSITION_RULE, this.rawSheet.cssRules.length);
michael@0:       this.document.documentElement.classList.add(TRANSITION_CLASS);
michael@0:     }
michael@0: 
michael@0:     this._transitionRefCount++;
michael@0: 
michael@0:     // Set up clean up and commit after transition duration (+buffer)
michael@0:     // @see _onTransitionEnd
michael@0:     this.window.setTimeout(this._onTransitionEnd.bind(this),
michael@0:                            TRANSITION_DURATION_MS + TRANSITION_BUFFER_MS);
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * This cleans up class and rule added for transition effect and then
michael@0:    * notifies that the style has been applied.
michael@0:    */
michael@0:   _onTransitionEnd: function()
michael@0:   {
michael@0:     if (--this._transitionRefCount == 0) {
michael@0:       this.document.documentElement.classList.remove(TRANSITION_CLASS);
michael@0:       this.rawSheet.deleteRule(this.rawSheet.cssRules.length - 1);
michael@0:     }
michael@0: 
michael@0:     events.emit(this, "style-applied");
michael@0:   }
michael@0: })
michael@0: 
michael@0: /**
michael@0:  * StyleSheetFront is the client-side counterpart to a StyleSheetActor.
michael@0:  */
michael@0: var StyleSheetFront = protocol.FrontClass(StyleSheetActor, {
michael@0:   initialize: function(conn, form) {
michael@0:     protocol.Front.prototype.initialize.call(this, conn, form);
michael@0: 
michael@0:     this._onPropertyChange = this._onPropertyChange.bind(this);
michael@0:     events.on(this, "property-change", this._onPropertyChange);
michael@0:   },
michael@0: 
michael@0:   destroy: function() {
michael@0:     events.off(this, "property-change", this._onPropertyChange);
michael@0: 
michael@0:     protocol.Front.prototype.destroy.call(this);
michael@0:   },
michael@0: 
michael@0:   _onPropertyChange: function(property, value) {
michael@0:     this._form[property] = value;
michael@0:   },
michael@0: 
michael@0:   form: function(form, detail) {
michael@0:     if (detail === "actorid") {
michael@0:       this.actorID = form;
michael@0:       return;
michael@0:     }
michael@0:     this.actorID = form.actor;
michael@0:     this._form = form;
michael@0:   },
michael@0: 
michael@0:   get href() this._form.href,
michael@0:   get nodeHref() this._form.nodeHref,
michael@0:   get disabled() !!this._form.disabled,
michael@0:   get title() this._form.title,
michael@0:   get isSystem() this._form.system,
michael@0:   get styleSheetIndex() this._form.styleSheetIndex,
michael@0:   get ruleCount() this._form.ruleCount
michael@0: });
michael@0: 
michael@0: /**
michael@0:  * Actor representing an original source of a style sheet that was specified
michael@0:  * in a source map.
michael@0:  */
michael@0: let OriginalSourceActor = protocol.ActorClass({
michael@0:   typeName: "originalsource",
michael@0: 
michael@0:   initialize: function(aUrl, aSourceMap, aParentActor) {
michael@0:     protocol.Actor.prototype.initialize.call(this, null);
michael@0: 
michael@0:     this.url = aUrl;
michael@0:     this.sourceMap = aSourceMap;
michael@0:     this.parentActor = aParentActor;
michael@0:     this.conn = this.parentActor.conn;
michael@0: 
michael@0:     this.text = null;
michael@0:   },
michael@0: 
michael@0:   form: function() {
michael@0:     return {
michael@0:       actor: this.actorID, // actorID is set when it's added to a pool
michael@0:       url: this.url,
michael@0:       relatedStyleSheet: this.parentActor.form()
michael@0:     };
michael@0:   },
michael@0: 
michael@0:   _getText: function() {
michael@0:     if (this.text) {
michael@0:       return promise.resolve(this.text);
michael@0:     }
michael@0:     let content = this.sourceMap.sourceContentFor(this.url);
michael@0:     if (content) {
michael@0:       this.text = content;
michael@0:       return promise.resolve(content);
michael@0:     }
michael@0:     return fetch(this.url, { window: this.window }).then(({content}) => {
michael@0:       this.text = content;
michael@0:       return content;
michael@0:     });
michael@0:   },
michael@0: 
michael@0:   /**
michael@0:    * Protocol method to get the text of this source.
michael@0:    */
michael@0:   getText: method(function() {
michael@0:     return this._getText().then((text) => {
michael@0:       return new LongStringActor(this.conn, text || "");
michael@0:     });
michael@0:   }, {
michael@0:     response: {
michael@0:       text: RetVal("longstring")
michael@0:     }
michael@0:   })
michael@0: })
michael@0: 
michael@0: /**
michael@0:  * The client-side counterpart for an OriginalSourceActor.
michael@0:  */
michael@0: let OriginalSourceFront = protocol.FrontClass(OriginalSourceActor, {
michael@0:   initialize: function(client, form) {
michael@0:     protocol.Front.prototype.initialize.call(this, client, form);
michael@0: 
michael@0:     this.isOriginalSource = true;
michael@0:   },
michael@0: 
michael@0:   form: function(form, detail) {
michael@0:     if (detail === "actorid") {
michael@0:       this.actorID = form;
michael@0:       return;
michael@0:     }
michael@0:     this.actorID = form.actor;
michael@0:     this._form = form;
michael@0:   },
michael@0: 
michael@0:   get href() this._form.url,
michael@0:   get url() this._form.url
michael@0: });
michael@0: 
michael@0: 
michael@0: XPCOMUtils.defineLazyGetter(this, "DOMUtils", function () {
michael@0:   return Cc["@mozilla.org/inspector/dom-utils;1"].getService(Ci.inIDOMUtils);
michael@0: });
michael@0: 
michael@0: exports.StyleSheetsActor = StyleSheetsActor;
michael@0: exports.StyleSheetsFront = StyleSheetsFront;
michael@0: 
michael@0: exports.StyleSheetActor = StyleSheetActor;
michael@0: exports.StyleSheetFront = StyleSheetFront;
michael@0: 
michael@0: 
michael@0: /**
michael@0:  * Performs a request to load the desired URL and returns a promise.
michael@0:  *
michael@0:  * @param aURL String
michael@0:  *        The URL we will request.
michael@0:  * @returns Promise
michael@0:  *        A promise of the document at that URL, as a string.
michael@0:  */
michael@0: function fetch(aURL, aOptions={ loadFromCache: true, window: null,
michael@0:                                 charset: null}) {
michael@0:   let deferred = promise.defer();
michael@0:   let scheme;
michael@0:   let url = aURL.split(" -> ").pop();
michael@0:   let charset;
michael@0:   let contentType;
michael@0: 
michael@0:   try {
michael@0:     scheme = Services.io.extractScheme(url);
michael@0:   } catch (e) {
michael@0:     // In the xpcshell tests, the script url is the absolute path of the test
michael@0:     // file, which will make a malformed URI error be thrown. Add the file
michael@0:     // scheme prefix ourselves.
michael@0:     url = "file://" + url;
michael@0:     scheme = Services.io.extractScheme(url);
michael@0:   }
michael@0: 
michael@0:   switch (scheme) {
michael@0:     case "file":
michael@0:     case "chrome":
michael@0:     case "resource":
michael@0:       try {
michael@0:         NetUtil.asyncFetch(url, function onFetch(aStream, aStatus, aRequest) {
michael@0:           if (!components.isSuccessCode(aStatus)) {
michael@0:             deferred.reject(new Error("Request failed with status code = "
michael@0:                                       + aStatus
michael@0:                                       + " after NetUtil.asyncFetch for url = "
michael@0:                                       + url));
michael@0:             return;
michael@0:           }
michael@0: 
michael@0:           let source = NetUtil.readInputStreamToString(aStream, aStream.available());
michael@0:           contentType = aRequest.contentType;
michael@0:           deferred.resolve(source);
michael@0:           aStream.close();
michael@0:         });
michael@0:       } catch (ex) {
michael@0:         deferred.reject(ex);
michael@0:       }
michael@0:       break;
michael@0: 
michael@0:     default:
michael@0:       let channel;
michael@0:       try {
michael@0:         channel = Services.io.newChannel(url, null, null);
michael@0:       } catch (e if e.name == "NS_ERROR_UNKNOWN_PROTOCOL") {
michael@0:         // On Windows xpcshell tests, c:/foo/bar can pass as a valid URL, but
michael@0:         // newChannel won't be able to handle it.
michael@0:         url = "file:///" + url;
michael@0:         channel = Services.io.newChannel(url, null, null);
michael@0:       }
michael@0:       let chunks = [];
michael@0:       let streamListener = {
michael@0:         onStartRequest: function(aRequest, aContext, aStatusCode) {
michael@0:           if (!components.isSuccessCode(aStatusCode)) {
michael@0:             deferred.reject(new Error("Request failed with status code = "
michael@0:                                       + aStatusCode
michael@0:                                       + " in onStartRequest handler for url = "
michael@0:                                       + url));
michael@0:           }
michael@0:         },
michael@0:         onDataAvailable: function(aRequest, aContext, aStream, aOffset, aCount) {
michael@0:           chunks.push(NetUtil.readInputStreamToString(aStream, aCount));
michael@0:         },
michael@0:         onStopRequest: function(aRequest, aContext, aStatusCode) {
michael@0:           if (!components.isSuccessCode(aStatusCode)) {
michael@0:             deferred.reject(new Error("Request failed with status code = "
michael@0:                                       + aStatusCode
michael@0:                                       + " in onStopRequest handler for url = "
michael@0:                                       + url));
michael@0:             return;
michael@0:           }
michael@0: 
michael@0:           charset = channel.contentCharset || charset;
michael@0:           contentType = channel.contentType;
michael@0:           deferred.resolve(chunks.join(""));
michael@0:         }
michael@0:       };
michael@0: 
michael@0:       if (aOptions.window) {
michael@0:         // respect private browsing
michael@0:         channel.loadGroup = aOptions.window.QueryInterface(Ci.nsIInterfaceRequestor)
michael@0:                               .getInterface(Ci.nsIWebNavigation)
michael@0:                               .QueryInterface(Ci.nsIDocumentLoader)
michael@0:                               .loadGroup;
michael@0:       }
michael@0:       channel.loadFlags = aOptions.loadFromCache
michael@0:         ? channel.LOAD_FROM_CACHE
michael@0:         : channel.LOAD_BYPASS_CACHE;
michael@0:       channel.asyncOpen(streamListener, null);
michael@0:       break;
michael@0:   }
michael@0: 
michael@0:   return deferred.promise.then(source => {
michael@0:     return {
michael@0:       content: convertToUnicode(source, charset),
michael@0:       contentType: contentType
michael@0:     };
michael@0:   });
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Convert a given string, encoded in a given character set, to unicode.
michael@0:  *
michael@0:  * @param string aString
michael@0:  *        A string.
michael@0:  * @param string aCharset
michael@0:  *        A character set.
michael@0:  */
michael@0: function convertToUnicode(aString, aCharset=null) {
michael@0:   // Decoding primitives.
michael@0:   let converter = Cc["@mozilla.org/intl/scriptableunicodeconverter"]
michael@0:     .createInstance(Ci.nsIScriptableUnicodeConverter);
michael@0:   try {
michael@0:     converter.charset = aCharset || "UTF-8";
michael@0:     return converter.ConvertToUnicode(aString);
michael@0:   } catch(e) {
michael@0:     return aString;
michael@0:   }
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Normalize multiple relative paths towards the base paths on the right.
michael@0:  */
michael@0: function normalize(...aURLs) {
michael@0:   let base = Services.io.newURI(aURLs.pop(), null, null);
michael@0:   let url;
michael@0:   while ((url = aURLs.pop())) {
michael@0:     base = Services.io.newURI(url, null, base);
michael@0:   }
michael@0:   return base.spec;
michael@0: }
michael@0: 
michael@0: function dirname(aPath) {
michael@0:   return Services.io.newURI(
michael@0:     ".", null, Services.io.newURI(aPath, null, null)).spec;
michael@0: }