Updated Spanish translation

[bookstack] / app / Services / SearchService.php

diff --git a/app/Services/SearchService.php b/app/Services/SearchService.php
index ec505af00d87b541d3a80c6346897b559245f3c2..056e1f0772d3bc79f3bc3f788585875805e20e07 100644 (file)
--- a/app/Services/SearchService.php
+++ b/app/Services/SearchService.php
@@ -50,58 +50,147 @@ class SearchService
         $this->permissionService = $permissionService;
     }
 
         $this->permissionService = $permissionService;
     }
 

+    /**
+     * Set the database connection
+     * @param Connection $connection
+     */
+    public function setConnection(Connection $connection)
+    {
+        $this->db = $connection;
+    }
+

     /**
      * Search all entities in the system.
     /**
      * Search all entities in the system.

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

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

-     * @param int $count
+     * @param int $count - Count of each entity to search, Total returned could can be larger and not guaranteed.
+     * @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;
+
+        if ($entityType !== 'all') {
+            $entityTypesToSearch = $entityType;
+        } else if (isset($terms['filters']['type'])) {
+            $entityTypesToSearch = explode('|', $terms['filters']['type']);
+        }
+
+        $results = collect();
+        $total = 0;
+        $hasMore = false;
+
+        foreach ($entityTypesToSearch as $entityType) {
+            if (!in_array($entityType, $entityTypes)) {
+                continue;
+            }
+            $search = $this->searchEntityTable($terms, $entityType, $page, $count);
+            $entityTotal = $this->searchEntityTable($terms, $entityType, $page, $count, true);
+            if ($entityTotal > $page * $count) {
+                $hasMore = true;
+            }
+            $total += $entityTotal;
+            $results = $results->merge($search);
+        }
+
+        return [
+            'total' => $total,
+            'count' => count($results),
+            'has_more' => $hasMore,
+            'results' => $results->sortByDesc('score')->values()
+        ];
+    }
+
+
+    /**
+     * 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('entity_type', '=', 'BookStack\\' . ucfirst($entityType));
+            $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');

-            $entitySelect->join(\DB::raw('(' . $subQuery->toSql() . ') as s'), function(JoinClause $join) {
+            $entitySelect->join(\DB::raw('(' . $subQuery->toSql() . ') as s'), function (JoinClause $join) {

                 $join->on('id', '=', 'entity_id');
             })->selectRaw($entity->getTable().'.*, s.score')->orderBy('score', 'desc');
             $entitySelect->mergeBindings($subQuery);
         }
 
         // Handle exact term matching
                 $join->on('id', '=', 'entity_id');
             })->selectRaw($entity->getTable().'.*, s.score')->orderBy('score', 'desc');
             $entitySelect->mergeBindings($subQuery);
         }
 
         // 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 +200,19 @@ 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 +236,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,9 +246,20 @@ class SearchService
             }
         }
 
             }
         }
 

+        // Parse standard terms

         foreach (explode(' ', trim($searchString)) as $searchTerm) {
         foreach (explode(' ', trim($searchString)) as $searchTerm) {

-            if ($searchTerm !== '') $terms['search'][] = $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;
     }


@@ -184,15 +283,18 @@ class SearchService
      * @param string $tagTerm
      * @return mixed
      */
      * @param string $tagTerm
      * @return mixed
      */

