Replace node-sass with dart-sass

[bookstack] / app / helpers.php

diff --git a/app/helpers.php b/app/helpers.php
index dd835fbf64755adb17a0568902cff00cd7a75c4f..65da1853b54e54bb43a8cb8fe5d9959a3a877578 100644 (file)
--- a/app/helpers.php
+++ b/app/helpers.php
@@ -1,6 +1,9 @@
 <?php
 
 <?php
 

+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\User;

 use BookStack\Ownable;
 use BookStack\Ownable;

+use BookStack\Settings\SettingService;

 
 /**
  * Get the path to a versioned file.
 
 /**
  * Get the path to a versioned file.


@@ -9,140 +12,175 @@ use BookStack\Ownable;
  * @return string
  * @throws Exception
  */
  * @return string
  * @throws Exception
  */

-function versioned_asset($file = '')
+function versioned_asset(string $file = ''): string

 {
 {

-    // Don't require css and JS assets for testing
-    if (config('app.env') === 'testing') return '';
-
-    static $manifest = null;
-    $manifestPath = 'build/manifest.json';
-
-    if (is_null($manifest) && file_exists($manifestPath)) {
-        $manifest = json_decode(file_get_contents(public_path($manifestPath)), true);
-    } else if (!file_exists($manifestPath)) {
-        if (config('app.env') !== 'production') {
-            $path = public_path($manifestPath);
-            $error = "No {$path} file found, Ensure you have built the css/js assets using gulp.";
-        } else {
-            $error = "No {$manifestPath} file found, Ensure you are using the release version of BookStack";
-        }
-        throw new \Exception($error);
+    static $version = null;
+
+    if (is_null($version)) {
+        $versionFile = base_path('version');
+        $version = trim(file_get_contents($versionFile));

     }
 
     }
 

-    if (isset($manifest[$file])) {
-        return baseUrl($manifest[$file]);
+    $additional = '';
+    if (config('app.env') === 'development') {
+        $additional = sha1_file(public_path($file));

     }
 
     }
 

-    throw new InvalidArgumentException("File {$file} not defined in asset manifest.");
+    $path = $file . '?version=' . urlencode($version) . $additional;
+    return url($path);
+}
+
+/**
+ * Helper method to get the current User.
+ * Defaults to public 'Guest' user if not logged in.
+ * @return User
+ */
+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.
 }
 
 /**
  * Check if the current user has a permission.
  * If an ownable element is passed in the jointPermissions are checked against
  * that particular item.

- * @param $permission
- * @param Ownable $ownable
- * @return mixed

  */
  */

-function userCan($permission, Ownable $ownable = null)
+function userCan(string $permission, Ownable $ownable = null): bool

 {
     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

-    $permissionService = app(\BookStack\Services\PermissionService::class);
+    $permissionService = app(PermissionService::class);

     return $permissionService->checkOwnableUserAccess($ownable, $permission);
 }
 
     return $permissionService->checkOwnableUserAccess($ownable, $permission);
 }
 

+/**
+ * Check if the current user has the given permission
+ * on any item in the system.
+ * @param string $permission
+ * @param string|null $entityClass
+ * @return bool
+ */
+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
+ * @param string $key
+ * @param $default
+ * @return bool|string|SettingService

  */
  */

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

 {
 {

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

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

- * Helper to create url's relative to the applications root path.
+ * Get a path to a theme resource.

  * @param string $path
  * @param string $path

- * @param bool $forceAppDomain

  * @return string
  */
  * @return string
  */

-function baseUrl($path, $forceAppDomain = false)
+function theme_path(string $path = ''): string

 {
 {

-    $isFullUrl = strpos($path, 'http') === 0;
-    if ($isFullUrl && !$forceAppDomain) return $path;
-    $path = trim($path, '/');
-
-    // Remove non-specified domain if forced and we have a domain
-    if ($isFullUrl && $forceAppDomain) {
-        $explodedPath = explode('/', $path);
-        $path = implode('/', array_splice($explodedPath, 3));
-    }
-
-    // Return normal url path if not specified in config
-    if (config('app.url') === '') {
-        return url($path);
+    $theme = config('view.theme');
+    if (!$theme) {
+        return '';

     }
 
     }
 

-    return rtrim(config('app.url'), '/') . '/' . $path;
+    return base_path('themes/' . $theme .($path ? DIRECTORY_SEPARATOR.$path : $path));

 }
 
 /**
 }
 
 /**

- * Get an instance of the redirector.
- * Overrides the default laravel redirect helper.
- * Ensures it redirects even when the app is in a subdirectory.
+ * 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.

  *
  *

- * @param  string|null  $to
- * @param  int     $status
- * @param  array   $headers
- * @param  bool    $secure
- * @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse
+ * Returns an empty string if icon file not found.
+ * @param $name
+ * @param array $attrs
+ * @return mixed

  */
  */

-function redirect($to = null, $status = 302, $headers = [], $secure = null)
+function icon(string $name, array $attrs = []): string

 {
 {

-    if (is_null($to)) {
-        return app('redirect');
+    $attrs = array_merge([
+        'class'     => 'svg-icon',
+        'data-icon' => $name,
+        'role'      => 'presentation',
+    ], $attrs);
+    $attrString = ' ';
+    foreach ($attrs as $attrName => $attr) {
+        $attrString .=  $attrName . '="' . $attr . '" ';

     }
 
     }
 

-    $to = baseUrl($to);
+    $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 '';
+    }

 
 

-    return app('redirect')->to($to, $status, $headers, $secure);
+    $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.
 }
 
 /**
  * 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.

- * @param $path
+ * @param string $path

  * @param array $data
  * @param array $overrideData
  * @return string
  */
  * @param array $data
  * @param array $overrideData
  * @return string
  */

-function sortUrl($path, $data, $overrideData = [])
+function sortUrl(string $path, array $data, array $overrideData = []): string

 {
     $queryStringSections = [];
     $queryData = array_merge($data, $overrideData);
 {
     $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';
     } else {
         $queryData['order'] = 'asc';
     }
     // Change sorting direction is already sorted on current attribute
     if (isset($overrideData['sort']) && $overrideData['sort'] === $data['sort']) {
         $queryData['order'] = ($data['order'] === 'asc') ? 'desc' : 'asc';
     } else {
         $queryData['order'] = 'asc';
     }

-    
+

     foreach ($queryData as $name => $value) {
         $trimmedVal = trim($value);
     foreach ($queryData as $name => $value) {
         $trimmedVal = trim($value);

-        if ($trimmedVal === '') continue;
+        if ($trimmedVal === '') {
+            continue;
+        }

         $queryStringSections[] = urlencode($name) . '=' . urlencode($trimmedVal);
     }
 
         $queryStringSections[] = urlencode($name) . '=' . urlencode($trimmedVal);
     }
 

-    if (count($queryStringSections) === 0) return $path;
+    if (count($queryStringSections) === 0) {
+        return $path;
+    }

 
 

-    return baseUrl($path . '?' . implode('&', $queryStringSections));
-}
\ No newline at end of file
+    return url($path . '?' . implode('&', $queryStringSections));
+}