/* * ownCloud Android client application * * @author David A. Velasco * @author Chris Narkiewicz Chris Narkiewicz * Copyright (C) 2016 ownCloud Inc. * Copyright (C) 2019 Chris Narkiewicz * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ package com.nextcloud.client.preferences; import android.accounts.Account; import android.annotation.SuppressLint; import android.content.Context; import android.content.SharedPreferences; import com.nextcloud.client.account.CurrentAccountProvider; import com.nextcloud.client.account.UserAccountManagerImpl; import com.owncloud.android.datamodel.ArbitraryDataProvider; import com.owncloud.android.datamodel.FileDataStorageManager; import com.owncloud.android.datamodel.OCFile; import com.owncloud.android.ui.activity.PassCodeActivity; import com.owncloud.android.ui.activity.SettingsActivity; import com.owncloud.android.utils.FileSortOrder; import java.util.Set; import java.util.concurrent.CopyOnWriteArraySet; import androidx.annotation.Nullable; import static com.owncloud.android.ui.fragment.OCFileListFragment.FOLDER_LAYOUT_LIST; /** * Implementation of application-wide preferences using {@link SharedPreferences}. * * Users should not use this class directly. Please use {@link AppPreferences} interafce * instead. */ public final class AppPreferencesImpl implements AppPreferences { /** * Constant to access value of last path selected by the user to upload a file shared from other app. * Value handled by the app without direct access in the UI. */ public static final String AUTO_PREF__LAST_SEEN_VERSION_CODE = "lastSeenVersionCode"; public static final String STORAGE_PATH = "storage_path"; public static final float DEFAULT_GRID_COLUMN = 4.0f; private static final String AUTO_PREF__LAST_UPLOAD_PATH = "last_upload_path"; private static final String AUTO_PREF__UPLOAD_FROM_LOCAL_LAST_PATH = "upload_from_local_last_path"; private static final String AUTO_PREF__UPLOAD_FILE_EXTENSION_MAP_URL = "prefs_upload_file_extension_map_url"; private static final String AUTO_PREF__UPLOAD_FILE_EXTENSION_URL = "prefs_upload_file_extension_url"; private static final String AUTO_PREF__UPLOADER_BEHAVIOR = "prefs_uploader_behaviour"; private static final String AUTO_PREF__GRID_COLUMNS = "grid_columns"; private static final String AUTO_PREF__SHOW_DETAILED_TIMESTAMP = "detailed_timestamp"; private static final String PREF__INSTANT_UPLOADING = "instant_uploading"; private static final String PREF__INSTANT_VIDEO_UPLOADING = "instant_video_uploading"; private static final String PREF__SHOW_HIDDEN_FILES = "show_hidden_files_pref"; private static final String PREF__LEGACY_CLEAN = "legacyClean"; private static final String PREF__KEYS_MIGRATION = "keysMigration"; private static final String PREF__FIX_STORAGE_PATH = "storagePathFix"; private static final String PREF__KEYS_REINIT = "keysReinit"; private static final String PREF__AUTO_UPLOAD_UPDATE_PATH = "autoUploadPathUpdate"; private static final String PREF__PUSH_TOKEN = "pushToken"; private static final String PREF__AUTO_UPLOAD_SPLIT_OUT = "autoUploadEntriesSplitOut"; private static final String PREF__AUTO_UPLOAD_INIT = "autoUploadInit"; private static final String PREF__FOLDER_SORT_ORDER = "folder_sort_order"; private static final String PREF__FOLDER_LAYOUT = "folder_layout"; static final String PREF__DARK_THEME_ENABLED = "dark_theme_enabled"; private static final String PREF__LOCK_TIMESTAMP = "lock_timestamp"; private static final String PREF__SHOW_MEDIA_SCAN_NOTIFICATIONS = "show_media_scan_notifications"; private static final String PREF__LOCK = SettingsActivity.PREFERENCE_LOCK; private static final String PREF__SELECTED_ACCOUNT_NAME = "select_oc_account"; private static final String PREF__MIGRATED_USER_ID = "migrated_user_id"; private static final String PREF__PHOTO_SEARCH_TIMESTAMP = "photo_search_timestamp"; private static final String PREF__POWER_CHECK_DISABLED = "power_check_disabled"; private final Context context; private final SharedPreferences preferences; private final CurrentAccountProvider currentAccountProvider; private final ListenerRegistry listeners; /** * Adapter delegating raw {@link SharedPreferences.OnSharedPreferenceChangeListener} calls * with key-value pairs to respective {@link com.nextcloud.client.preferences.AppPreferences.Listener} method. */ static class ListenerRegistry implements SharedPreferences.OnSharedPreferenceChangeListener { private final AppPreferences preferences; private final Set listeners; ListenerRegistry(AppPreferences preferences) { this.preferences = preferences; this.listeners = new CopyOnWriteArraySet<>(); } void add(@Nullable final Listener listener) { if (listener != null) { listeners.add(listener); } } void remove(@Nullable final Listener listener) { if (listener != null) { listeners.remove(listener); } } @Override public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) { if(PREF__DARK_THEME_ENABLED.equals(key)) { boolean enabled = preferences.isDarkThemeEnabled(); for(Listener l : listeners) { l.onDarkThemeEnabledChanged(enabled); } } } } /** * This is a temporary workaround to access app preferences in places that cannot use * dependency injection yet. Use injected component via {@link AppPreferences} interface. * * WARNING: this creates new instance! it does not return app-wide singleton * * @param context Context used to create shared preferences * @return New instance of app preferences component */ @Deprecated public static AppPreferences fromContext(Context context) { final CurrentAccountProvider currentAccountProvider = UserAccountManagerImpl.fromContext(context); final SharedPreferences prefs = android.preference.PreferenceManager.getDefaultSharedPreferences(context); return new AppPreferencesImpl(context, prefs, currentAccountProvider); } AppPreferencesImpl(Context appContext, SharedPreferences preferences, CurrentAccountProvider currentAccountProvider) { this.context = appContext; this.preferences = preferences; this.currentAccountProvider = currentAccountProvider; this.listeners = new ListenerRegistry(this); this.preferences.registerOnSharedPreferenceChangeListener(listeners); } @Override public void addListener(@Nullable AppPreferences.Listener listener) { this.listeners.add(listener); } @Override public void removeListener(@Nullable AppPreferences.Listener listener) { this.listeners.remove(listener); } @Override public void setKeysReInitEnabled() { preferences.edit().putBoolean(PREF__KEYS_REINIT, true).apply(); } @Override public boolean isKeysReInitEnabled() { return preferences.getBoolean(PREF__KEYS_REINIT, false); } @Override public void setPushToken(String pushToken) { preferences.edit().putString(PREF__PUSH_TOKEN, pushToken).apply(); } @Override public String getPushToken() { return preferences.getString(PREF__PUSH_TOKEN, ""); } @Override public boolean instantPictureUploadEnabled() { return preferences.getBoolean(PREF__INSTANT_UPLOADING, false); } @Override public boolean instantVideoUploadEnabled() { return preferences.getBoolean(PREF__INSTANT_VIDEO_UPLOADING, false); } @Override public boolean isShowHiddenFilesEnabled() { return preferences.getBoolean(PREF__SHOW_HIDDEN_FILES, false); } @Override public void setShowHiddenFilesEnabled(boolean enabled) { preferences.edit().putBoolean(PREF__SHOW_HIDDEN_FILES, enabled).apply(); } @Override public int getUploadUrlFileExtensionUrlSelectedPos() { return preferences.getInt(AUTO_PREF__UPLOAD_FILE_EXTENSION_URL, 0); } @Override public void setUploadUrlFileExtensionUrlSelectedPos(int selectedPos) { preferences.edit().putInt(AUTO_PREF__UPLOAD_FILE_EXTENSION_URL, selectedPos).apply(); } @Override public int getUploadMapFileExtensionUrlSelectedPos() { return preferences.getInt(AUTO_PREF__UPLOAD_FILE_EXTENSION_MAP_URL, 0); } @Override public void setUploadMapFileExtensionUrlSelectedPos(int selectedPos) { preferences.edit().putInt(AUTO_PREF__UPLOAD_FILE_EXTENSION_MAP_URL, selectedPos).apply(); } @Override public String getUploadFromLocalLastPath() { return preferences.getString(AUTO_PREF__UPLOAD_FROM_LOCAL_LAST_PATH, ""); } @Override public void setUploadFromLocalLastPath(String path) { preferences.edit().putString(AUTO_PREF__UPLOAD_FROM_LOCAL_LAST_PATH, path).apply(); } @Override public String getLastUploadPath() { return preferences.getString(AUTO_PREF__LAST_UPLOAD_PATH, ""); } @Override public void setLastUploadPath(String path) { preferences.edit().putString(AUTO_PREF__LAST_UPLOAD_PATH, path).apply(); } @Override public String getLockPreference() { return preferences.getString(PREF__LOCK, SettingsActivity.LOCK_NONE); } @Override public void setLockPreference(String lockPreference) { preferences.edit().putString(PREF__LOCK, lockPreference).apply(); } @Override public void setPassCode(String d1, String d2, String d3, String d4) { preferences .edit() .putString(PassCodeActivity.PREFERENCE_PASSCODE_D1, d1) .putString(PassCodeActivity.PREFERENCE_PASSCODE_D2, d2) .putString(PassCodeActivity.PREFERENCE_PASSCODE_D3, d3) .putString(PassCodeActivity.PREFERENCE_PASSCODE_D4, d4) .apply(); } @Override public String[] getPassCode() { return new String[] { preferences.getString(PassCodeActivity.PREFERENCE_PASSCODE_D1, null), preferences.getString(PassCodeActivity.PREFERENCE_PASSCODE_D2, null), preferences.getString(PassCodeActivity.PREFERENCE_PASSCODE_D3, null), preferences.getString(PassCodeActivity.PREFERENCE_PASSCODE_D4, null), }; } @Override public boolean isFingerprintUnlockEnabled() { return preferences.getBoolean(SettingsActivity.PREFERENCE_USE_FINGERPRINT, false); } @Override public String getFolderLayout(OCFile folder) { return getFolderPreference(context, currentAccountProvider.getCurrentAccount(), PREF__FOLDER_LAYOUT, folder, FOLDER_LAYOUT_LIST); } @Override public void setFolderLayout(OCFile folder, String layout_name) { setFolderPreference(context, currentAccountProvider.getCurrentAccount(), PREF__FOLDER_LAYOUT, folder, layout_name); } @Override public FileSortOrder getSortOrderByFolder(OCFile folder) { return FileSortOrder.sortOrders.get(getFolderPreference(context, currentAccountProvider.getCurrentAccount(), PREF__FOLDER_SORT_ORDER, folder, FileSortOrder.sort_a_to_z.name)); } @Override public void setSortOrder(OCFile folder, FileSortOrder sortOrder) { setFolderPreference(context, currentAccountProvider.getCurrentAccount(), PREF__FOLDER_SORT_ORDER, folder, sortOrder.name); } @Override public FileSortOrder getSortOrderByType(FileSortOrder.Type type) { return getSortOrderByType(type, FileSortOrder.sort_a_to_z); } @Override public FileSortOrder getSortOrderByType(FileSortOrder.Type type, FileSortOrder defaultOrder) { Account account = currentAccountProvider.getCurrentAccount(); if (account == null) { return defaultOrder; } ArbitraryDataProvider dataProvider = new ArbitraryDataProvider(context.getContentResolver()); String value = dataProvider.getValue(account.name, PREF__FOLDER_SORT_ORDER + "_" + type); return value.isEmpty() ? defaultOrder : FileSortOrder.sortOrders.get(value); } @Override public void setSortOrder(FileSortOrder.Type type, FileSortOrder sortOrder) { Account account = currentAccountProvider.getCurrentAccount(); if (account == null) { throw new IllegalArgumentException("Account may not be null!"); } ArbitraryDataProvider dataProvider = new ArbitraryDataProvider(context.getContentResolver()); dataProvider.storeOrUpdateKeyValue(account.name, PREF__FOLDER_SORT_ORDER + "_" + type, sortOrder.name); } @Override public boolean isLegacyClean() { return preferences.getBoolean(PREF__LEGACY_CLEAN, false); } @Override public void setLegacyClean(boolean isLegacyClean) { preferences.edit().putBoolean(PREF__LEGACY_CLEAN, isLegacyClean).apply(); } @Override public boolean isKeysMigrationEnabled() { return preferences.getBoolean(PREF__KEYS_MIGRATION, false); } @Override public void setKeysMigrationEnabled(boolean keysMigration) { preferences.edit().putBoolean(PREF__KEYS_MIGRATION, keysMigration).apply(); } @Override public boolean isStoragePathFixEnabled() { return preferences.getBoolean(PREF__FIX_STORAGE_PATH, false); } @Override public void setStoragePathFixEnabled(boolean storagePathFixEnabled) { preferences.edit().putBoolean(PREF__FIX_STORAGE_PATH, storagePathFixEnabled).apply(); } @Override public boolean isAutoUploadPathsUpdateEnabled() { return preferences.getBoolean(PREF__AUTO_UPLOAD_UPDATE_PATH, false); } @Override public void setAutoUploadPathsUpdateEnabled(boolean pathUpdate) { preferences.edit().putBoolean(PREF__AUTO_UPLOAD_UPDATE_PATH, pathUpdate).apply(); } @Override public boolean isAutoUploadSplitEntriesEnabled() { return preferences.getBoolean(PREF__AUTO_UPLOAD_SPLIT_OUT, false); } @Override public void setAutoUploadSplitEntriesEnabled(boolean splitOut) { preferences.edit().putBoolean(PREF__AUTO_UPLOAD_SPLIT_OUT, splitOut).apply(); } @Override public boolean isAutoUploadInitialized() { return preferences.getBoolean(PREF__AUTO_UPLOAD_INIT, false); } @Override public void setAutoUploadInit(boolean autoUploadInit) { preferences.edit().putBoolean(PREF__AUTO_UPLOAD_INIT, autoUploadInit).apply(); } @Override public int getUploaderBehaviour() { return preferences.getInt(AUTO_PREF__UPLOADER_BEHAVIOR, 1); } @Override public void setDarkThemeEnabled(boolean enabled) { preferences.edit().putBoolean(PREF__DARK_THEME_ENABLED, enabled).apply(); } @Override public boolean isDarkThemeEnabled() { return preferences.getBoolean(PREF__DARK_THEME_ENABLED, false); } @Override public void setUploaderBehaviour(int uploaderBehaviour) { preferences.edit().putInt(AUTO_PREF__UPLOADER_BEHAVIOR, uploaderBehaviour).apply(); } /** * Gets the grid columns which the user has set last. * * @return grid columns grid columns */ @Override public float getGridColumns() { float columns = preferences.getFloat(AUTO_PREF__GRID_COLUMNS, DEFAULT_GRID_COLUMN); if (columns < 0) { return DEFAULT_GRID_COLUMN; } else { return columns; } } /** * Saves the grid columns which the user has set last. * * @param gridColumns the uploader behavior */ @Override public void setGridColumns(float gridColumns) { preferences.edit().putFloat(AUTO_PREF__GRID_COLUMNS, gridColumns).apply(); } @Override public int getLastSeenVersionCode() { return preferences.getInt(AUTO_PREF__LAST_SEEN_VERSION_CODE, 0); } @Override public void setLastSeenVersionCode(int versionCode) { preferences.edit().putInt(AUTO_PREF__LAST_SEEN_VERSION_CODE, versionCode).apply(); } @Override public long getLockTimestamp() { return preferences.getLong(PREF__LOCK_TIMESTAMP, 0); } @Override public void setLockTimestamp(long timestamp) { preferences.edit().putLong(PREF__LOCK_TIMESTAMP, timestamp).apply(); } @Override public boolean isShowDetailedTimestampEnabled() { return preferences.getBoolean(AUTO_PREF__SHOW_DETAILED_TIMESTAMP, false); } @Override public void setShowDetailedTimestampEnabled(boolean showDetailedTimestamp) { preferences.edit().putBoolean(AUTO_PREF__SHOW_DETAILED_TIMESTAMP, showDetailedTimestamp).apply(); } @Override public boolean isShowMediaScanNotifications() { return preferences.getBoolean(PREF__SHOW_MEDIA_SCAN_NOTIFICATIONS, true); } @Override public void setShowMediaScanNotifications(boolean value) { preferences.edit().putBoolean(PREF__SHOW_MEDIA_SCAN_NOTIFICATIONS, value).apply(); } @Override public void removeLegacyPreferences() { preferences.edit() .remove("instant_uploading") .remove("instant_video_uploading") .remove("instant_upload_path") .remove("instant_upload_path_use_subfolders") .remove("instant_upload_on_wifi") .remove("instant_upload_on_charging") .remove("instant_video_upload_path") .remove("instant_video_upload_path_use_subfolders") .remove("instant_video_upload_on_wifi") .remove("instant_video_uploading") .remove("instant_video_upload_on_charging") .remove("prefs_instant_behaviour") .apply(); } @Override public void clear() { preferences.edit().clear().apply(); } @Override public String getStoragePath(String defaultPath) { return preferences.getString(STORAGE_PATH, defaultPath); } @SuppressLint("ApplySharedPref") @Override public void setStoragePath(String path) { preferences.edit().putString(STORAGE_PATH, path).commit(); // commit synchronously } /** * Removes keys migration key from shared preferences. */ @SuppressLint("ApplySharedPref") @Override public void removeKeysMigrationPreference() { preferences.edit().remove(AppPreferencesImpl.PREF__KEYS_MIGRATION).commit(); // commit synchronously } @Override public String getCurrentAccountName() { return preferences.getString(PREF__SELECTED_ACCOUNT_NAME, null); } @Override public void setCurrentAccountName(String accountName) { preferences.edit().putString(PREF__SELECTED_ACCOUNT_NAME, accountName).apply(); } @Override public boolean isUserIdMigrated() { return preferences.getBoolean(PREF__MIGRATED_USER_ID, false); } @Override public void setMigratedUserId(boolean value) { preferences.edit().putBoolean(PREF__MIGRATED_USER_ID, value).apply(); } @Override public void setPhotoSearchTimestamp(long timestamp) { preferences.edit().putLong(PREF__PHOTO_SEARCH_TIMESTAMP, timestamp).apply(); } @Override public long getPhotoSearchTimestamp() { return preferences.getLong(PREF__PHOTO_SEARCH_TIMESTAMP, 0); } /** * Get preference value for a folder. * If folder is not set itself, it finds an ancestor that is set. * * @param context Context object. * @param preferenceName Name of the preference to lookup. * @param folder Folder. * @param defaultValue Fallback value in case no ancestor is set. * @return Preference value */ private static String getFolderPreference(final Context context, final Account account, final String preferenceName, final OCFile folder, final String defaultValue) { if (account == null) { return defaultValue; } ArbitraryDataProvider dataProvider = new ArbitraryDataProvider(context.getContentResolver()); FileDataStorageManager storageManager = new FileDataStorageManager(account, context.getContentResolver()); String value = dataProvider.getValue(account.name, getKeyFromFolder(preferenceName, folder)); OCFile prefFolder = folder; while (prefFolder != null && value.isEmpty()) { prefFolder = storageManager.getFileById(prefFolder.getParentId()); value = dataProvider.getValue(account.name, getKeyFromFolder(preferenceName, prefFolder)); } return value.isEmpty() ? defaultValue : value; } /** * Set preference value for a folder. * * @param context Context object. * @param preferenceName Name of the preference to set. * @param folder Folder. * @param value Preference value to set. */ private static void setFolderPreference(final Context context, final Account account, final String preferenceName, final OCFile folder, final String value) { if (account == null) { throw new IllegalArgumentException("Account may not be null!"); } ArbitraryDataProvider dataProvider = new ArbitraryDataProvider(context.getContentResolver()); dataProvider.storeOrUpdateKeyValue(account.name, getKeyFromFolder(preferenceName, folder), value); } private static String getKeyFromFolder(String preferenceName, OCFile folder) { final String folderIdString = String.valueOf(folder != null ? folder.getFileId() : FileDataStorageManager.ROOT_PARENT_ID); return preferenceName + "_" + folderIdString; } @Override public boolean isPowerCheckDisabled() { return preferences.getBoolean(PREF__POWER_CHECK_DISABLED, false); } @Override public void setPowerCheckDisabled(boolean value) { preferences.edit().putBoolean(PREF__POWER_CHECK_DISABLED, value).apply(); } }