"; } } } } } /** * * Strips comment from a possibly multiline SQL string * * @param string $string * * @return string * stripped string */ public static function stripComments($string) { return preg_replace("/^(#|--).*\R*/m", "", $string); } /** * @param $ext * * @return bool */ public static function isExtensionSafe($ext) { static $extensions = NULL; if (!$extensions) { $extensions = CRM_Core_OptionGroup::values('safe_file_extension', TRUE); // make extensions to lowercase $extensions = array_change_key_case($extensions, CASE_LOWER); // allow html/htm extension ONLY if the user is admin // and/or has access CiviMail if (!(CRM_Core_Permission::check('access CiviMail') || CRM_Core_Permission::check('administer CiviCRM') || (CRM_Mailing_Info::workflowEnabled() && CRM_Core_Permission::check('create mailings') ) ) ) { unset($extensions['html']); unset($extensions['htm']); } } // support lower and uppercase file extensions return isset($extensions[strtolower($ext)]) ? TRUE : FALSE; } /** * Determine whether a given file is listed in the PHP include path. * * @param string $name * Name of file. * * @return bool * whether the file can be include()d or require()d */ public static function isIncludable($name) { $x = @fopen($name, 'r', TRUE); if ($x) { fclose($x); return TRUE; } else { return FALSE; } } /** * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it. * * @param $name * * @return mixed */ public static function cleanFileName($name) { // replace the last 33 character before the '.' with null $name = preg_replace('/(_[\w]{32})\./', '.', $name); return $name; } /** * Make a valid file name. * * @param string $name * * @return string */ public static function makeFileName($name) { $uniqID = md5(uniqid(rand(), TRUE)); $info = pathinfo($name); $basename = substr($info['basename'], 0, -(strlen(CRM_Utils_Array::value('extension', $info)) + (CRM_Utils_Array::value('extension', $info) == '' ? 0 : 1)) ); if (!self::isExtensionSafe(CRM_Utils_Array::value('extension', $info))) { // munge extension so it cannot have an embbeded dot in it // The maximum length of a filename for most filesystems is 255 chars. // We'll truncate at 240 to give some room for the extension. return CRM_Utils_String::munge("{$basename}_" . CRM_Utils_Array::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown"; } else { return CRM_Utils_String::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array::value('extension', $info); } } /** * Copies a file * * @param $filePath * @return mixed */ public static function duplicate($filePath) { $oldName = pathinfo($filePath, PATHINFO_FILENAME); $uniqID = md5(uniqid(rand(), TRUE)); $newName = preg_replace('/(_[\w]{32})$/', '', $oldName) . '_' . $uniqID; $newPath = str_replace($oldName, $newName, $filePath); copy($filePath, $newPath); return $newPath; } /** * Get files for the extension. * * @param string $path * @param string $ext * * @return array */ public static function getFilesByExtension($path, $ext) { $path = self::addTrailingSlash($path); $files = []; if ($dh = opendir($path)) { while (FALSE !== ($elem = readdir($dh))) { if (substr($elem, -(strlen($ext) + 1)) == '.' . $ext) { $files[] .= $path . $elem; } } closedir($dh); } return $files; } /** * Restrict access to a given directory (by planting there a restrictive .htaccess file) * * @param string $dir * The directory to be secured. * @param bool $overwrite */ public static function restrictAccess($dir, $overwrite = FALSE) { // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir // of site, causing site to stop functioning. // FIXME: we should do more checks here - if (!empty($dir) && is_dir($dir)) { $htaccess = << # Apache 2.2 Order allow,deny Deny from all # Apache 2.4+ Require all denied HTACCESS; $file = $dir . '.htaccess'; if ($overwrite || !file_exists($file)) { if (file_put_contents($file, $htaccess) === FALSE) { CRM_Core_Error::movedSiteError($file); } } } } /** * Restrict remote users from browsing the given directory. * * @param $publicDir */ public static function restrictBrowsing($publicDir) { if (!is_dir($publicDir) || !is_writable($publicDir)) { return; } // base dir $nobrowse = realpath($publicDir) . '/index.html'; if (!file_exists($nobrowse)) { @file_put_contents($nobrowse, ''); } // child dirs $dir = new RecursiveDirectoryIterator($publicDir); foreach ($dir as $name => $object) { if (is_dir($name) && $name != '..') { $nobrowse = realpath($name) . '/index.html'; if (!file_exists($nobrowse)) { @file_put_contents($nobrowse, ''); } } } } /** * (Deprecated) Create the file-path from which all other internal paths are * computed. This implementation determines it as `dirname(CIVICRM_TEMPLATE_COMPILEDIR)`. * * This approach is problematic - e.g. it prevents one from authentically * splitting the CIVICRM_TEMPLATE_COMPILEDIR away from other dirs. The implementation * is preserved for backwards compatibility (and should only be called by * CMS-adapters and by Civi\Core\Paths). * * Do not use it for new path construction logic. Instead, use Civi::paths(). * * @deprecated * @see \Civi::paths() * @see \Civi\Core\Paths */ public static function baseFilePath() { static $_path = NULL; if (!$_path) { // Note: Don't rely on $config; that creates a dependency loop. if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) { throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR"); } $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR; $path = dirname($templateCompileDir); //this fix is to avoid creation of upload dirs inside templates_c directory $checkPath = explode(DIRECTORY_SEPARATOR, $path); $cnt = count($checkPath) - 1; if ($checkPath[$cnt] == 'templates_c') { unset($checkPath[$cnt]); $path = implode(DIRECTORY_SEPARATOR, $checkPath); } $_path = CRM_Utils_File::addTrailingSlash($path); } return $_path; } /** * Determine if a path is absolute. * * @param string $path * * @return bool * TRUE if absolute. FALSE if relative. */ public static function isAbsolute($path) { if (substr($path, 0, 1) === DIRECTORY_SEPARATOR) { return TRUE; } if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) { return TRUE; } } return FALSE; } /** * @param $directory * * @return string * @deprecated * Computation of a relative path requires some base. * This implementation is problematic because it relies on an * implicit base which was constructed problematically. */ public static function relativeDirectory($directory) { // Do nothing on windows if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { return $directory; } // check if directory is relative, if so return immediately if (!self::isAbsolute($directory)) { return $directory; } // make everything relative from the baseFilePath $basePath = self::baseFilePath(); // check if basePath is a substr of $directory, if so // return rest of string if (substr($directory, 0, strlen($basePath)) == $basePath) { return substr($directory, strlen($basePath)); } // return the original value return $directory; } /** * @param $directory * @param string $basePath * The base path when evaluating relative paths. Should include trailing slash. * * @return string */ public static function absoluteDirectory($directory, $basePath) { // check if directory is already absolute, if so return immediately // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) { return $directory; } // check if directory is already absolute, if so return immediately if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR) { return $directory; } if ($basePath === NULL) { // Previous versions interpreted `NULL` to mean "default to `self::baseFilePath()`". // However, no code in the known `universe` relies on this interpretation, and // the `baseFilePath()` function is problematic/deprecated. throw new \RuntimeException("absoluteDirectory() requires specifying a basePath"); } // ensure that $basePath has a trailing slash $basePath = self::addTrailingSlash($basePath); return $basePath . $directory; } /** * Make a file path relative to some base dir. * * @param $directory * @param $basePath * * @return string */ public static function relativize($directory, $basePath) { if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { $directory = strtr($directory, '\\', '/'); $basePath = strtr($basePath, '\\', '/'); } if (substr($directory, 0, strlen($basePath)) == $basePath) { return substr($directory, strlen($basePath)); } else { return $directory; } } /** * Create a path to a temporary file which can endure for multiple requests. * * @todo Automatic file cleanup using, eg, TTL policy * * @param string $prefix * * @return string, path to an openable/writable file * @see tempnam */ public static function tempnam($prefix = 'tmp-') { // $config = CRM_Core_Config::singleton(); // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL); // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix; $fileName = tempnam(sys_get_temp_dir(), $prefix); return $fileName; } /** * Create a path to a temporary directory which can endure for multiple requests. * * @todo Automatic file cleanup using, eg, TTL policy * * @param string $prefix * * @return string, path to an openable/writable directory; ends with '/' * @see tempnam */ public static function tempdir($prefix = 'tmp-') { $fileName = self::tempnam($prefix); unlink($fileName); mkdir($fileName, 0700); return $fileName . '/'; } /** * Search directory tree for files which match a glob pattern. * * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. * * @param string $dir * base dir. * @param string $pattern * glob pattern, eg "*.txt". * @param bool $relative * TRUE if paths should be made relative to $dir * @return array(string) */ public static function findFiles($dir, $pattern, $relative = FALSE) { if (!is_dir($dir)) { return []; } $dir = rtrim($dir, '/'); $todos = [$dir]; $result = []; while (!empty($todos)) { $subdir = array_shift($todos); $matches = glob("$subdir/$pattern"); if (is_array($matches)) { foreach ($matches as $match) { if (!is_dir($match)) { $result[] = $relative ? CRM_Utils_File::relativize($match, "$dir/") : $match; } } } if ($dh = opendir($subdir)) { while (FALSE !== ($entry = readdir($dh))) { $path = $subdir . DIRECTORY_SEPARATOR . $entry; if ($entry{0} == '.') { // ignore } elseif (is_dir($path)) { $todos[] = $path; } } closedir($dh); } } return $result; } /** * Determine if $child is a sub-directory of $parent * * @param string $parent * @param string $child * @param bool $checkRealPath * * @return bool */ public static function isChildPath($parent, $child, $checkRealPath = TRUE) { if ($checkRealPath) { $parent = realpath($parent); $child = realpath($child); } $parentParts = explode('/', rtrim($parent, '/')); $childParts = explode('/', rtrim($child, '/')); while (($parentPart = array_shift($parentParts)) !== NULL) { $childPart = array_shift($childParts); if ($parentPart != $childPart) { return FALSE; } } if (empty($childParts)) { // same directory return FALSE; } else { return TRUE; } } /** * Move $fromDir to $toDir, replacing/deleting any * pre-existing content. * * @param string $fromDir * The directory which should be moved. * @param string $toDir * The new location of the directory. * @param bool $verbose * * @return bool * TRUE on success */ public static function replaceDir($fromDir, $toDir, $verbose = FALSE) { if (is_dir($toDir)) { if (!self::cleanDir($toDir, TRUE, $verbose)) { return FALSE; } } // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097 CRM_Utils_File::copyDir($fromDir, $toDir); if (!CRM_Utils_File::cleanDir($fromDir, TRUE, FALSE)) { CRM_Core_Session::setStatus(ts('Failed to clean temp dir: %1', [1 => $fromDir]), '', 'alert'); return FALSE; } return TRUE; } /** * Format file. * * @param array $param * @param string $fileName * @param array $extraParams */ public static function formatFile(&$param, $fileName, $extraParams = []) { if (empty($param[$fileName])) { return; } $fileParams = [ 'uri' => $param[$fileName]['name'], 'type' => $param[$fileName]['type'], 'location' => $param[$fileName]['name'], 'upload_date' => date('YmdHis'), ] + $extraParams; $param[$fileName] = $fileParams; } /** * Return formatted file URL, like for image file return image url with image icon * * @param string $path * Absoulte file path * @param string $fileType * @param string $url * File preview link e.g. https://example.com/civicrm/file?reset=1&filename=image.png&mime-type=image/png * * @return string $url */ public static function getFileURL($path, $fileType, $url = NULL) { if (empty($path) || empty($fileType)) { return ''; } elseif (empty($url)) { $fileName = basename($path); $url = CRM_Utils_System::url('civicrm/file', "reset=1&filename={$fileName}&mime-type={$fileType}"); } switch ($fileType) { case 'image/jpeg': case 'image/pjpeg': case 'image/gif': case 'image/x-png': case 'image/png': case 'image/jpg': list($imageWidth, $imageHeight) = getimagesize($path); list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight); $url = " "; break; default: $url = sprintf('%s', $url, self::cleanFileName(basename($path))); break; } return $url; } /** * Return formatted image icon * * @param string $imageURL * Contact's image url * * @return string $url */ public static function getImageURL($imageURL) { // retrieve image name from $imageURL $imageURL = CRM_Utils_String::unstupifyUrl($imageURL); parse_str(parse_url($imageURL, PHP_URL_QUERY), $query); $url = NULL; if (!empty($query['photo'])) { $path = CRM_Core_Config::singleton()->customFileUploadDir . $query['photo']; } else { $path = $url = $imageURL; } $fileExtension = strtolower(pathinfo($path, PATHINFO_EXTENSION)); //According to (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types), // there are some extensions that would need translating.: $translateMimeTypes = [ 'tif' => 'tiff', 'jpg' => 'jpeg', 'svg' => 'svg+xml', ]; $mimeType = 'image/' . CRM_Utils_Array::value( $fileExtension, $translateMimeTypes, $fileExtension ); return self::getFileURL($path, $mimeType, $url); } /** * Resize an image. * * @param string $sourceFile * Filesystem path to existing image on server * @param int $targetWidth * New width desired, in pixels * @param int $targetHeight * New height desired, in pixels * @param string $suffix = "" * If supplied, the image will be renamed to include this suffix. For * example if the original file name is "foo.png" and $suffix = "_bar", * then the final file name will be "foo_bar.png". * @param bool $preserveAspect = TRUE * When TRUE $width and $height will be used as a bounding box, outside of * which the resized image will not extend. * When FALSE, the image will be resized exactly to $width and $height, even * if it means stretching it. * * @return string * Path to image * @throws \CRM_Core_Exception * Under the following conditions * - When GD is not available. * - When the source file is not an image. */ public static function resizeImage($sourceFile, $targetWidth, $targetHeight, $suffix = "", $preserveAspect = TRUE) { // Check if GD is installed $gdSupport = CRM_Utils_System::getModuleSetting('gd', 'GD Support'); if (!$gdSupport) { throw new CRM_Core_Exception(ts('Unable to resize image because the GD image library is not currently compiled in your PHP installation.')); } $sourceMime = mime_content_type($sourceFile); if ($sourceMime == 'image/gif') { $sourceData = imagecreatefromgif($sourceFile); } elseif ($sourceMime == 'image/png') { $sourceData = imagecreatefrompng($sourceFile); } elseif ($sourceMime == 'image/jpeg') { $sourceData = imagecreatefromjpeg($sourceFile); } else { throw new CRM_Core_Exception(ts('Unable to resize image because the file supplied was not an image.')); } // get image about original image $sourceInfo = getimagesize($sourceFile); $sourceWidth = $sourceInfo[0]; $sourceHeight = $sourceInfo[1]; // Adjust target width/height if preserving aspect ratio if ($preserveAspect) { $sourceAspect = $sourceWidth / $sourceHeight; $targetAspect = $targetWidth / $targetHeight; if ($sourceAspect > $targetAspect) { $targetHeight = $targetWidth / $sourceAspect; } if ($sourceAspect < $targetAspect) { $targetWidth = $targetHeight * $sourceAspect; } } // figure out the new filename $pathParts = pathinfo($sourceFile); $targetFile = $pathParts['dirname'] . DIRECTORY_SEPARATOR . $pathParts['filename'] . $suffix . "." . $pathParts['extension']; $targetData = imagecreatetruecolor($targetWidth, $targetHeight); // resize imagecopyresized($targetData, $sourceData, 0, 0, 0, 0, $targetWidth, $targetHeight, $sourceWidth, $sourceHeight); // save the resized image $fp = fopen($targetFile, 'w+'); ob_start(); imagejpeg($targetData); $image_buffer = ob_get_contents(); ob_end_clean(); imagedestroy($targetData); fwrite($fp, $image_buffer); rewind($fp); fclose($fp); // return the URL to link to $config = CRM_Core_Config::singleton(); return $config->imageUploadURL . basename($targetFile); } /** * Get file icon class for specific MIME Type * * @param string $mimeType * @return string */ public static function getIconFromMimeType($mimeType) { if (!isset(Civi::$statics[__CLASS__]['mimeIcons'])) { Civi::$statics[__CLASS__]['mimeIcons'] = json_decode(file_get_contents(__DIR__ . '/File/mimeIcons.json'), TRUE); } $iconClasses = Civi::$statics[__CLASS__]['mimeIcons']; foreach ($iconClasses as $text => $icon) { if (strpos($mimeType, $text) === 0) { return $icon; } } return $iconClasses['*']; } /** * Is the filename a safe and valid filename passed in from URL * * @param string $fileName * @return bool */ public static function isValidFileName($fileName = NULL) { if ($fileName) { $check = $fileName !== basename($fileName) ? FALSE : TRUE; if ($check) { if (substr($fileName, 0, 1) == '/' || substr($fileName, 0, 1) == '.' || substr($fileName, 0, 1) == DIRECTORY_SEPARATOR) { $check = FALSE; } } return $check; } return FALSE; } /** * Get the extensions that this MimeTpe is for * @param string $mimeType the mime-type we want extensions for * @return array */ public static function getAcceptableExtensionsForMimeType($mimeType = NULL) { $mapping = \MimeType\Mapping::$types; $extensions = []; foreach ($mapping as $extension => $type) { if ($mimeType == $type) { $extensions[] = $extension; } } return $extensions; } /** * Get the extension of a file based on its path * @param string $path path of the file to query * @return string */ public static function getExtensionFromPath($path) { return pathinfo($path, PATHINFO_EXTENSION); } }