|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace NerdsAndCompany\Schematic\Services; |
|
4
|
|
|
|
|
5
|
|
|
use Craft\Craft; |
|
6
|
|
|
use Craft\UserGroupModel; |
|
7
|
|
|
|
|
8
|
|
|
/** |
|
9
|
|
|
* Schematic User Groups Service. |
|
10
|
|
|
* |
|
11
|
|
|
* Sync Craft Setups. |
|
12
|
|
|
* |
|
13
|
|
|
* @author Nerds & Company |
|
14
|
|
|
* @copyright Copyright (c) 2015-2017, Nerds & Company |
|
15
|
|
|
* @license MIT |
|
16
|
|
|
* |
|
17
|
|
|
* @link http://www.nerds.company |
|
18
|
|
|
*/ |
|
19
|
|
|
class UserGroups extends Base |
|
20
|
|
|
{ |
|
21
|
|
|
/** @var string[] */ |
|
22
|
|
|
private $mappedPermissions = []; |
|
23
|
|
|
|
|
24
|
|
|
//============================================================================================================== |
|
25
|
|
|
//================================================ EXPORT ==================================================== |
|
26
|
|
|
//============================================================================================================== |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* Export user groups. |
|
30
|
|
|
* |
|
31
|
|
|
* @param UserGroupModel[] $groups |
|
32
|
|
|
* |
|
33
|
|
|
* @return array |
|
34
|
|
|
*/ |
|
35
|
4 |
|
public function export(array $groups = []) |
|
36
|
|
|
{ |
|
37
|
4 |
|
Craft::log(Craft::t('Exporting User Groups')); |
|
38
|
|
|
|
|
39
|
4 |
|
$groupDefinitions = []; |
|
40
|
|
|
|
|
41
|
4 |
|
$this->mappedPermissions = $this->getAllMappedPermissions(); |
|
42
|
|
|
|
|
43
|
4 |
|
foreach ($groups as $group) { |
|
44
|
3 |
|
$groupDefinitions[$group->handle] = $this->getGroupDefinition($group); |
|
45
|
4 |
|
} |
|
46
|
|
|
|
|
47
|
4 |
|
return $groupDefinitions; |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
/** |
|
51
|
|
|
* Get group definition. |
|
52
|
|
|
* |
|
53
|
|
|
* @param UserGroupModel $group |
|
54
|
|
|
* |
|
55
|
|
|
* @return array |
|
56
|
|
|
*/ |
|
57
|
3 |
|
private function getGroupDefinition(UserGroupModel $group) |
|
58
|
|
|
{ |
|
59
|
|
|
return [ |
|
60
|
3 |
|
'name' => $group->name, |
|
61
|
3 |
|
'permissions' => $this->getGroupPermissionDefinitions($group), |
|
62
|
3 |
|
]; |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* Get group permissions. |
|
67
|
|
|
* |
|
68
|
|
|
* @param $group |
|
69
|
|
|
* |
|
70
|
|
|
* @return array|string |
|
71
|
|
|
*/ |
|
72
|
3 |
|
private function getGroupPermissionDefinitions($group) |
|
73
|
|
|
{ |
|
74
|
3 |
|
$permissionDefinitions = []; |
|
75
|
3 |
|
$groupPermissions = Craft::app()->userPermissions->getPermissionsByGroupId($group->id); |
|
76
|
|
|
|
|
77
|
3 |
|
foreach ($groupPermissions as $permission) { |
|
78
|
1 |
|
if (array_key_exists($permission, $this->mappedPermissions)) { |
|
79
|
1 |
|
$permission = $this->mappedPermissions[$permission]; |
|
80
|
1 |
|
$permissionDefinitions[] = Craft::app()->schematic_sources->getSource(false, $permission, 'id', 'handle'); |
|
81
|
1 |
|
} |
|
82
|
3 |
|
} |
|
83
|
3 |
|
sort($permissionDefinitions); |
|
84
|
|
|
|
|
85
|
3 |
|
return $permissionDefinitions; |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
/** |
|
89
|
|
|
* Get a mapping of all permissions from lowercase to camelcase |
|
90
|
|
|
* savePermissions only accepts camelcase. |
|
91
|
|
|
* |
|
92
|
|
|
* @return array |
|
93
|
|
|
*/ |
|
94
|
4 |
|
private function getAllMappedPermissions() |
|
95
|
|
|
{ |
|
96
|
4 |
|
$mappedPermissions = []; |
|
97
|
4 |
|
foreach (Craft::app()->userPermissions->getAllPermissions() as $permissions) { |
|
98
|
4 |
|
$mappedPermissions = array_merge($mappedPermissions, $this->getMappedPermissions($permissions)); |
|
99
|
4 |
|
} |
|
100
|
|
|
|
|
101
|
4 |
|
return $mappedPermissions; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* @param array $permissions |
|
106
|
|
|
* |
|
107
|
|
|
* @return array |
|
108
|
|
|
*/ |
|
109
|
4 |
|
private function getMappedPermissions(array $permissions) |
|
110
|
|
|
{ |
|
111
|
4 |
|
$mappedPermissions = []; |
|
112
|
4 |
|
foreach ($permissions as $permission => $options) { |
|
113
|
4 |
|
$mappedPermissions[strtolower($permission)] = $permission; |
|
114
|
4 |
|
if (array_key_exists('nested', $options)) { |
|
115
|
4 |
|
$mappedPermissions = array_merge($mappedPermissions, $this->getMappedPermissions($options['nested'])); |
|
116
|
4 |
|
} |
|
117
|
4 |
|
} |
|
118
|
|
|
|
|
119
|
4 |
|
return $mappedPermissions; |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
//============================================================================================================== |
|
123
|
|
|
//================================================ IMPORT ==================================================== |
|
124
|
|
|
//============================================================================================================== |
|
125
|
|
|
|
|
126
|
|
|
/** |
|
127
|
|
|
* Import usergroups. |
|
128
|
|
|
* |
|
129
|
|
|
* @param array $groupDefinitions |
|
130
|
|
|
* @param bool $force if set to true items not in the import will be deleted |
|
131
|
|
|
* |
|
132
|
|
|
* @return Result |
|
133
|
|
|
*/ |
|
134
|
9 |
|
public function import(array $groupDefinitions, $force = false) |
|
135
|
|
|
{ |
|
136
|
9 |
|
Craft::log(Craft::t('Importing User Groups')); |
|
137
|
|
|
|
|
138
|
9 |
|
$userGroups = Craft::app()->userGroups->getAllGroups('handle'); |
|
139
|
|
|
|
|
140
|
9 |
|
foreach ($groupDefinitions as $groupHandle => $groupDefinition) { |
|
141
|
6 |
|
$group = array_key_exists($groupHandle, $userGroups) ? $userGroups[$groupHandle] : new UserGroupModel(); |
|
142
|
|
|
|
|
143
|
6 |
|
unset($userGroups[$groupHandle]); |
|
144
|
|
|
|
|
145
|
6 |
|
$group->name = $groupDefinition['name']; |
|
146
|
6 |
|
$group->handle = $groupHandle; |
|
147
|
|
|
|
|
148
|
6 |
|
if (!Craft::app()->userGroups->saveGroup($group)) { |
|
149
|
2 |
|
$this->addErrors($group->getAllErrors()); |
|
150
|
|
|
|
|
151
|
2 |
|
continue; |
|
152
|
|
|
} |
|
153
|
|
|
|
|
154
|
4 |
|
$permissions = $this->getPermissions($groupDefinition['permissions']); |
|
155
|
|
|
|
|
156
|
4 |
|
Craft::app()->userPermissions->saveGroupPermissions($group->id, $permissions); |
|
157
|
9 |
|
} |
|
158
|
|
|
|
|
159
|
9 |
|
if ($force) { |
|
160
|
3 |
|
foreach ($userGroups as $group) { |
|
161
|
3 |
|
Craft::app()->userGroups->deleteGroupById($group->id); |
|
162
|
3 |
|
} |
|
163
|
3 |
|
} |
|
164
|
|
|
|
|
165
|
9 |
|
return $this->getResultModel(); |
|
166
|
|
|
} |
|
167
|
|
|
|
|
168
|
|
|
/** |
|
169
|
|
|
* Get permissions. |
|
170
|
|
|
* |
|
171
|
|
|
* @param array $permissionDefinitions |
|
172
|
|
|
* |
|
173
|
|
|
* @return array |
|
174
|
|
|
*/ |
|
175
|
4 |
|
private function getPermissions(array $permissionDefinitions) |
|
176
|
|
|
{ |
|
177
|
4 |
|
$permissions = []; |
|
178
|
4 |
|
foreach ($permissionDefinitions as $permissionDefinition) { |
|
179
|
2 |
|
$permissions[] = Craft::app()->schematic_sources->getSource(false, $permissionDefinition, 'handle', 'id'); |
|
180
|
4 |
|
} |
|
181
|
|
|
|
|
182
|
4 |
|
return $permissions; |
|
183
|
|
|
} |
|
184
|
|
|
} |
|
185
|
|
|
|
nerds-and-company /
schematic
