Beef up filesystem helper & testing for it

Author: jim-parry

system/Helpers/filesystem_helper.php

@@ -87,15 +87,17 @@ function directory_map(string $source_dir, int $directory_depth = 0, bool $hidde
 				if (($directory_depth < 1 || $new_depth > 0) && is_dir($source_dir . $file))
 				{
 					$filedata[$file] = directory_map($source_dir . $file, $new_depth, $hidden);
-				} else
+				}
+				else
 				{
 					$filedata[] = $file;
 				}
 			}
 
 			closedir($fp);
 			return $filedata;
-		} catch (Exception $fe)
+		}
+		catch (\Exception $fe)
 		{
 			return [];
 		}
@@ -122,25 +124,29 @@ function directory_map(string $source_dir, int $directory_depth = 0, bool $hidde
 	 */
 	function write_file(string $path, string $data, string $mode = 'wb'): bool
 	{
-		if ( ! $fp = @fopen($path, $mode))
+		try
 		{
-			return false;
-		}
+			$fp = fopen($path, $mode);
 
-		flock($fp, LOCK_EX);
+			flock($fp, LOCK_EX);
 
-		for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result)
-		{
-			if (($result = fwrite($fp, substr($data, $written))) === false)
+			for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result)
 			{
-				break;
+				if (($result = fwrite($fp, substr($data, $written))) === false)
+				{
+					break;
+				}
 			}
-		}
 
-		flock($fp, LOCK_UN);
-		fclose($fp);
+			flock($fp, LOCK_UN);
+			fclose($fp);
 
-		return is_int($result);
+			return is_int($result);
+		}
+		catch (\Exception $fe)
+		{
+			return false;
+		}
 	}
 
 }
@@ -170,28 +176,33 @@ function delete_files(string $path, bool $delDir = false, bool $htdocs = false,
 		// Trim the trailing slash
 		$path = rtrim($path, '/\\');
 
-		if ( ! $current_dir = @opendir($path))
+		try
 		{
-			return false;
-		}
+			$current_dir = opendir($path);
 
-		while (false !== ($filename = @readdir($current_dir)))
-		{
-			if ($filename !== '.' && $filename !== '..')
+			while (false !== ($filename = @readdir($current_dir)))
 			{
-				if (is_dir($path . DIRECTORY_SEPARATOR . $filename) && $filename[0] !== '.')
-				{
-					delete_files($path . DIRECTORY_SEPARATOR . $filename, $delDir, $htdocs, $_level + 1);
-				} elseif ($htdocs !== true || ! preg_match('/^(\.htaccess|index\.(html|htm|php)|web\.config)$/i', $filename))
+				if ($filename !== '.' && $filename !== '..')
 				{
-					@unlink($path . DIRECTORY_SEPARATOR . $filename);
+					if (is_dir($path . DIRECTORY_SEPARATOR . $filename) && $filename[0] !== '.')
+					{
+						delete_files($path . DIRECTORY_SEPARATOR . $filename, $delDir, $htdocs, $_level + 1);
+					}
+					elseif ($htdocs !== true || ! preg_match('/^(\.htaccess|index\.(html|htm|php)|web\.config)$/i', $filename))
+					{
+						@unlink($path . DIRECTORY_SEPARATOR . $filename);
+					}
 				}
 			}
-		}
 
-		closedir($current_dir);
+			closedir($current_dir);
 
-		return ($delDir === true && $_level > 0) ? @rmdir($path) : true;
+			return ($delDir === true && $_level > 0) ? @rmdir($path) : true;
+		}
+		catch (\Exception $fe)
+		{
+			return false;
+		}
 	}
 
 }
