[REM] website_event_online: merge into website_event

PURPOSE

Clean organization and models linked to Event Online feature introduced in
semi stable saas-13.3 at odoo/odoo@981f95bbf46658eda9f2d33751b9310cc67d86aa and odoo/enterprise@14722028ae0773c3710ea48ce48ff44703e83b5a

Also clean website event menu not being available in website event but only
in website event track, which implies some extra-code to manage it.

In short: merge website_event_online in website_event, website_event_track
_(online/session) in website_event_track.

RATIONALE

_online modules have been added to extend content of website_event and
website_event_track without having any impact on those module. First step
of cleaning is to move this content directly in base module.

track_session module is mainly a rewrite of track module. Second step of
cleaning is to move its content directly in website_event_track.

SPECIFICATIONS

Move remaining content of website event online to website event.

Update dependencies accordingly.

LINKS

Task ID-2319779
COM odoo/odoo#56067
ENT odoo/enterprise#12520
UPG odoo/upgrade#1654

4 files changed, 221 insertions, 7 deletions

diff --git a/addons/website_event/models/__init__.py b/addons/website_event/models/__init__.py
index f49b644b04f..cce22a56c9e 100644
--- a/addons/website_event/models/__init__.py
+++ b/addons/website_event/models/__init__.py
@@ -1,7 +1,10 @@
 # -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
 
 from . import event_event
+from . import event_registration
 from . import event_type
 from . import website
 from . import website_event_menu
 from . import website_menu
+from . import website_visitor
diff --git a/addons/website_event/models/event_event.py b/addons/website_event/models/event_event.py
index 7cf5f4e6b05..162cdf8cd55 100644
--- a/addons/website_event/models/event_event.py
+++ b/addons/website_event/models/event_event.py
@@ -4,8 +4,11 @@
 import json
 import werkzeug.urls
 
+from pytz import utc
+
 from odoo import api, fields, models, _
 from odoo.addons.http_routing.models.ir_http import slug
+from odoo.osv import expression
 
 GOOGLE_CALENDAR_URL = 'https://www.google.com/calendar/render?'
 
@@ -36,6 +39,9 @@ class Event(models.Model):
         help="Creates menus Introduction, Location and Register on the page "
              "of the event on the website.")
     menu_id = fields.Many2one('website.menu', 'Event Menu', copy=False)
