Compare commits
108 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
9d87aab61b
|
|||
|
35ea94185b
|
|||
|
69feb0c29c
|
|||
|
788a9cbaba
|
|||
| be6d96273c | |||
| a700470067 | |||
| 8a62167cea | |||
| 4ea824e86f | |||
| 28dbfd45b5 | |||
| 1de69dfc70 | |||
| ccf8434f43 | |||
| 5aabb79199 | |||
| 509072ab78 | |||
| e61c55bed2 | |||
| 41a53a2a13 | |||
| da055acda6 | |||
| 1583e3be99 | |||
| 946a557177 | |||
| f0d4e7d3d9 | |||
| 954f7f4e80 | |||
| 27bb139a2b | |||
| c15862850f | |||
| afbfab338f | |||
| cac6b40af5 | |||
| 65bc028524 | |||
| e8377adcf5 | |||
| f4beb15a3b | |||
| da447d2873 | |||
| cde82ab918 | |||
| 1ac13f3b9c | |||
| 6705fa38eb | |||
| 30b79e9dc1 | |||
| 60715a3a5c | |||
| c90f0a3a42 | |||
| 71ead20f3f | |||
| be88c3c1bc | |||
| ced67bec8b | |||
| 757b067e16 | |||
| 06d948a709 | |||
| d89fd151ca | |||
| ce1ed60dd2 | |||
| f46bff6ec6 | |||
| 70a8d4f06a | |||
| 085571e58f | |||
| 0bfea79a8f | |||
| 39d78af524 | |||
| e570ee26b5 | |||
| 411ecebbc6 | |||
| c1801b0086 | |||
| f08c1117d8 | |||
| dd7687884a | |||
| 15c88d920b | |||
| 1cef3b8196 | |||
| faf4a7f166 | |||
| 4dcc1c91c2 | |||
| 1c40f45ffd | |||
| 6026c51490 | |||
| 2e0e87fe95 | |||
| b6aa125b8d | |||
| 15142054da | |||
| dc81ef35de | |||
| c292f33334 | |||
| 1c052b8409 | |||
| 7cf8a427ce | |||
| e8a749d9ba | |||
| ae72fe87b5 | |||
| bb0e71e9e4 | |||
| 3bfdacdb6d | |||
| e6d2015de5 | |||
| 56eb767e33 | |||
| 07031fe667 | |||
| 48c6e8495a | |||
| 4f45943775 | |||
| b26ea6a661 | |||
| 1878d5951b | |||
| 829165ad8c | |||
| 7d982b96c9 | |||
| 5e41cde52e | |||
| ad33cf2e83 | |||
| 87ad48d8d2 | |||
| 8a6f4d6b45 | |||
| c25fefa9e3 | |||
| b0795999fe | |||
| aaced9d0e1 | |||
| 4042932240 | |||
| 49ab2befb6 | |||
| fbf6a81e0b | |||
| dabf9f7544 | |||
| dcf173ab61 | |||
| d2c1c2e3ce | |||
| 3fcf916317 | |||
| 67e1890629 | |||
| e1cb541ea5 | |||
| 93e9c8dc24 | |||
| 7cf11986c5 | |||
| 5ca483a904 | |||
| fe7d61e1f7 | |||
| 1398cfe3db | |||
| f63de031f6 | |||
| 46bce5a0a5 | |||
| 0af0f4e8aa | |||
| 08896a18c1 | |||
| ea7c9a1e07 | |||
| 63da59efd5 | |||
| c7d4a1c930 | |||
| 421d0e6f8e | |||
| 5c1fc93ff9 | |||
| 7b5f7ff00b |
47
CONTRIBUTING.md
Normal file
47
CONTRIBUTING.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# How to Contribute
|
||||||
|
|
||||||
|
incorporeal-cms is a personal project seeking to implement a simpler, cleaner form of what would
|
||||||
|
commonly be called a "CMS". I appreciate any help in making incorporeal-cms better.
|
||||||
|
|
||||||
|
## Opening Issues
|
||||||
|
|
||||||
|
Issues should be posted to my Gitea instance at
|
||||||
|
<https://git.incorporeal.org/bss/incorporeal-cms/issues>. I'm not too picky about format, but I
|
||||||
|
recommend starting the title with "Improvement:" or "Bug:" so I can do a high level of
|
||||||
|
prioritization.
|
||||||
|
|
||||||
|
## Providing Code
|
||||||
|
|
||||||
|
Some guidelines:
|
||||||
|
|
||||||
|
* Code:
|
||||||
|
* Keep in mind that I strive for simplicity in the software. It serves files and renders
|
||||||
|
Markdown, that's pretty much it. Features around that function are good; otherwise, I need
|
||||||
|
convincing.
|
||||||
|
* Follow the style precedent set in the code. Do **not** use Black, or otherwise reformat existing
|
||||||
|
code. I like it the way it is and don't need a militant tool making bad decisions about what is
|
||||||
|
readable.
|
||||||
|
* `tox` should run cleanly, of course.
|
||||||
|
* Almost any change should include unit tests, and also functional tests if they provide a feature
|
||||||
|
to the CMS functionality. For defects, include unit tests that fail on the unfixed codebase, so I
|
||||||
|
know exactly what's happening.
|
||||||
|
* Commits:
|
||||||
|
* Squash tiny commits if you'd like. I prefer commits that make one atomic conceptual change
|
||||||
|
that doesn't affect the rest of the code, assembling multiple of those commits into larger
|
||||||
|
changes.
|
||||||
|
* Follow something like [Chris Beams'](https://chris.beams.io/posts/git-commit/) post on
|
||||||
|
formatting a good commit message.
|
||||||
|
|
||||||
|
### Contributing
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Accepted changes remain the copyright of the original author, but please include appropriate contact
|
||||||
|
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.
|
||||||
917
LICENSE
917
LICENSE
@@ -1,626 +1,339 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 2, June 1991
|
||||||
|
|
||||||
Version 3, 29 June 2007
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||||
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
Copyright © 2007 Free Software Foundation, Inc. <http s ://fsf.org/>
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
Everyone is permitted to copy and distribute verbatim copies of this license
|
|
||||||
document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for software and
|
The licenses for most software are designed to take away your
|
||||||
other kinds of works.
|
freedom to share and change it. By contrast, the GNU General Public
|
||||||
|
License is intended to guarantee your freedom to share and change free
|
||||||
The licenses for most software and other practical works are designed to take
|
software--to make sure the software is free for all its users. This
|
||||||
away your freedom to share and change the works. By contrast, the GNU General
|
General Public License applies to most of the Free Software
|
||||||
Public License is intended to guarantee your freedom to share and change all
|
Foundation's software and to any other program whose authors commit to
|
||||||
versions of a program--to make sure it remains free software for all its users.
|
using it. (Some other Free Software Foundation software is covered by
|
||||||
We, the Free Software Foundation, use the GNU General Public License for most
|
the GNU Lesser General Public License instead.) You can apply it to
|
||||||
of our software; it applies also to any other work released this way by its
|
your programs, too.
|
||||||
authors. You can apply it to your programs, too.
|
|
||||||
|
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
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
General Public Licenses are designed to make sure that you have the freedom
|
have the freedom to distribute copies of free software (and charge for
|
||||||
to distribute copies of free software (and charge for them if you wish), that
|
this service if you wish), that you receive source code or can get it
|
||||||
you receive source code or can get it if you want it, that you can change
|
if you want it, that you can change the software or use pieces of it
|
||||||
the software or use pieces of it in new free programs, and that you know you
|
in new free programs; and that you know you can do these things.
|
||||||
can do these things.
|
|
||||||
|
To protect your rights, we need to make restrictions that forbid
|
||||||
To protect your rights, we need to prevent others from denying you these rights
|
anyone to deny you these rights or to ask you to surrender the rights.
|
||||||
or asking you to surrender the rights. Therefore, you have certain responsibilities
|
These restrictions translate to certain responsibilities for you if you
|
||||||
if you distribute copies of the software, or if you modify it: responsibilities
|
distribute copies of the software, or if you modify it.
|
||||||
to respect the freedom of others.
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
For example, if you distribute copies of such a program, whether gratis or
|
gratis or for a fee, you must give the recipients all the rights that
|
||||||
for a fee, you must pass on to the recipients the same freedoms that you received.
|
you have. You must make sure that they, too, receive or can get the
|
||||||
You must make sure that they, too, receive or can get the source code. And
|
source code. And you must show them these terms so they know their
|
||||||
you must show them these terms so they know their rights.
|
rights.
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert
|
We protect your rights with two steps: (1) copyright the software, and
|
||||||
copyright on the software, and (2) offer you this License giving you legal
|
(2) offer you this license which gives you legal permission to copy,
|
||||||
permission to copy, distribute and/or modify it.
|
distribute and/or modify the software.
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains that
|
Also, for each author's protection and ours, we want to make certain
|
||||||
there is no warranty for this free software. For both users' and authors'
|
that everyone understands that there is no warranty for this free
|
||||||
sake, the GPL requires that modified versions be marked as changed, so that
|
software. If the software is modified by someone else and passed on, we
|
||||||
their problems will not be attributed erroneously to authors of previous versions.
|
want its recipients to know that what they have is not the original, so
|
||||||
|
that any problems introduced by others will not reflect on the original
|
||||||
Some devices are designed to deny users access to install or run modified
|
authors' reputations.
|
||||||
versions of the software inside them, although the manufacturer can do so.
|
|
||||||
This is fundamentally incompatible with the aim of protecting users' freedom
|
Finally, any free program is threatened constantly by software
|
||||||
to change the software. The systematic pattern of such abuse occurs in the
|
patents. We wish to avoid the danger that redistributors of a free
|
||||||
area of products for individuals to use, which is precisely where it is most
|
program will individually obtain patent licenses, in effect making the
|
||||||
unacceptable. Therefore, we have designed this version of the GPL to prohibit
|
program proprietary. To prevent this, we have made it clear that any
|
||||||
the practice for those products. If such problems arise substantially in other
|
patent must be licensed for everyone's free use or not licensed at all.
|
||||||
domains, we stand ready to extend this provision to those domains in future
|
|
||||||
versions of the GPL, as needed to protect the freedom of users.
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
Finally, every program is threatened constantly by software patents. States
|
|
||||||
should not allow patents to restrict development and use of software on general-purpose
|
GNU GENERAL PUBLIC LICENSE
|
||||||
computers, but in those that do, we wish to avoid the special danger that
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||||
patents applied to a free program could make it effectively proprietary. To
|
|
||||||
prevent this, the GPL assures that patents cannot be used to render the program
|
0. This License applies to any program or other work which contains
|
||||||
non-free.
|
a notice placed by the copyright holder saying it may be distributed
|
||||||
|
under the terms of this General Public License. The "Program", below,
|
||||||
The precise terms and conditions for copying, distribution and modification
|
refers to any such program or work, and a "work based on the Program"
|
||||||
follow.
|
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,
|
||||||
TERMS AND CONDITIONS
|
either verbatim or with modifications and/or translated into another
|
||||||
|
language. (Hereinafter, translation is included without limitation in
|
||||||
0. Definitions.
|
the term "modification".) Each licensee is addressed as "you".
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
Activities other than copying, distribution and modification are not
|
||||||
|
covered by this License; they are outside its scope. The act of
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of works,
|
running the Program is not restricted, and the output from the Program
|
||||||
such as semiconductor masks.
|
is covered only if its contents constitute a work based on the
|
||||||
|
Program (independent of having been made by running the Program).
|
||||||
"The Program" refers to any copyrightable work licensed under this License.
|
Whether that is true depends on what the Program does.
|
||||||
Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals
|
|
||||||
or organizations.
|
1. You may copy and distribute verbatim copies of the Program's
|
||||||
|
source code as you receive it, in any medium, provided that you
|
||||||
To "modify" a work means to copy from or adapt all or part of the work in
|
conspicuously and appropriately publish on each copy an appropriate
|
||||||
a fashion requiring copyright permission, other than the making of an exact
|
copyright notice and disclaimer of warranty; keep intact all the
|
||||||
copy. The resulting work is called a "modified version" of the earlier work
|
notices that refer to this License and to the absence of any warranty;
|
||||||
or a work "based on" the earlier work.
|
and give any other recipients of the Program a copy of this License
|
||||||
|
along with the Program.
|
||||||
A "covered work" means either the unmodified Program or a work based on the
|
|
||||||
Program.
|
You may charge a fee for the physical act of transferring a copy, and
|
||||||
|
you may at your option offer warranty protection in exchange for a fee.
|
||||||
To "propagate" a work means to do anything with it that, without permission,
|
|
||||||
would make you directly or secondarily liable for infringement under applicable
|
2. You may modify your copy or copies of the Program or any portion
|
||||||
copyright law, except executing it on a computer or modifying a private copy.
|
of it, thus forming a work based on the Program, and copy and
|
||||||
Propagation includes copying, distribution (with or without modification),
|
distribute such modifications or work under the terms of Section 1
|
||||||
making available to the public, and in some countries other activities as
|
above, provided that you also meet all of these conditions:
|
||||||
well.
|
|
||||||
|
a) You must cause the modified files to carry prominent notices
|
||||||
To "convey" a work means any kind of propagation that enables other parties
|
stating that you changed the files and the date of any change.
|
||||||
to make or receive copies. Mere interaction with a user through a computer
|
|
||||||
network, with no transfer of a copy, is not conveying.
|
b) You must cause any work that you distribute or publish, that in
|
||||||
|
whole or in part contains or is derived from the Program or any
|
||||||
An interactive user interface displays "Appropriate Legal Notices" to the
|
part thereof, to be licensed as a whole at no charge to all third
|
||||||
extent that it includes a convenient and prominently visible feature that
|
parties under the terms of this License.
|
||||||
(1) displays an appropriate copyright notice, and (2) tells the user that
|
|
||||||
there is no warranty for the work (except to the extent that warranties are
|
c) If the modified program normally reads commands interactively
|
||||||
provided), that licensees may convey the work under this License, and how
|
when run, you must cause it, when started running for such
|
||||||
to view a copy of this License. If the interface presents a list of user commands
|
interactive use in the most ordinary way, to print or display an
|
||||||
or options, such as a menu, a prominent item in the list meets this criterion.
|
announcement including an appropriate copyright notice and a
|
||||||
|
notice that there is no warranty (or else, saying that you provide
|
||||||
1. Source Code.
|
a warranty) and that users may redistribute the program under
|
||||||
|
these conditions, and telling the user how to view a copy of this
|
||||||
The "source code" for a work means the preferred form of the work for making
|
License. (Exception: if the Program itself is interactive but
|
||||||
modifications to it. "Object code" means any non-source form of a work.
|
does not normally print such an announcement, your work based on
|
||||||
|
the Program is not required to print an announcement.)
|
||||||
A "Standard Interface" means an interface that either is an official standard
|
|
||||||
defined by a recognized standards body, or, in the case of interfaces specified
|
These requirements apply to the modified work as a whole. If
|
||||||
for a particular programming language, one that is widely used among developers
|
identifiable sections of that work are not derived from the Program,
|
||||||
working in that language.
|
and can be reasonably considered independent and separate works in
|
||||||
|
themselves, then this License, and its terms, do not apply to those
|
||||||
The "System Libraries" of an executable work include anything, other than
|
sections when you distribute them as separate works. But when you
|
||||||
the work as a whole, that (a) is included in the normal form of packaging
|
distribute the same sections as part of a whole which is a work based
|
||||||
a Major Component, but which is not part of that Major Component, and (b)
|
on the Program, the distribution of the whole must be on the terms of
|
||||||
serves only to enable use of the work with that Major Component, or to implement
|
this License, whose permissions for other licensees extend to the
|
||||||
a Standard Interface for which an implementation is available to the public
|
entire whole, and thus to each and every part regardless of who wrote it.
|
||||||
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
|
Thus, it is not the intent of this section to claim rights or contest
|
||||||
(if any) on which the executable work runs, or a compiler used to produce
|
your rights to work written entirely by you; rather, the intent is to
|
||||||
the work, or an object code interpreter used to run it.
|
exercise the right to control the distribution of derivative or
|
||||||
|
collective works based on the Program.
|
||||||
The "Corresponding Source" for a work in object code form means all the source
|
|
||||||
code needed to generate, install, and (for an executable work) run the object
|
In addition, mere aggregation of another work not based on the Program
|
||||||
code and to modify the work, including scripts to control those activities.
|
with the Program (or with a work based on the Program) on a volume of
|
||||||
However, it does not include the work's System Libraries, or general-purpose
|
a storage or distribution medium does not bring the other work under
|
||||||
tools or generally available free programs which are used unmodified in performing
|
the scope of this License.
|
||||||
those activities but which are not part of the work. For example, Corresponding
|
|
||||||
Source includes interface definition files associated with source files for
|
3. You may copy and distribute the Program (or a work based on it,
|
||||||
the work, and the source code for shared libraries and dynamically linked
|
under Section 2) in object code or executable form under the terms of
|
||||||
subprograms that the work is specifically designed to require, such as by
|
Sections 1 and 2 above provided that you also do one of the following:
|
||||||
intimate data communication or control flow between those subprograms and
|
|
||||||
other parts of the work.
|
a) Accompany it with the complete corresponding machine-readable
|
||||||
|
source code, which must be distributed under the terms of Sections
|
||||||
The Corresponding Source need not include anything that users can regenerate
|
1 and 2 above on a medium customarily used for software interchange; or,
|
||||||
automatically from other parts of the Corresponding Source.
|
|
||||||
|
b) Accompany it with a written offer, valid for at least three
|
||||||
The Corresponding Source for a work in source code form is that same work.
|
years, to give any third party, for a charge no more than your
|
||||||
|
cost of physically performing source distribution, a complete
|
||||||
2. Basic Permissions.
|
machine-readable copy of the corresponding source code, to be
|
||||||
|
distributed under the terms of Sections 1 and 2 above on a medium
|
||||||
All rights granted under this License are granted for the term of copyright
|
customarily used for software interchange; or,
|
||||||
on the Program, and are irrevocable provided the stated conditions are met.
|
|
||||||
This License explicitly affirms your unlimited permission to run the unmodified
|
c) Accompany it with the information you received as to the offer
|
||||||
Program. The output from running a covered work is covered by this License
|
to distribute corresponding source code. (This alternative is
|
||||||
only if the output, given its content, constitutes a covered work. This License
|
allowed only for noncommercial distribution and only if you
|
||||||
acknowledges your rights of fair use or other equivalent, as provided by copyright
|
received the program in object code or executable form with such
|
||||||
law.
|
an offer, in accord with Subsection b above.)
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not convey, without
|
The source code for a work means the preferred form of the work for
|
||||||
conditions so long as your license otherwise remains in force. You may convey
|
making modifications to it. For an executable work, complete source
|
||||||
covered works to others for the sole purpose of having them make modifications
|
code means all the source code for all modules it contains, plus any
|
||||||
exclusively for you, or provide you with facilities for running those works,
|
associated interface definition files, plus the scripts used to
|
||||||
provided that you comply with the terms of this License in conveying all material
|
control compilation and installation of the executable. However, as a
|
||||||
for which you do not control copyright. Those thus making or running the covered
|
special exception, the source code distributed need not include
|
||||||
works for you must do so exclusively on your behalf, under your direction
|
anything that is normally distributed (in either source or binary
|
||||||
and control, on terms that prohibit them from making any copies of your copyrighted
|
form) with the major components (compiler, kernel, and so on) of the
|
||||||
material outside their relationship with you.
|
operating system on which the executable runs, unless that component
|
||||||
|
itself accompanies the executable.
|
||||||
Conveying under any other circumstances is permitted solely under the conditions
|
|
||||||
stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
If distribution of executable or object code is made by offering
|
||||||
|
access to copy from a designated place, then offering equivalent
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
access to copy the source code from the same place counts as
|
||||||
|
distribution of the source code, even though third parties are not
|
||||||
No covered work shall be deemed part of an effective technological measure
|
compelled to copy the source along with the object code.
|
||||||
under any applicable law fulfilling obligations under article 11 of the WIPO
|
|
||||||
copyright treaty adopted on 20 December 1996, or similar laws prohibiting
|
4. You may not copy, modify, sublicense, or distribute the Program
|
||||||
or restricting circumvention of such measures.
|
except as expressly provided under this License. Any attempt
|
||||||
|
otherwise to copy, modify, sublicense or distribute the Program is
|
||||||
When you convey a covered work, you waive any legal power to forbid circumvention
|
void, and will automatically terminate your rights under this License.
|
||||||
of technological measures to the extent such circumvention is effected by
|
However, parties who have received copies, or rights, from you under
|
||||||
exercising rights under this License with respect to the covered work, and
|
this License will not have their licenses terminated so long as such
|
||||||
you disclaim any intention to limit operation or modification of the work
|
parties remain in full compliance.
|
||||||
as a means of enforcing, against the work's users, your or third parties'
|
|
||||||
legal rights to forbid circumvention of technological measures.
|
5. You are not required to accept this License, since you have not
|
||||||
|
signed it. However, nothing else grants you permission to modify or
|
||||||
4. Conveying Verbatim Copies.
|
distribute the Program or its derivative works. These actions are
|
||||||
|
prohibited by law if you do not accept this License. Therefore, by
|
||||||
You may convey verbatim copies of the Program's source code as you receive
|
modifying or distributing the Program (or any work based on the
|
||||||
it, in any medium, provided that you conspicuously and appropriately publish
|
Program), you indicate your acceptance of this License to do so, and
|
||||||
on each copy an appropriate copyright notice; keep intact all notices stating
|
all its terms and conditions for copying, distributing or modifying
|
||||||
that this License and any non-permissive terms added in accord with section
|
the Program or works based on it.
|
||||||
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.
|
6. Each time you redistribute the Program (or any work based on the
|
||||||
|
Program), the recipient automatically receives a license from the
|
||||||
You may charge any price or no price for each copy that you convey, and you
|
original licensor to copy, distribute or modify the Program subject to
|
||||||
may offer support or warranty protection for a fee.
|
these terms and conditions. You may not impose any further
|
||||||
|
restrictions on the recipients' exercise of the rights granted herein.
|
||||||
5. Conveying Modified Source Versions.
|
You are not responsible for enforcing compliance by third parties to
|
||||||
|
this License.
|
||||||
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
|
7. If, as a consequence of a court judgment or allegation of patent
|
||||||
4, provided that you also meet all of these conditions:
|
infringement or for any other reason (not limited to patent issues),
|
||||||
|
conditions are imposed on you (whether by court order, agreement or
|
||||||
a) The work must carry prominent notices stating that you modified it, and
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
giving a relevant date.
|
excuse you from the conditions of this License. If you cannot
|
||||||
|
distribute so as to satisfy simultaneously your obligations under this
|
||||||
b) The work must carry prominent notices stating that it is released under
|
License and any other pertinent obligations, then as a consequence you
|
||||||
this License and any conditions added under section 7. This requirement modifies
|
may not distribute the Program at all. For example, if a patent
|
||||||
the requirement in section 4 to "keep intact all notices".
|
license would not permit royalty-free redistribution of the Program by
|
||||||
|
all those who receive copies directly or indirectly through you, then
|
||||||
c) You must license the entire work, as a whole, under this License to anyone
|
the only way you could satisfy both it and this License would be to
|
||||||
who comes into possession of a copy. This License will therefore apply, along
|
refrain entirely from distribution of the Program.
|
||||||
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
|
If any portion of this section is held invalid or unenforceable under
|
||||||
no permission to license the work in any other way, but it does not invalidate
|
any particular circumstance, the balance of the section is intended to
|
||||||
such permission if you have separately received it.
|
apply and the section as a whole is intended to apply in other
|
||||||
|
circumstances.
|
||||||
d) If the work has interactive user interfaces, each must display Appropriate
|
|
||||||
Legal Notices; however, if the Program has interactive interfaces that do
|
It is not the purpose of this section to induce you to infringe any
|
||||||
not display Appropriate Legal Notices, your work need not make them do so.
|
patents or other property right claims or to contest validity of any
|
||||||
|
such claims; this section has the sole purpose of protecting the
|
||||||
A compilation of a covered work with other separate and independent works,
|
integrity of the free software distribution system, which is
|
||||||
which are not by their nature extensions of the covered work, and which are
|
implemented by public license practices. Many people have made
|
||||||
not combined with it such as to form a larger program, in or on a volume of
|
generous contributions to the wide range of software distributed
|
||||||
a storage or distribution medium, is called an "aggregate" if the compilation
|
through that system in reliance on consistent application of that
|
||||||
and its resulting copyright are not used to limit the access or legal rights
|
system; it is up to the author/donor to decide if he or she is willing
|
||||||
of the compilation's users beyond what the individual works permit. Inclusion
|
to distribute software through any other system and a licensee cannot
|
||||||
of a covered work in an aggregate does not cause this License to apply to
|
impose that choice.
|
||||||
the other parts of the aggregate.
|
|
||||||
|
This section is intended to make thoroughly clear what is believed to
|
||||||
6. Conveying Non-Source Forms.
|
be a consequence of the rest of this License.
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms of sections
|
8. If the distribution and/or use of the Program is restricted in
|
||||||
4 and 5, provided that you also convey the machine-readable Corresponding
|
certain countries either by patents or by copyrighted interfaces, the
|
||||||
Source under the terms of this License, in one of these ways:
|
original copyright holder who places the Program under this License
|
||||||
|
may add an explicit geographical distribution limitation excluding
|
||||||
a) Convey the object code in, or embodied in, a physical product (including
|
those countries, so that distribution is permitted only in or among
|
||||||
a physical distribution medium), accompanied by the Corresponding Source fixed
|
countries not thus excluded. In such case, this License incorporates
|
||||||
on a durable physical medium customarily used for software interchange.
|
the limitation as if written in the body of this License.
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product (including
|
9. The Free Software Foundation may publish revised and/or new versions
|
||||||
a physical distribution medium), accompanied by a written offer, valid for
|
of the General Public License from time to time. Such new versions will
|
||||||
at least three years and valid for as long as you offer spare parts or customer
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
support for that product model, to give anyone who possesses the object code
|
address new problems or concerns.
|
||||||
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
|
Each version is given a distinguishing version number. If the Program
|
||||||
used for software interchange, for a price no more than your reasonable cost
|
specifies a version number of this License which applies to it and "any
|
||||||
of physically performing this conveying of source, or (2) access to copy the
|
later version", you have the option of following the terms and conditions
|
||||||
Corresponding Source from a network server at no charge.
|
either of that version or of any later version published by the Free
|
||||||
|
Software Foundation. If the Program does not specify a version number of
|
||||||
c) Convey individual copies of the object code with a copy of the written
|
this License, you may choose any version ever published by the Free Software
|
||||||
offer to provide the Corresponding Source. This alternative is allowed only
|
Foundation.
|
||||||
occasionally and noncommercially, and only if you received the object code
|
|
||||||
with such an offer, in accord with subsection 6b.
|
10. If you wish to incorporate parts of the Program into other free
|
||||||
|
programs whose distribution conditions are different, write to the author
|
||||||
d) Convey the object code by offering access from a designated place (gratis
|
to ask for permission. For software which is copyrighted by the Free
|
||||||
or for a charge), and offer equivalent access to the Corresponding Source
|
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||||
in the same way through the same place at no further charge. You need not
|
make exceptions for this. Our decision will be guided by the two goals
|
||||||
require recipients to copy the Corresponding Source along with the object
|
of preserving the free status of all derivatives of our free software and
|
||||||
code. If the place to copy the object code is a network server, the Corresponding
|
of promoting the sharing and reuse of software generally.
|
||||||
Source may be on a different server (operated by you or a third party) that
|
|
||||||
supports equivalent copying facilities, provided you maintain clear directions
|
NO WARRANTY
|
||||||
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
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||||
that it is available for as long as needed to satisfy these requirements.
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||||
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||||
e) Convey the object code using peer-to-peer transmission, provided you inform
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||||
other peers where the object code and Corresponding Source of the work are
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
being offered to the general public at no charge under subsection 6d.
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||||
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||||
A separable portion of the object code, whose source code is excluded from
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||||
the Corresponding Source as a System Library, need not be included in conveying
|
REPAIR OR CORRECTION.
|
||||||
the object code work.
|
|
||||||
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
A "User Product" is either (1) a "consumer product", which means any tangible
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||||
personal property which is normally used for personal, family, or household
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
purposes, or (2) anything designed or sold for incorporation into a dwelling.
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||||
In determining whether a product is a consumer product, doubtful cases shall
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||||
be resolved in favor of coverage. For a particular product received by a particular
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||||
user, "normally used" refers to a typical or common use of that class of product,
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||||
regardless of the status of the particular user or of the way in which the
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||||
particular user actually uses, or expects or is expected to use, the product.
|
POSSIBILITY OF SUCH DAMAGES.
|
||||||
A product is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent the
|
END OF TERMS AND CONDITIONS
|
||||||
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.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent
|
|
||||||
license under the contributor's essential patent claims, to 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 excuse you from
|
|
||||||
the conditions of this License. If you cannot convey a covered work so as
|
|
||||||
to satisfy simultaneously your obligations under this License and any other
|
|
||||||
pertinent obligations, then as a consequence you may not convey it at all.
|
|
||||||
For example, if you agree to terms that obligate you to collect a royalty
|
|
||||||
for further conveying from those to whom you convey the Program, the only
|
|
||||||
way you could satisfy both those terms and this License would be to refrain
|
|
||||||
entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have permission to
|
|
||||||
link or combine any covered work with a work licensed under version 3 of the
|
|
||||||
GNU Affero 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 special requirements of the GNU Affero
|
|
||||||
General Public License, section 13, concerning interaction through a network
|
|
||||||
will apply to the combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of the
|
|
||||||
GNU General Public License from time to time. Such new versions will be similar
|
|
||||||
in spirit to the present version, but may differ in detail to address new
|
|
||||||
problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program specifies
|
|
||||||
that a certain numbered version of the GNU General Public License "or any
|
|
||||||
later version" applies to it, you have the option of following the terms and
|
|
||||||
conditions either of that numbered version or of any later version published
|
|
||||||
by the Free Software Foundation. If the Program does not specify a version
|
|
||||||
number of the GNU General Public License, you may choose any version ever
|
|
||||||
published by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future versions of
|
|
||||||
the GNU General Public License can be used, that proxy's public statement
|
|
||||||
of acceptance of a version permanently authorizes you to choose that version
|
|
||||||
for the Program.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO 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.
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest possible
|
If you develop a new program, and you want it to be of the greatest
|
||||||
use to the public, the best way to achieve this is to make it free software
|
possible use to the public, the best way to achieve this is to make it
|
||||||
which everyone can redistribute and change under these terms.
|
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 attach
|
To do so, attach the following notices to the program. It is safest
|
||||||
them to the start of each source file to most effectively state the exclusion
|
to attach them to the start of each source file to most effectively
|
||||||
of warranty; and each file should have at least the "copyright" line and a
|
convey the exclusion of warranty; and each file should have at least
|
||||||
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 it under
|
This program is free software; you can redistribute it and/or modify
|
||||||
the terms of the GNU General Public License as published by the Free Software
|
it under the terms of the GNU General Public License as published by
|
||||||
Foundation, either version 3 of the License, or (at your option) any later
|
the Free Software Foundation; either version 2 of the License, or
|
||||||
version.
|
(at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful, but WITHOUT
|
This program is distributed in the hope that it will be useful,
|
||||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along with
|
You should have received a copy of the GNU General Public License along
|
||||||
this program. If not, see <http s ://www.gnu.org/licenses/>.
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||||
|
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 does terminal interaction, make it output a short notice like
|
If the program is interactive, make it output a short notice like this
|
||||||
this when it starts in an interactive mode:
|
when it starts in an interactive mode:
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
Gnomovision version 69, Copyright (C) year name of author
|
||||||
|
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
This is free software, and you are welcome to redistribute it under certain
|
|
||||||
conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
parts of the General Public License. Of course, your program's commands might
|
parts of the General Public License. Of course, the commands you use may
|
||||||
be different; for a GUI interface, you would use an "about box".
|
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 school,
|
You should also get your employer (if you work as a programmer) or your
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary. For
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
more information on this, and how to apply and follow the GNU GPL, see <http
|
necessary. Here is a sample; alter the names:
|
||||||
s ://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||||
into proprietary programs. If your program is a subroutine library, you may
|
`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
|
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
|
library. If this is what you want to do, use the GNU Lesser General
|
||||||
License instead of this License. But first, please read <http s ://www.gnu.org/
|
Public License instead of this License.
|
||||||
licenses /why-not-lgpl.html>.
|
|
||||||
|
|||||||
56
README.md
56
README.md
@@ -1,3 +1,57 @@
|
|||||||
# incorporeal-cms
|
# incorporeal-cms
|
||||||
|
|
||||||
Software that makes incorporeal.org go.
|
Software that makes simple Markdown content go.
|
||||||
|
|
||||||
|
## Installation and Usage
|
||||||
|
|
||||||
|
I recommend getting a release from <https://git.incorporeal.org/bss/incorporeal-cms/releases> and
|
||||||
|
installing the Python package in a virtualenv. Something like the following should suffice:
|
||||||
|
|
||||||
|
```
|
||||||
|
% cd ~/site
|
||||||
|
% virtualenv --python=python3.8 env-py3.8
|
||||||
|
% source env-py3.8/bin/activate
|
||||||
|
% pip install -U pip
|
||||||
|
% pip install ~/incorporeal_cms-1.3.0-py3-none-any.whl
|
||||||
|
% pip install -U gunicorn
|
||||||
|
% gunicorn -w 5 -t 60 -b 127.0.0.1:10000 --reload 'incorporealcms:create_app()'
|
||||||
|
```
|
||||||
|
|
||||||
|
This will get the CMS up and running, and listening on the specified port. The application is
|
||||||
|
further configured within `env-py3.8/var/incorporealcms-instance/config.py`, and content is served
|
||||||
|
out of `env-py3.8/var/incorporealcms-instance/pages/`.
|
||||||
|
|
||||||
|
## Serving a Site
|
||||||
|
|
||||||
|
Put content inside `env-py3.8/var/incorporealcms-instance/pages/` and go.
|
||||||
|
|
||||||
|
* Markdown files (ending in `.md`) are rendered via Python-Markdown if they are accessed without the
|
||||||
|
suffix (i.e., `post.md` should be referred to as `/post` to get it to render as Markdown.
|
||||||
|
* Directory paths (e.g. `/dir/`) can be rendered with a `/dir/index.md` file.
|
||||||
|
* Symlinks to files are treated as redirects to the destination content.
|
||||||
|
* Request paths with file suffixes are not rendered and served directly, so images, etc., can be
|
||||||
|
referenced naturally, and even the unrendered Markdown can be served as a text file via e.g.
|
||||||
|
`/post.md`.
|
||||||
|
|
||||||
|
Care is taken to not serve content above the `pages/` dir, even via symlink.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
I've tried to keep the software agnostic to my personal domains, logos, etc. There are some settings
|
||||||
|
you are probably interested in tweaking, by specifying new values in
|
||||||
|
`incorporealcms-instance/config.py`:
|
||||||
|
|
||||||
|
* `TITLE_SUFFIX` is appended to the title of every page, separated from other title content by a
|
||||||
|
dash.
|
||||||
|
* `CONTACT_EMAIL` is referred to in error templates.
|
||||||
|
* `FAVICON` supplies the image used in browser tabs and that kind of thing.
|
||||||
|
|
||||||
|
If I missed anything, please let me know.
|
||||||
|
|
||||||
|
## Author and Licensing
|
||||||
|
|
||||||
|
Written by and copyright Brian S. Stephan (bss@incorporeal.org).
|
||||||
|
|
||||||
|
This program is free software; you can redistribute it and/or modify it under the terms of
|
||||||
|
the GNU General Public License as published by the Free Software Foundation; either version
|
||||||
|
2 of the License (included in this repository), or (at your option) any later version.
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import logging
|
|||||||
import os
|
import os
|
||||||
from logging.config import dictConfig
|
from logging.config import dictConfig
|
||||||
|
|
||||||
from flask import Flask, request, send_from_directory
|
from flask import Flask, request
|
||||||
|
|
||||||
from ._version import get_versions
|
from ._version import get_versions
|
||||||
|
|
||||||
@@ -40,12 +40,10 @@ def create_app(instance_path=None, test_config=None):
|
|||||||
logger.info("RESPONSE: %s %s: %s", request.method, request.path, response.status)
|
logger.info("RESPONSE: %s %s: %s", request.method, request.path, response.status)
|
||||||
return response
|
return response
|
||||||
|
|
||||||
@app.route(f'/{app.config["MEDIA_DIR"]}/<path:filename>')
|
from . import error_pages, pages
|
||||||
def media_files(filename):
|
|
||||||
return send_from_directory(os.path.join(app.instance_path, app.config['MEDIA_DIR']),
|
|
||||||
filename)
|
|
||||||
|
|
||||||
from . import pages
|
|
||||||
app.register_blueprint(pages.bp)
|
app.register_blueprint(pages.bp)
|
||||||
|
app.register_error_handler(400, error_pages.bad_request)
|
||||||
|
app.register_error_handler(404, error_pages.page_not_found)
|
||||||
|
app.register_error_handler(500, error_pages.internal_server_error)
|
||||||
|
|
||||||
return app
|
return app
|
||||||
|
|||||||
@@ -32,5 +32,27 @@ class Config(object):
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
TITLE_SUFFIX = 'incorporeal.org'
|
MARKDOWN_EXTENSIONS = ['extra', 'mdx_linkify', 'sane_lists', 'smarty', 'tables']
|
||||||
|
MARKDOWN_EXTENSION_CONFIGS = {
|
||||||
|
'extra': {
|
||||||
|
'attr_list': {},
|
||||||
|
'footnotes': {
|
||||||
|
'UNIQUE_IDS': True,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'smarty': {
|
||||||
|
'smart_dashes': True,
|
||||||
|
'smart_quotes': False,
|
||||||
|
'smart_angled_quotes': False,
|
||||||
|
'smart_ellipses': True,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
MEDIA_DIR = 'media'
|
MEDIA_DIR = 'media'
|
||||||
|
|
||||||
|
# customizations
|
||||||
|
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
|
||||||
|
|||||||
17
incorporealcms/error_pages.py
Normal file
17
incorporealcms/error_pages.py
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
"""Error page views for 400, 404, etc."""
|
||||||
|
from incorporealcms.lib import render
|
||||||
|
|
||||||
|
|
||||||
|
def bad_request(error):
|
||||||
|
"""Display 400 error messaging."""
|
||||||
|
return render('400.html'), 400
|
||||||
|
|
||||||
|
|
||||||
|
def internal_server_error(error):
|
||||||
|
"""Display 500 error messaging."""
|
||||||
|
return render('500.html'), 500
|
||||||
|
|
||||||
|
|
||||||
|
def page_not_found(error):
|
||||||
|
"""Display 404 error messaging."""
|
||||||
|
return render('404.html'), 404
|
||||||
51
incorporealcms/lib.py
Normal file
51
incorporealcms/lib.py
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
"""Miscellaneous helper functions and whatnot."""
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import markdown
|
||||||
|
from flask import current_app as app
|
||||||
|
from flask import make_response, render_template, request
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def get_meta_str(md, key):
|
||||||
|
"""Provide the page's (parsed in Markup obj md) metadata for the specified key, or '' if unset."""
|
||||||
|
return " ".join(md.Meta.get(key)) if md.Meta.get(key) else ""
|
||||||
|
|
||||||
|
|
||||||
|
def init_md():
|
||||||
|
"""Initialize the Markdown parser.
|
||||||
|
|
||||||
|
This used to done at the app level in __init__, but extensions like footnotes apparently
|
||||||
|
assume the parser to only live for the length of parsing one document, and create double
|
||||||
|
footnote ref links if the one parser sees the same document multiple times.
|
||||||
|
"""
|
||||||
|
# initialize markdown parser from config, but include
|
||||||
|
# extensions our app depends on, like the meta extension
|
||||||
|
return markdown.Markdown(extensions=app.config['MARKDOWN_EXTENSIONS'] + ['meta'],
|
||||||
|
extension_configs=app.config['MARKDOWN_EXTENSION_CONFIGS'])
|
||||||
|
|
||||||
|
|
||||||
|
def render(template_name_or_list, **context):
|
||||||
|
"""Wrap Flask's render_template.
|
||||||
|
|
||||||
|
* Determine the proper site theme to use in the template and provide it.
|
||||||
|
"""
|
||||||
|
PAGE_STYLES = {
|
||||||
|
'dark': 'css/dark.css',
|
||||||
|
'light': 'css/light.css',
|
||||||
|
'plain': 'css/plain.css',
|
||||||
|
}
|
||||||
|
|
||||||
|
selected_style = request.args.get('style', None)
|
||||||
|
if selected_style:
|
||||||
|
user_style = selected_style
|
||||||
|
else:
|
||||||
|
user_style = request.cookies.get('user-style')
|
||||||
|
logger.debug("user style cookie: %s", user_style)
|
||||||
|
context['user_style'] = PAGE_STYLES.get(user_style, PAGE_STYLES.get(app.config['DEFAULT_PAGE_STYLE']))
|
||||||
|
|
||||||
|
resp = make_response(render_template(template_name_or_list, **context))
|
||||||
|
if selected_style:
|
||||||
|
resp.set_cookie('user-style', selected_style)
|
||||||
|
return resp
|
||||||
1
incorporealcms/mdx/__init__.py
Normal file
1
incorporealcms/mdx/__init__.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
"""Markdown extensions."""
|
||||||
51
incorporealcms/mdx/pydot.py
Normal file
51
incorporealcms/mdx/pydot.py
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
"""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'~~~pydot:(?P<filename>[^\s]+)\n(?P<content>.*?)~~~', re.DOTALL)
|
||||||
|
|
||||||
|
def run(self, lines):
|
||||||
|
"""Match and generate diagrams from dot code blocks."""
|
||||||
|
text = '\n'.join(lines)
|
||||||
|
for match in self.BLOCK_RE.finditer(text):
|
||||||
|
filename = match.group(1)
|
||||||
|
dot_string = match.group(2)
|
||||||
|
|
||||||
|
# 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''
|
||||||
|
|
||||||
|
# replace the image in the output markdown
|
||||||
|
text = f'{text[:match.start()]}\n{inline_image}\n{text[match.end():]}'
|
||||||
|
|
||||||
|
return text.split('\n')
|
||||||
|
|
||||||
|
|
||||||
|
def makeExtension(*args, **kwargs):
|
||||||
|
"""Provide the extension to the markdown extension loader."""
|
||||||
|
return InlinePydot(*args, **kwargs)
|
||||||
@@ -2,90 +2,198 @@
|
|||||||
import datetime
|
import datetime
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
import markdown
|
|
||||||
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, render_template
|
from flask import redirect, request, send_from_directory
|
||||||
from tzlocal import get_localzone
|
from tzlocal import get_localzone
|
||||||
|
|
||||||
|
from incorporealcms.lib import get_meta_str, init_md, render
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
bp = Blueprint('pages', __name__, url_prefix='/')
|
bp = Blueprint('pages', __name__, url_prefix='/')
|
||||||
md = markdown.Markdown(extensions=['meta', 'tables'])
|
|
||||||
|
|
||||||
|
|
||||||
@bp.route('/', defaults={'path': 'index'})
|
@bp.route('/', defaults={'path': 'index'})
|
||||||
@bp.route('/<path:path>')
|
@bp.route('/<path:path>')
|
||||||
def display_page(path):
|
def display_page(path):
|
||||||
"""Get the file contents of the requested path and render the file."""
|
"""Get the file contents of the requested path and render the file."""
|
||||||
if is_file_path_actually_dir_path(path):
|
|
||||||
return redirect(f'{path}/', code=301)
|
|
||||||
|
|
||||||
resolved_path = resolve_page_file(path)
|
|
||||||
logger.debug("received request for path '%s', resolved to '%s'", path, resolved_path)
|
|
||||||
try:
|
try:
|
||||||
|
resolved_path, render_type = request_path_to_instance_resource_path(path)
|
||||||
|
logger.debug("received request for path '%s', resolved to '%s', type '%s'",
|
||||||
|
path, resolved_path, render_type)
|
||||||
|
except PermissionError:
|
||||||
|
abort(400)
|
||||||
|
except IsADirectoryError:
|
||||||
|
return redirect(f'/{path}/', code=301)
|
||||||
|
except FileNotFoundError:
|
||||||
|
abort(404)
|
||||||
|
|
||||||
|
if render_type == 'file':
|
||||||
|
return send_from_directory(app.instance_path, resolved_path)
|
||||||
|
elif render_type == 'symlink':
|
||||||
|
logger.debug("attempting to redirect path '%s' to reverse of resource '%s'", path, resolved_path)
|
||||||
|
redirect_path = f'/{instance_resource_path_to_request_path(resolved_path)}'
|
||||||
|
logger.debug("redirect path: '%s'", redirect_path)
|
||||||
|
return redirect(redirect_path, code=301)
|
||||||
|
elif render_type == 'markdown':
|
||||||
|
logger.debug("treating path '%s' as markdown '%s'", path, resolved_path)
|
||||||
|
return handle_markdown_file_path(resolved_path)
|
||||||
|
else:
|
||||||
|
logger.exception("unsupported render_type '%s'!?", render_type)
|
||||||
|
abort(500)
|
||||||
|
|
||||||
|
|
||||||
|
def handle_markdown_file_path(resolved_path):
|
||||||
|
"""Given a location on disk, attempt to open it and render the markdown within."""
|
||||||
|
try:
|
||||||
|
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:
|
||||||
logger.debug("file '%s' found", resolved_path)
|
|
||||||
parent_navs = generate_parent_navs(path)
|
|
||||||
mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), get_localzone())
|
mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), get_localzone())
|
||||||
entry = entry_file.read()
|
entry = entry_file.read()
|
||||||
except FileNotFoundError:
|
logger.debug("resolved path '%s' read", resolved_path)
|
||||||
logger.warning("requested path '%s' (resolved path '%s') not found!", path, resolved_path)
|
except OSError:
|
||||||
abort(404)
|
logger.exception("resolved path '%s' could not be opened!", resolved_path)
|
||||||
|
abort(500)
|
||||||
else:
|
else:
|
||||||
|
try:
|
||||||
|
md = init_md()
|
||||||
content = Markup(md.convert(entry))
|
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)
|
||||||
title = " ".join(md.Meta.get('title')) if md.Meta.get('title') else ""
|
|
||||||
return render_template('base.html', title=title, content=content, navs=parent_navs,
|
parent_navs = generate_parent_navs(resolved_path)
|
||||||
mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
|
|
||||||
|
page_name = (get_meta_str(md, 'title') if md.Meta.get('title') else
|
||||||
|
f'/{instance_resource_path_to_request_path(resolved_path)}')
|
||||||
|
page_title = f'{page_name} - {app.config["TITLE_SUFFIX"]}' if page_name else app.config['TITLE_SUFFIX']
|
||||||
|
logger.debug("title (potentially derived): %s", page_title)
|
||||||
|
|
||||||
|
template = get_meta_str(md, 'template') if md.Meta.get('template') else 'base.html'
|
||||||
|
|
||||||
|
# check if this has a HTTP redirect
|
||||||
|
redirect_url = get_meta_str(md, 'redirect') if md.Meta.get('redirect') else None
|
||||||
|
if redirect_url:
|
||||||
|
logger.debug("redirecting via meta tag to '%s'", redirect_url)
|
||||||
|
return redirect(redirect_url, code=301)
|
||||||
|
|
||||||
|
return render(template, title=page_title, description=get_meta_str(md, 'description'),
|
||||||
|
image=get_meta_str(md, 'image'), base_url=request.base_url, content=content,
|
||||||
|
navs=parent_navs, mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
|
||||||
|
|
||||||
|
|
||||||
def resolve_page_file(path):
|
def request_path_to_instance_resource_path(path):
|
||||||
"""Manipulate the request path to find appropriate page file.
|
"""Turn a request URL path to the full page path.
|
||||||
|
|
||||||
* convert dir requests to index files
|
flask.Flask.open_instance_resource will open a file like /etc/hosts if you tell it to,
|
||||||
|
which sucks, so we do a lot of work here to make sure we have a valid request to
|
||||||
Worth noting, Flask already does stuff like convert '/foo/../../../bar' to
|
something inside the pages dir.
|
||||||
'/bar', so we don't need to take care around file access here.
|
|
||||||
"""
|
"""
|
||||||
if path.endswith('/'):
|
# check if the path is allowed
|
||||||
path = f'{path}index'
|
base_dir = os.path.realpath(f'{app.instance_path}/pages/')
|
||||||
path = f'pages/{path}.md'
|
verbatim_path = os.path.abspath(os.path.join(base_dir, path))
|
||||||
return 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
|
||||||
|
if base_dir != os.path.commonpath((base_dir, resolved_path)):
|
||||||
|
logger.warning("client tried to request a path '%s' outside of the base_dir!", path)
|
||||||
|
raise PermissionError
|
||||||
|
|
||||||
|
# see if we have a real file or if we should infer markdown rendering
|
||||||
|
if os.path.exists(resolved_path):
|
||||||
|
# if this is a file-like request but actually a directory, redirect the user
|
||||||
|
if os.path.isdir(resolved_path) and not path.endswith('/'):
|
||||||
|
logger.info("client requested a path '%s' that is actually a directory", path)
|
||||||
|
raise IsADirectoryError
|
||||||
|
|
||||||
|
# if the requested path contains a symlink, redirect the user
|
||||||
|
if verbatim_path != resolved_path:
|
||||||
|
logger.info("client requested a path '%s' that is actually a symlink to file '%s'", path, resolved_path)
|
||||||
|
return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'symlink'
|
||||||
|
|
||||||
|
# derive the proper markdown or actual file depending on if this is a dir or file
|
||||||
|
if os.path.isdir(resolved_path):
|
||||||
|
resolved_path = os.path.join(resolved_path, 'index.md')
|
||||||
|
return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'markdown'
|
||||||
|
|
||||||
|
logger.info("final DIRECT path = '%s' for request '%s'", resolved_path, path)
|
||||||
|
return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'file'
|
||||||
|
|
||||||
|
# if we're here, this isn't direct file access, so try markdown inference
|
||||||
|
verbatim_path = os.path.abspath(os.path.join(base_dir, f'{path}.md'))
|
||||||
|
resolved_path = os.path.realpath(verbatim_path)
|
||||||
|
|
||||||
|
# does the final file actually exist?
|
||||||
|
if not os.path.exists(resolved_path):
|
||||||
|
logger.warning("requested final path '%s' does not exist!", resolved_path)
|
||||||
|
raise FileNotFoundError
|
||||||
|
|
||||||
|
# check for symlinks
|
||||||
|
if verbatim_path != resolved_path:
|
||||||
|
logger.info("client requested a path '%s' that is actually a symlink to file '%s'", path, resolved_path)
|
||||||
|
return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'symlink'
|
||||||
|
|
||||||
|
logger.info("final path = '%s' for request '%s'", resolved_path, path)
|
||||||
|
# we checked that the file exists via absolute path, but now we need to give the path relative to instance dir
|
||||||
|
return resolved_path.replace(f'{app.instance_path}{os.path.sep}', ''), 'markdown'
|
||||||
|
|
||||||
|
|
||||||
def is_file_path_actually_dir_path(path):
|
def instance_resource_path_to_request_path(path):
|
||||||
"""Check if requested path which looks like a file is actually a directory.
|
"""Reverse a (presumed to exist) disk path to the canonical path that would show up in a Flask route.
|
||||||
|
|
||||||
If, for example, /foo used to be a file (foo.md) which later became a directory,
|
This does not include the leading /, so aside from the root index case, this should be
|
||||||
foo/, this returns True. Useful for when I make my structure more complicated
|
bidirectional.
|
||||||
than it originally was, or if users are just weird.
|
|
||||||
"""
|
"""
|
||||||
if not path.endswith('/'):
|
return re.sub(r'^pages/', '', re.sub(r'.md$', '', re.sub(r'index.md$', '', path)))
|
||||||
logger.debug("requested path '%s' looks like a file", path)
|
|
||||||
if os.path.isdir(f'{app.instance_path}/pages/{path}'):
|
|
||||||
logger.debug("...and it's actually a dir")
|
|
||||||
return True
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def generate_parent_navs(path):
|
def generate_parent_navs(path):
|
||||||
"""Create a series of paths/links to navigate up from the given path."""
|
"""Create a series of paths/links to navigate up from the given resource path."""
|
||||||
# derive additional path/location stuff based on path
|
if path == 'pages/index.md':
|
||||||
resolved_path = resolve_page_file(path)
|
# bail and return the title suffix (generally the domain name) as a terminal case
|
||||||
parent_dir = os.path.dirname(resolved_path)
|
|
||||||
parent_path = '/'.join(path[:-1].split('/')[:-1]) + '/'
|
|
||||||
|
|
||||||
logger.debug("path: '%s'; parent path: '%s'; resolved path: '%s'; parent dir: '%s'",
|
|
||||||
path, parent_path, resolved_path, parent_dir)
|
|
||||||
|
|
||||||
if path in ('index', '/'):
|
|
||||||
return [(app.config['TITLE_SUFFIX'], '/')]
|
return [(app.config['TITLE_SUFFIX'], '/')]
|
||||||
else:
|
else:
|
||||||
with app.open_instance_resource(resolved_path, 'r') as entry_file:
|
if path.endswith('index.md'):
|
||||||
|
# index case: one dirname for foo/bar/index.md -> foo/bar, one for foo/bar -> foo
|
||||||
|
parent_resource_dir = os.path.dirname(os.path.dirname(path))
|
||||||
|
else:
|
||||||
|
# usual case: foo/buh.md -> foo
|
||||||
|
parent_resource_dir = os.path.dirname(path)
|
||||||
|
|
||||||
|
# generate the request path (i.e. what the link will be) for this path, and
|
||||||
|
# also the resource path of this parent (which is always a dir, so always index.md)
|
||||||
|
request_path = f'/{instance_resource_path_to_request_path(path)}'
|
||||||
|
parent_resource_path = os.path.join(parent_resource_dir, 'index.md')
|
||||||
|
|
||||||
|
logger.debug("resource path: '%s'; request path: '%s'; parent resource path: '%s'", path,
|
||||||
|
request_path, parent_resource_path)
|
||||||
|
|
||||||
|
# for issues regarding parser reuse (see lib.init_md) we reinitialize the parser here
|
||||||
|
md = init_md()
|
||||||
|
|
||||||
|
# read the resource
|
||||||
|
try:
|
||||||
|
with app.open_instance_resource(path, 'r') as entry_file:
|
||||||
entry = entry_file.read()
|
entry = entry_file.read()
|
||||||
_ = Markup(md.convert(entry))
|
_ = Markup(md.convert(entry))
|
||||||
page_name = " ".join(md.Meta.get('title')) if md.Meta.get('title') else f'/{path}'
|
page_name = (" ".join(md.Meta.get('title')) if md.Meta.get('title')
|
||||||
return generate_parent_navs(parent_path) + [(page_name, f'/{path}')]
|
else request_path_to_breadcrumb_display(request_path))
|
||||||
|
return generate_parent_navs(parent_resource_path) + [(page_name, request_path)]
|
||||||
|
except FileNotFoundError:
|
||||||
|
return generate_parent_navs(parent_resource_path) + [(request_path, request_path)]
|
||||||
|
|
||||||
|
|
||||||
|
def request_path_to_breadcrumb_display(path):
|
||||||
|
"""Given a request path, e.g. "/foo/bar/baz/", turn it into breadcrumby text "baz"."""
|
||||||
|
undired = path.rstrip('/')
|
||||||
|
leaf = undired[undired.rfind('/'):]
|
||||||
|
return leaf.strip('/')
|
||||||
|
|||||||
205
incorporealcms/static/css/base.css
Normal file
205
incorporealcms/static/css/base.css
Normal file
@@ -0,0 +1,205 @@
|
|||||||
|
html {
|
||||||
|
font-family: sans-serif;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
text-size-adjust: 100%;
|
||||||
|
-ms-text-size-adjust: 100%;
|
||||||
|
-moz-text-size-adjust: 100%;
|
||||||
|
-webkit-text-size-adjust: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-wrap-normal-width {
|
||||||
|
max-width: 70pc;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-wrap-double-width {
|
||||||
|
max-width: 140pc;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-wrap {
|
||||||
|
min-height: 100vh;
|
||||||
|
margin: 0;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:link {
|
||||||
|
font-weight: bold;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:visited {
|
||||||
|
font-weight: bold;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
font-weight: bold;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:active {
|
||||||
|
font-weight: bold;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
font-size: 0.75em;
|
||||||
|
padding: 0.25em 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header a {
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.content {
|
||||||
|
font-size: 11pt;
|
||||||
|
padding: 0 1em;
|
||||||
|
line-height: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
sup, sub {
|
||||||
|
vertical-align: baseline;
|
||||||
|
position: relative;
|
||||||
|
top: -0.4em;
|
||||||
|
}
|
||||||
|
sub {
|
||||||
|
top: 0.4em;
|
||||||
|
}
|
||||||
|
|
||||||
|
footer {
|
||||||
|
clear: both;
|
||||||
|
display: block;
|
||||||
|
font-size: 75%;
|
||||||
|
color: #999;
|
||||||
|
padding: 0 1em;
|
||||||
|
padding-bottom: 16px;
|
||||||
|
margin-top: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
table, th, td {
|
||||||
|
padding: 5px;
|
||||||
|
border: 1px solid #ccc;
|
||||||
|
margin-bottom: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
background-color: rgba(120, 120, 120, 0.3);
|
||||||
|
padding: 1px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.splash {
|
||||||
|
margin-top: 1em;
|
||||||
|
margin-bottom: 1em;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-25 {
|
||||||
|
max-width: 25% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-50 {
|
||||||
|
max-width: 50% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-75 {
|
||||||
|
max-width: 75% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-center {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-left {
|
||||||
|
float: left;
|
||||||
|
margin-right: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-right {
|
||||||
|
float: right;
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-frame {
|
||||||
|
padding: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* For screens with width smaller than 400px */
|
||||||
|
.figure-left .figure-right {
|
||||||
|
max-width: 95%;
|
||||||
|
float: none;
|
||||||
|
margin-left: 10px;
|
||||||
|
margin-right: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* For larger screens */
|
||||||
|
@media only screen and (min-width: 400px) {
|
||||||
|
.figure-left {
|
||||||
|
float: left;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-left: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.figure-right {
|
||||||
|
float: right;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-right: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
figure {
|
||||||
|
max-width: 400px;
|
||||||
|
padding: 5px;
|
||||||
|
margin: 10px;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
figure img {
|
||||||
|
max-width: 100%;
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
figcaption {
|
||||||
|
font-family: "Times New Roman", serif;
|
||||||
|
color: #777777;
|
||||||
|
text-align: center;
|
||||||
|
font-style: italic;
|
||||||
|
line-height: 1.3em;
|
||||||
|
margin-top: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.thumbnail-image {
|
||||||
|
width: 150px;
|
||||||
|
height: auto;
|
||||||
|
margin: 5px;
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footnote {
|
||||||
|
font-size: 0.8em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footnote p {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footnote-ref:link, .footnote-ref:visited, .footnote-ref:hover, .footnote-ref:active {
|
||||||
|
border-bottom: none;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
64
incorporealcms/static/css/dark.css
Normal file
64
incorporealcms/static/css/dark.css
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
/* common styling via the base.css, used in light and dark */
|
||||||
|
@import '/static/css/base.css';
|
||||||
|
|
||||||
|
html {
|
||||||
|
color: #DDD;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
background: #090909;
|
||||||
|
}
|
||||||
|
|
||||||
|
strong {
|
||||||
|
color: #EEE;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-wrap {
|
||||||
|
background: black;
|
||||||
|
|
||||||
|
border: 1px solid #222;
|
||||||
|
border-top: none;
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
color: #B31D15;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:link, a:visited {
|
||||||
|
color: #EEE;
|
||||||
|
border-bottom: 1px dotted #EEE;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover, a:active {
|
||||||
|
color: #B31D15;
|
||||||
|
border-bottom: 1px dotted #B31D15;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header {
|
||||||
|
background: #222;
|
||||||
|
border-bottom: 1px solid #222;
|
||||||
|
color: #BBB;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header a {
|
||||||
|
color: #BBB;
|
||||||
|
}
|
||||||
|
|
||||||
|
table, th, td {
|
||||||
|
border: 1px solid #333;
|
||||||
|
}
|
||||||
|
|
||||||
|
th {
|
||||||
|
background: #333;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
background-color: rgba(120, 120, 120, 0.3);
|
||||||
|
border: 1px solid #222;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-frame {
|
||||||
|
background-color: rgba(255, 255, 255, 0.1);
|
||||||
|
border: 1px solid #333;
|
||||||
|
}
|
||||||
64
incorporealcms/static/css/light.css
Normal file
64
incorporealcms/static/css/light.css
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
/* common styling via the base.css, used in light and dark */
|
||||||
|
@import '/static/css/base.css';
|
||||||
|
|
||||||
|
html {
|
||||||
|
color: #222;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
background: #F6F6F6;
|
||||||
|
}
|
||||||
|
|
||||||
|
strong {
|
||||||
|
color: #111;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-wrap {
|
||||||
|
background: white;
|
||||||
|
|
||||||
|
border: 1px solid #DDD;
|
||||||
|
border-top: none;
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
color: #811610;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:link, a:visited {
|
||||||
|
color: #111;
|
||||||
|
border-bottom: 1px dotted #111;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover, a:active {
|
||||||
|
color: #811610;
|
||||||
|
border-bottom: 1px dotted #811610;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header {
|
||||||
|
background: #DDD;
|
||||||
|
border-bottom: 1px solid #DDD;
|
||||||
|
color: #444;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.header a {
|
||||||
|
color: #444;
|
||||||
|
}
|
||||||
|
|
||||||
|
table, th, td {
|
||||||
|
border: 1px solid #CCC;
|
||||||
|
}
|
||||||
|
|
||||||
|
th {
|
||||||
|
background: #CCC;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
background-color: rgba(120, 120, 120, 0.1);
|
||||||
|
border: 1px solid #DDD;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-frame {
|
||||||
|
background-color: rgba(0, 0, 0, 0.1);
|
||||||
|
border: 1px solid #CCC;
|
||||||
|
}
|
||||||
12
incorporealcms/static/css/plain.css
Normal file
12
incorporealcms/static/css/plain.css
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
/* specify almost no styling, just fix some image rendering */
|
||||||
|
.img-25 {
|
||||||
|
max-width: 25% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-50 {
|
||||||
|
max-width: 50% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-75 {
|
||||||
|
max-width: 75% !important;
|
||||||
|
}
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
html {
|
|
||||||
font-family: sans-serif;
|
|
||||||
padding: 0;
|
|
||||||
padding-bottom: 16px;
|
|
||||||
color: #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1,h2,h3,h4,h5,h6 {
|
|
||||||
color: #811610;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
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 {
|
|
||||||
color: #222;
|
|
||||||
font-weight: bold;
|
|
||||||
text-decoration: none;
|
|
||||||
border-bottom: 1px dotted #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:visited {
|
|
||||||
color: #222;
|
|
||||||
font-weight: bold;
|
|
||||||
text-decoration: none;
|
|
||||||
border-bottom: 1px dotted #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
color: #811610;
|
|
||||||
font-weight: bold;
|
|
||||||
text-decoration: none;
|
|
||||||
border-bottom: 1px dotted #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:active {
|
|
||||||
color: #811610;
|
|
||||||
font-weight: bold;
|
|
||||||
text-decoration: none;
|
|
||||||
border-bottom: 1px dotted #222;
|
|
||||||
}
|
|
||||||
|
|
||||||
section.nav {
|
|
||||||
color: #666;
|
|
||||||
background: #eee;
|
|
||||||
font-size: 0.75em;
|
|
||||||
border-bottom: 1px solid #ccc;
|
|
||||||
padding: 0.25em 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
section.nav a {
|
|
||||||
color: #666;
|
|
||||||
border-bottom: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
section.content {
|
|
||||||
font-size: 11pt;
|
|
||||||
|
|
||||||
padding: 0 1em;
|
|
||||||
line-height: 1.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
footer {
|
|
||||||
display: block;
|
|
||||||
font-size: 75%;
|
|
||||||
color: #999;
|
|
||||||
padding: 0 1em;
|
|
||||||
margin-top: 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table {
|
|
||||||
border-collapse: collapse;
|
|
||||||
}
|
|
||||||
|
|
||||||
table, th, td {
|
|
||||||
padding: 5px;
|
|
||||||
border: 1px solid #ccc;
|
|
||||||
margin-bottom: 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
th {
|
|
||||||
background: #eee;
|
|
||||||
}
|
|
||||||
|
|
||||||
blockquote {
|
|
||||||
background-color: rgba(120, 120, 120, 0.1);
|
|
||||||
padding: 1px 10px;
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 49 KiB |
14
incorporealcms/templates/400.html
Normal file
14
incorporealcms/templates/400.html
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block header %}
|
||||||
|
<div class="header">
|
||||||
|
<a href="/">{{ config.TITLE_SUFFIX }}</a>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block body %}
|
||||||
|
<div class="content">
|
||||||
|
<h1>BAD REQUEST</h1>
|
||||||
|
<p>You're doing something you're not supposed to. Stop it?</p>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
19
incorporealcms/templates/404.html
Normal file
19
incorporealcms/templates/404.html
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block header %}
|
||||||
|
<div class="header">
|
||||||
|
<a href="/">{{ config.TITLE_SUFFIX }}</a>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block body %}
|
||||||
|
<div class="content">
|
||||||
|
<h1>NOT FOUND</h1>
|
||||||
|
<p>Sorry, <b><tt>{{ request.path }}</tt></b> does not seem to exist, at least not anymore.</p>
|
||||||
|
<p>It's possible you followed a dead link on this site, in which case I would appreciate it if you could email me at
|
||||||
|
{{ config.CONTACT_EMAIL }} and I can take a look. I make an effort to symlink old content to its new location,
|
||||||
|
so old links and URLs should, generally speaking, work.</p>
|
||||||
|
<p>Otherwise, I suggest you go <a href="/">to the index</a> and navigate your way (hopefully) to what
|
||||||
|
you're looking for.</p>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
14
incorporealcms/templates/500.html
Normal file
14
incorporealcms/templates/500.html
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block header %}
|
||||||
|
<div class="header">
|
||||||
|
<a href="/">{{ config.TITLE_SUFFIX }}</a>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block body %}
|
||||||
|
<div class="content">
|
||||||
|
<h1>INTERNAL SERVER ERROR</h1>
|
||||||
|
<p>Something bad happened! Please email me at {{ config.CONTACT_EMAIL }} and tell me what happened.</p>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
2
incorporealcms/templates/base-wide.html
Normal file
2
incorporealcms/templates/base-wide.html
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
{% block site_class %}class="site-wrap site-wrap-double-width"{% endblock %}
|
||||||
@@ -1,16 +1,38 @@
|
|||||||
<!doctype html>
|
<!doctype html>
|
||||||
<title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
|
<html lang="en">
|
||||||
<link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
|
<title>{{ title }}</title>
|
||||||
<link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
|
{% if title %}<meta property="og:title" content="{{ title }}">{% endif %}
|
||||||
<section class="nav">
|
{% if description %}<meta property="og:description" content="{{ description }}">{% endif %}
|
||||||
|
{% if image %}<meta property="og:image" content="{{ image }}">{% endif %}
|
||||||
|
<meta property="og:url" content="{{ base_url }}">
|
||||||
|
<meta name="twitter:card" content="summary_large_image">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}">
|
||||||
|
<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 %}>
|
||||||
|
{% block header %}
|
||||||
|
<div class="header">
|
||||||
|
<div class="nav">
|
||||||
{% for nav in navs %}
|
{% for nav in navs %}
|
||||||
<a href="{{ nav.1 }}">{{ nav.0 }}</a>
|
<a href="{{ nav.1 }}">{{ nav.0 }}</a>
|
||||||
{% if not loop.last %} » {% endif %}
|
{% if not loop.last %} » {% endif %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
</section>
|
</div>
|
||||||
<section class="content">
|
<div class="styles">
|
||||||
|
<a href="?style=dark">[dark]</a>
|
||||||
|
<a href="?style=light">[light]</a>
|
||||||
|
<a href="?style=plain">[plain]</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
{% block body %}
|
||||||
|
<div class="content">
|
||||||
{{ content }}
|
{{ content }}
|
||||||
</section>
|
</div>
|
||||||
<footer>
|
<footer>
|
||||||
<i>Last modified: {{ mtime }}</i>
|
<i>Last modified: {{ mtime }}</i>
|
||||||
</footer>
|
</footer>
|
||||||
|
{% endblock %}
|
||||||
|
</div>
|
||||||
|
</html>
|
||||||
|
|||||||
@@ -1,12 +1,25 @@
|
|||||||
-r requirements.in
|
-r requirements.in
|
||||||
|
|
||||||
flake8 # flake8 and plugins, for local dev linting in vim
|
# testing runner, test reporting, packages used during testing (e.g. requests-mock), etc.
|
||||||
|
pydot
|
||||||
|
pytest
|
||||||
|
pytest-cov
|
||||||
|
|
||||||
|
# linting and other static code analysis
|
||||||
|
bandit==1.6.2 # pinned because 1.7.0 wasn't running right in tox
|
||||||
|
dlint
|
||||||
|
flake8
|
||||||
flake8-blind-except
|
flake8-blind-except
|
||||||
flake8-builtins
|
flake8-builtins
|
||||||
flake8-docstrings
|
flake8-docstrings
|
||||||
flake8-executable
|
flake8-executable
|
||||||
|
flake8-fixme
|
||||||
flake8-isort
|
flake8-isort
|
||||||
flake8-logging-format
|
flake8-logging-format
|
||||||
|
flake8-mutable
|
||||||
|
safety # check requirements file for issues
|
||||||
|
|
||||||
|
# maintenance utilities and tox
|
||||||
pip-tools # pip-compile
|
pip-tools # pip-compile
|
||||||
tox # CI stuff
|
tox # CI stuff
|
||||||
tox-wheel # build wheels in tox
|
tox-wheel # build wheels in tox
|
||||||
|
|||||||
@@ -1,49 +1,187 @@
|
|||||||
#
|
#
|
||||||
# This file is autogenerated by pip-compile
|
# This file is autogenerated by pip-compile with python 3.8
|
||||||
# To update, run:
|
# To update, run:
|
||||||
#
|
#
|
||||||
# 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 # via virtualenv
|
attrs==21.2.0
|
||||||
click==7.1.2 # via flask, pip-tools
|
# via pytest
|
||||||
distlib==0.3.0 # via virtualenv
|
backports.entry-points-selectable==1.1.0
|
||||||
filelock==3.0.12 # via tox, virtualenv
|
# via virtualenv
|
||||||
flake8-blind-except==0.1.1 # via -r requirements/requirements-dev.in
|
backports.zoneinfo==0.2.1
|
||||||
flake8-builtins==1.5.3 # via -r requirements/requirements-dev.in
|
# via tzlocal
|
||||||
flake8-docstrings==1.5.0 # via -r requirements/requirements-dev.in
|
bandit==1.6.2
|
||||||
flake8-executable==2.0.3 # via -r requirements/requirements-dev.in
|
# via -r requirements/requirements-dev.in
|
||||||
flake8-isort==3.0.0 # via -r requirements/requirements-dev.in
|
bleach==4.1.0
|
||||||
flake8-logging-format==0.6.0 # via -r requirements/requirements-dev.in
|
# via mdx-linkify
|
||||||
flake8==3.8.3 # via -r requirements/requirements-dev.in, flake8-builtins, flake8-docstrings, flake8-executable, flake8-isort
|
certifi==2021.5.30
|
||||||
flask==1.1.2 # via -r requirements/requirements.in
|
# via requests
|
||||||
importlib-metadata==1.6.0 # via flake8, markdown, pluggy, tox, virtualenv
|
charset-normalizer==2.0.6
|
||||||
isort[pyproject]==4.3.21 # via flake8-isort
|
# via requests
|
||||||
itsdangerous==1.1.0 # via flask
|
click==8.0.1
|
||||||
jinja2==2.11.2 # via flask
|
# via
|
||||||
markdown==3.2.2 # via -r requirements/requirements.in
|
# flask
|
||||||
markupsafe==1.1.1 # via jinja2
|
# pip-tools
|
||||||
mccabe==0.6.1 # via flake8
|
# safety
|
||||||
packaging==20.4 # via tox
|
coverage[toml]==6.0.1
|
||||||
pip-tools==5.2.1 # via -r requirements/requirements-dev.in
|
# via pytest-cov
|
||||||
pluggy==0.13.1 # via tox
|
distlib==0.3.3
|
||||||
py==1.8.1 # via tox
|
# via virtualenv
|
||||||
pycodestyle==2.6.0 # via flake8
|
dlint==0.11.0
|
||||||
pydocstyle==5.0.2 # via flake8-docstrings
|
# via -r requirements/requirements-dev.in
|
||||||
pyflakes==2.2.0 # via flake8
|
dparse==0.5.1
|
||||||
pyparsing==2.4.7 # via packaging
|
# via safety
|
||||||
pytz==2020.1 # via tzlocal
|
filelock==3.3.0
|
||||||
six==1.15.0 # via packaging, pip-tools, tox, virtualenv
|
# via
|
||||||
snowballstemmer==2.0.0 # via pydocstyle
|
# tox
|
||||||
testfixtures==6.14.1 # via flake8-isort
|
# virtualenv
|
||||||
toml==0.10.1 # via isort, tox
|
flake8==3.9.2
|
||||||
tox-wheel==0.4.2 # via -r requirements/requirements-dev.in
|
# via
|
||||||
tox==3.15.2 # via -r requirements/requirements-dev.in, tox-wheel
|
# -r requirements/requirements-dev.in
|
||||||
tzlocal==2.1 # via -r requirements/requirements.in
|
# dlint
|
||||||
versioneer==0.18 # via -r requirements/requirements-dev.in
|
# flake8-builtins
|
||||||
virtualenv==20.0.23 # via tox
|
# flake8-docstrings
|
||||||
werkzeug==1.0.1 # via flask
|
# flake8-executable
|
||||||
wheel==0.34.2 # via tox-wheel
|
# flake8-isort
|
||||||
zipp==3.1.0 # via importlib-metadata
|
# flake8-mutable
|
||||||
|
flake8-blind-except==0.2.0
|
||||||
|
# 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
|
||||||
|
flask==2.0.2
|
||||||
|
# via -r requirements/requirements.in
|
||||||
|
gitdb==4.0.7
|
||||||
|
# via gitpython
|
||||||
|
gitpython==3.1.24
|
||||||
|
# via bandit
|
||||||
|
idna==3.2
|
||||||
|
# via requests
|
||||||
|
iniconfig==1.1.1
|
||||||
|
# via pytest
|
||||||
|
isort==5.9.3
|
||||||
|
# via flake8-isort
|
||||||
|
itsdangerous==2.0.1
|
||||||
|
# via flask
|
||||||
|
jinja2==3.0.2
|
||||||
|
# via flask
|
||||||
|
markdown==3.3.4
|
||||||
|
# via
|
||||||
|
# -r requirements/requirements.in
|
||||||
|
# mdx-linkify
|
||||||
|
markupsafe==2.0.1
|
||||||
|
# via jinja2
|
||||||
|
mccabe==0.6.1
|
||||||
|
# via flake8
|
||||||
|
mdx-linkify==2.1
|
||||||
|
# via -r requirements/requirements.in
|
||||||
|
packaging==21.0
|
||||||
|
# via
|
||||||
|
# bleach
|
||||||
|
# dparse
|
||||||
|
# pytest
|
||||||
|
# safety
|
||||||
|
# tox
|
||||||
|
pbr==5.6.0
|
||||||
|
# via stevedore
|
||||||
|
pep517==0.11.0
|
||||||
|
# via pip-tools
|
||||||
|
pip-tools==6.3.0
|
||||||
|
# via -r requirements/requirements-dev.in
|
||||||
|
platformdirs==2.4.0
|
||||||
|
# via virtualenv
|
||||||
|
pluggy==1.0.0
|
||||||
|
# via
|
||||||
|
# pytest
|
||||||
|
# tox
|
||||||
|
py==1.10.0
|
||||||
|
# via
|
||||||
|
# pytest
|
||||||
|
# tox
|
||||||
|
pycodestyle==2.7.0
|
||||||
|
# via flake8
|
||||||
|
pydocstyle==6.1.1
|
||||||
|
# via flake8-docstrings
|
||||||
|
pydot==1.4.2
|
||||||
|
# via -r requirements/requirements-dev.in
|
||||||
|
pyflakes==2.3.1
|
||||||
|
# via flake8
|
||||||
|
pyparsing==2.4.7
|
||||||
|
# via
|
||||||
|
# packaging
|
||||||
|
# pydot
|
||||||
|
pytest==6.2.5
|
||||||
|
# via
|
||||||
|
# -r requirements/requirements-dev.in
|
||||||
|
# pytest-cov
|
||||||
|
pytest-cov==3.0.0
|
||||||
|
# via -r requirements/requirements-dev.in
|
||||||
|
pyyaml==5.4.1
|
||||||
|
# via
|
||||||
|
# bandit
|
||||||
|
# dparse
|
||||||
|
requests==2.26.0
|
||||||
|
# via safety
|
||||||
|
safety==1.10.3
|
||||||
|
# via -r requirements/requirements-dev.in
|
||||||
|
six==1.16.0
|
||||||
|
# via
|
||||||
|
# bandit
|
||||||
|
# bleach
|
||||||
|
# tox
|
||||||
|
# virtualenv
|
||||||
|
smmap==4.0.0
|
||||||
|
# via gitdb
|
||||||
|
snowballstemmer==2.1.0
|
||||||
|
# via pydocstyle
|
||||||
|
stevedore==3.4.0
|
||||||
|
# via bandit
|
||||||
|
testfixtures==6.18.3
|
||||||
|
# via flake8-isort
|
||||||
|
toml==0.10.2
|
||||||
|
# via
|
||||||
|
# dparse
|
||||||
|
# pytest
|
||||||
|
# tox
|
||||||
|
tomli==1.2.1
|
||||||
|
# via
|
||||||
|
# coverage
|
||||||
|
# pep517
|
||||||
|
tox==3.24.4
|
||||||
|
# via
|
||||||
|
# -r requirements/requirements-dev.in
|
||||||
|
# tox-wheel
|
||||||
|
tox-wheel==0.6.0
|
||||||
|
# via -r requirements/requirements-dev.in
|
||||||
|
typing-extensions==3.10.0.2
|
||||||
|
# via gitpython
|
||||||
|
tzlocal==3.0
|
||||||
|
# via -r requirements/requirements.in
|
||||||
|
urllib3==1.26.7
|
||||||
|
# via requests
|
||||||
|
versioneer==0.20
|
||||||
|
# via -r requirements/requirements-dev.in
|
||||||
|
virtualenv==20.8.1
|
||||||
|
# via tox
|
||||||
|
webencodings==0.5.1
|
||||||
|
# via bleach
|
||||||
|
werkzeug==2.0.2
|
||||||
|
# via flask
|
||||||
|
wheel==0.37.0
|
||||||
|
# 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
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
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
|
tzlocal # identifying system's local timezone
|
||||||
|
|||||||
@@ -1,17 +1,38 @@
|
|||||||
#
|
#
|
||||||
# This file is autogenerated by pip-compile
|
# This file is autogenerated by pip-compile with python 3.8
|
||||||
# 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
|
||||||
#
|
#
|
||||||
click==7.1.2 # via flask
|
backports.zoneinfo==0.2.1
|
||||||
flask==1.1.2 # via -r requirements/requirements.in
|
# via tzlocal
|
||||||
importlib-metadata==1.6.0 # via markdown
|
bleach==4.1.0
|
||||||
itsdangerous==1.1.0 # via flask
|
# via mdx-linkify
|
||||||
jinja2==2.11.2 # via flask
|
click==8.0.1
|
||||||
markdown==3.2.2 # via -r requirements/requirements.in
|
# via flask
|
||||||
markupsafe==1.1.1 # via jinja2
|
flask==2.0.2
|
||||||
pytz==2020.1 # via tzlocal
|
# via -r requirements/requirements.in
|
||||||
tzlocal==2.1 # via -r requirements/requirements.in
|
itsdangerous==2.0.1
|
||||||
werkzeug==1.0.1 # via flask
|
# via flask
|
||||||
zipp==3.1.0 # via importlib-metadata
|
jinja2==3.0.2
|
||||||
|
# via flask
|
||||||
|
markdown==3.3.4
|
||||||
|
# via
|
||||||
|
# -r requirements/requirements.in
|
||||||
|
# mdx-linkify
|
||||||
|
markupsafe==2.0.1
|
||||||
|
# via jinja2
|
||||||
|
mdx-linkify==2.1
|
||||||
|
# via -r requirements/requirements.in
|
||||||
|
packaging==21.0
|
||||||
|
# via bleach
|
||||||
|
pyparsing==2.4.7
|
||||||
|
# via packaging
|
||||||
|
six==1.16.0
|
||||||
|
# via bleach
|
||||||
|
tzlocal==3.0
|
||||||
|
# via -r requirements/requirements.in
|
||||||
|
webencodings==0.5.1
|
||||||
|
# via bleach
|
||||||
|
werkzeug==2.0.2
|
||||||
|
# via flask
|
||||||
|
|||||||
5
setup.py
5
setup.py
@@ -18,7 +18,7 @@ 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',
|
license='GPLv2+',
|
||||||
author='Brian S. Stephan',
|
author='Brian S. Stephan',
|
||||||
author_email='bss@incorporeal.org',
|
author_email='bss@incorporeal.org',
|
||||||
version=versioneer.get_version(),
|
version=versioneer.get_version(),
|
||||||
@@ -27,4 +27,7 @@ setup(
|
|||||||
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'],
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|||||||
39
tests/functional_markdown_tests.py
Normal file
39
tests/functional_markdown_tests.py
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
"""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_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
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
"""Test page requests."""
|
"""Test page requests."""
|
||||||
import re
|
import re
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
|
||||||
def test_page_that_exists(client):
|
def test_page_that_exists(client):
|
||||||
@@ -9,25 +10,113 @@ def test_page_that_exists(client):
|
|||||||
assert b'<h1>test index</h1>' in response.data
|
assert b'<h1>test index</h1>' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_direct_file_that_exists(client):
|
||||||
|
"""Test that the app can serve a basic file at the index."""
|
||||||
|
response = client.get('/foo.txt')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'test file' in response.data
|
||||||
|
|
||||||
|
|
||||||
def test_page_that_doesnt_exist(client):
|
def test_page_that_doesnt_exist(client):
|
||||||
"""Test that the app returns 404 for nonsense requests."""
|
"""Test that the app returns 404 for nonsense requests and they use my error page."""
|
||||||
response = client.get('/ohuesthaoeusth')
|
response = client.get('/ohuesthaoeusth')
|
||||||
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
|
||||||
|
# test the contact email config
|
||||||
|
assert b'admin@example.com' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_files_outside_pages_do_not_get_served(client):
|
||||||
|
"""Test that page pathing doesn't break out of the instance/pages/ dir, and the error uses my error page."""
|
||||||
|
response = client.get('/../unreachable')
|
||||||
|
assert response.status_code == 400
|
||||||
|
assert b'You\'re doing something you\'re not supposed to. Stop it?' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_internal_server_error_serves_error_page(client):
|
||||||
|
"""Test that various exceptions serve up the 500 page."""
|
||||||
|
response = client.get('/actually-a-png')
|
||||||
|
assert response.status_code == 500
|
||||||
|
assert b'INTERNAL SERVER ERROR' in response.data
|
||||||
|
# test the contact email config
|
||||||
|
assert b'admin@example.com' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_oserror_is_500(client, app):
|
||||||
|
"""Test that an OSError raises as a 500."""
|
||||||
|
with app.test_request_context():
|
||||||
|
with patch('flask.current_app.open_instance_resource', side_effect=OSError):
|
||||||
|
response = client.get('/')
|
||||||
|
assert response.status_code == 500
|
||||||
|
assert b'INTERNAL SERVER ERROR' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_unsupported_file_type_is_500(client, app):
|
||||||
|
"""Test a coding condition mishap raises as a 500."""
|
||||||
|
with app.test_request_context():
|
||||||
|
with patch('incorporealcms.pages.request_path_to_instance_resource_path', return_value=('foo', 'bar')):
|
||||||
|
response = client.get('/')
|
||||||
|
assert response.status_code == 500
|
||||||
|
assert b'INTERNAL SERVER ERROR' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_weird_paths_do_not_get_served(client):
|
||||||
|
"""Test that we clean up requests as desired."""
|
||||||
|
response = client.get('/../../')
|
||||||
|
assert response.status_code == 400
|
||||||
|
|
||||||
|
|
||||||
def test_page_with_title_metadata(client):
|
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>incorporeal.org</title>' in response.data
|
assert b'<title>/no-title - example.com</title>' in response.data
|
||||||
assert b'<h1>this page doesn\'t have a title!</h1>' in response.data
|
|
||||||
|
|
||||||
|
def test_page_in_subdir_without_title_metadata(client):
|
||||||
|
"""Test that the title-less page display is as expected."""
|
||||||
|
response = client.get('/subdir//page-no-title')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'<title>/subdir/page-no-title - example.com</title>' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_page_with_card_metadata(client):
|
||||||
|
"""Test that a page with opengraph metadata."""
|
||||||
|
response = client.get('/more-metadata')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'<meta property="og:title" content="title for the page - example.com">' in response.data
|
||||||
|
assert b'<meta property="og:description" content="description of this page made even longer">' in response.data
|
||||||
|
assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_page_with_card_title_even_when_no_metadata(client):
|
||||||
|
"""Test that a page without metadata still has a card with the derived title."""
|
||||||
|
response = client.get('/no-title')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'<meta property="og:title" content="/no-title - example.com">' in response.data
|
||||||
|
assert b'<meta property="og:description"' not in response.data
|
||||||
|
assert b'<meta property="og:image"' not in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_page_with_forced_empty_title_just_shows_suffix(client):
|
||||||
|
"""Test that if a page specifies a blank Title meta tag explicitly, only the suffix is used in the title."""
|
||||||
|
response = client.get('/forced-no-title')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'<title>example.com</title>' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_page_with_redirect_meta_url_redirects(client):
|
||||||
|
"""Test that if a page specifies a URL to redirect to, that the site serves up a 301."""
|
||||||
|
response = client.get('/redirect')
|
||||||
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://www.google.com/'
|
||||||
|
|
||||||
|
|
||||||
def test_page_has_modified_timestamp(client):
|
def test_page_has_modified_timestamp(client):
|
||||||
@@ -45,6 +134,44 @@ def test_that_page_request_redirects_to_directory(client):
|
|||||||
"""
|
"""
|
||||||
response = client.get('/subdir')
|
response = client.get('/subdir')
|
||||||
assert response.status_code == 301
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://localhost/subdir/'
|
||||||
|
|
||||||
|
|
||||||
|
def test_that_request_to_symlink_redirects_markdown(client):
|
||||||
|
"""Test that a request to /foo redirects to /what-foo-points-at."""
|
||||||
|
response = client.get('/symlink-to-no-title')
|
||||||
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://localhost/no-title'
|
||||||
|
|
||||||
|
|
||||||
|
def test_that_request_to_symlink_redirects_file(client):
|
||||||
|
"""Test that a request to /foo.txt redirects to /what-foo-points-at.txt."""
|
||||||
|
response = client.get('/symlink-to-foo.txt')
|
||||||
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://localhost/foo.txt'
|
||||||
|
|
||||||
|
|
||||||
|
def test_that_request_to_symlink_redirects_directory(client):
|
||||||
|
"""Test that a request to /foo/ redirects to /what-foo-points-at/."""
|
||||||
|
response = client.get('/symlink-to-subdir/')
|
||||||
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://localhost/subdir'
|
||||||
|
# sadly, this location also redirects
|
||||||
|
response = client.get('/subdir')
|
||||||
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://localhost/subdir/'
|
||||||
|
# but we do get there
|
||||||
|
response = client.get('/subdir/')
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
|
||||||
|
def test_that_request_to_symlink_redirects_subdirectory(client):
|
||||||
|
"""Test that a request to /foo/bar redirects to /what-foo-points-at/bar."""
|
||||||
|
response = client.get('/symlink-to-subdir/page-no-title')
|
||||||
|
assert response.status_code == 301
|
||||||
|
assert response.location == 'http://localhost/subdir/page-no-title'
|
||||||
|
response = client.get('/subdir/page-no-title')
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
|
||||||
def test_that_dir_request_does_not_redirect(client):
|
def test_that_dir_request_does_not_redirect(client):
|
||||||
@@ -52,3 +179,34 @@ def test_that_dir_request_does_not_redirect(client):
|
|||||||
response = client.get('/subdir/')
|
response = client.get('/subdir/')
|
||||||
assert response.status_code == 200
|
assert response.status_code == 200
|
||||||
assert b'another page' in response.data
|
assert b'another page' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_setting_selected_style_includes_cookie(client):
|
||||||
|
"""Test that a request with style=foo sets the cookie and renders appropriately."""
|
||||||
|
response = client.get('/')
|
||||||
|
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
|
||||||
|
assert style_cookie is None
|
||||||
|
|
||||||
|
response = client.get('/?style=light')
|
||||||
|
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'light.css' in response.data
|
||||||
|
assert b'dark.css' not in response.data
|
||||||
|
assert style_cookie.value == 'light'
|
||||||
|
|
||||||
|
response = client.get('/?style=dark')
|
||||||
|
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'dark.css' in response.data
|
||||||
|
assert b'light.css' not in response.data
|
||||||
|
assert style_cookie.value == 'dark'
|
||||||
|
|
||||||
|
|
||||||
|
def test_pages_can_supply_alternate_templates(client):
|
||||||
|
"""Test that pages can supply templates other than the default."""
|
||||||
|
response = client.get('/')
|
||||||
|
assert b'class="site-wrap site-wrap-normal-width"' in response.data
|
||||||
|
assert b'class="site-wrap site-wrap-double-width"' not in response.data
|
||||||
|
response = client.get('/custom-template')
|
||||||
|
assert b'class="site-wrap site-wrap-normal-width"' not in response.data
|
||||||
|
assert b'class="site-wrap site-wrap-double-width"' in response.data
|
||||||
|
|||||||
BIN
tests/instance/pages/actually-a-png.md
Normal file
BIN
tests/instance/pages/actually-a-png.md
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
BIN
tests/instance/pages/bss-square-no-bg.png
Normal file
BIN
tests/instance/pages/bss-square-no-bg.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
3
tests/instance/pages/custom-template.md
Normal file
3
tests/instance/pages/custom-template.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
Template: base-wide.html
|
||||||
|
|
||||||
|
testttttttttt
|
||||||
1
tests/instance/pages/foo.txt
Normal file
1
tests/instance/pages/foo.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
test file
|
||||||
3
tests/instance/pages/forced-no-title.md
Normal file
3
tests/instance/pages/forced-no-title.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
Title:
|
||||||
|
|
||||||
|
some words are here
|
||||||
3
tests/instance/pages/mdash-or-triple-dash.md
Normal file
3
tests/instance/pages/mdash-or-triple-dash.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
Test page
|
||||||
|
|
||||||
|
word --- word
|
||||||
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
6
tests/instance/pages/more-metadata.md
Normal file
6
tests/instance/pages/more-metadata.md
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Title: title for the page
|
||||||
|
Description: description of this page
|
||||||
|
made even longer
|
||||||
|
Image: http://buh.com/test.img
|
||||||
|
|
||||||
|
hello
|
||||||
1
tests/instance/pages/no-index-dir/page.md
Normal file
1
tests/instance/pages/no-index-dir/page.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
this is a test page
|
||||||
1
tests/instance/pages/redirect.md
Normal file
1
tests/instance/pages/redirect.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
Redirect: http://www.google.com/
|
||||||
1
tests/instance/pages/subdir/page-no-title.md
Normal file
1
tests/instance/pages/subdir/page-no-title.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
this is just a page
|
||||||
1
tests/instance/pages/symlink-to-foo.txt
Symbolic link
1
tests/instance/pages/symlink-to-foo.txt
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
foo.txt
|
||||||
1
tests/instance/pages/symlink-to-no-title.md
Symbolic link
1
tests/instance/pages/symlink-to-no-title.md
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
no-title.md
|
||||||
1
tests/instance/pages/symlink-to-subdir
Symbolic link
1
tests/instance/pages/symlink-to-subdir
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
subdir
|
||||||
12
tests/instance/pages/test-graphviz.md
Normal file
12
tests/instance/pages/test-graphviz.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# test
|
||||||
|
|
||||||
|
test
|
||||||
|
~~~pydot:attack-plan
|
||||||
|
digraph G {
|
||||||
|
rankdir=LR
|
||||||
|
Earth
|
||||||
|
Mars
|
||||||
|
Earth -> Mars
|
||||||
|
}
|
||||||
|
~~~
|
||||||
|
more test
|
||||||
11
tests/instance/pages/test-invalid-graphviz.md
Normal file
11
tests/instance/pages/test-invalid-graphviz.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# test
|
||||||
|
|
||||||
|
test
|
||||||
|
~~~pydot:attack-plan
|
||||||
|
rankdir=LR
|
||||||
|
Earth
|
||||||
|
Mars
|
||||||
|
Earth -> Mars
|
||||||
|
}
|
||||||
|
~~~
|
||||||
|
more test
|
||||||
1
tests/instance/unreachable.md
Normal file
1
tests/instance/unreachable.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
this file exists but the app should not serve it.
|
||||||
@@ -13,6 +13,36 @@ def test_config():
|
|||||||
assert create_app(instance_path=instance_path, test_config={"TESTING": True}).testing
|
assert create_app(instance_path=instance_path, test_config={"TESTING": True}).testing
|
||||||
|
|
||||||
|
|
||||||
|
def test_markdown_meta_extension_always():
|
||||||
|
"""Test that the markdown meta extension is always loaded, even if not specified."""
|
||||||
|
app = create_app(instance_path=os.path.join(HERE, 'instance'),
|
||||||
|
test_config={'MARKDOWN_EXTENSIONS': []})
|
||||||
|
client = app.test_client()
|
||||||
|
response = client.get('/')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'<title>Index - example.com</title>' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_custom_markdown_extensions_work():
|
||||||
|
"""Test we can change extensions via config, and that they work.
|
||||||
|
|
||||||
|
This used to test smarty, but that's added by default now, so we test
|
||||||
|
that it can be removed by overriding the option.
|
||||||
|
"""
|
||||||
|
app = create_app(instance_path=os.path.join(HERE, 'instance'))
|
||||||
|
client = app.test_client()
|
||||||
|
response = client.get('/mdash-or-triple-dash')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'word — word' in response.data
|
||||||
|
|
||||||
|
app = create_app(instance_path=os.path.join(HERE, 'instance'),
|
||||||
|
test_config={'MARKDOWN_EXTENSIONS': []})
|
||||||
|
client = app.test_client()
|
||||||
|
response = client.get('/mdash-or-triple-dash')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'word --- word' in response.data
|
||||||
|
|
||||||
|
|
||||||
def test_title_override():
|
def test_title_override():
|
||||||
"""Test that a configuration with a specific title overrides the default."""
|
"""Test that a configuration with a specific title overrides the default."""
|
||||||
instance_path = os.path.join(HERE, 'instance')
|
instance_path = os.path.join(HERE, 'instance')
|
||||||
@@ -20,7 +50,7 @@ def test_title_override():
|
|||||||
client = app.test_client()
|
client = app.test_client()
|
||||||
response = client.get('/no-title')
|
response = client.get('/no-title')
|
||||||
assert response.status_code == 200
|
assert response.status_code == 200
|
||||||
assert b'<title>suou.net</title>' in response.data
|
assert b'<title>/no-title - suou.net</title>' in response.data
|
||||||
|
|
||||||
|
|
||||||
def test_media_file_access(client):
|
def test_media_file_access(client):
|
||||||
@@ -28,3 +58,22 @@ def test_media_file_access(client):
|
|||||||
response = client.get('/media/favicon.png')
|
response = client.get('/media/favicon.png')
|
||||||
assert response.status_code == 200
|
assert response.status_code == 200
|
||||||
assert response.headers['content-type'] == 'image/png'
|
assert response.headers['content-type'] == 'image/png'
|
||||||
|
|
||||||
|
|
||||||
|
def test_favicon_override():
|
||||||
|
"""Test that a configuration with a specific favicon overrides the default."""
|
||||||
|
instance_path = os.path.join(HERE, 'instance')
|
||||||
|
app = create_app(instance_path=instance_path, test_config={'FAVICON': '/media/foo.png'})
|
||||||
|
client = app.test_client()
|
||||||
|
response = client.get('/no-title')
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert b'<link rel="icon" href="/media/foo.png">' in response.data
|
||||||
|
|
||||||
|
|
||||||
|
def test_misconfigured_markdown_extensions():
|
||||||
|
"""Test that a misconfigured markdown extensions leads to a 500 at render time."""
|
||||||
|
instance_path = os.path.join(HERE, 'instance')
|
||||||
|
app = create_app(instance_path=instance_path, test_config={'MARKDOWN_EXTENSIONS': 'WRONG'})
|
||||||
|
client = app.test_client()
|
||||||
|
response = client.get('/no-title')
|
||||||
|
assert response.status_code == 500
|
||||||
|
|||||||
@@ -1,76 +1,221 @@
|
|||||||
"""Unit test helper methods."""
|
"""Unit test helper methods."""
|
||||||
from incorporealcms.pages import generate_parent_navs, is_file_path_actually_dir_path, resolve_page_file
|
import pytest
|
||||||
|
from werkzeug.http import dump_cookie
|
||||||
|
|
||||||
|
from incorporealcms.pages import (generate_parent_navs, instance_resource_path_to_request_path, render,
|
||||||
def test_resolve_page_file_dir_to_index():
|
request_path_to_breadcrumb_display, request_path_to_instance_resource_path)
|
||||||
"""Test that a request to a directory path results in the dir's index.md."""
|
|
||||||
assert resolve_page_file('foo/') == 'pages/foo/index.md'
|
|
||||||
|
|
||||||
|
|
||||||
def test_resolve_page_file_subdir_to_index():
|
|
||||||
"""Test that a request to a dir's subdir path results in the subdir's index.md."""
|
|
||||||
assert resolve_page_file('foo/bar/') == 'pages/foo/bar/index.md'
|
|
||||||
|
|
||||||
|
|
||||||
def test_resolve_page_file_other_requests_fine():
|
|
||||||
"""Test that a request to non-dir path results in a Markdown file."""
|
|
||||||
assert resolve_page_file('foo/baz') == 'pages/foo/baz.md'
|
|
||||||
|
|
||||||
|
|
||||||
def test_generate_page_navs_index(app):
|
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('/') == [('incorporeal.org', '/')]
|
assert generate_parent_navs('pages/index.md') == [('example.com', '/')]
|
||||||
|
|
||||||
|
|
||||||
def test_generate_page_navs_alternate_index(app):
|
|
||||||
"""Test that the index page (as a page, not a path) also has navs only to the root (by path)."""
|
|
||||||
with app.app_context():
|
|
||||||
assert generate_parent_navs('index') == [('incorporeal.org', '/')]
|
|
||||||
|
|
||||||
|
|
||||||
def test_generate_page_navs_subdir_index(app):
|
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('subdir/') == [('incorporeal.org', '/'), ('/subdir/', '/subdir/')]
|
assert generate_parent_navs('pages/subdir/index.md') == [('example.com', '/'), ('subdir', '/subdir/')]
|
||||||
|
|
||||||
|
|
||||||
def test_generate_page_navs_subdir_real_page(app):
|
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('subdir/page') == [('incorporeal.org', '/'), ('/subdir/', '/subdir/'),
|
assert generate_parent_navs('pages/subdir/page.md') == [('example.com', '/'), ('subdir', '/subdir/'),
|
||||||
('Page', '/subdir/page')]
|
('Page', '/subdir/page')]
|
||||||
|
|
||||||
|
|
||||||
def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
|
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('subdir-with-title/page') == [
|
assert generate_parent_navs('pages/subdir-with-title/page.md') == [
|
||||||
('incorporeal.org', '/'),
|
('example.com', '/'),
|
||||||
('SUB!', '/subdir-with-title/'),
|
('SUB!', '/subdir-with-title/'),
|
||||||
('/subdir-with-title/page', '/subdir-with-title/page')
|
('page', '/subdir-with-title/page')
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def test_is_file_path_actually_dir_path_valid_file_is_yes(app):
|
def test_generate_page_navs_subdir_with_no_index(app):
|
||||||
"""Test that a file request for what's actually a directory is detected as such."""
|
"""Test that breadcrumbs still generate even if a subdir doesn't have an index.md."""
|
||||||
with app.app_context():
|
with app.app_context():
|
||||||
assert is_file_path_actually_dir_path('/subdir')
|
assert generate_parent_navs('pages/no-index-dir/page.md') == [
|
||||||
|
('example.com', '/'),
|
||||||
|
('/no-index-dir/', '/no-index-dir/'),
|
||||||
|
('page', '/no-index-dir/page')
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
def test_is_file_path_actually_dir_path_valid_dir_is_no(app):
|
def test_render_with_user_dark_theme(app):
|
||||||
"""Test that a directory request is still a directory request."""
|
"""Test that a request with the dark theme selected renders the dark theme."""
|
||||||
with app.app_context():
|
cookie = dump_cookie("user-style", 'dark')
|
||||||
assert not is_file_path_actually_dir_path('/subdir/')
|
with app.test_request_context(headers={'COOKIE': cookie}):
|
||||||
|
assert b'dark.css' in render('base.html').data
|
||||||
|
assert b'light.css' not in render('base.html').data
|
||||||
|
|
||||||
|
|
||||||
def test_is_file_path_actually_dir_path_nonsense_file_is_no(app):
|
def test_render_with_user_light_theme(app):
|
||||||
"""Test that requests to nonsense file-looking paths aren't treated as dirs."""
|
"""Test that a request with the light theme selected renders the light theme."""
|
||||||
with app.app_context():
|
with app.test_request_context():
|
||||||
assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax')
|
assert b'light.css' in render('base.html').data
|
||||||
|
assert b'dark.css' not in render('base.html').data
|
||||||
|
|
||||||
|
|
||||||
def test_is_file_path_actually_dir_path_nonsense_dir_is_no(app):
|
def test_render_with_no_user_theme(app):
|
||||||
"""Test that a directory request is a directory request even if the dir doesn't exist."""
|
"""Test that a request with no theme set renders the light theme."""
|
||||||
with app.app_context():
|
with app.test_request_context():
|
||||||
assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax/')
|
assert b'light.css' in render('base.html').data
|
||||||
|
assert b'dark.css' not in render('base.html').data
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert request_path_to_instance_resource_path('index') == ('pages/index.md', 'markdown')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_direct_file(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert request_path_to_instance_resource_path('no-title') == ('pages/no-title.md', 'markdown')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_in_subdir(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert request_path_to_instance_resource_path('subdir/page') == ('pages/subdir/page.md', 'markdown')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_subdir_index(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert request_path_to_instance_resource_path('subdir/') == ('pages/subdir/index.md', 'markdown')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_relatives_walked(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('subdir/more-subdir/../../more-metadata') ==
|
||||||
|
('pages/more-metadata.md', 'markdown'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_relatives_walked_indexes_work_too(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert request_path_to_instance_resource_path('subdir/more-subdir/../../') == ('pages/index.md', 'markdown')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_relatives_walked_into_subdirs_also_fine(app):
|
||||||
|
"""Test a normal URL request is transformed into the file path."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('subdir/more-subdir/../../subdir/page') ==
|
||||||
|
('pages/subdir/page.md', 'markdown'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_permission_error_on_ref_above_pages(app):
|
||||||
|
"""Test that attempts to get above the base dir ("/../../foo") fail."""
|
||||||
|
with app.test_request_context():
|
||||||
|
with pytest.raises(PermissionError):
|
||||||
|
assert request_path_to_instance_resource_path('../unreachable')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_isadirectory_on_file_like_req_for_dir(app):
|
||||||
|
"""Test that a request for e.g. '/foo' when foo is a dir indicate to redirect."""
|
||||||
|
with app.test_request_context():
|
||||||
|
with pytest.raises(IsADirectoryError):
|
||||||
|
assert request_path_to_instance_resource_path('subdir')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_actual_file(app):
|
||||||
|
"""Test that a request for e.g. '/foo.png' when foo.png is a real file works."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('bss-square-no-bg.png') ==
|
||||||
|
('pages/bss-square-no-bg.png', 'file'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_markdown_symlink(app):
|
||||||
|
"""Test that a request for e.g. '/foo' when foo.md is a symlink to another .md file redirects."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('symlink-to-no-title') ==
|
||||||
|
('pages/no-title.md', 'symlink'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_file_symlink(app):
|
||||||
|
"""Test that a request for e.g. '/foo' when foo.txt is a symlink to another .txt file redirects."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('symlink-to-foo.txt') ==
|
||||||
|
('pages/foo.txt', 'symlink'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_dir_symlink(app):
|
||||||
|
"""Test that a request for e.g. '/foo' when /foo is a symlink to /bar redirects."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('symlink-to-subdir/') ==
|
||||||
|
('pages/subdir', 'symlink'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_subdir_symlink(app):
|
||||||
|
"""Test that a request for e.g. '/foo/baz' when /foo is a symlink to /bar redirects."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert (request_path_to_instance_resource_path('symlink-to-subdir/page-no-title') ==
|
||||||
|
('pages/subdir/page-no-title.md', 'symlink'))
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_nonexistant_file_errors(app):
|
||||||
|
"""Test that a request for something not on disk errors."""
|
||||||
|
with app.test_request_context():
|
||||||
|
with pytest.raises(FileNotFoundError):
|
||||||
|
assert request_path_to_instance_resource_path('nthanpthpnh')
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_instance_resource_path_absolute_file_errors(app):
|
||||||
|
"""Test that a request for something not on disk errors."""
|
||||||
|
with app.test_request_context():
|
||||||
|
with pytest.raises(PermissionError):
|
||||||
|
assert request_path_to_instance_resource_path('/etc/hosts')
|
||||||
|
|
||||||
|
|
||||||
|
def test_instance_resource_path_to_request_path_on_index(app):
|
||||||
|
"""Test index.md -> /."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert instance_resource_path_to_request_path('index.md') == ''
|
||||||
|
|
||||||
|
|
||||||
|
def test_instance_resource_path_to_request_path_on_page(app):
|
||||||
|
"""Test no-title.md -> no-title."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert instance_resource_path_to_request_path('no-title.md') == 'no-title'
|
||||||
|
|
||||||
|
|
||||||
|
def test_instance_resource_path_to_request_path_on_subdir(app):
|
||||||
|
"""Test subdir/index.md -> subdir/."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert instance_resource_path_to_request_path('subdir/index.md') == 'subdir/'
|
||||||
|
|
||||||
|
|
||||||
|
def test_instance_resource_path_to_request_path_on_subdir_and_page(app):
|
||||||
|
"""Test subdir/page.md -> subdir/page."""
|
||||||
|
with app.test_request_context():
|
||||||
|
assert instance_resource_path_to_request_path('subdir/page.md') == 'subdir/page'
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_resource_request_root(app):
|
||||||
|
"""Test that a request can resolve to a resource and back to a request."""
|
||||||
|
with app.test_request_context():
|
||||||
|
instance_path, _ = request_path_to_instance_resource_path('index')
|
||||||
|
instance_resource_path_to_request_path(instance_path) == ''
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_resource_request_page(app):
|
||||||
|
"""Test that a request can resolve to a resource and back to a request."""
|
||||||
|
with app.test_request_context():
|
||||||
|
instance_path, _ = request_path_to_instance_resource_path('no-title')
|
||||||
|
instance_resource_path_to_request_path(instance_path) == 'no-title'
|
||||||
|
|
||||||
|
|
||||||
|
def test_request_path_to_breadcrumb_display_patterns():
|
||||||
|
"""Test various conversions from request path to leaf nodes for display in the breadcrumbs."""
|
||||||
|
assert request_path_to_breadcrumb_display('/foo') == 'foo'
|
||||||
|
assert request_path_to_breadcrumb_display('/foo/') == 'foo'
|
||||||
|
assert request_path_to_breadcrumb_display('/foo/bar') == 'bar'
|
||||||
|
assert request_path_to_breadcrumb_display('/foo/bar/') == 'bar'
|
||||||
|
assert request_path_to_breadcrumb_display('/') == ''
|
||||||
|
|||||||
76
tox.ini
76
tox.ini
@@ -4,7 +4,7 @@
|
|||||||
# and then run "tox" from this directory.
|
# and then run "tox" from this directory.
|
||||||
|
|
||||||
[tox]
|
[tox]
|
||||||
envlist = py37,security,lint
|
envlist = begin,py37,py38,py39,coverage,security,lint,bundle
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
# build a wheel and test it
|
# build a wheel and test it
|
||||||
@@ -12,45 +12,65 @@ wheel = true
|
|||||||
wheel_build_env = build
|
wheel_build_env = build
|
||||||
|
|
||||||
# whitelist commands we need
|
# whitelist commands we need
|
||||||
whitelist_externals = ln
|
whitelist_externals = cp
|
||||||
|
|
||||||
|
# install everything via requirements-dev.txt, so that developer environment
|
||||||
|
# is the same as the tox environment (for ease of use/no weird gotchas in
|
||||||
|
# local dev results vs. tox results) and also to avoid ticky-tacky maintenance
|
||||||
|
# of "oh this particular env has weird results unless I install foo" --- just
|
||||||
|
# shotgun blast install everything everywhere
|
||||||
|
deps =
|
||||||
|
-rrequirements/requirements-dev.txt
|
||||||
|
|
||||||
[testenv:build]
|
[testenv:build]
|
||||||
# require setuptools when building
|
# require setuptools when building
|
||||||
deps = setuptools
|
deps = setuptools
|
||||||
|
|
||||||
|
[testenv:begin]
|
||||||
|
# clean up potential previous coverage runs
|
||||||
|
skip_install = true
|
||||||
|
commands = coverage erase
|
||||||
|
|
||||||
[testenv:py37]
|
[testenv:py37]
|
||||||
# run pytest and coverage
|
# run pytest with coverage
|
||||||
deps =
|
|
||||||
pytest
|
|
||||||
pytest-cov
|
|
||||||
commands =
|
commands =
|
||||||
pytest --cov={envsitepackagesdir}/incorporealcms/ \
|
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
|
||||||
--cov-report=term-missing --cov-branch --cov-fail-under=90
|
|
||||||
ln -sf {distdir} dist
|
[testenv:py38]
|
||||||
|
# run pytest with coverage
|
||||||
|
commands =
|
||||||
|
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
|
||||||
|
|
||||||
|
[testenv:py39]
|
||||||
|
# run pytest with coverage
|
||||||
|
commands =
|
||||||
|
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
|
||||||
|
|
||||||
|
[testenv:coverage]
|
||||||
|
# report on coverage runs from above
|
||||||
|
skip_install = true
|
||||||
|
commands =
|
||||||
|
coverage report --fail-under=95 --show-missing
|
||||||
|
|
||||||
[testenv:security]
|
[testenv:security]
|
||||||
# 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
|
||||||
deps =
|
|
||||||
bandit
|
|
||||||
commands =
|
commands =
|
||||||
bandit {envsitepackagesdir}/incorporealcms/ -r
|
bandit {envsitepackagesdir}/incorporealcms/ -r
|
||||||
|
safety check -r requirements/requirements-dev.txt
|
||||||
|
|
||||||
[testenv:lint]
|
[testenv:lint]
|
||||||
# run style checks
|
# run style checks
|
||||||
skip_install = true
|
|
||||||
deps =
|
|
||||||
flake8
|
|
||||||
flake8-blind-except
|
|
||||||
flake8-builtins
|
|
||||||
flake8-docstrings
|
|
||||||
flake8-executable
|
|
||||||
flake8-isort
|
|
||||||
flake8-logging-format
|
|
||||||
commands =
|
commands =
|
||||||
flake8
|
flake8
|
||||||
- flake8 --disable-noqa --select=E,W,F,C,D,A,G,B,I
|
- flake8 --disable-noqa --ignore= --select=E,W,F,C,D,A,G,B,I,T,M,DUO
|
||||||
|
|
||||||
|
[testenv:bundle]
|
||||||
|
# take extra actions (build sdist, sphinx, whatever) to completely package the app
|
||||||
|
commands =
|
||||||
|
cp -r {distdir} .
|
||||||
|
python setup.py sdist
|
||||||
|
|
||||||
[coverage:paths]
|
[coverage:paths]
|
||||||
source =
|
source =
|
||||||
@@ -59,23 +79,29 @@ 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
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
max-line-length = 120
|
enable-extensions = G,M
|
||||||
exclude =
|
exclude =
|
||||||
.tox/
|
.tox/
|
||||||
versioneer.py
|
versioneer.py
|
||||||
_version.py
|
_version.py
|
||||||
instance/
|
instance/
|
||||||
|
extend-ignore = T101
|
||||||
max-complexity = 10
|
max-complexity = 10
|
||||||
|
max-line-length = 120
|
||||||
|
|
||||||
[isort]
|
[isort]
|
||||||
line_length = 120
|
line_length = 120
|
||||||
# only way I could figure out how to make tests/conftest.py happy and have pytest separate from incorporealcms
|
|
||||||
# and if I let them be combined in tox runs, flake8-isort in vim would complain :(
|
|
||||||
forced_separate = incorporealcms
|
|
||||||
|
|
||||||
[pytest]
|
[pytest]
|
||||||
python_files =
|
python_files =
|
||||||
|
|||||||
Reference in New Issue
Block a user