diff --git a/subscription_oca_portal/.gitignore b/subscription_oca_portal/.gitignore new file mode 100644 index 0000000..6da5887 --- /dev/null +++ b/subscription_oca_portal/.gitignore @@ -0,0 +1,2 @@ +*.*~ +*pyc diff --git a/subscription_oca_portal/README.md b/subscription_oca_portal/README.md new file mode 100644 index 0000000..fde9ee8 --- /dev/null +++ b/subscription_oca_portal/README.md @@ -0,0 +1,152 @@ +# Subscription OCA Portal + +![Beta](https://img.shields.io/badge/maturity-Beta-yellow.png) +![License: AGPL-3](https://img.shields.io/badge/licence-AGPL--3-blue.png) +![Gitea](https://img.shields.io/badge/gitea-elabore%2Fsale--tools-lightgray.png) + +This module lets portal users consult the subscriptions (`subscription_oca`) that are +billed to them, from the Odoo customer portal. + +`subscription_oca` ships no portal at all: `sale.subscription` is not a portal document, +its access rights are limited to the salesman group and it has no record rule. This +module adds the missing portal layer, read-only, modelled on the portal of the OCA +`contract` module. + +## Table of Contents + +- [Description](#description) +- [Installation](#installation) +- [Configuration](#configuration) +- [Usage](#usage) +- [Security Model](#security-model) +- [Known Issues / Roadmap](#known-issues--roadmap) +- [Bug Tracker](#bug-tracker) +- [Credits](#credits) + +## Description + +### Portal document + +`sale.subscription` inherits `portal.mixin`, which brings the `access_token` and +`access_url` fields. `access_url` resolves to `/my/subscriptions/`, so +`get_portal_url()` and the share links built by `_get_share_url()` point at the portal +page instead of the backend. + +### Routes + +| Route | Auth | Purpose | +| ------------------------------- | ------ | ------------------------------------------- | +| `/my/subscriptions` | user | Paginated list of the user's subscriptions | +| `/my/subscriptions/page/` | user | Page N of that list | +| `/my/subscriptions/` | public | Detail page, by ownership or by share token | + +The list is sortable by start date (default), next invoice date, and reference. An entry +is added to the portal home page (`/my`), with a counter that reflects the record rule. + +### Detail page + +The detail page shows the customer, the reference, the subscription template, the stage, +the start / next invoice / finish dates, the subscription lines (description, quantity, +unit price, discount, subtotal), the recurring price, the taxes, the total, the related +invoices, and a portal chatter. + +Only **posted** invoices that the visitor is actually allowed to read are listed. +`subscription_oca` creates its invoices in `sudo`, so nothing guarantees the customer +may read them: the portal rule of `account.move` requires a posted move whose followers +include the customer's commercial partner. Invoices are therefore re-browsed with the +visitor's own environment and filtered on the effective read access, which keeps the +page free of dead links. A visitor arriving with a share token sees no invoice at all. + +### Out of scope + +The portal is strictly read-only. Cancelling, renewing or modifying a subscription, and +online or recurring payment, are not covered. + +## Installation + +This module depends on: + +- `subscription_oca` (OCA, [contract](https://github.com/OCA/contract) repository) +- `portal` (Odoo core) + +Use the standard Odoo module installation procedure to install +`subscription_oca_portal`. + +## Configuration + +No specific configuration is required. The portal entry appears as soon as a portal user +owns at least one subscription. + +The customer's contacts see the subscriptions of their company, because the record rule +matches the commercial partner and its children. No action is needed to share a +subscription with the contacts of a company. + +## Usage + +1. Create a subscription for a customer that has a portal user. +2. Log in to the portal with that user: the **Subscriptions** card appears on `/my`. +3. Open the card to list the subscriptions, then click a reference to see its detail. +4. To share a subscription with someone who has no account, use the `access_token` of + the record as a query string parameter: + `/my/subscriptions/?access_token=`. + +## Security Model + +| Model | Portal access | Record rule | +| ---------------------------- | ------------- | --------------------------------------------------------------------- | +| `sale.subscription` | read | `partner_id` is the user's commercial partner, or one of its children | +| `sale.subscription.line` | read | the parent subscription matches the same condition | +| `sale.subscription.stage` | read | none: stage names are configuration data | +| `sale.subscription.template` | read | none: template names are configuration data | + +The rule on the line model is not optional: without it, the read access granted on +`sale.subscription.line` would expose every subscription line to every portal user. + +Granting read access on the stage and template models exposes their names to all portal +users. These two models are only read to display the stage and the template of a +subscription. + +The portal chatter is a write surface: a portal user who can see a subscription can post +messages on it. + +## Known Issues / Roadmap + +- `subscription_oca` declares no multi-company record rule on `sale.subscription`. This + module does not add one, since that belongs upstream; the portal rule is based on the + partner, so a portal user never sees the subscriptions of another customer, whatever + the company. +- The JS tour (`subscription_oca_portal_tour`) is skipped when the test image ships no + Chrome binary, which is the case of the Elabore CI image. It is kept for parity with + the OCA `contract` portal and runs as soon as a browser is available. +- The heading of the chatter block carries `mb-4` on purpose. The frontend portal + chatter pulls its own sticky bar 15 px above its container and paints it opaque + (`portal/static/src/chatter/core/portal_chatter.xml` and + `portal/static/src/chatter/scss/shadow.scss`), so a heading with less than 15 px of + bottom margin gets its lower half covered. Core portal pages hide the same overlap + behind a much taller `

