%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Manages revisions (backups) of a file.
* Revision file names have form "<filename>-backup-<date>.<ext>~"
*/
class Loco_fs_Revisions implements Countable/*, IteratorAggregate*/ {
/**
* @var Loco_fs_File
*/
private $master;
/**
* Sortable list of backed up file paths (not including master)
* @var array
*/
private $paths;
/**
* Cached regular expression for matching backup file paths
* @var string
*/
private $regex;
/**
* Cached count of backups + 1
* @var int
*/
private $length;
/**
* Paths to delete when object removed from memory
* @var array
*/
private $trash = [];
/**
* Construct from master file (current version)
* @param Loco_fs_File $file
*/
public function __construct( Loco_fs_File $file ){
$this->master = $file;
}
/**
* @internal
* Executes deferred deletions with silent errors
*/
public function __destruct(){
if( $trash = $this->trash ){
$writer = clone $this->master->getWriteContext();
foreach( $trash as $file ){
if( $file->exists() ){
try {
$writer->setFile($file);
$writer->delete(false);
}
catch( Loco_error_WriteException $e ){
// avoiding fatal error because pruning is non-critical operation
Loco_error_AdminNotices::debug( $e->getMessage() );
}
}
}
}
}
/**
* Check that file permissions allow a new backup to be created
* @return bool
*/
public function writable(){
return $this->master->exists() && $this->master->getParent()->writable();
}
/**
* Create a new backup of current version
* @return Loco_fs_File
*/
public function create(){
$vers = 0;
$date = date('YmdHis');
$ext = $this->master->extension();
$base = $this->master->dirname().'/'.$this->master->filename();
do {
$path = sprintf( '%s-backup-%s%u.%s~', $base, $date, $vers++, $ext);
}
while (
file_exists($path)
);
$copy = $this->master->copy( $path );
// invalidate cache so next access reads disk
$this->paths = null;
$this->length = null;
return $copy;
}
/**
* Delete the oldest backups until we have maximum of $num_backups remaining
* @param int $num_backups
* @return Loco_fs_Revisions
*/
public function prune( $num_backups ){
$paths = $this->getPaths();
if( isset($paths[$num_backups]) ){
foreach( array_slice( $paths, $num_backups ) as $path ){
$this->unlinkLater($path);
}
$this->paths = array_slice( $paths, 0, $num_backups );
$this->length = null;
}
return $this;
}
/**
* build regex for matching backed up revisions of master
* @return string
*/
private function getRegExp(){
$regex = $this->regex;
if( is_null($regex) ){
$regex = preg_quote( $this->master->filename(), '/' ).'-backup-(\\d{14,})';
if( $ext = $this->master->extension() ){
$regex .= preg_quote('.'.$ext,'/');
}
$regex = '/^'.$regex.'~/';
$this->regex = $regex;
}
return $regex;
}
/**
* @return array
*/
public function getPaths(){
if( is_null($this->paths) ){
$this->paths = [];
$regex = $this->getRegExp();
$finder = new Loco_fs_FileFinder( $this->master->dirname() );
$finder->setRecursive(false);
/* @var $file Loco_fs_File */
foreach( $finder as $file ){
if( preg_match( $regex, $file->basename() ) ){
$this->paths[] = $file->getPath();
}
}
// time sort order descending
rsort( $this->paths );
}
return $this->paths;
}
/**
* Parse a file path into a timestamp
* @param string $path
* @return int
*/
public function getTimestamp( $path ){
$name = basename($path);
if( preg_match( $this->getRegExp(), $name, $r ) ){
$ymdhis = substr( $r[1], 0, 14 );
return strtotime( $ymdhis );
}
throw new Loco_error_Exception('Invalid revision file: '.$name);
}
/**
* Get number of backups plus master
* @return int
*/
#[ReturnTypeWillChange]
public function count(){
if( ! $this->length ){
$this->length = 1 + count( $this->getPaths() );
}
return $this->length;
}
/**
* Delete file when object removed from memory.
* Previously unlinked on shutdown, but doesn't work with WordPress file system abstraction
* @param string $path
* @return void
*/
public function unlinkLater($path){
$this->trash[] = new Loco_fs_File($path);
}
/**
* Execute backup of current file if enabled in settings.
* @param Loco_api_WordPressFileSystem $api Authorized file system
* @return Loco_fs_File|null backup file if saved
*/
public function rotate( Loco_api_WordPressFileSystem $api ){
$backup = null;
$pofile = $this->master;
$num_backups = Loco_data_Settings::get()->num_backups;
if( $num_backups ){
// Attempt backup, but return null on failure
try {
$api->authorizeCopy($pofile);
$backup = $this->create();
}
catch( Exception $e ){
Loco_error_AdminNotices::debug( $e->getMessage() );
// translators: %s refers to a directory where a backup file could not be created due to file permissions
$message = __('Failed to create backup file in "%s". Check file permissions or disable backups','loco-translate');
Loco_error_AdminNotices::warn( sprintf( $message, $pofile->getParent()->basename() ) );
}
// prune operation in separate catch block as error would be misleading
try {
$this->prune($num_backups);
}
catch( Exception $e ){
Loco_error_AdminNotices::debug('Failed to prune backup files: '.$e->getMessage() );
}
}
return $backup;
}
}
Zerion Mini Shell 1.0