Improve sorting Shelf Books

[bookstack] / app / helpers.php

diff --git a/app/helpers.php b/app/helpers.php
index 582e4e03ad56242ffabcfd1f11d5537be90ac938..c090bfd055acc400e1ad4c46e7059b6c19820f60 100644 (file)
--- a/app/helpers.php
+++ b/app/helpers.php
@@ -1,62 +1,171 @@
 <?php
 
 <?php
 

-if (!function_exists('versioned_asset')) {
-    /**
-     * Get the path to a versioned file.
-     *
-     * @param  string $file
-     * @return string
-     *
-     * @throws \InvalidArgumentException
-     */
-    function versioned_asset($file)
-    {
-        static $manifest = null;
-
-        if (is_null($manifest)) {
-            $manifest = json_decode(file_get_contents(public_path('build/manifest.json')), true);
-        }
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\User;
+use BookStack\Model;
+use BookStack\Settings\SettingService;

 
 

-        if (isset($manifest[$file])) {
-            return '/' . $manifest[$file];
-        }
+/**
+ * Get the path to a versioned file.
+ * @throws Exception
+ */
+function versioned_asset(string $file = ''): string
+{
+    static $version = null;

 
 

-        if (file_exists(public_path($file))) {
-            return '/' . $file;
-        }
+    if (is_null($version)) {
+        $versionFile = base_path('version');
+        $version = trim(file_get_contents($versionFile));
+    }

 
 

-        throw new InvalidArgumentException("File {$file} not defined in asset manifest.");
+    $additional = '';
+    if (config('app.env') === 'development') {
+        $additional = sha1_file(public_path($file));

     }
     }

+
+    $path = $file . '?version=' . urlencode($version) . $additional;
+    return url($path);

 }
 
 /**
 }
 
 /**

- * Check if the current user has a permission.
- * If an ownable element is passed in the permissions are checked against
- * that particular item.
- * @param $permission
- * @param \BookStack\Ownable $ownable
- * @return mixed
+ * Helper method to get the current User.
+ * Defaults to public 'Guest' user if not logged in.

  */
  */

-function userCan($permission, \BookStack\Ownable $ownable = null)
+function user(): User
+{
+    return auth()->user() ?: User::getDefault();
+}
+
+/**
+ * Check if current user is a signed in user.
+ */
+function signedInUser(): bool
+{
+    return auth()->user() && !auth()->user()->isDefault();
+}
+
+/**
+ * Check if the current user has general access.
+ */
+function hasAppAccess(): bool
+{
+    return !auth()->guest() || setting('app-public');
+}
+
+/**
+ * Check if the current user has a permission. If an ownable element
+ * is passed in the jointPermissions are checked against that particular item.
+ */
+function userCan(string $permission, Model $ownable = null): bool

 {
 {

-    if (!auth()->check()) return false;

     if ($ownable === null) {
     if ($ownable === null) {

-        return auth()->user() && auth()->user()->can($permission);
+        return user() && user()->can($permission);

     }
 
     // Check permission on ownable item
     }
 
     // Check permission on ownable item

-    $restrictionService = app('BookStack\Services\RestrictionService');
-    return $restrictionService->checkEntityUserAccess($ownable, $permission);
+    $permissionService = app(PermissionService::class);
+    return $permissionService->checkOwnableUserAccess($ownable, $permission);
+}
+
+/**
+ * Check if the current user has the given permission
+ * on any item in the system.
+ */
+function userCanOnAny(string $permission, string $entityClass = null): bool
+{
+    $permissionService = app(PermissionService::class);
+    return $permissionService->checkUserHasPermissionOnAnything($permission, $entityClass);

 }
 
 /**
  * Helper to access system settings.
 }
 
 /**
  * Helper to access system settings.

- * @param $key
- * @param bool $default
- * @return mixed
+ * @return bool|string|SettingService

  */
  */

-function setting($key, $default = false)
+function setting(string $key = null, $default = false)

 {
 {

-    $settingService = app('BookStack\Services\SettingService');
+    $settingService = resolve(SettingService::class);
+
+    if (is_null($key)) {
+        return $settingService;
+    }
+

     return $settingService->get($key, $default);
 }
     return $settingService->get($key, $default);
 }

+
+/**
+ * Get a path to a theme resource.
+ */
+function theme_path(string $path = ''): string
+{
+    $theme = config('view.theme');
+
+    if (!$theme) {
+        return '';
+    }
+
+    return base_path('themes/' . $theme .($path ? DIRECTORY_SEPARATOR.$path : $path));
+}
+
+/**
+ * Get fetch an SVG icon as a string.
+ * Checks for icons defined within a custom theme before defaulting back
+ * to the 'resources/assets/icons' folder.
+ *
+ * Returns an empty string if icon file not found.
+ */
+function icon(string $name, array $attrs = []): string
+{
+    $attrs = array_merge([
+        'class'     => 'svg-icon',
+        'data-icon' => $name,
+        'role'      => 'presentation',
+    ], $attrs);
+    $attrString = ' ';
+    foreach ($attrs as $attrName => $attr) {
+        $attrString .=  $attrName . '="' . $attr . '" ';
+    }
+
+    $iconPath = resource_path('icons/' . $name . '.svg');
+    $themeIconPath = theme_path('icons/' . $name . '.svg');
+
+    if ($themeIconPath && file_exists($themeIconPath)) {
+        $iconPath = $themeIconPath;
+    } else if (!file_exists($iconPath)) {
+        return '';
+    }
+
+    $fileContents = file_get_contents($iconPath);
+    return  str_replace('<svg', '<svg' . $attrString, $fileContents);
+}
+
+/**
+ * Generate a url with multiple parameters for sorting purposes.
+ * Works out the logic to set the correct sorting direction
+ * Discards empty parameters and allows overriding.
+ */
+function sortUrl(string $path, array $data, array $overrideData = []): string
+{
+    $queryStringSections = [];
+    $queryData = array_merge($data, $overrideData);
+
+    // Change sorting direction is already sorted on current attribute
+    if (isset($overrideData['sort']) && $overrideData['sort'] === $data['sort']) {
+        $queryData['order'] = ($data['order'] === 'asc') ? 'desc' : 'asc';
+    } elseif (isset($overrideData['sort'])) {
+        $queryData['order'] = 'asc';
+    }
+
+    foreach ($queryData as $name => $value) {
+        $trimmedVal = trim($value);
+        if ($trimmedVal === '') {
+            continue;
+        }
+        $queryStringSections[] = urlencode($name) . '=' . urlencode($trimmedVal);
+    }
+
+    if (count($queryStringSections) === 0) {
+        return $path;
+    }
+
+    return url($path . '?' . implode('&', $queryStringSections));
+}