includes/content/ContentHandler.php

   1 <?php
   2 /**
   3  * Base class for content handling.
   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  * @author Daniel Kinzler
  26  */
  27
  28 /**
  29  * Exception representing a failure to serialize or unserialize a content object.
  30  *
  31  * @ingroup Content
  32  */
  33 class MWContentSerializationException extends MWException {
  34 }
  35
  36 /**
  37  * A content handler knows how do deal with a specific type of content on a wiki
  38  * page. Content is stored in the database in a serialized form (using a
  39  * serialization format a.k.a. MIME type) and is unserialized into its native
  40  * PHP representation (the content model), which is wrapped in an instance of
  41  * the appropriate subclass of Content.
  42  *
  43  * ContentHandler instances are stateless singletons that serve, among other
  44  * things, as a factory for Content objects. Generally, there is one subclass
  45  * of ContentHandler and one subclass of Content for every type of content model.
  46  *
  47  * Some content types have a flat model, that is, their native representation
  48  * is the same as their serialized form. Examples would be JavaScript and CSS
  49  * code. As of now, this also applies to wikitext (MediaWiki's default content
  50  * type), but wikitext content may be represented by a DOM or AST structure in
  51  * the future.
  52  *
  53  * @ingroup Content
  54  */
  55 abstract class ContentHandler {
  56         /**
  57          * Switch for enabling deprecation warnings. Used by ContentHandler::deprecated()
  58          * and ContentHandler::runLegacyHooks().
  59          *
  60          * Once the ContentHandler code has settled in a bit, this should be set to true to
  61          * make extensions etc. show warnings when using deprecated functions and hooks.
  62          */
  63         protected static $enableDeprecationWarnings = false;
  64
  65         /**
  66          * Convenience function for getting flat text from a Content object. This
  67          * should only be used in the context of backwards compatibility with code
  68          * that is not yet able to handle Content objects!
  69          *
  70          * If $content is null, this method returns the empty string.
  71          *
  72          * If $content is an instance of TextContent, this method returns the flat
  73          * text as returned by $content->getNativeData().
  74          *
  75          * If $content is not a TextContent object, the behavior of this method
  76          * depends on the global $wgContentHandlerTextFallback:
  77          * - If $wgContentHandlerTextFallback is 'fail' and $content is not a
  78          *   TextContent object, an MWException is thrown.
  79          * - If $wgContentHandlerTextFallback is 'serialize' and $content is not a
  80          *   TextContent object, $content->serialize() is called to get a string
  81          *   form of the content.
  82          * - If $wgContentHandlerTextFallback is 'ignore' and $content is not a
  83          *   TextContent object, this method returns null.
  84          * - otherwise, the behavior is undefined.
  85          *
  86          * @since 1.21
  87          *
  88          * @param Content $content
  89          *
  90          * @throws MWException If the content is not an instance of TextContent and
  91          * wgContentHandlerTextFallback was set to 'fail'.
  92          * @return string|null Textual form of the content, if available.
  93          */
  94         public static function getContentText( Content $content = null ) {
  95                 global $wgContentHandlerTextFallback;
  96
  97                 if ( is_null( $content ) ) {
  98                         return '';
  99                 }
 100
 101                 if ( $content instanceof TextContent ) {
 102                         return $content->getNativeData();
 103                 }
 104
 105                 wfDebugLog( 'ContentHandler', 'Accessing ' . $content->getModel() . ' content as text!' );
 106
 107                 if ( $wgContentHandlerTextFallback == 'fail' ) {
 108                         throw new MWException(
 109                                 "Attempt to get text from Content with model " .
 110                                 $content->getModel()
 111                         );
 112                 }
 113
 114                 if ( $wgContentHandlerTextFallback == 'serialize' ) {
 115                         return $content->serialize();
 116                 }
 117
 118                 return null;
 119         }
 120
 121         /**
 122          * Convenience function for creating a Content object from a given textual
 123          * representation.
 124          *
 125          * $text will be deserialized into a Content object of the model specified
 126          * by $modelId (or, if that is not given, $title->getContentModel()) using
 127          * the given format.
 128          *
 129          * @since 1.21
 130          *
 131          * @param string $text The textual representation, will be
 132          *    unserialized to create the Content object
 133          * @param Title $title The title of the page this text belongs to.
 134          *    Required if $modelId is not provided.
 135          * @param string $modelId The model to deserialize to. If not provided,
 136          *    $title->getContentModel() is used.
 137          * @param string $format The format to use for deserialization. If not
 138          *    given, the model's default format is used.
 139          *
 140          * @throws MWException If model ID or format is not supported or if the text can not be
 141          * unserialized using the format.
 142          * @return Content A Content object representing the text.
 143          */
 144         public static function makeContent( $text, Title $title = null,
 145                 $modelId = null, $format = null ) {
 146                 if ( is_null( $modelId ) ) {
 147                         if ( is_null( $title ) ) {
 148                                 throw new MWException( "Must provide a Title object or a content model ID." );
 149                         }
 150
 151                         $modelId = $title->getContentModel();
 152                 }
 153
 154                 $handler = ContentHandler::getForModelID( $modelId );
 155
 156                 return $handler->unserializeContent( $text, $format );
 157         }
 158
 159         /**
 160          * Returns the name of the default content model to be used for the page
 161          * with the given title.
 162          *
 163          * Note: There should rarely be need to call this method directly.
 164          * To determine the actual content model for a given page, use
 165          * Title::getContentModel().
 166          *
 167          * Which model is to be used by default for the page is determined based
 168          * on several factors:
 169          * - The global setting $wgNamespaceContentModels specifies a content model
 170          *   per namespace.
 171          * - The hook ContentHandlerDefaultModelFor may be used to override the page's default
 172          *   model.
 173          * - Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript
 174          *   model if they end in .js or .css, respectively.
 175          * - Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
 176          * - The hook TitleIsCssOrJsPage may be used to force a page to use the CSS
 177          *   or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor
 178          *   hook should be used instead if possible.
 179          * - The hook TitleIsWikitextPage may be used to force a page to use the
 180          *   wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor
 181          *   hook should be used instead if possible.
 182          *
 183          * If none of the above applies, the wikitext model is used.
 184          *
 185          * Note: this is used by, and may thus not use, Title::getContentModel()
 186          *
 187          * @since 1.21
 188          *
 189          * @param Title $title
 190          *
 191          * @return string Default model name for the page given by $title
 192          */
 193         public static function getDefaultModelFor( Title $title ) {
 194                 // NOTE: this method must not rely on $title->getContentModel() directly or indirectly,
 195                 //       because it is used to initialize the mContentModel member.
 196
 197                 $ns = $title->getNamespace();
 198
 199                 $ext = false;
 200                 $m = null;
 201                 $model = MWNamespace::getNamespaceContentModel( $ns );
 202
 203                 // Hook can determine default model
 204                 if ( !wfRunHooks( 'ContentHandlerDefaultModelFor', array( $title, &$model ) ) ) {
 205                         if ( !is_null( $model ) ) {
 206                                 return $model;
 207                         }
 208                 }
 209
 210                 // Could this page contain custom CSS or JavaScript, based on the title?
 211                 $isCssOrJsPage = NS_MEDIAWIKI == $ns && preg_match( '!\.(css|js)$!u', $title->getText(), $m );
 212                 if ( $isCssOrJsPage ) {
 213                         $ext = $m[1];
 214                 }
 215
 216                 // Hook can force JS/CSS
 217                 wfRunHooks( 'TitleIsCssOrJsPage', array( $title, &$isCssOrJsPage ) );
 218
 219                 // Is this a .css subpage of a user page?
 220                 $isJsCssSubpage = NS_USER == $ns
 221                         && !$isCssOrJsPage
 222                         && preg_match( "/\\/.*\\.(js|css)$/", $title->getText(), $m );
 223                 if ( $isJsCssSubpage ) {
 224                         $ext = $m[1];
 225                 }
 226
 227                 // Is this wikitext, according to $wgNamespaceContentModels or the DefaultModelFor hook?
 228                 $isWikitext = is_null( $model ) || $model == CONTENT_MODEL_WIKITEXT;
 229                 $isWikitext = $isWikitext && !$isCssOrJsPage && !$isJsCssSubpage;
 230
 231                 // Hook can override $isWikitext
 232                 wfRunHooks( 'TitleIsWikitextPage', array( $title, &$isWikitext ) );
 233
 234                 if ( !$isWikitext ) {
 235                         switch ( $ext ) {
 236                                 case 'js':
 237                                         return CONTENT_MODEL_JAVASCRIPT;
 238                                 case 'css':
 239                                         return CONTENT_MODEL_CSS;
 240                                 default:
 241                                         return is_null( $model ) ? CONTENT_MODEL_TEXT : $model;
 242                         }
 243                 }
 244
 245                 // We established that it must be wikitext
 246
 247                 return CONTENT_MODEL_WIKITEXT;
 248         }
 249
 250         /**
 251          * Returns the appropriate ContentHandler singleton for the given title.
 252          *
 253          * @since 1.21
 254          *
 255          * @param Title $title
 256          *
 257          * @return ContentHandler
 258          */
 259         public static function getForTitle( Title $title ) {
 260                 $modelId = $title->getContentModel();
 261
 262                 return ContentHandler::getForModelID( $modelId );
 263         }
 264
 265         /**
 266          * Returns the appropriate ContentHandler singleton for the given Content
 267          * object.
 268          *
 269          * @since 1.21
 270          *
 271          * @param Content $content
 272          *
 273          * @return ContentHandler
 274          */
 275         public static function getForContent( Content $content ) {
 276                 $modelId = $content->getModel();
 277
 278                 return ContentHandler::getForModelID( $modelId );
 279         }
 280
 281         /**
 282          * @var array A Cache of ContentHandler instances by model id
 283          */
 284         protected static $handlers;
 285
 286         /**
 287          * Returns the ContentHandler singleton for the given model ID. Use the
 288          * CONTENT_MODEL_XXX constants to identify the desired content model.
 289          *
 290          * ContentHandler singletons are taken from the global $wgContentHandlers
 291          * array. Keys in that array are model names, the values are either
 292          * ContentHandler singleton objects, or strings specifying the appropriate
 293          * subclass of ContentHandler.
 294          *
 295          * If a class name is encountered when looking up the singleton for a given
 296          * model name, the class is instantiated and the class name is replaced by
 297          * the resulting singleton in $wgContentHandlers.
 298          *
 299          * If no ContentHandler is defined for the desired $modelId, the
 300          * ContentHandler may be provided by the ContentHandlerForModelID hook.
 301          * If no ContentHandler can be determined, an MWException is raised.
 302          *
 303          * @since 1.21
 304          *
 305          * @param string $modelId The ID of the content model for which to get a
 306          *    handler. Use CONTENT_MODEL_XXX constants.
 307          *
 308          * @throws MWException If no handler is known for the model ID.
 309          * @return ContentHandler The ContentHandler singleton for handling the model given by the ID.
 310          */
 311         public static function getForModelID( $modelId ) {
 312                 global $wgContentHandlers;
 313
 314                 if ( isset( ContentHandler::$handlers[$modelId] ) ) {
 315                         return ContentHandler::$handlers[$modelId];
 316                 }
 317
 318                 if ( empty( $wgContentHandlers[$modelId] ) ) {
 319                         $handler = null;
 320
 321                         wfRunHooks( 'ContentHandlerForModelID', array( $modelId, &$handler ) );
 322
 323                         if ( $handler === null ) {
 324                                 throw new MWException( "No handler for model '$modelId' registered in \$wgContentHandlers" );
 325                         }
 326
 327                         if ( !( $handler instanceof ContentHandler ) ) {
 328                                 throw new MWException( "ContentHandlerForModelID must supply a ContentHandler instance" );
 329                         }
 330                 } else {
 331                         $class = $wgContentHandlers[$modelId];
 332                         $handler = new $class( $modelId );
 333
 334                         if ( !( $handler instanceof ContentHandler ) ) {
 335                                 throw new MWException( "$class from \$wgContentHandlers is not " .
 336                                         "compatible with ContentHandler" );
 337                         }
 338                 }
 339
 340                 wfDebugLog( 'ContentHandler', 'Created handler for ' . $modelId
 341                         . ': ' . get_class( $handler ) );
 342
 343                 ContentHandler::$handlers[$modelId] = $handler;
 344
 345                 return ContentHandler::$handlers[$modelId];
 346         }
 347
 348         /**
 349          * Returns the localized name for a given content model.
 350          *
 351          * Model names are localized using system messages. Message keys
 352          * have the form content-model-$name, where $name is getContentModelName( $id ).
 353          *
 354          * @param string $name The content model ID, as given by a CONTENT_MODEL_XXX
 355          *    constant or returned by Revision::getContentModel().
 356          *
 357          * @throws MWException If the model ID isn't known.
 358          * @return string The content model's localized name.
 359          */
 360         public static function getLocalizedName( $name ) {
 361                 // Messages: content-model-wikitext, content-model-text,
 362                 // content-model-javascript, content-model-css
 363                 $key = "content-model-$name";
 364
 365                 $msg = wfMessage( $key );
 366
 367                 return $msg->exists() ? $msg->plain() : $name;
 368         }
 369
 370         public static function getContentModels() {
 371                 global $wgContentHandlers;
 372
 373                 return array_keys( $wgContentHandlers );
 374         }
 375
 376         public static function getAllContentFormats() {
 377                 global $wgContentHandlers;
 378
 379                 $formats = array();
 380
 381                 foreach ( $wgContentHandlers as $model => $class ) {
 382                         $handler = ContentHandler::getForModelID( $model );
 383                         $formats = array_merge( $formats, $handler->getSupportedFormats() );
 384                 }
 385
 386                 $formats = array_unique( $formats );
 387
 388                 return $formats;
 389         }
 390
 391         // ------------------------------------------------------------------------
 392
 393         /**
 394          * @var string
 395          */
 396         protected $mModelID;
 397
 398         /**
 399          * @var string[]
 400          */
 401         protected $mSupportedFormats;
 402
 403         /**
 404          * Constructor, initializing the ContentHandler instance with its model ID
 405          * and a list of supported formats. Values for the parameters are typically
 406          * provided as literals by subclass's constructors.
 407          *
 408          * @param string $modelId (use CONTENT_MODEL_XXX constants).
 409          * @param string[] $formats List for supported serialization formats
 410          *    (typically as MIME types)
 411          */
 412         public function __construct( $modelId, $formats ) {
 413                 $this->mModelID = $modelId;
 414                 $this->mSupportedFormats = $formats;
 415
 416                 $this->mModelName = preg_replace( '/(Content)?Handler$/', '', get_class( $this ) );
 417                 $this->mModelName = preg_replace( '/[_\\\\]/', '', $this->mModelName );
 418                 $this->mModelName = strtolower( $this->mModelName );
 419         }
 420
 421         /**
 422          * Serializes a Content object of the type supported by this ContentHandler.
 423          *
 424          * @since 1.21
 425          *
 426          * @param Content $content The Content object to serialize
 427          * @param string $format The desired serialization format
 428          *
 429          * @return string Serialized form of the content
 430          */
 431         abstract public function serializeContent( Content $content, $format = null );
 432
 433         /**
 434          * Applies transformations on export (returns the blob unchanged per default).
 435          * Subclasses may override this to perform transformations such as conversion
 436          * of legacy formats or filtering of internal meta-data.
 437          *
 438          * @param string $blob The blob to be exported
 439          * @param string|null $format The blob's serialization format
 440          *
 441          * @return string
 442          */
 443         public function exportTransform( $blob, $format = null ) {
 444                 return $blob;
 445         }
 446
 447         /**
 448          * Unserializes a Content object of the type supported by this ContentHandler.
 449          *
 450          * @since 1.21
 451          *
 452          * @param string $blob Serialized form of the content
 453          * @param string $format The format used for serialization
 454          *
 455          * @return Content The Content object created by deserializing $blob
 456          */
 457         abstract public function unserializeContent( $blob, $format = null );
 458
 459         /**
 460          * Creates an empty Content object of the type supported by this
 461          * ContentHandler.
 462          *
 463          * @since 1.21
 464          *
 465          * @return Content
 466          */
 467         abstract public function makeEmptyContent();
 468
 469         /**
 470          * Creates a new Content object that acts as a redirect to the given page,
 471          * or null if redirects are not supported by this content model.
 472          *
 473          * This default implementation always returns null. Subclasses supporting redirects
 474          * must override this method.
 475          *
 476          * Note that subclasses that override this method to return a Content object
 477          * should also override supportsRedirects() to return true.
 478          *
 479          * @since 1.21
 480          *
 481          * @param Title $destination The page to redirect to.
 482          * @param string $text Text to include in the redirect, if possible.
 483          *
 484          * @return Content Always null.
 485          */
 486         public function makeRedirectContent( Title $destination, $text = '' ) {
 487                 return null;
 488         }
 489
 490         /**
 491          * Returns the model id that identifies the content model this
 492          * ContentHandler can handle. Use with the CONTENT_MODEL_XXX constants.
 493          *
 494          * @since 1.21
 495          *
 496          * @return string The model ID
 497          */
 498         public function getModelID() {
 499                 return $this->mModelID;
 500         }
 501
 502         /**
 503          * @since 1.21
 504          *
 505          * @param string $model_id The model to check
 506          *
 507          * @throws MWException If the model ID is not the ID of the content model supported by this
 508          * ContentHandler.
 509          */
 510         protected function checkModelID( $model_id ) {
 511                 if ( $model_id !== $this->mModelID ) {
 512                         throw new MWException( "Bad content model: " .
 513                                 "expected {$this->mModelID} " .
 514                                 "but got $model_id." );
 515                 }
 516         }
 517
 518         /**
 519          * Returns a list of serialization formats supported by the
 520          * serializeContent() and unserializeContent() methods of this
 521          * ContentHandler.
 522          *
 523          * @since 1.21
 524          *
 525          * @return string[] List of serialization formats as MIME type like strings
 526          */
 527         public function getSupportedFormats() {
 528                 return $this->mSupportedFormats;
 529         }
 530
 531         /**
 532          * The format used for serialization/deserialization by default by this
 533          * ContentHandler.
 534          *
 535          * This default implementation will return the first element of the array
 536          * of formats that was passed to the constructor.
 537          *
 538          * @since 1.21
 539          *
 540          * @return string The name of the default serialization format as a MIME type
 541          */
 542         public function getDefaultFormat() {
 543                 return $this->mSupportedFormats[0];
 544         }
 545
 546         /**
 547          * Returns true if $format is a serialization format supported by this
 548          * ContentHandler, and false otherwise.
 549          *
 550          * Note that if $format is null, this method always returns true, because
 551          * null means "use the default format".
 552          *
 553          * @since 1.21
 554          *
 555          * @param string $format The serialization format to check
 556          *
 557          * @return bool
 558          */
 559         public function isSupportedFormat( $format ) {
 560                 if ( !$format ) {
 561                         return true; // this means "use the default"
 562                 }
 563
 564                 return in_array( $format, $this->mSupportedFormats );
 565         }
 566
 567         /**
 568          * Convenient for checking whether a format provided as a parameter is actually supported.
 569          *
 570          * @param string $format The serialization format to check
 571          *
 572          * @throws MWException If the format is not supported by this content handler.
 573          */
 574         protected function checkFormat( $format ) {
 575                 if ( !$this->isSupportedFormat( $format ) ) {
 576                         throw new MWException(
 577                                 "Format $format is not supported for content model "
 578                                 . $this->getModelID()
 579                         );
 580                 }
 581         }
 582
 583         /**
 584          * Returns overrides for action handlers.
 585          * Classes listed here will be used instead of the default one when
 586          * (and only when) $wgActions[$action] === true. This allows subclasses
 587          * to override the default action handlers.
 588          *
 589          * @since 1.21
 590          *
 591          * @return array Always an empty array.
 592          */
 593         public function getActionOverrides() {
 594                 return array();
 595         }
 596
 597         /**
 598          * Factory for creating an appropriate DifferenceEngine for this content model.
 599          *
 600          * @since 1.21
 601          *
 602          * @param IContextSource $context Context to use, anything else will be ignored.
 603          * @param int $old Revision ID we want to show and diff with.
 604          * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
 605          * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
 606          * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
 607          * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
 608          *
 609          * @return DifferenceEngine
 610          */
 611         public function createDifferenceEngine( IContextSource $context, $old = 0, $new = 0,
 612                 $rcid = 0, //FIXME: Deprecated, no longer used
 613                 $refreshCache = false, $unhide = false ) {
 614                 $diffEngineClass = $this->getDiffEngineClass();
 615
 616                 return new $diffEngineClass( $context, $old, $new, $rcid, $refreshCache, $unhide );
 617         }
 618
 619         /**
 620          * Get the language in which the content of the given page is written.
 621          *
 622          * This default implementation just returns $wgContLang (except for pages
 623          * in the MediaWiki namespace)
 624          *
 625          * Note that the pages language is not cacheable, since it may in some
 626          * cases depend on user settings.
 627          *
 628          * Also note that the page language may or may not depend on the actual content of the page,
 629          * that is, this method may load the content in order to determine the language.
 630          *
 631          * @since 1.21
 632          *
 633          * @param Title $title The page to determine the language for.
 634          * @param Content $content The page's content, if you have it handy, to avoid reloading it.
 635          *
 636          * @return Language The page's language
 637          */
 638         public function getPageLanguage( Title $title, Content $content = null ) {
 639                 global $wgContLang, $wgLang;
 640                 $pageLang = $wgContLang;
 641
 642                 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
 643                         // Parse mediawiki messages with correct target language
 644                         list( /* $unused */, $lang ) = MessageCache::singleton()->figureMessage( $title->getText() );
 645                         $pageLang = wfGetLangObj( $lang );
 646                 }
 647
 648                 wfRunHooks( 'PageContentLanguage', array( $title, &$pageLang, $wgLang ) );
 649
 650                 return wfGetLangObj( $pageLang );
 651         }
 652
 653         /**
 654          * Get the language in which the content of this page is written when
 655          * viewed by user. Defaults to $this->getPageLanguage(), but if the user
 656          * specified a preferred variant, the variant will be used.
 657          *
 658          * This default implementation just returns $this->getPageLanguage( $title, $content ) unless
 659          * the user specified a preferred variant.
 660          *
 661          * Note that the pages view language is not cacheable, since it depends on user settings.
 662          *
 663          * Also note that the page language may or may not depend on the actual content of the page,
 664          * that is, this method may load the content in order to determine the language.
 665          *
 666          * @since 1.21
 667          *
 668          * @param Title $title The page to determine the language for.
 669          * @param Content $content The page's content, if you have it handy, to avoid reloading it.
 670          *
 671          * @return Language The page's language for viewing
 672          */
 673         public function getPageViewLanguage( Title $title, Content $content = null ) {
 674                 $pageLang = $this->getPageLanguage( $title, $content );
 675
 676                 if ( $title->getNamespace() !== NS_MEDIAWIKI ) {
 677                         // If the user chooses a variant, the content is actually
 678                         // in a language whose code is the variant code.
 679                         $variant = $pageLang->getPreferredVariant();
 680                         if ( $pageLang->getCode() !== $variant ) {
 681                                 $pageLang = Language::factory( $variant );
 682                         }
 683                 }
 684
 685                 return $pageLang;
 686         }
 687
 688         /**
 689          * Determines whether the content type handled by this ContentHandler
 690          * can be used on the given page.
 691          *
 692          * This default implementation always returns true.
 693          * Subclasses may override this to restrict the use of this content model to specific locations,
 694          * typically based on the namespace or some other aspect of the title, such as a special suffix
 695          * (e.g. ".svg" for SVG content).
 696          *
 697          * @note: this calls the ContentHandlerCanBeUsedOn hook which may be used to override which
 698          * content model can be used where.
 699          *
 700          * @param Title $title The page's title.
 701          *
 702          * @return bool True if content of this kind can be used on the given page, false otherwise.
 703          */
 704         public function canBeUsedOn( Title $title ) {
 705                 $ok = true;
 706
 707                 wfRunHooks( 'ContentModelCanBeUsedOn', array( $this->getModelID(), $title, &$ok ) );
 708
 709                 return $ok;
 710         }
 711
 712         /**
 713          * Returns the name of the diff engine to use.
 714          *
 715          * @since 1.21
 716          *
 717          * @return string
 718          */
 719         protected function getDiffEngineClass() {
 720                 return 'DifferenceEngine';
 721         }
 722
 723         /**
 724          * Attempts to merge differences between three versions. Returns a new
 725          * Content object for a clean merge and false for failure or a conflict.
 726          *
 727          * This default implementation always returns false.
 728          *
 729          * @since 1.21
 730          *
 731          * @param Content|string $oldContent The page's previous content.
 732          * @param Content|string $myContent One of the page's conflicting contents.
 733          * @param Content|string $yourContent One of the page's conflicting contents.
 734          *
 735          * @return Content|bool Always false.
 736          */
 737         public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
 738                 return false;
 739         }
 740
 741         /**
 742          * Return an applicable auto-summary if one exists for the given edit.
 743          *
 744          * @since 1.21
 745          *
 746          * @param Content $oldContent The previous text of the page.
 747          * @param Content $newContent The submitted text of the page.
 748          * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
 749          *
 750          * @return string An appropriate auto-summary, or an empty string.
 751          */
 752         public function getAutosummary( Content $oldContent = null, Content $newContent = null,
 753                 $flags ) {
 754                 // Decide what kind of auto-summary is needed.
 755
 756                 // Redirect auto-summaries
 757
 758                 /**
 759                  * @var $ot Title
 760                  * @var $rt Title
 761                  */
 762
 763                 $ot = !is_null( $oldContent ) ? $oldContent->getRedirectTarget() : null;
 764                 $rt = !is_null( $newContent ) ? $newContent->getRedirectTarget() : null;
 765
 766                 if ( is_object( $rt ) ) {
 767                         if ( !is_object( $ot )
 768                                 || !$rt->equals( $ot )
 769                                 || $ot->getFragment() != $rt->getFragment()
 770                         ) {
 771                                 $truncatedtext = $newContent->getTextForSummary(
 772                                         250
 773                                         - strlen( wfMessage( 'autoredircomment' )->inContentLanguage()->text() )
 774                                         - strlen( $rt->getFullText() ) );
 775
 776                                 return wfMessage( 'autoredircomment', $rt->getFullText() )
 777                                         ->rawParams( $truncatedtext )->inContentLanguage()->text();
 778                         }
 779                 }
 780
 781                 // New page auto-summaries
 782                 if ( $flags & EDIT_NEW && $newContent->getSize() > 0 ) {
 783                         // If they're making a new article, give its text, truncated, in
 784                         // the summary.
 785
 786                         $truncatedtext = $newContent->getTextForSummary(
 787                                 200 - strlen( wfMessage( 'autosumm-new' )->inContentLanguage()->text() ) );
 788
 789                         return wfMessage( 'autosumm-new' )->rawParams( $truncatedtext )
 790                                 ->inContentLanguage()->text();
 791                 }
 792
 793                 // Blanking auto-summaries
 794                 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
 795                         return wfMessage( 'autosumm-blank' )->inContentLanguage()->text();
 796                 } elseif ( !empty( $oldContent )
 797                         && $oldContent->getSize() > 10 * $newContent->getSize()
 798                         && $newContent->getSize() < 500
 799                 ) {
 800                         // Removing more than 90% of the article
 801
 802                         $truncatedtext = $newContent->getTextForSummary(
 803                                 200 - strlen( wfMessage( 'autosumm-replace' )->inContentLanguage()->text() ) );
 804
 805                         return wfMessage( 'autosumm-replace' )->rawParams( $truncatedtext )
 806                                 ->inContentLanguage()->text();
 807                 }
 808
 809                 // If we reach this point, there's no applicable auto-summary for our
 810                 // case, so our auto-summary is empty.
 811                 return '';
 812         }
 813
 814         /**
 815          * Auto-generates a deletion reason
 816          *
 817          * @since 1.21
 818          *
 819          * @param Title $title The page's title
 820          * @param bool &$hasHistory Whether the page has a history
 821          *
 822          * @return mixed String containing deletion reason or empty string, or
 823          *    boolean false if no revision occurred
 824          *
 825          * @XXX &$hasHistory is extremely ugly, it's here because
 826          * WikiPage::getAutoDeleteReason() and Article::generateReason()
 827          * have it / want it.
 828          */
 829         public function getAutoDeleteReason( Title $title, &$hasHistory ) {
 830                 $dbw = wfGetDB( DB_MASTER );
 831
 832                 // Get the last revision
 833                 $rev = Revision::newFromTitle( $title );
 834
 835                 if ( is_null( $rev ) ) {
 836                         return false;
 837                 }
 838
 839                 // Get the article's contents
 840                 $content = $rev->getContent();
 841                 $blank = false;
 842
 843                 // If the page is blank, use the text from the previous revision,
 844                 // which can only be blank if there's a move/import/protect dummy
 845                 // revision involved
 846                 if ( !$content || $content->isEmpty() ) {
 847                         $prev = $rev->getPrevious();
 848
 849                         if ( $prev ) {
 850                                 $rev = $prev;
 851                                 $content = $rev->getContent();
 852                                 $blank = true;
 853                         }
 854                 }
 855
 856                 $this->checkModelID( $rev->getContentModel() );
 857
 858                 // Find out if there was only one contributor
 859                 // Only scan the last 20 revisions
 860                 $res = $dbw->select( 'revision', 'rev_user_text',
 861                         array(
 862                                 'rev_page' => $title->getArticleID(),
 863                                 $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0'
 864                         ),
 865                         __METHOD__,
 866                         array( 'LIMIT' => 20 )
 867                 );
 868
 869                 if ( $res === false ) {
 870                         // This page has no revisions, which is very weird
 871                         return false;
 872                 }
 873
 874                 $hasHistory = ( $res->numRows() > 1 );
 875                 $row = $dbw->fetchObject( $res );
 876
 877                 if ( $row ) { // $row is false if the only contributor is hidden
 878                         $onlyAuthor = $row->rev_user_text;
 879                         // Try to find a second contributor
 880                         foreach ( $res as $row ) {
 881                                 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
 882                                         $onlyAuthor = false;
 883                                         break;
 884                                 }
 885                         }
 886                 } else {
 887                         $onlyAuthor = false;
 888                 }
 889
 890                 // Generate the summary with a '$1' placeholder
 891                 if ( $blank ) {
 892                         // The current revision is blank and the one before is also
 893                         // blank. It's just not our lucky day
 894                         $reason = wfMessage( 'exbeforeblank', '$1' )->inContentLanguage()->text();
 895                 } else {
 896                         if ( $onlyAuthor ) {
 897                                 $reason = wfMessage(
 898                                         'excontentauthor',
 899                                         '$1',
 900                                         $onlyAuthor
 901                                 )->inContentLanguage()->text();
 902                         } else {
 903                                 $reason = wfMessage( 'excontent', '$1' )->inContentLanguage()->text();
 904                         }
 905                 }
 906
 907                 if ( $reason == '-' ) {
 908                         // Allow these UI messages to be blanked out cleanly
 909                         return '';
 910                 }
 911
 912                 // Max content length = max comment length - length of the comment (excl. $1)
 913                 $text = $content ? $content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) : '';
 914
 915                 // Now replace the '$1' placeholder
 916                 $reason = str_replace( '$1', $text, $reason );
 917
 918                 return $reason;
 919         }
 920
 921         /**
 922          * Get the Content object that needs to be saved in order to undo all revisions
 923          * between $undo and $undoafter. Revisions must belong to the same page,
 924          * must exist and must not be deleted.
 925          *
 926          * @since 1.21
 927          *
 928          * @param Revision $current The current text
 929          * @param Revision $undo The revision to undo
 930          * @param Revision $undoafter Must be an earlier revision than $undo
 931          *
 932          * @return mixed String on success, false on failure
 933          */
 934         public function getUndoContent( Revision $current, Revision $undo, Revision $undoafter ) {
 935                 $cur_content = $current->getContent();
 936
 937                 if ( empty( $cur_content ) ) {
 938                         return false; // no page
 939                 }
 940
 941                 $undo_content = $undo->getContent();
 942                 $undoafter_content = $undoafter->getContent();
 943
 944                 if ( !$undo_content || !$undoafter_content ) {
 945                         return false; // no content to undo
 946                 }
 947
 948                 $this->checkModelID( $cur_content->getModel() );
 949                 $this->checkModelID( $undo_content->getModel() );
 950                 $this->checkModelID( $undoafter_content->getModel() );
 951
 952                 if ( $cur_content->equals( $undo_content ) ) {
 953                         // No use doing a merge if it's just a straight revert.
 954                         return $undoafter_content;
 955                 }
 956
 957                 $undone_content = $this->merge3( $undo_content, $undoafter_content, $cur_content );
 958
 959                 return $undone_content;
 960         }
 961
 962         /**
 963          * Get parser options suitable for rendering and caching the article
 964          *
 965          * @param IContextSource|User|string $context One of the following:
 966          *        - IContextSource: Use the User and the Language of the provided
 967          *                                            context
 968          *        - User: Use the provided User object and $wgLang for the language,
 969          *                                            so use an IContextSource object if possible.
 970          *        - 'canonical': Canonical options (anonymous user with default
 971          *                                            preferences and content language).
 972          *
 973          * @throws MWException
 974          * @return ParserOptions
 975          */
 976         public function makeParserOptions( $context ) {
 977                 global $wgContLang, $wgEnableParserLimitReporting;
 978
 979                 if ( $context instanceof IContextSource ) {
 980                         $options = ParserOptions::newFromContext( $context );
 981                 } elseif ( $context instanceof User ) { // settings per user (even anons)
 982                         $options = ParserOptions::newFromUser( $context );
 983                 } elseif ( $context === 'canonical' ) { // canonical settings
 984                         $options = ParserOptions::newFromUserAndLang( new User, $wgContLang );
 985                 } else {
 986                         throw new MWException( "Bad context for parser options: $context" );
 987                 }
 988
 989                 $options->enableLimitReport( $wgEnableParserLimitReporting ); // show inclusion/loop reports
 990                 $options->setTidy( true ); // fix bad HTML
 991
 992                 return $options;
 993         }
 994
 995         /**
 996          * Returns true for content models that support caching using the
 997          * ParserCache mechanism. See WikiPage::isParserCacheUsed().
 998          *
 999          * @since 1.21
1000          *
1001          * @return bool Always false.
1002          */
1003         public function isParserCacheSupported() {
1004                 return false;
1005         }
1006
1007         /**
1008          * Returns true if this content model supports sections.
1009          * This default implementation returns false.
1010          *
1011          * Content models that return true here should also implement
1012          * Content::getSection, Content::replaceSection, etc. to handle sections..
1013          *
1014          * @return bool Always false.
1015          */
1016         public function supportsSections() {
1017                 return false;
1018         }
1019
1020         /**
1021          * Returns true if this content model supports redirects.
1022          * This default implementation returns false.
1023          *
1024          * Content models that return true here should also implement
1025          * ContentHandler::makeRedirectContent to return a Content object.
1026          *
1027          * @return bool Always false.
1028          */
1029         public function supportsRedirects() {
1030                 return false;
1031         }
1032
1033         /**
1034          * Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if
1035          * self::$enableDeprecationWarnings is set to true.
1036          *
1037          * @param string $func The name of the deprecated function
1038          * @param string $version The version since the method is deprecated. Usually 1.21
1039          *   for ContentHandler related stuff.
1040          * @param string|bool $component : Component to which the function belongs.
1041          *   If false, it is assumed the function is in MediaWiki core.
1042          *
1043          * @see ContentHandler::$enableDeprecationWarnings
1044          * @see wfDeprecated
1045          */
1046         public static function deprecated( $func, $version, $component = false ) {
1047                 if ( self::$enableDeprecationWarnings ) {
1048                         wfDeprecated( $func, $version, $component, 3 );
1049                 }
1050         }
1051
1052         /**
1053          * Call a legacy hook that uses text instead of Content objects.
1054          * Will log a warning when a matching hook function is registered.
1055          * If the textual representation of the content is changed by the
1056          * hook function, a new Content object is constructed from the new
1057          * text.
1058          *
1059          * @param string $event Event name
1060          * @param array $args Parameters passed to hook functions
1061          * @param bool $warn Whether to log a warning.
1062          *                    Default to self::$enableDeprecationWarnings.
1063          *                    May be set to false for testing.
1064          *
1065          * @return bool True if no handler aborted the hook
1066          *
1067          * @see ContentHandler::$enableDeprecationWarnings
1068          */
1069         public static function runLegacyHooks( $event, $args = array(),
1070                 $warn = null
1071         ) {
1072
1073                 if ( $warn === null ) {
1074                         $warn = self::$enableDeprecationWarnings;
1075                 }
1076
1077                 if ( !Hooks::isRegistered( $event ) ) {
1078                         return true; // nothing to do here
1079                 }
1080
1081                 if ( $warn ) {
1082                         // Log information about which handlers are registered for the legacy hook,
1083                         // so we can find and fix them.
1084
1085                         $handlers = Hooks::getHandlers( $event );
1086                         $handlerInfo = array();
1087
1088                         wfSuppressWarnings();
1089
1090                         foreach ( $handlers as $handler ) {
1091                                 if ( is_array( $handler ) ) {
1092                                         if ( is_object( $handler[0] ) ) {
1093                                                 $info = get_class( $handler[0] );
1094                                         } else {
1095                                                 $info = $handler[0];
1096                                         }
1097
1098                                         if ( isset( $handler[1] ) ) {
1099                                                 $info .= '::' . $handler[1];
1100                                         }
1101                                 } elseif ( is_object( $handler ) ) {
1102                                         $info = get_class( $handler[0] );
1103                                         $info .= '::on' . $event;
1104                                 } else {
1105                                         $info = $handler;
1106                                 }
1107
1108                                 $handlerInfo[] = $info;
1109                         }
1110
1111                         wfRestoreWarnings();
1112
1113                         wfWarn( "Using obsolete hook $event via ContentHandler::runLegacyHooks()! Handlers: " .
1114                                 implode( ', ', $handlerInfo ), 2 );
1115                 }
1116
1117                 // convert Content objects to text
1118                 $contentObjects = array();
1119                 $contentTexts = array();
1120
1121                 foreach ( $args as $k => $v ) {
1122                         if ( $v instanceof Content ) {
1123                                 /* @var Content $v */
1124
1125                                 $contentObjects[$k] = $v;
1126
1127                                 $v = $v->serialize();
1128                                 $contentTexts[$k] = $v;
1129                                 $args[$k] = $v;
1130                         }
1131                 }
1132
1133                 // call the hook functions
1134                 $ok = wfRunHooks( $event, $args );
1135
1136                 // see if the hook changed the text
1137                 foreach ( $contentTexts as $k => $orig ) {
1138                         /* @var Content $content */
1139
1140                         $modified = $args[$k];
1141                         $content = $contentObjects[$k];
1142
1143                         if ( $modified !== $orig ) {
1144                                 // text was changed, create updated Content object
1145                                 $content = $content->getContentHandler()->unserializeContent( $modified );
1146                         }
1147
1148                         $args[$k] = $content;
1149                 }
1150
1151                 return $ok;
1152         }
1153 }