blob: bfd179141554030471c96a54f1b3041ced949583 [file] [log] [blame]
Dianne Hackborn231cc602009-04-27 17:10:36 -07001/*
2 * Copyright (C) 2009 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
Jeff Sharkey7a96c392012-11-15 14:01:46 -080017package com.android.server.content;
Jason parksa3cdaa52011-01-13 14:15:43 -060018
Fred Quintanad9d2f112009-04-23 13:36:27 -070019import android.accounts.Account;
Amith Yamasanif29f2362012-04-05 18:29:52 -070020import android.accounts.AccountAndUser;
Suprabh Shukla042a4782017-05-12 15:26:54 -070021import android.accounts.AccountManager;
Makoto Onuki3ab77812018-07-09 14:29:33 -070022import android.annotation.Nullable;
Marvin Paula6533252014-11-24 12:57:48 -080023import android.app.backup.BackupManager;
Matthew Williamsfa774182013-06-18 15:44:11 -070024import android.content.ComponentName;
Jeff Sharkey7a96c392012-11-15 14:01:46 -080025import android.content.ContentResolver;
Makoto Onuki75ad2492018-03-28 14:42:42 -070026import android.content.ContentResolver.SyncExemption;
Jeff Sharkey7a96c392012-11-15 14:01:46 -080027import android.content.Context;
28import android.content.ISyncStatusObserver;
29import android.content.PeriodicSync;
30import android.content.SyncInfo;
Matthew Williams56dbf8f2013-07-26 12:56:39 -070031import android.content.SyncRequest;
Jeff Sharkey7a96c392012-11-15 14:01:46 -080032import android.content.SyncStatusInfo;
Suprabh Shukla042a4782017-05-12 15:26:54 -070033import android.content.pm.PackageManager;
Dianne Hackborn231cc602009-04-27 17:10:36 -070034import android.os.Bundle;
35import android.os.Environment;
36import android.os.Handler;
Makoto Onuki6963bea72017-12-12 10:42:39 -080037import android.os.Looper;
Dianne Hackborn231cc602009-04-27 17:10:36 -070038import android.os.Message;
39import android.os.Parcel;
40import android.os.RemoteCallbackList;
41import android.os.RemoteException;
Matthew Williams56dbf8f2013-07-26 12:56:39 -070042import android.os.UserHandle;
Makoto Onukid4764302018-03-30 17:32:57 -070043import android.util.ArrayMap;
44import android.util.AtomicFile;
45import android.util.EventLog;
46import android.util.Log;
47import android.util.Pair;
48import android.util.Slog;
49import android.util.SparseArray;
50import android.util.Xml;
Jeff Sharkey7a96c392012-11-15 14:01:46 -080051
52import com.android.internal.annotations.VisibleForTesting;
53import com.android.internal.util.ArrayUtils;
54import com.android.internal.util.FastXmlSerializer;
55
56import org.xmlpull.v1.XmlPullParser;
57import org.xmlpull.v1.XmlPullParserException;
58import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080059
Dianne Hackborn231cc602009-04-27 17:10:36 -070060import java.io.File;
61import java.io.FileInputStream;
62import java.io.FileOutputStream;
Wojciech Staszkiewicz9e9e2e72015-05-08 14:58:46 +010063import java.nio.charset.StandardCharsets;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080064import java.util.ArrayList;
Dianne Hackborn231cc602009-04-27 17:10:36 -070065import java.util.Calendar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080066import java.util.HashMap;
Dianne Hackborn231cc602009-04-27 17:10:36 -070067import java.util.Iterator;
Jeff Sharkey7a96c392012-11-15 14:01:46 -080068import java.util.List;
Ashish Sharma69d95de2012-04-11 17:27:24 -070069import java.util.Random;
Jason parks1125d782011-01-12 09:47:26 -060070import java.util.TimeZone;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080071
72/**
Dianne Hackborn231cc602009-04-27 17:10:36 -070073 * Singleton that tracks the sync data and overall sync
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074 * history on the device.
Costin Manolache360e4542009-09-04 13:36:04 -070075 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080076 * @hide
77 */
Makoto Onuki6963bea72017-12-12 10:42:39 -080078public class SyncStorageEngine {
Amith Yamasani04e0d262012-02-14 11:50:53 -080079
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080080 private static final String TAG = "SyncManager";
Matthew Williamsba352712013-08-13 15:53:31 -070081 private static final String TAG_FILE = "SyncManagerFile";
Costin Manolache360e4542009-09-04 13:36:04 -070082
Amith Yamasani04e0d262012-02-14 11:50:53 -080083 private static final String XML_ATTR_NEXT_AUTHORITY_ID = "nextAuthorityId";
84 private static final String XML_ATTR_LISTEN_FOR_TICKLES = "listen-for-tickles";
Ashish Sharma69d95de2012-04-11 17:27:24 -070085 private static final String XML_ATTR_SYNC_RANDOM_OFFSET = "offsetInSeconds";
Amith Yamasani04e0d262012-02-14 11:50:53 -080086 private static final String XML_ATTR_ENABLED = "enabled";
87 private static final String XML_ATTR_USER = "user";
88 private static final String XML_TAG_LISTEN_FOR_TICKLES = "listenForTickles";
89
Matthew Williamsfa774182013-06-18 15:44:11 -070090 /** Default time for a periodic sync. */
Shreyas Basargecf939c12016-02-19 15:45:29 +000091 private static final long DEFAULT_POLL_FREQUENCY_SECONDS = 60 * 60 * 24; // One day
Fred Quintanac5d1c6d2010-01-27 12:17:49 -080092
Shreyas Basarge8c834c02016-01-07 13:53:16 +000093 /** Percentage of period that is flex by default, if no flexMillis is set. */
Matthew Williamsfa774182013-06-18 15:44:11 -070094 private static final double DEFAULT_FLEX_PERCENT_SYNC = 0.04;
95
96 /** Lower bound on sync time from which we assign a default flex time. */
97 private static final long DEFAULT_MIN_FLEX_ALLOWED_SECS = 5;
98
Jeff Sharkey8b2c3a142012-11-12 11:45:05 -080099 @VisibleForTesting
Dianne Hackborn231cc602009-04-27 17:10:36 -0700100 static final long MILLIS_IN_4WEEKS = 1000L * 60 * 60 * 24 * 7 * 4;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800101
Dianne Hackborn231cc602009-04-27 17:10:36 -0700102 /** Enum value for a sync start event. */
103 public static final int EVENT_START = 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800104
Dianne Hackborn231cc602009-04-27 17:10:36 -0700105 /** Enum value for a sync stop event. */
106 public static final int EVENT_STOP = 1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800107
Makoto Onuki94986212018-04-11 16:24:46 -0700108 /** Enum value for a sync with other sources. */
109 public static final int SOURCE_OTHER = 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800110
Dianne Hackborn231cc602009-04-27 17:10:36 -0700111 /** Enum value for a local-initiated sync. */
112 public static final int SOURCE_LOCAL = 1;
Makoto Onuki94986212018-04-11 16:24:46 -0700113
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700114 /** Enum value for a poll-based sync (e.g., upon connection to network) */
Dianne Hackborn231cc602009-04-27 17:10:36 -0700115 public static final int SOURCE_POLL = 2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800116
Dianne Hackborn231cc602009-04-27 17:10:36 -0700117 /** Enum value for a user-initiated sync. */
118 public static final int SOURCE_USER = 3;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800119
Fred Quintanac5d1c6d2010-01-27 12:17:49 -0800120 /** Enum value for a periodic sync. */
121 public static final int SOURCE_PERIODIC = 4;
122
Makoto Onuki94986212018-04-11 16:24:46 -0700123 /** Enum a sync with a "feed" extra */
124 public static final int SOURCE_FEED = 5;
125
Fred Quintana307da1a2010-01-21 14:24:20 -0800126 public static final long NOT_IN_BACKOFF_MODE = -1;
127
Makoto Onukif74cf942018-04-16 17:04:58 -0700128 /**
129 * String names for the sync source types.
130 *
131 * KEEP THIS AND {@link SyncStatusInfo#SOURCE_COUNT} IN SYNC.
132 */
133 public static final String[] SOURCES = {
134 "OTHER",
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000135 "LOCAL",
136 "POLL",
137 "USER",
138 "PERIODIC",
Makoto Onuki94986212018-04-11 16:24:46 -0700139 "FEED"};
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800140
Dianne Hackborn231cc602009-04-27 17:10:36 -0700141 // The MESG column will contain one of these or one of the Error types.
142 public static final String MESG_SUCCESS = "success";
143 public static final String MESG_CANCELED = "canceled";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800144
Dianne Hackborna33e3f72009-09-29 17:28:24 -0700145 public static final int MAX_HISTORY = 100;
Costin Manolache360e4542009-09-04 13:36:04 -0700146
Dianne Hackborn231cc602009-04-27 17:10:36 -0700147 private static final int MSG_WRITE_STATUS = 1;
148 private static final long WRITE_STATUS_DELAY = 1000*60*10; // 10 minutes
Costin Manolache360e4542009-09-04 13:36:04 -0700149
Dianne Hackborn231cc602009-04-27 17:10:36 -0700150 private static final int MSG_WRITE_STATISTICS = 2;
151 private static final long WRITE_STATISTICS_DELAY = 1000*60*30; // 1/2 hour
Joe Onorato8294fad2009-07-15 16:08:44 -0700152
153 private static final boolean SYNC_ENABLED_DEFAULT = false;
Costin Manolache360e4542009-09-04 13:36:04 -0700154
Fred Quintanac2e46912010-03-15 16:10:44 -0700155 // the version of the accounts xml file format
Svet Ganov65712b02016-09-01 10:24:11 -0700156 private static final int ACCOUNTS_VERSION = 3;
Fred Quintanafb084402010-03-23 17:57:03 -0700157
158 private static HashMap<String, String> sAuthorityRenames;
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000159 private static PeriodicSyncAddedListener mPeriodicSyncAddedListener;
Fred Quintanafb084402010-03-23 17:57:03 -0700160
Makoto Onuki94986212018-04-11 16:24:46 -0700161 private volatile boolean mIsClockValid;
162
Fred Quintanafb084402010-03-23 17:57:03 -0700163 static {
164 sAuthorityRenames = new HashMap<String, String>();
165 sAuthorityRenames.put("contacts", "com.android.contacts");
166 sAuthorityRenames.put("calendar", "com.android.calendar");
167 }
Fred Quintanac2e46912010-03-15 16:10:44 -0700168
Dianne Hackborn231cc602009-04-27 17:10:36 -0700169 static class AccountInfo {
Amith Yamasani04e0d262012-02-14 11:50:53 -0800170 final AccountAndUser accountAndUser;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700171 final HashMap<String, AuthorityInfo> authorities =
172 new HashMap<String, AuthorityInfo>();
Costin Manolache360e4542009-09-04 13:36:04 -0700173
Amith Yamasani04e0d262012-02-14 11:50:53 -0800174 AccountInfo(AccountAndUser accountAndUser) {
175 this.accountAndUser = accountAndUser;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700176 }
177 }
Costin Manolache360e4542009-09-04 13:36:04 -0700178
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700179 /** Bare bones representation of a sync target. */
180 public static class EndPoint {
181 public final static EndPoint USER_ALL_PROVIDER_ALL_ACCOUNTS_ALL =
182 new EndPoint(null, null, UserHandle.USER_ALL);
Dianne Hackborn7a135592009-05-06 00:28:37 -0700183 final Account account;
Amith Yamasani04e0d262012-02-14 11:50:53 -0800184 final int userId;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700185 final String provider;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700186
187 public EndPoint(Account account, String provider, int userId) {
188 this.account = account;
189 this.provider = provider;
190 this.userId = userId;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700191 }
192
193 /**
Matthew Williams8ef22042013-07-26 12:56:39 -0700194 * An Endpoint for a sync matches if it targets the same sync adapter for the same user.
195 *
196 * @param spec the Endpoint to match. If the spec has null fields, they indicate a wildcard
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000197 * and match any.
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700198 */
Matthew Williams8ef22042013-07-26 12:56:39 -0700199 public boolean matchesSpec(EndPoint spec) {
200 if (userId != spec.userId
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700201 && userId != UserHandle.USER_ALL
Matthew Williams8ef22042013-07-26 12:56:39 -0700202 && spec.userId != UserHandle.USER_ALL) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700203 return false;
204 }
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000205 boolean accountsMatch;
206 if (spec.account == null) {
207 accountsMatch = true;
208 } else {
209 accountsMatch = account.equals(spec.account);
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700210 }
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000211 boolean providersMatch;
212 if (spec.provider == null) {
213 providersMatch = true;
214 } else {
215 providersMatch = provider.equals(spec.provider);
216 }
217 return accountsMatch && providersMatch;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700218 }
219
220 public String toString() {
221 StringBuilder sb = new StringBuilder();
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000222 sb.append(account == null ? "ALL ACCS" : account.name)
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700223 .append("/")
224 .append(provider == null ? "ALL PDRS" : provider);
Matthew Williams8ef22042013-07-26 12:56:39 -0700225 sb.append(":u" + userId);
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700226 return sb.toString();
227 }
228 }
229
230 public static class AuthorityInfo {
Matthew Williams53abfdb2015-06-10 20:06:37 -0700231 // Legal values of getIsSyncable
Svet Ganovf6d424f12016-09-20 20:18:53 -0700232
233 /**
234 * The syncable state is undefined.
235 */
236 public static final int UNDEFINED = -2;
237
Matthew Williams53abfdb2015-06-10 20:06:37 -0700238 /**
239 * Default state for a newly installed adapter. An uninitialized adapter will receive an
240 * initialization sync which are governed by a different set of rules to that of regular
241 * syncs.
242 */
243 public static final int NOT_INITIALIZED = -1;
244 /**
245 * The adapter will not receive any syncs. This is behaviourally equivalent to
246 * setSyncAutomatically -> false. However setSyncAutomatically is surfaced to the user
247 * while this is generally meant to be controlled by the developer.
248 */
249 public static final int NOT_SYNCABLE = 0;
250 /**
251 * The adapter is initialized and functioning. This is the normal state for an adapter.
252 */
253 public static final int SYNCABLE = 1;
254 /**
255 * The adapter is syncable but still requires an initialization sync. For example an adapter
256 * than has been restored from a previous device will be in this state. Not meant for
257 * external use.
258 */
259 public static final int SYNCABLE_NOT_INITIALIZED = 2;
260
Svetoslav Ganov5cb29732016-07-11 19:32:30 -0700261 /**
262 * The adapter is syncable but does not have access to the synced account and needs a
263 * user access approval.
264 */
265 public static final int SYNCABLE_NO_ACCOUNT_ACCESS = 3;
266
Matthew Williams8ef22042013-07-26 12:56:39 -0700267 final EndPoint target;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700268 final int ident;
269 boolean enabled;
Fred Quintana5e787c42009-08-16 23:13:53 -0700270 int syncable;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700271 /** Time at which this sync will run, taking into account backoff. */
Fred Quintana307da1a2010-01-21 14:24:20 -0800272 long backoffTime;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700273 /** Amount of delay due to backoff. */
Fred Quintana307da1a2010-01-21 14:24:20 -0800274 long backoffDelay;
Matthew Williams8ef22042013-07-26 12:56:39 -0700275 /** Time offset to add to any requests coming to this target. */
Fred Quintana307da1a2010-01-21 14:24:20 -0800276 long delayUntil;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700277
Matthew Williamsfa774182013-06-18 15:44:11 -0700278 final ArrayList<PeriodicSync> periodicSyncs;
Fred Quintanaac9385e2009-06-22 18:00:59 -0700279
Carlos Valdivia3aca7d72012-05-07 19:03:51 -0700280 /**
281 * Copy constructor for making deep-ish copies. Only the bundles stored
282 * in periodic syncs can make unexpected changes.
283 *
284 * @param toCopy AuthorityInfo to be copied.
285 */
286 AuthorityInfo(AuthorityInfo toCopy) {
Matthew Williams8ef22042013-07-26 12:56:39 -0700287 target = toCopy.target;
Carlos Valdivia3aca7d72012-05-07 19:03:51 -0700288 ident = toCopy.ident;
289 enabled = toCopy.enabled;
290 syncable = toCopy.syncable;
291 backoffTime = toCopy.backoffTime;
292 backoffDelay = toCopy.backoffDelay;
293 delayUntil = toCopy.delayUntil;
Matthew Williamsfa774182013-06-18 15:44:11 -0700294 periodicSyncs = new ArrayList<PeriodicSync>();
295 for (PeriodicSync sync : toCopy.periodicSyncs) {
Carlos Valdivia3aca7d72012-05-07 19:03:51 -0700296 // Still not a perfect copy, because we are just copying the mappings.
Matthew Williamsfa774182013-06-18 15:44:11 -0700297 periodicSyncs.add(new PeriodicSync(sync));
Carlos Valdivia3aca7d72012-05-07 19:03:51 -0700298 }
299 }
300
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700301 AuthorityInfo(EndPoint info, int id) {
Matthew Williams8ef22042013-07-26 12:56:39 -0700302 target = info;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700303 ident = id;
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000304 enabled = SYNC_ENABLED_DEFAULT;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700305 periodicSyncs = new ArrayList<PeriodicSync>();
306 defaultInitialisation();
307 }
308
309 private void defaultInitialisation() {
Matthew Williams53abfdb2015-06-10 20:06:37 -0700310 syncable = NOT_INITIALIZED; // default to "unknown"
Fred Quintana307da1a2010-01-21 14:24:20 -0800311 backoffTime = -1; // if < 0 then we aren't in backoff mode
312 backoffDelay = -1; // if < 0 then we aren't in backoff mode
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000313
314 if (mPeriodicSyncAddedListener != null) {
315 mPeriodicSyncAddedListener.onPeriodicSyncAdded(target, new Bundle(),
316 DEFAULT_POLL_FREQUENCY_SECONDS,
317 calculateDefaultFlexTime(DEFAULT_POLL_FREQUENCY_SECONDS));
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700318 }
Dianne Hackborn231cc602009-04-27 17:10:36 -0700319 }
Matthew Williams06485a72013-07-26 12:56:39 -0700320
321 @Override
322 public String toString() {
323 return target + ", enabled=" + enabled + ", syncable=" + syncable + ", backoff="
324 + backoffTime + ", delay=" + delayUntil;
325 }
Dianne Hackborn231cc602009-04-27 17:10:36 -0700326 }
Costin Manolache360e4542009-09-04 13:36:04 -0700327
Dianne Hackborn231cc602009-04-27 17:10:36 -0700328 public static class SyncHistoryItem {
329 int authorityId;
330 int historyId;
331 long eventTime;
332 long elapsedTime;
333 int source;
334 int event;
335 long upstreamActivity;
336 long downstreamActivity;
337 String mesg;
Fred Quintanadc475562012-05-04 15:51:54 -0700338 boolean initialization;
Alon Albert57286f92012-10-09 14:21:38 -0700339 Bundle extras;
340 int reason;
Makoto Onukid5f25d22018-05-22 16:02:17 -0700341 int syncExemptionFlag;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700342 }
Costin Manolache360e4542009-09-04 13:36:04 -0700343
Dianne Hackborn231cc602009-04-27 17:10:36 -0700344 public static class DayStats {
345 public final int day;
346 public int successCount;
347 public long successTime;
348 public int failureCount;
349 public long failureTime;
Costin Manolache360e4542009-09-04 13:36:04 -0700350
Dianne Hackborn231cc602009-04-27 17:10:36 -0700351 public DayStats(int day) {
352 this.day = day;
353 }
354 }
Costin Manolache360e4542009-09-04 13:36:04 -0700355
Amith Yamasani04e0d262012-02-14 11:50:53 -0800356 interface OnSyncRequestListener {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700357
358 /** Called when a sync is needed on an account(s) due to some change in state. */
Makoto Onuki61283ec2018-01-31 17:22:36 -0800359 public void onSyncRequest(EndPoint info, int reason, Bundle extras,
Makoto Onukie183a402018-08-29 11:46:41 -0700360 @SyncExemption int syncExemptionFlag, int callingUid, int callingPid);
Amith Yamasani04e0d262012-02-14 11:50:53 -0800361 }
362
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000363 interface PeriodicSyncAddedListener {
364 /** Called when a periodic sync is added. */
365 void onPeriodicSyncAdded(EndPoint target, Bundle extras, long pollFrequency, long flex);
366 }
367
368 interface OnAuthorityRemovedListener {
369 /** Called when an authority is removed. */
370 void onAuthorityRemoved(EndPoint removedAuthority);
371 }
372
Suprabh Shukla042a4782017-05-12 15:26:54 -0700373 /**
374 * Validator that maintains a lazy cache of accounts and providers to tell if an authority or
375 * account is valid.
376 */
377 private static class AccountAuthorityValidator {
378 final private AccountManager mAccountManager;
379 final private PackageManager mPackageManager;
380 final private SparseArray<Account[]> mAccountsCache;
381 final private SparseArray<ArrayMap<String, Boolean>> mProvidersPerUserCache;
382
383 AccountAuthorityValidator(Context context) {
384 mAccountManager = context.getSystemService(AccountManager.class);
385 mPackageManager = context.getPackageManager();
386 mAccountsCache = new SparseArray<>();
387 mProvidersPerUserCache = new SparseArray<>();
388 }
389
390 // An account is valid if an installed authenticator has previously created that account
391 // on the device
392 boolean isAccountValid(Account account, int userId) {
393 Account[] accountsForUser = mAccountsCache.get(userId);
394 if (accountsForUser == null) {
395 accountsForUser = mAccountManager.getAccountsAsUser(userId);
396 mAccountsCache.put(userId, accountsForUser);
397 }
398 return ArrayUtils.contains(accountsForUser, account);
399 }
400
401 // An authority is only valid if it has a content provider installed on the system
402 boolean isAuthorityValid(String authority, int userId) {
403 ArrayMap<String, Boolean> authorityMap = mProvidersPerUserCache.get(userId);
404 if (authorityMap == null) {
405 authorityMap = new ArrayMap<>();
406 mProvidersPerUserCache.put(userId, authorityMap);
407 }
408 if (!authorityMap.containsKey(authority)) {
409 authorityMap.put(authority, mPackageManager.resolveContentProviderAsUser(authority,
410 PackageManager.MATCH_DIRECT_BOOT_AWARE
411 | PackageManager.MATCH_DIRECT_BOOT_UNAWARE, userId) != null);
412 }
413 return authorityMap.get(authority);
414 }
415 }
416
Dianne Hackborn231cc602009-04-27 17:10:36 -0700417 // Primary list of all syncable authorities. Also our global lock.
418 private final SparseArray<AuthorityInfo> mAuthorities =
419 new SparseArray<AuthorityInfo>();
Costin Manolache360e4542009-09-04 13:36:04 -0700420
Amith Yamasani04e0d262012-02-14 11:50:53 -0800421 private final HashMap<AccountAndUser, AccountInfo> mAccounts
422 = new HashMap<AccountAndUser, AccountInfo>();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800423
Amith Yamasani04e0d262012-02-14 11:50:53 -0800424 private final SparseArray<ArrayList<SyncInfo>> mCurrentSyncs
425 = new SparseArray<ArrayList<SyncInfo>>();
Costin Manolache360e4542009-09-04 13:36:04 -0700426
Dianne Hackborn231cc602009-04-27 17:10:36 -0700427 private final SparseArray<SyncStatusInfo> mSyncStatus =
428 new SparseArray<SyncStatusInfo>();
Costin Manolache360e4542009-09-04 13:36:04 -0700429
Dianne Hackborn231cc602009-04-27 17:10:36 -0700430 private final ArrayList<SyncHistoryItem> mSyncHistory =
431 new ArrayList<SyncHistoryItem>();
Costin Manolache360e4542009-09-04 13:36:04 -0700432
Dianne Hackborn231cc602009-04-27 17:10:36 -0700433 private final RemoteCallbackList<ISyncStatusObserver> mChangeListeners
434 = new RemoteCallbackList<ISyncStatusObserver>();
Costin Manolache360e4542009-09-04 13:36:04 -0700435
Matthew Williams8ef22042013-07-26 12:56:39 -0700436 /** Reverse mapping for component name -> <userid -> target id>. */
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700437 private final ArrayMap<ComponentName, SparseArray<AuthorityInfo>> mServices =
438 new ArrayMap<ComponentName, SparseArray<AuthorityInfo>>();
Matthew Williamsfa774182013-06-18 15:44:11 -0700439
Fred Quintana77c560f2010-03-29 22:20:26 -0700440 private int mNextAuthorityId = 0;
441
Dianne Hackborn231cc602009-04-27 17:10:36 -0700442 // We keep 4 weeks of stats.
443 private final DayStats[] mDayStats = new DayStats[7*4];
444 private final Calendar mCal;
445 private int mYear;
446 private int mYearInDays;
Costin Manolache360e4542009-09-04 13:36:04 -0700447
Dianne Hackborn231cc602009-04-27 17:10:36 -0700448 private final Context mContext;
Fred Quintanac5d1c6d2010-01-27 12:17:49 -0800449
Dianne Hackborn231cc602009-04-27 17:10:36 -0700450 private static volatile SyncStorageEngine sSyncStorageEngine = null;
Costin Manolache360e4542009-09-04 13:36:04 -0700451
Ashish Sharma69d95de2012-04-11 17:27:24 -0700452 private int mSyncRandomOffset;
453
Dianne Hackborn231cc602009-04-27 17:10:36 -0700454 /**
455 * This file contains the core engine state: all accounts and the
456 * settings for them. It must never be lost, and should be changed
457 * infrequently, so it is stored as an XML file.
458 */
459 private final AtomicFile mAccountInfoFile;
Costin Manolache360e4542009-09-04 13:36:04 -0700460
Dianne Hackborn231cc602009-04-27 17:10:36 -0700461 /**
462 * This file contains the current sync status. We would like to retain
463 * it across boots, but its loss is not the end of the world, so we store
464 * this information as binary data.
465 */
466 private final AtomicFile mStatusFile;
Costin Manolache360e4542009-09-04 13:36:04 -0700467
Dianne Hackborn231cc602009-04-27 17:10:36 -0700468 /**
469 * This file contains sync statistics. This is purely debugging information
470 * so is written infrequently and can be thrown away at any time.
471 */
472 private final AtomicFile mStatisticsFile;
Costin Manolache360e4542009-09-04 13:36:04 -0700473
Dianne Hackborn231cc602009-04-27 17:10:36 -0700474 private int mNextHistoryId = 0;
Amith Yamasani04e0d262012-02-14 11:50:53 -0800475 private SparseArray<Boolean> mMasterSyncAutomatically = new SparseArray<Boolean>();
Yameng Huang2b5d0ea2011-01-11 14:00:19 +0800476 private boolean mDefaultMasterSyncAutomatically;
Amith Yamasani04e0d262012-02-14 11:50:53 -0800477
478 private OnSyncRequestListener mSyncRequestListener;
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000479 private OnAuthorityRemovedListener mAuthorityRemovedListener;
Costin Manolache360e4542009-09-04 13:36:04 -0700480
Svet Ganov65712b02016-09-01 10:24:11 -0700481 private boolean mGrantSyncAdaptersAccountAccess;
482
Makoto Onuki6963bea72017-12-12 10:42:39 -0800483 private final MyHandler mHandler;
Makoto Onukid4764302018-03-30 17:32:57 -0700484 private final SyncLogger mLogger;
Makoto Onuki6963bea72017-12-12 10:42:39 -0800485
486 private SyncStorageEngine(Context context, File dataDir, Looper looper) {
487 mHandler = new MyHandler(looper);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800488 mContext = context;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800489 sSyncStorageEngine = this;
Makoto Onukid4764302018-03-30 17:32:57 -0700490 mLogger = SyncLogger.getInstance();
Costin Manolache360e4542009-09-04 13:36:04 -0700491
Dianne Hackborn231cc602009-04-27 17:10:36 -0700492 mCal = Calendar.getInstance(TimeZone.getTimeZone("GMT+0"));
Costin Manolache360e4542009-09-04 13:36:04 -0700493
Yameng Huang2b5d0ea2011-01-11 14:00:19 +0800494 mDefaultMasterSyncAutomatically = mContext.getResources().getBoolean(
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000495 com.android.internal.R.bool.config_syncstorageengine_masterSyncAutomatically);
Yameng Huang2b5d0ea2011-01-11 14:00:19 +0800496
Dianne Hackborn231cc602009-04-27 17:10:36 -0700497 File systemDir = new File(dataDir, "system");
498 File syncDir = new File(systemDir, "sync");
Fred Quintanac5d1c6d2010-01-27 12:17:49 -0800499 syncDir.mkdirs();
Matthew Williamsba352712013-08-13 15:53:31 -0700500
501 maybeDeleteLegacyPendingInfoLocked(syncDir);
502
Dianne Hackborne17b4452018-01-10 13:15:40 -0800503 mAccountInfoFile = new AtomicFile(new File(syncDir, "accounts.xml"), "sync-accounts");
504 mStatusFile = new AtomicFile(new File(syncDir, "status.bin"), "sync-status");
505 mStatisticsFile = new AtomicFile(new File(syncDir, "stats.bin"), "sync-stats");
Costin Manolache360e4542009-09-04 13:36:04 -0700506
Dianne Hackborn231cc602009-04-27 17:10:36 -0700507 readAccountInfoLocked();
508 readStatusLocked();
Dianne Hackborn231cc602009-04-27 17:10:36 -0700509 readStatisticsLocked();
Makoto Onukid4764302018-03-30 17:32:57 -0700510
511 if (mLogger.enabled()) {
512 final int size = mAuthorities.size();
513 mLogger.log("Loaded ", size, " items");
514 for (int i = 0; i < size; i++) {
515 mLogger.log(mAuthorities.valueAt(i));
516 }
517 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 }
519
520 public static SyncStorageEngine newTestInstance(Context context) {
Makoto Onuki6963bea72017-12-12 10:42:39 -0800521 return new SyncStorageEngine(context, context.getFilesDir(), Looper.getMainLooper());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800522 }
523
Makoto Onuki6963bea72017-12-12 10:42:39 -0800524 public static void init(Context context, Looper looper) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800525 if (sSyncStorageEngine != null) {
Fred Quintana307da1a2010-01-21 14:24:20 -0800526 return;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800527 }
Jeff Sharkey8212ae02016-02-10 14:46:43 -0700528 File dataDir = Environment.getDataDirectory();
Makoto Onuki6963bea72017-12-12 10:42:39 -0800529 sSyncStorageEngine = new SyncStorageEngine(context, dataDir, looper);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800530 }
531
532 public static SyncStorageEngine getSingleton() {
533 if (sSyncStorageEngine == null) {
534 throw new IllegalStateException("not initialized");
535 }
536 return sSyncStorageEngine;
537 }
538
Amith Yamasani04e0d262012-02-14 11:50:53 -0800539 protected void setOnSyncRequestListener(OnSyncRequestListener listener) {
540 if (mSyncRequestListener == null) {
541 mSyncRequestListener = listener;
542 }
543 }
544
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000545 protected void setOnAuthorityRemovedListener(OnAuthorityRemovedListener listener) {
546 if (mAuthorityRemovedListener == null) {
547 mAuthorityRemovedListener = listener;
548 }
549 }
550
551 protected void setPeriodicSyncAddedListener(PeriodicSyncAddedListener listener) {
552 if (mPeriodicSyncAddedListener == null) {
553 mPeriodicSyncAddedListener = listener;
554 }
555 }
556
Makoto Onuki6963bea72017-12-12 10:42:39 -0800557 private class MyHandler extends Handler {
558 public MyHandler(Looper looper) {
559 super(looper);
560 }
561
562 @Override
563 public void handleMessage(Message msg) {
564 if (msg.what == MSG_WRITE_STATUS) {
565 synchronized (mAuthorities) {
566 writeStatusLocked();
567 }
568 } else if (msg.what == MSG_WRITE_STATISTICS) {
569 synchronized (mAuthorities) {
570 writeStatisticsLocked();
571 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800572 }
573 }
574 }
Costin Manolache360e4542009-09-04 13:36:04 -0700575
Ashish Sharma69d95de2012-04-11 17:27:24 -0700576 public int getSyncRandomOffset() {
577 return mSyncRandomOffset;
578 }
579
Dianne Hackborn231cc602009-04-27 17:10:36 -0700580 public void addStatusChangeListener(int mask, ISyncStatusObserver callback) {
581 synchronized (mAuthorities) {
582 mChangeListeners.register(callback, mask);
583 }
584 }
Costin Manolache360e4542009-09-04 13:36:04 -0700585
Dianne Hackborn231cc602009-04-27 17:10:36 -0700586 public void removeStatusChangeListener(ISyncStatusObserver callback) {
587 synchronized (mAuthorities) {
588 mChangeListeners.unregister(callback);
589 }
590 }
Costin Manolache360e4542009-09-04 13:36:04 -0700591
Matthew Williamsfa774182013-06-18 15:44:11 -0700592 /**
593 * Figure out a reasonable flex time for cases where none is provided (old api calls).
594 * @param syncTimeSeconds requested sync time from now.
595 * @return amount of seconds before syncTimeSeconds that the sync can occur.
596 * I.e.
597 * earliest_sync_time = syncTimeSeconds - calculateDefaultFlexTime(syncTimeSeconds)
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700598 * The flex time is capped at a percentage of the {@link #DEFAULT_POLL_FREQUENCY_SECONDS}.
Matthew Williamsfa774182013-06-18 15:44:11 -0700599 */
600 public static long calculateDefaultFlexTime(long syncTimeSeconds) {
601 if (syncTimeSeconds < DEFAULT_MIN_FLEX_ALLOWED_SECS) {
602 // Small enough sync request time that we don't add flex time - developer probably
603 // wants to wait for an operation to occur before syncing so we honour the
604 // request time.
605 return 0L;
606 } else if (syncTimeSeconds < DEFAULT_POLL_FREQUENCY_SECONDS) {
607 return (long) (syncTimeSeconds * DEFAULT_FLEX_PERCENT_SYNC);
608 } else {
609 // Large enough sync request time that we cap the flex time.
610 return (long) (DEFAULT_POLL_FREQUENCY_SECONDS * DEFAULT_FLEX_PERCENT_SYNC);
611 }
612 }
613
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000614 void reportChange(int which) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700615 ArrayList<ISyncStatusObserver> reports = null;
616 synchronized (mAuthorities) {
617 int i = mChangeListeners.beginBroadcast();
618 while (i > 0) {
619 i--;
620 Integer mask = (Integer)mChangeListeners.getBroadcastCookie(i);
621 if ((which & mask.intValue()) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800622 continue;
623 }
Dianne Hackborn231cc602009-04-27 17:10:36 -0700624 if (reports == null) {
625 reports = new ArrayList<ISyncStatusObserver>(i);
626 }
627 reports.add(mChangeListeners.getBroadcastItem(i));
628 }
Dianne Hackbornb06ea702009-07-13 13:07:51 -0700629 mChangeListeners.finishBroadcast();
Dianne Hackborn231cc602009-04-27 17:10:36 -0700630 }
Costin Manolache360e4542009-09-04 13:36:04 -0700631
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700632 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000633 Slog.v(TAG, "reportChange " + which + " to: " + reports);
Fred Quintana77c560f2010-03-29 22:20:26 -0700634 }
Costin Manolache360e4542009-09-04 13:36:04 -0700635
Dianne Hackborn231cc602009-04-27 17:10:36 -0700636 if (reports != null) {
637 int i = reports.size();
638 while (i > 0) {
639 i--;
640 try {
641 reports.get(i).onStatusChanged(which);
642 } catch (RemoteException e) {
643 // The remote callback list will take care of this for us.
644 }
645 }
646 }
647 }
Amith Yamasani70c874b2009-07-06 14:53:25 -0700648
Amith Yamasani04e0d262012-02-14 11:50:53 -0800649 public boolean getSyncAutomatically(Account account, int userId, String providerName) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700650 synchronized (mAuthorities) {
651 if (account != null) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700652 AuthorityInfo authority = getAuthorityLocked(
653 new EndPoint(account, providerName, userId),
Fred Quintanaac9385e2009-06-22 18:00:59 -0700654 "getSyncAutomatically");
655 return authority != null && authority.enabled;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700656 }
Fred Quintanaac9385e2009-06-22 18:00:59 -0700657
Dianne Hackborn231cc602009-04-27 17:10:36 -0700658 int i = mAuthorities.size();
659 while (i > 0) {
660 i--;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700661 AuthorityInfo authorityInfo = mAuthorities.valueAt(i);
Matthew Williams8ef22042013-07-26 12:56:39 -0700662 if (authorityInfo.target.matchesSpec(new EndPoint(account, providerName, userId))
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700663 && authorityInfo.enabled) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700664 return true;
665 }
666 }
667 return false;
668 }
669 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800670
Amith Yamasani04e0d262012-02-14 11:50:53 -0800671 public void setSyncAutomatically(Account account, int userId, String providerName,
Makoto Onukie183a402018-08-29 11:46:41 -0700672 boolean sync, @SyncExemption int syncExemptionFlag, int callingUid, int callingPid) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700673 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000674 Slog.d(TAG, "setSyncAutomatically: " + /* account + */" provider " + providerName
Dianne Hackborn40e9f292012-11-27 19:12:23 -0800675 + ", user " + userId + " -> " + sync);
676 }
Makoto Onukid4764302018-03-30 17:32:57 -0700677 mLogger.log("Set sync auto account=", account,
678 " user=", userId,
679 " authority=", providerName,
680 " value=", Boolean.toString(sync),
Makoto Onukie183a402018-08-29 11:46:41 -0700681 " cuid=", callingUid,
682 " cpid=", callingPid
683 );
Dianne Hackborn231cc602009-04-27 17:10:36 -0700684 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700685 AuthorityInfo authority =
686 getOrCreateAuthorityLocked(
687 new EndPoint(account, providerName, userId),
688 -1 /* ident */,
689 false);
Fred Quintana77c560f2010-03-29 22:20:26 -0700690 if (authority.enabled == sync) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700691 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000692 Slog.d(TAG, "setSyncAutomatically: already set to " + sync + ", doing nothing");
Dianne Hackborn40e9f292012-11-27 19:12:23 -0800693 }
Fred Quintana77c560f2010-03-29 22:20:26 -0700694 return;
695 }
Matthew Williams53abfdb2015-06-10 20:06:37 -0700696 // If the adapter was syncable but missing its initialization sync, set it to
697 // uninitialized now. This is to give it a chance to run any one-time initialization
698 // logic.
699 if (sync && authority.syncable == AuthorityInfo.SYNCABLE_NOT_INITIALIZED) {
700 authority.syncable = AuthorityInfo.NOT_INITIALIZED;
701 }
Joe Onorato8294fad2009-07-15 16:08:44 -0700702 authority.enabled = sync;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700703 writeAccountInfoLocked();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800704 }
Joe Onorato8294fad2009-07-15 16:08:44 -0700705
Fred Quintana77c560f2010-03-29 22:20:26 -0700706 if (sync) {
Alon Albert57286f92012-10-09 14:21:38 -0700707 requestSync(account, userId, SyncOperation.REASON_SYNC_AUTO, providerName,
Makoto Onuki61283ec2018-01-31 17:22:36 -0800708 new Bundle(),
Makoto Onukie183a402018-08-29 11:46:41 -0700709 syncExemptionFlag, callingUid, callingPid);
Joe Onorato8294fad2009-07-15 16:08:44 -0700710 }
Fred Quintanaac9385e2009-06-22 18:00:59 -0700711 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_SETTINGS);
Marvin Paula6533252014-11-24 12:57:48 -0800712 queueBackup();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800713 }
714
Amith Yamasani04e0d262012-02-14 11:50:53 -0800715 public int getIsSyncable(Account account, int userId, String providerName) {
Fred Quintana5e787c42009-08-16 23:13:53 -0700716 synchronized (mAuthorities) {
717 if (account != null) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700718 AuthorityInfo authority = getAuthorityLocked(
719 new EndPoint(account, providerName, userId),
720 "get authority syncable");
Fred Quintana5e787c42009-08-16 23:13:53 -0700721 if (authority == null) {
Matthew Williams53abfdb2015-06-10 20:06:37 -0700722 return AuthorityInfo.NOT_INITIALIZED;
Fred Quintana5e787c42009-08-16 23:13:53 -0700723 }
724 return authority.syncable;
725 }
726
727 int i = mAuthorities.size();
728 while (i > 0) {
729 i--;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700730 AuthorityInfo authorityInfo = mAuthorities.valueAt(i);
Matthew Williams8ef22042013-07-26 12:56:39 -0700731 if (authorityInfo.target != null
732 && authorityInfo.target.provider.equals(providerName)) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700733 return authorityInfo.syncable;
Fred Quintana5e787c42009-08-16 23:13:53 -0700734 }
735 }
Matthew Williams53abfdb2015-06-10 20:06:37 -0700736 return AuthorityInfo.NOT_INITIALIZED;
Fred Quintana5e787c42009-08-16 23:13:53 -0700737 }
738 }
739
Makoto Onukid4764302018-03-30 17:32:57 -0700740 public void setIsSyncable(Account account, int userId, String providerName, int syncable,
Makoto Onukie183a402018-08-29 11:46:41 -0700741 int callingUid, int callingPid) {
Makoto Onukid4764302018-03-30 17:32:57 -0700742 setSyncableStateForEndPoint(new EndPoint(account, providerName, userId), syncable,
Makoto Onukie183a402018-08-29 11:46:41 -0700743 callingUid, callingPid);
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700744 }
745
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700746 /**
747 * An enabled sync service and a syncable provider's adapter both get resolved to the same
748 * persisted variable - namely the "syncable" attribute for an AuthorityInfo in accounts.xml.
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700749 * @param target target to set value for.
750 * @param syncable 0 indicates unsyncable, <0 unknown, >0 is active/syncable.
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700751 */
Makoto Onukie183a402018-08-29 11:46:41 -0700752 private void setSyncableStateForEndPoint(EndPoint target, int syncable,
753 int callingUid, int callingPid) {
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700754 AuthorityInfo aInfo;
Makoto Onukid4764302018-03-30 17:32:57 -0700755 mLogger.log("Set syncable ", target, " value=", Integer.toString(syncable),
Makoto Onukie183a402018-08-29 11:46:41 -0700756 " cuid=", callingUid,
757 " cpid=", callingPid);
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700758 synchronized (mAuthorities) {
759 aInfo = getOrCreateAuthorityLocked(target, -1, false);
Matthew Williams53abfdb2015-06-10 20:06:37 -0700760 if (syncable < AuthorityInfo.NOT_INITIALIZED) {
761 syncable = AuthorityInfo.NOT_INITIALIZED;
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700762 }
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700763 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000764 Slog.d(TAG, "setIsSyncable: " + aInfo.toString() + " -> " + syncable);
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700765 }
766 if (aInfo.syncable == syncable) {
767 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000768 Slog.d(TAG, "setIsSyncable: already set to " + syncable + ", doing nothing");
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700769 }
770 return;
771 }
772 aInfo.syncable = syncable;
773 writeAccountInfoLocked();
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700774 }
Matthew Williams53abfdb2015-06-10 20:06:37 -0700775 if (syncable == AuthorityInfo.SYNCABLE) {
Makoto Onuki61283ec2018-01-31 17:22:36 -0800776 requestSync(aInfo, SyncOperation.REASON_IS_SYNCABLE, new Bundle(),
Makoto Onukie183a402018-08-29 11:46:41 -0700777 ContentResolver.SYNC_EXEMPTION_NONE, callingUid, callingPid);
Fred Quintana5e787c42009-08-16 23:13:53 -0700778 }
779 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_SETTINGS);
780 }
781
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700782 public Pair<Long, Long> getBackoff(EndPoint info) {
Fred Quintana307da1a2010-01-21 14:24:20 -0800783 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700784 AuthorityInfo authority = getAuthorityLocked(info, "getBackoff");
785 if (authority != null) {
786 return Pair.create(authority.backoffTime, authority.backoffDelay);
Fred Quintana307da1a2010-01-21 14:24:20 -0800787 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700788 return null;
Fred Quintana307da1a2010-01-21 14:24:20 -0800789 }
790 }
791
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700792 /**
793 * Update the backoff for the given endpoint. The endpoint may be for a provider/account and
794 * the account or provider info be null, which signifies all accounts or providers.
795 */
796 public void setBackoff(EndPoint info, long nextSyncTime, long nextDelay) {
797 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000798 Slog.v(TAG, "setBackoff: " + info
Fred Quintana307da1a2010-01-21 14:24:20 -0800799 + " -> nextSyncTime " + nextSyncTime + ", nextDelay " + nextDelay);
800 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700801 boolean changed;
Fred Quintana307da1a2010-01-21 14:24:20 -0800802 synchronized (mAuthorities) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000803 if (info.account == null || info.provider == null) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700804 // Do more work for a provider sync if the provided info has specified all
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000805 // accounts/providers.
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700806 changed = setBackoffLocked(
807 info.account /* may be null */,
808 info.userId,
809 info.provider /* may be null */,
810 nextSyncTime, nextDelay);
Fred Quintana307da1a2010-01-21 14:24:20 -0800811 } else {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700812 AuthorityInfo authorityInfo =
813 getOrCreateAuthorityLocked(info, -1 /* ident */, true);
814 if (authorityInfo.backoffTime == nextSyncTime
815 && authorityInfo.backoffDelay == nextDelay) {
816 changed = false;
817 } else {
818 authorityInfo.backoffTime = nextSyncTime;
819 authorityInfo.backoffDelay = nextDelay;
820 changed = true;
Fred Quintana307da1a2010-01-21 14:24:20 -0800821 }
Fred Quintana307da1a2010-01-21 14:24:20 -0800822 }
Fred Quintana307da1a2010-01-21 14:24:20 -0800823 }
Fred Quintana307da1a2010-01-21 14:24:20 -0800824 if (changed) {
825 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_SETTINGS);
826 }
827 }
828
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700829 /**
830 * Either set backoff for a specific authority, or set backoff for all the
831 * accounts on a specific adapter/all adapters.
832 *
833 * @param account account for which to set backoff. Null to specify all accounts.
834 * @param userId id of the user making this request.
835 * @param providerName provider for which to set backoff. Null to specify all providers.
Matthew Williams7a2ab3a2013-09-11 14:25:51 -0700836 * @return true if a change occured.
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700837 */
838 private boolean setBackoffLocked(Account account, int userId, String providerName,
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000839 long nextSyncTime, long nextDelay) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700840 boolean changed = false;
841 for (AccountInfo accountInfo : mAccounts.values()) {
842 if (account != null && !account.equals(accountInfo.accountAndUser.account)
843 && userId != accountInfo.accountAndUser.userId) {
844 continue;
845 }
846 for (AuthorityInfo authorityInfo : accountInfo.authorities.values()) {
847 if (providerName != null
Matthew Williams8ef22042013-07-26 12:56:39 -0700848 && !providerName.equals(authorityInfo.target.provider)) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700849 continue;
850 }
851 if (authorityInfo.backoffTime != nextSyncTime
852 || authorityInfo.backoffDelay != nextDelay) {
853 authorityInfo.backoffTime = nextSyncTime;
854 authorityInfo.backoffDelay = nextDelay;
855 changed = true;
856 }
857 }
858 }
859 return changed;
860 }
861
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000862 public void clearAllBackoffsLocked() {
Alon Albert744e310f2010-12-14 11:37:20 -0800863 boolean changed = false;
864 synchronized (mAuthorities) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000865 // Clear backoff for all sync adapters.
866 for (AccountInfo accountInfo : mAccounts.values()) {
867 for (AuthorityInfo authorityInfo : accountInfo.authorities.values()) {
868 if (authorityInfo.backoffTime != NOT_IN_BACKOFF_MODE
869 || authorityInfo.backoffDelay != NOT_IN_BACKOFF_MODE) {
870 if (Log.isLoggable(TAG, Log.VERBOSE)) {
871 Slog.v(TAG, "clearAllBackoffsLocked:"
872 + " authority:" + authorityInfo.target
873 + " account:" + accountInfo.accountAndUser.account.name
874 + " user:" + accountInfo.accountAndUser.userId
875 + " backoffTime was: " + authorityInfo.backoffTime
876 + " backoffDelay was: " + authorityInfo.backoffDelay);
Alon Albert744e310f2010-12-14 11:37:20 -0800877 }
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000878 authorityInfo.backoffTime = NOT_IN_BACKOFF_MODE;
879 authorityInfo.backoffDelay = NOT_IN_BACKOFF_MODE;
880 changed = true;
Alon Albert744e310f2010-12-14 11:37:20 -0800881 }
882 }
883 }
884 }
885
886 if (changed) {
887 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_SETTINGS);
888 }
889 }
890
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700891 public long getDelayUntilTime(EndPoint info) {
Fred Quintana307da1a2010-01-21 14:24:20 -0800892 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700893 AuthorityInfo authority = getAuthorityLocked(info, "getDelayUntil");
Fred Quintana307da1a2010-01-21 14:24:20 -0800894 if (authority == null) {
895 return 0;
896 }
897 return authority.delayUntil;
898 }
899 }
900
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700901 public void setDelayUntilTime(EndPoint info, long delayUntil) {
902 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000903 Slog.v(TAG, "setDelayUntil: " + info
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700904 + " -> delayUntil " + delayUntil);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -0800905 }
906 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700907 AuthorityInfo authority = getOrCreateAuthorityLocked(info, -1, true);
908 if (authority.delayUntil == delayUntil) {
909 return;
Matthew Williamsfa774182013-06-18 15:44:11 -0700910 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700911 authority.delayUntil = delayUntil;
912 }
913 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_SETTINGS);
914 }
915
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700916 /**
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000917 * Restore all periodic syncs read from persisted files. Used to restore periodic syncs
918 * after an OS update.
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700919 */
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000920 boolean restoreAllPeriodicSyncs() {
921 if (mPeriodicSyncAddedListener == null) {
922 return false;
Fred Quintanac5d1c6d2010-01-27 12:17:49 -0800923 }
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000924 synchronized (mAuthorities) {
925 for (int i=0; i<mAuthorities.size(); i++) {
926 AuthorityInfo authority = mAuthorities.valueAt(i);
927 for (PeriodicSync periodicSync: authority.periodicSyncs) {
928 mPeriodicSyncAddedListener.onPeriodicSyncAdded(authority.target,
929 periodicSync.extras, periodicSync.period, periodicSync.flexTime);
930 }
931 authority.periodicSyncs.clear();
932 }
933 writeAccountInfoLocked();
934 }
935 return true;
Fred Quintanac5d1c6d2010-01-27 12:17:49 -0800936 }
937
Makoto Onuki75ad2492018-03-28 14:42:42 -0700938 public void setMasterSyncAutomatically(boolean flag, int userId,
Makoto Onukie183a402018-08-29 11:46:41 -0700939 @SyncExemption int syncExemptionFlag, int callingUid, int callingPid) {
Makoto Onukid4764302018-03-30 17:32:57 -0700940 mLogger.log("Set master enabled=", flag, " user=", userId,
Makoto Onukie183a402018-08-29 11:46:41 -0700941 " cuid=", callingUid,
942 " cpid=", callingPid);
Dianne Hackborn231cc602009-04-27 17:10:36 -0700943 synchronized (mAuthorities) {
Amith Yamasani04e0d262012-02-14 11:50:53 -0800944 Boolean auto = mMasterSyncAutomatically.get(userId);
Matthew Williams8ef22042013-07-26 12:56:39 -0700945 if (auto != null && auto.equals(flag)) {
Fred Quintana77c560f2010-03-29 22:20:26 -0700946 return;
947 }
Amith Yamasani04e0d262012-02-14 11:50:53 -0800948 mMasterSyncAutomatically.put(userId, flag);
Dianne Hackborn231cc602009-04-27 17:10:36 -0700949 writeAccountInfoLocked();
950 }
Fred Quintana77c560f2010-03-29 22:20:26 -0700951 if (flag) {
Alon Albert57286f92012-10-09 14:21:38 -0700952 requestSync(null, userId, SyncOperation.REASON_MASTER_SYNC_AUTO, null,
Makoto Onuki61283ec2018-01-31 17:22:36 -0800953 new Bundle(),
Makoto Onukie183a402018-08-29 11:46:41 -0700954 syncExemptionFlag, callingUid, callingPid);
Joe Onorato8294fad2009-07-15 16:08:44 -0700955 }
Fred Quintanaac9385e2009-06-22 18:00:59 -0700956 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_SETTINGS);
Jeff Sharkey7a96c392012-11-15 14:01:46 -0800957 mContext.sendBroadcast(ContentResolver.ACTION_SYNC_CONN_STATUS_CHANGED);
Marvin Paula6533252014-11-24 12:57:48 -0800958 queueBackup();
Dianne Hackborn231cc602009-04-27 17:10:36 -0700959 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800960
Amith Yamasani04e0d262012-02-14 11:50:53 -0800961 public boolean getMasterSyncAutomatically(int userId) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700962 synchronized (mAuthorities) {
Amith Yamasani04e0d262012-02-14 11:50:53 -0800963 Boolean auto = mMasterSyncAutomatically.get(userId);
Yameng Huang2b5d0ea2011-01-11 14:00:19 +0800964 return auto == null ? mDefaultMasterSyncAutomatically : auto;
Dianne Hackborn231cc602009-04-27 17:10:36 -0700965 }
966 }
Costin Manolache360e4542009-09-04 13:36:04 -0700967
Makoto Onukib47e8942017-09-18 14:03:03 -0700968 public int getAuthorityCount() {
969 synchronized (mAuthorities) {
970 return mAuthorities.size();
971 }
972 }
973
Dianne Hackborn231cc602009-04-27 17:10:36 -0700974 public AuthorityInfo getAuthority(int authorityId) {
975 synchronized (mAuthorities) {
976 return mAuthorities.get(authorityId);
977 }
978 }
Costin Manolache360e4542009-09-04 13:36:04 -0700979
Dianne Hackborn231cc602009-04-27 17:10:36 -0700980 /**
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700981 * Returns true if there is currently a sync operation being actively processed for the given
Matthew Williams8ef22042013-07-26 12:56:39 -0700982 * target.
Dianne Hackborn231cc602009-04-27 17:10:36 -0700983 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700984 public boolean isSyncActive(EndPoint info) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700985 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -0700986 for (SyncInfo syncInfo : getCurrentSyncs(info.userId)) {
Fred Quintana918339a2010-10-05 14:00:39 -0700987 AuthorityInfo ainfo = getAuthority(syncInfo.authorityId);
Matthew Williams8ef22042013-07-26 12:56:39 -0700988 if (ainfo != null && ainfo.target.matchesSpec(info)) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700989 return true;
990 }
991 }
992 }
Dianne Hackborn231cc602009-04-27 17:10:36 -0700993 return false;
994 }
Costin Manolache360e4542009-09-04 13:36:04 -0700995
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000996 public void markPending(EndPoint info, boolean pendingValue) {
Dianne Hackborn231cc602009-04-27 17:10:36 -0700997 synchronized (mAuthorities) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +0000998 AuthorityInfo authority = getOrCreateAuthorityLocked(info,
999 -1 /* desired identifier */,
1000 true /* write accounts to storage */);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001001 if (authority == null) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001002 return;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001003 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001004 SyncStatusInfo status = getOrCreateSyncStatusLocked(authority.ident);
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001005 status.pending = pendingValue;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001006 }
Fred Quintanaac9385e2009-06-22 18:00:59 -07001007 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_PENDING);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001008 }
Costin Manolache360e4542009-09-04 13:36:04 -07001009
Dianne Hackborn231cc602009-04-27 17:10:36 -07001010 /**
1011 * Called when the set of account has changed, given the new array of
1012 * active accounts.
1013 */
Makoto Onuki3ab77812018-07-09 14:29:33 -07001014 public void removeStaleAccounts(@Nullable Account[] accounts, int userId) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001015 synchronized (mAuthorities) {
Matthew Williams8ef22042013-07-26 12:56:39 -07001016 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001017 Slog.v(TAG, "Updating for new accounts...");
Matthew Williams8ef22042013-07-26 12:56:39 -07001018 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001019 SparseArray<AuthorityInfo> removing = new SparseArray<AuthorityInfo>();
1020 Iterator<AccountInfo> accIt = mAccounts.values().iterator();
1021 while (accIt.hasNext()) {
1022 AccountInfo acc = accIt.next();
Makoto Onuki3ab77812018-07-09 14:29:33 -07001023 if ((accounts == null) || (
1024 (acc.accountAndUser.userId == userId)
1025 && !ArrayUtils.contains(accounts, acc.accountAndUser.account))) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001026 // This account no longer exists...
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001027 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001028 Slog.v(TAG, "Account removed: " + acc.accountAndUser);
Fred Quintana77c560f2010-03-29 22:20:26 -07001029 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001030 for (AuthorityInfo auth : acc.authorities.values()) {
1031 removing.put(auth.ident, auth);
1032 }
1033 accIt.remove();
1034 }
1035 }
Costin Manolache360e4542009-09-04 13:36:04 -07001036
Dianne Hackborn231cc602009-04-27 17:10:36 -07001037 // Clean out all data structures.
1038 int i = removing.size();
1039 if (i > 0) {
1040 while (i > 0) {
1041 i--;
1042 int ident = removing.keyAt(i);
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001043 AuthorityInfo auth = removing.valueAt(i);
1044 if (mAuthorityRemovedListener != null) {
1045 mAuthorityRemovedListener.onAuthorityRemoved(auth.target);
1046 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001047 mAuthorities.remove(ident);
1048 int j = mSyncStatus.size();
1049 while (j > 0) {
1050 j--;
1051 if (mSyncStatus.keyAt(j) == ident) {
1052 mSyncStatus.remove(mSyncStatus.keyAt(j));
1053 }
1054 }
1055 j = mSyncHistory.size();
1056 while (j > 0) {
1057 j--;
1058 if (mSyncHistory.get(j).authorityId == ident) {
1059 mSyncHistory.remove(j);
1060 }
1061 }
1062 }
1063 writeAccountInfoLocked();
1064 writeStatusLocked();
Dianne Hackborn231cc602009-04-27 17:10:36 -07001065 writeStatisticsLocked();
1066 }
1067 }
1068 }
1069
1070 /**
Fred Quintana918339a2010-10-05 14:00:39 -07001071 * Called when a sync is starting. Supply a valid ActiveSyncContext with information
1072 * about the sync.
Dianne Hackborn231cc602009-04-27 17:10:36 -07001073 */
Fred Quintana918339a2010-10-05 14:00:39 -07001074 public SyncInfo addActiveSync(SyncManager.ActiveSyncContext activeSyncContext) {
1075 final SyncInfo syncInfo;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001076 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001077 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001078 Slog.v(TAG, "setActiveSync: account="
1079 + " auth=" + activeSyncContext.mSyncOperation.target
1080 + " src=" + activeSyncContext.mSyncOperation.syncSource
1081 + " extras=" + activeSyncContext.mSyncOperation.extras);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001082 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001083 final EndPoint info = activeSyncContext.mSyncOperation.target;
1084 AuthorityInfo authorityInfo = getOrCreateAuthorityLocked(
1085 info,
Matthew Williams8ef22042013-07-26 12:56:39 -07001086 -1 /* assign a new identifier if creating a new target */,
Fred Quintana918339a2010-10-05 14:00:39 -07001087 true /* write to storage if this results in a change */);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001088 syncInfo = new SyncInfo(
1089 authorityInfo.ident,
Matthew Williams8ef22042013-07-26 12:56:39 -07001090 authorityInfo.target.account,
1091 authorityInfo.target.provider,
Fred Quintana918339a2010-10-05 14:00:39 -07001092 activeSyncContext.mStartTime);
Matthew Williams8ef22042013-07-26 12:56:39 -07001093 getCurrentSyncs(authorityInfo.target.userId).add(syncInfo);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001094 }
Fred Quintana918339a2010-10-05 14:00:39 -07001095 reportActiveChange();
1096 return syncInfo;
1097 }
1098
1099 /**
1100 * Called to indicate that a previously active sync is no longer active.
1101 */
Amith Yamasani04e0d262012-02-14 11:50:53 -08001102 public void removeActiveSync(SyncInfo syncInfo, int userId) {
Fred Quintana918339a2010-10-05 14:00:39 -07001103 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001104 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001105 Slog.v(TAG, "removeActiveSync: account=" + syncInfo.account
Amith Yamasani04e0d262012-02-14 11:50:53 -08001106 + " user=" + userId
Matthew Williams5a9decd2014-06-04 09:25:11 -07001107 + " auth=" + syncInfo.authority);
Fred Quintana918339a2010-10-05 14:00:39 -07001108 }
Amith Yamasani04e0d262012-02-14 11:50:53 -08001109 getCurrentSyncs(userId).remove(syncInfo);
Fred Quintana918339a2010-10-05 14:00:39 -07001110 }
1111
1112 reportActiveChange();
Dianne Hackborn231cc602009-04-27 17:10:36 -07001113 }
1114
1115 /**
1116 * To allow others to send active change reports, to poke clients.
1117 */
1118 public void reportActiveChange() {
Fred Quintanaac9385e2009-06-22 18:00:59 -07001119 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_ACTIVE);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001120 }
Costin Manolache360e4542009-09-04 13:36:04 -07001121
Dianne Hackborn231cc602009-04-27 17:10:36 -07001122 /**
Matthew Williams8ef22042013-07-26 12:56:39 -07001123 * Note that sync has started for the given operation.
Dianne Hackborn231cc602009-04-27 17:10:36 -07001124 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001125 public long insertStartSyncEvent(SyncOperation op, long now) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001126 long id;
1127 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001128 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001129 Slog.v(TAG, "insertStartSyncEvent: " + op);
Fred Quintana77c560f2010-03-29 22:20:26 -07001130 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001131 AuthorityInfo authority = getAuthorityLocked(op.target, "insertStartSyncEvent");
Dianne Hackborn231cc602009-04-27 17:10:36 -07001132 if (authority == null) {
1133 return -1;
1134 }
1135 SyncHistoryItem item = new SyncHistoryItem();
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001136 item.initialization = op.isInitialization();
Dianne Hackborn231cc602009-04-27 17:10:36 -07001137 item.authorityId = authority.ident;
1138 item.historyId = mNextHistoryId++;
1139 if (mNextHistoryId < 0) mNextHistoryId = 0;
1140 item.eventTime = now;
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001141 item.source = op.syncSource;
1142 item.reason = op.reason;
1143 item.extras = op.extras;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001144 item.event = EVENT_START;
Makoto Onukid5f25d22018-05-22 16:02:17 -07001145 item.syncExemptionFlag = op.syncExemptionFlag;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001146 mSyncHistory.add(0, item);
1147 while (mSyncHistory.size() > MAX_HISTORY) {
1148 mSyncHistory.remove(mSyncHistory.size()-1);
1149 }
1150 id = item.historyId;
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001151 if (Log.isLoggable(TAG, Log.VERBOSE)) Slog.v(TAG, "returning historyId " + id);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001152 }
Costin Manolache360e4542009-09-04 13:36:04 -07001153
Fred Quintanaac9385e2009-06-22 18:00:59 -07001154 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_STATUS);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001155 return id;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001156 }
1157
Fred Quintana77c560f2010-03-29 22:20:26 -07001158 public void stopSyncEvent(long historyId, long elapsedTime, String resultMessage,
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001159 long downstreamActivity, long upstreamActivity) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001160 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001161 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001162 Slog.v(TAG, "stopSyncEvent: historyId=" + historyId);
Fred Quintana77c560f2010-03-29 22:20:26 -07001163 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001164 SyncHistoryItem item = null;
1165 int i = mSyncHistory.size();
1166 while (i > 0) {
1167 i--;
1168 item = mSyncHistory.get(i);
1169 if (item.historyId == historyId) {
1170 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001171 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001172 item = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001173 }
Costin Manolache360e4542009-09-04 13:36:04 -07001174
Dianne Hackborn231cc602009-04-27 17:10:36 -07001175 if (item == null) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001176 Slog.w(TAG, "stopSyncEvent: no history for id " + historyId);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001177 return;
1178 }
Costin Manolache360e4542009-09-04 13:36:04 -07001179
Dianne Hackborn231cc602009-04-27 17:10:36 -07001180 item.elapsedTime = elapsedTime;
1181 item.event = EVENT_STOP;
1182 item.mesg = resultMessage;
1183 item.downstreamActivity = downstreamActivity;
1184 item.upstreamActivity = upstreamActivity;
Costin Manolache360e4542009-09-04 13:36:04 -07001185
Dianne Hackborn231cc602009-04-27 17:10:36 -07001186 SyncStatusInfo status = getOrCreateSyncStatusLocked(item.authorityId);
Costin Manolache360e4542009-09-04 13:36:04 -07001187
Makoto Onuki94986212018-04-11 16:24:46 -07001188 status.maybeResetTodayStats(isClockValid(), /*force=*/ false);
1189
1190 status.totalStats.numSyncs++;
1191 status.todayStats.numSyncs++;
1192 status.totalStats.totalElapsedTime += elapsedTime;
1193 status.todayStats.totalElapsedTime += elapsedTime;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001194 switch (item.source) {
1195 case SOURCE_LOCAL:
Makoto Onuki94986212018-04-11 16:24:46 -07001196 status.totalStats.numSourceLocal++;
1197 status.todayStats.numSourceLocal++;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001198 break;
1199 case SOURCE_POLL:
Makoto Onuki94986212018-04-11 16:24:46 -07001200 status.totalStats.numSourcePoll++;
1201 status.todayStats.numSourcePoll++;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001202 break;
1203 case SOURCE_USER:
Makoto Onuki94986212018-04-11 16:24:46 -07001204 status.totalStats.numSourceUser++;
1205 status.todayStats.numSourceUser++;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001206 break;
Makoto Onuki94986212018-04-11 16:24:46 -07001207 case SOURCE_OTHER:
1208 status.totalStats.numSourceOther++;
1209 status.todayStats.numSourceOther++;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001210 break;
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001211 case SOURCE_PERIODIC:
Makoto Onuki94986212018-04-11 16:24:46 -07001212 status.totalStats.numSourcePeriodic++;
1213 status.todayStats.numSourcePeriodic++;
1214 break;
1215 case SOURCE_FEED:
1216 status.totalStats.numSourceFeed++;
1217 status.todayStats.numSourceFeed++;
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001218 break;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001219 }
Costin Manolache360e4542009-09-04 13:36:04 -07001220
Dianne Hackborn231cc602009-04-27 17:10:36 -07001221 boolean writeStatisticsNow = false;
Dianne Hackborn55280a92009-05-07 15:53:46 -07001222 int day = getCurrentDayLocked();
Dianne Hackborn231cc602009-04-27 17:10:36 -07001223 if (mDayStats[0] == null) {
1224 mDayStats[0] = new DayStats(day);
1225 } else if (day != mDayStats[0].day) {
1226 System.arraycopy(mDayStats, 0, mDayStats, 1, mDayStats.length-1);
1227 mDayStats[0] = new DayStats(day);
1228 writeStatisticsNow = true;
1229 } else if (mDayStats[0] == null) {
1230 }
1231 final DayStats ds = mDayStats[0];
Costin Manolache360e4542009-09-04 13:36:04 -07001232
Dianne Hackborn231cc602009-04-27 17:10:36 -07001233 final long lastSyncTime = (item.eventTime + elapsedTime);
1234 boolean writeStatusNow = false;
1235 if (MESG_SUCCESS.equals(resultMessage)) {
1236 // - if successful, update the successful columns
1237 if (status.lastSuccessTime == 0 || status.lastFailureTime != 0) {
1238 writeStatusNow = true;
1239 }
Makoto Onukif74cf942018-04-16 17:04:58 -07001240 status.setLastSuccess(item.source, lastSyncTime);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001241 ds.successCount++;
1242 ds.successTime += elapsedTime;
1243 } else if (!MESG_CANCELED.equals(resultMessage)) {
1244 if (status.lastFailureTime == 0) {
1245 writeStatusNow = true;
1246 }
Makoto Onuki94986212018-04-11 16:24:46 -07001247 status.totalStats.numFailures++;
1248 status.todayStats.numFailures++;
1249
Makoto Onukif74cf942018-04-16 17:04:58 -07001250 status.setLastFailure(item.source, lastSyncTime, resultMessage);
1251
Dianne Hackborn231cc602009-04-27 17:10:36 -07001252 ds.failureCount++;
1253 ds.failureTime += elapsedTime;
Makoto Onuki94986212018-04-11 16:24:46 -07001254 } else {
1255 // Cancel
1256 status.totalStats.numCancels++;
1257 status.todayStats.numCancels++;
1258 writeStatusNow = true;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001259 }
Makoto Onuki15e7a252017-06-08 17:12:05 -07001260 final StringBuilder event = new StringBuilder();
1261 event.append("" + resultMessage + " Source=" + SyncStorageEngine.SOURCES[item.source]
1262 + " Elapsed=");
1263 SyncManager.formatDurationHMS(event, elapsedTime);
1264 event.append(" Reason=");
1265 event.append(SyncOperation.reasonToString(null, item.reason));
Makoto Onukid5f25d22018-05-22 16:02:17 -07001266 if (item.syncExemptionFlag != ContentResolver.SYNC_EXEMPTION_NONE) {
1267 event.append(" Exemption=");
1268 switch (item.syncExemptionFlag) {
1269 case ContentResolver.SYNC_EXEMPTION_PROMOTE_BUCKET:
1270 event.append("fg");
1271 break;
1272 case ContentResolver.SYNC_EXEMPTION_PROMOTE_BUCKET_WITH_TEMP:
1273 event.append("top");
1274 break;
1275 default:
1276 event.append(item.syncExemptionFlag);
1277 break;
1278 }
1279 }
Makoto Onuki15e7a252017-06-08 17:12:05 -07001280 event.append(" Extras=");
1281 SyncOperation.extrasToStringBuilder(item.extras, event);
1282
1283 status.addEvent(event.toString());
Costin Manolache360e4542009-09-04 13:36:04 -07001284
Dianne Hackborn231cc602009-04-27 17:10:36 -07001285 if (writeStatusNow) {
1286 writeStatusLocked();
Makoto Onuki6963bea72017-12-12 10:42:39 -08001287 } else if (!mHandler.hasMessages(MSG_WRITE_STATUS)) {
1288 mHandler.sendMessageDelayed(mHandler.obtainMessage(MSG_WRITE_STATUS),
Dianne Hackborn231cc602009-04-27 17:10:36 -07001289 WRITE_STATUS_DELAY);
1290 }
1291 if (writeStatisticsNow) {
1292 writeStatisticsLocked();
Makoto Onuki6963bea72017-12-12 10:42:39 -08001293 } else if (!mHandler.hasMessages(MSG_WRITE_STATISTICS)) {
1294 mHandler.sendMessageDelayed(mHandler.obtainMessage(MSG_WRITE_STATISTICS),
Dianne Hackborn231cc602009-04-27 17:10:36 -07001295 WRITE_STATISTICS_DELAY);
Costin Manolache360e4542009-09-04 13:36:04 -07001296 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001297 }
Costin Manolache360e4542009-09-04 13:36:04 -07001298
Fred Quintanaac9385e2009-06-22 18:00:59 -07001299 reportChange(ContentResolver.SYNC_OBSERVER_TYPE_STATUS);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001300 }
1301
1302 /**
Matthew Williamsa7456e42013-11-12 14:41:02 -08001303 * Return a list of the currently active syncs. Note that the returned
1304 * items are the real, live active sync objects, so be careful what you do
1305 * with it.
Fred Quintana918339a2010-10-05 14:00:39 -07001306 */
Matthew Williamsa7456e42013-11-12 14:41:02 -08001307 private List<SyncInfo> getCurrentSyncs(int userId) {
Fred Quintana918339a2010-10-05 14:00:39 -07001308 synchronized (mAuthorities) {
Matthew Williamsa7456e42013-11-12 14:41:02 -08001309 return getCurrentSyncsLocked(userId);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001310 }
1311 }
Costin Manolache360e4542009-09-04 13:36:04 -07001312
Dianne Hackborn231cc602009-04-27 17:10:36 -07001313 /**
Matthew Williamsf39549e2016-01-19 23:04:04 +00001314 * @param userId Id of user to return current sync info.
1315 * @param canAccessAccounts Determines whether to redact Account information from the result.
1316 * @return a copy of the current syncs data structure. Will not return null.
Matthew Williamsa7456e42013-11-12 14:41:02 -08001317 */
Matthew Williamsf39549e2016-01-19 23:04:04 +00001318 public List<SyncInfo> getCurrentSyncsCopy(int userId, boolean canAccessAccounts) {
Matthew Williamsa7456e42013-11-12 14:41:02 -08001319 synchronized (mAuthorities) {
1320 final List<SyncInfo> syncs = getCurrentSyncsLocked(userId);
1321 final List<SyncInfo> syncsCopy = new ArrayList<SyncInfo>();
1322 for (SyncInfo sync : syncs) {
Matthew Williamsf39549e2016-01-19 23:04:04 +00001323 SyncInfo copy;
1324 if (!canAccessAccounts) {
1325 copy = SyncInfo.createAccountRedacted(
1326 sync.authorityId, sync.authority, sync.startTime);
1327 } else {
1328 copy = new SyncInfo(sync);
1329 }
1330 syncsCopy.add(copy);
Matthew Williamsa7456e42013-11-12 14:41:02 -08001331 }
1332 return syncsCopy;
1333 }
1334 }
1335
1336 private List<SyncInfo> getCurrentSyncsLocked(int userId) {
1337 ArrayList<SyncInfo> syncs = mCurrentSyncs.get(userId);
1338 if (syncs == null) {
1339 syncs = new ArrayList<SyncInfo>();
1340 mCurrentSyncs.put(userId, syncs);
1341 }
1342 return syncs;
1343 }
1344
1345 /**
Matthew Williams8ef22042013-07-26 12:56:39 -07001346 * Return a copy of the specified target with the corresponding sync status
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001347 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001348 public Pair<AuthorityInfo, SyncStatusInfo> getCopyOfAuthorityWithSyncStatus(EndPoint info) {
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001349 synchronized (mAuthorities) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001350 AuthorityInfo authorityInfo = getOrCreateAuthorityLocked(info,
Matthew Williams8ef22042013-07-26 12:56:39 -07001351 -1 /* assign a new identifier if creating a new target */,
Georgi Nikolovdbe846b2013-06-25 14:09:56 -07001352 true /* write to storage if this results in a change */);
1353 return createCopyPairOfAuthorityWithSyncStatusLocked(authorityInfo);
1354 }
1355 }
1356
1357 /**
Matthew Williams8ef22042013-07-26 12:56:39 -07001358 * Returns the status that matches the target.
Costin Manolacheb7520982009-09-02 18:03:05 -07001359 *
Matthew Williams8ef22042013-07-26 12:56:39 -07001360 * @param info the endpoint target we are querying status info for.
1361 * @return the SyncStatusInfo for the endpoint.
Dianne Hackborn231cc602009-04-27 17:10:36 -07001362 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001363 public SyncStatusInfo getStatusByAuthority(EndPoint info) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001364 if (info.account == null || info.provider == null) {
Matthew Williamsd08d6682013-10-14 10:39:41 -07001365 return null;
Costin Manolacheb7520982009-09-02 18:03:05 -07001366 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001367 synchronized (mAuthorities) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001368 final int N = mSyncStatus.size();
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001369 for (int i = 0; i < N; i++) {
Costin Manolache360e4542009-09-04 13:36:04 -07001370 SyncStatusInfo cur = mSyncStatus.valueAt(i);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001371 AuthorityInfo ainfo = mAuthorities.get(cur.authorityId);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001372 if (ainfo != null
Matthew Williams8ef22042013-07-26 12:56:39 -07001373 && ainfo.target.matchesSpec(info)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001374 return cur;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001375 }
1376 }
Costin Manolacheb7520982009-09-02 18:03:05 -07001377 return null;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001378 }
1379 }
Costin Manolache360e4542009-09-04 13:36:04 -07001380
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001381 /** Return true if the pending status is true of any matching authorities. */
1382 public boolean isSyncPending(EndPoint info) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001383 synchronized (mAuthorities) {
1384 final int N = mSyncStatus.size();
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001385 for (int i = 0; i < N; i++) {
Costin Manolache360e4542009-09-04 13:36:04 -07001386 SyncStatusInfo cur = mSyncStatus.valueAt(i);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001387 AuthorityInfo ainfo = mAuthorities.get(cur.authorityId);
1388 if (ainfo == null) {
1389 continue;
1390 }
Matthew Williams8ef22042013-07-26 12:56:39 -07001391 if (!ainfo.target.matchesSpec(info)) {
Amith Yamasani04e0d262012-02-14 11:50:53 -08001392 continue;
1393 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001394 if (cur.pending) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001395 return true;
1396 }
1397 }
1398 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001399 }
1400 }
1401
1402 /**
Dianne Hackborn231cc602009-04-27 17:10:36 -07001403 * Return an array of the current sync status for all authorities. Note
1404 * that the objects inside the array are the real, live status objects,
1405 * so be careful what you do with them.
1406 */
1407 public ArrayList<SyncHistoryItem> getSyncHistory() {
1408 synchronized (mAuthorities) {
1409 final int N = mSyncHistory.size();
1410 ArrayList<SyncHistoryItem> items = new ArrayList<SyncHistoryItem>(N);
1411 for (int i=0; i<N; i++) {
1412 items.add(mSyncHistory.get(i));
1413 }
1414 return items;
1415 }
1416 }
Costin Manolache360e4542009-09-04 13:36:04 -07001417
Dianne Hackborn231cc602009-04-27 17:10:36 -07001418 /**
1419 * Return an array of the current per-day statistics. Note
1420 * that the objects inside the array are the real, live status objects,
1421 * so be careful what you do with them.
1422 */
1423 public DayStats[] getDayStatistics() {
1424 synchronized (mAuthorities) {
1425 DayStats[] ds = new DayStats[mDayStats.length];
1426 System.arraycopy(mDayStats, 0, ds, 0, ds.length);
1427 return ds;
1428 }
1429 }
Costin Manolache360e4542009-09-04 13:36:04 -07001430
Georgi Nikolovdbe846b2013-06-25 14:09:56 -07001431 private Pair<AuthorityInfo, SyncStatusInfo> createCopyPairOfAuthorityWithSyncStatusLocked(
1432 AuthorityInfo authorityInfo) {
1433 SyncStatusInfo syncStatusInfo = getOrCreateSyncStatusLocked(authorityInfo.ident);
1434 return Pair.create(new AuthorityInfo(authorityInfo), new SyncStatusInfo(syncStatusInfo));
1435 }
1436
Dianne Hackborn55280a92009-05-07 15:53:46 -07001437 private int getCurrentDayLocked() {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001438 mCal.setTimeInMillis(System.currentTimeMillis());
1439 final int dayOfYear = mCal.get(Calendar.DAY_OF_YEAR);
1440 if (mYear != mCal.get(Calendar.YEAR)) {
1441 mYear = mCal.get(Calendar.YEAR);
1442 mCal.clear();
1443 mCal.set(Calendar.YEAR, mYear);
1444 mYearInDays = (int)(mCal.getTimeInMillis()/86400000);
1445 }
1446 return dayOfYear + mYearInDays;
1447 }
Costin Manolache360e4542009-09-04 13:36:04 -07001448
Dianne Hackborn231cc602009-04-27 17:10:36 -07001449 /**
Matthew Williams8ef22042013-07-26 12:56:39 -07001450 * Retrieve a target's full info, returning null if one does not exist.
Costin Manolache360e4542009-09-04 13:36:04 -07001451 *
Matthew Williams8ef22042013-07-26 12:56:39 -07001452 * @param info info of the target to look up.
Dianne Hackborn231cc602009-04-27 17:10:36 -07001453 * @param tag If non-null, this will be used in a log message if the
Matthew Williams8ef22042013-07-26 12:56:39 -07001454 * requested target does not exist.
Dianne Hackborn231cc602009-04-27 17:10:36 -07001455 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001456 private AuthorityInfo getAuthorityLocked(EndPoint info, String tag) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001457 AccountAndUser au = new AccountAndUser(info.account, info.userId);
1458 AccountInfo accountInfo = mAccounts.get(au);
1459 if (accountInfo == null) {
1460 if (tag != null) {
1461 if (Log.isLoggable(TAG, Log.VERBOSE)) {
1462 Slog.v(TAG, tag + ": unknown account " + au);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001463 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001464 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001465 return null;
1466 }
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001467 AuthorityInfo authority = accountInfo.authorities.get(info.provider);
1468 if (authority == null) {
1469 if (tag != null) {
1470 if (Log.isLoggable(TAG, Log.VERBOSE)) {
1471 Slog.v(TAG, tag + ": unknown provider " + info.provider);
1472 }
1473 }
1474 return null;
1475 }
1476 return authority;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001477 }
Costin Manolache360e4542009-09-04 13:36:04 -07001478
Matthew Williamsfa774182013-06-18 15:44:11 -07001479 /**
Matthew Williams8ef22042013-07-26 12:56:39 -07001480 * @param info info identifying target.
1481 * @param ident unique identifier for target. -1 for none.
Matthew Williamsfa774182013-06-18 15:44:11 -07001482 * @param doWrite if true, update the accounts.xml file on the disk.
Matthew Williams8ef22042013-07-26 12:56:39 -07001483 * @return the authority that corresponds to the provided sync target, creating it if none
Matthew Williamsfa774182013-06-18 15:44:11 -07001484 * exists.
1485 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001486 private AuthorityInfo getOrCreateAuthorityLocked(EndPoint info, int ident, boolean doWrite) {
1487 AuthorityInfo authority = null;
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001488 AccountAndUser au = new AccountAndUser(info.account, info.userId);
1489 AccountInfo account = mAccounts.get(au);
1490 if (account == null) {
1491 account = new AccountInfo(au);
1492 mAccounts.put(au, account);
1493 }
1494 authority = account.authorities.get(info.provider);
1495 if (authority == null) {
1496 authority = createAuthorityLocked(info, ident, doWrite);
1497 account.authorities.put(info.provider, authority);
Matthew Williamsfa774182013-06-18 15:44:11 -07001498 }
1499 return authority;
1500 }
1501
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001502 private AuthorityInfo createAuthorityLocked(EndPoint info, int ident, boolean doWrite) {
1503 AuthorityInfo authority;
1504 if (ident < 0) {
1505 ident = mNextAuthorityId;
1506 mNextAuthorityId++;
1507 doWrite = true;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001508 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001509 if (Log.isLoggable(TAG, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001510 Slog.v(TAG, "created a new AuthorityInfo for " + info);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001511 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001512 authority = new AuthorityInfo(info, ident);
1513 mAuthorities.put(ident, authority);
1514 if (doWrite) {
1515 writeAccountInfoLocked();
1516 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001517 return authority;
1518 }
Costin Manolache360e4542009-09-04 13:36:04 -07001519
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001520 public void removeAuthority(EndPoint info) {
1521 synchronized (mAuthorities) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001522 removeAuthorityLocked(info.account, info.userId, info.provider, true /* doWrite */);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001523 }
1524 }
1525
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001526
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001527 /**
1528 * Remove an authority associated with a provider. Needs to be a standalone function for
1529 * backward compatibility.
1530 */
Amith Yamasani04e0d262012-02-14 11:50:53 -08001531 private void removeAuthorityLocked(Account account, int userId, String authorityName,
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001532 boolean doWrite) {
Amith Yamasani04e0d262012-02-14 11:50:53 -08001533 AccountInfo accountInfo = mAccounts.get(new AccountAndUser(account, userId));
Fred Quintana7620f1a2010-03-16 15:58:44 -07001534 if (accountInfo != null) {
Fred Quintanafb084402010-03-23 17:57:03 -07001535 final AuthorityInfo authorityInfo = accountInfo.authorities.remove(authorityName);
1536 if (authorityInfo != null) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001537 if (mAuthorityRemovedListener != null) {
1538 mAuthorityRemovedListener.onAuthorityRemoved(authorityInfo.target);
1539 }
Fred Quintanafb084402010-03-23 17:57:03 -07001540 mAuthorities.remove(authorityInfo.ident);
Fred Quintana77c560f2010-03-29 22:20:26 -07001541 if (doWrite) {
1542 writeAccountInfoLocked();
1543 }
Fred Quintana7620f1a2010-03-16 15:58:44 -07001544 }
1545 }
1546 }
1547
Dianne Hackborn231cc602009-04-27 17:10:36 -07001548 private SyncStatusInfo getOrCreateSyncStatusLocked(int authorityId) {
1549 SyncStatusInfo status = mSyncStatus.get(authorityId);
1550 if (status == null) {
1551 status = new SyncStatusInfo(authorityId);
1552 mSyncStatus.put(authorityId, status);
1553 }
1554 return status;
1555 }
Costin Manolache360e4542009-09-04 13:36:04 -07001556
Dianne Hackborn55280a92009-05-07 15:53:46 -07001557 public void writeAllState() {
1558 synchronized (mAuthorities) {
1559 // Account info is always written so no need to do it here.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001560 writeStatusLocked();
1561 writeStatisticsLocked();
1562 }
1563 }
Costin Manolache360e4542009-09-04 13:36:04 -07001564
Svet Ganov65712b02016-09-01 10:24:11 -07001565 public boolean shouldGrantSyncAdaptersAccountAccess() {
1566 return mGrantSyncAdaptersAccountAccess;
1567 }
1568
Dianne Hackborn231cc602009-04-27 17:10:36 -07001569 /**
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001570 * public for testing
1571 */
1572 public void clearAndReadState() {
1573 synchronized (mAuthorities) {
1574 mAuthorities.clear();
1575 mAccounts.clear();
Matthew Williamsfa774182013-06-18 15:44:11 -07001576 mServices.clear();
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001577 mSyncStatus.clear();
1578 mSyncHistory.clear();
1579
1580 readAccountInfoLocked();
1581 readStatusLocked();
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001582 readStatisticsLocked();
Fred Quintana77c560f2010-03-29 22:20:26 -07001583 writeAccountInfoLocked();
1584 writeStatusLocked();
Fred Quintana77c560f2010-03-29 22:20:26 -07001585 writeStatisticsLocked();
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001586 }
1587 }
1588
1589 /**
Dianne Hackborn231cc602009-04-27 17:10:36 -07001590 * Read all account information back in to the initial engine state.
1591 */
1592 private void readAccountInfoLocked() {
Fred Quintana77c560f2010-03-29 22:20:26 -07001593 int highestAuthorityId = -1;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001594 FileInputStream fis = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001595 try {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001596 fis = mAccountInfoFile.openRead();
Matthew Williamsba352712013-08-13 15:53:31 -07001597 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001598 Slog.v(TAG_FILE, "Reading " + mAccountInfoFile.getBaseFile());
Matthew Williamsba352712013-08-13 15:53:31 -07001599 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001600 XmlPullParser parser = Xml.newPullParser();
Wojciech Staszkiewicz9e9e2e72015-05-08 14:58:46 +01001601 parser.setInput(fis, StandardCharsets.UTF_8.name());
Dianne Hackborn231cc602009-04-27 17:10:36 -07001602 int eventType = parser.getEventType();
Narayan Kamath2ac3cb72014-01-06 11:31:35 +00001603 while (eventType != XmlPullParser.START_TAG &&
1604 eventType != XmlPullParser.END_DOCUMENT) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001605 eventType = parser.next();
1606 }
Narayan Kamath2ac3cb72014-01-06 11:31:35 +00001607 if (eventType == XmlPullParser.END_DOCUMENT) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001608 Slog.i(TAG, "No initial accounts");
Narayan Kamath2ac3cb72014-01-06 11:31:35 +00001609 return;
1610 }
1611
Dianne Hackborn231cc602009-04-27 17:10:36 -07001612 String tagName = parser.getName();
1613 if ("accounts".equals(tagName)) {
Amith Yamasani04e0d262012-02-14 11:50:53 -08001614 String listen = parser.getAttributeValue(null, XML_ATTR_LISTEN_FOR_TICKLES);
Fred Quintanac2e46912010-03-15 16:10:44 -07001615 String versionString = parser.getAttributeValue(null, "version");
1616 int version;
1617 try {
1618 version = (versionString == null) ? 0 : Integer.parseInt(versionString);
1619 } catch (NumberFormatException e) {
1620 version = 0;
1621 }
Svet Ganov65712b02016-09-01 10:24:11 -07001622
1623 if (version < 3) {
1624 mGrantSyncAdaptersAccountAccess = true;
1625 }
1626
Amith Yamasani04e0d262012-02-14 11:50:53 -08001627 String nextIdString = parser.getAttributeValue(null, XML_ATTR_NEXT_AUTHORITY_ID);
Fred Quintana77c560f2010-03-29 22:20:26 -07001628 try {
1629 int id = (nextIdString == null) ? 0 : Integer.parseInt(nextIdString);
1630 mNextAuthorityId = Math.max(mNextAuthorityId, id);
1631 } catch (NumberFormatException e) {
1632 // don't care
Fred Quintanac2e46912010-03-15 16:10:44 -07001633 }
Ashish Sharma69d95de2012-04-11 17:27:24 -07001634 String offsetString = parser.getAttributeValue(null, XML_ATTR_SYNC_RANDOM_OFFSET);
1635 try {
1636 mSyncRandomOffset = (offsetString == null) ? 0 : Integer.parseInt(offsetString);
1637 } catch (NumberFormatException e) {
1638 mSyncRandomOffset = 0;
1639 }
1640 if (mSyncRandomOffset == 0) {
1641 Random random = new Random(System.currentTimeMillis());
1642 mSyncRandomOffset = random.nextInt(86400);
1643 }
Amith Yamasani04e0d262012-02-14 11:50:53 -08001644 mMasterSyncAutomatically.put(0, listen == null || Boolean.parseBoolean(listen));
Dianne Hackborn231cc602009-04-27 17:10:36 -07001645 eventType = parser.next();
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001646 AuthorityInfo authority = null;
Matthew Williamsfa774182013-06-18 15:44:11 -07001647 PeriodicSync periodicSync = null;
Suprabh Shukla042a4782017-05-12 15:26:54 -07001648 AccountAuthorityValidator validator = new AccountAuthorityValidator(mContext);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001649 do {
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001650 if (eventType == XmlPullParser.START_TAG) {
Dianne Hackborn231cc602009-04-27 17:10:36 -07001651 tagName = parser.getName();
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001652 if (parser.getDepth() == 2) {
1653 if ("authority".equals(tagName)) {
Suprabh Shukla042a4782017-05-12 15:26:54 -07001654 authority = parseAuthority(parser, version, validator);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001655 periodicSync = null;
Shreyas Basarge11cb4e22016-01-13 14:27:16 +00001656 if (authority != null) {
1657 if (authority.ident > highestAuthorityId) {
1658 highestAuthorityId = authority.ident;
1659 }
Shreyas Basargebae9ded2016-02-17 13:54:44 +00001660 } else {
1661 EventLog.writeEvent(0x534e4554, "26513719", -1,
1662 "Malformed authority");
Fred Quintana77c560f2010-03-29 22:20:26 -07001663 }
Amith Yamasani04e0d262012-02-14 11:50:53 -08001664 } else if (XML_TAG_LISTEN_FOR_TICKLES.equals(tagName)) {
1665 parseListenForTickles(parser);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001666 }
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001667 } else if (parser.getDepth() == 3) {
1668 if ("periodicSync".equals(tagName) && authority != null) {
1669 periodicSync = parsePeriodicSync(parser, authority);
1670 }
1671 } else if (parser.getDepth() == 4 && periodicSync != null) {
1672 if ("extra".equals(tagName)) {
Matthew Williamsfa774182013-06-18 15:44:11 -07001673 parseExtra(parser, periodicSync.extras);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001674 }
1675 }
1676 }
1677 eventType = parser.next();
1678 } while (eventType != XmlPullParser.END_DOCUMENT);
1679 }
1680 } catch (XmlPullParserException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001681 Slog.w(TAG, "Error reading accounts", e);
Fred Quintanac2e46912010-03-15 16:10:44 -07001682 return;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001683 } catch (java.io.IOException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001684 if (fis == null) Slog.i(TAG, "No initial accounts");
1685 else Slog.w(TAG, "Error reading accounts", e);
Fred Quintanac2e46912010-03-15 16:10:44 -07001686 return;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001687 } finally {
Fred Quintana77c560f2010-03-29 22:20:26 -07001688 mNextAuthorityId = Math.max(highestAuthorityId + 1, mNextAuthorityId);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001689 if (fis != null) {
1690 try {
1691 fis.close();
1692 } catch (java.io.IOException e1) {
1693 }
1694 }
1695 }
Fred Quintanac2e46912010-03-15 16:10:44 -07001696
Fred Quintana77c560f2010-03-29 22:20:26 -07001697 maybeMigrateSettingsForRenamedAuthorities();
Dianne Hackborn231cc602009-04-27 17:10:36 -07001698 }
Costin Manolache360e4542009-09-04 13:36:04 -07001699
Fred Quintanafb084402010-03-23 17:57:03 -07001700 /**
Matthew Williamsba352712013-08-13 15:53:31 -07001701 * Ensure the old pending.bin is deleted, as it has been changed to pending.xml.
1702 * pending.xml was used starting in KLP.
1703 * @param syncDir directory where the sync files are located.
1704 */
1705 private void maybeDeleteLegacyPendingInfoLocked(File syncDir) {
1706 File file = new File(syncDir, "pending.bin");
1707 if (!file.exists()) {
1708 return;
1709 } else {
1710 file.delete();
1711 }
1712 }
1713
1714 /**
Fred Quintanafb084402010-03-23 17:57:03 -07001715 * some authority names have changed. copy over their settings and delete the old ones
1716 * @return true if a change was made
1717 */
1718 private boolean maybeMigrateSettingsForRenamedAuthorities() {
1719 boolean writeNeeded = false;
1720
1721 ArrayList<AuthorityInfo> authoritiesToRemove = new ArrayList<AuthorityInfo>();
1722 final int N = mAuthorities.size();
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001723 for (int i = 0; i < N; i++) {
Fred Quintanafb084402010-03-23 17:57:03 -07001724 AuthorityInfo authority = mAuthorities.valueAt(i);
1725 // skip this authority if it isn't one of the renamed ones
Matthew Williams8ef22042013-07-26 12:56:39 -07001726 final String newAuthorityName = sAuthorityRenames.get(authority.target.provider);
Fred Quintanafb084402010-03-23 17:57:03 -07001727 if (newAuthorityName == null) {
1728 continue;
1729 }
1730
1731 // remember this authority so we can remove it later. we can't remove it
1732 // now without messing up this loop iteration
1733 authoritiesToRemove.add(authority);
1734
1735 // this authority isn't enabled, no need to copy it to the new authority name since
1736 // the default is "disabled"
1737 if (!authority.enabled) {
1738 continue;
1739 }
1740
1741 // if we already have a record of this new authority then don't copy over the settings
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001742 EndPoint newInfo =
Matthew Williams8ef22042013-07-26 12:56:39 -07001743 new EndPoint(authority.target.account,
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001744 newAuthorityName,
Matthew Williams8ef22042013-07-26 12:56:39 -07001745 authority.target.userId);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001746 if (getAuthorityLocked(newInfo, "cleanup") != null) {
Fred Quintanafb084402010-03-23 17:57:03 -07001747 continue;
1748 }
1749
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001750 AuthorityInfo newAuthority =
1751 getOrCreateAuthorityLocked(newInfo, -1 /* ident */, false /* doWrite */);
Fred Quintanafb084402010-03-23 17:57:03 -07001752 newAuthority.enabled = true;
1753 writeNeeded = true;
1754 }
1755
1756 for (AuthorityInfo authorityInfo : authoritiesToRemove) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001757 removeAuthorityLocked(
Matthew Williams8ef22042013-07-26 12:56:39 -07001758 authorityInfo.target.account,
1759 authorityInfo.target.userId,
1760 authorityInfo.target.provider,
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001761 false /* doWrite */);
Fred Quintanafb084402010-03-23 17:57:03 -07001762 writeNeeded = true;
1763 }
1764
1765 return writeNeeded;
1766 }
1767
Amith Yamasani04e0d262012-02-14 11:50:53 -08001768 private void parseListenForTickles(XmlPullParser parser) {
1769 String user = parser.getAttributeValue(null, XML_ATTR_USER);
1770 int userId = 0;
1771 try {
1772 userId = Integer.parseInt(user);
1773 } catch (NumberFormatException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001774 Slog.e(TAG, "error parsing the user for listen-for-tickles", e);
Amith Yamasani04e0d262012-02-14 11:50:53 -08001775 } catch (NullPointerException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001776 Slog.e(TAG, "the user in listen-for-tickles is null", e);
Amith Yamasani04e0d262012-02-14 11:50:53 -08001777 }
1778 String enabled = parser.getAttributeValue(null, XML_ATTR_ENABLED);
1779 boolean listen = enabled == null || Boolean.parseBoolean(enabled);
1780 mMasterSyncAutomatically.put(userId, listen);
1781 }
1782
Suprabh Shukla042a4782017-05-12 15:26:54 -07001783 private AuthorityInfo parseAuthority(XmlPullParser parser, int version,
1784 AccountAuthorityValidator validator) {
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001785 AuthorityInfo authority = null;
1786 int id = -1;
1787 try {
Matthew Williamsfa774182013-06-18 15:44:11 -07001788 id = Integer.parseInt(parser.getAttributeValue(null, "id"));
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001789 } catch (NumberFormatException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001790 Slog.e(TAG, "error parsing the id of the authority", e);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001791 } catch (NullPointerException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001792 Slog.e(TAG, "the id of the authority is null", e);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001793 }
1794 if (id >= 0) {
Fred Quintanafb084402010-03-23 17:57:03 -07001795 String authorityName = parser.getAttributeValue(null, "authority");
Amith Yamasani04e0d262012-02-14 11:50:53 -08001796 String enabled = parser.getAttributeValue(null, XML_ATTR_ENABLED);
Fred Quintanafb084402010-03-23 17:57:03 -07001797 String syncable = parser.getAttributeValue(null, "syncable");
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001798 String accountName = parser.getAttributeValue(null, "account");
1799 String accountType = parser.getAttributeValue(null, "type");
Amith Yamasani04e0d262012-02-14 11:50:53 -08001800 String user = parser.getAttributeValue(null, XML_ATTR_USER);
Matthew Williamsfa774182013-06-18 15:44:11 -07001801 String packageName = parser.getAttributeValue(null, "package");
1802 String className = parser.getAttributeValue(null, "class");
Amith Yamasani04e0d262012-02-14 11:50:53 -08001803 int userId = user == null ? 0 : Integer.parseInt(user);
Matthew Williams8ef22042013-07-26 12:56:39 -07001804 if (accountType == null && packageName == null) {
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001805 accountType = "com.google";
Matthew Williams53abfdb2015-06-10 20:06:37 -07001806 syncable = String.valueOf(AuthorityInfo.NOT_INITIALIZED);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001807 }
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001808 authority = mAuthorities.get(id);
Matthew Williamsba352712013-08-13 15:53:31 -07001809 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001810 Slog.v(TAG_FILE, "Adding authority:"
Matthew Williams8ef22042013-07-26 12:56:39 -07001811 + " account=" + accountName
1812 + " accountType=" + accountType
1813 + " auth=" + authorityName
1814 + " package=" + packageName
1815 + " class=" + className
Matthew Williamsba352712013-08-13 15:53:31 -07001816 + " user=" + userId
1817 + " enabled=" + enabled
1818 + " syncable=" + syncable);
1819 }
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001820 if (authority == null) {
Matthew Williamsba352712013-08-13 15:53:31 -07001821 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001822 Slog.v(TAG_FILE, "Creating authority entry");
Matthew Williamsfa774182013-06-18 15:44:11 -07001823 }
Matthew Williams8ef22042013-07-26 12:56:39 -07001824 if (accountName != null && authorityName != null) {
Suprabh Shukla042a4782017-05-12 15:26:54 -07001825 EndPoint info = new EndPoint(
Matthew Williams8ef22042013-07-26 12:56:39 -07001826 new Account(accountName, accountType),
1827 authorityName, userId);
Suprabh Shukla042a4782017-05-12 15:26:54 -07001828 if (validator.isAccountValid(info.account, userId)
1829 && validator.isAuthorityValid(authorityName, userId)) {
1830 authority = getOrCreateAuthorityLocked(info, id, false);
1831 // If the version is 0 then we are upgrading from a file format that did not
1832 // know about periodic syncs. In that case don't clear the list since we
1833 // want the default, which is a daily periodic sync.
1834 // Otherwise clear out this default list since we will populate it later
1835 // with
1836 // the periodic sync descriptions that are read from the configuration file.
1837 if (version > 0) {
1838 authority.periodicSyncs.clear();
1839 }
1840 } else {
1841 EventLog.writeEvent(0x534e4554, "35028827", -1,
1842 "account:" + info.account + " provider:" + authorityName + " user:"
1843 + userId);
Dianne Hackbornbef28fe2015-10-29 17:57:11 -07001844 }
Fred Quintanac2e46912010-03-15 16:10:44 -07001845 }
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001846 }
1847 if (authority != null) {
1848 authority.enabled = enabled == null || Boolean.parseBoolean(enabled);
Matthew Williams53abfdb2015-06-10 20:06:37 -07001849 try {
1850 authority.syncable = (syncable == null) ?
1851 AuthorityInfo.NOT_INITIALIZED : Integer.parseInt(syncable);
1852 } catch (NumberFormatException e) {
1853 // On L we stored this as {"unknown", "true", "false"} so fall back to this
1854 // format.
1855 if ("unknown".equals(syncable)) {
1856 authority.syncable = AuthorityInfo.NOT_INITIALIZED;
1857 } else {
1858 authority.syncable = Boolean.parseBoolean(syncable) ?
1859 AuthorityInfo.SYNCABLE : AuthorityInfo.NOT_SYNCABLE;
1860 }
1861
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001862 }
1863 } else {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001864 Slog.w(TAG, "Failure adding authority: account="
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001865 + accountName + " auth=" + authorityName
1866 + " enabled=" + enabled
1867 + " syncable=" + syncable);
1868 }
1869 }
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001870 return authority;
1871 }
1872
Matthew Williamsfa774182013-06-18 15:44:11 -07001873 /**
1874 * Parse a periodic sync from accounts.xml. Sets the bundle to be empty.
1875 */
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001876 private PeriodicSync parsePeriodicSync(XmlPullParser parser, AuthorityInfo authorityInfo) {
Matthew Williamsfa774182013-06-18 15:44:11 -07001877 Bundle extras = new Bundle(); // Gets filled in later.
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001878 String periodValue = parser.getAttributeValue(null, "period");
Matthew Williamsfa774182013-06-18 15:44:11 -07001879 String flexValue = parser.getAttributeValue(null, "flex");
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001880 final long period;
Matthew Williamsfa774182013-06-18 15:44:11 -07001881 long flextime;
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001882 try {
1883 period = Long.parseLong(periodValue);
1884 } catch (NumberFormatException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001885 Slog.e(TAG, "error parsing the period of a periodic sync", e);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001886 return null;
1887 } catch (NullPointerException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001888 Slog.e(TAG, "the period of a periodic sync is null", e);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001889 return null;
1890 }
Matthew Williamsfa774182013-06-18 15:44:11 -07001891 try {
1892 flextime = Long.parseLong(flexValue);
1893 } catch (NumberFormatException e) {
Matthew Williamsfa774182013-06-18 15:44:11 -07001894 flextime = calculateDefaultFlexTime(period);
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001895 Slog.e(TAG, "Error formatting value parsed for periodic sync flex: " + flexValue
Matthew Williams8ef22042013-07-26 12:56:39 -07001896 + ", using default: "
1897 + flextime);
Matthew Williamsfa774182013-06-18 15:44:11 -07001898 } catch (NullPointerException expected) {
1899 flextime = calculateDefaultFlexTime(period);
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001900 Slog.d(TAG, "No flex time specified for this sync, using a default. period: "
1901 + period + " flex: " + flextime);
Matthew Williamsfa774182013-06-18 15:44:11 -07001902 }
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001903 PeriodicSync periodicSync;
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001904 periodicSync =
Matthew Williams8ef22042013-07-26 12:56:39 -07001905 new PeriodicSync(authorityInfo.target.account,
1906 authorityInfo.target.provider,
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001907 extras,
Matthew Williamsfa774182013-06-18 15:44:11 -07001908 period, flextime);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001909 authorityInfo.periodicSyncs.add(periodicSync);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001910 return periodicSync;
1911 }
1912
Matthew Williamsfa774182013-06-18 15:44:11 -07001913 private void parseExtra(XmlPullParser parser, Bundle extras) {
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001914 String name = parser.getAttributeValue(null, "name");
1915 String type = parser.getAttributeValue(null, "type");
1916 String value1 = parser.getAttributeValue(null, "value1");
1917 String value2 = parser.getAttributeValue(null, "value2");
1918
1919 try {
1920 if ("long".equals(type)) {
1921 extras.putLong(name, Long.parseLong(value1));
1922 } else if ("integer".equals(type)) {
1923 extras.putInt(name, Integer.parseInt(value1));
1924 } else if ("double".equals(type)) {
1925 extras.putDouble(name, Double.parseDouble(value1));
1926 } else if ("float".equals(type)) {
1927 extras.putFloat(name, Float.parseFloat(value1));
1928 } else if ("boolean".equals(type)) {
1929 extras.putBoolean(name, Boolean.parseBoolean(value1));
1930 } else if ("string".equals(type)) {
1931 extras.putString(name, value1);
1932 } else if ("account".equals(type)) {
1933 extras.putParcelable(name, new Account(value1, value2));
1934 }
1935 } catch (NumberFormatException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001936 Slog.e(TAG, "error parsing bundle value", e);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001937 } catch (NullPointerException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001938 Slog.e(TAG, "error parsing bundle value", e);
Fred Quintanac5d1c6d2010-01-27 12:17:49 -08001939 }
1940 }
1941
Dianne Hackborn231cc602009-04-27 17:10:36 -07001942 /**
1943 * Write all account information to the account file.
1944 */
1945 private void writeAccountInfoLocked() {
Matthew Williamsba352712013-08-13 15:53:31 -07001946 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001947 Slog.v(TAG_FILE, "Writing new " + mAccountInfoFile.getBaseFile());
Matthew Williamsba352712013-08-13 15:53:31 -07001948 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001949 FileOutputStream fos = null;
Costin Manolache360e4542009-09-04 13:36:04 -07001950
Dianne Hackborn231cc602009-04-27 17:10:36 -07001951 try {
1952 fos = mAccountInfoFile.startWrite();
1953 XmlSerializer out = new FastXmlSerializer();
Wojciech Staszkiewicz9e9e2e72015-05-08 14:58:46 +01001954 out.setOutput(fos, StandardCharsets.UTF_8.name());
Dianne Hackborn231cc602009-04-27 17:10:36 -07001955 out.startDocument(null, true);
1956 out.setFeature("http://xmlpull.org/v1/doc/features.html#indent-output", true);
Costin Manolache360e4542009-09-04 13:36:04 -07001957
Dianne Hackborn231cc602009-04-27 17:10:36 -07001958 out.startTag(null, "accounts");
Fred Quintanac2e46912010-03-15 16:10:44 -07001959 out.attribute(null, "version", Integer.toString(ACCOUNTS_VERSION));
Amith Yamasani04e0d262012-02-14 11:50:53 -08001960 out.attribute(null, XML_ATTR_NEXT_AUTHORITY_ID, Integer.toString(mNextAuthorityId));
Ashish Sharma69d95de2012-04-11 17:27:24 -07001961 out.attribute(null, XML_ATTR_SYNC_RANDOM_OFFSET, Integer.toString(mSyncRandomOffset));
Amith Yamasani04e0d262012-02-14 11:50:53 -08001962
1963 // Write the Sync Automatically flags for each user
1964 final int M = mMasterSyncAutomatically.size();
1965 for (int m = 0; m < M; m++) {
1966 int userId = mMasterSyncAutomatically.keyAt(m);
1967 Boolean listen = mMasterSyncAutomatically.valueAt(m);
1968 out.startTag(null, XML_TAG_LISTEN_FOR_TICKLES);
1969 out.attribute(null, XML_ATTR_USER, Integer.toString(userId));
1970 out.attribute(null, XML_ATTR_ENABLED, Boolean.toString(listen));
1971 out.endTag(null, XML_TAG_LISTEN_FOR_TICKLES);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001972 }
Costin Manolache360e4542009-09-04 13:36:04 -07001973
Dianne Hackborn231cc602009-04-27 17:10:36 -07001974 final int N = mAuthorities.size();
Matthew Williamsfa774182013-06-18 15:44:11 -07001975 for (int i = 0; i < N; i++) {
Costin Manolache360e4542009-09-04 13:36:04 -07001976 AuthorityInfo authority = mAuthorities.valueAt(i);
Matthew Williams8ef22042013-07-26 12:56:39 -07001977 EndPoint info = authority.target;
Dianne Hackborn231cc602009-04-27 17:10:36 -07001978 out.startTag(null, "authority");
1979 out.attribute(null, "id", Integer.toString(authority.ident));
Matthew Williams56dbf8f2013-07-26 12:56:39 -07001980 out.attribute(null, XML_ATTR_USER, Integer.toString(info.userId));
Amith Yamasani04e0d262012-02-14 11:50:53 -08001981 out.attribute(null, XML_ATTR_ENABLED, Boolean.toString(authority.enabled));
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001982 out.attribute(null, "account", info.account.name);
1983 out.attribute(null, "type", info.account.type);
1984 out.attribute(null, "authority", info.provider);
Matthew Williams53abfdb2015-06-10 20:06:37 -07001985 out.attribute(null, "syncable", Integer.toString(authority.syncable));
Dianne Hackborn231cc602009-04-27 17:10:36 -07001986 out.endTag(null, "authority");
1987 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07001988 out.endTag(null, "accounts");
Dianne Hackborn231cc602009-04-27 17:10:36 -07001989 out.endDocument();
Dianne Hackborn231cc602009-04-27 17:10:36 -07001990 mAccountInfoFile.finishWrite(fos);
1991 } catch (java.io.IOException e1) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00001992 Slog.w(TAG, "Error writing accounts", e1);
Dianne Hackborn231cc602009-04-27 17:10:36 -07001993 if (fos != null) {
1994 mAccountInfoFile.failWrite(fos);
1995 }
1996 }
1997 }
Costin Manolache360e4542009-09-04 13:36:04 -07001998
Dianne Hackborn231cc602009-04-27 17:10:36 -07001999 public static final int STATUS_FILE_END = 0;
2000 public static final int STATUS_FILE_ITEM = 100;
Costin Manolache360e4542009-09-04 13:36:04 -07002001
Dianne Hackborn231cc602009-04-27 17:10:36 -07002002 /**
2003 * Read all sync status back in to the initial engine state.
2004 */
2005 private void readStatusLocked() {
Matthew Williamsba352712013-08-13 15:53:31 -07002006 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002007 Slog.v(TAG_FILE, "Reading " + mStatusFile.getBaseFile());
Matthew Williamsba352712013-08-13 15:53:31 -07002008 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07002009 try {
2010 byte[] data = mStatusFile.readFully();
2011 Parcel in = Parcel.obtain();
2012 in.unmarshall(data, 0, data.length);
2013 in.setDataPosition(0);
2014 int token;
2015 while ((token=in.readInt()) != STATUS_FILE_END) {
2016 if (token == STATUS_FILE_ITEM) {
2017 SyncStatusInfo status = new SyncStatusInfo(in);
2018 if (mAuthorities.indexOfKey(status.authorityId) >= 0) {
2019 status.pending = false;
Matthew Williamsba352712013-08-13 15:53:31 -07002020 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002021 Slog.v(TAG_FILE, "Adding status for id " + status.authorityId);
Matthew Williamsba352712013-08-13 15:53:31 -07002022 }
Dianne Hackborn231cc602009-04-27 17:10:36 -07002023 mSyncStatus.put(status.authorityId, status);
2024 }
2025 } else {
2026 // Ooops.
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002027 Slog.w(TAG, "Unknown status token: " + token);
Dianne Hackborn231cc602009-04-27 17:10:36 -07002028 break;
2029 }
2030 }
2031 } catch (java.io.IOException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002032 Slog.i(TAG, "No initial status");
Dianne Hackborn231cc602009-04-27 17:10:36 -07002033 }
2034 }
Costin Manolache360e4542009-09-04 13:36:04 -07002035
Dianne Hackborn231cc602009-04-27 17:10:36 -07002036 /**
2037 * Write all sync status to the sync status file.
2038 */
2039 private void writeStatusLocked() {
Matthew Williamsba352712013-08-13 15:53:31 -07002040 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002041 Slog.v(TAG_FILE, "Writing new " + mStatusFile.getBaseFile());
Matthew Williamsba352712013-08-13 15:53:31 -07002042 }
Costin Manolache360e4542009-09-04 13:36:04 -07002043
Dianne Hackborn231cc602009-04-27 17:10:36 -07002044 // The file is being written, so we don't need to have a scheduled
2045 // write until the next change.
Makoto Onuki6963bea72017-12-12 10:42:39 -08002046 mHandler.removeMessages(MSG_WRITE_STATUS);
Costin Manolache360e4542009-09-04 13:36:04 -07002047
Dianne Hackborn231cc602009-04-27 17:10:36 -07002048 FileOutputStream fos = null;
2049 try {
2050 fos = mStatusFile.startWrite();
2051 Parcel out = Parcel.obtain();
2052 final int N = mSyncStatus.size();
2053 for (int i=0; i<N; i++) {
2054 SyncStatusInfo status = mSyncStatus.valueAt(i);
2055 out.writeInt(STATUS_FILE_ITEM);
2056 status.writeToParcel(out, 0);
2057 }
2058 out.writeInt(STATUS_FILE_END);
2059 fos.write(out.marshall());
2060 out.recycle();
Costin Manolache360e4542009-09-04 13:36:04 -07002061
Dianne Hackborn231cc602009-04-27 17:10:36 -07002062 mStatusFile.finishWrite(fos);
2063 } catch (java.io.IOException e1) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002064 Slog.w(TAG, "Error writing status", e1);
Dianne Hackborn231cc602009-04-27 17:10:36 -07002065 if (fos != null) {
2066 mStatusFile.failWrite(fos);
2067 }
2068 }
2069 }
Costin Manolache360e4542009-09-04 13:36:04 -07002070
Makoto Onuki61283ec2018-01-31 17:22:36 -08002071 private void requestSync(AuthorityInfo authorityInfo, int reason, Bundle extras,
Makoto Onukie183a402018-08-29 11:46:41 -07002072 @SyncExemption int syncExemptionFlag, int callingUid, int callingPid) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07002073 if (android.os.Process.myUid() == android.os.Process.SYSTEM_UID
2074 && mSyncRequestListener != null) {
Makoto Onuki61283ec2018-01-31 17:22:36 -08002075 mSyncRequestListener.onSyncRequest(authorityInfo.target, reason, extras,
Makoto Onukie183a402018-08-29 11:46:41 -07002076 syncExemptionFlag, callingUid, callingPid);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07002077 } else {
2078 SyncRequest.Builder req =
2079 new SyncRequest.Builder()
Nick Kralevich69002ae2013-10-19 08:43:08 -07002080 .syncOnce()
Matthew Williams8ef22042013-07-26 12:56:39 -07002081 .setExtras(extras);
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002082 req.setSyncAdapter(authorityInfo.target.account, authorityInfo.target.provider);
Matthew Williams56dbf8f2013-07-26 12:56:39 -07002083 ContentResolver.requestSync(req.build());
2084 }
2085 }
2086
Alon Albert57286f92012-10-09 14:21:38 -07002087 private void requestSync(Account account, int userId, int reason, String authority,
Makoto Onukie183a402018-08-29 11:46:41 -07002088 Bundle extras, @SyncExemption int syncExemptionFlag, int callingUid, int callingPid) {
Amith Yamasani04e0d262012-02-14 11:50:53 -08002089 // If this is happening in the system process, then call the syncrequest listener
2090 // to make a request back to the SyncManager directly.
2091 // If this is probably a test instance, then call back through the ContentResolver
2092 // which will know which userId to apply based on the Binder id.
2093 if (android.os.Process.myUid() == android.os.Process.SYSTEM_UID
2094 && mSyncRequestListener != null) {
Matthew Williams56dbf8f2013-07-26 12:56:39 -07002095 mSyncRequestListener.onSyncRequest(
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002096 new EndPoint(account, authority, userId),
Makoto Onukie183a402018-08-29 11:46:41 -07002097 reason, extras, syncExemptionFlag, callingUid, callingPid);
Amith Yamasani04e0d262012-02-14 11:50:53 -08002098 } else {
2099 ContentResolver.requestSync(account, authority, extras);
2100 }
2101 }
2102
Dianne Hackborn231cc602009-04-27 17:10:36 -07002103 public static final int STATISTICS_FILE_END = 0;
2104 public static final int STATISTICS_FILE_ITEM_OLD = 100;
2105 public static final int STATISTICS_FILE_ITEM = 101;
Costin Manolache360e4542009-09-04 13:36:04 -07002106
Dianne Hackborn231cc602009-04-27 17:10:36 -07002107 /**
2108 * Read all sync statistics back in to the initial engine state.
2109 */
2110 private void readStatisticsLocked() {
2111 try {
2112 byte[] data = mStatisticsFile.readFully();
2113 Parcel in = Parcel.obtain();
2114 in.unmarshall(data, 0, data.length);
2115 in.setDataPosition(0);
2116 int token;
2117 int index = 0;
2118 while ((token=in.readInt()) != STATISTICS_FILE_END) {
2119 if (token == STATISTICS_FILE_ITEM
2120 || token == STATISTICS_FILE_ITEM_OLD) {
2121 int day = in.readInt();
2122 if (token == STATISTICS_FILE_ITEM_OLD) {
2123 day = day - 2009 + 14245; // Magic!
2124 }
2125 DayStats ds = new DayStats(day);
2126 ds.successCount = in.readInt();
2127 ds.successTime = in.readLong();
2128 ds.failureCount = in.readInt();
2129 ds.failureTime = in.readLong();
2130 if (index < mDayStats.length) {
2131 mDayStats[index] = ds;
2132 index++;
2133 }
2134 } else {
2135 // Ooops.
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002136 Slog.w(TAG, "Unknown stats token: " + token);
Dianne Hackborn231cc602009-04-27 17:10:36 -07002137 break;
2138 }
2139 }
2140 } catch (java.io.IOException e) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002141 Slog.i(TAG, "No initial statistics");
Dianne Hackborn231cc602009-04-27 17:10:36 -07002142 }
2143 }
Costin Manolache360e4542009-09-04 13:36:04 -07002144
Dianne Hackborn231cc602009-04-27 17:10:36 -07002145 /**
2146 * Write all sync statistics to the sync status file.
2147 */
2148 private void writeStatisticsLocked() {
Matthew Williamsba352712013-08-13 15:53:31 -07002149 if (Log.isLoggable(TAG_FILE, Log.VERBOSE)) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002150 Slog.v(TAG, "Writing new " + mStatisticsFile.getBaseFile());
Matthew Williamsba352712013-08-13 15:53:31 -07002151 }
Costin Manolache360e4542009-09-04 13:36:04 -07002152
Dianne Hackborn231cc602009-04-27 17:10:36 -07002153 // The file is being written, so we don't need to have a scheduled
2154 // write until the next change.
Makoto Onuki6963bea72017-12-12 10:42:39 -08002155 mHandler.removeMessages(MSG_WRITE_STATISTICS);
Costin Manolache360e4542009-09-04 13:36:04 -07002156
Dianne Hackborn231cc602009-04-27 17:10:36 -07002157 FileOutputStream fos = null;
2158 try {
2159 fos = mStatisticsFile.startWrite();
2160 Parcel out = Parcel.obtain();
2161 final int N = mDayStats.length;
2162 for (int i=0; i<N; i++) {
2163 DayStats ds = mDayStats[i];
2164 if (ds == null) {
2165 break;
2166 }
2167 out.writeInt(STATISTICS_FILE_ITEM);
2168 out.writeInt(ds.day);
2169 out.writeInt(ds.successCount);
2170 out.writeLong(ds.successTime);
2171 out.writeInt(ds.failureCount);
2172 out.writeLong(ds.failureTime);
2173 }
2174 out.writeInt(STATISTICS_FILE_END);
2175 fos.write(out.marshall());
2176 out.recycle();
Costin Manolache360e4542009-09-04 13:36:04 -07002177
Dianne Hackborn231cc602009-04-27 17:10:36 -07002178 mStatisticsFile.finishWrite(fos);
2179 } catch (java.io.IOException e1) {
Shreyas Basarge8c834c02016-01-07 13:53:16 +00002180 Slog.w(TAG, "Error writing stats", e1);
Dianne Hackborn231cc602009-04-27 17:10:36 -07002181 if (fos != null) {
2182 mStatisticsFile.failWrite(fos);
2183 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002184 }
2185 }
Matthew Williamsfa774182013-06-18 15:44:11 -07002186
2187 /**
Marvin Paula6533252014-11-24 12:57:48 -08002188 * Let the BackupManager know that account sync settings have changed. This will trigger
2189 * {@link com.android.server.backup.SystemBackupAgent} to run.
2190 */
2191 public void queueBackup() {
2192 BackupManager.dataChanged("android");
2193 }
Makoto Onuki94986212018-04-11 16:24:46 -07002194
2195 public void setClockValid() {
2196 if (!mIsClockValid) {
2197 mIsClockValid = true;
2198 Slog.w(TAG, "Clock is valid now.");
2199 }
2200 }
2201
2202 public boolean isClockValid() {
2203 return mIsClockValid;
2204 }
2205
2206 public void resetTodayStats(boolean force) {
2207 if (force) {
2208 Log.w(TAG, "Force resetting today stats.");
2209 }
2210 synchronized (mAuthorities) {
2211 final int N = mSyncStatus.size();
2212 for (int i = 0; i < N; i++) {
2213 SyncStatusInfo cur = mSyncStatus.valueAt(i);
2214 cur.maybeResetTodayStats(isClockValid(), force);
2215 }
2216 writeStatusLocked();
2217 }
2218 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002219}