MediaWiki  REL1_31
RightsLogFormatter.php
Go to the documentation of this file.
1 <?php
32  protected function makePageLink( Title $title = null, $parameters = [], $html = null ) {
34 
35  if ( !$this->plaintext ) {
36  $text = $wgContLang->ucfirst( $title->getDBkey() );
37  $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );
38 
39  if ( count( $parts ) === 2 ) {
40  $titleLink = WikiMap::foreignUserLink(
41  $parts[1],
42  $parts[0],
43  htmlspecialchars(
44  strtr( $parts[0], '_', ' ' ) .
46  $parts[1]
47  )
48  );
49 
50  if ( $titleLink !== false ) {
51  return $titleLink;
52  }
53  }
54  }
55 
56  return parent::makePageLink( $title, $parameters, $title ? $title->getText() : null );
57  }
58 
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
64  $key .= '-legacy';
65  }
66 
67  return $key;
68  }
69 
70  protected function getMessageParameters() {
71  $params = parent::getMessageParameters();
72 
73  // Really old entries that lack old/new groups
74  if ( !isset( $params[3] ) && !isset( $params[4] ) ) {
75  return $params;
76  }
77 
78  $oldGroups = $this->makeGroupArray( $params[3] );
79  $newGroups = $this->makeGroupArray( $params[4] );
80 
81  $userName = $this->entry->getTarget()->getText();
82  if ( !$this->plaintext && count( $oldGroups ) ) {
83  foreach ( $oldGroups as &$group ) {
84  $group = UserGroupMembership::getGroupMemberName( $group, $userName );
85  }
86  }
87  if ( !$this->plaintext && count( $newGroups ) ) {
88  foreach ( $newGroups as &$group ) {
89  $group = UserGroupMembership::getGroupMemberName( $group, $userName );
90  }
91  }
92 
93  // fetch the metadata about each group membership
94  $allParams = $this->entry->getParameters();
95 
96  if ( count( $oldGroups ) ) {
97  $params[3] = [ 'raw' => $this->formatRightsList( $oldGroups,
98  isset( $allParams['oldmetadata'] ) ? $allParams['oldmetadata'] : [] ) ];
99  } else {
100  $params[3] = $this->msg( 'rightsnone' )->text();
101  }
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'] : [] ) ];
107  } else {
108  $params[4] = $this->msg( 'rightsnone' )->text();
109  }
110 
111  $params[5] = $userName;
112 
113  return $params;
114  }
115 
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 = [];
121 
122  reset( $groups );
123  reset( $serializedUGMs );
124  while ( current( $groups ) ) {
125  $group = current( $groups );
126 
127  if ( current( $serializedUGMs ) &&
128  isset( current( $serializedUGMs )['expiry'] ) &&
129  current( $serializedUGMs )['expiry']
130  ) {
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();
138  } else {
139  // the right does not expire; just insert the group name
140  $permList[] = $group;
141  }
142 
143  next( $groups );
144  next( $serializedUGMs );
145  }
146 
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 ) );
150  }
151 
152  protected function getParametersForApi() {
155 
156  static $map = [
157  '4:array:oldgroups',
158  '5:array:newgroups',
159  '4::oldgroups' => '4:array:oldgroups',
160  '5::newgroups' => '5:array:newgroups',
161  ];
162  foreach ( $map as $index => $key ) {
163  if ( isset( $params[$index] ) ) {
164  $params[$key] = $params[$index];
165  unset( $params[$index] );
166  }
167  }
168 
169  // Really old entries do not have log params, so form them from whatever info
170  // we have.
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'] );
175 
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];
183  }
184  $result['expiry'] = ApiResult::formatExpiry( isset( $result['expiry'] ) ?
185  $result['expiry'] : null );
186 
187  return $result;
188  }, array_keys( $params['4:array:oldgroups'] ) );
189  }
190 
191  if ( isset( $params['5:array:newgroups'] ) ) {
192  $params['5:array:newgroups'] = $this->makeGroupArray( $params['5:array:newgroups'] );
193 
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];
201  }
202  $result['expiry'] = ApiResult::formatExpiry( isset( $result['expiry'] ) ?
203  $result['expiry'] : null );
204 
205  return $result;
206  }, array_keys( $params['5:array:newgroups'] ) );
207  }
208 
209  return $params;
210  }
211 
212  public function formatParametersForApi() {
213  $ret = parent::formatParametersForApi();
214  if ( isset( $ret['oldgroups'] ) ) {
215  ApiResult::setIndexedTagName( $ret['oldgroups'], 'g' );
216  }
217  if ( isset( $ret['newgroups'] ) ) {
218  ApiResult::setIndexedTagName( $ret['newgroups'], 'g' );
219  }
220  if ( isset( $ret['oldmetadata'] ) ) {
221  ApiResult::setArrayType( $ret['oldmetadata'], 'array' );
222  ApiResult::setIndexedTagName( $ret['oldmetadata'], 'g' );
223  }
224  if ( isset( $ret['newmetadata'] ) ) {
225  ApiResult::setArrayType( $ret['newmetadata'], 'array' );
226  ApiResult::setIndexedTagName( $ret['newmetadata'], 'g' );
227  }
228  return $ret;
229  }
230 
231  private function makeGroupArray( $group ) {
232  // Migrate old group params from string to array
233  if ( $group === '' ) {
234  $group = [];
235  } elseif ( is_string( $group ) ) {
236  $group = array_map( 'trim', explode( ',', $group ) );
237  }
238  return $group;
239  }
240 }
WikiMap\foreignUserLink
static foreignUserLink( $wikiID, $user, $text=null)
Convenience to get a link to a user page on a foreign wiki.
Definition: WikiMap.php:137
RightsLogFormatter\makeGroupArray
makeGroupArray( $group)
Definition: RightsLogFormatter.php:231
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$html
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:2013
LogEntry\getParameters
getParameters()
Get the extra parameters stored for this message.
LogFormatter\$entry
LogEntryBase $entry
Definition: LogFormatter.php:83
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:2005
RightsLogFormatter\getParametersForApi
getParametersForApi()
Get the array of parameters, converted from legacy format if necessary.
Definition: RightsLogFormatter.php:152
$params
$params
Definition: styleTest.css.php:40
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
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:37
LogFormatter\msg
msg( $key)
Shortcut for wfMessage which honors local context.
Definition: LogFormatter.php:735
RightsLogFormatter
This class formats rights log entries.
Definition: RightsLogFormatter.php:31
ApiResult\setArrayType
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
$wgUserrightsInterwikiDelimiter
$wgUserrightsInterwikiDelimiter
Character used as a delimiter when testing for interwiki userrights (In Special:UserRights,...
Definition: DefaultSettings.php:4941
RightsLogFormatter\formatParametersForApi
formatParametersForApi()
Format parameters for API output.
Definition: RightsLogFormatter.php:212
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
RightsLogFormatter\getMessageKey
getMessageKey()
Returns a key to be used for formatting the action sentence.
Definition: RightsLogFormatter.php:59
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
RightsLogFormatter\getMessageParameters
getMessageParameters()
Formats parameters intented for action message from array of all parameters.
Definition: RightsLogFormatter.php:70
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
RightsLogFormatter\formatRightsList
formatRightsList( $groups, $serializedUGMs=[])
Definition: RightsLogFormatter.php:116
LogFormatter
Implements the default log formatting.
Definition: LogFormatter.php:38
Title
Represents a title within MediaWiki.
Definition: Title.php:39
RightsLogFormatter\makePageLink
makePageLink(Title $title=null, $parameters=[], $html=null)
Helper to make a link to the page, taking the plaintext value in consideration.
Definition: RightsLogFormatter.php:32
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:22
ApiResult\formatExpiry
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
Definition: ApiResult.php:1207
UserGroupMembership\getGroupMemberName
static getGroupMemberName( $group, $username)
Gets the localized name for a member of a group, if it exists.
Definition: UserGroupMembership.php:455
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57