netkorp / spring-boot-telegram-framework

import com.github.netkorp.telegram.framework.annotations.TelegramCommand;

import com.github.netkorp.telegram.framework.commands.abstracts.AbstractSimpleCommand;

import com.github.netkorp.telegram.framework.commands.interfaces.Command;

import com.github.netkorp.telegram.framework.commands.interfaces.HelpCommand;

import com.github.netkorp.telegram.framework.condition.ExcludeCondition;

import com.github.netkorp.telegram.framework.exceptions.CommandNotFound;

import com.github.netkorp.telegram.framework.managers.CommandManager;

import com.github.netkorp.telegram.framework.managers.SecurityManager;

import org.apache.logging.log4j.util.Strings;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;

import org.springframework.context.NoSuchMessageException;

import org.springframework.context.annotation.Conditional;

import org.springframework.context.i18n.LocaleContextHolder;

import org.telegram.telegrambots.meta.api.objects.Update;

import java.util.Collection;

import java.util.LinkedList;

import java.util.List;

import java.util.Objects;

import java.util.SortedMap;

import java.util.StringJoiner;

import java.util.TreeMap;

/**

 * Displays the bot's help.

 */

@TelegramCommand(name = "help", group = "commands.groups.help", description = "commands.description.help")

@Conditional(ExcludeCondition.class)

@ConditionalOnSingleCandidate(HelpCommand.class)

    /**

     * The component to know which user is authorized.

     */

    /**

     * Constructs a new {@link BasicHelpCommand} instance with the {@link SecurityManager} component instance.

     *

     * @param securityManager the {@link SecurityManager} component instance.

     */

    @Autowired

    }

    /**

     * Processes the data sent by the users.

     *

     * @param update the received message.

     * @param args   the parameters passed to the command execution.

     */

    @Override

                return;

            }

            StringJoiner stringJoiner = new StringJoiner(System.lineSeparator());

                    execute(update);

                }

            }

            bot.sendMessage(stringJoiner.toString(), update.getMessage().getChatId(), true);

            // Do nothing

        }

    }

    /**

     * Executes the command's logic without taking parameters.

     *

     * @param update the received message.

     */

    @Override

        stringJoiner.add(String.format("%s:", messageSource.getMessage("commands.basic.help.title", null,

                LocaleContextHolder.getLocale())));

        commandsByGroup(getAvailableCommands(update.getMessage().getChatId()))

        bot.sendMessage(stringJoiner.toString(), update.getMessage().getChatId(), true);

    }

    /**

     * Returns the help for the group of commands.

     *

     * @param group    the name of the group.

     * @param commands the commands into the group.

     * @return the help for the group.

     */

        }

        return System.lineSeparator() + stringJoiner.toString();

    }

    /**

     * Returns the help for a single command.

     *

     * @param command the command.

     * @return the help of the command.

     */

        CommandManager.getCommandFullNames(command).forEach(stringJoiner::add);

        return String.format("%s - %s", stringJoiner.toString(), getDescription(command));

    }

    /**

     * Organizes the available commands into groups.

     *

     * @param commands the list with all the available commands.

     * @return the available commands in groups sorted by the group's name.

     */

            List<Command> commandList = commandsByGroup.getOrDefault(group, new LinkedList<>());

            commandList.add(command);

            commandsByGroup.put(group, commandList);

        });

        return commandsByGroup;

    }

    /**

     * Cleans the class name by removing the word "command" from it.

     *

     * @param commandClass the class to be cleaned.

     * @return the cleaned class name.

     */

        }

        return className;

    }

    /**

     * Returns the group's name of the command.

     *

     * @param command the command from which the group's name will be retrieved.

     * @return the group's name.

     */

        // If there is no an explicit group, we'll try to generate a key to retrieve a message

        String key = "";

            groupName = key;

        }

            }

        }

        return groupName;

    }

    /**

     * Returns the description of the command.

     *

     * @param command the command from which the description will be retrieved.

     * @return the command's description.

     */

        // If there is no explicit description, we'll try to generate a description key to retrieve a message

        String key = "";

            description = key;

        }

            }

        }

        return description;

    }

    /**

     * Returns the list of available commands for the user. It takes into account whether the user is authorized or not.

     *

     * @param chatId the identification of the user's chat.

     * @return the list of available commands.

     */

}