HTMLFormatter.py

#!/usr/bin/env python
#  -*- mode: python; indent-tabs-mode: nil; -*- coding: iso-8859-1 -*-

"""
HTMLFormatter.py

Copyright 2009-2014 by Marcello Perathoner

Distributable under the GNU General Public License Version 3 or newer.

Produce a HTML page.

"""

from __future__ import unicode_literals

import operator

import genshi.output
import re
import six

from libgutenberg.MediaTypes import mediatypes as mt

import BaseSearcher
import BaseFormatter

# filetypes ignored on desktop site
NO_DESKTOP_FILETYPES = {'plucker', 'qioo', 'rdf', 'rst', 'rst.gen', 'rst.master', 'tei',
    'cover.medium', 'cover.small', 'pageimages', 'kindle.noimages'}

# filetypes which are usually handed over to a separate app on mobile devices
HANDOVER_TYPES = (mt.epub, mt.mobi, mt.pdf)

# self-contained files we can send to dropbox
CLOUD_TYPES = (mt.epub, mt.mobi, mt.pdf)
STD_PDF_MATCH = re.compile(r'files/\d+/\d+-pdf.pdf$')

class XMLishFormatter(BaseFormatter.BaseFormatter):
    """ Produce XMLish output. """

    def __init__(self):
        super(XMLishFormatter, self).__init__()


    def fix_dc(self, dc, os):
        """ Tweak dc. """
        def has_std_path(file_obj):
            ''' so cloudstorage links can be elided when the url is non-standard'''
            if file_obj.filetype == 'pdf':
                return STD_PDF_MATCH.search(file_obj.url)
            return True

        super(XMLishFormatter, self).fix_dc(dc, os)

        dedupable = {}
        for file_ in dc.files:
            if file_.filetype and file_.filetype.endswith('images'):
                dedupable[file_.filetype] = file_
        do_dedupe = False
        for ft in ['epub', 'pdf', 'html']:
            if ft + '.images' in dedupable and ft + '.noimages' in dedupable:
                # because of timestamps, identical files may vary by a bit or 2
                if abs(dedupable[ft + '.images'].extent - dedupable[ft + '.noimages'].extent) < 3:
                    do_dedupe = True
        if do_dedupe:
            for ft in ['epub', 'pdf', 'html']:
                if ft + '.images' in dedupable and ft + '.noimages' in dedupable:
                    dc.files.remove(dedupable[ft + '.noimages'])

        for file_ in dc.files:
            type_ = six.text_type(file_.mediatypes[0])
            m = type_.partition(';')[0]
            if m in CLOUD_TYPES and has_std_path(file_):
                file_.dropbox_url = os.url(
                    'dropbox_send', id=dc.project_gutenberg_id, filetype=file_.filetype,
                    protocol='https')
                file_.gdrive_url = os.url(
                    'gdrive_send', id=dc.project_gutenberg_id, filetype=file_.filetype,
                    protocol='https')
                file_.msdrive_url = os.url(
                    'msdrive_send', id = dc.project_gutenberg_id, filetype=file_.filetype,
                    protocol='https')

            # these are used as relative links
            if file_.generated and not file_.filetype.startswith('cover.'):
                file_.filename = "ebooks/%d.%s" % (dc.project_gutenberg_id, file_.filetype)


    def format(self, page, os):
        """ Format to HTML. """

        for e in os.entries:
            if isinstance(e, BaseSearcher.DC):
                self.fix_dc(e, os)

        # loop again because fix:dc appends things
        for e in os.entries:
            if isinstance(e, BaseSearcher.Cat):
                if e.url:
                    e.icon2 = e.icon2 or 'next'
                else:
                    e.class_ += 'grayed'

        if os.title_icon:
            os.class_ += 'icon_' + os.title_icon

        os.entries.sort(key = operator.attrgetter('order'))

        return self.render(page, os)


class HTMLFormatter(XMLishFormatter):
    """ Produce HTML output. """

    CONTENT_TYPE = 'text/html; charset=UTF-8'
    DOCTYPE = 'html5'

    def __init__(self):
        super (HTMLFormatter, self).__init__()


    def get_serializer(self):
        return genshi.output.HTMLSerializer(doctype=self.DOCTYPE, strip_whitespace=False)


    def fix_dc(self, dc, os):
        """ Add some info to dc for easier templating.

        Also make sure that dc `walks like a cat´. """

        super(HTMLFormatter, self).fix_dc(dc, os)

        if dc.new_filesystem:
            dc.base_dir = "/files/%d/" % dc.project_gutenberg_id
        else:
            dc.base_dir = None

        dc.magnetlink = None

        # hide all txt files but the first one
        showncount = htmlcount = 0
        txt_file = None
        # this is the logic for whether or not to display a file
        for file_ in dc.files:
            filetype = file_.filetype or ''
            file_.hidden = False
            if filetype == 'txt.utf-8': # should be there for all books
                if txt_file != None:
                    # must be a filetype = 'txt', hide it
                    txt_file.hidden = True
                    showncount -= 1
                txt_file = file_
            elif file_.compression == 'zip':
                if file_.archive_path.startswith('cache/epub'):
                    file_.hr_filetype = 'Download HTML (zip)'
                    file_.mediatypes.append('application/zip')
                else:
                    file_.hidden = True
            elif filetype == 'html.images':
                if file_.compression == 'none':
                    if htmlcount > 0:
                        file_.hidden = True
                    else:
                        htmlcount += 1
            elif filetype in NO_DESKTOP_FILETYPES or filetype == '':
                # if no filetype is available, we shouldn't show it
                file_.hidden = True
            elif filetype == "txt": # rare
                # only show if no "txt.utf-8"
                if txt_file:
                    file_.hidden = True
                else:
                    txt_file = file_
            if not file_.hidden:
                showncount += 1

        # if we happened to hide everything, show all files
        if showncount == 0:
            for file_ in dc.files:
                file_.hidden = False