- * It will correctly handle addition of users into the DB and the execution of abilities and replies.
- *
- * @param update the update received by Telegram's API
- */
- public void onUpdateReceived(Update update) {
- BotLogger.info(format("New update [%s] received at %s", update.getUpdateId(), now()), format("%s - %s", TAG, botUsername));
- BotLogger.info(update.toString(), TAG);
- long millisStarted = System.currentTimeMillis();
-
- Stream.of(update)
- .filter(this::checkGlobalFlags)
- .filter(this::checkBlacklist)
- .map(this::addUser)
- .filter(this::filterReply)
- .map(this::getAbility)
- .filter(this::validateAbility)
- .filter(this::checkPrivacy)
- .filter(this::checkLocality)
- .filter(this::checkInput)
- .filter(this::checkMessageFlags)
- .map(this::getContext)
- .map(this::consumeUpdate)
- .forEach(this::postConsumption);
-
- long processingTime = System.currentTimeMillis() - millisStarted;
- BotLogger.info(format("Processing of update [%s] ended at %s%n---> Processing time: [%d ms] <---%n", update.getUpdateId(), now(), processingTime), format("%s - %s", TAG, botUsername));
- }
-
- public String getBotToken() {
- return botToken;
- }
-
- public String getBotUsername() {
- return botUsername;
- }
-
- /**
- * Test the update against the provided global flags. The default implementation is a passthrough to all updates.
- *
- * This method should be overridden if the user wants to restrict bot usage to only certain updates.
- *
- * @param update a Telegram {@link Update}
- * @return true if the update satisfies the global flags
- */
- protected boolean checkGlobalFlags(Update update) {
- return true;
- }
-
- /**
- * Gets the user with the specified username.
- *
- * @param username the username of the required user
- * @return the user
- */
- protected User getUser(String username) {
- Integer id = userIds().get(username.toLowerCase());
- if (id == null) {
- throw new IllegalStateException(format("Could not find ID corresponding to username [%s]", username));
+ registerAbilities();
}
- return getUser(id);
- }
-
- /**
- * Gets the user with the specified ID.
- *
- * @param id the id of the required user
- * @return the user
- */
- protected User getUser(int id) {
- User user = users().get(id);
- if (user == null) {
- throw new IllegalStateException(format("Could not find user corresponding to id [%d]", id));
+ /**
+ * @return the map of
+ */
+ protected Map users() {
+ return db.getMap(USERS);
}
- return user;
- }
-
- /**
- * Gets the user with the specified username. If user was not found, the bot will send a message on Telegram.
- *
- * @param username the username of the required user
- * @param ctx the message context with the originating user
- * @return the id of the user
- */
- protected int getUserIdSendError(String username, MessageContext ctx) {
- try {
- return getUser(username).getId();
- } catch (IllegalStateException ex) {
- silent.send(getLocalizedMessage(USER_NOT_FOUND, ctx.user().getLanguageCode(), username), ctx.chatId());
- throw propagate(ex);
+ /**
+ * @return the map of
+ */
+ protected Map userIds() {
+ return db.getMap(USER_ID);
}
- }
- /**
- *
- * Format of the report:
- *
- * [command1] - [description1]
- *
- * [command2] - [description2]
- *
- * ...
- *
- * Once you invoke it, the bot will send the available commands to the chat. This is a public ability so anyone can invoke it.
- *
- * Usage: /commands
- *
- * @return the ability to report commands defined by the child bot.
- */
- public Ability reportCommands() {
- return builder()
- .name(REPORT)
- .locality(ALL)
- .privacy(CREATOR)
- .input(0)
- .action(ctx -> {
- String commands = abilities.entrySet().stream()
- .filter(entry -> nonNull(entry.getValue().info()))
- .map(entry -> {
- String name = entry.getValue().name();
- String info = entry.getValue().info();
- return format("%s - %s", name, info);
- })
- .sorted()
- .reduce((a, b) -> format("%s%n%s", a, b))
- .orElse(getLocalizedMessage(ABILITY_COMMANDS_NOT_FOUND, ctx.user().getLanguageCode()));
+ /**
+ * @return a blacklist containing all the IDs of the banned users
+ */
+ protected Set blacklist() {
+ return db.getSet(BLACKLIST);
+ }
- silent.send(commands, ctx.chatId());
- })
- .build();
- }
+ /**
+ * @return an admin set of all the IDs of bot administrators
+ */
+ protected Set admins() {
+ return db.getSet(ADMINS);
+ }
- /**
- * Default format:
- *
- * PUBLIC
- *
- * [command1] - [description1]
- *
- * [command2] - [description2]
- *
- * GROUP_ADMIN
- *
- * [command1] - [description1]
- *
- * ...
- *
- * @return the ability to print commands based on the privacy of the requesting user
- */
- public Ability commands() {
- return builder()
- .name(COMMANDS)
- .locality(USER)
- .privacy(PUBLIC)
- .input(0)
- .action(ctx -> {
- Privacy privacy = getPrivacy(ctx.update(), ctx.user().getId());
+ /**
+ * @return the immutable map of
+ */
+ public Map abilities() {
+ return abilities;
+ }
- ListMultimap abilitiesPerPrivacy = abilities.entrySet().stream()
- .map(entry -> {
- String name = entry.getValue().name();
- String info = entry.getValue().info();
+ /**
+ * @return the immutable list carrying the embedded replies
+ */
+ public List replies() {
+ return replies;
+ }
- if (!isEmpty(info))
- return Pair.of(entry.getValue().privacy(), format("/%s - %s", name, info));
- return Pair.of(entry.getValue().privacy(), format("/%s", name));
- })
- .sorted(comparing(Pair::b))
- .collect(() -> hashKeys().arrayListValues().build(),
- (map, pair) -> map.put(pair.a(), pair.b()),
- Multimap::putAll);
+ /**
+ * This method contains the stream of actions that are applied on any update.
+ *
+ * It will correctly handle addition of users into the DB and the execution of abilities and replies.
+ *
+ * @param update the update received by Telegram's API
+ */
+ public void onUpdateReceived(Update update) {
+ log.info(format("[%s] New update [%s] received at %s", botUsername, update.getUpdateId(), now()));
+ log.info(update.toString());
+ long millisStarted = System.currentTimeMillis();
- String commands = abilitiesPerPrivacy.asMap().entrySet().stream()
- .filter(entry -> privacy.compareTo(entry.getKey()) >= 0)
- .sorted(comparing(Entry::getKey))
- .map(entry ->
- entry.getValue().stream()
- .reduce(entry.getKey().toString(), (a, b) -> format("%s\n%s", a, b))
- )
- .collect(joining("\n"));
+ Stream.of(update)
+ .filter(this::checkGlobalFlags)
+ .filter(this::checkBlacklist)
+ .map(this::addUser)
+ .filter(this::filterReply)
+ .map(this::getAbility)
+ .filter(this::validateAbility)
+ .filter(this::checkPrivacy)
+ .filter(this::checkLocality)
+ .filter(this::checkInput)
+ .filter(this::checkMessageFlags)
+ .map(this::getContext)
+ .map(this::consumeUpdate)
+ .forEach(this::postConsumption);
- if (commands.isEmpty())
- commands = getLocalizedMessage(ABILITY_COMMANDS_NOT_FOUND, ctx.user().getLanguageCode());
+ long processingTime = System.currentTimeMillis() - millisStarted;
+ log.info(format("[%s] Processing of update [%s] ended at %s%n---> Processing time: [%d ms] <---%n", botUsername, update.getUpdateId(), now(), processingTime));
+ }
- silent.send(commands, ctx.chatId());
- })
- .build();
- }
+ public String getBotToken() {
+ return botToken;
+ }
- /**
- * This backup ability returns the object defined by {@link DBContext#backup()} as a message document.
- *
- * This is a high-profile ability and is restricted to the CREATOR only.
- *
- * Usage: /backup
- *
- * @return the ability to back-up the database of the bot
- */
- public Ability backupDB() {
- return builder()
- .name(BACKUP)
- .locality(USER)
- .privacy(CREATOR)
- .input(0)
- .action(ctx -> {
- File backup = new File("backup.json");
+ public String getBotUsername() {
+ return botUsername;
+ }
- try (PrintStream printStream = new PrintStream(backup)) {
- printStream.print(db.backup());
- sender.sendDocument(new SendDocument()
- .setDocument(backup)
- .setChatId(ctx.chatId())
- );
- } catch (FileNotFoundException e) {
- BotLogger.error("Error while fetching backup", TAG, e);
- } catch (TelegramApiException e) {
- BotLogger.error("Error while sending document/backup file", TAG, e);
- }
- })
- .build();
- }
+ /**
+ * Test the update against the provided global flags. The default implementation is a passthrough to all updates.
+ *
+ * This method should be overridden if the user wants to restrict bot usage to only certain updates.
+ *
+ * @param update a Telegram {@link Update}
+ * @return true if the update satisfies the global flags
+ */
+ protected boolean checkGlobalFlags(Update update) {
+ return true;
+ }
- /**
- * Recovers the bot database using {@link DBContext#recover(Object)}.
- *
- * The bot recovery process hugely depends on the implementation of the recovery method of {@link DBContext}.
- *
- * Usage: /recover
- *
- * @return the ability to recover the database of the bot
- */
- public Ability recoverDB() {
- return builder()
- .name(RECOVER)
- .locality(USER)
- .privacy(CREATOR)
- .input(0)
- .action(ctx -> silent.forceReply(
- getLocalizedMessage(ABILITY_RECOVER_MESSAGE, ctx.user().getLanguageCode()), ctx.chatId()))
- .reply(update -> {
- String replyToMsg = update.getMessage().getReplyToMessage().getText();
- String recoverMessage = getLocalizedMessage(ABILITY_RECOVER_MESSAGE, AbilityUtils.getUser(update).getLanguageCode());
- if (!replyToMsg.equals(recoverMessage))
- return;
+ /**
+ * Gets the user with the specified username.
+ *
+ * @param username the username of the required user
+ * @return the user
+ */
+ protected User getUser(String username) {
+ Integer id = userIds().get(username.toLowerCase());
+ if (id == null) {
+ throw new IllegalStateException(format("Could not find ID corresponding to username [%s]", username));
+ }
- String fileId = update.getMessage().getDocument().getFileId();
- try (FileReader reader = new FileReader(downloadFileWithId(fileId))) {
- String backupData = IOUtils.toString(reader);
- if (db.recover(backupData)) {
- send(ABILITY_RECOVER_SUCCESS, update);
- } else {
- send(ABILITY_RECOVER_FAIL, update);
+ return getUser(id);
+ }
+
+ /**
+ * Gets the user with the specified ID.
+ *
+ * @param id the id of the required user
+ * @return the user
+ */
+ protected User getUser(int id) {
+ User user = users().get(id);
+ if (user == null) {
+ throw new IllegalStateException(format("Could not find user corresponding to id [%d]", id));
+ }
+
+ return user;
+ }
+
+ /**
+ * Gets the user with the specified username. If user was not found, the bot will send a message on Telegram.
+ *
+ * @param username the username of the required user
+ * @param ctx the message context with the originating user
+ * @return the id of the user
+ */
+ protected int getUserIdSendError(String username, MessageContext ctx) {
+ try {
+ return getUser(username).getId();
+ } catch (IllegalStateException ex) {
+ silent.send(getLocalizedMessage(USER_NOT_FOUND, ctx.user().getLanguageCode(), username), ctx.chatId());
+ throw ex;
+ }
+ }
+
+ /**
+ *
+ * Format of the report:
+ *
+ * [command1] - [description1]
+ *
+ * [command2] - [description2]
+ *
+ * ...
+ *
+ * Once you invoke it, the bot will send the available commands to the chat. This is a public ability so anyone can invoke it.
+ *
+ * ...
+ *
+ * @return the ability to print commands based on the privacy of the requesting user
+ */
+ public Ability commands() {
+ return builder()
+ .name(COMMANDS)
+ .locality(USER)
+ .privacy(PUBLIC)
+ .input(0)
+ .action(ctx -> {
+ Privacy privacy = getPrivacy(ctx.update(), ctx.user().getId());
+
+ ListMultimap abilitiesPerPrivacy = abilities.values().stream()
+ .map(ability -> {
+ String name = ability.name();
+ String info = ability.info();
+
+ if (!isEmpty(info))
+ return Pair.of(ability.privacy(), format("/%s - %s", name, info));
+ return Pair.of(ability.privacy(), format("/%s", name));
+ })
+ .sorted(comparing(Pair::b))
+ .collect(() -> hashKeys().arrayListValues().build(),
+ (map, pair) -> map.put(pair.a(), pair.b()),
+ Multimap::putAll);
+
+ String commands = abilitiesPerPrivacy.asMap().entrySet().stream()
+ .filter(entry -> privacy.compareTo(entry.getKey()) >= 0)
+ .sorted(comparing(Entry::getKey))
+ .map(entry ->
+ entry.getValue().stream()
+ .reduce(entry.getKey().toString(), (a, b) -> format("%s\n%s", a, b))
+ )
+ .collect(joining("\n"));
+
+ if (commands.isEmpty())
+ commands = getLocalizedMessage(ABILITY_COMMANDS_NOT_FOUND, ctx.user().getLanguageCode());
+
+ silent.send(commands, ctx.chatId());
+ })
+ .build();
+ }
+
+ /**
+ * This backup ability returns the object defined by {@link DBContext#backup()} as a message document.
+ *
+ * This is a high-profile ability and is restricted to the CREATOR only.
+ *
+ * Usage: /backup
+ *
+ * @return the ability to back-up the database of the bot
+ */
+ public Ability backupDB() {
+ return builder()
+ .name(BACKUP)
+ .locality(USER)
+ .privacy(CREATOR)
+ .input(0)
+ .action(ctx -> {
+ File backup = new File("backup.json");
+
+ try (PrintStream printStream = new PrintStream(backup)) {
+ printStream.print(db.backup());
+ sender.sendDocument(new SendDocument()
+ .setDocument(backup)
+ .setChatId(ctx.chatId())
+ );
+ } catch (FileNotFoundException e) {
+ log.error("Error while fetching backup", e);
+ } catch (TelegramApiException e) {
+ log.error("Error while sending document/backup file", e);
+ }
+ })
+ .build();
+ }
+
+ /**
+ * Recovers the bot database using {@link DBContext#recover(Object)}.
+ *
+ * The bot recovery process hugely depends on the implementation of the recovery method of {@link DBContext}.
+ *
+ * Usage: /recover
+ *
+ * @return the ability to recover the database of the bot
+ */
+ public Ability recoverDB() {
+ return builder()
+ .name(RECOVER)
+ .locality(USER)
+ .privacy(CREATOR)
+ .input(0)
+ .action(ctx -> silent.forceReply(
+ getLocalizedMessage(ABILITY_RECOVER_MESSAGE, ctx.user().getLanguageCode()), ctx.chatId()))
+ .reply(update -> {
+ String replyToMsg = update.getMessage().getReplyToMessage().getText();
+ String recoverMessage = getLocalizedMessage(ABILITY_RECOVER_MESSAGE, AbilityUtils.getUser(update).getLanguageCode());
+ if (!replyToMsg.equals(recoverMessage))
+ return;
+
+ String fileId = update.getMessage().getDocument().getFileId();
+ try (FileReader reader = new FileReader(downloadFileWithId(fileId))) {
+ String backupData = IOUtils.toString(reader);
+ if (db.recover(backupData)) {
+ send(ABILITY_RECOVER_SUCCESS, update);
+ } else {
+ send(ABILITY_RECOVER_FAIL, update);
+ }
+ } catch (Exception e) {
+ log.error("Could not recover DB from backup", e);
+ send(ABILITY_RECOVER_ERROR, update);
+ }
+ }, MESSAGE, DOCUMENT, REPLY)
+ .build();
+ }
+
+ /**
+ * Banned users are accumulated in the blacklist. Use {@link DBContext#getSet(String)} with name specified by {@link BaseAbilityBot#BLACKLIST}.
+ *
+ * Usage: /ban @username
+ *
+ * Note that admins who try to ban the creator, get banned.
+ *
+ * @return the ability to ban the user from any kind of bot interaction
+ */
+ public Ability banUser() {
+ return builder()
+ .name(BAN)
+ .locality(ALL)
+ .privacy(ADMIN)
+ .input(1)
+ .action(ctx -> {
+ String username = stripTag(ctx.firstArg());
+ int userId = getUserIdSendError(username, ctx);
+ String bannedUser;
+
+ // Protection from abuse
+ if (userId == creatorId()) {
+ userId = ctx.user().getId();
+ bannedUser = isNullOrEmpty(ctx.user().getUserName()) ? addTag(ctx.user().getUserName()) : shortName(ctx.user());
+ } else {
+ bannedUser = addTag(username);
+ }
+
+ Set blacklist = blacklist();
+ if (blacklist.contains(userId))
+ sendMd(ABILITY_BAN_FAIL, ctx, escape(bannedUser));
+ else {
+ blacklist.add(userId);
+ sendMd(ABILITY_BAN_SUCCESS, ctx, escape(bannedUser));
+ }
+ })
+ .post(commitTo(db))
+ .build();
+ }
+
+ /**
+ * Usage: /unban @username
+ *
+ * @return the ability to unban a user
+ */
+ public Ability unbanUser() {
+ return builder()
+ .name(UNBAN)
+ .locality(ALL)
+ .privacy(ADMIN)
+ .input(1)
+ .action(ctx -> {
+ String username = stripTag(ctx.firstArg());
+ Integer userId = getUserIdSendError(username, ctx);
+
+ Set blacklist = blacklist();
+
+ if (!blacklist.remove(userId))
+ silent.sendMd(getLocalizedMessage(ABILITY_UNBAN_FAIL, ctx.user().getLanguageCode(), escape(username)), ctx.chatId());
+ else {
+ silent.sendMd(getLocalizedMessage(ABILITY_UNBAN_SUCCESS, ctx.user().getLanguageCode(), escape(username)), ctx.chatId());
+ }
+ })
+ .post(commitTo(db))
+ .build();
+ }
+
+ /**
+ * @return the ability to promote a user to a bot admin
+ */
+ public Ability promoteAdmin() {
+ return builder()
+ .name(PROMOTE)
+ .locality(ALL)
+ .privacy(ADMIN)
+ .input(1)
+ .action(ctx -> {
+ String username = stripTag(ctx.firstArg());
+ Integer userId = getUserIdSendError(username, ctx);
+
+ Set admins = admins();
+ if (admins.contains(userId))
+ sendMd(ABILITY_PROMOTE_FAIL, ctx, escape(username));
+ else {
+ admins.add(userId);
+ sendMd(ABILITY_PROMOTE_SUCCESS, ctx, escape(username));
+ }
+ }).post(commitTo(db))
+ .build();
+ }
+
+ /**
+ * @return the ability to demote an admin to a user
+ */
+ public Ability demoteAdmin() {
+ return builder()
+ .name(DEMOTE)
+ .locality(ALL)
+ .privacy(ADMIN)
+ .input(1)
+ .action(ctx -> {
+ String username = stripTag(ctx.firstArg());
+ Integer userId = getUserIdSendError(username, ctx);
+
+ Set admins = admins();
+ if (admins.remove(userId)) {
+ sendMd(ABILITY_DEMOTE_SUCCESS, ctx, escape(username));
+ } else {
+ sendMd(ABILITY_DEMOTE_FAIL, ctx, escape(username));
+ }
+ })
+ .post(commitTo(db))
+ .build();
+ }
+
+ /**
+ * Regular users and admins who try to claim the bot will get banned.
+ *
+ * @return the ability to claim yourself as the master and creator of the bot
+ */
+ public Ability claimCreator() {
+ return builder()
+ .name(CLAIM)
+ .locality(ALL)
+ .privacy(CREATOR)
+ .input(0)
+ .action(ctx -> {
+ Set admins = admins();
+ int id = creatorId();
+
+ if (admins.contains(id))
+ send(ABILITY_CLAIM_FAIL, ctx);
+ else {
+ admins.add(id);
+ send(ABILITY_CLAIM_SUCCESS, ctx);
+ }
+ })
+ .post(commitTo(db))
+ .build();
+ }
+
+ private Optional send(String message, MessageContext ctx, String... args) {
+ return silent.send(getLocalizedMessage(message, ctx.user().getLanguageCode(), args), ctx.chatId());
+ }
+
+ private Optional sendMd(String message, MessageContext ctx, String... args) {
+ return silent.sendMd(getLocalizedMessage(message, ctx.user().getLanguageCode(), args), ctx.chatId());
+ }
+
+ private Optional send(String message, Update upd) {
+ Long chatId = upd.getMessage().getChatId();
+ return silent.send(getLocalizedMessage(message, AbilityUtils.getUser(upd).getLanguageCode()), chatId);
+ }
+
+ /**
+ * Registers the declared abilities using method reflection. Also, replies are accumulated using the built abilities and standalone methods that return a Reply.
+ *
+ * Only abilities and replies with the public accessor are registered!
+ */
+ private void registerAbilities() {
+ try {
+ // Collect all classes that implement AbilityExtension declared in the bot
+ List extensions = stream(getClass().getMethods())
+ .filter(checkReturnType(AbilityExtension.class))
+ .map(returnExtension(this))
+ .collect(Collectors.toList());
+
+ // Add the bot itself as it is an AbilityExtension
+ extensions.add(this);
+
+ // Extract all abilities from every single extension instance
+ abilities = extensions.stream()
+ .flatMap(ext -> stream(ext.getClass().getMethods())
+ .filter(checkReturnType(Ability.class))
+ .map(returnAbility(ext)))
+ // Abilities are immutable, build it respectively
+ .collect(ImmutableMap::builder,
+ (b, a) -> b.put(a.name(), a),
+ (b1, b2) -> b1.putAll(b2.build()))
+ .build();
+
+ // Extract all replies from every single extension instance
+ Stream extensionReplies = extensions.stream()
+ .flatMap(ext -> stream(ext.getClass().getMethods())
+ .filter(checkReturnType(Reply.class))
+ .map(returnReply(ext)));
+
+ // Replies can be standalone or attached to abilities, fetch those too
+ Stream abilityReplies = abilities.values().stream()
+ .flatMap(ability -> ability.replies().stream());
+
+ // Now create the replies registry (list)
+ replies = Stream.concat(abilityReplies, extensionReplies).collect(
+ ImmutableList::builder,
+ Builder::add,
+ (b1, b2) -> b1.addAll(b2.build()))
+ .build();
+ } catch (IllegalStateException e) {
+ log.error("Duplicate names found while registering abilities. Make sure that the abilities declared don't clash with the reserved ones.", e);
+ throw new RuntimeException(e);
+ }
+ }
+
+ /**
+ * @param clazz the type to be tested
+ * @return a predicate testing the return type of the method corresponding to the class parameter
+ */
+ private Predicate checkReturnType(Class clazz) {
+ return method -> clazz.isAssignableFrom(method.getReturnType());
+ }
+
+ /**
+ * Invokes the method and retrieves its return {@link Reply}.
+ *
+ * @param obj an bot or extension that this method is invoked with
+ * @return a {@link Function} which returns the {@link Reply} returned by the given method
+ */
+ private Function returnExtension(Object obj) {
+ return method -> {
+ try {
+ return (AbilityExtension) method.invoke(obj);
+ } catch (IllegalAccessException | InvocationTargetException e) {
+ log.error("Could not add ability extension", e);
+ throw new RuntimeException(e);
}
- } catch (Exception e) {
- BotLogger.error("Could not recover DB from backup", TAG, e);
- send(ABILITY_RECOVER_ERROR, update);
- }
- }, MESSAGE, DOCUMENT, REPLY)
- .build();
- }
-
- /**
- * Banned users are accumulated in the blacklist. Use {@link DBContext#getSet(String)} with name specified by {@link BaseAbilityBot#BLACKLIST}.
- *
- * Usage: /ban @username
- *
- * Note that admins who try to ban the creator, get banned.
- *
- * @return the ability to ban the user from any kind of bot interaction
- */
- public Ability banUser() {
- return builder()
- .name(BAN)
- .locality(ALL)
- .privacy(ADMIN)
- .input(1)
- .action(ctx -> {
- String username = stripTag(ctx.firstArg());
- int userId = getUserIdSendError(username, ctx);
- String bannedUser;
-
- // Protection from abuse
- if (userId == creatorId()) {
- userId = ctx.user().getId();
- bannedUser = isNullOrEmpty(ctx.user().getUserName()) ? addTag(ctx.user().getUserName()) : shortName(ctx.user());
- } else {
- bannedUser = addTag(username);
- }
-
- Set blacklist = blacklist();
- if (blacklist.contains(userId))
- sendMd(ABILITY_BAN_FAIL, ctx, escape(bannedUser));
- else {
- blacklist.add(userId);
- sendMd(ABILITY_BAN_SUCCESS, ctx, escape(bannedUser));
- }
- })
- .post(commitTo(db))
- .build();
- }
-
- /**
- * Usage: /unban @username
- *
- * @return the ability to unban a user
- */
- public Ability unbanUser() {
- return builder()
- .name(UNBAN)
- .locality(ALL)
- .privacy(ADMIN)
- .input(1)
- .action(ctx -> {
- String username = stripTag(ctx.firstArg());
- Integer userId = getUserIdSendError(username, ctx);
-
- Set blacklist = blacklist();
-
- if (!blacklist.remove(userId))
- silent.sendMd(getLocalizedMessage(ABILITY_UNBAN_FAIL, ctx.user().getLanguageCode(), escape(username)), ctx.chatId());
- else {
- silent.sendMd(getLocalizedMessage(ABILITY_UNBAN_SUCCESS, ctx.user().getLanguageCode(), escape(username)), ctx.chatId());
- }
- })
- .post(commitTo(db))
- .build();
- }
-
- /**
- * @return the ability to promote a user to a bot admin
- */
- public Ability promoteAdmin() {
- return builder()
- .name(PROMOTE)
- .locality(ALL)
- .privacy(ADMIN)
- .input(1)
- .action(ctx -> {
- String username = stripTag(ctx.firstArg());
- Integer userId = getUserIdSendError(username, ctx);
-
- Set admins = admins();
- if (admins.contains(userId))
- sendMd(ABILITY_PROMOTE_FAIL, ctx, escape(username));
- else {
- admins.add(userId);
- sendMd(ABILITY_PROMOTE_SUCCESS, ctx, escape(username));
- }
- }).post(commitTo(db))
- .build();
- }
-
- /**
- * @return the ability to demote an admin to a user
- */
- public Ability demoteAdmin() {
- return builder()
- .name(DEMOTE)
- .locality(ALL)
- .privacy(ADMIN)
- .input(1)
- .action(ctx -> {
- String username = stripTag(ctx.firstArg());
- Integer userId = getUserIdSendError(username, ctx);
-
- Set admins = admins();
- if (admins.remove(userId)) {
- sendMd(ABILITY_DEMOTE_SUCCESS, ctx, escape(username));
- } else {
- sendMd(ABILITY_DEMOTE_FAIL, ctx, escape(username));
- }
- })
- .post(commitTo(db))
- .build();
- }
-
- /**
- * Regular users and admins who try to claim the bot will get banned.
- *
- * @return the ability to claim yourself as the master and creator of the bot
- */
- public Ability claimCreator() {
- return builder()
- .name(CLAIM)
- .locality(ALL)
- .privacy(CREATOR)
- .input(0)
- .action(ctx -> {
- Set admins = admins();
- int id = creatorId();
-
- if (admins.contains(id))
- send(ABILITY_CLAIM_FAIL, ctx);
- else {
- admins.add(id);
- send(ABILITY_CLAIM_SUCCESS, ctx);
- }
- })
- .post(commitTo(db))
- .build();
- }
-
- private Optional send(String message, MessageContext ctx, String... args) {
- return silent.send(getLocalizedMessage(message, ctx.user().getLanguageCode(), args), ctx.chatId());
- }
-
- private Optional sendMd(String message, MessageContext ctx, String... args) {
- return silent.sendMd(getLocalizedMessage(message, ctx.user().getLanguageCode(), args), ctx.chatId());
- }
-
- private Optional send(String message, Update upd) {
- Long chatId = upd.getMessage().getChatId();
- return silent.send(getLocalizedMessage(message, AbilityUtils.getUser(upd).getLanguageCode()), chatId);
- }
-
- /**
- * Registers the declared abilities using method reflection. Also, replies are accumulated using the built abilities and standalone methods that return a Reply.
- *
- * Only abilities and replies with the public accessor are registered!
- */
- private void registerAbilities() {
- try {
- // Collect all classes that implement AbilityExtension declared in the bot
- List extensions = stream(getClass().getMethods())
- .filter(checkReturnType(AbilityExtension.class))
- .map(returnExtension(this))
- .collect(Collectors.toList());
-
- // Add the bot itself as it is an AbilityExtension
- extensions.add(this);
-
- // Extract all abilities from every single extension instance
- abilities = extensions.stream()
- .flatMap(ext -> stream(ext.getClass().getMethods())
- .filter(checkReturnType(Ability.class))
- .map(returnAbility(ext)))
- // Abilities are immutable, build it respectively
- .collect(ImmutableMap::builder,
- (b, a) -> b.put(a.name(), a),
- (b1, b2) -> b1.putAll(b2.build()))
- .build();
-
- // Extract all replies from every single extension instance
- Stream extensionReplies = extensions.stream()
- .flatMap(ext -> stream(ext.getClass().getMethods())
- .filter(checkReturnType(Reply.class))
- .map(returnReply(ext)));
-
- // Replies can be standalone or attached to abilities, fetch those too
- Stream abilityReplies = abilities.values().stream()
- .flatMap(ability -> ability.replies().stream());
-
- // Now create the replies registry (list)
- replies = Stream.concat(abilityReplies, extensionReplies).collect(
- ImmutableList::builder,
- Builder::add,
- (b1, b2) -> b1.addAll(b2.build()))
- .build();
- } catch (IllegalStateException e) {
- BotLogger.error(TAG, "Duplicate names found while registering abilities. Make sure that the abilities declared don't clash with the reserved ones.", e);
- throw propagate(e);
- }
- }
-
- /**
- * @param clazz the type to be tested
- * @return a predicate testing the return type of the method corresponding to the class parameter
- */
- private Predicate checkReturnType(Class clazz) {
- return method -> clazz.isAssignableFrom(method.getReturnType());
- }
-
- /**
- * Invokes the method and retrieves its return {@link Reply}.
- *
- * @param obj an bot or extension that this method is invoked with
- * @return a {@link Function} which returns the {@link Reply} returned by the given method
- */
- private Function returnExtension(Object obj) {
- return method -> {
- try {
- return (AbilityExtension) method.invoke(obj);
- } catch (IllegalAccessException | InvocationTargetException e) {
- BotLogger.error("Could not add ability extension", TAG, e);
- throw propagate(e);
- }
- };
- }
-
- /**
- * Invokes the method and retrieves its return {@link Ability}.
- *
- * @param obj an bot or extension that this method is invoked with
- * @return a {@link Function} which returns the {@link Ability} returned by the given method
- */
- private Function returnAbility(Object obj) {
- return method -> {
- try {
- return (Ability) method.invoke(obj);
- } catch (IllegalAccessException | InvocationTargetException e) {
- BotLogger.error("Could not add ability", TAG, e);
- throw propagate(e);
- }
- };
- }
-
- /**
- * Invokes the method and retrieves its return {@link Reply}.
- *
- * @param obj an bot or extension that this method is invoked with
- * @return a {@link Function} which returns the {@link Reply} returned by the given method
- */
- private Function returnReply(Object obj) {
- return method -> {
- try {
- return (Reply) method.invoke(obj);
- } catch (IllegalAccessException | InvocationTargetException e) {
- BotLogger.error("Could not add reply", TAG, e);
- throw propagate(e);
- }
- };
- }
-
- private void postConsumption(Pair pair) {
- ofNullable(pair.b().postAction())
- .ifPresent(consumer -> consumer.accept(pair.a()));
- }
-
- Pair consumeUpdate(Pair pair) {
- pair.b().action().accept(pair.a());
- return pair;
- }
-
- Pair getContext(Trio trio) {
- Update update = trio.a();
- User user = AbilityUtils.getUser(update);
-
- return Pair.of(newContext(update, user, getChatId(update), trio.c()), trio.b());
- }
-
- boolean checkBlacklist(Update update) {
- Integer id = AbilityUtils.getUser(update).getId();
-
- return id == creatorId() || !blacklist().contains(id);
- }
-
- boolean checkInput(Trio trio) {
- String[] tokens = trio.c();
- int abilityTokens = trio.b().tokens();
-
- boolean isOk = abilityTokens == 0 || (tokens.length > 0 && tokens.length == abilityTokens);
-
- if (!isOk)
- silent.send(
- getLocalizedMessage(
- CHECK_INPUT_FAIL,
- AbilityUtils.getUser(trio.a()).getLanguageCode(),
- abilityTokens, abilityTokens == 1 ? "input" : "inputs"),
- getChatId(trio.a()));
- return isOk;
- }
-
- boolean checkLocality(Trio trio) {
- Update update = trio.a();
- Locality locality = isUserMessage(update) ? USER : GROUP;
- Locality abilityLocality = trio.b().locality();
-
- boolean isOk = abilityLocality == ALL || locality == abilityLocality;
-
- if (!isOk)
- silent.send(
- getLocalizedMessage(
- CHECK_LOCALITY_FAIL,
- AbilityUtils.getUser(trio.a()).getLanguageCode(),
- abilityLocality.toString().toLowerCase()),
- getChatId(trio.a()));
- return isOk;
- }
-
- boolean checkPrivacy(Trio trio) {
- Update update = trio.a();
- User user = AbilityUtils.getUser(update);
- Privacy privacy;
- int id = user.getId();
-
- privacy = getPrivacy(update, id);
-
- boolean isOk = privacy.compareTo(trio.b().privacy()) >= 0;
-
- if (!isOk)
- silent.send(
- getLocalizedMessage(
- CHECK_PRIVACY_FAIL,
- AbilityUtils.getUser(trio.a()).getLanguageCode()),
- getChatId(trio.a()));
- return isOk;
- }
-
- @NotNull
- private Privacy getPrivacy(Update update, int id) {
- return isCreator(id) ?
- CREATOR : isAdmin(id) ?
- ADMIN : (isGroupUpdate(update) || isSuperGroupUpdate(update)) && isGroupAdmin(update, id) ?
- GROUP_ADMIN : PUBLIC;
- }
-
- private boolean isGroupAdmin(Update update, int id) {
- GetChatAdministrators admins = new GetChatAdministrators().setChatId(getChatId(update));
-
- return silent.execute(admins)
- .orElse(new ArrayList<>()).stream()
- .anyMatch(member -> member.getUser().getId() == id);
- }
-
- private boolean isCreator(int id) {
- return id == creatorId();
- }
-
- private boolean isAdmin(Integer id) {
- return admins().contains(id);
- }
-
- boolean validateAbility(Trio trio) {
- return trio.b() != null;
- }
-
- Trio getAbility(Update update) {
- // Handle updates without messages
- // Passing through this function means that the global flags have passed
- Message msg = update.getMessage();
- if (!update.hasMessage() || !msg.hasText())
- return Trio.of(update, abilities.get(DEFAULT), new String[]{});
-
- String[] tokens = msg.getText().split(" ");
-
- if (tokens[0].startsWith("/")) {
- String abilityToken = stripBotUsername(tokens[0].substring(1)).toLowerCase();
- Ability ability = abilities.get(abilityToken);
- tokens = Arrays.copyOfRange(tokens, 1, tokens.length);
- return Trio.of(update, ability, tokens);
- } else {
- Ability ability = abilities.get(DEFAULT);
- return Trio.of(update, ability, tokens);
- }
- }
-
- private String stripBotUsername(String token) {
- return compile(format("@%s", botUsername), CASE_INSENSITIVE)
- .matcher(token)
- .replaceAll("");
- }
-
- Update addUser(Update update) {
- User endUser = AbilityUtils.getUser(update);
-
- users().compute(endUser.getId(), (id, user) -> {
- if (user == null) {
- updateUserId(user, endUser);
- return endUser;
- }
-
- if (!user.equals(endUser)) {
- updateUserId(user, endUser);
- return endUser;
- }
-
- return user;
- });
-
- db.commit();
- return update;
- }
-
- private void updateUserId(User oldUser, User newUser) {
- if (oldUser != null && oldUser.getUserName() != null) {
- // Remove old username -> ID
- userIds().remove(oldUser.getUserName());
+ };
}
- if (newUser.getUserName() != null) {
- // Add new mapping with the new username
- userIds().put(newUser.getUserName().toLowerCase(), newUser.getId());
+ /**
+ * Invokes the method and retrieves its return {@link Ability}.
+ *
+ * @param obj an bot or extension that this method is invoked with
+ * @return a {@link Function} which returns the {@link Ability} returned by the given method
+ */
+ private Function returnAbility(Object obj) {
+ return method -> {
+ try {
+ return (Ability) method.invoke(obj);
+ } catch (IllegalAccessException | InvocationTargetException e) {
+ log.error("Could not add ability", e);
+ throw new RuntimeException(e);
+ }
+ };
}
- }
- boolean filterReply(Update update) {
- return replies.stream()
- .filter(reply -> reply.isOkFor(update))
- .map(reply -> {
- reply.actOn(update);
- return false;
- })
- .reduce(true, Boolean::logicalAnd);
- }
+ /**
+ * Invokes the method and retrieves its return {@link Reply}.
+ *
+ * @param obj an bot or extension that this method is invoked with
+ * @return a {@link Function} which returns the {@link Reply} returned by the given method
+ */
+ private Function returnReply(Object obj) {
+ return method -> {
+ try {
+ return (Reply) method.invoke(obj);
+ } catch (IllegalAccessException | InvocationTargetException e) {
+ log.error("Could not add reply", e);
+ throw new RuntimeException(e);
+ }
+ };
+ }
- boolean checkMessageFlags(Trio trio) {
- Ability ability = trio.b();
- Update update = trio.a();
+ private void postConsumption(Pair pair) {
+ ofNullable(pair.b().postAction())
+ .ifPresent(consumer -> consumer.accept(pair.a()));
+ }
- // The following variable is required to avoid bug #JDK-8044546
- BiFunction, Boolean> flagAnd = (flag, nextFlag) -> flag && nextFlag.test(update);
- return ability.flags().stream()
- .reduce(true, flagAnd, Boolean::logicalAnd);
- }
+ Pair consumeUpdate(Pair pair) {
+ pair.b().action().accept(pair.a());
+ return pair;
+ }
- private File downloadFileWithId(String fileId) throws TelegramApiException {
- return sender.downloadFile(sender.execute(new GetFile().setFileId(fileId)));
- }
+ Pair getContext(Trio trio) {
+ Update update = trio.a();
+ User user = AbilityUtils.getUser(update);
+
+ return Pair.of(newContext(update, user, getChatId(update), trio.c()), trio.b());
+ }
+
+ boolean checkBlacklist(Update update) {
+ Integer id = AbilityUtils.getUser(update).getId();
+
+ return id == creatorId() || !blacklist().contains(id);
+ }
+
+ boolean checkInput(Trio trio) {
+ String[] tokens = trio.c();
+ int abilityTokens = trio.b().tokens();
+
+ boolean isOk = abilityTokens == 0 || (tokens.length > 0 && tokens.length == abilityTokens);
+
+ if (!isOk)
+ silent.send(
+ getLocalizedMessage(
+ CHECK_INPUT_FAIL,
+ AbilityUtils.getUser(trio.a()).getLanguageCode(),
+ abilityTokens, abilityTokens == 1 ? "input" : "inputs"),
+ getChatId(trio.a()));
+ return isOk;
+ }
+
+ boolean checkLocality(Trio trio) {
+ Update update = trio.a();
+ Locality locality = isUserMessage(update) ? USER : GROUP;
+ Locality abilityLocality = trio.b().locality();
+
+ boolean isOk = abilityLocality == ALL || locality == abilityLocality;
+
+ if (!isOk)
+ silent.send(
+ getLocalizedMessage(
+ CHECK_LOCALITY_FAIL,
+ AbilityUtils.getUser(trio.a()).getLanguageCode(),
+ abilityLocality.toString().toLowerCase()),
+ getChatId(trio.a()));
+ return isOk;
+ }
+
+ boolean checkPrivacy(Trio trio) {
+ Update update = trio.a();
+ User user = AbilityUtils.getUser(update);
+ Privacy privacy;
+ int id = user.getId();
+
+ privacy = getPrivacy(update, id);
+
+ boolean isOk = privacy.compareTo(trio.b().privacy()) >= 0;
+
+ if (!isOk)
+ silent.send(
+ getLocalizedMessage(
+ CHECK_PRIVACY_FAIL,
+ AbilityUtils.getUser(trio.a()).getLanguageCode()),
+ getChatId(trio.a()));
+ return isOk;
+ }
+
+ @NotNull
+ private Privacy getPrivacy(Update update, int id) {
+ return isCreator(id) ?
+ CREATOR : isAdmin(id) ?
+ ADMIN : (isGroupUpdate(update) || isSuperGroupUpdate(update)) && isGroupAdmin(update, id) ?
+ GROUP_ADMIN : PUBLIC;
+ }
+
+ private boolean isGroupAdmin(Update update, int id) {
+ GetChatAdministrators admins = new GetChatAdministrators().setChatId(getChatId(update));
+
+ return silent.execute(admins)
+ .orElse(new ArrayList<>()).stream()
+ .anyMatch(member -> member.getUser().getId() == id);
+ }
+
+ private boolean isCreator(int id) {
+ return id == creatorId();
+ }
+
+ private boolean isAdmin(Integer id) {
+ return admins().contains(id);
+ }
+
+ boolean validateAbility(Trio trio) {
+ return trio.b() != null;
+ }
+
+ Trio getAbility(Update update) {
+ // Handle updates without messages
+ // Passing through this function means that the global flags have passed
+ Message msg = update.getMessage();
+ if (!update.hasMessage() || !msg.hasText())
+ return Trio.of(update, abilities.get(DEFAULT), new String[]{});
+
+ String[] tokens = msg.getText().split(" ");
+
+ if (tokens[0].startsWith("/")) {
+ String abilityToken = stripBotUsername(tokens[0].substring(1)).toLowerCase();
+ Ability ability = abilities.get(abilityToken);
+ tokens = Arrays.copyOfRange(tokens, 1, tokens.length);
+ return Trio.of(update, ability, tokens);
+ } else {
+ Ability ability = abilities.get(DEFAULT);
+ return Trio.of(update, ability, tokens);
+ }
+ }
+
+ private String stripBotUsername(String token) {
+ return compile(format("@%s", botUsername), CASE_INSENSITIVE)
+ .matcher(token)
+ .replaceAll("");
+ }
+
+ Update addUser(Update update) {
+ User endUser = AbilityUtils.getUser(update);
+
+ users().compute(endUser.getId(), (id, user) -> {
+ if (user == null) {
+ updateUserId(user, endUser);
+ return endUser;
+ }
+
+ if (!user.equals(endUser)) {
+ updateUserId(user, endUser);
+ return endUser;
+ }
+
+ return user;
+ });
+
+ db.commit();
+ return update;
+ }
+
+ private void updateUserId(User oldUser, User newUser) {
+ if (oldUser != null && oldUser.getUserName() != null) {
+ // Remove old username -> ID
+ userIds().remove(oldUser.getUserName());
+ }
+
+ if (newUser.getUserName() != null) {
+ // Add new mapping with the new username
+ userIds().put(newUser.getUserName().toLowerCase(), newUser.getId());
+ }
+ }
+
+ boolean filterReply(Update update) {
+ return replies.stream()
+ .filter(reply -> reply.isOkFor(update))
+ .map(reply -> {
+ reply.actOn(update);
+ return false;
+ })
+ .reduce(true, Boolean::logicalAnd);
+ }
+
+ boolean checkMessageFlags(Trio trio) {
+ Ability ability = trio.b();
+ Update update = trio.a();
+
+ // The following variable is required to avoid bug #JDK-8044546
+ BiFunction, Boolean> flagAnd = (flag, nextFlag) -> flag && nextFlag.test(update);
+ return ability.flags().stream()
+ .reduce(true, flagAnd, Boolean::logicalAnd);
+ }
+
+ private File downloadFileWithId(String fileId) throws TelegramApiException {
+ return sender.downloadFile(sender.execute(new GetFile().setFileId(fileId)));
+ }
- private String escape(String username) {
- return username.replace("_", "\\_");
- }
+ private String escape(String username) {
+ return username.replace("_", "\\_");
+ }
}
\ No newline at end of file
diff --git a/telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/db/DBContext.java b/telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/db/DBContext.java
index 9fce2c8a..bb33ec22 100644
--- a/telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/db/DBContext.java
+++ b/telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/db/DBContext.java
@@ -11,7 +11,7 @@ import java.util.Set;
/**
* This interface represents the high-level methods exposed to the user when handling an {@link Update}.
* Example usage:
- *