LDAP: Added TLS support

[bookstack] / app / Entities / Entity.php

diff --git a/app/Entities/Entity.php b/app/Entities/Entity.php
index 87d679fdbeea60578bb6a7fd9894a5232c04545c..99922bcebe50047c18563da197091d3b9bca1215 100644 (file)
--- a/app/Entities/Entity.php
+++ b/app/Entities/Entity.php
@@ -2,15 +2,42 @@
 
 use BookStack\Actions\Activity;
 use BookStack\Actions\Comment;
 
 use BookStack\Actions\Activity;
 use BookStack\Actions\Comment;

+use BookStack\Actions\Tag;
+use BookStack\Actions\View;

 use BookStack\Auth\Permissions\EntityPermission;
 use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Auth\Permissions\EntityPermission;
 use BookStack\Auth\Permissions\JointPermission;

+use BookStack\Facades\Permissions;

 use BookStack\Ownable;
 use BookStack\Ownable;

-use BookStack\Actions\Tag;
-use BookStack\Actions\View;
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;

 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\Relations\MorphMany;

+use Illuminate\Database\Eloquent\SoftDeletes;

 
 

+/**
+ * Class Entity
+ * The base class for book-like items such as pages, chapters & books.
+ * This is not a database model in itself but extended.
+ *
+ * @property int $id
+ * @property string $name
+ * @property string $slug
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ * @property int $created_by
+ * @property int $updated_by
+ * @property boolean $restricted
+ * @property Collection $tags
+ * @method static Entity|Builder visible()
+ * @method static Entity|Builder hasPermission(string $permission)
+ * @method static Builder withLastView()
+ * @method static Builder withViewCount()
+ *
+ * @package BookStack\Entities
+ */

 class Entity extends Ownable
 {
 class Entity extends Ownable
 {

+    use SoftDeletes;

 
     /**
      * @var string - Name of property where the main text content is found
 
     /**
      * @var string - Name of property where the main text content is found


@@ -23,14 +50,45 @@ class Entity extends Ownable
     public $searchFactor = 1.0;
 
     /**
     public $searchFactor = 1.0;
 
     /**

-     * Get the morph class for this model.
-     * Set here since, due to folder changes, the namespace used
-     * in the database no longer matches the class namespace.
-     * @return string
+     * Get the entities that are visible to the current user.
+     */
+    public function scopeVisible(Builder $query)
+    {
+        return $this->scopeHasPermission($query, 'view');
+    }
+
+    /**
+     * Scope the query to those entities that the current user has the given permission for.
+     */
+    public function scopeHasPermission(Builder $query, string $permission)
+    {
+        return Permissions::restrictEntityQuery($query, $permission);
+    }
+
+    /**
+     * Query scope to get the last view from the current user.

      */
      */

-    public function getMorphClass()
+    public function scopeWithLastView(Builder $query)

     {
     {

-        return 'BookStack\\Entity';
+        $viewedAtQuery = View::query()->select('updated_at')
+            ->whereColumn('viewable_id', '=', $this->getTable() . '.id')
+            ->where('viewable_type', '=', $this->getMorphClass())
+            ->where('user_id', '=', user()->id)
+            ->take(1);
+
+        return $query->addSelect(['last_viewed_at' => $viewedAtQuery]);
+    }
+
+    /**
+     * Query scope to get the total view count of the entities.
+     */
+    public function scopeWithViewCount(Builder $query)
+    {
+        $viewCountQuery = View::query()->selectRaw('SUM(views) as view_count')
+            ->whereColumn('viewable_id', '=', $this->getTable() . '.id')
+            ->where('viewable_type', '=', $this->getMorphClass())->take(1);
+
+        $query->addSelect(['view_count' => $viewCountQuery]);

     }
 
     /**
     }
 
     /**


@@ -70,11 +128,12 @@ class Entity extends Ownable
 
     /**
      * Gets the activity objects for this entity.
 
     /**
      * Gets the activity objects for this entity.

-     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     * @return MorphMany

      */
     public function activity()
     {
      */
     public function activity()
     {

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

     }
 
     /**
     }
 
     /**


@@ -87,7 +146,7 @@ class Entity extends Ownable
 
     /**
      * Get the Tag models that have been user assigned to this entity.
 
     /**
      * Get the Tag models that have been user assigned to this entity.

-     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     * @return MorphMany

      */
     public function tags()
     {
      */
     public function tags()
     {


@@ -107,7 +166,7 @@ class Entity extends Ownable
 
     /**
      * Get the related search terms.
 
     /**
      * Get the related search terms.

-     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     * @return MorphMany

      */
     public function searchTerms()
     {
      */
     public function searchTerms()
     {


@@ -136,20 +195,25 @@ class Entity extends Ownable
 
     /**
      * Get the entity jointPermissions this is connected to.
 
     /**
      * Get the entity jointPermissions this is connected to.

-     * @return \Illuminate\Database\Eloquent\Relations\MorphMany

      */
      */

-    public function jointPermissions()
+    public function jointPermissions(): MorphMany

     {
         return $this->morphMany(JointPermission::class, 'entity');
     }
 
     /**
     {
         return $this->morphMany(JointPermission::class, 'entity');
     }
 
     /**

-     * Allows checking of the exact class, Used to check entity type.
-     * Cleaner method for is_a.
-     * @param $type
-     * @return bool
+     * Get the related delete records for this entity.
+     */
+    public function deletions(): MorphMany
+    {
+        return $this->morphMany(Deletion::class, 'deletable');
+    }
+
+    /**
+     * Check if this instance or class is a certain type of entity.
+     * Examples of $type are 'page', 'book', 'chapter'

      */
      */

-    public static function isA($type)
+    public static function isA(string $type): bool

     {
         return static::getType() === strtolower($type);
     }
     {
         return static::getType() === strtolower($type);
     }


@@ -181,10 +245,8 @@ class Entity extends Ownable
 
     /**
      * Gets a limited-length version of the entities name.
 
     /**
      * Gets a limited-length version of the entities name.

-     * @param int $length
-     * @return string

      */
      */

-    public function getShortName($length = 25)
+    public function getShortName(int $length = 25): string

     {
         if (mb_strlen($this->name) <= $length) {
             return $this->name;
     {
         if (mb_strlen($this->name) <= $length) {
             return $this->name;


@@ -202,12 +264,17 @@ class Entity extends Ownable
     }
 
     /**
     }
 
     /**

-     * Return a generalised, common raw query that can be 'unioned' across entities.
-     * @return string
+     * Get an excerpt of this entity's descriptive content to the specified length.
+     * @param int $length
+     * @return mixed

      */
      */

-    public function entityRawQuery()
+    public function getExcerpt(int $length = 100)

     {
     {

-        return '';
+        $text = $this->getText();
+        if (mb_strlen($text) > $length) {
+            $text = mb_substr($text, 0, $length-3) . '...';
+        }
+        return trim($text);

     }
 
     /**
     }
 
     /**


@@ -219,4 +286,48 @@ class Entity extends Ownable
     {
         return $path;
     }
     {
         return $path;
     }

+
+    /**
+     * Get the parent entity if existing.
+     * This is the "static" parent and does not include dynamic
+     * relations such as shelves to books.
+     */
+    public function getParent(): ?Entity
+    {
+        if ($this->isA('page')) {
+            return $this->chapter_id ? $this->chapter()->withTrashed()->first() : $this->book()->withTrashed()->first();
+        }
+        if ($this->isA('chapter')) {
+            return $this->book()->withTrashed()->first();
+        }
+        return null;
+    }
+
+    /**
+     * Rebuild the permissions for this entity.
+     */
+    public function rebuildPermissions()
+    {
+        /** @noinspection PhpUnhandledExceptionInspection */
+        Permissions::buildJointPermissionsForEntity(clone $this);
+    }
+
+    /**
+     * Index the current entity for search
+     */
+    public function indexForSearch()
+    {
+        $searchService = app()->make(SearchService::class);
+        $searchService->indexEntity(clone $this);
+    }
+
+    /**
+     * Generate and set a new URL slug for this model.
+     */
+    public function refreshSlug(): string
+    {
+        $generator = new SlugGenerator($this);
+        $this->slug = $generator->generate();
+        return $this->slug;
+    }

 }
 }