nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/commands/RegisterCommand.java

   1 package org.asamk.signal.commands;
   2
   3 import com.fasterxml.jackson.core.type.TypeReference;
   4
   5 import net.sourceforge.argparse4j.impl.Arguments;
   6 import net.sourceforge.argparse4j.inf.Namespace;
   7 import net.sourceforge.argparse4j.inf.Subparser;
   8
   9 import org.asamk.signal.OutputType;
  10 import org.asamk.signal.commands.exceptions.CommandException;
  11 import org.asamk.signal.commands.exceptions.IOErrorException;
  12 import org.asamk.signal.commands.exceptions.UserErrorException;
  13 import org.asamk.signal.manager.RegistrationManager;
  14 import org.asamk.signal.manager.api.CaptchaRequiredException;
  15 import org.asamk.signal.manager.api.NonNormalizedPhoneNumberException;
  16 import org.asamk.signal.manager.api.RateLimitException;
  17 import org.asamk.signal.output.JsonWriter;
  18 import org.asamk.signal.util.DateUtils;
  19
  20 import java.io.IOException;
  21 import java.util.List;
  22
  23 public class RegisterCommand implements RegistrationCommand, JsonRpcRegistrationCommand<RegisterCommand.RegistrationParams> {
  24
  25     @Override
  26     public String getName() {
  27         return "register";
  28     }
  29
  30     @Override
  31     public void attachToSubparser(final Subparser subparser) {
  32         subparser.help("Register a phone number with SMS or voice verification.");
  33         subparser.addArgument("-v", "--voice")
  34                 .help("The verification should be done over voice, not SMS.")
  35                 .action(Arguments.storeTrue());
  36         subparser.addArgument("--captcha")
  37                 .help("The captcha token, required if registration failed with a captcha required error.");
  38     }
  39
  40     @Override
  41     public void handleCommand(final Namespace ns, final RegistrationManager m) throws CommandException {
  42         final boolean voiceVerification = Boolean.TRUE.equals(ns.getBoolean("voice"));
  43         final var captcha = ns.getString("captcha");
  44
  45         register(m, voiceVerification, captcha);
  46     }
  47
  48     @Override
  49     public TypeReference<RegistrationParams> getRequestType() {
  50         return new TypeReference<>() {};
  51     }
  52
  53     @Override
  54     public List<OutputType> getSupportedOutputTypes() {
  55         return List.of(OutputType.PLAIN_TEXT, OutputType.JSON);
  56     }
  57
  58     @Override
  59     public void handleCommand(
  60             final RegistrationParams request, final RegistrationManager m, final JsonWriter jsonWriter
  61     ) throws CommandException {
  62         register(m, Boolean.TRUE.equals(request.voice()), request.captcha());
  63     }
  64
  65     private void register(
  66             final RegistrationManager m, final boolean voiceVerification, final String captcha
  67     ) throws UserErrorException, IOErrorException {
  68         try {
  69             m.register(voiceVerification, captcha);
  70         } catch (RateLimitException e) {
  71             String message = "Rate limit reached";
  72             if (e.getNextAttemptTimestamp() > 0) {
  73                 message += "\nNext attempt may be tried at " + DateUtils.formatTimestamp(e.getNextAttemptTimestamp());
  74             }
  75             throw new UserErrorException(message);
  76         } catch (CaptchaRequiredException e) {
  77             String message;
  78             if (captcha == null) {
  79                 message = """
  80                           Captcha required for verification, use --captcha CAPTCHA
  81                           To get the token, go to https://signalcaptchas.org/registration/generate.html
  82                           Check the developer tools (F12) console for a failed redirect to signalcaptcha://
  83                           Everything after signalcaptcha:// is the captcha token.""";
  84             } else {
  85                 message = "Invalid captcha given.";
  86             }
  87             if (e.getNextAttemptTimestamp() > 0) {
  88                 message += "\nNext Captcha may be provided at "
  89                         + DateUtils.formatTimestamp(e.getNextAttemptTimestamp());
  90             }
  91             throw new UserErrorException(message);
  92         } catch (NonNormalizedPhoneNumberException e) {
  93             throw new UserErrorException("Failed to register: " + e.getMessage(), e);
  94         } catch (IOException e) {
  95             throw new IOErrorException("Failed to register: %s (%s)".formatted(e.getMessage(),
  96                     e.getClass().getSimpleName()), e);
  97         }
  98     }
  99
 100     public record RegistrationParams(Boolean voice, String captcha) {}
 101 }