ImportKeysList.java

/*
 * Copyright (C) 2014 Tim Bray <tbray@textuality.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

package org.sufficientlysecure.keychain.keyimport;

import java.util.ArrayList;
import java.util.Collection;

/**
 * Just an ArrayList, only with a synchronized dupe-merging add/addAll, and a sign-off method
 */
public class ImportKeysList extends ArrayList<ImportKeysListEntry> {

    private int mSupplierCount;

    public ImportKeysList(int supplierCount) {
        mSupplierCount = supplierCount;
    }

    @Override
    public boolean add(ImportKeysListEntry toAdd) {
        addOrMerge(toAdd);
        return true; // that’s what the ArrayList#add contract says
    }

    @Override
    public boolean addAll(Collection<? extends ImportKeysListEntry> addThese) {
        boolean modified = false;
        for (ImportKeysListEntry toAdd : addThese) {
            modified = addOrMerge(toAdd) || modified;
        }
        return modified;
    }

    // NOTE: side-effects
    // NOTE: synchronized
    private synchronized boolean addOrMerge(ImportKeysListEntry toAdd) {
        for (ImportKeysListEntry existing : this) {
            if (toAdd.hasSameKeyAs(existing)) {
                return mergeDupes(toAdd, existing);
            }
        }
        return super.add(toAdd);
    }

    // being a little anal about the ArrayList#addAll contract here
    private boolean mergeDupes(ImportKeysListEntry incoming, ImportKeysListEntry existing) {
        boolean modified = false;

        // if any source thinks it’s expired/revoked, it is
        if (incoming.isRevoked()) {
            existing.setRevoked(true);
            modified = true;
        }
        if (incoming.isExpired()) {
            existing.setExpired(true);
            modified = true;
        }
        if (!incoming.isSecure()) {
            existing.setSecure(false);
            modified = true;
        }

        if (incoming.getKeyserver() != null) {
            existing.setKeyserver(incoming.getKeyserver());
            // Mail addresses returned by HKP servers are preferred over keybase.io IDs
            existing.setPrimaryUserId(incoming.getPrimaryUserId());

            modified = true;
        } else if (incoming.getKeybaseName() != null) {
            // to work properly, Keybase-sourced/Facebook-sourced entries need to pass along the
            // identifying name/id
            existing.setKeybaseName(incoming.getKeybaseName());
            modified = true;
        } else if (incoming.getFbUsername() != null) {
            existing.setFbUsername(incoming.getFbUsername());
            modified = true;
        }

        if (existing.addUserIds(incoming.getUserIds()))
            modified = true;

        return modified;
    }

    // NOTE: synchronized
    public synchronized void finishedAdding() {
        mSupplierCount--;
        if (mSupplierCount == 0) {
            this.notify();
        }
    }

    public int outstandingSuppliers() {
        return mSupplierCount;
    }
}