added daily trigger for group members

CRM/Civirules/BAO/Event.php

@@ -178,6 +178,26 @@ class CRM_Civirules_BAO_Event extends CRM_Civirules_DAO_Event {
     return $object;
   }
 
+  public static function getEventObjectByEventId($event_id, $abort=true) {
+    $sql = "SELECT e.*
+            FROM `civirule_event` e
+            WHERE e.`is_active` = 1 AND e.id = %1";
+
+    $params[1] = array($event_id, 'Integer');
+    $dao = CRM_Core_DAO::executeQuery($sql, $params);
+    if ($dao->fetch()) {
+      if (!empty($dao->object_name) && !empty($dao->op) && empty($dao->cron)) {
+        return self::getPostEventObjectByClassName($dao->class_name, $abort);
+      } elseif (!empty($dao->class_name)) {
+        return self::getEventObjectByClassName($dao->class_name, $abort);
+      }
+    }
+
+    if ($abort) {
+      throw new Exception('Could not find event with ID: '.$event_id);
+    }
+  }
+
   /*
    * Function to check if an event exists with class_name or object_name/op
    *

CRM/Civirules/BAO/Rule.php

@@ -166,7 +166,7 @@ class CRM_Civirules_BAO_Rule extends CRM_Civirules_DAO_Rule {
   public static function findRulesByObjectNameAndOp($objectName, $op)
   {
     $events = array();
-    $sql = "SELECT r.id AS rule_id, e.id AS event_id, e.class_name
+    $sql = "SELECT r.id AS rule_id, e.id AS event_id, e.class_name, r.event_params
             FROM `civirule_rule` r
             INNER JOIN `civirule_event` e ON r.event_id = e.id AND e.is_active = 1
             WHERE r.`is_active` = 1 AND e.cron = 0 AND e.object_name = %1 AND e.op = %2";
@@ -175,10 +175,11 @@ class CRM_Civirules_BAO_Rule extends CRM_Civirules_DAO_Rule {
 
     $dao = CRM_Core_DAO::executeQuery($sql, $params);
     while ($dao->fetch()) {
-      $eventObject = CRM_Civirules_BAO_Event::getPostEventObjectByClassName($dao->class_name, $objectName, false);
+      $eventObject = CRM_Civirules_BAO_Event::getPostEventObjectByClassName($dao->class_name, false);
       if ($eventObject !== false) {
         $eventObject->setEventId($dao->event_id);
         $eventObject->setRuleId($dao->rule_id);
+        $eventObject->setEventParams($dao->event_params);
         $events[] = $eventObject;
       }
     }
@@ -193,7 +194,7 @@ class CRM_Civirules_BAO_Rule extends CRM_Civirules_DAO_Rule {
   public static function findRulesForCron()
   {
     $cronEvents = array();
-    $sql = "SELECT r.id AS rule_id, e.id AS event_id, e.class_name
+    $sql = "SELECT r.id AS rule_id, e.id AS event_id, e.class_name, r.event_params
             FROM `civirule_rule` r
             INNER JOIN `civirule_event` e ON r.event_id = e.id AND e.is_active = 1
             WHERE r.`is_active` = 1 AND e.cron = 1";
@@ -204,6 +205,7 @@ class CRM_Civirules_BAO_Rule extends CRM_Civirules_DAO_Rule {
       if ($cronEventObject !== false) {
         $cronEventObject->setEventId($dao->event_id);
         $cronEventObject->setRuleId($dao->rule_id);
+        $cronEventObject->setEventParams($dao->event_params);
         $cronEvents[] = $cronEventObject;
       }
     }

CRM/Civirules/DAO/Rule.php

@@ -48,6 +48,10 @@ class CRM_Civirules_DAO_Rule extends CRM_Core_DAO {
           'name' => 'event_id',
           'type' => CRM_Utils_Type::T_INT,
         ),
+        'event_params' => array(
+          'name' => 'event_params',
+          'type' => CRM_Utils_Type::T_TEXT
+        ),
         'is_active' => array(
           'name' => 'is_active',
           'type' => CRM_Utils_Type::T_INT,
@@ -86,6 +90,7 @@ class CRM_Civirules_DAO_Rule extends CRM_Core_DAO {
         'name' => 'name',
         'label' => 'label',
         'event_id' => 'event_id',
+        'event_params' => 'event_params',
         'is_active' => 'is_active',
         'created_date' => 'created_date',
         'created_user_id' => 'created_user_id',

CRM/Civirules/Engine.php

@@ -17,6 +17,7 @@ class CRM_Civirules_Engine {
    *
    * @param CRM_Civirules_Event $event
    * @param object CRM_Civirules_EventData_EventData $eventData
+   * @return bool true when conditions are valid; false when conditions are not valid
    * @access public
    * @static
    */
