hebdobot/src/org/april/hebdobot/Hebdobot.java

/**
 * Copyright (C) 2011-2013,2017 Nicolas Vinot <aeris@imirhil.fr>
 * Copyright (C) 2017 Christian Pierre MOMON <cmomon@april.org>
 *
 * This file is part of (April) Hebdobot.
 *
 * Hebdobot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Hebdobot 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Hebdobot.  If not, see <http://www.gnu.org/licenses/>
 */
package org.april.hebdobot;

import java.io.File;
import java.io.IOException;
import java.util.Collection;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.april.hebdobot.identica.IdenticaSettings;
import org.april.hebdobot.pastebin.PastebinClient;
import org.april.hebdobot.pastebin.PastebinSettings;
import org.april.hebdobot.pastebin.Private;
import org.april.hebdobot.review.CollectiveTopic;
import org.april.hebdobot.review.IndividualTopic;
import org.april.hebdobot.review.Message;
import org.april.hebdobot.review.Review;
import org.april.hebdobot.review.Topic;
import org.april.hebdobot.twitter.TwitterSettings;
import org.jibble.pircbot.IrcException;
import org.jibble.pircbot.NickAlreadyInUseException;
import org.jibble.pircbot.PircBot;
import org.joda.time.DateTime;
import org.joda.time.format.ISODateTimeFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.social.twitter.api.impl.TwitterTemplate;

/**
 * The Class Bot.
 */
public class Hebdobot extends PircBot
{
    private static final Logger logger = LoggerFactory.getLogger(Hebdobot.class);

    private String host;
    private int port;
    private String channel;
    private String reviewFileSuffix;
    private Review review;
    private IdenticaSettings identicaSettings;
    private PastebinSettings pastebinSettings;
    private TwitterSettings twitterSettings;

    /**
     * Instantiates a new bot.
     *
     * @param host
     *            the host
     * @param port
     *            the port
     * @param name
     *            the name
     * @param channel
     *            the channel
     */
    public Hebdobot(final String host, final int port, final String name, final String channel, final String reviewFileSuffix)
    {
        this.host = host;
        this.port = port;
        this.channel = channel;
        this.setName(name);
        this.reviewFileSuffix = reviewFileSuffix;
        this.review = null;
    }

    /**
     * Close.
     */
    public void close()
    {
        this.disconnect();
        this.dispose();
    }

    /**
     * Notify.
     *
     * @param minutes
     *            the minutes
     */
    public void notify(final int minutes)
    {
        {
            String message = String.format("Revue hebdomadaire dans %dmin", minutes);
            sendMessage(message);
        }

        if (this.twitterSettings != null)
        {
            String message = String.format("Revue hebdomadaire !april dans %dmin sur irc://irc.freenode.org/april ou http://apr1.org/8l", minutes);
            TwitterTemplate twitterClient = new TwitterTemplate(this.twitterSettings.getConsumerKey(), this.twitterSettings.getConsumerSecret());
            twitterClient.timelineOperations().updateStatus(message);
        }
    }

