81 Commits

Author SHA1 Message Date
55cfad90a9 use werkzeug safe_join to sanitize the requested path
no tests changed, so my implementation might have been good, but let's
use the provided check
2022-12-31 11:53:14 -06:00
b3dfab2611 simplify and better standardize the link underline 2022-12-31 11:33:36 -06:00
715bc38d78 serve per-instance static files at custom-static/ 2022-12-31 10:51:36 -06:00
e9af2de21e don't assume all styles are in the static directory
this is to make room for a second, instance-configured spot for them
2022-12-31 10:16:35 -06:00
83bc8b2c21 requirements bump, only affected dev tools 2022-12-31 10:13:20 -06:00
4a2f650a33 don't hardcode styles to present, use config
now that we can override the styles in practice, we also need to only
present what is possible in the HTML
2022-12-31 09:53:22 -06:00
fd0fb390ff allow for overriding PAGE_STYLES
moving this allows for per-instance customizations later, but that won't
be practical until serving styles from the instance dir is also allowed.
but, this sets the ground work and does allow for removing some styles
(e.g. if someone wanted to only allow 'plain').

also I still need to add the ability to present the themes list dynamically
2022-12-31 09:40:13 -06:00
be8a8dd35a test full path for stylesheets
I'm going to be screwing around with this code in some future commits so
it's better to be explicit
2022-12-31 09:02:57 -06:00
0f19fcb174 fix bad copy and paste job on link styles 2022-09-16 14:16:13 -05:00
f1684a57a9 requirements recompile 2022-09-16 13:49:57 -05:00
83eb464be9 style the potential for links in the footer 2022-09-16 13:40:23 -05:00
0f03ad6f38 allow pages to supply extra footer text 2022-09-16 13:35:40 -05:00
21ea24ffa1 header style tweaks, deemphasizing it a bit 2022-06-05 21:30:49 -05:00
724a2240b2 requirements bump for latest release 2022-05-25 07:24:03 -05:00
aa6a27dd8b make the header bigger, and align header and content padding better 2022-05-17 07:57:23 -05:00
c80172cffd go back to red headers and links as normal-colored text
the new way to do the links without adding links to images is probably
dumb and/or missing some stuff, but it works and does what I want, and I
think I like the old look of the colors better, so time to try it and
see if it sticks still
2022-05-17 07:57:23 -05:00
89ea2fb87e give the header nav links an underline on hover 2022-05-17 07:57:23 -05:00
8ac5b25208 get rid of the slight recoloring of bold text 2022-05-17 07:57:23 -05:00
54b953f5ed go back to the old, balanced width alignments 2022-05-17 07:57:23 -05:00
de0641b08f tweak the two-tone backgrounds and whitespace up the header 2022-05-17 07:57:23 -05:00
cc3e311738 clarify my DCO-like stance, and provide cloning info 2022-05-17 07:52:58 -05:00
985bb93839 do a requirements bump
notable changes:

* Flask 1.1 treats redirects to itself as relative URLs now, so a spate
  of tests were updated
2022-04-19 08:41:59 -05:00
3454de17fc style links with color, not underlines
this allows me to link to images (e.g. in figures) without having a
separate override class to remove their underline, which is ugly. on
account of making links red, it was looking like too much red
(especially on the index) with headers also being red, so this makes
headers the default text color.

still not 100% committed to this but I'm trying it out
2022-04-19 08:41:59 -05:00
1fe6623587 remove .img-frame class, unnecessary with figures 2022-04-19 08:41:59 -05:00
ec042e466c scoot the footer down a bit, and give it margins like the main content's 2022-04-19 08:41:59 -05:00
6daed848d0 remove duplicate link styles
all these subclasses or whatever are the same
2022-04-19 08:41:59 -05:00
502adac89c make the pydot syntax backwards compatible with code fences
without this, the code fence parser was getting thrown off if you didn't
have the pydot extension loaded, which was thwarting backwards
compatibility. this makes the pydot bits look like an attribute to the
vanilla parser, so at least then the vanilla markdown renders as
intended
2022-04-19 08:41:59 -05:00
08305e26db pydot: handle multiple dot images in one file 2022-04-19 08:41:59 -05:00
9a65dfffaf tweaks to the content responsiveness and header padding
more readability stuff for desktop without (hopefully) affecting the
mobile experience much
2022-04-19 08:41:58 -05:00
a42ce34aad add a bit of whitespace in content text
meant to help readability slightly, in part because of what I'm screwing
around with in changing link and header colors
2022-04-19 08:41:58 -05:00
9ce8e9a1cc restyle figures and captions for more flexibility 2022-04-19 08:41:58 -05:00
d07260331b remove unused figure classes
these are being reworked and I don't think I'm going to do responsive
stuff anymore
2022-04-19 08:41:58 -05:00
2c47501589 remove unused thumbnail class
used to appear on a couple images, the styling was replaced with some
more explicit image tags and soon will be replaced again with figure
stuff
2022-04-19 08:41:58 -05:00
f15d955067 initial crack at a block-level figure parser
I didn't like the other figure + figcaption parsers, they either assumed
a lot about usage (e.g. images only), or they were inline parsers that
either wrapped the figure in a paragraph tag (which is incorrect syntax)
or did span trickery (annoying)

