utils/php/astropenguin/botanical/RegRename.php

<?php

namespace astropenguin\botanical;
use DirectoryIterator;

class RegRename
{

	//Define globals
	private $test = false;
	private $recursive = false;
	private $searchDirs = array();
	private $patterns = array();
	private $replaceStrs = array();
	private $excludes = array();

	private $logfile = NULL;

	public function begin()
	{
		$this->validateOptions();

		//------- Begin Operations -------
		foreach ( $this->searchDirs as $dir )
		{
			$this->elog("Directory: $dir\nBuilding file list ...");
			if ( $this->recursive )
			{
				$fileList = $this->getWholeFileList($dir);
			}
			else
			{
				$fileList = $this->getFileList($dir);
			}
			$this->elog("Searching ...");
			foreach ( $fileList as $file )
			{
				//
				// Get the file name
				// RegExplained:
				// Example: /foo/bar/foobar.bar
				//   $matches[0][0] is the whole string "/foo/bar/foobar.bar"
				//
				//   ^(.+?)
				//   This gets the file path "/foo/bar/" for $matches[1][0]
				//
				//   ([^\/\\\\]+)$
				//   This gets the file name "foobar.bar" for $matches[2][0]
				//
				preg_match_all('/^(.+?)([^\/\\\\]+)$/', $file, $matches );
				$newName = $matches[2][0];
				foreach ( $this->patterns as $key => $pattern )
				{
					//Rename over the patterns
					$newName = preg_replace( $pattern, $this->replaceStrs[$key], $newName );
				}

				if( $matches[2][0] != $newName )
				{

					// Excluede any matches
					foreach ( $this->excludes as $key => $pattern )
					{
						if(preg_match_all($pattern, $file))
						{
							$this->elog("S File \"{$matches[2][0]}\" excluded on $pattern");
							continue 2;
						}
					}

					if( $this->test )
					{
						$this->elog("R File \"{$matches[2][0]}\" will be renamed to \"$newName\"");
					}
					else
					{
						rename ( $file, "{$matches[1][0]}$newName" );
					}

					if( $this->logfile )
					{
						file_put_contents( $this->logfile, $this->log );
					}
				}
				/*
				else
				{
					echo "File \"{$matches[0][0]}\" will not be renamed\n";
				}
				//*/
			}
			$this->elog();
		}
		if ( $this->test ) $this->elog("*** Test enabled ***\n");
		//------- End Operations -------*/
	}

	public function setOption( $item, $value = NULL )
	{
		switch($item)
		{
			case "-d":
				if($value)
				$this->searchDirs[] = $value;
				break;
			case "-p":
				if($value)
				$this->patterns[] = $value;
				break;
			case "-r":
				$this->recursive = true;
				break;
			case "-s":
				if($value)
				$this->replaceStrs[] = $value;
				break;
			case "-t":
				$this->test = true;
				break;
			case "-e":
				$this->excludes[] = $value;
				break;
			case "-l":
				$this->logfile = $value;
				break;
			default:
				//Do nothing
		}
	}

	//------- Main Functions --------

	function elog( $line = "" )
	{
		$this->log .= $line;
		$this->log .= "\n";
		echo "$line\n";
	}


	private function getDirName ( $dir )
	{
		return is_dir ( $dir ) ? $dir : dirname ( $dir ) ;
	}

	private function getFileList ( $dir )
	{
		$fileList = array();
		$iterator = new DirectoryIterator ( $this->getDirName ( $dir )  ) ;
		foreach ( $iterator as $fileinfo )
		{
			if ( $fileinfo->isFile() )
			{
				$fileList[] = $dir."/".$fileinfo->getFilename();
			}
		}
		return $fileList;
	}

	private function getDirList ( $dir )
	{
		$dirList = array();
		$iterator = new DirectoryIterator ( $this->getDirName ( $dir ) );
		foreach ( $iterator as $fileinfo )
		{
			if ( $fileinfo->isDir() && !$fileinfo->isDot())
			{
				$dirList[] = $fileinfo->getFilename();
			}
		}

		return $dirList;
	}

	private function getWholeDirList ( $dir )
	{
		$wholeDirList = array();
		//getWholeDirList will stop untill getDirList return an empty array.
		foreach ( $this->getDirList ( $dir ) as $file )
		{
				//Store found path
				$wholeDirList[] = "$dir/$file";
				//Method getWholeDirList will self-iterate if sub-directories exist.
				$wholeDirList = array_merge ( $wholeDirList, $this->getWholeDirList ( "$dir/$file" )  ) ;
		}
		return $wholeDirList;
	}

	private function getWholeFileList ( $dir )
	{
		//Get the first level list.
		$wholeFileList = $this->getFileList( $dir );
		//getWholeDirList and search its files.
		foreach ( $this->getWholeDirList ( $dir ) as $dir )
		{
			$wholeFileList = array_merge ( $wholeFileList, $this->getFileList ( $dir )  ) ;
		}
		return $wholeFileList;
	}

	private function validateOptions (  )
	{
		try
		{
			if(count($this->searchDirs) == 0)
			throw new Exception("Search directory is missing");

			else if(count($this->patterns) == 0)
			throw new Exception("Search pattern is missing");

			else if(count($this->replaceStrs) == 0)
			throw new Exception("Replacement string is missing");

			else if(count($this->replaceStrs) != count($this->patterns))
			throw new Exception("Replacement string and pattern count not match");
		}
		catch(Exception $e)
		{
			var_dump( $GLOBALS );
			die("Error: $e.\n");
		}
	}

	//------- End Main Functions --------
}