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
26 * Displays information about a page.
30 class InfoAction
extends FormlessAction
{
31 const CACHE_VERSION
= '2013-03-17';
34 * Returns the name of the action this object responds to.
36 * @return string Lowercase name
38 public function getName() {
43 * Whether this action can still be executed by a blocked user.
47 public function requiresUnblock() {
52 * Whether this action requires the wiki not to be locked.
56 public function requiresWrite() {
61 * Clear the info cache for a given Title.
64 * @param Title $title Title to clear cache for
66 public static function invalidateCache( Title
$title ) {
69 $revision = WikiPage
::factory( $title )->getRevision();
70 if ( $revision !== null ) {
71 $key = wfMemcKey( 'infoaction', sha1( $title->getPrefixedText() ), $revision->getId() );
72 $wgMemc->delete( $key );
77 * Shows page information on GET request.
79 * @return string Page information that will be added to the output
81 public function onView() {
85 $oldid = $this->page
->getOldID();
87 $revision = $this->page
->getRevisionFetched();
89 // Revision is missing
90 if ( $revision === null ) {
91 return $this->msg( 'missing-revision', $oldid )->parse();
94 // Revision is not current
95 if ( !$revision->isCurrent() ) {
96 return $this->msg( 'pageinfo-not-current' )->plain();
101 if ( !$this->msg( 'pageinfo-header' )->isDisabled() ) {
102 $content .= $this->msg( 'pageinfo-header' )->parse();
105 // Hide "This page is a member of # hidden categories" explanation
106 $content .= Html
::element( 'style', array(),
107 '.mw-hiddenCategoriesExplanation { display: none; }' ) . "\n";
109 // Hide "Templates used on this page" explanation
110 $content .= Html
::element( 'style', array(),
111 '.mw-templatesUsedExplanation { display: none; }' ) . "\n";
113 // Get page information
114 $pageInfo = $this->pageInfo();
116 // Allow extensions to add additional information
117 Hooks
::run( 'InfoAction', array( $this->getContext(), &$pageInfo ) );
119 // Render page information
120 foreach ( $pageInfo as $header => $infoTable ) {
122 // pageinfo-header-basic, pageinfo-header-edits, pageinfo-header-restrictions,
123 // pageinfo-header-properties, pageinfo-category-info
124 $content .= $this->makeHeader( $this->msg( "pageinfo-${header}" )->escaped() ) . "\n";
126 foreach ( $infoTable as $infoRow ) {
127 $name = ( $infoRow[0] instanceof Message
) ?
$infoRow[0]->escaped() : $infoRow[0];
128 $value = ( $infoRow[1] instanceof Message
) ?
$infoRow[1]->escaped() : $infoRow[1];
129 $id = ( $infoRow[0] instanceof Message
) ?
$infoRow[0]->getKey() : null;
130 $table = $this->addRow( $table, $name, $value, $id ) . "\n";
132 $content = $this->addTable( $content, $table ) . "\n";
136 if ( !$this->msg( 'pageinfo-footer' )->isDisabled() ) {
137 $content .= $this->msg( 'pageinfo-footer' )->parse();
141 /*if ( $this->page->exists() ) {
142 $content .= Html::rawElement( 'div', array( 'id' => 'mw-credits' ), $this->getContributors() );
149 * Creates a header that can be added to the output.
151 * @param string $header The header text.
152 * @return string The HTML.
154 protected function makeHeader( $header ) {
155 $spanAttribs = array( 'class' => 'mw-headline', 'id' => Sanitizer
::escapeId( $header ) );
157 return Html
::rawElement( 'h2', array(), Html
::element( 'span', $spanAttribs, $header ) );
161 * Adds a row to a table that will be added to the content.
163 * @param string $table The table that will be added to the content
164 * @param string $name The name of the row
165 * @param string $value The value of the row
166 * @param string $id The ID to use for the 'tr' element
167 * @return string The table with the row added
169 protected function addRow( $table, $name, $value, $id ) {
170 return $table . Html
::rawElement( 'tr', $id === null ?
array() : array( 'id' => 'mw-' . $id ),
171 Html
::rawElement( 'td', array( 'style' => 'vertical-align: top;' ), $name ) .
172 Html
::rawElement( 'td', array(), $value )
177 * Adds a table to the content that will be added to the output.
179 * @param string $content The content that will be added to the output
180 * @param string $table The table
181 * @return string The content with the table added
183 protected function addTable( $content, $table ) {
184 return $content . Html
::rawElement( 'table', array( 'class' => 'wikitable mw-page-info' ),
189 * Returns page information in an easily-manipulated format. Array keys are used so extensions
190 * may add additional information in arbitrary positions. Array values are arrays with one
191 * element to be rendered as a header, arrays with two elements to be rendered as a table row.
195 protected function pageInfo() {
196 global $wgContLang, $wgMemc;
198 $user = $this->getUser();
199 $lang = $this->getLanguage();
200 $title = $this->getTitle();
201 $id = $title->getArticleID();
202 $config = $this->context
->getConfig();
204 $memcKey = wfMemcKey( 'infoaction',
205 sha1( $title->getPrefixedText() ), $this->page
->getLatest() );
206 $pageCounts = $wgMemc->get( $memcKey );
207 $version = isset( $pageCounts['cacheversion'] ) ?
$pageCounts['cacheversion'] : false;
208 if ( $pageCounts === false ||
$version !== self
::CACHE_VERSION
) {
209 // Get page information that would be too "expensive" to retrieve by normal means
210 $pageCounts = $this->pageCounts( $title );
211 $pageCounts['cacheversion'] = self
::CACHE_VERSION
;
213 $wgMemc->set( $memcKey, $pageCounts );
216 // Get page properties
217 $dbr = wfGetDB( DB_SLAVE
);
218 $result = $dbr->select(
220 array( 'pp_propname', 'pp_value' ),
221 array( 'pp_page' => $id ),
225 $pageProperties = array();
226 foreach ( $result as $row ) {
227 $pageProperties[$row->pp_propname
] = $row->pp_value
;
232 $pageInfo['header-basic'] = array();
235 $displayTitle = $title->getPrefixedText();
236 if ( !empty( $pageProperties['displaytitle'] ) ) {
237 $displayTitle = $pageProperties['displaytitle'];
240 $pageInfo['header-basic'][] = array(
241 $this->msg( 'pageinfo-display-title' ), $displayTitle
244 // Is it a redirect? If so, where to?
245 if ( $title->isRedirect() ) {
246 $pageInfo['header-basic'][] = array(
247 $this->msg( 'pageinfo-redirectsto' ),
248 Linker
::link( $this->page
->getRedirectTarget() ) .
249 $this->msg( 'word-separator' )->text() .
250 $this->msg( 'parentheses', Linker
::link(
251 $this->page
->getRedirectTarget(),
252 $this->msg( 'pageinfo-redirectsto-info' )->escaped(),
254 array( 'action' => 'info' )
260 $sortKey = $title->getCategorySortkey();
261 if ( !empty( $pageProperties['defaultsort'] ) ) {
262 $sortKey = $pageProperties['defaultsort'];
265 $sortKey = htmlspecialchars( $sortKey );
266 $pageInfo['header-basic'][] = array( $this->msg( 'pageinfo-default-sort' ), $sortKey );
268 // Page length (in bytes)
269 $pageInfo['header-basic'][] = array(
270 $this->msg( 'pageinfo-length' ), $lang->formatNum( $title->getLength() )
273 // Page ID (number not localised, as it's a database ID)
274 $pageInfo['header-basic'][] = array( $this->msg( 'pageinfo-article-id' ), $id );
276 // Language in which the page content is (supposed to be) written
277 $pageLang = $title->getPageLanguage()->getCode();
279 if ( $config->get( 'PageLanguageUseDB' )
280 && $this->getTitle()->userCan( 'pagelang', $this->getUser() )
282 // Link to Special:PageLanguage with pre-filled page title if user has permissions
283 $titleObj = SpecialPage
::getTitleFor( 'PageLanguage', $title->getPrefixedText() );
284 $langDisp = Linker
::link(
286 $this->msg( 'pageinfo-language' )->escaped()
289 // Display just the message
290 $langDisp = $this->msg( 'pageinfo-language' )->escaped();
293 $pageInfo['header-basic'][] = array( $langDisp,
294 Language
::fetchLanguageName( $pageLang, $lang->getCode() )
295 . ' ' . $this->msg( 'parentheses', $pageLang )->escaped() );
297 // Content model of the page
298 $pageInfo['header-basic'][] = array(
299 $this->msg( 'pageinfo-content-model' ),
300 htmlspecialchars( ContentHandler
::getLocalizedName( $title->getContentModel() ) )
303 // Search engine status
304 $pOutput = new ParserOutput();
305 if ( isset( $pageProperties['noindex'] ) ) {
306 $pOutput->setIndexPolicy( 'noindex' );
308 if ( isset( $pageProperties['index'] ) ) {
309 $pOutput->setIndexPolicy( 'index' );
312 // Use robot policy logic
313 $policy = $this->page
->getRobotPolicy( 'view', $pOutput );
314 $pageInfo['header-basic'][] = array(
315 // Messages: pageinfo-robot-index, pageinfo-robot-noindex
316 $this->msg( 'pageinfo-robot-policy' ), $this->msg( "pageinfo-robot-${policy['index']}" )
319 $unwatchedPageThreshold = $config->get( 'UnwatchedPageThreshold' );
321 $user->isAllowed( 'unwatchedpages' ) ||
322 ( $unwatchedPageThreshold !== false &&
323 $pageCounts['watchers'] >= $unwatchedPageThreshold )
325 // Number of page watchers
326 $pageInfo['header-basic'][] = array(
327 $this->msg( 'pageinfo-watchers' ), $lang->formatNum( $pageCounts['watchers'] )
329 } elseif ( $unwatchedPageThreshold !== false ) {
330 $pageInfo['header-basic'][] = array(
331 $this->msg( 'pageinfo-watchers' ),
332 $this->msg( 'pageinfo-few-watchers' )->numParams( $unwatchedPageThreshold )
336 // Redirects to this page
337 $whatLinksHere = SpecialPage
::getTitleFor( 'Whatlinkshere', $title->getPrefixedText() );
338 $pageInfo['header-basic'][] = array(
341 $this->msg( 'pageinfo-redirects-name' )->escaped(),
346 'hideimages' => $title->getNamespace() == NS_FILE
349 $this->msg( 'pageinfo-redirects-value' )
350 ->numParams( count( $title->getRedirectsHere() ) )
353 // Is it counted as a content page?
354 if ( $this->page
->isCountable() ) {
355 $pageInfo['header-basic'][] = array(
356 $this->msg( 'pageinfo-contentpage' ),
357 $this->msg( 'pageinfo-contentpage-yes' )
361 // Subpages of this page, if subpages are enabled for the current NS
362 if ( MWNamespace
::hasSubpages( $title->getNamespace() ) ) {
363 $prefixIndex = SpecialPage
::getTitleFor( 'Prefixindex', $title->getPrefixedText() . '/' );
364 $pageInfo['header-basic'][] = array(
365 Linker
::link( $prefixIndex, $this->msg( 'pageinfo-subpages-name' )->escaped() ),
366 $this->msg( 'pageinfo-subpages-value' )
368 $pageCounts['subpages']['total'],
369 $pageCounts['subpages']['redirects'],
370 $pageCounts['subpages']['nonredirects'] )
374 if ( $title->inNamespace( NS_CATEGORY
) ) {
375 $category = Category
::newFromTitle( $title );
376 $pageInfo['category-info'] = array(
378 $this->msg( 'pageinfo-category-pages' ),
379 $lang->formatNum( $category->getPageCount() )
382 $this->msg( 'pageinfo-category-subcats' ),
383 $lang->formatNum( $category->getSubcatCount() )
386 $this->msg( 'pageinfo-category-files' ),
387 $lang->formatNum( $category->getFileCount() )
393 $pageInfo['header-restrictions'] = array();
395 // Is this page affected by the cascading protection of something which includes it?
396 if ( $title->isCascadeProtected() ) {
398 $sources = $title->getCascadeProtectionSources(); // Array deferencing is in PHP 5.4 :(
400 foreach ( $sources[0] as $sourceTitle ) {
401 $cascadingFrom .= Html
::rawElement( 'li', array(), Linker
::linkKnown( $sourceTitle ) );
404 $cascadingFrom = Html
::rawElement( 'ul', array(), $cascadingFrom );
405 $pageInfo['header-restrictions'][] = array(
406 $this->msg( 'pageinfo-protect-cascading-from' ),
411 // Is out protection set to cascade to other pages?
412 if ( $title->areRestrictionsCascading() ) {
413 $pageInfo['header-restrictions'][] = array(
414 $this->msg( 'pageinfo-protect-cascading' ),
415 $this->msg( 'pageinfo-protect-cascading-yes' )
420 foreach ( $title->getRestrictionTypes() as $restrictionType ) {
421 $protectionLevel = implode( ', ', $title->getRestrictions( $restrictionType ) );
423 if ( $protectionLevel == '' ) {
425 $message = $this->msg( 'protect-default' )->escaped();
427 // Administrators only
428 // Messages: protect-level-autoconfirmed, protect-level-sysop
429 $message = $this->msg( "protect-level-$protectionLevel" );
430 if ( $message->isDisabled() ) {
431 // Require "$1" permission
432 $message = $this->msg( "protect-fallback", $protectionLevel )->parse();
434 $message = $message->escaped();
438 // Messages: restriction-edit, restriction-move, restriction-create,
439 // restriction-upload
440 $pageInfo['header-restrictions'][] = array(
441 $this->msg( "restriction-$restrictionType" ), $message
445 if ( !$this->page
->exists() ) {
450 $pageInfo['header-edits'] = array();
452 $firstRev = $this->page
->getOldestRevision();
453 $lastRev = $this->page
->getRevision();
454 $batch = new LinkBatch
;
457 $firstRevUser = $firstRev->getUserText( Revision
::FOR_THIS_USER
);
458 if ( $firstRevUser !== '' ) {
459 $batch->add( NS_USER
, $firstRevUser );
460 $batch->add( NS_USER_TALK
, $firstRevUser );
465 $lastRevUser = $lastRev->getUserText( Revision
::FOR_THIS_USER
);
466 if ( $lastRevUser !== '' ) {
467 $batch->add( NS_USER
, $lastRevUser );
468 $batch->add( NS_USER_TALK
, $lastRevUser );
476 $pageInfo['header-edits'][] = array(
477 $this->msg( 'pageinfo-firstuser' ),
478 Linker
::revUserTools( $firstRev )
481 // Date of page creation
482 $pageInfo['header-edits'][] = array(
483 $this->msg( 'pageinfo-firsttime' ),
486 htmlspecialchars( $lang->userTimeAndDate( $firstRev->getTimestamp(), $user ) ),
488 array( 'oldid' => $firstRev->getId() )
495 $pageInfo['header-edits'][] = array(
496 $this->msg( 'pageinfo-lastuser' ),
497 Linker
::revUserTools( $lastRev )
500 // Date of latest edit
501 $pageInfo['header-edits'][] = array(
502 $this->msg( 'pageinfo-lasttime' ),
505 htmlspecialchars( $lang->userTimeAndDate( $this->page
->getTimestamp(), $user ) ),
507 array( 'oldid' => $this->page
->getLatest() )
512 // Total number of edits
513 $pageInfo['header-edits'][] = array(
514 $this->msg( 'pageinfo-edits' ), $lang->formatNum( $pageCounts['edits'] )
517 // Total number of distinct authors
518 $pageInfo['header-edits'][] = array(
519 $this->msg( 'pageinfo-authors' ), $lang->formatNum( $pageCounts['authors'] )
522 // Recent number of edits (within past 30 days)
523 $pageInfo['header-edits'][] = array(
524 $this->msg( 'pageinfo-recent-edits', $lang->formatDuration( $config->get( 'RCMaxAge' ) ) ),
525 $lang->formatNum( $pageCounts['recent_edits'] )
528 // Recent number of distinct authors
529 $pageInfo['header-edits'][] = array(
530 $this->msg( 'pageinfo-recent-authors' ), $lang->formatNum( $pageCounts['recent_authors'] )
533 // Array of MagicWord objects
534 $magicWords = MagicWord
::getDoubleUnderscoreArray();
536 // Array of magic word IDs
537 $wordIDs = $magicWords->names
;
539 // Array of IDs => localized magic words
540 $localizedWords = $wgContLang->getMagicWords();
542 $listItems = array();
543 foreach ( $pageProperties as $property => $value ) {
544 if ( in_array( $property, $wordIDs ) ) {
545 $listItems[] = Html
::element( 'li', array(), $localizedWords[$property][1] );
549 $localizedList = Html
::rawElement( 'ul', array(), implode( '', $listItems ) );
550 $hiddenCategories = $this->page
->getHiddenCategories();
553 count( $listItems ) > 0 ||
554 count( $hiddenCategories ) > 0 ||
555 $pageCounts['transclusion']['from'] > 0 ||
556 $pageCounts['transclusion']['to'] > 0
558 $options = array( 'LIMIT' => $config->get( 'PageInfoTransclusionLimit' ) );
559 $transcludedTemplates = $title->getTemplateLinksFrom( $options );
560 if ( $config->get( 'MiserMode' ) ) {
561 $transcludedTargets = array();
563 $transcludedTargets = $title->getTemplateLinksTo( $options );
567 $pageInfo['header-properties'] = array();
570 if ( count( $listItems ) > 0 ) {
571 $pageInfo['header-properties'][] = array(
572 $this->msg( 'pageinfo-magic-words' )->numParams( count( $listItems ) ),
578 if ( count( $hiddenCategories ) > 0 ) {
579 $pageInfo['header-properties'][] = array(
580 $this->msg( 'pageinfo-hidden-categories' )
581 ->numParams( count( $hiddenCategories ) ),
582 Linker
::formatHiddenCategories( $hiddenCategories )
586 // Transcluded templates
587 if ( $pageCounts['transclusion']['from'] > 0 ) {
588 if ( $pageCounts['transclusion']['from'] > count( $transcludedTemplates ) ) {
589 $more = $this->msg( 'morenotlisted' )->escaped();
594 $pageInfo['header-properties'][] = array(
595 $this->msg( 'pageinfo-templates' )
596 ->numParams( $pageCounts['transclusion']['from'] ),
597 Linker
::formatTemplates(
598 $transcludedTemplates,
605 if ( !$config->get( 'MiserMode' ) && $pageCounts['transclusion']['to'] > 0 ) {
606 if ( $pageCounts['transclusion']['to'] > count( $transcludedTargets ) ) {
607 $more = Linker
::link(
609 $this->msg( 'moredotdotdot' )->escaped(),
611 array( 'hidelinks' => 1, 'hideredirs' => 1 )
617 $pageInfo['header-properties'][] = array(
618 $this->msg( 'pageinfo-transclusions' )
619 ->numParams( $pageCounts['transclusion']['to'] ),
620 Linker
::formatTemplates(
633 * Returns page counts that would be too "expensive" to retrieve by normal means.
635 * @param Title $title Title to get counts for
638 protected function pageCounts( Title
$title ) {
639 $id = $title->getArticleID();
640 $config = $this->context
->getConfig();
642 $dbr = wfGetDB( DB_SLAVE
);
645 // Number of page watchers
646 $watchers = (int)$dbr->selectField(
650 'wl_namespace' => $title->getNamespace(),
651 'wl_title' => $title->getDBkey(),
655 $result['watchers'] = $watchers;
657 // Total number of edits
658 $edits = (int)$dbr->selectField(
661 array( 'rev_page' => $id ),
664 $result['edits'] = $edits;
666 // Total number of distinct authors
667 $authors = (int)$dbr->selectField(
669 'COUNT(DISTINCT rev_user_text)',
670 array( 'rev_page' => $id ),
673 $result['authors'] = $authors;
675 // "Recent" threshold defined by RCMaxAge setting
676 $threshold = $dbr->timestamp( time() - $config->get( 'RCMaxAge' ) );
678 // Recent number of edits
679 $edits = (int)$dbr->selectField(
684 "rev_timestamp >= " . $dbr->addQuotes( $threshold )
688 $result['recent_edits'] = $edits;
690 // Recent number of distinct authors
691 $authors = (int)$dbr->selectField(
693 'COUNT(DISTINCT rev_user_text)',
696 "rev_timestamp >= " . $dbr->addQuotes( $threshold )
700 $result['recent_authors'] = $authors;
702 // Subpages (if enabled)
703 if ( MWNamespace
::hasSubpages( $title->getNamespace() ) ) {
704 $conds = array( 'page_namespace' => $title->getNamespace() );
705 $conds[] = 'page_title ' . $dbr->buildLike( $title->getDBkey() . '/', $dbr->anyString() );
707 // Subpages of this page (redirects)
708 $conds['page_is_redirect'] = 1;
709 $result['subpages']['redirects'] = (int)$dbr->selectField(
715 // Subpages of this page (non-redirects)
716 $conds['page_is_redirect'] = 0;
717 $result['subpages']['nonredirects'] = (int)$dbr->selectField(
724 // Subpages of this page (total)
725 $result['subpages']['total'] = $result['subpages']['redirects']
726 +
$result['subpages']['nonredirects'];
729 // Counts for the number of transclusion links (to/from)
730 if ( $config->get( 'MiserMode' ) ) {
731 $result['transclusion']['to'] = 0;
733 $result['transclusion']['to'] = (int)$dbr->selectField(
737 'tl_namespace' => $title->getNamespace(),
738 'tl_title' => $title->getDBkey()
744 $result['transclusion']['from'] = (int)$dbr->selectField(
747 array( 'tl_from' => $title->getArticleID() ),
755 * Returns the name that goes in the "<h1>" page title.
759 protected function getPageTitle() {
760 return $this->msg( 'pageinfo-title', $this->getTitle()->getPrefixedText() )->text();
764 * Get a list of contributors of $article
765 * @return string Html
767 protected function getContributors() {
768 $contributors = $this->page
->getContributors();
769 $real_names = array();
770 $user_names = array();
773 # Sift for real versus user names
774 /** @var $user User */
775 foreach ( $contributors as $user ) {
776 $page = $user->isAnon()
777 ? SpecialPage
::getTitleFor( 'Contributions', $user->getName() )
778 : $user->getUserPage();
780 $hiddenPrefs = $this->context
->getConfig()->get( 'HiddenPrefs' );
781 if ( $user->getID() == 0 ) {
782 $anon_ips[] = Linker
::link( $page, htmlspecialchars( $user->getName() ) );
783 } elseif ( !in_array( 'realname', $hiddenPrefs ) && $user->getRealName() ) {
784 $real_names[] = Linker
::link( $page, htmlspecialchars( $user->getRealName() ) );
786 $user_names[] = Linker
::link( $page, htmlspecialchars( $user->getName() ) );
790 $lang = $this->getLanguage();
792 $real = $lang->listToText( $real_names );
794 # "ThisSite user(s) A, B and C"
795 if ( count( $user_names ) ) {
796 $user = $this->msg( 'siteusers' )->rawParams( $lang->listToText( $user_names ) )->params(
797 count( $user_names ) )->escaped();
802 if ( count( $anon_ips ) ) {
803 $anon = $this->msg( 'anonusers' )->rawParams( $lang->listToText( $anon_ips ) )->params(
804 count( $anon_ips ) )->escaped();
809 # This is the big list, all mooshed together. We sift for blank strings
811 foreach ( array( $real, $user, $anon ) as $s ) {
813 array_push( $fulllist, $s );
817 $count = count( $fulllist );
819 # "Based on work by ..."
821 ?
$this->msg( 'othercontribs' )->rawParams(
822 $lang->listToText( $fulllist ) )->params( $count )->escaped()
827 * Returns the description that goes below the "<h1>" tag.
831 protected function getDescription() {