Changeset 236818 in webkit

Timestamp:

Oct 3, 2018, 5:50:46 PM (8 years ago)

Author:

jer.noble@apple.com

Message:

Add a quirk to disable Modern EME for sites which are broken with it enabled
​https://bugs.webkit.org/show_bug.cgi?id=190051

Reviewed by Daniel Bates.

Add a new class, parallel to Settings, to track quirk behavior. Extend the bindings
generator to support a DisabledByQuirk attribute, and set this attribute for all
the Modern EME types. Check whether the quirk is set inside HTMLMediaElement in
addition to the existing Setting.

• Modules/encryptedmedia/MediaKeyMessageEvent.idl:
• Modules/encryptedmedia/MediaKeySession.idl:
• Modules/encryptedmedia/MediaKeyStatusMap.idl:
• Modules/encryptedmedia/MediaKeySystemAccess.idl:
• Modules/encryptedmedia/MediaKeys.idl:
• Modules/encryptedmedia/NavigatorEME.idl:
• Sources.txt:
• WebCore.xcodeproj/project.pbxproj:
• bindings/scripts/CodeGenerator.pm:

(WK_ucfirst):

• bindings/scripts/CodeGeneratorJS.pm:

(NeedsRuntimeCheck):
(GenerateRuntimeEnableConditionalString):

• bindings/scripts/IDLAttributes.json:
• bindings/scripts/preprocess-idls.pl:

(GenerateConstructorAttributes):

• dom/Document.cpp:

(WebCore::Document::Document):

• dom/Document.h:

(WebCore::Document::quirks const):

• html/HTMLMediaElement.cpp:

(WebCore::HTMLMediaElement::mediaPlayerKeyNeeded):
(WebCore::HTMLMediaElement::mediaPlayerInitializationDataEncountered):

• html/HTMLMediaElement.idl:
• page/Quirks.cpp: Added.

(Quirks::Quirks):
(Quirks::disableEncryptedMediaAPIQuirk const):

