19.0 vanilla

This commit is contained in:
Ernad Husremovic 2026-03-09 09:31:39 +01:00
parent 5df8c07b59
commit daa394e8b0
2114 changed files with 564841 additions and 299642 deletions

View file

@ -1,10 +1,14 @@
# Part of Odoo. See LICENSE file for full copyright and licensing details.
from markupsafe import Markup
from werkzeug.exceptions import NotFound
from urllib.parse import urlsplit
from pytz import timezone
from odoo import http, tools, _
from odoo.http import request
from odoo.addons.base.models.assetsbundle import AssetsBundle
from odoo import http, _
from odoo.http import content_disposition, request
from odoo.addons.base.models.ir_qweb_fields import nl2br
from odoo.addons.mail.tools.discuss import add_guest_to_context, Store
class LivechatController(http.Controller):
@ -12,32 +16,49 @@ class LivechatController(http.Controller):
# Note: the `cors` attribute on many routes is meant to allow the livechat
# to be embedded in an external website.
@http.route('/im_livechat/external_lib.<any(css,js):ext>', type='http', auth='public')
def livechat_lib(self, ext, **kwargs):
# _get_asset return the bundle html code (script and link list) but we want to use the attachment content
bundle = 'im_livechat.external_lib'
files, _ = request.env["ir.qweb"]._get_asset_content(bundle)
asset = AssetsBundle(bundle, files)
@http.route('/im_livechat/external_lib.<any(css,js):ext>', type='http', auth='public', cors='*')
def external_lib(self, ext, **kwargs):
""" Preserve compatibility with legacy livechat imports. Only
serves javascript since the css will be fetched by the shadow
DOM of the livechat to avoid conflicts.
"""
if ext == 'css':
raise request.not_found()
return self.assets_embed(ext, **kwargs)
mock_attachment = getattr(asset, ext)()
if isinstance(mock_attachment, list): # suppose that CSS asset will not required to be split in pages
mock_attachment = mock_attachment[0]
def _is_cors_request(self):
headers = request.httprequest.headers
origin_url = urlsplit(headers.get("referer"))
return (
origin_url.netloc != headers.get("host")
or origin_url.scheme != request.httprequest.scheme
)
stream = request.env['ir.binary']._get_stream_from(mock_attachment)
@http.route('/im_livechat/assets_embed.<any(css, js):ext>', type='http', auth='public', cors='*')
def assets_embed(self, ext, **kwargs):
# If the request comes from a different origin, we must provide the CORS
# assets to enable the redirection of routes to the CORS controller.
bundle = "im_livechat.assets_embed_cors" if self._is_cors_request() else "im_livechat.assets_embed_external"
asset = request.env["ir.qweb"]._get_asset_bundle(bundle)
if ext not in ('css', 'js'):
raise request.not_found()
stream = request.env['ir.binary']._get_stream_from(getattr(asset, ext)())
return stream.get_response()
@http.route('/im_livechat/load_templates', type='json', auth='none', cors="*")
def load_templates(self, **kwargs):
templates = self._livechat_templates_get()
return [tools.file_open(tmpl, 'rb').read() for tmpl in templates]
@http.route('/im_livechat/font-awesome', type='http', auth='none', cors="*")
def fontawesome(self, **kwargs):
return http.Stream.from_path('web/static/src/libs/fontawesome/fonts/fontawesome-webfont.woff2').get_response()
def _livechat_templates_get(self):
return [
'im_livechat/static/src/legacy/widgets/feedback/feedback.xml',
'im_livechat/static/src/legacy/widgets/public_livechat_window/public_livechat_window.xml',
'im_livechat/static/src/legacy/widgets/public_livechat_view/public_livechat_view.xml',
'im_livechat/static/src/legacy/public_livechat_chatbot.xml',
]
@http.route('/im_livechat/odoo_ui_icons', type='http', auth='none', cors="*")
def odoo_ui_icons(self, **kwargs):
return http.Stream.from_path('web/static/lib/odoo_ui_icons/fonts/odoo_ui_icons.woff2').get_response()
@http.route('/im_livechat/emoji_bundle', type='http', auth='public', cors='*')
def get_emoji_bundle(self):
bundle = 'web.assets_emoji'
asset = request.env["ir.qweb"]._get_asset_bundle(bundle)
stream = request.env['ir.binary']._get_stream_from(asset.js())
return stream.get_response()
@http.route('/im_livechat/support/<int:channel_id>', type='http', auth='public')
def support_page(self, channel_id, **kwargs):
@ -51,107 +72,140 @@ class LivechatController(http.Controller):
info = channel.get_livechat_info(username=username)
return request.render('im_livechat.loader', {'info': info}, headers=[('Content-Type', 'application/javascript')])
@http.route('/im_livechat/init', type='json', auth="public", cors="*")
def livechat_init(self, channel_id):
operator_available = len(request.env['im_livechat.channel'].sudo().browse(channel_id)._get_available_users())
rule = {}
# find the country from the request
country_id = False
country_code = request.geoip.get('country_code')
if country_code:
country_id = request.env['res.country'].sudo().search([('code', '=', country_code)], limit=1).id
# extract url
url = request.httprequest.headers.get('Referer')
# find the first matching rule for the given country and url
matching_rule = request.env['im_livechat.channel.rule'].sudo().match_rule(channel_id, url, country_id)
if matching_rule and (not matching_rule.chatbot_script_id or matching_rule.chatbot_script_id.script_step_ids):
frontend_lang = request.httprequest.cookies.get('frontend_lang', request.env.user.lang or 'en_US')
matching_rule = matching_rule.with_context(lang=frontend_lang)
rule = {
'action': matching_rule.action,
'auto_popup_timer': matching_rule.auto_popup_timer,
'regex_url': matching_rule.regex_url,
def _process_extra_channel_params(self, **kwargs):
# non_persisted_channel_params, persisted_channel_params
return {}, {}
def _get_guest_name(self):
return _("Visitor")
@http.route('/im_livechat/get_session', methods=["POST"], type="jsonrpc", auth='public')
@add_guest_to_context
def get_session(self, channel_id, previous_operator_id=None, chatbot_script_id=None, persisted=True, **kwargs):
channel = request.env["discuss.channel"]
country = request.env["res.country"]
guest = request.env["mail.guest"]
store = Store()
livechat_channel = (
request.env["im_livechat.channel"]
.with_context(lang=False)
.sudo()
.search([("id", "=", channel_id)])
)
if not livechat_channel:
raise NotFound()
if not request.env.user._is_public():
country = request.env.user.country_id
elif request.geoip.country_code:
country = request.env["res.country"].search(
[("code", "=", request.geoip.country_code)], limit=1
)
operator_info = livechat_channel._get_operator_info(
previous_operator_id=previous_operator_id,
chatbot_script_id=chatbot_script_id,
country_id=country.id,
lang=request.cookies.get("frontend_lang"),
**kwargs
)
if not operator_info['operator_partner']:
return False
chatbot_script = operator_info['chatbot_script']
is_chatbot_script = operator_info['operator_model'] == 'chatbot.script'
non_persisted_channel_params, persisted_channel_params = self._process_extra_channel_params(**kwargs)
if not persisted:
channel_id = -1 # only one temporary thread at a time, id does not matter.
chatbot_data = None
if is_chatbot_script:
welcome_steps = chatbot_script._get_welcome_steps()
chatbot_data = {
"script": chatbot_script.id,
"steps": welcome_steps.mapped(lambda s: {"scriptStep": s.id}),
}
store.add(chatbot_script)
store.add(welcome_steps)
channel_info = {
"fetchChannelInfoState": "fetched",
"id": channel_id,
"isLoaded": True,
"livechat_operator_id": Store.One(
operator_info["operator_partner"], self.env["discuss.channel"]._store_livechat_operator_id_fields(),
),
"scrollUnread": False,
"channel_type": "livechat",
"chatbot": chatbot_data,
**non_persisted_channel_params,
}
if matching_rule.chatbot_script_id.active and (not matching_rule.chatbot_only_if_no_operator or
(not operator_available and matching_rule.chatbot_only_if_no_operator)) and matching_rule.chatbot_script_id.script_step_ids:
chatbot_script = matching_rule.chatbot_script_id
rule.update({'chatbot': chatbot_script._format_for_frontend()})
store.add_model_values("discuss.channel", channel_info)
else:
if request.env.user._is_public():
guest = guest.sudo()._get_or_create_guest(
guest_name=self._get_guest_name(),
country_code=request.geoip.country_code,
timezone=request.env["mail.guest"]._get_timezone_from_request(request),
)
livechat_channel = livechat_channel.with_context(guest=guest)
request.update_context(guest=guest)
channel_vals = livechat_channel._get_livechat_discuss_channel_vals(**operator_info)
channel_vals.update(**persisted_channel_params)
lang = request.env["res.lang"].search(
[("code", "=", request.cookies.get("frontend_lang"))]
)
channel_vals.update({"country_id": country.id, "livechat_lang_id": lang.id})
channel = request.env['discuss.channel'].with_context(
lang=request.env['chatbot.script']._get_chatbot_language()
).sudo().create(channel_vals)
channel_id = channel.id
if is_chatbot_script:
chatbot_script._post_welcome_steps(channel)
if not is_chatbot_script or chatbot_script.operator_partner_id != channel.livechat_operator_id:
channel._broadcast([channel.livechat_operator_id.id])
if guest:
store.add_global_values(guest_token=guest.sudo()._format_auth_cookie())
request.env["res.users"]._init_store_data(store)
# Make sure not to send "isLoaded" value on the guest bus, otherwise it
# could be overwritten.
if channel:
store.add(
channel,
extra_fields={
"isLoaded": not is_chatbot_script,
"scrollUnread": False,
},
)
if not request.env.user._is_public():
store.add(
request.env.user.partner_id,
{"email": request.env.user.partner_id.email},
)
return {
'available_for_me': (rule and rule.get('chatbot'))
or operator_available and (not rule or rule['action'] != 'hide_button'),
'rule': rule,
"store_data": store.get_result(),
"channel_id": channel_id,
}
@http.route('/im_livechat/operator/<int:operator_id>/avatar',
type='http', auth="public", cors="*")
def livechat_operator_get_avatar(self, operator_id):
""" Custom route allowing to retrieve an operator's avatar.
This is done to bypass more complicated rules, notably 'website_published' when the website
module is installed.
Here, we assume that if you are a member of at least one im_livechat.channel, then it's ok
to make your avatar publicly available.
We also make the chatbot operator avatars publicly available. """
is_livechat_member = False
operator = request.env['res.partner'].sudo().browse(operator_id)
if operator.exists():
is_livechat_member = bool(request.env['im_livechat.channel'].sudo().search_count([
('user_ids', 'in', operator.user_ids.ids)
]))
if not is_livechat_member:
# we don't put chatbot operators as livechat members (because we don't have a user_id for them)
is_livechat_member = bool(request.env['chatbot.script'].sudo().search_count([
('operator_partner_id', 'in', operator.ids)
]))
return request.env['ir.binary']._get_image_stream_from(
operator if is_livechat_member else request.env['res.partner'],
field_name='avatar_128',
placeholder='mail/static/src/img/smiley/avatar.jpg',
).get_response()
@http.route('/im_livechat/get_session', type="json", auth='public', cors="*")
def get_session(self, channel_id, anonymous_name, previous_operator_id=None, chatbot_script_id=None, persisted=True, **kwargs):
user_id = None
country_id = None
# if the user is identifiy (eg: portal user on the frontend), don't use the anonymous name. The user will be added to session.
if request.session.uid:
user_id = request.env.user.id
country_id = request.env.user.country_id.id
else:
# if geoip, add the country name to the anonymous name
if request.geoip:
# get the country of the anonymous person, if any
country_code = request.geoip.get('country_code', "")
country = request.env['res.country'].sudo().search([('code', '=', country_code)], limit=1) if country_code else None
if country:
country_id = country.id
if previous_operator_id:
previous_operator_id = int(previous_operator_id)
chatbot_script = False
if chatbot_script_id:
frontend_lang = request.httprequest.cookies.get('frontend_lang', request.env.user.lang or 'en_US')
chatbot_script = request.env['chatbot.script'].sudo().with_context(lang=frontend_lang).browse(chatbot_script_id)
return request.env["im_livechat.channel"].with_context(lang=False).sudo().browse(channel_id)._open_livechat_mail_channel(
anonymous_name,
previous_operator_id=previous_operator_id,
chatbot_script=chatbot_script,
user_id=user_id,
country_id=country_id,
persisted=persisted
def _post_feedback_message(self, channel, rating, reason):
body = Markup(
"""<div class="o_mail_notification o_hide_author">"""
"""%(rating)s: <img class="o_livechat_emoji_rating" src="%(rating_url)s" alt="rating"/>%(reason)s"""
"""</div>"""
) % {
"rating": _("Rating"),
"rating_url": rating.rating_image_url,
"reason": nl2br("\n" + reason) if reason else "",
}
# sudo: discuss.channel - not necessary for posting, but necessary to update related rating
channel.sudo().message_post(
body=body,
message_type="notification",
rating_id=rating.id,
subtype_xmlid="mail.mt_comment",
)
@http.route('/im_livechat/feedback', type='json', auth='public', cors="*")
def feedback(self, uuid, rate, reason=None, **kwargs):
channel = request.env['mail.channel'].sudo().search([('uuid', '=', uuid)], limit=1)
if channel:
@http.route("/im_livechat/feedback", type="jsonrpc", auth="public")
@add_guest_to_context
def feedback(self, channel_id, rate, reason=None, **kwargs):
if channel := request.env["discuss.channel"].search([("id", "=", channel_id)]):
# limit the creation : only ONE rating per session
values = {
'rating': rate,
@ -159,13 +213,15 @@ class LivechatController(http.Controller):
'feedback': reason,
'is_internal': False,
}
if not channel.rating_ids:
# sudo: rating.rating - visitor can access rating to check if
# feedback was already given
if not channel.sudo().rating_ids:
values.update({
'res_id': channel.id,
'res_model_id': request.env['ir.model']._get_id('mail.channel'),
'res_model_id': request.env['ir.model']._get_id('discuss.channel'),
})
# find the partner (operator)
if channel.channel_partner_ids:
# sudo: res.partner - visitor must find the operator to rate
if channel.sudo().channel_partner_ids:
values['rated_partner_id'] = channel.channel_partner_ids[0].id
# if logged in user, set its partner on rating
values['partner_id'] = request.env.user.partner_id.id if request.session.uid else False
@ -173,46 +229,57 @@ class LivechatController(http.Controller):
rating = request.env['rating.rating'].sudo().create(values)
else:
rating = channel.rating_ids[0]
rating.write(values)
# sudo: rating.rating - guest or portal user can update their livechat rating
rating.sudo().write(values)
self._post_feedback_message(channel, rating, reason)
return rating.id
return False
@http.route('/im_livechat/history', type="json", auth="public", cors="*")
def history_pages(self, pid, channel_uuid, page_history=None):
partner_ids = (pid, request.env.user.partner_id.id)
channel = request.env['mail.channel'].sudo().search([('uuid', '=', channel_uuid), ('channel_partner_ids', 'in', partner_ids)])
if channel:
channel._send_history_message(pid, page_history)
return True
@http.route("/im_livechat/history", type="jsonrpc", auth="public")
@add_guest_to_context
def history_pages(self, pid, channel_id, page_history=None):
if channel := request.env["discuss.channel"].search([("id", "=", channel_id)]):
if pid in channel.sudo().channel_member_ids.partner_id.ids:
request.env["res.partner"].browse(pid)._bus_send_history_message(channel, page_history)
@http.route('/im_livechat/notify_typing', type='json', auth='public', cors="*")
def notify_typing(self, uuid, is_typing):
""" Broadcast the typing notification of the website user to other channel members
:param uuid: (string) the UUID of the livechat channel
:param is_typing: (boolean) tells whether the website user is typing or not.
"""
channel = request.env['mail.channel'].sudo().search([('uuid', '=', uuid)])
if not channel:
@http.route("/im_livechat/email_livechat_transcript", type="jsonrpc", auth="user")
@add_guest_to_context
def email_livechat_transcript(self, channel_id, email):
if not request.env.user._is_internal():
raise NotFound()
channel_member = channel.env['mail.channel.member'].search([('channel_id', '=', channel.id), ('partner_id', '=', request.env.user.partner_id.id)])
if not channel_member:
raise NotFound()
channel_member._notify_typing(is_typing=is_typing)
@http.route('/im_livechat/email_livechat_transcript', type='json', auth='public', cors="*")
def email_livechat_transcript(self, uuid, email):
channel = request.env['mail.channel'].sudo().search([
('channel_type', '=', 'livechat'),
('uuid', '=', uuid)], limit=1)
if channel:
if channel := request.env["discuss.channel"].search([("id", "=", channel_id)]):
channel._email_livechat_transcript(email)
@http.route('/im_livechat/visitor_leave_session', type='json', auth="public")
def visitor_leave_session(self, uuid):
""" Called when the livechat visitor leaves the conversation.
This will clean the chat request and warn the operator that the conversation is over.
This allows also to re-send a new chat request to the visitor, as while the visitor is
in conversation with an operator, it's not possible to send the visitor a chat request."""
mail_channel = request.env['mail.channel'].sudo().search([('uuid', '=', uuid)])
if mail_channel:
mail_channel._close_livechat_session()
@http.route("/im_livechat/download_transcript/<int:channel_id>", type="http", auth="public")
@add_guest_to_context
def download_livechat_transcript(self, channel_id):
channel = request.env["discuss.channel"].search([("id", "=", channel_id)])
if not channel:
raise NotFound()
partner, guest = request.env["res.partner"]._get_current_persona()
tz = timezone(partner.tz or guest.timezone or "UTC")
pdf, _type = (
request.env["ir.actions.report"]
.sudo()
._render_qweb_pdf(
"im_livechat.action_report_livechat_conversation",
channel.ids,
data={"company": request.env.company, "tz": tz},
)
)
headers = [
("Content-Disposition", content_disposition(f"transcript_{channel.id}.pdf", "inline")),
("Content-Length", len(pdf)),
("Content-Type", "application/pdf"),
]
return request.make_response(pdf, headers=headers)
@http.route("/im_livechat/visitor_leave_session", type="jsonrpc", auth="public")
@add_guest_to_context
def visitor_leave_session(self, channel_id):
"""Called when the livechat visitor leaves the conversation.
This will clean the chat request and warn the operator that the conversation is over.
This allows also to re-send a new chat request to the visitor, as while the visitor is
in conversation with an operator, it's not possible to send the visitor a chat request."""
if channel := request.env["discuss.channel"].search([("id", "=", channel_id)]):
channel._close_livechat_session()