poole - {{ hx(page["title"]) }}

From 501622816878fbae771a23449eab6d274e9a147a Mon Sep 17 00:00:00 2001 From: Holger Weiss Date: Sun, 29 Dec 2024 19:40:53 +0100 Subject: Switch to latest Poole version Use the latest Poole code currently available at: https://hg.sr.ht/~obensonne/poole Rather than including the code in this repository, expect it to be found in the PATH (e.g., in $prefix/opt/poole/env/bin). As Poole is Python-3-based now, update web/macros.py accordingly. --- libexec/poole | 755 ---------------------------------------------------------- 1 file changed, 755 deletions(-) delete mode 100755 libexec/poole (limited to 'libexec') diff --git a/libexec/poole b/libexec/poole deleted file mode 100755 index eeac0b9..0000000 --- a/libexec/poole +++ /dev/null @@ -1,755 +0,0 @@ -#!/home/plugins/python2/bin/python -# -*- coding: utf-8 -*- - -# ============================================================================= -# -# Poole - A damn simple static website generator. -# Copyright (C) 2012 Oben Sonne -# -# This file is part of Poole. -# -# Poole is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Poole is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Poole. If not, see . -# -# ============================================================================= - -from __future__ import with_statement - -import codecs -import glob -import imp -import optparse -import os -from os.path import join as opj -from os.path import exists as opx -import re -import shutil -import StringIO -import sys -import traceback -import urlparse - -from SimpleHTTPServer import SimpleHTTPRequestHandler -from BaseHTTPServer import HTTPServer - -try: - import markdown -except ImportError: - print("abort : need python-markdown, get it from " - "http://www.freewisdom.org/projects/python-markdown/Installation") - sys.exit(1) - -HERE = os.path.dirname(os.path.realpath(__file__)) - -THEME_DIR = opj(HERE, 'themes') - -THEME_NAMES = ['minimal'] + [ - os.path.basename(x) - for x in glob.glob(opj(THEME_DIR, '*')) - if os.path.isdir(x) -] - -# ============================================================================= -# init site -# ============================================================================= - -EXAMPLE_FILES = { - -"page.html": """ - - - - poole - {{ hx(page["title"]) }} - - - - - -

- - -

