<?php
-# $Id$
-#
-# Class representing a Wikipedia article and history.
-# See design.doc for an overview.
-
-# Note: edit user interface and cache support functions have been
-# moved to separate EditPage and CacheManager classes.
-
+/**
+ * File for articles
+ * @version $Id$
+ * @package MediaWiki
+ */
+
+/**
+ * Need the CacheManager to be loaded
+ */
require_once ( 'CacheManager.php' );
$wgArticleCurContentFields = false;
$wgArticleOldContentFields = false;
+/**
+ * Class representing a Wikipedia article and history.
+ *
+ * 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 {
- /* private */ var $mContent, $mContentLoaded;
- /* private */ var $mUser, $mTimestamp, $mUserText;
- /* private */ var $mCounter, $mComment, $mCountAdjustment;
- /* private */ var $mMinorEdit, $mRedirectedFrom;
- /* private */ var $mTouched, $mFileCache, $mTitle;
- /* private */ var $mId, $mTable;
- /* private */ var $mForUpdate;
-
+ /**#@+
+ * @access private
+ */
+ var $mContent, $mContentLoaded;
+ var $mUser, $mTimestamp, $mUserText;
+ var $mCounter, $mComment, $mCountAdjustment;
+ var $mMinorEdit, $mRedirectedFrom;
+ var $mTouched, $mFileCache, $mTitle;
+ var $mId, $mTable;
+ var $mForUpdate;
+ /**#@-*/
+
+ /**
+ * Constructor and clear the article
+ * @param mixed &$title
+ */
function Article( &$title ) {
$this->mTitle =& $title;
$this->clear();
}
- /* private */ function clear() {
+ /**
+ * Clear the object
+ * @private
+ */
+ function clear() {
$this->mContentLoaded = false;
$this->mCurID = $this->mUser = $this->mCounter = -1; # Not loaded
$this->mRedirectedFrom = $this->mUserText =
$this->mForUpdate = false;
}
- # Get revision text associated with an old or archive row
- # $row is usually an object from wfFetchRow(), both the flags and the text field must be included
- /* static */ function getRevisionText( $row, $prefix = 'old_' ) {
+ /**
+ * Get revision text associated with an old or archive row
+ * $row is usually an object from wfFetchRow(), both the flags and the text
+ * field must be included
+ * @static
+ * @param integer $row Id of a row
+ * @param string $prefix table prefix (default 'old_')
+ * @return string $text|false the text requested
+ */
+ function getRevisionText( $row, $prefix = 'old_' ) {
# Get data
$textField = $prefix . 'text';
$flagsField = $prefix . 'flags';
return $text;
}
- /* static */ function compressRevisionText( &$text ) {
+ /**
+ * If $wgCompressRevisions is enabled, we will compress datas
+ * @static
+ * @param mixed $text reference to a text
+ * @return string 'gzip' if it get compressed, '' overwise
+ */
+ function compressRevisionText( &$text ) {
global $wgCompressRevisions;
if( !$wgCompressRevisions ) {
return '';
return 'gzip';
}
- # Returns the text associated with a "link" type old table row
- /* static */ function followLink( $link ) {
+ /**
+ * 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
$lines = explode( '\n', $link );
$hash = '';
return $text;
}
- /* static */ function fetchFromLocation( $location, $hash ) {
+ /**
+ * @static
+ * @param $location
+ * @param $hash
+ */
+ function fetchFromLocation( $location, $hash ) {
global $wgLoadBalancer;
$fname = 'fetchFromLocation';
wfProfileIn( $fname );
return $text;
}
- # 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
+ /**
+ * Note that getContent/loadContent may follow redirects if
+ * not told otherwise, and so may cause a change to mTitle.
+ *
+ * @param $noredir
+ * @return Return the text of this revision
+ */
function getContent( $noredir ) {
global $wgRequest;
}
}
- # This function returns the text of a section, specified by a number ($section).
- # A section is text under a heading like == Heading == or <h1>Heading</h1>, or
- # the first section before any such heading (section 0).
- #
- # If a section contains subsections, these are also returned.
- #
+ /**
+ * This function returns the text of a section, specified by a number ($section).
+ * A section is text under a heading like == Heading == or <h1>Heading</h1>, or
+ * 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
+ /**
+ * Return an array of the columns of the "cur"-table
+ */
function &getCurContentFields() {
global $wgArticleCurContentFields;
if ( !$wgArticleCurContentFields ) {
return $wgArticleCurContentFields;
}
- # Return an array of the columns of the "old"-table
+ /**
+ * Return an array of the columns of the "old"-table
+ */
function &getOldContentFields() {
global $wgArticleOldContentFields;
if ( !$wgArticleOldContentFields ) {
return $wgArticleOldContentFields;
}
- # Load the revision (including cur_text) into this object
+ /**
+ * 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
return $this->mContent;
}
- # Gets the article text without using so many damn globals
- # Returns false on error
+ /**
+ * 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;
}
return $this->mContent;
}
- # Read/write accessor to select FOR UPDATE
+ /**
+ * Read/write accessor to select FOR UPDATE
+ */
function forUpdate( $x = NULL ) {
return wfSetVar( $this->mForUpdate, $x );
}
- # Get the database which should be used for reads
+ /**
+ * Get the database which should be used for reads
+ */
function &getDB() {
if ( $this->mForUpdate ) {
return wfGetDB( DB_MASTER );
}
}
- # Get options for all SELECT statements
- # Can pass an option array, to which the class-wide options will be appended
+ /**
+ * Get options for all SELECT statements
+ * Can pass an option array, to which the class-wide options will be appended
+ */
function getSelectOptions( $options = '' ) {
if ( $this->mForUpdate ) {
if ( $options ) {
return $options;
}
+ /**
+ * Return the Article ID
+ */
function getID() {
if( $this->mTitle ) {
return $this->mTitle->getArticleID();
}
}
+ /**
+ * Get the view count for this article
+ */
function getCount() {
if ( -1 == $this->mCounter ) {
$id = $this->getID();
return $this->mCounter;
}
- # Would the given text make this article a "good" article (i.e.,
- # suitable for including in the article count)?
+ /**
+ * Would the given text make this article a "good" article (i.e.,
+ * 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;
}
- # Loads everything from cur except cur_text
- # This isn't necessary for all uses, so it's only done if needed.
- /* private */ function loadLastEdit() {
+ /**
+ * 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.
+ * @private
+ */
+ function loadLastEdit() {
global $wgOut;
if ( -1 != $this->mUser ) return;
$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; }
return $contribs;
}
- # This is the default action of the script: just view the page of
- # the given title.
-
+ /**
+ * This is the default action of the script: just view the page of
+ * the given title.
+ */
function view() {
- global $wgUser, $wgOut, $wgLang, $wgRequest, $wgMwRedir, $wgOnlySysopsCanPatrol;
+ global $wgUser, $wgOut, $wgLang, $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 );
wfProfileOut( $fname );
}
- # Theoretically we could defer these whole insert and update
- # functions for after display, but that's taking a big leap
- # of faith, and we want to be able to report database
- # errors at some point.
-
- /* private */ function insertNewArticle( $text, $summary, $isminor, $watchthis ) {
- global $wgOut, $wgUser, $wgMwRedir;
+ /**
+ * Theoretically we could defer these whole insert and update
+ * functions for after display, but that's taking a big leap
+ * of faith, and we want to be able to report database
+ * errors at some point.
+ * @private
+ */
+ function insertNewArticle( $text, $summary, $isminor, $watchthis ) {
+ 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 */
- function getTextOfLastEditWithSectionReplacedOrAdded($section, $text, $summary = '') {
- $this->loadLastEdit();
- $oldtext = $this->getContent( true );
+ /**
+ * Side effects: loads last edit if $edittime is NULL
+ */
+ 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";
return $text;
}
+ /**
+ * 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;
global $wgDBtransactions, $wgMwRedir;
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; }
return $good;
}
- # After we've either updated or inserted the article, update
- # the link tables and redirect to the new page.
-
+ /**
+ * After we've either updated or inserted the article, update
+ * the link tables and redirect to the new page.
+ */
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 = '';
$wgOut->redirect( $this->mTitle->getFullURL( $r ).$sectionanchor );
}
- # Validate article
-
+ /**
+ * Validate article
+ * @todo document this function a bit more
+ */
function validate () {
global $wgOut, $wgUseValidation;
if( $wgUseValidation ) {
}
}
- # Mark this particular edit as patrolled
+ /**
+ * Mark this particular edit as patrolled
+ */
function markpatrolled() {
global $wgOut, $wgRequest, $wgOnlySysopsCanPatrol, $wgUseRCPatrol, $wgUser;
$wgOut->setRobotpolicy( 'noindex,follow' );
}
- # Add this page to my watchlist
-
+ /**
+ * Add or remove this page to my watchlist based on value of $add
+ */
function watch( $add = true ) {
global $wgUser, $wgOut, $wgLang;
global $wgDeferredUpdateList;
$wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
}
+ /**
+ * Stop watching a page, it act just like a call to watch(false)
+ */
function unwatch() {
$this->watch( false );
}
- # protect a page
-
+ /**
+ * protect a page
+ */
function protect( $limit = 'sysop' ) {
global $wgUser, $wgOut, $wgRequest;
}
}
- # Output protection confirmation dialog
-
+ /**
+ * Output protection confirmation dialog
+ */
function confirmProtect( $par, $reason, $limit = 'sysop' ) {
global $wgOut;
$wgOut->returnToMain( false );
}
+ /**
+ * Unprotect the pages
+ */
function unprotect() {
return $this->protect( '' );
}
- # UI entry point for page deletion
-
+ /*
+ * UI entry point for page deletion
+ */
function delete() {
global $wgUser, $wgOut, $wgMessageCache, $wgRequest;
$fname = 'Article::delete';
return $this->confirmDelete( '', $reason );
}
- # Output deletion confirmation dialog
-
+ /**
+ * Output deletion confirmation dialog
+ */
function confirmDelete( $par, $reason ) {
global $wgOut;
}
- # Perform a deletion and output success or failure messages
-
+ /**
+ * Perform a deletion and output success or failure messages
+ */
function doDelete( $reason ) {
global $wgOut, $wgUser, $wgLang;
$fname = 'Article::doDelete';
}
}
- # Back-end article deletion
- # Deletes the article with database consistency, writes logs, purges caches
- # Returns success
+ /**
+ * Back-end article deletion
+ * Deletes the article with database consistency, writes logs, purges caches
+ * Returns success
+ */
function doDeleteArticle( $reason ) {
global $wgUser, $wgLang;
global $wgUseSquid, $wgDeferredUpdateList, $wgInternalServer;
$linkID = $titleObj->getArticleID();
$brokenLinks[] = array( 'bl_from' => $linkID, 'bl_to' => $t );
}
- $dbw->insert( 'brokenlinks', $brokenLinks, $fname, 'IGNORE' );
+ $dbw->insertArray( 'brokenlinks', $brokenLinks, $fname, 'IGNORE' );
# Delete live links
$dbw->delete( 'links', array( 'l_to' => $id ) );
return true;
}
+ /**
+ * Revert a modification
+ */
function rollback() {
global $wgUser, $wgLang, $wgOut, $wgRequest;
$fname = 'Article::rollback';
}
- # Do standard deferred updates after page view
-
- /* private */ function viewUpdates() {
+ /**
+ * Do standard deferred updates after page view
+ * @private
+ */
+ function viewUpdates() {
global $wgDeferredUpdateList;
if ( 0 != $this->getID() ) {
global $wgDisableCounters;
array_push( $wgDeferredUpdateList, $u );
}
- # Do standard deferred updates after page edit.
- # Every 1000th edit, prune the recent changes table.
-
- /* private */ function editUpdates( $text ) {
+ /**
+ * 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;
global $wgMessageCache;
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 );
}
}
}
- /* private */ function setOldSubtitle() {
+ /**
+ * @todo document this function
+ * @private
+ */
+ function setOldSubtitle() {
global $wgLang, $wgOut, $wgUser;
$td = $wgLang->timeanddate( $this->mTimestamp, true );
$sk = $wgUser->getSkin();
- $lnk = $sk->makeKnownLinkObj ( $this->mTitle, wfMsg( 'revisionasoflink' ) );
- $r = wfMsg( 'revisionasof', $td, $lnk );
+ $lnk = $sk->makeKnownLinkObj ( $this->mTitle, wfMsg( 'currentrevisionlink' ) );
+ $r = wfMsg( 'revisionasofwithlink', $td, $lnk );
$wgOut->setSubtitle( $r );
}
- # This function is called right before saving the wikitext,
- # so we can do things like signatures and links-in-context.
-
+ /**
+ * 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;
return $wgParser->preSaveTransform( $text, $this->mTitle, $wgUser, ParserOptions::newFromUser( $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.
- #
- # This is a good place to put code to clear caches, for instance.
-
- # This is called on page move and undelete, as well as edit
- /* static */ function onArticleCreate($title_obj) {
+ /**#@+
+ * The onArticle*() functions are supposed to be a kind of hooks
+ * which should be called whenever any of the specified actions
+ * are done.
+ *
+ * This is a good place to put code to clear caches, for instance.
+ *
+ * This is called on page move and undelete, as well as edit
+ * @static
+ * @param $title_obj a title object
+ */
+
+ function onArticleCreate($title_obj) {
global $wgUseSquid, $wgDeferredUpdateList;
$titles = $title_obj->getBrokenLinksTo();
LinkCache::linksccClearBrokenLinksTo( $title_obj->getPrefixedDBkey() );
}
- /* static */ function onArticleDelete($title_obj) {
+ function onArticleDelete($title_obj) {
LinkCache::linksccClearLinksTo( $title_obj->getArticleID() );
}
-
- /* static */ function onArticleEdit($title_obj) {
+ function onArticleEdit($title_obj) {
LinkCache::linksccClearPage( $title_obj->getArticleID() );
}
+ /**#@-*/
-
- # Info about this page
-
+ /**
+ * Info about this page
+ */
function info() {
global $wgUser, $wgTitle, $wgOut, $wgLang, $wgAllowPageInfo;
$fname = 'Article::info';
dépôts / lhc / web / wiklou.git / blobdiff