@@ -27,7 +28,9 @@ class CRM_Civirules_Engine {
     if ($isRuleValid) {
       self::logRule($eventData);
       self::executeActions($eventData);
+      return true;
     }
+    return false;
   }
 
   /**

CRM/Civirules/Event.php

@@ -6,10 +6,16 @@ abstract class CRM_Civirules_Event {
 
   protected $eventId;
 
+  protected $eventParams;
+
   public function setRuleId($ruleId) {
     $this->ruleId = $ruleId;
   }
 
+  public function setEventParams($eventParams) {
+    $this->eventParams = $eventParams;
+  }
+
   public function getRuleId() {
     return $this->ruleId;
   }
@@ -51,4 +57,29 @@ abstract class CRM_Civirules_Event {
     return array();
   }
 
+  /**
+   * Returns a redirect url to extra data input from the user after adding a condition
+   *
+   * Return false if you do not need extra data input
+   *
+   * @param int $ruleId
+   * @return bool|string
+   * @access public
+   * @abstract
+   */
+  public function getExtraDataInputUrl($ruleId) {
+    return false;
+  }
+
+  /**
+   * Returns a description of this event
+   *
+   * @return string
+   * @access public
+   * @abstract
+   */
+  public function getEventDescription() {
+    return '';
+  }
+
 }
\ No newline at end of file

CRM/Civirules/Event/Cron.php

