BinaryDownloader

class BinaryDownloader

Downloads and extracts binary files.

Constructors

BinaryDownloader()

BinaryDownloader({
  dynamic client,
  RetryHelper? retryHelper,
  ChecksumValidator? checksumValidator,
})

Implementation

dart

BinaryDownloader({
  http.Client? client,
  RetryHelper? retryHelper,
  ChecksumValidator? checksumValidator,
})  : _client = client,
      retryHelper = retryHelper ?? RetryHelper(),
      checksumValidator =
          checksumValidator ?? ChecksumValidator(client: client);

Properties

checksumValidator final

final ChecksumValidator checksumValidator

Implementation

dart

final ChecksumValidator checksumValidator;

client no setter

dynamic get client

Implementation

dart

http.Client get client => _client ?? http.Client();

hashCode no setter inherited

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

dart

external int get hashCode;

retryHelper final

final RetryHelper retryHelper

Implementation

dart

final RetryHelper retryHelper;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

dart

external Type get runtimeType;

Methods

downloadAndExtract()

Future<String> downloadAndExtract(
  String url,
  String cacheDir, {
  String? expectedBinaryName,
  (void Function(int received, int total))? onProgress,
  (void Function(int attempt, Exception error))? onRetry,
  (void Function(bool validated, String? checksum))? onChecksum,
  List<String>? availableAssetUrls,
  bool skipChecksumValidation = false,
  Duration timeout = const Duration(minutes: 5),
})

Downloads and extracts a binary in one operation.

Implementation

dart

Future<String> downloadAndExtract(
  String url,
  String cacheDir, {
  String? expectedBinaryName,
  ProgressCallback? onProgress,
  RetryCallback? onRetry,
  ChecksumCallback? onChecksum,
  List<String>? availableAssetUrls,
  bool skipChecksumValidation = false,
  Duration timeout = const Duration(minutes: 5),
}) async {
  _logger.info('Starting download and extract from: $url');

  final archiveName = p.basename(Uri.parse(url).path);
  final archivePath = p.join(cacheDir, archiveName);

  &#47;&#47; Download
  _logger.debug('Downloading to: $archivePath');
  await downloadFile(
    url,
    archivePath,
    onProgress: onProgress,
    onRetry: onRetry,
    timeout: timeout,
  );

  &#47;&#47; Validate checksum if not skipped
  if (!skipChecksumValidation && availableAssetUrls != null) {
    _logger.debug('Validating checksum...');
    try {
      final validated = await checksumValidator.tryValidateFromGitHubAssets(
        archivePath,
        url,
        availableAssetUrls,
      );

      if (validated) {
        _logger.info('Checksum validation: PASSED');
      } else {
        _logger
            .warning('Checksum validation: SKIPPED (no .sha256 file found)');
      }

      if (onChecksum != null) {
        &#47;&#47; Get actual checksum for callback
        String? checksum;
        if (validated) {
          checksum = await checksumValidator.computeFileChecksum(archivePath);
        }
        onChecksum(validated, checksum);
      }
    } on ChecksumValidationException {
      &#47;&#47; Clean up downloaded file on checksum failure
      _logger.error('Checksum validation exception - cleaning up');
      await File(archivePath).delete();
      rethrow;
    }
  } else {
    _logger.warning('Checksum validation SKIPPED by user request');
  }

  &#47;&#47; Extract
  final binaryPath = await extractArchive(
    archivePath,
    cacheDir,
    expectedBinaryName: expectedBinaryName,
  );

  &#47;&#47; Clean up archive
  _logger.debug('Cleaning up archive file');
  await File(archivePath).delete();

  _logger.info('Download and extract complete');
  return binaryPath;
}

downloadFile()

Future<void> downloadFile(
  String url,
  String destinationPath, {
  (void Function(int received, int total))? onProgress,
  (void Function(int attempt, Exception error))? onRetry,
  Duration timeout = const Duration(minutes: 5),
})

Downloads a file from url to destinationPath with optional progress tracking.

Implementation

dart

Future<void> downloadFile(
  String url,
  String destinationPath, {
  ProgressCallback? onProgress,
  RetryCallback? onRetry,
  Duration timeout = const Duration(minutes: 5),
}) async {
  &#47;&#47; Wrap download in retry logic
  await retryHelper.executeNetworkOperation(
    () => _downloadFileInternal(
      url,
      destinationPath,
      onProgress: onProgress,
      timeout: timeout,
    ),
    onRetry: onRetry,
  );
}

extractArchive()

Future<String> extractArchive(
  String archivePath,
  String destinationDir, {
  String? expectedBinaryName,
})

Extracts an archive file (tar.gz or zip) to a destination directory.

Implementation

dart

Future<String> extractArchive(
  String archivePath,
  String destinationDir, {
  String? expectedBinaryName,
}) async {
  _logger.debug('Extracting archive: $archivePath');
  _logger.debug('Destination dir: $destinationDir');

  final file = File(archivePath);
  if (!await file.exists()) {
    _logger.error('Archive file not found: $archivePath');
    throw DownloadException('Archive file not found: $archivePath');
  }

  final bytes = await file.readAsBytes();
  _logger.debug('Archive size: ${_formatBytes(bytes.length)}');

  final archive = _decodeArchive(archivePath, bytes);
  _logger.info('Extracting ${archive.length} files from archive');

  await Directory(destinationDir).create(recursive: true);

  String? binaryPath;

  for (final file in archive) {
    if (file.isFile) {
      final filename = file.name;
      final outputPath = p.join(destinationDir, filename);

      final outputFile = File(outputPath);
      await outputFile.create(recursive: true);
      await outputFile.writeAsBytes(file.content as List<int>);

      &#47;&#47; Make executable on Unix-like systems
      if (!Platform.isWindows &&
          (expectedBinaryName == null || filename == expectedBinaryName)) {
        await Process.run('chmod', ['+x', outputPath]);
        binaryPath = outputPath;
      } else if (Platform.isWindows &&
          (filename.endsWith('.exe') ||
              (expectedBinaryName != null &&
                  filename == expectedBinaryName))) {
        binaryPath = outputPath;
      }
    }
  }

  if (binaryPath == null) {
    _logger
        .error('Binary not found in archive. Expected: $expectedBinaryName');
    throw DownloadException(
      'Binary not found in archive. Expected: $expectedBinaryName',
    );
  }

  _logger.info('Extraction complete. Binary: $binaryPath');
  return binaryPath;
}

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

dart

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

dart

external String toString();

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects o, o == o must be true.
Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.
Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

dart

external bool operator ==(Object other);

BinaryDownloader ​

Constructors ​