Add --scrub-log flag to remove possibly sensitive information from the log

[signal-cli] / src / main / java / org / asamk / signal / commands / UpdateGroupCommand.java

diff --git a/src/main/java/org/asamk/signal/commands/UpdateGroupCommand.java b/src/main/java/org/asamk/signal/commands/UpdateGroupCommand.java
index 931ad76371216170cf51ce7e64dd60c738ab8508..411ae74762fbf84b1d130af4a35bd019297cad45 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/UpdateGroupCommand.java
+++ b/src/main/java/org/asamk/signal/commands/UpdateGroupCommand.java
@@ -4,40 +4,46 @@ import net.sourceforge.argparse4j.impl.Arguments;
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 

-import org.asamk.Signal;
-import org.asamk.signal.GroupLinkState;
-import org.asamk.signal.GroupPermission;
-import org.asamk.signal.PlainTextWriterImpl;

 import org.asamk.signal.commands.exceptions.CommandException;
 import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
 import org.asamk.signal.commands.exceptions.UserErrorException;
 import org.asamk.signal.commands.exceptions.CommandException;
 import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
 import org.asamk.signal.commands.exceptions.UserErrorException;

-import org.asamk.signal.manager.AttachmentInvalidException;

 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.Manager;

+import org.asamk.signal.manager.api.AttachmentInvalidException;
+import org.asamk.signal.manager.api.SendGroupMessageResults;
+import org.asamk.signal.manager.api.UnregisteredRecipientException;
+import org.asamk.signal.manager.api.UpdateGroup;

 import org.asamk.signal.manager.groups.GroupId;
 import org.asamk.signal.manager.groups.GroupId;

-import org.asamk.signal.manager.groups.GroupIdFormatException;
+import org.asamk.signal.manager.groups.GroupLinkState;

 import org.asamk.signal.manager.groups.GroupNotFoundException;
 import org.asamk.signal.manager.groups.GroupNotFoundException;

+import org.asamk.signal.manager.groups.GroupPermission;
+import org.asamk.signal.manager.groups.GroupSendingNotAllowedException;

 import org.asamk.signal.manager.groups.NotAGroupMemberException;
 import org.asamk.signal.manager.groups.NotAGroupMemberException;

-import org.asamk.signal.util.ErrorUtils;
-import org.asamk.signal.util.Util;
-import org.freedesktop.dbus.exceptions.DBusExecutionException;
+import org.asamk.signal.output.JsonWriter;
+import org.asamk.signal.output.OutputWriter;
+import org.asamk.signal.output.PlainTextWriter;
+import org.asamk.signal.util.CommandUtil;
+import org.asamk.signal.util.SendMessageResultUtils;

 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

-import org.whispersystems.signalservice.api.util.InvalidNumberException;

 
 import java.io.File;
 import java.io.IOException;
 
 import java.io.File;
 import java.io.IOException;

-import java.util.ArrayList;
-import java.util.Base64;
-import java.util.List;
+import java.util.HashMap;
+import java.util.stream.Stream;

 
 

