2021-06-26 15:23:15 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Uploads;
|
2018-09-25 11:30:50 +00:00
|
|
|
|
2021-10-18 16:46:55 +00:00
|
|
|
use BookStack\Auth\Permissions\PermissionService;
|
2021-10-19 23:58:56 +00:00
|
|
|
use BookStack\Auth\User;
|
2021-10-18 16:46:55 +00:00
|
|
|
use BookStack\Entities\Models\Entity;
|
2020-11-22 00:17:45 +00:00
|
|
|
use BookStack\Entities\Models\Page;
|
2020-12-30 18:25:35 +00:00
|
|
|
use BookStack\Model;
|
|
|
|
use BookStack\Traits\HasCreatorAndUpdater;
|
2021-10-18 16:46:55 +00:00
|
|
|
use Illuminate\Database\Eloquent\Builder;
|
2021-06-13 13:16:09 +00:00
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
2016-10-09 17:58:22 +00:00
|
|
|
|
2020-09-13 17:29:48 +00:00
|
|
|
/**
|
2021-10-18 16:46:55 +00:00
|
|
|
* @property int $id
|
|
|
|
* @property string $name
|
|
|
|
* @property string $path
|
|
|
|
* @property string $extension
|
|
|
|
* @property ?Page $page
|
|
|
|
* @property bool $external
|
|
|
|
* @property int $uploaded_to
|
2021-10-19 23:58:56 +00:00
|
|
|
* @property User $updatedBy
|
|
|
|
* @property User $createdBy
|
2021-10-18 16:46:55 +00:00
|
|
|
*
|
|
|
|
* @method static Entity|Builder visible()
|
2020-09-13 17:29:48 +00:00
|
|
|
*/
|
2020-12-30 18:25:35 +00:00
|
|
|
class Attachment extends Model
|
2016-10-09 17:58:22 +00:00
|
|
|
{
|
2020-12-30 18:25:35 +00:00
|
|
|
use HasCreatorAndUpdater;
|
|
|
|
|
2016-10-09 17:58:22 +00:00
|
|
|
protected $fillable = ['name', 'order'];
|
2021-10-19 23:58:56 +00:00
|
|
|
protected $hidden = ['path'];
|
|
|
|
protected $casts = [
|
|
|
|
'external' => 'bool',
|
|
|
|
];
|
2016-10-09 17:58:22 +00:00
|
|
|
|
2016-10-23 12:36:45 +00:00
|
|
|
/**
|
|
|
|
* Get the downloadable file name for this upload.
|
2021-06-26 15:23:15 +00:00
|
|
|
*
|
2016-10-23 12:36:45 +00:00
|
|
|
* @return mixed|string
|
|
|
|
*/
|
|
|
|
public function getFileName()
|
|
|
|
{
|
2019-09-13 22:58:40 +00:00
|
|
|
if (strpos($this->name, '.') !== false) {
|
2018-01-28 16:58:52 +00:00
|
|
|
return $this->name;
|
|
|
|
}
|
2021-06-26 15:23:15 +00:00
|
|
|
|
2016-10-23 12:36:45 +00:00
|
|
|
return $this->name . '.' . $this->extension;
|
|
|
|
}
|
|
|
|
|
2016-10-09 17:58:22 +00:00
|
|
|
/**
|
|
|
|
* Get the page this file was uploaded to.
|
|
|
|
*/
|
2021-06-13 13:16:09 +00:00
|
|
|
public function page(): BelongsTo
|
2016-10-09 17:58:22 +00:00
|
|
|
{
|
|
|
|
return $this->belongsTo(Page::class, 'uploaded_to');
|
|
|
|
}
|
|
|
|
|
2016-10-10 19:30:27 +00:00
|
|
|
/**
|
|
|
|
* Get the url of this file.
|
|
|
|
*/
|
2021-06-06 12:55:56 +00:00
|
|
|
public function getUrl($openInline = false): string
|
2016-10-10 19:30:27 +00:00
|
|
|
{
|
2018-05-20 10:06:10 +00:00
|
|
|
if ($this->external && strpos($this->path, 'http') !== 0) {
|
|
|
|
return $this->path;
|
|
|
|
}
|
2021-06-26 15:23:15 +00:00
|
|
|
|
2021-06-06 12:55:56 +00:00
|
|
|
return url('/attachments/' . $this->id . ($openInline ? '?open=true' : ''));
|
2016-10-10 19:30:27 +00:00
|
|
|
}
|
2020-07-28 09:45:28 +00:00
|
|
|
|
2020-09-13 17:29:48 +00:00
|
|
|
/**
|
|
|
|
* Generate a HTML link to this attachment.
|
|
|
|
*/
|
2020-07-28 09:45:28 +00:00
|
|
|
public function htmlLink(): string
|
|
|
|
{
|
2021-06-26 15:23:15 +00:00
|
|
|
return '<a target="_blank" href="' . e($this->getUrl()) . '">' . e($this->name) . '</a>';
|
2020-07-28 09:45:28 +00:00
|
|
|
}
|
|
|
|
|
2020-09-13 17:29:48 +00:00
|
|
|
/**
|
|
|
|
* Generate a markdown link to this attachment.
|
|
|
|
*/
|
2020-07-28 09:45:28 +00:00
|
|
|
public function markdownLink(): string
|
|
|
|
{
|
2021-06-26 15:23:15 +00:00
|
|
|
return '[' . $this->name . '](' . $this->getUrl() . ')';
|
2020-07-28 09:45:28 +00:00
|
|
|
}
|
2021-10-18 16:46:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Scope the query to those attachments that are visible based upon related page permissions.
|
|
|
|
*/
|
2021-10-19 23:58:56 +00:00
|
|
|
public function scopeVisible(): Builder
|
2021-10-18 16:46:55 +00:00
|
|
|
{
|
|
|
|
$permissionService = app()->make(PermissionService::class);
|
|
|
|
return $permissionService->filterRelatedEntity(
|
|
|
|
Page::class,
|
|
|
|
Attachment::query(),
|
|
|
|
'attachments',
|
|
|
|
'uploaded_to'
|
|
|
|
);
|
|
|
|
}
|
2016-10-09 17:58:22 +00:00
|
|
|
}
|