2 # Functions for interacting with the persons table in the database
4 # Mark Huang <mlhuang@cs.princeton.edu>
5 # Copyright (C) 2006 The Trustees of Princeton University
7 # $Id: Persons.py,v 1.18 2006/11/09 03:07:42 mlhuang Exp $
10 from types import StringTypes
11 from datetime import datetime
14 from random import Random
18 from PLC.Faults import *
19 from PLC.Parameter import Parameter
20 from PLC.Filter import Filter
21 from PLC.Table import Row, Table
22 from PLC.Keys import Key, Keys
27 Representation of a row in the persons table. To use, optionally
28 instantiate with a dict of values. Update as you would a
29 dict. Commit to the database with sync().
32 table_name = 'persons'
33 primary_key = 'person_id'
34 join_tables = ['person_role', 'person_site', 'slice_person', 'person_session']
36 'person_id': Parameter(int, "Account identifier"),
37 'first_name': Parameter(str, "Given name", max = 128),
38 'last_name': Parameter(str, "Surname", max = 128),
39 'title': Parameter(str, "Title", max = 128, nullok = True),
40 'email': Parameter(str, "Primary e-mail address", max = 254),
41 'phone': Parameter(str, "Telephone number", max = 64, nullok = True),
42 'url': Parameter(str, "Home page", max = 254, nullok = True),
43 'bio': Parameter(str, "Biography", max = 254, nullok = True),
44 'enabled': Parameter(bool, "Has been enabled"),
45 'password': Parameter(str, "Account password in crypt() form", max = 254),
46 'last_updated': Parameter(int, "Date and time of last update", ro = True),
47 'date_created': Parameter(int, "Date and time when account was created", ro = True),
48 'role_ids': Parameter([int], "List of role identifiers"),
49 'roles': Parameter([str], "List of roles"),
50 'site_ids': Parameter([int], "List of site identifiers"),
51 'key_ids': Parameter([int], "List of key identifiers"),
52 'slice_ids': Parameter([int], "List of slice identifiers"),
55 def validate_email(self, email):
57 Validate email address. Stolen from Mailman.
60 invalid_email = PLCInvalidArgument("Invalid e-mail address")
61 email_badchars = r'[][()<>|;^,\200-\377]'
63 # Pretty minimal, cheesy check. We could do better...
64 if not email or email.count(' ') > 0:
66 if re.search(email_badchars, email) or email[0] == '-':
70 at_sign = email.find('@')
73 user = email[:at_sign]
74 rest = email[at_sign+1:]
75 domain = rest.split('.')
77 # This means local, unqualified addresses, are no allowed
83 conflicts = Persons(self.api, [email])
84 for person in conflicts:
85 if 'person_id' not in self or self['person_id'] != person['person_id']:
86 raise PLCInvalidArgument, "E-mail address already in use"
90 def validate_password(self, password):
92 Encrypt password if necessary before committing to the
98 if len(password) > len(magic) and \
99 password[0:len(magic)] == magic:
102 # Generate a somewhat unique 8 character salt string
103 salt = str(time.time()) + str(Random().random())
104 salt = md5.md5(salt).hexdigest()[:8]
105 return crypt.crypt(password.encode(self.api.encoding), magic + salt + "$")
107 def can_update(self, person):
109 Returns true if we can update the specified person. We can
112 1. We are the person.
114 3. We are a PI and the person is a user or tech or at
118 assert isinstance(person, Person)
120 if self['person_id'] == person['person_id']:
123 if 'admin' in self['roles']:
126 if 'pi' in self['roles']:
127 if set(self['site_ids']).intersection(person['site_ids']):
128 # Can update people with higher role IDs
129 return min(self['role_ids']) < min(person['role_ids'])
133 def can_view(self, person):
135 Returns true if we can view the specified person. We can
138 1. We are the person.
140 3. We are a PI and the person is at one of our sites.
143 assert isinstance(person, Person)
145 if self.can_update(person):
148 if 'pi' in self['roles']:
149 if set(self['site_ids']).intersection(person['site_ids']):
150 # Can view people with equal or higher role IDs
151 return min(self['role_ids']) <= min(person['role_ids'])
155 def add_role(self, role_id, commit = True):
157 Add role to existing account.
160 assert 'person_id' in self
162 person_id = self['person_id']
164 if role_id not in self['role_ids']:
165 self.api.db.do("INSERT INTO person_role (person_id, role_id)" \
166 " VALUES(%(person_id)d, %(role_id)d)",
172 self['role_ids'].append(role_id)
174 def remove_role(self, role_id, commit = True):
176 Remove role from existing account.
179 assert 'person_id' in self
181 person_id = self['person_id']
183 if role_id in self['role_ids']:
184 self.api.db.do("DELETE FROM person_role" \
185 " WHERE person_id = %(person_id)d" \
186 " AND role_id = %(role_id)d",
192 self['role_ids'].remove(role_id)
194 def add_key(self, key, commit = True):
196 Add key to existing account.
199 assert 'person_id' in self
200 assert isinstance(key, Key)
201 assert 'key_id' in key
203 person_id = self['person_id']
204 key_id = key['key_id']
206 if key_id not in self['key_ids']:
207 self.api.db.do("INSERT INTO person_key (person_id, key_id)" \
208 " VALUES(%(person_id)d, %(key_id)d)",
214 self['key_ids'].append(key_id)
216 def remove_key(self, key, commit = True):
218 Remove key from existing account.
221 assert 'person_id' in self
222 assert isinstance(key, Key)
223 assert 'key_id' in key
225 person_id = self['person_id']
226 key_id = key['key_id']
228 if key_id in self['key_ids']:
229 self.api.db.do("DELETE FROM person_key" \
230 " WHERE person_id = %(person_id)d" \
231 " AND key_id = %(key_id)d",
237 self['key_ids'].remove(key_id)
239 def set_primary_site(self, site, commit = True):
241 Set the primary site for an existing account.
244 assert 'person_id' in self
245 assert isinstance(site, PLC.Sites.Site)
246 assert 'site_id' in site
248 person_id = self['person_id']
249 site_id = site['site_id']
250 self.api.db.do("UPDATE person_site SET is_primary = False" \
251 " WHERE person_id = %(person_id)d",
253 self.api.db.do("UPDATE person_site SET is_primary = True" \
254 " WHERE person_id = %(person_id)d" \
255 " AND site_id = %(site_id)d",
261 assert 'site_ids' in self
262 assert site_id in self['site_ids']
264 # Make sure that the primary site is first in the list
265 self['site_ids'].remove(site_id)
266 self['site_ids'].insert(0, site_id)
268 def delete(self, commit = True):
270 Delete existing account.
274 keys = Keys(self.api, self['key_ids'])
276 key.delete(commit = False)
278 # Clean up miscellaneous join tables
279 for table in self.join_tables:
280 self.api.db.do("DELETE FROM %s WHERE person_id = %d" % \
281 (table, self['person_id']))
284 self['deleted'] = True
287 class Persons(Table):
289 Representation of row(s) from the persons table in the
293 def __init__(self, api, person_filter = None, columns = None):
294 Table.__init__(self, api, Person, columns)
296 sql = "SELECT %s FROM view_persons WHERE deleted IS False" % \
297 ", ".join(self.columns)
299 if person_filter is not None:
300 if isinstance(person_filter, (list, tuple, set)):
301 # Separate the list into integers and strings
302 ints = filter(lambda x: isinstance(x, (int, long)), person_filter)
303 strs = filter(lambda x: isinstance(x, StringTypes), person_filter)
304 person_filter = Filter(Person.fields, {'person_id': ints, 'email': strs})
305 sql += " AND (%s)" % person_filter.sql(api, "OR")
306 elif isinstance(person_filter, dict):
307 person_filter = Filter(Person.fields, person_filter)
308 sql += " AND (%s)" % person_filter.sql(api, "AND")