includes/content/ContentHandler.php

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