3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * class to provide simple static functions for file objects
39 class CRM_Utils_File
{
42 * Given a file name, determine if the file contents make it an ascii file
44 * @param string $name name of file
46 * @return boolean true if file is ascii
49 static function isAscii($name) {
50 $fd = fopen($name, "r");
57 $line = fgets($fd, 8192);
58 if (!CRM_Utils_String
::isAscii($line)) {
69 * Given a file name, determine if the file contents make it an html file
71 * @param string $name name of file
73 * @return boolean true if file is html
76 static function isHtml($name) {
77 $fd = fopen($name, "r");
84 while (!feof($fd) & $lineCount <= 5) {
86 $line = fgets($fd, 8192);
87 if (!CRM_Utils_String
::isHtml($line)) {
98 * create a directory given a path name, creates parent directories
101 * @param string $path the path name
102 * @param boolean $abort should we abort or just return an invalid code
108 static function createDir($path, $abort = TRUE) {
109 if (is_dir($path) ||
empty($path)) {
113 CRM_Utils_File
::createDir(dirname($path), $abort);
114 if (@mkdir
($path, 0777) == FALSE) {
116 $docLink = CRM_Utils_System
::docURL2('Moving an Existing Installation to a New Server or Location', NULL, NULL, NULL, NULL, "wiki");
117 echo "Error: Could not create directory: $path.<p>If you have moved an existing CiviCRM installation from one location or server to another there are several steps you will need to follow. They are detailed on this CiviCRM wiki page - {$docLink}. A fix for the specific problem that caused this error message to be displayed is to set the value of the config_backend column in the civicrm_domain table to NULL. However we strongly recommend that you review and follow all the steps in that document.</p>";
119 CRM_Utils_System
::civiExit();
129 * delete a directory given a path name, delete children directories
130 * and files if needed
134 * @param bool $verbose
137 * @internal param string $path the path name
143 static function cleanDir($target, $rmdir = TRUE, $verbose = TRUE) {
144 static $exceptions = array('.', '..');
145 if ($target == '' ||
$target == '/') {
146 throw new Exception("Overly broad deletion");
149 if ($sourcedir = @opendir
($target)) {
150 while (FALSE !== ($sibling = readdir($sourcedir))) {
151 if (!in_array($sibling, $exceptions)) {
152 $object = $target . DIRECTORY_SEPARATOR
. $sibling;
154 if (is_dir($object)) {
155 CRM_Utils_File
::cleanDir($object, $rmdir, $verbose);
157 elseif (is_file($object)) {
158 if (!unlink($object)) {
159 CRM_Core_Session
::setStatus(ts('Unable to remove file %1', array(1 => $object)), ts('Warning'), 'error');
164 closedir($sourcedir);
167 if (rmdir($target)) {
169 CRM_Core_Session
::setStatus(ts('Removed directory %1', array(1 => $target)), '', 'success');
174 CRM_Core_Session
::setStatus(ts('Unable to remove directory %1', array(1 => $target)), ts('Warning'), 'error');
182 * @param $destination
184 static function copyDir($source, $destination) {
185 $dir = opendir($source);
186 @mkdir
($destination);
187 while (FALSE !== ($file = readdir($dir))) {
188 if (($file != '.') && ($file != '..')) {
189 if (is_dir($source . DIRECTORY_SEPARATOR
. $file)) {
190 CRM_Utils_File
::copyDir($source . DIRECTORY_SEPARATOR
. $file, $destination . DIRECTORY_SEPARATOR
. $file);
193 copy($source . DIRECTORY_SEPARATOR
. $file, $destination . DIRECTORY_SEPARATOR
. $file);
201 * Given a file name, recode it (in place!) to UTF-8
203 * @param string $name name of file
205 * @return boolean whether the file was recoded properly
208 static function toUtf8($name) {
209 static $config = NULL;
210 static $legacyEncoding = NULL;
211 if ($config == NULL) {
212 $config = CRM_Core_Config
::singleton();
213 $legacyEncoding = $config->legacyEncoding
;
216 if (!function_exists('iconv')) {
222 $contents = file_get_contents($name);
223 if ($contents === FALSE) {
227 $contents = iconv($legacyEncoding, 'UTF-8', $contents);
228 if ($contents === FALSE) {
232 $file = fopen($name, 'w');
233 if ($file === FALSE) {
237 $written = fwrite($file, $contents);
238 $closed = fclose($file);
239 if ($written === FALSE or !$closed) {
247 * Appends a slash to the end of a string if it doesn't already end with one
249 * @param string $path
250 * @param string $slash
256 static function addTrailingSlash($path, $slash = NULL) {
258 // FIXME: Defaulting to backslash on windows systems can produce unexpected results, esp for URL strings which should always use forward-slashes.
259 // I think this fn should default to forward-slash instead.
260 $slash = DIRECTORY_SEPARATOR
;
262 if (!in_array(substr($path, -1, 1), array('/', '\\'))) {
271 * @param null $prefix
272 * @param bool $isQueryString
273 * @param bool $dieOnErrors
275 static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $isQueryString = FALSE, $dieOnErrors = TRUE) {
276 require_once 'DB.php';
278 $db = DB
::connect($dsn);
279 if (PEAR
::isError($db)) {
280 die("Cannot open $dsn: " . $db->getMessage());
282 if (CRM_Utils_Constant
::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System
::isDevelopment())) {
283 $db->query('SET SESSION sql_mode = STRICT_TRANS_TABLES');
286 if (!$isQueryString) {
287 $string = $prefix . file_get_contents($fileName);
290 // use filename as query string
291 $string = $prefix . $fileName;
294 //get rid of comments starting with # and --
296 $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
297 $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
299 $queries = preg_split('/;\s*$/m', $string);
300 foreach ($queries as $query) {
301 $query = trim($query);
302 if (!empty($query)) {
303 CRM_Core_Error
::debug_query($query);
304 $res = &$db->query($query);
305 if (PEAR
::isError($res)) {
307 die("Cannot execute $query: " . $res->getMessage());
310 echo "Cannot execute $query: " . $res->getMessage() . "<p>";
322 static function isExtensionSafe($ext) {
323 static $extensions = NULL;
325 $extensions = CRM_Core_OptionGroup
::values('safe_file_extension', TRUE);
327 //make extensions to lowercase
328 $extensions = array_change_key_case($extensions, CASE_LOWER
);
329 // allow html/htm extension ONLY if the user is admin
330 // and/or has access CiviMail
331 if (!(CRM_Core_Permission
::check('access CiviMail') ||
332 CRM_Core_Permission
::check('administer CiviCRM') ||
333 (CRM_Mailing_Info
::workflowEnabled() &&
334 CRM_Core_Permission
::check('create mailings')
337 unset($extensions['html']);
338 unset($extensions['htm']);
341 //support lower and uppercase file extensions
342 return isset($extensions[strtolower($ext)]) ?
TRUE : FALSE;
346 * Determine whether a given file is listed in the PHP include path
348 * @param string $name name of file
350 * @return boolean whether the file can be include()d or require()d
352 static function isIncludable($name) {
353 $x = @fopen
($name, 'r', TRUE);
364 * remove the 32 bit md5 we add to the fileName
365 * also remove the unknown tag if we added it
367 static function cleanFileName($name) {
368 // replace the last 33 character before the '.' with null
369 $name = preg_replace('/(_[\w]{32})\./', '.', $name);
378 static function makeFileName($name) {
379 $uniqID = md5(uniqid(rand(), TRUE));
380 $info = pathinfo($name);
381 $basename = substr($info['basename'],
382 0, -(strlen(CRM_Utils_Array
::value('extension', $info)) +
(CRM_Utils_Array
::value('extension', $info) == '' ?
0 : 1))
384 if (!self
::isExtensionSafe(CRM_Utils_Array
::value('extension', $info))) {
385 // munge extension so it cannot have an embbeded dot in it
386 // The maximum length of a filename for most filesystems is 255 chars.
387 // We'll truncate at 240 to give some room for the extension.
388 return CRM_Utils_String
::munge("{$basename}_" . CRM_Utils_Array
::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown";
391 return CRM_Utils_String
::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array
::value('extension', $info);
401 static function getFilesByExtension($path, $ext) {
402 $path = self
::addTrailingSlash($path);
403 $dh = opendir($path);
405 while (FALSE !== ($elem = readdir($dh))) {
406 if (substr($elem, -(strlen($ext) +
1)) == '.' . $ext) {
407 $files[] .= $path . $elem;
415 * Restrict access to a given directory (by planting there a restrictive .htaccess file)
417 * @param string $dir the directory to be secured
418 * @param bool $overwrite
420 static function restrictAccess($dir, $overwrite = FALSE) {
421 // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
422 // of site, causing site to stop functioning.
423 // FIXME: we should do more checks here -
424 if (!empty($dir) && is_dir($dir)) {
425 $htaccess = <<<HTACCESS
432 $file = $dir . '.htaccess';
433 if ($overwrite ||
!file_exists($file)) {
434 if (file_put_contents($file, $htaccess) === FALSE) {
435 CRM_Core_Error
::movedSiteError($file);
442 * Restrict remote users from browsing the given directory.
446 static function restrictBrowsing($publicDir) {
447 if (!is_dir($publicDir) ||
!is_writable($publicDir)) {
452 $nobrowse = realpath($publicDir) . '/index.html';
453 if (!file_exists($nobrowse)) {
454 @file_put_contents
($nobrowse, '');
458 $dir = new RecursiveDirectoryIterator($publicDir);
459 foreach ($dir as $name => $object) {
460 if (is_dir($name) && $name != '..') {
461 $nobrowse = realpath($name) . '/index.html';
462 if (!file_exists($nobrowse)) {
463 @file_put_contents
($nobrowse, '');
470 * Create the base file path from which all our internal directories are
471 * offset. This is derived from the template compile directory set
473 static function baseFilePath($templateCompileDir = NULL) {
474 static $_path = NULL;
476 if ($templateCompileDir == NULL) {
477 $config = CRM_Core_Config
::singleton();
478 $templateCompileDir = $config->templateCompileDir
;
481 $path = dirname($templateCompileDir);
483 //this fix is to avoid creation of upload dirs inside templates_c directory
484 $checkPath = explode(DIRECTORY_SEPARATOR
, $path);
486 $cnt = count($checkPath) - 1;
487 if ($checkPath[$cnt] == 'templates_c') {
488 unset($checkPath[$cnt]);
489 $path = implode(DIRECTORY_SEPARATOR
, $checkPath);
492 $_path = CRM_Utils_File
::addTrailingSlash($path);
502 static function relativeDirectory($directory) {
503 // Do nothing on windows
504 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
508 // check if directory is relative, if so return immediately
509 if (substr($directory, 0, 1) != DIRECTORY_SEPARATOR
) {
513 // make everything relative from the baseFilePath
514 $basePath = self
::baseFilePath();
515 // check if basePath is a substr of $directory, if so
516 // return rest of string
517 if (substr($directory, 0, strlen($basePath)) == $basePath) {
518 return substr($directory, strlen($basePath));
521 // return the original value
530 static function absoluteDirectory($directory) {
531 // check if directory is already absolute, if so return immediately
532 // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
533 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
537 // check if directory is already absolute, if so return immediately
538 if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR
) {
542 // make everything absolute from the baseFilePath
543 $basePath = self
::baseFilePath();
545 return $basePath . $directory;
549 * Make a file path relative to some base dir
556 static function relativize($directory, $basePath) {
557 if (substr($directory, 0, strlen($basePath)) == $basePath) {
558 return substr($directory, strlen($basePath));
565 * Create a path to a temporary file which can endure for multiple requests
567 * TODO: Automatic file cleanup using, eg, TTL policy
569 * @param $prefix string
571 * @return string, path to an openable/writable file
574 static function tempnam($prefix = 'tmp-') {
575 //$config = CRM_Core_Config::singleton();
576 //$nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
577 //$fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
578 $fileName = tempnam(sys_get_temp_dir(), $prefix);
583 * Create a path to a temporary directory which can endure for multiple requests
585 * TODO: Automatic file cleanup using, eg, TTL policy
587 * @param $prefix string
589 * @return string, path to an openable/writable directory; ends with '/'
592 static function tempdir($prefix = 'tmp-') {
593 $fileName = self
::tempnam($prefix);
595 mkdir($fileName, 0700);
596 return $fileName . '/';
600 * Search directory tree for files which match a glob pattern.
602 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
604 * @param $dir string, base dir
605 * @param $pattern string, glob pattern, eg "*.txt"
606 * @return array(string)
608 static function findFiles($dir, $pattern) {
609 $todos = array($dir);
611 while (!empty($todos)) {
612 $subdir = array_shift($todos);
613 $matches = glob("$subdir/$pattern");
614 if (is_array($matches)) {
615 foreach ($matches as $match) {
616 if (!is_dir($match)) {
621 $dh = opendir($subdir);
623 while (FALSE !== ($entry = readdir($dh))) {
624 $path = $subdir . DIRECTORY_SEPARATOR
. $entry;
625 if ($entry{0} == '.') {
627 } elseif (is_dir($path)) {
638 * Determine if $child is a sub-directory of $parent
640 * @param string $parent
641 * @param string $child
642 * @param bool $checkRealPath
646 static function isChildPath($parent, $child, $checkRealPath = TRUE) {
647 if ($checkRealPath) {
648 $parent = realpath($parent);
649 $child = realpath($child);
651 $parentParts = explode('/', rtrim($parent, '/'));
652 $childParts = explode('/', rtrim($child, '/'));
653 while (($parentPart = array_shift($parentParts)) !== NULL) {
654 $childPart = array_shift($childParts);
655 if ($parentPart != $childPart) {
659 if (empty($childParts)) {
660 return FALSE; // same directory
667 * Move $fromDir to $toDir, replacing/deleting any
668 * pre-existing content.
670 * @param string $fromDir the directory which should be moved
671 * @param string $toDir the new location of the directory
672 * @param bool $verbose
674 * @return bool TRUE on success
676 static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
677 if (is_dir($toDir)) {
678 if (!self
::cleanDir($toDir, TRUE, $verbose)) {
683 // return rename($fromDir, $toDir); // CRM-11987, https://bugs.php.net/bug.php?id=54097
685 CRM_Utils_File
::copyDir($fromDir, $toDir);
686 if (!CRM_Utils_File
::cleanDir($fromDir, TRUE, FALSE)) {
687 CRM_Core_Session
::setStatus(ts('Failed to clean temp dir: %1', array(1 => $fromDir)), '', 'alert');