T2853 recurring payment methods integration postfinance

my_compassion/__manifest__.py

@@ -91,6 +91,9 @@
         "templates/components/my2_giving_limits_modal.xml",
         "templates/components/my2_checkout.xml",
         "templates/components/my2_weather_time_container.xml",
+        "templates/components/my2_sponsorships_section.xml",
+        "templates/components/my2_payment_method_modal.xml",
+        "templates/components/my2_payment_method_card.xml",
         # Other data the depends on the templates
         "data/my2_new_sponsorship_wizard_steps.xml",
     ],

my_compassion/controllers/my2_donations.py

@@ -8,18 +8,26 @@
 #
 ##############################################################################
 
+import json
 import math
 from collections import defaultdict
 from datetime import datetime, timedelta
 
 from werkzeug.exceptions import BadRequest, NotFound
 
-from odoo import fields, http
+import odoo
+from odoo import _, fields, http
 from odoo.http import request
 
 from odoo.addons.portal.controllers.portal import CustomerPortal
 
 
+# TODO: Refactor payment-related methods into a separate controller
+# PLEASE NOTE:
+# Before deep diving into this code note that there's a documentation
+# page explaining the overall architecture and flow of this code.
+# https://compassion.odoo.com/odoo/knowledge/202 and
+# https://compassion.odoo.com/odoo/knowledge/205
 class MyCompassionDonationsController(CustomerPortal):
     @http.route(
         '/my2/gifts/<model("product.template"):product>',
@@ -387,6 +395,10 @@ def _get_paid_invoices_amount(self, partner):
         )
         return number_of_paid_invoices
 
+    # -------------------------------------------------------------------------
+    # Methods and routes for MyCompassion2.0 Donations Page
+    # -------------------------------------------------------------------------
+
     @http.route(
         "/my2/donations",
         type="http",
@@ -397,7 +409,14 @@ def my_donations(self, invoice_page=1, invoice_per_page=12, **kw):
         partner = request.env.user.partner_id
 
         # Active sponsorships
-        active_sponsorships = partner.get_portal_sponsorships("active")
+        active_sponsorships = partner.get_portal_sponsorships(["active", "mandate"])
+
+        # Group sponsorships by their backend Contract Group
+        sponsorship_groups = active_sponsorships.mapped("group_id")
+
+        # Put all payment methods into a dict of group_id -> method info
+        all_groups = partner.get_payment_modes()
+        payment_info_map = all_groups.get_payment_method_info()
 
         # Due invoices
         date_filter_up_bound = datetime.today() + timedelta(days=30)
@@ -417,16 +436,16 @@ def my_donations(self, invoice_page=1, invoice_per_page=12, **kw):
             )
         )
 
-        # Computing the total price of the active sponsorships grouped
-        # per sponsorship frequency and payment method.
-        # group_id groups the invoices that have the same payment method and frequency.
+        # Total cost calculation
         tot_cost_per_frequency = defaultdict(lambda: defaultdict(float))
 
         for sponsorship in active_sponsorships:
             currency = sponsorship.pricelist_id.currency_id.name
