doctor.dart 27.2 KB
Newer Older
1 2 3 4
// 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.

5
import 'dart:async';
6

7
import 'android/android_studio_validator.dart';
8
import 'android/android_workflow.dart';
9
import 'artifacts.dart';
10
import 'base/async_guard.dart';
11
import 'base/common.dart';
12
import 'base/context.dart';
13
import 'base/file_system.dart';
14
import 'base/logger.dart';
15
import 'base/os.dart';
16
import 'base/platform.dart';
17
import 'base/process_manager.dart';
18
import 'base/terminal.dart';
19
import 'base/user_messages.dart';
20
import 'base/utils.dart';
21
import 'base/version.dart';
22
import 'cache.dart';
23
import 'device.dart';
24
import 'fuchsia/fuchsia_workflow.dart';
25
import 'globals.dart';
26
import 'intellij/intellij.dart';
27
import 'ios/ios_workflow.dart';
28
import 'ios/plist_parser.dart';
29
import 'linux/linux_doctor.dart';
30
import 'linux/linux_workflow.dart';
31
import 'macos/cocoapods_validator.dart';
32
import 'macos/macos_workflow.dart';
33
import 'macos/xcode_validator.dart';
34
import 'proxy_validator.dart';
35
import 'reporting/reporting.dart';
36
import 'tester/flutter_tester.dart';
37
import 'version.dart';
38
import 'vscode/vscode_validator.dart';
39 40
import 'web/web_validator.dart';
import 'web/workflow.dart';
41
import 'windows/visual_studio_validator.dart';
42
import 'windows/windows_workflow.dart';
Devon Carew's avatar
Devon Carew committed
43

44
Doctor get doctor => context.get<Doctor>();
45

46 47
abstract class DoctorValidatorsProvider {
  /// The singleton instance, pulled from the [AppContext].
48
  static DoctorValidatorsProvider get instance => context.get<DoctorValidatorsProvider>();
49

50
  static final DoctorValidatorsProvider defaultInstance = _DefaultDoctorValidatorsProvider();
51 52

  List<DoctorValidator> get validators;
53
  List<Workflow> get workflows;
54 55
}

56
class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
57
  List<DoctorValidator> _validators;
58
  List<Workflow> _workflows;
59

60
  @override
61
  List<DoctorValidator> get validators {
62 63
    if (_validators != null) {
      return _validators;
64
    }
65 66 67 68 69 70 71 72 73 74

    final List<DoctorValidator> ideValidators = <DoctorValidator>[
      ...AndroidStudioValidator.allValidators,
      ...IntelliJValidator.installedValidators,
      ...VsCodeValidator.installedValidators,
    ];

    _validators = <DoctorValidator>[
      FlutterValidator(),
      if (androidWorkflow.appliesToHostPlatform)
75
        GroupedValidator(<DoctorValidator>[androidValidator, androidLicenseValidator]),
76
      if (iosWorkflow.appliesToHostPlatform || macOSWorkflow.appliesToHostPlatform)
77
        GroupedValidator(<DoctorValidator>[xcodeValidator, cocoapodsValidator]),
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
      if (webWorkflow.appliesToHostPlatform)
        const WebValidator(),
      if (linuxWorkflow.appliesToHostPlatform)
        LinuxDoctorValidator(),
      if (windowsWorkflow.appliesToHostPlatform)
        visualStudioValidator,
      if (ideValidators.isNotEmpty)
        ...ideValidators
      else
        NoIdeValidator(),
      if (ProxyValidator.shouldShow)
        ProxyValidator(),
      if (deviceManager.canListAnything)
        DeviceValidator(),
    ];
93 94
    return _validators;
  }
95 96 97

  @override
  List<Workflow> get workflows {
98 99 100 101 102 103 104 105
    if (_workflows == null) {
      _workflows = <Workflow>[];

      if (iosWorkflow.appliesToHostPlatform)
        _workflows.add(iosWorkflow);

      if (androidWorkflow.appliesToHostPlatform)
        _workflows.add(androidWorkflow);
106 107 108

      if (fuchsiaWorkflow.appliesToHostPlatform)
        _workflows.add(fuchsiaWorkflow);
109 110 111 112 113 114 115 116 117 118

      if (linuxWorkflow.appliesToHostPlatform)
        _workflows.add(linuxWorkflow);

      if (macOSWorkflow.appliesToHostPlatform)
        _workflows.add(macOSWorkflow);

      if (windowsWorkflow.appliesToHostPlatform)
        _workflows.add(windowsWorkflow);

119 120 121
      if (webWorkflow.appliesToHostPlatform)
        _workflows.add(webWorkflow);

122
    }
123 124 125
    return _workflows;
  }

