protected $user;
protected $permissionService;
- /**
- * ActivityService constructor.
- */
public function __construct(Activity $activity, PermissionService $permissionService)
{
$this->activity = $activity;
/**
* Add activity data to database.
*/
- public function add(Entity $entity, string $activityKey, ?int $bookId = null)
+ public function add(Entity $entity, string $type, ?int $bookId = null)
{
- $activity = $this->newActivityForUser($activityKey, $bookId);
+ $activity = $this->newActivityForUser($type, $bookId);
$entity->activity()->save($activity);
- $this->setNotification($activityKey);
- }
-
- /**
- * Adds a activity history with a message, without binding to a entity.
- */
- public function addMessage(string $activityKey, string $message, ?int $bookId = null)
- {
- $this->newActivityForUser($activityKey, $bookId)->forceFill([
- 'extra' => $message
- ])->save();
-
- $this->setNotification($activityKey);
+ $this->setNotification($type);
}
/**
--- /dev/null
+<?php namespace BookStack\Actions;
+
+class ActivityType
+{
+ const PAGE_CREATE = 'page_create';
+ const PAGE_UPDATE = 'page_update';
+ const PAGE_DELETE = 'page_delete';
+ const PAGE_RESTORE = 'page_restore';
+ const PAGE_MOVE = 'page_move';
+ const COMMENTED_ON = 'commented_on';
+ const CHAPTER_CREATE = 'chapter_create';
+ const CHAPTER_UPDATE = 'chapter_update';
+ const CHAPTER_DELETE = 'chapter_delete';
+ const CHAPTER_MOVE = 'chapter_move';
+ const BOOK_CREATE = 'book_create';
+ const BOOK_UPDATE = 'book_update';
+ const BOOK_DELETE = 'book_delete';
+ const BOOK_SORT = 'book_sort';
+ const BOOKSHELF_CREATE = 'bookshelf_create';
+ const BOOKSHELF_UPDATE = 'bookshelf_update';
+ const BOOKSHELF_DELETE = 'bookshelf_delete';
+}
\ No newline at end of file
$comment->parent_id = $parent_id;
$entity->comments()->save($comment);
+ Activity::add($entity, ActivityType::COMMENTED_ON, $entity->book->id);
return $comment;
}
<?php namespace BookStack\Entities\Repos;
+use BookStack\Actions\ActivityType;
use BookStack\Actions\TagRepo;
use BookStack\Entities\Book;
use BookStack\Entities\Managers\TrashCan;
use BookStack\Exceptions\ImageUploadException;
use BookStack\Exceptions\NotFoundException;
use BookStack\Exceptions\NotifyException;
+use BookStack\Facades\Activity;
use BookStack\Uploads\ImageRepo;
use Exception;
use Illuminate\Contracts\Container\BindingResolutionException;
{
$book = new Book();
$this->baseRepo->create($book, $input);
+ Activity::add($book, ActivityType::BOOK_CREATE, $book->id);
return $book;
}
public function update(Book $book, array $input): Book
{
$this->baseRepo->update($book, $input);
+ Activity::add($book, ActivityType::BOOK_UPDATE, $book->id);
return $book;
}
{
$trashCan = new TrashCan();
$trashCan->softDestroyBook($book);
+ Activity::add($book, ActivityType::BOOK_DELETE, $book->id);
+
$trashCan->autoClearOld();
}
}
<?php namespace BookStack\Entities\Repos;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Book;
use BookStack\Entities\Bookshelf;
use BookStack\Entities\Managers\TrashCan;
use BookStack\Exceptions\ImageUploadException;
use BookStack\Exceptions\NotFoundException;
+use BookStack\Facades\Activity;
use Exception;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Http\UploadedFile;
$shelf = new Bookshelf();
$this->baseRepo->create($shelf, $input);
$this->updateBooks($shelf, $bookIds);
+ Activity::add($shelf, ActivityType::BOOKSHELF_CREATE);
return $shelf;
}
/**
- * Create a new shelf in the system.
+ * Update an existing shelf in the system using the given input.
*/
public function update(Bookshelf $shelf, array $input, ?array $bookIds): Bookshelf
{
$this->updateBooks($shelf, $bookIds);
}
+ Activity::add($shelf, ActivityType::BOOKSHELF_UPDATE);
return $shelf;
}
{
$trashCan = new TrashCan();
$trashCan->softDestroyShelf($shelf);
+ Activity::add($shelf, ActivityType::BOOKSHELF_DELETE);
$trashCan->autoClearOld();
}
}
<?php namespace BookStack\Entities\Repos;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Book;
use BookStack\Entities\Chapter;
use BookStack\Entities\Managers\BookContents;
use BookStack\Entities\Managers\TrashCan;
use BookStack\Exceptions\MoveOperationException;
use BookStack\Exceptions\NotFoundException;
+use BookStack\Facades\Activity;
use Exception;
use Illuminate\Support\Collection;
$chapter->book_id = $parentBook->id;
$chapter->priority = (new BookContents($parentBook))->getLastPriority() + 1;
$this->baseRepo->create($chapter, $input);
+ Activity::add($chapter, ActivityType::CHAPTER_CREATE, $parentBook->id);
return $chapter;
}
public function update(Chapter $chapter, array $input): Chapter
{
$this->baseRepo->update($chapter, $input);
+ Activity::add($chapter, ActivityType::CHAPTER_UPDATE, $chapter->book->id);
return $chapter;
}
{
$trashCan = new TrashCan();
$trashCan->softDestroyChapter($chapter);
+ Activity::add($chapter, ActivityType::CHAPTER_DELETE, $chapter->book->id);
$trashCan->autoClearOld();
}
throw new MoveOperationException('Chapters can only be moved into books');
}
+ /** @var Book $parent */
$parent = Book::visible()->where('id', '=', $entityId)->first();
if ($parent === null) {
throw new MoveOperationException('Book to move chapter into not found');
$chapter->changeBook($parent->id);
$chapter->rebuildPermissions();
+ Activity::add($chapter, ActivityType::CHAPTER_MOVE, $parent->id);
+
return $parent;
}
}
<?php namespace BookStack\Entities\Repos;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Book;
use BookStack\Entities\Chapter;
use BookStack\Entities\Entity;
use BookStack\Exceptions\NotFoundException;
use BookStack\Exceptions\NotifyException;
use BookStack\Exceptions\PermissionsException;
+use BookStack\Facades\Activity;
use Exception;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Pagination\LengthAwarePaginator;
$this->savePageRevision($draft, trans('entities.pages_initial_revision'));
$draft->indexForSearch();
- return $draft->refresh();
+ $draft->refresh();
+
+ Activity::add($draft, ActivityType::PAGE_CREATE, $draft->book->id);
+ return $draft;
}
/**
$this->savePageRevision($page, $summary);
}
+ Activity::add($page, ActivityType::PAGE_UPDATE, $page->book->id);
return $page;
}
{
$trashCan = new TrashCan();
$trashCan->softDestroyPage($page);
+ Activity::add($page, ActivityType::PAGE_DELETE, $page->book_id);
$trashCan->autoClearOld();
}
$page->save();
$page->indexForSearch();
+ Activity::add($page, ActivityType::PAGE_RESTORE, $page->book->id);
return $page;
}
* @throws MoveOperationException
* @throws PermissionsException
*/
- public function move(Page $page, string $parentIdentifier): Book
+ public function move(Page $page, string $parentIdentifier): Entity
{
$parent = $this->findParentByIdentifier($parentIdentifier);
if ($parent === null) {
$page->changeBook($parent instanceof Book ? $parent->id : $parent->book->id);
$page->rebuildPermissions();
- return ($parent instanceof Book ? $parent : $parent->book);
+ Activity::add($page, ActivityType::PAGE_MOVE, $page->book->id);
+ return $parent;
}
/**
<?php namespace BookStack\Http\Controllers\Api;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Book;
use BookStack\Entities\Repos\BookRepo;
use BookStack\Exceptions\NotifyException;
$requestData = $this->validate($request, $this->rules['create']);
$book = $this->bookRepo->create($requestData);
- Activity::add($book, 'book_create', $book->id);
-
return response()->json($book);
}
$requestData = $this->validate($request, $this->rules['update']);
$book = $this->bookRepo->update($book, $requestData);
- Activity::add($book, 'book_update', $book->id);
return response()->json($book);
}
$this->checkOwnablePermission('book-delete', $book);
$this->bookRepo->destroy($book);
- Activity::addMessage('book_delete', $book->name);
-
return response('', 204);
}
}
\ No newline at end of file
<?php namespace BookStack\Http\Controllers\Api;
+use BookStack\Actions\ActivityType;
use BookStack\Facades\Activity;
use BookStack\Entities\Repos\BookshelfRepo;
use BookStack\Entities\Bookshelf;
$bookIds = $request->get('books', []);
$shelf = $this->bookshelfRepo->create($requestData, $bookIds);
- Activity::add($shelf, 'bookshelf_create', $shelf->id);
return response()->json($shelf);
}
$this->checkOwnablePermission('bookshelf-update', $shelf);
$requestData = $this->validate($request, $this->rules['update']);
-
$bookIds = $request->get('books', null);
$shelf = $this->bookshelfRepo->update($shelf, $requestData, $bookIds);
- Activity::add($shelf, 'bookshelf_update', $shelf->id);
-
return response()->json($shelf);
}
$this->checkOwnablePermission('bookshelf-delete', $shelf);
$this->bookshelfRepo->destroy($shelf);
- Activity::addMessage('bookshelf_delete', $shelf->name);
-
return response('', 204);
}
}
\ No newline at end of file
<?php namespace BookStack\Http\Controllers\Api;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Book;
use BookStack\Entities\Chapter;
use BookStack\Entities\Repos\ChapterRepo;
$this->checkOwnablePermission('chapter-create', $book);
$chapter = $this->chapterRepo->create($request->all(), $book);
- Activity::add($chapter, 'chapter_create', $book->id);
-
return response()->json($chapter->load(['tags']));
}
$this->checkOwnablePermission('chapter-update', $chapter);
$updatedChapter = $this->chapterRepo->update($chapter, $request->all());
- Activity::add($chapter, 'chapter_update', $chapter->book->id);
-
return response()->json($updatedChapter->load(['tags']));
}
$this->checkOwnablePermission('chapter-delete', $chapter);
$this->chapterRepo->destroy($chapter);
- Activity::addMessage('chapter_delete', $chapter->name, $chapter->book->id);
-
return response('', 204);
}
}
<?php namespace BookStack\Http\Controllers;
use Activity;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Managers\BookContents;
use BookStack\Entities\Bookshelf;
use BookStack\Entities\Managers\EntityContext;
use BookStack\Entities\Repos\BookRepo;
use BookStack\Exceptions\ImageUploadException;
-use BookStack\Exceptions\NotifyException;
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
use Throwable;
protected $bookRepo;
protected $entityContextManager;
- /**
- * BookController constructor.
- */
public function __construct(EntityContext $entityContextManager, BookRepo $bookRepo)
{
$this->bookRepo = $bookRepo;
$book = $this->bookRepo->create($request->all());
$this->bookRepo->updateCoverImage($book, $request->file('image', null));
- Activity::add($book, 'book_create', $book->id);
if ($bookshelf) {
$bookshelf->appendBook($book);
- Activity::add($bookshelf, 'bookshelf_update');
+ Activity::add($bookshelf, ActivityType::BOOKSHELF_UPDATE);
}
return redirect($book->getUrl());
$resetCover = $request->has('image_reset');
$this->bookRepo->updateCoverImage($book, $request->file('image', null), $resetCover);
- Activity::add($book, 'book_update', $book->id);
-
return redirect($book->getUrl());
}
$book = $this->bookRepo->getBySlug($bookSlug);
$this->checkOwnablePermission('book-delete', $book);
- Activity::add($book, 'book_delete', $book->id);
$this->bookRepo->destroy($book);
return redirect('/books');
namespace BookStack\Http\Controllers;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Book;
use BookStack\Entities\Managers\BookContents;
use BookStack\Entities\Repos\BookRepo;
// Rebuild permissions and add activity for involved books.
$booksInvolved->each(function (Book $book) {
- Activity::add($book, 'book_sort', $book->id);
+ Activity::add($book, ActivityType::BOOK_SORT, $book->id);
});
return redirect($book->getUrl());
$shelf = $this->bookshelfRepo->create($request->all(), $bookIds);
$this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null));
- Activity::add($shelf, 'bookshelf_create');
return redirect($shelf->getUrl());
}
$shelf = $this->bookshelfRepo->update($shelf, $request->all(), $bookIds);
$resetCover = $request->has('image_reset');
$this->bookshelfRepo->updateCoverImage($shelf, $request->file('image', null), $resetCover);
- Activity::add($shelf, 'bookshelf_update');
return redirect($shelf->getUrl());
}
$shelf = $this->bookshelfRepo->getBySlug($slug);
$this->checkOwnablePermission('bookshelf-delete', $shelf);
- Activity::add($shelf, 'bookshelf_delete');
$this->bookshelfRepo->destroy($shelf);
return redirect('/shelves');
<?php namespace BookStack\Http\Controllers;
-use Activity;
use BookStack\Entities\Book;
use BookStack\Entities\Managers\BookContents;
use BookStack\Entities\Repos\ChapterRepo;
$this->checkOwnablePermission('chapter-create', $book);
$chapter = $this->chapterRepo->create($request->all(), $book);
- Activity::add($chapter, 'chapter_create', $book->id);
return redirect($chapter->getUrl());
}
$this->checkOwnablePermission('chapter-update', $chapter);
$this->chapterRepo->update($chapter, $request->all());
- Activity::add($chapter, 'chapter_update', $chapter->book->id);
return redirect($chapter->getUrl());
}
$chapter = $this->chapterRepo->getBySlug($bookSlug, $chapterSlug);
$this->checkOwnablePermission('chapter-delete', $chapter);
- Activity::add($chapter, 'chapter_delete', $chapter->book->id);
$this->chapterRepo->destroy($chapter);
return redirect($chapter->book->getUrl());
return redirect()->back();
}
- Activity::add($chapter, 'chapter_move', $newBook->id);
-
$this->showSuccessNotification(trans('entities.chapter_move_success', ['bookName' => $newBook->name]));
return redirect($chapter->getUrl());
}
<?php namespace BookStack\Http\Controllers;
use Activity;
+use BookStack\Actions\ActivityType;
use BookStack\Actions\CommentRepo;
use BookStack\Entities\Page;
use Illuminate\Http\Request;
// Create a new comment.
$this->checkPermission('comment-create-all');
$comment = $this->commentRepo->create($page, $request->get('text'), $request->get('parent_id'));
- Activity::add($page, 'commented_on', $page->book->id);
return view('comments.comment', ['comment' => $comment]);
}
<?php namespace BookStack\Http\Controllers;
use Activity;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Managers\BookContents;
use BookStack\Entities\Managers\PageContent;
use BookStack\Entities\Managers\PageEditActivity;
$this->checkOwnablePermission('page-create', $draftPage->getParent());
$page = $this->pageRepo->publishDraft($draftPage, $request->all());
- Activity::add($page, 'page_create', $draftPage->book->id);
return redirect($page->getUrl());
}
$this->checkOwnablePermission('page-update', $page);
$this->pageRepo->update($page, $request->all());
- Activity::add($page, 'page_update', $page->book->id);
return redirect($page->getUrl());
}
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-delete', $page);
+ $parent = $page->getParent();
- $book = $page->book;
- $parent = $page->chapter ?? $book;
$this->pageRepo->destroy($page);
- Activity::add($page, 'page_delete', $page->book_id);
return redirect($parent->getUrl());
}
return redirect()->back();
}
- Activity::add($page, 'page_move', $page->book->id);
$this->showSuccessNotification(trans('entities.pages_move_success', ['parentName' => $parent->name]));
return redirect($page->getUrl());
}
return redirect()->back();
}
- Activity::add($pageCopy, 'page_create', $pageCopy->book->id);
-
$this->showSuccessNotification(trans('entities.pages_copy_success'));
return redirect($pageCopy->getUrl());
}
<?php namespace BookStack\Http\Controllers;
+use BookStack\Actions\ActivityType;
use BookStack\Entities\Managers\PageContent;
use BookStack\Entities\Repos\PageRepo;
use BookStack\Exceptions\NotFoundException;
$page = $this->pageRepo->restoreRevision($page, $revisionId);
- Activity::add($page, 'page_restore', $page->book->id);
return redirect($page->getUrl());
}
<?php namespace Tests;
+use BookStack\Actions\ActivityType;
use BookStack\Actions\Comment;
use BookStack\Actions\CommentRepo;
use BookStack\Auth\Permissions\JointPermission;
{
$this->asEditor();
$page = Page::first();
- \Activity::add($page, 'page_update', $page->book->id);
+ \Activity::add($page, ActivityType::PAGE_UPDATE, $page->book->id);
$this->assertDatabaseHas('activities', [
'key' => 'page_update',
<?php namespace Tests\User;
use Activity;
+use BookStack\Actions\ActivityType;
use BookStack\Auth\User;
use BookStack\Entities\Bookshelf;
use Tests\BrowserKitTest;
$newUser = $this->getNewBlankUser();
$this->actingAs($newUser);
$entities = $this->createEntityChainBelongingToUser($newUser, $newUser);
- Activity::add($entities['book'], 'book_update', $entities['book']->id);
- Activity::add($entities['page'], 'page_create', $entities['book']->id);
+ Activity::add($entities['book'], ActivityType::BOOK_UPDATE, $entities['book']->id);
+ Activity::add($entities['page'], ActivityType::PAGE_CREATE, $entities['book']->id);
$this->asAdmin()->visit('/user/' . $newUser->id)
->seeInElement('#recent-user-activity', 'updated book')
$newUser = $this->getNewBlankUser();
$this->actingAs($newUser);
$entities = $this->createEntityChainBelongingToUser($newUser, $newUser);
- Activity::add($entities['book'], 'book_update', $entities['book']->id);
- Activity::add($entities['page'], 'page_create', $entities['book']->id);
+ Activity::add($entities['book'], ActivityType::BOOK_UPDATE, $entities['book']->id);
+ Activity::add($entities['page'], ActivityType::PAGE_CREATE, $entities['book']->id);
$this->asAdmin()->visit('/')->clickInElement('#recent-activity', $newUser->name)
->seePageIs('/user/' . $newUser->id)
projects / bookstack / commitdiff