@@ -217,8 +228,9 @@ function get_filenames(string $source_dir, bool $include_path = false, bool $rec
 	{
 		static $filedata = [];
 
-		if ($fp = @opendir($source_dir))
+		try
 		{
+			$fp = opendir($source_dir);
 			// reset the array and make sure $source_dir has a trailing slash on the initial call
 			if ($recursion === false)
 			{
@@ -231,7 +243,8 @@ function get_filenames(string $source_dir, bool $include_path = false, bool $rec
 				if (is_dir($source_dir . $file) && $file[0] !== '.')
 				{
 					get_filenames($source_dir . $file . DIRECTORY_SEPARATOR, $include_path, true);
-				} elseif ($file[0] !== '.')
+				}
+				elseif ($file[0] !== '.')
 				{
 					$filedata[] = ($include_path === true) ? $source_dir . $file : $file;
 				}
@@ -240,8 +253,10 @@ function get_filenames(string $source_dir, bool $include_path = false, bool $rec
 			closedir($fp);
 			return $filedata;
 		}
-
-		return [];
+		catch (\Exception $fe)
+		{
+			return [];
+		}
 	}
 
 }
@@ -270,33 +285,38 @@ function get_dir_file_info(string $source_dir, bool $top_level_only = true, bool
 		static $filedata = [];
 		$relative_path = $source_dir;
 
-		if ($fp = @opendir($source_dir))
+		try
 		{
-			// reset the array and make sure $source_dir has a trailing slash on the initial call
-			if ($recursion === false)
-			{
-				$filedata = [];
-				$source_dir = rtrim(realpath($source_dir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
-			}
-
-			// Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
-			while (false !== ($file = readdir($fp)))
-			{
-				if (is_dir($source_dir . $file) && $file[0] !== '.' && $top_level_only === false)
+			$fp = @opendir($source_dir); {
+				// reset the array and make sure $source_dir has a trailing slash on the initial call
+				if ($recursion === false)
 				{
-					get_dir_file_info($source_dir . $file . DIRECTORY_SEPARATOR, $top_level_only, true);
-				} elseif ($file[0] !== '.')
+					$filedata = [];
+					$source_dir = rtrim(realpath($source_dir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+				}
+
+				// Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
+				while (false !== ($file = readdir($fp)))
 				{
-					$filedata[$file] = get_file_info($source_dir . $file);
-					$filedata[$file]['relative_path'] = $relative_path;
+					if (is_dir($source_dir . $file) && $file[0] !== '.' && $top_level_only === false)
+					{
+						get_dir_file_info($source_dir . $file . DIRECTORY_SEPARATOR, $top_level_only, true);
+					}
+					elseif ($file[0] !== '.')
+					{
+						$filedata[$file] = get_file_info($source_dir . $file);
+						$filedata[$file]['relative_path'] = $relative_path;
+					}
 				}
-			}
 
-			closedir($fp);
-			return $filedata;
+				closedir($fp);
+				return $filedata;
+			}
+		}
+		catch (\Exception $fe)
+		{
+			return [];
 		}
-
-		return [];
 	}
 
 }
@@ -385,25 +405,32 @@ function symbolic_permissions(int $perms): string
 		if (($perms & 0xC000) === 0xC000)
 		{
 			$symbolic = 's'; // Socket
-		} elseif (($perms & 0xA000) === 0xA000)
+		}
+		elseif (($perms & 0xA000) === 0xA000)
 		{
 			$symbolic = 'l'; // Symbolic Link
-		} elseif (($perms & 0x8000) === 0x8000)
+		}
+		elseif (($perms & 0x8000) === 0x8000)
 		{
 			$symbolic = '-'; // Regular
-		} elseif (($perms & 0x6000) === 0x6000)
+		}
+		elseif (($perms & 0x6000) === 0x6000)
 		{
 			$symbolic = 'b'; // Block special
-		} elseif (($perms & 0x4000) === 0x4000)
+		}
+		elseif (($perms & 0x4000) === 0x4000)
 		{
 			$symbolic = 'd'; // Directory
-		} elseif (($perms & 0x2000) === 0x2000)
+		}
+		elseif (($perms & 0x2000) === 0x2000)
 		{
 			$symbolic = 'c'; // Character special
-		} elseif (($perms & 0x1000) === 0x1000)
+		}
+		elseif (($perms & 0x1000) === 0x1000)
 		{
 			$symbolic = 'p'; // FIFO pipe
-		} else
+		}
+		else
 		{
 			$symbolic = 'u'; // Unknown
 		}
@@ -474,7 +501,8 @@ function set_realpath(string $path, bool $checkExistance = false): string
 		if (realpath($path) !== false)
 		{
 			$path = realpath($path);
-		} elseif ($checkExistance && ! is_dir($path) && ! is_file($path))
+		}
+		elseif ($checkExistance && ! is_dir($path) && ! is_file($path))
 		{
 			throw new InvalidArgumentException('Not a valid path: ' . $path);
 		}