FilesExpand file tree

 master

/

helpers.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

191 lines (169 loc) · 4.84 KB

 master

/

helpers.php

Copy path

Top

File metadata and controls

• Code
• Blame

191 lines (169 loc) · 4.84 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

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

<?php

use BookStack\Auth\Permissions\PermissionService;

use BookStack\Auth\User;

use BookStack\Ownable;

use BookStack\Settings\SettingService;

/**

* Get the path to a versioned file.

*

* @param string $file

* @return string

* @throws Exception

*/

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

{

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

* @return bool

*/

function signedInUser(): bool

{

return auth()->user() && !auth()->user()->isDefault();

}

/**

* Check if the current user has general access.

* @return bool

*/

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.

* @param string $permission

* @param Ownable $ownable

* @return bool

*/

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

{

if ($ownable === null) {

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

}

// Check permission on ownable item

$permissionService = app(PermissionService::class);

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.

* @param string $key

* @param $default

* @return bool|string|SettingService

*/

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

{

$settingService = resolve(SettingService::class);

if (is_null($key)) {

return $settingService;

}

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

}

/**

* Get a path to a theme resource.

* @param string $path

* @return string

*/

function theme_path(string $path = ''): string

{

$theme = config('view.theme');

if (!$theme) {

return '';

}

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(string $name, array $attrs = []): string

{

$attrs = array_merge([

'class' => 'svg-icon',

'data-icon' => $name,

'role' => 'presentation',

], $attrs);

$attrString = ' ';

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

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

}

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

}

$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 string $path

* @param array $data

* @param array $overrideData

* @return string

*/

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

{

$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 url($path . '?' . implode('&', $queryStringSections));

}