From ba43d3c6919ce63354badcf4b7088d2be85fe732 Mon Sep 17 00:00:00 2001 From: Benjamin Dauvergne Date: Thu, 4 Oct 2018 23:33:09 +0200 Subject: [PATCH] users: add cronjob to delete users (#24430) --- tests/test_users.py | 81 ++++++++++++++++++++++++++++++++++++++++++++- wcs/publisher.py | 8 +++++ wcs/sql.py | 61 ++++++++++++++++++++++++++++++++++ 3 files changed, 149 insertions(+), 1 deletion(-) diff --git a/tests/test_users.py b/tests/test_users.py index fc44d6be5..b037119ac 100644 --- a/tests/test_users.py +++ b/tests/test_users.py @@ -1,7 +1,9 @@ +import datetime import shutil +import time import pytest -from quixote import cleanup +from quixote import cleanup, get_publisher from wcs import fields from wcs.variables import LazyUser @@ -92,3 +94,80 @@ def test_user_formdef_getattr(): with pytest.raises(AttributeError): # noqa pylint: disable=pointless-statement user.xxx + + +def test_clean_deleted_users(): + from wcs.carddef import CardDef + from wcs.formdef import FormDef + from wcs.workflows import Evolution + + User = pub.user_class + + User.wipe() + FormDef.wipe() + CardDef.wipe() + + formdef = FormDef() + formdef.name = 'foobar' + formdef.url_name = 'foobar' + formdef.fields = [] + formdef.store() + data_class = formdef.data_class() + + carddef = CardDef() + carddef.name = 'barfoo' + carddef.url_name = 'barfoo' + carddef.fields = [] + carddef.store() + card_data_class = carddef.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() + + user3 = User() + user3.name = 'Michel' + user3.deleted_timestamp = datetime.datetime.now() + user3.store() + + user4 = User() + user4.name = 'Martin' + user4.deleted_timestamp = datetime.datetime.now() + user4.store() + + user5 = User() + user5.name = 'Alain' + user5.deleted_timestamp = datetime.datetime.now() + user5.store() + + formdata1 = data_class() + formdata1.user_id = user1.id + evo = Evolution() + evo.time = time.localtime() + evo.who = user4.id + formdata1.evolution = [evo] + formdata1.workflow_roles = {'_received': '_user:%s' % user5.id} + formdata1.store() + + carddata1 = card_data_class() + carddata1.user_id = user3.id + carddata1.store() + + assert User.count() == 5 + + get_publisher().clean_deleted_users() + + assert {user.name for user in User.select()} == {'Pierre', 'Michel', 'Martin', 'Alain'} + + data_class.wipe() + card_data_class.wipe() + + get_publisher().clean_deleted_users() + + assert User.count() == 0 diff --git a/wcs/publisher.py b/wcs/publisher.py index c31211e25..50e84d572 100644 --- a/wcs/publisher.py +++ b/wcs/publisher.py @@ -123,6 +123,10 @@ class WcsPublisher(QommonPublisher): cls.register_cronjob( CronJob(cls.update_deprecations_report, name='update_deprecations_report', hours=[2], minutes=[0]) ) + # once a day delete unreferenced users + cls.register_cronjob( + CronJob(cls.clean_deleted_users, name='clean_deleted_users', hours=[3], minutes=[0]) + ) # other jobs data_sources.register_cronjob() formdef.register_cronjobs() @@ -511,6 +515,10 @@ class WcsPublisher(QommonPublisher): return value_.get_value() return value_ + 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 3bb736de2..5ac4123cd 100644 --- a/wcs/sql.py +++ b/wcs/sql.py @@ -3302,6 +3302,67 @@ class SqlUser(SqlMixin, wcs.users.User): return objects + @classmethod + def get_reference_ids(cls): + '''Retrieve ids of users reference in some carddata or formdata.''' + from wcs.carddef import CardDef + from wcs.formdef import FormDef + + referenced_ids = set() + + conn, cur = get_connection_and_cursor() + + for objectdef in CardDef.select() + FormDef.select(): + data_class = objectdef.data_class() + + # referenced in form/card data.user_id + sql_statement = ( + 'SELECT CAST(data.user_id AS INTEGER) FROM %(table)s AS data WHERE data.user_id IS NOT NULL' + % { + 'table': data_class._table_name, + } + ) + cur.execute(sql_statement) + referenced_ids.update(user_id for user_id, in cur.fetchall()) + conn.commit() + + # referenced in form/card data_evolution.who + sql_statement = 'SELECT CAST(evolution.who AS INTEGER) FROM %(table)s AS evolution' % { + 'table': '%s_evolutions' % data_class._table_name, + } + cur.execute(sql_statement) + referenced_ids.update(user_id for user_id, in cur.fetchall()) + conn.commit() + + # referenced in form/card data.workflow_roles_array + sql_statement = '''SELECT CAST(SUBSTRING(workflow_role.workflow_role FROM 7) AS INTEGER) + FROM %(table)s AS data, UNNEST(data.workflow_roles_array) AS workflow_role + WHERE SUBSTRING(workflow_role.workflow_role FROM 1 FOR 6) = '_user:' ''' % { + # users will be referenced as "_user:" entries in + # workflow_roles_array, filter on values starting with "_user:" + # (FROM 1 FOR 6) and extract the id part (FROM 7). + 'table': data_class._table_name, + } + cur.execute(sql_statement) + referenced_ids.update(user_id for user_id, in cur.fetchall()) + conn.commit() + return referenced_ids + + @classmethod + def get_to_delete_ids(cls): + '''Retrieve ids of users which are deleted on the IdP and are no more referenced by any form or card.''' + + # fetch marked as deleted users + conn, cur = get_connection_and_cursor() + sql_statement = 'SELECT users.id FROM users WHERE users.deleted_timestamp IS NOT NULL' + cur.execute(sql_statement) + deleted_ids = {user_id for user_id, in cur.fetchall()} + conn.commit() + cur.close() + + to_delete_ids = deleted_ids.difference(cls.get_reference_ids()) + return to_delete_ids + class Role(SqlMixin, wcs.roles.Role): _table_name = 'roles' -- 2.37.2