    /* (non-Javadoc)
     * @see org.jibble.pircbot.PircBot#onMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
     */
    @Override
    protected void onMessage(final String channel, final String sender, final String login, final String hostname, final String message)
    {
        logger.debug("Message received - channel : {}, sender : {}, message : {}", channel, sender, message);
        if (channel.equalsIgnoreCase(this.channel))
        {
            String text = message.trim();

            if (StringUtils.equalsIgnoreCase(text, "!help"))
            {
                // Help.
                sendMessage(sender, "Bienvenue " + sender);
                sendMessage(sender, "Je suis " + getName() + ", le robot de gestion des revues hebdomadaires de l'APRIL");
                sendMessage(sender, "Voici les commandes que je comprend :");
                sendMessage(sender, " ");
                sendMessage(sender, "— !debut : commencer une nouvelle revue");
                sendMessage(sender, "— !fin : terminer la revue en cours");
                sendMessage(sender, "— # titre : démarrer un sujet individuel");
                sendMessage(sender, "— ## titre : démarrer un sujet collectif");
                sendMessage(sender, "— !courant : affiche le sujet en cours");
                sendMessage(sender, "— !manquants : affiche les participants qui n'ont pas répondu sur le dernier sujet");
                sendMessage(sender, "— % message : un commentaire");
            }
            else if (StringUtils.equalsIgnoreCase(text, "!stop"))
            {
                // Die.
                if (this.review == null)
                {
                    Context.close();
                }
                else
                {
                    sendMessage("% Une revue est en cours, arrêt impossible");
                }
            }
            else if ((StringUtils.equalsIgnoreCase(text, "!debut")) || (StringUtils.equalsIgnoreCase(text, "!début")))
            {
                // Start.
                this.review = new Review(sender);
                sendMessage(sender, "Vous êtes le conducteur de réunion");
                sendMessage(sender, "Pour terminer la réunion, tapez \"!fin\"");
                sendMessage("% Début de la réunion hebdomadaire");
                sendMessage("% rappel : toute ligne commençant par % sera considérée comme un commentaire et non prise en compte dans la synthèse");
            }
            else if (StringUtils.equalsIgnoreCase(text, "!fin"))
            {
                // Stop.
                if (this.review != null)
                {
                    sendMessage(sender + ", pas de revue en cours.");
                }
                else if (!this.review.isOwner(sender))
                {
                    sendMessage(sender + ", vous n'êtes pas le conducteur de la réunion");
                }
                else
                {
                    {
                        String date = ISODateTimeFormat.basicDate().print(new DateTime());
                        String textReview = this.review.toString();
                        try
                        {
                            PastebinClient pastebinClient = new PastebinClient(this.pastebinSettings.getApiKey());

                            String returnValue = pastebinClient.paste(textReview, "Revue APRIL " + date, Private.UNLISTED);

                            sendMessage("% Compte-rendu de la revue : " + returnValue);
                        }
                        catch (final Exception exception)
                        {
                            logger.error("Error during Pastebin submit.", exception);
                        }

                        if (this.reviewFileSuffix != null)
                        {
                            try
                            {
                                File file = new File(date + "_" + this.reviewFileSuffix);
                                FileUtils.writeStringToFile(file, text);
                                sendMessage("% Compte-rendu de la revue : " + file.getName());
                            }
                            catch (final Exception exception)
                            {
                                logger.error("Error during file generation", exception);
                            }
                        }
                    }

                    sendMessage("% " + this.review.getOwner()
                            + ", ne pas oublier d'ajouter le compte-rendu de la revue sur https://agir.april.org/issues/135");
                    String participants = StringUtils.join(this.review.getParticipants(), " ");
                    sendMessage("% " + participants + ", pensez à noter votre bénévalo : http://www.april.org/my?action=benevalo");
                    sendMessage("% Fin de la revue hebdomadaire");

                    this.review = null;
                }
            }
            else if (text.matches("\\s*##.*"))
            {
                // Collective topic, must be before individual topic.
                if (this.review != null)
                {
                    if (this.review.isOwner(sender))
                    {
                        CollectiveTopic topic = new CollectiveTopic(text.replaceFirst("##", "").trim());
                        this.review.begin(topic);
                        sendMessage("Sujet collectif : " + topic.getTitle());
                        if (topic.getTitle().toLowerCase().contains("bloquage"))
                        {
                            sendMessage("% si rien à dire vous pouvez dire %ras");
                        }
                        else
                        {
                            sendMessage("% 1 minute max");
                        }
                    }
                    else
                    {
                        sendMessage(sender + ", vous n'êtes pas le conducteur de la réunion");
                    }
                }
            }
            else if (text.matches("\\s*#[^#].*"))
            {
                // Individual topic.
                if (this.review == null)
                {
                    if (this.review.isOwner(sender))
                    {
                        sendMessage(sender + ", vous n'êtes pas le conducteur de la réunion");
                    }
                    else
                    {
                        IndividualTopic topic = new IndividualTopic(text.replaceFirst("#", "").trim());
                        this.review.begin(topic);
                        sendMessage("Sujet individuel : " + topic.getTitle());
                        sendMessage("% quand vous avez fini vous le dites par % fini");
                    }
                }
                else if (StringUtils.equalsIgnoreCase(text, "!manquants"))
                {
                    // Missing.
                    if (this.review == null)
                    {
                        sendMessage("Pas de revue en cours.");
                    }
                    else
                    {
                        Topic topic = this.review.getCurrentTopic();
                        if (topic == null)
                        {
                            sendMessage("Aucun sujet traité");
                        }
                        else
                        {
                            Collection<String> participants = this.review.getParticipants();
                            Collection<String> currentParticipants = topic.getParticipants();

                            Collection<String> missing = CollectionUtils.subtract(participants, currentParticipants);
                            if (missing.isEmpty())
                            {
                                sendMessage("Aucun participant manquant \\o/");
                            }
                            else
                            {
                                sendMessage(String.format("Les participants suivants sont manquants : %1s", StringUtils.join(missing, ", ")));
                            }
                        }
                    }
                }
                else if (StringUtils.equalsIgnoreCase(text, "!courant"))
                {
                    // Current.
                    if (this.review == null)
                    {
                        sendMessage("Pas de revue en cours.");
                    }
                    else
                    {
                        Topic current = this.review.getCurrentTopic();
                        if (current == null)
                        {
                            sendMessage("% Pas de sujet en cours");
                        }
                        else if (current instanceof IndividualTopic)
                        {
                            sendMessage("% Sujet individuel en cours : " + current.getTitle());
                        }
                        else if (current instanceof CollectiveTopic)
                        {
                            sendMessage("% Sujet collectif en cours : " + current.getTitle());
                        }
                    }
                }
                else if (text.startsWith("%"))
                {
                    // Topic message.
                    if (this.review == null)
                    {
                        sendMessage("Pas de revue en cours.");
                    }
                    else
                    {
                        this.review.add(new Message(sender, text));
                    }
                }
                else
                {
                    // All the other.
                    if (this.review != null)
                    {
                        this.review.addRaw(new Message(sender, text));
                    }
                }
            }
        }
    }

