MD Settings: clarify "controlled by" logic

chrome/browser/extensions/api/settings_private/prefs_util.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/extensions/api/settings_private/prefs_util.h"
 
 #include "build/build_config.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/extensions/chrome_extension_function.h"
+#include "chrome/browser/extensions/settings_api_helpers.h"
+#include "chrome/browser/prefs/session_startup_pref.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/pref_names.h"
 #include "components/autofill/core/common/autofill_pref_names.h"
 #include "components/bookmarks/common/bookmark_pref_names.h"
 #include "components/browsing_data/core/pref_names.h"
 #include "components/content_settings/core/common/pref_names.h"
 #include "components/drive/drive_pref_names.h"
 #include "components/password_manager/core/common/password_manager_pref_names.h"
 #include "components/prefs/pref_service.h"
 #include "components/proxy_config/proxy_config_pref_names.h"
 #include "components/proxy_config/proxy_config_pref_names.h"
 #include "components/safe_browsing_db/safe_browsing_prefs.h"
+#include "components/search_engines/search_engines_pref_names.h"
 #include "components/spellcheck/browser/pref_names.h"
 #include "components/translate/core/browser/translate_prefs.h"
 #include "components/translate/core/common/translate_pref_names.h"
 #include "components/url_formatter/url_fixer.h"
 #include "extensions/browser/extension_pref_value_map.h"
 #include "extensions/browser/extension_pref_value_map_factory.h"
 #include "extensions/browser/extension_registry.h"
+#include "extensions/browser/extension_system.h"
+#include "extensions/browser/management_policy.h"
 #include "extensions/common/extension.h"
 
 #if defined(OS_CHROMEOS)
 #include "chrome/browser/chromeos/ownership/owner_settings_service_chromeos.h"
 #include "chrome/browser/chromeos/ownership/owner_settings_service_chromeos_factory.h"
 #include "chrome/browser/chromeos/policy/browser_policy_connector_chromeos.h"
 #include "chrome/browser/chromeos/profiles/profile_helper.h"
 #include "chrome/browser/chromeos/settings/cros_settings.h"
 #include "chromeos/settings/cros_settings_names.h"
 #endif
@@ skipping 47 matching lines @@
   (*s_whitelist)[::prefs::kShowHomeButton] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
 
   // Appearance settings.
   (*s_whitelist)[::prefs::kCurrentThemeID] =
       settings_private::PrefType::PREF_TYPE_STRING;
 #if defined(OS_LINUX) && !defined(OS_CHROMEOS)
   (*s_whitelist)[::prefs::kUsesSystemTheme] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
 #endif
+  (*s_whitelist)[::prefs::kHomePage] =
+      settings_private::PrefType::PREF_TYPE_URL;
+  (*s_whitelist)[::prefs::kHomePageIsNewTabPage] =
+      settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[::prefs::kWebKitDefaultFixedFontSize] =
       settings_private::PrefType::PREF_TYPE_NUMBER;
   (*s_whitelist)[::prefs::kWebKitDefaultFontSize] =
       settings_private::PrefType::PREF_TYPE_NUMBER;
   (*s_whitelist)[::prefs::kWebKitMinimumFontSize] =
       settings_private::PrefType::PREF_TYPE_NUMBER;
   (*s_whitelist)[::prefs::kWebKitFixedFontFamily] =
       settings_private::PrefType::PREF_TYPE_STRING;
   (*s_whitelist)[::prefs::kWebKitSansSerifFontFamily] =
       settings_private::PrefType::PREF_TYPE_STRING;
   (*s_whitelist)[::prefs::kWebKitSerifFontFamily] =
       settings_private::PrefType::PREF_TYPE_STRING;
   (*s_whitelist)[::prefs::kWebKitStandardFontFamily] =
       settings_private::PrefType::PREF_TYPE_STRING;
   (*s_whitelist)[::prefs::kDefaultCharset] =
       settings_private::PrefType::PREF_TYPE_STRING;
 
+  // On startup.
+  (*s_whitelist)[::prefs::kRestoreOnStartup] =
+      settings_private::PrefType::PREF_TYPE_NUMBER;
+  (*s_whitelist)[::prefs::kURLsToRestoreOnStartup] =
+      settings_private::PrefType::PREF_TYPE_LIST;
+
   // Downloads settings.
   (*s_whitelist)[::prefs::kDownloadDefaultDirectory] =
       settings_private::PrefType::PREF_TYPE_STRING;
   (*s_whitelist)[::prefs::kPromptForDownload] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[drive::prefs::kDisableDrive] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
 
   // Printing settings.
   (*s_whitelist)[::prefs::kLocalDiscoveryNotificationsEnabled] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
 
-  // Miscelaneous. TODO(stevenjb): categorize.
+  // Miscellaneous. TODO(stevenjb): categorize.
   (*s_whitelist)[::prefs::kEnableDoNotTrack] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
