CRM/Utils/File.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * class to provide simple static functions for file objects
  20  */
  21 class CRM_Utils_File {
  22
  23   /**
  24    * Given a file name, determine if the file contents make it an ascii file
  25    *
  26    * @param string $name
  27    *   Name of file.
  28    *
  29    * @return bool
  30    *   true if file is ascii
  31    */
  32   public static function isAscii($name) {
  33     $fd = fopen($name, "r");
  34     if (!$fd) {
  35       return FALSE;
  36     }
  37
  38     $ascii = TRUE;
  39     while (!feof($fd)) {
  40       $line = fgets($fd, 8192);
  41       if (!CRM_Utils_String::isAscii($line)) {
  42         $ascii = FALSE;
  43         break;
  44       }
  45     }
  46
  47     fclose($fd);
  48     return $ascii;
  49   }
  50
  51   /**
  52    * Given a file name, determine if the file contents make it an html file
  53    *
  54    * @param string $name
  55    *   Name of file.
  56    *
  57    * @return bool
  58    *   true if file is html
  59    */
  60   public static function isHtml($name) {
  61     $fd = fopen($name, "r");
  62     if (!$fd) {
  63       return FALSE;
  64     }
  65
  66     $html = FALSE;
  67     $lineCount = 0;
  68     while (!feof($fd) & $lineCount <= 5) {
  69       $lineCount++;
  70       $line = fgets($fd, 8192);
  71       if (!CRM_Utils_String::isHtml($line)) {
  72         $html = TRUE;
  73         break;
  74       }
  75     }
  76
  77     fclose($fd);
  78     return $html;
  79   }
  80
  81   /**
  82    * Create a directory given a path name, creates parent directories
  83    * if needed
  84    *
  85    * @param string $path
  86    *   The path name.
  87    * @param bool $abort
  88    *   Should we abort or just return an invalid code.
  89    * @return bool|NULL
  90    *   NULL: Folder already exists or was not specified.
  91    *   TRUE: Creation succeeded.
  92    *   FALSE: Creation failed.
  93    */
  94   public static function createDir($path, $abort = TRUE) {
  95     if (is_dir($path) || empty($path)) {
  96       return NULL;
  97     }
  98
  99     CRM_Utils_File::createDir(dirname($path), $abort);
 100     if (@mkdir($path, 0777) == FALSE) {
 101       if ($abort) {
 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>";
 104
 105         CRM_Utils_System::civiExit();
 106       }
 107       else {
 108         return FALSE;
 109       }
 110     }
 111     return TRUE;
 112   }
 113
 114   /**
 115    * Delete a directory given a path name, delete children directories
 116    * and files if needed
 117    *
 118    * @param string $target
 119    *   The path name.
 120    * @param bool $rmdir
 121    * @param bool $verbose
 122    *
 123    * @throws Exception
 124    */
 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");
 129     }
 130
 131     if ($dh = @opendir($target)) {
 132       while (FALSE !== ($sibling = readdir($dh))) {
 133         if (!in_array($sibling, $exceptions)) {
 134           $object = $target . DIRECTORY_SEPARATOR . $sibling;
 135
 136           if (is_dir($object)) {
 137             CRM_Utils_File::cleanDir($object, $rmdir, $verbose);
 138           }
 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');
 142             }
 143           }
 144         }
 145       }
 146       closedir($dh);
 147
 148       if ($rmdir) {
 149         if (rmdir($target)) {
 150           if ($verbose) {
 151             CRM_Core_Session::setStatus(ts('Removed directory %1', [1 => $target]), '', 'success');
 152           }
 153           return TRUE;
 154         }
 155         else {
 156           CRM_Core_Session::setStatus(ts('Unable to remove directory %1', [1 => $target]), ts('Warning'), 'error');
 157         }
 158       }
 159     }
 160   }
 161
 162   /**
 163    * Concatenate several files.
 164    *
 165    * @param array $files
 166    *   List of file names.
 167    * @param string $delim
 168    *   An optional delimiter to put between files.
 169    * @return string
 170    */
 171   public static function concat($files, $delim = '') {
 172     $buf = '';
 173     $first = TRUE;
 174     foreach ($files as $file) {
 175       if (!$first) {
 176         $buf .= $delim;
 177       }
 178       $buf .= file_get_contents($file);
 179       $first = FALSE;
 180     }
 181     return $buf;
 182   }
 183
 184   /**
 185    * @param string $source
 186    * @param string $destination
 187    */
 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);
 195           }
 196           else {
 197             copy($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
 198           }
 199         }
 200       }
 201       closedir($dh);
 202     }
 203   }
 204
 205   /**
 206    * Given a file name, recode it (in place!) to UTF-8
 207    *
 208    * @param string $name
 209    *   Name of file.
 210    *
 211    * @return bool
 212    *   whether the file was recoded properly
 213    */
 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;
 220     }
 221
 222     if (!function_exists('iconv')) {
 223
 224       return FALSE;
 225
 226     }
 227
 228     $contents = file_get_contents($name);
 229     if ($contents === FALSE) {
 230       return FALSE;
 231     }
 232
 233     $contents = iconv($legacyEncoding, 'UTF-8', $contents);
 234     if ($contents === FALSE) {
 235       return FALSE;
 236     }
 237
 238     $file = fopen($name, 'w');
 239     if ($file === FALSE) {
 240       return FALSE;
 241     }
 242
 243     $written = fwrite($file, $contents);
 244     $closed = fclose($file);
 245     if ($written === FALSE or !$closed) {
 246       return FALSE;
 247     }
 248
 249     return TRUE;
 250   }
 251
 252   /**
 253    * Appends a slash to the end of a string if it doesn't already end with one
 254    *
 255    * @param string $path
 256    * @param string $slash
 257    *
 258    * @return string
 259    */
 260   public static function addTrailingSlash($path, $slash = NULL) {
 261     if (!$slash) {
 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;
 266     }
 267     if (!in_array(substr($path, -1, 1), ['/', '\\'])) {
 268       $path .= $slash;
 269     }
 270     return $path;
 271   }
 272
 273   /**
 274    * Save a fake file somewhere
 275    *
 276    * @param string $dir
 277    *   The directory where the file should be saved.
 278    * @param string $contents
 279    *   Optional: the contents of the file.
 280    * @param string $fileName
 281    *
 282    * @return string
 283    *   The filename saved, or FALSE on failure.
 284    */
 285   public static function createFakeFile($dir, $contents = 'delete me', $fileName = NULL) {
 286     $dir = self::addTrailingSlash($dir);
 287     if (!$fileName) {
 288       $fileName = 'delete-this-' . CRM_Utils_String::createRandom(10, CRM_Utils_String::ALPHANUMERIC);
 289     }
 290     $success = @file_put_contents($dir . $fileName, $contents);
 291
 292     return ($success === FALSE) ? FALSE : $fileName;
 293   }
 294
 295   /**
 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
 302    */
 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.');
 308     }
 309
 310     self::runSqlQuery($dsn, file_get_contents($fileName), $prefix, $dieOnErrors);
 311   }
 312
 313   /**
 314    *
 315    * @param string|NULL $dsn
 316    * @param string $queryString
 317    * @param string $prefix
 318    * @param bool $dieOnErrors
 319    */
 320   public static function runSqlQuery($dsn, $queryString, $prefix = NULL, $dieOnErrors = TRUE) {
 321     $string = $prefix . $queryString;
 322
 323     if ($dsn === NULL) {
 324       $db = CRM_Core_DAO::getConnection();
 325     }
 326     else {
 327       require_once 'DB.php';
 328       $dsn = CRM_Utils_SQL::autoSwitchDSN($dsn);
 329       try {
 330         $options = CRM_Utils_SQL::isSSLDSN($dsn) ? ['ssl' => TRUE] : [];
 331         $db = DB::connect($dsn, $options);
 332       }
 333       catch (Exception $e) {
 334         die("Cannot open $dsn: " . $e->getMessage());
 335       }
 336     }
 337
 338     $db->query('SET NAMES utf8mb4');
 339     $transactionId = CRM_Utils_Type::escape(CRM_Utils_Request::id(), 'String');
 340     $db->query('SET @uniqueID = ' . "'$transactionId'");
 341
 342     // get rid of comments starting with # and --
 343
 344     $string = self::stripComments($string);
 345
 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);
 351         try {
 352           $res = &$db->query($query);
 353         }
 354         catch (Exception $e) {
 355           if ($dieOnErrors) {
 356             die("Cannot execute $query: " . $e->getMessage());
 357           }
 358           else {
 359             echo "Cannot execute $query: " . $e->getMessage() . "<p>";
 360           }
 361         }
 362       }
 363     }
 364   }
 365
 366   /**
 367    *
 368    * Strips comment from a possibly multiline SQL string
 369    *
 370    * @param string $string
 371    *
 372    * @return string
 373    *   stripped string
 374    */
 375   public static function stripComments($string) {
 376     return preg_replace("/^(#|--).*\R*/m", "", $string);
 377   }
 378
 379   /**
 380    * @param $ext
 381    *
 382    * @return bool
 383    */
 384   public static function isExtensionSafe($ext) {
 385     static $extensions = NULL;
 386     if (!$extensions) {
 387       $extensions = CRM_Core_OptionGroup::values('safe_file_extension', TRUE);
 388
 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')
 397         )
 398       )
 399       ) {
 400         unset($extensions['html']);
 401         unset($extensions['htm']);
 402       }
 403     }
 404     // support lower and uppercase file extensions
 405     return (bool) isset($extensions[strtolower($ext)]);
 406   }
 407
 408   /**
 409    * Determine whether a given file is listed in the PHP include path.
 410    *
 411    * @param string $name
 412    *   Name of file.
 413    *
 414    * @return bool
 415    *   whether the file can be include()d or require()d
 416    */
 417   public static function isIncludable($name) {
 418     $full_filepath = stream_resolve_include_path($name);
 419     if ($full_filepath === FALSE) {
 420       return FALSE;
 421     }
 422     return is_readable($full_filepath);
 423   }
 424
 425   /**
 426    * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it.
 427    *
 428    * @param $name
 429    *
 430    * @return mixed
 431    */
 432   public static function cleanFileName($name) {
 433     // replace the last 33 character before the '.' with null
 434     $name = preg_replace('/(_[\w]{32})\./', '.', $name);
 435     return $name;
 436   }
 437
 438   /**
 439    * Make a valid file name.
 440    *
 441    * @param string $name
 442    *
 443    * @return string
 444    */
 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))
 450     );
 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";
 456     }
 457     else {
 458       return CRM_Utils_String::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array::value('extension', $info);
 459     }
 460   }
 461
 462   /**
 463    * Copies a file
 464    *
 465    * @param $filePath
 466    * @return mixed
 467    */
 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);
 474     return $newPath;
 475   }
 476
 477   /**
 478    * Get files for the extension.
 479    *
 480    * @param string $path
 481    * @param string $ext
 482    *
 483    * @return array
 484    */
 485   public static function getFilesByExtension($path, $ext) {
 486     $path = self::addTrailingSlash($path);
 487     $files = [];
 488     if ($dh = opendir($path)) {
 489       while (FALSE !== ($elem = readdir($dh))) {
 490         if (substr($elem, -(strlen($ext) + 1)) == '.' . $ext) {
 491           $files[] .= $path . $elem;
 492         }
 493       }
 494       closedir($dh);
 495     }
 496     return $files;
 497   }
 498
 499   /**
 500    * Restrict access to a given directory (by planting there a restrictive .htaccess file)
 501    *
 502    * @param string $dir
 503    *   The directory to be secured.
 504    * @param bool $overwrite
 505    */
 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
 512 <Files "*">
 513 # Apache 2.2
 514   <IfModule !authz_core_module>
 515     Order allow,deny
 516     Deny from all
 517   </IfModule>
 518
 519 # Apache 2.4+
 520   <IfModule authz_core_module>
 521     Require all denied
 522   </IfModule>
 523 </Files>
 524
 525 HTACCESS;
 526       $file = $dir . '.htaccess';
 527       if ($overwrite || !file_exists($file)) {
 528         if (file_put_contents($file, $htaccess) === FALSE) {
 529           CRM_Core_Error::movedSiteError($file);
 530         }
 531       }
 532     }
 533   }
 534
 535   /**
 536    * Restrict remote users from browsing the given directory.
 537    *
 538    * @param $publicDir
 539    */
 540   public static function restrictBrowsing($publicDir) {
 541     if (!is_dir($publicDir) || !is_writable($publicDir)) {
 542       return;
 543     }
 544
 545     // base dir
 546     $nobrowse = realpath($publicDir) . '/index.html';
 547     if (!file_exists($nobrowse)) {
 548       @file_put_contents($nobrowse, '');
 549     }
 550
 551     // child dirs
 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, '');
 558         }
 559       }
 560     }
 561   }
 562
 563   /**
 564    * (Deprecated) Create the file-path from which all other internal paths are
 565    * computed. This implementation determines it as `dirname(CIVICRM_TEMPLATE_COMPILEDIR)`.
 566    *
 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).
 571    *
 572    * Do not use it for new path construction logic. Instead, use Civi::paths().
 573    *
 574    * @deprecated
 575    * @see \Civi::paths()
 576    * @see \Civi\Core\Paths
 577    */
 578   public static function baseFilePath() {
 579     static $_path = NULL;
 580     if (!$_path) {
 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");
 584       }
 585       $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR;
 586
 587       $path = dirname($templateCompileDir);
 588
 589       //this fix is to avoid creation of upload dirs inside templates_c directory
 590       $checkPath = explode(DIRECTORY_SEPARATOR, $path);
 591
 592       $cnt = count($checkPath) - 1;
 593       if ($checkPath[$cnt] == 'templates_c') {
 594         unset($checkPath[$cnt]);
 595         $path = implode(DIRECTORY_SEPARATOR, $checkPath);
 596       }
 597
 598       $_path = CRM_Utils_File::addTrailingSlash($path);
 599     }
 600     return $_path;
 601   }
 602
 603   /**
 604    * Determine if a path is absolute.
 605    *
 606    * @param string $path
 607    *
 608    * @return bool
 609    *   TRUE if absolute. FALSE if relative.
 610    */
 611   public static function isAbsolute($path) {
 612     if (substr($path, 0, 1) === DIRECTORY_SEPARATOR) {
 613       return TRUE;
 614     }
 615     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 616       if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
 617         return TRUE;
 618       }
 619     }
 620     return FALSE;
 621   }
 622
 623   /**
 624    * @param $directory
 625    * @param string $basePath
 626    *   The base path when evaluating relative paths. Should include trailing slash.
 627    *
 628    * @return string
 629    */
 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)) {
 634       return $directory;
 635     }
 636
 637     // check if directory is already absolute, if so return immediately
 638     if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR) {
 639       return $directory;
 640     }
 641
 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");
 647     }
 648
 649     // ensure that $basePath has a trailing slash
 650     $basePath = self::addTrailingSlash($basePath);
 651     return $basePath . $directory;
 652   }
 653
 654   /**
 655    * Make a file path relative to some base dir.
 656    *
 657    * @param $directory
 658    * @param $basePath
 659    *
 660    * @return string
 661    */
 662   public static function relativize($directory, $basePath) {
 663     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 664       $directory = strtr($directory, '\\', '/');
 665       $basePath = strtr($basePath, '\\', '/');
 666     }
 667     if (substr($directory, 0, strlen($basePath)) == $basePath) {
 668       return substr($directory, strlen($basePath));
 669     }
 670     else {
 671       return $directory;
 672     }
 673   }
 674
 675   /**
 676    * Create a path to a temporary file which can endure for multiple requests.
 677    *
 678    * @todo Automatic file cleanup using, eg, TTL policy
 679    *
 680    * @param string $prefix
 681    *
 682    * @return string, path to an openable/writable file
 683    * @see tempnam
 684    */
 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);
 690     return $fileName;
 691   }
 692
 693   /**
 694    * Create a path to a temporary directory which can endure for multiple requests.
 695    *
 696    * @todo Automatic file cleanup using, eg, TTL policy
 697    *
 698    * @param string $prefix
 699    *
 700    * @return string, path to an openable/writable directory; ends with '/'
 701    * @see tempnam
 702    */
 703   public static function tempdir($prefix = 'tmp-') {
 704     $fileName = self::tempnam($prefix);
 705     unlink($fileName);
 706     mkdir($fileName, 0700);
 707     return $fileName . '/';
 708   }
 709
 710   /**
 711    * Search directory tree for files which match a glob pattern.
 712    *
 713    * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
 714    *
 715    * @param string $dir
 716    *   base dir.
 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)
 722    */
 723   public static function findFiles($dir, $pattern, $relative = FALSE) {
 724     if (!is_dir($dir) || !is_readable($dir)) {
 725       return [];
 726     }
 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) . '\.@';
 733
 734     $dir = rtrim($dir, '/');
 735     $todos = [$dir];
 736     $result = [];
 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;
 744           }
 745         }
 746       }
 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.
 755           if (
 756             $entry !== '.'
 757             && $entry !== '..'
 758             && (empty($excludeDirsPattern) || !preg_match($excludeDirsPattern, $path))
 759             && is_dir($path)
 760             && is_readable($path)
 761           ) {
 762             $todos[] = $path;
 763           }
 764         }
 765         closedir($dh);
 766       }
 767     }
 768     return $result;
 769   }
 770
 771   /**
 772    * Determine if $child is a sub-directory of $parent
 773    *
 774    * @param string $parent
 775    * @param string $child
 776    * @param bool $checkRealPath
 777    *
 778    * @return bool
 779    */
 780   public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
 781     if ($checkRealPath) {
 782       $parent = realpath($parent);
 783       $child = realpath($child);
 784     }
 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) {
 790         return FALSE;
 791       }
 792     }
 793     if (empty($childParts)) {
 794       // same directory
 795       return FALSE;
 796     }
 797     else {
 798       return TRUE;
 799     }
 800   }
 801
 802   /**
 803    * Move $fromDir to $toDir, replacing/deleting any
 804    * pre-existing content.
 805    *
 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
 811    *
 812    * @return bool
 813    *   TRUE on success
 814    */
 815   public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
 816     if (is_dir($toDir)) {
 817       if (!self::cleanDir($toDir, TRUE, $verbose)) {
 818         return FALSE;
 819       }
 820     }
 821
 822     // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
 823
 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');
 827       return FALSE;
 828     }
 829     return TRUE;
 830   }
 831
 832   /**
 833    * Format file.
 834    *
 835    * @param array $param
 836    * @param string $fileName
 837    * @param array $extraParams
 838    */
 839   public static function formatFile(&$param, $fileName, $extraParams = []) {
 840     if (empty($param[$fileName])) {
 841       return;
 842     }
 843
 844     $fileParams = [
 845       'uri' => $param[$fileName]['name'],
 846       'type' => $param[$fileName]['type'],
 847       'location' => $param[$fileName]['name'],
 848       'upload_date' => date('YmdHis'),
 849     ] + $extraParams;
 850
 851     $param[$fileName] = $fileParams;
 852   }
 853
 854   /**
 855    * Return formatted file URL, like for image file return image url with image icon
 856    *
 857    * @param string $path
 858    *   Absoulte file path
 859    * @param string $fileType
 860    * @param string $url
 861    *   File preview link e.g. https://example.com/civicrm/file?reset=1&filename=image.png&mime-type=image/png
 862    *
 863    * @return string $url
 864    */
 865   public static function getFileURL($path, $fileType, $url = NULL) {
 866     if (empty($path) || empty($fileType)) {
 867       return '';
 868     }
 869     elseif (empty($url)) {
 870       $fileName = basename($path);
 871       $url = CRM_Utils_System::url('civicrm/file', "reset=1&filename={$fileName}&mime-type={$fileType}");
 872     }
 873     switch ($fileType) {
 874       case 'image/jpeg':
 875       case 'image/pjpeg':
 876       case 'image/gif':
 877       case 'image/x-png':
 878       case 'image/png':
 879       case 'image/jpg':
 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/>
 884           </a>";
 885         break;
 886
 887       default:
 888         $url = sprintf('<a href="%s">%s</a>', $url, self::cleanFileName(basename($path)));
 889         break;
 890     }
 891
 892     return $url;
 893   }
 894
 895   /**
 896    * Return formatted image icon
 897    *
 898    * @param string $imageURL
 899    *   Contact's image url
 900    *
 901    * @return string $url
 902    */
 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);
 907
 908     $url = NULL;
 909     if (!empty($query['photo'])) {
 910       $path = CRM_Core_Config::singleton()->customFileUploadDir . $query['photo'];
 911     }
 912     else {
 913       $path = $url = $imageURL;
 914     }
 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 = [
 919       'tif' => 'tiff',
 920       'jpg' => 'jpeg',
 921       'svg' => 'svg+xml',
 922     ];
 923     $mimeType = 'image/' . CRM_Utils_Array::value(
 924       $fileExtension,
 925       $translateMimeTypes,
 926       $fileExtension
 927     );
 928
 929     return self::getFileURL($path, $mimeType, $url);
 930   }
 931
 932   /**
 933    * Resize an image.
 934    *
 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.
 950    *
 951    * @return string
 952    *   Path to image
 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.
 957    */
 958   public static function resizeImage($sourceFile, $targetWidth, $targetHeight, $suffix = "", $preserveAspect = TRUE) {
 959
 960     // Check if GD is installed
 961     $gdSupport = CRM_Utils_System::getModuleSetting('gd', 'GD Support');
 962     if (!$gdSupport) {
 963       throw new CRM_Core_Exception(ts('Unable to resize image because the GD image library is not currently compiled in your PHP installation.'));
 964     }
 965
 966     $sourceMime = mime_content_type($sourceFile);
 967     if ($sourceMime == 'image/gif') {
 968       $sourceData = imagecreatefromgif($sourceFile);
 969     }
 970     elseif ($sourceMime == 'image/png') {
 971       $sourceData = imagecreatefrompng($sourceFile);
 972     }
 973     elseif ($sourceMime == 'image/jpeg') {
 974       $sourceData = imagecreatefromjpeg($sourceFile);
 975     }
 976     else {
 977       throw new CRM_Core_Exception(ts('Unable to resize image because the file supplied was not an image.'));
 978     }
 979
 980     // get image about original image
 981     $sourceInfo = getimagesize($sourceFile);
 982     $sourceWidth = $sourceInfo[0];
 983     $sourceHeight = $sourceInfo[1];
 984
 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;
 991       }
 992       if ($sourceAspect < $targetAspect) {
 993         $targetWidth = $targetHeight * $sourceAspect;
 994       }
 995     }
 996
 997     // figure out the new filename
 998     $pathParts = pathinfo($sourceFile);
 999     $targetFile = $pathParts['dirname'] . DIRECTORY_SEPARATOR
