Settings.java revision 0e25caf82ebe2af3aa5612d27e0eef7c10e8d85c
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.provider;
18
19import com.google.android.collect.Maps;
20
21import org.apache.commons.codec.binary.Base64;
22
23import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
25import android.content.ContentQueryMap;
26import android.content.ContentResolver;
27import android.content.ContentValues;
28import android.content.Context;
29import android.content.Intent;
30import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Configuration;
33import android.content.res.Resources;
34import android.database.Cursor;
35import android.database.SQLException;
36import android.net.Uri;
37import android.os.*;
38import android.telephony.TelephonyManager;
39import android.text.TextUtils;
40import android.util.AndroidException;
41import android.util.Config;
42import android.util.Log;
43
44import java.net.URISyntaxException;
45import java.security.MessageDigest;
46import java.security.NoSuchAlgorithmException;
47import java.util.Collections;
48import java.util.HashMap;
49import java.util.HashSet;
50import java.util.Map;
51
52
53/**
54 * The Settings provider contains global system-level device preferences.
55 */
56public final class Settings {
57
58    // Intent actions for Settings
59
60    /**
61     * Activity Action: Show system settings.
62     * <p>
63     * Input: Nothing.
64     * <p>
65     * Output: nothing.
66     */
67    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
68    public static final String ACTION_SETTINGS = "android.settings.SETTINGS";
69
70    /**
71     * Activity Action: Show settings to allow configuration of APNs.
72     * <p>
73     * Input: Nothing.
74     * <p>
75     * Output: nothing.
76     */
77    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
78    public static final String ACTION_APN_SETTINGS = "android.settings.APN_SETTINGS";
79
80    /**
81     * Activity Action: Show settings to allow configuration of current location
82     * sources.
83     * <p>
84     * In some cases, a matching Activity may not exist, so ensure you
85     * safeguard against this.
86     * <p>
87     * Input: Nothing.
88     * <p>
89     * Output: Nothing.
90     */
91    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
92    public static final String ACTION_LOCATION_SOURCE_SETTINGS =
93            "android.settings.LOCATION_SOURCE_SETTINGS";
94
95    /**
96     * Activity Action: Show settings to allow configuration of wireless controls
97     * such as Wi-Fi, Bluetooth and Mobile networks.
98     * <p>
99     * In some cases, a matching Activity may not exist, so ensure you
100     * safeguard against this.
101     * <p>
102     * Input: Nothing.
103     * <p>
104     * Output: Nothing.
105     */
106    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
107    public static final String ACTION_WIRELESS_SETTINGS =
108            "android.settings.WIRELESS_SETTINGS";
109
110    /**
111     * Activity Action: Show settings to allow entering/exiting airplane mode.
112     * <p>
113     * In some cases, a matching Activity may not exist, so ensure you
114     * safeguard against this.
115     * <p>
116     * Input: Nothing.
117     * <p>
118     * Output: Nothing.
119     */
120    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
121    public static final String ACTION_AIRPLANE_MODE_SETTINGS =
122            "android.settings.AIRPLANE_MODE_SETTINGS";
123
124    /**
125     * Activity Action: Show settings for accessibility modules.
126     * <p>
127     * In some cases, a matching Activity may not exist, so ensure you
128     * safeguard against this.
129     * <p>
130     * Input: Nothing.
131     * <p>
132     * Output: Nothing.
133     */
134    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
135    public static final String ACTION_ACCESSIBILITY_SETTINGS =
136            "android.settings.ACCESSIBILITY_SETTINGS";
137
138    /**
139     * Activity Action: Show settings to allow configuration of security and
140     * location privacy.
141     * <p>
142     * In some cases, a matching Activity may not exist, so ensure you
143     * safeguard against this.
144     * <p>
145     * Input: Nothing.
146     * <p>
147     * Output: Nothing.
148     */
149    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
150    public static final String ACTION_SECURITY_SETTINGS =
151            "android.settings.SECURITY_SETTINGS";
152
153    /**
154     * Activity Action: Show settings to allow configuration of privacy options.
155     * <p>
156     * In some cases, a matching Activity may not exist, so ensure you
157     * safeguard against this.
158     * <p>
159     * Input: Nothing.
160     * <p>
161     * Output: Nothing.
162     */
163    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
164    public static final String ACTION_PRIVACY_SETTINGS =
165            "android.settings.PRIVACY_SETTINGS";
166
167    /**
168     * Activity Action: Show settings to allow configuration of Wi-Fi.
169
170     * <p>
171     * In some cases, a matching Activity may not exist, so ensure you
172     * safeguard against this.
173     * <p>
174     * Input: Nothing.
175     * <p>
176     * Output: Nothing.
177
178     */
179    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
180    public static final String ACTION_WIFI_SETTINGS =
181            "android.settings.WIFI_SETTINGS";
182
183    /**
184     * Activity Action: Show settings to allow configuration of a static IP
185     * address for Wi-Fi.
186     * <p>
187     * In some cases, a matching Activity may not exist, so ensure you safeguard
188     * against this.
189     * <p>
190     * Input: Nothing.
191     * <p>
192     * Output: Nothing.
193     */
194    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
195    public static final String ACTION_WIFI_IP_SETTINGS =
196            "android.settings.WIFI_IP_SETTINGS";
197
198    /**
199     * Activity Action: Show settings to allow configuration of Bluetooth.
200     * <p>
201     * In some cases, a matching Activity may not exist, so ensure you
202     * safeguard against this.
203     * <p>
204     * Input: Nothing.
205     * <p>
206     * Output: Nothing.
207     */
208    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
209    public static final String ACTION_BLUETOOTH_SETTINGS =
210            "android.settings.BLUETOOTH_SETTINGS";
211
212    /**
213     * Activity Action: Show settings to allow configuration of date and time.
214     * <p>
215     * In some cases, a matching Activity may not exist, so ensure you
216     * safeguard against this.
217     * <p>
218     * Input: Nothing.
219     * <p>
220     * Output: Nothing.
221     */
222    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
223    public static final String ACTION_DATE_SETTINGS =
224            "android.settings.DATE_SETTINGS";
225
226    /**
227     * Activity Action: Show settings to allow configuration of sound and volume.
228     * <p>
229     * In some cases, a matching Activity may not exist, so ensure you
230     * safeguard against this.
231     * <p>
232     * Input: Nothing.
233     * <p>
234     * Output: Nothing.
235     */
236    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
237    public static final String ACTION_SOUND_SETTINGS =
238            "android.settings.SOUND_SETTINGS";
239
240    /**
241     * Activity Action: Show settings to allow configuration of display.
242     * <p>
243     * In some cases, a matching Activity may not exist, so ensure you
244     * safeguard against this.
245     * <p>
246     * Input: Nothing.
247     * <p>
248     * Output: Nothing.
249     */
250    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
251    public static final String ACTION_DISPLAY_SETTINGS =
252            "android.settings.DISPLAY_SETTINGS";
253
254    /**
255     * Activity Action: Show settings to allow configuration of locale.
256     * <p>
257     * In some cases, a matching Activity may not exist, so ensure you
258     * safeguard against this.
259     * <p>
260     * Input: Nothing.
261     * <p>
262     * Output: Nothing.
263     */
264    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
265    public static final String ACTION_LOCALE_SETTINGS =
266            "android.settings.LOCALE_SETTINGS";
267
268    /**
269     * Activity Action: Show settings to configure input methods, in particular
270     * allowing the user to enable input methods.
271     * <p>
272     * In some cases, a matching Activity may not exist, so ensure you
273     * safeguard against this.
274     * <p>
275     * Input: Nothing.
276     * <p>
277     * Output: Nothing.
278     */
279    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
280    public static final String ACTION_INPUT_METHOD_SETTINGS =
281            "android.settings.INPUT_METHOD_SETTINGS";
282
283    /**
284     * Activity Action: Show settings to manage the user input dictionary.
285     * <p>
286     * In some cases, a matching Activity may not exist, so ensure you
287     * safeguard against this.
288     * <p>
289     * Input: Nothing.
290     * <p>
291     * Output: Nothing.
292     */
293    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
294    public static final String ACTION_USER_DICTIONARY_SETTINGS =
295            "android.settings.USER_DICTIONARY_SETTINGS";
296
297    /**
298     * Activity Action: Show settings to allow configuration of application-related settings.
299     * <p>
300     * In some cases, a matching Activity may not exist, so ensure you
301     * safeguard against this.
302     * <p>
303     * Input: Nothing.
304     * <p>
305     * Output: Nothing.
306     */
307    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
308    public static final String ACTION_APPLICATION_SETTINGS =
309            "android.settings.APPLICATION_SETTINGS";
310
311    /**
312     * Activity Action: Show settings to allow configuration of application
313     * development-related settings.
314     * <p>
315     * In some cases, a matching Activity may not exist, so ensure you safeguard
316     * against this.
317     * <p>
318     * Input: Nothing.
319     * <p>
320     * Output: Nothing.
321     */
322    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
323    public static final String ACTION_APPLICATION_DEVELOPMENT_SETTINGS =
324            "android.settings.APPLICATION_DEVELOPMENT_SETTINGS";
325
326    /**
327     * Activity Action: Show settings to allow configuration of quick launch shortcuts.
328     * <p>
329     * In some cases, a matching Activity may not exist, so ensure you
330     * safeguard against this.
331     * <p>
332     * Input: Nothing.
333     * <p>
334     * Output: Nothing.
335     */
336    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
337    public static final String ACTION_QUICK_LAUNCH_SETTINGS =
338            "android.settings.QUICK_LAUNCH_SETTINGS";
339
340    /**
341     * Activity Action: Show settings to manage installed applications.
342     * <p>
343     * In some cases, a matching Activity may not exist, so ensure you
344     * safeguard against this.
345     * <p>
346     * Input: Nothing.
347     * <p>
348     * Output: Nothing.
349     */
350    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
351    public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS =
352            "android.settings.MANAGE_APPLICATIONS_SETTINGS";
353
354    /**
355     * Activity Action: Show settings for system update functionality.
356     * <p>
357     * In some cases, a matching Activity may not exist, so ensure you
358     * safeguard against this.
359     * <p>
360     * Input: Nothing.
361     * <p>
362     * Output: Nothing.
363     *
364     * @hide
365     */
366    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
367    public static final String ACTION_SYSTEM_UPDATE_SETTINGS =
368            "android.settings.SYSTEM_UPDATE_SETTINGS";
369
370    /**
371     * Activity Action: Show settings to allow configuration of sync settings.
372     * <p>
373     * In some cases, a matching Activity may not exist, so ensure you
374     * safeguard against this.
375     * <p>
376     * Input: Nothing.
377     * <p>
378     * Output: Nothing.
379     */
380    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
381    public static final String ACTION_SYNC_SETTINGS =
382            "android.settings.SYNC_SETTINGS";
383
384    /**
385     * Activity Action: Show settings for selecting the network operator.
386     * <p>
387     * In some cases, a matching Activity may not exist, so ensure you
388     * safeguard against this.
389     * <p>
390     * Input: Nothing.
391     * <p>
392     * Output: Nothing.
393     */
394    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
395    public static final String ACTION_NETWORK_OPERATOR_SETTINGS =
396            "android.settings.NETWORK_OPERATOR_SETTINGS";
397
398    /**
399     * Activity Action: Show settings for selection of 2G/3G.
400     * <p>
401     * In some cases, a matching Activity may not exist, so ensure you
402     * safeguard against this.
403     * <p>
404     * Input: Nothing.
405     * <p>
406     * Output: Nothing.
407     */
408    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
409    public static final String ACTION_DATA_ROAMING_SETTINGS =
410            "android.settings.DATA_ROAMING_SETTINGS";
411
412    /**
413     * Activity Action: Show settings for internal storage.
414     * <p>
415     * In some cases, a matching Activity may not exist, so ensure you
416     * safeguard against this.
417     * <p>
418     * Input: Nothing.
419     * <p>
420     * Output: Nothing.
421     */
422    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
423    public static final String ACTION_INTERNAL_STORAGE_SETTINGS =
424            "android.settings.INTERNAL_STORAGE_SETTINGS";
425    /**
426     * Activity Action: Show settings for memory card storage.
427     * <p>
428     * In some cases, a matching Activity may not exist, so ensure you
429     * safeguard against this.
430     * <p>
431     * Input: Nothing.
432     * <p>
433     * Output: Nothing.
434     */
435    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
436    public static final String ACTION_MEMORY_CARD_SETTINGS =
437            "android.settings.MEMORY_CARD_SETTINGS";
438
439    // End of Intent actions for Settings
440
441    private static final String JID_RESOURCE_PREFIX = "android";
442
443    public static final String AUTHORITY = "settings";
444
445    private static final String TAG = "Settings";
446    private static final boolean LOCAL_LOGV = Config.LOGV || false;
447
448    public static class SettingNotFoundException extends AndroidException {
449        public SettingNotFoundException(String msg) {
450            super(msg);
451        }
452    }
453
454    /**
455     * Common base for tables of name/value settings.
456     */
457    public static class NameValueTable implements BaseColumns {
458        public static final String NAME = "name";
459        public static final String VALUE = "value";
460
461        protected static boolean putString(ContentResolver resolver, Uri uri,
462                String name, String value) {
463            // The database will take care of replacing duplicates.
464            try {
465                ContentValues values = new ContentValues();
466                values.put(NAME, name);
467                values.put(VALUE, value);
468                resolver.insert(uri, values);
469                return true;
470            } catch (SQLException e) {
471                Log.w(TAG, "Can't set key " + name + " in " + uri, e);
472                return false;
473            }
474        }
475
476        public static Uri getUriFor(Uri uri, String name) {
477            return Uri.withAppendedPath(uri, name);
478        }
479    }
480
481    private static class NameValueCache {
482        private final String mVersionSystemProperty;
483        private final Uri mUri;
484
485        // Must synchronize(mValues) to access mValues and mValuesVersion.
486        private final HashMap<String, String> mValues = new HashMap<String, String>();
487        private long mValuesVersion = 0;
488
489        public NameValueCache(String versionSystemProperty, Uri uri) {
490            mVersionSystemProperty = versionSystemProperty;
491            mUri = uri;
492        }
493
494        public String getString(ContentResolver cr, String name) {
495            long newValuesVersion = SystemProperties.getLong(mVersionSystemProperty, 0);
496
497            synchronized (mValues) {
498                if (mValuesVersion != newValuesVersion) {
499                    if (LOCAL_LOGV) {
500                        Log.v(TAG, "invalidate [" + mUri.getLastPathSegment() + "]: current " +
501                                newValuesVersion + " != cached " + mValuesVersion);
502                    }
503
504                    mValues.clear();
505                    mValuesVersion = newValuesVersion;
506                }
507
508                if (mValues.containsKey(name)) {
509                    return mValues.get(name);  // Could be null, that's OK -- negative caching
510                }
511            }
512
513            Cursor c = null;
514            try {
515                c = cr.query(mUri, new String[] { Settings.NameValueTable.VALUE },
516                        Settings.NameValueTable.NAME + "=?", new String[]{name}, null);
517                if (c == null) {
518                    Log.w(TAG, "Can't get key " + name + " from " + mUri);
519                    return null;
520                }
521
522                String value = c.moveToNext() ? c.getString(0) : null;
523                synchronized (mValues) {
524                    mValues.put(name, value);
525                }
526                if (LOCAL_LOGV) {
527                    Log.v(TAG, "cache miss [" + mUri.getLastPathSegment() + "]: " +
528                            name + " = " + (value == null ? "(null)" : value));
529                }
530                return value;
531            } catch (SQLException e) {
532                Log.w(TAG, "Can't get key " + name + " from " + mUri, e);
533                return null;  // Return null, but don't cache it.
534            } finally {
535                if (c != null) c.close();
536            }
537        }
538    }
539
540    /**
541     * System settings, containing miscellaneous system preferences.  This
542     * table holds simple name/value pairs.  There are convenience
543     * functions for accessing individual settings entries.
544     */
545    public static final class System extends NameValueTable {
546        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_system_version";
547
548        private static volatile NameValueCache mNameValueCache = null;
549
550        private static final HashSet<String> MOVED_TO_SECURE;
551        static {
552            MOVED_TO_SECURE = new HashSet<String>(30);
553            MOVED_TO_SECURE.add(Secure.ADB_ENABLED);
554            MOVED_TO_SECURE.add(Secure.ANDROID_ID);
555            MOVED_TO_SECURE.add(Secure.BLUETOOTH_ON);
556            MOVED_TO_SECURE.add(Secure.DATA_ROAMING);
557            MOVED_TO_SECURE.add(Secure.DEVICE_PROVISIONED);
558            MOVED_TO_SECURE.add(Secure.HTTP_PROXY);
559            MOVED_TO_SECURE.add(Secure.INSTALL_NON_MARKET_APPS);
560            MOVED_TO_SECURE.add(Secure.LOCATION_PROVIDERS_ALLOWED);
561            MOVED_TO_SECURE.add(Secure.LOGGING_ID);
562            MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_ENABLED);
563            MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_LAST_UPDATE);
564            MOVED_TO_SECURE.add(Secure.PARENTAL_CONTROL_REDIRECT_URL);
565            MOVED_TO_SECURE.add(Secure.SETTINGS_CLASSNAME);
566            MOVED_TO_SECURE.add(Secure.USB_MASS_STORAGE_ENABLED);
567            MOVED_TO_SECURE.add(Secure.USE_GOOGLE_MAIL);
568            MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON);
569            MOVED_TO_SECURE.add(Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY);
570            MOVED_TO_SECURE.add(Secure.WIFI_NUM_OPEN_NETWORKS_KEPT);
571            MOVED_TO_SECURE.add(Secure.WIFI_ON);
572            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE);
573            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_AP_COUNT);
574            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS);
575            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED);
576            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS);
577            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT);
578            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_MAX_AP_CHECKS);
579            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_ON);
580            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_COUNT);
581            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_DELAY_MS);
582            MOVED_TO_SECURE.add(Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS);
583        }
584
585        /**
586         * Look up a name in the database.
587         * @param resolver to access the database with
588         * @param name to look up in the table
589         * @return the corresponding value, or null if not present
590         */
591        public synchronized static String getString(ContentResolver resolver, String name) {
592            if (MOVED_TO_SECURE.contains(name)) {
593                Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
594                        + " to android.provider.Settings.Secure, returning read-only value.");
595                return Secure.getString(resolver, name);
596            }
597            if (mNameValueCache == null) {
598                mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
599            }
600            return mNameValueCache.getString(resolver, name);
601        }
602
603        /**
604         * Store a name/value pair into the database.
605         * @param resolver to access the database with
606         * @param name to store
607         * @param value to associate with the name
608         * @return true if the value was set, false on database errors
609         */
610        public static boolean putString(ContentResolver resolver, String name, String value) {
611            if (MOVED_TO_SECURE.contains(name)) {
612                Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
613                        + " to android.provider.Settings.Secure, value is unchanged.");
614                return false;
615            }
616            return putString(resolver, CONTENT_URI, name, value);
617        }
618
619        /**
620         * Construct the content URI for a particular name/value pair,
621         * useful for monitoring changes with a ContentObserver.
622         * @param name to look up in the table
623         * @return the corresponding content URI, or null if not present
624         */
625        public static Uri getUriFor(String name) {
626            if (MOVED_TO_SECURE.contains(name)) {
627                Log.w(TAG, "Setting " + name + " has moved from android.provider.Settings.System"
628                    + " to android.provider.Settings.Secure, returning Secure URI.");
629                return Secure.getUriFor(Secure.CONTENT_URI, name);
630            }
631            return getUriFor(CONTENT_URI, name);
632        }
633
634        /**
635         * Convenience function for retrieving a single system settings value
636         * as an integer.  Note that internally setting values are always
637         * stored as strings; this function converts the string to an integer
638         * for you.  The default value will be returned if the setting is
639         * not defined or not an integer.
640         *
641         * @param cr The ContentResolver to access.
642         * @param name The name of the setting to retrieve.
643         * @param def Value to return if the setting is not defined.
644         *
645         * @return The setting's current value, or 'def' if it is not defined
646         * or not a valid integer.
647         */
648        public static int getInt(ContentResolver cr, String name, int def) {
649            String v = getString(cr, name);
650            try {
651                return v != null ? Integer.parseInt(v) : def;
652            } catch (NumberFormatException e) {
653                return def;
654            }
655        }
656
657        /**
658         * Convenience function for retrieving a single system settings value
659         * as an integer.  Note that internally setting values are always
660         * stored as strings; this function converts the string to an integer
661         * for you.
662         * <p>
663         * This version does not take a default value.  If the setting has not
664         * been set, or the string value is not a number,
665         * it throws {@link SettingNotFoundException}.
666         *
667         * @param cr The ContentResolver to access.
668         * @param name The name of the setting to retrieve.
669         *
670         * @throws SettingNotFoundException Thrown if a setting by the given
671         * name can't be found or the setting value is not an integer.
672         *
673         * @return The setting's current value.
674         */
675        public static int getInt(ContentResolver cr, String name)
676                throws SettingNotFoundException {
677            String v = getString(cr, name);
678            try {
679                return Integer.parseInt(v);
680            } catch (NumberFormatException e) {
681                throw new SettingNotFoundException(name);
682            }
683        }
684
685        /**
686         * Convenience function for updating a single settings value as an
687         * integer. This will either create a new entry in the table if the
688         * given name does not exist, or modify the value of the existing row
689         * with that name.  Note that internally setting values are always
690         * stored as strings, so this function converts the given value to a
691         * string before storing it.
692         *
693         * @param cr The ContentResolver to access.
694         * @param name The name of the setting to modify.
695         * @param value The new value for the setting.
696         * @return true if the value was set, false on database errors
697         */
698        public static boolean putInt(ContentResolver cr, String name, int value) {
699            return putString(cr, name, Integer.toString(value));
700        }
701
702        /**
703         * Convenience function for retrieving a single system settings value
704         * as a {@code long}.  Note that internally setting values are always
705         * stored as strings; this function converts the string to a {@code long}
706         * for you.  The default value will be returned if the setting is
707         * not defined or not a {@code long}.
708         *
709         * @param cr The ContentResolver to access.
710         * @param name The name of the setting to retrieve.
711         * @param def Value to return if the setting is not defined.
712         *
713         * @return The setting's current value, or 'def' if it is not defined
714         * or not a valid {@code long}.
715         */
716        public static long getLong(ContentResolver cr, String name, long def) {
717            String valString = getString(cr, name);
718            long value;
719            try {
720                value = valString != null ? Long.parseLong(valString) : def;
721            } catch (NumberFormatException e) {
722                value = def;
723            }
724            return value;
725        }
726
727        /**
728         * Convenience function for retrieving a single system settings value
729         * as a {@code long}.  Note that internally setting values are always
730         * stored as strings; this function converts the string to a {@code long}
731         * for you.
732         * <p>
733         * This version does not take a default value.  If the setting has not
734         * been set, or the string value is not a number,
735         * it throws {@link SettingNotFoundException}.
736         *
737         * @param cr The ContentResolver to access.
738         * @param name The name of the setting to retrieve.
739         *
740         * @return The setting's current value.
741         * @throws SettingNotFoundException Thrown if a setting by the given
742         * name can't be found or the setting value is not an integer.
743         */
744        public static long getLong(ContentResolver cr, String name)
745                throws SettingNotFoundException {
746            String valString = getString(cr, name);
747            try {
748                return Long.parseLong(valString);
749            } catch (NumberFormatException e) {
750                throw new SettingNotFoundException(name);
751            }
752        }
753
754        /**
755         * Convenience function for updating a single settings value as a long
756         * integer. This will either create a new entry in the table if the
757         * given name does not exist, or modify the value of the existing row
758         * with that name.  Note that internally setting values are always
759         * stored as strings, so this function converts the given value to a
760         * string before storing it.
761         *
762         * @param cr The ContentResolver to access.
763         * @param name The name of the setting to modify.
764         * @param value The new value for the setting.
765         * @return true if the value was set, false on database errors
766         */
767        public static boolean putLong(ContentResolver cr, String name, long value) {
768            return putString(cr, name, Long.toString(value));
769        }
770
771        /**
772         * Convenience function for retrieving a single system settings value
773         * as a floating point number.  Note that internally setting values are
774         * always stored as strings; this function converts the string to an
775         * float for you. The default value will be returned if the setting
776         * is not defined or not a valid float.
777         *
778         * @param cr The ContentResolver to access.
779         * @param name The name of the setting to retrieve.
780         * @param def Value to return if the setting is not defined.
781         *
782         * @return The setting's current value, or 'def' if it is not defined
783         * or not a valid float.
784         */
785        public static float getFloat(ContentResolver cr, String name, float def) {
786            String v = getString(cr, name);
787            try {
788                return v != null ? Float.parseFloat(v) : def;
789            } catch (NumberFormatException e) {
790                return def;
791            }
792        }
793
794        /**
795         * Convenience function for retrieving a single system settings value
796         * as a float.  Note that internally setting values are always
797         * stored as strings; this function converts the string to a float
798         * for you.
799         * <p>
800         * This version does not take a default value.  If the setting has not
801         * been set, or the string value is not a number,
802         * it throws {@link SettingNotFoundException}.
803         *
804         * @param cr The ContentResolver to access.
805         * @param name The name of the setting to retrieve.
806         *
807         * @throws SettingNotFoundException Thrown if a setting by the given
808         * name can't be found or the setting value is not a float.
809         *
810         * @return The setting's current value.
811         */
812        public static float getFloat(ContentResolver cr, String name)
813                throws SettingNotFoundException {
814            String v = getString(cr, name);
815            try {
816                return Float.parseFloat(v);
817            } catch (NumberFormatException e) {
818                throw new SettingNotFoundException(name);
819            }
820        }
821
822        /**
823         * Convenience function for updating a single settings value as a
824         * floating point number. This will either create a new entry in the
825         * table if the given name does not exist, or modify the value of the
826         * existing row with that name.  Note that internally setting values
827         * are always stored as strings, so this function converts the given
828         * value to a string before storing it.
829         *
830         * @param cr The ContentResolver to access.
831         * @param name The name of the setting to modify.
832         * @param value The new value for the setting.
833         * @return true if the value was set, false on database errors
834         */
835        public static boolean putFloat(ContentResolver cr, String name, float value) {
836            return putString(cr, name, Float.toString(value));
837        }
838
839        /**
840         * Convenience function to read all of the current
841         * configuration-related settings into a
842         * {@link Configuration} object.
843         *
844         * @param cr The ContentResolver to access.
845         * @param outConfig Where to place the configuration settings.
846         */
847        public static void getConfiguration(ContentResolver cr, Configuration outConfig) {
848            outConfig.fontScale = Settings.System.getFloat(
849                cr, FONT_SCALE, outConfig.fontScale);
850            if (outConfig.fontScale < 0) {
851                outConfig.fontScale = 1;
852            }
853        }
854
855        /**
856         * Convenience function to write a batch of configuration-related
857         * settings from a {@link Configuration} object.
858         *
859         * @param cr The ContentResolver to access.
860         * @param config The settings to write.
861         * @return true if the values were set, false on database errors
862         */
863        public static boolean putConfiguration(ContentResolver cr, Configuration config) {
864            return Settings.System.putFloat(cr, FONT_SCALE, config.fontScale);
865        }
866
867        public static boolean getShowGTalkServiceStatus(ContentResolver cr) {
868            return getInt(cr, SHOW_GTALK_SERVICE_STATUS, 0) != 0;
869        }
870
871        public static void setShowGTalkServiceStatus(ContentResolver cr, boolean flag) {
872            putInt(cr, SHOW_GTALK_SERVICE_STATUS, flag ? 1 : 0);
873        }
874
875        /**
876         * The content:// style URL for this table
877         */
878        public static final Uri CONTENT_URI =
879            Uri.parse("content://" + AUTHORITY + "/system");
880
881        /**
882         * Whether we keep the device on while the device is plugged in.
883         * Supported values are:
884         * <ul>
885         * <li>{@code 0} to never stay on while plugged in</li>
886         * <li>{@link BatteryManager#BATTERY_PLUGGED_AC} to stay on for AC charger</li>
887         * <li>{@link BatteryManager#BATTERY_PLUGGED_USB} to stay on for USB charger</li>
888         * </ul>
889         * These values can be OR-ed together.
890         */
891        public static final String STAY_ON_WHILE_PLUGGED_IN = "stay_on_while_plugged_in";
892
893        /**
894         * What happens when the user presses the end call button if they're not
895         * on a call.<br/>
896         * <b>Values:</b><br/>
897         * 0 - The end button does nothing.<br/>
898         * 1 - The end button goes to the home screen.<br/>
899         * 2 - The end button puts the device to sleep and locks the keyguard.<br/>
900         * 3 - The end button goes to the home screen.  If the user is already on the
901         * home screen, it puts the device to sleep.
902         */
903        public static final String END_BUTTON_BEHAVIOR = "end_button_behavior";
904
905        /**
906         * Whether Airplane Mode is on.
907         */
908        public static final String AIRPLANE_MODE_ON = "airplane_mode_on";
909
910        /**
911         * Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
912         */
913        public static final String RADIO_BLUETOOTH = "bluetooth";
914
915        /**
916         * Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
917         */
918        public static final String RADIO_WIFI = "wifi";
919
920        /**
921         * Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
922         */
923        public static final String RADIO_CELL = "cell";
924
925        /**
926         * A comma separated list of radios that need to be disabled when airplane mode
927         * is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are
928         * included in the comma separated list.
929         */
930        public static final String AIRPLANE_MODE_RADIOS = "airplane_mode_radios";
931
932        /**
933         * A comma separated list of radios that should to be disabled when airplane mode
934         * is on, but can be manually reenabled by the user.  For example, if RADIO_WIFI is
935         * added to both AIRPLANE_MODE_RADIOS and AIRPLANE_MODE_TOGGLEABLE_RADIOS, then Wifi
936         * will be turned off when entering airplane mode, but the user will be able to reenable
937         * Wifi in the Settings app.
938         *
939         * {@hide}
940         */
941        public static final String AIRPLANE_MODE_TOGGLEABLE_RADIOS = "airplane_mode_toggleable_radios";
942
943        /**
944         * The policy for deciding when Wi-Fi should go to sleep (which will in
945         * turn switch to using the mobile data as an Internet connection).
946         * <p>
947         * Set to one of {@link #WIFI_SLEEP_POLICY_DEFAULT},
948         * {@link #WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED}, or
949         * {@link #WIFI_SLEEP_POLICY_NEVER}.
950         */
951        public static final String WIFI_SLEEP_POLICY = "wifi_sleep_policy";
952
953        /**
954         * Value for {@link #WIFI_SLEEP_POLICY} to use the default Wi-Fi sleep
955         * policy, which is to sleep shortly after the turning off
956         * according to the {@link #STAY_ON_WHILE_PLUGGED_IN} setting.
957         */
958        public static final int WIFI_SLEEP_POLICY_DEFAULT = 0;
959
960        /**
961         * Value for {@link #WIFI_SLEEP_POLICY} to use the default policy when
962         * the device is on battery, and never go to sleep when the device is
963         * plugged in.
964         */
965        public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED = 1;
966
967        /**
968         * Value for {@link #WIFI_SLEEP_POLICY} to never go to sleep.
969         */
970        public static final int WIFI_SLEEP_POLICY_NEVER = 2;
971
972        /**
973         * Whether to use static IP and other static network attributes.
974         * <p>
975         * Set to 1 for true and 0 for false.
976         */
977        public static final String WIFI_USE_STATIC_IP = "wifi_use_static_ip";
978
979        /**
980         * The static IP address.
981         * <p>
982         * Example: "192.168.1.51"
983         */
984        public static final String WIFI_STATIC_IP = "wifi_static_ip";
985
986        /**
987         * If using static IP, the gateway's IP address.
988         * <p>
989         * Example: "192.168.1.1"
990         */
991        public static final String WIFI_STATIC_GATEWAY = "wifi_static_gateway";
992
993        /**
994         * If using static IP, the net mask.
995         * <p>
996         * Example: "255.255.255.0"
997         */
998        public static final String WIFI_STATIC_NETMASK = "wifi_static_netmask";
999
1000        /**
1001         * If using static IP, the primary DNS's IP address.
1002         * <p>
1003         * Example: "192.168.1.1"
1004         */
1005        public static final String WIFI_STATIC_DNS1 = "wifi_static_dns1";
1006
1007        /**
1008         * If using static IP, the secondary DNS's IP address.
1009         * <p>
1010         * Example: "192.168.1.2"
1011         */
1012        public static final String WIFI_STATIC_DNS2 = "wifi_static_dns2";
1013
1014        /**
1015         * The number of radio channels that are allowed in the local
1016         * 802.11 regulatory domain.
1017         * @hide
1018         */
1019        public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
1020
1021        /**
1022         * Determines whether remote devices may discover and/or connect to
1023         * this device.
1024         * <P>Type: INT</P>
1025         * 2 -- discoverable and connectable
1026         * 1 -- connectable but not discoverable
1027         * 0 -- neither connectable nor discoverable
1028         */
1029        public static final String BLUETOOTH_DISCOVERABILITY =
1030            "bluetooth_discoverability";
1031
1032        /**
1033         * Bluetooth discoverability timeout.  If this value is nonzero, then
1034         * Bluetooth becomes discoverable for a certain number of seconds,
1035         * after which is becomes simply connectable.  The value is in seconds.
1036         */
1037        public static final String BLUETOOTH_DISCOVERABILITY_TIMEOUT =
1038            "bluetooth_discoverability_timeout";
1039
1040        /**
1041         * Whether autolock is enabled (0 = false, 1 = true)
1042         */
1043        public static final String LOCK_PATTERN_ENABLED = "lock_pattern_autolock";
1044
1045        /**
1046         * Whether lock pattern is visible as user enters (0 = false, 1 = true)
1047         */
1048        public static final String LOCK_PATTERN_VISIBLE = "lock_pattern_visible_pattern";
1049
1050        /**
1051         * Whether lock pattern will vibrate as user enters (0 = false, 1 = true)
1052         */
1053        public static final String LOCK_PATTERN_TACTILE_FEEDBACK_ENABLED =
1054            "lock_pattern_tactile_feedback_enabled";
1055
1056
1057        /**
1058         * A formatted string of the next alarm that is set, or the empty string
1059         * if there is no alarm set.
1060         */
1061        public static final String NEXT_ALARM_FORMATTED = "next_alarm_formatted";
1062
1063        /**
1064         * Scaling factor for fonts, float.
1065         */
1066        public static final String FONT_SCALE = "font_scale";
1067
1068        /**
1069         * Name of an application package to be debugged.
1070         */
1071        public static final String DEBUG_APP = "debug_app";
1072
1073        /**
1074         * If 1, when launching DEBUG_APP it will wait for the debugger before
1075         * starting user code.  If 0, it will run normally.
1076         */
1077        public static final String WAIT_FOR_DEBUGGER = "wait_for_debugger";
1078
1079        /**
1080         * Whether or not to dim the screen. 0=no  1=yes
1081         */
1082        public static final String DIM_SCREEN = "dim_screen";
1083
1084        /**
1085         * The timeout before the screen turns off.
1086         */
1087        public static final String SCREEN_OFF_TIMEOUT = "screen_off_timeout";
1088
1089        /**
1090         * If 0, the compatibility mode is off for all applications.
1091         * If 1, older applications run under compatibility mode.
1092         * TODO: remove this settings before code freeze (bug/1907571)
1093         * @hide
1094         */
1095        public static final String COMPATIBILITY_MODE = "compatibility_mode";
1096
1097        /**
1098         * The screen backlight brightness between 0 and 255.
1099         */
1100        public static final String SCREEN_BRIGHTNESS = "screen_brightness";
1101
1102        /**
1103         * Control whether to enable automatic brightness mode.
1104         * @hide
1105         */
1106        public static final String SCREEN_BRIGHTNESS_MODE = "screen_brightness_mode";
1107
1108        /**
1109         * SCREEN_BRIGHTNESS_MODE value for manual mode.
1110         * @hide
1111         */
1112        public static final int SCREEN_BRIGHTNESS_MODE_MANUAL = 0;
1113
1114        /**
1115         * SCREEN_BRIGHTNESS_MODE value for manual mode.
1116         * @hide
1117         */
1118        public static final int SCREEN_BRIGHTNESS_MODE_AUTOMATIC = 1;
1119
1120        /**
1121         * Control whether the process CPU usage meter should be shown.
1122         */
1123        public static final String SHOW_PROCESSES = "show_processes";
1124
1125        /**
1126         * If 1, the activity manager will aggressively finish activities and
1127         * processes as soon as they are no longer needed.  If 0, the normal
1128         * extended lifetime is used.
1129         */
1130        public static final String ALWAYS_FINISH_ACTIVITIES =
1131                "always_finish_activities";
1132
1133
1134        /**
1135         * Ringer mode. This is used internally, changing this value will not
1136         * change the ringer mode. See AudioManager.
1137         */
1138        public static final String MODE_RINGER = "mode_ringer";
1139
1140        /**
1141         * Determines which streams are affected by ringer mode changes. The
1142         * stream type's bit should be set to 1 if it should be muted when going
1143         * into an inaudible ringer mode.
1144         */
1145        public static final String MODE_RINGER_STREAMS_AFFECTED = "mode_ringer_streams_affected";
1146
1147         /**
1148          * Determines which streams are affected by mute. The
1149          * stream type's bit should be set to 1 if it should be muted when a mute request
1150          * is received.
1151          */
1152         public static final String MUTE_STREAMS_AFFECTED = "mute_streams_affected";
1153
1154        /**
1155         * Whether vibrate is on for different events. This is used internally,
1156         * changing this value will not change the vibrate. See AudioManager.
1157         */
1158        public static final String VIBRATE_ON = "vibrate_on";
1159
1160        /**
1161         * Ringer volume. This is used internally, changing this value will not
1162         * change the volume. See AudioManager.
1163         */
1164        public static final String VOLUME_RING = "volume_ring";
1165
1166        /**
1167         * System/notifications volume. This is used internally, changing this
1168         * value will not change the volume. See AudioManager.
1169         */
1170        public static final String VOLUME_SYSTEM = "volume_system";
1171
1172        /**
1173         * Voice call volume. This is used internally, changing this value will
1174         * not change the volume. See AudioManager.
1175         */
1176        public static final String VOLUME_VOICE = "volume_voice";
1177
1178        /**
1179         * Music/media/gaming volume. This is used internally, changing this
1180         * value will not change the volume. See AudioManager.
1181         */
1182        public static final String VOLUME_MUSIC = "volume_music";
1183
1184        /**
1185         * Alarm volume. This is used internally, changing this
1186         * value will not change the volume. See AudioManager.
1187         */
1188        public static final String VOLUME_ALARM = "volume_alarm";
1189
1190        /**
1191         * Notification volume. This is used internally, changing this
1192         * value will not change the volume. See AudioManager.
1193         */
1194        public static final String VOLUME_NOTIFICATION = "volume_notification";
1195
1196        /**
1197         * Bluetooth Headset volume. This is used internally, changing this value will
1198         * not change the volume. See AudioManager.
1199         */
1200        public static final String VOLUME_BLUETOOTH_SCO = "volume_bluetooth_sco";
1201
1202        /**
1203         * Whether the notifications should use the ring volume (value of 1) or
1204         * a separate notification volume (value of 0). In most cases, users
1205         * will have this enabled so the notification and ringer volumes will be
1206         * the same. However, power users can disable this and use the separate
1207         * notification volume control.
1208         * <p>
1209         * Note: This is a one-off setting that will be removed in the future
1210         * when there is profile support. For this reason, it is kept hidden
1211         * from the public APIs.
1212         *
1213         * @hide
1214         */
1215        public static final String NOTIFICATIONS_USE_RING_VOLUME =
1216            "notifications_use_ring_volume";
1217
1218        /**
1219         * The mapping of stream type (integer) to its setting.
1220         */
1221        public static final String[] VOLUME_SETTINGS = {
1222            VOLUME_VOICE, VOLUME_SYSTEM, VOLUME_RING, VOLUME_MUSIC,
1223            VOLUME_ALARM, VOLUME_NOTIFICATION, VOLUME_BLUETOOTH_SCO
1224        };
1225
1226        /**
1227         * Appended to various volume related settings to record the previous
1228         * values before they the settings were affected by a silent/vibrate
1229         * ringer mode change.
1230         */
1231        public static final String APPEND_FOR_LAST_AUDIBLE = "_last_audible";
1232
1233        /**
1234         * Persistent store for the system-wide default ringtone URI.
1235         * <p>
1236         * If you need to play the default ringtone at any given time, it is recommended
1237         * you give {@link #DEFAULT_RINGTONE_URI} to the media player.  It will resolve
1238         * to the set default ringtone at the time of playing.
1239         *
1240         * @see #DEFAULT_RINGTONE_URI
1241         */
1242        public static final String RINGTONE = "ringtone";
1243
1244        /**
1245         * A {@link Uri} that will point to the current default ringtone at any
1246         * given time.
1247         * <p>
1248         * If the current default ringtone is in the DRM provider and the caller
1249         * does not have permission, the exception will be a
1250         * FileNotFoundException.
1251         */
1252        public static final Uri DEFAULT_RINGTONE_URI = getUriFor(RINGTONE);
1253
1254        /**
1255         * Persistent store for the system-wide default notification sound.
1256         *
1257         * @see #RINGTONE
1258         * @see #DEFAULT_NOTIFICATION_URI
1259         */
1260        public static final String NOTIFICATION_SOUND = "notification_sound";
1261
1262        /**
1263         * A {@link Uri} that will point to the current default notification
1264         * sound at any given time.
1265         *
1266         * @see #DEFAULT_RINGTONE_URI
1267         */
1268        public static final Uri DEFAULT_NOTIFICATION_URI = getUriFor(NOTIFICATION_SOUND);
1269
1270        /**
1271         * Persistent store for the system-wide default alarm alert.
1272         *
1273         * @see #RINGTONE
1274         * @see #DEFAULT_ALARM_ALERT_URI
1275         */
1276        public static final String ALARM_ALERT = "alarm_alert";
1277
1278        /**
1279         * A {@link Uri} that will point to the current default alarm alert at
1280         * any given time.
1281         *
1282         * @see #DEFAULT_ALARM_ALERT_URI
1283         */
1284        public static final Uri DEFAULT_ALARM_ALERT_URI = getUriFor(ALARM_ALERT);
1285
1286        /**
1287         * Setting to enable Auto Replace (AutoText) in text editors. 1 = On, 0 = Off
1288         */
1289        public static final String TEXT_AUTO_REPLACE = "auto_replace";
1290
1291        /**
1292         * Setting to enable Auto Caps in text editors. 1 = On, 0 = Off
1293         */
1294        public static final String TEXT_AUTO_CAPS = "auto_caps";
1295
1296        /**
1297         * Setting to enable Auto Punctuate in text editors. 1 = On, 0 = Off. This
1298         * feature converts two spaces to a "." and space.
1299         */
1300        public static final String TEXT_AUTO_PUNCTUATE = "auto_punctuate";
1301
1302        /**
1303         * Setting to showing password characters in text editors. 1 = On, 0 = Off
1304         */
1305        public static final String TEXT_SHOW_PASSWORD = "show_password";
1306
1307        public static final String SHOW_GTALK_SERVICE_STATUS =
1308                "SHOW_GTALK_SERVICE_STATUS";
1309
1310        /**
1311         * Name of activity to use for wallpaper on the home screen.
1312         */
1313        public static final String WALLPAPER_ACTIVITY = "wallpaper_activity";
1314
1315        /**
1316         * Value to specify if the user prefers the date, time and time zone
1317         * to be automatically fetched from the network (NITZ). 1=yes, 0=no
1318         */
1319        public static final String AUTO_TIME = "auto_time";
1320
1321        /**
1322         * Display times as 12 or 24 hours
1323         *   12
1324         *   24
1325         */
1326        public static final String TIME_12_24 = "time_12_24";
1327
1328        /**
1329         * Date format string
1330         *   mm/dd/yyyy
1331         *   dd/mm/yyyy
1332         *   yyyy/mm/dd
1333         */
1334        public static final String DATE_FORMAT = "date_format";
1335
1336        /**
1337         * Whether the setup wizard has been run before (on first boot), or if
1338         * it still needs to be run.
1339         *
1340         * nonzero = it has been run in the past
1341         * 0 = it has not been run in the past
1342         */
1343        public static final String SETUP_WIZARD_HAS_RUN = "setup_wizard_has_run";
1344
1345        /**
1346         * Scaling factor for normal window animations. Setting to 0 will disable window
1347         * animations.
1348         */
1349        public static final String WINDOW_ANIMATION_SCALE = "window_animation_scale";
1350
1351        /**
1352         * Scaling factor for activity transition animations. Setting to 0 will disable window
1353         * animations.
1354         */
1355        public static final String TRANSITION_ANIMATION_SCALE = "transition_animation_scale";
1356
1357        /**
1358         * Scaling factor for normal window animations. Setting to 0 will disable window
1359         * animations.
1360         * @hide
1361         */
1362        public static final String FANCY_IME_ANIMATIONS = "fancy_ime_animations";
1363
1364        /**
1365         * Control whether the accelerometer will be used to change screen
1366         * orientation.  If 0, it will not be used unless explicitly requested
1367         * by the application; if 1, it will be used by default unless explicitly
1368         * disabled by the application.
1369         */
1370        public static final String ACCELEROMETER_ROTATION = "accelerometer_rotation";
1371
1372        /**
1373         * Whether the audible DTMF tones are played by the dialer when dialing. The value is
1374         * boolean (1 or 0).
1375         */
1376        public static final String DTMF_TONE_WHEN_DIALING = "dtmf_tone";
1377
1378        /**
1379         * CDMA only settings
1380         * DTMF tone type played by the dialer when dialing.
1381         *                 0 = Normal
1382         *                 1 = Long
1383         * @hide
1384         */
1385        public static final String DTMF_TONE_TYPE_WHEN_DIALING = "dtmf_tone_type";
1386
1387        /**
1388         * CDMA only settings
1389         * Emergency Tone  0 = Off
1390         *                 1 = Alert
1391         *                 2 = Vibrate
1392         * @hide
1393         */
1394        public static final String EMERGENCY_TONE = "emergency_tone";
1395
1396        /**
1397         * CDMA only settings
1398         * Whether the auto retry is enabled. The value is
1399         * boolean (1 or 0).
1400         * @hide
1401         */
1402        public static final String CALL_AUTO_RETRY = "call_auto_retry";
1403
1404        /**
1405         * Whether the hearing aid is enabled. The value is
1406         * boolean (1 or 0).
1407         * @hide
1408         */
1409        public static final String HEARING_AID = "hearing_aid";
1410
1411        /**
1412         * CDMA only settings
1413         * TTY Mode
1414         * 0 = OFF
1415         * 1 = FULL
1416         * 2 = VCO
1417         * 3 = HCO
1418         * @hide
1419         */
1420        public static final String TTY_MODE = "tty_mode";
1421
1422        /**
1423         * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1424         * boolean (1 or 0).
1425         */
1426        public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
1427
1428        /**
1429         * Whether the haptic feedback (long presses, ...) are enabled. The value is
1430         * boolean (1 or 0).
1431         */
1432        public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
1433
1434        /**
1435         * Whether live web suggestions while the user types into search dialogs are
1436         * enabled. Browsers and other search UIs should respect this, as it allows
1437         * a user to avoid sending partial queries to a search engine, if it poses
1438         * any privacy concern. The value is boolean (1 or 0).
1439         */
1440        public static final String SHOW_WEB_SUGGESTIONS = "show_web_suggestions";
1441
1442        /**
1443         * Whether the notification LED should repeatedly flash when a notification is
1444         * pending. The value is boolean (1 or 0).
1445         * @hide
1446         */
1447        public static final String NOTIFICATION_LIGHT_PULSE = "notification_light_pulse";
1448
1449        /**
1450         * Settings to backup. This is here so that it's in the same place as the settings
1451         * keys and easy to update.
1452         * @hide
1453         */
1454        public static final String[] SETTINGS_TO_BACKUP = {
1455            STAY_ON_WHILE_PLUGGED_IN,
1456            WIFI_SLEEP_POLICY,
1457            WIFI_USE_STATIC_IP,
1458            WIFI_STATIC_IP,
1459            WIFI_STATIC_GATEWAY,
1460            WIFI_STATIC_NETMASK,
1461            WIFI_STATIC_DNS1,
1462            WIFI_STATIC_DNS2,
1463            BLUETOOTH_DISCOVERABILITY,
1464            BLUETOOTH_DISCOVERABILITY_TIMEOUT,
1465            DIM_SCREEN,
1466            SCREEN_OFF_TIMEOUT,
1467            SCREEN_BRIGHTNESS,
1468            SCREEN_BRIGHTNESS_MODE,
1469            VIBRATE_ON,
1470            NOTIFICATIONS_USE_RING_VOLUME,
1471            MODE_RINGER,
1472            MODE_RINGER_STREAMS_AFFECTED,
1473            MUTE_STREAMS_AFFECTED,
1474            VOLUME_VOICE,
1475            VOLUME_SYSTEM,
1476            VOLUME_RING,
1477            VOLUME_MUSIC,
1478            VOLUME_ALARM,
1479            VOLUME_NOTIFICATION,
1480            VOLUME_BLUETOOTH_SCO,
1481            VOLUME_VOICE + APPEND_FOR_LAST_AUDIBLE,
1482            VOLUME_SYSTEM + APPEND_FOR_LAST_AUDIBLE,
1483            VOLUME_RING + APPEND_FOR_LAST_AUDIBLE,
1484            VOLUME_MUSIC + APPEND_FOR_LAST_AUDIBLE,
1485            VOLUME_ALARM + APPEND_FOR_LAST_AUDIBLE,
1486            VOLUME_NOTIFICATION + APPEND_FOR_LAST_AUDIBLE,
1487            VOLUME_BLUETOOTH_SCO + APPEND_FOR_LAST_AUDIBLE,
1488            TEXT_AUTO_REPLACE,
1489            TEXT_AUTO_CAPS,
1490            TEXT_AUTO_PUNCTUATE,
1491            TEXT_SHOW_PASSWORD,
1492            AUTO_TIME,
1493            TIME_12_24,
1494            DATE_FORMAT,
1495            ACCELEROMETER_ROTATION,
1496            DTMF_TONE_WHEN_DIALING,
1497            DTMF_TONE_TYPE_WHEN_DIALING,
1498            EMERGENCY_TONE,
1499            CALL_AUTO_RETRY,
1500            HEARING_AID,
1501            TTY_MODE,
1502            SOUND_EFFECTS_ENABLED,
1503            HAPTIC_FEEDBACK_ENABLED,
1504            SHOW_WEB_SUGGESTIONS,
1505            NOTIFICATION_LIGHT_PULSE
1506        };
1507
1508        // Settings moved to Settings.Secure
1509
1510        /**
1511         * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
1512         * instead
1513         */
1514        @Deprecated
1515        public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1516
1517        /**
1518         * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1519         */
1520        @Deprecated
1521        public static final String ANDROID_ID = Secure.ANDROID_ID;
1522
1523        /**
1524         * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1525         */
1526        @Deprecated
1527        public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1528
1529        /**
1530         * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1531         */
1532        @Deprecated
1533        public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1534
1535        /**
1536         * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1537         */
1538        @Deprecated
1539        public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1540
1541        /**
1542         * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1543         */
1544        @Deprecated
1545        public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1546
1547        /**
1548         * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1549         */
1550        @Deprecated
1551        public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
1552
1553        /**
1554         * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1555         * instead
1556         */
1557        @Deprecated
1558        public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1559
1560        /**
1561         * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1562         */
1563        @Deprecated
1564        public static final String LOGGING_ID = Secure.LOGGING_ID;
1565
1566        /**
1567         * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1568         */
1569        @Deprecated
1570        public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1571
1572        /**
1573         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1574         * instead
1575         */
1576        @Deprecated
1577        public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1578
1579        /**
1580         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1581         * instead
1582         */
1583        @Deprecated
1584        public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1585
1586        /**
1587         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1588         * instead
1589         */
1590        @Deprecated
1591        public static final String PARENTAL_CONTROL_REDIRECT_URL =
1592            Secure.PARENTAL_CONTROL_REDIRECT_URL;
1593
1594        /**
1595         * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1596         */
1597        @Deprecated
1598        public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1599
1600        /**
1601         * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1602         */
1603        @Deprecated
1604        public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
1605
1606        /**
1607         * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1608         */
1609        @Deprecated
1610        public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1611
1612       /**
1613         * @deprecated Use
1614         * {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT} instead
1615         */
1616        @Deprecated
1617        public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1618
1619        /**
1620         * @deprecated Use
1621         * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS} instead
1622         */
1623        @Deprecated
1624        public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1625                Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1626
1627        /**
1628         * @deprecated Use
1629         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1630         */
1631        @Deprecated
1632        public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1633            Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1634
1635        /**
1636         * @deprecated Use
1637         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
1638         */
1639        @Deprecated
1640        public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1641            Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
1642
1643        /**
1644         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
1645         * instead
1646         */
1647        @Deprecated
1648        public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
1649
1650        /**
1651         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
1652         */
1653        @Deprecated
1654        public static final String WIFI_ON = Secure.WIFI_ON;
1655
1656        /**
1657         * @deprecated Use
1658         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
1659         * instead
1660         */
1661        @Deprecated
1662        public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1663                Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
1664
1665        /**
1666         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
1667         */
1668        @Deprecated
1669        public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
1670
1671        /**
1672         * @deprecated Use
1673         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
1674         */
1675        @Deprecated
1676        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1677                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
1678
1679        /**
1680         * @deprecated Use
1681         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
1682         */
1683        @Deprecated
1684        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1685                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
1686
1687        /**
1688         * @deprecated Use
1689         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
1690         * instead
1691         */
1692        @Deprecated
1693        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1694                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
1695
1696        /**
1697         * @deprecated Use
1698         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
1699         */
1700        @Deprecated
1701        public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1702            Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
1703
1704        /**
1705         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
1706         * instead
1707         */
1708        @Deprecated
1709        public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
1710
1711        /**
1712         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
1713         */
1714        @Deprecated
1715        public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
1716
1717        /**
1718         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
1719         */
1720        @Deprecated
1721        public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
1722
1723        /**
1724         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
1725         * instead
1726         */
1727        @Deprecated
1728        public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
1729
1730        /**
1731         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
1732         * instead
1733         */
1734        @Deprecated
1735        public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
1736            Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
1737    }
1738
1739    /**
1740     * Secure system settings, containing system preferences that applications
1741     * can read but are not allowed to write.  These are for preferences that
1742     * the user must explicitly modify through the system UI or specialized
1743     * APIs for those values, not modified directly by applications.
1744     */
1745    public static final class Secure extends NameValueTable {
1746        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
1747
1748        private static volatile NameValueCache mNameValueCache = null;
1749
1750        /**
1751         * Look up a name in the database.
1752         * @param resolver to access the database with
1753         * @param name to look up in the table
1754         * @return the corresponding value, or null if not present
1755         */
1756        public synchronized static String getString(ContentResolver resolver, String name) {
1757            if (mNameValueCache == null) {
1758                mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
1759            }
1760            return mNameValueCache.getString(resolver, name);
1761        }
1762
1763        /**
1764         * Store a name/value pair into the database.
1765         * @param resolver to access the database with
1766         * @param name to store
1767         * @param value to associate with the name
1768         * @return true if the value was set, false on database errors
1769         */
1770        public static boolean putString(ContentResolver resolver,
1771                String name, String value) {
1772            return putString(resolver, CONTENT_URI, name, value);
1773        }
1774
1775        /**
1776         * Construct the content URI for a particular name/value pair,
1777         * useful for monitoring changes with a ContentObserver.
1778         * @param name to look up in the table
1779         * @return the corresponding content URI, or null if not present
1780         */
1781        public static Uri getUriFor(String name) {
1782            return getUriFor(CONTENT_URI, name);
1783        }
1784
1785        /**
1786         * Convenience function for retrieving a single secure settings value
1787         * as an integer.  Note that internally setting values are always
1788         * stored as strings; this function converts the string to an integer
1789         * for you.  The default value will be returned if the setting is
1790         * not defined or not an integer.
1791         *
1792         * @param cr The ContentResolver to access.
1793         * @param name The name of the setting to retrieve.
1794         * @param def Value to return if the setting is not defined.
1795         *
1796         * @return The setting's current value, or 'def' if it is not defined
1797         * or not a valid integer.
1798         */
1799        public static int getInt(ContentResolver cr, String name, int def) {
1800            String v = getString(cr, name);
1801            try {
1802                return v != null ? Integer.parseInt(v) : def;
1803            } catch (NumberFormatException e) {
1804                return def;
1805            }
1806        }
1807
1808        /**
1809         * Convenience function for retrieving a single secure settings value
1810         * as an integer.  Note that internally setting values are always
1811         * stored as strings; this function converts the string to an integer
1812         * for you.
1813         * <p>
1814         * This version does not take a default value.  If the setting has not
1815         * been set, or the string value is not a number,
1816         * it throws {@link SettingNotFoundException}.
1817         *
1818         * @param cr The ContentResolver to access.
1819         * @param name The name of the setting to retrieve.
1820         *
1821         * @throws SettingNotFoundException Thrown if a setting by the given
1822         * name can't be found or the setting value is not an integer.
1823         *
1824         * @return The setting's current value.
1825         */
1826        public static int getInt(ContentResolver cr, String name)
1827                throws SettingNotFoundException {
1828            String v = getString(cr, name);
1829            try {
1830                return Integer.parseInt(v);
1831            } catch (NumberFormatException e) {
1832                throw new SettingNotFoundException(name);
1833            }
1834        }
1835
1836        /**
1837         * Convenience function for updating a single settings value as an
1838         * integer. This will either create a new entry in the table if the
1839         * given name does not exist, or modify the value of the existing row
1840         * with that name.  Note that internally setting values are always
1841         * stored as strings, so this function converts the given value to a
1842         * string before storing it.
1843         *
1844         * @param cr The ContentResolver to access.
1845         * @param name The name of the setting to modify.
1846         * @param value The new value for the setting.
1847         * @return true if the value was set, false on database errors
1848         */
1849        public static boolean putInt(ContentResolver cr, String name, int value) {
1850            return putString(cr, name, Integer.toString(value));
1851        }
1852
1853        /**
1854         * Convenience function for retrieving a single secure settings value
1855         * as a {@code long}.  Note that internally setting values are always
1856         * stored as strings; this function converts the string to a {@code long}
1857         * for you.  The default value will be returned if the setting is
1858         * not defined or not a {@code long}.
1859         *
1860         * @param cr The ContentResolver to access.
1861         * @param name The name of the setting to retrieve.
1862         * @param def Value to return if the setting is not defined.
1863         *
1864         * @return The setting's current value, or 'def' if it is not defined
1865         * or not a valid {@code long}.
1866         */
1867        public static long getLong(ContentResolver cr, String name, long def) {
1868            String valString = getString(cr, name);
1869            long value;
1870            try {
1871                value = valString != null ? Long.parseLong(valString) : def;
1872            } catch (NumberFormatException e) {
1873                value = def;
1874            }
1875            return value;
1876        }
1877
1878        /**
1879         * Convenience function for retrieving a single secure settings value
1880         * as a {@code long}.  Note that internally setting values are always
1881         * stored as strings; this function converts the string to a {@code long}
1882         * for you.
1883         * <p>
1884         * This version does not take a default value.  If the setting has not
1885         * been set, or the string value is not a number,
1886         * it throws {@link SettingNotFoundException}.
1887         *
1888         * @param cr The ContentResolver to access.
1889         * @param name The name of the setting to retrieve.
1890         *
1891         * @return The setting's current value.
1892         * @throws SettingNotFoundException Thrown if a setting by the given
1893         * name can't be found or the setting value is not an integer.
1894         */
1895        public static long getLong(ContentResolver cr, String name)
1896                throws SettingNotFoundException {
1897            String valString = getString(cr, name);
1898            try {
1899                return Long.parseLong(valString);
1900            } catch (NumberFormatException e) {
1901                throw new SettingNotFoundException(name);
1902            }
1903        }
1904
1905        /**
1906         * Convenience function for updating a secure settings value as a long
1907         * integer. This will either create a new entry in the table if the
1908         * given name does not exist, or modify the value of the existing row
1909         * with that name.  Note that internally setting values are always
1910         * stored as strings, so this function converts the given value to a
1911         * string before storing it.
1912         *
1913         * @param cr The ContentResolver to access.
1914         * @param name The name of the setting to modify.
1915         * @param value The new value for the setting.
1916         * @return true if the value was set, false on database errors
1917         */
1918        public static boolean putLong(ContentResolver cr, String name, long value) {
1919            return putString(cr, name, Long.toString(value));
1920        }
1921
1922        /**
1923         * Convenience function for retrieving a single secure settings value
1924         * as a floating point number.  Note that internally setting values are
1925         * always stored as strings; this function converts the string to an
1926         * float for you. The default value will be returned if the setting
1927         * is not defined or not a valid float.
1928         *
1929         * @param cr The ContentResolver to access.
1930         * @param name The name of the setting to retrieve.
1931         * @param def Value to return if the setting is not defined.
1932         *
1933         * @return The setting's current value, or 'def' if it is not defined
1934         * or not a valid float.
1935         */
1936        public static float getFloat(ContentResolver cr, String name, float def) {
1937            String v = getString(cr, name);
1938            try {
1939                return v != null ? Float.parseFloat(v) : def;
1940            } catch (NumberFormatException e) {
1941                return def;
1942            }
1943        }
1944
1945        /**
1946         * Convenience function for retrieving a single secure settings value
1947         * as a float.  Note that internally setting values are always
1948         * stored as strings; this function converts the string to a float
1949         * for you.
1950         * <p>
1951         * This version does not take a default value.  If the setting has not
1952         * been set, or the string value is not a number,
1953         * it throws {@link SettingNotFoundException}.
1954         *
1955         * @param cr The ContentResolver to access.
1956         * @param name The name of the setting to retrieve.
1957         *
1958         * @throws SettingNotFoundException Thrown if a setting by the given
1959         * name can't be found or the setting value is not a float.
1960         *
1961         * @return The setting's current value.
1962         */
1963        public static float getFloat(ContentResolver cr, String name)
1964                throws SettingNotFoundException {
1965            String v = getString(cr, name);
1966            try {
1967                return Float.parseFloat(v);
1968            } catch (NumberFormatException e) {
1969                throw new SettingNotFoundException(name);
1970            }
1971        }
1972
1973        /**
1974         * Convenience function for updating a single settings value as a
1975         * floating point number. This will either create a new entry in the
1976         * table if the given name does not exist, or modify the value of the
1977         * existing row with that name.  Note that internally setting values
1978         * are always stored as strings, so this function converts the given
1979         * value to a string before storing it.
1980         *
1981         * @param cr The ContentResolver to access.
1982         * @param name The name of the setting to modify.
1983         * @param value The new value for the setting.
1984         * @return true if the value was set, false on database errors
1985         */
1986        public static boolean putFloat(ContentResolver cr, String name, float value) {
1987            return putString(cr, name, Float.toString(value));
1988        }
1989
1990        /**
1991         * The content:// style URL for this table
1992         */
1993        public static final Uri CONTENT_URI =
1994            Uri.parse("content://" + AUTHORITY + "/secure");
1995
1996        /**
1997         * Whether ADB is enabled.
1998         */
1999        public static final String ADB_ENABLED = "adb_enabled";
2000
2001        /**
2002         * Setting to allow mock locations and location provider status to be injected into the
2003         * LocationManager service for testing purposes during application development.  These
2004         * locations and status values  override actual location and status information generated
2005         * by network, gps, or other location providers.
2006         */
2007        public static final String ALLOW_MOCK_LOCATION = "mock_location";
2008
2009        /**
2010         * The Android ID (a unique 64-bit value) as a hex string.
2011         * Identical to that obtained by calling
2012         * GoogleLoginService.getAndroidId(); it is also placed here
2013         * so you can get it without binding to a service.
2014         */
2015        public static final String ANDROID_ID = "android_id";
2016
2017        /**
2018         * Whether bluetooth is enabled/disabled
2019         * 0=disabled. 1=enabled.
2020         */
2021        public static final String BLUETOOTH_ON = "bluetooth_on";
2022
2023        /**
2024         * Get the key that retrieves a bluetooth headset's priority.
2025         * @hide
2026         */
2027        public static final String getBluetoothHeadsetPriorityKey(String address) {
2028            return ("bluetooth_headset_priority_" + address.toUpperCase());
2029        }
2030
2031        /**
2032         * Get the key that retrieves a bluetooth a2dp sink's priority.
2033         * @hide
2034         */
2035        public static final String getBluetoothA2dpSinkPriorityKey(String address) {
2036            return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
2037        }
2038
2039        /**
2040         * Whether or not data roaming is enabled. (0 = false, 1 = true)
2041         */
2042        public static final String DATA_ROAMING = "data_roaming";
2043
2044        /**
2045         * Setting to record the input method used by default, holding the ID
2046         * of the desired method.
2047         */
2048        public static final String DEFAULT_INPUT_METHOD = "default_input_method";
2049
2050        /**
2051         * Whether the device has been provisioned (0 = false, 1 = true)
2052         */
2053        public static final String DEVICE_PROVISIONED = "device_provisioned";
2054
2055        /**
2056         * List of input methods that are currently enabled.  This is a string
2057         * containing the IDs of all enabled input methods, each ID separated
2058         * by ':'.
2059         */
2060        public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
2061
2062        /**
2063         * Host name and port for a user-selected proxy.
2064         */
2065        public static final String HTTP_PROXY = "http_proxy";
2066
2067        /**
2068         * Whether the package installer should allow installation of apps downloaded from
2069         * sources other than the Android Market (vending machine).
2070         *
2071         * 1 = allow installing from other sources
2072         * 0 = only allow installing from the Android Market
2073         */
2074        public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
2075
2076        /**
2077         * Comma-separated list of location providers that activities may access.
2078         */
2079        public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
2080
2081        /**
2082         * Whether assisted GPS should be enabled or not.
2083         * @hide
2084         */
2085        public static final String ASSISTED_GPS_ENABLED = "assisted_gps_enabled";
2086
2087        /**
2088         * The Logging ID (a unique 64-bit value) as a hex string.
2089         * Used as a pseudonymous identifier for logging.
2090         * @deprecated This identifier is poorly initialized and has
2091         * many collisions.  It should not be used.
2092         */
2093        @Deprecated
2094        public static final String LOGGING_ID = "logging_id";
2095
2096        /**
2097         * User preference for which network(s) should be used. Only the
2098         * connectivity service should touch this.
2099         */
2100        public static final String NETWORK_PREFERENCE = "network_preference";
2101
2102        /**
2103         */
2104        public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
2105
2106        /**
2107         */
2108        public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
2109
2110        /**
2111         */
2112        public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
2113
2114        /**
2115         * Settings classname to launch when Settings is clicked from All
2116         * Applications.  Needed because of user testing between the old
2117         * and new Settings apps.
2118         */
2119        // TODO: 881807
2120        public static final String SETTINGS_CLASSNAME = "settings_classname";
2121
2122        /**
2123         * USB Mass Storage Enabled
2124         */
2125        public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
2126
2127        /**
2128         * If this setting is set (to anything), then all references
2129         * to Gmail on the device must change to Google Mail.
2130         */
2131        public static final String USE_GOOGLE_MAIL = "use_google_mail";
2132
2133        /**
2134         * If accessibility is enabled.
2135         */
2136        public static final String ACCESSIBILITY_ENABLED = "accessibility_enabled";
2137
2138        /**
2139         * List of the enabled accessibility providers.
2140         */
2141        public static final String ENABLED_ACCESSIBILITY_SERVICES =
2142            "enabled_accessibility_services";
2143
2144        /**
2145         * Setting to always use the default text-to-speech settings regardless
2146         * of the application settings.
2147         * 1 = override application settings,
2148         * 0 = use application settings (if specified).
2149         */
2150        public static final String TTS_USE_DEFAULTS = "tts_use_defaults";
2151
2152        /**
2153         * Default text-to-speech engine speech rate. 100 = 1x
2154         */
2155        public static final String TTS_DEFAULT_RATE = "tts_default_rate";
2156
2157        /**
2158         * Default text-to-speech engine pitch. 100 = 1x
2159         */
2160        public static final String TTS_DEFAULT_PITCH = "tts_default_pitch";
2161
2162        /**
2163         * Default text-to-speech engine.
2164         */
2165        public static final String TTS_DEFAULT_SYNTH = "tts_default_synth";
2166
2167        /**
2168         * Default text-to-speech language.
2169         */
2170        public static final String TTS_DEFAULT_LANG = "tts_default_lang";
2171
2172        /**
2173         * Default text-to-speech country.
2174         */
2175        public static final String TTS_DEFAULT_COUNTRY = "tts_default_country";
2176
2177        /**
2178         * Default text-to-speech locale variant.
2179         */
2180        public static final String TTS_DEFAULT_VARIANT = "tts_default_variant";
2181
2182        /**
2183         * Whether to notify the user of open networks.
2184         * <p>
2185         * If not connected and the scan results have an open network, we will
2186         * put this notification up. If we attempt to connect to a network or
2187         * the open network(s) disappear, we remove the notification. When we
2188         * show the notification, we will not show it again for
2189         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
2190         */
2191        public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
2192                "wifi_networks_available_notification_on";
2193
2194        /**
2195         * Delay (in seconds) before repeating the Wi-Fi networks available notification.
2196         * Connecting to a network will reset the timer.
2197         */
2198        public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
2199                "wifi_networks_available_repeat_delay";
2200
2201        /**
2202         * The number of radio channels that are allowed in the local
2203         * 802.11 regulatory domain.
2204         * @hide
2205         */
2206        public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
2207
2208        /**
2209         * When the number of open networks exceeds this number, the
2210         * least-recently-used excess networks will be removed.
2211         */
2212        public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
2213
2214        /**
2215         * Whether the Wi-Fi should be on.  Only the Wi-Fi service should touch this.
2216         */
2217        public static final String WIFI_ON = "wifi_on";
2218
2219        /**
2220         * The acceptable packet loss percentage (range 0 - 100) before trying
2221         * another AP on the same network.
2222         */
2223        public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2224                "wifi_watchdog_acceptable_packet_loss_percentage";
2225
2226        /**
2227         * The number of access points required for a network in order for the
2228         * watchdog to monitor it.
2229         */
2230        public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
2231
2232        /**
2233         * The delay between background checks.
2234         */
2235        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2236                "wifi_watchdog_background_check_delay_ms";
2237
2238        /**
2239         * Whether the Wi-Fi watchdog is enabled for background checking even
2240         * after it thinks the user has connected to a good access point.
2241         */
2242        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2243                "wifi_watchdog_background_check_enabled";
2244
2245        /**
2246         * The timeout for a background ping
2247         */
2248        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2249                "wifi_watchdog_background_check_timeout_ms";
2250
2251        /**
2252         * The number of initial pings to perform that *may* be ignored if they
2253         * fail. Again, if these fail, they will *not* be used in packet loss
2254         * calculation. For example, one network always seemed to time out for
2255         * the first couple pings, so this is set to 3 by default.
2256         */
2257        public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2258            "wifi_watchdog_initial_ignored_ping_count";
2259
2260        /**
2261         * The maximum number of access points (per network) to attempt to test.
2262         * If this number is reached, the watchdog will no longer monitor the
2263         * initial connection state for the network. This is a safeguard for
2264         * networks containing multiple APs whose DNS does not respond to pings.
2265         */
2266        public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
2267
2268        /**
2269         * Whether the Wi-Fi watchdog is enabled.
2270         */
2271        public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2272
2273        /**
2274         * A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.
2275         */
2276        public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2277
2278        /**
2279         * The number of pings to test if an access point is a good connection.
2280         */
2281        public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
2282
2283        /**
2284         * The delay between pings.
2285         */
2286        public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
2287
2288        /**
2289         * The timeout per ping.
2290         */
2291        public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
2292
2293        /**
2294         * The maximum number of times we will retry a connection to an access
2295         * point for which we have failed in acquiring an IP address from DHCP.
2296         * A value of N means that we will make N+1 connection attempts in all.
2297         */
2298        public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
2299
2300        /**
2301         * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2302         * data connectivity to be established after a disconnect from Wi-Fi.
2303         */
2304        public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2305            "wifi_mobile_data_transition_wakelock_timeout_ms";
2306
2307        /**
2308         * Whether background data usage is allowed by the user. See
2309         * ConnectivityManager for more info.
2310         */
2311        public static final String BACKGROUND_DATA = "background_data";
2312
2313        /**
2314         * The CDMA roaming mode 0 = Home Networks, CDMA default
2315         *                       1 = Roaming on Affiliated networks
2316         *                       2 = Roaming on any networks
2317         * @hide
2318         */
2319        public static final String CDMA_ROAMING_MODE = "roaming_settings";
2320
2321        /**
2322         * The CDMA subscription mode 0 = RUIM/SIM (default)
2323         *                                1 = NV
2324         * @hide
2325         */
2326        public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2327
2328        /**
2329         * The preferred network mode   7 = Global
2330         *                              6 = EvDo only
2331         *                              5 = CDMA w/o EvDo
2332         *                              4 = CDMA / EvDo auto
2333         *                              3 = GSM / WCDMA auto
2334         *                              2 = WCDMA only
2335         *                              1 = GSM only
2336         *                              0 = GSM / WCDMA preferred
2337         * @hide
2338         */
2339        public static final String PREFERRED_NETWORK_MODE =
2340                "preferred_network_mode";
2341
2342        /**
2343         * The preferred TTY mode     0 = TTy Off, CDMA default
2344         *                            1 = TTY Full
2345         *                            2 = TTY HCO
2346         *                            3 = TTY VCO
2347         * @hide
2348         */
2349        public static final String PREFERRED_TTY_MODE =
2350                "preferred_tty_mode";
2351
2352
2353        /**
2354         * CDMA Cell Broadcast SMS
2355         *                            0 = CDMA Cell Broadcast SMS disabled
2356         *                            1 = CDMA Cell Broadcast SMS enabled
2357         * @hide
2358         */
2359        public static final String CDMA_CELL_BROADCAST_SMS =
2360                "cdma_cell_broadcast_sms";
2361
2362        /**
2363         * The cdma subscription 0 = Subscription from RUIM, when available
2364         *                       1 = Subscription from NV
2365         * @hide
2366         */
2367        public static final String PREFERRED_CDMA_SUBSCRIPTION =
2368                "preferred_cdma_subscription";
2369
2370        /**
2371         * Whether the enhanced voice privacy mode is enabled.
2372         * 0 = normal voice privacy
2373         * 1 = enhanced voice privacy
2374         * @hide
2375         */
2376        public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
2377
2378        /**
2379         * Whether the TTY mode mode is enabled.
2380         * 0 = disabled
2381         * 1 = enabled
2382         * @hide
2383         */
2384        public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
2385
2386        /**
2387         * Flag for allowing service provider to use location information to improve products and
2388         * services.
2389         * Type: int ( 0 = disallow, 1 = allow )
2390         * @hide
2391         */
2392        public static final String USE_LOCATION_FOR_SERVICES = "use_location";
2393
2394        /**
2395         * Controls whether settings backup is enabled.
2396         * Type: int ( 0 = disabled, 1 = enabled )
2397         * @hide
2398         */
2399        public static final String BACKUP_ENABLED = "backup_enabled";
2400
2401        /**
2402         * Indicates whether settings backup has been fully provisioned.
2403         * Type: int ( 0 = unprovisioned, 1 = fully provisioned )
2404         * @hide
2405         */
2406        public static final String BACKUP_PROVISIONED = "backup_provisioned";
2407
2408        /**
2409         * Component of the transport to use for backup/restore.
2410         * @hide
2411         */
2412        public static final String BACKUP_TRANSPORT = "backup_transport";
2413
2414        /**
2415         * Version for which the setup wizard was last shown.  Bumped for
2416         * each release when there is new setup information to show.
2417         * @hide
2418         */
2419        public static final String LAST_SETUP_SHOWN = "last_setup_shown";
2420
2421        /**
2422         * How frequently (in seconds) to check the memory status of the
2423         * device.
2424         * @hide
2425         */
2426        public static final String MEMCHECK_INTERVAL = "memcheck_interval";
2427
2428        /**
2429         * Max frequency (in seconds) to log memory check stats, in realtime
2430         * seconds.  This allows for throttling of logs when the device is
2431         * running for large amounts of time.
2432         * @hide
2433         */
2434        public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
2435                "memcheck_log_realtime_interval";
2436
2437        /**
2438         * Boolean indicating whether rebooting due to system memory checks
2439         * is enabled.
2440         * @hide
2441         */
2442        public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
2443
2444        /**
2445         * How many bytes the system process must be below to avoid scheduling
2446         * a soft reboot.  This reboot will happen when it is next determined
2447         * to be a good time.
2448         * @hide
2449         */
2450        public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
2451
2452        /**
2453         * How many bytes the system process must be below to avoid scheduling
2454         * a hard reboot.  This reboot will happen immediately.
2455         * @hide
2456         */
2457        public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
2458
2459        /**
2460         * How many bytes the phone process must be below to avoid scheduling
2461         * a soft restart.  This restart will happen when it is next determined
2462         * to be a good time.
2463         * @hide
2464         */
2465        public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
2466
2467        /**
2468         * How many bytes the phone process must be below to avoid scheduling
2469         * a hard restart.  This restart will happen immediately.
2470         * @hide
2471         */
2472        public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
2473
2474        /**
2475         * Boolean indicating whether restarting the phone process due to
2476         * memory checks is enabled.
2477         * @hide
2478         */
2479        public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
2480
2481        /**
2482         * First time during the day it is okay to kill processes
2483         * or reboot the device due to low memory situations.  This number is
2484         * in seconds since midnight.
2485         * @hide
2486         */
2487        public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
2488
2489        /**
2490         * Last time during the day it is okay to kill processes
2491         * or reboot the device due to low memory situations.  This number is
2492         * in seconds since midnight.
2493         * @hide
2494         */
2495        public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
2496
2497        /**
2498         * How long the screen must have been off in order to kill processes
2499         * or reboot.  This number is in seconds.  A value of -1 means to
2500         * entirely disregard whether the screen is on.
2501         * @hide
2502         */
2503        public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
2504
2505        /**
2506         * How much time there must be until the next alarm in order to kill processes
2507         * or reboot.  This number is in seconds.  Note: this value must be
2508         * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
2509         * always see an alarm scheduled within its time.
2510         * @hide
2511         */
2512        public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
2513
2514        /**
2515         * How frequently to check whether it is a good time to restart things,
2516         * if the device is in a bad state.  This number is in seconds.  Note:
2517         * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
2518         * the alarm to schedule the recheck will always appear within the
2519         * minimum "do not execute now" time.
2520         * @hide
2521         */
2522        public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
2523
2524        /**
2525         * How frequently (in DAYS) to reboot the device.  If 0, no reboots
2526         * will occur.
2527         * @hide
2528         */
2529        public static final String REBOOT_INTERVAL = "reboot_interval";
2530
2531        /**
2532         * First time during the day it is okay to force a reboot of the
2533         * device (if REBOOT_INTERVAL is set).  This number is
2534         * in seconds since midnight.
2535         * @hide
2536         */
2537        public static final String REBOOT_START_TIME = "reboot_start_time";
2538
2539        /**
2540         * The window of time (in seconds) after each REBOOT_INTERVAL in which
2541         * a reboot can be executed.  If 0, a reboot will always be executed at
2542         * exactly the given time.  Otherwise, it will only be executed if
2543         * the device is idle within the window.
2544         * @hide
2545         */
2546        public static final String REBOOT_WINDOW = "reboot_window";
2547
2548        /**
2549         * Threshold values for the duration and level of a discharge cycle, under
2550         * which we log discharge cycle info.
2551         * @hide
2552         */
2553        public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
2554                "battery_discharge_duration_threshold";
2555        /** @hide */
2556        public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
2557
2558        /**
2559         * Flag for allowing ActivityManagerService to send ACTION_APP_ERROR intents
2560         * on application crashes and ANRs. If this is disabled, the crash/ANR dialog
2561         * will never display the "Report" button.
2562         * Type: int ( 0 = disallow, 1 = allow )
2563         * @hide
2564         */
2565        public static final String SEND_ACTION_APP_ERROR = "send_action_app_error";
2566
2567        /**
2568         * Nonzero causes Log.wtf() to crash.
2569         * @hide
2570         */
2571        public static final String WTF_IS_FATAL = "wtf_is_fatal";
2572
2573        /**
2574         * Maximum age of entries kept by {@link android.os.IDropBox}.
2575         * @hide
2576         */
2577        public static final String DROPBOX_AGE_SECONDS =
2578                "dropbox_age_seconds";
2579        /**
2580         * Maximum amount of disk space used by {@link android.os.IDropBox} no matter what.
2581         * @hide
2582         */
2583        public static final String DROPBOX_QUOTA_KB =
2584                "dropbox_quota_kb";
2585        /**
2586         * Percent of free disk (excluding reserve) which {@link android.os.IDropBox} will use.
2587         * @hide
2588         */
2589        public static final String DROPBOX_QUOTA_PERCENT =
2590                "dropbox_quota_percent";
2591        /**
2592         * Percent of total disk which {@link android.os.IDropBox} will never dip into.
2593         * @hide
2594         */
2595        public static final String DROPBOX_RESERVE_PERCENT =
2596                "dropbox_reserve_percent";
2597        /**
2598         * Prefix for per-tag dropbox disable/enable settings.
2599         * @hide
2600         */
2601        public static final String DROPBOX_TAG_PREFIX =
2602                "dropbox:";
2603
2604
2605        /**
2606         * Screen timeout in milliseconds corresponding to the
2607         * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
2608         * possible screen timeout behavior.)
2609         * @hide
2610         */
2611        public static final String SHORT_KEYLIGHT_DELAY_MS =
2612                "short_keylight_delay_ms";
2613
2614        /**
2615         * The interval in minutes after which the amount of free storage left on the
2616         * device is logged to the event log
2617         * @hide
2618         */
2619        public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
2620                "sys_free_storage_log_interval";
2621
2622        /**
2623         * Threshold for the amount of change in disk free space required to report the amount of
2624         * free space. Used to prevent spamming the logs when the disk free space isn't changing
2625         * frequently.
2626         * @hide
2627         */
2628        public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
2629                "disk_free_change_reporting_threshold";
2630
2631
2632        /**
2633         * Minimum percentage of free storage on the device that is used to determine if
2634         * the device is running low on storage.
2635         * Say this value is set to 10, the device is considered running low on storage
2636         * if 90% or more of the device storage is filled up.
2637         * @hide
2638         */
2639        public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
2640                "sys_storage_threshold_percentage";
2641
2642        /**
2643         * The interval in milliseconds after which Wi-Fi is considered idle.
2644         * When idle, it is possible for the device to be switched from Wi-Fi to
2645         * the mobile data network.
2646         * @hide
2647         */
2648        public static final String WIFI_IDLE_MS = "wifi_idle_ms";
2649
2650        /**
2651         * The interval in milliseconds at which to check packet counts on the
2652         * mobile data interface when screen is on, to detect possible data
2653         * connection problems.
2654         * @hide
2655         */
2656        public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
2657                "pdp_watchdog_poll_interval_ms";
2658
2659        /**
2660         * The interval in milliseconds at which to check packet counts on the
2661         * mobile data interface when screen is off, to detect possible data
2662         * connection problems.
2663         * @hide
2664         */
2665        public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
2666                "pdp_watchdog_long_poll_interval_ms";
2667
2668        /**
2669         * The interval in milliseconds at which to check packet counts on the
2670         * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
2671         * outgoing packets has been reached without incoming packets.
2672         * @hide
2673         */
2674        public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
2675                "pdp_watchdog_error_poll_interval_ms";
2676
2677        /**
2678         * The number of outgoing packets sent without seeing an incoming packet
2679         * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
2680         * device is logged to the event log
2681         * @hide
2682         */
2683        public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
2684                "pdp_watchdog_trigger_packet_count";
2685
2686        /**
2687         * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
2688         * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
2689         * attempting data connection recovery.
2690         * @hide
2691         */
2692        public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
2693                "pdp_watchdog_error_poll_count";
2694
2695        /**
2696         * The number of failed PDP reset attempts before moving to something more
2697         * drastic: re-registering to the network.
2698         * @hide
2699         */
2700        public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
2701                "pdp_watchdog_max_pdp_reset_fail_count";
2702
2703        /**
2704         * Address to ping as a last sanity check before attempting any recovery.
2705         * Unset or set to "0.0.0.0" to skip this check.
2706         * @hide
2707         */
2708        public static final String PDP_WATCHDOG_PING_ADDRESS = "pdp_watchdog_ping_address";
2709
2710        /**
2711         * The "-w deadline" parameter for the ping, ie, the max time in
2712         * seconds to spend pinging.
2713         * @hide
2714         */
2715        public static final String PDP_WATCHDOG_PING_DEADLINE = "pdp_watchdog_ping_deadline";
2716
2717        /**
2718         * The interval in milliseconds at which to check gprs registration
2719         * after the first registration mismatch of gprs and voice service,
2720         * to detect possible data network registration problems.
2721         *
2722         * @hide
2723         */
2724        public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
2725                "gprs_register_check_period_ms";
2726
2727        /**
2728         * The length of time in milli-seconds that automatic small adjustments to
2729         * SystemClock are ignored if NITZ_UPDATE_DIFF is not exceeded.
2730         * @hide
2731         */
2732        public static final String NITZ_UPDATE_SPACING = "nitz_update_spacing";
2733
2734        /**
2735         * If the NITZ_UPDATE_DIFF time is exceeded then an automatic adjustment
2736         * to SystemClock will be allowed even if NITZ_UPDATE_SPACING has not been
2737         * exceeded.
2738         * @hide
2739         */
2740        public static final String NITZ_UPDATE_DIFF = "nitz_update_diff";
2741
2742        /**
2743         * The maximum reconnect delay for short network outages or when the network is suspended
2744         * due to phone use.
2745         * @hide
2746         */
2747        public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
2748                "sync_max_retry_delay_in_seconds";
2749
2750        /**
2751         * The interval in milliseconds at which to check the number of SMS sent
2752         * out without asking for use permit, to limit the un-authorized SMS
2753         * usage.
2754         * @hide
2755         */
2756        public static final String SMS_OUTGOING_CHECK_INTERVAL_MS =
2757                "sms_outgoing_check_interval_ms";
2758
2759        /**
2760         * The number of outgoing SMS sent without asking for user permit
2761         * (of {@link #SMS_OUTGOING_CHECK_INTERVAL_MS}
2762         * @hide
2763         */
2764        public static final String SMS_OUTGOING_CHECK_MAX_COUNT =
2765                "sms_outgoing_check_max_count";
2766
2767        /**
2768         * Enable use of ssl session caching.
2769         * 'db' - save each session in a (per process) database
2770         * 'file' - save each session in a (per process) file
2771         * not set or any other value - normal java in-memory caching
2772         * @hide
2773         */
2774        public static final String SSL_SESSION_CACHE = "ssl_session_cache";
2775
2776        /**
2777         * How many bytes long a message has to be, in order to be gzipped.
2778         * @hide
2779         */
2780        public static final String SYNC_MIN_GZIP_BYTES =
2781                "sync_min_gzip_bytes";
2782
2783        /**
2784         * The number of promoted sources in GlobalSearch.
2785         * @hide
2786         */
2787        public static final String SEARCH_NUM_PROMOTED_SOURCES = "search_num_promoted_sources";
2788        /**
2789         * The maximum number of suggestions returned by GlobalSearch.
2790         * @hide
2791         */
2792        public static final String SEARCH_MAX_RESULTS_TO_DISPLAY = "search_max_results_to_display";
2793        /**
2794         * The number of suggestions GlobalSearch will ask each non-web search source for.
2795         * @hide
2796         */
2797        public static final String SEARCH_MAX_RESULTS_PER_SOURCE = "search_max_results_per_source";
2798        /**
2799         * The number of suggestions the GlobalSearch will ask the web search source for.
2800         * @hide
2801         */
2802        public static final String SEARCH_WEB_RESULTS_OVERRIDE_LIMIT =
2803                "search_web_results_override_limit";
2804        /**
2805         * The number of milliseconds that GlobalSearch will wait for suggestions from
2806         * promoted sources before continuing with all other sources.
2807         * @hide
2808         */
2809        public static final String SEARCH_PROMOTED_SOURCE_DEADLINE_MILLIS =
2810                "search_promoted_source_deadline_millis";
2811        /**
2812         * The number of milliseconds before GlobalSearch aborts search suggesiton queries.
2813         * @hide
2814         */
2815        public static final String SEARCH_SOURCE_TIMEOUT_MILLIS = "search_source_timeout_millis";
2816        /**
2817         * The maximum number of milliseconds that GlobalSearch shows the previous results
2818         * after receiving a new query.
2819         * @hide
2820         */
2821        public static final String SEARCH_PREFILL_MILLIS = "search_prefill_millis";
2822        /**
2823         * The maximum age of log data used for shortcuts in GlobalSearch.
2824         * @hide
2825         */
2826        public static final String SEARCH_MAX_STAT_AGE_MILLIS = "search_max_stat_age_millis";
2827        /**
2828         * The maximum age of log data used for source ranking in GlobalSearch.
2829         * @hide
2830         */
2831        public static final String SEARCH_MAX_SOURCE_EVENT_AGE_MILLIS =
2832                "search_max_source_event_age_millis";
2833        /**
2834         * The minimum number of impressions needed to rank a source in GlobalSearch.
2835         * @hide
2836         */
2837        public static final String SEARCH_MIN_IMPRESSIONS_FOR_SOURCE_RANKING =
2838                "search_min_impressions_for_source_ranking";
2839        /**
2840         * The minimum number of clicks needed to rank a source in GlobalSearch.
2841         * @hide
2842         */
2843        public static final String SEARCH_MIN_CLICKS_FOR_SOURCE_RANKING =
2844                "search_min_clicks_for_source_ranking";
2845        /**
2846         * The maximum number of shortcuts shown by GlobalSearch.
2847         * @hide
2848         */
2849        public static final String SEARCH_MAX_SHORTCUTS_RETURNED = "search_max_shortcuts_returned";
2850        /**
2851         * The size of the core thread pool for suggestion queries in GlobalSearch.
2852         * @hide
2853         */
2854        public static final String SEARCH_QUERY_THREAD_CORE_POOL_SIZE =
2855                "search_query_thread_core_pool_size";
2856        /**
2857         * The maximum size of the thread pool for suggestion queries in GlobalSearch.
2858         * @hide
2859         */
2860        public static final String SEARCH_QUERY_THREAD_MAX_POOL_SIZE =
2861                "search_query_thread_max_pool_size";
2862        /**
2863         * The size of the core thread pool for shortcut refreshing in GlobalSearch.
2864         * @hide
2865         */
2866        public static final String SEARCH_SHORTCUT_REFRESH_CORE_POOL_SIZE =
2867                "search_shortcut_refresh_core_pool_size";
2868        /**
2869         * The maximum size of the thread pool for shortcut refreshing in GlobalSearch.
2870         * @hide
2871         */
2872        public static final String SEARCH_SHORTCUT_REFRESH_MAX_POOL_SIZE =
2873                "search_shortcut_refresh_max_pool_size";
2874        /**
2875         * The maximun time that excess threads in the GlobalSeach thread pools will
2876         * wait before terminating.
2877         * @hide
2878         */
2879        public static final String SEARCH_THREAD_KEEPALIVE_SECONDS =
2880                "search_thread_keepalive_seconds";
2881        /**
2882         * The maximum number of concurrent suggestion queries to each source.
2883         * @hide
2884         */
2885        public static final String SEARCH_PER_SOURCE_CONCURRENT_QUERY_LIMIT =
2886                "search_per_source_concurrent_query_limit";
2887
2888        /**
2889         * Whether or not alert sounds are played on MountService events. (0 = false, 1 = true)
2890         * @hide
2891         */
2892        public static final String MOUNT_PLAY_NOTIFICATION_SND = "mount_play_not_snd";
2893
2894        /**
2895         * Whether or not UMS auto-starts on UMS host detection. (0 = false, 1 = true)
2896         * @hide
2897         */
2898        public static final String MOUNT_UMS_AUTOSTART = "mount_ums_autostart";
2899
2900        /**
2901         * Whether or not a notification is displayed on UMS host detection. (0 = false, 1 = true)
2902         * @hide
2903         */
2904        public static final String MOUNT_UMS_PROMPT = "mount_ums_prompt";
2905
2906        /**
2907         * Whether or not a notification is displayed while UMS is enabled. (0 = false, 1 = true)
2908         * @hide
2909         */
2910        public static final String MOUNT_UMS_NOTIFY_ENABLED = "mount_ums_notify_enabled";
2911
2912        /**
2913         * If nonzero, ANRs in invisible background processes bring up a dialog.
2914         * Otherwise, the process will be silently killed.
2915         * @hide
2916         */
2917        public static final String ANR_SHOW_BACKGROUND = "anr_show_background";
2918
2919        /**
2920         * @hide
2921         */
2922        public static final String[] SETTINGS_TO_BACKUP = {
2923            ADB_ENABLED,
2924            ALLOW_MOCK_LOCATION,
2925            PARENTAL_CONTROL_ENABLED,
2926            PARENTAL_CONTROL_REDIRECT_URL,
2927            USB_MASS_STORAGE_ENABLED,
2928            ACCESSIBILITY_ENABLED,
2929            ENABLED_ACCESSIBILITY_SERVICES,
2930            TTS_USE_DEFAULTS,
2931            TTS_DEFAULT_RATE,
2932            TTS_DEFAULT_PITCH,
2933            TTS_DEFAULT_SYNTH,
2934            TTS_DEFAULT_LANG,
2935            TTS_DEFAULT_COUNTRY,
2936            WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON,
2937            WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY,
2938            WIFI_NUM_ALLOWED_CHANNELS,
2939            WIFI_NUM_OPEN_NETWORKS_KEPT,
2940            MOUNT_PLAY_NOTIFICATION_SND,
2941            MOUNT_UMS_AUTOSTART,
2942            MOUNT_UMS_PROMPT,
2943            MOUNT_UMS_NOTIFY_ENABLED
2944        };
2945
2946        /**
2947         * Helper method for determining if a location provider is enabled.
2948         * @param cr the content resolver to use
2949         * @param provider the location provider to query
2950         * @return true if the provider is enabled
2951         *
2952         * @hide
2953         */
2954        public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
2955            String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
2956            if (allowedProviders != null) {
2957                return (allowedProviders.equals(provider) ||
2958                        allowedProviders.contains("," + provider + ",") ||
2959                        allowedProviders.startsWith(provider + ",") ||
2960                        allowedProviders.endsWith("," + provider));
2961            }
2962            return false;
2963        }
2964
2965        /**
2966         * Thread-safe method for enabling or disabling a single location provider.
2967         * @param cr the content resolver to use
2968         * @param provider the location provider to enable or disable
2969         * @param enabled true if the provider should be enabled
2970         *
2971         * @hide
2972         */
2973        public static final void setLocationProviderEnabled(ContentResolver cr,
2974                String provider, boolean enabled) {
2975            // to ensure thread safety, we write the provider name with a '+' or '-'
2976            // and let the SettingsProvider handle it rather than reading and modifying
2977            // the list of enabled providers.
2978            if (enabled) {
2979                provider = "+" + provider;
2980            } else {
2981                provider = "-" + provider;
2982            }
2983            putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
2984        }
2985    }
2986
2987    /**
2988     * User-defined bookmarks and shortcuts.  The target of each bookmark is an
2989     * Intent URL, allowing it to be either a web page or a particular
2990     * application activity.
2991     *
2992     * @hide
2993     */
2994    public static final class Bookmarks implements BaseColumns
2995    {
2996        private static final String TAG = "Bookmarks";
2997
2998        /**
2999         * The content:// style URL for this table
3000         */
3001        public static final Uri CONTENT_URI =
3002            Uri.parse("content://" + AUTHORITY + "/bookmarks");
3003
3004        /**
3005         * The row ID.
3006         * <p>Type: INTEGER</p>
3007         */
3008        public static final String ID = "_id";
3009
3010        /**
3011         * Descriptive name of the bookmark that can be displayed to the user.
3012         * If this is empty, the title should be resolved at display time (use
3013         * {@link #getTitle(Context, Cursor)} any time you want to display the
3014         * title of a bookmark.)
3015         * <P>
3016         * Type: TEXT
3017         * </P>
3018         */
3019        public static final String TITLE = "title";
3020
3021        /**
3022         * Arbitrary string (displayed to the user) that allows bookmarks to be
3023         * organized into categories.  There are some special names for
3024         * standard folders, which all start with '@'.  The label displayed for
3025         * the folder changes with the locale (via {@link #getLabelForFolder}) but
3026         * the folder name does not change so you can consistently query for
3027         * the folder regardless of the current locale.
3028         *
3029         * <P>Type: TEXT</P>
3030         *
3031         */
3032        public static final String FOLDER = "folder";
3033
3034        /**
3035         * The Intent URL of the bookmark, describing what it points to.  This
3036         * value is given to {@link android.content.Intent#getIntent} to create
3037         * an Intent that can be launched.
3038         * <P>Type: TEXT</P>
3039         */
3040        public static final String INTENT = "intent";
3041
3042        /**
3043         * Optional shortcut character associated with this bookmark.
3044         * <P>Type: INTEGER</P>
3045         */
3046        public static final String SHORTCUT = "shortcut";
3047
3048        /**
3049         * The order in which the bookmark should be displayed
3050         * <P>Type: INTEGER</P>
3051         */
3052        public static final String ORDERING = "ordering";
3053
3054        private static final String[] sIntentProjection = { INTENT };
3055        private static final String[] sShortcutProjection = { ID, SHORTCUT };
3056        private static final String sShortcutSelection = SHORTCUT + "=?";
3057
3058        /**
3059         * Convenience function to retrieve the bookmarked Intent for a
3060         * particular shortcut key.
3061         *
3062         * @param cr The ContentResolver to query.
3063         * @param shortcut The shortcut key.
3064         *
3065         * @return Intent The bookmarked URL, or null if there is no bookmark
3066         *         matching the given shortcut.
3067         */
3068        public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3069        {
3070            Intent intent = null;
3071
3072            Cursor c = cr.query(CONTENT_URI,
3073                    sIntentProjection, sShortcutSelection,
3074                    new String[] { String.valueOf((int) shortcut) }, ORDERING);
3075            // Keep trying until we find a valid shortcut
3076            try {
3077                while (intent == null && c.moveToNext()) {
3078                    try {
3079                        String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
3080                        intent = Intent.getIntent(intentURI);
3081                    } catch (java.net.URISyntaxException e) {
3082                        // The stored URL is bad...  ignore it.
3083                    } catch (IllegalArgumentException e) {
3084                        // Column not found
3085                        Log.w(TAG, "Intent column not found", e);
3086                    }
3087                }
3088            } finally {
3089                if (c != null) c.close();
3090            }
3091
3092            return intent;
3093        }
3094
3095        /**
3096         * Add a new bookmark to the system.
3097         *
3098         * @param cr The ContentResolver to query.
3099         * @param intent The desired target of the bookmark.
3100         * @param title Bookmark title that is shown to the user; null if none
3101         *            or it should be resolved to the intent's title.
3102         * @param folder Folder in which to place the bookmark; null if none.
3103         * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3104         *            this is non-zero and there is an existing bookmark entry
3105         *            with this same shortcut, then that existing shortcut is
3106         *            cleared (the bookmark is not removed).
3107         * @return The unique content URL for the new bookmark entry.
3108         */
3109        public static Uri add(ContentResolver cr,
3110                                           Intent intent,
3111                                           String title,
3112                                           String folder,
3113                                           char shortcut,
3114                                           int ordering)
3115        {
3116            // If a shortcut is supplied, and it is already defined for
3117            // another bookmark, then remove the old definition.
3118            if (shortcut != 0) {
3119                Cursor c = cr.query(CONTENT_URI,
3120                        sShortcutProjection, sShortcutSelection,
3121                        new String[] { String.valueOf((int) shortcut) }, null);
3122                try {
3123                    if (c.moveToFirst()) {
3124                        while (c.getCount() > 0) {
3125                            if (!c.deleteRow()) {
3126                                Log.w(TAG, "Could not delete existing shortcut row");
3127                            }
3128                        }
3129                    }
3130                } finally {
3131                    if (c != null) c.close();
3132                }
3133            }
3134
3135            ContentValues values = new ContentValues();
3136            if (title != null) values.put(TITLE, title);
3137            if (folder != null) values.put(FOLDER, folder);
3138            values.put(INTENT, intent.toURI());
3139            if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3140            values.put(ORDERING, ordering);
3141            return cr.insert(CONTENT_URI, values);
3142        }
3143
3144        /**
3145         * Return the folder name as it should be displayed to the user.  This
3146         * takes care of localizing special folders.
3147         *
3148         * @param r Resources object for current locale; only need access to
3149         *          system resources.
3150         * @param folder The value found in the {@link #FOLDER} column.
3151         *
3152         * @return CharSequence The label for this folder that should be shown
3153         *         to the user.
3154         */
3155        public static CharSequence getLabelForFolder(Resources r, String folder) {
3156            return folder;
3157        }
3158
3159        /**
3160         * Return the title as it should be displayed to the user. This takes
3161         * care of localizing bookmarks that point to activities.
3162         *
3163         * @param context A context.
3164         * @param cursor A cursor pointing to the row whose title should be
3165         *        returned. The cursor must contain at least the {@link #TITLE}
3166         *        and {@link #INTENT} columns.
3167         * @return A title that is localized and can be displayed to the user,
3168         *         or the empty string if one could not be found.
3169         */
3170        public static CharSequence getTitle(Context context, Cursor cursor) {
3171            int titleColumn = cursor.getColumnIndex(TITLE);
3172            int intentColumn = cursor.getColumnIndex(INTENT);
3173            if (titleColumn == -1 || intentColumn == -1) {
3174                throw new IllegalArgumentException(
3175                        "The cursor must contain the TITLE and INTENT columns.");
3176            }
3177
3178            String title = cursor.getString(titleColumn);
3179            if (!TextUtils.isEmpty(title)) {
3180                return title;
3181            }
3182
3183            String intentUri = cursor.getString(intentColumn);
3184            if (TextUtils.isEmpty(intentUri)) {
3185                return "";
3186            }
3187
3188            Intent intent;
3189            try {
3190                intent = Intent.getIntent(intentUri);
3191            } catch (URISyntaxException e) {
3192                return "";
3193            }
3194
3195            PackageManager packageManager = context.getPackageManager();
3196            ResolveInfo info = packageManager.resolveActivity(intent, 0);
3197            return info != null ? info.loadLabel(packageManager) : "";
3198        }
3199    }
3200
3201    /**
3202     * Returns the device ID that we should use when connecting to the mobile gtalk server.
3203     * This is a string like "android-0x1242", where the hex string is the Android ID obtained
3204     * from the GoogleLoginService.
3205     *
3206     * @param androidId The Android ID for this device.
3207     * @return The device ID that should be used when connecting to the mobile gtalk server.
3208     * @hide
3209     */
3210    public static String getGTalkDeviceId(long androidId) {
3211        return "android-" + Long.toHexString(androidId);
3212    }
3213}
3214