User:Leucosticte/ApiMirrorMove.php

<?php /** * * ApiMirrorMove * Created on 22 July 2014 by Nathan Larson * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html * * @file */

/** * A module that allows for mirroring page moves. * * @ingroup API */ class ApiMirrorMove extends ApiBase { public function execute { global $wgNamespacesToTruncate; $user = $this->getUser; if ( !$user->isAllowed( 'mirrortools' ) ) { $this->dieUsage(				'Access denied: This user does not have the mirrortools right' ); }		$params = $this->extractRequestParams; $dbw = wfGetDB( DB_MASTER ); $pushTimestamp = wfTimestamp( TS_MW ); // See if this data is already in the tables // Is it in the logging table? $conds = array ( 'log_id' => $params['logid'] ); $res = $dbw->selectRow( 'logging', 'log_id', $conds ); if ( $res ) { $this->dieUsage( 'Log id ' . $params['logid']				. ' is already in the logging table' ); }		// Is it in the recentchanges table? $conds = array ( 'rc_id' => $params['rcid'] ); $res = $dbw->selectRow( 'recentchanges', 'rc_id', $conds ); if ( RecentChange::newFromId( $params['rcid'] ) ) { $this->dieUsage( 'Rc id ' . $params['rcid'] .				' is already in the recentchanges table' ); }		// Get the target (i.e. move to) page title and namespace $logParams = unserialize( $params['logparams'] ); $prefixedMoveTo = $logParams['4::target']; $noRedir = $logParams['5::noredir'] == '1' ? true : false; // Figure out what namespace it's being moved to; truncate any namespace prefix $moveToNamespace = 0; $moveToTitle = $prefixedMoveTo; foreach( $wgMirrorNamespaces as $mirrorNamespace ) { if ( substr( $prefixedMoveTo, 0, strlen( $mirrorNamespace ) )				== $namespaceToTruncate ) { $moveToTitle = substr( $prefixedMoveTo,				   strlen( $mirrorNamespace ),				    strlen( $prefixedMoveTo )				    - strlen( $mirrorNamespace ) ); $moveToNamespace = $mirrorNamespace; break; }               }		// Get the page ID of the source (i.e. move from) page $sourcePageTitle = Title::makeTitleSafe(			$params['lognamespace'],			$params['logtitle']		); if ( !$sourcePageTitle ) { dieUsage( "Could not retrieve the source page entry" ); }		$sourcePageId = $sourcePageTitle->getArticleID; $newSourcePageRevPage = $noRedir ? 'rev_mt_former_page' : $params['logpage']; // If there's a merged history of local and remote revisions at the source page, // change the rev_page of the local revisions back to the rev_mt_former_page if		// there's no redirect created; otherwise change the rev_page to the redirect page // ID. $res = $dbw->update(			'revision',			array( 'rev_page' => 'rev_mt_former_page', ),			array( 'rev_page' => $sourcePageId, "rev_mt_former_page<>''" )		);		// If there were any revisions whose rev_page was changed back to		// rev_mt_former_page, then also re-create the page entry $existingLocalSourcePageId = null; if ( $dbw->affectedRows && $noRedir ) { $row = $dbw->selectRow(				'revision',				array( 'rev_id', 'rev_content_model', 'maxpagetouched' => 'MAX(rev_timestamp)' ), array( 'rev_page' => $row->rev_mt_former_page )			);			$dbw->insert(				'page',				array( 'page_id' => $row->page_id, 'page_namespace' => $params['lognamespace'], 'page_title' => $params['logtitle'], 'page_counter' => 0, // TODO: Perhaps fix this using WikitextContent's					// getRedirectTargetAndText 'page_is_redirect' => 0, 'page_is_new' => $dbw->affectedRows > 1 ? 0 : 1,					'page_random' => wfRandom, 'page_touched' => $pushTimestamp, 'page_links_updated' => NULL, 'page_latest' => $row->rev_id, 'page_len' => $row->rev_len, 'page_content_model' => $row->rev_content_model, 'page_lang' => NULL )			);			$existingLocalSourcePageId = $dbw->insertId; }		// Does a page already exist at this target page title and namespace? $alreadyExistingTargetPageId = $dbw->selectField(			'page',			'page_id',			array( 'page_namespace' => $moveToNamespace, 'page_title' => $moveToTitle )		);		if ( $alreadyExistingTargetPageId ) { // A local page already exists at the target page title and namespace. // Make any remotely live revisions that are at that target page not // remotely live anymore; they're probably a redirect or something. // Change the rev_page of the revisions that already exist at the target to // the page ID of the mirrored page. Also set the rev_mt_former_page in // case there's another mirrormove reversing this mirrormove. $dbw->update(				'revision',				array( 'rev_page' => $sourcePageId, 'rev_mt_former_page' => $alreadyExistingTargetPageId, 'rev_mt_remotely_live' => 0 ),				array( 'rev_page' => $alreadyExistingTargetPageId, )			);			// Delete the page table entry for the target page. $dbw->delete(				'page',				array( 'page_id' => $params['logpage'] )			); }		// Find most recent revision $mostRecentRevisionRow = $dbw->selectRow(			'revision',			array( 'rev_id', 'rev_text_id', 'rev_len', 'rev_sha1', 'rev_content_model', 'rev_content_format', 'maxrevtimestamp' => 'MAX(rev_timestamp)' ),			array( 'rev_page' => $sourcePageId )		); // Create null revision $conds = array(			'rev_page' => $sourcePageId,			'rev_text_id' => $mostRecentRevisionRow->rev_text_id,			'rev_comment' => $params['comment2'],			'rev_user' => 0,			'rev_user_text' => $params['logusertext'],			'rev_timestamp' => $params['logtimestamp'],			'rev_minor_edit' => 1,			'rev_deleted' => 0,			'rev_len' => $mostRecentRevisionRow->rev_len,			'rev_parent_id' => $mostRecentRevisionRow->rev_id,			'rev_sha1' => $mostRecentRevisionRow->rev_sha1,			'rev_content_model' => $mostRecentRevisionRow->rev_content_model,			'rev_content_format' => $mostRecentRevisionRow->rev_content_format,			'rev_mt_push_timestamp' => $pushTimestamp,			'rev_mt_user' => $params['loguser']		); if ( $params['nullrevid'] ) { $conds['rev_id'] = $params['nullrevid']; }		$dbw->insert( 'revision', $conds ); // Change page namespace and title of mirrored source (move from) page $dbw->update(			'page',			array( 'page_namespace' => $moveToNamespace, 'page_title' => $moveToTitle ),			array( 'page_id' => $sourcePageId )		);		// Create a redirect, if applicable if ( !$noRedir ) { // If there's already local stuff remaining at the source page, then put // the redirect in the appropriate place in that page entry. This may or			// may not be the latest revision, since who knows how far behind mirroring // is. $parentId = 0; $redirectPageId = 0; $redirRevIsLatestRev = false; $oldText = "#REDIRECT $prefixedMoveTo"; if( $existingLocalSourcePageId ) { $redirectPageId = $existingLocalSourcePageId; $possibleParentId = $dbw->selectField(					'revision',					array( 'rev_id', 'maxrevtimestamp' => 'MAX(rev_timestamp)' ),					array( 'rev_page' => $existingLocalSourcePageId, "rev_timestamp<". $params['logtimestamp'] )				);				if ( $possibleParentId ) { $parentId = $possibleParentId->rev_id; }				// Find out whether the redirect revision is the latest revision $latestTimestamp = $dbw->select(					'revision',					array( 'rev_timestamp', 'maxrevtimestamp' => 'MAX(rev_timestamp)' ),					array( 'rev_page' => $existingLocalSourcePageId )				); $latestTimestamp = $latestRow->rev_timestamp; if ( $latestTimestamp < $params['logtimestamp'] ) { $redirRevIsLatestRev = true; }			} else { // Otherwise, create a new page entry for the redirect revision $dbw->insert(					'page',					array( 'page_id' => $params['logpage'], 'page_namespace' => $params['lognamespace'], 'page_title' => $params['logtitle'], 'page_counter' => 0, // TODO: Perhaps fix this using WikitextContent's						// getRedirectTargetAndText 'page_is_redirect' => 1, 'page_is_new' => 1, 'page_random' => wfRandom, 'page_touched' => $pushTimestamp, 'page_links_updated' => NULL, 'page_latest' => 0, 'page_len' => strlen( $oldText ), 'page_content_model' => $row->rev_content_model, 'page_lang' => NULL )				);				$redirectPageId = $params['logpage']; // Since the page only has one revision (viz. the redirect				// revision), the redirect revision must be the latest revision $redirRevIsLatestRev = true; }			// Insert redirect text entry $dbw->insert(				'text',				array( 'old_text' => $oldText, 'old_flags' => 'utf-8' )			);			$textId = $dbw->insertId; // Insert redirect revision entry $conds = array(				'rev_page' => $redirectPageId,				'rev_text_id' => $textId,				'rev_comment' => $params['comment2'],				'rev_user' => 0,				'rev_user_text' => $params['logusertext'],				'rev_timestamp' => $params['logtimestamp'],				'rev_minor_edit' => 0,				'rev_deleted' => 0,				'rev_len' => strlen( $oldText ),				'rev_parent_id' => $parentId,				'rev_sha1' => Revision::base36Sha1( $oldText ),				'rev_mt_user' => $params['loguser'],				'rev_mt_push_timestamp' => $pushTimestamp			); if ( $params['redirrevid'] ) { $conds['rev_id'] = $params['redirrevid']; }			$dbw->insert( 'revision', $conds ); $redirectRevisionId = $dbw->insertId; // Set page_latest to the redirect revision entry, if that's the latest // revision if ( $redirRevIsLatestRev ) { $dbw->update(					'page',					array( 'page_latest' => $redirectRevisionId, 'page_is_redirect' => 1 ),					array( 'page_id' => $redirectPageId )				); }		}		$pushTimestamp = wfTimestamp( TS_MW ); // Insert $insertLoggingArray = array(			'log_id' => $params['logid'],			'log_type' => 'move',			'log_action' => 'move',			'log_timestamp' => $params['logtimestamp'],			'log_user' => 0,			'log_namespace' => $params['lognamespace'],			'log_deleted' => $params['logdeleted'],			'log_user_text' => $params['logusertext'],			'log_title' => $params['logtitle'],			'log_comment' => $params['logcomment'],			'log_params' => $params['logparams'],			'log_page' => $movedPageId,			'log_mt_user' => $params['loguser'],			'log_mt_push_timestamp' => $pushTimestamp		); $dbw->insert( 'logging', $insertLoggingArray ); $insertRecentchangesArray = array(			'rc_id' => $params['rcid'],			'rc_timestamp' => $params['logtimestamp'],			'rc_user' => 0,			'rc_user_text' => $params['logusertext'],			'rc_namespace' => $params['lognamespace'],			'rc_title' => $params['logtitle'],			'rc_comment' => $params['logcomment'],			'rc_minor' => 0,			'rc_bot' => $params['rcbot'],			'rc_new' => 0,			'rc_cur_id' => $params['logpage'],			'rc_this_oldid' => 0,			'rc_last_oldid' => 0,			'rc_type' => 'log',			'rc_source' => 'mw.log',			'rc_patrolled' => $params['rcpatrolled'],			'rc_ip' => $params['rcip'],			'rc_old_len' => NULL,			'rc_new_len' => NULL,			'rc_deleted' => $params['logdeleted'],			'rc_logid' => $params['logid'],			'rc_log_type' => 'move',			'rc_log_action' => 'move',			'rc_params' => $params['logparams'],			'rc_mt_push_timestamp' => $pushTimestamp,			'rc_mt_user' => $params['loguser']		); $dbw->insert( 'recentchanges', $insertRecentchangesArray ); if ( $params['tstags'] ) { $insertTagsummaryArray = array(				'ts_log_id' => $params['logid'],				'ts_rc_id' => $param['rcid'],				'ts_tags' => $params['tstags']			); $dbw->insert( 'tag_summary', $insertTagsummaryArray ); }		$r = array; $r['result'] = 'Success'; $r['timestamp'] = $pushTimestamp; $this->getResult->addValue( null, $this->getModuleName, $r ); return true; }

public function getDescription { return 'Mirror page moves.'; }

public function getAllowedParams { return array(			'logid' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true ),			'logtimestamp' => array( ApiBase::PARAM_TYPE => 'timestamp', ApiBase::PARAM_REQUIRED => true ),			'loguser' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true ),			'lognamespace' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true ),			'logdeleted' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_DFLT => 0 ),			'logusertext' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_REQUIRED => true ),			'logtitle' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_REQUIRED => true ),			'logcomment' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_DFLT => '', ),			'logparams' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_DFLT => '', ),			'logpage' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true, ),			'rcid' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true, ),			'rcbot' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true, ),			'rcpatrolled' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_REQUIRED => true, ),			'rcip' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_DFLT => '', ),			'tstags' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_DFLT => '' ),			'comment2' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_DFLT => '' ),			'nullrevid' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_DFLT => NULL ),			'redirrevid' => array( ApiBase::PARAM_TYPE => 'integer', ApiBase::PARAM_DFLT => NULL ),			'token' => array( ApiBase::PARAM_TYPE => 'string', ApiBase::PARAM_REQUIRED => true )		);	}

public function getHelpUrls { return 'https://www.mediawiki.org/wiki/Extension:MirrorTools/MirrorLogEntry'; }

public function mustBePosted { return true; }	public function needsToken { return true; }	public function getTokenSalt { return ''; } }