RecursiveDirectoryIterator.php 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Finder\Iterator;
  11. use Symfony\Component\Finder\Exception\AccessDeniedException;
  12. use Symfony\Component\Finder\SplFileInfo;
  13. /**
  14. * Extends the \RecursiveDirectoryIterator to support relative paths.
  15. *
  16. * @author Victor Berchet <victor@suumit.com>
  17. */
  18. class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator
  19. {
  20. /**
  21. * @var bool
  22. */
  23. private $ignoreUnreadableDirs;
  24. /**
  25. * @var bool
  26. */
  27. private $rewindable;
  28. // these 3 properties take part of the performance optimization to avoid redoing the same work in all iterations
  29. private $rootPath;
  30. private $subPath;
  31. private $directorySeparator = '/';
  32. /**
  33. * @param string $path
  34. * @param int $flags
  35. * @param bool $ignoreUnreadableDirs
  36. *
  37. * @throws \RuntimeException
  38. */
  39. public function __construct($path, $flags, $ignoreUnreadableDirs = false)
  40. {
  41. if ($flags & (self::CURRENT_AS_PATHNAME | self::CURRENT_AS_SELF)) {
  42. throw new \RuntimeException('This iterator only support returning current as fileinfo.');
  43. }
  44. parent::__construct($path, $flags);
  45. $this->ignoreUnreadableDirs = $ignoreUnreadableDirs;
  46. $this->rootPath = (string) $path;
  47. if ('/' !== \DIRECTORY_SEPARATOR && !($flags & self::UNIX_PATHS)) {
  48. $this->directorySeparator = \DIRECTORY_SEPARATOR;
  49. }
  50. }
  51. /**
  52. * Return an instance of SplFileInfo with support for relative paths.
  53. *
  54. * @return SplFileInfo File information
  55. */
  56. public function current()
  57. {
  58. // the logic here avoids redoing the same work in all iterations
  59. if (null === $subPathname = $this->subPath) {
  60. $subPathname = $this->subPath = (string) $this->getSubPath();
  61. }
  62. if ('' !== $subPathname) {
  63. $subPathname .= $this->directorySeparator;
  64. }
  65. $subPathname .= $this->getFilename();
  66. return new SplFileInfo($this->rootPath.$this->directorySeparator.$subPathname, $this->subPath, $subPathname);
  67. }
  68. /**
  69. * @return \RecursiveIterator
  70. *
  71. * @throws AccessDeniedException
  72. */
  73. public function getChildren()
  74. {
  75. try {
  76. $children = parent::getChildren();
  77. if ($children instanceof self) {
  78. // parent method will call the constructor with default arguments, so unreadable dirs won't be ignored anymore
  79. $children->ignoreUnreadableDirs = $this->ignoreUnreadableDirs;
  80. // performance optimization to avoid redoing the same work in all children
  81. $children->rewindable = &$this->rewindable;
  82. $children->rootPath = $this->rootPath;
  83. }
  84. return $children;
  85. } catch (\UnexpectedValueException $e) {
  86. if ($this->ignoreUnreadableDirs) {
  87. // If directory is unreadable and finder is set to ignore it, a fake empty content is returned.
  88. return new \RecursiveArrayIterator(array());
  89. } else {
  90. throw new AccessDeniedException($e->getMessage(), $e->getCode(), $e);
  91. }
  92. }
  93. }
  94. /**
  95. * Do nothing for non rewindable stream.
  96. */
  97. public function rewind()
  98. {
  99. if (false === $this->isRewindable()) {
  100. return;
  101. }
  102. // @see https://bugs.php.net/68557
  103. if (\PHP_VERSION_ID < 50523 || \PHP_VERSION_ID >= 50600 && \PHP_VERSION_ID < 50607) {
  104. parent::next();
  105. }
  106. parent::rewind();
  107. }
  108. /**
  109. * Checks if the stream is rewindable.
  110. *
  111. * @return bool true when the stream is rewindable, false otherwise
  112. */
  113. public function isRewindable()
  114. {
  115. if (null !== $this->rewindable) {
  116. return $this->rewindable;
  117. }
  118. // workaround for an HHVM bug, should be removed when https://github.com/facebook/hhvm/issues/7281 is fixed
  119. if ('' === $this->getPath()) {
  120. return $this->rewindable = false;
  121. }
  122. if (false !== $stream = @opendir($this->getPath())) {
  123. $infos = stream_get_meta_data($stream);
  124. closedir($stream);
  125. if ($infos['seekable']) {
  126. return $this->rewindable = true;
  127. }
  128. }
  129. return $this->rewindable = false;
  130. }
  131. }