oberstufe-alt/typo3conf/ext/metaseo/Classes/Page/RobotsTxtPage.php

<?php

/*
 *  Copyright notice
 *
 *  (c) 2015 Markus Blaschke <typo3@markus-blaschke.de> (metaseo)
 *  (c) 2013 Markus Blaschke (TEQneers GmbH & Co. KG) <blaschke@teqneers.de> (tq_seo)
 *  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!
 */

namespace Metaseo\Metaseo\Page;

use Metaseo\Metaseo\Utility\GeneralUtility;

/**
 * Robots txt Page
 */
class RobotsTxtPage extends AbstractPage
{

    // ########################################################################
    // Attributes
    // ########################################################################

    /**
     * Content object renderer
     *
     * @var \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
     */
    public $cObj;

    /**
     * TypoScript Setup Seo
     *
     * @var array
     */
    protected $tsSetupSeo = array();

    /**
     * Root page id
     *
     * @var integer
     */
    protected $rootPid;

    /**
     * Language id
     *
     * @var integer
     */
    protected $languageId;

    /**
     * Link to static sitemap
     *
     * @var boolean
     */
    protected $linkToStaticSitemap;

    /**
     * Sitemap language lock
     *
     * @var boolean
     */
    protected $sitemapLanguageLock;

    // ########################################################################
    // Methods
    // ########################################################################

    /**
     * Fetch and build robots.txt
     */
    public function main()
    {
        $ret = '';

        $settings = GeneralUtility::getRootSetting();

        // INIT
        $this->tsSetup = $GLOBALS['TSFE']->tmpl->setup;
        $this->cObj    = $GLOBALS['TSFE']->cObj;
        $this->rootPid = GeneralUtility::getRootPid();

        $this->tsSetupSeo = null;
        if (!empty($this->tsSetup['plugin.']['metaseo.']['robotsTxt.'])) {
            $this->tsSetupSeo = $this->tsSetup['plugin.']['metaseo.']['robotsTxt.'];
        }

        // check if sitemap is enabled in root
        if (!GeneralUtility::getRootSettingValue('is_robotstxt', true)) {
            return true;
        }

        $this->linkToStaticSitemap = GeneralUtility::getRootSettingValue('is_robotstxt_sitemap_static', false);

        // Language lock
        $this->sitemapLanguageLock = GeneralUtility::getRootSettingValue('is_sitemap_language_lock', false);
        $this->languageId          = GeneralUtility::getLanguageId();

        // ###############################
        // Fetch robots.txt content
        // ###############################
        $settings['robotstxt'] = trim($settings['robotstxt']);

        if (!empty($settings['robotstxt'])) {
            // Custom Robots.txt
            $ret .= $settings['robotstxt'];
        } elseif ($this->tsSetupSeo) {
            // Default robots.txt
            $ret .= $this->cObj->cObjGetSingle($this->tsSetupSeo['default'], $this->tsSetupSeo['default.']);
        }

        // ###############################
        // Fetch extra robots.txt content
        // ###############################
        // User additional
        if (!empty($settings['robotstxt_additional'])) {
            $ret .= "\n\n" . $settings['robotstxt_additional'];
        }

        // Setup additional
        if ($this->tsSetupSeo) {
            // Default robots.txt
            $tmp = $this->cObj->cObjGetSingle($this->tsSetupSeo['extra'], $this->tsSetupSeo['extra.']);

            if (!empty($tmp)) {
                $ret .= "\n\n" . $tmp;
            }
        }

        // ###############################
        // Marker
        // ###############################
        if (!empty($this->tsSetupSeo['marker.'])) {
            $ret = $this->applyMarker($ret);
        }

        // Call hook
        GeneralUtility::callHookAndSignal(__CLASS__, 'robotsTxtOutput', $this, $ret);

        return $ret;
    }

    /**
     * Apply marker to robots.txt
     *
     * @param string $robotsTxt Content of robots.txt
     *
     * @return string
     */
    protected function applyMarker($robotsTxt)
    {
        $ret = $robotsTxt;

        $markerList     = array();
        $markerConfList = array();

        foreach ($this->tsSetupSeo['marker.'] as $name => $data) {
            if (strpos($name, '.') === false) {
                $markerConfList[$name] = null;
            }
        }

        if ($this->linkToStaticSitemap) {
            // remove sitemap-marker because we link to static url
            unset($markerConfList['sitemap']);
        }

        // Fetch marker content
        foreach ($markerConfList as $name => $conf) {
            $markerList['%' . $name . '%'] = $this->cObj->cObjGetSingle(
                $this->tsSetupSeo['marker.'][$name],
                $this->tsSetupSeo['marker.'][$name . '.']
            );
        }

        // generate sitemap-static marker
        if ($this->linkToStaticSitemap) {
            if ($this->sitemapLanguageLock) {
                $path = 'uploads/tx_metaseo/sitemap_xml/index-r' . (int)$this->rootPid . '-l'
                    . (int)$this->languageId . '.xml.gz';
            } else {
                $path = 'uploads/tx_metaseo/sitemap_xml/index-r' . (int)$this->rootPid . '.xml.gz';
            }

            $conf = array(
                'parameter' => $path
            );

            $markerList['%sitemap%'] = $this->cObj->typolink_URL($conf);
        }

        // Fix sitemap-marker url (add prefix if needed)
        $markerList['%sitemap%'] = GeneralUtility::fullUrl($markerList['%sitemap%']);

        // Call hook
        GeneralUtility::callHookAndSignal(__CLASS__, 'robotsTxtMarker', $this, $markerList);

        // Apply marker list
        if (!empty($markerList)) {
            $ret = strtr($ret, $markerList);

            return $ret;
        }

        return $ret;
    }
}