MediaWiki  REL1_31
BlockListPager.php
Go to the documentation of this file.
1 <?php
27 
28 class BlockListPager extends TablePager {
29 
30  protected $conds;
31  protected $page;
32 
37  function __construct( $page, $conds ) {
38  $this->page = $page;
39  $this->conds = $conds;
40  $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
41  parent::__construct( $page->getContext() );
42  }
43 
44  function getFieldNames() {
45  static $headers = null;
46 
47  if ( $headers === null ) {
48  $headers = [
49  'ipb_timestamp' => 'blocklist-timestamp',
50  'ipb_target' => 'blocklist-target',
51  'ipb_expiry' => 'blocklist-expiry',
52  'ipb_by' => 'blocklist-by',
53  'ipb_params' => 'blocklist-params',
54  'ipb_reason' => 'blocklist-reason',
55  ];
56  foreach ( $headers as $key => $val ) {
57  $headers[$key] = $this->msg( $val )->text();
58  }
59  }
60 
61  return $headers;
62  }
63 
64  function formatValue( $name, $value ) {
65  static $msg = null;
66  if ( $msg === null ) {
67  $keys = [
68  'anononlyblock',
69  'createaccountblock',
70  'noautoblockblock',
71  'emailblock',
72  'blocklist-nousertalk',
73  'unblocklink',
74  'change-blocklink',
75  ];
76 
77  foreach ( $keys as $key ) {
78  $msg[$key] = $this->msg( $key )->text();
79  }
80  }
81 
83  $row = $this->mCurrentRow;
84 
85  $language = $this->getLanguage();
86 
87  $formatted = '';
88 
89  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
90 
91  switch ( $name ) {
92  case 'ipb_timestamp':
93  $formatted = htmlspecialchars( $language->userTimeAndDate( $value, $this->getUser() ) );
94  break;
95 
96  case 'ipb_target':
97  if ( $row->ipb_auto ) {
98  $formatted = $this->msg( 'autoblockid', $row->ipb_id )->parse();
99  } else {
100  list( $target, $type ) = Block::parseTarget( $row->ipb_address );
101  switch ( $type ) {
102  case Block::TYPE_USER:
103  case Block::TYPE_IP:
104  $formatted = Linker::userLink( $target->getId(), $target );
105  $formatted .= Linker::userToolLinks(
106  $target->getId(),
107  $target,
108  false,
110  );
111  break;
112  case Block::TYPE_RANGE:
113  $formatted = htmlspecialchars( $target );
114  }
115  }
116  break;
117 
118  case 'ipb_expiry':
119  $formatted = htmlspecialchars( $language->formatExpiry(
120  $value,
121  /* User preference timezone */true
122  ) );
123  if ( $this->getUser()->isAllowed( 'block' ) ) {
124  if ( $row->ipb_auto ) {
125  $links[] = $linkRenderer->makeKnownLink(
126  SpecialPage::getTitleFor( 'Unblock' ),
127  $msg['unblocklink'],
128  [],
129  [ 'wpTarget' => "#{$row->ipb_id}" ]
130  );
131  } else {
132  $links[] = $linkRenderer->makeKnownLink(
133  SpecialPage::getTitleFor( 'Unblock', $row->ipb_address ),
134  $msg['unblocklink']
135  );
136  $links[] = $linkRenderer->makeKnownLink(
137  SpecialPage::getTitleFor( 'Block', $row->ipb_address ),
138  $msg['change-blocklink']
139  );
140  }
141  $formatted .= ' ' . Html::rawElement(
142  'span',
143  [ 'class' => 'mw-blocklist-actions' ],
144  $this->msg( 'parentheses' )->rawParams(
145  $language->pipeList( $links ) )->escaped()
146  );
147  }
148  if ( $value !== 'infinity' ) {
149  $timestamp = new MWTimestamp( $value );
150  $formatted .= '<br />' . $this->msg(
151  'ipb-blocklist-duration-left',
152  $language->formatDuration(
153  $timestamp->getTimestamp() - time(),
154  // reasonable output
155  [
156  'minutes',
157  'hours',
158  'days',
159  'years',
160  ]
161  )
162  )->escaped();
163  }
164  break;
165 
166  case 'ipb_by':
167  if ( isset( $row->by_user_name ) ) {
168  $formatted = Linker::userLink( $value, $row->by_user_name );
169  $formatted .= Linker::userToolLinks( $value, $row->by_user_name );
170  } else {
171  $formatted = htmlspecialchars( $row->ipb_by_text ); // foreign user?
172  }
173  break;
174 
175  case 'ipb_reason':
176  $value = CommentStore::getStore()->getComment( 'ipb_reason', $row )->text;
177  $formatted = Linker::formatComment( $value );
178  break;
179 
180  case 'ipb_params':
181  $properties = [];
182  if ( $row->ipb_anon_only ) {
183  $properties[] = htmlspecialchars( $msg['anononlyblock'] );
184  }
185  if ( $row->ipb_create_account ) {
186  $properties[] = htmlspecialchars( $msg['createaccountblock'] );
187  }
188  if ( $row->ipb_user && !$row->ipb_enable_autoblock ) {
189  $properties[] = htmlspecialchars( $msg['noautoblockblock'] );
190  }
191 
192  if ( $row->ipb_block_email ) {
193  $properties[] = htmlspecialchars( $msg['emailblock'] );
194  }
195 
196  if ( !$row->ipb_allow_usertalk ) {
197  $properties[] = htmlspecialchars( $msg['blocklist-nousertalk'] );
198  }
199 
200  $formatted = $language->commaList( $properties );
201  break;
202 
203  default:
204  $formatted = "Unable to format $name";
205  break;
206  }
207 
208  return $formatted;
209  }
210 
211  function getQueryInfo() {
212  $commentQuery = CommentStore::getStore()->getJoin( 'ipb_reason' );
213  $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
214 
215  $info = [
216  'tables' => array_merge(
217  [ 'ipblocks' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ]
218  ),
219  'fields' => [
220  'ipb_id',
221  'ipb_address',
222  'ipb_user',
223  'by_user_name' => 'user_name',
224  'ipb_timestamp',
225  'ipb_auto',
226  'ipb_anon_only',
227  'ipb_create_account',
228  'ipb_enable_autoblock',
229  'ipb_expiry',
230  'ipb_range_start',
231  'ipb_range_end',
232  'ipb_deleted',
233  'ipb_block_email',
234  'ipb_allow_usertalk',
235  ] + $commentQuery['fields'] + $actorQuery['fields'],
236  'conds' => $this->conds,
237  'join_conds' => [
238  'user' => [ 'LEFT JOIN', 'user_id = ' . $actorQuery['fields']['ipb_by'] ]
239  ] + $commentQuery['joins'] + $actorQuery['joins']
240  ];
241 
242  # Filter out any expired blocks
243  $db = $this->getDatabase();
244  $info['conds'][] = 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() );
245 
246  # Is the user allowed to see hidden blocks?
247  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
248  $info['conds']['ipb_deleted'] = 0;
249  }
250 
251  return $info;
252  }
253 
259  function getTotalAutoblocks() {
260  $dbr = $this->getDatabase();
261  $res = $dbr->selectField( 'ipblocks',
262  [ 'COUNT(*) AS totalautoblocks' ],
263  [
264  'ipb_auto' => '1',
265  'ipb_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() ),
266  ]
267  );
268  if ( $res ) {
269  return $res;
270  }
271  return 0; // We found nothing
272  }
273 
274  protected function getTableClass() {
275  return parent::getTableClass() . ' mw-blocklist';
276  }
277 
278  function getIndexField() {
279  return 'ipb_timestamp';
280  }
281 
282  function getDefaultSort() {
283  return 'ipb_timestamp';
284  }
285 
286  function isFieldSortable( $name ) {
287  return false;
288  }
289 
295  # Do a link batch query
296  $lb = new LinkBatch;
297  $lb->setCaller( __METHOD__ );
298 
299  foreach ( $result as $row ) {
300  $lb->add( NS_USER, $row->ipb_address );
301  $lb->add( NS_USER_TALK, $row->ipb_address );
302 
303  if ( isset( $row->by_user_name ) ) {
304  $lb->add( NS_USER, $row->by_user_name );
305  $lb->add( NS_USER_TALK, $row->by_user_name );
306  }
307  }
308 
309  $lb->execute();
310  }
311 
312 }
MWTimestamp
Library for creating and parsing MW-style timestamps.
Definition: MWTimestamp.php:32
Linker\TOOL_LINKS_NOBLOCK
const TOOL_LINKS_NOBLOCK
Flags for userToolLinks()
Definition: Linker.php:38
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
BlockListPager\isFieldSortable
isFieldSortable( $name)
Return true if the named field should be sortable by the UI, false otherwise.
Definition: BlockListPager.php:286
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:893
TablePager\$mCurrentRow
$mCurrentRow
Definition: TablePager.php:31
Block\TYPE_IP
const TYPE_IP
Definition: Block.php:84
Block\TYPE_RANGE
const TYPE_RANGE
Definition: Block.php:85
BlockListPager
Definition: BlockListPager.php:28
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
LinkBatch\setCaller
setCaller( $caller)
Use ->setCaller( METHOD ) to indicate which code is using this class.
Definition: LinkBatch.php:61
IndexPager\getDatabase
getDatabase()
Get the Database object in use.
Definition: IndexPager.php:190
BlockListPager\$conds
$conds
Definition: BlockListPager.php:30
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
page
target page
Definition: All_system_messages.txt:1267
$res
$res
Definition: database.txt:21
$linkRenderer
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 after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:2056
$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
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
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
$dbr
$dbr
Definition: testCompression.php:50
ContextSource\getLanguage
getLanguage()
Definition: ContextSource.php:128
Block\parseTarget
static parseTarget( $target)
From an existing Block, get the target and the type of target.
Definition: Block.php:1395
Wikimedia\Rdbms\IResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: IResultWrapper.php:24
BlockListPager\getTableClass
getTableClass()
Definition: BlockListPager.php:274
TablePager
Table-based display with a user-selectable sort order.
Definition: TablePager.php:28
BlockListPager\__construct
__construct( $page, $conds)
Definition: BlockListPager.php:37
BlockListPager\getFieldNames
getFieldNames()
An array mapping database field names to a textual description of the field name, for use in the tabl...
Definition: BlockListPager.php:44
BlockListPager\getDefaultSort
getDefaultSort()
The database field name used as a default sort order.
Definition: BlockListPager.php:282
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
BlockListPager\getIndexField
getIndexField()
Definition: BlockListPager.php:278
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:77
$value
$value
Definition: styleTest.css.php:45
Linker\userToolLinks
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:931
BlockListPager\$page
$page
Definition: BlockListPager.php:31
BlockListPager\getQueryInfo
getQueryInfo()
This function should be overridden to provide all parameters needed for the main paged query.
Definition: BlockListPager.php:211
BlockListPager\getTotalAutoblocks
getTotalAutoblocks()
Get total number of autoblocks at any given time.
Definition: BlockListPager.php:259
Linker\formatComment
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1109
Block\TYPE_USER
const TYPE_USER
Definition: Block.php:83
IndexPager\DIR_DESCENDING
const DIR_DESCENDING
Definition: IndexPager.php:76
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
BlockListPager\preprocessResults
preprocessResults( $result)
Do a LinkBatch query to minimise database load when generating all these links.
Definition: BlockListPager.php:294
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
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
$keys
$keys
Definition: testCompression.php:67
NS_USER
const NS_USER
Definition: Defines.php:76
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:25
CommentStore\getStore
static getStore()
Definition: CommentStore.php:130
BlockListPager\formatValue
formatValue( $name, $value)
Format a table cell.
Definition: BlockListPager.php:64
$type
$type
Definition: testCompression.php:48