Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-07-05 02:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added revision activity types to system and audit log

Browse Source 
Closes #3628
This commit is contained in:
Dan Brown 2022-08-09 13:25:18 +01:00
parent 7fa934e7f2
commit 6e0a7344fa
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
6 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
app/Actions/ActivityType.php
View File

@ -29,6 +29,9 @@ class ActivityType
const COMMENTED_ON = 'commented_on'; const COMMENTED_ON = 'commented_on';
const PERMISSIONS_UPDATE = 'permissions_update'; const PERMISSIONS_UPDATE = 'permissions_update';
const REVISION_RESTORE = 'revision_restore';
const REVISION_DELETE = 'revision_delete';
const SETTINGS_UPDATE = 'settings_update'; const SETTINGS_UPDATE = 'settings_update';
const MAINTENANCE_ACTION_RUN = 'maintenance_action_run'; const MAINTENANCE_ACTION_RUN = 'maintenance_action_run';

8
app/Entities/Models/PageRevision.php
View File

@ -3,6 +3,7 @@
namespace BookStack\Entities\Models; namespace BookStack\Entities\Models;
use BookStack\Auth\User; use BookStack\Auth\User;
use BookStack\Interfaces\Loggable;
use BookStack\Model; use BookStack\Model;
use Carbon\Carbon; use Carbon\Carbon;
use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\BelongsTo;
@ -27,7 +28,7 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
* @property Page $page * @property Page $page
* @property-read ?User $createdBy * @property-read ?User $createdBy
*/ */
class PageRevision extends Model class PageRevision extends Model implements Loggable
{ {
protected $fillable = ['name', 'text', 'summary']; protected $fillable = ['name', 'text', 'summary'];
protected $hidden = ['html', 'markdown', 'restricted', 'text']; protected $hidden = ['html', 'markdown', 'restricted', 'text'];
@ -83,4 +84,9 @@ class PageRevision extends Model
{ {
return $type === 'revision'; return $type === 'revision';
} }
public function logDescriptor(): string
{
return "Revision #{$this->revision_number} (ID: {$this->id}) for page ID {$this->page_id}";
}
} }

1
app/Entities/Repos/PageRepo.php
View File

@ -337,6 +337,7 @@ class PageRepo
$this->savePageRevision($page, $summary); $this->savePageRevision($page, $summary);
Activity::add(ActivityType::PAGE_RESTORE, $page); Activity::add(ActivityType::PAGE_RESTORE, $page);
Activity::add(ActivityType::REVISION_RESTORE, $revision);
return $page; return $page;
} }

2
app/Facades/Activity.php
View File

@ -5,7 +5,7 @@ namespace BookStack\Facades;
use Illuminate\Support\Facades\Facade; use Illuminate\Support\Facades\Facade;
/** /**
* @see \BookStack\Actions\ActivityLogger * @mixin \BookStack\Actions\ActivityLogger
*/ */
class Activity extends Facade class Activity extends Facade
{ {

3
app/Http/Controllers/PageRevisionController.php
View File

@ -2,9 +2,11 @@
namespace BookStack\Http\Controllers; namespace BookStack\Http\Controllers;
use BookStack\Actions\ActivityType;
use BookStack\Entities\Repos\PageRepo; use BookStack\Entities\Repos\PageRepo;
use BookStack\Entities\Tools\PageContent; use BookStack\Entities\Tools\PageContent;
use BookStack\Exceptions\NotFoundException; use BookStack\Exceptions\NotFoundException;
use BookStack\Facades\Activity;
use Ssddanbrown\HtmlDiff\Diff; use Ssddanbrown\HtmlDiff\Diff;
class PageRevisionController extends Controller class PageRevisionController extends Controller
@ -132,6 +134,7 @@ class PageRevisionController extends Controller
} }
$revision->delete(); $revision->delete();
Activity::add(ActivityType::REVISION_DELETE, $revision);
$this->showSuccessNotification(trans('entities.revision_delete_success')); $this->showSuccessNotification(trans('entities.revision_delete_success'));
return redirect($page->getUrl('/revisions')); return redirect($page->getUrl('/revisions'));

7
tests/Entity/PageRevisionTest.php
View File

@ -2,6 +2,7 @@
namespace Tests\Entity; namespace Tests\Entity;
use BookStack\Actions\ActivityType;
use BookStack\Entities\Models\Page; use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\PageRepo; use BookStack\Entities\Repos\PageRepo;
use Tests\TestCase; use Tests\TestCase;
@ -117,6 +118,9 @@ class PageRevisionTest extends TestCase
'type' => 'version', 'type' => 'version',
'summary' => "Restored from #{$revToRestore->id}; My first update", 'summary' => "Restored from #{$revToRestore->id}; My first update",
]); ]);
$detail = "Revision #{$revToRestore->revision_number} (ID: {$revToRestore->id}) for page ID {$revToRestore->page_id}";
$this->assertActivityExists(ActivityType::REVISION_RESTORE, null, $detail);
} }
public function test_page_revision_count_increments_on_update() public function test_page_revision_count_increments_on_update()
@ -164,6 +168,9 @@ class PageRevisionTest extends TestCase
$this->assertTrue($beforeRevisionCount === ($afterRevisionCount + 1)); $this->assertTrue($beforeRevisionCount === ($afterRevisionCount + 1));
$detail = "Revision #{$revision->revision_number} (ID: {$revision->id}) for page ID {$revision->page_id}";
$this->assertActivityExists(ActivityType::REVISION_DELETE, null, $detail);
// Try to delete the latest revision // Try to delete the latest revision
$beforeRevisionCount = $page->revisions->count(); $beforeRevisionCount = $page->revisions->count();
$resp = $this->asEditor()->delete($page->currentRevision->getUrl('/delete/')); $resp = $this->asEditor()->delete($page->currentRevision->getUrl('/delete/'));