Add a script to check if a wiki is OK for enabling ReplaceText

maintenance/replaceTextEligible.php

@@ -0,0 +1,148 @@
+<?php
+
+namespace Miraheze\MirahezeMagic\Maintenance;
+
+/**
+ * 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 3 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
+ * @ingroup Maintenance
+ * @author Alex
+ * @version 1.0
+ */
+
+$IP = getenv( 'MW_INSTALL_PATH' );
+if ( $IP === false ) {
+	$IP = __DIR__ . '/../../..';
+}
+
+require_once "$IP/maintenance/Maintenance.php";
+
+use Exception;
+use Maintenance;
+use Wikimedia\Rdbms\SelectQueryBuilder;;
+
+class ReplaceTextEligible extends Maintenance {
+	public function __construct() {
+		parent::__construct();
+
+		$this->addDescription( 'Checks if the current wiki is eligible for enabling ReplaceText\n See https://meta.miraheze.org/wiki/Tech:Noticeboard?oldid=414759#The_state_of_the_ReplaceText_extension' );
+	}
+
+	public function execute() {
+		$dbr = $this->getDB( DB_REPLICA );
+
+		$pages = $dbr->newSelectQueryBuilder()
+			->select( [ 'page_id', 'page_latest', 'page_name' ]  )
+			->from( 'page' )
+			->caller( __METHOD__ )->fetchResultSet();
+		$deletedPageIDs = $dbr->newSelectQueryBuilder()
+			->select( [ 'ar_page_id' ] )
+			->from( 'archive' )
+			->distinct()
+			->caller( __METHOD__ )->fetchResultSet();
+		$this->output( sprintf( 'Got %d pages from the page table and %d deleted pages from the archive table to process, hang tight...', $pages->numRows(), $deletedPageIDs->numRows() ) );
+
+		// Arrays to hold the names of pages preventing ReplaceText from working correctly
+		$problematicPages = [];
+		$problematicDeletedPages = [];
+
+		// Regular pages
+		$this->output( 'Processing regular pages' );
+		foreach ( $pages as $page ) {
+			// TODO: Use JOINs?
+			$slotContentID = $dbr->newSelectQueryBuilder()
+				->select( [ 'slot_content_id' ] )
+				->from( 'slots' )
+				->where( [ 'slot_revision_id' => $page->page_latest ] )
+				->caller( __METHOD__ )->fetchRow();
+			$contentAddress = $dbr->newSelectQueryBuilder()
+				->select( [ 'content_address' ] )
+				->from( 'content' )
+				->where( [ 'content_id' => $slotContentID ] )
+				->caller( __METHOD__ )->fetchRow();
+			$oldID = substr( $contentAddress, 3 );
+			$textFlags = $dbr->newSelectQueryBuilder()
+				->select( [ 'old_flags' ] )
+				->from( 'text' )
+				->where( [ 'old_id' => $oldID ] )
+				->caller( __METHOD__ )->fetchRow();
+
+			if ( str_contains( $textFlags, 'gzip' ) ) {
+				// The latest revision of this page is compressed
+				$problematicPages[] = $page->page_name;
+			}
+		}
+
+		// Deleted pages
+		// These can be undeleted on-wiki, and if so, they may also cause issues with ReplaceText
+		$this->output( 'Processing deleted pages' );
+		foreach ( $deletedPageIDs as $deletedPageID ) {
+			// TODO: Use JOINs?
+			// Get the latest revision
+			$revID = $dbr->newSelectQueryBuilder()
+				->select( [ 'ar_rev_id' ] )
+				->from( 'archive' )
+				->where( [ 'ar_page_id' => $deletedPageID->ar_page_id ] )
+				->orderBy( 'ar_rev_id', SelectQueryBuilder::SORT_DESC )
+				->limit( 1 )
+				->caller( __METHOD__ )->fetchRow();
+			$slotContentID = $dbr->newSelectQueryBuilder()
+                                ->select( [ 'slot_content_id' ] )
+                                ->from( 'slots' )
+                                ->where( [ 'slot_revision_id' => $revID ] )
+                                ->caller( __METHOD__ )->fetchRow();
+                        $contentAddress = $dbr->newSelectQueryBuilder()
+                                ->select( [ 'content_address' ] )
+                                ->from( 'content' )
+                                ->where( [ 'content_id' => $slotContentID ] )
+                                ->caller( __METHOD__ )->fetchRow();
+                        $oldID = substr( $contentAddress, 3 );
+                        $textFlags = $dbr->newSelectQueryBuilder()
+                                ->select( [ 'old_flags' ] )
+                                ->from( 'text' )
+                                ->where( [ 'old_id' => $oldID ] )
+                                ->caller( __METHOD__ )->fetchRow();
+			if ( str_contains( $textFlags, 'gzip' ) ) {
+                                // The latest revision of this page is compressed
+				$deletedPageName = $dbr->newSelectQueryBuilder
+					->select( [ 'ar_page_name' ] )
+					->from( 'archive' )
+					->where( [ 'ar_page_id' => $deletedPageID->ar_page_id ] )
+					->limit( 1 )
+					->caller( __METHOD__ )->fetchRow();
+                                $problematicDeletedPages[] = $deletedPageName->ar_page_name;
+                        }
+		}
+		if ( count( $problematicPages ) > 0 || count( $problematicDeletedPages ) > 0 ) {
+			$this->output( 'ReplaceText should not be enabled on this wiki.' );
+			if ( count( $problematicPages ) > 0 ) {
+				$this->output( 'The following pages\' latest revisions are compressed:' );
+				$this->output( implode( ', ', $problematicPages ) );
+			}
+			if ( count( $problematicDeletedPages ) > 0 ) {
+				$this->output( 'The following deleted pages\' latest revisions are compressed:' );
+				$this->output( implode( ', ', $problematicDeletedPages ) );
+				$this->output( 'If these pages are undeleted with ReplaceText enabled, usage of the extension will cause problems.' );
+			}
+		} else {
+			$this->output( 'There\'s no problem with this wiki\'s pages; enabling ReplaceText in this wiki is safe.' );
+		}
+	}
+}
+
+$maintClass = ReplaceTextEligible::class;
+require_once RUN_MAINTENANCE_IF_MAIN;