| // 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' show UTF8; |
| |
| import 'package:archive/archive.dart'; |
| |
| import 'android/android_studio_validator.dart'; |
| import 'android/android_workflow.dart'; |
| import 'artifacts.dart'; |
| import 'base/common.dart'; |
| import 'base/context.dart'; |
| import 'base/file_system.dart'; |
| import 'base/os.dart'; |
| import 'base/platform.dart'; |
| import 'base/process_manager.dart'; |
| import 'base/version.dart'; |
| import 'cache.dart'; |
| import 'device.dart'; |
| import 'globals.dart'; |
| import 'ios/ios_workflow.dart'; |
| import 'ios/plist_utils.dart'; |
| import 'version.dart'; |
| |
| Doctor get doctor => context[Doctor]; |
| |
| class Doctor { |
| List<DoctorValidator> _validators; |
| |
| List<DoctorValidator> get validators { |
| if (_validators == null) { |
| _validators = <DoctorValidator>[]; |
| _validators.add(new _FlutterValidator()); |
| |
| if (androidWorkflow.appliesToHostPlatform) |
| _validators.add(androidWorkflow); |
| |
| if (iosWorkflow.appliesToHostPlatform) |
| _validators.add(iosWorkflow); |
| |
| final List<DoctorValidator> ideValidators = <DoctorValidator>[]; |
| ideValidators.addAll(AndroidStudioValidator.allValidators); |
| ideValidators.addAll(IntelliJValidator.installedValidators); |
| if (ideValidators.isNotEmpty) |
| _validators.addAll(ideValidators); |
| else |
| _validators.add(new NoIdeValidator()); |
| |
| if (deviceManager.canListAnything) |
| _validators.add(new DeviceValidator()); |
| } |
| return _validators; |
| } |
| |
| List<Workflow> get workflows { |
| return new List<Workflow>.from(validators.where((DoctorValidator validator) => validator is Workflow)); |
| } |
| |
| /// Print a summary of the state of the tooling, as well as how to get more info. |
| Future<Null> summary() async { |
| printStatus(await summaryText); |
| } |
| |
| Future<String> get summaryText async { |
| final StringBuffer buffer = new StringBuffer(); |
| |
| bool allGood = true; |
| |
| for (DoctorValidator validator in validators) { |
| final ValidationResult result = await validator.validate(); |
| buffer.write('${result.leadingBox} ${validator.title} is '); |
| if (result.type == ValidationType.missing) |
| buffer.write('not installed.'); |
| else if (result.type == ValidationType.partial) |
| buffer.write('partially installed; more components are available.'); |
| else |
| buffer.write('fully installed.'); |
| |
| if (result.statusInfo != null) |
| buffer.write(' (${result.statusInfo})'); |
| |
| buffer.writeln(); |
| |
| if (result.type != ValidationType.installed) |
| allGood = false; |
| } |
| |
| if (!allGood) { |
| buffer.writeln(); |
| buffer.writeln('Run "flutter doctor" for information about installing additional components.'); |
| } |
| |
| return buffer.toString(); |
| } |
| |
| /// Print verbose information about the state of installed tooling. |
| Future<bool> diagnose({ bool androidLicenses: false }) async { |
| if (androidLicenses) |
| return AndroidWorkflow.runLicenseManager(); |
| |
| bool doctorResult = true; |
| |
| for (DoctorValidator validator in validators) { |
| final ValidationResult result = await validator.validate(); |
| |
| if (result.type == ValidationType.missing) |
| doctorResult = false; |
| |
| if (result.statusInfo != null) |
| printStatus('${result.leadingBox} ${validator.title} (${result.statusInfo})'); |
| else |
| printStatus('${result.leadingBox} ${validator.title}'); |
| |
| for (ValidationMessage message in result.messages) { |
| final String text = message.message.replaceAll('\n', '\n '); |
| if (message.isError) { |
| printStatus(' ✗ $text', emphasis: true); |
| } else { |
| printStatus(' • $text'); |
| } |
| } |
| |
| printStatus(''); |
| } |
| |
| return doctorResult; |
| } |
| |
| bool get canListAnything => workflows.any((Workflow workflow) => workflow.canListDevices); |
| |
| bool get canLaunchAnything => workflows.any((Workflow workflow) => workflow.canLaunchDevices); |
| } |
| |
| /// A series of tools and required install steps for a target platform (iOS or Android). |
| abstract class Workflow { |
| /// Whether the workflow applies to this platform (as in, should we ever try and use it). |
| bool get appliesToHostPlatform; |
| |
| /// Are we functional enough to list devices? |
| bool get canListDevices; |
| |
| /// Could this thing launch *something*? It may still have minor issues. |
| bool get canLaunchDevices; |
| } |
| |
| enum ValidationType { |
| missing, |
| partial, |
| installed |
| } |
| |
| abstract class DoctorValidator { |
| DoctorValidator(this.title); |
| |
| final String title; |
| |
| Future<ValidationResult> validate(); |
| } |
| |
| class ValidationResult { |
| ValidationResult(this.type, this.messages, { this.statusInfo }); |
| |
| final ValidationType type; |
| // A short message about the status. |
| final String statusInfo; |
| final List<ValidationMessage> messages; |
| |
| String get leadingBox { |
| if (type == ValidationType.missing) |
| return '[✗]'; |
| else if (type == ValidationType.installed) |
| return '[✓]'; |
| else |
| return '[-]'; |
| } |
| } |
| |
| class ValidationMessage { |
| ValidationMessage(this.message) : isError = false; |
| ValidationMessage.error(this.message) : isError = true; |
| |
| final bool isError; |
| final String message; |
| |
| @override |
| String toString() => message; |
| } |
| |
| class _FlutterValidator extends DoctorValidator { |
| _FlutterValidator() : super('Flutter'); |
| |
| @override |
| Future<ValidationResult> validate() async { |
| final List<ValidationMessage> messages = <ValidationMessage>[]; |
| ValidationType valid = ValidationType.installed; |
| |
| final FlutterVersion version = FlutterVersion.instance; |
| |
| messages.add(new ValidationMessage('Flutter version ${version.frameworkVersion} at ${Cache.flutterRoot}')); |
| if (Cache.flutterRoot.contains(' ')) |
| messages.add(new ValidationMessage.error( |
| 'Flutter SDK install paths with spaces are not yet supported. (https://github.com/flutter/flutter/issues/6577)\n' |
| 'Please move the SDK to a path that does not include spaces.')); |
| messages.add(new ValidationMessage( |
| 'Framework revision ${version.frameworkRevisionShort} ' |
| '(${version.frameworkAge}), ${version.frameworkDate}' |
| )); |
| messages.add(new ValidationMessage('Engine revision ${version.engineRevisionShort}')); |
| messages.add(new ValidationMessage('Tools Dart version ${version.dartSdkVersion}')); |
| messages.add(new ValidationMessage('Engine Dart version ${version.engineDartVersion}')); |
| final String genSnapshotPath = |
| artifacts.getArtifactPath(Artifact.genSnapshot); |
| |
| // Check that the binaries we downloaded for this platform actually run on it. |
| if (!_genSnapshotRuns(genSnapshotPath)) { |
| messages.add(new ValidationMessage.error('Downloaded executables cannot execute ' |
| 'on host (see https://github.com/flutter/flutter/issues/6207 for more information)')); |
| valid = ValidationType.partial; |
| } |
| |
| return new ValidationResult(valid, messages, |
| statusInfo: 'on ${os.name}, locale ${platform.localeName}, channel ${version.channel}'); |
| } |
| } |
| |
| bool _genSnapshotRuns(String genSnapshotPath) { |
| final int kExpectedExitCode = 255; |
| try { |
| return processManager.runSync(<String>[genSnapshotPath]).exitCode == kExpectedExitCode; |
| } catch (error) { |
| return false; |
| } |
| } |
| |
| class NoIdeValidator extends DoctorValidator { |
| NoIdeValidator() : super('Flutter IDE Support'); |
| |
| @override |
| Future<ValidationResult> validate() async { |
| return new ValidationResult(ValidationType.missing, <ValidationMessage>[ |
| new ValidationMessage('IntelliJ - https://www.jetbrains.com/idea/'), |
| ], statusInfo: 'No supported IDEs installed'); |
| } |
| } |
| |
| abstract class IntelliJValidator extends DoctorValidator { |
| IntelliJValidator(String title) : super(title); |
| |
| String get version; |
| String get pluginsPath; |
| |
| static final Map<String, String> _idToTitle = <String, String>{ |
| 'IntelliJIdea' : 'IntelliJ IDEA Ultimate Edition', |
| 'IdeaIC' : 'IntelliJ IDEA Community Edition', |
| }; |
| |
| static final Version kMinIdeaVersion = new Version(2017, 1, 0); |
| static final Version kMinFlutterPluginVersion = new Version(16, 0, 0); |
| |
| static Iterable<DoctorValidator> get installedValidators { |
| if (platform.isLinux || platform.isWindows) |
| return IntelliJValidatorOnLinuxAndWindows.installed; |
| if (platform.isMacOS) |
| return IntelliJValidatorOnMac.installed; |
| return <DoctorValidator>[]; |
| } |
| |
| @override |
| Future<ValidationResult> validate() async { |
| final List<ValidationMessage> messages = <ValidationMessage>[]; |
| |
| _validatePackage(messages, <String>['flutter-intellij', 'flutter-intellij.jar'], |
| 'Flutter', minVersion: kMinFlutterPluginVersion); |
| _validatePackage(messages, <String>['Dart'], 'Dart'); |
| |
| if (_hasIssues(messages)) { |
| messages.add(new ValidationMessage( |
| 'For information about installing plugins, see\n' |
| 'https://flutter.io/intellij-setup/#installing-the-plugins' |
| )); |
| } |
| |
| _validateIntelliJVersion(messages, kMinIdeaVersion); |
| |
| return new ValidationResult( |
| _hasIssues(messages) ? ValidationType.partial : ValidationType.installed, |
| messages, |
| statusInfo: 'version $version' |
| ); |
| } |
| |
| bool _hasIssues(List<ValidationMessage> messages) { |
| return messages.any((ValidationMessage message) => message.isError); |
| } |
| |
| void _validateIntelliJVersion(List<ValidationMessage> messages, Version minVersion) { |
| // Ignore unknown versions. |
| if (minVersion == Version.unknown) |
| return; |
| |
| final Version installedVersion = new Version.parse(version); |
| if (installedVersion == null) |
| return; |
| |
| if (installedVersion < minVersion) { |
| messages.add(new ValidationMessage.error( |
| 'This install is older than the minimum recommended version of $minVersion.' |
| )); |
| } |
| } |
| |
| void _validatePackage(List<ValidationMessage> messages, List<String> packageNames, String title, { |
| Version minVersion |
| }) { |
| for (String packageName in packageNames) { |
| if (!hasPackage(packageName)) { |
| continue; |
| } |
| |
| final String versionText = _readPackageVersion(packageName); |
| final Version version = new Version.parse(versionText); |
| if (version != null && minVersion != null && version < minVersion) { |
| messages.add(new ValidationMessage.error( |
| '$title plugin version $versionText - the recommended minimum version is $minVersion' |
| )); |
| } else { |
| messages.add(new ValidationMessage( |
| '$title plugin ${version != null ? "version $version" : "installed"}' |
| )); |
| } |
| |
| return; |
| } |
| |
| messages.add(new ValidationMessage.error( |
| '$title plugin not installed; this adds $title specific functionality.' |
| )); |
| } |
| |
| String _readPackageVersion(String packageName) { |
| final String jarPath = packageName.endsWith('.jar') |
| ? fs.path.join(pluginsPath, packageName) |
| : fs.path.join(pluginsPath, packageName, 'lib', '$packageName.jar'); |
| // TODO(danrubel) look for a better way to extract a single 2K file from the zip |
| // rather than reading the entire file into memory. |
| try { |
| final Archive archive = new ZipDecoder().decodeBytes(fs.file(jarPath).readAsBytesSync()); |
| final ArchiveFile file = archive.findFile('META-INF/plugin.xml'); |
| final String content = UTF8.decode(file.content); |
| final String versionStartTag = '<version>'; |
| final int start = content.indexOf(versionStartTag); |
| final int end = content.indexOf('</version>', start); |
| return content.substring(start + versionStartTag.length, end); |
| } catch (_) { |
| return null; |
| } |
| } |
| |
| bool hasPackage(String packageName) { |
| final String packagePath = fs.path.join(pluginsPath, packageName); |
| if (packageName.endsWith('.jar')) |
| return fs.isFileSync(packagePath); |
| return fs.isDirectorySync(packagePath); |
| } |
| } |
| |
| class IntelliJValidatorOnLinuxAndWindows extends IntelliJValidator { |
| IntelliJValidatorOnLinuxAndWindows(String title, this.version, this.installPath, this.pluginsPath) : super(title); |
| |
| @override |
| String version; |
| |
| final String installPath; |
| |
| @override |
| String pluginsPath; |
| |
| static Iterable<DoctorValidator> get installed { |
| final List<DoctorValidator> validators = <DoctorValidator>[]; |
| if (homeDirPath == null) |
| return validators; |
| |
| void addValidator(String title, String version, String installPath, String pluginsPath) { |
| final IntelliJValidatorOnLinuxAndWindows validator = |
| new IntelliJValidatorOnLinuxAndWindows(title, version, installPath, pluginsPath); |
| for (int index = 0; index < validators.length; ++index) { |
| final DoctorValidator other = validators[index]; |
| if (other is IntelliJValidatorOnLinuxAndWindows && validator.installPath == other.installPath) { |
| if (validator.version.compareTo(other.version) > 0) |
| validators[index] = validator; |
| return; |
| } |
| } |
| validators.add(validator); |
| } |
| |
| for (FileSystemEntity dir in fs.directory(homeDirPath).listSync()) { |
| if (dir is Directory) { |
| final String name = fs.path.basename(dir.path); |
| IntelliJValidator._idToTitle.forEach((String id, String title) { |
| if (name.startsWith('.$id')) { |
| final String version = name.substring(id.length + 1); |
| String installPath; |
| try { |
| installPath = fs.file(fs.path.join(dir.path, 'system', '.home')).readAsStringSync(); |
| } catch (e) { |
| // ignored |
| } |
| if (installPath != null && fs.isDirectorySync(installPath)) { |
| final String pluginsPath = fs.path.join(dir.path, 'config', 'plugins'); |
| addValidator(title, version, installPath, pluginsPath); |
| } |
| } |
| }); |
| } |
| } |
| return validators; |
| } |
| } |
| |
| class IntelliJValidatorOnMac extends IntelliJValidator { |
| IntelliJValidatorOnMac(String title, this.id, this.installPath) : super(title); |
| |
| final String id; |
| final String installPath; |
| |
| static final Map<String, String> _dirNameToId = <String, String>{ |
| 'IntelliJ IDEA.app' : 'IntelliJIdea', |
| 'IntelliJ IDEA Ultimate.app' : 'IntelliJIdea', |
| 'IntelliJ IDEA CE.app' : 'IdeaIC', |
| }; |
| |
| static Iterable<DoctorValidator> get installed { |
| final List<DoctorValidator> validators = <DoctorValidator>[]; |
| final List<String> installPaths = <String>['/Applications', fs.path.join(homeDirPath, 'Applications')]; |
| |
| void checkForIntelliJ(Directory dir) { |
| final String name = fs.path.basename(dir.path); |
| _dirNameToId.forEach((String dirName, String id) { |
| if (name == dirName) { |
| final String title = IntelliJValidator._idToTitle[id]; |
| validators.add(new IntelliJValidatorOnMac(title, id, dir.path)); |
| } |
| }); |
| } |
| |
| try { |
| final Iterable<FileSystemEntity> installDirs = installPaths |
| .map((String installPath) => fs.directory(installPath)) |
| .map((Directory dir) => dir.existsSync() ? dir.listSync() : <FileSystemEntity>[]) |
| .expand((List<FileSystemEntity> mappedDirs) => mappedDirs) |
| .where((FileSystemEntity mappedDir) => mappedDir is Directory); |
| for (FileSystemEntity dir in installDirs) { |
| if (dir is Directory) { |
| checkForIntelliJ(dir); |
| if (!dir.path.endsWith('.app')) { |
| for (FileSystemEntity subdir in dir.listSync()) { |
| if (subdir is Directory) { |
| checkForIntelliJ(subdir); |
| } |
| } |
| } |
| } |
| } |
| } on FileSystemException catch (e) { |
| validators.add(new ValidatorWithResult( |
| 'Cannot determine if IntelliJ is installed', |
| new ValidationResult(ValidationType.missing, <ValidationMessage>[ |
| new ValidationMessage.error(e.message), |
| ]), |
| )); |
| } |
| return validators; |
| } |
| |
| @override |
| String get version { |
| if (_version == null) { |
| final String plistFile = fs.path.join(installPath, 'Contents', 'Info.plist'); |
| _version = getValueFromFile(plistFile, kCFBundleShortVersionStringKey) ?? 'unknown'; |
| } |
| return _version; |
| } |
| String _version; |
| |
| @override |
| String get pluginsPath { |
| final List<String> split = version.split('.'); |
| final String major = split[0]; |
| final String minor = split[1]; |
| return fs.path.join(homeDirPath, 'Library', 'Application Support', '$id$major.$minor'); |
| } |
| } |
| |
| class DeviceValidator extends DoctorValidator { |
| DeviceValidator() : super('Connected devices'); |
| |
| @override |
| Future<ValidationResult> validate() async { |
| final List<Device> devices = await deviceManager.getAllConnectedDevices().toList(); |
| List<ValidationMessage> messages; |
| if (devices.isEmpty) { |
| final List<String> diagnostics = await deviceManager.getDeviceDiagnostics(); |
| if (diagnostics.isNotEmpty) { |
| messages = diagnostics.map((String message) => new ValidationMessage(message)).toList(); |
| } else { |
| messages = <ValidationMessage>[new ValidationMessage('None')]; |
| } |
| } else { |
| messages = await Device.descriptions(devices) |
| .map((String msg) => new ValidationMessage(msg)).toList(); |
| } |
| return new ValidationResult(devices.isEmpty ? ValidationType.partial : ValidationType.installed, messages); |
| } |
| } |
| |
| class ValidatorWithResult extends DoctorValidator { |
| final ValidationResult result; |
| |
| ValidatorWithResult(String title, this.result) : super(title); |
| |
| @override |
| Future<ValidationResult> validate() async => result; |
| } |