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
|
<?php
/**
* Contains a class for formatting log legacy entries
*
* 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
* @author Niklas Laxström
* @license GPL-2.0-or-later
* @since 1.19
*/
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
/**
* This class formats all log entries for log types
* which have not been converted to the new system.
* This is not about old log entries which store
* parameters in a different format - the new
* LogFormatter classes have code to support formatting
* those too.
* @since 1.19
*/
class LegacyLogFormatter extends LogFormatter {
/**
* Backward compatibility for extension changing the comment from
* the LogLine hook. This will be set by the first call on getComment(),
* then it might be modified by the hook when calling getActionLinks(),
* so that the modified value will be returned when calling getComment()
* a second time.
*
* @var string|null
*/
private $comment = null;
/**
* Cache for the result of getActionLinks() so that it does not need to
* run multiple times depending on the order that getComment() and
* getActionLinks() are called.
*
* @var string|null
*/
private $revert = null;
private HookRunner $hookRunner;
public function __construct(
LogEntry $entry,
HookContainer $hookContainer
) {
parent::__construct( $entry );
$this->hookRunner = new HookRunner( $hookContainer );
}
public function getComment() {
$this->comment ??= parent::getComment();
// Make sure we execute the LogLine hook so that we immediately return
// the correct value.
if ( $this->revert === null ) {
$this->getActionLinks();
}
return $this->comment;
}
/**
* @return string
* @return-taint onlysafefor_html
*/
protected function getActionMessage() {
$entry = $this->entry;
$action = LogPage::actionText(
$entry->getType(),
$entry->getSubtype(),
$entry->getTarget(),
$this->plaintext ? null : $this->context->getSkin(),
(array)$entry->getParameters(),
!$this->plaintext // whether to filter [[]] links
);
$performer = $this->getPerformerElement();
if ( !$this->irctext ) {
$sep = $this->msg( 'word-separator' );
$sep = $this->plaintext ? $sep->text() : $sep->escaped();
$action = $performer . $sep . $action;
}
return $action;
}
public function getActionLinks() {
if ( $this->revert !== null ) {
return $this->revert;
}
if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
$this->revert = '';
return $this->revert;
}
$title = $this->entry->getTarget();
$type = $this->entry->getType();
$subtype = $this->entry->getSubtype();
// Do nothing. The implementation is handled by the hook modifying the
// passed-by-ref parameters. This also changes the default value so that
// getComment() and getActionLinks() do not call them indefinitely.
$this->revert = '';
// This is to populate the $comment member of this instance so that it
// can be modified when calling the hook just below.
if ( $this->comment === null ) {
$this->getComment();
}
$params = $this->entry->getParameters();
$this->hookRunner->onLogLine(
$type, $subtype, $title, $params, $this->comment, $this->revert, $this->entry->getTimestamp() );
return $this->revert;
}
}
|