• page/Quirks.h: Added.

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• Modules/encryptedmedia/MediaKeyMessageEvent.idl (modified) (1 diff)
• Modules/encryptedmedia/MediaKeySession.idl (modified) (1 diff)
• Modules/encryptedmedia/MediaKeyStatusMap.idl (modified) (1 diff)
• Modules/encryptedmedia/MediaKeySystemAccess.idl (modified) (1 diff)
• Modules/encryptedmedia/MediaKeys.idl (modified) (1 diff)
• Modules/encryptedmedia/NavigatorEME.idl (modified) (1 diff)
• Sources.txt (modified) (1 diff)
• WebCore.xcodeproj/project.pbxproj (modified) (2 diffs)
• bindings/scripts/CodeGeneratorJS.pm (modified) (2 diffs)
• bindings/scripts/IDLAttributes.json (modified) (1 diff)
• bindings/scripts/preprocess-idls.pl (modified) (1 diff)
• dom/Document.cpp (modified) (2 diffs)
• dom/Document.h (modified) (4 diffs)
• html/HTMLMediaElement.cpp (modified) (3 diffs)
• html/HTMLMediaElement.idl (modified) (1 diff)
• html/MediaEncryptedEvent.idl (modified) (1 diff)
• page/Quirks.cpp (added)
• page/Quirks.h (added)
• page/csp/ContentSecurityPolicySource.cpp (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2018-10-03  Jer Noble  <jer.noble@apple.com>
+
+        Add a quirk to disable Modern EME for sites which are broken with it enabled
+        https://bugs.webkit.org/show_bug.cgi?id=190051
+
+        Reviewed by Daniel Bates.
+
+        Add a new class, parallel to Settings, to track quirk behavior. Extend the bindings
+        generator to support a DisabledByQuirk attribute, and set this attribute for all
+        the Modern EME types. Check whether the quirk is set inside HTMLMediaElement in
+        addition to the existing Setting.
+
+        * Modules/encryptedmedia/MediaKeyMessageEvent.idl:
+        * Modules/encryptedmedia/MediaKeySession.idl:
+        * Modules/encryptedmedia/MediaKeyStatusMap.idl:
+        * Modules/encryptedmedia/MediaKeySystemAccess.idl:
+        * Modules/encryptedmedia/MediaKeys.idl:
+        * Modules/encryptedmedia/NavigatorEME.idl:
+        * Sources.txt:
+        * WebCore.xcodeproj/project.pbxproj:
+        * bindings/scripts/CodeGenerator.pm:
+        (WK_ucfirst):
+        * bindings/scripts/CodeGeneratorJS.pm:
+        (NeedsRuntimeCheck):
+        (GenerateRuntimeEnableConditionalString):
+        * bindings/scripts/IDLAttributes.json:
+        * bindings/scripts/preprocess-idls.pl:
+        (GenerateConstructorAttributes):
+        * dom/Document.cpp:
+        (WebCore::Document::Document):
+        * dom/Document.h:
+        (WebCore::Document::quirks const):
+        * html/HTMLMediaElement.cpp:
+        (WebCore::HTMLMediaElement::mediaPlayerKeyNeeded):
+        (WebCore::HTMLMediaElement::mediaPlayerInitializationDataEncountered):
+        * html/HTMLMediaElement.idl:
+        * page/Quirks.cpp: Added.
+        (Quirks::Quirks):
+        (Quirks::disableEncryptedMediaAPIQuirk const):
+        * page/Quirks.h: Added.
+
 2018-10-03  Antoine Quint  <graouts@apple.com>
 

trunk/Source/WebCore/Modules/encryptedmedia/MediaKeyMessageEvent.idl

@@ -42 +42 @@
     Conditional=ENCRYPTED_MEDIA,
     Constructor(DOMString type, MediaKeyMessageEventInit eventInitDict),
-    EnabledAtRuntime=EncryptedMediaAPI
+    EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
 ] interface MediaKeyMessageEvent : Event {
     readonly attribute MediaKeyMessageType messageType;

trunk/Source/WebCore/Modules/encryptedmedia/MediaKeySession.idl

@@ -29 +29 @@
 [
     Conditional=ENCRYPTED_MEDIA,
-    EnabledAtRuntime=EncryptedMediaAPI
+    EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
 ] interface MediaKeySession : EventTarget {
     readonly attribute DOMString sessionId;

trunk/Source/WebCore/Modules/encryptedmedia/MediaKeyStatusMap.idl

@@ -39 +39 @@
 [
     Conditional=ENCRYPTED_MEDIA,
-    EnabledAtRuntime=EncryptedMediaAPI
+    EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
 ] interface MediaKeyStatusMap {
     iterable<BufferSource, MediaKeyStatus>;

trunk/Source/WebCore/Modules/encryptedmedia/MediaKeySystemAccess.idl

@@ -30 +30 @@
     Conditional=ENCRYPTED_MEDIA,
     EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
     ImplementationLacksVTable,
 ] interface MediaKeySystemAccess {

trunk/Source/WebCore/Modules/encryptedmedia/MediaKeys.idl

@@ -30 +30 @@
     Conditional=ENCRYPTED_MEDIA,
     EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
     ImplementationLacksVTable,
 ] interface MediaKeys {

trunk/Source/WebCore/Modules/encryptedmedia/NavigatorEME.idl

@@ -29 +29 @@
 [
     Conditional=ENCRYPTED_MEDIA,
-    EnabledAtRuntime=EncryptedMediaAPI
+    EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
 ] partial interface Navigator {
     [CallWith=Document] Promise<MediaKeySystemAccess> requestMediaKeySystemAccess(DOMString keySystem, sequence<MediaKeySystemConfiguration> supportedConfiguration);

trunk/Source/WebCore/Sources.txt

@@ -1421 +1421 @@
 page/PrintContext.cpp
 page/ProcessWarming.cpp
+page/Quirks.cpp
 page/RemoteDOMWindow.cpp
 page/RemoteFrame.cpp

trunk/Source/WebCore/WebCore.xcodeproj/project.pbxproj

@@ -13344 +13344 @@
                 CD94A5DA1F71CBB000F525C5 /* CDMClearKey.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CDMClearKey.h; sourceTree = "<group>"; };
                 CD94A5DB1F71CBB000F525C5 /* CDMClearKey.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = CDMClearKey.cpp; sourceTree = "<group>"; };
+                CD9A87F9215D6CF3006F17B5 /* Quirks.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = Quirks.cpp; sourceTree = "<group>"; };
+                CD9A87FB215D6CF3006F17B5 /* Quirks.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = Quirks.h; sourceTree = "<group>"; };
                 CD9D375A215163E40049657B /* CDMInstanceSession.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = CDMInstanceSession.h; sourceTree = "<group>"; };
                 CD9D82731C7AE535006FF066 /* TextureCacheCV.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = TextureCacheCV.mm; sourceTree = "<group>"; };
@@ -19535 +19537 @@
                                 E42050162141901B0066EF3B /* ProcessWarming.cpp */,
                                 E42050142141901A0066EF3B /* ProcessWarming.h */,
+                                CD9A87F9215D6CF3006F17B5 /* Quirks.cpp */,
+                                CD9A87FB215D6CF3006F17B5 /* Quirks.h */,
                                 46B9518D207D632A00A7D2DD /* RemoteDOMWindow.cpp */,
                                 46B9518E207D632A00A7D2DD /* RemoteDOMWindow.h */,

trunk/Source/WebCore/bindings/scripts/CodeGeneratorJS.pm

@@ -1706 +1706 @@
         || $context->extendedAttributes->{EnabledForWorld}
         || $context->extendedAttributes->{EnabledBySetting}
+        || $context->extendedAttributes->{DisabledByQuirk}
         || $context->extendedAttributes->{SecureContext}
         || $context->extendedAttributes->{ContextHasServiceWorkerScheme};
@@ -3719 +3720 @@
         foreach my $flag (@flags) {
             push(@conjuncts, "downcast<Document>(jsCast<JSDOMGlobalObject*>(" . $globalObjectPtr . ")->scriptExecutionContext())->settings()." . ToMethodName($flag) . "Enabled()");
+        }
+    }
+
+    if ($context->extendedAttributes->{DisabledByQuirk}) {
+        assert("Must specify value for DisabledByQuirk.") if $context->extendedAttributes->{DisabledByQuirk} eq "VALUE_IS_MISSING";
+
+        AddToImplIncludes("Document.h");
+        AddToImplIncludes("Quirks.h");
+
+        assert("DisabledByQuirk can only be used by interfaces only exposed to the Window") if $interface->extendedAttributes->{Exposed} && $interface->extendedAttributes->{Exposed} ne "Window";
+
+        my @flags = split(/&/, $context->extendedAttributes->{DisabledByQuirk});
+        foreach my $flag (@flags) {
+            push(@conjuncts, "!downcast<Document>(jsCast<JSDOMGlobalObject*>(" . $globalObjectPtr . ")->scriptExecutionContext())->quirks()." . ToMethodName($flag) . "Quirk()");
         }
     }

trunk/Source/WebCore/bindings/scripts/IDLAttributes.json

@@ -182 +182 @@
             "values": ["*"]
         },
+        "DisabledByQuirk": {
+            "contextsAllowed": ["interface", "dictionary", "enum", "attribute", "operation", "constant"],
+            "values": ["*"]
+        },
         "EnabledForWorld": {
             "contextsAllowed": ["attribute", "operation"],

trunk/Source/WebCore/bindings/scripts/preprocess-idls.pl

@@ -259 +259 @@
       next unless ($attributeName eq "Conditional" || $attributeName eq "EnabledAtRuntime" || $attributeName eq "EnabledForWorld"
         || $attributeName eq "EnabledBySetting" || $attributeName eq "SecureContext" || $attributeName eq "PrivateIdentifier"
-        || $attributeName eq "PublicIdentifier");
+        || $attributeName eq "PublicIdentifier" || $attributeName eq "DisabledByQuirk");
       my $extendedAttribute = $attributeName;
       $extendedAttribute .= "=" . $extendedAttributes->{$attributeName} unless $extendedAttributes->{$attributeName} eq "VALUE_IS_MISSING";

trunk/Source/WebCore/dom/Document.cpp

@@ -151 +151 @@
 #include "ProcessingInstruction.h"
 #include "PublicSuffix.h"
+#include "Quirks.h"
 #include "RealtimeMediaSourceCenter.h"
 #include "RenderChildIterator.h"
@@ -490 +491 @@
 #endif
     , m_settings(frame ? Ref<Settings>(frame->settings()) : Settings::create(nullptr))
+    , m_quirks(makeUniqueRef<Quirks>(*this))
     , m_cachedResourceLoader(m_frame ? Ref<CachedResourceLoader>(m_frame->loader().activeDocumentLoader()->cachedResourceLoader()) : CachedResourceLoader::create(nullptr))
     , m_domTreeVersion(++s_globalTreeVersion)

trunk/Source/WebCore/dom/Document.h

@@ -64 +64 @@
 #include <wtf/Logger.h>
 #include <wtf/ObjectIdentifier.h>
+#include <wtf/UniqueRef.h>
 #include <wtf/WeakPtr.h>
 #include <wtf/text/AtomicStringHash.h>
@@ -156 +157 @@
 class ProcessingInstruction;
 class QualifiedName;
+class Quirks;
 class Range;
 class RenderFullScreen;
@@ -566 +568 @@
     Settings& mutableSettings() { return m_settings.get(); }
 
+    const Quirks& quirks() const { return m_quirks; }
+
     float deviceScaleFactor() const;
 
@@ -1629 +1633 @@
     const Ref<Settings> m_settings;
 
+    UniqueRef<Quirks> m_quirks;
+
     std::unique_ptr<StyleResolver> m_userAgentShadowTreeStyleResolver;
 

trunk/Source/WebCore/html/HTMLMediaElement.cpp

@@ -74 +74 @@
 #include "ProgressTracker.h"
 #include "PublicSuffix.h"
+#include "Quirks.h"
 #include "RenderLayerCompositor.h"
 #include "RenderTheme.h"
@@ -2628 +2629 @@
         // Only fire an error if ENCRYPTED_MEDIA is not enabled, to give clients of the 
         // "encrypted" event a chance to handle it without resulting in a synthetic error.
-        && !RuntimeEnabledFeatures::sharedFeatures().encryptedMediaAPIEnabled()
+        && (!RuntimeEnabledFeatures::sharedFeatures().encryptedMediaAPIEnabled() || document().quirks().hasBrokenEncryptedMediaAPISupportQuirk())
 #endif
         ) {
@@ -2764 +2765 @@
 void HTMLMediaElement::mediaPlayerInitializationDataEncountered(const String& initDataType, RefPtr<ArrayBuffer>&& initData)
 {
-    if (!RuntimeEnabledFeatures::sharedFeatures().encryptedMediaAPIEnabled())
+    if (!RuntimeEnabledFeatures::sharedFeatures().encryptedMediaAPIEnabled() || document().quirks().hasBrokenEncryptedMediaAPISupportQuirk())
         return;
 

trunk/Source/WebCore/html/HTMLMediaElement.idl

@@ -105 +105 @@
     [Conditional=LEGACY_ENCRYPTED_MEDIA, EnabledAtRuntime=LegacyEncryptedMediaAPI] readonly attribute WebKitMediaKeys webkitKeys;
     [Conditional=LEGACY_ENCRYPTED_MEDIA, EnabledAtRuntime=LegacyEncryptedMediaAPI] void webkitSetMediaKeys(WebKitMediaKeys? mediaKeys);
-    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI] readonly attribute MediaKeys mediaKeys;
-    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI] attribute EventHandler onencrypted;
-    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI] attribute EventHandler onwaitingforkey;
-    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI] Promise<void> setMediaKeys(MediaKeys? mediaKeys);
+    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI, DisabledByQuirk=hasBrokenEncryptedMediaAPISupport] readonly attribute MediaKeys mediaKeys;
+    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI, DisabledByQuirk=hasBrokenEncryptedMediaAPISupport] attribute EventHandler onencrypted;
+    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI, DisabledByQuirk=hasBrokenEncryptedMediaAPISupport] attribute EventHandler onwaitingforkey;
+    [Conditional=ENCRYPTED_MEDIA, EnabledAtRuntime=EncryptedMediaAPI, DisabledByQuirk=hasBrokenEncryptedMediaAPISupport] Promise<void> setMediaKeys(MediaKeys? mediaKeys);
 
     [Conditional=VIDEO_TRACK, MayThrowException] TextTrack addTextTrack(DOMString kind, optional DOMString label = "", optional DOMString language = "");

trunk/Source/WebCore/html/MediaEncryptedEvent.idl

@@ -35 +35 @@
     Conditional=ENCRYPTED_MEDIA,
     Constructor(DOMString type, optional MediaEncryptedEventInit eventInitDict),
-    EnabledAtRuntime=EncryptedMediaAPI
+    EnabledAtRuntime=EncryptedMediaAPI,
+    DisabledByQuirk=hasBrokenEncryptedMediaAPISupport,
 ] interface MediaEncryptedEvent : Event {
     readonly attribute DOMString initDataType;

trunk/Source/WebCore/page/csp/ContentSecurityPolicySource.cpp

@@ -30 +30 @@
 #include "ContentSecurityPolicy.h"
 #include "SecurityOriginData.h"
+#include "TextEncoding.h"
 #include "URL.h"