Added method for using enity ownership in relation queries

[bookstack] / app / helpers.php

diff --git a/app/helpers.php b/app/helpers.php
index c1d72b91da4fb7f5bb3efba3a2de46490ec3dce9..eb4e07a665ef2a62fe0efd879fc8830dc0105ffa 100644 (file)
--- a/app/helpers.php
+++ b/app/helpers.php
@@ -1,12 +1,13 @@
 <?php
 
 <?php
 

-use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\Permissions\PermissionApplicator;

 use BookStack\Auth\User;
 use BookStack\Model;
 use BookStack\Settings\SettingService;
 
 /**
  * Get the path to a versioned file.
 use BookStack\Auth\User;
 use BookStack\Model;
 use BookStack\Settings\SettingService;
 
 /**
  * Get the path to a versioned file.

+ *

  * @throws Exception
  */
 function versioned_asset(string $file = ''): string
  * @throws Exception
  */
 function versioned_asset(string $file = ''): string


@@ -24,6 +25,7 @@ function versioned_asset(string $file = ''): string
     }
 
     $path = $file . '?version=' . urlencode($version) . $additional;
     }
 
     $path = $file . '?version=' . urlencode($version) . $additional;

+

     return url($path);
 }
 
     return url($path);
 }
 


@@ -53,8 +55,9 @@ function hasAppAccess(): bool
 }
 
 /**
 }
 
 /**

- * Check if the current user has a permission. If an ownable element
- * is passed in the jointPermissions are checked against that particular item.
+ * Check if the current user has a permission.
+ * Checks a generic role permission or, if an ownable model is passed in, it will
+ * check against the given entity model, taking into account entity-level permissions.

  */
 function userCan(string $permission, Model $ownable = null): bool
 {
  */
 function userCan(string $permission, Model $ownable = null): bool
 {


@@ -63,22 +66,25 @@ function userCan(string $permission, Model $ownable = null): bool
     }
 
     // Check permission on ownable item
     }
 
     // Check permission on ownable item

-    $permissionService = app(PermissionService::class);
-    return $permissionService->checkOwnableUserAccess($ownable, $permission);
+    $permissions = app(PermissionApplicator::class);
+
+    return $permissions->checkOwnableUserAccess($ownable, $permission);

 }
 
 /**
 }
 
 /**

- * Check if the current user has the given permission
- * on any item in the system.
+ * Check if the current user can perform the given action on any items in the system.
+ * Can be provided the class name of an entity to filter ability to that specific entity type.

  */
  */

-function userCanOnAny(string $permission, string $entityClass = null): bool
+function userCanOnAny(string $action, string $entityClass = ''): bool

 {
 {

-    $permissionService = app(PermissionService::class);
-    return $permissionService->checkUserHasPermissionOnAnything($permission, $entityClass);
+    $permissions = app(PermissionApplicator::class);
+
+    return $permissions->checkUserHasEntityPermissionOnAny($action, $entityClass);

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

+ *

  * @return mixed|SettingService
  */
 function setting(string $key = null, $default = null)
  * @return mixed|SettingService
  */
 function setting(string $key = null, $default = null)


@@ -94,16 +100,18 @@ function setting(string $key = null, $default = null)
 
 /**
  * Get a path to a theme resource.
 
 /**
  * Get a path to a theme resource.

+ * Returns null if a theme is not configured and
+ * therefore a full path is not available for use.

  */
  */

-function theme_path(string $path = ''): string
+function theme_path(string $path = ''): ?string

 {
     $theme = config('view.theme');
 
     if (!$theme) {
 {
     $theme = config('view.theme');
 
     if (!$theme) {

-        return '';
+        return null;

     }
 
     }
 

-    return base_path('themes/' . $theme .($path ? DIRECTORY_SEPARATOR.$path : $path));
+    return base_path('themes/' . $theme . ($path ? DIRECTORY_SEPARATOR . $path : $path));

 }
 
 /**
 }
 
 /**


@@ -122,7 +130,7 @@ function icon(string $name, array $attrs = []): string
     ], $attrs);
     $attrString = ' ';
     foreach ($attrs as $attrName => $attr) {
     ], $attrs);
     $attrString = ' ';
     foreach ($attrs as $attrName => $attr) {

-        $attrString .=  $attrName . '="' . $attr . '" ';
+        $attrString .= $attrName . '="' . $attr . '" ';

     }
 
     $iconPath = resource_path('icons/' . $name . '.svg');
     }
 
     $iconPath = resource_path('icons/' . $name . '.svg');


@@ -130,11 +138,12 @@ function icon(string $name, array $attrs = []): string
 
     if ($themeIconPath && file_exists($themeIconPath)) {
         $iconPath = $themeIconPath;
 
     if ($themeIconPath && file_exists($themeIconPath)) {
         $iconPath = $themeIconPath;

-    } else if (!file_exists($iconPath)) {
+    } elseif (!file_exists($iconPath)) {

         return '';
     }
 
     $fileContents = file_get_contents($iconPath);
         return '';
     }
 
     $fileContents = file_get_contents($iconPath);

+

     return  str_replace('<svg', '<svg' . $attrString, $fileContents);
 }
 
     return  str_replace('<svg', '<svg' . $attrString, $fileContents);
 }