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.IntegerField(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 the community doesn't allow negative reputation, set it to 0
 180         if not settings.ALLOW_NEGATIVE_REPUTATION and self.reputation < 0:
 181             self.reputation = 0
 182
 183         new = not bool(self.id)
 184
 185         super(User, self).save(*args, **kwargs)
 186
 187         if new:
 188             sub_settings = SubscriptionSettings(user=self)
 189             sub_settings.save()
 190
 191     def get_messages(self):
 192         messages = []
 193         for m in self.message_set.all():
 194             messages.append(m.message)
 195         return messages
 196
 197     def delete_messages(self):
 198         self.message_set.all().delete()
 199
 200     @models.permalink
 201     def get_profile_url(self):
 202         return ('user_profile', (), {'id': self.id, 'slug': slugify(smart_unicode(self.username))})
 203
 204     def get_absolute_url(self):
 205         return self.get_profile_url()
 206
 207     @models.permalink
 208     def get_asked_url(self):
 209         return ('user_questions', (), {'mode': _('asked-by'), 'user': self.id, 'slug': slugify(smart_unicode(self.username))})
 210
 211     @models.permalink
 212     def get_user_subscriptions_url(self):
 213         return ('user_subscriptions', (), { 'id': self.id, 'slug': slugify(smart_unicode(self.username))})
 214
 215     @models.permalink
 216     def get_answered_url(self):
 217         return ('user_questions', (), {'mode': _('answered-by'), 'user': self.id, 'slug': slugify(self.username)})
 218
 219     def get_subscribed_url(self):
 220         try:
 221             # Try to retrieve the Subscribed User URL.
 222             url = reverse('user_questions',
 223                            kwargs={'mode': _('subscribed-by'), 'user': self.id, 'slug': slugify(smart_unicode(self.username))})
 224             return url
 225         except Exception, e:
 226             # If some Exception has been raised, don't forget to log it.
 227             logging.error("Error retrieving a subscribed user URL: %s" % e)
 228
 229     def get_profile_link(self):
 230         profile_link = u'<a href="%s">%s</a>' % (self.get_profile_url(), self.username)
 231         return mark_safe(profile_link)
 232
 233     def get_visible_answers(self, question):
 234         return question.answers.filter_state(deleted=False)
 235
 236     def get_vote_count_today(self):
 237         today = datetime.date.today()
 238         return self.actions.filter(canceled=False, action_type__in=("voteup", "votedown"),
 239                                    action_date__gte=(today - datetime.timedelta(days=1))).count()
 240
 241     def get_reputation_by_upvoted_today(self):
 242         today = datetime.datetime.now()
 243         sum = self.reputes.filter(reputed_at__range=(today - datetime.timedelta(days=1), today)).aggregate(
 244                 models.Sum('value'))
 245         #todo: redo this, maybe transform in the daily cap
 246         #if sum.get('value__sum', None) is not None: return sum['value__sum']
 247         return 0
 248
 249     def get_flagged_items_count_today(self):
 250         today = datetime.date.today()
 251         return self.actions.filter(canceled=False, action_type="flag",
 252                                    action_date__gte=(today - datetime.timedelta(days=1))).count()
 253
 254     def can_vote_count_today(self):
 255         votes_today = settings.MAX_VOTES_PER_DAY
 256
 257         if settings.USER_REPUTATION_TO_MAX_VOTES:
 258             votes_today = votes_today + int(self.reputation)
 259
 260         return votes_today
 261
 262     def can_use_canned_comments(self):
 263         # The canned comments feature is available only for admins and moderators,
 264         # and only if the "Use canned comments" setting is activated in the administration.
 265         if (self.is_superuser or self.is_staff) and settings.USE_CANNED_COMMENTS:
 266             return True
 267         else:
 268             return False
 269
 270     @true_if_is_super_or_staff
 271     def can_view_deleted_post(self, post):
 272         return post.author == self
 273
 274     @true_if_is_super_or_staff
 275     def can_vote_up(self):
 276         return self.reputation >= int(settings.REP_TO_VOTE_UP)
 277
 278     @true_if_is_super_or_staff
 279     def can_vote_down(self):
 280         return self.reputation >= int(settings.REP_TO_VOTE_DOWN)
 281
 282     @false_if_validation_required_to('flag')
 283     def can_flag_offensive(self, post=None):
 284         if post is not None and post.author == self:
 285             return False
 286         return self.is_superuser or self.is_staff or self.reputation >= int(settings.REP_TO_FLAG)
 287
 288     @true_if_is_super_or_staff
 289     def can_view_offensive_flags(self, post=None):
 290         if post is not None and post.author == self:
 291             return True
 292         return self.reputation >= int(settings.REP_TO_VIEW_FLAGS)
 293
 294     @true_if_is_super_or_staff
 295     @false_if_validation_required_to('comment')
 296     def can_comment(self, post):
 297         return self == post.author or self.reputation >= int(settings.REP_TO_COMMENT
 298                 ) or (post.__class__.__name__ == "Answer" and self == post.question.author)
 299
 300     @true_if_is_super_or_staff
 301     def can_like_comment(self, comment):
 302         return self != comment.author and (self.reputation >= int(settings.REP_TO_LIKE_COMMENT))
 303
 304     @true_if_is_super_or_staff
 305     def can_edit_comment(self, comment):
 306         return (comment.author == self and comment.added_at >= datetime.datetime.now() - datetime.timedelta(minutes=60)
 307         ) or self.is_superuser
 308
 309     @true_if_is_super_or_staff
 310     def can_delete_comment(self, comment):
 311         return self == comment.author or self.reputation >= int(settings.REP_TO_DELETE_COMMENTS)
 312
 313     def can_convert_comment_to_answer(self, comment):
 314         # We need to know what is the comment parent node type.
 315         comment_parent_type = comment.parent.node_type
 316
 317         # If the parent is not a question or an answer this comment cannot be converted to an answer.
 318         if comment_parent_type != "question" and comment_parent_type != "answer":
 319             return False
 320
 321         return (comment.parent.node_type in ('question', 'answer')) and (self.is_superuser or self.is_staff or (
 322             self == comment.author) or (self.reputation >= int(settings.REP_TO_CONVERT_COMMENTS_TO_ANSWERS)))
 323
 324     def can_convert_to_comment(self, answer):
 325         return (not answer.marked) and (self.is_superuser or self.is_staff or answer.author == self or self.reputation >= int
 326                 (settings.REP_TO_CONVERT_TO_COMMENT))
 327
 328     def can_convert_to_question(self, node):
 329         return (not node.marked) and (self.is_superuser or self.is_staff or node.author == self or self.reputation >= int
 330                 (settings.REP_TO_CONVERT_TO_QUESTION))
 331
 332     @true_if_is_super_or_staff
 333     def can_accept_answer(self, answer):
 334         return self == answer.question.author and (settings.USERS_CAN_ACCEPT_OWN or answer.author != answer.question.author)
 335
 336     @true_if_is_super_or_staff
 337     def can_create_tags(self):
 338         return self.reputation >= int(settings.REP_TO_CREATE_TAGS)
 339
 340     @true_if_is_super_or_staff
 341     def can_edit_post(self, post):
 342         return self == post.author or self.reputation >= int(settings.REP_TO_EDIT_OTHERS
 343                                                              ) or (post.nis.wiki and self.reputation >= int(
 344                 settings.REP_TO_EDIT_WIKI))
 345
 346     @true_if_is_super_or_staff
 347     def can_wikify(self, post):
 348         return self == post.author or self.reputation >= int(settings.REP_TO_WIKIFY)
 349
 350     @true_if_is_super_or_staff
 351     def can_cancel_wiki(self, post):
 352         return self == post.author
 353
 354     @true_if_is_super_or_staff
 355     def can_retag_questions(self):
 356         return self.reputation >= int(settings.REP_TO_RETAG)
 357
 358     @true_if_is_super_or_staff
 359     def can_close_question(self, question):
 360         return (self == question.author and self.reputation >= int(settings.REP_TO_CLOSE_OWN)
 361         ) or self.reputation >= int(settings.REP_TO_CLOSE_OTHERS)
 362
 363     @true_if_is_super_or_staff
 364     def can_reopen_question(self, question):
 365         # Check whether the setting to Unify close and reopen permissions has been activated
 366         if bool(settings.UNIFY_PERMISSIONS_TO_CLOSE_AND_REOPEN):
 367             # If we unify close to reopen check whether the user has permissions to close.
 368             # If he has -- he can reopen his question too.
 369             can_reopen = (
 370                 self == question.author and self.reputation >= int(settings.REP_TO_CLOSE_OWN)
 371             ) or self.reputation >= int(settings.REP_TO_CLOSE_OTHERS)
 372         else:
 373             # Check whether the user is the author and has the required permissions to reopen
 374             can_reopen = self == question.author and self.reputation >= int(settings.REP_TO_REOPEN_OWN)
 375         return can_reopen
 376
 377     @true_if_is_super_or_staff
 378     def can_delete_post(self, post):
 379         if post.node_type == "comment":
 380             return self.can_delete_comment(post)
 381
 382         return (self == post.author and (post.__class__.__name__ == "Answer" or
 383         not post.answers.exclude(author__id=self.id).count()))
 384
 385     @true_if_is_super_or_staff
 386     def can_upload_files(self):
 387         return self.reputation >= int(settings.REP_TO_UPLOAD)
 388
 389     @true_if_is_super_or_staff
 390     def is_a_super_user_or_staff(self):
 391         return False
 392
 393     def email_valid_and_can_ask(self):
 394         return 'ask' not in settings.REQUIRE_EMAIL_VALIDATION_TO or self.email_isvalid
 395
 396     def email_valid_and_can_answer(self):
 397         return 'answer' not in settings.REQUIRE_EMAIL_VALIDATION_TO or self.email_isvalid
 398
 399     def check_password(self, old_passwd):
 400         self.__dict__.update(self.__class__.objects.filter(id=self.id).values('password')[0])
 401         return DjangoUser.check_password(self, old_passwd)
 402
 403     @property
 404     def suspension(self):
 405         if self.__dict__.get('_suspension_dencache_', False) != None:
 406             try:
 407                 self.__dict__['_suspension_dencache_'] = self.reputes.get(action__action_type="suspend", action__canceled=False).action
 408             except ObjectDoesNotExist:
 409                 self.__dict__['_suspension_dencache_'] = None
 410             except MultipleObjectsReturned:
 411                 logging.error("Multiple suspension actions found for user %s (%s)" % (self.username, self.id))
 412                 self.__dict__['_suspension_dencache_'] = self.reputes.filter(action__action_type="suspend", action__canceled=False
 413                                                                              ).order_by('-action__action_date')[0].action
 414
 415         return self.__dict__['_suspension_dencache_']
 416
 417     def _pop_suspension_cache(self):
 418         self.__dict__.pop('_suspension_dencache_', None)
 419
 420     def is_suspended(self):
 421         if not self.is_active:
 422             suspension = self.suspension
 423
 424             if suspension and suspension.extra.get('bantype', None) == 'forxdays' and (
 425             datetime.datetime.now() > suspension.action_date + datetime.timedelta(
 426                     days=int(suspension.extra.get('forxdays', 365)))):
 427                 suspension.cancel()
 428             else:
 429                 return True
 430
 431         return False
 432
 433     class Meta:
 434         app_label = 'forum'
 435
 436 class UserProperty(BaseModel):
 437     user = models.ForeignKey(User, related_name='properties')
 438     key = models.CharField(max_length=16)
 439     value = PickledObjectField()
 440
 441     class Meta:
 442         app_label = 'forum'
 443         unique_together = ('user', 'key')
 444
 445     def cache_key(self):
 446         return self._generate_cache_key("%s:%s" % (self.user.id, self.key))
 447
 448     @classmethod
 449     def infer_cache_key(cls, querydict):
 450         if 'user' in querydict and 'key' in querydict:
 451             return cls._generate_cache_key("%s:%s" % (querydict['user'].id, querydict['key']))
 452
 453         return None
 454
 455 class UserPropertyDict(object):
 456     def __init__(self, user):
 457         self.__dict__['_user'] = user
 458
 459     def __get_property(self, name):
 460         if self.__dict__.get('__%s__' % name, None):
 461             return self.__dict__['__%s__' % name]
 462         try:
 463             user = self.__dict__['_user']
 464             prop = UserProperty.objects.get(user=user, key=name)
 465             self.__dict__['__%s__' % name] = prop
 466             self.__dict__[name] = prop.value
 467             return prop
 468         except:
 469             return None
 470
 471
 472     def __getattr__(self, name):
 473         if self.__dict__.get(name, None):
 474             return self.__dict__[name]
 475
 476         prop = self.__get_property(name)
 477
 478         if prop:
 479             return prop.value
 480         else:
 481             return None
 482
 483     def __setattr__(self, name, value):
 484         current = self.__get_property(name)
 485
 486         if value is not None:
 487             if current:
 488                 current.value = value
 489                 self.__dict__[name] = value
 490                 current.save(full_save=True)
 491             else:
 492                 user = self.__dict__['_user']
 493                 prop = UserProperty(user=user, value=value, key=name)
 494                 prop.save()
 495                 self.__dict__[name] = value
 496                 self.__dict__['__%s__' % name] = prop
 497         else:
 498             if current:
 499                 current.delete()
 500                 del self.__dict__[name]
 501                 del self.__dict__['__%s__' % name]
 502
 503
 504 class SubscriptionSettings(models.Model):
 505     user = models.OneToOneField(User, related_name='subscription_settings', editable=False)
 506
 507     enable_notifications = models.BooleanField(default=True)
 508
 509     #notify if
 510     member_joins = models.CharField(max_length=1, default='n')
 511     new_question = models.CharField(max_length=1, default='n')
 512     new_question_watched_tags = models.CharField(max_length=1, default='i')
 513     subscribed_questions = models.CharField(max_length=1, default='i')
 514
 515     #auto_subscribe_to
 516     all_questions = models.BooleanField(default=False)
 517     all_questions_watched_tags = models.BooleanField(default=False)
 518     questions_viewed = models.BooleanField(default=False)
 519
 520     #notify activity on subscribed
 521     notify_answers = models.BooleanField(default=True)
 522     notify_reply_to_comments = models.BooleanField(default=True)
 523     notify_comments_own_post = models.BooleanField(default=True)
 524     notify_comments = models.BooleanField(default=False)
 525     notify_accepted = models.BooleanField(default=False)
 526
 527     send_digest = models.BooleanField(default=True)
 528
 529     class Meta:
 530         app_label = 'forum'
 531
 532 from forum.utils.time import one_day_from_now
 533
 534 class ValidationHashManager(models.Manager):
 535     def _generate_md5_hash(self, user, type, hash_data, seed):
 536         return md5("%s%s%s%s" % (seed, "".join(map(str, hash_data)), user.id, type)).hexdigest()
 537
 538     def create_new(self, user, type, hash_data=[], expiration=None):
 539         seed = ''.join(Random().sample(string.letters+string.digits, 12))
 540         hash = self._generate_md5_hash(user, type, hash_data, seed)
 541
 542         obj = ValidationHash(hash_code=hash, seed=seed, user=user, type=type)
 543
 544         if expiration is not None:
 545             obj.expiration = expiration
 546
 547         try:
 548             obj.save()
 549         except:
 550             return None
 551
 552         return obj
 553
 554     def validate(self, hash, user, type, hash_data=[]):
 555         try:
 556             obj = self.get(hash_code=hash)
 557         except:
 558             return False
 559
 560         if obj.type != type:
 561             return False
 562
 563         if obj.user != user:
 564             return False
 565
 566         valid = (obj.hash_code == self._generate_md5_hash(obj.user, type, hash_data, obj.seed))
 567
 568         if valid:
 569             if obj.expiration < datetime.datetime.now():
 570                 obj.delete()
 571                 return False
 572             else:
 573                 obj.delete()
 574                 return True
 575
 576         return False
 577
 578 class ValidationHash(models.Model):
 579     hash_code = models.CharField(max_length=255, unique=True)
 580     seed = models.CharField(max_length=12)
 581     expiration = models.DateTimeField(default=one_day_from_now)
 582     type = models.CharField(max_length=12)
 583     user = models.ForeignKey(User)
 584
 585     objects = ValidationHashManager()
 586
 587     class Meta:
 588         unique_together = ('user', 'type')
 589         app_label = 'forum'
 590
 591     def __str__(self):
 592         return self.hash_code
 593
 594 class AuthKeyUserAssociation(models.Model):
 595     key = models.CharField(max_length=255, null=False, unique=True)
 596     provider = models.CharField(max_length=64)
 597     user = models.ForeignKey(User, related_name="auth_keys")
 598     added_at = models.DateTimeField(default=datetime.datetime.now)
 599
 600     class Meta:
 601         app_label = 'forum'