/* * Copyright (C) 2024 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.server.appsearch.appsindexer; import android.annotation.NonNull; import android.os.PersistableBundle; import android.util.AtomicFile; import com.android.internal.annotations.VisibleForTesting; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.util.Objects; /** * Apps indexer settings backed by a PersistableBundle. * *

Holds settings such as: * *

* *

This class is NOT thread safe (similar to {@link PersistableBundle} which it wraps). * * @hide */ public class AppsIndexerSettings { static final String SETTINGS_FILE_NAME = "apps_indexer_settings.pb"; static final String LAST_UPDATE_TIMESTAMP_KEY = "last_update_timestamp_millis"; static final String LAST_APP_UPDATE_TIMESTAMP_KEY = "last_app_update_timestamp_millis"; private final File mFile; private PersistableBundle mBundle = new PersistableBundle(); public AppsIndexerSettings(@NonNull File baseDir) { Objects.requireNonNull(baseDir); mFile = new File(baseDir, SETTINGS_FILE_NAME); } public void load() throws IOException { mBundle = readBundle(mFile); } public void persist() throws IOException { writeBundle(mFile, mBundle); } /** Returns the timestamp of when the last full update occurred in milliseconds. */ public long getLastUpdateTimestampMillis() { return mBundle.getLong(LAST_UPDATE_TIMESTAMP_KEY); } /** Sets the timestamp of when the last full update occurred in milliseconds. */ public void setLastUpdateTimestampMillis(long timestampMillis) { mBundle.putLong(LAST_UPDATE_TIMESTAMP_KEY, timestampMillis); } /** Returns the timestamp of when the last app was updated in milliseconds. */ public long getLastAppUpdateTimestampMillis() { return mBundle.getLong(LAST_APP_UPDATE_TIMESTAMP_KEY); } /** Sets the timestamp of when the last apps was updated in milliseconds. */ public void setLastAppUpdateTimestampMillis(long timestampMillis) { mBundle.putLong(LAST_APP_UPDATE_TIMESTAMP_KEY, timestampMillis); } /** Resets all the settings to default values. */ public void reset() { setLastUpdateTimestampMillis(0); setLastAppUpdateTimestampMillis(0); } @VisibleForTesting @NonNull static PersistableBundle readBundle(@NonNull File src) throws IOException { AtomicFile atomicFile = new AtomicFile(src); try (FileInputStream fis = atomicFile.openRead()) { return PersistableBundle.readFromStream(fis); } } @VisibleForTesting static void writeBundle(@NonNull File dest, @NonNull PersistableBundle bundle) throws IOException { AtomicFile atomicFile = new AtomicFile(dest); FileOutputStream fos = null; try { fos = atomicFile.startWrite(); bundle.writeToStream(fos); atomicFile.finishWrite(fos); } catch (IOException e) { if (fos != null) { atomicFile.failWrite(fos); } throw e; } } }