155 lines
3.8 KiB
PHP
155 lines
3.8 KiB
PHP
<?php
|
|
|
|
namespace SMW\Maintenance;
|
|
|
|
use MediaWiki\Maintenance\Maintenance;
|
|
use Onoi\MessageReporter\CallbackMessageReporter;
|
|
use Onoi\MessageReporter\MessageReporter;
|
|
use SMW\Maintenance\DataRebuilder\OutdatedDisposer;
|
|
use SMW\Services\ServicesFactory as ApplicationFactory;
|
|
use SMW\Setup;
|
|
use SMW\Utils\CliMsgFormatter;
|
|
|
|
/**
|
|
* Load the required class
|
|
*/
|
|
// @codeCoverageIgnoreStart
|
|
if ( getenv( 'MW_INSTALL_PATH' ) !== false ) {
|
|
require_once getenv( 'MW_INSTALL_PATH' ) . '/maintenance/Maintenance.php';
|
|
} else {
|
|
require_once __DIR__ . '/../../../maintenance/Maintenance.php';
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* @license GPL-2.0-or-later
|
|
* @since 3.2
|
|
*
|
|
* @author mwjames
|
|
*/
|
|
class disposeOutdatedEntities extends Maintenance {
|
|
|
|
/**
|
|
* @var MessageReporter
|
|
*/
|
|
private $messageReporter;
|
|
|
|
/**
|
|
* @since 3.2
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( "Dispose of outdated entities." );
|
|
$this->addOption( 'with-maintenance-log', 'Add log entry to `Special:Log` about the maintenance run.', false );
|
|
}
|
|
|
|
/**
|
|
* @since 3.2
|
|
*
|
|
* @param MessageReporter $messageReporter
|
|
*/
|
|
public function setMessageReporter( MessageReporter $messageReporter ) {
|
|
$this->messageReporter = $messageReporter;
|
|
}
|
|
|
|
/**
|
|
* @since 3.2
|
|
*
|
|
* @param string $message
|
|
*/
|
|
public function reportMessage( $message ) {
|
|
$this->output( $message );
|
|
}
|
|
|
|
/**
|
|
* @see Maintenance::execute
|
|
*/
|
|
public function execute() {
|
|
if ( $this->canExecute() !== true ) {
|
|
exit;
|
|
}
|
|
|
|
$applicationFactory = ApplicationFactory::getInstance();
|
|
$maintenanceFactory = $applicationFactory->newMaintenanceFactory();
|
|
|
|
$maintenanceHelper = $maintenanceFactory->newMaintenanceHelper();
|
|
$maintenanceHelper->initRuntimeValues();
|
|
|
|
$title = $this->getServiceContainer()->getTitleFactory()->newFromText( __METHOD__ );
|
|
|
|
$outdatedDisposer = new OutdatedDisposer(
|
|
$applicationFactory->newJobFactory()->newEntityIdDisposerJob( $title ),
|
|
$applicationFactory->getIteratorFactory()
|
|
);
|
|
|
|
if ( $this->messageReporter === null ) {
|
|
$this->messageReporter = new CallbackMessageReporter( [ $this, 'reportMessage' ] );
|
|
}
|
|
|
|
$cliMsgFormatter = new CliMsgFormatter();
|
|
|
|
$this->messageReporter->reportMessage(
|
|
"\n" . $cliMsgFormatter->head()
|
|
);
|
|
|
|
$this->messageReporter->reportMessage(
|
|
$cliMsgFormatter->section( 'About' )
|
|
);
|
|
|
|
$text = [
|
|
"This script will remove outdated entities and entities rendered",
|
|
"invalid due to redeclared namespace settings. It will also dispose of",
|
|
"query link entries from tables that no longer hold a valid entity reference",
|
|
"in Semantic MediaWiki."
|
|
];
|
|
|
|
$this->messageReporter->reportMessage(
|
|
"\n" . $cliMsgFormatter->wordwrap( $text ) . "\n"
|
|
);
|
|
|
|
$this->messageReporter->reportMessage(
|
|
$cliMsgFormatter->section( 'Outdated entitie(s)' ) . "\n"
|
|
);
|
|
|
|
$outdatedDisposer->setMessageReporter( $this->messageReporter );
|
|
$outdatedDisposer->run();
|
|
|
|
if ( $this->hasOption( 'with-maintenance-log' ) ) {
|
|
$maintenanceLogger = $maintenanceFactory->newMaintenanceLogger( 'DisposeOutdatedEntitiesLogger' );
|
|
$runtimeValues = $maintenanceHelper->getRuntimeValues();
|
|
|
|
$log = [
|
|
'Memory used' => $runtimeValues['memory-used'],
|
|
'Time used' => $runtimeValues['humanreadable-time']
|
|
];
|
|
|
|
$maintenanceLogger->logFromArray( $log );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
private function canExecute() {
|
|
if ( !Setup::isEnabled() ) {
|
|
return $this->reportMessage(
|
|
"\nYou need to have SMW enabled in order to run the maintenance script!\n"
|
|
);
|
|
}
|
|
|
|
if ( !Setup::isValid( true ) ) {
|
|
return $this->reportMessage(
|
|
"\nYou need to run `update.php` or `setupStore.php` first before continuing\n" .
|
|
"with this maintenance task!\n"
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = disposeOutdatedEntities::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|