[MAINTENANCE] Fix and move Solr classes (#982)

Co-authored-by: Sebastian Meyer <[email protected]>
kitodo · Jul 20, 2023 · e3d09d8 · e3d09d8
1 parent 613ade1
commit e3d09d8
Show file tree

Hide file tree

Showing 21 changed files with 60 additions and 43 deletions.
diff --git a/Classes/Common/Indexer.php b/Classes/Common/Indexer.php
@@ -12,6 +12,7 @@
 
 namespace Kitodo\Dlf\Common;
 
+use Kitodo\Dlf\Common\Solr\Solr;
 use Kitodo\Dlf\Domain\Repository\DocumentRepository;
 use Kitodo\Dlf\Domain\Model\Document;
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
@@ -74,9 +75,9 @@ class Indexer
     protected static $processedDocs = [];
 
     /**
-     * Instance of \Kitodo\Dlf\Common\Solr class
+     * Instance of \Kitodo\Dlf\Common\Solr\Solr class
      *
-     * @var \Kitodo\Dlf\Common\Solr
+     * @var Solr
      * @access protected
      */
     protected static $solr;

diff --git a/...ses/Common/SolrSearchResult/Highlight.php → ...es/Common/Solr/SearchResult/Highlight.php b/...ses/Common/SolrSearchResult/Highlight.php → ...es/Common/Solr/SearchResult/Highlight.php
@@ -10,7 +10,7 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\Dlf\Common\SolrSearchResult;
+namespace Kitodo\Dlf\Common\Solr\SearchResult;
 
 /**
  * Highlight class for the 'dlf' extension. It keeps highlight for found search phrase.

diff --git a/Classes/Common/SolrSearchResult/Page.php → Classes/Common/Solr/SearchResult/Page.php b/Classes/Common/SolrSearchResult/Page.php → Classes/Common/Solr/SearchResult/Page.php
@@ -10,7 +10,7 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\Dlf\Common\SolrSearchResult;
+namespace Kitodo\Dlf\Common\Solr\SearchResult;
 
 /**
  * Page class for the 'dlf' extension. It keeps page in which search phrase was found.

diff --git a/Classes/Common/SolrSearchResult/Region.php → Classes/Common/Solr/SearchResult/Region.php b/Classes/Common/SolrSearchResult/Region.php → Classes/Common/Solr/SearchResult/Region.php
@@ -10,7 +10,7 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\Dlf\Common\SolrSearchResult;
+namespace Kitodo\Dlf\Common\Solr\SearchResult;
 
 /**
  * Region class for the 'dlf' extension. It keeps region in which search phrase was found.

diff --git a/...ommon/SolrSearchResult/ResultDocument.php → ...mmon/Solr/SearchResult/ResultDocument.php b/...ommon/SolrSearchResult/ResultDocument.php → ...mmon/Solr/SearchResult/ResultDocument.php
@@ -10,11 +10,7 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\Dlf\Common\SolrSearchResult;
-
-use Kitodo\Dlf\Common\SolrSearchResult\Highlight;
-use Kitodo\Dlf\Common\SolrSearchResult\Page;
-use Kitodo\Dlf\Common\SolrSearchResult\Region;
+namespace Kitodo\Dlf\Common\Solr\SearchResult;
 
 /**
  * ResultDocument class for the 'dlf' extension. It keeps the result of the search in the SOLR index.
@@ -202,7 +198,7 @@ public function getSnippets()
     }
 
     /**
-     * Get the thumnail URL
+     * Get the thumbnail URL
      *
      * @access public
      *

diff --git a/Classes/Common/Solr.php → Classes/Common/Solr/Solr.php b/Classes/Common/Solr.php → Classes/Common/Solr/Solr.php
@@ -10,8 +10,9 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\Dlf\Common;
+namespace Kitodo\Dlf\Common\Solr;
 
+use Kitodo\Dlf\Common\Helper;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use TYPO3\CMS\Core\Cache\CacheManager;
@@ -115,7 +116,7 @@ class Solr implements LoggerAwareInterface
     /**
      * This holds the singleton search objects with their core as array key
      *
-     * @var array (\Kitodo\Dlf\Common\Solr)
+     * @var array (\Kitodo\Dlf\Common\Solr\Solr)
      * @access protected
      */
     protected static $registry = [];
@@ -187,8 +188,7 @@ public static function createCore($core = '')
      */
     public static function escapeQuery($query)
     {
-        $helper = GeneralUtility::makeInstance(\Solarium\Core\Query\Helper::class);
-        // Escape query by dissallowing range and field operators
+        // Escape query by disallowing range and field operators
         // Permit operators: wildcard, boolean, fuzzy, proximity, boost, grouping
         // https://solr.apache.org/guide/solr/latest/query-guide/standard-query-parser.html
         return preg_replace('/(\{|}|\[|]|:|\/|\\\)/', '\\\$1', $query);
@@ -298,7 +298,7 @@ public static function getFields()
      *
      * @param mixed $core: Name or UID of the core to load or null to get core admin endpoint
      *
-     * @return \Kitodo\Dlf\Common\Solr Instance of this class
+     * @return \Kitodo\Dlf\Common\Solr\Solr Instance of this class
      */
     public static function getInstance($core = null)
     {

diff --git a/Classes/Common/SolrSearch.php → Classes/Common/Solr/SolrSearch.php b/Classes/Common/SolrSearch.php → Classes/Common/Solr/SolrSearch.php
@@ -1,9 +1,11 @@
 <?php
 
-namespace Kitodo\Dlf\Common;
+namespace Kitodo\Dlf\Common\Solr;
 
-use Kitodo\Dlf\Common\SolrSearchResult\ResultDocument;
+use Kitodo\Dlf\Common\Solr\SearchResult\ResultDocument;
+use Kitodo\Dlf\Common\Doc;
 use Kitodo\Dlf\Common\Helper;
+use Kitodo\Dlf\Common\Indexer;
 use Kitodo\Dlf\Domain\Model\Collection;
 use Kitodo\Dlf\Domain\Repository\DocumentRepository;
 use TYPO3\CMS\Core\Cache\CacheManager;
@@ -276,24 +278,24 @@ public function prepare()
             $virtualCollectionsQueryString = '';
             foreach ($this->collection as $collectionEntry) {
                 // check for virtual collections query string
-                if($collectionEntry->getIndexSearch()) {
+                if ($collectionEntry->getIndexSearch()) {
                     $virtualCollectionsQueryString .= empty($virtualCollectionsQueryString) ? '(' . $collectionEntry->getIndexSearch() . ')' : ' OR ('. $collectionEntry->getIndexSearch() . ')' ;
                 } else {
                     $collectionsQueryString .= empty($collectionsQueryString) ? '"' . $collectionEntry->getIndexName() . '"' : ' OR "' . $collectionEntry->getIndexName() . '"';
                 }
             }
-            
+
             // distinguish between simple collection browsing and actual searching within the collection(s)
-            if(!empty($collectionsQueryString)) {
-                if(empty($query)) {
+            if (!empty($collectionsQueryString)) {
+                if (empty($query)) {
                     $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . ') AND toplevel:true AND partof:0)';
                 } else {
                     $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . '))';
                 }
             }
 
             // virtual collections might query documents that are neither toplevel:true nor partof:0 and need to be searched separatly
-            if(!empty($virtualCollectionsQueryString)) {
+            if (!empty($virtualCollectionsQueryString)) {
                 $virtualCollectionsQueryString = '(' . $virtualCollectionsQueryString . ')';
             }
 
@@ -372,9 +374,9 @@ public function submit($start, $rows, $processResults = true)
                 }
                 if ($documents[$doc['uid']]) {
                     // translate language code if applicable
-                    if($doc['metadata']['language']) {
-                        foreach($doc['metadata']['language'] as $indexName => $language) {
-                            $doc['metadata']['language'][$indexName] = Helper::getLanguageName($doc['metadata']['language'][$indexName]);
+                    if ($doc['metadata']['language']) {
+                        foreach ($doc['metadata']['language'] as $indexName => $language) {
+                            $doc['metadata']['language'][$indexName] = Helper::getLanguageName($language);
                         }
                     }
                     if ($doc['toplevel'] === false) {
@@ -558,7 +560,7 @@ protected function searchSolr($parameters = [], $enableCache = true)
             // Perform search for all documents with the same uid that either fit to the search or marked as toplevel.
             $response = $solr->service->executeRequest($solrRequest);
             // return empty resultSet on error-response
-            if ($response->getStatusCode() == "400") {
+            if ($response->getStatusCode() == 400) {
                 return $resultSet;
             }
             $result = $solr->service->createResult($selectQuery, $response);

diff --git a/Classes/Common/SolrSearchQuery.php → Classes/Common/Solr/SolrSearchQuery.php b/Classes/Common/SolrSearchQuery.php → Classes/Common/Solr/SolrSearchQuery.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Kitodo\Dlf\Common;
+namespace Kitodo\Dlf\Common\Solr;
 
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 use TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface;
@@ -12,6 +12,24 @@
  */
 class SolrSearchQuery implements QueryInterface
 {
+    /**
+     * @var SolrSearch
+     * @access private
+     */
+    private $solrSearch;
+
+    /**
+     * @var int
+     * @access private
+     */
+    private $limit;
+
+    /**
+     * @var int
+     * @access private
+     */
+    private $offset;
+
     public function __construct($solrSearch)
     {
         $this->solrSearch = $solrSearch;

diff --git a/Classes/Controller/Backend/NewTenantController.php b/Classes/Controller/Backend/NewTenantController.php
@@ -11,7 +11,7 @@
 
 namespace Kitodo\Dlf\Controller\Backend;
 
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Kitodo\Dlf\Controller\AbstractController;
 use Kitodo\Dlf\Domain\Model\Format;
 use Kitodo\Dlf\Domain\Model\Metadata;

diff --git a/Classes/Controller/CollectionController.php b/Classes/Controller/CollectionController.php
@@ -11,7 +11,7 @@
 
 namespace Kitodo\Dlf\Controller;
 
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\MathUtility;
 use Kitodo\Dlf\Domain\Repository\CollectionRepository;

diff --git a/Classes/Controller/OaiPmhController.php b/Classes/Controller/OaiPmhController.php
@@ -12,7 +12,7 @@
 namespace Kitodo\Dlf\Controller;
 
 use TYPO3\CMS\Core\Utility\GeneralUtility;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Kitodo\Dlf\Domain\Model\Token;
 use Kitodo\Dlf\Domain\Repository\CollectionRepository;
 use Kitodo\Dlf\Domain\Repository\LibraryRepository;

diff --git a/Classes/Controller/SearchController.php b/Classes/Controller/SearchController.php
@@ -14,7 +14,7 @@
 
 use Kitodo\Dlf\Common\Helper;
 use Kitodo\Dlf\Common\Indexer;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use TYPO3\CMS\Core\Core\Environment;
 use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
@@ -326,7 +326,7 @@ public function makeFacetsMenuArray($facets)
         $solrRequest = $solr->service->createRequest($selectQuery);
         $response = $solr->service->executeRequest($solrRequest);
         // return empty facet on solr error
-        if ($response->getStatusCode() == "400") {
+        if ($response->getStatusCode() == 400) {
             return [];
         }
         $results = $solr->service->select($selectQuery);

diff --git a/Classes/Domain/Repository/DocumentRepository.php b/Classes/Domain/Repository/DocumentRepository.php
@@ -14,7 +14,7 @@
 
 use Kitodo\Dlf\Common\Doc;
 use Kitodo\Dlf\Common\Helper;
-use Kitodo\Dlf\Common\SolrSearch;
+use Kitodo\Dlf\Common\Solr\SolrSearch;
 use Kitodo\Dlf\Domain\Model\Collection;
 use Kitodo\Dlf\Domain\Model\Document;
 use TYPO3\CMS\Core\Database\ConnectionPool;

diff --git a/Classes/Eid/SearchInDocument.php b/Classes/Eid/SearchInDocument.php
@@ -13,8 +13,8 @@
 namespace Kitodo\Dlf\Eid;
 
 use Kitodo\Dlf\Common\Helper;
-use Kitodo\Dlf\Common\Solr;
-use Kitodo\Dlf\Common\SolrSearchResult\ResultDocument;
+use Kitodo\Dlf\Common\Solr\Solr;
+use Kitodo\Dlf\Common\Solr\SearchResult\ResultDocument;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use TYPO3\CMS\Core\Http\Response;

diff --git a/Classes/Eid/SearchSuggest.php b/Classes/Eid/SearchSuggest.php
@@ -12,7 +12,7 @@
 
 namespace Kitodo\Dlf\Eid;
 
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use TYPO3\CMS\Core\Core\Environment;

diff --git a/Classes/Hooks/ConfigurationForm.php b/Classes/Hooks/ConfigurationForm.php
@@ -13,7 +13,7 @@
 namespace Kitodo\Dlf\Hooks;
 
 use Kitodo\Dlf\Common\Helper;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use TYPO3\CMS\Core\Core\Bootstrap;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Localization\LanguageService;

diff --git a/Classes/Hooks/DataHandler.php b/Classes/Hooks/DataHandler.php
@@ -15,7 +15,7 @@
 use Kitodo\Dlf\Common\Doc;
 use Kitodo\Dlf\Common\Helper;
 use Kitodo\Dlf\Common\Indexer;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Kitodo\Dlf\Domain\Repository\DocumentRepository;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;

diff --git a/Classes/Hooks/Form/FieldInformation/SolrCoreStatus.php b/Classes/Hooks/Form/FieldInformation/SolrCoreStatus.php
@@ -13,7 +13,7 @@
 namespace Kitodo\Dlf\Hooks\Form\FieldInformation;
 
 use Kitodo\Dlf\Common\Helper;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use TYPO3\CMS\Backend\Form\AbstractNode;
 
 /**

diff --git a/Tests/Functional/Api/OaiPmhTest.php b/Tests/Functional/Api/OaiPmhTest.php
@@ -4,7 +4,7 @@
 
 use DateTime;
 use GuzzleHttp\Client as HttpClient;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Kitodo\Dlf\Domain\Repository\SolrCoreRepository;
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use Phpoaipmh\Endpoint;

diff --git a/Tests/Functional/Common/SolrIndexingTest.php b/Tests/Functional/Common/SolrIndexingTest.php
@@ -4,7 +4,7 @@
 
 use Kitodo\Dlf\Common\Doc;
 use Kitodo\Dlf\Common\Indexer;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Kitodo\Dlf\Domain\Model\Collection;
 use Kitodo\Dlf\Domain\Model\SolrCore;
 use Kitodo\Dlf\Domain\Repository\CollectionRepository;

diff --git a/Tests/Functional/FunctionalTestCase.php b/Tests/Functional/FunctionalTestCase.php
@@ -3,7 +3,7 @@
 namespace Kitodo\Dlf\Tests\Functional;
 
 use GuzzleHttp\Client as HttpClient;
-use Kitodo\Dlf\Common\Solr;
+use Kitodo\Dlf\Common\Solr\Solr;
 use Symfony\Component\Yaml\Yaml;
 use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Utility\ArrayUtility;