CreateProjectCommand.php 9.6 KB

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