lib/ActiveMongo.php

   1 <?php
   2 /*
   3   +---------------------------------------------------------------------------------+
   4   | Copyright (c) 2010 ActiveMongo                                                  |
   5   +---------------------------------------------------------------------------------+
   6   | Redistribution and use in source and binary forms, with or without              |
   7   | modification, are permitted provided that the following conditions are met:     |
   8   | 1. Redistributions of source code must retain the above copyright               |
   9   |    notice, this list of conditions and the following disclaimer.                |
  10   |                                                                                 |
  11   | 2. Redistributions in binary form must reproduce the above copyright            |
  12   |    notice, this list of conditions and the following disclaimer in the          |
  13   |    documentation and/or other materials provided with the distribution.         |
  14   |                                                                                 |
  15   | 3. All advertising materials mentioning features or use of this software        |
  16   |    must display the following acknowledgement:                                  |
  17   |    This product includes software developed by César D. Rodas.                  |
  18   |                                                                                 |
  19   | 4. Neither the name of the César D. Rodas nor the                               |
  20   |    names of its contributors may be used to endorse or promote products         |
  21   |    derived from this software without specific prior written permission.        |
  22   |                                                                                 |
  23   | THIS SOFTWARE IS PROVIDED BY CÉSAR D. RODAS ''AS IS'' AND ANY                   |
  24   | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED       |
  25   | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE          |
  26   | DISCLAIMED. IN NO EVENT SHALL CÉSAR D. RODAS BE LIABLE FOR ANY                  |
  27   | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES      |
  28   | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;    |
  29   | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND     |
  30   | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT      |
  31   | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS   |
  32   | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE                     |
  33   +---------------------------------------------------------------------------------+
  34   | Authors: César Rodas <crodas@php.net>                                           |
  35   +---------------------------------------------------------------------------------+
  36 */
  37
  38 // Class FilterException {{{
  39 class  ActiveMongo_Exception extends Exception
  40 {
  41 }
  42 /**
  43  *  FilterException
  44  *
  45  *  This is Exception is thrown if any validation
  46  *  fails when save() is called.
  47  *
  48  */
  49 class ActiveMongo_FilterException extends ActiveMongo_Exception
  50 {
  51 }
  52 // }}}
  53
  54 // array get_object_vars_ex(stdobj $obj) {{{
  55 /**
  56  *  Simple hack to avoid get private and protected variables
  57  *
  58  *  @param obj
  59  *
  60  *  @return array
  61  */
  62 function get_object_vars_ex($obj)
  63 {
  64     return get_object_vars($obj);
  65 }
  66 // }}}
  67
  68 /**
  69  *  ActiveMongo
  70  *
  71  *  Simple ActiveRecord pattern built on top of MongoDB. This class
  72  *  aims to provide easy iteration, data validation before update,
  73  *  and efficient update.
  74  *
  75  *  @author César D. Rodas <crodas@php.net>
  76  *  @license PHP License
  77  *  @package ActiveMongo
  78  *  @version 1.0
  79  *
  80  */
  81 abstract class ActiveMongo implements Iterator
  82 {
  83
  84     // properties {{{
  85     /**
  86      *  Current databases objects
  87      *
  88      *  @type array
  89      */
  90     private static $_dbs;
  91     /**
  92      *  Current collections objects
  93      *
  94      *  @type array
  95      */
  96     private static $_collections;
  97     /**
  98      *  Current connection to MongoDB
  99      *
 100      *  @type MongoConnection
 101      */
 102     private static $_conn;
 103     /**
 104      *  Database name
 105      *
 106      *  @type string
 107      */
 108     private static $_db;
 109     /**
 110      *  List of events handlers
 111      *
 112      *  @type array
 113      */
 114     static private $_events = array();
 115     /**
 116      *  List of global events handlers
 117      *
 118      *  @type array
 119      */
 120     static private $_super_events = array();
 121     /**
 122      *  Host name
 123      *
 124      *  @type string
 125      */
 126     private static $_host;
 127     /**
 128      *  Current document
 129      *
 130      *  @type array
 131      */
 132     private $_current = array();
 133     /**
 134      *  Result cursor
 135      *
 136      *  @type MongoCursor
 137      */
 138     private $_cursor  = null;
 139
 140     /* {{{ Silly but useful query abstraction  */
 141     private $_query   = null;
 142     private $_sort    = null;
 143     private $_limit   = 0;
 144     private $_skip    = 0;
 145     private $_columns = null;
 146     /* }}} */
 147
 148     /**
 149      *  Current document ID
 150      *
 151      *  @type MongoID
 152      */
 153     private $_id;
 154
 155     /**
 156      *  Tell if the current object
 157      *  is cloned or not.
 158      *
 159      *  @type bool
 160      */
 161     private $_cloned = false;
 162     // }}}
 163
 164     // GET CONNECTION CONFIG {{{
 165
 166     // string getCollectionName() {{{
 167     /**
 168      *  Get Collection Name, by default the class name,
 169      *  but you it can be override at the class itself to give
 170      *  a custom name.
 171      *
 172      *  @return string Collection Name
 173      */
 174     protected function getCollectionName()
 175     {
 176         return strtolower(get_class($this));
 177     }
 178     // }}}
 179
 180     // string getDatabaseName() {{{
 181     /**
 182      *  Get Database Name, by default it is used
 183      *  the db name set by ActiveMong::connect()
 184      *
 185      *  @return string DB Name
 186      */
 187     protected function getDatabaseName()
 188     {
 189         if (is_null(self::$_db)) {
 190             throw new MongoException("There is no information about the default DB name");
 191         }
 192         return self::$_db;
 193     }
 194     // }}}
 195
 196     // void install() {{{
 197     /**
 198      *  Install.
 199      *
 200      *  This static method iterate over the classes lists,
 201      *  and execute the setup() method on every ActiveMongo
 202      *  subclass. You should do this just once.
 203      *
 204      */
 205     final public static function install()
 206     {
 207         $classes = array_reverse(get_declared_classes());
 208         foreach ($classes as $class)
 209         {
 210             if ($class == __CLASS__) {
 211                 break;
 212             }
 213             if (is_subclass_of($class, __CLASS__)) {
 214                 $obj = new $class;
 215                 $obj->setup();
 216             }
 217         }
 218     }
 219     // }}}
 220
 221     // void connection($db, $host) {{{
 222     /**
 223      *  Connect
 224      *
 225      *  This method setup parameters to connect to a MongoDB
 226      *  database. The connection is done when it is needed.
 227      *
 228      *  @param string $db   Database name
 229      *  @param string $host Host to connect
 230      *
 231      *  @return void
 232      */
 233     final public static function connect($db, $host='localhost')
 234     {
 235         self::$_host = $host;
 236         self::$_db   = $db;
 237     }
 238     // }}}
 239
 240     // MongoConnection _getConnection() {{{
 241     /**
 242      *  Get Connection
 243      *
 244      *  Get a valid database connection
 245      *
 246      *  @return MongoConnection
 247      */
 248     final protected function _getConnection()
 249     {
 250         if (is_null(self::$_conn)) {
 251             if (is_null(self::$_host)) {
 252                 self::$_host = 'localhost';
 253             }
 254             self::$_conn = new Mongo(self::$_host);
 255         }
 256         $dbname = $this->getDatabaseName();
 257         if (!isSet(self::$_dbs[$dbname])) {
 258             self::$_dbs[$dbname] = self::$_conn->selectDB($dbname);
 259         }
 260         return self::$_dbs[$dbname];
 261     }
 262     // }}}
 263
 264     // MongoCollection _getCollection() {{{
 265     /**
 266      *  Get Collection
 267      *
 268      *  Get a collection connection.
 269      *
 270      *  @return MongoCollection
 271      */
 272     final protected function _getCollection()
 273     {
 274         $colName = $this->getCollectionName();
 275         if (!isset(self::$_collections[$colName])) {
 276             self::$_collections[$colName] = self::_getConnection()->selectCollection($colName);
 277         }
 278         return self::$_collections[$colName];
 279     }
 280     // }}}
 281
 282     // }}}
 283
 284     // GET DOCUMENT TO SAVE OR UPDATE {{{
 285
 286     // bool getCurrentSubDocument(array &$document, string $parent_key, array $values, array $past_values) {{{
 287     /**
 288      *  Generate Sub-document
 289      *
 290      *  This method build the difference between the current sub-document,
 291      *  and the origin one. If there is no difference, it would do nothing,
 292      *  otherwise it would build a document containing the differences.
 293      *
 294      *  @param array  &$document    Document target
 295      *  @param string $parent_key   Parent key name
 296      *  @param array  $values       Current values
 297      *  @param array  $past_values  Original values
 298      *
 299      *  @return false
 300      */
 301     final function getCurrentSubDocument(&$document, $parent_key, Array $values, Array $past_values)
 302     {
 303         /**
 304          *  The current property is a embedded-document,
 305          *  now we're looking for differences with the
 306          *  previous value (because we're on an update).
 307          *
 308          *  It behaves exactly as getCurrentDocument,
 309          *  but this is simples (it doesn't support
 310          *  yet filters)
 311          */
 312         foreach ($values as $key => $value) {
 313             $super_key = "{$parent_key}.{$key}";
 314             if (is_array($value)) {
 315                 /**
 316                  *  Inner document detected
 317                  */
 318                 if (!isset($past_values[$key]) || !is_array($past_values[$key])) {
 319                     /**
 320                      *  We're lucky, it is a new sub-document,
 321                      *  we simple add it
 322                      */
 323                     $document['$set'][$super_key] = $value;
 324                 } else {
 325                     /**
 326                      *  This is a document like this, we need
 327                      *  to find out the differences to avoid
 328                      *  network overhead.
 329                      */
 330                     if (!$this->getCurrentSubDocument($document, $super_key, $value, $past_values[$key])) {
 331                         return false;
 332                     }
 333                 }
 334                 continue;
 335             } else if (!isset($past_values[$key]) || $past_values[$key] != $value) {
 336                 $document['$set'][$super_key] = $value;
 337             }
 338         }
 339
 340         foreach (array_diff(array_keys($past_values), array_keys($values)) as $key) {
 341             $super_key = "{$parent_key}.{$key}";
 342             $document['$unset'][$super_key] = 1;
 343         }
 344
 345         return true;
 346     }
 347     // }}}
 348
 349     // array getCurrentDocument(bool $update) {{{
 350     /**
 351      *    Get Current Document
 352      *
 353      *    Based on this object properties a new document (Array)
 354      *    is returned. If we're modifying an document, just the modified
 355      *    properties are included in this document, which uses $set,
 356      *    $unset, $pushAll and $pullAll.
 357      *
 358      *
 359      *    @param bool $update
 360      *
 361      *    @return array
 362      */
 363     final protected function getCurrentDocument($update=false, $current=false)
 364     {
 365         $document = array();
 366         $object   = get_object_vars_ex($this);
 367
 368         if (!$current) {
 369             $current = (array)$this->_current;
 370         }
 371
 372
 373         $this->findReferences($object);
 374
 375         $this->triggerEvent('before_validate_'.($update?'update':'creation'), array(&$object));
 376         $this->triggerEvent('before_validate', array(&$object));
 377
 378         foreach ($object as $key => $value) {
 379             if (!$value) {
 380                 continue;
 381             }
 382             if ($update) {
 383                 if (is_array($value) && isset($current[$key])) {
 384                     /**
 385                      *  If the Field to update is an array, it has a different
 386                      *  behaviour other than $set and $unset. Fist, we need
 387                      *  need to check if it is an array or document, because
 388                      *  they can't be mixed.
 389                      *
 390                      */
 391                     if (!is_array($current[$key])) {
 392                         /**
 393                          *  We're lucky, the field wasn't
 394                          *  an array previously.
 395                          */
 396                         $this->runFilter($key, $value, $current[$key]);
 397                         $document['$set'][$key] = $value;
 398                         continue;
 399                     }
 400
 401                     if (!$this->getCurrentSubDocument($document, $key, $value, $current[$key])) {
 402                         throw new Exception("{$key}: Array and documents are not compatible");
 403                     }
 404                 } else if(!isset($current[$key]) || $value !== $current[$key]) {
 405                     /**
 406                      *  It is 'linear' field that has changed, or
 407                      *  has been modified.
 408                      */
 409                     $past_value = isset($current[$key]) ? $current[$key] : null;
 410                     $this->runFilter($key, $value, $past_value);
 411                     $document['$set'][$key] = $value;
 412                 }
 413             } else {
 414                 /**
 415                  *  It is a document insertation, so we
 416                  *  create the document.
 417                  */
 418                 $this->runFilter($key, $value, null);
 419                 $document[$key] = $value;
 420             }
 421         }
 422
 423         /* Updated behaves in a diff. way */
 424         if ($update) {
 425             foreach (array_diff(array_keys($this->_current), array_keys($object)) as $property) {
 426                 if ($property == '_id') {
 427                     continue;
 428                 }
 429                 $document['$unset'][$property] = 1;
 430             }
 431         }
 432
 433         if (count($document) == 0) {
 434             return array();
 435         }
 436
 437         $this->triggerEvent('after_validate_'.($update?'update':'creation'), array(&$object));
 438         $this->triggerEvent('after_validate', array(&$document));
 439
 440         return $document;
 441     }
 442     // }}}
 443
 444     // }}}
 445
 446     // EVENT HANDLERS {{{
 447
 448     // addEvent($action, $callback) {{{
 449     /**
 450      *  addEvent
 451      *
 452      */
 453     final static function addEvent($action, $callback)
 454     {
 455         if (!is_callable($callback)) {
 456             throw new Exception("Invalid callback");
 457         }
 458
 459         $class = get_called_class();
 460         if ($class == __CLASS__) {
 461             $events = & self::$_super_events;
 462         } else {
 463             $events = & self::$_events[$class];
 464         }
 465         if (!isset($events[$action])) {
 466             $events[$action] = array();
 467         }
 468         $events[$action][] = $callback;
 469         return true;
 470     }
 471     // }}}
 472
 473     // triggerEvent(string $event, Array $events_params) {{{
 474     final function triggerEvent($event, Array $events_params = array())
 475     {
 476         $events  = & self::$_events[get_class($this)][$event];
 477         $sevents = & self::$_super_events[$event];
 478
 479         if (!is_array($events_params)) {
 480             return false;
 481         }
 482
 483         /* Super-Events handler receives the ActiveMongo class name as first param */
 484         $sevents_params = array_merge(array(get_class($this)), $events_params);
 485
 486         foreach (array('events', 'sevents') as $event_type) {
 487             if (count($$event_type) > 0) {
 488                 $params = "{$event_type}_params";
 489                 foreach ($$event_type as $fnc) {
 490                     call_user_func_array($fnc, $$params);
 491                 }
 492             }
 493         }
 494
 495         /* Some natives events are allowed to be called
 496          * as methods, if they exists
 497          */
 498         switch ($event) {
 499         case 'before_create':
 500         case 'before_update':
 501         case 'before_validate':
 502         case 'before_delete':
 503         case 'after_create':
 504         case 'after_update':
 505         case 'after_validate':
 506         case 'after_delete':
 507             $fnc    = array($this, $event);
 508             $params = "events_params";
 509             if (is_callable($fnc)) {
 510                 call_user_func_array($fnc, $$params);
 511             }
 512             break;
 513         }
 514     }
 515     // }}}
 516
 517      // void runFilter(string $key, mixed &$value, mixed $past_value) {{{
 518     /**
 519      *  *Internal Method*
 520      *
 521      *  This method check if the current document property has
 522      *  a filter method, if so, call it.
 523      *
 524      *  If the filter returns false, throw an Exception.
 525      *
 526      *  @return void
 527      */
 528     protected function runFilter($key, &$value, $past_value)
 529     {
 530         $filter = array($this, "{$key}_filter");
 531         if (is_callable($filter)) {
 532             $filter = call_user_func_array($filter, array(&$value, $past_value));
 533             if ($filter===false) {
 534                 throw new ActiveMongo_FilterException("{$key} filter failed");
 535             }
 536             $this->$key = $value;
 537         }
 538     }
 539     // }}}
 540
 541     // }}}
 542
 543     // void setCursor(MongoCursor $obj) {{{
 544     /**
 545      *  Set Cursor
 546      *
 547      *  This method receive a MongoCursor and make
 548      *  it iterable.
 549      *
 550      *  @param MongoCursor $obj
 551      *
 552      *  @return void
 553      */
 554     final protected function setCursor(MongoCursor $obj)
 555     {
 556         $this->_cursor = $obj;
 557         $this->setResult($obj->getNext());
 558     }
 559     // }}}
 560
 561     // void setResult(Array $obj) {{{
 562     /**
 563      *  Set Result
 564      *
 565      *  This method takes an document and copy it
 566      *  as properties in this object.
 567      *
 568      *  @param Array $obj
 569      *
 570      *  @return void
 571      */
 572     final protected function setResult($obj)
 573     {
 574         /* Unsetting previous results, if any */
 575         foreach (array_keys((array)$this->_current) as $key) {
 576             unset($this->$key);
 577         }
 578
 579         /* Add our current resultset as our object's property */
 580         foreach ((array)$obj as $key => $value) {
 581             if ($key[0] == '$') {
 582                 continue;
 583             }
 584             $this->$key = $value;
 585         }
 586
 587         /* Save our record */
 588         $this->_current = $obj;
 589     }
 590     // }}}
 591
 592     // this find([$_id]) {{{
 593     /**
 594      *    Simple find.
 595      *
 596      *    Really simple find, which uses this object properties
 597      *    for fast filtering
 598      *
 599      *    @return object this
 600      */
 601     final function find($_id = null)
 602     {
 603         $vars = get_object_vars_ex($this);
 604         foreach ($vars as $key => $value) {
 605             if (!$value) {
 606                 unset($vars[$key]);
 607             }
 608             $parent_class = __CLASS__;
 609             if ($value InstanceOf $parent_class) {
 610                 $this->getColumnDeference($vars, $key, $value);
 611                 unset($vars[$key]); /* delete old value */
 612             }
 613         }
 614         if ($_id != null) {
 615             if (is_array($_id)) {
 616                 $vars['_id'] = array('$in' => $_id);
 617             } else {
 618                 $vars['_id'] = $_id;
 619             }
 620         }
 621         $res  = $this->_getCollection()->find($vars);
 622         $this->setCursor($res);
 623         return $this;
 624     }
 625     // }}}
 626
 627     // void save(bool $async) {{{
 628     /**
 629      *    Save
 630      *
 631      *    This method save the current document in MongoDB. If
 632      *    we're modifying a document, a update is performed, otherwise
 633      *    the document is inserted.
 634      *
 635      *    On updates, special operations such as $set, $pushAll, $pullAll
 636      *    and $unset in order to perform efficient updates
 637      *
 638      *    @param bool $async
 639      *
 640      *    @return void
 641      */
 642     final function save($async=true)
 643     {
 644         $update = isset($this->_id) && $this->_id InstanceOf MongoID;
 645         $conn   = $this->_getCollection();
 646         $obj    = $this->getCurrentDocument($update);
 647         if (count($obj) == 0) {
 648             return; /*nothing to do */
 649         }
 650
 651          /* PRE-save hook */
 652         $this->triggerEvent('before_'.($update ? 'update' : 'create'), array(&$obj));
 653
 654         if ($update) {
 655             $conn->update(array('_id' => $this->_id), $obj);
 656             foreach ($obj as $key => $value) {
 657                 if ($key[0] == '$') {
 658                     continue;
 659                 }
 660                 $this->_current[$key] = $value;
 661             }
 662         } else {
 663             $conn->insert($obj, $async);
 664             $this->_id      = $obj['_id'];
 665             $this->_current = $obj;
 666         }
 667
 668         $this->triggerEvent('after_'.($update ? 'update' : 'create'), array($obj));
 669     }
 670     // }}}
 671
 672     // bool delete() {{{
 673     /**
 674      *  Delete the current document
 675      *
 676      *  @return bool
 677      */
 678     final function delete()
 679     {
 680         if ($this->valid()) {
 681             $document = array('_id' => $this->_id);
 682             $this->triggerEvent('before_delete', array($document));
 683             $result = $this->_getCollection()->remove($document);
 684             $this->triggerEvent('after_delete', array($document));
 685             return $result;
 686         }
 687         return false;
 688     }
 689     // }}}
 690
 691     // void drop() {{{
 692     /**
 693      *  Delete the current colleciton and all its documents
 694      *
 695      *  @return void
 696      */
 697     final static function drop()
 698     {
 699         $class = get_called_class();
 700         if ($class == __CLASS__) {
 701             return false;
 702         }
 703         $obj = new $class;
 704         return $obj->_getCollection()->drop();
 705     }
 706     // }}}
 707
 708     // int count() {{{
 709     /**
 710      *  Return the number of documents in the actual request. If
 711      *  we're not in a request, it will return 0.
 712      *
 713      *  @return int
 714      */
 715     final function count()
 716     {
 717         if ($this->valid()) {
 718             return $this->_cursor->count();
 719         }
 720         return 0;
 721     }
 722     // }}}
 723
 724     // void setup() {{{
 725     /**
 726      *  This method should contain all the indexes, and shard keys
 727      *  needed by the current collection. This try to make
 728      *  installation on development environments easier.
 729      */
 730     function setup()
 731     {
 732     }
 733     // }}}
 734
 735     // bool addIndex(array $columns, array $options) {{{
 736     /**
 737      *  addIndex
 738      *
 739      *  Create an Index in the current collection.
 740      *
 741      *  @param array $columns L ist of columns
 742      *  @param array $options Options
 743      *
 744      *  @return bool
 745      */
 746     final function addIndex($columns, $options=array())
 747     {
 748         $default_options = array(
 749             'background' => 1,
 750         );
 751
 752        foreach ($default_options as $option => $value) {
 753             if (!isset($options[$option])) {
 754                 $options[$option] = $value;
 755             }
 756         }
 757
 758         $collection = $this->_getCollection();
 759
 760         return $collection->ensureIndex($columns, $options);
 761     }
 762     // }}}
 763
 764     // string __toString() {{{
 765     /**
 766      *  To String
 767      *
 768      *  If this object is treated as a string,
 769      *  it would return its ID.
 770      *
 771      *  @return string
 772      */
 773     final function __toString()
 774     {
 775         return (string)$this->getID();
 776     }
 777     // }}}
 778
 779     // array sendCmd(array $cmd) {{{
 780     /**
 781      *  This method sends a command to the current
 782      *  database.
 783      *
 784      *  @param array $cmd Current command
 785      *
 786      *  @return array
 787      */
 788     final protected function sendCmd($cmd)
 789     {
 790         return $this->_getConnection()->command($cmd);
 791     }
 792     // }}}
 793
 794     // ITERATOR {{{
 795
 796     // void reset() {{{
 797     /**
 798      *  Reset our Object, delete the current cursor if any, and reset
 799      *  unsets the values.
 800      *
 801      *  @return void
 802      */
 803     final function reset()
 804     {
 805         $this->_columns = null;
 806         $this->_cursor  = null;
 807         $this->_query   = null;
 808         $this->_sort    = null;
 809         $this->_limit   = 0;
 810         $this->_skip    = 0;
 811         $this->setResult(array());
 812     }
 813     // }}}
 814
 815     // bool valid() {{{
 816     /**
 817      *    Valid
 818      *
 819      *    Return if we're on an iteration and if it is still valid
 820      *
 821      *    @return true
 822      */
 823     final function valid()
 824     {
 825         return $this->_cursor InstanceOf MongoCursor && $this->_cursor->valid();
 826     }
 827     // }}}
 828
 829     // bool next() {{{
 830     /**
 831      *    Move to the next document
 832      *
 833      *    @return bool
 834      */
 835     final function next()
 836     {
 837         if ($this->_cloned) {
 838             throw new MongoException("Cloned objects can't iterate");
 839         }
 840         return $this->_cursor->next();
 841     }
 842     // }}}
 843
 844     // this current() {{{
 845     /**
 846      *    Return the current object, and load the current document
 847      *    as this object property
 848      *
 849      *    @return object
 850      */
 851     final function current()
 852     {
 853         $this->setResult($this->_cursor->current());
 854         return $this;
 855     }
 856     // }}}
 857
 858     // bool rewind() {{{
 859     /**
 860      *    Go to the first document
 861      */
 862     final function rewind()
 863     {
 864         if (!$this->_cursor InstanceOf MongoCursor) {
 865             $this->doQuery();
 866         }
 867         return $this->_cursor->rewind();
 868     }
 869     // }}}
 870
 871     // }}}
 872
 873     // REFERENCES {{{
 874
 875     // array getReference() {{{
 876     /**
 877      *  ActiveMongo extended the Mongo references, adding
 878      *  the concept of 'dynamic' requests, saving in the database
 879      *  the current query with its options (sort, limit, etc).
 880      *
 881      *  This is useful to associate a document with a given
 882      *  request. To undestand this better please see the 'reference'
 883      *  example.
 884      *
 885      *  @return array
 886      */
 887     final function getReference($dynamic=false)
 888     {
 889         if (!$this->getID() && !$dynamic) {
 890             return null;
 891         }
 892
 893         $document = array(
 894             '$ref'  => $this->getCollectionName(),
 895             '$id'   => $this->getID(),
 896             '$db'   => $this->getDatabaseName(),
 897             'class' => get_class($this),
 898         );
 899
 900         if ($dynamic && $this->_cursor InstanceOf MongoCursor) {
 901             $cursor = $this->_cursor;
 902             if (!is_callable(array($cursor, "Info"))) {
 903                 throw new Exception("Please upgrade your PECL/Mongo module to use this feature");
 904             }
 905             $document['dynamic'] = array();
 906             $query  = $cursor->Info();
 907             foreach ($query as $type => $value) {
 908                 $document['dynamic'][$type] = $value;
 909             }
 910         }
 911         return $document;
 912     }
 913     // }}}
 914
 915     // void getDocumentReferences($document, &$refs) {{{
 916     /**
 917      *  Get Current References
 918      *
 919      *  Inspect the current document trying to get any references,
 920      *  if any.
 921      *
 922      *  @param array $document   Current document
 923      *  @param array &$refs      References found in the document.
 924      *  @param array $parent_key Parent key
 925      *
 926      *  @return void
 927      */
 928     final protected function getDocumentReferences($document, &$refs, $parent_key=null)
 929     {
 930         foreach ($document as $key => $value) {
 931            if (is_array($value)) {
 932                if (MongoDBRef::isRef($value)) {
 933                    $pkey   = $parent_key;
 934                    $pkey[] = $key;
 935                    $refs[] = array('ref' => $value, 'key' => $pkey);
 936                } else {
 937                    $parent_key[] = $key;
 938                    $this->getDocumentReferences($value, $refs, $parent_key);
 939                }
 940            }
 941         }
 942     }
 943     // }}}
 944
 945     // object _deferencingCreateObject(string $class) {{{
 946     /**
 947      *  Called at deferencig time
 948      *
 949      *  Check if the given string is a class, and it is a sub class
 950      *  of ActiveMongo, if it is instance and return the object.
 951      *
 952      *  @param string $class
 953      *
 954      *  @return object
 955      */
 956     private function _deferencingCreateObject($class)
 957     {
 958         if (!is_subclass_of($class, __CLASS__)) {
 959             throw new MongoException("Fatal Error, imposible to create ActiveMongo object of {$class}");
 960         }
 961         return new $class;
 962     }
 963     // }}}
 964
 965     // void _deferencingRestoreProperty(array &$document, array $keys, mixed $req) {{{
 966     /**
 967      *  Called at deferencig time
 968      *
 969      *  This method iterates $document until it could match $keys path, and
 970      *  replace its value by $req.
 971      *
 972      *  @param array &$document Document to replace
 973      *  @param array $keys      Path of property to change
 974      *  @param mixed $req       Value to replace.
 975      *
 976      *  @return void
 977      */
 978     private function _deferencingRestoreProperty(&$document, $keys, $req)
 979     {
 980         $obj = & $document;
 981
 982         /* find the $req proper spot */
 983         foreach ($keys as $key) {
 984             $obj = & $obj[$key];
 985         }
 986
 987         $obj = $req;
 988
 989         /* Delete reference variable */
 990         unset($obj);
 991     }
 992     // }}}
 993
 994     // object _deferencingQuery($request) {{{
 995     /**
 996      *  Called at deferencig time
 997      *
 998      *  This method takes a dynamic reference and request
 999      *  it to MongoDB.
1000      *
1001      *  @param array $request Dynamic reference
1002      *
1003      *  @return this
1004      */
1005     private function _deferencingQuery($request)
1006     {
1007         $collection = $this->_getCollection();
1008         $cursor     = $collection->find($request['query'], $request['fields']);
1009         if ($request['limit'] > 0) {
1010             $cursor->limit($request['limit']);
1011         }
1012         if ($request['skip'] > 0) {
1013             $cursor->limit($request['limit']);
1014         }
1015
1016         $this->setCursor($cursor);
1017
1018         return $this;
1019     }
1020     // }}}
1021
1022     // void doDeferencing() {{{
1023     /**
1024      *  Perform a deferencing in the current document, if there is
1025      *  any reference.
1026      *
1027      *  ActiveMongo will do its best to group references queries as much
1028      *  as possible, in order to perform as less request as possible.
1029      *
1030      *  ActiveMongo doesn't rely on MongoDB references, but it can support
1031      *  it, but it is prefered to use our referencing.
1032      *
1033      *  @experimental
1034      */
1035     final function doDeferencing($refs=array())
1036     {
1037         /* Get current document */
1038         $document = get_object_vars_ex($this);
1039
1040         if (count($refs)==0) {
1041             /* Inspect the whole document */
1042             $this->getDocumentReferences($document, $refs);
1043         }
1044
1045         $db = $this->_getConnection();
1046
1047         /* Gather information about ActiveMongo Objects
1048          * that we need to create
1049          */
1050         $classes = array();
1051         foreach ($refs as $ref) {
1052             if (!isset($ref['ref']['class'])) {
1053
1054                 /* Support MongoDBRef, we do our best to be compatible {{{ */
1055                 /* MongoDB 'normal' reference */
1056
1057                 $obj = MongoDBRef::get($db, $ref['ref']);
1058
1059                 /* Offset the current document to the right spot */
1060                 /* Very inefficient, never use it, instead use ActiveMongo References */
1061
1062                 $this->_deferencingRestoreProperty($document, $ref['key'], clone $req);
1063
1064                 /* Dirty hack, override our current document
1065                  * property with the value itself, in order to
1066                  * avoid replace a MongoDB reference by its content
1067                  */
1068                 $this->_deferencingRestoreProperty($this->_current, $ref['key'], clone $req);
1069
1070                 /* }}} */
1071
1072             } else {
1073
1074                 if (isset($ref['ref']['dynamic'])) {
1075                     /* ActiveMongo Dynamic Reference */
1076
1077                     /* Create ActiveMongo object */
1078                     $req = $this->_deferencingCreateObject($ref['ref']['class']);
1079
1080                     /* Restore saved query */
1081                     $req->_deferencingQuery($ref['ref']['dynamic']);
1082
1083                     $results = array();
1084
1085                     /* Add the result set */
1086                     foreach ($req as $result) {
1087                         $results[]  = clone $result;
1088                     }
1089
1090                     /* add  information about the current reference */
1091                     foreach ($ref['ref'] as $key => $value) {
1092                         $results[$key] = $value;
1093                     }
1094
1095                     $this->_deferencingRestoreProperty($document, $ref['key'], $results);
1096
1097                 } else {
1098                     /* ActiveMongo Reference FTW! */
1099                     $classes[$ref['ref']['class']][] = $ref;
1100                 }
1101             }
1102         }
1103
1104         /* {{{ Create needed objects to query MongoDB and replace
1105          * our references by its objects documents.
1106          */
1107         foreach ($classes as $class => $refs) {
1108             $req = $this->_deferencingCreateObject($class);
1109
1110             /* Load list of IDs */
1111             $ids = array();
1112             foreach ($refs as $ref) {
1113                 $ids[] = $ref['ref']['$id'];
1114             }
1115
1116             /* Search to MongoDB once for all IDs found */
1117             $req->find($ids);
1118
1119             if ($req->count() != count($refs)) {
1120                 $total    = $req->count();
1121                 $expected = count($refs);
1122                 throw new MongoException("Dereferencing error, MongoDB replied {$total} objects, we expected {$expected}");
1123             }
1124
1125             /* Replace our references by its objects */
1126             foreach ($refs as $ref) {
1127                 $id    = $ref['ref']['$id'];
1128                 $place = $ref['key'];
1129                 $req->rewind();
1130                 while ($req->getID() != $id && $req->next());
1131
1132                 assert($req->getID() == $id);
1133
1134                 $this->_deferencingRestoreProperty($document, $place, clone $req);
1135
1136                 unset($obj);
1137             }
1138
1139             /* Release request, remember we
1140              * safely cloned it,
1141              */
1142             unset($req);
1143         }
1144         // }}}
1145
1146         /* Replace the current document by the new deferenced objects */
1147         foreach ($document as $key => $value) {
1148             $this->$key = $value;
1149         }
1150     }
1151     // }}}
1152
1153     // void getColumnDeference(&$document, $propety, ActiveMongo Obj) {{{
1154     /**
1155      *  Prepare a "selector" document to search treaing the property
1156      *  as a reference to the given ActiveMongo object.
1157      *
1158      */
1159     final function getColumnDeference(&$document, $property, ActiveMongo $obj)
1160     {
1161         $document["{$property}.\$id"] = $obj->getID();
1162     }
1163     // }}}
1164
1165     // void findReferences(&$document) {{{
1166     /**
1167      *  Check if in the current document to insert or update
1168      *  exists any references to other ActiveMongo Objects.
1169      *
1170      *  @return void
1171      */
1172     final function findReferences(&$document)
1173     {
1174         if (!is_array($document)) {
1175             return;
1176         }
1177         foreach($document as &$value) {
1178             $parent_class = __CLASS__;
1179             if (is_array($value)) {
1180                 if (MongoDBRef::isRef($value)) {
1181                     /*  If the property we're inspecting is a reference,
1182                      *  we need to remove the values, restoring the valid
1183                      *  Reference.
1184                      */
1185                     $arr = array(
1186                         '$ref'=>1, '$id'=>1, '$db'=>1, 'class'=>1, 'dynamic'=>1
1187                     );
1188                     foreach (array_keys($value) as $key) {
1189                         if (!isset($arr[$key])) {
1190                             unset($value[$key]);
1191                         }
1192                     }
1193                 } else {
1194                     $this->findReferences($value);
1195                 }
1196             } else if ($value InstanceOf $parent_class) {
1197                 $value = $value->getReference();
1198             }
1199         }
1200         /* trick: delete last var. reference */
1201         unset($value);
1202     }
1203     // }}}
1204
1205     // void __clone() {{{
1206     /**
1207      *  Cloned objects are rarely used, but ActiveMongo
1208      *  uses it to create different objects per everyrecord,
1209      *  which is used at deferencing. Therefore cloned object
1210      *  do not contains the recordset, just the actual document,
1211      *  so iterations are not allowed.
1212      *
1213      */
1214     final function __clone()
1215     {
1216         unset($this->_cursor);
1217         $this->_cloned = true;
1218     }
1219     // }}}
1220
1221     // }}}
1222
1223     // GET DOCUMENT ID {{{
1224
1225     // getID() {{{
1226     /**
1227      *  Return the current document ID. If there is
1228      *  no document it would return false.
1229      *
1230      *  @return object|false
1231      */
1232     final public function getID()
1233     {
1234         if ($this->_id instanceof MongoID) {
1235             return $this->_id;
1236         }
1237         return false;
1238     }
1239     // }}}
1240
1241     // string key() {{{
1242     /**
1243      *    Return the current key
1244      *
1245      *    @return string
1246      */
1247     final function key()
1248     {
1249         return $this->getID();
1250     }
1251     // }}}
1252
1253     // }}}
1254
1255     // Fancy (and silly) query abstraction {{{
1256
1257     final protected function doQuery()
1258     {
1259         $col = $this->_getCollection();
1260         if (count($this->_columns) > 0) {
1261             $cursor = $col->find((array)$this->_query['query'], $this->_columns);
1262         } else {
1263             $cursor = $col->find((array)$this->_query['query']);
1264         }
1265         if (is_array($this->_sort)) {
1266             $cursor->sort($this->_sort);
1267         }
1268         if ($this->_limit > 0) {
1269             $cursor->limit($this->_limit);
1270         }
1271         if ($this->_skip > 0) {
1272             $this->skip($this->_skip);
1273         }
1274         /* Our cursor must be sent to ActiveMongo */
1275         $this->setCursor($cursor);
1276     }
1277
1278     final function columns($columns)
1279     {
1280         if (!is_array($columns) && !is_string($columns)) {
1281             return false;
1282         }
1283
1284         if (is_string($columns)) {
1285             $columns = explode(",", $columns);
1286         }
1287
1288         foreach ($columns as $id => $name) {
1289             $columns[trim($name)] = 1;
1290             unset($columns[$id]);
1291         }
1292
1293         $this->_columns = $columns;
1294     }
1295
1296     /**
1297      *  Where abstraction
1298      *
1299      */
1300     final function where($column_str, $value)
1301     {
1302         $column = explode(" ", $column_str);
1303         if (count($column) != 1 && count($column) != 2) {
1304             throw new ActiveMongo_Exception("Failed while parsing '{$column_str}'");
1305         } else if (count($column) == 2) {
1306             switch ($column[1]) {
1307             case '>':
1308                 $op = '$gt';
1309                 break;
1310             case '>=':
1311                 $op = '$gte';
1312             case '<':
1313                 $op = '$lt';
1314                 break;
1315             case '<=':
1316                 $op = '$lte';
1317                 break;
1318             case '==':
1319                 $op = '$eq';
1320             case '!=':
1321                 $op = '$ne';
1322                 break;
1323             case 'near':
1324                 $op = '$near';
1325                 break;
1326             default:
1327                 throw new ActiveMongo_Exception("Failed to parse '{$column[1]}'");
1328             }
1329             $value = array($op => $value);
1330             if (is_array($value) || $op != '$near') {
1331                 throw new ActiveMongo_Exception("Cannot use comparing operations with Array");
1332             }
1333         } else if (is_array($value)) {
1334             $value = array('$in' => $value);
1335         }
1336
1337         $this->_query['query'][$column[0]] =  $value;
1338     }
1339
1340     final function sort($sort_str)
1341     {
1342         $this->_sort = array();
1343         foreach ((array)explode(",", $sort_str) as $sort_part_str) {
1344             $sort_part = explode(" ", $sort_part_str, 2);
1345             switch(count($sort_part)) {
1346             case 1:
1347                 $sort_part[1] = 'ASC';
1348                 break;
1349             case 2:
1350                 break;
1351             default:
1352                 throw new ActiveMongo_Exception("Don't know how to parse {$sort_part_str}");
1353             }
1354
1355             switch (strtoupper($sort_part[1])) {
1356             case 'ASC':
1357                 $sort_part[1] = 1;
1358                 break;
1359             case 'DESC':
1360                 $sort_part[1] = -1;
1361                 break;
1362             default:
1363                 throw new ActiveMongo_Exception("Invalid sorting direction {$sort_part[1]}");
1364             }
1365             $this->_sort[ $sort_part[0] ] = $sort_part[1];
1366         }
1367     }
1368
1369     final function limit($limit=0, $skip=0)
1370     {
1371         if ($limit < 0 || $skip < 0) {
1372             return false;
1373         }
1374         $this->_limit = $limit;
1375         $this->_skip  = $skip;
1376     }
1377
1378     // }}}
1379
1380 }
1381
1382 require_once dirname(__FILE__)."/Validators.php";
1383
1384 /*
1385  * Local variables:
1386  * tab-width: 4
1387  * c-basic-offset: 4
1388  * End:
1389  * vim600: sw=4 ts=4 fdm=marker
1390  * vim<600: sw=4 ts=4
1391  */