Rss-Bridge/lib/HttpCachingBridgeAbstract.php
logmanoriginal 1a2a48e129 [HttpCachingBridgeAbstract] Use sha1 cache file names
Previously folder hierarchies were created based on the input URL
which could result in very deep folder structures. Using SHA1 file
names also allows to check for old files more effectively (via
fileatime)
2016-09-10 00:00:10 +02:00

67 lines
2.4 KiB
PHP

<?php
require_once(__DIR__ . '/BridgeInterface.php');
/**
* Extension of BridgeAbstract allowing caching of files downloaded over http.
* TODO allow file cache invalidation by touching files on access, and removing
* files/directories which have not been touched since ... a long time
*/
abstract class HttpCachingBridgeAbstract extends BridgeAbstract {
/**
* Maintain locally cached versions of pages to download, to avoid multiple downloads.
* @param url url to cache
* @param duration duration of the cache file in seconds (default: 24h/86400s)
* @return content of the file as string
*/
public function get_cached($url, $duration = 86400){
$filepath = $this->buildCacheFilePath($url);
if(file_exists($filepath) && filectime($filepath) < time() - $duration){
$this->debugMessage('Cache file ' . $filepath . ' exceeded duration of ' . $duration . ' seconds.');
unlink ($filepath);
$this->debugMessage('Cached file deleted: ' . $filepath);
}
if(file_exists($filepath)){
$this->debugMessage('loading cached file from ' . $filepath . ' for page at url ' . $url);
// TODO touch file and its parent, and try to do neighbour deletion
touch($filepath);
$content = file_get_contents($filepath);
} else {
$this->debugMessage('we have no local copy of ' . $url . ' Downloading to ' . $filepath);
$dir = substr($filepath, 0, strrpos($filepath, '/'));
if(!is_dir($dir)){
$this->debugMessage('creating directories for ' . $dir);
mkdir($dir, 0777, true);
}
$content = $this->getContents($url);
if($content !== false){
file_put_contents($filepath, $content);
}
}
return str_get_html($content);
}
public function get_cached_time($url){
$filepath = $this->buildCacheFilePath($url);
if(!file_exists($filepath)){
$this->get_cached($url);
}
return filectime($filepath);
}
private function buildCacheFilePath($url){
return __DIR__ . '/../cache/pages/' . sha1($url) . '.cache';
}
public function remove_from_cache($url){
$filepath = $this->buildCacheFilePath($url);
$this->debugMessage('removing from cache \'' . $filepath . '\'');
unlink($filepath);
}
}