so, this handles images and maybe other things, and does things properly
with figures as their own blocks. incomplete but it works with my
images, and should allow for looping (for multi-line content) in the
future?
2022-04-19 08:41:55 -05:00
b3c3c0de45 clean up the default markdown configuration a bit
this brings the config a bit closer to my default, and updates the
expectations of a test accordingly
2022-04-19 06:45:32 -05:00
853a58b78b make the breadcrumbs and style menu a bit nicer 2022-03-24 22:41:34 -05:00
3cade4fe73 add the image floats to the plain CSS
primarily it's the main page that just looks weird without it
2022-03-24 22:28:09 -05:00
63a764c6a0 don't use system tz, display timestamps as UTC
no particular reason, just one less dependency, and it goes further
towards my idyllic world where everyone is on UTC and there are no
timezones
2022-03-24 22:12:00 -05:00
d129d04e04 remove mdx_linkify and do requirement bumps 2022-03-24 22:00:37 -05:00
410f96ffb4 relicense under the AGPLv3+
after a lot of deliberation I think I'm starting to prefer GPLv3 over
GPLv2 for copyleft, and this is a case where my rationale benefits from
the additions of the Affero clause
2022-01-17 16:55:24 -06:00
e325831f70 some tweaks to the CONTRIBUTING section 2022-01-17 16:49:40 -06:00
56289ab75d remove warning for coverage feature not in use 2022-01-15 17:40:12 -06:00
d623c9c93d adding support for 3.10, dropping support for 3.7 2022-01-15 17:35:56 -06:00
9d87aab61b go back to lighter red in dark style
contrast is just too low for the "incorporeal red"
2022-01-03 12:40:30 -06:00
35ea94185b unify some of the colors in light vs. dark 2022-01-02 22:55:43 -06:00
69feb0c29c add a 75% max-width class, using it for GOTY? 2022-01-02 22:51:21 -06:00
788a9cbaba use a smaller font for the styled pages 2022-01-02 22:50:04 -06:00
be6d96273c eliminate warnings about how we register the pydot markdown extension 2021-11-03 14:16:18 -05:00
a700470067 document the customization options
more work towards #15
2021-11-01 23:36:10 -05:00
8a62167cea remove some self-specific stuff from settings
implements most, if not all, of #15
2021-11-01 23:27:00 -05:00
4ea824e86f provide some comments explaining the css files 2021-11-01 23:20:42 -05:00
28dbfd45b5 remove bss-specific image from the package
part of the work of #15
2021-11-01 23:20:16 -05:00
1de69dfc70 requirements bump 2021-10-08 07:30:46 -05:00
ccf8434f43 remove a bunch of unnecessary font size styling
in the end, a lot of this doesn't really matter, and right now, I
slightly prefer the site with a touch bigger font, so let's just let the
default do its thing
2021-10-08 07:16:31 -05:00
5aabb79199 call the pydot rendering support 'dot' in package extras 2021-10-08 07:09:21 -05:00
509072ab78 safety in tox: scan requirements for known bad packages 2021-06-24 11:46:56 -05:00
e61c55bed2 handle graphviz parsing errors more cleanly 2021-06-24 11:37:57 -05:00
41a53a2a13 add py39 environment to tox test envs 2021-06-24 11:23:36 -05:00
da055acda6 provide markdown extension to render graphviz
this is server side, and a more standard format, and thus I like it more
than mermaid, which I've been using at work. but, I really wanted a
server-side option (see my manifesto) for drawing relationship graphs,
for D&D stuff of all things.

this adds an optional 'graphviz' feature to package installation which
consequently depends on pydot
2021-06-24 09:46:26 -05:00
1583e3be99 more debugging and catch md misconfigured error 2021-06-24 09:43:00 -05:00
946a557177 correct the license declaration to match LICENSE and README 2021-06-24 08:34:26 -05:00
f0d4e7d3d9 have footer clear: both;
closes #14
2021-06-06 22:28:43 -05:00
954f7f4e80 allow markdown files to specify a redirect
closes #13
2021-06-06 22:24:35 -05:00
27bb139a2b add installation and usage information 2021-06-05 22:59:00 -05:00
c15862850f add a CONTRIBUTING file 2021-06-04 17:41:18 -05:00
afbfab338f properly apply site wrap classes to style wide version
fixes #12
2021-06-03 07:52:01 -05:00
cac6b40af5 relicense the project under GPLv2
prepping for an actual public release of a sort, this hopefully
clarifies the license and copyright

license from https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
2021-06-02 07:44:23 -05:00
65bc028524 implement base-wide.html as an extension of base.html
not quite sure why I didn't think of this initially... too much hacking
2021-05-19 22:30:20 -05:00
e8377adcf5 allow pages to specify different templates 2021-04-30 19:41:39 -05:00
f4beb15a3b make directory redirects absolute paths
I think this is always the right choice, since we're rewriting the full
input path
2021-04-17 15:06:39 -05:00
da447d2873 Merge branch 'master' of git.incorporeal.org:bss/incorporeal-cms 2021-04-17 14:57:20 -05:00
cde82ab918 don't route /media separately anymore 2021-04-17 11:16:34 -05:00
1ac13f3b9c add some 500 tests for test coverage 2021-04-17 11:08:01 -05:00
6705fa38eb requirements bumps 2021-04-17 10:58:06 -05:00
30b79e9dc1 add tests for subdir symlinks
this is automagically supported by the previous rewrite
2021-04-17 10:39:05 -05:00
60715a3a5c make request -> instance conversion support symlink dirs
I think this also clarifies the code, a bit
2021-04-17 10:31:05 -05:00
c90f0a3a42 treat symlinks as redirects
closes #7
2021-04-15 21:44:02 -05:00
71ead20f3f have file handler return render type rather than bool
for when we have further types to render
2021-04-15 20:36:30 -05:00
be88c3c1bc don't error on breadcrumbs if a dir doesn't have index.md
fixes #8
2021-04-14 21:35:14 -05:00
ced67bec8b allow for serving files directly inside pages/ 2021-04-14 20:45:50 -05:00
f46bff6ec6 tweak language around the email 2021-02-23 13:16:58 -06:00
44 changed files with 1698 additions and 1006 deletions

76
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,76 @@
# 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
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.
### 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 *spirit* of the [Developer Certificate of Origin](https://developercertificate.org/),
but in a simplified fashion:
By making a contribution to this project, you certify that:
1. The contribution was created by you and you have the right to submit it under the open source license
indicated in the LICENSE file; or
2. The contribution is based upon previous work that is covered under an appropriate open source license
compatible with the license indicated in the LICENSE file, and you have the right to contribute that
work with or without modifications, under the terms of that same open source license; or
3. The contribution was provided directly to you by some other person who certified points 1, 2, or 3, and
you have not modified it.
In the event of point 3, your commit **must** include the Signed-off-by line(s) as a chain of custody,
via `git commit -s`. For points 1 and 2, your commit with accurate Author information doubles as direct
custody.

1279
LICENSE

File diff suppressed because it is too large Load Diff

View File

@@ -1,3 +1,66 @@
# incorporeal-cms # 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/>.

View File

@@ -3,7 +3,7 @@ import logging
import os import os
from logging.config import dictConfig from logging.config import dictConfig
from flask import Flask, request, send_from_directory from flask import Flask, request
from ._version import get_versions from ._version import get_versions
@@ -40,13 +40,9 @@ def create_app(instance_path=None, test_config=None):
logger.info("RESPONSE: %s %s: %s", request.method, request.path, response.status) logger.info("RESPONSE: %s %s: %s", request.method, request.path, response.status)
return response return response
@app.route(f'/{app.config["MEDIA_DIR"]}/<path:filename>') from . import error_pages, pages, static
def media_files(filename):
return send_from_directory(os.path.join(app.instance_path, app.config['MEDIA_DIR']),
filename)
from . import error_pages, pages
app.register_blueprint(pages.bp) app.register_blueprint(pages.bp)
app.register_blueprint(static.bp)
app.register_error_handler(400, error_pages.bad_request) app.register_error_handler(400, error_pages.bad_request)
app.register_error_handler(404, error_pages.page_not_found) app.register_error_handler(404, error_pages.page_not_found)
app.register_error_handler(500, error_pages.internal_server_error) app.register_error_handler(500, error_pages.internal_server_error)

