includes/content/WikitextContentHandler.php

   1 <?php
   2 /**
   3  * Content handler for wiki text pages.
   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  * @since 1.21
  21  *
  22  * @file
  23  * @ingroup Content
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27
  28 /**
  29  * Content handler for wiki text pages.
  30  *
  31  * @ingroup Content
  32  */
  33 class WikitextContentHandler extends TextContentHandler {
  34
  35         public function __construct( $modelId = CONTENT_MODEL_WIKITEXT ) {
  36                 parent::__construct( $modelId, [ CONTENT_FORMAT_WIKITEXT ] );
  37         }
  38
  39         protected function getContentClass() {
  40                 return WikitextContent::class;
  41         }
  42
  43         /**
  44          * Returns a WikitextContent object representing a redirect to the given destination page.
  45          *
  46          * @param Title $destination The page to redirect to.
  47          * @param string $text Text to include in the redirect, if possible.
  48          *
  49          * @return Content
  50          *
  51          * @see ContentHandler::makeRedirectContent
  52          */
  53         public function makeRedirectContent( Title $destination, $text = '' ) {
  54                 $optionalColon = '';
  55
  56                 if ( $destination->getNamespace() == NS_CATEGORY ) {
  57                         $optionalColon = ':';
  58                 } else {
  59                         $iw = $destination->getInterwiki();
  60                         if ( $iw && Language::fetchLanguageName( $iw, null, 'mw' ) ) {
  61                                 $optionalColon = ':';
  62                         }
  63                 }
  64
  65                 $mwRedir = MediaWikiServices::getInstance()->getMagicWordFactory()->get( 'redirect' );
  66                 $redirectText = $mwRedir->getSynonym( 0 ) .
  67                         ' [[' . $optionalColon . $destination->getFullText() . ']]';
  68
  69                 if ( $text != '' ) {
  70                         $redirectText .= "\n" . $text;
  71                 }
  72
  73                 $class = $this->getContentClass();
  74                 return new $class( $redirectText );
  75         }
  76
  77         /**
  78          * Returns true because wikitext supports redirects.
  79          *
  80          * @return bool Always true.
  81          *
  82          * @see ContentHandler::supportsRedirects
  83          */
  84         public function supportsRedirects() {
  85                 return true;
  86         }
  87
  88         /**
  89          * Returns true because wikitext supports sections.
  90          *
  91          * @return bool Always true.
  92          *
  93          * @see ContentHandler::supportsSections
  94          */
  95         public function supportsSections() {
  96                 return true;
  97         }
  98
  99         /**
 100          * Returns true, because wikitext supports caching using the
 101          * ParserCache mechanism.
 102          *
 103          * @since 1.21
 104          *
 105          * @return bool Always true.
 106          *
 107          * @see ContentHandler::isParserCacheSupported
 108          */
 109         public function isParserCacheSupported() {
 110                 return true;
 111         }
 112
 113         /**
 114          * Get file handler
 115          * @return FileContentHandler
 116          */
 117         protected function getFileHandler() {
 118                 return new FileContentHandler();
 119         }
 120
 121         public function getFieldsForSearchIndex( SearchEngine $engine ) {
 122                 $fields = parent::getFieldsForSearchIndex( $engine );
 123
 124                 $fields['heading'] =
 125                         $engine->makeSearchFieldMapping( 'heading', SearchIndexField::INDEX_TYPE_TEXT );
 126                 $fields['heading']->setFlag( SearchIndexField::FLAG_SCORING );
 127
 128                 $fields['auxiliary_text'] =
 129                         $engine->makeSearchFieldMapping( 'auxiliary_text', SearchIndexField::INDEX_TYPE_TEXT );
 130
 131                 $fields['opening_text'] =
 132                         $engine->makeSearchFieldMapping( 'opening_text', SearchIndexField::INDEX_TYPE_TEXT );
 133                 $fields['opening_text']->setFlag(
 134                         SearchIndexField::FLAG_SCORING | SearchIndexField::FLAG_NO_HIGHLIGHT
 135                 );
 136                 // Until we have full first-class content handler for files, we invoke it explicitly here
 137                 $fields = array_merge( $fields, $this->getFileHandler()->getFieldsForSearchIndex( $engine ) );
 138
 139                 return $fields;
 140         }
 141
 142         public function getDataForSearchIndex(
 143                 WikiPage $page,
 144                 ParserOutput $parserOutput,
 145                 SearchEngine $engine
 146         ) {
 147                 $fields = parent::getDataForSearchIndex( $page, $parserOutput, $engine );
 148
 149                 $structure = new WikiTextStructure( $parserOutput );
 150                 $fields['heading'] = $structure->headings();
 151                 // text fields
 152                 $fields['opening_text'] = $structure->getOpeningText();
 153                 $fields['text'] = $structure->getMainText(); // overwrites one from ContentHandler
 154                 $fields['auxiliary_text'] = $structure->getAuxiliaryText();
 155                 $fields['defaultsort'] = $structure->getDefaultSort();
 156
 157                 // Until we have full first-class content handler for files, we invoke it explicitly here
 158                 if ( NS_FILE == $page->getTitle()->getNamespace() ) {
 159                         $fields = array_merge( $fields,
 160                                         $this->getFileHandler()->getDataForSearchIndex( $page, $parserOutput, $engine ) );
 161                 }
 162                 return $fields;
 163         }
 164
 165         /**
 166          * Returns the content's text as-is.
 167          *
 168          * @param Content $content
 169          * @param string|null $format The serialization format to check
 170          *
 171          * @return mixed
 172          */
 173         public function serializeContent( Content $content, $format = null ) {
 174                 $this->checkFormat( $format );
 175
 176                 // NOTE: MessageContent also uses CONTENT_MODEL_WIKITEXT, but it's not a TextContent!
 177                 // Perhaps MessageContent should use a separate ContentHandler instead.
 178                 if ( $content instanceof MessageContent ) {
 179                         return $content->getMessage()->plain();
 180                 }
 181
 182                 return parent::serializeContent( $content, $format );
 183         }
 184
 185 }