]> nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/commands/UpdateGroupCommand.java
Implement announcement groups
[signal-cli] / 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;
8 import org.asamk.signal.JsonWriter;
9 import org.asamk.signal.OutputWriter;
10 import org.asamk.signal.PlainTextWriter;
11 import org.asamk.signal.commands.exceptions.CommandException;
12 import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
13 import org.asamk.signal.commands.exceptions.UserErrorException;
14 import org.asamk.signal.manager.AttachmentInvalidException;
15 import org.asamk.signal.manager.Manager;
16 import org.asamk.signal.manager.groups.GroupId;
17 import org.asamk.signal.manager.groups.GroupIdFormatException;
18 import org.asamk.signal.manager.groups.GroupLinkState;
19 import org.asamk.signal.manager.groups.GroupNotFoundException;
20 import org.asamk.signal.manager.groups.GroupPermission;
21 import org.asamk.signal.manager.groups.NotAGroupMemberException;
22 import org.asamk.signal.util.ErrorUtils;
23 import org.asamk.signal.util.Util;
24 import org.freedesktop.dbus.exceptions.DBusExecutionException;
25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
27 import org.whispersystems.signalservice.api.util.InvalidNumberException;
28
29 import java.io.File;
30 import java.io.IOException;
31 import java.util.ArrayList;
32 import java.util.HashMap;
33 import java.util.List;
34
35 public class UpdateGroupCommand implements DbusCommand, JsonRpcLocalCommand {
36
37 private final static Logger logger = LoggerFactory.getLogger(UpdateGroupCommand.class);
38
39 @Override
40 public String getName() {
41 return "updateGroup";
42 }
43
44 @Override
45 public void attachToSubparser(final Subparser subparser) {
46 subparser.help("Create or update a group.");
47 subparser.addArgument("-g", "--group-id", "--group").help("Specify the group ID.");
48 subparser.addArgument("-n", "--name").help("Specify the new group name.");
49 subparser.addArgument("-d", "--description").help("Specify the new group description.");
50 subparser.addArgument("-a", "--avatar").help("Specify a new group avatar image file");
51 subparser.addArgument("-m", "--member").nargs("*").help("Specify one or more members to add to the group");
52 subparser.addArgument("-r", "--remove-member")
53 .nargs("*")
54 .help("Specify one or more members to remove from the group");
55 subparser.addArgument("--admin").nargs("*").help("Specify one or more members to make a group admin");
56 subparser.addArgument("--remove-admin")
57 .nargs("*")
58 .help("Specify one or more members to remove group admin privileges");
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 switch (value) {
85 case "enabled":
86 return GroupLinkState.ENABLED;
87 case "enabled-with-approval":
88 case "enabledWithApproval":
89 return GroupLinkState.ENABLED_WITH_APPROVAL;
90 case "disabled":
91 return GroupLinkState.DISABLED;
92 default:
93 throw new UserErrorException("Invalid group link state: " + value);
94 }
95 }
96
97 GroupPermission getGroupPermission(String value) throws UserErrorException {
98 if (value == null) {
99 return null;
100 }
101 switch (value) {
102 case "every-member":
103 case "everyMember":
104 return GroupPermission.EVERY_MEMBER;
105 case "only-admins":
106 case "onlyAdmins":
107 return GroupPermission.ONLY_ADMINS;
108 default:
109 throw new UserErrorException("Invalid group permission: " + value);
110 }
111 }
112
113 @Override
114 public void handleCommand(
115 final Namespace ns, final Manager m, final OutputWriter outputWriter
116 ) throws CommandException {
117 GroupId groupId = null;
118 final var groupIdString = ns.getString("group-id");
119 if (groupIdString != null) {
120 try {
121 groupId = Util.decodeGroupId(groupIdString);
122 } catch (GroupIdFormatException e) {
123 throw new UserErrorException("Invalid group id: " + e.getMessage());
124 }
125 }
126
127 var groupName = ns.getString("name");
128 var groupDescription = ns.getString("description");
129 var groupMembers = ns.<String>getList("member");
130 var groupRemoveMembers = ns.<String>getList("remove-member");
131 var groupAdmins = ns.<String>getList("admin");
132 var groupRemoveAdmins = ns.<String>getList("remove-admin");
133 var groupAvatar = ns.getString("avatar");
134 var groupResetLink = ns.getBoolean("reset-link");
135 var groupLinkState = getGroupLinkState(ns.getString("link"));
136 var groupExpiration = ns.getInt("expiration");
137 var groupAddMemberPermission = getGroupPermission(ns.getString("set-permission-add-member"));
138 var groupEditDetailsPermission = getGroupPermission(ns.getString("set-permission-edit-details"));
139 var groupSendMessagesPermission = getGroupPermission(ns.getString("set-permission-send-messages"));
140
141 try {
142 boolean isNewGroup = false;
143 if (groupId == null) {
144 isNewGroup = true;
145 var results = m.createGroup(groupName,
146 groupMembers,
147 groupAvatar == null ? null : new File(groupAvatar));
148 ErrorUtils.handleSendMessageResults(results.second());
149 groupId = results.first();
150 groupName = null;
151 groupMembers = null;
152 groupAvatar = null;
153 }
154
155 var results = m.updateGroup(groupId,
156 groupName,
157 groupDescription,
158 groupMembers,
159 groupRemoveMembers,
160 groupAdmins,
161 groupRemoveAdmins,
162 groupResetLink,
163 groupLinkState,
164 groupAddMemberPermission,
165 groupEditDetailsPermission,
166 groupAvatar == null ? null : new File(groupAvatar),
167 groupExpiration,
168 groupSendMessagesPermission == null
169 ? null
170 : groupSendMessagesPermission == GroupPermission.ONLY_ADMINS);
171 Long timestamp = null;
172 if (results != null) {
173 timestamp = results.first();
174 ErrorUtils.handleSendMessageResults(results.second());
175 }
176 outputResult(outputWriter, timestamp, isNewGroup ? groupId : null);
177 } catch (AttachmentInvalidException e) {
178 throw new UserErrorException("Failed to add avatar attachment for group\": " + e.getMessage());
179 } catch (GroupNotFoundException e) {
180 logger.warn("Unknown group id: {}", groupIdString);
181 } catch (NotAGroupMemberException e) {
182 logger.warn("You're not a group member");
183 } catch (InvalidNumberException e) {
184 throw new UserErrorException("Failed to parse member number: " + e.getMessage());
185 } catch (IOException e) {
186 throw new UnexpectedErrorException("Failed to send message: " + e.getMessage());
187 }
188 }
189
190 @Override
191 public void handleCommand(
192 final Namespace ns, final Signal signal, final OutputWriter outputWriter
193 ) throws CommandException {
194 byte[] groupId = null;
195 if (ns.getString("group-id") != null) {
196 try {
197 groupId = Util.decodeGroupId(ns.getString("group-id")).serialize();
198 } catch (GroupIdFormatException e) {
199 throw new UserErrorException("Invalid group id: " + e.getMessage());
200 }
201 }
202 if (groupId == null) {
203 groupId = new byte[0];
204 }
205
206 var groupName = ns.getString("name");
207 if (groupName == null) {
208 groupName = "";
209 }
210
211 List<String> groupMembers = ns.getList("member");
212 if (groupMembers == null) {
213 groupMembers = new ArrayList<>();
214 }
215
216 var groupAvatar = ns.getString("avatar");
217 if (groupAvatar == null) {
218 groupAvatar = "";
219 }
220
221 try {
222 var newGroupId = signal.updateGroup(groupId, groupName, groupMembers, groupAvatar);
223 if (groupId.length != newGroupId.length) {
224 outputResult(outputWriter, null, GroupId.unknownVersion(newGroupId));
225 }
226 } catch (Signal.Error.AttachmentInvalid e) {
227 throw new UserErrorException("Failed to add avatar attachment for group\": " + e.getMessage());
228 } catch (DBusExecutionException e) {
229 throw new UnexpectedErrorException("Failed to send message: " + e.getMessage());
230 }
231 }
232
233 private void outputResult(final OutputWriter outputWriter, final Long timestamp, final GroupId groupId) {
234 if (outputWriter instanceof PlainTextWriter) {
235 final var writer = (PlainTextWriter) outputWriter;
236 if (groupId != null) {
237 writer.println("Created new group: \"{}\"", groupId.toBase64());
238 }
239 if (timestamp != null) {
240 writer.println("{}", timestamp);
241 }
242 } else {
243 final var writer = (JsonWriter) outputWriter;
244 final var result = new HashMap<>();
245 if (timestamp != null) {
246 result.put("timestamp", timestamp);
247 }
248 if (groupId != null) {
249 result.put("groupId", groupId.toBase64());
250 }
251 writer.write(result);
252 }
253 }
254 }