DMDirc-Client/src/com/dmdirc/ui/core/feedback/CoreFeedbackDialogModel.java

/*
 * Copyright (c) 2006-2014 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.ui.core.feedback;

import com.dmdirc.ClientModule;
import com.dmdirc.commandline.CommandLineOptionsModule.Directory;
import com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
import com.dmdirc.interfaces.Connection;
import com.dmdirc.interfaces.ConnectionManager;
import com.dmdirc.interfaces.config.AggregateConfigProvider;
import com.dmdirc.interfaces.ui.FeedbackDialogModel;
import com.dmdirc.interfaces.ui.FeedbackDialogModelListener;
import com.dmdirc.util.ClientInfo;
import com.dmdirc.util.collections.ListenerList;
import com.dmdirc.util.validators.NotEmptyValidator;
import com.dmdirc.util.validators.OptionalEmailAddressValidator;
import com.dmdirc.util.validators.PermissiveValidator;
import com.dmdirc.util.validators.Validator;

import java.nio.file.Path;
import java.util.Optional;

import javax.inject.Inject;

/**
 * Default implementation of a feedback dialog module.
 */
public class CoreFeedbackDialogModel implements FeedbackDialogModel {

    private final FeedbackSenderFactory feedbackSenderFactory;
    private final ListenerList listeners;
    private final AggregateConfigProvider config;
    private final ConnectionManager connectionManager;
    private final Path configDirectory;
    private final ClientInfo clientInfo;
    private Optional<String> name;
    private Optional<String> email;
    private Optional<String> feedback;
    private boolean includeServerInfo;
    private boolean includeDMDircInfo;

    @Inject
    public CoreFeedbackDialogModel(@ClientModule.GlobalConfig final AggregateConfigProvider config,
            final ConnectionManager connectionManager, final FeedbackSenderFactory feedbackSenderFactory,
            @Directory(DirectoryType.BASE) final Path configDirectory,
            final ClientInfo clientInfo) {
        this.connectionManager = connectionManager;
        this.configDirectory = configDirectory;
        this.feedbackSenderFactory = feedbackSenderFactory;
        this.config = config;
        this.clientInfo = clientInfo;
        this.listeners = new ListenerList();
        name = Optional.empty();
        email = Optional.empty();
        feedback = Optional.empty();
        includeServerInfo = false;
        includeDMDircInfo = false;
    }

    @Override
    public Optional<String> getName() {
        return name;
    }

    @Override
    public void setName(final Optional<String> name) {
        this.name = name;
        listeners.getCallable(FeedbackDialogModelListener.class).nameChanged(name);
    }

    @Override
    public boolean isNameValid() {
        return !getNameValidator().validate(name.orElse("")).isFailure();
    }

    @Override
    public Validator<String> getNameValidator() {
        return new PermissiveValidator<>();
    }

    @Override
    public Optional<String> getEmail() {
        return email;
    }

    @Override
    public void setEmail(final Optional<String> email) {
        this.email = email;
        listeners.getCallable(FeedbackDialogModelListener.class).emailChanged(email);
    }

    @Override
    public boolean isEmailValid() {
        return !getEmailValidator().validate(email.orElse("")).isFailure();
    }

    @Override
    public Validator<String> getEmailValidator() {
        return new OptionalEmailAddressValidator();
    }

    @Override
    public Optional<String> getFeedback() {
        return feedback;
    }

    @Override
    public void setFeedback(final Optional<String> feedback) {
        this.feedback = feedback;
        listeners.getCallable(FeedbackDialogModelListener.class).feedbackChanged(feedback);
    }

    @Override
    public boolean isFeedbackValid() {
        return !getFeedbackValidator().validate(feedback.orElse("")).isFailure();
    }

    @Override
    public Validator<String> getFeedbackValidator() {
        return new NotEmptyValidator();
    }

    @Override
    public boolean getIncludeServerInfo() {
        return includeServerInfo;
    }

    @Override
    public void setIncludeServerInfo(final boolean includeServerInfo) {
        this.includeServerInfo = includeServerInfo;
        listeners.getCallable(FeedbackDialogModelListener.class).includeServerInfoChanged(
                includeServerInfo);
    }

    @Override
    public boolean getIncludeDMDircInfo() {
        return includeDMDircInfo;
    }

    @Override
    public void setIncludeDMDircInfo(final boolean includeDMDircInfo) {
        this.includeDMDircInfo = includeDMDircInfo;
        listeners.getCallable(FeedbackDialogModelListener.class).includeDMDircInfoChanged(
                includeDMDircInfo);
    }

    @Override
    public boolean isSaveAllowed() {
        return isNameValid() && isEmailValid() && isFeedbackValid();
    }

    @Override
    public void save() {
        final StringBuilder serverInfo = new StringBuilder(255);
        final StringBuilder dmdircInfo = new StringBuilder(255);
        if (getIncludeServerInfo()) {
            for (Connection connection : connectionManager.getConnections()) {
                if (connection.getState().isDisconnected()) {
                    continue;
                }
                serverInfo.append("Actual name: ").append(connection.getParser()
                        .getServerName()).append('\n');
                serverInfo.append("Network: ").append(connection.getNetwork())
                        .append('\n');
                serverInfo.append("IRCd: ").append(connection.getParser()
                        .getServerSoftware()).append(" - ");
                serverInfo.append(connection.getParser().getServerSoftwareType())
                        .append('\n');
                serverInfo.append("Modes: ").append(connection.getParser()
                        .getBooleanChannelModes()).append(' ');
                serverInfo.append(connection.getParser().getListChannelModes())
                        .append(' ');
                serverInfo.append(connection.getParser().getParameterChannelModes())
                        .append(' ');
                serverInfo.append(connection.getParser().
                        getDoubleParameterChannelModes());
            }
        }
        if (getIncludeDMDircInfo()) {
            dmdircInfo.append("DMDirc version: ").append(clientInfo.getVersionInformation())
                    .append('\n');
            dmdircInfo.append("Profile directory: ").append(configDirectory).append('\n');
            dmdircInfo.append("Java version: ").append(clientInfo.getJavaInformation())
                    .append('\n');
            dmdircInfo.append("OS Version: ").append(clientInfo.getOperatingSystemInformation());
        }
        final FeedbackSender sender = feedbackSenderFactory.getFeedbackSender(
                name.orElse(""), email.orElse(""), feedback.orElse(""),
                config.getOption("version", "version"),
                serverInfo.toString(), dmdircInfo.toString());
        new Thread(sender, "Feedback Sender").start();
    }

    @Override
    public void addListener(final FeedbackDialogModelListener listener) {
        listeners.add(FeedbackDialogModelListener.class, listener);
    }

    @Override
    public void removeListener(final FeedbackDialogModelListener listener) {
        listeners.remove(FeedbackDialogModelListener.class, listener);
    }

}