CRM/Core/BAO/RecurringEntity.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 require_once 'packages/When/When.php';
  35
  36 /**
  37  * Class CRM_Core_BAO_RecurringEntity.
  38  */
  39 class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity {
  40
  41   const RUNNING = 1;
  42   public $schedule = array();
  43   public $scheduleId = NULL;
  44   public $scheduleFormValues = array();
  45
  46   public $dateColumns = array();
  47   public $overwriteColumns = array();
  48   public $intervalDateColumns = array();
  49   public $excludeDates = array();
  50
  51   public $linkedEntities = array();
  52
  53   public $isRecurringEntityRecord = TRUE;
  54
  55   protected $recursion = NULL;
  56   protected $recursion_start_date = NULL;
  57
  58   public static $_entitiesToBeDeleted = array();
  59
  60   public static $status = NULL;
  61
  62   static $_recurringEntityHelper
  63     = array(
  64       'civicrm_event' => array(
  65         'helper_class' => 'CRM_Event_DAO_Event',
  66         'delete_func' => 'delete',
  67         'pre_delete_func' => 'CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents',
  68       ),
  69       'civicrm_activity' => array(
  70         'helper_class' => 'CRM_Activity_DAO_Activity',
  71         'delete_func' => 'delete',
  72         'pre_delete_func' => '',
  73       ),
  74     );
  75
  76   static $_dateColumns
  77     = array(
  78       'civicrm_event' => array(
  79         'dateColumns' => array('start_date'),
  80         'excludeDateRangeColumns' => array('start_date', 'end_date'),
  81         'intervalDateColumns' => array('end_date'),
  82       ),
  83       'civicrm_activity' => array(
  84         'dateColumns' => array('activity_date_time'),
  85       ),
  86     );
  87
  88   static $_tableDAOMapper
  89     = array(
  90       'civicrm_event' => 'CRM_Event_DAO_Event',
  91       'civicrm_price_set_entity' => 'CRM_Price_DAO_PriceSetEntity',
  92       'civicrm_uf_join' => 'CRM_Core_DAO_UFJoin',
  93       'civicrm_tell_friend' => 'CRM_Friend_DAO_Friend',
  94       'civicrm_pcp_block' => 'CRM_PCP_DAO_PCPBlock',
  95       'civicrm_activity' => 'CRM_Activity_DAO_Activity',
  96       'civicrm_activity_contact' => 'CRM_Activity_DAO_ActivityContact',
  97     );
  98
  99   static $_updateSkipFields
 100     = array(
 101       'civicrm_event' => array('start_date', 'end_date'),
 102       'civicrm_tell_friend' => array('entity_id'),
 103       'civicrm_pcp_block' => array('entity_id'),
 104       'civicrm_activity' => array('activity_date_time'),
 105     );
 106
 107   static $_linkedEntitiesInfo
 108     = array(
 109       'civicrm_tell_friend' => array(
 110         'entity_id_col' => 'entity_id',
 111         'entity_table_col' => 'entity_table',
 112       ),
 113       'civicrm_price_set_entity' => array(
 114         'entity_id_col' => 'entity_id',
 115         'entity_table_col' => 'entity_table',
 116         'is_multirecord' => TRUE,
 117       ),
 118       'civicrm_uf_join' => array(
 119         'entity_id_col' => 'entity_id',
 120         'entity_table_col' => 'entity_table',
 121         'is_multirecord' => TRUE,
 122       ),
 123       'civicrm_pcp_block' => array(
 124         'entity_id_col' => 'entity_id',
 125         'entity_table_col' => 'entity_table',
 126       ),
 127     );
 128
 129   //Define global CLASS CONSTANTS for recurring entity mode types
 130   const MODE_THIS_ENTITY_ONLY = 1;
 131   const MODE_NEXT_ALL_ENTITY = 2;
 132   const MODE_ALL_ENTITY_IN_SERIES = 3;
 133
 134   /**
 135    * Getter for status.
 136    *
 137    * @return string
 138    */
 139   public static function getStatus() {
 140     return self::$status;
 141   }
 142
 143   /**
 144    * Setter for status.
 145    *
 146    * @param string $status
 147    */
 148   public static function setStatus($status) {
 149     self::$status = $status;
 150   }
 151
 152   /**
 153    * Save records in civicrm_recurring_entity table.
 154    *
 155    * @param array $params
 156    *   Reference array contains the values submitted by the form.
 157    *
 158    * @return object
 159    */
 160   public static function add(&$params) {
 161     if (!empty($params['id'])) {
 162       CRM_Utils_Hook::pre('edit', 'RecurringEntity', $params['id'], $params);
 163     }
 164     else {
 165       CRM_Utils_Hook::pre('create', 'RecurringEntity', NULL, $params);
 166     }
 167
 168     $daoRecurringEntity = new CRM_Core_DAO_RecurringEntity();
 169     $daoRecurringEntity->copyValues($params);
 170     $daoRecurringEntity->find(TRUE);
 171     $result = $daoRecurringEntity->save();
 172
 173     if (!empty($params['id'])) {
 174       CRM_Utils_Hook::post('edit', 'RecurringEntity', $daoRecurringEntity->id, $daoRecurringEntity);
 175     }
 176     else {
 177       CRM_Utils_Hook::post('create', 'RecurringEntity', $daoRecurringEntity->id, $daoRecurringEntity);
 178     }
 179     return $result;
 180   }
 181
 182   /**
 183    * Wrapper for the function add() to add entry in recurring entity
 184    *
 185    * @param int $parentId
 186    *   Parent entity id .
 187    * @param int $entityId
 188    *   Child entity id .
 189    * @param string $entityTable
 190    *   Name of the entity table .
 191    *
 192    *
 193    * @return object
 194    */
 195   public static function quickAdd($parentId, $entityId, $entityTable) {
 196     $params
 197       = array(
 198         'parent_id' => $parentId,
 199         'entity_id' => $entityId,
 200         'entity_table' => $entityTable,
 201       );
 202     return self::add($params);
 203   }
 204
 205   /**
 206    * This function updates the mode column in the civicrm_recurring_entity table.
 207    *
 208    * @param int $mode
 209    *   Mode of the entity to cascade changes across parent/child relations eg 1 - only this entity, 2 - this and the following entities, 3 - All the entity.
 210    */
 211   public function mode($mode) {
 212     if ($this->entity_id && $this->entity_table) {
 213       if ($this->find(TRUE)) {
 214         $this->mode = $mode;
 215       }
 216       else {
 217         $this->parent_id = $this->entity_id;
 218         $this->mode = $mode;
 219       }
 220       $this->save();
 221     }
 222   }
 223
 224   /**
 225    * This function generates all new entities based on object vars.
 226    *
 227    * @return array
 228    */
 229   public function generate() {
 230     $this->generateRecursiveDates();
 231
 232     return $this->generateEntities();
 233   }
 234
 235   /**
 236    * This function builds a "When" object based on schedule/reminder params
 237    *
 238    * @return object
 239    *   When object
 240    */
 241   public function generateRecursion() {
 242     // return if already generated
 243     if (is_a($this->recursion, 'When')) {
 244       return $this->recursion;
 245     }
 246
 247     if ($this->scheduleId) {
 248       // get params by ID
 249       $this->schedule = $this->getScheduleParams($this->scheduleId);
 250     }
 251     elseif (!empty($this->scheduleFormValues)) {
 252       $this->schedule = $this->mapFormValuesToDB($this->scheduleFormValues);
 253     }
 254
 255     if (!empty($this->schedule)) {
 256       $this->recursion = $this->getRecursionFromSchedule($this->schedule);
 257     }
 258     return $this->recursion;
 259   }
 260
 261   /**
 262    * Generate new DAOs and along with entries in civicrm_recurring_entity table.
 263    *
 264    * @return array
 265    */
 266   public function generateEntities() {
 267     self::setStatus(self::RUNNING);
 268
 269     $newEntities = array();
 270     $findCriteria = array();
 271     if (!empty($this->recursionDates)) {
 272       if ($this->entity_id) {
 273         $findCriteria = array('id' => $this->entity_id);
 274
 275         // save an entry with initiating entity-id & entity-table
 276         if ($this->entity_table && !$this->find(TRUE)) {
 277           $this->parent_id = $this->entity_id;
 278           $this->save();
 279         }
 280       }
 281       if (empty($findCriteria)) {
 282         CRM_Core_Error::fatal("Find criteria missing to generate form. Make sure entity_id and table is set.");
 283       }
 284
 285       $count = 0;
 286       foreach ($this->recursionDates as $key => $dateCols) {
 287         $newCriteria = $dateCols;
 288         foreach ($this->overwriteColumns as $col => $val) {
 289           $newCriteria[$col] = $val;
 290         }
 291         // create main entities
 292         $obj = CRM_Core_BAO_RecurringEntity::copyCreateEntity($this->entity_table,
 293           $findCriteria,
 294           $newCriteria,
 295           $this->isRecurringEntityRecord
 296         );
 297
 298         if (is_a($obj, 'CRM_Core_DAO') && $obj->id) {
 299           $newCriteria = array();
 300           $newEntities[$this->entity_table][$count] = $obj->id;
 301
 302           foreach ($this->linkedEntities as $linkedInfo) {
 303             foreach ($linkedInfo['linkedColumns'] as $col) {
 304               $newCriteria[$col] = $obj->id;
 305             }
 306             // create linked entities
 307             $linkedObj = CRM_Core_BAO_RecurringEntity::copyCreateEntity($linkedInfo['table'],
 308               $linkedInfo['findCriteria'],
 309               $newCriteria,
 310               CRM_Utils_Array::value('isRecurringEntityRecord', $linkedInfo, TRUE)
 311             );
 312
 313             if (is_a($linkedObj, 'CRM_Core_DAO') && $linkedObj->id) {
 314               $newEntities[$linkedInfo['table']][$count] = $linkedObj->id;
 315             }
 316           }
 317         }
 318         $count++;
 319       }
 320     }
 321
 322     self::$status = NULL;
 323     return $newEntities;
 324   }
 325
 326   /**
 327    * This function iterates through when object criteria and
 328    * generates recursive dates based on that
 329    *
 330    * @return array
 331    *   array of dates
 332    */
 333   public function generateRecursiveDates() {
 334     $this->generateRecursion();
 335
 336     $recursionDates = array();
 337     if (is_a($this->recursion, 'When')) {
 338       $initialCount = CRM_Utils_Array::value('start_action_offset', $this->schedule);
 339
 340       $exRangeStart = $exRangeEnd = NULL;
 341       if (!empty($this->excludeDateRangeColumns)) {
 342         $exRangeStart = $this->excludeDateRangeColumns[0];
 343         $exRangeEnd = $this->excludeDateRangeColumns[1];
 344       }
 345
 346       $count = 1;
 347       while ($result = $this->recursion->next()) {
 348         $skip = FALSE;
 349         if ($result == $this->recursion_start_date) {
 350           // skip the recursion-start-date from the list we going to generate
 351           $skip = TRUE;
 352         }
 353         $baseDate = CRM_Utils_Date::processDate($result->format('Y-m-d H:i:s'));
 354
 355         foreach ($this->dateColumns as $col) {
 356           $recursionDates[$count][$col] = $baseDate;
 357         }
 358         foreach ($this->intervalDateColumns as $col => $interval) {
 359           $newDate = new DateTime($baseDate);
 360           $newDate->add($interval);
 361           $recursionDates[$count][$col] = CRM_Utils_Date::processDate($newDate->format('Y-m-d H:i:s'));
 362         }
 363         if ($exRangeStart) {
 364           $exRangeStartDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value($exRangeStart, $recursionDates[$count]), NULL, FALSE, 'Ymd');
 365           $exRangeEndDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value($exRangeEnd, $recursionDates[$count]), NULL, FALSE, 'Ymd');
 366         }
 367
 368         foreach ($this->excludeDates as $exDate) {
 369           $exDate = CRM_Utils_Date::processDate($exDate, NULL, FALSE, 'Ymd');
 370           if (!$exRangeStart) {
 371             if ($exDate == $result->format('Ymd')) {
 372               $skip = TRUE;
 373               break;
 374             }
 375           }
 376           else {
 377             if (($exDate == $exRangeStartDate) ||
 378               ($exRangeEndDate && ($exDate > $exRangeStartDate) && ($exDate <= $exRangeEndDate))
 379             ) {
 380               $skip = TRUE;
 381               break;
 382             }
 383           }
 384         }
 385
 386         if ($skip) {
 387           unset($recursionDates[$count]);
 388           if ($initialCount && ($initialCount > 0)) {
 389             // lets increase the counter, so we get correct number of occurrences
 390             $initialCount++;
 391             $this->recursion->count($initialCount);
 392           }
 393           continue;
 394         }
 395         $count++;
 396       }
 397     }
 398     $this->recursionDates = $recursionDates;
 399
 400     return $recursionDates;
 401   }
 402
 403   /**
 404    * This function gets all the children for a particular parent entity.
 405    *
 406    * @param int $parentId
 407    *   Parent entity id .
 408    * @param string $entityTable
 409    *   Name of the entity table .
 410    * @param bool $includeParent
 411    *   If true parent id is included in result set and vice versa .
 412    * @param int $mode
 413    *   1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. .
 414    * @param int $initiatorId
 415    *   The instance where this function is invoked from .
 416    *
 417    *
 418    * @return array
 419    *   an array of child ids
 420    */
 421   static public function getEntitiesForParent($parentId, $entityTable, $includeParent = TRUE, $mode = 3, $initiatorId = NULL) {
 422     $entities = array();
 423     if (empty($parentId) || empty($entityTable)) {
 424       return $entities;
 425     }
 426
 427     if (!$initiatorId) {
 428       $initiatorId = $parentId;
 429     }
 430
 431     $queryParams = array(
 432       1 => array($parentId, 'Integer'),
 433       2 => array($entityTable, 'String'),
 434       3 => array($initiatorId, 'Integer'),
 435     );
 436
 437     if (!$mode) {
 438       $mode = CRM_Core_DAO::singleValueQuery("SELECT mode FROM civicrm_recurring_entity WHERE entity_id = %3 AND entity_table = %2", $queryParams);
 439     }
 440
 441     $query = "SELECT *
 442       FROM civicrm_recurring_entity
 443       WHERE parent_id = %1 AND entity_table = %2";
 444     if (!$includeParent) {
 445       $query .= " AND entity_id != " . ($initiatorId ? "%3" : "%1");
 446     }
 447
 448     // MODE = SINGLE
 449     if ($mode == '1') {
 450       $query .= " AND entity_id = %3";
 451     }
 452     // MODE = FUTURE
 453     elseif ($mode == '2') {
 454       $recurringEntityID = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_recurring_entity WHERE entity_id = %3 AND entity_table = %2", $queryParams);
 455       if ($recurringEntityID) {
 456         $query .= $includeParent ? " AND id >= %4" : " AND id > %4";
 457         $query .= " ORDER BY id ASC"; // FIXME: change to order by dates
 458         $queryParams[4] = array($recurringEntityID, 'Integer');
 459       }
 460       else {
 461         // something wrong, return empty
 462         return array();
 463       }
 464     }
 465
 466     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 467     while ($dao->fetch()) {
 468       $entities["{$dao->entity_table}_{$dao->entity_id}"]['table'] = $dao->entity_table;
 469       $entities["{$dao->entity_table}_{$dao->entity_id}"]['id'] = $dao->entity_id;
 470     }
 471     return $entities;
 472   }
 473
 474   /**
 475    * This function when passed an entity id checks if it has parent and
 476    * returns all other entities that are connected to same parent.
 477    *
 478    * @param int $entityId
 479    *   Entity id .
 480    * @param string $entityTable
 481    *   Entity table name .
 482    * @param bool $includeParent
 483    *   Include parent in result set .
 484    * @param int $mode
 485    *   1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. .
 486    *
 487    *
 488    * @return array
 489    *   array of connected ids
 490    */
 491   static public function getEntitiesFor($entityId, $entityTable, $includeParent = TRUE, $mode = 3) {
 492     $parentId = self::getParentFor($entityId, $entityTable);
 493     if ($parentId) {
 494       return self::getEntitiesForParent($parentId, $entityTable, $includeParent, $mode, $entityId);
 495     }
 496     return array();
 497   }
 498
 499   /**
 500    * This function gets the parent for the entity id passed to it.
 501    *
 502    * @param int $entityId
 503    *   Entity ID .
 504    * @param string $entityTable
 505    *   Entity table name .
 506    * @param bool $includeParent
 507    *   Include parent in result set .
 508    *
 509    *
 510    * @return int
 511    *   unsigned $parentId Parent ID
 512    */
 513   static public function getParentFor($entityId, $entityTable, $includeParent = TRUE) {
 514     if (empty($entityId) || empty($entityTable)) {
 515       return NULL;
 516     }
 517
 518     $query = "
 519       SELECT parent_id
 520       FROM civicrm_recurring_entity
 521       WHERE entity_id = %1 AND entity_table = %2";
 522     if (!$includeParent) {
 523       $query .= " AND parent_id != %1";
 524     }
 525     $parentId
 526       = CRM_Core_DAO::singleValueQuery($query,
 527         array(
 528           1 => array($entityId, 'Integer'),
 529           2 => array($entityTable, 'String'),
 530         )
 531       );
 532     return $parentId;
 533   }
 534
 535   /**
 536    * Finds the position of this entity as well as total count of the repeating set
 537    *
 538    * @param $entityId
 539    * @param $entityTable
 540    * @return array|null
 541    */
 542   static public function getPositionAndCount($entityId, $entityTable) {
 543     $position = $count = 0;
 544
 545     $query = "
 546       SELECT entity_id
 547       FROM civicrm_recurring_entity
 548       WHERE parent_id = (SELECT parent_id FROM civicrm_recurring_entity WHERE entity_id = %1 AND entity_table = %2) AND entity_table = %2";
 549
 550     $dao = CRM_Core_DAO::executeQuery($query,
 551       array(
 552         1 => array($entityId, 'Integer'),
 553         2 => array($entityTable, 'String'),
 554       )
 555     );
 556
 557     while ($dao->fetch()) {
 558       ++$count;
 559       if ($dao->entity_id <= $entityId) {
 560         ++$position;
 561       }
 562     }
 563     if ($count) {
 564       return array($position, $count);
 565     }
 566     return NULL;
 567   }
 568
 569   /**
 570    * This function copies the information from parent entity and creates other entities with same information.
 571    *
 572    * @param string $entityTable
 573    *   Entity table name .
 574    * @param array $fromCriteria
 575    *   Array of all the fields & values on which basis to copy .
 576    * @param array $newParams
 577    *   Array of all the fields & values to be copied besides the other fields .
 578    * @param bool $createRecurringEntity
 579    *   If to create a record in recurring_entity table .
 580    *
 581    *
 582    * @return object
 583    */
 584   static public function copyCreateEntity($entityTable, $fromCriteria, $newParams, $createRecurringEntity = TRUE) {
 585     $daoName = self::$_tableDAOMapper[$entityTable];
 586     if (!$daoName) {
 587       CRM_Core_Error::fatal("DAO Mapper missing for $entityTable.");
 588     }
 589     $newObject = CRM_Core_DAO::copyGeneric($daoName, $fromCriteria, $newParams);
 590
 591     if (is_a($newObject, 'CRM_Core_DAO') && $newObject->id && $createRecurringEntity) {
 592       $object = new $daoName();
 593       foreach ($fromCriteria as $key => $value) {
 594         $object->$key = $value;
 595       }
 596       $object->find(TRUE);
 597
 598       CRM_Core_BAO_RecurringEntity::quickAdd($object->id, $newObject->id, $entityTable);
 599     }
 600     return $newObject;
 601   }
 602
 603   /**
 604    * This function acts as a listener to dao->update whenever there is an update.
 605    *
 606    * It propagates any changes to all related entities present in recurring entity table
 607    *
 608    * @param object $event
 609    *   An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just updated.
 610    */
 611   static public function triggerUpdate($event) {
 612     // if DB version is earlier than 4.6 skip any processing
 613     static $currentVer = NULL;
 614     if (!$currentVer) {
 615       $currentVer = CRM_Core_BAO_Domain::version();
 616     }
 617     if (version_compare($currentVer, '4.6.alpha1') < 0) {
 618       return;
 619     }
 620
 621     static $processedEntities = array();
 622     $obj =& $event->object;
 623     if (empty($obj->id) || empty($obj->__table)) {
 624       return;
 625     }
 626     $key = "{$obj->__table}_{$obj->id}";
 627
 628     if (array_key_exists($key, $processedEntities)) {
 629       // already processed
 630       return;
 631     }
 632
 633     // get related entities
 634     $repeatingEntities = self::getEntitiesFor($obj->id, $obj->__table, FALSE, NULL);
 635     if (empty($repeatingEntities)) {
 636       // return if its not a recurring entity parent
 637       return;
 638     }
 639     // mark being processed
 640     $processedEntities[$key] = 1;
 641
 642     // to make sure we not copying to source itself
 643     unset($repeatingEntities[$key]);
 644
 645     foreach ($repeatingEntities as $key => $val) {
 646       $entityID = $val['id'];
 647       $entityTable = $val['table'];
 648
 649       $processedEntities[$key] = 1;
 650
 651       if (array_key_exists($entityTable, self::$_tableDAOMapper)) {
 652         $daoName = self::$_tableDAOMapper[$entityTable];
 653
 654         $skipData = array();
 655         if (array_key_exists($entityTable, self::$_updateSkipFields)) {
 656           $skipFields = self::$_updateSkipFields[$entityTable];
 657           foreach ($skipFields as $sfield) {
 658             $skipData[$sfield] = NULL;
 659           }
 660         }
 661
 662         $updateDAO = CRM_Core_DAO::cascadeUpdate($daoName, $obj->id, $entityID, $skipData);
 663         CRM_Core_DAO::freeResult();
 664       }
 665       else {
 666         CRM_Core_Error::fatal("DAO Mapper missing for $entityTable.");
 667       }
 668     }
 669     // done with processing. lets unset static var.
 670     unset($processedEntities);
 671   }
 672
 673   /**
 674    * This function acts as a listener to dao->save,
 675    * and creates entries for linked entities in recurring entity table
 676    *
 677    * @param object $event
 678    *   An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just inserted.
 679    */
 680   static public function triggerInsert($event) {
 681     $obj =& $event->object;
 682     if (!array_key_exists($obj->__table, self::$_linkedEntitiesInfo)) {
 683       return;
 684     }
 685
 686     // if DB version is earlier than 4.6 skip any processing
 687     static $currentVer = NULL;
 688     if (!$currentVer) {
 689       $currentVer = CRM_Core_BAO_Domain::version();
 690     }
 691     if (version_compare($currentVer, '4.6.alpha1') < 0) {
 692       return;
 693     }
 694
 695     static $processedEntities = array();
 696     if (empty($obj->id) || empty($obj->__table)) {
 697       return;
 698     }
 699     $key = "{$obj->__table}_{$obj->id}";
 700
 701     if (array_key_exists($key, $processedEntities)) {
 702       // already being processed. Exit recursive calls.
 703       return;
 704     }
 705
 706     if (self::getStatus() == self::RUNNING) {
 707       // if recursion->generate() is doing some work, lets not intercept
 708       return;
 709     }
 710
 711     // mark being processed
 712     $processedEntities[$key] = 1;
 713
 714     // get related entities for table being saved
 715     $hasaRecurringRecord = self::getParentFor($obj->id, $obj->__table);
 716
 717     if (empty($hasaRecurringRecord)) {
 718       // check if its a linked entity
 719       if (array_key_exists($obj->__table, self::$_linkedEntitiesInfo) &&
 720         !CRM_Utils_Array::value('is_multirecord', self::$_linkedEntitiesInfo[$obj->__table])
 721       ) {
 722         $linkedDAO = new self::$_tableDAOMapper[$obj->__table]();
 723         $linkedDAO->id = $obj->id;
 724         if ($linkedDAO->find(TRUE)) {
 725           $idCol = self::$_linkedEntitiesInfo[$obj->__table]['entity_id_col'];
 726           $tableCol = self::$_linkedEntitiesInfo[$obj->__table]['entity_table_col'];
 727
 728           $pEntityID = $linkedDAO->$idCol;
 729           $pEntityTable = $linkedDAO->$tableCol;
 730
 731           // find all parent recurring entity set
 732           $pRepeatingEntities = self::getEntitiesFor($pEntityID, $pEntityTable);
 733
 734           if (!empty($pRepeatingEntities)) {
 735             // for each parent entity in the set, find out a similar linked entity,
 736             // if doesn't exist create one, and also create entries in recurring_entity table
 737
 738             foreach ($pRepeatingEntities as $key => $val) {
 739               if (array_key_exists($key, $processedEntities)) {
 740                 // this graph is already being processed
 741                 return;
 742               }
 743               $processedEntities[$key] = 1;
 744             }
 745
 746             // start with first entry with just itself
 747             CRM_Core_BAO_RecurringEntity::quickAdd($obj->id, $obj->id, $obj->__table);
 748
 749             foreach ($pRepeatingEntities as $key => $val) {
 750               $rlinkedDAO = new self::$_tableDAOMapper[$obj->__table]();
 751               $rlinkedDAO->$idCol = $val['id'];
 752               $rlinkedDAO->$tableCol = $val['table'];
 753               if ($rlinkedDAO->find(TRUE)) {
 754                 CRM_Core_BAO_RecurringEntity::quickAdd($obj->id, $rlinkedDAO->id, $obj->__table);
 755               }
 756               else {
 757                 // linked entity doesn't exist. lets create them
 758                 $newCriteria = array(
 759                   $idCol => $val['id'],
 760                   $tableCol => $val['table'],
 761                 );
 762                 $linkedObj = CRM_Core_BAO_RecurringEntity::copyCreateEntity($obj->__table,
 763                   array('id' => $obj->id),
 764                   $newCriteria,
 765                   TRUE
 766                 );
 767                 if ($linkedObj->id) {
 768                   CRM_Core_BAO_RecurringEntity::quickAdd($obj->id, $linkedObj->id, $obj->__table);
 769                 }
 770               }
 771             }
 772           }
 773         }
 774       }
 775     }
 776
 777     // done with processing. lets unset static var.
 778     unset($processedEntities);
 779   }
 780
 781   /**
 782    * This function acts as a listener to dao->delete, and deletes an entry from recurring_entity table
 783    *
 784    * @param object $event
 785    *   An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just deleted.
 786    */
 787   static public function triggerDelete($event) {
 788     $obj =& $event->object;
 789
 790     // if DB version is earlier than 4.6 skip any processing
 791     static $currentVer = NULL;
 792     if (!$currentVer) {
 793       $currentVer = CRM_Core_BAO_Domain::version();
 794     }
 795     if (version_compare($currentVer, '4.6.alpha1') < 0) {
 796       return;
 797     }
 798
 799     static $processedEntities = array();
 800     if (empty($obj->id) || empty($obj->__table) || !$event->result) {
 801       return;
 802     }
 803     $key = "{$obj->__table}_{$obj->id}";
 804
 805     if (array_key_exists($key, $processedEntities)) {
 806       // already processed
 807       return;
 808     }
 809
 810     // mark being processed
 811     $processedEntities[$key] = 1;
 812
 813     $parentID = self::getParentFor($obj->id, $obj->__table);
 814     if ($parentID) {
 815       CRM_Core_BAO_RecurringEntity::delEntity($obj->id, $obj->__table, TRUE);
 816     }
 817   }
 818
 819   /**
 820    * This function deletes main entity and related linked entities from recurring-entity table.
 821    *
 822    * @param int $entityId
 823    *   Entity id
 824    * @param string $entityTable
 825    *   Name of the entity table
 826    *
 827    * @param bool $isDelLinkedEntities
 828    *
 829    * @return bool|\CRM_Core_DAO_RecurringEntity
 830    * @throws \Exception
 831    */
 832   static public function delEntity($entityId, $entityTable, $isDelLinkedEntities = FALSE) {
 833     if (empty($entityId) || empty($entityTable)) {
 834       return FALSE;
 835     }
 836     $dao = new CRM_Core_DAO_RecurringEntity();
 837     $dao->entity_id = $entityId;
 838     $dao->entity_table = $entityTable;
 839     if ($dao->find(TRUE)) {
 840       // make sure its not a linked entity thats being deleted
 841       if ($isDelLinkedEntities && !array_key_exists($entityTable, self::$_linkedEntitiesInfo)) {
 842         // delete all linked entities from recurring entity table
 843         foreach (self::$_linkedEntitiesInfo as $linkedTable => $linfo) {
 844           $daoName = self::$_tableDAOMapper[$linkedTable];
 845           if (!$daoName) {
 846             CRM_Core_Error::fatal("DAO Mapper missing for $linkedTable.");
 847           }
 848
 849           $linkedDao = new $daoName();
 850           $linkedDao->{$linfo['entity_id_col']} = $entityId;
 851           $linkedDao->{$linfo['entity_table_col']} = $entityTable;
 852           $linkedDao->find();
 853           while ($linkedDao->fetch()) {
 854             CRM_Core_BAO_RecurringEntity::delEntity($linkedDao->id, $linkedTable, FALSE);
 855           }
 856         }
 857       }
 858       // delete main entity
 859       return $dao->delete();
 860     }
 861     return FALSE;
 862   }
 863
 864   /**
 865    * This function maps values posted from form to civicrm_action_schedule columns.
 866    *
 867    * @param array $formParams
 868    *   And array of form values posted .
 869    *
 870    * @return array
 871    */
 872   public function mapFormValuesToDB($formParams = array()) {
 873     $dbParams = array();
 874     if (!empty($formParams['used_for'])) {
 875       $dbParams['used_for'] = $formParams['used_for'];
 876     }
 877
 878     if (!empty($formParams['entity_id'])) {
 879       $dbParams['entity_value'] = $formParams['entity_id'];
 880     }
 881
 882     if (!empty($formParams['repetition_start_date'])) {
 883       if (!empty($formParams['repetition_start_date_display'])) {
 884         $repetitionStartDate = $formParams['repetition_start_date_display'];
 885       }
 886       else {
 887         $repetitionStartDate = $formParams['repetition_start_date'];
 888       }
 889       if (!empty($formParams['repetition_start_date_time'])) {
 890         $repetitionStartDate = $repetitionStartDate . " " . $formParams['repetition_start_date_time'];
 891       }
 892       $repetition_start_date = new DateTime($repetitionStartDate);
 893       $dbParams['start_action_date'] = CRM_Utils_Date::processDate($repetition_start_date->format('Y-m-d H:i:s'));
 894     }
 895
 896     if (!empty($formParams['repetition_frequency_unit'])) {
 897       $dbParams['repetition_frequency_unit'] = $formParams['repetition_frequency_unit'];
 898     }
 899
 900     if (!empty($formParams['repetition_frequency_interval'])) {
 901       $dbParams['repetition_frequency_interval'] = $formParams['repetition_frequency_interval'];
 902     }
 903
 904     //For Repeats on:(weekly case)
 905     if ($formParams['repetition_frequency_unit'] == 'week') {
 906       if (!empty($formParams['start_action_condition'])) {
 907         $repeats_on = CRM_Utils_Array::value('start_action_condition', $formParams);
 908         $dbParams['start_action_condition'] = implode(",", array_keys($repeats_on));
 909       }
 910     }
 911
 912     //For Repeats By:(monthly case)
 913     if ($formParams['repetition_frequency_unit'] == 'month') {
 914       if ($formParams['repeats_by'] == 1) {
 915         if (!empty($formParams['limit_to'])) {
 916           $dbParams['limit_to'] = $formParams['limit_to'];
 917         }
 918       }
 919       if ($formParams['repeats_by'] == 2) {
 920         if (CRM_Utils_Array::value('entity_status_1', $formParams) && CRM_Utils_Array::value('entity_status_2', $formParams)) {
 921           $dbParams['entity_status'] = $formParams['entity_status_1'] . " " . $formParams['entity_status_2'];
 922         }
 923       }
 924     }
 925
 926     //For "Ends" - After:
 927     if ($formParams['ends'] == 1) {
 928       if (!empty($formParams['start_action_offset'])) {
 929         $dbParams['start_action_offset'] = $formParams['start_action_offset'];
 930       }
 931     }
 932
 933     //For "Ends" - On:
 934     if ($formParams['ends'] == 2) {
 935       if (!empty($formParams['repeat_absolute_date'])) {
 936         $dbParams['absolute_date'] = CRM_Utils_Date::processDate($formParams['repeat_absolute_date']);
 937       }
 938     }
 939     return $dbParams;
 940   }
 941
 942   /**
 943    * This function gets all the columns of civicrm_action_schedule table based on id(primary key)
 944    *
 945    * @param int $scheduleReminderId
 946    *   Primary key of civicrm_action_schedule table .
 947    *
 948    *
 949    * @return object
 950    */
 951   static public function getScheduleReminderDetailsById($scheduleReminderId) {
 952     $query = "SELECT *
 953       FROM civicrm_action_schedule WHERE 1";
 954     if ($scheduleReminderId) {
 955       $query .= "
 956         AND id = %1";
 957     }
 958     $dao = CRM_Core_DAO::executeQuery($query,
 959       array(
 960         1 => array($scheduleReminderId, 'Integer'),
 961       )
 962     );
 963     $dao->fetch();
 964     return $dao;
 965   }
 966
 967   /**
 968    * wrapper of getScheduleReminderDetailsById function.
 969    *
 970    * @param int $scheduleReminderId
 971    *   Primary key of civicrm_action_schedule table .
 972    *
 973    * @return array
 974    */
 975   public function getScheduleParams($scheduleReminderId) {
 976     $scheduleReminderDetails = array();
 977     if ($scheduleReminderId) {
 978       //Get all the details from schedule reminder table
 979       $scheduleReminderDetails = self::getScheduleReminderDetailsById($scheduleReminderId);
 980       $scheduleReminderDetails = (array) $scheduleReminderDetails;
 981     }
 982     return $scheduleReminderDetails;
 983   }
 984
 985   /**
 986    * This function takes criteria saved in civicrm_action_schedule table
 987    * and creates recursion rule
 988    *
 989    * @param array $scheduleReminderDetails
 990    *   Array of repeat criteria saved in civicrm_action_schedule table .
 991    *
 992    * @return object
 993    *   When object
 994    */
 995   public function getRecursionFromSchedule($scheduleReminderDetails = array()) {
 996     $r = new When();
 997     //If there is some data for this id
 998     if ($scheduleReminderDetails['repetition_frequency_unit']) {
 999       if ($scheduleReminderDetails['start_action_date']) {
1000         $currDate = date('Y-m-d H:i:s', strtotime($scheduleReminderDetails['start_action_date']));
1001       }
1002       else {
1003         $currDate = date("Y-m-d H:i:s");
1004       }
1005       $start = new DateTime($currDate);
1006       $this->recursion_start_date = $start;
1007       if ($scheduleReminderDetails['repetition_frequency_unit']) {
1008         $repetition_frequency_unit = $scheduleReminderDetails['repetition_frequency_unit'];
1009         if ($repetition_frequency_unit == "day") {
1010           $repetition_frequency_unit = "dai";
1011         }
1012         $repetition_frequency_unit = $repetition_frequency_unit . 'ly';
1013         $r->recur($start, $repetition_frequency_unit);
1014       }
1015
1016       if ($scheduleReminderDetails['repetition_frequency_interval']) {
1017         $r->interval($scheduleReminderDetails['repetition_frequency_interval']);
1018       }
1019       else {
1020         $r->errors[] = 'Repeats every: is a required field';
1021       }
1022
1023       //week
1024       if ($scheduleReminderDetails['repetition_frequency_unit'] == 'week') {
1025         if ($scheduleReminderDetails['start_action_condition']) {
1026           $startActionCondition = $scheduleReminderDetails['start_action_condition'];
1027           $explodeStartActionCondition = explode(',', $startActionCondition);
1028           $buildRuleArray = array();
1029           foreach ($explodeStartActionCondition as $key => $val) {
1030             $buildRuleArray[] = strtoupper(substr($val, 0, 2));
1031           }
1032           $r->wkst('MO')->byday($buildRuleArray);
1033         }
1034       }
1035
1036       //month
1037       if ($scheduleReminderDetails['repetition_frequency_unit'] == 'month') {
1038         if ($scheduleReminderDetails['entity_status']) {
1039           $startActionDate = explode(" ", $scheduleReminderDetails['entity_status']);
1040           switch ($startActionDate[0]) {
1041             case 'first':
1042               $startActionDate1 = 1;
1043               break;
1044
1045             case 'second':
1046               $startActionDate1 = 2;
1047               break;
1048
1049             case 'third':
1050               $startActionDate1 = 3;
1051               break;
1052
1053             case 'fourth':
1054               $startActionDate1 = 4;
1055               break;
1056
1057             case 'last':
1058               $startActionDate1 = -1;
1059               break;
1060           }
1061           $concatStartActionDateBits = $startActionDate1 . strtoupper(substr($startActionDate[1], 0, 2));
1062           $r->byday(array($concatStartActionDateBits));
1063         }
1064         elseif ($scheduleReminderDetails['limit_to']) {
1065           $r->bymonthday(array($scheduleReminderDetails['limit_to']));
1066         }
1067       }
1068
1069       //Ends
1070       if ($scheduleReminderDetails['start_action_offset']) {
1071         if ($scheduleReminderDetails['start_action_offset'] > 30) {
1072           $r->errors[] = 'Occurrences should be less than or equal to 30';
1073         }
1074         $r->count($scheduleReminderDetails['start_action_offset']);
1075       }
1076
1077       if (!empty($scheduleReminderDetails['absolute_date'])) {
1078         $absoluteDate = CRM_Utils_Date::setDateDefaults($scheduleReminderDetails['absolute_date']);
1079         // absolute_date column of scheduled-reminder table is of type date (and not datetime)
1080         // and we always want the date to be included, and therefore appending 23:59
1081         $endDate = new DateTime($absoluteDate[0] . ' ' . '23:59');
1082         $r->until($endDate);
1083       }
1084
1085       if (!$scheduleReminderDetails['start_action_offset'] && !$scheduleReminderDetails['absolute_date']) {
1086         $r->errors[] = 'Ends: is a required field';
1087       }
1088     }
1089     else {
1090       $r->errors[] = 'Repeats: is a required field';
1091     }
1092     return $r;
1093   }
1094
1095
1096   /**
1097    * This function gets time difference between the two datetime object.
1098    *
1099    * @param DateTime $startDate
1100    *   Start Date .
1101    * @param DateTime $endDate
1102    *   End Date .
1103    *
1104    *
1105    * @return object
1106    *   DateTime object which contain time difference
1107    */
1108   static public function getInterval($startDate, $endDate) {
1109     if ($startDate && $endDate) {
1110       $startDate = new DateTime($startDate);
1111       $endDate = new DateTime($endDate);
1112       return $startDate->diff($endDate);
1113     }
1114   }
1115
1116   /**
1117    * This function gets all columns from civicrm_action_schedule on the basis of event id.
1118    *
1119    * @param int $entityId
1120    *   Entity ID .
1121    * @param string $used_for
1122    *   Specifies for which entity type it's used for .
1123    *
1124    *
1125    * @return object
1126    */
1127   public static function getReminderDetailsByEntityId($entityId, $used_for) {
1128     if ($entityId) {
1129       $query = "
1130         SELECT *
1131         FROM   civicrm_action_schedule
1132         WHERE  entity_value = %1";
1133       if ($used_for) {
1134         $query .= " AND used_for = %2";
1135       }
1136       $params = array(
1137         1 => array($entityId, 'Integer'),
1138         2 => array($used_for, 'String'),
1139       );
1140       $dao = CRM_Core_DAO::executeQuery($query, $params);
1141       $dao->fetch();
1142     }
1143     return $dao;
1144   }
1145
1146   /**
1147    * Update mode column in civicrm_recurring_entity table for event related tabs.
1148    *
1149    * @param int $entityId
1150    *   Event id .
1151    * @param string $linkedEntityTable
1152    *   Linked entity table name for this event .
1153    * @param string $mainEntityTable
1154    *
1155    * @return array
1156    */
1157   public static function updateModeLinkedEntity($entityId, $linkedEntityTable, $mainEntityTable) {
1158     $result = array();
1159     if ($entityId && $linkedEntityTable && $mainEntityTable) {
1160       if (CRM_Utils_Array::value($linkedEntityTable, self::$_tableDAOMapper)) {
1161         $dao = self::$_tableDAOMapper[$linkedEntityTable];
1162       }
1163       else {
1164         CRM_Core_Session::setStatus('Could not update mode for linked entities');
1165         return NULL;
1166       }
1167       $entityTable = $linkedEntityTable;
1168       $params = array(
1169         'entity_id' => $entityId,
1170         'entity_table' => $mainEntityTable,
1171       );
1172       $defaults = array();
1173       CRM_Core_DAO::commonRetrieve($dao, $params, $defaults);
1174       if (!empty($defaults['id'])) {
1175         $result['entityId'] = $defaults['id'];
1176         $result['entityTable'] = $entityTable;
1177       }
1178     }
1179     return $result;
1180   }
1181
1182   /**
1183    * Update mode in civicrm_recurring_entity table for event related data and price set in civicrm_price_set_entity.
1184    *
1185    * @param int $entityId
1186    *   Event id .
1187    * @param string $entityTable
1188    * @param string $mode
1189    * @param string $linkedEntityTable
1190    *   Linked entity table name for this event .
1191    * @param string $priceSet
1192    *   Price set of the event .
1193    *
1194    * @return array
1195    */
1196   public static function updateModeAndPriceSet($entityId, $entityTable, $mode, $linkedEntityTable, $priceSet) {
1197     $finalResult = array();
1198
1199     if (!empty($linkedEntityTable)) {
1200       $result = CRM_Core_BAO_RecurringEntity::updateModeLinkedEntity($entityId, $linkedEntityTable, $entityTable);
1201     }
1202
1203     $dao = new CRM_Core_DAO_RecurringEntity();
1204     if (!empty($result)) {
1205       $dao->entity_id = $result['entityId'];
1206       $dao->entity_table = $result['entityTable'];
1207     }
1208     else {
1209       $dao->entity_id = $entityId;
1210       $dao->entity_table = $entityTable;
1211     }
1212
1213     if ($dao->find(TRUE)) {
1214       $dao->mode = $mode;
1215       $dao->save();
1216
1217       if ($priceSet) {
1218         //CRM-20787 Fix
1219         //I am not sure about other fields, if mode = 3 apply for an event then other fields
1220         //should be save for all other series events or not so applying for price set only for now here.
1221         if (CRM_Core_BAO_RecurringEntity::MODE_ALL_ENTITY_IN_SERIES === $mode) {
1222           //Step-1: Get all events of series
1223           $seriesEventRecords = CRM_Core_BAO_RecurringEntity::getEntitiesFor($entityId, $entityTable);
1224           foreach ($seriesEventRecords as $event) {
1225             //Step-2: Save price set in other series events
1226             if (CRM_Price_BAO_PriceSet::removeFrom($event['table'], $event['id'])) {//Remove existing priceset
1227               CRM_Core_BAO_Discount::del($event['id'], $event['table']);
1228             }
1229             CRM_Price_BAO_PriceSet::addTo($event['table'], $event['id'], $priceSet); //Add new price set
1230           }
1231         }
1232
1233         if (CRM_Core_BAO_RecurringEntity::MODE_NEXT_ALL_ENTITY === $mode) {
1234           //Step-1: Get all events of series
1235           $seriesEventRecords = CRM_Core_BAO_RecurringEntity::getEntitiesFor($entityId, $entityTable);
1236           foreach ($seriesEventRecords as $event) {
1237             //Step-2: Save price set in other series events
1238             if ($entityId < $event["id"]) {
1239               if (CRM_Price_BAO_PriceSet::removeFrom($event['table'], $event['id'])) {//Remove existing priceset
1240                 CRM_Core_BAO_Discount::del($event['id'], $event['table']);
1241               }
1242               CRM_Price_BAO_PriceSet::addTo($event['table'], $event['id'], $priceSet); //Add new price set
1243             }
1244           }
1245         }
1246       }
1247
1248       //CRM-20787 - Fix end
1249       $finalResult['status'] = 'Done';
1250     }
1251     else {
1252       $finalResult['status'] = 'Error';
1253     }
1254
1255     return $finalResult;
1256   }
1257
1258 }