crop-monitor/core/components/phpthumbof/model/pthumbcachecleaner.class.php

<?php
/**
 * pThumb
 * Copyright 2013, 2014 Jason Grant
 *
 * Please see the GitHub page for documentation or to report bugs:
 * https://github.com/oo12/phpThumbOf
 *
 * pThumb is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option) any
 * later version.
 *
 * pThumb is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * phpThumbOf; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA 02111-1307 USA
 */

require_once MODX_CORE_PATH . 'components/phpthumbof/model/phpthumbof.class.php';

/*
 *  Used for recursing through the pThumb Cache
 */
class FilenameFilter extends RecursiveRegexIterator {
	protected $regex;

	function __construct(RecursiveIterator $it, $regex) {
		$this->regex = $regex;
		parent::__construct($it, $regex);
	}

	function accept() {
		return (!$this->isFile() || preg_match($this->regex, $this->getFilename()));
	}
}


/*
 *  Extends main pThumb class to add a cache cleaning method
 *  Used by phpThumbOfCacheManager
 */
class pThumbCacheCleaner extends phpThumbOf {


private function pluralize($count, $thing = 'image') {
	return $count == 1 ? "1 $thing" : "$count $thing" . 's';
}

private function rmfile($file, $isS3, $s3obj) {
	if ($isS3) {
		$response = $s3obj->driver->delete_object($s3obj->bucket, $file);
		return $response->isOK();
	}
	else { return @unlink($file); }
}


/*
 *  Clean up the pThumb cache directories
 *  Adapted from phpThumb ( http://phpthumb.sourceforge.net/ )
 *  Clean Levels:
 *  0: no cleaning
 *  1: clean based on system phpThumb cache settings
 *  2: remove all cached images
 */
public function cleanCache() {
	$config['clean_level'] = (int) $this->modx->getOption('pthumb.clean_level', null, 0);
	$config['cache_maxage'] = $this->modx->getOption('phpthumb_cache_maxage', null, 365);
	$description['maxage'] = $this->pluralize($config['cache_maxage'], 'day');
	$config['cache_maxage'] *= 86400;  // convert to seconds
	$config['cache_maxsize'] = $this->modx->getOption('phpthumb_cache_maxsize', null, 300);
	$description['maxsize'] = "{$config['cache_maxsize']} MB";
	$config['cache_maxsize'] *= 1048576;  // convert to bytes
	$config['cache_maxfiles'] = (int) $this->modx->getOption('phpthumb_cache_maxfiles', null, 10000);
	$this->modx->log(modX::LOG_LEVEL_INFO, "[pThumb Cache Manager]  Clean Level: {$config['clean_level']} || Max Age: {$description['maxage']} || Max Size: {$description['maxsize']} || Max Files: {$config['cache_maxfiles']}");

	if ($config['clean_level'] < 1 || ($config['clean_level'] === 1 && !($config['cache_maxage'] || $config['cache_maxsize'] || $config['cache_maxfiles']))) {
		$this->modx->log(modX::LOG_LEVEL_INFO, '::  Skipping cache cleanup based on settings');
		$this->modx->log(modX::LOG_LEVEL_INFO, '');
		return;  // that was easy.
	}
	$cachepath = array();  // gather up cache paths
	$cachepath['pThumb'] = $this->modx->getOption('pthumb.ptcache_location', null, 'assets/image-cache', true);
	if ($cachepath['pThumb'] === '/') {  // for safety, pThumb cache location has to be a subdir, can't be the web root
		$cachepath['pThumb'] = 'assets/image-cache';
	}
	$cachepath['pThumb'] = MODX_BASE_PATH . $cachepath['pThumb'];
	$cachepath['phpThumbOf'] = $this->modx->getOption('phpthumbof.cache_path', null, "{$this->config['assetsPath']}components/phpthumbof/cache", true);
	$cachepath['Remote Images'] = $this->config['remoteImagesCachePath'];
	foreach ($cachepath as $path) {
		$path = rtrim(str_replace('//', '/', $path), '/');  // normalize path
		if (!is_dir($path)) {
			$path = false;
		}
	}

	$cachefiles = array();  // gather up cache files
	foreach (array('pThumb', 'Remote Images') as $cachename) {
		if (is_writeable($cachepath[$cachename])) {  // recurse through all subdirectories looking for jpeg, jpg, png and gif
			$filter = new FilenameFilter(
				new RecursiveDirectoryIterator($cachepath[$cachename], FilesystemIterator::SKIP_DOTS),
				$cachename === 'pThumb' ? '/.+\.[0-9a-f]{8}\.(jpg|png|gif)$/' : '/\.(?:jpe?g|png|gif)$/i'  // for pThumb cache, only select images with what appears to be an 8-character hash
			);
			$cachefiles[$cachename] = array();
			foreach(new RecursiveIteratorIterator($filter) as $file) {
				$cachefiles[$cachename][] = $file->getPathName();
			}
		}
	}
	if ($cachepath['phpThumbOf']) {
		if ( ! $cachefiles['phpThumbOf'] = glob("{$cachepath['phpThumbOf']}/*.{jp*g,png,gif}", GLOB_BRACE)) {
			$cachefiles['phpThumbOf'] = array();  // empty array if glob didn't find anything
		}
	}
	$s3out = false;
	if ($this->config['s3outputMS']) {
		$s3out =& $this->config[$this->config['s3outKey']];
		$cachefiles['S3'] = array_keys($this->config[$this->config['s3outKey'] . '_images']);
	}

	foreach ($cachefiles as $cachename => $fileset) {
		$isS3 = $cachename === 'S3';
		$totalimages = count($fileset);
		$DeletedKeys = array();
		$CacheDirOldFilesAge  = array();
		$CacheDirOldFilesSize = array();
		if ($isS3) {
			foreach($this->config[$this->config['s3outKey'] . '_images'] as $k => $v) {
				$CacheDirOldFilesAge[$k] = $v['mod'];
				$CacheDirOldFilesSize[$k] = $v['size'];
			}
		}
		else {
			foreach ($fileset as $fullfilename) {  // get accessed (or modified) time and size for each file
				if ( ! $CacheDirOldFilesAge[$fullfilename] = @fileatime($fullfilename)) {
					$CacheDirOldFilesAge[$fullfilename] = @filemtime($fullfilename);  // fall back to filemtime if fileatime doesn't work
				}
				$CacheDirOldFilesSize[$fullfilename] = @filesize($fullfilename);
			}
		}

		$this->modx->log(modX::LOG_LEVEL_INFO, ":: $cachename Cache: " . $this->pluralize($totalimages) . ' (' . round(array_sum($CacheDirOldFilesSize) / 1048576, 2) . ' MB)');

		if ($config['clean_level'] === 2) {  // simply delete all the files
			$deleted = 0;
			if ($isS3) {
				$response = $s3out->driver->delete_all_objects($s3out->bucket, $this->cacheimgRegex);
				if ($response) {
					$deleted = $totalimages;
				}
			}
			else {
				foreach ($fileset as $file) {
					if (@unlink($file)) {
						++$deleted;
					}
				}
			}
			$this->modx->log(modX::LOG_LEVEL_INFO, ':: ' . $this->pluralize($deleted, 'file') . ' purged');
		}
		else {  // clean up based on system phpThumb settings
			$madedeletions = false;
			$DeletedKeys['zerobyte'] = 0;
			foreach ($CacheDirOldFilesSize as $fullfilename => $filesize) {  // remove any 0-byte files
				// but only if they're more than 10 min old (to prevent trying to delete just-created or in-use files)
				$cutofftime = time() - 600;
				if (!$filesize && $CacheDirOldFilesAge[$fullfilename] < $cutofftime) {
					if ($this->rmfile($fullfilename, $isS3, $s3out)) {
						++$DeletedKeys['zerobyte'];
						unset($CacheDirOldFilesSize[$fullfilename]);
						unset($CacheDirOldFilesAge[$fullfilename]);
					}
				}
			}
			if ($DeletedKeys['zerobyte']) {
				$this->modx->log(modX::LOG_LEVEL_INFO, ':: Purged ' . $this->pluralize($DeletedKeys['zerobyte'], 'zero-byte image'));
				$madedeletions = true;
			}

			asort($CacheDirOldFilesAge);  // all deletions start with the least recently accesed (or oldest) files first

			if ($config['cache_maxage']) {  // delete any files older that maxage
				$mindate = time() - $config['cache_maxage'];
				$DeletedKeys['maxage'] = 0;
				foreach ($CacheDirOldFilesAge as $fullfilename => $filedate) {
					if ($filedate) {
						if ($filedate < $mindate) {
							if ($this->rmfile($fullfilename, $isS3, $s3out)) {
								++$DeletedKeys['maxage'];
								unset($CacheDirOldFilesAge[$fullfilename]);
								unset($CacheDirOldFilesSize[$fullfilename]);
							}
						}
						else {  // the rest of the files are new enough to keep
							break;
						}
					}
				}
				if ($DeletedKeys['maxage']) {
					$this->modx->log(modX::LOG_LEVEL_INFO, ':: Purged ' . $this->pluralize($DeletedKeys['maxage']) . " based on (cache_maxage={$description['maxage']})");
					$madedeletions = true;
				}
			}

			if ($config['cache_maxfiles']) {  // delete any files in excess of maxfiles
				$TotalCachedFiles = count($CacheDirOldFilesAge);
				$DeletedKeys['maxfiles'] = 0;
				foreach ($CacheDirOldFilesAge as $fullfilename => $filedate) {
					if ($TotalCachedFiles > $config['cache_maxfiles']) {
						if ($this->rmfile($fullfilename, $isS3, $s3out)) {
							--$TotalCachedFiles;
							++$DeletedKeys['maxfiles'];
							unset($CacheDirOldFilesAge[$fullfilename]);
							unset($CacheDirOldFilesSize[$fullfilename]);
						}
					}
					else {  // there are few enough files to keep the rest
						break;
					}
				}
				if ($DeletedKeys['maxfiles']) {
					$this->modx->log(modX::LOG_LEVEL_INFO, ':: Purged ' . $this->pluralize($DeletedKeys['maxfiles']) . " based on (cache_maxfiles={$config['cache_maxfiles']})");
					$madedeletions = true;
				}
			}

			if ($config['cache_maxsize']) {  // delete files to get the total cache size under the maxsize limit
				$TotalCachedFileSize = array_sum($CacheDirOldFilesSize);
				$DeletedKeys['maxsize'] = 0;
				foreach ($CacheDirOldFilesAge as $fullfilename => $filedate) {
					if ($TotalCachedFileSize > $config['cache_maxsize']) {
						if ($this->rmfile($fullfilename, $isS3, $s3out)) {
							$TotalCachedFileSize -= $CacheDirOldFilesSize[$fullfilename];
							++$DeletedKeys['maxsize'];
							unset($CacheDirOldFilesAge[$fullfilename]);
							unset($CacheDirOldFilesSize[$fullfilename]);
						}
					}
					else {  // the total filesizes are small enough to keep the rest of the files
						break;
					}
				}
				if ($DeletedKeys['maxsize']) {
					$this->modx->log(modX::LOG_LEVEL_INFO, ':: Purged ' . $this->pluralize($DeletedKeys['maxsize']) . " based on (cache_maxsize={$description['maxsize']})");
					$madedeletions = true;
				}
			}
		}

		$DeletedSubdirs = 0;
		if ($cachename !== 'phpThumbOf' && !$isS3 && is_writable($cachepath[$cachename])) {  // remove any empty subdirs in pThumb and Remote Images caches
			$ritit = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($cachepath[$cachename], FilesystemIterator::SKIP_DOTS), RecursiveIteratorIterator::CHILD_FIRST);
			foreach ($ritit as $dirname => $pathObj) {
				if ($pathObj->isDir() && iterator_count($ritit->getSubIterator()->getChildren()) === 0) {
					rmdir($dirname);
					++$DeletedSubdirs;
				}
			}
		}

		if ($config['clean_level'] != 2) {
			$totalpurged = 0;
			foreach ($DeletedKeys as $value) {
				$totalpurged += $value;
			}
			$this->modx->log(modX::LOG_LEVEL_INFO, ':: Purged ' . $this->pluralize($totalpurged) . ($DeletedSubdirs ? ', ' . $this->pluralize($DeletedSubdirs, 'empty subdir') : '') . ($madedeletions ? ' || New cache size: ' . $this->pluralize(count($CacheDirOldFilesSize)) . ' (' . round(array_sum($CacheDirOldFilesSize) / 1048576, 2) . ' MB)': ''));
		}
	}
	$this->modx->log(modX::LOG_LEVEL_INFO, '');
}

}