audrius/server-backend
1
0
Fork 0
mirror of https://github.com/OCA/server-backend.git synced 2025-02-18 09:52:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] base_ical: Allow advanced snippets. Use apikeys with scope.

Browse Source
This commit is contained in:
fkantelberg
2024-04-23 18:44:20 +02:00
parent 1e6b6ceda7
commit d7f8964db6
17 changed files with 564 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
base_ical/README.rst
View File

@@ -2,13 +2,10 @@
Readonly publishing of calendars
================================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:f98a0b075e11b8bf4075af16bbe8ba8b249d03f4b675874d232c68a897235579
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
:target: https://odoo-community.org/page/development-status
@@ -23,10 +20,10 @@ Readonly publishing of calendars
:target: https://translation.odoo-community.org/projects/server-backend-15-0/server-backend-15-0-base_ical
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=15.0
:target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/server-backend&target_branch=15.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allows administrators to configure iCalendars based on an arbitrary selection on arbitrary models.
@@ -50,13 +47,45 @@ Configuration
To configure this module, you need to:
#. Go to Settings/Technical/iCalendars
#. Create a calendar, fill in the model you want to expose and possibly a domain to restrict records. You can use the ``user`` variable to restrict things relative to the user using the calendar
#. A few iCalendar-fields have defaults that should work for any model, you'll have to fill in expressions manually though for the start and end date of the records.
#. Create a iCalendar, fill in the model you want to expose and possibly a domain to restrict records. You can use the ``user`` variable to restrict things relative to the user using the iCalendar
#. A iCalendar is only available to the allowed users. Use the `Allow automatically` to make the iCalendar available to all users
#. See the examples below for a start
For example, for model ``calendar.event``, you'd fill in ``record.allday and record.start_date or record.start`` as `DTSTART` and ``record.allday and record.stop_date or record.stop`` as `DTEND`.
Examples
~~~~~~~~
For model ``hr.leave``, you'd write ``(record.request_unit_half or record.request_unit_hours) and record.date_from or record.date_from.date()`` for `DTSTART` and ``(record.request_unit_half or record.request_unit_hours) and record.date_to or (record.date_to.date() + timedelta(days=1))`` for `DTEND` - this is a bit more complex because of the way Odoo handles the begin and end times of leaves, and you'll want the extra day as most clients interpret the end date as non-inclusive.
#. Existing calendars are available for users in the tab `Calendars` of their profile form, where they can enable them to obtain a link they can paste into whatever client they are going to use
Simple example, for model ``calendar.event``, you'd fill in ``record.allday and record.start_date or record.start`` as `DTSTART` and ``record.allday and record.stop_date or record.stop`` as `DTEND`.
Advanced example, for model ``calendar.event``, you'd use ``calendar = record._get_ics_file()`` in the code.
Advanced example, for model ``hr.leave``, you can use the following code and ``[("employee_id.user_id", "=", user.id)]`` in the `domain` to export the own time offs. This is a bit more complex because of the way Odoo handles the begin and end times of leaves, and you'll want the extra day as most clients interpret the end date as non-inclusive.:
.. code-block:: python
confirmed = ("validate", "validate1")
if record.request_unit_half or record.request_unit_hours:
event = {
"dtstart": event["dtstart"].date(),
"dtend": event["dtend"].date() + timedelta(days=1),
}
else:
event = {
"dtstart": record.date_from,
"dtend": record.date_to,
}
event["summary"] = record.name
event["status"] = "CONFIRMED" if record.state in confirmed else "TENTATIVE"
Advanced example, for model ``mail.activity``, you can use the following code and ``[("user_id", "=", user.id)]`` and `domain` to export all user activities.
.. code-block:: python
todo = {
"summary": record.display_name,
"due": record.date_deadline,
"description": html2plaintext(record.note) if record.note else ""
}
Usage
=====
@@ -78,7 +107,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_ical%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
@@ -95,14 +124,7 @@ Contributors
~~~~~~~~~~~~
* Holger Brunn <mail@hunki-enterprises.com> (https://hunki-enterprises.com)
Other credits
~~~~~~~~~~~~~
The development of this module has been financially supported by:
* Company 1 name
* Company 2 name
* Florian Kantelberg <florian.kantelberg@initos.com> (https://www.initos.com)
Maintainers
~~~~~~~~~~~

1
base_ical/__manifest__.py
View File

@@ -18,7 +18,6 @@
"web",
],
"data": [
"security/base_ical.xml",
"security/ir.model.access.csv",
"views/base_ical.xml",
"views/res_users.xml",

51
base_ical/controllers/main.py
View File

@@ -1,27 +1,54 @@
# Copyright 2023 Hunki Enterprises BV
# Copyright 2024 initOS GmbH
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
import logging
import werkzeug.wrappers
from werkzeug.exceptions import Unauthorized
from odoo import http
from odoo.http import request
_logger = logging.getLogger(__name__)
class MyController(http.Controller):
class ICalController(http.Controller):
@http.route(
"/base_ical/<string:token>",
auth="public",
"/base_ical/<int:calendar_id>",
auth="none",
csrf=False,
methods=["GET"],
type="http",
)
def get_ical(self, token):
# TODO: respect if-modified-since headers
token = (
http.request.env["base.ical.token"].sudo().search([("token", "=", token)])
def get_ical(self, calendar_id, access_token=None):
if not access_token:
raise Unauthorized()
user_id = request.env["res.users.apikeys"]._check_credentials(
scope=f"odoo.plugin.ical.{calendar_id}",
key=access_token,
)
if not token:
return http.request.not_found()
response = http.request.make_response(
token.ical_id.with_user(token.user_id)._get_ical(),
headers={"content-type": "text/calendar"},
if not user_id:
raise Unauthorized()
calendar = (
http.request.env["base.ical"]
.with_user(user_id)
.search([("id", "=", calendar_id)])
)
if not calendar:
return request.not_found()
records = calendar._get_items()
response = werkzeug.wrappers.Response()
if records:
response.last_modified = max(records.mapped("write_date"))
response.make_conditional(request.httprequest)
if response.status_code == 304:
return response
response.mimetype = "text/calendar"
response.data = calendar._get_ical(records)
return response

4
base_ical/models/__init__.py
View File

@@ -1,3 +1 @@
from . import res_users
from . import base_ical
from . import base_ical_token
from . import base_ical, base_ical_url_description, base_ical_url_show, res_users

220
base_ical/models/base_ical.py
View File

@@ -1,70 +1,80 @@
# Copyright 2023 Hunki Enterprises BV
# Copyright 2024 initOS GmbH
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
import datetime
from urllib.parse import urlparse, urlunparse
import logging
from urllib.parse import urlparse
import pytz
import vobject
from dateutil import relativedelta
from odoo import api, fields, models
from odoo.tools.safe_eval import safe_eval
from odoo import _, api, fields, models
from odoo.tools import html2plaintext
from odoo.tools.safe_eval import safe_eval, wrap_module
_logger = logging.getLogger(__name__)
vobject_wrapped = wrap_module(__import__("vobject"), ["iCalendar", "readOne"])
class BaseIcal(models.Model):
_name = "base.ical"
_description = "Definition of an iCal export"
def _get_operating_modes(self):
return [
("simple", _("Simple")),
("advanced", _("Advanced")),
]
active = fields.Boolean(default=True)
name = fields.Char(required=True, translate=True)
mode = fields.Selection("_get_operating_modes", required=True, default="simple")
model_id = fields.Many2one("ir.model", required=True, ondelete="cascade")
model = fields.Char(related="model_id.model")
model = fields.Char("Model Name", related="model_id.model")
domain = fields.Char(
required=True, default="[]", help="You can use variables `env` and `user` here"
)
preview = fields.Text(compute="_compute_preview")
code = fields.Text()
expression_dtstamp = fields.Char(
required=True,
vevent_field="dtstamp",
string="DTSTAMP",
help="You can use variables `record` and `user` here",
default="record.write_date",
)
expression_uid = fields.Char(
required=True,
vevent_field="uid",
string="UID",
help="You can use variables `record` and `user` here",
)
expression_dtstart = fields.Char(
required=True,
vevent_field="dtstart",
string="DTSTART",
help="You can use variables `record` and `user` here",
)
expression_dtend = fields.Char(
required=True,
vevent_field="dtend",
string="DTEND",
help="You can use variables `record` and `user` here",
)
expression_summary = fields.Char(
required=True,
vevent_field="summary",
string="SUMMARY",
help="You can use variables `record` and `user` here",
default="record.display_name",
)
user_url = fields.Char(compute="_compute_user_fields", string="URL")
user_active = fields.Boolean(compute="_compute_user_fields")
allowed_users_ids = fields.Many2many("res.users")
auto = fields.Boolean(
"Enable automatically",
"Allow automatically",
copy=False,
help="If you check this, the calendar will be enabled for all current and "
"future users. Not that unchecking this will not disable existing calendar "
"subscriptions",
)
help_text = fields.Html(compute="_compute_help")
def _valid_field_parameter(self, field, name):
return super()._valid_field_parameter(field, name) or name == "vevent_field"
@@ -77,24 +87,23 @@ class BaseIcal(models.Model):
"expression_dtstart",
"expression_dtend",
"expression_summary",
"code",
"mode",
)
def _compute_preview(self):
for this in self:
this.preview = this._get_ical()
this.preview = this._get_ical(limit=5)
def _compute_user_fields(self):
base_url = self.env["ir.config_parameter"].sudo().get_param("web.base.url")
@api.depends("mode")
def _compute_help(self):
for this in self:
token = this._get_user_tokens()[:1]
vals = {"user_url": False, "user_active": False}
if token:
vals.update(
user_url=urlunparse(
urlparse(base_url)._replace(path="/base_ical/%s" % token.token)
),
user_active=token.active,
)
this.update(vals)
variables = this.default_variables()
lines = []
for var, desc in sorted(variables.items()):
var = (f"<code>{v.strip()}</code>" for v in var.split(","))
lines.append(f"<li>{', '.join(sorted(var))}: {desc}</li>")
this.help_text = "<ul>" + "\n".join(lines) + "</ul>"
@api.onchange("model_id")
def _onchange_model_id(self):
@@ -117,6 +126,8 @@ class BaseIcal(models.Model):
"expression_dtstart",
"expression_dtend",
"expression_summary",
"code",
"mode",
)
def _check_domain(self):
for this in self:
@@ -136,25 +147,34 @@ class BaseIcal(models.Model):
self._enable_all_users()
return result
def _get_user_tokens(self):
return (
self.env["base.ical.token"]
.with_context(active_test=False)
.search(
[
("user_id", "=", self.env.user.id),
("ical_id", "in", self.ids),
]
def default_variables(self):
self.ensure_one()
variables = {
"datetime, relativedelta, time, timedelta": "useful Python libraries",
"record": "Record to export",
"user": "Current user record",
}
if self.mode == "advanced":
variables.update(
{
"calendar": "Output: Calendar e.g. from `_get_ics_file`",
"dict2ical": "Function to add the key-values of dict to ical component",
"event": "Output: Dictionary of an VEVENT",
"todo": "Output: Dictionary of an VTODO",
"vobject": "vobject python library",
"html2plaintext": "Converts HTML to plain text",
}
)
)
return variables
def _get_eval_expression_context(self, record):
def _get_eval_expression_context(self):
"""Return the evaluation context for expression evaluation"""
return {
"record": record,
"user": self.env.user,
"timedelta": datetime.timedelta,
"datetime": datetime.datetime,
"date": datetime.date,
"relativedelta": relativedelta.relativedelta,
"timedelta": datetime.timedelta,
"user": self.env.user,
}
def _get_eval_domain_context(self):
@@ -164,36 +184,103 @@ class BaseIcal(models.Model):
"env": self.env,
}
def _get_events(self):
def _get_items(self, limit=None):
"""Return events based on model_id and domain"""
self.ensure_one()
return self.env[self.model_id.sudo().model].search(
safe_eval(self.domain, self._get_eval_domain_context())
safe_eval(self.domain, self._get_eval_domain_context()),
limit=limit,
)
def _get_ical(self):
def _get_ical(self, records=None, limit=None):
"""Return the vcalendar as text"""
if self.mode == "simple":
return self._get_ical_simple(records=records, limit=limit)
return self._get_ical_advanced(records=records, limit=limit)
def _get_ical_simple(self, records=None, limit=None):
if not all(
self[field_name]
for field_name, field in self._fields.items()
if hasattr(field, "vevent_field") and field.required
if hasattr(field, "vevent_field")
):
return False
return ""
calendar = vobject.iCalendar()
for record in self._get_events():
for record in records or self._get_items(limit):
event = calendar.add("vevent")
for field_name, field in self._fields.items():
if not hasattr(field, "vevent_field"):
continue
value = safe_eval(
self[field_name], self._get_eval_expression_context(record)
)
if not self[field_name]:
continue
ctx = self._get_eval_expression_context()
ctx["record"] = record
value = safe_eval(self[field_name], ctx)
event.add(field.vevent_field).value = self._format_ical_value(
field, value
value, field=field
)
return calendar.serialize()
def _format_ical_value(self, field, value):
def _get_ical_advanced(self, records=None, limit=None):
if not self.code:
return ""
context = self._get_eval_expression_context()
context.update(
{
"dict2ical": self._dict_to_ical_component,
"html2plaintext": html2plaintext,
"vobject": vobject_wrapped,
}
)
calendar = vobject.iCalendar()
tz = pytz.timezone(self.env.user.tz or "UTC")
calendar.add(vobject.icalendar.TimezoneComponent(tz))
for record in records or self._get_items(limit):
context.update(
{"record": record, "calendar": None, "event": None, "todo": None}
)
safe_eval(self.code, context, mode="exec", nocopy=True)
cal = context.get("calendar")
if cal:
# Support for `_get_ics_file`
if isinstance(cal, dict) and record.id in cal:
cal = cal[record.id]
if isinstance(cal, bytes):
cal = cal.decode()
if isinstance(cal, str):
cal = vobject.readOne(cal)
self._copy_ical_calendar(calendar, cal)
event, todo = map(context.get, ("event", "todo"))
if event:
self._dict_to_ical_component(calendar.add("vevent"), event)
if todo:
self._dict_to_ical_component(calendar.add("vtodo"), todo)
return calendar.serialize()
def _dict_to_ical_component(self, component, data):
for key, value in data.items():
component.add(key).value = self._format_ical_value(value)
def _copy_ical_calendar(self, dst_calendar, src_calendar):
for item in src_calendar.getChildren():
if item.name.lower() in ("vevent", "vtodo"):
dst_calendar.add(item)
def _format_ical_value(self, value, field=None):
"""Add timezone to datetime values"""
if isinstance(value, datetime.datetime):
return pytz.utc.localize(value).astimezone(
@@ -203,24 +290,19 @@ class BaseIcal(models.Model):
def _enable_all_users(self, users=None):
"""Enable calendar for all users"""
for this in self:
for user in users or self.env["res.users"].search(
[("groups_id", "=", self.env.ref("base.group_user").id)]
):
this.with_user(user).action_enable()
users = users or self.env.ref("base.group_user").users
self.write({"allowed_users_ids": users})
def action_enable(self):
def action_new_url(self):
"""Create or activate current user's token"""
token = self._get_user_tokens()[:1]
if token and not token.active:
token.active = True
elif not token:
self.env["base.ical.token"].create(
{"ical_id": self.id, "user_id": self.env.user.id}
)
def action_disable(self):
"""Deactivate current user's token"""
token = self._get_user_tokens()[:1]
if token and token.active:
token.active = False
return {
"type": "ir.actions.act_window",
"res_model": "base.ical.url.description",
"name": "iCalendar URL",
"views": [(False, "form")],
"target": "new",
"context": {
"default_calendar_id": self.id,
},
}

22
base_ical/models/base_ical_token.py
View File

@@ -1,22 +0,0 @@
# Copyright 2023 Hunki Enterprises BV
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
import secrets
from odoo import fields, models
class BaseIcalToken(models.Model):
_name = "base.ical.token"
_description = "User token of an iCal export"
_rec_name = "ical_id"
active = fields.Boolean(default=True)
ical_id = fields.Many2one("base.ical", required=True, ondelete="cascade")
user_id = fields.Many2one("res.users", required=True, ondelete="cascade")
token = fields.Char(required=True, default=lambda self: secrets.token_urlsafe())
_sql_constraints = [
("token_uniqe", "unique(token)", "The token must be unique"),
]

47
base_ical/models/base_ical_url_description.py Normal file
View File

@@ -0,0 +1,47 @@
# Copyright 2024 initOS GmbH
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
from urllib.parse import urlparse, urlunparse
from odoo import _, fields, models
from odoo.exceptions import AccessError
from odoo.addons.base.models.res_users import check_identity
class BaseIcalUrlDescription(models.TransientModel):
_name = "base.ical.url.description"
_description = "Description for iCalendar"
calendar_id = fields.Many2one("base.ical", required=True)
name = fields.Char("Description", required=True)
def _make_url(self):
if not self.user_has_groups("base.group_user"):
raise AccessError(_("Only internal users can create API keys"))
scope = f"odoo.plugin.ical.{self.calendar_id.id}"
token = self.env["res.users.apikeys"]._generate(scope, f"Calendar: {self.name}")
base_url = self.env["ir.config_parameter"].sudo().get_param("web.base.url")
return urlunparse(
urlparse(base_url)._replace(
path=f"/base_ical/{self.calendar_id.id}",
query=f"access_token={token}",
)
)
@check_identity
def make_url(self):
url = self._make_url()
return {
"type": "ir.actions.act_window",
"res_model": "base.ical.url.show",
"name": "iCalendar URL",
"views": [(False, "form")],
"target": "new",
"context": {
"default_url": url,
},
}

12
base_ical/models/base_ical_url_show.py Normal file
View File

@@ -0,0 +1,12 @@
# Copyright 2024 initOS GmbH
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
from odoo import fields, models
class BaseIcalUrlShow(models.AbstractModel):
_name = "base.ical.url.show"
_description = "Show URL for iCalendar"
id = fields.Id()
url = fields.Char(readonly=True)

10
base_ical/models/res_users.py
View File

@@ -1,7 +1,7 @@
# Copyright 2023 Hunki Enterprises BV
# Copyright 2024 initOS GmbH
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
from odoo import api, fields, models
@@ -9,11 +9,10 @@ class ResUsers(models.Model):
_inherit = "res.users"
ical_ids = fields.One2many("base.ical", compute="_compute_ical_ids")
ical_token_ids = fields.One2many("base.ical.token", "user_id")
def _compute_ical_ids(self):
for this in self:
this.ical_ids = self.env["base.ical"].search([])
domain = [("allowed_users_ids", "=", self.env.uid)]
self.write({"ical_ids": self.env["base.ical"].search(domain)})
@property
def SELF_READABLE_FIELDS(self):
@@ -22,5 +21,6 @@ class ResUsers(models.Model):
@api.model_create_multi
def create(self, vals_list):
result = super().create(vals_list)
self.env["base.ical"].search([("auto", "=", True)])._enable_all_users(result)
calendars = self.env["base.ical"].search([("auto", "=", True)])
calendars.sudo().write({"allowed_users_ids": [(4, result.id)]})
return result

42
base_ical/readme/CONFIGURE.rst
View File

@@ -1,10 +1,42 @@
To configure this module, you need to:
#. Go to Settings/Technical/iCalendars
#. Create a calendar, fill in the model you want to expose and possibly a domain to restrict records. You can use the ``user`` variable to restrict things relative to the user using the calendar
#. A few iCalendar-fields have defaults that should work for any model, you'll have to fill in expressions manually though for the start and end date of the records.
#. Create a iCalendar, fill in the model you want to expose and possibly a domain to restrict records. You can use the ``user`` variable to restrict things relative to the user using the iCalendar
#. A iCalendar is only available to the allowed users. Use the `Allow automatically` to make the iCalendar available to all users
#. See the examples below for a start
For example, for model ``calendar.event``, you'd fill in ``record.allday and record.start_date or record.start`` as `DTSTART` and ``record.allday and record.stop_date or record.stop`` as `DTEND`.
Examples
~~~~~~~~
For model ``hr.leave``, you'd write ``(record.request_unit_half or record.request_unit_hours) and record.date_from or record.date_from.date()`` for `DTSTART` and ``(record.request_unit_half or record.request_unit_hours) and record.date_to or (record.date_to.date() + timedelta(days=1))`` for `DTEND` - this is a bit more complex because of the way Odoo handles the begin and end times of leaves, and you'll want the extra day as most clients interpret the end date as non-inclusive.
#. Existing calendars are available for users in the tab `Calendars` of their profile form, where they can enable them to obtain a link they can paste into whatever client they are going to use
Simple example, for model ``calendar.event``, you'd fill in ``record.allday and record.start_date or record.start`` as `DTSTART` and ``record.allday and record.stop_date or record.stop`` as `DTEND`.
Advanced example, for model ``calendar.event``, you'd use ``calendar = record._get_ics_file()`` in the code.
Advanced example, for model ``hr.leave``, you can use the following code and ``[("employee_id.user_id", "=", user.id)]`` in the `domain` to export the own time offs. This is a bit more complex because of the way Odoo handles the begin and end times of leaves, and you'll want the extra day as most clients interpret the end date as non-inclusive.:
.. code-block:: python
confirmed = ("validate", "validate1")
if record.request_unit_half or record.request_unit_hours:
event = {
"dtstart": event["dtstart"].date(),
"dtend": event["dtend"].date() + timedelta(days=1),
}
else:
event = {
"dtstart": record.date_from,
"dtend": record.date_to,
}
event["summary"] = record.name
event["status"] = "CONFIRMED" if record.state in confirmed else "TENTATIVE"
Advanced example, for model ``mail.activity``, you can use the following code and ``[("user_id", "=", user.id)]`` and `domain` to export all user activities.
.. code-block:: python
todo = {
"summary": record.display_name,
"due": record.date_deadline,
"description": html2plaintext(record.note) if record.note else ""
}

1
base_ical/readme/CONTRIBUTORS.rst
View File

@@ -1 +1,2 @@
* Holger Brunn <mail@hunki-enterprises.com> (https://hunki-enterprises.com)
* Florian Kantelberg <florian.kantelberg@initos.com> (https://www.initos.com)

4
base_ical/readme/CREDITS.rst
View File

@@ -1,4 +0,0 @@
The development of this module has been financially supported by:
* Company 1 name
* Company 2 name

25
base_ical/security/base_ical.xml
View File

@@ -1,25 +0,0 @@
<?xml version="1.0" encoding="utf-8" ?>
<!-- Copyright 2023 Hunki Enterprises BV
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) -->
<data>
<record id="rule_base_ical_token" model="ir.rule">
<field name="name">Ical export tokens</field>
<field name="model_id" ref="model_base_ical_token" />
<field name="groups" eval="[(4, ref('base.group_user'))]" />
<field name="perm_create" eval="True" />
<field name="perm_read" eval="True" />
<field name="perm_write" eval="True" />
<field name="perm_unlink" eval="True" />
<field name="domain_force">[('user_id', '=', user.id)]</field>
</record>
<record id="rule_base_ical_token_admin" model="ir.rule">
<field name="name">Ical export tokens</field>
<field name="model_id" ref="model_base_ical_token" />
<field name="groups" eval="[(4, ref('base.group_system'))]" />
<field name="perm_create" eval="True" />
<field name="perm_read" eval="True" />
<field name="perm_write" eval="True" />
<field name="perm_unlink" eval="True" />
<field name="domain_force">[(1, '=', 1)]</field>
</record>
</data>

3
base_ical/security/ir.model.access.csv
View File

@@ -1,4 +1,5 @@
id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
access_base_ical,access_base_ical,model_base_ical,base.group_user,1,0,0,0
modify_base_ical,modify_base_ical,model_base_ical,base.group_system,1,1,1,1
modify_base_ical_token,modify_base_ical_token,model_base_ical_token,base.group_user,1,1,1,1
access_base_ical_url_description,access_base_ical_url_description,model_base_ical_url_description,base.group_user,1,0,1,0
access_base_ical_url_show,access_base_ical_url_show,model_base_ical_url_show,base.group_user,1,0,1,0
1 id name model_id:id group_id:id perm_read perm_write perm_create perm_unlink
2 access_base_ical access_base_ical model_base_ical base.group_user 1 0 0 0
3 modify_base_ical modify_base_ical model_base_ical base.group_system 1 1 1 1
4 modify_base_ical_token access_base_ical_url_description modify_base_ical_token access_base_ical_url_description model_base_ical_token model_base_ical_url_description base.group_user 1 1 0 1 1 0
5 access_base_ical_url_show access_base_ical_url_show model_base_ical_url_show base.group_user 1 0 1 0

123
base_ical/tests/test_base_ical.py
View File

@@ -1,54 +1,125 @@
# Copyright 2023 Hunki Enterprises BV
# Copyright 2024 initOS GmbH
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
import logging
from urllib.parse import parse_qs, urlparse
import vobject
from odoo.tests.common import Form, TransactionCase
_logger = logging.getLogger(__name__)
class TestBaseIcal(TransactionCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.calendar = cls.env.ref("base_ical.demo_calendar")
cls.user = cls.env.ref("base.user_demo")
def test_profile(self):
"""Test url generation"""
user = self.env.ref("base.user_demo")
token_domain = [
("user_id", "=", user.id),
("ical_id", "=", self.calendar.id),
]
token_search = (
self.env["base.ical.token"].with_context(active_test=False).search
desc = (
self.env["base.ical.url.description"]
.with_user(self.user)
.create({"calendar_id": self.calendar.id, "name": "Testing"})
)
self.assertFalse(token_search(token_domain))
self.assertFalse(self.calendar.with_user(user).user_active)
self.calendar.with_user(user).action_enable()
token = token_search(token_domain)
self.assertTrue(token.active)
self.calendar.invalidate_cache()
self.assertTrue(self.calendar.with_user(user).user_active)
self.calendar.with_user(user).action_disable()
self.calendar.invalidate_cache()
self.assertFalse(self.calendar.with_user(user).user_active)
def test_config(self):
"""Configure calendar"""
url = desc._make_url()
self.assertTrue(url)
parsed = urlparse(url)
params = parse_qs(parsed.query)
access_token = params.get("access_token")[0]
self.assertTrue(access_token)
user_id = self.env["res.users.apikeys"]._check_credentials(
scope=f"odoo.plugin.ical.{self.calendar.id}",
key=access_token,
)
self.assertEqual(user_id, self.user.id)
def test_config_simple(self):
"""Configure a simple calendar"""
with Form(self.calendar) as calendar_form:
calendar_form.mode = "simple"
calendar_form.model_id = self.env.ref("base.model_res_partner")
self.assertFalse(calendar_form.expression_dtstart)
self.assertFalse(calendar_form.preview)
calendar_form.expression_dtstart = "record.create_date"
calendar_form.expression_dtend = "record.write_date"
self.assertTrue(calendar_form.preview)
self.assertTrue(vobject.readOne(calendar_form.preview))
def test_config_advanced_event(self):
with Form(self.calendar) as calendar_form:
calendar_form.mode = "advanced"
calendar_form.model_id = self.env.ref("base.model_res_partner")
self.assertFalse(calendar_form.preview)
calendar_form.code = (
"event = {"
"'dtstart':record.create_date,"
"'dtend':record.write_date,"
"'summary':record.name,"
"}"
)
self.assertTrue(calendar_form.preview)
cal = vobject.readOne(calendar_form.preview)
self.assertTrue(cal)
self.assertTrue(
any(item.name.lower() == "vevent" for item in cal.getChildren())
)
def test_config_advanced_todo(self):
with Form(self.calendar) as calendar_form:
calendar_form.mode = "advanced"
calendar_form.model_id = self.env.ref("base.model_res_partner")
self.assertFalse(calendar_form.preview)
calendar_form.code = (
"todo = {'due':record.write_date,'summary':record.name}"
)
self.assertTrue(calendar_form.preview)
cal = vobject.readOne(calendar_form.preview)
self.assertTrue(cal)
self.assertTrue(
any(item.name.lower() == "vtodo" for item in cal.getChildren())
)
def test_config_advanced_calendar(self):
code = (
"cal = vobject.iCalendar()\n"
"dict2ical(cal.add('vevent'),{"
"'summary':record.name,"
"'dtstart':record.create_date,"
"'dtend':record.write_date})\n"
)
with Form(self.calendar) as calendar_form:
calendar_form.mode = "advanced"
calendar_form.model_id = self.env.ref("base.model_res_partner")
self.assertFalse(calendar_form.preview)
calendar_form.code = (
code + "calendar = {record.id:cal.serialize().encode()}"
)
self.assertTrue(calendar_form.preview)
cal = vobject.readOne(calendar_form.preview)
self.assertTrue(cal)
def test_auto_flag(self):
"""Test the auto flag is honored"""
user = self.env.ref("base.user_demo")
self.assertFalse(user.ical_token_ids)
self.assertFalse(self.calendar.allowed_users_ids)
self.calendar.auto = True
self.assertTrue(user.ical_token_ids)
self.calendar.copy()
self.assertEqual(len(user.ical_token_ids), 2)
new_user = user.copy()
self.assertEqual(len(new_user.ical_token_ids), 2)
self.assertTrue(self.calendar.allowed_users_ids)
new_calendar = self.calendar.copy()
self.assertIn(self.user, new_calendar.allowed_users_ids)
self.calendar.auto = False
new_user = self.user.copy()
self.assertNotIn(new_user, self.calendar.allowed_users_ids)
self.calendar.auto = True
new_user = new_user.copy()
self.assertIn(new_user, self.calendar.allowed_users_ids)

124
base_ical/views/base_ical.xml
View File

@@ -2,6 +2,58 @@
<!-- Copyright 2023 Hunki Enterprises BV
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) -->
<data>
<record id="view_icalendar_url_show_form" model="ir.ui.view">
<field name="name">iCalendar: Show Url</field>
<field name="model">base.ical.url.show</field>
<field name="arch" type="xml">
<form>
<sheet>
<p>
Here is your new URL to the calendar.
</p>
<p><code><field name="url" readonly="True" /></code></p>
<p class="alert alert-warning" role="alert">
<strong>Important:</strong>
The url cannot be retrieved later and provides.
</p>
<footer>
<button special="cancel" data-hotkey="z" string="Done!" />
</footer>
</sheet>
</form>
</field>
</record>
<record id="view_icalendar_url_description_form" model="ir.ui.view">
<field name="name">iCalendar: Show Url</field>
<field name="model">base.ical.url.description</field>
<field name="arch" type="xml">
<form>
<sheet>
<group>
<field name="calendar_id" invisible="1" />
<field name="name" />
</group>
<footer>
<button
name="make_url"
type="object"
string="Generate url"
class="btn-primary"
data-hotkey="q"
/>
<button
special="cancel"
data-hotkey="z"
string="Cancel"
class="btn-secondary"
/>
</footer>
</sheet>
</form>
</field>
</record>
<record id="view_base_ical_form" model="ir.ui.view">
<field name="model">base.ical</field>
<field name="arch" type="xml">
@@ -10,28 +62,70 @@
<label class="oe_edit_only" for="name" />
<h1><field name="name" /></h1>
<group>
<group name="main">
<field name="model_id" />
<field name="model" invisible="True" />
<field
<group name="main">
<field name="mode" />
<field name="model_id" />
<field name="model" invisible="True" />
<field
name="domain"
placeholder="[('user_id', '=', user.id)]"
/>
<field name="auto" />
<field name="allowed_users_ids" widget="many2many_tags" />
<field name="auto" />
</group>
<group
name="fields"
string="Simple Configuration"
attrs="{'invisible': [('mode', '!=', 'simple')]}"
>
<field
name="expression_dtstamp"
attrs="{'required': [('mode', '=', 'simple')]}"
/>
<field
name="expression_uid"
attrs="{'required': [('mode', '=', 'simple')]}"
/>
<field
name="expression_dtstart"
attrs="{'required': [('mode', '=', 'simple')]}"
/>
<field
name="expression_dtend"
attrs="{'required': [('mode', '=', 'simple')]}"
/>
<field
name="expression_summary"
attrs="{'required': [('mode', '=', 'simple')]}"
/>
</group>
<group
name="advanced"
string="Advanced Configuration"
attrs="{'invisible': [('mode', '!=', 'advanced')]}"
>
<field
name="code"
nolabel="1"
widget="ace"
options="{'mode': 'python'}"
/>
</group>
</group>
<group name="fields">
<field name="expression_dtstamp" />
<field name="expression_uid" />
<field name="expression_dtstart" />
<field name="expression_dtend" />
<field name="expression_summary" />
</group>
</group>
<field name="preview" widget="ace" groups="base.group_no_one" />
<notebook>
<page string="Help">
<field name="help_text" />
</page>
<page string="Preview" groups="base.group_no_one">
<field name="preview" widget="ace" />
</page>
</notebook>
</sheet>
</form>
</field>
</record>
<record id="view_base_ical_tree" model="ir.ui.view">
<field name="model">base.ical</field>
<field name="arch" type="xml">
@@ -42,11 +136,13 @@
</tree>
</field>
</record>
<record id="action_base_ical" model="ir.actions.act_window">
<field name="name">iCalendars</field>
<field name="type">ir.actions.act_window</field>
<field name="res_model">base.ical</field>
<field name="view_mode">tree,form</field>
</record>
<menuitem id="menu_ical" parent="base.menu_custom" action="action_base_ical" />
</data>

35
base_ical/views/res_users.xml
View File

@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="utf-8" ?>
<!-- Copyright 2023 Hunki Enterprises BV
Copyright 2024 initOS GmbH
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) -->
<data>
<record id="view_res_users_form" model="ir.ui.view">
@@ -8,27 +9,31 @@
<field name="arch" type="xml">
<notebook position="inside">
<page name="base_ical" string="Calendars">
<label for="ical_ids" string="Calendars" />
<field name="ical_ids">
<tree>
<button
type="object"
name="action_enable"
attrs="{'invisible': [('user_active', '=', True)]}"
string="Enable"
/>
<button
type="object"
name="action_disable"
attrs="{'invisible': [('user_active', '=', False)]}"
string="Disable"
name="action_new_url"
string="New URL"
/>
<field name="name" />
<field name="user_active" invisible="1" />
<field
name="user_url"
attrs="{'invisible': [('user_active', '=', False)]}"
widget="url"
/>
</tree>
</field>
<!-- TODO: Re-evaluate after migration to 16.0 -->
<label for="api_key_ids" string="Existing Access" />
<field
name="api_key_ids"
domain="[('scope', '=like', 'odoo.plugin.ical.%')]"
nolabel="1"
readonly="1"
>
<tree create="false">
<field name="name" />
<field name="scope" />
<field name="create_date" />
<button type="object" name="remove" icon="fa-trash" />
</tree>
</field>
</page>