<?php
-# $Id$
/**
* File for articles
+ * @version $Id$
+ * @package MediaWiki
*/
/**
* See design.doc for an overview.
* Note: edit user interface and cache support functions have been
* moved to separate EditPage and CacheManager classes.
+ *
+ * @version $Id$
+ * @package MediaWiki
*/
class Article {
/**#@+
/**
* Constructor and clear the article
+ * @param mixed &$title
*/
function Article( &$title ) {
$this->mTitle =& $title;
* @static
* @param integer $row Id of a row
* @param string $prefix table prefix (default 'old_')
- * @return string $text the text requested
+ * @return string $text|false the text requested
*/
function getRevisionText( $row, $prefix = 'old_' ) {
# Get data
/**
* If $wgCompressRevisions is enabled, we will compress datas
* @static
- * @param reference to a text
+ * @param mixed $text reference to a text
* @return string 'gzip' if it get compressed, '' overwise
*/
function compressRevisionText( &$text ) {
/**
* Returns the text associated with a "link" type old table row
* @static
+ * @param mixed $link
+ * @return string $text|false
*/
function followLink( $link ) {
# Split the link into fields and values
/**
* @static
+ * @param $location
+ * @param $hash
*/
function fetchFromLocation( $location, $hash ) {
global $wgLoadBalancer;
* Note that getContent/loadContent may follow redirects if
* not told otherwise, and so may cause a change to mTitle.
*
- * Return the text of this revision
+ * @param $noredir
+ * @return Return the text of this revision
*/
function getContent( $noredir ) {
global $wgRequest;
* the first section before any such heading (section 0).
*
* If a section contains subsections, these are also returned.
- */
+ *
+ * @param string $text text to look in
+ * @param integer $section section number
+ * @return string text of the requested section
+ */
function getSection($text,$section) {
# strip NOWIKI etc. to avoid confusion (true-parameter causes HTML
/**
* Return an array of the columns of the "cur"-table
- */
+ */
function &getCurContentFields() {
global $wgArticleCurContentFields;
if ( !$wgArticleCurContentFields ) {
/**
* Return an array of the columns of the "old"-table
- */
+ */
function &getOldContentFields() {
global $wgArticleOldContentFields;
if ( !$wgArticleOldContentFields ) {
* Load the revision (including cur_text) into this object
*/
function loadContent( $noredir = false ) {
- global $wgOut, $wgMwRedir, $wgRequest;
+ global $wgOut, $wgRequest;
+ if ( $this->mContentLoaded ) return;
+
$dbr =& $this->getDB();
# Query variables :P
$oldid = $wgRequest->getVal( 'oldid' );
$redirect = $wgRequest->getVal( 'redirect' );
- if ( $this->mContentLoaded ) return;
$fname = 'Article::loadContent';
# Pre-fill content with error message so that if something
/**
* Gets the article text without using so many damn globals
* Returns false on error
- */
+ *
+ * @param integer $oldid
+ */
function getContentWithoutUsingSoManyDamnGlobals( $oldid = 0, $noredir = false ) {
- global $wgMwRedir;
-
if ( $this->mContentLoaded ) {
return $this->mContent;
}
}
}
- /*
- * @todo document function
+ /**
+ * Get the view count for this article
*/
function getCount() {
if ( -1 == $this->mCounter ) {
* suitable for including in the article count)?
*/
function isCountable( $text ) {
- global $wgUseCommaCount, $wgMwRedir;
+ global $wgUseCommaCount;
if ( 0 != $this->mTitle->getNamespace() ) { return 0; }
- if ( $wgMwRedir->matchStart( $text ) ) { return 0; }
+ if ( $this->isRedirect( $text ) ) { return 0; }
$token = ($wgUseCommaCount ? ',' : '[[' );
if ( false === strstr( $text, $token ) ) { return 0; }
return 1;
}
+ /**
+ * Tests if the article text represents a redirect
+ */
+ function isRedirect( $text = false ) {
+ if ( $text === false ) {
+ $this->loadContent();
+ $titleObj = Title::newFromRedirect( $this->mText );
+ } else {
+ $titleObj = Title::newFromRedirect( $text );
+ }
+ return $titleObj !== NULL;
+ }
+
/**
* Loads everything from cur except cur_text
* This isn't necessary for all uses, so it's only done if needed.
$dbr =& $this->getDB();
$oldTable = $dbr->tableName( 'old' );
$userTable = $dbr->tableName( 'user' );
- $encDBkey = $dbr->strencode( $title->getDBkey() );
+ $encDBkey = $dbr->addQuotes( $title->getDBkey() );
$ns = $title->getNamespace();
$user = $this->getUser();
WHERE old_namespace = $user
AND old_title = $encDBkey
AND old_user != $user
- GROUP BY old_user
+ GROUP BY old_user, old_user_text, user_real_name
ORDER BY timestamp DESC";
if ($limit > 0) { $sql .= ' LIMIT '.$limit; }
* the given title.
*/
function view() {
- global $wgUser, $wgOut, $wgLang, $wgRequest, $wgMwRedir, $wgOnlySysopsCanPatrol;
+ global $wgUser, $wgOut, $wgRequest, $wgOnlySysopsCanPatrol;
global $wgLinkCache, $IP, $wgEnableParserCache, $wgStylePath, $wgUseRCPatrol;
$sk = $wgUser->getSkin();
$wgOut->addHTML( '<pre>'.htmlspecialchars($this->mContent)."\n</pre>" );
} else if ( $rt = Title::newFromRedirect( $text ) ) {
# Display redirect
- $imageUrl = $wgStylePath.'/images/redirect.png';
+ $imageUrl = $wgStylePath.'/common/images/redirect.png';
$targetUrl = $rt->escapeLocalURL();
$titleText = htmlspecialchars( $rt->getPrefixedText() );
$link = $sk->makeLinkObj( $rt );
* @private
*/
function insertNewArticle( $text, $summary, $isminor, $watchthis ) {
- global $wgOut, $wgUser, $wgMwRedir;
+ global $wgOut, $wgUser;
global $wgUseSquid, $wgDeferredUpdateList, $wgInternalServer;
$fname = 'Article::insertNewArticle';
$ns = $this->mTitle->getNamespace();
$ttl = $this->mTitle->getDBkey();
$text = $this->preSaveTransform( $text );
- if ( $wgMwRedir->matchStart( $text ) ) { $redir = 1; }
+ if ( $this->isRedirect( $text ) ) { $redir = 1; }
else { $redir = 0; }
$now = wfTimestampNow();
/**
- * Side effects: loads last edit
+ * Side effects: loads last edit if $edittime is NULL
*/
- function getTextOfLastEditWithSectionReplacedOrAdded($section, $text, $summary = '') {
- $this->loadLastEdit();
- $oldtext = $this->getContent( true );
+ function getTextOfLastEditWithSectionReplacedOrAdded($section, $text, $summary = '', $edittime = NULL) {
+ $fname = 'Article::getTextOfLastEditWithSectionReplacedOrAdded';
+ if(is_null($edittime)) {
+ $this->loadLastEdit();
+ $oldtext = $this->getContent( true );
+ } else {
+ $dbw =& wfGetDB( DB_MASTER );
+ $ns = $this->mTitle->getNamespace();
+ $title = $this->mTitle->getDBkey();
+ $obj = $dbw->getArray( 'old',
+ array( 'old_text','old_flags'),
+ array( 'old_namespace' => $ns, 'old_title' => $title,
+ 'old_timestamp' => $dbw->timestamp($edittime)),
+ $fname );
+ $oldtext = Article::getRevisionText( $obj );
+ }
if ($section != '') {
if($section=='new') {
if($summary) $subject="== {$summary} ==\n\n";
}
/**
- * @todo document this function
+ * Change an existing article. Puts the previous version back into the old table, updates RC
+ * and all necessary caches, mostly via the deferred update array.
+ *
+ * It is possible to call this function from a command-line script, but note that you should
+ * first set $wgUser, and clean up $wgDeferredUpdates after each edit.
*/
function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
global $wgOut, $wgUser;
if ( $this->mMinorEdit ) { $me1 = 1; } else { $me1 = 0; }
if ( $minor && $wgUser->getID() ) { $me2 = 1; } else { $me2 = 0; }
- if ( preg_match( "/^((" . $wgMwRedir->getBaseRegex() . ')[^\\n]+)/i', $text, $m ) ) {
- $redir = 1;
- $text = $m[1] . "\n"; # Remove all content but redirect
+ if ( $this->isRedirect( $text ) ) {
+ # Remove all content but redirect
+ # This could be done by reconstructing the redirect from a title given by
+ # Title::newFromRedirect(), but then we wouldn't know which synonym the user
+ # wants to see
+ if ( preg_match( "/^((" . $wgMwRedir->getBaseRegex() . ')[^\\n]+)/i', $text, $m ) ) {
+ $redir = 1;
+ $text = $m[1] . "\n";
+ }
}
else { $redir = 0; }
*/
function showArticle( $text, $subtitle , $sectionanchor = '' ) {
global $wgOut, $wgUser, $wgLinkCache;
- global $wgMwRedir;
$wgLinkCache = new LinkCache();
# Select for update
# Look up the links in the DB and add them to the link cache
$wgOut->transformBuffer( RLH_FOR_UPDATE );
- if( $wgMwRedir->matchStart( $text ) )
+ if( $this->isRedirect( $text ) )
$r = 'redirect=no';
else
$r = '';
* Add or remove this page to my watchlist based on value of $add
*/
function watch( $add = true ) {
- global $wgUser, $wgOut, $wgLang;
+ global $wgUser, $wgOut;
global $wgDeferredUpdateList;
if ( 0 == $wgUser->getID() ) {
* Perform a deletion and output success or failure messages
*/
function doDelete( $reason ) {
- global $wgOut, $wgUser, $wgLang;
+ global $wgOut, $wgUser, $wgContLang;
$fname = 'Article::doDelete';
wfDebug( $fname."\n" );
$wgOut->setRobotpolicy( 'noindex,nofollow' );
$sk = $wgUser->getSkin();
- $loglink = $sk->makeKnownLink( $wgLang->getNsText( NS_PROJECT ) .
- ':' . wfMsg( 'dellogpage' ), wfMsg( 'deletionlog' ) );
+ $loglink = $sk->makeKnownLink( $wgContLang->getNsText( NS_PROJECT ) .
+ ':' . wfMsgForContent( 'dellogpage' ), wfMsg( 'deletionlog' ) );
$text = wfMsg( 'deletedtext', $deleted, $loglink );
* Returns success
*/
function doDeleteArticle( $reason ) {
- global $wgUser, $wgLang;
+ global $wgUser;
global $wgUseSquid, $wgDeferredUpdateList, $wgInternalServer;
$fname = 'Article::doDeleteArticle';
* Revert a modification
*/
function rollback() {
- global $wgUser, $wgLang, $wgOut, $wgRequest;
+ global $wgUser, $wgOut, $wgRequest;
$fname = 'Article::rollback';
if ( ! $wgUser->isSysop() ) {
* Do standard deferred updates after page edit.
* Every 1000th edit, prune the recent changes table.
* @private
+ * @param string $text
*/
function editUpdates( $text ) {
global $wgDeferredUpdateList, $wgDBname, $wgMemc;
wfSeedRandom();
if ( 0 == mt_rand( 0, 999 ) ) {
$dbw =& wfGetDB( DB_MASTER );
- $cutoff = wfUnix2Timestamp( time() - ( 7 * 86400 ) );
+ $cutoff = $dbw->timestamp( time() - ( 7 * 86400 ) );
$sql = "DELETE FROM recentchanges WHERE rc_timestamp < '{$cutoff}'";
$dbw->query( $sql );
}
/**
* This function is called right before saving the wikitext,
* so we can do things like signatures and links-in-context.
+ *
+ * @param string $text
*/
function preSaveTransform( $text ) {
global $wgParser, $wgUser;
/* Caching functions */
- # checkLastModified returns true if it has taken care of all
- # output to the client that is necessary for this request.
- # (that is, it has sent a cached version of the page)
+ /**
+ * checkLastModified returns true if it has taken care of all
+ * output to the client that is necessary for this request.
+ * (that is, it has sent a cached version of the page)
+ */
function tryFileCache() {
static $called = false;
if( $called ) {
wfDebug( " tryFileCache() - not cacheable\n" );
}
}
-
+
+ /**
+ * Check if the page can be cached
+ * @return bool
+ */
function isFileCacheable() {
global $wgUser, $wgUseFileCache, $wgShowIPinHeader, $wgRequest;
extract( $wgRequest->getValues( 'action', 'oldid', 'diff', 'redirect', 'printable' ) );
and (!$this->mRedirectedFrom);
}
- # Loads cur_touched and returns a value indicating if it should be used
+ /**
+ * Loads cur_touched and returns a value indicating if it should be used
+ *
+ */
function checkTouched() {
$fname = 'Article::checkTouched';
$id = $this->getID();
}
}
- # Edit an article without doing all that other stuff
+ /**
+ * Edit an article without doing all that other stuff
+ *
+ * @param string $text text submitted
+ * @param string $comment comment submitted
+ * @param integer $minor whereas it's a minor modification
+ */
function quickEdit( $text, $comment = '', $minor = 0 ) {
- global $wgUser, $wgMwRedir;
+ global $wgUser;
$fname = 'Article::quickEdit';
wfProfileIn( $fname );
'cur_user_text' => $wgUser->getName(),
'inverse_timestamp' => wfInvertTimestamp( $timestamp ),
'cur_comment' => $comment,
- 'cur_is_redirect' => $wgMwRedir->matchStart( $text ) ? 1 : 0,
+ 'cur_is_redirect' => $this->isRedirect( $text ) ? 1 : 0,
'cur_minor_edit' => intval($minor),
'cur_touched' => $dbw->timestamp($timestamp),
);
wfProfileOut( $fname );
}
- /* static */ function incViewCount( $id ) {
+ /**
+ * Used to increment the view counter
+ *
+ * @static
+ * @param integer $id article id
+ */
+ function incViewCount( $id ) {
$id = intval( $id );
global $wgHitcounterUpdateFreq;
$dbw->ignoreErrors( $oldignore );
}
- /**
+ /**#@+
* The onArticle*() functions are supposed to be a kind of hooks
* which should be called whenever any of the specified actions
* are done.
* @static
* @param $title_obj a title object
*/
+
function onArticleCreate($title_obj) {
global $wgUseSquid, $wgDeferredUpdateList;
LinkCache::linksccClearBrokenLinksTo( $title_obj->getPrefixedDBkey() );
}
- /**
- * @static
- */
function onArticleDelete($title_obj) {
LinkCache::linksccClearLinksTo( $title_obj->getArticleID() );
}
-
- /**
- * @static
- */
function onArticleEdit($title_obj) {
LinkCache::linksccClearPage( $title_obj->getArticleID() );
}
-
+ /**#@-*/
/**
* Info about this page
*/
function info() {
- global $wgUser, $wgTitle, $wgOut, $wgLang, $wgAllowPageInfo;
+ global $wgUser, $wgTitle, $wgOut, $wgAllowPageInfo;
$fname = 'Article::info';
if ( !$wgAllowPageInfo ) {