BookStack Code Mirror - bookstack/blob - app/helpers.php

   1 <?php
   2
   3 use BookStack\Ownable;
   4
   5 if (!function_exists('versioned_asset')) {
   6     /**
   7      * Get the path to a versioned file.
   8      *
   9      * @param  string $file
  10      * @return string
  11      *
  12      * @throws \InvalidArgumentException
  13      */
  14     function versioned_asset($file)
  15     {
  16         static $manifest = null;
  17
  18         if (is_null($manifest)) {
  19             $manifest = json_decode(file_get_contents(public_path('build/manifest.json')), true);
  20         }
  21
  22         if (isset($manifest[$file])) {
  23             return baseUrl($manifest[$file]);
  24         }
  25
  26         if (file_exists(public_path($file))) {
  27             return baseUrl($file);
  28         }
  29
  30         throw new InvalidArgumentException("File {$file} not defined in asset manifest.");
  31     }
  32 }
  33
  34 /**
  35  * Check if the current user has a permission.
  36  * If an ownable element is passed in the jointPermissions are checked against
  37  * that particular item.
  38  * @param $permission
  39  * @param Ownable $ownable
  40  * @return mixed
  41  */
  42 function userCan($permission, Ownable $ownable = null)
  43 {
  44     if ($ownable === null) {
  45         return auth()->user() && auth()->user()->can($permission);
  46     }
  47
  48     // Check permission on ownable item
  49     $permissionService = app(\BookStack\Services\PermissionService::class);
  50     return $permissionService->checkOwnableUserAccess($ownable, $permission);
  51 }
  52
  53 /**
  54  * Helper to access system settings.
  55  * @param $key
  56  * @param bool $default
  57  * @return mixed
  58  */
  59 function setting($key, $default = false)
  60 {
  61     $settingService = app('BookStack\Services\SettingService');
  62     return $settingService->get($key, $default);
  63 }
  64
  65 /**
  66  * Helper to create url's relative to the applications root path.
  67  * @param string $path
  68  * @param bool $forceAppDomain
  69  * @return string
  70  */
  71 function baseUrl($path, $forceAppDomain = false)
  72 {
  73     $isFullUrl = strpos($path, 'http') === 0;
  74     if ($isFullUrl && !$forceAppDomain) return $path;
  75     $path = trim($path, '/');
  76
  77     if ($isFullUrl && $forceAppDomain) {
  78         $explodedPath = explode('/', $path);
  79         $path = implode('/', array_splice($explodedPath, 3));
  80     }
  81
  82     return rtrim(config('app.url'), '/') . '/' . $path;
  83 }
  84
  85 /**
  86  * Get an instance of the redirector.
  87  * Overrides the default laravel redirect helper.
  88  * Ensures it redirects even when the app is in a subdirectory.
  89  *
  90  * @param  string|null  $to
  91  * @param  int     $status
  92  * @param  array   $headers
  93  * @param  bool    $secure
  94  * @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse
  95  */
  96 function redirect($to = null, $status = 302, $headers = [], $secure = null)
  97 {
  98     if (is_null($to)) {
  99         return app('redirect');
 100     }
 101
 102     $to = baseUrl($to);
 103
 104     return app('redirect')->to($to, $status, $headers, $secure);
 105 }
 106
 107 /**
 108  * Generate a url with multiple parameters for sorting purposes.
 109  * Works out the logic to set the correct sorting direction
 110  * Discards empty parameters and allows overriding.
 111  * @param $path
 112  * @param array $data
 113  * @param array $overrideData
 114  * @return string
 115  */
 116 function sortUrl($path, $data, $overrideData = [])
 117 {
 118     $queryStringSections = [];
 119     $queryData = array_merge($data, $overrideData);
 120
 121     // Change sorting direction is already sorted on current attribute
 122     if (isset($overrideData['sort']) && $overrideData['sort'] === $data['sort']) {
 123         $queryData['order'] = ($data['order'] === 'asc') ? 'desc' : 'asc';
 124     } else {
 125         $queryData['order'] = 'asc';
 126     }
 127
 128     foreach ($queryData as $name => $value) {
 129         $trimmedVal = trim($value);
 130         if ($trimmedVal === '') continue;
 131         $queryStringSections[] = urlencode($name) . '=' . urlencode($trimmedVal);
 132     }
 133
 134     if (count($queryStringSections) === 0) return $path;
 135
 136     return baseUrl($path . '?' . implode('&', $queryStringSections));
 137 }