Util::buildConfigurationArray() - Code Metrics - Inspection of "Merge pull request #1257 from timohund/task/master..." - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 90cea8...3d6c73 )

by Timo

created 2017-04-10 09:23 UTC

Util::buildConfigurationArray() A

↳ Parent: Util

Complexity

Conditions	3
Paths	4

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	4
nop	4
crap	3

<?php
namespace ApacheSolrForTypo3\Solr;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2009-2015 Ingo Renner <[email protected]>
 *  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 2 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 ApacheSolrForTypo3\Solr\Domain\Index\Queue\RecordMonitor\Helper\RootPageResolver;
use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
use ApacheSolrForTypo3\Solr\Domain\Site\SiteHashService;
use ApacheSolrForTypo3\Solr\System\Cache\TwoLevelCache;
use ApacheSolrForTypo3\Solr\System\Configuration\ConfigurationManager;
use ApacheSolrForTypo3\Solr\System\Configuration\ConfigurationPageResolver;
use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
use ApacheSolrForTypo3\Solr\System\DateTime\FormatService;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\TimeTracker\NullTimeTracker;
use TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\CMS\Frontend\Page\PageRepository;

/**
 * Utility class for tx_solr
 *
 * @author Ingo Renner <[email protected]>
 */
class Util
{

    /**
     * Generates a document id for documents representing page records.
     *
     * @param int $uid The page's uid
     * @param int $typeNum The page's typeNum
     * @param int $language the language id, defaults to 0
     * @param string $accessGroups comma separated list of uids of groups that have access to that page
     * @param string $mountPointParameter The mount point parameter that is used to access the page.
     * @return string The document id for that page
     */
    public static function getPageDocumentId(
        $uid,
        $typeNum = 0,
        $language = 0,
        $accessGroups = '0,-1',
        $mountPointParameter = ''
    ) {
        $additionalParameters = $typeNum . '/' . $language . '/' . $accessGroups;

        if ((string)$mountPointParameter !== '') {
            $additionalParameters = $mountPointParameter . '/' . $additionalParameters;
        }

        $documentId = self::getDocumentId(
            'pages',
            $uid,
            $uid,
            $additionalParameters
        );

        return $documentId;
    }

    /**
     * Generates a document id in the form $siteHash/$type/$uid.
     *
     * @param string $table The records table name
     * @param int $pid The record's pid
     * @param int $uid The record's uid
     * @param string $additionalIdParameters Additional ID parameters
     * @return string A document id
     */
    public static function getDocumentId(
        $table,
        $pid,
        $uid,
        $additionalIdParameters = ''
    ) {
        $siteRepository = GeneralUtility::makeInstance(SiteRepository::class);
        $site = $siteRepository->getSiteByPageId($pid);
        $siteHash = $site->getSiteHash();

        $documentId = $siteHash . '/' . $table . '/' . $uid;
        if (!empty($additionalIdParameters)) {
            $documentId .= '/' . $additionalIdParameters;
        }

        return $documentId;
    }

    /**
     * Returns given word as CamelCased.
     *
     * Converts a word like "send_email" to "SendEmail". It
     * will remove non alphanumeric characters from the word, so
     * "who's online" will be converted to "WhoSOnline"
     *
     * @param string $word Word to convert to camel case
     * @return string UpperCamelCasedWord
     */
    public static function camelize($word)
    {
        return str_replace(' ', '',
            ucwords(preg_replace('![^A-Z^a-z^0-9]+!', ' ', $word)));
    }

    /**
     * Returns a given CamelCasedString as an lowercase string with underscores.
     * Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
     *
     * @param string $string String to be converted to lowercase underscore
     * @return string     lowercase_and_underscored_string
     */
    public static function camelCaseToLowerCaseUnderscored($string)
    {
        return strtolower(preg_replace('/(?<=\w)([A-Z])/', '_\\1', $string));
    }

    /**
     * Returns a given string with underscores as UpperCamelCase.
     * Example: Converts blog_example to BlogExample
     *
     * @param string $string String to be converted to camel case
     * @return string     UpperCamelCasedWord
     */
    public static function underscoredToUpperCamelCase($string)
    {
        return str_replace(' ', '',
            ucwords(str_replace('_', ' ', strtolower($string))));
    }

    /**
     * Shortcut to retrieve the TypoScript configuration for EXT:solr
     * (plugin.tx_solr) from TSFE.
     *
     * @return TypoScriptConfiguration
     */
    public static function getSolrConfiguration()
    {
        $configurationManager = self::getConfigurationManager();

        return $configurationManager->getTypoScriptConfiguration();
    }