- - - -""", - -# ----------------------------------------------------------------------------- - -opj("input", "index.md"): """ -title: home -menu-position: 0 ---- - -## Welcome to Poole - -In Poole you write your pages in [markdown][md]. It's easier to write -markdown than HTML. - -Poole is made for simple websites you just want to get done, without installing -a bunch of requirements and without learning a template engine. - -In a build, Poole copies every file from the *input* directory to the *output* -directory. During that process every markdown file (ending with *md*, *mkd*, -*mdown* or *markdown*) is converted to HTML using the project's `page.html` -as a skeleton. - -[md]: http://daringfireball.net/projects/markdown/ -""", - -# ----------------------------------------------------------------------------- - -opj("input", "logic.md"): """ -menu-position: 4 ---- -Poole has basic support for content generation using Python code inlined in -page files. This is everything but a clear separation of logic and content but -for simple sites this is just a pragmatic way to get things done fast. -For instance the menu on this page is generated by some inlined Python code in -the project's `page.html` file. - -Just ignore this feature if you don't need it :) - -Content generation by inlined Python code is good to add some zest to your -site. If you use it a lot, you better go with more sophisticated site -generators like [Hyde](http://ringce.com/hyde). -""", - -# ----------------------------------------------------------------------------- - -opj("input", "layout.md"): """ -menu-position: 3 ---- -Every page of a poole site is based on *one global template file*, `page.html`. -All you need to adjust the site layout is to edit the page template -`page.html`. -""", - -opj("input", "blog.md"): """ -menu-position: 10 ---- -Poole has basic blog support. If an input page's file name has a structure like -`page-title.YYYY-MM-DD.post-title.md`, e.g. `blog.2010-02-27.read_this.md`, -Poole recognizes the date and post title and sets them as attributes of the -page. These attributes can then be used to generate a list of blog posts: - - - -Have a look into `input/blog.md` to see how it works. Feel free to adjust it -to your needs. -""", - -# ----------------------------------------------------------------------------- - -opj("input", "blog.2013-04-08.Lorem_Ipsum.md") : """ - ---- -## {{ page["post"] }} - -*Posted at -* - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed sed pretium arcu. -Nullam eu leo ut justo egestas condimentum sed id dolor. In suscipit est eu -tellus lacinia congue. Nunc tincidunt posuere nibh vitae accumsan. Suspendisse -quis justo quis nulla rhoncus venenatis. Cum sociis natoque penatibus et magnis -dis parturient montes, nascetur ridiculus mus. Suspendisse potenti. - -Nullam luctus tortor ac libero eleifend interdum nec eget dolor. Aliquam quis -massa metus, id fringilla odio. Fusce lobortis sollicitudin gravida. Donec -porttitor metus aliquam diam consectetur vitae tristique ligula aliquet. Nulla -facilisi. Mauris eleifend erat id velit eleifend facilisis. Proin orci lacus, -imperdiet eu mollis ac, cursus sit amet ligula. Ut id neque urna, sed dignissim -urna. Cras sit amet sodales orci. In at lacus dui. Duis mi neque, posuere ut -congue non, ornare a magna. Fusce massa ligula, vestibulum sed vulputate quis, -sodales at massa. - -No-ASCII characters like `öäüß` are no problems as long as input files are -encoded in UTF8. -""", - -# ----------------------------------------------------------------------------- - -opj("input", "blog.2013-04-01.Holy_Grail.md"): """ - -## {{ page["post"] }} - -*Posted at .* - -Knights of Ni, we are but simple travelers who seek the enchanter who lives -beyond these woods. A newt? Did you dress her up like this? On second thoughts, -let's not go there. It is a silly place. You don't vote for kings. Knights of -Ni, we are but simple travelers who seek the enchanter who lives beyond these -woods. - -### Bridgekeeper ### - -Camelot! What do you mean? And this isn't my nose. This is a false one. Ah, now -we see the violence inherent in the system! - -You don't frighten us, English pig-dogs! Go and boil your bottoms, sons of a -silly person! I blow my nose at you, so-called Ah-thoor Keeng, you and all your -silly English K-n-n-n-n-n-n-n-niggits! I don't want to talk to you no more, you -empty-headed animal food trough water! I fart in your general direction! Your -mother was a hamster and your father smelt of elderberries! Now leave before I -am forced to taunt you a second time! Shh! Knights, I bid you welcome to your -new home. Let us ride to Camelot! Now, look here, my good man. - -### What a strange ### - -She looks like one. Why do you think that she is a witch? Look, my liege! Bring -her forward! - -[Ni!](http://chrisvalleskey.com/fillerama/) -""", -} - -def init(project, theme): - """Initialize a site project.""" - - if not opx(project): - os.makedirs(project) - - if os.listdir(project): - print("abort : project dir %s is not empty" % project) - sys.exit(1) - - dir_in = opj(project, "input") - dir_out = opj(project, "output") - - os.mkdir(dir_in) - os.mkdir(dir_out) - - for fname, content in EXAMPLE_FILES.items(): - print('info: create example %r' % fname) - with open(opj(project, fname), 'w') as fp: - fp.write(content) - - if theme != 'minimal': - shutil.copy(opj(THEME_DIR, theme, 'page.html'), project) - for fname in glob.glob(opj(THEME_DIR, theme, '*')): - print('info: copy theme data %r' % fname) - if os.path.basename(fname) == 'page.html': - continue - if os.path.isdir(fname): - shutil.copytree(fname, opj(dir_in, os.path.basename(fname))) - else: - shutil.copy(fname, dir_in) - - print("success: initialized project") - -# ============================================================================= -# build site -# ============================================================================= - -MKD_PATT = r'\.(?:md|mkd|mdown|markdown)$' - -def hx(s): - """ - Replace the characters that are special within HTML (&, <, > and ") - with their equivalent character entity (e.g., &). This should be - called whenever an arbitrary string is inserted into HTML (so in most - places where you use {{ variable }} in your templates). - - Note that " is not special in most HTML, only within attributes. - However, since escaping it does not hurt within normal HTML, it is - just escaped unconditionally. - """ - if getattr(s, 'escaped', False): - return s - - escape = { - "&": "&", - '"': """, - ">": ">", - "<": "<", - } - return ''.join(escape.get(c, c) for c in s) - -class Page(dict): - """Abstraction of a source page.""" - - _template = None # template dictionary - _opts = None # command line options - _pstrip = None # path prefix to strip from (non-virtual) page file names - - _re_eom = re.compile(r'^---+ *\r?\n?$') - _re_vardef = re.compile(r'^([^\n:=]+?)[:=]((?:.|\n )*)', re.MULTILINE) - _sec_macros = "macros" - _modmacs = None - - def __init__(self, fname, virtual=None, **attrs): - """Create a new page. - - Page content is read from `fname`, except when `virtual` is given (a - string representing the raw content of a virtual page). - - The filename refers to the page source file. For virtual pages, this - *must* be relative to a projects input directory. - - Virtual pages may contain page attribute definitions similar to real - pages. However, it probably is easier to provide the attributes - directly. This may be done using arbitrary keyword arguments. - - """ - super(Page, self).__init__() - - self.update(self._template) - self.update(attrs) - - self._virtual = virtual is not None - - fname = opj(self._pstrip, fname) if virtual else fname - - self["fname"] = fname - - self["url"] = re.sub(MKD_PATT, ".html", fname) - self["url"] = self["url"][len(self._pstrip):].lstrip(os.path.sep) - self["url"] = self["url"].replace(os.path.sep, "/") - - if virtual: - self.raw = virtual - else: - with codecs.open(fname, 'r', self._opts.input_enc) as fp: - self.raw = fp.readlines() - - # split raw content into macro definitions and real content - vardefs = "" - self.source = "" - for line in self.raw: - if not vardefs and self._re_eom.match(line): - vardefs = self.source - self.source = "" # only macro defs until here, reset source - else: - self.source += line - - for key, val in self._re_vardef.findall(vardefs): - key = key.strip() - val = val.strip() - val = re.sub(r' *\n +', ' ', val) # clean out line continuation - self[key] = val - - basename = os.path.basename(fname) - - fpatt = r'(.+?)(?:\.([0-9]+-[0-9]+-[0-9]+)(?:\.(.*))?)?%s' % MKD_PATT - title, date, post = re.match(fpatt, basename).groups() - title = title.replace("_", " ") - post = post and post.replace("_", " ") or None - self["title"] = self.get("title", title) - if date and "date" not in self: self["date"] = date - if post and "post" not in self: self["post"] = post - - self.html = "" - - def __getattr__(self, name): - """Attribute-style access to dictionary items.""" - try: - return self[name] - except KeyError: - raise AttributeError(name) - - def __str__(self): - """Page representation by file name.""" - return ('%s (virtual)' % self.fname) if self._virtual else self.fname - -# ----------------------------------------------------------------------------- - -def build(project, opts): - """Build a site project.""" - - # ------------------------------------------------------------------------- - # utilities - # ------------------------------------------------------------------------- - - def abort_iex(page, itype, inline, exc): - """Abort because of an exception in inlined Python code.""" - print("abort : Python %s in %s failed" % (itype, page)) - print((" %s raising the exception " % itype).center(79, "-")) - print(inline) - print(" exception ".center(79, "-")) - print(exc) - sys.exit(1) - - def copy(src, dst): - if os.path.islink(src): - linkto = os.readlink(src) - if os.path.isdir(dst): - dst = opj(dst, os.path.basename(src)) - os.symlink(linkto, dst) - else: - shutil.copy2(src, opj(dir_out, cwd_site)) - - # ------------------------------------------------------------------------- - # regex patterns and replacements - # ------------------------------------------------------------------------- - - regx_escp = re.compile(r'\\((?:(?:<|<)!--|{)(?:{|%))') # escaped code - repl_escp = r'\1' - regx_rurl = re.compile(r'(?<=(?:(?:\n| )src|href)=")([^#/&%].*?)(?=")') - repl_rurl = lambda m: urlparse.urljoin(opts.base_url, m.group(1)) - - regx_eval = re.compile(r'(?|}))', re.S) - - def repl_eval(m): - """Replace a Python expression block by its evaluation.""" - - expr = m.group(1) - try: - repl = eval(expr, macros.copy()) - except: - abort_iex(page, "expression", expr, traceback.format_exc()) - else: - if not isinstance(repl, basestring): # e.g. numbers - repl = unicode(repl) - elif not isinstance(repl, unicode): - repl = repl.decode("utf-8") - return repl - - regx_exec = re.compile(r'(?|}))', re.S) - - def repl_exec(m): - """Replace a block of Python statements by their standard output.""" - - stmt = m.group(1).replace("\r\n", "\n") - - # base indentation - ind_lvl = len(re.findall(r'^(?: *\n)*( *)', stmt, re.MULTILINE)[0]) - ind_rex = re.compile(r'^ {0,%d}' % ind_lvl, re.MULTILINE) - stmt = ind_rex.sub('', stmt) - - # execute - sys.stdout = StringIO.StringIO() - try: - exec stmt in macros.copy() - except: - sys.stdout = sys.__stdout__ - abort_iex(page, "statements", stmt, traceback.format_exc()) - else: - repl = sys.stdout.getvalue()[:-1] # remove last line break - sys.stdout = sys.__stdout__ - if not isinstance(repl, unicode): - repl = repl.decode(opts.input_enc) - return repl - - # ------------------------------------------------------------------------- - # preparations - # ------------------------------------------------------------------------- - - dir_in = opj(project, "input") - dir_out = opj(project, "output") - page_html = opj(project, "page.html") - - # check required files and folders - for pelem in (page_html, dir_in, dir_out): - if not opx(pelem): - print("abort : %s does not exist, looks like project has not been " - "initialized" % pelem) - sys.exit(1) - - # prepare output directory - for fod in glob.glob(opj(dir_out, "*")): - if os.path.isdir(fod): - shutil.rmtree(fod) - else: - os.remove(fod) - if not opx(dir_out): - os.mkdir(dir_out) - - # macro module - fname = opj(opts.project, "macros.py") - macros = imp.load_source("macros", fname).__dict__ if opx(fname) else {} - - macros["__encoding__"] = opts.output_enc - macros["options"] = opts - macros["project"] = project - macros["input"] = dir_in - macros["output"] = dir_out - - # "builtin" items for use in macros and templates - macros["hx"] = hx - macros["htmlspecialchars"] = hx # legacy name of `htmlx` function - macros["Page"] = Page - - # ------------------------------------------------------------------------- - # process input files - # ------------------------------------------------------------------------- - - Page._template = macros.get("page", {}) - Page._opts = opts - Page._pstrip = dir_in - pages = [] - custom_converter = macros.get('converter', {}) - - for cwd, dirs, files in os.walk(dir_in.decode(opts.filename_enc)): - cwd_site = cwd[len(dir_in):].lstrip(os.path.sep) - for sdir in dirs[:]: - if re.search(opts.ignore, opj(cwd_site, sdir)): - dirs.remove(sdir) - else: - os.mkdir(opj(dir_out, cwd_site, sdir)) - for f in files: - if re.search(opts.ignore, opj(cwd_site, f)): - pass - elif re.search(MKD_PATT, f): - page = Page(opj(cwd, f)) - pages.append(page) - else: - # either use a custom converter or do a plain copy - for patt, (func, ext) in custom_converter.items(): - if re.search(patt, f): - f_src = opj(cwd, f) - f_dst = opj(dir_out, cwd_site, f) - f_dst = '%s.%s' % (os.path.splitext(f_dst)[0], ext) - print('info : convert %s (%s)' % (f_src, func.__name__)) - func(f_src, f_dst) - break - else: - src = opj(cwd, f) - try: - copy(src, opj(dir_out, cwd_site)) - except OSError: - # some filesystems like FAT won't allow shutil.copy - shutil.copyfile(src, opj(dir_out, cwd_site, f)) - - pages.sort(key=lambda p: int(p.get("sval", "0"))) - - macros["pages"] = pages - - # ------------------------------------------------------------------------- - # run pre-convert hooks in macro module (named 'once' before) - # ------------------------------------------------------------------------- - - hooks = [a for a in macros if re.match(r'hook_preconvert_|once_', a)] - for fn in sorted(hooks): - macros[fn]() - - # ------------------------------------------------------------------------- - # convert pages (markdown to HTML) - # ------------------------------------------------------------------------- - - for page in pages: - - print("info : convert %s" % page) - - # replace expressions and statements in page source - macros["page"] = page - out = regx_eval.sub(repl_eval, page.source) - out = regx_exec.sub(repl_exec, out) - - # convert to HTML - page.html = markdown.Markdown(extensions=opts.md_ext).convert(out) - - # ------------------------------------------------------------------------- - # run post-convert hooks in macro module - # ------------------------------------------------------------------------- - - hooks = [a for a in macros if a.startswith("hook_postconvert_")] - for fn in sorted(hooks): - macros[fn]() - - # ------------------------------------------------------------------------- - # render complete HTML pages - # ------------------------------------------------------------------------- - - with codecs.open(opj(project, "page.html"), 'r', opts.input_enc) as fp: - skeleton = fp.read() - - for page in pages: - - print("info : render %s" % page.url) - - # replace expressions and statements in page.html - macros["page"] = page - macros["__content__"] = page.html - out = regx_eval.sub(repl_eval, skeleton) - out = regx_exec.sub(repl_exec, out) - - # un-escape escaped python code blocks - out = regx_escp.sub(repl_escp, out) - - # make relative links absolute - out = regx_rurl.sub(repl_rurl, out) - - # write HTML page - fname = page.fname.replace(dir_in, dir_out) - fname = re.sub(MKD_PATT, ".html", fname) - with codecs.open(fname, 'w', opts.output_enc) as fp: - fp.write(out) - - print("success: built project") - -# ============================================================================= -# serve site -# ============================================================================= - -def serve(project, port): - """Temporary serve a site project.""" - - root = opj(project, "output") - if not os.listdir(project): - print("abort : output dir is empty (build project first!)") - sys.exit(1) - - os.chdir(root) - server = HTTPServer(('', port), SimpleHTTPRequestHandler) - server.serve_forever() - -# ============================================================================= -# options -# ============================================================================= - -def options(): - """Parse and validate command line arguments.""" - - usage = ("Usage: %prog --init [OPTIONS] [path/to/project]\n" - " %prog --build [OPTIONS] [path/to/project]\n" - " %prog --serve [OPTIONS] [path/to/project]\n" - "\n" - " Project path is optional, '.' is used as default.") - - op = optparse.OptionParser(usage=usage) - - op.add_option("-i" , "--init", action="store_true", default=False, - help="init project") - op.add_option("-b" , "--build", action="store_true", default=False, - help="build project") - op.add_option("-s" , "--serve", action="store_true", default=False, - help="serve project") - - og = optparse.OptionGroup(op, "Init options") - og.add_option("", "--theme", type="choice", default="minimal", - choices=THEME_NAMES, - help="theme for a new project (choices: %s)" % ', '.join(THEME_NAMES)) - op.add_option_group(og) - - og = optparse.OptionGroup(op, "Build options") - og.add_option("", "--base-url", default="/", metavar="URL", - help="base url for relative links (default: /)") - og.add_option("" , "--ignore", default=r"^\.|~$", metavar="REGEX", - help="input files to ignore (default: '^\.|~$')") - og.add_option("" , "--md-ext", default=[], metavar="EXT", - action="append", help="enable a markdown extension") - og.add_option("", "--input-enc", default="utf-8", metavar="ENC", - help="encoding of input pages (default: utf-8)") - og.add_option("", "--output-enc", default="utf-8", metavar="ENC", - help="encoding of output pages (default: utf-8)") - og.add_option("", "--filename-enc", default="utf-8", metavar="ENC", - help="encoding of file names (default: utf-8)") - op.add_option_group(og) - - og = optparse.OptionGroup(op, "Serve options") - og.add_option("" , "--port", default=8080, - metavar="PORT", type="int", - help="port for serving (default: 8080)") - op.add_option_group(og) - - opts, args = op.parse_args() - - if opts.init + opts.build + opts.serve < 1: - op.print_help() - op.exit() - - opts.project = args and args[0] or "." - - return opts - -# ============================================================================= -# main -# ============================================================================= - -def main(): - - opts = options() - - if opts.init: - init(opts.project, opts.theme) - if opts.build: - build(opts.project, opts) - if opts.serve: - serve(opts.project, opts.port) - -if __name__ == '__main__': - - main() -- cgit v1.2.3-74-g34f1