Fixes #354, Adds the spellchecker option

[bookstack] / app / Entity.php

diff --git a/app/Entity.php b/app/Entity.php
index 97500917419cd82bd730b0f9859bfc309bb99be6..e8deddf0a56f6f861e31ee83523ccac9c47c1bdc 100644 (file)
--- a/app/Entity.php
+++ b/app/Entity.php
@@ -1,9 +1,11 @@
 <?php namespace BookStack;
 
 
 <?php namespace BookStack;
 
 

-abstract class Entity extends Ownable
+class Entity extends Ownable

 {
 
 {
 

+    protected $fieldsToSearch = ['name', 'description'];
+

     /**
      * Compares this entity to another given entity.
      * Matches by comparing class and id.
     /**
      * Compares this entity to another given entity.
      * Matches by comparing class and id.


@@ -43,7 +45,7 @@ abstract class Entity extends Ownable
      */
     public function activity()
     {
      */
     public function activity()
     {

-        return $this->morphMany('BookStack\Activity', 'entity')->orderBy('created_at', 'desc');
+        return $this->morphMany(Activity::class, 'entity')->orderBy('created_at', 'desc');

     }
 
     /**
     }
 
     /**


@@ -51,15 +53,24 @@ abstract class Entity extends Ownable
      */
     public function views()
     {
      */
     public function views()
     {

-        return $this->morphMany('BookStack\View', 'viewable');
+        return $this->morphMany(View::class, 'viewable');
+    }
+
+    /**
+     * Get the Tag models that have been user assigned to this entity.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function tags()
+    {
+        return $this->morphMany(Tag::class, 'entity')->orderBy('order', 'asc');

     }
 
     /**
      * Get this entities restrictions.
      */
     }
 
     /**
      * Get this entities restrictions.
      */

-    public function restrictions()
+    public function permissions()

     {
     {

-        return $this->morphMany('BookStack\Restriction', 'restrictable');
+        return $this->morphMany(EntityPermission::class, 'restrictable');

     }
 
     /**
     }
 
     /**


@@ -70,7 +81,28 @@ abstract class Entity extends Ownable
      */
     public function hasRestriction($role_id, $action)
     {
      */
     public function hasRestriction($role_id, $action)
     {

-        return $this->restrictions->where('role_id', $role_id)->where('action', $action)->count() > 0;
+        return $this->permissions()->where('role_id', '=', $role_id)
+            ->where('action', '=', $action)->count() > 0;
+    }
+
+    /**
+     * Check if this entity has live (active) restrictions in place.
+     * @param $role_id
+     * @param $action
+     * @return bool
+     */
+    public function hasActiveRestriction($role_id, $action)
+    {
+        return $this->getRawAttribute('restricted') && $this->hasRestriction($role_id, $action);
+    }
+
+    /**
+     * Get the entity jointPermissions this is connected to.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function jointPermissions()
+    {
+        return $this->morphMany(JointPermission::class, 'entity');

     }
 
     /**
     }
 
     /**


@@ -81,7 +113,32 @@ abstract class Entity extends Ownable
      */
     public static function isA($type)
     {
      */
     public static function isA($type)
     {

-        return static::getClassName() === strtolower($type);
+        return static::getType() === strtolower($type);
+    }
+
+    /**
+     * Get entity type.
+     * @return mixed
+     */
+    public static function getType()
+    {
+        return strtolower(static::getClassName());
+    }
+
+    /**
+     * Get an instance of an entity of the given type.
+     * @param $type
+     * @return Entity
+     */
+    public static function getEntityInstance($type)
+    {
+        $types = ['Page', 'Book', 'Chapter'];
+        $className = str_replace([' ', '-', '_'], '', ucwords($type));
+        if (!in_array($className, $types)) {
+            return null;
+        }
+
+        return app('BookStack\\' . $className);

     }
 
     /**
     }
 
     /**


@@ -91,8 +148,8 @@ abstract class Entity extends Ownable
      */
     public function getShortName($length = 25)
     {
      */
     public function getShortName($length = 25)
     {

-        if(strlen($this->name) <= $length) return $this->name;
-        return substr($this->name, 0, $length-3) . '...';
+        if (strlen($this->name) <= $length) return $this->name;
+        return substr($this->name, 0, $length - 3) . '...';

     }
 
     /**
     }
 
     /**


@@ -102,16 +159,47 @@ abstract class Entity extends Ownable
      * @param string[] array $wheres
      * @return mixed
      */
      * @param string[] array $wheres
      * @return mixed
      */

-    public static function fullTextSearchQuery($fieldsToSearch, $terms, $wheres = [])
+    public function fullTextSearchQuery($terms, $wheres = [])

     {
     {

-        $termString = '';
-        foreach ($terms as $term) {
-            $termString .= htmlentities($term) . '* ';
+        $exactTerms = [];
+        $fuzzyTerms = [];
+        $search = static::newQuery();
+
+        foreach ($terms as $key => $term) {
+            $term = htmlentities($term, ENT_QUOTES);
+            $term = preg_replace('/[+\-><\(\)~*\"@]+/', ' ', $term);
+            if (preg_match('/&quot;.*?&quot;/', $term) || is_numeric($term)) {
+                $term = str_replace('&quot;', '', $term);
+                $exactTerms[] = '%' . $term . '%';
+            } else {
+                $term = '' . $term . '*';
+                if ($term !== '*') $fuzzyTerms[] = $term;
+            }

         }
         }

-        $fields = implode(',', $fieldsToSearch);
-        $termStringEscaped = \DB::connection()->getPdo()->quote($termString);
-        $search = static::addSelect(\DB::raw('*, MATCH(name) AGAINST('.$termStringEscaped.' IN BOOLEAN MODE) AS title_relevance'));
-        $search = $search->whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
+
+        $isFuzzy = count($exactTerms) === 0 && count($fuzzyTerms) > 0;
+
+
+        // Perform fulltext search if relevant terms exist.
+        if ($isFuzzy) {
+            $termString = implode(' ', $fuzzyTerms);
+            $fields = implode(',', $this->fieldsToSearch);
+            $search = $search->selectRaw('*, MATCH(name) AGAINST(? IN BOOLEAN MODE) AS title_relevance', [$termString]);
+            $search = $search->whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
+        }
+
+        // Ensure at least one exact term matches if in search
+        if (count($exactTerms) > 0) {
+            $search = $search->where(function ($query) use ($exactTerms) {
+                foreach ($exactTerms as $exactTerm) {
+                    foreach ($this->fieldsToSearch as $field) {
+                        $query->orWhere($field, 'like', $exactTerm);
+                    }
+                }
+            });
+        }
+
+        $orderBy = $isFuzzy ? 'title_relevance' : 'updated_at';

 
         // Add additional where terms
         foreach ($wheres as $whereTerm) {
 
         // Add additional where terms
         foreach ($wheres as $whereTerm) {


@@ -119,19 +207,13 @@ abstract class Entity extends Ownable
         }
 
         // Load in relations
         }
 
         // Load in relations

-        if (static::isA('page'))  {
+        if ($this->isA('page')) {

             $search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
             $search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');

-        } else if (static::isA('chapter')) {
+        } else if ($this->isA('chapter')) {

             $search = $search->with('book');
         }
 
             $search = $search->with('book');
         }
 

-        return $search->orderBy('title_relevance', 'desc');
+        return $search->orderBy($orderBy, 'desc');

     }
 
     }
 

-    /**
-     * Get the url for this item.
-     * @return string
-     */
-    abstract public function getUrl();
-

 }
 }