Differential D25033 Diff 86 src/packages/ArcanistPackagesLoader.php

Changeset View

Standalone View

src/packages/ArcanistPackagesLoader.php

This file was added.

				<?php

				final class ArcanistPackagesLoader
				extends Phobject {

				private $configurationSourceList;

				public function setConfigurationSourceList(
				ArcanistConfigurationSourceList $sources) {

				$this->configurationSourceList = $sources;
				return $this;
				}

				public function loadPackages() {
				$log = new ArcanistLogEngine();
				$requested = $this->listRequestedPackages();

				$this->checkForConflicts($requested);

				$missing = array();

				foreach ($requested as $package) {
				$package_dir = $this->resolvePath($package);
				$found = ArcanistPackageDescriptor::fromDirectory($package_dir);
				if ($found != null) {
				if ($found->getIdentifier() != $package->getIdentifier() \|\|
				$found->getVersion() != $package->getVersion()) {
				$log->writeError(
				pht('PACKAGE LOAD ERROR'),
				pht(
				'Expected to find package %s in location %s, found %s instead',
				$package->getIdentifier(),
				$package_dir,
				$found->getIdentifier()));
				$missing[] = $package;
				continue;
				}

				try {
				$this->loadPackage($found);
				} catch (PhutilBootloaderException $ex) {
				$log->writeError(
				pht('LOAD ERROR'),
				pht(
				'Failed to load package "%s". This package is '.
				'specified by "%s"',
				$package->getIdentifier(),
				$package->getConfigurationSource()->getSourceDisplayName()));

				$prompt = pht('Continue loading without this package?');
				if (!phutil_console_confirm($prompt)) {
				throw $ex;
				}
				}
				} else {
				$missing[] = $package;
				}
				}

				if ($missing) {
				$log->writeError(
				pht('MISSING PACKAGES'),
				pht(
				'The following packages were requested but not found: %s.',
				implode(', ', $missing)));

				// TODO try to install; use `prompts`?
				Lint: TODO Comment Inline Actions This comment has a TODO. Lint: TODO Comment: This comment has a TODO.
				$prompt = pht('Continue without these packages?');
				if (!phutil_console_confirm($prompt)) {
				throw new ArcanistUserAbortException('Requested package not found.');
				}
				}
				}

				private function checkForConflicts($requested) {
				$log = new ArcanistLogEngine();
				$packages = mgroup($requested, 'getIdentifier', 'getVersion');

				foreach ($packages as $identifier => $versions) {
				if (count($versions) > 1) {
				$requests = array();
				foreach ($versions as $version => $list) {
				$package = head($list);
				$requests[] = pht(
				'v%s - Requested from %s',
				$package->getVersion(),
				$package->getConfigSource()->getSourceDisplayName());
				}

				$log->writeError(
				pht('CONFLICTING PACKAGE REQUESTED'),
				pht(
				'The package "%s" has conflicting requirements: %s.',
				$identifier,
				implode('; ', $requests)));

				throw new ArcanistUsageException(
				pht('Conflicting requests for package %s', $identifier));
				}
				}
				}

				private function loadPackage(ArcanistPackageDescriptor $package) {
				phutil_load_library($this->resolvePath($package).'/src');
				}

				public function listRequestedPackages() {
				$requested = array();
				$items = $this->configurationSourceList->getStorageValueList('packages');

				foreach ($items as $item) {
				foreach ($item->getValue() as $package_item) {
				$requested[] = ArcanistPackageDescriptor::fromConfig(
				$package_item,
				$item->getConfigurationSource());
				}
				}
				return $requested;
				}

				/**
				* This method may be slow, because it looks for and loads lots of files.
				*/
				public function listInstalledPackages() {
				$packages_root = $this->getPackagesDirectory();

				if (!Filesystem::pathExists($packages_root)) {
				return array();
				}

				$dirs = Filesystem::listDirectory($packages_root);

				$packages = array();
				foreach ($dirs as $dir) {
				$packages[$dir] =
				ArcanistPackageDescriptor::fromDirectory($packages_root.'/'.$dir);
				}
				return array_filter($packages);
				}

				private function resolvePath(ArcanistPackageDescriptor $package) {
				return $this->getPackagesDirectory().'/'.$package->getDirectoryName();
				}

				private function getPackagesDirectory() {
				if (phutil_is_windows()) {
				return getenv('APPDATA').'/.cache/arcanist-packages';
				}
				return getenv('HOME').'/.cache/arcanist-packages';
				}
				}