MediaWiki  master
FileJournal.php
Go to the documentation of this file.
1 <?php
37 abstract class FileJournal {
39  protected $backend;
40 
42  protected $ttlDays;
43 
50  protected function __construct( array $config ) {
51  $this->ttlDays = $config['ttlDays'] ?? false;
52  }
53 
62  final public static function factory( array $config, $backend ) {
63  $class = $config['class'];
64  $jrn = new $class( $config );
65  if ( !$jrn instanceof self ) {
66  throw new InvalidArgumentException( "Class given is not an instance of FileJournal." );
67  }
68  $jrn->backend = $backend;
69 
70  return $jrn;
71  }
72 
78  final public function getTimestampedUUID() {
79  $s = '';
80  for ( $i = 0; $i < 5; $i++ ) {
81  $s .= mt_rand( 0, 2147483647 );
82  }
83  $s = Wikimedia\base_convert( sha1( $s ), 16, 36, 31 );
84 
85  return substr( Wikimedia\base_convert( wfTimestamp( TS_MW ), 10, 36, 9 ) . $s, 0, 31 );
86  }
87 
99  final public function logChangeBatch( array $entries, $batchId ) {
100  if ( $entries === [] ) {
101  return StatusValue::newGood();
102  }
103 
104  return $this->doLogChangeBatch( $entries, $batchId );
105  }
106 
114  abstract protected function doLogChangeBatch( array $entries, $batchId );
115 
121  final public function getCurrentPosition() {
122  return $this->doGetCurrentPosition();
123  }
124 
129  abstract protected function doGetCurrentPosition();
130 
137  final public function getPositionAtTime( $time ) {
138  return $this->doGetPositionAtTime( $time );
139  }
140 
146  abstract protected function doGetPositionAtTime( $time );
147 
165  final public function getChangeEntries( $start = null, $limit = 0, &$next = null ) {
166  $entries = $this->doGetChangeEntries( $start, $limit ? $limit + 1 : 0 );
167  if ( $limit && count( $entries ) > $limit ) {
168  $last = array_pop( $entries ); // remove the extra entry
169  $next = $last['id']; // update for next call
170  } else {
171  $next = null; // end of list
172  }
173 
174  return $entries;
175  }
176 
183  abstract protected function doGetChangeEntries( $start, $limit );
184 
190  final public function purgeOldLogs() {
191  return $this->doPurgeOldLogs();
192  }
193 
198  abstract protected function doPurgeOldLogs();
199 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
string $backend
Definition: FileJournal.php:39
doGetChangeEntries( $start, $limit)
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
getPositionAtTime( $time)
Get the position ID of the latest journal entry at some point in time.
doGetCurrentPosition()
__construct(array $config)
Construct a new instance from configuration.
Definition: FileJournal.php:50
$last
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
getCurrentPosition()
Get the position ID of the latest journal entry.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
logChangeBatch(array $entries, $batchId)
Log changes made by a batch file operation.
Definition: FileJournal.php:99
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getChangeEntries( $start=null, $limit=0, &$next=null)
Get an array of file change log entries.
doLogChangeBatch(array $entries, $batchId)
getTimestampedUUID()
Get a statistically unique ID string.
Definition: FileJournal.php:78
purgeOldLogs()
Purge any old log entries.
doGetPositionAtTime( $time)
static factory(array $config, $backend)
Create an appropriate FileJournal object from config.
Definition: FileJournal.php:62
Class for handling file operation journaling.
Definition: FileJournal.php:37