CreateProjectCommand.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. <?php
  2. /*
  3. * This file is part of Composer.
  4. *
  5. * (c) Nils Adermann <naderman@naderman.de>
  6. * Jordi Boggiano <j.boggiano@seld.be>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  11. namespace Composer\Command;
  12. use Composer\Config;
  13. use Composer\Factory;
  14. use Composer\Installer;
  15. use Composer\Installer\ProjectInstaller;
  16. use Composer\IO\IOInterface;
  17. use Composer\Package\BasePackage;
  18. use Composer\Package\LinkConstraint\VersionConstraint;
  19. use Composer\DependencyResolver\Pool;
  20. use Composer\Repository\ComposerRepository;
  21. use Composer\Repository\CompositeRepository;
  22. use Composer\Repository\FilesystemRepository;
  23. use Composer\Repository\NotifiableRepositoryInterface;
  24. use Composer\Repository\InstalledFilesystemRepository;
  25. use Symfony\Component\Console\Input\InputArgument;
  26. use Symfony\Component\Console\Input\InputInterface;
  27. use Symfony\Component\Console\Input\InputOption;
  28. use Symfony\Component\Console\Output\OutputInterface;
  29. use Symfony\Component\Finder\Finder;
  30. use Composer\Json\JsonFile;
  31. use Composer\Util\Filesystem;
  32. use Composer\Util\RemoteFilesystem;
  33. use Composer\Package\Version\VersionParser;
  34. /**
  35. * Install a package as new project into new directory.
  36. *
  37. * @author Benjamin Eberlei <kontakt@beberlei.de>
  38. * @author Jordi Boggiano <j.boggiano@seld.be>
  39. */
  40. class CreateProjectCommand extends Command
  41. {
  42. protected function configure()
  43. {
  44. $this
  45. ->setName('create-project')
  46. ->setDescription('Create new project from a package into given directory.')
  47. ->setDefinition(array(
  48. new InputArgument('package', InputArgument::REQUIRED, 'Package name to be installed'),
  49. new InputArgument('directory', InputArgument::OPTIONAL, 'Directory where the files should be created'),
  50. new InputArgument('version', InputArgument::OPTIONAL, 'Version, will defaults to latest'),
  51. new InputOption('stability', 's', InputOption::VALUE_REQUIRED, 'Minimum-stability allowed (unless a version is specified).', 'stable'),
  52. new InputOption('prefer-source', null, InputOption::VALUE_NONE, 'Forces installation from package sources when possible, including VCS information.'),
  53. new InputOption('prefer-dist', null, InputOption::VALUE_NONE, 'Forces installation from package dist even for dev versions.'),
  54. new InputOption('repository-url', null, InputOption::VALUE_REQUIRED, 'Pick a different repository url to look for the package.'),
  55. new InputOption('dev', null, InputOption::VALUE_NONE, 'Whether to install dependencies for development.'),
  56. new InputOption('no-custom-installers', null, InputOption::VALUE_NONE, 'Whether to disable custom installers.'),
  57. new InputOption('no-scripts', null, InputOption::VALUE_NONE, 'Whether to prevent execution of all defined scripts in the root package.'),
  58. new InputOption('keep-vcs', null, InputOption::VALUE_NONE, 'Whether to prevent deletion vcs folder.'),
  59. ))
  60. ->setHelp(<<<EOT
  61. The <info>create-project</info> command creates a new project from a given
  62. package into a new directory. You can use this command to bootstrap new
  63. projects or setup a clean version-controlled installation
  64. for developers of your project.
  65. <info>php composer.phar create-project vendor/project target-directory [version]</info>
  66. You can also specify the version with the package name using = or : as separator.
  67. To install unstable packages, either specify the version you want, or use the
  68. --stability=dev (where dev can be one of RC, beta, alpha or dev).
  69. To setup a developer workable version you should create the project using the source
  70. controlled code by appending the <info>'--prefer-source'</info> flag. Also, it is
  71. advisable to install all dependencies required for development by appending the
  72. <info>'--dev'</info> flag.
  73. To install a package from another repository than the default one you
  74. can pass the <info>'--repository-url=http://myrepository.org'</info> flag.
  75. EOT
  76. )
  77. ;
  78. }
  79. protected function execute(InputInterface $input, OutputInterface $output)
  80. {
  81. return $this->installProject(
  82. $this->getIO(),
  83. $input->getArgument('package'),
  84. $input->getArgument('directory'),
  85. $input->getArgument('version'),
  86. $input->getOption('stability'),
  87. $input->getOption('prefer-source'),
  88. $input->getOption('prefer-dist'),
  89. $input->getOption('dev'),
  90. $input->getOption('repository-url'),
  91. $input->getOption('no-custom-installers'),
  92. $input->getOption('no-scripts'),
  93. $input->getOption('keep-vcs')
  94. );
  95. }
  96. public function installProject(IOInterface $io, $packageName, $directory = null, $packageVersion = null, $stability = 'stable', $preferSource = false, $preferDist = false, $installDevPackages = false, $repositoryUrl = null, $disableCustomInstallers = false, $noScripts = false, $keepVcs = false)
  97. {
  98. $config = Factory::createConfig();
  99. $stability = strtolower($stability);
  100. if ($stability === 'rc') {
  101. $stability = 'RC';
  102. }
  103. if (!isset(BasePackage::$stabilities[$stability])) {
  104. throw new \InvalidArgumentException('Invalid stability provided ('.$stability.'), must be one of: '.implode(', ', array_keys(BasePackage::$stabilities)));
  105. }
  106. $dm = $this->createDownloadManager($io, $config);
  107. if ($preferSource) {
  108. $dm->setPreferSource(true);
  109. }
  110. if (null === $repositoryUrl) {
  111. $sourceRepo = new CompositeRepository(Factory::createDefaultRepositories($io, $config));
  112. } elseif ("json" === pathinfo($repositoryUrl, PATHINFO_EXTENSION)) {
  113. $sourceRepo = new FilesystemRepository(new JsonFile($repositoryUrl, new RemoteFilesystem($io)));
  114. } elseif (0 === strpos($repositoryUrl, 'http')) {
  115. $sourceRepo = new ComposerRepository(array('url' => $repositoryUrl), $io, $config);
  116. } else {
  117. throw new \InvalidArgumentException("Invalid repository url given. Has to be a .json file or an http url.");
  118. }
  119. $parser = new VersionParser();
  120. $candidates = array();
  121. $requirements = $parser->parseNameVersionPairs(array($packageName));
  122. $name = strtolower($requirements[0]['name']);
  123. if (!$packageVersion && isset($requirements[0]['version'])) {
  124. $packageVersion = $requirements[0]['version'];
  125. }
  126. $pool = new Pool($packageVersion ? 'dev' : $stability);
  127. $pool->addRepository($sourceRepo);
  128. $constraint = $packageVersion ? new VersionConstraint('=', $parser->normalize($packageVersion)) : null;
  129. $candidates = $pool->whatProvides($name, $constraint);
  130. foreach ($candidates as $key => $candidate) {
  131. if ($candidate->getName() !== $name) {
  132. unset($candidates[$key]);
  133. }
  134. }
  135. if (!$candidates) {
  136. throw new \InvalidArgumentException("Could not find package $name" . ($packageVersion ? " with version $packageVersion." : " with stability $stability."));
  137. }
  138. if (null === $directory) {
  139. $parts = explode("/", $name, 2);
  140. $directory = getcwd() . DIRECTORY_SEPARATOR . array_pop($parts);
  141. }
  142. // select highest version if we have many
  143. $package = $candidates[0];
  144. foreach ($candidates as $candidate) {
  145. if (version_compare($package->getVersion(), $candidate->getVersion(), '<')) {
  146. $package = $candidate;
  147. }
  148. }
  149. unset($candidates);
  150. $io->write('<info>Installing ' . $package->getName() . ' (' . VersionParser::formatVersion($package, false) . ')</info>');
  151. if ($disableCustomInstallers) {
  152. $io->write('<info>Custom installers have been disabled.</info>');
  153. }
  154. if (0 === strpos($package->getPrettyVersion(), 'dev-') && in_array($package->getSourceType(), array('git', 'hg'))) {
  155. $package->setSourceReference(substr($package->getPrettyVersion(), 4));
  156. }
  157. $dm->setPreferSource($preferSource)
  158. ->setPreferDist($preferDist);
  159. $projectInstaller = new ProjectInstaller($directory, $dm);
  160. $projectInstaller->install(new InstalledFilesystemRepository(new JsonFile('php://memory')), $package);
  161. if ($package->getRepository() instanceof NotifiableRepositoryInterface) {
  162. $package->getRepository()->notifyInstall($package);
  163. }
  164. $installedFromVcs = 'source' === $package->getInstallationSource();
  165. $io->write('<info>Created project in ' . $directory . '</info>');
  166. chdir($directory);
  167. putenv('COMPOSER_ROOT_VERSION='.$package->getPrettyVersion());
  168. // clean up memory
  169. unset($dm, $config, $projectInstaller, $sourceRepo, $package);
  170. // install dependencies of the created project
  171. $composer = Factory::create($io);
  172. $installer = Installer::create($io, $composer);
  173. $installer->setPreferSource($preferSource)
  174. ->setPreferDist($preferDist)
  175. ->setDevMode($installDevPackages)
  176. ->setRunScripts( ! $noScripts);
  177. if ($disableCustomInstallers) {
  178. $installer->disableCustomInstallers();
  179. }
  180. if (!$installer->run()) {
  181. return 1;
  182. }
  183. if (!$keepVcs && $installedFromVcs
  184. && (
  185. !$io->isInteractive()
  186. || $io->askConfirmation('<info>Do you want to remove the existing VCS (.git, .svn..) history?</info> [<comment>Y,n</comment>]? ', true)
  187. )
  188. ) {
  189. $finder = new Finder();
  190. $finder->depth(0)->directories()->in(getcwd())->ignoreVCS(false)->ignoreDotFiles(false);
  191. foreach (array('.svn', '_svn', 'CVS', '_darcs', '.arch-params', '.monotone', '.bzr', '.git', '.hg') as $vcsName) {
  192. $finder->name($vcsName);
  193. }
  194. try {
  195. $fs = new Filesystem();
  196. $dirs = iterator_to_array($finder);
  197. unset($finder);
  198. foreach ($dirs as $dir) {
  199. if (!$fs->removeDirectory($dir)) {
  200. throw new \RuntimeException('Could not remove '.$dir);
  201. }
  202. }
  203. } catch (\Exception $e) {
  204. $io->write('<error>An error occurred while removing the VCS metadata: '.$e->getMessage().'</error>');
  205. }
  206. }
  207. return 0;
  208. }
  209. protected function createDownloadManager(IOInterface $io, Config $config)
  210. {
  211. $factory = new Factory();
  212. return $factory->createDownloadManager($io, $config);
  213. }
  214. }