simplify the expected feed structure

I don't think there's any need for a million directories, on second
thought, so just put YYMMDD prefixed files in the feed/ directory

Signed-off-by: Brian S. Stephan <bss@incorporeal.org>

.gitignore

@@ -117,3 +117,6 @@ dmypy.json
 
 # vim stuff
 *.swp
+
+# autogenerated versioning
+_version.py

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# How to Contribute
+
+incorporeal-cms is a personal project seeking to implement a simpler, cleaner form of what would
+commonly be called a "CMS". I appreciate any help in making it better.
+
+incorporeal-cms is made available under the GNU Affero General Public License version 3, or any
+later version.
+
+## Opening Issues
+
+Issues should be posted to my Gitea instance at
+<https://git.incorporeal.org/bss/incorporeal-cms/issues>. I'm not too picky about format, but I
+recommend starting the title with "Improvement:", "Bug:", or similar, so I can do a high level of
+prioritization.
+
+## Contributions
+
+### Sign Offs/Custody of Contributions
+
+I do not request the copyright of contributions be assigned to me or to the project, and I require no provision that I
+be allowed to relicense your contributions. My personal oath is to maintain inbound=outbound in my open source projects,
+and the expectation is authors are responsible for their contributions.
+
+I am following the the [Developer Certificate of Origin (DCO)](https://developercertificate.org/), also available at
+`DCO.txt`. The DCO is a way for contributors to certify that they wrote or otherwise have the right to license their
+code contributions to the project. Contributors must sign-off that they adhere to these requirements by adding a
+`Signed-off-by` line to their commit message, and/or, for frequent contributors, by signing off on their entry in
+`MAINTAINERS.md`.
+
+This process is followed by a number of open source projects, most notably the Linux kernel. Here's the gist of it:
+
+```
+[Your normal Git commit message here.]
+
+Signed-off-by: Random J Developer <random@developer.example.org>
+```
+
+`git help commit` has more info on adding this:
+
+```
+-s, --signoff
+    Add Signed-off-by line by the committer at the end of the commit log
+    message. The meaning of a signoff depends on the project, but it typically
+    certifies that committer has the rights to submit this work under the same
+    license and agrees to a Developer Certificate of Origin (see
+    http://developercertificate.org/ for more information).
+```
+
+### Submitting Contributions
+
+I don't expect contributors to sign up for my personal Gitea in order to send contributions, but it
+of course makes it easier. If you wish to go this route, please sign up at
+<https://git.incorporeal.org/bss/incorporeal-cms> and fork the project. People planning on
+contributing often are also welcome to request access to the project directly.
+
+Otherwise, contact me via any means you know to reach me at, or <bss@incorporeal.org>, to discuss
+your change and to tell me how to pull your changes.
+
+### Guidelines for Patches, etc.
+
+* Cloning
+    * Clone the project. I would advise using a pull-based workflow where I have access to the hosted
+      repository --- using my Gitea, cloning to a public GitHub, etc. --- rather than doing this over
+      email, but that works too if we must.
+    * Make your contributions in a new branch, generally off of `master`.
+    * Send me a pull request when you're ready, and we'll go through a code review.
+* Code:
+    * Keep in mind that I strive for simplicity in the software. It serves files and renders
+      Markdown, that's pretty much it. Features around that function are good; otherwise, I need
+      convincing.
+    * Follow the style precedent set in the code. Do **not** use Black, or otherwise reformat existing
+      code. I like it the way it is and don't need a militant tool making bad decisions about what is
+      readable.
+    * `tox` should run cleanly, of course.
+    * Almost any change should include unit tests, and also functional tests if they provide a feature
+      to the CMS functionality. For defects, include unit tests that fail on the unfixed codebase, so I
+      know exactly what's happening.
+* Commits:
+    * Squash tiny commits if you'd like. I prefer commits that make one atomic conceptual change
+      that doesn't affect the rest of the code, assembling multiple of those commits into larger
+      changes.
+    * Follow something like [Chris Beams's post](https://chris.beams.io/posts/git-commit/) on
+      formatting a good commit message.
+    * Please make sure your Author contact information is stable, in case I need to reach you.
+    * Consider cryptographically signing (`git commit -S`) your commits.

DCO.txt

@@ -0,0 +1,34 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.

MAINTAINERS.md

@@ -0,0 +1,10 @@
+# Maintainers
+
+This file contains information about people permitted to make major decisions and direction on the project.
+
+## Contributing Under the DCO
+
+By adding your name and email address to this section, you certify that all of your subsequent contributions to
+incorporeal-cms are made under the terms of the Developer's Certificate of Origin 1.1, available at `DCO.txt`.
+
+* Brian S. Stephan (<bss@incorporeal.org>)

README.md

@@ -1,3 +1,66 @@
 # incorporeal-cms
 
-Software that makes incorporeal.org go.
+Software that makes simple Markdown content go.
+
+## Installation and Usage
+
+I recommend getting a release from <https://git.incorporeal.org/bss/incorporeal-cms/releases> and
+installing the Python package in a virtualenv. Something like the following should suffice:
+
+```
+% cd ~/site
+% virtualenv --python=python3.8 env-py3.8
+% source env-py3.8/bin/activate
+% pip install -U pip
+% pip install ~/incorporeal_cms-1.3.0-py3-none-any.whl
+% pip install -U gunicorn
+% gunicorn -w 5 -t 60 -b 127.0.0.1:10000 --reload 'incorporealcms:create_app()'
+```
+
+This will get the CMS up and running, and listening on the specified port. The application is
+further configured within `env-py3.8/var/incorporealcms-instance/config.py`, and content is served
+out of `env-py3.8/var/incorporealcms-instance/pages/`.
+
+## Serving a Site
+
+Put content inside `env-py3.8/var/incorporealcms-instance/pages/` and go.
+
+* Markdown files (ending in `.md`) are rendered via Python-Markdown if they are accessed without the
+  suffix (i.e., `post.md` should be referred to as `/post` to get it to render as Markdown.
+* Directory paths (e.g. `/dir/`) can be rendered with a `/dir/index.md` file.
+* Symlinks to files are treated as redirects to the destination content.
+* Request paths with file suffixes are not rendered and served directly, so images, etc., can be
+  referenced naturally, and even the unrendered Markdown can be served as a text file via e.g.
+  `/post.md`.
+
+Care is taken to not serve content above the `pages/` dir, even via symlink.
+
+## Configuration
+
+I've tried to keep the software agnostic to my personal domains, logos, etc. There are some settings
+you are probably interested in tweaking, by specifying new values in
+`incorporealcms-instance/config.py`:
+
+* `TITLE_SUFFIX` is appended to the title of every page, separated from other title content by a
+  dash.
+* `CONTACT_EMAIL` is referred to in error templates.
+* `FAVICON` supplies the image used in browser tabs and that kind of thing.
+
+If I missed anything, please let me know.
+
+## Author and Licensing
+
+Written by and copyright Brian S. Stephan (bss@incorporeal.org).
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

incorporealcms/__init__.py

@@ -1,14 +1,13 @@
-"""An application for running my Markdown-based sites."""
+"""An application for running my Markdown-based sites.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 import logging
 import os
 from logging.config import dictConfig
 
-from flask import Flask, request, send_from_directory
+from flask import Flask, request
-
-from ._version import get_versions
-
-__version__ = get_versions()['version']
-del get_versions
 
 
 def create_app(instance_path=None, test_config=None):
@@ -40,12 +39,12 @@ def create_app(instance_path=None, test_config=None):
         logger.info("RESPONSE: %s %s: %s", request.method, request.path, response.status)
         return response
 
-    @app.route(f'/{app.config["MEDIA_DIR"]}/<path:filename>')
+    from . import error_pages, feed, pages, static
-    def media_files(filename):
+    app.register_blueprint(feed.bp)
-        return send_from_directory(os.path.join(app.instance_path, app.config['MEDIA_DIR']),
-                                   filename)
-
-    from . import pages
     app.register_blueprint(pages.bp)
+    app.register_blueprint(static.bp)
+    app.register_error_handler(400, error_pages.bad_request)
+    app.register_error_handler(404, error_pages.page_not_found)
+    app.register_error_handler(500, error_pages.internal_server_error)
 
     return app

incorporealcms/_version.py

@@ -1,520 +0,0 @@
-
-# This file helps to compute a version number in source trees obtained from
-# git-archive tarball (such as those provided by githubs download-from-tag
-# feature). Distribution tarballs (built by setup.py sdist) and build
-# directories (produced by setup.py build) will contain a much shorter file
-# that just contains the computed version number.
-
-# This file is released into the public domain. Generated by
-# versioneer-0.18 (https://github.com/warner/python-versioneer)
-
-"""Git implementation of _version.py."""
-
-import errno
-import os
-import re
-import subprocess
-import sys
-
-
-def get_keywords():
-    """Get the keywords needed to look up the version information."""
-    # these strings will be replaced by git during git-archive.
-    # setup.py/versioneer.py will grep for the variable names, so they must
-    # each be defined on a line of their own. _version.py will just call
-    # get_keywords().
-    git_refnames = "$Format:%d$"
-    git_full = "$Format:%H$"
-    git_date = "$Format:%ci$"
-    keywords = {"refnames": git_refnames, "full": git_full, "date": git_date}
-    return keywords
-
-
-class VersioneerConfig:
-    """Container for Versioneer configuration parameters."""
-
-
-def get_config():
-    """Create, populate and return the VersioneerConfig() object."""
-    # these strings are filled in when 'setup.py versioneer' creates
-    # _version.py
-    cfg = VersioneerConfig()
-    cfg.VCS = "git"
-    cfg.style = "pep440-post"
-    cfg.tag_prefix = "v"
-    cfg.parentdir_prefix = "None"
-    cfg.versionfile_source = "incorporealcms/_version.py"
-    cfg.verbose = False
-    return cfg
-
-
-class NotThisMethod(Exception):
-    """Exception raised if a method is not valid for the current scenario."""
-
-
-LONG_VERSION_PY = {}
-HANDLERS = {}
-
-
-def register_vcs_handler(vcs, method):  # decorator
-    """Decorator to mark a method as the handler for a particular VCS."""
-    def decorate(f):
-        """Store f in HANDLERS[vcs][method]."""
-        if vcs not in HANDLERS:
-            HANDLERS[vcs] = {}
-        HANDLERS[vcs][method] = f
-        return f
-    return decorate
-
-
-def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
-                env=None):
-    """Call the given command(s)."""
-    assert isinstance(commands, list)
-    p = None
-    for c in commands:
-        try:
-            dispcmd = str([c] + args)
-            # remember shell=False, so use git.cmd on windows, not just git
-            p = subprocess.Popen([c] + args, cwd=cwd, env=env,
-                                 stdout=subprocess.PIPE,
-                                 stderr=(subprocess.PIPE if hide_stderr
-                                         else None))
-            break
-        except EnvironmentError:
-            e = sys.exc_info()[1]
-            if e.errno == errno.ENOENT:
-                continue
-            if verbose:
-                print("unable to run %s" % dispcmd)
-                print(e)
-            return None, None
-    else:
-        if verbose:
-            print("unable to find command, tried %s" % (commands,))
-        return None, None
-    stdout = p.communicate()[0].strip()
-    if sys.version_info[0] >= 3:
-        stdout = stdout.decode()
-    if p.returncode != 0:
-        if verbose:
-            print("unable to run %s (error)" % dispcmd)
-            print("stdout was %s" % stdout)
-        return None, p.returncode
-    return stdout, p.returncode
-
-
-def versions_from_parentdir(parentdir_prefix, root, verbose):
-    """Try to determine the version from the parent directory name.
-
-    Source tarballs conventionally unpack into a directory that includes both
-    the project name and a version string. We will also support searching up
-    two directory levels for an appropriately named parent directory
-    """
-    rootdirs = []
-
-    for i in range(3):
-        dirname = os.path.basename(root)
-        if dirname.startswith(parentdir_prefix):
-            return {"version": dirname[len(parentdir_prefix):],
-                    "full-revisionid": None,
-                    "dirty": False, "error": None, "date": None}
-        else:
-            rootdirs.append(root)
-            root = os.path.dirname(root)  # up a level
-
-    if verbose:
-        print("Tried directories %s but none started with prefix %s" %
-              (str(rootdirs), parentdir_prefix))
-    raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
-
-
-@register_vcs_handler("git", "get_keywords")
-def git_get_keywords(versionfile_abs):
-    """Extract version information from the given file."""
-    # the code embedded in _version.py can just fetch the value of these
-    # keywords. When used from setup.py, we don't want to import _version.py,
-    # so we do it with a regexp instead. This function is not used from
-    # _version.py.
-    keywords = {}
-    try:
-        f = open(versionfile_abs, "r")
-        for line in f.readlines():
-            if line.strip().startswith("git_refnames ="):
-                mo = re.search(r'=\s*"(.*)"', line)
-                if mo:
-                    keywords["refnames"] = mo.group(1)
-            if line.strip().startswith("git_full ="):
-                mo = re.search(r'=\s*"(.*)"', line)
-                if mo:
-                    keywords["full"] = mo.group(1)
-            if line.strip().startswith("git_date ="):
-                mo = re.search(r'=\s*"(.*)"', line)
-                if mo:
-                    keywords["date"] = mo.group(1)
-        f.close()
-    except EnvironmentError:
-        pass
-    return keywords
-
-
-@register_vcs_handler("git", "keywords")
-def git_versions_from_keywords(keywords, tag_prefix, verbose):
-    """Get version information from git keywords."""
-    if not keywords:
-        raise NotThisMethod("no keywords at all, weird")
-    date = keywords.get("date")
-    if date is not None:
-        # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant
-        # datestamp. However we prefer "%ci" (which expands to an "ISO-8601
-        # -like" string, which we must then edit to make compliant), because
-        # it's been around since git-1.5.3, and it's too difficult to
-        # discover which version we're using, or to work around using an
-        # older one.
-        date = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
-    refnames = keywords["refnames"].strip()
-    if refnames.startswith("$Format"):
-        if verbose:
-            print("keywords are unexpanded, not using")
-        raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
-    refs = set([r.strip() for r in refnames.strip("()").split(",")])
-    # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
-    # just "foo-1.0". If we see a "tag: " prefix, prefer those.
-    TAG = "tag: "
-    tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
-    if not tags:
-        # Either we're using git < 1.8.3, or there really are no tags. We use
-        # a heuristic: assume all version tags have a digit. The old git %d
-        # expansion behaves like git log --decorate=short and strips out the
-        # refs/heads/ and refs/tags/ prefixes that would let us distinguish
-        # between branches and tags. By ignoring refnames without digits, we
-        # filter out many common branch names like "release" and
-        # "stabilization", as well as "HEAD" and "master".
-        tags = set([r for r in refs if re.search(r'\d', r)])
-        if verbose:
-            print("discarding '%s', no digits" % ",".join(refs - tags))
-    if verbose:
-        print("likely tags: %s" % ",".join(sorted(tags)))
-    for ref in sorted(tags):
-        # sorting will prefer e.g. "2.0" over "2.0rc1"
-        if ref.startswith(tag_prefix):
-            r = ref[len(tag_prefix):]
-            if verbose:
-                print("picking %s" % r)
-            return {"version": r,
-                    "full-revisionid": keywords["full"].strip(),
-                    "dirty": False, "error": None,
-                    "date": date}
-    # no suitable tags, so version is "0+unknown", but full hex is still there
-    if verbose:
-        print("no suitable tags, using unknown + full revision id")
-    return {"version": "0+unknown",
-            "full-revisionid": keywords["full"].strip(),
-            "dirty": False, "error": "no suitable tags", "date": None}
-
-
-@register_vcs_handler("git", "pieces_from_vcs")
-def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
-    """Get version from 'git describe' in the root of the source tree.
-
-    This only gets called if the git-archive 'subst' keywords were *not*
-    expanded, and _version.py hasn't already been rewritten with a short
-    version string, meaning we're inside a checked out source tree.
-    """
-    GITS = ["git"]
-    if sys.platform == "win32":
-        GITS = ["git.cmd", "git.exe"]
-
-    out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root,
-                          hide_stderr=True)
-    if rc != 0:
-        if verbose:
-            print("Directory %s not under git control" % root)
-        raise NotThisMethod("'git rev-parse --git-dir' returned error")
-
-    # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
-    # if there isn't one, this yields HEX[-dirty] (no NUM)
-    describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty",
-                                          "--always", "--long",
-                                          "--match", "%s*" % tag_prefix],
-                                   cwd=root)
-    # --long was added in git-1.5.5
-    if describe_out is None:
-        raise NotThisMethod("'git describe' failed")
-    describe_out = describe_out.strip()
-    full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
-    if full_out is None:
-        raise NotThisMethod("'git rev-parse' failed")
-    full_out = full_out.strip()
-
-    pieces = {}
-    pieces["long"] = full_out
-    pieces["short"] = full_out[:7]  # maybe improved later
-    pieces["error"] = None
-
-    # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
-    # TAG might have hyphens.
-    git_describe = describe_out
-
-    # look for -dirty suffix
-    dirty = git_describe.endswith("-dirty")
-    pieces["dirty"] = dirty
-    if dirty:
-        git_describe = git_describe[:git_describe.rindex("-dirty")]
-
-    # now we have TAG-NUM-gHEX or HEX
-
-    if "-" in git_describe:
-        # TAG-NUM-gHEX
-        mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
-        if not mo:
-            # unparseable. Maybe git-describe is misbehaving?
-            pieces["error"] = ("unable to parse git-describe output: '%s'"
-                               % describe_out)
-            return pieces
-
-        # tag
-        full_tag = mo.group(1)
-        if not full_tag.startswith(tag_prefix):
-            if verbose:
-                fmt = "tag '%s' doesn't start with prefix '%s'"
-                print(fmt % (full_tag, tag_prefix))
-            pieces["error"] = ("tag '%s' doesn't start with prefix '%s'"
-                               % (full_tag, tag_prefix))
-            return pieces
-        pieces["closest-tag"] = full_tag[len(tag_prefix):]
-
-        # distance: number of commits since tag
-        pieces["distance"] = int(mo.group(2))
-
-        # commit: short hex revision ID
-        pieces["short"] = mo.group(3)
-
-    else:
-        # HEX: no tags
-        pieces["closest-tag"] = None
-        count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"],
-                                    cwd=root)
-        pieces["distance"] = int(count_out)  # total number of commits
-
-    # commit date: see ISO-8601 comment in git_versions_from_keywords()
-    date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"],
-                       cwd=root)[0].strip()
-    pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
-
-    return pieces
-
-
-def plus_or_dot(pieces):
-    """Return a + if we don't already have one, else return a ."""
-    if "+" in pieces.get("closest-tag", ""):
-        return "."
-    return "+"
-
-
-def render_pep440(pieces):
-    """Build up version string, with post-release "local version identifier".
-
-    Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
-    get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
-
-    Exceptions:
-    1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
-    """
-    if pieces["closest-tag"]:
-        rendered = pieces["closest-tag"]
-        if pieces["distance"] or pieces["dirty"]:
-            rendered += plus_or_dot(pieces)
-            rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
-            if pieces["dirty"]:
-                rendered += ".dirty"
-    else:
-        # exception #1
-        rendered = "0+untagged.%d.g%s" % (pieces["distance"],
-                                          pieces["short"])
-        if pieces["dirty"]:
-            rendered += ".dirty"
-    return rendered
-
-
-def render_pep440_pre(pieces):
-    """TAG[.post.devDISTANCE] -- No -dirty.
-
-    Exceptions:
-    1: no tags. 0.post.devDISTANCE
-    """
-    if pieces["closest-tag"]:
-        rendered = pieces["closest-tag"]
-        if pieces["distance"]:
-            rendered += ".post.dev%d" % pieces["distance"]
-    else:
-        # exception #1
-        rendered = "0.post.dev%d" % pieces["distance"]
-    return rendered
-
-
-def render_pep440_post(pieces):
-    """TAG[.postDISTANCE[.dev0]+gHEX] .
-
-    The ".dev0" means dirty. Note that .dev0 sorts backwards
-    (a dirty tree will appear "older" than the corresponding clean one),
-    but you shouldn't be releasing software with -dirty anyways.
-
-    Exceptions:
-    1: no tags. 0.postDISTANCE[.dev0]
-    """
-    if pieces["closest-tag"]:
-        rendered = pieces["closest-tag"]
-        if pieces["distance"] or pieces["dirty"]:
-            rendered += ".post%d" % pieces["distance"]
-            if pieces["dirty"]:
-                rendered += ".dev0"
-            rendered += plus_or_dot(pieces)
-            rendered += "g%s" % pieces["short"]
-    else:
-        # exception #1
-        rendered = "0.post%d" % pieces["distance"]
-        if pieces["dirty"]:
-            rendered += ".dev0"
-        rendered += "+g%s" % pieces["short"]
-    return rendered
-
-
-def render_pep440_old(pieces):
-    """TAG[.postDISTANCE[.dev0]] .
-
-    The ".dev0" means dirty.
-
-    Eexceptions:
-    1: no tags. 0.postDISTANCE[.dev0]
-    """
-    if pieces["closest-tag"]:
-        rendered = pieces["closest-tag"]
-        if pieces["distance"] or pieces["dirty"]:
-            rendered += ".post%d" % pieces["distance"]
-            if pieces["dirty"]:
-                rendered += ".dev0"
-    else:
-        # exception #1
-        rendered = "0.post%d" % pieces["distance"]
-        if pieces["dirty"]:
-            rendered += ".dev0"
-    return rendered
-
-
-def render_git_describe(pieces):
-    """TAG[-DISTANCE-gHEX][-dirty].
-
-    Like 'git describe --tags --dirty --always'.
-
-    Exceptions:
-    1: no tags. HEX[-dirty]  (note: no 'g' prefix)
-    """
-    if pieces["closest-tag"]:
-        rendered = pieces["closest-tag"]
-        if pieces["distance"]:
-            rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
-    else:
-        # exception #1
-        rendered = pieces["short"]
-    if pieces["dirty"]:
-        rendered += "-dirty"
-    return rendered
-
-
-def render_git_describe_long(pieces):
-    """TAG-DISTANCE-gHEX[-dirty].
-
-    Like 'git describe --tags --dirty --always -long'.
-    The distance/hash is unconditional.
-
-    Exceptions:
-    1: no tags. HEX[-dirty]  (note: no 'g' prefix)
-    """
-    if pieces["closest-tag"]:
-        rendered = pieces["closest-tag"]
-        rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
-    else:
-        # exception #1
-        rendered = pieces["short"]
-    if pieces["dirty"]:
-        rendered += "-dirty"
-    return rendered
-
-
-def render(pieces, style):
-    """Render the given version pieces into the requested style."""
-    if pieces["error"]:
-        return {"version": "unknown",
-                "full-revisionid": pieces.get("long"),
-                "dirty": None,
-                "error": pieces["error"],
-                "date": None}
-
-    if not style or style == "default":
-        style = "pep440"  # the default
-
-    if style == "pep440":
-        rendered = render_pep440(pieces)
-    elif style == "pep440-pre":
-        rendered = render_pep440_pre(pieces)
-    elif style == "pep440-post":
-        rendered = render_pep440_post(pieces)
-    elif style == "pep440-old":
-        rendered = render_pep440_old(pieces)
-    elif style == "git-describe":
-        rendered = render_git_describe(pieces)
-    elif style == "git-describe-long":
-        rendered = render_git_describe_long(pieces)
-    else:
-        raise ValueError("unknown style '%s'" % style)
-
-    return {"version": rendered, "full-revisionid": pieces["long"],
-            "dirty": pieces["dirty"], "error": None,
-            "date": pieces.get("date")}
-
-
-def get_versions():
-    """Get version information or return default if unable to do so."""
-    # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
-    # __file__, we can work backwards from there to the root. Some
-    # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
-    # case we can only use expanded keywords.
-
-    cfg = get_config()
-    verbose = cfg.verbose
-
-    try:
-        return git_versions_from_keywords(get_keywords(), cfg.tag_prefix,
-                                          verbose)
-    except NotThisMethod:
-        pass
-
-    try:
-        root = os.path.realpath(__file__)
-        # versionfile_source is the relative path from the top of the source
-        # tree (where the .git directory might live) to this file. Invert
-        # this to find the root from __file__.
-        for i in cfg.versionfile_source.split('/'):
-            root = os.path.dirname(root)
-    except NameError:
-        return {"version": "0+unknown", "full-revisionid": None,
-                "dirty": None,
-                "error": "unable to find root of source tree",
-                "date": None}
-
-    try:
-        pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose)
-        return render(pieces, cfg.style)
-    except NotThisMethod:
-        pass
-
-    try:
-        if cfg.parentdir_prefix:
-            return versions_from_parentdir(cfg.parentdir_prefix, root, verbose)
-    except NotThisMethod:
-        pass
-
-    return {"version": "0+unknown", "full-revisionid": None,
-            "dirty": None,
-            "error": "unable to compute version", "date": None}

incorporealcms/config.py

@@ -1,4 +1,8 @@
-"""Default configuration."""
+"""Default configuration.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 
 
 class Config(object):
@@ -32,10 +36,9 @@ class Config(object):
         },
     }
 
-    MARKDOWN_EXTENSIONS = ['extra', 'mdx_linkify', 'smarty', 'tables']
+    MARKDOWN_EXTENSIONS = ['extra', 'incorporealcms.mdx.figures', 'sane_lists', 'smarty', 'toc']
     MARKDOWN_EXTENSION_CONFIGS = {
         'extra': {
-            'attr_list': {},
             'footnotes': {
                 'UNIQUE_IDS': True,
             },
@@ -48,7 +51,21 @@ class Config(object):
         },
     }
 
-    DEFAULT_PAGE_STYLE = 'light'
-
-    TITLE_SUFFIX = 'incorporeal.org'
     MEDIA_DIR = 'media'
+
+    # customizations
+    PAGE_STYLES = {
+        'dark': '/static/css/dark.css',
+        'light': '/static/css/light.css',
+        'plain': '/static/css/plain.css',
+    }
+
+    DEFAULT_PAGE_STYLE = 'light'
+    DOMAIN_NAME = 'example.com'
+    TITLE_SUFFIX = DOMAIN_NAME
+    CONTACT_EMAIL = 'admin@example.com'
+
+    # feed settings
+    AUTHOR = {'name': 'Test Name', 'email': 'admin@example.com'}
+
+    # specify FAVICON in your instance config.py to override the provided icon

incorporealcms/error_pages.py

@@ -0,0 +1,21 @@
+"""Error page views for 400, 404, etc.
+
+SPDX-FileCopyrightText: © 2021 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+from incorporealcms.lib import render
+
+
+def bad_request(error):
+    """Display 400 error messaging."""
+    return render('400.html'), 400
+
+
+def internal_server_error(error):
+    """Display 500 error messaging."""
+    return render('500.html'), 500
+
+
+def page_not_found(error):
+    """Display 404 error messaging."""
+    return render('404.html'), 404

incorporealcms/feed.py

@@ -0,0 +1,73 @@
+"""Generate Atom and RSS feeds based on content in a blog-ish location.
+
+This parses a special root directory, feed/, for YYYYMMDD-foo.md files,
+and combines them into an Atom or RSS feed. These files *should* be symlinks
+to the real pages, which may mirror the same YYYYMMDD-foo.md file naming scheme
+under pages/ (which may make sense for a blog) if they want, but could just
+as well be pages/foo content.
+
+SPDX-FileCopyrightText: © 2023 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import logging
+import os
+import re
+
+from feedgen.feed import FeedGenerator
+from flask import Blueprint, Response, abort
+from flask import current_app as app
+
+from incorporealcms.lib import instance_resource_path_to_request_path, parse_md
+
+logger = logging.getLogger(__name__)
+
+bp = Blueprint('feed', __name__, url_prefix='/feed')
+
+
+@bp.route('/<feed_type>')
+def serve_feed(feed_type):
+    """Serve the Atom or RSS feed as requested."""
+    logger.warning("wat")
+    if feed_type not in ('atom', 'rss'):
+        abort(404)
+
+    fg = FeedGenerator()
+    fg.id(f'https://{app.config["DOMAIN_NAME"]}/')
+    fg.title(f'{app.config["TITLE_SUFFIX"]}')
+    fg.author(app.config["AUTHOR"])
+    fg.link(href=f'https://{app.config["DOMAIN_NAME"]}/feed/{feed_type}', rel='self')
+    fg.link(href=f'https://{app.config["DOMAIN_NAME"]}', rel='alternate')
+    fg.subtitle(f"Blog posts and other dated materials from {app.config['TITLE_SUFFIX']}")
+
+    # get recent feeds
+    feed_path = os.path.join(app.instance_path, 'feed')
+    feed_entry_paths = [os.path.join(dirpath, filename) for dirpath, _, filenames in os.walk(feed_path)
+                        for filename in filenames if os.path.islink(os.path.join(dirpath, filename))]
+    for feed_entry_path in sorted(feed_entry_paths):
+        # get the actual file to parse it
+        resolved_path = os.path.realpath(feed_entry_path).replace(f'{app.instance_path}/', '')
+        try:
+            content, md, page_name, page_title, mtime = parse_md(resolved_path)
+            link = f'https://{app.config["DOMAIN_NAME"]}/{instance_resource_path_to_request_path(resolved_path)}'
+        except (OSError, ValueError, TypeError):
+            logger.exception("error loading/rendering markdown!")
+            abort(500)
+
+        fe = fg.add_entry()
+        fe.id(_generate_feed_id(feed_entry_path))
+        fe.title(page_name if page_name else page_title)
+        fe.author(app.config["AUTHOR"])
+        fe.link(href=link)
+        fe.content(content, type='html')
+
+    if feed_type == 'atom':
+        return Response(fg.atom_str(pretty=True), mimetype='application/atom+xml')
+    else:
+        return Response(fg.rss_str(pretty=True), mimetype='application/rss+xml')
+
+
+def _generate_feed_id(feed_entry_path):
+    """For a relative file path, generate the Atom/RSS feed ID for it."""
+    date = re.sub(r'.*(\d{4})(\d{2})(\d{2}).*', r'\1-\2-\3', feed_entry_path)
+    cleaned = feed_entry_path.replace('#', '/').replace('feed/', '', 1).replace(app.instance_path, '')
+    return f'tag:{app.config["DOMAIN_NAME"]},{date}:{cleaned}'

incorporealcms/lib.py

@@ -1,6 +1,19 @@
-"""Miscellaneous helper functions and whatnot."""
+"""Miscellaneous helper functions and whatnot.
+
+SPDX-FileCopyrightText: © 2021 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import datetime
+import logging
+import os
+import re
+
 import markdown
 from flask import current_app as app
+from flask import make_response, render_template, request
+from markupsafe import Markup
+
+logger = logging.getLogger(__name__)
 
 
 def get_meta_str(md, key):
@@ -19,3 +32,63 @@ def init_md():
     # extensions our app depends on, like the meta extension
     return markdown.Markdown(extensions=app.config['MARKDOWN_EXTENSIONS'] + ['meta'],
                              extension_configs=app.config['MARKDOWN_EXTENSION_CONFIGS'])
+
+
+def instance_resource_path_to_request_path(path):
+    """Reverse a (presumed to exist) RELATIVE disk path to the canonical path that would show up in a Flask route.
+
+    This does not include the leading /, so aside from the root index case, this should be
+    bidirectional.
+    """
+    return re.sub(r'^pages/', '', re.sub(r'.md$', '', re.sub(r'index.md$', '', path)))
+
+
+def parse_md(resolved_path):
+    """Given a file to parse, return file content and other derived data along with the md object."""
+    try:
+        logger.debug("opening resolved path '%s'", resolved_path)
+        with app.open_instance_resource(resolved_path, 'r') as entry_file:
+            mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), tz=datetime.timezone.utc)
+            entry = entry_file.read()
+        logger.debug("resolved path '%s' read", resolved_path)
+        md = init_md()
+        content = Markup(md.convert(entry))
+    except OSError:
+        logger.exception("resolved path '%s' could not be opened!", resolved_path)
+        raise
+    except ValueError:
+        logger.exception("error parsing/rendering markdown!")
+        raise
+    except TypeError:
+        logger.exception("error loading/rendering markdown!")
+        raise
+
+    logger.debug("file metadata: %s", md.Meta)
+
+    page_name = (get_meta_str(md, 'title') if md.Meta.get('title') else
+                 f'/{instance_resource_path_to_request_path(resolved_path)}')
+    page_title = f'{page_name} - {app.config["TITLE_SUFFIX"]}' if page_name else app.config['TITLE_SUFFIX']
+    logger.debug("title (potentially derived): %s", page_title)
+
+    return content, md, page_name, page_title, mtime
+
+
+def render(template_name_or_list, **context):
+    """Wrap Flask's render_template.
+
+    * Determine the proper site theme to use in the template and provide it.
+    """
+    page_styles = app.config['PAGE_STYLES']
+    selected_style = request.args.get('style', None)
+    if selected_style:
+        user_style = selected_style
+    else:
+        user_style = request.cookies.get('user-style')
+        logger.debug("user style cookie: %s", user_style)
+    context['user_style'] = page_styles.get(user_style, page_styles.get(app.config['DEFAULT_PAGE_STYLE']))
+    context['page_styles'] = page_styles
+
+    resp = make_response(render_template(template_name_or_list, **context))
+    if selected_style:
+        resp.set_cookie('user-style', selected_style)
+    return resp

