CRM/Utils/File.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  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 = array('.', '..');
 143     if ($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', array(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', array(1 => $target)), '', 'success');
 168           }
 169           return TRUE;
 170         }
 171         else {
 172           CRM_Core_Session::setStatus(ts('Unable to remove directory %1', array(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), array('/', '\\'))) {
 284       $path .= $slash;
 285     }
 286     return $path;
 287   }
 288
 289   /**
 290    * @param string|NULL $dsn
 291    *   Use NULL to load the default/active connection from CRM_Core_DAO.
 292    *   Otherwise, give a full DSN string.
 293    * @param string $fileName
 294    * @param null $prefix
 295    * @param bool $isQueryString
 296    * @param bool $dieOnErrors
 297    */
 298   public static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $isQueryString = FALSE, $dieOnErrors = TRUE) {
 299     if ($dsn === NULL) {
 300       $db = CRM_Core_DAO::getConnection();
 301     }
 302     else {
 303       require_once 'DB.php';
 304       $db = DB::connect($dsn);
 305     }
 306
 307     if (PEAR::isError($db)) {
 308       die("Cannot open $dsn: " . $db->getMessage());
 309     }
 310     if (CRM_Utils_Constant::value('CIVICRM_MYSQL_STRICT', CRM_Utils_System::isDevelopment())) {
 311       $db->query('SET SESSION sql_mode = STRICT_TRANS_TABLES');
 312     }
 313     $db->query('SET NAMES utf8');
 314
 315     if (!$isQueryString) {
 316       $string = $prefix . file_get_contents($fileName);
 317     }
 318     else {
 319       // use filename as query string
 320       $string = $prefix . $fileName;
 321     }
 322
 323     // get rid of comments starting with # and --
 324
 325     $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
 326     $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
 327
 328     $queries = preg_split('/;\s*$/m', $string);
 329     foreach ($queries as $query) {
 330       $query = trim($query);
 331       if (!empty($query)) {
 332         CRM_Core_Error::debug_query($query);
 333         $res = &$db->query($query);
 334         if (PEAR::isError($res)) {
 335           if ($dieOnErrors) {
 336             die("Cannot execute $query: " . $res->getMessage());
 337           }
 338           else {
 339             echo "Cannot execute $query: " . $res->getMessage() . "<p>";
 340           }
 341         }
 342       }
 343     }
 344   }
 345
 346   /**
 347    * @param $ext
 348    *
 349    * @return bool
 350    */
 351   public static function isExtensionSafe($ext) {
 352     static $extensions = NULL;
 353     if (!$extensions) {
 354       $extensions = CRM_Core_OptionGroup::values('safe_file_extension', TRUE);
 355
 356       // make extensions to lowercase
 357       $extensions = array_change_key_case($extensions, CASE_LOWER);
 358       // allow html/htm extension ONLY if the user is admin
 359       // and/or has access CiviMail
 360       if (!(CRM_Core_Permission::check('access CiviMail') ||
 361         CRM_Core_Permission::check('administer CiviCRM') ||
 362         (CRM_Mailing_Info::workflowEnabled() &&
 363           CRM_Core_Permission::check('create mailings')
 364         )
 365       )
 366       ) {
 367         unset($extensions['html']);
 368         unset($extensions['htm']);
 369       }
 370     }
 371     // support lower and uppercase file extensions
 372     return isset($extensions[strtolower($ext)]) ? TRUE : FALSE;
 373   }
 374
 375   /**
 376    * Determine whether a given file is listed in the PHP include path.
 377    *
 378    * @param string $name
 379    *   Name of file.
 380    *
 381    * @return bool
 382    *   whether the file can be include()d or require()d
 383    */
 384   public static function isIncludable($name) {
 385     $x = @fopen($name, 'r', TRUE);
 386     if ($x) {
 387       fclose($x);
 388       return TRUE;
 389     }
 390     else {
 391       return FALSE;
 392     }
 393   }
 394
 395   /**
 396    * Remove the 32 bit md5 we add to the fileName also remove the unknown tag if we added it.
 397    *
 398    * @param $name
 399    *
 400    * @return mixed
 401    */
 402   public static function cleanFileName($name) {
 403     // replace the last 33 character before the '.' with null
 404     $name = preg_replace('/(_[\w]{32})\./', '.', $name);
 405     return $name;
 406   }
 407
 408   /**
 409    * @param string $name
 410    *
 411    * @return string
 412    */
 413   public static function makeFileName($name) {
 414     $uniqID = md5(uniqid(rand(), TRUE));
 415     $info = pathinfo($name);
 416     $basename = substr($info['basename'],
 417       0, -(strlen(CRM_Utils_Array::value('extension', $info)) + (CRM_Utils_Array::value('extension', $info) == '' ? 0 : 1))
 418     );
 419     if (!self::isExtensionSafe(CRM_Utils_Array::value('extension', $info))) {
 420       // munge extension so it cannot have an embbeded dot in it
 421       // The maximum length of a filename for most filesystems is 255 chars.
 422       // We'll truncate at 240 to give some room for the extension.
 423       return CRM_Utils_String::munge("{$basename}_" . CRM_Utils_Array::value('extension', $info) . "_{$uniqID}", '_', 240) . ".unknown";
 424     }
 425     else {
 426       return CRM_Utils_String::munge("{$basename}_{$uniqID}", '_', 240) . "." . CRM_Utils_Array::value('extension', $info);
 427     }
 428   }
 429
 430   /**
 431    * @param $path
 432    * @param $ext
 433    *
 434    * @return array
 435    */
 436   public static function getFilesByExtension($path, $ext) {
 437     $path = self::addTrailingSlash($path);
 438     $files = array();
 439     if ($dh = opendir($path)) {
 440       while (FALSE !== ($elem = readdir($dh))) {
 441         if (substr($elem, -(strlen($ext) + 1)) == '.' . $ext) {
 442           $files[] .= $path . $elem;
 443         }
 444       }
 445       closedir($dh);
 446     }
 447     return $files;
 448   }
 449
 450   /**
 451    * Restrict access to a given directory (by planting there a restrictive .htaccess file)
 452    *
 453    * @param string $dir
 454    *   The directory to be secured.
 455    * @param bool $overwrite
 456    */
 457   public static function restrictAccess($dir, $overwrite = FALSE) {
 458     // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
 459     // of site, causing site to stop functioning.
 460     // FIXME: we should do more checks here -
 461     if (!empty($dir) && is_dir($dir)) {
 462       $htaccess = <<<HTACCESS
 463 <Files "*">
 464   Order allow,deny
 465   Deny from all
 466 </Files>
 467
 468 HTACCESS;
 469       $file = $dir . '.htaccess';
 470       if ($overwrite || !file_exists($file)) {
 471         if (file_put_contents($file, $htaccess) === FALSE) {
 472           CRM_Core_Error::movedSiteError($file);
 473         }
 474       }
 475     }
 476   }
 477
 478   /**
 479    * Restrict remote users from browsing the given directory.
 480    *
 481    * @param $publicDir
 482    */
 483   public static function restrictBrowsing($publicDir) {
 484     if (!is_dir($publicDir) || !is_writable($publicDir)) {
 485       return;
 486     }
 487
 488     // base dir
 489     $nobrowse = realpath($publicDir) . '/index.html';
 490     if (!file_exists($nobrowse)) {
 491       @file_put_contents($nobrowse, '');
 492     }
 493
 494     // child dirs
 495     $dir = new RecursiveDirectoryIterator($publicDir);
 496     foreach ($dir as $name => $object) {
 497       if (is_dir($name) && $name != '..') {
 498         $nobrowse = realpath($name) . '/index.html';
 499         if (!file_exists($nobrowse)) {
 500           @file_put_contents($nobrowse, '');
 501         }
 502       }
 503     }
 504   }
 505
 506   /**
 507    * Create the base file path from which all our internal directories are
 508    * offset. This is derived from the template compile directory set
 509    */
 510   public static function baseFilePath() {
 511     static $_path = NULL;
 512     if (!$_path) {
 513       // Note: Don't rely on $config; that creates a dependency loop.
 514       if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
 515         throw new RuntimeException("Undefined constant: CIVICRM_TEMPLATE_COMPILEDIR");
 516       }
 517       $templateCompileDir = CIVICRM_TEMPLATE_COMPILEDIR;
 518
 519       $path = dirname($templateCompileDir);
 520
 521       //this fix is to avoid creation of upload dirs inside templates_c directory
 522       $checkPath = explode(DIRECTORY_SEPARATOR, $path);
 523
 524       $cnt = count($checkPath) - 1;
 525       if ($checkPath[$cnt] == 'templates_c') {
 526         unset($checkPath[$cnt]);
 527         $path = implode(DIRECTORY_SEPARATOR, $checkPath);
 528       }
 529
 530       $_path = CRM_Utils_File::addTrailingSlash($path);
 531     }
 532     return $_path;
 533   }
 534
 535   /**
 536    * Determine if a path is absolute.
 537    *
 538    * @param string $path
 539    *
 540    * @return bool
 541    *   TRUE if absolute. FALSE if relative.
 542    */
 543   public static function isAbsolute($path) {
 544     if (substr($path, 0, 1) === DIRECTORY_SEPARATOR) {
 545       return TRUE;
 546     }
 547     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 548       if (preg_match('!^[a-zA-Z]:[/\\\\]!', $path)) {
 549         return TRUE;
 550       }
 551     }
 552     return FALSE;
 553   }
 554
 555   /**
 556    * @param $directory
 557    *
 558    * @return string
 559    */
 560   public static function relativeDirectory($directory) {
 561     // Do nothing on windows
 562     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 563       return $directory;
 564     }
 565
 566     // check if directory is relative, if so return immediately
 567     if (!self::isAbsolute($directory)) {
 568       return $directory;
 569     }
 570
 571     // make everything relative from the baseFilePath
 572     $basePath = self::baseFilePath();
 573     // check if basePath is a substr of $directory, if so
 574     // return rest of string
 575     if (substr($directory, 0, strlen($basePath)) == $basePath) {
 576       return substr($directory, strlen($basePath));
 577     }
 578
 579     // return the original value
 580     return $directory;
 581   }
 582
 583   /**
 584    * @param $directory
 585    * @param string|NULL $basePath
 586    *   The base path when evaluating relative paths. Should include trailing slash.
 587    *
 588    * @return string
 589    */
 590   public static function absoluteDirectory($directory, $basePath = NULL) {
 591     // check if directory is already absolute, if so return immediately
 592     // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
 593     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
 594       return $directory;
 595     }
 596
 597     // check if directory is already absolute, if so return immediately
 598     if (substr($directory, 0, 1) == DIRECTORY_SEPARATOR) {
 599       return $directory;
 600     }
 601
 602     // make everything absolute from the baseFilePath
 603     $basePath = ($basePath === NULL) ? self::baseFilePath() : $basePath;
 604
 605     return $basePath . $directory;
 606   }
 607
 608   /**
 609    * Make a file path relative to some base dir.
 610    *
 611    * @param $directory
 612    * @param $basePath
 613    *
 614    * @return string
 615    */
 616   public static function relativize($directory, $basePath) {
 617     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 618       $directory = strtr($directory, '\\', '/');
 619       $basePath = strtr($basePath, '\\', '/');
 620     }
 621     if (substr($directory, 0, strlen($basePath)) == $basePath) {
 622       return substr($directory, strlen($basePath));
 623     }
 624     else {
 625       return $directory;
 626     }
 627   }
 628
 629   /**
 630    * Create a path to a temporary file which can endure for multiple requests.
 631    *
 632    * @todo Automatic file cleanup using, eg, TTL policy
 633    *
 634    * @param string $prefix
 635    *
 636    * @return string, path to an openable/writable file
 637    * @see tempnam
 638    */
 639   public static function tempnam($prefix = 'tmp-') {
 640     // $config = CRM_Core_Config::singleton();
 641     // $nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
 642     // $fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
 643     $fileName = tempnam(sys_get_temp_dir(), $prefix);
 644     return $fileName;
 645   }
 646
 647   /**
 648    * Create a path to a temporary directory which can endure for multiple requests.
 649    *
 650    * @todo Automatic file cleanup using, eg, TTL policy
 651    *
 652    * @param string $prefix
 653    *
 654    * @return string, path to an openable/writable directory; ends with '/'
 655    * @see tempnam
 656    */
 657   public static function tempdir($prefix = 'tmp-') {
 658     $fileName = self::tempnam($prefix);
 659     unlink($fileName);
 660     mkdir($fileName, 0700);
 661     return $fileName . '/';
 662   }
 663
 664   /**
 665    * Search directory tree for files which match a glob pattern.
 666    *
 667    * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
 668    *
 669    * @param string $dir
 670    *   base dir.
 671    * @param string $pattern
 672    *   glob pattern, eg "*.txt".
 673    * @param bool $relative
 674    *   TRUE if paths should be made relative to $dir
 675    * @return array(string)
 676    */
 677   public static function findFiles($dir, $pattern, $relative = FALSE) {
 678     if (!is_dir($dir)) {
 679       return array();
 680     }
 681     $dir = rtrim($dir, '/');
 682     $todos = array($dir);
 683     $result = array();
 684     while (!empty($todos)) {
 685       $subdir = array_shift($todos);
 686       $matches = glob("$subdir/$pattern");
 687       if (is_array($matches)) {
 688         foreach ($matches as $match) {
 689           if (!is_dir($match)) {
 690             $result[] = $relative ? CRM_Utils_File::relativize($match, "$dir/") : $match;
 691           }
 692         }
 693       }
 694       if ($dh = opendir($subdir)) {
 695         while (FALSE !== ($entry = readdir($dh))) {
 696           $path = $subdir . DIRECTORY_SEPARATOR . $entry;
 697           if ($entry{0} == '.') {
 698             // ignore
 699           }
 700           elseif (is_dir($path)) {
 701             $todos[] = $path;
 702           }
 703         }
 704         closedir($dh);
 705       }
 706     }
 707     return $result;
 708   }
 709
 710   /**
 711    * Determine if $child is a sub-directory of $parent
 712    *
 713    * @param string $parent
 714    * @param string $child
 715    * @param bool $checkRealPath
 716    *
 717    * @return bool
 718    */
 719   public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
 720     if ($checkRealPath) {
 721       $parent = realpath($parent);
 722       $child = realpath($child);
 723     }
 724     $parentParts = explode('/', rtrim($parent, '/'));
 725     $childParts = explode('/', rtrim($child, '/'));
 726     while (($parentPart = array_shift($parentParts)) !== NULL) {
 727       $childPart = array_shift($childParts);
 728       if ($parentPart != $childPart) {
 729         return FALSE;
 730       }
 731     }
 732     if (empty($childParts)) {
 733       return FALSE; // same directory
 734     }
 735     else {
 736       return TRUE;
 737     }
 738   }
 739
 740   /**
 741    * Move $fromDir to $toDir, replacing/deleting any
 742    * pre-existing content.
 743    *
 744    * @param string $fromDir
 745    *   The directory which should be moved.
 746    * @param string $toDir
 747    *   The new location of the directory.
 748    * @param bool $verbose
 749    *
 750    * @return bool
 751    *   TRUE on success
 752    */
 753   public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
 754     if (is_dir($toDir)) {
 755       if (!self::cleanDir($toDir, TRUE, $verbose)) {
 756         return FALSE;
 757       }
 758     }
 759
 760     // return rename($fromDir, $toDir); CRM-11987, https://bugs.php.net/bug.php?id=54097
 761
 762     CRM_Utils_File::copyDir($fromDir, $toDir);
 763     if (!CRM_Utils_File::cleanDir($fromDir, TRUE, FALSE)) {
 764       CRM_Core_Session::setStatus(ts('Failed to clean temp dir: %1', array(1 => $fromDir)), '', 'alert');
 765       return FALSE;
 766     }
 767     return TRUE;
 768   }
 769
 770   public static function formatFile(&$param, $fileName, $extraParams = array()) {
 771     if (empty($param[$fileName])) {
 772       return;
 773     }
 774
 775     $fileParams = array(
 776       'uri' => $param[$fileName]['name'],
 777       'type' => $param[$fileName]['type'],
 778       'location' => $param[$fileName]['name'],
 779       'upload_date' => date('YmdHis'),
 780     ) + $extraParams;
 781
 782     $param[$fileName] = $fileParams;
 783   }
 784
 785 }