@@ -16,11 +16,18 @@ abstract class CRM_Civirules_Event_Cron extends CRM_Civirules_Event {
    */
   public function process() {
     $count = 0;
+    $isValidCount = 0;
     while($eventData = $this->getNextEntityEventData()) {
-      CRM_Civirules_Engine::triggerRule($eventData, $this->ruleId, $this->eventId);
+      $isValid = CRM_Civirules_Engine::triggerRule($this, $eventData);
+      if ($isValid) {
+        $isValidCount++;
+      }
       $count ++;
     }
-    return $count;
+    return array(
+      'count' => $count,
+      'is_valid_count' => $isValidCount,
+    );
   }
 
 

CRM/Civirules/Form/Rule.php

@@ -13,6 +13,15 @@ class CRM_Civirules_Form_Rule extends CRM_Core_Form {
   
   protected $ruleId = NULL;
 
+  protected $rule;
+
+  protected $event;
+
+  /**
+   * @var CRM_Civirules_Event
+   */
+  protected $eventClass;
+
   /**
    * Function to buildQuickForm (extends parent function)
    * 
@@ -31,6 +40,32 @@ class CRM_Civirules_Form_Rule extends CRM_Core_Form {
    */
   function preProcess() {
     $this->ruleId = CRM_Utils_Request::retrieve('id', 'Integer');
+
+    $this->rule = new CRM_Civirules_BAO_Rule();
+    $this->event = new CRM_Civirules_BAO_Event();
+
+    $this->assign('event_edit_params', false);
+    $this->eventClass = false;
+    if (!empty($this->ruleId)) {
+      $this->rule->id = $this->ruleId;
+      if (!$this->rule->find(TRUE)) {
+        throw new Exception('Civirules could not find rule');
+      }
+
+      $this->event->id = $this->rule->event_id;
+      if (!$this->event->find(TRUE)) {
+        throw new Exception('Civirules could not find event');
+      }
+
+      $this->eventClass = CRM_Civirules_BAO_Event::getEventObjectByEventId($this->event->id, TRUE);
+      $this->eventClass->setEventId($this->event->id);
+      $this->eventClass->setRuleId($this->rule->id);
+      $this->eventClass->setEventParams($this->rule->event_params);
+
+      $this->assign('event_edit_params', $this->eventClass->getExtraDataInputUrl($this->ruleId));
+    }
+    $this->assign('eventClass', $this->eventClass);
+
     $ruleConditionAddUrl = CRM_Utils_System::url('civicrm/civirule/form/rule_condition', 'reset=1&action=add&rid='.$this->ruleId, TRUE);
     $ruleActionAddUrl = CRM_Utils_System::url('civicrm/civirule/form/rule_action', 'reset=1&action=add&rid='.$this->ruleId, TRUE);
     $this->assign('ruleConditionAddUrl', $ruleConditionAddUrl);
@@ -73,6 +108,14 @@ class CRM_Civirules_Form_Rule extends CRM_Core_Form {
       $editUrl = CRM_Utils_System::url('civicrm/civirule/form/rule', 'action=update&id='.$this->ruleId, TRUE);
       $session->pushUserContext($editUrl);
     }
+
+    if (isset($this->_submitValues['rule_event_select'])) {
+      $redirectUrl = $this->getEventRedirect($this->_submitValues['rule_event_select']);
+      if ($redirectUrl) {
+        CRM_Utils_System::redirect($redirectUrl);
+      }
+    }
+
     parent::postProcess();
   }
 
@@ -356,4 +399,19 @@ class CRM_Civirules_Form_Rule extends CRM_Core_Form {
       CRM_Civirules_BAO_Rule::add($ruleParams);
     }
   }
+
+  /**
+   * Returns the url for redirect
+   *
+   * @param $event_id
+   * @return bool|string url
+   */
+  protected function getEventRedirect($event_id) {
+    $event = CRM_Civirules_BAO_Event::getEventObjectByEventId($event_id, true);
+    $redirectUrl = $event->getExtraDataInputUrl($this->ruleId);
+    if (!empty($redirectUrl)) {
+      return $redirectUrl;
+    }
+    return false;
+  }
 }

CRM/Civirules/Upgrader.php

@@ -24,4 +24,15 @@ class CRM_Civirules_Upgrader extends CRM_Civirules_Upgrader_Base {
   public function uninstall() {
     $this->executeSqlFile('sql/uninstall.sql');
   }
+
+  public function upgrade_1001() {
+    CRM_Core_DAO::executeQuery("ALTER TABLE `civirule_rule` ADD event_params TEXT NULL AFTER event_id");
+
+    CRM_Core_DAO::executeQuery("
+      INSERT INTO civirule_event (name, label, object_name, op, cron, class_name, created_date, created_user_id)
+      VALUES
+        ('groupmembership', 'Daily trigger for group members', null, null, 1, 'CRM_CivirulesCronEvent_GroupMembership',  CURDATE(), 1);
+      ");
+    return true;
+  }
 }
\ No newline at end of file

CRM/CivirulesConditions/Contact/AgeComparison.php

@@ -6,7 +6,7 @@
  * @license AGPL-3.0
  */
 
-class CRM_CivirulesConditions_Contact_Contact_AgeComparison extends CRM_CivirulesConditions_Generic_ValueComparison {
+class CRM_CivirulesConditions_Contact_AgeComparison extends CRM_CivirulesConditions_Generic_ValueComparison {
 
   /**
    * Returns value of the field
@@ -65,7 +65,7 @@ class CRM_CivirulesConditions_Contact_Contact_AgeComparison extends CRM_Civirule
    * @access public
    */
   public function requiredEntities() {
-    return array('contact');
+    return array();
   }
 
 }
\ No newline at end of file

CRM/CivirulesCronEvent/Birthday.php

@@ -58,7 +58,7 @@ class CRM_CivirulesCronEvent_Birthday extends CRM_Civirules_Event_Cron {
               WHERE `rule_log`.`rule_id` = %1 AND DATE(`rule_log`.`log_date`) = DATE(NOW())
             )";
     $params[1] = array($this->ruleId, 'Integer');
-    $this->dao = CRM_Core_DAO::executeQuery($sql, $params, 'CRM_Contact_BAO_Contact');
+    $this->dao = CRM_Core_DAO::executeQuery($sql, $params, true, 'CRM_Contact_BAO_Contact');
   }
 
 }
