3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
35 * class to provide simple static functions for file objects
37 class CRM_Utils_File
{
40 * Given a file name, determine if the file contents make it an ascii file
46 * true if file is ascii
48 public static function isAscii($name) {
49 $fd = fopen($name, "r");
56 $line = fgets($fd, 8192);
57 if (!CRM_Utils_String
::isAscii($line)) {
68 * Given a file name, determine if the file contents make it an html file
74 * true if file is html
76 public 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
104 * Should we abort or just return an invalid code.
106 * NULL: Folder already exists or was not specified.
107 * TRUE: Creation succeeded.
108 * FALSE: Creation failed.
110 public static function createDir($path, $abort = TRUE) {
111 if (is_dir($path) ||
empty($path)) {
115 CRM_Utils_File
::createDir(dirname($path), $abort);
116 if (@mkdir
($path, 0777) == FALSE) {
118 $docLink = CRM_Utils_System
::docURL2('Moving an Existing Installation to a New Server or Location', NULL, NULL, NULL, NULL, "wiki");
119 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>";
121 CRM_Utils_System
::civiExit();
131 * Delete a directory given a path name, delete children directories
132 * and files if needed
134 * @param string $target
137 * @param bool $verbose
141 public static function cleanDir($target, $rmdir = TRUE, $verbose = TRUE) {
142 static $exceptions = array('.', '..');
143 if ($target == '' ||
$target == '/') {
144 throw new Exception("Overly broad deletion");
147 if ($dh = @opendir
($target)) {
148 while (FALSE !== ($sibling = readdir($dh))) {
149 if (!in_array($sibling, $exceptions)) {
150 $object = $target . DIRECTORY_SEPARATOR
. $sibling;
152 if (is_dir($object)) {
153 CRM_Utils_File
::cleanDir($object, $rmdir, $verbose);
155 elseif (is_file($object)) {
156 if (!unlink($object)) {
157 CRM_Core_Session
::setStatus(ts('Unable to remove file %1', array(1 => $object)), ts('Warning'), 'error');
165 if (rmdir($target)) {
167 CRM_Core_Session
::setStatus(ts('Removed directory %1', array(1 => $target)), '', 'success');
172 CRM_Core_Session
::setStatus(ts('Unable to remove directory %1', array(1 => $target)), ts('Warning'), 'error');
179 * Concatenate several files.
181 * @param array $files
182 * List of file names.
183 * @param string $delim
184 * An optional delimiter to put between files.
187 public static function concat($files, $delim = '') {
190 foreach ($files as $file) {
194 $buf .= file_get_contents($file);
201 * @param string $source
202 * @param string $destination
204 public static function copyDir($source, $destination) {
205 if ($dh = opendir($source)) {
206 @mkdir
($destination);
207 while (FALSE !== ($file = readdir($dh))) {
208 if (($file != '.') && ($file != '..')) {
209 if (is_dir($source . DIRECTORY_SEPARATOR
. $file)) {
210 CRM_Utils_File
::copyDir($source . DIRECTORY_SEPARATOR
. $file, $destination . DIRECTORY_SEPARATOR
. $file);
213 copy($source . DIRECTORY_SEPARATOR
. $file, $destination . DIRECTORY_SEPARATOR
. $file);
222 * Given a file name, recode it (in place!) to UTF-8
224 * @param string $name
228 * whether the file was recoded properly
230 public static function toUtf8($name) {
231 static $config = NULL;
232 static $legacyEncoding = NULL;
233 if ($config == NULL) {
234 $config = CRM_Core_Config
::singleton();
235 $legacyEncoding = $config->legacyEncoding
;
238 if (!function_exists('iconv')) {
244 $contents = file_get_contents($name);
245 if ($contents === FALSE) {
249 $contents = iconv($legacyEncoding, 'UTF-8', $contents);
250 if ($contents === FALSE) {
254 $file = fopen($name, 'w');
255 if ($file === FALSE) {
259 $written = fwrite($file, $contents);
260 $closed = fclose($file);
261 if ($written === FALSE or !$closed) {
269 * Appends a slash to the end of a string if it doesn't already end with one
271 * @param string $path
272 * @param string $slash
276 public static function addTrailingSlash($path, $slash = NULL) {
278 // FIXME: Defaulting to backslash on windows systems can produce
279 // unexpected results, esp for URL strings which should always use forward-slashes.
280 // I think this fn should default to forward-slash instead.
281 $slash = DIRECTORY_SEPARATOR
;
283 if (!in_array(substr($path, -1, 1), array('/', '\\'))) {
290 * @param string|NULL $dsn
291 * Use NULL to load the default/active connection from CRM_Core_DAO.
292 * Otherwise, give a full DSN string.
293 * @param string $fileName
294 * @param null $prefix
295 * @param bool $isQueryString
296 * @param bool $dieOnErrors
298 public static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $isQueryString = FALSE, $dieOnErrors = TRUE) {
300 $db = CRM_Core_DAO
::getConnection();
303 require_once 'DB.php';
304 $db = DB
::connect($dsn);
307 if (PEAR
::isError($db)) {
308 die("Cannot open $dsn: " . $db->getMessage());
310 if (CRM_Utils_Constant
::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System
::isDevelopment())) {
311 $db->query('SET SESSION sql_mode = STRICT_TRANS_TABLES');
314 if (!$isQueryString) {
315 $string = $prefix . file_get_contents($fileName);
318 // use filename as query string
319 $string = $prefix . $fileName;
322 // get rid of comments starting with # and --
324 $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
325 $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
327 $queries = preg_split('/;\s*$/m', $string);
328 foreach ($queries as $query) {
329 $query = trim($query);
330 if (!empty($query)) {
331 CRM_Core_Error
::debug_query($query);
332 $res = &$db->query($query);
333 if (PEAR
::isError($res)) {
335 die("Cannot execute $query: " . $res->getMessage());
338 echo "Cannot execute $query: " . $res->getMessage() . "<p>";
350 public static function isExtensionSafe($ext) {
351 static $extensions = NULL;
353 $extensions = CRM_Core_OptionGroup
::values('safe_file_extension', TRUE);
355 // make extensions to lowercase
356 $extensions = array_change_key_case($extensions, CASE_LOWER
);
357 // allow html/htm extension ONLY if the user is admin
358 // and/or has access CiviMail
359 if (!(CRM_Core_Permission
::check('access CiviMail') ||
360 CRM_Core_Permission
::check('administer CiviCRM') ||
361 (CRM_Mailing_Info
::workflowEnabled() &&
362 CRM_Core_Permission
::check('create mailings')
366 unset($extensions['html']);
367 unset($extensions['htm']);
370 // support lower and uppercase file extensions
371 return isset($extensions[strtolower($ext)]) ?
TRUE : FALSE;
375 * Determine whether a given file is listed in the PHP include path.
377 * @param string $name
381 * whether the file can be include()d or require()d
383 public static function isIncludable($name) {
384 $x = @fopen
($name, 'r', TRUE);
395 * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it.
401 public static function cleanFileName($name) {
402 // replace the last 33 character before the '.' with null
403 $name = preg_replace('/(_[\w]{32})\./', '.', $name);
408 * @param string $name
412 public static function makeFileName($name) {
413 $uniqID = md5(uniqid(rand(), TRUE));
414 $info = pathinfo($name);
415 $basename = substr($info['basename'],
416 0, -(strlen(CRM_Utils_Array
::value('extension', $info)) +
(CRM_Utils_Array
::value('extension', $info) == '' ?
0 : 1))
418 if (!self
::isExtensionSafe(CRM_Utils_Array
::value('extension', $info))) {
419 // munge extension so it cannot have an embbeded dot in it
420 // The maximum length of a filename for most filesystems is 255 chars.
421 // We'll truncate at 240 to give some room for the extension.
422 return CRM_Utils_String
::munge("{$basename}_" . CRM_Utils_Array
::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown";
425 return CRM_Utils_String
::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array
::value('extension', $info);
435 public static function getFilesByExtension($path, $ext) {
436 $path = self
::addTrailingSlash($path);
438 if ($dh = opendir($path)) {
439 while (FALSE !== ($elem = readdir($dh))) {
440 if (substr($elem, -(strlen($ext) +
1)) == '.' . $ext) {
441 $files[] .= $path . $elem;
450 * Restrict access to a given directory (by planting there a restrictive .htaccess file)
453 * The directory to be secured.
454 * @param bool $overwrite
456 public static function restrictAccess($dir, $overwrite = FALSE) {
457 // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
458 // of site, causing site to stop functioning.
459 // FIXME: we should do more checks here -
460 if (!empty($dir) && is_dir($dir)) {
461 $htaccess = <<<HTACCESS
468 $file = $dir . '.htaccess';
469 if ($overwrite ||
!file_exists($file)) {
470 if (file_put_contents($file, $htaccess) === FALSE) {
471 CRM_Core_Error
::movedSiteError($file);
478 * Restrict remote users from browsing the given directory.
482 public static function restrictBrowsing($publicDir) {
483 if (!is_dir($publicDir) ||
!is_writable($publicDir)) {
488 $nobrowse = realpath($publicDir) . '/index.html';
489 if (!file_exists($nobrowse)) {
490 @file_put_contents
($nobrowse, '');
494 $dir = new RecursiveDirectoryIterator($publicDir);
495 foreach ($dir as $name => $object) {
496 if (is_dir($name) && $name != '..') {
497 $nobrowse = realpath($name) . '/index.html';
498 if (!file_exists($nobrowse)) {
499 @file_put_contents
($nobrowse, '');
506 * Create the base file path from which all our internal directories are
507 * offset. This is derived from the template compile directory set
509 public static function baseFilePath() {
510 static $_path = NULL;
512 // Note: Don't rely on $config; that creates a dependency loop.
513 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
514 throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR");
516 $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR
;
518 $path = dirname($templateCompileDir);
520 //this fix is to avoid creation of upload dirs inside templates_c directory
521 $checkPath = explode(DIRECTORY_SEPARATOR
, $path);
523 $cnt = count($checkPath) - 1;
524 if ($checkPath[$cnt] == 'templates_c') {
525 unset($checkPath[$cnt]);
526 $path = implode(DIRECTORY_SEPARATOR
, $checkPath);
529 $_path = CRM_Utils_File
::addTrailingSlash($path);
535 * Determine if a path is absolute.
537 * @param string $path
540 * TRUE if absolute. FALSE if relative.
542 public static function isAbsolute($path) {
543 if (substr($path, 0, 1) === DIRECTORY_SEPARATOR
) {
546 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
547 if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
559 public static function relativeDirectory($directory) {
560 // Do nothing on windows
561 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
565 // check if directory is relative, if so return immediately
566 if (!self
::isAbsolute($directory)) {
570 // make everything relative from the baseFilePath
571 $basePath = self
::baseFilePath();
572 // check if basePath is a substr of $directory, if so
573 // return rest of string
574 if (substr($directory, 0, strlen($basePath)) == $basePath) {
575 return substr($directory, strlen($basePath));
578 // return the original value
584 * @param string|NULL $basePath
585 * The base path when evaluating relative paths. Should include trailing slash.
589 public static function absoluteDirectory($directory, $basePath = NULL) {
590 // check if directory is already absolute, if so return immediately
591 // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
592 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
596 // check if directory is already absolute, if so return immediately
597 if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR
) {
601 // make everything absolute from the baseFilePath
602 $basePath = ($basePath === NULL) ? self
::baseFilePath() : $basePath;
604 return $basePath . $directory;
608 * Make a file path relative to some base dir.
615 public static function relativize($directory, $basePath) {
616 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
617 $directory = strtr($directory, '\\', '/');
618 $basePath = strtr($basePath, '\\', '/');
620 if (substr($directory, 0, strlen($basePath)) == $basePath) {
621 return substr($directory, strlen($basePath));
629 * Create a path to a temporary file which can endure for multiple requests.
631 * @todo Automatic file cleanup using, eg, TTL policy
633 * @param string $prefix
635 * @return string, path to an openable/writable file
638 public static function tempnam($prefix = 'tmp-') {
639 // $config = CRM_Core_Config::singleton();
640 // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
641 // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
642 $fileName = tempnam(sys_get_temp_dir(), $prefix);
647 * Create a path to a temporary directory which can endure for multiple requests.
649 * @todo Automatic file cleanup using, eg, TTL policy
651 * @param string $prefix
653 * @return string, path to an openable/writable directory; ends with '/'
656 public static function tempdir($prefix = 'tmp-') {
657 $fileName = self
::tempnam($prefix);
659 mkdir($fileName, 0700);
660 return $fileName . '/';
664 * Search directory tree for files which match a glob pattern.
666 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
670 * @param string $pattern
671 * glob pattern, eg "*.txt".
672 * @param bool $relative
673 * TRUE if paths should be made relative to $dir
674 * @return array(string)
676 public static function findFiles($dir, $pattern, $relative = FALSE) {
680 $dir = rtrim($dir, '/');
681 $todos = array($dir);
683 while (!empty($todos)) {
684 $subdir = array_shift($todos);
685 $matches = glob("$subdir/$pattern");
686 if (is_array($matches)) {
687 foreach ($matches as $match) {
688 if (!is_dir($match)) {
689 $result[] = $relative ? CRM_Utils_File
::relativize($match, "$dir/") : $match;
693 if ($dh = opendir($subdir)) {
694 while (FALSE !== ($entry = readdir($dh))) {
695 $path = $subdir . DIRECTORY_SEPARATOR
. $entry;
696 if ($entry{0} == '.') {
699 elseif (is_dir($path)) {
710 * Determine if $child is a sub-directory of $parent
712 * @param string $parent
713 * @param string $child
714 * @param bool $checkRealPath
718 public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
719 if ($checkRealPath) {
720 $parent = realpath($parent);
721 $child = realpath($child);
723 $parentParts = explode('/', rtrim($parent, '/'));
724 $childParts = explode('/', rtrim($child, '/'));
725 while (($parentPart = array_shift($parentParts)) !== NULL) {
726 $childPart = array_shift($childParts);
727 if ($parentPart != $childPart) {
731 if (empty($childParts)) {
732 return FALSE; // same directory
740 * Move $fromDir to $toDir, replacing/deleting any
741 * pre-existing content.
743 * @param string $fromDir
744 * The directory which should be moved.
745 * @param string $toDir
746 * The new location of the directory.
747 * @param bool $verbose
752 public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
753 if (is_dir($toDir)) {
754 if (!self
::cleanDir($toDir, TRUE, $verbose)) {
759 // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
761 CRM_Utils_File
::copyDir($fromDir, $toDir);
762 if (!CRM_Utils_File
::cleanDir($fromDir, TRUE, FALSE)) {
763 CRM_Core_Session
::setStatus(ts('Failed to clean temp dir: %1', array(1 => $fromDir)), '', 'alert');