nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/commands/UpdateGroupCommand.java

   1 package org.asamk.signal.commands;
   2
   3 import net.sourceforge.argparse4j.impl.Arguments;
   4 import net.sourceforge.argparse4j.inf.Namespace;
   5 import net.sourceforge.argparse4j.inf.Subparser;
   6
   7 import org.asamk.signal.commands.exceptions.CommandException;
   8 import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
   9 import org.asamk.signal.commands.exceptions.UserErrorException;
  10 import org.asamk.signal.manager.Manager;
  11 import org.asamk.signal.manager.api.AttachmentInvalidException;
  12 import org.asamk.signal.manager.api.SendGroupMessageResults;
  13 import org.asamk.signal.manager.api.UnregisteredRecipientException;
  14 import org.asamk.signal.manager.api.UpdateGroup;
  15 import org.asamk.signal.manager.groups.GroupId;
  16 import org.asamk.signal.manager.groups.GroupLinkState;
  17 import org.asamk.signal.manager.groups.GroupNotFoundException;
  18 import org.asamk.signal.manager.groups.GroupPermission;
  19 import org.asamk.signal.manager.groups.GroupSendingNotAllowedException;
  20 import org.asamk.signal.manager.groups.NotAGroupMemberException;
  21 import org.asamk.signal.output.JsonWriter;
  22 import org.asamk.signal.output.OutputWriter;
  23 import org.asamk.signal.output.PlainTextWriter;
  24 import org.asamk.signal.util.CommandUtil;
  25 import org.asamk.signal.util.SendMessageResultUtils;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 import java.io.File;
  30 import java.io.IOException;
  31 import java.util.HashMap;
  32 import java.util.stream.Stream;
  33
  34 public class UpdateGroupCommand implements JsonRpcLocalCommand {
  35
  36     private final static Logger logger = LoggerFactory.getLogger(UpdateGroupCommand.class);
  37
  38     @Override
  39     public String getName() {
  40         return "updateGroup";
  41     }
  42
  43     @Override
  44     public void attachToSubparser(final Subparser subparser) {
  45         subparser.help("Create or update a group.");
  46         subparser.addArgument("-g", "--group-id", "--group").help("Specify the group ID.");
  47         subparser.addArgument("-n", "--name").help("Specify the new group name.");
  48         subparser.addArgument("-d", "--description").help("Specify the new group description.");
  49         subparser.addArgument("-a", "--avatar").help("Specify a new group avatar image file");
  50         subparser.addArgument("-m", "--member").nargs("*").help("Specify one or more members to add to the group");
  51         subparser.addArgument("-r", "--remove-member")
  52                 .nargs("*")
  53                 .help("Specify one or more members to remove from the group");
  54         subparser.addArgument("--admin").nargs("*").help("Specify one or more members to make a group admin");
  55         subparser.addArgument("--remove-admin")
  56                 .nargs("*")
  57                 .help("Specify one or more members to remove group admin privileges");
  58         subparser.addArgument("--ban").nargs("*").help("Specify one or more members to ban from joining the group");
  59         subparser.addArgument("--unban").nargs("*").help("Specify one or more members to remove from the ban list");
  60
  61         subparser.addArgument("--reset-link")
  62                 .action(Arguments.storeTrue())
  63                 .help("Reset group link and create new link password");
  64         subparser.addArgument("--link")
  65                 .help("Set group link state, with or without admin approval")
  66                 .choices("enabled", "enabled-with-approval", "disabled");
  67
  68         subparser.addArgument("--set-permission-add-member")
  69                 .help("Set permission to add new group members")
  70                 .choices("every-member", "only-admins");
  71         subparser.addArgument("--set-permission-edit-details")
  72                 .help("Set permission to edit group details")
  73                 .choices("every-member", "only-admins");
  74         subparser.addArgument("--set-permission-send-messages")
  75                 .help("Set permission to send messages")
  76                 .choices("every-member", "only-admins");
  77
  78         subparser.addArgument("-e", "--expiration").type(int.class).help("Set expiration time of messages (seconds)");
  79     }
  80
  81     GroupLinkState getGroupLinkState(String value) throws UserErrorException {
  82         if (value == null) {
  83             return null;
  84         }
  85         return switch (value) {
  86             case "enabled" -> GroupLinkState.ENABLED;
  87             case "enabled-with-approval", "enabledWithApproval" -> GroupLinkState.ENABLED_WITH_APPROVAL;
  88             case "disabled" -> GroupLinkState.DISABLED;
  89             default -> throw new UserErrorException("Invalid group link state: " + value);
  90         };
  91     }
  92
  93     GroupPermission getGroupPermission(String value) throws UserErrorException {
  94         if (value == null) {
  95             return null;
  96         }
  97         return switch (value) {
  98             case "every-member", "everyMember" -> GroupPermission.EVERY_MEMBER;
  99             case "only-admins", "onlyAdmins" -> GroupPermission.ONLY_ADMINS;
 100             default -> throw new UserErrorException("Invalid group permission: " + value);
 101         };
 102     }
 103
 104     @Override
 105     public void handleCommand(
 106             final Namespace ns, final Manager m, final OutputWriter outputWriter
 107     ) throws CommandException {
 108         final var groupIdString = ns.getString("group-id");
 109         var groupId = CommandUtil.getGroupId(groupIdString);
 110
 111         final var localNumber = m.getSelfNumber();
 112
 113         var groupName = ns.getString("name");
 114         var groupDescription = ns.getString("description");
 115         var groupMembers = CommandUtil.getSingleRecipientIdentifiers(ns.getList("member"), localNumber);
 116         var groupRemoveMembers = CommandUtil.getSingleRecipientIdentifiers(ns.getList("remove-member"), localNumber);
 117         var groupAdmins = CommandUtil.getSingleRecipientIdentifiers(ns.getList("admin"), localNumber);
 118         var groupRemoveAdmins = CommandUtil.getSingleRecipientIdentifiers(ns.getList("remove-admin"), localNumber);
 119         var groupBan = CommandUtil.getSingleRecipientIdentifiers(ns.getList("ban"), localNumber);
 120         var groupUnban = CommandUtil.getSingleRecipientIdentifiers(ns.getList("unban"), localNumber);
 121         var groupAvatar = ns.getString("avatar");
 122         var groupResetLink = Boolean.TRUE.equals(ns.getBoolean("reset-link"));
 123         var groupLinkState = getGroupLinkState(ns.getString("link"));
 124         var groupExpiration = ns.getInt("expiration");
 125         var groupAddMemberPermission = getGroupPermission(ns.getString("set-permission-add-member"));
 126         var groupEditDetailsPermission = getGroupPermission(ns.getString("set-permission-edit-details"));
 127         var groupSendMessagesPermission = getGroupPermission(ns.getString("set-permission-send-messages"));
 128
 129         try {
 130             boolean isNewGroup = false;
 131             SendGroupMessageResults groupMessageResults = null;
 132             if (groupId == null) {
 133                 isNewGroup = true;
 134                 var results = m.createGroup(groupName,
 135                         groupMembers,
 136                         groupAvatar == null ? null : new File(groupAvatar));
 137                 groupMessageResults = results.second();
 138                 groupId = results.first();
 139                 groupName = null;
 140                 groupMembers = null;
 141                 groupAvatar = null;
 142             }
 143
 144             var results = m.updateGroup(groupId,
 145                     UpdateGroup.newBuilder()
 146                             .withName(groupName)
 147                             .withDescription(groupDescription)
 148                             .withMembers(groupMembers)
 149                             .withRemoveMembers(groupRemoveMembers)
 150                             .withAdmins(groupAdmins)
 151                             .withRemoveAdmins(groupRemoveAdmins)
 152                             .withBanMembers(groupBan)
 153                             .withUnbanMembers(groupUnban)
 154                             .withResetGroupLink(groupResetLink)
 155                             .withGroupLinkState(groupLinkState)
 156                             .withAddMemberPermission(groupAddMemberPermission)
 157                             .withEditDetailsPermission(groupEditDetailsPermission)
 158                             .withAvatarFile(groupAvatar == null ? null : new File(groupAvatar))
 159                             .withExpirationTimer(groupExpiration)
 160                             .withIsAnnouncementGroup(groupSendMessagesPermission == null
 161                                     ? null
 162                                     : groupSendMessagesPermission == GroupPermission.ONLY_ADMINS)
 163                             .build());
 164             if (results != null) {
 165                 if (groupMessageResults == null) {
 166                     groupMessageResults = results;
 167                 } else {
 168                     groupMessageResults = new SendGroupMessageResults(results.timestamp(),
 169                             Stream.concat(groupMessageResults.results().stream(), results.results().stream()).toList());
 170                 }
 171             }
 172             outputResult(outputWriter, groupMessageResults, isNewGroup ? groupId : null);
 173         } catch (AttachmentInvalidException e) {
 174             throw new UserErrorException("Failed to add avatar attachment for group\": " + e.getMessage());
 175         } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
 176             throw new UserErrorException(e.getMessage());
 177         } catch (UnregisteredRecipientException e) {
 178             throw new UserErrorException("The user " + e.getSender().getIdentifier() + " is not registered.");
 179         } catch (IOException e) {
 180             throw new UnexpectedErrorException("Failed to send message: " + e.getMessage() + " (" + e.getClass()
 181                     .getSimpleName() + ")", e);
 182         }
 183     }
 184
 185     private void outputResult(
 186             final OutputWriter outputWriter, final SendGroupMessageResults results, final GroupId groupId
 187     ) {
 188         if (outputWriter instanceof PlainTextWriter writer) {
 189             if (groupId != null) {
 190                 writer.println("Created new group: \"{}\"", groupId.toBase64());
 191             }
 192             if (results != null) {
 193                 var errors = SendMessageResultUtils.getErrorMessagesFromSendMessageResults(results.results());
 194                 SendMessageResultUtils.printSendMessageResultErrors(writer, errors);
 195                 writer.println("{}", results.timestamp());
 196             }
 197         } else {
 198             final var writer = (JsonWriter) outputWriter;
 199             final var response = new HashMap<>();
 200             if (results != null) {
 201                 response.put("timestamp", results.timestamp());
 202                 var jsonResults = SendMessageResultUtils.getJsonSendMessageResults(results.results());
 203                 response.put("results", jsonResults);
 204             }
 205             if (groupId != null) {
 206                 response.put("groupId", groupId.toBase64());
 207             }
 208             writer.write(response);
 209         }
 210     }
 211 }