src/com/android/telecomm/PhoneAccountRegistrar.java

/*
 * Copyright (C) 2014 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.telecomm;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;

import android.content.ComponentName;
import android.content.Context;

import android.content.SharedPreferences;
import android.net.Uri;
import android.telecomm.PhoneAccount;
import android.telecomm.PhoneAccountMetadata;
import android.telecomm.TelecommManager;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * Handles writing and reading PhoneAccount registration entries. This is a simple verbatim
 * delegate for all the account handling methods on {@link TelecommManager} as implemented in
 * {@link TelecommServiceImpl}, with the notable exception that {@link TelecommServiceImpl} is
 * responsible for security checking to make sure that the caller has proper authority over
 * the {@code ComponentName}s they are declaring in their {@code PhoneAccount}s.
 *
 * TODO(santoscordon): Replace this implementation with a proper database stored in a Telecomm
 * provider.
 */
final class PhoneAccountRegistrar {
    private static final String TELECOMM_PREFERENCES = "telecomm_prefs";
    private static final String PREFERENCE_PHONE_ACCOUNTS = "phone_accounts";

    private final Context mContext;

    PhoneAccountRegistrar(Context context) {
        mContext = context;
    }

    public PhoneAccount getDefaultOutgoingPhoneAccount() {
        State s = read();
        return s.mDefaultOutgoing;
    }

    public void setDefaultOutgoingPhoneAccount(PhoneAccount account) {
        State s = read();

        if (account == null) {
            // Asking to clear the default outgoing is a valid request
            s.mDefaultOutgoing = null;
        } else {
            boolean found = false;
            for (PhoneAccountMetadata m : s.mAccounts) {
                if (Objects.equals(account, m.getAccount())) {
                    found = true;
                    break;
                }
            }

            if (!found) {
                Log.d(this, "Trying to set nonexistent default outgoing phone account %s", account);
                return;
            }

            s.mDefaultOutgoing = account;
        }

        write(s);
    }

    public List<PhoneAccount> getEnabledPhoneAccounts() {
        State s = read();
        return accountsOnly(s);
    }

    public PhoneAccountMetadata getPhoneAccountMetadata(PhoneAccount account) {
        State s = read();
        for (PhoneAccountMetadata m : s.mAccounts) {
            if (Objects.equals(account, m.getAccount())) {
                return m;
            }
        }
        return null;
    }

    // TODO: Should we implement an artificial limit for # of accounts associated with a single
    // ComponentName?
    public void registerPhoneAccount(PhoneAccountMetadata metadata) {
        State s = read();

        s.mAccounts.add(metadata);
        // Search for duplicates and remove any that are found.
        for (int i = 0; i < s.mAccounts.size() - 1; i++) {
            if (Objects.equals(metadata.getAccount(), s.mAccounts.get(i).getAccount())) {
                // replace existing entry.
                s.mAccounts.remove(i);
                break;
            }
        }

        write(s);
    }

    public void unregisterPhoneAccount(PhoneAccount account) {
        State s = read();

        for (int i = 0; i < s.mAccounts.size(); i++) {
            if (Objects.equals(account, s.mAccounts.get(i).getAccount())) {
                s.mAccounts.remove(i);
                break;
            }
        }

        checkDefaultOutgoing(s);

        write(s);
    }

    public void clearAccounts(String packageName) {
        State s = read();

        for (int i = 0; i < s.mAccounts.size(); i++) {
            if (Objects.equals(
                    packageName,
                    s.mAccounts.get(i).getAccount().getComponentName().getPackageName())) {
                s.mAccounts.remove(i);
            }
        }

        checkDefaultOutgoing(s);

        write(s);
    }

    private void checkDefaultOutgoing(State s) {
        // Check that, after an operation that removes accounts, the account set up as the "default
        // outgoing" has not been deleted. If it has, then clear out the setting.
        for (PhoneAccountMetadata m : s.mAccounts) {
            if (Objects.equals(s.mDefaultOutgoing, m.getAccount())) {
                return;
            }
        }
        s.mDefaultOutgoing = null;
    }

    private List<PhoneAccount> accountsOnly(State s) {
        List<PhoneAccount> result = new ArrayList<>();
        for (PhoneAccountMetadata m : s.mAccounts) {
            result.add(m.getAccount());
        }
        return result;
    }

    private State read() {
        try {
            String serialized = getPreferences().getString(PREFERENCE_PHONE_ACCOUNTS, null);
            Log.d(this, "read() obtained serialized state: %s", serialized);
            State state = serialized == null
                    ? new State()
                    : deserializeState(serialized);
            Log.d(this, "read() obtained state: %s", state);
            return state;
        } catch (Exception e) {
            Log.e(this, e, "read");
            throw new RuntimeException(e);
        }
    }

