Where <type> is according to DBus specification:
- * <s> : String
- * <ay> : Byte Array
- * <aay> : Array of Byte Arrays
- * <as> : String Array
- * <ax> : Array of signed 64 bit integer
- * <b> : Boolean (0|1)
- * <x> : Signed 64 bit integer
-* <a> : Array of ... (comma-separated list)
++* <a> : Array of ... (comma-separated list, array:)
+ * (...) : Struct (cannot be sent via `dbus-send`)
+ * <b> : Boolean (false|true) (boolean:)
+ * <i> : Signed 32-bit (int) integer (int32:)
+ * <o> : DBusPath object (objpath:)
+ * <s> : String (string:)
+ * <x> : Signed 64-bit (long) integer (int64:)
+ * <y> : Unsigned 8-bit (byte) integer (byte:)
* <> : no return value
+ The final parenthetical value (such as "boolean:") is the type indicator used by `dbus-send`.
+
Exceptions are the names of the Java Exceptions returned in the body field. They typically contain an additional message with details. All Exceptions begin with "org.asamk.Signal.Error." which is omitted here for better readability.
Phone numbers always have the format +<countrycode><regional number>
getContactName(number<s>) -> name<s>::
* number : Phone number
-* name : Contact's name in local storage (from the master device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
+* name : Contact's name in local storage (from the primary device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
setContactName(number<s>,name<>) -> <>::
* number : Phone number
Exception: InvalidUri
- listDevices() -> devices<as>::
- * devices : String array of linked devices
+ listDevices() -> devices<a(oxs)>::
+ * devices : Array of structs (objectPath, id, name)
+ ** objectPath : DBusPath representing the device's object path
+ ** id : Long representing the deviceId
+ ** name : String representing the device's name
Exception: Failure
* stickerPackPath : Path to the manifest.json file or a zip file in the same directory
* url : URL of sticker pack after successful upload
-Exception: Failure
+Exception: Failure, IOError
+
+getConfiguration() -> [readReceipts<b>, unidentifiedDeliveryIndicators<b>, typingIndicators<b>, linkPreviews<b>] -> <>::
+* readReceipts : Should Signal send read receipts (true/false).
+* unidentifiedDeliveryIndicators : Should Signal show unidentified delivery indicators (true/false).
+* typingIndicators : Should Signal send/show typing indicators (true/false).
+* linkPreviews : Should Signal generate link previews (true/false).
+
+Gets an array of four booleans as indicated. Only works from primary device.
+
+Exceptions: IOError, UserError
+
+setConfiguration(readReceipts<b>, unidentifiedDeliveryIndicators<b>, typingIndicators<b>, linkPreviews<b>) -> <>::
+* readReceipts : Should Signal send read receipts (true/false).
+* unidentifiedDeliveryIndicators : Should Signal show unidentified delivery indicators (true/false).
+* typingIndicators : Should Signal send/show typing indicators (true/false).
+* linkPreviews : Should Signal generate link previews (true/false).
+
+Update Signal configurations and sync them to linked devices. Only works from primary device.
+
+Exceptions: IOError, UserError
- == Signals
+ submitRateLimitChallenge(challenge<s>, captcha<s>) -> <>::
+ * challenge : The challenge token taken from the proof required error.
+ * captcha : The captcha token from the solved captcha on the Signal website..
+ Can be used to lift some rate-limits by solving a captcha.
+ Exception: IOErrorException
+
+ == Signals
SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
The sync message is received when the user sends a message from a linked device.
package org.asamk;
+ import org.asamk.signal.commands.exceptions.IOErrorException;
+
import org.freedesktop.dbus.DBusPath;
+ import org.freedesktop.dbus.Struct;
import org.freedesktop.dbus.annotations.DBusProperty;
+ import org.freedesktop.dbus.annotations.Position;
import org.freedesktop.dbus.exceptions.DBusException;
import org.freedesktop.dbus.exceptions.DBusExecutionException;
import org.freedesktop.dbus.interfaces.DBusInterface;
DBusPath getDevice(long deviceId);
- List<DBusPath> listDevices() throws Error.Failure;
+ List<StructDevice> listDevices() throws Error.Failure;
DBusPath getThisDevice();
String uploadStickerPack(String stickerPackPath) throws Error.Failure;
+ void setConfiguration(boolean readReceipts, boolean unidentifiedDeliveryIndicators, boolean typingIndicators, boolean linkPreviews) throws Error.IOError, Error.UserError;
+
+ List<Boolean> getConfiguration();
+
+ void submitRateLimitChallenge(String challenge, String captchaString) throws IOErrorException;
+
class MessageReceived extends DBusSignal {
private final long timestamp;
}
}
- @DBusProperty(name = "Id", type = Integer.class, access = DBusProperty.Access.READ)
+ class StructDevice extends Struct {
+
+ @Position(0)
+ DBusPath objectPath;
+
+ @Position(1)
+ Long id;
+
+ @Position(2)
+ String name;
+
+ public StructDevice(final DBusPath objectPath, final Long id, final String name) {
+ this.objectPath = objectPath;
+ this.id = id;
+ this.name = name;
+ }
+
+ public DBusPath getObjectPath() {
+ return objectPath;
+ }
+
+ public Long getId() {
+ return id;
+ }
+
+ public String getName() {
+ return name;
+ }
+ }
+
+ @DBusProperty(name = "Id", type = Long.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "Name", type = String.class)
@DBusProperty(name = "Created", type = String.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "LastSeen", type = String.class, access = DBusProperty.Access.READ)
super(message);
}
}
+
+ class IOError extends DBusExecutionException {
+
+ public IOError(final String message) {
+ super(message);
+ }
+ }
+
+ class UserError extends DBusExecutionException {
+
+ public UserError(final String message) {
+ super(message);
+ }
+ }
}
}
final Boolean typingIndicators,
final Boolean linkPreviews
) throws IOException {
- throw new UnsupportedOperationException();
+ signal.setConfiguration(
+ readReceipts,
+ unidentifiedDeliveryIndicators,
+ typingIndicators,
+ linkPreviews
+ );
+ }
+
+ @Override
+ public List<Boolean> getConfiguration() {
+ return signal.getConfiguration();
}
@Override
@Override
public List<Device> getLinkedDevices() throws IOException {
final var thisDevice = signal.getThisDevice();
- return signal.listDevices().stream().map(devicePath -> {
- final var device = getRemoteObject(devicePath, Signal.Device.class).GetAll("org.asamk.Signal.Device");
+ return signal.listDevices().stream().map(d -> {
+ final var device = getRemoteObject(d.getObjectPath(),
+ Signal.Device.class).GetAll("org.asamk.Signal.Device");
return new Device((long) device.get("Id").getValue(),
(String) device.get("Name").getValue(),
(long) device.get("Created").getValue(),
(long) device.get("LastSeen").getValue(),
- thisDevice.equals(devicePath));
+ thisDevice.equals(d.getObjectPath()));
}).collect(Collectors.toList());
}
import org.asamk.Signal;
import org.asamk.Signal.Error;
import org.asamk.signal.BaseConfig;
+ import org.asamk.signal.commands.exceptions.IOErrorException;
import org.asamk.signal.manager.AttachmentInvalidException;
import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.NotMasterDeviceException;
private final String objectPath;
private DBusPath thisDevice;
- private final List<DBusPath> devices = new ArrayList<>();
+ private final List<StructDevice> devices = new ArrayList<>();
public DbusSignalImpl(final Manager m, DBusConnection connection, final String objectPath) {
this.m = m;
return m.getSelfNumber();
}
+ @Override
+ public void submitRateLimitChallenge(String challenge, String captchaString) throws IOErrorException {
+ final var captcha = captchaString == null ? null : captchaString.replace("signalcaptcha://", "");
+
+ try {
+ m.submitRateLimitRecaptchaChallenge(challenge, captcha);
+ } catch (IOException e) {
+ throw new IOErrorException("Submit challenge error: " + e.getMessage(), e);
+ }
+
+ }
+
@Override
public void addDevice(String uri) {
try {
}
@Override
- public List<DBusPath> listDevices() {
+ public List<StructDevice> listDevices() {
updateDevices();
return this.devices;
}
- private void updateDevices() {
- List<org.asamk.signal.manager.api.Device> linkedDevices;
- try {
- linkedDevices = m.getLinkedDevices();
- } catch (IOException | Error.Failure e) {
- throw new Error.Failure("Failed to get linked devices: " + e.getMessage());
- }
-
- unExportDevices();
-
- linkedDevices.forEach(d -> {
- final var object = new DbusSignalDeviceImpl(d);
- final var deviceObjectPath = object.getObjectPath();
- try {
- connection.exportObject(object);
- } catch (DBusException e) {
- e.printStackTrace();
- }
- if (d.isThisDevice()) {
- thisDevice = new DBusPath(deviceObjectPath);
- }
- this.devices.add(new DBusPath(deviceObjectPath));
- });
- }
-
- private void unExportDevices() {
- this.devices.stream().map(DBusPath::getPath).forEach(connection::unExportObject);
- this.devices.clear();
- }
-
@Override
public DBusPath getThisDevice() {
updateDevices();
try {
return m.uploadStickerPack(path).toString();
} catch (IOException e) {
- throw new Error.Failure("Upload error (maybe image size is too large):" + e.getMessage());
+ throw new Error.IOError("Upload error (maybe image size is too large):" + e.getMessage());
} catch (StickerPackInvalidException e) {
throw new Error.Failure("Invalid sticker pack: " + e.getMessage());
}
}
+ @Override
+ public void setConfiguration(boolean readReceipts, boolean unidentifiedDeliveryIndicators, boolean typingIndicators, boolean linkPreviews) {
+ try {
+ m.updateConfiguration(readReceipts, unidentifiedDeliveryIndicators, typingIndicators, linkPreviews);
+ } catch (IOException e) {
+ throw new Error.IOError("UpdateAccount error: " + e.getMessage());
+ } catch (NotMasterDeviceException e) {
+ throw new Error.UserError("This command doesn't work on linked devices.");
+ }
+ }
+
+ @Override
+ public List<Boolean> getConfiguration() {
+ List<Boolean> config = new ArrayList<>(4);
+ try {
+ config = m.getConfiguration();
+ } catch (IOException e) {
+ throw new Error.IOError("Configuration storage error: " + e.getMessage());
+ } catch (NotMasterDeviceException e) {
+ throw new Error.UserError("This command doesn't work on linked devices.");
+ }
+ return config;
+ }
+
private static void checkSendMessageResult(long timestamp, SendMessageResult result) throws DBusExecutionException {
var error = ErrorUtils.getErrorMessageFromSendMessageResult(result);
return name.isEmpty() ? null : name;
}
+ private String emptyIfNull(final String string) {
+ return string == null ? "" : string;
+ }
+
private static String getDeviceObjectPath(String basePath, long deviceId) {
return basePath + "/Devices/" + deviceId;
}
+ private void updateDevices() {
+ List<org.asamk.signal.manager.api.Device> linkedDevices;
+ try {
+ linkedDevices = m.getLinkedDevices();
+ } catch (IOException e) {
+ throw new Error.Failure("Failed to get linked devices: " + e.getMessage());
+ }
+
+ unExportDevices();
+
+ linkedDevices.forEach(d -> {
+ final var object = new DbusSignalDeviceImpl(d);
+ final var deviceObjectPath = object.getObjectPath();
+ try {
+ connection.exportObject(object);
+ } catch (DBusException e) {
+ e.printStackTrace();
+ }
+ if (d.isThisDevice()) {
+ thisDevice = new DBusPath(deviceObjectPath);
+ }
+ this.devices.add(new StructDevice(new DBusPath(deviceObjectPath), d.getId(), emptyIfNull(d.getName())));
+ });
+ }
+
+ private void unExportDevices() {
+ this.devices.stream()
+ .map(StructDevice::getObjectPath)
+ .map(DBusPath::getPath)
+ .forEach(connection::unExportObject);
+ this.devices.clear();
+ }
+
public class DbusSignalDeviceImpl extends DbusProperties implements Signal.Device {
private final org.asamk.signal.manager.api.Device device;
public DbusSignalDeviceImpl(final org.asamk.signal.manager.api.Device device) {
- super();
super.addPropertiesHandler(new DbusInterfacePropertiesHandler("org.asamk.Signal.Device",
List.of(new DbusProperty<>("Id", device::getId),
- new DbusProperty<>("Name",
- () -> device.getName() == null ? "" : device.getName(),
- this::setDeviceName),
+ new DbusProperty<>("Name", () -> emptyIfNull(device.getName()), this::setDeviceName),
new DbusProperty<>("Created", device::getCreated),
new DbusProperty<>("LastSeen", device::getLastSeen))));
this.device = device;
git.nmode.ca / signal-cli / commitdiff
