Bug 1470651 - Support cookieStoreId option in contentScripts.register r=rpl,robwu

Differential Revision: https://phabricator.services.mozilla.com/D124537

Author: 14Richa

dom/chrome-webidl/WebExtensionContentScript.webidl

@@ -86,6 +86,12 @@ interface MozDocumentMatcher {
   [Cached, Constant, Frozen]
   readonly attribute sequence<MatchGlob>? excludeGlobs;
 
+  /**
+   * The originAttributesPattern for which this script should be enabled for.
+   */
+  [Constant, Throws]
+  readonly attribute any originAttributesPatterns;
+
   /**
    * The policy object for the extension that this matcher belongs to.
    */
@@ -96,6 +102,8 @@ interface MozDocumentMatcher {
 dictionary MozDocumentMatcherInit {
   boolean allFrames = false;
 
+  sequence<OriginAttributesPatternDictionary>? originAttributesPatterns = null;
+
   boolean matchAboutBlank = false;
 
   unsigned long long? frameID = null;

toolkit/components/extensions/WebExtensionContentScript.h

@@ -144,6 +144,10 @@ class MozDocumentMatcher : public nsISupports, public nsWrapperCache {
 
   Nullable<uint64_t> GetFrameID() const { return mFrameID; }
 
+  void GetOriginAttributesPatterns(JSContext* aCx,
+                                   JS::MutableHandle<JS::Value> aVal,
+                                   ErrorResult& aError) const;
+
   WebExtensionPolicy* GetParentObject() const { return mExtension; }
   virtual JSObject* WrapObject(JSContext* aCx,
                                JS::HandleObject aGivenProto) override;
@@ -171,6 +175,7 @@ class MozDocumentMatcher : public nsISupports, public nsWrapperCache {
   bool mAllFrames;
   Nullable<uint64_t> mFrameID;
   bool mMatchAboutBlank;
+  Nullable<dom::Sequence<OriginAttributesPattern>> mOriginAttributesPatterns;
 
  private:
   template <typename T, typename U>

toolkit/components/extensions/WebExtensionPolicy.cpp

@@ -667,6 +667,17 @@ MozDocumentMatcher::MozDocumentMatcher(GlobalObject& aGlobal,
       return;
     }
   }
+
+  if (!aInit.mOriginAttributesPatterns.IsNull()) {
+    Sequence<OriginAttributesPattern>& arr =
+        mOriginAttributesPatterns.SetValue();
+    for (const auto& pattern : aInit.mOriginAttributesPatterns.Value()) {
+      if (!arr.AppendElement(OriginAttributesPattern(pattern), fallible)) {
+        aRv.Throw(NS_ERROR_OUT_OF_MEMORY);
+        return;
+      }
+    }
+  }
 }
 
 WebExtensionContentScript::WebExtensionContentScript(
@@ -698,6 +709,21 @@ bool MozDocumentMatcher::Matches(const DocInfo& aDoc) const {
     return false;
   }
 
+  if (loadContext && !mOriginAttributesPatterns.IsNull()) {
+    OriginAttributes docShellAttrs;
+    loadContext->GetOriginAttributes(docShellAttrs);
+    bool patternMatch = false;
+    for (const auto& pattern : mOriginAttributesPatterns.Value()) {
+      if (pattern.Matches(docShellAttrs)) {
+        patternMatch = true;
+        break;
+      }
+    }
+    if (!patternMatch) {
+      return false;
+    }
+  }
+
   if (!mMatchAboutBlank && aDoc.URL().InheritsPrincipal()) {
     return false;
   }
@@ -760,6 +786,14 @@ bool MozDocumentMatcher::MatchesWindowGlobal(WindowGlobalChild& aWindow) const {
   return Matches(inner->GetOuterWindow());
 }
 
+void MozDocumentMatcher::GetOriginAttributesPatterns(
+    JSContext* aCx, JS::MutableHandle<JS::Value> aVal,
+    ErrorResult& aError) const {
+  if (!ToJSValue(aCx, mOriginAttributesPatterns, aVal)) {
+    aError.NoteJSContextException(aCx);
+  }
+}
+
 JSObject* MozDocumentMatcher::WrapObject(JSContext* aCx,
                                          JS::HandleObject aGivenProto) {
   return MozDocumentMatcher_Binding::Wrap(aCx, this, aGivenProto);

toolkit/components/extensions/parent/ext-contentScripts.js

@@ -15,6 +15,30 @@ var { ExtensionUtils } = ChromeUtils.import(
 
 var { ExtensionError, getUniqueId } = ExtensionUtils;
 
+function getOriginAttributesPatternForCookieStoreId(cookieStoreId) {
+  if (isDefaultCookieStoreId(cookieStoreId)) {
+    return {
+      userContextId: Ci.nsIScriptSecurityManager.DEFAULT_USER_CONTEXT_ID,
+      privateBrowsingId:
+        Ci.nsIScriptSecurityManager.DEFAULT_PRIVATE_BROWSING_ID,
+    };
+  }
+  if (isPrivateCookieStoreId(cookieStoreId)) {
+    return {
+      userContextId: Ci.nsIScriptSecurityManager.DEFAULT_USER_CONTEXT_ID,
+      privateBrowsingId: 1,
+    };
+  }
+  if (isContainerCookieStoreId(cookieStoreId)) {
+    let userContextId = getContainerForCookieStoreId(cookieStoreId);
+    if (userContextId !== null) {
+      return { userContextId };
+    }
+  }
+
+  throw new ExtensionError("Invalid cookieStoreId");
+}
+
 /**
  * Represents (in the main browser process) a content script registered
  * programmatically (instead of being included in the addon manifest).
@@ -74,8 +98,18 @@ class ContentScriptParent {
       runAt: details.runAt || "document_idle",
       jsPaths: [],
       cssPaths: [],
+      originAttributesPatterns: null,
     };
 
+    if (details.cookieStoreId != null) {
+      const cookieStoreIds = Array.isArray(details.cookieStoreId)
+        ? details.cookieStoreId
+        : [details.cookieStoreId];
+      options.originAttributesPatterns = cookieStoreIds.map(cookieStoreId =>
+        getOriginAttributesPatternForCookieStoreId(cookieStoreId)
+      );
+    }
+
     const convertCodeToURL = (data, mime) => {
       const blob = new context.cloneScope.Blob(data, { type: mime });
       const blobURL = context.cloneScope.URL.createObjectURL(blob);

toolkit/components/extensions/schemas/content_scripts.json

@@ -51,6 +51,20 @@
             "$ref": "extensionTypes.RunAt",
             "optional": true,
             "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
+          },
+          "cookieStoreId": {
+            "choices": [ 
+              {
+                "type": "array",
+                "minItems": 1,
+                "items": { "type": "string" }
+              },
+              {
+                "type": "string"
+              }          
+            ],
+            "optional": true,
+            "description": "limit the set of matched tabs to those that belong to the given cookie store id"
           }
         }
       },