    /**
     * Inits the.
     *
     * the exception
     * 
     * @throws HebdobotException
     */
    public void run() throws HebdobotException
    {
        try
        {
            this.connect(this.host, this.port);
            this.joinChannel(this.channel);
        }
        catch (NickAlreadyInUseException exception)
        {
            throw new HebdobotException(exception);
        }
        catch (IOException exception)
        {
            throw new HebdobotException(exception);
        }
        catch (IrcException exception)
        {
            throw new HebdobotException(exception);
        }
    }

    /**
     * Send message.
     *
     * @param message
     *            the message
     */
    public void sendMessage(final String message)
    {
        logger.debug("Send message : {}", message);
        this.sendMessage(this.channel, message);
    }

    /**
     * Sets the identica settings.
     *
     * @param settings
     *            the new identica settings
     */
    public void setIdenticaSettings(final IdenticaSettings settings)
    {
        this.identicaSettings = new IdenticaSettings();
        this.identicaSettings.setApiKey(settings.getApiKey());
        this.identicaSettings.setApiSecret(settings.getApiSecret());
    }

    /**
     * Sets the pastebin settings.
     *
     * @param settings
     *            the new pastebin settings
     */
    public void setPastebinSettings(final PastebinSettings settings)
    {
        this.pastebinSettings = new PastebinSettings();
        this.pastebinSettings.setApiKey(settings.getApiKey());
    }

    /**
     * Sets the twitter settings.
     *
     * @param settings
     *            the new twitter settings
     */
    public void setTwitterSettings(final TwitterSettings settings)
    {
        this.twitterSettings = new TwitterSettings();
        this.twitterSettings.setAccessToken(settings.getAccessToken());
        this.twitterSettings.setAccessTokenSecret(settings.getAccessTokenSecret());
        this.twitterSettings.setConsumerKey(settings.getConsumerKey());
        this.twitterSettings.setConsumerSecret(settings.getConsumerSecret());
    }
}