CRM/Upgrade/Incremental/php/FourSix.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7.alpha1                                         |
   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  * Upgrade logic for 4.6
  30  */
  31 class CRM_Upgrade_Incremental_php_FourSix extends CRM_Upgrade_Incremental_Base {
  32
  33   /**
  34    * Compute any messages which should be displayed after upgrade.
  35    *
  36    * @param string $postUpgradeMessage
  37    *   alterable.
  38    * @param string $rev
  39    *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
  40    */
  41   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  42     if ($rev == '4.6.alpha1') {
  43       $postUpgradeMessage .= '<br /><br />' . ts('Default versions of the following System Workflow Message Templates have been modified to handle new functionality: <ul><li>Events - Registration Confirmation and Receipt (on-line)</li><li>Events - Registration Confirmation and Receipt (off-line)</li><li>Contributions - Receipt (on-line)</li><li>Contributions - Receipt (off-line)</li><li>Memberships - Receipt (on-line)</li><li>Memberships - Signup and Renewal Receipts (off-line)</li></ul> If you have modified these templates, please review the new default versions and implement updates as needed to your copies (Administer > Communications > Message Templates > System Workflow Messages).');
  44     }
  45     if ($rev == '4.6.alpha3') {
  46       $postUpgradeMessage .= '<br /><br />' . ts('A new permission has been added for editing message templates. Previously, users needed the "administer CiviCRM" permission. Now, users need the new permission called "edit message templates." Please check your CMS permissions to ensure that users who should be able to edit message templates are assigned this new permission.');
  47     }
  48   }
  49
  50   /**
  51    * CRM-16846 - This function incorrectly omits running the 4.6.alpha3 sql file.
  52    *
  53    * Instead of correcting it here (which would not run again for sites already on 4.6),
  54    * the file is re-run conditionally during 4.6.6
  55    * @see upgrade_4_6_6
  56    *
  57    * @param string $rev
  58    */
  59   public function upgrade_4_6_alpha3($rev) {
  60     // Task to process sql.
  61     $this->addTask(ts('Add and update reference_date column for Schedule Reminders'), 'updateReferenceDate');
  62   }
  63
  64   /**
  65    * Add new column reference_date to civicrm_action_log in order to track.
  66    *
  67    * CRM-15728, actual action_start_date for membership entity for only those schedule reminders which are not repeatable
  68    *
  69    * @param \CRM_Queue_TaskContext $ctx
  70    *
  71    * @return bool
  72    */
  73   public static function updateReferenceDate(CRM_Queue_TaskContext $ctx) {
  74     //Add column civicrm_action_log.reference_date if not exists.
  75     $sql = "SELECT count(*) FROM information_schema.columns WHERE table_schema = database() AND table_name = 'civicrm_action_log' AND COLUMN_NAME = 'reference_date' ";
  76     $res = CRM_Core_DAO::singleValueQuery($sql);
  77
  78     if ($res <= 0) {
  79       $query = "ALTER TABLE `civicrm_action_log`
  80  ADD COLUMN `reference_date` date COMMENT 'Stores the date from the entity which triggered this reminder action (e.g. membership.end_date for most membership renewal reminders)'";
  81       CRM_Core_DAO::executeQuery($query);
  82     }
  83
  84     //Retrieve schedule reminders for membership entity and is not repeatable and no absolute date chosen.
  85     $query = "SELECT schedule.* FROM civicrm_action_schedule schedule
  86  INNER JOIN civicrm_action_mapping mapper ON mapper.id = schedule.mapping_id AND
  87    mapper.entity = 'civicrm_membership' AND
  88    schedule.is_repeat = 0 AND
  89    schedule.start_action_date IS NOT NULL";
  90
  91     // construct basic where clauses
  92     $where = array(
  93       'reminder.action_date_time >= DATE_SUB(reminder.action_date_time, INTERVAL 9 MONTH)',
  94     ); //choose reminder older then 9 months
  95     $dao = CRM_Core_DAO::executeQuery($query);
  96     while ($dao->fetch()) {
  97
  98       $referenceColumn = str_replace('membership_', "m.", $dao->start_action_date);
  99       $value = implode(', ', explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($dao->entity_value, CRM_Core_DAO::VALUE_SEPARATOR)));
 100       if (!empty($value)) {
 101         $where[] = "m.membership_type_id IN ({$value})";
 102       }
 103       else {
 104         $where[] = "m.membership_type_id IS NULL";
 105       }
 106
 107       //Create new action_log records where action_start_date changes and exclude reminders for additional contacts
 108       //and select contacts are active
 109       $sql = "UPDATE civicrm_action_log reminder
 110  LEFT JOIN civicrm_membership m
 111    ON reminder.entity_id = m.id AND
 112    reminder.entity_table = 'civicrm_membership' AND
 113    ( m.is_override IS NULL OR m.is_override = 0 )
 114  INNER JOIN civicrm_contact c
 115    ON c.id = m.contact_id AND
 116    c.is_deleted = 0 AND c.is_deceased = 0
 117  SET reminder.reference_date = {$referenceColumn}
 118  WHERE " . implode(" AND ", $where);
 119       CRM_Core_DAO::executeQuery($sql);
 120     }
 121
 122     return TRUE;
 123   }
 124
 125   /**
 126    * Upgrade function.
 127    *
 128    * @param string $rev
 129    */
 130   public function upgrade_4_6_1($rev) {
 131     // CRM-16289 - Fix invalid data in log_civicrm_case.case_type_id.
 132     $this->addTask(ts('Cleanup case type id data in log table.'), 'fixCaseLog');
 133   }
 134
 135   /**
 136    * Upgrade function.
 137    *
 138    * @param string $rev
 139    */
 140   public function upgrade_4_6_6($rev) {
 141     // CRM-16846 - This sql file may have been previously skipped. Conditionally run it again if it doesn't appear to have run before.
 142     if (!CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_state_province WHERE abbreviation = '100' AND country_id = 1193")) {
 143       $this->addTask('Update Slovenian municipalities', 'task_4_6_x_runOnlySql', '4.6.alpha3');
 144     }
 145     // CRM-16846 - This sql file may have been previously skipped. No harm in running it again because it's just UPDATE statements.
 146     $this->addTask('State-province update from 4.4.7', 'task_4_6_x_runOnlySql', '4.4.7');
 147
 148     $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
 149   }
 150
 151   /**
 152    * Remove special characters from case_type_id column in log_civicrm_case.
 153    *
 154    * CRM-16289 - If logging enabled and upgrading from 4.4 or earlier, log_civicrm_case.case_type_id will contain special characters.
 155    * This will cause ALTER TABLE to fail when changing this column to an INT
 156    *
 157    * @param \CRM_Queue_TaskContext $ctx
 158    *
 159    * @return bool
 160    */
 161   public static function fixCaseLog(CRM_Queue_TaskContext $ctx) {
 162     $sql = "SELECT count(*) FROM information_schema.columns WHERE table_schema = database() AND table_name = 'log_civicrm_case'";
 163     $res = CRM_Core_DAO::singleValueQuery($sql);
 164
 165     if ($res) {
 166       // executeQuery doesn't like running multiple engine changes in one pass, so have to break it up. dgg
 167       $query = "ALTER TABLE `log_civicrm_case` ENGINE = InnoDB;";
 168       CRM_Core_DAO::executeQuery($query);
 169       $query = "UPDATE log_civicrm_case SET case_type_id = replace(case_type_id, 0x01, '');";
 170       CRM_Core_DAO::executeQuery($query);
 171       $query = "ALTER TABLE `log_civicrm_case` ENGINE = ARCHIVE;";
 172       CRM_Core_DAO::executeQuery($query);
 173       $query = "ALTER TABLE log_civicrm_case MODIFY `case_type_id` int(10) unsigned DEFAULT NULL COMMENT 'FK to civicrm_case_type.id';";
 174       CRM_Core_DAO::executeQuery($query);
 175     }
 176     return TRUE;
 177   }
 178
 179   /**
 180    * Queue Task Callback for CRM-16846
 181    *
 182    * Run a sql file without resetting locale to that version
 183    */
 184   public static function task_4_6_x_runOnlySql(CRM_Queue_TaskContext $ctx, $rev) {
 185     $upgrade = new CRM_Upgrade_Form();
 186     $smarty = CRM_Core_Smarty::singleton();
 187     $smarty->assign('domainID', CRM_Core_Config::domainID());
 188
 189     $fileName = dirname(__DIR__) . "/sql/$rev.mysql.tpl";
 190
 191     $upgrade->source($smarty->fetch($fileName), TRUE);
 192
 193     return TRUE;
 194   }
 195
 196 }