netkorp /
spring-boot-telegram-framework
| 1 | package com.github.netkorp.telegram.framework.managers; |
||
|
Code Smell
introduced
by
|
|||
| 2 | |||
| 3 | import com.github.netkorp.telegram.framework.annotations.TelegramCommand; |
||
| 4 | import com.github.netkorp.telegram.framework.commands.interfaces.Command; |
||
| 26 | * It includes the management of non-secure commands, active command, basic commands and |
||
| 27 | * those commands that are involved in the multistage command flow. |
||
| 28 | */ |
||
| 29 | @SuppressWarnings("WeakerAccess") |
||
| 30 | @Component |
||
| 31 | public class CommandManager { |
||
| 32 | |||
| 33 | private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); |
||
| 34 | |||
| 35 | /** |
||
| 36 | * The list of the available commands into a map to get a quick access from its name. |
||
| 58 | private final CommandProperties commandProperties; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * The command that closes an active conversation with the bot, indicating to the active command that the conversation is closed. |
||
| 62 | * It is kept here for a quick access to the close command. |
||
| 63 | */ |
||
| 64 | private MultistageCloseCommand closeCommand; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * The command that closes an active conversation with the bot, indicating to the active command that the conversation is done. |
||
| 68 | * It is kept here for a quick access to the done command. |
||
| 69 | */ |
||
| 70 | private MultistageDoneCommand doneCommand; |
||
| 83 | * @param commandProperties the properties of the commands. |
||
| 84 | */ |
||
| 85 | @Autowired |
||
| 86 | public CommandManager(List<Command> commands, CommandProperties commandProperties) { |
||
| 87 | this.commandsByFullName = new HashMap<>(); |
||
| 88 | this.commands = new LinkedList<>(); |
||
| 89 | this.nonSecureCommands = new LinkedList<>(); |
||
| 90 | |||
| 92 | this.commandProperties = commandProperties; |
||
| 93 | |||
| 94 | commands.stream() |
||
| 95 | .filter(item -> item.getClass().isAnnotationPresent(TelegramCommand.class)) |
||
| 96 | .forEach(this::addCommand); |
||
| 97 | } |
||
| 98 | |||
| 108 | * @see #doneCommand |
||
| 109 | * @see #helpCommand |
||
| 110 | */ |
||
| 111 | private void addCommand(Command command) { |
||
| 112 | // Registering the command for each name |
||
| 113 | for (String name : getCommandNames(command)) { |
||
| 114 | |||
| 115 | if (!isValidCommandName(name)) { |
||
| 116 | LOG.warn(String.format("Command %s has a duplicate or empty name. It will be discarded.", |
||
| 117 | command.getClass().getSimpleName())); |
||
| 118 | break; |
||
| 119 | } |
||
| 120 | |||
| 121 | this.commandsByFullName.put(getCommandFullName(name), command); |
||
| 122 | |||
| 123 | if (!this.commands.contains(command)) { |
||
| 124 | this.commands.add(command); |
||
| 125 | } |
||
| 126 | |||
| 127 | // Just for keeping a reference of the non-secure commands |
||
| 128 | if ((commandProperties.getNonSecure().contains(name) |
||
| 129 | || !command.getClass().getAnnotation(TelegramCommand.class).secure()) |
||
| 130 | && !this.nonSecureCommands.contains(command)) { |
||
| 131 | this.nonSecureCommands.add(command); |
||
| 132 | } |
||
| 133 | |||
| 134 | if (command instanceof MultistageCloseCommand) { |
||
| 135 | closeCommand = (MultistageCloseCommand) command; |
||
| 136 | } else if (command instanceof MultistageDoneCommand) { |
||
| 137 | doneCommand = (MultistageDoneCommand) command; |
||
| 138 | } else if (command instanceof HelpCommand) { |
||
| 139 | helpCommand = (HelpCommand) command; |
||
| 140 | } |
||
| 141 | } |
||
| 142 | } |
||
| 147 | * @param commandName the name of the command to validate. |
||
| 148 | * @return {@code true} if the command name is a valid name for a command; {@code false} otherwise. |
||
| 149 | */ |
||
| 150 | private boolean isValidCommandName(String commandName) { |
||
| 151 | return !commandName.trim().isEmpty() && !this.commandsByFullName.containsKey(commandName); |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 157 | * @param command the command to be processed. |
||
| 158 | * @return {@code true} if the command is non-secure; {@code false} otherwise. |
||
| 159 | */ |
||
| 160 | public boolean isNonSecureCommand(Command command) { |
||
| 161 | return this.nonSecureCommands.contains(command); |
||
| 162 | } |
||
| 163 | |||
| 164 | /** |
||
| 168 | * @param command the command from which the names will be identified. |
||
| 169 | * @return the names of the command. |
||
| 170 | */ |
||
| 171 | public static String[] getCommandNames(Command command) { |
||
| 172 | return command.getClass().getAnnotation(TelegramCommand.class).name(); |
||
| 173 | } |
||
| 174 | |||
| 175 | /** |
||
| 178 | * @param commandName the command's name (the same name declared on {@link TelegramCommand#name()}) |
||
| 179 | * @return the name of the command. |
||
| 180 | */ |
||
| 181 | public static String getCommandFullName(String commandName) { |
||
| 182 | return commandName.startsWith("/") ? commandName : String.format("/%s", commandName); |
||
| 183 | } |
||
| 184 | |||
| 185 | /** |
||
| 188 | * @param command the command from which the names will be identified. |
||
| 189 | * @return the names of the command. |
||
| 190 | */ |
||
| 191 | public static List<String> getCommandFullNames(Command command) { |
||
| 192 | List<String> commandFullNames = new LinkedList<>(); |
||
| 193 | |||
| 194 | for (String name : getCommandNames(command)) { |
||
| 195 | commandFullNames.add(getCommandFullName(name)); |
||
| 196 | } |
||
| 197 | |||
| 198 | return commandFullNames; |
||
| 205 | * @return the {@link Command} instance. |
||
| 206 | * @throws CommandNotFound if the name is not related to any commands. |
||
| 207 | */ |
||
| 208 | public Command getCommand(String command) throws CommandNotFound { |
||
| 209 | if (!this.commandsByFullName.containsKey(command)) { |
||
| 210 | throw new CommandNotFound(); |
||
| 211 | } |
||
| 212 | |||
| 213 | return this.commandsByFullName.get(command); |
||
| 219 | * @param idChat the chat identification of the user for whom the multistage command will be active. |
||
| 220 | * @param command the command to activate. |
||
| 221 | */ |
||
| 222 | public void setActiveCommand(final Long idChat, final MultistageCommand command) { |
||
| 223 | this.activeCommand.put(idChat, command); |
||
| 224 | } |
||
| 225 | |||
| 226 | /** |
||
| 230 | * @return the active command. |
||
| 231 | * @throws CommandNotActive if there is no an active command. |
||
| 232 | */ |
||
| 233 | public MultistageCommand getActiveCommand(Long idChat) throws CommandNotActive { |
||
| 234 | if (!hasActiveCommand(idChat)) { |
||
| 235 | throw new CommandNotActive(); |
||
| 236 | } |
||
| 237 | |||
| 238 | return activeCommand.get(idChat); |
||
| 243 | * |
||
| 244 | * @param idChat the chat identification of the user. |
||
| 245 | */ |
||
| 246 | public void removeActiveCommand(Long idChat) { |
||
| 247 | activeCommand.remove(idChat); |
||
| 248 | } |
||
| 249 | |||
| 250 | /** |
||
| 253 | * @param idChat the chat identification of the user. |
||
| 254 | * @return {@code true} if there is an active command; {@code false} otherwise. |
||
| 255 | */ |
||
| 256 | public boolean hasActiveCommand(Long idChat) { |
||
| 257 | return activeCommand.containsKey(idChat); |
||
| 258 | } |
||
| 259 | |||
| 260 | /** |
||
| 262 | * |
||
| 263 | * @return the {@link MultistageCloseCommand} instance. |
||
| 264 | */ |
||
| 265 | public Optional<MultistageCloseCommand> getCloseCommand() { |
||
| 266 | return Optional.ofNullable(this.closeCommand); |
||
| 267 | } |
||
| 268 | |||
| 269 | /** |
||
| 271 | * |
||
| 272 | * @return the {@link MultistageDoneCommand} instance. |
||
| 273 | */ |
||
| 274 | public Optional<MultistageDoneCommand> getDoneCommand() { |
||
| 275 | return Optional.ofNullable(this.doneCommand); |
||
| 276 | } |
||
| 277 | |||
| 278 | /** |
||
| 280 | * |
||
| 281 | * @return the {@link HelpCommand} instance. |
||
| 282 | */ |
||
| 283 | public Optional<HelpCommand> getHelpCommand() { |
||
| 284 | return Optional.ofNullable(this.helpCommand); |
||
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 289 | * |
||
| 290 | * @return the available commands. |
||
| 291 | */ |
||
| 292 | public List<Command> getAvailableCommands() { |
||
| 293 | return commands; |
||
| 294 | } |
||
| 295 | |||
| 296 | /** |
||
| 298 | * |
||
| 299 | * @return the available non-secure commands. |
||
| 300 | */ |
||
| 301 | public List<Command> getAvailableNonSecureCommands() { |
||
| 302 | return nonSecureCommands; |
||
| 303 | } |
||
| 304 | } |
||
| 305 |
Loading history...