BookStack Code Mirror - bookstack/blob - app/App/HomeController.php

   1 <?php
   2
   3 namespace BookStack\App;
   4
   5 use BookStack\Activity\ActivityQueries;
   6 use BookStack\Entities\Models\Page;
   7 use BookStack\Entities\Queries\EntityQueries;
   8 use BookStack\Entities\Queries\RecentlyViewed;
   9 use BookStack\Entities\Queries\TopFavourites;
  10 use BookStack\Entities\Tools\PageContent;
  11 use BookStack\Http\Controller;
  12 use BookStack\Uploads\FaviconHandler;
  13 use BookStack\Util\SimpleListOptions;
  14 use Illuminate\Http\Request;
  15
  16 class HomeController extends Controller
  17 {
  18     public function __construct(
  19         protected EntityQueries $queries,
  20     ) {
  21     }
  22
  23     /**
  24      * Display the homepage.
  25      */
  26     public function index(Request $request, ActivityQueries $activities)
  27     {
  28         $activity = $activities->latest(10);
  29         $draftPages = [];
  30
  31         if ($this->isSignedIn()) {
  32             $draftPages = $this->queries->pages->currentUserDraftsForList()
  33                 ->orderBy('updated_at', 'desc')
  34                 ->with('book')
  35                 ->take(6)
  36                 ->get();
  37         }
  38
  39         $recentFactor = count($draftPages) > 0 ? 0.5 : 1;
  40         $recents = $this->isSignedIn() ?
  41             (new RecentlyViewed())->run(12 * $recentFactor, 1)
  42             : $this->queries->books->visibleForList()->orderBy('created_at', 'desc')->take(12 * $recentFactor)->get();
  43         $favourites = (new TopFavourites())->run(6);
  44         $recentlyUpdatedPages = $this->queries->pages->visibleForList()
  45             ->where('draft', false)
  46             ->orderBy('updated_at', 'desc')
  47             ->take($favourites->count() > 0 ? 5 : 10)
  48             ->get();
  49
  50         $homepageOptions = ['default', 'books', 'bookshelves', 'page'];
  51         $homepageOption = setting('app-homepage-type', 'default');
  52         if (!in_array($homepageOption, $homepageOptions)) {
  53             $homepageOption = 'default';
  54         }
  55
  56         $commonData = [
  57             'activity'             => $activity,
  58             'recents'              => $recents,
  59             'recentlyUpdatedPages' => $recentlyUpdatedPages,
  60             'draftPages'           => $draftPages,
  61             'favourites'           => $favourites,
  62         ];
  63
  64         // Add required list ordering & sorting for books & shelves views.
  65         if ($homepageOption === 'bookshelves' || $homepageOption === 'books') {
  66             $key = $homepageOption;
  67             $view = setting()->getForCurrentUser($key . '_view_type');
  68             $listOptions = SimpleListOptions::fromRequest($request, $key)->withSortOptions([
  69                 'name' => trans('common.sort_name'),
  70                 'created_at' => trans('common.sort_created_at'),
  71                 'updated_at' => trans('common.sort_updated_at'),
  72             ]);
  73
  74             $commonData = array_merge($commonData, [
  75                 'view'        => $view,
  76                 'listOptions' => $listOptions,
  77             ]);
  78         }
  79
  80         if ($homepageOption === 'bookshelves') {
  81             $shelves = $this->queries->shelves->visibleForListWithCover()
  82                 ->orderBy($commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder())
  83                 ->paginate(18);
  84             $data = array_merge($commonData, ['shelves' => $shelves]);
  85
  86             return view('home.shelves', $data);
  87         }
  88
  89         if ($homepageOption === 'books') {
  90             $books = $this->queries->books->visibleForListWithCover()
  91                 ->orderBy($commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder())
  92                 ->paginate(18);
  93             $data = array_merge($commonData, ['books' => $books]);
  94
  95             return view('home.books', $data);
  96         }
  97
  98         if ($homepageOption === 'page') {
  99             $homepageSetting = setting('app-homepage', '0:');
 100             $id = intval(explode(':', $homepageSetting)[0]);
 101             /** @var Page $customHomepage */
 102             $customHomepage = $this->queries->pages->start()->where('draft', '=', false)->findOrFail($id);
 103             $pageContent = new PageContent($customHomepage);
 104             $customHomepage->html = $pageContent->render(false);
 105
 106             return view('home.specific-page', array_merge($commonData, ['customHomepage' => $customHomepage]));
 107         }
 108
 109         return view('home.default', $commonData);
 110     }
 111
 112     /**
 113      * Show the view for /robots.txt.
 114      */
 115     public function robots()
 116     {
 117         $sitePublic = setting('app-public', false);
 118         $allowRobots = config('app.allow_robots');
 119
 120         if ($allowRobots === null) {
 121             $allowRobots = $sitePublic;
 122         }
 123
 124         return response()
 125             ->view('misc.robots', ['allowRobots' => $allowRobots])
 126             ->header('Content-Type', 'text/plain');
 127     }
 128
 129     /**
 130      * Show the route for 404 responses.
 131      */
 132     public function notFound()
 133     {
 134         return response()->view('errors.404', [], 404);
 135     }
 136
 137     /**
 138      * Serve the application favicon.
 139      * Ensures a 'favicon.ico' file exists at the web root location (if writable) to be served
 140      * directly by the webserver in the future.
 141      */
 142     public function favicon(FaviconHandler $favicons)
 143     {
 144         $exists = $favicons->restoreOriginalIfNotExists();
 145         return response()->file($exists ? $favicons->getPath() : $favicons->getOriginalPath());
 146     }
 147
 148     /**
 149      * Serve a PWA application manifest.
 150      */
 151     public function pwaManifest(PwaManifestBuilder $manifestBuilder)
 152     {
 153         return response()->json($manifestBuilder->build());
 154     }
 155 }