    /**
     * @return ConfigurationManager
     */
    private static function getConfigurationManager()
    {
        /** @var ConfigurationManager $configurationManager */
        $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);
        return $configurationManager;
    }

    /**
     * Gets the Solr configuration for a specific root page id.
     * To be used from the backend.
     *
     * @param int $pageId Id of the (root) page to get the Solr configuration from.
     * @param bool $initializeTsfe Optionally initializes a full TSFE to get the configuration, defaults to FALSE
     * @param int $language System language uid, optional, defaults to 0
     * @return TypoScriptConfiguration The Solr configuration for the requested tree.
     */
    public static function getSolrConfigurationFromPageId(
        $pageId,
        $initializeTsfe = false,
        $language = 0
    ) {
        $rootPath = '';
        return self::getConfigurationFromPageId($pageId, $rootPath, $initializeTsfe, $language);
    }

    /**
     * Loads the TypoScript configuration for a given page id and language.
     * Language usage may be disabled to get the default TypoScript
     * configuration.
     *
     * @param int $pageId Id of the (root) page to get the Solr configuration from.
     * @param string $path The TypoScript configuration path to retrieve.
     * @param bool $initializeTsfe Optionally initializes a full TSFE to get the configuration, defaults to FALSE
     * @param int $language System language uid, optional, defaults to 0
     * @param bool $useTwoLevelCache Flag to enable the two level cache for the typoscript configuration array
     * @return TypoScriptConfiguration The Solr configuration for the requested tree.
     */
    public static function getConfigurationFromPageId(
        $pageId,
        $path,
        $initializeTsfe = false,
        $language = 0,
        $useTwoLevelCache = true
    ) {
        $pageId = self::getConfigurationPageIdToUse($pageId);

        static $configurationObjectCache = [];
        $cacheId = md5($pageId . '|' . $path . '|' . $language);
        if (isset($configurationObjectCache[$cacheId])) {
            return $configurationObjectCache[$cacheId];
        }

        // If we're on UID 0, we cannot retrieve a configuration currently.
        // getRootline() below throws an exception (since #typo3-60 )
        // as UID 0 cannot have any parent rootline by design.
        if ($pageId == 0) {
            return $configurationObjectCache[$cacheId] = self::buildTypoScriptConfigurationFromArray([], $pageId, $language, $path);
        }

        if ($useTwoLevelCache) {
            /** @var $cache TwoLevelCache */
            $cache = GeneralUtility::makeInstance(TwoLevelCache::class, 'tx_solr_configuration');
            $configurationArray = $cache->get($cacheId);
        }

        if (!empty($configurationArray)) {
            // we have a cache hit and can return it.
            return $configurationObjectCache[$cacheId] = self::buildTypoScriptConfigurationFromArray($configurationArray, $pageId, $language, $path);
        }

        // we have nothing in the cache. We need to build the configurationToUse
        $configurationArray = self::buildConfigurationArray($pageId, $path, $initializeTsfe, $language);

        if ($useTwoLevelCache && isset($cache)) {
            $cache->set($cacheId, $configurationArray);
        }

        return $configurationObjectCache[$cacheId] = self::buildTypoScriptConfigurationFromArray($configurationArray, $pageId, $language, $path);
    }

    /**
     * This method retrieves the closest pageId where a configuration is located, when this
     * feature is enabled.
     *
     * @param int $pageId
     * @return int
     */
    protected static function getConfigurationPageIdToUse($pageId)
    {
        $extensionConfiguration = GeneralUtility::makeInstance(ExtensionConfiguration::class);
        if ($extensionConfiguration->getIsUseConfigurationFromClosestTemplateEnabled()) {
            /** @var $configurationPageResolve ConfigurationPageResolver */
            $configurationPageResolver = GeneralUtility::makeInstance(ConfigurationPageResolver::class);
            $pageId = $configurationPageResolver->getClosestPageIdWithActiveTemplate($pageId);
            return $pageId;
        }
        return $pageId;
    }

    /**
     * Initializes a TSFE, if required and builds an configuration array, containing the solr configuration.
     *
     * @param integer $pageId
     * @param string $path
     * @param boolean $initializeTsfe
     * @param integer $language
     * @return array
     */
    protected static function buildConfigurationArray($pageId, $path, $initializeTsfe, $language)
    {
        if ($initializeTsfe) {
            self::initializeTsfe($pageId, $language);
            $configurationToUse = self::getConfigurationFromInitializedTSFE($path);
        } else {
            $configurationToUse = self::getConfigurationFromExistingTSFE($pageId, $path, $language);
        }

        return is_array($configurationToUse) ? $configurationToUse : [];
    }

    /**
     * Builds the configuration object from a config array and returns it.
     *
     * @param array $configurationToUse
     * @param int $pageId
     * @param int $languageId
     * @param string $typoScriptPath
     * @return TypoScriptConfiguration
     */
    protected static function buildTypoScriptConfigurationFromArray(array $configurationToUse, $pageId, $languageId, $typoScriptPath)
    {
        $configurationManager = self::getConfigurationManager();
        return $configurationManager->getTypoScriptConfiguration($configurationToUse, $pageId, $languageId, $typoScriptPath);
    }

    /**
     * This function is used to retrieve the configuration from a previous initialized TSFE
     * (see: getConfigurationFromPageId)
     *
     * @param string $path
     * @return mixed
     */
    private static function getConfigurationFromInitializedTSFE($path)
    {
        /** @var $tmpl ExtendedTemplateService */
        $tmpl = GeneralUtility::makeInstance(ExtendedTemplateService::class);
        $configuration = $tmpl->ext_getSetup($GLOBALS['TSFE']->tmpl->setup, $path);
        $configurationToUse = $configuration[0];
        return $configurationToUse;
    }

    /**
     * This function is used to retrieve the configuration from an existing TSFE instance
     * @param $pageId
     * @param $path
     * @param $language
     * @return mixed
     */
    private static function getConfigurationFromExistingTSFE($pageId, $path, $language)
    {
        if (is_int($language)) {
            GeneralUtility::_GETset($language, 'L');
        }

            /** @var $pageSelect PageRepository */
        $pageSelect = GeneralUtility::makeInstance(PageRepository::class);
        $rootLine = $pageSelect->getRootLine($pageId);

        $initializedTsfe = false;
        $initializedPageSelect = false;
        if (empty($GLOBALS['TSFE']->sys_page)) {
            if (empty($GLOBALS['TSFE'])) {
                $GLOBALS['TSFE'] = new \stdClass();
                $GLOBALS['TSFE']->tmpl = new \stdClass();
                $GLOBALS['TSFE']->tmpl->rootLine = $rootLine;
                $GLOBALS['TSFE']->sys_page = $pageSelect;
                $GLOBALS['TSFE']->id = $pageId;
                $GLOBALS['TSFE']->tx_solr_initTsfe = 1;
                $initializedTsfe = true;
            }

            $GLOBALS['TSFE']->sys_page = $pageSelect;
            $initializedPageSelect = true;
        }
            /** @var $tmpl ExtendedTemplateService */
        $tmpl = GeneralUtility::makeInstance(ExtendedTemplateService::class);
        $tmpl->tt_track = false; // Do not log time-performance information
        $tmpl->init();
        $tmpl->runThroughTemplates($rootLine); // This generates the constants/config + hierarchy info for the template.
        $tmpl->generateConfig();

        $getConfigurationFromInitializedTSFEAndWriteToCache = $tmpl->ext_getSetup($tmpl->setup, $path);
        $configurationToUse = $getConfigurationFromInitializedTSFEAndWriteToCache[0];

        if ($initializedPageSelect) {
            $GLOBALS['TSFE']->sys_page = null;
        }
        if ($initializedTsfe) {
            unset($GLOBALS['TSFE']);
        }
        return $configurationToUse;
    }

    /**
     * Initializes the TSFE for a given page ID and language.
     *
     * @param int $pageId The page id to initialize the TSFE for
     * @param int $language System language uid, optional, defaults to 0
     * @param bool $useCache Use cache to reuse TSFE
     * @return void
     */
    public static function initializeTsfe(
        $pageId,
        $language = 0,
        $useCache = true
    ) {
        static $tsfeCache = [];

        // resetting, a TSFE instance with data from a different page Id could be set already
        unset($GLOBALS['TSFE']);

        $cacheId = $pageId . '|' . $language;

        if (!is_object($GLOBALS['TT'])) {
            $GLOBALS['TT'] = GeneralUtility::makeInstance(NullTimeTracker::class);
        }

        if (!isset($tsfeCache[$cacheId]) || !$useCache) {
            GeneralUtility::_GETset($language, 'L');

            $GLOBALS['TSFE'] = GeneralUtility::makeInstance(TypoScriptFrontendController::class,
                $GLOBALS['TYPO3_CONF_VARS'], $pageId, 0);

            // for certain situations we need to trick TSFE into granting us
            // access to the page in any case to make getPageAndRootline() work
            // see http://forge.typo3.org/issues/42122
            $pageRecord = BackendUtility::getRecord('pages', $pageId, 'fe_group');
            $groupListBackup = $GLOBALS['TSFE']->gr_list;
            $GLOBALS['TSFE']->gr_list = $pageRecord['fe_group'];

            $GLOBALS['TSFE']->sys_page = GeneralUtility::makeInstance(PageRepository::class);
            $GLOBALS['TSFE']->getPageAndRootline();

            // restore gr_list
            $GLOBALS['TSFE']->gr_list = $groupListBackup;

            $GLOBALS['TSFE']->initTemplate();
            $GLOBALS['TSFE']->forceTemplateParsing = true;
            $GLOBALS['TSFE']->initFEuser();
            $GLOBALS['TSFE']->initUserGroups();
            //  $GLOBALS['TSFE']->getCompressedTCarray(); // seems to cause conflicts sometimes

            $GLOBALS['TSFE']->no_cache = true;
            $GLOBALS['TSFE']->tmpl->start($GLOBALS['TSFE']->rootLine);
            $GLOBALS['TSFE']->no_cache = false;
            $GLOBALS['TSFE']->getConfigArray();

            $GLOBALS['TSFE']->settingLanguage();
            if (!$useCache) {
                $GLOBALS['TSFE']->settingLocale();
            }

            $GLOBALS['TSFE']->newCObj();
            $GLOBALS['TSFE']->absRefPrefix = self::getAbsRefPrefixFromTSFE($GLOBALS['TSFE']);
            $GLOBALS['TSFE']->calculateLinkVars();

            if ($useCache) {
                $tsfeCache[$cacheId] = $GLOBALS['TSFE'];
            }
        }

        if ($useCache) {
            $GLOBALS['TSFE'] = $tsfeCache[$cacheId];
            $GLOBALS['TSFE']->settingLocale();
        }
    }

    /**
     * Check if record ($table, $uid) is a workspace record
     *
     * @param string $table The table the record belongs to
     * @param int $uid The record's uid
     * @return bool TRUE if the record is in a draft workspace, FALSE if it's a LIVE record
     */
    public static function isDraftRecord($table, $uid)
    {
        $isWorkspaceRecord = false;

        if ((ExtensionManagementUtility::isLoaded('workspaces')) && (BackendUtility::isTableWorkspaceEnabled($table))) {
            $record = BackendUtility::getRecord($table, $uid, 'pid, t3ver_state');

            if ($record['pid'] == '-1' || $record['t3ver_state'] > 0) {
                $isWorkspaceRecord = true;
            }
        }

        return $isWorkspaceRecord;
    }

    /**
     * Checks whether a record is a localization overlay.
     *
     * @param string $tableName The record's table name
     * @param array $record The record to check
     * @return bool TRUE if the record is a language overlay, FALSE otherwise
     */
    public static function isLocalizedRecord($tableName, array $record)
    {
        $isLocalizedRecord = false;

        if (isset($GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'])) {
            $translationOriginalPointerField = $GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'];

            if ($record[$translationOriginalPointerField] > 0) {
                $isLocalizedRecord = true;
            }
        }

        return $isLocalizedRecord;
    }

    /**
     * Check if the page type of a page record is allowed
     *
     * @param array $pageRecord The pages database row
     * @param string $configurationName The name of the configuration to use.
     *
     * @return bool TRUE if the page type is allowed, otherwise FALSE
     */
    public static function isAllowedPageType(array $pageRecord, $configurationName = 'pages')
    {
        $isAllowedPageType = false;
        $configurationName = is_null($configurationName) ? 'pages' : $configurationName;
        $allowedPageTypes = self::getAllowedPageTypes($pageRecord['uid'], $configurationName);

        if (in_array($pageRecord['doktype'], $allowedPageTypes)) {
            $isAllowedPageType = true;
        }

        return $isAllowedPageType;
    }

    /**
     * Get allowed page types
     *
     * @param int $pageId Page ID
     * @param string $configurationName The name of the configuration to use.
     *
     * @return array Allowed page types to compare to a doktype of a page record
     */
    public static function getAllowedPageTypes($pageId, $configurationName = 'pages')
    {
        $rootPath = '';
        $configuration = self::getConfigurationFromPageId($pageId, $rootPath);
        return $configuration->getIndexQueueAllowedPageTypesArrayByConfigurationName($configurationName);
    }

    /**
     * Method to check if a page exists.
     *
     * @param int $pageId
     * @return bool
     */
    public static function pageExists($pageId)
    {
        $page = BackendUtility::getRecord('pages', (int)$pageId, 'uid');

        if (!is_array($page) || $page['uid'] != $pageId) {
            return false;
        }

        return true;
    }

    /**
     * Resolves the configured absRefPrefix to a valid value and resolved if absRefPrefix
     * is set to "auto".
     *
     * @param TypoScriptFrontendController $TSFE
     * @return string
     */
    public static function getAbsRefPrefixFromTSFE(TypoScriptFrontendController $TSFE)
    {
        $absRefPrefix = '';
        if (empty($TSFE->config['config']['absRefPrefix'])) {
            return $absRefPrefix;
        }

        $absRefPrefix = trim($TSFE->config['config']['absRefPrefix']);
        if ($absRefPrefix === 'auto') {
            $absRefPrefix = GeneralUtility::getIndpEnv('TYPO3_SITE_PATH');
        }

        return $absRefPrefix;
    }

    /**
     * This function can be used to check if one of the strings in needles is
     * contained in the haystack.
     *
     *
     * Example:
     *
     * haystack: the brown fox
     * needles: ['hello', 'world']
     * result: false
     *
     * haystack: the brown fox
     * needles: ['is', 'fox']
     * result: true
     *
     * @param string $haystack
     * @param array $needles
     * @return bool
     */
    public static function containsOneOfTheStrings($haystack, array $needles)
    {
        foreach ($needles as $needle) {
            $position = strpos($haystack, $needle);
            if ($position !== false) {
                return true;
            }
        }

        return false;
    }
}


