author | Pawel Solyga <Pawel.Solyga@gmail.com> |
Tue, 30 Sep 2008 16:26:30 +0000 | |
changeset 214 | 21f94815fc85 |
parent 193 | 3d30a7a96ce7 |
child 298 | c76a366c7ab4 |
permissions | -rw-r--r-- |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
1 |
#!/usr/bin/python2.5 |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
2 |
# |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
3 |
# Copyright 2008 the Melange authors. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
4 |
# |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
5 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
6 |
# you may not use this file except in compliance with the License. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
7 |
# You may obtain a copy of the License at |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
8 |
# |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
9 |
# http://www.apache.org/licenses/LICENSE-2.0 |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
10 |
# |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
11 |
# Unless required by applicable law or agreed to in writing, software |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
12 |
# distributed under the License is distributed on an "AS IS" BASIS, |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
13 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
14 |
# See the License for the specific language governing permissions and |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
15 |
# limitations under the License. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
16 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
17 |
"""This module contains the User Model.""" |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
18 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
19 |
__authors__ = [ |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
20 |
'"Todd Larsen" <tlarsen@google.com>', |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
21 |
'"Sverre Rabbelier" <sverre@rabbelier.nl>', |
78
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
22 |
'"Pawel Solyga" <pawel.solyga@gmail.com>', |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
23 |
] |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
24 |
|
118
d2e61a490969
Clean up User Model and User profile edit view now that soc.logic.site.id_user
Todd Larsen <tlarsen@google.com>
parents:
99
diff
changeset
|
25 |
|
131 | 26 |
from google.appengine.api import users |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
27 |
from google.appengine.ext import db |
131 | 28 |
|
78
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
29 |
from django.utils.translation import ugettext_lazy |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
30 |
|
118
d2e61a490969
Clean up User Model and User profile edit view now that soc.logic.site.id_user
Todd Larsen <tlarsen@google.com>
parents:
99
diff
changeset
|
31 |
from soc.models import base |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
32 |
|
118
d2e61a490969
Clean up User Model and User profile edit view now that soc.logic.site.id_user
Todd Larsen <tlarsen@google.com>
parents:
99
diff
changeset
|
33 |
|
d2e61a490969
Clean up User Model and User profile edit view now that soc.logic.site.id_user
Todd Larsen <tlarsen@google.com>
parents:
99
diff
changeset
|
34 |
class User(base.ModelWithFieldAttributes): |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
35 |
"""A user and associated login credentials, the fundamental identity entity. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
36 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
37 |
User is a separate Model class from Person because the same login |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
38 |
ID may be used to, for example, serve as Contributor in one Program |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
39 |
and a Reviewer in another. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
40 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
41 |
Also, this allows a Person to, in the future, re-associate that |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
42 |
Person entity with a different Google Account if necessary. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
43 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
44 |
A User entity participates in the following relationships implemented |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
45 |
as a db.ReferenceProperty elsewhere in another db.Model: |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
46 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
47 |
persons) a 1:many relationship of Person entities identified by the |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
48 |
User. This relation is implemented as the 'persons' back-reference |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
49 |
Query of the Person model 'user' reference. |
181
fdd29818a954
Remove Author model (use Person instead). Update models after removing Author. Add new Sponsor, Organization models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
161
diff
changeset
|
50 |
|
fdd29818a954
Remove Author model (use Person instead). Update models after removing Author. Add new Sponsor, Organization models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
161
diff
changeset
|
51 |
documents) a 1:many relationship of Document entities identified by the |
fdd29818a954
Remove Author model (use Person instead). Update models after removing Author. Add new Sponsor, Organization models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
161
diff
changeset
|
52 |
User. This relation is implemented as the 'user' back-reference |
fdd29818a954
Remove Author model (use Person instead). Update models after removing Author. Add new Sponsor, Organization models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
161
diff
changeset
|
53 |
Query of the Document model 'user' reference. |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
54 |
|
193
3d30a7a96ce7
Note 'groups' back-reference from 'founder' property in soc.models.group.Group.
Todd Larsen <tlarsen@google.com>
parents:
181
diff
changeset
|
55 |
groups) a 1:many relationship of Group entities "founded" by the User. |
3d30a7a96ce7
Note 'groups' back-reference from 'founder' property in soc.models.group.Group.
Todd Larsen <tlarsen@google.com>
parents:
181
diff
changeset
|
56 |
This relation is implemented as the 'groups' back-reference Query of |
3d30a7a96ce7
Note 'groups' back-reference from 'founder' property in soc.models.group.Group.
Todd Larsen <tlarsen@google.com>
parents:
181
diff
changeset
|
57 |
the Group model 'founder' reference. |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
58 |
""" |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
59 |
|
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
60 |
#: A Google Account, which also provides a "private" email address. |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
61 |
#: This email address is only used in an automated fashion by |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
62 |
#: Melange web applications and is not made visible to other users |
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
63 |
#: of any Melange application. |
161
f4af04306890
Add a verbose_name and help_text to the User.id Property.
Todd Larsen <tlarsen@google.com>
parents:
137
diff
changeset
|
64 |
id = db.UserProperty(required=True, |
f4af04306890
Add a verbose_name and help_text to the User.id Property.
Todd Larsen <tlarsen@google.com>
parents:
137
diff
changeset
|
65 |
verbose_name=ugettext_lazy('User account')) |
f4af04306890
Add a verbose_name and help_text to the User.id Property.
Todd Larsen <tlarsen@google.com>
parents:
137
diff
changeset
|
66 |
id.help_text = ugettext_lazy( |
f4af04306890
Add a verbose_name and help_text to the User.id Property.
Todd Larsen <tlarsen@google.com>
parents:
137
diff
changeset
|
67 |
'Email address of a valid user (Google Account).') |
7
5c72db822ebb
Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
68 |
|
131 | 69 |
#: A list (possibly empty) of former Google Accounts associated with |
70 |
#: this User. |
|
71 |
former_ids = db.ListProperty(users.User) |
|
72 |
||
78
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
73 |
#: Required field storing a nickname; displayed publicly. |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
74 |
#: Nicknames can be any valid UTF-8 text. |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
75 |
nick_name = db.StringProperty(required=True, |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
76 |
verbose_name=ugettext_lazy('Nick name')) |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
77 |
|
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
78 |
#: Required field storing linkname used in URLs to identify user. |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
79 |
#: Lower ASCII characters only. |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
80 |
link_name = db.StringProperty(required=True, |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
81 |
verbose_name=ugettext_lazy('Link name')) |
206e6eeed6c4
Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
54
diff
changeset
|
82 |
link_name.help_text = ugettext_lazy( |
83
3f4f7c540b75
Created response helper respond() function that is used to generate base templates and it's child templates (handles sign in/out links, user name etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
78
diff
changeset
|
83 |
'Field used in URLs to identify user. ' |
3f4f7c540b75
Created response helper respond() function that is used to generate base templates and it's child templates (handles sign in/out links, user name etc).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents:
78
diff
changeset
|
84 |
'Lower ASCII characters only.') |
137
0f572149449d
Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents:
131
diff
changeset
|
85 |
|
0f572149449d
Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents:
131
diff
changeset
|
86 |
#: field storing whether User is a Developer with site-wide access. |
0f572149449d
Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents:
131
diff
changeset
|
87 |
is_developer = db.BooleanProperty( |
0f572149449d
Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents:
131
diff
changeset
|
88 |
verbose_name=ugettext_lazy('Is Developer')) |
0f572149449d
Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents:
131
diff
changeset
|
89 |
is_developer.help_text = ugettext_lazy( |
0f572149449d
Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents:
131
diff
changeset
|
90 |
'Field used to indicate user with site-wide "Developer" access.') |