`. +- The product of a subscription line is deliberately not displayed: `product.product` + grants no read access to the portal group in Odoo 18. The line description is shown + instead. + +## Bug Tracker + +Bugs are tracked on +[our issue tracker](https://git.elabore.coop/Elabore/sale-tools/issues). In case of +trouble, please check there if your issue has already been reported. If you spotted it +first, help us smash it by providing a detailed and welcomed feedback. + +## Credits + +### Contributors + +- Stéphan Sainléger \ + +### Funders + +The development of this module has been financially supported by: + +- [Elabore](https://elabore.coop) + +### Maintainer + +This module is maintained by [Elabore](https://elabore.coop). diff --git a/subscription_oca_portal/__init__.py b/subscription_oca_portal/__init__.py new file mode 100644 index 0000000..91c5580 --- /dev/null +++ b/subscription_oca_portal/__init__.py @@ -0,0 +1,2 @@ +from . import controllers +from . import models diff --git a/subscription_oca_portal/__manifest__.py b/subscription_oca_portal/__manifest__.py new file mode 100644 index 0000000..1bb2000 --- /dev/null +++ b/subscription_oca_portal/__manifest__.py @@ -0,0 +1,30 @@ +# Copyright 2026 Stéphan Sainléger (Elabore) +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + "name": "subscription_oca_portal", + "version": "18.0.1.0.0", + "author": "Elabore", + "website": "https://git.elabore.coop/elabore/sale-tools", + "maintainer": "Stéphan Sainléger", + "license": "AGPL-3", + "category": "Sales", + "summary": "Let portal users consult their own subscriptions.", + "depends": [ + "subscription_oca", + "portal", + ], + "data": [ + "security/ir.model.access.csv", + "security/subscription_portal_security.xml", + "views/subscription_portal_templates.xml", + ], + "assets": { + "web.assets_tests": [ + "subscription_oca_portal/static/src/js/subscription_portal_tour.esm.js", + ], + }, + "installable": True, + "auto_install": False, + "application": False, +} diff --git a/subscription_oca_portal/controllers/__init__.py b/subscription_oca_portal/controllers/__init__.py new file mode 100644 index 0000000..12a7e52 --- /dev/null +++ b/subscription_oca_portal/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/subscription_oca_portal/controllers/main.py b/subscription_oca_portal/controllers/main.py new file mode 100644 index 0000000..e1764ca --- /dev/null +++ b/subscription_oca_portal/controllers/main.py @@ -0,0 +1,168 @@ +# Copyright 2026 Stéphan Sainléger (Elabore) +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import _, http +from odoo.exceptions import AccessError, MissingError +from odoo.http import request + +from odoo.addons.portal.controllers.portal import CustomerPortal +from odoo.addons.portal.controllers.portal import pager as portal_pager + +PAGE_NAME = "Subscriptions" +SESSION_HISTORY_KEY = "my_subscriptions_history" + + +class PortalSubscription(CustomerPortal): + """Expose ``sale.subscription`` records as read-only portal documents.""" + + def _prepare_home_portal_values(self, counters): + """Add the subscription counter displayed on the portal home page. + + :param counters: list of counter names requested by the portal home. + :return: the portal home values, with ``subscription_count`` added when + it was requested. The count is ``0`` for users without read access + so that the home entry stays hidden instead of raising. + """ + values = super()._prepare_home_portal_values(counters) + if "subscription_count" in counters: + subscription_model = request.env["sale.subscription"] + values["subscription_count"] = ( + subscription_model.search_count([]) + if subscription_model.has_access("read") + else 0 + ) + return values + + def _subscription_portal_invoices(self, subscription_sudo): + """Return the subscription invoices the current visitor may read. + + Subscription invoices are created in ``sudo`` by ``subscription_oca``, + so nothing guarantees the customer is allowed to read them: the portal + rule of ``account.move`` requires a posted move the partner follows. + Browsing the moves with the visitor's own environment and filtering on + the effective access right keeps the detail page free of dead links. + + :param subscription_sudo: ``sale.subscription`` singleton, in sudo. + :return: an ``account.move`` recordset, possibly empty, readable by the + current user and restricted to posted moves. + """ + subscription_sudo.ensure_one() + posted_invoices = subscription_sudo.invoice_ids.filtered( + lambda move: move.state == "posted" + ) + return ( + request.env["account.move"] + .browse(posted_invoices.ids) + ._filtered_access("read") + ) + + def _subscription_get_page_view_values( + self, subscription_sudo, access_token, **kwargs + ): + """Build the rendering values of the subscription detail page. + + :param subscription_sudo: ``sale.subscription`` singleton, in sudo. + :param access_token: share token used to reach the page, or ``None``. + :param kwargs: extra values forwarded to ``_get_page_view_values``. + :return: dict of QWeb values, including the prev/next record browsing + keys computed by the portal from the session history. + """ + values = { + "page_name": PAGE_NAME, + "subscription": subscription_sudo, + "invoices": self._subscription_portal_invoices(subscription_sudo), + } + return self._get_page_view_values( + subscription_sudo, + access_token, + values, + SESSION_HISTORY_KEY, + False, + **kwargs, + ) + + @http.route( + ["/my/subscriptions", "/my/subscriptions/page/"], + type="http", + auth="user", + website=True, + ) + def portal_my_subscriptions(self, page=1, sortby=None, **kw): + """Render the paginated list of the current user's subscriptions. + + Record-level filtering is delegated to the portal ``ir.rule``, so the + search domain stays empty on purpose. + + :param page: 1-based page number. + :param sortby: key of ``searchbar_sortings``; defaults to the start date. + :param kw: extra query string arguments, ignored. + :return: the rendered list page, or a redirect to ``/my`` when the user + has no read access on subscriptions. + :raise KeyError: if ``sortby`` is not a known sorting key. + """ + subscription_model = request.env["sale.subscription"] + if not subscription_model.has_access("read"): + return request.redirect("/my") + values = self._prepare_portal_layout_values() + searchbar_sortings = { + "date_start": {"label": _("Start Date"), "order": "date_start desc"}, + "recurring_next_date": { + "label": _("Next Invoice Date"), + "order": "recurring_next_date desc", + }, + "code": {"label": _("Reference"), "order": "code desc"}, + } + if not sortby: + sortby = "date_start" + order = searchbar_sortings[sortby]["order"] + subscription_count = subscription_model.search_count([]) + pager = portal_pager( + url="/my/subscriptions", + url_args={"sortby": sortby}, + total=subscription_count, + page=page, + step=self._items_per_page, + ) + subscriptions = subscription_model.search( + [], order=order, limit=self._items_per_page, offset=pager["offset"] + ) + request.session[SESSION_HISTORY_KEY] = subscriptions.ids[:100] + values.update( + { + "subscriptions": subscriptions, + "page_name": PAGE_NAME, + "pager": pager, + "default_url": "/my/subscriptions", + "searchbar_sortings": searchbar_sortings, + "sortby": sortby, + } + ) + return request.render("subscription_oca_portal.portal_my_subscriptions", values) + + @http.route( + ["/my/subscriptions/"], + type="http", + auth="public", + website=True, + ) + def portal_my_subscription_detail(self, subscription_id, access_token=None, **kw): + """Render one subscription, by ownership or by share token. + + :param subscription_id: database id of the subscription. + :param access_token: share token allowing access without ownership. + :param kw: extra query string arguments forwarded to the view values. + :return: the rendered detail page, or a redirect to ``/my`` when the + record is missing or not accessible. + """ + try: + subscription_sudo = self._document_check_access( + "sale.subscription", subscription_id, access_token + ) + except (AccessError, MissingError): + return request.redirect("/my") + values = self._subscription_get_page_view_values( + subscription_sudo, access_token, **kw + ) + return request.render( + "subscription_oca_portal.portal_subscription_page", values + ) diff --git a/subscription_oca_portal/i18n/fr.po b/subscription_oca_portal/i18n/fr.po new file mode 100644 index 0000000..391a6b5 --- /dev/null +++ b/subscription_oca_portal/i18n/fr.po @@ -0,0 +1,200 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * subscription_oca_portal +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 18.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2026-10-20 20:17+0000\n" +"PO-Revision-Date: 2026-10-20 20:17+0000\n" +"Last-Translator: \n" +"Language-Team: \n" +"Language: fr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Communication" +msgstr "Communication" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Customer:" +msgstr "Client :" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Finish Date" +msgstr "Date de fin" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Invoices" +msgstr "Factures" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Next Invoice Date" +msgstr "Date de prochaine facture" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Recurring Price" +msgstr "Prix récurrent" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Reference" +msgstr "Référence" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Stage" +msgstr "Étape" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Start Date" +msgstr "Date de début" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Subscription Template" +msgstr "Modèle d'abonnement" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Total" +msgstr "Total" + +#. module: subscription_oca_portal +#: model:ir.model.fields,field_description:subscription_oca_portal.field_sale_subscription__access_warning +msgid "Access warning" +msgstr "Avertissement d'accès" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Amount Due" +msgstr "Montant dû" + +#. module: subscription_oca_portal +#: model:ir.model.fields,help:subscription_oca_portal.field_sale_subscription__access_url +msgid "Customer Portal URL" +msgstr "URL du portail client" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Description" +msgstr "Description" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Discount (%)" +msgstr "Remise (%)" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_home_subscription +msgid "Follow your recurring subscriptions" +msgstr "Suivez vos abonnements récurrents" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Invoice" +msgstr "Facture" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Invoice Date" +msgstr "Date de facturation" + +#. module: subscription_oca_portal +#. odoo-python +#: code:addons/subscription_oca_portal/controllers/main.py:0 +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Next Invoice Date" +msgstr "Date de prochaine facture" + +#. module: subscription_oca_portal +#: model:ir.model.fields,field_description:subscription_oca_portal.field_sale_subscription__access_url +msgid "Portal Access URL" +msgstr "URL d'accès au portail" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Quantity" +msgstr "Quantité" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Recurring Price" +msgstr "Prix récurrent" + +#. module: subscription_oca_portal +#. odoo-python +#: code:addons/subscription_oca_portal/controllers/main.py:0 +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Reference" +msgstr "Référence" + +#. module: subscription_oca_portal +#: model:ir.model.fields,field_description:subscription_oca_portal.field_sale_subscription__access_token +msgid "Security Token" +msgstr "Jeton de sécurité" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Stage" +msgstr "Étape" + +#. module: subscription_oca_portal +#. odoo-python +#: code:addons/subscription_oca_portal/controllers/main.py:0 +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Start Date" +msgstr "Date de début" + +#. module: subscription_oca_portal +#: model:ir.model,name:subscription_oca_portal.model_sale_subscription +msgid "Subscription" +msgstr "Abonnement" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Subscription -" +msgstr "Abonnement -" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Subscription Template" +msgstr "Modèle d'abonnement" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_home_menu_subscription +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_home_subscription +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Subscriptions" +msgstr "Abonnements" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Subtotal" +msgstr "Sous-total" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Taxes" +msgstr "Taxes" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Total" +msgstr "Total" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Unit Price" +msgstr "Prix unitaire" diff --git a/subscription_oca_portal/i18n/subscription_oca_portal.pot b/subscription_oca_portal/i18n/subscription_oca_portal.pot new file mode 100644 index 0000000..55a7121 --- /dev/null +++ b/subscription_oca_portal/i18n/subscription_oca_portal.pot @@ -0,0 +1,199 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * subscription_oca_portal +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 18.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2026-10-20 20:17+0000\n" +"PO-Revision-Date: 2026-10-20 20:17+0000\n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Communication" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Customer:" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Finish Date" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Invoices" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Next Invoice Date" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Recurring Price" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Reference" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Stage" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Start Date" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Subscription Template" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Total" +msgstr "" + +#. module: subscription_oca_portal +#: model:ir.model.fields,field_description:subscription_oca_portal.field_sale_subscription__access_warning +msgid "Access warning" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Amount Due" +msgstr "" + +#. module: subscription_oca_portal +#: model:ir.model.fields,help:subscription_oca_portal.field_sale_subscription__access_url +msgid "Customer Portal URL" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Description" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Discount (%)" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_home_subscription +msgid "Follow your recurring subscriptions" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Invoice" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Invoice Date" +msgstr "" + +#. module: subscription_oca_portal +#. odoo-python +#: code:addons/subscription_oca_portal/controllers/main.py:0 +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Next Invoice Date" +msgstr "" + +#. module: subscription_oca_portal +#: model:ir.model.fields,field_description:subscription_oca_portal.field_sale_subscription__access_url +msgid "Portal Access URL" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Quantity" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Recurring Price" +msgstr "" + +#. module: subscription_oca_portal +#. odoo-python +#: code:addons/subscription_oca_portal/controllers/main.py:0 +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Reference" +msgstr "" + +#. module: subscription_oca_portal +#: model:ir.model.fields,field_description:subscription_oca_portal.field_sale_subscription__access_token +msgid "Security Token" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Stage" +msgstr "" + +#. module: subscription_oca_portal +#. odoo-python +#: code:addons/subscription_oca_portal/controllers/main.py:0 +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Start Date" +msgstr "" + +#. module: subscription_oca_portal +#: model:ir.model,name:subscription_oca_portal.model_sale_subscription +msgid "Subscription" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Subscription -" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Subscription Template" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_home_menu_subscription +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_home_subscription +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_my_subscriptions +msgid "Subscriptions" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Subtotal" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Taxes" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Total" +msgstr "" + +#. module: subscription_oca_portal +#: model_terms:ir.ui.view,arch_db:subscription_oca_portal.portal_subscription_page +msgid "Unit Price" +msgstr "" diff --git a/subscription_oca_portal/models/__init__.py b/subscription_oca_portal/models/__init__.py new file mode 100644 index 0000000..9119ef9 --- /dev/null +++ b/subscription_oca_portal/models/__init__.py @@ -0,0 +1 @@ +from . import sale_subscription diff --git a/subscription_oca_portal/models/sale_subscription.py b/subscription_oca_portal/models/sale_subscription.py new file mode 100644 index 0000000..d968d8e --- /dev/null +++ b/subscription_oca_portal/models/sale_subscription.py @@ -0,0 +1,31 @@ +# Copyright 2026 Stéphan Sainléger (Elabore) +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + + +class SaleSubscription(models.Model): + """Turn subscriptions into shareable portal documents. + + ``subscription_oca`` declares ``sale.subscription`` as a mail thread only. + Adding ``portal.mixin`` brings in ``access_token`` / ``access_url``, which + the portal controllers need for ownership checks and token-based sharing. + """ + + _name = "sale.subscription" + _inherit = ["sale.subscription", "portal.mixin"] + + def _compute_access_url(self): + """Point each subscription at its portal detail page. + + ``portal.mixin`` computes ``access_url`` as ``'#'``; this override makes + ``get_portal_url()`` and ``_get_share_url()`` resolve to the route + served by ``PortalSubscription.portal_my_subscription_detail``. + + :return: whatever ``portal.mixin`` returns, i.e. ``None``. The method + assigns ``access_url`` on every record of ``self``. + """ + result = super()._compute_access_url() + for subscription in self: + subscription.access_url = f"/my/subscriptions/{subscription.id}" + return result diff --git a/subscription_oca_portal/pyproject.toml b/subscription_oca_portal/pyproject.toml new file mode 100644 index 0000000..4231d0c --- /dev/null +++ b/subscription_oca_portal/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/subscription_oca_portal/security/ir.model.access.csv b/subscription_oca_portal/security/ir.model.access.csv new file mode 100644 index 0000000..f6d9984 --- /dev/null +++ b/subscription_oca_portal/security/ir.model.access.csv @@ -0,0 +1,5 @@ +id,name,model_id/id,group_id/id,perm_read,perm_write,perm_create,perm_unlink +access_sale_subscription_portal,sale.subscription portal,subscription_oca.model_sale_subscription,base.group_portal,1,0,0,0 +access_sale_subscription_line_portal,sale.subscription.line portal,subscription_oca.model_sale_subscription_line,base.group_portal,1,0,0,0 +access_sale_subscription_stage_portal,sale.subscription.stage portal,subscription_oca.model_sale_subscription_stage,base.group_portal,1,0,0,0 +access_sale_subscription_template_portal,sale.subscription.template portal,subscription_oca.model_sale_subscription_template,base.group_portal,1,0,0,0 diff --git a/subscription_oca_portal/security/subscription_portal_security.xml b/subscription_oca_portal/security/subscription_portal_security.xml new file mode 100644 index 0000000..c2f1f95 --- /dev/null +++ b/subscription_oca_portal/security/subscription_portal_security.xml @@ -0,0 +1,26 @@ + + + + + + Portal Subscriptions + + [('partner_id', 'child_of', [user.commercial_partner_id.id])] + + + + + Portal Subscription Lines + + [('sale_subscription_id.partner_id', 'child_of', [user.commercial_partner_id.id])] + + + diff --git a/subscription_oca_portal/static/src/img/subscription_icon.svg b/subscription_oca_portal/static/src/img/subscription_icon.svg new file mode 100644 index 0000000..bf11b42 --- /dev/null +++ b/subscription_oca_portal/static/src/img/subscription_icon.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/subscription_oca_portal/static/src/js/subscription_portal_tour.esm.js b/subscription_oca_portal/static/src/js/subscription_portal_tour.esm.js new file mode 100644 index 0000000..24fbf7a --- /dev/null +++ b/subscription_oca_portal/static/src/js/subscription_portal_tour.esm.js @@ -0,0 +1,17 @@ +import {redirect} from "@web/core/utils/urls"; +import {registry} from "@web/core/registry"; + +registry.category("web_tour.tours").add("subscription_oca_portal_tour", { + url: "/my", + steps: () => [ + { + content: "Go to the subscription list", + trigger: 'a[href*="/my/subscriptions"]', + run: () => redirect("/my/subscriptions"), + }, + { + content: "Open the first subscription", + trigger: "table.o_portal_my_doc_table tr:eq(0)", + }, + ], +}); diff --git a/subscription_oca_portal/tests/__init__.py b/subscription_oca_portal/tests/__init__.py new file mode 100644 index 0000000..8307da4 --- /dev/null +++ b/subscription_oca_portal/tests/__init__.py @@ -0,0 +1 @@ +from . import test_portal diff --git a/subscription_oca_portal/tests/test_portal.py b/subscription_oca_portal/tests/test_portal.py new file mode 100644 index 0000000..4c0e39a --- /dev/null +++ b/subscription_oca_portal/tests/test_portal.py @@ -0,0 +1,281 @@ +# Copyright 2026 Stéphan Sainléger (Elabore) +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import Command, fields +from odoo.tests import HttpCase, tagged + +INVOICE_LINK_CLASS = "tr_subscription_invoice_link" + + +@tagged("post_install", "-at_install") +class TestSubscriptionPortal(HttpCase): + """Cover the portal exposure of ``sale.subscription``. + + The fixtures build a minimal accounting setup on purpose: the CI database + is installed without demo data nor chart of accounts, so invoices cannot be + posted without declaring an income account, a receivable account and a sale + journal first. + """ + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.portal_group = cls.env.ref("base.group_portal") + cls.draft_stage = cls.env.ref("subscription_oca.subscription_stage_draft") + cls.template = cls.env["sale.subscription.template"].create( + {"name": "Portal Monthly", "code": "PMON"} + ) + cls.pricelist = cls.env["product.pricelist"].create( + { + "name": "Portal Test Pricelist", + "currency_id": cls.env.company.currency_id.id, + } + ) + cls.product = cls.env["product.product"].create( + {"name": "Portal Subscription Service", "type": "service"} + ) + cls.customer = cls.env["res.partner"].create( + {"name": "Portal Customer", "is_company": True} + ) + cls.contact = cls.env["res.partner"].create( + { + "name": "Portal Contact", + "parent_id": cls.customer.id, + "email": "portal.contact@example.org", + } + ) + cls.outsider = cls.env["res.partner"].create( + {"name": "Outsider Customer", "is_company": True} + ) + cls.portal_user = cls._create_portal_user("portal-subscriber", cls.contact) + cls.outsider_user = cls._create_portal_user("portal-outsider", cls.outsider) + cls.subscription = cls._create_subscription(cls.customer) + cls.outsider_subscription = cls._create_subscription(cls.outsider) + cls._setup_minimal_accounting() + + @classmethod + def _create_portal_user(cls, login, partner): + """Create a portal user bound to an existing partner. + + :param login: login and password of the new user. + :param partner: ``res.partner`` record used as the user contact. + :return: the created ``res.users`` record. + """ + return cls.env["res.users"].create( + { + "name": login, + "login": login, + "password": login, + "partner_id": partner.id, + "groups_id": [Command.set(cls.portal_group.ids)], + } + ) + + @classmethod + def _create_subscription(cls, partner): + """Create a one-line subscription billed to ``partner``. + + The stage is forced because ``subscription_oca`` only defaults it when + both ``date_start`` and ``recurring_next_date`` are passed to ``create``. + + :param partner: ``res.partner`` record billed by the subscription. + :return: the created ``sale.subscription`` record. + """ + return cls.env["sale.subscription"].create( + { + "partner_id": partner.id, + "template_id": cls.template.id, + "pricelist_id": cls.pricelist.id, + "stage_id": cls.draft_stage.id, + "sale_subscription_line_ids": [ + Command.create( + { + "product_id": cls.product.id, + "name": "Portal subscription line", + "product_uom_qty": 2.0, + "price_unit": 50.0, + "tax_ids": [Command.clear()], + } + ) + ], + } + ) + + @classmethod + def _setup_minimal_accounting(cls): + """Declare the accounts and journal required to post a customer invoice. + + :return: None. Sets ``cls.income_account`` and ``cls.sale_journal``. + """ + cls.income_account = cls.env["account.account"].create( + { + "name": "Portal Test Income", + "code": "PTI400", + "account_type": "income", + } + ) + receivable_account = cls.env["account.account"].create( + { + "name": "Portal Test Receivable", + "code": "PTR110", + "account_type": "asset_receivable", + "reconcile": True, + } + ) + cls.sale_journal = cls.env["account.journal"].create( + { + "name": "Portal Test Sales", + "code": "PTSAJ", + "type": "sale", + "default_account_id": cls.income_account.id, + } + ) + (cls.customer | cls.contact).property_account_receivable_id = receivable_account + + def _create_subscription_invoice(self, post): + """Create an invoice attached to ``self.subscription``. + + :param post: whether the invoice must be posted; a draft invoice is + invisible to portal users by design. + :return: the created ``account.move`` record. + """ + invoice = self.env["account.move"].create( + { + "move_type": "out_invoice", + "partner_id": self.customer.id, + "journal_id": self.sale_journal.id, + "invoice_date": fields.Date.today(), + "subscription_id": self.subscription.id, + "invoice_line_ids": [ + Command.create( + { + "name": "Portal invoice line", + "quantity": 1.0, + "price_unit": 100.0, + "account_id": self.income_account.id, + "tax_ids": [Command.clear()], + } + ) + ], + } + ) + if post: + invoice.action_post() + invoice.message_subscribe(partner_ids=self.customer.ids) + return invoice + + def _authenticated_open(self, user, url, allow_redirects=True): + """Log ``user`` in and request ``url``. + + :param user: ``res.users`` record whose login equals its password. + :param url: portal URL to request. + :param allow_redirects: whether the client follows redirections. + :return: the ``requests.Response`` object. + """ + self.authenticate(user.login, user.login) + return self.url_open(url, allow_redirects=allow_redirects) + + def test_access_url_points_to_portal_page(self): + self.assertEqual( + self.subscription.access_url, + f"/my/subscriptions/{self.subscription.id}", + ) + + def test_record_rule_hides_other_partners_subscriptions(self): + visible = self.env["sale.subscription"].with_user(self.portal_user).search([]) + self.assertEqual(visible, self.subscription) + + def test_record_rule_hides_other_partners_lines(self): + visible = ( + self.env["sale.subscription.line"].with_user(self.portal_user).search([]) + ) + self.assertEqual(visible, self.subscription.sale_subscription_line_ids) + + def test_list_shows_only_own_subscriptions(self): + response = self._authenticated_open(self.portal_user, "/my/subscriptions") + + self.assertEqual(response.status_code, 200) + self.assertIn(self.subscription.name, response.text) + self.assertNotIn(self.outsider_subscription.name, response.text) + + def test_list_accepts_every_declared_sorting(self): + for sortby in ("date_start", "recurring_next_date", "code"): + with self.subTest(sortby=sortby): + response = self._authenticated_open( + self.portal_user, f"/my/subscriptions?sortby={sortby}" + ) + self.assertEqual(response.status_code, 200) + + def test_detail_is_readable_by_owner(self): + response = self._authenticated_open( + self.portal_user, f"/my/subscriptions/{self.subscription.id}" + ) + + self.assertEqual(response.status_code, 200) + self.assertIn("Portal subscription line", response.text) + + def test_detail_is_denied_to_other_portal_user(self): + response = self._authenticated_open( + self.outsider_user, + f"/my/subscriptions/{self.subscription.id}", + allow_redirects=False, + ) + + self.assertEqual(response.status_code, 303) + self.assertTrue(response.headers["Location"].endswith("/my")) + + def test_detail_is_readable_with_access_token(self): + token = self.subscription._portal_ensure_token() + + # A public session, so that the request resolves to the test database. + self.authenticate(None, None) + response = self.url_open( + f"/my/subscriptions/{self.subscription.id}?access_token={token}" + ) + + self.assertEqual(response.status_code, 200) + self.assertIn("Portal subscription line", response.text) + + def test_home_counter_counts_only_own_subscriptions(self): + self.authenticate(self.portal_user.login, self.portal_user.login) + + counters = self.make_jsonrpc_request( + "/my/counters", {"counters": ["subscription_count"]} + ) + + self.assertEqual(counters["subscription_count"], 1) + + def test_home_declares_the_subscription_entry(self): + response = self._authenticated_open(self.portal_user, "/my") + + self.assertEqual(response.status_code, 200) + self.assertIn("subscription_count", response.text) + + def test_detail_lists_posted_invoices_only(self): + self._create_subscription_invoice(post=False) + posted_invoice = self._create_subscription_invoice(post=True) + + response = self._authenticated_open( + self.portal_user, f"/my/subscriptions/{self.subscription.id}" + ) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.text.count(INVOICE_LINK_CLASS), 1) + self.assertIn(posted_invoice.name, response.text) + + def test_detail_hides_invoices_from_token_visitor(self): + self._create_subscription_invoice(post=True) + token = self.subscription._portal_ensure_token() + + self.authenticate(None, None) + response = self.url_open( + f"/my/subscriptions/{self.subscription.id}?access_token={token}" + ) + + self.assertEqual(response.status_code, 200) + self.assertNotIn(INVOICE_LINK_CLASS, response.text) + + def test_tour(self): + self.start_tour( + "/my", "subscription_oca_portal_tour", login=self.portal_user.login + ) diff --git a/subscription_oca_portal/views/subscription_portal_templates.xml b/subscription_oca_portal/views/subscription_portal_templates.xml new file mode 100644 index 0000000..d2df581 --- /dev/null +++ b/subscription_oca_portal/views/subscription_portal_templates.xml @@ -0,0 +1,307 @@ + + + + + + + +