3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License along with this program; if not, contact CiviCRM LLC |
21 | at info[AT]civicrm[DOT]org. If you have questions about the |
22 | GNU Affero General Public License or the licensing of CiviCRM, |
23 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
24 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2014
34 class CRM_Upgrade_Incremental_php_FourFive
{
35 const BATCH_SIZE
= 5000;
42 function verifyPreDBstate(&$errors) {
47 * Compute any messages which should be displayed beforeupgrade
49 * Note: This function is called iteratively for each upcoming
50 * revision to the database.
52 * @param $preUpgradeMessage
53 * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
54 * @param null $currentVer
56 * @internal param string $postUpgradeMessage , alterable
59 function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
63 * Compute any messages which should be displayed after upgrade
65 * @param $postUpgradeMessage string, alterable
66 * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
69 function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
70 if ($rev == '4.5.alpha1') {
71 $postUpgradeMessage .= '<br /><br />' . ts('Default versions of the following System Workflow Message Templates have been modified to handle new functionality: <ul><li>Contributions - Receipt (off-line)</li><li>Contributions - Receipt (on-line)</li><li>Contributions - Recurring Start and End Notification</li><li>Contributions - Recurring Updates</li><li>Memberships - Receipt (on-line)</li><li>Memberships - Signup and Renewal Receipts (off-line)</li><li>Pledges - Acknowledgement</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). (<a href="%1">learn more...</a>)', array(1 => 'http://wiki.civicrm.org/confluence/display/CRMDOC/Updating+System+Workflow+Message+Templates+after+Upgrades+-+method+1+-+kdiff'));
72 $postUpgradeMessage .= '<br /><br />' . ts('This release allows you to view and edit multiple-record custom field sets in a table format which will be more usable in some cases. You can try out the format by navigating to Administer > Custom Data & Screens > Custom Fields. Click Settings for a custom field set and change Display Style to "Tab with Tables".');
73 $postUpgradeMessage .= '<br /><br />' . ts('This release changes the way that anonymous event registrations match participants with existing contacts. By default, all event participants will be matched with existing individuals using the Unsupervised rule, even if multiple registrations with the same email address are allowed. However, you can now select a different matching rule to use for each event. Please review your events to make sure you choose the appropriate matching rule and collect sufficient information for it to match contacts.');
75 if ($rev == '4.5.beta2') {
76 $postUpgradeMessage .= '<br /><br />' . ts('If you use CiviMail for newsletters or other communications, check out the new sample CiviMail templates which use responsive design to optimize display on mobile devices (Administer > Communications > Message Templates ).');
78 if ($rev == '4.5.1') {
79 $postUpgradeMessage .= '<br /><br />' . ts('WARNING: If you use CiviCase with v4.5.alpha*, v4.5.beta*, or v4.5.0, it is possible that previous upgrades corrupted some CiviCase metadata. If you have not already done so, please identify any custom field sets, smart groups, or reports which refer to CiviCase and ensure that they are properly configured.');
88 function upgrade_4_5_alpha1($rev) {
89 // task to process sql
90 $this->addTask(ts('Migrate honoree information to module_data'), 'migrateHonoreeInfo');
91 $this->addTask(ts('Upgrade DB to 4.5.alpha1: SQL'), 'task_4_5_x_runSql', $rev);
92 $this->addTask(ts('Set default for Individual name fields configuration'), 'addNameFieldOptions');
94 // CRM-14522 - The below schema checking is done as foreign key name
95 // for pdf_format_id column varies for different databases
96 // if DB is been into upgrade for 3.4.2 version, it would have pdf_format_id name for FK
97 // else FK_civicrm_msg_template_pdf_format_id
98 $config = CRM_Core_Config
::singleton();
99 $dbUf = DB
::parseDSN($config->dsn
);
101 SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS
102 WHERE TABLE_NAME = 'civicrm_msg_template'
103 AND CONSTRAINT_TYPE = 'FOREIGN KEY'
104 AND TABLE_SCHEMA = %1
106 $params = array(1 => array($dbUf['database'], 'String'));
107 $dao = CRM_Core_DAO
::executeQuery($query, $params, TRUE, NULL, FALSE, FALSE);
109 if ($dao->CONSTRAINT_NAME
== 'FK_civicrm_msg_template_pdf_format_id' ||
110 $dao->CONSTRAINT_NAME
== 'pdf_format_id') {
111 $sqlDropFK = "ALTER TABLE `civicrm_msg_template`
112 DROP FOREIGN KEY `{$dao->CONSTRAINT_NAME}`,
113 DROP KEY `{$dao->CONSTRAINT_NAME}`";
114 CRM_Core_DAO
::executeQuery($sqlDropFK, CRM_Core_DAO
::$_nullArray, TRUE, NULL, FALSE, FALSE);
126 function upgrade_4_5_beta9($rev) {
127 $this->addTask(ts('Upgrade DB to 4.5.beta9: SQL'), 'task_4_5_x_runSql', $rev);
129 $entityTable = array(
130 'Participant' => 'civicrm_participant_payment',
131 'Contribution' => 'civicrm_contribution',
132 'Membership' => 'civicrm_membership',
135 foreach ($entityTable as $label => $tableName) {
136 list($minId, $maxId) = CRM_Core_DAO
::executeQuery("SELECT coalesce(min(id),0), coalesce(max(id),0)
137 FROM {$tableName}")->getDatabaseResult()->fetchRow();
138 for ($startId = $minId; $startId <= $maxId; $startId +
= self
::BATCH_SIZE
) {
139 $endId = $startId + self
::BATCH_SIZE
- 1;
140 $title = ts("Upgrade DB to 4.5.beta9: Fix line items for {$label} (%1 => %2)", array(1 => $startId, 2 => $endId));
141 $this->addTask($title, 'task_4_5_0_fixLineItem', $startId, $endId, $label);
148 * (Queue Task Callback)
150 * Function to update the line items
153 * @param CRM_Queue_TaskContext $ctx
154 * @param $startId int, the first/lowest entity ID to convert
155 * @param $endId int, the last/highest entity ID to convert
160 static function task_4_5_0_fixLineItem(CRM_Queue_TaskContext
$ctx, $startId, $endId, $entityTable) {
163 1 => array($startId, 'Integer'),
164 2 => array($endId, 'Integer'),
166 switch ($entityTable) {
168 // update all the line item entity_table and entity_id with contribution due to bug CRM-15055
169 CRM_Core_DAO
::executeQuery("UPDATE civicrm_line_item li
170 INNER JOIN civicrm_contribution cc ON cc.id = li.contribution_id
171 SET entity_id = li.contribution_id, entity_table = 'civicrm_contribution'
172 WHERE li.contribution_id IS NOT NULL AND li.entity_table <> 'civicrm_participant' AND (cc.id BETWEEN %1 AND %2)", $sqlParams);
174 // update the civicrm_line_item.contribution_id
175 CRM_Core_DAO
::executeQuery("UPDATE civicrm_line_item li
176 INNER JOIN civicrm_contribution cc ON cc.id = li.entity_id
177 SET contribution_id = entity_id
178 WHERE li.contribution_id IS NULL AND li.entity_table = 'civicrm_contribution' AND (cc.id BETWEEN %1 AND %2)", $sqlParams);
182 // update the civicrm_line_item.contribution_id
183 CRM_Core_DAO
::executeQuery("UPDATE civicrm_line_item li
184 INNER JOIN civicrm_participant_payment pp ON pp.participant_id = li.entity_id
185 SET li.contribution_id = pp.contribution_id
186 WHERE li.entity_table = 'civicrm_participant' AND li.contribution_id IS NULL AND (pp.id BETWEEN %1 AND %2)", $sqlParams);
190 $upgrade = new CRM_Upgrade_Form();
191 // update the line item of membership
192 CRM_Core_DAO
::executeQuery("UPDATE civicrm_line_item li
193 INNER JOIN civicrm_membership_payment mp ON mp.contribution_id = li.contribution_id
194 INNER JOIN civicrm_membership cm ON mp.membership_id = cm.id
195 INNER JOIN civicrm_price_field_value pv ON pv.id = li.price_field_value_id
196 SET li.entity_table = 'civicrm_membership', li.entity_id = mp.membership_id
197 WHERE li.entity_table = 'civicrm_contribution'
198 AND pv.membership_type_id IS NOT NULL AND cm.membership_type_id = pv.membership_type_id AND (cm.id BETWEEN %1 AND %2)", $sqlParams);
200 CRM_Core_DAO
::executeQuery("UPDATE civicrm_line_item li
201 INNER JOIN civicrm_membership_payment mp ON mp.contribution_id = li.contribution_id
202 INNER JOIN civicrm_price_field_value pv ON pv.id = li.price_field_value_id
203 SET li.entity_table = 'civicrm_membership', li.entity_id = mp.membership_id
204 WHERE li.entity_table = 'civicrm_contribution'
205 AND pv.membership_type_id IS NOT NULL AND (mp.membership_id BETWEEN %1 AND %2)", $sqlParams);
207 CRM_Core_DAO
::executeQuery("INSERT INTO civicrm_line_item (entity_table, entity_id, price_field_id, label,
208 qty, unit_price, line_total, price_field_value_id, financial_type_id)
209 SELECT 'civicrm_membership', cm.id, cpf.id price_field_id, cpfv.label, 1 as qty, cpfv.amount, cpfv.amount line_total,
210 cpfv.id price_field_value_id, cpfv.financial_type_id FROM civicrm_membership cm
211 LEFT JOIN civicrm_membership_payment cmp ON cmp.membership_id = cm.id
212 INNER JOIN civicrm_price_field_value cpfv ON cpfv.membership_type_id = cm.membership_type_id
213 INNER JOIN civicrm_price_field cpf ON cpf.id = cpfv.price_field_id
214 INNER JOIN civicrm_price_set cps ON cps.id = cpf.price_set_id
215 WHERE cmp.contribution_id IS NULL AND cps.name = 'default_membership_type_amount' AND (cm.id BETWEEN %1 AND %2)", $sqlParams);
222 * Add defaults for the newly introduced name fields configuration in 'contact_edit_options' setting
224 * @param CRM_Queue_TaskContext $ctx
226 * @return bool TRUE for success
228 static function addNameFieldOptions(CRM_Queue_TaskContext
$ctx) {
229 $query = "SELECT `value` FROM `civicrm_setting` WHERE `group_name` = 'CiviCRM Preferences' AND `name` = 'contact_edit_options'";
230 $dao = CRM_Core_DAO
::executeQuery($query);
232 $oldValue = unserialize($dao->value
);
234 $newValue = $oldValue . '12\ 114\ 115\ 116\ 117\ 1';
236 $query = "UPDATE `civicrm_setting` SET `value` = %1 WHERE `group_name` = 'CiviCRM Preferences' AND `name` = 'contact_edit_options'";
237 $params = array(1 => array(serialize($newValue), 'String'));
238 CRM_Core_DAO
::executeQuery($query, $params);
244 * Migrate honoree information to uf_join.module_data as honoree columns (text and title) will be dropped
247 * @param CRM_Queue_TaskContext $ctx
249 * @return bool TRUE for success
251 static function migrateHonoreeInfo(CRM_Queue_TaskContext
$ctx) {
252 $query = "ALTER TABLE `civicrm_uf_join`
253 ADD COLUMN `module_data` longtext COMMENT 'Json serialized array of data used by the ufjoin.module'";
254 CRM_Core_DAO
::executeQuery($query);
256 $honorTypes = array_keys(CRM_Core_OptionGroup
::values('honor_type'));
257 $ufGroupDAO = new CRM_Core_DAO_UFGroup();
258 $ufGroupDAO->name
= 'new_individual';
259 $ufGroupDAO->find(TRUE);
261 $query = "SELECT * FROM civicrm_contribution_page";
262 $dao = CRM_Core_DAO
::executeQuery($query);
265 $domain = new CRM_Core_DAO_Domain
;
267 while ($dao->fetch()) {
268 $honorParams = array('soft_credit' => array('soft_credit_types' => $honorTypes));
269 if ($domain->locales
) {
270 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
271 foreach ($locales as $locale) {
272 $honor_block_title = "honor_block_title_{$locale}";
273 $honor_block_text = "honor_block_text_{$locale}";
274 $honorParams['soft_credit'] +
= array(
276 'honor_block_title' => $dao->$honor_block_title,
277 'honor_block_text' => $dao->$honor_block_text,
283 $honorParams['soft_credit'] +
= array(
285 'honor_block_title' => $dao->honor_block_title
,
286 'honor_block_text' => $dao->honor_block_text
,
290 $ufJoinParam = array(
291 'module' => 'soft_credit',
292 'entity_table' => 'civicrm_contribution_page',
293 'is_active' => $dao->honor_block_is_active
,
294 'entity_id' => $dao->id
,
295 'uf_group_id' => $ufGroupDAO->id
,
296 'module_data' => json_encode($honorParams),
298 CRM_Core_BAO_UFJoin
::create($ufJoinParam);
306 * (Queue Task Callback)
308 static function task_4_5_x_runSql(CRM_Queue_TaskContext
$ctx, $rev) {
309 $upgrade = new CRM_Upgrade_Form();
310 $upgrade->processSQL($rev);
316 * Syntactic sugar for adding a task which (a) is in this class and (b) has
319 * After passing the $funcName, you can also pass parameters that will go to
320 * the function. Note that all params must be serializable.
322 protected function addTask($title, $funcName) {
323 $queue = CRM_Queue_Service
::singleton()->load(array(
325 'name' => CRM_Upgrade_Form
::QUEUE_NAME
,
328 $args = func_get_args();
329 $title = array_shift($args);
330 $funcName = array_shift($args);
331 $task = new CRM_Queue_Task(
332 array(get_class($this), $funcName),
336 $queue->createItem($task, array('weight' => -1));