126 127 128 129 130 131 132 133 134 135 136 137 138 139
}

class ValidatorTask {
  ValidatorTask(this.validator, this.result);
  final DoctorValidator validator;
  final Future<ValidationResult> result;
}

class Doctor {
  const Doctor();

  List<DoctorValidator> get validators {
    return DoctorValidatorsProvider.instance.validators;
  }
140

141 142 143 144 145
  /// Return a list of [ValidatorTask] objects and starts validation on all
  /// objects in [validators].
  List<ValidatorTask> startValidatorTasks() {
    final List<ValidatorTask> tasks = <ValidatorTask>[];
    for (DoctorValidator validator in validators) {
146 147 148
      final Future<ValidationResult> result =
          asyncGuard<ValidationResult>(() => validator.validate());
      tasks.add(ValidatorTask(validator, result));
149 150 151 152
    }
    return tasks;
  }

153
  List<Workflow> get workflows {
154
    return DoctorValidatorsProvider.instance.workflows;
155
  }
156

157
  /// Print a summary of the state of the tooling, as well as how to get more info.
158
  Future<void> summary() async {
159
    printStatus(await _summaryText());
160
  }
161

162
  Future<String> _summaryText() async {
163
    final StringBuffer buffer = StringBuffer();
164

165 166
    bool missingComponent = false;
    bool sawACrash = false;
167

168
    for (DoctorValidator validator in validators) {
169
      final StringBuffer lineBuffer = StringBuffer();
170 171 172 173 174 175 176 177
      ValidationResult result;
      try {
        result = await asyncGuard<ValidationResult>(() => validator.validate());
      } catch (exception) {
        // We're generating a summary, so drop the stack trace.
        result = ValidationResult.crash(exception);
      }
      lineBuffer.write('${result.coloredLeadingBox} ${validator.title}: ');
178
      switch (result.type) {
179 180 181 182
        case ValidationType.crash:
          lineBuffer.write('the doctor check crashed without a result.');
          sawACrash = true;
          break;
183
        case ValidationType.missing:
184
          lineBuffer.write('is not installed.');
185 186
          break;
        case ValidationType.partial:
187
          lineBuffer.write('is partially installed; more components are available.');
188 189
          break;
        case ValidationType.notAvailable:
190
          lineBuffer.write('is not available.');
191 192
          break;
        case ValidationType.installed:
193
          lineBuffer.write('is fully installed.');
194 195
          break;
      }
196

197
      if (result.statusInfo != null) {
198
        lineBuffer.write(' (${result.statusInfo})');
199
      }
200

201
      buffer.write(wrapText(lineBuffer.toString(), hangingIndent: result.leadingBox.length + 1));
202 203
      buffer.writeln();

204 205 206 207 208 209 210 211
      if (result.type != ValidationType.installed) {
        missingComponent = true;
      }
    }

    if (sawACrash) {
      buffer.writeln();
      buffer.writeln('Run "flutter doctor" for information about why a doctor check crashed.');
212 213
    }

214
    if (missingComponent) {
215
      buffer.writeln();
Devon Carew's avatar
Devon Carew committed
216
      buffer.writeln('Run "flutter doctor" for information about installing additional components.');
217 218 219 220 221
    }

    return buffer.toString();
  }

222
  Future<bool> checkRemoteArtifacts(String engineRevision) async {
223
    return Cache.instance.areRemoteArtifactsAvailable(engineVersion: engineRevision);
224 225
  }

226
  /// Print information about the state of installed tooling.
227
  Future<bool> diagnose({ bool androidLicenses = false, bool verbose = true }) async {
228
    if (androidLicenses)
229
      return AndroidLicenseValidator.runLicenseManager();
230

231 232 233
    if (!verbose) {
      printStatus('Doctor summary (to see all details, run flutter doctor -v):');
    }
234
    bool doctorResult = true;
235
    int issues = 0;
236

237
    for (ValidatorTask validatorTask in startValidatorTasks()) {
238
      final DoctorValidator validator = validatorTask.validator;
239
      final Status status = Status.withSpinner(
240
        timeout: timeoutConfiguration.fastOperation,
241 242
        slowWarningCallback: () => validator.slowWarning,
      );
243
      ValidationResult result;
244 245
      try {
        result = await validatorTask.result;
246
      } catch (exception, stackTrace) {
247
        result = ValidationResult.crash(exception, stackTrace);
248 249
      } finally {
        status.stop();
250
      }
251

252
      switch (result.type) {
253 254 255 256
        case ValidationType.crash:
          doctorResult = false;
          issues += 1;
          break;
257 258 259 260 261 262 263 264 265 266
        case ValidationType.missing:
          doctorResult = false;
          issues += 1;
          break;
        case ValidationType.partial:
        case ValidationType.notAvailable:
          issues += 1;
          break;
        case ValidationType.installed:
          break;
267
      }
268

269
      DoctorResultEvent(validator: validator, result: result).send();
270

271 272 273 274 275 276 277
      if (result.statusInfo != null) {
        printStatus('${result.coloredLeadingBox} ${validator.title} (${result.statusInfo})',
            hangingIndent: result.leadingBox.length + 1);
      } else {
        printStatus('${result.coloredLeadingBox} ${validator.title}',
            hangingIndent: result.leadingBox.length + 1);
      }
278 279

      for (ValidationMessage message in result.messages) {
280 281 282 283 284 285 286 287
        if (message.type != ValidationMessageType.information || verbose == true) {
          int hangingIndent = 2;
          int indent = 4;
          for (String line in '${message.coloredIndicator} ${message.message}'.split('\n')) {
            printStatus(line, hangingIndent: hangingIndent, indent: indent, emphasis: true);
            // Only do hanging indent for the first line.
            hangingIndent = 0;
            indent = 6;
288
          }
289 290
        }
      }
291
      if (verbose) {
292
        printStatus('');
293
      }
294
    }
295

296
    // Make sure there's always one line before the summary even when not verbose.
297
    if (!verbose) {
298
      printStatus('');
299
    }
300

301
    if (issues > 0) {
302
      printStatus('${terminal.color('!', TerminalColor.yellow)} Doctor found issues in $issues categor${issues > 1 ? "ies" : "y"}.', hangingIndent: 2);
303
    } else {
304
      printStatus('${terminal.color('•', TerminalColor.green)} No issues found!', hangingIndent: 2);
305
    }
306 307

    return doctorResult;
308 309 310 311
  }