\ No newline at end of file

CRM/CivirulesCronEvent/Form/GroupMembership.php

+<?php
+/**
+ * Class for CiviRules Condition Contribution Financial Type Form
+ *
+ * @author Jaap Jansma (CiviCooP) <jaap.jansma@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+class CRM_CivirulesCronEvent_Form_GroupMembership extends CRM_CivirulesEvent_Form_Form {
+
+  /**
+   * Method to get groups
+   *
+   * @return array
+   * @access protected
+   */
+  protected function getGroups() {
+    return CRM_Contact_BAO_GroupContact::getGroupList();
+  }
+
+  /**
+   * Overridden parent method to build form
+   *
+   * @access public
+   */
+  public function buildQuickForm() {
+    $this->add('hidden', 'rule_id');
+
+    $this->add('select', 'group_id', ts('Groups'), $this->getGroups(), true);
+
+    $this->addButtons(array(
+      array('type' => 'next', 'name' => ts('Save'), 'isDefault' => TRUE,),
+      array('type' => 'cancel', 'name' => ts('Cancel'))));
+  }
+
+  /**
+   * Overridden parent method to set default values
+   *
+   * @return array $defaultValues
+   * @access public
+   */
+  public function setDefaultValues() {
+    $defaultValues = parent::setDefaultValues();
+    $data = unserialize($this->rule->event_params);
+    if (!empty($data['group_id'])) {
+      $defaultValues['group_id'] = $data['group_id'];
+    }
+    return $defaultValues;
+  }
+
+  /**
+   * Overridden parent method to process form data after submission
+   *
+   * @throws Exception when rule condition not found
+   * @access public
+   */
+  public function postProcess() {
+    $data['group_id'] = $this->_submitValues['group_id'];
+    $this->rule->event_params = serialize($data);
+    $this->rule->save();
+
+    parent::postProcess();
+  }
+}
\ No newline at end of file

CRM/CivirulesCronEvent/GroupMembership.php

