[FEATURE] Add flush errors button to backend module

Author: Markus Günther

Classes/Backend/SolrModule/IndexQueueModuleController.php

@@ -26,7 +26,7 @@
 
 use TYPO3\CMS\Core\Messaging\FlashMessage;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-
+use TYPO3\CMS\Core\Database\DatabaseConnection;
 
 /**
  * Index Queue Module
@@ -67,7 +67,7 @@ public function indexAction() {
 	 * @return void
 	 */
 	public function initializeIndexQueueAction() {
-		$initializedIndexingConfigurations = array();
+		$initializedIndexingConfigurations = [];
 
 		$itemIndexQueue                     = GeneralUtility::makeInstance('Tx_Solr_IndexQueue_Queue');
 		$indexingConfigurationsToInitialize = GeneralUtility::_POST('tx_solr-index-queue-initialization');
@@ -93,7 +93,7 @@ public function initializeIndexQueueAction() {
 			);
 		}
 
-		$messagesForConfigurations = array();
+		$messagesForConfigurations = [];
 		foreach (array_keys($initializedIndexingConfigurations) as $indexingConfigurationName) {
 			$itemCount = $itemIndexQueue->getItemsCountBySite($this->site, $indexingConfigurationName);
 			if (!is_int($itemCount)) {
@@ -113,6 +113,32 @@ public function initializeIndexQueueAction() {
 		$this->forward('index');
 	}
 
+	/**
+	 * Removes all errors in the index queue list. So that the items can be indexed again.
+	 *
+	 * @return void
+	 */
+	public function flushLogErrorsAction() {
+		/** @var DatabaseConnection $database */
+		$database = $GLOBALS['TYPO3_DB'];
+		$flushResult = $database->exec_UPDATEquery('tx_solr_indexqueue_item', 'errors NOT LIKE ""', ['errors' => '']);
+
+		$message = 'All errors has been flushed';
+		$severity = FlashMessage::OK;
+		if (!$flushResult) {
+			$message = 'An error occured while removing the error log in the index queue.';
+			$severity = FlashMessage::ERROR;
+		}
+
+		$this->addFlashMessage(
+			$message,
+			'Index Queue errors',
+			$severity
+		);
+
+		$this->forward('index');
+	}
+
 	/**
 	 * Renders a field to select which indexing configurations to initialize.
 	 *
@@ -142,7 +168,7 @@ protected function getIndexQueueStats() {
 			'pending, erroneous'
 		);
 
-		$stats = array();
+		$stats = [];
 		foreach($indexQueueStats as $row) {
 			if($row['erroneous'] == 1) {
 				$stats['erroneous'] = $row['count'];

Resources/Private/Templates/IndexQueueModule/Index.html

@@ -65,6 +65,11 @@ <h2>Indexing Errors</h2>
 				</tr>
 			</f:for>
 		</table>
+
+		<f:if condition="{indexqueue_errors}">
+			<a href="{f:uri.action(controller:'Administration', arguments:{module:'{module.name}', moduleAction:'flushLogErrors'} )}"
+				class="btn btn-default" >Flush errors</a>
+		</f:if>
 	</div>
 
 	<div class="span4 well stats_container">

ext_tables.php

@@ -118,7 +118,7 @@
 		ApacheSolrForTypo3\Solr\Backend\SolrModule\AdministrationModuleManager::registerModule(
 			'ApacheSolrForTypo3.' . $_EXTKEY,
 			'IndexQueue',
-			array('index,initializeIndexQueue')
+			array('index,initializeIndexQueue,flushLogErrors')
 		);
 
 		ApacheSolrForTypo3\Solr\Backend\SolrModule\AdministrationModuleManager::registerModule(