Fixed failing test after drawio default url change

[bookstack] / app / Entities / Tools / SearchRunner.php

diff --git a/app/Entities/Tools/SearchRunner.php b/app/Entities/Tools/SearchRunner.php
index a251fbc4d0cd6e38928cbbd42ab9d3fe2f6b20d6..a0a44f3a553b0bf1791afc08645da769e59e70d8 100644 (file)
--- a/app/Entities/Tools/SearchRunner.php
+++ b/app/Entities/Tools/SearchRunner.php
@@ -5,11 +5,14 @@ namespace BookStack\Entities\Tools;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Auth\User;
 use BookStack\Entities\EntityProvider;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Auth\User;
 use BookStack\Entities\EntityProvider;

+use BookStack\Entities\Models\BookChild;

 use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Models\SearchTerm;
 use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Models\SearchTerm;

+use Illuminate\Database\Connection;

 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;

+use Illuminate\Database\Eloquent\Relations\BelongsTo;

 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;


@@ -54,6 +57,8 @@ class SearchRunner
      * Search all entities in the system.
      * The provided count is for each entity to search,
      * Total returned could be larger and not guaranteed.
      * Search all entities in the system.
      * The provided count is for each entity to search,
      * Total returned could be larger and not guaranteed.

+     *
+     * @return array{total: int, count: int, has_more: bool, results: Entity[]}

      */
     public function searchEntities(SearchOptions $searchOpts, string $entityType = 'all', int $page = 1, int $count = 20, string $action = 'view'): array
     {
      */
     public function searchEntities(SearchOptions $searchOpts, string $entityType = 'all', int $page = 1, int $count = 20, string $action = 'view'): array
     {


@@ -75,9 +80,10 @@ class SearchRunner
                 continue;
             }
 
                 continue;
             }
 

-            $searchQuery = $this->buildQuery($searchOpts, $entityType, $action);
+            $entityModelInstance = $this->entityProvider->get($entityType);
+            $searchQuery = $this->buildQuery($searchOpts, $entityModelInstance, $action);

             $entityTotal = $searchQuery->count();
             $entityTotal = $searchQuery->count();

-            $searchResults = $this->getPageOfDataFromQuery($searchQuery, $page, $count);
+            $searchResults = $this->getPageOfDataFromQuery($searchQuery, $entityModelInstance, $page, $count);

 
             if ($entityTotal > ($page * $count)) {
                 $hasMore = true;
 
             if ($entityTotal > ($page * $count)) {
                 $hasMore = true;


@@ -109,7 +115,9 @@ class SearchRunner
             if (!in_array($entityType, $entityTypes)) {
                 continue;
             }
             if (!in_array($entityType, $entityTypes)) {
                 continue;
             }

-            $search = $this->buildQuery($opts, $entityType)->where('book_id', '=', $bookId)->take(20)->get();
+
+            $entityModelInstance = $this->entityProvider->get($entityType);
+            $search = $this->buildQuery($opts, $entityModelInstance)->where('book_id', '=', $bookId)->take(20)->get();

             $results = $results->merge($search);
         }
 
             $results = $results->merge($search);
         }
 


@@ -122,7 +130,8 @@ class SearchRunner
     public function searchChapter(int $chapterId, string $searchString): Collection
     {
         $opts = SearchOptions::fromString($searchString);
     public function searchChapter(int $chapterId, string $searchString): Collection
     {
         $opts = SearchOptions::fromString($searchString);

-        $pages = $this->buildQuery($opts, 'page')->where('chapter_id', '=', $chapterId)->take(20)->get();
+        $entityModelInstance = $this->entityProvider->get('page');
+        $pages = $this->buildQuery($opts, $entityModelInstance)->where('chapter_id', '=', $chapterId)->take(20)->get();

 
         return $pages->sortByDesc('score');
     }
 
         return $pages->sortByDesc('score');
     }


@@ -130,9 +139,24 @@ class SearchRunner
     /**
      * Get a page of result data from the given query based on the provided page parameters.
      */
     /**
      * Get a page of result data from the given query based on the provided page parameters.
      */

