forked from github/pelican
48f4f0850d
This change partially addresses issue #1019, by teaching Pelican to distinguish between static files and content source files. A user can now safely add the same directory to both STATIC_PATHS and PAGE_PATHS (or ARTICLE_PATHS). Pelican will then process the content source files in that directory normally, and treat the remaining files as static, without copying the raw content source files to the output directory. (The OUTPUT_SOURCES setting still works.) In other words, images and markdown/reST files can now safely live together. To keep those files together in the generated site, STATIC_SAVE_AS and PAGE_SAVE_AS (or ARTICLE_SAVE_AS) should point to the same output directory. There are two new configuration settings: STATIC_EXCLUDES=[] # This works just like PAGE_EXCLUDES and ARTICLE_EXCLUDES. STATIC_EXCLUDE_SOURCES=True # Set this to False to get the old behavior. Two small but noteworthy internal changes: StaticGenerator now runs after all the other generators. This allows it to see which files are meant to be processed by other generators, and avoid them. Generators now include files that they fail to process (e.g. those with missing mandatory metadata) along with all the other paths in context['filenames']. This allows such files to be excluded from StaticGenerator's file list, so they won't end up accidentally published. Since these files have no Content object, their value in context['filenames'] is None. The code that uses that dict has been updated accordingly.
381 lines
14 KiB
Python
381 lines
14 KiB
Python
# -*- coding: utf-8 -*-
|
|
from __future__ import unicode_literals, print_function
|
|
import six
|
|
|
|
import copy
|
|
import inspect
|
|
import os
|
|
import locale
|
|
import logging
|
|
|
|
try:
|
|
# SourceFileLoader is the recommended way in 3.3+
|
|
from importlib.machinery import SourceFileLoader
|
|
load_source = lambda name, path: SourceFileLoader(name, path).load_module()
|
|
except ImportError:
|
|
# but it does not exist in 3.2-, so fall back to imp
|
|
import imp
|
|
load_source = imp.load_source
|
|
|
|
from os.path import isabs
|
|
|
|
from pelican.log import LimitFilter
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
DEFAULT_THEME = os.path.join(os.path.dirname(os.path.abspath(__file__)),
|
|
'themes', 'notmyidea')
|
|
DEFAULT_CONFIG = {
|
|
'PATH': os.curdir,
|
|
'ARTICLE_PATHS': [''],
|
|
'ARTICLE_EXCLUDES': [],
|
|
'PAGE_PATHS': ['pages'],
|
|
'PAGE_EXCLUDES': [],
|
|
'THEME': DEFAULT_THEME,
|
|
'OUTPUT_PATH': 'output',
|
|
'READERS': {},
|
|
'STATIC_PATHS': ['images'],
|
|
'STATIC_EXCLUDES': [],
|
|
'STATIC_EXCLUDE_SOURCES': True,
|
|
'THEME_STATIC_DIR': 'theme',
|
|
'THEME_STATIC_PATHS': ['static', ],
|
|
'FEED_ALL_ATOM': os.path.join('feeds', 'all.atom.xml'),
|
|
'CATEGORY_FEED_ATOM': os.path.join('feeds', '%s.atom.xml'),
|
|
'AUTHOR_FEED_ATOM': os.path.join('feeds', '%s.atom.xml'),
|
|
'AUTHOR_FEED_RSS': os.path.join('feeds', '%s.rss.xml'),
|
|
'TRANSLATION_FEED_ATOM': os.path.join('feeds', 'all-%s.atom.xml'),
|
|
'FEED_MAX_ITEMS': '',
|
|
'SITEURL': '',
|
|
'SITENAME': 'A Pelican Blog',
|
|
'DISPLAY_PAGES_ON_MENU': True,
|
|
'DISPLAY_CATEGORIES_ON_MENU': True,
|
|
'DOCUTILS_SETTINGS': {},
|
|
'OUTPUT_SOURCES': False,
|
|
'OUTPUT_SOURCES_EXTENSION': '.text',
|
|
'USE_FOLDER_AS_CATEGORY': True,
|
|
'DEFAULT_CATEGORY': 'misc',
|
|
'WITH_FUTURE_DATES': True,
|
|
'CSS_FILE': 'main.css',
|
|
'NEWEST_FIRST_ARCHIVES': True,
|
|
'REVERSE_CATEGORY_ORDER': False,
|
|
'DELETE_OUTPUT_DIRECTORY': False,
|
|
'OUTPUT_RETENTION': (),
|
|
'ARTICLE_URL': '{slug}.html',
|
|
'ARTICLE_SAVE_AS': '{slug}.html',
|
|
'ARTICLE_ORDER_BY': 'slug',
|
|
'ARTICLE_LANG_URL': '{slug}-{lang}.html',
|
|
'ARTICLE_LANG_SAVE_AS': '{slug}-{lang}.html',
|
|
'DRAFT_URL': 'drafts/{slug}.html',
|
|
'DRAFT_SAVE_AS': os.path.join('drafts', '{slug}.html'),
|
|
'DRAFT_LANG_URL': 'drafts/{slug}-{lang}.html',
|
|
'DRAFT_LANG_SAVE_AS': os.path.join('drafts', '{slug}-{lang}.html'),
|
|
'PAGE_URL': 'pages/{slug}.html',
|
|
'PAGE_SAVE_AS': os.path.join('pages', '{slug}.html'),
|
|
'PAGE_ORDER_BY': 'basename',
|
|
'PAGE_LANG_URL': 'pages/{slug}-{lang}.html',
|
|
'PAGE_LANG_SAVE_AS': os.path.join('pages', '{slug}-{lang}.html'),
|
|
'STATIC_URL': '{path}',
|
|
'STATIC_SAVE_AS': '{path}',
|
|
'PDF_GENERATOR': False,
|
|
'PDF_STYLE_PATH': '',
|
|
'PDF_STYLE': 'twelvepoint',
|
|
'CATEGORY_URL': 'category/{slug}.html',
|
|
'CATEGORY_SAVE_AS': os.path.join('category', '{slug}.html'),
|
|
'TAG_URL': 'tag/{slug}.html',
|
|
'TAG_SAVE_AS': os.path.join('tag', '{slug}.html'),
|
|
'AUTHOR_URL': 'author/{slug}.html',
|
|
'AUTHOR_SAVE_AS': os.path.join('author', '{slug}.html'),
|
|
'PAGINATION_PATTERNS': [
|
|
(0, '{name}{number}{extension}', '{name}{number}{extension}'),
|
|
],
|
|
'YEAR_ARCHIVE_SAVE_AS': '',
|
|
'MONTH_ARCHIVE_SAVE_AS': '',
|
|
'DAY_ARCHIVE_SAVE_AS': '',
|
|
'RELATIVE_URLS': False,
|
|
'DEFAULT_LANG': 'en',
|
|
'TAG_CLOUD_STEPS': 4,
|
|
'TAG_CLOUD_MAX_ITEMS': 100,
|
|
'DIRECT_TEMPLATES': ('index', 'tags', 'categories', 'authors', 'archives'),
|
|
'EXTRA_TEMPLATES_PATHS': [],
|
|
'PAGINATED_DIRECT_TEMPLATES': ('index', ),
|
|
'PELICAN_CLASS': 'pelican.Pelican',
|
|
'DEFAULT_DATE_FORMAT': '%a %d %B %Y',
|
|
'DATE_FORMATS': {},
|
|
'MD_EXTENSIONS': ['codehilite(css_class=highlight)', 'extra'],
|
|
'JINJA_EXTENSIONS': [],
|
|
'JINJA_FILTERS': {},
|
|
'LOG_FILTER': [],
|
|
'LOCALE': [''], # defaults to user locale
|
|
'DEFAULT_PAGINATION': False,
|
|
'DEFAULT_ORPHANS': 0,
|
|
'DEFAULT_METADATA': (),
|
|
'FILENAME_METADATA': '(?P<date>\d{4}-\d{2}-\d{2}).*',
|
|
'PATH_METADATA': '',
|
|
'EXTRA_PATH_METADATA': {},
|
|
'DEFAULT_STATUS': 'published',
|
|
'ARTICLE_PERMALINK_STRUCTURE': '',
|
|
'TYPOGRIFY': False,
|
|
'TYPOGRIFY_IGNORE_TAGS': [],
|
|
'SUMMARY_MAX_LENGTH': 50,
|
|
'PLUGIN_PATHS': [],
|
|
'PLUGINS': [],
|
|
'PYGMENTS_RST_OPTIONS': {},
|
|
'TEMPLATE_PAGES': {},
|
|
'IGNORE_FILES': ['.#*'],
|
|
'SLUG_SUBSTITUTIONS': (),
|
|
'INTRASITE_LINK_REGEX': '[{|](?P<what>.*?)[|}]',
|
|
'SLUGIFY_SOURCE': 'title',
|
|
'CACHE_CONTENT': True,
|
|
'CONTENT_CACHING_LAYER': 'reader',
|
|
'CACHE_PATH': 'cache',
|
|
'GZIP_CACHE': True,
|
|
'CHECK_MODIFIED_METHOD': 'mtime',
|
|
'LOAD_CONTENT_CACHE': True,
|
|
'AUTORELOAD_IGNORE_CACHE': False,
|
|
'WRITE_SELECTED': [],
|
|
}
|
|
|
|
PYGMENTS_RST_OPTIONS = None
|
|
|
|
|
|
def read_settings(path=None, override=None):
|
|
if path:
|
|
local_settings = get_settings_from_file(path)
|
|
# Make the paths relative to the settings file
|
|
for p in ['PATH', 'OUTPUT_PATH', 'THEME', 'CACHE_PATH']:
|
|
if p in local_settings and local_settings[p] is not None \
|
|
and not isabs(local_settings[p]):
|
|
absp = os.path.abspath(os.path.normpath(os.path.join(
|
|
os.path.dirname(path), local_settings[p])))
|
|
if p not in ('THEME') or os.path.exists(absp):
|
|
local_settings[p] = absp
|
|
|
|
if 'PLUGIN_PATH' in local_settings:
|
|
logger.warning('PLUGIN_PATH setting has been replaced by '
|
|
'PLUGIN_PATHS, moving it to the new setting name.')
|
|
local_settings['PLUGIN_PATHS'] = local_settings['PLUGIN_PATH']
|
|
del local_settings['PLUGIN_PATH']
|
|
if isinstance(local_settings['PLUGIN_PATHS'], six.string_types):
|
|
logger.warning("Defining PLUGIN_PATHS setting as string "
|
|
"has been deprecated (should be a list)")
|
|
local_settings['PLUGIN_PATHS'] = [local_settings['PLUGIN_PATHS']]
|
|
elif local_settings['PLUGIN_PATHS'] is not None:
|
|
local_settings['PLUGIN_PATHS'] = [os.path.abspath(os.path.normpath(os.path.join(os.path.dirname(path), pluginpath)))
|
|
if not isabs(pluginpath) else pluginpath for pluginpath in local_settings['PLUGIN_PATHS']]
|
|
else:
|
|
local_settings = copy.deepcopy(DEFAULT_CONFIG)
|
|
|
|
if override:
|
|
local_settings.update(override)
|
|
|
|
parsed_settings = configure_settings(local_settings)
|
|
# This is because there doesn't seem to be a way to pass extra
|
|
# parameters to docutils directive handlers, so we have to have a
|
|
# variable here that we'll import from within Pygments.run (see
|
|
# rstdirectives.py) to see what the user defaults were.
|
|
global PYGMENTS_RST_OPTIONS
|
|
PYGMENTS_RST_OPTIONS = parsed_settings.get('PYGMENTS_RST_OPTIONS', None)
|
|
return parsed_settings
|
|
|
|
|
|
def get_settings_from_module(module=None, default_settings=DEFAULT_CONFIG):
|
|
"""Loads settings from a module, returns a dictionary."""
|
|
|
|
context = copy.deepcopy(default_settings)
|
|
if module is not None:
|
|
context.update(
|
|
(k, v) for k, v in inspect.getmembers(module) if k.isupper())
|
|
return context
|
|
|
|
|
|
def get_settings_from_file(path, default_settings=DEFAULT_CONFIG):
|
|
"""Loads settings from a file path, returning a dict."""
|
|
|
|
name, ext = os.path.splitext(os.path.basename(path))
|
|
module = load_source(name, path)
|
|
return get_settings_from_module(module, default_settings=default_settings)
|
|
|
|
|
|
def configure_settings(settings):
|
|
"""Provide optimizations, error checking, and warnings for the given
|
|
settings.
|
|
Also, specify the log messages to be ignored.
|
|
"""
|
|
if not 'PATH' in settings or not os.path.isdir(settings['PATH']):
|
|
raise Exception('You need to specify a path containing the content'
|
|
' (see pelican --help for more information)')
|
|
|
|
# specify the log messages to be ignored
|
|
LimitFilter._ignore.update(set(settings.get('LOG_FILTER',
|
|
DEFAULT_CONFIG['LOG_FILTER'])))
|
|
|
|
# lookup the theme in "pelican/themes" if the given one doesn't exist
|
|
if not os.path.isdir(settings['THEME']):
|
|
theme_path = os.path.join(
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
'themes',
|
|
settings['THEME'])
|
|
if os.path.exists(theme_path):
|
|
settings['THEME'] = theme_path
|
|
else:
|
|
raise Exception("Could not find the theme %s"
|
|
% settings['THEME'])
|
|
|
|
# make paths selected for writing absolute if necessary
|
|
settings['WRITE_SELECTED'] = [
|
|
os.path.abspath(path) for path in
|
|
settings.get('WRITE_SELECTED', DEFAULT_CONFIG['WRITE_SELECTED'])
|
|
]
|
|
|
|
# standardize strings to lowercase strings
|
|
for key in [
|
|
'DEFAULT_LANG',
|
|
]:
|
|
if key in settings:
|
|
settings[key] = settings[key].lower()
|
|
|
|
# standardize strings to lists
|
|
for key in [
|
|
'LOCALE',
|
|
]:
|
|
if key in settings and isinstance(settings[key], six.string_types):
|
|
settings[key] = [settings[key]]
|
|
|
|
# check settings that must be a particular type
|
|
for key, types in [
|
|
('OUTPUT_SOURCES_EXTENSION', six.string_types),
|
|
('FILENAME_METADATA', six.string_types),
|
|
]:
|
|
if key in settings and not isinstance(settings[key], types):
|
|
value = settings.pop(key)
|
|
logger.warn('Detected misconfigured %s (%s), '
|
|
'falling back to the default (%s)',
|
|
key, value, DEFAULT_CONFIG[key])
|
|
|
|
# try to set the different locales, fallback on the default.
|
|
locales = settings.get('LOCALE', DEFAULT_CONFIG['LOCALE'])
|
|
|
|
for locale_ in locales:
|
|
try:
|
|
locale.setlocale(locale.LC_ALL, str(locale_))
|
|
break # break if it is successful
|
|
except locale.Error:
|
|
pass
|
|
else:
|
|
logger.warning("LOCALE option doesn't contain a correct value")
|
|
|
|
if ('SITEURL' in settings):
|
|
# If SITEURL has a trailing slash, remove it and provide a warning
|
|
siteurl = settings['SITEURL']
|
|
if (siteurl.endswith('/')):
|
|
settings['SITEURL'] = siteurl[:-1]
|
|
logger.warning("Removed extraneous trailing slash from SITEURL.")
|
|
# If SITEURL is defined but FEED_DOMAIN isn't,
|
|
# set FEED_DOMAIN to SITEURL
|
|
if not 'FEED_DOMAIN' in settings:
|
|
settings['FEED_DOMAIN'] = settings['SITEURL']
|
|
|
|
# check content caching layer and warn of incompatibilities
|
|
if (settings.get('CACHE_CONTENT', False) and
|
|
settings.get('CONTENT_CACHING_LAYER', '') == 'generator' and
|
|
settings.get('WITH_FUTURE_DATES', DEFAULT_CONFIG['WITH_FUTURE_DATES'])):
|
|
logger.warning('WITH_FUTURE_DATES conflicts with '
|
|
"CONTENT_CACHING_LAYER set to 'generator', "
|
|
"use 'reader' layer instead")
|
|
|
|
# Warn if feeds are generated with both SITEURL & FEED_DOMAIN undefined
|
|
feed_keys = [
|
|
'FEED_ATOM', 'FEED_RSS',
|
|
'FEED_ALL_ATOM', 'FEED_ALL_RSS',
|
|
'CATEGORY_FEED_ATOM', 'CATEGORY_FEED_RSS',
|
|
'AUTHOR_FEED_ATOM', 'AUTHOR_FEED_RSS',
|
|
'TAG_FEED_ATOM', 'TAG_FEED_RSS',
|
|
'TRANSLATION_FEED_ATOM', 'TRANSLATION_FEED_RSS',
|
|
]
|
|
|
|
if any(settings.get(k) for k in feed_keys):
|
|
if not settings.get('SITEURL'):
|
|
logger.warning('Feeds generated without SITEURL set properly may'
|
|
' not be valid')
|
|
|
|
if not 'TIMEZONE' in settings:
|
|
logger.warning(
|
|
'No timezone information specified in the settings. Assuming'
|
|
' your timezone is UTC for feed generation. Check '
|
|
'http://docs.getpelican.com/en/latest/settings.html#timezone '
|
|
'for more information')
|
|
|
|
# fix up pagination rules
|
|
from pelican.paginator import PaginationRule
|
|
pagination_rules = [
|
|
PaginationRule(*r) for r in settings.get(
|
|
'PAGINATION_PATTERNS',
|
|
DEFAULT_CONFIG['PAGINATION_PATTERNS'],
|
|
)
|
|
]
|
|
settings['PAGINATION_PATTERNS'] = sorted(
|
|
pagination_rules,
|
|
key=lambda r: r[0],
|
|
)
|
|
|
|
# move {ARTICLE,PAGE}_DIR -> {ARTICLE,PAGE}_PATHS
|
|
for key in ['ARTICLE', 'PAGE']:
|
|
old_key = key + '_DIR'
|
|
new_key = key + '_PATHS'
|
|
if old_key in settings:
|
|
logger.warning('Deprecated setting %s, moving it to %s list',
|
|
old_key, new_key)
|
|
settings[new_key] = [settings[old_key]] # also make a list
|
|
del settings[old_key]
|
|
|
|
# Save people from accidentally setting a string rather than a list
|
|
path_keys = (
|
|
'ARTICLE_EXCLUDES',
|
|
'DEFAULT_METADATA',
|
|
'DIRECT_TEMPLATES',
|
|
'EXTRA_TEMPLATES_PATHS',
|
|
'FILES_TO_COPY',
|
|
'IGNORE_FILES',
|
|
'JINJA_EXTENSIONS',
|
|
'PAGINATED_DIRECT_TEMPLATES',
|
|
'PLUGINS',
|
|
'STATIC_EXCLUDES',
|
|
'STATIC_PATHS',
|
|
'THEME_STATIC_PATHS',
|
|
'ARTICLE_PATHS',
|
|
'PAGE_PATHS',
|
|
)
|
|
for PATH_KEY in filter(lambda k: k in settings, path_keys):
|
|
if isinstance(settings[PATH_KEY], six.string_types):
|
|
logger.warning("Detected misconfiguration with %s setting "
|
|
"(must be a list), falling back to the default",
|
|
PATH_KEY)
|
|
settings[PATH_KEY] = DEFAULT_CONFIG[PATH_KEY]
|
|
|
|
# Add {PAGE,ARTICLE}_PATHS to {ARTICLE,PAGE}_EXCLUDES
|
|
mutually_exclusive = ('ARTICLE', 'PAGE')
|
|
for type_1, type_2 in [mutually_exclusive, mutually_exclusive[::-1]]:
|
|
try:
|
|
includes = settings[type_1 + '_PATHS']
|
|
excludes = settings[type_2 + '_EXCLUDES']
|
|
for path in includes:
|
|
if path not in excludes:
|
|
excludes.append(path)
|
|
except KeyError:
|
|
continue # setting not specified, nothing to do
|
|
|
|
for old, new, doc in [
|
|
('LESS_GENERATOR', 'the Webassets plugin', None),
|
|
('FILES_TO_COPY', 'STATIC_PATHS and EXTRA_PATH_METADATA',
|
|
'https://github.com/getpelican/pelican/blob/master/docs/settings.rst#path-metadata'),
|
|
]:
|
|
if old in settings:
|
|
message = 'The {} setting has been removed in favor of {}'.format(
|
|
old, new)
|
|
if doc:
|
|
message += ', see {} for details'.format(doc)
|
|
logger.warning(message)
|
|
|
|
return settings
|