Fixed model extending mis-use

[bookstack] / app / Services / SearchService.php

diff --git a/app/Services/SearchService.php b/app/Services/SearchService.php
index ec505af00d87b541d3a80c6346897b559245f3c2..a3186e8f4a38ceeb32d741b6803ab4699e621f8e 100644 (file)
--- a/app/Services/SearchService.php
+++ b/app/Services/SearchService.php
@@ -52,43 +52,110 @@ class SearchService
 
     /**
      * Search all entities in the system.
 
     /**
      * Search all entities in the system.

-     * @param $searchString
+     * @param string $searchString

      * @param string $entityType
      * @param int $page
      * @param int $count
      * @param string $entityType
      * @param int $page
      * @param int $count

+     * @return array[int, Collection];
+     */
+    public function searchEntities($searchString, $entityType = 'all', $page = 1, $count = 20)
+    {
+        $terms = $this->parseSearchString($searchString);
+        $entityTypes = array_keys($this->entities);
+        $entityTypesToSearch = $entityTypes;
+        $results = collect();
+
+        if ($entityType !== 'all') {
+            $entityTypesToSearch = $entityType;
+        } else if (isset($terms['filters']['type'])) {
+            $entityTypesToSearch = explode('|', $terms['filters']['type']);
+        }
+
+        $total = 0;
+
+        foreach ($entityTypesToSearch as $entityType) {
+            if (!in_array($entityType, $entityTypes)) continue;
+            $search = $this->searchEntityTable($terms, $entityType, $page, $count);
+            $total += $this->searchEntityTable($terms, $entityType, $page, $count, true);
+            $results = $results->merge($search);
+        }
+
+        return [
+            'total' => $total,
+            'count' => count($results),
+            'results' => $results->sortByDesc('score')
+        ];
+    }
+
+
+    /**
+     * Search a book for entities
+     * @param integer $bookId
+     * @param string $searchString

      * @return Collection
      */
      * @return Collection
      */