+<?php
+/**
+ * Created by PhpStorm.
+ * User: jaap
+ * Date: 6/23/15
+ * Time: 10:26 AM
+ */
+
+class CRM_CivirulesCronEvent_GroupMembership extends CRM_Civirules_Event_Cron {
+
+  private $dao = false;
+
+  /**
+   * This function returns a CRM_Civirules_EventData_EventData this entity is used for triggering the rule
+   *
+   * Return false when no next entity is available
+   *
+   * @return CRM_Civirules_EventData_EventData|false
+   */
+  protected function getNextEntityEventData() {
+    if (!$this->dao) {
+      if (!$this->queryForEventEntities()) {
+        return false;
+      }
+    }
+    if ($this->dao->fetch()) {
+      $data = array();
+      CRM_Core_DAO::storeValues($this->dao, $data);
+      $eventData = new CRM_Civirules_EventData_Cron($this->dao->contact_id, 'GroupContact', $data);
+      return $eventData;
+    }
+    return false;
+  }
+
+  /**
+   * Returns an array of entities on which the event reacts
+   *
+   * @return CRM_Civirules_EventData_EntityDefinition
+   */
+  protected function reactOnEntity() {
+    return new CRM_Civirules_EventData_EntityDefinition('GroupContact', 'GroupContact', 'CRM_Contact_DAO_GroupContact', 'GroupContact');
+  }
+
+  /**
+   * Method to query event entities
+   *
+   * @access private
+   */
+  private function queryForEventEntities() {
+
+    if (empty($this->eventParams['group_id'])) {
+      return false;
+    }
+
+    $sql = "SELECT c.*
+            FROM `civicrm_group_contact` `c`
+            WHERE `c`.`group_id` = %1 AND c.status = 'Added'
+            AND `c`.`contact_id` NOT IN (
+              SELECT `rule_log`.`contact_id`
+              FROM `civirule_rule_log` `rule_log`
+              WHERE `rule_log`.`rule_id` = %2 AND DATE(`rule_log`.`log_date`) = DATE(NOW())
+            )";
+    $params[1] = array($this->eventParams['group_id'], 'Integer');
+    $params[2] = array($this->ruleId, 'Integer');
+    $this->dao = CRM_Core_DAO::executeQuery($sql, $params, true, 'CRM_Contact_DAO_GroupContact');
+
+    return true;
+  }
+
+  /**
+   * Returns a redirect url to extra data input from the user after adding a condition
+   *
+   * Return false if you do not need extra data input
+   *
+   * @param int $ruleId
+   * @return bool|string
+   * @access public
+   * @abstract
+   */
+  public function getExtraDataInputUrl($ruleId) {
+    return CRM_Utils_System::url('civicrm/civirule/form/event/groupmembership/', 'rule_id='.$ruleId);
+  }
+
+  public function setEventParams($eventParams) {
+    $this->eventParams = unserialize($eventParams);
+  }
+
+  /**
+   * Returns a description of this event
+   *
+   * @return string
+   * @access public
+   * @abstract
+   */
+  public function getEventDescription() {
+    $groupName = ts('Unknown');
+    try {
+      $groupName = civicrm_api3('Group', 'getvalue', array(
+        'return' => 'title',
+        'id' => $this->eventParams['group_id']
+      ));
+    } catch (Exception $e) {
+      //do nothing
+    }
+    return ts('Daily trigger for all members of group %1', array(
+      1 => $groupName
+    ));
+  }
+
+}
\ No newline at end of file

CRM/CivirulesEvent/Form/Form.php

+<?php
+
+class CRM_CivirulesEvent_Form_Form extends CRM_Core_Form
+{
+
+  protected $ruleId = false;
+
+  protected $rule;
+
+  protected $event;
+
+  /**
+   * @var CRM_Civirules_Event
+   */
+  protected $eventClass;
+
+  /**
+   * Overridden parent method to perform processing before form is build
+   *
+   * @access public
+   */
+  public function preProcess()
+  {
+    $this->ruleId = CRM_Utils_Request::retrieve('rule_id', 'Integer');
+
+    $this->rule = new CRM_Civirules_BAO_Rule();
+    $this->event = new CRM_Civirules_BAO_Event();
+
+    $this->rule->id = $this->ruleId;
+    if (!$this->rule->find(true)) {
+      throw new Exception('Civirules could not find rule');
+    }
+
+    $this->event->id = $this->rule->event_id;
+    if (!$this->event->find(true)) {
+      throw new Exception('Civirules could not find event');
+    }
+
+    $this->eventClass = CRM_Civirules_BAO_Event::getEventObjectByEventId($this->event->id, true);
+    $this->eventClass->setEventId($this->event->id);
+    $this->eventClass->setRuleId($this->rule->id);
+    $this->eventClass->setEventParams($this->rule->event_params);
+
+    parent::preProcess();
+
+    $this->setFormTitle();
+  }
+
+  /**
+   * Overridden parent method to set default values
+   *
+   * @return array $defaultValues
+   * @access public
+   */
+  public function setDefaultValues() {
+    $defaultValues = array();
+    $defaultValues['rule_id'] = $this->ruleId;
+    return $defaultValues;
+  }
+
+  public function postProcess() {
+    $session = CRM_Core_Session::singleton();
+    $session->setStatus('Rule '.$this->rule->label.' parameters updated', 'Rule parameters updated', 'success');
+
+    $redirectUrl = CRM_Utils_System::url('civicrm/civirule/form/rule', 'action=update&id='.$this->rule->id, TRUE);
+    CRM_Utils_System::redirect($redirectUrl);
+  }
+
+  /**
+   * Method to set the form title
+   *
+   * @access protected
+   */
+  protected function setFormTitle() {
+    $title = 'CiviRules Edit event parameters';
+    $this->assign('ruleEventHeader', 'Edit rule '.$this->rule->label);
+    CRM_Utils_System::setTitle($title);
+  }
+
+}
\ No newline at end of file

