path: root/objectapp/templatetags/objectapp_tags.py

# Copyright (c) 2011,  2012 Free Software Foundation

#     This program is free software: you can redistribute it and/or modify
#     it under the terms of the GNU Affero General Public License as
#     published by the Free Software Foundation, either version 3 of the
#     License, or (at your option) any later version.

#     This program is distributed in the hope that it will be useful,
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#     GNU Affero General Public License for more details.

#     You should have received a copy of the GNU Affero General Public License
#     along with this program.  If not, see <http://www.gnu.org/licenses/>.


# This project incorporates work covered by the following copyright and permission notice:  

#    Copyright (c) 2009, Julien Fache
#    All rights reserved.

#    Redistribution and use in source and binary forms, with or without
#    modification, are permitted provided that the following conditions
#    are met:

#    * Redistributions of source code must retain the above copyright
#      notice, this list of conditions and the following disclaimer.
#    * Redistributions in binary form must reproduce the above copyright
#      notice, this list of conditions and the following disclaimer in
#      the documentation and/or other materials provided with the
#      distribution.
#    * Neither the name of the author nor the names of other
#      contributors may be used to endorse or promote products derived
#      from this software without specific prior written permission.

#    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
#    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
#    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
#    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
#    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
#    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
#    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
#    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
#    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
#    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
#    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
#    OF THE POSSIBILITY OF SUCH DAMAGE.
"""Template tags and filters for Objectapp"""
from hashlib import md5
from random import sample
from urllib import urlencode
from datetime import datetime

from django.db.models import Q
from django.db import connection
from django.template import Node
from django.template import Library
from django.template import TemplateSyntaxError
from django.contrib.comments.models import CommentFlag
from django.contrib.contenttypes.models import ContentType
from django.utils.encoding import smart_unicode
from django.contrib.comments import get_model as get_comment_model

from tagging.models import Tag
from tagging.utils import calculate_cloud

from gstudio.gnowql import get_node

from objectapp.models import Gbobject
from objectapp.models import Author
from objectapp.models import Objecttype
from objectapp.managers import tags_published
from objectapp.comparison import VectorBuilder
from objectapp.comparison import pearson_score
from objectapp.templatetags.zcalendar import ObjectappCalendar
from objectapp.templatetags.zbreadcrumbs import retrieve_breadcrumbs

register = Library()

VECTORS = None
VECTORS_FACTORY = lambda: VectorBuilder(Gbobject.published.all(),
                                        ['title', 'excerpt', 'content'])
CACHE_GBOBJECTS_RELATED = {}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_objecttypes(template='objectapp/tags/objecttypes.html'):
    """Return the objecttypes"""
    return {'template': template,
            'objecttypes': Objecttype.tree.all()}

@register.simple_tag
def get_this_nodes_uri(name):
    obj =  get_node(name)
    return obj.get_absolute_url()


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_authors(template='objectapp/tags/authors.html'):
    """Return the published authors"""
    return {'template': template,
            'authors': Author.published.all()}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_recent_gbobjects(number=5, template='objectapp/tags/recent_gbobjects.html'):
    """Return the most recent gbobjects"""
    return {'template': template,
            'gbobjects': Gbobject.published.all()[:number]}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_featured_gbobjects(number=5,
                         template='objectapp/tags/featured_gbobjects.html'):
    """Return the featured gbobjects"""
    return {'template': template,
            'gbobjects': Gbobject.published.filter(featured=True)[:number]}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_random_gbobjects(number=5, template='objectapp/tags/random_gbobjects.html'):
    """Return random gbobjects"""
    gbobjects = Gbobject.published.all()
    if number > len(gbobjects):
        number = len(gbobjects)
    return {'template': template,
            'gbobjects': sample(gbobjects, number)}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_popular_gbobjects(number=5, template='objectapp/tags/popular_gbobjects.html'):
    """Return popular  gbobjects"""
    ctype = ContentType.objects.get_for_model(Gbobject)
    query = """SELECT object_pk, COUNT(*) AS score
    FROM %s
    WHERE content_type_id = %%s
    AND is_public = '1'
    GROUP BY object_pk
    ORDER BY score DESC""" % get_comment_model()._meta.db_table

    cursor = connection.cursor()
    cursor.execute(query, [ctype.id])
    object_ids = [int(row[0]) for row in cursor.fetchall()]

    # Use ``in_bulk`` here instead of an ``id__in`` filter, because ``id__in``
    # would clobber the ordering.
    object_dict = Gbobject.published.in_bulk(object_ids)

    return {'template': template,
            'gbobjects': [object_dict[object_id]
                        for object_id in object_ids
                        if object_id in object_dict][:number]}


