X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/43d9d2eba76528dc1bcaccb6896b110faa920cff..refs/pull/717/head:/app/helpers.php diff --git a/app/helpers.php b/app/helpers.php index 541f23fbe..50b41ec05 100644 --- a/app/helpers.php +++ b/app/helpers.php @@ -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); - } - - if (isset($manifest[$file])) { - return baseUrl($manifest[$file]); - } +/** + * Get the path to a versioned file. + * + * @param string $file + * @return string + * @throws Exception + */ +function versioned_asset($file = '') +{ + static $version = null; - if (file_exists(public_path($file))) { - return baseUrl($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 baseUrl($path); +} + +/** + * 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(); +} + +/** + * Check if current user is a signed in user. + * @return bool + */ +function signedInUser() +{ + return auth()->user() && !auth()->user()->isDefault(); } /** @@ -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 @@ -54,23 +69,42 @@ function userCan($permission, Ownable $ownable = null) * Helper to access system settings. * @param $key * @param bool $default - * @return mixed + * @return bool|string|\BookStack\Services\SettingService */ -function setting($key, $default = false) +function setting($key = null, $default = false) { - $settingService = app('BookStack\Services\SettingService'); + $settingService = resolve(\BookStack\Services\SettingService::class); + if (is_null($key)) { + return $settingService; + } return $settingService->get($key, $default); } /** * Helper to create url's relative to the applications root path. - * @param $path + * @param string $path + * @param bool $forceAppDomain * @return string */ -function baseUrl($path) +function baseUrl($path, $forceAppDomain = false) { - if (strpos($path, 'http') === 0) return $path; + $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; } @@ -96,6 +130,54 @@ function redirect($to = null, $status = 302, $headers = [], $secure = null) return app('redirect')->to($to, $status, $headers, $secure); } +/** + * Get a path to a theme resource. + * @param string $path + * @return string|boolean + */ +function theme_path($path = '') +{ + $theme = config('view.theme'); + if (!$theme) { + return false; + } + + 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. + * @param $name + * @param array $attrs + * @return mixed + */ +function icon($name, $attrs = []) +{ + $attrs = array_merge([ + 'class' => 'svg-icon', + 'data-icon' => $name + ], $attrs); + $attrString = ' '; + foreach ($attrs as $attrName => $attr) { + $attrString .= $attrName . '="' . $attr . '" '; + } + + $iconPath = resource_path('assets/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(' $value) { $trimmedVal = trim($value); - if ($trimmedVal === '') continue; + if ($trimmedVal === '') { + continue; + } $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 +}