-    protected function getPageOfDataFromQuery(EloquentBuilder $query, int $page = 1, int $count = 20): EloquentCollection
+    protected function getPageOfDataFromQuery(EloquentBuilder $query, Entity $entityModelInstance, int $page = 1, int $count = 20): EloquentCollection

     {
     {

+        $relations = ['tags'];
+
+        if ($entityModelInstance instanceof BookChild) {
+            $relations['book'] = function (BelongsTo $query) {
+                $query->scopes('visible');
+            };
+        }
+
+        if ($entityModelInstance instanceof Page) {
+            $relations['chapter'] = function (BelongsTo $query) {
+                $query->scopes('visible');
+            };
+        }
+

         return $query->clone()
         return $query->clone()

+            ->with(array_filter($relations))

             ->skip(($page - 1) * $count)
             ->take($count)
             ->get();
             ->skip(($page - 1) * $count)
             ->take($count)
             ->get();


@@ -141,25 +165,24 @@ class SearchRunner
     /**
      * Create a search query for an entity.
      */
     /**
      * Create a search query for an entity.
      */

-    protected function buildQuery(SearchOptions $searchOpts, string $entityType = 'page', string $action = 'view'): EloquentBuilder
+    protected function buildQuery(SearchOptions $searchOpts, Entity $entityModelInstance, string $action = 'view'): EloquentBuilder

     {
     {

-        $entity = $this->entityProvider->get($entityType);
-        $entityQuery = $entity->newQuery();
+        $entityQuery = $entityModelInstance->newQuery();

 
 

-        if ($entity instanceof Page) {
-            $entityQuery->select($entity::$listAttributes);
+        if ($entityModelInstance instanceof Page) {
+            $entityQuery->select($entityModelInstance::$listAttributes);

         } else {
             $entityQuery->select(['*']);
         }
 
         // Handle normal search terms
         } else {
             $entityQuery->select(['*']);
         }
 
         // Handle normal search terms

-        $this->applyTermSearch($entityQuery, $searchOpts, $entity);
+        $this->applyTermSearch($entityQuery, $searchOpts, $entityModelInstance);

 
         // Handle exact term matching
         foreach ($searchOpts->exacts as $inputTerm) {
 
         // Handle exact term matching
         foreach ($searchOpts->exacts as $inputTerm) {

-            $entityQuery->where(function (EloquentBuilder $query) use ($inputTerm, $entity) {
+            $entityQuery->where(function (EloquentBuilder $query) use ($inputTerm, $entityModelInstance) {

                 $query->where('name', 'like', '%' . $inputTerm . '%')
                 $query->where('name', 'like', '%' . $inputTerm . '%')

-                    ->orWhere($entity->textField, 'like', '%' . $inputTerm . '%');
+                    ->orWhere($entityModelInstance->textField, 'like', '%' . $inputTerm . '%');

             });
         }
 
             });
         }
 


@@ -172,11 +195,11 @@ class SearchRunner
         foreach ($searchOpts->filters as $filterTerm => $filterValue) {
             $functionName = Str::camel('filter_' . $filterTerm);
             if (method_exists($this, $functionName)) {
         foreach ($searchOpts->filters as $filterTerm => $filterValue) {
             $functionName = Str::camel('filter_' . $filterTerm);
             if (method_exists($this, $functionName)) {

-                $this->$functionName($entityQuery, $entity, $filterValue);
+                $this->$functionName($entityQuery, $entityModelInstance, $filterValue);

             }
         }
 
             }
         }
 

-        return $this->permissionService->enforceEntityRestrictions($entity, $entityQuery, $action);
+        return $this->permissionService->enforceEntityRestrictions($entityModelInstance, $entityQuery, $action);

     }
 
     /**
     }
 
     /**


@@ -217,6 +240,8 @@ class SearchRunner
      * Create a select statement, with prepared bindings, for the given
      * set of scored search terms.
      *
      * Create a select statement, with prepared bindings, for the given
      * set of scored search terms.
      *

+     * @param array<string, float> $scoredTerms
+     *

      * @return array{statement: string, bindings: string[]}
      */
     protected function selectForScoredTerms(array $scoredTerms): array
      * @return array{statement: string, bindings: string[]}
      */
     protected function selectForScoredTerms(array $scoredTerms): array


@@ -238,6 +263,13 @@ class SearchRunner
         ];
     }
 
         ];
     }
 

+    /**
+     * For the terms in the given search options, query their popularity across all
+     * search terms then provide that back as score adjustment multiplier applicable
+     * for their rarity. Returns an array of float multipliers, keyed by term.
+     *
+     * @return array<string, float>
+     */

     protected function getTermAdjustments(SearchOptions $options): array
     {
         if (isset($this->termAdjustmentCache[$options])) {
     protected function getTermAdjustments(SearchOptions $options): array
     {
         if (isset($this->termAdjustmentCache[$options])) {


@@ -281,7 +313,7 @@ class SearchRunner
         if (empty($termCounts)) {
             return [];
         }
         if (empty($termCounts)) {
             return [];
         }

-        
+

         $multipliers = [];
         $max = max(array_values($termCounts));
 
         $multipliers = [];
         $max = max(array_values($termCounts));
 


@@ -325,7 +357,9 @@ class SearchRunner
                     // We have to do a raw sql query for this since otherwise PDO will quote the value and MySQL will
                     // search the value as a string which prevents being able to do number-based operations
                     // on the tag values. We ensure it has a numeric value and then cast it just to be sure.
                     // We have to do a raw sql query for this since otherwise PDO will quote the value and MySQL will
                     // search the value as a string which prevents being able to do number-based operations
                     // on the tag values. We ensure it has a numeric value and then cast it just to be sure.

-                    $tagValue = (float) trim($query->getConnection()->getPdo()->quote($tagValue), "'");
+                    /** @var Connection $connection */
+                    $connection = $query->getConnection();
+                    $tagValue = (float) trim($connection->getPdo()->quote($tagValue), "'");

                     $query->whereRaw("value ${tagOperator} ${tagValue}");
                 } else {
                     $query->where('value', $tagOperator, $tagValue);
                     $query->whereRaw("value ${tagOperator} ${tagValue}");
                 } else {
                     $query->where('value', $tagOperator, $tagValue);