Merge pull request #10953 from seamuslee001/CRM-20892

CRM-20892 Add in modified_date column to civicrm_mailing to assist in…
civicrm · Sep 11, 2017 · d2c3675 · d2c3675
2 parents b448aa6 + 56944d3
commit d2c3675
Show file tree

Hide file tree

Showing 7 changed files with 89 additions and 31 deletions.
diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php
@@ -1600,11 +1600,19 @@ public static function add(&$params, $ids = array()) {
     ) {
       $params['replyto_email'] = $params['from_email'];
     }
-
     $mailing->copyValues($params);
 
+    // CRM-20892 Unset Modifed Date here so that MySQL can correctly set an updated modfied date.
+    unset($mailing->modified_date);
     $result = $mailing->save();
 
+    // CRM-20892 Re find record after saing so we can set the updated modified date in the result.
+    $mailing->find(TRUE);
+
+    if (isset($mailing->modified_date)) {
+      $result->modified_date = $mailing->modified_date;
+    }
+
     if (!empty($ids['mailing'])) {
       CRM_Utils_Hook::post('edit', 'Mailing', $mailing->id, $mailing);
     }

diff --git a/CRM/Mailing/DAO/Mailing.php b/CRM/Mailing/DAO/Mailing.php
@@ -30,7 +30,7 @@
  *
  * Generated from xml/schema/CRM/Mailing/Mailing.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:9a7cf33adcdee2e83d5fe1b5a28186cb)
+ * (GenCodeChecksum:3e332257744be5cf9d7a2545f69f67eb)
  */
 require_once 'CRM/Core/DAO.php';
 require_once 'CRM/Utils/Type.php';
@@ -210,6 +210,12 @@ class CRM_Mailing_DAO_Mailing extends CRM_Core_DAO {
    * @var timestamp
    */
   public $created_date;
+  /**
+   * When the mailing (or closely related entity) was created or modified or deleted.
+   *
+   * @var timestamp
+   */
+  public $modified_date;
   /**
    * FK to Contact ID who scheduled this mailing
    *
@@ -673,7 +679,7 @@ static function &fields() {
           'title' => ts('Mailing Created Date') ,
           'description' => 'Date and time this mailing was created.',
           'required' => false,
-          'default' => 'CURRENT_TIMESTAMP',
+          'default' => 'NULL',
           'table_name' => 'civicrm_mailing',
           'entity' => 'Mailing',
           'bao' => 'CRM_Mailing_BAO_Mailing',
@@ -683,6 +689,22 @@ static function &fields() {
             'formatType' => 'activityDateTime',
           ) ,
         ) ,
+        'mailing_modified_date' => array(
+          'name' => 'modified_date',
+          'type' => CRM_Utils_Type::T_TIMESTAMP,
+          'title' => ts('Modified Date') ,
+          'description' => 'When the mailing (or closely related entity) was created or modified or deleted.',
+          'required' => false,
+          'export' => true,
+          'where' => 'civicrm_mailing.modified_date',
+          'headerPattern' => '',
+          'dataPattern' => '',
+          'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
+          'table_name' => 'civicrm_mailing',
+          'entity' => 'Mailing',
+          'bao' => 'CRM_Mailing_BAO_Mailing',
+          'localizable' => 0,
+        ) ,
         'scheduled_id' => array(
           'name' => 'scheduled_id',
           'type' => CRM_Utils_Type::T_INT,

diff --git a/CRM/Upgrade/Incremental/php/FourSeven.php b/CRM/Upgrade/Incremental/php/FourSeven.php
@@ -429,6 +429,16 @@ public function upgrade_4_7_25($rev) {
       'civicrm_case', 'modified_date', "timestamp NULL  DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'When was the case (or closely related entity) was created or modified or deleted.'");
   }
 
+  /**
+   * Upgrade function.
+   *
+   * @param string $rev
+   */
+  public function upgrade_4_7_26($rev) {
+    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
+    $this->addTask('CRM-20892 - Add modified_date to civicrm_mailing', 'addColumn',
+      'civicrm_mailing', 'modified_date', "timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'When the mailing (or closely related entity) was created or modified or deleted.'");
+  }
 
   /*
    * Important! All upgrade functions MUST add a 'runSql' task.

diff --git a/CRM/Upgrade/Incremental/sql/4.7.26.mysql.tpl b/CRM/Upgrade/Incremental/sql/4.7.26.mysql.tpl
@@ -1 +1,4 @@
 {* file to handle db changes in 4.7.26 during upgrade *}
+
+-- CRM-20892 Change created_date default so that we can add a modified_date column
+ALTER TABLE civicrm_mailing CHANGE created_date created_date timestamp NULL  DEFAULT NULL COMMENT 'Date and time this mailing was created.';
diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php
@@ -208,6 +208,11 @@ public function createContainer() {
         ->setFactory(array($class, 'singleton'));
     }
 
+    $container->setDefinition('civi.mailing.triggers', new Definition(
+      'Civi\Core\SqlTrigger\TimestampTriggers',
+      array('civicrm_mailing', 'Mailing')
+    ))->addTag('kernel.event_listener', array('event' => 'hook_civicrm_triggerInfo', 'method' => 'onTriggerInfo'));
+
     $container->setDefinition('civi.activity.triggers', new Definition(
       'Civi\Core\SqlTrigger\TimestampTriggers',
       array('civicrm_activity', 'Activity')

diff --git a/sql/civicrm_generated.mysql b/sql/civicrm_generated.mysql
diff --git a/xml/schema/Mailing/Mailing.xml b/xml/schema/Mailing/Mailing.xml
@@ -272,7 +272,7 @@
   <field>
     <name>created_date</name>
     <type>timestamp</type>
-    <default>CURRENT_TIMESTAMP</default>
+    <default>NULL</default>
     <required>false</required>
     <title>Mailing Created Date</title>
     <comment>Date and time this mailing was created.</comment>
@@ -282,6 +282,16 @@
       <formatType>activityDateTime</formatType>
     </html>
   </field>
+  <field>
+   <name>modified_date</name>
+   <uniqueName>mailing_modified_date</uniqueName>
+   <type>timestamp</type>
+   <comment>When the mailing (or closely related entity) was created or modified or deleted.</comment>
+   <required>false</required>
+   <export>true</export>
+   <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP</default>
+   <add>4.7</add>
+  </field>
   <field>
     <name>scheduled_id</name>
     <title>Scheduled By</title>