incorporealcms/mdx/__init__.py

@@ -0,0 +1,5 @@
+"""Markdown extensions.
+
+SPDX-FileCopyrightText: © 2021 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""

incorporealcms/mdx/figures.py

@@ -0,0 +1,64 @@
+"""Create generic figures with captions.
+
+SPDX-FileCopyrightText: © 2022 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import re
+from xml.etree.ElementTree import SubElement  # nosec B405 - not parsing untrusted XML here
+
+import markdown
+
+
+class FigureExtension(markdown.Extension):
+    """Wrap the markdown prepcoressor."""
+
+    def extendMarkdown(self, md):
+        """Add FigureBlockProcessor to the Markdown instance."""
+        md.parser.blockprocessors.register(FigureBlockProcessor(md.parser), 'figure', 100)
+
+
+class FigureBlockProcessor(markdown.blockprocessors.BlockProcessor):
+    """Process figures."""
+
+    # |> thing to put in the figure
+    # |: optional caption for the figure
+    # optional whatever else, like maybe an attr_list
+    figure_regex = re.compile(r'^[ ]{0,3}\|>[ ]{0,3}(?P<content>[^\n]*)')
+    caption_regex = re.compile(r'^[ ]{0,3}\|:[ ]{0,3}(?P<caption>[^\n]*)')
+
+    def test(self, parent, block):
+        """Determine if we should process this block."""
+        lines = block.split('\n')
+        return bool(self.figure_regex.search(lines[0]))
+
+    def run(self, parent, blocks):
+        """Replace the top block with HTML."""
+        block = blocks.pop(0)
+        lines = block.split('\n')
+
+        # consume line and create a figure
+        figure_match = self.figure_regex.search(lines[0])
+        lines.pop(0)
+        content = figure_match.group('content')
+        figure = SubElement(parent, 'figure')
+        figure.text = content
+        if lines:
+            if caption_match := self.caption_regex.search(lines[0]):
+                # consume line and add the caption as a child of the figure
+                lines.pop(0)
+                caption = caption_match.group('caption')
+                figcaption = SubElement(figure, 'figcaption')
+                figcaption.text = caption
+        if lines:
+            # other lines are mysteries, might be attr_list, so re-append
+            # make sure there's a child to hang the rest (which is maybe an attr_list?) off of
+            # this is probably a bad hack
+            if not len(list(figure)):
+                SubElement(figure, 'span')
+            rest = '\n'.join(lines)
+            figure[-1].tail = f'\n{rest}'
+
+
+def makeExtension(*args, **kwargs):
+    """Provide the extension to the markdown extension loader."""
+    return FigureExtension(*args, **kwargs)

