CRM/Core/BAO/RecurringEntity.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 require_once 'packages/When/When.php';
  37
  38 /**
  39  * Class CRM_Core_BAO_RecurringEntity
  40  */
  41 class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity {
  42
  43   const RUNNING = 1;
  44   public $schedule = array();
  45   public $scheduleId = NULL;
  46   public $scheduleFormValues = array();
  47
  48   public $dateColumns = array();
  49   public $overwriteColumns = array();
  50   public $intervalDateColumns = array();
  51   public $excludeDates = array();
  52
  53   public $linkedEntities = array();
  54
  55   public $isRecurringEntityRecord = TRUE;
  56
  57   protected $recursion = NULL;
  58   protected $recursion_start_date = NULL;
  59
  60   public static $_entitiesToBeDeleted = array();
  61
  62   public static $status = NULL;
  63
  64   static $_recurringEntityHelper
  65     = array(
  66       'civicrm_event' => array(
  67         'helper_class' => 'CRM_Event_DAO_Event',
  68         'delete_func' => 'delete',
  69         'pre_delete_func' => 'CRM_Event_Form_ManageEvent_Repeat::checkRegistrationForEvents',
  70       ),
  71       'civicrm_activity' => array(
  72         'helper_class' => 'CRM_Activity_DAO_Activity',
  73         'delete_func' => 'delete',
  74         'pre_delete_func' => '',
  75       ),
  76     );
  77
  78   static $_dateColumns
  79     = array(
  80       'civicrm_event' => array(
  81         'dateColumns' => array('start_date'),
  82         'excludeDateRangeColumns' => array('start_date', 'end_date'),
  83         'intervalDateColumns' => array('end_date'),
  84       ),
  85       'civicrm_activity' => array(
  86         'dateColumns' => array('activity_date_time'),
  87       ),
  88     );
  89
  90   static $_tableDAOMapper
  91     = array(
  92       'civicrm_event' => 'CRM_Event_DAO_Event',
  93       'civicrm_price_set_entity' => 'CRM_Price_DAO_PriceSetEntity',
  94       'civicrm_uf_join' => 'CRM_Core_DAO_UFJoin',
  95       'civicrm_tell_friend' => 'CRM_Friend_DAO_Friend',
  96       'civicrm_pcp_block' => 'CRM_PCP_DAO_PCPBlock',
  97       'civicrm_activity' => 'CRM_Activity_DAO_Activity',
  98       'civicrm_activity_contact' => 'CRM_Activity_DAO_ActivityContact',
  99     );
 100
 101   static $_updateSkipFields
 102     = array(
 103       'civicrm_event' => array('start_date', 'end_date'),
 104       'civicrm_tell_friend' => array('entity_id'),
 105       'civicrm_pcp_block' => array('entity_id'),
 106       'civicrm_activity' => array('activity_date_time'),
 107     );
 108
 109   static $_linkedEntitiesInfo
 110     = array(
 111       'civicrm_tell_friend' => array(
 112         'entity_id_col' => 'entity_id',
 113         'entity_table_col' => 'entity_table',
 114       ),
 115       'civicrm_price_set_entity' => array(
 116         'entity_id_col' => 'entity_id',
 117         'entity_table_col' => 'entity_table',
 118         'is_multirecord' => TRUE,
 119       ),
 120       'civicrm_uf_join' => array(
 121         'entity_id_col' => 'entity_id',
 122         'entity_table_col' => 'entity_table',
 123         'is_multirecord' => TRUE,
 124       ),
 125       'civicrm_pcp_block' => array(
 126         'entity_id_col' => 'entity_id',
 127         'entity_table_col' => 'entity_table',
 128       ),
 129     );
 130
 131   /**
 132    * Getter for status.
 133    *
 134    * @return string
 135    */
 136   public static function getStatus() {
 137     return self::$status;
 138   }
 139
 140   /**
 141    * Setter for status.
 142    *
 143    * @param string $status
 144    */
 145   public static function setStatus($status) {
 146     self::$status = $status;
 147   }
 148
 149   /**
 150    * Save records in civicrm_recurring_entity table.
 151    *
 152    * @param array $params
 153    *   Reference array contains the values submitted by the form.
 154    *
 155    * @return object
 156    */
 157   public static function add(&$params) {
 158     if (!empty($params['id'])) {
 159       CRM_Utils_Hook::pre('edit', 'RecurringEntity', $params['id'], $params);
 160     }
 161     else {
 162       CRM_Utils_Hook::pre('create', 'RecurringEntity', NULL, $params);
 163     }
 164
 165     $daoRecurringEntity = new CRM_Core_DAO_RecurringEntity();
 166     $daoRecurringEntity->copyValues($params);
 167     $daoRecurringEntity->find(TRUE);
 168     $result = $daoRecurringEntity->save();
 169
 170     if (!empty($params['id'])) {
 171       CRM_Utils_Hook::post('edit', 'RecurringEntity', $daoRecurringEntity->id, $daoRecurringEntity);
 172     }
 173     else {
 174       CRM_Utils_Hook::post('create', 'RecurringEntity', $daoRecurringEntity->id, $daoRecurringEntity);
 175     }
 176     return $result;
 177   }
 178
 179   /**
 180    * Wrapper for the function add() to add entry in recurring entity
 181    *
 182    * @param int $parentId
 183    *   Parent entity id .
 184    * @param int $entityId
 185    *   Child entity id .
 186    * @param string $entityTable
 187    *   Name of the entity table .
 188    *
 189    *
 190    * @return object
 191    */
 192   public static function quickAdd($parentId, $entityId, $entityTable) {
 193     $params
 194       = array(
 195         'parent_id' => $parentId,
 196         'entity_id' => $entityId,
 197         'entity_table' => $entityTable,
 198       );
 199     return self::add($params);
 200   }
 201
 202   /**
 203    * This function updates the mode column in the civicrm_recurring_entity table.
 204    *
 205    * @param int $mode
 206    *   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 .
 207    *
 208    *
 209    * @return void
 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    * and propagates any changes to all related entities present in recurring entity table
 606    *
 607    * @param object $event
 608    *   An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just updated .
 609    *
 610    *
 611    * @return void
 612    */
 613   static public function triggerUpdate($event) {
 614     // if DB version is earlier than 4.6 skip any processing
 615     static $currentVer = NULL;
 616     if (!$currentVer) {
 617       $currentVer = CRM_Core_BAO_Domain::version();
 618     }
 619     if (version_compare($currentVer, '4.6.alpha1') < 0) {
 620       return;
 621     }
 622
 623     static $processedEntities = array();
 624     $obj =& $event->object;
 625     if (empty($obj->id) || empty($obj->__table)) {
 626       return FALSE;
 627     }
 628     $key = "{$obj->__table}_{$obj->id}";
 629
 630     if (array_key_exists($key, $processedEntities)) {
 631       // already processed
 632       return NULL;
 633     }
 634
 635     // get related entities
 636     $repeatingEntities = self::getEntitiesFor($obj->id, $obj->__table, FALSE, NULL);
 637     if (empty($repeatingEntities)) {
 638       // return if its not a recurring entity parent
 639       return NULL;
 640     }
 641     // mark being processed
 642     $processedEntities[$key] = 1;
 643
 644     // to make sure we not copying to source itself
 645     unset($repeatingEntities[$key]);
 646
 647     foreach ($repeatingEntities as $key => $val) {
 648       $entityID = $val['id'];
 649       $entityTable = $val['table'];
 650
 651       $processedEntities[$key] = 1;
 652
 653       if (array_key_exists($entityTable, self::$_tableDAOMapper)) {
 654         $daoName = self::$_tableDAOMapper[$entityTable];
 655
 656         $skipData = array();
 657         if (array_key_exists($entityTable, self::$_updateSkipFields)) {
 658           $skipFields = self::$_updateSkipFields[$entityTable];
 659           foreach ($skipFields as $sfield) {
 660             $skipData[$sfield] = NULL;
 661           }
 662         }
 663
 664         $updateDAO = CRM_Core_DAO::cascadeUpdate($daoName, $obj->id, $entityID, $skipData);
 665         CRM_Core_DAO::freeResult();
 666       }
 667       else {
 668         CRM_Core_Error::fatal("DAO Mapper missing for $entityTable.");
 669       }
 670     }
 671     // done with processing. lets unset static var.
 672     unset($processedEntities);
 673   }
 674
 675   /**
 676    * This function acts as a listener to dao->save,
 677    * and creates entries for linked entities in recurring entity table
 678    *
 679    * @param object $event
 680    *   An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just inserted .
 681    *
 682    *
 683    * @return void
 684    */
 685   static public function triggerInsert($event) {
 686     $obj =& $event->object;
 687     if (!array_key_exists($obj->__table, self::$_linkedEntitiesInfo)) {
 688       return FALSE;
 689     }
 690
 691     // if DB version is earlier than 4.6 skip any processing
 692     static $currentVer = NULL;
 693     if (!$currentVer) {
 694       $currentVer = CRM_Core_BAO_Domain::version();
 695     }
 696     if (version_compare($currentVer, '4.6.alpha1') < 0) {
 697       return;
 698     }
 699
 700     static $processedEntities = array();
 701     if (empty($obj->id) || empty($obj->__table)) {
 702       return FALSE;
 703     }
 704     $key = "{$obj->__table}_{$obj->id}";
 705
 706     if (array_key_exists($key, $processedEntities)) {
 707       // already being processed. Exit recursive calls.
 708       return NULL;
 709     }
 710
 711     if (self::getStatus() == self::RUNNING) {
 712       // if recursion->generate() is doing some work, lets not intercept
 713       return NULL;
 714     }
 715
 716     // mark being processed
 717     $processedEntities[$key] = 1;
 718
 719     // get related entities for table being saved
 720     $hasaRecurringRecord = self::getParentFor($obj->id, $obj->__table);
 721
 722     if (empty($hasaRecurringRecord)) {
 723       // check if its a linked entity
 724       if (array_key_exists($obj->__table, self::$_linkedEntitiesInfo) &&
 725         !CRM_Utils_Array::value('is_multirecord', self::$_linkedEntitiesInfo[$obj->__table])
 726       ) {
 727         $linkedDAO = new self::$_tableDAOMapper[$obj->__table]();
 728         $linkedDAO->id = $obj->id;
 729         if ($linkedDAO->find(TRUE)) {
 730           $idCol = self::$_linkedEntitiesInfo[$obj->__table]['entity_id_col'];
 731           $tableCol = self::$_linkedEntitiesInfo[$obj->__table]['entity_table_col'];
 732
 733           $pEntityID = $linkedDAO->$idCol;
 734           $pEntityTable = $linkedDAO->$tableCol;
 735
 736           // find all parent recurring entity set
 737           $pRepeatingEntities = self::getEntitiesFor($pEntityID, $pEntityTable);
 738
 739           if (!empty($pRepeatingEntities)) {
 740             // for each parent entity in the set, find out a similar linked entity,
 741             // if doesn't exist create one, and also create entries in recurring_entity table
 742
 743             foreach ($pRepeatingEntities as $key => $val) {
 744               if (array_key_exists($key, $processedEntities)) {
 745                 // this graph is already being processed
 746                 return NULL;
 747               }
 748               $processedEntities[$key] = 1;
 749             }
 750
 751             // start with first entry with just itself
 752             CRM_Core_BAO_RecurringEntity::quickAdd($obj->id, $obj->id, $obj->__table);
 753
 754             foreach ($pRepeatingEntities as $key => $val) {
 755               $rlinkedDAO = new self::$_tableDAOMapper[$obj->__table]();
 756               $rlinkedDAO->$idCol = $val['id'];
 757               $rlinkedDAO->$tableCol = $val['table'];
 758               if ($rlinkedDAO->find(TRUE)) {
 759                 CRM_Core_BAO_RecurringEntity::quickAdd($obj->id, $rlinkedDAO->id, $obj->__table);
 760               }
 761               else {
 762                 // linked entity doesn't exist. lets create them
 763                 $newCriteria = array(
 764                   $idCol => $val['id'],
 765                   $tableCol => $val['table'],
 766                 );
 767                 $linkedObj = CRM_Core_BAO_RecurringEntity::copyCreateEntity($obj->__table,
 768                   array('id' => $obj->id),
 769                   $newCriteria,
 770                   TRUE
 771                 );
 772                 if ($linkedObj->id) {
 773                   CRM_Core_BAO_RecurringEntity::quickAdd($obj->id, $linkedObj->id, $obj->__table);
 774                 }
 775               }
 776             }
 777           }
 778         }
 779       }
 780     }
 781
 782     // done with processing. lets unset static var.
 783     unset($processedEntities);
 784   }
 785
 786   /**
 787    * This function acts as a listener to dao->delete, and deletes an entry from recurring_entity table
 788    *
 789    * @param object $event
 790    *   An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just deleted .
 791    *
 792    *
 793    * @return void
 794    */
 795   static public function triggerDelete($event) {
 796     $obj =& $event->object;
 797
 798     // if DB version is earlier than 4.6 skip any processing
 799     static $currentVer = NULL;
 800     if (!$currentVer) {
 801       $currentVer = CRM_Core_BAO_Domain::version();
 802     }
 803     if (version_compare($currentVer, '4.6.alpha1') < 0) {
 804       return;
 805     }
 806
 807     static $processedEntities = array();
 808     if (empty($obj->id) || empty($obj->__table) || !$event->result) {
 809       return FALSE;
 810     }
 811     $key = "{$obj->__table}_{$obj->id}";
 812
 813     if (array_key_exists($key, $processedEntities)) {
 814       // already processed
 815       return NULL;
 816     }
 817
 818     // mark being processed
 819     $processedEntities[$key] = 1;
 820
 821     $parentID = self::getParentFor($obj->id, $obj->__table);
 822     if ($parentID) {
 823       CRM_Core_BAO_RecurringEntity::delEntity($obj->id, $obj->__table, TRUE);
 824     }
 825   }
 826
 827   /**
 828    * This function deletes main entity and related linked entities from recurring-entity table
 829    *
 830    * @param int $entityId
 831    *   Entity id
 832    * @param string $entityTable
 833    *   Name of the entity table
 834    *
 835    *
 836    * @return bool|CRM_Core_DAO_RecurringEntity
 837    */
 838   static public function delEntity($entityId, $entityTable, $isDelLinkedEntities = FALSE) {
 839     if (empty($entityId) || empty($entityTable)) {
 840       return FALSE;
 841     }
 842     $dao = new CRM_Core_DAO_RecurringEntity();
 843     $dao->entity_id = $entityId;
 844     $dao->entity_table = $entityTable;
 845     if ($dao->find(TRUE)) {
 846       // make sure its not a linked entity thats being deleted
 847       if ($isDelLinkedEntities && !array_key_exists($entityTable, self::$_linkedEntitiesInfo)) {
 848         // delete all linked entities from recurring entity table
 849         foreach (self::$_linkedEntitiesInfo as $linkedTable => $linfo) {
 850           $daoName = self::$_tableDAOMapper[$linkedTable];
 851           if (!$daoName) {
 852             CRM_Core_Error::fatal("DAO Mapper missing for $linkedTable.");
 853           }
 854
 855           $linkedDao = new $daoName();
 856           $linkedDao->$linfo['entity_id_col'] = $entityId;
 857           $linkedDao->$linfo['entity_table_col'] = $entityTable;
 858           $linkedDao->find();
 859           while ($linkedDao->fetch()) {
 860             CRM_Core_BAO_RecurringEntity::delEntity($linkedDao->id, $linkedTable, FALSE);
 861           }
 862         }
 863       }
 864       // delete main entity
 865       return $dao->delete();
 866     }
 867     return FALSE;
 868   }
 869
 870   /**
 871    * This function maps values posted from form to civicrm_action_schedule columns.
 872    *
 873    * @param array $formParams
 874    *   And array of form values posted .
 875    *
 876    * @return array
 877    */
 878   public function mapFormValuesToDB($formParams = array()) {
 879     $dbParams = array();
 880     if (!empty($formParams['used_for'])) {
 881       $dbParams['used_for'] = $formParams['used_for'];
 882     }
 883
 884     if (!empty($formParams['entity_id'])) {
 885       $dbParams['entity_value'] = $formParams['entity_id'];
 886     }
 887
 888     if (!empty($formParams['repetition_start_date'])) {
 889       if (!empty($formParams['repetition_start_date_display'])) {
 890         $repetitionStartDate = $formParams['repetition_start_date_display'];
 891       }
 892       else {
 893         $repetitionStartDate = $formParams['repetition_start_date'];
 894       }
 895       if (!empty($formParams['repetition_start_date_time'])) {
 896         $repetitionStartDate = $repetitionStartDate . " " . $formParams['repetition_start_date_time'];
 897       }
 898       $repetition_start_date = new DateTime($repetitionStartDate);
 899       $dbParams['start_action_date'] = CRM_Utils_Date::processDate($repetition_start_date->format('Y-m-d H:i:s'));
 900     }
 901
 902     if (!empty($formParams['repetition_frequency_unit'])) {
 903       $dbParams['repetition_frequency_unit'] = $formParams['repetition_frequency_unit'];
 904     }
 905
 906     if (!empty($formParams['repetition_frequency_interval'])) {
 907       $dbParams['repetition_frequency_interval'] = $formParams['repetition_frequency_interval'];
 908     }
 909
 910     //For Repeats on:(weekly case)
 911     if ($formParams['repetition_frequency_unit'] == 'week') {
 912       if (!empty($formParams['start_action_condition'])) {
 913         $repeats_on = CRM_Utils_Array::value('start_action_condition', $formParams);
 914         $dbParams['start_action_condition'] = implode(",", array_keys($repeats_on));
 915       }
 916     }
 917
 918     //For Repeats By:(monthly case)
 919     if ($formParams['repetition_frequency_unit'] == 'month') {
 920       if ($formParams['repeats_by'] == 1) {
 921         if (!empty($formParams['limit_to'])) {
 922           $dbParams['limit_to'] = $formParams['limit_to'];
 923         }
 924       }
 925       if ($formParams['repeats_by'] == 2) {
 926         if (CRM_Utils_Array::value('entity_status_1', $formParams) && CRM_Utils_Array::value('entity_status_2', $formParams)) {
 927           $dbParams['entity_status'] = $formParams['entity_status_1'] . " " . $formParams['entity_status_2'];
 928         }
 929       }
 930     }
 931
 932     //For "Ends" - After:
 933     if ($formParams['ends'] == 1) {
 934       if (!empty($formParams['start_action_offset'])) {
 935         $dbParams['start_action_offset'] = $formParams['start_action_offset'];
 936       }
 937     }
 938
 939     //For "Ends" - On:
 940     if ($formParams['ends'] == 2) {
 941       if (!empty($formParams['repeat_absolute_date'])) {
 942         $dbParams['absolute_date'] = CRM_Utils_Date::processDate($formParams['repeat_absolute_date']);
 943       }
 944     }
 945     return $dbParams;
 946   }
 947
 948   /**
 949    * This function gets all the columns of civicrm_action_schedule table based on id(primary key)
 950    *
 951    * @param int $scheduleReminderId
 952    *   Primary key of civicrm_action_schedule table .
 953    *
 954    *
 955    * @return object
 956    */
 957   static public function getScheduleReminderDetailsById($scheduleReminderId) {
 958     $query = "SELECT *
 959       FROM civicrm_action_schedule WHERE 1";
 960     if ($scheduleReminderId) {
 961       $query .= "
 962         AND id = %1";
 963     }
 964     $dao = CRM_Core_DAO::executeQuery($query,
 965       array(
 966         1 => array($scheduleReminderId, 'Integer'),
 967       )
 968     );
 969     $dao->fetch();
 970     return $dao;
 971   }
 972
 973   /**
 974    * wrapper of getScheduleReminderDetailsById function.
 975    *
 976    * @param int $scheduleReminderId
 977    *   Primary key of civicrm_action_schedule table .
 978    *
 979    * @return array
 980    */
 981   public function getScheduleParams($scheduleReminderId) {
 982     $scheduleReminderDetails = array();
 983     if ($scheduleReminderId) {
 984       //Get all the details from schedule reminder table
 985       $scheduleReminderDetails = self::getScheduleReminderDetailsById($scheduleReminderId);
 986       $scheduleReminderDetails = (array) $scheduleReminderDetails;
 987     }
 988     return $scheduleReminderDetails;
 989   }
 990
 991   /**
 992    * This function takes criteria saved in civicrm_action_schedule table
 993    * and creates recursion rule
 994    *
 995    * @param array $scheduleReminderDetails
 996    *   Array of repeat criteria saved in civicrm_action_schedule table .
 997    *
 998    * @return object
 999    *   When object
1000    */
1001   public function getRecursionFromSchedule($scheduleReminderDetails = array()) {
1002     $r = new When();
1003     //If there is some data for this id
1004     if ($scheduleReminderDetails['repetition_frequency_unit']) {
1005       if ($scheduleReminderDetails['start_action_date']) {
1006         $currDate = date('Y-m-d H:i:s', strtotime($scheduleReminderDetails['start_action_date']));
1007       }
1008       else {
1009         $currDate = date("Y-m-d H:i:s");
1010       }
1011       $start = new DateTime($currDate);
1012       $this->recursion_start_date = $start;
1013       if ($scheduleReminderDetails['repetition_frequency_unit']) {
1014         $repetition_frequency_unit = $scheduleReminderDetails['repetition_frequency_unit'];
1015         if ($repetition_frequency_unit == "day") {
1016           $repetition_frequency_unit = "dai";
1017         }
1018         $repetition_frequency_unit = $repetition_frequency_unit . 'ly';
1019         $r->recur($start, $repetition_frequency_unit);
1020       }
1021
1022       if ($scheduleReminderDetails['repetition_frequency_interval']) {
1023         $r->interval($scheduleReminderDetails['repetition_frequency_interval']);
1024       }
1025       else {
1026         $r->errors[] = 'Repeats every: is a required field';
1027       }
1028
1029       //week
1030       if ($scheduleReminderDetails['repetition_frequency_unit'] == 'week') {
1031         if ($scheduleReminderDetails['start_action_condition']) {
1032           $startActionCondition = $scheduleReminderDetails['start_action_condition'];
1033           $explodeStartActionCondition = explode(',', $startActionCondition);
1034           $buildRuleArray = array();
1035           foreach ($explodeStartActionCondition as $key => $val) {
1036             $buildRuleArray[] = strtoupper(substr($val, 0, 2));
1037           }
1038           $r->wkst('MO')->byday($buildRuleArray);
1039         }
1040       }
1041
1042       //month
1043       if ($scheduleReminderDetails['repetition_frequency_unit'] == 'month') {
1044         if ($scheduleReminderDetails['entity_status']) {
1045           $startActionDate = explode(" ", $scheduleReminderDetails['entity_status']);
1046           switch ($startActionDate[0]) {
1047             case 'first':
1048               $startActionDate1 = 1;
1049               break;
1050
1051             case 'second':
1052               $startActionDate1 = 2;
1053               break;
1054
1055             case 'third':
1056               $startActionDate1 = 3;
1057               break;
1058
1059             case 'fourth':
1060               $startActionDate1 = 4;
1061               break;
1062
1063             case 'last':
1064               $startActionDate1 = -1;
1065               break;
1066           }
1067           $concatStartActionDateBits = $startActionDate1 . strtoupper(substr($startActionDate[1], 0, 2));
1068           $r->byday(array($concatStartActionDateBits));
1069         }
1070         elseif ($scheduleReminderDetails['limit_to']) {
1071           $r->bymonthday(array($scheduleReminderDetails['limit_to']));
1072         }
1073       }
1074
1075       //Ends
1076       if ($scheduleReminderDetails['start_action_offset']) {
1077         if ($scheduleReminderDetails['start_action_offset'] > 30) {
1078           $r->errors[] = 'Occurrences should be less than or equal to 30';
1079         }
1080         $r->count($scheduleReminderDetails['start_action_offset']);
1081       }
1082
1083       if (!empty($scheduleReminderDetails['absolute_date'])) {
1084         $absoluteDate = CRM_Utils_Date::setDateDefaults($scheduleReminderDetails['absolute_date']);
1085         // absolute_date column of scheduled-reminder table is of type date (and not datetime)
1086         // and we always want the date to be included, and therefore appending 23:59
1087         $endDate = new DateTime($absoluteDate[0] . ' ' . '23:59');
1088         $r->until($endDate);
1089       }
1090
1091       if (!$scheduleReminderDetails['start_action_offset'] && !$scheduleReminderDetails['absolute_date']) {
1092         $r->errors[] = 'Ends: is a required field';
1093       }
1094     }
1095     else {
1096       $r->errors[] = 'Repeats: is a required field';
1097     }
1098     return $r;
1099   }
1100
1101
1102   /**
1103    * This function gets time difference between the two datetime object.
1104    *
1105    * @param DateTime $startDate
1106    *   Start Date .
1107    * @param DateTime $endDate
1108    *   End Date .
1109    *
1110    *
1111    * @return object
1112    *   DateTime object which contain time difference
1113    */
1114   static public function getInterval($startDate, $endDate) {
1115     if ($startDate && $endDate) {
1116       $startDate = new DateTime($startDate);
1117       $endDate = new DateTime($endDate);
1118       return $startDate->diff($endDate);
1119     }
1120   }
1121
1122   /**
1123    * This function gets all columns from civicrm_action_schedule on the basis of event id.
1124    *
1125    * @param int $entityId
1126    *   Entity ID .
1127    * @param string $used_for
1128    *   Specifies for which entity type it's used for .
1129    *
1130    *
1131    * @return object
1132    */
1133   public static function getReminderDetailsByEntityId($entityId, $used_for) {
1134     if ($entityId) {
1135       $query = "
1136         SELECT *
1137         FROM   civicrm_action_schedule
1138         WHERE  entity_value = %1";
1139       if ($used_for) {
1140         $query .= " AND used_for = %2";
1141       }
1142       $params = array(
1143         1 => array($entityId, 'Integer'),
1144         2 => array($used_for, 'String'),
1145       );
1146       $dao = CRM_Core_DAO::executeQuery($query, $params);
1147       $dao->fetch();
1148     }
1149     return $dao;
1150   }
1151
1152   /**
1153    * Update mode column in civicrm_recurring_entity table for event related tabs.
1154    *
1155    * @param int $entityId
1156    *   Event id .
1157    * @param string $linkedEntityTable
1158    *   Linked entity table name for this event .
1159    * @return array
1160    */
1161   public static function updateModeLinkedEntity($entityId, $linkedEntityTable, $mainEntityTable) {
1162     $result = array();
1163     if ($entityId && $linkedEntityTable && $mainEntityTable) {
1164       if (CRM_Utils_Array::value($linkedEntityTable, self::$_tableDAOMapper)) {
1165         $dao = self::$_tableDAOMapper[$linkedEntityTable];
1166       }
1167       else {
1168         CRM_Core_Session::setStatus('Could not update mode for linked entities');
1169         return NULL;
1170       }
1171       $entityTable = $linkedEntityTable;
1172       $params = array(
1173         'entity_id' => $entityId,
1174         'entity_table' => $mainEntityTable,
1175       );
1176       $defaults = array();
1177       CRM_Core_DAO::commonRetrieve($dao, $params, $defaults);
1178       if (!empty($defaults['id'])) {
1179         $result['entityId'] = $defaults['id'];
1180         $result['entityTable'] = $entityTable;
1181       }
1182     }
1183     return $result;
1184   }
1185
1186 }