1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
# Copyright (C) 2011-2016 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Unique IDs."""
__all__ = [
'UID',
]
from mailman.database.model import Model
from mailman.database.transaction import dbconnection
from mailman.database.types import UUID
from sqlalchemy import Column, Integer
class UID(Model):
"""Enforce uniqueness of uids through a database table.
This is used so that unique ids don't have to be tracked by each
individual model object that uses them. So for example, when a user is
deleted, we don't have to keep separate track of its uid to prevent it
from ever being used again. This class, hooked up to the `UIDFactory`
serves that purpose.
There is no interface for this class, because it's purely an internal
implementation detail.
"""
__tablename__ = 'uid'
id = Column(Integer, primary_key=True)
uid = Column(UUID, index=True)
@dbconnection
def __init__(self, store, uid):
super().__init__()
self.uid = uid
store.add(self)
def __repr__(self):
return '<UID {} at {}>'.format(self.uid, id(self))
@staticmethod
@dbconnection
# Note that the parameter order is deliberately reversed here. Normally,
# `store` is the first parameter after `self`, but since this is a
# staticmethod and there is no self, the decorator will see the uid in
# arg[0].
def record(uid, store):
"""Record the uid in the database.
:param uid: The unique id.
:type uid: unicode
:raises ValueError: if the id is not unique.
"""
existing = store.query(UID).filter_by(uid=uid)
if existing.count() != 0:
raise ValueError(uid)
return UID(uid)
@staticmethod
@dbconnection
def get_total_uid_count(store):
return store.query(UID).count()
@staticmethod
@dbconnection
def cull_orphans(store):
# Avoid circular imports.
from mailman.model.user import User
# Delete all uids in this table that are not associated with user
# rows.
results = store.query(UID).filter(
~UID.uid.in_(store.query(User._user_id)))
for uid in results.all():
store.delete(uid)
|
