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: 

<?php
namespace LeanCloud;

use LeanCloud\Client;
use LeanCloud\LeanObject;
use LeanCloud\CloudException;

/**
 * User representation for LeanCloud User
 *
 * LeanCloud provides a default user model to facilitate user
 * management at application level. Users can be managed by email,
 * mobile phone number, or simply a username.
 *
 * Upon sign-up a session token is issued to user, which shall be used
 * to authenticate the user in subsequent requests. The session token
 * of logged-in user is available at
 *
 * ```
 * User::getCurrentSessionToken()
 * ```
 *
 * and current user at
 *
 * ```
 * User::getCurrentUser()
 * ```
 *
 * Providing a token, the user can be conveniently authenticated and
 * fetched by
 *
 * ```
 * User::become($token)
 * ```
 *
 */

class User extends LeanObject {

    /**
     * className on LeanCloud
     *
     * @var string
     */
    protected static $className = "_User";

    /**
     * Current logged-in user
     *
     * @var User
     */
    public static $currentUser = null;

    /**
     * Set username
     *
     * @param string $username
     * @return self
     */
    public function setUsername($username) {
        $this->set("username", $username);
        return $this;
    }

    /**
     * Set email
     *
     * @param string $email
     * @return self
     */
    public function setEmail($email) {
        $this->set("email", $email);
        return $this;
    }

    /**
     * Set password
     *
     * @param string $password
     * @return self
     */
    public function setPassword($password) {
        $this->set("password", $password);
        return $this;
    }

    /**
     * Set mobile phone number
     *
     * @param string $number
     * @return self
     */
    public function setMobilePhoneNumber($number) {
        $this->set("mobilePhoneNumber", $number);
        return $this;
    }

    /**
     * Sign-up user
     *
     * It will also auto-login and set current user.
     *
     * @throws CloudException
     */
    public function signUp() {
        if ($this->getObjectId()) {
            throw new CloudException("User has already signed up.");
        }
        parent::save();
        static::saveCurrentUser($this);
    }

    /**
     * Save a signed-up user
     *
     * @param SaveOption $option
     * @throws CloudException
     */
    public function save($option=null) {
        if ($this->getObjectId()) {
            parent::save($option);
        } else {
            throw new CloudException("Cannot save new user, please signUp ".
                                    "first.");
        }
    }

    /**
     * Update password with old password
     *
     * @param string $old Old password
     * @param string $new New password
     * @throws CloudException
     */
    public function updatePassword($old, $new) {
        if ($this->getObjectId()) {
            $path = "/users/{$this->getObjectId()}/updatePassword";
            $resp = Client::put($path, array("old_password" => $old,
                                                 "new_password" => $new),
                                    $this->getSessionToken());
            $this->mergeAfterFetch($resp);
            static::saveCurrentUser($this);
        } else {
            throw new CloudException("Cannot update password on new user.");
        }
    }

    /**
     * @return string
     */
    public function getUsername() {
        return $this->get("username");
    }

    /**
     * @return string
     */
    public function getEmail() {
        return $this->get("email");
    }

    /**
     * @return string
     */
    public function getMobilePhoneNumber() {
        return $this->get("mobilePhoneNumber");
    }

    /**
     * Get session token of user
     *
     * @return string
     */
    public function getSessionToken() {
        return $this->get("sessionToken");
    }


    // Static methods

    /**
     * Set session token as of logged-in user
     *
     * Save session token after a user logs in. It will clear session token
     * if given token is null.
     *
     * @param string $token Session token of logged-in user
     */
    public static function setCurrentSessionToken($token) {
        Client::getStorage()->set("LC_SessionToken", $token);
    }

    /**
     * Get (persisted) session token
     *
     * @return string
     */
    public static function getCurrentSessionToken() {
        return Client::getStorage()->get("LC_SessionToken");
    }

    /**
     * Get currently logged-in user
     *
     * @return User
     */
    public static function getCurrentUser() {
        if (self::$currentUser instanceof User) {
            return self::$currentUser;
        }
        $token = static::getCurrentSessionToken();
        if ($token) {
            return static::become($token);
        }
    }

    /**
     * Save logged-in user and session token
     *
     * @param User
     */
    public static function saveCurrentUser($user) {
        self::$currentUser = $user;
        self::setCurrentSessionToken($user->getSessionToken());
    }

    /**
     * Clear logged-in user and session token.
     */
    public static function clearCurrentUser() {
        self::$currentUser = null;
        self::setCurrentSessionToken(null);
    }