-  (*s_whitelist)[::prefs::kHomePage] =
-      settings_private::PrefType::PREF_TYPE_URL;
-  (*s_whitelist)[::prefs::kHomePageIsNewTabPage] =
-      settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[::prefs::kApplicationLocale] =
       settings_private::PrefType::PREF_TYPE_STRING;
   (*s_whitelist)[::prefs::kNetworkPredictionOptions] =
       settings_private::PrefType::PREF_TYPE_NUMBER;
   (*s_whitelist)[password_manager::prefs::kPasswordManagerSavingEnabled] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[password_manager::prefs::kCredentialsEnableAutosignin] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[::prefs::kSafeBrowsingEnabled] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[::prefs::kSafeBrowsingExtendedReportingEnabled] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[::prefs::kSearchSuggestEnabled] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
-  (*s_whitelist)[::prefs::kRestoreOnStartup] =
-      settings_private::PrefType::PREF_TYPE_NUMBER;
-  (*s_whitelist)[::prefs::kURLsToRestoreOnStartup] =
-      settings_private::PrefType::PREF_TYPE_LIST;
   (*s_whitelist)[spellcheck::prefs::kSpellCheckDictionaries] =
       settings_private::PrefType::PREF_TYPE_LIST;
   (*s_whitelist)[spellcheck::prefs::kSpellCheckUseSpellingService] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[::prefs::kEnableTranslate] =
       settings_private::PrefType::PREF_TYPE_BOOLEAN;
   (*s_whitelist)[translate::TranslatePrefs::kPrefTranslateBlockedLanguages] =
       settings_private::PrefType::PREF_TYPE_LIST;
 
   // Site Settings prefs.