-    public function searchEntities($searchString, $entityType = 'all', $page = 0, $count = 20)
+    public function searchBook($bookId, $searchString)

     {
     {

-        // TODO - Check drafts don't show up in results
-       if ($entityType !== 'all') return $this->searchEntityTable($searchString, $entityType, $page, $count);
+        $terms = $this->parseSearchString($searchString);
+        $entityTypes = ['page', 'chapter'];
+        $entityTypesToSearch = isset($terms['filters']['type']) ? explode('|', $terms['filters']['type']) : $entityTypes;
+
+        $results = collect();
+        foreach ($entityTypesToSearch as $entityType) {
+            if (!in_array($entityType, $entityTypes)) continue;
+            $search = $this->buildEntitySearchQuery($terms, $entityType)->where('book_id', '=', $bookId)->take(20)->get();
+            $results = $results->merge($search);
+        }
+        return $results->sortByDesc('score')->take(20);
+    }

 
 

-       $bookSearch = $this->searchEntityTable($searchString, 'book', $page, $count);
-       $chapterSearch = $this->searchEntityTable($searchString, 'chapter', $page, $count);
-       $pageSearch = $this->searchEntityTable($searchString, 'page', $page, $count);
-       return collect($bookSearch)->merge($chapterSearch)->merge($pageSearch)->sortByDesc('score');
+    /**
+     * Search a book for entities
+     * @param integer $chapterId
+     * @param string $searchString
+     * @return Collection
+     */
+    public function searchChapter($chapterId, $searchString)
+    {
+        $terms = $this->parseSearchString($searchString);
+        $pages = $this->buildEntitySearchQuery($terms, 'page')->where('chapter_id', '=', $chapterId)->take(20)->get();
+        return $pages->sortByDesc('score');

     }
 
     /**
      * Search across a particular entity type.
     }
 
     /**
      * Search across a particular entity type.

-     * @param string $searchString
+     * @param array $terms

      * @param string $entityType
      * @param int $page
      * @param int $count
      * @param string $entityType
      * @param int $page
      * @param int $count

-     * @return \Illuminate\Database\Eloquent\Collection|static[]
+     * @param bool $getCount Return the total count of the search
+     * @return \Illuminate\Database\Eloquent\Collection|int|static[]

      */
      */

-    public function searchEntityTable($searchString, $entityType = 'page', $page = 0, $count = 20)
+    public function searchEntityTable($terms, $entityType = 'page', $page = 1, $count = 20, $getCount = false)

     {
     {

-        $searchTerms = $this->parseSearchString($searchString);
+        $query = $this->buildEntitySearchQuery($terms, $entityType);
+        if ($getCount) return $query->count();
+
+        $query = $query->skip(($page-1) * $count)->take($count);
+        return $query->get();
+    }

 
 

+    /**
+     * Create a search query for an entity
+     * @param array $terms
+     * @param string $entityType
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    protected function buildEntitySearchQuery($terms, $entityType = 'page')
+    {

         $entity = $this->getEntity($entityType);
         $entitySelect = $entity->newQuery();
 
         // Handle normal search terms
         $entity = $this->getEntity($entityType);
         $entitySelect = $entity->newQuery();
 
         // Handle normal search terms

-        if (count($searchTerms['search']) > 0) {
+        if (count($terms['search']) > 0) {

             $subQuery = $this->db->table('search_terms')->select('entity_id', 'entity_type', \DB::raw('SUM(score) as score'));
             $subQuery = $this->db->table('search_terms')->select('entity_id', 'entity_type', \DB::raw('SUM(score) as score'));

-            $subQuery->where(function(Builder $query) use ($searchTerms) {
-                foreach ($searchTerms['search'] as $inputTerm) {
+            $subQuery->where(function(Builder $query) use ($terms) {
+                foreach ($terms['search'] as $inputTerm) {

                     $query->orWhere('term', 'like', $inputTerm .'%');
                 }
             })->groupBy('entity_type', 'entity_id');
                     $query->orWhere('term', 'like', $inputTerm .'%');
                 }
             })->groupBy('entity_type', 'entity_id');


@@ -99,9 +166,9 @@ class SearchService
         }
 
         // Handle exact term matching
         }
 
         // Handle exact term matching

-        if (count($searchTerms['exact']) > 0) {
-            $entitySelect->where(function(\Illuminate\Database\Eloquent\Builder $query) use ($searchTerms, $entity) {
-                foreach ($searchTerms['exact'] as $inputTerm) {
+        if (count($terms['exact']) > 0) {
+            $entitySelect->where(function(\Illuminate\Database\Eloquent\Builder $query) use ($terms, $entity) {
+                foreach ($terms['exact'] as $inputTerm) {

                     $query->where(function (\Illuminate\Database\Eloquent\Builder $query) use ($inputTerm, $entity) {
                         $query->where('name', 'like', '%'.$inputTerm .'%')
                             ->orWhere($entity->textField, 'like', '%'.$inputTerm .'%');
                     $query->where(function (\Illuminate\Database\Eloquent\Builder $query) use ($inputTerm, $entity) {
                         $query->where('name', 'like', '%'.$inputTerm .'%')
                             ->orWhere($entity->textField, 'like', '%'.$inputTerm .'%');


@@ -111,21 +178,17 @@ class SearchService
         }
 
         // Handle tag searches
         }
 
         // Handle tag searches

-        foreach ($searchTerms['tags'] as $inputTerm) {
+        foreach ($terms['tags'] as $inputTerm) {

             $this->applyTagSearch($entitySelect, $inputTerm);
         }
 
         // Handle filters
             $this->applyTagSearch($entitySelect, $inputTerm);
         }
 
         // Handle filters

-        foreach ($searchTerms['filters'] as $filterTerm) {
-            $splitTerm = explode(':', $filterTerm);
-            $functionName = camel_case('filter_' . $splitTerm[0]);
-            $param = count($splitTerm) > 1 ? $splitTerm[1] : '';
-            if (method_exists($this, $functionName)) $this->$functionName($entitySelect, $entity, $param);
+        foreach ($terms['filters'] as $filterTerm => $filterValue) {
+            $functionName = camel_case('filter_' . $filterTerm);
+            if (method_exists($this, $functionName)) $this->$functionName($entitySelect, $entity, $filterValue);

         }
 
         }
 

-        $entitySelect->skip($page * $count)->take($count);
-        $query = $this->permissionService->enforceEntityRestrictions($entityType, $entitySelect, 'view');
-        return $query->get();
+        return $this->permissionService->enforceEntityRestrictions($entityType, $entitySelect, 'view');

     }
 
 
     }
 
 


@@ -149,6 +212,7 @@ class SearchService
             'filters' => '/\{(.*?)\}/'
         ];
 
             'filters' => '/\{(.*?)\}/'
         ];
 

+        // Parse special terms

         foreach ($patterns as $termType => $pattern) {
             $matches = [];
             preg_match_all($pattern, $searchString, $matches);
         foreach ($patterns as $termType => $pattern) {
             $matches = [];
             preg_match_all($pattern, $searchString, $matches);


@@ -158,10 +222,19 @@ class SearchService
             }
         }
 
             }
         }
 

+        // Parse standard terms

         foreach (explode(' ', trim($searchString)) as $searchTerm) {
             if ($searchTerm !== '') $terms['search'][] = $searchTerm;
         }
 
         foreach (explode(' ', trim($searchString)) as $searchTerm) {
             if ($searchTerm !== '') $terms['search'][] = $searchTerm;
         }
 

+        // Split filter values out
+        $splitFilters = [];
+        foreach ($terms['filters'] as $filter) {
+            $explodedFilter = explode(':', $filter, 2);
+            $splitFilters[$explodedFilter[0]] = (count($explodedFilter) > 1) ? $explodedFilter[1] : '';
+        }
+        $terms['filters'] = $splitFilters;
+

         return $terms;
     }
 
         return $terms;
     }
 


@@ -353,13 +426,15 @@ class SearchService
 
     protected function filterCreatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
 
     protected function filterCreatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {

-        if (!is_numeric($input)) return;
+        if (!is_numeric($input) && $input !== 'me') return;
+        if ($input === 'me') $input = user()->id;

         $query->where('created_by', '=', $input);
     }
 
     protected function filterUpdatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
         $query->where('created_by', '=', $input);
     }
 
     protected function filterUpdatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {

-        if (!is_numeric($input)) return;
+        if (!is_numeric($input) && $input !== 'me') return;
+        if ($input === 'me') $input = user()->id;

         $query->where('updated_by', '=', $input);
     }
 
         $query->where('updated_by', '=', $input);
     }