[Autoplay] Use custom wording on site details UI

This implements slide 13 of the spec attached to the bug
on the site details page.

When we enable the new unified autoplay sound settings UI the
sound settings dropdown on the site details UI should have custom
wording based on the state of the sound content setting and
the unified autoplay enabled pref.

BUG=865548

Change-Id: Id52b7cb9d1fdf06236a0094621fea9c46569cf34
Reviewed-on: https://chromium-review.googlesource.com/1160873
Commit-Queue: Becca Hughes <beccahughes@chromium.org>
Reviewed-by: Michael Giuffrida <michaelpg@chromium.org>
Cr-Commit-Position: refs/heads/master@{#583521}

chrome/app/settings_strings.grdp

@@ -2962,9 +2962,15 @@
   <message name="IDS_SETTINGS_SITE_SETTINGS_ALLOW_DEFAULT_MENU" desc="Label for the default menu item to allow a permission for a particular site.">
     Allow (default)
   </message>
+  <message name="IDS_SETTINGS_SITE_SETTINGS_AUTOMATIC_DEFAULT_MENU" desc="Label for the default menu item to automatically control autoplay for a particular site.">
+    Automatic (default)
+  </message>
   <message name="IDS_SETTINGS_SITE_SETTINGS_BLOCK_DEFAULT_MENU" desc="Label for the default menu item to block a permission for a particular site.">
     Block (default)
   </message>
+  <message name="IDS_SETTINGS_SITE_SETTINGS_MUTE_DEFAULT_MENU" desc="Label for the default menu item to mute sound for a particular site.">
+    Mute (default)
+  </message>
   <!-- TODO(https://crbug.com/753173): Consolidate these strings with those used in the Page Info bubble. -->
   <message name="IDS_SETTINGS_SITE_SETTINGS_ALLOW_MENU" desc="Label for the menu item to allow permission for a particular site.">
     Allow
@@ -2975,6 +2981,9 @@
   <message name="IDS_SETTINGS_SITE_SETTINGS_ASK_MENU" desc="Label for the menu item to ask for permission for a particular site.">
     Ask
   </message>
+  <message name="IDS_SETTINGS_SITE_SETTINGS_MUTE_MENU" desc="Label for the menu item to mute sound for a particular site.">
+    Mute
+  </message>
   <message name="IDS_SETTINGS_SITE_SETTINGS_RESET_MENU" desc="Label for the menu item to remove the permission for a particular site (make it ask you again next time).">
     Remove
   </message>

chrome/browser/resources/settings/privacy_page/privacy_page.html

@@ -484,7 +484,10 @@
       </template>
       <template is="dom-if" route-path="/content/siteDetails" no-search>
         <settings-subpage page-title="[[pageTitle]]">
-          <site-details page-title="{{pageTitle}}"></site-details>
+          <site-details
+            page-title="{{pageTitle}}"
+            block-autoplay-enabled="[[blockAutoplayStatus_.pref.value]]">
+          </site-details>
         </settings-subpage>
       </template>
       <template is="dom-if" route-path="/cookies/detail" no-search>

chrome/browser/resources/settings/site_settings/BUILD.gn

@@ -181,6 +181,7 @@ js_library("site_details_permission") {
     ":site_settings_behavior",
     "//ui/webui/resources/js:assert",
     "//ui/webui/resources/js:cr",
+    "//ui/webui/resources/js:i18n_behavior",
     "//ui/webui/resources/js:load_time_data",
     "//ui/webui/resources/js:web_ui_listener_behavior",
   ]

chrome/browser/resources/settings/site_settings/site_details.html

@@ -148,7 +148,8 @@
       </site-details-permission>
       <site-details-permission category="{{ContentSettingsTypes.SOUND}}"
           icon="settings:volume-up" id="sound"
-          label="$i18n{siteSettingsSound}">
+          label="$i18n{siteSettingsSound}"
+          use-automatic-label="[[blockAutoplayEnabled]]">
       </site-details-permission>
       <site-details-permission
           category="{{ContentSettingsTypes.AUTOMATIC_DOWNLOADS}}"

chrome/browser/resources/settings/site_settings/site_details.js

@@ -16,6 +16,11 @@ Polymer({
   ],
 
   properties: {
+    /**
+     * Whether unified autoplay blocking is enabled.
+     */
+    blockAutoplayEnabled: Boolean,
+
     /**
      * The origin that this widget is showing details for.
      * @private
@@ -72,6 +77,9 @@ Polymer({
     this.addWebUIListener(
         'prefEnableDrmChanged', this.prefEnableDrmChanged_.bind(this));
     // </if>
+
+    // Refresh block autoplay status from the backend.
+    this.browserProxy.fetchBlockAutoplayStatus();
   },
 
   /** @override */

chrome/browser/resources/settings/site_settings/site_details_permission.html

@@ -3,6 +3,7 @@
 <link rel="import" href="chrome://resources/html/md_select_css.html">
 <link rel="import" href="chrome://resources/polymer/v1_0/iron-icon/iron-icon.html">
 <link rel="import" href="chrome://resources/html/web_ui_listener_behavior.html">
+<link rel="import" href="chrome://resources/html/i18n_behavior.html">
 <link rel="import" href="../settings_shared_css.html">
 <link rel="import" href="../settings_vars_css.html">
 <link rel="import" href="constants.html">
@@ -53,16 +54,18 @@
           <option id="default" value$="[[ContentSetting.DEFAULT]]">
             [[defaultSettingString_(
                 defaultSetting_,
-                '$i18nPolymer{siteSettingsActionAskDefault}',
-                '$i18nPolymer{siteSettingsActionAllowDefault}',
-                '$i18nPolymer{siteSettingsActionBlockDefault}')]]
+                category,
+                useAutomaticLabel)]]
           </option>
           <option id="allow" value$="[[ContentSetting.ALLOW]]"
               hidden$="[[!showAllowedSetting_(category)]]">
             $i18n{siteSettingsActionAllow}
           </option>
           <option id="block" value$="[[ContentSetting.BLOCK]]">
-            $i18n{siteSettingsActionBlock}
+            [[blockSettingString_(
+                category,
+                '$i18n{siteSettingsActionBlock}',
+                '$i18n{siteSettingsActionMute}')]]
           </option>
           <option id="ask" value$="[[ContentSetting.ASK]]"
               hidden$="[[!showAskSetting_(category, site.setting,

chrome/browser/resources/settings/site_settings/site_details_permission.js

@@ -10,9 +10,16 @@
 Polymer({
   is: 'site-details-permission',
 
-  behaviors: [SiteSettingsBehavior, WebUIListenerBehavior],
+  behaviors: [I18nBehavior, SiteSettingsBehavior, WebUIListenerBehavior],
 
   properties: {
+    /**
+     * If this is a sound content setting, then this controls whether it
+     * should use "Automatic" instead of "Allow" as the default setting
+     * allow label.
+     */
+    useAutomaticLabel: {type: Boolean, value: false},
+
     /**
      * The site that this widget is showing details for.
      * @type {RawSiteException}
@@ -98,30 +105,63 @@ Polymer({
         this.site.origin, [this.category], this.$.permission.value);
   },
 
+  /**
+   * Returns if we should use the custom labels for the sound type.
+   * @param {!settings.ContentSettingsTypes} category The permission type.
+   * @return {boolean}
+   * @private
+   */
+  useCustomSoundLabels_: function(category) {
+    return category == settings.ContentSettingsTypes.SOUND &&
+        loadTimeData.getBoolean('enableBlockAutoplayContentSetting');
+  },
+
   /**
    * Updates the string used for this permission category's default setting.
    * @param {!settings.ContentSetting} defaultSetting Value of the default
    *     setting for this permission category.
-   * @param {string} askString 'Ask' label, e.g. 'Ask (default)'.
-   * @param {string} allowString 'Allow' label, e.g. 'Allow (default)'.
-   * @param {string} blockString 'Block' label, e.g. 'Blocked (default)'.
+   * @param {!settings.ContentSettingsTypes} category The permission type.
+   * @param {boolean} useAutomaticLabel Whether to use the automatic label
+   *     if the default setting value is allow.
    * @return {string}
    * @private
    */
-  defaultSettingString_: function(
-      defaultSetting, askString, allowString, blockString) {
+  defaultSettingString_: function(defaultSetting, category, useAutomaticLabel) {
+    if (defaultSetting == undefined || category == undefined ||
+        useAutomaticLabel == undefined) {
+      return '';
+    }
+
     if (defaultSetting == settings.ContentSetting.ASK ||
         defaultSetting == settings.ContentSetting.IMPORTANT_CONTENT) {
-      return askString;
+      return this.i18n('siteSettingsActionAskDefault');
     } else if (defaultSetting == settings.ContentSetting.ALLOW) {
-      return allowString;
+      if (this.useCustomSoundLabels_(category) && useAutomaticLabel)
+        return this.i18n('siteSettingsActionAutomaticDefault');
+      return this.i18n('siteSettingsActionAllowDefault');
     } else if (defaultSetting == settings.ContentSetting.BLOCK) {
-      return blockString;
+      if (this.useCustomSoundLabels_(category))
+        return this.i18n('siteSettingsActionMuteDefault');
+      return this.i18n('siteSettingsActionBlockDefault');
     }
     assertNotReached(
         `No string for ${this.category}'s default of ${defaultSetting}`);
   },
 
+  /**
+   * Updates the string used for this permission category's block setting.
+   * @param {!settings.ContentSettingsTypes} category The permission type.
+   * @param {string} blockString 'Block' label.
+   * @param {string} muteString 'Mute' label.
+   * @return {string}
+   * @private
+   */
+  blockSettingString_: function(category, blockString, muteString) {
+    if (this.useCustomSoundLabels_(category))
+      return muteString;
+    return blockString;
+  },
+
   /**
    * Returns true if there's a string to display that provides more information
    * about this permission's setting. Currently, this only gets called when

chrome/browser/resources/settings/site_settings/site_settings_prefs_browser_proxy.js

@@ -317,6 +317,12 @@ cr.define('settings', function() {
      */
     showAndroidManageAppLinks() {}
     // </if>
+
+    /**
+     * Fetches the current block autoplay state. Returns the results via
+     * onBlockAutoplayStatusChanged.
+     */
+    fetchBlockAutoplayStatus() {}
   }
 
   /**
@@ -459,6 +465,11 @@ cr.define('settings', function() {
       chrome.send('showAndroidManageAppLinks');
     }
     // </if>
+
+    /** @override */
+    fetchBlockAutoplayStatus() {
+      chrome.send('fetchBlockAutoplayStatus');
+    }
   }
 
   // The singleton instance_ is replaced with a test version of this wrapper

chrome/browser/ui/webui/settings/md_settings_localized_strings_provider.cc

@@ -2353,11 +2353,16 @@ void AddSiteSettingsStrings(content::WebUIDataSource* html_source,
      IDS_SETTINGS_SITE_SETTINGS_ASK_DEFAULT_MENU},
     {"siteSettingsActionAllowDefault",
      IDS_SETTINGS_SITE_SETTINGS_ALLOW_DEFAULT_MENU},
+    {"siteSettingsActionAutomaticDefault",
+     IDS_SETTINGS_SITE_SETTINGS_AUTOMATIC_DEFAULT_MENU},
     {"siteSettingsActionBlockDefault",
      IDS_SETTINGS_SITE_SETTINGS_BLOCK_DEFAULT_MENU},
+    {"siteSettingsActionMuteDefault",
+     IDS_SETTINGS_SITE_SETTINGS_MUTE_DEFAULT_MENU},
     {"siteSettingsActionAllow", IDS_SETTINGS_SITE_SETTINGS_ALLOW_MENU},
     {"siteSettingsActionBlock", IDS_SETTINGS_SITE_SETTINGS_BLOCK_MENU},
     {"siteSettingsActionAsk", IDS_SETTINGS_SITE_SETTINGS_ASK_MENU},
+    {"siteSettingsActionMute", IDS_SETTINGS_SITE_SETTINGS_MUTE_MENU},
     {"siteSettingsActionReset", IDS_SETTINGS_SITE_SETTINGS_RESET_MENU},
     {"siteSettingsActionSessionOnly",
      IDS_SETTINGS_SITE_SETTINGS_SESSION_ONLY_MENU},

chrome/browser/ui/webui/settings/site_settings_handler.cc

@@ -277,6 +277,10 @@ void SiteSettingsHandler::RegisterMessages() {
       "setBlockAutoplayEnabled",
       base::BindRepeating(&SiteSettingsHandler::HandleSetBlockAutoplayEnabled,
                           base::Unretained(this)));
+  web_ui()->RegisterMessageCallback(
+      "fetchBlockAutoplayStatus",
+      base::BindRepeating(&SiteSettingsHandler::HandleFetchBlockAutoplayStatus,
+                          base::Unretained(this)));
 }
 
 void SiteSettingsHandler::OnJavascriptAllowed() {
@@ -1140,6 +1144,12 @@ void SiteSettingsHandler::HandleRemoveZoomLevel(const base::ListValue* args) {
   host_zoom_map->SetZoomLevelForHost(origin, default_level);
 }
 
+void SiteSettingsHandler::HandleFetchBlockAutoplayStatus(
+    const base::ListValue* args) {
+  AllowJavascript();
+  SendBlockAutoplayStatus();
+}
+
 void SiteSettingsHandler::SendBlockAutoplayStatus() {
   if (!IsJavascriptAllowed())
     return;

chrome/browser/ui/webui/settings/site_settings_handler.h

@@ -91,6 +91,8 @@ class SiteSettingsHandler : public SettingsPageUIHandler,
   FRIEND_TEST_ALL_PREFIXES(SiteSettingsHandlerInfobarTest,
                            SettingPermissionsTriggersInfobar);
   FRIEND_TEST_ALL_PREFIXES(SiteSettingsHandlerTest, SessionOnlyException);
+  FRIEND_TEST_ALL_PREFIXES(SiteSettingsHandlerTest,
+                           BlockAutoplay_SendOnRequest);
   FRIEND_TEST_ALL_PREFIXES(SiteSettingsHandlerTest, BlockAutoplay_Update);
 
   // Asynchronously fetches the usage for a given origin. Replies back with
@@ -162,6 +164,9 @@ class SiteSettingsHandler : public SettingsPageUIHandler,
   // Removes a particular zoom level for a given host.
   void HandleRemoveZoomLevel(const base::ListValue* args);
 
+  // Handles the request to send block autoplay state.
+  void HandleFetchBlockAutoplayStatus(const base::ListValue* args);
+
   // Notifies the JS side about the state of the block autoplay toggle.
   void SendBlockAutoplayStatus();
 

chrome/browser/ui/webui/settings/site_settings_handler_unittest.cc

@@ -1264,6 +1264,14 @@ TEST_F(SiteSettingsHandlerTest, SessionOnlyException) {
   histograms.ExpectTotalCount(uma_base + ".SessionOnly", 1);
 }
 
+TEST_F(SiteSettingsHandlerTest, BlockAutoplay_SendOnRequest) {
+  base::ListValue args;
+  handler()->HandleFetchBlockAutoplayStatus(&args);
+
+  // Check that we are checked and enabled.
+  ValidateBlockAutoplay(true, true);
+}
+
 TEST_F(SiteSettingsHandlerTest, BlockAutoplay_SoundSettingUpdate) {
   SetSoundContentSettingDefault(CONTENT_SETTING_BLOCK);
   base::RunLoop().RunUntilIdle();

chrome/test/data/webui/settings/site_details_permission_tests.js

@@ -28,6 +28,8 @@ suite('SiteDetailsPermission', function() {
             settings.ContentSettingsTypes.CAMERA,
             [test_util.createRawSiteException('https://www.example.com')])]);
 
+    loadTimeData.overrideValues({enableBlockAutoplayContentSetting: true});
+
     browserProxy = new TestSiteSettingsPrefsBrowserProxy();
     settings.SiteSettingsPrefsBrowserProxyImpl.instance_ = browserProxy;
     PolymerTest.clearBody();
@@ -310,4 +312,83 @@ suite('SiteDetailsPermission', function() {
     assertFalse(testElement.$.permissionItem.classList.contains('two-line'));
     assertFalse(testElement.$.permission.disabled);
   });
+
+  test('sound setting default string is correct', function() {
+    const origin = 'https://www.example.com';
+    browserProxy.setPrefs(prefs);
+    testElement.category = settings.ContentSettingsTypes.SOUND;
+    testElement.label = 'Sound';
+    testElement.site = {
+      origin: origin,
+      embeddingOrigin: '',
+      setting: settings.ContentSetting.ALLOW,
+      source: settings.SiteSettingSource.PREFERENCE,
+    };
+
+    return browserProxy.whenCalled('getDefaultValueForContentType')
+        .then((args) => {
+          // Check getDefaultValueForContentType was called for sound category.
+          assertEquals(settings.ContentSettingsTypes.SOUND, args);
+
+          // The default option will always be the first in the menu.
+          assertEquals(
+              'Allow (default)', testElement.$.permission.options[0].text,
+              'Default setting string should match prefs');
+          browserProxy.resetResolver('getDefaultValueForContentType');
+          const defaultPrefs = test_util.createSiteSettingsPrefs(
+              [test_util.createContentSettingTypeToValuePair(
+                  settings.ContentSettingsTypes.SOUND,
+                  test_util.createDefaultContentSetting(
+                      {setting: settings.ContentSetting.BLOCK}))],
+              []);
+          browserProxy.setPrefs(defaultPrefs);
+          return browserProxy.whenCalled('getDefaultValueForContentType');
+        })
+        .then((args) => {
+          assertEquals(settings.ContentSettingsTypes.SOUND, args);
+          assertEquals(
+              'Mute (default)', testElement.$.permission.options[0].text,
+              'Default setting string should match prefs');
+          browserProxy.resetResolver('getDefaultValueForContentType');
+          testElement.useAutomaticLabel = true;
+          const defaultPrefs = test_util.createSiteSettingsPrefs(
+              [test_util.createContentSettingTypeToValuePair(
+                  settings.ContentSettingsTypes.SOUND,
+                  test_util.createDefaultContentSetting(
+                      {setting: settings.ContentSetting.ALLOW}))],
+              []);
+          browserProxy.setPrefs(defaultPrefs);
+          return browserProxy.whenCalled('getDefaultValueForContentType');
+        })
+        .then((args) => {
+          assertEquals(settings.ContentSettingsTypes.SOUND, args);
+          assertEquals(
+              'Automatic (default)', testElement.$.permission.options[0].text,
+              'Default setting string should match prefs');
+        });
+  });
+
+  test('sound setting block string is correct', function() {
+    const origin = 'https://www.example.com';
+    browserProxy.setPrefs(prefs);
+    testElement.category = settings.ContentSettingsTypes.SOUND;
+    testElement.label = 'Sound';
+    testElement.site = {
+      origin: origin,
+      embeddingOrigin: '',
+      setting: settings.ContentSetting.ALLOW,
+      source: settings.SiteSettingSource.PREFERENCE,
+    };
+
+    return browserProxy.whenCalled('getDefaultValueForContentType')
+        .then((args) => {
+          // Check getDefaultValueForContentType was called for sound category.
+          assertEquals(settings.ContentSettingsTypes.SOUND, args);
+
+          // The block option will always be the third in the menu.
+          assertEquals(
+              'Mute', testElement.$.permission.options[2].text,
+              'Block setting string should match prefs');
+        });
+  });
 });

chrome/test/data/webui/settings/site_details_tests.js

@@ -443,4 +443,12 @@ suite('SiteDetails', function() {
         });
   });
 
+  test('call fetch block autoplay status', function() {
+    const origin = 'https://foo.com:443';
+    browserProxy.setPrefs(prefs);
+    loadTimeData.overrideValues({enableSiteSettings: true});
+    testElement = createSiteDetails(origin);
+    return browserProxy.whenCalled('fetchBlockAutoplayStatus');
+  });
+
 });

chrome/test/data/webui/settings/test_site_settings_prefs_browser_proxy.js

@@ -44,6 +44,7 @@ class TestSiteSettingsPrefsBrowserProxy extends TestBrowserProxy {
       'setOriginPermissions',
       'setProtocolDefault',
       'updateIncognitoStatus',
+      'fetchBlockAutoplayStatus',
     ]);
 
     /** @private {boolean} */
@@ -386,4 +387,9 @@ class TestSiteSettingsPrefsBrowserProxy extends TestBrowserProxy {
   updateIncognitoStatus() {
     this.methodCalled('updateIncognitoStatus', arguments);
   }
+
+  /** @override */
+  fetchBlockAutoplayStatus() {
+    this.methodCalled('fetchBlockAutoplayStatus');
+  }
 }