3 * Copyright (C) 2007 The Android Open Source Project
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 package com.android.browser;
20 import com.google.android.providers.GoogleSettings.Partner;
22 import android.app.ActivityManager;
23 import android.content.ContentResolver;
24 import android.content.Context;
25 import android.content.pm.ActivityInfo;
26 import android.content.SharedPreferences;
27 import android.content.SharedPreferences.Editor;
28 import android.preference.PreferenceActivity;
29 import android.preference.PreferenceScreen;
30 import android.webkit.CookieManager;
31 import android.webkit.GeolocationPermissions;
32 import android.webkit.ValueCallback;
33 import android.webkit.WebView;
34 import android.webkit.WebViewDatabase;
35 import android.webkit.WebIconDatabase;
36 import android.webkit.WebSettings;
37 import android.webkit.WebStorage;
38 import android.preference.PreferenceManager;
39 import android.provider.Browser;
41 import java.util.HashMap;
44 import java.util.Observable;
47 * Package level class for storing various WebView and Browser settings. To use
49 * BrowserSettings s = BrowserSettings.getInstance();
50 * s.addObserver(webView.getSettings());
51 * s.loadFromDb(context); // Only needed on app startup
52 * s.javaScriptEnabled = true;
53 * ... // set any other settings
54 * s.update(); // this will update all the observers
56 * To remove an observer:
57 * s.deleteObserver(webView.getSettings());
59 class BrowserSettings extends Observable {
61 // Private variables for settings
62 // NOTE: these defaults need to be kept in sync with the XML
63 // until the performance of PreferenceManager.setDefaultValues()
65 private boolean loadsImagesAutomatically = true;
66 private boolean javaScriptEnabled = true;
67 private boolean pluginsEnabled = true;
68 private boolean javaScriptCanOpenWindowsAutomatically = false;
69 private boolean showSecurityWarnings = true;
70 private boolean rememberPasswords = true;
71 private boolean saveFormData = true;
72 private boolean openInBackground = false;
73 private String defaultTextEncodingName;
74 private String homeUrl = "";
75 private boolean loginInitialized = false;
76 private boolean autoFitPage = true;
77 private boolean landscapeOnly = false;
78 private boolean loadsPageInOverviewMode = true;
79 private boolean showDebugSettings = false;
81 private boolean appCacheEnabled = true;
82 private boolean databaseEnabled = true;
83 private boolean domStorageEnabled = true;
84 private boolean geolocationEnabled = true;
85 private boolean workersEnabled = true; // only affects V8. JSC does not have a similar setting
86 // HTML5 API configuration params
87 private long appCacheMaxSize = Long.MAX_VALUE;
88 private String appCachePath; // default value set in loadFromDb().
89 private String databasePath; // default value set in loadFromDb()
90 private String geolocationDatabasePath; // default value set in loadFromDb()
91 private WebStorageSizeManager webStorageSizeManager;
93 private String jsFlags = "";
95 private final static String TAG = "BrowserSettings";
97 // Development settings
98 public WebSettings.LayoutAlgorithm layoutAlgorithm =
99 WebSettings.LayoutAlgorithm.NARROW_COLUMNS;
100 private boolean useWideViewPort = true;
101 private int userAgent = 0;
102 private boolean tracing = false;
103 private boolean lightTouch = false;
104 private boolean navDump = false;
106 // By default the error console is shown once the user navigates to about:debug.
107 // The setting can be then toggled from the settings menu.
108 private boolean showConsole = true;
110 // Private preconfigured values
111 private static int minimumFontSize = 8;
112 private static int minimumLogicalFontSize = 8;
113 private static int defaultFontSize = 16;
114 private static int defaultFixedFontSize = 13;
115 private static WebSettings.TextSize textSize =
116 WebSettings.TextSize.NORMAL;
117 private static WebSettings.ZoomDensity zoomDensity =
118 WebSettings.ZoomDensity.MEDIUM;
119 private static int pageCacheCapacity;
121 // Preference keys that are used outside this class
122 public final static String PREF_CLEAR_CACHE = "privacy_clear_cache";
123 public final static String PREF_CLEAR_COOKIES = "privacy_clear_cookies";
124 public final static String PREF_CLEAR_HISTORY = "privacy_clear_history";
125 public final static String PREF_HOMEPAGE = "homepage";
126 public final static String PREF_CLEAR_FORM_DATA =
127 "privacy_clear_form_data";
128 public final static String PREF_CLEAR_PASSWORDS =
129 "privacy_clear_passwords";
130 public final static String PREF_EXTRAS_RESET_DEFAULTS =
131 "reset_default_preferences";
132 public final static String PREF_DEBUG_SETTINGS = "debug_menu";
133 public final static String PREF_WEBSITE_SETTINGS = "website_settings";
134 public final static String PREF_TEXT_SIZE = "text_size";
135 public final static String PREF_DEFAULT_ZOOM = "default_zoom";
136 public final static String PREF_DEFAULT_TEXT_ENCODING =
137 "default_text_encoding";
138 public final static String PREF_CLEAR_GEOLOCATION_ACCESS =
139 "privacy_clear_geolocation_access";
141 private static final String DESKTOP_USERAGENT = "Mozilla/5.0 (Macintosh; " +
142 "U; Intel Mac OS X 10_5_7; en-us) AppleWebKit/530.17 (KHTML, " +
143 "like Gecko) Version/4.0 Safari/530.17";
145 private static final String IPHONE_USERAGENT = "Mozilla/5.0 (iPhone; U; " +
146 "CPU iPhone OS 3_0 like Mac OS X; en-us) AppleWebKit/528.18 " +
147 "(KHTML, like Gecko) Version/4.0 Mobile/7A341 Safari/528.16";
149 // Value to truncate strings when adding them to a TextView within
151 public final static int MAX_TEXTVIEW_LEN = 80;
153 private TabControl mTabControl;
155 // Single instance of the BrowserSettings for use in the Browser app.
156 private static BrowserSettings sSingleton;
158 // Private map of WebSettings to Observer objects used when deleting an
160 private HashMap<WebSettings,Observer> mWebSettingsToObservers =
161 new HashMap<WebSettings,Observer>();
164 * An observer wrapper for updating a WebSettings object with the new
165 * settings after a call to BrowserSettings.update().
167 static class Observer implements java.util.Observer {
168 // Private WebSettings object that will be updated.
169 private WebSettings mSettings;
171 Observer(WebSettings w) {
175 public void update(Observable o, Object arg) {
176 BrowserSettings b = (BrowserSettings)o;
177 WebSettings s = mSettings;
179 s.setLayoutAlgorithm(b.layoutAlgorithm);
180 if (b.userAgent == 0) {
181 // use the default ua string
182 s.setUserAgentString(null);
183 } else if (b.userAgent == 1) {
184 s.setUserAgentString(DESKTOP_USERAGENT);
185 } else if (b.userAgent == 2) {
186 s.setUserAgentString(IPHONE_USERAGENT);
188 s.setUseWideViewPort(b.useWideViewPort);
189 s.setLoadsImagesAutomatically(b.loadsImagesAutomatically);
190 s.setJavaScriptEnabled(b.javaScriptEnabled);
191 s.setPluginsEnabled(b.pluginsEnabled);
192 s.setJavaScriptCanOpenWindowsAutomatically(
193 b.javaScriptCanOpenWindowsAutomatically);
194 s.setDefaultTextEncodingName(b.defaultTextEncodingName);
195 s.setMinimumFontSize(b.minimumFontSize);
196 s.setMinimumLogicalFontSize(b.minimumLogicalFontSize);
197 s.setDefaultFontSize(b.defaultFontSize);
198 s.setDefaultFixedFontSize(b.defaultFixedFontSize);
199 s.setNavDump(b.navDump);
200 s.setTextSize(b.textSize);
201 s.setDefaultZoom(b.zoomDensity);
202 s.setLightTouchEnabled(b.lightTouch);
203 s.setSaveFormData(b.saveFormData);
204 s.setSavePassword(b.rememberPasswords);
205 s.setLoadWithOverviewMode(b.loadsPageInOverviewMode);
206 s.setPageCacheCapacity(pageCacheCapacity);
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);
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);
220 // HTML5 configuration parameters.
221 s.setAppCacheMaxSize(b.appCacheMaxSize);
222 s.setAppCachePath(b.appCachePath);
223 s.setDatabasePath(b.databasePath);
224 s.setGeolocationDatabasePath(b.geolocationDatabasePath);
226 // Enable/Disable the error console.
227 b.mTabControl.getBrowserActivity().setShouldShowErrorConsole(
228 b.showDebugSettings && b.showConsole);
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.
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(
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();
257 homeUrl = getFactoryResetHomeUrl(ctx);
259 // the cost of one cached page is ~3M (measured using nytimes.com). For
260 // low end devices, we only cache one page. For high end devices, we try
261 // to cache more pages, currently choose 5.
262 ActivityManager am = (ActivityManager) ctx
263 .getSystemService(Context.ACTIVITY_SERVICE);
264 if (am.getMemoryClass() > 16) {
265 pageCacheCapacity = 5;
267 pageCacheCapacity = 1;
270 // Load the defaults from the xml
271 // This call is TOO SLOW, need to manually keep the defaults
273 //PreferenceManager.setDefaultValues(ctx, R.xml.browser_preferences);
274 syncSharedPreferences(p);
277 /* package */ void syncSharedPreferences(SharedPreferences p) {
280 p.getString(PREF_HOMEPAGE, homeUrl);
282 loadsImagesAutomatically = p.getBoolean("load_images",
283 loadsImagesAutomatically);
284 javaScriptEnabled = p.getBoolean("enable_javascript",
286 pluginsEnabled = p.getBoolean("enable_plugins",
288 javaScriptCanOpenWindowsAutomatically = !p.getBoolean(
289 "block_popup_windows",
290 !javaScriptCanOpenWindowsAutomatically);
291 showSecurityWarnings = p.getBoolean("show_security_warnings",
292 showSecurityWarnings);
293 rememberPasswords = p.getBoolean("remember_passwords",
295 saveFormData = p.getBoolean("save_formdata",
297 boolean accept_cookies = p.getBoolean("accept_cookies",
298 CookieManager.getInstance().acceptCookie());
299 CookieManager.getInstance().setAcceptCookie(accept_cookies);
300 openInBackground = p.getBoolean("open_in_background", openInBackground);
301 loginInitialized = p.getBoolean("login_initialized", loginInitialized);
302 textSize = WebSettings.TextSize.valueOf(
303 p.getString(PREF_TEXT_SIZE, textSize.name()));
304 zoomDensity = WebSettings.ZoomDensity.valueOf(
305 p.getString(PREF_DEFAULT_ZOOM, zoomDensity.name()));
306 autoFitPage = p.getBoolean("autofit_pages", autoFitPage);
307 loadsPageInOverviewMode = p.getBoolean("load_page",
308 loadsPageInOverviewMode);
309 boolean landscapeOnlyTemp =
310 p.getBoolean("landscape_only", landscapeOnly);
311 if (landscapeOnlyTemp != landscapeOnly) {
312 landscapeOnly = landscapeOnlyTemp;
313 mTabControl.getBrowserActivity().setRequestedOrientation(
314 landscapeOnly ? ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE
315 : ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED);
317 useWideViewPort = true; // use wide view port for either setting
319 layoutAlgorithm = WebSettings.LayoutAlgorithm.NARROW_COLUMNS;
321 layoutAlgorithm = WebSettings.LayoutAlgorithm.NORMAL;
323 defaultTextEncodingName =
324 p.getString(PREF_DEFAULT_TEXT_ENCODING,
325 defaultTextEncodingName);
328 p.getBoolean(PREF_DEBUG_SETTINGS, showDebugSettings);
329 // Debug menu items have precidence if the menu is visible
330 if (showDebugSettings) {
331 boolean small_screen = p.getBoolean("small_screen",
333 WebSettings.LayoutAlgorithm.SINGLE_COLUMN);
335 layoutAlgorithm = WebSettings.LayoutAlgorithm.SINGLE_COLUMN;
337 boolean normal_layout = p.getBoolean("normal_layout",
338 layoutAlgorithm == WebSettings.LayoutAlgorithm.NORMAL);
340 layoutAlgorithm = WebSettings.LayoutAlgorithm.NORMAL;
343 WebSettings.LayoutAlgorithm.NARROW_COLUMNS;
346 useWideViewPort = p.getBoolean("wide_viewport", useWideViewPort);
347 tracing = p.getBoolean("enable_tracing", tracing);
348 lightTouch = p.getBoolean("enable_light_touch", lightTouch);
349 navDump = p.getBoolean("enable_nav_dump", navDump);
350 userAgent = Integer.parseInt(p.getString("user_agent", "0"));
352 // JS flags is loaded from DB even if showDebugSettings is false,
353 // so that it can be set once and be effective all the time.
354 jsFlags = p.getString("js_engine_flags", "");
356 // Read the setting for showing/hiding the JS Console always so that should the
357 // user enable debug settings, we already know if we should show the console.
358 // The user will never see the console unless they navigate to about:debug,
359 // regardless of the setting we read here. This setting is only used after debug
361 showConsole = p.getBoolean("javascript_console", showConsole);
362 mTabControl.getBrowserActivity().setShouldShowErrorConsole(
363 showDebugSettings && showConsole);
366 appCacheEnabled = p.getBoolean("enable_appcache", appCacheEnabled);
367 databaseEnabled = p.getBoolean("enable_database", databaseEnabled);
368 domStorageEnabled = p.getBoolean("enable_domstorage", domStorageEnabled);
369 geolocationEnabled = p.getBoolean("enable_geolocation", geolocationEnabled);
370 workersEnabled = p.getBoolean("enable_workers", workersEnabled);
375 public String getHomePage() {
379 public String getJsFlags() {
383 public WebStorageSizeManager getWebStorageSizeManager() {
384 return webStorageSizeManager;
387 public void setHomePage(Context context, String url) {
388 Editor ed = PreferenceManager.
389 getDefaultSharedPreferences(context).edit();
390 ed.putString(PREF_HOMEPAGE, url);
395 public boolean isLoginInitialized() {
396 return loginInitialized;
399 public void setLoginInitialized(Context context) {
400 loginInitialized = true;
401 Editor ed = PreferenceManager.
402 getDefaultSharedPreferences(context).edit();
403 ed.putBoolean("login_initialized", loginInitialized);
407 public WebSettings.TextSize getTextSize() {
411 public WebSettings.ZoomDensity getDefaultZoom() {
415 public boolean openInBackground() {
416 return openInBackground;
419 public boolean showSecurityWarnings() {
420 return showSecurityWarnings;
423 public boolean isTracing() {
427 public boolean isLightTouch() {
431 public boolean isNavDump() {
435 public boolean showDebugSettings() {
436 return showDebugSettings;
439 public void toggleDebugSettings() {
440 showDebugSettings = !showDebugSettings;
441 navDump = showDebugSettings;
446 * Add a WebSettings object to the list of observers that will be updated
447 * when update() is called.
449 * @param s A WebSettings object that is strictly tied to the life of a
452 public Observer addObserver(WebSettings s) {
453 Observer old = mWebSettingsToObservers.get(s);
455 super.deleteObserver(old);
457 Observer o = new Observer(s);
458 mWebSettingsToObservers.put(s, o);
459 super.addObserver(o);
464 * Delete the given WebSettings observer from the list of observers.
465 * @param s The WebSettings object to be deleted.
467 public void deleteObserver(WebSettings s) {
468 Observer o = mWebSettingsToObservers.get(s);
470 mWebSettingsToObservers.remove(s);
471 super.deleteObserver(o);
476 * Package level method for obtaining a single app instance of the
479 /*package*/ static BrowserSettings getInstance() {
480 if (sSingleton == null ) {
481 sSingleton = new BrowserSettings();
487 * Package level method for associating the BrowserSettings with TabControl
489 /* package */void setTabControl(TabControl tabControl) {
490 mTabControl = tabControl;
494 * Update all the observers of the object.
496 /*package*/ void update() {
501 /*package*/ void clearCache(Context context) {
502 WebIconDatabase.getInstance().removeAllIcons();
503 if (mTabControl != null) {
504 WebView current = mTabControl.getCurrentWebView();
505 if (current != null) {
506 current.clearCache(true);
511 /*package*/ void clearCookies(Context context) {
512 CookieManager.getInstance().removeAllCookie();
515 /* package */void clearHistory(Context context) {
516 ContentResolver resolver = context.getContentResolver();
517 Browser.clearHistory(resolver);
518 Browser.clearSearches(resolver);
521 /* package */ void clearFormData(Context context) {
522 WebViewDatabase.getInstance(context).clearFormData();
523 if (mTabControl != null) {
524 mTabControl.getCurrentTopWebView().clearFormData();
528 /*package*/ void clearPasswords(Context context) {
529 WebViewDatabase db = WebViewDatabase.getInstance(context);
530 db.clearUsernamePassword();
531 db.clearHttpAuthUsernamePassword();
534 private void maybeDisableWebsiteSettings(Context context) {
535 PreferenceActivity activity = (PreferenceActivity) context;
536 final PreferenceScreen screen = (PreferenceScreen)
537 activity.findPreference(BrowserSettings.PREF_WEBSITE_SETTINGS);
538 screen.setEnabled(false);
539 WebStorage.getInstance().getOrigins(new ValueCallback<Map>() {
540 public void onReceiveValue(Map webStorageOrigins) {
541 if ((webStorageOrigins != null) && !webStorageOrigins.isEmpty()) {
542 screen.setEnabled(true);
547 GeolocationPermissions.getInstance().getOrigins(new ValueCallback<Set<String> >() {
548 public void onReceiveValue(Set<String> geolocationOrigins) {
549 if ((geolocationOrigins != null) && !geolocationOrigins.isEmpty()) {
550 screen.setEnabled(true);
556 /*package*/ void clearDatabases(Context context) {
557 WebStorage.getInstance().deleteAllData();
558 maybeDisableWebsiteSettings(context);
561 /*package*/ void clearLocationAccess(Context context) {
562 GeolocationPermissions.getInstance().clearAll();
563 maybeDisableWebsiteSettings(context);
566 /*package*/ void resetDefaultPreferences(Context ctx) {
567 SharedPreferences p =
568 PreferenceManager.getDefaultSharedPreferences(ctx);
569 p.edit().clear().commit();
570 PreferenceManager.setDefaultValues(ctx, R.xml.browser_preferences,
573 setHomePage(ctx, getFactoryResetHomeUrl(ctx));
574 // reset appcache max size
575 appCacheMaxSize = webStorageSizeManager.getAppCacheMaxSize();
578 private String getFactoryResetHomeUrl(Context context) {
579 String url = context.getResources().getString(R.string.homepage_base);
580 if (url.indexOf("{CID}") != -1) {
581 url = url.replace("{CID}", Partner.getString(context
582 .getContentResolver(), Partner.CLIENT_ID, "android-google"));
587 // Private constructor that does nothing.
588 private BrowserSettings() {