1000       . $pathParts['filename'] . $suffix . "." . $pathParts['extension'];
1001
1002     $targetData = imagecreatetruecolor($targetWidth, $targetHeight);
1003
1004     // resize
1005     imagecopyresized($targetData, $sourceData,
1006       0, 0, 0, 0,
1007       $targetWidth, $targetHeight, $sourceWidth, $sourceHeight);
1008
1009     // save the resized image
1010     $fp = fopen($targetFile, 'w+');
1011     ob_start();
1012     imagejpeg($targetData);
1013     $image_buffer = ob_get_contents();
1014     ob_end_clean();
1015     imagedestroy($targetData);
1016     fwrite($fp, $image_buffer);
1017     rewind($fp);
1018     fclose($fp);
1019
1020     // return the URL to link to
1021     $config = CRM_Core_Config::singleton();
1022     return $config->imageUploadURL . basename($targetFile);
1023   }
1024
1025   /**
1026    * Get file icon class for specific MIME Type
1027    *
1028    * @param string $mimeType
1029    * @return string
1030    */
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);
1034     }
1035     $iconClasses = Civi::$statics[__CLASS__]['mimeIcons'];
1036     foreach ($iconClasses as $text => $icon) {
1037       if (strpos($mimeType, $text) === 0) {
1038         return $icon;
1039       }
1040     }
1041     return $iconClasses['*'];
1042   }
1043
1044   /**
1045    * Is the filename a safe and valid filename passed in from URL
1046    *
1047    * @param string $fileName
1048    * @return bool
1049    */
1050   public static function isValidFileName($fileName = NULL) {
1051     if ($fileName) {
1052       $check = ($fileName === basename($fileName));
1053       if ($check) {
1054         if (substr($fileName, 0, 1) == '/' || substr($fileName, 0, 1) == '.' || substr($fileName, 0, 1) == DIRECTORY_SEPARATOR) {
1055           $check = FALSE;
1056         }
1057       }
1058       return $check;
1059     }
1060     return FALSE;
1061   }
1062
1063   /**
1064    * Get the extensions that this MimeTpe is for
1065    * @param string $mimeType the mime-type we want extensions for
1066    * @return array
1067    */
1068   public static function getAcceptableExtensionsForMimeType($mimeType = []) {
1069     $mimeRepostory = new \MimeTyper\Repository\ExtendedRepository();
1070     return $mimeRepostory->findExtensions($mimeType);
1071   }
1072
1073   /**
1074    * Get the extension of a file based on its path
1075    * @param string $path path of the file to query
1076    * @return string
1077    */
1078   public static function getExtensionFromPath($path) {
1079     return pathinfo($path, PATHINFO_EXTENSION);
1080   }
1081
1082 }