3 # Copyright (C) 2013 FinalsClub Foundation
6 from allauth.account.signals import email_confirmed
7 from django.contrib.auth.models import User
8 from django.db.models import Sum
9 from django.db.models.signals import post_save
10 from django.dispatch import receiver
11 from django.db import models, DatabaseError
12 from django.middleware.transaction import transaction
13 from karmaworld.apps.courses.models import School
15 logger = logging.getLogger(__name__)
18 class UserProfile(models.Model):
19 user = models.OneToOneField(User)
21 school = models.ForeignKey(School, blank=True, null=True)
25 for cls in ALL_KARMA_EVENT_CLASSES:
26 points = cls.objects.filter(user=self.user).aggregate(Sum('points'))['points__sum']
51 APPRENTICE: 'Apprentice',
64 points = self.get_points()
65 highest_badge = self.NO_BADGE
66 for badge in self.BADGES:
67 if points >= self.BADGE_THRESHOLDS[badge]:
70 if highest_badge is not self.NO_BADGE:
71 return self.BADGE_NAMES[highest_badge]
75 def __unicode__(self):
76 return self.user.__unicode__()
79 @receiver(email_confirmed, weak=True)
80 def give_email_confirm_karma(sender, **kwargs):
81 GenericKarmaEvent.create_event(kwargs['email_address'].user, "You confirmed your email address", 5)
84 class BaseKarmaEvent(models.Model):
85 points = models.IntegerField()
86 user = models.ForeignKey(User)
87 timestamp = models.DateTimeField(default=datetime.datetime.utcnow)
92 def get_message(self):
93 raise NotImplemented()
96 class GenericKarmaEvent(BaseKarmaEvent):
97 message = models.CharField(max_length=255)
100 def create_event(user, message, points):
101 event = GenericKarmaEvent.objects.create(user=user,
106 def get_message(self):
110 class NoteKarmaEvent(BaseKarmaEvent):
113 NOTE_DELETED = 'deleted'
114 GIVE_FLAG = 'give_flag'
115 GET_FLAGGED = 'get_flagged'
116 EVENT_TYPE_CHOICES = (
117 (UPLOAD, "You uploaded a note"),
118 (THANKS, "You received a thanks for your note"),
119 (NOTE_DELETED, "Your note was deleted"),
120 (GIVE_FLAG, "You flagged a note"),
121 (GET_FLAGGED, "Your note was flagged as spam"),
123 note = models.ForeignKey('notes.Note')
124 event_type = models.CharField(max_length=15, choices=EVENT_TYPE_CHOICES)
134 def get_message(self):
135 return self.get_event_type_display()
137 def __unicode__(self):
138 return unicode(self.user) + ' -- ' + self.get_event_type_display() + ' -- ' + unicode(self.note)
141 def create_event(user, note, type):
142 event = NoteKarmaEvent.objects.create(user=user,
144 points=NoteKarmaEvent.POINTS[type],
149 class CourseKarmaEvent(BaseKarmaEvent):
150 GIVE_FLAG = 'give_flag'
151 EVENT_TYPE_CHOICES = (
152 (GIVE_FLAG, "You flagged a course"),
154 course = models.ForeignKey('courses.Course')
155 event_type = models.CharField(max_length=15, choices=EVENT_TYPE_CHOICES)
161 def get_message(self):
162 return self.get_event_type_display()
164 def __unicode__(self):
165 return unicode(self.user) + ' -- ' + self.get_event_type_display() + ' -- ' + unicode(self.course)
168 def create_event(user, course, type):
169 event = CourseKarmaEvent.objects.create(user=user,
171 points=CourseKarmaEvent.POINTS[type],
176 ALL_KARMA_EVENT_CLASSES = (GenericKarmaEvent, NoteKarmaEvent, CourseKarmaEvent)
179 def user_display_name(user):
180 """Return the best way to display a user's
181 name to them on the site."""
182 if hasattr(user, 'first_name') and user.first_name and \
183 hasattr(user, 'last_name') and user.last_name:
184 return user.first_name + ' ' + user.last_name
185 elif hasattr(user, 'email') and user.email:
191 @receiver(post_save, sender=User, weak=True)
192 def create_user_profile(sender, instance, created, **kwargs):
194 with transaction.commit_on_success():
196 UserProfile.objects.create(user=instance)
197 except DatabaseError:
198 logger.warn("Could not create UserProfile for user {u}. This is okay if running syncdb.".format(u=instance))