-            tot_cost_per_frequency[sponsorship.group_id.month_interval][
-                currency
-            ] += sponsorship.total_amount
+            # Ensure group exists
+            if sponsorship.group_id:
+                tot_cost_per_frequency[sponsorship.group_id.month_interval][
+                    currency
+                ] += sponsorship.total_amount
 
         paid_invoices_data = self._get_paginated_paid_invoices(
             partner, invoice_page, invoice_per_page
@@ -436,6 +455,9 @@ def my_donations(self, invoice_page=1, invoice_per_page=12, **kw):
         values.update(
             {
                 "active_sponsorships": active_sponsorships,
+                "sponsorship_groups": sponsorship_groups,
+                "payment_info_map": payment_info_map,
+                "payment_methods_json": json.dumps(payment_info_map),
                 "tot_cost_per_frequency": tot_cost_per_frequency,
                 "due_invoices": due_invoices,
                 "paid_invoices_subset": paid_invoices_data["paid_invoices_subset"],
@@ -466,6 +488,219 @@ def my_donations_history(self, invoice_page=1, invoice_per_page=12, **kw):
 
         return {"html": html}
 
+    @http.route(
+        "/my2/donation/change_method_contract", type="json", auth="user", website=True
+    )
+    def change_payment_method_contract(self, contract_id, group_id, **kwargs):
+        """
+        Changes the payment method for a specific contract.
+
+        :param contract_id: ID of the recurring.contract to update.
+        :param group_id: ID of an existing group to merge into
+        """
+        partner = request.env.user.partner_id
+        if not contract_id or not group_id:
+            raise BadRequest()
+        # Verify that the contract belongs to the user
+        contract = (
+            request.env["recurring.contract"]
+            .sudo()
+            .search([("id", "=", int(contract_id)), ("partner_id", "=", partner.id)])
+        )
+        if not contract:
+            raise NotFound()
+
+        success = contract.change_contract_group(int(group_id))
+        if success:
+            # Render the updated list
+            values = self._prepare_sponsorship_values(partner)
+            html = request.env["ir.qweb"]._render(
+                "my_compassion.my2_sponsorships_section", values
+            )
+            return {
+                "success": True,
+                "html": html,
+                "payment_info_map": values["payment_info_map"],
+            }
+
+        return {"success": False, "error": _("Operation failed")}
+
+    @http.route(
+        "/my2/donation/change_method_group", type="json", auth="user", website=True
+    )
+    def change_payment_method_group(
+        self, group_id, new_group_id=None, new_bvr_ref=None, **kwargs
+    ):
+        """
+        Endpoint to update payment method for a sponsorship group.
+        Accepts new_group_id (to merge) or new_bvr_ref (to update ref).
+        """
+        partner = request.env.user.partner_id
+
+        if not group_id:
+            raise BadRequest(_("Group ID is required."))
+
+        # Security Check: Search ensures the group belongs to the logged-in user
+        group = (
+            request.env["recurring.contract.group"]
+            .sudo()
+            .search(
+                [("id", "=", int(group_id)), ("partner_id", "=", partner.id)], limit=1
+            )
+        )
+
+        if not group:
+            raise NotFound(_("Payment group not found or access denied."))
+
+        # Call the model method to perform the logic
+        success = group.change_payment_method(
+            new_group_id=new_group_id, new_bvr_ref=new_bvr_ref
+        )
+
+        if success:
+            values = self._prepare_sponsorship_values(partner)
+            html = request.env["ir.qweb"]._render(
+                "my_compassion.my2_sponsorships_section", values
+            )
+            return {
+                "success": True,
+                "html": html,
+                "payment_info_map": values["payment_info_map"],
+            }
+
+        return {"success": False, "error": _("Operation failed")}
+
+    @http.route(
+        "/my2/donation/add_payment_method_group", type="json", auth="user", website=True
+    )
+    def add_payment_method_group(
+        self,
+        recurring_unit="month",
+        method_type="bvr",
+        advance_billing_months=1,
+        **kwargs,
+    ):
+        """
+        Creates a new Contract Group with manual BVR/Permanent Order details.
+        """
+        partner = request.env.user.partner_id
+
+        # 1. Find Payment Mode
+        payment_mode = self._find_manual_payment_mode(method_type)
+        if not payment_mode:
+            return {
+                "success": False,
+                "error": _('Configuration Error: Payment mode for "%s" not found.')
+                % method_type,
+            }
+
+        # 2. Create the Group
+        try:
+            new_group = self._create_contract_group(
+                partner, payment_mode, recurring_unit, advance_billing_months
+            )
+
+            # Specific BVR Logic
+            new_bvr_ref = new_group.compute_partner_bvr_ref(partner)
+            if new_bvr_ref:
+                new_group.bvr_reference = new_bvr_ref
+
+            # 3. Return HTML
+            values = self._prepare_sponsorship_values(partner)
+            html = request.env["ir.qweb"]._render(
+                "my_compassion.my2_sponsorships_section", values
+            )
+
+            return {
+                "success": True,
+                "html": html,
+                "group_id": new_group.id,
+                "payment_info_map": values["payment_info_map"],
+            }
+
+        except odoo.exceptions.ValidationError as e:
+            return {"success": False, "error": str(e)}
+        except Exception:
+            return {"success": False, "error": _("An unexpected error occurred.")}
+
+    @http.route(
+        "/my2/donation/fetch_payment_methods_iframe",
+        type="json",
+        auth="user",
+        website=True,
+    )
+    def fetch_payment_methods_iframe(
+        self, recurring_unit="month", recurring_value=1, **kwargs
+    ):
+        """
+        Initiates a 'validation' transaction to tokenize a card/method.
+        Returns data for rendering the PostFinance Iframe with available methods.
+        """
+        acquirer = self._get_payment_acquirer()
+
+        if not acquirer.exists():
+            return {"success": False, "error": "No payment provider found"}
+
+        # Prepare Transaction
+        return_url = "/my2/donations?unit={}&val={}".format(
+            recurring_unit, recurring_value
+        )
+
+        # 3. Get Integration Data (Iframe)
+        # This calls the method overridden in country specific module
+        result_data = self._prepare_iframe_redirect(acquirer, return_url)
+
+        if (
+            result_data
+            and isinstance(result_data, dict)
+            and result_data.get("type") == "iframe"
+        ):
+            return {
+                "success": True,
+                "iframe_url": result_data["url"],
+                "pf_methods": result_data.get("pf_methods", []),
+            }
+
+        # Error if Iframe data is missing
+        return {"success": False, "error": "Payment interface could not be loaded."}
+
+    # -------------------------------------------------------------------------
+    # PRIVATE HELPERS (Rendering Data Preparation)
+    # -------------------------------------------------------------------------
+
+    @staticmethod
+    def _prepare_sponsorship_values(partner):
+        """
+        Helper to fetch all data required for the sponsorship list view.
+        Returns a dict of values for QWeb rendering.
+        """
+        # 1. Fetch Active Sponsorships
+        active_sponsorships = partner.get_portal_sponsorships(["active", "mandate"])
+
+        # 2. Fetch Groups
+        sponsorship_groups = active_sponsorships.mapped("group_id")
+
+        # 3. Calculate Totals
+        tot_cost_per_frequency = defaultdict(lambda: defaultdict(float))
+        for sponsorship in active_sponsorships:
+            currency = sponsorship.pricelist_id.currency_id.name
+            if sponsorship.group_id:
+                tot_cost_per_frequency[sponsorship.group_id.month_interval][
+                    currency
+                ] += sponsorship.total_amount
+
+        # 4. Fetch Available Methods (for modals)
+        all_groups = partner.get_payment_modes()
+        payment_info_map = all_groups.get_payment_method_info()
+
+        return {
+            "active_sponsorships": active_sponsorships,
+            "sponsorship_groups": sponsorship_groups,
+            "tot_cost_per_frequency": tot_cost_per_frequency,
+            "payment_info_map": payment_info_map,
+            "payment_methods_json": json.dumps(payment_info_map),
+        }
+
     def _get_paginated_paid_invoices(
         self, partner, invoice_page=1, invoice_per_page=12
     ):
@@ -489,6 +724,54 @@ def _get_paginated_paid_invoices(
             "total_pages": total_pages,
         }
 
+    @staticmethod
+    def _create_contract_group(partner, payment_mode, unit, value, token=None):
+        """
+        Centralized method to create a recurring contract group.
+        Used by both Manual (BVR, etc.) and Online (Credit Card, etc.) flows.
+        """
+        vals = {
+            "partner_id": partner.id,
+            "payment_mode_id": payment_mode.id,
+            "recurring_unit": unit,
+            "recurring_value": int(value),
+            "active": True,
+        }
+        if token:
+            vals["payment_token_id"] = token.id
+
+        return request.env["recurring.contract.group"].sudo().create(vals)
+
+    @staticmethod
+    def _find_manual_payment_mode(method_key):
+        """
+        Finds a payment mode based on the frontend key (bvr/permanent).
+        Handles case-insensitive search and archiving.
+        """
+        # Map frontend keys to DB names
+        search_map = {
+            "permanent_order": "Permanent Order",
+            "bvr": "BVR",
+        }
+        term = search_map.get(method_key)
+        if not term:
+            return None
+
+        # Search with active_test=False to find modes even if archived/hidden
+        domain = [("name", "=", term)]
+        mode = (
+            request.env["account.payment.mode"]
+            .sudo()
+            .with_context(active_test=False)
+            .search(domain, limit=1)
+        )
+
+        return mode
+
+    def _prepare_iframe_redirect(self, acquirer, return_url):
+        """Method to be overridden by country/provider specific modules"""
+        return False
+
     @staticmethod
     def _get_payment_acquirer():
         return (

my_compassion/data/payment_options.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <data noupdate="1">
+        <record id="payment_mode_ebill" model="account.payment.mode">
+            <field name="name">eBill</field>
+            <field name="company_id" ref="base.main_company"/>
+            <field name="bank_account_link">variable</field>
+            <field name="payment_method_id" ref="account.account_payment_method_manual_in"/>
+            <field name="active" eval="True"/>
+        </record>
+
+        <record id="account_payment_method_ebill" model="account.payment.method">
+            <field name="name">eBill</field>
+            <field name="code">ebill</field>
+            <field name="payment_type">inbound</field>
+        </record>
+    </data>
+</odoo>