3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * class to provide simple static functions for file objects
21 class CRM_Utils_File
{
24 * Given a file name, determine if the file contents make it an ascii file
30 * true if file is ascii
32 public static function isAscii($name) {
33 $fd = fopen($name, "r");
40 $line = fgets($fd, 8192);
41 if (!CRM_Utils_String
::isAscii($line)) {
52 * Given a file name, determine if the file contents make it an html file
58 * true if file is html
60 public static function isHtml($name) {
61 $fd = fopen($name, "r");
68 while (!feof($fd) & $lineCount <= 5) {
70 $line = fgets($fd, 8192);
71 if (!CRM_Utils_String
::isHtml($line)) {
82 * Create a directory given a path name, creates parent directories
88 * Should we abort or just return an invalid code.
90 * NULL: Folder already exists or was not specified.
91 * TRUE: Creation succeeded.
92 * FALSE: Creation failed.
94 public static function createDir($path, $abort = TRUE) {
95 if (is_dir($path) ||
empty($path)) {
99 CRM_Utils_File
::createDir(dirname($path), $abort);
100 if (@mkdir
($path, 0777) == FALSE) {
102 $docLink = CRM_Utils_System
::docURL2('Moving an Existing Installation to a New Server or Location', NULL, NULL, NULL, NULL, "wiki");
103 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>";
105 CRM_Utils_System
::civiExit();
115 * Delete a directory given a path name, delete children directories
116 * and files if needed
118 * @param string $target
121 * @param bool $verbose
125 public static function cleanDir($target, $rmdir = TRUE, $verbose = TRUE) {
126 static $exceptions = ['.', '..'];
127 if ($target == '' ||
$target == '/' ||
!$target) {
128 throw new Exception("Overly broad deletion");
131 if ($dh = @opendir
($target)) {
132 while (FALSE !== ($sibling = readdir($dh))) {
133 if (!in_array($sibling, $exceptions)) {
134 $object = $target . DIRECTORY_SEPARATOR
. $sibling;
136 if (is_dir($object)) {
137 CRM_Utils_File
::cleanDir($object, $rmdir, $verbose);
139 elseif (is_file($object)) {
140 if (!unlink($object)) {
141 CRM_Core_Session
::setStatus(ts('Unable to remove file %1', [1 => $object]), ts('Warning'), 'error');
149 if (rmdir($target)) {
151 CRM_Core_Session
::setStatus(ts('Removed directory %1', [1 => $target]), '', 'success');
156 CRM_Core_Session
::setStatus(ts('Unable to remove directory %1', [1 => $target]), ts('Warning'), 'error');
163 * Concatenate several files.
165 * @param array $files
166 * List of file names.
167 * @param string $delim
168 * An optional delimiter to put between files.
171 public static function concat($files, $delim = '') {
174 foreach ($files as $file) {
178 $buf .= file_get_contents($file);
185 * @param string $source
186 * @param string $destination
188 public static function copyDir($source, $destination) {
189 if ($dh = opendir($source)) {
190 @mkdir
($destination);
191 while (FALSE !== ($file = readdir($dh))) {
192 if (($file != '.') && ($file != '..')) {
193 if (is_dir($source . DIRECTORY_SEPARATOR
. $file)) {
194 CRM_Utils_File
::copyDir($source . DIRECTORY_SEPARATOR
. $file, $destination . DIRECTORY_SEPARATOR
. $file);
197 copy($source . DIRECTORY_SEPARATOR
. $file, $destination . DIRECTORY_SEPARATOR
. $file);
206 * Given a file name, recode it (in place!) to UTF-8
208 * @param string $name
212 * whether the file was recoded properly
214 public static function toUtf8($name) {
215 static $config = NULL;
216 static $legacyEncoding = NULL;
217 if ($config == NULL) {
218 $config = CRM_Core_Config
::singleton();
219 $legacyEncoding = $config->legacyEncoding
;
222 if (!function_exists('iconv')) {
228 $contents = file_get_contents($name);
229 if ($contents === FALSE) {
233 $contents = iconv($legacyEncoding, 'UTF-8', $contents);
234 if ($contents === FALSE) {
238 $file = fopen($name, 'w');
239 if ($file === FALSE) {
243 $written = fwrite($file, $contents);
244 $closed = fclose($file);
245 if ($written === FALSE or !$closed) {
253 * Appends a slash to the end of a string if it doesn't already end with one
255 * @param string $path
256 * @param string $slash
260 public static function addTrailingSlash($path, $slash = NULL) {
262 // FIXME: Defaulting to backslash on windows systems can produce
263 // unexpected results, esp for URL strings which should always use forward-slashes.
264 // I think this fn should default to forward-slash instead.
265 $slash = DIRECTORY_SEPARATOR
;
267 if (!in_array(substr($path, -1, 1), ['/', '\\'])) {
274 * Save a fake file somewhere
277 * The directory where the file should be saved.
278 * @param string $contents
279 * Optional: the contents of the file.
280 * @param string $fileName
283 * The filename saved, or FALSE on failure.
285 public static function createFakeFile($dir, $contents = 'delete me', $fileName = NULL) {
286 $dir = self
::addTrailingSlash($dir);
288 $fileName = 'delete-this-' . CRM_Utils_String
::createRandom(10, CRM_Utils_String
::ALPHANUMERIC
);
290 $success = @file_put_contents
($dir . $fileName, $contents);
292 return ($success === FALSE) ?
FALSE : $fileName;
296 * @param string|NULL $dsn
297 * Use NULL to load the default/active connection from CRM_Core_DAO.
298 * Otherwise, give a full DSN string.
299 * @param string $fileName
300 * @param string $prefix
301 * @param bool $dieOnErrors
303 public static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $dieOnErrors = TRUE) {
304 if (FALSE === file_get_contents($fileName)) {
305 // Our file cannot be found.
306 // Using 'die' here breaks this on extension upgrade.
307 throw new CRM_Core_Exception('Could not find the SQL file.');
310 self
::runSqlQuery($dsn, file_get_contents($fileName), $prefix, $dieOnErrors);
315 * @param string|NULL $dsn
316 * @param string $queryString
317 * @param string $prefix
318 * @param bool $dieOnErrors
320 public static function runSqlQuery($dsn, $queryString, $prefix = NULL, $dieOnErrors = TRUE) {
321 $string = $prefix . $queryString;
324 $db = CRM_Core_DAO
::getConnection();
327 require_once 'DB.php';
328 $dsn = CRM_Utils_SQL
::autoSwitchDSN($dsn);
330 $options = CRM_Utils_SQL
::isSSLDSN($dsn) ?
['ssl' => TRUE] : [];
331 $db = DB
::connect($dsn, $options);
333 catch (Exception
$e) {
334 die("Cannot open $dsn: " . $e->getMessage());
338 $db->query('SET NAMES utf8mb4');
339 $transactionId = CRM_Utils_Type
::escape(CRM_Utils_Request
::id(), 'String');
340 $db->query('SET @uniqueID = ' . "'$transactionId'");
342 // get rid of comments starting with # and --
344 $string = self
::stripComments($string);
346 $queries = preg_split('/;\s*$/m', $string);
347 foreach ($queries as $query) {
348 $query = trim($query);
349 if (!empty($query)) {
350 CRM_Core_Error
::debug_query($query);
352 $res = &$db->query($query);
354 catch (Exception
$e) {
356 die("Cannot execute $query: " . $e->getMessage());
359 echo "Cannot execute $query: " . $e->getMessage() . "<p>";
368 * Strips comment from a possibly multiline SQL string
370 * @param string $string
375 public static function stripComments($string) {
376 return preg_replace("/^(#|--).*\R*/m", "", $string);
384 public static function isExtensionSafe($ext) {
385 static $extensions = NULL;
387 $extensions = CRM_Core_OptionGroup
::values('safe_file_extension', TRUE);
389 // make extensions to lowercase
390 $extensions = array_change_key_case($extensions, CASE_LOWER
);
391 // allow html/htm extension ONLY if the user is admin
392 // and/or has access CiviMail
393 if (!(CRM_Core_Permission
::check('access CiviMail') ||
394 CRM_Core_Permission
::check('administer CiviCRM') ||
395 (CRM_Mailing_Info
::workflowEnabled() &&
396 CRM_Core_Permission
::check('create mailings')
400 unset($extensions['html']);
401 unset($extensions['htm']);
404 // support lower and uppercase file extensions
405 return (bool) isset($extensions[strtolower($ext)]);
409 * Determine whether a given file is listed in the PHP include path.
411 * @param string $name
415 * whether the file can be include()d or require()d
417 public static function isIncludable($name) {
418 $full_filepath = stream_resolve_include_path($name);
419 if ($full_filepath === FALSE) {
422 return is_readable($full_filepath);
426 * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it.
432 public static function cleanFileName($name) {
433 // replace the last 33 character before the '.' with null
434 $name = preg_replace('/(_[\w]{32})\./', '.', $name);
439 * Make a valid file name.
441 * @param string $name
445 public static function makeFileName($name) {
446 $uniqID = md5(uniqid(rand(), TRUE));
447 $info = pathinfo($name);
448 $basename = substr($info['basename'],
449 0, -(strlen(CRM_Utils_Array
::value('extension', $info)) +
(CRM_Utils_Array
::value('extension', $info) == '' ?
0 : 1))
451 if (!self
::isExtensionSafe(CRM_Utils_Array
::value('extension', $info))) {
452 // munge extension so it cannot have an embbeded dot in it
453 // The maximum length of a filename for most filesystems is 255 chars.
454 // We'll truncate at 240 to give some room for the extension.
455 return CRM_Utils_String
::munge("{$basename}_" . CRM_Utils_Array
::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown";
458 return CRM_Utils_String
::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array
::value('extension', $info);
463 * CRM_Utils_String::munge() doesn't handle unicode and needs to be able
464 * to generate valid database tablenames so will sometimes generate a
465 * random string. Here what we want is a human-sensible filename that might
467 * Note that this does filter out emojis and such, but keeps characters that
468 * are considered alphanumeric in non-english languages.
470 * @param string $input
471 * @param string $replacementString Character or string to replace invalid characters with. Can be the empty string.
472 * @param int $cutoffLength Length to truncate the result after replacements.
475 public static function makeFilenameWithUnicode(string $input, string $replacementString = '_', int $cutoffLength = 63): string {
476 $filename = preg_replace('/\W/u', $replacementString, $input);
478 return mb_substr($filename, 0, $cutoffLength);
489 public static function duplicate($filePath) {
490 $oldName = pathinfo($filePath, PATHINFO_FILENAME
);
491 $uniqID = md5(uniqid(rand(), TRUE));
492 $newName = preg_replace('/(_[\w]{32})$/', '', $oldName) . '_' . $uniqID;
493 $newPath = str_replace($oldName, $newName, $filePath);
494 copy($filePath, $newPath);
499 * Get files for the extension.
501 * @param string $path
506 public static function getFilesByExtension($path, $ext) {
507 $path = self
::addTrailingSlash($path);
509 if ($dh = opendir($path)) {
510 while (FALSE !== ($elem = readdir($dh))) {
511 if (substr($elem, -(strlen($ext) +
1)) == '.' . $ext) {
512 $files[] .= $path . $elem;
521 * Restrict access to a given directory (by planting there a restrictive .htaccess file)
524 * The directory to be secured.
525 * @param bool $overwrite
527 public static function restrictAccess($dir, $overwrite = FALSE) {
528 // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
529 // of site, causing site to stop functioning.
530 // FIXME: we should do more checks here -
531 if (!empty($dir) && is_dir($dir)) {
532 $htaccess = <<<HTACCESS
535 <IfModule !authz_core_module>
541 <IfModule authz_core_module>
547 $file = $dir . '.htaccess';
548 if ($overwrite ||
!file_exists($file)) {
549 if (file_put_contents($file, $htaccess) === FALSE) {
550 CRM_Core_Error
::movedSiteError($file);
557 * Restrict remote users from browsing the given directory.
561 public static function restrictBrowsing($publicDir) {
562 if (!is_dir($publicDir) ||
!is_writable($publicDir)) {
567 $nobrowse = realpath($publicDir) . '/index.html';
568 if (!file_exists($nobrowse)) {
569 @file_put_contents
($nobrowse, '');
573 $dir = new RecursiveDirectoryIterator($publicDir);
574 foreach ($dir as $name => $object) {
575 if (is_dir($name) && $name != '..') {
576 $nobrowse = realpath($name) . '/index.html';
577 if (!file_exists($nobrowse)) {
578 @file_put_contents
($nobrowse, '');
585 * (Deprecated) Create the file-path from which all other internal paths are
586 * computed. This implementation determines it as `dirname(CIVICRM_TEMPLATE_COMPILEDIR)`.
588 * This approach is problematic - e.g. it prevents one from authentically
589 * splitting the CIVICRM_TEMPLATE_COMPILEDIR away from other dirs. The implementation
590 * is preserved for backwards compatibility (and should only be called by
591 * CMS-adapters and by Civi\Core\Paths).
593 * Do not use it for new path construction logic. Instead, use Civi::paths().
596 * @see \Civi::paths()
597 * @see \Civi\Core\Paths
599 public static function baseFilePath() {
600 static $_path = NULL;
602 // Note: Don't rely on $config; that creates a dependency loop.
603 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
604 throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR");
606 $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR
;
608 $path = dirname($templateCompileDir);
610 //this fix is to avoid creation of upload dirs inside templates_c directory
611 $checkPath = explode(DIRECTORY_SEPARATOR
, $path);
613 $cnt = count($checkPath) - 1;
614 if ($checkPath[$cnt] == 'templates_c') {
615 unset($checkPath[$cnt]);
616 $path = implode(DIRECTORY_SEPARATOR
, $checkPath);
619 $_path = CRM_Utils_File
::addTrailingSlash($path);
625 * Determine if a path is absolute.
627 * @param string $path
630 * TRUE if absolute. FALSE if relative.
632 public static function isAbsolute($path) {
633 if (substr($path, 0, 1) === DIRECTORY_SEPARATOR
) {
636 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
637 if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
646 * @param string $basePath
647 * The base path when evaluating relative paths. Should include trailing slash.
651 public static function absoluteDirectory($directory, $basePath) {
652 // check if directory is already absolute, if so return immediately
653 // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
654 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
658 // check if directory is already absolute, if so return immediately
659 if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR
) {
663 if ($basePath === NULL) {
664 // Previous versions interpreted `NULL` to mean "default to `self::baseFilePath()`".
665 // However, no code in the known `universe` relies on this interpretation, and
666 // the `baseFilePath()` function is problematic/deprecated.
667 throw new \
RuntimeException("absoluteDirectory() requires specifying a basePath");
670 // ensure that $basePath has a trailing slash
671 $basePath = self
::addTrailingSlash($basePath);
672 return $basePath . $directory;
676 * Make a file path relative to some base dir.
683 public static function relativize($directory, $basePath) {
684 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
685 $directory = strtr($directory, '\\', '/');
686 $basePath = strtr($basePath, '\\', '/');
688 if (substr($directory, 0, strlen($basePath)) == $basePath) {
689 return substr($directory, strlen($basePath));
697 * Create a path to a temporary file which can endure for multiple requests.
699 * @todo Automatic file cleanup using, eg, TTL policy
701 * @param string $prefix
703 * @return string, path to an openable/writable file
706 public static function tempnam($prefix = 'tmp-') {
707 // $config = CRM_Core_Config::singleton();
708 // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
709 // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
710 $fileName = tempnam(sys_get_temp_dir(), $prefix);
715 * Create a path to a temporary directory which can endure for multiple requests.
717 * @todo Automatic file cleanup using, eg, TTL policy
719 * @param string $prefix
721 * @return string, path to an openable/writable directory; ends with '/'
724 public static function tempdir($prefix = 'tmp-') {
725 $fileName = self
::tempnam($prefix);
727 mkdir($fileName, 0700);
728 return $fileName . '/';
732 * Search directory tree for files which match a glob pattern.
734 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
738 * @param string $pattern
739 * glob pattern, eg "*.txt".
740 * @param bool $relative
741 * TRUE if paths should be made relative to $dir
742 * @return array(string)
744 public static function findFiles($dir, $pattern, $relative = FALSE) {
745 if (!is_dir($dir) ||
!is_readable($dir)) {
748 // Which dirs should we exclude from our searches?
749 // If not defined, we default to excluding any dirname that begins
750 // with a . which is the old behaviour and therefore excludes .git/
751 $excludeDirsPattern = defined('CIVICRM_EXCLUDE_DIRS_PATTERN')
752 ?
constant('CIVICRM_EXCLUDE_DIRS_PATTERN')
753 : '@' . preg_quote(DIRECTORY_SEPARATOR
) . '\.@';
755 $dir = rtrim($dir, '/');
758 while (!empty($todos)) {
759 $subdir = array_shift($todos);
760 $matches = glob("$subdir/$pattern");
761 if (is_array($matches)) {
762 foreach ($matches as $match) {
763 if (!is_dir($match)) {
764 $result[] = $relative ? CRM_Utils_File
::relativize($match, "$dir/") : $match;
768 // Find subdirs to recurse into.
769 if ($dh = opendir($subdir)) {
770 while (FALSE !== ($entry = readdir($dh))) {
771 $path = $subdir . DIRECTORY_SEPARATOR
. $entry;
772 // Exclude . (self) and .. (parent) to avoid infinite loop.
773 // Exclude configured exclude dirs.
774 // Exclude dirs we can't read.
775 // Exclude anything that's not a dir.
779 && (empty($excludeDirsPattern) ||
!preg_match($excludeDirsPattern, $path))
781 && is_readable($path)
793 * Determine if $child is a sub-directory of $parent
795 * @param string $parent
796 * @param string $child
797 * @param bool $checkRealPath
801 public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
802 if ($checkRealPath) {
803 $parent = realpath($parent);
804 $child = realpath($child);
805 if ($parent === FALSE ||
$child === FALSE) {
809 $parentParts = explode('/', rtrim($parent, '/'));
810 $childParts = explode('/', rtrim($child, '/'));
811 while (($parentPart = array_shift($parentParts)) !== NULL) {
812 $childPart = array_shift($childParts);
813 if ($parentPart != $childPart) {
817 if (empty($childParts)) {
827 * Move $fromDir to $toDir, replacing/deleting any
828 * pre-existing content.
830 * @param string $fromDir
831 * The directory which should be moved.
832 * @param string $toDir
833 * The new location of the directory.
834 * @param bool $verbose
839 public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
840 if (is_dir($toDir)) {
841 if (!self
::cleanDir($toDir, TRUE, $verbose)) {
846 // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
848 CRM_Utils_File
::copyDir($fromDir, $toDir);
849 if (!CRM_Utils_File
::cleanDir($fromDir, TRUE, FALSE)) {
850 CRM_Core_Session
::setStatus(ts('Failed to clean temp dir: %1', [1 => $fromDir]), '', 'alert');
859 * @param array $param
860 * @param string $fileName
861 * @param array $extraParams
863 public static function formatFile(&$param, $fileName, $extraParams = []) {
864 if (empty($param[$fileName])) {
869 'uri' => $param[$fileName]['name'],
870 'type' => $param[$fileName]['type'],
871 'location' => $param[$fileName]['name'],
872 'upload_date' => date('YmdHis'),
875 $param[$fileName] = $fileParams;
879 * Return formatted file URL, like for image file return image url with image icon
881 * @param string $path
883 * @param string $fileType
885 * File preview link e.g. https://example.com/civicrm/file?reset=1&filename=image.png&mime-type=image/png
887 * @return string $url
889 public static function getFileURL($path, $fileType, $url = NULL) {
890 if (empty($path) ||
empty($fileType)) {
893 elseif (empty($url)) {
894 $fileName = basename($path);
895 $url = CRM_Utils_System
::url('civicrm/file', "reset=1&filename={$fileName}&mime-type={$fileType}");
904 list($imageWidth, $imageHeight) = getimagesize($path);
905 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
906 $url = "<a href=\"$url\" class='crm-image-popup'>
907 <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
912 $url = sprintf('<a href="%s">%s</a>', $url, self
::cleanFileName(basename($path)));
920 * Return formatted image icon
922 * @param string $imageURL
923 * Contact's image url
925 * @return string $url
927 public static function getImageURL($imageURL) {
928 // retrieve image name from $imageURL
929 $imageURL = CRM_Utils_String
::unstupifyUrl($imageURL);
930 parse_str(parse_url($imageURL, PHP_URL_QUERY
), $query);
933 if (!empty($query['photo'])) {
934 $path = CRM_Core_Config
::singleton()->customFileUploadDir
. $query['photo'];
937 $path = $url = $imageURL;
939 $fileExtension = strtolower(pathinfo($path, PATHINFO_EXTENSION
));
940 //According to (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types),
941 // there are some extensions that would need translating.:
942 $translateMimeTypes = [
947 $mimeType = 'image/' . CRM_Utils_Array
::value(
953 return self
::getFileURL($path, $mimeType, $url);
959 * @param string $sourceFile
960 * Filesystem path to existing image on server
961 * @param int $targetWidth
962 * New width desired, in pixels
963 * @param int $targetHeight
964 * New height desired, in pixels
965 * @param string $suffix = ""
966 * If supplied, the image will be renamed to include this suffix. For
967 * example if the original file name is "foo.png" and $suffix = "_bar",
968 * then the final file name will be "foo_bar.png".
969 * @param bool $preserveAspect = TRUE
970 * When TRUE $width and $height will be used as a bounding box, outside of
971 * which the resized image will not extend.
972 * When FALSE, the image will be resized exactly to $width and $height, even
973 * if it means stretching it.
977 * @throws \CRM_Core_Exception
978 * Under the following conditions
979 * - When GD is not available.
980 * - When the source file is not an image.
982 public static function resizeImage($sourceFile, $targetWidth, $targetHeight, $suffix = "", $preserveAspect = TRUE) {
984 // Check if GD is installed
985 $gdSupport = CRM_Utils_System
::getModuleSetting('gd', 'GD Support');
987 throw new CRM_Core_Exception(ts('Unable to resize image because the GD image library is not currently compiled in your PHP installation.'));
990 $sourceMime = mime_content_type($sourceFile);
991 if ($sourceMime == 'image/gif') {
992 $sourceData = imagecreatefromgif($sourceFile);
994 elseif ($sourceMime == 'image/png') {
995 $sourceData = imagecreatefrompng($sourceFile);
997 elseif ($sourceMime == 'image/jpeg') {
998 $sourceData = imagecreatefromjpeg($sourceFile);
1001 throw new CRM_Core_Exception(ts('Unable to resize image because the file supplied was not an image.'));
1004 // get image about original image
1005 $sourceInfo = getimagesize($sourceFile);
1006 $sourceWidth = $sourceInfo[0];
1007 $sourceHeight = $sourceInfo[1];
1009 // Adjust target width/height if preserving aspect ratio
1010 if ($preserveAspect) {
1011 $sourceAspect = $sourceWidth / $sourceHeight;
1012 $targetAspect = $targetWidth / $targetHeight;
1013 if ($sourceAspect > $targetAspect) {
1014 $targetHeight = $targetWidth / $sourceAspect;
1016 if ($sourceAspect < $targetAspect) {
1017 $targetWidth = $targetHeight * $sourceAspect;
1021 // figure out the new filename
1022 $pathParts = pathinfo($sourceFile);
1023 $targetFile = $pathParts['dirname'] . DIRECTORY_SEPARATOR
1024 . $pathParts['filename'] . $suffix . "." . $pathParts['extension'];
1026 $targetData = imagecreatetruecolor($targetWidth, $targetHeight);
1029 imagecopyresized($targetData, $sourceData,
1031 $targetWidth, $targetHeight, $sourceWidth, $sourceHeight);
1033 // save the resized image
1034 $fp = fopen($targetFile, 'w+');
1036 imagejpeg($targetData);
1037 $image_buffer = ob_get_contents();
1039 imagedestroy($targetData);
1040 fwrite($fp, $image_buffer);
1044 // return the URL to link to
1045 $config = CRM_Core_Config
::singleton();
1046 return $config->imageUploadURL
. basename($targetFile);
1050 * Get file icon class for specific MIME Type
1052 * @param string $mimeType
1055 public static function getIconFromMimeType($mimeType) {
1056 if (!isset(Civi
::$statics[__CLASS__
]['mimeIcons'])) {
1057 Civi
::$statics[__CLASS__
]['mimeIcons'] = json_decode(file_get_contents(__DIR__
. '/File/mimeIcons.json'), TRUE);
1059 $iconClasses = Civi
::$statics[__CLASS__
]['mimeIcons'];
1060 foreach ($iconClasses as $text => $icon) {
1061 if (strpos($mimeType, $text) === 0) {
1065 return $iconClasses['*'];
1069 * Is the filename a safe and valid filename passed in from URL
1071 * @param string $fileName
1074 public static function isValidFileName($fileName = NULL) {
1076 $check = ($fileName === basename($fileName));
1078 if (substr($fileName, 0, 1) == '/' ||
substr($fileName, 0, 1) == '.' ||
substr($fileName, 0, 1) == DIRECTORY_SEPARATOR
) {
1088 * Get the extensions that this MimeTpe is for
1089 * @param string $mimeType the mime-type we want extensions for
1092 public static function getAcceptableExtensionsForMimeType($mimeType = []) {
1093 $mimeRepostory = new \MimeTyper\Repository\
ExtendedRepository();
1094 return $mimeRepostory->findExtensions($mimeType);
1098 * Get the extension of a file based on its path
1099 * @param string $path path of the file to query
1102 public static function getExtensionFromPath($path) {
1103 return pathinfo($path, PATHINFO_EXTENSION
);
1107 * Wrapper for is_dir() to avoid flooding logs when open_basedir is used.
1109 * Don't use this function as a swap-in replacement for is_dir() for all
1110 * situations as this might silence errors that you want to know about
1111 * and would help troubleshoot problems. It should only be used when
1112 * doing something like iterating over a set of folders where you know some
1113 * of them might not legitimately exist or might be outside open_basedir
1114 * because you're trying to find the right one. If you expect the path you're
1115 * checking to be inside open_basedir, then you should use the regular
1116 * is_dir(). (e.g. it might not exist but might be something
1117 * like a cache folder in templates_c, which can't be outside open_basedir,
1118 * so there you would use regular is_dir).
1120 * **** Security alert ****
1121 * If you change this function so that it would be possible to return
1122 * TRUE without checking the real value of is_dir() then it opens up a
1123 * possible security issue.
1124 * It should either return FALSE, or the value returned from is_dir().
1126 * @param string|null $dir
1128 * In php8 the return value from is_dir() is always bool but in php7 it can be null.
1130 public static function isDir(?
string $dir) {
1131 set_error_handler(function($errno, $errstr) {
1132 // If this is open_basedir-related, convert it to an exception so we
1134 if (strpos($errstr, 'open_basedir restriction in effect') !== FALSE) {
1135 throw new \
ErrorException($errstr, $errno);
1137 // Continue with normal error handling so other errors still happen.
1141 $is_dir = is_dir($dir);
1143 catch (\ErrorException
$e) {
1147 restore_error_handler();