SemanticMediaWiki / SemanticApprovedRevs

src/Hooks.php

<?php

namespace SMW\ApprovedRevs;

use MediaWiki\MediaWikiServices;

The type MediaWiki\MediaWikiServices was not found. Maybe you did not declare it correctly or list all dependencies?

use Onoi\Cache\Cache;
use SMW\ApplicationFactory;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class Hooks {

	/**
	 * @var array
	 */
	private $handlers = [];

	/**
	 * @var Cache
	 */
	private $cache;

	/**
	 * @since 1.0
	 *
	 * @param array $config
	 */
	public function __construct( $config = [] ) {
		$this->registerHandlers( $config );
	}

	/**
	 * @since 1.0
	 *
	 * @param Cache $cache
	 */
	public function setCache( Cache $cache ) {
		$this->cache = $cache;
	}

	/**
	 * @since  1.0
	 */
	public static function hasPropertyCollisions( $var ) {

		if ( !isset( $var['sespgEnabledPropertyList'] ) ) {
			return false;
		}

		// SESP properties!
		$list = [
			'_APPROVED' => true,
			'_APPROVEDBY' => true,
			'_APPROVEDDATE' => true,
			'_APPROVEDSTATUS' => true
		];

		foreach ( $var['sespgEnabledPropertyList'] as $key ) {
			if ( isset( $list[$key] ) ) {
				return $key;
			}
		}

		return false;
	}

	/**
	 * @since 1.0
	 *
	 * @param array &$vars
	 */
	public static function initExtension( &$vars ) {

The parameter $vars is not used and could be removed.

		$version = 'UNKNOWN' ;

		// See https://phabricator.wikimedia.org/T151136
		if ( isset( $credits['version'] ) ) {

The variable $credits seems to never exist and therefore isset should always be false.

			$version = $credits['version'];
		}

		define( 'SMW_APPROVED_REVS_VERSION', $version );

		/**
		 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Config::BeforeCompletion
		 *
		 * @since 1.0
		 *
		 * @param array &$config
		 */
		$GLOBALS['wgHooks']['SMW::Config::BeforeCompletion'][] = function( &$config ) {

			if ( isset( $config['smwgImportFileDirs'] ) ) {
				$config['smwgImportFileDirs'] += [ 'sar' => __DIR__ . '/../data/import' ];
			}

			return true;
		};
	}

	/**
	 * @since  1.0
	 */
	public function register() {
		foreach ( $this->handlers as $name => $callback ) {
			\Hooks::register( $name, $callback );

The type Hooks was not found. Maybe you did not declare it correctly or list all dependencies?

		}
	}

	/**
	 * @since  1.0
	 */
	public function deregister() {
		foreach ( array_keys( $this->handlers ) as $name ) {
			MediaWikiServices::getInstance()->getHookContainer()->clear( $name );

			// Remove registered `wgHooks` hooks that are not cleared by the
			// previous call
			if ( isset( $GLOBALS['wgHooks'][$name] ) ) {
				unset( $GLOBALS['wgHooks'][$name] );
			}
		}
	}

	/**
	 * @since  1.0
	 *
	 * @param string $name
	 *
	 * @return boolean
	 */
	public function isRegistered( $name ) {
		return \Hooks::isRegistered( $name );
	}

	/**
	 * @since  1.0
	 *
	 * @param string $name
	 *
	 * @return array
	 */
	public function getHandlers( $name ) {
		return \Hooks::getHandlers( $name );
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $title

The type SMW\ApprovedRevs\Title was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param integer $latestRevID
	 */
	public function onIsApprovedRevision( $title, $latestRevID ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		return $approvedRevsHandler->isApprovedUpdate( $title, $latestRevID );
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param Revision|null &$revision

The type SMW\ApprovedRevs\Revision was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	public function onChangeRevision( $title, &$revision ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeRevision( $title, $revision );

		return true;
	}

	/**
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param integer &$latestRevID
	 */
	public function onOverrideRevisionID( $title, &$latestRevID ) {

		$approvedRevsHandler =  new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeRevisionID( $title, $latestRevID );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Property::initProperties
	 *
	 * @since 1.0
	 *
	 * @param ProertyRegistry $$registry

The type SMW\ApprovedRevs\ProertyRegistry was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param integer &$latestRevID
	 */
	public function onInitProperties( $registry ) {

		$propertyRegistry = new PropertyRegistry();
		$propertyRegistry->register( $registry );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMWStore::updateDataBefore
	 *
	 * @since 1.0
	 *
	 * @param ProertyRegistry $$registry
	 * @param integer &$latestRevID
	 */
	public function onUpdateDataBefore( $store, $semanticData ) {

		$propertyAnnotator = new PropertyAnnotator(
			new ServicesFactory()
		);

		$propertyAnnotator->setLogger(
			ApplicationFactory::getInstance()->getMediaWikiLogger( 'smw-approved-revs' )
		);

		$propertyAnnotator->addAnnotation( $semanticData );

		return true;
	}

	/**
	 * @see ??
	 *
	 * @since 1.0
	 *
	 * @param ParserOutput $output

The type SMW\ApprovedRevs\ParserOutput was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param Title $title
	 * @param integer $rev_id
	 * @param string $content
	 */
	public function onApprovedRevsRevisionApproved( $output, $title, $rev_id, $content  ) {

The parameter $content is not used and could be removed.

		$ttl = 60 * 60; // 1hr

		if ( $this->cache === null ) {
			$this->cache = ApplicationFactory::getInstance()->getCache();
		}

		// Send an event to ParserAfterTidy and allow it to pass the preliminary
		// test even in cases where the content doesn't contain any SMW related
		// annotations. It is to ensure that when an agent switches to a blank
		// version (no SMW related annotations or categories) the update is carried
		// out and the store is able to remove any remaining annotations.
		$key = smwfCacheKey( 'smw:parseraftertidy', $title->getPrefixedDBKey() );
		$this->cache->save( $key, $rev_id, $ttl );

		return true;
	}

	/**
	 * @see ??
	 *
	 * @since 1.0
	 *
	 * @param Parser $parser

The type SMW\ApprovedRevs\Parser was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @param Title $title
	 * @param integer $timestamp
	 * @param string $sha1
	 */
	public function onApprovedRevsFileRevisionApproved( $parser, $title, $timestamp, $sha1  ) {

		$ttl = 60 * 60; // 1hr

		if ( $this->cache === null ) {
			$this->cache = ApplicationFactory::getInstance()->getCache();
		}

		// @see onApprovedRevsRevisionApproved for the same reason
		$key = smwfCacheKey( 'smw:parseraftertidy', $title->getPrefixedDBKey() );
		$this->cache->save( $key, $sha1, $ttl );

		return true;
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#...
	 *
	 * @since 1.0
	 *
	 * @param Title $title
	 * @param File &$file

The type SMW\ApprovedRevs\File was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	public function onChangeFile( $title, &$file ) {

		$approvedRevsHandler = new ApprovedRevsHandler(
			new ApprovedRevsFacade()
		);

		$approvedRevsHandler->doChangeFile( $title, $file );

		return true;
	}

	private function registerHandlers( $config ) {

The parameter $config is not used and could be removed.

		$this->handlers = [
			'ApprovedRevsRevisionApproved' => [ $this, 'onApprovedRevsRevisionApproved' ],
			'ApprovedRevsFileRevisionApproved' => [ $this, 'onApprovedRevsFileRevisionApproved' ],
			'SMW::RevisionGuard::IsApprovedRevision' => [ $this, 'onIsApprovedRevision' ],
			'SMW::RevisionGuard::ChangeRevision' => [ $this, 'onChangeRevision' ],
			'SMW::RevisionGuard::ChangeRevisionID' => [ $this, 'onOverrideRevisionID' ],
			'SMW::RevisionGuard::ChangeFile' => [ $this, 'onChangeFile' ],
			'SMW::Property::initProperties' => [ $this, 'onInitProperties' ],
			'SMWStore::updateDataBefore' => [ $this, 'onUpdateDataBefore' ],
		];
	}

	/**
	 * @since 1.0
	 */
	public static function onExtensionFunction() {

		if ( !defined( 'SMW_VERSION' ) ) {
			if ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' ) {
				die( "\nThe 'Semantic Approved Revs' extension requires the 'Semantic MediaWiki' extension to be installed and enabled.\n" );

Using exit here is not recommended.

			} else {
				die(

Using exit here is not recommended.

					'<b>Error:</b> The <a href="https://github.com/SemanticMediaWiki/SemanticApprovedRevs/">Semantic Approved Revs</a> extension' .
					' requires the <a href="https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki">Semantic MediaWiki</a> extension to be installed and enabled.<br />'
				);
			}
		}

		// We expected to check for APPROVED_REVS_VERSION but the extension and
		// its `extension.json` doesn't set the constant so we have to rely on
		// active class loading (which is an anti-pattern) to check whether the
		// extension is enabled or not!
		if ( !class_exists( 'ApprovedRevs' ) ) {
			if ( PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg' ) {
				die( "\nThe 'Semantic Approved Revs' extension requires the 'Approved Revs' extension to be installed and enabled.\n" );

Using exit here is not recommended.

			} else {
				die(

Using exit here is not recommended.

					'<b>Error:</b> The <a href="https://github.com/SemanticMediaWiki/SemanticApprovedRevs/">Semantic Approved Revs</a> extension' .
					' requires the <a href="https://www.mediawiki.org/wiki/Extension:Approved_Revs">Approved Revs</a> extension to be installed and enabled.<br />'
				);
			}
		}

		if ( defined( 'SESP_VERSION' ) && version_compare( SESP_VERSION, '2.1.0', '<' ) && ( $prop = Hooks::hasPropertyCollisions( $GLOBALS ) ) !== false ) {

The constant SMW\ApprovedRevs\SESP_VERSION was not found. Maybe you did not declare it correctly or list all dependencies?

			die(

Using exit here is not recommended.

				"\nPlease remove the `$prop` property (defined by the SemanticExtraSpecialProperties extension) and switch to the new SESP version 2.1" .
				" to avoid collision with the 'Semantic Approved Revs' list of properties.\n"
			);
		}

		$hooks = new Hooks();
		$hooks->register();
	}

}