CacheApiService.php

<?php
namespace Etobi\CoreAPI\Service;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2012 Georg Ringer <georg.ringer@cyberhouse.at>
 *  (c) 2014 Stefano Kowalke <blueduck@gmx.net>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Cache API service
 *
 * @author Georg Ringer <georg.ringer@cyberhouse.at>
 * @author Stefano Kowalke <blueduck@gmx.net>
 * @package Etobi\CoreAPI\Service\SiteApiService
 */
class CacheApiService
{

	/**
	 * @var \TYPO3\CMS\Core\DataHandling\DataHandler
	 */
	protected $dataHandler;

	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager
	 */
	protected $objectManager;

	/**
	 * @var \TYPO3\CMS\Install\Service\ClearCacheService
	 */
	protected $installToolClearCacheService;

	/**
	 * @param \TYPO3\CMS\Core\DataHandling\DataHandler $dataHandler
	 *
	 * @return void
	 */
	public function injectDataHandler(\TYPO3\CMS\Core\DataHandling\DataHandler $dataHandler)
	{
		$this->dataHandler = $dataHandler;
	}

	/**
	 * @param \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager
	 *
	 * @return void
	 */
	public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)
	{
		$this->objectManager = $objectManager;
	}

	/**
	 * @param \TYPO3\CMS\Install\Service\ClearCacheService $installToolClearCacheService
	 *
	 * @return void
	 */
	public function injectInstallToolClearCacheService(\TYPO3\CMS\Install\Service\ClearCacheService $installToolClearCacheService)
	{
		$this->installToolClearCacheService = $installToolClearCacheService;
	}

	/**
	 * Initialize the object.
	 *
	 * @return void
	 */
	public function initializeObject()
	{
		// Create a fake admin user
		$adminUser = $this->objectManager->get('TYPO3\\CMS\\Core\\Authentication\\BackendUserAuthentication');
		$adminUser->user['uid'] = $GLOBALS['BE_USER']->user['uid'];
		$adminUser->user['username'] = '_CLI_lowlevel';
		$adminUser->user['admin'] = 1;
		$adminUser->workspace = 0;

		$this->dataHandler->start(Array(), Array(), $adminUser);
	}

	/**
	 * Clear all caches.
	 *
	 * @param bool $hard
	 * @return void
	 */
	public function clearAllCaches($hard = FALSE)
	{
		!$hard ? $this->dataHandler->clear_cacheCmd('all') : $this->installToolClearCacheService->clearAll();
	}

	/**
	 * Clear the page cache.
	 *
	 * @return void
	 */
	public function clearPageCache()
	{
		$this->dataHandler->clear_cacheCmd('pages');
	}

	/**
	 * Clear the page cache by tag.
	 *
	 * @return void
	 */
	public function clearPageCacheByTag($tag)
	{
		$this->dataHandler->clear_cacheCmd('cachetag:' . $tag);
	}

	/**
	 * Clears the configuration cache.
	 *
	 * @return void
	 */
	public function clearConfigurationCache()
	{
		$this->dataHandler->clear_cacheCmd('temp_cached');
	}


	/**
	 * Clear the system cache
	 *
	 * @return void
	 */
	public function clearSystemCache()
	{
		$this->dataHandler->clear_cacheCmd('system');
	}

	/**
	 * Clears the opcode cache.
	 *
	 * @param string|NULL $fileAbsPath The file as absolute path to be cleared
	 *                                 or NULL to clear completely.
	 *
	 * @return void
	 */
	public function clearAllActiveOpcodeCache($fileAbsPath = NULL)
	{
		$this->clearAllActiveOpcodeCacheWrapper($fileAbsPath);
	}

	/**
	 * Clear all caches except the page cache.
	 * This is especially useful on big sites when you can't
	 * just drop the page cache.
	 *
	 * @return array with list of cleared caches
	 */
	public function clearAllExceptPageCache()
	{
		$out = array();
		$cacheKeys = array_keys($GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']);
		$ignoredCaches = array('cache_pages', 'cache_pagesection');

		$toBeFlushed = array_diff($cacheKeys, $ignoredCaches);

		/** @var \TYPO3\CMS\Core\Cache\CacheManager $cacheManager */
		$cacheManager = $GLOBALS['typo3CacheManager'];
		foreach ($cacheKeys as $cacheKey) {
			if ($cacheManager->hasCache($cacheKey)) {
				$out[] = $cacheKey;
				$singleCache = $cacheManager->getCache($cacheKey);
				$singleCache->flush();
			}
		}

		return $toBeFlushed;
	}

	/**
	 * Clear processed files
	 * The sys_file_processedfile table is truncated and the physical files of local storages are deleted.
	 * @return \TYPO3\CMS\Install\Status\StatusInterface
	 */
	public function clearProcessedFiles()
	{
		$repository = $this->objectManager->get('\\TYPO3\\CMS\\Core\\Resource\\ProcessedFileRepository');
		$failedDeletions = $repository->removeAll();
		return $failedDeletions;

	}

	/**
	 * Clears the opcode cache. This just wraps the static call for testing purposes.
	 *
	 * @param string|NULL $fileAbsPath The file as absolute path to be cleared
	 *                                 or NULL to clear completely.
	 *
	 * @return void
	 */
	protected function clearAllActiveOpcodeCacheWrapper($fileAbsPath)
	{
		\TYPO3\CMS\Core\Utility\OpcodeCacheUtility::clearAllActive($fileAbsPath);
	}
}