X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;ds=sidebyside;f=CRM%2FUtils%2FFile.php;h=f435ad175e5d04928dd8e5a1d3d9d7fc61135a38;hb=4b57bc9f2b1fa63555e588f6ad9c3c079725af4d;hp=42ef38472b85d2443c257fdd597e6da12dafbbae;hpb=e8cca51aa6ed1feb98786bd980a1395d8a9a785a;p=civicrm-core.git

diff --git a/CRM/Utils/File.php b/CRM/Utils/File.php
index 42ef38472b..f435ad175e 100644
--- a/CRM/Utils/File.php
+++ b/CRM/Utils/File.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -44,9 +44,8 @@ class CRM_Utils_File {
    * @param string $name name of file
    *
    * @return boolean     true if file is ascii
-   * @access public
    */
-  static function isAscii($name) {
+  public static function isAscii($name) {
     $fd = fopen($name, "r");
     if (!$fd) {
       return FALSE;
@@ -71,9 +70,8 @@ class CRM_Utils_File {
    * @param string $name name of file
    *
    * @return boolean     true if file is html
-   * @access public
    */
-  static function isHtml($name) {
+  public static function isHtml($name) {
     $fd = fopen($name, "r");
     if (!$fd) {
       return FALSE;
@@ -95,17 +93,16 @@ class CRM_Utils_File {
   }
 
   /**
-   * create a directory given a path name, creates parent directories
+   * Create a directory given a path name, creates parent directories
    * if needed
    *
    * @param string $path  the path name
    * @param boolean $abort should we abort or just return an invalid code
    *
    * @return void
-   * @access public
    * @static
    */
-  static function createDir($path, $abort = TRUE) {
+  public static function createDir($path, $abort = TRUE) {
     if (is_dir($path) || empty($path)) {
       return;
     }
@@ -126,27 +123,24 @@ class CRM_Utils_File {
   }
 
   /**
-   * delete a directory given a path name, delete children directories
+   * Delete a directory given a path name, delete children directories
    * and files if needed
    *
-   * @param $target
+   * @param string $target the path name
    * @param bool $rmdir
    * @param bool $verbose
    *
    * @throws Exception
-   * @internal param string $path the path name
-   *
    * @return void
-   * @access public
    * @static
    */
-  static function cleanDir($target, $rmdir = TRUE, $verbose = TRUE) {
+  public static function cleanDir($target, $rmdir = TRUE, $verbose = TRUE) {
     static $exceptions = array('.', '..');
     if ($target == '' || $target == '/') {
       throw new Exception("Overly broad deletion");
     }
 
-    if ($sourcedir = @opendir($target)) {
+    if ($sourcedir = opendir($target)) {
       while (FALSE !== ($sibling = readdir($sourcedir))) {
         if (!in_array($sibling, $exceptions)) {
           $object = $target . DIRECTORY_SEPARATOR . $sibling;
@@ -182,19 +176,20 @@ class CRM_Utils_File {
    * @param $destination
    */
   static function copyDir($source, $destination) {
-    $dir = opendir($source);
-    @mkdir($destination);
-    while (FALSE !== ($file = readdir($dir))) {
-      if (($file != '.') && ($file != '..')) {
-        if (is_dir($source . DIRECTORY_SEPARATOR . $file)) {
-          CRM_Utils_File::copyDir($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
-        }
-        else {
-          copy($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
+    if ($dir = opendir($source)) {
+      @mkdir($destination);
+      while (FALSE !== ($file = readdir($dir))) {
+        if (($file != '.') && ($file != '..')) {
+          if (is_dir($source . DIRECTORY_SEPARATOR . $file)) {
+            CRM_Utils_File::copyDir($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
+          }
+          else {
+            copy($source . DIRECTORY_SEPARATOR . $file, $destination . DIRECTORY_SEPARATOR . $file);
+          }
         }
       }
+      closedir($dir);
     }
-    closedir($dir);
   }
 
   /**
@@ -203,9 +198,8 @@ class CRM_Utils_File {
    * @param string $name name of file
    *
    * @return boolean  whether the file was recoded properly
-   * @access public
    */
-  static function toUtf8($name) {
+  public static function toUtf8($name) {
     static $config = NULL;
     static $legacyEncoding = NULL;
     if ($config == NULL) {
@@ -250,10 +244,9 @@ class CRM_Utils_File {
    * @param string $slash
    *
    * @return string
-   * @access public
    * @static
    */
-  static function addTrailingSlash($path, $slash = NULL) {
+  public static function addTrailingSlash($path, $slash = NULL) {
     if (!$slash) {
       // FIXME: Defaulting to backslash on windows systems can produce unexpected results, esp for URL strings which should always use forward-slashes.
       // I think this fn should default to forward-slash instead.
@@ -267,12 +260,12 @@ class CRM_Utils_File {
 
   /**
    * @param $dsn
-   * @param $fileName
+   * @param string $fileName
    * @param null $prefix
    * @param bool $isQueryString
    * @param bool $dieOnErrors
    */
-  static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $isQueryString = FALSE, $dieOnErrors = TRUE) {
+  public static function sourceSQLFile($dsn, $fileName, $prefix = NULL, $isQueryString = FALSE, $dieOnErrors = TRUE) {
     require_once 'DB.php';
 
     $db = DB::connect($dsn);
@@ -319,7 +312,7 @@ class CRM_Utils_File {
    *
    * @return bool
    */
-  static function isExtensionSafe($ext) {
+  public static function isExtensionSafe($ext) {
     static $extensions = NULL;
     if (!$extensions) {
       $extensions = CRM_Core_OptionGroup::values('safe_file_extension', TRUE);
@@ -349,7 +342,7 @@ class CRM_Utils_File {
    *
    * @return boolean  whether the file can be include()d or require()d
    */
-  static function isIncludable($name) {
+  public static function isIncludable($name) {
     $x = @fopen($name, 'r', TRUE);
     if ($x) {
       fclose($x);
@@ -361,21 +354,21 @@ class CRM_Utils_File {
   }
 
   /**
-   * remove the 32 bit md5 we add to the fileName
+   * Remove the 32 bit md5 we add to the fileName
    * also remove the unknown tag if we added it
    */
-  static function cleanFileName($name) {
+  public static function cleanFileName($name) {
     // replace the last 33 character before the '.' with null
     $name = preg_replace('/(_[\w]{32})\./', '.', $name);
     return $name;
   }
 
   /**
-   * @param $name
+   * @param string $name
    *
    * @return string
    */
-  static function makeFileName($name) {
+  public static function makeFileName($name) {
     $uniqID   = md5(uniqid(rand(), TRUE));
     $info     = pathinfo($name);
     $basename = substr($info['basename'],
@@ -398,17 +391,18 @@ class CRM_Utils_File {
    *
    * @return array
    */
-  static function getFilesByExtension($path, $ext) {
+  public static function getFilesByExtension($path, $ext) {
     $path  = self::addTrailingSlash($path);
-    $dh    = opendir($path);
-    $files = array();
-    while (FALSE !== ($elem = readdir($dh))) {
-      if (substr($elem, -(strlen($ext) + 1)) == '.' . $ext) {
-        $files[] .= $path . $elem;
+    if ($dh = opendir($path)) {
+      $files = array();
+      while (FALSE !== ($elem = readdir($dh))) {
+        if (substr($elem, -(strlen($ext) + 1)) == '.' . $ext) {
+          $files[] .= $path . $elem;
+        }
       }
+      closedir($dh);
+      return $files;
     }
-    closedir($dh);
-    return $files;
   }
 
   /**
@@ -417,7 +411,7 @@ class CRM_Utils_File {
    * @param string $dir the directory to be secured
    * @param bool $overwrite
    */
-  static function restrictAccess($dir, $overwrite = FALSE) {
+  public static function restrictAccess($dir, $overwrite = FALSE) {
     // note: empty value for $dir can play havoc, since that might result in putting '.htaccess' to root dir
     // of site, causing site to stop functioning.
     // FIXME: we should do more checks here -
@@ -443,7 +437,7 @@ HTACCESS;
    *
    * @param $publicDir
    */
-  static function restrictBrowsing($publicDir) {
+  public static function restrictBrowsing($publicDir) {
     if (!is_dir($publicDir) || !is_writable($publicDir)) {
       return;
     }
@@ -470,7 +464,7 @@ HTACCESS;
    * Create the base file path from which all our internal directories are
    * offset. This is derived from the template compile directory set
    */
-  static function baseFilePath($templateCompileDir = NULL) {
+  public static function baseFilePath($templateCompileDir = NULL) {
     static $_path = NULL;
     if (!$_path) {
       if ($templateCompileDir == NULL) {
@@ -499,7 +493,7 @@ HTACCESS;
    *
    * @return string
    */
-  static function relativeDirectory($directory) {
+  public static function relativeDirectory($directory) {
     // Do nothing on windows
     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
       return $directory;
@@ -527,7 +521,7 @@ HTACCESS;
    *
    * @return string
    */
-  static function absoluteDirectory($directory) {
+  public static function absoluteDirectory($directory) {
     // check if directory is already absolute, if so return immediately
     // Note: Windows PHP accepts any mix of "/" or "\", so "C:\htdocs" or "C:/htdocs" would be a valid absolute path
     if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && preg_match(';^[a-zA-Z]:[/\\\\];', $directory)) {
@@ -553,7 +547,7 @@ HTACCESS;
    *
    * @return string
    */
-  static function relativize($directory, $basePath) {
+  public static function relativize($directory, $basePath) {
     if (substr($directory, 0, strlen($basePath)) == $basePath) {
       return substr($directory, strlen($basePath));
     } else {
@@ -571,7 +565,7 @@ HTACCESS;
    * @return string, path to an openable/writable file
    * @see tempnam
    */
-  static function tempnam($prefix = 'tmp-') {
+  public static function tempnam($prefix = 'tmp-') {
     //$config = CRM_Core_Config::singleton();
     //$nonce = md5(uniqid() . $config->dsn . $config->userFrameworkResourceURL);
     //$fileName = "{$config->configAndLogDir}" . $prefix . $nonce . $suffix;
@@ -589,7 +583,7 @@ HTACCESS;
    * @return string, path to an openable/writable directory; ends with '/'
    * @see tempnam
    */
-  static function tempdir($prefix = 'tmp-') {
+  public static function tempdir($prefix = 'tmp-') {
     $fileName = self::tempnam($prefix);
     unlink($fileName);
     mkdir($fileName, 0700);
@@ -605,7 +599,7 @@ HTACCESS;
    * @param $pattern string, glob pattern, eg "*.txt"
    * @return array(string)
    */
-  static function findFiles($dir, $pattern) {
+  public static function findFiles($dir, $pattern) {
     $todos = array($dir);
     $result = array();
     while (!empty($todos)) {
@@ -618,8 +612,7 @@ HTACCESS;
           }
         }
       }
-      $dh = opendir($subdir);
-      if ($dh) {
+      if ($dh = opendir($subdir)) {
         while (FALSE !== ($entry = readdir($dh))) {
           $path = $subdir . DIRECTORY_SEPARATOR . $entry;
           if ($entry{0} == '.') {
@@ -643,7 +636,7 @@ HTACCESS;
    *
    * @return bool
    */
-  static function isChildPath($parent, $child, $checkRealPath = TRUE) {
+  public static function isChildPath($parent, $child, $checkRealPath = TRUE) {
     if ($checkRealPath) {
       $parent = realpath($parent);
       $child = realpath($child);
@@ -673,7 +666,7 @@ HTACCESS;
    *
    * @return bool TRUE on success
    */
-  static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
+  public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
     if (is_dir($toDir)) {
       if (!self::cleanDir($toDir, TRUE, $verbose)) {
         return FALSE;
@@ -690,4 +683,3 @@ HTACCESS;
     return TRUE;
   }
 }
-