tsm-odoo
de6de48deb
*: hr_presence, web_editor.
This commit is part of the websocket integration in Odoo.
It focuses on adapting the bus to support websockets:
- last notification id is now kept on the server
- channel list is built by overriding the `_build_bus_channel_list`
method of the `ir_websocket` model instead of overriding the `_poll`
method of the bus controller.
- The bus presence was updated during polls, since there is no more poll,
bus presence update will be the responsability of the client.
- The `/websocket/peek_notifications`, `/websocket/update_bus_presence`
routes will be available so that odoo sh can access notifications/update presence
from http requests.
- /longpolling routes are now prefixed with /bus thus won't be redirected to the
gevent worker anymore except for `/longpolling/health` which is the
health check route of the gevent server.
Since websocket now handle incoming messages, a way to manage authentication
have been introduced :
- The session is retrieved from the HTTP handshake.
- When a websocket message comes/leaves the session is retrieved
on the file system so that we're sure it still exists and that
it is up to date.
- The session is checked
- If no session is found on the file system or `check_session`
fails, the websocket connection is closed with the `SESSION_EXPIRED`
close code (which is a custom close code: 4001).
- Note that websocket connections are closed every `KEEP_ALIVE_TIMEOUT`
seconds to ensure no websocket connection will stay open if the user
clears its cookies.
- Note that a wsrequest object is available when processing incoming
messages. It is similar to the http request and contains various
useful informations (session, env, ...).
Part-of: odoo/odoo#75510
43 lines
1.5 KiB
Python
43 lines
1.5 KiB
Python
from odoo import models
|
|
from odoo.http import SessionExpiredException
|
|
from odoo.service import security
|
|
from ..models.bus import dispatch
|
|
from ..websocket import wsrequest
|
|
|
|
class IrWebsocket(models.AbstractModel):
|
|
_name = 'ir.websocket'
|
|
_description = 'websocket message handling'
|
|
|
|
def _build_bus_channel_list(self, channels):
|
|
"""
|
|
Return the list of channels to subscribe to. Override this
|
|
method to add channels in addition to the ones the client
|
|
sent.
|
|
|
|
:param channels: The channel list sent by the client.
|
|
"""
|
|
channels.append('broadcast')
|
|
return channels
|
|
|
|
def _subscribe(self, data):
|
|
channels = set(self._build_bus_channel_list(data['channels']))
|
|
dispatch.subscribe(channels, data['last'], self.env.registry.db_name, wsrequest.ws)
|
|
|
|
def _update_bus_presence(self, inactivity_period):
|
|
if self.env.uid:
|
|
self.env['bus.presence'].update(
|
|
inactivity_period,
|
|
identity_field='user_id',
|
|
identity_value=self.env.uid
|
|
)
|
|
|
|
@classmethod
|
|
def _authenticate(cls):
|
|
if wsrequest.session.uid is not None:
|
|
if not security.check_session(wsrequest.session, wsrequest.env):
|
|
wsrequest.session.logout(keep_db=True)
|
|
raise SessionExpiredException()
|
|
else:
|
|
public_user = wsrequest.env.ref('base.public_user')
|
|
wsrequest.update_env(user=public_user.id)
|