DMDirc-Plugins/identd/src/main/java/com/dmdirc/addons/identd/IdentdServer.java

/*
 * Copyright (c) 2006-2015 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.addons.identd;

import com.dmdirc.config.GlobalConfig;
import com.dmdirc.interfaces.ConnectionManager;
import com.dmdirc.interfaces.config.AggregateConfigProvider;
import com.dmdirc.plugins.PluginDomain;
import com.dmdirc.util.SystemInfo;
import java.io.IOException;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.ArrayList;
import java.util.List;
import javax.inject.Inject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.dmdirc.util.LogUtils.USER_ERROR;

/**
 * The IdentdServer watches over the ident port when required
 */
public final class IdentdServer implements Runnable {

    private static final Logger LOG = LoggerFactory.getLogger(IdentdServer.class);
    /** The Thread in use for this server */
    private volatile Thread myThread;
    /** The current socket in use for this server */
    private ServerSocket serverSocket;
    /** Arraylist of all the clients we have */
    private final List<IdentClient> clientList = new ArrayList<>();
    /** Server manager. */
    private final ConnectionManager connectionManager;
    /** Have we failed to start this server previously? */
    private boolean failed;
    /** Global configuration to read plugin's from. */
    private final AggregateConfigProvider config;
    /** This plugin's config settings domain. */
    private final String domain;
    /** System info wrapper to use for the ident client. */
    private final SystemInfo systemInfo;

    /**
     * Create the IdentdServer.
     *
     * @param connectionManager Server manager to iterate over servers
     * @param config        Global config
     * @param domain        This plugin's setting domain
     */
    @Inject
    public IdentdServer(final ConnectionManager connectionManager,
            @GlobalConfig final AggregateConfigProvider config,
            @PluginDomain(IdentdPlugin.class) final String domain,
            final SystemInfo systemInfo) {
        this.connectionManager = connectionManager;
        this.config = config;
        this.domain = domain;
        this.systemInfo = systemInfo;
    }

    /**
     * Run this IdentdServer.
     */
    @Override
    public void run() {
        final Thread thisThread = Thread.currentThread();
        while (myThread == thisThread) {
            try {
                final Socket clientSocket = serverSocket.accept();
                final IdentClient client = new IdentClient(this, clientSocket, connectionManager,
                        config, domain, systemInfo);
                client.start();
                addClient(client);
            } catch (IOException e) {
                if (myThread == thisThread) {
                    LOG.error(USER_ERROR, "Accepting client failed: {}", e.getMessage(), e);
                }
            }
        }
    }

    /**
     * Add an IdentClient to the clientList
     *
     * @param client Client to add
     */
    public void addClient(final IdentClient client) {
        synchronized (clientList) {
            clientList.add(client);
        }
    }

    /**
     * Remove an IdentClient from the clientList
     *
     * @param client Client to remove
     */
    public void delClient(final IdentClient client) {
        synchronized (clientList) {
            for (int i = 0; i < clientList.size(); ++i) {
                if (clientList.get(i) == client) {
                    clientList.remove(i);
                    break;
                }
            }
        }
    }

    /**
     * Check if the server is currently running
     *
     * @return True if the server is running
     */
    public boolean isRunning() {
        return myThread != null;
    }

    /**
     * Start the ident server
     */
    public void startServer() {
        if (!failed && myThread == null) {
            try {
                final int identPort = config.getOptionInt(domain, "advanced.port");
                serverSocket = new ServerSocket(identPort);
                myThread = new Thread(this);
                myThread.start();
            } catch (IOException e) {
                LOG.error(USER_ERROR, "Unable to start identd server: {}", e.getMessage(), e);
                if ("Permission denied".equals(e.getMessage())) {
                    failed = true;
                }
            }
        }
    }

    /**
     * Stop the ident server
     */
    public void stopServer() {
        if (myThread != null) {
            final Thread tmpThread = myThread;
            myThread = null;
            if (tmpThread != null) {
                tmpThread.interrupt();
            }
            try {
                serverSocket.close();
            } catch (IOException e) {
                LOG.info("Unable to close socket: {}", e.getMessage(), e);
            }

            synchronized (clientList) {
                clientList.forEach(IdentClient::close);
                clientList.clear();
            }
        }
    }

}