MyPreferences.java

/*******************************************************************************
 * Copyright (c) 2010 Denis Solonenko.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * <p/>
 * Contributors:
 * Denis Solonenko - initial API and implementation
 * Rodrigo Sousa - google docs backup
 * Abdsandryk Souza - report preferences
 ******************************************************************************/
package ru.orangesoftware.financisto2.utils;

import android.content.Context;
import android.content.SharedPreferences;
import android.content.pm.PackageManager;
import android.content.res.Configuration;
import android.content.res.Resources;
import android.preference.PreferenceManager;
import android.util.Log;

import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Locale;

import ru.orangesoftware.financisto2.export.Export;
import ru.orangesoftware.financisto2.model.Currency;
import ru.orangesoftware.financisto2.rates.ExchangeRateProvider;
import ru.orangesoftware.financisto2.rates.ExchangeRateProviderFactory;

import static ru.orangesoftware.financisto2.utils.AndroidUtils.isGreenDroidSupported;

public class MyPreferences {

    public static final String DROPBOX_AUTH_TOKEN = "dropbox_auth_token";
    public static final String DROPBOX_AUTHORIZE = "dropbox_authorize";

    public enum AccountSortOrder {
        NAME("title", true),
        LAST_TRANSACTION_ASC("lastTransactionDate", true),
        LAST_TRANSACTION_DESC("lastTransactionDate", false);

        public final String property;
        public final boolean asc;

        AccountSortOrder(String property, boolean asc) {
            this.property = property;
            this.asc = asc;
        }
    }

    public enum StartupScreen {
        ACCOUNTS("accounts"),
        BLOTTER("blotter"),
        BUDGETS("budgets"),
        REPORTS("reports");

        public final String tag;

        StartupScreen(String tag) {
            this.tag = tag;
        }
    }

    private static Method hasSystemFeatureMethod;

    static {
        // hack for 1.5/1.6 devices
        try {
            hasSystemFeatureMethod = PackageManager.class.getMethod("hasSystemFeature", String.class);
        } catch (NoSuchMethodException ex) {
            hasSystemFeatureMethod = null;
        }

    }

    public static boolean isPinProtected(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("pin_protection", false);
    }

    public static boolean isPinProtectedNewTransaction(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("pin_protection_lock_transaction", true);
    }

    public static boolean isPinLockEnabled(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return isPinProtected(context) && sharedPreferences.getBoolean("pin_protection_lock", true);
    }

    public static int getLockTimeSeconds(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return isPinLockEnabled(context) ? 60 * Integer.parseInt(sharedPreferences.getString("pin_protection_lock_time", "5")) : 0;
    }

    public static String getPin(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("pin", null);
    }

