DMDirc-Plugins/channelwho/src/main/java/com/dmdirc/addons/channelwho/ConnectionHandler.java

/*
 * Copyright (c) 2006-2017 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.channelwho;

import com.dmdirc.config.ConfigBinder;
import com.dmdirc.config.ConfigBinding;
import com.dmdirc.events.ChannelUserAwayEvent;
import com.dmdirc.events.DisplayProperty;
import com.dmdirc.events.ServerNumericEvent;
import com.dmdirc.interfaces.Connection;
import com.dmdirc.interfaces.EventBus;
import com.dmdirc.interfaces.GroupChat;
import com.dmdirc.interfaces.GroupChatUser;
import com.dmdirc.interfaces.config.AggregateConfigProvider;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.Multimap;

import java.util.Optional;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

import net.engio.mbassy.listener.Handler;

/**
 * Responsible for managing timers and settings required to who any {@link GroupChat}s on a
 * {@link Connection} as specified by the user.
 */
public class ConnectionHandler {

    private final Multimap<String, GroupChatUser> users;
    private final EventBus eventBus;
    private final Connection connection;
    private final String domain;
    private final ScheduledExecutorService executorService;
    private final ConfigBinder configBinder;
    private ScheduledFuture<?> future;

    public ConnectionHandler(
            final AggregateConfigProvider config,
            final ScheduledExecutorService executorService,
            final EventBus eventBus,
            final String domain,
            final Connection connection) {
        this.eventBus = eventBus;
        this.connection = connection;
        this.domain = domain;
        this.executorService = executorService;
        configBinder = config.getBinder().withDefaultDomain(domain);
        users = HashMultimap.create();
    }

    public void load() {
        configBinder.bind(this, ConnectionHandler.class);
        connection.getWindowModel().getEventBus().subscribe(this);
    }

    public void unload() {
        configBinder.unbind(this);
        executorService.shutdown();
        connection.getWindowModel().getEventBus().unsubscribe(this);
        if (future != null) {
            future.cancel(false);
        }
    }

    @VisibleForTesting
    void checkWho() {
        connection.getGroupChatManager().getChannels().forEach(channel -> {
            if (channel.getWindowModel().getConfigManager().getOptionBool(domain, "sendwho")) {
                channel.requestUsersInfo();
            }
        });
    }

    @VisibleForTesting
    @ConfigBinding(key="whointerval")
    void handleWhoInterval(final int value) {
        if (future != null) {
            future.cancel(false);
        }
        future = executorService.scheduleAtFixedRate(this::checkWho, value, value,
                TimeUnit.MILLISECONDS);
    }

    @VisibleForTesting
    @Handler
    void handleAwayEvent(final ChannelUserAwayEvent event) {
        if (event.getChannel().getConnection().equals(Optional.of(connection))
                && !event.getReason().isPresent()) {
            event.setDisplayProperty(DisplayProperty.DO_NOT_DISPLAY, true);
            final boolean notseen = !users.containsKey(event.getUser().getNickname());
            users.put(event.getUser().getNickname(), event.getUser());
            if (notseen) {
                event.getChannel().getConnection()
                        .ifPresent(c -> c.requestUserInfo(event.getUser().getUser()));
            }
        }
    }

    @VisibleForTesting
    @Handler
    void handleServerNumericEvent(final ServerNumericEvent event) {
        if (event.getConnection().equals(connection) && event.getNumeric() == 301) {
            final String nickname = event.getArgs()[3];
            final String reason = event.getArgs()[4];
            users.removeAll(nickname).forEach(u -> eventBus.publishAsync(
                new ChannelUserAwayEvent(u.getGroupChat(), u, Optional.ofNullable(reason))));
        }
    }
}