2020-01-29 23:10:32 +00:00
|
|
|
''' template filters '''
|
|
|
|
from django import template
|
|
|
|
|
2020-09-21 15:10:37 +00:00
|
|
|
from bookwyrm import models
|
2020-02-21 23:39:25 +00:00
|
|
|
|
|
|
|
|
2020-01-29 23:10:32 +00:00
|
|
|
register = template.Library()
|
|
|
|
|
|
|
|
@register.filter(name='dict_key')
|
|
|
|
def dict_key(d, k):
|
|
|
|
'''Returns the given key from a dictionary.'''
|
|
|
|
return d.get(k) or 0
|
|
|
|
|
2020-03-07 06:56:44 +00:00
|
|
|
|
2020-04-03 19:43:49 +00:00
|
|
|
@register.filter(name='rating')
|
|
|
|
def get_rating(book, user):
|
|
|
|
''' get a user's rating of a book '''
|
|
|
|
rating = models.Review.objects.filter(
|
|
|
|
user=user,
|
|
|
|
book=book,
|
|
|
|
rating__isnull=False,
|
|
|
|
).order_by('-published_date').first()
|
|
|
|
if rating:
|
|
|
|
return rating.rating
|
|
|
|
return 0
|
2020-01-29 23:32:43 +00:00
|
|
|
|
2020-03-07 06:56:44 +00:00
|
|
|
|
2020-02-22 00:03:05 +00:00
|
|
|
@register.filter(name='username')
|
|
|
|
def get_user_identifier(user):
|
|
|
|
''' use localname for local users, username for remote '''
|
|
|
|
return user.localname if user.localname else user.username
|
|
|
|
|
|
|
|
|
2020-03-07 22:50:29 +00:00
|
|
|
@register.filter(name='notification_count')
|
|
|
|
def get_notification_count(user):
|
|
|
|
''' how many UNREAD notifications are there '''
|
|
|
|
return user.notification_set.filter(read=False).count()
|
|
|
|
|
|
|
|
|
2020-03-10 00:03:59 +00:00
|
|
|
@register.filter(name='replies')
|
|
|
|
def get_replies(status):
|
2020-03-27 16:26:27 +00:00
|
|
|
''' get all direct replies to a status '''
|
|
|
|
#TODO: this limit could cause problems
|
|
|
|
return models.Status.objects.filter(
|
2020-10-08 19:40:47 +00:00
|
|
|
reply_parent=status,
|
|
|
|
deleted=False,
|
2020-03-27 16:26:27 +00:00
|
|
|
).select_subclasses().all()[:10]
|
2020-03-10 00:03:59 +00:00
|
|
|
|
|
|
|
|
|
|
|
@register.filter(name='parent')
|
|
|
|
def get_parent(status):
|
2020-03-27 16:26:27 +00:00
|
|
|
''' get the reply parent for a status '''
|
|
|
|
return models.Status.objects.filter(
|
|
|
|
id=status.reply_parent_id
|
|
|
|
).select_subclasses().get()
|
2020-03-10 00:03:59 +00:00
|
|
|
|
|
|
|
|
2020-03-15 22:25:43 +00:00
|
|
|
@register.filter(name='liked')
|
|
|
|
def get_user_liked(user, status):
|
2020-03-27 16:26:27 +00:00
|
|
|
''' did the given user fav a status? '''
|
2020-03-15 22:25:43 +00:00
|
|
|
try:
|
|
|
|
models.Favorite.objects.get(user=user, status=status)
|
|
|
|
return True
|
|
|
|
except models.Favorite.DoesNotExist:
|
|
|
|
return False
|
|
|
|
|
|
|
|
|
2020-04-01 22:15:21 +00:00
|
|
|
@register.filter(name='boosted')
|
|
|
|
def get_user_boosted(user, status):
|
|
|
|
''' did the given user fav a status? '''
|
|
|
|
return user.id in status.boosters.all().values_list('user', flat=True)
|
|
|
|
|
|
|
|
|
2020-03-29 23:18:04 +00:00
|
|
|
@register.filter(name='follow_request_exists')
|
|
|
|
def follow_request_exists(user, requester):
|
|
|
|
''' see if there is a pending follow request for a user '''
|
|
|
|
try:
|
|
|
|
models.UserFollowRequest.objects.filter(
|
|
|
|
user_subject=requester,
|
|
|
|
user_object=user,
|
|
|
|
).get()
|
|
|
|
return True
|
|
|
|
except models.UserFollowRequest.DoesNotExist:
|
|
|
|
return False
|
|
|
|
|
|
|
|
|
2020-04-01 21:55:32 +00:00
|
|
|
@register.filter(name='boosted_status')
|
|
|
|
def get_boosted(boost):
|
|
|
|
''' load a boosted status. have to do this or it wont get foregin keys '''
|
|
|
|
return models.Status.objects.select_subclasses().filter(
|
|
|
|
id=boost.boosted_status.id
|
|
|
|
).get()
|
|
|
|
|
2020-03-29 23:18:04 +00:00
|
|
|
|
2020-05-03 23:22:33 +00:00
|
|
|
@register.filter(name='edition_info')
|
|
|
|
def get_edition_info(book):
|
|
|
|
''' paperback, French language, 1982 '''
|
2020-05-11 01:22:34 +00:00
|
|
|
if not book:
|
2020-09-21 17:25:26 +00:00
|
|
|
return ''
|
2020-05-03 23:22:33 +00:00
|
|
|
items = [
|
2020-05-11 01:22:34 +00:00
|
|
|
book.physical_format if isinstance(book, models.Edition) else None,
|
2020-05-03 23:22:33 +00:00
|
|
|
book.languages[0] + ' language' if book.languages and \
|
|
|
|
book.languages[0] != 'English' else None,
|
|
|
|
str(book.published_date.year) if book.published_date else None,
|
|
|
|
]
|
|
|
|
return ', '.join(i for i in items if i)
|
|
|
|
|
|
|
|
|
2020-10-31 21:18:56 +00:00
|
|
|
@register.filter(name='book_description')
|
|
|
|
def get_book_description(book):
|
|
|
|
''' use the work's text if the book doesn't have it '''
|
|
|
|
return book.description or book.parent_work.description
|
|
|
|
|
|
|
|
|
|
|
|
@register.filter(name='text_overflow')
|
|
|
|
def text_overflow(text):
|
|
|
|
''' dont' let book descriptions run for ages '''
|
2020-11-01 19:57:46 +00:00
|
|
|
if not text:
|
2020-11-01 19:59:51 +00:00
|
|
|
return ''
|
2020-10-31 21:18:56 +00:00
|
|
|
char_max = 500
|
2020-11-01 19:57:46 +00:00
|
|
|
if text and len(text) < char_max:
|
2020-10-31 21:18:56 +00:00
|
|
|
return text
|
|
|
|
|
|
|
|
trimmed = text[:char_max]
|
|
|
|
# go back to the last space
|
|
|
|
trimmed = ' '.join(trimmed.split(' ')[:-1])
|
|
|
|
return trimmed + '...'
|
|
|
|
|
|
|
|
|
2020-02-21 23:39:25 +00:00
|
|
|
@register.simple_tag(takes_context=True)
|
|
|
|
def shelve_button_identifier(context, book):
|
|
|
|
''' check what shelf a user has a book on, if any '''
|
2020-03-27 16:37:11 +00:00
|
|
|
#TODO: books can be on multiple shelves, handle that better
|
|
|
|
shelf = models.ShelfBook.objects.filter(
|
|
|
|
shelf__user=context['request'].user,
|
|
|
|
book=book
|
|
|
|
).first()
|
|
|
|
if not shelf:
|
2020-02-21 23:39:25 +00:00
|
|
|
return 'to-read'
|
2020-03-27 16:37:11 +00:00
|
|
|
|
2020-02-21 23:39:25 +00:00
|
|
|
identifier = shelf.shelf.identifier
|
|
|
|
if identifier == 'to-read':
|
|
|
|
return 'reading'
|
2020-04-22 13:53:22 +00:00
|
|
|
if identifier == 'reading':
|
2020-02-21 23:39:25 +00:00
|
|
|
return 'read'
|
|
|
|
return 'to-read'
|
|
|
|
|
|
|
|
|
|
|
|
@register.simple_tag(takes_context=True)
|
|
|
|
def shelve_button_text(context, book):
|
|
|
|
''' check what shelf a user has a book on, if any '''
|
2020-03-27 16:37:11 +00:00
|
|
|
#TODO: books can be on multiple shelves
|
|
|
|
shelf = models.ShelfBook.objects.filter(
|
|
|
|
shelf__user=context['request'].user,
|
|
|
|
book=book
|
|
|
|
).first()
|
|
|
|
if not shelf:
|
2020-02-21 23:39:25 +00:00
|
|
|
return 'Want to read'
|
2020-03-27 16:37:11 +00:00
|
|
|
|
2020-02-21 23:39:25 +00:00
|
|
|
identifier = shelf.shelf.identifier
|
2020-02-22 00:26:52 +00:00
|
|
|
if identifier == 'to-read':
|
|
|
|
return 'Start reading'
|
2020-04-22 13:53:22 +00:00
|
|
|
if identifier == 'reading':
|
2020-02-21 23:39:25 +00:00
|
|
|
return 'I\'m done!'
|
|
|
|
return 'Want to read'
|
2020-02-22 00:03:05 +00:00
|
|
|
|
2020-02-23 22:26:03 +00:00
|
|
|
|
2020-04-15 12:06:23 +00:00
|
|
|
@register.simple_tag(takes_context=False)
|
|
|
|
def latest_read_through(book, user):
|
2020-09-21 17:25:26 +00:00
|
|
|
''' the most recent read activity '''
|
2020-04-15 12:06:23 +00:00
|
|
|
return models.ReadThrough.objects.filter(
|
|
|
|
user=user,
|
|
|
|
book=book).order_by('-created_date').first()
|