path: root/www/wiki/extensions/SemanticMediaWiki/src/SQLStore/QueryEngine/Fulltext/SearchTable.php

<?php

namespace SMW\SQLStore\QueryEngine\Fulltext;

use SMW\DataTypeRegistry;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMW\MediaWiki\Database;
use SMW\SQLStore\SQLStore;
use SMWDataItem as DataItem;
use SMW\Exception\PredefinedPropertyLabelMismatchException;

/**
 * @license GNU GPL v2+
 * @since 2.5
 *
 * @author mwjames
 */
class SearchTable {

	/**
	 * @var Store
	 */
	private $store;

	/**
	 * @var Database
	 */
	private $connection;

	/**
	 * @var boolean
	 */
	private $isEnabled = false;

	/**
	 * @var integer
	 */
	private $minTokenSize = 3;

	/**
	 * @var integer
	 */
	private $indexableDataTypes = 0;

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

	/**
	 * @since 2.5
	 *
	 * @param SQLStore $store
	 */
	public function __construct( SQLStore $store ) {
		$this->store = $store;
		$this->connection = $store->getConnection( 'mw.db.queryengine' );
	}

	/**
	 * @since 2.5
	 *
	 * @param array $propertyExemptionList
	 */
	public function setPropertyExemptionList( array $propertyExemptionList ) {
		$this->propertyExemptionList = array_flip(
			str_replace( ' ', '_', $propertyExemptionList )
		);
	}

	/**
	 * @since 2.5
	 *
	 * @param integer $indexableDataTypes
	 */
	public function setIndexableDataTypes( $indexableDataTypes ) {
		$this->indexableDataTypes = $indexableDataTypes;
	}

	/**
	 * @since 2.5
	 *
	 * @return array
	 */
	public function getPropertyExemptionList() {
		return array_keys( $this->propertyExemptionList );
	}

	/**
	 * @since 2.5
	 *
	 * @param integer $id
	 *
	 * @return boolean
	 */
	public function isExemptedPropertyById( $id ) {

		$dataItem = $this->getDataItemById( $id );

		if ( !$dataItem instanceof DIWikiPage || $dataItem->getDBKey() === '' ) {
			return false;
		}

		try {
			$property = DIProperty::newFromUserLabel(
				$dataItem->getDBKey()
			);
		} catch( PredefinedPropertyLabelMismatchException $e ) {
			// The property no longer exists (or is no longer available) therefore
			// exempt it.
			return true;
		}

		return $this->isExemptedProperty( $property );
	}

	/**
	 * @since 2.5
	 *
	 * @param DIProperty $property
	 *
	 * @return boolean
	 */
	public function isExemptedProperty( DIProperty $property ) {

		$dataItemTypeId = DataTypeRegistry::getInstance()->getDataItemId(
			$property->findPropertyTypeID()
		);

		// Property does not belong to a valid type which means to be exempted
		if ( !$this->isValidByType( $dataItemTypeId ) ) {
			return true;
		}

		return isset( $this->propertyExemptionList[$property->getKey()] );
	}

	/**
	 * @since 2.5
	 *
	 * @param DIProperty $property
	 *
	 * @return boolean
	 */
	public function isValidByType( $type ) {

		$indexType = SMW_FT_NONE;

		if ( $type === DataItem::TYPE_BLOB ) {
			$indexType = SMW_FT_BLOB;
		}

		if ( $type === DataItem::TYPE_URI ) {
			$indexType = SMW_FT_URI;
		}

		if ( $type === DataItem::TYPE_WIKIPAGE ) {
			$indexType = SMW_FT_WIKIPAGE;
		}

		return ( $this->indexableDataTypes & $indexType ) != 0;
	}

	/**
	 * @since 2.5
	 *
	 * @param boolean $enabled
	 */
	public function setEnabled( $enabled ) {
		$this->isEnabled = (bool)$enabled;
	}

	/**
	 * @since 2.5
	 *
	 * @return boolean
	 */
	public function isEnabled() {
		return $this->isEnabled;
	}

	/**
	 * @since 2.5
	 *
	 * @return string
	 */
	public function getTableName() {
		return SQLStore::FT_SEARCH_TABLE;
	}

	/**
	 * @since 2.5
	 *
	 * @return string
	 */
	public function getIndexField() {
		return 'o_text';
	}

	/**
	 * @since 2.5
	 *
	 * @return string
	 */
	public function getSortField() {
		return 'o_sort';
	}

	/**
	 * @since 2.5
	 *
	 * @return integer
	 */
	public function getMinTokenSize() {
		return $this->minTokenSize;
	}

	/**
	 * @since 2.5
	 *
	 * @return integer $minTokenSize
	 */
	public function setMinTokenSize( $minTokenSize ) {
		$this->minTokenSize = (int)$minTokenSize;
	}

	/**
	 * @since 2.5
	 *
	 * @param string $token
	 *
	 * @return boolean
	 */
	public function hasMinTokenLength( $token ) {
		return mb_strlen( $token ) >= $this->minTokenSize;
	}

	/**
	 * @since 2.5
	 *
	 * @param DIProperty $property
	 *
	 * @return integer
	 */
	public function getIdByProperty( DIProperty $property ) {
		return $this->store->getObjectIds()->getId( $property->getCanonicalDiWikiPage() );
	}

	/**
	 * @since 2.5
	 *
	 * @param integer $id
	 *
	 * @return DIWikiPage|null
	 */
	public function getDataItemById( $id ) {
		return $this->store->getObjectIds()->getDataItemById( $id );
	}

	/**
	 * @since 2.5
	 *
	 * @return array
	 */
	public function getPropertyTables() {
		return $this->store->getPropertyTables();
	}

	/**
	 * @since 2.5
	 *
	 * @param string $value
	 *
	 * @return string
	 */
	public function addQuotes( $value ) {
		return $this->connection->addQuotes( $value );
	}

}