@@ skipping 200 matching lines @@
     if (!pref)
       return nullptr;
     pref_object.reset(new settings_private::PrefObject());
     pref_object->key = pref->name();
     pref_object->type = GetType(name, pref->GetType());
     pref_object->value.reset(pref->GetValue()->DeepCopy());
   }
 
 #if defined(OS_CHROMEOS)
   if (IsPrefPrimaryUserControlled(name)) {
-    pref_object->policy_source =
-        settings_private::PolicySource::POLICY_SOURCE_PRIMARY_USER;
-    pref_object->policy_enforcement =
-        settings_private::PolicyEnforcement::POLICY_ENFORCEMENT_ENFORCED;
-    pref_object->policy_source_name.reset(
+    pref_object->controlled_by =
+        settings_private::ControlledBy::CONTROLLED_BY_PRIMARY_USER;
+    pref_object->enforcement =
+        settings_private::Enforcement::ENFORCEMENT_ENFORCED;
+    pref_object->controlled_by_name.reset(
         new std::string(user_manager::UserManager::Get()
                             ->GetPrimaryUser()
                             ->GetAccountId()
                             .GetUserEmail()));
     return pref_object;
   }
+
   if (IsPrefEnterpriseManaged(name)) {
     // Enterprise managed prefs are treated the same as device policy restricted
     // prefs in the UI.
-    pref_object->policy_source =
-        settings_private::PolicySource::POLICY_SOURCE_DEVICE_POLICY;
-    pref_object->policy_enforcement =
-        settings_private::PolicyEnforcement::POLICY_ENFORCEMENT_ENFORCED;
+    pref_object->controlled_by =
+        settings_private::ControlledBy::CONTROLLED_BY_DEVICE_POLICY;
+    pref_object->enforcement =
+        settings_private::Enforcement::ENFORCEMENT_ENFORCED;
     return pref_object;
   }
 #endif
 
   if (pref && pref->IsManaged()) {
-    pref_object->policy_source =
-        settings_private::PolicySource::POLICY_SOURCE_USER_POLICY;
-    pref_object->policy_enforcement =
-        settings_private::PolicyEnforcement::POLICY_ENFORCEMENT_ENFORCED;
+    pref_object->controlled_by =
+        settings_private::ControlledBy::CONTROLLED_BY_USER_POLICY;
+    pref_object->enforcement =
+        settings_private::Enforcement::ENFORCEMENT_ENFORCED;
     return pref_object;
   }
+
   if (pref && pref->IsRecommended()) {
-    pref_object->policy_source =
-        settings_private::PolicySource::POLICY_SOURCE_USER_POLICY;
-    pref_object->policy_enforcement =
-        settings_private::PolicyEnforcement::POLICY_ENFORCEMENT_RECOMMENDED;
+    pref_object->controlled_by =
+        settings_private::ControlledBy::CONTROLLED_BY_USER_POLICY;
+    pref_object->enforcement =
+        settings_private::Enforcement::ENFORCEMENT_RECOMMENDED;
     pref_object->recommended_value.reset(
         pref->GetRecommendedValue()->DeepCopy());
     return pref_object;
   }
 
 #if defined(OS_CHROMEOS)
   if (IsPrefOwnerControlled(name)) {
     // Check for owner controlled after managed checks because if there is a
     // device policy there is no "owner". (In the unlikely case that both
     // situations apply, either badge is potentially relevant, so the order
     // is somewhat arbitrary).
-    pref_object->policy_source =
-        settings_private::PolicySource::POLICY_SOURCE_OWNER;
-    pref_object->policy_enforcement =
-        settings_private::PolicyEnforcement::POLICY_ENFORCEMENT_ENFORCED;
-    pref_object->policy_source_name.reset(new std::string(
+    pref_object->controlled_by =
+        settings_private::ControlledBy::CONTROLLED_BY_OWNER;
+    pref_object->enforcement =
+        settings_private::Enforcement::ENFORCEMENT_ENFORCED;
+    pref_object->controlled_by_name.reset(new std::string(
         user_manager::UserManager::Get()->GetOwnerAccountId().GetUserEmail()));
     return pref_object;
   }
 #endif
 
-  if (pref && pref->IsExtensionControlled()) {
-    std::string extension_id =
-        ExtensionPrefValueMapFactory::GetForBrowserContext(profile_)
-            ->GetExtensionControllingPref(pref->name());
-    const Extension* extension = ExtensionRegistry::Get(profile_)->
-        GetExtensionById(extension_id, ExtensionRegistry::ENABLED);
-    if (extension) {
-      pref_object->policy_source =
-          settings_private::PolicySource::POLICY_SOURCE_EXTENSION;
-      pref_object->policy_enforcement =
-          settings_private::PolicyEnforcement::POLICY_ENFORCEMENT_ENFORCED;
-      pref_object->extension_id.reset(new std::string(extension_id));
-      pref_object->policy_source_name.reset(new std::string(extension->name()));
-      return pref_object;
-    }
-  }
-  if (pref && (!pref->IsUserModifiable() || IsPrefSupervisorControlled(name))) {
-    // TODO(stevenjb): Investigate whether either of these should be badged.
-    pref_object->read_only.reset(new bool(true));
+  const Extension* extension = GetExtensionControllingPref(*pref_object);
+  if (extension) {
+    pref_object->controlled_by =
+        settings_private::ControlledBy::CONTROLLED_BY_EXTENSION;
+    pref_object->enforcement =
+        settings_private::Enforcement::ENFORCEMENT_ENFORCED;
+    pref_object->extension_id.reset(new std::string(extension->id()));
+    pref_object->controlled_by_name.reset(new std::string(extension->name()));
+    bool can_be_disabled = !ExtensionSystem::Get(profile_)->management_policy()
+        ->MustRemainEnabled(extension, nullptr);
+    pref_object->extension_can_be_disabled.reset(new bool(can_be_disabled));
     return pref_object;
   }
 
+  // TODO(dbeam): surface !IsUserModifiable or IsPrefSupervisorControlled?
+
   return pref_object;
 }
 
 PrefsUtil::SetPrefResult PrefsUtil::SetPref(const std::string& pref_name,
                                             const base::Value* value) {
   if (IsCrosSetting(pref_name))
     return SetCrosSettingsPref(pref_name, value);
 
   PrefService* pref_service = FindServiceForPref(pref_name);
 
@@ skipping 201 matching lines @@
 }
 
 bool PrefsUtil::IsCrosSetting(const std::string& pref_name) {
 #if defined(OS_CHROMEOS)
   return CrosSettings::Get()->IsCrosSettings(pref_name);
 #else
   return false;
 #endif
 }
 
+const Extension* PrefsUtil::GetExtensionControllingPref(
+    const settings_private::PrefObject& pref_object) {

[stevenjb, 2016/11/12 01:31:46]

Can we add a comment here, similar to what's in the CL description? It was not
at all obvious that GetExtensionControllingPref() does not do what the name
implies. Clearly I should have investigated that more thoroughly, but let's at
least give the next person who comes along some breadcrumbs.

[Dan Beam, 2016/11/15 05:38:39]

Done.

+  if (pref_object.key == ::prefs::kHomePage)
+    return GetExtensionOverridingHomepage(profile_);
+
+  if (pref_object.key == ::prefs::kRestoreOnStartup) {
+    int session_startup_type;
+    CHECK(pref_object.value->GetAsInteger(&session_startup_type));
+    if (session_startup_type == SessionStartupPref::kPrefValueNewTab)
+      return GetExtensionOverridingNewTabPage(profile_);
+    if (session_startup_type == SessionStartupPref::kPrefValueURLs)
+      return GetExtensionOverridingStartupPages(profile_);
+  }
+
+  if (pref_object.key == ::prefs::kDefaultSearchProviderEnabled)
+    return GetExtensionOverridingSearchEngine(profile_);
+
+  if (pref_object.key == proxy_config::prefs::kProxy)
+    return GetExtensionOverridingProxy(profile_);
+
+  return nullptr;
+}
+
 }  // namespace extensions