models.py
13.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# -*- coding: utf-8 -*-
import urllib
from uuid import uuid4
from hashlib import md5
from django.db import models
from django.conf import settings
from django.utils import timezone
from django.core.urlresolvers import reverse
from django.utils.translation import ugettext_lazy as _
from html2text import html2text
from haystack.query import SearchQuerySet
from taggit.managers import TaggableManager
from hitcounter.models import HitCounterModelMixin
from .managers import NotSpamManager, MostVotedManager, HighestScore
from .utils import blocks, email
from .utils.etiquetador import etiquetador
from colab.accounts.utils import mailman
def get_validation_key():
return uuid4().hex
class EmailAddressValidation(models.Model):
address = models.EmailField(unique=True)
user = models.ForeignKey(settings.AUTH_USER_MODEL, null=True,
related_name='emails_not_validated')
validation_key = models.CharField(max_length=32, null=True,
default=get_validation_key)
created = models.DateTimeField(auto_now_add=True)
class Meta:
unique_together = ('user', 'address')
@classmethod
def create(cls, address, user):
email_address_validation = cls.objects.create(address=address,
user=user)
return email_address_validation
@classmethod
def verify_email(cls, email_address_validation, verification_url):
return email.send_verification_email(
email_address_validation.address,
email_address_validation.user,
email_address_validation.validation_key,
verification_url
)
class EmailAddress(models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL, null=True,
related_name='emails', on_delete=models.SET_NULL)
address = models.EmailField(unique=True)
real_name = models.CharField(max_length=64, blank=True, db_index=True)
md5 = models.CharField(max_length=32, null=True)
class Meta:
ordering = ('id', )
def save(self, *args, **kwargs):
self.md5 = md5(self.address).hexdigest()
super(EmailAddress, self).save(*args, **kwargs)
def get_full_name(self):
if self.user and self.user.get_full_name():
return self.user.get_full_name()
else:
return self.real_name
def get_full_name_or_anonymous(self):
return self.get_full_name() or _('Anonymous')
def __unicode__(self):
return '"%s" <%s>' % (self.get_full_name(), self.address)
class MailingList(models.Model):
name = models.CharField(max_length=80)
email = models.EmailField()
description = models.TextField()
logo = models.FileField(upload_to='list_logo') # TODO
last_imported_index = models.IntegerField(default=0)
is_private = models.BooleanField(default=False)
_max_latest_threads = 6
def update_privacy(self):
self.is_private = mailman.is_private_list(self.name)
def get_absolute_url(self):
params = {
'list': self.name,
'type': 'thread',
'order': 'latest',
}
return u'{}?{}'.format(reverse('haystack_search'),
urllib.urlencode(params))
def get_latest(self):
not_spam_latest = self.thread_set.filter(spam=False)
ordered_latest = not_spam_latest.order_by(
'-latest_message__received_time')
return ordered_latest[:self._max_latest_threads]
def get_most_relevant(self):
all_most_relevant = Thread.highest_score.filter(
mailinglist__name=self.name)[:self._max_latest_threads]
return [thread.latest_message for thread in all_most_relevant]
def get_number_of_users(self):
return len(mailman.list_users(self.name))
def __unicode__(self):
return self.name
class MailingListMembership(models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL)
mailinglist = models.ForeignKey(MailingList)
def __unicode__(self):
return '%s on %s' % (self.user.email, self.mailinglist.name)
class Keyword(models.Model):
keyword = models.CharField(max_length='128')
weight = models.IntegerField(default=0)
thread = models.ForeignKey('Thread')
class Meta:
ordering = ('?', ) # random order
def __unicode__(self):
return self.keyword
class Thread(models.Model, HitCounterModelMixin):
subject_token = models.CharField(max_length=512)
mailinglist = \
models.ForeignKey(
MailingList,
verbose_name=_(u"Mailing List"),
help_text=_(u"The Mailing List where is the thread"))
latest_message = \
models.OneToOneField('Message', null=True, related_name='+',
verbose_name=_(u"Latest message"),
help_text=_(u"Latest message posted"))
score = models.IntegerField(default=0, verbose_name=_(u"Score"),
help_text=_(u"Thread score"))
spam = models.BooleanField(default=False)
highest_score = HighestScore()
all_objects = models.Manager()
objects = NotSpamManager()
tags = TaggableManager()
# Save this pseudo now to avoid calling the
# function N times in the loops below
now = timezone.now()
class Meta:
verbose_name = _(u"Thread")
verbose_name_plural = _(u"Threads")
unique_together = ('subject_token', 'mailinglist')
ordering = ('-latest_message__received_time', )
@models.permalink
def get_absolute_url(self):
return ('thread_view', [self.mailinglist, self.subject_token])
def update_keywords(self):
blocks = MessageBlock.objects.filter(message__thread__pk=self.pk,
is_reply=False)
self.tags.clear()
text = u'\n'.join(map(unicode, blocks))
tags = etiquetador(html2text(text))
for tag, weight in tags:
keyword, created = Keyword.objects.get_or_create(thread=self,
keyword=tag)
if created or keyword.weight != weight:
keyword.weight = weight
keyword.save()
if weight >= 3:
self.tags.add(tag)
# removing old tags not used anylonger
if tags:
qs = Keyword.objects.filter(thread=self)
qs = qs.exclude(keyword__in=zip(*tags)[0])
qs.delete()
def get_related(self):
query_string = u' '.join(self.tags.names())
if query_string:
query_set = SearchQuerySet().exclude(django_id=self.pk)
return query_set.filter(content=query_string, type='thread')
return tuple()
def __unicode__(self):
return '%s - %s (%s)' % (self.id,
self.subject_token,
self.message_set.count())
def _days_ago(self, date):
return (self.now - date).days
def _get_score(self, weight, created):
return max(weight - (self._days_ago(created) // 3), 5)
def update_score(self):
"""Update the relevance score for this thread.
The score is calculated with the following variables:
* vote_weight: 100 - (minus) 1 for each 3 days since
voted with minimum of 5.
* replies_weight: 300 - (minus) 1 for each 3 days since
replied with minimum of 5.
* page_view_weight: 10.
* vote_score: sum(vote_weight)
* replies_score: sum(replies_weight)
* page_view_score: sum(page_view_weight)
* score = (vote_score + replies_score + page_view_score) // 10
with minimum of 0 and maximum of 5000
"""
if not self.subject_token:
return
vote_score = 0
replies_score = 0
for msg in self.message_set.all():
# Calculate replies_score
replies_score += self._get_score(300, msg.received_time)
# Calculate vote_score
for vote in msg.vote_set.all():
vote_score += self._get_score(100, vote.created)
# Calculate page_view_score
page_view_score = self.hits * 10
self.score = (page_view_score + vote_score + replies_score) // 10
self.save()
class Vote(models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL)
message = models.ForeignKey('Message')
created = models.DateTimeField(auto_now_add=True)
class Meta:
unique_together = ('user', 'message')
def __unicode__(self):
return 'Vote on %s by %s' % (self.message.id,
self.user.username)
class Message(models.Model):
from_address = models.ForeignKey(EmailAddress, db_index=True)
thread = models.ForeignKey(Thread, null=True, db_index=True)
# RFC 2822 recommends to use 78 chars + CRLF (so 80 chars) for
# the max_length of a subject but most of implementations
# goes for 256. We use 512 just in case.
subject = models.CharField(max_length=512, db_index=True,
verbose_name=_(u"Subject"),
help_text=_(u"Please enter a message subject"))
subject_clean = models.CharField(max_length=512, db_index=True)
body = models.TextField(default='',
verbose_name=_(u"Message body"),
help_text=_(u"Please enter a message body"))
received_time = models.DateTimeField(db_index=True)
message_id = models.CharField(max_length=512)
spam = models.BooleanField(default=False)
all_objects = models.Manager()
objects = NotSpamManager()
most_voted = MostVotedManager()
class Meta:
verbose_name = _(u"Message")
verbose_name_plural = _(u"Messages")
unique_together = ('thread', 'message_id')
ordering = ('received_time', )
def __unicode__(self):
return '(%s) %s: %s' % (self.id,
self.from_address.get_full_name(),
self.subject_clean)
def update_blocks(self):
# delete all blocks for that message
self.blocks.all().delete()
for i, block in enumerate(blocks.EmailBlockParser(self)):
MessageBlock.from_emailblock(block, self, i)
@property
def mailinglist(self):
if not self.thread:
return None
return self.thread.mailinglist
def vote_list(self):
"""Return a list of user that voted in this message."""
return [vote.user for vote in self.vote_set.iterator()]
def votes_count(self):
return len(self.vote_list())
def vote(self, user):
Vote.objects.create(
message=self,
user=user
)
def unvote(self, user):
Vote.objects.get(
message=self,
user=user
).delete()
@property
def url(self):
"""Shortcut to get thread url"""
return reverse('thread_view', args=[self.mailinglist.name,
self.thread.subject_token])
@property
def description(self):
"""Alias to self.body"""
return self.body
@property
def title(self):
"""Alias to self.subject_clean"""
return self.subject_clean
@property
def modified(self):
"""Alias to self.modified"""
return self.received_time
@property
def tag(self):
if not self.thread:
return None
return self.mailinglist.name
@property
def author(self):
return self.fullname
@property
def author_url(self):
if self.from_address.user_id:
return self.from_address.user.get_absolute_url()
return None
# An alias for author
@property
def modified_by(self):
return self.author
# An alias for author_url
@property
def modified_by_url(self):
return self.author_url
@property
def fullname(self):
return self.from_address.get_full_name()
@property
def icon_name(self):
return u'envelope'
@property
def type(self):
return u'thread'
class MessageBlock(models.Model):
message = models.ForeignKey(Message, related_name='blocks')
text = models.TextField()
is_reply = models.BooleanField(default=False)
order = models.IntegerField()
def __unicode__(self):
return self.text
class Meta:
ordering = ('order', )
@classmethod
def from_emailblock(klass, emailblock, message, order):
obj = klass.objects.create(text=emailblock.text,
is_reply=emailblock.is_reply,
message=message,
order=order)
return obj
class MessageMetadata(models.Model):
Message = models.ForeignKey(Message)
# Same problem here than on subjects. Read comment above
# on Message.subject
name = models.CharField(max_length=512)
value = models.TextField()
def __unicode__(self):
return 'Email Message Id: %s - %s: %s' % (self.Message.id,
self.name, self.value)