@register.inclusion_tag('objectapp/tags/dummy.html', takes_context=True)
def get_similar_gbobjects(context, number=5,
                        template='objectapp/tags/similar_gbobjects.html',
                        flush=False):
    """Return similar gbobjects"""
    global VECTORS
    global CACHE_GBOBJECTS_RELATED

    if VECTORS is None or flush:
        VECTORS = VECTORS_FACTORY()
        CACHE_GBOBJECTS_RELATED = {}

    def compute_related(object_id, dataset):
        """Compute related gbobjects to an gbobject with a dataset"""
        object_vector = None
        for gbobject, e_vector in dataset.items():
            if gbobject.pk == object_id:
                object_vector = e_vector

        if not object_vector:
            return []

        gbobject_related = {}
        for gbobject, e_vector in dataset.items():
            if gbobject.pk != object_id:
                score = pearson_score(object_vector, e_vector)
                if score:
                    gbobject_related[gbobject] = score

        related = sorted(gbobject_related.items(), key=lambda(k, v): (v, k))
        return [rel[0] for rel in related]

    object_id = context['object'].pk
    columns, dataset = VECTORS()
    key = '%s-%s' % (object_id, VECTORS.key)
    if not key in CACHE_GBOBJECTS_RELATED.keys():
        CACHE_GBOBJECTS_RELATED[key] = compute_related(object_id, dataset)

    gbobjects = CACHE_GBOBJECTS_RELATED[key][:number]
    return {'template': template,
            'gbobjects': gbobjects}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_archives_gbobjects(template='objectapp/tags/archives_gbobjects.html'):
    """Return archives gbobjects"""
    return {'template': template,
            'archives': Gbobject.published.dates('creation_date', 'month',
                                              order='DESC')}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_archives_gbobjects_tree(
    template='objectapp/tags/archives_gbobjects_tree.html'):
    """Return archives gbobjects as a Tree"""
    return {'template': template,
            'archives': Gbobject.published.dates('creation_date', 'day',
                                              order='ASC')}


@register.inclusion_tag('objectapp/tags/dummy.html', takes_context=True)
def get_calendar_gbobjects(context, year=None, month=None,
                         template='objectapp/tags/calendar.html'):
    """Return an HTML calendar of gbobjects"""
    if not year or not month:
        date_month = context.get('month') or context.get('day') or \
                     getattr(context.get('object'), 'creation_date', None) or \
                     datetime.today()
        year, month = date_month.timetuple()[:2]

    calendar = ObjectappCalendar()
    current_month = datetime(year, month, 1)

    dates = list(Gbobject.published.dates('creation_date', 'month'))

    if not current_month in dates:
        dates.append(current_month)
        dates.sort()
    index = dates.index(current_month)

    previous_month = index > 0 and dates[index - 1] or None
    next_month = index != len(dates) - 1 and dates[index + 1] or None

    return {'template': template,
            'next_month': next_month,
            'previous_month': previous_month,
            'calendar': calendar.formatmonth(year, month)}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_recent_comments(number=5, template='objectapp/tags/recent_comments.html'):
    """Return the most recent comments"""
    # Using map(smart_unicode... fix bug related to issue #8554
    gbobject_published_pks = map(smart_unicode,
                              Gbobject.published.values_list('id', flat=True))
    content_type = ContentType.objects.get_for_model(Gbobject)

    comments = get_comment_model().objects.filter(
        Q(flags=None) | Q(flags__flag=CommentFlag.MODERATOR_APPROVAL),
        content_type=content_type, object_pk__in=gbobject_published_pks,
        is_public=True).order_by('-submit_date')[:number]

    return {'template': template,
            'comments': comments}


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_recent_linkbacks(number=5,
                         template='objectapp/tags/recent_linkbacks.html'):
    """Return the most recent linkbacks"""
    gbobject_published_pks = map(smart_unicode,
                              Gbobject.published.values_list('id', flat=True))
    content_type = ContentType.objects.get_for_model(Gbobject)

    linkbacks = get_comment_model().objects.filter(
        content_type=content_type,
        object_pk__in=gbobject_published_pks,
        flags__flag__in=['pingback', 'trackback'],
        is_public=True).order_by(
        '-submit_date')[:number]

    return {'template': template,
            'linkbacks': linkbacks}


