[18.0][MIG] base_ical

base_ical/README.rst

@@ -0,0 +1,173 @@
+================================
+Readonly publishing of calendars
+================================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:fcc362c6ec99b15b1310731ed8fe11a12ee242565f3b449ad387f663683ae54d
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Alpha
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-backend/tree/18.0/base_ical
+    :alt: OCA/server-backend
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-backend-18-0/server-backend-18-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=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows administrators to configure iCalendars based on an
+arbitrary selection on arbitrary models.
+
+Users can selectively subscribe to them by enabling them in their
+profile form.
+
+This is useful for exposing Odoo data to calendaring application like
+Nextcloud.
+
+.. IMPORTANT::
+   This is an alpha version, the data model and design can change at any time without warning.
+   Only for development or testing purpose, do not use in production.
+   `More details on development status <https://odoo-community.org/page/development-status>`_
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+To configure this module, you need to:
+
+1. Go to Settings/Technical/iCalendars
+2. 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
+3. A iCalendar is only available to the allowed users. Use the Allow
+   automatically to make the iCalendar available to all users
+4. See the examples below for a start
+
+Examples
+--------
+
+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:: 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:: python
+
+   todo = {
+      "summary": record.display_name,
+      "due": record.date_deadline,
+      "description": html2plaintext(record.note) if record.note else ""
+   }
+
+Usage
+=====
+
+To use this module, you need to:
+
+1. Go to your profile form
+2. Click Enable on one of the calendars listed in tab Calendars
+3. Copy the URL to the application you use
+
+Known issues / Roadmap
+======================
+
+-  support all of
+   https://datatracker.ietf.org/doc/html/rfc5545#section-3.8
+-  allow users to define their own calendars
+
+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
+`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_ical%0Aversion:%2018.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.
+
+Credits
+=======
+
+Authors
+-------
+
+* Hunki Enterprises BV
+
+Contributors
+------------
+
+-  Holger Brunn <mail@hunki-enterprises.com>
+   (https://hunki-enterprises.com)
+-  Florian Kantelberg <florian.kantelberg@initos.com>
+   (https://www.initos.com)
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-hbrunn| image:: https://github.com/hbrunn.png?size=40px
+    :target: https://github.com/hbrunn
+    :alt: hbrunn
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-hbrunn| 
+
+This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/18.0/base_ical>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

base_ical/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from . import controllers

base_ical/__manifest__.py

@@ -0,0 +1,28 @@
+# Copyright 2023 Hunki Enterprises BV
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0)
+
+{
+    "name": "Readonly publishing of calendars",
+    "summary": "Provide (readonly) .ics URLs to calendar-like models",
+    "version": "18.0.1.0.0",
+    "development_status": "Alpha",
+    "category": "Tools",
+    "website": "https://github.com/OCA/server-backend",
+    "author": "Hunki Enterprises BV, Odoo Community Association (OCA)",
+    "maintainers": ["hbrunn"],
+    "license": "AGPL-3",
+    "external_dependencies": {
+        "python": ["vobject"],
+    },
+    "depends": [
+        "web",
+    ],
+    "data": [
+        "security/ir.model.access.csv",
+        "views/base_ical.xml",
+        "views/res_users.xml",
+    ],
+    "demo": [
+        "demo/base_ical.xml",
+    ],
+}

base_ical/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

base_ical/controllers/main.py

@@ -0,0 +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 ICalController(http.Controller):
+    @http.route(
+        "/base_ical/<int:calendar_id>",
+        auth="none",
+        csrf=False,
+        methods=["GET"],
+        type="http",
+    )
+    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 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

base_ical/demo/base_ical.xml

@@ -0,0 +1,12 @@
+<?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="demo_calendar" model="base.ical">
+        <field name="name">Demo calendar</field>
+        <field name="model_id" ref="base.model_res_users" />
+        <field name="expression_uid">str(record.id)</field>
+        <field name="expression_dtstart">record.create_date</field>
+        <field name="expression_dtend">record.write_date</field>
+    </record>
+</data>