From 66de72bcae7a27b27a1f5def6a3da39cfe92eb8c Mon Sep 17 00:00:00 2001
From: eileen <emcnaughton@wikimedia.org>
Date: Sat, 6 Feb 2021 13:34:38 +1300
Subject: [PATCH] [REF] Use form property rather than formValues to pass
 generated invoice ID

formValues is 'sort of' the array for 'submittedValues' but it has stuff added to it
& passed around. This is part of an attempt to make it clearer where
various values come from to faciliate cleaning up the code and
removing some of the very many arrays in use.
---
 CRM/Contribute/Form/AbstractEditPayment.php | 23 +++++++++++++++++++++
 CRM/Member/Form/Membership.php              | 10 ++++-----
 CRM/Member/Form/MembershipRenewal.php       |  4 ++--
 3 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php
index cdf5b2f6a1..9c6ee35599 100644
--- a/CRM/Contribute/Form/AbstractEditPayment.php
+++ b/CRM/Contribute/Form/AbstractEditPayment.php
@@ -216,6 +216,29 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task {
    */
   protected $submittableMoneyFields = ['total_amount', 'net_amount', 'non_deductible_amount', 'fee_amount'];
 
+  /**
+   * Invoice ID.
+   *
+   * This is a generated unique string.
+   *
+   * @var string
+   */
+  protected $invoiceID;
+
+  /**
+   * Get the unique invoice ID.
+   *
+   * This is generated if one has not already been generated.
+   *
+   * @return string
+   */
+  public function getInvoiceID(): string {
+    if (!$this->invoiceID) {
+      $this->invoiceID = md5(uniqid(mt_rand(), TRUE));
+    }
+    return $this->invoiceID;
+  }
+
   /**
    * Pre process function with common actions.
    *
diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php
index df2c662d4d..f5e5e7c251 100644
--- a/CRM/Member/Form/Membership.php
+++ b/CRM/Member/Form/Membership.php
@@ -1257,7 +1257,7 @@ DESC limit 1");
       // @todo this is a candidate for beginPostProcessFunction.
       $formValues['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
       $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
-      $formValues['invoiceID'] = md5(uniqid(rand(), TRUE));
+      $formValues['invoiceID'] = $this->getInvoiceID();
       $formValues['financial_type_id'] = $params['financial_type_id'];
 
       // at this point we've created a contact and stored its address etc
@@ -1354,7 +1354,7 @@ DESC limit 1");
       }
       $now = CRM_Utils_Time::date('YmdHis');
       $params['receive_date'] = CRM_Utils_Time::date('Y-m-d H:i:s');
-      $params['invoice_id'] = $formValues['invoiceID'];
+      $params['invoice_id'] = $this->getInvoiceID();
       $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
         [1 => $this->getSelectedMembershipLabels(), 2 => $userName]
       );
@@ -1866,7 +1866,7 @@ DESC limit 1");
     $contributionParams = array_merge([
       'receive_date' => !empty($params['receive_date']) ? CRM_Utils_Date::processDate($params['receive_date']) : CRM_Utils_Time::date('YmdHis'),
       'tax_amount' => $params['tax_amount'] ?? NULL,
-      'invoice_id' => $params['invoiceID'],
+      'invoice_id' => $this->getInvoiceID(),
       'currency' => $params['currencyID'],
       'is_pay_later' => $params['is_pay_later'] ?? 0,
       //setting to make available to hook - although seems wrong to set on form for BAO hook availability
@@ -1925,13 +1925,13 @@ DESC limit 1");
     if (!empty($params['receive_date'])) {
       $recurParams['start_date'] = date('YmdHis', CRM_Utils_Time::strtotime($params['receive_date']));
     }
-    $recurParams['invoice_id'] = $params['invoiceID'] ?? NULL;
+    $recurParams['invoice_id'] = $this->getInvoiceID();
     $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
     $recurParams['payment_processor_id'] = $params['payment_processor_id'] ?? NULL;
     $recurParams['is_email_receipt'] = (bool) $this->getSubmittedValue('send_receipt');
     // we need to add a unique trxn_id to avoid a unique key error
     // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
-    $recurParams['trxn_id'] = $params['trxn_id'] ?? $params['invoiceID'];
+    $recurParams['trxn_id'] = $params['trxn_id'] ?? $this->getInvoiceID();
 
     $campaignId = $params['campaign_id'] ?? $this->_values['campaign_id'] ?? NULL;
     $recurParams['campaign_id'] = $campaignId;
diff --git a/CRM/Member/Form/MembershipRenewal.php b/CRM/Member/Form/MembershipRenewal.php
index e57e54550f..e54260b56c 100644
--- a/CRM/Member/Form/MembershipRenewal.php
+++ b/CRM/Member/Form/MembershipRenewal.php
@@ -507,7 +507,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form {
     $this->assign('module', 'Membership');
     $this->assign('receiptType', 'membership renewal');
     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
-    $this->_params['invoice_id'] = $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
+    $this->_params['invoice_id'] = $this->getInvoiceID();
 
     if (!empty($this->_params['send_receipt'])) {
       $this->_params['receipt_date'] = $now;
@@ -546,7 +546,7 @@ class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form {
           'financial_type_id' => $this->_params['financial_type_id'],
           'is_email_receipt' => !empty($this->_params['send_receipt']),
           'payment_instrument_id' => $this->_params['payment_instrument_id'],
-          'invoice_id' => $this->_params['invoice_id'],
+          'invoice_id' => $this->getInvoiceID(),
         ], $paymentParams['membership_type_id'][1]);
 
         $contributionRecurID = $contributionRecurParams['contributionRecurID'];
-- 
2.25.1