    private boolean write(State state) {
        try {
            Log.d(this, "write() writing state: %s", state);
            String serialized = serializeState(state);
            Log.d(this, "write() writing serialized state: %s", serialized);
            boolean success = getPreferences()
                    .edit()
                    .putString(PREFERENCE_PHONE_ACCOUNTS, serialized)
                    .commit();
            Log.d(this, "serialized state was written with succcess = %b", success);
            return success;
        } catch (Exception e) {
            Log.e(this, e, "write");
            throw new RuntimeException(e);
        }
    }

    private SharedPreferences getPreferences() {
        return mContext.getSharedPreferences(TELECOMM_PREFERENCES, Context.MODE_PRIVATE);
    }

    private String serializeState(State s) throws JSONException {
        // TODO: If this is used in production, remove the indent (=> do not pretty print)
        return sStateJson.toJson(s).toString(2);
    }

    private State deserializeState(String s) throws JSONException {
        return sStateJson.fromJson(new JSONObject(new JSONTokener(s)));
    }

    private static class State {
        PhoneAccount mDefaultOutgoing = null;
        final List<PhoneAccountMetadata> mAccounts = new ArrayList<>();
    }

    //
    // JSON serialization
    //

    private interface Json<T> {
        JSONObject toJson(T o) throws JSONException;
        T fromJson(JSONObject json) throws JSONException;
    }

    private static final Json<State> sStateJson =
            new Json<State>() {
        private static final String DEFAULT_OUTGOING = "default_outgoing";
        private static final String ACCOUNTS = "accounts";

        @Override
        public JSONObject toJson(State o) throws JSONException {
            JSONObject json = new JSONObject();
            if (o.mDefaultOutgoing != null) {
                json.put(DEFAULT_OUTGOING, sPhoneAccountJson.toJson(o.mDefaultOutgoing));
            }
            JSONArray accounts = new JSONArray();
            for (PhoneAccountMetadata m : o.mAccounts) {
                accounts.put(sPhoneAccountMetadataJson.toJson(m));
            }
            json.put(ACCOUNTS, accounts);
            return json;
        }

        @Override
        public State fromJson(JSONObject json) throws JSONException {
            State s = new State();
            if (json.has(DEFAULT_OUTGOING)) {
                s.mDefaultOutgoing = sPhoneAccountJson.fromJson(
                        (JSONObject) json.get(DEFAULT_OUTGOING));
            }
            if (json.has(ACCOUNTS)) {
                JSONArray accounts = (JSONArray) json.get(ACCOUNTS);
                for (int i = 0; i < accounts.length(); i++) {
                    try {
                        s.mAccounts.add(sPhoneAccountMetadataJson.fromJson(
                                (JSONObject) accounts.get(i)));
                    } catch (Exception e) {
                        Log.e(this, e, "Extracting phone account");
                    }
                }
            }
            return s;
        }
    };

    private static final Json<PhoneAccountMetadata> sPhoneAccountMetadataJson =
            new Json<PhoneAccountMetadata>() {
        private static final String ACCOUNT = "account";
        private static final String HANDLE = "handle";
        private static final String CAPABILITIES = "capabilities";
        private static final String ICON_RES_ID = "icon_res_id";
        private static final String LABEL = "label";
        private static final String SHORT_DESCRIPTION = "short_description";
        private static final String VIDEO_CALLING_SUPPORTED = "video_calling_supported";

        @Override
        public JSONObject toJson(PhoneAccountMetadata o) throws JSONException {
            return new JSONObject()
                    .put(ACCOUNT, sPhoneAccountJson.toJson(o.getAccount()))
                    .put(HANDLE, o.getHandle().toString())
                    .put(CAPABILITIES, o.getCapabilities())
                    .put(ICON_RES_ID, o.getIconResId())
                    .put(LABEL, o.getLabel())
                    .put(SHORT_DESCRIPTION, o.getShortDescription())
                    .put(VIDEO_CALLING_SUPPORTED, (Boolean) o.isVideoCallingSupported());
        }

        @Override
        public PhoneAccountMetadata fromJson(JSONObject json) throws JSONException {
            return new PhoneAccountMetadata(
                    sPhoneAccountJson.fromJson((JSONObject) json.get(ACCOUNT)),
                    Uri.parse((String) json.get(HANDLE)),
                    (int) json.get(CAPABILITIES),
                    (int) json.get(ICON_RES_ID),
                    (String) json.get(LABEL),
                    (String) json.get(SHORT_DESCRIPTION),
                    (Boolean) json.get(VIDEO_CALLING_SUPPORTED));
        }
    };

    private static final Json<PhoneAccount> sPhoneAccountJson =
            new Json<PhoneAccount>() {
        private static final String COMPONENT_NAME = "component_name";
        private static final String ID = "id";

        @Override
        public JSONObject toJson(PhoneAccount o) throws JSONException {
            return new JSONObject()
                    .put(COMPONENT_NAME, o.getComponentName().flattenToString())
                    .put(ID, o.getId());
        }

        @Override
        public PhoneAccount fromJson(JSONObject json) throws JSONException {
            return new PhoneAccount(
                    ComponentName.unflattenFromString((String) json.get(COMPONENT_NAME)),
                    (String) json.get(ID));
        }
    };
}