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
|
<?php
/**
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCA\Files_External\Lib;
use \OCA\Files_External\Service\BackendService;
/**
* Trait to implement backend and auth mechanism permissions
*
* For user type constants, see BackendService::USER_*
* For permission constants, see BackendService::PERMISSION_*
*/
trait PermissionsTrait {
/** @var array [user type => permissions] */
protected $permissions = [
BackendService::USER_PERSONAL => BackendService::PERMISSION_DEFAULT,
BackendService::USER_ADMIN => BackendService::PERMISSION_DEFAULT,
];
/** @var array [user type => allowed permissions] */
protected $allowedPermissions = [
BackendService::USER_PERSONAL => BackendService::PERMISSION_DEFAULT,
BackendService::USER_ADMIN => BackendService::PERMISSION_DEFAULT,
];
/**
* @param string $userType
* @return int
*/
public function getPermissions($userType) {
if (isset($this->permissions[$userType])) {
return $this->permissions[$userType];
}
return BackendService::PERMISSION_NONE;
}
/**
* Check if the user type has permission
*
* @param string $userType
* @param int $permission
* @return bool
*/
public function isPermitted($userType, $permission) {
if ($this->getPermissions($userType) & $permission) {
return true;
}
return false;
}
/**
* @param string $userType
* @param int $permissions
* @return self
*/
public function setPermissions($userType, $permissions) {
$this->permissions[$userType] = $permissions;
$this->allowedPermissions[$userType] =
$this->getAllowedPermissions($userType) | $permissions;
return $this;
}
/**
* @param string $userType
* @param int $permission
* @return self
*/
public function addPermission($userType, $permission) {
return $this->setPermissions($userType,
$this->getPermissions($userType) | $permission
);
}
/**
* @param string $userType
* @param int $permission
* @return self
*/
public function removePermission($userType, $permission) {
return $this->setPermissions($userType,
$this->getPermissions($userType) & ~$permission
);
}
/**
* @param string $userType
* @return int
*/
public function getAllowedPermissions($userType) {
if (isset($this->allowedPermissions[$userType])) {
return $this->allowedPermissions[$userType];
}
return BackendService::PERMISSION_NONE;
}
/**
* Check if the user type has an allowed permission
*
* @param string $userType
* @param int $permission
* @return bool
*/
public function isAllowedPermitted($userType, $permission) {
if ($this->getAllowedPermissions($userType) & $permission) {
return true;
}
return false;
}
/**
* @param string $userType
* @param int $permissions
* @return self
*/
public function setAllowedPermissions($userType, $permissions) {
$this->allowedPermissions[$userType] = $permissions;
$this->permissions[$userType] =
$this->getPermissions($userType) & $permissions;
return $this;
}
/**
* @param string $userType
* @param int $permission
* @return self
*/
public function addAllowedPermission($userType, $permission) {
return $this->setAllowedPermissions($userType,
$this->getAllowedPermissions($userType) | $permission
);
}
/**
* @param string $userType
* @param int $permission
* @return self
*/
public function removeAllowedPermission($userType, $permission) {
return $this->setAllowedPermissions($userType,
$this->getAllowedPermissions($userType) & ~$permission
);
}
}
|
