[IMP] website_event, website_event_sale: adapt JsonLd builder

Author: gppa-odoo

addons/website_event/controllers/main.py

@@ -187,7 +187,8 @@ def events(self, page=1, slug_tags=None, **searches):
             'slugify_tags': self._slugify_tags,
             'search_count': event_count,
             'original_search': fuzzy_search_term and search,
-            'website': website
+            'website': website,
+            'structured_data': events._to_structured_data(),
         }
 
         return request.render("website_event.index", values)
@@ -219,6 +220,7 @@ def event_page(self, event, page, **post):
             page = view.key if view else page
             values['seo_object'] = request.website.get_template(page)
             values['main_object'] = event
+            values['structured_data'] = event._to_structured_data(is_detail_page=True)
         except ValueError:
             # page not found
             page = 'website.page_404'
@@ -264,6 +266,7 @@ def _prepare_event_register_values(self, event, **post):
         return {
             'event': event,
             'main_object': event,
+            'structured_data': event._to_structured_data(is_detail_page=True),
             'range': range,
             'google_url': lazy(lambda: urls.get('google_url')),
             'iCal_url': lazy(lambda: urls.get('iCal_url')),

addons/website_event/models/event_event.py

@@ -10,6 +10,8 @@
 from markupsafe import Markup
 
 from odoo import api, fields, models, tools, _
+from odoo.addons.website.helpers.jsonld_builder import JsonLd
+from odoo.addons.website.tools import text_from_html
 from odoo.exceptions import UserError, ValidationError
 from odoo.fields import Domain
 from odoo.tools.misc import get_lang, format_date
@@ -26,6 +28,7 @@ class EventEvent(models.Model):
         'website.cover_properties.mixin',
         'website.searchable.mixin',
         'website.page_visibility_options.mixin',
+        'website.structured_data.mixin',
     ]
 
     def _default_cover_properties(self):
@@ -650,3 +653,128 @@ def _search_render_results(self, fetch_fields, mapping, icon, limit):
             data['tag_ids'] = event.tag_ids.read(['name'])
             data['image_url'] = event._get_image_url()
         return results_data
