]> BookStack Code Mirror - bookstack/blobdiff - app/helpers.php
Page Attachments - Improved UI, Now initially complete
[bookstack] / app / helpers.php
index 42e4c189476c8669a2d8bd336a7c9b84a7223df2..ad1c7dd20ce1b0a5f38ad7d9ce5b267d7f92f30c 100644 (file)
@@ -2,33 +2,48 @@
 
 use BookStack\Ownable;
 
-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);
-        }
+/**
+ * Get the path to a versioned file.
+ *
+ * @param  string $file
+ * @return string
+ * @throws Exception
+ */
+function versioned_asset($file = '')
+{
+    // Don't require css and JS assets for testing
+    if (config('app.env') === 'testing') return '';
 
-        if (isset($manifest[$file])) {
-            return '/' . $manifest[$file];
-        }
+    static $manifest = null;
+    $manifestPath = 'build/manifest.json';
 
-        if (file_exists(public_path($file))) {
-            return '/' . $file;
+    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);
+    }
 
-        throw new InvalidArgumentException("File {$file} not defined in asset manifest.");
+    if (isset($manifest[$file])) {
+        return baseUrl($manifest[$file]);
     }
+
+    throw new InvalidArgumentException("File {$file} not defined in asset manifest.");
+}
+
+/**
+ * Helper method to get the current User.
+ * Defaults to public 'Guest' user if not logged in.
+ * @return \BookStack\User
+ */
+function user()
+{
+    return auth()->user() ?: \BookStack\User::getDefault();
 }
 
 /**
@@ -42,7 +57,7 @@ if (!function_exists('versioned_asset')) {
 function userCan($permission, Ownable $ownable = null)
 {
     if ($ownable === null) {
-        return auth()->user() && auth()->user()->can($permission);
+        return user() && user()->can($permission);
     }
 
     // Check permission on ownable item
@@ -58,10 +73,58 @@ function userCan($permission, Ownable $ownable = null)
  */
 function setting($key, $default = false)
 {
-    $settingService = app('BookStack\Services\SettingService');
+    $settingService = app(\BookStack\Services\SettingService::class);
     return $settingService->get($key, $default);
 }
 
+/**
+ * Helper to create url's relative to the applications root path.
+ * @param string $path
+ * @param bool $forceAppDomain
+ * @return string
+ */
+function baseUrl($path, $forceAppDomain = false)
+{
+    $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);
+    }
+
+    return rtrim(config('app.url'), '/') . '/' . $path;
+}
+
+/**
+ * Get an instance of the redirector.
+ * Overrides the default laravel redirect helper.
+ * Ensures it redirects even when the app is in a subdirectory.
+ *
+ * @param  string|null  $to
+ * @param  int     $status
+ * @param  array   $headers
+ * @param  bool    $secure
+ * @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse
+ */
+function redirect($to = null, $status = 302, $headers = [], $secure = null)
+{
+    if (is_null($to)) {
+        return app('redirect');
+    }
+
+    $to = baseUrl($to);
+
+    return app('redirect')->to($to, $status, $headers, $secure);
+}
+
 /**
  * Generate a url with multiple parameters for sorting purposes.
  * Works out the logic to set the correct sorting direction
@@ -91,5 +154,5 @@ function sortUrl($path, $data, $overrideData = [])
 
     if (count($queryStringSections) === 0) return $path;
 
-    return $path . '?' . implode('&', $queryStringSections);
+    return baseUrl($path . '?' . implode('&', $queryStringSections));
 }
\ No newline at end of file