BookStack Code Mirror - bookstack/blob - app/Http/Controllers/FavouriteController.php

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Entities\Models\Entity;
   6 use BookStack\Interfaces\Favouritable;
   7 use BookStack\Model;
   8 use Illuminate\Http\Request;
   9
  10 class FavouriteController extends Controller
  11 {
  12     /**
  13      * Add a new item as a favourite.
  14      */
  15     public function add(Request $request)
  16     {
  17         $favouritable = $this->getValidatedModelFromRequest($request);
  18         $favouritable->favourites()->firstOrCreate([
  19             'user_id' => user()->id,
  20         ]);
  21
  22         $this->showSuccessNotification(trans('activities.favourite_add_notification', [
  23             'name' => $favouritable->name,
  24         ]));
  25         return redirect()->back();
  26     }
  27
  28     /**
  29      * Remove an item as a favourite.
  30      */
  31     public function remove(Request $request)
  32     {
  33         $favouritable = $this->getValidatedModelFromRequest($request);
  34         $favouritable->favourites()->where([
  35             'user_id' => user()->id,
  36         ])->delete();
  37
  38         $this->showSuccessNotification(trans('activities.favourite_remove_notification', [
  39             'name' => $favouritable->name,
  40         ]));
  41         return redirect()->back();
  42     }
  43
  44     /**
  45      * @throws \Illuminate\Validation\ValidationException
  46      * @throws \Exception
  47      */
  48     protected function getValidatedModelFromRequest(Request $request): Favouritable
  49     {
  50         $modelInfo = $this->validate($request, [
  51             'type' => 'required|string',
  52             'id' => 'required|integer',
  53         ]);
  54
  55         if (!class_exists($modelInfo['type'])) {
  56             throw new \Exception('Model not found');
  57         }
  58
  59         /** @var Model $model */
  60         $model = new $modelInfo['type'];
  61         if (! $model instanceof Favouritable) {
  62             throw new \Exception('Model not favouritable');
  63         }
  64
  65         $modelInstance = $model->newQuery()
  66             ->where('id', '=', $modelInfo['id'])
  67             ->first(['id', 'name']);
  68
  69         $inaccessibleEntity = ($modelInstance instanceof Entity && !userCan('view', $modelInstance));
  70         if (is_null($modelInstance) || $inaccessibleEntity) {
  71             throw new \Exception('Model instance not found');
  72         }
  73
  74         return $modelInstance;
  75     }
  76 }