Settings.java revision 350feeb8368846d674321db4fc1bee233959e4cf
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         * Whether the sounds effects (key clicks, lid open ...) are enabled. The value is
1294         * boolean (1 or 0).
1295         */
1296        public static final String SOUND_EFFECTS_ENABLED = "sound_effects_enabled";
1297
1298        /**
1299         * Whether the haptic feedback (long presses, ...) are enabled. The value is
1300         * boolean (1 or 0).
1301         */
1302        public static final String HAPTIC_FEEDBACK_ENABLED = "haptic_feedback_enabled";
1303
1304        /**
1305         * Whether live web suggestions while the user types into search dialogs are
1306         * enabled. Browsers and other search UIs should respect this, as it allows
1307         * a user to avoid sending partial queries to a search engine, if it poses
1308         * any privacy concern. The value is boolean (1 or 0).
1309         */
1310        public static final String SHOW_WEB_SUGGESTIONS = "show_web_suggestions";
1311
1312        // Settings moved to Settings.Secure
1313
1314        /**
1315         * @deprecated Use {@link android.provider.Settings.Secure#ADB_ENABLED}
1316         * instead
1317         */
1318        @Deprecated
1319        public static final String ADB_ENABLED = Secure.ADB_ENABLED;
1320
1321        /**
1322         * @deprecated Use {@link android.provider.Settings.Secure#ANDROID_ID} instead
1323         */
1324        @Deprecated
1325        public static final String ANDROID_ID = Secure.ANDROID_ID;
1326
1327        /**
1328         * @deprecated Use {@link android.provider.Settings.Secure#BLUETOOTH_ON} instead
1329         */
1330        @Deprecated
1331        public static final String BLUETOOTH_ON = Secure.BLUETOOTH_ON;
1332
1333        /**
1334         * @deprecated Use {@link android.provider.Settings.Secure#DATA_ROAMING} instead
1335         */
1336        @Deprecated
1337        public static final String DATA_ROAMING = Secure.DATA_ROAMING;
1338
1339        /**
1340         * @deprecated Use {@link android.provider.Settings.Secure#DEVICE_PROVISIONED} instead
1341         */
1342        @Deprecated
1343        public static final String DEVICE_PROVISIONED = Secure.DEVICE_PROVISIONED;
1344
1345        /**
1346         * @deprecated Use {@link android.provider.Settings.Secure#HTTP_PROXY} instead
1347         */
1348        @Deprecated
1349        public static final String HTTP_PROXY = Secure.HTTP_PROXY;
1350
1351        /**
1352         * @deprecated Use {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS} instead
1353         */
1354        @Deprecated
1355        public static final String INSTALL_NON_MARKET_APPS = Secure.INSTALL_NON_MARKET_APPS;
1356
1357        /**
1358         * @deprecated Use {@link android.provider.Settings.Secure#LOCATION_PROVIDERS_ALLOWED}
1359         * instead
1360         */
1361        @Deprecated
1362        public static final String LOCATION_PROVIDERS_ALLOWED = Secure.LOCATION_PROVIDERS_ALLOWED;
1363
1364        /**
1365         * @deprecated Use {@link android.provider.Settings.Secure#LOGGING_ID} instead
1366         */
1367        @Deprecated
1368        public static final String LOGGING_ID = Secure.LOGGING_ID;
1369
1370        /**
1371         * @deprecated Use {@link android.provider.Settings.Secure#NETWORK_PREFERENCE} instead
1372         */
1373        @Deprecated
1374        public static final String NETWORK_PREFERENCE = Secure.NETWORK_PREFERENCE;
1375
1376        /**
1377         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_ENABLED}
1378         * instead
1379         */
1380        @Deprecated
1381        public static final String PARENTAL_CONTROL_ENABLED = Secure.PARENTAL_CONTROL_ENABLED;
1382
1383        /**
1384         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_LAST_UPDATE}
1385         * instead
1386         */
1387        @Deprecated
1388        public static final String PARENTAL_CONTROL_LAST_UPDATE = Secure.PARENTAL_CONTROL_LAST_UPDATE;
1389
1390        /**
1391         * @deprecated Use {@link android.provider.Settings.Secure#PARENTAL_CONTROL_REDIRECT_URL}
1392         * instead
1393         */
1394        @Deprecated
1395        public static final String PARENTAL_CONTROL_REDIRECT_URL =
1396            Secure.PARENTAL_CONTROL_REDIRECT_URL;
1397
1398        /**
1399         * @deprecated Use {@link android.provider.Settings.Secure#SETTINGS_CLASSNAME} instead
1400         */
1401        @Deprecated
1402        public static final String SETTINGS_CLASSNAME = Secure.SETTINGS_CLASSNAME;
1403
1404        /**
1405         * @deprecated Use {@link android.provider.Settings.Secure#USB_MASS_STORAGE_ENABLED} instead
1406         */
1407        @Deprecated
1408        public static final String USB_MASS_STORAGE_ENABLED = Secure.USB_MASS_STORAGE_ENABLED;
1409
1410        /**
1411         * @deprecated Use {@link android.provider.Settings.Secure#USE_GOOGLE_MAIL} instead
1412         */
1413        @Deprecated
1414        public static final String USE_GOOGLE_MAIL = Secure.USE_GOOGLE_MAIL;
1415
1416//       /**
1417//         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_MAX_DHCP_RETRY_COUNT}
1418//         * instead
1419//         */
1420        @Deprecated
1421        public static final String WIFI_MAX_DHCP_RETRY_COUNT = Secure.WIFI_MAX_DHCP_RETRY_COUNT;
1422
1423//        /**
1424//         * @deprecated Use
1425//         * {@link android.provider.Settings.Secure#WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS}
1426//         * instead
1427//         */
1428        @Deprecated
1429        public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
1430                Secure.WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS;
1431
1432        /**
1433         * @deprecated Use
1434         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON} instead
1435         */
1436        @Deprecated
1437        public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1438            Secure.WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON;
1439
1440        /**
1441         * @deprecated Use
1442         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} instead
1443         */
1444        @Deprecated
1445        public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1446            Secure.WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY;
1447
1448        /**
1449         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_NUM_OPEN_NETWORKS_KEPT}
1450         * instead
1451         */
1452        @Deprecated
1453        public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = Secure.WIFI_NUM_OPEN_NETWORKS_KEPT;
1454
1455        /**
1456         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_ON} instead
1457         */
1458        @Deprecated
1459        public static final String WIFI_ON = Secure.WIFI_ON;
1460
1461        /**
1462         * @deprecated Use
1463         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE}
1464         * instead
1465         */
1466        @Deprecated
1467        public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
1468                Secure.WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE;
1469
1470        /**
1471         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_AP_COUNT} instead
1472         */
1473        @Deprecated
1474        public static final String WIFI_WATCHDOG_AP_COUNT = Secure.WIFI_WATCHDOG_AP_COUNT;
1475
1476        /**
1477         * @deprecated Use
1478         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS} instead
1479         */
1480        @Deprecated
1481        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
1482                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS;
1483
1484        /**
1485         * @deprecated Use
1486         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED} instead
1487         */
1488        @Deprecated
1489        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
1490                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED;
1491
1492        /**
1493         * @deprecated Use
1494         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS}
1495         * instead
1496         */
1497        @Deprecated
1498        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
1499                Secure.WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS;
1500
1501        /**
1502         * @deprecated Use
1503         * {@link android.provider.Settings.Secure#WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT} instead
1504         */
1505        @Deprecated
1506        public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
1507            Secure.WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT;
1508
1509        /**
1510         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_MAX_AP_CHECKS}
1511         * instead
1512         */
1513        @Deprecated
1514        public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = Secure.WIFI_WATCHDOG_MAX_AP_CHECKS;
1515
1516        /**
1517         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_ON} instead
1518         */
1519        @Deprecated
1520        public static final String WIFI_WATCHDOG_ON = Secure.WIFI_WATCHDOG_ON;
1521
1522        /**
1523         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_COUNT} instead
1524         */
1525        @Deprecated
1526        public static final String WIFI_WATCHDOG_PING_COUNT = Secure.WIFI_WATCHDOG_PING_COUNT;
1527
1528        /**
1529         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_DELAY_MS}
1530         * instead
1531         */
1532        @Deprecated
1533        public static final String WIFI_WATCHDOG_PING_DELAY_MS = Secure.WIFI_WATCHDOG_PING_DELAY_MS;
1534
1535        /**
1536         * @deprecated Use {@link android.provider.Settings.Secure#WIFI_WATCHDOG_PING_TIMEOUT_MS}
1537         * instead
1538         */
1539        @Deprecated
1540        public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS =
1541            Secure.WIFI_WATCHDOG_PING_TIMEOUT_MS;
1542    }
1543
1544    /**
1545     * Secure system settings, containing system preferences that applications
1546     * can read but are not allowed to write.  These are for preferences that
1547     * the user must explicitly modify through the system UI or specialized
1548     * APIs for those values, not modified directly by applications.
1549     */
1550    public static final class Secure extends NameValueTable {
1551        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_secure_version";
1552
1553        private static volatile NameValueCache mNameValueCache = null;
1554
1555        /**
1556         * Look up a name in the database.
1557         * @param resolver to access the database with
1558         * @param name to look up in the table
1559         * @return the corresponding value, or null if not present
1560         */
1561        public synchronized static String getString(ContentResolver resolver, String name) {
1562            if (mNameValueCache == null) {
1563                mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
1564            }
1565            return mNameValueCache.getString(resolver, name);
1566        }
1567
1568        /**
1569         * Store a name/value pair into the database.
1570         * @param resolver to access the database with
1571         * @param name to store
1572         * @param value to associate with the name
1573         * @return true if the value was set, false on database errors
1574         */
1575        public static boolean putString(ContentResolver resolver,
1576                String name, String value) {
1577            return putString(resolver, CONTENT_URI, name, value);
1578        }
1579
1580        /**
1581         * Construct the content URI for a particular name/value pair,
1582         * useful for monitoring changes with a ContentObserver.
1583         * @param name to look up in the table
1584         * @return the corresponding content URI, or null if not present
1585         */
1586        public static Uri getUriFor(String name) {
1587            return getUriFor(CONTENT_URI, name);
1588        }
1589
1590        /**
1591         * Convenience function for retrieving a single secure settings value
1592         * as an integer.  Note that internally setting values are always
1593         * stored as strings; this function converts the string to an integer
1594         * for you.  The default value will be returned if the setting is
1595         * not defined or not an integer.
1596         *
1597         * @param cr The ContentResolver to access.
1598         * @param name The name of the setting to retrieve.
1599         * @param def Value to return if the setting is not defined.
1600         *
1601         * @return The setting's current value, or 'def' if it is not defined
1602         * or not a valid integer.
1603         */
1604        public static int getInt(ContentResolver cr, String name, int def) {
1605            String v = getString(cr, name);
1606            try {
1607                return v != null ? Integer.parseInt(v) : def;
1608            } catch (NumberFormatException e) {
1609                return def;
1610            }
1611        }
1612
1613        /**
1614         * Convenience function for retrieving a single secure settings value
1615         * as an integer.  Note that internally setting values are always
1616         * stored as strings; this function converts the string to an integer
1617         * for you.
1618         * <p>
1619         * This version does not take a default value.  If the setting has not
1620         * been set, or the string value is not a number,
1621         * it throws {@link SettingNotFoundException}.
1622         *
1623         * @param cr The ContentResolver to access.
1624         * @param name The name of the setting to retrieve.
1625         *
1626         * @throws SettingNotFoundException Thrown if a setting by the given
1627         * name can't be found or the setting value is not an integer.
1628         *
1629         * @return The setting's current value.
1630         */
1631        public static int getInt(ContentResolver cr, String name)
1632                throws SettingNotFoundException {
1633            String v = getString(cr, name);
1634            try {
1635                return Integer.parseInt(v);
1636            } catch (NumberFormatException e) {
1637                throw new SettingNotFoundException(name);
1638            }
1639        }
1640
1641        /**
1642         * Convenience function for updating a single settings value as an
1643         * integer. This will either create a new entry in the table if the
1644         * given name does not exist, or modify the value of the existing row
1645         * with that name.  Note that internally setting values are always
1646         * stored as strings, so this function converts the given value to a
1647         * string before storing it.
1648         *
1649         * @param cr The ContentResolver to access.
1650         * @param name The name of the setting to modify.
1651         * @param value The new value for the setting.
1652         * @return true if the value was set, false on database errors
1653         */
1654        public static boolean putInt(ContentResolver cr, String name, int value) {
1655            return putString(cr, name, Integer.toString(value));
1656        }
1657
1658        /**
1659         * Convenience function for retrieving a single secure settings value
1660         * as a {@code long}.  Note that internally setting values are always
1661         * stored as strings; this function converts the string to a {@code long}
1662         * for you.  The default value will be returned if the setting is
1663         * not defined or not a {@code long}.
1664         *
1665         * @param cr The ContentResolver to access.
1666         * @param name The name of the setting to retrieve.
1667         * @param def Value to return if the setting is not defined.
1668         *
1669         * @return The setting's current value, or 'def' if it is not defined
1670         * or not a valid {@code long}.
1671         */
1672        public static long getLong(ContentResolver cr, String name, long def) {
1673            String valString = getString(cr, name);
1674            long value;
1675            try {
1676                value = valString != null ? Long.parseLong(valString) : def;
1677            } catch (NumberFormatException e) {
1678                value = def;
1679            }
1680            return value;
1681        }
1682
1683        /**
1684         * Convenience function for retrieving a single secure settings value
1685         * as a {@code long}.  Note that internally setting values are always
1686         * stored as strings; this function converts the string to a {@code long}
1687         * for you.
1688         * <p>
1689         * This version does not take a default value.  If the setting has not
1690         * been set, or the string value is not a number,
1691         * it throws {@link SettingNotFoundException}.
1692         *
1693         * @param cr The ContentResolver to access.
1694         * @param name The name of the setting to retrieve.
1695         *
1696         * @return The setting's current value.
1697         * @throws SettingNotFoundException Thrown if a setting by the given
1698         * name can't be found or the setting value is not an integer.
1699         */
1700        public static long getLong(ContentResolver cr, String name)
1701                throws SettingNotFoundException {
1702            String valString = getString(cr, name);
1703            try {
1704                return Long.parseLong(valString);
1705            } catch (NumberFormatException e) {
1706                throw new SettingNotFoundException(name);
1707            }
1708        }
1709
1710        /**
1711         * Convenience function for updating a secure settings value as a long
1712         * integer. This will either create a new entry in the table if the
1713         * given name does not exist, or modify the value of the existing row
1714         * with that name.  Note that internally setting values are always
1715         * stored as strings, so this function converts the given value to a
1716         * string before storing it.
1717         *
1718         * @param cr The ContentResolver to access.
1719         * @param name The name of the setting to modify.
1720         * @param value The new value for the setting.
1721         * @return true if the value was set, false on database errors
1722         */
1723        public static boolean putLong(ContentResolver cr, String name, long value) {
1724            return putString(cr, name, Long.toString(value));
1725        }
1726
1727        /**
1728         * Convenience function for retrieving a single secure settings value
1729         * as a floating point number.  Note that internally setting values are
1730         * always stored as strings; this function converts the string to an
1731         * float for you. The default value will be returned if the setting
1732         * is not defined or not a valid float.
1733         *
1734         * @param cr The ContentResolver to access.
1735         * @param name The name of the setting to retrieve.
1736         * @param def Value to return if the setting is not defined.
1737         *
1738         * @return The setting's current value, or 'def' if it is not defined
1739         * or not a valid float.
1740         */
1741        public static float getFloat(ContentResolver cr, String name, float def) {
1742            String v = getString(cr, name);
1743            try {
1744                return v != null ? Float.parseFloat(v) : def;
1745            } catch (NumberFormatException e) {
1746                return def;
1747            }
1748        }
1749
1750        /**
1751         * Convenience function for retrieving a single secure settings value
1752         * as a float.  Note that internally setting values are always
1753         * stored as strings; this function converts the string to a float
1754         * for you.
1755         * <p>
1756         * This version does not take a default value.  If the setting has not
1757         * been set, or the string value is not a number,
1758         * it throws {@link SettingNotFoundException}.
1759         *
1760         * @param cr The ContentResolver to access.
1761         * @param name The name of the setting to retrieve.
1762         *
1763         * @throws SettingNotFoundException Thrown if a setting by the given
1764         * name can't be found or the setting value is not a float.
1765         *
1766         * @return The setting's current value.
1767         */
1768        public static float getFloat(ContentResolver cr, String name)
1769                throws SettingNotFoundException {
1770            String v = getString(cr, name);
1771            try {
1772                return Float.parseFloat(v);
1773            } catch (NumberFormatException e) {
1774                throw new SettingNotFoundException(name);
1775            }
1776        }
1777
1778        /**
1779         * Convenience function for updating a single settings value as a
1780         * floating point number. This will either create a new entry in the
1781         * table if the given name does not exist, or modify the value of the
1782         * existing row with that name.  Note that internally setting values
1783         * are always stored as strings, so this function converts the given
1784         * value to a string before storing it.
1785         *
1786         * @param cr The ContentResolver to access.
1787         * @param name The name of the setting to modify.
1788         * @param value The new value for the setting.
1789         * @return true if the value was set, false on database errors
1790         */
1791        public static boolean putFloat(ContentResolver cr, String name, float value) {
1792            return putString(cr, name, Float.toString(value));
1793        }
1794
1795        /**
1796         * The content:// style URL for this table
1797         */
1798        public static final Uri CONTENT_URI =
1799            Uri.parse("content://" + AUTHORITY + "/secure");
1800
1801        /**
1802         * Whether ADB is enabled.
1803         */
1804        public static final String ADB_ENABLED = "adb_enabled";
1805
1806        /**
1807         * Setting to allow mock locations and location provider status to be injected into the
1808         * LocationManager service for testing purposes during application development.  These
1809         * locations and status values  override actual location and status information generated
1810         * by network, gps, or other location providers.
1811         */
1812        public static final String ALLOW_MOCK_LOCATION = "mock_location";
1813
1814        /**
1815         * The Android ID (a unique 64-bit value) as a hex string.
1816         * Identical to that obtained by calling
1817         * GoogleLoginService.getAndroidId(); it is also placed here
1818         * so you can get it without binding to a service.
1819         */
1820        public static final String ANDROID_ID = "android_id";
1821
1822        /**
1823         * Whether bluetooth is enabled/disabled
1824         * 0=disabled. 1=enabled.
1825         */
1826        public static final String BLUETOOTH_ON = "bluetooth_on";
1827
1828        /**
1829         * Get the key that retrieves a bluetooth headset's priority.
1830         * @hide
1831         */
1832        public static final String getBluetoothHeadsetPriorityKey(String address) {
1833            return ("bluetooth_headset_priority_" + address.toUpperCase());
1834        }
1835
1836        /**
1837         * Get the key that retrieves a bluetooth a2dp sink's priority.
1838         * @hide
1839         */
1840        public static final String getBluetoothA2dpSinkPriorityKey(String address) {
1841            return ("bluetooth_a2dp_sink_priority_" + address.toUpperCase());
1842        }
1843
1844        /**
1845         * Whether or not data roaming is enabled. (0 = false, 1 = true)
1846         */
1847        public static final String DATA_ROAMING = "data_roaming";
1848
1849        /**
1850         * Setting to record the input method used by default, holding the ID
1851         * of the desired method.
1852         */
1853        public static final String DEFAULT_INPUT_METHOD = "default_input_method";
1854
1855        /**
1856         * Whether the device has been provisioned (0 = false, 1 = true)
1857         */
1858        public static final String DEVICE_PROVISIONED = "device_provisioned";
1859
1860        /**
1861         * List of input methods that are currently enabled.  This is a string
1862         * containing the IDs of all enabled input methods, each ID separated
1863         * by ':'.
1864         */
1865        public static final String ENABLED_INPUT_METHODS = "enabled_input_methods";
1866
1867        /**
1868         * Host name and port for a user-selected proxy.
1869         */
1870        public static final String HTTP_PROXY = "http_proxy";
1871
1872        /**
1873         * Whether the package installer should allow installation of apps downloaded from
1874         * sources other than the Android Market (vending machine).
1875         *
1876         * 1 = allow installing from other sources
1877         * 0 = only allow installing from the Android Market
1878         */
1879        public static final String INSTALL_NON_MARKET_APPS = "install_non_market_apps";
1880
1881        /**
1882         * Comma-separated list of location providers that activities may access.
1883         */
1884        public static final String LOCATION_PROVIDERS_ALLOWED = "location_providers_allowed";
1885
1886        /**
1887         * The Logging ID (a unique 64-bit value) as a hex string.
1888         * Used as a pseudonymous identifier for logging.
1889         * @deprecated This identifier is poorly initialized and has
1890         * many collisions.  It should not be used.
1891         */
1892        @Deprecated
1893        public static final String LOGGING_ID = "logging_id";
1894
1895        /**
1896         * The Logging ID (a unique 64-bit value) as a hex string.
1897         * Used as a pseudonymous identifier for logging.
1898         * @hide
1899         */
1900        public static final String LOGGING_ID2 = "logging_id2";
1901
1902        /**
1903         * User preference for which network(s) should be used. Only the
1904         * connectivity service should touch this.
1905         */
1906        public static final String NETWORK_PREFERENCE = "network_preference";
1907
1908        /**
1909         */
1910        public static final String PARENTAL_CONTROL_ENABLED = "parental_control_enabled";
1911
1912        /**
1913         */
1914        public static final String PARENTAL_CONTROL_LAST_UPDATE = "parental_control_last_update";
1915
1916        /**
1917         */
1918        public static final String PARENTAL_CONTROL_REDIRECT_URL = "parental_control_redirect_url";
1919
1920        /**
1921         * Settings classname to launch when Settings is clicked from All
1922         * Applications.  Needed because of user testing between the old
1923         * and new Settings apps.
1924         */
1925        // TODO: 881807
1926        public static final String SETTINGS_CLASSNAME = "settings_classname";
1927
1928        /**
1929         * USB Mass Storage Enabled
1930         */
1931        public static final String USB_MASS_STORAGE_ENABLED = "usb_mass_storage_enabled";
1932
1933        /**
1934         * If this setting is set (to anything), then all references
1935         * to Gmail on the device must change to Google Mail.
1936         */
1937        public static final String USE_GOOGLE_MAIL = "use_google_mail";
1938
1939        /**
1940         * If accessibility is enabled.
1941         */
1942        public static final String ACCESSIBILITY_ENABLED = "accessibility_enabled";
1943
1944        /**
1945         * List of the enabled accessibility providers.
1946         */
1947        public static final String ENABLED_ACCESSIBILITY_SERVICES =
1948            "enabled_accessibility_services";
1949
1950        /**
1951         * Setting to always use the default text-to-speech settings regardless
1952         * of the application settings.
1953         * 1 = override application settings,
1954         * 0 = use application settings (if specified).
1955         */
1956        public static final String TTS_USE_DEFAULTS = "tts_use_defaults";
1957
1958        /**
1959         * Default text-to-speech engine speech rate. 100 = 1x
1960         */
1961        public static final String TTS_DEFAULT_RATE = "tts_default_rate";
1962
1963        /**
1964         * Default text-to-speech engine pitch. 100 = 1x
1965         */
1966        public static final String TTS_DEFAULT_PITCH = "tts_default_pitch";
1967
1968        /**
1969         * Default text-to-speech engine.
1970         */
1971        public static final String TTS_DEFAULT_SYNTH = "tts_default_synth";
1972
1973        /**
1974         * Default text-to-speech language.
1975         */
1976        public static final String TTS_DEFAULT_LANG = "tts_default_lang";
1977
1978        /**
1979         * Whether to notify the user of open networks.
1980         * <p>
1981         * If not connected and the scan results have an open network, we will
1982         * put this notification up. If we attempt to connect to a network or
1983         * the open network(s) disappear, we remove the notification. When we
1984         * show the notification, we will not show it again for
1985         * {@link android.provider.Settings.Secure#WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY} time.
1986         */
1987        public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON =
1988                "wifi_networks_available_notification_on";
1989
1990        /**
1991         * Delay (in seconds) before repeating the Wi-Fi networks available notification.
1992         * Connecting to a network will reset the timer.
1993         */
1994        public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY =
1995                "wifi_networks_available_repeat_delay";
1996
1997        /**
1998         * The number of radio channels that are allowed in the local
1999         * 802.11 regulatory domain.
2000         * @hide
2001         */
2002        public static final String WIFI_NUM_ALLOWED_CHANNELS = "wifi_num_allowed_channels";
2003
2004        /**
2005         * When the number of open networks exceeds this number, the
2006         * least-recently-used excess networks will be removed.
2007         */
2008        public static final String WIFI_NUM_OPEN_NETWORKS_KEPT = "wifi_num_open_networks_kept";
2009
2010        /**
2011         * Whether the Wi-Fi should be on.  Only the Wi-Fi service should touch this.
2012         */
2013        public static final String WIFI_ON = "wifi_on";
2014
2015        /**
2016         * The acceptable packet loss percentage (range 0 - 100) before trying
2017         * another AP on the same network.
2018         */
2019        public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE =
2020                "wifi_watchdog_acceptable_packet_loss_percentage";
2021
2022        /**
2023         * The number of access points required for a network in order for the
2024         * watchdog to monitor it.
2025         */
2026        public static final String WIFI_WATCHDOG_AP_COUNT = "wifi_watchdog_ap_count";
2027
2028        /**
2029         * The delay between background checks.
2030         */
2031        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS =
2032                "wifi_watchdog_background_check_delay_ms";
2033
2034        /**
2035         * Whether the Wi-Fi watchdog is enabled for background checking even
2036         * after it thinks the user has connected to a good access point.
2037         */
2038        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED =
2039                "wifi_watchdog_background_check_enabled";
2040
2041        /**
2042         * The timeout for a background ping
2043         */
2044        public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS =
2045                "wifi_watchdog_background_check_timeout_ms";
2046
2047        /**
2048         * The number of initial pings to perform that *may* be ignored if they
2049         * fail. Again, if these fail, they will *not* be used in packet loss
2050         * calculation. For example, one network always seemed to time out for
2051         * the first couple pings, so this is set to 3 by default.
2052         */
2053        public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT =
2054            "wifi_watchdog_initial_ignored_ping_count";
2055
2056        /**
2057         * The maximum number of access points (per network) to attempt to test.
2058         * If this number is reached, the watchdog will no longer monitor the
2059         * initial connection state for the network. This is a safeguard for
2060         * networks containing multiple APs whose DNS does not respond to pings.
2061         */
2062        public static final String WIFI_WATCHDOG_MAX_AP_CHECKS = "wifi_watchdog_max_ap_checks";
2063
2064        /**
2065         * Whether the Wi-Fi watchdog is enabled.
2066         */
2067        public static final String WIFI_WATCHDOG_ON = "wifi_watchdog_on";
2068
2069        /**
2070         * A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.
2071         */
2072        public static final String WIFI_WATCHDOG_WATCH_LIST = "wifi_watchdog_watch_list";
2073
2074        /**
2075         * The number of pings to test if an access point is a good connection.
2076         */
2077        public static final String WIFI_WATCHDOG_PING_COUNT = "wifi_watchdog_ping_count";
2078
2079        /**
2080         * The delay between pings.
2081         */
2082        public static final String WIFI_WATCHDOG_PING_DELAY_MS = "wifi_watchdog_ping_delay_ms";
2083
2084        /**
2085         * The timeout per ping.
2086         */
2087        public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS = "wifi_watchdog_ping_timeout_ms";
2088
2089        /**
2090         * The maximum number of times we will retry a connection to an access
2091         * point for which we have failed in acquiring an IP address from DHCP.
2092         * A value of N means that we will make N+1 connection attempts in all.
2093         */
2094        public static final String WIFI_MAX_DHCP_RETRY_COUNT = "wifi_max_dhcp_retry_count";
2095
2096        /**
2097         * Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile
2098         * data connectivity to be established after a disconnect from Wi-Fi.
2099         */
2100        public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS =
2101            "wifi_mobile_data_transition_wakelock_timeout_ms";
2102
2103        /**
2104         * Whether background data usage is allowed by the user. See
2105         * ConnectivityManager for more info.
2106         */
2107        public static final String BACKGROUND_DATA = "background_data";
2108
2109        /**
2110         * The CDMA roaming mode 0 = Home Networks, CDMA default
2111         *                       1 = Roaming on Affiliated networks
2112         *                       2 = Roaming on any networks
2113         * @hide
2114         */
2115        public static final String CDMA_ROAMING_MODE = "roaming_settings";
2116
2117        /**
2118         * The CDMA subscription mode 0 = RUIM/SIM (default)
2119         *                                1 = NV
2120         * @hide
2121         */
2122        public static final String CDMA_SUBSCRIPTION_MODE = "subscription_mode";
2123
2124        /**
2125         * The preferred network mode   7 = Global
2126         *                              6 = EvDo only
2127         *                              5 = CDMA w/o EvDo
2128         *                              4 = CDMA / EvDo auto
2129         *                              3 = GSM / WCDMA auto
2130         *                              2 = WCDMA only
2131         *                              1 = GSM only
2132         *                              0 = GSM / WCDMA preferred
2133         * @hide
2134         */
2135        public static final String PREFERRED_NETWORK_MODE =
2136                "preferred_network_mode";
2137
2138        /**
2139         * The preferred TTY mode     0 = TTy Off, CDMA default
2140         *                            1 = TTY Full
2141         *                            2 = TTY HCO
2142         *                            3 = TTY VCO
2143         * @hide
2144         */
2145        public static final String PREFERRED_TTY_MODE =
2146                "preferred_tty_mode";
2147
2148
2149        /**
2150         * CDMA Cell Broadcast SMS
2151         *                            0 = CDMA Cell Broadcast SMS disabled
2152         *                            1 = CDMA Cell Broadcast SMS enabled
2153         * @hide
2154         */
2155        public static final String CDMA_CELL_BROADCAST_SMS =
2156                "cdma_cell_broadcast_sms";
2157
2158        /**
2159         * The cdma subscription 0 = Subscription from RUIM, when available
2160         *                       1 = Subscription from NV
2161         * @hide
2162         */
2163        public static final String PREFERRED_CDMA_SUBSCRIPTION =
2164                "preferred_cdma_subscription";
2165
2166        /**
2167         * Whether the enhanced voice privacy mode is enabled.
2168         * 0 = normal voice privacy
2169         * 1 = enhanced voice privacy
2170         * @hide
2171         */
2172        public static final String ENHANCED_VOICE_PRIVACY_ENABLED = "enhanced_voice_privacy_enabled";
2173
2174        /**
2175         * Whether the TTY mode mode is enabled.
2176         * 0 = disabled
2177         * 1 = enabled
2178         * @hide
2179         */
2180        public static final String TTY_MODE_ENABLED = "tty_mode_enabled";
2181
2182        /**
2183         * Flag for allowing service provider to use location information to improve products and
2184         * services.
2185         * Type: int ( 0 = disallow, 1 = allow )
2186         * @hide
2187         */
2188        public static final String USE_LOCATION_FOR_SERVICES = "use_location";
2189
2190        /**
2191         * Helper method for determining if a location provider is enabled.
2192         * @param cr the content resolver to use
2193         * @param provider the location provider to query
2194         * @return true if the provider is enabled
2195         *
2196         * @hide
2197         */
2198        public static final boolean isLocationProviderEnabled(ContentResolver cr, String provider) {
2199            String allowedProviders = Settings.Secure.getString(cr, LOCATION_PROVIDERS_ALLOWED);
2200            if (allowedProviders != null) {
2201                return (allowedProviders.equals(provider) ||
2202                        allowedProviders.contains("," + provider + ",") ||
2203                        allowedProviders.startsWith(provider + ",") ||
2204                        allowedProviders.endsWith("," + provider));
2205            }
2206            return false;
2207        }
2208
2209        /**
2210         * Thread-safe method for enabling or disabling a single location provider.
2211         * @param cr the content resolver to use
2212         * @param provider the location provider to enable or disable
2213         * @param enabled true if the provider should be enabled
2214         *
2215         * @hide
2216         */
2217        public static final void setLocationProviderEnabled(ContentResolver cr,
2218                String provider, boolean enabled) {
2219            // to ensure thread safety, we write the provider name with a '+' or '-'
2220            // and let the SettingsProvider handle it rather than reading and modifying
2221            // the list of enabled providers.
2222            if (enabled) {
2223                provider = "+" + provider;
2224            } else {
2225                provider = "-" + provider;
2226            }
2227            putString(cr, Settings.Secure.LOCATION_PROVIDERS_ALLOWED, provider);
2228        }
2229    }
2230
2231    /**
2232     * Gservices settings, containing the network names for Google's
2233     * various services. This table holds simple name/addr pairs.
2234     * Addresses can be accessed through the getString() method.
2235     *
2236     * TODO: This should move to partner/google/... somewhere.
2237     *
2238     * @hide
2239     */
2240    public static final class Gservices extends NameValueTable {
2241        public static final String SYS_PROP_SETTING_VERSION = "sys.settings_gservices_version";
2242
2243        /**
2244         * Intent action broadcast when the Gservices table is updated by the server.
2245         * This is broadcast once after settings change (so many values may have been updated).
2246         */
2247        @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248        public static final String CHANGED_ACTION =
2249            "com.google.gservices.intent.action.GSERVICES_CHANGED";
2250
2251        /**
2252         * Intent action to override Gservices for testing.  (Requires WRITE_GSERVICES permission.)
2253         */
2254        @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2255        public static final String OVERRIDE_ACTION =
2256            "com.google.gservices.intent.action.GSERVICES_OVERRIDE";
2257
2258        private static volatile NameValueCache mNameValueCache = null;
2259        private static final Object mNameValueCacheLock = new Object();
2260
2261        /**
2262         * Look up a name in the database.
2263         * @param resolver to access the database with
2264         * @param name to look up in the table
2265         * @return the corresponding value, or null if not present
2266         */
2267        public static String getString(ContentResolver resolver, String name) {
2268            synchronized (mNameValueCacheLock) {
2269                if (mNameValueCache == null) {
2270                    mNameValueCache = new NameValueCache(SYS_PROP_SETTING_VERSION, CONTENT_URI);
2271                }
2272                return mNameValueCache.getString(resolver, name);
2273            }
2274        }
2275
2276        /**
2277         * Store a name/value pair into the database.
2278         * @param resolver to access the database with
2279         * @param name to store
2280         * @param value to associate with the name
2281         * @return true if the value was set, false on database errors
2282         */
2283        public static boolean putString(ContentResolver resolver,
2284                String name, String value) {
2285            return putString(resolver, CONTENT_URI, name, value);
2286        }
2287
2288        /**
2289         * Look up the value for name in the database, convert it to an int using Integer.parseInt
2290         * and return it. If it is null or if a NumberFormatException is caught during the
2291         * conversion then return defValue.
2292         */
2293        public static int getInt(ContentResolver resolver, String name, int defValue) {
2294            String valString = getString(resolver, name);
2295            int value;
2296            try {
2297                value = valString != null ? Integer.parseInt(valString) : defValue;
2298            } catch (NumberFormatException e) {
2299                value = defValue;
2300            }
2301            return value;
2302        }
2303
2304        /**
2305         * Look up the value for name in the database, convert it to a long using Long.parseLong
2306         * and return it. If it is null or if a NumberFormatException is caught during the
2307         * conversion then return defValue.
2308         */
2309        public static long getLong(ContentResolver resolver, String name, long defValue) {
2310            String valString = getString(resolver, name);
2311            long value;
2312            try {
2313                value = valString != null ? Long.parseLong(valString) : defValue;
2314            } catch (NumberFormatException e) {
2315                value = defValue;
2316            }
2317            return value;
2318        }
2319
2320        /**
2321         * Construct the content URI for a particular name/value pair,
2322         * useful for monitoring changes with a ContentObserver.
2323         * @param name to look up in the table
2324         * @return the corresponding content URI, or null if not present
2325         */
2326        public static Uri getUriFor(String name) {
2327            return getUriFor(CONTENT_URI, name);
2328        }
2329
2330        /**
2331         * The content:// style URL for this table
2332         */
2333        public static final Uri CONTENT_URI =
2334                Uri.parse("content://" + AUTHORITY + "/gservices");
2335
2336        /**
2337         * MMS - URL to use for HTTP "x-wap-profile" header
2338         */
2339        public static final String MMS_X_WAP_PROFILE_URL
2340                = "mms_x_wap_profile_url";
2341
2342        /**
2343         * YouTube - the flag to indicate whether to use proxy
2344         */
2345        public static final String YOUTUBE_USE_PROXY
2346                = "youtube_use_proxy";
2347
2348        /**
2349         * MMS - maximum message size in bytes for a MMS message.
2350         */
2351        public static final String MMS_MAXIMUM_MESSAGE_SIZE
2352                = "mms_maximum_message_size";
2353
2354        /**
2355         * Event tags from the kernel event log to upload during checkin.
2356         */
2357        public static final String CHECKIN_EVENTS = "checkin_events";
2358
2359        /**
2360         * Event tags for list of services to upload during checkin.
2361         */
2362        public static final String CHECKIN_DUMPSYS_LIST = "checkin_dumpsys_list";
2363
2364        /**
2365         * The interval (in seconds) between periodic checkin attempts.
2366         */
2367        public static final String CHECKIN_INTERVAL = "checkin_interval";
2368
2369        /**
2370         * Boolean indicating if the market app should force market only checkins on
2371         * install/uninstall. Any non-0 value is considered true.
2372         */
2373        public static final String MARKET_FORCE_CHECKIN = "market_force_checkin";
2374
2375        /**
2376         * How frequently (in seconds) to check the memory status of the
2377         * device.
2378         */
2379        public static final String MEMCHECK_INTERVAL = "memcheck_interval";
2380
2381        /**
2382         * Max frequency (in seconds) to log memory check stats, in realtime
2383         * seconds.  This allows for throttling of logs when the device is
2384         * running for large amounts of time.
2385         */
2386        public static final String MEMCHECK_LOG_REALTIME_INTERVAL =
2387                "memcheck_log_realtime_interval";
2388
2389        /**
2390         * Boolean indicating whether rebooting due to system memory checks
2391         * is enabled.
2392         */
2393        public static final String MEMCHECK_SYSTEM_ENABLED = "memcheck_system_enabled";
2394
2395        /**
2396         * How many bytes the system process must be below to avoid scheduling
2397         * a soft reboot.  This reboot will happen when it is next determined
2398         * to be a good time.
2399         */
2400        public static final String MEMCHECK_SYSTEM_SOFT_THRESHOLD = "memcheck_system_soft";
2401
2402        /**
2403         * How many bytes the system process must be below to avoid scheduling
2404         * a hard reboot.  This reboot will happen immediately.
2405         */
2406        public static final String MEMCHECK_SYSTEM_HARD_THRESHOLD = "memcheck_system_hard";
2407
2408        /**
2409         * How many bytes the phone process must be below to avoid scheduling
2410         * a soft restart.  This restart will happen when it is next determined
2411         * to be a good time.
2412         */
2413        public static final String MEMCHECK_PHONE_SOFT_THRESHOLD = "memcheck_phone_soft";
2414
2415        /**
2416         * How many bytes the phone process must be below to avoid scheduling
2417         * a hard restart.  This restart will happen immediately.
2418         */
2419        public static final String MEMCHECK_PHONE_HARD_THRESHOLD = "memcheck_phone_hard";
2420
2421        /**
2422         * Boolean indicating whether restarting the phone process due to
2423         * memory checks is enabled.
2424         */
2425        public static final String MEMCHECK_PHONE_ENABLED = "memcheck_phone_enabled";
2426
2427        /**
2428         * First time during the day it is okay to kill processes
2429         * or reboot the device due to low memory situations.  This number is
2430         * in seconds since midnight.
2431         */
2432        public static final String MEMCHECK_EXEC_START_TIME = "memcheck_exec_start_time";
2433
2434        /**
2435         * Last time during the day it is okay to kill processes
2436         * or reboot the device due to low memory situations.  This number is
2437         * in seconds since midnight.
2438         */
2439        public static final String MEMCHECK_EXEC_END_TIME = "memcheck_exec_end_time";
2440
2441        /**
2442         * How long the screen must have been off in order to kill processes
2443         * or reboot.  This number is in seconds.  A value of -1 means to
2444         * entirely disregard whether the screen is on.
2445         */
2446        public static final String MEMCHECK_MIN_SCREEN_OFF = "memcheck_min_screen_off";
2447
2448        /**
2449         * How much time there must be until the next alarm in order to kill processes
2450         * or reboot.  This number is in seconds.  Note: this value must be
2451         * smaller than {@link #MEMCHECK_RECHECK_INTERVAL} or else it will
2452         * always see an alarm scheduled within its time.
2453         */
2454        public static final String MEMCHECK_MIN_ALARM = "memcheck_min_alarm";
2455
2456        /**
2457         * How frequently to check whether it is a good time to restart things,
2458         * if the device is in a bad state.  This number is in seconds.  Note:
2459         * this value must be larger than {@link #MEMCHECK_MIN_ALARM} or else
2460         * the alarm to schedule the recheck will always appear within the
2461         * minimum "do not execute now" time.
2462         */
2463        public static final String MEMCHECK_RECHECK_INTERVAL = "memcheck_recheck_interval";
2464
2465        /**
2466         * How frequently (in DAYS) to reboot the device.  If 0, no reboots
2467         * will occur.
2468         */
2469        public static final String REBOOT_INTERVAL = "reboot_interval";
2470
2471        /**
2472         * First time during the day it is okay to force a reboot of the
2473         * device (if REBOOT_INTERVAL is set).  This number is
2474         * in seconds since midnight.
2475         */
2476        public static final String REBOOT_START_TIME = "reboot_start_time";
2477
2478        /**
2479         * The window of time (in seconds) after each REBOOT_INTERVAL in which
2480         * a reboot can be executed.  If 0, a reboot will always be executed at
2481         * exactly the given time.  Otherwise, it will only be executed if
2482         * the device is idle within the window.
2483         */
2484        public static final String REBOOT_WINDOW = "reboot_window";
2485
2486        /**
2487         * The minimum version of the server that is required in order for the device to accept
2488         * the server's recommendations about the initial sync settings to use. When this is unset,
2489         * blank or can't be interpreted as an integer then we will not ask the server for a
2490         * recommendation.
2491         */
2492        public static final String GMAIL_CONFIG_INFO_MIN_SERVER_VERSION =
2493                "gmail_config_info_min_server_version";
2494
2495        /**
2496         * Controls whether Gmail offers a preview button for images.
2497         */
2498        public static final String GMAIL_DISALLOW_IMAGE_PREVIEWS = "gmail_disallow_image_previews";
2499
2500        /**
2501         * The maximal size in bytes allowed for attachments when composing messages in Gmail
2502         */
2503        public static final String GMAIL_MAX_ATTACHMENT_SIZE = "gmail_max_attachment_size_bytes";
2504
2505        /**
2506         * The timeout in milliseconds that Gmail uses when opening a connection and reading
2507         * from it. A missing value or a value of -1 instructs Gmail to use the defaults provided
2508         * by GoogleHttpClient.
2509         */
2510        public static final String GMAIL_TIMEOUT_MS = "gmail_timeout_ms";
2511
2512        /**
2513         * Controls whether Gmail will request an expedited sync when a message is sent. Value must
2514         * be an integer where non-zero means true. Defaults to 1.
2515         */
2516        public static final String GMAIL_SEND_IMMEDIATELY = "gmail_send_immediately";
2517
2518        /**
2519         * Controls whether gmail buffers server responses.  Possible values are "memory", for a
2520         * memory-based buffer, or "file", for a temp-file-based buffer.  All other values
2521         * (including not set) disable buffering.
2522         */
2523        public static final String GMAIL_BUFFER_SERVER_RESPONSE = "gmail_buffer_server_response";
2524
2525        /**
2526         * The maximum size in bytes allowed for the provider to gzip a protocol buffer uploaded to
2527         * the server.
2528         */
2529        public static final String GMAIL_MAX_GZIP_SIZE = "gmail_max_gzip_size_bytes";
2530
2531        /**
2532         * Controls whether Gmail will discard uphill operations that repeatedly fail. Value must be
2533         * an integer where non-zero means true. Defaults to 1.
2534         */
2535        public static final String GMAIL_DISCARD_ERROR_UPHILL_OP = "gmail_discard_error_uphill_op";
2536
2537        /**
2538         * Hostname of the GTalk server.
2539         */
2540        public static final String GTALK_SERVICE_HOSTNAME = "gtalk_hostname";
2541
2542        /**
2543         * Secure port of the GTalk server.
2544         */
2545        public static final String GTALK_SERVICE_SECURE_PORT = "gtalk_secure_port";
2546
2547        /**
2548         * The server configurable RMQ acking interval
2549         */
2550        public static final String GTALK_SERVICE_RMQ_ACK_INTERVAL = "gtalk_rmq_ack_interval";
2551
2552        /**
2553         * The minimum reconnect delay for short network outages or when the network is suspended
2554         * due to phone use.
2555         */
2556        public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT =
2557                "gtalk_min_reconnect_delay_short";
2558
2559        /**
2560         * The reconnect variant range for short network outages or when the network is suspended
2561         * due to phone use. A random number between 0 and this constant is computed and
2562         * added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_SHORT} to form the initial reconnect
2563         * delay.
2564         */
2565        public static final String GTALK_SERVICE_RECONNECT_VARIANT_SHORT =
2566                "gtalk_reconnect_variant_short";
2567
2568        /**
2569         * The minimum reconnect delay for long network outages
2570         */
2571        public static final String GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG =
2572                "gtalk_min_reconnect_delay_long";
2573
2574        /**
2575         * The reconnect variant range for long network outages.  A random number between 0 and this
2576         * constant is computed and added to {@link #GTALK_SERVICE_MIN_RECONNECT_DELAY_LONG} to
2577         * form the initial reconnect delay.
2578         */
2579        public static final String GTALK_SERVICE_RECONNECT_VARIANT_LONG =
2580                "gtalk_reconnect_variant_long";
2581
2582        /**
2583         * The maximum reconnect delay time, in milliseconds.
2584         */
2585        public static final String GTALK_SERVICE_MAX_RECONNECT_DELAY =
2586                "gtalk_max_reconnect_delay";
2587
2588        /**
2589         * The network downtime that is considered "short" for the above calculations,
2590         * in milliseconds.
2591         */
2592        public static final String GTALK_SERVICE_SHORT_NETWORK_DOWNTIME =
2593                "gtalk_short_network_downtime";
2594
2595        /**
2596         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2597         * will reset the heartbeat timer. The away heartbeat should be used when the user is
2598         * logged into the GTalk app, but not actively using it.
2599         */
2600        public static final String GTALK_SERVICE_AWAY_HEARTBEAT_INTERVAL_MS =
2601                "gtalk_heartbeat_ping_interval_ms";  // keep the string backward compatible
2602
2603        /**
2604         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2605         * will reset the heartbeat timer. The active heartbeat should be used when the user is
2606         * actively using the GTalk app.
2607         */
2608        public static final String GTALK_SERVICE_ACTIVE_HEARTBEAT_INTERVAL_MS =
2609                "gtalk_active_heartbeat_ping_interval_ms";
2610
2611        /**
2612         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2613         * will reset the heartbeat timer. The sync heartbeat should be used when the user isn't
2614         * logged into the GTalk app, but auto-sync is enabled.
2615         */
2616        public static final String GTALK_SERVICE_SYNC_HEARTBEAT_INTERVAL_MS =
2617                "gtalk_sync_heartbeat_ping_interval_ms";
2618
2619        /**
2620         * How frequently we send heartbeat pings to the GTalk server. Receiving a server packet
2621         * will reset the heartbeat timer. The no sync heartbeat should be used when the user isn't
2622         * logged into the GTalk app, and auto-sync is not enabled.
2623         */
2624        public static final String GTALK_SERVICE_NOSYNC_HEARTBEAT_INTERVAL_MS =
2625                "gtalk_nosync_heartbeat_ping_interval_ms";
2626
2627        /**
2628         * The maximum heartbeat interval used while on the WIFI network.
2629         */
2630        public static final String GTALK_SERVICE_WIFI_MAX_HEARTBEAT_INTERVAL_MS =
2631                "gtalk_wifi_max_heartbeat_ping_interval_ms";
2632
2633        /**
2634         * How long we wait to receive a heartbeat ping acknowledgement (or another packet)
2635         * from the GTalk server, before deeming the connection dead.
2636         */
2637        public static final String GTALK_SERVICE_HEARTBEAT_ACK_TIMEOUT_MS =
2638                "gtalk_heartbeat_ack_timeout_ms";
2639
2640        /**
2641         * How long after screen is turned off before we consider the user to be idle.
2642         */
2643        public static final String GTALK_SERVICE_IDLE_TIMEOUT_MS =
2644                "gtalk_idle_timeout_ms";
2645
2646        /**
2647         * By default, GTalkService will always connect to the server regardless of the auto-sync
2648         * setting. However, if this parameter is true, then GTalkService will only connect
2649         * if auto-sync is enabled. Using the GTalk app will trigger the connection too.
2650         */
2651        public static final String GTALK_SERVICE_CONNECT_ON_AUTO_SYNC =
2652                "gtalk_connect_on_auto_sync";
2653
2654        /**
2655         * GTalkService holds a wakelock while broadcasting the intent for data message received.
2656         * It then automatically release the wakelock after a timeout. This setting controls what
2657         * the timeout should be.
2658         */
2659        public static final String GTALK_DATA_MESSAGE_WAKELOCK_MS =
2660                "gtalk_data_message_wakelock_ms";
2661
2662        /**
2663         * The socket read timeout used to control how long ssl handshake wait for reads before
2664         * timing out. This is needed so the ssl handshake doesn't hang for a long time in some
2665         * circumstances.
2666         */
2667        public static final String GTALK_SSL_HANDSHAKE_TIMEOUT_MS =
2668                "gtalk_ssl_handshake_timeout_ms";
2669
2670        /**
2671         * Compress the gtalk stream.
2672         */
2673        public static final String GTALK_COMPRESS = "gtalk_compress";
2674
2675        /**
2676         * This is the timeout for which Google Talk will send the message using bareJID. In a
2677         * established chat between two XMPP endpoints, Google Talk uses fullJID in the format
2678         * of user@domain/resource in order to send the message to the specific client. However,
2679         * if Google Talk hasn't received a message from that client after some time, it would
2680         * fall back to use the bareJID, which would broadcast the message to all clients for
2681         * the other user.
2682         */
2683        public static final String GTALK_USE_BARE_JID_TIMEOUT_MS = "gtalk_use_barejid_timeout_ms";
2684
2685        /**
2686         * Enable use of ssl session caching.
2687         * 'db' - save each session in a (per process) database
2688         * 'file' - save each session in a (per process) file
2689         * not set or any other value - normal java in-memory caching
2690         */
2691        public static final String SSL_SESSION_CACHE = "ssl_session_cache";
2692
2693        /**
2694         * How many bytes long a message has to be, in order to be gzipped.
2695         */
2696        public static final String SYNC_MIN_GZIP_BYTES =
2697                "sync_min_gzip_bytes";
2698
2699        /**
2700         * The hash value of the current provisioning settings
2701         */
2702        public static final String PROVISIONING_DIGEST = "digest";
2703
2704        /**
2705         * Provisioning keys to block from server update
2706         */
2707        public static final String PROVISIONING_OVERRIDE = "override";
2708
2709        /**
2710         * "Generic" service name for  authentication requests.
2711         */
2712        public static final String GOOGLE_LOGIN_GENERIC_AUTH_SERVICE
2713                = "google_login_generic_auth_service";
2714
2715        /**
2716         * Frequency in milliseconds at which we should sync the locally installed Vending Machine
2717         * content with the server.
2718         */
2719        public static final String VENDING_SYNC_FREQUENCY_MS = "vending_sync_frequency_ms";
2720
2721        /**
2722         * Support URL that is opened in a browser when user clicks on 'Help and Info' in Vending
2723         * Machine.
2724         */
2725        public static final String VENDING_SUPPORT_URL = "vending_support_url";
2726
2727        /**
2728         * Indicates if Vending Machine requires a SIM to be in the phone to allow a purchase.
2729         *
2730         * true = SIM is required
2731         * false = SIM is not required
2732         */
2733        public static final String VENDING_REQUIRE_SIM_FOR_PURCHASE =
2734                "vending_require_sim_for_purchase";
2735
2736        /**
2737         * The current version id of the Vending Machine terms of service.
2738         */
2739        public static final String VENDING_TOS_VERSION = "vending_tos_version";
2740
2741        /**
2742         * URL that points to the terms of service for Vending Machine.
2743         */
2744        public static final String VENDING_TOS_URL = "vending_tos_url";
2745
2746        /**
2747         * Whether to use sierraqa instead of sierra tokens for the purchase flow in
2748         * Vending Machine.
2749         *
2750         * true = use sierraqa
2751         * false = use sierra (default)
2752         */
2753        public static final String VENDING_USE_CHECKOUT_QA_SERVICE =
2754                "vending_use_checkout_qa_service";
2755
2756        /**
2757         * Default value to use for all/free/priced filter in Market.
2758         * Valid values: ALL, FREE, PAID (case insensitive)
2759         */
2760        public static final String VENDING_DEFAULT_FILTER = "vending_default_filter";
2761        /**
2762         * Ranking type value to use for the first category tab (currently popular)
2763         */
2764        public static final String VENDING_TAB_1_RANKING_TYPE = "vending_tab_1_ranking_type";
2765
2766        /**
2767         * Title string to use for first category tab.
2768         */
2769        public static final String VENDING_TAB_1_TITLE = "vending_tab_1_title";
2770
2771        /**
2772         * Ranking type value to use for the second category tab (currently newest)
2773         */
2774        public static final String VENDING_TAB_2_RANKING_TYPE = "vending_tab_2_ranking_type";
2775
2776        /**
2777         * Title string to use for second category tab.
2778         */
2779        public static final String VENDING_TAB_2_TITLE = "vending_tab_2_title";
2780
2781        /**
2782         * Frequency in milliseconds at which we should request MCS heartbeats
2783         * from the Vending Machine client.
2784         */
2785        public static final String VENDING_HEARTBEAT_FREQUENCY_MS =
2786                "vending_heartbeat_frequency_ms";
2787
2788        /**
2789         * URL that points to the legal terms of service to display in Settings.
2790         * <p>
2791         * This should be a https URL. For a pretty user-friendly URL, use
2792         * {@link #SETTINGS_TOS_PRETTY_URL}.
2793         */
2794        public static final String SETTINGS_TOS_URL = "settings_tos_url";
2795
2796        /**
2797         * URL that points to the legal terms of service to display in Settings.
2798         * <p>
2799         * This should be a pretty http URL. For the URL the device will access
2800         * via Settings, use {@link #SETTINGS_TOS_URL}.
2801         */
2802        public static final String SETTINGS_TOS_PRETTY_URL = "settings_tos_pretty_url";
2803
2804        /**
2805         * URL that points to the contributors to display in Settings.
2806         * <p>
2807         * This should be a https URL. For a pretty user-friendly URL, use
2808         * {@link #SETTINGS_CONTRIBUTORS_PRETTY_URL}.
2809         */
2810        public static final String SETTINGS_CONTRIBUTORS_URL = "settings_contributors_url";
2811
2812        /**
2813         * URL that points to the contributors to display in Settings.
2814         * <p>
2815         * This should be a pretty http URL. For the URL the device will access
2816         * via Settings, use {@link #SETTINGS_CONTRIBUTORS_URL}.
2817         */
2818        public static final String SETTINGS_CONTRIBUTORS_PRETTY_URL =
2819                "settings_contributors_pretty_url";
2820
2821        /**
2822         * URL that points to the Terms Of Service for the device.
2823         * <p>
2824         * This should be a pretty http URL.
2825         */
2826        public static final String SETUP_GOOGLE_TOS_URL = "setup_google_tos_url";
2827
2828        /**
2829         * URL that points to the Android privacy policy for the device.
2830         * <p>
2831         * This should be a pretty http URL.
2832         */
2833        public static final String SETUP_ANDROID_PRIVACY_URL = "setup_android_privacy_url";
2834
2835        /**
2836         * URL that points to the Google privacy policy for the device.
2837         * <p>
2838         * This should be a pretty http URL.
2839         */
2840        public static final String SETUP_GOOGLE_PRIVACY_URL = "setup_google_privacy_url";
2841
2842        /**
2843         * Request an MSISDN token for various Google services.
2844         */
2845        public static final String USE_MSISDN_TOKEN = "use_msisdn_token";
2846
2847        /**
2848         * RSA public key used to encrypt passwords stored in the database.
2849         */
2850        public static final String GLS_PUBLIC_KEY = "google_login_public_key";
2851
2852        /**
2853         * Only check parental control status if this is set to "true".
2854         */
2855        public static final String PARENTAL_CONTROL_CHECK_ENABLED =
2856                "parental_control_check_enabled";
2857
2858        /**
2859         * The list of applications we need to block if parental control is
2860         * enabled.
2861         */
2862        public static final String PARENTAL_CONTROL_APPS_LIST =
2863                "parental_control_apps_list";
2864
2865        /**
2866         * Duration in which parental control status is valid.
2867         */
2868        public static final String PARENTAL_CONTROL_TIMEOUT_IN_MS =
2869                "parental_control_timeout_in_ms";
2870
2871        /**
2872         * When parental control is off, we expect to get this string from the
2873         * litmus url.
2874         */
2875        public static final String PARENTAL_CONTROL_EXPECTED_RESPONSE =
2876                "parental_control_expected_response";
2877
2878        /**
2879         * When the litmus url returns a 302, declare parental control to be on
2880         * only if the redirect url matches this regular expression.
2881         */
2882        public static final String PARENTAL_CONTROL_REDIRECT_REGEX =
2883                "parental_control_redirect_regex";
2884
2885        /**
2886         * Threshold for the amount of change in disk free space required to report the amount of
2887         * free space. Used to prevent spamming the logs when the disk free space isn't changing
2888         * frequently.
2889         */
2890        public static final String DISK_FREE_CHANGE_REPORTING_THRESHOLD =
2891                "disk_free_change_reporting_threshold";
2892
2893        /**
2894         * Prefix for new Google services published by the checkin
2895         * server.
2896         */
2897        public static final String GOOGLE_SERVICES_PREFIX
2898                = "google_services:";
2899
2900        /**
2901         * The maximum reconnect delay for short network outages or when the network is suspended
2902         * due to phone use.
2903         */
2904        public static final String SYNC_MAX_RETRY_DELAY_IN_SECONDS =
2905                "sync_max_retry_delay_in_seconds";
2906
2907        /**
2908         * Minimum percentage of free storage on the device that is used to determine if
2909         * the device is running low on storage.
2910         * Say this value is set to 10, the device is considered running low on storage
2911         * if 90% or more of the device storage is filled up.
2912         */
2913        public static final String SYS_STORAGE_THRESHOLD_PERCENTAGE =
2914                "sys_storage_threshold_percentage";
2915
2916        /**
2917         * The interval in minutes after which the amount of free storage left on the
2918         * device is logged to the event log
2919         */
2920        public static final String SYS_FREE_STORAGE_LOG_INTERVAL =
2921                "sys_free_storage_log_interval";
2922
2923        /**
2924         * The interval in milliseconds at which to check the number of SMS sent
2925         * out without asking for use permit, to limit the un-authorized SMS
2926         * usage.
2927         */
2928        public static final String SMS_OUTGOING_CHECK_INTERVAL_MS =
2929                "sms_outgoing_check_interval_ms";
2930
2931        /**
2932         * The number of outgoing SMS sent without asking for user permit
2933         * (of {@link #SMS_OUTGOING_CHECK_INTERVAL_MS}
2934         */
2935        public static final String SMS_OUTGOING_CEHCK_MAX_COUNT =
2936                "sms_outgoing_check_max_count";
2937
2938        /**
2939         * The interval in milliseconds at which to check packet counts on the
2940         * mobile data interface when screen is on, to detect possible data
2941         * connection problems.
2942         */
2943        public static final String PDP_WATCHDOG_POLL_INTERVAL_MS =
2944                "pdp_watchdog_poll_interval_ms";
2945
2946        /**
2947         * The interval in milliseconds at which to check packet counts on the
2948         * mobile data interface when screen is off, to detect possible data
2949         * connection problems.
2950         */
2951        public static final String PDP_WATCHDOG_LONG_POLL_INTERVAL_MS =
2952                "pdp_watchdog_long_poll_interval_ms";
2953
2954        /**
2955         * The interval in milliseconds at which to check packet counts on the
2956         * mobile data interface after {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT}
2957         * outgoing packets has been reached without incoming packets.
2958         */
2959        public static final String PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS =
2960                "pdp_watchdog_error_poll_interval_ms";
2961
2962        /**
2963         * The number of outgoing packets sent without seeing an incoming packet
2964         * that triggers a countdown (of {@link #PDP_WATCHDOG_ERROR_POLL_COUNT}
2965         * device is logged to the event log
2966         */
2967        public static final String PDP_WATCHDOG_TRIGGER_PACKET_COUNT =
2968                "pdp_watchdog_trigger_packet_count";
2969
2970        /**
2971         * The number of polls to perform (at {@link #PDP_WATCHDOG_ERROR_POLL_INTERVAL_MS})
2972         * after hitting {@link #PDP_WATCHDOG_TRIGGER_PACKET_COUNT} before
2973         * attempting data connection recovery.
2974         */
2975        public static final String PDP_WATCHDOG_ERROR_POLL_COUNT =
2976                "pdp_watchdog_error_poll_count";
2977
2978        /**
2979         * The number of failed PDP reset attempts before moving to something more
2980         * drastic: re-registering to the network.
2981         */
2982        public static final String PDP_WATCHDOG_MAX_PDP_RESET_FAIL_COUNT =
2983                "pdp_watchdog_max_pdp_reset_fail_count";
2984
2985        /**
2986         * Address to ping as a last sanity check before attempting any recovery.
2987         * Unset or set to "0.0.0.0" to skip this check.
2988         */
2989        public static final String PDP_WATCHDOG_PING_ADDRESS = "pdp_watchdog_ping_address";
2990
2991        /**
2992         * The "-w deadline" parameter for the ping, ie, the max time in
2993         * seconds to spend pinging.
2994         */
2995        public static final String PDP_WATCHDOG_PING_DEADLINE = "pdp_watchdog_ping_deadline";
2996
2997        /**
2998         * The interval in milliseconds at which to check gprs registration
2999         * after the first registration mismatch of gprs and voice service,
3000         * to detect possible data network registration problems.
3001         *
3002         */
3003        public static final String GPRS_REGISTER_CHECK_PERIOD_MS =
3004                "gprs_register_check_period_ms";
3005
3006        /**
3007         * The interval in milliseconds after which Wi-Fi is considered idle.
3008         * When idle, it is possible for the device to be switched from Wi-Fi to
3009         * the mobile data network.
3010         */
3011        public static final String WIFI_IDLE_MS = "wifi_idle_ms";
3012
3013        /**
3014         * Screen timeout in milliseconds corresponding to the
3015         * PowerManager's POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest
3016         * possible screen timeout behavior.)
3017         */
3018        public static final String SHORT_KEYLIGHT_DELAY_MS =
3019                "short_keylight_delay_ms";
3020
3021        /**
3022         * URL that points to the voice search servers. To be factored out of this class.
3023         */
3024        public static final String VOICE_SEARCH_URL = "voice_search_url";
3025
3026        /**
3027         * Speech encoding used with voice search on 3G networks. To be factored out of this class.
3028         */
3029        public static final String VOICE_SEARCH_ENCODING_THREE_G = "voice_search_encoding_three_g";
3030
3031        /**
3032         * Speech encoding used with voice search on WIFI networks. To be factored out of this class.
3033         */
3034        public static final String VOICE_SEARCH_ENCODING_WIFI = "voice_search_encoding_wifi";
3035
3036        /**
3037         * Whether to use automatic gain control in voice search (0 = disable, 1 = enable).
3038         * To be factored out of this class.
3039         */
3040        public static final String VOICE_SEARCH_ENABLE_AGC = "voice_search_enable_agc";
3041
3042        /**
3043         * Whether to use noise suppression in voice search (0 = disable, 1 = enable).
3044         * To be factored out of this class.
3045         */
3046        public static final String VOICE_SEARCH_ENABLE_NS = "voice_search_enable_ns";
3047
3048        /**
3049         * Whether to use the IIR filter in voice search (0 = disable, 1 = enable).
3050         * To be factored out of this class.
3051         */
3052        public static final String VOICE_SEARCH_ENABLE_IIR = "voice_search_enable_iir";
3053
3054        /**
3055         * List of test suites (local disk filename) for the automatic instrumentation test runner.
3056         * The file format is similar to automated_suites.xml, see AutoTesterService.
3057         * If this setting is missing or empty, the automatic test runner will not start.
3058         */
3059        public static final String AUTOTEST_SUITES_FILE = "autotest_suites_file";
3060
3061        /**
3062         * Interval between synchronous checkins forced by the automatic test runner.
3063         * If you set this to a value smaller than CHECKIN_INTERVAL, then the test runner's
3064         * frequent checkins will prevent asynchronous background checkins from interfering
3065         * with any performance measurements.
3066         */
3067        public static final String AUTOTEST_CHECKIN_SECONDS = "autotest_checkin_seconds";
3068
3069        /**
3070         * Interval between reboots forced by the automatic test runner.
3071         */
3072        public static final String AUTOTEST_REBOOT_SECONDS = "autotest_reboot_seconds";
3073
3074
3075        /**
3076         * Threshold values for the duration and level of a discharge cycle, under
3077         * which we log discharge cycle info.
3078         */
3079        public static final String BATTERY_DISCHARGE_DURATION_THRESHOLD =
3080                "battery_discharge_duration_threshold";
3081        public static final String BATTERY_DISCHARGE_THRESHOLD = "battery_discharge_threshold";
3082
3083        /**
3084         * An email address that anr bugreports should be sent to.
3085         */
3086        public static final String ANR_BUGREPORT_RECIPIENT = "anr_bugreport_recipient";
3087
3088        /**
3089         * Flag for allowing service provider to use location information to improve products and
3090         * services.
3091         * Type: int ( 0 = disallow, 1 = allow )
3092         * @deprecated
3093         */
3094        public static final String USE_LOCATION_FOR_SERVICES = "use_location";
3095
3096        /**
3097         * @deprecated
3098         * @hide
3099         */
3100        @Deprecated  // Obviated by NameValueCache: just fetch the value directly.
3101        public static class QueryMap extends ContentQueryMap {
3102
3103            public QueryMap(ContentResolver contentResolver, Cursor cursor, boolean keepUpdated,
3104                    Handler handlerForUpdateNotifications) {
3105                super(cursor, NAME, keepUpdated, handlerForUpdateNotifications);
3106            }
3107
3108            public QueryMap(ContentResolver contentResolver, boolean keepUpdated,
3109                    Handler handlerForUpdateNotifications) {
3110                this(contentResolver,
3111                        contentResolver.query(CONTENT_URI, null, null, null, null),
3112                        keepUpdated, handlerForUpdateNotifications);
3113            }
3114
3115            public String getString(String name) {
3116                ContentValues cv = getValues(name);
3117                if (cv == null) return null;
3118                return cv.getAsString(VALUE);
3119            }
3120        }
3121
3122    }
3123
3124    /**
3125     * User-defined bookmarks and shortcuts.  The target of each bookmark is an
3126     * Intent URL, allowing it to be either a web page or a particular
3127     * application activity.
3128     *
3129     * @hide
3130     */
3131    public static final class Bookmarks implements BaseColumns
3132    {
3133        private static final String TAG = "Bookmarks";
3134
3135        /**
3136         * The content:// style URL for this table
3137         */
3138        public static final Uri CONTENT_URI =
3139            Uri.parse("content://" + AUTHORITY + "/bookmarks");
3140
3141        /**
3142         * The row ID.
3143         * <p>Type: INTEGER</p>
3144         */
3145        public static final String ID = "_id";
3146
3147        /**
3148         * Descriptive name of the bookmark that can be displayed to the user.
3149         * If this is empty, the title should be resolved at display time (use
3150         * {@link #getTitle(Context, Cursor)} any time you want to display the
3151         * title of a bookmark.)
3152         * <P>
3153         * Type: TEXT
3154         * </P>
3155         */
3156        public static final String TITLE = "title";
3157
3158        /**
3159         * Arbitrary string (displayed to the user) that allows bookmarks to be
3160         * organized into categories.  There are some special names for
3161         * standard folders, which all start with '@'.  The label displayed for
3162         * the folder changes with the locale (via {@link #getLabelForFolder}) but
3163         * the folder name does not change so you can consistently query for
3164         * the folder regardless of the current locale.
3165         *
3166         * <P>Type: TEXT</P>
3167         *
3168         */
3169        public static final String FOLDER = "folder";
3170
3171        /**
3172         * The Intent URL of the bookmark, describing what it points to.  This
3173         * value is given to {@link android.content.Intent#getIntent} to create
3174         * an Intent that can be launched.
3175         * <P>Type: TEXT</P>
3176         */
3177        public static final String INTENT = "intent";
3178
3179        /**
3180         * Optional shortcut character associated with this bookmark.
3181         * <P>Type: INTEGER</P>
3182         */
3183        public static final String SHORTCUT = "shortcut";
3184
3185        /**
3186         * The order in which the bookmark should be displayed
3187         * <P>Type: INTEGER</P>
3188         */
3189        public static final String ORDERING = "ordering";
3190
3191        private static final String[] sIntentProjection = { INTENT };
3192        private static final String[] sShortcutProjection = { ID, SHORTCUT };
3193        private static final String sShortcutSelection = SHORTCUT + "=?";
3194
3195        /**
3196         * Convenience function to retrieve the bookmarked Intent for a
3197         * particular shortcut key.
3198         *
3199         * @param cr The ContentResolver to query.
3200         * @param shortcut The shortcut key.
3201         *
3202         * @return Intent The bookmarked URL, or null if there is no bookmark
3203         *         matching the given shortcut.
3204         */
3205        public static Intent getIntentForShortcut(ContentResolver cr, char shortcut)
3206        {
3207            Intent intent = null;
3208
3209            Cursor c = cr.query(CONTENT_URI,
3210                    sIntentProjection, sShortcutSelection,
3211                    new String[] { String.valueOf((int) shortcut) }, ORDERING);
3212            // Keep trying until we find a valid shortcut
3213            try {
3214                while (intent == null && c.moveToNext()) {
3215                    try {
3216                        String intentURI = c.getString(c.getColumnIndexOrThrow(INTENT));
3217                        intent = Intent.getIntent(intentURI);
3218                    } catch (java.net.URISyntaxException e) {
3219                        // The stored URL is bad...  ignore it.
3220                    } catch (IllegalArgumentException e) {
3221                        // Column not found
3222                        Log.e(TAG, "Intent column not found", e);
3223                    }
3224                }
3225            } finally {
3226                if (c != null) c.close();
3227            }
3228
3229            return intent;
3230        }
3231
3232        /**
3233         * Add a new bookmark to the system.
3234         *
3235         * @param cr The ContentResolver to query.
3236         * @param intent The desired target of the bookmark.
3237         * @param title Bookmark title that is shown to the user; null if none
3238         *            or it should be resolved to the intent's title.
3239         * @param folder Folder in which to place the bookmark; null if none.
3240         * @param shortcut Shortcut that will invoke the bookmark; 0 if none. If
3241         *            this is non-zero and there is an existing bookmark entry
3242         *            with this same shortcut, then that existing shortcut is
3243         *            cleared (the bookmark is not removed).
3244         * @return The unique content URL for the new bookmark entry.
3245         */
3246        public static Uri add(ContentResolver cr,
3247                                           Intent intent,
3248                                           String title,
3249                                           String folder,
3250                                           char shortcut,
3251                                           int ordering)
3252        {
3253            // If a shortcut is supplied, and it is already defined for
3254            // another bookmark, then remove the old definition.
3255            if (shortcut != 0) {
3256                Cursor c = cr.query(CONTENT_URI,
3257                        sShortcutProjection, sShortcutSelection,
3258                        new String[] { String.valueOf((int) shortcut) }, null);
3259                try {
3260                    if (c.moveToFirst()) {
3261                        while (c.getCount() > 0) {
3262                            if (!c.deleteRow()) {
3263                                Log.w(TAG, "Could not delete existing shortcut row");
3264                            }
3265                        }
3266                    }
3267                } finally {
3268                    if (c != null) c.close();
3269                }
3270            }
3271
3272            ContentValues values = new ContentValues();
3273            if (title != null) values.put(TITLE, title);
3274            if (folder != null) values.put(FOLDER, folder);
3275            values.put(INTENT, intent.toURI());
3276            if (shortcut != 0) values.put(SHORTCUT, (int) shortcut);
3277            values.put(ORDERING, ordering);
3278            return cr.insert(CONTENT_URI, values);
3279        }
3280
3281        /**
3282         * Return the folder name as it should be displayed to the user.  This
3283         * takes care of localizing special folders.
3284         *
3285         * @param r Resources object for current locale; only need access to
3286         *          system resources.
3287         * @param folder The value found in the {@link #FOLDER} column.
3288         *
3289         * @return CharSequence The label for this folder that should be shown
3290         *         to the user.
3291         */
3292        public static CharSequence getLabelForFolder(Resources r, String folder) {
3293            return folder;
3294        }
3295
3296        /**
3297         * Return the title as it should be displayed to the user. This takes
3298         * care of localizing bookmarks that point to activities.
3299         *
3300         * @param context A context.
3301         * @param cursor A cursor pointing to the row whose title should be
3302         *        returned. The cursor must contain at least the {@link #TITLE}
3303         *        and {@link #INTENT} columns.
3304         * @return A title that is localized and can be displayed to the user,
3305         *         or the empty string if one could not be found.
3306         */
3307        public static CharSequence getTitle(Context context, Cursor cursor) {
3308            int titleColumn = cursor.getColumnIndex(TITLE);
3309            int intentColumn = cursor.getColumnIndex(INTENT);
3310            if (titleColumn == -1 || intentColumn == -1) {
3311                throw new IllegalArgumentException(
3312                        "The cursor must contain the TITLE and INTENT columns.");
3313            }
3314
3315            String title = cursor.getString(titleColumn);
3316            if (!TextUtils.isEmpty(title)) {
3317                return title;
3318            }
3319
3320            String intentUri = cursor.getString(intentColumn);
3321            if (TextUtils.isEmpty(intentUri)) {
3322                return "";
3323            }
3324
3325            Intent intent;
3326            try {
3327                intent = Intent.getIntent(intentUri);
3328            } catch (URISyntaxException e) {
3329                return "";
3330            }
3331
3332            PackageManager packageManager = context.getPackageManager();
3333            ResolveInfo info = packageManager.resolveActivity(intent, 0);
3334            return info != null ? info.loadLabel(packageManager) : "";
3335        }
3336    }
3337
3338    /**
3339     * Returns the GTalk JID resource associated with this device.
3340     *
3341     * @return  String  the JID resource of the device. It uses the device IMEI in the computation
3342     * of the JID resource. If IMEI is not ready (i.e. telephony module not ready), we'll return
3343     * an empty string.
3344     * @hide
3345     */
3346    // TODO: we shouldn't not have a permenant Jid resource, as that's an easy target for
3347    // spams. We should change it once a while, like when we resubscribe to the subscription feeds
3348    // server.
3349    // (also, should this live in GTalkService?)
3350    public static synchronized String getJidResource() {
3351        if (sJidResource != null) {
3352            return sJidResource;
3353        }
3354
3355        MessageDigest digest;
3356        try {
3357            digest = MessageDigest.getInstance("SHA-1");
3358        } catch (NoSuchAlgorithmException e) {
3359            throw new RuntimeException("this should never happen");
3360        }
3361
3362        String deviceId = TelephonyManager.getDefault().getDeviceId();
3363        if (TextUtils.isEmpty(deviceId)) {
3364            return "";
3365        }
3366
3367        byte[] hashedDeviceId = digest.digest(deviceId.getBytes());
3368        String id = new String(Base64.encodeBase64(hashedDeviceId), 0, 12);
3369        id = id.replaceAll("/", "_");
3370        sJidResource = JID_RESOURCE_PREFIX + id;
3371        return sJidResource;
3372    }
3373
3374    /**
3375     * Returns the device ID that we should use when connecting to the mobile gtalk server.
3376     * This is a string like "android-0x1242", where the hex string is the Android ID obtained
3377     * from the GoogleLoginService.
3378     *
3379     * @param androidId The Android ID for this device.
3380     * @return The device ID that should be used when connecting to the mobile gtalk server.
3381     * @hide
3382     */
3383    public static String getGTalkDeviceId(long androidId) {
3384        return "android-" + Long.toHexString(androidId);
3385    }
3386}
3387