FilesExpand file tree

 master

/

helpers.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

169 lines (146 loc) · 4.48 KB

 master

/

helpers.php

Copy path

Top

File metadata and controls

• Code
• Blame

169 lines (146 loc) · 4.48 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

<?php

use BookStack\Ownable;

/**

* Get the path to a versioned file.

*

* @param string $file

* @return string

* @throws Exception

*/

function versioned_asset($file = '')

{

static $version = null;

if (is_null($version)) {

$versionFile = base_path('version');

$version = trim(file_get_contents($versionFile));

}

$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();

}

/**

* 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)

{

if ($ownable === null) {

return user() && user()->can($permission);

}

// Check permission on ownable item

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

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

}

/**

* Helper to access system settings.

* @param $key

* @param bool $default

* @return bool|string|\BookStack\Services\SettingService

*/

function setting($key = null, $default = false)

{

$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 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);

}

function icon($name, $attrs = []) {

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

$attrString = ' ';

foreach ($attrs as $attrName => $attr) {

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

}

$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.

* @param $path

* @param array $data

* @param array $overrideData

* @return string

*/

function sortUrl($path, $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';

}

foreach ($queryData as $name => $value) {

$trimmedVal = trim($value);

if ($trimmedVal === '') continue;

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

}

if (count($queryStringSections) === 0) return $path;

return baseUrl($path . '?' . implode('&', $queryStringSections));

}