@register.inclusion_tag('objectapp/tags/dummy.html', takes_context=True)
def objectapp_pagination(context, page, begin_pages=3, end_pages=3,
                      before_pages=2, after_pages=2,
                      template='objectapp/tags/pagination.html'):
    """Return a Digg-like pagination, by splitting long list of page
    into 3 blocks of pages"""
    GET_string = ''
    for key, value in context['request'].GET.items():
        if key != 'page':
            GET_string += '&%s=%s' % (key, value)

    begin = page.paginator.page_range[:begin_pages]
    end = page.paginator.page_range[-end_pages:]
    middle = page.paginator.page_range[max(page.number - before_pages - 1, 0):
                                       page.number + after_pages]

    if set(begin) & set(end):  # [1, 2, 3], [...], [2, 3, 4]
        begin = sorted(set(begin + end))  # [1, 2, 3, 4]
        middle, end = [], []
    elif begin[-1] + 1 == end[0]:  # [1, 2, 3], [...], [4, 5, 6]
        begin += end  # [1, 2, 3, 4, 5, 6]
        middle, end = [], []
    elif set(begin) & set(middle):  # [1, 2, 3], [2, 3, 4], [...]
        begin = sorted(set(begin + middle))  # [1, 2, 3, 4]
        middle = []
    elif begin[-1] + 1 == middle[0]:  # [1, 2, 3], [4, 5, 6], [...]
        begin += middle  # [1, 2, 3, 4, 5, 6]
        middle = []
    elif middle[-1] + 1 == end[0]:  # [...], [15, 16, 17], [18, 19, 20]
        end = middle + end  # [15, 16, 17, 18, 19, 20]
        middle = []
    elif set(middle) & set(end):  # [...], [17, 18, 19], [18, 19, 20]
        end = sorted(set(middle + end))  # [17, 18, 19, 20]
        middle = []

    return {'template': template, 'page': page, 'GET_string': GET_string,
            'begin': begin, 'middle': middle, 'end': end}


@register.inclusion_tag('objectapp/tags/dummy.html', takes_context=True)
def objectapp_breadcrumbs(context, separator='/', root_name='Objects',
                       template='objectapp/tags/breadcrumbs.html',):
    """Return a breadcrumb for the application"""
    path = context['request'].path
    page_object = context.get('object') or context.get('Objecttype') or \
                  context.get('tag') or context.get('author')
    breadcrumbs = retrieve_breadcrumbs(path, page_object, root_name)

    return {'template': template,
            'separator': separator,
            'breadcrumbs': breadcrumbs}


@register.simple_tag
def get_gravatar(email, size=80, rating='g', default=None):
    """Return url for a Gravatar"""
    url = 'http://www.gravatar.com/avatar/%s.jpg' % \
          md5(email.strip().lower()).hexdigest()
    options = {'s': size, 'r': rating}
    if default:
        options['d'] = default

    url = '%s?%s' % (url, urlencode(options))
    return url.replace('&', '&amp;')


class TagsNode(Node):
    def __init__(self, context_var):
        self.context_var = context_var

    def render(self, context):
        context[self.context_var] = tags_published()
        return ''


@register.tag
def get_tags(parser, token):
    """{% get_tags as var %}"""
    bits = token.split_contents()

    if len(bits) != 3:
        raise TemplateSyntaxError(
            'get_tags tag takes exactly two arguments')
    if bits[1] != 'as':
        raise TemplateSyntaxError(
            "first argument to get_tags tag must be 'as'")
    return TagsNode(bits[2])


@register.inclusion_tag('objectapp/tags/dummy.html')
def get_tag_cloud(steps=6, template='objectapp/tags/tag_cloud.html'):
    """Return a cloud of published tags"""
    tags = Tag.objects.usage_for_queryset(
        Gbobject.published.all(), counts=True)
    return {'template': template,
            'tags': calculate_cloud(tags, steps)}