View File

@@ -32,10 +32,9 @@ class Config(object):
}, },
} }
MARKDOWN_EXTENSIONS = ['extra', 'mdx_linkify', 'sane_lists', 'smarty', 'tables'] MARKDOWN_EXTENSIONS = ['extra', 'incorporealcms.mdx.figures', 'sane_lists', 'smarty', 'toc']
MARKDOWN_EXTENSION_CONFIGS = { MARKDOWN_EXTENSION_CONFIGS = {
'extra': { 'extra': {
'attr_list': {},
'footnotes': { 'footnotes': {
'UNIQUE_IDS': True, 'UNIQUE_IDS': True,
}, },
@@ -51,8 +50,14 @@ class Config(object):
MEDIA_DIR = 'media' MEDIA_DIR = 'media'
# customizations # customizations
DEFAULT_PAGE_STYLE = 'light' PAGE_STYLES = {
TITLE_SUFFIX = 'incorporeal.org' 'dark': '/static/css/dark.css',
CONTACT_EMAIL = 'bss@incorporeal.org' 'light': '/static/css/light.css',
'plain': '/static/css/plain.css',
}
# specify FAVICON in your instance config.py to override the suou icon DEFAULT_PAGE_STYLE = 'light'
TITLE_SUFFIX = 'example.com'
CONTACT_EMAIL = 'admin@example.com'
# specify FAVICON in your instance config.py to override the provided icon

View File

@@ -31,19 +31,15 @@ def render(template_name_or_list, **context):
* Determine the proper site theme to use in the template and provide it. * Determine the proper site theme to use in the template and provide it.
""" """
PAGE_STYLES = { page_styles = app.config['PAGE_STYLES']
'dark': 'css/dark.css',
'light': 'css/light.css',
'plain': 'css/plain.css',
}
selected_style = request.args.get('style', None) selected_style = request.args.get('style', None)
if selected_style: if selected_style:
user_style = selected_style user_style = selected_style
else: else:
user_style = request.cookies.get('user-style') user_style = request.cookies.get('user-style')
logger.debug("user style cookie: %s", 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['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)) resp = make_response(render_template(template_name_or_list, **context))
if selected_style: if selected_style:

View File

@@ -0,0 +1 @@
"""Markdown extensions."""

View File

@@ -0,0 +1,60 @@
"""Create generic figures with captions."""
import re
from xml.etree.ElementTree import SubElement
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)

View File

@@ -0,0 +1,54 @@
"""Serve dot diagrams inline."""
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)

View File

@@ -6,8 +6,8 @@ import re
from flask import Blueprint, Markup, abort from flask import Blueprint, Markup, abort
from flask import current_app as app from flask import current_app as app
from flask import redirect, request from flask import redirect, request, send_from_directory
from tzlocal import get_localzone from werkzeug.security import safe_join
from incorporealcms.lib import get_meta_str, init_md, render from incorporealcms.lib import get_meta_str, init_md, render
@@ -21,25 +21,53 @@ bp = Blueprint('pages', __name__, url_prefix='/')
def display_page(path): def display_page(path):
"""Get the file contents of the requested path and render the file.""" """Get the file contents of the requested path and render the file."""
try: try:
resolved_path = request_path_to_instance_resource_path(path) resolved_path, render_type = request_path_to_instance_resource_path(path)
logger.debug("received request for path '%s', resolved to '%s'", path, resolved_path) logger.debug("received request for path '%s', resolved to '%s', type '%s'",
path, resolved_path, render_type)
except PermissionError: except PermissionError:
abort(400) abort(400)
except IsADirectoryError: except IsADirectoryError:
return redirect(f'{path}/', code=301) return redirect(f'/{path}/', code=301)
except FileNotFoundError: except FileNotFoundError:
abort(404) 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:
logger.exception("unsupported render_type '%s'!?", render_type)
abort(500)
def handle_markdown_file_path(resolved_path):
"""Given a location on disk, attempt to open it and render the markdown within."""
try: try:
logger.debug("opening resolved path '%s'", resolved_path)
with app.open_instance_resource(resolved_path, 'r') as entry_file: with app.open_instance_resource(resolved_path, 'r') as entry_file:
mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), get_localzone()) mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), tz=datetime.timezone.utc)
entry = entry_file.read() entry = entry_file.read()
logger.debug("resolved path '%s' read", resolved_path)
except OSError: except OSError:
logger.exception("resolved path '%s' could not be opened!", resolved_path) logger.exception("resolved path '%s' could not be opened!", resolved_path)
abort(500) abort(500)
else: else:
md = init_md() try:
content = Markup(md.convert(entry)) md = init_md()
content = Markup(md.convert(entry))
except ValueError:
logger.exception("error parsing/rendering markdown!")
abort(500)
except TypeError:
logger.exception("error loading/rendering markdown!")
abort(500)
logger.debug("file metadata: %s", md.Meta) logger.debug("file metadata: %s", md.Meta)
parent_navs = generate_parent_navs(resolved_path) parent_navs = generate_parent_navs(resolved_path)
@@ -49,9 +77,20 @@ def display_page(path):
page_title = f'{page_name} - {app.config["TITLE_SUFFIX"]}' if page_name else app.config['TITLE_SUFFIX'] 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) logger.debug("title (potentially derived): %s", page_title)
return render('base.html', title=page_title, description=get_meta_str(md, 'description'), extra_footer = get_meta_str(md, 'footer') if md.Meta.get('footer') else None
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')) template = get_meta_str(md, 'template') if md.Meta.get('template') else 'base.html'
# check if this has a HTTP redirect
redirect_url = get_meta_str(md, 'redirect') if md.Meta.get('redirect') else None
if redirect_url:
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 request_path_to_instance_resource_path(path): def request_path_to_instance_resource_path(path):
@@ -63,34 +102,53 @@ def request_path_to_instance_resource_path(path):
""" """
# check if the path is allowed # check if the path is allowed
base_dir = os.path.realpath(f'{app.instance_path}/pages/') base_dir = os.path.realpath(f'{app.instance_path}/pages/')
resolved_path = os.path.realpath(os.path.join(base_dir, path)) safe_path = safe_join(base_dir, path)
logger.debug("base_dir: %s, constructed resolved_path: %s", base_dir, resolved_path)
# bail if the requested real path isn't inside the base directory # bail if the requested real path isn't inside the base directory
if base_dir != os.path.commonpath((base_dir, resolved_path)): if not safe_path:
logger.warning("client tried to request a path '%s' outside of the base_dir!", path) logger.warning("client tried to request a path '%s' outside of the base_dir!", path)
raise PermissionError raise PermissionError
# if this is a file-like requset but actually a directory, redirect the user verbatim_path = os.path.abspath(safe_path)
if os.path.isdir(resolved_path) and not path.endswith('/'): resolved_path = os.path.realpath(verbatim_path)
logger.info("client requested a path '%s' that is actually a directory", path) logger.debug("base_dir '%s', constructed resolved_path '%s' for path '%s'", base_dir, resolved_path, path)
raise IsADirectoryError
# derive the proper markdown file depending on if this is a dir or file # see if we have a real file or if we should infer markdown rendering
if os.path.isdir(resolved_path): if os.path.exists(resolved_path):
absolute_resource = os.path.join(resolved_path, 'index.md') # if this is a file-like request but actually a directory, redirect the user
else: if os.path.isdir(resolved_path) and not path.endswith('/'):
absolute_resource = f'{resolved_path}.md' logger.info("client requested a path '%s' that is actually a directory", path)
raise IsADirectoryError
logger.info("final path = '%s' for request '%s'", absolute_resource, path) # if the requested path contains a symlink, redirect the user
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'
# 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? # does the final file actually exist?
if not os.path.exists(absolute_resource): if not os.path.exists(resolved_path):
logger.warning("requested final path '%s' does not exist!", absolute_resource) logger.warning("requested final path '%s' does not exist!", resolved_path)
raise FileNotFoundError 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 # we checked that the file exists via absolute path, but now we need to give the path relative to instance dir
return absolute_resource.replace(f'{app.instance_path}{os.path.sep}', '') return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'markdown'
def instance_resource_path_to_request_path(path): def instance_resource_path_to_request_path(path):
@@ -127,12 +185,15 @@ def generate_parent_navs(path):
md = init_md() md = init_md()
# read the resource # read the resource
with app.open_instance_resource(path, 'r') as entry_file: try:
entry = entry_file.read() with app.open_instance_resource(path, 'r') as entry_file:
_ = Markup(md.convert(entry)) entry = entry_file.read()
page_name = (" ".join(md.Meta.get('title')) if md.Meta.get('title') _ = Markup(md.convert(entry))
else request_path_to_breadcrumb_display(request_path)) page_name = (" ".join(md.Meta.get('title')) if md.Meta.get('title')
return generate_parent_navs(parent_resource_path) + [(page_name, request_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): def request_path_to_breadcrumb_display(path):

14
incorporealcms/static.py Normal file
View File

@@ -0,0 +1,14 @@
"""Serve static files from the instance directory."""
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)

View File

@@ -11,74 +11,43 @@ body {
-webkit-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;
} }
.site-wrap-normal-width {
max-width: 65pc;
}
.site-wrap-double-width {
max-width: 130pc;
}
.site-wrap { .site-wrap {
max-width: 70pc;
min-height: 100vh; min-height: 100vh;
margin: 0; margin: 0;
margin-left: auto; margin-left: auto;
margin-right: 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; 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 { div.header {
display: flex; display: flex;
justify-content: space-between; justify-content: space-between;
font-size: 0.75em; font-size: 0.8em;
padding: 0.25em 0.5em; padding: 1rem 1rem;
} padding-bottom: 0;
div.header a {
border-bottom: none;
} }
div.content { div.content {
font-size: 11pt; 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 { sup, sub {
@@ -91,12 +60,17 @@ sub {
} }
footer { footer {
clear: both;
display: block; display: block;
font-size: 75%; font-size: 75%;
color: #999; color: #999;
padding: 0 1em; padding: 0 1em;
padding-bottom: 16px; padding-bottom: 16px;
margin-top: 15px; margin-top: 30px;
}
.extra-footer {
margin-bottom: 5px;
} }
table { table {
@@ -132,6 +106,10 @@ img {
max-width: 50% !important; max-width: 50% !important;
} }
.img-75 {
max-width: 75% !important;
}
.img-center { .img-center {
display: block; display: block;
margin-left: auto; margin-left: auto;
@@ -148,39 +126,26 @@ img {
margin-left: 1em; 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 { figure {
max-width: 400px;
padding: 5px; padding: 5px;
margin: 10px; margin: 0;
margin-top: 0;
margin-bottom: 5px; 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 { figure img {
@@ -189,19 +154,8 @@ figure img {
} }
figcaption { figcaption {
font-family: "Times New Roman", serif;
color: #777777;
text-align: center; 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 { .footnote {
@@ -213,6 +167,5 @@ figcaption {
} }
.footnote-ref:link, .footnote-ref:visited, .footnote-ref:hover, .footnote-ref:active { .footnote-ref:link, .footnote-ref:visited, .footnote-ref:hover, .footnote-ref:active {
border-bottom: none;
font-weight: normal; font-weight: normal;
} }

View File

@@ -1,47 +1,37 @@
/* common styling via the base.css, used in light and dark */
@import '/static/css/base.css'; @import '/static/css/base.css';
html { html {
color: #CCC; color: #DDD;
} }
body { body {
background: black;
}
strong {
color: #EEE;
}
.site-wrap {
background: #111; background: #111;
border: 1px solid #222;
border-top: none;
border-bottom: none;
} }
h1, h2, h3, h4, h5, h6 { h1, h2, h3, h4, h5, h6 {
color: #B31D15; 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; color: #B31D15;
border-bottom: 1px dotted #B31D15;
} }
div.header { div.site-wrap {
background: #222; background: black;
border-bottom: 1px solid #222;
color: #BBB;
} }
div.header a { div.header, div.header a {
color: #BBB; color: #555;
text-decoration: none;
} }
table, th, td { table, th, td {
@@ -57,16 +47,11 @@ blockquote {
border: 1px solid #222; border: 1px solid #222;
} }
.img-frame { figure {
background-color: rgba(255, 255, 255, 0.1); background-color: rgba(255, 255, 255, 0.1);
border: 1px solid #333; border: 1px solid #333;
} }
figure {
background: #222;
border: 1px solid #333;
}
figcaption { figcaption {
color: #BBB; color: #AAAAAA;
} }

View File

@@ -1,3 +1,4 @@
/* common styling via the base.css, used in light and dark */
@import '/static/css/base.css'; @import '/static/css/base.css';
html { html {
@@ -5,68 +6,52 @@ html {
} }
body { 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 { h1, h2, h3, h4, h5, h6 {
color: #811610; 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; color: #811610;
border-bottom: 1px dotted #811610;
} }
div.header { div.site-wrap {
background: #EEE; background: white;
border-bottom: 1px solid #CCC;
color: #666;
} }
div.header a { div.header, div.header a {
color: #666; color: #AAA;
text-decoration: none;
} }
table, th, td { table, th, td {
border: 1px solid #ccc; border: 1px solid #CCC;
} }
th { th {
background: #eee; background: #CCC;
} }
blockquote { blockquote {
background-color: rgba(120, 120, 120, 0.1); 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 { figure {
background: #EFEFEF; background-color: rgba(0, 0, 0, 0.1);
border: 1px solid #CCCCCC; border: 1px solid #CCC;
} }
figcaption { figcaption {
color: #777777; color: #666666;
} }

View File

@@ -1,3 +1,8 @@
/* specify almost no styling, just fix some image and nav rendering */
div.header {
display: flex;
justify-content: space-between;
}
.img-25 { .img-25 {
max-width: 25% !important; max-width: 25% !important;
@@ -6,3 +11,23 @@
.img-50 { .img-50 {
max-width: 50% !important; 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;
}

View File

@@ -10,7 +10,7 @@
<div class="content"> <div class="content">
<h1>NOT FOUND</h1> <h1>NOT FOUND</h1>
<p>Sorry, <b><tt>{{ request.path }}</tt></b> does not seem to exist, at least not anymore.</p> <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 via: <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, {{ 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> 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 <p>Otherwise, I suggest you go <a href="/">to the index</a> and navigate your way (hopefully) to what

View File

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

View File

@@ -7,10 +7,10 @@
<meta property="og:url" content="{{ base_url }}"> <meta property="og:url" content="{{ base_url }}">
<meta name="twitter:card" content="summary_large_image"> <meta name="twitter:card" content="summary_large_image">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}"> <link rel="stylesheet" href="{{ user_style }}">
<link rel="icon" href="{% if config.FAVICON %}{{ config.FAVICON }}{% else %}{{ url_for('static', filename='img/favicon.png') }}{% endif %}"> <link rel="icon" href="{% if config.FAVICON %}{{ config.FAVICON }}{% else %}{{ url_for('static', filename='img/favicon.png') }}{% endif %}">
<div class="site-wrap"> <div {% block site_class %}class="site-wrap site-wrap-normal-width"{% endblock %}>
{% block header %} {% block header %}
<div class="header"> <div class="header">
<div class="nav"> <div class="nav">
@@ -20,9 +20,9 @@
{% endfor %} {% endfor %}
</div> </div>
<div class="styles"> <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>
<a href="?style=plain">[plain]</a> {% endfor %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}
@@ -31,7 +31,8 @@
{{ content }} {{ content }}
</div> </div>
<footer> <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> </footer>
{% endblock %} {% endblock %}
</div> </div>

View File

@@ -1,11 +1,12 @@
-r requirements.in -r requirements.in
# testing runner, test reporting, packages used during testing (e.g. requests-mock), etc. # testing runner, test reporting, packages used during testing (e.g. requests-mock), etc.
pydot
pytest pytest
pytest-cov pytest-cov
# linting and other static code analysis # linting and other static code analysis
bandit==1.6.2 # pinned because 1.7.0 wasn't running right in tox bandit
dlint dlint
flake8 flake8
flake8-blind-except flake8-blind-except
@@ -16,9 +17,10 @@ flake8-fixme
flake8-isort flake8-isort
flake8-logging-format flake8-logging-format
flake8-mutable flake8-mutable
safety # check requirements file for issues
# maintenance utilities and tox # maintenance utilities and tox
pip-tools # pip-compile pip-tools # pip-compile
tox # CI stuff tox<4 # CI stuff, pinned for now to avoid packaging conflict w/safety
tox-wheel # build wheels in tox tox-wheel # build wheels in tox
versioneer # automatic version numbering versioneer # automatic version numbering

View File

@@ -1,48 +1,39 @@
# #
# This file is autogenerated by pip-compile # This file is autogenerated by pip-compile with Python 3.10
# To update, run: # by the following command:
# #
# pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in # pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in
# #
appdirs==1.4.4 attrs==22.2.0
# via virtualenv
attrs==20.3.0
# via pytest # via pytest
bandit==1.6.2 bandit==1.7.4
# via -r requirements/requirements-dev.in # via -r requirements/requirements-dev.in
bleach==3.3.0 build==0.9.0
# via mdx-linkify # via pip-tools
click==7.1.2 certifi==2022.12.7
# via requests
charset-normalizer==2.1.1
# via requests
click==8.1.3
# via # via
# flask # flask
# pip-tools # pip-tools
coverage==5.4 # safety
coverage[toml]==7.0.1
# via pytest-cov # via pytest-cov
distlib==0.3.1 distlib==0.3.6
# via virtualenv # via virtualenv
dlint==0.11.0 dlint==0.13.0
# via -r requirements/requirements-dev.in # via -r requirements/requirements-dev.in
filelock==3.0.12 dparse==0.6.2
# via safety
exceptiongroup==1.1.0
# via pytest
filelock==3.9.0
# via # via
# tox # tox
# virtualenv # virtualenv
flake8-blind-except==0.2.0 flake8==5.0.4
# 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 # via
# -r requirements/requirements-dev.in # -r requirements/requirements-dev.in
# dlint # dlint
@@ -51,101 +42,130 @@ flake8==3.8.4
# flake8-executable # flake8-executable
# flake8-isort # flake8-isort
# flake8-mutable # flake8-mutable
flask==1.1.2 flake8-blind-except==0.2.1
# via -r requirements/requirements-dev.in
flake8-builtins==2.1.0
# via -r requirements/requirements-dev.in
flake8-docstrings==1.6.0
# via -r requirements/requirements-dev.in
flake8-executable==2.1.2
# via -r requirements/requirements-dev.in
flake8-fixme==1.1.1
# via -r requirements/requirements-dev.in
flake8-isort==6.0.0
# via -r requirements/requirements-dev.in
flake8-logging-format==0.9.0
# via -r requirements/requirements-dev.in
flake8-mutable==1.2.0
# via -r requirements/requirements-dev.in
flask==2.2.2
# via -r requirements/requirements.in # via -r requirements/requirements.in
gitdb==4.0.5 gitdb==4.0.10
# via gitpython # via gitpython
gitpython==3.1.13 gitpython==3.1.30
# via bandit # via bandit
idna==3.4
# via requests
iniconfig==1.1.1 iniconfig==1.1.1
# via pytest # via pytest
isort==5.7.0 isort==5.11.4
# via flake8-isort # via flake8-isort
itsdangerous==1.1.0 itsdangerous==2.1.2
# via flask # via flask
jinja2==2.11.3 jinja2==3.1.2
# via flask # via flask
markdown==3.3.3 markdown==3.4.1
# via
# -r requirements/requirements.in
# mdx-linkify
markupsafe==1.1.1
# via jinja2
mccabe==0.6.1
# via flake8
mdx-linkify==2.1
# via -r requirements/requirements.in # via -r requirements/requirements.in
packaging==20.9 markupsafe==2.1.1
# via # via
# bleach # jinja2
# werkzeug
mccabe==0.7.0
# via flake8
packaging==21.3
# via
# build
# dparse
# pytest # pytest
# safety
# tox # tox
pbr==5.5.1 pbr==5.11.0
# via stevedore # via stevedore
pip-tools==5.5.0 pep517==0.13.0
# via build
pip-tools==6.12.1
# via -r requirements/requirements-dev.in # via -r requirements/requirements-dev.in
pluggy==0.13.1 platformdirs==2.6.2
# via virtualenv
pluggy==1.0.0
# via # via
# pytest # pytest
# tox # tox
py==1.10.0 py==1.11.0
# via # via tox
# pytest pycodestyle==2.9.1
# tox
pycodestyle==2.6.0
# via flake8 # via flake8
pydocstyle==5.1.1 pydocstyle==6.1.1
# via flake8-docstrings # via flake8-docstrings
pyflakes==2.2.0 pydot==1.4.2
# via flake8
pyparsing==2.4.7
# via packaging
pytest-cov==2.11.1
# via -r requirements/requirements-dev.in # via -r requirements/requirements-dev.in
pytest==6.2.2 pyflakes==2.5.0
# via flake8
pyparsing==3.0.9
# via
# packaging
# pydot
pytest==7.2.0
# via # via
# -r requirements/requirements-dev.in # -r requirements/requirements-dev.in
# pytest-cov # pytest-cov
pytz==2021.1 pytest-cov==4.0.0
# via tzlocal # via -r requirements/requirements-dev.in
pyyaml==5.4.1 pyyaml==6.0
# via bandit # via bandit
six==1.15.0 requests==2.28.1
# via # via safety
# bandit ruamel-yaml==0.17.21
# bleach # via safety
# tox ruamel-yaml-clib==0.2.7
# virtualenv # via ruamel-yaml
smmap==3.0.5 safety==2.3.5
# via -r requirements/requirements-dev.in
six==1.16.0
# via tox
smmap==5.0.0
# via gitdb # via gitdb
snowballstemmer==2.1.0 snowballstemmer==2.2.0
# via pydocstyle # via pydocstyle
stevedore==3.3.0 stevedore==4.1.1
# via bandit # via bandit
testfixtures==6.17.1
# via flake8-isort
toml==0.10.2 toml==0.10.2
# via dparse
tomli==2.0.1
# via # via
# build
# coverage
# pep517
# pytest # pytest
# tox # tox
tox-wheel==0.6.0 tox==3.28.0
# via -r requirements/requirements-dev.in
tox==3.22.0
# via # via
# -r requirements/requirements-dev.in # -r requirements/requirements-dev.in
# tox-wheel # tox-wheel
tzlocal==2.1 tox-wheel==1.0.0
# via -r requirements/requirements.in
versioneer==0.19
# via -r requirements/requirements-dev.in # via -r requirements/requirements-dev.in
virtualenv==20.4.2 urllib3==1.26.13
# via requests
versioneer==0.28
# via -r requirements/requirements-dev.in
virtualenv==20.17.1
# via tox # via tox
webencodings==0.5.1 werkzeug==2.2.2
# via bleach
werkzeug==1.0.1
# via flask # via flask
wheel==0.36.2 wheel==0.38.4
# via tox-wheel # via
# pip-tools
# tox-wheel
# The following packages are considered to be unsafe in a requirements file: # The following packages are considered to be unsafe in a requirements file:
# pip # pip

View File

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

View File

@@ -1,38 +1,22 @@
# #
# This file is autogenerated by pip-compile # This file is autogenerated by pip-compile with python 3.10
# To update, run: # To update, run:
# #
# pip-compile --output-file=requirements/requirements.txt requirements/requirements.in # pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
# #
bleach==3.3.0 click==8.1.3
# via mdx-linkify
click==7.1.2
# via flask # via flask
flask==1.1.2 flask==2.2.2
# via -r requirements/requirements.in # via -r requirements/requirements.in
itsdangerous==1.1.0 itsdangerous==2.1.2
# via flask # via flask
jinja2==2.11.3 jinja2==3.1.2
# via flask # via flask
markdown==3.3.3 markdown==3.4.1
# via -r requirements/requirements.in
markupsafe==2.1.1
# via # via
# -r requirements/requirements.in # jinja2
# mdx-linkify # werkzeug
markupsafe==1.1.1 werkzeug==2.2.2
# via jinja2
mdx-linkify==2.1
# via -r requirements/requirements.in
packaging==20.9
# via bleach
pyparsing==2.4.7
# via packaging
pytz==2021.1
# 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 # via flask

View File

@@ -18,13 +18,19 @@ setup(
name='incorporeal-cms', name='incorporeal-cms',
description='Flask project for running https://suou.net (and eventually others).', description='Flask project for running https://suou.net (and eventually others).',
url='https://git.incorporeal.org/bss/incorporeal-cms', url='https://git.incorporeal.org/bss/incorporeal-cms',
license='GPL3',
author='Brian S. Stephan', author='Brian S. Stephan',
author_email='bss@incorporeal.org', author_email='bss@incorporeal.org',
license='AGPLv3+',
classifiers=[
'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
],
version=versioneer.get_version(), version=versioneer.get_version(),
cmdclass=versioneer.get_cmdclass(), cmdclass=versioneer.get_cmdclass(),
packages=find_packages(), packages=find_packages(),
include_package_data=True, include_package_data=True,
zip_safe=False, zip_safe=False,
install_requires=extract_requires(), install_requires=extract_requires(),
extras_require={
'dot': ['pydot'],
},
) )

View File

@@ -0,0 +1,63 @@
"""Test graphviz functionality."""
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

View File

@@ -1,12 +1,20 @@
"""Test page requests.""" """Test page requests."""
import re import re
from unittest.mock import patch
def test_page_that_exists(client): def test_page_that_exists(client):
"""Test that the app can serve a basic file at the index.""" """Test that the app can serve a basic file at the index."""
response = client.get('/') response = client.get('/')
assert response.status_code == 200 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): def test_page_that_doesnt_exist(client):
@@ -15,7 +23,7 @@ def test_page_that_doesnt_exist(client):
assert response.status_code == 404 assert response.status_code == 404
assert b'<b><tt>/ohuesthaoeusth</tt></b> does not seem to exist' in response.data assert b'<b><tt>/ohuesthaoeusth</tt></b> does not seem to exist' in response.data
# test the contact email config # test the contact email config
assert b'bss@incorporeal.org' in response.data assert b'admin@example.com' in response.data
def test_files_outside_pages_do_not_get_served(client): def test_files_outside_pages_do_not_get_served(client):
@@ -31,7 +39,25 @@ def test_internal_server_error_serves_error_page(client):
assert response.status_code == 500 assert response.status_code == 500
assert b'INTERNAL SERVER ERROR' in response.data assert b'INTERNAL SERVER ERROR' in response.data
# test the contact email config # test the contact email config
assert b'bss@incorporeal.org' in response.data 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): def test_weird_paths_do_not_get_served(client):
@@ -44,28 +70,28 @@ def test_page_with_title_metadata(client):
"""Test that a page with title metadata has its title written.""" """Test that a page with title metadata has its title written."""
response = client.get('/') response = client.get('/')
assert response.status_code == 200 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): def test_page_without_title_metadata(client):
"""Test that a page without title metadata gets the default title.""" """Test that a page without title metadata gets the default title."""
response = client.get('/no-title') response = client.get('/no-title')
assert response.status_code == 200 assert response.status_code == 200
assert b'<title>/no-title - incorporeal.org</title>' in response.data assert b'<title>/no-title - example.com</title>' in response.data
def test_page_in_subdir_without_title_metadata(client): def test_page_in_subdir_without_title_metadata(client):
"""Test that the title-less page display is as expected.""" """Test that the title-less page display is as expected."""
response = client.get('/subdir//page-no-title') response = client.get('/subdir//page-no-title')
assert response.status_code == 200 assert response.status_code == 200
assert b'<title>/subdir/page-no-title - incorporeal.org</title>' in response.data assert b'<title>/subdir/page-no-title - example.com</title>' in response.data
def test_page_with_card_metadata(client): def test_page_with_card_metadata(client):
"""Test that a page with opengraph metadata.""" """Test that a page with opengraph metadata."""
response = client.get('/more-metadata') response = client.get('/more-metadata')
assert response.status_code == 200 assert response.status_code == 200
assert b'<meta property="og:title" content="title for the page - incorporeal.org">' 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: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 assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
@@ -74,7 +100,7 @@ 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.""" """Test that a page without metadata still has a card with the derived title."""
response = client.get('/no-title') response = client.get('/no-title')
assert response.status_code == 200 assert response.status_code == 200
assert b'<meta property="og:title" content="/no-title - incorporeal.org">' in response.data 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:description"' not in response.data
assert b'<meta property="og:image"' not in response.data assert b'<meta property="og:image"' not in response.data
@@ -83,7 +109,14 @@ 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.""" """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') response = client.get('/forced-no-title')
assert response.status_code == 200 assert response.status_code == 200
assert b'<title>incorporeal.org</title>' in response.data 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): def test_page_has_modified_timestamp(client):
@@ -101,6 +134,44 @@ def test_that_page_request_redirects_to_directory(client):
""" """
response = client.get('/subdir') response = client.get('/subdir')
assert response.status_code == 301 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): def test_that_dir_request_does_not_redirect(client):
@@ -119,13 +190,51 @@ def test_setting_selected_style_includes_cookie(client):
response = client.get('/?style=light') response = client.get('/?style=light')
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None) style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
assert response.status_code == 200 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' assert style_cookie.value == 'light'
response = client.get('/?style=dark') response = client.get('/?style=dark')
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None) style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
assert response.status_code == 200 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' 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

View File

@@ -15,6 +15,10 @@ LOGGING = {
}, },
}, },
'loggers': { 'loggers': {
'incorporealcms.mdx': {
'level': 'DEBUG',
'handlers': ['console'],
},
'incorporealcms.pages': { 'incorporealcms.pages': {
'level': 'DEBUG', 'level': 'DEBUG',
'handlers': ['console'], 'handlers': ['console'],

View File

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

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

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

View File

@@ -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)

View File

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

View File

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

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1 @@
subdir

View File

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

View File

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

View File

@@ -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

View File

@@ -20,7 +20,7 @@ def test_markdown_meta_extension_always():
client = app.test_client() client = app.test_client()
response = client.get('/') response = client.get('/')
assert response.status_code == 200 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(): def test_custom_markdown_extensions_work():
@@ -68,3 +68,12 @@ def test_favicon_override():
response = client.get('/no-title') response = client.get('/no-title')
assert response.status_code == 200 assert response.status_code == 200
assert b'<link rel="icon" href="/media/foo.png">' in response.data 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

View File

@@ -1,27 +1,32 @@
"""Unit test helper methods.""" """Unit test helper methods."""
import os
import pytest import pytest
from werkzeug.http import dump_cookie from werkzeug.http import dump_cookie
from incorporealcms import create_app
from incorporealcms.pages import (generate_parent_navs, instance_resource_path_to_request_path, render, 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) request_path_to_breadcrumb_display, request_path_to_instance_resource_path)
HERE = os.path.dirname(os.path.abspath(__file__))
def test_generate_page_navs_index(app): def test_generate_page_navs_index(app):
"""Test that the index page has navs to the root (itself).""" """Test that the index page has navs to the root (itself)."""
with app.app_context(): with app.app_context():
assert generate_parent_navs('pages/index.md') == [('incorporeal.org', '/')] assert generate_parent_navs('pages/index.md') == [('example.com', '/')]
def test_generate_page_navs_subdir_index(app): def test_generate_page_navs_subdir_index(app):
"""Test that dir pages have navs to the root and themselves.""" """Test that dir pages have navs to the root and themselves."""
with app.app_context(): with app.app_context():
assert generate_parent_navs('pages/subdir/index.md') == [('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): def test_generate_page_navs_subdir_real_page(app):
"""Test that real pages have navs to the root, their parent, and themselves.""" """Test that real pages have navs to the root, their parent, and themselves."""
with app.app_context(): with app.app_context():
assert generate_parent_navs('pages/subdir/page.md') == [('incorporeal.org', '/'), ('subdir', '/subdir/'), assert generate_parent_navs('pages/subdir/page.md') == [('example.com', '/'), ('subdir', '/subdir/'),
('Page', '/subdir/page')] ('Page', '/subdir/page')]
@@ -29,75 +34,138 @@ def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
"""Test that title metadata is used in the nav text.""" """Test that title metadata is used in the nav text."""
with app.app_context(): with app.app_context():
assert generate_parent_navs('pages/subdir-with-title/page.md') == [ assert generate_parent_navs('pages/subdir-with-title/page.md') == [
('incorporeal.org', '/'), ('example.com', '/'),
('SUB!', '/subdir-with-title/'), ('SUB!', '/subdir-with-title/'),
('page', '/subdir-with-title/page') ('page', '/subdir-with-title/page')
] ]
def test_generate_page_navs_subdir_with_no_index(app):
"""Test that breadcrumbs still generate even if a subdir doesn't have an index.md."""
with app.app_context():
assert generate_parent_navs('pages/no-index-dir/page.md') == [
('example.com', '/'),
('/no-index-dir/', '/no-index-dir/'),
('page', '/no-index-dir/page')
]
def test_render_with_user_dark_theme(app): def test_render_with_user_dark_theme(app):
"""Test that a request with the dark theme selected renders the dark theme.""" """Test that a request with the dark theme selected renders the dark theme."""
cookie = dump_cookie("user-style", 'dark') cookie = dump_cookie("user-style", 'dark')
with app.test_request_context(headers={'COOKIE': cookie}): 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): def test_render_with_user_light_theme(app):
"""Test that a request with the light theme selected renders the light theme.""" """Test that a request with the light theme selected renders the light theme."""
with app.test_request_context(): 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): def test_render_with_no_user_theme(app):
"""Test that a request with no theme set renders the light theme.""" """Test that a request with no theme set renders the light theme."""
with app.test_request_context(): 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): def test_request_path_to_instance_resource_path(app):
"""Test a normal URL request is transformed into the file path.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert request_path_to_instance_resource_path('index') == 'pages/index.md' assert request_path_to_instance_resource_path('index') == ('pages/index.md', 'markdown')
def test_request_path_to_instance_resource_path_direct_file(app): def test_request_path_to_instance_resource_path_direct_file(app):
"""Test a normal URL request is transformed into the file path.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert request_path_to_instance_resource_path('no-title') == 'pages/no-title.md' 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): def test_request_path_to_instance_resource_path_in_subdir(app):
"""Test a normal URL request is transformed into the file path.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert request_path_to_instance_resource_path('subdir/page') == 'pages/subdir/page.md' 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): def test_request_path_to_instance_resource_path_subdir_index(app):
"""Test a normal URL request is transformed into the file path.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert request_path_to_instance_resource_path('subdir/') == 'pages/subdir/index.md' assert request_path_to_instance_resource_path('subdir/') == ('pages/subdir/index.md', 'markdown')
def test_request_path_to_instance_resource_path_relatives_walked(app): def test_request_path_to_instance_resource_path_relatives_walked(app):
"""Test a normal URL request is transformed into the file path.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert (request_path_to_instance_resource_path('subdir/more-subdir/../../more-metadata') == assert (request_path_to_instance_resource_path('subdir/more-subdir/../../more-metadata') ==
'pages/more-metadata.md') ('pages/more-metadata.md', 'markdown'))
def test_request_path_to_instance_resource_path_relatives_walked_indexes_work_too(app): 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.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert request_path_to_instance_resource_path('subdir/more-subdir/../../') == 'pages/index.md' 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): 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.""" """Test a normal URL request is transformed into the file path."""
with app.test_request_context(): with app.test_request_context():
assert request_path_to_instance_resource_path('subdir/more-subdir/../../subdir/page') == 'pages/subdir/page.md' 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): def test_request_path_to_instance_resource_path_permission_error_on_ref_above_pages(app):
@@ -114,6 +182,41 @@ def test_request_path_to_instance_resource_path_isadirectory_on_file_like_req_fo
assert request_path_to_instance_resource_path('subdir') 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): def test_request_path_to_instance_resource_path_nonexistant_file_errors(app):
"""Test that a request for something not on disk errors.""" """Test that a request for something not on disk errors."""
with app.test_request_context(): with app.test_request_context():
@@ -155,13 +258,15 @@ def test_instance_resource_path_to_request_path_on_subdir_and_page(app):
def test_request_resource_request_root(app): def test_request_resource_request_root(app):
"""Test that a request can resolve to a resource and back to a request.""" """Test that a request can resolve to a resource and back to a request."""
with app.test_request_context(): with app.test_request_context():
instance_resource_path_to_request_path(request_path_to_instance_resource_path('index')) == '' instance_path, _ = request_path_to_instance_resource_path('index')
instance_resource_path_to_request_path(instance_path) == ''
def test_request_resource_request_page(app): def test_request_resource_request_page(app):
"""Test that a request can resolve to a resource and back to a request.""" """Test that a request can resolve to a resource and back to a request."""
with app.test_request_context(): with app.test_request_context():
instance_resource_path_to_request_path(request_path_to_instance_resource_path('no-title')) == 'no-title' 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(): def test_request_path_to_breadcrumb_display_patterns():

19
tox.ini
View File

@@ -4,7 +4,7 @@
# and then run "tox" from this directory. # and then run "tox" from this directory.
[tox] [tox]
envlist = begin,py37,py38,coverage,security,lint,bundle envlist = begin,py38,py39,py310,coverage,security,lint,bundle
[testenv] [testenv]
# build a wheel and test it # build a wheel and test it
@@ -31,12 +31,17 @@ deps = setuptools
skip_install = true skip_install = true
commands = coverage erase commands = coverage erase
[testenv:py37] [testenv:py38]
# run pytest with coverage # run pytest with coverage
commands = commands =
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch 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 # run pytest with coverage
commands = commands =
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
@@ -51,8 +56,10 @@ commands =
# run security checks # run security checks
# #
# again it seems the most valuable here to run against the packaged code # again it seems the most valuable here to run against the packaged code
# 51457 is nearly a red herring that I'm stuck with because tox is pinned, try removing occasionally
commands = commands =
bandit {envsitepackagesdir}/incorporealcms/ -r bandit {envsitepackagesdir}/incorporealcms/ -r
safety check -r requirements/requirements-dev.txt -i 51457
[testenv:lint] [testenv:lint]
# run style checks # run style checks
@@ -74,12 +81,6 @@ source =
[coverage:run] [coverage:run]
branch = True 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 = omit =
**/_version.py **/_version.py