-
-
Notifications
You must be signed in to change notification settings - Fork 341
Expand file tree
/
Copy pathParseUser.php
More file actions
676 lines (627 loc) · 19.3 KB
/
ParseUser.php
File metadata and controls
676 lines (627 loc) · 19.3 KB
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
<?php
/**
* Class ParseUser | Parse/ParseUser.php
*/
namespace Parse;
/**
* Class ParseUser - Representation of a user object stored on Parse.
*
* @author Fosco Marotto <[email protected]>
* @package Parse
*/
class ParseUser extends ParseObject
{
/**
* Parse Class name
*
* @var string
*/
public static $parseClassName = '_User';
/**
* The currently logged-in user.
*
* @var ParseUser
*/
protected static $currentUser = null;
/**
* The sessionToken for an authenticated user.
*
* @var string
*/
protected $_sessionToken = null;
/**
* Returns the username.
*
* @return string|null
*/
public function getUsername()
{
return $this->get('username');
}
/**
* Sets the username for the ParseUser.
*
* @param string $username The username
*/
public function setUsername($username)
{
return $this->set('username', $username);
}
/**
* Sets the password for the ParseUser.
*
* @param string $password The password
*/
public function setPassword($password)
{
return $this->set('password', $password);
}
/**
* Returns the email address, if set, for the ParseUser.
*
* @return string|null
*/
public function getEmail()
{
return $this->get('email');
}
/**
* Sets the email address for the ParseUser.
*
* @param string $email The email address
*/
public function setEmail($email)
{
return $this->set('email', $email);
}
/**
* Checks whether this user has been authenticated.
*
* @return bool
*/
public function isAuthenticated()
{
return $this->_sessionToken !== null;
}
/**
* Signs up the current user, or throw if invalid.
* This will create a new ParseUser on the server, and also persist the
* session so that you can access the user using ParseUser::getCurrentUser();.
*/
public function signUp()
{
if (!$this->get('username')) {
throw new ParseException(
'Cannot sign up user with an empty name',
200
);
}
if (!$this->get('password')) {
throw new ParseException(
'Cannot sign up user with an empty password.',
201
);
}
if ($this->getObjectId()) {
throw new ParseException(
'Cannot sign up an already existing user.',
208
);
}
parent::save();
$this->handleSaveResult(true);
}
/**
* Logs in and returns a valid ParseUser, or throws if invalid.
*
* @param string $username
* @param string $password
*
* @throws ParseException
*
* @return ParseUser
*/
public static function logIn($username, $password)
{
if (!$username) {
throw new ParseException(
'Cannot log in user with an empty name',
200
);
}
if (!$password) {
throw new ParseException(
'Cannot log in user with an empty password.',
201
);
}
$data = ['username' => $username, 'password' => $password];
$result = ParseClient::_request('POST', 'login', '', json_encode($data));
$user = new static();
$user->_mergeAfterFetch($result);
$user->handleSaveResult(true);
ParseClient::getStorage()->set('user', $user);
return $user;
}
/**
* Uses the master key to log in and return a valid ParseUser, or throws if invalid.
*
* @param $userId
*
* @throws ParseException
*
* @return ParseUser
*/
public static function logInAs($userId)
{
if (!$userId) {
throw new ParseException(
'Cannot log in as user with an empty user id',
200
);
}
$data = ['userId' => $userId];
$result = ParseClient::_request('POST', 'loginAs', '', json_encode($data), true);
$user = new static();
$user->_mergeAfterFetch($result);
$user->handleSaveResult(true);
ParseClient::getStorage()->set('user', $user);
return $user;
}
/**
* Logs in with Facebook details, or throws if invalid.
*
* @param string $id the Facebook user identifier
* @param string $access_token the access token for this session
* @param \DateTime $expiration_date defaults to 60 days
*
* @throws ParseException
*
* @return ParseUser
*/
public static function logInWithFacebook($id, $access_token, $expiration_date = null)
{
if (!$id) {
throw new ParseException(
'Cannot log in Facebook user without an id.',
250
);
}
if (!$access_token) {
throw new ParseException(
'Cannot log in Facebook user without an access token.',
251
);
}
if (!$expiration_date) {
$expiration_date = new \DateTime();
$expiration_date->setTimestamp(time() + 86400 * 60);
}
$authData = [
'id' => $id,
'access_token' => $access_token,
'expiration_date' => ParseClient::getProperDateFormat($expiration_date),
];
return self::logInWith('facebook', $authData);
}
/**
* Logs in with Twitter details, or throws if invalid.
*
* @param string $id the Twitter user identifier
* @param string $screen_name the user's Twitter handle
* @param string $consumer_key the application's consumer key
* @param string $consumer_secret the application's consumer secret
* @param string $auth_token the authorized Twitter token for the user
* @param string $auth_token_secret the secret associated with $auth_token
*
* @throws ParseException
*
* @return ParseUser
*/
public static function logInWithTwitter(
$id,
$screen_name,
$consumer_key,
$consumer_secret = null,
$auth_token = null,
$auth_token_secret = null
) {
if (!$id) {
throw new ParseException(
'Cannot log in Twitter user without an id.',
250
);
}
if (!$screen_name) {
throw new ParseException(
'Cannot log in Twitter user without Twitter screen name.',
251
);
}
if (!$consumer_key) {
throw new ParseException(
'Cannot log in Twitter user without a consumer key.',
253
);
}
if (!$auth_token) {
throw new ParseException(
'Cannot log in Twitter user without an auth token.',
253
);
}
if (!$auth_token_secret) {
throw new ParseException(
'Cannot log in Twitter user without an auth token secret.',
253
);
}
$authData = [
'id' => $id,
'screen_name' => $screen_name,
'consumer_key' => $consumer_key,
'consumer_secret' => $consumer_secret,
'auth_token' => $auth_token,
'auth_token_secret' => $auth_token_secret,
];
return self::logInWith('twitter', $authData);
}
/**
* Login as an anonymous User with REST API. See docs http://parseplatform.org/docs/php/guide/#users
*
* @link http://parseplatform.org/docs/rest/guide/#anonymous-user-authdata
*
* @throws ParseException
*
* @return ParseUser
*/
public static function loginWithAnonymous()
{
/*
* We use UUID version 4 as the id value
* @link https://en.wikipedia.org/wiki/Universally_unique_identifier
*/
$uuid_parts = str_split(md5(mt_rand()), 4);
$authData = [
'id' => $uuid_parts[0].
$uuid_parts[1].'-'.
$uuid_parts[2].'-'.
$uuid_parts[3].'-'.
$uuid_parts[4].'-'.
$uuid_parts[5].
$uuid_parts[6].
$uuid_parts[7],
];
return self::logInWith('anonymous', $authData);
}
/**
* Logs in with a service.
*
* @param string $serviceName the name of the service
* @param array $authData the array of auth data for $serviceName
*
* @return ParseUser
*/
public static function logInWith($serviceName, $authData)
{
$data = ['authData' => [
$serviceName => $authData,
]];
$result = ParseClient::_request('POST', 'users', '', json_encode($data));
$user = new static();
$user->_mergeAfterFetch($result);
$user->handleSaveResult(true);
ParseClient::getStorage()->set('user', $user);
return $user;
}
/**
* Link the user with Facebook details.
*
* @param string $id the Facebook user identifier
* @param string $access_token the access token for this session
* @param \DateTime $expiration_date defaults to 60 days
* @param bool $useMasterKey whether to override security
*
* @throws ParseException
*
* @return ParseUser
*/
public function linkWithFacebook(
$id,
$access_token,
$expiration_date = null,
$useMasterKey = false
) {
if (!$this->getObjectId()) {
throw new ParseException(
'Cannot link an unsaved user, use ParseUser::logInWithFacebook',
104
);
}
if (!$id) {
throw new ParseException(
'Cannot link Facebook user without an id.',
250
);
}
if (!$access_token) {
throw new ParseException(
'Cannot link Facebook user without an access token.',
251
);
}
if (!$expiration_date) {
$expiration_date = new \DateTime();
$expiration_date->setTimestamp(time() + 86400 * 60);
}
$authData = [
'id' => $id,
'access_token' => $access_token,
'expiration_date' => ParseClient::getProperDateFormat($expiration_date),
];
return $this->linkWith('facebook', $authData, $useMasterKey);
}
/**
* Link the user with Twitter details.
*
* @param string $id the Twitter user identifier
* @param string $screen_name the user's Twitter handle
* @param string $consumer_key the application's consumer key
* @param string $consumer_secret the application's consumer secret
* @param string $auth_token the authorized Twitter token for the user
* @param string $auth_token_secret the secret associated with $auth_token
* @param bool $useMasterKey whether to override security
*
* @throws ParseException
*
* @return ParseUser
*/
public function linkWithTwitter(
$id,
$screen_name,
$consumer_key,
$consumer_secret = null,
$auth_token = null,
$auth_token_secret = null,
$useMasterKey = false
) {
if (!$this->getObjectId()) {
throw new ParseException('Cannot link an unsaved user, use ParseUser::logInWithTwitter', 104);
}
if (!$id) {
throw new ParseException('Cannot link Twitter user without an id.', 250);
}
if (!$screen_name) {
throw new ParseException('Cannot link Twitter user without Twitter screen name.', 251);
}
if (!$consumer_key) {
throw new ParseException('Cannot link Twitter user without a consumer key.', 253);
}
if (!$auth_token) {
throw new ParseException('Cannot link Twitter user without an auth token.', 253);
}
if (!$auth_token_secret) {
throw new ParseException('Cannot link Twitter user without an auth token secret.', 253);
}
$authData = [
'id' => $id,
'screen_name' => $screen_name,
'consumer_key' => $consumer_key,
'consumer_secret' => $consumer_secret,
'auth_token' => $auth_token,
'auth_token_secret' => $auth_token_secret,
];
return $this->linkWith('twitter', $authData, $useMasterKey);
}
/**
* Link the user with a service.
*
* @param string $serviceName the name of the service
* @param array $authData the array of auth data for $serviceName
* @param bool $useMasterKey Whether or not to use the master key, default is false
*
* @return ParseUser
*/
public function linkWith($serviceName, $authData, $useMasterKey = false)
{
$data = ['authData' => [
$serviceName => $authData,
]];
$result = ParseClient::_request(
'PUT',
'users/'.$this->getObjectId(),
$this->getSessionToken(),
json_encode($data),
$useMasterKey
);
$user = new self();
$user->_mergeAfterFetch($result);
$user->handleSaveResult(true);
return $user;
}
/**
* Logs in a user with a session token. Calls the /users/me route and if
* valid, creates and returns the current user.
*
* @param string $sessionToken
*
* @return ParseUser
*/
public static function become($sessionToken)
{
$result = ParseClient::_request('GET', 'users/me', $sessionToken);
$user = new static();
$user->_mergeAfterFetch($result);
$user->handleSaveResult(true);
ParseClient::getStorage()->set('user', $user);
return $user;
}
/**
* Log out the current user. This will clear the storage and future calls
* to current will return null.
* This will make a network request to logout to invalidate the session.
*/
public static function logOut()
{
$user = static::getCurrentUser();
if ($user) {
try {
ParseClient::_request('POST', 'logout', $user->getSessionToken());
} catch (ParseException $ex) {
// If this fails, we're going to ignore it.
}
static::$currentUser = null;
}
ParseClient::getStorage()->remove('user');
}
/**
* After a save, perform User object specific logic.
*
* @param bool $makeCurrent Whether to set the current user.
*/
protected function handleSaveResult($makeCurrent = false)
{
if (isset($this->serverData['password'])) {
unset($this->serverData['password']);
}
if (isset($this->serverData['sessionToken'])) {
$this->_sessionToken = $this->serverData['sessionToken'];
unset($this->serverData['sessionToken']);
}
if ($makeCurrent) {
if (session_id()) {
// see: https://www.owasp.org/index.php/Session_fixation
session_regenerate_id();
}
static::$currentUser = $this;
static::saveCurrentUser();
}
$this->rebuildEstimatedData();
}
/**
* Retrieves the currently logged in ParseUser with a valid session,
* either from memory or the storage provider, if necessary.
*
* @return ParseUser|null
*/
public static function getCurrentUser()
{
if (static::$currentUser instanceof self) {
return static::$currentUser;
}
$storage = ParseClient::getStorage();
$userData = $storage->get('user');
if ($userData instanceof self) {
static::$currentUser = $userData;
return $userData;
}
if (isset($userData['id']) && isset($userData['_sessionToken'])) {
$user = new static(null, $userData['id']);
unset($userData['id']);
$user->_sessionToken = $userData['_sessionToken'];
unset($userData['_sessionToken']);
foreach ($userData as $key => $value) {
$user->set($key, $value);
}
static::$currentUser = $user;
return $user;
}
return null;
}
/**
* Persists the current user to the storage provider.
*/
protected static function saveCurrentUser()
{
$storage = ParseClient::getStorage();
$storage->set('user', static::getCurrentUser());
}
/**
* Returns the session token, if available.
*
* @return string|null
*/
public function getSessionToken()
{
return $this->_sessionToken;
}
/**
* Returns true if this user is the current user.
*
* @return bool
*/
public function isCurrent()
{
if (static::getCurrentUser() && $this->getObjectId()) {
if ($this->getObjectId() == static::getCurrentUser()->getObjectId()) {
return true;
}
}
return false;
}
/**
* Remove current user's anonymous AuthData
*/
private function clearAnonymousAuthData()
{
$json = json_encode(['authData' => [ 'anonymous' => null]]);
ParseClient::_request('PUT', 'classes/_User/' . $this->getObjectId(), null, $json, true);
}
/**
* Save the current user object, unless it is not signed up.
*
* @param bool $useMasterKey Whether to use the Master Key
*
* @throws ParseException
*/
public function save($useMasterKey = false)
{
if ($this->getObjectId()) {
$wasAnonymous = isset($this->operationSet['username'])
&& $this->operationSet['username'] instanceof \Parse\Internal\SetOperation;
parent::save($useMasterKey);
if ($wasAnonymous) {
$this->clearAnonymousAuthData();
}
} else {
throw new ParseException(
'You must call signUp to create a new User.',
207
);
}
}
/**
* Requests a password reset email to be sent to the specified email
* address associated with the user account. This email allows the user
* to securely reset their password on the Parse site.
*
* @param string $email
*/
public static function requestPasswordReset($email)
{
$json = json_encode(['email' => $email]);
ParseClient::_request('POST', 'requestPasswordReset', null, $json);
}
/**
* Request a verification email to be sent to the specified email address
*
* @param string $email Email to request a verification for
*/
public static function requestVerificationEmail($email)
{
$json = json_encode(['email' => $email]);
ParseClient::_request(
'POST',
'verificationEmailRequest',
null,
$json
);
}
/**
* Sets the current user to null. Used internally for testing purposes.
*/
public static function _clearCurrentUserVariable()
{
static::$currentUser = null;
}
}