61 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
34 changed files with 1330 additions and 632 deletions

View File

@@ -1,19 +1,36 @@
# How to Contribute # How to Contribute
incorporeal-cms is a personal project seeking to implement a simpler, cleaner form of what would 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 incorporeal-cms better. 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 ## Opening Issues
Issues should be posted to my Gitea instance at 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 <https://git.incorporeal.org/bss/incorporeal-cms/issues>. I'm not too picky about format, but I
recommend starting the title with "Improvement:" or "Bug:" so I can do a high level of recommend starting the title with "Improvement:", "Bug:", or similar, so I can do a high level of
prioritization. prioritization.
## Providing Code ## Contributions
Some guidelines: 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: * Code:
* Keep in mind that I strive for simplicity in the software. It serves files and renders * 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 Markdown, that's pretty much it. Features around that function are good; otherwise, I need
@@ -29,19 +46,31 @@ Some guidelines:
* Squash tiny commits if you'd like. I prefer commits that make one atomic conceptual change * 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 that doesn't affect the rest of the code, assembling multiple of those commits into larger
changes. changes.
* Follow something like [Chris Beams'](https://chris.beams.io/posts/git-commit/) post on * Follow something like [Chris Beams's post](https://chris.beams.io/posts/git-commit/) on
formatting a good commit message. 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.
### Contributing ### Custody of Contributions
I don't expect contributors to sign up for my personal Gitea in order to send contributions, but it I do not request the copyright of contributions be assigned to me or to the project, and I require no
of course makes it easier. If you wish to go this route, please sign up at provision that I be allowed to relicense your contributions. My personal oath is to maintain
<https://git.incorporeal.org/bss/incorporeal-cms> and fork the project. People planning on inbound=outbound in my open source projects, and the expectation is authors are responsible for their
contributing often are also welcome to request access to the project directly. contributions.
Otherwise, contact me via any means you know to reach me at, or <bss@incorporeal.org>, to discuss I am following the *spirit* of the [Developer Certificate of Origin](https://developercertificate.org/),
your change and to tell me how to pull your changes. but in a simplified fashion:
Accepted changes remain the copyright of the original author, but please include appropriate contact By making a contribution to this project, you certify that:
methods in the event I choose to provide the project under a new license and need to contact you
to approve the new license terms. Please note that the software is provided under GPLv2 or later. 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.

844
LICENSE
View File

@@ -1,281 +1,620 @@
GNU GENERAL PUBLIC LICENSE GNU AFFERO GENERAL PUBLIC LICENSE
Version 2, June 1991 Version 3, 19 November 2007
Copyright (C) 1989, 1991 Free Software Foundation, Inc., Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed. of this license document, but changing it is not allowed.
Preamble Preamble
The licenses for most software are designed to take away your The GNU Affero General Public License is a free, copyleft license for
freedom to share and change it. By contrast, the GNU General Public software and other kinds of works, specifically designed to ensure
License is intended to guarantee your freedom to share and change free cooperation with the community in the case of network server software.
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software The licenses for most software and other practical works are designed
Foundation's software and to any other program whose authors commit to to take away your freedom to share and change the works. By contrast,
using it. (Some other Free Software Foundation software is covered by our General Public Licenses are intended to guarantee your freedom to
the GNU Lesser General Public License instead.) You can apply it to share and change all versions of a program--to make sure it remains free
your programs, too. software for all its users.
When we speak of free software, we are referring to freedom, not When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it them if you wish), that you receive source code or can get it if you
if you want it, that you can change the software or use pieces of it want it, that you can change the software or use pieces of it in new
in new free programs; and that you know you can do these things. free programs, and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid Developers that use our General Public Licenses protect your rights
anyone to deny you these rights or to ask you to surrender the rights. with two steps: (1) assert copyright on the software, and (2) offer
These restrictions translate to certain responsibilities for you if you you this License which gives you legal permission to copy, distribute
distribute copies of the software, or if you modify it. and/or modify the software.
For example, if you distribute copies of such a program, whether A secondary benefit of defending all users' freedom is that
gratis or for a fee, you must give the recipients all the rights that improvements made in alternate versions of the program, if they
you have. You must make sure that they, too, receive or can get the receive widespread use, become available for other developers to
source code. And you must show them these terms so they know their incorporate. Many developers of free software are heartened and
rights. encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
We protect your rights with two steps: (1) copyright the software, and The GNU Affero General Public License is designed specifically to
(2) offer you this license which gives you legal permission to copy, ensure that, in such cases, the modified source code becomes available
distribute and/or modify the software. to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
Also, for each author's protection and ours, we want to make certain An older license, called the Affero General Public License and
that everyone understands that there is no warranty for this free published by Affero, was designed to accomplish similar goals. This is
software. If the software is modified by someone else and passed on, we a different license, not a version of the Affero GPL, but Affero has
want its recipients to know that what they have is not the original, so released a new version of the Affero GPL which permits relicensing under
that any problems introduced by others will not reflect on the original this license.
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and The precise terms and conditions for copying, distribution and
modification follow. modification follow.
GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains 0. Definitions.
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not "This License" refers to version 3 of the GNU Affero General Public License.
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's "Copyright" also means copyright-like laws that apply to other kinds of
source code as you receive it, in any medium, provided that you works, such as semiconductor masks.
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and "The Program" refers to any copyrightable work licensed under this
you may at your option offer warranty protection in exchange for a fee. License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
2. You may modify your copy or copies of the Program or any portion To "modify" a work means to copy from or adapt all or part of the work
of it, thus forming a work based on the Program, and copy and in a fashion requiring copyright permission, other than the making of an
distribute such modifications or work under the terms of Section 1 exact copy. The resulting work is called a "modified version" of the
above, provided that you also meet all of these conditions: earlier work or a work "based on" the earlier work.
a) You must cause the modified files to carry prominent notices A "covered work" means either the unmodified Program or a work based
stating that you changed the files and the date of any change. on the Program.
b) You must cause any work that you distribute or publish, that in To "propagate" a work means to do anything with it that, without
whole or in part contains or is derived from the Program or any permission, would make you directly or secondarily liable for
part thereof, to be licensed as a whole at no charge to all third infringement under applicable copyright law, except executing it on a
parties under the terms of this License. computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
c) If the modified program normally reads commands interactively To "convey" a work means any kind of propagation that enables other
when run, you must cause it, when started running for such parties to make or receive copies. Mere interaction with a user through
interactive use in the most ordinary way, to print or display an a computer network, with no transfer of a copy, is not conveying.
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If An interactive user interface displays "Appropriate Legal Notices"
identifiable sections of that work are not derived from the Program, to the extent that it includes a convenient and prominently visible
and can be reasonably considered independent and separate works in feature that (1) displays an appropriate copyright notice, and (2)
themselves, then this License, and its terms, do not apply to those tells the user that there is no warranty for the work (except to the
sections when you distribute them as separate works. But when you extent that warranties are provided), that licensees may convey the
distribute the same sections as part of a whole which is a work based work under this License, and how to view a copy of this License. If
on the Program, the distribution of the whole must be on the terms of the interface presents a list of user commands or options, such as a
this License, whose permissions for other licensees extend to the menu, a prominent item in the list meets this criterion.
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest 1. Source Code.
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program The "source code" for a work means the preferred form of the work
with the Program (or with a work based on the Program) on a volume of for making modifications to it. "Object code" means any non-source
a storage or distribution medium does not bring the other work under form of a work.
the scope of this License.
3. You may copy and distribute the Program (or a work based on it, A "Standard Interface" means an interface that either is an official
under Section 2) in object code or executable form under the terms of standard defined by a recognized standards body, or, in the case of
Sections 1 and 2 above provided that you also do one of the following: interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
a) Accompany it with the complete corresponding machine-readable The "System Libraries" of an executable work include anything, other
source code, which must be distributed under the terms of Sections than the work as a whole, that (a) is included in the normal form of
1 and 2 above on a medium customarily used for software interchange; or, packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
b) Accompany it with a written offer, valid for at least three The "Corresponding Source" for a work in object code form means all
years, to give any third party, for a charge no more than your the source code needed to generate, install, and (for an executable
cost of physically performing source distribution, a complete work) run the object code and to modify the work, including scripts to
machine-readable copy of the corresponding source code, to be control those activities. However, it does not include the work's
distributed under the terms of Sections 1 and 2 above on a medium System Libraries, or general-purpose tools or generally available free
customarily used for software interchange; or, programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
c) Accompany it with the information you received as to the offer The Corresponding Source need not include anything that users
to distribute corresponding source code. (This alternative is can regenerate automatically from other parts of the Corresponding
allowed only for noncommercial distribution and only if you Source.
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for The Corresponding Source for a work in source code form is that
making modifications to it. For an executable work, complete source same work.
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering 2. Basic Permissions.
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program All rights granted under this License are granted for the term of
except as expressly provided under this License. Any attempt copyright on the Program, and are irrevocable provided the stated
otherwise to copy, modify, sublicense or distribute the Program is conditions are met. This License explicitly affirms your unlimited
void, and will automatically terminate your rights under this License. permission to run the unmodified Program. The output from running a
However, parties who have received copies, or rights, from you under covered work is covered by this License only if the output, given its
this License will not have their licenses terminated so long as such content, constitutes a covered work. This License acknowledges your
parties remain in full compliance. rights of fair use or other equivalent, as provided by copyright law.
5. You are not required to accept this License, since you have not You may make, run and propagate covered works that you do not
signed it. However, nothing else grants you permission to modify or convey, without conditions so long as your license otherwise remains
distribute the Program or its derivative works. These actions are in force. You may convey covered works to others for the sole purpose
prohibited by law if you do not accept this License. Therefore, by of having them make modifications exclusively for you, or provide you
modifying or distributing the Program (or any work based on the with facilities for running those works, provided that you comply with
Program), you indicate your acceptance of this License to do so, and the terms of this License in conveying all material for which you do
all its terms and conditions for copying, distributing or modifying not control copyright. Those thus making or running the covered works
the Program or works based on it. for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
6. Each time you redistribute the Program (or any work based on the Conveying under any other circumstances is permitted solely under
Program), the recipient automatically receives a license from the the conditions stated below. Sublicensing is not allowed; section 10
original licensor to copy, distribute or modify the Program subject to makes it unnecessary.
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein. 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
You are not responsible for enforcing compliance by third parties to
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License. this License.
7. If, as a consequence of a court judgment or allegation of patent Each contributor grants you a non-exclusive, worldwide, royalty-free
infringement or for any other reason (not limited to patent issues), patent license under the contributor's essential patent claims, to
conditions are imposed on you (whether by court order, agreement or make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot excuse you from the conditions of this License. If you cannot convey a
distribute so as to satisfy simultaneously your obligations under this covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you License and any other pertinent obligations, then as a consequence you may
may not distribute the Program at all. For example, if a patent not convey it at all. For example, if you agree to terms that obligate you
license would not permit royalty-free redistribution of the Program by to collect a royalty for further conveying from those to whom you convey
all those who receive copies directly or indirectly through you, then the Program, the only way you could satisfy both those terms and this
the only way you could satisfy both it and this License would be to License would be to refrain entirely from conveying the Program.
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under 13. Remote Network Interaction; Use with the GNU General Public License.
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any Notwithstanding any other provision of this License, if you modify the
patents or other property right claims or to contest validity of any Program, your modified version must prominently offer all users
such claims; this section has the sole purpose of protecting the interacting with it remotely through a computer network (if your version
integrity of the free software distribution system, which is supports such interaction) an opportunity to receive the Corresponding
implemented by public license practices. Many people have made Source of your version by providing access to the Corresponding Source
generous contributions to the wide range of software distributed from a network server at no charge, through some standard or customary
through that system in reliance on consistent application of that means of facilitating copying of software. This Corresponding Source
system; it is up to the author/donor to decide if he or she is willing shall include the Corresponding Source for any work covered by version 3
to distribute software through any other system and a licensee cannot of the GNU General Public License that is incorporated pursuant to the
impose that choice. following paragraph.
This section is intended to make thoroughly clear what is believed to Notwithstanding any other provision of this License, you have
be a consequence of the rest of this License. permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
8. If the distribution and/or use of the Program is restricted in 14. Revised Versions of this License.
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions The Free Software Foundation may publish revised and/or new versions of
of the General Public License from time to time. Such new versions will the GNU Affero General Public License from time to time. Such new versions
be similar in spirit to the present version, but may differ in detail to will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns. address new problems or concerns.
Each version is given a distinguishing version number. If the Program Each version is given a distinguishing version number. If the
specifies a version number of this License which applies to it and "any Program specifies that a certain numbered version of the GNU Affero General
later version", you have the option of following the terms and conditions Public License "or any later version" applies to it, you have the
either of that version or of any later version published by the Free option of following the terms and conditions either of that numbered
Software Foundation. If the Program does not specify a version number of version or of any later version published by the Free Software
this License, you may choose any version ever published by the Free Software Foundation. If the Program does not specify a version number of the
Foundation. GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free If the Program specifies that a proxy can decide which future
programs whose distribution conditions are different, write to the author versions of the GNU Affero General Public License can be used, that proxy's
to ask for permission. For software which is copyrighted by the Free public statement of acceptance of a version permanently authorizes you
Software Foundation, write to the Free Software Foundation; we sometimes to choose that version for the Program.
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 15. Disclaimer of Warranty.
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
POSSIBILITY OF SUCH DAMAGES.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS END OF TERMS AND CONDITIONS
@@ -287,53 +626,36 @@ free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found. the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.> <one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author> Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation; either version 2 of the License, or the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License along You should have received a copy of the GNU Affero General Public License
with this program; if not, write to the Free Software Foundation, Inc., along with this program. If not, see <https://www.gnu.org/licenses/>.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail. Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this If your software can interact with users remotely through a computer
when it starts in an interactive mode: network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
Gnomovision version 69, Copyright (C) year name of author You should also get your employer (if you work as a programmer) or school,
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. if any, to sign a "copyright disclaimer" for the program, if necessary.
This is free software, and you are welcome to redistribute it For more information on this, and how to apply and follow the GNU AGPL, see
under certain conditions; type `show c' for details. <https://www.gnu.org/licenses/>.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

View File

@@ -35,10 +35,32 @@ Put content inside `env-py3.8/var/incorporealcms-instance/pages/` and go.
Care is taken to not serve content above the `pages/` dir, even via symlink. 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 ## Author and Licensing
Written by and copyright Brian S. Stephan (bss@incorporeal.org). 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 This program is free software: you can redistribute it and/or modify
the GNU General Public License as published by the Free Software Foundation; either version it under the terms of the GNU Affero General Public License as published
2 of the License (included in this repository), or (at your option) any later version. 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

@@ -40,8 +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
from . import error_pages, pages from . import error_pages, pages, static
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

@@ -7,7 +7,7 @@ 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, send_from_directory 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
@@ -49,15 +49,25 @@ def display_page(path):
def handle_markdown_file_path(resolved_path): def handle_markdown_file_path(resolved_path):
"""Given a location on disk, attempt to open it and render the markdown within.""" """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)
@@ -67,6 +77,8 @@ def handle_markdown_file_path(resolved_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)
extra_footer = get_meta_str(md, 'footer') if md.Meta.get('footer') else None
template = get_meta_str(md, 'template') if md.Meta.get('template') else 'base.html' template = get_meta_str(md, 'template') if md.Meta.get('template') else 'base.html'
# check if this has a HTTP redirect # check if this has a HTTP redirect
@@ -77,7 +89,8 @@ def handle_markdown_file_path(resolved_path):
return render(template, title=page_title, description=get_meta_str(md, 'description'), 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, 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')) 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):
@@ -89,15 +102,16 @@ 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/')
verbatim_path = os.path.abspath(os.path.join(base_dir, path)) safe_path = safe_join(base_dir, 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)
# 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
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)
# see if we have a real file or if we should infer markdown rendering # see if we have a real file or if we should infer markdown rendering
if os.path.exists(resolved_path): if os.path.exists(resolved_path):
# if this is a file-like request but actually a directory, redirect the user # if this is a file-like request but actually a directory, redirect the user
@@ -119,7 +133,7 @@ def request_path_to_instance_resource_path(path):
return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'file' 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 # if we're here, this isn't direct file access, so try markdown inference
verbatim_path = os.path.abspath(os.path.join(base_dir, f'{path}.md')) verbatim_path = f'{safe_path}.md'
resolved_path = os.path.realpath(verbatim_path) resolved_path = os.path.realpath(verbatim_path)
# does the final file actually exist? # does the final file actually exist?

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

@@ -12,11 +12,11 @@ body {
} }
.site-wrap-normal-width { .site-wrap-normal-width {
max-width: 70pc; max-width: 65pc;
} }
.site-wrap-double-width { .site-wrap-double-width {
max-width: 140pc; max-width: 130pc;
} }
.site-wrap { .site-wrap {
@@ -26,66 +26,28 @@ body {
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 {
@@ -104,7 +66,11 @@ footer {
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 {
@@ -140,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;
@@ -156,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 {
@@ -197,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 {
@@ -221,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;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

View File

@@ -7,7 +7,7 @@
<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 {% block site_class %}class="site-wrap site-wrap-normal-width"{% endblock %}> <div {% block site_class %}class="site-wrap site-wrap-normal-width"{% endblock %}>
@@ -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.5 # 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.6.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.9.1
# via # via
# -r requirements/requirements-dev.in # -r requirements/requirements-dev.in
# dlint # dlint
@@ -51,104 +42,130 @@ flake8==3.9.1
# 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.7 gitdb==4.0.10
# via gitpython # via gitpython
gitpython==3.1.14 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.8.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.4 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
pep517==0.10.0 pep517==0.13.0
# via pip-tools # via build
pip-tools==6.1.0 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.7.0
# via flake8 # via flake8
pydocstyle==6.0.0 pydocstyle==6.1.1
# via flake8-docstrings # via flake8-docstrings
pyflakes==2.3.1 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.3 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==4.0.0 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 # pep517
# pytest # pytest
# tox # tox
tox-wheel==0.6.0 tox==3.28.0
# via -r requirements/requirements-dev.in
tox==3.23.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.3 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.4 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

@@ -7,7 +7,7 @@ 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): def test_direct_file_that_exists(client):
@@ -23,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):
@@ -39,7 +39,7 @@ 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): def test_oserror_is_500(client, app):
@@ -70,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
@@ -100,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
@@ -109,7 +109,7 @@ 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): def test_page_with_redirect_meta_url_redirects(client):
@@ -134,32 +134,32 @@ 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 == 'http://localhost/subdir/' assert response.location == '/subdir/'
def test_that_request_to_symlink_redirects_markdown(client): def test_that_request_to_symlink_redirects_markdown(client):
"""Test that a request to /foo redirects to /what-foo-points-at.""" """Test that a request to /foo redirects to /what-foo-points-at."""
response = client.get('/symlink-to-no-title') response = client.get('/symlink-to-no-title')
assert response.status_code == 301 assert response.status_code == 301
assert response.location == 'http://localhost/no-title' assert response.location == '/no-title'
def test_that_request_to_symlink_redirects_file(client): def test_that_request_to_symlink_redirects_file(client):
"""Test that a request to /foo.txt redirects to /what-foo-points-at.txt.""" """Test that a request to /foo.txt redirects to /what-foo-points-at.txt."""
response = client.get('/symlink-to-foo.txt') response = client.get('/symlink-to-foo.txt')
assert response.status_code == 301 assert response.status_code == 301
assert response.location == 'http://localhost/foo.txt' assert response.location == '/foo.txt'
def test_that_request_to_symlink_redirects_directory(client): def test_that_request_to_symlink_redirects_directory(client):
"""Test that a request to /foo/ redirects to /what-foo-points-at/.""" """Test that a request to /foo/ redirects to /what-foo-points-at/."""
response = client.get('/symlink-to-subdir/') response = client.get('/symlink-to-subdir/')
assert response.status_code == 301 assert response.status_code == 301
assert response.location == 'http://localhost/subdir' assert response.location == '/subdir'
# sadly, this location also redirects # sadly, this location also redirects
response = client.get('/subdir') response = client.get('/subdir')
assert response.status_code == 301 assert response.status_code == 301
assert response.location == 'http://localhost/subdir/' assert response.location == '/subdir/'
# but we do get there # but we do get there
response = client.get('/subdir/') response = client.get('/subdir/')
assert response.status_code == 200 assert response.status_code == 200
@@ -169,7 +169,7 @@ def test_that_request_to_symlink_redirects_subdirectory(client):
"""Test that a request to /foo/bar redirects to /what-foo-points-at/bar.""" """Test that a request to /foo/bar redirects to /what-foo-points-at/bar."""
response = client.get('/symlink-to-subdir/page-no-title') response = client.get('/symlink-to-subdir/page-no-title')
assert response.status_code == 301 assert response.status_code == 301
assert response.location == 'http://localhost/subdir/page-no-title' assert response.location == '/subdir/page-no-title'
response = client.get('/subdir/page-no-title') response = client.get('/subdir/page-no-title')
assert response.status_code == 200 assert response.status_code == 200
@@ -190,15 +190,15 @@ 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'
@@ -210,3 +210,31 @@ def test_pages_can_supply_alternate_templates(client):
response = client.get('/custom-template') 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-normal-width"' not in response.data
assert b'class="site-wrap site-wrap-double-width"' 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

@@ -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,6 @@
Title: Index
Footer: ooo <a href="a">a</a>
# test index
this is some test content

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,7 +34,7 @@ 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')
] ]
@@ -39,7 +44,7 @@ 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.""" """Test that breadcrumbs still generate even if a subdir doesn't have an index.md."""
with app.app_context(): with app.app_context():
assert generate_parent_navs('pages/no-index-dir/page.md') == [ assert generate_parent_navs('pages/no-index-dir/page.md') == [
('incorporeal.org', '/'), ('example.com', '/'),
('/no-index-dir/', '/no-index-dir/'), ('/no-index-dir/', '/no-index-dir/'),
('page', '/no-index-dir/page') ('page', '/no-index-dir/page')
] ]
@@ -49,22 +54,74 @@ 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):

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