  bool get canListAnything => workflows.any((Workflow workflow) => workflow.canListDevices);

312 313 314 315 316
  bool get canLaunchAnything {
    if (FlutterTesterDevices.showFlutterTesterDevice)
      return true;
    return workflows.any((Workflow workflow) => workflow.canLaunchDevices);
  }
317 318
}

Devon Carew's avatar
Devon Carew committed
319
/// A series of tools and required install steps for a target platform (iOS or Android).
320
abstract class Workflow {
321 322
  const Workflow();

323 324 325 326 327 328 329 330
  /// 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;
331 332 333

  /// Are we functional enough to list emulators?
  bool get canListEmulators;
334 335 336
}

enum ValidationType {
337
  crash,
338 339
  missing,
  partial,
340 341
  notAvailable,
  installed,
342 343
}

344 345 346 347 348 349
enum ValidationMessageType {
  error,
  hint,
  information,
}

350
abstract class DoctorValidator {
351
  const DoctorValidator(this.title);
352

353
  /// This is displayed in the CLI.
354
  final String title;
355

356 357
  String get slowWarning => 'This is taking an unexpectedly long time...';

358
  Future<ValidationResult> validate();
359 360
}

361 362 363 364 365
/// A validator that runs other [DoctorValidator]s and combines their output
/// into a single [ValidationResult]. It uses the title of the first validator
/// passed to the constructor and reports the statusInfo of the first validator
/// that provides one. Other titles and statusInfo strings are discarded.
class GroupedValidator extends DoctorValidator {
366
  GroupedValidator(this.subValidators) : super(subValidators[0].title);
367 368 369

  final List<DoctorValidator> subValidators;

370 371 372 373 374 375 376 377 378
  List<ValidationResult> _subResults;