-public class UpdateGroupCommand implements DbusCommand, LocalCommand {
+public class UpdateGroupCommand implements JsonRpcLocalCommand {

 
     private final static Logger logger = LoggerFactory.getLogger(UpdateGroupCommand.class);
 
 
     private final static Logger logger = LoggerFactory.getLogger(UpdateGroupCommand.class);
 

+    @Override
+    public String getName() {
+        return "updateGroup";
+    }
+

     @Override
     public void attachToSubparser(final Subparser subparser) {
         subparser.help("Create or update a group.");
     @Override
     public void attachToSubparser(final Subparser subparser) {
         subparser.help("Create or update a group.");

-        subparser.addArgument("-g", "--group").help("Specify the recipient group ID.");
+        subparser.addArgument("-g", "--group-id", "--group").help("Specify the group ID.");

         subparser.addArgument("-n", "--name").help("Specify the new group name.");
         subparser.addArgument("-d", "--description").help("Specify the new group description.");
         subparser.addArgument("-a", "--avatar").help("Specify a new group avatar image file");
         subparser.addArgument("-n", "--name").help("Specify the new group name.");
         subparser.addArgument("-d", "--description").help("Specify the new group description.");
         subparser.addArgument("-a", "--avatar").help("Specify a new group avatar image file");


@@ -49,131 +55,157 @@ public class UpdateGroupCommand implements DbusCommand, LocalCommand {
         subparser.addArgument("--remove-admin")
                 .nargs("*")
                 .help("Specify one or more members to remove group admin privileges");
         subparser.addArgument("--remove-admin")
                 .nargs("*")
                 .help("Specify one or more members to remove group admin privileges");

+        subparser.addArgument("--ban").nargs("*").help("Specify one or more members to ban from joining the group");
+        subparser.addArgument("--unban").nargs("*").help("Specify one or more members to remove from the ban list");

 
         subparser.addArgument("--reset-link")
                 .action(Arguments.storeTrue())
                 .help("Reset group link and create new link password");
         subparser.addArgument("--link")
                 .help("Set group link state, with or without admin approval")
 
         subparser.addArgument("--reset-link")
                 .action(Arguments.storeTrue())
                 .help("Reset group link and create new link password");
         subparser.addArgument("--link")
                 .help("Set group link state, with or without admin approval")

-                .type(Arguments.enumStringType(GroupLinkState.class));
+                .choices("enabled", "enabled-with-approval", "disabled");

 
         subparser.addArgument("--set-permission-add-member")
                 .help("Set permission to add new group members")
 
         subparser.addArgument("--set-permission-add-member")
                 .help("Set permission to add new group members")

-                .type(Arguments.enumStringType(GroupPermission.class));
+                .choices("every-member", "only-admins");

         subparser.addArgument("--set-permission-edit-details")
                 .help("Set permission to edit group details")
         subparser.addArgument("--set-permission-edit-details")
                 .help("Set permission to edit group details")

-                .type(Arguments.enumStringType(GroupPermission.class));
+                .choices("every-member", "only-admins");
+        subparser.addArgument("--set-permission-send-messages")
+                .help("Set permission to send messages")
+                .choices("every-member", "only-admins");

 
         subparser.addArgument("-e", "--expiration").type(int.class).help("Set expiration time of messages (seconds)");
     }
 
 
         subparser.addArgument("-e", "--expiration").type(int.class).help("Set expiration time of messages (seconds)");
     }
 

-    @Override
-    public void handleCommand(final Namespace ns, final Manager m) throws CommandException {
-        final var writer = new PlainTextWriterImpl(System.out);
-        GroupId groupId = null;
-        final var groupIdString = ns.getString("group");
-        if (groupIdString != null) {
-            try {
-                groupId = Util.decodeGroupId(groupIdString);
-            } catch (GroupIdFormatException e) {
-                throw new UserErrorException("Invalid group id: " + e.getMessage());
-            }
+    GroupLinkState getGroupLinkState(String value) throws UserErrorException {
+        if (value == null) {
+            return null;
+        }
+        return switch (value) {
+            case "enabled" -> GroupLinkState.ENABLED;
+            case "enabled-with-approval", "enabledWithApproval" -> GroupLinkState.ENABLED_WITH_APPROVAL;
+            case "disabled" -> GroupLinkState.DISABLED;
+            default -> throw new UserErrorException("Invalid group link state: " + value);
+        };
+    }
+
+    GroupPermission getGroupPermission(String value) throws UserErrorException {
+        if (value == null) {
+            return null;

         }
         }

+        return switch (value) {
+            case "every-member", "everyMember" -> GroupPermission.EVERY_MEMBER;
+            case "only-admins", "onlyAdmins" -> GroupPermission.ONLY_ADMINS;
+            default -> throw new UserErrorException("Invalid group permission: " + value);
+        };
+    }
+
+    @Override
+    public void handleCommand(
+            final Namespace ns, final Manager m, final OutputWriter outputWriter
+    ) throws CommandException {
+        final var groupIdString = ns.getString("group-id");
+        var groupId = CommandUtil.getGroupId(groupIdString);
+
+        final var localNumber = m.getSelfNumber();

 
         var groupName = ns.getString("name");
         var groupDescription = ns.getString("description");
 
         var groupName = ns.getString("name");
         var groupDescription = ns.getString("description");

-        var groupMembers = ns.<String>getList("member");
-        var groupRemoveMembers = ns.<String>getList("remove-member");
-        var groupAdmins = ns.<String>getList("admin");
-        var groupRemoveAdmins = ns.<String>getList("remove-admin");
+        var groupMembers = CommandUtil.getSingleRecipientIdentifiers(ns.getList("member"), localNumber);
+        var groupRemoveMembers = CommandUtil.getSingleRecipientIdentifiers(ns.getList("remove-member"), localNumber);
+        var groupAdmins = CommandUtil.getSingleRecipientIdentifiers(ns.getList("admin"), localNumber);
+        var groupRemoveAdmins = CommandUtil.getSingleRecipientIdentifiers(ns.getList("remove-admin"), localNumber);
+        var groupBan = CommandUtil.getSingleRecipientIdentifiers(ns.getList("ban"), localNumber);
+        var groupUnban = CommandUtil.getSingleRecipientIdentifiers(ns.getList("unban"), localNumber);

         var groupAvatar = ns.getString("avatar");
         var groupAvatar = ns.getString("avatar");

-        var groupResetLink = ns.getBoolean("reset-link");
-        var groupLinkState = ns.<GroupLinkState>get("link");
+        var groupResetLink = Boolean.TRUE.equals(ns.getBoolean("reset-link"));
+        var groupLinkState = getGroupLinkState(ns.getString("link"));

         var groupExpiration = ns.getInt("expiration");
         var groupExpiration = ns.getInt("expiration");

-        var groupAddMemberPermission = ns.<GroupPermission>get("set-permission-add-member");
-        var groupEditDetailsPermission = ns.<GroupPermission>get("set-permission-edit-details");
+        var groupAddMemberPermission = getGroupPermission(ns.getString("set-permission-add-member"));
+        var groupEditDetailsPermission = getGroupPermission(ns.getString("set-permission-edit-details"));
+        var groupSendMessagesPermission = getGroupPermission(ns.getString("set-permission-send-messages"));

 
         try {
 
         try {

+            boolean isNewGroup = false;
+            SendGroupMessageResults groupMessageResults = null;

             if (groupId == null) {
             if (groupId == null) {

+                isNewGroup = true;

                 var results = m.createGroup(groupName,
                         groupMembers,
                         groupAvatar == null ? null : new File(groupAvatar));
                 var results = m.createGroup(groupName,
                         groupMembers,
                         groupAvatar == null ? null : new File(groupAvatar));

-                ErrorUtils.handleTimestampAndSendMessageResults(writer, 0, results.second());
+                groupMessageResults = results.second();

                 groupId = results.first();
                 groupId = results.first();

-                writer.println("Created new group: \"{}\"", groupId.toBase64());

                 groupName = null;
                 groupMembers = null;
                 groupAvatar = null;
             }
 
             var results = m.updateGroup(groupId,
                 groupName = null;
                 groupMembers = null;
                 groupAvatar = null;
             }
 
             var results = m.updateGroup(groupId,

-                    groupName,
-                    groupDescription,
-                    groupMembers,
-                    groupRemoveMembers,
-                    groupAdmins,
-                    groupRemoveAdmins,
-                    groupResetLink,
-                    groupLinkState != null ? groupLinkState.toLinkState() : null,
-                    groupAddMemberPermission != null ? groupAddMemberPermission.toManager() : null,
-                    groupEditDetailsPermission != null ? groupEditDetailsPermission.toManager() : null,
-                    groupAvatar == null ? null : new File(groupAvatar),
-                    groupExpiration);
+                    UpdateGroup.newBuilder()
+                            .withName(groupName)
+                            .withDescription(groupDescription)
+                            .withMembers(groupMembers)
+                            .withRemoveMembers(groupRemoveMembers)
+                            .withAdmins(groupAdmins)
+                            .withRemoveAdmins(groupRemoveAdmins)
+                            .withBanMembers(groupBan)
+                            .withUnbanMembers(groupUnban)
+                            .withResetGroupLink(groupResetLink)
+                            .withGroupLinkState(groupLinkState)
+                            .withAddMemberPermission(groupAddMemberPermission)
+                            .withEditDetailsPermission(groupEditDetailsPermission)
+                            .withAvatarFile(groupAvatar == null ? null : new File(groupAvatar))
+                            .withExpirationTimer(groupExpiration)
+                            .withIsAnnouncementGroup(groupSendMessagesPermission == null
+                                    ? null
+                                    : groupSendMessagesPermission == GroupPermission.ONLY_ADMINS)
+                            .build());

             if (results != null) {
             if (results != null) {

-                ErrorUtils.handleTimestampAndSendMessageResults(writer, results.first(), results.second());
+                if (groupMessageResults == null) {
+                    groupMessageResults = results;
+                } else {
+                    groupMessageResults = new SendGroupMessageResults(results.timestamp(),
+                            Stream.concat(groupMessageResults.results().stream(), results.results().stream()).toList());
+                }

             }
             }

+            outputResult(outputWriter, groupMessageResults, isNewGroup ? groupId : null);

         } catch (AttachmentInvalidException e) {
             throw new UserErrorException("Failed to add avatar attachment for group\": " + e.getMessage());
         } catch (AttachmentInvalidException e) {
             throw new UserErrorException("Failed to add avatar attachment for group\": " + e.getMessage());

-        } catch (GroupNotFoundException e) {
-            logger.warn("Unknown group id: {}", groupIdString);
-        } catch (NotAGroupMemberException e) {
-            logger.warn("You're not a group member");
-        } catch (InvalidNumberException e) {
-            throw new UserErrorException("Failed to parse member number: " + e.getMessage());
+        } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
+            throw new UserErrorException(e.getMessage());
+        } catch (UnregisteredRecipientException e) {
+            throw new UserErrorException("The user " + e.getSender().getIdentifier() + " is not registered.");

         } catch (IOException e) {
         } catch (IOException e) {

-            throw new UnexpectedErrorException("Failed to send message: " + e.getMessage());
+            throw new UnexpectedErrorException("Failed to send message: " + e.getMessage() + " (" + e.getClass()
+                    .getSimpleName() + ")", e);

         }
     }
 
         }
     }
 

-    @Override
-    public void handleCommand(final Namespace ns, final Signal signal) throws CommandException {
-        final var writer = new PlainTextWriterImpl(System.out);
-        byte[] groupId = null;
-        if (ns.getString("group") != null) {
-            try {
-                groupId = Util.decodeGroupId(ns.getString("group")).serialize();
-            } catch (GroupIdFormatException e) {
-                throw new UserErrorException("Invalid group id: " + e.getMessage());
+    private void outputResult(
+            final OutputWriter outputWriter, final SendGroupMessageResults results, final GroupId groupId
+    ) {
+        if (outputWriter instanceof PlainTextWriter writer) {
+            if (groupId != null) {
+                writer.println("Created new group: \"{}\"", groupId.toBase64());

             }
             }

-        }
-        if (groupId == null) {
-            groupId = new byte[0];
-        }
-
-        var groupName = ns.getString("name");
-        if (groupName == null) {
-            groupName = "";
-        }
-
-        List<String> groupMembers = ns.getList("member");
-        if (groupMembers == null) {
-            groupMembers = new ArrayList<>();
-        }
-
-        var groupAvatar = ns.getString("avatar");
-        if (groupAvatar == null) {
-            groupAvatar = "";
-        }
-
-        try {
-            var newGroupId = signal.updateGroup(groupId, groupName, groupMembers, groupAvatar);
-            if (groupId.length != newGroupId.length) {
-                writer.println("Created new group: \"{}\"", Base64.getEncoder().encodeToString(newGroupId));
+            if (results != null) {
+                var errors = SendMessageResultUtils.getErrorMessagesFromSendMessageResults(results.results());
+                SendMessageResultUtils.printSendMessageResultErrors(writer, errors);
+                writer.println("{}", results.timestamp());

             }
             }

-        } catch (Signal.Error.AttachmentInvalid e) {
-            throw new UserErrorException("Failed to add avatar attachment for group\": " + e.getMessage());
-        } catch (DBusExecutionException e) {
-            throw new UnexpectedErrorException("Failed to send message: " + e.getMessage());
+        } else {
+            final var writer = (JsonWriter) outputWriter;
+            final var response = new HashMap<>();
+            if (results != null) {
+                response.put("timestamp", results.timestamp());
+                var jsonResults = SendMessageResultUtils.getJsonSendMessageResults(results.results());
+                response.put("results", jsonResults);
+            }
+            if (groupId != null) {
+                response.put("groupId", groupId.toBase64());
+            }
+            writer.write(response);

         }
     }
 }
         }
     }
 }