miscellaneous doxygen warnings
[lhc/web/wiklou.git] / includes / actions / InfoAction.php
1 <?php
2 /**
3 * Displays information about a page.
4 *
5 * Copyright © 2011 Alexandre Emsenhuber
6 *
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.
11 *
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.
16 *
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
20 *
21 * @file
22 * @ingroup Actions
23 */
24
25 class InfoAction extends FormlessAction {
26 /**
27 * Returns the name of the action this object responds to.
28 *
29 * @return string lowercase
30 */
31 public function getName() {
32 return 'info';
33 }
34
35 /**
36 * Whether this action can still be executed by a blocked user.
37 *
38 * @return bool
39 */
40 public function requiresUnblock() {
41 return false;
42 }
43
44 /**
45 * Whether this action requires the wiki not to be locked.
46 *
47 * @return bool
48 */
49 public function requiresWrite() {
50 return false;
51 }
52
53 /**
54 * Shows page information on GET request.
55 *
56 * @return string Page information that will be added to the output
57 */
58 public function onView() {
59 $content = '';
60
61 // Validate revision
62 $oldid = $this->page->getOldID();
63 if ( $oldid ) {
64 $revision = $this->page->getRevisionFetched();
65
66 // Revision is missing
67 if ( $revision === null ) {
68 return $this->msg( 'missing-revision', $oldid )->parse();
69 }
70
71 // Revision is not current
72 if ( !$revision->isCurrent() ) {
73 return $this->msg( 'pageinfo-not-current' )->plain();
74 }
75 }
76
77 // Page header
78 if ( !$this->msg( 'pageinfo-header' )->isDisabled() ) {
79 $content .= $this->msg( 'pageinfo-header' )->parse();
80 }
81
82 // Hide "This page is a member of # hidden categories" explanation
83 $content .= Html::element( 'style', array(),
84 '.mw-hiddenCategoriesExplanation { display: none; }' );
85
86 // Hide "Templates used on this page" explanation
87 $content .= Html::element( 'style', array(),
88 '.mw-templatesUsedExplanation { display: none; }' );
89
90 // Get page information
91 $pageInfo = $this->pageInfo();
92
93 // Allow extensions to add additional information
94 wfRunHooks( 'InfoAction', array( $this->getContext(), &$pageInfo ) );
95
96 // Render page information
97 foreach ( $pageInfo as $header => $infoTable ) {
98 $content .= $this->makeHeader( $this->msg( "pageinfo-${header}" )->escaped() );
99 $table = '';
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 );
104 }
105 $content = $this->addTable( $content, $table );
106 }
107
108 // Page footer
109 if ( !$this->msg( 'pageinfo-footer' )->isDisabled() ) {
110 $content .= $this->msg( 'pageinfo-footer' )->parse();
111 }
112
113 // Page credits
114 /*if ( $this->page->exists() ) {
115 $content .= Html::rawElement( 'div', array( 'id' => 'mw-credits' ), $this->getContributors() );
116 }*/
117
118 return $content;
119 }
120
121 /**
122 * Creates a header that can be added to the output.
123 *
124 * @param $header The header text.
125 * @return string The HTML.
126 */
127 protected function makeHeader( $header ) {
128 global $wgParser;
129 $spanAttribs = array( 'class' => 'mw-headline', 'id' => $wgParser->guessSectionNameFromWikiText( $header ) );
130 return Html::rawElement( 'h2', array(), Html::element( 'span', $spanAttribs, $header ) );
131 }
132
133 /**
134 * Adds a row to a table that will be added to the content.
135 *
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
140 */
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 )
145 );
146 }
147
148 /**
149 * Adds a table to the content that will be added to the output.
150 *
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
154 */
155 protected function addTable( $content, $table ) {
156 return $content . Html::rawElement( 'table', array( 'class' => 'wikitable mw-page-info' ),
157 $table );
158 }
159
160 /**
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.
164 *
165 * @return array
166 */
167 protected function pageInfo() {
168 global $wgContLang, $wgRCMaxAge;
169
170 $user = $this->getUser();
171 $lang = $this->getLanguage();
172 $title = $this->getTitle();
173 $id = $title->getArticleID();
174
175 // Get page information that would be too "expensive" to retrieve by normal means
176 $pageCounts = self::pageCounts( $title, $user );
177
178 // Get page properties
179 $dbr = wfGetDB( DB_SLAVE );
180 $result = $dbr->select(
181 'page_props',
182 array( 'pp_propname', 'pp_value' ),
183 array( 'pp_page' => $id ),
184 __METHOD__
185 );
186
187 $pageProperties = array();
188 foreach ( $result as $row ) {
189 $pageProperties[$row->pp_propname] = $row->pp_value;
190 }
191
192 // Basic information
193 $pageInfo = array();
194 $pageInfo['header-basic'] = array();
195
196 // Display title
197 $displayTitle = $title->getPrefixedText();
198 if ( !empty( $pageProperties['displaytitle'] ) ) {
199 $displayTitle = $pageProperties['displaytitle'];
200 }
201
202 $pageInfo['header-basic'][] = array(
203 $this->msg( 'pageinfo-display-title' ), $displayTitle
204 );
205
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( 'word-separator' )->text() .
212 $this->msg( 'parentheses', Linker::link(
213 $this->page->getRedirectTarget(),
214 $this->msg( 'pageinfo-redirectsto-info' )->escaped(),
215 array(),
216 array( 'action' => 'info' )
217 ) )->text()
218 );
219 }
220
221 // Default sort key
222 $sortKey = $title->getCategorySortKey();
223 if ( !empty( $pageProperties['defaultsort'] ) ) {
224 $sortKey = $pageProperties['defaultsort'];
225 }
226
227 $pageInfo['header-basic'][] = array( $this->msg( 'pageinfo-default-sort' ), $sortKey );
228
229 // Page length (in bytes)
230 $pageInfo['header-basic'][] = array(
231 $this->msg( 'pageinfo-length' ), $lang->formatNum( $title->getLength() )
232 );
233
234 // Page ID (number not localised, as it's a database ID)
235 $pageInfo['header-basic'][] = array( $this->msg( 'pageinfo-article-id' ), $id );
236
237 // Search engine status
238 $pOutput = new ParserOutput();
239 if ( isset( $pageProperties['noindex'] ) ) {
240 $pOutput->setIndexPolicy( 'noindex' );
241 }
242
243 // Use robot policy logic
244 $policy = $this->page->getRobotPolicy( 'view', $pOutput );
245 $pageInfo['header-basic'][] = array(
246 $this->msg( 'pageinfo-robot-policy' ), $this->msg( "pageinfo-robot-${policy['index']}" )
247 );
248
249 if ( isset( $pageCounts['views'] ) ) {
250 // Number of views
251 $pageInfo['header-basic'][] = array(
252 $this->msg( 'pageinfo-views' ), $lang->formatNum( $pageCounts['views'] )
253 );
254 }
255
256 if ( isset( $pageCounts['watchers'] ) ) {
257 // Number of page watchers
258 $pageInfo['header-basic'][] = array(
259 $this->msg( 'pageinfo-watchers' ), $lang->formatNum( $pageCounts['watchers'] )
260 );
261 }
262
263 // Redirects to this page
264 $whatLinksHere = SpecialPage::getTitleFor( 'Whatlinkshere', $title->getPrefixedText() );
265 $pageInfo['header-basic'][] = array(
266 Linker::link(
267 $whatLinksHere,
268 $this->msg( 'pageinfo-redirects-name' )->escaped(),
269 array(),
270 array( 'hidelinks' => 1, 'hidetrans' => 1 )
271 ),
272 $this->msg( 'pageinfo-redirects-value' )
273 ->numParams( count( $title->getRedirectsHere() ) )
274 );
275
276 // Is it counted as a content page?
277 if ( $this->page->isCountable() ) {
278 $pageInfo['header-basic'][] = array(
279 $this->msg( 'pageinfo-contentpage' ),
280 $this->msg( 'pageinfo-contentpage-yes' )
281 );
282 }
283
284 // Subpages of this page, if subpages are enabled for the current NS
285 if ( MWNamespace::hasSubpages( $title->getNamespace() ) ) {
286 $prefixIndex = SpecialPage::getTitleFor( 'Prefixindex', $title->getPrefixedText() . '/' );
287 $pageInfo['header-basic'][] = array(
288 Linker::link( $prefixIndex, $this->msg( 'pageinfo-subpages-name' )->escaped() ),
289 $this->msg( 'pageinfo-subpages-value' )
290 ->numParams(
291 $pageCounts['subpages']['total'],
292 $pageCounts['subpages']['redirects'],
293 $pageCounts['subpages']['nonredirects'] )
294 );
295 }
296
297 // Page protection
298 $pageInfo['header-restrictions'] = array();
299
300 // Is this page effected by the cascading protection of something which includes it?
301 if ( $title->isCascadeProtected() ) {
302 $cascadingFrom = '';
303 $sources = $title->getCascadeProtectionSources(); // Array deferencing is in PHP 5.4 :(
304
305 foreach ( $sources[0] as $sourceTitle ) {
306 $cascadingFrom .= Html::rawElement( 'li', array(), Linker::linkKnown( $sourceTitle ) );
307 }
308
309 $cascadingFrom = Html::rawElement( 'ul', array(), $cascadingFrom );
310 $pageInfo['header-restrictions'][] = array(
311 $this->msg( 'pageinfo-protect-cascading-from' ),
312 $cascadingFrom
313 );
314 }
315
316 // Is out protection set to cascade to other pages?
317 if ( $title->areRestrictionsCascading() ) {
318 $pageInfo['header-restrictions'][] = array(
319 $this->msg( 'pageinfo-protect-cascading' ),
320 $this->msg( 'pageinfo-protect-cascading-yes' )
321 );
322 }
323
324 // Page protection
325 foreach ( $title->getRestrictionTypes() as $restrictionType ) {
326 $protectionLevel = implode( ', ', $title->getRestrictions( $restrictionType ) );
327
328 if ( $protectionLevel == '' ) {
329 // Allow all users
330 $message = $this->msg( 'protect-default' )->escaped();
331 } else {
332 // Administrators only
333 $message = $this->msg( "protect-level-$protectionLevel" );
334 if ( $message->isDisabled() ) {
335 // Require "$1" permission
336 $message = $this->msg( "protect-fallback", $protectionLevel )->parse();
337 } else {
338 $message = $message->escaped();
339 }
340 }
341
342 $pageInfo['header-restrictions'][] = array(
343 $this->msg( "restriction-$restrictionType" ), $message
344 );
345 }
346
347 if ( !$this->page->exists() ) {
348 return $pageInfo;
349 }
350
351 // Edit history
352 $pageInfo['header-edits'] = array();
353
354 $firstRev = $this->page->getOldestRevision();
355
356 // Page creator
357 $pageInfo['header-edits'][] = array(
358 $this->msg( 'pageinfo-firstuser' ),
359 Linker::revUserTools( $firstRev )
360 );
361
362 // Date of page creation
363 $pageInfo['header-edits'][] = array(
364 $this->msg( 'pageinfo-firsttime' ),
365 Linker::linkKnown(
366 $title,
367 $lang->userTimeAndDate( $firstRev->getTimestamp(), $user ),
368 array(),
369 array( 'oldid' => $firstRev->getId() )
370 )
371 );
372
373 // Latest editor
374 $pageInfo['header-edits'][] = array(
375 $this->msg( 'pageinfo-lastuser' ),
376 Linker::revUserTools( $this->page->getRevision() )
377 );
378
379 // Date of latest edit
380 $pageInfo['header-edits'][] = array(
381 $this->msg( 'pageinfo-lasttime' ),
382 Linker::linkKnown(
383 $title,
384 $lang->userTimeAndDate( $this->page->getTimestamp(), $user ),
385 array(),
386 array( 'oldid' => $this->page->getLatest() )
387 )
388 );
389
390 // Total number of edits
391 $pageInfo['header-edits'][] = array(
392 $this->msg( 'pageinfo-edits' ), $lang->formatNum( $pageCounts['edits'] )
393 );
394
395 // Total number of distinct authors
396 $pageInfo['header-edits'][] = array(
397 $this->msg( 'pageinfo-authors' ), $lang->formatNum( $pageCounts['authors'] )
398 );
399
400 // Recent number of edits (within past 30 days)
401 $pageInfo['header-edits'][] = array(
402 $this->msg( 'pageinfo-recent-edits', $lang->formatDuration( $wgRCMaxAge ) ),
403 $lang->formatNum( $pageCounts['recent_edits'] )
404 );
405
406 // Recent number of distinct authors
407 $pageInfo['header-edits'][] = array(
408 $this->msg( 'pageinfo-recent-authors' ), $lang->formatNum( $pageCounts['recent_authors'] )
409 );
410
411 // Array of MagicWord objects
412 $magicWords = MagicWord::getDoubleUnderscoreArray();
413
414 // Array of magic word IDs
415 $wordIDs = $magicWords->names;
416
417 // Array of IDs => localized magic words
418 $localizedWords = $wgContLang->getMagicWords();
419
420 $listItems = array();
421 foreach ( $pageProperties as $property => $value ) {
422 if ( in_array( $property, $wordIDs ) ) {
423 $listItems[] = Html::element( 'li', array(), $localizedWords[$property][1] );
424 }
425 }
426
427 $localizedList = Html::rawElement( 'ul', array(), implode( '', $listItems ) );
428 $hiddenCategories = $this->page->getHiddenCategories();
429 $transcludedTemplates = $title->getTemplateLinksFrom();
430
431 if ( count( $listItems ) > 0
432 || count( $hiddenCategories ) > 0
433 || count( $transcludedTemplates ) > 0 ) {
434 // Page properties
435 $pageInfo['header-properties'] = array();
436
437 // Magic words
438 if ( count( $listItems ) > 0 ) {
439 $pageInfo['header-properties'][] = array(
440 $this->msg( 'pageinfo-magic-words' )->numParams( count( $listItems ) ),
441 $localizedList
442 );
443 }
444
445 // Hidden categories
446 if ( count( $hiddenCategories ) > 0 ) {
447 $pageInfo['header-properties'][] = array(
448 $this->msg( 'pageinfo-hidden-categories' )
449 ->numParams( count( $hiddenCategories ) ),
450 Linker::formatHiddenCategories( $hiddenCategories )
451 );
452 }
453
454 // Transcluded templates
455 if ( count( $transcludedTemplates ) > 0 ) {
456 $pageInfo['header-properties'][] = array(
457 $this->msg( 'pageinfo-templates' )
458 ->numParams( count( $transcludedTemplates ) ),
459 Linker::formatTemplates( $transcludedTemplates )
460 );
461 }
462 }
463
464 return $pageInfo;
465 }
466
467 /**
468 * Returns page counts that would be too "expensive" to retrieve by normal means.
469 *
470 * @param $title Title object
471 * @param $user User object
472 * @return array
473 */
474 protected static function pageCounts( $title, $user ) {
475 global $wgRCMaxAge, $wgDisableCounters;
476
477 wfProfileIn( __METHOD__ );
478 $id = $title->getArticleID();
479
480 $dbr = wfGetDB( DB_SLAVE );
481 $result = array();
482
483 if ( !$wgDisableCounters ) {
484 // Number of views
485 $views = (int) $dbr->selectField(
486 'page',
487 'page_counter',
488 array( 'page_id' => $id ),
489 __METHOD__
490 );
491 $result['views'] = $views;
492 }
493
494 if ( $user->isAllowed( 'unwatchedpages' ) ) {
495 // Number of page watchers
496 $watchers = (int) $dbr->selectField(
497 'watchlist',
498 'COUNT(*)',
499 array(
500 'wl_namespace' => $title->getNamespace(),
501 'wl_title' => $title->getDBkey(),
502 ),
503 __METHOD__
504 );
505 $result['watchers'] = $watchers;
506 }
507
508 // Total number of edits
509 $edits = (int) $dbr->selectField(
510 'revision',
511 'COUNT(rev_page)',
512 array( 'rev_page' => $id ),
513 __METHOD__
514 );
515 $result['edits'] = $edits;
516
517 // Total number of distinct authors
518 $authors = (int) $dbr->selectField(
519 'revision',
520 'COUNT(DISTINCT rev_user_text)',
521 array( 'rev_page' => $id ),
522 __METHOD__
523 );
524 $result['authors'] = $authors;
525
526 // "Recent" threshold defined by $wgRCMaxAge
527 $threshold = $dbr->timestamp( time() - $wgRCMaxAge );
528
529 // Recent number of edits
530 $edits = (int) $dbr->selectField(
531 'revision',
532 'COUNT(rev_page)',
533 array(
534 'rev_page' => $id ,
535 "rev_timestamp >= $threshold"
536 ),
537 __METHOD__
538 );
539 $result['recent_edits'] = $edits;
540
541 // Recent number of distinct authors
542 $authors = (int) $dbr->selectField(
543 'revision',
544 'COUNT(DISTINCT rev_user_text)',
545 array(
546 'rev_page' => $id,
547 "rev_timestamp >= $threshold"
548 ),
549 __METHOD__
550 );
551 $result['recent_authors'] = $authors;
552
553 // Subpages (if enabled)
554 if ( MWNamespace::hasSubpages( $title->getNamespace() ) ) {
555 $conds = array( 'page_namespace' => $title->getNamespace() );
556 $conds[] = 'page_title ' . $dbr->buildLike( $title->getDBkey() . '/', $dbr->anyString() );
557
558 // Subpages of this page (redirects)
559 $conds['page_is_redirect'] = 1;
560 $result['subpages']['redirects'] = (int) $dbr->selectField(
561 'page',
562 'COUNT(page_id)',
563 $conds,
564 __METHOD__ );
565
566 // Subpages of this page (non-redirects)
567 $conds['page_is_redirect'] = 0;
568 $result['subpages']['nonredirects'] = (int) $dbr->selectField(
569 'page',
570 'COUNT(page_id)',
571 $conds,
572 __METHOD__
573 );
574
575 // Subpages of this page (total)
576 $result['subpages']['total'] = $result['subpages']['redirects']
577 + $result['subpages']['nonredirects'];
578 }
579
580 wfProfileOut( __METHOD__ );
581 return $result;
582 }
583
584 /**
585 * Returns the name that goes in the "<h1>" page title.
586 *
587 * @return string
588 */
589 protected function getPageTitle() {
590 return $this->msg( 'pageinfo-title', $this->getTitle()->getPrefixedText() )->text();
591 }
592
593 /**
594 * Get a list of contributors of $article
595 * @return string: html
596 */
597 protected function getContributors() {
598 global $wgHiddenPrefs;
599
600 $contributors = $this->page->getContributors();
601 $real_names = array();
602 $user_names = array();
603 $anon_ips = array();
604
605 # Sift for real versus user names
606 foreach ( $contributors as $user ) {
607 $page = $user->isAnon()
608 ? SpecialPage::getTitleFor( 'Contributions', $user->getName() )
609 : $user->getUserPage();
610
611 if ( $user->getID() == 0 ) {
612 $anon_ips[] = Linker::link( $page, htmlspecialchars( $user->getName() ) );
613 } elseif ( !in_array( 'realname', $wgHiddenPrefs ) && $user->getRealName() ) {
614 $real_names[] = Linker::link( $page, htmlspecialchars( $user->getRealName() ) );
615 } else {
616 $user_names[] = Linker::link( $page, htmlspecialchars( $user->getName() ) );
617 }
618 }
619
620 $lang = $this->getLanguage();
621
622 $real = $lang->listToText( $real_names );
623
624 # "ThisSite user(s) A, B and C"
625 if ( count( $user_names ) ) {
626 $user = $this->msg( 'siteusers' )->rawParams( $lang->listToText( $user_names ) )->params(
627 count( $user_names ) )->escaped();
628 } else {
629 $user = false;
630 }
631
632 if ( count( $anon_ips ) ) {
633 $anon = $this->msg( 'anonusers' )->rawParams( $lang->listToText( $anon_ips ) )->params(
634 count( $anon_ips ) )->escaped();
635 } else {
636 $anon = false;
637 }
638
639 # This is the big list, all mooshed together. We sift for blank strings
640 $fulllist = array();
641 foreach ( array( $real, $user, $anon ) as $s ) {
642 if ( $s !== '' ) {
643 array_push( $fulllist, $s );
644 }
645 }
646
647 $count = count( $fulllist );
648 # "Based on work by ..."
649 return $count
650 ? $this->msg( 'othercontribs' )->rawParams(
651 $lang->listToText( $fulllist ) )->params( $count )->escaped()
652 : '';
653 }
654
655 /**
656 * Returns the description that goes below the "<h1>" tag.
657 *
658 * @return string
659 */
660 protected function getDescription() {
661 return '';
662 }
663 }