!!![TASK] Introduce specific EXT:solr exceptions

Existing exceptions are now based on the recently introduced
generic EXT:solr exception.

Additionally based on the new generic EXT:solr exception a further
exception is introduced, allowing more targeted handling of exceptions:
InvalidIndexQueueInitizalizationPostProcessorException

This is a breaking change as the base excepion changed and the new
exception is no longer based on \UnexpectedValueException.

Resolves: #3763

Classes/Access/RootlineElementFormatException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Access;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * Signals a wrong format for the access definition of a page or the content.

Classes/ConnectionManager.php

@@ -20,12 +20,12 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\Exception\UnexpectedTYPO3SiteInitializationException;
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Records\Pages\PagesRepository as PagesRepositoryAtExtSolr;
 use ApacheSolrForTypo3\Solr\System\Solr\Node;
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection;
 use ApacheSolrForTypo3\Solr\System\Util\SiteUtility;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Site\Entity\Site as Typo3Site;
 use TYPO3\CMS\Core\Utility\GeneralUtility;

Classes/ContentObject/Classification.php

@@ -17,7 +17,7 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Index\Classification\Classification as ClassificationItem;
 use ApacheSolrForTypo3\Solr\Domain\Index\Classification\ClassificationService;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Frontend\ContentObject\AbstractContentObject;
 

Classes/Controller/Backend/Search/AbstractModuleController.php

@@ -19,11 +19,11 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\Exception\UnexpectedTYPO3SiteInitializationException;
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use ApacheSolrForTypo3\Solr\System\Mvc\Backend\Service\ModuleDataStorageService;
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection as SolrCoreConnection;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use TYPO3\CMS\Backend\Template\Components\Menu\Menu;
 use TYPO3\CMS\Backend\Template\ModuleTemplate;

Classes/Domain/Index/Queue/GarbageRemover/AbstractStrategy.php

@@ -17,12 +17,12 @@
 
 use ApacheSolrForTypo3\Solr\ConnectionManager;
 use ApacheSolrForTypo3\Solr\Domain\Site\Exception\UnexpectedTYPO3SiteInitializationException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\GarbageCollectorPostProcessor;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
 use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use UnexpectedValueException;
 

Classes/Domain/Index/Queue/QueueInitializationService.php

@@ -20,6 +20,7 @@
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Event\IndexQueue\AfterIndexQueueHasBeenInitializedEvent;
 use ApacheSolrForTypo3\Solr\IndexQueue\Initializer\AbstractInitializer;
+use ApacheSolrForTypo3\Solr\IndexQueue\QueueInitializationServiceAwareInterface;
 use ApacheSolrForTypo3\Solr\IndexQueue\QueueInterface;
 use Doctrine\DBAL\ConnectionException;
 use Doctrine\DBAL\Exception as DBALException;
@@ -42,7 +43,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher = null)
     {
         $this->eventDispatcher = $eventDispatcher ?? GeneralUtility::makeInstance(EventDispatcherInterface::class);
     }
