351 lines
11 KiB
Python
351 lines
11 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (C) 2004-2005 Tristan Seligmann and Jonathan Jacobs
|
|
# Copyright (C) 2012-2014 Bastian Kleineidam
|
|
# Copyright (C) 2015-2016 Tobias Gruetzmacher
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
import os
|
|
import time
|
|
from six.moves.urllib.parse import quote as url_quote
|
|
import codecs
|
|
import json
|
|
|
|
from . import rss, util, configuration
|
|
from .output import out
|
|
|
|
# Maximum width or height to display an image in exported pages.
|
|
# Note that only the displayed size is adjusted, not the image itself.
|
|
MaxImageSize = (800, 800)
|
|
|
|
|
|
class EventHandler(object):
|
|
"""Base class for writing events to files. The currently defined events are
|
|
start(), comicDownloaded() and end()."""
|
|
|
|
def __init__(self, basepath, baseurl, allowdownscale):
|
|
"""Initialize base path and url."""
|
|
self.basepath = basepath
|
|
self.baseurl = baseurl or self.getBaseUrl()
|
|
self.allowdownscale = allowdownscale
|
|
|
|
def getBaseUrl(self):
|
|
'''Return a file: URL that probably points to the basedir.
|
|
|
|
This is used as a halfway sane default when the base URL is not
|
|
provided; not perfect, but should work in most cases.'''
|
|
components = util.splitpath(os.path.abspath(self.basepath))
|
|
url = '/'.join([url_quote(component, '') for component in components])
|
|
return 'file:///' + url + '/'
|
|
|
|
def getUrlFromFilename(self, filename):
|
|
"""Construct URL from filename."""
|
|
components = util.splitpath(util.getRelativePath(self.basepath, filename))
|
|
url = '/'.join([url_quote(component, '') for component in components])
|
|
return self.baseurl + url
|
|
|
|
def start(self):
|
|
"""Emit a start event. Should be overridden in subclass."""
|
|
pass
|
|
|
|
def comicDownloaded(self, comic, filename, text=None):
|
|
"""Emit a comic downloaded event. Should be overridden in subclass."""
|
|
pass
|
|
|
|
def comicPageLink(self, comic, url, prevUrl):
|
|
"""Emit an event to inform the handler about links between comic pages. Should be overridden in subclass."""
|
|
pass
|
|
|
|
def end(self):
|
|
"""Emit an end event. Should be overridden in subclass."""
|
|
pass
|
|
|
|
|
|
class RSSEventHandler(EventHandler):
|
|
"""Output in RSS format."""
|
|
|
|
name = 'rss'
|
|
|
|
def getFilename(self):
|
|
"""Return RSS filename."""
|
|
return os.path.abspath(os.path.join(self.basepath, 'dailydose.rss'))
|
|
|
|
def start(self):
|
|
"""Log start event."""
|
|
today = time.time()
|
|
yesterday = today - 86400
|
|
today = time.localtime(today)
|
|
yesterday = time.localtime(yesterday)
|
|
|
|
link = configuration.Url
|
|
|
|
self.rssfn = self.getFilename()
|
|
|
|
if os.path.exists(self.rssfn):
|
|
self.newfile = False
|
|
self.rss = rss.parseFeed(self.rssfn, yesterday)
|
|
else:
|
|
self.newfile = True
|
|
self.rss = rss.Feed('Daily Dosage', link, 'Comics for %s' % time.strftime('%Y/%m/%d', today))
|
|
|
|
def comicDownloaded(self, comic, filename, text=None):
|
|
"""Write RSS entry for downloaded comic."""
|
|
imageUrl = self.getUrlFromFilename(filename)
|
|
size = None
|
|
if self.allowdownscale:
|
|
size = getDimensionForImage(filename, MaxImageSize)
|
|
title = '%s - %s' % (comic.name, os.path.basename(filename))
|
|
pageUrl = comic.referrer
|
|
description = '<img src="%s"' % imageUrl
|
|
if size:
|
|
description += ' width="%d" height="%d"' % size
|
|
description += '/>'
|
|
if text:
|
|
description += '<br/>%s' % text
|
|
description += '<br/><a href="%s">View Comic Online</a>' % pageUrl
|
|
args = (
|
|
title,
|
|
imageUrl,
|
|
description,
|
|
util.rfc822date(time.time())
|
|
)
|
|
|
|
if self.newfile:
|
|
self.newfile = False
|
|
self.rss.addItem(*args)
|
|
else:
|
|
self.rss.addItem(*args, append=False)
|
|
|
|
def end(self):
|
|
"""Write RSS data to file."""
|
|
self.rss.write(self.rssfn)
|
|
|
|
|
|
def getDimensionForImage(filename, maxsize):
|
|
"""Return scaled image size in (width, height) format.
|
|
The scaling preserves the aspect ratio.
|
|
If PIL is not found returns None."""
|
|
try:
|
|
from PIL import Image
|
|
except ImportError:
|
|
return None
|
|
img = Image.open(filename)
|
|
width, height = img.size
|
|
if width > maxsize[0] or height > maxsize[1]:
|
|
img.thumbnail(maxsize)
|
|
out.info("Downscaled display size from %s to %s" % ((width, height), img.size))
|
|
return img.size
|
|
|
|
|
|
class HtmlEventHandler(EventHandler):
|
|
"""Output in HTML format."""
|
|
|
|
name = 'html'
|
|
encoding = 'utf-8'
|
|
|
|
def fnFromDate(self, date):
|
|
"""Get filename from date."""
|
|
fn = time.strftime('comics-%Y%m%d', date)
|
|
fn = os.path.join(self.basepath, 'html', fn + ".html")
|
|
fn = os.path.abspath(fn)
|
|
return fn
|
|
|
|
def addNavLinks(self):
|
|
if self.yesterdayUrl:
|
|
self.html.write(u'<a href="%s">Previous Day</a> | ' % self.yesterdayUrl)
|
|
self.html.write(u'<a href="%s">Next Day</a>\n' % self.tomorrowUrl)
|
|
|
|
def start(self):
|
|
"""Start HTML output."""
|
|
today = time.time()
|
|
yesterday = today - 86400
|
|
tomorrow = today + 86400
|
|
today = time.localtime(today)
|
|
yesterday = time.localtime(yesterday)
|
|
tomorrow = time.localtime(tomorrow)
|
|
|
|
fn = self.fnFromDate(today)
|
|
if os.path.exists(fn):
|
|
out.warn('HTML output file %r already exists' % fn)
|
|
out.warn('the page link of previous run will skip this file')
|
|
out.warn('try to generate HTML output only once per day')
|
|
fn = util.getNonexistingFile(fn)
|
|
|
|
d = os.path.dirname(fn)
|
|
if not os.path.isdir(d):
|
|
os.makedirs(d)
|
|
|
|
try:
|
|
fn_yesterday = self.fnFromDate(yesterday)
|
|
fn_yesterday = util.getExistingFile(fn_yesterday)
|
|
self.yesterdayUrl = self.getUrlFromFilename(fn_yesterday)
|
|
except ValueError:
|
|
self.yesterdayUrl = None
|
|
self.tomorrowUrl = self.getUrlFromFilename(self.fnFromDate(tomorrow))
|
|
|
|
self.html = codecs.open(fn, 'w', self.encoding)
|
|
self.html.write(u'''<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=%s"/>
|
|
<meta name="generator" content="%s"/>
|
|
<title>Comics for %s</title>
|
|
</head>
|
|
<body>
|
|
''' % (self.encoding, configuration.App, time.strftime('%Y/%m/%d', today)))
|
|
self.addNavLinks()
|
|
self.html.write(u'<ul>\n')
|
|
# last comic name (eg. CalvinAndHobbes)
|
|
self.lastComic = None
|
|
# last comic strip URL (eg. http://example.com/page42)
|
|
self.lastUrl = None
|
|
|
|
def comicDownloaded(self, comic, filename, text=None):
|
|
"""Write HTML entry for downloaded comic."""
|
|
if self.lastComic != comic.name:
|
|
self.newComic(comic)
|
|
size = None
|
|
if self.allowdownscale:
|
|
size = getDimensionForImage(filename, MaxImageSize)
|
|
imageUrl = self.getUrlFromFilename(filename)
|
|
pageUrl = comic.referrer
|
|
if pageUrl != self.lastUrl:
|
|
self.html.write(u'<li><a href="%s">%s</a>\n' % (pageUrl, pageUrl))
|
|
self.html.write(u'<br/><img src="%s"' % imageUrl)
|
|
if size:
|
|
self.html.write(' width="%d" height="%d"' % size)
|
|
self.html.write('/>\n')
|
|
if text:
|
|
self.html.write(u'<br/>%s\n' % text)
|
|
self.lastComic = comic.name
|
|
self.lastUrl = pageUrl
|
|
|
|
def newComic(self, comic):
|
|
"""Start new comic list in HTML."""
|
|
if self.lastUrl is not None:
|
|
self.html.write(u'</li>\n')
|
|
if self.lastComic is not None:
|
|
self.html.write(u'</ul>\n')
|
|
self.html.write(u'<li>%s</li>\n' % comic.name)
|
|
self.html.write(u'<ul>\n')
|
|
|
|
def end(self):
|
|
"""End HTML output."""
|
|
if self.lastUrl is not None:
|
|
self.html.write(u'</li>\n')
|
|
if self.lastComic is not None:
|
|
self.html.write(u'</ul>\n')
|
|
self.html.write(u'</ul>\n')
|
|
self.addNavLinks()
|
|
self.html.close()
|
|
|
|
|
|
class JSONEventHandler(EventHandler):
|
|
"""Output metadata for comics in JSON format."""
|
|
|
|
name = 'json'
|
|
encoding = 'utf-8'
|
|
|
|
def start(self):
|
|
"""Start with empty data."""
|
|
self.data = {}
|
|
|
|
def jsonFn(self, comic):
|
|
"""Get filename for the JSON file for a comic."""
|
|
fn = os.path.join(self.basepath, comic, 'dosage.json')
|
|
fn = os.path.abspath(fn)
|
|
return fn
|
|
|
|
def getComicData(self, comic):
|
|
"""Return dictionary with comic info."""
|
|
if comic not in self.data:
|
|
if os.path.exists(self.jsonFn(comic)):
|
|
with codecs.open(self.jsonFn(comic), 'r', self.encoding) as f:
|
|
self.data[comic] = json.load(f)
|
|
else:
|
|
self.data[comic] = {'pages': {}}
|
|
return self.data[comic]
|
|
|
|
def getPageInfo(self, comic, url):
|
|
"""Return dictionary with comic page info."""
|
|
comicData = self.getComicData(comic)
|
|
if url not in comicData['pages']:
|
|
comicData['pages'][url] = {'images': {}}
|
|
return comicData['pages'][url]
|
|
|
|
def comicDownloaded(self, comic, filename, text=None):
|
|
"""Add URL-to-filename mapping into JSON."""
|
|
pageInfo = self.getPageInfo(comic.name, comic.referrer)
|
|
pageInfo['images'][comic.url] = os.path.basename(filename)
|
|
|
|
def comicPageLink(self, comic, url, prevUrl):
|
|
"""Write previous link into JSON."""
|
|
pageInfo = self.getPageInfo(comic, url)
|
|
pageInfo['prev'] = prevUrl
|
|
|
|
def end(self):
|
|
"""Write all JSON data to files."""
|
|
for comic in self.data:
|
|
with codecs.open(self.jsonFn(comic), 'w', self.encoding) as f:
|
|
json.dump(self.data[comic], f, indent=2, separators=(',', ': '), sort_keys=True)
|
|
|
|
|
|
_handler_classes = {}
|
|
|
|
|
|
def addHandlerClass(clazz):
|
|
"""Register handler class."""
|
|
if not issubclass(clazz, EventHandler):
|
|
raise ValueError("%s must be subclassed from %s" % (clazz, EventHandler))
|
|
_handler_classes[clazz.name] = clazz
|
|
|
|
addHandlerClass(HtmlEventHandler)
|
|
addHandlerClass(RSSEventHandler)
|
|
addHandlerClass(JSONEventHandler)
|
|
|
|
|
|
def getHandlerNames():
|
|
"""Get sorted handler names."""
|
|
return sorted(_handler_classes.keys())
|
|
|
|
|
|
_handlers = []
|
|
|
|
|
|
def addHandler(name, basepath=None, baseurl=None, allowDownscale=False):
|
|
"""Add an event handler with given name."""
|
|
if basepath is None:
|
|
basepath = '.'
|
|
_handlers.append(_handler_classes[name](basepath, baseurl, allowDownscale))
|
|
|
|
|
|
class MultiHandler(object):
|
|
"""Encapsulate a list of handlers."""
|
|
|
|
def start(self):
|
|
"""Emit start events for handlers."""
|
|
for handler in _handlers:
|
|
handler.start()
|
|
|
|
def comicDownloaded(self, comic, filename, text=None):
|
|
"""Emit comic downloaded events for handlers."""
|
|
for handler in _handlers:
|
|
handler.comicDownloaded(comic, filename, text=text)
|
|
|
|
def comicPageLink(self, comic, url, prevUrl):
|
|
"""Emit an event to inform the handler about links between comic pages. Should be overridden in subclass."""
|
|
for handler in _handlers:
|
|
handler.comicPageLink(comic, url, prevUrl)
|
|
|
|
def end(self):
|
|
"""Emit end events for handlers."""
|
|
for handler in _handlers:
|
|
handler.end()
|
|
|
|
|
|
multihandler = MultiHandler()
|
|
|
|
|
|
def getHandler():
|
|
"""Get installed event handler."""
|
|
return multihandler
|