Merge pull request #20210 from eileenmcnaughton/cancel

Fix old-ish regression on paypal standard self-service cancel links

Author: seamuslee001

CRM/Contribute/Page/Tab.php

@@ -94,6 +94,87 @@ public static function recurLinks(int $recurID, $context = 'contribution') {
     return $links;
   }
 
+  /**
+   * Get the recur links to return for self service.
+   *
+   * These are the links to present to a logged in user wishing
+   * to service their own
+   *
+   * @param int $recurID
+   *
+   * @return array|array[]
+   * @throws \CRM_Core_Exception
+   * @throws \CiviCRM_API3_Exception
+   */
+  public static function selfServiceRecurLinks(int $recurID): array {
+    $links = [];
+    $paymentProcessorObj = Civi\Payment\System::singleton()->getById(CRM_Contribute_BAO_ContributionRecur::getPaymentProcessorID($recurID));
+    if ($paymentProcessorObj->supports('cancelRecurring')
+      && $paymentProcessorObj->subscriptionURL($recurID, 'recur', 'cancel')
+    ) {
+      $url = $paymentProcessorObj->subscriptionURL($recurID, 'recur', 'cancel');
+      $links[CRM_Core_Action::DISABLE] = [
+        'url' => $url,
+        'name' => ts('Cancel'),
+        'title' => ts('Cancel'),
+        // Only display on-site links in a popup.
+        'class' => (stripos($url, 'http') !== FALSE) ? 'no-popup' : '',
+      ];
+    }
+
+    if ($paymentProcessorObj->supports('UpdateSubscriptionBillingInfo')
+      && $paymentProcessorObj->subscriptionURL($recurID, 'recur', 'billing')
+    ) {
+      $url = $paymentProcessorObj->subscriptionURL($recurID, 'recur', 'billing');
+      $links[CRM_Core_Action::RENEW] = [
+        'name' => ts('Change Billing Details'),
+        'title' => ts('Change Billing Details'),
+        'url' => $url,
+        // Only display on-site links in a popup.
+        'class' => (stripos($url, 'http') !== FALSE) ? 'no-popup' : '',
+      ];
+    }
+
+    if (($paymentProcessorObj->supports('ChangeSubscriptionAmount')
+    || $paymentProcessorObj->supports('EditRecurringContribution'))
+    && $paymentProcessorObj->subscriptionURL($recurID, 'recur', 'update')
+    ) {
+      $url = $paymentProcessorObj->subscriptionURL($recurID, 'recur', 'update');
+      $links[CRM_Core_Action::UPDATE] = [
+        'name' => ts('Edit'),
+        'title' => ts('Edit Recurring Payment'),
+        'url' => $url,
+        // Only display on-site links in a popup.
+        'class' => (stripos($url, 'http') !== FALSE) ? 'no-popup' : '',
+      ];
+    }
+    return $links;
+  }
+
+  /**
+   * Get recurring links appropriate to viewing a user dashboard.
+   *
+   * A contact should be able to see links appropriate to them (e.g
+   * payment processor cancel page) if viewing their own dashboard and
+   * links appropriate to the contact they are viewing, if they have
+   * permission, if viewing another user.
+   *
+   * @param int $recurID
+   * @param int $contactID
+   *
+   * @return array|array[]
+   * @throws \CRM_Core_Exception
+   * @throws \CiviCRM_API3_Exception
+   */
+  public static function dashboardRecurLinks(int $recurID, int $contactID): array {
+    $links = [];
+    if ($contactID && $contactID === CRM_Core_Session::getLoggedInContactID()) {
+      $links = self::selfServiceRecurLinks($recurID);
+    }
+    $links += self::recurLinks($recurID, 'dashboard');
+    return $links;
+  }
+
   /**
    * called when action is browse.
    *

CRM/Contribute/Page/UserDashboard.php

@@ -98,7 +98,7 @@ public function listContribution() {
       $values['recur_status'] = $recurStatus[$values['contribution_status_id']];
       $recurRow[$values['id']] = $values;
 
-      $action = array_sum(array_keys(CRM_Contribute_Page_Tab::recurLinks((int) $recur->id, 'dashboard')));
+      $action = array_sum(array_keys(CRM_Contribute_Page_Tab::dashboardRecurLinks((int) $recur->id, (int) $recur->contact_id)));
 
       $details = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($recur->id, 'recur');
       $hideUpdate = $details->membership_id & $details->auto_renew;
@@ -107,7 +107,7 @@ public function listContribution() {
         $action -= CRM_Core_Action::UPDATE;
       }
 
-      $recurRow[$values['id']]['action'] = CRM_Core_Action::formLink(CRM_Contribute_Page_Tab::recurLinks((int) $recur->id, 'dashboard'),
+      $recurRow[$values['id']]['action'] = CRM_Core_Action::formLink(CRM_Contribute_Page_Tab::dashboardRecurLinks((int) $recur->id, (int) $this->_contactId),
         $action, [
           'cid' => $this->_contactId,
           'crid' => $values['id'],

CRM/Core/Session.php

@@ -563,7 +563,7 @@ public static function getLoggedInContactID() {
     if (!is_numeric($session->get('userID'))) {
       return NULL;
     }
-    return $session->get('userID');
+    return (int) $session->get('userID');
   }
 
   /**

CRM/Member/Page/RecurringContributions.php

@@ -125,7 +125,7 @@ private function setActionsForRecurringContribution(int $recurID, &$recurringCon
       }
 
       $recurringContribution['action'] = CRM_Core_Action::formLink(
-        CRM_Contribute_Page_Tab::recurLinks($recurID, 'contribution'),
+        CRM_Contribute_Page_Tab::recurLinks($recurID),
         $action,
         [
           'cid' => $this->contactID,

tests/phpunit/CRM/Contribute/Page/TabTest.php

@@ -18,22 +18,79 @@
  */
 class CRM_Contribute_Page_TabTest extends CiviUnitTestCase {
 
+  /**
+   * Clean up after test.
+   *
+   * @throws \CRM_Core_Exception
+   */
+  public function tearDown(): void {
+    $this->quickCleanUpFinancialEntities();
+    parent::tearDown();
+  }
+
   /**
    * Test links render correctly for manual processor.
    *
    * @throws \API_Exception
    * @throws \CiviCRM_API3_Exception
    */
-  public function testLinks() {
-    $contactID = $this->individualCreate();
-    $recurID = ContributionRecur::create()->setValues([
+  public function testLinksManual(): void {
+    [$contactID, $recurID] = $this->setupTemplate();
+
+    $templateVariable = CRM_Core_Smarty::singleton()->get_template_vars();
+    $this->assertEquals('Mr. Anthony Anderson II', $templateVariable['displayName']);
+    $this->assertEquals("<span><a href=\"/index.php?q=civicrm/contact/view/contributionrecur&amp;reset=1&amp;id=" . $recurID . "&amp;cid=" . $contactID . "&amp;context=contribution\" class=\"action-item crm-hover-button\" title='View Recurring Payment' >View</a><a href=\"/index.php?q=civicrm/contribute/updaterecur&amp;reset=1&amp;action=update&amp;crid=1&amp;cid=3&amp;context=contribution\" class=\"action-item crm-hover-button\" title='Edit Recurring Payment' >Edit</a><a href=\"/index.php?q=civicrm/contribute/unsubscribe&amp;reset=1&amp;crid=" . $recurID . "&amp;cid=" . $contactID . "&amp;context=contribution\" class=\"action-item crm-hover-button\" title='Cancel' >Cancel</a></span>",
+      $this->getActionHtml()
+    );
+  }
+
+  /**
+   * Test links render correctly for manual processor.
+   *
+   * @throws \API_Exception
+   * @throws \CiviCRM_API3_Exception
+   */
+  public function testLinksPaypalStandard(): void {
+    $this->setupTemplate([
+      'payment_processor_id' => $this->paymentProcessorCreate(['payment_processor_type_id' => 'PayPal_Standard']),
+      'contact_id' => $this->createLoggedInUser(),
+    ]);
+    $expected = '<span><a href="/index.php?q=civicrm/contact/view/contributionrecur&amp;reset=1&amp;id=1&amp;cid=3&amp;context=contribution" class="action-item crm-hover-button" title=\'View Recurring Payment\' >View</a><a href="/index.php?q=civicrm/contribute/updaterecur&amp;reset=1&amp;action=update&amp;crid=1&amp;cid=3&amp;context=contribution" class="action-item crm-hover-button" title=\'Edit Recurring Payment\' >Edit</a></span><span class=\'btn-slide crm-hover-button\'>more<ul class=\'panel\'><li><a href="/index.php?q=civicrm/contribute/unsubscribe&amp;reset=1&amp;crid=1&amp;cid=3&amp;context=contribution" class="action-item crm-hover-button" title=\'Cancel\' >Cancel</a></li><li><a href="/index.php?q=civicrm/contribute/updatebilling&amp;reset=1&amp;crid=1&amp;cid=3&amp;context=contribution" class="action-item crm-hover-button" title=\'Change Billing Details\' >Change Billing Details</a></li></ul></span>';
+    $this->assertEquals($expected, $this->getActionHtml());
+
+    $page = new CRM_Contribute_Page_UserDashboard();
+    $page->run();
+    $expected = '<span><a href="https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_subscr-find&alias=sunil._1183377782_biz_api1.webaccess.co.in" class="action-item crm-hover-button no-popup" title=\'Cancel\' >Cancel</a>'
+      . '<a href="/index.php?q=civicrm/contact/view/contributionrecur&amp;reset=1&amp;id=1&amp;cid=3&amp;context=dashboard" class="action-item crm-hover-button" title=\'View Recurring Payment\' >View</a>'
+      . '</span><span class=\'btn-slide crm-hover-button\'>more<ul class=\'panel\'><li><a href="/index.php?q=civicrm/contribute/updaterecur&amp;reset=1&amp;action=update&amp;crid=1&amp;cid=3&amp;context=dashboard" class="action-item crm-hover-button" title=\'Edit Recurring Payment\' >Edit</a></li><li><a href="/index.php?q=civicrm/contribute/updatebilling&amp;reset=1&amp;crid=1&amp;cid=3&amp;context=dashboard" class="action-item crm-hover-button" title=\'Change Billing Details\' >Change Billing Details</a></li></ul></span>';
+    $this->assertEquals(
+      $expected,
+      $this->getDashboardActionHtml()
+    );
+  }
+
+  /**
+   * Set up template for user dashboard.
+   *
+   * Create the recurring contribution, contribution and run the dashboard.
+   *
+   * @param array $recurParams
+   *
+   * @return array
+   * @throws \API_Exception
+   * @throws \CiviCRM_API3_Exception
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  protected function setupTemplate($recurParams = []): array {
+    $contactID = $recurParams['contact_id'] ?? $this->individualCreate();
+    $recurID = ContributionRecur::create()->setValues(array_merge([
       'contact_id' => $contactID,
       'amount' => 10,
       'frequency_interval' => 'week',
       'start_date' => 'now',
       'is_active' => TRUE,
       'contribution_status_id:name' => 'Pending',
-    ])
+    ], $recurParams))
       ->addChain(
         'contribution',
         Contribution::create()->setValues([
@@ -48,12 +105,27 @@ public function testLinks() {
     $page->_contactId = $contactID;
     $page->_action = CRM_Core_Action::VIEW;
     $page->browse();
+    return [$contactID, $recurID];
+  }
 
-    $templateVariable = CRM_Core_Smarty::singleton()->get_template_vars();
-    $this->assertEquals('Mr. Anthony Anderson II', $templateVariable['displayName']);
-    $this->assertEquals("<span><a href=\"/index.php?q=civicrm/contact/view/contributionrecur&amp;reset=1&amp;id=" . $recurID . "&amp;cid=" . $contactID . "&amp;context=contribution\" class=\"action-item crm-hover-button\" title='View Recurring Payment' >View</a><a href=\"/index.php?q=civicrm/contribute/updaterecur&amp;reset=1&amp;action=update&amp;crid=1&amp;cid=3&amp;context=contribution\" class=\"action-item crm-hover-button\" title='Edit Recurring Payment' >Edit</a><a href=\"/index.php?q=civicrm/contribute/unsubscribe&amp;reset=1&amp;crid=" . $recurID . "&amp;cid=" . $contactID . "&amp;context=contribution\" class=\"action-item crm-hover-button\" title='Cancel' >Cancel</a></span>",
-      $templateVariable['activeRecurRows'][1]['action']
-    );
+  /**
+   * Get the html assigned as actions.
+   *
+   * @return string
+   */
+  protected function getActionHtml(): string {
+    return CRM_Core_Smarty::singleton()
+      ->get_template_vars()['activeRecurRows'][1]['action'];
+  }
+
+  /**
+   * Get the html assigned as actions.
+   *
+   * @return string
+   */
+  protected function getDashboardActionHtml(): string {
+    return CRM_Core_Smarty::singleton()
+      ->get_template_vars()['recurRows'][1]['action'];
   }
 
 }