wikimedia / mediawiki

maintenance/fixExtLinksProtocolRelative.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 34 and the first side effect is on line 26.

/**
 * Fixes any entries for protocol-relative URLs in the externallinks table,
 * replacing each protocol-relative entry with two entries, one for http
 * and one for https.
 *
 * 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
 * @ingroup Maintenance
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script that fixes any entriy for protocol-relative URLs
 * in the externallinks table.
 *
 * @ingroup Maintenance
 */
class FixExtLinksProtocolRelative extends LoggedUpdateMaintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription(
			'Fixes any entries in the externallinks table containing protocol-relative URLs' );
	}

	protected function getUpdateKey() {
		return 'fix protocol-relative URLs in externallinks';
	}

	protected function updateSkippedMessage() {
		return 'protocol-relative URLs in externallinks table already fixed.';
	}

	protected function doDBUpdates() {
		$db = $this->getDB( DB_MASTER );
		if ( !$db->tableExists( 'externallinks' ) ) {
			$this->error( "externallinks table does not exist" );

			return false;
		}
		$this->output( "Fixing protocol-relative entries in the externallinks table...\n" );
		$res = $db->select( 'externallinks', [ 'el_from', 'el_to', 'el_index' ],
			[ 'el_index' . $db->buildLike( '//', $db->anyString() ) ],
			__METHOD__
		);
		$count = 0;
		foreach ( $res as $row ) {
			$count++;
			if ( $count % 100 == 0 ) {
				$this->output( $count . "\n" );
				wfWaitForSlaves();

The function wfWaitForSlaves() has been deprecated with message: since 1.27 Use LBFactory::waitForReplication

			}
			$db->insert( 'externallinks',
				[
					[
						'el_id' => $db->nextSequenceValue( 'externallinks_el_id_seq' ),
						'el_from' => $row->el_from,
						'el_to' => $row->el_to,
						'el_index' => "http:{$row->el_index}",
					],
					[
						'el_id' => $db->nextSequenceValue( 'externallinks_el_id_seq' ),
						'el_from' => $row->el_from,
						'el_to' => $row->el_to,
						'el_index' => "https:{$row->el_index}",
					]
				], __METHOD__, [ 'IGNORE' ]
			);
			$db->delete(
				'externallinks',
				[
					'el_index' => $row->el_index,
					'el_from' => $row->el_from,
					'el_to' => $row->el_to
				],
				__METHOD__
			);
		}
		$this->output( "Done, $count rows updated.\n" );

		return true;
	}
}

$maintClass = "FixExtLinksProtocolRelative";
require_once RUN_MAINTENANCE_IF_MAIN;