+
+    def _to_structured_data_summary_event(self):
+        """Return summary structured data for a single event card."""
+        self.ensure_one()
+        if not self.address_id or self.is_ongoing or self.is_done or self.website_visibility != 'public':
+            # Google event rich results require a public upcoming event with
+            # a physical place.
+            return None
+
+        website = self.env['website'].get_current_website()
+        base_url = website.get_base_url()
+
+        image = None
+        if image_url := website.image_url(self, 'image_1920'):
+            image = JsonLd("ImageObject", {"url": f"{base_url}{image_url}"})
+
+        address = self.address_id.sudo()
+        street = ', '.join(part for part in (address.street, address.street2) if part)
+        location = JsonLd("Place", {"name": self.address_name}).add_nested({
+            "address": JsonLd("PostalAddress", {
+                "street_address": street or None,
+                "address_locality": address.city or None,
+                "postal_code": address.zip or None,
+                "address_region": address.state_id.code or None,
+                "address_country": address.country_id.code or None,
+            }),
+        })
+
+        return JsonLd("Event", {
+            "name": self.name,
+            "url": self.website_absolute_url,
+            "start_date": JsonLd.datetime(self.date_begin),
+        }).add_nested({
+            "image": image,
+            "location": location,
+        })
+
+    def _to_structured_data_event(self):
+        """Return full structured data for a single event detail page."""
+        self.ensure_one()
+        event_data = self._to_structured_data_summary_event()
+        if not event_data:
+            return None
+
+        description = self.subtitle or (self.description and text_from_html(self.description, True))
+        organizer = None
+        if self.organizer_id:
+            organizer_sudo = self.organizer_id.sudo()
+            organizer = JsonLd("Organization", {"name": organizer_sudo.name})
+            if organizer_sudo.website:
+                organizer.set({"url": organizer_sudo.website})
+
+        event_status = "EventCancelled" if self.kanban_state == 'cancel' else "EventScheduled"
+        return event_data.set({
+            "end_date": JsonLd.datetime(self.date_end),
+            "description": description,
+            "event_status": f"https://schema.org/{event_status}",
+            "event_attendance_mode": "https://schema.org/OfflineEventAttendanceMode",
+        }).add_nested({
+            "organizer": organizer,
+            "offers": [self._to_structured_data_ticket_offer(ticket) for ticket in self.event_ticket_ids],
+        })
+
+    def _to_structured_data_ticket_offer(self, ticket):
+        """Create a JSON-LD Offer for a single event ticket."""
+        now = fields.Datetime.now()
+        is_expired = ticket.end_sale_datetime and ticket.end_sale_datetime < now
+        availability = (
+            "https://schema.org/SoldOut"
+            if ticket.is_sold_out or is_expired
+            else "https://schema.org/InStock"
+        )
+
+        offer = JsonLd("Offer", {
+            "name": ticket.name,
+            "availability": availability,
+            "valid_from": JsonLd.datetime(ticket.start_sale_datetime),
+            "valid_through": JsonLd.datetime(ticket.end_sale_datetime),
+        })
+        if availability == "https://schema.org/InStock":
+            offer.set({"url": f"{self.website_absolute_url}/register"})
+        return offer
+
+    def _to_structured_data_collectionpage(self):
+        """Return CollectionPage structured data for the events listing page."""
+        website = self.env['website'].get_current_website()
+        base_url = website.get_base_url()
+        return JsonLd("CollectionPage", {
+            "name": self.env._("Events"),
+            "url": f"{base_url}/event",
+        }).add_nested({
+            "has_part": [event._to_structured_data_summary_event() for event in self],
+            "is_part_of": JsonLd("Organization", {"id": f"{base_url}/#organization"}),
+        })
+
+    def _get_breadcrumb_items(self):
+        """Return breadcrumb items for a single event page."""
+        self.ensure_one()
+        website = self.env['website'].get_current_website()
+        base_url = website.get_base_url()
+        return [
+            (website.name, base_url),
+            (self.env._("Events"), f"{base_url}/event"),
+            (self.name, f"{base_url}{self.website_url}"),
+        ]
+
+    def _to_structured_data(self, is_detail_page=False):
+        """Return rendered structured data for event list and detail pages."""
+        schemas = super()._to_structured_data(is_detail_page=is_detail_page)
+        if is_detail_page:
+            self.ensure_one()
+            if event_schema := self._to_structured_data_event():
+                schemas.append(event_schema)
+            items = self._get_breadcrumb_items()
+        else:
+            website = self.env['website'].get_current_website()
+            base_url = website.get_base_url()
+            if self:
+                schemas.append(self._to_structured_data_collectionpage())
+            items = [
+                (website.name, base_url),
+                (self.env._("Events"), f"{base_url}/event"),
+            ]
+        schemas.append(self._get_breadcrumb_structured_data(items))
+        return JsonLd.render_structured_data(schemas)

addons/website_event_sale/models/__init__.py

@@ -1,3 +1,4 @@
+from . import event_event
 from . import product
 from . import product_pricelist
 from . import sale_order

addons/website_event_sale/models/event_event.py

@@ -0,0 +1,28 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import models
+
+
+class EventEvent(models.Model):
+    _inherit = 'event.event'
+
+    def _to_structured_data_ticket_offer(self, ticket):
+        """Add ticket pricing to the structured data offer.
+
+        Uses the tax-included or tax-excluded price depending on the
+        website ``show_line_subtotals_tax_selection`` setting, matching
+        the price displayed on the event page.
+        """
+        offer = super()._to_structured_data_ticket_offer(ticket)
+        if not offer:
+            return offer
+        website = self.env['website'].get_current_website()
+        if website.show_line_subtotals_tax_selection == 'tax_excluded':
+            price = ticket.total_price_reduce
+        else:
+            price = ticket.total_price_reduce_taxinc
+        offer.set({
+            'price': price,
+            'price_currency': self.company_id.currency_id.name,
+        })
+        return offer