StaticPages.module

<?php
/*
Static pages module
https://github.com/ryancramerdesign/Helloworld
AT
28.07.26
*/

namespace ProcessWire;

class StaticPages extends WireData implements Module, ConfigurableModule {

	public function init() {
		$this->addHookAfter('Modules::saveConfig', $this, 'hookAfterSaveConfig');

		if( !$this->isEnabled || $this->isEnabled == '' ) return;

		$this->addHookAfter('Page::render', $this, 'hookCache', ['priority' => (int) $this->priority]);
		$this->pages->addHookAfter('save', $this, 'hookWipe');
		$this->pages->addHookAfter('delete', $this, 'hookWipe');
	}

	public function hookCache($event) {
		return $this->cachePage($event);
	}

	public function hookWipe($event) {

		//skipping wipe is page is a repeater item
		if ( $event->arguments[0] instanceof RepeaterPage ) return;

/*
ob_start();
echo 'page: ', var_dump( $event->arguments[0] );
$buffer = ob_get_clean();
$this->message($buffer);
*/
		return $this->wipeCaches();
	}

	public function hookAfterSaveConfig($event) {
		//should run in backend only!
		//Only continue if settings of this module are being saved.
		if( $event->arguments[0] !== $this->className ) return;
		if( $_POST['forceWipeOnModuleSave'] != 1 ) return;
		return $this->wipeCaches();
	}

////

	public function cachePage($event) {
		//should run in frontend only!

		$page = $event->object;

		//skipping 404 page caching
		if( $page->id == wire('config')->http404PageID ) return;

		$html = $event->return;

		// skip if template is deprecated
		if( in_array($page->template->id, (array)$this->nonStaticTemplates) ) return;

		//skip if get or post request
		if( count(wire('input')->get) > 0 || count (wire('input')->post) > 0 ) return;

		//caching url segments independently for non-404 pages
		//if( $page->id != wire('config')->http404PageID )
			$urlSegmentStr = wire('input')->urlSegmentStr;

		$dir = "{$_SERVER['DOCUMENT_ROOT']}{$page->path}";
		if( $urlSegmentStr !='' ) $dir.= "$urlSegmentStr/";
		$path = $dir.$this->staticFile;
		mkdir($dir, octdec($this->newDirPermissions), true);
		file_put_contents($path,$html);
	}

	public function wipeCaches(){
		//wipes every dir/index.html in non-deprecated dirs with no regard to template, page etc
		//should run in backend

		$start = microtime(true);
		ob_start();

		if( $this->useShell ){
			switch(true){
				case stristr( PHP_OS, 'win' ):
					$this->wipeCachesWindows();
				break;

				case stristr( PHP_OS, 'linux' ):
				case stristr( PHP_OS, 'unix' ):
				case stristr( PHP_OS, 'darwin' ):
					$this->wipeCachesLinux();
				break;

				default:
					$this->wipeCachesPHP();
			}
		}

		else
			$this->wipeCachesPHP();

		$duration = round( microtime(true)-$start, 2 );

echo "Static cache cleaned in $duration s.";

		$buffer = ob_get_clean();
		$this->message($buffer);
	}

//privates

private function wipeCachesLinux(){

//echo 'wipeCachesLinux()';//

	$shellCommand = "find {$_SERVER['DOCUMENT_ROOT']} ";
	$pruneCommands = [];

	$nonStaticDirs = explode( "\n", $this->nonStaticDirs );

	foreach( $nonStaticDirs as $nonStaticDir)
		$pruneCommands[] = "-type d -name '$nonStaticDir' -prune ";

	$shellCommand .= implode(' -o ', $pruneCommands);
	$shellCommand .= "-o -type f -name '{$this->staticFile}' -exec rm {} + ";

//echo '$shellCommand: ', var_dump($shellCommand);

	`$shellCommand`;

	//deleting empty dirs
	for( $i=0; $i<$this->rmDirPasses; $i++ )
		`find {$_SERVER['DOCUMENT_ROOT']} -type d -empty -exec rmdir {} +`;

}

private function wipeCachesWindows(){

//echo 'wipeCachesWindows()';//

	$nonStaticDirs = explode( "\n", $this->nonStaticDirs );

	$shellCommand = "Get-ChildItem -Path {$_SERVER['DOCUMENT_ROOT']} -Filter '{$this->staticFile}'  -Recurse -File ";
	$notLikeCommands = [];

	foreach( $nonStaticDirs as $nonStaticDir)
		$notLikeCommands[] = "\$_.DirectoryName -notlike '*\\" . $nonStaticDir . "*' ";

	if( count($notLikeCommands) )
		$shellCommand .= ' | Where-Object {' . implode(' -or ', $notLikeCommands) . '}';

	$shellCommand .= " | Remove-Item -Force";

	$shellCommand = "powershell \"$shellCommand\"";

//echo '$shellCommand: ', var_dump($shellCommand);

	$result = `$shellCommand`;

//echo '$result: ', var_dump($result);

	//deleting empty dirs
	$shellCommand = "Get-ChildItem -Path {$_SERVER['DOCUMENT_ROOT']} -Recurse -Directory | Where-Object { \$_.GetFileSystemInfos().Count -eq 0 } | Remove-Item -Force -Verbose";
	$shellCommand = "powershell \"$shellCommand\"";

//echo '$shellCommand: ', var_dump($shellCommand);

	for( $i=0; $i<$this->rmDirPasses; $i++ )
		`$shellCommand`;

}

