/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1999 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ /* loading of CSS style sheets using the network APIs */ #ifndef nsICSSLoader_h___ #define nsICSSLoader_h___ #include "nsIPrincipal.h" #include "nsAString.h" #include "nsAutoPtr.h" #include "nsCompatibility.h" #include "nsDataHashtable.h" #include "nsInterfaceHashtable.h" #include "nsTArray.h" #include "nsTObserverArray.h" #include "nsURIHashKey.h" class nsIAtom; class nsICSSImportRule; class nsICSSLoaderObserver; class nsICSSStyleSheet; class nsIContent; class nsIDocument; class nsIUnicharInputStream; class nsCSSParser; class nsMediaList; class nsPresContext; namespace mozilla { class URIAndPrincipalHashKey : public nsURIHashKey { public: typedef URIAndPrincipalHashKey* KeyType; typedef const URIAndPrincipalHashKey* KeyTypePointer; URIAndPrincipalHashKey(const URIAndPrincipalHashKey* aKey) : nsURIHashKey(aKey->mKey), mPrincipal(aKey->mPrincipal) { MOZ_COUNT_CTOR(URIAndPrincipalHashKey); } URIAndPrincipalHashKey(nsIURI* aURI, nsIPrincipal* aPrincipal) : nsURIHashKey(aURI), mPrincipal(aPrincipal) { MOZ_COUNT_CTOR(URIAndPrincipalHashKey); } URIAndPrincipalHashKey(const URIAndPrincipalHashKey& toCopy) : nsURIHashKey(toCopy), mPrincipal(toCopy.mPrincipal) { MOZ_COUNT_CTOR(URIAndPrincipalHashKey); } ~URIAndPrincipalHashKey() { MOZ_COUNT_DTOR(URIAndPrincipalHashKey); } URIAndPrincipalHashKey* GetKey() const { return const_cast(this); } const URIAndPrincipalHashKey* GetKeyPointer() const { return this; } PRBool KeyEquals(const URIAndPrincipalHashKey* aKey) const { if (!nsURIHashKey::KeyEquals(aKey->mKey)) { return PR_FALSE; } if (!mPrincipal != !aKey->mPrincipal) { // One or the other has a principal, but not both... not equal return PR_FALSE; } PRBool eq; return !mPrincipal || (NS_SUCCEEDED(mPrincipal->Equals(aKey->mPrincipal, &eq)) && eq); } static const URIAndPrincipalHashKey* KeyToPointer(URIAndPrincipalHashKey* aKey) { return aKey; } static PLDHashNumber HashKey(const URIAndPrincipalHashKey* aKey) { return nsURIHashKey::HashKey(aKey->mKey); } enum { ALLOW_MEMMOVE = PR_TRUE }; protected: nsCOMPtr mPrincipal; }; namespace css { class SheetLoadData; /*********************************************************************** * Enum that describes the state of the sheet returned by CreateSheet. * ***********************************************************************/ enum StyleSheetState { eSheetStateUnknown = 0, eSheetNeedsParser, eSheetPending, eSheetLoading, eSheetComplete }; class Loader { public: Loader(); Loader(nsIDocument*); ~Loader(); // This isn't a COM class but it's reference-counted like one. NS_IMETHOD_(nsrefcnt) AddRef(); NS_IMETHOD_(nsrefcnt) Release(); void DropDocumentReference(); // notification that doc is going away void SetCompatibilityMode(nsCompatibility aCompatMode) { mCompatMode = aCompatMode; } nsCompatibility GetCompatibilityMode() { return mCompatMode; } nsresult SetPreferredSheet(const nsAString& aTitle); nsresult GetPreferredSheet(nsAString& aTitle); // XXXbz sort out what the deal is with events! When should they fire? /** * Load an inline style sheet. If a successful result is returned and * *aCompleted is false, then aObserver is guaranteed to be notified * asynchronously once the sheet is marked complete. If an error is * returned, or if *aCompleted is true, aObserver will not be notified. In * addition to parsing the sheet, this method will insert it into the * stylesheet list of this CSSLoader's document. * * @param aElement the element linking to the stylesheet. This must not be * null and must implement nsIStyleSheetLinkingElement. * @param aStream the character stream that holds the stylesheet data. * @param aLineNumber the line number at which the stylesheet data started. * @param aTitle the title of the sheet. * @param aMedia the media string for the sheet. * @param aObserver the observer to notify when the load completes. * May be null. * @param [out] aCompleted whether parsing of the sheet completed. * @param [out] aIsAlternate whether the stylesheet ended up being an * alternate sheet. */ nsresult LoadInlineStyle(nsIContent* aElement, nsIUnicharInputStream* aStream, PRUint32 aLineNumber, const nsAString& aTitle, const nsAString& aMedia, nsICSSLoaderObserver* aObserver, PRBool* aCompleted, PRBool* aIsAlternate); /** * Load a linked (document) stylesheet. If a successful result is returned, * aObserver is guaranteed to be notified asynchronously once the sheet is * loaded and marked complete. If an error is returned, aObserver will not * be notified. In addition to loading the sheet, this method will insert it * into the stylesheet list of this CSSLoader's document. * * @param aElement the element linking to the the stylesheet. May be null. * @param aURL the URL of the sheet. * @param aTitle the title of the sheet. * @param aMedia the media string for the sheet. * @param aHasAlternateRel whether the rel for this link included * "alternate". * @param aObserver the observer to notify when the load completes. * May be null. * @param [out] aIsAlternate whether the stylesheet actually ended up beinga * an alternate sheet. Note that this need not match * aHasAlternateRel. */ nsresult LoadStyleLink(nsIContent* aElement, nsIURI* aURL, const nsAString& aTitle, const nsAString& aMedia, PRBool aHasAlternateRel, nsICSSLoaderObserver* aObserver, PRBool* aIsAlternate); /** * Load a child (@import-ed) style sheet. In addition to loading the sheet, * this method will insert it into the child sheet list of aParentSheet. If * there is no sheet currently being parsed and the child sheet is not * complete when this method returns, then when the child sheet becomes * complete aParentSheet will be QIed to nsICSSLoaderObserver and * asynchronously notified, just like for LoadStyleLink. Note that if the * child sheet is already complete when this method returns, no * nsICSSLoaderObserver notification will be sent. * * @param aParentSheet the parent of this child sheet * @param aURL the URL of the child sheet * @param aMedia the already-parsed media list for the child sheet * @param aRule the @import rule importing this child. This is used to * properly order the child sheet list of aParentSheet. */ nsresult LoadChildSheet(nsICSSStyleSheet* aParentSheet, nsIURI* aURL, nsMediaList* aMedia, nsICSSImportRule* aRule); /** * Synchronously load and return the stylesheet at aURL. Any child sheets * will also be loaded synchronously. Note that synchronous loads over some * protocols may involve spinning up a new event loop, so use of this method * does NOT guarantee not receiving any events before the sheet loads. This * method can be used to load sheets not associated with a document. * * @param aURL the URL of the sheet to load * @param aEnableUnsafeRules whether unsafe rules are enabled for this * sheet load * Unsafe rules are rules that can violate key Gecko invariants if misused. * In particular, most anonymous box pseudoelements must be very carefully * styled or we will have severe problems. Therefore unsafe rules should * never be enabled for stylesheets controlled by untrusted sites; preferably * unsafe rules should only be enabled for agent sheets. * @param aUseSystemPrincipal if true, give the resulting sheet the system * principal no matter where it's being loaded from. * @param [out] aSheet the loaded, complete sheet. * * NOTE: At the moment, this method assumes the sheet will be UTF-8, but * ideally it would allow arbitrary encodings. Callers should NOT depend on * non-UTF8 sheets being treated as UTF-8 by this method. * * NOTE: A successful return from this method doesn't indicate anything about * whether the data could be parsed as CSS and doesn't indicate anything * about the status of child sheets of the returned sheet. */ nsresult LoadSheetSync(nsIURI* aURL, PRBool aEnableUnsafeRules, PRBool aUseSystemPrincipal, nsICSSStyleSheet** aSheet); /** * As above, but aUseSystemPrincipal and aEnableUnsafeRules are assumed false. */ nsresult LoadSheetSync(nsIURI* aURL, nsICSSStyleSheet** aSheet) { return LoadSheetSync(aURL, PR_FALSE, PR_FALSE, aSheet); } /** * Asynchronously load the stylesheet at aURL. If a successful result is * returned, aObserver is guaranteed to be notified asynchronously once the * sheet is loaded and marked complete. This method can be used to load * sheets not associated with a document. * * @param aURL the URL of the sheet to load * @param aOriginPrincipal the principal to use for security checks. This * can be null to indicate that these checks should * be skipped. * @param aCharset the encoding to use for converting the sheet data * from bytes to Unicode. May be empty to indicate that the * charset of the CSSLoader's document should be used. This * is only used if neither the network transport nor the * sheet itself indicate an encoding. * @param aObserver the observer to notify when the load completes. * Must not be null. * @param [out] aSheet the sheet to load. Note that the sheet may well * not be loaded by the time this method returns. */ nsresult LoadSheet(nsIURI* aURL, nsIPrincipal* aOriginPrincipal, const nsCString& aCharset, nsICSSLoaderObserver* aObserver, nsICSSStyleSheet** aSheet); /** * Same as above, to be used when the caller doesn't care about the * not-yet-loaded sheet. */ nsresult LoadSheet(nsIURI* aURL, nsIPrincipal* aOriginPrincipal, const nsCString& aCharset, nsICSSLoaderObserver* aObserver); /** * Stop loading all sheets. All nsICSSLoaderObservers involved will be * notified with NS_BINDING_ABORTED as the status, possibly synchronously. */ nsresult Stop(void); /** * Stop loading one sheet. The nsICSSLoaderObserver involved will be * notified with NS_BINDING_ABORTED as the status, possibly synchronously. */ nsresult StopLoadingSheet(nsIURI* aURL); /** * Whether the loader is enabled or not. * When disabled, processing of new styles is disabled and an attempt * to do so will fail with a return code of * NS_ERROR_NOT_AVAILABLE. Note that this DOES NOT disable * currently loading styles or already processed styles. */ PRBool GetEnabled() { return mEnabled; } void SetEnabled(PRBool aEnabled) { mEnabled = aEnabled; } /** * Return true if this loader has pending loads (ones that would send * notifications to an nsICSSLoaderObserver attached to this loader). * If called from inside nsICSSLoaderObserver::StyleSheetLoaded, this will * return PR_FALSE if and only if that is the last StyleSheetLoaded * notification the CSSLoader knows it's going to send. In other words, if * two sheets load at once (via load coalescing, e.g.), HasPendingLoads() * will return PR_TRUE during notification for the first one, and PR_FALSE * during notification for the second one. */ PRBool HasPendingLoads(); /** * Add an observer to this loader. The observer will be notified * for all loads that would have notified their own observers (even * if those loads don't have observers attached to them). * Load-specific observers will be notified before generic * observers. The loader holds a reference to the observer. * * aObserver must not be null. */ nsresult AddObserver(nsICSSLoaderObserver* aObserver); /** * Remove an observer added via AddObserver. */ void RemoveObserver(nsICSSLoaderObserver* aObserver); // These interfaces are public only for the benefit of static functions // within nsCSSLoader.cpp. // IsAlternate can change our currently selected style set if none // is selected and aHasAlternateRel is false. PRBool IsAlternate(const nsAString& aTitle, PRBool aHasAlternateRel); typedef nsTArray > LoadDataArray; private: friend class SheetLoadData; // Note: null aSourcePrincipal indicates that the content policy and // CheckLoadURI checks should be skipped. nsresult CheckLoadAllowed(nsIPrincipal* aSourcePrincipal, nsIURI* aTargetURI, nsISupports* aContext); // For inline style, the aURI param is null, but the aLinkingContent // must be non-null then. The loader principal must never be null // if aURI is not null. nsresult CreateSheet(nsIURI* aURI, nsIContent* aLinkingContent, nsIPrincipal* aLoaderPrincipal, PRBool aSyncLoad, StyleSheetState& aSheetState, nsICSSStyleSheet** aSheet); // Pass in either a media string or the nsMediaList from the // CSSParser. Don't pass both. // If aIsAlternate is non-null, this method will set *aIsAlternate to // correspond to the sheet's enabled state (which it will set no matter what) nsresult PrepareSheet(nsICSSStyleSheet* aSheet, const nsAString& aTitle, const nsAString& aMediaString, nsMediaList* aMediaList, PRBool aHasAlternateRel = PR_FALSE, PRBool *aIsAlternate = nsnull); nsresult InsertSheetInDoc(nsICSSStyleSheet* aSheet, nsIContent* aLinkingContent, nsIDocument* aDocument); nsresult InsertChildSheet(nsICSSStyleSheet* aSheet, nsICSSStyleSheet* aParentSheet, nsICSSImportRule* aParentRule); nsresult InternalLoadNonDocumentSheet(nsIURI* aURL, PRBool aAllowUnsafeRules, PRBool aUseSystemPrincipal, nsIPrincipal* aOriginPrincipal, const nsCString& aCharset, nsICSSStyleSheet** aSheet, nsICSSLoaderObserver* aObserver); // Post a load event for aObserver to be notified about aSheet. The // notification will be sent with status NS_OK unless the load event is // canceled at some point (in which case it will be sent with // NS_BINDING_ABORTED). aWasAlternate indicates the state when the load was // initiated, not the state at some later time. aURI should be the URI the // sheet was loaded from (may be null for inline sheets). nsresult PostLoadEvent(nsIURI* aURI, nsICSSStyleSheet* aSheet, nsICSSLoaderObserver* aObserver, PRBool aWasAlternate); // Start the loads of all the sheets in mPendingDatas void StartAlternateLoads(); // Handle an event posted by PostLoadEvent void HandleLoadEvent(SheetLoadData* aEvent); // Note: LoadSheet is responsible for releasing aLoadData and setting the // sheet to complete on failure. nsresult LoadSheet(SheetLoadData* aLoadData, StyleSheetState aSheetState); // Parse the stylesheet in aLoadData. The sheet data comes from aStream. // Set aCompleted to true if the parse finished, false otherwise (e.g. if the // sheet had an @import). If aCompleted is true when this returns, then // ParseSheet also called SheetComplete on aLoadData nsresult ParseSheet(nsIUnicharInputStream* aStream, SheetLoadData* aLoadData, PRBool& aCompleted); // The load of the sheet in aLoadData is done, one way or another. Do final // cleanup, including releasing aLoadData. void SheetComplete(SheetLoadData* aLoadData, nsresult aStatus); // The guts of SheetComplete. This may be called recursively on parent datas // or datas that had glommed on to a single load. The array is there so load // datas whose observers need to be notified can be added to it. void DoSheetComplete(SheetLoadData* aLoadData, nsresult aStatus, LoadDataArray& aDatasToNotify); nsInterfaceHashtable mCompleteSheets; nsDataHashtable mLoadingDatas; // weak refs nsDataHashtable mPendingDatas; // weak refs // We're not likely to have many levels of @import... But likely to have // some. Allocate some storage, what the hell. nsAutoTArray mParsingDatas; // The array of posted stylesheet loaded events (SheetLoadDatas) we have. // Note that these are rare. LoadDataArray mPostedEvents; // Our array of "global" observers nsTObserverArray > mObservers; // the load data needs access to the document... nsIDocument* mDocument; // the document we live for // Refcounting nsAutoRefCnt mRefCnt; NS_DECL_OWNINGTHREAD // Number of datas still waiting to be notified on if we're notifying on a // whole bunch at once (e.g. in one of the stop methods). This is used to // make sure that HasPendingLoads() won't return false until we're notifying // on the last data we're working with. PRUint32 mDatasToNotifyOn; nsCompatibility mCompatMode; nsString mPreferredSheet; // title of preferred sheet PRPackedBool mEnabled; // is enabled to load new styles #ifdef DEBUG PRPackedBool mSyncCallback; #endif }; } // namespace css } // namespace mozilla #endif /* nsICSSLoader_h___ */