wiki.techinc.nl/maintenance/cleanupPageLang.php
Dreamy Jazz e7393b3cc7 Exclude boilerplate maintenance code from code coverage reports
Why:
* Maintenance scripts in core have bolierplate code that is
  added before and after the class to allow directly running
  the maintenance script.
* Running the maintenance script directly has been deprecated
  since 1.40, so this boilerplate code is only to support a now
  deprecated method of running maintenance scripts.
* This code cannot also be marked as covered, due to PHPUnit
  not recognising code coverage for files.
* Therefore, it is best to ignore this boilerplate code in code
  coverage reports as it cannot be marked as covered and also
  is for deprecated code.

What:
* Wrap the boilerplate code (requiring Maintenance.php and then
  later defining the maintenance script class and running if the
  maintenance script was called directly) with @codeCoverageIgnore
  comments.
* Some files use a different boilerplate code, however, these
  should also be marked as ignored for coverage for the same
  reason that coverage is not properly reported for files.

Bug: T371167
Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
2024-08-27 13:22:29 +01:00

85 lines
2.5 KiB
PHP

<?php
/**
* Clean up deprecated language codes in page_lang
*
* 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
*/
// @codeCoverageIgnoreStart
require_once __DIR__ . '/TableCleanup.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script to clean up deprecated language codes in page_lang
*
* @ingroup Maintenance
*/
class CleanupPageLang extends TableCleanup {
public function __construct() {
parent::__construct();
$this->addDescription( 'Script to clean up deprecated language codes in page_lang' );
$this->setBatchSize( 1000 );
}
/**
* @param stdClass $row
*/
protected function processRow( $row ) {
$oldPageLang = $row->page_lang;
if ( $oldPageLang === null ) {
// Page has no page language
$this->progress( 0 );
return;
}
$newPageLang = LanguageCode::replaceDeprecatedCodes( $oldPageLang );
if ( $newPageLang === $oldPageLang ) {
// Page language is unchanged
$this->progress( 0 );
return;
}
$this->updatePageLang( $row, $oldPageLang, $newPageLang );
$this->progress( 1 );
}
/**
* @param stdClass $row
* @param string $oldPageLang
* @param string $newPageLang
*/
private function updatePageLang( $row, $oldPageLang, $newPageLang ) {
if ( $this->dryrun ) {
$this->output( "DRY RUN: would update page_lang on $row->page_id from $oldPageLang to $newPageLang.\n" );
} else {
$this->output( "Update page_lang on $row->page_id from $oldPageLang to $newPageLang.\n" );
$this->getPrimaryDB()
->newUpdateQueryBuilder()
->update( 'page' )
->set( [ 'page_lang' => $newPageLang ] )
->where( [ 'page_id' => $row->page_id ] )
->caller( __METHOD__ )->execute();
}
}
}
// @codeCoverageIgnoreStart
$maintClass = CleanupPageLang::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd