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