generator_en.py

#! /usr/bin/python
# -*- coding: utf-8 -*-

"""Codes required to create English Wikipedia citation templates."""


from datetime import date
import re


def sfn_template(d):
    """Creates citation based on the given dictionary."""
    s = '{{sfn'
    if 'authors' in d:
        c = 0
        for name in d['authors']:
            c += 1
            if c < 5:  # {{sfn}} only supports a maximum of four authors
                s += '|' + name.lastname
    else:
        # the same order should be used in citation_template:
        s += '|' + (d['publisher'] if 'publisher' in d else
                    "''" + d['journal'] + "''" if 'journal' in d else
                    "''" + d['website'] + "''" if 'website' in d else
                    d['title'] if 'title' in d else
                    'Anon.')
    if 'year' in d:
        s += '|' + d['year']
    if 'pages' in d:
        if '–' in d['pages']:
            s += '|pp=' + d['pages']
        else:
            s += '|p=' + d['pages']
    elif 'url' not in d:
        s += '|p='
    s += '}}'
    return s   

    
def citation_template(d, date_format):
    """Create citation based on the given dictionary."""
    if d['type'] == 'book':
        s = '* {{cite book'
    elif d['type'] in ['article', 'jour']:
        s = '* {{cite journal'
    elif d['type'] == 'web':
        s = '* {{cite web'
    else:
        raise KeyError(d['type'] + " is not a valid value for d['type']")

    if 'authors' in d:
        s += names2para(d['authors'],
                        'first',
                        'last',
                        'author')
    if 'editors' in d:
        s += names2para(d['editors'],
                        'editor-first',
                        'editor-last',
                        'editor')
    if 'translators' in d:
        for translator in d['translators']:
            translator.fullname += ' (مترجم)'
        # todo: add a 'Translated by ' before name of translators
        if 'others' in d:
            d['others'].extend(d['translators'])
        else:
            d['others'] = d['translators']
    if 'others' in d:
        s += names1para(d['others'], 'others')
    if 'title' in d:
        s += '|title=' + d['title']
    if 'journal' in d:
        s += '|journal=' + d['journal']
    elif 'website' in d:
        s += '|website=' + d['website']
    if 'publisher' in d:
        s += '|publisher=' + d['publisher']
    if 'address' in d:
        s += '|location=' + d['address']
    if 'series' in d:
        s += '|series=' + d['series']
    if 'volume' in d:
        s += '|volume=' + d['volume']
    if 'issue' in d:
        s += '|issue=' + d['issue']
    if 'date' in d:
        if isinstance(d['date'], date):
            s += '|date=' + d['date'].strftime(date_format)
        else:
            s += '|date=' + d['date']
    if 'year' in d:
        s += '|year=' + d['year']
    if 'isbn' in d:
        s += '|isbn=' + d['isbn']
    if 'issn' in d:
        s += '|issn=' + d['issn']
    if 'pmid' in d:
        s += '|pmid=' + d['pmid']
    if d['type'] in ['article', 'jour']:
        if 'pages' in d:
            if '–' in d['pages']:
                s += '|pages=' + d['pages']
            else:
                s += '|page=' + d['pages']
    if 'url' in d:
        s += '|url=' + d['url']
    if 'doi' in d:
        s += '|doi=' + d['doi']
    if 'language' in d:
        if d['language'].lower() not in ['english', 'en']:
            s += '|language=' + d['language']
    if 'authors' in d:
        s += '|ref=harv'
    else:
        # order should match sfn_template
        s += '|ref={{sfnref|' +\
             (
                 d['publisher'] if 'publisher' in d else
                 d['journal'] if 'journal' in d else
                 d['website'] if 'website' in d else
                 d['title'] if 'title' in d else
                 'Anon.'
             )
        if 'year' in d:
            s += '|' + d['year']
        s += '}}'
    if 'url' in d:
        s += '|accessdate=' + date.strftime(date.today(), date_format)
    s += '}}'
    return s


def reference_tag(dictionary, sfn_template, citation_template):
    """Create named <ref> tag."""
    name = sfn_template[6:-2].replace('|', ' ').replace("'", '')
    text = re.sub('(\|ref=({{.*?}}|harv))(?P<repl>\||}})',
                  '\g<repl>',
                  citation_template[2:])
    if ' p=' in name  and '|page=' not in text:
        name = name.replace(' p=', ' p. ')
        if 'pages' in dictionary:
            text = text[:-2] + '|page=' + dictionary['pages'] + '}}'
        else:
            text = text[:-2] + '|page=}}'
    elif ' pp=' in name:
        name = name.replace(' pp=', ' pp. ')
        if 'pages' in dictionary and '|pages=' not in text:
            text = text[:-2] + '|pages=' + dictionary['pages'] + '}}'
    return  '<ref name="' + name + '">' + text + '</ref>'


def names2para(names, fn_parameter, ln_parameter, nofn_parameter=None):
    """Take list of names. Return the string to be appended to citation."""
    c = 0
    s = ''
    for name in names:
        c += 1
        if c == 1:
            if name.firstname or not nofn_parameter:
                s += '|' + ln_parameter + '=' + name.lastname
                s += '|' + fn_parameter + '=' + name.firstname
            else:
                s += '|' + nofn_parameter + '=' + name.fullname
        else:
            if name.firstname or not nofn_parameter:
                s += '|' + ln_parameter + str(c) + '=' + name.lastname
                s += '|' + fn_parameter + str(c) + '=' + name.firstname
            else:
                s += '|' + nofn_parameter + str(c) + '=' + name.fullname
    return s


def names1para(translators, para):
    """Take list of names. Return the string to be appended to citation."""
    s = '|' + para + '='
    c = 0
    for name in translators:
        c += 1
        if c == 1:
            s += name.fullname
        elif c == len(translators):
            s += ', and ' + name.fullname
        else:
            s += ', ' + name.fullname
    return s