[MIG] mail_activity_done: Migration to 18.0

The functionality is now supported by Odoo, using a similar datamodel: to mark
activities done, they are archived instead of unlinked. This is reflected in the
way that the state field is computed.

Author: StefanRijnhart

mail_activity_done/README.rst

@@ -32,6 +32,10 @@ This module implements the capability to keep activities that have been
 completed, for future reporting, by setting them with the boolean
 'Done'.
 
+Since Odoo 18.0, this is supported natively by Odoo, depending on the
+configuration of the activity types. This module ensures that the option
+is active on all existing and new activity types in your setup.
+
 **Table of contents**
 
 .. contents::
@@ -40,15 +44,7 @@ completed, for future reporting, by setting them with the boolean
 Usage
 =====
 
-To use this module, you need to:
-
-1. Access to an activity from the systray activities menu.
-2. Once finished, open the activity and mark it as Done.
-
-To check activities:
-
-1. Go to Settings -> Technical -> Activities
-2. To see finished activities filter by Completed Activities
+To use this module, you do not need to do anything.
 
 Bug Tracker
 ===========
@@ -79,6 +75,7 @@ Contributors
 -  Manuel Regidor <manuel.regidor@sygel.es> (https://www.sygel.es)
 -  Bernat Puig <bernat.puig@forgeflow.com>
    (`www.forgeflow.com <http://www.forgeflow.com>`__)
+-  Stefan Rijnhart <stefan@opener.amsterdam>
 
 Maintainers
 -----------

mail_activity_done/__init__.py

@@ -1,2 +1,2 @@
 from . import models
-from .hooks import pre_init_hook, uninstall_hook
+from .hooks import post_init_hook

mail_activity_done/__manifest__.py

@@ -2,13 +2,11 @@
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
 {
     "name": "Mail Activity Done",
-    "version": "17.0.1.0.0",
+    "version": "18.0.1.0.0",
     "author": "ForgeFlow, Odoo Community Association (OCA)",
     "license": "LGPL-3",
     "category": "Discuss",
     "website": "https://github.com/OCA/mail",
     "depends": ["mail"],
-    "data": ["views/mail_activity_views.xml"],
-    "pre_init_hook": "pre_init_hook",
-    "uninstall_hook": "uninstall_hook",
+    "post_init_hook": "post_init_hook",
 }

mail_activity_done/hooks.py

@@ -3,40 +3,16 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html).
 
 
-def pre_init_hook(env):
-    """The objective of this hook is to default to false all values of field
-    'done' of mail.activity
-    """
-    cr = env.cr
-    cr.execute(
-        """SELECT column_name
-    FROM information_schema.columns
-    WHERE table_name='mail_activity' AND
-    column_name='done'"""
-    )
-    if not cr.fetchone():
-        cr.execute(
-            """
-            ALTER TABLE mail_activity ADD COLUMN done boolean;
-            """
-        )
-
+def _set_keep_done(cr):
+    """Set keep_done to true for all existing activity types"""
     cr.execute(
         """
-        UPDATE mail_activity
-        SET done = False
+        update mail_activity_type
+        set keep_done = true
+        where keep_done is not true
         """
     )
 
 
-def uninstall_hook(env):
-    """The objective of this hook is to remove all activities that are done
-    upon module uninstall
-    """
-    cr = env.cr
-    cr.execute(
-        """
-        DELETE FROM mail_activity
-        WHERE done=True
-        """
-    )
+def post_init_hook(env):
+    _set_keep_done(env.cr)

mail_activity_done/migrations/18.0.1.0.0/post-migration.py

@@ -0,0 +1,31 @@
+import logging
+
+from odoo.addons.mail_activity_done.hooks import _set_keep_done
+
+
+def migrate(cr, version):
+    """Deal with possible inconsistencies between active and done.
+
+    Set done activities that were not archived to archived.
+    Warn about possible archived activities that were not done.
+    """
+    logger = logging.getLogger("odoo.addons.mail_activity_done.migrations")
+    _set_keep_done(cr)
+    cr.execute(
+        "update mail_activity set active = false where active and done;",
+    )
+    if cr.rowcount:
+        logger.info(
+            f"{cr.rowcount} done activities were previously unarchived. They are "
+            "now set back to archived for Odoo to still consider them done.",
+        )
+    cr.execute(
+        "select id from mail_activity where active is not true and done is not true;",
+    )
+    ids = [str(row[0]) for row in cr.fetchall()]
+    if ids:
+        logger.warning(
+            f"{len(ids)} activities were previously archived but not "
+            "done. Odoo will consider them done now (activities with ids "
+            f"{','.join(ids)})"
+        )

mail_activity_done/models/__init__.py

@@ -1,2 +1 @@
-from . import mail_activity
-from . import res_users
+from . import mail_activity_type

mail_activity_done/models/mail_activity.py

@@ -0,0 +1,9 @@
+# Copyright 2018-22 ForgeFlow <http://www.forgeflow.com>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+from odoo import fields, models
+
+
+class MailActivityType(models.Model):
+    _inherit = "mail.activity.type"
+
+    keep_done = fields.Boolean(default=True)

mail_activity_done/models/mail_activity_type.py

@@ -5,3 +5,4 @@
 - Radovan Skolnik \<<radovan@skolnik.info>\> (<https://www.kema.sk>)
 - Manuel Regidor \<<manuel.regidor@sygel.es>\> (<https://www.sygel.es>)
 - Bernat Puig \<<bernat.puig@forgeflow.com>\> (www.forgeflow.com)
+- Stefan Rijnhart \<<stefan@opener.amsterdam>\>