  /// Subvalidator results.
  ///
  /// To avoid losing information when results are merged, the subresults are
  /// cached on this field when they are available. The results are in the same
  /// order as the subvalidator list.
  List<ValidationResult> get subResults => _subResults;

379 380 381 382
  @override
  String get slowWarning => _currentSlowWarning;
  String _currentSlowWarning = 'Initializing...';

383
  @override
384
  Future<ValidationResult> validate() async {
385 386
    final List<ValidatorTask> tasks = <ValidatorTask>[];
    for (DoctorValidator validator in subValidators) {
387 388 389
      final Future<ValidationResult> result =
          asyncGuard<ValidationResult>(() => validator.validate());
      tasks.add(ValidatorTask(validator, result));
390 391 392 393
    }

    final List<ValidationResult> results = <ValidationResult>[];
    for (ValidatorTask subValidator in tasks) {
394
      _currentSlowWarning = subValidator.validator.slowWarning;
395 396 397
      try {
        results.add(await subValidator.result);
      } catch (exception, stackTrace) {
398
        results.add(ValidationResult.crash(exception, stackTrace));
399
      }
400
    }
401
    _currentSlowWarning = 'Merging results...';
402 403 404 405 406
    return _mergeValidationResults(results);
  }

  ValidationResult _mergeValidationResults(List<ValidationResult> results) {
    assert(results.isNotEmpty, 'Validation results should not be empty');
407
    _subResults = results;
408 409 410 411 412 413 414 415 416 417 418 419
    ValidationType mergedType = results[0].type;
    final List<ValidationMessage> mergedMessages = <ValidationMessage>[];
    String statusInfo;

    for (ValidationResult result in results) {
      statusInfo ??= result.statusInfo;
      switch (result.type) {
        case ValidationType.installed:
          if (mergedType == ValidationType.missing) {
            mergedType = ValidationType.partial;
          }
          break;
420
        case ValidationType.notAvailable:
421 422 423
        case ValidationType.partial:
          mergedType = ValidationType.partial;
          break;
424
        case ValidationType.crash:
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
        case ValidationType.missing:
          if (mergedType == ValidationType.installed) {
            mergedType = ValidationType.partial;
          }
          break;
        default:
          throw 'Unrecognized validation type: ' + result.type.toString();
      }
      mergedMessages.addAll(result.messages);
    }

    return ValidationResult(mergedType, mergedMessages,
        statusInfo: statusInfo);
  }
}
440

441
class ValidationResult {
442 443
  /// [ValidationResult.type] should only equal [ValidationResult.installed]
  /// if no [messages] are hints or errors.
444
  ValidationResult(this.type, this.messages, { this.statusInfo });
445

446
  factory ValidationResult.crash(Object error, [StackTrace stackTrace]) {
447 448 449 450 451
    return ValidationResult(ValidationType.crash, <ValidationMessage>[
      ValidationMessage.error(
          'Due to an error, the doctor check did not complete. '
          'If the error message below is not helpful, '
          'please let us know about this issue at https://github.com/flutter/flutter/issues.'),
452
      ValidationMessage.error('$error'),
453
      if (stackTrace != null)
454 455
          // Stacktrace is informational. Printed in verbose mode only.
          ValidationMessage('$stackTrace'),
456 457 458
    ], statusInfo: 'the doctor check crashed');
  }

459
  final ValidationType type;
460 461 462
  // A short message about the status.
  final String statusInfo;
  final List<ValidationMessage> messages;
463

464
  String get leadingBox {
465 466
    assert(type != null);
    switch (type) {
467 468
      case ValidationType.crash:
        return '[☠]';
469 470 471 472
      case ValidationType.missing:
        return '[✗]';
      case ValidationType.installed:
        return '[✓]';
473
      case ValidationType.notAvailable:
474 475 476 477
      case ValidationType.partial:
        return '[!]';
    }
    return null;
478
  }
479 480 481 482

  String get coloredLeadingBox {
    assert(type != null);
    switch (type) {
483 484
      case ValidationType.crash:
        return terminal.color(leadingBox, TerminalColor.red);
485 486 487 488 489 490 491 492 493 494
      case ValidationType.missing:
        return terminal.color(leadingBox, TerminalColor.red);
      case ValidationType.installed:
        return terminal.color(leadingBox, TerminalColor.green);
      case ValidationType.notAvailable:
      case ValidationType.partial:
       return terminal.color(leadingBox, TerminalColor.yellow);
    }
    return null;
  }
495 496 497 498 499

