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