WikitextContent.php

Go to the documentation of this file.

<?php
class WikitextContent extends TextContent {

        public function __construct( $text ) {
                parent::__construct( $text, CONTENT_MODEL_WIKITEXT );
        }

        public function getSection( $section ) {
                global $wgParser;

                $text = $this->getNativeData();
                $sect = $wgParser->getSection( $text, $section, false );

                if ( $sect === false ) {
                        return false;
                } else {
                        return new WikitextContent( $sect );
                }
        }

        public function replaceSection( $section, Content $with, $sectionTitle = '' ) {
                wfProfileIn( __METHOD__ );

                $myModelId = $this->getModel();
                $sectionModelId = $with->getModel();

                if ( $sectionModelId != $myModelId  ) {
                        throw new MWException( "Incompatible content model for section: " .
                                "document uses $myModelId but " .
                                "section uses $sectionModelId." );
                }

                $oldtext = $this->getNativeData();
                $text = $with->getNativeData();

                if ( $section === '' ) {
                        return $with; # XXX: copy first?
                } if ( $section == 'new' ) {
                        # Inserting a new section
                        $subject = $sectionTitle ? wfMessage( 'newsectionheaderdefaultlevel' )
                                ->rawParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
                        if ( wfRunHooks( 'PlaceNewSection', array( $this, $oldtext, $subject, &$text ) ) ) {
                                $text = strlen( trim( $oldtext ) ) > 0
                                        ? "{$oldtext}\n\n{$subject}{$text}"
                                        : "{$subject}{$text}";
                        }
                } else {
                        # Replacing an existing section; roll out the big guns
                        global $wgParser;

                        $text = $wgParser->replaceSection( $oldtext, $section, $text );
                }

                $newContent = new WikitextContent( $text );

                wfProfileOut( __METHOD__ );
                return $newContent;
        }

        public function addSectionHeader( $header ) {
                $text = wfMessage( 'newsectionheaderdefaultlevel' )
                        ->rawParams( $header )->inContentLanguage()->text();
                $text .= "\n\n";
                $text .= $this->getNativeData();

                return new WikitextContent( $text );
        }

        public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
                global $wgParser;

                $text = $this->getNativeData();
                $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
                rtrim( $pst );

                return ( $text === $pst ) ? $this : new WikitextContent( $pst );
        }

        public function preloadTransform( Title $title, ParserOptions $popts ) {
                global $wgParser;

                $text = $this->getNativeData();
                $plt = $wgParser->getPreloadText( $text, $title, $popts );

                return new WikitextContent( $plt );
        }

        public function getRedirectTarget() {
                global $wgMaxRedirects;
                if ( $wgMaxRedirects < 1 ) {
                        // redirects are disabled, so quit early
                        return null;
                }
                $redir = MagicWord::get( 'redirect' );
                $text = trim( $this->getNativeData() );
                if ( $redir->matchStartAndRemove( $text ) ) {
                        // Extract the first link and see if it's usable
                        // Ensure that it really does come directly after #REDIRECT
                        // Some older redirects included a colon, so don't freak about that!
                        $m = array();
                        if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
                                // Strip preceding colon used to "escape" categories, etc.
                                // and URL-decode links
                                if ( strpos( $m[1], '%' ) !== false ) {
                                        // Match behavior of inline link parsing here;
                                        $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
                                }
                                $title = Title::newFromText( $m[1] );
                                // If the title is a redirect to bad special pages or is invalid, return null
                                if ( !$title instanceof Title || !$title->isValidRedirectTarget() ) {
                                        return null;
                                }
                                return $title;
                        }
                }
                return null;
        }

        public function updateRedirect( Title $target ) {
                if ( !$this->isRedirect() ) {
                        return $this;
                }

                # Fix the text
                # Remember that redirect pages can have categories, templates, etc.,
                # so the regex has to be fairly general
                $newText = preg_replace( '/ \[ \[  [^\]]*  \] \] /x',
                        '[[' . $target->getFullText() . ']]',
                        $this->getNativeData(), 1 );

                return new WikitextContent( $newText );
        }

        public function isCountable( $hasLinks = null, Title $title = null ) {
                global $wgArticleCountMethod;

                if ( $this->isRedirect( ) ) {
                        return false;
                }

                $text = $this->getNativeData();

                switch ( $wgArticleCountMethod ) {
                        case 'any':
                                return true;
                        case 'comma':
                                return strpos( $text,  ',' ) !== false;
                        case 'link':
                                if ( $hasLinks === null ) { # not known, find out
                                        if ( !$title ) {
                                                $context = RequestContext::getMain();
                                                $title = $context->getTitle();
                                        }

                                        $po = $this->getParserOutput( $title, null, null, false );
                                        $links = $po->getLinks();
                                        $hasLinks = !empty( $links );
                                }

                                return $hasLinks;
                }

                return false;
        }

        public function getTextForSummary( $maxlength = 250 ) {
                $truncatedtext = parent::getTextForSummary( $maxlength );

                # clean up unfinished links
                # XXX: make this optional? wasn't there in autosummary, but required for
                # deletion summary.
                $truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );

                return $truncatedtext;
        }

        public function getParserOutput( Title $title,
                $revId = null,
                ParserOptions $options = null, $generateHtml = true
        ) {
                global $wgParser;

                if ( !$options ) {
                        //NOTE: use canonical options per default to produce cacheable output
                        $options = $this->getContentHandler()->makeParserOptions( 'canonical' );
                }

                $po = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
                return $po;
        }

        protected function getHtml() {
                throw new MWException(
                        "getHtml() not implemented for wikitext. "
                                . "Use getParserOutput()->getText()."
                );
        }

        public function matchMagicWord( MagicWord $word ) {
                return $word->match( $this->getNativeData() );
        }
}