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 {
-
-	class fs_filelister {
 
 	var $_list = array();
+
 	var $_directory = null;
 
-		
+	// constructor
-		//constructor
 	function __construct($directory = null) {
-			if ($directory) $this->_directory = $directory; 
+		if ($directory)
+			$this->_directory = $directory;
 		$this->_listFiles($this->_directory);
 	}
 
@@ -28,62 +26,61 @@
 	}
 
 	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)) {
+		if ($dir = opendir($directory)) {
 			// Add the files
-				while($file = readdir($dir)) {
+			while ($file = readdir($dir)) {
-				
+				if (!fs_is_directorycomponent($file)) {
-					if ($file != '.' && $file != '..') {
+					$action = $this->_checkFile($directory, $file);
-						 
-						$action = $this->_checkFile($directory,$file);
 
 					// $action == 0: ok, go on
 					// $action == 1: recurse
 					// $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() {
-			//$this->_listFiles($this->_directory);
+		// $this->_listFiles($this->_directory);
 		return $this->_list;
 	}
 
 	function count() {
-			if (!isset ($this->count))
+		if (!isset($this->count))
 			$this->count = count($this->_list);
 		return $this->count;
 	}
 
-	}
+}
+
+class fs_pathlister extends fs_filelister {
 
-	class fs_pathlister extends fs_filelister {
 	function _checkFile($directory, $file) {
 		$f = "$directory/$file";
 		if (!is_dir($f))
@@ -92,25 +89,22 @@
 			return 1;
 	}
 
-	}
+}
 
-	// dir list
+// dir list
-	function fs_list_dirs($dir) {
+function fs_list_dirs($dir) {
 	$dh = opendir($dir);
 	while (false !== ($filename = readdir($dh))) {
-		if ( ($filename[0] != '.') ) {
+		if (($filename [0] != '.')) {
 			// $id = lang_id($filename);
-			$files[] = $filename;
+			$files [] = $filename;
 		}
-		 
-		 
 	}
 	sort($files);
 	return $files;
-	}
+}
 
-	
+/**
-	/**
  * function fs_mkdir
  *
  * <p>Function from : {@link http://www.php.net/function.mkdir.php}</p>
@@ -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) {
+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 (@mkdir($dir,$mode) && @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) {
+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,27 +158,26 @@
 	// so that we can anyway track it back
 
 	return 2;
+}
 
-		
+/**
-	}
-	
-	/**
  * function fs_recursive_chmod
  *
  * 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 {
-	 class fs_chmodder extends fs_filelister {
 
 	var $_chmod_dir;
+
 	var $_chmod_file;
 
-		function __construct($directory, $ch_file=FILE_PERMISSIONS, $ch_dir=DIR_PERMISSIONS) {
+	function __construct($directory, $ch_file = FILE_PERMISSIONS, $ch_dir = DIR_PERMISSIONS) {
 		$this->_directory = $directory;
 		$this->_chmod_file = $ch_file;
 		$this->_chmod_dir = $ch_dir;
@@ -196,70 +189,71 @@
 		$path = "$directory/$file";
 		if (is_dir($path))
 			$retval = 1;
-			if ( !@chmod($path, ($retval? $this->_chmod_dir : $this->_chmod_file ) ) )
+		if (!@chmod($path, ($retval ? $this->_chmod_dir : $this->_chmod_file)))
 			array_push($this->_list, $path);
 
 		return $retval;
 	}
-	 }
 
-	function fs_chmod_recursive($fpath=FP_CONTENT) {
+}
+
+function fs_chmod_recursive($fpath = FP_CONTENT) {
 	$obj = new fs_chmodder($fpath);
 	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 {
+/*
-		
+ * class fs_deleter extends fs_filelister {
-		function fs_deleter($directory) {
+ *
-			$this->_directory = $directory;
+ * function fs_deleter($directory) {
-			parent::__construct();
+ * $this->_directory = $directory;
-		}
+ * parent::__construct();
-		
+ * }
-		function _checkFile($directory, $file) {
+ *
-			
+ * function _checkFile($directory, $file) {
-			$path = "$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;
-			}
+ * }
-			
+ *
-		}
+ * }
-		
+ *
-	}
+ * }
-	
+ *
  */
 
-	/*
+/*
  * 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;
  *
  * paths are now cached and then deleted
  */
-
+function fs_delete_recursive($path) {
-	function fs_delete_recursive($path) {
 	if (file_exists($path)) {
 
 		$obj = new fs_pathlister($path);
@@ -268,26 +262,40 @@
 		unset($obj);
 
 		$elem = null;
-			while($elem = array_pop($list)) {
+		while ($elem = array_pop($list)) {
 			$elem;
 			fs_delete($elem);
 		}
-			
-			
-			
 	}
 
-		
 	return true;
-	}
+}
 
-	
+function fs_copy($source, $dest) {
-	
-	function fs_copy($source, $dest) {
 	if ($contents = io_load_file($source)) {
 		return io_write_file($dest, $contents);
 	}
 	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) === '.';
+}