MediaWiki  1.23.8
DifferenceEngine Class Reference
Inheritance diagram for DifferenceEngine:
Collaboration diagram for DifferenceEngine:

Public Member Functions

 __construct ( $context=null, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
 #- More...
 
 addHeader ( $diff, $otitle, $ntitle, $multi='', $notice='')
 Add the header to a diff body. More...
 
 deletedIdMarker ( $id)
 Build a wikitext link toward a deleted revision, if viewable. More...
 
 deletedLink ( $id)
 Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to load deleted diffs in currently. More...
 
 generateContentDiffBody (Content $old, Content $new)
 Generate a diff, no caching. More...
 
 generateDiffBody ( $otext, $ntext)
 Generate a diff, no caching. More...
 
 generateTextDiffBody ( $otext, $ntext)
 Generate a diff, no caching. More...
 
 getDiff ( $otitle, $ntitle, $notice='')
 Get complete diff table, including header. More...
 
 getDiffBody ()
 Get the diff table body, without header. More...
 
 getDiffLang ()
 
 getMultiNotice ()
 If there are revisions between the ones being compared, return a note saying so. More...
 
 getNewid ()
 
 getOldid ()
 
 loadNewText ()
 Load the text of the new revision, not the old one. More...
 
 loadRevisionData ()
 Load revision metadata for the specified articles. More...
 
 loadText ()
 Load the text of the revisions, as well as revision data. More...
 
 localiseLineNumbers ( $text)
 Replace line numbers with the text in the user's language. More...
 
 localiseLineNumbersCb ( $matches)
 
 mapDiffPrevNext ( $old, $new)
 Maps a revision pair definition as accepted by DifferenceEngine constructor to a pair of actual integers representing revision ids. More...
 
 renderNewRevision ()
 Show the new revision of the page. More...
 
 setContent (Content $oldContent, Content $newContent)
 Use specified text instead of loading from the database. More...
 
 setReducedLineNumbers ( $value=true)
 
 setText ( $oldText, $newText)
 Use specified text instead of loading from the database. More...
 
 setTextLanguage ( $lang)
 Set the language in which the diff text is written (Defaults to page content language). More...
 
 showDiff ( $otitle, $ntitle, $notice='')
 Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated, otherwise returns true. More...
 
 showDiffPage ( $diffOnly=false)
 
 showDiffStyle ()
 Add style sheets and supporting JS for diff display. More...
 
 wasCacheHit ()
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the RequestContext object. More...
 
 getLang ()
 Get the Language object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Static Public Member Functions

static intermediateEditsMsg ( $numEdits, $numUsers, $limit)
 Get a notice about how many intermediate edits and users there are. More...
 

Public Attributes

 $enableDebugComment = false
 Set this to true to add debug info to the HTML output. More...
 
bool $mCacheHit = false
 Was the diff fetched from cache? *. More...
 
Content $mNewContent
 
int $mNewid
 
Title $mNewPage
 
Revision $mNewRev
 
Content $mOldContent
 
int $mOldid
 
Title $mOldPage
 
Revision $mOldRev
 
bool $mRevisionsLoaded = false
 Have the revisions been loaded *. More...
 
int $mTextLoaded = 0
 How many text blobs have been loaded, 0, 1 or 2? *. More...
 

Protected Member Functions

 debug ( $generator="internal")
 Generate a debug comment indicating diff generating time, server node, and generator backend. More...
 
 getDiffBodyCacheKey ()
 Returns the cache key for diff body text or content. More...
 
 getParserOutput (WikiPage $page, Revision $rev)
 
 getRevisionHeader (Revision $rev, $complete='')
 Get a header for a specified revision. More...
 
 markPatrolledLink ()
 Get a link to mark the change as patrolled, or '' if there's either no revision to patrol or the user is not allowed to to it. More...
 
 revisionDeleteLink ( $rev)
 

Protected Attributes

Language $mDiffLang
 
string $mMarkPatrolledLink = null
 Link to action=markpatrolled *. More...
 
bool $mReducedLineNumbers = false
 If true, line X is not displayed when X is 1, for example to increase readability and conserve space with many small diffs. More...
 
bool $unhide = false
 Show rev_deleted content if allowed *. More...
 

Private Member Functions

 loadRevisionIds ()
 Load revision IDs. More...
 
 showMissingRevision ()
 

Private Attributes

 $mNewTags
 
 $mOldTags
 
bool $mRevisionsIdsLoaded = false
 Have the revisions IDs been loaded *. More...
 

Detailed Description

Todo:
document

Definition at line 36 of file DifferenceEngine.php.

Constructor & Destructor Documentation

◆ __construct()

DifferenceEngine::__construct (   $context = null,
  $old = 0,
  $new = 0,
  $rcid = 0,
  $refreshCache = false,
  $unhide = false 
)

#-

Constructor

Parameters
IContextSource$contextcontext to use, anything else will be ignored
int$oldold ID we want to show and diff with.
string | int$neweither revision ID or 'prev' or 'next'. Default: 0.
int$rcidDeprecated, no longer used!
bool$refreshCacheIf set, refreshes the diff cache
bool$unhideIf set, allow viewing deleted revs

Definition at line 92 of file DifferenceEngine.php.

References ContextSource\$context, $unhide, ContextSource\setContext(), and wfDebug().

Member Function Documentation

◆ addHeader()

DifferenceEngine::addHeader (   $diff,
  $otitle,
  $ntitle,
  $multi = '',
  $notice = '' 
)

Add the header to a diff body.

Parameters
string$diffDiff body
string$otitleOld revision header
string$ntitleNew revision header
string$multiNotice telling user that there are intermediate revisions between the ones being compared
string$noticeOther notices, e.g. that user is viewing deleted content
Returns
string

Definition at line 1077 of file DifferenceEngine.php.

References getDiffLang().

Referenced by getDiff(), and showDiffPage().

◆ debug()

DifferenceEngine::debug (   $generator = "internal")
protected

Generate a debug comment indicating diff generating time, server node, and generator backend.

Parameters
string$generator: What diff engine was used
Returns
string

Definition at line 908 of file DifferenceEngine.php.

References array(), global, TS_DB, wfHostname(), and wfTimestamp().

Referenced by generateTextDiffBody().

◆ deletedIdMarker()

DifferenceEngine::deletedIdMarker (   $id)

Build a wikitext link toward a deleted revision, if viewable.

Parameters
int$idRevision ID
Returns
string Wikitext fragment

Definition at line 186 of file DifferenceEngine.php.

References $link, and deletedLink().

Referenced by showMissingRevision().

◆ deletedLink()

DifferenceEngine::deletedLink (   $id)

Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to load deleted diffs in currently.

Parameters
int$idRevision ID
Returns
mixed URL or false

Definition at line 159 of file DifferenceEngine.php.

References $dbr, $rev, $title, array(), DB_SLAVE, SpecialPage\getTitleFor(), ContextSource\getUser(), Title\makeTitleSafe(), Revision\newFromArchiveRow(), and wfGetDB().

Referenced by deletedIdMarker().

◆ generateContentDiffBody()

DifferenceEngine::generateContentDiffBody ( Content  $old,
Content  $new 
)

Generate a diff, no caching.

This implementation uses generateTextDiffBody() to generate a diff based on the default serialization of the given Content objects. This will fail if $old or $new are not instances of TextContent.

Subclasses may override this to provide a different rendering for the diff, perhaps taking advantage of the content's native form. This is required for all content models that are not text based.

Since
1.21
Parameters
Content$oldOld content
Content$newNew content
Exceptions
MWExceptionIf old or new content is not an instance of TextContent.
Returns
bool|string

Definition at line 783 of file DifferenceEngine.php.

References generateTextDiffBody(), and Content\serialize().

Referenced by getDiffBody().

◆ generateDiffBody()

DifferenceEngine::generateDiffBody (   $otext,
  $ntext 
)

Generate a diff, no caching.

Parameters
string$otextOld text, must be already segmented
string$ntextNew text, must be already segmented
Returns
bool|string
Deprecated:
since 1.21, use generateContentDiffBody() instead!

Definition at line 809 of file DifferenceEngine.php.

References ContentHandler\deprecated(), and generateTextDiffBody().

◆ generateTextDiffBody()

DifferenceEngine::generateTextDiffBody (   $otext,
  $ntext 
)

Generate a diff, no caching.

Todo:
move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.
Parameters
string$otextold text, must be already segmented
string$ntextnew text, must be already segmented
Returns
bool|string

Definition at line 825 of file DifferenceEngine.php.

References $wgContLang, debug(), global, wfEscapeShellArg(), wfProfileIn(), wfProfileOut(), wfShellExec(), and wfTempDir().

Referenced by generateContentDiffBody(), and generateDiffBody().

◆ getDiff()

DifferenceEngine::getDiff (   $otitle,
  $ntitle,
  $notice = '' 
)

Get complete diff table, including header.

Parameters
string | bool$otitleHeader for old text or false
string | bool$ntitleHeader for new text or false
string$noticeHTML between diff header and body
Returns
mixed

Definition at line 648 of file DifferenceEngine.php.

References addHeader(), getDiffBody(), getMultiNotice(), and ContextSource\msg().

Referenced by showDiff().

◆ getDiffBody()

DifferenceEngine::getDiffBody ( )

Get the diff table body, without header.

Returns
mixed (string/false)

Definition at line 670 of file DifferenceEngine.php.

References $wgMemc, array(), Revision\DELETED_TEXT, generateContentDiffBody(), getDiffBodyCacheKey(), global, loadRevisionData(), loadText(), localiseLineNumbers(), wfIncrStats(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by getDiff().

◆ getDiffBodyCacheKey()

DifferenceEngine::getDiffBodyCacheKey ( )
protected

Returns the cache key for diff body text or content.

Since
1.23
Exceptions
MWException
Returns
string

Definition at line 755 of file DifferenceEngine.php.

References MW_DIFF_VERSION, and wfMemcKey().

Referenced by getDiffBody().

◆ getDiffLang()

DifferenceEngine::getDiffLang ( )
Returns
Language

Definition at line 117 of file DifferenceEngine.php.

References $mDiffLang, and ContextSource\getTitle().

Referenced by addHeader().

◆ getMultiNotice()

DifferenceEngine::getMultiNotice ( )

If there are revisions between the ones being compared, return a note saying so.

Returns
string

Definition at line 952 of file DifferenceEngine.php.

References $limit, $mNewRev, $mOldRev, and intermediateEditsMsg().

Referenced by getDiff(), and showDiffPage().

◆ getNewid()

DifferenceEngine::getNewid ( )
Returns
bool|int

Definition at line 145 of file DifferenceEngine.php.

References $mNewid, and loadRevisionIds().

◆ getOldid()

DifferenceEngine::getOldid ( )
Returns
int

Definition at line 136 of file DifferenceEngine.php.

References $mOldid, and loadRevisionIds().

◆ getParserOutput()

DifferenceEngine::getParserOutput ( WikiPage  $page,
Revision  $rev 
)
protected

◆ getRevisionHeader()

DifferenceEngine::getRevisionHeader ( Revision  $rev,
  $complete = '' 
)
protected

Get a header for a specified revision.

Parameters
Revision$rev
string$complete'complete' to get the header wrapped depending the visibility of the revision and a link to edit the page.
Returns
string HTML fragment

Definition at line 1017 of file DifferenceEngine.php.

References $rev, $timestamp, $title, $user, array(), Revision\DELETED_TEXT, ContextSource\getLanguage(), ContextSource\getUser(), Revision\isCurrent(), Linker\linkKnown(), ContextSource\msg(), and Html\rawElement().

Referenced by renderNewRevision(), and showDiffPage().

◆ intermediateEditsMsg()

static DifferenceEngine::intermediateEditsMsg (   $numEdits,
  $numUsers,
  $limit 
)
static

Get a notice about how many intermediate edits and users there are.

Parameters
int$numEdits
int$numUsers
int$limit
Returns
string

Definition at line 995 of file DifferenceEngine.php.

References $limit, and wfMessage().

Referenced by getMultiNotice().

◆ loadNewText()

DifferenceEngine::loadNewText ( )

Load the text of the new revision, not the old one.

Returns
bool

Definition at line 1336 of file DifferenceEngine.php.

References Revision\FOR_THIS_USER, ContextSource\getUser(), and loadRevisionData().

Referenced by renderNewRevision().

◆ loadRevisionData()

DifferenceEngine::loadRevisionData ( )

Load revision metadata for the specified articles.

If newid is 0, then compare the old article in oldid to the current article; if oldid is 0, then compare the current article to the immediately previous one (ignoring the value of newid).

If oldid is false, leave the corresponding revision object set to false. This is impossible via ordinary user input, and is provided for API convenience.

Returns
bool

Definition at line 1222 of file DifferenceEngine.php.

References $dbr, $rev, array(), DB_SLAVE, ContextSource\getTitle(), loadRevisionIds(), Revision\newFromId(), Revision\newFromTitle(), IDBAccessObject\READ_NORMAL, and wfGetDB().

Referenced by getDiffBody(), loadNewText(), loadText(), and showDiffPage().

◆ loadRevisionIds()

DifferenceEngine::loadRevisionIds ( )
private

Load revision IDs.

Definition at line 1187 of file DifferenceEngine.php.

References $mNewid, $mOldid, array(), ContextSource\getTitle(), list, mapDiffPrevNext(), and wfRunHooks().

Referenced by getNewid(), getOldid(), and loadRevisionData().

◆ loadText()

DifferenceEngine::loadText ( )

Load the text of the revisions, as well as revision data.

Returns
bool

Definition at line 1302 of file DifferenceEngine.php.

References Revision\FOR_THIS_USER, ContextSource\getUser(), and loadRevisionData().

Referenced by getDiffBody().

◆ localiseLineNumbers()

DifferenceEngine::localiseLineNumbers (   $text)

Replace line numbers with the text in the user's language.

Parameters
string$text
Returns
mixed

Definition at line 931 of file DifferenceEngine.php.

References array().

Referenced by getDiffBody().

◆ localiseLineNumbersCb()

DifferenceEngine::localiseLineNumbersCb (   $matches)

Definition at line 939 of file DifferenceEngine.php.

References $matches, and ContextSource\msg().

◆ mapDiffPrevNext()

DifferenceEngine::mapDiffPrevNext (   $old,
  $new 
)

Maps a revision pair definition as accepted by DifferenceEngine constructor to a pair of actual integers representing revision ids.

Parameters
int$oldRevision id, e.g. from URL parameter 'oldid'
int | string$newRevision id or strings 'next' or 'prev', e.g. from URL parameter 'diff'
Returns
int[] List of two revision ids, older first, later second. Zero signifies invalid argument passed. false signifies that there is no previous/next revision ($old is the oldest/newest one).

Definition at line 1167 of file DifferenceEngine.php.

References array(), and ContextSource\getTitle().

Referenced by loadRevisionIds().

◆ markPatrolledLink()

DifferenceEngine::markPatrolledLink ( )
protected

Get a link to mark the change as patrolled, or '' if there's either no revision to patrol or the user is not allowed to to it.

Side effect: When the patrol link is build, this method will call OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.

Returns
string

Definition at line 443 of file DifferenceEngine.php.

References $mMarkPatrolledLink, $user, array(), DB_SLAVE, ContextSource\getOutput(), ContextSource\getUser(), global, RecentChange\isInRCLifespan(), Linker\linkKnown(), ContextSource\msg(), RecentChange\newFromConds(), and wfGetDB().

Referenced by renderNewRevision(), and showDiffPage().

◆ renderNewRevision()

◆ revisionDeleteLink()

DifferenceEngine::revisionDeleteLink (   $rev)
protected
Parameters
Revision$rev
Returns
string

Definition at line 512 of file DifferenceEngine.php.

References $link, $rev, Linker\getRevDeleteLink(), and ContextSource\getUser().

Referenced by showDiffPage().

◆ setContent()

DifferenceEngine::setContent ( Content  $oldContent,
Content  $newContent 
)

Use specified text instead of loading from the database.

Since
1.21

Definition at line 1139 of file DifferenceEngine.php.

Referenced by setText().

◆ setReducedLineNumbers()

DifferenceEngine::setReducedLineNumbers (   $value = true)
Parameters
bool$value

Definition at line 110 of file DifferenceEngine.php.

References $value.

◆ setText()

DifferenceEngine::setText (   $oldText,
  $newText 
)

Use specified text instead of loading from the database.

Deprecated:
since 1.21, use setContent() instead.

Definition at line 1126 of file DifferenceEngine.php.

References ContentHandler\deprecated(), ContextSource\getTitle(), ContentHandler\makeContent(), and setContent().

◆ setTextLanguage()

DifferenceEngine::setTextLanguage (   $lang)

Set the language in which the diff text is written (Defaults to page content language).

Since
1.19

Definition at line 1152 of file DifferenceEngine.php.

References wfGetLangObj().

◆ showDiff()

DifferenceEngine::showDiff (   $otitle,
  $ntitle,
  $notice = '' 
)

Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated, otherwise returns true.

Parameters
string | bool$otitleHeader for old text or false
string | bool$ntitleHeader for new text or false
string$noticeHTML between diff header and body
Returns
bool

Definition at line 618 of file DifferenceEngine.php.

References getDiff(), ContextSource\getOutput(), showDiffStyle(), and showMissingRevision().

Referenced by showDiffPage().

◆ showDiffPage()

◆ showDiffStyle()

DifferenceEngine::showDiffStyle ( )

Add style sheets and supporting JS for diff display.

Definition at line 635 of file DifferenceEngine.php.

References ContextSource\getOutput().

Referenced by showDiff(), and showDiffPage().

◆ showMissingRevision()

DifferenceEngine::showMissingRevision ( )
private

◆ wasCacheHit()

DifferenceEngine::wasCacheHit ( )
Returns
bool

Definition at line 129 of file DifferenceEngine.php.

References $mCacheHit.

Member Data Documentation

◆ $enableDebugComment

DifferenceEngine::$enableDebugComment = false

Set this to true to add debug info to the HTML output.

Warning: this may cause RSS readers to spuriously mark articles as "new" (bug 20601)

Definition at line 72 of file DifferenceEngine.php.

◆ $mCacheHit

bool DifferenceEngine::$mCacheHit = false

Was the diff fetched from cache? *.

Definition at line 65 of file DifferenceEngine.php.

Referenced by wasCacheHit().

◆ $mDiffLang

Language DifferenceEngine::$mDiffLang
protected

Definition at line 49 of file DifferenceEngine.php.

Referenced by getDiffLang().

◆ $mMarkPatrolledLink

string DifferenceEngine::$mMarkPatrolledLink = null
protected

Link to action=markpatrolled *.

Definition at line 78 of file DifferenceEngine.php.

Referenced by markPatrolledLink().

◆ $mNewContent

Content DifferenceEngine::$mNewContent

Definition at line 47 of file DifferenceEngine.php.

◆ $mNewid

int DifferenceEngine::$mNewid

Definition at line 40 of file DifferenceEngine.php.

Referenced by getNewid(), and loadRevisionIds().

◆ $mNewPage

Title DifferenceEngine::$mNewPage

Definition at line 53 of file DifferenceEngine.php.

◆ $mNewRev

Revision DifferenceEngine::$mNewRev

Definition at line 57 of file DifferenceEngine.php.

Referenced by getMultiNotice().

◆ $mNewTags

DifferenceEngine::$mNewTags
private

Definition at line 43 of file DifferenceEngine.php.

◆ $mOldContent

Content DifferenceEngine::$mOldContent

Definition at line 45 of file DifferenceEngine.php.

◆ $mOldid

int DifferenceEngine::$mOldid

Definition at line 38 of file DifferenceEngine.php.

Referenced by getOldid(), and loadRevisionIds().

◆ $mOldPage

Title DifferenceEngine::$mOldPage

Definition at line 51 of file DifferenceEngine.php.

◆ $mOldRev

Revision DifferenceEngine::$mOldRev

Definition at line 55 of file DifferenceEngine.php.

Referenced by getMultiNotice().

◆ $mOldTags

DifferenceEngine::$mOldTags
private

Definition at line 42 of file DifferenceEngine.php.

◆ $mReducedLineNumbers

bool DifferenceEngine::$mReducedLineNumbers = false
protected

If true, line X is not displayed when X is 1, for example to increase readability and conserve space with many small diffs.

Definition at line 76 of file DifferenceEngine.php.

◆ $mRevisionsIdsLoaded

bool DifferenceEngine::$mRevisionsIdsLoaded = false
private

Have the revisions IDs been loaded *.

Definition at line 59 of file DifferenceEngine.php.

◆ $mRevisionsLoaded

bool DifferenceEngine::$mRevisionsLoaded = false

Have the revisions been loaded *.

Definition at line 61 of file DifferenceEngine.php.

◆ $mTextLoaded

int DifferenceEngine::$mTextLoaded = 0

How many text blobs have been loaded, 0, 1 or 2? *.

Definition at line 63 of file DifferenceEngine.php.

◆ $unhide

bool DifferenceEngine::$unhide = false
protected

Show rev_deleted content if allowed *.

Definition at line 80 of file DifferenceEngine.php.

Referenced by __construct().


The documentation for this class was generated from the following file: