Fixed model extending mis-use

[bookstack] / app / Entity.php

diff --git a/app/Entity.php b/app/Entity.php
index 97500917419cd82bd730b0f9859bfc309bb99be6..6aeb66481dc436ca4654d8acd5c1ed3603d6665e 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

 {
 
 {
 

+    public $textField = '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,33 @@ 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 the related search terms.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function searchTerms()
+    {
+        return $this->morphMany(SearchTerm::class, 'entity');

     }
 
     /**
      * 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 +90,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 +122,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,47 +157,24 @@ 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) . '...';

     }
 
     /**
     }
 
     /**

-     * Perform a full-text search on this entity.
-     * @param string[] $fieldsToSearch
-     * @param string[] $terms
-     * @param string[] array $wheres
+     * Get the body text of this entity.

      * @return mixed
      */
      * @return mixed
      */

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

     {
     {

-        $termString = '';
-        foreach ($terms as $term) {
-            $termString .= htmlentities($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]);
-
-        // Add additional where terms
-        foreach ($wheres as $whereTerm) {
-            $search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
-        }
-
-        // Load in relations
-        if (static::isA('page'))  {
-            $search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
-        } else if (static::isA('chapter')) {
-            $search = $search->with('book');
-        }
-
-        return $search->orderBy('title_relevance', 'desc');
+        return $this->{$this->textField};

     }
 
     /**
     }
 
     /**

-     * Get the url for this item.
+     * Return a generalised, common raw query that can be 'unioned' across entities.

      * @return string
      */
      * @return string
      */

-    abstract public function getUrl();
+    public function entityRawQuery(){return '';}
+

 
 }
 
 }