3 require_once(dirname(__FILE__) . '/stdlib.php');
6 * A class for finding files.
8 * This should really provided by pear. We don't want really to mess around
9 * with all the lousy systems. (WindowsNT, Win95, Mac, ...)
10 * But pear has only System and File, which do nothing.
11 * Anyway, in good PHP style we ignore the rest of the world and try to behave
12 * as on unix only. That means we use / as pathsep in all our constants.
16 public $_pathsep, $_path;
21 * @param $path array A list of directories in which to search for files.
23 function FileFinder($path = false)
25 $this->_pathsep = $this->_get_syspath_separator();
26 if (!isset($this->_path) and $path === false)
27 $path = $this->_get_include_path();
34 * @param $file string File to search for.
35 * @return string The filename (including path), if found, otherwise false.
37 function findFile($file, $missing_okay = false)
39 if ($this->_is_abs($file)) {
40 if (file_exists($file))
42 } elseif (($dir = $this->_search_path($file))) {
43 return $dir . $this->_use_path_separator($dir) . $file;
45 return $missing_okay ? false : $this->_not_found($file);
49 * Unify used pathsep character.
50 * Accepts array of paths also.
51 * This might not work on Windows95 or FAT volumes. (not tested)
53 function slashifyPath($path)
55 return $this->forcePathSlashes($path, $this->_pathsep);
59 * Force using '/' as path seperator.
61 function forcePathSlashes($path, $sep = '/')
63 if (is_array($path)) {
65 foreach ($path as $dir) {
66 $result[] = $this->forcePathSlashes($dir, $sep);
70 if (isWindows() or $this->_isOtherPathsep()) {
71 if (isWindows()) $from = "\\";
73 // PHP is stupid enough to use \\ instead of \
75 if (substr($path, 0, 2) != '\\\\')
76 $path = str_replace('\\\\', '\\', $path);
78 $path = '\\\\' . str_replace('\\\\', '\\', substr($path, 2));
80 return strtr($path, $from, $sep);
87 * Try to include file.
89 * If file is found in the path, then the files directory is added
90 * to PHP's include_path (if it's not already there.) Then the
91 * file is include_once()'d.
93 * @param $file string File to include.
94 * @return bool True if file was successfully included.
96 function includeOnce($file)
98 if (($ret = @include_once($file)))
101 if (!$this->_is_abs($file)) {
102 if (($dir = $this->_search_path($file)) && is_file($dir . $this->_pathsep . $file)) {
103 $this->_append_to_include_path($dir);
104 return include_once($file);
107 return $this->_not_found($file);
110 function _isOtherPathsep()
112 return $this->_pathsep != '/';
116 * The system-dependent path-separator character.
117 * UNIX,WindowsNT,MacOSX: /
122 * @return string path_separator.
124 function _get_syspath_separator()
126 if (!empty($this->_pathsep)) return $this->_pathsep;
127 elseif (isWindowsNT()) return "/"; // we can safely use '/'
128 elseif (isWindows()) return "\\"; // FAT might use '\'
129 // VMS or LispM is really weird, we ignore it.
134 * The path-separator character of the given path.
135 * Windows accepts "/" also, but gets confused with mixed path_separators,
136 * e.g "C:\Apache\phpwiki/locale/button"
137 * > dir "C:\Apache\phpwiki/locale/button" =>
138 * Parameterformat nicht korrekt - "locale"
139 * So if there's any '\' in the path, either fix them to '/' (not in Win95 or FAT?)
140 * or use '\' for ours.
143 * @return string path_separator.
145 function _use_path_separator($path)
148 if (empty($path)) return "\\";
149 else return (strchr($path, "\\")) ? "\\" : '/';
151 return $this->_get_syspath_separator();
156 * Determine if path is absolute.
159 * @param $path string Path.
160 * @return bool True if path is absolute.
162 function _is_abs($path)
164 if (substr($path, 0, 1) == '/') {
166 } elseif (isWindows() and preg_match("/^[a-z]:/i", $path)
167 and (substr($path, 2, 1) == "/" or substr($path, 2, 1) == "\\")
176 * Strip ending '/' or '\' from path.
179 * @param $path string Path.
180 * @return bool New path (destructive)
182 function _strip_last_pathchar(&$path)
184 if (substr($path, -1) == '/' or substr($path, -1) == "\\")
185 $path = substr($path, 0, -1);
190 * Report a "file not found" error.
193 * @param $file string Name of missing file.
194 * @return bool false.
196 function _not_found($file)
198 if (function_exists("_"))
199 trigger_error(sprintf(_("%s: file not found"), $file), E_USER_ERROR);
201 trigger_error(sprintf("%s: file not found", $file), E_USER_ERROR);
206 * Search our path for a file.
209 * @param $file string File to find.
210 * @return string Directory which contains $file, or false.
213 function _search_path($file)
215 foreach ($this->_path as $dir) {
216 // ensure we use the same pathsep
217 if ($this->_isOtherPathsep()) {
218 $dir = $this->slashifyPath($dir);
219 $file = $this->slashifyPath($file);
220 if (file_exists($dir . $this->_pathsep . $file))
222 } elseif (@file_exists($dir . $this->_pathsep . $file))
229 * The system-dependent path-separator character. On UNIX systems,
230 * this character is ':'; on Win32 systems it is ';'.
232 * On Mac it cannot be : because this is the seperator there!
235 * @return string path_separator.
237 function _get_ini_separator()
239 return isWindows() ? ';' : ':';
240 // return preg_match('/^Windows/', php_uname())
244 * Get the value of PHP's include_path.
247 * @return array Include path.
249 function _get_include_path()
251 if (defined("INCLUDE_PATH"))
252 $path = INCLUDE_PATH;
254 $path = @get_cfg_var('include_path'); // FIXME: report warning
255 if (empty($path)) $path = @ini_get('include_path');
259 return explode($this->_get_ini_separator(), $this->slashifyPath($path));
263 * Add a directory to the end of PHP's include_path.
265 * The directory is appended only if it is not already listed in
269 * @param $dir string Directory to add.
271 function _append_to_include_path($dir)
273 $dir = $this->slashifyPath($dir);
274 if (!in_array($dir, $this->_path)) {
275 $this->_path[] = $dir;
278 * Some (buggy) PHP's (notable SourceForge's PHP 4.0.6)
279 * sometimes don't seem to heed their include_path.
280 * I.e. sometimes a file is not found even though it seems to
281 * be in the current include_path. A simple
282 * ini_set('include_path', ini_get('include_path')) seems to
283 * be enough to fix the problem
285 * This following line should be in the above if-block, but we
286 * put it here, as it seems to work-around the bug.
288 $GLOBALS['INCLUDE_PATH'] = implode($this->_get_ini_separator(), $this->_path);
289 @ini_set('include_path', $GLOBALS['INCLUDE_PATH']);
293 * Add a directory to the front of PHP's include_path.
295 * The directory is prepended, and removed from the tail if already existing.
298 * @param $dir string Directory to add.
300 function _prepend_to_include_path($dir)
302 $dir = $this->slashifyPath($dir);
304 if ($i = array_search($dir, $this->_path) !== false) {
305 array_splice($this->_path, $i, 1);
307 array_unshift($this->_path, $dir);
308 $GLOBALS['INCLUDE_PATH'] = implode($this->_path, $this->_get_ini_separator());
309 @ini_set('include_path', $GLOBALS['INCLUDE_PATH']);
312 // Return all the possible shortened locale specifiers for the given locale.
313 // Most specific first.
314 // de_DE.iso8859-1@euro => de_DE.iso8859-1, de_DE, de
315 // This code might needed somewhere else also.
316 function locale_versions($lang)
318 // Try less specific versions of the locale
320 foreach (array('@', '.', '_') as $sep) {
321 if (($tail = strchr($lang, $sep)))
322 $langs[] = substr($lang, 0, -strlen($tail));
328 * Try to figure out the appropriate value for $LANG.
331 * @return string The value of $LANG.
335 if (!empty($GLOBALS['LANG']))
336 return $GLOBALS['LANG'];
338 foreach (array('LC_ALL', 'LC_MESSAGES', 'LC_RESPONSES') as $var) {
339 $lang = setlocale(constant($var), 0);
344 foreach (array('LC_ALL', 'LC_MESSAGES', 'LC_RESPONSES', 'LANG') as $var) {
345 $lang = getenv($var);
355 * A class for finding PEAR code.
357 * This is a subclass of FileFinder which searches a standard list of
358 * directories where PEAR code is likely to be installed.
363 * $pearFinder = new PearFileFinder;
364 * $pearFinder->includeOnce('DB.php');
367 * The above code will look for 'DB.php', if found, the directory in
368 * which it was found will be added to PHP's include_path, and the
369 * file will be included. (If the file is not found, and E_USER_ERROR
378 * @param $path array Where to look for PEAR library code.
379 * A good set of defaults is provided, so you can probably leave
380 * this parameter blank.
382 function PearFileFinder($path = array())
384 $this->FileFinder(array_merge(
386 array('/usr/share/php',
388 '/usr/local/share/php',
389 '/usr/local/lib/php',
390 '/System/Library/PHP',
391 '/Apache/pear' // Windows
397 * Find PhpWiki localized files.
399 * This is a subclass of FileFinder which searches PHP's include_path
400 * for files. It looks first for "locale/$LANG/$file", then for
403 * If $LANG is something like "de_DE.iso8859-1@euro", this class will
404 * also search under various less specific variations like
405 * "de_DE.iso8859-1", "de_DE" and "de".
407 class LocalizedFileFinder
413 function LocalizedFileFinder()
415 $this->_pathsep = $this->_get_syspath_separator();
416 $include_path = $this->_get_include_path();
419 $lang = $this->_get_lang();
420 assert(!empty($lang));
422 if ($locales = $this->locale_versions($lang)) {
423 foreach ($locales as $lang) {
424 if ($lang == 'C') $lang = 'en';
425 foreach ($include_path as $dir) {
426 $path[] = $this->slashifyPath($dir . "/locale/$lang");
430 $this->FileFinder(array_merge($path, $include_path));
435 * Find PhpWiki localized theme buttons.
437 * This is a subclass of FileFinder which searches PHP's include_path
438 * for files. It looks first for "buttons/$LANG/$file", then for
441 * If $LANG is something like "de_DE.iso8859-1@euro", this class will
442 * also search under various less specific variations like
443 * "de_DE.iso8859-1", "de_DE" and "de".
445 class LocalizedButtonFinder
451 function LocalizedButtonFinder()
454 $this->_pathsep = $this->_get_syspath_separator();
455 $include_path = $this->_get_include_path();
458 $lang = $this->_get_lang();
459 assert(!empty($lang));
460 assert(!empty($WikiTheme));
462 if (is_object($WikiTheme)) {
463 $langs = $this->locale_versions($lang);
464 foreach ($langs as $lang) {
465 if ($lang == 'C') $lang = 'en';
466 foreach ($include_path as $dir) {
467 $path[] = $this->slashifyPath($WikiTheme->file("buttons/$lang"));
472 $this->FileFinder(array_merge($path, $include_path));
476 // Search PHP's include_path to find file or directory.
477 function FindFile($file, $missing_okay = false, $slashify = false)
480 if (!isset($finder)) {
481 $finder = new FileFinder;
482 // remove "/lib" from dirname(__FILE__)
483 $wikidir = preg_replace('/.lib$/', '', dirname(__FILE__));
484 // let the system favor its local pear?
485 $finder->_append_to_include_path(dirname(__FILE__) . "/pear");
486 $finder->_prepend_to_include_path($wikidir);
487 // Don't override existing INCLUDE_PATH config.
488 if (!defined("INCLUDE_PATH"))
489 define("INCLUDE_PATH", implode($finder->_get_ini_separator(), $finder->_path));
491 $s = $finder->findFile($file, $missing_okay);
493 $s = $finder->slashifyPath($s);
497 // Search PHP's include_path to find file or directory.
498 // Searches for "locale/$LANG/$file", then for "$file".
499 function FindLocalizedFile($file, $missing_okay = false, $re_init = false)
502 if ($re_init or !isset($finder))
503 $finder = new LocalizedFileFinder;
504 return $finder->findFile($file, $missing_okay);
507 function FindLocalizedButtonFile($file, $missing_okay = false, $re_init = false)
509 static $buttonfinder;
510 if ($re_init or !isset($buttonfinder))
511 $buttonfinder = new LocalizedButtonFinder;
512 return $buttonfinder->findFile($file, $missing_okay);
516 * Prefixes with PHPWIKI_DIR and slashify.
517 * For example to unify with
518 * require_once dirname(__FILE__).'/lib/file.php'
519 * require_once 'lib/file.php' loading style.
520 * Doesn't expand "~" or symlinks yet. truename would be perfect.
522 * NormalizeLocalFileName("lib/config.php") => /home/user/phpwiki/lib/config.php
524 function NormalizeLocalFileName($file)
527 if (!isset($finder)) {
528 $finder = new FileFinder;
530 // remove "/lib" from dirname(__FILE__)
531 if ($finder->_is_abs($file))
532 return $finder->slashifyPath($file);
534 if (defined("PHPWIKI_DIR")) $wikidir = PHPWIKI_DIR;
535 else $wikidir = preg_replace('/.lib$/', '', dirname(__FILE__));
536 $wikidir = $finder->_strip_last_pathchar($wikidir);
537 $pathsep = $finder->_use_path_separator($wikidir);
538 return $finder->slashifyPath($wikidir . $pathsep . $file);
539 // return PHPWIKI_DIR . "/" . $file;
544 * Prefixes with DATA_PATH and slashify
546 function NormalizeWebFileName($file)
549 if (!isset($finder)) {
550 $finder = new FileFinder;
552 if (defined("DATA_PATH")) {
553 $wikipath = DATA_PATH;
554 $wikipath = $finder->_strip_last_pathchar($wikipath);
556 return $finder->forcePathSlashes($wikipath);
558 return $finder->forcePathSlashes($wikipath . '/' . $file);
560 return $finder->forcePathSlashes($file);
567 if (isset($win)) return $win;
568 //return preg_match('/^Windows/', php_uname());
569 $win = (substr(PHP_OS, 0, 3) == 'WIN');
573 function isWindows95()
576 if (isset($win95)) return $win95;
577 $win95 = isWindows() and !isWindowsNT();
581 function isWindowsNT()
584 if (isset($winnt)) return $winnt;
585 // FIXME: Do this using PHP_OS instead of php_uname().
586 // $winnt = (PHP_OS == "WINNT"); // example from http://www.php.net/manual/en/ref.readline.php
587 if (function_usable('php_uname'))
588 $winnt = preg_match('/^Windows NT/', php_uname());
590 $winnt = false; // FIXME: punt.
598 // c-hanging-comment-ender-p: nil
599 // indent-tabs-mode: nil