hebdobot/src/org/april/hebdobot/bot/hooks/HelpHook.java

/**
 * Copyright (C) 2018 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.bot.hooks;

import org.apache.commons.lang3.StringUtils;
import org.april.hebdobot.bot.Hebdobot;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

    /* (non-Javadoc)
     * @see org.april.hebdobot.bot.hooks.Hook#attemptProcess(org.april.hebdobot.bot.Hebdobot, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
     */
    @Override
    public boolean attemptProcess(final Hebdobot bot, final String channel, final String sender, final String login, final String hostname,
            final String message)
    {
        boolean result;

        if (StringUtils.equalsAnyIgnoreCase(message, "!aide", "!help"))
        {
            logger.info("!help caught.");

            // Help.
            bot.sendMessage(sender, "Bienvenue " + sender);
            bot.sendMessage(sender, "Je suis " + bot.getName() + ", le robot de gestion des revues hebdomadaires de l'APRIL.");
            bot.sendMessage(sender, "Voici les commandes que je comprends :");
            bot.sendMessage(sender, " ");
            bot.sendMessage(sender, "  !aide,!help   : afficher cette aide");
            bot.sendMessage(sender, "  !début        : commencer une nouvelle revue");
            bot.sendMessage(sender, "  # titre       : démarrer un sujet individuel");
            bot.sendMessage(sender, "  ## titre      : démarrer un sujet collectif");
            bot.sendMessage(sender, "  % message     : traiter comme un commentaire");
            bot.sendMessage(sender, "  !courant      : afficher le sujet en cours");
            bot.sendMessage(sender, "  !manquants    : afficher qui n'a pas participé sur le dernier sujet");
            bot.sendMessage(sender, "  !fin          : terminer la revue en cours");
            bot.sendMessage(sender, "  !stop         : abandonner la revue en cours");
            bot.sendMessage(sender, "  !licence      : afficher la licence du logiciel Hebdobot et le lien vers ses sources");
            bot.sendMessage(sender, "  !record       : affiche le record de participation à la revue");
            bot.sendMessage(sender, "  !stats        : statistiques sur les précédentes revues");
            bot.sendMessage(sender, "  !version      : afficher la version d'Hebdobot");
            bot.sendMessage(sender, " ");
            bot.sendMessage(sender, "Autres commandes de dialogue : !bonjour, !date, !hello, !merci, !salut");

            result = true;
        }
        else
        {
            result = false;
        }

        //
        return result;
    }
}