added fs_is_directorycomponent() and fs_is_hidden_file()

fp-includes/core/core.filesystem.php

@@ -1,23 +1,21 @@
 <?php
 
-	
 /**
  * Filesystem lib
  * provides basic filesystem handling functions.
  *
  * @author NoWhereMan <nowhereman@phreaker.net>
  */
-	
-
 class fs_filelister {
 
 	var $_list = array();
-		var $_directory = null;
 
+	var $_directory = null;
 
 	// constructor
 	function __construct($directory = null) {
-			if ($directory) $this->_directory = $directory; 
+		if ($directory)
+			$this->_directory = $directory;
 		$this->_listFiles($this->_directory);
 	}
 
@@ -28,20 +26,18 @@
 	}
 
 	function _exitingDir($directory, $file) {
-			
 	}
 
 	function _listFiles($directory) {
 
 		// Try to open the directory
-			if (!file_exists($directory)) return array();
+		if (!file_exists($directory))
+			return array();
 
 		if ($dir = opendir($directory)) {
 			// Add the files
 			while ($file = readdir($dir)) {
-				
+				if (!fs_is_directorycomponent($file)) {
-					if ($file != '.' && $file != '..') {
-						 
 					$action = $this->_checkFile($directory, $file);
 
 					// $action == 0: ok, go on
@@ -49,25 +45,25 @@
 					// $action == 2: exit function
 
 					switch ($action) {
-							case (1): {
+						case (1):
+							{
 								$this->_listFiles("$directory/$file");
 								$this->_exitingDir($directory, $file);
 								break;
 							}
-							case (2): {
+						case (2):
+							{
 								return false;
 							}
 					}
 				}
-					
 			}
 
 			// Finish off the function
 			closedir($dir);
 			return true;
-			}
+		} else
-			else return false;
+			return false;
-			
 	}
 
 	function getList() {
@@ -84,6 +80,7 @@
 }
 
 class fs_pathlister extends fs_filelister {
+
 	function _checkFile($directory, $file) {
 		$f = "$directory/$file";
 		if (!is_dir($f))
@@ -102,14 +99,11 @@
 			// $id = lang_id($filename);
 			$files [] = $filename;
 		}
-		 
-		 
 	}
 	sort($files);
 	return $files;
 }
 
-	
 /**
  * function fs_mkdir
  *
@@ -118,29 +112,31 @@
  * <p>Recursively creates dirs.</p>
  * <p>Returns true on success, else false</p>
  *
-	 * @param string $path Directory or directories to create
+ * @param string $path
-	 * @param int $mode octal mode value; same as UNIX chmod; defaults to 0777 (rwrwrw);
+ *        	Directory or directories to create
+ * @param int $mode
+ *        	octal mode value; same as UNIX chmod; defaults to 0777 (rwrwrw);
  * @return bool
  *
  * @todo cleanup & check bool return value
  *      
  */
 function fs_mkdir($dir, $mode = DIR_PERMISSIONS) {
-                if (is_dir($dir) || (@mkdir($dir,$mode))) {@chmod($dir, $mode); return TRUE;}
+	if (is_dir($dir) || (@mkdir($dir, $mode))) {
-                if (!fs_mkdir(dirname($dir),$mode)) return FALSE;
+		@chmod($dir, $mode);
+		return TRUE;
+	}
+	if (!fs_mkdir(dirname($dir), $mode))
+		return FALSE;
 	return (@mkdir($dir, $mode) && @chmod($dir, $mode));
 }
 
-	
-	
 /**
  * function fs_delete
  *
  * Deletes a file and recursively deletes dirs, if they're empty
-	 * 
  */
 function fs_delete($path) {
-		
 	if (file_exists($path)) {
 
 		$fsuccess = unlink($path);
@@ -150,12 +146,10 @@
 
 			$path = dirname($path);
 			$dsuccess = @rmdir($path);
-					
 		}
 
 		// unlink can return both 0 and false -__-'
 		return ($fsuccess);
-			
 	}
 
 	// in our particular implementation
@@ -164,8 +158,6 @@
 	// so that we can anyway track it back
 
 	return 2;
-		
-		
 }
 
 /**
@@ -174,14 +166,15 @@
  * Perform a recursive reset of file permission in the given $path
  * and its subdirectories to 0777
  *
-	 * @param $fpath dir path
+ * @param $fpath dir
+ *        	path
  * @return bool
  *
  */
