<?php
namespace WapplerSystems\Meilisearch\IndexQueue;
/***************************************************************
* Copyright notice
*
* (c) 2012-2015 Ingo Renner <ingo@typo3.org>
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project 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 3 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script 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.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
use WapplerSystems\Meilisearch\ContentObject\Classification;
use WapplerSystems\Meilisearch\ContentObject\Multivalue;
use WapplerSystems\Meilisearch\ContentObject\Relation;
use WapplerSystems\Meilisearch\System\Meilisearch\Document\Document;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
/**
* An abstract indexer class to collect a few common methods shared with other
* indexers.
*
* @author Ingo Renner <ingo@typo3.org>
*/
abstract class AbstractIndexer
{
/**
* Holds the type of the data to be indexed, usually that is the table name.
*
* @var string
*/
protected $type = '';
/**
* Holds field names that are denied to overwrite in thy indexing configuration.
*
* @var array
*/
protected static $unAllowedOverrideFields = ['type'];
/**
* @param string $meilisearchFieldName
* @return bool
*/
public static function isAllowedToOverrideField($meilisearchFieldName)
{
return !in_array($meilisearchFieldName, static::$unAllowedOverrideFields);
}
/**
* Adds fields to the document as defined in $indexingConfiguration
*
* @param Document $document base document to add fields to
* @param array $indexingConfiguration Indexing configuration / mapping
* @param array $data Record data
* @return Document Modified document with added fields
*/
protected function addDocumentFieldsFromTyposcript(Document $document, array $indexingConfiguration, array $data) {
$data = static::addVirtualContentFieldToRecord($document, $data);
// mapping of record fields => meilisearch document fields, resolving cObj
foreach ($indexingConfiguration as $meilisearchFieldName => $recordFieldName) {
if (is_array($recordFieldName)) {
// configuration for a content object, skipping
continue;
}
if (!static::isAllowedToOverrideField($meilisearchFieldName)) {
throw new InvalidFieldNameException(
'Must not overwrite field .' . $meilisearchFieldName,
1435441863
);
}
$fieldValue = $this->resolveFieldValue($indexingConfiguration, $meilisearchFieldName, $data);
if (is_array($fieldValue)) {
// multi value
$document->setField($meilisearchFieldName, $fieldValue);
} else {
if ($fieldValue !== '' && $fieldValue !== null) {
$document->setField($meilisearchFieldName, $fieldValue);
}
}
}
return $document;
}
/**
* Add's the content of the field 'content' from the meilisearch document as virtual field __meilisearch_content in the record,
* to have it available in typoscript.
*
* @param Document $document
* @param array $data
* @return array
*/
public static function addVirtualContentFieldToRecord(Document $document, array $data): array
{
if (isset($document['content'])) {
$data['__meilisearch_content'] = $document['content'];
return $data;
}
return $data;
}
/**
* Resolves a field to its value depending on its configuration.
*
* This enables you to configure the indexer to put the item/record through
* cObj processing if wanted/needed. Otherwise the plain item/record value
* is taken.
*
* @param array $indexingConfiguration Indexing configuration as defined in plugin.tx_meilisearch_index.queue.[indexingConfigurationName].fields
* @param string $meilisearchFieldName A Meilisearch field name that is configured in the indexing configuration
* @param array $data A record or item's data
* @return string The resolved string value to be indexed
*/
protected function resolveFieldValue(
array $indexingConfiguration,
$meilisearchFieldName,
array $data
) {
$contentObject = GeneralUtility::makeInstance(ContentObjectRenderer::class);
if (isset($indexingConfiguration[$meilisearchFieldName . '.'])) {
// configuration found => need to resolve a cObj
// need to change directory to make IMAGE content objects work in BE context
// see http://blog.netzelf.de/lang/de/tipps-und-tricks/tslib_cobj-image-im-backend
$backupWorkingDirectory = getcwd();
chdir(Environment::getPublicPath() . '/');
$contentObject->start($data, $this->type);
$fieldValue = $contentObject->cObjGetSingle(
$indexingConfiguration[$meilisearchFieldName],
$indexingConfiguration[$meilisearchFieldName . '.']
);
chdir($backupWorkingDirectory);
if ($this->isSerializedValue($indexingConfiguration,
$meilisearchFieldName)
) {
$fieldValue = unserialize($fieldValue);
}
} elseif (substr($indexingConfiguration[$meilisearchFieldName], 0,
1) === '<'
) {
$referencedTsPath = trim(substr($indexingConfiguration[$meilisearchFieldName],
1));
$typoScriptParser = GeneralUtility::makeInstance(TypoScriptParser::class);
// $name and $conf is loaded with the referenced values.
list($name, $conf) = $typoScriptParser->getVal($referencedTsPath,
$GLOBALS['TSFE']->tmpl->setup);
// need to change directory to make IMAGE content objects work in BE context
// see http://blog.netzelf.de/lang/de/tipps-und-tricks/tslib_cobj-image-im-backend
$backupWorkingDirectory = getcwd();
chdir(Environment::getPublicPath() . '/');
$contentObject->start($data, $this->type);
$fieldValue = $contentObject->cObjGetSingle($name, $conf);
chdir($backupWorkingDirectory);
if ($this->isSerializedValue($indexingConfiguration,
$meilisearchFieldName)
) {
$fieldValue = unserialize($fieldValue);
}
} else {
$fieldValue = $data[$indexingConfiguration[$meilisearchFieldName]];
}
// detect and correct type for dynamic fields
// find last underscore, substr from there, cut off last character (S/M)
$fieldType = substr($meilisearchFieldName, strrpos($meilisearchFieldName, '_') + 1,
-1);
if (is_array($fieldValue)) {
foreach ($fieldValue as $key => $value) {
$fieldValue[$key] = $this->ensureFieldValueType($value,
$fieldType);
}
} else {
$fieldValue = $this->ensureFieldValueType($fieldValue, $fieldType);
}
return $fieldValue;
}
// Utility methods
/**
* Uses a field's configuration to detect whether its value returned by a
* content object is expected to be serialized and thus needs to be
* unserialized.
*
* @param array $indexingConfiguration Current item's indexing configuration
* @param string $meilisearchFieldName Current field being indexed
* @return bool TRUE if the value is expected to be serialized, FALSE otherwise
*/
public static function isSerializedValue(array $indexingConfiguration, $meilisearchFieldName)
{
$isSerialized = static::isSerializedResultFromRegisteredHook($indexingConfiguration, $meilisearchFieldName);
if ($isSerialized === true) {
return $isSerialized;
}
$isSerialized = static::isSerializedResultFromCustomContentElement($indexingConfiguration, $meilisearchFieldName);
return $isSerialized;
}
/**
* Checks if the response comes from a custom content element that returns a serialized value.
*
* @param array $indexingConfiguration
* @param string $meilisearchFieldName
* @return bool
*/
protected static function isSerializedResultFromCustomContentElement(array $indexingConfiguration, $meilisearchFieldName): bool
{
$isSerialized = false;
// SOLR_CLASSIFICATION - always returns serialized array
if ($indexingConfiguration[$meilisearchFieldName] == Classification::CONTENT_OBJECT_NAME) {
$isSerialized = true;
}
// SOLR_MULTIVALUE - always returns serialized array
if ($indexingConfiguration[$meilisearchFieldName] == Multivalue::CONTENT_OBJECT_NAME) {
$isSerialized = true;
}
// SOLR_RELATION - returns serialized array if multiValue option is set
if ($indexingConfiguration[$meilisearchFieldName] == Relation::CONTENT_OBJECT_NAME && !empty($indexingConfiguration[$meilisearchFieldName . '.']['multiValue'])) {
$isSerialized = true;
}
return $isSerialized;
}
/**
* Checks registered hooks if a SerializedValueDetector detects a serialized response.
*
* @param array $indexingConfiguration
* @param string $meilisearchFieldName
* @return bool
*/
protected static function isSerializedResultFromRegisteredHook(array $indexingConfiguration, $meilisearchFieldName)
{
if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['meilisearch']['detectSerializedValue'])) {
return false;
}
foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['meilisearch']['detectSerializedValue'] as $classReference) {
$serializedValueDetector = GeneralUtility::makeInstance($classReference);
if (!$serializedValueDetector instanceof SerializedValueDetector) {
$message = get_class($serializedValueDetector) . ' must implement interface ' . SerializedValueDetector::class;
throw new \UnexpectedValueException($message, 1404471741);
}
$isSerialized = (boolean)$serializedValueDetector->isSerializedValue($indexingConfiguration, $meilisearchFieldName);
if ($isSerialized) {
return true;
}
}
}
/**
* Makes sure a field's value matches a (dynamic) field's type.
*
* @param mixed $value Value to be added to a document
* @param string $fieldType The dynamic field's type
* @return mixed Returns the value in the correct format for the field type
*/
protected function ensureFieldValueType($value, $fieldType)
{
switch ($fieldType) {
case 'int':
case 'tInt':
$value = intval($value);
break;
case 'float':
case 'tFloat':
$value = floatval($value);
break;
// long and double do not exist in PHP
// simply make sure it somehow looks like a number
// <insert PHP rant here>
case 'long':
case 'tLong':
// remove anything that's not a number or negative/minus sign
$value = preg_replace('/[^0-9\\-]/', '', $value);
if (trim($value) === '') {
$value = 0;
}
break;
case 'double':
case 'tDouble':
case 'tDouble4':
// as long as it's numeric we'll take it, int or float doesn't matter
if (!is_numeric($value)) {
$value = 0;
}
break;
default:
// assume things are correct for non-dynamic fields
}
return $value;
}
}