CRM/Core/Payment/MJWIPNTrait.php

@@ -9,6 +9,9 @@
  +--------------------------------------------------------------------+
  */
 
+use Civi\Api4\Contribution;
+use Civi\Payment\Exception\PaymentProcessorException;
+
 /**
  * Shared payment IPN functions that should one day be migrated to CiviCRM core
  *
@@ -24,7 +27,7 @@ trait CRM_Core_Payment_MJWIPNTrait {
   /**
    * Do we send an email receipt for each contribution?
    *
-   * @var int
+   * @var int|null
    */
   protected $is_email_receipt = NULL;
 
@@ -34,6 +37,12 @@ trait CRM_Core_Payment_MJWIPNTrait {
    */
   protected $contribution_recur_id = NULL;
 
+  /**
+   * The recurring contribution detail (as retrieved by API4)
+   * @var array
+   */
+  protected $contributionRecur = [];
+
   /**
    *  The IPN event type
    * @var string
@@ -69,65 +78,39 @@ trait CRM_Core_Payment_MJWIPNTrait {
   protected $data;
 
   /**
-   * Set the value of is_email_receipt to use when a new contribution is received for a recurring contribution
-   * If not set, we respect the value set on the ContributionRecur entity.
    *
-   * @param int $sendReceipt The value of is_email_receipt
+   * Set the value of is_email_receipt to use when a new contribution is
+   * received for a recurring contribution. If set to NULL, we use CiviCRM core
+   * logic to determine if a receipt should be sent (typically the recurring
+   * contribution setting).
+   *
+   * @param int|null|bool $sendReceipt The value of is_email_receipt
    */
   public function setSendEmailReceipt($sendReceipt) {
-    switch ($sendReceipt) {
-      case 0:
-        $this->is_email_receipt = 0;
-        break;
-
-      case 1:
-        $this->is_email_receipt = 1;
-        break;
-
-      default:
-        $this->is_email_receipt = 0;
+    if (is_null($sendReceipt)) {
+      // Let CiviCRM core decide whether to send a receipt.
+      $this->is_email_receipt = NULL;
+    }
+    elseif ($sendReceipt) {
+      // Explicitly turn on receipts.
+      $this->is_email_receipt = 1;
+    }
+    else {
+      // Explicitly turn off receipts.
+      $this->is_email_receipt = 0;
     }
   }
 
   /**
    * Get the value of is_email_receipt to use when a new contribution is received.
-   * If not set, we respect the value set on the ContributionRecur entity (for recurring contributions)
-   * or the value set on the ContributionPage entity (for non-recurring contributions).
+   * If NULL we let CiviCRM core decide whether to send a receipt.
    *
-   * @param int $contributionID
+   * See setSendEmalReceipt() for more details.
    *
-   * @return int
-   * @throws \CiviCRM_API3_Exception
+   * @return int|null
    */
-  public function getSendEmailReceipt(int $contributionID) {
-    if (isset($this->is_email_receipt)) {
-      return (int) $this->is_email_receipt;
-    }
-    if (!empty($this->contribution_recur_id)) {
-      try {
-        $this->is_email_receipt = civicrm_api3('ContributionRecur', 'getvalue', [
-          'return' => "is_email_receipt",
-          'id' => $this->contribution_recur_id,
-        ]);
-      }
-      catch (Exception $e) {
-        $this->is_email_receipt = 0;
-      }
-    }
-    // Non-recurring contribution.
-    else {
-      try {
-        $this->is_email_receipt = \Civi\Api4\Contribution::get(FALSE)
-          ->addSelect('contribution_page.is_email_receipt')
-          ->addWhere('id', '=', $contributionID)
-          ->execute()
-          ->first()['contribution_page.is_email_receipt'] ?? 0;
-      }
-      catch (Exception $e) {
-        $this->is_email_receipt = 0;
-      }
-    }
-    return (int) $this->is_email_receipt;
+  public function getSendEmailReceipt() {
+    return $this->is_email_receipt;
   }
 
   /**
@@ -152,6 +135,22 @@ trait CRM_Core_Payment_MJWIPNTrait {
     return $this->_paymentProcessor;
   }
 
+  /**
+   * @param int $recurID
+   *
+   * @return void
+   */
+  public function setContributionRecurID(int $recurID) {
+    $this->contribution_recur_id = $recurID;
+  }
+
+  /**
+   * @return int|null
+   */
+  public function getContributionRecurID() {
+    return $this->contribution_recur_id;
+  }
+
   /**
    * @param bool $verify
    */
@@ -236,7 +235,7 @@ trait CRM_Core_Payment_MJWIPNTrait {
    * Cancel a subscription (recurring contribution)
    * @param array $params
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   protected function updateRecurCancelled($params) {
@@ -248,7 +247,7 @@ trait CRM_Core_Payment_MJWIPNTrait {
    * Update the subscription (recurring contribution) to a successful status
    * @param array $params
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   private function updateRecurSuccess($params) {
@@ -264,21 +263,23 @@ trait CRM_Core_Payment_MJWIPNTrait {
    * Update the subscription (recurring contribution) to a completed status
    * @param array $params
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   private function updateRecurCompleted($params) {
     $this->checkRequiredParams('updateRecurCompleted', ['id'], $params);
-    $params['contribution_status_id'] = 'Completed';
 
-    civicrm_api3('ContributionRecur', 'create', $params);
+    \Civi\Api4\ContributionRecur::update(FALSE)
+      ->addWhere('id', '=', $params['id'])
+      ->addValue('contribution_status_id:name', 'Completed')
+      ->execute();
   }
 
   /**
    * Update the subscription (recurring contribution) to a failing status
    * @param array $params
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   private function updateRecurFailed($params) {
@@ -300,13 +301,13 @@ trait CRM_Core_Payment_MJWIPNTrait {
   /**
    * Repeat a contribution (call the Contribution.repeattransaction API)
    *
-   * @param array $params
+   * @param array $repeatContributionParams
    *
-   * @return bool
-   * @throws \CiviCRM_API3_Exception
+   * @return int The new Contribution ID
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
-  private function repeatContribution($params) {
+  private function repeatContribution(array $repeatContributionParams): int {
     $this->checkRequiredParams(
       'repeatContribution',
       [
@@ -318,14 +319,14 @@ trait CRM_Core_Payment_MJWIPNTrait {
         'trxn_id',
         //'total_amount',
       ],
-      $params
+      $repeatContributionParams
     );
     // Optional Params: fee_amount
 
     // Creat contributionParams for Contribution.repeattransaction and set some values
-    $contributionParams = $params;
+    $contributionParams = $repeatContributionParams;
     // Status should be pending if we have a successful payment
-    switch ($params['contribution_status_id']) {
+    switch ($contributionParams['contribution_status_id']) {
       case CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'):
         // Create a contribution in Pending state using Contribution.repeattransaction and then complete using Payment.create
         $contributionParams['contribution_status_id'] = 'Pending';
@@ -335,52 +336,59 @@ trait CRM_Core_Payment_MJWIPNTrait {
       default:
         // Failed etc.
         // For any other status create it directly using Contribution.repeattransaction and don't create a payment
-        $contributionParams['contribution_status_id'] = $params['contribution_status_id'];
         $createPayment = FALSE;
     }
 
     // Create the new contribution
-    $contributionParams['trxn_id'] = $params['order_reference'];
+    $contributionParams['trxn_id'] = $repeatContributionParams['order_reference'];
     // We send a receipt when adding a payment, not now
     $contributionParams['is_email_receipt'] = FALSE;
     try {
       $contribution = reset(civicrm_api3('Contribution', 'repeattransaction', $contributionParams)['values']);
     }
     catch (Exception $e) {
-      \Civi::log()->error('MJWIPNTrait call to repeattransaction failed: ' . $e->getMessage() . '; params: ' . print_r($contributionParams, TRUE));
-      return FALSE;
+      // We catch, log, throw again so we have debug details in the logs
+      $message = 'MJWIPNTrait call to repeattransaction failed: ' . $e->getMessage() . '; params: ' . print_r($contributionParams, TRUE);
+      \Civi::log()->error($message);
+      throw new PaymentProcessorException($message);
     }
 
     // Get total amount from contribution returned by repeatTransaction (Which came from the recur template Contribution)
-    $params['total_amount'] = $params['total_amount'] ?? $contribution['total_amount'];
+    $repeatContributionParams['total_amount'] = $repeatContributionParams['total_amount'] ?? $contribution['total_amount'];
 
     if ($createPayment) {
-      $paymentParamsKeys = [
+      // Start by passing through all params (we may pass in customdata as well in API4 format)
+      $paymentParams = $repeatContributionParams;
+      // Now map contribution keys to payment keys
+      $paymentParamsMap = [
         'receive_date' => 'trxn_date',
         'order_reference' => 'order_reference',
         'trxn_id' => 'trxn_id',
         'total_amount' => 'total_amount',
         'fee_amount' => 'fee_amount',
       ];
-      foreach ($paymentParamsKeys as $contributionKey => $paymentKey) {
-        if (isset($params[$contributionKey])) {
-          $paymentParams[$paymentKey] = $params[$contributionKey];
+      foreach ($paymentParamsMap as $contributionKey => $paymentKey) {
+        if (isset($contributionParams[$contributionKey])) {
+          unset($paymentParams[$contributionKey]);
+          $paymentParams[$paymentKey] = $contributionParams[$contributionKey];
         }
       }
       $paymentParams['contribution_id'] = $contribution['id'];
-      $paymentParams['payment_processor_id'] = $this->_paymentProcessor->getID();
-      $paymentParams['is_send_contribution_notification'] = $this->getSendEmailReceipt($paymentParams['contribution_id']);
+      $paymentParams['payment_processor_id'] = $this->getPaymentProcessor()->getID();
+      $paymentParams['is_send_contribution_notification'] = $this->getSendEmailReceipt();
       $paymentParams['skipCleanMoney'] = TRUE;
       civicrm_api3('Mjwpayment', 'create_payment', $paymentParams);
     }
-    return TRUE;
+    return $contribution['id'];
   }
 
   /**
    * @param array $params
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
+   *
+   * @deprecated Was used in Stripe until 6.11
    */
   private function updateContribution($params) {
     $this->checkRequiredParams('updateContribution', ['contribution_id'], $params);
@@ -396,15 +404,18 @@ trait CRM_Core_Payment_MJWIPNTrait {
   /**
    * Complete a pending contribution and update associated entities (recur/membership)
    *
-   * @param array $params
+   * @param array $contributionParams
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
-  private function updateContributionCompleted($params) {
-    $this->checkRequiredParams('updateContributionCompleted', ['contribution_id', 'trxn_date', 'order_reference', 'trxn_id', 'total_amount'], $params);
+  private function updateContributionCompleted(array $contributionParams) {
+    $this->checkRequiredParams('updateContributionCompleted', ['contribution_id', 'trxn_date', 'order_reference', 'trxn_id', 'total_amount'], $contributionParams);
 
-    $paymentParamsKeys = [
+    // Start by passing through all params (we may pass in customdata as well in API4 format)
+    $paymentParams = $contributionParams;
+    // Now map contribution keys to payment keys
+    $paymentParamsMap = [
       'contribution_id' => 'contribution_id',
       'trxn_date' => 'trxn_date',
       'order_reference' => 'order_reference',
@@ -412,9 +423,10 @@ trait CRM_Core_Payment_MJWIPNTrait {
       'total_amount' => 'total_amount',
       'fee_amount' => 'fee_amount',
     ];
-    foreach ($paymentParamsKeys as $contributionKey => $paymentKey) {
-      if (isset($params[$contributionKey])) {
-        $paymentParams[$paymentKey] = $params[$contributionKey];
+    foreach ($paymentParamsMap as $contributionKey => $paymentKey) {
+      if (isset($contributionParams[$contributionKey])) {
+        unset($paymentParams[$contributionKey]);
+        $paymentParams[$paymentKey] = $contributionParams[$contributionKey];
       }
     }
 
@@ -425,17 +437,17 @@ trait CRM_Core_Payment_MJWIPNTrait {
     // Also set cancel_date to NULL because we are setting it for failed payments and UI will still display "greyed
     // out" if it is set.
     $failedContributionStatus = (int) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Failed');
-    if (isset($params['contribution_status_id']) && ((int) $params['contribution_status_id'] === $failedContributionStatus)) {
+    if (isset($contributionParams['contribution_status_id']) && ((int) $contributionParams['contribution_status_id'] === $failedContributionStatus)) {
       $sql = "UPDATE civicrm_contribution SET contribution_status_id=%1,cancel_date=NULL WHERE id=%2";
       $queryParams = [
         1 => [CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending'), 'Positive'],
-        2 => [$params['contribution_id'], 'Positive'],
+        2 => [$contributionParams['contribution_id'], 'Positive'],
       ];
       CRM_Core_DAO::executeQuery($sql, $queryParams);
     }
-    $paymentParams['is_send_contribution_notification'] = $this->getSendEmailReceipt($paymentParams['contribution_id']);
+    $paymentParams['is_send_contribution_notification'] = $this->getSendEmailReceipt();
     $paymentParams['skipCleanMoney'] = TRUE;
-    $paymentParams['payment_processor_id'] = $this->_paymentProcessor->getID();
+    $paymentParams['payment_processor_id'] = $this->getPaymentProcessor()->getID();
     civicrm_api3('Mjwpayment', 'create_payment', $paymentParams);
   }
 
@@ -444,18 +456,18 @@ trait CRM_Core_Payment_MJWIPNTrait {
    *
    * @param array $params ['contribution_id', 'order_reference'{, cancel_date, cancel_reason}]
    *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   private function updateContributionFailed($params) {
     $this->checkRequiredParams('updateContributionFailed', ['contribution_id', 'order_reference'], $params);
-    civicrm_api3('Contribution', 'create', [
-      'contribution_status_id' => 'Failed',
-      'id' => $params['contribution_id'],
-      'trxn_id' => $params['order_reference'],
-      'cancel_date' => $params['cancel_date'] ?? NULL,
-      'cancel_reason' => $params['cancel_reason'] ?? NULL,
-    ]);
+    Contribution::update(FALSE)
+      ->addValue('contribution_status_id:name', 'Failed')
+      ->addValue('trxn_id', $params['order_reference'])
+      ->addValue('cancel_date', $params['cancel_date'] ?? '')
+      ->addValue('cancel_reason', $params['cancel_reason'] ?? '')
+      ->addWhere('id', '=', $params['contribution_id'])
+      ->execute();
     // No financial_trxn is created so we don't need to update that.
   }
 
@@ -500,30 +512,25 @@ trait CRM_Core_Payment_MJWIPNTrait {
    * @param array $params
    *
    * @throws \CRM_Core_Exception
-   * @throws \CiviCRM_API3_Exception
    */
   protected function updateContributionRefund($params) {
     $this->checkRequiredParams('updateContributionRefund', ['contribution_id', 'total_amount'], $params);
-    $params['payment_processor_id'] = $this->_paymentProcessor->getID();
-    civicrm_api3('Mjwpayment', 'create_payment', $params);
-
-    // https://github.com/civicrm/civicrm-core/pull/18930
-    // Set contribution status to refunded even if cancelled_payment_id is set
-    if (version_compare(CRM_Utils_System::version(), '5.32', '<')) {
-      if ($params['total_amount'] < 0 && !empty($params['cancelled_payment_id'])) {
-        $contribution = civicrm_api3('Contribution', 'getsingle', ['id' => $params['contribution_id']]);
-        $contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution['contribution_status_id']);
-
-        if ($contributionStatus === 'Completed' && ((float) CRM_Core_BAO_FinancialTrxn::getTotalPayments($params['contribution_id'], TRUE) === 0.0)) {
-          // If the contribution has previously been completed (fully paid) and now has total payments adding up to 0
-          //  change status to refunded.
-          $this->updateContribution([
-            'contribution_id' => $params['contribution_id'],
-            'contribution_status_id' => 'Refunded',
-          ]);
-        }
-      }
+    $params['payment_processor_id'] = $this->getPaymentProcessor()->getID();
+
+    $lock = Civi::lockManager()->acquire('data.contribute.contribution.' . $params['contribution_id']);
+    if (!$lock->isAcquired()) {
+      throw new PaymentProcessorException('Could not acquire lock to record refund for contribution: ' . $params['contribution_id']);
+    }
+    // Check if it was already recorded (in case two processes are running the same time - eg. Refund UI + IPN processing).
+    $refundPayment = civicrm_api3('Payment', 'get', [
+      'contribution_id' => $params['contribution_id'],
+      'total_amount' => $params['total_amount'],
+      'trxn_id' => $params['trxn_id'] ?? NULL,
+    ]);
+    if (empty($refundPayment['count'])) {
+      civicrm_api3('Mjwpayment', 'create_payment', $params);
     }
+    $lock->release();
   }
 
   /**
@@ -545,14 +552,14 @@ trait CRM_Core_Payment_MJWIPNTrait {
    * @throws \Civi\Payment\Exception\PaymentProcessorException
    */
   protected function exception($message) {
-    $label = method_exists($this->_paymentProcessor, 'getPaymentProcessorLabel') ? $this->_paymentProcessor->getPaymentProcessorLabel() : __CLASS__;
+    $label = method_exists($this->getPaymentProcessor(), 'getPaymentProcessorLabel') ? $this->getPaymentProcessor()->getPaymentProcessorLabel() : __CLASS__;
     $errorMessage = $label . ' Exception: Event: ' . $this->eventType . ' Error: ' . $message;
     Civi::log()->error($errorMessage);
     if ($this->exitOnException) {
       http_response_code(400);
       exit(1);
     } else {
-      Throw new \Civi\Payment\Exception\PaymentProcessorException($message);
+      Throw new PaymentProcessorException($message);
     }
   }
 

CRM/Mjwshared/Check.php

@@ -16,24 +16,102 @@ use CRM_Mjwshared_ExtensionUtil as E;
  */
 class CRM_Mjwshared_Check {
 
-  public static function checkRequirements(&$messages) {
-    self::checkExtensionWorldpay($messages);
-    self::checkExtensionMinifier($messages);
-    self::checkExtensionContributiontransactlegacy($messages);
-  }
+  const MIN_VERSION_SWEETALERT = '1.5';
+
+  /**
+   * @var array
+   */
+  private array $messages;
 
   /**
+   * CRM_Mjwshared_Check constructor.
+   *
    * @param array $messages
    *
-   * @throws \CiviCRM_API3_Exception
    */
-  private static function checkExtensionWorldpay(&$messages) {
+  public function __construct($messages) {
+    $this->messages = $messages;
+  }
+
+  /**
+   * @return array
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  public function checkRequirements() {
+    $this->checkExtensionWorldpay();
+    // $this->checkExtensionMinifier();
+    $this->checkExtensionContributiontransactlegacy();
+    $this->checkIfSeparateMembershipPaymentEnabled();
+    $this->checkExtensionSweetalert();
+    $this->checkMultidomainJobs();
+    $this->checkPaymentprocessorWebhooks();
+    return $this->messages;
+  }
+
+  /**
+   * @param string $extensionName
+   * @param string $minVersion
+   * @param string $actualVersion
+   */
+  private function requireExtensionMinVersion(string $extensionName, string $minVersion, string $actualVersion) {
+    $actualVersionModified = $actualVersion;
+    if (substr($actualVersion, -4) === '-dev') {
+      $actualVersionModified = substr($actualVersion, 0, -4);
+      $devMessageAlreadyDefined = FALSE;
+      foreach ($this->messages as $message) {
+        if ($message->getName() === __FUNCTION__ . $extensionName . '_requirements_dev') {
+          // Another extension already generated the "Development version" message for this extension
+          $devMessageAlreadyDefined = TRUE;
+        }
+      }
+      if (!$devMessageAlreadyDefined) {
+        $message = new \CRM_Utils_Check_Message(
+          __FUNCTION__ . $extensionName . '_requirements_dev',
+          E::ts('You are using a development version of %1 extension.',
+            [1 => $extensionName]),
+          E::ts('%1: Development version', [1 => $extensionName]),
+          \Psr\Log\LogLevel::WARNING,
+          'fa-code'
+        );
+        $this->messages[] = $message;
+      }
+    }
+
+    if (version_compare($actualVersionModified, $minVersion) === -1) {
+      $message = new \CRM_Utils_Check_Message(
+        __FUNCTION__ . $extensionName . E::SHORT_NAME . '_requirements',
+        E::ts('The %1 extension requires the %2 extension version %3 or greater but your system has version %4.',
+          [
+            1 => ucfirst(E::SHORT_NAME),
+            2 => $extensionName,
+            3 => $minVersion,
+            4 => $actualVersion
+          ]),
+        E::ts('%1: Missing Requirements', [1 => ucfirst(E::SHORT_NAME)]),
+        \Psr\Log\LogLevel::ERROR,
+        'fa-exclamation-triangle'
+      );
+      $message->addAction(
+        E::ts('Upgrade now'),
+        NULL,
+        'href',
+        ['path' => 'civicrm/admin/extensions', 'query' => ['action' => 'update', 'id' => $extensionName, 'key' => $extensionName]]
+      );
+      $this->messages[] = $message;
+    }
+  }
+
+  /**
+   * @throws \CRM_Core_Exception
+   */
+  private function checkExtensionWorldpay() {
     $extensions = civicrm_api3('Extension', 'get', [
       'full_name' => 'uk.co.nfpservice.onlineworldpay',
     ]);
 
     if (!empty($extensions['id']) && ($extensions['values'][$extensions['id']]['status'] === 'installed')) {
-      $messages[] = new CRM_Utils_Check_Message(
+      $this->messages[] = new CRM_Utils_Check_Message(
         __FUNCTION__ . 'mjwshared_incompatible',
         E::ts('You have the uk.co.nfpservice.onlineworldpay extension installed.
         There are multiple versions of this extension on various sites and the source code has not been released.
@@ -46,17 +124,15 @@ class CRM_Mjwshared_Check {
   }
 
   /**
-   * @param array $messages
-   *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    */
-  private static function checkExtensionMinifier(&$messages) {
+  private function checkExtensionMinifier() {
     $extensionName = 'minifier';
     $extensions = civicrm_api3('Extension', 'get', [
       'full_name' => $extensionName,
     ]);
 
-    if (empty($extensions['id']) || ($extensions['values'][$extensions['id']]['status'] !== 'installed')) {
+    if (empty($extensions['count']) || ($extensions['values'][$extensions['id']]['status'] !== 'installed')) {
       $message = new CRM_Utils_Check_Message(
         __FUNCTION__ . 'mjwshared_recommended',
         E::ts('It is recommended that you download and install the <strong><a href="https://civicrm.org/extensions/minifier">minifier</a></strong> extension.
@@ -71,19 +147,17 @@ class CRM_Mjwshared_Check {
         'href',
         ['path' => 'civicrm/admin/extensions', 'query' => ['action' => 'update', 'id' => $extensionName, 'key' => $extensionName]]
       );
-      $messages[] = $message;
+      $this->messages[] = $message;
     }
   }
 
   /**
-   * @param array $messages
-   *
-   * @throws \CiviCRM_API3_Exception
+   * @throws \CRM_Core_Exception
    */
-  private static function checkExtensionContributiontransactlegacy(&$messages) {
+  private function checkExtensionContributiontransactlegacy() {
     $extensionName = 'contributiontransactlegacy';
-    // Only on Drupal - do we have webform_civicrm installed?
-    if (function_exists('module_exists')) {
+    // Only on Drupal 7 (webform_civicrm 7.x-5.x) - do we have webform_civicrm installed?
+    if (function_exists('module_exists') && CRM_Core_Config::singleton()->userFramework === 'Drupal') {
       $extensions = civicrm_api3('Extension', 'get', [
         'full_name' => $extensionName,
       ]);
@@ -104,11 +178,183 @@ class CRM_Mjwshared_Check {
           'href',
           ['path' => 'civicrm/admin/extensions', 'query' => ['action' => 'update', 'id' => $extensionName, 'key' => $extensionName]]
         );
-        $messages[] = $message;
+        $this->messages[] = $message;
       }
     }
   }
 
+  /**
+   * We don't support "Separate Membership Payment" configuration
+   *
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  private function checkIfSeparateMembershipPaymentEnabled() {
+    $separateMembershipPaymentNotSupportedProcessors = ['Stripe', 'Globalpayments'];
+    $membershipBlocks = civicrm_api3('MembershipBlock', 'get', [
+      'is_separate_payment' => 1,
+      'is_active' => 1,
+    ]);
+    if ($membershipBlocks['count'] > 0) {
+      $contributionPagesToCheck = [];
+      foreach ($membershipBlocks['values'] as $blockDetails) {
+        if ($blockDetails['entity_table'] !== 'civicrm_contribution_page') {
+          continue;
+        }
+        $contributionPagesToCheck[] = $blockDetails['entity_id'];
+      }
+      $paymentProcessorIDs = \Civi\Api4\PaymentProcessor::get(FALSE)
+        ->addJoin('PaymentProcessorType AS payment_processor_type', 'INNER', ['payment_processor_type_id', '=', 'payment_processor_type.id'])
+        ->addWhere('payment_processor_type.name', 'IN', $separateMembershipPaymentNotSupportedProcessors)
+        ->execute()
+        ->column('id');
+
+      if (!empty($contributionPagesToCheck)) {
+        $contributionPages = civicrm_api3('ContributionPage', 'get', [
+          'return' => ['payment_processor'],
+          'id' => ['IN' => $contributionPagesToCheck],
+          'is_active' => 1,
+        ]);
+        foreach ($contributionPages['values'] as $contributionPage) {
+          $enabledPaymentProcessors = is_array($contributionPage['payment_processor'])
+              ? $contributionPage['payment_processor'] : explode(CRM_Core_DAO::VALUE_SEPARATOR, $contributionPage['payment_processor']);
+          foreach ($enabledPaymentProcessors as $enabledID) {
+            if (in_array($enabledID, $paymentProcessorIDs)) {
+              $message = new CRM_Utils_Check_Message(
+                __FUNCTION__ . 'mjwshared_requirements',
+                E::ts('You need to disable "Separate Membership Payment" or disable the payment processors: %2 on contribution page %1 because it is not supported and will not work.
+                See <a href="https://lab.civicrm.org/extensions/stripe/-/issues/134">Stripe#134</a>.',
+                  [
+                    1 => $contributionPage['id'],
+                    2 => implode(', ', $separateMembershipPaymentNotSupportedProcessors),
+                  ]),
+                E::ts('Payments: Invalid configuration'),
+                \Psr\Log\LogLevel::ERROR,
+                'fa-money'
+              );
+              $this->messages[] = $message;
+              return;
+            }
+          }
+        }
+      }
+    }
+  }
 
+  /**
+   * @throws \CRM_Core_Exception
+   */
+  private function checkExtensionSweetalert() {
+    // sweetalert: recommended. If installed requires min version
+    $extensionName = 'sweetalert';
+    $extensions = civicrm_api3('Extension', 'get', [
+      'full_name' => $extensionName,
+    ]);
+
+    if (empty($extensions['count']) || ($extensions['values'][$extensions['id']]['status'] !== 'installed')) {
+      $message = new CRM_Utils_Check_Message(
+        __FUNCTION__ . 'mjwshared_recommended',
+        E::ts('It is recommended that you install the <strong><a href="https://civicrm.org/extensions/sweetalert">sweetalert</a></strong> extension.
+        This allows extensions such as Stripe to show useful messages to the user when processing payment.
+        If this is not installed it will fallback to the browser "alert" message but you will
+        not see some messages (such as <em>we are pre-authorizing your card</em> and <em>please wait</em>) and the feedback to the user will not be as helpful.'),
+        E::ts('Recommended Extension: sweetalert'),
+        \Psr\Log\LogLevel::NOTICE,
+        'fa-lightbulb-o'
+      );
+      $message->addAction(
+        E::ts('Install now'),
+        NULL,
+        'href',
+        ['path' => 'civicrm/admin/extensions', 'query' => ['action' => 'update', 'id' => $extensionName, 'key' => $extensionName]]
+      );
+      $this->messages[] = $message;
+      return;
+    }
+    if (isset($extensions['id']) && $extensions['values'][$extensions['id']]['status'] === 'installed') {
+      $this->requireExtensionMinVersion($extensionName, self::MIN_VERSION_SWEETALERT, $extensions['values'][$extensions['id']]['version']);
+    }
+  }
+
+  /**
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  private function checkMultidomainJobs() {
+    $domains = \Civi\Api4\Domain::get(FALSE)
+      ->execute();
+    if ($domains->count() <= 1) {
+      return;
+    }
+
+    $jobs = civicrm_api3('Job', 'get', [
+      'api_action' => "process_paymentprocessor_webhooks",
+      'api_entity' => "job",
+    ])['values'];
+
+    $domainMissingJob = [];
+    foreach ($domains as $domain) {
+      foreach ($jobs as $job) {
+        if ((int) $job['domain_id'] === $domain['id']) {
+          // We found a job for this domain.
+          continue 2;
+        }
+      }
+      $domainMissingJob[$domain['id']] = "{$domain['id']}: {$domain['name']}";
+    }
+
+    if (!empty($domainMissingJob)) {
+      $domainMessage = '<ul><li>' . implode('</li><li>', $domainMissingJob) . '</li></ul>';
+      $message = new CRM_Utils_Check_Message(
+        __FUNCTION__ . 'mjwshared_multidomain',
+        E::ts('You have multiple domains configured and some domains are missing the scheduled job "Job.process_paymentprocessor_webhooks": %1',
+          [1 => $domainMessage]
+        ),
+        E::ts('Payments: Multidomain scheduled jobs'),
+        \Psr\Log\LogLevel::WARNING,
+        'fa-code'
+      );
+      $this->messages[] = $message;
+    }
+  }
+
+  /**
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  private function checkPaymentprocessorWebhooks() {
+    $paymentprocessorWebhooksProcessingCount = \Civi\Api4\PaymentprocessorWebhook::get(FALSE)
+      ->addSelect('row_count')
+      ->addWhere('status', '=', 'processing')
+      ->addWhere('created_date', '<', 'now-1hour')
+      ->addOrderBy('created_date', 'DESC')
+      ->execute()
+      ->countMatched();
+
+    if ($paymentprocessorWebhooksProcessingCount > 0) {
+      $paymentprocessorWebhookProcessors = \Civi\Api4\PaymentprocessorWebhook::get(FALSE)
+        ->addSelect('id', 'payment_processor_id:label')
+        ->addWhere('status', '=', 'processing')
+        ->addWhere('created_date', '<', 'now-1hour')
+        ->addOrderBy('created_date', 'DESC')
+        ->addGroupBy('payment_processor_id')
+        ->execute()
+        ->indexBy('payment_processor_id:label')
+        ->getArrayCopy();
+      $message = new CRM_Utils_Check_Message(
+        __FUNCTION__ . 'mjwshared_paymentprocessorwebhooks',
+        E::ts('You have %1 payment processor webhooks in "processing" status for %2 payment processors.
+        This means that the system started processing them but something went wrong that can\'t be fixed automatically.
+        Please check and identify the problem. Then you can mark them for retry.',
+          [1 => $paymentprocessorWebhooksProcessingCount, 2 => implode(',', array_keys($paymentprocessorWebhookProcessors))]
+        ),
+        E::ts('Payment Processor Webhooks: Processing failed'),
+        \Psr\Log\LogLevel::ERROR,
+        'fa-code'
+      );
+      $message->addAction('Check now', FALSE, 'href', ['path' => 'civicrm/a#/paymentprocessorWebhook']);
+      $this->messages[] = $message;
+    }
+  }
 
 }

CRM/Mjwshared/DAO/PaymentprocessorWebhook.php

 <?php
 
 /**
- * @package CRM
- * @copyright CiviCRM LLC https://civicrm.org/licensing
+ * DAOs provide an OOP-style facade for reading and writing database records.
  *
- * Generated from mjwshared/xml/schema/CRM/Mjwshared/PaymentprocessorWebhook.xml
- * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:f87fdd5e01150ab8d776e10bbe3fa15d)
- */
-use CRM_Mjwshared_ExtensionUtil as E;
-
-/**
- * Database access object for the PaymentprocessorWebhook entity.
+ * DAOs are a primary source for metadata in older versions of CiviCRM (<5.74)
+ * and are required for some subsystems (such as APIv3).
+ *
+ * This stub provides compatibility. It is not intended to be modified in a
+ * substantive way. Property annotations may be added, but are not required.
+ * @property string $id 
+ * @property string $payment_processor_id 
+ * @property string $event_id 
+ * @property string $trigger 
+ * @property string $created_date 
+ * @property string $processed_date 
+ * @property string $status 
+ * @property string $identifier 
+ * @property string $message 
+ * @property string $data 
  */
-class CRM_Mjwshared_DAO_PaymentprocessorWebhook extends CRM_Core_DAO {
-  const EXT = E::LONG_NAME;
-  const TABLE_ADDED = '';
+class CRM_Mjwshared_DAO_PaymentprocessorWebhook extends CRM_Mjwshared_DAO_Base {
 
   /**
-   * Static instance to hold the table name.
-   *
+   * Required by older versions of CiviCRM (<5.74).
    * @var string
    */
   public static $_tableName = 'civicrm_paymentprocessor_webhook';
 
-  /**
-   * Should CiviCRM log any modifications to this table in the civicrm_log table.
-   *
-   * @var bool
-   */
-  public static $_log = TRUE;
-
-  /**
-   * Unique PaymentprocessorWebhook ID
-   *
-   * @var int
-   */
-  public $id;
-
-  /**
-   * Payment Processor for this webhook
-   *
-   * @var int
-   */
-  public $payment_processor_id;
-
-  /**
-   * Webhook event ID
-   *
-   * @var string
-   */
-  public $event_id;
-
-  /**
-   * Webhook trigger event type
-   *
-   * @var string
-   */
-  public $trigger;
-
-  /**
-   * When the webhook was first received by the IPN code
-   *
-   * @var timestamp
-   */
-  public $created_date;
-
-  /**
-   * Has this webhook been processed yet?
-   *
-   * @var timestamp
-   */
-  public $processed_date;
-
-  /**
-   * Webhook processing status
-   *
-   * @var string
-   */
-  public $status;
-
-  /**
-   * @var text
-   */
-  public $identifier;
-
-  /**
-   * Class constructor.
-   */
-  public function __construct() {
-    $this->__table = 'civicrm_paymentprocessor_webhook';
-    parent::__construct();
-  }
-
-  /**
-   * Returns localized title of this entity.
-   *
-   * @param bool $plural
-   *   Whether to return the plural version of the title.
-   */
-  public static function getEntityTitle($plural = FALSE) {
-    return $plural ? E::ts('Paymentprocessor Webhooks') : E::ts('Paymentprocessor Webhook');
-  }
-
-  /**
-   * Returns foreign keys and entity references.
-   *
-   * @return array
-   *   [CRM_Core_Reference_Interface]
-   */
-  public static function getReferenceColumns() {
-    if (!isset(Civi::$statics[__CLASS__]['links'])) {
-      Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
-      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'payment_processor_id', 'civicrm_payment_processor', 'id');
-      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
-    }
-    return Civi::$statics[__CLASS__]['links'];
-  }
-
-  /**
-   * Returns all the column names of this table
-   *
-   * @return array
-   */
-  public static function &fields() {
-    if (!isset(Civi::$statics[__CLASS__]['fields'])) {
-      Civi::$statics[__CLASS__]['fields'] = [
-        'id' => [
-          'name' => 'id',
-          'type' => CRM_Utils_Type::T_INT,
-          'description' => E::ts('Unique PaymentprocessorWebhook ID'),
-          'required' => TRUE,
-          'where' => 'civicrm_paymentprocessor_webhook.id',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-        'payment_processor_id' => [
-          'name' => 'payment_processor_id',
-          'type' => CRM_Utils_Type::T_INT,
-          'title' => E::ts('Payment Processor'),
-          'description' => E::ts('Payment Processor for this webhook'),
-          'where' => 'civicrm_paymentprocessor_webhook.payment_processor_id',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'FKClassName' => 'CRM_Financial_DAO_PaymentProcessor',
-          'html' => [
-            'type' => 'Select',
-          ],
-          'pseudoconstant' => [
-            'table' => 'civicrm_payment_processor',
-            'keyColumn' => 'id',
-            'labelColumn' => 'name',
-          ],
-          'add' => NULL,
-        ],
-        'event_id' => [
-          'name' => 'event_id',
-          'type' => CRM_Utils_Type::T_STRING,
-          'description' => E::ts('Webhook event ID'),
-          'maxlength' => 255,
-          'size' => CRM_Utils_Type::HUGE,
-          'where' => 'civicrm_paymentprocessor_webhook.event_id',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-        'trigger' => [
-          'name' => 'trigger',
-          'type' => CRM_Utils_Type::T_STRING,
-          'title' => E::ts('Trigger'),
-          'description' => E::ts('Webhook trigger event type'),
-          'maxlength' => 255,
-          'size' => CRM_Utils_Type::HUGE,
-          'where' => 'civicrm_paymentprocessor_webhook.trigger',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-        'created_date' => [
-          'name' => 'created_date',
-          'type' => CRM_Utils_Type::T_TIMESTAMP,
-          'title' => E::ts('Created Date'),
-          'description' => E::ts('When the webhook was first received by the IPN code'),
-          'where' => 'civicrm_paymentprocessor_webhook.created_date',
-          'default' => 'CURRENT_TIMESTAMP',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-        'processed_date' => [
-          'name' => 'processed_date',
-          'type' => CRM_Utils_Type::T_TIMESTAMP,
-          'title' => E::ts('Processed Date'),
-          'description' => E::ts('Has this webhook been processed yet?'),
-          'where' => 'civicrm_paymentprocessor_webhook.processed_date',
-          'default' => 'NULL',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-        'status' => [
-          'name' => 'status',
-          'type' => CRM_Utils_Type::T_STRING,
-          'title' => E::ts('Status'),
-          'description' => E::ts('Webhook processing status'),
-          'maxlength' => 255,
-          'size' => CRM_Utils_Type::HUGE,
-          'where' => 'civicrm_paymentprocessor_webhook.status',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-        'identifier' => [
-          'name' => 'identifier',
-          'type' => CRM_Utils_Type::T_TEXT,
-          'title' => E::ts('Identifier'),
-          'where' => 'civicrm_paymentprocessor_webhook.identifier',
-          'table_name' => 'civicrm_paymentprocessor_webhook',
-          'entity' => 'PaymentprocessorWebhook',
-          'bao' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
-          'localizable' => 0,
-          'add' => NULL,
-        ],
-      ];
-      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
-    }
-    return Civi::$statics[__CLASS__]['fields'];
-  }
-
-  /**
-   * Return a mapping from field-name to the corresponding key (as used in fields()).
-   *
-   * @return array
-   *   Array(string $name => string $uniqueName).
-   */
-  public static function &fieldKeys() {
-    if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
-      Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
-    }
-    return Civi::$statics[__CLASS__]['fieldKeys'];
-  }
-
-  /**
-   * Returns the names of this table
-   *
-   * @return string
-   */
-  public static function getTableName() {
-    return self::$_tableName;
-  }
-
-  /**
-   * Returns if this table needs to be logged
-   *
-   * @return bool
-   */
-  public function getLog() {
-    return self::$_log;
-  }
-
-  /**
-   * Returns the list of fields that can be imported
-   *
-   * @param bool $prefix
-   *
-   * @return array
-   */
-  public static function &import($prefix = FALSE) {
-    $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'paymentprocessor_webhook', $prefix, []);
-    return $r;
-  }
-
-  /**
-   * Returns the list of fields that can be exported
-   *
-   * @param bool $prefix
-   *
-   * @return array
-   */
-  public static function &export($prefix = FALSE) {
-    $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'paymentprocessor_webhook', $prefix, []);
-    return $r;
-  }
-
-  /**
-   * Returns the list of indices
-   *
-   * @param bool $localize
-   *
-   * @return array
-   */
-  public static function indices($localize = TRUE) {
-    $indices = [];
-    return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
-  }
-
 }

CRM/Mjwshared/Form/PaymentRefund.php

 <?php
 
+use Civi\Api4\LineItem;
+use Civi\Api4\Membership;
+use Civi\Api4\Participant;
+use Civi\Api4\PaymentProcessor;
+use Civi\Payment\Exception\PaymentProcessorException;
 use CRM_Mjwshared_ExtensionUtil as E;
+use Brick\Money\Money;
+use Brick\Money\Context\DefaultContext;
+use Brick\Math\RoundingMode;
+
 
 /**
  * Form controller class
@@ -19,47 +28,106 @@ class CRM_Mjwshared_Form_PaymentRefund extends CRM_Core_Form {
    */
   private $contributionID;
 
+  /**
+   * @var array $financialTrxn
+   */
+  private $financialTrxn;
+
   public function buildQuickForm() {
     if (!CRM_Core_Permission::check('edit contributions')) {
       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
     }
 
-    if ($this->isSubmitted()) {
-      return;
-    }
+    $this->addFormRule(['CRM_Mjwshared_Form_PaymentRefund', 'formRule'], $this);
 
     $this->setTitle('Refund payment');
 
-    $this->paymentID = CRM_Utils_Request::retrieveValue('id', 'Positive', NULL, FALSE, 'GET');
+    $this->paymentID = CRM_Utils_Request::retrieveValue('payment_id', 'Positive', NULL, FALSE, 'REQUEST');
     if (!$this->paymentID) {
       CRM_Core_Error::statusBounce('Payment not found!');
     }
 
-    $this->contributionID = CRM_Utils_Request::retrieveValue('contribution_id', 'Positive', NULL, FALSE, 'GET');
+    $this->contributionID = CRM_Utils_Request::retrieveValue('contribution_id', 'Positive', NULL, FALSE, 'REQUEST');
     if (!$this->contributionID) {
       CRM_Core_Error::statusBounce('Contribution not found!');
     }
 
+    $financialTrxn = reset(civicrm_api3('Mjwpayment', 'get_payment', [
+      'financial_trxn_id' => $this->paymentID,
+    ])['values']);
+    if ((int)$financialTrxn['contribution_id'] !== $this->contributionID) {
+      CRM_Core_Error::statusBounce('Contribution / Payment does not match');
+    }
+    $financialTrxn['order_reference'] = $financialTrxn['order_reference'] ?? NULL;
+
+    $paymentProcessor = PaymentProcessor::get(FALSE)
+      ->addWhere('id', '=', $financialTrxn['payment_processor_id'])
+      ->execute()
+      ->first();
+    $financialTrxn['payment_processor_title'] = $paymentProcessor['title'] ?? $paymentProcessor['name'];
+
+    $this->assign('paymentInfo', $financialTrxn);
+    $this->financialTrxn = $financialTrxn;
+
     $this->add('hidden', 'payment_id');
+    $this->add('hidden', 'contribution_id');
+
+    $participantIDs = $membershipIDs = [];
 
-    $lineItems = civicrm_api3('LineItem', 'get', [
-      'contribution_id' => $this->contributionID,
-    ])['values'];
-    foreach ($lineItems as $lineItemID => $lineItemDetails) {
+    $lineItems = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $this->contributionID)
+      ->execute();
+    foreach ($lineItems as $lineItemDetails) {
       switch ($lineItemDetails['entity_table']) {
         case 'civicrm_participant':
           $participantIDs[] = $lineItemDetails['entity_id'];
           break;
+
+        case 'civicrm_membership':
+          $membershipIDs[] = $lineItemDetails['entity_id'];
+          break;
       }
     }
     if (!empty($participantIDs)) {
+      $participantsForAssign = [];
       $this->set('participant_ids', $participantIDs);
-      $participants = civicrm_api3('Participant', 'get', [
-        'id' => ['IN' => $participantIDs],
-      ])['values'];
-      $this->assign('participants', $participants);
-      $this->addYesNo('cancel_participants', E::ts('Cancel Participants'), NULL, TRUE);
+      $participants = Participant::get()
+        ->addSelect('*', 'event_id.title', 'status_id:label', 'contact_id.display_name')
+        ->addWhere('id', 'IN', $participantIDs)
+        ->execute();
+      foreach ($participants->getArrayCopy() as $participant) {
+        $participant['status'] = $participant['status_id:label'];
+        $participant['event_title'] = $participant['event_id.title'];
+        $participant['display_name'] = $participant['contact_id.display_name'];
+        $participantsForAssign[] = $participant;
+      }
+      $this->addYesNo('cancel_participants', E::ts('Do you want to cancel these registrations when you refund the payment?'), NULL, TRUE);
+    }
+    $this->assign('participants', $participantsForAssign ?? NULL);
+
+    if (!empty($membershipIDs)) {
+      $membershipsForAssign = [];
+      $this->set('membership_ids', $membershipIDs);
+      $memberships = Membership::get(FALSE)
+        ->addSelect('*', 'membership_type_id:label', 'status_id:label', 'contact_id.display_name')
+        ->addWhere('id', 'IN', $membershipIDs)
+        ->execute();
+      foreach ($memberships->getArrayCopy() as $membership) {
+        $membership['status'] = $membership['status_id:label'];
+        $membership['type'] = $membership['membership_type_id:label'];
+        $membership['display_name'] = $membership['contact_id.display_name'];
+        $membershipsForAssign[] = $membership;
+      }
+      $this->addYesNo('cancel_memberships', E::ts('Do you want to cancel these memberships when you refund the payment?'), NULL, TRUE);
     }
+    $this->assign('memberships', $membershipsForAssign ?? NULL);
+
+    $this->addMoney('refund_amount',
+      ts('Refund Amount'),
+      TRUE,
+      [],
+      TRUE, 'currency', $financialTrxn['currency'], TRUE
+    );
 
     $this->addButtons([
       [
@@ -78,42 +146,103 @@ class CRM_Mjwshared_Form_PaymentRefund extends CRM_Core_Form {
     if ($this->paymentID) {
       $this->_defaults['payment_id'] = $this->paymentID;
       $this->set('payment_id', $this->paymentID);
+      $this->_defaults['contribution_id'] = $this->contributionID;
+      $this->set('contribution_id', $this->contributionID);
+      $this->_defaults['refund_amount'] = $this->financialTrxn['total_amount'];
     }
     return $this->_defaults;
   }
 
+  /**
+   * Global form rule.
+   *
+   * @param array $fields
+   *   The input form values.
+   * @param array $files
+   *   The uploaded files if any.
+   * @param CRM_Core_Form $form
+   *
+   * @return bool|array
+   *   true if no errors, else array of errors
+   */
+  public static function formRule($fields, $files, $form) {
+    $errors = [];
+
+    $formValues = $form->getSubmitValues();
+    $paymentID = $form->get('payment_id');
+
+    $payment = reset(civicrm_api3('Mjwpayment', 'get_payment', ['id' => $paymentID])['values']);
+
+    // Check refund amount
+    $refundAmount = Money::of($formValues['refund_amount'], $payment['currency'], new DefaultContext(), RoundingMode::CEILING);
+    $paymentAmount = Money::of($payment['total_amount'], $payment['currency'], new DefaultContext(), RoundingMode::CEILING);
+
+    if ($refundAmount->isGreaterThan($paymentAmount)) {
+      $errors['refund_amount'] = 'Cannot refund more than the original amount';
+    }
+    if ($refundAmount->isNegativeOrZero()) {
+      $errors['refund_amount'] = 'Cannot refund zero or negative amount';
+    }
+
+    return $errors;
+  }
+
   public function postProcess() {
     $formValues = $this->getSubmitValues();
     $paymentID = $this->get('payment_id');
     $participantIDs = $this->get('participant_ids');
-    // For some reason cancel_participants is a required field but is not being validated as "required" by the form.
-    //   so do a crude validation here.
-    if (!empty($participantIDs) && !isset($formValues['cancel_participants'])) {
-      CRM_Core_Error::statusBounce('Cancel Participants is a required field');
-    }
+    $cancelParticipants = $formValues['cancel_participants'] ?? FALSE;
+    $membershipIDs = $this->get('membership_ids');
+    $cancelMemberships = $formValues['cancel_memberships'] ?? FALSE;
 
     try {
       $payment = reset(civicrm_api3('Mjwpayment', 'get_payment', ['id' => $paymentID])['values']);
+
+      // Check refund amount
+      $refundAmount = Money::of($formValues['refund_amount'], $payment['currency'], new DefaultContext(), RoundingMode::CEILING);
+      $paymentAmount = Money::of($payment['total_amount'], $payment['currency'], new DefaultContext(), RoundingMode::CEILING);
+
+      if ($refundAmount->isGreaterThan($paymentAmount)) {
+        throw new PaymentProcessorException('Cannot refund more than the original amount');
+      }
+      if ($refundAmount->isNegativeOrZero()) {
+        throw new PaymentProcessorException('Cannot refund zero or negative amount');
+      }
+
       $refundParams = [
         'payment_processor_id' => $payment['payment_processor_id'],
-        'amount' => $payment['total_amount'],
+        'amount' => $refundAmount->getAmount()->toFloat(),
         'currency' => $payment['currency'],
         'trxn_id' => $payment['trxn_id'],
       ];
       $refund = reset(civicrm_api3('PaymentProcessor', 'Refund', $refundParams)['values']);
-      if ($refund['refund_status_name'] === 'Completed') {
+      if ($refund['refund_status'] === 'Completed') {
         $refundPaymentParams = [
           'contribution_id' => $payment['contribution_id'],
           'trxn_id' => $refund['refund_trxn_id'],
-          'order_reference' => $payment['order_reference'],
-          'total_amount' => (-$payment['total_amount']),
+          'order_reference' => $payment['order_reference'] ?? NULL,
+          'total_amount' => 0 - abs($refundAmount->getAmount()->toFloat()),
+          'fee_amount' => 0 - abs($refund['fee_amount']),
           'payment_processor_id' => $payment['payment_processor_id'],
         ];
-        // Record the refund in CiviCRM
-        civicrm_api3('Mjwpayment', 'create_payment', $refundPaymentParams);
+
+        $lock = Civi::lockManager()->acquire('data.contribute.contribution.' . $refundPaymentParams['contribution_id']);
+        if (!$lock->isAcquired()) {
+          throw new PaymentProcessorException('Could not acquire lock to record refund for contribution: ' . $refundPaymentParams['contribution_id']);
+        }
+        $refundPayment = civicrm_api3('Payment', 'get', [
+          'contribution_id' => $refundPaymentParams['contribution_id'],
+          'total_amount' => $refundPaymentParams['total_amount'],
+          'trxn_id' => $refundPaymentParams['trxn_id'],
+        ]);
+        if (empty($refundPayment['count'])) {
+          // Record the refund in CiviCRM
+          civicrm_api3('Mjwpayment', 'create_payment', $refundPaymentParams);
+        }
+        $lock->release();
         $message = E::ts('Refund was processed successfully.');
 
-        if ($formValues['cancel_participants'] && !empty($participantIDs)) {
+        if ($cancelParticipants && !empty($participantIDs)) {
           foreach ($participantIDs as $participantID) {
             civicrm_api3('Participant', 'create', [
               'id' => $participantID,
@@ -122,10 +251,19 @@ class CRM_Mjwshared_Form_PaymentRefund extends CRM_Core_Form {
           }
           $message .= ' ' . E::ts('Cancelled %1 participant registration(s).', [1 => count($participantIDs)]);
         }
+
+        if ($cancelMemberships && !empty($membershipIDs)) {
+          Membership::update(FALSE)
+            ->addValue('status_id.name', 'Cancelled')
+            ->addWhere('id', 'IN', $membershipIDs)
+            ->execute();
+          $message .= ' ' . E::ts('Cancelled %1 membership(s).', [1 => count($membershipIDs)]);
+        }
+
         CRM_Core_Session::setStatus($message, 'Refund processed', 'success');
       }
       else {
-        CRM_Core_Error::statusBounce("Refund status '{$refund['refund_status_name']}'is not supported at this time and was not recorded in CiviCRM.");
+        CRM_Core_Error::statusBounce("Refund status '{$refund['refund_status']}'is not supported at this time and was not recorded in CiviCRM.");
       }
     } catch (Exception $e) {
       CRM_Core_Error::statusBounce($e->getMessage(), NULL, 'Refund failed');

CRM/Mjwshared/Hook.php

+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * This class implements hooks for Mjwshared
+ */
+class CRM_Mjwshared_Hook {
+
+  /**
+   * This hook allows modifying recurring contribution parameters
+   *
+   * @param string $type The type of webhook - eg. 'stripe'
+   * @param object $object The object (eg. CRM_Core_Payment_StripeIPN)
+   * @param string $code "Code" to identify what was not matched (eg. customer_not_found)
+   * @param array $result Results returned by hook processing. Depends on the type/code. Eg. for stripe.contribution_not_found return $result['contribution'] = "contribution array from API"
+   *
+   * @return mixed
+   */
+  public static function webhookEventNotMatched(string $type, $object, string $code = '', array &$result = []) {
+    // Wrap in a try/catch to guard against coding errors in extensions.
+    try {
+      return CRM_Utils_Hook::singleton()
+        ->invoke([
+          'type',
+          'object',
+          'code',
+          'result'
+        ], $type, $object, $code, $result, CRM_Utils_Hook::$_nullObject, CRM_Utils_Hook::$_nullObject,
+          'civicrm_webhook_eventNotMatched'
+        );
+    }
+    catch (Exception $e) {
+      \Civi::log()->error("webhookEventNotMatched triggered exception. Type: {$type}; Code: {$code}; Message: " . $e->getMessage());
+      return FALSE;
+    }
+  }
+
+}

CRM/Mjwshared/Upgrader.php

@@ -4,7 +4,7 @@ use CRM_Mjwshared_ExtensionUtil as E;
 /**
  * Collection of upgrade steps.
  */
-class CRM_Mjwshared_Upgrader extends CRM_Mjwshared_Upgrader_Base {
+class CRM_Mjwshared_Upgrader extends CRM_Extension_Upgrader_Base {
 
   /**
    * @return TRUE on success
@@ -13,9 +13,38 @@ class CRM_Mjwshared_Upgrader extends CRM_Mjwshared_Upgrader_Base {
   public function upgrade_1000() {
     $this->ctx->log->info('Applying update 1000 - Add civicrm_paymentprocessor_webhook table');
     if (!CRM_Core_DAO::checkTableExists('civicrm_paymentprocessor_webhook')) {
-      $this->executeSqlFile('sql/paymentprocessorwebhook_install.sql');
+      // Note: this SQL installs an old version of this table which will then
+      // be updated by upgrade_1001 It only exists for the sake of people
+      // upgrading from old versions.
+      $this->executeSqlFile('sql/upgrade_1000.sql');
     }
     return TRUE;
   }
 
+  /**
+   * @return TRUE on success
+   * @throws Exception
+  */
+  public function upgrade_1001() {
+    $this->ctx->log->info('Applying update 1001 - alter civicrm_paymentprocessor_webhook table');
+    $this->executeSqlFile('sql/upgrade_1001.sql');
+    return TRUE;
+  }
+
+  public function upgrade_1002() {
+    $this->ctx->log->info('Add indexes to civicrm_paymentprocessor_webhook table');
+    if (!CRM_Core_BAO_SchemaHandler::checkIfIndexExists('civicrm_paymentprocessor_webhook', 'index_processed_date')) {
+      CRM_Core_DAO::executeQuery('ALTER TABLE `civicrm_paymentprocessor_webhook` ADD INDEX `index_processed_date` (`processed_date`)');
+    }
+    if (!CRM_Core_BAO_SchemaHandler::checkIfIndexExists('civicrm_paymentprocessor_webhook', 'index_identifier')) {
+      CRM_Core_DAO::executeQuery('ALTER TABLE `civicrm_paymentprocessor_webhook` ADD INDEX `index_identifier` (`identifier`)');
+    }
+    return TRUE;
+  }
+
+  public function upgrade_1003() {
+    $this->ctx->log->info('Make "message" field not required');
+    CRM_Core_DAO::executeQuery("ALTER TABLE civicrm_paymentprocessor_webhook MODIFY COLUMN `message` varchar(1024) DEFAULT '' COMMENT 'Stores data sent that is needed for processing. JSON suggested.'");
+    return TRUE;
+  }
 }

CRM/Mjwshared/Upgrader/Base.php

-<?php
-
-// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
-use CRM_Mjwshared_ExtensionUtil as E;
-
-/**
- * Base class which provides helpers to execute upgrade logic
- */
-class CRM_Mjwshared_Upgrader_Base {
-
-  /**
-   * @var CRM_Mjwshared_Upgrader_Base
-   */
-  public static $instance;
-
-  /**
-   * @var CRM_Queue_TaskContext
-   */
-  protected $ctx;
-
-  /**
-   * @var string
-   *   eg 'com.example.myextension'
-   */
-  protected $extensionName;
-
-  /**
-   * @var string
-   *   full path to the extension's source tree
-   */
-  protected $extensionDir;
-
-  /**
-   * @var array
-   *   sorted numerically
-   */
-  private $revisions;
-
-  /**
-   * @var bool
-   *   Flag to clean up extension revision data in civicrm_setting
-   */
-  private $revisionStorageIsDeprecated = FALSE;
-
-  /**
-   * Obtain a reference to the active upgrade handler.
-   */
-  public static function instance() {
-    if (!self::$instance) {
-      self::$instance = new CRM_Mjwshared_Upgrader(
-        'mjwshared',
-        E::path()
-      );
-    }
-    return self::$instance;
-  }
-
-  /**
-   * Adapter that lets you add normal (non-static) member functions to the queue.
-   *
-   * Note: Each upgrader instance should only be associated with one
-   * task-context; otherwise, this will be non-reentrant.
-   *
-   * ```
-   * CRM_Mjwshared_Upgrader_Base::_queueAdapter($ctx, 'methodName', 'arg1', 'arg2');
-   * ```
-   */
-  public static function _queueAdapter() {
-    $instance = self::instance();
-    $args = func_get_args();
-    $instance->ctx = array_shift($args);
-    $instance->queue = $instance->ctx->queue;
-    $method = array_shift($args);
-    return call_user_func_array([$instance, $method], $args);
-  }
-
-  /**
-   * CRM_Mjwshared_Upgrader_Base constructor.
-   *
-   * @param $extensionName
-   * @param $extensionDir
-   */
-  public function __construct($extensionName, $extensionDir) {
-    $this->extensionName = $extensionName;
-    $this->extensionDir = $extensionDir;
-  }
-
-  // ******** Task helpers ********
-
-  /**
-   * Run a CustomData file.
-   *
-   * @param string $relativePath
-   *   the CustomData XML file path (relative to this extension's dir)
-   * @return bool
-   */
-  public function executeCustomDataFile($relativePath) {
-    $xml_file = $this->extensionDir . '/' . $relativePath;
-    return $this->executeCustomDataFileByAbsPath($xml_file);
-  }
-
-  /**
-   * Run a CustomData file
-   *
-   * @param string $xml_file
-   *   the CustomData XML file path (absolute path)
-   *
-   * @return bool
-   */
-  protected function executeCustomDataFileByAbsPath($xml_file) {
-    $import = new CRM_Utils_Migrate_Import();
-    $import->run($xml_file);
-    return TRUE;
-  }
-
-  /**
-   * Run a SQL file.
-   *
-   * @param string $relativePath
-   *   the SQL file path (relative to this extension's dir)
-   *
-   * @return bool
-   */
-  public function executeSqlFile($relativePath) {
-    CRM_Utils_File::sourceSQLFile(
-      CIVICRM_DSN,
-      $this->extensionDir . DIRECTORY_SEPARATOR . $relativePath
-    );
-    return TRUE;
-  }
-
-  /**
-   * Run the sql commands in the specified file.
-   *
-   * @param string $tplFile
-   *   The SQL file path (relative to this extension's dir).
-   *   Ex: "sql/mydata.mysql.tpl".
-   *
-   * @return bool
-   * @throws \CRM_Core_Exception
-   */
-  public function executeSqlTemplate($tplFile) {
-    // Assign multilingual variable to Smarty.
-    $upgrade = new CRM_Upgrade_Form();
-
-    $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile;
-    $smarty = CRM_Core_Smarty::singleton();
-    $smarty->assign('domainID', CRM_Core_Config::domainID());
-    CRM_Utils_File::sourceSQLFile(
-      CIVICRM_DSN, $smarty->fetch($tplFile), NULL, TRUE
-    );
-    return TRUE;
-  }
-
-  /**
-   * Run one SQL query.
-   *
-   * This is just a wrapper for CRM_Core_DAO::executeSql, but it
-   * provides syntactic sugar for queueing several tasks that
-   * run different queries
-   *
-   * @return bool
-   */
-  public function executeSql($query, $params = []) {
-    // FIXME verify that we raise an exception on error
-    CRM_Core_DAO::executeQuery($query, $params);
-    return TRUE;
-  }
-
-  /**
-   * Syntactic sugar for enqueuing a task which calls a function in this class.
-   *
-   * The task is weighted so that it is processed
-   * as part of the currently-pending revision.
-   *
-   * After passing the $funcName, you can also pass parameters that will go to
-   * the function. Note that all params must be serializable.
-   */
-  public function addTask($title) {
-    $args = func_get_args();
-    $title = array_shift($args);
-    $task = new CRM_Queue_Task(
-      [get_class($this), '_queueAdapter'],
-      $args,
-      $title
-    );
-    return $this->queue->createItem($task, ['weight' => -1]);
-  }
-
-  // ******** Revision-tracking helpers ********
-
-  /**
-   * Determine if there are any pending revisions.
-   *
-   * @return bool
-   */
-  public function hasPendingRevisions() {
-    $revisions = $this->getRevisions();
-    $currentRevision = $this->getCurrentRevision();
-
-    if (empty($revisions)) {
-      return FALSE;
-    }
-    if (empty($currentRevision)) {
-      return TRUE;
-    }
-
-    return ($currentRevision < max($revisions));
-  }
-
-  /**
-   * Add any pending revisions to the queue.
-   *
-   * @param CRM_Queue_Queue $queue
-   */
-  public function enqueuePendingRevisions(CRM_Queue_Queue $queue) {
-    $this->queue = $queue;
-
-    $currentRevision = $this->getCurrentRevision();
-    foreach ($this->getRevisions() as $revision) {
-      if ($revision > $currentRevision) {
-        $title = E::ts('Upgrade %1 to revision %2', [
-          1 => $this->extensionName,
-          2 => $revision,
-        ]);
-
-        // note: don't use addTask() because it sets weight=-1
-
-        $task = new CRM_Queue_Task(
-          [get_class($this), '_queueAdapter'],
-          ['upgrade_' . $revision],
-          $title
-        );
-        $this->queue->createItem($task);
-
-        $task = new CRM_Queue_Task(
-          [get_class($this), '_queueAdapter'],
-          ['setCurrentRevision', $revision],
-          $title
-        );
-        $this->queue->createItem($task);
-      }
-    }
-  }
-
-  /**
-   * Get a list of revisions.
-   *
-   * @return array
-   *   revisionNumbers sorted numerically
-   */
-  public function getRevisions() {
-    if (!is_array($this->revisions)) {
-      $this->revisions = [];
-
-      $clazz = new ReflectionClass(get_class($this));
-      $methods = $clazz->getMethods();
-      foreach ($methods as $method) {
-        if (preg_match('/^upgrade_(.*)/', $method->name, $matches)) {
-          $this->revisions[] = $matches[1];
-        }
-      }
-      sort($this->revisions, SORT_NUMERIC);
-    }
-
-    return $this->revisions;
-  }
-
-  public function getCurrentRevision() {
-    $revision = CRM_Core_BAO_Extension::getSchemaVersion($this->extensionName);
-    if (!$revision) {
-      $revision = $this->getCurrentRevisionDeprecated();
-    }
-    return $revision;
-  }
-
-  private function getCurrentRevisionDeprecated() {
-    $key = $this->extensionName . ':version';
-    if ($revision = \Civi::settings()->get($key)) {
-      $this->revisionStorageIsDeprecated = TRUE;
-    }
-    return $revision;
-  }
-
-  public function setCurrentRevision($revision) {
-    CRM_Core_BAO_Extension::setSchemaVersion($this->extensionName, $revision);
-    // clean up legacy schema version store (CRM-19252)
-    $this->deleteDeprecatedRevision();
-    return TRUE;
-  }
-
-  private function deleteDeprecatedRevision() {
-    if ($this->revisionStorageIsDeprecated) {
-      $setting = new CRM_Core_BAO_Setting();
-      $setting->name = $this->extensionName . ':version';
-      $setting->delete();
-      CRM_Core_Error::debug_log_message("Migrated extension schema revision ID for {$this->extensionName} from civicrm_setting (deprecated) to civicrm_extension.\n");
-    }
-  }
-
-  // ******** Hook delegates ********
-
-  /**
-   * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
-   */
-  public function onInstall() {
-    $files = glob($this->extensionDir . '/sql/*_install.sql');
-    if (is_array($files)) {
-      foreach ($files as $file) {
-        CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
-      }
-    }
-    $files = glob($this->extensionDir . '/sql/*_install.mysql.tpl');
-    if (is_array($files)) {
-      foreach ($files as $file) {
-        $this->executeSqlTemplate($file);
-      }
-    }
-    $files = glob($this->extensionDir . '/xml/*_install.xml');
-    if (is_array($files)) {
-      foreach ($files as $file) {
-        $this->executeCustomDataFileByAbsPath($file);
-      }
-    }
-    if (is_callable([$this, 'install'])) {
-      $this->install();
-    }
-  }
-
-  /**
-   * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
-   */
-  public function onPostInstall() {
-    $revisions = $this->getRevisions();
-    if (!empty($revisions)) {
-      $this->setCurrentRevision(max($revisions));
-    }
-    if (is_callable([$this, 'postInstall'])) {
-      $this->postInstall();
-    }
-  }
-
-  /**
-   * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
-   */
-  public function onUninstall() {
-    $files = glob($this->extensionDir . '/sql/*_uninstall.mysql.tpl');
-    if (is_array($files)) {
-      foreach ($files as $file) {
-        $this->executeSqlTemplate($file);
-      }
-    }
-    if (is_callable([$this, 'uninstall'])) {
-      $this->uninstall();
-    }
-    $files = glob($this->extensionDir . '/sql/*_uninstall.sql');
-    if (is_array($files)) {
-      foreach ($files as $file) {
-        CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
-      }
-    }
-  }
-
-  /**
-   * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
-   */
-  public function onEnable() {
-    // stub for possible future use
-    if (is_callable([$this, 'enable'])) {
-      $this->enable();
-    }
-  }
-
-  /**
-   * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
-   */
-  public function onDisable() {
-    // stub for possible future use
-    if (is_callable([$this, 'disable'])) {
-      $this->disable();
-    }
-  }
-
-  public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) {
-    switch ($op) {
-      case 'check':
-        return [$this->hasPendingRevisions()];
-
-      case 'enqueue':
-        return $this->enqueuePendingRevisions($queue);
-
-      default:
-    }
-  }
-
-}

CRM/Mjwshared/Utils.php

@@ -17,12 +17,12 @@ class CRM_Mjwshared_Utils {
   /**
    * Return the field ID for $fieldName custom field
    *
-   * @param $fieldName
-   * @param $fieldGroup
-   * @param bool $fullString
+   * @param string $fieldName
+   * @param string $fieldGroup
+   * @param bool $fullString If TRUE return "custom_25", If FALSE return "25"
    *
-   * @return mixed
-   * @throws \CiviCRM_API3_Exception
+   * @return int|string
+   * @throws \CRM_Core_Exception
    */
   public static function getCustomByName($fieldName, $fieldGroup, $fullString = TRUE) {
     if (!isset(Civi::$statics[__CLASS__][$fieldGroup][$fieldName])) {

Civi/Api4/Action/ContributionRecur/UpdateAmountOnRecurMJW.php

+<?php
+namespace Civi\Api4\Action\ContributionRecur;
+
+use Brick\Money\Money;
+
+/**
+ * This API Action updates the contributionRecur and related entities (templatecontribution/lineitems)
+ *   when a subscription is changed.
+ *
+ */
+class UpdateAmountOnRecurMJW extends \Civi\Api4\Generic\AbstractUpdateAction {
+
+  /**
+   *
+   * Note that the result class is that of the annotation below, not the hint
+   * in the method (which must match the parent class)
+   *
+   * @var \Civi\Api4\Generic\Result $result
+   */
+  public function _run(\Civi\Api4\Generic\Result $result) {
+    if (!array_key_exists('amount', $this->values)) {
+      throw new \CRM_Core_Exception('Must specify amount');
+    }
+    foreach ($this->values as $key => $value) {
+      if ($key !== 'amount') {
+        throw new \CRM_Core_Exception('Only amount can be specified');
+      }
+    }
+
+    // Load the recurs.
+    $recurs = \Civi\Api4\ContributionRecur::get(FALSE)
+      ->setWhere($this->where)
+      ->execute()->indexBy('id');
+
+    foreach ($recurs as $recur) {
+      $subscription = new \Civi\MJW\Payment\Subscription();
+      $subscription->setRecur($recur);
+      if (empty($subscription->getRecur())) {
+        throw new \CRM_Core_Exception('RecurID is not valid!');
+      }
+
+      $newAmount = Money::of($this->values['amount'], $recur['currency']);
+      $recurResults[] = $subscription->updateRecurAndTemplateContributionAmount($newAmount);
+    }
+    $result->exchangeArray($recurResults ?? []);
+    return $result;
+  }
+
+  protected function updateRecords(array $items): array {
+    return $items;
+  }
+}

Civi/Api4/Action/Membership/LinkToRecurMJW.php

+<?php
+namespace Civi\Api4\Action\Membership;
+
+/**
+ * This API Action updates the contributionRecur and related entities (templatecontribution/lineitems)
+ *   when a subscription is changed so they are not linked to a Membership.
+ *
+ */
+class LinkToRecurMJW extends \Civi\Api4\Generic\AbstractUpdateAction {
+
+  /**
+   * @var array field => REQUIRED
+   */
+  private $whereFields = [
+    'id' => TRUE,
+    'contribution_recur_id' => FALSE,
+    'contribution_id' => FALSE,
+  ];
+
+  /**
+   *
+   * Note that the result class is that of the annotation below, not the hint
+   * in the method (which must match the parent class)
+   *
+   * @var \Civi\Api4\Generic\Result $result
+   */
+  public function _run(\Civi\Api4\Generic\Result $result) {
+    if (empty($this->values['id'])) {
+      throw new \CRM_Core_Exception('Must specify Membership ID (id)');
+    }
+    // One of contribution_recur_id or contribution_id is required.
+    if (empty($this->values['contribution_recur_id']) && (empty($this->values['contribution_id']))) {
+      throw new \CRM_Core_Exception('One of contribution_id or contribution_recur_id is required');
+    }
+
+    $membershipProcessor = new \Civi\MJW\Payment\Membership();
+    $entityIDs = $membershipProcessor->linkMembershipToRecur($this->values['id'], $this->values['contribution_id'] ?? NULL, $this->values['contribution_recur_id'] ?? NULL);
+
+    $result->exchangeArray($entityIDs);
+    return $result;
+  }
+
+  protected function updateRecords(array $items): array {
+    return $items;
+  }
+}

Civi/Api4/Action/Membership/UnlinkFromRecurMJW.php

+<?php
+namespace Civi\Api4\Action\Membership;
+
+/**
+ * This API Action updates the contributionRecur and related entities (templatecontribution/lineitems)
+ *   when a subscription is changed so they are not linked to a Membership
+ *
+ */
+class UnlinkFromRecurMJW extends \Civi\Api4\Generic\AbstractUpdateAction {
+
+  /**
+   * @var array field => REQUIRED
+   */
+  private $whereFields = [
+    'id' => TRUE,
+    'contribution_recur_id' => FALSE,
+    'contribution_id' => FALSE,
+  ];
+
+  /**
+   *
+   * Note that the result class is that of the annotation below, not the hint
+   * in the method (which must match the parent class)
+   *
+   * @var \Civi\Api4\Generic\Result $result
+   */
+  public function _run(\Civi\Api4\Generic\Result $result) {
+    if (empty($this->values['id'])) {
+      throw new \CRM_Core_Exception('Must specify Membership ID (id)');
+    }
+
+    $membershipProcessor = new \Civi\MJW\Payment\Membership();
+    $entityIDs = $membershipProcessor->unlinkMembershipFromRecur($this->values['id'], $this->values['contribution_id'] ?? NULL, $this->values['contribution_recur_id'] ?? NULL);
+
+    $result->exchangeArray($entityIDs);
+    return $result;
+  }
+
+  protected function updateRecords(array $items): array {
+    return $items;
+  }
+}

Civi/Api4/Action/PaymentMJW/Create.php

+<?php
+
+namespace Civi\Api4\Action\PaymentMJW;
+
+use CRM_Mjwshared_ExtensionUtil as E;
+use Civi\Api4\CustomField;
+
+/**
+ * This API Action creates a payment. It is based on API3 Payment.create and API3 MJWPayment.create
+ *
+ */
+class Create extends \Civi\Api4\Generic\AbstractCreateAction {
+
+  public static function getCreateFields() {
+    // Basically a copy of _civicrm_api3_payment_create_spec;
+    $fields = [
+      [
+        'name' => 'contribution_id',
+        'required' => TRUE,
+        'description' => E::ts('Contribution ID'),
+        'data_type' => 'Integer',
+        'fk_entity' => 'Contribution',
+        'input_type' => 'EntityRef',
+      ],
+      [
+        'name' => 'total_amount',
+        'required' => TRUE,
+        'description' => E::ts('Total Payment Amount'),
+        'data_type' => 'Float',
+      ],
+      [
+        'name' => 'fee_amount',
+        'description' => E::ts('Fee Amount'),
+        'data_type' => 'Float',
+      ],
+      [
+        'name' => 'payment_processor_id',
+        'data_type' => 'Integer',
+        'description' => E::ts('Payment Processor for this payment'),
+        'fk_entity' => 'PaymentProcessor',
+        'input_type' => 'EntityRef',
+      ],
+      [
+        'name' => 'trxn_date',
+        'description' => E::ts('Payment Date'),
+        'data_type' => 'Datetime',
+        'default' => 'now',
+        'required' => TRUE,
+      ],
+      [
+        'name' => 'is_send_contribution_notification',
+        'description' => E::ts('Send out notifications based on contribution status change?'),
+        'data_type' => 'Boolean',
+        'default' => TRUE,
+      ],
+      [
+        'name' => 'payment_instrument_id',
+        'data_type' => 'Integer',
+        'description' => E::ts('Payment Method (FK to payment_instrument option group values)'),
+        'pseudoconstant' => [
+          'optionGroupName' => 'payment_instrument',
+          'optionEditPath' => 'civicrm/admin/options/payment_instrument',
+        ],
+      ],
+      [
+        'name' => 'card_type_id',
+        'data_type' => 'Integer',
+        'description' => E::ts('Card Type ID (FK to accept_creditcard option group values)'),
+        'pseudoconstant' => [
+          'optionGroupName' => 'accept_creditcard',
+          'optionEditPath' => 'civicrm/admin/options/accept_creditcard',
+        ],
+      ],
+      [
+        'name' => 'trxn_result_code',
+        'data_type' => 'String',
+        'description' => E::ts('Transaction Result Code'),
+      ],
+      [
+        'name' => 'trxn_id',
+        'data_type' => 'String',
+        'description' => E::ts('Transaction ID supplied by external processor. This may not be unique.'),
+      ],
+      [
+        'name' => 'order_reference',
+        'data_type' => 'String',
+        'description' => E::ts('Payment Processor external order reference'),
+      ],
+      [
+        'name' => 'check_number',
+        'data_type' => 'String',
+        'description' => E::ts('Check Number'),
+      ],
+      [
+        'name' => 'pan_truncation',
+        'type' => 'String',
+        'description' => E::ts('PAN Truncation (Last 4 digits of credit card)'),
+      ],
+    ];
+    $customFields = CustomField::get(FALSE)
+      ->addSelect('custom_group_id:name', 'name', 'label', 'data_type')
+      ->addWhere('custom_group_id.extends', '=', 'FinancialTrxn')
+      ->execute();
+    foreach ($customFields as $customField) {
+      $customField['name'] = $customField['custom_group_id:name'] . '.' . $customField['name'];
+      unset($customField['id'], $customField['custom_group_id:name']);
+      $customField['description'] = $customField['label'];
+      $fields[] = $customField;
+    }
+    return $fields;
+  }
+
+  public function fields(): array {
+    return self::getCreateFields();
+  }
+
+  /**
+   *
+   * Note that the result class is that of the annotation below, not the h
+   * in the method (which must match the parent class)
+   *
+   * @var \Civi\Api4\Generic\Result $result
+   */
+  public function _run(\Civi\Api4\Generic\Result $result) {
+    $trxn = \CRM_Financial_BAO_Payment::create($this->values);
+
+    $customFields = CustomField::get(FALSE)
+      ->addSelect('id', 'custom_group_id:name', 'name', 'label', 'data_type')
+      ->addWhere('custom_group_id.extends', '=', 'FinancialTrxn')
+      ->execute();
+    foreach ($customFields as $customField) {
+      $key = $customField['custom_group_id:name'] . '.' . $customField['name'];
+      if (isset($this->values[$key])) {
+        $customParams['custom_' . $customField['id']] = $this->values[$key];
+      }
+    }
+    if (!empty($customParams)) {
+      $customParams['entity_id'] = $trxn->id;
+      civicrm_api3('CustomValue', 'create', $customParams);
+    }
+
+    $result->exchangeArray($trxn);
+    return $result;
+  }
+
+}

Civi/Api4/Action/PriceFieldValue/GetDefaultPriceFieldValueForContributionMJW.php

+<?php
+namespace Civi\Api4\Action\PriceFieldValue;
+
+use Civi\Api4\PriceField;
+use Civi\Api4\PriceFieldValue;
+
+/**
+ * This API Action gets the default price_field_value_id for a contribution
+ *
+ */
+class GetDefaultPriceFieldValueForContributionMJW extends \Civi\Api4\Generic\AbstractQueryAction {
+
+  /**
+   *
+   *  Get the default price_field_id and price_field_value_id for a contribution
+   *
+   * $result = ['price_field_id' = X, 'price_field_value_id' = Y, 'label' = price_field_value.label]
+   *
+   * Note that the result class is that of the annotation below, not the hint
+   * in the method (which must match the parent class)
+   *
+   * @var \Civi\Api4\Generic\Result $result
+   */
+  public function _run(\Civi\Api4\Generic\Result $result) {
+    $priceSetName = 'default_contribution_amount';
+    $priceField = PriceField::get(FALSE)
+      ->addWhere('price_set_id:name', '=', $priceSetName)
+      ->addOrderBy('id', 'ASC')
+      ->execute()
+      ->first();
+    // Now get the relevant PriceFieldValue for the MembershipType.
+    $priceFieldValue = PriceFieldValue::get(FALSE)
+      ->addWhere('price_field_id', '=', $priceField['id'])
+      ->execute()
+      ->first();
+    $results = [
+      'price_field_id' => $priceField['id'],
+      'price_field_value_id' => $priceFieldValue['id'],
+      'label' => $priceFieldValue['label'],
+    ];
+
+    $result->exchangeArray($results);
+    return $result;
+  }
+
+}

Civi/Api4/Action/PriceFieldValue/GetDefaultPriceFieldValueForMembershipMJW.php

+<?php
+namespace Civi\Api4\Action\PriceFieldValue;
+
+use Civi\Api4\PriceField;
+use Civi\Api4\PriceFieldValue;
+
+/**
+ * This API Action gets the default price_field_value_id for the specified membership
+ *
+ * @property int $membershipID
+ */
+class GetDefaultPriceFieldValueForMembershipMJW extends \Civi\Api4\Generic\AbstractAction {
+
+  /**
+   * The Membership ID
+   *
+   * @var int
+   * @required
+   */
+  protected int $membershipID = 0;
+
+  /**
+   *
+   * Get the default price_field_id and price_field_value_id for the membership
+   *
+   * $result = ['price_field_id' = X, 'price_field_value_id' = Y, 'label' = price_field_value.label]
+   *
+   * Note that the result class is that of the annotation below, not the hint
+   * in the method (which must match the parent class)
+   *
+   * @var \Civi\Api4\Generic\Result $result
+   */
+  public function _run(\Civi\Api4\Generic\Result $result) {
+    if (empty($this->membershipID)) {
+      throw new \CRM_Core_Exception('Membership ID is required');
+    }
+    // First we need membership_type_id.member_of_contact_id and membership_type_id to find the PriceFieldValue.
+    $membership = \Civi\Api4\Membership::get(FALSE)
+      ->addSelect('membership_type_id.member_of_contact_id', 'membership_type_id')
+      ->addWhere('id', '=', $this->membershipID)
+      ->execute()
+      ->first();
+
+    // PriceFields and Membership Types...
+    // There is a default PriceSet for contributions with name="default_contribution_amount"
+    // There is a default PriceSet for memberships with name="default_membership_type_amount"
+    // Each MembershipType has a "member_of_contact_id" which gets used as a FK reference in PriceField.name
+    // Each MembershipType has a PriceFieldValue with PriceFieldValue.membership_type_id = Membership Type
+    // Why all this? Well we could (and probably do) have multiple PriceSets that include the same MembershipType but
+    //   different prices. But only one of them will be linked to the default PriceSet.
+    // Confused yet?
+
+    // Get the default price field ID for memberships from the default membership PriceSet and the member_of_contact_id
+    $priceField = PriceField::get(FALSE)
+      ->addWhere('price_set_id:name', '=', 'default_membership_type_amount')
+      ->addWhere('name', '=', $membership['membership_type_id.member_of_contact_id'])
+      ->addOrderBy('id', 'ASC')
+      ->execute()
+      ->first();
+
+    // Now get the relevant PriceFieldValue for the MembershipType.
+    $priceFieldValue = PriceFieldValue::get(FALSE)
+      ->addWhere('price_field_id', '=', $priceField['id'])
+      ->addWhere('membership_type_id', '=', $membership['membership_type_id'])
+      ->execute()
+      ->first();
+
+    $results = [
+      'price_field_id' => $priceField['id'],
+      'price_field_value_id' => $priceFieldValue['id'],
+      'label' => $priceFieldValue['label'],
+    ];
+
+    $result->exchangeArray($results);
+    return $result;
+  }
+
+}

Civi/Api4/PaymentMJW.php

+<?php
+
+namespace Civi\Api4;
+
+/**
+ * A collection of system maintenance/diagnostic utilities.
+ *
+ * @searchable none
+ * @since 5.19
+ * @package Civi\Api4
+ */
+class PaymentMJW extends Generic\AbstractEntity {
+
+  /**
+   * @param bool $checkPermissions
+   * @return Generic\BasicGetFieldsAction
+   */
+  public static function getFields($checkPermissions = TRUE) {
+    return (new Generic\BasicGetFieldsAction(__CLASS__, __FUNCTION__, function() {
+      return [];
+    }))->setCheckPermissions($checkPermissions);
+  }
+
+}

Civi/Api4/PaymentprocessorWebhook.php

 <?php
 namespace Civi\Api4;
 
-use Civi\Api4\Generic\BasicReplaceAction;
-use Civi\Api4\Generic\DAOCreateAction;
-use Civi\Api4\Generic\DAODeleteAction;
-use Civi\Api4\Generic\DAOGetAction;
-use Civi\Api4\Generic\DAOGetFieldsAction;
-use Civi\Api4\Generic\DAOSaveAction;
-use Civi\Api4\Generic\DAOUpdateAction;
-
 /**
  * PaymentprocessorWebhook entity.
  *
@@ -18,43 +10,4 @@ use Civi\Api4\Generic\DAOUpdateAction;
  */
 class PaymentprocessorWebhook extends Generic\DAOEntity {
 
-  /**
-   * @param bool $checkPermissions
-   * @return DAOGetAction
-   */
-  public static function get($checkPermissions = TRUE) {
-    return (new DAOGetAction(static::class, __FUNCTION__))
-      ->setCheckPermissions($checkPermissions)
-      ->addWhere('payment_processor.domain_id', '=', \CRM_Core_Config::domainID());
-  }
-
-  /**
-   * @param bool $checkPermissions
-   * @return DAOUpdateAction
-   */
-  public static function update($checkPermissions = TRUE) {
-    return (new DAOUpdateAction(static::class, __FUNCTION__))
-      ->setCheckPermissions($checkPermissions)
-      ->addWhere('payment_processor.domain_id', '=', \CRM_Core_Config::domainID());
-  }
-
-  /**
-   * @param bool $checkPermissions
-   * @return DAODeleteAction
-   */
-  public static function delete($checkPermissions = TRUE) {
-    return (new DAODeleteAction(static::class, __FUNCTION__))
-      ->setCheckPermissions($checkPermissions)
-      ->addWhere('payment_processor.domain_id', '=', \CRM_Core_Config::domainID());
-  }
-
-  /**
-   * @param bool $checkPermissions
-   * @return BasicReplaceAction
-   */
-  public static function replace($checkPermissions = TRUE) {
-    return (new BasicReplaceAction(static::class, __FUNCTION__))
-      ->setCheckPermissions($checkPermissions)
-      ->addWhere('payment_processor.domain_id', '=', \CRM_Core_Config::domainID());
-  }
 }

Civi/MJW/Logger.php

+<?php
+
+namespace Civi\MJW;
+
+
+/**
+ * Abstracts the Civi::log class so that we:
+ *   - Don't have to specify channel each time we log.
+ *   - Automatically log the entityID/name if provided.
+ */
+class Logger {
+
+  /**
+   * The Log channel
+   *
+   * @var string
+   */
+  private string $logChannel = '';
+
+  /**
+   * The entityID/Name
+   *
+   * @var string
+   */
+  private string $logEntity = '';
+
+  public function __construct(string $logChannel, string $logEntity) {
+    $this->logChannel = $logChannel;
+    $this->logEntity = $logEntity;
+  }
+
+  /**
+   * Log an info message with payment processor prefix
+   * @param string $message
+   *
+   * @return void
+   */
+  public function logInfo(string $message) {
+    $this->log('info', $message);
+  }
+
+  /**
+   * Log an error message with payment processor prefix
+   *
+   * @param string $message
+   *
+   * @return void
+   */
+  public function logError(string $message) {
+    $this->log('error', $message);
+  }
+
+  /**
+   * Log a debug message with payment processor prefix
+   *
+   * @param string $message
+   *
+   * @return void
+   */
+  public function logDebug(string $message) {
+    $this->log('debug', $message);
+  }
+
+  /**
+   * @param string $level
+   * @param string $message
+   *
+   * @return void
+   */
+  private function log(string $level, string $message) {
+    $channel = $this->logChannel;
+    $prefix = $channel . '(' . $this->logEntity . '): ';
+    \Civi::log($channel)->$level($prefix . $message);
+  }
+}
\ No newline at end of file

Civi/MJW/Payment/Membership.php

+<?php
+
+namespace Civi\MJW\Payment;
+
+use Civi\Api4\Contribution;
+use Civi\Api4\ContributionRecur;
+use Civi\Api4\LineItem;
+use Civi\Core\Service\AutoService;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * @internal
+ * @service
+ */
+class Membership extends AutoService implements EventSubscriberInterface {
+
+  /**
+   * @return array
+   */
+  public static function getSubscribedEvents() {
+    return [
+      'hook_civicrm_pre' => ['on_hook_civicrm_pre', 150],
+    ];
+  }
+
+  /**
+   * Force setting entity_table / entity_id in LineItem.create (for update)
+   *
+   * @param \Civi\Core\Event\PreEvent $event
+   *
+   * @return void
+   */
+  public function on_hook_civicrm_pre(\Civi\Core\Event\PreEvent $event) {
+    if ($event->entity !== 'LineItem' || $event->action !== 'edit') {
+      return;
+    }
+    // API3 LineItem.create removes entity_table/entity_id before saving.
+    // We add them after LineItem.create removed them but before save!
+    if (isset($event->params['entity_table_force'])) {
+      $event->params['entity_table'] = $event->params['entity_table_force'];
+      unset($event->params['entity_table_force']);
+    }
+    if (isset($event->params['entity_id_force'])) {
+      $event->params['entity_id'] = $event->params['entity_id_force'];
+      unset($event->params['entity_id_force']);
+    }
+  }
+
+  /**
+   * Update and Link Membership to Contribution LineItem and Recur
+   *
+   * @param int $membershipID
+   * @param int|null $contributionID
+   * @param int|null $contributionRecurID
+   *
+   * @return array The various entity IDs
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  public function linkMembershipToRecur(int $membershipID, $contributionID = NULL, $contributionRecurID = NULL): array {
+    // Get contribution ID from the recur if possible
+    if (empty($contributionID) && !empty($contributionRecurID)) {
+      $contributionID = \CRM_Contribute_BAO_ContributionRecur::ensureTemplateContributionExists($contributionRecurID);
+    }
+
+    // First the simple bit! Link the membership to the contributionRecur record if we have one
+    if ($contributionRecurID) {
+      \Civi\Api4\Membership::update(FALSE)
+        ->addWhere('id', '=', $membershipID)
+        ->addValue('contribution_recur_id', $contributionRecurID)
+        ->execute()
+        ->first();
+    }
+
+    // Now we need to update the LineItems on the contribution so that renewals etc. work properly.
+    $priceFieldValues = \Civi\Api4\PriceFieldValue::getDefaultPriceFieldValueForMembershipMJW(FALSE)
+      ->setMembershipID($membershipID)
+      ->execute();
+
+    // Now get the LineItems for the contribution
+    $lineItems = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $contributionID)
+      ->execute();
+    if ($lineItems->count() > 1) {
+      throw new \CRM_Core_Exception('ContributionID: ' . $contributionID . ' has more than one lineitem. Not linking membership as I don\'t know what to do');
+      // @todo: Maybe search them for a LineItem matching this membership type?
+    }
+
+    // Get the membership FinancialType so we can update the Contribution,Recur and LineItem.
+    $membership = \Civi\Api4\Membership::get(FALSE)
+      ->addSelect('membership_type_id.financial_type_id')
+      ->addWhere('id', '=', $membershipID)
+      ->execute()
+      ->first();
+
+    // Update the contributionRecur with the new FinancialType
+    if (!empty($contributionRecurID)) {
+      ContributionRecur::update(FALSE)
+        ->addWhere('id', '=', $contributionRecurID)
+        ->addValue('financial_type_id', $membership['membership_type_id.financial_type_id'])
+        ->execute();
+    }
+    // Update the contribution with the new FinancialType
+    if (!empty($contributionID)) {
+      Contribution::update(FALSE)
+        ->addWhere('id', '=', $contributionID)
+        ->addValue('financial_type_id', $membership['membership_type_id.financial_type_id'])
+        ->execute();
+    }
+
+    // Finally, Update the LineItem to map to a membership
+    civicrm_api3('LineItem', 'create', [
+      'entity_id' => $membershipID,
+      'id' => $lineItems->first()['id'],
+      'entity_table' => 'civicrm_membership',
+      'price_field_id' => $priceFieldValues['price_field_id'],
+      'price_field_value_id' => $priceFieldValues['price_field_value_id'],
+      'label' => $priceFieldValues['label'],
+      'financial_type_id' => $membership['membership_type_id.financial_type_id'],
+      // API3 LineItem.create removes entity_table/entity_id before saving.
+      // We add them here so we can add them back in using hook_civicrm_pre (implemented in on_hook_civicrm_pre).
+      'entity_table_force' => 'civicrm_membership',
+      'entity_id_force' => $membershipID,
+    ]);
+
+    return [
+      'lineItemID' => $lineItems->first()['id'],
+      'contributionRecurID' => $contributionRecurID ?? NULL,
+      'contributionID' => $contributionID,
+      'membershipID' => $membershipID,
+      'action' => 'link',
+    ];
+  }
+
+  /**
+   * Update and Link Membership to Contribution LineItem and Recur
+   *
+   * @param int $membershipID
+   * @param int|null $contributionID
+   * @param int|null $contributionRecurID
+   *
+   * @return array The various entity IDs
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  public function unlinkMembershipFromRecur(int $membershipID, $contributionID = NULL, $contributionRecurID = NULL): array {
+    if (empty($contributionID) && empty($contributionRecurID)) {
+      $contributionRecurID = \Civi\Api4\Membership::get(FALSE)
+        ->addSelect('contribution_recur_id')
+        ->addWhere('id', '=', $membershipID)
+        ->execute()
+        ->first()['contribution_recur_id'];
+      if (empty($contributionRecurID)) {
+        throw new \CRM_Core_Exception('Membership ' . $membershipID . ' does not have a contribution_recur_id. Cannot unlink!');
+      }
+    }
+
+    // Get contribution ID from the recur if possible
+    if (empty($contributionID) && !empty($contributionRecurID)) {
+      $contributionID = \CRM_Contribute_BAO_ContributionRecur::ensureTemplateContributionExists($contributionRecurID);
+    }
+
+    // First the simple bit! Remove the contribution_recur_id from the membership
+    if ($contributionRecurID) {
+      \Civi\Api4\Membership::update(FALSE)
+        ->addWhere('id', '=', $membershipID)
+        ->addValue('contribution_recur_id', NULL)
+        ->execute()
+        ->first();
+    }
+
+    // Now we need to update the LineItems on the contribution so that renewals etc. work properly.
+    $priceFieldValues = \Civi\Api4\PriceFieldValue::getDefaultPriceFieldValueForContributionMJW(FALSE)->execute();
+
+    // Now get the LineItems for the contribution
+    $lineItems = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $contributionID)
+      ->execute();
+    if ($lineItems->count() > 1) {
+      throw new \CRM_Core_Exception('ContributionID: ' . $contributionID . ' has more than one lineitem. Not unlinking membership as I don\'t know what to do');
+      // @todo: Maybe search them for a LineItem matching this membership type?
+    }
+
+    // @todo Maybe change the financial type on contribution/recur to default / "Donation".
+    // But not sure what would be best as we don't have an obvious default (when linking we use Membership financialType).
+
+    // Finally, Update the LineItem to map to a contribution
+    $newLineItem = civicrm_api3('LineItem', 'create', [
+      'entity_id' => $contributionID,
+      'id' => $lineItems->first()['id'],
+      'entity_table' => 'civicrm_contribution',
+      'price_field_id' => $priceFieldValues['price_field_id'],
+      'price_field_value_id' => $priceFieldValues['price_field_value_id'],
+      'label' => $priceFieldValues['label'],
+      // 'financial_type_id' => $membership['membership_type_id.financial_type_id'],
+      // API3 LineItem.create removes entity_table/entity_id before saving.
+      // We add them here so we can add them back in using hook_civicrm_pre (implemented in on_hook_civicrm_pre).
+      'entity_table_force' => 'civicrm_contribution',
+      'entity_id_force' => $contributionID,
+    ]);
+
+    return [
+      'lineItemID' => $lineItems->first()['id'],
+      'contributionRecurID' => $contributionRecurID ?? NULL,
+      'contributionID' => $contributionID,
+      'membershipID' => $membershipID,
+      'action' => 'unlink',
+    ];
+  }
+
+}

Civi/MJW/Payment/Subscription.php

+<?php
+
+namespace Civi\MJW\Payment;
+
+use Brick\Money\Money;
+use Civi\Api4\Contribution;
+use Civi\Api4\ContributionRecur;
+
+class Subscription {
+
+  /**
+   * The ContributionRecur as retrieved by API4.
+   *
+   * @var array
+   */
+  protected array $recur;
+
+  public function setRecur(array $recur) {
+    $this->recur = $recur;
+  }
+
+  public function getRecur(): array {
+    return $this->recur;
+  }
+
+  /**
+   * Updates the ContributionRecur entity, and if a template contribution
+   * exists, update that along with its single line item.
+   *
+   * @param \Brick\Money\Money $newAmount
+   *
+   * @return array
+   * @throws \Brick\Money\Exception\MoneyMismatchException
+   * @throws \Brick\Money\Exception\UnknownCurrencyException
+   * @throws \CRM_Core_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   * @throws \Civi\Core\Exception\DBQueryException
+   */
+  public function updateRecurAndTemplateContributionAmount(Money $newAmount): array {
+    $recur = $this->getRecur();
+    if (empty($recur)) {
+      throw new \CRM_Core_Exception('Must set recur first');
+    }
+
+    // Check if amount is the same
+    if (Money::of($recur['amount'], $recur['currency'])->compareTo($newAmount) === 0) {
+      \Civi::log()->debug('nothing to do. Amount is already the same');
+      return $recur;
+    }
+
+    // Get the template contribution
+    // Calling ensureTemplateContributionExists will *always* return a template contribution
+    //   Either it will have created one or will return the one that already exists.
+    $templateContributionID = \CRM_Contribute_BAO_ContributionRecur::ensureTemplateContributionExists($recur['id']);
+
+    // Now we update the template contribution with the new details
+    // This will automatically update the Contribution LineItems as well.
+    Contribution::update(FALSE)
+      ->addValue('id', $templateContributionID)
+      ->addValue('total_amount', $newAmount->getAmount()->toFloat())
+      ->addWhere('id', '=', $templateContributionID)
+      ->execute()
+      ->first();
+
+    // Update the recur
+    // If we update a template contribution the recur will automatically be updated
+    // (see CRM_Contribute_BAO_Contribution::self_hook_civicrm_post)
+    // We need to make sure we updated the template contribution first because
+    //   CRM_Contribute_BAO_ContributionRecur::self_hook_civicrm_post will also try to update it.
+    $this->setRecur(ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $recur['id'])
+      ->execute()
+      ->first());
+
+    return $this->getRecur();
+  }
+
+}