<?php
-
-# Splitting edit page/HTML interface from Article...
-# The actual database and text munging is still in Article,
-# but it should get easier to call those from alternate
-# interfaces.
-
+# $Id$
+/**
+ * Contain the EditPage class
+ * @package MediaWiki
+ */
+
+/**
+ * Splitting edit page/HTML interface from Article...
+ * The actual database and text munging is still in Article,
+ * but it should get easier to call those from alternate
+ * interfaces.
+ *
+ * @package MediaWiki
+ */
class EditPage {
var $mArticle;
var $mTitle;
# Form values
var $save = false, $preview = false;
var $minoredit = false, $watchthis = false;
- var $textbox1 = "", $textbox2 = "", $summary = "";
- var $edittime = "", $section = "";
+ var $textbox1 = '', $textbox2 = '', $summary = '';
+ var $edittime = '', $section = '';
var $oldid = 0;
+ /**
+ * @todo document
+ * @param $article
+ */
function EditPage( $article ) {
$this->mArticle =& $article;
global $wgTitle;
$this->mTitle =& $wgTitle;
}
- # This is the function that gets called for "action=edit".
-
- function edit()
- {
+ /**
+ * This is the function that gets called for "action=edit".
+ */
+ function edit() {
global $wgOut, $wgUser, $wgWhitelistEdit, $wgRequest;
// this is not an article
$wgOut->setArticleFlag(false);
}
if ( wfReadOnly() ) {
if( $this->save || $this->preview ) {
- $this->editForm( "preview" );
+ $this->editForm( 'preview' );
} else {
$wgOut->readOnlyPage( $this->mArticle->getContent( true ) );
}
return;
}
if ( $this->save ) {
- $this->editForm( "save" );
+ $this->editForm( 'save' );
} else if ( $this->preview ) {
- $this->editForm( "preview" );
+ $this->editForm( 'preview' );
} else { # First time through
- $this->editForm( "initial" );
+ $this->editForm( 'initial' );
}
}
+ /**
+ * @todo document
+ */
function importFormData( &$request ) {
# 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 = rtrim( $request->getText( "wpTextbox1" ) );
- $this->textbox2 = rtrim( $request->getText( "wpTextbox2" ) );
- $this->summary = trim( $request->getText( "wpSummary" ) );
+ $this->textbox1 = rtrim( $request->getText( 'wpTextbox1' ) );
+ $this->textbox2 = rtrim( $request->getText( 'wpTextbox2' ) );
+ $this->summary = trim( $request->getText( 'wpSummary' ) );
$this->edittime = $request->getVal( 'wpEdittime' );
- if( !preg_match( '/^\d{14}$/', $this->edittime )) $this->edittime = "";
+ if( !preg_match( '/^\d{14}$/', $this->edittime )) $this->edittime = '';
$this->preview = $request->getCheck( 'wpPreview' );
$this->save = $request->wasPosted() && !$this->preview;
$this->section = $request->getVal( 'wpSection', $request->getVal( 'section' ) );
}
- # Since there is only one text field on the edit form,
- # pressing <enter> will cause the form to be submitted, but
- # the submit button value won't appear in the query, so we
- # Fake it here before going back to edit(). This is kind of
- # ugly, but it helps some old URLs to still work.
-
- function submit()
- {
+ /**
+ * Since there is only one text field on the edit form,
+ * pressing <enter> will cause the form to be submitted, but
+ * the submit button value won't appear in the query, so we
+ * Fake it here before going back to edit(). This is kind of
+ * ugly, but it helps some old URLs to still work.
+ */
+ function submit() {
if( !$this->preview ) $this->save = true;
$this->edit();
}
- # 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 editForm( $formtype )
- {
+ /**
+ * 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.
+ *
+ * @param string $formtype Type of form either : save, initial or preview
+ */
+ function editForm( $formtype ) {
global $wgOut, $wgUser;
global $wgLang, $wgParser, $wgTitle;
global $wgAllowAnonymousMinor;
$isCssJsSubpage = (Namespace::getUser() == $wgTitle->getNamespace() and preg_match("/\\.(css|js)$/", $wgTitle->getText() ));
if(!$this->mTitle->getArticleID()) { # new article
- $wgOut->addWikiText(wfmsg("newarticletext"));
+ $wgOut->addWikiText(wfmsg('newarticletext'));
}
if( Namespace::isTalk( $this->mTitle->getNamespace() ) ) {
- $wgOut->addWikiText(wfmsg("talkpagetext"));
+ $wgOut->addWikiText(wfmsg('talkpagetext'));
}
# Attempt submission here. This will check for edit conflicts,
# that edit() already checked just in case someone tries to sneak
# in the back door with a hand-edited submission URL.
- if ( "save" == $formtype ) {
+ if ( 'save' == $formtype ) {
# Check for spam
if ( $wgSpamRegex && preg_match( $wgSpamRegex, $this->textbox1, $matches ) ) {
$this->spamPage ( $matches );
}
# If article is new, insert it.
- $aid = $this->mTitle->getArticleID();
+ $aid = $this->mTitle->getArticleID( GAID_FOR_UPDATE );
if ( 0 == $aid ) {
# Don't save a new article if it's blank.
- if ( ( "" == $this->textbox1 ) ||
- ( wfMsg( "newarticletext" ) == $this->textbox1 ) ) {
+ if ( ( '' == $this->textbox1 ) ||
+ ( wfMsg( 'newarticletext' ) == $this->textbox1 ) ) {
$wgOut->redirect( $this->mTitle->getFullURL() );
return;
}
# Article exists. Check for edit conflict.
$this->mArticle->clear(); # Force reload of dates, etc.
+ $this->mArticle->forUpdate( true ); # Lock the article
- if( ( $this->section != "new" ) &&
+ if( ( $this->section != 'new' ) &&
($this->mArticle->getTimestamp() != $this->edittime ) ) {
$isConflict = true;
}
// Successful merge! Maybe we should tell the user the good news?
$isConflict = false;
} else {
- $this->section = "";
+ $this->section = '';
$this->textbox1 = $text;
}
}
# First time through: get contents, set time for conflict
# checking, etc.
- if ( "initial" == $formtype ) {
+ if ( 'initial' == $formtype ) {
$this->edittime = $this->mArticle->getTimestamp();
$this->textbox1 = $this->mArticle->getContent( true );
- $this->summary = "";
+ $this->summary = '';
$this->proxyCheck();
}
- $wgOut->setRobotpolicy( "noindex,nofollow" );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
# Enabled article-related sidebar, toplinks, etc.
$wgOut->setArticleRelated( true );
if ( $isConflict ) {
- $s = wfMsg( "editconflict", $this->mTitle->getPrefixedText() );
+ $s = wfMsg( 'editconflict', $this->mTitle->getPrefixedText() );
$wgOut->setPageTitle( $s );
- $wgOut->addHTML( wfMsg( "explainconflict" ) );
+ $wgOut->addHTML( wfMsg( 'explainconflict' ) );
$this->textbox2 = $this->textbox1;
$this->textbox1 = $this->mArticle->getContent( true );
$this->edittime = $this->mArticle->getTimestamp();
} else {
- $s = wfMsg( "editing", $this->mTitle->getPrefixedText() );
+ $s = wfMsg( 'editing', $this->mTitle->getPrefixedText() );
- if( $this->section != "" ) {
- if( $this->section == "new" ) {
- $s.=wfMsg("commentedit");
+ if( $this->section != '' ) {
+ if( $this->section == 'new' ) {
+ $s.=wfMsg('commentedit');
} else {
- $s.=wfMsg("sectionedit");
+ $s.=wfMsg('sectionedit');
}
if(!$this->preview) {
$sectitle=preg_match("/^=+(.*?)=+/mi",
$wgOut->setPageTitle( $s );
if ( $this->oldid ) {
$this->mArticle->setOldSubtitle();
- $wgOut->addHTML( wfMsg( "editingold" ) );
+ $wgOut->addHTML( wfMsg( 'editingold' ) );
}
}
if( wfReadOnly() ) {
- $wgOut->addHTML( "<strong>" .
- wfMsg( "readonlywarning" ) .
+ $wgOut->addHTML( '<strong>' .
+ wfMsg( 'readonlywarning' ) .
"</strong>" );
- } else if ( $isCssJsSubpage and "preview" != $formtype) {
- $wgOut->addHTML( wfMsg( "usercssjsyoucanpreview" ));
+ } else if ( $isCssJsSubpage and 'preview' != $formtype) {
+ $wgOut->addHTML( wfMsg( 'usercssjsyoucanpreview' ));
}
if( $this->mTitle->isProtected() ) {
- $wgOut->addHTML( "<strong>" . wfMsg( "protectedpagewarning" ) .
+ $wgOut->addHTML( '<strong>' . wfMsg( 'protectedpagewarning' ) .
"</strong><br />\n" );
}
$kblength = (int)(strlen( $this->textbox1 ) / 1024);
if( $kblength > 29 ) {
- $wgOut->addHTML( "<strong>" .
- wfMsg( "longpagewarning", $kblength )
- . "</strong>" );
+ $wgOut->addHTML( '<strong>' .
+ wfMsg( 'longpagewarning', $wgLang->formatNum( $kblength ) )
+ . '</strong>' );
}
- $rows = $wgUser->getOption( "rows" );
- $cols = $wgUser->getOption( "cols" );
+ $rows = $wgUser->getOption( 'rows' );
+ $cols = $wgUser->getOption( 'cols' );
- $ew = $wgUser->getOption( "editwidth" );
+ $ew = $wgUser->getOption( 'editwidth' );
if ( $ew ) $ew = " style=\"width:100%\"";
- else $ew = "" ;
+ else $ew = '';
- $q = "action=submit";
+ $q = 'action=submit';
#if ( "no" == $redirect ) { $q .= "&redirect=no"; }
$action = $this->mTitle->escapeLocalURL( $q );
- $summary = wfMsg( "summary" );
- $subject = wfMsg("subject");
- $minor = wfMsg( "minoredit" );
- $watchthis = wfMsg ("watchthis");
- $save = wfMsg( "savearticle" );
- $prev = wfMsg( "showpreview" );
+ $summary = wfMsg('summary');
+ $subject = wfMsg('subject');
+ $minor = wfMsg('minoredit');
+ $watchthis = wfMsg ('watchthis');
+ $save = wfMsg('savearticle');
+ $prev = wfMsg('showpreview');
$cancel = $sk->makeKnownLink( $this->mTitle->getPrefixedText(),
- wfMsg( "cancel" ) );
+ wfMsg('cancel') );
$edithelpurl = $sk->makeUrl( wfMsg( 'edithelppage' ));
$edithelp = '<a target="helpwindow" href="'.$edithelpurl.'">'.
htmlspecialchars( wfMsg( 'edithelp' ) ).'</a> '.
global $wgRightsText;
$copywarn = "<div id=\"editpage-copywarn\">\n" .
- wfMsg( $wgRightsText ? "copyrightwarning" : "copyrightwarning2",
- "[[" . wfMsg( "copyrightpage" ) . "]]",
+ wfMsg( $wgRightsText ? 'copyrightwarning' : 'copyrightwarning2',
+ '[[' . wfMsg( 'copyrightpage' ) . ']]',
$wgRightsText ) . "\n</div>";
- if( $wgUser->getOption("showtoolbar") and !$isCssJsSubpage ) {
-# prepare toolbar for edit buttons
+ if( $wgUser->getOption('showtoolbar') and !$isCssJsSubpage ) {
+ # prepare toolbar for edit buttons
$toolbar = $sk->getEditToolbar();
} else {
- $toolbar = "";
+ $toolbar = '';
}
// activate checkboxes if user wants them to be always active
if( !$this->preview ) {
- if( $wgUser->getOption( "watchdefault" ) ) $this->watchthis = true;
- if( $wgUser->getOption( "minordefault" ) ) $this->minoredit = true;
+ if( $wgUser->getOption( 'watchdefault' ) ) $this->watchthis = true;
+ if( $wgUser->getOption( 'minordefault' ) ) $this->minoredit = true;
// activate checkbox also if user is already watching the page,
// require wpWatchthis to be unset so that second condition is not
if( !$this->watchthis && $this->mTitle->userIsWatching() ) $this->watchthis = true;
}
- $minoredithtml = "";
+ $minoredithtml = '';
if ( 0 != $wgUser->getID() || $wgAllowAnonymousMinor ) {
$minoredithtml =
"<label for='wpMinoredit' title='".wfMsg('tooltip-minoredit')."'>{$minor}</label>";
}
- $watchhtml = "";
+ $watchhtml = '';
if ( 0 != $wgUser->getID() ) {
$watchhtml = "<input tabindex='4' type='checkbox' name='wpWatchthis'".($this->watchthis?" checked='checked'":"").
"<label for='wpWatchthis' title='".wfMsg('tooltip-watch')."'>{$watchthis}</label>";
}
- $checkboxhtml = $minoredithtml . $watchhtml . "<br />";
+ $checkboxhtml = $minoredithtml . $watchhtml . '<br />';
- if ( "preview" == $formtype) {
- $previewhead="<h2>" . wfMsg( "preview" ) . "</h2>\n<p><center><font color=\"#cc0000\">" .
- wfMsg( "note" ) . wfMsg( "previewnote" ) . "</font></center></p>\n";
+ if ( 'preview' == $formtype) {
+ $previewhead='<h2>' . wfMsg( 'preview' ) . "</h2>\n<p><center><font color=\"#cc0000\">" .
+ wfMsg( 'note' ) . wfMsg( 'previewnote' ) . "</font></center></p>\n";
if ( $isConflict ) {
- $previewhead.="<h2>" . wfMsg( "previewconflict" ) .
+ $previewhead.='<h2>' . wfMsg( 'previewconflict' ) .
"</h2>\n";
}
$parserOptions = ParserOptions::newFromUser( $wgUser );
- $parserOptions->setUseCategoryMagic( false );
$parserOptions->setEditSection( false );
$parserOptions->setEditSectionOnRightClick( false );
-# don't parse user css/js, show message about preview
-# XXX: stupid php bug won't let us use $wgTitle->isCssJsSubpage() here
+
+ # don't parse user css/js, show message about preview
+ # XXX: stupid php bug won't let us use $wgTitle->isCssJsSubpage() here
+
if ( $isCssJsSubpage ) {
if(preg_match("/\\.css$/", $wgTitle->getText() ) ) {
$previewtext = wfMsg('usercsspreview');
$wgTitle, $parserOptions );
$previewHTML = $parserOutput->mText;
- if($wgUser->getOption("previewontop")) {
+ if($wgUser->getOption('previewontop')) {
$wgOut->addHTML($previewhead);
$wgOut->addHTML($previewHTML);
}
}
}
-# if this is a comment, show a subject line at the top, which is also the edit summary.
-# Otherwise, show a summary field at the bottom
+ # if this is a comment, show a subject line at the top, which is also the edit summary.
+ # Otherwise, show a summary field at the bottom
$summarytext = htmlspecialchars( $wgLang->recodeForEdit( $this->summary ) ); # FIXME
- if( $this->section == "new" ) {
+ if( $this->section == 'new' ) {
$commentsubject="{$subject}: <input tabindex='1' type='text' value=\"$summarytext\" name=\"wpSummary\" maxlength='200' size='60' /><br />";
- $editsummary = "";
+ $editsummary = '';
} else {
- $commentsubject = "";
+ $commentsubject = '';
$editsummary="{$summary}: <input tabindex='3' type='text' value=\"$summarytext\" name=\"wpSummary\" maxlength='200' size='60' /><br />";
}
if( !$this->preview ) {
# Don't select the edit box on preview; this interferes with seeing what's going on.
- $wgOut->setOnloadHandler( "document.editform.wpTextbox1.focus()" );
+ $wgOut->setOnloadHandler( 'document.editform.wpTextbox1.focus()' );
}
# Prepare a list of templates used by this page
$db =& wfGetDB( DB_SLAVE );
}
}
$templates .= '</ul>';
+ } else {
+ $templates = '';
}
$wgOut->addHTML( "
{$toolbar}
<input type='hidden' value=\"{$this->edittime}\" name=\"wpEdittime\" />\n" );
if ( $isConflict ) {
+ require_once( "DifferenceEngine.php" );
$wgOut->addHTML( "<h2>" . wfMsg( "yourdiff" ) . "</h2>\n" );
DifferenceEngine::showDiff( $this->textbox2, $this->textbox1,
wfMsg( "yourtext" ), wfMsg( "storedversion" ) );
$wgOut->addHTML($previewhead);
$wgOut->addHTML($previewHTML);
}
-
}
- function blockedIPpage()
- {
+ /**
+ * @todo document
+ */
+ function blockedIPpage() {
global $wgOut, $wgUser, $wgLang, $wgIP;
- $wgOut->setPageTitle( wfMsg( "blockedtitle" ) );
- $wgOut->setRobotpolicy( "noindex,nofollow" );
+ $wgOut->setPageTitle( wfMsg( 'blockedtitle' ) );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
$wgOut->setArticleRelated( false );
$id = $wgUser->blockedBy();
$reason = $wgUser->blockedFor();
- $ip = $wgIP;
+ $ip = $wgIP;
if ( is_numeric( $id ) ) {
- $name = User::whoIs( $id );
+ $name = User::whoIs( $id );
} else {
$name = $id;
}
- $link = "[[" . $wgLang->getNsText( Namespace::getUser() ) .
+ $link = '[[' . $wgLang->getNsText( Namespace::getUser() ) .
":{$name}|{$name}]]";
- $wgOut->addWikiText( wfMsg( "blockedtext", $link, $reason, $ip, $name ) );
+ $wgOut->addWikiText( wfMsg( 'blockedtext', $link, $reason, $ip, $name ) );
$wgOut->returnToMain( false );
}
-
-
- function userNotLoggedInPage()
- {
+ /**
+ * @todo document
+ */
+ function userNotLoggedInPage() {
global $wgOut, $wgUser, $wgLang;
- $wgOut->setPageTitle( wfMsg( "whitelistedittitle" ) );
- $wgOut->setRobotpolicy( "noindex,nofollow" );
+ $wgOut->setPageTitle( wfMsg( 'whitelistedittitle' ) );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
$wgOut->setArticleRelated( false );
- $wgOut->addWikiText( wfMsg( "whitelistedittext" ) );
+ $wgOut->addWikiText( wfMsg( 'whitelistedittext' ) );
$wgOut->returnToMain( false );
}
+ /**
+ * @todo document
+ */
function spamPage ( $matches = array() )
{
global $wgOut;
- $wgOut->setPageTitle( wfMsg( "spamprotectiontitle" ) );
- $wgOut->setRobotpolicy( "noindex,nofollow" );
+ $wgOut->setPageTitle( wfMsg( 'spamprotectiontitle' ) );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
$wgOut->setArticleRelated( false );
$wgOut->addWikiText( wfMsg( 'spamprotectiontext' ) );
$wgOut->returnToMain( false );
}
- # Forks processes to scan the originating IP for an open proxy server
- # MemCached can be used to skip IPs that have already been scanned
- function proxyCheck()
- {
+ /**
+ * Forks processes to scan the originating IP for an open proxy server
+ * MemCached can be used to skip IPs that have already been scanned
+ */
+ function proxyCheck() {
global $wgBlockOpenProxies, $wgProxyPorts, $wgProxyScriptPath;
global $wgIP, $wgUseMemCached, $wgMemc, $wgDBname, $wgProxyMemcExpiry;
# Get MemCached key
$skip = false;
if ( $wgUseMemCached ) {
- $mcKey = "$wgDBname:proxy:ip:$wgIP";
+ $mcKey = $wgDBname.':proxy:ip:'.$wgIP;
$mcValue = $wgMemc->get( $mcKey );
if ( $mcValue ) {
$skip = true;
# Fork the processes
if ( !$skip ) {
- $title = Title::makeTitle( NS_SPECIAL, "Blockme" );
+ $title = Title::makeTitle( NS_SPECIAL, 'Blockme' );
$iphash = md5( $wgIP . $wgProxyKey );
- $url = $title->getFullURL( "ip=$iphash" );
+ $url = $title->getFullURL( 'ip='.$iphash );
foreach ( $wgProxyPorts as $port ) {
- $params = implode( " ", array(
+ $params = implode( ' ', array(
escapeshellarg( $wgProxyScriptPath ),
escapeshellarg( $wgIP ),
escapeshellarg( $port ),
}
}
- /* private */ function mergeChangesInto( &$text ){
+ /**
+ * @access private
+ * @todo document
+ */
+ function mergeChangesInto( &$text ){
$fname = 'EditPage::mergeChangesInto';
$oldDate = $this->edittime;
$dbw =& wfGetDB( DB_MASTER );
$title = $this->mTitle->getDBkey();
$obj = $dbw->getArray( 'old',
array( 'old_text','old_flags'),
- array( 'old_namespace' => $ns, 'old_title' => $title, 'old_timestamp' => $oldDate ),
+ array( 'old_namespace' => $ns, 'old_title' => $title,
+ 'old_timestamp' => $dbw->timestamp($oldDate)),
$fname );
$oldText = Article::getRevisionText( $obj );