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

   1 a<?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      * Check if the page has been updated since the draft has been saved.
  48      *
  49      * @return bool
  50      */
  51     public function hasPageBeenUpdatedSinceDraftSaved(PageRevision $draft): bool
  52     {
  53         return $draft->page->updated_at->timestamp >= $draft->updated_at->timestamp;
  54     }
  55
  56     /**
  57      * Get the message to show when the user will be editing one of their drafts.
  58      *
  59      * @param PageRevision $draft
  60      *
  61      * @return string
  62      */
  63     public function getEditingActiveDraftMessage(PageRevision $draft): string
  64     {
  65         $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
  66         if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
  67             return $message;
  68         }
  69
  70         return $message . "\n" . trans('entities.pages_draft_edited_notification');
  71     }
  72
  73     /**
  74      * A query to check for active update drafts on a particular page
  75      * within the last given many minutes.
  76      */
  77     protected function activePageEditingQuery(int $withinMinutes): Builder
  78     {
  79         $checkTime = Carbon::now()->subMinutes($withinMinutes);
  80         $query = PageRevision::query()
  81             ->where('type', '=', 'update_draft')
  82             ->where('page_id', '=', $this->page->id)
  83             ->where('updated_at', '>', $this->page->updated_at)
  84             ->where('created_by', '!=', user()->id)
  85             ->where('updated_at', '>=', $checkTime)
  86             ->with('createdBy');
  87
  88         return $query;
  89     }
  90 }