CRM/Upgrade/Incremental/php/FiveThirtyOne.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Upgrade logic for FiveThirtyOne */
  14 class CRM_Upgrade_Incremental_php_FiveThirtyOne extends CRM_Upgrade_Incremental_Base {
  15
  16   /**
  17    * Compute any messages which should be displayed beforeupgrade.
  18    *
  19    * Note: This function is called iteratively for each upcoming
  20    * revision to the database.
  21    *
  22    * @param string $preUpgradeMessage
  23    * @param string $rev
  24    *   a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
  25    * @param null $currentVer
  26    */
  27   public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
  28     // Example: Generate a pre-upgrade message.
  29     // if ($rev == '5.12.34') {
  30     //   $preUpgradeMessage .= '<p>' . ts('A new permission, "%1", has been added. This permission is now used to control access to the Manage Tags screen.', array(1 => ts('manage tags'))) . '</p>';
  31     // }
  32   }
  33
  34   /**
  35    * Compute any messages which should be displayed after upgrade.
  36    *
  37    * @param string $postUpgradeMessage
  38    *   alterable.
  39    * @param string $rev
  40    *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
  41    */
  42   public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  43     // Example: Generate a post-upgrade message.
  44     // if ($rev == '5.12.34') {
  45     //   $postUpgradeMessage .= '<br /><br />' . ts("By default, CiviCRM now disables the ability to import directly from SQL. To use this feature, you must explicitly grant permission 'import SQL datasource'.");
  46     // }
  47   }
  48
  49   /*
  50    * Important! All upgrade functions MUST add a 'runSql' task.
  51    * Uncomment and use the following template for a new upgrade version
  52    * (change the x in the function name):
  53    */
  54
  55   //  /**
  56   //   * Upgrade function.
  57   //   *
  58   //   * @param string $rev
  59   //   */
  60   //  public function upgrade_5_0_x($rev) {
  61   //    $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
  62   //    $this->addTask('Do the foo change', 'taskFoo', ...);
  63   //    // Additional tasks here...
  64   //    // Note: do not use ts() in the addTask description because it adds unnecessary strings to transifex.
  65   //    // The above is an exception because 'Upgrade DB to %1: SQL' is generic & reusable.
  66   //  }
  67
  68   /**
  69    * Upgrade function.
  70    *
  71    * @param string $rev
  72    */
  73   public function upgrade_5_31_alpha1($rev) {
  74     $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
  75     $this->addTask('Remove Eway Single Currency Payment Processor type if not used or install the new extension for it', 'enableEwaySingleExtension');
  76     $this->addTask('dev/core#1486 Remove FKs from ACL Cache tables', 'removeFKsFromACLCacheTables');
  77   }
  78
  79   public static function enableEwaySingleExtension(CRM_Queue_TaskContext $ctx) {
  80     $eWAYPaymentProcessorType = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_payment_processor_type WHERE class_name = 'Payment_eWAY'");
  81     if ($eWAYPaymentProcessorType) {
  82       $ewayPaymentProcessorCount = CRM_Core_DAO::singleValueQuery("SELECT count(id) FROM civicrm_payment_processor WHERE payment_processor_type_id = %1", [1 => [$eWAYPaymentProcessorType, 'Positive']]);
  83       if ($ewayPaymentProcessorCount) {
  84         $insert = CRM_Utils_SQL_Insert::into('civicrm_extension')->row([
  85           'type' => 'module',
  86           'full_name' => 'ewaysingle',
  87           'name' => 'eway Single currency extension',
  88           'label' => 'eway Single currency extension',
  89           'file' => 'ewaysingle',
  90           'schema_version' => NULL,
  91           'is_active' => 1,
  92         ]);
  93         CRM_Core_DAO::executeQuery($insert->usingReplace()->toSQL());
  94         $managedEntity = CRM_Utils_SQL_Insert::into('civicrm_managed')->row([
  95           'name' => 'eWAY',
  96           'module' => 'ewaysingle',
  97           'entity_type' => 'PaymentProcessorType',
  98           'entity_id' => $eWAYPaymentProcessorType,
  99           'cleanup' => NULL,
 100         ]);
 101         CRM_Core_DAO::executeQuery($managedEntity->usingReplace()->toSQL());
 102       }
 103       else {
 104         CRM_Core_DAO::executeQuery("DELETE FROM civicrm_payment_processor_type WHERE id = %1", [1 => [$eWAYPaymentProcessorType, 'Positive']]);
 105       }
 106     }
 107     return TRUE;
 108   }
 109
 110   public static function removeFKsFromACLCacheTables(CRM_Queue_TaskContext $ctx) {
 111     CRM_Core_BAO_SchemaHandler::safeRemoveFK('civicrm_acl_contact_cache', 'FK_civicrm_acl_contact_cache_contact_id');
 112     CRM_Core_BAO_SchemaHandler::safeRemoveFK('civicrm_acl_cache', 'FK_civicrm_acl_cache_contact_id');
 113     CRM_Core_BAO_SchemaHandler::createIndexes(['civicrm_acl_cache' => ['contact_id']]);
 114     return TRUE;
 115   }
 116
 117 }