Mercurial > public > sg101

annotate bio/models.py @ 598:2e429e2b7bb6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
For issue #15; add date info to forum search results.
author Brian Neal <bgneal@gmail.com>
date Wed, 13 Jun 2012 20:46:30 -0500
parents ee87ea74d46b
children 678a1a2ef55a
rev   line source
gremmie@1 1 """
gremmie@1 2 Contains models for the bio application.
gremmie@1 3 I would have picked profile for this application, but that is already taken, apparently.
gremmie@1 4 """
bgneal@277 5 import datetime
gremmie@1 6 import os.path
gremmie@1 7
gremmie@1 8 from django.db import models
bgneal@259 9 from django.contrib.auth.models import User
gremmie@1 10 from django.conf import settings
bgneal@54 11 from django.core.cache import cache
bgneal@277 12 from django.template.loader import render_to_string
gremmie@1 13
bgneal@128 14 from core.markup import SiteMarkup
bgneal@124 15
bgneal@562 16
bgneal@215 17 # These are the secondary user status enumeration values.
bgneal@215 18 (STA_ACTIVE, # User is a full member in good standing.
bgneal@215 19 STA_RESIGNED, # User has voluntarily asked to be removed.
bgneal@215 20 STA_REMOVED, # User was removed for bad behavior.
bgneal@215 21 STA_SUSPENDED, # User is temporarily suspended; e.g. a stranger tripped
bgneal@215 22 # the spam filter.
bgneal@215 23 STA_SPAMMER, # User has been removed for spamming.
bgneal@215 24 STA_STRANGER, # New member, isn't fully trusted yet. Their comments and
bgneal@215 25 # forum posts are scanned for spam. They can have their
bgneal@215 26 # accounts deactivated by moderators for spamming.
bgneal@215 27 ) = range(6)
bgneal@147 28
bgneal@147 29 USER_STATUS_CHOICES = (
bgneal@147 30 (STA_ACTIVE, "Active"),
bgneal@147 31 (STA_RESIGNED, "Resigned"),
bgneal@147 32 (STA_REMOVED, "Removed"),
bgneal@147 33 (STA_SUSPENDED, "Suspended"),
bgneal@147 34 (STA_SPAMMER, "Spammer"),
bgneal@215 35 (STA_STRANGER, "Stranger")
bgneal@147 36 )
bgneal@147 37
bgneal@204 38
bgneal@204 39 class Badge(models.Model):
bgneal@204 40 """This model represents badges that users can earn."""
bgneal@204 41 image = models.ImageField(upload_to='badges')
bgneal@204 42 name = models.CharField(max_length=64)
bgneal@204 43 description = models.TextField(blank=True)
bgneal@204 44 order = models.IntegerField()
bgneal@204 45 numeric_id = models.IntegerField(db_index=True)
bgneal@204 46
bgneal@204 47 class Meta:
bgneal@204 48 ordering = ('order', )
bgneal@204 49
bgneal@204 50 def __unicode__(self):
bgneal@204 51 return self.name
bgneal@204 52
bgneal@204 53 def get_absolute_url(self):
bgneal@204 54 return self.image.url
bgneal@204 55
bgneal@204 56 def html(self):
bgneal@204 57 """Returns a HTML img tag representation of the badge."""
bgneal@204 58 if self.image:
bgneal@204 59 return u'<img src="%s" alt="%s" title="%s" />' % (
bgneal@204 60 self.get_absolute_url(), self.name, self.name)
bgneal@204 61 return u''
bgneal@204 62 html.allow_tags = True
bgneal@204 63
bgneal@204 64
gremmie@1 65 def avatar_file_path(instance, filename):
bgneal@560 66 ext = os.path.splitext(filename)[1]
bgneal@560 67 if not ext:
bgneal@560 68 ext = '.jpg'
bgneal@560 69 avatar_name = instance.user.username + ext
bgneal@560 70 return os.path.join(settings.AVATAR_DIR, 'users', avatar_name)
gremmie@1 71
gremmie@1 72
gremmie@1 73 class UserProfile(models.Model):
gremmie@1 74 """model to represent additional information about users"""
gremmie@1 75
bgneal@259 76 user = models.ForeignKey(User, unique=True)
gremmie@1 77 location = models.CharField(max_length=128, blank=True)
gremmie@1 78 birthday = models.DateField(blank=True, null=True,
gremmie@1 79 help_text='Optional; the year is not shown to others')
gremmie@1 80 occupation = models.CharField(max_length=128, blank=True)
gremmie@1 81 interests = models.CharField(max_length=255, blank=True)
gremmie@1 82 profile_text = models.TextField(blank=True)
gremmie@1 83 profile_html = models.TextField(blank=True)
gremmie@1 84 hide_email = models.BooleanField(default=True)
gremmie@1 85 signature = models.TextField(blank=True)
gremmie@1 86 signature_html = models.TextField(blank=True)
gremmie@1 87 avatar = models.ImageField(upload_to=avatar_file_path, blank=True)
bgneal@70 88 time_zone = models.CharField(max_length=64, blank=True,
bgneal@70 89 default='US/Pacific')
bgneal@120 90 use_24_time = models.BooleanField(default=False)
bgneal@96 91 forum_post_count = models.IntegerField(default=0)
bgneal@215 92 status = models.IntegerField(default=STA_STRANGER,
bgneal@147 93 choices=USER_STATUS_CHOICES)
bgneal@147 94 status_date = models.DateTimeField(auto_now_add=True)
bgneal@204 95 badges = models.ManyToManyField(Badge, through="BadgeOwnership")
bgneal@277 96 update_date = models.DateTimeField(db_index=True, blank=True)
bgneal@390 97 auto_favorite = models.BooleanField(default=False)
bgneal@390 98 auto_subscribe = models.BooleanField(default=False)
gremmie@1 99
gremmie@1 100 def __unicode__(self):
gremmie@1 101 return self.user.username
gremmie@1 102
gremmie@1 103 class Meta:
gremmie@1 104 ordering = ('user__username', )
gremmie@1 105
gremmie@1 106 def save(self, *args, **kwargs):
bgneal@562 107 """
bgneal@562 108 Custom profile save() function.
bgneal@562 109 If content_update is True (default), then it is assumed that major
bgneal@562 110 fields are being updated and that the profile_content_update signal
bgneal@562 111 should be signalled. When content_update is False, the update_date is
bgneal@562 112 not updated, expensive markup conversions are not performed, and the
bgneal@562 113 signal is not signalled. This is useful for updating the
bgneal@562 114 forum_post_count, for example.
bgneal@562 115
bgneal@562 116 """
bgneal@562 117 content_update = kwargs.pop('content_update', True)
bgneal@562 118
bgneal@562 119 if content_update:
bgneal@562 120 self.update_date = datetime.datetime.now()
bgneal@562 121 sm = SiteMarkup()
bgneal@562 122 self.profile_html = sm.convert(self.profile_text)
bgneal@562 123 self.signature_html = sm.convert(self.signature)
bgneal@562 124 cache.delete('avatar_' + self.user.username)
bgneal@562 125
gremmie@1 126 super(UserProfile, self).save(*args, **kwargs)
bgneal@562 127
bgneal@562 128 if content_update:
bgneal@562 129 notify_profile_content_update(self)
bgneal@138 130
bgneal@138 131 @models.permalink
bgneal@138 132 def get_absolute_url(self):
bgneal@138 133 return ('bio-view_profile', (), {'username': self.user.username})
bgneal@138 134
bgneal@204 135 def badge_ownership(self):
bgneal@329 136 return BadgeOwnership.objects.filter(profile=self).select_related('badge')
bgneal@204 137
bgneal@215 138 def is_stranger(self):
bgneal@215 139 """Returns True if this user profile status is STA_STRANGER."""
bgneal@215 140 return self.status == STA_STRANGER
bgneal@215 141
bgneal@215 142 def user_is_active(self):
bgneal@215 143 """Returns the profile's user is_active status. This function exists
bgneal@215 144 for the admin.
bgneal@215 145 """
bgneal@215 146 return self.user.is_active
bgneal@215 147 user_is_active.boolean = True
bgneal@215 148 user_is_active.short_description = "Is Active"
bgneal@215 149
bgneal@363 150 def reset_text_fields(self):
bgneal@363 151 """
bgneal@363 152 Reset profile text fields to empty defaults.
bgneal@363 153 This function is useful when a spammer is identified.
bgneal@363 154
bgneal@363 155 """
bgneal@363 156 self.location = ''
bgneal@363 157 self.occupation = ''
bgneal@363 158 self.interests = ''
bgneal@363 159 self.profile_text = ''
bgneal@363 160 self.signature = ''
bgneal@363 161
bgneal@223 162 def search_title(self):
bgneal@223 163 full_name = self.user.get_full_name()
bgneal@223 164 if full_name:
bgneal@223 165 return u"%s (%s)" % (self.user.username, full_name)
bgneal@223 166 return self.user.username
bgneal@223 167
bgneal@223 168 def search_summary(self):
bgneal@277 169 text = render_to_string('search/indexes/bio/userprofile_text.txt',
bgneal@277 170 {'object': self});
bgneal@277 171 return text
bgneal@223 172
bgneal@138 173
bgneal@138 174 class UserProfileFlag(models.Model):
bgneal@138 175 """This model represents a user flagging a profile as inappropriate."""
bgneal@259 176 user = models.ForeignKey(User)
bgneal@138 177 profile = models.ForeignKey(UserProfile)
bgneal@138 178 flag_date = models.DateTimeField(auto_now_add=True)
bgneal@138 179
bgneal@138 180 def __unicode__(self):
bgneal@138 181 return u"%s's profile flagged by %s" % (self.profile.user.username,
bgneal@138 182 self.user.username)
bgneal@138 183
bgneal@138 184 class Meta:
bgneal@138 185 ordering = ('flag_date', )
bgneal@138 186
bgneal@138 187 def get_profile_url(self):
bgneal@138 188 return '<a href="%s">Profile</a>' % self.profile.get_absolute_url()
bgneal@138 189 get_profile_url.allow_tags = True
bgneal@204 190
bgneal@204 191
bgneal@204 192 class BadgeOwnership(models.Model):
bgneal@204 193 """This model represents the ownership of badges by users."""
bgneal@204 194 profile = models.ForeignKey(UserProfile)
bgneal@204 195 badge = models.ForeignKey(Badge)
bgneal@204 196 count = models.IntegerField(default=1)
bgneal@204 197
bgneal@204 198 class Meta:
bgneal@204 199 verbose_name_plural = "badge ownership"
bgneal@204 200 ordering = ('badge__order', )
bgneal@204 201
bgneal@204 202 def __unicode__(self):
bgneal@204 203 if self.count == 1:
bgneal@204 204 return u"%s owns 1 %s" % (self.profile.user.username,
bgneal@204 205 self.badge.name)
bgneal@204 206 else:
bgneal@204 207 return u"%s owns %d %s badges" % (self.profile.user.username,
bgneal@204 208 self.count, self.badge.name)
bgneal@204 209
bgneal@204 210 def badge_count_str(self):
bgneal@204 211 if self.count == 1:
bgneal@204 212 return u"1 %s" % self.badge.name
bgneal@204 213 return u"%d %ss" % (self.count, self.badge.name)
bgneal@562 214
bgneal@562 215 # Put down here to avoid a circular import
bgneal@562 216 from bio.signals import notify_profile_content_update