    /**
     * Refresh session token
     */
    public function refreshSessionToken() {
        $resp = Client::put("/users/{$this->getObjectId()}/refreshSessionToken",
                            null);
        $this->mergeAfterFetch($resp);
        static::saveCurrentUser($this);
    }

    /**
     * Test if user logged in and session token is valid.
     *
     * @return bool
     */
    public function isAuthenticated() {
        $token = $this->getSessionToken();
        if (!$token) {
            return false;
        }
        try {
            $resp = Client::get("/users/me",
                                array("session_token" => $token));
        } catch(CloudException $ex) {
            if ($ex->getCode() === 211) {
                return false;
            }
            throw ex;
        }
        return true;
    }

    /**
     * Get roles the user belongs to
     *
     * @return array Array of Role
     */
    public function getRoles() {
        if (!$this->getObjectId()) {
            return array();
        }
        $query = new Query("_Role");
        $query->equalTo("users", $this);
        $roles = $query->find();
        return $roles;
    }

    /**
     * Log-in user by session token
     *
     * And set current user.
     *
     * @param string $token Session token
     * @return User
     * @throws CloudException
     */
    public static function become($token) {
        $resp = Client::get("/users/me",
                                array("session_token" => $token));
        $user = new static();
        $user->mergeAfterFetch($resp);
        static::saveCurrentUser($user);

        return $user;
    }


    private static function _login($userData) {
        $resp = Client::post("/login", $userData);
        $user = new static();
        $user->mergeAfterFetch($resp);
        static::saveCurrentUser($user);
        return $user;
    }
    /**
     * Log-in user by username and password
     *
     * And set current user.
     *
     * @param string $username
     * @param string $password
     * @return User
     * @throws CloudException
     */
    public static function logIn($username, $password) {
        $user = static::_login(array("username" => $username,
            "password" => $password));
        return $user;
    }
    /**
     * Log-in user by email and password
     *
     * And set current user.
     *
     * @param string $email
     * @param string $password
     * @return User
     * @throws CloudException
     */
    public static function logInWithEmail($email, $password) {
        $user = static::_login(array("email" => $email,
            "password" => $password));
        return $user;
    }


    /**
     * Log-out current user
     */
    public static function logOut() {
        $user = static::getCurrentUser();
        if ($user) {
            try {
                Client::post("/logout", null, $user->getSessionToken());
            } catch (CloudException $exp) {
                // skip
            }
            static::clearCurrentUser($user);
        }
    }

    /**
     * Log-in user by mobile phone and password
     *
     * @param string $phoneNumber
     * @param string $password
     * @return User
     */
    public static function logInWithMobilePhoneNumber($phoneNumber, $password) {
        $params = array("mobilePhoneNumber" => $phoneNumber,
                        "password" => $password);
        $resp = Client::post("/login", $params);
        $user = new static();
        $user->mergeAfterFetch($resp);
        static::saveCurrentUser($user);
        return $user;
    }

    /**
     * Log-in user by mobile phone and SMS code.
     *
     * Log-in user with SMS code, which can be requested by
     * `requestLoginSmsCode`. It will set current user.
     *
     * @param string $phoneNumber Registered mobile phone number
     * @param string $smsCode
     * @return User
     */
    public static function logInWithSmsCode($phoneNumber, $smsCode) {
        $params = array("mobilePhoneNumber" => $phoneNumber,
                        "smsCode" => $smsCode);
        $resp = Client::get("/login", $params);
        $user = new static();
        $user->mergeAfterFetch($resp);
        static::saveCurrentUser($user);
        return $user;
    }

    /**
     * Request login SMS code
     *
     * Send user mobile phone a message with SMS code, which can be used
     * for login then.
     *
     * @param string $phoneNumber Register mobile phone number
     */
    public static function requestLoginSmsCode($phoneNumber) {
        Client::post("/requestLoginSmsCode",
                         array("mobilePhoneNumber" => $phoneNumber));
    }

    /**
     * Request email verify
     *
     * Send user an email to verify email.
     *
     * @param string $email
     */
    public static function requestEmailVerify($email) {
        Client::post("/requestEmailVerify", array("email" => $email));
    }

    /**
     * Request password reset by email
     *
     * @param string $email Registered email
     */
    public static function requestPasswordReset($email) {
        Client::post("/requestPasswordReset", array("email" => $email));
    }

