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: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 

<?php
namespace LeanCloud;

// use LeanCloud\Client;
use LeanCloud\Operation\IOperation;
use LeanCloud\Operation\SetOperation;
use LeanCloud\Operation\DeleteOperation;
use LeanCloud\Operation\ArrayOperation;
use LeanCloud\Operation\IncrementOperation;

/**
 * LeanObject interface to LeanCloud storage API
 *
 */
class LeanObject {

    /**
     * Preserved keys
     *
     * @var array
     */
    public static $PRESERVED_KEYS = array("objectId", "updatedAt", "createdAt");

    /**
     * Map of registered className to class.
     *
     * @var array
     */
    private static $_registeredClasses = array();

    /**
     * className on LeanCloud storage.
     *
     * @var string
     */
    private $_className;

    /**
     * Snapshot of data fields.
     *
     * @var array
     */
    private $_data;

    /**
     * Unsaved operations of fields.
     *
     * @var array
     */
    private $_operationSet;

    /**
     * Save option of object
     *
     * @var SaveOption
     * @see SaveOption
     */
    private $_saveOption;

    /**
     * Make a new *plain* LeanObject.
     *
     * @param string $className
     * @param string $objectId
     * @throws InvalidArgumentException
     */
    public function __construct($className=null, $objectId=null) {
        $class = get_called_class();
        $name  = static::getRegisteredClassName();

        $className = $className ? $className : $name;
        if (!$className || ($class !== __CLASS__ && $className !== $name)) {
            throw new \InvalidArgumentException(
                "className is invalid.");
        }
        $this->_className    = $className;
        $this->_data         = array();
        $this->_operationSet = array();
        $this->_data["objectId"] = $objectId;
    }

    /**
     * Make a new object for class
     *
     * The returned object will be instance of sub-class, if className has
     * been registered.
     *
     * @param string $className
     * @param string $objectId
     * @return LeanObject
     */
    public static function create($className, $objectId=null) {
        if (isset(self::$_registeredClasses[$className])) {
            return new self::$_registeredClasses[$className]($className,
                                                               $objectId);
        } else {
            return new LeanObject($className, $objectId);
        }
    }

    /**
     * Register a sub-class to LeanObject.
     *
     * When a sub-class extends LeanObject, it should specify a static
     * string variable `::$className`, which corresponds to a className on
     * LeanCloud. It shall then invoke `->registerClass` to register
     * itself to LeanObject. Such that LeanObject maintains a map of
     * className to sub-classes.
     *
     * It is only callable on sub-class.
     *
     * @throws RuntimeException
     */
    public static function registerClass() {
        if (isset(static::$className)) {
            $class = get_called_class();
            $name  = static::$className;
            if (isset(self::$_registeredClasses[$name])) {
                $prevClass = self::$_registeredClasses[$name];
                if ($class !== $prevClass) {
                    throw new \RuntimeException("className '$name' " .
                                              "has already been registered.");
                }
            } else {
                self::$_registeredClasses[static::$className] = get_called_class();
            }
        } else {
            throw new \RuntimeException("Cannot register class without " .
                                      "::className.");
        }
    }

    /**
     * Search for className given a sub-class
     *
     * @return string|null
     */
    private static function getRegisteredClassName() {
        return array_search(get_called_class(), self::$_registeredClasses);
    }

    /**
     * Get className of object
     *
     * @return string
     */
    public function getClassName() {
        return $this->_className;
    }

    public function disableBeforeHook() {
        $this->_set("__before",
                    Client::signHook("__before_for_{$this->getClassName()}",
                                     round(microtime(true) * 1000)));
    }

    public function disableAfterHook() {
        $this->_set("__after",
                    Client::signHook("__after_for_{$this->getClassName()}",
                                     round(microtime(true) * 1000)));
    }

    /**
     * Pointer representation of object
     *
     * @return array
     */
    public function getPointer() {
        if (!$this->getObjectId()) {
            throw new \RuntimeException("LeanObject without ID cannot " .
                                      "be serialized.");
        }
        return array(
            "__type"    => "Pointer",
            "className" => $this->getClassName(),
            "objectId"  => $this->getObjectId(),
        );
    }

    /**
     * Recursively encode object and its data to JSON
     *
     * Top level object are encoded to literal JSON, with __type and
     * className stripped out.
     *
     * @return array
     * @see self::toFullJSON
     */
    public function toJSON() {
        $out = $this->toFullJSON();
        unset($out["__type"]);
        unset($out["className"]);
        return $out;
    }

