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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Setup\Model;
use Magento\Authorization\Model\Acl\Role\Group;
use Magento\Authorization\Model\Acl\Role\User;
use Magento\Authorization\Model\UserContextInterface;
use Magento\Framework\Encryption\EncryptorInterface;
use Magento\Framework\DB\Adapter\AdapterInterface;
class AdminAccount
{
/**#@+
* Data keys
*/
const KEY_USER = 'admin-user';
const KEY_PASSWORD = 'admin-password';
const KEY_EMAIL = 'admin-email';
const KEY_FIRST_NAME = 'admin-firstname';
const KEY_LAST_NAME = 'admin-lastname';
const KEY_PREFIX = 'db-prefix';
/**#@- */
/**
* Db connection
*
* @var AdapterInterface
*/
private $connection;
/**
* Configurations
*
* @var []
*/
private $data;
/**
* @var EncryptorInterface
*/
private $encryptor;
/**
* Default Constructor
*
* @param AdapterInterface $connection
* @param EncryptorInterface $encryptor
* @param array $data
*/
public function __construct(
AdapterInterface $connection,
EncryptorInterface $encryptor,
array $data
) {
$this->connection = $connection;
$this->encryptor = $encryptor;
$this->data = $data;
}
/**
* Generate password string
*
* @return string
*/
protected function generatePassword()
{
return $this->encryptor->getHash($this->data[self::KEY_PASSWORD], true);
}
/**
* Save administrator account and user role to DB.
*
* If the administrator account exists, update it.
*
* @return void
*/
public function save()
{
$adminId = $this->saveAdminUser();
$this->saveAdminUserRole($adminId);
}
/**
* Uses the information in data[] to create the admin user.
*
* If the username already exists, it will update the record with information from data[]
* and set the is_active flag.
*
* @return int The admin user id
*/
private function saveAdminUser()
{
$passwordHash = $this->generatePassword();
$adminData = [
'firstname' => $this->data[self::KEY_FIRST_NAME],
'lastname' => $this->data[self::KEY_LAST_NAME],
'password' => $passwordHash,
'is_active' => 1,
];
$result = $this->connection->fetchRow(
'SELECT user_id, username, email FROM ' . $this->getTableName('admin_user') . ' ' .
'WHERE username = :username OR email = :email',
['username' => $this->data[self::KEY_USER], 'email' => $this->data[self::KEY_EMAIL]],
null
);
if (!empty($result)) {
// User exists, update
$this->validateUserMatches();
$adminId = $result['user_id'];
$adminData['modified'] = date('Y-m-d H:i:s');
$this->connection->update(
$this->getTableName('admin_user'),
$adminData,
$this->connection->quoteInto('username = ?', $this->data[self::KEY_USER])
);
} else {
// User does not exist, create it
$adminData['username'] = $this->data[self::KEY_USER];
$adminData['email'] = $this->data[self::KEY_EMAIL];
$this->connection->insert(
$this->getTableName('admin_user'),
$adminData
);
$adminId = $this->connection->lastInsertId();
}
$this->trackPassword($adminId, $passwordHash);
return $adminId;
}
/**
* Remember a password hash for further usage.
*
* @param int $adminId
* @param string $passwordHash
* @return void
*/
private function trackPassword($adminId, $passwordHash)
{
$this->connection->insert(
$this->getTableName('admin_passwords'),
[
'user_id' => $adminId,
'password_hash' => $passwordHash,
'last_updated' => time()
]
);
}
/**
* Validates that the username and email both match the user,
* and that password exists and is different from user name.
*
* @return void
* @throws \Exception If the username and email do not both match data provided to install
* @throws \Exception If password is empty and if password is the same as the user name
*/
public function validateUserMatches()
{
if (empty($this->data[self::KEY_PASSWORD])) {
throw new \Exception(
'"Password" is required. Enter and try again.'
);
}
if (strcasecmp($this->data[self::KEY_PASSWORD], $this->data[self::KEY_USER]) == 0) {
throw new \Exception(
'Password cannot be the same as the user name.'
);
}
try {
$result = $this->connection->fetchRow(
"SELECT user_id, username, email FROM {$this->getTableName('admin_user')} "
. "WHERE username = :username OR email = :email",
['username' => $this->data[self::KEY_USER], 'email' => $this->data[self::KEY_EMAIL]]
);
} catch (\Exception $e) {
return; // New installation, no need to validate existing users.
}
$email = $result['email'];
$username = $result['username'];
if ((strcasecmp($email, $this->data[self::KEY_EMAIL]) == 0) &&
(strcasecmp($username, $this->data[self::KEY_USER]) != 0)) {
// email matched but username did not
throw new \Exception(
'An existing user has the given email but different username. '
. 'Username and email both need to match an existing user or both be new.'
);
}
if ((strcasecmp($username, $this->data[self::KEY_USER]) == 0) &&
(strcasecmp($email, $this->data[self::KEY_EMAIL]) != 0)) {
// username matched but email did not
throw new \Exception(
'An existing user has the given username but different email. '
. 'Username and email both need to match an existing user or both be new.'
);
}
}
/**
* Creates the admin user role if one does not exist.
*
* Do nothing if a role already exists for this user
*
* @param int $adminId User id of administrator to set role for
* @return void
*/
private function saveAdminUserRole($adminId)
{
$result = $this->connection->fetchRow(
'SELECT * FROM ' . $this->getTableName('authorization_role') . ' ' .
'WHERE user_id = :user_id AND user_type = :user_type',
['user_id' => $adminId, 'user_type' => UserContextInterface::USER_TYPE_ADMIN]
);
if (empty($result)) {
// No user role exists for this user id, create it
$adminRoleData = [
'parent_id' => $this->retrieveAdministratorsRoleId(),
'tree_level' => 2,
'role_type' => User::ROLE_TYPE,
'user_id' => $adminId,
'user_type' => UserContextInterface::USER_TYPE_ADMIN,
'role_name' => $this->data[self::KEY_USER],
];
$this->connection->insert($this->getTableName('authorization_role'), $adminRoleData);
}
}
/**
* Gets the "Administrators" role id, the special role created by data fixture in Authorization module.
*
* @return int The id of the Administrators role
* @throws \Exception If Administrators role not found or problem connecting with database.
*/
private function retrieveAdministratorsRoleId()
{
// Get Administrators role id to use as parent_id
$administratorsRoleData = [
'parent_id' => 0,
'tree_level' => 1,
'role_type' => Group::ROLE_TYPE,
'user_id' => 0,
'user_type' => UserContextInterface::USER_TYPE_ADMIN,
'role_name' => 'Administrators',
];
$result = $this->connection->fetchRow(
'SELECT * FROM ' . $this->getTableName('authorization_role') . ' ' .
'WHERE parent_id = :parent_id AND tree_level = :tree_level AND role_type = :role_type AND ' .
'user_id = :user_id AND user_type = :user_type AND role_name = :role_name',
$administratorsRoleData
);
if (empty($result)) {
throw new \Exception('No Administrators role was found, data fixture needs to be run');
} else {
// Found at least one, use first
return $result['role_id'];
}
}
/**
* Take table with prefix without loading modules
*
* @param string $table
* @return string
*/
private function getTableName($table)
{
if (!empty($this->data[self::KEY_PREFIX])) {
return $this->connection->getTableName($this->data[self::KEY_PREFIX] . $table);
}
return $this->connection->getTableName($table);
}
}