From 383e392ff03679dc97e754f009747cfe59a75dd0 Mon Sep 17 00:00:00 2001 From: "B. Endres" Date: Fri, 22 Nov 2019 15:04:51 +0100 Subject: [PATCH 1/5] [#13] removed ::isSDD dependency from CiviSEPA --- CRM/Twingle/Form/Profile.php | 15 +-------------- CRM/Twingle/Tools.php | 2 +- api/v3/TwingleDonation/Cancel.php | 2 +- api/v3/TwingleDonation/Endrecurring.php | 2 +- 4 files changed, 4 insertions(+), 17 deletions(-) diff --git a/CRM/Twingle/Form/Profile.php b/CRM/Twingle/Form/Profile.php index 59dee93..33fecfc 100644 --- a/CRM/Twingle/Form/Profile.php +++ b/CRM/Twingle/Form/Profile.php @@ -602,20 +602,7 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { // enabled. if ( CRM_Twingle_Submission::civiSepaEnabled() - && ( - ( - method_exists('CRM_Sepa_Logic_PaymentInstruments', 'isSDD') - && CRM_Sepa_Logic_PaymentInstruments::isSDD(array( - 'payment_instrument_id' => $payment_instrument['value'], - )) - ) - || ( - method_exists('CRM_Sepa_Logic_Settings', 'isSDD') - && CRM_Sepa_Logic_Settings::isSDD(array( - 'payment_instrument_id' => $payment_instrument['value'], - )) - ) - ) + && CRM_Twingle_Tools::isSDD($payment_instrument['value']) ) { if (!isset(self::$_paymentInstruments['sepa'])) { self::$_paymentInstruments['sepa'] = E::ts('CiviSEPA'); diff --git a/CRM/Twingle/Tools.php b/CRM/Twingle/Tools.php index 6af1999..787d10c 100644 --- a/CRM/Twingle/Tools.php +++ b/CRM/Twingle/Tools.php @@ -55,7 +55,7 @@ class CRM_Twingle_Tools { 'id' => $recurring_contribution_id]); // check if this is a SEPA transaction - //if (self::isSDD($recurring_contribution['payment_instrument_id'])) return; + if (self::isSDD($recurring_contribution['payment_instrument_id'])) return; // check if it's really a termination (i.e. current status is 2 or 5) if (!in_array($recurring_contribution['contribution_status_id'], [2,5])) return; diff --git a/api/v3/TwingleDonation/Cancel.php b/api/v3/TwingleDonation/Cancel.php index 4883217..bfd49e3 100644 --- a/api/v3/TwingleDonation/Cancel.php +++ b/api/v3/TwingleDonation/Cancel.php @@ -97,7 +97,7 @@ function civicrm_api3_twingle_donation_Cancel($params) { // End SEPA mandate if applicable. if ( CRM_Twingle_Submission::civiSepaEnabled() - && CRM_Sepa_Logic_Settings::isSDD($contribution) + && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); // Mandates can not be terminated in the past. diff --git a/api/v3/TwingleDonation/Endrecurring.php b/api/v3/TwingleDonation/Endrecurring.php index aa5d967..c5015cb 100644 --- a/api/v3/TwingleDonation/Endrecurring.php +++ b/api/v3/TwingleDonation/Endrecurring.php @@ -80,7 +80,7 @@ function civicrm_api3_twingle_donation_endrecurring($params) { // recurring contributions. if ( CRM_Twingle_Submission::civiSepaEnabled() - && CRM_Sepa_Logic_Settings::isSDD($contribution) + && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); // Mandates can not be terminated in the past. From 24d93ed1f1e767e913ce4dce020585ace642492e Mon Sep 17 00:00:00 2001 From: "B. Endres" Date: Sat, 23 Nov 2019 08:46:23 +0100 Subject: [PATCH 2/5] [#13] fixed end date issues --- api/v3/TwingleDonation/Endrecurring.php | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/api/v3/TwingleDonation/Endrecurring.php b/api/v3/TwingleDonation/Endrecurring.php index c5015cb..cdd0533 100644 --- a/api/v3/TwingleDonation/Endrecurring.php +++ b/api/v3/TwingleDonation/Endrecurring.php @@ -83,11 +83,16 @@ function civicrm_api3_twingle_donation_endrecurring($params) { && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); - // Mandates can not be terminated in the past. - $end_date = date('Ymd', max( - time(), - date_create_from_format('Ymd', $params['cancelled_at'])->getTimestamp() - )); + $end_date = date_create_from_format('Ymd', $params['ended_at']); + if ($end_date) { + // Mandates can not be terminated in the past: + $end_date = date('Ymd', max( + time(), + $end_date->getTimestamp())); + } else { + // end date couldn't be parsed, use 'now' + $end_date = date('Ymd'); + } // verify that the mandate has not been terminated in the past $mandate_status = civicrm_api3('SepaMandate', 'getvalue', ['return' => 'status', 'id' => $mandate_id]); @@ -115,9 +120,9 @@ function civicrm_api3_twingle_donation_endrecurring($params) { else { CRM_Twingle_Tools::$protection_suspended = TRUE; $contribution = civicrm_api3('ContributionRecur', 'create', array( - 'id' => $contribution['id'], - 'end_date' => $params['ended_at'], - 'contribution_status_id' => CRM_Twingle_Submission::CONTRIBUTION_STATUS_COMPLETED, + 'id' => $contribution['id'], + 'end_date' => $params['ended_at'], + 'contribution_status_id' => CRM_Twingle_Submission::CONTRIBUTION_STATUS_COMPLETED, )); CRM_Twingle_Tools::$protection_suspended = FALSE; } From e8bb3a42cc754decf6bd292a9a06dff9d40cfba7 Mon Sep 17 00:00:00 2001 From: "B. Endres" Date: Mon, 25 Nov 2019 08:52:46 +0100 Subject: [PATCH 3/5] [#13] removed SEPA::getMandateFor dependency --- CRM/Twingle/Tools.php | 37 +++++++++++++++++++++++++ api/v3/TwingleDonation/Cancel.php | 30 +++++++++++++++----- api/v3/TwingleDonation/Endrecurring.php | 18 +++++++++--- 3 files changed, 74 insertions(+), 11 deletions(-) diff --git a/CRM/Twingle/Tools.php b/CRM/Twingle/Tools.php index 787d10c..08a596f 100644 --- a/CRM/Twingle/Tools.php +++ b/CRM/Twingle/Tools.php @@ -91,4 +91,41 @@ class CRM_Twingle_Tools { } return in_array($payment_instrument_id, $sepa_payment_instruments); } + + /** + * Get a CiviSEPA mandate for the given contribution ID + * + * @param $contribution_id integer contribution ID *or* recurring contribution ID + * @return integer mandate ID or null + */ + public static function getMandateFor($contribution_id) { + $contribution_id = (int) $contribution_id; + if ($contribution_id) { + try { + // try recurring mandate + $rcur_mandate = civicrm_api3('SepaMandate', 'get', [ + 'entity_id' => $contribution_id, + 'entity_table' => 'civicrm_contribution_recur', + 'type' => 'RCUR', + ]); + if ($rcur_mandate['count'] == 1) { + return reset($rcur_mandate['values']); + } + + // try OOFF mandate + // try recurring mandate + $ooff_mandate = civicrm_api3('SepaMandate', 'get', [ + 'entity_id' => $contribution_id, + 'entity_table' => 'civicrm_contribution', + 'type' => 'OOFF', + ]); + if ($ooff_mandate['count'] == 1) { + return reset($ooff_mandate['values']); + } + } catch (Exception $ex) { + Civi::log()->error("CRM_Twingle_Tools::getMandate failde for [{$contribution_id}]: " . $ex->getMessage()); + } + } + return NULL; + } } diff --git a/api/v3/TwingleDonation/Cancel.php b/api/v3/TwingleDonation/Cancel.php index bfd49e3..32a4e95 100644 --- a/api/v3/TwingleDonation/Cancel.php +++ b/api/v3/TwingleDonation/Cancel.php @@ -72,7 +72,7 @@ function civicrm_api3_twingle_donation_Cancel($params) { try { // Validate date for parameter "cancelled_at". - if (!DateTime::createFromFormat('YmdHis', $params['cancelled_at'])) { + if (!DateTime::createFromFormat('Ymd', $params['cancelled_at'])) { throw new CiviCRM_API3_Exception( E::ts('Invalid date for parameter "cancelled_at".'), 'invalid_format' @@ -94,17 +94,32 @@ function civicrm_api3_twingle_donation_Cancel($params) { $contribution_type = 'ContributionRecur'; } - // End SEPA mandate if applicable. if ( CRM_Twingle_Submission::civiSepaEnabled() && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { - $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); + // End SEPA mandate if applicable. + $mandate = CRM_Twingle_Tools::getMandateFor($contribution['id']); + if (!$mandate) { + throw new CiviCRM_API3_Exception( + E::ts("SEPA Mandate for contribution [%1 not found.", [1 => $contribution['id']]), + 'api_error' + ); + } + $mandate_id = (int) $mandate['id']; + // Mandates can not be terminated in the past. - $end_date = date('Ymd', max( - time(), - date_create_from_format('Ymd', $params['cancelled_at'])->getTimestamp() - )); + $end_date = date_create_from_format('Ymd', $params['cancelled_at']); + if ($end_date) { + // Mandates can not be terminated in the past: + $end_date = date('Ymd', max( + time(), + $end_date->getTimestamp())); + } else { + // end date couldn't be parsed, use 'now' + $end_date = date('Ymd'); + } + if (!CRM_Sepa_BAO_SEPAMandate::terminateMandate( $mandate_id, $end_date, @@ -122,6 +137,7 @@ function civicrm_api3_twingle_donation_Cancel($params) { )); } else { + // regular contribution CRM_Twingle_Tools::$protection_suspended = TRUE; $contribution = civicrm_api3($contribution_type, 'create', array( 'id' => $contribution['id'], diff --git a/api/v3/TwingleDonation/Endrecurring.php b/api/v3/TwingleDonation/Endrecurring.php index cdd0533..318b115 100644 --- a/api/v3/TwingleDonation/Endrecurring.php +++ b/api/v3/TwingleDonation/Endrecurring.php @@ -76,14 +76,24 @@ function civicrm_api3_twingle_donation_endrecurring($params) { $contribution = civicrm_api3('ContributionRecur', 'getsingle', array( 'trxn_id' => $default_profile->getTransactionID($params['trx_id']), )); + // End SEPA mandate (which ends the associated recurring contribution) or // recurring contributions. if ( CRM_Twingle_Submission::civiSepaEnabled() && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { - $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); - $end_date = date_create_from_format('Ymd', $params['ended_at']); + // END SEPA MANDATE + $mandate = CRM_Twingle_Tools::getMandateFor($contribution['id']); + if (!$mandate) { + throw new CiviCRM_API3_Exception( + E::ts("SEPA Mandate for recurring contribution [%1 not found.", [1 => $contribution['id']]), + 'api_error' + ); + } + + $mandate_id = $mandate['id']; + $end_date = date_create_from_format('YmdHis', $params['ended_at']); if ($end_date) { // Mandates can not be terminated in the past: $end_date = date('Ymd', max( @@ -95,8 +105,7 @@ function civicrm_api3_twingle_donation_endrecurring($params) { } // verify that the mandate has not been terminated in the past - $mandate_status = civicrm_api3('SepaMandate', 'getvalue', ['return' => 'status', 'id' => $mandate_id]); - if ($mandate_status != 'FRST' && $mandate_status != 'RCUR') { + if ($mandate['status'] != 'FRST' && $mandate['status'] != 'RCUR') { throw new CiviCRM_API3_Exception( E::ts("SEPA Mandate [%1] already terminated.", [1 => $mandate_id]), 'api_error' @@ -118,6 +127,7 @@ function civicrm_api3_twingle_donation_endrecurring($params) { )); } else { + // END RECURRING CONTRIBUTION CRM_Twingle_Tools::$protection_suspended = TRUE; $contribution = civicrm_api3('ContributionRecur', 'create', array( 'id' => $contribution['id'], From 4151963a5c5118061fb1fbf4391e7dffbbc96320 Mon Sep 17 00:00:00 2001 From: "B. Endres" Date: Mon, 25 Nov 2019 08:55:55 +0100 Subject: [PATCH 4/5] fixed date parsing for TwingleDonation.Cancel --- api/v3/TwingleDonation/Cancel.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/v3/TwingleDonation/Cancel.php b/api/v3/TwingleDonation/Cancel.php index 32a4e95..d2bba26 100644 --- a/api/v3/TwingleDonation/Cancel.php +++ b/api/v3/TwingleDonation/Cancel.php @@ -72,7 +72,7 @@ function civicrm_api3_twingle_donation_Cancel($params) { try { // Validate date for parameter "cancelled_at". - if (!DateTime::createFromFormat('Ymd', $params['cancelled_at'])) { + if (!DateTime::createFromFormat('YmdHis', $params['cancelled_at'])) { throw new CiviCRM_API3_Exception( E::ts('Invalid date for parameter "cancelled_at".'), 'invalid_format' @@ -109,7 +109,7 @@ function civicrm_api3_twingle_donation_Cancel($params) { $mandate_id = (int) $mandate['id']; // Mandates can not be terminated in the past. - $end_date = date_create_from_format('Ymd', $params['cancelled_at']); + $end_date = date_create_from_format('YmdHis', $params['cancelled_at']); if ($end_date) { // Mandates can not be terminated in the past: $end_date = date('Ymd', max( From 082fd934d463581a10d5c6a22bf115341ad2de5b Mon Sep 17 00:00:00 2001 From: "B. Endres" Date: Wed, 29 Jan 2020 17:59:03 +0100 Subject: [PATCH 5/5] [#13] minor adjustments --- CRM/Twingle/Tools.php | 2 +- api/v3/TwingleDonation/Submit.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CRM/Twingle/Tools.php b/CRM/Twingle/Tools.php index 08a596f..cd91e82 100644 --- a/CRM/Twingle/Tools.php +++ b/CRM/Twingle/Tools.php @@ -123,7 +123,7 @@ class CRM_Twingle_Tools { return reset($ooff_mandate['values']); } } catch (Exception $ex) { - Civi::log()->error("CRM_Twingle_Tools::getMandate failde for [{$contribution_id}]: " . $ex->getMessage()); + Civi::log()->debug("CRM_Twingle_Tools::getMandate failed for [{$contribution_id}]: " . $ex->getMessage()); } } return NULL; diff --git a/api/v3/TwingleDonation/Submit.php b/api/v3/TwingleDonation/Submit.php index 2bc3d3a..2215ed8 100644 --- a/api/v3/TwingleDonation/Submit.php +++ b/api/v3/TwingleDonation/Submit.php @@ -163,7 +163,7 @@ function _civicrm_api3_twingle_donation_Submit_spec(&$params) { ); $params['user_email'] = array( 'name' => 'user_email', - 'title' => E::ts('E-mail address'), + 'title' => E::ts('Email address'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, 'description' => E::ts('The e-mail address of the contact.'),