3 * Formatter for user rights log entries.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Alexandre Emsenhuber
22 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
27 * This class formats rights log entries.
31 class RightsLogFormatter
extends LogFormatter
{
32 protected function makePageLink( Title
$title = null, $parameters = [], $html = null ) {
33 global $wgContLang, $wgUserrightsInterwikiDelimiter;
35 if ( !$this->plaintext
) {
36 $text = $wgContLang->ucfirst( $title->getDBkey() );
37 $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );
39 if ( count( $parts ) === 2 ) {
40 $titleLink = WikiMap
::foreignUserLink(
44 strtr( $parts[0], '_', ' ' ) .
45 $wgUserrightsInterwikiDelimiter .
50 if ( $titleLink !== false ) {
56 return parent
::makePageLink( $title, $parameters, $title ?
$title->getText() : null );
59 protected function getMessageKey() {
60 $key = parent
::getMessageKey();
61 $params = $this->getMessageParameters();
62 if ( !isset( $params[3] ) && !isset( $params[4] ) ) {
63 // Messages: logentry-rights-rights-legacy
70 protected function getMessageParameters() {
71 $params = parent
::getMessageParameters();
73 // Really old entries that lack old/new groups
74 if ( !isset( $params[3] ) && !isset( $params[4] ) ) {
78 $oldGroups = $this->makeGroupArray( $params[3] );
79 $newGroups = $this->makeGroupArray( $params[4] );
81 $userName = $this->entry
->getTarget()->getText();
82 if ( !$this->plaintext
&& count( $oldGroups ) ) {
83 foreach ( $oldGroups as &$group ) {
84 $group = UserGroupMembership
::getGroupMemberName( $group, $userName );
87 if ( !$this->plaintext
&& count( $newGroups ) ) {
88 foreach ( $newGroups as &$group ) {
89 $group = UserGroupMembership
::getGroupMemberName( $group, $userName );
93 // fetch the metadata about each group membership
94 $allParams = $this->entry
->getParameters();
96 if ( count( $oldGroups ) ) {
97 $params[3] = [ 'raw' => $this->formatRightsList( $oldGroups,
98 isset( $allParams['oldmetadata'] ) ?
$allParams['oldmetadata'] : [] ) ];
100 $params[3] = $this->msg( 'rightsnone' )->text();
102 if ( count( $newGroups ) ) {
103 // Array_values is used here because of T44211
104 // see use of array_unique in UserrightsPage::doSaveUserGroups on $newGroups.
105 $params[4] = [ 'raw' => $this->formatRightsList( array_values( $newGroups ),
106 isset( $allParams['newmetadata'] ) ?
$allParams['newmetadata'] : [] ) ];
108 $params[4] = $this->msg( 'rightsnone' )->text();
111 $params[5] = $userName;
116 protected function formatRightsList( $groups, $serializedUGMs = [] ) {
117 $uiLanguage = $this->context
->getLanguage();
118 $uiUser = $this->context
->getUser();
119 // separate arrays of temporary and permanent memberships
120 $tempList = $permList = [];
123 reset( $serializedUGMs );
124 while ( current( $groups ) ) {
125 $group = current( $groups );
127 if ( current( $serializedUGMs ) &&
128 isset( current( $serializedUGMs )['expiry'] ) &&
129 current( $serializedUGMs )['expiry']
131 // there is an expiry date; format the group and expiry into a friendly string
132 $expiry = current( $serializedUGMs )['expiry'];
133 $expiryFormatted = $uiLanguage->userTimeAndDate( $expiry, $uiUser );
134 $expiryFormattedD = $uiLanguage->userDate( $expiry, $uiUser );
135 $expiryFormattedT = $uiLanguage->userTime( $expiry, $uiUser );
136 $tempList[] = $this->msg( 'rightslogentry-temporary-group' )->params( $group,
137 $expiryFormatted, $expiryFormattedD, $expiryFormattedT )->parse();
139 // the right does not expire; just insert the group name
140 $permList[] = $group;
144 next( $serializedUGMs );
147 // place all temporary memberships first, to avoid the ambiguity of
148 // "adinistrator, bureaucrat and importer (temporary, until X time)"
149 return $uiLanguage->listToText( array_merge( $tempList, $permList ) );
152 protected function getParametersForApi() {
153 $entry = $this->entry
;
154 $params = $entry->getParameters();
159 '4::oldgroups' => '4:array:oldgroups',
160 '5::newgroups' => '5:array:newgroups',
162 foreach ( $map as $index => $key ) {
163 if ( isset( $params[$index] ) ) {
164 $params[$key] = $params[$index];
165 unset( $params[$index] );
169 // Really old entries do not have log params, so form them from whatever info
171 // Also walk through the parallel arrays of groups and metadata, combining each
172 // metadata array with the name of the group it pertains to
173 if ( isset( $params['4:array:oldgroups'] ) ) {
174 $params['4:array:oldgroups'] = $this->makeGroupArray( $params['4:array:oldgroups'] );
176 $oldmetadata =& $params['oldmetadata'];
177 // unset old metadata entry to ensure metadata goes at the end of the params array
178 unset( $params['oldmetadata'] );
179 $params['oldmetadata'] = array_map( function( $index ) use ( $params, $oldmetadata ) {
180 $result = [ 'group' => $params['4:array:oldgroups'][$index] ];
181 if ( isset( $oldmetadata[$index] ) ) {
182 $result +
= $oldmetadata[$index];
184 $result['expiry'] = ApiResult
::formatExpiry( isset( $result['expiry'] ) ?
185 $result['expiry'] : null );
188 }, array_keys( $params['4:array:oldgroups'] ) );
191 if ( isset( $params['5:array:newgroups'] ) ) {
192 $params['5:array:newgroups'] = $this->makeGroupArray( $params['5:array:newgroups'] );
194 $newmetadata =& $params['newmetadata'];
195 // unset old metadata entry to ensure metadata goes at the end of the params array
196 unset( $params['newmetadata'] );
197 $params['newmetadata'] = array_map( function( $index ) use ( $params, $newmetadata ) {
198 $result = [ 'group' => $params['5:array:newgroups'][$index] ];
199 if ( isset( $newmetadata[$index] ) ) {
200 $result +
= $newmetadata[$index];
202 $result['expiry'] = ApiResult
::formatExpiry( isset( $result['expiry'] ) ?
203 $result['expiry'] : null );
206 }, array_keys( $params['5:array:newgroups'] ) );
212 public function formatParametersForApi() {
213 $ret = parent
::formatParametersForApi();
214 if ( isset( $ret['oldgroups'] ) ) {
215 ApiResult
::setIndexedTagName( $ret['oldgroups'], 'g' );
217 if ( isset( $ret['newgroups'] ) ) {
218 ApiResult
::setIndexedTagName( $ret['newgroups'], 'g' );
220 if ( isset( $ret['oldmetadata'] ) ) {
221 ApiResult
::setArrayType( $ret['oldmetadata'], 'array' );
222 ApiResult
::setIndexedTagName( $ret['oldmetadata'], 'g' );
224 if ( isset( $ret['newmetadata'] ) ) {
225 ApiResult
::setArrayType( $ret['newmetadata'], 'array' );
226 ApiResult
::setIndexedTagName( $ret['newmetadata'], 'g' );
231 private function makeGroupArray( $group ) {
232 // Migrate old group params from string to array
233 if ( $group === '' ) {
235 } elseif ( is_string( $group ) ) {
236 $group = array_map( 'trim', explode( ',', $group ) );