Re-structured the app code to be feature based rather than code type based

2025-08-06 12:02:45 +03:00 · 2018-09-25 12:30:50 +01:00
parent 19751ed1cb
commit 919660678b
109 changed files with 684 additions and 531 deletions
--- a/app/Actions/ViewService.php
+++ b/app/Actions/ViewService.php
@@ -0,0 +1,109 @@
+<?php namespace BookStack\Actions;
+
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Entities\Entity;
+
+class ViewService
+{
+    protected $view;
+    protected $permissionService;
+
+    /**
+     * ViewService constructor.
+     * @param \BookStack\Actions\View $view
+     * @param \BookStack\Auth\Permissions\PermissionService $permissionService
+     */
+    public function __construct(View $view, PermissionService $permissionService)
+    {
+        $this->view = $view;
+        $this->permissionService = $permissionService;
+    }
+
+    /**
+     * Add a view to the given entity.
+     * @param Entity $entity
+     * @return int
+     */
+    public function add(Entity $entity)
+    {
+        $user = user();
+        if ($user === null || $user->isDefault()) {
+            return 0;
+        }
+        $view = $entity->views()->where('user_id', '=', $user->id)->first();
+        // Add view if model exists
+        if ($view) {
+            $view->increment('views');
+            return $view->views;
+        }
+
+        // Otherwise create new view count
+        $entity->views()->save($this->view->create([
+            'user_id' => $user->id,
+            'views' => 1
+        ]));
+
+        return 1;
+    }
+
+    /**
+     * Get the entities with the most views.
+     * @param int $count
+     * @param int $page
+     * @param Entity|false|array $filterModel
+     * @param string $action - used for permission checking
+     * @return
+     */
+    public function getPopular($count = 10, $page = 0, $filterModel = false, $action = 'view')
+    {
+        // TODO - Standardise input filter
+        $skipCount = $count * $page;
+        $query = $this->permissionService->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type', $action)
+            ->select('*', 'viewable_id', 'viewable_type', \DB::raw('SUM(views) as view_count'))
+            ->groupBy('viewable_id', 'viewable_type')
+            ->orderBy('view_count', 'desc');
+
+        if ($filterModel && is_array($filterModel)) {
+            $query->whereIn('viewable_type', $filterModel);
+        } else if ($filterModel) {
+            $query->where('viewable_type', '=', $filterModel->getMorphClass());
+        }
+
+        return $query->with('viewable')->skip($skipCount)->take($count)->get()->pluck('viewable');
+    }
+
+    /**
+     * Get all recently viewed entities for the current user.
+     * @param int $count
+     * @param int $page
+     * @param Entity|bool $filterModel
+     * @return mixed
+     */
+    public function getUserRecentlyViewed($count = 10, $page = 0, $filterModel = false)
+    {
+        $user = user();
+        if ($user === null || $user->isDefault()) {
+            return collect();
+        }
+
+        $query = $this->permissionService
+            ->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type');
+
+        if ($filterModel) {
+            $query = $query->where('viewable_type', '=', $filterModel->getMorphClass());
+        }
+        $query = $query->where('user_id', '=', $user->id);
+
+        $viewables = $query->with('viewable')->orderBy('updated_at', 'desc')
+            ->skip($count * $page)->take($count)->get()->pluck('viewable');
+        return $viewables;
+    }
+
+    /**
+     * Reset all view counts by deleting all views.
+     */
+    public function resetAll()
+    {
+        $this->view->truncate();
+    }
+}