FEATURE: Respect inherited start- and endtime for pages

Do not index records below tables that extend their start- or endtime to
their subpages are not accessible due to timing now.

Classes/Domain/Index/TcaIndexer/TcaTableService.php

@@ -24,6 +24,8 @@ use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
 use Codappix\SearchCore\Domain\Index\IndexingException;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Core\Utility\RootlineUtility;
+use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
 
 /**
  * Encapsulate logik related to TCA configuration.
@@ -47,15 +49,20 @@ class TcaTableService
      */
     protected $configuration;
 
+    /**
+     * @var RelationResolver
+     */
+    protected $relationResolver;
+
     /**
      * @var \TYPO3\CMS\Core\Log\Logger
      */
     protected $logger;
 
     /**
-     * @var RelationResolver
+     * @var ObjectManagerInterface
      */
-    protected $relationResolver;
+    protected $objectManager;
 
     /**
      * Inject log manager to get concrete logger from it.
@@ -67,6 +74,14 @@ class TcaTableService
         $this->logger = $logManager->getLogger(__CLASS__);
     }
 
+    /**
+     * @param ObjectManagerInterface $objectManager
+     */
+    public function injectObjectManager(ObjectManagerInterface $objectManager)
+    {
+        $this->objectManager = $objectManager;
+    }
+
     /**
      * @param string $tableName
      * @param ConfigurationContainerInterface $configuration
@@ -243,26 +258,31 @@ class TcaTableService
      * Checks whether the given record was blacklisted by root line.
      * This can be configured by typoscript as whole root lines can be black listed.
      *
-     * NOTE: Does not support pages yet. We have to add a switch once we
-     * support them to use uid instead.
-     *
      * @param array &$record
      * @return bool
      */
     protected function isRecordBlacklistedByRootline(array &$record)
     {
         // If no rootline exists, the record is on a unreachable page and therefore blacklisted.
-        $rootline = BackendUtility::BEgetRootLine($record['pid']);
+        if ($record['pid'] == 0) {
+            return false;
+        }
+
+        $rootline = $this->objectManager->get(RootlineUtility::class, $record['pid'])->get();
         if (!isset($rootline[0])) {
             return true;
         }
 
-        // Check configured black list if present.
+        foreach ($rootline as $pageInRootLine) {
-        if ($this->isBlackListedRootLineConfigured()) {
+            // Check configured black list if present.
-            foreach ($rootline as $pageInRootLine) {
+            if ($this->isBlackListedRootLineConfigured() && in_array($pageInRootLine['uid'], $this->getBlackListedRootLine())) {
-                if (in_array($pageInRootLine['uid'], $this->getBlackListedRootLine())) {
+                return true;
-                    return true;
+            }
-                }
+            if ($pageInRootLine['extendToSubpages'] && (
+                ($pageInRootLine['endtime'] > 0 && $pageInRootLine['endtime'] <= time())
+                || ($pageInRootLine['starttime'] > 0 && $pageInRootLine['starttime'] >= time())
+            )) {
+                return true;
             }
         }
 

Tests/Functional/Fixtures/Indexing/PagesIndexer/InheritedTiming.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<dataset>
+    <!-- DISABLED PAGES -->
+    <pages>
+        <uid>2</uid>
+        <pid>1</pid>
+        <title>Some disabled page due to timing</title>
+        <endtime>1502186635</endtime>
+        <extendToSubpages>1</extendToSubpages>
+    </pages>
+    <pages>
+        <uid>3</uid>
+        <pid>2</pid>
+        <title>Some disabled page due to inherited timing</title>
+    </pages>
+    <pages>
+        <uid>4</uid>
+        <pid>1</pid>
+        <title>Some disabled page due to timing</title>
+        <starttime>2147483647</starttime>
+        <extendToSubpages>1</extendToSubpages>
+    </pages>
+    <pages>
+        <uid>5</uid>
+        <pid>4</pid>
+        <title>Some disabled page due to inherited timing</title>
+    </pages>
+    <!-- ENABLED PAGES -->
+    <pages>
+        <uid>6</uid>
+        <pid>1</pid>
+        <title>Some enabled page due to no be below inherited disabled timing</title>
+    </pages>
+</dataset>

Tests/Functional/Indexing/PagesIndexerTest.php

@@ -61,4 +61,33 @@ class PagesIndexerTest extends AbstractFunctionalTestCase
         $this->inject($indexer, 'connection', $connection);
         $indexer->indexAllDocuments();
     }
+
+    /**
+     * @test
+     */
+    public function inheritedTimingIsRespectedDuringIndexing()
+    {
+        $this->importDataSet('Tests/Functional/Fixtures/Indexing/PagesIndexer/InheritedTiming.xml');
+
+        $objectManager = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(ObjectManager::class);
+        $tableName = 'pages';
+
+        $connection = $this->getMockBuilder(Elasticsearch::class)
+            ->setMethods(['addDocuments'])
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $connection->expects($this->once())
+            ->method('addDocuments')
+            ->with(
+                $this->stringContains($tableName),
+                $this->callback(function ($documents) {
+                    return count($documents) === 2;
+                })
+            );
+
+        $indexer = $objectManager->get(IndexerFactory::class)->getIndexer($tableName);
+        $this->inject($indexer, 'connection', $connection);
+        $indexer->indexAllDocuments();
+    }
 }