	public function wipeCachesPHP(){
		//wipes every dir/index.html in non-deprecated dirs with no regard to template, page etc
		//should run in backend

		$deletedFiles = 0;
		$deletedDirs = 0;
		$deletedBytes = 0;

		$nonStaticDirs = explode( "\n", $this->nonStaticDirs );

//echo '$nonStaticDirs: ', var_dump($nonStaticDirs);//
//echo '$_SERVER[DOCUMENT_ROOT]: ', var_dump($_SERVER['DOCUMENT_ROOT']);//

		$rii = new \RecursiveIteratorIterator( new \RecursiveDirectoryIterator($_SERVER['DOCUMENT_ROOT']) );
		foreach ($rii as $entry) {

			//skipping dirs
			if ( $entry == $_SERVER['DOCUMENT_ROOT'].'/..' ) continue; 
			if ( $entry->isDir() ) continue;

			$path = $entry->getPathname();
			$pathInfo = pathinfo($path);
			$dirPath = $pathInfo['dirname'];

			//skipping files which should not be deleted
			if( $pathInfo['basename'] != $this->staticFile ) continue;

			//skipping $nonStaticDirs
			$continueFlag = false;
			foreach( $nonStaticDirs as $nonStaticDir ){
				$sample = $_SERVER['DOCUMENT_ROOT'] . DIRECTORY_SEPARATOR . $nonStaticDir;
				if( strpos($dirPath, $sample) === false ) continue;
				$continueFlag = true;
				break;
			}
			if( $continueFlag ) continue;

//echo "deleting file $path...\n";//
			$fileSize = filesize($path);
			unlink($path);
			$deletedFiles++;
			$deletedBytes += $fileSize;

			//trying to delete the dir if empty
			$dirIsEmpty = !(new \FilesystemIterator($dirPath))->valid();
			if( !$dirIsEmpty ) continue;
//echo "deleting dir $dirPath...\n";//
			rmdir($dirPath);//
			$deletedDirs++;

			//trying to delete empty dirs up to the DOCUMENT_ROOT level
			$parts = explode( DIRECTORY_SEPARATOR, $dirPath );
			foreach( $parts as $part ){
				array_pop($parts);
				$parentDirPath = implode( DIRECTORY_SEPARATOR, $parts );

				if( strlen($parentDirPath) <= strlen($_SERVER['DOCUMENT_ROOT']) ) continue;
				if( in_array( $parentDirPath, ['', '.', '..'] ) ) continue;

				$dirIsEmpty = !(new \FilesystemIterator($parentDirPath))->valid();
				if( !$dirIsEmpty ) continue;
//echo "deleting dir $parentDirPath...\n";
				rmdir($parentDirPath);//
				$deletedDirs++;
			}

		}

		$deletedBytes = $this->readableFilesize($deletedBytes);

echo "$deletedFiles static file(s) ($deletedBytes) and $deletedDirs dir(s) deleted. ";

	}

	private function readableFilesize($bytes, $decimals = 2) {
		$sz = 'BKMGTP';
		$factor = floor((strlen($bytes) - 1) / 3);
		return sprintf("%.{$decimals}f", $bytes / pow(1024, $factor)) . @$sz[$factor];
	}

}