forum/models/user.py

   1 from base import *
   2 from utils import PickledObjectField
   3 from django.core.exceptions import ObjectDoesNotExist, MultipleObjectsReturned
   4 from django.contrib.contenttypes.models import ContentType
   5 from django.contrib.auth.models import User as DjangoUser, AnonymousUser as DjangoAnonymousUser
   6 from django.db.models import Q
   7
   8 from django.utils.encoding import smart_unicode
   9
  10 from forum.settings import TRUNCATE_LONG_USERNAMES, TRUNCATE_USERNAMES_LONGER_THAN
  11
  12 import string
  13 from random import Random
  14
  15 from django.utils.translation import ugettext as _
  16 import logging
  17
  18 class AnonymousUser(DjangoAnonymousUser):
  19     reputation = 0
  20
  21     def get_visible_answers(self, question):
  22         return question.answers.filter_state(deleted=False)
  23
  24     def can_view_deleted_post(self, post):
  25         return False
  26
  27     def can_vote_up(self):
  28         return False
  29
  30     def can_vote_down(self):
  31         return False
  32
  33     def can_vote_count_today(self):
  34         return 0
  35
  36     def can_flag_offensive(self, post=None):
  37         return False
  38
  39     def can_view_offensive_flags(self, post=None):
  40         return False
  41
  42     def can_comment(self, post):
  43         return False
  44
  45     def can_like_comment(self, comment):
  46         return False
  47
  48     def can_edit_comment(self, comment):
  49         return False
  50
  51     def can_delete_comment(self, comment):
  52         return False
  53
  54     def can_convert_to_comment(self, answer):
  55         return False
  56
  57     def can_convert_to_question(self, answer):
  58         return False
  59
  60     def can_convert_comment_to_answer(self, comment):
  61         return False
  62
  63     def can_accept_answer(self, answer):
  64         return False
  65
  66     def can_create_tags(self):
  67         return False
  68
  69     def can_edit_post(self, post):
  70         return False
  71
  72     def can_wikify(self, post):
  73         return False
  74
  75     def can_cancel_wiki(self, post):
  76         return False
  77
  78     def can_retag_questions(self):
  79         return False
  80
  81     def can_close_question(self, question):
  82         return False
  83
  84     def can_reopen_question(self, question):
  85         return False
  86
  87     def can_delete_post(self, post):
  88         return False
  89
  90     def can_upload_files(self):
  91         return False
  92
  93     def is_a_super_user_or_staff(self):
  94         return False
  95
  96 def true_if_is_super_or_staff(fn):
  97     def decorated(self, *args, **kwargs):
  98         return self.is_superuser or self.is_staff or fn(self, *args, **kwargs)
  99
 100     return decorated
 101
 102 def false_if_validation_required_to(item):
 103     def decorator(fn):
 104         def decorated(self, *args, **kwargs):
 105             if item in settings.REQUIRE_EMAIL_VALIDATION_TO and not self.email_isvalid:
 106                 return False
 107             else:
 108                 return fn(self, *args, **kwargs)
 109         return decorated
 110     return decorator
 111
 112 class User(BaseModel, DjangoUser):
 113     is_approved = models.BooleanField(default=False)
 114     email_isvalid = models.BooleanField(default=False)
 115
 116     reputation = models.PositiveIntegerField(default=0)
 117     gold = models.PositiveIntegerField(default=0)
 118     silver = models.PositiveIntegerField(default=0)
 119     bronze = models.PositiveIntegerField(default=0)
 120
 121     last_seen = models.DateTimeField(default=datetime.datetime.now)
 122     real_name = models.CharField(max_length=100, blank=True)
 123     website = models.URLField(max_length=200, blank=True)
 124     location = models.CharField(max_length=100, blank=True)
 125     date_of_birth = models.DateField(null=True, blank=True)
 126     about = models.TextField(blank=True)
 127
 128     subscriptions = models.ManyToManyField('Node', related_name='subscribers', through='QuestionSubscription')
 129
 130     vote_up_count = DenormalizedField("actions", canceled=False, action_type="voteup")
 131     vote_down_count = DenormalizedField("actions", canceled=False, action_type="votedown")
 132
 133     def __unicode__(self):
 134         return smart_unicode(self.username)
 135
 136     @property
 137     def prop(self):
 138         prop = self.__dict__.get('_prop', None)
 139
 140         if prop is None:
 141             prop = UserPropertyDict(self)
 142             self._prop = prop
 143
 144         return prop
 145
 146     @property
 147     def is_siteowner(self):
 148         #todo: temporary thing, for now lets just assume that the site owner will always be the first user of the application
 149         return self.id == 1
 150
 151     @property
 152     def decorated_name(self):
 153         username = smart_unicode(self.username)
 154
 155         if len(username) > TRUNCATE_USERNAMES_LONGER_THAN and TRUNCATE_LONG_USERNAMES:
 156             username = '%s...' % username[:TRUNCATE_USERNAMES_LONGER_THAN-3]
 157
 158         if settings.SHOW_STATUS_DIAMONDS:
 159             if self.is_superuser:
 160                 return u"%s \u2666\u2666" % username
 161
 162             if self.is_staff:
 163                 return u"%s \u2666" % username
 164
 165         return username
 166
 167     @property
 168     def last_activity(self):
 169         try:
 170             return self.actions.order_by('-action_date')[0].action_date
 171         except:
 172             return self.last_seen
 173
 174     @property
 175     def gravatar(self):
 176         return md5(self.email.lower()).hexdigest()
 177
 178     def save(self, *args, **kwargs):
 179         if self.reputation < 0:
 180             self.reputation = 0
 181
 182         new = not bool(self.id)
 183
 184         super(User, self).save(*args, **kwargs)
 185
 186         if new:
 187             sub_settings = SubscriptionSettings(user=self)
 188             sub_settings.save()
 189
 190     def get_messages(self):
 191         messages = []
 192         for m in self.message_set.all():
 193             messages.append(m.message)
 194         return messages
 195
 196     def delete_messages(self):
 197         self.message_set.all().delete()
 198
 199     @models.permalink
 200     def get_profile_url(self):
 201         return ('user_profile', (), {'id': self.id, 'slug': slugify(smart_unicode(self.username))})
 202
 203     def get_absolute_url(self):
 204         return self.get_profile_url()
 205
 206     @models.permalink
 207     def get_asked_url(self):
 208         return ('user_questions', (), {'mode': _('asked-by'), 'user': self.id, 'slug': slugify(smart_unicode(self.username))})
 209
 210     @models.permalink
 211     def get_user_subscriptions_url(self):
 212         return ('user_subscriptions', (), { 'id': self.id, 'slug': slugify(smart_unicode(self.username))})
 213
 214     @models.permalink
 215     def get_answered_url(self):
 216         return ('user_questions', (), {'mode': _('answered-by'), 'user': self.id, 'slug': slugify(self.username)})
 217
 218     def get_subscribed_url(self):
 219         try:
 220             # Try to retrieve the Subscribed User URL.
 221             url = reverse('user_questions',
 222                            kwargs={'mode': _('subscribed-by'), 'user': self.id, 'slug': slugify(smart_unicode(self.username))})
 223             return url
 224         except Exception, e:
 225             # If some Exception has been raised, don't forget to log it.
 226             logging.error("Error retrieving a subscribed user URL: %s" % e)
 227
 228     def get_profile_link(self):
 229         profile_link = u'<a href="%s">%s</a>' % (self.get_profile_url(), self.username)
 230         return mark_safe(profile_link)
 231
 232     def get_visible_answers(self, question):
 233         return question.answers.filter_state(deleted=False)
 234
 235     def get_vote_count_today(self):
 236         today = datetime.date.today()
 237         return self.actions.filter(canceled=False, action_type__in=("voteup", "votedown"),
 238                                    action_date__gte=(today - datetime.timedelta(days=1))).count()
 239
 240     def get_reputation_by_upvoted_today(self):
 241         today = datetime.datetime.now()
 242         sum = self.reputes.filter(reputed_at__range=(today - datetime.timedelta(days=1), today)).aggregate(
 243                 models.Sum('value'))
 244         #todo: redo this, maybe transform in the daily cap
 245         #if sum.get('value__sum', None) is not None: return sum['value__sum']
 246         return 0
 247
 248     def get_flagged_items_count_today(self):
 249         today = datetime.date.today()
 250         return self.actions.filter(canceled=False, action_type="flag",
 251                                    action_date__gte=(today - datetime.timedelta(days=1))).count()
 252
 253     def can_vote_count_today(self):
 254         votes_today = settings.MAX_VOTES_PER_DAY
 255
 256         if settings.USER_REPUTATION_TO_MAX_VOTES:
 257             votes_today = votes_today + int(self.reputation)
 258
 259         return votes_today
 260
 261     @true_if_is_super_or_staff
 262     def can_view_deleted_post(self, post):
 263         return post.author == self
 264
 265     @true_if_is_super_or_staff
 266     def can_vote_up(self):
 267         return self.reputation >= int(settings.REP_TO_VOTE_UP)
 268
 269     @true_if_is_super_or_staff
 270     def can_vote_down(self):
 271         return self.reputation >= int(settings.REP_TO_VOTE_DOWN)
 272
 273     @false_if_validation_required_to('flag')
 274     def can_flag_offensive(self, post=None):
 275         if post is not None and post.author == self:
 276             return False
 277         return self.is_superuser or self.is_staff or self.reputation >= int(settings.REP_TO_FLAG)
 278
 279     @true_if_is_super_or_staff
 280     def can_view_offensive_flags(self, post=None):
 281         if post is not None and post.author == self:
 282             return True
 283         return self.reputation >= int(settings.REP_TO_VIEW_FLAGS)
 284
 285     @true_if_is_super_or_staff
 286     @false_if_validation_required_to('comment')
 287     def can_comment(self, post):
 288         return self == post.author or self.reputation >= int(settings.REP_TO_COMMENT
 289                 ) or (post.__class__.__name__ == "Answer" and self == post.question.author)
 290
 291     @true_if_is_super_or_staff
 292     def can_like_comment(self, comment):
 293         return self != comment.author and (self.reputation >= int(settings.REP_TO_LIKE_COMMENT))
 294
 295     @true_if_is_super_or_staff
 296     def can_edit_comment(self, comment):
 297         return (comment.author == self and comment.added_at >= datetime.datetime.now() - datetime.timedelta(minutes=60)
 298         ) or self.is_superuser
 299
 300     @true_if_is_super_or_staff
 301     def can_delete_comment(self, comment):
 302         return self == comment.author or self.reputation >= int(settings.REP_TO_DELETE_COMMENTS)
 303
 304     def can_convert_comment_to_answer(self, comment):
 305         # We need to know what is the comment parent node type.
 306         comment_parent_type = comment.parent.node_type
 307
 308         # If the parent is not a question or an answer this comment cannot be converted to an answer.
 309         if comment_parent_type != "question" and comment_parent_type != "answer":
 310             return False
 311
 312         return (comment.parent.node_type in ('question', 'answer')) and (self.is_superuser or self.is_staff or (
 313             self == comment.author) or (self.reputation >= int(settings.REP_TO_CONVERT_COMMENTS_TO_ANSWERS)))
 314
 315     def can_convert_to_comment(self, answer):
 316         return (not answer.marked) and (self.is_superuser or self.is_staff or answer.author == self or self.reputation >= int
 317                 (settings.REP_TO_CONVERT_TO_COMMENT))
 318
 319     def can_convert_to_question(self, answer):
 320         return (not answer.marked) and (self.is_superuser or self.is_staff or answer.author == self or self.reputation >= int
 321                 (settings.REP_TO_CONVERT_TO_QUESTION))
 322
 323     @true_if_is_super_or_staff
 324     def can_accept_answer(self, answer):
 325         return self == answer.question.author and (settings.USERS_CAN_ACCEPT_OWN or answer.author != answer.question.author)
 326
 327     @true_if_is_super_or_staff
 328     def can_create_tags(self):
 329         return self.reputation >= int(settings.REP_TO_CREATE_TAGS)
 330
 331     @true_if_is_super_or_staff
 332     def can_edit_post(self, post):
 333         return self == post.author or self.reputation >= int(settings.REP_TO_EDIT_OTHERS
 334                                                              ) or (post.nis.wiki and self.reputation >= int(
 335                 settings.REP_TO_EDIT_WIKI))
 336
 337     @true_if_is_super_or_staff
 338     def can_wikify(self, post):
 339         return self == post.author or self.reputation >= int(settings.REP_TO_WIKIFY)
 340
 341     @true_if_is_super_or_staff
 342     def can_cancel_wiki(self, post):
 343         return self == post.author
 344
 345     @true_if_is_super_or_staff
 346     def can_retag_questions(self):
 347         return self.reputation >= int(settings.REP_TO_RETAG)
 348
 349     @true_if_is_super_or_staff
 350     def can_close_question(self, question):
 351         return (self == question.author and self.reputation >= int(settings.REP_TO_CLOSE_OWN)
 352         ) or self.reputation >= int(settings.REP_TO_CLOSE_OTHERS)
 353
 354     @true_if_is_super_or_staff
 355     def can_reopen_question(self, question):
 356         return self == question.author and self.reputation >= int(settings.REP_TO_REOPEN_OWN)
 357
 358     @true_if_is_super_or_staff
 359     def can_delete_post(self, post):
 360         if post.node_type == "comment":
 361             return self.can_delete_comment(post)
 362
 363         return (self == post.author and (post.__class__.__name__ == "Answer" or
 364         not post.answers.exclude(author__id=self.id).count()))
 365
 366     @true_if_is_super_or_staff
 367     def can_upload_files(self):
 368         return self.reputation >= int(settings.REP_TO_UPLOAD)
 369
 370     @true_if_is_super_or_staff
 371     def is_a_super_user_or_staff(self):
 372         return False
 373
 374     def email_valid_and_can_ask(self):
 375         return 'ask' not in settings.REQUIRE_EMAIL_VALIDATION_TO or self.email_isvalid
 376
 377     def email_valid_and_can_answer(self):
 378         return 'answer' not in settings.REQUIRE_EMAIL_VALIDATION_TO or self.email_isvalid
 379
 380     def check_password(self, old_passwd):
 381         self.__dict__.update(self.__class__.objects.filter(id=self.id).values('password')[0])
 382         return DjangoUser.check_password(self, old_passwd)
 383
 384     @property
 385     def suspension(self):
 386         if self.__dict__.get('_suspension_dencache_', False) != None:
 387             try:
 388                 self.__dict__['_suspension_dencache_'] = self.reputes.get(action__action_type="suspend", action__canceled=False).action
 389             except ObjectDoesNotExist:
 390                 self.__dict__['_suspension_dencache_'] = None
 391             except MultipleObjectsReturned:
 392                 logging.error("Multiple suspension actions found for user %s (%s)" % (self.username, self.id))
 393                 self.__dict__['_suspension_dencache_'] = self.reputes.filter(action__action_type="suspend", action__canceled=False
 394                                                                              ).order_by('-action__action_date')[0]
 395
 396         return self.__dict__['_suspension_dencache_']
 397
 398     def _pop_suspension_cache(self):
 399         self.__dict__.pop('_suspension_dencache_', None)
 400
 401     def is_suspended(self):
 402         if not self.is_active:
 403             suspension = self.suspension
 404
 405             if suspension and suspension.extra.get('bantype', None) == 'forxdays' and (
 406             datetime.datetime.now() > suspension.action_date + datetime.timedelta(
 407                     days=int(suspension.extra.get('forxdays', 365)))):
 408                 suspension.cancel()
 409             else:
 410                 return True
 411
 412         return False
 413
 414     class Meta:
 415         app_label = 'forum'
 416
 417 class UserProperty(BaseModel):
 418     user = models.ForeignKey(User, related_name='properties')
 419     key = models.CharField(max_length=16)
 420     value = PickledObjectField()
 421
 422     class Meta:
 423         app_label = 'forum'
 424         unique_together = ('user', 'key')
 425
 426     def cache_key(self):
 427         return self._generate_cache_key("%s:%s" % (self.user.id, self.key))
 428
 429     @classmethod
 430     def infer_cache_key(cls, querydict):
 431         if 'user' in querydict and 'key' in querydict:
 432             return cls._generate_cache_key("%s:%s" % (querydict['user'].id, querydict['key']))
 433
 434         return None
 435
 436 class UserPropertyDict(object):
 437     def __init__(self, user):
 438         self.__dict__['_user'] = user
 439
 440     def __get_property(self, name):
 441         if self.__dict__.get('__%s__' % name, None):
 442             return self.__dict__['__%s__' % name]
 443         try:
 444             user = self.__dict__['_user']
 445             prop = UserProperty.objects.get(user=user, key=name)
 446             self.__dict__['__%s__' % name] = prop
 447             self.__dict__[name] = prop.value
 448             return prop
 449         except:
 450             return None
 451
 452
 453     def __getattr__(self, name):
 454         if self.__dict__.get(name, None):
 455             return self.__dict__[name]
 456
 457         prop = self.__get_property(name)
 458
 459         if prop:
 460             return prop.value
 461         else:
 462             return None
 463
 464     def __setattr__(self, name, value):
 465         current = self.__get_property(name)
 466
 467         if value is not None:
 468             if current:
 469                 current.value = value
 470                 self.__dict__[name] = value
 471                 current.save(full_save=True)
 472             else:
 473                 user = self.__dict__['_user']
 474                 prop = UserProperty(user=user, value=value, key=name)
 475                 prop.save()
 476                 self.__dict__[name] = value
 477                 self.__dict__['__%s__' % name] = prop
 478         else:
 479             if current:
 480                 current.delete()
 481                 del self.__dict__[name]
 482                 del self.__dict__['__%s__' % name]
 483
 484
 485 class SubscriptionSettings(models.Model):
 486     user = models.OneToOneField(User, related_name='subscription_settings', editable=False)
 487
 488     enable_notifications = models.BooleanField(default=True)
 489
 490     #notify if
 491     member_joins = models.CharField(max_length=1, default='n')
 492     new_question = models.CharField(max_length=1, default='n')
 493     new_question_watched_tags = models.CharField(max_length=1, default='i')
 494     subscribed_questions = models.CharField(max_length=1, default='i')
 495
 496     #auto_subscribe_to
 497     all_questions = models.BooleanField(default=False)
 498     all_questions_watched_tags = models.BooleanField(default=False)
 499     questions_viewed = models.BooleanField(default=False)
 500
 501     #notify activity on subscribed
 502     notify_answers = models.BooleanField(default=True)
 503     notify_reply_to_comments = models.BooleanField(default=True)
 504     notify_comments_own_post = models.BooleanField(default=True)
 505     notify_comments = models.BooleanField(default=False)
 506     notify_accepted = models.BooleanField(default=False)
 507
 508     send_digest = models.BooleanField(default=True)
 509
 510     class Meta:
 511         app_label = 'forum'
 512
 513 from forum.utils.time import one_day_from_now
 514
 515 class ValidationHashManager(models.Manager):
 516     def _generate_md5_hash(self, user, type, hash_data, seed):
 517         return md5("%s%s%s%s" % (seed, "".join(map(str, hash_data)), user.id, type)).hexdigest()
 518
 519     def create_new(self, user, type, hash_data=[], expiration=None):
 520         seed = ''.join(Random().sample(string.letters+string.digits, 12))
 521         hash = self._generate_md5_hash(user, type, hash_data, seed)
 522
 523         obj = ValidationHash(hash_code=hash, seed=seed, user=user, type=type)
 524
 525         if expiration is not None:
 526             obj.expiration = expiration
 527
 528         try:
 529             obj.save()
 530         except:
 531             return None
 532
 533         return obj
 534
 535     def validate(self, hash, user, type, hash_data=[]):
 536         try:
 537             obj = self.get(hash_code=hash)
 538         except:
 539             return False
 540
 541         if obj.type != type:
 542             return False
 543
 544         if obj.user != user:
 545             return False
 546
 547         valid = (obj.hash_code == self._generate_md5_hash(obj.user, type, hash_data, obj.seed))
 548
 549         if valid:
 550             if obj.expiration < datetime.datetime.now():
 551                 obj.delete()
 552                 return False
 553             else:
 554                 obj.delete()
 555                 return True
 556
 557         return False
 558
 559 class ValidationHash(models.Model):
 560     hash_code = models.CharField(max_length=255, unique=True)
 561     seed = models.CharField(max_length=12)
 562     expiration = models.DateTimeField(default=one_day_from_now)
 563     type = models.CharField(max_length=12)
 564     user = models.ForeignKey(User)
 565
 566     objects = ValidationHashManager()
 567
 568     class Meta:
 569         unique_together = ('user', 'type')
 570         app_label = 'forum'
 571
 572     def __str__(self):
 573         return self.hash_code
 574
 575 class AuthKeyUserAssociation(models.Model):
 576     key = models.CharField(max_length=255, null=False, unique=True)
 577     provider = models.CharField(max_length=64)
 578     user = models.ForeignKey(User, related_name="auth_keys")
 579     added_at = models.DateTimeField(default=datetime.datetime.now)
 580
 581     class Meta:
 582         app_label = 'forum'