MediaWiki  1.29.1
DBFileJournal.php
Go to the documentation of this file.
1 <?php
28 
33 class DBFileJournal extends FileJournal {
35  protected $dbw;
36 
37  protected $wiki = false; // string; wiki DB name
38 
45  protected function __construct( array $config ) {
46  parent::__construct( $config );
47 
48  $this->wiki = $config['wiki'];
49  }
50 
57  protected function doLogChangeBatch( array $entries, $batchId ) {
59 
60  try {
61  $dbw = $this->getMasterDB();
62  } catch ( DBError $e ) {
63  $status->fatal( 'filejournal-fail-dbconnect', $this->backend );
64 
65  return $status;
66  }
67 
68  $now = wfTimestamp( TS_UNIX );
69 
70  $data = [];
71  foreach ( $entries as $entry ) {
72  $data[] = [
73  'fj_batch_uuid' => $batchId,
74  'fj_backend' => $this->backend,
75  'fj_op' => $entry['op'],
76  'fj_path' => $entry['path'],
77  'fj_new_sha1' => $entry['newSha1'],
78  'fj_timestamp' => $dbw->timestamp( $now )
79  ];
80  }
81 
82  try {
83  $dbw->insert( 'filejournal', $data, __METHOD__ );
84  if ( mt_rand( 0, 99 ) == 0 ) {
85  $this->purgeOldLogs(); // occasionally delete old logs
86  }
87  } catch ( DBError $e ) {
88  $status->fatal( 'filejournal-fail-dbquery', $this->backend );
89 
90  return $status;
91  }
92 
93  return $status;
94  }
95 
100  protected function doGetCurrentPosition() {
101  $dbw = $this->getMasterDB();
102 
103  return $dbw->selectField( 'filejournal', 'MAX(fj_id)',
104  [ 'fj_backend' => $this->backend ],
105  __METHOD__
106  );
107  }
108 
114  protected function doGetPositionAtTime( $time ) {
115  $dbw = $this->getMasterDB();
116 
117  $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $time ) );
118 
119  return $dbw->selectField( 'filejournal', 'fj_id',
120  [ 'fj_backend' => $this->backend, "fj_timestamp <= $encTimestamp" ],
121  __METHOD__,
122  [ 'ORDER BY' => 'fj_timestamp DESC' ]
123  );
124  }
125 
132  protected function doGetChangeEntries( $start, $limit ) {
133  $dbw = $this->getMasterDB();
134 
135  $res = $dbw->select( 'filejournal', '*',
136  [
137  'fj_backend' => $this->backend,
138  'fj_id >= ' . $dbw->addQuotes( (int)$start ) ], // $start may be 0
139  __METHOD__,
140  array_merge( [ 'ORDER BY' => 'fj_id ASC' ],
141  $limit ? [ 'LIMIT' => $limit ] : [] )
142  );
143 
144  $entries = [];
145  foreach ( $res as $row ) {
146  $item = [];
147  foreach ( (array)$row as $key => $value ) {
148  $item[substr( $key, 3 )] = $value; // "fj_op" => "op"
149  }
150  $entries[] = $item;
151  }
152 
153  return $entries;
154  }
155 
161  protected function doPurgeOldLogs() {
163  if ( $this->ttlDays <= 0 ) {
164  return $status; // nothing to do
165  }
166 
167  $dbw = $this->getMasterDB();
168  $dbCutoff = $dbw->timestamp( time() - 86400 * $this->ttlDays );
169 
170  $dbw->delete( 'filejournal',
171  [ 'fj_timestamp < ' . $dbw->addQuotes( $dbCutoff ) ],
172  __METHOD__
173  );
174 
175  return $status;
176  }
177 
184  protected function getMasterDB() {
185  if ( !$this->dbw ) {
186  // Get a separate connection in autocommit mode
187  $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->newMainLB();
188  $this->dbw = $lb->getConnection( DB_MASTER, [], $this->wiki );
189  $this->dbw->clearFlag( DBO_TRX );
190  }
191 
192  return $this->dbw;
193  }
194 }
DBFileJournal\doPurgeOldLogs
doPurgeOldLogs()
Definition: DBFileJournal.php:161
DBFileJournal
Version of FileJournal that logs to a DB table.
Definition: DBFileJournal.php:33
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1994
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:1
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
FileJournal\$backend
string $backend
Definition: FileJournal.php:40
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
DBFileJournal\doLogChangeBatch
doLogChangeBatch(array $entries, $batchId)
Definition: DBFileJournal.php:57
$res
$res
Definition: database.txt:21
DBFileJournal\getMasterDB
getMasterDB()
Get a master connection to the logging DB.
Definition: DBFileJournal.php:184
Wikimedia\Rdbms\DBError
Database error base class.
Definition: DBError.php:30
Wikimedia\Rdbms\IDatabase\insert
insert( $table, $a, $fname=__METHOD__, $options=[])
INSERT wrapper, inserts an array into a table.
DBO_TRX
const DBO_TRX
Definition: defines.php:12
php
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
DBFileJournal\__construct
__construct(array $config)
Construct a new instance from configuration.
Definition: DBFileJournal.php:45
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
Wikimedia\Rdbms\IDatabase\timestamp
timestamp( $ts=0)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
FileJournal
Class for handling file operation journaling.
Definition: FileJournal.php:38
$limit
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1049
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1769
DBFileJournal\$dbw
IDatabase $dbw
Definition: DBFileJournal.php:35
DB_MASTER
const DB_MASTER
Definition: defines.php:26
DBFileJournal\$wiki
$wiki
Definition: DBFileJournal.php:37
DBFileJournal\doGetChangeEntries
doGetChangeEntries( $start, $limit)
Definition: DBFileJournal.php:132
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
$value
$value
Definition: styleTest.css.php:45
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
FileJournal\purgeOldLogs
purgeOldLogs()
Purge any old log entries.
Definition: FileJournal.php:191
Wikimedia\Rdbms\IDatabase\selectField
selectField( $table, $var, $cond='', $fname=__METHOD__, $options=[])
A SELECT wrapper which returns a single field from a single result row.
DBFileJournal\doGetPositionAtTime
doGetPositionAtTime( $time)
Definition: DBFileJournal.php:114
Wikimedia\Rdbms\IDatabase\addQuotes
addQuotes( $s)
Adds quotes and backslashes.
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
DBFileJournal\doGetCurrentPosition
doGetCurrentPosition()
Definition: DBFileJournal.php:100
Wikimedia\Rdbms\IDatabase\select
select( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Execute a SELECT query constructed using the various parameters provided.
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:23
Wikimedia\Rdbms\IDatabase\delete
delete( $table, $conds, $fname=__METHOD__)
DELETE query wrapper.
array
the array() calling protocol came about after MediaWiki 1.4rc1.