summaryrefslogtreecommitdiff
path: root/src/com/android/providers/media/photopicker/sync/SyncTrackerRegistry.java
blob: 5a5f6c90f570ee1f0baede4142c5abaacc9dff9f (plain)
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*
 * Copyright (C) 2023 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.providers.media.photopicker.sync;

import static com.android.providers.media.photopicker.sync.PickerSyncManager.SYNC_CLOUD_ONLY;
import static com.android.providers.media.photopicker.sync.PickerSyncManager.SYNC_LOCAL_AND_CLOUD;
import static com.android.providers.media.photopicker.sync.PickerSyncManager.SYNC_LOCAL_ONLY;

import androidx.annotation.NonNull;
import androidx.annotation.VisibleForTesting;

import java.util.UUID;

/**
 * This class stores all sync trackers.
 */
public class SyncTrackerRegistry {
    private static SyncTracker sLocalSyncTracker = new SyncTracker();
    private static SyncTracker sLocalAlbumSyncTracker = new SyncTracker();
    private static SyncTracker sCloudSyncTracker = new SyncTracker();
    private static SyncTracker sCloudAlbumSyncTracker = new SyncTracker();

    public static SyncTracker getLocalSyncTracker() {
        return sLocalSyncTracker;
    }

    /**
     * This setter is required to inject mock data for tests. Do not use this anywhere else.
     */
    @VisibleForTesting(otherwise = VisibleForTesting.NONE)
    public static void setLocalSyncTracker(SyncTracker syncTracker) {
        sLocalSyncTracker = syncTracker;
    }

    public static SyncTracker getLocalAlbumSyncTracker() {
        return sLocalAlbumSyncTracker;
    }

    /**
     * This setter is required to inject mock data for tests. Do not use this anywhere else.
     */
    @VisibleForTesting(otherwise = VisibleForTesting.NONE)
    public static void setLocalAlbumSyncTracker(
            SyncTracker localAlbumSyncTracker) {
        sLocalAlbumSyncTracker = localAlbumSyncTracker;
    }

    public static SyncTracker getCloudSyncTracker() {
        return sCloudSyncTracker;
    }

    /**
     * This setter is required to inject mock data for tests. Do not use this anywhere else.
     */
    @VisibleForTesting(otherwise = VisibleForTesting.NONE)
    public static void setCloudSyncTracker(
            SyncTracker cloudSyncTracker) {
        sCloudSyncTracker = cloudSyncTracker;
    }

    public static SyncTracker getCloudAlbumSyncTracker() {
        return sCloudAlbumSyncTracker;
    }

    /**
     * This setter is required to inject mock data for tests. Do not use this anywhere else.
     */
    @VisibleForTesting(otherwise = VisibleForTesting.NONE)
    public static void setCloudAlbumSyncTracker(
            SyncTracker cloudAlbumSyncTracker) {
        sCloudAlbumSyncTracker = cloudAlbumSyncTracker;
    }

    /**
     * Return the appropriate sync tracker.
     * @param isLocal is true when sync with local provider needs to be tracked. It is false for
     *                sync with cloud provider.
     * @return the appropriate {@link SyncTracker} object.
     */
    public static SyncTracker getSyncTracker(boolean isLocal) {
        if (isLocal) {
            return sLocalSyncTracker;
        } else {
            return sCloudSyncTracker;
        }
    }

    /**
     * Return the appropriate album sync tracker.
     * @param isLocal is true when sync with local provider needs to be tracked. It is false for
     *                sync with cloud provider.
     * @return the appropriate {@link SyncTracker} object.
     */
    public static SyncTracker getAlbumSyncTracker(boolean isLocal) {
        if (isLocal) {
            return sLocalAlbumSyncTracker;
        } else {
            return sCloudAlbumSyncTracker;
        }
    }

    /**
     * Create the required completable futures for new media sync requests that need to be tracked.
     */
    public static void trackNewSyncRequests(
            @PickerSyncManager.SyncSource int syncSource,
            @NonNull UUID syncRequestId) {
        if (syncSource == SYNC_LOCAL_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getLocalSyncTracker().createSyncFuture(syncRequestId);
        }
        if (syncSource == SYNC_CLOUD_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getCloudSyncTracker().createSyncFuture(syncRequestId);
        }
    }

    /**
     * Create the required completable futures for new album media sync requests that need to be
     * tracked.
     */
    public static void trackNewAlbumMediaSyncRequests(
            @PickerSyncManager.SyncSource int syncSource,
            @NonNull UUID syncRequestId) {
        if (syncSource == SYNC_LOCAL_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getLocalAlbumSyncTracker().createSyncFuture(syncRequestId);
        }
        if (syncSource == SYNC_CLOUD_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getCloudAlbumSyncTracker().createSyncFuture(syncRequestId);
        }
    }

    /**
     * Mark the required futures as complete for existing media sync requests.
     */
    public static void markSyncAsComplete(
            @PickerSyncManager.SyncSource int syncSource,
            @NonNull UUID syncRequestId) {
        if (syncSource == SYNC_LOCAL_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getLocalSyncTracker().markSyncCompleted(syncRequestId);
        }
        if (syncSource == SYNC_CLOUD_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getCloudSyncTracker().markSyncCompleted(syncRequestId);
        }
    }

    /**
     * Mark the required futures as complete for existing album media sync requests.
     */
    public static void markAlbumMediaSyncAsComplete(
            @PickerSyncManager.SyncSource int syncSource,
            @NonNull UUID syncRequestId) {
        if (syncSource == SYNC_LOCAL_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getLocalAlbumSyncTracker().markSyncCompleted(syncRequestId);
        }
        if (syncSource == SYNC_CLOUD_ONLY || syncSource == SYNC_LOCAL_AND_CLOUD) {
            getCloudAlbumSyncTracker().markSyncCompleted(syncRequestId);
        }
    }
}