    /**
     * Recursively encode object and its data to full JSON
     *
     * Recursively encode object and its (snapshot) data to full JSON, the
     * `__type` and `className` will be included in the attributes.
     *
     * @param array $seen Objects that have been traversed
     * @return array
     * @see self::toJSON
     */
    public function toFullJSON($seen=array()) {
        $out = array();
        forEach($this->_data as $key => $val) {
            $out[$key] = Client::encode($val, "toFullJSON", $seen);
        }
        $out["__type"] = "Object";
        $out["className"] = $this->getClassName();
        return $out;
    }

    /**
     * Get objectId of object
     *
     * @return string
     */
    public function getObjectId() {
        return $this->get("objectId");
    }

    /**
     *
     * @return DateTime
     */
    public function getCreatedAt() {
        return $this->get("createdAt");
    }

    /**
     *
     * @return DateTime
     */
    public function getUpdatedAt() {
        return $this->get("updatedAt");
    }

    private function _set($key, $val) {
        if ($key === "ACL" &&
            !($val instanceof ACL)) {
            throw new RuntimeException("Invalid ACL.");
        }
        if (!($val instanceof IOperation)) {
            $val = new SetOperation($key, $val);
        }
        $this->_applyOperation($val);
        return $this;
    }

    /**
     * Set field value by key
     *
     * @param string $key field key
     * @param mixed  $val field value
     * @return self
     * @throws RuntimeException
     */
    public function set($key, $val) {
        if (in_array($key, self::$PRESERVED_KEYS)) {
            throw new \RuntimeException("Preserved field could not be set.");
        }
        return $this->_set($key, $val);
    }

    /**
     * Set ACL for object
     *
     * @param ACL $acl
     * @return self
     */
    public function setACL(ACL $acl) {
        return $this->_set("ACL", $acl);
    }

    /**
     * Get ACL for object
     *
     * @return null|ACL
     */
    public function getACL() {
        return $this->get("ACL");
    }

    /**
     * Delete field by key
     *
     * @param string $key Field key
     * @return self
     */
    public function delete($key) {
        $this->_applyOperation(new DeleteOperation($key));
        return $this;
    }

    /**
     * Get field value by key
     *
     * @param string $key field key
     * @return mixed      field value
     */
    public function get($key) {
        if (!isset($this->_data[$key])) {
            return null;
        }
        $val = $this->_data[$key];
        if ($val instanceof Relation) {
            return $this->getRelation($key);
        }
        return $this->_data[$key];
    }

    /**
     * Increment a numeric field
     *
     * For decrement, provide a negative amount.
     *
     * @param string $key    field key
     * @param number $amount amount to increment
     * @return self
     */
    public function increment($key, $amount = 1) {
        $this->_applyOperation(new IncrementOperation($key, $amount));
        return $this;
    }

    /**
     * Get queued operation by key
     *
     * @param string $key
     * @return IOperation|null
     */
    private function _getPreviousOp($key) {
        if (isset($this->_operationSet[$key])) {
            return $this->_operationSet[$key];
        }
        return null;
    }

    /**
     * Apply operation
     *
     * @param IOperation $operation
     */
    private function _applyOperation($operation) {
        $key    = $operation->getKey();
        $oldval = $this->get($key);
        $newval = $operation->applyOn($oldval, $this);
        if ($newval !== null) {
            $this->_data[$key] = $newval;
        } else if (isset($this->_data[$key])) {
            unset($this->_data[$key]);
        }

        $prevOp = $this->_getPreviousOp($key);
        $newOp  = $prevOp ? $operation->mergeWith($prevOp) : $operation;
        $this->_operationSet[$key] = $newOp;
    }

    /**
     * Add one object into array field
     *
     * @param  string $key Field key
     * @param  miexed $val Object to add
     * @return self
     * @throws RuntimeException
     */
    public function addIn($key, $val) {
        $this->_applyOperation(new ArrayOperation($key, array($val), "Add"));
        return $this;
    }

    /**
     * Add one object uniquely into array field
     *
     * @param string $key Field key
     * @param mixed  $val Object to add
     * @return self
     * @throws RuntimeException
     */
    public function addUniqueIn($key, $val) {
        $this->_applyOperation(new ArrayOperation($key,
                                                  array($val),
                                                  "AddUnique"));
        return $this;
    }

    /**
     * Remove one object from array field
     *
     * @param string $key Field key
     * @param mixed  $val Object to remove
     * @return self
     * @throws RuntimeException
     */
    public function removeIn($key, $val) {
        $this->_applyOperation(new ArrayOperation($key, array($val), "Remove"));
        return $this;
    }

    /**
     * If object has data attributes.
     *
     * @return bool
     */
    public function hasData() {
        $keys = array_keys($this->_data);
        return $keys !== array("objectId");
    }

    /**
     * If there are unsaved operations.
     *
     * @return bool
     */
    public function isDirty() {
        // TODO: check children too?
        return !empty($this->_operationSet);
    }

