CRM/Utils/File.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * class to provide simple static functions for file objects
  36  */
  37 class CRM_Utils_File {
  38
  39   /**
  40    * Given a file name, determine if the file contents make it an ascii file
  41    *
  42    * @param string $name
  43    *   Name of file.
  44    *
  45    * @return bool
  46    *   true if file is ascii
  47    */
  48   public static function isAscii($name) {
  49     $fd = fopen($name, "r");
  50     if (!$fd) {
  51       return FALSE;
  52     }
  53
  54     $ascii = TRUE;
  55     while (!feof($fd)) {
  56       $line = fgets($fd, 8192);
  57       if (!CRM_Utils_String::isAscii($line)) {
  58         $ascii = FALSE;
  59         break;
  60       }
  61     }
  62
  63     fclose($fd);
  64     return $ascii;
  65   }
  66
  67   /**
  68    * Given a file name, determine if the file contents make it an html file
  69    *
  70    * @param string $name
  71    *   Name of file.
  72    *
  73    * @return bool
  74    *   true if file is html
  75    */
  76   public static function isHtml($name) {
  77     $fd = fopen($name, "r");
  78     if (!$fd) {
  79       return FALSE;
  80     }
  81
  82     $html = FALSE;
  83     $lineCount = 0;
  84     while (!feof($fd) & $lineCount <= 5) {
  85       $lineCount++;
  86       $line = fgets($fd, 8192);
  87       if (!CRM_Utils_String::isHtml($line)) {
  88         $html = TRUE;
  89         break;
  90       }
  91     }
  92
  93     fclose($fd);
  94     return $html;
  95   }
  96
  97   /**
  98    * Create a directory given a path name, creates parent directories
  99    * if needed
 100    *
 101    * @param string $path
 102    *   The path name.
 103    * @param bool $abort
 104    *   Should we abort or just return an invalid code.
 105    * @return bool|NULL
 106    *   NULL: Folder already exists or was not specified.
 107    *   TRUE: Creation succeeded.
 108    *   FALSE: Creation failed.
 109    */
 110   public static function createDir($path, $abort = TRUE) {
 111     if (is_dir($path) || empty($path)) {
 112       return NULL;
 113     }
 114
 115     CRM_Utils_File::createDir(dirname($path), $abort);
 116     if (@mkdir($path, 0777) == FALSE) {
 117       if ($abort) {
 118         $docLink = CRM_Utils_System::docURL2('Moving an Existing Installation to a New Server or Location', NULL, NULL, NULL, NULL, "wiki");
 119         echo "Error: Could not create directory: $path.<p>If you have moved an existing CiviCRM installation from one location or server to another there are several steps you will need to follow. They are detailed on this CiviCRM wiki page - {$docLink}. A fix for the specific problem that caused this error message to be displayed is to set the value of the config_backend column in the civicrm_domain table to NULL. However we strongly recommend that you review and follow all the steps in that document.</p>";
 120
 121         CRM_Utils_System::civiExit();
 122       }
 123       else {
 124         return FALSE;
 125       }
 126     }
 127     return TRUE;
 128   }
 129
 130   /**
 131    * Delete a directory given a path name, delete children directories
 132    * and files if needed
 133    *
 134    * @param string $target
 135    *   The path name.
 136    * @param bool $rmdir
 137    * @param bool $verbose
 138    *
 139    * @throws Exception
 140    */
 141   public static function cleanDir($target, $rmdir = TRUE, $verbose = TRUE) {
 142     static $exceptions = ['.', '..'];
 143     if ($target == '' || $target == '/' || !$target) {
 144       throw new Exception("Overly broad deletion");
 145     }
 146
 147     if ($dh = @opendir($target)) {
 148       while (FALSE !== ($sibling = readdir($dh))) {
 149         if (!in_array($sibling, $exceptions)) {
 150           $object = $target . DIRECTORY_SEPARATOR . $sibling;
 151
 152           if (is_dir($object)) {
 153             CRM_Utils_File::cleanDir($object, $rmdir, $verbose);
 154           }
 155           elseif (is_file($object)) {
 156             if (!unlink($object)) {
 157               CRM_Core_Session::setStatus(ts('Unable to remove file %1', [1 => $object]), ts('Warning'), 'error');
 158             }
 159           }
 160         }
 161       }
 162       closedir($dh);
 163
 164       if ($rmdir) {
 165         if (rmdir($target)) {
 166           if ($verbose) {
 167             CRM_Core_Session::setStatus(ts('Removed directory %1', [1 => $target]), '', 'success');
 168           }
 169           return TRUE;
 170         }
 171         else {
 172           CRM_Core_Session::setStatus(ts('Unable to remove directory %1', [1 => $target]), ts('Warning'), 'error');
 173         }
 174       }
 175     }
 176   }
 177
 178   /**
 179    * Concatenate several files.
 180    *
 181    * @param array $files
 182    *   List of file names.
 183    * @param string $delim
 184    *   An optional delimiter to put between files.
 185    * @return string
 186    */
 187   public static function concat($files, $delim = '') {
 188     $buf = '';
 189     $first = TRUE;
 190     foreach ($files as $file) {
 191       if (!$first) {
 192         $buf .= $delim;
 193       }
 194       $buf .= file_get_contents($file);
 195       $first = FALSE;
 196     }
 197     return $buf;
 198   }
 199
 200   /**
 201    * @param string $source
 202    * @param string $destination
 203    */
 204   public static function copyDir($source, $destination) {
 205     if ($dh = opendir($source)) {
 206       @mkdir($destination);
 207       while (FALSE !== ($file = readdir($dh))) {
 208         if (($file != '.') && ($file != '..')) {
 209           if (is_dir($source . DIRECTORY_SEPARATOR . $file)) {
 210             CRM_Utils_File::copyDir($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
 211           }
 212           else {
 213             copy($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
 214           }
 215         }
 216       }
 217       closedir($dh);
 218     }
 219   }
 220
 221   /**
 222    * Given a file name, recode it (in place!) to UTF-8
 223    *
 224    * @param string $name
 225    *   Name of file.
 226    *
 227    * @return bool
 228    *   whether the file was recoded properly
 229    */
 230   public static function toUtf8($name) {
 231     static $config = NULL;
 232     static $legacyEncoding = NULL;
 233     if ($config == NULL) {
 234       $config = CRM_Core_Config::singleton();
 235       $legacyEncoding = $config->legacyEncoding;
 236     }
 237
 238     if (!function_exists('iconv')) {
 239
 240       return FALSE;
 241
 242     }
 243
 244     $contents = file_get_contents($name);
 245     if ($contents === FALSE) {
 246       return FALSE;
 247     }
 248
 249     $contents = iconv($legacyEncoding, 'UTF-8', $contents);
 250     if ($contents === FALSE) {
 251       return FALSE;
 252     }
 253
 254     $file = fopen($name, 'w');
 255     if ($file === FALSE) {
 256       return FALSE;
 257     }
 258
 259     $written = fwrite($file, $contents);
 260     $closed = fclose($file);
 261     if ($written === FALSE or !$closed) {
 262       return FALSE;
 263     }
 264
 265     return TRUE;
 266   }
 267
 268   /**
 269    * Appends a slash to the end of a string if it doesn't already end with one
 270    *
 271    * @param string $path
 272    * @param string $slash
 273    *
 274    * @return string
 275    */
 276   public static function addTrailingSlash($path, $slash = NULL) {
 277     if (!$slash) {
 278       // FIXME: Defaulting to backslash on windows systems can produce
 279       // unexpected results, esp for URL strings which should always use forward-slashes.
 280       // I think this fn should default to forward-slash instead.
 281       $slash = DIRECTORY_SEPARATOR;
 282     }
 283     if (!in_array(substr($path, -1, 1), ['/', '\\'])) {
 284       $path .= $slash;
 285     }
 286     return $path;
 287   }
 288
 289   /**
 290    * Save a fake file somewhere
 291    *
 292    * @param string $dir
 293    *   The directory where the file should be saved.
 294    * @param string $contents
 295    *   Optional: the contents of the file.
 296    * @param string $fileName
 297    *
 298    * @return string
 299    *   The filename saved, or FALSE on failure.
 300    */
 301   public static function createFakeFile($dir, $contents = 'delete me', $fileName = NULL) {
 302     $dir = self::addTrailingSlash($dir);
 303     if (!$fileName) {
 304       $fileName = 'delete-this-' . CRM_Utils_String::createRandom(10, CRM_Utils_String::ALPHANUMERIC);
 305     }
 306     $success = @file_put_contents($dir . $fileName, $contents);
 307
 308     return ($success === FALSE) ? FALSE : $fileName;
 309   }
 310
 311   /**
 312    * @param string|NULL $dsn
 313    *   Use NULL to load the default/active connection from CRM_Core_DAO.
 314    *   Otherwise, give a full DSN string.
 315    * @param string $fileName
 316    * @param string $prefix
 317    * @param bool $dieOnErrors
 318    */
 319   public static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $dieOnErrors = TRUE) {
 320     if (FALSE === file_get_contents($fileName)) {
 321       // Our file cannot be found.
 322       // Using 'die' here breaks this on extension upgrade.
 323       throw new CRM_Exception('Could not find the SQL file.');
 324     }
 325
 326     self::runSqlQuery($dsn, file_get_contents($fileName), $prefix, $dieOnErrors);
 327   }
 328
 329   /**
 330    *
 331    * @param string|NULL $dsn
 332    * @param string $queryString
 333    * @param string $prefix
 334    * @param bool $dieOnErrors
 335    */
 336   public static function runSqlQuery($dsn, $queryString, $prefix = NULL, $dieOnErrors = TRUE) {
 337     $string = $prefix . $queryString;
 338
 339     if ($dsn === NULL) {
 340       $db = CRM_Core_DAO::getConnection();
 341     }
 342     else {
 343       require_once 'DB.php';
 344       $db = DB::connect($dsn);
 345     }
 346
 347     if (PEAR::isError($db)) {
 348       die("Cannot open $dsn: " . $db->getMessage());
 349     }
 350     if (CRM_Utils_Constant::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System::isDevelopment())) {
 351       $db->query('SET SESSION sql_mode = STRICT_TRANS_TABLES');
 352     }
 353     $db->query('SET NAMES utf8');
 354     $transactionId = CRM_Utils_Type::escape(CRM_Utils_Request::id(), 'String');
 355     $db->query('SET @uniqueID = ' . "'$transactionId'");
 356
 357     // get rid of comments starting with # and --
 358
 359     $string = self::stripComments($string);
 360
 361     $queries = preg_split('/;\s*$/m', $string);
 362     foreach ($queries as $query) {
 363       $query = trim($query);
 364       if (!empty($query)) {
 365         CRM_Core_Error::debug_query($query);
 366         $res = &$db->query($query);
 367         if (PEAR::isError($res)) {
 368           if ($dieOnErrors) {
 369             die("Cannot execute $query: " . $res->getMessage());
 370           }
 371           else {
 372             echo "Cannot execute $query: " . $res->getMessage() . "<p>";
 373           }
 374         }
 375       }
 376     }
 377   }
 378
 379   /**
 380    *
 381    * Strips comment from a possibly multiline SQL string
 382    *
 383    * @param string $string
 384    *
 385    * @return string
 386    *   stripped string
 387    */
 388   public static function stripComments($string) {
 389     return preg_replace("/^(#|--).*\R*/m", "", $string);
 390   }
 391
 392   /**
 393    * @param $ext
 394    *
 395    * @return bool
 396    */
 397   public static function isExtensionSafe($ext) {
 398     static $extensions = NULL;
 399     if (!$extensions) {
 400       $extensions = CRM_Core_OptionGroup::values('safe_file_extension', TRUE);
 401
 402       // make extensions to lowercase
 403       $extensions = array_change_key_case($extensions, CASE_LOWER);
 404       // allow html/htm extension ONLY if the user is admin
 405       // and/or has access CiviMail
 406       if (!(CRM_Core_Permission::check('access CiviMail') ||
 407         CRM_Core_Permission::check('administer CiviCRM') ||
 408         (CRM_Mailing_Info::workflowEnabled() &&
 409           CRM_Core_Permission::check('create mailings')
 410         )
 411       )
 412       ) {
 413         unset($extensions['html']);
 414         unset($extensions['htm']);
 415       }
 416     }
 417     // support lower and uppercase file extensions
 418     return isset($extensions[strtolower($ext)]) ? TRUE : FALSE;
 419   }
 420
 421   /**
 422    * Determine whether a given file is listed in the PHP include path.
 423    *
 424    * @param string $name
 425    *   Name of file.
 426    *
 427    * @return bool
 428    *   whether the file can be include()d or require()d
 429    */
 430   public static function isIncludable($name) {
 431     $x = @fopen($name, 'r', TRUE);
 432     if ($x) {
 433       fclose($x);
 434       return TRUE;
 435     }
 436     else {
 437       return FALSE;
 438     }
 439   }
 440
 441   /**
 442    * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it.
 443    *
 444    * @param $name
 445    *
 446    * @return mixed
 447    */
 448   public static function cleanFileName($name) {
 449     // replace the last 33 character before the '.' with null
 450     $name = preg_replace('/(_[\w]{32})\./', '.', $name);
 451     return $name;
 452   }
 453
 454   /**
 455    * Make a valid file name.
 456    *
 457    * @param string $name
 458    *
 459    * @return string
 460    */
 461   public static function makeFileName($name) {
 462     $uniqID = md5(uniqid(rand(), TRUE));
 463     $info = pathinfo($name);
 464     $basename = substr($info['basename'],
 465       0, -(strlen(CRM_Utils_Array::value('extension', $info)) + (CRM_Utils_Array::value('extension', $info) == '' ? 0 : 1))
 466     );
 467     if (!self::isExtensionSafe(CRM_Utils_Array::value('extension', $info))) {
 468       // munge extension so it cannot have an embbeded dot in it
 469       // The maximum length of a filename for most filesystems is 255 chars.
 470       // We'll truncate at 240 to give some room for the extension.
 471       return CRM_Utils_String::munge("{$basename}_" . CRM_Utils_Array::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown";
 472     }
 473     else {
 474       return CRM_Utils_String::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array::value('extension', $info);
 475     }
 476   }
 477
 478   /**
 479    * Copies a file
 480    *
 481    * @param $filePath
 482    * @return mixed
 483    */
 484   public static function duplicate($filePath) {
 485     $oldName = pathinfo($filePath, PATHINFO_FILENAME);
 486     $uniqID = md5(uniqid(rand(), TRUE));
 487     $newName = preg_replace('/(_[\w]{32})$/', '', $oldName) . '_' . $uniqID;
 488     $newPath = str_replace($oldName, $newName, $filePath);
 489     copy($filePath, $newPath);
 490     return $newPath;
 491   }
 492
 493   /**
 494    * Get files for the extension.
 495    *
 496    * @param string $path
 497    * @param string $ext
 498    *
 499    * @return array
 500    */
 501   public static function getFilesByExtension($path, $ext) {
 502     $path = self::addTrailingSlash($path);
 503     $files = [];
 504     if ($dh = opendir($path)) {
 505       while (FALSE !== ($elem = readdir($dh))) {
 506         if (substr($elem, -(strlen($ext) + 1)) == '.' . $ext) {
 507           $files[] .= $path . $elem;
 508         }
 509       }
 510       closedir($dh);
 511     }
 512     return $files;
 513   }
 514
 515   /**
 516    * Restrict access to a given directory (by planting there a restrictive .htaccess file)
 517    *
 518    * @param string $dir
 519    *   The directory to be secured.
 520    * @param bool $overwrite
 521    */
 522   public static function restrictAccess($dir, $overwrite = FALSE) {
 523     // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
 524     // of site, causing site to stop functioning.
 525     // FIXME: we should do more checks here -
 526     if (!empty($dir) && is_dir($dir)) {
 527       $htaccess = <<<HTACCESS
 528 <Files "*">
 529 # Apache 2.2
 530   <IfModule !authz_core_module>
 531     Order allow,deny
 532     Deny from all
 533   </IfModule>
 534
 535 # Apache 2.4+
 536   <IfModule authz_core_module>
 537     Require all denied
 538   </IfModule>
 539 </Files>
 540
 541 HTACCESS;
 542       $file = $dir . '.htaccess';
 543       if ($overwrite || !file_exists($file)) {
 544         if (file_put_contents($file, $htaccess) === FALSE) {
 545           CRM_Core_Error::movedSiteError($file);
 546         }
 547       }
 548     }
 549   }
 550
 551   /**
 552    * Restrict remote users from browsing the given directory.
 553    *
 554    * @param $publicDir
 555    */
 556   public static function restrictBrowsing($publicDir) {
 557     if (!is_dir($publicDir) || !is_writable($publicDir)) {
 558       return;
 559     }
 560
 561     // base dir
 562     $nobrowse = realpath($publicDir) . '/index.html';
 563     if (!file_exists($nobrowse)) {
 564       @file_put_contents($nobrowse, '');
 565     }
 566
 567     // child dirs
 568     $dir = new RecursiveDirectoryIterator($publicDir);
 569     foreach ($dir as $name => $object) {
 570       if (is_dir($name) && $name != '..') {
 571         $nobrowse = realpath($name) . '/index.html';
 572         if (!file_exists($nobrowse)) {
 573           @file_put_contents($nobrowse, '');
 574         }
 575       }
 576     }
 577   }
 578
 579   /**
 580    * Create the base file path from which all our internal directories are
 581    * offset. This is derived from the template compile directory set
 582    */
 583   public static function baseFilePath() {
 584     static $_path = NULL;
 585     if (!$_path) {
 586       // Note: Don't rely on $config; that creates a dependency loop.
 587       if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
 588         throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR");
 589       }
 590       $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR;
 591
 592       $path = dirname($templateCompileDir);
 593
 594       //this fix is to avoid creation of upload dirs inside templates_c directory
 595       $checkPath = explode(DIRECTORY_SEPARATOR, $path);
 596
 597       $cnt = count($checkPath) - 1;
 598       if ($checkPath[$cnt] == 'templates_c') {
 599         unset($checkPath[$cnt]);
 600         $path = implode(DIRECTORY_SEPARATOR, $checkPath);
 601       }
 602
 603       $_path = CRM_Utils_File::addTrailingSlash($path);
 604     }
 605     return $_path;
 606   }
 607
 608   /**
 609    * Determine if a path is absolute.
 610    *
 611    * @param string $path
 612    *
 613    * @return bool
 614    *   TRUE if absolute. FALSE if relative.
 615    */
 616   public static function isAbsolute($path) {
 617     if (substr($path, 0, 1) === DIRECTORY_SEPARATOR) {
 618       return TRUE;
 619     }
 620     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 621       if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
 622         return TRUE;
 623       }
 624     }
 625     return FALSE;
 626   }
 627
 628   /**
 629    * @param $directory
 630    *
 631    * @return string
 632    */
 633   public static function relativeDirectory($directory) {
 634     // Do nothing on windows
 635     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 636       return $directory;
 637     }
 638
 639     // check if directory is relative, if so return immediately
 640     if (!self::isAbsolute($directory)) {
 641       return $directory;
 642     }
 643
 644     // make everything relative from the baseFilePath
 645     $basePath = self::baseFilePath();
 646     // check if basePath is a substr of $directory, if so
 647     // return rest of string
 648     if (substr($directory, 0, strlen($basePath)) == $basePath) {
 649       return substr($directory, strlen($basePath));
 650     }
 651
 652     // return the original value
 653     return $directory;
 654   }
 655
 656   /**
 657    * @param $directory
 658    * @param string|NULL $basePath
 659    *   The base path when evaluating relative paths. Should include trailing slash.
 660    *
 661    * @return string
 662    */
 663   public static function absoluteDirectory($directory, $basePath = NULL) {
 664     // check if directory is already absolute, if so return immediately
 665     // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
 666     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
 667       return $directory;
 668     }
 669
 670     // check if directory is already absolute, if so return immediately
 671     if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR) {
 672       return $directory;
 673     }
 674
 675     // make everything absolute from the baseFilePath
 676     $basePath = ($basePath === NULL) ? self::baseFilePath() : $basePath;
 677
 678     // ensure that $basePath has a trailing slash
 679     $basePath = self::addTrailingSlash($basePath);
 680     return $basePath . $directory;
 681   }
 682
 683   /**
 684    * Make a file path relative to some base dir.
 685    *
 686    * @param $directory
 687    * @param $basePath
 688    *
 689    * @return string
 690    */
 691   public static function relativize($directory, $basePath) {
 692     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 693       $directory = strtr($directory, '\\', '/');
 694       $basePath = strtr($basePath, '\\', '/');
 695     }
 696     if (substr($directory, 0, strlen($basePath)) == $basePath) {
 697       return substr($directory, strlen($basePath));
 698     }
 699     else {
 700       return $directory;
 701     }
 702   }
 703
 704   /**
 705    * Create a path to a temporary file which can endure for multiple requests.
 706    *
 707    * @todo Automatic file cleanup using, eg, TTL policy
 708    *
 709    * @param string $prefix
 710    *
 711    * @return string, path to an openable/writable file
 712    * @see tempnam
 713    */
 714   public static function tempnam($prefix = 'tmp-') {
 715     // $config = CRM_Core_Config::singleton();
 716     // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
 717     // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
 718     $fileName = tempnam(sys_get_temp_dir(), $prefix);
 719     return $fileName;
 720   }
 721
 722   /**
 723    * Create a path to a temporary directory which can endure for multiple requests.
 724    *
 725    * @todo Automatic file cleanup using, eg, TTL policy
 726    *
 727    * @param string $prefix
 728    *
 729    * @return string, path to an openable/writable directory; ends with '/'
 730    * @see tempnam
 731    */
 732   public static function tempdir($prefix = 'tmp-') {
 733     $fileName = self::tempnam($prefix);
 734     unlink($fileName);
 735     mkdir($fileName, 0700);
 736     return $fileName . '/';
 737   }
 738
 739   /**
 740    * Search directory tree for files which match a glob pattern.
 741    *
 742    * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
 743    *
 744    * @param string $dir
 745    *   base dir.
 746    * @param string $pattern
 747    *   glob pattern, eg "*.txt".
 748    * @param bool $relative
 749    *   TRUE if paths should be made relative to $dir
 750    * @return array(string)
 751    */
 752   public static function findFiles($dir, $pattern, $relative = FALSE) {
 753     if (!is_dir($dir)) {
 754       return [];
 755     }
 756     $dir = rtrim($dir, '/');
 757     $todos = [$dir];
 758     $result = [];
 759     while (!empty($todos)) {
 760       $subdir = array_shift($todos);
 761       $matches = glob("$subdir/$pattern");
 762       if (is_array($matches)) {
 763         foreach ($matches as $match) {
 764           if (!is_dir($match)) {
 765             $result[] = $relative ? CRM_Utils_File::relativize($match, "$dir/") : $match;
 766           }
 767         }
 768       }
 769       if ($dh = opendir($subdir)) {
 770         while (FALSE !== ($entry = readdir($dh))) {
 771           $path = $subdir . DIRECTORY_SEPARATOR . $entry;
 772           if ($entry{0} == '.') {
 773             // ignore
 774           }
 775           elseif (is_dir($path)) {
 776             $todos[] = $path;
 777           }
 778         }
 779         closedir($dh);
 780       }
 781     }
 782     return $result;
 783   }
 784
 785   /**
 786    * Determine if $child is a sub-directory of $parent
 787    *
 788    * @param string $parent
 789    * @param string $child
 790    * @param bool $checkRealPath
 791    *
 792    * @return bool
 793    */
 794   public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
 795     if ($checkRealPath) {
 796       $parent = realpath($parent);
 797       $child = realpath($child);
 798     }
 799     $parentParts = explode('/', rtrim($parent, '/'));
 800     $childParts = explode('/', rtrim($child, '/'));
 801     while (($parentPart = array_shift($parentParts)) !== NULL) {
 802       $childPart = array_shift($childParts);
 803       if ($parentPart != $childPart) {
 804         return FALSE;
 805       }
 806     }
 807     if (empty($childParts)) {
 808       // same directory
 809       return FALSE;
 810     }
 811     else {
 812       return TRUE;
 813     }
 814   }
 815
 816   /**
 817    * Move $fromDir to $toDir, replacing/deleting any
 818    * pre-existing content.
 819    *
 820    * @param string $fromDir
 821    *   The directory which should be moved.
 822    * @param string $toDir
 823    *   The new location of the directory.
 824    * @param bool $verbose
 825    *
 826    * @return bool
 827    *   TRUE on success
 828    */
 829   public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
 830     if (is_dir($toDir)) {
 831       if (!self::cleanDir($toDir, TRUE, $verbose)) {
 832         return FALSE;
 833       }
 834     }
 835
 836     // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
 837
 838     CRM_Utils_File::copyDir($fromDir, $toDir);
 839     if (!CRM_Utils_File::cleanDir($fromDir, TRUE, FALSE)) {
 840       CRM_Core_Session::setStatus(ts('Failed to clean temp dir: %1', [1 => $fromDir]), '', 'alert');
 841       return FALSE;
 842     }
 843     return TRUE;
 844   }
 845
 846   /**
 847    * Format file.
 848    *
 849    * @param array $param
 850    * @param string $fileName
 851    * @param array $extraParams
 852    */
 853   public static function formatFile(&$param, $fileName, $extraParams = []) {
 854     if (empty($param[$fileName])) {
 855       return;
 856     }
 857
 858     $fileParams = [
 859       'uri' => $param[$fileName]['name'],
 860       'type' => $param[$fileName]['type'],
 861       'location' => $param[$fileName]['name'],
 862       'upload_date' => date('YmdHis'),
 863     ] + $extraParams;
 864
 865     $param[$fileName] = $fileParams;
 866   }
 867
 868   /**
 869    * Return formatted file URL, like for image file return image url with image icon
 870    *
 871    * @param string $path
 872    *   Absoulte file path
 873    * @param string $fileType
 874    * @param string $url
 875    *   File preview link e.g. https://example.com/civicrm/file?reset=1&filename=image.png&mime-type=image/png
 876    *
 877    * @return string $url
 878    */
 879   public static function getFileURL($path, $fileType, $url = NULL) {
 880     if (empty($path) || empty($fileType)) {
 881       return '';
 882     }
 883     elseif (empty($url)) {
 884       $fileName = basename($path);
 885       $url = CRM_Utils_System::url('civicrm/file', "reset=1&filename={$fileName}&mime-type={$fileType}");
 886     }
 887     switch ($fileType) {
 888       case 'image/jpeg':
 889       case 'image/pjpeg':
 890       case 'image/gif':
 891       case 'image/x-png':
 892       case 'image/png':
 893       case 'image/jpg':
 894         list($imageWidth, $imageHeight) = getimagesize($path);
 895         list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight);
 896         $url = "<a href=\"$url\" class='crm-image-popup'>
 897           <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
 898           </a>";
 899         break;
 900
 901       default:
 902         $url = sprintf('<a href="%s">%s</a>', $url, self::cleanFileName(basename($path)));
 903         break;
 904     }
 905
 906     return $url;
 907   }
 908
 909   /**
 910    * Return formatted image icon
 911    *
 912    * @param string $imageURL
 913    *   Contact's image url
 914    *
 915    * @return string $url
 916    */
 917   public static function getImageURL($imageURL) {
 918     // retrieve image name from $imageURL
 919     $imageURL = CRM_Utils_String::unstupifyUrl($imageURL);
 920     parse_str(parse_url($imageURL, PHP_URL_QUERY), $query);
 921
 922     $url = NULL;
 923     if (!empty($query['photo'])) {
 924       $path = CRM_Core_Config::singleton()->customFileUploadDir . $query['photo'];
 925     }
 926     else {
 927       $path = $url = $imageURL;
 928     }
 929     $fileExtension = strtolower(pathinfo($path, PATHINFO_EXTENSION));
 930     //According to (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types),
 931     // there are some extensions that would need translating.:
 932     $translateMimeTypes = [
 933       'tif' => 'tiff',
 934       'jpg' => 'jpeg',
 935       'svg' => 'svg+xml',
 936     ];
 937     $mimeType = 'image/' . CRM_Utils_Array::value(
 938       $fileExtension,
 939       $translateMimeTypes,
 940       $fileExtension
 941     );
 942
 943     return self::getFileURL($path, $mimeType, $url);
 944   }
 945
 946   /**
 947    * Resize an image.
 948    *
 949    * @param string $sourceFile
 950    *   Filesystem path to existing image on server
 951    * @param int $targetWidth
 952    *   New width desired, in pixels
 953    * @param int $targetHeight
 954    *   New height desired, in pixels
 955    * @param string $suffix = ""
 956    *   If supplied, the image will be renamed to include this suffix. For
 957    *   example if the original file name is "foo.png" and $suffix = "_bar",
 958    *   then the final file name will be "foo_bar.png".
 959    * @param bool $preserveAspect = TRUE
 960    *   When TRUE $width and $height will be used as a bounding box, outside of
 961    *   which the resized image will not extend.
 962    *   When FALSE, the image will be resized exactly to $width and $height, even
 963    *   if it means stretching it.
 964    *
 965    * @return string
 966    *   Path to image
 967    * @throws \CRM_Core_Exception
 968    *   Under the following conditions
 969    *   - When GD is not available.
 970    *   - When the source file is not an image.
 971    */
 972   public static function resizeImage($sourceFile, $targetWidth, $targetHeight, $suffix = "", $preserveAspect = TRUE) {
 973
 974     // Check if GD is installed
 975     $gdSupport = CRM_Utils_System::getModuleSetting('gd', 'GD Support');
 976     if (!$gdSupport) {
 977       throw new CRM_Core_Exception(ts('Unable to resize image because the GD image library is not currently compiled in your PHP installation.'));
 978     }
 979
 980     $sourceMime = mime_content_type($sourceFile);
 981     if ($sourceMime == 'image/gif') {
 982       $sourceData = imagecreatefromgif($sourceFile);
 983     }
 984     elseif ($sourceMime == 'image/png') {
 985       $sourceData = imagecreatefrompng($sourceFile);
 986     }
 987     elseif ($sourceMime == 'image/jpeg') {
 988       $sourceData = imagecreatefromjpeg($sourceFile);
 989     }
 990     else {
 991       throw new CRM_Core_Exception(ts('Unable to resize image because the file supplied was not an image.'));
 992     }
 993
 994     // get image about original image
 995     $sourceInfo = getimagesize($sourceFile);
 996     $sourceWidth = $sourceInfo[0];
 997     $sourceHeight = $sourceInfo[1];
 998
 999     // Adjust target width/height if preserving aspect ratio
1000     if ($preserveAspect) {
1001       $sourceAspect = $sourceWidth / $sourceHeight;
1002       $targetAspect = $targetWidth / $targetHeight;
1003       if ($sourceAspect > $targetAspect) {
1004         $targetHeight = $targetWidth / $sourceAspect;
1005       }
1006       if ($sourceAspect < $targetAspect) {
1007         $targetWidth = $targetHeight * $sourceAspect;
1008       }
1009     }
1010
1011     // figure out the new filename
1012     $pathParts = pathinfo($sourceFile);
1013     $targetFile = $pathParts['dirname'] . DIRECTORY_SEPARATOR
1014       . $pathParts['filename'] . $suffix . "." . $pathParts['extension'];
1015
1016     $targetData = imagecreatetruecolor($targetWidth, $targetHeight);
1017
1018     // resize
1019     imagecopyresized($targetData, $sourceData,
1020       0, 0, 0, 0,
1021       $targetWidth, $targetHeight, $sourceWidth, $sourceHeight);
1022
1023     // save the resized image
1024     $fp = fopen($targetFile, 'w+');
1025     ob_start();
1026     imagejpeg($targetData);
1027     $image_buffer = ob_get_contents();
1028     ob_end_clean();
1029     imagedestroy($targetData);
1030     fwrite($fp, $image_buffer);
1031     rewind($fp);
1032     fclose($fp);
1033
1034     // return the URL to link to
1035     $config = CRM_Core_Config::singleton();
1036     return $config->imageUploadURL . basename($targetFile);
1037   }
1038
1039   /**
1040    * Get file icon class for specific MIME Type
1041    *
1042    * @param string $mimeType
1043    * @return string
1044    */
1045   public static function getIconFromMimeType($mimeType) {
1046     if (!isset(Civi::$statics[__CLASS__]['mimeIcons'])) {
1047       Civi::$statics[__CLASS__]['mimeIcons'] = json_decode(file_get_contents(__DIR__ . '/File/mimeIcons.json'), TRUE);
1048     }
1049     $iconClasses = Civi::$statics[__CLASS__]['mimeIcons'];
1050     foreach ($iconClasses as $text => $icon) {
1051       if (strpos($mimeType, $text) === 0) {
1052         return $icon;
1053       }
1054     }
1055     return $iconClasses['*'];
1056   }
1057
1058   /**
1059    * Is the filename a safe and valid filename passed in from URL
1060    *
1061    * @param string $fileName
1062    * @return bool
1063    */
1064   public static function isValidFileName($fileName = NULL) {
1065     if ($fileName) {
1066       $check = $fileName !== basename($fileName) ? FALSE : TRUE;
1067       if ($check) {
1068         if (substr($fileName, 0, 1) == '/' || substr($fileName, 0, 1) == '.' || substr($fileName, 0, 1) == DIRECTORY_SEPARATOR) {
1069           $check = FALSE;
1070         }
1071       }
1072       return $check;
1073     }
1074     return FALSE;
1075   }
1076
1077   /**
1078    * Get the extensions that this MimeTpe is for
1079    * @param string $mimeType the mime-type we want extensions for
1080    * @return array
1081    */
1082   public static function getAcceptableExtensionsForMimeType($mimeType = NULL) {
1083     $mapping = \MimeType\Mapping::$types;
1084     $extensions = [];
1085     foreach ($mapping as $extension => $type) {
1086       if ($mimeType == $type) {
1087         $extensions[] = $extension;
1088       }
1089     }
1090     return $extensions;
1091   }
1092
1093   /**
1094    * Get the extension of a file based on its path
1095    * @param string $path path of the file to query
1096    * @return string
1097    */
1098   public static function getExtensionFromPath($path) {
1099     return pathinfo($path, PATHINFO_EXTENSION);
1100   }
1101
1102 }