webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-09-02 20:40:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added AsamK's suggestions

Browse source
This commit is contained in:
david-harley 2021-01-11 10:57:24 +10:30
parent 06ea285d14
commit ac31901f31
5 changed files with 40 additions and 98 deletions
Download patch file Download diff file Expand all files Collapse all files

16
man/signal-cli.1.adoc
View file

@ -44,6 +44,9 @@ Make request via user dbus.
*--dbus-system*::
Make request via system dbus.
*-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
Specify if you want commands to output in either "plain-text" mode or in "json". Defaults to "plain-text"
== Commands
=== register
@ -126,12 +129,10 @@ Use listDevices to see the deviceIds.
=== getUserStatus
Uses a list of phone numbers to determine the statuses of those users. Shows if they are registered on the Signal Servers or not.
Uses a list of phone numbers to determine the statuses of those users. Shows if they are registered on the Signal Servers or not. In json mode this is outputted as a list of objects.
[NUMBER [NUMBER ...]]::
One or more numbers to check.
*--j*, *--json*::
Output the statuses as an array of json objects.
=== send
@ -177,15 +178,13 @@ Remove a reaction.
=== receive
Query the server for new messages.
New messages are printed on standardoutput and attachments are downloaded to the config directory.
New messages are printed on standard output and attachments are downloaded to the config directory. In json mode this is outputted as one json object per line.
*-t* TIMEOUT, *--timeout* TIMEOUT::
Number of seconds to wait for new messages (negative values disable timeout).
Default is 5 seconds.
*--ignore-attachments*::
Don’t download attachments of received messages.
*--j*, *--json*::
Output received messages in json format, one object per line.
=== joinGroup
@ -222,14 +221,11 @@ Specify the recipient group ID in base64 encoding.
=== listGroups
Show a list of known groups and related information.
Show a list of known groups and related information. In json mode this is outputted as an list of objects and is always in detailed mode.
*-d*, *--detailed*::
Include the list of members of each group and the group invite link.
*--j*, *--json*::
Output group information as a list of json objects.
=== listIdentities
List all known identity keys and their trust status, fingerprint and safety number.

3
src/main/java/org/asamk/signal/Main.java
View file

