Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-02-06-10-43-01
[civicrm-core.git] / CRM / Upgrade / Incremental / php / FourFive.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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. |
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 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 +--------------------------------------------------------------------+
25 */
26
27 /**
28 *
29 * @package CRM
30 * @copyright CiviCRM LLC (c) 2004-2013
31 * $Id$
32 *
33 */
34 class CRM_Upgrade_Incremental_php_FourFive {
35 const BATCH_SIZE = 5000;
36
37 function verifyPreDBstate(&$errors) {
38 return TRUE;
39 }
40
41 /**
42 * Compute any messages which should be displayed beforeupgrade
43 *
44 * Note: This function is called iteratively for each upcoming
45 * revision to the database.
46 *
47 * @param $postUpgradeMessage string, alterable
48 * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
49 * @return void
50 */
51 function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
52 }
53
54 /**
55 * Compute any messages which should be displayed after upgrade
56 *
57 * @param $postUpgradeMessage string, alterable
58 * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
59 * @return void
60 */
61 function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
62 if ($rev == '4.5.alpha1') {
63 $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>Memberships - Receipt (on-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).');
64 }
65 }
66
67 function upgrade_4_5_alpha1($rev) {
68 // task to process sql
69 $this->addTask(ts('Upgrade DB to 4.5.alpha1: SQL'), 'task_4_5_x_runSql', $rev);
70
71 $this->addTask(ts('Set default for Individual name fields configuration'), 'addNameFieldOptions');
72
73 return TRUE;
74 }
75
76 /**
77 * Add defaults for the newly introduced name fields configuration in 'contact_edit_options' setting
78 *
79 * @return bool TRUE for success
80 */
81 static function addNameFieldOptions(CRM_Queue_TaskContext $ctx) {
82 $query = "SELECT `value` FROM `civicrm_setting` WHERE `group_name` = 'CiviCRM Preferences' AND `name` = 'contact_edit_options'";
83 $dao = CRM_Core_DAO::executeQuery($query);
84 $dao->fetch();
85 $oldValue = unserialize($dao->value);
86
87 $newValue = $oldValue . '12\ 114\ 115\ 116\ 117\ 1';
88
89 $query = "UPDATE `civicrm_setting` SET `value` = %1 WHERE `group_name` = 'CiviCRM Preferences' AND `name` = 'contact_edit_options'";
90 $params = array(1 => array(serialize($newValue), 'String'));
91 CRM_Core_DAO::executeQuery($query, $params);
92
93 return TRUE;
94 }
95
96 /**
97 * (Queue Task Callback)
98 */
99 static function task_4_5_x_runSql(CRM_Queue_TaskContext $ctx, $rev) {
100 $upgrade = new CRM_Upgrade_Form();
101 $upgrade->processSQL($rev);
102
103 return TRUE;
104 }
105
106 /**
107 * Syntatic sugar for adding a task which (a) is in this class and (b) has
108 * a high priority.
109 *
110 * After passing the $funcName, you can also pass parameters that will go to
111 * the function. Note that all params must be serializable.
112 */
113 protected function addTask($title, $funcName) {
114 $queue = CRM_Queue_Service::singleton()->load(array(
115 'type' => 'Sql',
116 'name' => CRM_Upgrade_Form::QUEUE_NAME,
117 ));
118
119 $args = func_get_args();
120 $title = array_shift($args);
121 $funcName = array_shift($args);
122 $task = new CRM_Queue_Task(
123 array(get_class($this), $funcName),
124 $args,
125 $title
126 );
127 $queue->createItem($task, array('weight' => -1));
128 }
129 }