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);
468 public static function duplicate($filePath) {
469 $oldName = pathinfo($filePath, PATHINFO_FILENAME
);
470 $uniqID = md5(uniqid(rand(), TRUE));
471 $newName = preg_replace('/(_[\w]{32})$/', '', $oldName) . '_' . $uniqID;
472 $newPath = str_replace($oldName, $newName, $filePath);
473 copy($filePath, $newPath);
478 * Get files for the extension.
480 * @param string $path
485 public static function getFilesByExtension($path, $ext) {
486 $path = self
::addTrailingSlash($path);
488 if ($dh = opendir($path)) {
489 while (FALSE !== ($elem = readdir($dh))) {
490 if (substr($elem, -(strlen($ext) +
1)) == '.' . $ext) {
491 $files[] .= $path . $elem;
500 * Restrict access to a given directory (by planting there a restrictive .htaccess file)
503 * The directory to be secured.
504 * @param bool $overwrite
506 public static function restrictAccess($dir, $overwrite = FALSE) {
507 // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
508 // of site, causing site to stop functioning.
509 // FIXME: we should do more checks here -
510 if (!empty($dir) && is_dir($dir)) {
511 $htaccess = <<<HTACCESS
514 <IfModule !authz_core_module>
520 <IfModule authz_core_module>
526 $file = $dir . '.htaccess';
527 if ($overwrite ||
!file_exists($file)) {
528 if (file_put_contents($file, $htaccess) === FALSE) {
529 CRM_Core_Error
::movedSiteError($file);
536 * Restrict remote users from browsing the given directory.
540 public static function restrictBrowsing($publicDir) {
541 if (!is_dir($publicDir) ||
!is_writable($publicDir)) {
546 $nobrowse = realpath($publicDir) . '/index.html';
547 if (!file_exists($nobrowse)) {
548 @file_put_contents
($nobrowse, '');
552 $dir = new RecursiveDirectoryIterator($publicDir);
553 foreach ($dir as $name => $object) {
554 if (is_dir($name) && $name != '..') {
555 $nobrowse = realpath($name) . '/index.html';
556 if (!file_exists($nobrowse)) {
557 @file_put_contents
($nobrowse, '');
564 * (Deprecated) Create the file-path from which all other internal paths are
565 * computed. This implementation determines it as `dirname(CIVICRM_TEMPLATE_COMPILEDIR)`.
567 * This approach is problematic - e.g. it prevents one from authentically
568 * splitting the CIVICRM_TEMPLATE_COMPILEDIR away from other dirs. The implementation
569 * is preserved for backwards compatibility (and should only be called by
570 * CMS-adapters and by Civi\Core\Paths).
572 * Do not use it for new path construction logic. Instead, use Civi::paths().
575 * @see \Civi::paths()
576 * @see \Civi\Core\Paths
578 public static function baseFilePath() {
579 static $_path = NULL;
581 // Note: Don't rely on $config; that creates a dependency loop.
582 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
583 throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR");
585 $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR
;
587 $path = dirname($templateCompileDir);
589 //this fix is to avoid creation of upload dirs inside templates_c directory
590 $checkPath = explode(DIRECTORY_SEPARATOR
, $path);
592 $cnt = count($checkPath) - 1;
593 if ($checkPath[$cnt] == 'templates_c') {
594 unset($checkPath[$cnt]);
595 $path = implode(DIRECTORY_SEPARATOR
, $checkPath);
598 $_path = CRM_Utils_File
::addTrailingSlash($path);
604 * Determine if a path is absolute.
606 * @param string $path
609 * TRUE if absolute. FALSE if relative.
611 public static function isAbsolute($path) {
612 if (substr($path, 0, 1) === DIRECTORY_SEPARATOR
) {
615 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
616 if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
625 * @param string $basePath
626 * The base path when evaluating relative paths. Should include trailing slash.
630 public static function absoluteDirectory($directory, $basePath) {
631 // check if directory is already absolute, if so return immediately
632 // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
633 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
637 // check if directory is already absolute, if so return immediately
638 if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR
) {
642 if ($basePath === NULL) {
643 // Previous versions interpreted `NULL` to mean "default to `self::baseFilePath()`".
644 // However, no code in the known `universe` relies on this interpretation, and
645 // the `baseFilePath()` function is problematic/deprecated.
646 throw new \
RuntimeException("absoluteDirectory() requires specifying a basePath");
649 // ensure that $basePath has a trailing slash
650 $basePath = self
::addTrailingSlash($basePath);
651 return $basePath . $directory;
655 * Make a file path relative to some base dir.
662 public static function relativize($directory, $basePath) {
663 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
664 $directory = strtr($directory, '\\', '/');
665 $basePath = strtr($basePath, '\\', '/');
667 if (substr($directory, 0, strlen($basePath)) == $basePath) {
668 return substr($directory, strlen($basePath));
676 * Create a path to a temporary file which can endure for multiple requests.
678 * @todo Automatic file cleanup using, eg, TTL policy
680 * @param string $prefix
682 * @return string, path to an openable/writable file
685 public static function tempnam($prefix = 'tmp-') {
686 // $config = CRM_Core_Config::singleton();
687 // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
688 // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
689 $fileName = tempnam(sys_get_temp_dir(), $prefix);
694 * Create a path to a temporary directory which can endure for multiple requests.
696 * @todo Automatic file cleanup using, eg, TTL policy
698 * @param string $prefix
700 * @return string, path to an openable/writable directory; ends with '/'
703 public static function tempdir($prefix = 'tmp-') {
704 $fileName = self
::tempnam($prefix);
706 mkdir($fileName, 0700);
707 return $fileName . '/';
711 * Search directory tree for files which match a glob pattern.
713 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
717 * @param string $pattern
718 * glob pattern, eg "*.txt".
719 * @param bool $relative
720 * TRUE if paths should be made relative to $dir
721 * @return array(string)
723 public static function findFiles($dir, $pattern, $relative = FALSE) {
724 if (!is_dir($dir) ||
!is_readable($dir)) {
727 // Which dirs should we exclude from our searches?
728 // If not defined, we default to excluding any dirname that begins
729 // with a . which is the old behaviour and therefore excludes .git/
730 $excludeDirsPattern = defined('CIVICRM_EXCLUDE_DIRS_PATTERN')
731 ?
constant('CIVICRM_EXCLUDE_DIRS_PATTERN')
732 : '@' . preg_quote(DIRECTORY_SEPARATOR
) . '\.@';
734 $dir = rtrim($dir, '/');
737 while (!empty($todos)) {
738 $subdir = array_shift($todos);
739 $matches = glob("$subdir/$pattern");
740 if (is_array($matches)) {
741 foreach ($matches as $match) {
742 if (!is_dir($match)) {
743 $result[] = $relative ? CRM_Utils_File
::relativize($match, "$dir/") : $match;
747 // Find subdirs to recurse into.
748 if ($dh = opendir($subdir)) {
749 while (FALSE !== ($entry = readdir($dh))) {
750 $path = $subdir . DIRECTORY_SEPARATOR
. $entry;
751 // Exclude . (self) and .. (parent) to avoid infinite loop.
752 // Exclude configured exclude dirs.
753 // Exclude dirs we can't read.
754 // Exclude anything that's not a dir.
758 && (empty($excludeDirsPattern) ||
!preg_match($excludeDirsPattern, $path))
760 && is_readable($path)
772 * Determine if $child is a sub-directory of $parent
774 * @param string $parent
775 * @param string $child
776 * @param bool $checkRealPath
780 public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
781 if ($checkRealPath) {
782 $parent = realpath($parent);
783 $child = realpath($child);
785 $parentParts = explode('/', rtrim($parent, '/'));
786 $childParts = explode('/', rtrim($child, '/'));
787 while (($parentPart = array_shift($parentParts)) !== NULL) {
788 $childPart = array_shift($childParts);
789 if ($parentPart != $childPart) {
793 if (empty($childParts)) {
803 * Move $fromDir to $toDir, replacing/deleting any
804 * pre-existing content.
806 * @param string $fromDir
807 * The directory which should be moved.
808 * @param string $toDir
809 * The new location of the directory.
810 * @param bool $verbose
815 public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
816 if (is_dir($toDir)) {
817 if (!self
::cleanDir($toDir, TRUE, $verbose)) {
822 // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
824 CRM_Utils_File
::copyDir($fromDir, $toDir);
825 if (!CRM_Utils_File
::cleanDir($fromDir, TRUE, FALSE)) {
826 CRM_Core_Session
::setStatus(ts('Failed to clean temp dir: %1', [1 => $fromDir]), '', 'alert');
835 * @param array $param
836 * @param string $fileName
837 * @param array $extraParams
839 public static function formatFile(&$param, $fileName, $extraParams = []) {
840 if (empty($param[$fileName])) {
845 'uri' => $param[$fileName]['name'],
846 'type' => $param[$fileName]['type'],
847 'location' => $param[$fileName]['name'],
848 'upload_date' => date('YmdHis'),
851 $param[$fileName] = $fileParams;
855 * Return formatted file URL, like for image file return image url with image icon
857 * @param string $path
859 * @param string $fileType
861 * File preview link e.g. https://example.com/civicrm/file?reset=1&filename=image.png&mime-type=image/png
863 * @return string $url
865 public static function getFileURL($path, $fileType, $url = NULL) {
866 if (empty($path) ||
empty($fileType)) {
869 elseif (empty($url)) {
870 $fileName = basename($path);
871 $url = CRM_Utils_System
::url('civicrm/file', "reset=1&filename={$fileName}&mime-type={$fileType}");
880 list($imageWidth, $imageHeight) = getimagesize($path);
881 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
882 $url = "<a href=\"$url\" class='crm-image-popup'>
883 <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
888 $url = sprintf('<a href="%s">%s</a>', $url, self
::cleanFileName(basename($path)));
896 * Return formatted image icon
898 * @param string $imageURL
899 * Contact's image url
901 * @return string $url
903 public static function getImageURL($imageURL) {
904 // retrieve image name from $imageURL
905 $imageURL = CRM_Utils_String
::unstupifyUrl($imageURL);
906 parse_str(parse_url($imageURL, PHP_URL_QUERY
), $query);
909 if (!empty($query['photo'])) {
910 $path = CRM_Core_Config
::singleton()->customFileUploadDir
. $query['photo'];
913 $path = $url = $imageURL;
915 $fileExtension = strtolower(pathinfo($path, PATHINFO_EXTENSION
));
916 //According to (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types),
917 // there are some extensions that would need translating.:
918 $translateMimeTypes = [
923 $mimeType = 'image/' . CRM_Utils_Array
::value(
929 return self
::getFileURL($path, $mimeType, $url);
935 * @param string $sourceFile
936 * Filesystem path to existing image on server
937 * @param int $targetWidth
938 * New width desired, in pixels
939 * @param int $targetHeight
940 * New height desired, in pixels
941 * @param string $suffix = ""
942 * If supplied, the image will be renamed to include this suffix. For
943 * example if the original file name is "foo.png" and $suffix = "_bar",
944 * then the final file name will be "foo_bar.png".
945 * @param bool $preserveAspect = TRUE
946 * When TRUE $width and $height will be used as a bounding box, outside of
947 * which the resized image will not extend.
948 * When FALSE, the image will be resized exactly to $width and $height, even
949 * if it means stretching it.
953 * @throws \CRM_Core_Exception
954 * Under the following conditions
955 * - When GD is not available.
956 * - When the source file is not an image.
958 public static function resizeImage($sourceFile, $targetWidth, $targetHeight, $suffix = "", $preserveAspect = TRUE) {
960 // Check if GD is installed
961 $gdSupport = CRM_Utils_System
::getModuleSetting('gd', 'GD Support');
963 throw new CRM_Core_Exception(ts('Unable to resize image because the GD image library is not currently compiled in your PHP installation.'));
966 $sourceMime = mime_content_type($sourceFile);
967 if ($sourceMime == 'image/gif') {
968 $sourceData = imagecreatefromgif($sourceFile);
970 elseif ($sourceMime == 'image/png') {
971 $sourceData = imagecreatefrompng($sourceFile);
973 elseif ($sourceMime == 'image/jpeg') {
974 $sourceData = imagecreatefromjpeg($sourceFile);
977 throw new CRM_Core_Exception(ts('Unable to resize image because the file supplied was not an image.'));
980 // get image about original image
981 $sourceInfo = getimagesize($sourceFile);
982 $sourceWidth = $sourceInfo[0];
983 $sourceHeight = $sourceInfo[1];
985 // Adjust target width/height if preserving aspect ratio
986 if ($preserveAspect) {
987 $sourceAspect = $sourceWidth / $sourceHeight;
988 $targetAspect = $targetWidth / $targetHeight;
989 if ($sourceAspect > $targetAspect) {
990 $targetHeight = $targetWidth / $sourceAspect;
992 if ($sourceAspect < $targetAspect) {
993 $targetWidth = $targetHeight * $sourceAspect;
997 // figure out the new filename
998 $pathParts = pathinfo($sourceFile);
999 $targetFile = $pathParts['dirname'] . DIRECTORY_SEPARATOR
1000 . $pathParts['filename'] . $suffix . "." . $pathParts['extension'];
1002 $targetData = imagecreatetruecolor($targetWidth, $targetHeight);
1005 imagecopyresized($targetData, $sourceData,
1007 $targetWidth, $targetHeight, $sourceWidth, $sourceHeight);
1009 // save the resized image
1010 $fp = fopen($targetFile, 'w+');
1012 imagejpeg($targetData);
1013 $image_buffer = ob_get_contents();
1015 imagedestroy($targetData);
1016 fwrite($fp, $image_buffer);
1020 // return the URL to link to
1021 $config = CRM_Core_Config
::singleton();
1022 return $config->imageUploadURL
. basename($targetFile);
1026 * Get file icon class for specific MIME Type
1028 * @param string $mimeType
1031 public static function getIconFromMimeType($mimeType) {
1032 if (!isset(Civi
::$statics[__CLASS__
]['mimeIcons'])) {
1033 Civi
::$statics[__CLASS__
]['mimeIcons'] = json_decode(file_get_contents(__DIR__
. '/File/mimeIcons.json'), TRUE);
1035 $iconClasses = Civi
::$statics[__CLASS__
]['mimeIcons'];
1036 foreach ($iconClasses as $text => $icon) {
1037 if (strpos($mimeType, $text) === 0) {
1041 return $iconClasses['*'];
1045 * Is the filename a safe and valid filename passed in from URL
1047 * @param string $fileName
1050 public static function isValidFileName($fileName = NULL) {
1052 $check = ($fileName === basename($fileName));
1054 if (substr($fileName, 0, 1) == '/' ||
substr($fileName, 0, 1) == '.' ||
substr($fileName, 0, 1) == DIRECTORY_SEPARATOR
) {
1064 * Get the extensions that this MimeTpe is for
1065 * @param string $mimeType the mime-type we want extensions for
1068 public static function getAcceptableExtensionsForMimeType($mimeType = []) {
1069 $mimeRepostory = new \MimeTyper\Repository\
ExtendedRepository();
1070 return $mimeRepostory->findExtensions($mimeType);
1074 * Get the extension of a file based on its path
1075 * @param string $path path of the file to query
1078 public static function getExtensionFromPath($path) {
1079 return pathinfo($path, PATHINFO_EXTENSION
);