    /**
     * Get unsaved changes
     *
     * @return array
     */
    private function getSaveData() {
        return Client::encode($this->_operationSet);
    }

    /**
     * Save object and its children objects and files
     *
     * @param SaveOption $option
     * @throws CloudException
     */
    public function save($option=null) {
        if (!$this->isDirty()) {return;}
        if ($option) {
            $this->_saveOption = $option;
        }
        try {
            $result = self::saveAll(array($this));
        } catch (BatchRequestError $batchRequestError) {
            $err = $batchRequestError->getFirst();
            if ($err)
                throw new CloudException($err["error"], $err["code"]);
        }
        return $result;
    }

    /**
     * Merge data from server
     *
     * @param array $data JSON decoded server response
     */
    private function _mergeData($data) {
        // manually convert createdAt and updatedAt fields so they'll
        // be decoded as DateTime object.
        forEach(array("createdAt", "updatedAt") as $key) {
            if (isset($data[$key]) && is_string($data[$key])) {
                $data[$key] = array("__type" => "Date",
                                    "iso"    => $data[$key]);
            }
        }

        forEach($data as $key => $val) {
            $this->_data[$key] = Client::decode($val, $key);
        }
    }

    /**
     * Merge server data after save.
     *
     * All local changes will be cleared.
     *
     * @param array $data JSON decoded server response
     */
    public function mergeAfterSave($data) {
        $this->_operationSet = array();
        $this->_mergeData($data);
    }

    /**
     * Merge server data after fetch.
     *
     * Local changes will be cleared. Though it is different from
     * megerAfterSave, that changes on new fields (which do not exist
     * on server) will be preserved until saved to server.
     *
     * @param array $data JSON decoded server response
     */
    public function mergeAfterFetch($data) {
        forEach($data as $key => $val) {
            if (isset($this->_operationSet[$key])) {
                unset($this->_operationSet[$key]);
            }
        }
        $this->_mergeData($data);
    }

    /**
     * Fetch data from server
     *
     * Local unsaved changes will be **discarded**.
     *
     * @throws RuntimeException, CloudException
     */
    public function fetch() {
        try {
            static::fetchAll(array($this));
        } catch (BatchRequestError $batchRequestError) {
            $err = $batchRequestError->getFirst();
            if ($err)
                throw new CloudException($err["error"], $err["code"]);
        }
    }

    /**
     * Fetch objects from server
     *
     * @param array $objects Objects to fetch.
     * @throws RuntimeException, CloudException
     */
    public function fetchAll($objects) {
        $batch = array();
        forEach($objects as $obj) {
            if (!$obj->getObjectId()) {
                throw new \RuntimeException("Cannot fetch object without ID.");
            }
            // remove duplicate objects by id
            $batch[$obj->getObjectId()] = $obj;
        }
        if (empty($batch)) { return; }

        $requests = array();
        $objects  = array();
        forEach($batch as $obj) {
            $requests[] = array(
                "path" => "/1.1/classes/{$obj->getClassName()}" .
                          "/{$obj->getObjectId()}",
                "method" => "GET"
            );
            $objects[] = $obj;
        }

        $sessionToken = User::getCurrentSessionToken();
        $response = Client::batch($requests, $sessionToken);

        $batchRequestError = new BatchRequestError();
        forEach($objects as $i => $obj) {
            if (isset($response[$i]["success"])) {
                if (!empty($response[$i]["success"])) {
                    $obj->mergeAfterFetch($response[$i]["success"]);
                } else {
                    $batchRequestError->add($requests[$i],
                                            array("error" => "Object not found."));
                }
            }
        }
        if (!$batchRequestError->isEmpty()) {
            throw $batchRequestError;
        }
    }

    /**
     * Destroy object on server
     *
     * It does and only destroy current object.
     *
     * @throws CloudException
     */
    public function destroy() {
        if (!$this->getObjectId()) {
            return false;
        }

        try {
            static::destroyAll(array($this));
        } catch (BatchRequestError $batchRequestError) {
            $err = $batchRequestError->getFirst();
            if ($err)
                throw new CloudException($err["error"], $err["code"]);
        }
    }

    /**
     * Return query object based on the object class
     *
     * @return Query
     */
    public function getQuery() {
        return new Query($this->getClassName());
    }

    /**
     * Get (or build) relation on field
     *
     * @param  string $key Field key
     * @return Relation
     * @throws RuntimeException
     */
    public function getRelation($key) {
        $val = isset($this->_data[$key]) ? $this->_data[$key] : null;
        if ($val) {
            if ($val instanceof Relation) {
                $val->setParentAndKey($this, $key);
                return $val;
            } else {
                throw new \RuntimeException("Field {$key} is not relation.");
            }
        }
        return new Relation($this, $key);
    }

