3 * Displays information about a page.
5 * Copyright © 2011 Alexandre Emsenhuber
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 class InfoAction
extends FormlessAction
{
27 * Returns the name of the action this object responds to.
29 * @return string lowercase
31 public function getName() {
36 * Whether this action can still be executed by a blocked user.
40 public function requiresUnblock() {
45 * Whether this action requires the wiki not to be locked.
49 public function requiresWrite() {
54 * Shows page information on GET request.
56 * @return string Page information that will be added to the output
58 public function onView() {
62 $oldid = $this->page
->getOldID();
64 $revision = $this->page
->getRevisionFetched();
66 // Revision is missing
67 if ( $revision === null ) {
68 return $this->msg( 'missing-revision', $oldid )->parse();
71 // Revision is not current
72 if ( !$revision->isCurrent() ) {
73 return $this->msg( 'pageinfo-not-current' )->plain();
78 if ( !$this->msg( 'pageinfo-header' )->isDisabled() ) {
79 $content .= $this->msg( 'pageinfo-header' )->parse();
82 // Hide "This page is a member of # hidden categories" explanation
83 $content .= Html
::element( 'style', array(),
84 '.mw-hiddenCategoriesExplanation { display: none; }' );
86 // Hide "Templates used on this page" explanation
87 $content .= Html
::element( 'style', array(),
88 '.mw-templatesUsedExplanation { display: none; }' );
90 // Get page information
91 $pageInfo = $this->pageInfo();
93 // Allow extensions to add additional information
94 wfRunHooks( 'InfoAction', array( $this->getContext(), &$pageInfo ) );
96 // Render page information
97 foreach ( $pageInfo as $header => $infoTable ) {
98 $content .= $this->makeHeader( $this->msg( "pageinfo-${header}" )->escaped() );
100 foreach ( $infoTable as $infoRow ) {
101 $name = ( $infoRow[0] instanceof Message
) ?
$infoRow[0]->escaped() : $infoRow[0];
102 $value = ( $infoRow[1] instanceof Message
) ?
$infoRow[1]->escaped() : $infoRow[1];
103 $table = $this->addRow( $table, $name, $value );
105 $content = $this->addTable( $content, $table );
109 if ( !$this->msg( 'pageinfo-footer' )->isDisabled() ) {
110 $content .= $this->msg( 'pageinfo-footer' )->parse();
114 /*if ( $this->page->exists() ) {
115 $content .= Html::rawElement( 'div', array( 'id' => 'mw-credits' ), $this->getContributors() );
122 * Creates a header that can be added to the output.
124 * @param $header The header text.
125 * @return string The HTML.
127 protected function makeHeader( $header ) {
129 $spanAttribs = array( 'class' => 'mw-headline', 'id' => $wgParser->guessSectionNameFromWikiText( $header ) );
130 return Html
::rawElement( 'h2', array(), Html
::element( 'span', $spanAttribs, $header ) );
134 * Adds a row to a table that will be added to the content.
136 * @param $table string The table that will be added to the content
137 * @param $name string The name of the row
138 * @param $value string The value of the row
139 * @return string The table with the row added
141 protected function addRow( $table, $name, $value ) {
142 return $table . Html
::rawElement( 'tr', array(),
143 Html
::rawElement( 'td', array( 'style' => 'vertical-align: top;' ), $name ) .
144 Html
::rawElement( 'td', array(), $value )
149 * Adds a table to the content that will be added to the output.
151 * @param $content string The content that will be added to the output
152 * @param $table string The table
153 * @return string The content with the table added
155 protected function addTable( $content, $table ) {
156 return $content . Html
::rawElement( 'table', array( 'class' => 'wikitable mw-page-info' ),
161 * Returns page information in an easily-manipulated format. Array keys are used so extensions
162 * may add additional information in arbitrary positions. Array values are arrays with one
163 * element to be rendered as a header, arrays with two elements to be rendered as a table row.
167 protected function pageInfo() {
168 global $wgContLang, $wgRCMaxAge;
170 $user = $this->getUser();
171 $lang = $this->getLanguage();
172 $title = $this->getTitle();
173 $id = $title->getArticleID();
175 // Get page information that would be too "expensive" to retrieve by normal means
176 $pageCounts = self
::pageCounts( $title, $user );
178 // Get page properties
179 $dbr = wfGetDB( DB_SLAVE
);
180 $result = $dbr->select(
182 array( 'pp_propname', 'pp_value' ),
183 array( 'pp_page' => $id ),
187 $pageProperties = array();
188 foreach ( $result as $row ) {
189 $pageProperties[$row->pp_propname
] = $row->pp_value
;
194 $pageInfo['header-basic'] = array();
197 $displayTitle = $title->getPrefixedText();
198 if ( !empty( $pageProperties['displaytitle'] ) ) {
199 $displayTitle = $pageProperties['displaytitle'];
202 $pageInfo['header-basic'][] = array(
203 $this->msg( 'pageinfo-display-title' ), $displayTitle
206 // Is it a redirect? If so, where to?
207 if ( $title->isRedirect() ) {
208 $pageInfo['header-basic'][] = array(
209 $this->msg( 'pageinfo-redirectsto' ),
210 Linker
::link( $this->page
->getRedirectTarget() ) . ' ' .
211 $this->msg( 'parentheses', Linker
::link(
212 $this->page
->getRedirectTarget(),
213 $this->msg( 'pageinfo-redirectsto-info' ),
215 array( 'action' => 'info' )
221 $sortKey = $title->getCategorySortKey();
222 if ( !empty( $pageProperties['defaultsort'] ) ) {
223 $sortKey = $pageProperties['defaultsort'];
226 $pageInfo['header-basic'][] = array( $this->msg( 'pageinfo-default-sort' ), $sortKey );
228 // Page length (in bytes)
229 $pageInfo['header-basic'][] = array(
230 $this->msg( 'pageinfo-length' ), $lang->formatNum( $title->getLength() )
233 // Page ID (number not localised, as it's a database ID)
234 $pageInfo['header-basic'][] = array( $this->msg( 'pageinfo-article-id' ), $id );
236 // Search engine status
237 $pOutput = new ParserOutput();
238 if ( isset( $pageProperties['noindex'] ) ) {
239 $pOutput->setIndexPolicy( 'noindex' );
242 // Use robot policy logic
243 $policy = $this->page
->getRobotPolicy( 'view', $pOutput );
244 $pageInfo['header-basic'][] = array(
245 $this->msg( 'pageinfo-robot-policy' ), $this->msg( "pageinfo-robot-${policy['index']}" )
248 if ( isset( $pageCounts['views'] ) ) {
250 $pageInfo['header-basic'][] = array(
251 $this->msg( 'pageinfo-views' ), $lang->formatNum( $pageCounts['views'] )
255 if ( isset( $pageCounts['watchers'] ) ) {
256 // Number of page watchers
257 $pageInfo['header-basic'][] = array(
258 $this->msg( 'pageinfo-watchers' ), $lang->formatNum( $pageCounts['watchers'] )
262 // Redirects to this page
263 $whatLinksHere = SpecialPage
::getTitleFor( 'Whatlinkshere', $title->getPrefixedText() );
264 $pageInfo['header-basic'][] = array(
267 $this->msg( 'pageinfo-redirects-name' )->escaped(),
269 array( 'hidelinks' => 1, 'hidetrans' => 1 )
271 $this->msg( 'pageinfo-redirects-value' )
272 ->numParams( count( $title->getRedirectsHere() ) )
275 // Is it counted as a content page?
276 if ( $this->page
->isCountable() ) {
277 $pageInfo['header-basic'][] = array(
278 $this->msg( 'pageinfo-contentpage' ),
279 $this->msg( 'pageinfo-contentpage-yes' )
283 // Subpages of this page, if subpages are enabled for the current NS
284 if ( MWNamespace
::hasSubpages( $title->getNamespace() ) ) {
285 $prefixIndex = SpecialPage
::getTitleFor( 'Prefixindex', $title->getPrefixedText() . '/' );
286 $pageInfo['header-basic'][] = array(
287 Linker
::link( $prefixIndex, $this->msg( 'pageinfo-subpages-name' )->escaped() ),
288 $this->msg( 'pageinfo-subpages-value' )
290 $pageCounts['subpages']['total'],
291 $pageCounts['subpages']['redirects'],
292 $pageCounts['subpages']['nonredirects'] )
297 $pageInfo['header-restrictions'] = array();
300 foreach ( $title->getRestrictionTypes() as $restrictionType ) {
301 $protectionLevel = implode( ', ', $title->getRestrictions( $restrictionType ) );
303 if ( $protectionLevel == '' ) {
305 $message = $this->msg( 'protect-default' )->escaped();
307 // Administrators only
308 $message = $this->msg( "protect-level-$protectionLevel" );
309 if ( $message->isDisabled() ) {
310 // Require "$1" permission
311 $message = $this->msg( "protect-fallback", $protectionLevel )->parse();
313 $message = $message->escaped();
317 $pageInfo['header-restrictions'][] = array(
318 $this->msg( "restriction-$restrictionType" ), $message
322 if ( !$this->page
->exists() ) {
327 $pageInfo['header-edits'] = array();
329 $firstRev = $this->page
->getOldestRevision();
332 $pageInfo['header-edits'][] = array(
333 $this->msg( 'pageinfo-firstuser' ),
334 Linker
::revUserTools( $firstRev )
337 // Date of page creation
338 $pageInfo['header-edits'][] = array(
339 $this->msg( 'pageinfo-firsttime' ),
342 $lang->userTimeAndDate( $firstRev->getTimestamp(), $user ),
344 array( 'oldid' => $firstRev->getId() )
349 $pageInfo['header-edits'][] = array(
350 $this->msg( 'pageinfo-lastuser' ),
351 Linker
::revUserTools( $this->page
->getRevision() )
354 // Date of latest edit
355 $pageInfo['header-edits'][] = array(
356 $this->msg( 'pageinfo-lasttime' ),
359 $lang->userTimeAndDate( $this->page
->getTimestamp(), $user ),
361 array( 'oldid' => $this->page
->getLatest() )
365 // Total number of edits
366 $pageInfo['header-edits'][] = array(
367 $this->msg( 'pageinfo-edits' ), $lang->formatNum( $pageCounts['edits'] )
370 // Total number of distinct authors
371 $pageInfo['header-edits'][] = array(
372 $this->msg( 'pageinfo-authors' ), $lang->formatNum( $pageCounts['authors'] )
375 // Recent number of edits (within past 30 days)
376 $pageInfo['header-edits'][] = array(
377 $this->msg( 'pageinfo-recent-edits', $lang->formatDuration( $wgRCMaxAge ) ),
378 $lang->formatNum( $pageCounts['recent_edits'] )
381 // Recent number of distinct authors
382 $pageInfo['header-edits'][] = array(
383 $this->msg( 'pageinfo-recent-authors' ), $lang->formatNum( $pageCounts['recent_authors'] )
386 // Array of MagicWord objects
387 $magicWords = MagicWord
::getDoubleUnderscoreArray();
389 // Array of magic word IDs
390 $wordIDs = $magicWords->names
;
392 // Array of IDs => localized magic words
393 $localizedWords = $wgContLang->getMagicWords();
395 $listItems = array();
396 foreach ( $pageProperties as $property => $value ) {
397 if ( in_array( $property, $wordIDs ) ) {
398 $listItems[] = Html
::element( 'li', array(), $localizedWords[$property][1] );
402 $localizedList = Html
::rawElement( 'ul', array(), implode( '', $listItems ) );
403 $hiddenCategories = $this->page
->getHiddenCategories();
404 $transcludedTemplates = $title->getTemplateLinksFrom();
406 if ( count( $listItems ) > 0
407 ||
count( $hiddenCategories ) > 0
408 ||
count( $transcludedTemplates ) > 0 ) {
410 $pageInfo['header-properties'] = array();
413 if ( count( $listItems ) > 0 ) {
414 $pageInfo['header-properties'][] = array(
415 $this->msg( 'pageinfo-magic-words' )->numParams( count( $listItems ) ),
421 if ( count( $hiddenCategories ) > 0 ) {
422 $pageInfo['header-properties'][] = array(
423 $this->msg( 'pageinfo-hidden-categories' )
424 ->numParams( count( $hiddenCategories ) ),
425 Linker
::formatHiddenCategories( $hiddenCategories )
429 // Transcluded templates
430 if ( count( $transcludedTemplates ) > 0 ) {
431 $pageInfo['header-properties'][] = array(
432 $this->msg( 'pageinfo-templates' )
433 ->numParams( count( $transcludedTemplates ) ),
434 Linker
::formatTemplates( $transcludedTemplates )
443 * Returns page counts that would be too "expensive" to retrieve by normal means.
445 * @param $title Title object
446 * @param $user User object
449 protected static function pageCounts( $title, $user ) {
450 global $wgRCMaxAge, $wgDisableCounters;
452 wfProfileIn( __METHOD__
);
453 $id = $title->getArticleID();
455 $dbr = wfGetDB( DB_SLAVE
);
458 if ( !$wgDisableCounters ) {
460 $views = (int) $dbr->selectField(
463 array( 'page_id' => $id ),
466 $result['views'] = $views;
469 if ( $user->isAllowed( 'unwatchedpages' ) ) {
470 // Number of page watchers
471 $watchers = (int) $dbr->selectField(
475 'wl_namespace' => $title->getNamespace(),
476 'wl_title' => $title->getDBkey(),
480 $result['watchers'] = $watchers;
483 // Total number of edits
484 $edits = (int) $dbr->selectField(
487 array( 'rev_page' => $id ),
490 $result['edits'] = $edits;
492 // Total number of distinct authors
493 $authors = (int) $dbr->selectField(
495 'COUNT(DISTINCT rev_user_text)',
496 array( 'rev_page' => $id ),
499 $result['authors'] = $authors;
501 // "Recent" threshold defined by $wgRCMaxAge
502 $threshold = $dbr->timestamp( time() - $wgRCMaxAge );
504 // Recent number of edits
505 $edits = (int) $dbr->selectField(
510 "rev_timestamp >= $threshold"
514 $result['recent_edits'] = $edits;
516 // Recent number of distinct authors
517 $authors = (int) $dbr->selectField(
519 'COUNT(DISTINCT rev_user_text)',
522 "rev_timestamp >= $threshold"
526 $result['recent_authors'] = $authors;
528 // Subpages (if enabled)
529 if ( MWNamespace
::hasSubpages( $title->getNamespace() ) ) {
530 $conds = array( 'page_namespace' => $title->getNamespace() );
531 $conds[] = 'page_title ' . $dbr->buildLike( $title->getDBkey() . '/', $dbr->anyString() );
533 // Subpages of this page (redirects)
534 $conds['page_is_redirect'] = 1;
535 $result['subpages']['redirects'] = (int) $dbr->selectField(
541 // Subpages of this page (non-redirects)
542 $conds['page_is_redirect'] = 0;
543 $result['subpages']['nonredirects'] = (int) $dbr->selectField(
550 // Subpages of this page (total)
551 $result['subpages']['total'] = $result['subpages']['redirects']
552 +
$result['subpages']['nonredirects'];
555 wfProfileOut( __METHOD__
);
560 * Returns the name that goes in the <h1> page title.
564 protected function getPageTitle() {
565 return $this->msg( 'pageinfo-title', $this->getTitle()->getPrefixedText() )->text();
569 * Get a list of contributors of $article
570 * @return string: html
572 protected function getContributors() {
573 global $wgHiddenPrefs;
575 $contributors = $this->page
->getContributors();
576 $real_names = array();
577 $user_names = array();
580 # Sift for real versus user names
581 foreach ( $contributors as $user ) {
582 $page = $user->isAnon()
583 ? SpecialPage
::getTitleFor( 'Contributions', $user->getName() )
584 : $user->getUserPage();
586 if ( $user->getID() == 0 ) {
587 $anon_ips[] = Linker
::link( $page, htmlspecialchars( $user->getName() ) );
588 } elseif ( !in_array( 'realname', $wgHiddenPrefs ) && $user->getRealName() ) {
589 $real_names[] = Linker
::link( $page, htmlspecialchars( $user->getRealName() ) );
591 $user_names[] = Linker
::link( $page, htmlspecialchars( $user->getName() ) );
595 $lang = $this->getLanguage();
597 $real = $lang->listToText( $real_names );
599 # "ThisSite user(s) A, B and C"
600 if ( count( $user_names ) ) {
601 $user = $this->msg( 'siteusers' )->rawParams( $lang->listToText( $user_names ) )->params(
602 count( $user_names ) )->escaped();
607 if ( count( $anon_ips ) ) {
608 $anon = $this->msg( 'anonusers' )->rawParams( $lang->listToText( $anon_ips ) )->params(
609 count( $anon_ips ) )->escaped();
614 # This is the big list, all mooshed together. We sift for blank strings
616 foreach ( array( $real, $user, $anon ) as $s ) {
618 array_push( $fulllist, $s );
622 $count = count( $fulllist );
623 # "Based on work by ..."
625 ?
$this->msg( 'othercontribs' )->rawParams(
626 $lang->listToText( $fulllist ) )->params( $count )->escaped()
631 * Returns the description that goes below the <h1> tag.
635 protected function getDescription() {