/libs/Nette/Utils/Finder.php
PHP | 420 lines | 287 code | 56 blank | 77 comment | 28 complexity | 85924b30ef50bcab2e543ab00cce7a69 MD5 | raw file
- <?php
-
- /**
- * This file is part of the Nette Framework (http://nette.org)
- *
- * Copyright (c) 2004, 2011 David Grudl (http://davidgrudl.com)
- *
- * For the full copyright and license information, please view
- * the file license.txt that was distributed with this source code.
- */
-
- namespace Nette\Utils;
-
- use Nette,
- RecursiveIteratorIterator;
-
-
-
- /**
- * Finder allows searching through directory trees using iterator.
- *
- * <code>
- * Finder::findFiles('*.php')
- * ->size('> 10kB')
- * ->from('.')
- * ->exclude('temp');
- * </code>
- *
- * @author David Grudl
- */
- class Finder extends Nette\Object implements \IteratorAggregate
- {
- /** @var array */
- private $paths = array();
-
- /** @var array of filters */
- private $groups;
-
- /** @var filter for recursive traversing */
- private $exclude = array();
-
- /** @var int */
- private $order = RecursiveIteratorIterator::SELF_FIRST;
-
- /** @var int */
- private $maxDepth = -1;
-
- /** @var array */
- private $cursor;
-
-
-
- /**
- * Begins search for files matching mask and all directories.
- * @param mixed
- * @return Finder
- */
- public static function find($mask)
- {
- if (!is_array($mask)) {
- $mask = func_get_args();
- }
- $finder = new static;
- return $finder->select(array(), 'isDir')->select($mask, 'isFile');
- }
-
-
-
- /**
- * Begins search for files matching mask.
- * @param mixed
- * @return Finder
- */
- public static function findFiles($mask)
- {
- if (!is_array($mask)) {
- $mask = func_get_args();
- }
- $finder = new static;
- return $finder->select($mask, 'isFile');
- }
-
-
-
- /**
- * Begins search for directories matching mask.
- * @param mixed
- * @return Finder
- */
- public static function findDirectories($mask)
- {
- if (!is_array($mask)) {
- $mask = func_get_args();
- }
- $finder = new static;
- return $finder->select($mask, 'isDir');
- }
-
-
-
- /**
- * Creates filtering group by mask & type selector.
- * @param array
- * @param string
- * @return Finder provides a fluent interface
- */
- private function select($masks, $type)
- {
- $this->cursor = & $this->groups[];
- $pattern = self::buildPattern($masks);
- if ($type || $pattern) {
- $this->filter(function($file) use ($type, $pattern) {
- return !$file->isDot()
- && (!$type || $file->$type())
- && (!$pattern || preg_match($pattern, '/' . strtr($file->getSubPathName(), '\\', '/')));
- });
- }
- return $this;
- }
-
-
-
- /**
- * Searchs in the given folder(s).
- * @param string|array
- * @return Finder provides a fluent interface
- */
- public function in($path)
- {
- if (!is_array($path)) {
- $path = func_get_args();
- }
- $this->maxDepth = 0;
- return $this->from($path);
- }
-
-
-
- /**
- * Searchs recursively from the given folder(s).
- * @param string|array
- * @return Finder provides a fluent interface
- */
- public function from($path)
- {
- if ($this->paths) {
- throw new Nette\InvalidStateException('Directory to search has already been specified.');
- }
- if (!is_array($path)) {
- $path = func_get_args();
- }
- $this->paths = $path;
- $this->cursor = & $this->exclude;
- return $this;
- }
-
-
-
- /**
- * Shows folder content prior to the folder.
- * @return Finder provides a fluent interface
- */
- public function childFirst()
- {
- $this->order = RecursiveIteratorIterator::CHILD_FIRST;
- return $this;
- }
-
-
-
- /**
- * Converts Finder pattern to regular expression.
- * @param array
- * @return string
- */
- private static function buildPattern($masks)
- {
- $pattern = array();
- // TODO: accept regexp
- foreach ($masks as $mask) {
- $mask = rtrim(strtr($mask, '\\', '/'), '/');
- $prefix = '';
- if ($mask === '') {
- continue;
-
- } elseif ($mask === '*') {
- return NULL;
-
- } elseif ($mask[0] === '/') { // absolute fixing
- $mask = ltrim($mask, '/');
- $prefix = '(?<=^/)';
- }
- $pattern[] = $prefix . strtr(preg_quote($mask, '#'),
- array('\*\*' => '.*', '\*' => '[^/]*', '\?' => '[^/]', '\[\!' => '[^', '\[' => '[', '\]' => ']', '\-' => '-'));
- }
- return $pattern ? '#/(' . implode('|', $pattern) . ')$#i' : NULL;
- }
-
-
-
- /********************* iterator generator ****************d*g**/
-
-
-
- /**
- * Returns iterator.
- * @return Nette\Iterator
- */
- public function getIterator()
- {
- if (!$this->paths) {
- throw new Nette\InvalidStateException('Call in() or from() to specify directory to search.');
-
- } elseif (count($this->paths) === 1) {
- return $this->buildIterator($this->paths[0]);
-
- } else {
- $iterator = new \AppendIterator(); // buggy!
- foreach ($this->paths as $path) {
- $iterator->append($this->buildIterator($path));
- }
- return $iterator;
- }
- }
-
-
-
- /**
- * Returns per-path iterator.
- * @param string
- * @return Nette\Iterator
- */
- private function buildIterator($path)
- {
- if (PHP_VERSION_ID < 50301) {
- $iterator = new Nette\Utils\RecursiveDirectoryIteratorFixed($path);
- } else {
- $iterator = new \RecursiveDirectoryIterator($path, \RecursiveDirectoryIterator::FOLLOW_SYMLINKS);
- }
-
- if ($this->exclude) {
- $filters = $this->exclude;
- $iterator = new Nette\Iterators\RecursiveFilter($iterator, function($file) use ($filters) {
- if (!$file->isFile()) {
- foreach ($filters as $filter) {
- if (!call_user_func($filter, $file)) {
- return FALSE;
- }
- }
- }
- return TRUE;
- });
- }
-
- if ($this->maxDepth !== 0) {
- $iterator = new RecursiveIteratorIterator($iterator, $this->order);
- $iterator->setMaxDepth($this->maxDepth);
- }
-
- if ($this->groups) {
- $groups = $this->groups;
- $iterator = new Nette\Iterators\Filter($iterator, function($file) use ($groups) {
- foreach ($groups as $filters) {
- foreach ($filters as $filter) {
- if (!call_user_func($filter, $file)) {
- continue 2;
- }
- }
- return TRUE;
- }
- return FALSE;
- });
- }
-
- return $iterator;
- }
-
-
-
- /********************* filtering ****************d*g**/
-
-
-
- /**
- * Restricts the search using mask.
- * Excludes directories from recursive traversing.
- * @param mixed
- * @return Finder provides a fluent interface
- */
- public function exclude($masks)
- {
- if (!is_array($masks)) {
- $masks = func_get_args();
- }
- $pattern = self::buildPattern($masks);
- if ($pattern) {
- $this->filter(function($file) use ($pattern) {
- return !preg_match($pattern, '/' . strtr($file->getSubPathName(), '\\', '/'));
- });
- }
- return $this;
- }
-
-
-
- /**
- * Restricts the search using callback.
- * @param callback
- * @return Finder provides a fluent interface
- */
- public function filter($callback)
- {
- $this->cursor[] = $callback;
- return $this;
- }
-
-
-
- /**
- * Limits recursion level.
- * @param int
- * @return Finder provides a fluent interface
- */
- public function limitDepth($depth)
- {
- $this->maxDepth = $depth;
- return $this;
- }
-
-
-
- /**
- * Restricts the search by size.
- * @param string "[operator] [size] [unit]" example: >=10kB
- * @param int
- * @return Finder provides a fluent interface
- */
- public function size($operator, $size = NULL)
- {
- if (func_num_args() === 1) { // in $operator is predicate
- if (!preg_match('#^(?:([=<>!]=?|<>)\s*)?((?:\d*\.)?\d+)\s*(K|M|G|)B?$#i', $operator, $matches)) {
- throw new Nette\InvalidArgumentException('Invalid size predicate format.');
- }
- list(, $operator, $size, $unit) = $matches;
- static $units = array('' => 1, 'k' => 1e3, 'm' => 1e6, 'g' => 1e9);
- $size *= $units[strtolower($unit)];
- $operator = $operator ? $operator : '=';
- }
- return $this->filter(function($file) use ($operator, $size) {
- return Finder::compare($file->getSize(), $operator, $size);
- });
- }
-
-
-
- /**
- * Restricts the search by modified time.
- * @param string "[operator] [date]" example: >1978-01-23
- * @param mixed
- * @return Finder provides a fluent interface
- */
- public function date($operator, $date = NULL)
- {
- if (func_num_args() === 1) { // in $operator is predicate
- if (!preg_match('#^(?:([=<>!]=?|<>)\s*)?(.+)$#i', $operator, $matches)) {
- throw new Nette\InvalidArgumentException('Invalid date predicate format.');
- }
- list(, $operator, $date) = $matches;
- $operator = $operator ? $operator : '=';
- }
- $date = Nette\DateTime::from($date)->format('U');
- return $this->filter(function($file) use ($operator, $date) {
- return Finder::compare($file->getMTime(), $operator, $date);
- });
- }
-
-
-
- /**
- * Compares two values.
- * @param mixed
- * @param mixed
- * @return bool
- */
- public static function compare($l, $operator, $r)
- {
- switch ($operator) {
- case '>':
- return $l > $r;
- case '>=':
- return $l >= $r;
- case '<':
- return $l < $r;
- case '<=':
- return $l <= $r;
- case '=':
- case '==':
- return $l == $r;
- case '!':
- case '!=':
- case '<>':
- return $l != $r;
- }
- throw new Nette\InvalidArgumentException("Unknown operator $operator.");
- }
-
- }
-
-
-
- if (PHP_VERSION_ID < 50301) {
- /** @internal */
- class RecursiveDirectoryIteratorFixed extends \RecursiveDirectoryIterator
- {
- function hasChildren()
- {
- return parent::hasChildren(TRUE);
- }
- }
- }