first commit

Classes/Domain/Site/SiteHashService.php

@@ -0,0 +1,141 @@
+<?php
+
+namespace WapplerSystems\Meilisearch\Domain\Site;
+
+/***************************************************************
+ *  Copyright notice
+ *
+ *  (c) 2017- Timo Hund <timo.hund@dkd.de>
+ *  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\GeneralUtility;
+
+/**
+ * SiteHashService
+ *
+ * Responsible to provide sitehash related service methods.
+ *
+ * @author Timo Hund <timo.hund@dkd.de>
+ */
+class SiteHashService
+{
+
+    /**
+     * Resolves magic keywords in allowed sites configuration.
+     * Supported keywords:
+     *   __solr_current_site - The domain of the site the query has been started from
+     *   __current_site - Same as __solr_current_site
+     *   __all - Adds all domains as allowed sites
+     *   * - Means all sites are allowed, same as no siteHash
+     *
+     * @param integer $pageId A page ID that is then resolved to the site it belongs to
+     * @param string $allowedSitesConfiguration TypoScript setting for allowed sites
+     * @return string List of allowed sites/domains, magic keywords resolved
+     */
+    public function getAllowedSitesForPageIdAndAllowedSitesConfiguration($pageId, $allowedSitesConfiguration)
+    {
+        if ($allowedSitesConfiguration === '__all') {
+            return  $this->getDomainListOfAllSites();
+        } elseif ($allowedSitesConfiguration === '*') {
+            return '*';
+        } else {
+            // we thread empty allowed site configurations as __solr_current_site since this is the default behaviour
+            $allowedSitesConfiguration = empty($allowedSitesConfiguration) ? '__solr_current_site' : $allowedSitesConfiguration;
+            return $this->getDomainByPageIdAndReplaceMarkers($pageId, $allowedSitesConfiguration);
+        }
+    }
+
+    /**
+     * Gets the site hash for a domain
+     *
+     * @param string $domain Domain to calculate the site hash for.
+     * @return string site hash for $domain
+     */
+    public function getSiteHashForDomain($domain)
+    {
+        static $siteHashes = [];
+        if (isset($siteHashes[$domain])) {
+            return $siteHashes[$domain];
+        }
+
+        $siteHashes[$domain] = sha1($domain . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . 'tx_meilisearch');
+        return $siteHashes[$domain];
+    }
+
+
+    /**
+     * Returns a comma separated list of all domains from all sites.
+     *
+     * @return string
+     */
+    protected function getDomainListOfAllSites()
+    {
+        $sites = $this->getAvailableSites();
+        $domains = [];
+        foreach ($sites as $site) {
+            $domains[] = $site->getDomain();
+        }
+
+        $allowedSites = implode(',', $domains);
+        return $allowedSites;
+    }
+
+    /**
+     * Retrieves the domain of the site that belongs to the passed pageId and replaces their markers __solr_current_site
+     * and __current_site.
+     *
+     * @param integer $pageId
+     * @param string $allowedSitesConfiguration
+     * @return string
+     */
+    protected function getDomainByPageIdAndReplaceMarkers($pageId, $allowedSitesConfiguration)
+    {
+        $domainOfPage = $this->getSiteByPageId($pageId)->getDomain();
+        $allowedSites = str_replace(['__solr_current_site', '__current_site'], $domainOfPage, $allowedSitesConfiguration);
+        return (string)$allowedSites;
+    }
+
+    /**
+     * @return Site[]
+     */
+    protected function getAvailableSites()
+    {
+        return $this->getSiteRepository()->getAvailableSites();
+    }
+
+    /**
+     * @param $pageId
+     * @return SiteInterface
+     */
+    protected function getSiteByPageId($pageId)
+    {
+        return $this->getSiteRepository()->getSiteByPageId($pageId);
+    }
+
+    /**
+     * Get a reference to SiteRepository
+     *
+     * @return SiteRepository
+     */
+    protected function getSiteRepository()
+    {
+        return GeneralUtility::makeInstance(SiteRepository::class);
+    }
+}