3 namespace BookStack\Entities\Tools;
5 use BookStack\Entities\Models\Page;
6 use BookStack\Entities\Models\PageRevision;
8 use Illuminate\Database\Eloquent\Builder;
10 class PageEditActivity
15 * PageEditActivity constructor.
17 public function __construct(Page $page)
23 * Check if there's active editing being performed on this page.
25 public function hasActiveEditing(): bool
27 return $this->activePageEditingQuery(60)->count() > 0;
31 * Get a notification message concerning the editing activity on the page.
33 public function activeEditingMessage(): string
35 $pageDraftEdits = $this->activePageEditingQuery(60)->get();
36 $count = $pageDraftEdits->count();
38 $userMessage = $count > 1 ? trans('entities.pages_draft_edit_active.start_a', ['count' => $count]) : trans('entities.pages_draft_edit_active.start_b', ['userName' => $pageDraftEdits->first()->createdBy->name]);
39 $timeMessage = trans('entities.pages_draft_edit_active.time_b', ['minCount'=> 60]);
41 return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);
45 * Get any editor clash warning messages to show for the given draft revision.
47 * @param PageRevision|Page $draft
51 public function getWarningMessagesForDraft($draft): array
55 if ($this->hasActiveEditing()) {
56 $warnings[] = $this->activeEditingMessage();
59 if ($draft instanceof PageRevision && $this->hasPageBeenUpdatedSinceDraftCreated($draft)) {
60 $warnings[] = trans('entities.pages_draft_page_changed_since_creation');
67 * Check if the page has been updated since the draft has been saved.
69 protected function hasPageBeenUpdatedSinceDraftCreated(PageRevision $draft): bool
71 return $draft->page->updated_at->timestamp > $draft->created_at->timestamp;
75 * Get the message to show when the user will be editing one of their drafts.
77 public function getEditingActiveDraftMessage(PageRevision $draft): string
79 $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
80 if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
84 return $message . "\n" . trans('entities.pages_draft_edited_notification');
88 * A query to check for active update drafts on a particular page
89 * within the last given many minutes.
91 protected function activePageEditingQuery(int $withinMinutes): Builder
93 $checkTime = Carbon::now()->subMinutes($withinMinutes);
94 $query = PageRevision::query()
95 ->where('type', '=', 'update_draft')
96 ->where('page_id', '=', $this->page->id)
97 ->where('updated_at', '>', $this->page->updated_at)
98 ->where('created_by', '!=', user()->id)
99 ->where('updated_at', '>=', $checkTime)