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