BookStack Code Mirror - bookstack/blob - app/Entities/Models/Page.php

   1 <?php
   2
   3 namespace BookStack\Entities\Models;
   4
   5 use BookStack\Entities\Tools\PageContent;
   6 use BookStack\Permissions\PermissionApplicator;
   7 use BookStack\Uploads\Attachment;
   8 use Illuminate\Database\Eloquent\Builder;
   9 use Illuminate\Database\Eloquent\Collection;
  10 use Illuminate\Database\Eloquent\Factories\HasFactory;
  11 use Illuminate\Database\Eloquent\Relations\BelongsTo;
  12 use Illuminate\Database\Eloquent\Relations\HasMany;
  13 use Illuminate\Database\Eloquent\Relations\HasOne;
  14
  15 /**
  16  * Class Page.
  17  *
  18  * @property int          $chapter_id
  19  * @property string       $html
  20  * @property string       $markdown
  21  * @property string       $text
  22  * @property bool         $template
  23  * @property bool         $draft
  24  * @property int          $revision_count
  25  * @property string       $editor
  26  * @property Chapter      $chapter
  27  * @property Collection   $attachments
  28  * @property Collection   $revisions
  29  * @property PageRevision $currentRevision
  30  */
  31 class Page extends BookChild
  32 {
  33     use HasFactory;
  34
  35     public static $listAttributes = ['name', 'id', 'slug', 'book_id', 'chapter_id', 'draft', 'template', 'text', 'created_at', 'updated_at', 'priority'];
  36     public static $contentAttributes = ['name', 'id', 'slug', 'book_id', 'chapter_id', 'draft', 'template', 'html', 'text', 'created_at', 'updated_at', 'priority'];
  37
  38     protected $fillable = ['name', 'priority'];
  39
  40     public string $textField = 'text';
  41     public string $htmlField = 'html';
  42
  43     protected $hidden = ['html', 'markdown', 'text', 'pivot', 'deleted_at'];
  44
  45     protected $casts = [
  46         'draft'    => 'boolean',
  47         'template' => 'boolean',
  48     ];
  49
  50     /**
  51      * Get the entities that are visible to the current user.
  52      */
  53     public function scopeVisible(Builder $query): Builder
  54     {
  55         $query = app()->make(PermissionApplicator::class)->restrictDraftsOnPageQuery($query);
  56
  57         return parent::scopeVisible($query);
  58     }
  59
  60     /**
  61      * Get the chapter that this page is in, If applicable.
  62      *
  63      * @return BelongsTo
  64      */
  65     public function chapter()
  66     {
  67         return $this->belongsTo(Chapter::class);
  68     }
  69
  70     /**
  71      * Check if this page has a chapter.
  72      */
  73     public function hasChapter(): bool
  74     {
  75         return $this->chapter()->count() > 0;
  76     }
  77
  78     /**
  79      * Get the associated page revisions, ordered by created date.
  80      * Only provides actual saved page revision instances, Not drafts.
  81      */
  82     public function revisions(): HasMany
  83     {
  84         return $this->allRevisions()
  85             ->where('type', '=', 'version')
  86             ->orderBy('created_at', 'desc')
  87             ->orderBy('id', 'desc');
  88     }
  89
  90     /**
  91      * Get the current revision for the page if existing.
  92      */
  93     public function currentRevision(): HasOne
  94     {
  95         return $this->hasOne(PageRevision::class)
  96             ->where('type', '=', 'version')
  97             ->orderBy('created_at', 'desc')
  98             ->orderBy('id', 'desc');
  99     }
 100
 101     /**
 102      * Get all revision instances assigned to this page.
 103      * Includes all types of revisions.
 104      */
 105     public function allRevisions(): HasMany
 106     {
 107         return $this->hasMany(PageRevision::class);
 108     }
 109
 110     /**
 111      * Get the attachments assigned to this page.
 112      *
 113      * @return HasMany
 114      */
 115     public function attachments()
 116     {
 117         return $this->hasMany(Attachment::class, 'uploaded_to')->orderBy('order', 'asc');
 118     }
 119
 120     /**
 121      * Get the url of this page.
 122      */
 123     public function getUrl(string $path = ''): string
 124     {
 125         $parts = [
 126             'books',
 127             urlencode($this->book_slug ?? $this->book->slug),
 128             $this->draft ? 'draft' : 'page',
 129             $this->draft ? $this->id : urlencode($this->slug),
 130             trim($path, '/'),
 131         ];
 132
 133         return url('/' . implode('/', $parts));
 134     }
 135
 136     /**
 137      * Get this page for JSON display.
 138      */
 139     public function forJsonDisplay(): self
 140     {
 141         $refreshed = $this->refresh()->unsetRelations()->load(['tags', 'createdBy', 'updatedBy', 'ownedBy']);
 142         $refreshed->setHidden(array_diff($refreshed->getHidden(), ['html', 'markdown']));
 143         $refreshed->setAttribute('raw_html', $refreshed->html);
 144         $refreshed->html = (new PageContent($refreshed))->render();
 145
 146         return $refreshed;
 147     }
 148
 149     /**
 150      * Get a visible page by its book and page slugs.
 151      * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
 152      */
 153     public static function getBySlugs(string $bookSlug, string $pageSlug): self
 154     {
 155         return static::visible()->whereSlugs($bookSlug, $pageSlug)->firstOrFail();
 156     }
 157 }