    /**
     * Request password reset by SMS
     *
     * Send user mobile phone a message with SMS code.
     *
     * @param string $phoneNumber Registered mobile phone number
     */
    public static function requestPasswordResetBySmsCode($phoneNumber) {
        Client::post("/requestPasswordResetBySmsCode",
                         array("mobilePhoneNumber" => $phoneNumber));
    }

    /**
     * Reset password by SMS code.
     *
     * @param string $smsCode
     * @param string $newPassword
     */
    public static function resetPasswordBySmsCode($smsCode, $newPassword) {
        Client::put("/resetPasswordBySmsCode/{$smsCode}",
                        array("password" => $newPassword));
    }

    /**
     * Request mobile phone verify.
     *
     * Send user mobile phone a message with SMS code.
     *
     * @param string $phoneNumber
     */
    public static function requestMobilePhoneVerify($phoneNumber) {
        Client::post("/requestMobilePhoneVerify",
                         array("mobilePhoneNumber" => $phoneNumber));
    }

    /**
     * Verify mobile phone by SMS code
     *
     * @param string $smsCode
     */
    public static function verifyMobilePhone($smsCode) {
        Client::post("/verifyMobilePhone/{$smsCode}", null);
    }

    /**
     * Request mobile phone verify before updating it.
     *
     * @param string $phoneNumber
     */
    public static function requestChangePhoneNumber($phoneNumber) {
        Client::post("/requestChangePhoneNumber", array(
            "mobilePhoneNumber" => $phoneNumber
        ));
    }

    /**
     * Update mobile phone number by SMS code.
     *
     * @param string $smsCode
     * @param string $phoneNumber
     */
    public static function changePhoneNumber($smsCode, $phoneNumber) {
        Client::post("/changePhoneNumber", array(
            "mobilePhoneNumber" => $phoneNumber,
            "code" => $smsCode
        ));
    }

    /**
     * Sign up user by mobile phone and SMS code
     *
     * @param string  $phoneNumber
     * @param string  $smsCode
     * @return User
     */
    public static function signUpOrLoginByMobilePhone($phoneNumber, $smsCode) {
        $resp = Client::post("/usersByMobilePhone", array(
            "mobilePhoneNumber" => $phoneNumber,
            "smsCode" => $smsCode
        ));
        $user = new static();
        $user->mergeAfterFetch($resp);
        static::saveCurrentUser($user);
        return $user;
    }

    /*
     * Link and unlink with 3rd party auth provider
     *
     * The auth data we work with has following structure in general:
     *
     *     {"authData": {
     *             "provider-name": {
     *                 "uid":          "...",
     *                 "access_token": "...",
     *                 "expires_in":   "..."
     *             }
     *         }
     *     }
     */

    /**
     * Log-in with 3rd party auth data
     *
     * Log-in with 3rd party provider auth data. If the auth data has been
     * linked previously with user, it will login _as_ that user. Else a
     * new user will be created with generated username. It will set
     * current user.
     *
     * @param string $provider  Provider name
     * @param array  $authToken Auth token
     * @return User
     */
    public static function logInWith($provider, $authToken) {
        $user = new static();
        $user->linkWith($provider, $authToken);
        static::saveCurrentUser($user);
        return $user;
    }

    /**
     * Link user with 3rd party provider
     *
     * @param string $provider  Provider name e.g. "weibo", "weixin"
     * @param array  $authToken Array of id, token, and expiration info
     * @return self
     */
    public function linkWith($provider, $authToken) {
        if (!is_string($provider) || empty($provider)) {
            throw new \InvalidArgumentException("Provider name can only " .
                                                "be string.");
        }
        $data = $this->get("authData");
        if (!$data) {
            $data = array();
        }
        $data[$provider] = $authToken;
        $this->set("authData", $data);
        parent::save();

        return $this;
    }

    /**
     * Unlink user with a provider
     *
     * @param string $provider Provider name
     * @return self
     */
    public function unlinkWith($provider) {
        if (!is_string($provider) || empty($provider)) {
            throw new \InvalidArgumentException("Provider name can only " .
                                                "be string.");
        }
        if (!$this->getObjectId()) {
            throw new \RuntimeException("Cannot unlink with unsaved user.");
        }

        $data = $this->get("authData");
        if (isset($data[$provider])) {
            $data[$provider] = null;
            $this->set("authData", $data);
            $this->save();
        }
        return $this;
    }

}