Merge pull request #80 from skurfuerst/only-index-live

[FEATURE] allow indexing only live workspace

Author: skurfuerst

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Command/NodeIndexCommandController.php

@@ -92,6 +92,28 @@ class NodeIndexCommandController extends CommandController {
 	 */
 	protected $logger;
 
+	/**
+	 * @Flow\Inject
+	 * @var \TYPO3\Flow\Configuration\ConfigurationManager
+	 */
+	protected $configurationManager;
+
+	/**
+	 * @var array
+	 */
+	protected $settings;
+
+	/**
+	 * Called by the Flow object framework after creating the object and resolving all dependencies.
+	 *
+	 * @param integer $cause Creation cause
+	 */
+	public function initializeObject($cause) {
+		if ($cause === \TYPO3\Flow\Object\ObjectManagerInterface::INITIALIZATIONCAUSE_CREATED) {
+			$this->settings = $this->configurationManager->getConfiguration(\TYPO3\Flow\Configuration\ConfigurationManager::CONFIGURATION_TYPE_SETTINGS, 'TYPO3.TYPO3CR.Search');
+		}
+	}
+
 	/**
 	 * Show the mapping which would be sent to the ElasticSearch server
 	 *
@@ -160,6 +182,10 @@ public function buildCommand($limit = NULL, $update = FALSE, $workspace = NULL)
 		$this->indexedNodes = 0;
 		$this->countedIndexedNodes = 0;
 
+		if ($workspace === NULL && $this->settings['indexAllWorkspaces'] === FALSE) {
+			$workspace = 'live';
+		}
+
 		if ($workspace === NULL) {
 			foreach ($this->workspaceRepository->findAll() as $workspace) {
 				$this->indexWorkspace($workspace->getName());

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Indexer/NodeIndexer.php

@@ -120,6 +120,20 @@ public function getIndex() {
 	public function indexNode(NodeInterface $node, $targetWorkspaceName = NULL) {
 		$contextPath = $node->getContextPath();
 
+		if ($this->settings['indexAllWorkspaces'] === FALSE) {
+			// we are only supposed to index the live workspace.
+			// We need to check the workspace at two occasions; checking the
+			// $targetWorkspaceName and the workspace name of the node's context as fallback
+			if ($targetWorkspaceName !== NULL && $targetWorkspaceName !== 'live') {
+				return;
+			}
+
+			if ($targetWorkspaceName === NULL && $node->getContext()->getWorkspaceName() !== 'live') {
+				return;
+			}
+		}
+
+
 		if ($targetWorkspaceName !== NULL) {
 			$contextPath = str_replace($node->getContext()->getWorkspace()->getName(), $targetWorkspaceName, $contextPath);
 		}
@@ -325,6 +339,12 @@ protected function isFulltextRoot(NodeInterface $node) {
 	 * @return string
 	 */
 	public function removeNode(NodeInterface $node) {
+		if ($this->settings['indexAllWorkspaces'] === FALSE) {
+			if ($node->getContext()->getWorkspaceName() !== 'live') {
+				return;
+			}
+		}
+
 		// TODO: handle deletion from the fulltext index as well
 		$identifier = sha1($node->getContextPath());
 

Configuration/Settings.yaml

@@ -2,6 +2,12 @@ TYPO3:
   TYPO3CR:
     Search:
 
+      # API. If set to FALSE, only index the "live" workspace and not user workspaces.
+      # If you only index the live workspace, Search will not work for your editors in the user workspaces.
+      # Furthermore, if you heavily rely on Search for collecting content, this might be strange for editors to
+      # work with -- as unpublished changes are not indexed right away.
+      indexAllWorkspaces: true
+
       elasticSearch:
 
         # API. name of the ElasticSearch index to use. Will create many indices prefixed by this indexName.