AOEpeople / crawler

Classes/Hooks/StaticFileCacheCreateUriHook.php

<?php
namespace AOE\Crawler\Hooks;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2016 AOE GmbH <dev@aoe.com>
 *
 *  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 TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;

/**
 * Class StaticFileCacheCreateUriHook
 * @package AOE\Crawler\Hooks
 */
class StaticFileCacheCreateUriHook
{
    /**
     * Initializes the variables before starting the processing.
     *
     * @param array $parameters The parameters used in this hook
     * @param $parent The calling parent object
     * @return void
     */
    public function initialize(array $parameters, $parent)

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

    {
        list($parameters['host'], $parameters['uri']) = $this->fixNonSpeakingUri($parameters['host'], $parameters['uri'], $parameters['TSFE']);
    }

    /**
     * Fixes non speaking URLs.
     *
     * @param string $host
     * @param string $uri
     * @param TypoScriptFrontendController $frontend
     *
     * @return array
     *
     * @throws \Exception
     *
     * TODO: Write Unit test
     */
    protected function fixNonSpeakingUri($host, $uri, TypoScriptFrontendController $frontend)
    {
        $matches = [];

        if ($this->isCrawlerExtensionRunning($frontend) && preg_match('#^/index.php\?&?id=(\d+)(&.*)?$#', $uri, $matches)) {
            $speakingUri = $frontend->cObj->typoLink_URL(['parameter' => $matches[1], 'additionalParams' => $matches[2]]);
            $speakingUriParts = parse_url($speakingUri);
            if (false === $speakingUriParts) {
                throw new \Exception('Could not parse URI: ' . $speakingUri, 1289915976);
            }
            $speakingUrlPath = '/' . ltrim($speakingUriParts['path'], '/');
            // Don't change anything if speaking URL is part of old URI:
            // (it might be the case the using the speaking URL failed)
            if (strpos($uri, $speakingUrlPath) !== 0 || $speakingUrlPath === '/') {
                if (isset($speakingUriParts['host'])) {
                    $host = $speakingUriParts['host'];
                }

                $uri = $speakingUrlPath;
            }
        }

        return [$host, $uri];
    }

    /**
     * Determine whether the crawler extension is running and initiated the current request.
     *
     * @param TypoScriptFrontendController $frontend
     * @return boolean
     *
     * TODO: Write Unit test
     */
    protected function isCrawlerExtensionRunning(TypoScriptFrontendController $frontend)
    {
        return (
            ExtensionManagementUtility::isLoaded('crawler')
            && isset($frontend->applicationData['tx_crawler']['running'])
            && isset($frontend->applicationData['tx_crawler']['parameters']['procInstructions'])
            && $frontend->applicationData['tx_crawler']['running']
        );
    }
}