  /// The string representation of the type.
  String get typeStr {
    assert(type != null);
    switch (type) {
500 501
      case ValidationType.crash:
        return 'crash';
502 503 504 505 506 507 508 509 510 511 512
      case ValidationType.missing:
        return 'missing';
      case ValidationType.installed:
        return 'installed';
      case ValidationType.notAvailable:
        return 'notAvailable';
      case ValidationType.partial:
        return 'partial';
    }
    return null;
  }
513
}
514

515
class ValidationMessage {
516 517 518
  ValidationMessage(this.message) : type = ValidationMessageType.information;
  ValidationMessage.error(this.message) : type = ValidationMessageType.error;
  ValidationMessage.hint(this.message) : type = ValidationMessageType.hint;
519

520 521 522
  final ValidationMessageType type;
  bool get isError => type == ValidationMessageType.error;
  bool get isHint => type == ValidationMessageType.hint;
523
  final String message;
524

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
  String get indicator {
    switch (type) {
      case ValidationMessageType.error:
        return '✗';
      case ValidationMessageType.hint:
        return '!';
      case ValidationMessageType.information:
        return '•';
    }
    return null;
  }

  String get coloredIndicator {
    switch (type) {
      case ValidationMessageType.error:
        return terminal.color(indicator, TerminalColor.red);
      case ValidationMessageType.hint:
        return terminal.color(indicator, TerminalColor.yellow);
      case ValidationMessageType.information:
        return terminal.color(indicator, TerminalColor.green);
    }
    return null;
  }

549 550
  @override
  String toString() => message;
551 552 553 554 555 556 557 558 559 560 561 562 563

  @override
  bool operator ==(Object other) {
    if (other.runtimeType != runtimeType) {
      return false;
    }
    final ValidationMessage typedOther = other;
    return typedOther.message == message
      && typedOther.type == type;
  }

  @override
  int get hashCode => type.hashCode ^ message.hashCode;
564
}
565

566 567
class FlutterValidator extends DoctorValidator {
  FlutterValidator() : super('Flutter');
568

569
  @override
570
  Future<ValidationResult> validate() async {
571
    final List<ValidationMessage> messages = <ValidationMessage>[];
572
    ValidationType valid = ValidationType.installed;
573

574
    final FlutterVersion version = FlutterVersion.instance;
575

576 577 578 579
    messages.add(ValidationMessage(userMessages.flutterVersion(version.frameworkVersion, Cache.flutterRoot)));
    messages.add(ValidationMessage(userMessages.flutterRevision(version.frameworkRevisionShort, version.frameworkAge, version.frameworkDate)));
    messages.add(ValidationMessage(userMessages.engineRevision(version.engineRevisionShort)));
    messages.add(ValidationMessage(userMessages.dartRevision(version.dartSdkVersion)));
580 581 582 583 584
    final String genSnapshotPath =
      artifacts.getArtifactPath(Artifact.genSnapshot);

    // Check that the binaries we downloaded for this platform actually run on it.
    if (!_genSnapshotRuns(genSnapshotPath)) {
585
      final StringBuffer buf = StringBuffer();
586
      buf.writeln(userMessages.flutterBinariesDoNotRun);
587
      if (platform.isLinux) {
588
        buf.writeln(userMessages.flutterBinariesLinuxRepairCommands);
589
      }
590
      messages.add(ValidationMessage.error(buf.toString()));
591
      valid = ValidationType.partial;
592
    }
593

594
    return ValidationResult(valid, messages,
595
      statusInfo: userMessages.flutterStatusInfo(version.channel, version.frameworkVersion, os.name, platform.localeName),
596
    );
597
  }
598
}
Devon Carew's avatar
Devon Carew committed
599

600
bool _genSnapshotRuns(String genSnapshotPath) {
601
  const int kExpectedExitCode = 255;
602 603 604 605
  try {
    return processManager.runSync(<String>[genSnapshotPath]).exitCode == kExpectedExitCode;
  } catch (error) {
    return false;
606 607 608
  }
}

609
class NoIdeValidator extends DoctorValidator {
610
  NoIdeValidator() : super('Flutter IDE Support');
611 612 613

  @override
  Future<ValidationResult> validate() async {
614
    return ValidationResult(ValidationType.missing, <ValidationMessage>[
615 616
      ValidationMessage(userMessages.noIdeInstallationInfo),
    ], statusInfo: userMessages.noIdeStatusInfo);
617 618 619
  }
}

