]> BookStack Code Mirror - bookstack/blob - app/Entities/Tools/PageEditActivity.php
Allow to use DB tables prefix
[bookstack] / 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 Carbon\Carbon;
8 use Illuminate\Database\Eloquent\Builder;
9
10 class PageEditActivity
11 {
12     protected $page;
13
14     /**
15      * PageEditActivity constructor.
16      */
17     public function __construct(Page $page)
18     {
19         $this->page = $page;
20     }
21
22     /**
23      * Check if there's active editing being performed on this page.
24      *
25      * @return bool
26      */
27     public function hasActiveEditing(): bool
28     {
29         return $this->activePageEditingQuery(60)->count() > 0;
30     }
31
32     /**
33      * Get a notification message concerning the editing activity on the page.
34      */
35     public function activeEditingMessage(): string
36     {
37         $pageDraftEdits = $this->activePageEditingQuery(60)->get();
38         $count = $pageDraftEdits->count();
39
40         $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]);
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 the message to show when the user will be editing one of their drafts.
48      *
49      * @param PageRevision $draft
50      *
51      * @return string
52      */
53     public function getEditingActiveDraftMessage(PageRevision $draft): string
54     {
55         $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
56         if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
57             return $message;
58         }
59
60         return $message . "\n" . trans('entities.pages_draft_edited_notification');
61     }
62
63     /**
64      * A query to check for active update drafts on a particular page
65      * within the last given many minutes.
66      */
67     protected function activePageEditingQuery(int $withinMinutes): Builder
68     {
69         $checkTime = Carbon::now()->subMinutes($withinMinutes);
70         $query = PageRevision::query()
71             ->where('type', '=', 'update_draft')
72             ->where('page_id', '=', $this->page->id)
73             ->where('updated_at', '>', $this->page->updated_at)
74             ->where('created_by', '!=', user()->id)
75             ->where('updated_at', '>=', $checkTime)
76             ->with('createdBy');
77
78         return $query;
79     }
80 }