-	
 class fs_chmodder extends fs_filelister {
 
 	var $_chmod_dir;
+
 	var $_chmod_file;
 
 	function __construct($directory, $ch_file = FILE_PERMISSIONS, $ch_dir = DIR_PERMISSIONS) {
@@ -201,6 +194,7 @@
 
 		return $retval;
 	}
+
 }
 
 function fs_chmod_recursive($fpath = FP_CONTENT) {
@@ -208,47 +202,48 @@
 	return $obj->getList();
 }
 
-	
-	
 /**
  * recursive deletion
  * deletes all files and directories recursively in the given $path
-	* @param $fpath dir path
+ *
+ * @param $fpath dir
+ *        	path
  * @return bool
  */
 
-	/*class fs_deleter extends fs_filelister {
-		
-		function fs_deleter($directory) {
-			$this->_directory = $directory;
-			parent::__construct();
-		}
-		
-		function _checkFile($directory, $file) {
-			
-			$path = "$directory/$file";	
-			
 /*
+ * class fs_deleter extends fs_filelister {
+ *
+ * function fs_deleter($directory) {
+ * $this->_directory = $directory;
+ * parent::__construct();
+ * }
+ *
+ * function _checkFile($directory, $file) {
+ *
+ * $path = "$directory/$file";
+ *
+ * /*
  * open dir handle prevents directory deletion of php5 (and probably win)
  * thanks to cimangi <cimangi (at) yahoo (dot) it> for noticing and
  * giving a possible solution:
  *
  * filenames are cached and then deleted
-			 //
+ * //
-			
+ *
-			if ( is_dir($path) ) {
+ * if ( is_dir($path) ) {
-				return 1;
+ * return 1;
-			} elseif ( file_exists($path) ) {
+ * } elseif ( file_exists($path) ) {
-				array_push($this->_list, $path);
+ * array_push($this->_list, $path);
-				return 0;
+ * return 0;
-			} else {
+ * } else {
-				return 2;
+ * return 2;
-			}
+ * }
-			
+ *
-		}
+ * }
-		
+ *
-	}
+ * }
-	
+ *
  */
 
 /*
@@ -258,7 +253,6 @@
  *
  * paths are now cached and then deleted
  */
-
 function fs_delete_recursive($path) {
 	if (file_exists($path)) {
 
@@ -272,17 +266,11 @@
 			$elem;
 			fs_delete($elem);
 		}
-			
-			
-			
 	}
 
-		
 	return true;
 }
 
-	
-	
 function fs_copy($source, $dest) {
 	if ($contents = io_load_file($source)) {
 		return io_write_file($dest, $contents);
@@ -290,4 +278,24 @@
 	return false;
 }
 
+/**
+ * Checks if the file with the given name is a directory component ('.' or '..').
+ *
+ * @param string $filename
+ *        	the file name
+ * @return boolean <code>true</code> if the file is a directory component; otherwise <code>false</code>
+ */
+function fs_is_directorycomponent($filename) {
+	return strlen($filename) > 0 && ($filename === '.' || $filename === '..');
+}
 
+/**
+ * Checks if the file with the given name is a hidden file (i.e., starts with a '.').
+ *
+ * @param string $filename
+ *        	the file name
+ * @return boolean <code>true</code> if the file is a hidden file; otherwise <code>false</code>
+ */
+function fs_is_hidden_file($filename) {
+	return strlen($filename) > 0 && substr($filename, 0, 1) === '.';
+}