263 lines
9.0 KiB
Python
263 lines
9.0 KiB
Python
# Copyright (c) 2009-2018 - Simon Conseil
|
|
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to
|
|
# deal in the Software without restriction, including without limitation the
|
|
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
# sell copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
# IN THE SOFTWARE.
|
|
|
|
import click
|
|
import importlib
|
|
import locale
|
|
import logging
|
|
import os
|
|
import socketserver
|
|
import sys
|
|
import time
|
|
|
|
from click import argument, option
|
|
from http import server
|
|
|
|
from .gallery import Gallery
|
|
from .log import init_logging
|
|
from .settings import read_settings
|
|
from .utils import copy
|
|
|
|
__version__ = '2.1.dev'
|
|
__url__ = 'https://github.com/saimn/sigal'
|
|
|
|
_DEFAULT_CONFIG_FILE = 'sigal.conf.py'
|
|
|
|
if sys.version_info[:2] < (3, 5):
|
|
raise Exception('Sigal supports Python 3.5+ only')
|
|
|
|
|
|
@click.group()
|
|
@click.version_option(version=__version__)
|
|
def main():
|
|
"""Sigal - Simple Static Gallery Generator.
|
|
|
|
Sigal is yet another python script to prepare a static gallery of images:
|
|
resize images, create thumbnails with some options, generate html pages.
|
|
|
|
"""
|
|
pass # pragma: no cover
|
|
|
|
|
|
@main.command()
|
|
@argument('path', default=_DEFAULT_CONFIG_FILE)
|
|
def init(path):
|
|
"""Copy a sample config file in the current directory (default to
|
|
'sigal.conf.py'), or use the provided 'path'."""
|
|
|
|
if os.path.isfile(path):
|
|
print("Found an existing config file, will abort to keep it safe.")
|
|
sys.exit(1)
|
|
|
|
from pkg_resources import resource_string
|
|
conf = resource_string(__name__, 'templates/sigal.conf.py')
|
|
|
|
with open(path, 'w', encoding='utf-8') as f:
|
|
f.write(conf.decode('utf8'))
|
|
print("Sample config file created: {}".format(path))
|
|
|
|
|
|
@main.command()
|
|
@argument('source', required=False)
|
|
@argument('destination', required=False)
|
|
@option('-f', '--force', is_flag=True,
|
|
help="Force the reprocessing of existing images")
|
|
@option('-v', '--verbose', is_flag=True, help="Show all messages")
|
|
@option('-d', '--debug', is_flag=True,
|
|
help="Show all message, including debug messages")
|
|
@option('-c', '--config', default=_DEFAULT_CONFIG_FILE, show_default=True,
|
|
help="Configuration file")
|
|
@option('-t', '--theme', help="Specify a theme directory, or a theme name for "
|
|
"the themes included with Sigal")
|
|
@option('--title', help="Title of the gallery (overrides the title setting.")
|
|
@option('-n', '--ncpu', help="Number of cpu to use (default: all)")
|
|
def build(source, destination, debug, verbose, force, config, theme, title,
|
|
ncpu):
|
|
"""Run sigal to process a directory.
|
|
|
|
If provided, 'source', 'destination' and 'theme' will override the
|
|
corresponding values from the settings file.
|
|
|
|
"""
|
|
level = ((debug and logging.DEBUG) or (verbose and logging.INFO) or
|
|
logging.WARNING)
|
|
init_logging(__name__, level=level)
|
|
logger = logging.getLogger(__name__)
|
|
|
|
if not os.path.isfile(config):
|
|
logger.error("Settings file not found: %s", config)
|
|
sys.exit(1)
|
|
|
|
start_time = time.time()
|
|
settings = read_settings(config)
|
|
|
|
for key in ('source', 'destination', 'theme'):
|
|
arg = locals()[key]
|
|
if arg is not None:
|
|
settings[key] = os.path.abspath(arg)
|
|
logger.info("%12s : %s", key.capitalize(), settings[key])
|
|
|
|
if not settings['source'] or not os.path.isdir(settings['source']):
|
|
logger.error("Input directory not found: %s", settings['source'])
|
|
sys.exit(1)
|
|
|
|
# on windows os.path.relpath raises a ValueError if the two paths are on
|
|
# different drives, in that case we just ignore the exception as the two
|
|
# paths are anyway not relative
|
|
relative_check = True
|
|
try:
|
|
relative_check = os.path.relpath(settings['destination'],
|
|
settings['source']).startswith('..')
|
|
except ValueError:
|
|
pass
|
|
|
|
if not relative_check:
|
|
logger.error("Output directory should be outside of the input "
|
|
"directory.")
|
|
sys.exit(1)
|
|
|
|
if title:
|
|
settings['title'] = title
|
|
|
|
locale.setlocale(locale.LC_ALL, settings['locale'])
|
|
init_plugins(settings)
|
|
|
|
gal = Gallery(settings, ncpu=ncpu)
|
|
gal.build(force=force)
|
|
|
|
# copy extra files
|
|
for src, dst in settings['files_to_copy']:
|
|
src = os.path.join(settings['source'], src)
|
|
dst = os.path.join(settings['destination'], dst)
|
|
logger.debug('Copy %s to %s', src, dst)
|
|
copy(src, dst, symlink=settings['orig_link'])
|
|
|
|
stats = gal.stats
|
|
|
|
def format_stats(_type):
|
|
opt = ["{} {}".format(stats[_type + '_' + subtype], subtype)
|
|
for subtype in ('skipped', 'failed')
|
|
if stats[_type + '_' + subtype] > 0]
|
|
opt = ' ({})'.format(', '.join(opt)) if opt else ''
|
|
return '{} {}s{}'.format(stats[_type], _type, opt)
|
|
|
|
print('Done.\nProcessed {} and {} in {:.2f} seconds.'
|
|
.format(format_stats('image'), format_stats('video'),
|
|
time.time() - start_time))
|
|
|
|
|
|
def init_plugins(settings):
|
|
"""Load plugins and call register()."""
|
|
|
|
logger = logging.getLogger(__name__)
|
|
logger.debug('Plugin paths: %s', settings['plugin_paths'])
|
|
|
|
for path in settings['plugin_paths']:
|
|
sys.path.insert(0, path)
|
|
|
|
for plugin in settings['plugins']:
|
|
try:
|
|
if isinstance(plugin, str):
|
|
mod = importlib.import_module(plugin)
|
|
mod.register(settings)
|
|
else:
|
|
plugin.register(settings)
|
|
logger.debug('Registered plugin %s', plugin)
|
|
except Exception as e:
|
|
logger.error('Failed to load plugin %s: %r', plugin, e)
|
|
|
|
for path in settings['plugin_paths']:
|
|
sys.path.remove(path)
|
|
|
|
|
|
@main.command()
|
|
@argument('destination', default='_build')
|
|
@option('-p', '--port', help="Port to use", default=8000)
|
|
@option('-c', '--config', default=_DEFAULT_CONFIG_FILE,
|
|
show_default=True, help='Configuration file')
|
|
def serve(destination, port, config):
|
|
"""Run a simple web server."""
|
|
if os.path.exists(destination):
|
|
pass
|
|
elif os.path.exists(config):
|
|
settings = read_settings(config)
|
|
destination = settings.get('destination')
|
|
if not os.path.exists(destination):
|
|
sys.stderr.write("The '{}' directory doesn't exist, maybe try "
|
|
"building first?\n".format(destination))
|
|
sys.exit(1)
|
|
else:
|
|
sys.stderr.write("The {destination} directory doesn't exist "
|
|
"and the config file ({config}) could not be read.\n"
|
|
.format(destination=destination, config=config))
|
|
sys.exit(2)
|
|
|
|
print('DESTINATION : {}'.format(destination))
|
|
os.chdir(destination)
|
|
Handler = server.SimpleHTTPRequestHandler
|
|
httpd = socketserver.TCPServer(("", port), Handler, False)
|
|
print(" * Running on http://127.0.0.1:{}/".format(port))
|
|
|
|
try:
|
|
httpd.allow_reuse_address = True
|
|
httpd.server_bind()
|
|
httpd.server_activate()
|
|
httpd.serve_forever()
|
|
except KeyboardInterrupt:
|
|
print('\nAll done!')
|
|
|
|
|
|
@main.command()
|
|
@argument('target')
|
|
@argument('keys', nargs=-1)
|
|
@option('-o', '--overwrite', default=False, is_flag=True,
|
|
help='Overwrite existing .md file')
|
|
def set_meta(target, keys, overwrite=False):
|
|
"""Write metadata keys to .md file.
|
|
|
|
TARGET can be a media file or an album directory. KEYS are key/value pairs.
|
|
|
|
Ex, to set the title of test.jpg to "My test image":
|
|
|
|
sigal set_meta test.jpg title "My test image"
|
|
"""
|
|
|
|
if not os.path.exists(target):
|
|
sys.stderr.write("The target {} does not exist.\n".format(target))
|
|
sys.exit(1)
|
|
if len(keys) < 2 or len(keys) % 2 > 0:
|
|
sys.stderr.write("Need an even number of arguments.\n")
|
|
sys.exit(1)
|
|
|
|
if os.path.isdir(target):
|
|
descfile = os.path.join(target, 'index.md')
|
|
else:
|
|
descfile = os.path.splitext(target)[0] + '.md'
|
|
if os.path.exists(descfile) and not overwrite:
|
|
sys.stderr.write("Description file '{}' already exists. "
|
|
"Use --overwrite to overwrite it.\n".format(descfile))
|
|
sys.exit(2)
|
|
|
|
with open(descfile, "w") as fp:
|
|
for i in range(len(keys) // 2):
|
|
k, v = keys[i * 2:(i + 1) * 2]
|
|
fp.write("{}: {}\n".format(k.capitalize(), v))
|
|
print("{} metadata key(s) written to {}".format(len(keys) // 2, descfile))
|