| // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
| // for details. All rights reserved. Use of this source code is governed by a |
| // BSD-style license that can be found in the LICENSE file. |
| |
| library pub.entrypoint; |
| |
| import 'dart:async'; |
| |
| import 'package:path/path.dart' as path; |
| |
| import 'io.dart'; |
| import 'lock_file.dart'; |
| import 'log.dart' as log; |
| import 'package.dart'; |
| import 'package_graph.dart'; |
| import 'solver/version_solver.dart'; |
| import 'source/cached.dart'; |
| import 'system_cache.dart'; |
| import 'utils.dart'; |
| |
| /// The context surrounding the root package pub is operating on. |
| /// |
| /// Pub operates over a directed graph of dependencies that starts at a root |
| /// "entrypoint" package. This is typically the package where the current |
| /// working directory is located. An entrypoint knows the [root] package it is |
| /// associated with and is responsible for managing the "packages" directory |
| /// for it. |
| /// |
| /// That directory contains symlinks to all packages used by an app. These links |
| /// point either to the [SystemCache] or to some other location on the local |
| /// filesystem. |
| /// |
| /// While entrypoints are typically applications, a pure library package may end |
| /// up being used as an entrypoint. Also, a single package may be used as an |
| /// entrypoint in one context but not in another. For example, a package that |
| /// contains a reusable library may not be the entrypoint when used by an app, |
| /// but may be the entrypoint when you're running its tests. |
| class Entrypoint { |
| /// The root package this entrypoint is associated with. |
| final Package root; |
| |
| /// The system-wide cache which caches packages that need to be fetched over |
| /// the network. |
| final SystemCache cache; |
| |
| /// Loads the entrypoint from a package at [rootDir]. |
| Entrypoint(String rootDir, SystemCache cache) |
| : root = new Package.load(null, rootDir, cache.sources), |
| cache = cache; |
| |
| // TODO(rnystrom): Make this path configurable. |
| /// The path to the entrypoint's "packages" directory. |
| String get packagesDir => path.join(root.dir, 'packages'); |
| |
| /// `true` if the entrypoint package currently has a lock file. |
| bool get lockFileExists => entryExists(lockFilePath); |
| |
| /// The path to the entrypoint package's lockfile. |
| String get lockFilePath => path.join(root.dir, 'pubspec.lock'); |
| |
| /// Gets all dependencies of the [root] package. |
| /// |
| /// [useLatest], if provided, defines a list of packages that will be |
| /// unlocked and forced to their latest versions. If [upgradeAll] is |
| /// true, the previous lockfile is ignored and all packages are re-resolved |
| /// from scratch. Otherwise, it will attempt to preserve the versions of all |
| /// previously locked packages. |
| /// |
| /// Shows a report of the changes made relative to the previous lockfile. If |
| /// [isUpgrade] is `true`, all transitive dependencies are shown in the |
| /// report. Otherwise, only dependencies that were changed are shown. If |
| /// [dryRun] is `true`, no physical changes are made. |
| Future acquireDependencies({List<String> useLatest, bool isUpgrade: false, |
| bool dryRun: false}) { |
| return syncFuture(() { |
| return resolveVersions(cache.sources, root, lockFile: loadLockFile(), |
| useLatest: useLatest, upgradeAll: isUpgrade && useLatest.isEmpty); |
| }).then((result) { |
| if (!result.succeeded) throw result.error; |
| |
| result.showReport(isUpgrade: isUpgrade); |
| |
| if (dryRun) { |
| result.summarizeChanges(isUpgrade: isUpgrade, dryRun: dryRun); |
| return null; |
| } |
| |
| // Install the packages. |
| cleanDir(packagesDir); |
| return Future.wait(result.packages.map(_get)).then((ids) { |
| _saveLockFile(ids); |
| _linkSelf(); |
| _linkSecondaryPackageDirs(); |
| result.summarizeChanges(isUpgrade: isUpgrade, dryRun: dryRun); |
| }); |
| }); |
| } |
| |
| /// Makes sure the package at [id] is locally available. |
| /// |
| /// This automatically downloads the package to the system-wide cache as well |
| /// if it requires network access to retrieve (specifically, if the package's |
| /// source is a [CachedSource]). |
| Future<PackageId> _get(PackageId id) { |
| if (id.isRoot) return new Future.value(id); |
| |
| var packageDir = path.join(packagesDir, id.name); |
| if (entryExists(packageDir)) deleteEntry(packageDir); |
| |
| var source = cache.sources[id.source]; |
| return source.get(id, packageDir).then((_) => source.resolveId(id)); |
| } |
| |
| /// Loads the list of concrete package versions from the `pubspec.lock`, if it |
| /// exists. |
| /// |
| /// If it doesn't, this completes to an empty [LockFile]. |
| LockFile loadLockFile() { |
| if (!lockFileExists) return new LockFile.empty(); |
| return new LockFile.load(lockFilePath, cache.sources); |
| } |
| |
| /// Determines whether or not the lockfile is out of date with respect to the |
| /// pubspec. |
| /// |
| /// This will be `false` if there is no lockfile at all, or if the pubspec |
| /// contains dependencies that are not in the lockfile or that don't match |
| /// what's in there. |
| bool _isLockFileUpToDate(LockFile lockFile) { |
| return root.immediateDependencies.every((package) { |
| var locked = lockFile.packages[package.name]; |
| if (locked == null) return false; |
| |
| if (package.source != locked.source) return false; |
| if (!package.constraint.allows(locked.version)) return false; |
| |
| var source = cache.sources[package.source]; |
| if (source == null) return false; |
| |
| return source.descriptionsEqual(package.description, locked.description); |
| }); |
| } |
| |
| /// Determines whether all of the packages in the lockfile are already |
| /// installed and available. |
| /// |
| /// Note: this assumes [isLockFileUpToDate] has already been called and |
| /// returned `true`. |
| Future<bool> _arePackagesAvailable(LockFile lockFile) { |
| return Future.wait(lockFile.packages.values.map((package) { |
| var source = cache.sources[package.source]; |
| |
| // This should only be called after [_isLockFileUpToDate] has returned |
| // `true`, which ensures all of the sources in the lock file are valid. |
| assert(source != null); |
| |
| // We only care about cached sources. Uncached sources aren't "installed". |
| // If one of those is missing, we want to show the user the file not |
| // found error later since installing won't accomplish anything. |
| if (source is! CachedSource) return new Future.value(true); |
| |
| // Get the directory. |
| return source.getDirectory(package).then((dir) { |
| // See if the directory is there and looks like a package. |
| return dirExists(dir) || fileExists(path.join(dir, "pubspec.yaml")); |
| }); |
| })).then((results) { |
| // Make sure they are all true. |
| return results.every((result) => result); |
| }); |
| } |
| |
| /// Gets dependencies if the lockfile is out of date with respect to the |
| /// pubspec. |
| Future _ensureLockFileIsUpToDate() { |
| return syncFuture(() { |
| var lockFile = loadLockFile(); |
| |
| // If we don't have a current lock file, we definitely need to install. |
| if (!_isLockFileUpToDate(lockFile)) { |
| if (lockFileExists) { |
| log.message( |
| "Your pubspec has changed, so we need to update your lockfile:"); |
| } else { |
| log.message( |
| "You don't have a lockfile, so we need to generate that:"); |
| } |
| |
| return false; |
| } |
| |
| // If we do have a lock file, we still need to make sure the packages |
| // are actually installed. The user may have just gotten a package that |
| // includes a lockfile. |
| return _arePackagesAvailable(lockFile).then((available) { |
| if (!available) { |
| log.message( |
| "You are missing some dependencies, so we need to install them " |
| "first:"); |
| } |
| |
| return available; |
| }); |
| }).then((upToDate) { |
| if (upToDate) return null; |
| return acquireDependencies(); |
| }); |
| } |
| |
| /// Loads the package graph for the application and all of its transitive |
| /// dependencies. |
| /// |
| /// Before loading, makes sure the lockfile and dependencies are installed |
| /// and up to date. |
| Future<PackageGraph> loadPackageGraph() { |
| return _ensureLockFileIsUpToDate().then((_) { |
| var lockFile = loadLockFile(); |
| return Future.wait(lockFile.packages.values.map((id) { |
| var source = cache.sources[id.source]; |
| return source.getDirectory(id) |
| .then((dir) => new Package.load(id.name, dir, cache.sources)); |
| })).then((packages) { |
| var packageMap = new Map.fromIterable(packages, key: (p) => p.name); |
| packageMap[root.name] = root; |
| return new PackageGraph(this, lockFile, packageMap); |
| }); |
| }); |
| } |
| |
| /// Saves a list of concrete package versions to the `pubspec.lock` file. |
| void _saveLockFile(List<PackageId> packageIds) { |
| var lockFile = new LockFile(packageIds); |
| var lockFilePath = path.join(root.dir, 'pubspec.lock'); |
| writeTextFile(lockFilePath, lockFile.serialize(root.dir, cache.sources)); |
| } |
| |
| /// Creates a self-referential symlink in the `packages` directory that allows |
| /// a package to import its own files using `package:`. |
| void _linkSelf() { |
| var linkPath = path.join(packagesDir, root.name); |
| // Create the symlink if it doesn't exist. |
| if (entryExists(linkPath)) return; |
| ensureDir(packagesDir); |
| createPackageSymlink(root.name, root.dir, linkPath, |
| isSelfLink: true, relative: true); |
| } |
| |
| /// Add "packages" directories to the whitelist of directories that may |
| /// contain Dart entrypoints. |
| void _linkSecondaryPackageDirs() { |
| // Only the main "bin" directory gets a "packages" directory, not its |
| // subdirectories. |
| var binDir = path.join(root.dir, 'bin'); |
| if (dirExists(binDir)) _linkSecondaryPackageDir(binDir); |
| |
| // The others get "packages" directories in subdirectories too. |
| for (var dir in ['benchmark', 'example', 'test', 'tool', 'web']) { |
| _linkSecondaryPackageDirsRecursively(path.join(root.dir, dir)); |
| } |
| } |
| |
| /// Creates a symlink to the `packages` directory in [dir] and all its |
| /// subdirectories. |
| void _linkSecondaryPackageDirsRecursively(String dir) { |
| if (!dirExists(dir)) return; |
| _linkSecondaryPackageDir(dir); |
| _listDirWithoutPackages(dir) |
| .where(dirExists) |
| .forEach(_linkSecondaryPackageDir); |
| } |
| |
| // TODO(nweiz): roll this into [listDir] in io.dart once issue 4775 is fixed. |
| /// Recursively lists the contents of [dir], excluding hidden `.DS_Store` |
| /// files and `package` files. |
| List<String> _listDirWithoutPackages(dir) { |
| return flatten(listDir(dir).map((file) { |
| if (path.basename(file) == 'packages') return []; |
| if (!dirExists(file)) return []; |
| var fileAndSubfiles = [file]; |
| fileAndSubfiles.addAll(_listDirWithoutPackages(file)); |
| return fileAndSubfiles; |
| })); |
| } |
| |
| /// Creates a symlink to the `packages` directory in [dir]. Will replace one |
| /// if already there. |
| void _linkSecondaryPackageDir(String dir) { |
| var symlink = path.join(dir, 'packages'); |
| if (entryExists(symlink)) deleteEntry(symlink); |
| createSymlink(packagesDir, symlink, relative: true); |
| } |
| } |