ConfigHelper.java

/*******************************************************************************
 * Copyright 2011 The Regents of the University of California
 * 
 * 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 org.ohmage;

import android.content.Context;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;

/**
 * Preference helper for application wide settings. Any user specific settings
 * are specified in {@link UserPreferencesHelper} which is cleared on logout
 * 
 * @author cketcham
 */
public class ConfigHelper {

    private static final String KEY_VERSION_CODE = "version_code";
    private static final String KEY_IS_FIRST_RUN = "is_first_run";
    private static final String KEY_MOBILITY_VERSION = "mobility_version";
    private static final String KEY_SERVER_URL = "key_server_url";
    private static final String KEY_ADMIN_MODE = "key_admin_mode";
    private static final String KEY_LOG_LEVEL = "key_log_level";
    private static final String KEY_LOG_ANALYTICS = "keg_log_analytics";

    private static String serverUrl;
    private final SharedPreferences mPreferences;
    private final Context mContext;

    public ConfigHelper(Context context) {
        mContext = context;
        mPreferences = getSharedPreferences(context);
    }

    private static SharedPreferences getSharedPreferences(Context context) {
        return PreferenceManager.getDefaultSharedPreferences(context);
    }

    public int getLastVersionCode() {
        return mPreferences.getInt(KEY_VERSION_CODE, -1);
    }

    public boolean setLastVersionCode(int versionCode) {
        return mPreferences.edit().putInt(KEY_VERSION_CODE, versionCode).commit();
    }

    public boolean isFirstRun() {
        return mPreferences.getBoolean(KEY_IS_FIRST_RUN, true);
    }

    public boolean setFirstRun(boolean isFirstRun) {
        return mPreferences.edit().putBoolean(KEY_IS_FIRST_RUN, isFirstRun).commit();
    }

    public int getLastMobilityVersion() {
        return mPreferences.getInt(KEY_MOBILITY_VERSION, -1);
    }

    public boolean setMobilityVersion(int mobilityVersion) {
        return mPreferences.edit().putInt(KEY_MOBILITY_VERSION, mobilityVersion).commit();
    }

    public static void setServerUrl(String url) {
        serverUrl = url;
        PreferenceManager.getDefaultSharedPreferences(OhmageApplication.getContext()).edit()
                .putString(KEY_SERVER_URL, url).commit();
    }

    public static String serverUrl() {
        if (serverUrl == null)
            serverUrl = PreferenceManager.getDefaultSharedPreferences(
                    OhmageApplication.getContext()).getString(KEY_SERVER_URL, null);
        return serverUrl;
    }

    public static boolean isSingleCampaignMode() {
        UserPreferencesHelper prefHelper = new UserPreferencesHelper(OhmageApplication.getContext());
        return prefHelper.isSingleCampaignMode();
    }

    public boolean adminMode() {
        return mPreferences.getBoolean(KEY_ADMIN_MODE,
                mContext.getResources().getBoolean(R.bool.admin_mode));
    }

    public void setAdminMode(Boolean value) {
        mPreferences.edit().putBoolean(KEY_ADMIN_MODE, value).commit();
    }

    public String getLogLevel() {
        return mPreferences.getString(KEY_LOG_LEVEL,
                mContext.getResources().getString(R.string.log_level));
    }

    public void setLogLevel(String level) {
        mPreferences.edit().putString(KEY_LOG_LEVEL, level).commit();
    }

    public Boolean getLogAnalytics() {
        return mPreferences.getBoolean(KEY_LOG_ANALYTICS,
                mContext.getResources().getBoolean(R.bool.log_analytics));
    }

    public void setLogAnalytics(Boolean value) {
        mPreferences.edit().putBoolean(KEY_LOG_ANALYTICS, value).commit();
    }

    /**
     * Clears all settings specific to deployments
     */
    public void clearDeploymentSettings() {
        setLogAnalytics(mContext.getResources().getBoolean(R.bool.log_analytics));
        setLogLevel(mContext.getResources().getString(R.string.log_level));
        setAdminMode(mContext.getResources().getBoolean(R.bool.admin_mode));
    }
}