app/soc/models/user.py
author Todd Larsen <tlarsen@google.com>
Sat, 15 Nov 2008 03:12:33 +0000
changeset 481 94834a1e6c01
parent 339 b9be44e09530
child 512 aae25d2b4464
permissions -rw-r--r--
Attempt to rename User.id to User.account, in preparation for making User be derived from Linkable, which will have a property named 'id'. Patch by: Todd Larsen
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
Todd Larsen <tlarsen@google.com>
parents: 118
diff changeset
    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
Todd Larsen <tlarsen@google.com>
parents: 118
diff changeset
    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.
339
b9be44e09530 Define the Models for implementing Quizzes (collections of Questions) and their
Todd Larsen <tlarsen@google.com>
parents: 298
diff changeset
    58
b9be44e09530 Define the Models for implementing Quizzes (collections of Questions) and their
Todd Larsen <tlarsen@google.com>
parents: 298
diff changeset
    59
   responses)  a 1:many relationship of Reponse entities submitted by the
b9be44e09530 Define the Models for implementing Quizzes (collections of Questions) and their
Todd Larsen <tlarsen@google.com>
parents: 298
diff changeset
    60
     User.  This relation is implemented as the 'responses' back-reference
b9be44e09530 Define the Models for implementing Quizzes (collections of Questions) and their
Todd Larsen <tlarsen@google.com>
parents: 298
diff changeset
    61
     Query of the Response model 'respondent' reference.
7
5c72db822ebb Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    62
  """
5c72db822ebb Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    63
5c72db822ebb Initial revision of the user.py module, containing the User Model, from the
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    64
  #: 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
    65
  #: 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
    66
  #: 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
    67
  #: of any Melange application.
481
94834a1e6c01 Attempt to rename User.id to User.account, in preparation for making User be
Todd Larsen <tlarsen@google.com>
parents: 339
diff changeset
    68
  account = db.UserProperty(required=True,
161
f4af04306890 Add a verbose_name and help_text to the User.id Property.
Todd Larsen <tlarsen@google.com>
parents: 137
diff changeset
    69
      verbose_name=ugettext_lazy('User account'))
481
94834a1e6c01 Attempt to rename User.id to User.account, in preparation for making User be
Todd Larsen <tlarsen@google.com>
parents: 339
diff changeset
    70
  account.help_text = ugettext_lazy(
94834a1e6c01 Attempt to rename User.id to User.account, in preparation for making User be
Todd Larsen <tlarsen@google.com>
parents: 339
diff changeset
    71
      'A valid 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
    72
131
Todd Larsen <tlarsen@google.com>
parents: 118
diff changeset
    73
  #: A list (possibly empty) of former Google Accounts associated with
Todd Larsen <tlarsen@google.com>
parents: 118
diff changeset
    74
  #: this User.
481
94834a1e6c01 Attempt to rename User.id to User.account, in preparation for making User be
Todd Larsen <tlarsen@google.com>
parents: 339
diff changeset
    75
  former_accounts = db.ListProperty(users.User)
131
Todd Larsen <tlarsen@google.com>
parents: 118
diff changeset
    76
78
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    77
  #: Required field storing a nickname; displayed publicly.
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    78
  #: Nicknames can be any valid UTF-8 text.
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    79
  nick_name = db.StringProperty(required=True,
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    80
      verbose_name=ugettext_lazy('Nick name'))
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    81
      
298
c76a366c7ab4 Replace almost all occurences of linkname with link_name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 193
diff changeset
    82
  #: Required field storing link_name used in URLs to identify user.
78
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    83
  #: Lower ASCII characters only.
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    84
  link_name = db.StringProperty(required=True,
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    85
      verbose_name=ugettext_lazy('Link name'))
206e6eeed6c4 Updated User and Person models.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 54
diff changeset
    86
  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
    87
      '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
    88
      '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
    89
0f572149449d Make isIdDeveloper() also able to check an is_developer Boolean property in
Todd Larsen <tlarsen@google.com>
parents: 131
diff changeset
    90
  #: 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
    91
  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
    92
      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
    93
  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
    94
      'Field used to indicate user with site-wide "Developer" access.')