-<?php namespace BookStack\Entities\Repos;
+<?php
-use BookStack\Actions\ActivityType;
-use BookStack\Entities\Models\Book;
+namespace BookStack\Entities\Repos;
+
+use BookStack\Activity\ActivityType;
use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Queries\BookQueries;
use BookStack\Entities\Tools\TrashCan;
-use BookStack\Exceptions\ImageUploadException;
-use BookStack\Exceptions\NotFoundException;
use BookStack\Facades\Activity;
use Exception;
-use Illuminate\Contracts\Pagination\LengthAwarePaginator;
-use Illuminate\Http\UploadedFile;
-use Illuminate\Support\Collection;
class BookshelfRepo
{
- protected $baseRepo;
-
- /**
- * BookshelfRepo constructor.
- */
- public function __construct(BaseRepo $baseRepo)
- {
- $this->baseRepo = $baseRepo;
- }
-
- /**
- * Get all bookshelves in a paginated format.
- */
- public function getAllPaginated(int $count = 20, string $sort = 'name', string $order = 'asc'): LengthAwarePaginator
- {
- return Bookshelf::visible()
- ->with(['visibleBooks', 'cover'])
- ->orderBy($sort, $order)
- ->paginate($count);
- }
-
- /**
- * Get the bookshelves that were most recently viewed by this user.
- */
- public function getRecentlyViewed(int $count = 20): Collection
- {
- return Bookshelf::visible()->withLastView()
- ->having('last_viewed_at', '>', 0)
- ->orderBy('last_viewed_at', 'desc')
- ->take($count)->get();
- }
-
- /**
- * Get the most popular bookshelves in the system.
- */
- public function getPopular(int $count = 20): Collection
- {
- return Bookshelf::visible()->withViewCount()
- ->having('view_count', '>', 0)
- ->orderBy('view_count', 'desc')
- ->take($count)->get();
- }
-
- /**
- * Get the most recently created bookshelves from the system.
- */
- public function getRecentlyCreated(int $count = 20): Collection
- {
- return Bookshelf::visible()->orderBy('created_at', 'desc')
- ->take($count)->get();
- }
-
- /**
- * Get a shelf by its slug.
- */
- public function getBySlug(string $slug): Bookshelf
- {
- $shelf = Bookshelf::visible()->where('slug', '=', $slug)->first();
-
- if ($shelf === null) {
- throw new NotFoundException(trans('errors.bookshelf_not_found'));
- }
-
- return $shelf;
+ public function __construct(
+ protected BaseRepo $baseRepo,
+ protected BookQueries $bookQueries,
+ protected TrashCan $trashCan,
+ ) {
}
/**
{
$shelf = new Bookshelf();
$this->baseRepo->create($shelf, $input);
+ $this->baseRepo->updateCoverImage($shelf, $input['image'] ?? null);
$this->updateBooks($shelf, $bookIds);
- Activity::addForEntity($shelf, ActivityType::BOOKSHELF_CREATE);
+ Activity::add(ActivityType::BOOKSHELF_CREATE, $shelf);
+
return $shelf;
}
$this->updateBooks($shelf, $bookIds);
}
- Activity::addForEntity($shelf, ActivityType::BOOKSHELF_UPDATE);
+ if (array_key_exists('image', $input)) {
+ $this->baseRepo->updateCoverImage($shelf, $input['image'], $input['image'] === null);
+ }
+
+ Activity::add(ActivityType::BOOKSHELF_UPDATE, $shelf);
+
return $shelf;
}
/**
- * Update which books are assigned to this shelf by
- * syncing the given book ids.
+ * Update which books are assigned to this shelf by syncing the given book ids.
* Function ensures the books are visible to the current user and existing.
*/
protected function updateBooks(Bookshelf $shelf, array $bookIds)
return intval($id);
});
- $syncData = Book::visible()
+ $syncData = $this->bookQueries->visibleForList()
->whereIn('id', $bookIds)
- ->get(['id'])->pluck('id')->mapWithKeys(function ($bookId) use ($numericIDs) {
+ ->pluck('id')
+ ->mapWithKeys(function ($bookId) use ($numericIDs) {
return [$bookId => ['order' => $numericIDs->search($bookId)]];
});
$shelf->books()->sync($syncData);
}
- /**
- * Update the given shelf cover image, or clear it.
- * @throws ImageUploadException
- * @throws Exception
- */
- public function updateCoverImage(Bookshelf $shelf, ?UploadedFile $coverImage, bool $removeImage = false)
- {
- $this->baseRepo->updateCoverImage($shelf, $coverImage, $removeImage);
- }
-
- /**
- * Copy down the permissions of the given shelf to all child books.
- */
- public function copyDownPermissions(Bookshelf $shelf, $checkUserPermissions = true): int
- {
- $shelfPermissions = $shelf->permissions()->get(['role_id', 'action'])->toArray();
- $shelfBooks = $shelf->books()->get(['id', 'restricted']);
- $updatedBookCount = 0;
-
- /** @var Book $book */
- foreach ($shelfBooks as $book) {
- if ($checkUserPermissions && !userCan('restrictions-manage', $book)) {
- continue;
- }
- $book->permissions()->delete();
- $book->restricted = $shelf->restricted;
- $book->permissions()->createMany($shelfPermissions);
- $book->save();
- $book->rebuildPermissions();
- $updatedBookCount++;
- }
-
- return $updatedBookCount;
- }
-
/**
* Remove a bookshelf from the system.
+ *
* @throws Exception
*/
public function destroy(Bookshelf $shelf)
{
- $trashCan = new TrashCan();
- $trashCan->softDestroyShelf($shelf);
- Activity::addForEntity($shelf, ActivityType::BOOKSHELF_DELETE);
- $trashCan->autoClearOld();
+ $this->trashCan->softDestroyShelf($shelf);
+ Activity::add(ActivityType::BOOKSHELF_DELETE, $shelf);
+ $this->trashCan->autoClearOld();
}
}