CRM/Upgrade/Incremental/Base.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7.alpha1                                         |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * Base class for incremental upgrades
  30  */
  31 class CRM_Upgrade_Incremental_Base {
  32   const BATCH_SIZE = 5000;
  33
  34   /**
  35    * Verify DB state.
  36    *
  37    * @param $errors
  38    *
  39    * @return bool
  40    */
  41   public function verifyPreDBstate(&$errors) {
  42     return TRUE;
  43   }
  44
  45   /**
  46    * Compute any messages which should be displayed before upgrade.
  47    *
  48    * Note: This function is called iteratively for each upcoming
  49    * revision to the database.
  50    *
  51    * @param $preUpgradeMessage
  52    * @param string $rev
  53    *   a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
  54    * @param null $currentVer
  55    */
  56   public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
  57   }
  58
  59   /**
  60    * Compute any messages which should be displayed after upgrade.
  61    *
  62    * @param string $postUpgradeMessage
  63    *   alterable.
  64    * @param string $rev
  65    *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
  66    */
  67   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  68   }
  69
  70   /**
  71    * (Queue Task Callback)
  72    *
  73    * @param \CRM_Queue_TaskContext $ctx
  74    * @param string $rev
  75    *
  76    * @return bool
  77    */
  78   public static function runSql(CRM_Queue_TaskContext $ctx, $rev) {
  79     $upgrade = new CRM_Upgrade_Form();
  80     $upgrade->processSQL($rev);
  81
  82     return TRUE;
  83   }
  84
  85   /**
  86    * Syntactic sugar for adding a task.
  87    *
  88    * Task is (a) in this class and (b) has a high priority.
  89    *
  90    * After passing the $funcName, you can also pass parameters that will go to
  91    * the function. Note that all params must be serializable.
  92    *
  93    * @param string $title
  94    * @param string $funcName
  95    */
  96   protected function addTask($title, $funcName) {
  97     $queue = CRM_Queue_Service::singleton()->load(array(
  98       'type' => 'Sql',
  99       'name' => CRM_Upgrade_Form::QUEUE_NAME,
 100     ));
 101
 102     $args = func_get_args();
 103     $title = array_shift($args);
 104     $funcName = array_shift($args);
 105     $task = new CRM_Queue_Task(
 106       array(get_class($this), $funcName),
 107       $args,
 108       $title
 109     );
 110     $queue->createItem($task, array('weight' => -1));
 111   }
 112
 113   /**
 114    * Remove a payment processor if not in use
 115    *
 116    * @param CRM_Queue_TaskContext $ctx
 117    * @param string $name
 118    * @return bool
 119    * @throws \CiviCRM_API3_Exception
 120    */
 121   public static function removePaymentProcessorType(CRM_Queue_TaskContext $ctx, $name) {
 122     $processors = civicrm_api3('PaymentProcessor', 'getcount', array('payment_processor_type_id' => $name));
 123     if (empty($processors['result'])) {
 124       $result = civicrm_api3('PaymentProcessorType', 'get', array(
 125         'name' => $name,
 126         'return' => 'id',
 127       ));
 128       if (!empty($result['id'])) {
 129         civicrm_api3('PaymentProcessorType', 'delete', array('id' => $result['id']));
 130       }
 131     }
 132     return TRUE;
 133   }
 134
 135   /**
 136    * Add a column to a table if it doesn't already exist
 137    *
 138    * @param CRM_Queue_TaskContext $ctx
 139    * @param string $table
 140    * @param string $column
 141    * @param string $properties
 142    * @return bool
 143    */
 144   public static function addColumn($ctx, $table, $column, $properties) {
 145     if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, $column)) {
 146       CRM_Core_DAO::executeQuery("ALTER TABLE `$table` ADD COLUMN `$column` $properties",
 147         array(), TRUE, NULL, FALSE, FALSE);
 148     }
 149     return TRUE;
 150   }
 151
 152   /**
 153    * Drop a column from a table if it exist.
 154    *
 155    * @param CRM_Queue_TaskContext $ctx
 156    * @param string $table
 157    * @param string $column
 158    * @return bool
 159    */
 160   public static function dropColumn($ctx, $table, $column) {
 161     if (CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, $column)) {
 162       CRM_Core_DAO::executeQuery("ALTER TABLE `$table` DROP COLUMN `$column`",
 163         array(), TRUE, NULL, FALSE, FALSE);
 164     }
 165     return TRUE;
 166   }
 167
 168 }