620
abstract class IntelliJValidator extends DoctorValidator {
621
  IntelliJValidator(String title, this.installPath) : super(title);
622

623 624
  final String installPath;

625 626
  String get version;
  String get pluginsPath;
627

628
  static final Map<String, String> _idToTitle = <String, String>{
629 630
    'IntelliJIdea': 'IntelliJ IDEA Ultimate Edition',
    'IdeaIC': 'IntelliJ IDEA Community Edition',
631
  };
632

633
  static final Version kMinIdeaVersion = Version(2017, 1, 0);
634

635
  static Iterable<DoctorValidator> get installedValidators {
636
    if (platform.isLinux || platform.isWindows)
637
      return IntelliJValidatorOnLinuxAndWindows.installed;
638
    if (platform.isMacOS)
639 640
      return IntelliJValidatorOnMac.installed;
    return <DoctorValidator>[];
641 642 643 644
  }

  @override
  Future<ValidationResult> validate() async {
645
    final List<ValidationMessage> messages = <ValidationMessage>[];
646

647
    messages.add(ValidationMessage(userMessages.intellijLocation(installPath)));
648

649
    final IntelliJPlugins plugins = IntelliJPlugins(pluginsPath);
650 651 652
    plugins.validatePackage(messages, <String>['flutter-intellij', 'flutter-intellij.jar'],
        'Flutter', minVersion: IntelliJPlugins.kMinFlutterPluginVersion);
    plugins.validatePackage(messages, <String>['Dart'], 'Dart');
653

654
    if (_hasIssues(messages)) {
655
      messages.add(ValidationMessage(userMessages.intellijPluginInfo));
656 657
    }

658
    _validateIntelliJVersion(messages, kMinIdeaVersion);
659

660
    return ValidationResult(
661 662
      _hasIssues(messages) ? ValidationType.partial : ValidationType.installed,
      messages,
663
      statusInfo: userMessages.intellijStatusInfo(version));
664 665
  }

666 667 668 669 670 671 672 673 674
  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;

675
    final Version installedVersion = Version.parse(version);
676 677 678 679
    if (installedVersion == null)
      return;

    if (installedVersion < minVersion) {
680
      messages.add(ValidationMessage.error(userMessages.intellijMinimumVersion(minVersion.toString())));
681 682
    }
  }
683 684
}

685
class IntelliJValidatorOnLinuxAndWindows extends IntelliJValidator {
686
  IntelliJValidatorOnLinuxAndWindows(String title, this.version, String installPath, this.pluginsPath) : super(title, installPath);
687 688

  @override
689
  final String version;
690 691

  @override
692
  final String pluginsPath;
693 694

  static Iterable<DoctorValidator> get installed {
695
    final List<DoctorValidator> validators = <DoctorValidator>[];
696 697
    if (homeDirPath == null)
      return validators;
698 699

    void addValidator(String title, String version, String installPath, String pluginsPath) {
700
      final IntelliJValidatorOnLinuxAndWindows validator =
701
        IntelliJValidatorOnLinuxAndWindows(title, version, installPath, pluginsPath);
702
      for (int index = 0; index < validators.length; ++index) {
703
        final DoctorValidator other = validators[index];
704
        if (other is IntelliJValidatorOnLinuxAndWindows && validator.installPath == other.installPath) {
705 706 707 708 709 710 711 712
          if (validator.version.compareTo(other.version) > 0)
            validators[index] = validator;
          return;
        }
      }
      validators.add(validator);
    }

713
    for (FileSystemEntity dir in fs.directory(homeDirPath).listSync()) {
714
      if (dir is Directory) {
715
        final String name = fs.path.basename(dir.path);
716 717
        IntelliJValidator._idToTitle.forEach((String id, String title) {
          if (name.startsWith('.$id')) {
718
            final String version = name.substring(id.length + 1);
719 720
            String installPath;
            try {
721
              installPath = fs.file(fs.path.join(dir.path, 'system', '.home')).readAsStringSync();
722 723 724
            } catch (e) {
              // ignored
            }
725
            if (installPath != null && fs.isDirectorySync(installPath)) {
726
              final String pluginsPath = fs.path.join(dir.path, 'config', 'plugins');
727
              addValidator(title, version, installPath, pluginsPath);
728 729 730 731 732 733 734 735 736 737
            }
          }
        });
      }
    }
    return validators;
  }
}

class IntelliJValidatorOnMac extends IntelliJValidator {
738
  IntelliJValidatorOnMac(String title, this.id, String installPath) : super(title, installPath);
739 740 741 742

