DMDirc-Parser/src/com/dmdirc/parser/irc/IRCAuthenticator.java

/*
 * Copyright (c) 2006-2011 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.dmdirc.parser.irc;

import java.net.Authenticator;
import java.net.PasswordAuthentication;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Semaphore;

/**
 * Handles proxy authentication for the parser.
 *
 * @see IRCParser
 */
public final class IRCAuthenticator extends Authenticator {

    /**
     * A version number for this class. It should be changed whenever the class
     * structure is changed (or anything else that would prevent serialized
     * objects being unserialized with the new class).
     */
    private static final long serialVersionUID = 1;
    /** Singleton instance of IRCAuthenticator. */
    private static IRCAuthenticator me;
    /** List of authentication replies. */
    private final Map<String, PasswordAuthentication> replies = new HashMap<String, PasswordAuthentication>();
    /** List of servers for each host. */
    private final Map<String, List<ServerInfo>> owners = new HashMap<String, List<ServerInfo>>();
    /** Semaphore for connection limiting. */
    private final Semaphore mySemaphore = new Semaphore(1, true);

    /**
     * Create a new IRCAuthenticator.
     *
     * This creates an IRCAuthenticator and registers it as the default
     * Authenticator.
     */
    private IRCAuthenticator() {
        super();

        Authenticator.setDefault(this);
    }

    /**
     * Get the instance of IRCAuthenticator.
     *
     * @return The IRCAuthenticator instance.
     */
    public static synchronized IRCAuthenticator getIRCAuthenticator() {
        if (me == null) {
            me = new IRCAuthenticator();
        } else {
            // Make ourself the default authenticator again just incase.
            Authenticator.setDefault(me);
        }
        return me;
    }

    /**
     * Add a server to authenticate for.
     *
     * @param server ServerInfo object with proxy details.
     */
    public void addAuthentication(final ServerInfo server) {
        final String username = server.getProxyUser();
        final String password = server.getProxyPass();

        if (username == null || password == null || username.isEmpty() || password.isEmpty()) {
            return;
        }

        final String host = server.getProxyHost();
        final int port = server.getProxyPort();
        final PasswordAuthentication pass = new PasswordAuthentication(username, password.toCharArray());
        final String fullhost = host.toLowerCase() + ":" + port;

        // Delete old username/password if one exists and then add the new one
        replies.remove(fullhost);
        replies.put(fullhost, pass);

        // Store which servers are associated with which proxy
        final List<ServerInfo> servers = owners.containsKey(fullhost) ? owners.get(fullhost) : new ArrayList<ServerInfo>();
        owners.remove(fullhost);
        servers.add(server);
        owners.put(fullhost, servers);
    }

    /**
     * Get a copy of the semaphore.
     *
     * @return the IRCAuthenticator semaphore.
     */
    public Semaphore getSemaphore() {
        return mySemaphore;
    }

    /**
     * Remove a server to authenticate for.
     *
     * @param server ServerInfo object with proxy details.
     */
    public void removeAuthentication(final ServerInfo server) {
        final String host = server.getProxyHost();
        final int port = server.getProxyPort();

        final String fullhost = host.toLowerCase() + ":" + port;

        // See if any other servers are associated with this proxy.
        final List<ServerInfo> servers = owners.containsKey(fullhost) ? owners.get(fullhost) : new ArrayList<ServerInfo>();
        servers.remove(server);

        if (servers.isEmpty()) {
            // No more servers need this authentication info, remove.
            owners.remove(fullhost);
            replies.remove(fullhost);
        }
    }

    /** {@inheritDoc} */
    @Override
    protected PasswordAuthentication getPasswordAuthentication() {
        /*
         * getRequestingHost: 85.234.138.2
         * getRequestingPort: 1080
         * getRequestingPrompt: SOCKS authentication
         * getRequestingProtocol: SOCKS5
         * getRequestingScheme: null
         * getRequestingSite: /85.234.138.2
         * getRequestingURL: null
         * getRequestorType: SERVER
         */

        final String fullhost = getRequestingHost().toLowerCase() + ":" + getRequestingPort();
        return replies.get(fullhost);
    }
}