merged master
[lhc/web/wiklou.git] / includes / Article.php
1 <?php
2 /**
3 * User interface for page actions.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * Class for viewing MediaWiki article and history.
25 *
26 * This maintains WikiPage functions for backwards compatibility.
27 *
28 * @todo move and rewrite code to an Action class
29 *
30 * See design.txt for an overview.
31 * Note: edit user interface and cache support functions have been
32 * moved to separate EditPage and HTMLFileCache classes.
33 *
34 * @internal documentation reviewed 15 Mar 2010
35 */
36 class Article extends Page {
37 /**@{{
38 * @private
39 */
40
41 /**
42 * The context this Article is executed in
43 * @var IContextSource $mContext
44 */
45 protected $mContext;
46
47 /**
48 * The WikiPage object of this instance
49 * @var WikiPage $mPage
50 */
51 protected $mPage;
52
53 /**
54 * ParserOptions object for $wgUser articles
55 * @var ParserOptions $mParserOptions
56 */
57 public $mParserOptions;
58
59 /**
60 * Text of the revision we are working on
61 * @var string $mContent
62 */
63 var $mContent; // !< #BC cruft
64
65 /**
66 * Content of the revision we are working on
67 * @var Content
68 * @since 1.WD
69 */
70 var $mContentObject; // !<
71
72 /**
73 * Is the content ($mContent) already loaded?
74 * @var bool $mContentLoaded
75 */
76 var $mContentLoaded = false; // !<
77
78 /**
79 * The oldid of the article that is to be shown, 0 for the
80 * current revision
81 * @var int|null $mOldId
82 */
83 var $mOldId; // !<
84
85 /**
86 * Title from which we were redirected here
87 * @var Title $mRedirectedFrom
88 */
89 var $mRedirectedFrom = null;
90
91 /**
92 * URL to redirect to or false if none
93 * @var string|false $mRedirectUrl
94 */
95 var $mRedirectUrl = false; // !<
96
97 /**
98 * Revision ID of revision we are working on
99 * @var int $mRevIdFetched
100 */
101 var $mRevIdFetched = 0; // !<
102
103 /**
104 * Revision we are working on
105 * @var Revision $mRevision
106 */
107 var $mRevision = null;
108
109 /**
110 * ParserOutput object
111 * @var ParserOutput $mParserOutput
112 */
113 var $mParserOutput;
114
115 /**@}}*/
116
117 /**
118 * Constructor and clear the article
119 * @param $title Title Reference to a Title object.
120 * @param $oldId Integer revision ID, null to fetch from request, zero for current
121 */
122 public function __construct( Title $title, $oldId = null ) {
123 $this->mOldId = $oldId;
124 $this->mPage = $this->newPage( $title );
125 }
126
127 /**
128 * @param $title Title
129 * @return WikiPage
130 */
131 protected function newPage( Title $title ) {
132 return new WikiPage( $title );
133 }
134
135 /**
136 * Constructor from a page id
137 * @param $id Int article ID to load
138 * @return Article|null
139 */
140 public static function newFromID( $id ) {
141 $t = Title::newFromID( $id );
142 # @todo FIXME: Doesn't inherit right
143 return $t == null ? null : new self( $t );
144 # return $t == null ? null : new static( $t ); // PHP 5.3
145 }
146
147 /**
148 * Create an Article object of the appropriate class for the given page.
149 *
150 * @param $title Title
151 * @param $context IContextSource
152 * @return Article object
153 */
154 public static function newFromTitle( $title, IContextSource $context ) {
155 if ( NS_MEDIA == $title->getNamespace() ) {
156 // FIXME: where should this go?
157 $title = Title::makeTitle( NS_FILE, $title->getDBkey() );
158 }
159
160 $page = null;
161 wfRunHooks( 'ArticleFromTitle', array( &$title, &$page ) );
162 if ( !$page ) {
163 switch( $title->getNamespace() ) {
164 case NS_FILE:
165 $page = new ImagePage( $title );
166 break;
167 case NS_CATEGORY:
168 $page = new CategoryPage( $title );
169 break;
170 default:
171 $page = new Article( $title );
172 }
173 }
174 $page->setContext( $context );
175
176 return $page;
177 }
178
179 /**
180 * Create an Article object of the appropriate class for the given page.
181 *
182 * @param $page WikiPage
183 * @param $context IContextSource
184 * @return Article object
185 */
186 public static function newFromWikiPage( WikiPage $page, IContextSource $context ) {
187 $article = self::newFromTitle( $page->getTitle(), $context );
188 $article->mPage = $page; // override to keep process cached vars
189 return $article;
190 }
191
192 /**
193 * Tell the page view functions that this view was redirected
194 * from another page on the wiki.
195 * @param $from Title object.
196 */
197 public function setRedirectedFrom( Title $from ) {
198 $this->mRedirectedFrom = $from;
199 }
200
201 /**
202 * Get the title object of the article
203 *
204 * @return Title object of this page
205 */
206 public function getTitle() {
207 return $this->mPage->getTitle();
208 }
209
210 /**
211 * Get the WikiPage object of this instance
212 *
213 * @since 1.19
214 * @return WikiPage
215 */
216 public function getPage() {
217 return $this->mPage;
218 }
219
220 /**
221 * Clear the object
222 */
223 public function clear() {
224 $this->mContentLoaded = false;
225
226 $this->mRedirectedFrom = null; # Title object if set
227 $this->mRevIdFetched = 0;
228 $this->mRedirectUrl = false;
229
230 $this->mPage->clear();
231 }
232
233 /**
234 * Note that getContent/loadContent do not follow redirects anymore.
235 * If you need to fetch redirectable content easily, try
236 * the shortcut in WikiPage::getRedirectTarget()
237 *
238 * This function has side effects! Do not use this function if you
239 * only want the real revision text if any.
240 *
241 * @deprecated in 1.WD; use getContentObject() instead
242 *
243 * @return string Return the text of this revision
244 */
245 public function getContent() {
246 wfDeprecated( __METHOD__, '1.WD' );
247 $content = $this->getContentObject();
248 return ContentHandler::getContentText( $content );
249 }
250
251 /**
252 * Returns a Content object representing the pages effective display content,
253 * not necessarily the revision's content!
254 *
255 * Note that getContent/loadContent do not follow redirects anymore.
256 * If you need to fetch redirectable content easily, try
257 * the shortcut in WikiPage::getRedirectTarget()
258 *
259 * This function has side effects! Do not use this function if you
260 * only want the real revision text if any.
261 *
262 * @return Content Return the content of this revision
263 *
264 * @since 1.WD
265 *
266 * @todo: FIXME: this should really be protected, all callers should be changed to use WikiPage::getContent() instead.
267 */
268 public function getContentObject() {
269 global $wgUser;
270 wfProfileIn( __METHOD__ );
271
272 if ( $this->mPage->getID() === 0 ) {
273 # If this is a MediaWiki:x message, then load the messages
274 # and return the message value for x.
275 if ( $this->getTitle()->getNamespace() == NS_MEDIAWIKI ) {
276 $text = $this->getTitle()->getDefaultMessageText();
277 if ( $text === false ) {
278 $text = '';
279 }
280
281 $content = ContentHandler::makeContent( $text, $this->getTitle() );
282 } else {
283 $content = new MessageContent( $wgUser->isLoggedIn() ? 'noarticletext' : 'noarticletextanon', null, 'parsemag' );
284 }
285 wfProfileOut( __METHOD__ );
286
287 return $content;
288 } else {
289 $this->fetchContentObject();
290 wfProfileOut( __METHOD__ );
291
292 return $this->mContentObject;
293 }
294 }
295
296 /**
297 * @return int The oldid of the article that is to be shown, 0 for the
298 * current revision
299 */
300 public function getOldID() {
301 if ( is_null( $this->mOldId ) ) {
302 $this->mOldId = $this->getOldIDFromRequest();
303 }
304
305 return $this->mOldId;
306 }
307
308 /**
309 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
310 *
311 * @return int The old id for the request
312 */
313 public function getOldIDFromRequest() {
314 $this->mRedirectUrl = false;
315
316 $request = $this->getContext()->getRequest();
317 $oldid = $request->getIntOrNull( 'oldid' );
318
319 if ( $oldid === null ) {
320 return 0;
321 }
322
323 if ( $oldid !== 0 ) {
324 # Load the given revision and check whether the page is another one.
325 # In that case, update this instance to reflect the change.
326 if ( $oldid === $this->mPage->getLatest() ) {
327 $this->mRevision = $this->mPage->getRevision();
328 } else {
329 $this->mRevision = Revision::newFromId( $oldid );
330 if ( $this->mRevision !== null ) {
331 // Revision title doesn't match the page title given?
332 if ( $this->mPage->getID() != $this->mRevision->getPage() ) {
333 $function = array( get_class( $this->mPage ), 'newFromID' );
334 $this->mPage = call_user_func( $function, $this->mRevision->getPage() );
335 }
336 }
337 }
338 }
339
340 if ( $request->getVal( 'direction' ) == 'next' ) {
341 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
342 if ( $nextid ) {
343 $oldid = $nextid;
344 $this->mRevision = null;
345 } else {
346 $this->mRedirectUrl = $this->getTitle()->getFullURL( 'redirect=no' );
347 }
348 } elseif ( $request->getVal( 'direction' ) == 'prev' ) {
349 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
350 if ( $previd ) {
351 $oldid = $previd;
352 $this->mRevision = null;
353 }
354 }
355
356 return $oldid;
357 }
358
359 /**
360 * Load the revision (including text) into this object
361 *
362 * @deprecated in 1.19; use fetchContent()
363 */
364 function loadContent() {
365 wfDeprecated( __METHOD__, '1.19' );
366 $this->fetchContent();
367 }
368
369 /**
370 * Get text of an article from database
371 * Does *NOT* follow redirects.
372 *
373 * @protected
374 * @note this is really internal functionality that should really NOT be used by other functions. For accessing
375 * article content, use the WikiPage class, especially WikiBase::getContent(). However, a lot of legacy code
376 * uses this method to retrieve page text from the database, so the function has to remain public for now.
377 *
378 * @return mixed string containing article contents, or false if null
379 * @deprecated in 1.WD, use WikiPage::getContent() instead
380 */
381 function fetchContent() { #BC cruft!
382 wfDeprecated( __METHOD__, '1.WD' );
383
384 if ( $this->mContentLoaded && $this->mContent ) {
385 return $this->mContent;
386 }
387
388 wfProfileIn( __METHOD__ );
389
390 $content = $this->fetchContentObject();
391
392 $this->mContent = ContentHandler::getContentText( $content ); #@todo: get rid of mContent everywhere!
393 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent ) ); #BC cruft, deprecated!
394
395 wfProfileOut( __METHOD__ );
396
397 return $this->mContent;
398 }
399
400
401 /**
402 * Get text content object
403 * Does *NOT* follow redirects.
404 * TODO: when is this null?
405 *
406 * @note code that wants to retrieve page content from the database should use WikiPage::getContent().
407 *
408 * @return Content|null
409 *
410 * @since 1.WD
411 */
412 protected function fetchContentObject() {
413 if ( $this->mContentLoaded ) {
414 return $this->mContentObject;
415 }
416
417 wfProfileIn( __METHOD__ );
418
419 $this->mContentLoaded = true;
420 $this->mContent = null;
421
422 $oldid = $this->getOldID();
423
424 # Pre-fill content with error message so that if something
425 # fails we'll have something telling us what we intended.
426 $t = $this->getTitle()->getPrefixedText();
427 $d = $oldid ? wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
428 $this->mContentObject = new MessageContent( 'missing-article', array($t, $d), array() ) ; // @todo: this isn't page content but a UI message. horrible.
429
430 if ( $oldid ) {
431 # $this->mRevision might already be fetched by getOldIDFromRequest()
432 if ( !$this->mRevision ) {
433 $this->mRevision = Revision::newFromId( $oldid );
434 if ( !$this->mRevision ) {
435 wfDebug( __METHOD__ . " failed to retrieve specified revision, id $oldid\n" );
436 wfProfileOut( __METHOD__ );
437 return false;
438 }
439 }
440 } else {
441 if ( !$this->mPage->getLatest() ) {
442 wfDebug( __METHOD__ . " failed to find page data for title " . $this->getTitle()->getPrefixedText() . "\n" );
443 wfProfileOut( __METHOD__ );
444 return false;
445 }
446
447 $this->mRevision = $this->mPage->getRevision();
448
449 if ( !$this->mRevision ) {
450 wfDebug( __METHOD__ . " failed to retrieve current page, rev_id " . $this->mPage->getLatest() . "\n" );
451 wfProfileOut( __METHOD__ );
452 return false;
453 }
454 }
455
456 // @todo FIXME: Horrible, horrible! This content-loading interface just plain sucks.
457 // We should instead work with the Revision object when we need it...
458 $this->mContentObject = $this->mRevision->getContent( Revision::FOR_THIS_USER ); // Loads if user is allowed
459 $this->mRevIdFetched = $this->mRevision->getId();
460
461 wfRunHooks( 'ArticleAfterFetchContentObject', array( &$this, &$this->mContentObject ) );
462
463 wfProfileOut( __METHOD__ );
464
465 return $this->mContentObject;
466 }
467
468 /**
469 * No-op
470 * @deprecated since 1.18
471 */
472 public function forUpdate() {
473 wfDeprecated( __METHOD__, '1.18' );
474 }
475
476 /**
477 * Returns true if the currently-referenced revision is the current edit
478 * to this page (and it exists).
479 * @return bool
480 */
481 public function isCurrent() {
482 # If no oldid, this is the current version.
483 if ( $this->getOldID() == 0 ) {
484 return true;
485 }
486
487 return $this->mPage->exists() && $this->mRevision && $this->mRevision->isCurrent();
488 }
489
490 /**
491 * Get the fetched Revision object depending on request parameters or null
492 * on failure.
493 *
494 * @since 1.19
495 * @return Revision|null
496 */
497 public function getRevisionFetched() {
498 $this->fetchContentObject();
499
500 return $this->mRevision;
501 }
502
503 /**
504 * Use this to fetch the rev ID used on page views
505 *
506 * @return int revision ID of last article revision
507 */
508 public function getRevIdFetched() {
509 if ( $this->mRevIdFetched ) {
510 return $this->mRevIdFetched;
511 } else {
512 return $this->mPage->getLatest();
513 }
514 }
515
516 /**
517 * This is the default action of the index.php entry point: just view the
518 * page of the given title.
519 */
520 public function view() {
521 global $wgParser, $wgUseFileCache, $wgUseETag, $wgDebugToolbar;
522
523 wfProfileIn( __METHOD__ );
524
525 # Get variables from query string
526 # As side effect this will load the revision and update the title
527 # in a revision ID is passed in the request, so this should remain
528 # the first call of this method even if $oldid is used way below.
529 $oldid = $this->getOldID();
530
531 $user = $this->getContext()->getUser();
532 # Another whitelist check in case getOldID() is altering the title
533 $permErrors = $this->getTitle()->getUserPermissionsErrors( 'read', $user );
534 if ( count( $permErrors ) ) {
535 wfDebug( __METHOD__ . ": denied on secondary read check\n" );
536 wfProfileOut( __METHOD__ );
537 throw new PermissionsError( 'read', $permErrors );
538 }
539
540 $outputPage = $this->getContext()->getOutput();
541 # getOldID() may as well want us to redirect somewhere else
542 if ( $this->mRedirectUrl ) {
543 $outputPage->redirect( $this->mRedirectUrl );
544 wfDebug( __METHOD__ . ": redirecting due to oldid\n" );
545 wfProfileOut( __METHOD__ );
546
547 return;
548 }
549
550 # If we got diff in the query, we want to see a diff page instead of the article.
551 if ( $this->getContext()->getRequest()->getCheck( 'diff' ) ) {
552 wfDebug( __METHOD__ . ": showing diff page\n" );
553 $this->showDiffPage();
554 wfProfileOut( __METHOD__ );
555
556 return;
557 }
558
559 # Set page title (may be overridden by DISPLAYTITLE)
560 $outputPage->setPageTitle( $this->getTitle()->getPrefixedText() );
561
562 $outputPage->setArticleFlag( true );
563 # Allow frames by default
564 $outputPage->allowClickjacking();
565
566 $parserCache = ParserCache::singleton();
567
568 $parserOptions = $this->getParserOptions();
569 # Render printable version, use printable version cache
570 if ( $outputPage->isPrintable() ) {
571 $parserOptions->setIsPrintable( true );
572 $parserOptions->setEditSection( false );
573 } elseif ( !$this->isCurrent() || !$this->getTitle()->quickUserCan( 'edit', $user ) ) {
574 $parserOptions->setEditSection( false );
575 }
576
577 # Try client and file cache
578 if ( !$wgDebugToolbar && $oldid === 0 && $this->mPage->checkTouched() ) {
579 if ( $wgUseETag ) {
580 $outputPage->setETag( $parserCache->getETag( $this, $parserOptions ) );
581 }
582
583 # Is it client cached?
584 if ( $outputPage->checkLastModified( $this->mPage->getTouched() ) ) {
585 wfDebug( __METHOD__ . ": done 304\n" );
586 wfProfileOut( __METHOD__ );
587
588 return;
589 # Try file cache
590 } elseif ( $wgUseFileCache && $this->tryFileCache() ) {
591 wfDebug( __METHOD__ . ": done file cache\n" );
592 # tell wgOut that output is taken care of
593 $outputPage->disable();
594 $this->mPage->doViewUpdates( $user );
595 wfProfileOut( __METHOD__ );
596
597 return;
598 }
599 }
600
601 # Should the parser cache be used?
602 $useParserCache = $this->mPage->isParserCacheUsed( $parserOptions, $oldid );
603 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
604 if ( $user->getStubThreshold() ) {
605 wfIncrStats( 'pcache_miss_stub' );
606 }
607
608 $this->showRedirectedFromHeader();
609 $this->showNamespaceHeader();
610
611 # Iterate through the possible ways of constructing the output text.
612 # Keep going until $outputDone is set, or we run out of things to do.
613 $pass = 0;
614 $outputDone = false;
615 $this->mParserOutput = false;
616
617 while ( !$outputDone && ++$pass ) {
618 switch( $pass ) {
619 case 1:
620 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
621 break;
622 case 2:
623 # Early abort if the page doesn't exist
624 if ( !$this->mPage->exists() ) {
625 wfDebug( __METHOD__ . ": showing missing article\n" );
626 $this->showMissingArticle();
627 wfProfileOut( __METHOD__ );
628 return;
629 }
630
631 # Try the parser cache
632 if ( $useParserCache ) {
633 $this->mParserOutput = $parserCache->get( $this, $parserOptions );
634
635 if ( $this->mParserOutput !== false ) {
636 if ( $oldid ) {
637 wfDebug( __METHOD__ . ": showing parser cache contents for current rev permalink\n" );
638 $this->setOldSubtitle( $oldid );
639 } else {
640 wfDebug( __METHOD__ . ": showing parser cache contents\n" );
641 }
642 $outputPage->addParserOutput( $this->mParserOutput );
643 # Ensure that UI elements requiring revision ID have
644 # the correct version information.
645 $outputPage->setRevisionId( $this->mPage->getLatest() );
646 # Preload timestamp to avoid a DB hit
647 $cachedTimestamp = $this->mParserOutput->getTimestamp();
648 if ( $cachedTimestamp !== null ) {
649 $outputPage->setRevisionTimestamp( $cachedTimestamp );
650 $this->mPage->setTimestamp( $cachedTimestamp );
651 }
652 $outputDone = true;
653 }
654 }
655 break;
656 case 3:
657 # This will set $this->mRevision if needed
658 $this->fetchContentObject();
659
660 # Are we looking at an old revision
661 if ( $oldid && $this->mRevision ) {
662 $this->setOldSubtitle( $oldid );
663
664 if ( !$this->showDeletedRevisionHeader() ) {
665 wfDebug( __METHOD__ . ": cannot view deleted revision\n" );
666 wfProfileOut( __METHOD__ );
667 return;
668 }
669 }
670
671 # Ensure that UI elements requiring revision ID have
672 # the correct version information.
673 $outputPage->setRevisionId( $this->getRevIdFetched() );
674 # Preload timestamp to avoid a DB hit
675 $outputPage->setRevisionTimestamp( $this->getTimestamp() );
676
677 # Pages containing custom CSS or JavaScript get special treatment
678 if ( $this->getTitle()->isCssOrJsPage() || $this->getTitle()->isCssJsSubpage() ) {
679 wfDebug( __METHOD__ . ": showing CSS/JS source\n" );
680 $this->showCssOrJsPage();
681 $outputDone = true;
682 } elseif( !wfRunHooks( 'ArticleContentViewCustom', array( $this->fetchContentObject(), $this->getTitle(), $outputPage ) ) ) {
683 # Allow extensions do their own custom view for certain pages
684 $outputDone = true;
685 } elseif( Hooks::isRegistered( 'ArticleViewCustom' ) && !wfRunHooks( 'ArticleViewCustom', array( $this->fetchContent(), $this->getTitle(), $outputPage ) ) ) { #FIXME: fetchContent() is deprecated!
686 # Allow extensions do their own custom view for certain pages
687 $outputDone = true;
688 } else {
689 $content = $this->getContentObject();
690 $rt = $content->getRedirectChain();
691 if ( $rt ) {
692 wfDebug( __METHOD__ . ": showing redirect=no page\n" );
693 # Viewing a redirect page (e.g. with parameter redirect=no)
694 $outputPage->addHTML( $this->viewRedirect( $rt ) );
695 # Parse just to get categories, displaytitle, etc.
696 $this->mParserOutput = $content->getParserOutput( $this->getTitle(), $oldid, $parserOptions, false );
697 $outputPage->addParserOutputNoText( $this->mParserOutput );
698 $outputDone = true;
699 }
700 }
701 break;
702 case 4:
703 # Run the parse, protected by a pool counter
704 wfDebug( __METHOD__ . ": doing uncached parse\n" );
705
706 // @todo: shouldn't we be passing $this->getPage() to PoolWorkArticleView instead of plain $this?
707 $poolArticleView = new PoolWorkArticleView( $this, $parserOptions,
708 $this->getRevIdFetched(), $useParserCache, $this->getContentObject(), $this->getContext() );
709
710 if ( !$poolArticleView->execute() ) {
711 $error = $poolArticleView->getError();
712 if ( $error ) {
713 $outputPage->clearHTML(); // for release() errors
714 $outputPage->enableClientCache( false );
715 $outputPage->setRobotPolicy( 'noindex,nofollow' );
716
717 $errortext = $error->getWikiText( false, 'view-pool-error' );
718 $outputPage->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );
719 }
720 # Connection or timeout error
721 wfProfileOut( __METHOD__ );
722 return;
723 }
724
725 $this->mParserOutput = $poolArticleView->getParserOutput();
726 $outputPage->addParserOutput( $this->mParserOutput );
727
728 # Don't cache a dirty ParserOutput object
729 if ( $poolArticleView->getIsDirty() ) {
730 $outputPage->setSquidMaxage( 0 );
731 $outputPage->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
732 }
733
734 $outputDone = true;
735 break;
736 # Should be unreachable, but just in case...
737 default:
738 break 2;
739 }
740 }
741
742 # Get the ParserOutput actually *displayed* here.
743 # Note that $this->mParserOutput is the *current* version output.
744 $pOutput = ( $outputDone instanceof ParserOutput )
745 ? $outputDone // object fetched by hook
746 : $this->mParserOutput;
747
748 # Adjust title for main page & pages with displaytitle
749 if ( $pOutput ) {
750 $this->adjustDisplayTitle( $pOutput );
751 }
752
753 # For the main page, overwrite the <title> element with the con-
754 # tents of 'pagetitle-view-mainpage' instead of the default (if
755 # that's not empty).
756 # This message always exists because it is in the i18n files
757 if ( $this->getTitle()->isMainPage() ) {
758 $msg = wfMessage( 'pagetitle-view-mainpage' )->inContentLanguage();
759 if ( !$msg->isDisabled() ) {
760 $outputPage->setHTMLTitle( $msg->title( $this->getTitle() )->text() );
761 }
762 }
763
764 # Check for any __NOINDEX__ tags on the page using $pOutput
765 $policy = $this->getRobotPolicy( 'view', $pOutput );
766 $outputPage->setIndexPolicy( $policy['index'] );
767 $outputPage->setFollowPolicy( $policy['follow'] );
768
769 $this->showViewFooter();
770 $this->mPage->doViewUpdates( $user );
771
772 wfProfileOut( __METHOD__ );
773 }
774
775 /**
776 * Adjust title for pages with displaytitle, -{T|}- or language conversion
777 * @param $pOutput ParserOutput
778 */
779 public function adjustDisplayTitle( ParserOutput $pOutput ) {
780 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
781 $titleText = $pOutput->getTitleText();
782 if ( strval( $titleText ) !== '' ) {
783 $this->getContext()->getOutput()->setPageTitle( $titleText );
784 }
785 }
786
787 /**
788 * Show a diff page according to current request variables. For use within
789 * Article::view() only, other callers should use the DifferenceEngine class.
790 */
791 public function showDiffPage() {
792 $request = $this->getContext()->getRequest();
793 $user = $this->getContext()->getUser();
794 $diff = $request->getVal( 'diff' );
795 $rcid = $request->getVal( 'rcid' );
796 $diffOnly = $request->getBool( 'diffonly', $user->getOption( 'diffonly' ) );
797 $purge = $request->getVal( 'action' ) == 'purge';
798 $unhide = $request->getInt( 'unhide' ) == 1;
799 $oldid = $this->getOldID();
800
801 $contentHandler = ContentHandler::getForTitle( $this->getTitle() );
802 $de = $contentHandler->createDifferenceEngine( $this->getContext(), $oldid, $diff, $rcid, $purge, $unhide );
803
804 // DifferenceEngine directly fetched the revision:
805 $this->mRevIdFetched = $de->mNewid;
806 $de->showDiffPage( $diffOnly );
807
808 if ( $diff == 0 || $diff == $this->mPage->getLatest() ) {
809 # Run view updates for current revision only
810 $this->mPage->doViewUpdates( $user );
811 }
812 }
813
814 /**
815 * Show a page view for a page formatted as CSS or JavaScript. To be called by
816 * Article::view() only.
817 *
818 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
819 * page views.
820 */
821 protected function showCssOrJsPage( $showCacheHint = true ) {
822 global $wgOut;
823
824 if ( $showCacheHint ) {
825 $dir = $this->getContext()->getLanguage()->getDir();
826 $lang = $this->getContext()->getLanguage()->getCode();
827
828 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache' lang='$lang' dir='$dir' class='mw-content-$dir'>\n$1\n</div>",
829 'clearyourcache' );
830 }
831
832 // Give hooks a chance to customise the output
833 if ( !Hooks::isRegistered('ShowRawCssJs') || wfRunHooks( 'ShowRawCssJs', array( $this->fetchContent(), $this->getTitle(), $wgOut ) ) ) { #FIXME: fetchContent() is deprecated
834 $po = $this->mContentObject->getParserOutput( $this->getTitle() );
835 $wgOut->addHTML( $po->getText() );
836 }
837 }
838
839 /**
840 * Get the robot policy to be used for the current view
841 * @param $action String the action= GET parameter
842 * @param $pOutput ParserOutput
843 * @return Array the policy that should be set
844 * TODO: actions other than 'view'
845 */
846 public function getRobotPolicy( $action, $pOutput ) {
847 global $wgArticleRobotPolicies, $wgNamespaceRobotPolicies, $wgDefaultRobotPolicy;
848
849 $ns = $this->getTitle()->getNamespace();
850
851 if ( $ns == NS_USER || $ns == NS_USER_TALK ) {
852 # Don't index user and user talk pages for blocked users (bug 11443)
853 if ( !$this->getTitle()->isSubpage() ) {
854 if ( Block::newFromTarget( null, $this->getTitle()->getText() ) instanceof Block ) {
855 return array(
856 'index' => 'noindex',
857 'follow' => 'nofollow'
858 );
859 }
860 }
861 }
862
863 if ( $this->mPage->getID() === 0 || $this->getOldID() ) {
864 # Non-articles (special pages etc), and old revisions
865 return array(
866 'index' => 'noindex',
867 'follow' => 'nofollow'
868 );
869 } elseif ( $this->getContext()->getOutput()->isPrintable() ) {
870 # Discourage indexing of printable versions, but encourage following
871 return array(
872 'index' => 'noindex',
873 'follow' => 'follow'
874 );
875 } elseif ( $this->getContext()->getRequest()->getInt( 'curid' ) ) {
876 # For ?curid=x urls, disallow indexing
877 return array(
878 'index' => 'noindex',
879 'follow' => 'follow'
880 );
881 }
882
883 # Otherwise, construct the policy based on the various config variables.
884 $policy = self::formatRobotPolicy( $wgDefaultRobotPolicy );
885
886 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
887 # Honour customised robot policies for this namespace
888 $policy = array_merge(
889 $policy,
890 self::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
891 );
892 }
893 if ( $this->getTitle()->canUseNoindex() && is_object( $pOutput ) && $pOutput->getIndexPolicy() ) {
894 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
895 # a final sanity check that we have really got the parser output.
896 $policy = array_merge(
897 $policy,
898 array( 'index' => $pOutput->getIndexPolicy() )
899 );
900 }
901
902 if ( isset( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] ) ) {
903 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
904 $policy = array_merge(
905 $policy,
906 self::formatRobotPolicy( $wgArticleRobotPolicies[$this->getTitle()->getPrefixedText()] )
907 );
908 }
909
910 return $policy;
911 }
912
913 /**
914 * Converts a String robot policy into an associative array, to allow
915 * merging of several policies using array_merge().
916 * @param $policy Mixed, returns empty array on null/false/'', transparent
917 * to already-converted arrays, converts String.
918 * @return Array: 'index' => \<indexpolicy\>, 'follow' => \<followpolicy\>
919 */
920 public static function formatRobotPolicy( $policy ) {
921 if ( is_array( $policy ) ) {
922 return $policy;
923 } elseif ( !$policy ) {
924 return array();
925 }
926
927 $policy = explode( ',', $policy );
928 $policy = array_map( 'trim', $policy );
929
930 $arr = array();
931 foreach ( $policy as $var ) {
932 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
933 $arr['index'] = $var;
934 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
935 $arr['follow'] = $var;
936 }
937 }
938
939 return $arr;
940 }
941
942 /**
943 * If this request is a redirect view, send "redirected from" subtitle to
944 * the output. Returns true if the header was needed, false if this is not
945 * a redirect view. Handles both local and remote redirects.
946 *
947 * @return boolean
948 */
949 public function showRedirectedFromHeader() {
950 global $wgRedirectSources;
951 $outputPage = $this->getContext()->getOutput();
952
953 $rdfrom = $this->getContext()->getRequest()->getVal( 'rdfrom' );
954
955 if ( isset( $this->mRedirectedFrom ) ) {
956 // This is an internally redirected page view.
957 // We'll need a backlink to the source page for navigation.
958 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
959 $redir = Linker::linkKnown(
960 $this->mRedirectedFrom,
961 null,
962 array(),
963 array( 'redirect' => 'no' )
964 );
965
966 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
967
968 // Set the fragment if one was specified in the redirect
969 if ( strval( $this->getTitle()->getFragment() ) != '' ) {
970 $fragment = Xml::escapeJsString( $this->getTitle()->getFragmentForURL() );
971 $outputPage->addInlineScript( "redirectToFragment(\"$fragment\");" );
972 }
973
974 // Add a <link rel="canonical"> tag
975 $outputPage->addLink( array( 'rel' => 'canonical',
976 'href' => $this->getTitle()->getLocalURL() )
977 );
978
979 // Tell the output object that the user arrived at this article through a redirect
980 $outputPage->setRedirectedFrom( $this->mRedirectedFrom );
981
982 return true;
983 }
984 } elseif ( $rdfrom ) {
985 // This is an externally redirected view, from some other wiki.
986 // If it was reported from a trusted site, supply a backlink.
987 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
988 $redir = Linker::makeExternalLink( $rdfrom, $rdfrom );
989 $outputPage->addSubtitle( wfMessage( 'redirectedfrom' )->rawParams( $redir ) );
990
991 return true;
992 }
993 }
994
995 return false;
996 }
997
998 /**
999 * Show a header specific to the namespace currently being viewed, like
1000 * [[MediaWiki:Talkpagetext]]. For Article::view().
1001 */
1002 public function showNamespaceHeader() {
1003 if ( $this->getTitle()->isTalkPage() ) {
1004 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1005 $this->getContext()->getOutput()->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1006 }
1007 }
1008 }
1009
1010 /**
1011 * Show the footer section of an ordinary page view
1012 */
1013 public function showViewFooter() {
1014 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1015 if ( $this->getTitle()->getNamespace() == NS_USER_TALK && IP::isValid( $this->getTitle()->getText() ) ) {
1016 $this->getContext()->getOutput()->addWikiMsg( 'anontalkpagetext' );
1017 }
1018
1019 # If we have been passed an &rcid= parameter, we want to give the user a
1020 # chance to mark this new article as patrolled.
1021 $this->showPatrolFooter();
1022
1023 wfRunHooks( 'ArticleViewFooter', array( $this ) );
1024
1025 }
1026
1027 /**
1028 * If patrol is possible, output a patrol UI box. This is called from the
1029 * footer section of ordinary page views. If patrol is not possible or not
1030 * desired, does nothing.
1031 */
1032 public function showPatrolFooter() {
1033 $request = $this->getContext()->getRequest();
1034 $outputPage = $this->getContext()->getOutput();
1035 $user = $this->getContext()->getUser();
1036 $rcid = $request->getVal( 'rcid' );
1037
1038 if ( !$rcid || !$this->getTitle()->quickUserCan( 'patrol', $user ) ) {
1039 return;
1040 }
1041
1042 $token = $user->getEditToken( $rcid );
1043 $outputPage->preventClickjacking();
1044
1045 $outputPage->addHTML(
1046 "<div class='patrollink'>" .
1047 wfMsgHtml(
1048 'markaspatrolledlink',
1049 Linker::linkKnown(
1050 $this->getTitle(),
1051 wfMsgHtml( 'markaspatrolledtext' ),
1052 array(),
1053 array(
1054 'action' => 'markpatrolled',
1055 'rcid' => $rcid,
1056 'token' => $token,
1057 )
1058 )
1059 ) .
1060 '</div>'
1061 );
1062 }
1063
1064 /**
1065 * Show the error text for a missing article. For articles in the MediaWiki
1066 * namespace, show the default message text. To be called from Article::view().
1067 */
1068 public function showMissingArticle() {
1069 global $wgSend404Code;
1070 $outputPage = $this->getContext()->getOutput();
1071
1072 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1073 if ( $this->getTitle()->getNamespace() == NS_USER || $this->getTitle()->getNamespace() == NS_USER_TALK ) {
1074 $parts = explode( '/', $this->getTitle()->getText() );
1075 $rootPart = $parts[0];
1076 $user = User::newFromName( $rootPart, false /* allow IP users*/ );
1077 $ip = User::isIP( $rootPart );
1078
1079 if ( !($user && $user->isLoggedIn()) && !$ip ) { # User does not exist
1080 $outputPage->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1081 array( 'userpage-userdoesnotexist-view', wfEscapeWikiText( $rootPart ) ) );
1082 } elseif ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1083 LogEventsList::showLogExtract(
1084 $outputPage,
1085 'block',
1086 $user->getUserPage()->getPrefixedText(),
1087 '',
1088 array(
1089 'lim' => 1,
1090 'showIfEmpty' => false,
1091 'msgKey' => array(
1092 'blocked-notice-logextract',
1093 $user->getName() # Support GENDER in notice
1094 )
1095 )
1096 );
1097 }
1098 }
1099
1100 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1101
1102 # Show delete and move logs
1103 LogEventsList::showLogExtract( $outputPage, array( 'delete', 'move' ), $this->getTitle()->getPrefixedText(), '',
1104 array( 'lim' => 10,
1105 'conds' => array( "log_action != 'revision'" ),
1106 'showIfEmpty' => false,
1107 'msgKey' => array( 'moveddeleted-notice' ) )
1108 );
1109
1110 if ( !$this->mPage->hasViewableContent() && $wgSend404Code ) {
1111 // If there's no backing content, send a 404 Not Found
1112 // for better machine handling of broken links.
1113 $this->getContext()->getRequest()->response()->header( "HTTP/1.1 404 Not Found" );
1114 }
1115
1116 $hookResult = wfRunHooks( 'BeforeDisplayNoArticleText', array( $this ) );
1117
1118 if ( ! $hookResult ) {
1119 return;
1120 }
1121
1122 # Show error message
1123 $oldid = $this->getOldID();
1124 if ( $oldid ) {
1125 $text = wfMsgNoTrans( 'missing-article',
1126 $this->getTitle()->getPrefixedText(),
1127 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1128 } elseif ( $this->getTitle()->getNamespace() === NS_MEDIAWIKI ) {
1129 // Use the default message text
1130 $text = $this->getTitle()->getDefaultMessageText();
1131 } elseif ( $this->getTitle()->quickUserCan( 'create', $this->getContext()->getUser() )
1132 && $this->getTitle()->quickUserCan( 'edit', $this->getContext()->getUser() )
1133 ) {
1134 $text = wfMsgNoTrans( 'noarticletext' );
1135 } else {
1136 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1137 }
1138 $text = "<div class='noarticletext'>\n$text\n</div>";
1139
1140 $outputPage->addWikiText( $text );
1141 }
1142
1143 /**
1144 * If the revision requested for view is deleted, check permissions.
1145 * Send either an error message or a warning header to the output.
1146 *
1147 * @return boolean true if the view is allowed, false if not.
1148 */
1149 public function showDeletedRevisionHeader() {
1150 if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
1151 // Not deleted
1152 return true;
1153 }
1154
1155 $outputPage = $this->getContext()->getOutput();
1156 $user = $this->getContext()->getUser();
1157 // If the user is not allowed to see it...
1158 if ( !$this->mRevision->userCan( Revision::DELETED_TEXT, $user ) ) {
1159 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1160 'rev-deleted-text-permission' );
1161
1162 return false;
1163 // If the user needs to confirm that they want to see it...
1164 } elseif ( $this->getContext()->getRequest()->getInt( 'unhide' ) != 1 ) {
1165 # Give explanation and add a link to view the revision...
1166 $oldid = intval( $this->getOldID() );
1167 $link = $this->getTitle()->getFullUrl( "oldid={$oldid}&unhide=1" );
1168 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1169 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1170 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1171 array( $msg, $link ) );
1172
1173 return false;
1174 // We are allowed to see...
1175 } else {
1176 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1177 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1178 $outputPage->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1179
1180 return true;
1181 }
1182 }
1183
1184 /**
1185 * Generate the navigation links when browsing through an article revisions
1186 * It shows the information as:
1187 * Revision as of \<date\>; view current revision
1188 * \<- Previous version | Next Version -\>
1189 *
1190 * @param $oldid int: revision ID of this article revision
1191 */
1192 public function setOldSubtitle( $oldid = 0 ) {
1193 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
1194 return;
1195 }
1196
1197 $unhide = $this->getContext()->getRequest()->getInt( 'unhide' ) == 1;
1198
1199 # Cascade unhide param in links for easy deletion browsing
1200 $extraParams = array();
1201 if ( $unhide ) {
1202 $extraParams['unhide'] = 1;
1203 }
1204
1205 if ( $this->mRevision && $this->mRevision->getId() === $oldid ) {
1206 $revision = $this->mRevision;
1207 } else {
1208 $revision = Revision::newFromId( $oldid );
1209 }
1210
1211 $timestamp = $revision->getTimestamp();
1212
1213 $current = ( $oldid == $this->mPage->getLatest() );
1214 $language = $this->getContext()->getLanguage();
1215 $user = $this->getContext()->getUser();
1216
1217 $td = $language->userTimeAndDate( $timestamp, $user );
1218 $tddate = $language->userDate( $timestamp, $user );
1219 $tdtime = $language->userTime( $timestamp, $user );
1220
1221 # Show user links if allowed to see them. If hidden, then show them only if requested...
1222 $userlinks = Linker::revUserTools( $revision, !$unhide );
1223
1224 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
1225 ? 'revision-info-current'
1226 : 'revision-info';
1227
1228 $outputPage = $this->getContext()->getOutput();
1229 $outputPage->addSubtitle( "<div id=\"mw-{$infomsg}\">" . wfMessage( $infomsg,
1230 $td )->rawParams( $userlinks )->params( $revision->getID(), $tddate,
1231 $tdtime, $revision->getUser() )->parse() . "</div>" );
1232
1233 $lnk = $current
1234 ? wfMsgHtml( 'currentrevisionlink' )
1235 : Linker::linkKnown(
1236 $this->getTitle(),
1237 wfMsgHtml( 'currentrevisionlink' ),
1238 array(),
1239 $extraParams
1240 );
1241 $curdiff = $current
1242 ? wfMsgHtml( 'diff' )
1243 : Linker::linkKnown(
1244 $this->getTitle(),
1245 wfMsgHtml( 'diff' ),
1246 array(),
1247 array(
1248 'diff' => 'cur',
1249 'oldid' => $oldid
1250 ) + $extraParams
1251 );
1252 $prev = $this->getTitle()->getPreviousRevisionID( $oldid ) ;
1253 $prevlink = $prev
1254 ? Linker::linkKnown(
1255 $this->getTitle(),
1256 wfMsgHtml( 'previousrevision' ),
1257 array(),
1258 array(
1259 'direction' => 'prev',
1260 'oldid' => $oldid
1261 ) + $extraParams
1262 )
1263 : wfMsgHtml( 'previousrevision' );
1264 $prevdiff = $prev
1265 ? Linker::linkKnown(
1266 $this->getTitle(),
1267 wfMsgHtml( 'diff' ),
1268 array(),
1269 array(
1270 'diff' => 'prev',
1271 'oldid' => $oldid
1272 ) + $extraParams
1273 )
1274 : wfMsgHtml( 'diff' );
1275 $nextlink = $current
1276 ? wfMsgHtml( 'nextrevision' )
1277 : Linker::linkKnown(
1278 $this->getTitle(),
1279 wfMsgHtml( 'nextrevision' ),
1280 array(),
1281 array(
1282 'direction' => 'next',
1283 'oldid' => $oldid
1284 ) + $extraParams
1285 );
1286 $nextdiff = $current
1287 ? wfMsgHtml( 'diff' )
1288 : Linker::linkKnown(
1289 $this->getTitle(),
1290 wfMsgHtml( 'diff' ),
1291 array(),
1292 array(
1293 'diff' => 'next',
1294 'oldid' => $oldid
1295 ) + $extraParams
1296 );
1297
1298 $cdel = Linker::getRevDeleteLink( $user, $revision, $this->getTitle() );
1299 if ( $cdel !== '' ) {
1300 $cdel .= ' ';
1301 }
1302
1303 $outputPage->addSubtitle( "<div id=\"mw-revision-nav\">" . $cdel .
1304 wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
1305 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>" );
1306 }
1307
1308 /**
1309 * View redirect
1310 *
1311 * @param $target Title|Array of destination(s) to redirect
1312 * @param $appendSubtitle Boolean [optional]
1313 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1314 * @return string containing HMTL with redirect link
1315 */
1316 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1317 global $wgStylePath;
1318
1319 if ( !is_array( $target ) ) {
1320 $target = array( $target );
1321 }
1322
1323 $lang = $this->getTitle()->getPageLanguage();
1324 $imageDir = $lang->getDir();
1325
1326 if ( $appendSubtitle ) {
1327 $this->getContext()->getOutput()->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1328 }
1329
1330 // the loop prepends the arrow image before the link, so the first case needs to be outside
1331
1332 /**
1333 * @var $title Title
1334 */
1335 $title = array_shift( $target );
1336
1337 if ( $forceKnown ) {
1338 $link = Linker::linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1339 } else {
1340 $link = Linker::link( $title, htmlspecialchars( $title->getFullText() ) );
1341 }
1342
1343 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1344 $alt = $lang->isRTL() ? '←' : '→';
1345 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1346 foreach ( $target as $rt ) {
1347 $link .= Html::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1348 if ( $forceKnown ) {
1349 $link .= Linker::linkKnown( $rt, htmlspecialchars( $rt->getFullText(), array(), array( 'redirect' => 'no' ) ) );
1350 } else {
1351 $link .= Linker::link( $rt, htmlspecialchars( $rt->getFullText() ), array(), array( 'redirect' => 'no' ) );
1352 }
1353 }
1354
1355 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1356 return '<div class="redirectMsg">' .
1357 Html::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1358 '<span class="redirectText">' . $link . '</span></div>';
1359 }
1360
1361 /**
1362 * Handle action=render
1363 */
1364 public function render() {
1365 $this->getContext()->getOutput()->setArticleBodyOnly( true );
1366 $this->view();
1367 }
1368
1369 /**
1370 * action=protect handler
1371 */
1372 public function protect() {
1373 $form = new ProtectionForm( $this );
1374 $form->execute();
1375 }
1376
1377 /**
1378 * action=unprotect handler (alias)
1379 */
1380 public function unprotect() {
1381 $this->protect();
1382 }
1383
1384 /**
1385 * UI entry point for page deletion
1386 */
1387 public function delete() {
1388 # This code desperately needs to be totally rewritten
1389
1390 $title = $this->getTitle();
1391 $user = $this->getContext()->getUser();
1392
1393 # Check permissions
1394 $permission_errors = $title->getUserPermissionsErrors( 'delete', $user );
1395 if ( count( $permission_errors ) ) {
1396 throw new PermissionsError( 'delete', $permission_errors );
1397 }
1398
1399 # Read-only check...
1400 if ( wfReadOnly() ) {
1401 throw new ReadOnlyError;
1402 }
1403
1404 # Better double-check that it hasn't been deleted yet!
1405 $this->mPage->loadPageData( 'fromdbmaster' );
1406 if ( !$this->mPage->exists() ) {
1407 $outputPage = $this->getContext()->getOutput();
1408 $outputPage->setPageTitle( wfMessage( 'cannotdelete-title', $title->getPrefixedText() ) );
1409 $outputPage->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1410 array( 'cannotdelete', wfEscapeWikiText( $title->getPrefixedText() ) )
1411 );
1412 $outputPage->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
1413 LogEventsList::showLogExtract(
1414 $outputPage,
1415 'delete',
1416 $title->getPrefixedText()
1417 );
1418
1419 return;
1420 }
1421
1422 $request = $this->getContext()->getRequest();
1423 $deleteReasonList = $request->getText( 'wpDeleteReasonList', 'other' );
1424 $deleteReason = $request->getText( 'wpReason' );
1425
1426 if ( $deleteReasonList == 'other' ) {
1427 $reason = $deleteReason;
1428 } elseif ( $deleteReason != '' ) {
1429 // Entry from drop down menu + additional comment
1430 $reason = $deleteReasonList . wfMsgForContent( 'colon-separator' ) . $deleteReason;
1431 } else {
1432 $reason = $deleteReasonList;
1433 }
1434
1435 if ( $request->wasPosted() && $user->matchEditToken( $request->getVal( 'wpEditToken' ),
1436 array( 'delete', $this->getTitle()->getPrefixedText() ) ) )
1437 {
1438 # Flag to hide all contents of the archived revisions
1439 $suppress = $request->getVal( 'wpSuppress' ) && $user->isAllowed( 'suppressrevision' );
1440
1441 $this->doDelete( $reason, $suppress );
1442
1443 if ( $user->isLoggedIn() && $request->getCheck( 'wpWatch' ) != $user->isWatched( $title ) ) {
1444 if ( $request->getCheck( 'wpWatch' ) ) {
1445 WatchAction::doWatch( $title, $user );
1446 } else {
1447 WatchAction::doUnwatch( $title, $user );
1448 }
1449 }
1450
1451 return;
1452 }
1453
1454 // Generate deletion reason
1455 $hasHistory = false;
1456 if ( !$reason ) {
1457 try {
1458 $reason = $this->generateReason( $hasHistory );
1459 } catch (MWException $e) {
1460 # if a page is horribly broken, we still want to be able to delete it. so be lenient about errors here.
1461 wfDebug("Error while building auto delete summary: $e");
1462 $reason = '';
1463 }
1464 }
1465
1466 // If the page has a history, insert a warning
1467 if ( $hasHistory ) {
1468 $revisions = $this->mTitle->estimateRevisionCount();
1469 // @todo FIXME: i18n issue/patchwork message
1470 $this->getContext()->getOutput()->addHTML( '<strong class="mw-delete-warning-revisions">' .
1471 wfMsgExt( 'historywarning', array( 'parseinline' ), $this->getContext()->getLanguage()->formatNum( $revisions ) ) .
1472 wfMsgHtml( 'word-separator' ) . Linker::link( $title,
1473 wfMsgHtml( 'history' ),
1474 array( 'rel' => 'archives' ),
1475 array( 'action' => 'history' ) ) .
1476 '</strong>'
1477 );
1478
1479 if ( $this->mTitle->isBigDeletion() ) {
1480 global $wgDeleteRevisionsLimit;
1481 $this->getContext()->getOutput()->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
1482 array( 'delete-warning-toobig', $this->getContext()->getLanguage()->formatNum( $wgDeleteRevisionsLimit ) ) );
1483 }
1484 }
1485
1486 $this->confirmDelete( $reason );
1487 }
1488
1489 /**
1490 * Output deletion confirmation dialog
1491 * @todo FIXME: Move to another file?
1492 * @param $reason String: prefilled reason
1493 */
1494 public function confirmDelete( $reason ) {
1495 wfDebug( "Article::confirmDelete\n" );
1496
1497 $outputPage = $this->getContext()->getOutput();
1498 $outputPage->setPageTitle( wfMessage( 'delete-confirm', $this->getTitle()->getPrefixedText() ) );
1499 $outputPage->addBacklinkSubtitle( $this->getTitle() );
1500 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1501 $outputPage->addWikiMsg( 'confirmdeletetext' );
1502
1503 wfRunHooks( 'ArticleConfirmDelete', array( $this, $outputPage, &$reason ) );
1504
1505 $user = $this->getContext()->getUser();
1506
1507 if ( $user->isAllowed( 'suppressrevision' ) ) {
1508 $suppress = "<tr id=\"wpDeleteSuppressRow\">
1509 <td></td>
1510 <td class='mw-input'><strong>" .
1511 Xml::checkLabel( wfMsg( 'revdelete-suppress' ),
1512 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
1513 "</strong></td>
1514 </tr>";
1515 } else {
1516 $suppress = '';
1517 }
1518 $checkWatch = $user->getBoolOption( 'watchdeletion' ) || $user->isWatched( $this->getTitle() );
1519
1520 $form = Xml::openElement( 'form', array( 'method' => 'post',
1521 'action' => $this->getTitle()->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
1522 Xml::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
1523 Xml::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
1524 Xml::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
1525 "<tr id=\"wpDeleteReasonListRow\">
1526 <td class='mw-label'>" .
1527 Xml::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
1528 "</td>
1529 <td class='mw-input'>" .
1530 Xml::listDropDown( 'wpDeleteReasonList',
1531 wfMsgForContent( 'deletereason-dropdown' ),
1532 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
1533 "</td>
1534 </tr>
1535 <tr id=\"wpDeleteReasonRow\">
1536 <td class='mw-label'>" .
1537 Xml::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
1538 "</td>
1539 <td class='mw-input'>" .
1540 Html::input( 'wpReason', $reason, 'text', array(
1541 'size' => '60',
1542 'maxlength' => '255',
1543 'tabindex' => '2',
1544 'id' => 'wpReason',
1545 'autofocus'
1546 ) ) .
1547 "</td>
1548 </tr>";
1549
1550 # Disallow watching if user is not logged in
1551 if ( $user->isLoggedIn() ) {
1552 $form .= "
1553 <tr>
1554 <td></td>
1555 <td class='mw-input'>" .
1556 Xml::checkLabel( wfMsg( 'watchthis' ),
1557 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
1558 "</td>
1559 </tr>";
1560 }
1561
1562 $form .= "
1563 $suppress
1564 <tr>
1565 <td></td>
1566 <td class='mw-submit'>" .
1567 Xml::submitButton( wfMsg( 'deletepage' ),
1568 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
1569 "</td>
1570 </tr>" .
1571 Xml::closeElement( 'table' ) .
1572 Xml::closeElement( 'fieldset' ) .
1573 Html::hidden( 'wpEditToken', $user->getEditToken( array( 'delete', $this->getTitle()->getPrefixedText() ) ) ) .
1574 Xml::closeElement( 'form' );
1575
1576 if ( $user->isAllowed( 'editinterface' ) ) {
1577 $title = Title::makeTitle( NS_MEDIAWIKI, 'Deletereason-dropdown' );
1578 $link = Linker::link(
1579 $title,
1580 wfMsgHtml( 'delete-edit-reasonlist' ),
1581 array(),
1582 array( 'action' => 'edit' )
1583 );
1584 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
1585 }
1586
1587 $outputPage->addHTML( $form );
1588 $outputPage->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
1589 LogEventsList::showLogExtract( $outputPage, 'delete',
1590 $this->getTitle()->getPrefixedText()
1591 );
1592 }
1593
1594 /**
1595 * Perform a deletion and output success or failure messages
1596 * @param $reason
1597 * @param $suppress bool
1598 */
1599 public function doDelete( $reason, $suppress = false ) {
1600 $error = '';
1601 $outputPage = $this->getContext()->getOutput();
1602 $status = $this->mPage->doDeleteArticleReal( $reason, $suppress, 0, true, $error );
1603 if ( $status->isGood() ) {
1604 $deleted = $this->getTitle()->getPrefixedText();
1605
1606 $outputPage->setPageTitle( wfMessage( 'actioncomplete' ) );
1607 $outputPage->setRobotPolicy( 'noindex,nofollow' );
1608
1609 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
1610
1611 $outputPage->addWikiMsg( 'deletedtext', wfEscapeWikiText( $deleted ), $loglink );
1612 $outputPage->returnToMain( false );
1613 } else {
1614 $outputPage->setPageTitle( wfMessage( 'cannotdelete-title', $this->getTitle()->getPrefixedText() ) );
1615 if ( $error == '' ) {
1616 $errors = $status->getErrorsArray();
1617 $outputPage->wrapWikiMsg( "<div class=\"error mw-error-cannotdelete\">\n$1\n</div>",
1618 $errors[0]
1619 );
1620 $outputPage->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
1621
1622 LogEventsList::showLogExtract(
1623 $outputPage,
1624 'delete',
1625 $this->getTitle()->getPrefixedText()
1626 );
1627 } else {
1628 $outputPage->addHTML( $error );
1629 }
1630 }
1631 }
1632
1633 /* Caching functions */
1634
1635 /**
1636 * checkLastModified returns true if it has taken care of all
1637 * output to the client that is necessary for this request.
1638 * (that is, it has sent a cached version of the page)
1639 *
1640 * @return boolean true if cached version send, false otherwise
1641 */
1642 protected function tryFileCache() {
1643 static $called = false;
1644
1645 if ( $called ) {
1646 wfDebug( "Article::tryFileCache(): called twice!?\n" );
1647 return false;
1648 }
1649
1650 $called = true;
1651 if ( $this->isFileCacheable() ) {
1652 $cache = HTMLFileCache::newFromTitle( $this->getTitle(), 'view' );
1653 if ( $cache->isCacheGood( $this->mPage->getTouched() ) ) {
1654 wfDebug( "Article::tryFileCache(): about to load file\n" );
1655 $cache->loadFromFileCache( $this->getContext() );
1656 return true;
1657 } else {
1658 wfDebug( "Article::tryFileCache(): starting buffer\n" );
1659 ob_start( array( &$cache, 'saveToFileCache' ) );
1660 }
1661 } else {
1662 wfDebug( "Article::tryFileCache(): not cacheable\n" );
1663 }
1664
1665 return false;
1666 }
1667
1668 /**
1669 * Check if the page can be cached
1670 * @return bool
1671 */
1672 public function isFileCacheable() {
1673 $cacheable = false;
1674
1675 if ( HTMLFileCache::useFileCache( $this->getContext() ) ) {
1676 $cacheable = $this->mPage->getID()
1677 && !$this->mRedirectedFrom && !$this->getTitle()->isRedirect();
1678 // Extension may have reason to disable file caching on some pages.
1679 if ( $cacheable ) {
1680 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
1681 }
1682 }
1683
1684 return $cacheable;
1685 }
1686
1687 /**#@-*/
1688
1689 /**
1690 * Lightweight method to get the parser output for a page, checking the parser cache
1691 * and so on. Doesn't consider most of the stuff that WikiPage::view is forced to
1692 * consider, so it's not appropriate to use there.
1693 *
1694 * @since 1.16 (r52326) for LiquidThreads
1695 *
1696 * @param $oldid mixed integer Revision ID or null
1697 * @param $user User The relevant user
1698 * @return ParserOutput or false if the given revsion ID is not found
1699 */
1700 public function getParserOutput( $oldid = null, User $user = null ) {
1701 $user = is_null( $user ) ? $this->getContext()->getUser() : $user;
1702 $parserOptions = $this->mPage->makeParserOptions( $user );
1703
1704 return $this->mPage->getParserOutput( $parserOptions, $oldid );
1705 }
1706
1707 /**
1708 * Get parser options suitable for rendering the primary article wikitext
1709 * @return ParserOptions
1710 */
1711 public function getParserOptions() {
1712 if ( !$this->mParserOptions ) {
1713 $this->mParserOptions = $this->mPage->makeParserOptions( $this->getContext()->getUser() );
1714 }
1715 // Clone to allow modifications of the return value without affecting cache
1716 return clone $this->mParserOptions;
1717 }
1718
1719 /**
1720 * Sets the context this Article is executed in
1721 *
1722 * @param $context IContextSource
1723 * @since 1.18
1724 */
1725 public function setContext( $context ) {
1726 $this->mContext = $context;
1727 }
1728
1729 /**
1730 * Gets the context this Article is executed in
1731 *
1732 * @return IContextSource
1733 * @since 1.18
1734 */
1735 public function getContext() {
1736 if ( $this->mContext instanceof IContextSource ) {
1737 return $this->mContext;
1738 } else {
1739 wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
1740 return RequestContext::getMain();
1741 }
1742 }
1743
1744 /**
1745 * Info about this page
1746 * @deprecated since 1.19
1747 */
1748 public function info() {
1749 wfDeprecated( __METHOD__, '1.19' );
1750 Action::factory( 'info', $this )->show();
1751 }
1752
1753 /**
1754 * Mark this particular edit/page as patrolled
1755 * @deprecated since 1.18
1756 */
1757 public function markpatrolled() {
1758 wfDeprecated( __METHOD__, '1.18' );
1759 Action::factory( 'markpatrolled', $this )->show();
1760 }
1761
1762 /**
1763 * Handle action=purge
1764 * @deprecated since 1.19
1765 * @return Action|bool|null false if the action is disabled, null if it is not recognised
1766 */
1767 public function purge() {
1768 return Action::factory( 'purge', $this )->show();
1769 }
1770
1771 /**
1772 * Handle action=revert
1773 * @deprecated since 1.19
1774 */
1775 public function revert() {
1776 wfDeprecated( __METHOD__, '1.19' );
1777 Action::factory( 'revert', $this )->show();
1778 }
1779
1780 /**
1781 * Handle action=rollback
1782 * @deprecated since 1.19
1783 */
1784 public function rollback() {
1785 wfDeprecated( __METHOD__, '1.19' );
1786 Action::factory( 'rollback', $this )->show();
1787 }
1788
1789 /**
1790 * User-interface handler for the "watch" action.
1791 * Requires Request to pass a token as of 1.18.
1792 * @deprecated since 1.18
1793 */
1794 public function watch() {
1795 wfDeprecated( __METHOD__, '1.18' );
1796 Action::factory( 'watch', $this )->show();
1797 }
1798
1799 /**
1800 * Add this page to the current user's watchlist
1801 *
1802 * This is safe to be called multiple times
1803 *
1804 * @return bool true on successful watch operation
1805 * @deprecated since 1.18
1806 */
1807 public function doWatch() {
1808 wfDeprecated( __METHOD__, '1.18' );
1809 return WatchAction::doWatch( $this->getTitle(), $this->getContext()->getUser() );
1810 }
1811
1812 /**
1813 * User interface handler for the "unwatch" action.
1814 * Requires Request to pass a token as of 1.18.
1815 * @deprecated since 1.18
1816 */
1817 public function unwatch() {
1818 wfDeprecated( __METHOD__, '1.18' );
1819 Action::factory( 'unwatch', $this )->show();
1820 }
1821
1822 /**
1823 * Stop watching a page
1824 * @return bool true on successful unwatch
1825 * @deprecated since 1.18
1826 */
1827 public function doUnwatch() {
1828 wfDeprecated( __METHOD__, '1.18' );
1829 return WatchAction::doUnwatch( $this->getTitle(), $this->getContext()->getUser() );
1830 }
1831
1832 /**
1833 * Output a redirect back to the article.
1834 * This is typically used after an edit.
1835 *
1836 * @deprecated in 1.18; call OutputPage::redirect() directly
1837 * @param $noRedir Boolean: add redirect=no
1838 * @param $sectionAnchor String: section to redirect to, including "#"
1839 * @param $extraQuery String: extra query params
1840 */
1841 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
1842 wfDeprecated( __METHOD__, '1.18' );
1843 if ( $noRedir ) {
1844 $query = 'redirect=no';
1845 if ( $extraQuery )
1846 $query .= "&$extraQuery";
1847 } else {
1848 $query = $extraQuery;
1849 }
1850
1851 $this->getContext()->getOutput()->redirect( $this->getTitle()->getFullURL( $query ) . $sectionAnchor );
1852 }
1853
1854 /**
1855 * Use PHP's magic __get handler to handle accessing of
1856 * raw WikiPage fields for backwards compatibility.
1857 *
1858 * @param $fname String Field name
1859 */
1860 public function __get( $fname ) {
1861 if ( property_exists( $this->mPage, $fname ) ) {
1862 #wfWarn( "Access to raw $fname field " . __CLASS__ );
1863 return $this->mPage->$fname;
1864 }
1865 trigger_error( 'Inaccessible property via __get(): ' . $fname, E_USER_NOTICE );
1866 }
1867
1868 /**
1869 * Use PHP's magic __set handler to handle setting of
1870 * raw WikiPage fields for backwards compatibility.
1871 *
1872 * @param $fname String Field name
1873 * @param $fvalue mixed New value
1874 */
1875 public function __set( $fname, $fvalue ) {
1876 if ( property_exists( $this->mPage, $fname ) ) {
1877 #wfWarn( "Access to raw $fname field of " . __CLASS__ );
1878 $this->mPage->$fname = $fvalue;
1879 // Note: extensions may want to toss on new fields
1880 } elseif ( !in_array( $fname, array( 'mContext', 'mPage' ) ) ) {
1881 $this->mPage->$fname = $fvalue;
1882 } else {
1883 trigger_error( 'Inaccessible property via __set(): ' . $fname, E_USER_NOTICE );
1884 }
1885 }
1886
1887 /**
1888 * Use PHP's magic __call handler to transform instance calls to
1889 * WikiPage functions for backwards compatibility.
1890 *
1891 * @param $fname String Name of called method
1892 * @param $args Array Arguments to the method
1893 * @return mixed
1894 */
1895 public function __call( $fname, $args ) {
1896 if ( is_callable( array( $this->mPage, $fname ) ) ) {
1897 #wfWarn( "Call to " . __CLASS__ . "::$fname; please use WikiPage instead" );
1898 return call_user_func_array( array( $this->mPage, $fname ), $args );
1899 }
1900 trigger_error( 'Inaccessible function via __call(): ' . $fname, E_USER_ERROR );
1901 }
1902
1903 // ****** B/C functions to work-around PHP silliness with __call and references ****** //
1904
1905 /**
1906 * @param $limit array
1907 * @param $expiry array
1908 * @param $cascade bool
1909 * @param $reason string
1910 * @param $user User
1911 * @return Status
1912 */
1913 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User $user ) {
1914 return $this->mPage->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user );
1915 }
1916
1917 /**
1918 * @param $limit array
1919 * @param $reason string
1920 * @param $cascade int
1921 * @param $expiry array
1922 * @return bool
1923 */
1924 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
1925 return $this->mPage->updateRestrictions( $limit, $reason, $cascade, $expiry );
1926 }
1927
1928 /**
1929 * @param $reason string
1930 * @param $suppress bool
1931 * @param $id int
1932 * @param $commit bool
1933 * @param $error string
1934 * @return bool
1935 */
1936 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true, &$error = '' ) {
1937 return $this->mPage->doDeleteArticle( $reason, $suppress, $id, $commit, $error );
1938 }
1939
1940 /**
1941 * @param $fromP
1942 * @param $summary
1943 * @param $token
1944 * @param $bot
1945 * @param $resultDetails
1946 * @param $user User
1947 * @return array
1948 */
1949 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails, User $user = null ) {
1950 $user = is_null( $user ) ? $this->getContext()->getUser() : $user;
1951 return $this->mPage->doRollback( $fromP, $summary, $token, $bot, $resultDetails, $user );
1952 }
1953
1954 /**
1955 * @param $fromP
1956 * @param $summary
1957 * @param $bot
1958 * @param $resultDetails
1959 * @param $guser User
1960 * @return array
1961 */
1962 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser = null ) {
1963 $guser = is_null( $guser ) ? $this->getContext()->getUser() : $guser;
1964 return $this->mPage->commitRollback( $fromP, $summary, $bot, $resultDetails, $guser );
1965 }
1966
1967 /**
1968 * @param $hasHistory bool
1969 * @return mixed
1970 */
1971 public function generateReason( &$hasHistory ) {
1972 $title = $this->mPage->getTitle();
1973 $handler = ContentHandler::getForTitle( $title );
1974 return $handler->getAutoDeleteReason( $title, $hasHistory );
1975 }
1976
1977 // ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
1978
1979 /**
1980 * @return array
1981 */
1982 public static function selectFields() {
1983 return WikiPage::selectFields();
1984 }
1985
1986 /**
1987 * @param $title Title
1988 */
1989 public static function onArticleCreate( $title ) {
1990 WikiPage::onArticleCreate( $title );
1991 }
1992
1993 /**
1994 * @param $title Title
1995 */
1996 public static function onArticleDelete( $title ) {
1997 WikiPage::onArticleDelete( $title );
1998 }
1999
2000 /**
2001 * @param $title Title
2002 */
2003 public static function onArticleEdit( $title ) {
2004 WikiPage::onArticleEdit( $title );
2005 }
2006
2007 /**
2008 * @param $oldtext
2009 * @param $newtext
2010 * @param $flags
2011 * @return string
2012 * @deprecated since 1.WD, use ContentHandler::getAutosummary() instead
2013 */
2014 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2015 return WikiPage::getAutosummary( $oldtext, $newtext, $flags );
2016 }
2017 // ******
2018 }