Source for file RobotLoader.php

Documentation is available at RobotLoader.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Loaders
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Loaders/AutoLoader.php';
24:
25: require_once dirname(__FILE__) . '/../Framework.php';
26:
27:
28:
29: /**
30: * Nette auto loader is responsible for loading classes and interfaces.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Loaders
35: */
36: class RobotLoader extends AutoLoader
37: {
38: /** @var array */
39: public $scanDirs;
40:
41: /** @var string comma separated wildcards */
42: public $ignoreDirs = '.svn, .cvs, *.old, *.bak, *.tmp';
43:
44: /** @var string comma separated wildcards */
45: public $acceptFiles = '*.php, *.php5';
46:
47: /** @var bool */
48: public $autoRebuild;
49:
50: /** @var array */
51: private $list = NULL;
52:
53: /** @var bool */
54: private $rebuilded = FALSE;
55:
56: /** @var string */
57: private $acceptMask;
58:
59: /** @var string */
60: private $ignoreMask;
61:
62:
63:
64: /**
65: * Handles autoloading of classes or interfaces.
66: * @param string
67: * @return void
68: */
69: public function tryLoad($type)
70: {
71: if ($this->list === NULL) {
72: $this->list = array(); // prevents cycling
73:
74: $cache = $this->getCache();
75: $data = $cache['data'];
76: $opt = array($this->scanDirs, $this->ignoreDirs, $this->acceptFiles);
77:
78: if ($data['opt'] === $opt) {
79: $this->list = $data['list'];
80: } else {
81: $this->rebuild();
82: $cache['data'] = array(
83: 'list' => $this->list,
84: 'opt' => $opt,
85: );
86: }
87:
88: if (isset($this->list[strtolower(__CLASS__)]) && class_exists('NetteLoader', FALSE)) {
89: NetteLoader::getInstance()->unregister();
90: }
91: }
92:
93: $type = strtolower($type);
94: if (isset($this->list[$type])) {
95: if ($this->list[$type] !== FALSE) {
96: LimitedScope::load($this->list[$type]);
97: self::$count++;
98: }
99:
100: } else {
101: if ($this->autoRebuild === NULL) {
102: $this->autoRebuild = !$this->isProduction();
103: }
104:
105: if ($this->autoRebuild) {
106: if (!$this->rebuilded) {
107: $this->rebuild();
108: }
109:
110: if (isset($this->list[$type])) {
111: LimitedScope::load($this->list[$type]);
112: self::$count++;
113: } else {
114: $this->list[$type] = FALSE;
115: }
116:
117: $cache = $this->getCache();
118: $cache['data'] = array(
119: 'list' => $this->list,
120: 'opt' => array($this->scanDirs, $this->ignoreDirs, $this->acceptFiles),
121: );
122: }
123: }
124: }
125:
126:
127:
128: /**
129: * Rebuilds class list cache.
130: * @return void
131: */
132: public function rebuild()
133: {
134: $this->acceptMask = self::wildcards2re($this->acceptFiles);
135: $this->ignoreMask = self::wildcards2re($this->ignoreDirs);
136: $this->list = array();
137: $this->rebuilded = TRUE;
138:
139: foreach (array_unique($this->scanDirs) as $dir) {
140: $this->scanDirectory($dir);
141: }
142: }
143:
144:
145:
146: /**
147: * Add directory (or directories) to list.
148: * @param string|array
149: * @return void
150: * @throws InvalidArgumentException if path is not found
151: */
152: public function addDirectory($path)
153: {
154: foreach ((array) $path as $val) {
155: $real = realpath($val);
156: if ($real === FALSE) {
157: throw new InvalidArgumentException("Directory '$val' not found.");
158: }
159: $this->scanDirs[] = $real;
160: }
161: }
162:
163:
164:
165: /**
166: * Add class and file name to the list.
167: * @param string
168: * @param string
169: * @return void
170: */
171: public function addClass($class, $file)
172: {
173: $class = strtolower($class);
174: if (isset($this->list[$class]) && $this->list[$class] !== $file) {
175: // throwing exception is not possible, Nette\Debug converts errors to exceptions
176: die("Ambiguous class '$class' resolution; defined in $file and in " . $this->list[$class] . ".");
177: }
178: $this->list[$class] = $file;
179: }
180:
181:
182:
183: /**
184: * Scan a directory for PHP files, subdirectories and 'netterobots.txt' file.
185: * @param string
186: * @return void
187: */
188: private function scanDirectory($dir)
189: {
190: $dir = realpath($dir);
191: if (!$dir) return;
192: $iterator = dir($dir);
193: if (!$iterator) return;
194:
195: $disallow = array();
196: if (is_file($dir . '/netterobots.txt')) {
197: foreach (file($dir . '/netterobots.txt') as $s) {
198: if (preg_match('#^disallow\\s*:\\s*(\\S+)#i', $s, $m)) {
199: $disallow[trim($m[1], '/')] = TRUE;
200: }
201: }
202: if (isset($disallow[''])) return;
203: }
204:
205: while (FALSE !== ($entry = $iterator->read())) {
206: if ($entry == '.' || $entry == '..' || isset($disallow[$entry])) continue;
207:
208: $path = $dir . '/' . $entry;
209: if (!is_readable($path)) continue;
210:
211: // process subdirectories
212: if (is_dir($path)) {
213: // check ignore mask
214: if (!preg_match($this->ignoreMask, $entry)) {
215: $this->scanDirectory($path);
216: }
217: continue;
218: }
219:
220: if (is_file($path) && preg_match($this->acceptMask, $entry)) {
221: $this->scanScript($path);
222: }
223: }
224:
225: $iterator->close();
226: }
227:
228:
229:
230: /**
231: * Analyse PHP file.
232: * @param string
233: * @return void
234: */
235: private function scanScript($file)
236: {
237: if (!defined('T_NAMESPACE')) {
238: define('T_NAMESPACE', -1);
239: define('T_NS_SEPARATOR', -1);
240: }
241:
242: $expected = FALSE;
243: $namespace = '';
244: $level = 0;
245: $s = file_get_contents($file);
246:
247: if (preg_match('#//nette'.'loader=(\S*)#', $s, $matches)) {
248: foreach (explode(',', $matches[1]) as $name) {
249: $this->addClass($name, $file);
250: }
251: return;
252: }
253:
254: foreach (token_get_all($s) as $token)
255: {
256: if (is_array($token)) {
257: switch ($token[0]) {
258: case T_NAMESPACE:
259: case T_CLASS:
260: case T_INTERFACE:
261: $expected = $token[0];
262: $name = '';
263: continue 2;
264:
265: case T_COMMENT:
266: case T_DOC_COMMENT:
267: case T_WHITESPACE:
268: continue 2;
269:
270: case T_NS_SEPARATOR:
271: case T_STRING:
272: if ($expected) {
273: $name .= $token[1];
274: }
275: continue 2;
276: }
277: }
278:
279: if ($expected) {
280: if ($expected === T_NAMESPACE) {
281: $namespace = $name . '\\';
282: } elseif ($level === 0) {
283: $this->addClass($namespace . $name, $file);
284: }
285: $expected = FALSE;
286: }
287:
288: if (is_array($token)) {
289: if ($token[0] === T_CURLY_OPEN || $token[0] === T_DOLLAR_OPEN_CURLY_BRACES) {
290: $level++;
291: }
292: } elseif ($token === '{') {
293: $level++;
294: } elseif ($token === '}') {
295: $level--;
296: }
297: }
298: }
299:
300:
301:
302: /**
303: * Converts comma separated wildcards to regular expression.
304: * @param string
305: * @return string
306: */
307: private static function wildcards2re($wildcards)
308: {
309: $mask = array();
310: foreach (explode(',', $wildcards) as $wildcard) {
311: $wildcard = trim($wildcard);
312: $wildcard = addcslashes($wildcard, '.\\+[^]$(){}=!><|:#');
313: $wildcard = strtr($wildcard, array('*' => '.*', '?' => '.?'));
314: $mask[] = $wildcard;
315: }
316: return '#^(' . implode('|', $mask) . ')$#i';
317: }
318:
319:
320:
321: /********************* backend ****************d*g**/
322:
323:
324:
325: /**
326: * @return Cache
327: */
328: protected function getCache()
329: {
330: return Environment::getCache('Nette.RobotLoader');
331: }
332:
333:
334:
335: /**
336: * @return bool
337: */
338: protected function isProduction()
339: {
340: return Environment::isProduction();
341: }
342:
343: }

Source for file RobotLoader.php

Namespaces