3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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 == '/' ||
!$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 * Save a fake file somewhere
293 * The directory where the file should be saved.
294 * @param string $contents
295 * Optional: the contents of the file.
296 * @param string $fileName
299 * The filename saved, or FALSE on failure.
301 public static function createFakeFile($dir, $contents = 'delete me', $fileName = NULL) {
302 $dir = self
::addTrailingSlash($dir);
304 $fileName = 'delete-this-' . CRM_Utils_String
::createRandom(10, CRM_Utils_String
::ALPHANUMERIC
);
306 $success = file_put_contents($dir . $fileName, $contents);
308 return ($success === FALSE) ?
FALSE : $fileName;
312 * @param string|NULL $dsn
313 * Use NULL to load the default/active connection from CRM_Core_DAO.
314 * Otherwise, give a full DSN string.
315 * @param string $fileName
316 * @param null $prefix
317 * @param bool $isQueryString
318 * @param bool $dieOnErrors
320 public static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $isQueryString = FALSE, $dieOnErrors = TRUE) {
322 $db = CRM_Core_DAO
::getConnection();
325 require_once 'DB.php';
326 $db = DB
::connect($dsn);
329 if (PEAR
::isError($db)) {
330 die("Cannot open $dsn: " . $db->getMessage());
332 if (CRM_Utils_Constant
::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System
::isDevelopment())) {
333 $db->query('SET SESSION sql_mode = STRICT_TRANS_TABLES');
335 $db->query('SET NAMES utf8');
336 $transactionId = CRM_Utils_Type
::escape(CRM_Utils_Request
::id(), 'String');
337 $db->query('SET @uniqueID = ' . "'$transactionId'");
339 if (!$isQueryString) {
340 $string = $prefix . file_get_contents($fileName);
343 // use filename as query string
344 $string = $prefix . $fileName;
347 // get rid of comments starting with # and --
349 $string = self
::stripComments($string);
351 $queries = preg_split('/;\s*$/m', $string);
352 foreach ($queries as $query) {
353 $query = trim($query);
354 if (!empty($query)) {
355 CRM_Core_Error
::debug_query($query);
356 $res = &$db->query($query);
357 if (PEAR
::isError($res)) {
359 die("Cannot execute $query: " . $res->getMessage());
362 echo "Cannot execute $query: " . $res->getMessage() . "<p>";
370 * Strips comment from a possibly multiline SQL string
372 * @param string $string
377 public static function stripComments($string) {
378 return preg_replace("/^(#|--).*\R*/m", "", $string);
386 public static function isExtensionSafe($ext) {
387 static $extensions = NULL;
389 $extensions = CRM_Core_OptionGroup
::values('safe_file_extension', TRUE);
391 // make extensions to lowercase
392 $extensions = array_change_key_case($extensions, CASE_LOWER
);
393 // allow html/htm extension ONLY if the user is admin
394 // and/or has access CiviMail
395 if (!(CRM_Core_Permission
::check('access CiviMail') ||
396 CRM_Core_Permission
::check('administer CiviCRM') ||
397 (CRM_Mailing_Info
::workflowEnabled() &&
398 CRM_Core_Permission
::check('create mailings')
402 unset($extensions['html']);
403 unset($extensions['htm']);
406 // support lower and uppercase file extensions
407 return isset($extensions[strtolower($ext)]) ?
TRUE : FALSE;
411 * Determine whether a given file is listed in the PHP include path.
413 * @param string $name
417 * whether the file can be include()d or require()d
419 public static function isIncludable($name) {
420 $x = @fopen
($name, 'r', TRUE);
431 * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it.
437 public static function cleanFileName($name) {
438 // replace the last 33 character before the '.' with null
439 $name = preg_replace('/(_[\w]{32})\./', '.', $name);
444 * Make a valid file name.
446 * @param string $name
450 public static function makeFileName($name) {
451 $uniqID = md5(uniqid(rand(), TRUE));
452 $info = pathinfo($name);
453 $basename = substr($info['basename'],
454 0, -(strlen(CRM_Utils_Array
::value('extension', $info)) +
(CRM_Utils_Array
::value('extension', $info) == '' ?
0 : 1))
456 if (!self
::isExtensionSafe(CRM_Utils_Array
::value('extension', $info))) {
457 // munge extension so it cannot have an embbeded dot in it
458 // The maximum length of a filename for most filesystems is 255 chars.
459 // We'll truncate at 240 to give some room for the extension.
460 return CRM_Utils_String
::munge("{$basename}_" . CRM_Utils_Array
::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown";
463 return CRM_Utils_String
::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array
::value('extension', $info);
473 public static function duplicate($filePath) {
474 $oldName = pathinfo($filePath, PATHINFO_FILENAME
);
475 $uniqID = md5(uniqid(rand(), TRUE));
476 $newName = preg_replace('/(_[\w]{32})$/', '', $oldName) . '_' . $uniqID;
477 $newPath = str_replace($oldName, $newName, $filePath);
478 copy($filePath, $newPath);
483 * Get files for the extension.
485 * @param string $path
490 public static function getFilesByExtension($path, $ext) {
491 $path = self
::addTrailingSlash($path);
493 if ($dh = opendir($path)) {
494 while (FALSE !== ($elem = readdir($dh))) {
495 if (substr($elem, -(strlen($ext) +
1)) == '.' . $ext) {
496 $files[] .= $path . $elem;
505 * Restrict access to a given directory (by planting there a restrictive .htaccess file)
508 * The directory to be secured.
509 * @param bool $overwrite
511 public static function restrictAccess($dir, $overwrite = FALSE) {
512 // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
513 // of site, causing site to stop functioning.
514 // FIXME: we should do more checks here -
515 if (!empty($dir) && is_dir($dir)) {
516 $htaccess = <<<HTACCESS
523 $file = $dir . '.htaccess';
524 if ($overwrite ||
!file_exists($file)) {
525 if (file_put_contents($file, $htaccess) === FALSE) {
526 CRM_Core_Error
::movedSiteError($file);
533 * Restrict remote users from browsing the given directory.
537 public static function restrictBrowsing($publicDir) {
538 if (!is_dir($publicDir) ||
!is_writable($publicDir)) {
543 $nobrowse = realpath($publicDir) . '/index.html';
544 if (!file_exists($nobrowse)) {
545 @file_put_contents
($nobrowse, '');
549 $dir = new RecursiveDirectoryIterator($publicDir);
550 foreach ($dir as $name => $object) {
551 if (is_dir($name) && $name != '..') {
552 $nobrowse = realpath($name) . '/index.html';
553 if (!file_exists($nobrowse)) {
554 @file_put_contents
($nobrowse, '');
561 * Create the base file path from which all our internal directories are
562 * offset. This is derived from the template compile directory set
564 public static function baseFilePath() {
565 static $_path = NULL;
567 // Note: Don't rely on $config; that creates a dependency loop.
568 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
569 throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR");
571 $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR
;
573 $path = dirname($templateCompileDir);
575 //this fix is to avoid creation of upload dirs inside templates_c directory
576 $checkPath = explode(DIRECTORY_SEPARATOR
, $path);
578 $cnt = count($checkPath) - 1;
579 if ($checkPath[$cnt] == 'templates_c') {
580 unset($checkPath[$cnt]);
581 $path = implode(DIRECTORY_SEPARATOR
, $checkPath);
584 $_path = CRM_Utils_File
::addTrailingSlash($path);
590 * Determine if a path is absolute.
592 * @param string $path
595 * TRUE if absolute. FALSE if relative.
597 public static function isAbsolute($path) {
598 if (substr($path, 0, 1) === DIRECTORY_SEPARATOR
) {
601 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
602 if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
614 public static function relativeDirectory($directory) {
615 // Do nothing on windows
616 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
620 // check if directory is relative, if so return immediately
621 if (!self
::isAbsolute($directory)) {
625 // make everything relative from the baseFilePath
626 $basePath = self
::baseFilePath();
627 // check if basePath is a substr of $directory, if so
628 // return rest of string
629 if (substr($directory, 0, strlen($basePath)) == $basePath) {
630 return substr($directory, strlen($basePath));
633 // return the original value
639 * @param string|NULL $basePath
640 * The base path when evaluating relative paths. Should include trailing slash.
644 public static function absoluteDirectory($directory, $basePath = NULL) {
645 // check if directory is already absolute, if so return immediately
646 // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
647 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
651 // check if directory is already absolute, if so return immediately
652 if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR
) {
656 // make everything absolute from the baseFilePath
657 $basePath = ($basePath === NULL) ? self
::baseFilePath() : $basePath;
659 // ensure that $basePath has a trailing slash
660 $basePath = self
::addTrailingSlash($basePath);
661 return $basePath . $directory;
665 * Make a file path relative to some base dir.
672 public static function relativize($directory, $basePath) {
673 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
674 $directory = strtr($directory, '\\', '/');
675 $basePath = strtr($basePath, '\\', '/');
677 if (substr($directory, 0, strlen($basePath)) == $basePath) {
678 return substr($directory, strlen($basePath));
686 * Create a path to a temporary file which can endure for multiple requests.
688 * @todo Automatic file cleanup using, eg, TTL policy
690 * @param string $prefix
692 * @return string, path to an openable/writable file
695 public static function tempnam($prefix = 'tmp-') {
696 // $config = CRM_Core_Config::singleton();
697 // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
698 // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
699 $fileName = tempnam(sys_get_temp_dir(), $prefix);
704 * Create a path to a temporary directory which can endure for multiple requests.
706 * @todo Automatic file cleanup using, eg, TTL policy
708 * @param string $prefix
710 * @return string, path to an openable/writable directory; ends with '/'
713 public static function tempdir($prefix = 'tmp-') {
714 $fileName = self
::tempnam($prefix);
716 mkdir($fileName, 0700);
717 return $fileName . '/';
721 * Search directory tree for files which match a glob pattern.
723 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
727 * @param string $pattern
728 * glob pattern, eg "*.txt".
729 * @param bool $relative
730 * TRUE if paths should be made relative to $dir
731 * @return array(string)
733 public static function findFiles($dir, $pattern, $relative = FALSE) {
737 $dir = rtrim($dir, '/');
738 $todos = array($dir);
740 while (!empty($todos)) {
741 $subdir = array_shift($todos);
742 $matches = glob("$subdir/$pattern");
743 if (is_array($matches)) {
744 foreach ($matches as $match) {
745 if (!is_dir($match)) {
746 $result[] = $relative ? CRM_Utils_File
::relativize($match, "$dir/") : $match;
750 if ($dh = opendir($subdir)) {
751 while (FALSE !== ($entry = readdir($dh))) {
752 $path = $subdir . DIRECTORY_SEPARATOR
. $entry;
753 if ($entry{0} == '.') {
756 elseif (is_dir($path)) {
767 * Determine if $child is a sub-directory of $parent
769 * @param string $parent
770 * @param string $child
771 * @param bool $checkRealPath
775 public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
776 if ($checkRealPath) {
777 $parent = realpath($parent);
778 $child = realpath($child);
780 $parentParts = explode('/', rtrim($parent, '/'));
781 $childParts = explode('/', rtrim($child, '/'));
782 while (($parentPart = array_shift($parentParts)) !== NULL) {
783 $childPart = array_shift($childParts);
784 if ($parentPart != $childPart) {
788 if (empty($childParts)) {
789 return FALSE; // same directory
797 * Move $fromDir to $toDir, replacing/deleting any
798 * pre-existing content.
800 * @param string $fromDir
801 * The directory which should be moved.
802 * @param string $toDir
803 * The new location of the directory.
804 * @param bool $verbose
809 public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
810 if (is_dir($toDir)) {
811 if (!self
::cleanDir($toDir, TRUE, $verbose)) {
816 // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
818 CRM_Utils_File
::copyDir($fromDir, $toDir);
819 if (!CRM_Utils_File
::cleanDir($fromDir, TRUE, FALSE)) {
820 CRM_Core_Session
::setStatus(ts('Failed to clean temp dir: %1', array(1 => $fromDir)), '', 'alert');
829 * @param array $param
830 * @param string $fileName
831 * @param array $extraParams
833 public static function formatFile(&$param, $fileName, $extraParams = array()) {
834 if (empty($param[$fileName])) {
839 'uri' => $param[$fileName]['name'],
840 'type' => $param[$fileName]['type'],
841 'location' => $param[$fileName]['name'],
842 'upload_date' => date('YmdHis'),
845 $param[$fileName] = $fileParams;
849 * Return formatted file URL, like for image file return image url with image icon
851 * @param string $path
853 * @param string $fileType
855 * File preview link e.g. https://example.com/civicrm/file?reset=1&filename=image.png&mime-type=image/png
857 * @return string $url
859 public static function getFileURL($path, $fileType, $url = NULL) {
860 if (empty($path) ||
empty($fileType)) {
863 elseif (empty($url)) {
864 $fileName = basename($path);
865 $url = CRM_Utils_System
::url('civicrm/file', "reset=1&filename={$fileName}&mime-type={$fileType}");
874 list($imageWidth, $imageHeight) = getimagesize($path);
875 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
876 $url = "<a href=\"$url\" class='crm-image-popup'>
877 <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
882 $url = sprintf('<a href="%s">%s</a>', $url, basename($path));
890 * Return formatted image icon
892 * @param string $imageURL
893 * Contact's image url
895 * @return string $url
897 public static function getImageURL($imageURL) {
898 // retrieve image name from $imageURL
899 $imageURL = CRM_Utils_String
::unstupifyUrl($imageURL);
900 parse_str(parse_url($imageURL, PHP_URL_QUERY
), $query);
902 $path = CRM_Core_Config
::singleton()->customFileUploadDir
. $query['photo'];
903 $mimeType = 'image/' . strtolower(pathinfo($path, PATHINFO_EXTENSION
));
905 return self
::getFileURL($path, $mimeType);
910 * Get file icon class for specific MIME Type
912 * @param string $mimeType
915 public static function getIconFromMimeType($mimeType) {
916 if (!isset(Civi
::$statics[__CLASS__
]['mimeIcons'])) {
917 Civi
::$statics[__CLASS__
]['mimeIcons'] = json_decode(file_get_contents(__DIR__
. '/File/mimeIcons.json'), TRUE);
919 $iconClasses = Civi
::$statics[__CLASS__
]['mimeIcons'];
920 foreach ($iconClasses as $text => $icon) {
921 if (strpos($mimeType, $text) === 0) {
925 return $iconClasses['*'];