api/v3/Civirules/Cron.php

@@ -26,10 +26,13 @@ function civicrm_api3_civirules_cron($params) {
 
   $rules = CRM_Civirules_BAO_Rule::findRulesForCron();
   foreach($rules as $rule) {
-    $triggeredEntities = $rule->process();
+    $return = $rule->process();
+    $triggeredEntities = $return['count'];
+    $triggeredActions = $return['is_valid_count'];
     $returnValues[$rule->getRuleId()] = array(
       'rule' => CRM_Civirules_BAO_Rule::getRuleLabelWithId($rule->getRuleId()),
       'triggered_entities' => $triggeredEntities,
+      'triggered_actions' => $triggeredActions,
     );
   }
 

sql/createCiviruleRule.sql

@@ -3,6 +3,7 @@ CREATE TABLE IF NOT EXISTS civirule_rule (
   name VARCHAR(80) NULL,
   label VARCHAR(128) NULL,
   event_id INT UNSIGNED NULL,
+  event_params TEXT NULL,
   is_active TINYINT NULL DEFAULT 1,
   created_date DATE NULL,
   created_user_id INT NULL,

sql/insertCiviruleEvent.sql

@@ -86,4 +86,7 @@ VALUES
   ('deleted_tag', 'Tag is deleted', 'Tag', 'delete', null, CURDATE(), 1);
 
 INSERT INTO civirule_event (name, label, object_name, op, cron, class_name, created_date, created_user_id)
-VALUES  ('birthday', 'Individual has birthday', null, null, 1, 'CRM_CivirulesCronEvent_Birthday',  CURDATE(), 1);
+VALUES
+  ('birthday', 'Individual has birthday', null, null, 1, 'CRM_CivirulesCronEvent_Birthday',  CURDATE(), 1),
+  ('groupmembership', 'Daily trigger for group members', null, null, 1, 'CRM_CivirulesCronEvent_GroupMembership',  CURDATE(), 1);
+

templates/CRM/Civirules/Form/RuleBlocks/EventBlock.tpl

@@ -13,7 +13,17 @@
         <table id="civirule-eventBlock-table" class="display">
           <tbody>
             <tr class="odd-row">
-              <td>{$form.rule_event_label.value}</td>
+              <td>
+                  {$form.rule_event_label.value}
+                  {if $eventClass && $eventClass->getEventDescription()}
+                    <br><span class="description">
+                        {$eventClass->getEventDescription()}
+                    </span>
+                  {/if}
+                  {if $event_edit_params}
+                      <br><a href="{$event_edit_params}">{ts}Edit event parameters{/ts}</a>
+                  {/if}
+              </td>
             </tr>
           </tbody>
         </table>

templates/CRM/CivirulesCronEvent/Form/GroupMembership.tpl

+<h3>{$ruleEventHeader}</h3>
+<div class="crm-block crm-form-block crm-civirule-cron_event-block-group_membership">
+    <div class="crm-section">
+        <div class="label">{$form.group_id.label}</div>
+        <div class="content">{$form.group_id.html}</div>
+        <div class="clear"></div>
+    </div>
+</div>
+<div class="crm-submit-buttons">
+    {include file="CRM/common/formButtons.tpl" location="bottom"}
+</div>
\ No newline at end of file

xml/Menu/civirules.xml

@@ -72,6 +72,12 @@
     <title>Group contact</title>
     <access_arguments>access CiviCRM</access_arguments>
   </item>
+  <item>
+    <path>civicrm/civirule/form/event/groupmembership</path>
+    <page_callback>CRM_CivirulesCronEvent_Form_GroupMembership</page_callback>
+    <title>Group membership</title>
+    <access_arguments>access CiviCRM</access_arguments>
+  </item>
   <item>
     <path>civicrm/civirule/form/action/tag</path>
     <page_callback>CRM_CivirulesActions_Tag_Form_TagId</page_callback>