    /**
     * Traverse value in a hierarchy of arrays and objects
     *
     * Array and data attributes of LeanObject will be traversed, each time
     * a non-array value found the func will be invoked with the value as
     * arguement.
     *
     * @param array    $seen Objects that have been traversed
     * @param function $func A function to call when non-array value found.
     */
    public static function traverse($value, &$seen, $func) {
        if ($value instanceof LeanObject) {
            if (!in_array($value, $seen)) {
                $seen[] = $value;
                static::traverse($value->_data, $seen, $func);
                $func($value);
            }
        } else if (is_array($value)) {
            forEach($value as $val) {
                if (is_array($val)) {
                    static::traverse($val, $seen, $func);
                } else if ($val instanceof LeanObject) {
                    static::traverse($val, $seen, $func);
                } else {
                    $func($val);
                }
            }
        } else {
            $func($value);
        }
    }

    /**
     * Find unsaved children (both files and objects) of object.
     *
     * @return array
     */
    public function findUnsavedChildren() {
        $unsavedChildren = array();
        $seen            = array($this); // excluding object itself
        static::traverse($this->_data, $seen,
                       function($val) use (&$unsavedChildren) {
                           if (($val instanceof LeanObject) ||
                               ($val instanceof File)) {
                               if ($val->isDirty()) {
                                   $unsavedChildren[] = $val;
                               }
                           }
                       });
        return $unsavedChildren;
    }

    /**
     * Save objects and associated unsaved children and files.
     *
     * @param  array $objects Array of objects to save
     * @throws RuntimeException
     */
    public static function saveAll($objects) {
        if (empty($objects)) { return; }
        // Unsaved children (objects and files) are saved before saving
        // top level objects.
        $unsavedChildren = array();
        forEach($objects as $obj) {
            $unsavedChildren = array_merge($unsavedChildren,
                                           $obj->findUnsavedChildren());
        }

        $children = array(); // Array of unsaved objects excluding files
        forEach($unsavedChildren as $obj) {
            if ($obj instanceof File) {
                $obj->save();
            } else if ($obj instanceof LeanObject) {
                if (!in_array($obj, $children)) {
                    $children[] = $obj;
                }
            }
        }

        static::batchSave($children);
        static::batchSave($objects);
    }

    /**
     * Save objects in batch
     *
     * It saves objects in a shallow way, that we do not care about children
     * objects.
     *
     * @param array $objects   Array of objects to save
     * @param int   $batchSize Number of objects to save per batch
     * @throws RuntimeException
     */
    private static function batchSave($objects, $batchSize=20) {
        if (empty($objects)) { return; }
        $batch     = array(); // current batch of objects to save
        $remaining = array(); // remaining objects to save
        $count     = 0;
        forEach($objects as $obj) {
            if (!$obj->isDirty()) {
                continue;
            }
            if ($count > $batchSize) {
                $remaining[] = $obj;
                $count++;
                continue;
            }
            $count++;
            $batch[] = $obj;
        }

        $path     = "/1.1/classes";
        $requests = array();
        $objects  = array();
        forEach($batch as $obj) {
            $req = array("body" => $obj->getSaveData());
            if ($obj->getObjectId()) {
                $req["method"] = "PUT";
                $req["path"]   = "{$path}/{$obj->getClassName()}" .
                               "/{$obj->getObjectId()}";
            } else {
                $req["method"] = "POST";
                $req["path"]   = "{$path}/{$obj->getClassName()}";
            }
            if ($obj->_saveOption) {
                $req["params"] = $obj->_saveOption->encode();
            }
            $requests[] = $req;
            $objects[]  = $obj;
        }

        $sessionToken = User::getCurrentSessionToken();
        $response = Client::batch($requests, $sessionToken);

        forEach($objects as $i => $obj) {
            if (isset($response[$i]["success"])) {
                $obj->mergeAfterSave($response[$i]["success"]);
            }
        }

        // start next batch
        static::batchSave($remaining, $batchSize);
    }

    /**
     * Delete objects in batch
     *
     * @param array $objects Array of Objects to destroy
     */
    public static function destroyAll($objects) {
        $batch = array();
        forEach($objects as $obj) {
            if (!$obj->getObjectId()) {
                throw new \RuntimeException("Cannot destroy object without ID");
            }
            // Remove duplicate objects by ID
            $batch[$obj->getObjectId()] = $obj;
        }
        if (empty($batch)) { return; }

        $requests = array();
        $objects  = array();
        forEach($batch as $obj) {
            $requests[] = array(
                "path" => "/1.1/classes/{$obj->getClassName()}" .
                          "/{$obj->getObjectId()}",
                "method" => "DELETE"
            );
            $objects[] = $obj;
        }

        $sessionToken = User::getCurrentSessionToken();
        $response = Client::batch($requests, $sessionToken);
    }
}