netkorp /
spring-boot-telegram-framework
| 1 | package com.github.netkorp.telegram.framework.commands.basic; |
||
|
Code Smell
introduced
by
|
|||
| 2 | |||
| 3 | import com.github.netkorp.telegram.framework.annotations.TelegramCommand; |
||
| 4 | import com.github.netkorp.telegram.framework.commands.abstracts.AbstractSimpleCommand; |
||
| 30 | @TelegramCommand(name = "help", group = "commands.groups.help", description = "commands.description.help") |
||
| 31 | @Conditional(ExcludeCondition.class) |
||
| 32 | @ConditionalOnSingleCandidate(HelpCommand.class) |
||
| 33 | public class BasicHelpCommand extends AbstractSimpleCommand implements HelpCommand { |
||
| 34 | |||
| 35 | /** |
||
| 36 | * The component to know which user is authorized. |
||
| 37 | */ |
||
| 38 | private final SecurityManager securityManager; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Constructs a new {@link BasicHelpCommand} instance with the {@link SecurityManager} component instance. |
||
| 43 | * @param securityManager the {@link SecurityManager} component instance. |
||
| 44 | */ |
||
| 45 | @Autowired |
||
| 46 | public BasicHelpCommand(SecurityManager securityManager) { |
||
| 47 | this.securityManager = securityManager; |
||
| 48 | } |
||
| 49 | |||
| 50 | /** |
||
| 54 | * @param args the parameters passed to the command execution. |
||
| 55 | */ |
||
| 56 | @Override |
||
| 57 | public void execute(final Update update, String[] args) { |
||
| 58 | try { |
||
| 59 | if (args.length == 0) { |
||
| 60 | execute(update); |
||
| 61 | return; |
||
| 62 | } |
||
| 63 | |||
| 64 | StringJoiner stringJoiner = new StringJoiner(System.lineSeparator()); |
||
| 65 | |||
| 66 | for (String arg : args) { |
||
| 67 | try { |
||
| 68 | stringJoiner.add(helpForCommand(commandManager.getCommand(CommandManager.getCommandFullName(arg)))); |
||
| 69 | } catch (CommandNotFound commandNotFound) { |
||
| 70 | bot.sendMessage(String.format("%s: %s", commandNotFound.getMessage(), arg), update.getMessage().getChatId(), true); |
||
| 71 | execute(update); |
||
| 72 | throw commandNotFound; |
||
| 73 | } |
||
| 74 | } |
||
| 75 | |||
| 76 | bot.sendMessage(stringJoiner.toString(), update.getMessage().getChatId(), true); |
||
| 77 | } catch (CommandNotFound commandNotFound) { |
||
| 78 | // Do nothing |
||
| 79 | } |
||
| 80 | } |
||
| 85 | * @param update the received message. |
||
| 86 | */ |
||
| 87 | @Override |
||
| 88 | public void execute(Update update) { |
||
| 89 | StringJoiner stringJoiner = new StringJoiner(System.lineSeparator()); |
||
| 90 | |||
| 91 | stringJoiner.add(String.format("%s:", messageSource.getMessage("commands.basic.help.title", null, |
||
| 92 | LocaleContextHolder.getLocale()))); |
||
| 93 | |||
| 94 | commandsByGroup(getAvailableCommands(update.getMessage().getChatId())) |
||
| 95 | .forEach((group, commands) -> stringJoiner.add(helpForGroup(group, commands))); |
||
| 96 | |||
| 97 | bot.sendMessage(stringJoiner.toString(), update.getMessage().getChatId(), true); |
||
| 98 | } |
||
| 104 | * @param commands the commands into the group. |
||
| 105 | * @return the help for the group. |
||
| 106 | */ |
||
| 107 | private String helpForGroup(String group, List<Command> commands) { |
||
| 108 | StringJoiner stringJoiner = new StringJoiner(System.lineSeparator()); |
||
| 109 | if (!Strings.isEmpty(group)) { |
||
| 110 | stringJoiner.add(String.format("<b>%s</b>", group)); |
||
| 111 | } |
||
| 112 | commands.forEach(command -> stringJoiner.add(helpForCommand(command))); |
||
| 113 | return System.lineSeparator() + stringJoiner.toString(); |
||
| 114 | } |
||
| 115 | |||
| 119 | * @param command the command. |
||
| 120 | * @return the help of the command. |
||
| 121 | */ |
||
| 122 | private String helpForCommand(Command command) { |
||
| 123 | StringJoiner stringJoiner = new StringJoiner(", "); |
||
| 124 | CommandManager.getCommandFullNames(command).forEach(stringJoiner::add); |
||
| 125 | return String.format("%s - %s", stringJoiner.toString(), getDescription(command)); |
||
| 126 | } |
||
| 131 | * @param commands the list with all the available commands. |
||
| 132 | * @return the available commands in groups sorted by the group's name. |
||
| 133 | */ |
||
| 134 | private SortedMap<String, List<Command>> commandsByGroup(Collection<Command> commands) { |
||
| 135 | SortedMap<String, List<Command>> commandsByGroup = new TreeMap<>(); |
||
| 136 | |||
| 137 | commands.forEach(command -> { |
||
| 138 | String group = getGroupName(command); |
||
| 139 | |||
| 140 | List<Command> commandList = commandsByGroup.getOrDefault(group, new LinkedList<>()); |
||
| 141 | commandList.add(command); |
||
| 152 | * @param commandClass the class to be cleaned. |
||
| 153 | * @return the cleaned class name. |
||
| 154 | */ |
||
| 155 | private String cleanCommandClassName(Class<?> commandClass) { |
||
| 156 | String className = commandClass.getSimpleName().toLowerCase(); |
||
| 157 | if (!"command".equals(className) && className.endsWith("command")) { |
||
| 158 | className = className.substring(0, className.length() - 7); |
||
| 159 | } |
||
| 160 | |||
| 161 | return className; |
||
| 167 | * @param command the command from which the group's name will be retrieved. |
||
| 168 | * @return the group's name. |
||
| 169 | */ |
||
| 170 | private String getGroupName(Command command) { |
||
| 171 | String groupName = command.getClass().getAnnotation(TelegramCommand.class).group().trim(); |
||
| 172 | |||
| 173 | // If there is no an explicit group, we'll try to generate a key to retrieve a message |
||
| 174 | String key = ""; |
||
| 175 | if (groupName.isEmpty()) { |
||
| 176 | key = "commands.groups." + cleanCommandClassName(command.getClass()); |
||
| 177 | groupName = key; |
||
| 178 | } |
||
| 179 | |||
| 180 | try { |
||
| 181 | groupName = messageSource.getMessage(groupName, null, LocaleContextHolder.getLocale()); |
||
| 182 | } catch (NoSuchMessageException exception) { |
||
| 183 | if (Objects.equals(key, groupName)) { |
||
| 184 | groupName = ""; |
||
| 185 | } |
||
| 186 | } |
||
| 187 | |||
| 194 | * @param command the command from which the description will be retrieved. |
||
| 195 | * @return the command's description. |
||
| 196 | */ |
||
| 197 | private String getDescription(Command command) { |
||
| 198 | String description = command.getClass().getAnnotation(TelegramCommand.class).description().trim(); |
||
| 199 | |||
| 200 | // If there is no explicit description, we'll try to generate a description key to retrieve a message |
||
| 201 | String key = ""; |
||
| 202 | if (description.isEmpty()) { |
||
| 203 | key = "commands.description." + cleanCommandClassName(command.getClass()); |
||
| 204 | description = key; |
||
| 205 | } |
||
| 206 | |||
| 207 | try { |
||
| 208 | description = messageSource.getMessage(description, null, LocaleContextHolder.getLocale()); |
||
| 209 | } catch (NoSuchMessageException exception) { |
||
| 210 | if (Objects.equals(key, description)) { |
||
| 211 | description = messageSource.getMessage("commands.basic.help.default-description", null, LocaleContextHolder.getLocale()); |
||
| 212 | } |
||
| 213 | } |
||
| 214 | |||
| 221 | * @param chatId the identification of the user's chat. |
||
| 222 | * @return the list of available commands. |
||
| 223 | */ |
||
| 224 | private Collection<Command> getAvailableCommands(Long chatId) { |
||
| 225 | if (securityManager.isAuthorized(chatId)) { |
||
| 226 | return commandManager.getAvailableCommands(); |
||
| 227 | } |
||
| 228 | |||
| 229 | return commandManager.getAvailableNonSecureCommands(); |
||
| 230 | } |
||
| 231 | } |
||
| 232 |
Loading history...