Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move acl check for contributionView to the extension #22684

Merged
merged 1 commit into from
Feb 10, 2022
Merged

Move acl check for contributionView to the extension #22684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CRM/Contribute/BAO/Contribution.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ public static function getValues($params, &$values = [], &$ids = []) {
}

/**
* Get the values and resolve the most common mappings.
* Deprecated contact.get call.
*
* Since contribution status is resolved in almost every function that calls getValues it makes
* sense to have an extra function to resolve it rather than repeat the code.
Expand All @@ -330,6 +330,8 @@ public static function getValues($params, &$values = [], &$ids = []) {
* @return array
* Array of the found contribution.
* @throws CRM_Core_Exception
*
* @deprecated
*/
public static function getValuesWithMappings($params) {
$values = $ids = [];
Expand Down
40 changes: 31 additions & 9 deletions CRM/Contribute/Form/ContributionView.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
+--------------------------------------------------------------------+
*/

use Civi\Api4\Contribution;

/**
*
* @package CRM
Expand All @@ -24,16 +26,23 @@ class CRM_Contribute_Form_ContributionView extends CRM_Core_Form {
* Set variables up before form is built.
*/
public function preProcess() {
$id = $this->get('id');
if (empty($id)) {
throw new CRM_Core_Exception('Contribution ID is required');
}
$params = ['id' => $id];
$id = $this->getID();

$context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
$this->assign('context', $context);

$values = CRM_Contribute_BAO_Contribution::getValuesWithMappings($params);
// Note than this get could be restricted by ACLs in an extension
$contribution = Contribution::get(TRUE)->addWhere('id', '=', $id)->addSelect('*')->execute()->first();
if (empty($contribution)) {
CRM_Core_Error::statusBounce(ts('Access to contribution not permitted'));
}
// We just cast here because it was traditionally an array called values - would be better
// just to use 'contribution'.
$values = (array) $contribution;
$contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);

// @todo - it might have been better to create a new form that extends this
// for template contributions rather than overloading this form.
$force_create_template = CRM_Utils_Request::retrieve('force_create_template', 'Boolean', $this, FALSE, FALSE);
if ($force_create_template && !empty($values['contribution_recur_id']) && empty($values['is_template'])) {
// Create a template contribution.
Expand Down Expand Up @@ -70,7 +79,7 @@ public function preProcess() {
}

// get received into i.e to_financial_account_id from last trxn
$financialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($values['contribution_id'], 'DESC');
$financialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($this->getID(), 'DESC');
$values['to_financial_account'] = '';
if (!empty($financialTrxnId['financialTrxnId'])) {
$values['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $financialTrxnId['financialTrxnId'], 'to_financial_account_id');
Expand Down Expand Up @@ -129,7 +138,7 @@ public function preProcess() {
}

//assign soft credit record if exists.
$SCRecords = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($values['contribution_id'], TRUE);
$SCRecords = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->getID(), TRUE);
if (!empty($SCRecords['soft_credit'])) {
$this->assign('softContributions', $SCRecords['soft_credit']);
unset($SCRecords['soft_credit']);
Expand All @@ -150,7 +159,7 @@ public function preProcess() {
$campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
$values['campaign'] = $campaigns[$campaignId];
}
if ($values['contribution_status'] == 'Refunded') {
if ($contributionStatus === 'Refunded') {
$this->assign('refund_trxn_id', CRM_Core_BAO_FinancialTrxn::getRefundTransactionTrxnID($id));
}

Expand Down Expand Up @@ -260,4 +269,17 @@ protected function assignPaymentInfoBlock($id) {
return $title;
}

/**
* Get the contribution ID.
*
* @return int
*/
private function getID(): int {
$id = $this->get('id');
if (empty($id)) {
CRM_Core_Error::statusBounce('Contribution ID is required');
}
return $id;
}

}