// Copyright 2016 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import 'dart:async'; import 'dart:convert'; import 'dart:io'; import '../android/android_sdk.dart'; import '../application_package.dart'; import '../base/os.dart'; import '../base/process.dart'; import '../build_configuration.dart'; import '../device.dart'; import '../flx.dart' as flx; import '../globals.dart'; import '../service_protocol.dart'; import '../toolchain.dart'; import 'adb.dart'; import 'android.dart'; const String _defaultAdbPath = 'adb'; // Path where the FLX bundle will be copied on the device. const String _deviceBundlePath = '/data/local/tmp/dev.flx'; // Path where the snapshot will be copied on the device. const String _deviceSnapshotPath = '/data/local/tmp/dev_snapshot.bin'; class AndroidDevices extends PollingDeviceDiscovery { AndroidDevices() : super('AndroidDevices'); @override bool get supportsPlatform => true; @override List pollingGetDevices() => getAdbDevices(); } class AndroidDevice extends Device { AndroidDevice( String id, { this.productID, this.modelID, this.deviceCodeName }) : super(id); final String productID; final String modelID; final String deviceCodeName; Map _properties; bool _isLocalEmulator; TargetPlatform _platform; String _getProperty(String name) { if (_properties == null) { String getpropOutput = runCheckedSync(adbCommandForDevice(['shell', 'getprop'])); RegExp propertyExp = new RegExp(r'\[(.*?)\]: \[(.*?)\]'); _properties = {}; for (Match m in propertyExp.allMatches(getpropOutput)) { _properties[m.group(1)] = m.group(2); } } return _properties[name]; } @override bool get isLocalEmulator { if (_isLocalEmulator == null) { String characteristics = _getProperty('ro.build.characteristics'); _isLocalEmulator = characteristics != null && characteristics.contains('emulator'); } return _isLocalEmulator; } @override TargetPlatform get platform { if (_platform == null) { // http://developer.android.com/ndk/guides/abis.html (x86, armeabi-v7a, ...) switch (_getProperty('ro.product.cpu.abi')) { case 'x86_64': _platform = TargetPlatform.android_x64; break; case 'x86': _platform = TargetPlatform.android_x86; break; default: _platform = TargetPlatform.android_arm; break; } } return _platform; } _AdbLogReader _logReader; _AndroidDevicePortForwarder _portForwarder; List adbCommandForDevice(List args) { return [androidSdk.adbPath, '-s', id]..addAll(args); } bool _isValidAdbVersion(String adbVersion) { // Sample output: 'Android Debug Bridge version 1.0.31' Match versionFields = new RegExp(r'(\d+)\.(\d+)\.(\d+)').firstMatch(adbVersion); if (versionFields != null) { int majorVersion = int.parse(versionFields[1]); int minorVersion = int.parse(versionFields[2]); int patchVersion = int.parse(versionFields[3]); if (majorVersion > 1) { return true; } if (majorVersion == 1 && minorVersion > 0) { return true; } if (majorVersion == 1 && minorVersion == 0 && patchVersion >= 32) { return true; } return false; } printError( 'Unrecognized adb version string $adbVersion. Skipping version check.'); return true; } bool _checkForSupportedAdbVersion() { if (androidSdk == null) return false; try { String adbVersion = runCheckedSync([androidSdk.adbPath, 'version']); if (_isValidAdbVersion(adbVersion)) return true; printError('The ADB at "${androidSdk.adbPath}" is too old; please install version 1.0.32 or later.'); } catch (error, trace) { printError('Error running ADB: $error', trace); } return false; } bool _checkForSupportedAndroidVersion() { try { // If the server is automatically restarted, then we get irrelevant // output lines like this, which we want to ignore: // adb server is out of date. killing.. // * daemon started successfully * runCheckedSync([androidSdk.adbPath, 'start-server']); // Sample output: '22' String sdkVersion = _getProperty('ro.build.version.sdk'); int sdkVersionParsed = int.parse(sdkVersion, onError: (String source) => null); if (sdkVersionParsed == null) { printError('Unexpected response from getprop: "$sdkVersion"'); return false; } if (sdkVersionParsed < minApiLevel) { printError( 'The Android version ($sdkVersion) on the target device is too old. Please ' 'use a $minVersionName (version $minApiLevel / $minVersionText) device or later.'); return false; } return true; } catch (e) { printError('Unexpected failure from adb: $e'); return false; } } String _getDeviceSha1Path(ApplicationPackage app) { return '/data/local/tmp/sky.${app.id}.sha1'; } String _getDeviceApkSha1(ApplicationPackage app) { return runCheckedSync(adbCommandForDevice(['shell', 'cat', _getDeviceSha1Path(app)])); } String _getSourceSha1(ApplicationPackage app) { File shaFile = new File('${app.localPath}.sha1'); return shaFile.existsSync() ? shaFile.readAsStringSync() : ''; } @override String get name => modelID; @override bool isAppInstalled(ApplicationPackage app) { // This call takes 400ms - 600ms. String listOut = runCheckedSync(adbCommandForDevice(['shell', 'pm', 'list', 'packages', app.id])); if (!LineSplitter.split(listOut).contains("package:${app.id}")) return false; // Check the application SHA. return _getDeviceApkSha1(app) == _getSourceSha1(app); } @override bool installApp(ApplicationPackage app) { if (!FileSystemEntity.isFileSync(app.localPath)) { printError('"${app.localPath}" does not exist.'); return false; } if (!_checkForSupportedAdbVersion() || !_checkForSupportedAndroidVersion()) return false; String installOut = runCheckedSync(adbCommandForDevice(['install', '-r', app.localPath])); RegExp failureExp = new RegExp(r'^Failure.*$', multiLine: true); String failure = failureExp.stringMatch(installOut); if (failure != null) { printError('Package install error: $failure'); return false; } runCheckedSync(adbCommandForDevice(['shell', 'echo', '-n', _getSourceSha1(app), '>', _getDeviceSha1Path(app)])); return true; } Future _forwardPort(String service, int devicePort, int port) async { try { // Set up port forwarding for observatory. port = await portForwarder.forward(devicePort, hostPort: port); printStatus('$service listening on http://127.0.0.1:$port'); } catch (e) { printError('Unable to forward port $port: $e'); } } Future startBundle(AndroidApk apk, String bundlePath, { bool traceStartup: false, String route, DebuggingOptions options }) async { printTrace('$this startBundle'); if (!FileSystemEntity.isFileSync(bundlePath)) { printError('Cannot find $bundlePath'); return new LaunchResult.failed(); } runCheckedSync(adbCommandForDevice(['push', bundlePath, _deviceBundlePath])); ServiceProtocolDiscovery observatoryDiscovery; ServiceProtocolDiscovery diagnosticDiscovery; if (options.debuggingEnabled) { observatoryDiscovery = new ServiceProtocolDiscovery( logReader, ServiceProtocolDiscovery.kObservatoryService); diagnosticDiscovery = new ServiceProtocolDiscovery( logReader, ServiceProtocolDiscovery.kDiagnosticService); } List cmd = adbCommandForDevice([ 'shell', 'am', 'start', '-a', 'android.intent.action.RUN', '-d', _deviceBundlePath, '-f', '0x20000000', // FLAG_ACTIVITY_SINGLE_TOP '--ez', 'enable-background-compilation', 'true', ]); if (traceStartup) cmd.addAll(['--ez', 'trace-startup', 'true']); if (route != null) cmd.addAll(['--es', 'route', route]); if (options.debuggingEnabled) { if (options.checked) cmd.addAll(['--ez', 'enable-checked-mode', 'true']); if (options.startPaused) cmd.addAll(['--ez', 'start-paused', 'true']); } cmd.add(apk.launchActivity); String result = runCheckedSync(cmd); // This invocation returns 0 even when it fails. if (result.contains('Error: ')) { printError(result.trim()); return new LaunchResult.failed(); } if (!options.debuggingEnabled) { return new LaunchResult.succeeded(); } else { // Wait for the service protocol port here. This will complete once the // device has printed "Observatory is listening on...". printTrace('Waiting for observatory port to be available...'); try { Future> scrapeServicePorts = Future.wait( >[observatoryDiscovery.nextPort(), diagnosticDiscovery.nextPort()] ); List devicePorts = await scrapeServicePorts.timeout(new Duration(seconds: 20)); int observatoryDevicePort = devicePorts[0]; printTrace('observatory port = $observatoryDevicePort'); int observatoryLocalPort = await options.findBestObservatoryPort(); // TODO(devoncarew): Remember the forwarding information (so we can later remove the // port forwarding). await _forwardPort(ServiceProtocolDiscovery.kObservatoryService, observatoryDevicePort, observatoryLocalPort); int diagnosticDevicePort = devicePorts[1]; printTrace('diagnostic port = $diagnosticDevicePort'); int diagnosticLocalPort = await options.findBestDiagnosticPort(); await _forwardPort(ServiceProtocolDiscovery.kDiagnosticService, diagnosticDevicePort, diagnosticLocalPort); return new LaunchResult.succeeded( observatoryPort: observatoryLocalPort, diagnosticPort: diagnosticLocalPort ); } catch (error) { if (error is TimeoutException) printError('Timed out while waiting for a debug connection.'); else printError('Error waiting for a debug connection: $error'); return new LaunchResult.failed(); } finally { observatoryDiscovery.cancel(); diagnosticDiscovery.cancel(); } } } @override Future startApp( ApplicationPackage package, Toolchain toolchain, { String mainPath, String route, DebuggingOptions debuggingOptions, Map platformArgs }) async { if (!_checkForSupportedAdbVersion() || !_checkForSupportedAndroidVersion()) return new LaunchResult.failed(); String localBundlePath = await flx.buildFlx( toolchain, mainPath: mainPath, includeRobotoFonts: false ); if (localBundlePath == null) return new LaunchResult.failed(); printTrace('Starting bundle for $this.'); return startBundle( package, localBundlePath, traceStartup: platformArgs['trace-startup'], route: route, options: debuggingOptions ); } @override Future stopApp(ApplicationPackage app) { List command = adbCommandForDevice(['shell', 'am', 'force-stop', app.id]); return runCommandAndStreamOutput(command).then((int exitCode) => exitCode == 0); } @override void clearLogs() { runSync(adbCommandForDevice(['logcat', '-c'])); } @override DeviceLogReader get logReader { if (_logReader == null) _logReader = new _AdbLogReader(this); return _logReader; } @override DevicePortForwarder get portForwarder { if (_portForwarder == null) _portForwarder = new _AndroidDevicePortForwarder(this); return _portForwarder; } /// Return the most recent timestamp in the Android log or `null` if there is /// no available timestamp. The format can be passed to logcat's -T option. String get lastLogcatTimestamp { String output = runCheckedSync(adbCommandForDevice([ 'logcat', '-v', 'time', '-t', '1' ])); RegExp timeRegExp = new RegExp(r'^\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}', multiLine: true); Match timeMatch = timeRegExp.firstMatch(output); return timeMatch?.group(0); } @override bool isSupported() => true; Future refreshSnapshot(String activity, String snapshotPath) async { if (!FileSystemEntity.isFileSync(snapshotPath)) { printError('Cannot find $snapshotPath'); return false; } runCheckedSync(adbCommandForDevice(['push', snapshotPath, _deviceSnapshotPath])); List cmd = adbCommandForDevice([ 'shell', 'am', 'start', '-a', 'android.intent.action.RUN', '-d', _deviceBundlePath, '-f', '0x20000000', // FLAG_ACTIVITY_SINGLE_TOP '--es', 'snapshot', _deviceSnapshotPath, activity, ]); runCheckedSync(cmd); return true; } @override bool get supportsScreenshot => true; @override Future takeScreenshot(File outputFile) { const String remotePath = '/data/local/tmp/flutter_screenshot.png'; runCheckedSync(adbCommandForDevice(['shell', 'screencap', '-p', remotePath])); runCheckedSync(adbCommandForDevice(['pull', remotePath, outputFile.path])); runCheckedSync(adbCommandForDevice(['shell', 'rm', remotePath])); return new Future.value(true); } } // 015d172c98400a03 device usb:340787200X product:nakasi model:Nexus_7 device:grouper final RegExp _kDeviceRegex = new RegExp(r'^(\S+)\s+(\S+)(.*)'); /// Return the list of connected ADB devices. /// /// [mockAdbOutput] is public for testing. List getAdbDevices({ String mockAdbOutput }) { List devices = []; List output; if (mockAdbOutput == null) { String adbPath = getAdbPath(androidSdk); if (adbPath == null) return []; output = runSync([adbPath, 'devices', '-l']).trim().split('\n'); } else { output = mockAdbOutput.trim().split('\n'); } for (String line in output) { // Skip lines like: * daemon started successfully * if (line.startsWith('* daemon ')) continue; if (line.startsWith('List of devices')) continue; if (_kDeviceRegex.hasMatch(line)) { Match match = _kDeviceRegex.firstMatch(line); String deviceID = match[1]; String deviceState = match[2]; String rest = match[3]; Map info = {}; if (rest != null && rest.isNotEmpty) { rest = rest.trim(); for (String data in rest.split(' ')) { if (data.contains(':')) { List fields = data.split(':'); info[fields[0]] = fields[1]; } } } if (info['model'] != null) info['model'] = cleanAdbDeviceName(info['model']); if (deviceState == 'unauthorized') { printError( 'Device $deviceID is not authorized.\n' 'You might need to check your device for an authorization dialog.' ); } else if (deviceState == 'offline') { printError('Device $deviceID is offline.'); } else { devices.add(new AndroidDevice( deviceID, productID: info['product'], modelID: info['model'] ?? deviceID, deviceCodeName: info['device'] )); } } else { printError( 'Unexpected failure parsing device information from adb output:\n' '$line\n' 'Please report a bug at https://github.com/flutter/flutter/issues/new'); } } return devices; } /// A log reader that logs from `adb logcat`. class _AdbLogReader extends DeviceLogReader { _AdbLogReader(this.device) { _linesController = new StreamController.broadcast( onListen: _start, onCancel: _stop ); } final AndroidDevice device; StreamController _linesController; Process _process; @override Stream get logLines => _linesController.stream; @override String get name => device.name; void _start() { // Start the adb logcat process. List args = ['logcat', '-v', 'tag']; String lastTimestamp = device.lastLogcatTimestamp; if (lastTimestamp != null) args.addAll(['-T', lastTimestamp]); args.addAll([ '-s', 'flutter:V', 'FlutterMain:V', 'FlutterView:V', 'AndroidRuntime:W', 'ActivityManager:W', 'System.err:W', '*:F' ]); runCommand(device.adbCommandForDevice(args)).then((Process process) { _process = process; _process.stdout.transform(UTF8.decoder).transform(const LineSplitter()).listen(_onLine); _process.stderr.transform(UTF8.decoder).transform(const LineSplitter()).listen(_onLine); _process.exitCode.then((int code) { if (_linesController.hasListener) _linesController.close(); }); }); } void _onLine(String line) { // Filter out some noisy ActivityManager notifications. if (line.startsWith('W/ActivityManager: getRunningAppProcesses')) return; _linesController.add(line); } void _stop() { // TODO(devoncarew): We should remove adb port forwarding here. _process?.kill(); } } class _AndroidDevicePortForwarder extends DevicePortForwarder { _AndroidDevicePortForwarder(this.device); final AndroidDevice device; static int _extractPort(String portString) { return int.parse(portString.trim(), onError: (_) => null); } @override List get forwardedPorts { final List ports = []; String stdout = runCheckedSync(device.adbCommandForDevice( ['forward', '--list'] )); List lines = LineSplitter.split(stdout).toList(); for (String line in lines) { if (line.startsWith(device.id)) { List splitLine = line.split("tcp:"); // Sanity check splitLine. if (splitLine.length != 3) continue; // Attempt to extract ports. int hostPort = _extractPort(splitLine[1]); int devicePort = _extractPort(splitLine[2]); // Failed, skip. if ((hostPort == null) || (devicePort == null)) continue; ports.add(new ForwardedPort(hostPort, devicePort)); } } return ports; } @override Future forward(int devicePort, { int hostPort }) async { if ((hostPort == null) || (hostPort == 0)) { // Auto select host port. hostPort = await findAvailablePort(); } runCheckedSync(device.adbCommandForDevice( ['forward', 'tcp:$hostPort', 'tcp:$devicePort'] )); return hostPort; } @override Future unforward(ForwardedPort forwardedPort) async { runCheckedSync(device.adbCommandForDevice( ['forward', '--remove', 'tcp:${forwardedPort.hostPort}'] )); } }