src/com/android/browser/BrowserSettings.java

   1
   2 /*
   3  * Copyright (C) 2007 The Android Open Source Project
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package com.android.browser;
  19
  20 import com.google.android.providers.GoogleSettings.Partner;
  21
  22 import android.content.ContentResolver;
  23 import android.content.Context;
  24 import android.content.pm.ActivityInfo;
  25 import android.content.SharedPreferences;
  26 import android.content.SharedPreferences.Editor;
  27 import android.preference.PreferenceActivity;
  28 import android.preference.PreferenceScreen;
  29 import android.webkit.CookieManager;
  30 import android.webkit.GeolocationPermissions;
  31 import android.webkit.ValueCallback;
  32 import android.webkit.WebView;
  33 import android.webkit.WebViewDatabase;
  34 import android.webkit.WebIconDatabase;
  35 import android.webkit.WebSettings;
  36 import android.webkit.WebStorage;
  37 import android.preference.PreferenceManager;
  38 import android.provider.Browser;
  39
  40 import java.util.HashMap;
  41 import java.util.Map;
  42 import java.util.Set;
  43 import java.util.Observable;
  44
  45 /*
  46  * Package level class for storing various WebView and Browser settings. To use
  47  * this class:
  48  * BrowserSettings s = BrowserSettings.getInstance();
  49  * s.addObserver(webView.getSettings());
  50  * s.loadFromDb(context); // Only needed on app startup
  51  * s.javaScriptEnabled = true;
  52  * ... // set any other settings
  53  * s.update(); // this will update all the observers
  54  *
  55  * To remove an observer:
  56  * s.deleteObserver(webView.getSettings());
  57  */
  58 class BrowserSettings extends Observable {
  59
  60     // Private variables for settings
  61     // NOTE: these defaults need to be kept in sync with the XML
  62     // until the performance of PreferenceManager.setDefaultValues()
  63     // is improved.
  64     private boolean loadsImagesAutomatically = true;
  65     private boolean javaScriptEnabled = true;
  66     private boolean pluginsEnabled = true;
  67     private boolean javaScriptCanOpenWindowsAutomatically = false;
  68     private boolean showSecurityWarnings = true;
  69     private boolean rememberPasswords = true;
  70     private boolean saveFormData = true;
  71     private boolean openInBackground = false;
  72     private String defaultTextEncodingName;
  73     private String homeUrl = "";
  74     private boolean loginInitialized = false;
  75     private boolean autoFitPage = true;
  76     private boolean landscapeOnly = false;
  77     private boolean loadsPageInOverviewMode = true;
  78     private boolean showDebugSettings = false;
  79     // HTML5 API flags
  80     private boolean appCacheEnabled = true;
  81     private boolean databaseEnabled = true;
  82     private boolean domStorageEnabled = true;
  83     private boolean geolocationEnabled = true;
  84     private boolean workersEnabled = true;  // only affects V8. JSC does not have a similar setting
  85     // HTML5 API configuration params
  86     private long appCacheMaxSize = Long.MAX_VALUE;
  87     private String appCachePath;  // default value set in loadFromDb().
  88     private String databasePath; // default value set in loadFromDb()
  89     private String geolocationDatabasePath; // default value set in loadFromDb()
  90     private WebStorageSizeManager webStorageSizeManager;
  91
  92     private String jsFlags = "";
  93
  94     private final static String TAG = "BrowserSettings";
  95
  96     // Development settings
  97     public WebSettings.LayoutAlgorithm layoutAlgorithm =
  98         WebSettings.LayoutAlgorithm.NARROW_COLUMNS;
  99     private boolean useWideViewPort = true;
 100     private int userAgent = 0;
 101     private boolean tracing = false;
 102     private boolean lightTouch = false;
 103     private boolean navDump = false;
 104
 105     // By default the error console is shown once the user navigates to about:debug.
 106     // The setting can be then toggled from the settings menu.
 107     private boolean showConsole = true;
 108
 109     // Browser only settings
 110     private boolean doFlick = false;
 111
 112     // Private preconfigured values
 113     private static int minimumFontSize = 8;
 114     private static int minimumLogicalFontSize = 8;
 115     private static int defaultFontSize = 16;
 116     private static int defaultFixedFontSize = 13;
 117     private static WebSettings.TextSize textSize =
 118         WebSettings.TextSize.NORMAL;
 119     private static WebSettings.ZoomDensity zoomDensity =
 120         WebSettings.ZoomDensity.MEDIUM;
 121
 122     // Preference keys that are used outside this class
 123     public final static String PREF_CLEAR_CACHE = "privacy_clear_cache";
 124     public final static String PREF_CLEAR_COOKIES = "privacy_clear_cookies";
 125     public final static String PREF_CLEAR_HISTORY = "privacy_clear_history";
 126     public final static String PREF_HOMEPAGE = "homepage";
 127     public final static String PREF_CLEAR_FORM_DATA =
 128             "privacy_clear_form_data";
 129     public final static String PREF_CLEAR_PASSWORDS =
 130             "privacy_clear_passwords";
 131     public final static String PREF_EXTRAS_RESET_DEFAULTS =
 132             "reset_default_preferences";
 133     public final static String PREF_DEBUG_SETTINGS = "debug_menu";
 134     public final static String PREF_WEBSITE_SETTINGS = "website_settings";
 135     public final static String PREF_TEXT_SIZE = "text_size";
 136     public final static String PREF_DEFAULT_ZOOM = "default_zoom";
 137     public final static String PREF_DEFAULT_TEXT_ENCODING =
 138             "default_text_encoding";
 139     public final static String PREF_CLEAR_GEOLOCATION_ACCESS =
 140             "privacy_clear_geolocation_access";
 141
 142     private static final String DESKTOP_USERAGENT = "Mozilla/5.0 (Macintosh; " +
 143             "U; Intel Mac OS X 10_5_7; en-us) AppleWebKit/530.17 (KHTML, " +
 144             "like Gecko) Version/4.0 Safari/530.17";
 145
 146     private static final String IPHONE_USERAGENT = "Mozilla/5.0 (iPhone; U; " +
 147             "CPU iPhone OS 3_0 like Mac OS X; en-us) AppleWebKit/528.18 " +
 148             "(KHTML, like Gecko) Version/4.0 Mobile/7A341 Safari/528.16";
 149
 150     // Value to truncate strings when adding them to a TextView within
 151     // a ListView
 152     public final static int MAX_TEXTVIEW_LEN = 80;
 153
 154     private TabControl mTabControl;
 155
 156     // Single instance of the BrowserSettings for use in the Browser app.
 157     private static BrowserSettings sSingleton;
 158
 159     // Private map of WebSettings to Observer objects used when deleting an
 160     // observer.
 161     private HashMap<WebSettings,Observer> mWebSettingsToObservers =
 162         new HashMap<WebSettings,Observer>();
 163
 164     /*
 165      * An observer wrapper for updating a WebSettings object with the new
 166      * settings after a call to BrowserSettings.update().
 167      */
 168     static class Observer implements java.util.Observer {
 169         // Private WebSettings object that will be updated.
 170         private WebSettings mSettings;
 171
 172         Observer(WebSettings w) {
 173             mSettings = w;
 174         }
 175
 176         public void update(Observable o, Object arg) {
 177             BrowserSettings b = (BrowserSettings)o;
 178             WebSettings s = mSettings;
 179
 180             s.setLayoutAlgorithm(b.layoutAlgorithm);
 181             if (b.userAgent == 0) {
 182                 // use the default ua string
 183                 s.setUserAgentString(null);
 184             } else if (b.userAgent == 1) {
 185                 s.setUserAgentString(DESKTOP_USERAGENT);
 186             } else if (b.userAgent == 2) {
 187                 s.setUserAgentString(IPHONE_USERAGENT);
 188             }
 189             s.setUseWideViewPort(b.useWideViewPort);
 190             s.setLoadsImagesAutomatically(b.loadsImagesAutomatically);
 191             s.setJavaScriptEnabled(b.javaScriptEnabled);
 192             s.setPluginsEnabled(b.pluginsEnabled);
 193             s.setJavaScriptCanOpenWindowsAutomatically(
 194                     b.javaScriptCanOpenWindowsAutomatically);
 195             s.setDefaultTextEncodingName(b.defaultTextEncodingName);
 196             s.setMinimumFontSize(b.minimumFontSize);
 197             s.setMinimumLogicalFontSize(b.minimumLogicalFontSize);
 198             s.setDefaultFontSize(b.defaultFontSize);
 199             s.setDefaultFixedFontSize(b.defaultFixedFontSize);
 200             s.setNavDump(b.navDump);
 201             s.setTextSize(b.textSize);
 202             s.setDefaultZoom(b.zoomDensity);
 203             s.setLightTouchEnabled(b.lightTouch);
 204             s.setSaveFormData(b.saveFormData);
 205             s.setSavePassword(b.rememberPasswords);
 206             s.setLoadWithOverviewMode(b.loadsPageInOverviewMode);
 207
 208             // WebView inside Browser doesn't want initial focus to be set.
 209             s.setNeedInitialFocus(false);
 210             // Browser supports multiple windows
 211             s.setSupportMultipleWindows(true);
 212
 213             // HTML5 API flags
 214             s.setAppCacheEnabled(b.appCacheEnabled);
 215             s.setDatabaseEnabled(b.databaseEnabled);
 216             s.setDomStorageEnabled(b.domStorageEnabled);
 217             s.setWorkersEnabled(b.workersEnabled);  // This only affects V8.
 218             s.setGeolocationEnabled(b.geolocationEnabled);
 219
 220             // HTML5 configuration parameters.
 221             s.setAppCacheMaxSize(b.appCacheMaxSize);
 222             s.setAppCachePath(b.appCachePath);
 223             s.setDatabasePath(b.databasePath);
 224             s.setGeolocationDatabasePath(b.geolocationDatabasePath);
 225
 226             // Enable/Disable the error console.
 227             b.mTabControl.getBrowserActivity().setShouldShowErrorConsole(
 228                     b.showDebugSettings && b.showConsole);
 229         }
 230     }
 231
 232     /**
 233      * Load settings from the browser app's database.
 234      * NOTE: Strings used for the preferences must match those specified
 235      * in the browser_preferences.xml
 236      * @param ctx A Context object used to query the browser's settings
 237      *            database. If the database exists, the saved settings will be
 238      *            stored in this BrowserSettings object. This will update all
 239      *            observers of this object.
 240      */
 241     public void loadFromDb(Context ctx) {
 242         SharedPreferences p =
 243                 PreferenceManager.getDefaultSharedPreferences(ctx);
 244         // Set the default value for the Application Caches path.
 245         appCachePath = ctx.getDir("appcache", 0).getPath();
 246         // Determine the maximum size of the application cache.
 247         webStorageSizeManager = new WebStorageSizeManager(
 248                 ctx,
 249                 new WebStorageSizeManager.StatFsDiskInfo(appCachePath),
 250                 new WebStorageSizeManager.WebKitAppCacheInfo(appCachePath));
 251         appCacheMaxSize = webStorageSizeManager.getAppCacheMaxSize();
 252         // Set the default value for the Database path.
 253         databasePath = ctx.getDir("databases", 0).getPath();
 254         // Set the default value for the Geolocation database path.
 255         geolocationDatabasePath = ctx.getDir("geolocation", 0).getPath();
 256
 257         homeUrl = getFactoryResetHomeUrl(ctx);
 258
 259         // Load the defaults from the xml
 260         // This call is TOO SLOW, need to manually keep the defaults
 261         // in sync
 262         //PreferenceManager.setDefaultValues(ctx, R.xml.browser_preferences);
 263         syncSharedPreferences(p);
 264     }
 265
 266     /* package */ void syncSharedPreferences(SharedPreferences p) {
 267
 268         homeUrl =
 269             p.getString(PREF_HOMEPAGE, homeUrl);
 270
 271         loadsImagesAutomatically = p.getBoolean("load_images",
 272                 loadsImagesAutomatically);
 273         javaScriptEnabled = p.getBoolean("enable_javascript",
 274                 javaScriptEnabled);
 275         pluginsEnabled = p.getBoolean("enable_plugins",
 276                 pluginsEnabled);
 277         javaScriptCanOpenWindowsAutomatically = !p.getBoolean(
 278             "block_popup_windows",
 279             !javaScriptCanOpenWindowsAutomatically);
 280         showSecurityWarnings = p.getBoolean("show_security_warnings",
 281                 showSecurityWarnings);
 282         rememberPasswords = p.getBoolean("remember_passwords",
 283                 rememberPasswords);
 284         saveFormData = p.getBoolean("save_formdata",
 285                 saveFormData);
 286         boolean accept_cookies = p.getBoolean("accept_cookies",
 287                 CookieManager.getInstance().acceptCookie());
 288         CookieManager.getInstance().setAcceptCookie(accept_cookies);
 289         openInBackground = p.getBoolean("open_in_background", openInBackground);
 290         loginInitialized = p.getBoolean("login_initialized", loginInitialized);
 291         textSize = WebSettings.TextSize.valueOf(
 292                 p.getString(PREF_TEXT_SIZE, textSize.name()));
 293         zoomDensity = WebSettings.ZoomDensity.valueOf(
 294                 p.getString(PREF_DEFAULT_ZOOM, zoomDensity.name()));
 295         autoFitPage = p.getBoolean("autofit_pages", autoFitPage);
 296         loadsPageInOverviewMode = p.getBoolean("load_page",
 297                 loadsPageInOverviewMode);
 298         boolean landscapeOnlyTemp =
 299                 p.getBoolean("landscape_only", landscapeOnly);
 300         if (landscapeOnlyTemp != landscapeOnly) {
 301             landscapeOnly = landscapeOnlyTemp;
 302             mTabControl.getBrowserActivity().setRequestedOrientation(
 303                     landscapeOnly ? ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE
 304                     : ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED);
 305         }
 306         useWideViewPort = true; // use wide view port for either setting
 307         if (autoFitPage) {
 308             layoutAlgorithm = WebSettings.LayoutAlgorithm.NARROW_COLUMNS;
 309         } else {
 310             layoutAlgorithm = WebSettings.LayoutAlgorithm.NORMAL;
 311         }
 312         defaultTextEncodingName =
 313                 p.getString(PREF_DEFAULT_TEXT_ENCODING,
 314                         defaultTextEncodingName);
 315
 316         showDebugSettings =
 317                 p.getBoolean(PREF_DEBUG_SETTINGS, showDebugSettings);
 318         // Debug menu items have precidence if the menu is visible
 319         if (showDebugSettings) {
 320             boolean small_screen = p.getBoolean("small_screen",
 321                     layoutAlgorithm ==
 322                     WebSettings.LayoutAlgorithm.SINGLE_COLUMN);
 323             if (small_screen) {
 324                 layoutAlgorithm = WebSettings.LayoutAlgorithm.SINGLE_COLUMN;
 325             } else {
 326                 boolean normal_layout = p.getBoolean("normal_layout",
 327                         layoutAlgorithm == WebSettings.LayoutAlgorithm.NORMAL);
 328                 if (normal_layout) {
 329                     layoutAlgorithm = WebSettings.LayoutAlgorithm.NORMAL;
 330                 } else {
 331                     layoutAlgorithm =
 332                             WebSettings.LayoutAlgorithm.NARROW_COLUMNS;
 333                 }
 334             }
 335             useWideViewPort = p.getBoolean("wide_viewport", useWideViewPort);
 336             tracing = p.getBoolean("enable_tracing", tracing);
 337             lightTouch = p.getBoolean("enable_light_touch", lightTouch);
 338             navDump = p.getBoolean("enable_nav_dump", navDump);
 339             doFlick = p.getBoolean("enable_flick", doFlick);
 340             userAgent = Integer.parseInt(p.getString("user_agent", "0"));
 341         }
 342         // JS flags is loaded from DB even if showDebugSettings is false,
 343         // so that it can be set once and be effective all the time.
 344         jsFlags = p.getString("js_engine_flags", "");
 345
 346         // Read the setting for showing/hiding the JS Console always so that should the
 347         // user enable debug settings, we already know if we should show the console.
 348         // The user will never see the console unless they navigate to about:debug,
 349         // regardless of the setting we read here. This setting is only used after debug
 350         // is enabled.
 351         showConsole = p.getBoolean("javascript_console", showConsole);
 352         mTabControl.getBrowserActivity().setShouldShowErrorConsole(
 353                 showDebugSettings && showConsole);
 354
 355         // HTML5 API flags
 356         appCacheEnabled = p.getBoolean("enable_appcache", appCacheEnabled);
 357         databaseEnabled = p.getBoolean("enable_database", databaseEnabled);
 358         domStorageEnabled = p.getBoolean("enable_domstorage", domStorageEnabled);
 359         geolocationEnabled = p.getBoolean("enable_geolocation", geolocationEnabled);
 360         workersEnabled = p.getBoolean("enable_workers", workersEnabled);
 361
 362         update();
 363     }
 364
 365     public String getHomePage() {
 366         return homeUrl;
 367     }
 368
 369     public String getJsFlags() {
 370         return jsFlags;
 371     }
 372
 373     public WebStorageSizeManager getWebStorageSizeManager() {
 374         return webStorageSizeManager;
 375     }
 376
 377     public void setHomePage(Context context, String url) {
 378         Editor ed = PreferenceManager.
 379                 getDefaultSharedPreferences(context).edit();
 380         ed.putString(PREF_HOMEPAGE, url);
 381         ed.commit();
 382         homeUrl = url;
 383     }
 384
 385     public boolean isLoginInitialized() {
 386         return loginInitialized;
 387     }
 388
 389     public void setLoginInitialized(Context context) {
 390         loginInitialized = true;
 391         Editor ed = PreferenceManager.
 392                 getDefaultSharedPreferences(context).edit();
 393         ed.putBoolean("login_initialized", loginInitialized);
 394         ed.commit();
 395     }
 396
 397     public WebSettings.TextSize getTextSize() {
 398         return textSize;
 399     }
 400
 401     public WebSettings.ZoomDensity getDefaultZoom() {
 402         return zoomDensity;
 403     }
 404
 405     public boolean openInBackground() {
 406         return openInBackground;
 407     }
 408
 409     public boolean showSecurityWarnings() {
 410         return showSecurityWarnings;
 411     }
 412
 413     public boolean isTracing() {
 414         return tracing;
 415     }
 416
 417     public boolean isLightTouch() {
 418         return lightTouch;
 419     }
 420
 421     public boolean isNavDump() {
 422         return navDump;
 423     }
 424
 425     public boolean doFlick() {
 426         return doFlick;
 427     }
 428
 429     public boolean showDebugSettings() {
 430         return showDebugSettings;
 431     }
 432
 433     public void toggleDebugSettings() {
 434         showDebugSettings = !showDebugSettings;
 435         navDump = showDebugSettings;
 436         update();
 437     }
 438
 439     /**
 440      * Add a WebSettings object to the list of observers that will be updated
 441      * when update() is called.
 442      *
 443      * @param s A WebSettings object that is strictly tied to the life of a
 444      *            WebView.
 445      */
 446     public Observer addObserver(WebSettings s) {
 447         Observer old = mWebSettingsToObservers.get(s);
 448         if (old != null) {
 449             super.deleteObserver(old);
 450         }
 451         Observer o = new Observer(s);
 452         mWebSettingsToObservers.put(s, o);
 453         super.addObserver(o);
 454         return o;
 455     }
 456
 457     /**
 458      * Delete the given WebSettings observer from the list of observers.
 459      * @param s The WebSettings object to be deleted.
 460      */
 461     public void deleteObserver(WebSettings s) {
 462         Observer o = mWebSettingsToObservers.get(s);
 463         if (o != null) {
 464             mWebSettingsToObservers.remove(s);
 465             super.deleteObserver(o);
 466         }
 467     }
 468
 469     /*
 470      * Package level method for obtaining a single app instance of the
 471      * BrowserSettings.
 472      */
 473     /*package*/ static BrowserSettings getInstance() {
 474         if (sSingleton == null ) {
 475             sSingleton = new BrowserSettings();
 476         }
 477         return sSingleton;
 478     }
 479
 480     /*
 481      * Package level method for associating the BrowserSettings with TabControl
 482      */
 483     /* package */void setTabControl(TabControl tabControl) {
 484         mTabControl = tabControl;
 485     }
 486
 487     /*
 488      * Update all the observers of the object.
 489      */
 490     /*package*/ void update() {
 491         setChanged();
 492         notifyObservers();
 493     }
 494
 495     /*package*/ void clearCache(Context context) {
 496         WebIconDatabase.getInstance().removeAllIcons();
 497         if (mTabControl != null) {
 498             WebView current = mTabControl.getCurrentWebView();
 499             if (current != null) {
 500                 current.clearCache(true);
 501             }
 502         }
 503     }
 504
 505     /*package*/ void clearCookies(Context context) {
 506         CookieManager.getInstance().removeAllCookie();
 507     }
 508
 509     /* package */void clearHistory(Context context) {
 510         ContentResolver resolver = context.getContentResolver();
 511         Browser.clearHistory(resolver);
 512         Browser.clearSearches(resolver);
 513     }
 514
 515     /* package */ void clearFormData(Context context) {
 516         WebViewDatabase.getInstance(context).clearFormData();
 517         if (mTabControl != null) {
 518             mTabControl.getCurrentTopWebView().clearFormData();
 519         }
 520     }
 521
 522     /*package*/ void clearPasswords(Context context) {
 523         WebViewDatabase db = WebViewDatabase.getInstance(context);
 524         db.clearUsernamePassword();
 525         db.clearHttpAuthUsernamePassword();
 526     }
 527
 528     private void maybeDisableWebsiteSettings(Context context) {
 529         PreferenceActivity activity = (PreferenceActivity) context;
 530         final PreferenceScreen screen = (PreferenceScreen)
 531             activity.findPreference(BrowserSettings.PREF_WEBSITE_SETTINGS);
 532         screen.setEnabled(false);
 533         WebStorage.getInstance().getOrigins(new ValueCallback<Map>() {
 534             public void onReceiveValue(Map webStorageOrigins) {
 535                 if ((webStorageOrigins != null) && !webStorageOrigins.isEmpty()) {
 536                     screen.setEnabled(true);
 537                 }
 538             }
 539         });
 540
 541         GeolocationPermissions.getInstance().getOrigins(new ValueCallback<Set>() {
 542             public void onReceiveValue(Set geolocationOrigins) {
 543                 if ((geolocationOrigins != null) && !geolocationOrigins.isEmpty()) {
 544                     screen.setEnabled(true);
 545                 }
 546             }
 547         });
 548     }
 549
 550     /*package*/ void clearDatabases(Context context) {
 551         WebStorage.getInstance().deleteAllData();
 552         maybeDisableWebsiteSettings(context);
 553     }
 554
 555     /*package*/ void clearLocationAccess(Context context) {
 556         GeolocationPermissions.getInstance().clearAll();
 557         maybeDisableWebsiteSettings(context);
 558     }
 559
 560     /*package*/ void resetDefaultPreferences(Context ctx) {
 561         SharedPreferences p =
 562             PreferenceManager.getDefaultSharedPreferences(ctx);
 563         p.edit().clear().commit();
 564         PreferenceManager.setDefaultValues(ctx, R.xml.browser_preferences,
 565                 true);
 566         // reset homeUrl
 567         setHomePage(ctx, getFactoryResetHomeUrl(ctx));
 568         // reset appcache max size
 569         appCacheMaxSize = webStorageSizeManager.getAppCacheMaxSize();
 570     }
 571
 572     private String getFactoryResetHomeUrl(Context context) {
 573         String url = context.getResources().getString(R.string.homepage_base);
 574         if (url.indexOf("{CID}") != -1) {
 575             url = url.replace("{CID}", Partner.getString(context
 576                     .getContentResolver(), Partner.CLIENT_ID, "android-google"));
 577         }
 578         return url;
 579     }
 580
 581     // Private constructor that does nothing.
 582     private BrowserSettings() {
 583     }
 584 }