1		<?php
2		namespace ApacheSolrForTypo3\Solr;
3
4		/***************************************************************
5		* Copyright notice
6		*
7		* (c) 2009-2015 Ingo Renner <[email protected]>
8		* All rights reserved
9		*
10		* This script is part of the TYPO3 project. The TYPO3 project is
11		* free software; you can redistribute it and/or modify
12		* it under the terms of the GNU General Public License as published by
13		* the Free Software Foundation; either version 2 of the License, or
14		* (at your option) any later version.
15		*
16		* The GNU General Public License can be found at
17		* http://www.gnu.org/copyleft/gpl.html.
18		*
19		* This script is distributed in the hope that it will be useful,
20		* but WITHOUT ANY WARRANTY; without even the implied warranty of
21		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22		* GNU General Public License for more details.
23		*
24		* This copyright notice MUST APPEAR in all copies of the script!
25		***************************************************************/
26
27		use ApacheSolrForTypo3\Solr\Domain\Index\Queue\RecordMonitor\Helper\RootPageResolver;
28		use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
29		use ApacheSolrForTypo3\Solr\Domain\Site\SiteHashService;
30		use ApacheSolrForTypo3\Solr\System\Cache\TwoLevelCache;
31		use ApacheSolrForTypo3\Solr\System\Configuration\ConfigurationManager;
32		use ApacheSolrForTypo3\Solr\System\Configuration\ConfigurationPageResolver;
33		use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
34		use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
35		use ApacheSolrForTypo3\Solr\System\DateTime\FormatService;
36		use TYPO3\CMS\Backend\Utility\BackendUtility;
37		use TYPO3\CMS\Core\TimeTracker\NullTimeTracker;
38		use TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;
39		use TYPO3\CMS\Core\Utility\GeneralUtility;
40		use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
41		use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
42		use TYPO3\CMS\Frontend\Page\PageRepository;
43
44		/**
45		* Utility class for tx_solr
46		*
47		* @author Ingo Renner <[email protected]>
48		*/
49		class Util
50		{
51
52		/**
53		* Generates a document id for documents representing page records.
54		*
55		* @param int $uid The page's uid
56		* @param int $typeNum The page's typeNum
57		* @param int $language the language id, defaults to 0
58		* @param string $accessGroups comma separated list of uids of groups that have access to that page
59		* @param string $mountPointParameter The mount point parameter that is used to access the page.
60		* @return string The document id for that page
61		*/
62	45	public static function getPageDocumentId(
63		$uid,
64		$typeNum = 0,
65		$language = 0,
66		$accessGroups = '0,-1',
67		$mountPointParameter = ''
68		) {
69	45	$additionalParameters = $typeNum . '/' . $language . '/' . $accessGroups;
70
71	45	if ((string)$mountPointParameter !== '') {
72		$additionalParameters = $mountPointParameter . '/' . $additionalParameters;
73		}
74
75	45	$documentId = self::getDocumentId(
76	45	'pages',
77	45	$uid,
78	45	$uid,
79		$additionalParameters
80	45	);
81
82	45	return $documentId;
83		}
84
85		/**
86		* Generates a document id in the form $siteHash/$type/$uid.
87		*
88		* @param string $table The records table name
89		* @param int $pid The record's pid
90		* @param int $uid The record's uid
91		* @param string $additionalIdParameters Additional ID parameters
92		* @return string A document id
93		*/
94	56	public static function getDocumentId(
95		$table,
96		$pid,
97		$uid,
98		$additionalIdParameters = ''
99		) {
100	56	$siteRepository = GeneralUtility::makeInstance(SiteRepository::class);
101	56	$site = $siteRepository->getSiteByPageId($pid);
102	56	$siteHash = $site->getSiteHash();
103
104	56	$documentId = $siteHash . '/' . $table . '/' . $uid;
105	56	if (!empty($additionalIdParameters)) {
106	45	$documentId .= '/' . $additionalIdParameters;
107	45	}
108
109	56	return $documentId;
110		}
111
112		/**
113		* Returns given word as CamelCased.
114		*
115		* Converts a word like "send_email" to "SendEmail". It
116		* will remove non alphanumeric characters from the word, so
117		* "who's online" will be converted to "WhoSOnline"
118		*
119		* @param string $word Word to convert to camel case
120		* @return string UpperCamelCasedWord
121		*/
122		public static function camelize($word)
123		{
124		return str_replace(' ', '',
125		ucwords(preg_replace('![^A-Z^a-z^0-9]+!', ' ', $word)));
126		}
127
128		/**
129		* Returns a given CamelCasedString as an lowercase string with underscores.
130		* Example: Converts BlogExample to blog_example, and minimalValue to minimal_value
131		*
132		* @param string $string String to be converted to lowercase underscore
133		* @return string lowercase_and_underscored_string
134		*/
135		public static function camelCaseToLowerCaseUnderscored($string)
136		{
137		return strtolower(preg_replace('/(?<=\w)([A-Z])/', '_\\1', $string));
138		}
139
140		/**
141		* Returns a given string with underscores as UpperCamelCase.
142		* Example: Converts blog_example to BlogExample
143		*
144		* @param string $string String to be converted to camel case
145		* @return string UpperCamelCasedWord
146		*/
147		public static function underscoredToUpperCamelCase($string)
148		{
149		return str_replace(' ', '',
150		ucwords(str_replace('_', ' ', strtolower($string))));
151		}
152
153		/**
154		* Shortcut to retrieve the TypoScript configuration for EXT:solr
155		* (plugin.tx_solr) from TSFE.
156		*
157		* @return TypoScriptConfiguration
158		*/
159		public static function getSolrConfiguration()
160		{
161		$configurationManager = self::getConfigurationManager();
162
163		return $configurationManager->getTypoScriptConfiguration();
164		}
165
166		/**
167		* @return ConfigurationManager
168		*/
169		private static function getConfigurationManager()
170		{
171		/** @var ConfigurationManager $configurationManager */
172		$configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);
173		return $configurationManager;
174		}
175
176		/**
177		* Gets the Solr configuration for a specific root page id.
178		* To be used from the backend.
179		*
180		* @param int $pageId Id of the (root) page to get the Solr configuration from.
181		* @param bool $initializeTsfe Optionally initializes a full TSFE to get the configuration, defaults to FALSE
182		* @param int $language System language uid, optional, defaults to 0
183		* @return TypoScriptConfiguration The Solr configuration for the requested tree.
184		*/
185		public static function getSolrConfigurationFromPageId(
186		$pageId,
187		$initializeTsfe = false,
188		$language = 0
189		) {
190		$rootPath = '';
191		return self::getConfigurationFromPageId($pageId, $rootPath, $initializeTsfe, $language);
192		}
193
194		/**
195		* Loads the TypoScript configuration for a given page id and language.
196		* Language usage may be disabled to get the default TypoScript
197		* configuration.
198		*
199		* @param int $pageId Id of the (root) page to get the Solr configuration from.
200		* @param string $path The TypoScript configuration path to retrieve.
201		* @param bool $initializeTsfe Optionally initializes a full TSFE to get the configuration, defaults to FALSE
202		* @param int $language System language uid, optional, defaults to 0
203		* @param bool $useTwoLevelCache Flag to enable the two level cache for the typoscript configuration array
204		* @return TypoScriptConfiguration The Solr configuration for the requested tree.
205		*/
206		public static function getConfigurationFromPageId(
207	26	$pageId,
208		$path,
209	26	$initializeTsfe = false,
210	26	$language = 0,
211		$useTwoLevelCache = true
212		) {
213		$pageId = self::getConfigurationPageIdToUse($pageId);
214
215		static $configurationObjectCache = [];
216		$cacheId = md5($pageId . '\|' . $path . '\|' . $language);
217		if (isset($configurationObjectCache[$cacheId])) {
218		return $configurationObjectCache[$cacheId];
219	156	}
220
221	156	// If we're on UID 0, we cannot retrieve a configuration currently.
222		// getRootline() below throws an exception (since #typo3-60 )
223	156	// as UID 0 cannot have any parent rootline by design.
224		if ($pageId == 0) {
225		return $configurationObjectCache[$cacheId] = self::buildTypoScriptConfigurationFromArray([], $pageId, $language, $path);
226		}
227
228		if ($useTwoLevelCache) {
229	195	/** @var $cache TwoLevelCache */
230		$cache = GeneralUtility::makeInstance(TwoLevelCache::class, 'tx_solr_configuration');
231		$configurationArray = $cache->get($cacheId);
232	195	}
233	195
234		if (!empty($configurationArray)) {
235		// we have a cache hit and can return it.
236		return $configurationObjectCache[$cacheId] = self::buildTypoScriptConfigurationFromArray($configurationArray, $pageId, $language, $path);
237		}
238
239		// we have nothing in the cache. We need to build the configurationToUse
240		$configurationArray = self::buildConfigurationArray($pageId, $path, $initializeTsfe, $language);
241
242		if ($useTwoLevelCache && isset($cache)) {
243		$cache->set($cacheId, $configurationArray);
244		}
245	63
246		return $configurationObjectCache[$cacheId] = self::buildTypoScriptConfigurationFromArray($configurationArray, $pageId, $language, $path);
247		}
248
249		/**
250	63	* This method retrieves the closest pageId where a configuration is located, when this
251	63	* feature is enabled.
252		*
253		* @param int $pageId
254		* @return int
255		*/
256		protected static function getConfigurationPageIdToUse($pageId)
257		{
258		$extensionConfiguration = GeneralUtility::makeInstance(ExtensionConfiguration::class);
259		if ($extensionConfiguration->getIsUseConfigurationFromClosestTemplateEnabled()) {
260		/** @var $configurationPageResolve ConfigurationPageResolver */
261		$configurationPageResolver = GeneralUtility::makeInstance(ConfigurationPageResolver::class);
262		$pageId = $configurationPageResolver->getClosestPageIdWithActiveTemplate($pageId);
263		return $pageId;
264		}
265		return $pageId;
266	65	}
267
268		/**
269		* Initializes a TSFE, if required and builds an configuration array, containing the solr configuration.
270		*
271		* @param integer $pageId
272		* @param string $path
273	65	* @param boolean $initializeTsfe
274		* @param integer $language
275	65	* @return array
276	65	*/
277	65	protected static function buildConfigurationArray($pageId, $path, $initializeTsfe, $language)
278	57	{
279		if ($initializeTsfe) {
280		self::initializeTsfe($pageId, $language);
281		$configurationToUse = self::getConfigurationFromInitializedTSFE($path);
282		} else {
283		$configurationToUse = self::getConfigurationFromExistingTSFE($pageId, $path, $language);
284	65	}
285	2
286		return is_array($configurationToUse) ? $configurationToUse : [];
287		}
288	64
289		/**
290	64	* Builds the configuration object from a config array and returns it.
291	64	*
292	64	* @param array $configurationToUse
293		* @param int $pageId
294	64	* @param int $languageId
295		* @param string $typoScriptPath
296		* @return TypoScriptConfiguration
297		*/
298		protected static function buildTypoScriptConfigurationFromArray(array $configurationToUse, $pageId, $languageId, $typoScriptPath)
299		{
300	64	$configurationManager = self::getConfigurationManager();
301		return $configurationManager->getTypoScriptConfiguration($configurationToUse, $pageId, $languageId, $typoScriptPath);
302	64	}
303	64
304	64	/**
305		* This function is used to retrieve the configuration from a previous initialized TSFE
306	64	* (see: getConfigurationFromPageId)
307		*
308		* @param string $path
309		* @return mixed
310		*/
311		private static function getConfigurationFromInitializedTSFE($path)
312		{
313		/** @var $tmpl ExtendedTemplateService */
314		$tmpl = GeneralUtility::makeInstance(ExtendedTemplateService::class);
315		$configuration = $tmpl->ext_getSetup($GLOBALS['TSFE']->tmpl->setup, $path);
316	65	$configurationToUse = $configuration[0];
317		return $configurationToUse;
318	65	}
319	65
320		/**
321		* This function is used to retrieve the configuration from an existing TSFE instance
322		* @param $pageId
323		* @param $path
324		* @param $language
325	65	* @return mixed
326		*/
327		private static function getConfigurationFromExistingTSFE($pageId, $path, $language)
328		{
329		if (is_int($language)) {
330		GeneralUtility::_GETset($language, 'L');
331		}
332
333		/** @var $pageSelect PageRepository */
334		$pageSelect = GeneralUtility::makeInstance(PageRepository::class);
335		$rootLine = $pageSelect->getRootLine($pageId);
336
337	64	$initializedTsfe = false;
338		$initializedPageSelect = false;
339	64	if (empty($GLOBALS['TSFE']->sys_page)) {
340	2	if (empty($GLOBALS['TSFE'])) {
341	2	$GLOBALS['TSFE'] = new \stdClass();
342	2	$GLOBALS['TSFE']->tmpl = new \stdClass();
343	64	$GLOBALS['TSFE']->tmpl->rootLine = $rootLine;
344		$GLOBALS['TSFE']->sys_page = $pageSelect;
345		$GLOBALS['TSFE']->id = $pageId;
346	64	$GLOBALS['TSFE']->tx_solr_initTsfe = 1;
347		$initializedTsfe = true;
348		}
349
350		$GLOBALS['TSFE']->sys_page = $pageSelect;
351		$initializedPageSelect = true;
352		}
353		/** @var $tmpl ExtendedTemplateService */
354		$tmpl = GeneralUtility::makeInstance(ExtendedTemplateService::class);
355		$tmpl->tt_track = false; // Do not log time-performance information
356		$tmpl->init();
357		$tmpl->runThroughTemplates($rootLine); // This generates the constants/config + hierarchy info for the template.
358	65	$tmpl->generateConfig();
359
360	65	$getConfigurationFromInitializedTSFEAndWriteToCache = $tmpl->ext_getSetup($tmpl->setup, $path);
361	65	$configurationToUse = $getConfigurationFromInitializedTSFEAndWriteToCache[0];
362
363		if ($initializedPageSelect) {
364		$GLOBALS['TSFE']->sys_page = null;
365		}
366		if ($initializedTsfe) {
367		unset($GLOBALS['TSFE']);
368		}
369		return $configurationToUse;
370		}
371	2
372		/**
373		* Initializes the TSFE for a given page ID and language.
374	2	*
375	2	* @param int $pageId The page id to initialize the TSFE for
376	2	* @param int $language System language uid, optional, defaults to 0
377	2	* @param bool $useCache Use cache to reuse TSFE
378		* @return void
379		*/
380		public static function initializeTsfe(
381		$pageId,
382		$language = 0,
383		$useCache = true
384		) {
385		static $tsfeCache = [];
386
387	64	// resetting, a TSFE instance with data from a different page Id could be set already
388		unset($GLOBALS['TSFE']);
389	64
390	64	$cacheId = $pageId . '\|' . $language;
391	64
392		if (!is_object($GLOBALS['TT'])) {
393		$GLOBALS['TT'] = GeneralUtility::makeInstance(NullTimeTracker::class);
394	64	}
395	64
396		if (!isset($tsfeCache[$cacheId]) \|\| !$useCache) {
397	64	GeneralUtility::_GETset($language, 'L');
398	64
399	64	$GLOBALS['TSFE'] = GeneralUtility::makeInstance(TypoScriptFrontendController::class,
400	54	$GLOBALS['TYPO3_CONF_VARS'], $pageId, 0);
401	54
402	54	// for certain situations we need to trick TSFE into granting us
403	54	// access to the page in any case to make getPageAndRootline() work
404	54	// see http://forge.typo3.org/issues/42122
405	54	$pageRecord = BackendUtility::getRecord('pages', $pageId, 'fe_group');
406	54	$groupListBackup = $GLOBALS['TSFE']->gr_list;
407	54	$GLOBALS['TSFE']->gr_list = $pageRecord['fe_group'];
408	54
409		$GLOBALS['TSFE']->sys_page = GeneralUtility::makeInstance(PageRepository::class);
410	54	$GLOBALS['TSFE']->getPageAndRootline();
411	54
412	54	// restore gr_list
413		$GLOBALS['TSFE']->gr_list = $groupListBackup;
414	64
415	64	$GLOBALS['TSFE']->initTemplate();
416	64	$GLOBALS['TSFE']->forceTemplateParsing = true;
417	64	$GLOBALS['TSFE']->initFEuser();
418	64	$GLOBALS['TSFE']->initUserGroups();
419		// $GLOBALS['TSFE']->getCompressedTCarray(); // seems to cause conflicts sometimes
420	64
421	64	$GLOBALS['TSFE']->no_cache = true;
422		$GLOBALS['TSFE']->tmpl->start($GLOBALS['TSFE']->rootLine);
423	64	$GLOBALS['TSFE']->no_cache = false;
424	54	$GLOBALS['TSFE']->getConfigArray();
425	54
426	64	$GLOBALS['TSFE']->settingLanguage();
427	54	if (!$useCache) {
428	54	$GLOBALS['TSFE']->settingLocale();
429	64	}
430
431		$GLOBALS['TSFE']->newCObj();
432		$GLOBALS['TSFE']->absRefPrefix = self::getAbsRefPrefixFromTSFE($GLOBALS['TSFE']);
433		$GLOBALS['TSFE']->calculateLinkVars();
434
435		if ($useCache) {
436		$tsfeCache[$cacheId] = $GLOBALS['TSFE'];
437		}
438		}
439
440	15	if ($useCache) {
441		$GLOBALS['TSFE'] = $tsfeCache[$cacheId];
442		$GLOBALS['TSFE']->settingLocale();
443		}
444		}
445	15
446		/**
447		* Check if record ($table, $uid) is a workspace record
448	15	*
449		* @param string $table The table the record belongs to
450	15	* @param int $uid The record's uid
451		* @return bool TRUE if the record is in a draft workspace, FALSE if it's a LIVE record
452	15	*/
453	15	public static function isDraftRecord($table, $uid)
454	15	{
455		$isWorkspaceRecord = false;
456	15
457	15	if ((ExtensionManagementUtility::isLoaded('workspaces')) && (BackendUtility::isTableWorkspaceEnabled($table))) {
458		$record = BackendUtility::getRecord($table, $uid, 'pid, t3ver_state');
459	15
460	15	if ($record['pid'] == '-1' \|\| $record['t3ver_state'] > 0) {
461		$isWorkspaceRecord = true;
462		}
463		}
464
465	15	return $isWorkspaceRecord;
466	15	}
467	15
468		/**
469	15	* Checks whether a record is a localization overlay.
470	15	*
471		* @param string $tableName The record's table name
472		* @param array $record The record to check
473	15	* @return bool TRUE if the record is a language overlay, FALSE otherwise
474		*/
475	15	public static function isLocalizedRecord($tableName, array $record)
476	15	{
477	15	$isLocalizedRecord = false;
478	15
479		if (isset($GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'])) {
480		$translationOriginalPointerField = $GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'];
481	15
482	15	if ($record[$translationOriginalPointerField] > 0) {
483	15	$isLocalizedRecord = true;
484	15	}
485		}
486	15
487	15	return $isLocalizedRecord;
488		}
489
490		/**
491	15	* Check if the page type of a page record is allowed
492	15	*
493	15	* @param array $pageRecord The pages database row
494		* @param string $configurationName The name of the configuration to use.
495	15	*
496	15	* @return bool TRUE if the page type is allowed, otherwise FALSE
497	15	*/
498	15	public static function isAllowedPageType(array $pageRecord, $configurationName = 'pages')
499		{
500	15	$isAllowedPageType = false;
501	15	$configurationName = is_null($configurationName) ? 'pages' : $configurationName;
502	15	$allowedPageTypes = self::getAllowedPageTypes($pageRecord['uid'], $configurationName);
503	15
504	15	if (in_array($pageRecord['doktype'], $allowedPageTypes)) {
505		$isAllowedPageType = true;
506		}
507
508		return $isAllowedPageType;
509		}
510
511		/**
512		* Get allowed page types
513		*
514		* @param int $pageId Page ID
515		* @param string $configurationName The name of the configuration to use.
516		*
517		* @return array Allowed page types to compare to a doktype of a page record
518		*/
519		public static function getAllowedPageTypes($pageId, $configurationName = 'pages')
520		{
521		$rootPath = '';
522		$configuration = self::getConfigurationFromPageId($pageId, $rootPath);
523		return $configuration->getIndexQueueAllowedPageTypesArrayByConfigurationName($configurationName);
524		}
525
526		/**
527		* Method to check if a page exists.
528		*
529		* @param int $pageId
530		* @return bool
531		*/
532		public static function pageExists($pageId)
533		{
534		$page = BackendUtility::getRecord('pages', (int)$pageId, 'uid');
535
536		if (!is_array($page) \|\| $page['uid'] != $pageId) {
537		return false;
538		}
539
540		return true;
541		}
542
543		/**
544		* Resolves the configured absRefPrefix to a valid value and resolved if absRefPrefix
545		* is set to "auto".
546		*
547		* @param TypoScriptFrontendController $TSFE
548		* @return string
549		*/
550		public static function getAbsRefPrefixFromTSFE(TypoScriptFrontendController $TSFE)
551		{
552		$absRefPrefix = '';
553		if (empty($TSFE->config['config']['absRefPrefix'])) {
554		return $absRefPrefix;
555		}
556
557		$absRefPrefix = trim($TSFE->config['config']['absRefPrefix']);
558		if ($absRefPrefix === 'auto') {
559		$absRefPrefix = GeneralUtility::getIndpEnv('TYPO3_SITE_PATH');
560		}
561
562		return $absRefPrefix;
563		}
564
565		/**
566		* This function can be used to check if one of the strings in needles is
567		* contained in the haystack.
568		*
569		*
570		* Example:
571		*
572		* haystack: the brown fox
573		* needles: ['hello', 'world']
574		* result: false
575		*
576		* haystack: the brown fox
577		* needles: ['is', 'fox']
578		* result: true
579		*
580	38	* @param string $haystack
581		* @param array $needles
582	38	* @return bool
583		*/
584	38	public static function containsOneOfTheStrings($haystack, array $needles)
585		{
586		foreach ($needles as $needle) {
587		$position = strpos($haystack, $needle);
588		if ($position !== false) {
589		return true;
590		}
591		}
592	38
593		return false;
594		}
595		}
596

TYPO3-Solr / ext-solr

Push — master ( 90cea8...3d6c73 )

Util::buildConfigurationArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like