-    
+
     public function setClearQueueOnInitialization(bool $clearQueueOnInitialization): void
     {
         $this->clearQueueOnInitialization = $clearQueueOnInitialization;

Classes/Domain/Index/Queue/UpdateHandler/EventListener/AbstractBaseEventListener.php

@@ -21,8 +21,8 @@
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\EventListener\Events\ProcessingFinishedEventInterface;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\Events\DataUpdateEventInterface;
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\UpdateHandler\GarbageHandler;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
-use InvalidArgumentException;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/Domain/Search/LastSearches/LastSearchesRepository.php

@@ -15,10 +15,9 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\LastSearches;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Records\AbstractRepository;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
-
 use function json_encode;
 
 class LastSearchesRepository extends AbstractRepository

Classes/Domain/Search/Query/ParameterBuilder/Operator.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * The Operator ParameterProvider is responsible to build the solr query parameters

Classes/Domain/Search/ResultSet/Facets/InvalidFacetPackageException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 class InvalidFacetPackageException extends Exception
 {

Classes/Domain/Search/ResultSet/Facets/InvalidFacetParserException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 class InvalidFacetParserException extends Exception
 {

Classes/Domain/Search/ResultSet/Facets/InvalidQueryBuilderException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 class InvalidQueryBuilderException extends Exception
 {

Classes/Domain/Search/ResultSet/Facets/InvalidUrlDecoderException.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 class InvalidUrlDecoderException extends Exception
 {

Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeUrlDecoder.php

@@ -18,7 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\RangeBased\NumericRange;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets\FacetUrlDecoderInterface;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * Parser to build Solr range queries from tx_solr[filter]

Classes/Domain/Search/ResultSet/Facets/RequirementsService.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Domain/Search/ResultSet/Result/Parser/ResultParserRegistry.php

@@ -18,7 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result\Parser;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/Domain/Search/ResultSet/Result/SearchResultBuilder.php

@@ -17,8 +17,8 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Solr\Document\Document;
-use InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Domain/Search/ResultSet/Sorting/Sorting.php

@@ -18,7 +18,7 @@
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Sorting;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * Class Sorting

Classes/Domain/Search/ResultSet/Sorting/SortingHelper.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Sorting;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

Classes/Domain/Site/Exception/InvalidSiteRootPageException.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace ApacheSolrForTypo3\Solr\Domain\Site\Exception;
+
+use ApacheSolrForTypo3\Solr\Exception;
+
+class InvalidSiteRootPageException extends Exception
+{
+}

Classes/Domain/Site/SiteRepository.php

@@ -19,14 +19,14 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\RecordMonitor\Helper\RootPageResolver;
 use ApacheSolrForTypo3\Solr\Domain\Site\Exception\UnexpectedTYPO3SiteInitializationException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\FrontendEnvironment;
 use ApacheSolrForTypo3\Solr\FrontendEnvironment\Tsfe;
 use ApacheSolrForTypo3\Solr\System\Cache\TwoLevelCache;
 use ApacheSolrForTypo3\Solr\System\Configuration\ExtensionConfiguration;
 use ApacheSolrForTypo3\Solr\System\Records\Pages\PagesRepository;
 use ApacheSolrForTypo3\Solr\System\Util\SiteUtility;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use Throwable;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Registry;

Classes/Domain/Variants/IdBuilder.php

@@ -19,8 +19,8 @@
 
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Event\Variants\AfterVariantIdWasBuiltEvent;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Solr\Document\Document;
-use InvalidArgumentException;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/Exception/InvalidArgumentException.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace ApacheSolrForTypo3\Solr\Exception;
+
+use ApacheSolrForTypo3\Solr\Exception;
+
+/**
+ * Exception that is thrown if a given argument is invalid.
+ */
+class InvalidArgumentException extends Exception
+{
+}

Classes/IndexQueue/Exception/IllegalStateException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\IndexQueue\Exception;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 /**
  * Exception that is thrown on indexing process and any potentially unusual state.

Classes/IndexQueue/Exception/IndexingException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\IndexQueue\Exception;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 /**
  * Exception that is thrown on indexing process. Does not matter on which side, TYPO3 or Apache.

Classes/IndexQueue/Item.php

@@ -21,8 +21,8 @@
 use ApacheSolrForTypo3\Solr\Domain\Index\Queue\QueueItemRepository;
 use ApacheSolrForTypo3\Solr\Domain\Site\Site;
 use ApacheSolrForTypo3\Solr\Domain\Site\SiteRepository;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/IndexQueue/NoPidException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\IndexQueue;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 /**
  * This Exception is thrown when the RecordMonitor handles a record without a valid pid.

Classes/NoSolrConnectionFoundException.php

@@ -17,8 +17,6 @@
 
 namespace ApacheSolrForTypo3\Solr;
 
-use Exception;
-
 /**
  * Exception that is thrown when no Solr connection could be found.
  *

Classes/PingFailedException.php

@@ -17,8 +17,6 @@
 
 namespace ApacheSolrForTypo3\Solr;
 
-use Exception;
-
 /**
  * Exception that is thrown when a ping fails
  *

Classes/System/Configuration/TypoScriptConfiguration.php

@@ -16,12 +16,12 @@
 namespace ApacheSolrForTypo3\Solr\System\Configuration;
 
 use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequest;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\IndexQueue\Indexer;
 use ApacheSolrForTypo3\Solr\IndexQueue\Queue;
 use ApacheSolrForTypo3\Solr\IndexQueue\Initializer\Record;
 use ApacheSolrForTypo3\Solr\System\ContentObject\ContentObjectService;
 use ApacheSolrForTypo3\Solr\System\Util\ArrayAccessor;
-use InvalidArgumentException;
 use TYPO3\CMS\Core\Utility\ArrayUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 

Classes/System/Environment/WebRootAllReadyDefinedException.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\System\Environment;
 
-use Exception;
+use ApacheSolrForTypo3\Solr\Exception;
 
 /**
  * Exception that is thrown when a language file is needed, but not available.

Classes/System/Object/AbstractClassRegistry.php

@@ -17,7 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\System\Object;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use stdClass;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;

Classes/System/Records/AbstractRepository.php

@@ -17,8 +17,8 @@
 
 namespace ApacheSolrForTypo3\Solr\System\Records;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use RuntimeException;
 use TYPO3\CMS\Core\Database\Connection;
 use TYPO3\CMS\Core\Database\ConnectionPool;

Classes/System/Records/Pages/PagesRepository.php

@@ -17,11 +17,11 @@
 
 namespace ApacheSolrForTypo3\Solr\System\Records\Pages;
 
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 use ApacheSolrForTypo3\Solr\System\Cache\TwoLevelCache;
 use ApacheSolrForTypo3\Solr\System\Records\AbstractRepository;
 use Doctrine\DBAL\ArrayParameterType;
 use Doctrine\DBAL\Exception as DBALException;
-use InvalidArgumentException;
 use PDO;
 use Throwable;
 use TYPO3\CMS\Backend\Utility\BackendUtility;

Classes/System/Solr/Parser/StopWordParser.php

@@ -15,7 +15,7 @@
 
 namespace ApacheSolrForTypo3\Solr\System\Solr\Parser;
 
-use InvalidArgumentException;
+use ApacheSolrForTypo3\Solr\Exception\InvalidArgumentException;
 
 /**
  * Class to parse the stopwords from a solr response.