Themes: Documented public file serving

[bookstack] / app / Uploads / Image.php

diff --git a/app/Uploads/Image.php b/app/Uploads/Image.php
index 6fa5db2a562e703fa0d18aa12b5abb753de0e80b..0a267a64465ff623ae92c001cd68caf4666f38ef 100644 (file)
--- a/app/Uploads/Image.php
+++ b/app/Uploads/Image.php
@@ -1,33 +1,65 @@
-<?php namespace BookStack\Uploads;
+<?php

 
 

-use BookStack\Entities\Page;
-use BookStack\Ownable;
-use Images;
+namespace BookStack\Uploads;

 
 

-class Image extends Ownable
+use BookStack\App\Model;
+use BookStack\Entities\Models\Page;
+use BookStack\Permissions\Models\JointPermission;
+use BookStack\Permissions\PermissionApplicator;
+use BookStack\Users\Models\HasCreatorAndUpdater;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+
+/**
+ * @property int    $id
+ * @property string $name
+ * @property string $url
+ * @property string $path
+ * @property string $type
+ * @property int    $uploaded_to
+ * @property int    $created_by
+ * @property int    $updated_by
+ */
+class Image extends Model

 {
 {

+    use HasFactory;
+    use HasCreatorAndUpdater;

 
     protected $fillable = ['name'];
 
     protected $fillable = ['name'];

+    protected $hidden = [];
+
+    public function jointPermissions(): HasMany
+    {
+        return $this->hasMany(JointPermission::class, 'entity_id', 'uploaded_to')
+            ->where('joint_permissions.entity_type', '=', 'page');
+    }
+
+    /**
+     * Scope the query to just the images visible to the user based upon the
+     * user visibility of the uploaded_to page.
+     */
+    public function scopeVisible(Builder $query): Builder
+    {
+        return app()->make(PermissionApplicator::class)->restrictPageRelationQuery($query, 'images', 'uploaded_to');
+    }

 
     /**
 
     /**

-     * Get a thumbnail for this image.
-     * @param  int $width
-     * @param  int $height
-     * @param bool|false $keepRatio
-     * @return string
+     * Get a thumbnail URL for this image.
+     * Attempts to generate the thumbnail if not already existing.
+     *

      * @throws \Exception
      */
      * @throws \Exception
      */

-    public function getThumb($width, $height, $keepRatio = false)
+    public function getThumb(?int $width, ?int $height, bool $keepRatio = false): ?string

     {
     {

-        return Images::getThumbnail($this, $width, $height, $keepRatio);
+        return app()->make(ImageResizer::class)->resizeToThumbnailUrl($this, $width, $height, $keepRatio, false);

     }
 
     /**
      * Get the page this image has been uploaded to.
      * Only applicable to gallery or drawio image types.
     }
 
     /**
      * Get the page this image has been uploaded to.
      * Only applicable to gallery or drawio image types.

-     * @return Page|null

      */
      */

-    public function getPage()
+    public function getPage(): ?Page

     {
         return $this->belongsTo(Page::class, 'uploaded_to')->first();
     }
     {
         return $this->belongsTo(Page::class, 'uploaded_to')->first();
     }