051e127bdb
* Make the code easier to own and maintain by being part of a topical area of expertise rather than a generic catch-all bucket. This also helps Gerrit team dashboards, [[mw:Git/Reviewers]] subscription patterns, more meaningful component prefix for [[mw:Commit_message_guidelines]]. * Prep for possible CODEOWNERS adoption. * Prep for T166010 to give us better PSR-4 namespaces that we won't have to break/migrate again shortly after for the above. Bug: T225756 Change-Id: I62c701d574d2a79365b1c5350f92bef47770e3ce
101 lines
2.6 KiB
PHP
101 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* Data caching with dependencies.
|
|
*
|
|
* This program 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.
|
|
*
|
|
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Cache
|
|
*/
|
|
|
|
use Wikimedia\AtEase\AtEase;
|
|
|
|
/**
|
|
* @newable
|
|
* @ingroup Cache
|
|
*/
|
|
class FileDependency extends CacheDependency {
|
|
private $filename;
|
|
private $timestamp;
|
|
|
|
/**
|
|
* Create a file dependency
|
|
*
|
|
* @stable to call
|
|
*
|
|
* @param string $filename The name of the file, preferably fully qualified
|
|
* @param null|bool|int $timestamp The unix last modified timestamp, or false if the
|
|
* file does not exist. If omitted, the timestamp will be loaded from
|
|
* the file.
|
|
*
|
|
* A dependency on a nonexistent file will be triggered when the file is
|
|
* created. A dependency on an existing file will be triggered when the
|
|
* file is changed.
|
|
*/
|
|
public function __construct( $filename, $timestamp = null ) {
|
|
$this->filename = $filename;
|
|
$this->timestamp = $timestamp;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function __sleep() {
|
|
$this->loadDependencyValues();
|
|
|
|
return [ 'filename', 'timestamp' ];
|
|
}
|
|
|
|
public function loadDependencyValues() {
|
|
if ( $this->timestamp === null ) {
|
|
AtEase::suppressWarnings();
|
|
# Dependency on a non-existent file stores "false"
|
|
# This is a valid concept!
|
|
$this->timestamp = filemtime( $this->filename );
|
|
AtEase::restoreWarnings();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isExpired() {
|
|
AtEase::suppressWarnings();
|
|
$lastmod = filemtime( $this->filename );
|
|
AtEase::restoreWarnings();
|
|
if ( $lastmod === false ) {
|
|
if ( $this->timestamp === false ) {
|
|
# Still nonexistent
|
|
return false;
|
|
}
|
|
|
|
# Deleted
|
|
wfDebug( "Dependency triggered: {$this->filename} deleted." );
|
|
|
|
return true;
|
|
}
|
|
|
|
if ( $lastmod > $this->timestamp ) {
|
|
# Modified or created
|
|
wfDebug( "Dependency triggered: {$this->filename} changed." );
|
|
|
|
return true;
|
|
}
|
|
|
|
# Not modified
|
|
return false;
|
|
}
|
|
}
|