Migrate WebKit "global script" font prefs.

chrome/browser/ui/prefs/prefs_tab_helper.cc

 // Copyright (c) 2012 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/ui/prefs/prefs_tab_helper.h"
 
 #include "base/string_util.h"
 #include "base/stringprintf.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/prefs/overlay_user_pref_store.h"
@@ skipping 17 matching lines @@
 using content::WebContents;
 
 namespace {
 
 static void RegisterFontsAndCharsetPrefs(PrefService* prefs) {
   WebPreferences pref_defaults;
 
   prefs->RegisterLocalizedStringPref(prefs::kDefaultCharset,
                                      IDS_DEFAULT_ENCODING,
                                      PrefService::SYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitStandardFontFamily,
-                                     IDS_STANDARD_FONT_FAMILY,
-                                     PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitFixedFontFamily,
-                                     IDS_FIXED_FONT_FAMILY,
-                                     PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitSerifFontFamily,
-                                     IDS_SERIF_FONT_FAMILY,
-                                     PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitSansSerifFontFamily,
-                                     IDS_SANS_SERIF_FONT_FAMILY,
-                                     PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitCursiveFontFamily,
-                                     IDS_CURSIVE_FONT_FAMILY,
-                                     PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitFantasyFontFamily,
-                                     IDS_FANTASY_FONT_FAMILY,
-                                     PrefService::UNSYNCABLE_PREF);
   prefs->RegisterLocalizedIntegerPref(prefs::kWebKitDefaultFontSize,
                                       IDS_DEFAULT_FONT_SIZE,
                                       PrefService::UNSYNCABLE_PREF);
   prefs->RegisterLocalizedIntegerPref(prefs::kWebKitDefaultFixedFontSize,
                                       IDS_DEFAULT_FIXED_FONT_SIZE,
                                       PrefService::UNSYNCABLE_PREF);
   prefs->RegisterLocalizedIntegerPref(prefs::kWebKitMinimumFontSize,
                                       IDS_MINIMUM_FONT_SIZE,
                                       PrefService::UNSYNCABLE_PREF);
   prefs->RegisterLocalizedIntegerPref(prefs::kWebKitMinimumLogicalFontSize,
                                       IDS_MINIMUM_LOGICAL_FONT_SIZE,
                                       PrefService::UNSYNCABLE_PREF);
+
+  // These are only registered to be used in migration.
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitOldStandardFontFamily,
+                                     IDS_STANDARD_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitOldFixedFontFamily,
+                                     IDS_FIXED_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitOldSerifFontFamily,
+                                     IDS_SERIF_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitOldSansSerifFontFamily,
+                                     IDS_SANS_SERIF_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitOldCursiveFontFamily,
+                                     IDS_CURSIVE_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitOldFantasyFontFamily,
+                                     IDS_FANTASY_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalStandardFontFamily,
+                                     IDS_STANDARD_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalFixedFontFamily,
+                                     IDS_FIXED_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalSerifFontFamily,
+                                     IDS_SERIF_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalSansSerifFontFamily,
+                                     IDS_SANS_SERIF_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalCursiveFontFamily,
+                                     IDS_CURSIVE_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalFantasyFontFamily,
+                                     IDS_FANTASY_FONT_FAMILY,
+                                     PrefService::UNSYNCABLE_PREF);
 }
 
 // The list of prefs we want to observe.
 const char* kPrefsToObserve[] = {
   prefs::kDefaultZoomLevel,
   prefs::kGlobalDefaultCharset,
   prefs::kEnableReferrers,
   prefs::kWebKitAllowDisplayingInsecureContent,
   prefs::kWebKitAllowRunningInsecureContent,
-  prefs::kWebKitGlobalCursiveFontFamily,
   prefs::kWebKitGlobalDefaultFixedFontSize,
   prefs::kWebKitGlobalDefaultFontSize,
-  prefs::kWebKitGlobalFantasyFontFamily,
-  prefs::kWebKitGlobalFixedFontFamily,
   prefs::kWebKitGlobalJavascriptEnabled,
   prefs::kWebKitJavaEnabled,
   prefs::kWebKitGlobalLoadsImagesAutomatically,
   prefs::kWebKitGlobalMinimumFontSize,
   prefs::kWebKitGlobalMinimumLogicalFontSize,
   prefs::kWebKitGlobalPluginsEnabled,
-  prefs::kWebKitGlobalSansSerifFontFamily,
-  prefs::kWebKitGlobalSerifFontFamily,
-  prefs::kWebKitGlobalStandardFontFamily,
   prefs::kWebkitTabsToLinks,
   prefs::kWebKitUsesUniversalDetector
 };
 
 const int kPrefsToObserveLength = arraysize(kPrefsToObserve);
 
 // Registers a preference under the path |map_name| for each script used for
 // per-script font prefs.  For example, if |map_name| is "fonts.serif", then
 // "fonts.serif.Arab", "fonts.serif.Hang", etc. are registered.
 void RegisterFontFamilyMap(PrefService* prefs, const char* map_name) {
@@ skipping 134 matching lines @@
 // causes a warning due to comparison of unsigned expression < 0.
 const size_t kPerScriptFontDefaultsLength = arraysize(kPerScriptFontDefaults);
 #endif
 
 const struct {
   const char* from;
   const char* to;
 } kPrefNamesToMigrate[] = {
   { prefs::kDefaultCharset,
     prefs::kGlobalDefaultCharset },
-  { prefs::kWebKitCursiveFontFamily,
-    prefs::kWebKitGlobalCursiveFontFamily },
   { prefs::kWebKitDefaultFixedFontSize,
     prefs::kWebKitGlobalDefaultFixedFontSize },
   { prefs::kWebKitDefaultFontSize,
     prefs::kWebKitGlobalDefaultFontSize },
-  { prefs::kWebKitFantasyFontFamily,
-    prefs::kWebKitGlobalFantasyFontFamily },
-  { prefs::kWebKitFixedFontFamily,
-    prefs::kWebKitGlobalFixedFontFamily },
   { prefs::kWebKitMinimumFontSize,
     prefs::kWebKitGlobalMinimumFontSize },
   { prefs::kWebKitMinimumLogicalFontSize,
     prefs::kWebKitGlobalMinimumLogicalFontSize },
-  { prefs::kWebKitSansSerifFontFamily,
-    prefs::kWebKitGlobalSansSerifFontFamily },
-  { prefs::kWebKitSerifFontFamily,
-    prefs::kWebKitGlobalSerifFontFamily },
-  { prefs::kWebKitStandardFontFamily,
-    prefs::kWebKitGlobalStandardFontFamily },
+
+  // Migrate old-style "standard_font_family" font prefs to
+  // "fonts.standard.Zyyy". These prefs will exist if the migration to global

[Peter Kasting, 2012/05/11 22:01:06]

Nit: Should you explain "Zyyy" here?  Maybe "to 'fonts.standard.<blah>', where
<blah> is the such-and-such constant from ICU, chosen because ___"?  (My
suggestion is really vague here because I have absolutely no idea what Zyyy
means)

[falken, 2012/05/14 09:08:23]

I added some more explanation.

+  // prefs (for the per-tab pref mechanism, which has since been removed)
+  // never occurred.
+  { prefs::kWebKitOldCursiveFontFamily,
+    prefs::kWebKitCursiveFontFamily },
+  { prefs::kWebKitOldFantasyFontFamily,
+    prefs::kWebKitFantasyFontFamily },
+  { prefs::kWebKitOldFixedFontFamily,
+    prefs::kWebKitFixedFontFamily },
+  { prefs::kWebKitOldSansSerifFontFamily,
+    prefs::kWebKitSansSerifFontFamily },
+  { prefs::kWebKitOldSerifFontFamily,
+    prefs::kWebKitSerifFontFamily },
+  { prefs::kWebKitOldStandardFontFamily,
+    prefs::kWebKitStandardFontFamily },
+
+  // Migrate "global" prefs. These will exist if the migration to global prefs
+  // (for the per-tab pref mechanism, which has since been removed) occurred.
+  { prefs::kWebKitGlobalCursiveFontFamily,
+    prefs::kWebKitCursiveFontFamily },
+  { prefs::kWebKitGlobalFantasyFontFamily,
+    prefs::kWebKitFantasyFontFamily },
+  { prefs::kWebKitGlobalFixedFontFamily,
+    prefs::kWebKitFixedFontFamily },
+  { prefs::kWebKitGlobalSansSerifFontFamily,
+    prefs::kWebKitSansSerifFontFamily },
+  { prefs::kWebKitGlobalSerifFontFamily,
+    prefs::kWebKitSerifFontFamily },
+  { prefs::kWebKitGlobalStandardFontFamily,
+    prefs::kWebKitStandardFontFamily }
 };
 
 const int kPrefsToMigrateLength = ARRAYSIZE_UNSAFE(kPrefNamesToMigrate);
 
 static void MigratePreferences(PrefService* prefs) {
   RegisterFontsAndCharsetPrefs(prefs);
   for (int i = 0; i < kPrefsToMigrateLength; ++i) {
     const PrefService::Preference *pref =
         prefs->FindPreference(kPrefNamesToMigrate[i].from);
     if (!pref) continue;
@@ skipping 102 matching lines @@
                                      PrefService::SYNCABLE_PREF);
 #else
   // Not used in OSX.
   prefs->RegisterLocalizedStringPref(prefs::kAcceptLanguages,
                                      IDS_ACCEPT_LANGUAGES,
                                      PrefService::UNSYNCABLE_PREF);
 #endif
   prefs->RegisterLocalizedStringPref(prefs::kGlobalDefaultCharset,
                                      IDS_DEFAULT_ENCODING,
                                      PrefService::SYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalStandardFontFamily,
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitStandardFontFamily,
                                      IDS_STANDARD_FONT_FAMILY,
                                      PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalFixedFontFamily,
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitFixedFontFamily,
                                      IDS_FIXED_FONT_FAMILY,
                                      PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalSerifFontFamily,
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitSerifFontFamily,
                                      IDS_SERIF_FONT_FAMILY,
                                      PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalSansSerifFontFamily,
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitSansSerifFontFamily,
                                      IDS_SANS_SERIF_FONT_FAMILY,
                                      PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalCursiveFontFamily,
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitCursiveFontFamily,
                                      IDS_CURSIVE_FONT_FAMILY,
                                      PrefService::UNSYNCABLE_PREF);
-  prefs->RegisterLocalizedStringPref(prefs::kWebKitGlobalFantasyFontFamily,
+  prefs->RegisterLocalizedStringPref(prefs::kWebKitFantasyFontFamily,
                                      IDS_FANTASY_FONT_FAMILY,
                                      PrefService::UNSYNCABLE_PREF);
 
   // Register per-script font prefs that have defaults.
 #if defined(OS_CHROMEOS) || defined(OS_MACOSX) || defined(OS_WIN)
   // As explained by its definition, kPerScriptFontDefaultsLength is only
   // defined for platforms where it would be non-zero.
   std::string locale = g_browser_process->GetApplicationLocale();
   for (size_t i = 0; i < kPerScriptFontDefaultsLength; ++i) {
     const PerScriptFontDefault& pref = kPerScriptFontDefaults[i];
     // Suppress default per-script font when the script matches the browser's
     // locale.  Otherwise, the default would override the user's preferences
-    // when viewing pages in their native language.  This can be removed when
-    // per-script fonts are added to Preferences UI.

[Peter Kasting, 2012/05/11 22:01:06]

So, this can never be removed now?

[falken, 2012/05/14 09:08:23]

The original idea was for per-script fonts to be part of the built-in Settings
UI. That way, if Chrome upgrades and the user finds his fonts have been
overwritten, he would be able to go into Settings and fix it.

But that won't happen now; instead the Font Settings Extension API must be used.
Maybe if it turns out access to per-script settings in the extension model is
easy enough, or it turns out not to really be a problem, we can remove these
lines then.

[Peter Kasting, 2012/05/14 18:18:32]

Perhaps you could write some comments about this?

+    // when viewing pages in their native language.
     if (!StartsWithASCII(locale, pref.native_locale, false)) {
       prefs->RegisterLocalizedStringPref(pref.pref_name,
                                          pref.resource_id,
                                          PrefService::UNSYNCABLE_PREF);
     }
   }
 #endif
 
   // Register the rest of the per-script font prefs.
   RegisterFontFamilyMap(prefs, prefs::kWebKitStandardFontFamilyMap);
@@ skipping 71 matching lines @@
 
 void PrefsTabHelper::UpdateRendererPreferences() {
   renderer_preferences_util::UpdateFromSystemSettings(
       web_contents_->GetMutableRendererPrefs(), GetProfile());
   web_contents_->GetRenderViewHost()->SyncRendererPrefs();
 }
 
 Profile* PrefsTabHelper::GetProfile() {
   return Profile::FromBrowserContext(web_contents_->GetBrowserContext());
 }