    public static AccountSortOrder getAccountSortOrder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        String sortOrder = sharedPreferences.getString("sort_accounts", AccountSortOrder.LAST_TRANSACTION_DESC.name());
        return AccountSortOrder.valueOf(sortOrder);
    }

    public static long getLastAccount(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getLong("last_account_id", -1);
    }

    public static void setLastAccount(Context context, long accountId) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        sharedPreferences.edit().putLong("last_account_id", accountId).apply();
    }

    public static boolean isRememberAccount(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("remember_last_account", true);
    }

    public static boolean isRememberCategory(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("remember_last_category", false);
    }

    public static boolean isRememberProject(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("remember_last_project", false);
    }

    public static boolean isShowTakePicture(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return isCameraSupported(context) && sharedPreferences.getBoolean("ntsl_show_picture", true);
    }

    public static boolean isShowCategoryInTransferScreen(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_category_in_transfer", true);
    }

    public static boolean isShowPayee(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_payee", true);
    }

    public static boolean isShowPayeeInTransfers(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_payee_in_transfers", false);
    }

    public static boolean isShowCurrency(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_currency", true);
    }

    public static int getPayeeOrder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return Integer.parseInt(sharedPreferences.getString("ntsl_show_payee_order", "1"));
    }

    public static boolean isShowIsCCardPayment(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_is_ccard_payment", true);
    }

    public static boolean isOpenCalculatorForTemplates(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_open_calculator_for_template_transactions", true);
    }

    /**
     * Get google docs user login registered on preferences
     */
    public static String getUserLogin(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("user_login", null);
    }

    /**
     * Get google docs user password registered on preferences
     */
    public static String getUserPassword(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("user_password", null);
    }

    /**
     * Get google docs backup folder registered on preferences
     */
    public static String getBackupFolder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("backup_folder", "financisto");
    }

    /**
     * Gets the string representing reference currency registered on preferences to display chart reports.
     *
     * @param context The activity context
     * @return The string representing the currency registered as a reference to display chart reports or null if not configured yet.
     */
    public static String getReferenceCurrencyTitle(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("report_reference_currency", "");
    }

    /**
     * Gets the reference currency registered on preferences to display chart reports.
     *
     * @param context The activity context
     * @return The currency registered as a reference to display chart reports or null if not configured yet.
     */
    public static Currency getReferenceCurrency(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);

        Collection<Currency> currencies = CurrencyCache.getAllCurrencies();
        Currency cur = null;
        try {
            String refCurrency = sharedPreferences.getString("report_reference_currency", null);
            if (currencies != null && currencies.size() > 0) {
                for (Currency currency : currencies) {
                    if (currency.title.equals(refCurrency)) cur = currency;
                }
            }
        } catch (Exception e) {
            return null;
        }
        return cur;
    }

    /**
     * Gets the period of reference (number of Months to display the 2D report) registered on preferences.
     *
     * @param context The activity context
     * @return The number of months registered as a period of reference to display chart reports or 0 if not configured yet.
     */
    public static int getPeriodOfReference(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        String p = sharedPreferences.getString("report_reference_period", "0");
        return Integer.parseInt(p);
    }

    /**
     * Gets the reference month.
     *
     * @param context The activity context.
     * @return The reference month that represents the end of the report period.
     */
    public static int getReferenceMonth(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        String month = sharedPreferences.getString("report_reference_month", "0");
        return Integer.parseInt(month);
    }

    /**
     * Gets the flag that indicates if the sub categories will be available individually in 2D report or not.
     *
     * @param context The activity context.
     * @return True if the sub categories shall be displayed in the Report 2D list of categories, false otherwise.
     */
    public static boolean includeSubCategoriesInReport(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("report_include_sub_categories", true);
    }

    /**
     * Gets the flag that indicates if the list of filter ids will include No Filter (no category, no project or current location) or not.
     *
     * @param context The activity context.
     * @return True if no category, no project and current location shall be displayed in 2D Reports, false otherwise.
     */
    public static boolean includeNoFilterInReport(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("report_include_no_filter", true);
    }

    /**
     * Get the flag that indicates if the category monthly result will consider the result of its sub categories or not.
     *
     * @param context The activity context.
     * @return True if the category result shall include the result of its categories, false otherwise.
     */
    public static boolean addSubCategoriesToSum(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("report_add_sub_categories_result", false);
    }

    /**
     * Gets the flag that indicates if the statistics calculation will consider null values or not.
     *
     * @param context The activity context.
     * @return True if the null values shall impact the statistics, false otherwise.
     */
    public static boolean considerNullResultsInReport(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("report_consider_null_results", true);
    }

    public static boolean isShowNote(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_note", true);
    }

    public static int getNoteOrder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return Integer.parseInt(sharedPreferences.getString("ntsl_show_note_order", "3"));
    }

    public static boolean isShowProject(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_show_project", true);
    }

    public static int getProjectOrder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return Integer.parseInt(sharedPreferences.getString("ntsl_show_project_order", "4"));
    }

    public static boolean isUseFixedLayout(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("ntsl_use_fixed_layout", true);
    }

    public static boolean isWidgetEnabled(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("enable_widget", true);
    }

    public static boolean isIncludeTransfersIntoReports(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("include_transfers_into_reports", false);
    }

    public static boolean isRestoreMissedScheduledTransactions(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("restore_missed_scheduled_transactions", true);
    }

    public static boolean isShowRunningBalance(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("show_running_balance", true);
    }

    private static final String DEFAULT = "default";

    public static void switchLocale(Context context, String locale) {
        if (DEFAULT.equals(locale)) {
            switchLocale(context, Locale.getDefault());
        } else {
            String[] a = locale.split("-");
            String language = a[0];
            String country = a.length > 1 ? a[1] : null;
            Locale newLocale = country != null ? new Locale(language, country) : new Locale(language);
            switchLocale(context, newLocale);
        }
    }

    private static void switchLocale(Context context, Locale locale) {
        Resources resources = context.getApplicationContext().getResources();
        Configuration configuration = resources.getConfiguration();
        configuration.locale = locale;
        resources.updateConfiguration(configuration, resources.getDisplayMetrics());
        Log.i("MyPreferences", "Switching locale to " + configuration.locale.getDisplayName());
    }

    public static boolean isCameraSupported(Context context) {
        return isFeatureSupported(context, PackageManager.FEATURE_CAMERA);
    }

    public static boolean isAutoBackupEnabled(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("auto_backup_enabled", false);
    }

    public static int getAutoBackupTime(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getInt("auto_backup_time", 600);
    }

    public static boolean isCollapseBlotterButtons(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean("collapse_blotter_buttons", false);
    }

    private static boolean isFeatureSupported(Context context, String feature) {
        if (hasSystemFeatureMethod != null) {
            PackageManager pm = context.getPackageManager();
            try {
                return (Boolean) hasSystemFeatureMethod.invoke(pm, feature);
            } catch (Exception e) {
                Log.w("Financisto", "Some problems executing PackageManager.hasSystemFeature(" + feature + ")", e);
                return false;
            }
        }
        Log.i("Financisto", "It's an old device - no PackageManager.hasSystemFeature");
        return true;
    }

    public static boolean shouldRebuildRunningBalance(Context context) {
        return getOneTimeFlag(context, "should_rebuild_running_balance");
    }

    public static boolean shouldUpdateHomeCurrency(Context context) {
        return getOneTimeFlag(context, "should_update_home_currency");
    }

    public static boolean shouldUpdateAccountsLastTransactionDate(Context context) {
        return getOneTimeFlag(context, "should_update_accounts_last_transaction_date");
    }

    private static boolean getOneTimeFlag(Context context, String name) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        boolean result = sharedPreferences.getBoolean(name, true);
        if (result) {
            sharedPreferences.edit().putBoolean(name, false).apply();
        }
        return result;
    }

    public static String getDatabaseBackupFolder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("database_backup_folder", Export.DEFAULT_EXPORT_PATH.getAbsolutePath());
    }

    public static void setDatabaseBackupFolder(Context context, String databaseBackupFolder) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        sharedPreferences.edit().putString("database_backup_folder", databaseBackupFolder).apply();
    }

    public static String[] getReportPreferences(Context context) {
        String[] preferences = new String[7];
        preferences[0] = getReferenceCurrencyTitle(context);
        preferences[1] = Integer.toString(getPeriodOfReference(context));
        preferences[2] = Integer.toString(getReferenceMonth(context));
        preferences[3] = Boolean.toString(considerNullResultsInReport(context));
        preferences[4] = Boolean.toString(includeNoFilterInReport(context));
        preferences[5] = Boolean.toString(includeSubCategoriesInReport(context));
        preferences[6] = Boolean.toString(addSubCategoriesToSum(context));
        return preferences;
    }

    public static boolean isQuickMenuEnabledForAccount(Context context) {
        return getBoolean(context, "quick_menu_account_enabled", true) && isGreenDroidSupported();
    }

    public static boolean isQuickMenuEnabledForTransaction(Context context) {
        return getBoolean(context, "quick_menu_transaction_enabled", true) && isGreenDroidSupported();
    }

    public static void storeDropboxToken(Context context, String token) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        sharedPreferences.edit()
                .putString(DROPBOX_AUTH_TOKEN, token)
                .putBoolean(DROPBOX_AUTHORIZE, true)
                .apply();
    }

    public static String getDropboxToken(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString(DROPBOX_AUTH_TOKEN, null);
    }

    public static void removeDropboxKeys(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        sharedPreferences.edit()
                .remove(DROPBOX_AUTH_TOKEN)
                .remove(DROPBOX_AUTHORIZE)
                .apply();
    }

    public static boolean isDropboxAuthorized(Context context) {
        return getBoolean(context, DROPBOX_AUTHORIZE, false);
    }

    public static boolean isDropboxUploadBackups(Context context) {
        return isDropboxAuthorized(context) && getBoolean(context, "dropbox_upload_backup", false);
    }

    public static boolean isDropboxUploadAutoBackups(Context context) {
        return isDropboxAuthorized(context) && getBoolean(context, "dropbox_upload_autobackup", false);
    }

    public static boolean isUseHierarchicalCategorySelector(Context context) {
        return getBoolean(context, "use_hierarchical_category_selector", true);
    }

    public static boolean isAutoSelectChildCategory(Context context) {
        return getBoolean(context, "hierarchical_category_selector_select_child_immediately", true);
    }

    public static boolean isSeparateIncomeExpense(Context context) {
        return getBoolean(context, "hierarchical_category_selector_income_expense", false);
    }

    public static boolean isShowAccountLastTransactionDate(Context context) {
        return getBoolean(context, "show_account_last_transaction_date", true);
    }

    public static boolean isHideClosedAccounts(Context context) {
        return getBoolean(context, "hide_closed_accounts", false);
    }

    public static boolean isPinHapticFeedbackEnabled(Context context) {
        return getBoolean(context, "pin_protection_haptic_feedback", true);
    }

    public static StartupScreen getStartupScreen(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        String screen = sharedPreferences.getString("startup_screen", StartupScreen.ACCOUNTS.name());
        return StartupScreen.valueOf(screen);
    }

    public static ExchangeRateProvider createExchangeRatesProvider(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        ExchangeRateProviderFactory factory = getExchangeRateProviderFactory(sharedPreferences);
        return factory.createProvider(sharedPreferences);
    }

    private static ExchangeRateProviderFactory getExchangeRateProviderFactory(SharedPreferences sharedPreferences) {
        String provider = sharedPreferences.getString("exchange_rate_provider", ExchangeRateProviderFactory.webservicex.name());
        return ExchangeRateProviderFactory.valueOf(provider);
    }

    public static boolean isOpenExchangeRatesProviderSelected(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return getExchangeRateProviderFactory(sharedPreferences) == ExchangeRateProviderFactory.openexchangerates;
    }

    private static boolean getBoolean(Context context, String name, boolean defaultValue) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getBoolean(name, defaultValue);
    }

    public static String getGoogleDriveFolder(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("googledrive_folder", "financial_docs");
    }

    public static boolean doGoogleDriveUpload(Context context) {
        return getBoolean(context, "googledrive_upload", false);
    }

    public static boolean isAutoSync(Context context) {
        return getBoolean(context, "auto_sync_enabled", false);
    }

    public static String getGoogleDriveAccount(Context context) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        return sharedPreferences.getString("google_drive_backup_account", null);
    }

    public static void setGoogleDriveAccount(Context context, String accountName) {
        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
        sharedPreferences.edit().putString("google_drive_backup_account", accountName).apply();
    }

    public static boolean isGoogleDriveFullReadonly(Context context) {
        return getBoolean(context, "google_drive_backup_full_readonly", false);
    }

}