+    menu_register_cta = fields.Boolean(
+        'Add Register Button', compute='_compute_menu_register_cta',
+        readonly=False, store=True)
     community_menu = fields.Boolean(
         "Community Menu", compute="_compute_community_menu",
         readonly=False, store=True,
@@ -43,16 +49,58 @@ class Event(models.Model):
     community_menu_ids = fields.One2many(
         "website.event.menu", "event_id", string="Event Community Menus",
         domain=[("menu_type", "=", "community")])
+    # live information
+    is_ongoing = fields.Boolean(
+        'Is Ongoing', compute='_compute_time_data', search='_search_is_ongoing',
+        help="Whether event has begun")
+    is_done = fields.Boolean(
+        'Is Done', compute='_compute_time_data',
+        help="Whether event is finished")
+    start_today = fields.Boolean(
+        'Start Today', compute='_compute_time_data',
+        help="Whether event is going to start today if still not ongoing")
+    start_remaining = fields.Integer(
+        'Remaining before start', compute='_compute_time_data',
+        help="Remaining time before event starts (minutes)")
 
     def _compute_is_participating(self):
-        # we don't allow public user to see participating label
-        if self.env.user != self.env['website'].get_current_website().user_id:
-            email = self.env.user.partner_id.email
-            for event in self:
-                domain = ['&', '|', ('email', '=', email), ('partner_id', '=', self.env.user.partner_id.id), ('event_id', '=', event.id)]
-                event.is_participating = self.env['event.registration'].sudo().search_count(domain)
+        """Heuristic
+
+          * public, no visitor: not participating as we have no information;
+          * public and visitor: check visitor is linked to a registration. As
+            visitors are merged on the top parent, current visitor check is
+            sufficient even for successive visits;
+          * logged, no visitor: check partner is linked to a registration. Do
+            not check the email as it is not really secure;
+          * logged as visitor: check partner or visitor are linked to a
+            registration;
+        """
+        current_visitor = self.env['website.visitor']._get_visitor_from_request(force_create=False)
+        if self.env.user._is_public() and not current_visitor:
+            events = self.env['event.event']
+        elif self.env.user._is_public():
+            events = self.env['event.registration'].sudo().search([
+                ('event_id', 'in', self.ids),
+                ('visitor_id', '=', current_visitor.id),
+            ]).event_id
         else:
-            self.is_participating = False
+            if current_visitor:
+                domain = [
+                    '|',
+                    ('partner_id', '=', self.env.user.partner_id.id),
+                    ('visitor_id', '=', current_visitor.id)
+                ]
+            else:
+                domain = [('partner_id', '=', self.env.user.partner_id.id)]
+            events = self.env['event.registration'].sudo().search(
+                expression.AND([
+                    domain,
+                    [('event_id', 'in', self.ids)]
+                ])
+            ).event_id
+
+        for event in self:
+            event.is_participating = event in events
 
     @api.depends('event_type_id')
     def _compute_website_menu(self):
@@ -75,6 +123,28 @@ class Event(models.Model):
             elif not event.website_menu:
                 event.community_menu = False
 
+    @api.depends('website_menu')
+    def _compute_menu_register_cta(self):
+        for event in self:
+            event.menu_register_cta = event.website_menu
+
+    @api.depends('date_begin', 'date_end')
+    def _compute_time_data(self):
+        """ Compute start and remaining time. Do everything in UTC as we compute only
+        time deltas here. """
+        now_utc = utc.localize(fields.Datetime.now().replace(microsecond=0))
+        for event in self:
+            date_begin_utc = utc.localize(event.date_begin, is_dst=False)
+            date_end_utc = utc.localize(event.date_end, is_dst=False)
+            event.is_ongoing = date_begin_utc <= now_utc <= date_end_utc
+            event.is_done = now_utc > date_end_utc
+            event.start_today = date_begin_utc.date() == now_utc.date()
+            if date_begin_utc >= now_utc:
+                td = date_begin_utc - now_utc
+                event.start_remaining = int(td.total_seconds() / 60)
+            else:
+                event.start_remaining = 0
+
     @api.depends('name')
     def _compute_website_url(self):
         super(Event, self)._compute_website_url()
@@ -82,6 +152,10 @@ class Event(models.Model):
             if event.id:  # avoid to perform a slug on a not yet saved record in case of an onchange.
                 event.website_url = '/event/%s' % slug(event)
 
+    # ------------------------------------------------------------
+    # CRUD
+    # ------------------------------------------------------------
+
     @api.model
     def create(self, vals):
         res = super(Event, self).create(vals)
diff --git a/addons/website_event/models/event_registration.py b/addons/website_event/models/event_registration.py
new file mode 100644
index 00000000000..8b56c14f742
--- /dev/null
+++ b/addons/website_event/models/event_registration.py
@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import fields, models
+
+
+class EventRegistration(models.Model):
+    _name = 'event.registration'
+    _inherit = ['event.registration']
+
+    visitor_id = fields.Many2one('website.visitor', string='Visitor', ondelete='set null')
diff --git a/addons/website_event/models/website_visitor.py b/addons/website_event/models/website_visitor.py
new file mode 100644
index 00000000000..078e4f03296
--- /dev/null
+++ b/addons/website_event/models/website_visitor.py
@@ -0,0 +1,126 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import api, fields, models
+
+
+class WebsiteVisitor(models.Model):
+    _name = 'website.visitor'
+    _inherit = ['website.visitor']
+
+    parent_id = fields.Many2one(
+        'website.visitor', string="Parent", ondelete='set null',
+        help="Main identity")
+    event_registration_ids = fields.One2many(
+        'event.registration', 'visitor_id', string='Event Registrations',
+        groups="event.group_event_user")
+    event_registration_count = fields.Integer(
+        '# Registrations', compute='_compute_event_registration_count',
+        groups="event.group_event_user")
+    event_registered_ids = fields.Many2many(
+        'event.event', string="Registered Events",
+        compute="_compute_event_registered_ids", compute_sudo=True,
+        search="_search_event_registered_ids",
+        groups="event.group_event_user")
+
+    @api.depends('event_registration_ids')
+    def _compute_event_registration_count(self):
+        if self.ids:
+            read_group_res = self.env['event.registration'].read_group(
+                [('visitor_id', 'in', self.ids)],
+                ['visitor_id'], ['visitor_id'])
+            visitor_mapping = dict(
+                (item['visitor_id'][0], item['visitor_id_count'])
+                for item in read_group_res)
+        else:
+            visitor_mapping = dict()
+        for visitor in self:
+            visitor.event_registration_count = visitor_mapping.get(visitor.id) or 0
+
+    @api.depends('event_registration_ids.email', 'event_registration_ids.mobile', 'event_registration_ids.phone')
+    def _compute_email_phone(self):
+        super(WebsiteVisitor, self)._compute_email_phone()
+        self.flush()
+
+        for visitor in self.filtered(lambda visitor: not visitor.email or not visitor.mobile):
+            linked_registrations = visitor.event_registration_ids.sorted(lambda reg: (reg.create_date, reg.id), reverse=False)
+            if not visitor.email:
+                visitor.email = next((reg.email for reg in linked_registrations if reg.email), False)
+            if not visitor.mobile:
+                visitor.mobile = next((reg.mobile or reg.phone for reg in linked_registrations if reg.mobile or reg.phone), False)
+
+    @api.depends('parent_id', 'event_registration_ids')
+    def _compute_event_registered_ids(self):
+        # include parent's registrations in a visitor o2m field. We don't add
+        # child one as child should not have registrations (moved to the parent)
+        for visitor in self:
+            all_registrations = visitor.event_registration_ids | visitor.parent_id.event_registration_ids
+            visitor.event_registered_ids = all_registrations.mapped('event_id')
+
+    def _search_event_registered_ids(self, operator, operand):
+        """ Search visitors with terms on events within their event registrations. E.g. [('event_registered_ids',
+        'in', [1, 2])] should return visitors having a registration on events 1, 2 as
+        well as their children for notification purpose. """
+        if operator == "not in":
+            raise NotImplementedError("Unsupported 'Not In' operation on visitors registrations")
+
+        all_registrations = self.env['event.registration'].sudo().search([
+            ('event_id', operator, operand)
+        ])
+        if all_registrations:
+            # search children, even archived one, to contact them
+            visitors = all_registrations.with_context(active_test=False).mapped('visitor_id')
+            children = self.env['website.visitor'].with_context(
+                active_test=False
+            ).sudo().search([('parent_id', 'in', visitors.ids)])
+            visitor_ids = (visitors + children).ids
+        else:
+            visitor_ids = []
+
+        return [('id', 'in', visitor_ids)]
+
+    def _link_to_partner(self, partner, update_values=None):
+        """ Propagate partner update to registration records """
+        if partner:
+            registration_wo_partner = self.event_registration_ids.filtered(lambda registration: not registration.partner_id)
+            if registration_wo_partner:
+                registration_wo_partner.partner_id = partner
+        super(WebsiteVisitor, self)._link_to_partner(partner, update_values=update_values)
+
+    def _link_to_visitor(self, target, keep_unique=True):
+        """ Override linking process to link registrations to the final visitor. """
+        self.event_registration_ids.write({'visitor_id': target.id})
+
+        res = super(WebsiteVisitor, self)._link_to_visitor(target, keep_unique=False)
+
+        if keep_unique:
+            self.partner_id = False
+            self.parent_id = target.id
+            self.active = False
+
+        return res
+
+    def _get_visitor_from_request(self, force_create=False):
+        """ When fetching visitor, now that duplicates are linked to a main visitor
+        instead of unlinked, you may have more collisions issues with cookie being
+        set after a de-connection for example.
+
+        In base method, visitor associated to a partner in case of public user is
+        not taken into account. It is considered as desynchronized cookie. Here
+        we also discard if the visitor has a main visitor whose partner is set
+        (aka wrong after logout partner). """
+        visitor = super(WebsiteVisitor, self)._get_visitor_from_request(force_create=force_create)
+
+        # also check that visitor parent partner is not different from user's one (indicates duplicate due to invalid or wrong cookie)
+        if visitor and visitor.parent_id.partner_id:
+            if self.env.user._is_public():
+                visitor = self.env['website.visitor'].sudo()
+            elif not visitor.partner_id:
+                visitor = self.env['website.visitor'].sudo().with_context(active_test=False).search(
+                    [('partner_id', '=', self.env.user.partner_id.id)]
+                )
+
+        if not visitor and force_create:
+            visitor = self._create_visitor()
+
+        return visitor