2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.androiddebugbridge.internal;
15 import java.io.ByteArrayOutputStream;
17 import java.io.IOException;
18 import java.net.InetSocketAddress;
19 import java.net.Socket;
21 import java.net.URLEncoder;
22 import java.nio.charset.Charset;
23 import java.nio.charset.StandardCharsets;
24 import java.security.NoSuchAlgorithmException;
25 import java.security.spec.InvalidKeySpecException;
26 import java.util.ArrayList;
27 import java.util.Arrays;
28 import java.util.Base64;
29 import java.util.HashMap;
31 import java.util.concurrent.ExecutionException;
32 import java.util.concurrent.Future;
33 import java.util.concurrent.ScheduledExecutorService;
34 import java.util.concurrent.TimeUnit;
35 import java.util.concurrent.TimeoutException;
36 import java.util.concurrent.locks.ReentrantLock;
37 import java.util.regex.Matcher;
38 import java.util.regex.Pattern;
39 import java.util.stream.Collectors;
41 import org.eclipse.jdt.annotation.NonNullByDefault;
42 import org.eclipse.jdt.annotation.Nullable;
43 import org.openhab.core.OpenHAB;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
47 import com.tananaev.adblib.AdbBase64;
48 import com.tananaev.adblib.AdbConnection;
49 import com.tananaev.adblib.AdbCrypto;
50 import com.tananaev.adblib.AdbStream;
53 * The {@link AndroidDebugBridgeConfiguration} class encapsulates adb device connection logic.
55 * @author Miguel Álvarez - Initial contribution
58 public class AndroidDebugBridgeDevice {
59 public static final int ANDROID_MEDIA_STREAM = 3;
60 private static final String ADB_FOLDER = OpenHAB.getUserDataFolder() + File.separator + ".adb";
61 private final Logger logger = LoggerFactory.getLogger(AndroidDebugBridgeDevice.class);
62 private static final Pattern VOLUME_PATTERN = Pattern
63 .compile("volume is (?<current>\\d.*) in range \\[(?<min>\\d.*)\\.\\.(?<max>\\d.*)]");
64 private static final Pattern TAP_EVENT_PATTERN = Pattern.compile("(?<x>\\d+),(?<y>\\d+)");
65 private static final Pattern PACKAGE_NAME_PATTERN = Pattern
66 .compile("^([A-Za-z]{1}[A-Za-z\\d_]*\\.)+[A-Za-z][A-Za-z\\d_]*$");
67 private static final Pattern URL_PATTERN = Pattern.compile(
68 "https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,4}\\b([-a-zA-Z0-9@:%_\\+.~#?&//=]*)$");
69 private static final Pattern INPUT_EVENT_PATTERN = Pattern
70 .compile("/(?<input>\\S+): (?<n1>\\S+) (?<n2>\\S+) (?<n3>\\S+)$", Pattern.MULTILINE);
71 private static final Pattern VERSION_PATTERN = Pattern
72 .compile("^(?<major>\\d+)(\\.)?(?<minor>\\d+)?(\\.)?(?<patch>\\*|\\d+)?");
73 private static final Pattern MAC_PATTERN = Pattern.compile("^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$");
75 private static final Pattern SECURE_SHELL_INPUT_PATTERN = Pattern.compile("^[^\\|\\&;\\\"]+$");
77 private static @Nullable AdbCrypto adbCrypto;
80 var logger = LoggerFactory.getLogger(AndroidDebugBridgeDevice.class);
82 File directory = new File(ADB_FOLDER);
83 if (!directory.exists()) {
86 adbCrypto = loadKeyPair(ADB_FOLDER + File.separator + "adb_pub.key",
87 ADB_FOLDER + File.separator + "adb.key");
88 } catch (NoSuchAlgorithmException | IOException | InvalidKeySpecException e) {
89 logger.warn("Unable to setup adb keys: {}", e.getMessage());
93 private final ScheduledExecutorService scheduler;
94 private final ReentrantLock commandLock = new ReentrantLock();
96 private String ip = "127.0.0.1";
97 private int port = 5555;
98 private int timeoutSec = 5;
99 private int recordDuration;
100 private @Nullable Integer maxVolumeLevel = null;
101 private @Nullable Socket socket;
102 private @Nullable AdbConnection connection;
103 private @Nullable Future<String> commandFuture;
104 private int majorVersionNumber = 0;
105 private int minorVersionNumber = 0;
106 private int patchVersionNumber = 0;
108 * Assumed max volume for android versions that do not expose this value.
110 private int deviceMaxVolume = 25;
111 private String volumeSettingKey = "volume_music_hdmi";
113 public AndroidDebugBridgeDevice(ScheduledExecutorService scheduler) {
114 this.scheduler = scheduler;
117 public void configure(AndroidDebugBridgeConfiguration config) {
118 configureConnection(config.ip, config.port, config.timeout);
119 this.recordDuration = config.recordDuration;
120 this.volumeSettingKey = config.volumeSettingKey;
121 this.deviceMaxVolume = config.deviceMaxVolume;
124 public void configureConnection(String ip, int port, int timeout) {
127 this.timeoutSec = timeout;
130 public void sendKeyEvent(String eventCode)
131 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
132 runAdbShell("input", "keyevent", eventCode);
135 public void sendText(String text)
136 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
137 runAdbShell("input", "text", URLEncoder.encode(text, StandardCharsets.UTF_8));
140 public void sendTap(String point)
141 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
142 var match = TAP_EVENT_PATTERN.matcher(point);
143 if (!match.matches()) {
144 throw new AndroidDebugBridgeDeviceException("Unable to parse tap event");
146 runAdbShell("input", "mouse", "tap", match.group("x"), match.group("y"));
149 public void openUrl(String url)
150 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
151 var match = URL_PATTERN.matcher(url);
152 if (!match.matches()) {
153 throw new AndroidDebugBridgeDeviceException("Unable to parse url");
155 runAdbShell("am", "start", "-a", url);
158 public void startPackage(String packageName)
159 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
160 if (packageName.contains("/")) {
161 startPackageWithActivity(packageName);
164 if (!PACKAGE_NAME_PATTERN.matcher(packageName).matches()) {
165 logger.warn("{} is not a valid package name", packageName);
168 var out = runAdbShell("monkey", "--pct-syskeys", "0", "-p", packageName, "-v", "1");
169 if (out.contains("monkey aborted")) {
170 startTVPackage(packageName);
174 private void startTVPackage(String packageName)
175 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
176 // https://developer.android.com/training/tv/start/start
177 String result = runAdbShell("monkey", "--pct-syskeys", "0", "-c", "android.intent.category.LEANBACK_LAUNCHER",
178 "-p", packageName, "1");
179 if (result.contains("monkey aborted")) {
180 throw new AndroidDebugBridgeDeviceException("Unable to open package");
184 public void startPackageWithActivity(String packageWithActivity)
185 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
186 var parts = packageWithActivity.split("/");
187 if (parts.length != 2) {
188 logger.warn("{} is not a valid package", packageWithActivity);
191 var packageName = parts[0];
192 var activityName = parts[1];
193 if (!PACKAGE_NAME_PATTERN.matcher(packageName).matches()) {
194 logger.warn("{} is not a valid package name", packageName);
197 if (!SECURE_SHELL_INPUT_PATTERN.matcher(activityName).matches()) {
198 logger.warn("{} is not a valid activity name", activityName);
201 var out = runAdbShell("am", "start", "-n", packageWithActivity);
202 if (out.contains("usage: am")) {
203 out = runAdbShell("am", "start", packageWithActivity);
205 if (out.contains("usage: am") || out.contains("Exception")) {
206 logger.warn("open {} fail; retrying to open without activity info", packageWithActivity);
207 startPackage(packageName);
211 public void stopPackage(String packageName)
212 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
213 if (!PACKAGE_NAME_PATTERN.matcher(packageName).matches()) {
214 logger.warn("{} is not a valid package name", packageName);
217 runAdbShell("am", "force-stop", packageName);
220 public String getCurrentPackage() throws AndroidDebugBridgeDeviceException, InterruptedException,
221 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
223 if (isAtLeastVersion(10)) {
224 out = runAdbShell("dumpsys", "window", "displays", "|", "grep", "mFocusedApp");
226 out = runAdbShell("dumpsys", "window", "windows", "|", "grep", "mFocusedApp");
228 var targetLine = Arrays.stream(out.split("\n")).findFirst().orElse("");
229 var lineParts = targetLine.split(" ");
230 if (lineParts.length >= 2) {
231 var packageActivityName = lineParts[lineParts.length - 2];
232 if (packageActivityName.contains("/")) {
233 return packageActivityName.split("/")[0];
236 throw new AndroidDebugBridgeDeviceReadException("Unable to read package name");
239 public boolean isAwake()
240 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
241 String devicesResp = runAdbShell("dumpsys", "activity", "|", "grep", "mWakefulness");
242 return devicesResp.contains("mWakefulness=Awake");
245 public boolean isScreenOn() throws InterruptedException, AndroidDebugBridgeDeviceException,
246 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
247 String devicesResp = runAdbShell("dumpsys", "power", "|", "grep", "'Display Power'");
248 if (devicesResp.contains("=")) {
250 var state = devicesResp.split("=")[1].trim();
251 return state.equals("ON");
252 } catch (NumberFormatException e) {
253 logger.debug("Unable to parse device screen state: {}", e.getMessage());
256 throw new AndroidDebugBridgeDeviceReadException("Unable to read screen state");
259 public boolean isPlayingMedia(String currentApp)
260 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
261 String devicesResp = runAdbShell("dumpsys", "media_session", "|", "grep", "-A", "100", "'Sessions Stack'", "|",
262 "grep", "-A", "50", currentApp);
263 String[] mediaSessions = devicesResp.split("\n\n");
264 if (mediaSessions.length == 0) {
265 // no media session found for current app
268 boolean isPlaying = mediaSessions[0].contains("PlaybackState {state=3");
269 logger.debug("device media state playing {}", isPlaying);
273 public boolean isPlayingAudio()
274 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
275 String audioDump = runAdbShell("dumpsys", "audio", "|", "grep", "ID:");
276 return audioDump.contains("state:started");
279 public VolumeInfo getMediaVolume() throws AndroidDebugBridgeDeviceException, InterruptedException,
280 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
281 return getVolume(ANDROID_MEDIA_STREAM);
284 public void setMediaVolume(int volume)
285 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
286 setVolume(ANDROID_MEDIA_STREAM, volume);
289 public int getPowerWakeLock() throws InterruptedException, AndroidDebugBridgeDeviceException,
290 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
291 String lockResp = runAdbShell("dumpsys", "power", "|", "grep", "Locks", "|", "grep", "'size='");
292 if (lockResp.contains("=")) {
294 return Integer.parseInt(lockResp.replace("\n", "").split("=")[1].trim());
295 } catch (NumberFormatException e) {
296 String message = String.format("Unable to parse device wake-lock '%s'", lockResp);
297 logger.debug("{}: {}", message, e.getMessage());
298 throw new AndroidDebugBridgeDeviceReadException(message);
301 throw new AndroidDebugBridgeDeviceReadException(String.format("Unable to read wake-lock '%s'", lockResp));
304 private void setVolume(int stream, int volume)
305 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
306 if (isAtLeastVersion(12)) {
307 runAdbShell("service", "call", "audio", "11", "i32", String.valueOf(stream), "i32", String.valueOf(volume),
309 } else if (isAtLeastVersion(11)) {
310 runAdbShell("service", "call", "audio", "10", "i32", String.valueOf(stream), "i32", String.valueOf(volume),
313 runAdbShell("media", "volume", "--show", "--stream", String.valueOf(stream), "--set",
314 String.valueOf(volume));
318 public String getModel() throws AndroidDebugBridgeDeviceException, InterruptedException,
319 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
320 return getDeviceProp("ro.product.model");
323 public String getAndroidVersion() throws AndroidDebugBridgeDeviceException, InterruptedException,
324 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
325 return getDeviceProp("ro.build.version.release");
328 public void setAndroidVersion(String version) {
329 var matcher = VERSION_PATTERN.matcher(version);
330 if (!matcher.find()) {
331 logger.warn("Unable to parse android version");
334 this.majorVersionNumber = Integer.parseInt(matcher.group("major"));
335 var minorMatch = matcher.group("minor");
336 var patchMatch = matcher.group("patch");
337 this.minorVersionNumber = minorMatch != null ? Integer.parseInt(minorMatch) : 0;
338 this.patchVersionNumber = patchMatch != null ? Integer.parseInt(patchMatch) : 0;
341 public String getBrand() throws AndroidDebugBridgeDeviceException, InterruptedException,
342 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
343 return getDeviceProp("ro.product.brand");
346 public String getSerialNo() throws AndroidDebugBridgeDeviceException, InterruptedException,
347 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
348 return getDeviceProp("ro.serialno");
351 public String getMacAddress() throws AndroidDebugBridgeDeviceException, InterruptedException,
352 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
353 var macAddress = runAdbShell("cat", "/sys/class/net/wlan0/address").replace("\n", "").replace("\r", "");
354 var matcher = MAC_PATTERN.matcher(macAddress);
355 if (!matcher.find()) {
356 macAddress = runAdbShell("ip", "address", "|", "grep", "-m", "1", "link/ether", "|", "awk", "'{print $2}'")
357 .replace("\n", "").replace("\r", "");
358 matcher = MAC_PATTERN.matcher(macAddress);
359 if (matcher.find()) {
363 return "00:00:00:00:00:00";
366 private String getDeviceProp(String name) throws AndroidDebugBridgeDeviceException, InterruptedException,
367 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
368 var propValue = runAdbShell("getprop", name, "&&", "sleep", "0.3").replace("\n", "").replace("\r", "");
369 if (propValue.length() == 0) {
370 throw new AndroidDebugBridgeDeviceReadException(String.format("Unable to get device property '%s'", name));
375 private VolumeInfo getVolume(int stream) throws AndroidDebugBridgeDeviceException, InterruptedException,
376 AndroidDebugBridgeDeviceReadException, TimeoutException, ExecutionException {
377 if (isAtLeastVersion(11)) {
378 String volumeResp = runAdbShell("settings", "get", "system", volumeSettingKey);
379 var maxVolumeLevel = this.maxVolumeLevel;
380 if (maxVolumeLevel == null) {
382 maxVolumeLevel = Integer.parseInt(getDeviceProp("ro.config.media_vol_steps"));
383 this.maxVolumeLevel = maxVolumeLevel;
384 } catch (NumberFormatException ignored) {
385 logger.debug("Max volume level not available, using 'deviceMaxVolume' config");
386 maxVolumeLevel = deviceMaxVolume;
389 return new VolumeInfo(Integer.parseInt(volumeResp.replace("\n", "")), 0, maxVolumeLevel);
391 String volumeResp = runAdbShell("media", "volume", "--show", "--stream", String.valueOf(stream), "--get",
392 "|", "grep", "volume");
393 Matcher matcher = VOLUME_PATTERN.matcher(volumeResp);
394 if (!matcher.find()) {
395 throw new AndroidDebugBridgeDeviceReadException("Unable to get volume info");
397 var volumeInfo = new VolumeInfo(Integer.parseInt(matcher.group("current")),
398 Integer.parseInt(matcher.group("min")), Integer.parseInt(matcher.group("max")));
399 logger.debug("Device {}:{} VolumeInfo: current {}, min {}, max {}", this.ip, this.port, volumeInfo.current,
400 volumeInfo.min, volumeInfo.max);
405 public String recordInputEvents()
406 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
407 String out = runAdbShell(recordDuration * 2, "getevent", "&", "sleep", Integer.toString(recordDuration), "&&",
409 var matcher = INPUT_EVENT_PATTERN.matcher(out);
410 var commandList = new ArrayList<String>();
412 while (matcher.find()) {
413 String inputPath = matcher.group("input");
414 int n1 = Integer.parseInt(matcher.group("n1"), 16);
415 int n2 = Integer.parseInt(matcher.group("n2"), 16);
416 int n3 = Integer.parseInt(matcher.group("n3"), 16);
417 commandList.add(String.format("sendevent /%s %d %d %d", inputPath, n1, n2, n3));
419 } catch (NumberFormatException e) {
420 logger.warn("NumberFormatException while parsing events, aborting");
423 return String.join(" && ", commandList);
426 public void sendInputEvents(String command)
427 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
428 String out = runAdbShell(command.split(" "));
429 if (out.length() != 0) {
430 logger.warn("Device event unexpected output: {}", out);
431 throw new AndroidDebugBridgeDeviceException("Device event execution fail");
435 public void rebootDevice()
436 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
438 runAdbShell("reboot", "&", "sleep", "0.1", "&&", "exit");
444 public void powerOffDevice()
445 throws AndroidDebugBridgeDeviceException, InterruptedException, TimeoutException, ExecutionException {
447 runAdbShell("reboot", "-p", "&", "sleep", "0.1", "&&", "exit");
453 public void startIntent(String command)
454 throws AndroidDebugBridgeDeviceException, ExecutionException, InterruptedException, TimeoutException {
455 String[] commandParts = command.split("\\|\\|");
456 if (commandParts.length == 0) {
457 throw new AndroidDebugBridgeDeviceException("Empty command");
459 String targetPackage = commandParts[0];
460 var targetPackageParts = targetPackage.split("/");
461 if (targetPackageParts.length > 2) {
462 throw new AndroidDebugBridgeDeviceException("Invalid target package " + targetPackage);
464 if (!PACKAGE_NAME_PATTERN.matcher(targetPackageParts[0]).matches()) {
465 logger.warn("{} is not a valid package name", targetPackageParts[0]);
468 if (targetPackageParts.length == 2 && !SECURE_SHELL_INPUT_PATTERN.matcher(targetPackageParts[1]).matches()) {
469 logger.warn("{} is not a valid activity name", targetPackageParts[1]);
473 String action = null;
475 String dataUri = null;
477 String mimeType = null;
479 String category = null;
481 String component = null;
484 Map<String, Boolean> extraBooleans = new HashMap<>();
485 Map<String, String> extraStrings = new HashMap<>();
486 Map<String, Integer> extraIntegers = new HashMap<>();
487 Map<String, Float> extraFloats = new HashMap<>();
488 Map<String, Long> extraLongs = new HashMap<>();
489 Map<String, URI> extraUris = new HashMap<>();
490 for (var i = 1; i < commandParts.length; i++) {
491 var commandPart = commandParts[i];
492 var endToken = commandPart.indexOf(">");
493 var argName = commandPart.substring(0, endToken + 1);
494 var argValue = commandPart.substring(endToken + 1);
500 if (!PACKAGE_NAME_PATTERN.matcher(argValue).matches()) {
501 logger.warn("{} is not a valid action name", argValue);
508 if (!SECURE_SHELL_INPUT_PATTERN.matcher(argValue).matches()) {
509 logger.warn("{}, insecure input value", argValue);
516 if (!SECURE_SHELL_INPUT_PATTERN.matcher(argValue).matches()) {
517 logger.warn("{}, insecure input value", argValue);
524 if (!SECURE_SHELL_INPUT_PATTERN.matcher(argValue).matches()) {
525 logger.warn("{}, insecure input value", argValue);
532 if (!SECURE_SHELL_INPUT_PATTERN.matcher(argValue).matches()) {
533 logger.warn("{}, insecure input value", argValue);
536 component = argValue;
540 if (!SECURE_SHELL_INPUT_PATTERN.matcher(argValue).matches()) {
541 logger.warn("{}, insecure input value", argValue);
548 valueParts = argValue.split(" ");
549 if (valueParts.length != 2) {
550 logger.warn("argument '{}' requires a key value pair separated by space, current value '{}'",
554 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[0]).matches()) {
555 logger.warn("{}, insecure input value", valueParts[0]);
558 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[1]).matches()) {
559 logger.warn("{}, insecure input value", valueParts[1]);
562 extraStrings.put(valueParts[0], valueParts[1]);
565 valueParts = argValue.split(" ");
566 if (valueParts.length != 2) {
567 logger.warn("argument '{}' requires a key value pair separated by space, current value '{}'",
571 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[0]).matches()) {
572 logger.warn("{}, insecure input value", valueParts[0]);
575 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[1]).matches()) {
576 logger.warn("{}, insecure input value", valueParts[1]);
579 extraBooleans.put(valueParts[0], Boolean.parseBoolean(valueParts[1]));
582 valueParts = argValue.split(" ");
583 if (valueParts.length != 2) {
584 logger.warn("argument '{}' requires a key value pair separated by space, current value '{}'",
588 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[0]).matches()) {
589 logger.warn("{}, insecure input value", valueParts[0]);
592 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[1]).matches()) {
593 logger.warn("{}, insecure input value", valueParts[1]);
597 extraIntegers.put(valueParts[0], Integer.parseInt(valueParts[1]));
598 } catch (NumberFormatException e) {
599 logger.warn("Unable to parse {} as integer", valueParts[1]);
604 valueParts = argValue.split(" ");
605 if (valueParts.length != 2) {
606 logger.warn("argument '{}' requires a key value pair separated by space, current value '{}'",
610 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[0]).matches()) {
611 logger.warn("{}, insecure input value", valueParts[0]);
614 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[1]).matches()) {
615 logger.warn("{}, insecure input value", valueParts[1]);
619 extraLongs.put(valueParts[0], Long.parseLong(valueParts[1]));
620 } catch (NumberFormatException e) {
621 logger.warn("Unable to parse {} as long", valueParts[1]);
626 valueParts = argValue.split(" ");
627 if (valueParts.length != 2) {
628 logger.warn("argument '{}' requires a key value pair separated by space, current value '{}'",
632 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[0]).matches()) {
633 logger.warn("{}, insecure input value", valueParts[0]);
636 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[1]).matches()) {
637 logger.warn("{}, insecure input value", valueParts[1]);
641 extraFloats.put(valueParts[0], Float.parseFloat(valueParts[1]));
642 } catch (NumberFormatException e) {
643 logger.warn("Unable to parse {} as float", valueParts[1]);
648 valueParts = argValue.split(" ");
649 if (valueParts.length != 2) {
650 logger.warn("argument '{}' requires a key value pair separated by space, current value '{}'",
654 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[0]).matches()) {
655 logger.warn("{}, insecure input value", valueParts[0]);
658 if (!SECURE_SHELL_INPUT_PATTERN.matcher(valueParts[1]).matches()) {
659 logger.warn("{}, insecure input value", valueParts[1]);
662 extraUris.put(valueParts[0], URI.create(valueParts[1]));
665 throw new AndroidDebugBridgeDeviceException("Unsupported arg " + argName
666 + ". Open an issue or pr for it if you think support should be added.");
670 StringBuilder adbCommandBuilder = new StringBuilder("am start -n " + targetPackage);
671 if (action != null) {
672 adbCommandBuilder.append(" -a ").append(action);
674 if (dataUri != null) {
675 adbCommandBuilder.append(" -d ").append(dataUri);
677 if (mimeType != null) {
678 adbCommandBuilder.append(" -t ").append(mimeType);
680 if (category != null) {
681 adbCommandBuilder.append(" -c ").append(category);
683 if (component != null) {
684 adbCommandBuilder.append(" -n ").append(component);
687 adbCommandBuilder.append(" -f ").append(flags);
689 if (!extraStrings.isEmpty()) {
690 adbCommandBuilder.append(extraStrings.entrySet().stream()
691 .map(entry -> " --es \"" + entry.getKey() + "\" \"" + entry.getValue() + "\"")
692 .collect(Collectors.joining(" ")));
694 if (!extraBooleans.isEmpty()) {
695 adbCommandBuilder.append(extraBooleans.entrySet().stream()
696 .map(entry -> " --ez \"" + entry.getKey() + "\" " + entry.getValue())
697 .collect(Collectors.joining(" ")));
699 if (!extraIntegers.isEmpty()) {
700 adbCommandBuilder.append(extraIntegers.entrySet().stream()
701 .map(entry -> " --ei \"" + entry.getKey() + "\" " + entry.getValue())
702 .collect(Collectors.joining(" ")));
704 if (!extraFloats.isEmpty()) {
705 adbCommandBuilder.append(
706 extraFloats.entrySet().stream().map(entry -> " --ef \"" + entry.getKey() + "\" " + entry.getValue())
707 .collect(Collectors.joining(" ")));
709 if (!extraLongs.isEmpty()) {
710 adbCommandBuilder.append(
711 extraLongs.entrySet().stream().map(entry -> " --el \"" + entry.getKey() + "\" " + entry.getValue())
712 .collect(Collectors.joining(" ")));
714 runAdbShell(adbCommandBuilder.toString());
717 public boolean isConnected() {
718 var currentSocket = socket;
719 return currentSocket != null && currentSocket.isConnected();
722 public void connect() throws AndroidDebugBridgeDeviceException, InterruptedException {
724 AdbConnection adbConnection;
726 AdbCrypto crypto = adbCrypto;
727 if (crypto == null) {
728 throw new AndroidDebugBridgeDeviceException("Device not connected");
733 sock.connect(new InetSocketAddress(ip, port), (int) TimeUnit.SECONDS.toMillis(15));
734 } catch (IOException e) {
735 logger.debug("Error connecting to {}: [{}] {}", ip, e.getClass().getName(), e.getMessage());
736 if ("Socket closed".equals(e.getMessage())) {
737 // Connection aborted by us
738 throw new InterruptedException();
740 throw new AndroidDebugBridgeDeviceException("Can not open socket " + ip + ":" + port);
743 adbConnection = AdbConnection.create(sock, crypto);
744 connection = adbConnection;
745 adbConnection.connect(15, TimeUnit.SECONDS, false);
746 } catch (IOException e) {
747 logger.debug("Error connecting to {}: {}", ip, e.getMessage());
748 throw new AndroidDebugBridgeDeviceException("Can not open adb connection " + ip + ":" + port);
752 private String runAdbShell(String... args)
753 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
754 return runAdbShell(timeoutSec, args);
757 private String runAdbShell(int commandTimeout, String... args)
758 throws InterruptedException, AndroidDebugBridgeDeviceException, TimeoutException, ExecutionException {
759 var adb = connection;
761 throw new AndroidDebugBridgeDeviceException("Device not connected");
765 var commandFuture = scheduler.submit(() -> {
766 var byteArrayOutputStream = new ByteArrayOutputStream();
767 String cmd = String.join(" ", args);
768 logger.debug("{} - shell:{}", ip, cmd);
769 try (AdbStream stream = adb.open("shell:" + cmd)) {
771 byteArrayOutputStream.writeBytes(stream.read());
772 } while (!stream.isClosed());
773 } catch (IOException e) {
774 if (!"Stream closed".equals(e.getMessage())) {
778 return byteArrayOutputStream.toString(StandardCharsets.US_ASCII);
780 this.commandFuture = commandFuture;
781 return commandFuture.get(commandTimeout, TimeUnit.SECONDS);
783 var commandFuture = this.commandFuture;
784 if (commandFuture != null) {
785 commandFuture.cancel(true);
786 this.commandFuture = null;
788 commandLock.unlock();
792 private static AdbBase64 getBase64Impl() {
793 Charset asciiCharset = Charset.forName("ASCII");
794 return bytes -> new String(Base64.getEncoder().encode(bytes), asciiCharset);
797 private static AdbCrypto loadKeyPair(String pubKeyFile, String privKeyFile)
798 throws NoSuchAlgorithmException, IOException, InvalidKeySpecException {
799 File pub = new File(pubKeyFile);
800 File priv = new File(privKeyFile);
803 if (pub.exists() && priv.exists()) {
805 c = AdbCrypto.loadAdbKeyPair(getBase64Impl(), priv, pub);
806 } catch (IOException ignored) {
812 c = AdbCrypto.generateAdbKeyPair(getBase64Impl());
813 c.saveAdbKeyPair(priv, pub);
818 public void disconnect() {
819 var commandFuture = this.commandFuture;
820 if (commandFuture != null && !commandFuture.isDone()) {
821 commandFuture.cancel(true);
823 var adb = connection;
828 } catch (IOException ignored) {
835 } catch (IOException ignored) {
841 private boolean isAtLeastVersion(int major) {
842 return isAtLeastVersion(major, 0);
845 private boolean isAtLeastVersion(int major, int minor) {
846 return isAtLeastVersion(major, minor, 0);
849 private boolean isAtLeastVersion(int major, int minor, int patch) {
850 return majorVersionNumber > major || (majorVersionNumber == major
851 && (minorVersionNumber > minor || (minorVersionNumber == minor && patchVersionNumber >= patch)));
854 public static class VolumeInfo {
859 VolumeInfo(int current, int min, int max) {
860 this.current = current;