  final String id;

  static final Map<String, String> _dirNameToId = <String, String>{
743 744 745
    'IntelliJ IDEA.app': 'IntelliJIdea',
    'IntelliJ IDEA Ultimate.app': 'IntelliJIdea',
    'IntelliJ IDEA CE.app': 'IdeaIC',
746 747 748
  };

  static Iterable<DoctorValidator> get installed {
749 750
    final List<DoctorValidator> validators = <DoctorValidator>[];
    final List<String> installPaths = <String>['/Applications', fs.path.join(homeDirPath, 'Applications')];
751 752

    void checkForIntelliJ(Directory dir) {
753
      final String name = fs.path.basename(dir.path);
754 755
      _dirNameToId.forEach((String dirName, String id) {
        if (name == dirName) {
756
          final String title = IntelliJValidator._idToTitle[id];
757
          validators.add(IntelliJValidatorOnMac(title, id, dir.path));
758 759 760 761
        }
      });
    }

762
    try {
763
      final Iterable<Directory> installDirs = installPaths
764 765 766
              .map<Directory>((String installPath) => fs.directory(installPath))
              .map<List<FileSystemEntity>>((Directory dir) => dir.existsSync() ? dir.listSync() : <FileSystemEntity>[])
              .expand<FileSystemEntity>((List<FileSystemEntity> mappedDirs) => mappedDirs)
767 768 769 770 771 772 773
              .whereType<Directory>();
      for (Directory dir in installDirs) {
        checkForIntelliJ(dir);
        if (!dir.path.endsWith('.app')) {
          for (FileSystemEntity subdir in dir.listSync()) {
            if (subdir is Directory) {
              checkForIntelliJ(subdir);
774
            }
775
          }
776
        }
777
      }
778
    } on FileSystemException catch (e) {
779
      validators.add(ValidatorWithResult(
780
          userMessages.intellijMacUnknownResult,
781 782
          ValidationResult(ValidationType.missing, <ValidationMessage>[
              ValidationMessage.error(e.message),
783 784
          ]),
      ));
785 786 787 788 789 790 791
    }
    return validators;
  }

  @override
  String get version {
    if (_version == null) {
792
      final String plistFile = fs.path.join(installPath, 'Contents', 'Info.plist');
793
      _version = PlistParser.instance.getValueFromFile(
794
        plistFile,
795
        PlistParser.kCFBundleShortVersionStringKey,
796
      ) ?? 'unknown';
797 798 799 800 801 802 803
    }
    return _version;
  }
  String _version;

  @override
  String get pluginsPath {
804 805 806
    final List<String> split = version.split('.');
    final String major = split[0];
    final String minor = split[1];
807
    return fs.path.join(homeDirPath, 'Library', 'Application Support', '$id$major.$minor');
808 809 810
  }
}

811
class DeviceValidator extends DoctorValidator {
812
  DeviceValidator() : super('Connected device');
813

814 815 816
  @override
  String get slowWarning => 'Scanning for devices is taking a long time...';

817 818
  @override
  Future<ValidationResult> validate() async {
819
    final List<Device> devices = await deviceManager.getAllConnectedDevices().toList();
820 821
    List<ValidationMessage> messages;
    if (devices.isEmpty) {
822 823
      final List<String> diagnostics = await deviceManager.getDeviceDiagnostics();
      if (diagnostics.isNotEmpty) {
824
        messages = diagnostics.map<ValidationMessage>((String message) => ValidationMessage(message)).toList();
825
      } else {
826
        messages = <ValidationMessage>[ValidationMessage.hint(userMessages.devicesMissing)];
827
      }
828
    } else {
829
      messages = await Device.descriptions(devices)
830
          .map<ValidationMessage>((String msg) => ValidationMessage(msg)).toList();
831
    }
832 833

    if (devices.isEmpty) {
834
      return ValidationResult(ValidationType.notAvailable, messages);
835
    } else {
836
      return ValidationResult(ValidationType.installed, messages, statusInfo: userMessages.devicesAvailable(devices.length));
837
    }
838 839
  }
}
840 841 842 843

class ValidatorWithResult extends DoctorValidator {
  ValidatorWithResult(String title, this.result) : super(title);

844 845
  final ValidationResult result;

846 847 848
  @override
  Future<ValidationResult> validate() async => result;
}