BookStack Code Mirror - bookstack/blob - app/Entities/Tools/PageEditActivity.php

   1 <?php
   2
   3 namespace BookStack\Entities\Tools;
   4
   5 use BookStack\Entities\Models\Page;
   6 use BookStack\Entities\Models\PageRevision;
   7 use BookStack\Util\DateFormatter;
   8 use Carbon\Carbon;
   9 use Illuminate\Database\Eloquent\Builder;
  10
  11 class PageEditActivity
  12 {
  13     public function __construct(
  14         protected Page $page
  15     ) {
  16     }
  17
  18     /**
  19      * Check if there's active editing being performed on this page.
  20      */
  21     public function hasActiveEditing(): bool
  22     {
  23         return $this->activePageEditingQuery(60)->count() > 0;
  24     }
  25
  26     /**
  27      * Get a notification message concerning the editing activity on the page.
  28      */
  29     public function activeEditingMessage(): string
  30     {
  31         $pageDraftEdits = $this->activePageEditingQuery(60)->get();
  32         $count = $pageDraftEdits->count();
  33
  34         $userMessage = trans('entities.pages_draft_edit_active.start_a', ['count' => $count]);
  35         if ($count === 1) {
  36             /** @var PageRevision $firstDraft */
  37             $firstDraft = $pageDraftEdits->first();
  38             $userMessage = trans('entities.pages_draft_edit_active.start_b', ['userName' => $firstDraft->createdBy->name ?? '']);
  39         }
  40
  41         $timeMessage = trans('entities.pages_draft_edit_active.time_b', ['minCount' => 60]);
  42
  43         return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);
  44     }
  45
  46     /**
  47      * Get any editor clash warning messages to show for the given draft revision.
  48      *
  49      * @return string[]
  50      */
  51     public function getWarningMessagesForDraft(Page|PageRevision $draft): array
  52     {
  53         $warnings = [];
  54
  55         if ($this->hasActiveEditing()) {
  56             $warnings[] = $this->activeEditingMessage();
  57         }
  58
  59         if ($draft instanceof PageRevision && $this->hasPageBeenUpdatedSinceDraftCreated($draft)) {
  60             $warnings[] = trans('entities.pages_draft_page_changed_since_creation');
  61         }
  62
  63         return $warnings;
  64     }
  65
  66     /**
  67      * Check if the page has been updated since the draft has been saved.
  68      */
  69     protected function hasPageBeenUpdatedSinceDraftCreated(PageRevision $draft): bool
  70     {
  71         return $draft->page->updated_at->timestamp > $draft->created_at->timestamp;
  72     }
  73
  74     /**
  75      * Get the message to show when the user will be editing one of their drafts.
  76      */
  77     public function getEditingActiveDraftMessage(PageRevision $draft): string
  78     {
  79         $formatter = resolve(DateFormatter::class);
  80         $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $formatter->relative($draft->updated_at)]);
  81         if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
  82             return $message;
  83         }
  84
  85         return $message . "\n" . trans('entities.pages_draft_edited_notification');
  86     }
  87
  88     /**
  89      * A query to check for active update drafts on a particular page
  90      * within the last given many minutes.
  91      */
  92     protected function activePageEditingQuery(int $withinMinutes): Builder
  93     {
  94         $checkTime = Carbon::now()->subMinutes($withinMinutes);
  95         $query = PageRevision::query()
  96             ->where('type', '=', 'update_draft')
  97             ->where('page_id', '=', $this->page->id)
  98             ->where('updated_at', '>', $this->page->updated_at)
  99             ->where('created_by', '!=', user()->id)
 100             ->where('updated_at', '>=', $checkTime)
 101             ->with('createdBy');
 102
 103         return $query;
 104     }
 105 }