GenerateReport.php

<?php

namespace MediaWiki\Extension\SemanticReports\Maintenance;

use MediaWiki\Extension\SemanticReports\SemanticReports;
use MediaWiki\MediaWikiServices;
use RuntimeException;

$IP = getenv( 'MW_INSTALL_PATH' );
if ( $IP === false ) {
	$IP = __DIR__ . '/../../..';
}
require_once "$IP/maintenance/Maintenance.php";

/**
 * @method \MediaWiki\MediaWikiServices getServiceContainer() available in 1.40+
 */
class GenerateReport extends \Maintenance {

	/**
	 * SemanticReportsReport constructor.
	 */
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Generates a report based on the semantic query' );
		$this->addOption( 'query', 'Query to run: "{{#ask: ...}}"', true, true, 'q' );
		$this->addOption( 'format', 'Output format: csv', true, true, 'f' );
		$this->addOption( 'output', 'Output file', false, true, 'o' );

		$this->addOption( 'mainlabel', 'Override title label', false, true, 'm' );
		$this->addOption( 'sep', 'Override columns separator', false, true, 's' );
		$this->addOption( 'valuesep', 'Override values separator', false, true, 'v' );
		$this->addOption( 'limit', 'Override the results limit', false, true, 'l' );

		$this->requireExtension( 'SemanticReports' );
	}

	/**
	 * @return null
	 */
	public function execute() {
		// REL1_39 compat
		if ( !method_exists( $this, 'getServiceContainer' ) ) {
			/** @var SemanticReports $semanticReports */
			$semanticReports = MediaWikiServices::getInstance()->get( 'SemanticReports' );
		} else {
			/** @var SemanticReports $semanticReports */
			$semanticReports = $this->getServiceContainer()->get( 'SemanticReports' );
		}
		$query = $this->getOption( 'query' );
		$format = $this->getOption( 'format' );

		if ( $format !== 'csv' ) {
			$this->fatalError( 'Only CSV output is supported' );
		}

		// enforce that the query does not contain curly braces
		// (str_contains() is PHP 8+; this extension still supports 1.39/PHP 7.4)
		if ( strpos( $query, '{' ) !== false ) {
			$this->fatalError(
				'Query cannot contain curly braces, i.e. use "[[Category:Test]] [[Property:Test]]", ' .
				'not "{{#ask: [[Category:Test]] ... }}"'
			);
		}

		// enforce that the query does not contain pipe arguments aside from print requests
		if ( preg_match( '/\|[^?]+/', $query ) ) {
			$this->fatalError(
				'Query cannot contain pipe arguments aside from print requests, i.e. "|?Prop" is allowed,' .
				' but "|format=test" is not'
			);
		}

		$result = $semanticReports->getReportData(
			$query,
			$format,
			$this->getOption( 'mainlabel' ),
			$this->getOption( 'sep' ),
			$this->getOption( 'valuesep' ),
			$this->getOption( 'limit' )
		);

		if ( $result === false ) {
			$this->fatalError( 'Error generating report' );
		}

		$filename = $this->getOption( 'output' );
		if ( $filename ) {
			// output to the file
			if ( !file_put_contents( $filename, $result ) ) {
				$this->fatalError( "Error saving report to $filename" );
			}
			$this->outputChanneled( "Report saved to $filename" );
		} else {
			// output to the stdout
			$this->output( $result );
		}
	}

	/**
	 * @codeCoverageIgnore
	 * @inheritDoc
	 * @return never
	 */
	protected function fatalError( $msg, $exitCode = 1 ) {
		// Until 1.43 fatalError() would call exit() unconditionally, making it
		// impossible to test fatalError() calls, see T272241
		// In tests always use RuntimeException so that we support both 1.39 and
		// 1.43
		if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
			parent::fatalError( $msg, $exitCode );
		} else {
			throw new RuntimeException( "FATAL ERROR: $msg (exit code = $exitCode)" );
		}
	}

	/**
	 * @codeCoverageIgnore
	 * @inheritDoc
	 */
	protected function error( $err, $die = 0 ) {
		// Parent method will use
		// `fwrite( STDERR, $err . "\n" );` outside of tests
		// but `print $err;` in tests, add an extra line ending for readability
		// in tests
		if ( defined( 'MW_PHPUNIT_TEST' ) ) {
			print( $err . "\n" );
		} else {
			parent::error( $err, $die );
		}
	}

}

$maintClass = GenerateReport::class;
require_once RUN_MAINTENANCE_IF_MAIN;