/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #ifndef mozilla_dom_ScriptLoader_h #define mozilla_dom_ScriptLoader_h #include "nsCOMPtr.h" #include "nsRefPtrHashtable.h" #include "nsIUnicodeDecoder.h" #include "nsIScriptElement.h" #include "nsCOMArray.h" #include "nsCycleCollectionParticipant.h" #include "nsTArray.h" #include "nsAutoPtr.h" #include "nsIDocument.h" #include "nsIIncrementalStreamLoader.h" #include "nsURIHashKey.h" #include "mozilla/CORSMode.h" #include "mozilla/dom/SRIMetadata.h" #include "mozilla/dom/SRICheck.h" #include "mozilla/MozPromise.h" #include "mozilla/net/ReferrerPolicy.h" #include "mozilla/Vector.h" class nsIURI; namespace JS { class SourceBufferHolder; } // namespace JS namespace mozilla { namespace dom { class AutoJSAPI; class LoadedScript; class ModuleLoadRequest; class ModuleScript; class ScriptLoadRequestList; ////////////////////////////////////////////////////////////// // Per-request data structure ////////////////////////////////////////////////////////////// enum class ScriptKind { Classic, Module }; /* * Some options used when fetching script resources. This only loosely * corresponds to HTML's "script fetch options". * * These are common to all modules in a module graph, and hence a single * instance is shared by all ModuleLoadRequest objects in a graph. */ class ScriptFetchOptions { ~ScriptFetchOptions(); public: NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(ScriptFetchOptions) NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(ScriptFetchOptions) ScriptFetchOptions(mozilla::CORSMode aCORSMode, mozilla::net::ReferrerPolicy aReferrerPolicy, nsIScriptElement* aElement, nsIPrincipal* aTriggeringPrincipal); const mozilla::CORSMode mCORSMode; const mozilla::net::ReferrerPolicy mReferrerPolicy; bool mIsPreload; nsCOMPtr mElement; nsCOMPtr mTriggeringPrincipal; }; class ScriptLoadRequest : public nsISupports, private mozilla::LinkedListElement { typedef LinkedListElement super; // Allow LinkedListElement to cast us to itself as needed. friend class mozilla::LinkedListElement; friend class ScriptLoadRequestList; protected: virtual ~ScriptLoadRequest(); public: ScriptLoadRequest(ScriptKind aKind, nsIURI* aURI, ScriptFetchOptions* aFetchOptions, const SRIMetadata& aIntegrity, nsIURI* aReferrer); NS_DECL_CYCLE_COLLECTING_ISUPPORTS NS_DECL_CYCLE_COLLECTION_CLASS(ScriptLoadRequest) bool IsModuleRequest() const { return mKind == ScriptKind::Module; } ModuleLoadRequest* AsModuleRequest(); void FireScriptAvailable(nsresult aResult) { bool isInlineClassicScript = mIsInline && !IsModuleRequest(); Element()->ScriptAvailable(aResult, Element(), isInlineClassicScript, mURI, mLineNo); } void FireScriptEvaluated(nsresult aResult) { Element()->ScriptEvaluated(aResult, Element(), mIsInline); } bool IsPreload() const { MOZ_ASSERT_IF(mFetchOptions->mIsPreload, !Element()); return mFetchOptions->mIsPreload; } virtual void Cancel(); bool IsCanceled() const { return mIsCanceled; } virtual void SetReady(); void** OffThreadTokenPtr() { return mOffThreadToken ? &mOffThreadToken : nullptr; } enum class Progress { Loading, Compiling, FetchingImports, Ready }; bool IsReadyToRun() const { return mProgress == Progress::Ready; } bool IsLoading() const { return mProgress == Progress::Loading; } bool InCompilingStage() const { return mProgress == Progress::Compiling || (IsReadyToRun() && mWasCompiledOMT); } enum class ScriptMode : uint8_t { eBlocking, eDeferred, eAsync }; void SetScriptMode(bool aDeferAttr, bool aAsyncAttr); bool IsBlockingScript() const { return mScriptMode == ScriptMode::eBlocking; } bool IsDeferredScript() const { return mScriptMode == ScriptMode::eDeferred; } bool IsAsyncScript() const { return mScriptMode == ScriptMode::eAsync; } virtual bool IsTopLevel() const { // Classic scripts are always top level. return true; } mozilla::CORSMode CORSMode() const { return mFetchOptions->mCORSMode; } mozilla::net::ReferrerPolicy ReferrerPolicy() const { return mFetchOptions->mReferrerPolicy; } nsIScriptElement* Element() const { return mFetchOptions->mElement; } nsIPrincipal* TriggeringPrincipal() const { return mFetchOptions->mTriggeringPrincipal; } // Make this request a preload (speculative) request. void SetIsPreloadRequest() { MOZ_ASSERT(!Element()); MOZ_ASSERT(!IsPreload()); mFetchOptions->mIsPreload = true; } // Make a preload request into an actual load request for the given element. void SetIsLoadRequest(nsIScriptElement* aElement) { MOZ_ASSERT(aElement); MOZ_ASSERT(!Element()); MOZ_ASSERT(IsPreload()); mFetchOptions->mElement = aElement; mFetchOptions->mIsPreload = false; } FromParser GetParserCreated() const { nsIScriptElement* element = Element(); if (!element) { return NOT_FROM_PARSER; } return element->GetParserCreated(); } void SetScript(JSScript* aScript); void MaybeCancelOffThreadScript(); using super::getNext; using super::isInList; const ScriptKind mKind; // Whether this is a classic script or a module script. ScriptMode mScriptMode; // Whether this is a blocking, defer or async script. Progress mProgress; // Are we still waiting for a load to complete? bool mScriptFromHead; // Synchronous head script block loading of other non js/css content. bool mIsInline; // Is the script inline or loaded? bool mHasSourceMapURL; // Does the HTTP header have a source map url? bool mInDeferList; // True if we live in mDeferRequests. bool mInAsyncList; // True if we live in mLoadingAsyncRequests or mLoadedAsyncRequests. bool mIsNonAsyncScriptInserted; // True if we live in mNonAsyncExternalScriptInsertedRequests bool mIsXSLT; // True if we live in mXSLTRequests. bool mIsCanceled; // True if we have been explicitly canceled. bool mWasCompiledOMT; // True if the script has been compiled off main thread. void* mOffThreadToken; // Off-thread parsing token. nsString mSourceMapURL; // Holds source map url for loaded scripts char16_t* mScriptTextBuf; // Holds script text for non-inline scripts. Don't size_t mScriptTextLength; // use nsString so we can give ownership to jsapi. const nsCOMPtr mURI; nsCOMPtr mOriginPrincipal; nsAutoCString mURL; // Keep the URI's filename alive during off thread parsing. int32_t mLineNo; const SRIMetadata mIntegrity; const nsCOMPtr mReferrer; RefPtr mFetchOptions; // Holds the top-level JSScript that corresponds to the current source, once // it is parsed, and planned to be saved in the bytecode cache. JS::Heap mScript; // The base URL used for resolving relative module imports. nsCOMPtr mBaseURL; }; class ScriptLoadRequestList : private mozilla::LinkedList { typedef mozilla::LinkedList super; public: ~ScriptLoadRequestList(); void Clear(); #ifdef DEBUG bool Contains(ScriptLoadRequest* aElem) const; #endif // DEBUG using super::getFirst; using super::isEmpty; void AppendElement(ScriptLoadRequest* aElem) { MOZ_ASSERT(!aElem->isInList()); NS_ADDREF(aElem); insertBack(aElem); } MOZ_MUST_USE already_AddRefed Steal(ScriptLoadRequest* aElem) { aElem->removeFrom(*this); return dont_AddRef(aElem); } MOZ_MUST_USE already_AddRefed StealFirst() { MOZ_ASSERT(!isEmpty()); return Steal(getFirst()); } void Remove(ScriptLoadRequest* aElem) { aElem->removeFrom(*this); NS_RELEASE(aElem); } }; class ScriptLoadHandler; ////////////////////////////////////////////////////////////// // Script loader implementation ////////////////////////////////////////////////////////////// class ScriptLoader final : public nsISupports { class MOZ_STACK_CLASS AutoCurrentScriptUpdater { public: AutoCurrentScriptUpdater(ScriptLoader* aScriptLoader, nsIScriptElement* aCurrentScript) : mOldScript(aScriptLoader->mCurrentScript) , mScriptLoader(aScriptLoader) { mScriptLoader->mCurrentScript = aCurrentScript; } ~AutoCurrentScriptUpdater() { mScriptLoader->mCurrentScript.swap(mOldScript); } private: nsCOMPtr mOldScript; ScriptLoader* mScriptLoader; }; friend class ModuleLoadRequest; friend class ScriptRequestProcessor; friend class ScriptLoadHandler; friend class AutoCurrentScriptUpdater; public: explicit ScriptLoader(nsIDocument* aDocument); NS_DECL_CYCLE_COLLECTING_ISUPPORTS NS_DECL_CYCLE_COLLECTION_CLASS(ScriptLoader) /** * The loader maintains a weak reference to the document with * which it is initialized. This call forces the reference to * be dropped. */ void DropDocumentReference() { mDocument = nullptr; } /** * Add an observer for all scripts loaded through this loader. * * @param aObserver observer for all script processing. */ nsresult AddObserver(nsIScriptLoaderObserver* aObserver) { return mObservers.AppendObject(aObserver) ? NS_OK : NS_ERROR_OUT_OF_MEMORY; } /** * Remove an observer. * * @param aObserver observer to be removed */ void RemoveObserver(nsIScriptLoaderObserver* aObserver) { mObservers.RemoveObject(aObserver); } /** * Process a script element. This will include both loading the * source of the element if it is not inline and evaluating * the script itself. * * If the script is an inline script that can be executed immediately * (i.e. there are no other scripts pending) then ScriptAvailable * and ScriptEvaluated will be called before the function returns. * * If true is returned the script could not be executed immediately. * In this case ScriptAvailable is guaranteed to be called at a later * point (as well as possibly ScriptEvaluated). * * @param aElement The element representing the script to be loaded and * evaluated. */ bool ProcessScriptElement(nsIScriptElement* aElement); /** * Gets the currently executing script. This is useful if you want to * generate a unique key based on the currently executing script. */ nsIScriptElement* GetCurrentScript() { return mCurrentScript; } nsIScriptElement* GetCurrentParserInsertedScript() { return mCurrentParserInsertedScript; } /** * Whether the loader is enabled or not. * When disabled, processing of new script elements is disabled. * Any call to ProcessScriptElement() will return false. Note that * this DOES NOT disable currently loading or executing scripts. */ bool GetEnabled() { return mEnabled; } void SetEnabled(bool aEnabled) { if (!mEnabled && aEnabled) { ProcessPendingRequestsAsync(); } mEnabled = aEnabled; } /** * Add/remove a blocker for parser-blocking scripts (and XSLT * scripts). Blockers will stop such scripts from executing, but not from * loading. */ void AddParserBlockingScriptExecutionBlocker() { ++mParserBlockingBlockerCount; } void RemoveParserBlockingScriptExecutionBlocker() { if (!--mParserBlockingBlockerCount && ReadyToExecuteScripts()) { ProcessPendingRequestsAsync(); } } /** * Add/remove a blocker for execution of all scripts. Blockers will stop * scripts from executing, but not from loading. */ void AddExecuteBlocker() { ++mBlockerCount; } void RemoveExecuteBlocker() { MOZ_ASSERT(mBlockerCount); if (!--mBlockerCount) { ProcessPendingRequestsAsync(); } } /** * Convert the given buffer to a UTF-16 string. * @param aChannel Channel corresponding to the data. May be null. * @param aData The data to convert * @param aLength Length of the data * @param aHintCharset Hint for the character set (e.g., from a charset * attribute). May be the empty string. * @param aDocument Document which the data is loaded for. Must not be * null. * @param aBufOut [out] char16_t array allocated by ConvertToUTF16 and * containing data converted to unicode. Caller must * js_free() this data when no longer needed. * @param aLengthOut [out] Length of array returned in aBufOut in number * of char16_t code units. */ static nsresult ConvertToUTF16(nsIChannel* aChannel, const uint8_t* aData, uint32_t aLength, const nsAString& aHintCharset, nsIDocument* aDocument, char16_t*& aBufOut, size_t& aLengthOut); /** * Handle the completion of a stream. This is called by the * ScriptLoadHandler object which observes the IncrementalStreamLoader * loading the script. */ nsresult OnStreamComplete(nsIIncrementalStreamLoader* aLoader, nsISupports* aContext, nsresult aChannelStatus, nsresult aSRIStatus, mozilla::Vector &aString, mozilla::dom::SRICheckDataVerifier* aSRIDataVerifier); /** * Processes any pending requests that are ready for processing. */ void ProcessPendingRequests(); /** * Starts deferring deferred scripts and puts them in the mDeferredRequests * queue instead. */ void BeginDeferringScripts() { mDeferEnabled = true; if (mDocument) { mDocument->BlockOnload(); } } /** * Notifies the script loader that parsing is done. If aTerminated is true, * this will drop any pending scripts that haven't run yet. Otherwise, it * will stops deferring scripts and immediately processes the * mDeferredRequests queue. * * WARNING: This function will synchronously execute content scripts, so be * prepared that the world might change around you. */ void ParsingComplete(bool aTerminated); /** * Returns the number of pending scripts, deferred or not. */ uint32_t HasPendingOrCurrentScripts() { return mCurrentScript || mParserBlockingRequest; } /** * Adds aURI to the preload list and starts loading it. * * @param aURI The URI of the external script. * @param aCharset The charset parameter for the script. * @param aType The type parameter for the script. * @param aCrossOrigin The crossorigin attribute for the script. * Void if not present. * @param aIntegrity The expect hash url, if avail, of the request * @param aScriptFromHead Whether or not the script was a child of head */ virtual void PreloadURI(nsIURI *aURI, const nsAString &aCharset, const nsAString &aType, const nsAString &aCrossOrigin, const nsAString& aIntegrity, bool aScriptFromHead, bool aAsync, bool aDefer, bool aNoModule, const mozilla::net::ReferrerPolicy aReferrerPolicy); /** * Process a request that was deferred so that the script could be compiled * off thread. */ nsresult ProcessOffThreadRequest(ScriptLoadRequest *aRequest); bool AddPendingChildLoader(ScriptLoader* aChild) { return mPendingChildLoaders.AppendElement(aChild) != nullptr; } /* * Clear the map of loaded modules. Called when a Document object is reused * for a different global. */ void ClearModuleMap(); /** * Implement the HostResolveImportedModule abstract operation. * * Resolve a module specifier string and look this up in the module * map, returning the result. This is only called for previously * loaded modules and always succeeds. * * @param aReferencingPrivate A JS::Value which is either undefined * or contains a LoadedScript private pointer. * @param aSpecifier The module specifier. * @param aModuleOut This is set to the module found. */ static void ResolveImportedModule(JSContext* aCx, JS::Handle aReferencingPrivate, JS::Handle aSpecifier, JS::MutableHandle aModuleOut); void StartDynamicImport(ModuleLoadRequest* aRequest); void FinishDynamicImport(ModuleLoadRequest* aRequest, nsresult aResult); void FinishDynamicImport(JSContext* aCx, ModuleLoadRequest* aRequest, nsresult aResult); /* * Get the currently active script. This is used as the initiating script when * executing timeout handler scripts. */ static LoadedScript* GetActiveScript(JSContext* aCx); nsIDocument* GetDocument() const { return mDocument; } private: virtual ~ScriptLoader(); void EnsureModuleHooksInitialized(); ScriptLoadRequest* CreateLoadRequest(ScriptKind aKind, nsIURI* aURI, nsIScriptElement* aElement, nsIPrincipal* aTriggeringPrincipal, mozilla::CORSMode aCORSMode, const SRIMetadata& aIntegrity, mozilla::net::ReferrerPolicy aReferrerPolicy); /** * Unblocks the creator parser of the parser-blocking scripts. */ void UnblockParser(ScriptLoadRequest* aParserBlockingRequest); /** * Asynchronously resumes the creator parser of the parser-blocking scripts. */ void ContinueParserAsync(ScriptLoadRequest* aParserBlockingRequest); /** * Helper function to check the content policy for a given request. */ static nsresult CheckContentPolicy(nsIDocument* aDocument, nsISupports *aContext, nsIURI *aURI, const nsAString &aType, bool aIsPreLoad); /** * Start a load for aRequest's URI. */ nsresult StartLoad(ScriptLoadRequest *aRequest, const nsAString &aType, bool aScriptFromHead); void HandleLoadError(ScriptLoadRequest *aRequest, nsresult aResult); /** * Process any pending requests asynchronously (i.e. off an event) if there * are any. Note that this is a no-op if there aren't any currently pending * requests. * * This function is virtual to allow cross-library calls to SetEnabled() */ virtual void ProcessPendingRequestsAsync(); /** * If true, the loader is ready to execute parser-blocking scripts, and so are * all its ancestors. If the loader itself is ready but some ancestor is not, * this function will add an execute blocker and ask the ancestor to remove it * once it becomes ready. */ bool ReadyToExecuteParserBlockingScripts(); /** * Return whether just this loader is ready to execute parser-blocking * scripts. */ bool SelfReadyToExecuteParserBlockingScripts() { return ReadyToExecuteScripts() && !mParserBlockingBlockerCount; } /** * Return whether this loader is ready to execute scripts in general. */ bool ReadyToExecuteScripts() { return mEnabled && !mBlockerCount; } nsresult VerifySRI(ScriptLoadRequest *aRequest, nsIIncrementalStreamLoader* aLoader, nsresult aSRIStatus, SRICheckDataVerifier* aSRIDataVerifier) const; nsresult AttemptAsyncScriptCompile(ScriptLoadRequest* aRequest); nsresult ProcessRequest(ScriptLoadRequest* aRequest); void ProcessDynamicImport(ModuleLoadRequest* aRequest); nsresult CompileOffThreadOrProcessRequest(ScriptLoadRequest* aRequest); void FireScriptAvailable(nsresult aResult, ScriptLoadRequest* aRequest); void FireScriptEvaluated(nsresult aResult, ScriptLoadRequest* aRequest); nsresult EvaluateScript(ScriptLoadRequest* aRequest); already_AddRefed GetScriptGlobalObject(); nsresult FillCompileOptionsForRequest(const mozilla::dom::AutoJSAPI& jsapi, ScriptLoadRequest* aRequest, JS::Handle aScopeChain, JS::CompileOptions* aOptions); uint32_t NumberOfProcessors(); nsresult PrepareLoadedRequest(ScriptLoadRequest* aRequest, nsIIncrementalStreamLoader* aLoader, nsresult aStatus, mozilla::Vector &aString); void AddDeferRequest(ScriptLoadRequest* aRequest); void AddAsyncRequest(ScriptLoadRequest* aRequest); bool MaybeRemovedDeferRequests(); void MaybeMoveToLoadedList(ScriptLoadRequest* aRequest); JS::SourceBufferHolder GetScriptSource(ScriptLoadRequest* aRequest, nsAutoString& inlineData); void SetModuleFetchStarted(ModuleLoadRequest *aRequest); void SetModuleFetchFinishedAndResumeWaitingRequests(ModuleLoadRequest *aRequest, nsresult aResult); bool IsFetchingModule(ModuleLoadRequest *aRequest) const; bool ModuleMapContainsURL(nsIURI* aURL) const; RefPtr WaitForModuleFetch(nsIURI* aURL); ModuleScript* GetFetchedModule(nsIURI* aURL) const; friend JSObject* HostResolveImportedModule(JSContext* aCx, JS::Handle aReferencingPrivate, JS::Handle aSpecifier); nsresult CreateModuleScript(ModuleLoadRequest* aRequest); nsresult ProcessFetchedModuleSource(ModuleLoadRequest* aRequest); void CheckModuleDependenciesLoaded(ModuleLoadRequest* aRequest); void ProcessLoadedModuleTree(ModuleLoadRequest* aRequest); JS::Value FindFirstParseError(ModuleLoadRequest* aRequest); bool InstantiateModuleTree(ModuleLoadRequest* aRequest); void StartFetchingModuleDependencies(ModuleLoadRequest* aRequest); RefPtr StartFetchingModuleAndDependencies(ModuleLoadRequest* aParent, nsIURI* aURI); void RunScriptWhenSafe(ScriptLoadRequest* aRequest); nsIDocument* mDocument; // [WEAK] nsCOMArray mObservers; ScriptLoadRequestList mNonAsyncExternalScriptInsertedRequests; // mLoadingAsyncRequests holds async requests while they're loading; when they // have been loaded they are moved to mLoadedAsyncRequests. ScriptLoadRequestList mLoadingAsyncRequests; ScriptLoadRequestList mLoadedAsyncRequests; ScriptLoadRequestList mDeferRequests; ScriptLoadRequestList mXSLTRequests; ScriptLoadRequestList mDynamicImportRequests; RefPtr mParserBlockingRequest; // In mRequests, the additional information here is stored by the element. struct PreloadInfo { RefPtr mRequest; nsString mCharset; }; friend void ImplCycleCollectionUnlink(ScriptLoader::PreloadInfo& aField); friend void ImplCycleCollectionTraverse(nsCycleCollectionTraversalCallback& aCallback, ScriptLoader::PreloadInfo& aField, const char* aName, uint32_t aFlags); struct PreloadRequestComparator { bool Equals(const PreloadInfo &aPi, ScriptLoadRequest * const &aRequest) const { return aRequest == aPi.mRequest; } }; struct PreloadURIComparator { bool Equals(const PreloadInfo &aPi, nsIURI * const &aURI) const; }; nsTArray mPreloads; nsCOMPtr mCurrentScript; nsCOMPtr mCurrentParserInsertedScript; nsTArray< RefPtr > mPendingChildLoaders; uint32_t mParserBlockingBlockerCount; uint32_t mBlockerCount; uint32_t mNumberOfProcessors; bool mEnabled; bool mDeferEnabled; bool mDocumentParsingDone; bool mBlockingDOMContentLoaded; // Module map nsRefPtrHashtable mFetchingModules; nsRefPtrHashtable mFetchedModules; nsCOMPtr mReporter; }; class nsAutoScriptLoaderDisabler { public: explicit nsAutoScriptLoaderDisabler(nsIDocument* aDoc) { mLoader = aDoc->ScriptLoader(); mWasEnabled = mLoader->GetEnabled(); if (mWasEnabled) { mLoader->SetEnabled(false); } } ~nsAutoScriptLoaderDisabler() { if (mWasEnabled) { mLoader->SetEnabled(true); } } bool mWasEnabled; RefPtr mLoader; }; } // namespace dom } // namespace mozilla #endif //mozilla_dom_ScriptLoader_h