mTitle (as well as $mArticle) is the
* page in the database that is actually being edited. These are
* usually the same, but they are now allowed to be different.
*/
class EditPage {
const AS_SUCCESS_UPDATE = 200;
const AS_SUCCESS_NEW_ARTICLE = 201;
const AS_HOOK_ERROR = 210;
const AS_FILTERING = 211;
const AS_HOOK_ERROR_EXPECTED = 212;
const AS_BLOCKED_PAGE_FOR_USER = 215;
const AS_CONTENT_TOO_BIG = 216;
const AS_USER_CANNOT_EDIT = 217;
const AS_READ_ONLY_PAGE_ANON = 218;
const AS_READ_ONLY_PAGE_LOGGED = 219;
const AS_READ_ONLY_PAGE = 220;
const AS_RATE_LIMITED = 221;
const AS_ARTICLE_WAS_DELETED = 222;
const AS_NO_CREATE_PERMISSION = 223;
const AS_BLANK_ARTICLE = 224;
const AS_CONFLICT_DETECTED = 225;
const AS_SUMMARY_NEEDED = 226;
const AS_TEXTBOX_EMPTY = 228;
const AS_MAX_ARTICLE_SIZE_EXCEEDED = 229;
const AS_OK = 230;
const AS_END = 231;
const AS_SPAM_ERROR = 232;
const AS_IMAGE_REDIRECT_ANON = 233;
const AS_IMAGE_REDIRECT_LOGGED = 234;
var $mArticle;
var $mTitle;
var $action;
var $mMetaData = '';
var $isConflict = false;
var $isCssJsSubpage = false;
var $deletedSinceEdit = false;
var $formtype;
var $firsttime;
var $lastDelete;
var $mTokenOk = false;
var $mTokenOkExceptSuffix = false;
var $mTriedSave = false;
var $tooBig = false;
var $kblength = false;
var $missingComment = false;
var $missingSummary = false;
var $allowBlankSummary = false;
var $autoSumm = '';
var $hookError = '';
#var $mPreviewTemplates;
var $mParserOutput;
var $mBaseRevision = false;
# Form values
var $save = false, $preview = false, $diff = false;
var $minoredit = false, $watchthis = false, $recreate = false;
var $textbox1 = '', $textbox2 = '', $summary = '';
var $edittime = '', $section = '', $starttime = '';
var $oldid = 0, $editintro = '', $scrolltop = null;
# Placeholders for text injection by hooks (must be HTML)
# extensions should take care to _append_ to the present value
public $editFormPageTop; // Before even the preview
public $editFormTextTop;
public $editFormTextBeforeContent;
public $editFormTextAfterWarn;
public $editFormTextAfterTools;
public $editFormTextBottom;
/* $didSave should be set to true whenever an article was succesfully altered. */
public $didSave = false;
public $undidRev = 0;
public $suppressIntro = false;
/**
* @todo document
* @param $article
*/
function EditPage( $article ) {
$this->mArticle =& $article;
$this->mTitle = $article->getTitle();
$this->action = 'submit';
# Placeholders for text injection by hooks (empty per default)
$this->editFormPageTop =
$this->editFormTextTop =
$this->editFormTextBeforeContent =
$this->editFormTextAfterWarn =
$this->editFormTextAfterTools =
$this->editFormTextBottom =
$this->mPreloadText = "";
}
function getArticle() {
return $this->mArticle;
}
/**
* Fetch initial editing page content.
* @private
*/
function getContent( $def_text = '' ) {
global $wgOut, $wgRequest, $wgParser, $wgContLang, $wgMessageCache;
wfProfileIn( __METHOD__ );
# Get variables from query string :P
$section = $wgRequest->getVal( 'section' );
$preload = $wgRequest->getVal( 'preload' );
$undoafter = $wgRequest->getVal( 'undoafter' );
$undo = $wgRequest->getVal( 'undo' );
$text = '';
// For message page not locally set, use the i18n message.
// For other non-existent articles, use preload text if any.
if ( !$this->mTitle->exists() ) {
if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
# If this is a system message, get the default text.
list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle->getText() ) );
$wgMessageCache->loadAllMessages( $lang );
$text = wfMsgGetKey( $message, false, $lang, false );
if( wfEmptyMsg( $message, $text ) )
$text = '';
} else {
# If requested, preload some text.
$text = $this->getPreloadedText( $preload );
}
// For existing pages, get text based on "undo" or section parameters.
} else {
$text = $this->mArticle->getContent();
if ( $undo > 0 && $undoafter > 0 && $undo < $undoafter ) {
# If they got undoafter and undo round the wrong way, switch them
list( $undo, $undoafter ) = array( $undoafter, $undo );
}
if ( $undo > 0 && $undo > $undoafter ) {
# Undoing a specific edit overrides section editing; section-editing
# doesn't work with undoing.
if ( $undoafter ) {
$undorev = Revision::newFromId($undo);
$oldrev = Revision::newFromId($undoafter);
} else {
$undorev = Revision::newFromId($undo);
$oldrev = $undorev ? $undorev->getPrevious() : null;
}
# Sanity check, make sure it's the right page,
# the revisions exist and they were not deleted.
# Otherwise, $text will be left as-is.
if ( !is_null( $undorev ) && !is_null( $oldrev ) &&
$undorev->getPage() == $oldrev->getPage() &&
$undorev->getPage() == $this->mArticle->getID() &&
!$undorev->isDeleted( Revision::DELETED_TEXT ) &&
!$oldrev->isDeleted( Revision::DELETED_TEXT ) ) {
$undotext = $this->mArticle->getUndoText( $undorev, $oldrev );
if ( $undotext === false ) {
# Warn the user that something went wrong
$this->editFormPageTop .= $wgOut->parse( '
' . wfMsgNoTrans( 'undo-failure' ) . '
' );
} else {
$text = $undotext;
# Inform the user of our success and set an automatic edit summary
$this->editFormPageTop .= $wgOut->parse( '
' . wfMsgNoTrans( 'undo-success' ) . '
' );
$firstrev = $oldrev->getNext();
# If we just undid one rev, use an autosummary
if ( $firstrev->mId == $undo ) {
$this->summary = wfMsgForContent( 'undo-summary', $undo, $undorev->getUserText() );
$this->undidRev = $undo;
}
$this->formtype = 'diff';
}
} else {
// Failed basic sanity checks.
// Older revisions may have been removed since the link
// was created, or we may simply have got bogus input.
$this->editFormPageTop .= $wgOut->parse( '
' . wfMsgNoTrans( 'undo-norev' ) . '
' );
}
} else if ( $section != '' ) {
if ( $section == 'new' ) {
$text = $this->getPreloadedText( $preload );
} else {
$text = $wgParser->getSection( $text, $section, $def_text );
}
}
}
wfProfileOut( __METHOD__ );
return $text;
}
/** Use this method before edit() to preload some text into the edit box */
public function setPreloadedText( $text ) {
$this->mPreloadText = $text;
}
/**
* Get the contents of a page from its title and remove includeonly tags
*
* @param $preload String: the title of the page.
* @return string The contents of the page.
*/
protected function getPreloadedText( $preload ) {
if ( !empty($this->mPreloadText) ) {
return $this->mPreloadText;
} elseif ( $preload === '' ) {
return '';
} else {
$preloadTitle = Title::newFromText( $preload );
if ( isset( $preloadTitle ) && $preloadTitle->userCanRead() ) {
$rev = Revision::newFromTitle($preloadTitle);
if ( is_object( $rev ) ) {
$text = $rev->getText();
// TODO FIXME: AAAAAAAAAAA, this shouldn't be implementing
// its own mini-parser! -ævar
$text = preg_replace( '~?includeonly>~', '', $text );
return $text;
} else
return '';
}
}
}
/**
* This is the function that extracts metadata from the article body on the first view.
* To turn the feature on, set $wgUseMetadataEdit = true ; in LocalSettings
* and set $wgMetadataWhitelist to the *full* title of the template whitelist
*/
function extractMetaDataFromArticle () {
global $wgUseMetadataEdit, $wgMetadataWhitelist, $wgContLang;
$this->mMetaData = '';
if ( !$wgUseMetadataEdit ) return;
if ( $wgMetadataWhitelist == '' ) return;
$s = '';
$t = $this->getContent();
# MISSING : filtering
# Categories and language links
$t = explode ( "\n" , $t );
$catlow = strtolower ( $wgContLang->getNsText( NS_CATEGORY ) );
$cat = $ll = array();
foreach ( $t AS $key => $x ) {
$y = trim ( strtolower ( $x ) );
while ( substr ( $y , 0 , 2 ) == '[[' ) {
$y = explode ( ']]' , trim ( $x ) );
$first = array_shift ( $y );
$first = explode ( ':' , $first );
$ns = array_shift ( $first );
$ns = trim ( str_replace ( '[' , '' , $ns ) );
if ( $wgContLang->getLanguageName( $ns ) || strtolower ( $ns ) == $catlow ) {
$add = '[[' . $ns . ':' . implode ( ':' , $first ) . ']]';
if ( strtolower ( $ns ) == $catlow ) $cat[] = $add;
else $ll[] = $add;
$x = implode ( ']]' , $y );
$t[$key] = $x;
$y = trim ( strtolower ( $x ) );
} else {
$x = implode ( ']]' , $y );
$y = trim ( strtolower ( $x ) );
}
}
}
if ( count ( $cat ) ) $s .= implode ( ' ' , $cat ) . "\n";
if ( count ( $ll ) ) $s .= implode ( ' ' , $ll ) . "\n";
$t = implode ( "\n" , $t );
# Load whitelist
$sat = array () ; # stand-alone-templates; must be lowercase
$wl_title = Title::newFromText ( $wgMetadataWhitelist );
$wl_article = new Article ( $wl_title );
$wl = explode ( "\n" , $wl_article->getContent() );
foreach ( $wl AS $x ) {
$isentry = false;
$x = trim ( $x );
while ( substr ( $x , 0 , 1 ) == '*' ) {
$isentry = true;
$x = trim ( substr ( $x , 1 ) );
}
if ( $isentry ) {
$sat[] = strtolower ( $x );
}
}
# Templates, but only some
$t = explode ( '{{' , $t );
$tl = array () ;
foreach ( $t AS $key => $x ) {
$y = explode ( '}}' , $x , 2 );
if ( count ( $y ) == 2 ) {
$z = $y[0];
$z = explode ( '|' , $z );
$tn = array_shift ( $z );
if ( in_array ( strtolower ( $tn ) , $sat ) ) {
$tl[] = '{{' . $y[0] . '}}';
$t[$key] = $y[1];
$y = explode ( '}}' , $y[1] , 2 );
}
else $t[$key] = '{{' . $x;
}
else if ( $key != 0 ) $t[$key] = '{{' . $x;
else $t[$key] = $x;
}
if ( count ( $tl ) ) $s .= implode ( ' ' , $tl );
$t = implode ( '' , $t );
$t = str_replace ( "\n\n\n" , "\n" , $t );
$this->mArticle->mContent = $t;
$this->mMetaData = $s;
}
/*
* Check if a page was deleted while the user was editing it, before submit.
* Note that we rely on the logging table, which hasn't been always there,
* but that doesn't matter, because this only applies to brand new
* deletes.
*/
protected function wasDeletedSinceLastEdit() {
if ( $this->deletedSinceEdit )
return true;
if ( $this->mTitle->isDeletedQuick() ) {
$this->lastDelete = $this->getLastDelete();
if ( $this->lastDelete ) {
$deleteTime = wfTimestamp( TS_MW, $this->lastDelete->log_timestamp );
if ( $deleteTime > $this->starttime ) {
$this->deletedSinceEdit = true;
}
}
}
return $this->deletedSinceEdit;
}
function submit() {
$this->edit();
}
/**
* This is the function that gets called for "action=edit". It
* sets up various member variables, then passes execution to
* another function, usually showEditForm()
*
* The edit form is self-submitting, so that when things like
* preview and edit conflicts occur, we get the same form back
* with the extra stuff added. Only when the final submission
* is made and all is well do we actually save and redirect to
* the newly-edited page.
*/
function edit() {
global $wgOut, $wgRequest;
// Allow extensions to modify/prevent this form or submission
if ( !wfRunHooks( 'AlternateEdit', array( &$this ) ) ) {
return;
}
wfProfileIn( __METHOD__ );
wfDebug( __METHOD__.": enter\n" );
// This is not an article
$wgOut->setArticleFlag( false );
$this->importFormData( $wgRequest );
$this->firsttime = false;
if ( $this->live ) {
$this->livePreview();
wfProfileOut( __METHOD__ );
return;
}
if ( wfReadOnly() && $this->save ) {
// Force preview
$this->save = false;
$this->preview = true;
}
$wgOut->addScriptFile( 'edit.js' );
$permErrors = $this->getEditPermissionErrors();
if ( $permErrors ) {
wfDebug( __METHOD__.": User can't edit\n" );
$this->readOnlyPage( $this->getContent(), true, $permErrors, 'edit' );
wfProfileOut( __METHOD__ );
return;
} else {
if ( $this->save ) {
$this->formtype = 'save';
} else if ( $this->preview ) {
$this->formtype = 'preview';
} else if ( $this->diff ) {
$this->formtype = 'diff';
} else { # First time through
$this->firsttime = true;
if ( $this->previewOnOpen() ) {
$this->formtype = 'preview';
} else {
$this->extractMetaDataFromArticle () ;
$this->formtype = 'initial';
}
}
}
// If they used redlink=1 and the page exists, redirect to the main article
if ( $wgRequest->getBool( 'redlink' ) && $this->mTitle->exists() ) {
$wgOut->redirect( $this->mTitle->getFullURL() );
}
wfProfileIn( __METHOD__."-business-end" );
$this->isConflict = false;
// css / js subpages of user pages get a special treatment
$this->isCssJsSubpage = $this->mTitle->isCssJsSubpage();
$this->isValidCssJsSubpage = $this->mTitle->isValidCssJsSubpage();
# Show applicable editing introductions
if ( $this->formtype == 'initial' || $this->firsttime )
$this->showIntro();
if ( $this->mTitle->isTalkPage() ) {
$wgOut->addWikiMsg( 'talkpagetext' );
}
# Optional notices on a per-namespace and per-page basis
$editnotice_ns = 'editnotice-'.$this->mTitle->getNamespace();
if ( !wfEmptyMsg( $editnotice_ns, wfMsgForContent( $editnotice_ns ) ) ) {
$wgOut->addWikiText( wfMsgForContent( $editnotice_ns ) );
}
if ( MWNamespace::hasSubpages( $this->mTitle->getNamespace() ) ) {
$parts = explode( '/', $this->mTitle->getDBkey() );
$editnotice_base = $editnotice_ns;
while ( count( $parts ) > 0 ) {
$editnotice_base .= '-'.array_shift( $parts );
if ( !wfEmptyMsg( $editnotice_base, wfMsgForContent( $editnotice_base ) ) ) {
$wgOut->addWikiText( wfMsgForContent( $editnotice_base ) );
}
}
}
# Attempt submission here. This will check for edit conflicts,
# and redundantly check for locked database, blocked IPs, etc.
# that edit() already checked just in case someone tries to sneak
# in the back door with a hand-edited submission URL.
if ( 'save' == $this->formtype ) {
if ( !$this->attemptSave() ) {
wfProfileOut( __METHOD__."-business-end" );
wfProfileOut( __METHOD__ );
return;
}
}
# First time through: get contents, set time for conflict
# checking, etc.
if ( 'initial' == $this->formtype || $this->firsttime ) {
if ( $this->initialiseForm() === false) {
$this->noSuchSectionPage();
wfProfileOut( __METHOD__."-business-end" );
wfProfileOut( __METHOD__ );
return;
}
if ( !$this->mTitle->getArticleId() )
wfRunHooks( 'EditFormPreloadText', array( &$this->textbox1, &$this->mTitle ) );
}
$this->showEditForm();
wfProfileOut( __METHOD__."-business-end" );
wfProfileOut( __METHOD__ );
}
protected function getEditPermissionErrors() {
global $wgUser;
$permErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
# Can this title be created?
if ( !$this->mTitle->exists() ) {
$permErrors = array_merge( $permErrors,
wfArrayDiff2( $this->mTitle->getUserPermissionsErrors( 'create', $wgUser ), $permErrors ) );
}
# Ignore some permissions errors when a user is just previewing/viewing diffs
$remove = array();
foreach( $permErrors as $error ) {
if ( ($this->preview || $this->diff) &&
($error[0] == 'blockedtext' || $error[0] == 'autoblockedtext') )
{
$remove[] = $error;
}
}
$permErrors = wfArrayDiff2( $permErrors, $remove );
return $permErrors;
}
/**
* Show a read-only error
* Parameters are the same as OutputPage:readOnlyPage()
* Redirect to the article page if redlink=1
*/
function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
global $wgRequest, $wgOut;
if ( $wgRequest->getBool( 'redlink' ) ) {
// The edit page was reached via a red link.
// Redirect to the article page and let them click the edit tab if
// they really want a permission error.
$wgOut->redirect( $this->mTitle->getFullUrl() );
} else {
$wgOut->readOnlyPage( $source, $protected, $reasons, $action );
}
}
/**
* Should we show a preview when the edit form is first shown?
*
* @return bool
*/
protected function previewOnOpen() {
global $wgRequest, $wgUser;
if ( $wgRequest->getVal( 'preview' ) == 'yes' ) {
// Explicit override from request
return true;
} elseif ( $wgRequest->getVal( 'preview' ) == 'no' ) {
// Explicit override from request
return false;
} elseif ( $this->section == 'new' ) {
// Nothing *to* preview for new sections
return false;
} elseif ( ( $wgRequest->getVal( 'preload' ) !== null || $this->mTitle->exists() ) && $wgUser->getOption( 'previewonfirst' ) ) {
// Standard preference behaviour
return true;
} elseif ( !$this->mTitle->exists() && $this->mTitle->getNamespace() == NS_CATEGORY ) {
// Categories are special
return true;
} else {
return false;
}
}
/**
* @todo document
* @param $request
*/
function importFormData( &$request ) {
global $wgLang, $wgUser;
$fname = 'EditPage::importFormData';
wfProfileIn( $fname );
# Section edit can come from either the form or a link
$this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
if ( $request->wasPosted() ) {
# These fields need to be checked for encoding.
# Also remove trailing whitespace, but don't remove _initial_
# whitespace from the text boxes. This may be significant formatting.
$this->textbox1 = $this->safeUnicodeInput( $request, 'wpTextbox1' );
$this->textbox2 = $this->safeUnicodeInput( $request, 'wpTextbox2' );
$this->mMetaData = rtrim( $request->getText( 'metadata' ) );
# Truncate for whole multibyte characters. +5 bytes for ellipsis
$this->summary = $wgLang->truncate( $request->getText( 'wpSummary' ), 250, '' );
# Remove extra headings from summaries and new sections.
$this->summary = preg_replace('/^\s*=+\s*(.*?)\s*=+\s*$/', '$1', $this->summary);
$this->edittime = $request->getVal( 'wpEdittime' );
$this->starttime = $request->getVal( 'wpStarttime' );
$this->scrolltop = $request->getIntOrNull( 'wpScrolltop' );
if ( is_null( $this->edittime ) ) {
# If the form is incomplete, force to preview.
wfDebug( "$fname: Form data appears to be incomplete\n" );
wfDebug( "POST DATA: " . var_export( $_POST, true ) . "\n" );
$this->preview = true;
} else {
/* Fallback for live preview */
$this->preview = $request->getCheck( 'wpPreview' ) || $request->getCheck( 'wpLivePreview' );
$this->diff = $request->getCheck( 'wpDiff' );
// Remember whether a save was requested, so we can indicate
// if we forced preview due to session failure.
$this->mTriedSave = !$this->preview;
if ( $this->tokenOk( $request ) ) {
# Some browsers will not report any submit button
# if the user hits enter in the comment box.
# The unmarked state will be assumed to be a save,
# if the form seems otherwise complete.
wfDebug( "$fname: Passed token check.\n" );
} else if ( $this->diff ) {
# Failed token check, but only requested "Show Changes".
wfDebug( "$fname: Failed token check; Show Changes requested.\n" );
} else {
# Page might be a hack attempt posted from
# an external site. Preview instead of saving.
wfDebug( "$fname: Failed token check; forcing preview\n" );
$this->preview = true;
}
}
$this->save = !$this->preview && !$this->diff;
if ( !preg_match( '/^\d{14}$/', $this->edittime )) {
$this->edittime = null;
}
if ( !preg_match( '/^\d{14}$/', $this->starttime )) {
$this->starttime = null;
}
$this->recreate = $request->getCheck( 'wpRecreate' );
$this->minoredit = $request->getCheck( 'wpMinoredit' );
$this->watchthis = $request->getCheck( 'wpWatchthis' );
# Don't force edit summaries when a user is editing their own user or talk page
if ( ( $this->mTitle->mNamespace == NS_USER || $this->mTitle->mNamespace == NS_USER_TALK ) &&
$this->mTitle->getText() == $wgUser->getName() )
{
$this->allowBlankSummary = true;
} else {
$this->allowBlankSummary = $request->getBool( 'wpIgnoreBlankSummary' ) || !$wgUser->getOption( 'forceeditsummary');
}
$this->autoSumm = $request->getText( 'wpAutoSummary' );
} else {
# Not a posted form? Start with nothing.
wfDebug( "$fname: Not a posted form.\n" );
$this->textbox1 = '';
$this->textbox2 = '';
$this->mMetaData = '';
$this->summary = '';
$this->edittime = '';
$this->starttime = wfTimestampNow();
$this->edit = false;
$this->preview = false;
$this->save = false;
$this->diff = false;
$this->minoredit = false;
$this->watchthis = false;
$this->recreate = false;
if ( $this->section == 'new' && $request->getVal( 'preloadtitle' ) ) {
$this->summary = $request->getVal( 'preloadtitle' );
}
elseif ( $this->section != 'new' && $request->getVal( 'summary' ) ) {
$this->summary = $request->getText( 'summary' );
}
if ( $request->getVal( 'minor' ) ) {
$this->minoredit = true;
}
}
$this->oldid = $request->getInt( 'oldid' );
$this->live = $request->getCheck( 'live' );
$this->editintro = $request->getText( 'editintro' );
wfProfileOut( $fname );
}
/**
* Make sure the form isn't faking a user's credentials.
*
* @param $request WebRequest
* @return bool
* @private
*/
function tokenOk( &$request ) {
global $wgUser;
$token = $request->getVal( 'wpEditToken' );
$this->mTokenOk = $wgUser->matchEditToken( $token );
$this->mTokenOkExceptSuffix = $wgUser->matchEditTokenNoSuffix( $token );
return $this->mTokenOk;
}
/**
* Show all applicable editing introductions
*/
protected function showIntro() {
global $wgOut, $wgUser;
if ( $this->suppressIntro ) {
return;
}
$namespace = $this->mTitle->getNamespace();
if ( $namespace == NS_MEDIAWIKI ) {
# Show a warning if editing an interface message
$wgOut->wrapWikiMsg( "
\n$1
", 'editinginterface' );
}
# Show a warning message when someone creates/edits a user (talk) page but the user does not exists
if ( $namespace == NS_USER || $namespace == NS_USER_TALK ) {
$parts = explode( '/', $this->mTitle->getText(), 2 );
$username = $parts[0];
$id = User::idFromName( $username );
$ip = User::isIP( $username );
if ( $id == 0 && !$ip ) {
$wgOut->wrapWikiMsg( '
$1
',
array( 'userpage-userdoesnotexist', $username ) );
}
}
# Try to add a custom edit intro, or use the standard one if this is not possible.
if ( !$this->showCustomIntro() && !$this->mTitle->exists() ) {
if ( $wgUser->isLoggedIn() ) {
$wgOut->wrapWikiMsg( '
', 'newarticletextanon' );
}
}
# Give a notice if the user is editing a deleted/moved page...
if ( !$this->mTitle->exists() ) {
$this->showLogs( $wgOut );
}
}
/**
* Attempt to show a custom editing introduction, if supplied
*
* @return bool
*/
protected function showCustomIntro() {
if ( $this->editintro ) {
$title = Title::newFromText( $this->editintro );
if ( $title instanceof Title && $title->exists() && $title->userCanRead() ) {
global $wgOut;
$revision = Revision::newFromTitle( $title );
$wgOut->addWikiTextTitleTidy( $revision->getText(), $this->mTitle );
return true;
} else {
return false;
}
} else {
return false;
}
}
/**
* Attempt submission (no UI)
* @return one of the constants describing the result
*/
function internalAttemptSave( &$result, $bot = false ) {
global $wgFilterCallback, $wgUser, $wgOut, $wgParser;
global $wgMaxArticleSize;
$fname = 'EditPage::attemptSave';
wfProfileIn( $fname );
wfProfileIn( "$fname-checks" );
if ( !wfRunHooks( 'EditPage::attemptSave', array( &$this ) ) )
{
wfDebug( "Hook 'EditPage::attemptSave' aborted article saving\n" );
return self::AS_HOOK_ERROR;
}
# Check image redirect
if ( $this->mTitle->getNamespace() == NS_FILE &&
Title::newFromRedirect( $this->textbox1 ) instanceof Title &&
!$wgUser->isAllowed( 'upload' ) ) {
if ( $wgUser->isAnon() ) {
return self::AS_IMAGE_REDIRECT_ANON;
} else {
return self::AS_IMAGE_REDIRECT_LOGGED;
}
}
# Reintegrate metadata
if ( $this->mMetaData != '' ) $this->textbox1 .= "\n" . $this->mMetaData ;
$this->mMetaData = '' ;
# Check for spam
$match = self::matchSummarySpamRegex( $this->summary );
if ( $match === false ) {
$match = self::matchSpamRegex( $this->textbox1 );
}
if ( $match !== false ) {
$result['spam'] = $match;
$ip = wfGetIP();
$pdbk = $this->mTitle->getPrefixedDBkey();
$match = str_replace( "\n", '', $match );
wfDebugLog( 'SpamRegex', "$ip spam regex hit [[$pdbk]]: \"$match\"" );
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_SPAM_ERROR;
}
if ( $wgFilterCallback && $wgFilterCallback( $this->mTitle, $this->textbox1, $this->section, $this->hookError, $this->summary ) ) {
# Error messages or other handling should be performed by the filter function
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_FILTERING;
}
if ( !wfRunHooks( 'EditFilter', array( $this, $this->textbox1, $this->section, &$this->hookError, $this->summary ) ) ) {
# Error messages etc. could be handled within the hook...
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_HOOK_ERROR;
} elseif ( $this->hookError != '' ) {
# ...or the hook could be expecting us to produce an error
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_HOOK_ERROR_EXPECTED;
}
if ( $wgUser->isBlockedFrom( $this->mTitle, false ) ) {
# Check block state against master, thus 'false'.
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_BLOCKED_PAGE_FOR_USER;
}
$this->kblength = (int)(strlen( $this->textbox1 ) / 1024);
if ( $this->kblength > $wgMaxArticleSize ) {
// Error will be displayed by showEditForm()
$this->tooBig = true;
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_CONTENT_TOO_BIG;
}
if ( !$wgUser->isAllowed('edit') ) {
if ( $wgUser->isAnon() ) {
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_READ_ONLY_PAGE_ANON;
}
else {
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_READ_ONLY_PAGE_LOGGED;
}
}
if ( wfReadOnly() ) {
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_READ_ONLY_PAGE;
}
if ( $wgUser->pingLimiter() ) {
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_RATE_LIMITED;
}
# If the article has been deleted while editing, don't save it without
# confirmation
if ( $this->wasDeletedSinceLastEdit() && !$this->recreate ) {
wfProfileOut( "$fname-checks" );
wfProfileOut( $fname );
return self::AS_ARTICLE_WAS_DELETED;
}
wfProfileOut( "$fname-checks" );
# If article is new, insert it.
$aid = $this->mTitle->getArticleID( GAID_FOR_UPDATE );
if ( 0 == $aid ) {
// Late check for create permission, just in case *PARANOIA*
if ( !$this->mTitle->userCan( 'create' ) ) {
wfDebug( "$fname: no create permission\n" );
wfProfileOut( $fname );
return self::AS_NO_CREATE_PERMISSION;
}
# Don't save a new article if it's blank.
if ( '' == $this->textbox1 ) {
wfProfileOut( $fname );
return self::AS_BLANK_ARTICLE;
}
// Run post-section-merge edit filter
if ( !wfRunHooks( 'EditFilterMerged', array( $this, $this->textbox1, &$this->hookError, $this->summary ) ) ) {
# Error messages etc. could be handled within the hook...
wfProfileOut( $fname );
return self::AS_HOOK_ERROR;
}
# Handle the user preference to force summaries here. Check if it's not a redirect.
if ( !$this->allowBlankSummary && !Title::newFromRedirect( $this->textbox1 ) ) {
if ( md5( $this->summary ) == $this->autoSumm ) {
$this->missingSummary = true;
wfProfileOut( $fname );
return self::AS_SUMMARY_NEEDED;
}
}
$isComment = ( $this->section == 'new' );
$this->mArticle->insertNewArticle( $this->textbox1, $this->summary,
$this->minoredit, $this->watchthis, false, $isComment, $bot );
wfProfileOut( $fname );
return self::AS_SUCCESS_NEW_ARTICLE;
}
# Article exists. Check for edit conflict.
$this->mArticle->clear(); # Force reload of dates, etc.
$this->mArticle->forUpdate( true ); # Lock the article
wfDebug("timestamp: {$this->mArticle->getTimestamp()}, edittime: {$this->edittime}\n");
if ( $this->mArticle->getTimestamp() != $this->edittime ) {
$this->isConflict = true;
if ( $this->section == 'new' ) {
if ( $this->mArticle->getUserText() == $wgUser->getName() &&
$this->mArticle->getComment() == $this->summary ) {
// Probably a duplicate submission of a new comment.
// This can happen when squid resends a request after
// a timeout but the first one actually went through.
wfDebug( "EditPage::editForm duplicate new section submission; trigger edit conflict!\n" );
} else {
// New comment; suppress conflict.
$this->isConflict = false;
wfDebug( "EditPage::editForm conflict suppressed; new section\n" );
}
}
}
$userid = $wgUser->getId();
# Suppress edit conflict with self, except for section edits where merging is required.
if ( $this->isConflict && $this->section == '' && $this->userWasLastToEdit($userid,$this->edittime) ) {
wfDebug( "EditPage::editForm Suppressing edit conflict, same user.\n" );
$this->isConflict = false;
}
if ( $this->isConflict ) {
wfDebug( "EditPage::editForm conflict! getting section '$this->section' for time '$this->edittime' (article time '" .
$this->mArticle->getTimestamp() . "')\n" );
$text = $this->mArticle->replaceSection( $this->section, $this->textbox1, $this->summary, $this->edittime );
} else {
wfDebug( "EditPage::editForm getting section '$this->section'\n" );
$text = $this->mArticle->replaceSection( $this->section, $this->textbox1, $this->summary );
}
if ( is_null( $text ) ) {
wfDebug( "EditPage::editForm activating conflict; section replace failed.\n" );
$this->isConflict = true;
$text = $this->textbox1; // do not try to merge here!
} else if ( $this->isConflict ) {
# Attempt merge
if ( $this->mergeChangesInto( $text ) ) {
// Successful merge! Maybe we should tell the user the good news?
$this->isConflict = false;
wfDebug( "EditPage::editForm Suppressing edit conflict, successful merge.\n" );
} else {
$this->section = '';
$this->textbox1 = $text;
wfDebug( "EditPage::editForm Keeping edit conflict, failed merge.\n" );
}
}
if ( $this->isConflict ) {
wfProfileOut( $fname );
return self::AS_CONFLICT_DETECTED;
}
$oldtext = $this->mArticle->getContent();
// Run post-section-merge edit filter
if ( !wfRunHooks( 'EditFilterMerged', array( $this, $text, &$this->hookError, $this->summary ) ) ) {
# Error messages etc. could be handled within the hook...
wfProfileOut( $fname );
return self::AS_HOOK_ERROR;
}
# Handle the user preference to force summaries here, but not for null edits
if ( $this->section != 'new' && !$this->allowBlankSummary && 0 != strcmp($oldtext,$text)
&& !Title::newFromRedirect( $text ) ) # check if it's not a redirect
{
if ( md5( $this->summary ) == $this->autoSumm ) {
$this->missingSummary = true;
wfProfileOut( $fname );
return self::AS_SUMMARY_NEEDED;
}
}
# And a similar thing for new sections
if ( $this->section == 'new' && !$this->allowBlankSummary ) {
if (trim($this->summary) == '') {
$this->missingSummary = true;
wfProfileOut( $fname );
return self::AS_SUMMARY_NEEDED;
}
}
# All's well
wfProfileIn( "$fname-sectionanchor" );
$sectionanchor = '';
if ( $this->section == 'new' ) {
if ( $this->textbox1 == '' ) {
$this->missingComment = true;
return self::AS_TEXTBOX_EMPTY;
}
if ( $this->summary != '' ) {
$sectionanchor = $wgParser->guessSectionNameFromWikiText( $this->summary );
# This is a new section, so create a link to the new section
# in the revision summary.
$cleanSummary = $wgParser->stripSectionName( $this->summary );
$this->summary = wfMsgForContent( 'newsectionsummary', $cleanSummary );
}
} elseif ( $this->section != '' ) {
# Try to get a section anchor from the section source, redirect to edited section if header found
# XXX: might be better to integrate this into Article::replaceSection
# for duplicate heading checking and maybe parsing
$hasmatch = preg_match( "/^ *([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
# we can't deal with anchors, includes, html etc in the header for now,
# headline would need to be parsed to improve this
if ( $hasmatch and strlen($matches[2]) > 0 ) {
$sectionanchor = $wgParser->guessSectionNameFromWikiText( $matches[2] );
}
}
wfProfileOut( "$fname-sectionanchor" );
// Save errors may fall down to the edit form, but we've now
// merged the section into full text. Clear the section field
// so that later submission of conflict forms won't try to
// replace that into a duplicated mess.
$this->textbox1 = $text;
$this->section = '';
// Check for length errors again now that the section is merged in
$this->kblength = (int)(strlen( $text ) / 1024);
if ( $this->kblength > $wgMaxArticleSize ) {
$this->tooBig = true;
wfProfileOut( $fname );
return self::AS_MAX_ARTICLE_SIZE_EXCEEDED;
}
# update the article here
if ( $this->mArticle->updateArticle( $text, $this->summary, $this->minoredit,
$this->watchthis, $bot, $sectionanchor ) )
{
wfProfileOut( $fname );
return self::AS_SUCCESS_UPDATE;
} else {
$this->isConflict = true;
}
wfProfileOut( $fname );
return self::AS_END;
}
/**
* Check if no edits were made by other users since
* the time a user started editing the page. Limit to
* 50 revisions for the sake of performance.
*/
protected function userWasLastToEdit( $id, $edittime ) {
if( !$id ) return false;
$dbw = wfGetDB( DB_MASTER );
$res = $dbw->select( 'revision',
'rev_user',
array(
'rev_page' => $this->mArticle->getId(),
'rev_timestamp > '.$dbw->addQuotes( $dbw->timestamp($edittime) )
),
__METHOD__,
array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ) );
while( $row = $res->fetchObject() ) {
if( $row->rev_user != $id ) {
return false;
}
}
return true;
}
/**
* Check given input text against $wgSpamRegex, and return the text of the first match.
* @return mixed -- matching string or false
*/
public static function matchSpamRegex( $text ) {
global $wgSpamRegex;
// For back compatibility, $wgSpamRegex may be a single string or an array of regexes.
$regexes = (array)$wgSpamRegex;
return self::matchSpamRegexInternal( $text, $regexes );
}
/**
* Check given input text against $wgSpamRegex, and return the text of the first match.
* @return mixed -- matching string or false
*/
public static function matchSummarySpamRegex( $text ) {
global $wgSummarySpamRegex;
$regexes = (array)$wgSummarySpamRegex;
return self::matchSpamRegexInternal( $text, $regexes );
}
protected static function matchSpamRegexInternal( $text, $regexes ) {
foreach( $regexes as $regex ) {
$matches = array();
if( preg_match( $regex, $text, $matches ) ) {
return $matches[0];
}
}
return false;
}
/**
* Initialise form fields in the object
* Called on the first invocation, e.g. when a user clicks an edit link
*/
function initialiseForm() {
$this->edittime = $this->mArticle->getTimestamp();
$this->textbox1 = $this->getContent( false );
if ( $this->textbox1 === false ) return false;
wfProxyCheck();
return true;
}
function setHeaders() {
global $wgOut, $wgTitle;
$wgOut->setRobotPolicy( 'noindex,nofollow' );
if ( $this->formtype == 'preview' ) {
$wgOut->setPageTitleActionText( wfMsg( 'preview' ) );
}
if ( $this->isConflict ) {
$wgOut->setPageTitle( wfMsg( 'editconflict', $wgTitle->getPrefixedText() ) );
} elseif ( $this->section != '' ) {
$msg = $this->section == 'new' ? 'editingcomment' : 'editingsection';
$wgOut->setPageTitle( wfMsg( $msg, $wgTitle->getPrefixedText() ) );
} else {
# Use the title defined by DISPLAYTITLE magic word when present
if ( isset($this->mParserOutput)
&& ( $dt = $this->mParserOutput->getDisplayTitle() ) !== false ) {
$title = $dt;
} else {
$title = $wgTitle->getPrefixedText();
}
$wgOut->setPageTitle( wfMsg( 'editing', $title ) );
}
}
/**
* Send the edit form and related headers to $wgOut
* @param $formCallback Optional callable that takes an OutputPage
* parameter; will be called during form output
* near the top, for captchas and the like.
*/
function showEditForm( $formCallback=null ) {
global $wgOut, $wgUser, $wgLang, $wgContLang, $wgMaxArticleSize, $wgTitle, $wgRequest;
# If $wgTitle is null, that means we're in API mode.
# Some hook probably called this function without checking
# for is_null($wgTitle) first. Bail out right here so we don't
# do lots of work just to discard it right after.
if (is_null($wgTitle))
return;
$fname = 'EditPage::showEditForm';
wfProfileIn( $fname );
$sk = $wgUser->getSkin();
wfRunHooks( 'EditPage::showEditForm:initial', array( &$this ) ) ;
#need to parse the preview early so that we know which templates are used,
#otherwise users with "show preview after edit box" will get a blank list
#we parse this near the beginning so that setHeaders can do the title
#setting work instead of leaving it in getPreviewText
$previewOutput = '';
if ( $this->formtype == 'preview' ) {
$previewOutput = $this->getPreviewText();
}
$this->setHeaders();
# Enabled article-related sidebar, toplinks, etc.
$wgOut->setArticleRelated( true );
if ( $this->isConflict ) {
$wgOut->wrapWikiMsg( "
\n" );
}
if ( $this->mTitle->isCascadeProtected() ) {
# Is this page under cascading protection from some source pages?
list($cascadeSources, /* $restrictions */) = $this->mTitle->getCascadeProtectionSources();
$notice = "
$1\n";
$cascadeSourcesCount = count( $cascadeSources );
if ( $cascadeSourcesCount > 0 ) {
# Explain, and list the titles responsible
foreach( $cascadeSources as $page ) {
$notice .= '* [[:' . $page->getPrefixedText() . "]]\n";
}
}
$notice .= '
\n" : '';
$summarypreview = '';
} else {
$commentsubject = '';
# Add a class if 'missingsummary' is triggered to allow styling of the summary line
$summaryClass = $this->missingSummary ? 'mw-summarymissed' : 'mw-summary';
$editsummary = Xml::tags( 'label', array( 'for' => 'wpSummary' ), $summary );
$editsummary = Xml::tags( 'span', array( 'class' => $summaryClass, 'id' => "wpSummaryLabel" ),
$editsummary ) . ' ';
$editsummary .= Xml::input( 'wpSummary',
60,
$summarytext,
array(
'id' => 'wpSummary',
'maxlength' => '200',
'tabindex' => '1'
) );
// No idea where this is closed.
$editsummary = Xml::openElement( 'div', array( 'class' => 'editOptions' ) )
. $editsummary . ' ';
$summarypreview = '';
if ( $summarytext && $this->preview ) {
$summarypreview =
Xml::tags( 'div',
array( 'class' => 'mw-summary-preview' ),
wfMsgExt( 'summary-preview', 'parseinline' ) .
$sk->commentBlock( $this->summary, $this->mTitle )
);
}
$subjectpreview = '';
}
$commentsubject .= $summaryhiddens;
# Set focus to the edit box on load, except on preview or diff, where it would interfere with the display
if ( !$this->preview && !$this->diff ) {
$wgOut->setOnloadHandler( 'document.editform.wpTextbox1.focus()' );
}
$templates = $this->getTemplates();
$formattedtemplates = $sk->formatTemplates( $templates, $this->preview, $this->section != '');
$hiddencats = $this->mArticle->getHiddenCategories();
$formattedhiddencats = $sk->formatHiddenCategories( $hiddencats );
global $wgUseMetadataEdit ;
if ( $wgUseMetadataEdit ) {
$metadata = $this->mMetaData ;
$metadata = htmlspecialchars( $wgContLang->recodeForEdit( $metadata ) ) ;
$top = wfMsgWikiHtml( 'metadata_help' );
/* ToDo: Replace with clean code */
$ew = $wgUser->getOption( 'editwidth' );
if ( $ew ) $ew = " style=\"width:100%\"";
else $ew = '';
$cols = $wgUser->getIntOption( 'cols' );
/* /ToDo */
$metadata = $top . "" ;
}
else $metadata = "" ;
$recreate = '';
if ( $this->wasDeletedSinceLastEdit() ) {
if ( 'save' != $this->formtype ) {
$wgOut->wrapWikiMsg(
"
\n$1
",
'deletedwhileediting' );
} else {
// Hide the toolbar and edit area, user can click preview to get it back
// Add an confirmation checkbox and explanation.
$toolbar = '';
$recreate = '
");
/**
* To make it harder for someone to slip a user a page
* which submits an edit form to the wiki without their
* knowledge, a random token is associated with the login
* session. If it's not passed back with the submission,
* we won't save the page, or render user JavaScript and
* CSS previews.
*
* For anon editors, who may not have a session, we just
* include the constant suffix to prevent editing from
* broken text-mangling proxies.
*/
$token = htmlspecialchars( $wgUser->editToken() );
$wgOut->addHTML( "\n\n" );
$this->showTosSummary();
$this->showEditTools();
$wgOut->addHTML( <<editFormTextAfterTools}
{$formattedtemplates}
{$formattedhiddencats}
END
);
if ( $this->isConflict && wfRunHooks( 'EditPageBeforeConflictDiff', array( &$this, &$wgOut ) ) ) {
$wgOut->wrapWikiMsg( '==$1==', "yourdiff" );
$de = new DifferenceEngine( $this->mTitle );
$de->setText( $this->textbox2, $this->textbox1 );
$de->showDiff( wfMsg( "yourtext" ), wfMsg( "storedversion" ) );
$wgOut->wrapWikiMsg( '==$1==', "yourtext" );
$this->showTextbox2();
}
$wgOut->addHTML( $this->editFormTextBottom );
$wgOut->addHTML( "\n" );
if ( !$wgUser->getOption( 'previewontop' ) ) {
$this->displayPreviewArea( $previewOutput, false );
}
wfProfileOut( $fname );
}
protected function showFormBeforeText() {
global $wgOut;
$wgOut->addHTML( "
section ) . "\" name=\"wpSection\" />
starttime}\" name=\"wpStarttime\" />\n
edittime}\" name=\"wpEdittime\" />\n
scrolltop}\" name=\"wpScrolltop\" id=\"wpScrolltop\" />\n" );
}
protected function showTextbox1( $classes ) {
$attribs = array( 'tabindex' => 1 );
if ( $this->wasDeletedSinceLastEdit() )
$attribs['type'] = 'hidden';
if ( !empty($classes) )
$attribs['class'] = implode(' ',$classes);
$this->showTextbox( $this->textbox1, 'wpTextbox1', $attribs );
}
protected function showTextbox2() {
$this->showTextbox( $this->textbox2, 'wpTextbox2', array( 'tabindex' => 6 ) );
}
protected function showTextbox( $content, $name, $attribs = array() ) {
global $wgOut, $wgUser;
$wikitext = $this->safeUnicodeOutput( $content );
if ( $wikitext !== '' ) {
// Ensure there's a newline at the end, otherwise adding lines
// is awkward.
// But don't add a newline if the ext is empty, or Firefox in XHTML
// mode will show an extra newline. A bit annoying.
$wikitext .= "\n";
}
$attribs['accesskey'] = ',';
$attribs['id'] = $name;
if ( $wgUser->getOption( 'editwidth' ) )
$attribs['style'] = 'width: 100%';
$wgOut->addHTML( Xml::textarea(
$name,
$wikitext,
$wgUser->getIntOption( 'cols' ), $wgUser->getIntOption( 'rows' ),
$attribs ) );
}
protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
global $wgOut;
$classes = array();
if ( $isOnTop )
$classes[] = 'ontop';
$attribs = array( 'id' => 'wikiPreview', 'class' => implode( ' ', $classes ) );
if ( $this->formtype != 'preview' )
$attribs['style'] = 'display: none;';
$wgOut->addHTML( Xml::openElement( 'div', $attribs ) );
if ( $this->formtype == 'preview' ) {
$this->showPreview( $previewOutput );
}
$wgOut->addHTML( '' );
if ( $this->formtype == 'diff') {
$this->showDiff();
}
}
/**
* Append preview output to $wgOut.
* Includes category rendering if this is a category page.
*
* @param string $text The HTML to be output for the preview.
*/
protected function showPreview( $text ) {
global $wgOut;
if ( $this->mTitle->getNamespace() == NS_CATEGORY) {
$this->mArticle->openShowCategory();
}
# This hook seems slightly odd here, but makes things more
# consistent for extensions.
wfRunHooks( 'OutputPageBeforeHTML',array( &$wgOut, &$text ) );
$wgOut->addHTML( $text );
if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
$this->mArticle->closeShowCategory();
}
}
/**
* Live Preview lets us fetch rendered preview page content and
* add it to the page without refreshing the whole page.
* If not supported by the browser it will fall through to the normal form
* submission method.
*
* This function outputs a script tag to support live preview, and
* returns an onclick handler which should be added to the attributes
* of the preview button
*/
function doLivePreviewScript() {
global $wgOut, $wgTitle;
$wgOut->addScriptFile( 'preview.js' );
$liveAction = $wgTitle->getLocalUrl( array(
'action' => $this->action,
'wpPreview' => 'true',
'live' => 'true'
) );
return "return !lpDoPreview(" .
"editform.wpTextbox1.value," .
'"' . $liveAction . '"' . ")";
}
protected function showTosSummary() {
$msg = 'editpage-tos-summary';
// Give a chance for site and per-namespace customizations of
// terms of service summary link that might exist separately
// from the copyright notice.
//
// This will display between the save button and the edit tools,
// so should remain short!
wfRunHooks( 'EditPageTosSummary', array( $this->mTitle, &$msg ) );
$text = wfMsgForContent( $msg );
if( $text != '-' ) {
global $wgOut;
$wgOut->addHTML( '