incorporealcms/mdx/pydot.py

@@ -0,0 +1,58 @@
+"""Serve dot diagrams inline.
+
+SPDX-FileCopyrightText: © 2021 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import base64
+import logging
+import re
+
+import markdown
+import pydot
+
+logger = logging.getLogger(__name__)
+
+
+class InlinePydot(markdown.Extension):
+    """Wrap the markdown prepcoressor."""
+
+    def extendMarkdown(self, md):
+        """Add InlinePydotPreprocessor to the Markdown instance."""
+        md.preprocessors.register(InlinePydotPreprocessor(md), 'dot_block', 100)
+
+
+class InlinePydotPreprocessor(markdown.preprocessors.Preprocessor):
+    """Identify dot codeblocks and run them through pydot."""
+
+    BLOCK_RE = re.compile(r'~~~{\s+pydot:(?P<filename>[^\s]+)\s+}\n(?P<content>.*?)~~~', re.DOTALL)
+
+    def run(self, lines):
+        """Match and generate diagrams from dot code blocks."""
+        text = '\n'.join(lines)
+        out = text
+        for block_match in self.BLOCK_RE.finditer(text):
+            filename = block_match.group(1)
+            dot_string = block_match.group(2)
+            logger.debug("matched markdown block: %s", dot_string)
+            logger.debug("match start/end: %s/%s", block_match.start(), block_match.end())
+
+            # use pydot to turn the text into pydot
+            graphs = pydot.graph_from_dot_data(dot_string)
+            if not graphs:
+                logger.debug("some kind of issue with parsed 'dot' %s", dot_string)
+                raise ValueError("error parsing dot text!")
+
+            # encode the image and provide as an inline image in markdown
+            encoded_image = base64.b64encode(graphs[0].create_png()).decode('ascii')
+            data_path = f'data:image/png;base64,{encoded_image}'
+            inline_image = f'![{filename}]({data_path})'
+
+            # replace the image in the output markdown
+            out = out.replace(block_match.group(0), inline_image)
+
+        return out.split('\n')
+
+
+def makeExtension(*args, **kwargs):
+    """Provide the extension to the markdown extension loader."""
+    return InlinePydot(*args, **kwargs)

incorporealcms/pages.py

@@ -1,14 +1,18 @@
-"""General page functionality."""
+"""General page functionality.
-import datetime
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 import logging
 import os
 
-from flask import Blueprint, Markup, abort
+from flask import Blueprint, abort
 from flask import current_app as app
-from flask import make_response, redirect, render_template, request
+from flask import redirect, request, send_from_directory
-from tzlocal import get_localzone
+from markupsafe import Markup
+from werkzeug.security import safe_join
 
-from incorporealcms.lib import get_meta_str, init_md
+from incorporealcms.lib import get_meta_str, init_md, instance_resource_path_to_request_path, parse_md, render
 
 logger = logging.getLogger(__name__)
 
@@ -19,101 +23,158 @@ bp = Blueprint('pages', __name__, url_prefix='/')
 @bp.route('/<path:path>')
 def display_page(path):
     """Get the file contents of the requested path and render the file."""
-    if is_file_path_actually_dir_path(path):
-        return redirect(f'{path}/', code=301)
-
-    resolved_path = resolve_page_file(path)
-    logger.debug("received request for path '%s', resolved to '%s'", path, resolved_path)
     try:
-        with app.open_instance_resource(resolved_path, 'r') as entry_file:
+        resolved_path, render_type = request_path_to_instance_resource_path(path)
-            logger.debug("file '%s' found", resolved_path)
+        logger.debug("received request for path '%s', resolved to '%s', type '%s'",
-            parent_navs = generate_parent_navs(path)
+                     path, resolved_path, render_type)
-            mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), get_localzone())
+    except PermissionError:
-            entry = entry_file.read()
+        abort(400)
+    except IsADirectoryError:
+        return redirect(f'/{path}/', code=301)
     except FileNotFoundError:
-        logger.warning("requested path '%s' (resolved path '%s') not found!", path, resolved_path)
         abort(404)
+
+    if render_type == 'file':
+        return send_from_directory(app.instance_path, resolved_path)
+    elif render_type == 'symlink':
+        logger.debug("attempting to redirect path '%s' to reverse of resource '%s'", path, resolved_path)
+        redirect_path = f'/{instance_resource_path_to_request_path(resolved_path)}'
+        logger.debug("redirect path: '%s'", redirect_path)
+        return redirect(redirect_path, code=301)
+    elif render_type == 'markdown':
+        logger.debug("treating path '%s' as markdown '%s'", path, resolved_path)
+        return handle_markdown_file_path(resolved_path)
     else:
-        md = init_md()
+        logger.exception("unsupported render_type '%s'!?", render_type)
-        content = Markup(md.convert(entry))
+        abort(500)
-        logger.debug("file metadata: %s", md.Meta)
-
-        return render('base.html', title=get_meta_str(md, 'title'), description=get_meta_str(md, 'description'),
-                      image=get_meta_str(md, 'image'), base_url=request.base_url, content=content, navs=parent_navs,
-                      mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
 
 
-def render(template_name_or_list, **context):
+def handle_markdown_file_path(resolved_path):
-    """Wrap Flask's render_template.
+    """Given a location on disk, attempt to open it and render the markdown within."""
-
+    try:
-    * Determine the proper site theme to use in the template and provide it.
+        content, md, page_name, page_title, mtime = parse_md(resolved_path)
-    """
+    except OSError:
-    PAGE_STYLES = {
+        logger.exception("resolved path '%s' could not be opened!", resolved_path)
-        'dark': 'css/dark.css',
+        abort(500)
-        'light': 'css/light.css',
+    except ValueError:
-    }
+        logger.exception("error parsing/rendering markdown!")
-
+        abort(500)
-    selected_style = request.args.get('style', None)
+    except TypeError:
-    if selected_style:
+        logger.exception("error loading/rendering markdown!")
-        user_style = selected_style
+        abort(500)
     else:
-        user_style = request.cookies.get('user-style')
+        parent_navs = generate_parent_navs(resolved_path)
-        logger.debug("user style cookie: %s", user_style)
+        extra_footer = get_meta_str(md, 'footer') if md.Meta.get('footer') else None
-    context['user_style'] = PAGE_STYLES.get(user_style, PAGE_STYLES.get(app.config['DEFAULT_PAGE_STYLE']))
+        template = get_meta_str(md, 'template') if md.Meta.get('template') else 'base.html'
 
-    resp = make_response(render_template(template_name_or_list, **context))
+        # check if this has a HTTP redirect
-    if selected_style:
+        redirect_url = get_meta_str(md, 'redirect') if md.Meta.get('redirect') else None
-        resp.set_cookie('user-style', selected_style)
+        if redirect_url:
-    return resp
+            logger.debug("redirecting via meta tag to '%s'", redirect_url)
+            return redirect(redirect_url, code=301)
+
+        return render(template, title=page_title, description=get_meta_str(md, 'description'),
+                      image=get_meta_str(md, 'image'), base_url=request.base_url, content=content,
+                      navs=parent_navs, mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'),
+                      extra_footer=extra_footer)
 
 
-def resolve_page_file(path):
+def request_path_to_instance_resource_path(path):
-    """Manipulate the request path to find appropriate page file.
+    """Turn a request URL path to the full page path.
 
-    * convert dir requests to index files
+    flask.Flask.open_instance_resource will open a file like /etc/hosts if you tell it to,
-
+    which sucks, so we do a lot of work here to make sure we have a valid request to
-    Worth noting, Flask already does stuff like convert '/foo/../../../bar' to
+    something inside the pages dir.
-    '/bar', so we don't need to take care around file access here.
     """
-    if path.endswith('/'):
+    # check if the path is allowed
-        path = f'{path}index'
+    base_dir = os.path.realpath(f'{app.instance_path}/pages/')
-    path = f'pages/{path}.md'
+    safe_path = safe_join(base_dir, path)
-    return path
+    # bail if the requested real path isn't inside the base directory
+    if not safe_path:
+        logger.warning("client tried to request a path '%s' outside of the base_dir!", path)
+        raise PermissionError
 
+    verbatim_path = os.path.abspath(safe_path)
+    resolved_path = os.path.realpath(verbatim_path)
+    logger.debug("base_dir '%s', constructed resolved_path '%s' for path '%s'", base_dir, resolved_path, path)
 
-def is_file_path_actually_dir_path(path):
+    # see if we have a real file or if we should infer markdown rendering
-    """Check if requested path which looks like a file is actually a directory.
+    if os.path.exists(resolved_path):
+        # if this is a file-like request but actually a directory, redirect the user
+        if os.path.isdir(resolved_path) and not path.endswith('/'):
+            logger.info("client requested a path '%s' that is actually a directory", path)
+            raise IsADirectoryError
 
-    If, for example, /foo used to be a file (foo.md) which later became a directory,
+        # if the requested path contains a symlink, redirect the user
-    foo/, this returns True. Useful for when I make my structure more complicated
+        if verbatim_path != resolved_path:
-    than it originally was, or if users are just weird.
+            logger.info("client requested a path '%s' that is actually a symlink to file '%s'", path, resolved_path)
-    """
+            return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'symlink'
-    if not path.endswith('/'):
-        logger.debug("requested path '%s' looks like a file", path)
-        if os.path.isdir(f'{app.instance_path}/pages/{path}'):
-            logger.debug("...and it's actually a dir")
-            return True
 
-    return False
+        # derive the proper markdown or actual file depending on if this is a dir or file
+        if os.path.isdir(resolved_path):
+            resolved_path = os.path.join(resolved_path, 'index.md')
+            return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'markdown'
+
+        logger.info("final DIRECT path = '%s' for request '%s'", resolved_path, path)
+        return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'file'
+
+    # if we're here, this isn't direct file access, so try markdown inference
+    verbatim_path = f'{safe_path}.md'
+    resolved_path = os.path.realpath(verbatim_path)
+
+    # does the final file actually exist?
+    if not os.path.exists(resolved_path):
+        logger.warning("requested final path '%s' does not exist!", resolved_path)
+        raise FileNotFoundError
+
+    # check for symlinks
+    if verbatim_path != resolved_path:
+        logger.info("client requested a path '%s' that is actually a symlink to file '%s'", path, resolved_path)
+        return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'symlink'
+
+    logger.info("final path = '%s' for request '%s'", resolved_path, path)
+    # we checked that the file exists via absolute path, but now we need to give the path relative to instance dir
+    return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'markdown'
 
 
 def generate_parent_navs(path):
-    """Create a series of paths/links to navigate up from the given path."""
+    """Create a series of paths/links to navigate up from the given resource path."""
-    # derive additional path/location stuff based on path
+    if path == 'pages/index.md':
-    resolved_path = resolve_page_file(path)
+        # bail and return the domain name as a terminal case
-    parent_dir = os.path.dirname(resolved_path)
+        return [(app.config['DOMAIN_NAME'], '/')]
-    parent_path = '/'.join(path[:-1].split('/')[:-1]) + '/'
-
-    logger.debug("path: '%s'; parent path: '%s'; resolved path: '%s'; parent dir: '%s'",
-                 path, parent_path, resolved_path, parent_dir)
-
-    if path in ('index', '/'):
-        return [(app.config['TITLE_SUFFIX'], '/')]
     else:
-        with app.open_instance_resource(resolved_path, 'r') as entry_file:
+        if path.endswith('index.md'):
-            entry = entry_file.read()
+            # index case: one dirname for foo/bar/index.md -> foo/bar, one for foo/bar -> foo
+            parent_resource_dir = os.path.dirname(os.path.dirname(path))
+        else:
+            # usual case: foo/buh.md -> foo
+            parent_resource_dir = os.path.dirname(path)
+
+        # generate the request path (i.e. what the link will be) for this path, and
+        # also the resource path of this parent (which is always a dir, so always index.md)
+        request_path = f'/{instance_resource_path_to_request_path(path)}'
+        parent_resource_path = os.path.join(parent_resource_dir, 'index.md')
+
+        logger.debug("resource path: '%s'; request path: '%s'; parent resource path: '%s'", path,
+                     request_path, parent_resource_path)
+
         # for issues regarding parser reuse (see lib.init_md) we reinitialize the parser here
         md = init_md()
+
+        # read the resource
+        try:
+            with app.open_instance_resource(path, 'r') as entry_file:
+                entry = entry_file.read()
             _ = Markup(md.convert(entry))
-        page_name = " ".join(md.Meta.get('title')) if md.Meta.get('title') else f'/{path}'
+            page_name = (" ".join(md.Meta.get('title')) if md.Meta.get('title')
-        return generate_parent_navs(parent_path) + [(page_name, f'/{path}')]
+                         else request_path_to_breadcrumb_display(request_path))
+            return generate_parent_navs(parent_resource_path) + [(page_name, request_path)]
+        except FileNotFoundError:
+            return generate_parent_navs(parent_resource_path) + [(request_path, request_path)]
+
+
+def request_path_to_breadcrumb_display(path):
+    """Given a request path, e.g. "/foo/bar/baz/", turn it into breadcrumby text "baz"."""
+    undired = path.rstrip('/')
+    leaf = undired[undired.rfind('/'):]
+    return leaf.strip('/')

incorporealcms/static.py

@@ -0,0 +1,18 @@
+"""Serve static files from the instance directory.
+
+SPDX-FileCopyrightText: © 2022 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import os
+
+from flask import Blueprint
+from flask import current_app as app
+from flask import send_from_directory
+
+bp = Blueprint('static', __name__, url_prefix='/custom-static')
+
+
+@bp.route('/<path:name>')
+def serve_instance_static_file(name):
+    """Serve a static file from the instance directory, used for customization."""
+    return send_from_directory(os.path.join(app.instance_path, 'custom-static'), name)

incorporealcms/static/css/base.css

@@ -11,77 +11,43 @@ body {
     -webkit-text-size-adjust: 100%;
 }
 
+.site-wrap-normal-width {
+    max-width: 65pc;
+}
+
+.site-wrap-double-width {
+    max-width: 130pc;
+}
+
 .site-wrap {
-    max-width: 70pc;
     min-height: 100vh;
     margin: 0;
     margin-left: auto;
     margin-right: auto;
 }
 
-h1 {
+a {
-    font-size: 2em;
-}
-
-h2 {
-    font-size: 1.5em;
-}
-
-h3 {
-    font-size: 1.25em;
-}
-
-h4 {
-    font-size: 1.17em;
-}
-
-h5 {
-    font-size: 1em;
-}
-
-h6 {
-    font-size: .83em;
-}
-
-a:link {
     font-weight: bold;
-    text-decoration: none;
+    text-decoration-line: underline;
-}
+    text-decoration-thickness: 1px;
-
-a:visited {
-    font-weight: bold;
-    text-decoration: none;
-}
-
-a:hover {
-    font-weight: bold;
-    text-decoration: none;
-}
-
-a:active {
-    font-weight: bold;
-    text-decoration: none;
 }
 
 div.header {
     display: flex;
     justify-content: space-between;
-}
+    font-size: 0.8em;
-
+    padding: 1rem 1rem;
-div.nav, div.styles {
+    padding-bottom: 0;
-    font-size: 0.75em;
-    padding: 0.25em 0.5em;
-}
-
-div.nav a, div.styles a {
-    border-bottom: none;
 }
 
 div.content {
     font-size: 11pt;
+    padding: 0 1rem;
+    line-height: 1.6em;
+}
 
-    padding: 0 1em;
+div.content p {
-    line-height: 1.5em;
+    margin: 1.25em 0;
 }
 
 sup, sub {
@@ -94,12 +60,17 @@ sub {
 }
 
 footer {
+    clear: both;
     display: block;
     font-size: 75%;
     color: #999;
     padding: 0 1em;
     padding-bottom: 16px;
-    margin-top: 15px;
+    margin-top: 30px;
+}
+
+.extra-footer {
+    margin-bottom: 5px;
 }
 
 table {
@@ -135,6 +106,10 @@ img {
     max-width: 50% !important;
 }
 
+.img-75 {
+    max-width: 75% !important;
+}
+
 .img-center {
     display: block;
     margin-left: auto;
@@ -151,39 +126,26 @@ img {
     margin-left: 1em;
 }
 
-.img-frame {
-    padding: 5px;
-}
-
-/* For screens with width smaller than 400px */
-.figure-left .figure-right {
-    max-width: 95%;
-    float: none;
-    margin-left: 10px;
-    margin-right: 10px;
-}
-
-/* For larger screens */
-@media only screen and (min-width: 400px) {
-    .figure-left {
-        float: left;
-        margin-top: 0;
-        margin-left: 0;
-    }
-
-    .figure-right {
-        float: right;
-        margin-top: 0;
-        margin-right: 0;
-    }
-}
-
 figure {
-    max-width: 400px;
     padding: 5px;
-    margin: 10px;
+    margin: 0;
-    margin-top: 0;
     margin-bottom: 5px;
+    text-align: center;
+    max-width: 30%;
+    min-width: 10em;
+    display: inline-block;
+}
+
+figure.right {
+    float: right;
+    margin-left: 10px;
+    display: block;
+}
+
+figure.left {
+    float: left;
+    margin-right: 10px;
+    display: block;
 }
 
 figure img {
@@ -192,19 +154,8 @@ figure img {
 }
 
 figcaption {
-    font-family: "Times New Roman", serif;
-    color: #777777;
     text-align: center;
-    font-style: italic;
+    font-size: 0.9em;
-    line-height: 1.3em;
-    margin-top: 5px;
-}
-
-.thumbnail-image {
-    width: 150px;
-    height: auto;
-    margin: 5px;
-    display: inline;
 }
 
 .footnote {
@@ -216,6 +167,5 @@ figcaption {
 }
 
 .footnote-ref:link, .footnote-ref:visited, .footnote-ref:hover, .footnote-ref:active {
-    border-bottom: none;
     font-weight: normal;
 }

incorporealcms/static/css/dark.css

@@ -1,48 +1,37 @@
+/* common styling via the base.css, used in light and dark */
+@import '/static/css/base.css';
+
 html {
-    color: #CCC;
+    color: #DDD;
 }
 
 body {
-    background: black;
-}
-
-strong {
-    color: #EEE;
-}
-
-.site-wrap {
     background: #111;
-
-    border: 1px solid #222;
-    border-top: none;
-    border-bottom: none;
 }
 
 h1, h2, h3, h4, h5, h6 {
     color: #B31D15;
 }
 
-a:link, a:visited {
+p a, ul a, ol a {
-    color: #EEE;
+    color: #DDD;
-    border-bottom: 1px dotted #EEE;
 }
 
-a:hover, a:active {
+footer a {
+    color: #999;
+}
+
+p a:hover, ul a:hover, ol a:hover, footer a:hover {
     color: #B31D15;
-    border-bottom: 1px dotted #B31D15;
 }
 
-div.header {
+div.site-wrap {
-    background: #222;
+    background: black;
-    border-bottom: 1px solid #222;
 }
 
-div.nav, div.styles {
+div.header, div.header a {
-    color: #BBB;
+    color: #555;
-}
+    text-decoration: none;
-
-div.nav a, div.styles a {
-    color: #BBB;
 }
 
 table, th, td {
@@ -58,16 +47,11 @@ blockquote {
     border: 1px solid #222;
 }
 
-.img-frame {
+figure {
     background-color: rgba(255, 255, 255, 0.1);
     border: 1px solid #333;
 }
 
-figure {
-    background: #222;
-    border: 1px solid #333;
-}
-
 figcaption {
-    color: #BBB;
+    color: #AAAAAA;
 }

incorporealcms/static/css/light.css

@@ -1,73 +1,57 @@
+/* common styling via the base.css, used in light and dark */
+@import '/static/css/base.css';
+
 html {
     color: #222;
 }
 
 body {
-    background: #999;
+    background: #EEE;
-}
-
-strong {
-    color: #111;
-}
-
-.site-wrap {
-    background: white;
-
-    border: 1px solid #ddd;
-    border-top: none;
-    border-bottom: none;
 }
 
 h1, h2, h3, h4, h5, h6 {
     color: #811610;
 }
 
-a:link, a:visited {
+p a, ul a, ol a {
-    color: #111;
+    color: #222;
-    border-bottom: 1px dotted #111;
 }
 
-a:hover, a:active {
+footer a {
+    color: #999;
+}
+
+p a:hover, ul a:hover, ol a:hover, footer a:hover {
     color: #811610;
-    border-bottom: 1px dotted #811610;
 }
 
-div.header {
+div.site-wrap {
-    background: #EEE;
+    background: white;
-    border-bottom: 1px solid #CCC;
 }
 
-div.nav, div.styles {
+div.header, div.header a {
-    color: #666;
+    color: #AAA;
-}
+    text-decoration: none;
-
-div.nav a, div.styles a {
-    color: #666;
 }
 
 table, th, td {
-    border: 1px solid #ccc;
+    border: 1px solid #CCC;
 }
 
 th {
-    background: #eee;
+    background: #CCC;
 }
 
 blockquote {
     background-color: rgba(120, 120, 120, 0.1);
-    border: 1px solid #CCC;
+    border: 1px solid #DDD;
-}
-
-.img-frame {
-    background-color: rgba(0, 0, 0, 0.1);
-    border: 1px solid #BBB;
 }
 
 figure {
-    background: #EFEFEF;
+    background-color: rgba(0, 0, 0, 0.1);
-    border: 1px solid #CCCCCC;
+    border: 1px solid #CCC;
 }
 
 figcaption {
-    color: #777777;
+    color: #666666;
 }

incorporealcms/static/css/plain.css

@@ -0,0 +1,33 @@
+/* specify almost no styling, just fix some image and nav rendering */
+div.header {
+    display: flex;
+    justify-content: space-between;
+}
+
+.img-25 {
+    max-width: 25% !important;
+}
+
+.img-50 {
+    max-width: 50% !important;
+}
+
+.img-75 {
+    max-width: 75% !important;
+}
+
+.img-center {
+    display: block;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+.img-left {
+    float: left;
+    margin-right: 1em;
+}
+
+.img-right {
+    float: right;
+    margin-left: 1em;
+}

incorporealcms/templates/400.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+
+{% block header %}
+<div class="header">
+    <a href="/">{{ config.TITLE_SUFFIX }}</a>
+</div>
+{% endblock %}
+
+{% block body %}
+<div class="content">
+    <h1>BAD REQUEST</h1>
+    <p>You're doing something you're not supposed to. Stop it?</p>
+</div>
+{% endblock %}

incorporealcms/templates/404.html

@@ -0,0 +1,19 @@
+{% extends "base.html" %}
+
+{% block header %}
+<div class="header">
+    <a href="/">{{ config.TITLE_SUFFIX }}</a>
+</div>
+{% endblock %}
+
+{% block body %}
+<div class="content">
+    <h1>NOT FOUND</h1>
+    <p>Sorry, <b><tt>{{ request.path }}</tt></b> does not seem to exist, at least not anymore.</p>
+    <p>It's possible you followed a dead link on this site, in which case I would appreciate it if you could email me at
+    {{ config.CONTACT_EMAIL }} and I can take a look. I make an effort to symlink old content to its new location,
+    so old links and URLs should, generally speaking, work.</p>
+    <p>Otherwise, I suggest you go <a href="/">to the index</a> and navigate your way (hopefully) to what
+    you're looking for.</p>
+</div>
+{% endblock %}

incorporealcms/templates/500.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+
+{% block header %}
+<div class="header">
+    <a href="/">{{ config.TITLE_SUFFIX }}</a>
+</div>
+{% endblock %}
+
+{% block body %}
+<div class="content">
+    <h1>INTERNAL SERVER ERROR</h1>
+    <p>Something bad happened! Please email me at {{ config.CONTACT_EMAIL }} and tell me what happened.</p>
+</div>
+{% endblock %}

incorporealcms/templates/base-wide.html

@@ -0,0 +1,2 @@
+{% extends "base.html" %}
+{% block site_class %}class="site-wrap site-wrap-double-width"{% endblock %}

incorporealcms/templates/base.html

@@ -1,17 +1,19 @@
 <!doctype html>
 <html lang="en">
-<title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
+<title>{{ title }}</title>
 {% if title %}<meta property="og:title" content="{{ title }}">{% endif %}
 {% if description %}<meta property="og:description" content="{{ description }}">{% endif %}
 {% if image %}<meta property="og:image" content="{{ image }}">{% endif %}
 <meta property="og:url" content="{{ base_url }}">
 <meta name="twitter:card" content="summary_large_image">
 <meta name="viewport" content="width=device-width, initial-scale=1">
-<link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
+<link rel="stylesheet" href="{{ user_style }}">
-<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}">
+<link rel="icon" href="{% if config.FAVICON %}{{ config.FAVICON }}{% else %}{{ url_for('static', filename='img/favicon.png') }}{% endif %}">
-<link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
+<link rel="alternate" type="application/atom+xml" href="/feed/atom" />
+<link rel="alternate" type="application/rss+xml" href="/feed/rss" />
 
-<div class="site-wrap">
+<div {% block site_class %}class="site-wrap site-wrap-normal-width"{% endblock %}>
+    {% block header %}
     <div class="header">
         <div class="nav">
             {% for nav in navs %}
@@ -20,15 +22,20 @@
             {% endfor %}
         </div>
         <div class="styles">
-            <a href="?style=dark">[dark]</a>
+            {% for style in page_styles %}
-            <a href="?style=light">[light]</a>
+            <a href="?style={{ style }}">[{{ style }}]</a>
+            {% endfor %}
         </div>
     </div>
+    {% endblock %}
+    {% block body %}
     <div class="content">
         {{ content }}
     </div>
     <footer>
-        <i>Last modified: {{ mtime }}</i>
+        {% if extra_footer %}<div class="extra-footer"><i>{{ extra_footer|safe }}</i></div>{% endif %}
+        <div class="footer"><i>Last modified: {{ mtime }}</i></div>
     </footer>
+    {% endblock %}
 </div>
 </html>

pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "incorporeal-cms"
+description = "A CMS for serving Markdown files with a bit of dynamicism."
+readme = "README.md"
+license = {text = "AGPL-3.0-or-later"}
+authors = [
+	{name = "Brian S. Stephan", email = "bss@incorporeal.org"},
+]
+requires-python = ">=3.8"
+dependencies = ["feedgen", "Flask", "Markdown"]
+dynamic = ["version"]
+classifiers = [
+	"Framework :: Flask",
+	"Programming Language :: Python :: 3",
+	"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+	"Operating System :: OS Independent",
+	"Topic :: Text Processing :: Markup :: Markdown",
+]
+
+[project.urls]
+"Homepage" = "https://git.incorporeal.org/bss/incorporeal-cms"
+"Changelog" = "https://git.incorporeal.org/bss/incorporeal-cms/releases"
+"Bug Tracker" = "https://git.incorporeal.org/bss/incorporeal-cms/issues"
+
+
+[project.optional-dependencies]
+dev = ["bandit", "dlint", "flake8", "flake8-blind-except", "flake8-builtins", "flake8-docstrings",
+       "flake8-executable", "flake8-fixme", "flake8-isort", "flake8-logging-format", "flake8-mutable",
+       "flake8-pyproject", "mypy", "pip-tools", "pydot", "pytest", "pytest-cov", "safety",
+       "setuptools-scm", "tox"]
+dot = ["pydot"]
+
+[tool.flake8]
+enable-extensions = "G,M"
+exclude = [".tox/", "venv/", "_version.py"]
+extend-ignore = "T101"
+max-complexity = 10
+max-line-length = 120
+
+[tool.isort]
+line_length = 120
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+python_files = ["*_tests.py", "tests.py", "test_*.py"]
+
+[tool.setuptools_scm]
+write_to = "incorporealcms/_version.py"

requirements/requirements-dev.in

@@ -1,24 +0,0 @@
--r requirements.in
-
-# testing runner, test reporting, packages used during testing (e.g. requests-mock), etc.
-pytest
-pytest-cov
-
-# linting and other static code analysis
-bandit==1.6.2               # pinned because 1.7.0 wasn't running right in tox
-dlint
-flake8
-flake8-blind-except
-flake8-builtins
-flake8-docstrings
-flake8-executable
-flake8-fixme
-flake8-isort
-flake8-logging-format
-flake8-mutable
-
-# maintenance utilities and tox
-pip-tools                   # pip-compile
-tox                         # CI stuff
-tox-wheel                   # build wheels in tox
-versioneer                  # automatic version numbering

requirements/requirements-dev.txt

@@ -1,151 +1,191 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with Python 3.12
-# To update, run:
+# by the following command:
 #
-#    pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in
+#    pip-compile --extra=dev --output-file=requirements/requirements-dev.txt
 #
-appdirs==1.4.4
+bandit==1.7.6
-    # via virtualenv
+    # via incorporeal-cms (pyproject.toml)
-attrs==20.3.0
+blinker==1.7.0
-    # via pytest
+    # via flask
-bandit==1.6.2
+build==1.0.3
-    # via -r requirements/requirements-dev.in
+    # via pip-tools
-bleach==3.2.2
+cachetools==5.3.2
-    # via mdx-linkify
+    # via tox
-click==7.1.2
+certifi==2023.11.17
+    # via requests
+chardet==5.2.0
+    # via tox
+charset-normalizer==3.3.2
+    # via requests
+click==8.1.7
     # via
     #   flask
     #   pip-tools
-coverage==5.3.1
+    #   safety
-    # via pytest-cov
+colorama==0.4.6
-distlib==0.3.1
+    # via tox
+coverage[toml]==7.4.0
+    # via
+    #   coverage
+    #   pytest-cov
+distlib==0.3.8
     # via virtualenv
-dlint==0.11.0
+dlint==0.14.1
-    # via -r requirements/requirements-dev.in
+    # via incorporeal-cms (pyproject.toml)
-filelock==3.0.12
+dparse==0.6.3
+    # via safety
+feedgen==1.0.0
+    # via incorporeal-cms (pyproject.toml)
+filelock==3.13.1
     # via
     #   tox
     #   virtualenv
-flake8-blind-except==0.2.0
+flake8==6.1.0
-    # via -r requirements/requirements-dev.in
-flake8-builtins==1.5.3
-    # via -r requirements/requirements-dev.in
-flake8-docstrings==1.5.0
-    # via -r requirements/requirements-dev.in
-flake8-executable==2.1.1
-    # via -r requirements/requirements-dev.in
-flake8-fixme==1.1.1
-    # via -r requirements/requirements-dev.in
-flake8-isort==4.0.0
-    # via -r requirements/requirements-dev.in
-flake8-logging-format==0.6.0
-    # via -r requirements/requirements-dev.in
-flake8-mutable==1.2.0
-    # via -r requirements/requirements-dev.in
-flake8==3.8.4
     # via
-    #   -r requirements/requirements-dev.in
     #   dlint
     #   flake8-builtins
     #   flake8-docstrings
     #   flake8-executable
     #   flake8-isort
     #   flake8-mutable
-flask==1.1.2
+    #   flake8-pyproject
-    # via -r requirements/requirements.in
+    #   incorporeal-cms (pyproject.toml)
-gitdb==4.0.5
+flake8-blind-except==0.2.1
+    # via incorporeal-cms (pyproject.toml)
+flake8-builtins==2.2.0
+    # via incorporeal-cms (pyproject.toml)
+flake8-docstrings==1.7.0
+    # via incorporeal-cms (pyproject.toml)
+flake8-executable==2.1.3
+    # via incorporeal-cms (pyproject.toml)
+flake8-fixme==1.1.1
+    # via incorporeal-cms (pyproject.toml)
+flake8-isort==6.1.1
+    # via incorporeal-cms (pyproject.toml)
+flake8-logging-format==0.9.0
+    # via incorporeal-cms (pyproject.toml)
+flake8-mutable==1.2.0
+    # via incorporeal-cms (pyproject.toml)
+flake8-pyproject==1.2.3
+    # via incorporeal-cms (pyproject.toml)
+flask==3.0.0
+    # via incorporeal-cms (pyproject.toml)
+gitdb==4.0.11
     # via gitpython
-gitpython==3.1.12
+gitpython==3.1.40
     # via bandit
-iniconfig==1.1.1
+idna==3.6
+    # via requests
+iniconfig==2.0.0
     # via pytest
-isort==5.7.0
+isort==5.13.2
     # via flake8-isort
-itsdangerous==1.1.0
+itsdangerous==2.1.2
     # via flask
-jinja2==2.11.2
+jinja2==3.1.2
     # via flask
-markdown==3.3.3
+lxml==5.0.0
+    # via feedgen
+markdown==3.5.1
+    # via incorporeal-cms (pyproject.toml)
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.3
     # via
-    #   -r requirements/requirements.in
+    #   jinja2
-    #   mdx-linkify
+    #   werkzeug
-markupsafe==1.1.1
+mccabe==0.7.0
-    # via jinja2
-mccabe==0.6.1
     # via flake8
-mdx-linkify==2.1
+mdurl==0.1.2
-    # via -r requirements/requirements.in
+    # via markdown-it-py
-packaging==20.8
+mypy==1.8.0
+    # via incorporeal-cms (pyproject.toml)
+mypy-extensions==1.0.0
+    # via mypy
+packaging==21.3
     # via
-    #   bleach
+    #   build
+    #   dparse
+    #   pyproject-api
     #   pytest
+    #   safety
+    #   setuptools-scm
     #   tox
-pbr==5.5.1
+pbr==6.0.0
     # via stevedore
-pip-tools==5.5.0
+pip-tools==7.3.0
-    # via -r requirements/requirements-dev.in
+    # via incorporeal-cms (pyproject.toml)
-pluggy==0.13.1
+platformdirs==4.1.0
     # via
-    #   pytest
-    #   tox
-py==1.10.0
-    # via
-    #   pytest
-    #   tox
-pycodestyle==2.6.0
-    # via flake8
-pydocstyle==5.1.1
-    # via flake8-docstrings
-pyflakes==2.2.0
-    # via flake8
-pyparsing==2.4.7
-    # via packaging
-pytest-cov==2.11.1
-    # via -r requirements/requirements-dev.in
-pytest==6.2.1
-    # via
-    #   -r requirements/requirements-dev.in
-    #   pytest-cov
-pytz==2020.5
-    # via tzlocal
-pyyaml==5.4.1
-    # via bandit
-six==1.15.0
-    # via
-    #   bandit
-    #   bleach
     #   tox
     #   virtualenv
-smmap==3.0.4
+pluggy==1.3.0
-    # via gitdb
-snowballstemmer==2.1.0
-    # via pydocstyle
-stevedore==3.3.0
-    # via bandit
-testfixtures==6.17.1
-    # via flake8-isort
-toml==0.10.2
     # via
     #   pytest
     #   tox
-tox-wheel==0.6.0
+pycodestyle==2.11.1
-    # via -r requirements/requirements-dev.in
+    # via flake8
-tox==3.21.2
+pydocstyle==6.3.0
+    # via flake8-docstrings
+pydot==1.4.2
+    # via incorporeal-cms (pyproject.toml)
+pyflakes==3.1.0
+    # via flake8
+pygments==2.17.2
+    # via rich
+pyparsing==3.1.1
     # via
-    #   -r requirements/requirements-dev.in
+    #   packaging
-    #   tox-wheel
+    #   pydot
-tzlocal==2.1
+pyproject-api==1.5.0
-    # via -r requirements/requirements.in
-versioneer==0.19
-    # via -r requirements/requirements-dev.in
-virtualenv==20.4.0
     # via tox
-webencodings==0.5.1
+pyproject-hooks==1.0.0
-    # via bleach
+    # via build
-werkzeug==1.0.1
+pytest==7.4.3
+    # via
+    #   incorporeal-cms (pyproject.toml)
+    #   pytest-cov
+pytest-cov==4.1.0
+    # via incorporeal-cms (pyproject.toml)
+python-dateutil==2.8.2
+    # via feedgen
+pyyaml==6.0.1
+    # via bandit
+requests==2.31.0
+    # via safety
+rich==13.7.0
+    # via bandit
+ruamel-yaml==0.18.5
+    # via safety
+ruamel-yaml-clib==0.2.8
+    # via ruamel-yaml
+safety==2.3.5
+    # via incorporeal-cms (pyproject.toml)
+setuptools-scm==8.0.4
+    # via incorporeal-cms (pyproject.toml)
+six==1.16.0
+    # via python-dateutil
+smmap==5.0.1
+    # via gitdb
+snowballstemmer==2.2.0
+    # via pydocstyle
+stevedore==5.1.0
+    # via bandit
+tox==4.0.0
+    # via incorporeal-cms (pyproject.toml)
+typing-extensions==4.9.0
+    # via
+    #   mypy
+    #   setuptools-scm
+urllib3==2.1.0
+    # via requests
+virtualenv==20.25.0
+    # via tox
+werkzeug==3.0.1
     # via flask
-wheel==0.36.2
+wheel==0.42.0
-    # via tox-wheel
+    # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

requirements/requirements.in

@@ -1,4 +0,0 @@
-Flask                       # general purpose web service and web server stuff
-Markdown                    # markdown rendering in templates
-mdx-linkify                 # convert URLs in the text to clickable links
-tzlocal                     # identifying system's local timezone

requirements/requirements.txt

@@ -1,38 +1,32 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with Python 3.12
-# To update, run:
+# by the following command:
 #
-#    pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
+#    pip-compile --output-file=requirements/requirements.txt
 #
-bleach==3.2.2
+blinker==1.7.0
-    # via mdx-linkify
-click==7.1.2
     # via flask
-flask==1.1.2
+click==8.1.7
-    # via -r requirements/requirements.in
-itsdangerous==1.1.0
     # via flask
-jinja2==2.11.2
+feedgen==1.0.0
+    # via incorporeal-cms (pyproject.toml)
+flask==3.0.0
+    # via incorporeal-cms (pyproject.toml)
+itsdangerous==2.1.2
     # via flask
-markdown==3.3.3
+jinja2==3.1.2
+    # via flask
+lxml==5.0.0
+    # via feedgen
+markdown==3.5.1
+    # via incorporeal-cms (pyproject.toml)
+markupsafe==2.1.3
     # via
-    #   -r requirements/requirements.in
+    #   jinja2
-    #   mdx-linkify
+    #   werkzeug
-markupsafe==1.1.1
+python-dateutil==2.8.2
-    # via jinja2
+    # via feedgen
-mdx-linkify==2.1
+six==1.16.0
-    # via -r requirements/requirements.in
+    # via python-dateutil
-packaging==20.8
+werkzeug==3.0.1
-    # via bleach
-pyparsing==2.4.7
-    # via packaging
-pytz==2020.5
-    # via tzlocal
-six==1.15.0
-    # via bleach
-tzlocal==2.1
-    # via -r requirements/requirements.in
-webencodings==0.5.1
-    # via bleach
-werkzeug==1.0.1
     # via flask

setup.cfg

@@ -1,6 +0,0 @@
-[versioneer]
-VCS = git
-style = pep440-post
-versionfile_source = incorporealcms/_version.py
-versionfile_build = incorporealcms/_version.py
-tag_prefix = v

setup.py

@@ -1,30 +0,0 @@
-"""Setuptools configuration."""
-import os
-
-from setuptools import find_packages, setup
-
-import versioneer
-
-HERE = os.path.dirname(os.path.abspath(__file__))
-
-
-def extract_requires():
-    """Get pinned requirements from requirements.txt."""
-    with open(os.path.join(HERE, 'requirements/requirements.txt'), 'r') as reqs:
-        return [line.split(' ')[0] for line in reqs if not line[0] in ('-', '#')]
-
-
-setup(
-    name='incorporeal-cms',
-    description='Flask project for running https://suou.net (and eventually others).',
-    url='https://git.incorporeal.org/bss/incorporeal-cms',
-    license='GPL3',
-    author='Brian S. Stephan',
-    author_email='bss@incorporeal.org',
-    version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
-    packages=find_packages(),
-    include_package_data=True,
-    zip_safe=False,
-    install_requires=extract_requires(),
-)

tests/conftest.py

@@ -1,4 +1,8 @@
-"""Create the test app and other fixtures."""
+"""Create the test app and other fixtures.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 import os
 
 import pytest

tests/functional_markdown_tests.py

@@ -0,0 +1,67 @@
+"""Test graphviz functionality.
+
+SPDX-FileCopyrightText: © 2021 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import os
+
+from incorporealcms import create_app
+
+HERE = os.path.dirname(os.path.abspath(__file__))
+
+
+def app_with_pydot():
+    """Create the test app, including the pydot extension."""
+    return create_app(instance_path=os.path.join(HERE, 'instance'),
+                      test_config={'MARKDOWN_EXTENSIONS': ['incorporealcms.mdx.pydot']})
+
+
+def test_functional_initialization():
+    """Test initialization with the graphviz config."""
+    app = app_with_pydot()
+    assert app is not None
+
+
+def test_graphviz_is_rendered():
+    """Initialize the app with the graphviz extension and ensure it does something."""
+    app = app_with_pydot()
+    client = app.test_client()
+
+    response = client.get('/test-graphviz')
+    assert response.status_code == 200
+    assert b'~~~pydot' not in response.data
+    assert b'data:image/png;base64' in response.data
+
+
+def test_two_graphviz_are_rendered():
+    """Test two images are rendered."""
+    app = app_with_pydot()
+    client = app.test_client()
+
+    response = client.get('/test-two-graphviz')
+    assert response.status_code == 200
+    assert b'~~~pydot' not in response.data
+    assert b'data:image/png;base64' in response.data
+
+
+def test_invalid_graphviz_is_not_rendered():
+    """Check that invalid graphviz doesn't blow things up."""
+    app = app_with_pydot()
+    client = app.test_client()
+
+    response = client.get('/test-invalid-graphviz')
+    assert response.status_code == 500
+    assert b'INTERNAL SERVER ERROR' in response.data
+
+
+def test_figures_are_rendered(client):
+    """Test that a page with my figure syntax renders as expected."""
+    response = client.get('/figures')
+    assert response.status_code == 200
+    assert (b'<figure class="right"><img alt="fancy captioned logo" src="bss-square-no-bg.png" />'
+            b'<figcaption>this is my cool logo!</figcaption></figure>') in response.data
+    assert (b'<figure><img alt="vanilla captioned logo" src="bss-square-no-bg.png" />'
+            b'<figcaption>this is my cool logo without an attr!</figcaption>\n</figure>') in response.data
+    assert (b'<figure class="left"><img alt="fancy logo" src="bss-square-no-bg.png" />'
+            b'<span></span></figure>') in response.data
+    assert b'<figure><img alt="just a logo" src="bss-square-no-bg.png" /></figure>' in response.data

tests/functional_tests.py

@@ -1,44 +1,128 @@
-"""Test page requests."""
+"""Test page requests.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 import re
+from unittest.mock import patch
 
 
 def test_page_that_exists(client):
     """Test that the app can serve a basic file at the index."""
     response = client.get('/')
     assert response.status_code == 200
-    assert b'<h1>test index</h1>' in response.data
+    assert b'<h1 id="test-index">test index</h1>' in response.data
+
+
+def test_direct_file_that_exists(client):
+    """Test that the app can serve a basic file at the index."""
+    response = client.get('/foo.txt')
+    assert response.status_code == 200
+    assert b'test file' in response.data
 
 
 def test_page_that_doesnt_exist(client):
-    """Test that the app returns 404 for nonsense requests."""
+    """Test that the app returns 404 for nonsense requests and they use my error page."""
     response = client.get('/ohuesthaoeusth')
     assert response.status_code == 404
+    assert b'<b><tt>/ohuesthaoeusth</tt></b> does not seem to exist' in response.data
+    # test the contact email config
+    assert b'admin@example.com' in response.data
+
+
+def test_files_outside_pages_do_not_get_served(client):
+    """Test that page pathing doesn't break out of the instance/pages/ dir, and the error uses my error page."""
+    response = client.get('/../unreachable')
+    assert response.status_code == 400
+    assert b'You\'re doing something you\'re not supposed to. Stop it?' in response.data
+
+
+def test_internal_server_error_serves_error_page(client):
+    """Test that various exceptions serve up the 500 page."""
+    response = client.get('/actually-a-png')
+    assert response.status_code == 500
+    assert b'INTERNAL SERVER ERROR' in response.data
+    # test the contact email config
+    assert b'admin@example.com' in response.data
+
+
+def test_oserror_is_500(client, app):
+    """Test that an OSError raises as a 500."""
+    with app.test_request_context():
+        with patch('flask.current_app.open_instance_resource', side_effect=OSError):
+            response = client.get('/')
+            assert response.status_code == 500
+            assert b'INTERNAL SERVER ERROR' in response.data
+
+
+def test_unsupported_file_type_is_500(client, app):
+    """Test a coding condition mishap raises as a 500."""
+    with app.test_request_context():
+        with patch('incorporealcms.pages.request_path_to_instance_resource_path', return_value=('foo', 'bar')):
+            response = client.get('/')
+            assert response.status_code == 500
+            assert b'INTERNAL SERVER ERROR' in response.data
+
+
+def test_weird_paths_do_not_get_served(client):
+    """Test that we clean up requests as desired."""
+    response = client.get('/../../')
+    assert response.status_code == 400
 
 
 def test_page_with_title_metadata(client):
     """Test that a page with title metadata has its title written."""
     response = client.get('/')
     assert response.status_code == 200
-    assert b'<title>Index - incorporeal.org</title>' in response.data
+    assert b'<title>Index - example.com</title>' in response.data
 
 
 def test_page_without_title_metadata(client):
     """Test that a page without title metadata gets the default title."""
     response = client.get('/no-title')
     assert response.status_code == 200
-    assert b'<title>incorporeal.org</title>' in response.data
+    assert b'<title>/no-title - example.com</title>' in response.data
-    assert b'<h1>this page doesn\'t have a title!</h1>' in response.data
+
+
+def test_page_in_subdir_without_title_metadata(client):
+    """Test that the title-less page display is as expected."""
+    response = client.get('/subdir//page-no-title')
+    assert response.status_code == 200
+    assert b'<title>/subdir/page-no-title - example.com</title>' in response.data
 
 
 def test_page_with_card_metadata(client):
     """Test that a page with opengraph metadata."""
     response = client.get('/more-metadata')
     assert response.status_code == 200
-    assert b'<meta property="og:title" content="title for the page">' in response.data
+    assert b'<meta property="og:title" content="title for the page - example.com">' in response.data
     assert b'<meta property="og:description" content="description of this page made even longer">' in response.data
     assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
 
 
+def test_page_with_card_title_even_when_no_metadata(client):
+    """Test that a page without metadata still has a card with the derived title."""
+    response = client.get('/no-title')
+    assert response.status_code == 200
+    assert b'<meta property="og:title" content="/no-title - example.com">' in response.data
+    assert b'<meta property="og:description"' not in response.data
+    assert b'<meta property="og:image"' not in response.data
+
+
+def test_page_with_forced_empty_title_just_shows_suffix(client):
+    """Test that if a page specifies a blank Title meta tag explicitly, only the suffix is used in the title."""
+    response = client.get('/forced-no-title')
+    assert response.status_code == 200
+    assert b'<title>example.com</title>' in response.data
+
+
+def test_page_with_redirect_meta_url_redirects(client):
+    """Test that if a page specifies a URL to redirect to, that the site serves up a 301."""
+    response = client.get('/redirect')
+    assert response.status_code == 301
+    assert response.location == 'http://www.google.com/'
+
+
 def test_page_has_modified_timestamp(client):
     """Test that pages have modified timestamps in them."""
     response = client.get('/')
@@ -54,6 +138,44 @@ def test_that_page_request_redirects_to_directory(client):
     """
     response = client.get('/subdir')
     assert response.status_code == 301
+    assert response.location == '/subdir/'
+
+
+def test_that_request_to_symlink_redirects_markdown(client):
+    """Test that a request to /foo redirects to /what-foo-points-at."""
+    response = client.get('/symlink-to-no-title')
+    assert response.status_code == 301
+    assert response.location == '/no-title'
+
+
+def test_that_request_to_symlink_redirects_file(client):
+    """Test that a request to /foo.txt redirects to /what-foo-points-at.txt."""
+    response = client.get('/symlink-to-foo.txt')
+    assert response.status_code == 301
+    assert response.location == '/foo.txt'
+
+
+def test_that_request_to_symlink_redirects_directory(client):
+    """Test that a request to /foo/ redirects to /what-foo-points-at/."""
+    response = client.get('/symlink-to-subdir/')
+    assert response.status_code == 301
+    assert response.location == '/subdir'
+    # sadly, this location also redirects
+    response = client.get('/subdir')
+    assert response.status_code == 301
+    assert response.location == '/subdir/'
+    # but we do get there
+    response = client.get('/subdir/')
+    assert response.status_code == 200
+
+
+def test_that_request_to_symlink_redirects_subdirectory(client):
+    """Test that a request to /foo/bar redirects to /what-foo-points-at/bar."""
+    response = client.get('/symlink-to-subdir/page-no-title')
+    assert response.status_code == 301
+    assert response.location == '/subdir/page-no-title'
+    response = client.get('/subdir/page-no-title')
+    assert response.status_code == 200
 
 
 def test_that_dir_request_does_not_redirect(client):
@@ -66,19 +188,57 @@ def test_that_dir_request_does_not_redirect(client):
 def test_setting_selected_style_includes_cookie(client):
     """Test that a request with style=foo sets the cookie and renders appropriately."""
     response = client.get('/')
-    style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
+    style_cookie = client.get_cookie('user-style')
     assert style_cookie is None
 
     response = client.get('/?style=light')
-    style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
+    style_cookie = client.get_cookie('user-style')
     assert response.status_code == 200
-    assert b'light.css' in response.data
+    assert b'/static/css/light.css' in response.data
-    assert b'dark.css' not in response.data
+    assert b'/static/css/dark.css' not in response.data
     assert style_cookie.value == 'light'
 
     response = client.get('/?style=dark')
-    style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
+    style_cookie = client.get_cookie('user-style')
     assert response.status_code == 200
-    assert b'dark.css' in response.data
+    assert b'/static/css/dark.css' in response.data
-    assert b'light.css' not in response.data
+    assert b'/static/css/light.css' not in response.data
     assert style_cookie.value == 'dark'
+
+
+def test_pages_can_supply_alternate_templates(client):
+    """Test that pages can supply templates other than the default."""
+    response = client.get('/')
+    assert b'class="site-wrap site-wrap-normal-width"' in response.data
+    assert b'class="site-wrap site-wrap-double-width"' not in response.data
+    response = client.get('/custom-template')
+    assert b'class="site-wrap site-wrap-normal-width"' not in response.data
+    assert b'class="site-wrap site-wrap-double-width"' in response.data
+
+
+def test_extra_footer_per_page(client):
+    """Test that we don't include the extra-footer if there isn't one (or do if there is)."""
+    response = client.get('/')
+    assert b'<div class="extra-footer">' not in response.data
+    response = client.get('/index-but-with-footer')
+    assert b'<div class="extra-footer"><i>ooo <a href="a">a</a></i>' in response.data
+
+
+def test_serving_static_files(client):
+    """Test the usage of send_from_directory to serve extra static files."""
+    response = client.get('/custom-static/css/warm.css')
+    assert response.status_code == 200
+
+    # can't serve directories, just files
+    response = client.get('/custom-static/')
+    assert response.status_code == 404
+    response = client.get('/custom-static/css/')
+    assert response.status_code == 404
+    response = client.get('/custom-static/css')
+    assert response.status_code == 404
+
+    # can't serve files that don't exist or bad paths
+    response = client.get('/custom-static/css/cold.css')
+    assert response.status_code == 404
+    response = client.get('/custom-static/css/../../unreachable.md')
+    assert response.status_code == 404

tests/instance/config.py

@@ -1,4 +1,8 @@
-"""Configure the test application."""
+"""Configure the test application.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 
 LOGGING = {
     'version': 1,
@@ -15,6 +19,10 @@ LOGGING = {
         },
     },
     'loggers': {
+        'incorporealcms.mdx': {
+            'level': 'DEBUG',
+            'handlers': ['console'],
+        },
         'incorporealcms.pages': {
             'level': 'DEBUG',
             'handlers': ['console'],

tests/instance/custom-static/css/warm.css

@@ -0,0 +1,3 @@
+* {
+    color: red;
+}

tests/instance/feed/2023/12/01/forced-no-title.md

@@ -0,0 +1 @@
+../../../../pages/forced-no-title.md

tests/instance/feed/2023/12/30/page.md

@@ -0,0 +1 @@
+../../../../pages/subdir-with-title/page.md

tests/instance/pages/custom-template.md

@@ -0,0 +1,3 @@
+Template:           base-wide.html
+
+testttttttttt

tests/instance/pages/figures.md

@@ -0,0 +1,13 @@
+# test of figures
+
+|> ![fancy captioned logo](bss-square-no-bg.png)
+|: this is my cool logo!
+{: .right }
+
+|> ![vanilla captioned logo](bss-square-no-bg.png)
+|: this is my cool logo without an attr!
+
+|> ![fancy logo](bss-square-no-bg.png)
+{: .left }
+
+|> ![just a logo](bss-square-no-bg.png)

tests/instance/pages/foo.txt

@@ -0,0 +1 @@
+test file

tests/instance/pages/forced-no-title.md

@@ -0,0 +1,3 @@
+Title:
+
+some words are here

tests/instance/pages/index-but-with-footer.md

@@ -0,0 +1,6 @@
+Title:      Index
+Footer:     ooo <a href="a">a</a>
+
+# test index
+
+this is some test content

tests/instance/pages/no-index-dir/page.md

@@ -0,0 +1 @@
+this is a test page

tests/instance/pages/redirect.md

@@ -0,0 +1 @@
+Redirect:           http://www.google.com/

tests/instance/pages/subdir/page-no-title.md

@@ -0,0 +1 @@
+this is just a page

tests/instance/pages/symlink-to-foo.txt

@@ -0,0 +1 @@
+foo.txt

tests/instance/pages/symlink-to-no-title.md

@@ -0,0 +1 @@
+no-title.md

tests/instance/pages/symlink-to-subdir

@@ -0,0 +1 @@
+subdir

tests/instance/pages/test-graphviz.md

@@ -0,0 +1,12 @@
+# test
+
+test
+~~~{ pydot:attack-plan }
+digraph G {
+    rankdir=LR
+    Earth
+    Mars
+    Earth -> Mars
+}
+~~~
+more test

tests/instance/pages/test-invalid-graphviz.md

@@ -0,0 +1,11 @@
+# test
+
+test
+~~~{ pydot:attack-plan }
+    rankdir=LR
+    Earth
+    Mars
+    Earth -> Mars
+}
+~~~
+more test

tests/instance/pages/test-two-graphviz.md

@@ -0,0 +1,25 @@
+# test
+
+test
+
+~~~{ pydot:attack-plan }
+digraph G {
+    rankdir=LR
+    Earth
+    Mars
+    Earth -> Mars
+}
+~~~
+
+more test
+
+~~~{ pydot:new-attack-plan }
+digraph H {
+    rankdir=LR
+    Venus
+    Mars
+    Venus -> Mars
+}
+~~~
+
+done

tests/instance/unreachable.md

@@ -0,0 +1 @@
+this file exists but the app should not serve it.

tests/test_factory.py

@@ -1,4 +1,8 @@
-"""Test basic configuration stuff."""
+"""Test basic configuration stuff.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
 import os
 
 from incorporealcms import create_app
@@ -20,7 +24,7 @@ def test_markdown_meta_extension_always():
     client = app.test_client()
     response = client.get('/')
     assert response.status_code == 200
-    assert b'<title>Index - incorporeal.org</title>' in response.data
+    assert b'<title>Index - example.com</title>' in response.data
 
 
 def test_custom_markdown_extensions_work():
@@ -50,7 +54,7 @@ def test_title_override():
     client = app.test_client()
     response = client.get('/no-title')
     assert response.status_code == 200
-    assert b'<title>suou.net</title>' in response.data
+    assert b'<title>/no-title - suou.net</title>' in response.data
 
 
 def test_media_file_access(client):
@@ -58,3 +62,22 @@ def test_media_file_access(client):
     response = client.get('/media/favicon.png')
     assert response.status_code == 200
     assert response.headers['content-type'] == 'image/png'
+
+
+def test_favicon_override():
+    """Test that a configuration with a specific favicon overrides the default."""
+    instance_path = os.path.join(HERE, 'instance')
+    app = create_app(instance_path=instance_path, test_config={'FAVICON': '/media/foo.png'})
+    client = app.test_client()
+    response = client.get('/no-title')
+    assert response.status_code == 200
+    assert b'<link rel="icon" href="/media/foo.png">' in response.data
+
+
+def test_misconfigured_markdown_extensions():
+    """Test that a misconfigured markdown extensions leads to a 500 at render time."""
+    instance_path = os.path.join(HERE, 'instance')
+    app = create_app(instance_path=instance_path, test_config={'MARKDOWN_EXTENSIONS': 'WRONG'})
+    client = app.test_client()
+    response = client.get('/no-title')
+    assert response.status_code == 500

tests/test_feed.py

@@ -0,0 +1,44 @@
+"""Test the feed methods.
+
+SPDX-FileCopyrightText: © 2023 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+from incorporealcms.feed import serve_feed
+
+
+def test_unknown_type_is_404(client):
+    """Test that requesting a feed type that doesn't exist is a 404."""
+    response = client.get('/feed/wat')
+    assert response.status_code == 404
+
+
+def test_atom_type_is_200(client):
+    """Test that requesting an ATOM feed is found."""
+    response = client.get('/feed/atom')
+    assert response.status_code == 200
+    assert 'application/atom+xml' in response.content_type
+    print(response.text)
+
+
+def test_rss_type_is_200(client):
+    """Test that requesting an RSS feed is found."""
+    response = client.get('/feed/rss')
+    assert response.status_code == 200
+    assert 'application/rss+xml' in response.content_type
+    print(response.text)
+
+
+def test_feed_generator_atom(app):
+    """Test the root feed generator."""
+    with app.test_request_context():
+        content = serve_feed('atom')
+    assert b'<id>https://example.com/</id>' in content.data
+    assert b'<email>admin@example.com</email>' in content.data
+    assert b'<name>Test Name</name>' in content.data
+
+
+def test_feed_generator_rss(app):
+    """Test the root feed generator."""
+    with app.test_request_context():
+        content = serve_feed('rss')
+    assert b'<author>admin@example.com (Test Name)</author>' in content.data

tests/test_pages.py

@@ -1,100 +1,282 @@
-"""Unit test helper methods."""
+"""Unit test helper methods.
+
+SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+import os
+
+import pytest
 from werkzeug.http import dump_cookie
 
-from incorporealcms.pages import generate_parent_navs, is_file_path_actually_dir_path, render, resolve_page_file
+from incorporealcms import create_app
+from incorporealcms.pages import (generate_parent_navs, instance_resource_path_to_request_path, render,
+                                  request_path_to_breadcrumb_display, request_path_to_instance_resource_path)
 
-
+HERE = os.path.dirname(os.path.abspath(__file__))
-def test_resolve_page_file_dir_to_index():
-    """Test that a request to a directory path results in the dir's index.md."""
-    assert resolve_page_file('foo/') == 'pages/foo/index.md'
-
-
-def test_resolve_page_file_subdir_to_index():
-    """Test that a request to a dir's subdir path results in the subdir's index.md."""
-    assert resolve_page_file('foo/bar/') == 'pages/foo/bar/index.md'
-
-
-def test_resolve_page_file_other_requests_fine():
-    """Test that a request to non-dir path results in a Markdown file."""
-    assert resolve_page_file('foo/baz') == 'pages/foo/baz.md'
 
 
 def test_generate_page_navs_index(app):
     """Test that the index page has navs to the root (itself)."""
     with app.app_context():
-        assert generate_parent_navs('/') == [('incorporeal.org', '/')]
+        assert generate_parent_navs('pages/index.md') == [('example.com', '/')]
-
-
-def test_generate_page_navs_alternate_index(app):
-    """Test that the index page (as a page, not a path) also has navs only to the root (by path)."""
-    with app.app_context():
-        assert generate_parent_navs('index') == [('incorporeal.org', '/')]
 
 
 def test_generate_page_navs_subdir_index(app):
     """Test that dir pages have navs to the root and themselves."""
     with app.app_context():
-        assert generate_parent_navs('subdir/') == [('incorporeal.org', '/'), ('/subdir/', '/subdir/')]
+        assert generate_parent_navs('pages/subdir/index.md') == [('example.com', '/'), ('subdir', '/subdir/')]
 
 
 def test_generate_page_navs_subdir_real_page(app):
     """Test that real pages have navs to the root, their parent, and themselves."""
     with app.app_context():
-        assert generate_parent_navs('subdir/page') == [('incorporeal.org', '/'), ('/subdir/', '/subdir/'),
+        assert generate_parent_navs('pages/subdir/page.md') == [('example.com', '/'), ('subdir', '/subdir/'),
                                                                 ('Page', '/subdir/page')]
 
 
 def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
     """Test that title metadata is used in the nav text."""
     with app.app_context():
-        assert generate_parent_navs('subdir-with-title/page') == [
+        assert generate_parent_navs('pages/subdir-with-title/page.md') == [
-            ('incorporeal.org', '/'),
+            ('example.com', '/'),
             ('SUB!', '/subdir-with-title/'),
-            ('/subdir-with-title/page', '/subdir-with-title/page')
+            ('page', '/subdir-with-title/page')
         ]
 
 
-def test_is_file_path_actually_dir_path_valid_file_is_yes(app):
+def test_generate_page_navs_subdir_with_no_index(app):
-    """Test that a file request for what's actually a directory is detected as such."""
+    """Test that breadcrumbs still generate even if a subdir doesn't have an index.md."""
     with app.app_context():
-        assert is_file_path_actually_dir_path('/subdir')
+        assert generate_parent_navs('pages/no-index-dir/page.md') == [
-
+            ('example.com', '/'),
-
+            ('/no-index-dir/', '/no-index-dir/'),
-def test_is_file_path_actually_dir_path_valid_dir_is_no(app):
+            ('page', '/no-index-dir/page')
-    """Test that a directory request is still a directory request."""
+        ]
-    with app.app_context():
-        assert not is_file_path_actually_dir_path('/subdir/')
-
-
-def test_is_file_path_actually_dir_path_nonsense_file_is_no(app):
-    """Test that requests to nonsense file-looking paths aren't treated as dirs."""
-    with app.app_context():
-        assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax')
-
-
-def test_is_file_path_actually_dir_path_nonsense_dir_is_no(app):
-    """Test that a directory request is a directory request even if the dir doesn't exist."""
-    with app.app_context():
-        assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax/')
 
 
 def test_render_with_user_dark_theme(app):
     """Test that a request with the dark theme selected renders the dark theme."""
     cookie = dump_cookie("user-style", 'dark')
     with app.test_request_context(headers={'COOKIE': cookie}):
-        assert b'dark.css' in render('base.html').data
+        assert b'/static/css/dark.css' in render('base.html').data
-        assert b'light.css' not in render('base.html').data
+        assert b'/static/css/light.css' not in render('base.html').data
 
 
 def test_render_with_user_light_theme(app):
     """Test that a request with the light theme selected renders the light theme."""
     with app.test_request_context():
-        assert b'light.css' in render('base.html').data
+        assert b'/static/css/light.css' in render('base.html').data
-        assert b'dark.css' not in render('base.html').data
+        assert b'/static/css/dark.css' not in render('base.html').data
 
 
 def test_render_with_no_user_theme(app):
     """Test that a request with no theme set renders the light theme."""
     with app.test_request_context():
-        assert b'light.css' in render('base.html').data
+        assert b'/static/css/light.css' in render('base.html').data
-        assert b'dark.css' not in render('base.html').data
+        assert b'/static/css/dark.css' not in render('base.html').data
+
+
+def test_render_with_theme_defaults_affects_html(app):
+    """Test that the base themes are all that's presented in the HTML."""
+    # test we can remove stuff from the default
+    with app.test_request_context():
+        assert b'?style=light' in render('base.html').data
+        assert b'?style=dark' in render('base.html').data
+        assert b'?style=plain' in render('base.html').data
+
+
+def test_render_with_theme_overrides_affects_html(app):
+    """Test that the overridden themes are presented in the HTML."""
+    # test we can remove stuff from the default
+    restyled_app = create_app(instance_path=os.path.join(HERE, 'instance'),
+                              test_config={'PAGE_STYLES': {'light': '/static/css/light.css'}})
+    with restyled_app.test_request_context():
+        assert b'?style=light' in render('base.html').data
+        assert b'?style=dark' not in render('base.html').data
+        assert b'?style=plain' not in render('base.html').data
+
+    # test that we can add new stuff too/instead
+    restyled_app = create_app(instance_path=os.path.join(HERE, 'instance'),
+                              test_config={'PAGE_STYLES': {'cool': '/static/css/cool.css',
+                                                           'warm': '/static/css/warm.css'},
+                                           'DEFAULT_PAGE_STYLE': 'warm'})
+    with restyled_app.test_request_context():
+        assert b'?style=cool' in render('base.html').data
+        assert b'?style=warm' in render('base.html').data
+
+
+def test_render_with_theme_overrides(app):
+    """Test that the loaded themes can be overridden from the default."""
+    cookie = dump_cookie("user-style", 'cool')
+    restyled_app = create_app(instance_path=os.path.join(HERE, 'instance'),
+                              test_config={'PAGE_STYLES': {'cool': '/static/css/cool.css',
+                                                           'warm': '/static/css/warm.css'}})
+    with restyled_app.test_request_context(headers={'COOKIE': cookie}):
+        assert b'/static/css/cool.css' in render('base.html').data
+        assert b'/static/css/warm.css' not in render('base.html').data
+
+
+def test_render_with_theme_overrides_not_found_is_default(app):
+    """Test that theme overrides work, and if a requested theme doesn't exist, the default is loaded."""
+    cookie = dump_cookie("user-style", 'nonexistent')
+    restyled_app = create_app(instance_path=os.path.join(HERE, 'instance'),
+                              test_config={'PAGE_STYLES': {'cool': '/static/css/cool.css',
+                                                           'warm': '/static/css/warm.css'},
+                                           'DEFAULT_PAGE_STYLE': 'warm'})
+    with restyled_app.test_request_context(headers={'COOKIE': cookie}):
+        assert b'/static/css/warm.css' in render('base.html').data
+        assert b'/static/css/nonexistent.css' not in render('base.html').data
+
+
+def test_request_path_to_instance_resource_path(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert request_path_to_instance_resource_path('index') == ('pages/index.md', 'markdown')
+
+
+def test_request_path_to_instance_resource_path_direct_file(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert request_path_to_instance_resource_path('no-title') == ('pages/no-title.md', 'markdown')
+
+
+def test_request_path_to_instance_resource_path_in_subdir(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert request_path_to_instance_resource_path('subdir/page') == ('pages/subdir/page.md', 'markdown')
+
+
+def test_request_path_to_instance_resource_path_subdir_index(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert request_path_to_instance_resource_path('subdir/') == ('pages/subdir/index.md', 'markdown')
+
+
+def test_request_path_to_instance_resource_path_relatives_walked(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('subdir/more-subdir/../../more-metadata') ==
+                ('pages/more-metadata.md', 'markdown'))
+
+
+def test_request_path_to_instance_resource_path_relatives_walked_indexes_work_too(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert request_path_to_instance_resource_path('subdir/more-subdir/../../') == ('pages/index.md', 'markdown')
+
+
+def test_request_path_to_instance_resource_path_relatives_walked_into_subdirs_also_fine(app):
+    """Test a normal URL request is transformed into the file path."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('subdir/more-subdir/../../subdir/page') ==
+                ('pages/subdir/page.md', 'markdown'))
+
+
+def test_request_path_to_instance_resource_path_permission_error_on_ref_above_pages(app):
+    """Test that attempts to get above the base dir ("/../../foo") fail."""
+    with app.test_request_context():
+        with pytest.raises(PermissionError):
+            assert request_path_to_instance_resource_path('../unreachable')
+
+
+def test_request_path_to_instance_resource_path_isadirectory_on_file_like_req_for_dir(app):
+    """Test that a request for e.g. '/foo' when foo is a dir indicate to redirect."""
+    with app.test_request_context():
+        with pytest.raises(IsADirectoryError):
+            assert request_path_to_instance_resource_path('subdir')
+
+
+def test_request_path_to_instance_resource_path_actual_file(app):
+    """Test that a request for e.g. '/foo.png' when foo.png is a real file works."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('bss-square-no-bg.png') ==
+                ('pages/bss-square-no-bg.png', 'file'))
+
+
+def test_request_path_to_instance_resource_path_markdown_symlink(app):
+    """Test that a request for e.g. '/foo' when foo.md is a symlink to another .md file redirects."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('symlink-to-no-title') ==
+                ('pages/no-title.md', 'symlink'))
+
+
+def test_request_path_to_instance_resource_path_file_symlink(app):
+    """Test that a request for e.g. '/foo' when foo.txt is a symlink to another .txt file redirects."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('symlink-to-foo.txt') ==
+                ('pages/foo.txt', 'symlink'))
+
+
+def test_request_path_to_instance_resource_path_dir_symlink(app):
+    """Test that a request for e.g. '/foo' when /foo is a symlink to /bar redirects."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('symlink-to-subdir/') ==
+                ('pages/subdir', 'symlink'))
+
+
+def test_request_path_to_instance_resource_path_subdir_symlink(app):
+    """Test that a request for e.g. '/foo/baz' when /foo is a symlink to /bar redirects."""
+    with app.test_request_context():
+        assert (request_path_to_instance_resource_path('symlink-to-subdir/page-no-title') ==
+                ('pages/subdir/page-no-title.md', 'symlink'))
+
+
+def test_request_path_to_instance_resource_path_nonexistant_file_errors(app):
+    """Test that a request for something not on disk errors."""
+    with app.test_request_context():
+        with pytest.raises(FileNotFoundError):
+            assert request_path_to_instance_resource_path('nthanpthpnh')
+
+
+def test_request_path_to_instance_resource_path_absolute_file_errors(app):
+    """Test that a request for something not on disk errors."""
+    with app.test_request_context():
+        with pytest.raises(PermissionError):
+            assert request_path_to_instance_resource_path('/etc/hosts')
+
+
+def test_instance_resource_path_to_request_path_on_index(app):
+    """Test index.md -> /."""
+    with app.test_request_context():
+        assert instance_resource_path_to_request_path('index.md') == ''
+
+
+def test_instance_resource_path_to_request_path_on_page(app):
+    """Test no-title.md -> no-title."""
+    with app.test_request_context():
+        assert instance_resource_path_to_request_path('no-title.md') == 'no-title'
+
+
+def test_instance_resource_path_to_request_path_on_subdir(app):
+    """Test subdir/index.md -> subdir/."""
+    with app.test_request_context():
+        assert instance_resource_path_to_request_path('subdir/index.md') == 'subdir/'
+
+
+def test_instance_resource_path_to_request_path_on_subdir_and_page(app):
+    """Test subdir/page.md -> subdir/page."""
+    with app.test_request_context():
+        assert instance_resource_path_to_request_path('subdir/page.md') == 'subdir/page'
+
+
+def test_request_resource_request_root(app):
+    """Test that a request can resolve to a resource and back to a request."""
+    with app.test_request_context():
+        instance_path, _ = request_path_to_instance_resource_path('index')
+        instance_resource_path_to_request_path(instance_path) == ''
+
+
+def test_request_resource_request_page(app):
+    """Test that a request can resolve to a resource and back to a request."""
+    with app.test_request_context():
+        instance_path, _ = request_path_to_instance_resource_path('no-title')
+        instance_resource_path_to_request_path(instance_path) == 'no-title'
+
+
+def test_request_path_to_breadcrumb_display_patterns():
+    """Test various conversions from request path to leaf nodes for display in the breadcrumbs."""
+    assert request_path_to_breadcrumb_display('/foo') == 'foo'
+    assert request_path_to_breadcrumb_display('/foo/') == 'foo'
+    assert request_path_to_breadcrumb_display('/foo/bar') == 'bar'
+    assert request_path_to_breadcrumb_display('/foo/bar/') == 'bar'
+    assert request_path_to_breadcrumb_display('/') == ''

tox.ini

@@ -4,21 +4,11 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = begin,py37,py38,coverage,security,lint,bundle
+isolated_build = true
+envlist = begin,py38,py39,py310,py311,py312,coverage,security,lint
 
 [testenv]
-# build a wheel and test it
+allow_externals = pytest, coverage
-wheel = true
-wheel_build_env = build
-
-# whitelist commands we need
-whitelist_externals = cp
-
-# install everything via requirements-dev.txt, so that developer environment
-# is the same as the tox environment (for ease of use/no weird gotchas in
-# local dev results vs. tox results) and also to avoid ticky-tacky maintenance
-# of "oh this particular env has weird results unless I install foo" --- just
-# shotgun blast install everything everywhere
 deps =
     -rrequirements/requirements-dev.txt
 
@@ -31,12 +21,27 @@ deps = setuptools
 skip_install = true
 commands = coverage erase
 
-[testenv:py37]
+[testenv:py38]
 # run pytest with coverage
 commands =
     pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
 
-[testenv:py38]
+[testenv:py39]
+# run pytest with coverage
+commands =
+    pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
+
+[testenv:py310]
+# run pytest with coverage
+commands =
+    pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
+
+[testenv:py311]
+# run pytest with coverage
+commands =
+    pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
+
+[testenv:py312]
 # run pytest with coverage
 commands =
     pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
@@ -53,19 +58,15 @@ commands =
 # again it seems the most valuable here to run against the packaged code
 commands =
     bandit {envsitepackagesdir}/incorporealcms/ -r
+    safety check -r requirements/requirements-dev.txt
 
 [testenv:lint]
 # run style checks
+# TODO: mypy incorporealcms
 commands =
     flake8
     - flake8 --disable-noqa --ignore= --select=E,W,F,C,D,A,G,B,I,T,M,DUO
 
-[testenv:bundle]
-# take extra actions (build sdist, sphinx, whatever) to completely package the app
-commands =
-    cp -r {distdir} .
-    python setup.py sdist
-
 [coverage:paths]
 source =
     ./
@@ -74,31 +75,5 @@ source =
 [coverage:run]
 branch = True
 
-# redundant with pytest --cov above, but this tricks the coverage.xml report into
-# using the full path, otherwise files with the same name in different paths
-# get clobbered. maybe appends would fix this, IDK
-include =
-    .tox/**/incorporealcms/
-
 omit =
     **/_version.py
-
-[flake8]
-enable-extensions = G,M
-exclude =
-    .tox/
-    versioneer.py
-    _version.py
-    instance/
-extend-ignore = T101
-max-complexity = 10
-max-line-length = 120
-
-[isort]
-line_length = 120
-
-[pytest]
-python_files =
-    *_tests.py
-    tests.py
-    test_*.py