1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.deskclock;
import android.app.AlarmManager;
import android.app.PendingIntent;
import android.app.backup.BackupAgent;
import android.app.backup.BackupDataInput;
import android.app.backup.BackupDataOutput;
import android.content.ContentResolver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.SharedPreferences;
import android.os.ParcelFileDescriptor;
import android.os.SystemClock;
import android.preference.PreferenceManager;
import android.support.annotation.NonNull;
import com.android.deskclock.alarms.AlarmStateManager;
import com.android.deskclock.provider.Alarm;
import com.android.deskclock.provider.AlarmInstance;
import java.io.File;
import java.io.IOException;
import java.util.Calendar;
import java.util.List;
public class DeskClockBackupAgent extends BackupAgent {
private static final String KEY_RESTORE_FINISHED = "restore_finished";
public static final String ACTION_COMPLETE_RESTORE =
"com.android.deskclock.action.COMPLETE_RESTORE";
private static final String TAG = "DeskClockBackupAgent";
@Override
public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data,
ParcelFileDescriptor newState) throws IOException { }
@Override
public void onRestore(BackupDataInput data, int appVersionCode,
ParcelFileDescriptor newState) throws IOException { }
@Override
public void onRestoreFile(@NonNull ParcelFileDescriptor data, long size, File destination,
int type, long mode, long mtime) throws IOException {
// The preference file on the backup device may not be the same on the restore device.
// Massage the file name here before writing it.
if (destination.getName().endsWith("_preferences.xml")) {
final String prefFileName = getPackageName() + "_preferences.xml";
destination = new File(destination.getParentFile(), prefFileName);
}
super.onRestoreFile(data, size, destination, type, mode, mtime);
}
/**
* When this method is called during backup/restore, the application is executing in a
* "minimalist" state. Because of this, the application's ContentResolver cannot be used.
* Consequently, the work of scheduling alarms on the restore device cannot be done here.
* Instead, a future callback to DeskClock is used as a signal to reschedule the alarms. The
* future callback may take the form of ACTION_BOOT_COMPLETED if the device is not yet fully
* booted (i.e. the restore occurred as part of the setup wizard). If the device is booted, an
* ACTION_COMPLETE_RESTORE broadcast is scheduled 10 seconds in the future to give
* backup/restore enough time to kill the Clock process. Both of these future callbacks result
* in the execution of {@link #processRestoredData(Context)}.
*/
@Override
public void onRestoreFinished() {
if (Utils.isNOrLater()) {
// TODO: migrate restored database and preferences over into
// the device-encrypted storage area
}
// Write a preference to indicate a data restore has been completed.
final SharedPreferences prefs = Utils.getDefaultSharedPreferences(this);
prefs.edit().putBoolean(KEY_RESTORE_FINISHED, true).apply();
// Create an Intent to send into DeskClock indicating restore is complete.
final PendingIntent restoreIntent = PendingIntent.getBroadcast(this, 0,
new Intent(ACTION_COMPLETE_RESTORE).setClass(this, AlarmInitReceiver.class),
PendingIntent.FLAG_ONE_SHOT | PendingIntent.FLAG_CANCEL_CURRENT);
// Deliver the Intent 10 seconds from now.
final long triggerAtMillis = SystemClock.elapsedRealtime() + 10000;
// Schedule the Intent delivery in AlarmManager.
final AlarmManager alarmManager = (AlarmManager) getSystemService(Context.ALARM_SERVICE);
alarmManager.setExact(AlarmManager.ELAPSED_REALTIME_WAKEUP, triggerAtMillis, restoreIntent);
LogUtils.i(TAG, "Waiting for %s to complete the data restore", ACTION_COMPLETE_RESTORE);
}
/**
* @param context a context to access resources and services
* @return {@code true} if restore data was processed; {@code false} otherwise.
*/
public static boolean processRestoredData(Context context) {
// If the preference indicates data was not recently restored, there is nothing to do.
final SharedPreferences prefs = Utils.getDefaultSharedPreferences(context);
if (!prefs.getBoolean(KEY_RESTORE_FINISHED, false)) {
return false;
}
LogUtils.i(TAG, "processRestoredData() started");
// Now that alarms have been restored, schedule new instances in AlarmManager.
final ContentResolver contentResolver = context.getContentResolver();
final List<Alarm> alarms = Alarm.getAlarms(contentResolver, null);
final Calendar now = Calendar.getInstance();
for (Alarm alarm : alarms) {
// Remove any instances that may currently exist for the alarm;
// these aren't relevant on the restore device and we'll recreate them below.
AlarmStateManager.deleteAllInstances(context, alarm.id);
if (alarm.enabled) {
// Create the next alarm instance to schedule.
AlarmInstance alarmInstance = alarm.createInstanceAfter(now);
// Add the next alarm instance to the database.
alarmInstance = AlarmInstance.addInstance(contentResolver, alarmInstance);
// Schedule the next alarm instance in AlarmManager.
AlarmStateManager.registerInstance(context, alarmInstance, true);
LogUtils.i(TAG, "DeskClockBackupAgent scheduled alarm instance: %s", alarmInstance);
}
}
// Remove the preference to avoid executing this logic multiple times.
prefs.edit().remove(KEY_RESTORE_FINISHED).apply();
LogUtils.i(TAG, "processRestoredData() completed");
return true;
}
}
|
