display.py

import datetime

from django.core.urlresolvers import reverse as urlreverse

from ietf.doc.models import DocAlias


class DisplayField(object):

    codename = ''
    description = ''
    rfcDescription = ''

    def get_value(self, document, raw=False):
        return None


class FilenameField(DisplayField):
    codename = 'filename'
    description = 'I-D filename'
    rfcDescription = 'RFC Number'

    def get_value(self, document, raw=False):
        if not raw:
            return '<a href="%s">%s</a>' % (document.get_absolute_url(), document.canonical_name())
        else:
            return document.canonical_name()


class TitleField(DisplayField):
    codename = 'title'
    description = 'I-D title'
    rfcDescription = 'RFC Title'

    def get_value(self, document, raw=False):
        return document.title


class DateField(DisplayField):
    codename = 'date'
    description = 'Date of current I-D'
    rfcDescription = 'Date of RFC'

    def get_value(self, document, raw=False):
        date = document.latest_event(type='new_revision')
        if date:
            return date.time.strftime('%Y-%m-%d')
        return document.time.strftime('%Y-%m-%d')


class StatusField(DisplayField):
    codename = 'status'
    description = 'Status in the IETF process'
    rfcDescription = description

    def get_value(self, document, raw=False):
        draft_state = document.get_state('draft')
        stream_state = document.get_state('draft-stream-%s' % (document.stream.slug)) if document.stream else None
        iesg_state = document.get_state('draft-iesg') or ''
        rfceditor_state = document.get_state('draft-rfceditor')
        if draft_state.slug == 'rfc':
            state = draft_state.name
        else:
            state = ""
            if stream_state:
                state = state + ("%s<br/>" % stream_state.name)
            if iesg_state:
                state = state + ("%s<br/>" % iesg_state.name)
            if rfceditor_state:
                state = state + ("%s<br/>" % rfceditor_state.name)
        #
        if draft_state.slug == 'rfc':
            tags = ""
        else:
            tags = [ tag.name for tag in document.tags.all() ]
            if tags:
                tags = '[%s]' % ",".join(tags)
            else:
                tags = ''
        return '%s<br/>%s' % (state, tags)

class WGField(DisplayField):
    codename = 'wg_rg'
    description = 'Associated WG or RG'
    rfcDescription = description

    def get_value(self, document, raw=False):
        if raw or not document.group.type_id in ['wg','rg']:
            return document.group.acronym
        else:
            return '<a href="%s">%s</a>' % (urlreverse('group_home', kwargs=dict(group_type=document.group.type_id, acronym=document.group.acronym)), document.group.acronym) if (document.group and document.group.acronym != 'none')  else ''


class ADField(DisplayField):
    codename = 'ad'
    description = 'Associated AD, if any'
    rfcDescription = description

    def get_value(self, document, raw=False):
        return document.ad or ''


class OneDayField(DisplayField):
    codename = '1_day'
    description = 'Changed within the last 1 day'
    rfcDescription = description

    def get_value(self, document, raw=False):
        now = datetime.datetime.now()
        last = now - datetime.timedelta(days=1)
        if document.docevent_set.filter(time__gte=last):
            return raw and 'YES' or '&#10004;'
        return ''


class TwoDaysField(DisplayField):
    codename = '2_days'
    description = 'Changed within the last 2 days'
    rfcDescription = description

    def get_value(self, document, raw=False):
        now = datetime.datetime.now()
        last = now - datetime.timedelta(days=2)
        if document.docevent_set.filter(time__gte=last):
            return raw and 'YES' or '&#10004;'
        return ''


class SevenDaysField(DisplayField):
    codename = '7_days'
    description = 'Changed within the last 7 days'
    rfcDescription = description

    def get_value(self, document, raw=False):
        now = datetime.datetime.now()
        last = now - datetime.timedelta(days=7)
        if document.docevent_set.filter(time__gte=last):
            return raw and 'YES' or '&#10004;'
        return ''


TYPES_OF_DISPLAY_FIELDS = [(i.codename, i.description) for i in DisplayField.__subclasses__()]


class SortMethod(object):
    codename = ''
    description = ''

    def get_sort_field(self):
        return 'pk'


class FilenameSort(SortMethod):
    codename = 'by_filename'
    description = 'Alphabetical by I-D filename and RFC number'

    def get_sort_field(self):
        return 'name'

    def get_full_rfc_sort(self, documents):
        return [i.document for i in DocAlias.objects.filter(document__in=documents, name__startswith='rfc').order_by('name')]


class TitleSort(SortMethod):
    codename = 'by_title'
    description = 'Alphabetical by document title'

    def get_sort_field(self):
        return 'title'


class WGSort(SortMethod):
    codename = 'by_wg'
    description = 'Alphabetical by associated WG'

    def get_sort_field(self):
        return 'group__name'


class PublicationSort(SortMethod):
    codename = 'date_publication'
    description = 'Date of publication of current version of the document'

    def get_sort_field(self):
        return '-documentchangedates__new_version_date'

class ChangeSort(SortMethod):
    codename = 'recent_change'
    description = 'Date of most recent change of status of any type'

    def get_sort_field(self):
        return '-documentchangedates__normal_change_date'


class SignificantSort(SortMethod):
    codename = 'recent_significant'
    description = 'Date of most recent significant change of status'

    def get_sort_field(self):
        return '-documentchangedates__significant_change_date'


TYPES_OF_SORT = [(i.codename, i.description) for i in SortMethod.__subclasses__()]