From aaa5a05fb94c2c790e2b3daba5d90f911851bdc1 Mon Sep 17 00:00:00 2001
From: Benjamin Dauvergne <bdauvergne@entrouvert.com>
Date: Thu, 4 Oct 2018 23:33:09 +0200
Subject: [PATCH] users: add cronjob to delete users (#24430)

---
 tests/test_users.py | 48 ++++++++++++++++++++++++++++++++++++++++++++-
 wcs/publisher.py    |  8 ++++++++
 wcs/sql.py          | 19 ++++++++++++++++++
 wcs/users.py        | 19 ++++++++++++++++++
 4 files changed, 93 insertions(+), 1 deletion(-)

diff --git a/tests/test_users.py b/tests/test_users.py
index 025be12b..7ab357bf 100644
--- a/tests/test_users.py
+++ b/tests/test_users.py
@@ -7,7 +7,7 @@ import time
 
 import pytest
 
-from quixote import cleanup
+from quixote import cleanup, get_publisher
 
 from wcs import publisher
 from wcs import fields
@@ -98,3 +98,49 @@ def test_user_formdef_getattr():
 
     with pytest.raises(AttributeError):
         user.xxx
+
+
+def test_clean_deleted_users():
+    from wcs.formdef import FormDef
+    from wcs.qommon import storage as st
+
+    User = pub.user_class
+
+    User.wipe()
+    FormDef.wipe()
+
+    formdef = FormDef()
+    formdef.name = 'foobar'
+    formdef.url_name = 'foobar'
+    formdef.fields = []
+    formdef.store()
+    data_class = formdef.data_class()
+
+    user1 = User()
+    user1.name = 'Pierre'
+    user1.deleted_timestamp = datetime.datetime.now()
+    user1.store()
+
+    user2 = User()
+    user2.name = 'Jean'
+    user2.deleted_timestamp = datetime.datetime.now()
+    user2.store()
+
+    formdata1 = data_class()
+    formdata1.user_id = user1.id
+    formdata1.store()
+
+    assert User.count() == 2
+
+    get_publisher().clean_deleted_users()
+
+    assert User.count() == 1
+
+    assert len(User.select([st.Equal('name', 'Pierre')])) == 1
+    assert len(User.select([st.Equal('name', 'Jean')])) == 0
+
+    data_class.wipe()
+
+    get_publisher().clean_deleted_users()
+
+    assert User.count() == 0
diff --git a/wcs/publisher.py b/wcs/publisher.py
index 423583d9..b08a9616 100644
--- a/wcs/publisher.py
+++ b/wcs/publisher.py
@@ -127,6 +127,9 @@ class WcsPublisher(StubWcsPublisher):
         cls.register_cronjob(CronJob(
             cls.apply_global_action_timeouts,
             name='evaluate_global_action_timeouts', minutes=[0]))
+        cls.register_cronjob(CronJob(
+            cls.clean_deleted_users,
+            name='clean_deleted_users', minutes=[0]))
 
     def is_using_postgresql(self):
         return bool(self.has_site_option('postgresql') and self.cfg.get('postgresql', {}))
@@ -374,6 +377,11 @@ class WcsPublisher(StubWcsPublisher):
             from . import sql
             sql.cleanup_connection()
 
+    def clean_deleted_users(self):
+        for user_id in self.user_class.get_to_delete_ids():
+            self.user_class.remove_object(user_id)
+
+
 set_publisher_class(WcsPublisher)
 WcsPublisher.register_extra_dir(os.path.join(os.path.dirname(__file__), 'extra'))
 
diff --git a/wcs/sql.py b/wcs/sql.py
index 653c509a..326dfade 100644
--- a/wcs/sql.py
+++ b/wcs/sql.py
@@ -2125,6 +2125,25 @@ class SqlUser(SqlMixin, wcs.users.User):
 
         return objects
 
+    @classmethod
+    def get_to_delete_ids(cls):
+        from .formdef import FormDef
+
+        deleted_ids = set(
+            user.id
+            for user in cls.select([NotNull('deleted_timestamp')])
+        )
+
+        active_ids = set()
+        if FormDef.count():
+            # without any FormDef global views are not created.
+            active_ids = set(
+                formdata.user_id
+                for formdata in AnyFormData.select([Contains('user_id', deleted_ids)], iterator=True)
+                if formdata.user_id
+            )
+        return (deleted_ids - active_ids)
+
 
 class Session(SqlMixin, wcs.sessions.BasicSession):
     _table_name = 'sessions'
diff --git a/wcs/users.py b/wcs/users.py
index 25f93af1..b846b84c 100644
--- a/wcs/users.py
+++ b/wcs/users.py
@@ -263,6 +263,25 @@ class User(StorableObject):
         self.deleted_timestamp = datetime.datetime.now()
         self.store()
 
+    @classmethod
+    def get_to_delete_ids(cls):
+        from .formdef import FormDef
+
+        deleted_ids = set(
+            user.id
+            for user in cls.select([st.NotNull('deleted_timestamp')])
+        )
+
+        active_ids = set()
+        for formdef in FormDef.select():
+            data_class = formdef.data_class()
+            active_ids.update(
+                formdata.user_id
+                for formdata in data_class.select(iterator=True)
+                if formdata.user_id
+            )
+
+        return (deleted_ids - active_ids)
 
 Substitutions.register('session_user_display_name', category=N_('User'), comment=N_('Session User Display Name'))
 Substitutions.register('session_user_email', category=N_('User'), comment=N_('Session User Email'))
-- 
2.28.0