forked from github/pelican
c462237b9d
This setting allow to use template which are not in the theme. Should help to build more generic themes around the content.
542 lines
21 KiB
Python
542 lines
21 KiB
Python
# -*- coding: utf-8 -*-
|
|
import os
|
|
import math
|
|
import random
|
|
import logging
|
|
import datetime
|
|
import subprocess
|
|
|
|
from collections import defaultdict
|
|
from functools import partial
|
|
from itertools import chain
|
|
from operator import attrgetter, itemgetter
|
|
|
|
from jinja2 import Environment, FileSystemLoader, PrefixLoader, ChoiceLoader
|
|
from jinja2.exceptions import TemplateNotFound
|
|
|
|
from pelican.contents import Article, Page, Category, is_valid_content
|
|
from pelican.readers import read_file
|
|
from pelican.utils import copy, process_translations, open
|
|
from pelican import signals
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Generator(object):
|
|
"""Baseclass generator"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
for idx, item in enumerate(('context', 'settings', 'path', 'theme',
|
|
'output_path', 'markup')):
|
|
setattr(self, item, args[idx])
|
|
|
|
for arg, value in kwargs.items():
|
|
setattr(self, arg, value)
|
|
|
|
# templates cache
|
|
self._templates = {}
|
|
self._templates_path = []
|
|
self._templates_path.append(os.path.expanduser(
|
|
os.path.join(self.theme, 'templates')))
|
|
self._templates_path += self.settings.get('EXTRA_TEMPLATES_PATHS', [])
|
|
|
|
|
|
theme_path = os.path.dirname(os.path.abspath(__file__))
|
|
|
|
simple_loader = FileSystemLoader(os.path.join(theme_path,
|
|
"themes", "simple", "templates"))
|
|
self.env = Environment(
|
|
loader=ChoiceLoader([
|
|
FileSystemLoader(self._templates_path),
|
|
simple_loader, # implicit inheritance
|
|
PrefixLoader({'!simple': simple_loader}) # explicit one
|
|
]),
|
|
extensions=self.settings.get('JINJA_EXTENSIONS', []),
|
|
)
|
|
|
|
logger.debug('template list: {0}'.format(self.env.list_templates()))
|
|
|
|
# get custom Jinja filters from user settings
|
|
custom_filters = self.settings.get('JINJA_FILTERS', {})
|
|
self.env.filters.update(custom_filters)
|
|
|
|
def get_template(self, name):
|
|
"""Return the template by name.
|
|
Use self.theme to get the templates to use, and return a list of
|
|
templates ready to use with Jinja2.
|
|
"""
|
|
if name not in self._templates:
|
|
try:
|
|
self._templates[name] = self.env.get_template(name + '.html')
|
|
except TemplateNotFound:
|
|
raise Exception('[templates] unable to load %s.html from %s' \
|
|
% (name, self._templates_path))
|
|
return self._templates[name]
|
|
|
|
def get_files(self, path, exclude=[], extensions=None):
|
|
"""Return a list of files to use, based on rules
|
|
|
|
:param path: the path to search the file on
|
|
:param exclude: the list of path to exclude
|
|
"""
|
|
if not extensions:
|
|
extensions = self.markup
|
|
|
|
files = []
|
|
|
|
try:
|
|
iter = os.walk(path, followlinks=True)
|
|
except TypeError: # python 2.5 does not support followlinks
|
|
iter = os.walk(path)
|
|
|
|
for root, dirs, temp_files in iter:
|
|
for e in exclude:
|
|
if e in dirs:
|
|
dirs.remove(e)
|
|
files.extend([os.sep.join((root, f)) for f in temp_files
|
|
if True in [f.endswith(ext) for ext in extensions]])
|
|
return files
|
|
|
|
def _update_context(self, items):
|
|
"""Update the context with the given items from the currrent
|
|
processor.
|
|
"""
|
|
for item in items:
|
|
value = getattr(self, item)
|
|
if hasattr(value, 'items'):
|
|
value = value.items()
|
|
self.context[item] = value
|
|
|
|
|
|
class ArticlesGenerator(Generator):
|
|
"""Generate blog articles"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
"""initialize properties"""
|
|
self.articles = [] # only articles in default language
|
|
self.translations = []
|
|
self.dates = {}
|
|
self.tags = defaultdict(list)
|
|
self.categories = defaultdict(list)
|
|
self.related_posts = []
|
|
self.authors = defaultdict(list)
|
|
super(ArticlesGenerator, self).__init__(*args, **kwargs)
|
|
self.drafts = []
|
|
signals.article_generator_init.send(self)
|
|
|
|
def generate_feeds(self, writer):
|
|
"""Generate the feeds from the current context, and output files."""
|
|
if self.settings.get('FEED_ATOM') is None and self.settings.get('FEED_RSS') is None:
|
|
return
|
|
elif self.settings.get('SITEURL') is '':
|
|
logger.warning(
|
|
'Feeds generated without SITEURL set properly may not be valid'
|
|
)
|
|
|
|
if self.settings.get('FEED_ATOM'):
|
|
writer.write_feed(self.articles, self.context,
|
|
self.settings['FEED_ATOM'])
|
|
|
|
if self.settings.get('FEED_RSS'):
|
|
writer.write_feed(self.articles, self.context,
|
|
self.settings['FEED_RSS'], feed_type='rss')
|
|
|
|
for cat, arts in self.categories:
|
|
arts.sort(key=attrgetter('date'), reverse=True)
|
|
if self.settings.get('CATEGORY_FEED_ATOM'):
|
|
writer.write_feed(arts, self.context,
|
|
self.settings['CATEGORY_FEED_ATOM'] % cat)
|
|
|
|
if self.settings.get('CATEGORY_FEED_RSS'):
|
|
writer.write_feed(arts, self.context,
|
|
self.settings['CATEGORY_FEED_RSS'] % cat,
|
|
feed_type='rss')
|
|
|
|
if self.settings.get('TAG_FEED_ATOM') or self.settings.get('TAG_FEED_RSS'):
|
|
for tag, arts in self.tags.items():
|
|
arts.sort(key=attrgetter('date'), reverse=True)
|
|
if self.settings.get('TAG_FEED_ATOM'):
|
|
writer.write_feed(arts, self.context,
|
|
self.settings['TAG_FEED_ATOM'] % tag)
|
|
|
|
if self.settings.get('TAG_FEED_RSS'):
|
|
writer.write_feed(arts, self.context,
|
|
self.settings['TAG_FEED_RSS'] % tag,
|
|
feed_type='rss')
|
|
|
|
if self.settings.get('TRANSLATION_FEED'):
|
|
translations_feeds = defaultdict(list)
|
|
for article in chain(self.articles, self.translations):
|
|
translations_feeds[article.lang].append(article)
|
|
|
|
for lang, items in translations_feeds.items():
|
|
items.sort(key=attrgetter('date'), reverse=True)
|
|
writer.write_feed(items, self.context,
|
|
self.settings['TRANSLATION_FEED'] % lang)
|
|
|
|
def generate_articles(self, write):
|
|
"""Generate the articles."""
|
|
for article in chain(self.translations, self.articles):
|
|
write(article.save_as, self.get_template(article.template),
|
|
self.context, article=article, category=article.category)
|
|
|
|
def generate_direct_templates(self, write):
|
|
"""Generate direct templates pages"""
|
|
PAGINATED_TEMPLATES = self.settings.get('PAGINATED_DIRECT_TEMPLATES')
|
|
for template in self.settings.get('DIRECT_TEMPLATES'):
|
|
paginated = {}
|
|
if template in PAGINATED_TEMPLATES:
|
|
paginated = {'articles': self.articles, 'dates': self.dates}
|
|
save_as = self.settings.get("%s_SAVE_AS" % template.upper(),
|
|
'%s.html' % template)
|
|
if not save_as:
|
|
continue
|
|
|
|
write(save_as, self.get_template(template),
|
|
self.context, blog=True, paginated=paginated,
|
|
page_name=template)
|
|
|
|
def generate_tags(self, write):
|
|
"""Generate Tags pages."""
|
|
tag_template = self.get_template('tag')
|
|
for tag, articles in self.tags.items():
|
|
articles.sort(key=attrgetter('date'), reverse=True)
|
|
dates = [article for article in self.dates if article in articles]
|
|
write(tag.save_as, tag_template, self.context, tag=tag,
|
|
articles=articles, dates=dates,
|
|
paginated={'articles': articles, 'dates': dates},
|
|
page_name=u'tag/%s' % tag)
|
|
|
|
def generate_categories(self, write):
|
|
"""Generate category pages."""
|
|
category_template = self.get_template('category')
|
|
for cat, articles in self.categories:
|
|
dates = [article for article in self.dates if article in articles]
|
|
write(cat.save_as, category_template, self.context,
|
|
category=cat, articles=articles, dates=dates,
|
|
paginated={'articles': articles, 'dates': dates},
|
|
page_name=u'category/%s' % cat)
|
|
|
|
def generate_authors(self, write):
|
|
"""Generate Author pages."""
|
|
author_template = self.get_template('author')
|
|
for aut, articles in self.authors:
|
|
dates = [article for article in self.dates if article in articles]
|
|
write(aut.save_as, author_template, self.context,
|
|
author=aut, articles=articles, dates=dates,
|
|
paginated={'articles': articles, 'dates': dates},
|
|
page_name=u'author/%s' % aut)
|
|
|
|
def generate_drafts(self, write):
|
|
"""Generate drafts pages."""
|
|
for article in self.drafts:
|
|
write('drafts/%s.html' % article.slug,
|
|
self.get_template(article.template), self.context,
|
|
article=article, category=article.category)
|
|
|
|
def generate_pages(self, writer):
|
|
"""Generate the pages on the disk"""
|
|
write = partial(writer.write_file,
|
|
relative_urls=self.settings.get('RELATIVE_URLS'))
|
|
|
|
# to minimize the number of relative path stuff modification
|
|
# in writer, articles pass first
|
|
self.generate_articles(write)
|
|
self.generate_direct_templates(write)
|
|
|
|
|
|
# and subfolders after that
|
|
self.generate_tags(write)
|
|
self.generate_categories(write)
|
|
self.generate_authors(write)
|
|
self.generate_drafts(write)
|
|
|
|
def generate_context(self):
|
|
"""change the context"""
|
|
|
|
article_path = os.path.normpath( # we have to remove trailing slashes
|
|
os.path.join(self.path, self.settings['ARTICLE_DIR'])
|
|
)
|
|
all_articles = []
|
|
for f in self.get_files(
|
|
article_path,
|
|
exclude=self.settings['ARTICLE_EXCLUDES']):
|
|
try:
|
|
content, metadata = read_file(f, settings=self.settings)
|
|
except Exception, e:
|
|
logger.warning(u'Could not process %s\n%s' % (f, str(e)))
|
|
continue
|
|
|
|
# if no category is set, use the name of the path as a category
|
|
if 'category' not in metadata:
|
|
|
|
if os.path.dirname(f) == article_path: # if the article is not in a subdirectory
|
|
category = self.settings['DEFAULT_CATEGORY']
|
|
else:
|
|
category = os.path.basename(os.path.dirname(f))\
|
|
.decode('utf-8')
|
|
|
|
if category != '':
|
|
metadata['category'] = Category(category, self.settings)
|
|
|
|
if 'date' not in metadata and self.settings['DEFAULT_DATE']:
|
|
if self.settings['DEFAULT_DATE'] == 'fs':
|
|
metadata['date'] = datetime.datetime.fromtimestamp(
|
|
os.stat(f).st_ctime)
|
|
else:
|
|
metadata['date'] = datetime.datetime(
|
|
*self.settings['DEFAULT_DATE'])
|
|
|
|
signals.article_generate_context.send(self, metadata=metadata)
|
|
article = Article(content, metadata, settings=self.settings,
|
|
filename=f)
|
|
if not is_valid_content(article, f):
|
|
continue
|
|
|
|
if article.status == "published":
|
|
if hasattr(article, 'tags'):
|
|
for tag in article.tags:
|
|
self.tags[tag].append(article)
|
|
all_articles.append(article)
|
|
elif article.status == "draft":
|
|
self.drafts.append(article)
|
|
else:
|
|
logger.warning(u"Unknown status %s for file %s, skipping it." %
|
|
(repr(unicode.encode(article.status, 'utf-8')),
|
|
repr(f)))
|
|
|
|
self.articles, self.translations = process_translations(all_articles)
|
|
|
|
for article in self.articles:
|
|
# only main articles are listed in categories, not translations
|
|
self.categories[article.category].append(article)
|
|
self.authors[article.author].append(article)
|
|
|
|
# sort the articles by date
|
|
self.articles.sort(key=attrgetter('date'), reverse=True)
|
|
self.dates = list(self.articles)
|
|
self.dates.sort(key=attrgetter('date'),
|
|
reverse=self.context['NEWEST_FIRST_ARCHIVES'])
|
|
|
|
# create tag cloud
|
|
tag_cloud = defaultdict(int)
|
|
for article in self.articles:
|
|
for tag in getattr(article, 'tags', []):
|
|
tag_cloud[tag] += 1
|
|
|
|
tag_cloud = sorted(tag_cloud.items(), key=itemgetter(1), reverse=True)
|
|
tag_cloud = tag_cloud[:self.settings.get('TAG_CLOUD_MAX_ITEMS')]
|
|
|
|
tags = map(itemgetter(1), tag_cloud)
|
|
if tags:
|
|
max_count = max(tags)
|
|
steps = self.settings.get('TAG_CLOUD_STEPS')
|
|
|
|
# calculate word sizes
|
|
self.tag_cloud = [
|
|
(
|
|
tag,
|
|
int(math.floor(steps - (steps - 1) * math.log(count)
|
|
/ (math.log(max_count)or 1)))
|
|
)
|
|
for tag, count in tag_cloud
|
|
]
|
|
# put words in chaos
|
|
random.shuffle(self.tag_cloud)
|
|
|
|
# and generate the output :)
|
|
|
|
# order the categories per name
|
|
self.categories = list(self.categories.items())
|
|
self.categories.sort(
|
|
key=lambda item: item[0].name,
|
|
reverse=self.settings['REVERSE_CATEGORY_ORDER'])
|
|
|
|
self.authors = list(self.authors.items())
|
|
self.authors.sort(key=lambda item: item[0].name)
|
|
|
|
self._update_context(('articles', 'dates', 'tags', 'categories',
|
|
'tag_cloud', 'authors', 'related_posts'))
|
|
|
|
def generate_output(self, writer):
|
|
self.generate_feeds(writer)
|
|
self.generate_pages(writer)
|
|
|
|
|
|
class PagesGenerator(Generator):
|
|
"""Generate pages"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.pages = []
|
|
self.hidden_pages = []
|
|
self.hidden_translations = []
|
|
super(PagesGenerator, self).__init__(*args, **kwargs)
|
|
signals.pages_generator_init.send(self)
|
|
|
|
def generate_context(self):
|
|
all_pages = []
|
|
hidden_pages = []
|
|
for f in self.get_files(
|
|
os.path.join(self.path, self.settings['PAGE_DIR']),
|
|
exclude=self.settings['PAGE_EXCLUDES']):
|
|
try:
|
|
content, metadata = read_file(f)
|
|
except Exception, e:
|
|
logger.warning(u'Could not process %s\n%s' % (f, str(e)))
|
|
continue
|
|
signals.pages_generate_context.send(self, metadata=metadata )
|
|
page = Page(content, metadata, settings=self.settings,
|
|
filename=f)
|
|
if not is_valid_content(page, f):
|
|
continue
|
|
if page.status == "published":
|
|
all_pages.append(page)
|
|
elif page.status == "hidden":
|
|
hidden_pages.append(page)
|
|
else:
|
|
logger.warning(u"Unknown status %s for file %s, skipping it." %
|
|
(repr(unicode.encode(page.status, 'utf-8')),
|
|
repr(f)))
|
|
|
|
self.pages, self.translations = process_translations(all_pages)
|
|
self.hidden_pages, self.hidden_translations = process_translations(hidden_pages)
|
|
|
|
self._update_context(('pages', ))
|
|
self.context['PAGES'] = self.pages
|
|
|
|
def generate_output(self, writer):
|
|
for page in chain(self.translations, self.pages,
|
|
self.hidden_translations, self.hidden_pages):
|
|
writer.write_file(page.save_as, self.get_template(page.template),
|
|
self.context, page=page,
|
|
relative_urls=self.settings.get('RELATIVE_URLS'))
|
|
|
|
|
|
class StaticGenerator(Generator):
|
|
"""copy static paths (what you want to copy, like images, medias etc.
|
|
to output"""
|
|
|
|
def _copy_paths(self, paths, source, destination, output_path,
|
|
final_path=None):
|
|
"""Copy all the paths from source to destination"""
|
|
for path in paths:
|
|
copy(path, source, os.path.join(output_path, destination),
|
|
final_path, overwrite=True)
|
|
|
|
def generate_context(self):
|
|
|
|
if self.settings['WEBASSETS']:
|
|
from webassets import Environment as AssetsEnvironment
|
|
|
|
# Define the assets environment that will be passed to the
|
|
# generators. The StaticGenerator must then be run first to have
|
|
# the assets in the output_path before generating the templates.
|
|
assets_url = self.settings['SITEURL'] + '/theme/'
|
|
assets_src = os.path.join(self.output_path, 'theme')
|
|
self.assets_env = AssetsEnvironment(assets_src, assets_url)
|
|
|
|
if logging.getLevelName(logger.getEffectiveLevel()) == "DEBUG":
|
|
self.assets_env.debug = True
|
|
|
|
def generate_output(self, writer):
|
|
|
|
self._copy_paths(self.settings['STATIC_PATHS'], self.path,
|
|
'static', self.output_path)
|
|
self._copy_paths(self.settings['THEME_STATIC_PATHS'], self.theme,
|
|
'theme', self.output_path, '.')
|
|
|
|
# copy all the files needed
|
|
for source, destination in self.settings['FILES_TO_COPY']:
|
|
copy(source, self.path, self.output_path, destination,
|
|
overwrite=True)
|
|
|
|
|
|
class PdfGenerator(Generator):
|
|
"""Generate PDFs on the output dir, for all articles and pages coming from
|
|
rst"""
|
|
def __init__(self, *args, **kwargs):
|
|
try:
|
|
from rst2pdf.createpdf import RstToPdf
|
|
self.pdfcreator = RstToPdf(breakside=0,
|
|
stylesheets=['twelvepoint'])
|
|
except ImportError:
|
|
raise Exception("unable to find rst2pdf")
|
|
super(PdfGenerator, self).__init__(*args, **kwargs)
|
|
|
|
def _create_pdf(self, obj, output_path):
|
|
if obj.filename.endswith(".rst"):
|
|
filename = obj.slug + ".pdf"
|
|
output_pdf = os.path.join(output_path, filename)
|
|
# print "Generating pdf for", obj.filename, " in ", output_pdf
|
|
with open(obj.filename) as f:
|
|
self.pdfcreator.createPdf(text=f, output=output_pdf)
|
|
logger.info(u' [ok] writing %s' % output_pdf)
|
|
|
|
def generate_context(self):
|
|
pass
|
|
|
|
def generate_output(self, writer=None):
|
|
# we don't use the writer passed as argument here
|
|
# since we write our own files
|
|
logger.info(u' Generating PDF files...')
|
|
pdf_path = os.path.join(self.output_path, 'pdf')
|
|
if not os.path.exists(pdf_path):
|
|
try:
|
|
os.mkdir(pdf_path)
|
|
except OSError:
|
|
logger.error("Couldn't create the pdf output folder in " + pdf_path)
|
|
pass
|
|
|
|
for article in self.context['articles']:
|
|
self._create_pdf(article, pdf_path)
|
|
|
|
for page in self.context['pages']:
|
|
self._create_pdf(page, pdf_path)
|
|
|
|
|
|
class LessCSSGenerator(Generator):
|
|
"""Compile less css files."""
|
|
|
|
def _compile(self, less_file, source_dir, dest_dir):
|
|
base = os.path.relpath(less_file, source_dir)
|
|
target = os.path.splitext(
|
|
os.path.join(dest_dir, base))[0] + '.css'
|
|
target_dir = os.path.dirname(target)
|
|
|
|
if not os.path.exists(target_dir):
|
|
try:
|
|
os.makedirs(target_dir)
|
|
except OSError:
|
|
logger.error("Couldn't create the less css output folder in " +
|
|
target_dir)
|
|
|
|
subprocess.call([self._lessc, less_file, target])
|
|
logger.info(u' [ok] compiled %s' % base)
|
|
|
|
def generate_output(self, writer=None):
|
|
logger.info(u' Compiling less css')
|
|
|
|
# store out compiler here, so it won't be evaulted on each run of
|
|
# _compile
|
|
lg = self.settings['LESS_GENERATOR']
|
|
self._lessc = lg if isinstance(lg, basestring) else 'lessc'
|
|
|
|
# walk static paths
|
|
for static_path in self.settings['STATIC_PATHS']:
|
|
for f in self.get_files(
|
|
os.path.join(self.path, static_path),
|
|
extensions=['less']):
|
|
|
|
self._compile(f, self.path, self.output_path)
|
|
|
|
# walk theme static paths
|
|
theme_output_path = os.path.join(self.output_path, 'theme')
|
|
|
|
for static_path in self.settings['THEME_STATIC_PATHS']:
|
|
theme_static_path = os.path.join(self.theme, static_path)
|
|
for f in self.get_files(
|
|
theme_static_path,
|
|
extensions=['less']):
|
|
|
|
self._compile(f, theme_static_path, theme_output_path)
|