1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
<?php
/**
* Version of FileJournal that logs to a DB table.
*
* 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 FileJournal
*/
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\DBError;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* Version of FileJournal that logs to a DB table
* @since 1.20
*/
class DBFileJournal extends FileJournal {
/** @var IDatabase */
protected $dbw;
/** @var string */
protected $domain;
/**
* Construct a new instance from configuration.
*
* @param array $config Includes:
* - domain: database domain ID of the wiki
*/
public function __construct( array $config ) {
parent::__construct( $config );
$this->domain = $config['domain'] ?? $config['wiki']; // b/c
}
/**
* @see FileJournal::logChangeBatch()
* @param array[] $entries
* @param string $batchId
* @return StatusValue
*/
protected function doLogChangeBatch( array $entries, $batchId ) {
$status = StatusValue::newGood();
try {
$dbw = $this->getMasterDB();
} catch ( DBError $e ) {
$status->fatal( 'filejournal-fail-dbconnect', $this->backend );
return $status;
}
$now = ConvertibleTimestamp::time();
$data = [];
foreach ( $entries as $entry ) {
$data[] = [
'fj_batch_uuid' => $batchId,
'fj_backend' => $this->backend,
'fj_op' => $entry['op'],
'fj_path' => $entry['path'],
'fj_new_sha1' => $entry['newSha1'],
'fj_timestamp' => $dbw->timestamp( $now )
];
}
try {
$dbw->insert( 'filejournal', $data, __METHOD__ );
// XXX Should we do this deterministically so it's testable? Maybe look at the last two
// digits of a hash of a bunch of the data?
if ( mt_rand( 0, 99 ) == 0 ) {
// occasionally delete old logs
$this->purgeOldLogs(); // @codeCoverageIgnore
}
} catch ( DBError $e ) {
$status->fatal( 'filejournal-fail-dbquery', $this->backend );
return $status;
}
return $status;
}
/**
* @see FileJournal::doGetCurrentPosition()
* @return bool|mixed The value from the field, or false on failure.
*/
protected function doGetCurrentPosition() {
$dbw = $this->getMasterDB();
return $dbw->selectField( 'filejournal', 'MAX(fj_id)',
[ 'fj_backend' => $this->backend ],
__METHOD__
);
}
/**
* @see FileJournal::doGetPositionAtTime()
* @param int|string $time Timestamp
* @return bool|mixed The value from the field, or false on failure.
*/
protected function doGetPositionAtTime( $time ) {
$dbw = $this->getMasterDB();
$encTimestamp = $dbw->addQuotes( $dbw->timestamp( $time ) );
return $dbw->selectField( 'filejournal', 'fj_id',
[ 'fj_backend' => $this->backend, "fj_timestamp <= $encTimestamp" ],
__METHOD__,
[ 'ORDER BY' => 'fj_timestamp DESC' ]
);
}
/**
* @see FileJournal::doGetChangeEntries()
* @param int|null $start
* @param int $limit
* @return array[]
*/
protected function doGetChangeEntries( $start, $limit ) {
$dbw = $this->getMasterDB();
$res = $dbw->select( 'filejournal', '*',
[
'fj_backend' => $this->backend,
'fj_id >= ' . $dbw->addQuotes( (int)$start ) ], // $start may be 0
__METHOD__,
array_merge( [ 'ORDER BY' => 'fj_id ASC' ],
$limit ? [ 'LIMIT' => $limit ] : [] )
);
$entries = [];
foreach ( $res as $row ) {
$item = [];
foreach ( (array)$row as $key => $value ) {
$item[substr( $key, 3 )] = $value; // "fj_op" => "op"
}
$entries[] = $item;
}
return $entries;
}
/**
* @see FileJournal::purgeOldLogs()
* @return StatusValue
* @throws DBError
*/
protected function doPurgeOldLogs() {
$status = StatusValue::newGood();
if ( $this->ttlDays <= 0 ) {
return $status; // nothing to do
}
$dbw = $this->getMasterDB();
$dbCutoff = $dbw->timestamp( ConvertibleTimestamp::time() - 86400 * $this->ttlDays );
$dbw->delete( 'filejournal',
[ 'fj_timestamp < ' . $dbw->addQuotes( $dbCutoff ) ],
__METHOD__
);
return $status;
}
/**
* Get a master connection to the logging DB
*
* @return IDatabase
* @throws DBError
*/
protected function getMasterDB() {
if ( !$this->dbw ) {
// Get a separate connection in autocommit mode
$lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->newMainLB();
$this->dbw = $lb->getConnection( DB_MASTER, [], $this->domain );
$this->dbw->clearFlag( DBO_TRX );
}
return $this->dbw;
}
}
|