-    protected function applyTagSearch(\Illuminate\Database\Eloquent\Builder $query, $tagTerm) {
+    protected function applyTagSearch(\Illuminate\Database\Eloquent\Builder $query, $tagTerm)
+    {

         preg_match("/^(.*?)((".$this->getRegexEscapedOperators().")(.*?))?$/", $tagTerm, $tagSplit);
         preg_match("/^(.*?)((".$this->getRegexEscapedOperators().")(.*?))?$/", $tagTerm, $tagSplit);

-        $query->whereHas('tags', function(\Illuminate\Database\Eloquent\Builder $query) use ($tagSplit) {
+        $query->whereHas('tags', function (\Illuminate\Database\Eloquent\Builder $query) use ($tagSplit) {

             $tagName = $tagSplit[1];
             $tagOperator = count($tagSplit) > 2 ? $tagSplit[3] : '';
             $tagValue = count($tagSplit) > 3 ? $tagSplit[4] : '';
             $validOperator = in_array($tagOperator, $this->queryOperators);
             if (!empty($tagOperator) && !empty($tagValue) && $validOperator) {
             $tagName = $tagSplit[1];
             $tagOperator = count($tagSplit) > 2 ? $tagSplit[3] : '';
             $tagValue = count($tagSplit) > 3 ? $tagSplit[4] : '';
             $validOperator = in_array($tagOperator, $this->queryOperators);
             if (!empty($tagOperator) && !empty($tagValue) && $validOperator) {

-                if (!empty($tagName)) $query->where('name', '=', $tagName);
+                if (!empty($tagName)) {
+                    $query->where('name', '=', $tagName);
+                }

                 if (is_numeric($tagValue) && $tagOperator !== 'like') {
                     // 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
                 if (is_numeric($tagValue) && $tagOperator !== 'like') {
                     // 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


@@ -226,8 +328,8 @@ class SearchService
     public function indexEntity(Entity $entity)
     {
         $this->deleteEntityTerms($entity);
     public function indexEntity(Entity $entity)
     {
         $this->deleteEntityTerms($entity);

-        $nameTerms = $this->generateTermArrayFromText($entity->name, 5);
-        $bodyTerms = $this->generateTermArrayFromText($entity->getText(), 1);
+        $nameTerms = $this->generateTermArrayFromText($entity->name, 5 * $entity->searchFactor);
+        $bodyTerms = $this->generateTermArrayFromText($entity->getText(), 1 * $entity->searchFactor);

         $terms = array_merge($nameTerms, $bodyTerms);
         foreach ($terms as $index => $term) {
             $terms[$index]['entity_type'] = $entity->getMorphClass();
         $terms = array_merge($nameTerms, $bodyTerms);
         foreach ($terms as $index => $term) {
             $terms[$index]['entity_type'] = $entity->getMorphClass();


@@ -240,11 +342,12 @@ class SearchService
      * Index multiple Entities at once
      * @param Entity[] $entities
      */
      * Index multiple Entities at once
      * @param Entity[] $entities
      */

-    protected function indexEntities($entities) {
+    protected function indexEntities($entities)
+    {

         $terms = [];
         foreach ($entities as $entity) {
         $terms = [];
         foreach ($entities as $entity) {

-            $nameTerms = $this->generateTermArrayFromText($entity->name, 5);
-            $bodyTerms = $this->generateTermArrayFromText($entity->getText(), 1);
+            $nameTerms = $this->generateTermArrayFromText($entity->name, 5 * $entity->searchFactor);
+            $bodyTerms = $this->generateTermArrayFromText($entity->getText(), 1 * $entity->searchFactor);

             foreach (array_merge($nameTerms, $bodyTerms) as $term) {
                 $term['entity_id'] = $entity->id;
                 $term['entity_type'] = $entity->getMorphClass();
             foreach (array_merge($nameTerms, $bodyTerms) as $term) {
                 $term['entity_id'] = $entity->id;
                 $term['entity_type'] = $entity->getMorphClass();


@@ -299,11 +402,15 @@ class SearchService
     protected function generateTermArrayFromText($text, $scoreAdjustment = 1)
     {
         $tokenMap = []; // {TextToken => OccurrenceCount}
     protected function generateTermArrayFromText($text, $scoreAdjustment = 1)
     {
         $tokenMap = []; // {TextToken => OccurrenceCount}

-        $splitText = explode(' ', $text);
-        foreach ($splitText as $token) {
-            if ($token === '') continue;
-            if (!isset($tokenMap[$token])) $tokenMap[$token] = 0;
+        $splitChars = " \n\t.,!?:;()[]{}<>`'\"";
+        $token = strtok($text, $splitChars);
+
+        while ($token !== false) {
+            if (!isset($tokenMap[$token])) {
+                $tokenMap[$token] = 0;
+            }

             $tokenMap[$token]++;
             $tokenMap[$token]++;

+            $token = strtok($splitChars);

         }
 
         $terms = [];
         }
 
         $terms = [];


@@ -325,41 +432,63 @@ class SearchService
 
     protected function filterUpdatedAfter(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
 
     protected function filterUpdatedAfter(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {

-        try { $date = date_create($input);
-        } catch (\Exception $e) {return;}
+        try {
+            $date = date_create($input);
+        } catch (\Exception $e) {
+            return;
+        }

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

-        try { $date = date_create($input);
-        } catch (\Exception $e) {return;}
+        try {
+            $date = date_create($input);
+        } catch (\Exception $e) {
+            return;
+        }

         $query->where('updated_at', '<', $date);
     }
 
     protected function filterCreatedAfter(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
         $query->where('updated_at', '<', $date);
     }
 
     protected function filterCreatedAfter(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {

-        try { $date = date_create($input);
-        } catch (\Exception $e) {return;}
+        try {
+            $date = date_create($input);
+        } catch (\Exception $e) {
+            return;
+        }

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

-        try { $date = date_create($input);
-        } catch (\Exception $e) {return;}
+        try {
+            $date = date_create($input);
+        } catch (\Exception $e) {
+            return;
+        }

         $query->where('created_at', '<', $date);
     }
 
     protected function filterCreatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
         $query->where('created_at', '<', $date);
     }
 
     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);
     }
 


@@ -368,7 +497,10 @@ class SearchService
         $query->where('name', 'like', '%' .$input. '%');
     }
 
         $query->where('name', 'like', '%' .$input. '%');
     }
 

-    protected function filterInTitle(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input) {$this->filterInName($query, $model, $input);}
+    protected function filterInTitle(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+    {
+        $this->filterInName($query, $model, $input);
+    }

 
     protected function filterInBody(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
 
     protected function filterInBody(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {


@@ -382,16 +514,37 @@ class SearchService
 
     protected function filterViewedByMe(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
 
     protected function filterViewedByMe(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {

-        $query->whereHas('views', function($query) {
+        $query->whereHas('views', function ($query) {

             $query->where('user_id', '=', user()->id);
         });
     }
 
     protected function filterNotViewedByMe(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {
             $query->where('user_id', '=', user()->id);
         });
     }
 
     protected function filterNotViewedByMe(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
     {

-        $query->whereDoesntHave('views', function($query) {
+        $query->whereDoesntHave('views', function ($query) {

             $query->where('user_id', '=', user()->id);
         });
     }
 
             $query->where('user_id', '=', user()->id);
         });
     }
 

-}
\ No newline at end of file
+    protected function filterSortBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+    {
+        $functionName = camel_case('sort_by_' . $input);
+        if (method_exists($this, $functionName)) {
+            $this->$functionName($query, $model);
+        }
+    }
+
+
+    /**
+     * Sorting filter options
+     */
+
+    protected function sortByLastCommented(\Illuminate\Database\Eloquent\Builder $query, Entity $model)
+    {
+        $commentsTable = $this->db->getTablePrefix() . 'comments';
+        $morphClass = str_replace('\\', '\\\\', $model->getMorphClass());
+        $commentQuery = $this->db->raw('(SELECT c1.entity_id, c1.entity_type, c1.created_at as last_commented FROM '.$commentsTable.' c1 LEFT JOIN '.$commentsTable.' c2 ON (c1.entity_id = c2.entity_id AND c1.entity_type = c2.entity_type AND c1.created_at < c2.created_at) WHERE c1.entity_type = \''. $morphClass .'\' AND c2.created_at IS NULL) as comments');
+
+        $query->join($commentQuery, $model->getTable() . '.id', '=', 'comments.entity_id')->orderBy('last_commented', 'desc');
+    }
+}