OLD | NEW |
---|---|
(Empty) | |
1 // Copyright 2017 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 package org.chromium.components.background_task_scheduler; | |
6 | |
7 import android.content.Context; | |
8 import android.os.Bundle; | |
9 import android.support.annotation.NonNull; | |
10 | |
11 import com.google.android.gms.common.ConnectionResult; | |
12 import com.google.android.gms.common.GoogleApiAvailability; | |
13 import com.google.android.gms.gcm.GcmNetworkManager; | |
14 import com.google.android.gms.gcm.OneoffTask; | |
15 import com.google.android.gms.gcm.PeriodicTask; | |
16 import com.google.android.gms.gcm.Task; | |
17 import com.google.android.gms.gcm.TaskParams; | |
18 | |
19 import org.chromium.base.Log; | |
20 import org.chromium.base.ThreadUtils; | |
21 import org.chromium.base.VisibleForTesting; | |
22 | |
23 import java.util.concurrent.TimeUnit; | |
24 | |
25 /** | |
26 * An implementation of {@link BackgroundTaskSchedulerDelegate} that uses the Pl ay Services | |
27 * {@link GcmNetworkManager} to schedule jobs. | |
28 */ | |
29 class BackgroundTaskSchedulerGcmNetworkManager implements BackgroundTaskSchedule rDelegate { | |
30 private static final String TAG = "BkgrdTaskSchedGcmNM"; | |
31 | |
32 @VisibleForTesting | |
33 static final String BACKGROUND_TASK_CLASS_KEY = "_background_task_class"; | |
34 @VisibleForTesting | |
35 static final String BACKGROUND_TASK_EXTRAS_KEY = "_background_task_extras"; | |
36 | |
37 static BackgroundTask getBackgroundTaskFromTaskParams(@NonNull TaskParams ta skParams) { | |
38 String backgroundTaskClassName = getBackgroundTaskClassFromTaskParams(ta skParams); | |
39 return BackgroundTaskScheduler.getBackgroundTaskFromClassName(background TaskClassName); | |
40 } | |
41 | |
42 private static String getBackgroundTaskClassFromTaskParams(@NonNull TaskPara ms taskParams) { | |
43 Bundle extras = taskParams.getExtras(); | |
44 if (extras == null) return null; | |
45 return extras.getString(BACKGROUND_TASK_CLASS_KEY); | |
46 } | |
47 | |
48 /** | |
49 * Retrieves the {@link TaskParameters} from the {@link TaskParams}, which a re passed as | |
50 * one of the keys. Only values valid for {@link android.os.BaseBundle} are supported, and other | |
51 * values are stripped at the time when the task is scheduled. | |
52 * | |
53 * @param taskParams the {@link TaskParams} to extract the {@link TaskParame ters} from. | |
54 * @return the {@link TaskParameters} for the current job. | |
55 */ | |
56 static TaskParameters getTaskParametersFromTaskParams(@NonNull TaskParams ta skParams) { | |
57 int taskId; | |
58 try { | |
59 taskId = Integer.parseInt(taskParams.getTag()); | |
60 } catch (NumberFormatException e) { | |
61 Log.e(TAG, "Cound not parse task ID from task tag: " + taskParams.ge tTag()); | |
62 return null; | |
63 } | |
64 | |
65 TaskParameters.Builder builder = TaskParameters.create(taskId); | |
66 | |
67 Bundle extras = taskParams.getExtras(); | |
68 Bundle taskExtras = extras.getBundle(BACKGROUND_TASK_EXTRAS_KEY); | |
69 builder.addExtras(taskExtras); | |
70 | |
71 return builder.build(); | |
72 } | |
73 | |
74 @VisibleForTesting | |
75 static Task createTaskFromTaskInfo(@NonNull TaskInfo taskInfo) { | |
76 Bundle taskExtras = new Bundle(); | |
77 taskExtras.putString( | |
78 BACKGROUND_TASK_CLASS_KEY, taskInfo.getBackgroundTaskClass().get Name()); | |
79 taskExtras.putBundle(BACKGROUND_TASK_EXTRAS_KEY, taskInfo.getExtras()); | |
80 | |
81 Task.Builder builder; | |
82 if (taskInfo.isPeriodic()) { | |
83 builder = getPeriodicTaskBuilder(taskInfo.getPeriodicInfo()); | |
84 } else { | |
85 builder = getOneOffTaskBuilder(taskInfo.getOneOffInfo()); | |
86 } | |
87 | |
88 builder.setExtras(taskExtras) | |
89 // TODO(fgorski): Check what is the default for JobScheduler. Ta skInfo may need to | |
fgorski
2017/04/11 19:42:11
This is about how we have the defaults set...
We m
nyquist
2017/04/18 21:58:28
Yeah, would be great to look into this before we a
fgorski
2017/04/20 05:54:15
JobInfo or Builder documentation does not mention
nyquist
2017/04/25 20:44:15
sgtm
| |
90 // be fixed. | |
91 .setPersisted(taskInfo.isPersisted()) | |
92 .setRequiredNetwork(getGcmNetworkManagerNetworkTypeFromTypeFromT askNetworkType( | |
93 taskInfo.getRequiredNetworkType())) | |
94 .setRequiresCharging(taskInfo.requiresCharging()) | |
95 .setService(BackgroundTaskGcmTaskService.class) | |
96 .setTag(taskIdToTaskTag(taskInfo.getTaskId())) | |
97 .setUpdateCurrent(taskInfo.shouldUpdateCurrent()); | |
98 | |
99 return builder.build(); | |
100 } | |
101 | |
102 private static Task.Builder getPeriodicTaskBuilder(TaskInfo.PeriodicInfo per iodicInfo) { | |
103 PeriodicTask.Builder builder = new PeriodicTask.Builder(); | |
104 builder.setPeriod(TimeUnit.MILLISECONDS.toSeconds(periodicInfo.getInterv alMs())); | |
105 if (periodicInfo.hasFlex()) { | |
106 builder.setFlex(TimeUnit.MILLISECONDS.toSeconds(periodicInfo.getFlex Ms())); | |
107 } | |
108 return builder; | |
109 } | |
110 | |
111 private static Task.Builder getOneOffTaskBuilder(TaskInfo.OneOffInfo oneOffI nfo) { | |
112 OneoffTask.Builder builder = new OneoffTask.Builder(); | |
113 long windowStartSeconds = oneOffInfo.hasWindowStartTimeConstraint() | |
114 ? TimeUnit.MILLISECONDS.toSeconds(oneOffInfo.getWindowStartTimeM s()) | |
115 : 0; | |
116 builder.setExecutionWindow(windowStartSeconds, | |
117 TimeUnit.MILLISECONDS.toSeconds(oneOffInfo.getWindowEndTimeMs()) ); | |
118 return builder; | |
119 } | |
120 | |
121 private static int getGcmNetworkManagerNetworkTypeFromTypeFromTaskNetworkTyp e( | |
122 @TaskInfo.NetworkType int networkType) { | |
123 switch (networkType) { | |
124 // This is correct: GcmNM ANY means no network is guaranteed. | |
125 case TaskInfo.NETWORK_TYPE_NONE: | |
126 return Task.NETWORK_STATE_ANY; | |
127 case TaskInfo.NETWORK_TYPE_ANY: | |
128 return Task.NETWORK_STATE_CONNECTED; | |
129 case TaskInfo.NETWORK_TYPE_UNMETERED: | |
130 return Task.NETWORK_STATE_UNMETERED; | |
131 default: | |
132 assert false; | |
133 } | |
134 return Task.NETWORK_STATE_ANY; | |
135 } | |
136 | |
137 @Override | |
138 public boolean schedule(Context context, @NonNull TaskInfo taskInfo) { | |
139 ThreadUtils.assertOnUiThread(); | |
140 if (!BackgroundTaskScheduler.hasParameterlessPublicConstructor( | |
141 taskInfo.getBackgroundTaskClass())) { | |
142 Log.e(TAG, | |
143 "BackgroundTask " + taskInfo.getBackgroundTaskClass() | |
144 + " has no parameterless public constructor."); | |
145 return false; | |
146 } | |
147 | |
148 GcmNetworkManager gcmNetworkManager = getGcmNetworkManager(context); | |
149 if (gcmNetworkManager == null) { | |
150 Log.e(TAG, "GcmNetworkManager is not available."); | |
151 return false; | |
152 } | |
153 | |
154 Task task = createTaskFromTaskInfo(taskInfo); | |
155 | |
156 gcmNetworkManager.schedule(task); | |
157 return true; | |
158 } | |
159 | |
160 @Override | |
161 public void cancel(Context context, int taskId) { | |
162 ThreadUtils.assertOnUiThread(); | |
163 | |
164 GcmNetworkManager gcmNetworkManager = getGcmNetworkManager(context); | |
165 if (gcmNetworkManager == null) { | |
166 Log.e(TAG, "GcmNetworkManager is not available."); | |
167 return; | |
168 } | |
169 | |
170 gcmNetworkManager.cancelTask(taskIdToTaskTag(taskId), BackgroundTaskGcmT askService.class); | |
171 } | |
172 | |
173 private GcmNetworkManager getGcmNetworkManager(Context context) { | |
174 if (GoogleApiAvailability.getInstance().isGooglePlayServicesAvailable(co ntext) | |
175 == ConnectionResult.SUCCESS) { | |
176 return GcmNetworkManager.getInstance(context); | |
177 } | |
178 return null; | |
179 } | |
180 | |
181 private static String taskIdToTaskTag(int taskId) { | |
182 return Integer.toString(taskId); | |
183 } | |
184 } | |
OLD | NEW |