@ -283,6 +283,9 @@ public class Main {
mut.addArgument("--dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
mut.addArgument("--dbus-system").help("Make request via system dbus.").action(Arguments.storeTrue());
parser.addArgument("-o", "--output").help("Choose to output in plain text or JSON")
.choices("plain-text", "json").setDefault("plain-text");
Subparsers subparsers = parser.addSubparsers()
.title("subcommands")
.dest("command")

5
src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
View file

@ -21,9 +21,6 @@ public class GetUserStatusCommand implements LocalCommand {
public void attachToSubparser(final Subparser subparser) {
subparser.addArgument("number").help("Phone number").nargs("+");
subparser.help("Check if the specified phone number/s have been registered");
subparser.addArgument("-j", "--json")
.help("Output received messages in json format, one json object per line.")
.action(Arguments.storeTrue());
}
@Override
@ -47,7 +44,7 @@ public class GetUserStatusCommand implements LocalCommand {
}
// Output
if (ns.getBoolean("json")) {
if (ns.getString("output").equals("json")) {
List<JsonIsRegistered> objects = registered.entrySet()
.stream()
.map(entry -> new JsonIsRegistered(entry.getKey(), entry.getValue()))

107
src/main/java/org/asamk/signal/commands/ListGroupsCommand.java
View file

@ -16,36 +16,14 @@ import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
public class ListGroupsCommand implements LocalCommand {
private enum MembersType {
MEMBERS,
PENDING_MEMBERS,
REQUESTING_MEMBERS,
}
private static Set<String> getMembersSet(Manager m, GroupInfo group, MembersType type) {
Set<SignalServiceAddress> members;
switch (type) {
case MEMBERS:
members = group.getMembers();
break;
case PENDING_MEMBERS:
members = group.getPendingMembers();
break;
case REQUESTING_MEMBERS:
members = group.getRequestingMembers();
break;
default:
return Collections.emptySet();
}
return members.stream().map(m::resolveSignalServiceAddress)
private static Set<String> resolveMembers(Manager m, Set<SignalServiceAddress> addresses) {
return addresses.stream().map(m::resolveSignalServiceAddress)
.map(SignalServiceAddress::getLegacyIdentifier)
.collect(Collectors.toSet());
}
@ -72,9 +50,9 @@ public class ListGroupsCommand implements LocalCommand {
group.getTitle(),
group.isMember(m.getSelfAddress()),
group.isBlocked(),
getMembersSet(m, group, MembersType.MEMBERS),
getMembersSet(m, group, MembersType.PENDING_MEMBERS),
getMembersSet(m, group, MembersType.REQUESTING_MEMBERS),
resolveMembers(m, group.getMembers()),
resolveMembers(m, group.getPendingMembers()),
resolveMembers(m, group.getRequestingMembers()),
groupInviteLink == null ? '-' : groupInviteLink.getUrl()));
} else {
System.out.println(String.format("Id: %s Name: %s Active: %s Blocked: %b",
@ -87,11 +65,10 @@ public class ListGroupsCommand implements LocalCommand {
@Override
public void attachToSubparser(final Subparser subparser) {
subparser.addArgument("-d", "--detailed").action(Arguments.storeTrue()).help("List members of each group");
subparser.help("List group name and ids");
subparser.addArgument("-j", "--json")
.help("Output received messages in json format, one json object per line.")
.action(Arguments.storeTrue());
subparser.addArgument("-d", "--detailed").action(Arguments.storeTrue())
.help("List the members and group invite links of each group");
subparser.help("List group information including names, ids, active status, blocked status and members");
}
@Override
@ -101,42 +78,29 @@ public class ListGroupsCommand implements LocalCommand {
return 1;
}
List<GroupInfo> groups = m.getGroups();
boolean detailed = ns.getBoolean("detailed");
if (ns.getBoolean("json")) {
if (ns.getString("output").equals("json")) {
final ObjectMapper jsonProcessor = new ObjectMapper();
jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
if (detailed) {
List<JsonGroupDetailed> objects = new ArrayList<>();
for (GroupInfo group : groups) {
final GroupInviteLinkUrl groupInviteLink = group.getGroupInviteLink();
List<JsonGroup> objects = new ArrayList<>();
for (GroupInfo group : m.getGroups()) {
final GroupInviteLinkUrl groupInviteLink = group.getGroupInviteLink();
objects.add(new JsonGroupDetailed(group.getGroupId().toBase64(),
group.getTitle(),
group.isMember(m.getSelfAddress()),
group.isBlocked(),
getMembersSet(m, group, MembersType.MEMBERS),
getMembersSet(m, group, MembersType.PENDING_MEMBERS),
getMembersSet(m, group, MembersType.REQUESTING_MEMBERS),
groupInviteLink == null ? null : groupInviteLink.getUrl()));
}
return printGroupsJson(jsonProcessor, objects);
} else {
List<JsonGroup> objects = groups.stream().map(
group -> new JsonGroup(group.getGroupId().toBase64(),
group.getTitle(),
group.isMember(m.getSelfAddress()),
group.isBlocked()))
.collect(Collectors.toList());
return printGroupsJson(jsonProcessor, objects);
objects.add(new JsonGroup(group.getGroupId().toBase64(),
group.getTitle(),
group.isMember(m.getSelfAddress()),
group.isBlocked(),
resolveMembers(m, group.getMembers()),
resolveMembers(m, group.getPendingMembers()),
resolveMembers(m, group.getRequestingMembers()),
groupInviteLink == null ? null : groupInviteLink.getUrl()));
}
return printGroupsJson(jsonProcessor, objects);
} else {
for (GroupInfo group : groups) {
boolean detailed = ns.getBoolean("detailed");
for (GroupInfo group : m.getGroups()) {
printGroupPlainText(m, group, detailed);
}
}
@ -151,29 +115,14 @@ public class ListGroupsCommand implements LocalCommand {
public boolean isMember;
public boolean isBlocked;
public JsonGroup(String id, String name, boolean isMember, boolean isBlocked) {
this.id = id;
this.name = name;
this.isMember = isMember;
this.isBlocked = isBlocked;
}
}
private static final class JsonGroupDetailed {
public String id;
public String name;
public boolean isMember;
public boolean isBlocked;
public Set<String> members;
public Set<String> pendingMembers;
public Set<String> requestingMembers;
public String groupInviteLink;
public JsonGroupDetailed(String id, String name, boolean isMember, boolean isBlocked,
Set<String> members, Set<String> pendingMembers,
Set<String> requestingMembers, String groupInviteLink)
public JsonGroup(String id, String name, boolean isMember, boolean isBlocked,
Set<String> members, Set<String> pendingMembers,
Set<String> requestingMembers, String groupInviteLink)
{
this.id = id;
this.name = name;

7
src/main/java/org/asamk/signal/commands/ReceiveCommand.java
View file

@ -35,14 +35,11 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
subparser.addArgument("--ignore-attachments")
.help("Don’t download attachments of received messages.")
.action(Arguments.storeTrue());
subparser.addArgument("-j", "--json")
.help("Output received messages in json format, one json object per line.")
.action(Arguments.storeTrue());
}
public int handleCommand(final Namespace ns, final Signal signal, DBusConnection dbusconnection) {
final ObjectMapper jsonProcessor;
if (ns.getBoolean("json")) {
if (ns.getString("output").equals("json")) {
jsonProcessor = new ObjectMapper();
jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
@ -161,7 +158,7 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
}
boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
try {
final Manager.ReceiveMessageHandler handler = ns.getBoolean("json")
final Manager.ReceiveMessageHandler handler = ns.getString("output").equals("json")
? new JsonReceiveMessageHandler(m)
: new ReceiveMessageHandler(m);
m.receiveMessages((long) (timeout * 1000),