Compare commits

...

228 commits

Author SHA1 Message Date
c3e02a0d1a feat: moving from old name conventions. 2024-12-25 00:43:55 +05:00
Magnus Hovland Hoff
b034dcf61a Update bart dependency, which depended on a yanked crate version. 2023-06-21 21:59:17 +02:00
Magnus Hovland Hoff
03227d6aa9 Remove some redundant "extern crate" statements 2022-04-03 22:21:04 +02:00
Magnus Hovland Hoff
0521f0ce5a Upgrade quote 2022-04-03 22:16:45 +02:00
Magnus Hovland Hoff
25dcb85c24 Warning seems to have disappeared with updated diesel dependency 2022-04-03 22:10:29 +02:00
Magnus Hovland Hoff
bf34e2923b Addressed many cargo clippy complaints 2022-04-03 22:09:36 +02:00
Magnus Hovland Hoff
95a73b9471 cargo clippy --fix 2022-04-03 14:29:35 +02:00
Magnus Hovland Hoff
9320d14d89 Manually fix remaining compile warnings. 2022-04-03 14:19:56 +02:00
Magnus Hovland Hoff
e0f52cd031 Upgrade diesel dependencies.
When switching to edition=2021, the build fails with a linking error to -lsqlite3.
Upgrading libsqlite3-sys unfortunately does not fix this.
2022-04-03 14:01:45 +02:00
Magnus Hovland Hoff
203a701517 Upgrade lazy_static to get rid of compile warning 2022-04-03 13:49:15 +02:00
Magnus Hovland Hoff
9f80ced3ec cargo fmt 2022-04-03 13:47:43 +02:00
Magnus Hovland Hoff
26fe2b64da Update edition, cargo fix and cargo fix --edition 2022-04-03 13:45:50 +02:00
Magnus Hovland Hoff
3f71040aec Disable auto-deploy.
I would like to keep continuous builds available, but the auto-deploy has triggered
GitHub releases for every build, which is very confusing documentation. Also, Travis
and other CI services, do not seem to want to offer a free tier any longer. Considering
switching to running continuous build on my own hardware somehow.
2022-04-03 13:35:10 +02:00
Magnus Hovland Hoff
f675896054 Update API key for Github deploy 2021-05-23 21:17:42 +02:00
Magnus Hovland Hoff
3b16598444 cargo update
Fix broken build
2021-05-01 20:18:41 +02:00
Magnus Hovland Hoff
fef213f9f3 cargo update
This fixes build breakage caused by rotten dependency
2020-05-25 21:37:24 +02:00
Magnus Hovland Hoff
f96cc8dac5 Silence warnings caused by Diesel on Rust >=1.29, also in build.rs 2018-10-27 15:30:33 +02:00
Magnus Hovland Hoff
a20117a42c Silence warnings caused by Diesel on Rust >=1.29.
I expect this to be fixed in a future release of Diesel
2018-10-27 11:42:09 +02:00
Magnus Hovland Hoff
58a859b014 Completely disable setting focus.
setSelectionRange causes Safari to set focus to the element. Trying to get rid of distracting focus changes that pops up an on-screen keyboard
2018-10-08 07:53:41 +02:00
Magnus Hovland Hoff
318273a75d Improve placeholder styling.
Apply placeholder styling to title editor as well
2018-10-08 07:49:14 +02:00
Magnus Hovland Hoff
0a64a274ac Bugfix. Anonymous edits would have a stray period. 2018-10-07 13:54:09 +02:00
Magnus Hovland Hoff
ccbabb86f8 Make theme optional when updating articles.
This makes sense from an API design perspective
2018-10-05 13:07:19 +02:00
Magnus Hovland Hoff
09c68c5993 Select random theme for new articles server side.
This supports user agents with disabled javascript (noscript)
2018-10-05 11:56:53 +02:00
Magnus Hovland Hoff
7373af0417 Select random theme for new articles client side 2018-10-05 11:19:47 +02:00
Magnus Hovland Hoff
65ad262bd8 Bugfix.
Cancel button is always disabled and shown conditionally
2018-10-05 11:03:41 +02:00
Magnus Hovland Hoff
cffcc93b15 Add tests for automatically slugged links 2018-10-03 22:35:47 +02:00
Magnus Hovland Hoff
575c18f915 Support automatically slugged links 2018-10-03 18:24:55 +02:00
Magnus Hovland Hoff
6d1c9967aa Correctly mark unused variable 2018-10-03 18:12:27 +02:00
Magnus Hovland Hoff
748459483e Show author for diffs that show only one changeset 2018-10-02 08:44:06 +02:00
Magnus Hovland Hoff
01ceda8015 Use correct number for generating pagination link 2018-10-01 22:58:40 +02:00
Magnus Hoff
16384c9f83 Inconsequential change to trigger CI pipeline 2018-10-01 10:03:24 +02:00
Magnus Hovland Hoff
d5410f2a22 Revert focusing the body text editor when entering edit mode.
This behaves badly in multiple mobile browsers, causing confusion. Perhaps it is better to disable this feature altogether
2018-10-01 09:02:55 +02:00
Magnus Hovland Hoff
17c23da9bf Better scroll handling when toggling editing.
It will now retain the scroll position relative to the full document height when entering and leaving editing mode. This places the viewport closer to the contents you were watching. This is likely less disorienting
2018-10-01 09:01:27 +02:00
Magnus Hovland Hoff
619ba14b3f Fix editor controls layout in narrow layout 2018-10-01 08:36:44 +02:00
Magnus Hoff
58283a601c Also disable form elements via CSS pointer-events when not in edit mode.
This lets us visually transition the controls without accidentally enabling interaction
2018-09-30 22:33:40 +02:00
Magnus Hoff
c6dd37ed9e Centralize handling of form elements state handling.
This makes it easier to maintain state changes. Seems to handle all states well now
2018-09-30 22:30:52 +02:00
Magnus Hoff
85014d2789 Include theme in response when creating new article.
Bug caused by duplication of code.
2018-09-30 22:29:37 +02:00
Magnus Hovland Hoff
a81a568ee2 Forward the edit-state when redirecting to renamed articles.
This improves usability with noscript
2018-09-24 23:01:01 +02:00
Magnus Hovland Hoff
e92c9695be Fix editing of new articles with noscript.
This also generalizes the code. Neat!
2018-09-24 22:55:10 +02:00
Magnus Hovland Hoff
0439ca0d8e Avoid storing build cache in travis,
it costs more than we gain
2018-09-24 18:30:17 +02:00
Magnus Hovland Hoff
62378007b1 Reset theme when editing is canceled 2018-09-24 18:21:50 +02:00
Magnus Hoff
3bbe5840ee Implement theme picker UI 2018-09-24 08:43:36 +02:00
Magnus Hovland Hoff
baaab6ebc8 Store theme explicitly in database. Propagate theme both ways between db and frontend 2018-09-23 22:38:18 +02:00
Magnus Hovland Hoff
fe0011e757 Allow build.rs to figure out the correct database schema 2018-09-23 21:39:54 +02:00
Magnus Hovland Hoff
828490df3b Update serde_urlencoded dependency for bugfix 2018-09-23 21:39:09 +02:00
Magnus Hovland Hoff
c1fcc80cf0 Minor fix for making Theme insertable with Diesel 2018-09-23 21:38:17 +02:00
Magnus Hovland Hoff
8f1e95bdde Add theme to ArticleRevisionStub, RebaseResult and related.
This paves the way for explicitly storing the theme in the database
2018-09-22 23:16:58 +02:00
Magnus Hovland Hoff
c82228f019 Propagate theme in ArticleRevisions from the state struct 2018-09-21 08:57:35 +02:00
Magnus Hovland Hoff
b777a92a48 Expose theme_from_str_hash to SQL.
To be used in a db migration for storing the previously implicit value
2018-09-20 23:17:25 +02:00
Magnus Hovland Hoff
ca1e072d9b Add more tests for using Theme with the database 2018-09-20 08:37:27 +02:00
Magnus Hovland Hoff
df066c611d Add support for using Theme with the database 2018-09-19 22:56:12 +02:00
Magnus Hovland Hoff
f961699f0f Rename function to avoid confusion 2018-09-19 08:20:43 +02:00
Magnus Hovland Hoff
6118f14bb0 Explicitly set theme for layout.
Refactoring in anticipation of letting the user choose theme
2018-09-18 23:11:25 +02:00
Magnus Hovland Hoff
c1dcb1de64 Make responsibility for converting a theme to a css class to the theme module 2018-09-18 19:43:33 +02:00
Magnus Hovland Hoff
d4e8277f2a Dependency for previous commit 2018-09-18 19:21:36 +02:00
Magnus Hovland Hoff
a65e85f242 Refactor Theme handling to a new module.
Fundamentals for communicating about themes with the database and over http
2018-09-18 07:56:58 +02:00
Magnus Hovland Hoff
ecf4c1e98e Disable save hotkey when it is not appropriate 2018-09-16 22:31:57 +02:00
Magnus Hovland Hoff
534dffdfe3 Show disabled cancel button instead of removing it.
This fixes two problems caused by the removal of the button: Broken layout and broken JS
2018-09-16 22:25:28 +02:00
Magnus Hovland Hoff
999253a778 Place text caret at end of text to reduce visual distraction caused by stuff moving around 2018-09-16 12:16:03 +02:00
Magnus Hovland Hoff
a00cdf6394 Position editor controls with units that are affected by the scroll bar 2018-09-16 12:10:02 +02:00
Magnus Hovland Hoff
8d86e8937a Capitalize placeholder in search input.
I think I like this better
2018-09-16 12:06:20 +02:00
Magnus Hovland Hoff
830f641167 Fine-tune margin 2018-09-13 08:48:09 +02:00
Magnus Hoff
d6e1015197 Reset style for Safari to make transition between view and edit more seamless 2018-09-11 19:53:14 +02:00
Magnus Hoff
9c67333b87 Wider top margin for better visual balance 2018-09-11 19:19:22 +02:00
Magnus Hovland Hoff
7b1a0256e1 Add rainbow bar to test-themes 2018-08-31 21:30:46 +02:00
Magnus Hovland Hoff
94db59c44c Add hotkey for saving 2018-08-22 08:14:25 +02:00
Magnus Hovland Hoff
42e7857fcd Revert "Attempt to improve overscroll in Apple browsers"
This reverts commit 0847cb5c4d.
2018-08-21 21:57:40 +02:00
Magnus Hovland Hoff
0847cb5c4d Attempt to improve overscroll in Apple browsers 2018-08-21 19:06:53 +02:00
Magnus Hovland Hoff
b8da0ff753 Fix breakpoint size for editor controls 2018-08-21 19:02:38 +02:00
Magnus Hovland Hoff
096da6ef38 Iterate on editor controls design 2018-08-21 18:40:44 +02:00
Magnus Hoff
c94bf91fc2 Iterate on editor controls styling 2018-08-20 23:25:03 +02:00
Magnus Hoff
b93c79c479 Update styling of .notice 2018-08-20 22:47:52 +02:00
Magnus Hoff
b8a4368219 Improve contrast for placeholder text in search box 2018-08-20 22:32:04 +02:00
Magnus Hoff
8500075357 Update styling of hr 2018-08-20 22:31:35 +02:00
Magnus Hoff
53e983bee9 Iterate on themes
Select yellow alternate colors for some hues where blue works poorly
2018-07-21 11:54:03 +02:00
Magnus Hoff
c18b8f45d1 Iterate on the themes.
Always white text
2018-07-20 23:35:33 +02:00
Magnus Hoff
d3a50b0bc0 Iterate on color schemes.
Improve descision of proper contrast
2018-07-19 08:53:05 +02:00
Magnus Hoff
d905c1aa62 Unify appearence of placeholder text across browsers 2018-07-19 08:43:22 +02:00
Magnus Hoff
5a2be1d0a8 Update print style.
Hide outgoing link-indicator
2018-07-19 08:39:14 +02:00
Magnus Hoff
c2c0bae335 Avoid changing layout on hover 2018-07-19 08:36:47 +02:00
Magnus Hoff
e26e60ce2c Iterate on the design
Less box-shadow
2018-07-16 22:11:53 +02:00
Magnus Hoff
d5bb94dfb6 Iterate on the color palettes
Darker link color for light backgrounds
2018-07-16 20:10:30 +02:00
Magnus Hoff
05b12501a3 Iterate on the color palettes 2018-07-16 08:30:29 +02:00
Magnus Hoff
c201bb4bc4 Add test page for themes 2018-07-10 08:46:51 +02:00
Magnus Hoff
963d70ff7a Add dynamic-assets feature to facilitate rapid feedback when working on the assets 2018-07-09 21:27:34 +02:00
Magnus Hoff
8b0e58c24c Update about text 2018-07-08 22:34:04 +02:00
Magnus Hoff
862632335b Minor
This CSS is now included directly from the HTML. The real fix, however, is to preprocess the CSS into one file
2018-06-25 08:05:42 +02:00
Magnus Hoff
c0ce03973a Update print style for new theme 2018-06-25 08:03:40 +02:00
Magnus Hoff
0b5bff6356 Refactor handling of generated unique names for resources 2018-06-24 23:00:35 +02:00
cmal
77210a9692 Do not underline external link marker on hover (#69) 2018-06-24 15:04:37 +02:00
Magnus Hoff
e4fa7ed89a Credit cmal as new contributor 2018-06-24 14:56:01 +02:00
cmal
a85abf1ccb Added marker for external links (#63) 2018-06-23 10:35:22 +02:00
Magnus Hoff
bddf4c0225 CSS tweaks for iOS 2018-06-17 23:02:36 +02:00
Magnus Hoff
f7227bf3d4 Fix misalignment 2018-06-17 22:20:12 +02:00
Magnus Hoff
38c70f7b25 Select persistent theme per page based on title 2018-06-17 21:25:35 +02:00
Magnus Hoff
31ace5d4c2 Apply new style to search 2018-06-17 21:16:44 +02:00
Magnus Hoff
e4629d8edb Refactor rendering of pages to centralize header layout.
Convert all pages to new layout
2018-06-17 10:43:47 +02:00
Magnus Hoff
2b27e27a9b Tweak layout.html.
This fixes #67
2018-06-16 14:51:13 +02:00
Magnus Hoff
0a48ff2a54 Factor choice of theme into Layout struct 2018-06-16 14:30:18 +02:00
Magnus Hoff
7e6fe36ea0 Serve articles with a random theme 2018-06-16 11:24:34 +02:00
Magnus Hoff
4516534b39 Start trying out implementing new layout 2018-06-16 10:58:00 +02:00
Magnus Hoff
67ac61ee42 Add CSS defining color schemes/themes 2018-06-16 10:51:51 +02:00
Magnus Hoff
a40d45b197 Add utility for generating CSS for color themes 2018-06-16 10:32:33 +02:00
Magnus Hoff
28c8422e6b Tweak full text search representation of documents 2018-06-13 23:13:38 +02:00
Magnus Hoff
d577eabc9b Port to stable diesel API for user defined sqlite functions 2018-06-13 22:46:53 +02:00
Magnus Hoff
a582d3a627 Merge branch 'master' into process_markdown_in_sqlite 2018-06-13 22:22:08 +02:00
Magnus Hoff
b7c281e6f6 Misc upgrade of dependencies 2018-06-13 22:16:44 +02:00
Magnus Hoff
75e33b2766 Update to get rid of warnings that appeared when upgrading diesel.
One warning remains: unused import: `EmbedMigrations`. This one has been fixed in diesel, but not yet released
2018-06-13 22:03:55 +02:00
Magnus Hoff
604bea0c25 Upgrade diesel dependencies 2018-06-13 21:55:06 +02:00
Magnus Hoff
fc3bd0992a Run tests in the debug build.
Cargo has started failing to build the tests in the release configuration because tests must have panic=unwind, while the release profile is configured with panic=abort
2018-05-21 13:50:51 +02:00
Magnus Hoff
995737ff44 Revert "Disable build caching in Travis."
This reverts commit 4a8800a7c4.

It did not help with the failure on Travis.
2018-05-21 13:47:19 +02:00
Magnus Hoff
4a8800a7c4 Disable build caching in Travis.
This might or might not fix a build failure that I cannot reproduce locally
2018-05-14 08:19:16 +02:00
Magnus Hoff
81cda3bc35 Add CONTRIBUTING.md to help would-be contributors 2018-05-13 14:01:27 +02:00
Magnus Hoff
263a84637f Add a document describing the design 2018-05-13 13:57:05 +02:00
Magnus Hoff
d63ccd06b7 Cleanup 2018-05-12 14:36:52 +02:00
Magnus Hoff
c72ee90929 Return Result from main (requires Rust 1.26) 2018-05-12 14:34:09 +02:00
Magnus Hoff
b1b1a91db1 Attempt to fix font preload link 2018-01-21 11:58:04 +01:00
Magnus Hoff
b1e598cb17 Experimentally transform markdown for better presentation in full text search results
For issue #37
2018-01-19 16:49:26 +01:00
Magnus Hoff
e499a095c7 Use experimental Diesel branch for application defined sqlite functions 2018-01-19 16:47:40 +01:00
Magnus Hoff
c52ac1c2f1 Upgrade to Diesel 1.0.0 2018-01-06 09:29:15 +01:00
Magnus Hoff
bfbc81ada2 Add contributor 2017-12-17 17:32:02 +01:00
kyegupov
8b838ac8c9 Fix tests after diff bump; drive-by prettify diff tests (#56) 2017-12-17 17:14:39 +01:00
Magnus Hoff
6e3f1dab07 Upgrade to Diesel 1.0.0-beta1 2017-12-15 16:43:10 +01:00
Magnus Hoff
b7a7ae53ab Update to Diesel 0.99
This fixes #49
2017-12-15 16:29:24 +01:00
Magnus Hoff
4b1e1f9222 Promote brew install method to something one could try 2017-12-02 13:23:30 +01:00
Magnus Hoff
df05b1de79 Reset border-radius for <button> elements 2017-12-02 13:13:40 +01:00
Magnus Hoff
a6e329faf0 Simplify "Discard changes?" dialog 2017-12-02 11:06:20 +01:00
Magnus Hoff
bc0f8b8046 Restyle and refactor popup dialogs 2017-12-02 11:01:24 +01:00
Magnus Hoff
9f5b057266 Simplify styling of popups, get better results 2017-12-02 09:39:26 +01:00
Magnus Hoff
259c884045 Refactor popups a little 2017-12-01 16:52:39 +01:00
Magnus Hoff
ebef585c9c Replace use of confirm(), for #47 2017-12-01 16:44:07 +01:00
Magnus Hoff
35d13308b9 Replace use of alert(), for #47 2017-12-01 16:37:41 +01:00
Magnus Hoff
578d525e25 Better styling of popup dialog 2017-12-01 16:22:36 +01:00
Magnus Hoff
5ce9b37ab0 Update about.html 2017-11-30 13:29:21 +01:00
Magnus Hoff
2bf201e3fd Inject soft hyphen into commit hash so it works better on more screens 2017-11-30 13:24:13 +01:00
Magnus Hoff
ca805f1a9d Make it slightly clearer that the prebuilt binary is Linux only 2017-11-30 12:35:28 +01:00
Magnus Hoff
b31c47c103 Avoid deep directory structure in produced tar file 2017-11-30 12:33:07 +01:00
Magnus Hoff
342f996c8e Eliminate one weird install step by using tar instead of xz directly 2017-11-30 12:16:42 +01:00
Magnus Hoff
7dd5c046b7 Merge branch 'proper_html_handling' 2017-11-29 22:52:42 +01:00
Magnus Hoff
c780450dc3 Grammar 2017-11-29 16:52:31 +01:00
Magnus Hoff
1953baddbd Strike out brew install instructions, due to bug 2017-11-29 16:46:48 +01:00
Magnus Hoff
7e930a5df1 Words 2017-11-29 15:47:23 +01:00
Magnus Hoff
861765c85a Add brew formula 2017-11-29 15:45:03 +01:00
Magnus Hoff
b8be70ad27 Add link to documentation for enabling authentication. For #29 2017-11-29 14:31:01 +01:00
Magnus Hoff
74d2c18943 Use heuristic to guess that we hit a login redirect on saving 2017-11-29 12:53:41 +01:00
Magnus Hoff
2e406f4480 Handle authorization problems when saving article with JS 2017-11-24 17:26:46 +01:00
Magnus Hoff
af358fe22c Tweak 2017-11-24 12:20:02 +01:00
Magnus Hoff
fc7bf4cac1 Update USAGE in README 2017-11-22 14:48:06 +01:00
Magnus Hoff
afa48f5f85 Link to wiki page on making backups 2017-11-21 16:36:14 +01:00
Magnus Hoff
f261d66a3a Link to systemd install instructions 2017-11-21 14:14:57 +01:00
Magnus Hoff
98a8dd8aca Tweak print style for <pre> 2017-11-21 11:55:52 +01:00
Magnus Hoff
07c3f4204f Always update body text when editing, it could be changed server-side due to merging 2017-11-21 09:57:59 +01:00
Magnus Hoff
0f835fa312 Update tests 2017-11-20 16:48:31 +01:00
Magnus Hoff
a09aa4b601 Expose merge conflicts in the JavaScript editor. This fixes #23 2017-11-20 16:37:52 +01:00
Magnus Hoff
b685139d5b Implement merge conflict handling for the noscript case #23 2017-11-20 16:07:33 +01:00
Magnus Hoff
bf9716ccb8 Propagate rebase conflicts out from state object 2017-11-20 15:08:34 +01:00
Magnus Hoff
bfca5d6e78 Rebase title edits, #23 2017-11-20 13:12:36 +01:00
Magnus Hoff
b862ad8c73 Add test for rebasing over multiple revisions 2017-11-20 12:41:14 +01:00
Magnus Hoff
e92eab2c8f Automatically rebase edits to historic revisions, for #23 2017-11-20 12:37:44 +01:00
Magnus Hoff
9be9575639 Cleanup, obsolete attribute 2017-11-20 11:16:27 +01:00
Magnus Hoff
8519480fe4 Use build.rs to properly trigger rebuilds when env vars change, for #44 2017-11-20 10:26:35 +01:00
Magnus Hoff
83b011b9c9 Add more build info. This fixes #44 2017-11-20 10:19:49 +01:00
Magnus Hoff
88b3df21c2 Refactor build information and add more information #44 2017-11-20 10:12:10 +01:00
Magnus Hoff
990f570a31 Tests for article merging 2017-11-17 16:17:05 +01:00
Magnus Hoff
1eff18e659 Implement high level merge function 2017-11-17 16:13:48 +01:00
Magnus Hoff
dfefe78b2b Resolve output from tree-way diff chunks 2017-11-17 15:32:45 +01:00
Magnus Hoff
34ca3e424d Remove Chunk categorization from MergeIterator 2017-11-17 12:41:09 +01:00
Magnus Hoff
1985677474 Cleanup, refactor 2017-11-16 16:38:50 +01:00
Magnus Hoff
f6818f5a7f Maintain state in slices instead of indices 2017-11-16 16:31:24 +01:00
Magnus Hoff
ed5db344fb Emit slices instead of indices 2017-11-16 16:21:49 +01:00
Magnus Hoff
b48816e143 Borrow instead of move 2017-11-16 15:52:32 +01:00
Magnus Hoff
29a6ec6725 Cleanup, more descriptive names 2017-11-16 15:43:45 +01:00
Magnus Hoff
df39e658cd Start implementing merge, for #23 2017-11-16 15:38:45 +01:00
Magnus Hoff
d241da35fb More tests 2017-11-16 10:44:55 +01:00
Magnus Hoff
2665fb3b8a Add a test for State 2017-11-15 16:27:28 +01:00
Magnus Hoff
7b485f87b9 Refactor State, centralizing db connection and cpu pool handling 2017-11-15 15:58:33 +01:00
Magnus Hoff
59e1ca8fb4 Cleanup 2017-11-15 15:12:17 +01:00
Magnus Hoff
403158ddda Split entry point into main.rs and lib.rs.
This might enable some integration tests
2017-11-15 15:06:18 +01:00
Magnus Hoff
b2e8b45100 Avoid copyright notice for MPL2-licensed dependencies
The license does not include a copyright notice
2017-11-14 16:14:28 +01:00
Magnus Hoff
334b17ae56 Add license and attribution for musl 2017-11-14 14:48:52 +01:00
Magnus Hoff
efd1cc4b5c Update license-hound 2017-11-14 14:39:48 +01:00
Magnus Hoff
3521fd76b3 Add license information for missing crates 2017-11-14 14:37:31 +01:00
Magnus Hoff
1911a914ef Generate license attributions from JSON
JSON is mainly generated by cargo-license-hound
2017-11-14 13:06:50 +01:00
Magnus Hoff
f2ad17b33f Split codegen crate into modules 2017-11-14 11:40:28 +01:00
Magnus Hoff
249e428107 Rename proc macro helper crate 2017-11-14 11:35:13 +01:00
Magnus Hoff
21905b3506 Cleanup 2017-11-14 11:29:31 +01:00
Magnus Hoff
43f8ec439e "Hide" editor pages from search engines
They are essentially duplicates of the article pages
2017-11-14 11:21:41 +01:00
Magnus Hoff
26fc263cd4 Reword about page. Add list of dependencies and licenses 2017-11-07 15:54:46 +01:00
Magnus Hoff
7ad2a2ad73 Add SIL Open Font License 2017-11-07 15:49:26 +01:00
Magnus Hoff
ce7c0893bc Cleanup 2017-11-06 16:28:31 +01:00
Magnus Hoff
a796f299a4 Add link to diff view from article revision 2017-11-06 16:26:37 +01:00
Magnus Hoff
f9905e6548 Avoid generating invalid diff links in changes feed 2017-11-06 16:07:25 +01:00
Magnus Hoff
5acca0ddb7 Add links to the article before and after diff 2017-11-06 15:58:16 +01:00
Magnus Hoff
ac5ff0dbcc Add link to article history from diff page 2017-11-06 15:52:51 +01:00
Magnus Hoff
bfd2acda4f Get article revisions from database during diff lookup.
Diffs for missing revisions now cause 404-errors
2017-11-06 15:45:11 +01:00
Magnus Hoff
2e5b549ea8 Restructure the diff resource so it is only possible to see diffs between revisions of the same article 2017-11-06 15:09:21 +01:00
Magnus Hoff
c24c5a84d5 Generate links to diffs from changes feed 2017-11-06 13:37:46 +01:00
Magnus Hoff
9cb3da86e2 Also render diff of title 2017-11-06 13:06:32 +01:00
Magnus Hoff
2042e5e7fe Style diff a little bit better 2017-11-06 12:55:13 +01:00
Magnus Hoff
4ae2637192 Fix print CSS to avoid extra blank page at the end 2017-11-03 00:35:29 +01:00
Magnus Hoff
73b5ffc719 Add CSS for print 2017-11-03 00:16:18 +01:00
Magnus Hoff
e563faf81a Refactor lookup of license resources 2017-11-02 15:34:36 +01:00
Magnus Hoff
29a7d58b41 Use maplit for static hash map literal 2017-11-02 15:19:23 +01:00
Magnus Hoff
5ea9dbef71 Add BSD-3-Clause to list of licenses 2017-11-02 15:16:16 +01:00
Magnus Hoff
faec67c797 Include and serve relevant software licenses 2017-11-02 14:48:22 +01:00
Magnus Hoff
63b9715550 Add a bare bones _about page. #10 2017-11-01 15:38:50 +01:00
Magnus Hoff
78bd53e640 Machine readable branding.
Include project name and version in Server header and generator meta tag
2017-11-01 13:17:58 +01:00
Magnus Hoff
2626223f10 Styling for h4, h5, h6. Why do you need these? 2017-11-01 12:56:24 +01:00
Magnus Hoff
833c96b58d Make use of .default_value in clap 2017-11-01 11:58:11 +01:00
Magnus Hoff
548555c45e Populate clap with information from Cargo.toml 2017-11-01 11:44:49 +01:00
Magnus Hoff
551c4dc52b Report errors in live search without a modal dialog (alert) 2017-10-31 14:03:29 +01:00
Magnus Hoff
254ace7d24 README 2017-10-31 14:02:50 +01:00
Magnus Hoff
59b9e77d47 Rudimentary support for comparing revisions of articles
For issue #21
2017-10-30 16:35:21 +01:00
Magnus Hoff
a6f707b911 Allow configuration of bind address 2017-10-30 14:59:39 +01:00
Magnus Hoff
b6d3cbf2c6 Improve regression resistance with named consts 2017-10-30 14:40:49 +01:00
Magnus Hoff
7d431b46fe Require something in the title field, client side 2017-10-30 13:23:06 +01:00
Magnus Hoff
3dd4927281 Forbid empty titles in application layer 2017-10-30 13:20:40 +01:00
Magnus Hoff
dd97b8055c Cleanup 2017-10-30 13:06:32 +01:00
Magnus Hoff
975661048e Refactor to reuse TemporaryRedirectResource instead of ArticleRedirectResource 2017-10-30 12:56:28 +01:00
Magnus Hoff
1bdc21039b Refactor generation of links from slugs
This fixes a bug where the cancel-link on the front page would be to "" rather than "."
2017-10-30 12:42:53 +01:00
Magnus Hoff
4ca748f180 Optionally show authors in _changes based on --trust-identity command line argument.
This fixes #19
2017-10-30 11:44:36 +01:00
Magnus Hoff
ef4a3e689b More properly fix --trust-identity command line option 2017-10-30 11:33:05 +01:00
Magnus Hoff
245ecaa969 Prefer dashes in command line options 2017-10-30 11:04:01 +01:00
Magnus Hoff
5b37a41632 Support editing articles without JavaScript 2017-10-30 11:01:37 +01:00
Magnus Hoff
db2d8f5d76 More features 2017-10-29 22:51:19 +01:00
Magnus Hoff
bdb34d94bd Add "Features" to readme 2017-10-29 12:16:31 +01:00
Magnus Hoff
3ca84dbb4e Attempt to stop navigation when there is an edit in progress. This fixes #16 2017-10-28 15:26:50 +02:00
Magnus Hoff
6d56ad0001 Ask user for confirmation when they abandon an edit in progress. This fixes #17 2017-10-28 15:21:47 +02:00
81 changed files with 9496 additions and 1874 deletions

View file

@ -14,25 +14,10 @@ before_install:
script:
- rustup target add x86_64-unknown-linux-musl
- cargo test --target=x86_64-unknown-linux-musl
- cargo build --release --target=x86_64-unknown-linux-musl
- cargo test --release --target=x86_64-unknown-linux-musl
- strip -s target/x86_64-unknown-linux-musl/release/sausagewiki
- xz -9 < target/x86_64-unknown-linux-musl/release/sausagewiki > sausagewiki.xz
deploy:
provider: releases
api_key:
secure: NmM+uk4ijbv5wFF3O7w9KLTrGYbe1mxWAzJDR8cD9rimgORWNQKlHOZtthAQxVgtvmhKAMkzwglgQSX3p0w4yGK5oaV3oO1aA21dzlf0BXL7/BOxgYSTjV+x8O1uIu57ERnf4k2WATCpLSx4r4LpfxMgjdEtIl6LDAnV/zX+HKu7pZAzXvmkS22m5CJbEY4M6DpCAIfpP99dolnyU7h5/AR1njMmzSqGB/naVe5O2j0sBveInsjC+4gPSh9QT/VHZBxbOctcy+kSzwN4iDktkFdYIGe9Z2sDjXsiI39ihXntyOHXA2iVpdkgpIGeLIYBOo+DobgMdS45CzZQ2y9zLnwXwODCgrh8qexxnRpC8RG7uKuVe50R6v4HDPgkjwCJoHicxaEUDiPIsg5qCxEfMYd5qUt21OwEwBN9N8K/RZD0fmgKLE5lQiyxubufeSB4wjpWrXct2M46t25qPFobbZ0kzLCXtZHtKk1mkkk+EWv8UOhRvJ8ih0Fb9ivSOrN6YA1/eRd9/SRntkJriMYmfAW50W3DnyFnPHqdV+x+jHJgcB+DnaDvQnPamk93ZDF/UyUDjVuPJFd0BAFxoRUy6HGaF/yajH4r9g3EdlfSu2IrGDo4vIA9qawBYpHyaSGvYwdCDx4/oUPIAf8sLBS01WOaDJgcmmFey7A/OqSEt6Q=
file: sausagewiki.xz
skip_cleanup: true
on:
repo: maghoff/sausagewiki
branch: master
rust: stable
cache: cargo
before_cache:
- chmod -R a+r $HOME/.cargo
- XZ_OPT=-9 tar Jcf sausagewiki.tar.xz -C target/x86_64-unknown-linux-musl/release/ sausagewiki
branches:
except:

1621
Cargo.lock generated

File diff suppressed because it is too large Load diff

View file

@ -1,67 +1,93 @@
[package]
name = "sausagewiki"
version = "0.1.0"
authors = ["Magnus Hoff <maghoff@gmail.com>"]
description = "A wiki engine"
license = "GPL-3.0"
name = "sausagewiki"
version = "0.1.0-dev"
edition = "2018"
[profile.release]
panic = "abort"
[build-dependencies]
quote = "1.0.17"
walkdir = "1"
[build-dependencies.diesel]
default-features = false
features = ["sqlite", "chrono"]
version = "1.4.8"
[build-dependencies.diesel_migrations]
default-features = false
features = ["sqlite"]
version = "1.4.0"
[dependencies]
bart = "0.1.4"
bart_derive = "0.1.4"
bart = "0.1.6"
bart_derive = "0.1.6"
chrono = "0.4"
clap = "2.26"
clap = "2.31"
diff = "0.1"
futures = "0.1"
futures-cpupool = "0.1"
hyper = "0.11"
lazy_static = "0.2"
percent-encoding = "1.0.0"
r2d2 = "0.7"
r2d2-diesel = "0.16"
lazy_static = "1.4.0"
maplit = "1"
percent-encoding = "1.0"
r2d2 = "0.8"
r2d2-diesel = "1.0.0"
regex = "0.2"
seahash = "3.0.5"
serde = "1.0.0"
serde_derive = "1.0.0"
serde_json = "1.0"
serde_urlencoded = "0.5.0"
serde_urlencoded = "0.5.3"
slug = "0.1"
titlecase = "0.10"
tokio-io = "0.1"
tokio-proto = "0.1"
tokio-service = "0.1"
serde_plain = "0.3.0"
rand = "0.5.5"
[dependencies.libsqlite3-sys]
features = ["bundled"]
version = "*"
[dependencies.codegen]
path = "libs/codegen"
[dependencies.diesel]
default-features = false
features = ["sqlite", "chrono"]
version = "0.16"
version = "1.4.8"
[dependencies.diesel_codegen]
[dependencies.diesel_infer_schema]
default-features = false
features = ["sqlite"]
version = "0.16"
version = "1.4.0"
[dependencies.diesel_migrations]
default-features = false
features = ["sqlite"]
version = "1.4.0"
[dependencies.libsqlite3-sys]
features = ["bundled"]
version = "<0.23.0"
[dependencies.num]
default-features = false
version = "0.1"
[dependencies.pulldown-cmark]
default-features = false
git = "https://github.com/maghoff/pulldown-cmark.git"
default-features = false
[dependencies.static_resource_derive]
path = "libs/static_resource_derive"
[dev-dependencies]
indoc = "1.0.4"
matches = "0.1"
[build-dependencies]
quote = "0.3.10"
walkdir = "1"
[features]
dynamic-assets = []
[build-dependencies.diesel]
default-features = false
features = ["sqlite", "chrono"]
version = "0.16.0"
[profile]
[profile.release]
panic = "abort"
[workspace]

View file

@ -1,45 +0,0 @@
[![Build Status](https://travis-ci.org/maghoff/sausagewiki.svg?branch=master)](https://travis-ci.org/maghoff/sausagewiki)
Sausagewiki is a simple, self-contained wiki engine.
Copyright (C) 2017 Magnus Hovland Hoff <maghoff@gmail.com>
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 3 of the License, or (at your option) any later
version.
Install and run
===============
Sausagewiki aims to be simple to get up and running. It is distributed as a
single independent executable for Linux.
1. Download the latest build of `sausagewiki.xz` from <https://github.com/maghoff/sausagewiki/releases/latest>
2. Decompress: `xz -d sausagewiki.xz`
3. Set execution permission: `chmod a+x sausagewiki`
4. Run: `./sausagewiki wiki.db`
For other platforms you will presently have to build it yourself. Sausagewiki
is built like other Rust projects, with `cargo build`.
Command line arguments
----------------------
USAGE:
sausagewiki [FLAGS] [OPTIONS] <DATABASE>
FLAGS:
-h, --help Prints help information
--trust_identity Trust the value in the X-Identity header to be an authenticated username.
This only makes sense when Sausagewiki runs behind a reverse proxy which
sets this header.
-V, --version Prints version information
OPTIONS:
-p, --port <port> Sets the listening port
ARGS:
<DATABASE> Sets the database file to use
Sausagewiki will create an SQLite database file with the filename given in the
`DATABASE` parameter and open an HTTP server bound to `127.0.0.1` and the given
port number. The default port number is 8080.

View file

@ -1,3 +1,5 @@
"use strict";
function autosizeTextarea(textarea, shadow) {
shadow.style.width = textarea.clientWidth + "px";
shadow.value = textarea.value;
@ -6,46 +8,128 @@ function autosizeTextarea(textarea, shadow) {
function queryArgsFromForm(form) {
const items = [];
for (const {name, value} of form.elements) {
for (const {name, value, type, checked} of form.elements) {
if (!name) continue;
if (type === "radio" && !checked) continue;
items.push(encodeURIComponent(name) + '=' + encodeURIComponent(value));
}
return items.join('&');
}
let hasBeenOpen = false;
function isEdited(form) {
for (const {name, value, defaultValue, checked, defaultChecked} of form.elements) {
if (name && ((value !== defaultValue) || (checked !== defaultChecked))) return true;
}
return false;
}
function instantiate(templateId) {
return document.getElementById(templateId).firstElementChild.cloneNode(true);
}
function popup(dialog) {
document.body.appendChild(dialog);
dialog.querySelector(".primary").focus();
return new Promise((resolve, reject) => {
function handler(ev) {
document.body.removeChild(dialog);
resolve(ev.target.getAttribute("data-value"));
}
const buttons = dialog.querySelectorAll('.btn-row>*');
for (let i = 0; i < buttons.length; ++i)
buttons[i].addEventListener("click", handler);
});
}
function loginDialog(loginUrl) {
const dialog = instantiate("login");
dialog.querySelector("a").setAttribute("href", loginUrl);
return popup(dialog);
}
function alertAsync(message) {
const dialog = instantiate("alert");
dialog.querySelector(".message").textContent = message;
return popup(dialog);
}
function confirmDiscard() {
return popup(instantiate("confirm-discard"));
}
const state = {
hasBeenOpen: false,
saving: false,
editing: function () { return document.querySelector(".container").classList.contains('edit'); },
hasCancelUrl: function () { return document.querySelector("a.button-cancel").getAttribute('href') !== ""; }
};
function openEditor() {
const bodyElement = document.querySelector("body");
const container = document.querySelector(".container");
const rendered = container.querySelector(".rendered");
const editor = container.querySelector(".editor");
const textarea = editor.querySelector('textarea[name="body"]');
const shadow = editor.querySelector('textarea.shadow-control');
const form = editor.querySelector("form");
const cancel = editor.querySelector('.cancel');
const form = document.getElementById('article-editor');
const cancel = form.querySelector('.cancel');
const cancelButton = form.querySelector('button.button-cancel');
const cancelInteractionGroup = form.querySelector(".cancel-interaction-group");
const footer = document.querySelector("footer");
const lastUpdated = footer.querySelector(".last-updated");
textarea.style.height = rendered.clientHeight + "px";
container.classList.add('edit');
retainScrollRatio(() => {
container.classList.add('edit');
autosizeTextarea(textarea, shadow);
});
updateFormEnabledState();
autosizeTextarea(textarea, shadow);
textarea.focus();
if (hasBeenOpen) return;
hasBeenOpen = true;
if (state.hasBeenOpen) return;
state.hasBeenOpen = true;
textarea.addEventListener('input', () => autosizeTextarea(textarea, shadow));
window.addEventListener('resize', () => autosizeTextarea(textarea, shadow));
form.addEventListener("submit", function (ev) {
ev.preventDefault();
ev.stopPropagation();
function updateFormEnabledState() {
const baseEnabled = !state.saving && state.editing();
const enabled = {
cancel: baseEnabled && state.hasCancelUrl(),
};
cancelInteractionGroup.classList.remove(!enabled.cancel ? "interaction-group--root--enabled" : "interaction-group--root--disabled");
cancelInteractionGroup.classList.add(enabled.cancel ? "interaction-group--root--enabled" : "interaction-group--root--disabled");
for (const el of form.elements) {
el.disabled = !baseEnabled;
}
cancelButton.disabled = true;
// TODO: edit-link in footer?
}
function retainScrollRatio(innerFunction) {
const scrollElement = document.body.parentElement;
const savedScrollRatio = scrollElement.scrollTop / (scrollElement.scrollHeight - scrollElement.clientHeight);
innerFunction();
scrollElement.scrollTop = (scrollElement.scrollHeight - scrollElement.clientHeight) * savedScrollRatio;
}
function closeEditor() {
retainScrollRatio(() => container.classList.remove('edit'));
document.activeElement && document.activeElement.blur();
}
function doSave() {
state.saving = true;
updateFormEnabledState();
const body = queryArgsFromForm(form);
textarea.disabled = true;
fetch(
form.getAttribute("action"),
@ -58,44 +142,137 @@ function openEditor() {
credentials: "same-origin",
}
).then(response => {
if (!response.ok) throw new Error("Unexpected status code (" + response.status + ")");
// I don't know how to more precisely determine that we hit a login redirect:
const probablyLoginRedirect = response.redirected &&
(response.headers.get("content-type") !== "application/json");
return response.json();
}).then(result => {
// Update url-bar, page title and footer
window.history.replaceState(null, result.title, result.slug == "" ? "." : result.slug);
document.querySelector("title").textContent = result.title;
lastUpdated.innerHTML = result.last_updated;
lastUpdated.classList.remove("missing");
// Update body:
rendered.innerHTML = result.rendered;
// Update form:
form.elements.base_revision.value = result.revision;
for (const element of form.elements) {
element.defaultValue = element.value;
if (probablyLoginRedirect) {
return loginDialog(response.url)
.then(() => {
state.saving = false;
updateFormEnabledState();
});
}
container.classList.remove('edit');
if (!response.ok) throw new Error("Unexpected status code (" + response.status + ")");
textarea.disabled = false;
return response.json()
.then(result => {
// Update url-bar, page title, footer and cancel link
const url = result.slug == "" ? "." : result.slug;
window.history.replaceState(null, result.title, url);
cancel.setAttribute("href", url);
document.querySelector("title").textContent = result.title;
lastUpdated.innerHTML = result.last_updated;
lastUpdated.classList.remove("missing");
// Update body:
rendered.innerHTML = result.rendered;
form.elements.title.value = result.title;
shadow.value = textarea.value = result.body;
form.querySelector(`.theme-picker--option[value=${JSON.stringify(result.theme)}]`).checked = true;
bodyElement.className = `theme-${result.theme}`;
// Update form:
form.elements.base_revision.value = result.revision;
for (const element of form.elements) {
element.defaultValue = element.value;
element.defaultChecked = element.checked;
}
if (!result.conflict) {
closeEditor();
}
state.saving = false;
updateFormEnabledState();
autosizeTextarea(textarea, shadow);
if (result.conflict) {
return alertAsync("Your edit came into conflict with another change " +
"and has not been saved.\n" +
"Please resolve the merge conflict and save again.");
}
});
}).catch(err => {
textarea.disabled = false;
state.saving = false;
updateFormEnabledState();
console.error(err);
alert(err);
return alertAsync(err.toString());
});
}
function doCancel() {
Promise.resolve(!isEdited(form) || confirmDiscard())
.then(doReset => {
if (doReset) {
closeEditor();
updateFormEnabledState();
form.reset();
let selectedTheme = form.querySelector(`.theme-picker--option[checked]`).value;
bodyElement.className = `theme-${selectedTheme}`;
}
});
}
form.addEventListener("submit", function (ev) {
ev.preventDefault();
ev.stopPropagation();
doSave();
});
cancel.addEventListener('click', function (ev) {
ev.preventDefault();
ev.stopPropagation();
container.classList.remove('edit');
form.reset();
doCancel();
});
window.addEventListener("beforeunload", function (ev) {
if (isEdited(form)) {
ev.preventDefault();
return ev.returnValue = "Discard changes?";
}
});
document.addEventListener("keypress", function (ev) {
const accel = ev.ctrlKey || ev.metaKey; // Imprecise, but works cross platform
if (ev.key === "Enter" && accel) {
if (!state.editing()) return;
ev.stopPropagation();
ev.preventDefault();
doSave();
}
});
const themeOptions = form.querySelectorAll(".theme-picker--option");
for (let themeOption of themeOptions) {
themeOption.addEventListener("click", function (ev) {
bodyElement.className = `theme-${ev.target.value}`;
});
}
}
function initializeTheme() {
const form = document.getElementById('article-editor');
let preSelectedTheme = form.querySelector(`.theme-picker--option[checked]`);
if (preSelectedTheme) return;
let themes = form.querySelectorAll(`.theme-picker--option`);
let randomThemeId = (Math.random() * themes.length) | 0;
let theme = themes[randomThemeId];
theme.defaultChecked = theme.checked = true;
document.querySelector("body").className = `theme-${theme.value}`;
}
initializeTheme();
document
.getElementById("openEditor")
.addEventListener("click", function (ev) {

View file

@ -18,11 +18,17 @@ function debouncer(interval, callback) {
const results = form.querySelector('.live-results');
const resultPrototype = document.getElementById('search-result-prototype').firstChild;
function clearChildren(element) {
while (element.lastChild) {
element.removeChild(results.lastChild);
}
}
let ongoing = false;
function submit() {
if (input.value === "") {
results.classList.remove("show");
while (results.lastChild) results.removeChild(results.lastChild);
clearChildren(results);
return;
}
@ -31,7 +37,7 @@ function debouncer(interval, callback) {
const query = input.value;
fetch(
"_search?snippet_size=4&limit=4&q=" + encodeURIComponent(query),
"_search?snippet_size=14&limit=4&q=" + encodeURIComponent(query),
{
headers: {
"Accept": "application/json",
@ -43,14 +49,14 @@ function debouncer(interval, callback) {
return response.json();
}).then(result => {
while (results.lastChild) results.removeChild(results.lastChild);
clearChildren(results);
result.hits.forEach((hit, index) => {
const item = resultPrototype.cloneNode(true);
item.querySelector('.link').href = hit.slug || ".";
item.querySelector('.link').setAttribute("data-focusindex", index + 1);
item.querySelector('.title').textContent = hit.title;
item.querySelector('.snippet').textContent = hit.snippet;
item.querySelector('.snippet').innerHTML = hit.snippet;
results.appendChild(item);
})
@ -68,9 +74,18 @@ function debouncer(interval, callback) {
ongoing = false;
}).catch(err => {
ongoing = false;
console.error(err);
alert(err); // TODO Better interactive error reporting
clearChildren(results);
results.classList.add("show");
const item = document.createElement("li");
item.classList.add("search-result");
item.classList.add("error");
item.textContent = "Live search unavailable";
results.appendChild(item);
ongoing = false;
});
}
const submitter = debouncer(300, submit);

View file

@ -1,15 +1,11 @@
@font-face {
font-family: 'Amatic SC';
font-style: normal;
font-weight: 400;
src: local('Amatic SC Regular'), local('AmaticSC-Regular'),
url('amatic-sc-v9-latin-regular.woff') format('woff');
}
.prototype {
display: none;
}
input {
margin: 0; /* reset for Safari */
}
html {
font-family: "Apple Garamond", "Baskerville",
"Times New Roman", "Droid Serif", "Times",
@ -17,8 +13,6 @@ html {
}
h1 {
font-family: 'Amatic SC', sans-serif;
font-weight: normal;
font-style: normal;
@ -31,7 +25,7 @@ article h1 {
margin-bottom: 0;
}
h2, h3 {
h2, h3, h4, h5, h6 {
font-family: inherit;
font-size: 18px;
line-height: 32px;
@ -49,25 +43,31 @@ h3 {
font-style: italic;
}
h4, h5, h6 {
font-weight: normal;
font-style: normal;
}
article ul, article ol {
padding-left: 32px;
}
h1+*, h2+*, h3+* {
h1+*, h2+*, h3+*, h4+*, h5+*, h6+* {
margin-top: 0;
}
article>hr {
border: none;
border-top: 1px solid black;
max-width: 400px;
width: 70%;
border-top: 6px solid var(--theme-main);
width: 40px;
margin: 20px auto;
}
.notice {
background: lightyellow;
padding: 16px 48px;
background: var(--theme-main);
color: var(--theme-text);
padding: 1px 24px;
font-size: 18px;
line-height: 32px;
@ -76,6 +76,22 @@ article>hr {
width: 100%;
margin: 30px auto;
}
.notice a {
color: var(--theme-link);
}
.hero {
background: var(--theme-main);
color: var(--theme-text);
/* Hack to force containing the children instead of collapsing marigins */
border: 1px solid var(--theme-main);
}
.search-container {
background: var(--theme-main);
color: var(--theme-text);
}
header, article>*, .search {
box-sizing: border-box;
@ -92,7 +108,7 @@ header {
}
article {
margin: 0 auto 120px auto;
margin: 50px auto 120px auto;
font-size: 18px;
line-height: 32px;
@ -143,7 +159,19 @@ pre {
}
a {
color: #457796;
color: #1976D2;
text-decoration: none;
}
a[href^="http"]::after {
display: inline-block;
padding: 0 0.1rem;
font-size: 75%;
content: "🔗";
line-height: 0;
}
a[href^="http"]:hover::after {
text-decoration: none;
}
@ -177,10 +205,10 @@ body {
footer {
padding: 0 8px;
padding: 16px 8px 16px 8px;
background: #f8f8f8;
color: #444;
background: var(--theme-main);
color: var(--theme-text);
text-align: center;
font-family: -apple-system, BlinkMacSystemFont,
"Segoe UI", "Roboto", "Oxygen",
@ -188,6 +216,10 @@ footer {
"Droid Sans", "Helvetica Neue", sans-serif;
}
footer a {
color: var(--theme-link);
}
ul.dense {
list-style: none;
padding: 0;
@ -243,6 +275,11 @@ h1>input {
width: 100%;
}
.hero input {
background: var(--theme-input);
color: var(--theme-text);
}
.shadow-control {
visibility: hidden;
position: fixed;
@ -272,18 +309,163 @@ h1>input {
bottom: 0;
left: 0;
background: #91A238;
padding: 10px 20px;
box-sizing: border-box;
text-align: right;
box-shadow: 0px 5px 20px rgba(0,0,0, 0.2);
background: white;
color: var(--theme-text);
padding: 10px 10px;
transform: translate(0, 65px);
transition: transform 100ms;
transition-timing-function: linear;
pointer-events: none;
}
@media (min-width: 630px) {
.editor-controls {
position: fixed;
left: auto;
right: 20px;
bottom: 20px;
.edit .editor-controls {
transform: translate(0, 0);
transition-timing-function: cubic-bezier(.17,.84,.44,1);
box-shadow: 2px 2px 8px rgba(0,0,0, 0.25);
pointer-events: unset;
}
.theme-picker {
position: absolute;
top: 0;
left: 0;
right: 0;
display: flex;
}
.theme-picker--option {
/* reset */
-webkit-appearance: none;
-moz-appearance: none;
-o-appearance: none;
-ms-appearance: none;
appearance: none;
border: none;
border-radius: 0;
margin: 0;
padding: 0;
height: 20px;
background: var(--theme-main);
color: var(--theme-text);
flex-grow: 1;
position: relative;
}
.theme-picker--option:checked::after {
content: " ";
display: block;
background: white;
border-radius: 5px;
width: 10px;
height: 10px;
position: absolute;
top: calc(50% - 5px);
left: calc(50% - 5px);
}
.button {
border-radius: 2px;
display: inline-block;
width: 120px;
text-align: center;
border: none;
cursor: pointer;
font-family: -apple-system, BlinkMacSystemFont,
"Segoe UI", "Roboto", "Oxygen",
"Ubuntu", "Cantarell", "Fira Sans",
"Droid Sans", "Helvetica Neue", sans-serif;
font-size: 16px;
line-height: 20px;
padding: 10px 0px;
margin-left: 10px;
}
.button[disabled] {
opacity: 0.5;
cursor: default;
}
.button:hover {
text-decoration: none;
}
.button:not([disabled]):hover, .button:not([disabled]):active {
background: var(--button-alt);
}
.button-cancel {
background: white;
color: var(--theme-main);
--button-alt: #f0f0f0;
}
.button-default {
background: var(--theme-main);
color: var(--theme-text);
--button-alt: var(--theme-input);
}
.cancel-interaction-group {
display: inline;
}
.interaction-group--root--enabled .interaction-group--disabled {
display: none;
}
.interaction-group--root--disabled .interaction-group--enabled {
display: none;
}
@media (min-width: 960px) {
/* min-width is calculated like this:
body-width = width of the main text column
controls-width = width of .editor-controls element, including drop-shadow
min-width = body-width + 2*controls-width = 600 + 2 * 180 = 960
*/
.editor-controls {
border-radius: 2px;
position: fixed;
left: calc(50% + 320px);
width: 140px;
top: calc(50% - 55px);
height: 110px;
padding: 10px;
transform: translate(20px, 0);
opacity: 0;
transition: transform 100ms, opacity 100ms;
transition-timing-function: linear;
}
.edit .editor-controls {
transform: translate(0, 0);
transition-timing-function: cubic-bezier(.17,.84,.44,1);
opacity: 1;
}
.button {
margin: 0;
margin-bottom: 10px;
}
}
@ -300,9 +482,6 @@ article ul.search-results {
.search-result .title {
font-weight: bold;
}
.snippet {
white-space: pre-line;
}
.search-result p {
margin: 0;
}
@ -311,18 +490,18 @@ article ul.search-results {
display: block;
color: inherit;
text-decoration: none;
border: 1px solid #ccc;
padding: 8px;
padding: 8px 16px;
background: white;
color: black;
}
.search-result a:hover, .search-result a:focus {
background: #0074D9;
border-color: #0074D9;
color: white;
background: var(--theme-main);
color: var(--theme-text);
}
.search {
text-align: center;
margin-top: 30px;
margin-top: 45px;
position: relative;
}
@ -331,16 +510,18 @@ input[type="search"]::-webkit-search-decoration {
}
input[type="search"] {
-webkit-appearance: textfield;
-webkit-appearance: none;
border-radius: 0;
box-sizing: border-box;
width: 100%;
max-width: 300px;
transition: max-width 200ms;
padding: 0 16px;
margin: 0;
border: 1px solid #ccc;
border: none;
background: var(--theme-input);
color: var(--theme-text);
font: inherit;
font-size: 18px;
@ -348,13 +529,12 @@ input[type="search"] {
line-height: 32px;
height: 34px;
border-radius: 18px;
text-overflow: ellipsis;
}
.search input:focus, .search.focus input {
max-width: 300px;
border-color: #999;
input[type="search"]::placeholder, .hero input::placeholder {
color: var(--theme-text);
opacity: 0.6;
}
.search .live-results {
@ -362,9 +542,8 @@ input[type="search"] {
box-sizing: border-box;
width: 100%;
max-width: 266px; /* 300px - padding - border */
max-width: 300px;
background: white;
padding: 0;
margin: 0 auto;
@ -374,6 +553,15 @@ input[type="search"] {
max-height: 0px;
}
.search-widget-container {
border-radius: 2px;
overflow: hidden;
width: 100%;
max-width: 300px;
display: inline-block;
}
.live-results.show {
max-height: 500px;
}
@ -381,23 +569,33 @@ input[type="search"] {
.live-results .search-result {
margin: 0;
}
.live-results a {
border-top: none;
.live-results .search-result.error {
padding: 8px;
color: #888;
}
@media (min-width: 630px) {
.search {
text-align: right;
height: 38px;
position: relative;
}
.search input {
max-width: 125px;
.search-widget-container {
position: absolute;
right: 8px;
width: 300px;
box-shadow: 0 0 0 rgba(0,0,0,0.2);
transition: all 0.2s ease-in-out;
}
.focus .search-widget-container {
box-shadow: 0 5px 20px rgba(0,0,0,0.2);
}
.search .live-results {
position: absolute;
right: 8px;
margin: 0 16px;
width: 100%;
max-height: 0px;
}
@ -405,3 +603,146 @@ input[type="search"] {
max-height: 500px;
}
}
.diff {
background: none;
white-space: pre-wrap;
}
.removed {
color: #866;
background: #fdd;
text-decoration: line-through;
}
.added {
background: #ceb;
}
.modal-block {
position: fixed;
left: 0;
right: 0;
top: 0;
bottom: 0;
background: rgba(0, 0, 0, 0.6);
display: flex;
align-items: center;
justify-content: center;
}
.popup {
display: flex;
flex-direction: column;
text-align: center;
background: #eee;
box-shadow: 0px 5px 20px rgba(0,0,0, 0.2);
}
.popup>.message {
margin: 16px 32px;
max-width: 600px;
}
.popup>.btn-row {
display: flex;
flex-direction: row;
font-family: -apple-system, BlinkMacSystemFont,
"Segoe UI", "Roboto", "Oxygen",
"Ubuntu", "Cantarell", "Fira Sans",
"Droid Sans", "Helvetica Neue", sans-serif;
}
.btn-row>* {
padding: 8px 16px;
margin: 0;
background: white;
color: black;
border: none;
border-radius: 0;
flex: 1;
font-family: inherit;
cursor: pointer;
}
.btn-row>*:hover {
text-decoration: underline;
}
.primary {
background: #337ab7;
color: white;
}
@media print {
@page {
margin: 25mm;
}
html, body {
height: unset;
}
body {
display: block;
}
.hero {
background: none;
color: initial;
/* Disable hack to force containing the children instead of collapsing marigins */
border: none;
}
h1, h2, h3, h4, h5, h6 {
/* This doesn't work at all, but it might start to! */
break-after: avoid;
page-break-after: avoid;
}
a, a:visited, a:hover, a:visited:hover {
text-decoration: none;
color: black !important;
font-weight: normal !important;
}
a[href^="http"]::after {
display: none;
}
article {
margin: 0 auto;
}
article>hr {
border-color: black;
}
h1 {
font-size: 22pt;
line-height: 33pt;
}
article, h2, h3, h4, h5, h6, .notice {
font-size: 12pt;
line-height: 18pt;
}
article p {
text-align: justify;
}
pre {
overflow: visible;
white-space: pre-wrap;
}
.search {
display: none;
}
footer {
display: none;
}
}

54
assets/test-themes.html Normal file
View file

@ -0,0 +1,54 @@
<!DOCTYPE html>
<html>
<head>
<title>Test themes &ndash; Sausagewiki</title>
<link href="themes.css" rel="stylesheet">
<link href="style.css" rel="stylesheet">
<style>
.themed {
padding: 10px;
background: var(--theme-main);
color: var(--theme-text);
}
.link {
color: var(--theme-link);
}
.proto {
display: none;
}
#bar {
display: flex;
width: 100%;
}
#bar>div {
height: 30px;
flex-grow: 1;
}
</style>
</head>
<body>
<div id="bar"></div>
<div class="proto">
<div class="themed">The <span class="link">quick</span> brown <span class="link">dog</span> jumps over the lazy log <span class="theme-name"></span></div>
<div class="themed"><input type=search placeholder=placeholder> <input type=search value="Bacon"></div>
</div>
<script>
const themes = ["red", "pink", "purple", "deep-purple", "indigo", "blue", "light-blue", "cyan", "teal", "green", "light-green", "lime", "yellow", "amber", "orange", "deep-orange", "brown", "gray", "blue-gray"];
const body = document.querySelector("body");
const proto = document.querySelector(".proto");
for (theme of themes) {
const block = proto.cloneNode(true);
block.className = `theme-${theme}`;
block.querySelector(".theme-name").textContent = theme;
body.appendChild(block);
}
const bar = document.querySelector("#bar");
for (theme of themes) {
const block = document.createElement("div");
block.className = `theme-${theme} themed`;
bar.appendChild(block);
}
</script>
</body>
</html>

134
assets/themes.css Normal file
View file

@ -0,0 +1,134 @@
.theme-red {
--theme-main: #F44336;
--theme-text: white;
--theme-input: #E57373;
--theme-link: #FFF59D;
}
.theme-pink {
--theme-main: #E91E63;
--theme-text: white;
--theme-input: #F06292;
--theme-link: #FFF59D;
}
.theme-purple {
--theme-main: #9C27B0;
--theme-text: white;
--theme-input: #BA68C8;
--theme-link: #90CAF9;
}
.theme-deep-purple {
--theme-main: #673AB7;
--theme-text: white;
--theme-input: #9575CD;
--theme-link: #90CAF9;
}
.theme-indigo {
--theme-main: #3F51B5;
--theme-text: white;
--theme-input: #7986CB;
--theme-link: #90CAF9;
}
.theme-blue {
--theme-main: #2196F3;
--theme-text: white;
--theme-input: #64B5F6;
--theme-link: #90CAF9;
}
.theme-light-blue {
--theme-main: #03A9F4;
--theme-text: white;
--theme-input: #4FC3F7;
--theme-link: #90CAF9;
}
.theme-cyan {
--theme-main: #00ACC1;
--theme-text: white;
--theme-input: #26C6DA;
--theme-link: #90CAF9;
}
.theme-teal {
--theme-main: #009688;
--theme-text: white;
--theme-input: #4DB6AC;
--theme-link: #90CAF9;
}
.theme-green {
--theme-main: #4CAF50;
--theme-text: white;
--theme-input: #81C784;
--theme-link: #90CAF9;
}
.theme-light-green {
--theme-main: #7CB342;
--theme-text: white;
--theme-input: #9CCC65;
--theme-link: #90CAF9;
}
.theme-lime {
--theme-main: #C0CA33;
--theme-text: white;
--theme-input: #AFB42B;
--theme-link: #1976D2;
}
.theme-yellow {
--theme-main: #FDD835;
--theme-text: white;
--theme-input: #FBC02D;
--theme-link: #1976D2;
}
.theme-amber {
--theme-main: #FFB300;
--theme-text: white;
--theme-input: #FFA000;
--theme-link: #1976D2;
}
.theme-orange {
--theme-main: #FB8C00;
--theme-text: white;
--theme-input: #FFA726;
--theme-link: #FFF59D;
}
.theme-deep-orange {
--theme-main: #FF5722;
--theme-text: white;
--theme-input: #FF8A65;
--theme-link: #FFF59D;
}
.theme-brown {
--theme-main: #795548;
--theme-text: white;
--theme-input: #A1887F;
--theme-link: #FFF59D;
}
.theme-gray {
--theme-main: #9E9E9E;
--theme-text: white;
--theme-input: #E0E0E0;
--theme-link: #90CAF9;
}
.theme-blue-gray {
--theme-main: #607D8B;
--theme-text: white;
--theme-input: #90A4AE;
--theme-link: #90CAF9;
}

View file

@ -1,48 +1,77 @@
#[macro_use] extern crate quote;
#[macro_use]
extern crate diesel;
extern crate walkdir;
use diesel::Connection;
use diesel::prelude::*;
use diesel::Connection;
use quote::quote;
use std::env;
use std::fs::File;
use std::io::prelude::*;
use std::path::Path;
use walkdir::WalkDir;
#[allow(dead_code)]
mod sqlfunc {
use diesel::sql_types::Text;
sql_function!(fn markdown_to_fts(text: Text) -> Text);
sql_function!(fn theme_from_str_hash(text: Text) -> Text);
}
fn main() {
let out_dir = env::var("OUT_DIR").expect("cargo must set OUT_DIR");
let db_path = Path::new(&out_dir).join("build.db");
let db_path = db_path.to_str().expect("Will only work for Unicode-representable paths");
let db_path = db_path
.to_str()
.expect("Will only work for Unicode-representable paths");
let _ignore_failure = std::fs::remove_file(db_path);
let connection = SqliteConnection::establish(db_path)
.expect(&format!("Error esablishing a database connection to {}", db_path));
.unwrap_or_else(|_| panic!("Error esablishing a database connection to {}", db_path));
// Integer is a dummy placeholder. Compiling fails when passing ().
diesel::expression::sql_literal::sql::<(diesel::types::Integer)>("PRAGMA foreign_keys = ON")
diesel::expression::sql_literal::sql::<diesel::sql_types::Integer>("PRAGMA foreign_keys = ON")
.execute(&connection)
.expect("Should be able to enable foreign keys");
diesel::migrations::run_pending_migrations(&connection).unwrap();
sqlfunc::markdown_to_fts::register_impl(&connection, |_: String| -> String { unreachable!() })
.unwrap();
sqlfunc::theme_from_str_hash::register_impl(&connection, |_: String| -> String {
unreachable!()
})
.unwrap();
diesel_migrations::run_pending_migrations(&connection).unwrap();
let infer_schema_path = Path::new(&out_dir).join("infer_schema.rs");
let mut file = File::create(infer_schema_path).expect("Unable to open file for writing");
file.write_all(quote! {
mod __diesel_infer_schema_articles {
infer_table_from_schema!(#db_path, "articles");
}
pub use self::__diesel_infer_schema_articles::*;
file.write_all(
quote! {
mod __diesel_infer_schema_articles {
infer_table_from_schema!(#db_path, "articles");
}
pub use self::__diesel_infer_schema_articles::*;
mod __diesel_infer_schema_article_revisions {
infer_table_from_schema!(#db_path, "article_revisions");
mod __diesel_infer_schema_article_revisions {
infer_table_from_schema!(#db_path, "article_revisions");
}
pub use self::__diesel_infer_schema_article_revisions::*;
}
pub use self::__diesel_infer_schema_article_revisions::*;
}.as_str().as_bytes()).expect("Unable to write to file");
.to_string()
.as_bytes(),
)
.expect("Unable to write to file");
for entry in WalkDir::new("migrations").into_iter().filter_map(|e| e.ok()) {
for entry in WalkDir::new("migrations")
.into_iter()
.filter_map(|e| e.ok())
{
println!("cargo:rerun-if-changed={}", entry.path().display());
}
// For build_config.rs
for env_var in &["CONTINUOUS_INTEGRATION", "TRAVIS_BRANCH", "TRAVIS_COMMIT"] {
println!("cargo:rerun-if-env-changed={}", env_var);
}
}

4
contributing.md Normal file
View file

@ -0,0 +1,4 @@
Thank you for your interest in contributing to Sausagewiki!
The high level design of Sausagewiki is described in [DESIGN.md](DESIGN.md).
Please consider your contribution in light of this document.

View file

@ -4,3 +4,5 @@ This is a list of people who have contributed to this project.
- Magnus Hoff (maghoff@gmail.com)
- Johannes Hoff (johanneshoff@gmail.com)
- Konstantin Yegupov (kyegupov4@gmail.com)
- cmal (paul@cmal.info)

16
deploy/sausagewiki.rb Normal file
View file

@ -0,0 +1,16 @@
class Sausagewiki < Formula
desc "A simple, self-contained Wiki engine"
homepage "https://github.com/maghoff/sausagewiki/"
head "https://github.com/maghoff/sausagewiki.git"
depends_on "rust" => :build
def install
system "cargo", "build", "--release"
bin.install "target/release/sausagewiki"
end
test do
system "#{bin}/sausagewiki", "--version"
end
end

42
design.md Normal file
View file

@ -0,0 +1,42 @@
Sausagewiki is a simple, self-contained wiki engine. This is not merely a
description, but in fact design goals. Let's look closer at them.
Sausagewiki is simple
=====================
Sausagewiki is somewhat feature sparse. Of course, implementing features takes
time and effort, but that is not all. Sausagewiki attempts to attain
simplicity in part by being very restrictive with which features to add. Which
features belong in Sausagewiki? That is hard to pin down. There are many
features that could be included in a simple wiki engine, but it is probably
true that including _all_ those features would make the engine no longer
simple. Because of this, Sausagewiki is extremely restrictive with which
features to add.
Sausagewiki is simple to use. The user interface is clean and simple. The wiki
language is small and easy to fully grasp. For example: In order to keep the
wiki syntax small and easy, the inline HTML feature of Markdown has been
excluded. It would make the wiki syntax too large.
The executable has few command line options. It is easy for the system
administrator to get up and running correctly. As a user you can also be sure
that Sausagewiki is the same when using it in different places.
Sausagewiki is self-contained
=============================
The binary does not have runtime dependencies. It does not dynamically link
with any library. (This is true for Linux. For other systems it needs to link
to the C standard library) It does not require any other program during
run time, and it does not require any resource file external to the
Sausagewiki binary.
Sausagewiki has no configuration file. This is sensible only as long as it
also has very few command line options.
The data for a given wiki instance is contained in one file only. This makes
a wiki instance easy to back up, copy and move.
Sausagewiki is a wiki engine
============================
The user experience is geared towards collaborative editing rather than a
division between editors and readers. Sausagewiki aims for a low barrier to
entry; new readers should feel invited to edit the text if appropriate.

View file

@ -1,14 +1,17 @@
[package]
name = "static_resource_derive"
name = "codegen"
version = "0.1.0"
authors = ["Magnus Hoff <maghoff@gmail.com>"]
license = "GPL-3.0"
[dependencies]
quote = "0.3.10"
syn = "0.10.5"
sha2 = "0.6"
base64 = "0.6"
quote = "0.3.10"
serde = "1.0.0"
serde_derive = "1.0.0"
serde_json = "1.0"
sha2 = "0.6"
syn = "0.10.5"
[lib]
proc-macro = true

27
libs/codegen/src/lib.rs Normal file
View file

@ -0,0 +1,27 @@
#![recursion_limit = "128"]
#[macro_use]
extern crate quote;
#[macro_use]
extern crate serde_derive;
extern crate base64;
extern crate proc_macro;
extern crate serde;
extern crate serde_json;
extern crate sha2;
extern crate syn;
use proc_macro::TokenStream;
mod licenses;
mod static_resource;
#[proc_macro_derive(StaticResource, attributes(filename, mime))]
pub fn static_resource(input: TokenStream) -> TokenStream {
static_resource::static_resource(input)
}
#[proc_macro_derive(Licenses)]
pub fn licenses(input: TokenStream) -> TokenStream {
licenses::licenses(input)
}

View file

@ -0,0 +1,105 @@
use std::fs::File;
use proc_macro::TokenStream;
use quote;
use serde::de::IgnoredAny;
use serde_json;
const SOURCES: &[&str] = &["src/licenses/license-hound.json", "src/licenses/other.json"];
#[derive(Debug, Copy, Clone, Deserialize)]
pub enum LicenseId {
Bsd3Clause,
Mit,
Mpl2,
Ofl11,
}
impl LicenseId {
fn include_notice(&self) -> bool {
use self::LicenseId::*;
match self {
Mpl2 => false,
_ => true,
}
}
}
impl quote::ToTokens for LicenseId {
fn to_tokens(&self, tokens: &mut quote::Tokens) {
use self::LicenseId::*;
tokens.append(match self {
Bsd3Clause => "Bsd3Clause",
Mit => "Mit",
Mpl2 => "Mpl2",
Ofl11 => "Ofl11",
});
}
}
#[derive(Debug, Deserialize)]
struct LicenseDescription {
chosen_license: LicenseId,
copyright_notice: String,
link: Option<String>,
}
#[derive(Debug, Deserialize)]
struct LicenseReport {
package_name: String,
conclusion: Result<LicenseDescription, IgnoredAny>,
}
impl quote::ToTokens for LicenseReport {
fn to_tokens(&self, tokens: &mut quote::Tokens) {
let c: &LicenseDescription = self.conclusion.as_ref().unwrap();
let (name, link, copyright, license) = (
&self.package_name,
&c.link,
&c.copyright_notice,
&c.chosen_license,
);
let link = match *link {
Some(ref link) => quote! { Some(#link) },
None => quote! { None },
};
let copyright = match license.include_notice() {
true => copyright,
false => "",
};
tokens.append(quote! {
LicenseInfo {
name: #name,
link: #link,
copyright: #copyright,
license: License::#license,
}
});
}
}
pub fn licenses(_input: TokenStream) -> TokenStream {
let mut license_infos = SOURCES
.iter()
.map(|x| -> Vec<LicenseReport> { serde_json::from_reader(File::open(x).unwrap()).unwrap() })
.map(|x| x.into_iter().filter(|x| x.conclusion.is_ok()))
.fold(vec![], |mut a, b| {
a.extend(b);
a
});
license_infos.sort_unstable_by_key(|x| x.package_name.to_lowercase());
let gen = quote! {
lazy_static! {
static ref LICENSE_INFOS: &'static [LicenseInfo] = &[
#(#license_infos,)*
];
}
};
gen.parse().unwrap()
}

View file

@ -1,63 +1,64 @@
#![recursion_limit="128"]
#[macro_use] extern crate quote;
extern crate base64;
extern crate proc_macro;
extern crate sha2;
extern crate syn;
use proc_macro::TokenStream;
use std;
use std::fs::File;
use std::io::prelude::*;
use std::path::{Path, PathBuf};
use proc_macro::TokenStream;
use syn;
fn user_crate_root() -> PathBuf {
std::env::current_dir().expect("Unable to get current directory")
}
fn find_attr<'a>(attrs: &'a Vec<syn::Attribute>, name: &str) -> Option<&'a str> {
attrs.iter()
fn find_attr<'a>(attrs: &'a [syn::Attribute], name: &str) -> Option<&'a str> {
attrs
.iter()
.find(|&x| x.name() == name)
.and_then(|ref attr| match &attr.value {
&syn::MetaItem::NameValue(_, syn::Lit::Str(ref template, _)) => Some(template),
_ => None
.and_then(|attr| match attr.value {
syn::MetaItem::NameValue(_, syn::Lit::Str(ref template, _)) => Some(template),
_ => None,
})
.map(|x| x.as_ref())
}
fn buf_file<P: AsRef<Path>>(filename: P) -> Vec<u8> {
let mut f = File::open(filename)
.expect("Unable to open file for reading");
let mut f = File::open(filename).expect("Unable to open file for reading");
let mut buf = Vec::new();
f.read_to_end(&mut buf)
.expect("Unable to read file");
f.read_to_end(&mut buf).expect("Unable to read file");
buf
}
fn calculate_checksum<P: AsRef<Path>>(filename: P) -> String {
use base64::*;
use sha2::{Sha256, Digest};
use sha2::{Digest, Sha256};
encode_config(&Sha256::digest(&buf_file(filename)), URL_SAFE)
}
#[proc_macro_derive(StaticResource, attributes(filename, mime))]
pub fn static_resource(input: TokenStream) -> TokenStream {
let s = input.to_string();
let ast = syn::parse_macro_input(&s).unwrap();
let filename = find_attr(&ast.attrs, "filename")
.expect("The `filename` attribute must be specified");
let filename =
find_attr(&ast.attrs, "filename").expect("The `filename` attribute must be specified");
let abs_filename = user_crate_root().join(filename);
let abs_filename = abs_filename.to_str().expect("Absolute file path must be valid Unicode");
let abs_filename = abs_filename
.to_str()
.expect("Absolute file path must be valid Unicode");
let checksum = calculate_checksum(&abs_filename);
let mime = find_attr(&ast.attrs, "mime")
.expect("The `mime` attribute must be specified");
let path: &Path = filename.as_ref();
let resource_name = format!(
"{}-{}.{}",
path.file_stem().unwrap().to_str().unwrap(),
checksum,
path.extension().unwrap().to_str().unwrap()
);
let mime = find_attr(&ast.attrs, "mime").expect("The `mime` attribute must be specified");
let name = &ast.ident;
let (impl_generics, ty_generics, where_clause) = ast.generics.split_for_impl();
@ -97,12 +98,12 @@ pub fn static_resource(input: TokenStream) -> TokenStream {
}
impl #impl_generics #name #ty_generics #where_clause {
pub fn checksum() -> &'static str {
#checksum
pub fn resource_name() -> &'static str {
#resource_name
}
pub fn etag() -> ::hyper::header::EntityTag {
::hyper::header::EntityTag::new(false, Self::checksum().to_owned())
::hyper::header::EntityTag::new(false, #checksum.to_owned())
}
}
};

View file

@ -0,0 +1,24 @@
DROP TRIGGER article_revisions_ai;
DROP TRIGGER article_revisions_ad;
DROP TRIGGER article_revisions_au_disable;
DROP TRIGGER article_revisions_au_enable;
CREATE TRIGGER article_revisions_ai AFTER INSERT ON article_revisions WHEN new.latest = 1 BEGIN
DELETE FROM article_search WHERE rowid = new.article_id;
INSERT INTO article_search(rowid, title, body, slug) VALUES (new.article_id, new.title, markdown_to_fts(new.body), new.slug);
END;
CREATE TRIGGER article_revisions_ad AFTER DELETE ON article_revisions WHEN old.latest = 1 BEGIN
DELETE FROM article_search WHERE rowid = old.article_id;
END;
-- Index unique_latest_revision_per_article_id makes sure the following is sufficient:
CREATE TRIGGER article_revisions_au_disable AFTER UPDATE ON article_revisions WHEN old.latest = 1 AND new.latest = 0 BEGIN
DELETE FROM article_search WHERE rowid = old.article_id;
END;
CREATE TRIGGER article_revisions_au_enable AFTER UPDATE ON article_revisions WHEN old.latest = 0 AND new.latest = 1 BEGIN
INSERT INTO article_search(rowid, title, body, slug) VALUES (new.article_id, new.title, markdown_to_fts(new.body), new.slug);
END;
DELETE FROM article_search;
INSERT INTO article_search(title, body, slug)
SELECT title, markdown_to_fts(body), slug FROM article_revisions WHERE latest = 1;

View file

@ -0,0 +1,7 @@
ALTER TABLE article_revisions ADD COLUMN theme TEXT NOT NULL CHECK (theme IN (
'red', 'pink', 'purple', 'deep-purple', 'indigo', 'blue', 'light-blue',
'cyan', 'teal', 'green', 'light-green', 'lime', 'yellow', 'amber',
'orange', 'deep-orange', 'brown', 'gray', 'blue-gray'
)) DEFAULT 'red';
UPDATE article_revisions SET theme=theme_from_str_hash(title);

75
readme.md Normal file
View file

@ -0,0 +1,75 @@
[![Build Status](https://travis-ci.org/maghoff/sausagewiki.svg?branch=master)](https://travis-ci.org/maghoff/sausagewiki)
Sausagewiki is a simple, self-contained wiki engine.
Copyright (C) 2017 Magnus Hovland Hoff <maghoff@gmail.com>
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 3 of the License, or (at your option) any later
version.
Features
========
Some features of Sausagewiki, in no particular order:
* Simple to [install and run](#install-and-run), no runtime dependencies
* Reasonable to [back up](https://github.com/maghoff/sausagewiki/wiki/Backup),
there is only one data file
* Can be reverse proxied behind any path without configuration
* Snappy, light resource usage
* Markdown syntax
* Plus [table-support](https://help.github.com/articles/organizing-information-with-tables/)
* Without embedded HTML
* Full text search
* Responsive design: fits different screens as well as print
* Progressive enhancement: works with or without JavaScript
* Works with [external authentication](https://github.com/maghoff/sausagewiki/wiki/Enabling-authentication)
Install and run
===============
Sausagewiki aims to be simple to get up and running. It is distributed as a
single independent executable for Linux:
1. Download the latest build of `sausagewiki.tar.xz` from <https://github.com/maghoff/sausagewiki/releases/latest>
2. Decompress: `tar Jxf sausagewiki.tar.xz`, it decompresses to the single
Linux executable `sausagewiki`
3. Run: `./sausagewiki wiki.db`
For a more permanent installation, you could [install Sausagewiki as a systemd
service](https://github.com/maghoff/sausagewiki/wiki/System-wide-installation-with-systemd).
Alternative installation methods include the following:
**Build from source** with `cargo build --release`, producing the binary as
`target/release/sausagewiki`. This requires you to have a working installation
of [rust](https://www.rust-lang.org/en-US/).
**Install with [Homebrew](https://brew.sh/)** on OS X/macOS:
`brew install --HEAD https://raw.githubusercontent.com/maghoff/sausagewiki/master/deploy/sausagewiki.rb`
(Some users are hitting [rust issue #39870](https://github.com/rust-lang/rust/issues/39870)
with this brew formula, even though it is supposed to have been fixed)
Command line arguments
----------------------
USAGE:
sausagewiki [FLAGS] [OPTIONS] <DATABASE>
FLAGS:
-h, --help Prints help information
--trust-identity Trust the value in the X-Identity header to be an authenticated username.
This only makes sense when Sausagewiki runs behind a reverse proxy which
sets this header.
-V, --version Prints version information
OPTIONS:
-a, --address <address> Sets the IP address to bind to [default: 127.0.0.1]
-p, --port <port> Sets the listening port [default: 8080]
ARGS:
<DATABASE> Sets the database file to use
Sausagewiki will create an SQLite database file with the filename given in the
`DATABASE` parameter and open an HTTP server bound to the configured address,
`<address>:<port>`.

View file

@ -1,24 +1,90 @@
use futures::Future;
use web::{Resource, ResponseFuture};
#[cfg(not(feature = "dynamic-assets"))]
mod static_assets {
use crate::web::{Resource, ResponseFuture};
use futures::Future;
use std::collections::HashMap;
#[derive(StaticResource)]
#[filename = "assets/style.css"]
#[mime = "text/css"]
pub struct StyleCss;
// The CSS should be built to a single CSS file at compile time
#[derive(StaticResource)]
#[filename = "assets/themes.css"]
#[mime = "text/css"]
pub struct ThemesCss;
#[derive(StaticResource)]
#[filename = "assets/script.js"]
#[mime = "application/javascript"]
pub struct ScriptJs;
#[derive(StaticResource)]
#[filename = "assets/style.css"]
#[mime = "text/css"]
pub struct StyleCss;
#[derive(StaticResource)]
#[filename = "assets/search.js"]
#[mime = "application/javascript"]
pub struct SearchJs;
#[derive(StaticResource)]
#[filename = "assets/script.js"]
#[mime = "application/javascript"]
pub struct ScriptJs;
// SIL Open Font License 1.1: http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL
// Copyright 2015 The Amatic SC Project Authors (contact@sansoxygen.com)
#[derive(StaticResource)]
#[filename = "assets/amatic-sc-v9-latin-regular.woff"]
#[mime = "application/font-woff"]
pub struct AmaticFont;
#[derive(StaticResource)]
#[filename = "assets/search.js"]
#[mime = "application/javascript"]
pub struct SearchJs;
// SIL Open Font License 1.1: http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL
// Copyright 2015 The Amatic SC Project Authors (contact@sansoxygen.com)
// #[derive(StaticResource)]
// #[filename = "assets/amatic-sc-v9-latin-regular.woff"]
// #[mime = "application/font-woff"]
// pub struct AmaticFont;
type BoxResource = Box<dyn Resource + Sync + Send>;
type ResourceFn = Box<dyn Fn() -> BoxResource + Sync + Send>;
lazy_static! {
pub static ref ASSETS_MAP: HashMap<&'static str, ResourceFn> = hashmap!{
// The CSS should be built to a single CSS file at compile time
ThemesCss::resource_name() =>
Box::new(|| Box::new(ThemesCss) as BoxResource) as ResourceFn,
StyleCss::resource_name() =>
Box::new(|| Box::new(StyleCss) as BoxResource) as ResourceFn,
ScriptJs::resource_name() =>
Box::new(|| Box::new(ScriptJs) as BoxResource) as ResourceFn,
SearchJs::resource_name() =>
Box::new(|| Box::new(SearchJs) as BoxResource) as ResourceFn,
};
}
}
#[cfg(not(feature = "dynamic-assets"))]
pub use self::static_assets::*;
#[cfg(feature = "dynamic-assets")]
mod dynamic_assets {
pub struct ThemesCss;
impl ThemesCss {
pub fn resource_name() -> &'static str {
"themes.css"
}
}
pub struct StyleCss;
impl StyleCss {
pub fn resource_name() -> &'static str {
"style.css"
}
}
pub struct ScriptJs;
impl ScriptJs {
pub fn resource_name() -> &'static str {
"script.js"
}
}
pub struct SearchJs;
impl SearchJs {
pub fn resource_name() -> &'static str {
"search.js"
}
}
}
#[cfg(feature = "dynamic-assets")]
pub use self::dynamic_assets::*;

53
src/build_config.rs Normal file
View file

@ -0,0 +1,53 @@
#![allow(dead_code)]
// The non-CARGO env variables used here must be listed
// in build.rs to properly trigger rebuild on change
pub const PROJECT_NAME: &str = env!("CARGO_PKG_NAME");
const SOFT_HYPHEN: &str = "\u{00AD}";
#[cfg(all(not(debug_assertions), feature = "dynamic-assets"))]
compile_error!("dynamic-assets must not be used for production");
lazy_static! {
pub static ref VERSION: String = || -> String {
let mut components = vec![];
#[cfg(debug_assertions)]
components.push("debug".into());
#[cfg(test)]
components.push("test".into());
#[cfg(feature = "dynamic-assets")]
components.push("dynamic-assets".into());
if option_env!("CONTINUOUS_INTEGRATION").is_none() {
components.push("local-build".into());
}
if let Some(branch) = option_env!("TRAVIS_BRANCH") {
components.push(format!("branch:{}", branch));
}
if let Some(commit) = option_env!("TRAVIS_COMMIT") {
components.push(format!(
"commit:{}",
commit
.as_bytes()
.chunks(4)
.map(|x| String::from_utf8(x.to_owned()).unwrap_or_else(|_| String::new()))
.collect::<Vec<_>>()
.join(SOFT_HYPHEN)
));
}
if !components.is_empty() {
format!("{} ({})", env!("CARGO_PKG_VERSION"), components.join(" "))
} else {
env!("CARGO_PKG_VERSION").to_string()
}
}();
pub static ref HTTP_SERVER: String = format!("{}/{}", PROJECT_NAME, VERSION.as_str());
}

101
src/db.rs
View file

@ -1,32 +1,109 @@
use diesel::prelude::*;
use diesel::expression::sql_literal::sql;
use diesel::types::*;
use r2d2::{Config, CustomizeConnection, Pool};
use diesel::prelude::*;
use diesel::sql_types::*;
use r2d2::{CustomizeConnection, Pool};
use r2d2_diesel::{self, ConnectionManager};
use crate::rendering;
use crate::theme;
embed_migrations!();
#[derive(Debug)]
struct SqliteInitializer;
#[allow(dead_code)]
pub mod sqlfunc {
use diesel::sql_types::Text;
sql_function!(fn markdown_to_fts(text: Text) -> Text);
sql_function!(fn theme_from_str_hash(text: Text) -> Text);
}
impl CustomizeConnection<SqliteConnection, r2d2_diesel::Error> for SqliteInitializer {
fn on_acquire(&self, conn: &mut SqliteConnection) -> Result<(), r2d2_diesel::Error> {
sql::<(Integer)>("PRAGMA foreign_keys = ON")
sql::<Integer>("PRAGMA foreign_keys = ON")
.execute(conn)
.and(Ok(()))
.map_err(|x| r2d2_diesel::Error::QueryError(x))
.map_err(r2d2_diesel::Error::QueryError)?;
sqlfunc::markdown_to_fts::register_impl(conn, |text: String| {
rendering::render_markdown_for_fts(&text)
})
.map_err(r2d2_diesel::Error::QueryError)?;
sqlfunc::theme_from_str_hash::register_impl(conn, |title: String| {
theme::theme_from_str_hash(&title)
})
.map_err(r2d2_diesel::Error::QueryError)?;
Ok(())
}
}
pub fn create_pool(connection_string: String) -> Result<Pool<ConnectionManager<SqliteConnection>>, Box<::std::error::Error>> {
let config = Config::builder()
.connection_customizer(Box::new(SqliteInitializer {}))
.build();
pub fn create_pool<S: Into<String>>(
connection_string: S,
) -> Result<Pool<ConnectionManager<SqliteConnection>>, Box<dyn (::std::error::Error)>> {
let manager = ConnectionManager::<SqliteConnection>::new(connection_string);
let pool = Pool::new(config, manager)?;
let pool = Pool::builder()
.connection_customizer(Box::new(SqliteInitializer {}))
.build(manager)?;
embedded_migrations::run(&*pool.get()?)?;
Ok(pool)
}
#[cfg(test)]
pub fn test_connection() -> SqliteConnection {
let mut conn = SqliteConnection::establish(":memory:")
.expect("SQLite should be able to create an in-memory database");
SqliteInitializer.on_acquire(&mut conn).unwrap();
embedded_migrations::run(&conn).unwrap();
conn
}
#[cfg(test)]
mod test {
use super::*;
use diesel::sql_query;
#[test]
fn markdown_to_fts() {
let conn = test_connection();
#[derive(QueryableByName, PartialEq, Eq, Debug)]
struct Row {
#[sql_type = "Text"]
text: String,
}
let res = sql_query("SELECT markdown_to_fts('[link](url)') as text")
.load::<Row>(&conn)
.unwrap();
let expected = rendering::render_markdown_for_fts("[link](url)");
assert_eq!(expected, res[0].text);
}
#[test]
fn theme_from_str_hash() {
let conn = test_connection();
#[derive(QueryableByName, PartialEq, Eq, Debug)]
struct Row {
#[sql_type = "Text"]
theme: theme::Theme,
}
let res = sql_query("SELECT theme_from_str_hash('Bartefjes') as theme")
.load::<Row>(&conn)
.unwrap();
let expected = theme::theme_from_str_hash("Bartefjes");
assert_eq!(expected, res[0].theme);
}
}

71
src/lib.rs Normal file
View file

@ -0,0 +1,71 @@
#![allow(clippy::into_iter_on_ref)]
#![allow(clippy::vec_init_then_push)]
#![recursion_limit = "128"]
// for diesel's infer_schema!
#[cfg(test)]
#[macro_use]
extern crate matches;
#[macro_use]
extern crate bart_derive;
#[macro_use]
extern crate codegen;
#[macro_use]
#[allow(clippy::useless_attribute)]
#[allow(deprecated)]
extern crate diesel_infer_schema;
#[macro_use]
extern crate diesel_migrations;
#[macro_use]
extern crate diesel;
#[macro_use]
extern crate hyper;
#[macro_use]
extern crate lazy_static;
#[macro_use]
extern crate maplit;
#[macro_use]
extern crate serde_derive;
#[macro_use]
extern crate serde_plain;
use std::net::{IpAddr, SocketAddr};
mod assets;
mod build_config;
mod db;
mod merge;
mod mimes;
mod models;
mod rendering;
mod resources;
mod schema;
mod site;
mod state;
mod theme;
mod web;
mod wiki_lookup;
pub fn main(
db_file: String,
bind_host: IpAddr,
bind_port: u16,
trust_identity: bool,
) -> Result<(), Box<dyn std::error::Error>> {
let db_pool = db::create_pool(db_file)?;
let cpu_pool = futures_cpupool::CpuPool::new_num_cpus();
let state = state::State::new(db_pool, cpu_pool);
let lookup = wiki_lookup::WikiLookup::new(state, trust_identity);
let server = hyper::server::Http::new()
.bind(&SocketAddr::new(bind_host, bind_port), move || {
Ok(site::Site::new(lookup.clone(), trust_identity))
})?;
println!("Listening on http://{}", server.local_addr().unwrap());
server.run()?;
Ok(())
}

View file

@ -0,0 +1,9 @@
<p>Copyright &lt;YEAR&gt; &lt;COPYRIGHT HOLDER&gt;<br /></p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
<p>1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</p>
<p>2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</p>
<p>3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</p>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>

682
src/licenses/gpl3.html Normal file
View file

@ -0,0 +1,682 @@
<p>Version 3, 29 June 2007</p>
<p>Copyright &copy; 2007 Free Software Foundation, Inc.
&lt;<a href="https://fsf.org/">https://fsf.org/</a>&gt;</p><p>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.</p>
<h2><a name="preamble"></a>Preamble</h3>
<p>The GNU General Public License is a free, copyleft license for
software and other kinds of works.</p>
<p>The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.</p>
<p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.</p>
<p>To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.</p>
<p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.</p>
<p>Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.</p>
<p>For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.</p>
<p>Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other 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.</p>
<p>Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that 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 non-free.</p>
<p>The precise terms and conditions for copying, distribution and
modification follow.</p>
<h2><a name="terms"></a>TERMS AND CONDITIONS</h3>
<h3><a name="section0"></a>0. Definitions.</h4>
<p>&ldquo;This License&rdquo; refers to version 3 of the GNU General Public License.</p>
<p>&ldquo;Copyright&rdquo; also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.</p>
<p>&ldquo;The Program&rdquo; refers to any copyrightable work licensed under this
License. Each licensee is addressed as &ldquo;you&rdquo;. &ldquo;Licensees&rdquo; and
&ldquo;recipients&rdquo; may be individuals or organizations.</p>
<p>To &ldquo;modify&rdquo; a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a &ldquo;modified version&rdquo; of the
earlier work or a work &ldquo;based on&rdquo; the earlier work.</p>
<p>A &ldquo;covered work&rdquo; means either the unmodified Program or a work based
on the Program.</p>
<p>To &ldquo;propagate&rdquo; a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.</p>
<p>To &ldquo;convey&rdquo; a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.</p>
<p>An interactive user interface displays &ldquo;Appropriate Legal Notices&rdquo;
to the extent that it includes a convenient and prominently visible
feature that (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 provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.</p>
<h3><a name="section1"></a>1. Source Code.</h4>
<p>The &ldquo;source code&rdquo; for a work means the preferred form of the work
for making modifications to it. &ldquo;Object code&rdquo; means any non-source
form of a work.</p>
<p>A &ldquo;Standard Interface&rdquo; means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.</p>
<p>The &ldquo;System Libraries&rdquo; of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
&ldquo;Major Component&rdquo;, in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.</p>
<p>The &ldquo;Corresponding Source&rdquo; for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.</p>
<p>The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.</p>
<p>The Corresponding Source for a work in source code form is that
same work.</p>
<h3><a name="section2"></a>2. Basic Permissions.</h4>
<p>All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.</p>
<p>You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.</p>
<p>Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.</p>
<h3><a name="section3"></a>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4>
<p>No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.</p>
<p>When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.</p>
<h3><a name="section4"></a>4. Conveying Verbatim Copies.</h4>
<p>You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.</p>
<p>You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.</p>
<h3><a name="section5"></a>5. Conveying Modified Source Versions.</h4>
<p>You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:</p>
<ul>
<li>a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.</li>
<li>b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
&ldquo;keep intact all notices&rdquo;.</li>
<li>c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.</li>
<li>d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.</li>
</ul>
<p>A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
&ldquo;aggregate&rdquo; if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.</p>
<h3><a name="section6"></a>6. Conveying Non-Source Forms.</h4>
<p>You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:</p>
<ul>
<li>a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.</li>
<li>b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.</li>
<li>c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.</li>
<li>d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.</li>
<li>e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.</li>
</ul>
<p>A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.</p>
<p>A &ldquo;User Product&rdquo; is either (1) a &ldquo;consumer product&rdquo;, which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, &ldquo;normally used&rdquo; refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.</p>
<p>&ldquo;Installation Information&rdquo; 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.</p>
<p>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).</p>
<p>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.</p>
<p>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.</p>
<h3><a name="section7"></a>7. Additional Terms.</h4>
<p>&ldquo;Additional permissions&rdquo; 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.</p>
<p>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.</p>
<p>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:</p>
<ul>
<li>a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or</li>
<li>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</li>
<li>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</li>
<li>d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or</li>
<li>e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or</li>
<li>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.</li>
</ul>
<p>All other non-permissive additional terms are considered &ldquo;further
restrictions&rdquo; 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.</p>
<p>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.</p>
<p>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.</p>
<h3><a name="section8"></a>8. Termination.</h4>
<p>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).</p>
<p>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.</p>
<p>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.</p>
<p>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.</p>
<h3><a name="section9"></a>9. Acceptance Not Required for Having Copies.</h4>
<p>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.</p>
<h3><a name="section10"></a>10. Automatic Licensing of Downstream Recipients.</h4>
<p>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.</p>
<p>An &ldquo;entity transaction&rdquo; 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.</p>
<p>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.</p>
<h3><a name="section11"></a>11. Patents.</h4>
<p>A &ldquo;contributor&rdquo; 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 &ldquo;contributor version&rdquo;.</p>
<p>A contributor's &ldquo;essential patent claims&rdquo; 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, &ldquo;control&rdquo; includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.</p>
<p>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.</p>
<p>In the following three paragraphs, a &ldquo;patent license&rdquo; 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 &ldquo;grant&rdquo; such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.</p>
<p>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. &ldquo;Knowingly relying&rdquo; 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.</p>
<p>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.</p>
<p>A patent license is &ldquo;discriminatory&rdquo; 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.</p>
<p>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.</p>
<h3><a name="section12"></a>12. No Surrender of Others' Freedom.</h4>
<p>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.</p>
<h3><a name="section13"></a>13. Use with the GNU Affero General Public License.</h4>
<p>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.</p>
<h3><a name="section14"></a>14. Revised Versions of this License.</h4>
<p>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.</p>
<p>Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License &ldquo;or any later version&rdquo; 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.</p>
<p>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.</p>
<p>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.</p>
<h3><a name="section15"></a>15. Disclaimer of Warranty.</h4>
<p>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 &ldquo;AS IS&rdquo; 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.</p>
<h3><a name="section16"></a>16. Limitation of Liability.</h4>
<p>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.</p>
<h3><a name="section17"></a>17. Interpretation of Sections 15 and 16.</h4>
<p>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.</p>
<p>END OF TERMS AND CONDITIONS</p>
<h2><a name="howto"></a>How to Apply These Terms to Your New Programs</h3>
<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.</p>
<p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the &ldquo;copyright&rdquo; line and a pointer to where the full notice is found.</p>
<pre> &lt;one line to give the program's name and a brief idea of what it does.&gt;
Copyright (C) &lt;year&gt; &lt;name of author&gt;
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 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
</pre>
<p>Also add information on how to contact you by electronic and paper mail.</p>
<p>If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:</p>
<pre> &lt;program&gt; Copyright (C) &lt;year&gt; &lt;name of author&gt;
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.
</pre>
<p>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 be different; for a GUI interface, you would use an &ldquo;about box&rdquo;.</p>
<p>You should also get your employer (if you work as a programmer) or school,
if any, to sign a &ldquo;copyright disclaimer&rdquo; for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
&lt;<a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>&gt;.</p>
<p>The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
&lt;<a href="https://www.gnu.org/licenses/why-not-lgpl.html">https://www.gnu.org/licenses/why-not-lgpl.html</a>&gt;.</p>

File diff suppressed because one or more lines are too long

19
src/licenses/mit.html Normal file
View file

@ -0,0 +1,19 @@
<p>Copyright &lt;YEAR&gt; &lt;COPYRIGHT HOLDER&gt;</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</p>

126
src/licenses/mpl2.html Normal file
View file

@ -0,0 +1,126 @@
<h2 id="definitions">1. Definitions</h2>
<dl>
<dt>1.1. “Contributor”</dt>
<dd><p>means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.</p>
</dd>
<dt>1.2. “Contributor Version”</dt>
<dd><p>means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributors Contribution.</p>
</dd>
<dt>1.3. “Contribution”</dt>
<dd><p>means Covered Software of a particular Contributor.</p>
</dd>
<dt>1.4. “Covered Software”</dt>
<dd><p>means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.</p>
</dd>
<dt>1.5. “Incompatible With Secondary Licenses”</dt>
<dd><p>means</p>
<ol type="a">
<li><p>that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or</p></li>
<li><p>that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License.</p></li>
</ol>
</dd>
<dt>1.6. “Executable Form”</dt>
<dd><p>means any form of the work other than Source Code Form.</p>
</dd>
<dt>1.7. “Larger Work”</dt>
<dd><p>means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.</p>
</dd>
<dt>1.8. “License”</dt>
<dd><p>means this document.</p>
</dd>
<dt>1.9. “Licensable”</dt>
<dd><p>means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.</p>
</dd>
<dt>1.10. “Modifications”</dt>
<dd><p>means any of the following:</p>
<ol type="a">
<li><p>any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or</p></li>
<li><p>any new file in Source Code Form that contains any Covered Software.</p></li>
</ol>
</dd>
<dt>1.11. “Patent Claims” of a Contributor</dt>
<dd><p>means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.</p>
</dd>
<dt>1.12. “Secondary License”</dt>
<dd><p>means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.</p>
</dd>
<dt>1.13. “Source Code Form”</dt>
<dd><p>means the form of the work preferred for making modifications.</p>
</dd>
<dt>1.14. “You” (or “Your”)</dt>
<dd><p>means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.</p>
</dd>
</dl>
<h2 id="license-grants-and-conditions">2. License Grants and Conditions</h2>
<h3 id="grants">2.1. Grants</h3>
<p>Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:</p>
<ol type="a">
<li><p>under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and</p></li>
<li><p>under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.</p></li>
</ol>
<h3 id="effective-date">2.2. Effective Date</h3>
<p>The licenses granted in Section&nbsp;2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.</p>
<h3 id="limitations-on-grant-scope">2.3. Limitations on Grant Scope</h3>
<p>The licenses granted in this Section&nbsp;2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section&nbsp;2.1(b) above, no patent license is granted by a Contributor:</p>
<ol type="a">
<li><p>for any code that a Contributor has removed from Covered Software; or</p></li>
<li><p>for infringements caused by: (i) Your and any other third partys modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or</p></li>
<li><p>under Patent Claims infringed by Covered Software in the absence of its Contributions.</p></li>
</ol>
<p>This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section&nbsp;3.4).</p>
<h3 id="subsequent-licenses">2.4. Subsequent Licenses</h3>
<p>No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section&nbsp;10.2) or under the terms of a Secondary License (if permitted under the terms of Section&nbsp;3.3).</p>
<h3 id="representation">2.5. Representation</h3>
<p>Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.</p>
<h3 id="fair-use">2.6. Fair Use</h3>
<p>This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.</p>
<h3 id="conditions">2.7. Conditions</h3>
<p>Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section&nbsp;2.1.</p>
<h2 id="responsibilities">3. Responsibilities</h2>
<h3 id="distribution-of-source-form">3.1. Distribution of Source Form</h3>
<p>All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients rights in the Source Code Form.</p>
<h3 id="distribution-of-executable-form">3.2. Distribution of Executable Form</h3>
<p>If You distribute Covered Software in Executable Form then:</p>
<ol type="a">
<li><p>such Covered Software must also be made available in Source Code Form, as described in Section&nbsp;3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and</p></li>
<li><p>You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients rights in the Source Code Form under this License.</p></li>
</ol>
<h3 id="distribution-of-a-larger-work">3.3. Distribution of a Larger Work</h3>
<p>You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).</p>
<h3 id="notices">3.4. Notices</h3>
<p>You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.</p>
<h3 id="application-of-additional-terms">3.5. Application of Additional Terms</h3>
<p>You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.</p>
<h2 id="inability-to-comply-due-to-statute-or-regulation">4. Inability to Comply Due to Statute or Regulation</h2>
<p>If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.</p>
<h2 id="termination">5. Termination</h2>
<p>5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.</p>
<p>5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section&nbsp;2.1 of this License shall terminate.</p>
<p>5.3. In the event of termination under Sections&nbsp;5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.</p>
<h2 id="disclaimer-of-warranty">6. Disclaimer of Warranty</h2>
<p><em>Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.</em></p>
<h2 id="limitation-of-liability">7. Limitation of Liability</h2>
<p><em>Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such partys negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.</em></p>
<h2 id="litigation">8. Litigation</h2>
<p>Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a partys ability to bring cross-claims or counter-claims.</p>
<h2 id="miscellaneous">9. Miscellaneous</h2>
<p>This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.</p>
<h2 id="versions-of-the-license">10. Versions of the License</h2>
<h3 id="new-versions">10.1. New Versions</h3>
<p>Mozilla Foundation is the license steward. Except as provided in Section&nbsp;10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.</p>
<h3 id="effect-of-new-versions">10.2. Effect of New Versions</h3>
<p>You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.</p>
<h3 id="modified-versions">10.3. Modified Versions</h3>
<p>If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).</p>
<h3 id="distributing-source-code-form-that-is-incompatible-with-secondary-licenses">10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses</h3>
<p>If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.</p>
<h2 id="exhibit-a---source-code-form-license-notice">Exhibit A - Source Code Form License Notice</h2>
<blockquote>
<p>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.</p>
</blockquote>
<p>If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.</p>
<p>You may add additional accurate notices of copyright ownership.</p>
<h2 id="exhibit-b---incompatible-with-secondary-licenses-notice">Exhibit B - “Incompatible With Secondary Licenses” Notice</h2>
<blockquote>
<p>This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0.</p>
</blockquote>

49
src/licenses/other.json Normal file
View file

@ -0,0 +1,49 @@
[
{
"package_name": "Amatic SC",
"conclusion": {
"Ok": {
"chosen_license": "Ofl11",
"copyright_notice": "Copyright 2015 The Amatic SC Project Authors (contact@sansoxygen.com)"
}
}
},
{
"package_name": "magenta-sys",
"version": "0.1.1",
"conclusion": {
"Ok": {
"chosen_license": "Bsd3Clause",
"copyright_notice": "Copyright 2016 The Fuchsia Authors. All rights reserved."
}
}
},
{
"package_name": "diesel_codegen",
"version": "0.16.0",
"conclusion": {
"Ok": {
"chosen_license": "Mit",
"copyright_notice": "Copyright (c) 2015-2017 Sean Griffin",
"full_spdx_license": "MIT OR Apache-2.0",
"full_license_document": "The MIT License (MIT)\n\nCopyright (c) 2015-2017 Sean Griffin\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"license_source": {
"GitHubRepo": {
"url": "https://raw.githubusercontent.com/diesel-rs/diesel/master/LICENSE-MIT"
}
},
"link": "http://diesel.rs"
}
}
},
{
"package_name": "musl",
"conclusion": {
"Ok": {
"chosen_license": "Mit",
"copyright_notice": "Copyright © 2005-2014 Rich Felker, et al.",
"link": "https://www.musl-libc.org/"
}
}
}
]

View file

@ -0,0 +1,78 @@
<p>Version 1.1 - 26 February 2007</p>
<h2> PREAMBLE</h2>
<p>The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.</p>
<p>The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.</p>
<h2> DEFINITIONS</h2>
<p>"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.</p>
<p>"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).</p>
<p>"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).</p>
<p>"Modified Version" refers to any derivative made by adding to, deleting,
or substituting &mdash; in part or in whole &mdash; any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.</p>
<p>"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.</p>
<h2>PERMISSION &amp; CONDITIONS</h2>
<p>Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:</p>
<p>1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.</p>
<p>2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.</p>
<p>3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.</p>
<p>4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.</p>
<p>5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.</p>
<h2>TERMINATION</h2>
<p>This license becomes null and void if any of the above conditions are
not met.</p>
<h2>DISCLAIMER</h2>
<p>THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.</p>

View file

@ -1,103 +1,77 @@
#![recursion_limit="128"] // for diesel's infer_schema!
#[macro_use]
extern crate lazy_static;
#[macro_use] extern crate bart_derive;
#[macro_use] extern crate diesel;
#[macro_use] extern crate diesel_codegen;
#[macro_use] extern crate hyper;
#[macro_use] extern crate lazy_static;
#[macro_use] extern crate serde_derive;
#[macro_use] extern crate static_resource_derive;
use std::net::IpAddr;
extern crate chrono;
extern crate clap;
extern crate futures;
extern crate futures_cpupool;
extern crate percent_encoding;
extern crate pulldown_cmark;
extern crate r2d2;
extern crate r2d2_diesel;
extern crate serde;
extern crate serde_json;
extern crate serde_urlencoded;
extern crate slug;
extern crate titlecase;
mod build_config;
use crate::build_config::*;
use std::net::SocketAddr;
mod assets;
mod db;
mod mimes;
mod models;
mod rendering;
mod resources;
mod schema;
mod site;
mod state;
mod web;
mod wiki_lookup;
const DATABASE: &str = "DATABASE";
const TRUST_IDENTITY: &str = "trust-identity";
const ADDRESS: &str = "address";
const PORT: &str = "port";
fn args<'a>() -> clap::ArgMatches<'a> {
use clap::{App, Arg};
App::new("sausagewiki")
.about("A wiki engine")
.arg(Arg::with_name("DATABASE")
.help("Sets the database file to use")
.required(true))
.arg(Arg::with_name("port")
.help("Sets the listening port")
.short("p")
.long("port")
.validator(|x| match x.parse::<u16>() {
Ok(_) => Ok(()),
Err(_) => Err("Must be an integer in the range [0, 65535]".to_owned())
})
.takes_value(true))
.arg(Arg::with_name("trust_identity")
.help("Trust the value in the X-Identity header to be an \
App::new(PROJECT_NAME)
.version(VERSION.as_str())
.about(env!("CARGO_PKG_DESCRIPTION"))
.arg(
Arg::with_name(DATABASE)
.help("Sets the database file to use")
.required(true),
)
.arg(
Arg::with_name(PORT)
.help("Sets the listening port")
.short("p")
.long(PORT)
.default_value("8080")
.validator(|x| match x.parse::<u16>() {
Ok(_) => Ok(()),
Err(_) => Err("Must be an integer in the range [0, 65535]".into()),
})
.takes_value(true),
)
.arg(
Arg::with_name(ADDRESS)
.help("Sets the IP address to bind to")
.short("a")
.long(ADDRESS)
.default_value("127.0.0.1")
.validator(|x| match x.parse::<IpAddr>() {
Ok(_) => Ok(()),
Err(_) => Err("Must be a valid IP address".into()),
})
.takes_value(true),
)
.arg(
Arg::with_name(TRUST_IDENTITY)
.help(
"Trust the value in the X-Identity header to be an \
authenticated username. This only makes sense when Sausagewiki \
runs behind a reverse proxy which sets this header.")
.long("trust_identity"))
runs behind a reverse proxy which sets this header.",
)
.long(TRUST_IDENTITY),
)
.get_matches()
}
fn core_main() -> Result<(), Box<std::error::Error>> {
fn main() -> Result<(), Box<dyn std::error::Error>> {
let args = args();
let db_file = args.value_of("DATABASE").expect("Guaranteed by clap").to_owned();
let bind_host = "127.0.0.1".parse().unwrap();
let bind_port = args.value_of("port")
.map(|p| p.parse().expect("Guaranteed by validator"))
.unwrap_or(8080);
const CLAP: &str = "Guaranteed by clap";
const VALIDATOR: &str = "Guaranteed by clap validator";
let db_file = args.value_of(DATABASE).expect(CLAP).to_owned();
let bind_host = args
.value_of(ADDRESS)
.expect(CLAP)
.parse()
.expect(VALIDATOR);
let bind_port = args.value_of(PORT).expect(CLAP).parse().expect(VALIDATOR);
let trust_identity = args.is_present("trust_identity");
let trust_identity = args.is_present(TRUST_IDENTITY);
let db_pool = db::create_pool(db_file)?;
let cpu_pool = futures_cpupool::CpuPool::new_num_cpus();
let state = state::State::new(db_pool, cpu_pool);
let lookup = wiki_lookup::WikiLookup::new(state);
let server =
hyper::server::Http::new()
.bind(
&SocketAddr::new(bind_host, bind_port),
move || Ok(site::Site::new(lookup.clone(), trust_identity))
)?;
println!("Listening on http://{}", server.local_addr().unwrap());
server.run()?;
Ok(())
}
fn main() {
match core_main() {
Ok(()) => (),
Err(err) => {
eprintln!("{:#?}", err);
std::process::exit(1)
}
}
sausagewiki::main(db_file, bind_host, bind_port, trust_identity)
}

7
src/merge/chunk.rs Normal file
View file

@ -0,0 +1,7 @@
use std::fmt::Debug;
#[derive(Debug, PartialEq)]
pub struct Chunk<'a, Item: 'a + Debug + PartialEq + Copy>(
pub &'a [diff::Result<Item>],
pub &'a [diff::Result<Item>],
);

174
src/merge/chunk_iterator.rs Normal file
View file

@ -0,0 +1,174 @@
use std::fmt::Debug;
use diff::Result::*;
use super::chunk::Chunk;
pub struct ChunkIterator<'a, Item>
where
Item: 'a + Debug + PartialEq,
{
left: &'a [diff::Result<Item>],
right: &'a [diff::Result<Item>],
}
impl<'a, Item> ChunkIterator<'a, Item>
where
Item: 'a + Debug + PartialEq + Eq,
{
pub fn new(
left: &'a [diff::Result<Item>],
right: &'a [diff::Result<Item>],
) -> ChunkIterator<'a, Item> {
ChunkIterator { left, right }
}
}
impl<'a, Item> Iterator for ChunkIterator<'a, Item>
where
Item: 'a + Debug + PartialEq + Copy,
{
type Item = Chunk<'a, Item>;
fn next(&mut self) -> Option<Self::Item> {
let mut i = 0;
while let (Some(&Both(..)), Some(&Both(..))) = (self.left.get(i), self.right.get(i)) {
i += 1;
}
if i > 0 {
let chunk = Chunk(&self.left[..i], &self.right[..i]);
self.left = &self.left[i..];
self.right = &self.right[i..];
return Some(chunk);
}
let mut li = 0;
let mut ri = 0;
loop {
match (self.left.get(li), self.right.get(ri)) {
(Some(&Right(_)), _) => {
li += 1;
}
(_, Some(&Right(_))) => {
ri += 1;
}
(Some(&Left(_)), Some(_)) => {
li += 1;
ri += 1;
}
(Some(_), Some(&Left(_))) => {
li += 1;
ri += 1;
}
(Some(&Both(..)), Some(&Both(..))) => {
let chunk = Chunk(&self.left[..li], &self.right[..ri]);
self.left = &self.left[li..];
self.right = &self.right[ri..];
return Some(chunk);
}
_ => {
if !self.left.is_empty() || !self.right.is_empty() {
let chunk = Chunk(self.left, self.right);
self.left = &self.left[self.left.len()..];
self.right = &self.right[self.right.len()..];
return Some(chunk);
}
return None;
}
}
}
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn simple_case() {
let o = "aaabbbccc";
let a = "aaaxxxbbbccc";
let b = "aaabbbyyyccc";
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = ChunkIterator::new(&oa, &ob).collect::<Vec<_>>();
assert_eq!(
vec![
Chunk(&oa[0..3], &ob[0..3]),
Chunk(&oa[3..6], &ob[3..3]),
Chunk(&oa[6..9], &ob[3..6]),
Chunk(&oa[9..9], &ob[6..9]),
Chunk(&oa[9..12], &ob[9..12]),
],
chunks
);
}
#[test]
fn real_conflict() {
let o = "aaabbbccc";
let a = "aaaxxxccc";
let b = "aaayyyccc";
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = ChunkIterator::new(&oa, &ob).collect::<Vec<_>>();
assert_eq!(
vec![
Chunk(&oa[0..3], &ob[0..3]),
Chunk(&oa[3..9], &ob[3..9]),
Chunk(&oa[9..12], &ob[9..12]),
],
chunks
);
}
#[test]
fn additional_at_end() {
let o = "aaabbbccc";
let a = "aaabbbccc";
let b = "aaabbbcccddd";
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = ChunkIterator::new(&oa, &ob).collect::<Vec<_>>();
assert_eq!(
vec![Chunk(&oa[0..9], &ob[0..9]), Chunk(&oa[9..9], &ob[9..12]),],
chunks
);
}
#[test]
fn additional_at_end_2() {
let o = "aaabbb";
let a = "aaabbbccc";
let b = "aaabbbcccddd";
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = ChunkIterator::new(&oa, &ob).collect::<Vec<_>>();
assert_eq!(
vec![Chunk(&oa[0..6], &ob[0..6]), Chunk(&oa[6..9], &ob[6..12]),],
chunks
);
}
#[test]
fn completely_unrelated() {
let o = "aaa";
let a = "bbb";
let b = "ccc";
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = ChunkIterator::new(&oa, &ob).collect::<Vec<_>>();
assert_eq!(vec![Chunk(&oa[0..6], &ob[0..6]),], chunks);
}
}

280
src/merge/mod.rs Normal file
View file

@ -0,0 +1,280 @@
mod chunk;
mod chunk_iterator;
mod output;
use std::fmt::Debug;
use self::chunk_iterator::ChunkIterator;
use self::output::Output::Resolved;
use self::output::*;
pub use self::output::Output;
#[derive(Debug, PartialEq)]
pub enum MergeResult<Item: Debug + PartialEq> {
Clean(String),
Conflicted(Vec<Output<Item>>),
}
impl<'a> MergeResult<&'a str> {
pub fn into_strings(self) -> MergeResult<String> {
match self {
MergeResult::Clean(x) => MergeResult::Clean(x),
MergeResult::Conflicted(x) => {
MergeResult::Conflicted(x.into_iter().map(Output::into_strings).collect())
}
}
}
}
impl MergeResult<String> {
pub fn flatten(self) -> String {
match self {
MergeResult::Clean(x) => x,
MergeResult::Conflicted(x) => x
.into_iter()
.flat_map(|out| match out {
Output::Conflict(a, _o, b) => {
let mut x: Vec<String> = vec![];
x.push("<<<<<<< Your changes:\n".into());
x.extend(a.into_iter().map(|x| format!("{}\n", x)));
x.push("======= Their changes:\n".into());
x.extend(b.into_iter().map(|x| format!("{}\n", x)));
x.push(">>>>>>> Conflict ends here\n".into());
x
}
Output::Resolved(x) => x.into_iter().map(|x| format!("{}\n", x)).collect(),
})
.collect(),
}
}
}
impl MergeResult<char> {
pub fn flatten(self) -> String {
match self {
MergeResult::Clean(x) => x,
MergeResult::Conflicted(x) => x
.into_iter()
.flat_map(|out| match out {
Output::Conflict(a, _o, b) => {
let mut x: Vec<char> = vec![];
x.push('<');
x.extend(a);
x.push('|');
x.extend(b);
x.push('>');
x
}
Output::Resolved(x) => x,
})
.collect(),
}
}
}
pub fn merge_lines<'a>(a: &'a str, o: &'a str, b: &'a str) -> MergeResult<&'a str> {
let oa = diff::lines(o, a);
let ob = diff::lines(o, b);
let chunks = ChunkIterator::new(&oa, &ob);
let hunks: Vec<_> = chunks.map(resolve).collect();
let clean = hunks.iter().all(|x| matches!(x, Resolved(..)));
if clean {
MergeResult::Clean(
hunks
.into_iter()
.flat_map(|x| match x {
Resolved(y) => y.into_iter(),
_ => unreachable!(),
})
.collect::<Vec<_>>()
.join("\n"),
)
} else {
MergeResult::Conflicted(hunks)
}
}
pub fn merge_chars<'a>(a: &'a str, o: &'a str, b: &'a str) -> MergeResult<char> {
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = ChunkIterator::new(&oa, &ob);
let hunks: Vec<_> = chunks.map(resolve).collect();
let clean = hunks.iter().all(|x| matches!(x, Resolved(..)));
if clean {
MergeResult::Clean(
hunks
.into_iter()
.flat_map(|x| match x {
Resolved(y) => y.into_iter(),
_ => unreachable!(),
})
.collect(),
)
} else {
MergeResult::Conflicted(hunks)
}
}
#[cfg(test)]
mod test {
use indoc::indoc;
use super::output::Output::*;
use super::output::*;
use super::*;
#[test]
fn simple_case() {
fn merge_chars(a: &str, o: &str, b: &str) -> Vec<Output<char>> {
let oa = diff::chars(o, a);
let ob = diff::chars(o, b);
let chunks = super::chunk_iterator::ChunkIterator::new(&oa, &ob);
chunks.map(resolve).collect()
}
assert_eq!(
vec![
Resolved("aaa".chars().collect()),
Resolved("xxx".chars().collect()),
Resolved("bbb".chars().collect()),
Resolved("yyy".chars().collect()),
Resolved("ccc".chars().collect()),
],
merge_chars("aaaxxxbbbccc", "aaabbbccc", "aaabbbyyyccc",)
);
}
#[test]
fn clean_case() {
assert_eq!(
MergeResult::Clean(
indoc!(
"
aaa
xxx
bbb
yyy
ccc
"
)
.into()
),
merge_lines(
indoc!(
"
aaa
xxx
bbb
ccc
"
),
indoc!(
"
aaa
bbb
ccc
"
),
indoc!(
"
aaa
bbb
yyy
ccc
"
),
)
);
}
#[test]
fn clean_case_chars() {
assert_eq!(
MergeResult::Clean("Title".into()),
merge_chars("Titlle", "titlle", "title",)
);
}
#[test]
fn false_conflict() {
assert_eq!(
MergeResult::Clean(
indoc!(
"
aaa
xxx
ccc
"
)
.into()
),
merge_lines(
indoc!(
"
aaa
xxx
ccc
"
),
indoc!(
"
aaa
bbb
ccc
"
),
indoc!(
"
aaa
xxx
ccc
"
),
)
);
}
#[test]
fn true_conflict() {
assert_eq!(
MergeResult::Conflicted(vec![
Resolved(vec!["aaa"]),
Conflict(vec!["xxx"], vec![], vec!["yyy"]),
Resolved(vec!["bbb", "ccc", ""]),
]),
merge_lines(
indoc!(
"
aaa
xxx
bbb
ccc
"
),
indoc!(
"
aaa
bbb
ccc
"
),
indoc!(
"
aaa
yyy
bbb
ccc
"
),
)
);
}
}

113
src/merge/output.rs Normal file
View file

@ -0,0 +1,113 @@
use std::fmt::Debug;
use diff::Result::*;
use super::chunk::Chunk;
#[derive(Debug, PartialEq)]
pub enum Output<Item: Debug + PartialEq> {
Resolved(Vec<Item>),
Conflict(Vec<Item>, Vec<Item>, Vec<Item>),
}
impl<'a> Output<&'a str> {
pub fn into_strings(self) -> Output<String> {
match self {
Output::Resolved(x) => Output::Resolved(x.into_iter().map(str::to_string).collect()),
Output::Conflict(a, o, b) => Output::Conflict(
a.into_iter().map(str::to_string).collect(),
o.into_iter().map(str::to_string).collect(),
b.into_iter().map(str::to_string).collect(),
),
}
}
}
fn choose_left<Item: Copy>(operations: &[diff::Result<Item>]) -> Vec<Item> {
operations
.iter()
.filter_map(|x| match *x {
Both(y, _) => Some(y),
Left(y) => Some(y),
Right(_) => None,
})
.collect()
}
fn choose_right<Item: Copy>(operations: &[diff::Result<Item>]) -> Vec<Item> {
operations
.iter()
.filter_map(|x| match *x {
Both(_, y) => Some(y),
Left(_) => None,
Right(y) => Some(y),
})
.collect()
}
fn no_change<Item>(operations: &[diff::Result<Item>]) -> bool {
operations.iter().all(|x| matches!(x, Both(..)))
}
pub fn resolve<'a, Item: 'a + Debug + PartialEq + Copy>(chunk: Chunk<'a, Item>) -> Output<Item> {
if chunk.0 == chunk.1 {
// Either nothing changed or both sides made the same change
return Output::Resolved(choose_right(chunk.0));
}
if no_change(chunk.0) {
return Output::Resolved(choose_right(chunk.1));
}
if no_change(chunk.1) {
return Output::Resolved(choose_right(chunk.0));
}
Output::Conflict(
choose_right(chunk.0),
choose_left(chunk.0),
choose_right(chunk.1),
)
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn empty() {
assert_eq!(Output::Resolved(vec![]), resolve::<i32>(Chunk(&[], &[])));
}
#[test]
fn same() {
assert_eq!(
Output::Resolved(vec![1]),
resolve::<i32>(Chunk(&[Both(1, 1)], &[Both(1, 1)]))
);
}
#[test]
fn only_left() {
assert_eq!(
Output::Resolved(vec![2]),
resolve::<i32>(Chunk(&[Left(1), Right(2)], &[]))
);
}
#[test]
fn false_conflict() {
assert_eq!(
Output::Resolved(vec![2]),
resolve::<i32>(Chunk(&[Left(1), Right(2)], &[Left(1), Right(2)],))
);
}
#[test]
fn real_conflict() {
assert_eq!(
Output::Conflict(vec![2], vec![1], vec![3],),
resolve::<i32>(Chunk(&[Left(1), Right(2)], &[Left(1), Right(3)],))
);
}
}

View file

@ -2,5 +2,6 @@ use hyper::mime;
lazy_static! {
pub static ref TEXT_HTML: mime::Mime = "text/html;charset=utf-8".parse().unwrap();
pub static ref TEXT_PLAIN: mime::Mime = "text/plain;charset=utf-8".parse().unwrap();
pub static ref APPLICATION_JSON: mime::Mime = "application/json".parse().unwrap();
}

View file

@ -1,4 +1,12 @@
use chrono;
use crate::theme::Theme;
fn slug_link(slug: &str) -> &str {
if slug.is_empty() {
"."
} else {
slug
}
}
#[derive(Debug, Queryable)]
pub struct ArticleRevision {
@ -15,9 +23,17 @@ pub struct ArticleRevision {
pub latest: bool,
pub author: Option<String>,
pub theme: Theme,
}
#[derive(Debug, Queryable)]
impl ArticleRevision {
pub fn link(&self) -> &str {
slug_link(&self.slug)
}
}
#[derive(Debug, PartialEq, Queryable)]
pub struct ArticleRevisionStub {
pub sequence_number: i32,
@ -31,11 +47,31 @@ pub struct ArticleRevisionStub {
pub latest: bool,
pub author: Option<String>,
pub theme: Theme,
}
#[derive(Debug, Queryable, Serialize)]
impl ArticleRevisionStub {
pub fn link(&self) -> &str {
slug_link(&self.slug)
}
}
use diesel::sql_types::Text;
#[derive(Debug, QueryableByName, Serialize)]
pub struct SearchResult {
#[sql_type = "Text"]
pub title: String,
#[sql_type = "Text"]
pub snippet: String,
#[sql_type = "Text"]
pub slug: String,
}
impl SearchResult {
pub fn link(&self) -> &str {
slug_link(&self.slug)
}
}

View file

@ -1,9 +1,65 @@
use pulldown_cmark::{Parser, html, OPTION_ENABLE_TABLES, OPTION_DISABLE_HTML};
use pulldown_cmark::Event::{End, Text};
use pulldown_cmark::{html, Parser, Tag, OPTION_DISABLE_HTML, OPTION_ENABLE_TABLES};
use slug::slugify;
fn slugify_link(text: &str, title: &str) -> Option<(String, String)> {
Some((slugify(text), title.to_owned()))
}
fn parser(src: &str) -> Parser {
let opts = OPTION_ENABLE_TABLES | OPTION_DISABLE_HTML;
Parser::new_with_broken_link_callback(src, opts, Some(&slugify_link))
}
pub fn render_markdown(src: &str) -> String {
let opts = OPTION_ENABLE_TABLES | OPTION_DISABLE_HTML;
let p = Parser::new_ext(src, opts);
let p = parser(src);
let mut buf = String::new();
html::push_html(&mut buf, p);
buf
}
fn is_html_special(c: char) -> bool {
c == '&' || c == '<' || c == '>'
}
pub fn render_markdown_for_fts(src: &str) -> String {
let p = parser(src);
let mut buf = String::new();
for event in p {
match event {
// As far as I understand this is a basic
// sanitizing to prevent HTML from
// appearing in page.
Text(text) => buf.push_str(&text.replace(is_html_special, " ")),
// Footnote links maybe?
End(Tag::Link(uri, _title)) => {
buf.push_str(" (");
buf.push_str(&uri.replace(is_html_special, " "));
buf.push_str(") ");
}
_ => buf.push(' '),
}
}
buf
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn slug_link() {
let actual = render_markdown("[Slug link]");
let expected = "<p><a href=\"slug-link\" title=\"Slug link\">Slug link</a></p>\n";
assert_eq!(actual, expected);
}
#[test]
fn footnote_links() {
let actual = render_markdown("[Link]\n\n[Link]: target");
let expected = "<p><a href=\"target\">Link</a></p>\n";
assert_eq!(actual, expected);
}
}

View file

@ -0,0 +1,98 @@
use futures::{self, Future};
use hyper::header::ContentType;
use hyper::server::*;
use crate::build_config;
use crate::mimes::*;
use crate::site::system_page;
use crate::web::{Resource, ResponseFuture};
#[derive(Licenses)]
pub struct AboutResource;
impl AboutResource {
pub fn new() -> Self {
AboutResource
}
}
enum License {
Bsd3Clause,
Mit,
Mpl2,
Ofl11,
}
impl License {
fn link(&self) -> &'static str {
use self::License::*;
match self {
Bsd3Clause => "bsd-3-clause",
Mit => "mit",
Mpl2 => "mpl2",
Ofl11 => "sil-ofl-1.1",
}
}
fn name(&self) -> &'static str {
use self::License::*;
match self {
Bsd3Clause => "BSD-3-Clause",
Mit => "MIT",
Mpl2 => "MPL2",
Ofl11 => "OFL-1.1",
}
}
}
struct LicenseInfo {
name: &'static str,
link: Option<&'static str>,
copyright: &'static str,
license: License,
}
#[derive(BartDisplay)]
#[template = "templates/about.html"]
struct Template<'a> {
deps: &'a [LicenseInfo],
}
impl<'a> Template<'a> {
fn version(&self) -> &str {
&build_config::VERSION
}
}
impl Resource for AboutResource {
fn allow(&self) -> Vec<hyper::Method> {
use hyper::Method::*;
vec![Options, Head, Get]
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
let head = self.head();
Box::new(head.and_then(move |head| {
Ok(head.with_body(
system_page(
None, // Hmm, should perhaps accept `base` as argument
"About Sausagewiki",
Template {
deps: *LICENSE_INFOS,
},
)
.to_string(),
))
}))
}
}

View file

@ -1,51 +0,0 @@
use futures::{self, Future};
use hyper;
use hyper::header::Location;
use hyper::server::*;
use web::{Resource, ResponseFuture};
pub struct ArticleRedirectResource {
slug: String,
}
impl ArticleRedirectResource {
pub fn new(slug: String) -> Self {
// Hack to let redirects to "" work:
// TODO Calculate absolute Location URLs to conform to spec
// This would also remove the need for this hack
Self {
slug: if slug == "" { ".".to_owned() } else { slug }
}
}
}
impl Resource for ArticleRedirectResource {
fn allow(&self) -> Vec<hyper::Method> {
use hyper::Method::*;
vec![Options, Head, Get, Put]
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::TemporaryRedirect)
.with_header(Location::new(self.slug.clone()))
))
}
fn get(self: Box<Self>) -> ResponseFuture {
Box::new(self.head()
.and_then(move |head| {
Ok(head
.with_body(format!("Moved to {}", self.slug)))
}))
}
fn put(self: Box<Self>, _body: hyper::Body, _identity: Option<String>) -> ResponseFuture {
Box::new(self.head()
.and_then(move |head| {
Ok(head
.with_body(format!("Moved to {}", self.slug)))
}))
}
}

View file

@ -1,20 +1,52 @@
use chrono::{TimeZone, DateTime, Local};
use chrono::{DateTime, Local, TimeZone};
use futures::{self, Future};
use hyper;
use hyper::header::ContentType;
use hyper::server::*;
use serde_json;
use serde_urlencoded;
use assets::ScriptJs;
use mimes::*;
use rendering::render_markdown;
use site::Layout;
use state::State;
use web::{Resource, ResponseFuture};
use hyper::header::{ContentType, Location};
use hyper::server::*;
use crate::assets::ScriptJs;
use crate::mimes::*;
use crate::rendering::render_markdown;
use crate::site::Layout;
use crate::state::{RebaseConflict, State, UpdateResult};
use crate::theme::{self, Theme};
use crate::web::{Resource, ResponseFuture};
use super::changes_resource::QueryParameters;
struct SelectableTheme {
theme: Theme,
selected: bool,
}
#[derive(BartDisplay)]
#[template = "templates/article.html"]
struct Template<'a> {
revision: i32,
last_updated: Option<&'a str>,
edit: bool,
cancel_url: Option<&'a str>,
title: &'a str,
raw: &'a str,
rendered: String,
themes: &'a [SelectableTheme],
}
impl<'a> Template<'a> {
fn script_js(&self) -> &'static str {
ScriptJs::resource_name()
}
}
#[derive(Deserialize)]
struct UpdateArticle {
base_revision: i32,
title: String,
body: String,
theme: Option<Theme>,
}
pub struct ArticleResource {
state: State,
article_id: i32,
@ -24,7 +56,12 @@ pub struct ArticleResource {
impl ArticleResource {
pub fn new(state: State, article_id: i32, revision: i32, edit: bool) -> Self {
Self { state, article_id, revision, edit }
Self {
state,
article_id,
revision,
edit,
}
}
}
@ -44,69 +81,76 @@ pub fn last_updated(article_id: i32, created: &DateTime<Local>, author: Option<&
Template {
created: &created.to_rfc2822(),
article_history: &format!("_changes{}", QueryParameters::default().article_id(Some(article_id)).into_link()),
article_history: &format!(
"_changes{}",
QueryParameters::default()
.article_id(Some(article_id))
.into_link()
),
author: author.map(|author| Author {
author: &author,
history: format!("_changes{}", QueryParameters::default().author(Some(author.to_owned())).into_link()),
author,
history: format!(
"_changes{}",
QueryParameters::default()
.author(Some(author.to_owned()))
.into_link()
),
}),
}.to_string()
}
.to_string()
}
impl Resource for ArticleResource {
fn allow(&self) -> Vec<hyper::Method> {
use hyper::Method::*;
vec![Options, Head, Get, Put]
vec![Options, Head, Get, Put, Post]
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone()))
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
#[derive(BartDisplay)]
#[template="templates/article.html"]
struct Template<'a> {
revision: i32,
last_updated: Option<&'a str>,
edit: bool,
cancel_url: Option<&'a str>,
title: &'a str,
raw: &'a str,
rendered: String,
script_js_checksum: &'a str,
}
let data = self.state.get_article_revision(self.article_id, self.revision)
let data = self
.state
.get_article_revision(self.article_id, self.revision)
.map(|x| x.expect("Data model guarantees that this exists"));
let head = self.head();
Box::new(data.join(head)
.and_then(move |(data, head)| {
Ok(head
.with_body(Layout {
base: None, // Hmm, should perhaps accept `base` as argument
Box::new(data.join(head).and_then(move |(data, head)| {
Ok(head.with_body(
Layout {
base: None, // Hmm, should perhaps accept `base` as argument
title: &data.title,
theme: data.theme,
body: &Template {
revision: data.revision,
last_updated: Some(&last_updated(
data.article_id,
&Local.from_utc_datetime(&data.created),
data.author.as_deref(),
)),
edit: self.edit,
cancel_url: Some(data.link()),
title: &data.title,
body: &Template {
revision: data.revision,
last_updated: Some(&last_updated(
data.article_id,
&Local.from_utc_datetime(&data.created),
data.author.as_ref().map(|x| &**x)
)),
edit: self.edit,
cancel_url: Some(&data.slug),
title: &data.title,
raw: &data.body,
rendered: render_markdown(&data.body),
script_js_checksum: ScriptJs::checksum(),
},
}.to_string()))
}))
raw: &data.body,
rendered: render_markdown(&data.body),
themes: &theme::THEMES
.iter()
.map(|&x| SelectableTheme {
theme: x,
selected: x == data.theme,
})
.collect::<Vec<_>>(),
},
}
.to_string(),
))
}))
}
fn put(self: Box<Self>, body: hyper::Body, identity: Option<String>) -> ResponseFuture {
@ -114,15 +158,8 @@ impl Resource for ArticleResource {
use futures::Stream;
#[derive(Deserialize)]
struct UpdateArticle {
base_revision: i32,
title: String,
body: String,
}
#[derive(BartDisplay)]
#[template="templates/article_contents.html"]
#[template = "templates/article_contents.html"]
struct Template<'a> {
title: &'a str,
rendered: String,
@ -130,43 +167,158 @@ impl Resource for ArticleResource {
#[derive(Serialize)]
struct PutResponse<'a> {
conflict: bool,
slug: &'a str,
revision: i32,
title: &'a str,
body: &'a str,
theme: Theme,
rendered: &'a str,
last_updated: &'a str,
}
Box::new(body
.concat2()
.map_err(Into::into)
.and_then(|body| {
serde_urlencoded::from_bytes(&body)
.map_err(Into::into)
})
.and_then(move |update: UpdateArticle| {
self.state.update_article(self.article_id, update.base_revision, update.title, update.body, identity)
})
.and_then(|updated| {
futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(APPLICATION_JSON.clone()))
.with_body(serde_json::to_string(&PutResponse {
slug: &updated.slug,
revision: updated.revision,
title: &updated.title,
rendered: &Template {
title: &updated.title,
rendered: render_markdown(&updated.body),
}.to_string(),
last_updated: &last_updated(
updated.article_id,
&Local.from_utc_datetime(&updated.created),
updated.author.as_ref().map(|x| &**x)
),
}).expect("Should never fail"))
)
})
Box::new(
body.concat2()
.map_err(Into::into)
.and_then(|body| serde_urlencoded::from_bytes(&body).map_err(Into::into))
.and_then(move |update: UpdateArticle| {
self.state.update_article(
self.article_id,
update.base_revision,
update.title,
update.body,
identity,
update.theme,
)
})
.and_then(|updated| match updated {
UpdateResult::Success(updated) => Ok(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(APPLICATION_JSON.clone()))
.with_body(
serde_json::to_string(&PutResponse {
conflict: false,
slug: &updated.slug,
revision: updated.revision,
title: &updated.title,
body: &updated.body,
theme: updated.theme,
rendered: &Template {
title: &updated.title,
rendered: render_markdown(&updated.body),
}
.to_string(),
last_updated: &last_updated(
updated.article_id,
&Local.from_utc_datetime(&updated.created),
updated.author.as_deref(),
),
})
.expect("Should never fail"),
)),
UpdateResult::RebaseConflict(RebaseConflict {
base_article,
title,
body,
theme,
}) => {
let title = title.flatten();
let body = body.flatten();
Ok(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(APPLICATION_JSON.clone()))
.with_body(
serde_json::to_string(&PutResponse {
conflict: true,
slug: &base_article.slug,
revision: base_article.revision,
title: &title,
body: &body,
theme,
rendered: &Template {
title: &title,
rendered: render_markdown(&body),
}
.to_string(),
last_updated: &last_updated(
base_article.article_id,
&Local.from_utc_datetime(&base_article.created),
base_article.author.as_deref(),
),
})
.expect("Should never fail"),
))
}
}),
)
}
fn post(self: Box<Self>, body: hyper::Body, identity: Option<String>) -> ResponseFuture {
// TODO Check incoming Content-Type
use futures::Stream;
Box::new(
body.concat2()
.map_err(Into::into)
.and_then(|body| serde_urlencoded::from_bytes(&body).map_err(Into::into))
.and_then(move |update: UpdateArticle| {
self.state.update_article(
self.article_id,
update.base_revision,
update.title,
update.body,
identity,
update.theme,
)
})
.and_then(|updated| match updated {
UpdateResult::Success(updated) => Ok(Response::new()
.with_status(hyper::StatusCode::SeeOther)
.with_header(ContentType(TEXT_PLAIN.clone()))
.with_header(Location::new(updated.link().to_owned()))
.with_body("See other")),
UpdateResult::RebaseConflict(RebaseConflict {
base_article,
title,
body,
theme,
}) => {
let title = title.flatten();
let body = body.flatten();
Ok(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone()))
.with_body(
Layout {
base: None,
title: &title,
theme,
body: &Template {
revision: base_article.revision,
last_updated: Some(&last_updated(
base_article.article_id,
&Local.from_utc_datetime(&base_article.created),
base_article.author.as_deref(),
)),
edit: true,
cancel_url: Some(base_article.link()),
title: &title,
raw: &body,
rendered: render_markdown(&body),
themes: &theme::THEMES
.iter()
.map(|&x| SelectableTheme {
theme: x,
selected: x == theme,
})
.collect::<Vec<_>>(),
},
}
.to_string(),
))
}
}),
)
}
}

View file

@ -1,16 +1,17 @@
use chrono::{TimeZone, DateTime, Local};
use chrono::{DateTime, Local, TimeZone};
use futures::{self, Future};
use hyper;
use hyper::header::ContentType;
use hyper::server::*;
use mimes::*;
use models;
use rendering::render_markdown;
use site::Layout;
use web::{Resource, ResponseFuture};
use crate::mimes::*;
use crate::models;
use crate::rendering::render_markdown;
use crate::site::system_page;
use crate::web::{Resource, ResponseFuture};
use super::changes_resource::QueryParameters;
use super::diff_resource;
use super::pagination::Pagination;
pub struct ArticleRevisionResource {
@ -23,7 +24,12 @@ impl ArticleRevisionResource {
}
}
pub fn timestamp_and_author(sequence_number: i32, article_id: i32, created: &DateTime<Local>, author: Option<&str>) -> String {
pub fn timestamp_and_author(
sequence_number: i32,
article_id: i32,
created: &DateTime<Local>,
author: Option<&str>,
) -> String {
struct Author<'a> {
author: &'a str,
history: String,
@ -41,15 +47,17 @@ pub fn timestamp_and_author(sequence_number: i32, article_id: i32, created: &Dat
Template {
created: &created.to_rfc2822(),
article_history: &format!("_changes{}",
article_history: &format!(
"_changes{}",
QueryParameters::default()
.pagination(pagination)
.article_id(Some(article_id))
.into_link()
),
author: author.map(|author| Author {
author: &author,
history: format!("_changes{}",
author,
history: format!(
"_changes{}",
QueryParameters::default()
.pagination(pagination)
.article_id(Some(article_id))
@ -57,7 +65,8 @@ pub fn timestamp_and_author(sequence_number: i32, article_id: i32, created: &Dat
.into_link()
),
}),
}.to_string()
}
.to_string()
}
impl Resource for ArticleRevisionResource {
@ -67,44 +76,56 @@ impl Resource for ArticleRevisionResource {
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone()))
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
#[derive(BartDisplay)]
#[template="templates/article_revision.html"]
#[template = "templates/article_revision.html"]
struct Template<'a> {
link_current: &'a str,
timestamp_and_author: &'a str,
title: &'a str,
diff_link: Option<String>,
rendered: String,
}
let head = self.head();
let data = self.data;
Box::new(head
.and_then(move |head|
Ok(head
.with_body(Layout {
base: Some("../../"), // Hmm, should perhaps accept `base` as argument
title: &data.title,
body: &Template {
link_current: &format!("_by_id/{}", data.article_id),
timestamp_and_author: &timestamp_and_author(
data.sequence_number,
Box::new(head.and_then(move |head| {
Ok(head.with_body(
system_page(
Some("../../"), // Hmm, should perhaps accept `base` as argument
&data.title,
&Template {
link_current: &format!("_by_id/{}", data.article_id),
timestamp_and_author: &timestamp_and_author(
data.sequence_number,
data.article_id,
&Local.from_utc_datetime(&data.created),
data.author.as_deref(),
),
diff_link: if data.revision > 1 {
Some(format!(
"_diff/{}?{}",
data.article_id,
&Local.from_utc_datetime(&data.created),
data.author.as_ref().map(|x| &**x)
),
title: &data.title,
rendered: render_markdown(&data.body),
diff_resource::QueryParameters::new(
data.revision as u32 - 1,
data.revision as u32,
)
))
} else {
None
},
}.to_string()))
rendered: render_markdown(&data.body),
},
)
.to_string(),
))
}))
}
}

View file

@ -1,27 +1,27 @@
use diesel;
use futures::{self, Future};
use futures::future::{done, finished};
use hyper;
use futures::{self, Future};
use hyper::header::ContentType;
use hyper::server::*;
use serde_urlencoded;
use mimes::*;
use schema::article_revisions;
use site::Layout;
use state::State;
use web::{Resource, ResponseFuture};
use crate::mimes::*;
use crate::schema::article_revisions;
use crate::site::system_page;
use crate::state::State;
use crate::web::{Resource, ResponseFuture};
use super::diff_resource;
use super::pagination::Pagination;
use super::TemporaryRedirectResource;
const DEFAULT_LIMIT: i32 = 30;
type BoxResource = Box<Resource + Sync + Send>;
type BoxResource = Box<dyn Resource + Sync + Send>;
#[derive(Clone)]
pub struct ChangesLookup {
state: State,
show_authors: bool,
}
#[derive(Serialize, Deserialize, Default)]
@ -38,8 +38,16 @@ pub struct QueryParameters {
impl QueryParameters {
pub fn pagination(self, pagination: Pagination<i32>) -> Self {
Self {
after: if let Pagination::After(x) = pagination { Some(x) } else { None },
before: if let Pagination::Before(x) = pagination { Some(x) } else { None },
after: if let Pagination::After(x) = pagination {
Some(x)
} else {
None
},
before: if let Pagination::Before(x) = pagination {
Some(x)
} else {
None
},
..self
}
}
@ -54,14 +62,18 @@ impl QueryParameters {
pub fn limit(self, limit: i32) -> Self {
Self {
limit: if limit != DEFAULT_LIMIT { Some(limit) } else { None },
limit: if limit != DEFAULT_LIMIT {
Some(limit)
} else {
None
},
..self
}
}
pub fn into_link(self) -> String {
let args = serde_urlencoded::to_string(self).expect("Serializing to String cannot fail");
if args.len() > 0 {
if !args.is_empty() {
format!("?{}", args)
} else {
"_changes".to_owned()
@ -69,14 +81,12 @@ impl QueryParameters {
}
}
fn apply_query_config<'a>(
mut query: article_revisions::BoxedQuery<'a, diesel::sqlite::Sqlite>,
fn apply_query_config(
mut query: article_revisions::BoxedQuery<diesel::sqlite::Sqlite>,
article_id: Option<i32>,
author: Option<String>,
limit: i32,
)
-> article_revisions::BoxedQuery<'a, diesel::sqlite::Sqlite>
{
) -> article_revisions::BoxedQuery<diesel::sqlite::Sqlite> {
use diesel::prelude::*;
if let Some(article_id) = article_id {
@ -91,14 +101,21 @@ fn apply_query_config<'a>(
}
impl ChangesLookup {
pub fn new(state: State) -> ChangesLookup {
Self { state }
pub fn new(state: State, show_authors: bool) -> ChangesLookup {
Self {
state,
show_authors,
}
}
pub fn lookup(&self, query: Option<&str>) -> Box<Future<Item=Option<BoxResource>, Error=::web::Error>> {
pub fn lookup(
&self,
query: Option<&str>,
) -> Box<dyn Future<Item = Option<BoxResource>, Error = crate::web::Error>> {
use super::pagination;
let state = self.state.clone();
let show_authors = self.show_authors;
Box::new(
done((|| {
@ -108,60 +125,87 @@ impl ChangesLookup {
let limit = match params.limit {
None => Ok(DEFAULT_LIMIT),
Some(x) if 1 <= x && x <= 100 => Ok(x),
Some(x) if (1..=100).contains(&x) => Ok(x),
_ => Err("`limit` argument must be in range [1, 100]"),
}?;
Ok((pagination, params.article_id, params.author, limit))
})())
.and_then(move |(pagination, article_id, author, limit)| match pagination {
Pagination::After(x) => {
let author2 = author.clone();
.and_then(move |(pagination, article_id, author, limit)| {
match pagination {
Pagination::After(x) => {
let author2 = author.clone();
Box::new(state.query_article_revision_stubs(move |query| {
use diesel::prelude::*;
Box::new(
state
.query_article_revision_stubs(move |query| {
use diesel::prelude::*;
apply_query_config(query, article_id, author2, limit)
.filter(article_revisions::sequence_number.gt(x))
.order(article_revisions::sequence_number.asc())
}).and_then(move |mut data| {
let extra_element = if data.len() > limit as usize {
data.pop()
} else {
None
};
apply_query_config(query, article_id, author2, limit)
.filter(article_revisions::sequence_number.gt(x))
.order(article_revisions::sequence_number.asc())
})
.and_then(move |mut data| {
let extra_element = if data.len() > limit as usize {
data.pop()
} else {
None
};
let args =
QueryParameters {
after: None,
before: None,
article_id,
author,
limit: None,
}
.limit(limit);
let args = QueryParameters {
after: None,
before: None,
article_id,
author,
limit: None,
}
.limit(limit);
Ok(Some(match extra_element {
Some(x) => Box::new(TemporaryRedirectResource::new(
args
.pagination(Pagination::Before(x.sequence_number))
.into_link()
)) as BoxResource,
None => Box::new(TemporaryRedirectResource::new(
args.into_link()
)) as BoxResource,
}))
})) as Box<Future<Item=Option<BoxResource>, Error=::web::Error>>
},
Pagination::Before(x) => Box::new(finished(Some(Box::new(ChangesResource::new(state, Some(x), article_id, author, limit)) as BoxResource))),
Pagination::None => Box::new(finished(Some(Box::new(ChangesResource::new(state, None, article_id, author, limit)) as BoxResource))),
})
Ok(Some(match extra_element {
Some(x) => Box::new(TemporaryRedirectResource::new(
args.pagination(Pagination::Before(x.sequence_number))
.into_link(),
))
as BoxResource,
None => Box::new(TemporaryRedirectResource::new(
args.into_link(),
))
as BoxResource,
}))
}),
)
as Box<
dyn Future<Item = Option<BoxResource>, Error = crate::web::Error>,
>
}
Pagination::Before(x) => {
Box::new(finished(Some(Box::new(ChangesResource::new(
state,
show_authors,
Some(x),
article_id,
author,
limit,
)) as BoxResource)))
}
Pagination::None => Box::new(finished(Some(Box::new(ChangesResource::new(
state,
show_authors,
None,
article_id,
author,
limit,
))
as BoxResource))),
}
}),
)
}
}
pub struct ChangesResource {
state: State,
show_authors: bool,
before: Option<i32>,
article_id: Option<i32>,
author: Option<String>,
@ -169,8 +213,22 @@ pub struct ChangesResource {
}
impl ChangesResource {
pub fn new(state: State, before: Option<i32>, article_id: Option<i32>, author: Option<String>, limit: i32) -> Self {
Self { state, before, article_id, author, limit }
pub fn new(
state: State,
show_authors: bool,
before: Option<i32>,
article_id: Option<i32>,
author: Option<String>,
limit: i32,
) -> Self {
Self {
state,
show_authors,
before,
article_id,
author,
limit,
}
}
fn query_args(&self) -> QueryParameters {
@ -192,14 +250,15 @@ impl Resource for ChangesResource {
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone()))
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
use chrono::{TimeZone, Local};
use chrono::{Local, TimeZone};
struct Row<'a> {
resource: &'a ChangesResource,
@ -214,11 +273,14 @@ impl Resource for ChangesResource {
title: String,
_latest: bool,
diff_link: Option<String>,
}
impl<'a> Row<'a> {
fn author_link(&self) -> String {
self.resource.query_args()
self.resource
.query_args()
.pagination(Pagination::After(self.sequence_number))
.author(self.author.clone())
.into_link()
@ -231,10 +293,11 @@ impl Resource for ChangesResource {
}
#[derive(BartDisplay)]
#[template="templates/changes.html"]
#[template = "templates/changes.html"]
struct Template<'a> {
resource: &'a ChangesResource,
show_authors: bool,
newer: Option<NavLinks>,
older: Option<NavLinks>,
changes: &'a [Row<'a>],
@ -244,7 +307,7 @@ impl Resource for ChangesResource {
fn subject_clause(&self) -> String {
match self.resource.article_id {
Some(x) => format!(" <a href=\"_by_id/{}\">this article</a>", x),
None => format!(" the wiki"),
None => " the wiki".to_string(),
}
}
@ -253,24 +316,25 @@ impl Resource for ChangesResource {
}
fn all_articles_link(&self) -> Option<String> {
self.resource.article_id.map(|_| {
self.resource.query_args()
.article_id(None)
.into_link()
})
self.resource
.article_id
.map(|_| self.resource.query_args().article_id(None).into_link())
}
fn all_authors_link(&self) -> Option<String> {
self.resource.author.as_ref().map(|_| {
self.resource.query_args()
.author(None)
.into_link()
})
self.resource
.author
.as_ref()
.map(|_| self.resource.query_args().author(None).into_link())
}
}
let (before, article_id, author, limit) =
(self.before.clone(), self.article_id.clone(), self.author.clone(), self.limit);
let (before, article_id, author, limit) = (
self.before,
self.article_id,
self.author.clone(),
self.limit,
);
let data = self.state.query_article_revision_stubs(move |query| {
use diesel::prelude::*;
@ -285,65 +349,89 @@ impl Resource for ChangesResource {
let head = self.head();
Box::new(data.join(head)
.and_then(move |(mut data, head)| {
use std::iter::Iterator;
Box::new(data.join(head).and_then(move |(mut data, head)| {
let extra_element = if data.len() > self.limit as usize {
data.pop()
} else {
None
};
let extra_element = if data.len() > self.limit as usize {
data.pop()
} else {
None
};
let (newer, older) = match self.before {
Some(x) => (
Some(NavLinks {
more: self
.query_args()
.pagination(Pagination::After(x - 1))
.into_link(),
end: self.query_args().pagination(Pagination::None).into_link(),
}),
extra_element.map(|_| NavLinks {
more: self
.query_args()
.pagination(Pagination::Before(data.last().unwrap().sequence_number))
.into_link(),
end: self
.query_args()
.pagination(Pagination::After(0))
.into_link(),
}),
),
None => (
None,
extra_element.map(|_| NavLinks {
more: self
.query_args()
.pagination(Pagination::Before(data.last().unwrap().sequence_number))
.into_link(),
end: self
.query_args()
.pagination(Pagination::After(0))
.into_link(),
}),
),
};
let (newer, older) = match self.before {
Some(x) => (
Some(NavLinks {
more: self.query_args().pagination(Pagination::After(x-1)).into_link(),
end: self.query_args().pagination(Pagination::None).into_link(),
}),
extra_element.map(|_| NavLinks {
more: self.query_args()
.pagination(Pagination::Before(data.last().unwrap().sequence_number))
.into_link(),
end: self.query_args().pagination(Pagination::After(0)).into_link(),
})
),
None => (
None,
extra_element.map(|_| NavLinks {
more: self.query_args()
.pagination(Pagination::Before(data.last().unwrap().sequence_number))
.into_link(),
end: self.query_args().pagination(Pagination::After(0)).into_link(),
}),
),
};
let changes = &data
.into_iter()
.map(|x| Row {
resource: &self,
sequence_number: x.sequence_number,
article_id: x.article_id,
revision: x.revision,
created: Local.from_utc_datetime(&x.created).to_rfc2822(),
author: x.author,
_slug: x.slug,
title: x.title,
_latest: x.latest,
diff_link: if x.revision > 1 {
Some(format!(
"_diff/{}?{}",
x.article_id,
diff_resource::QueryParameters::new(
x.revision as u32 - 1,
x.revision as u32,
)
))
} else {
None
},
})
.collect::<Vec<_>>();
let changes = &data.into_iter().map(|x| {
Row {
Ok(head.with_body(
system_page(
None, // Hmm, should perhaps accept `base` as argument
"Changes",
Template {
resource: &self,
sequence_number: x.sequence_number,
article_id: x.article_id,
revision: x.revision,
created: Local.from_utc_datetime(&x.created).to_rfc2822(),
author: x.author,
_slug: x.slug,
title: x.title,
_latest: x.latest,
}
}).collect::<Vec<_>>();
Ok(head
.with_body(Layout {
base: None, // Hmm, should perhaps accept `base` as argument
title: "Changes",
body: &Template {
resource: &self,
newer,
older,
changes
},
}.to_string()))
}))
show_authors: self.show_authors,
newer,
older,
changes,
},
)
.to_string(),
))
}))
}
}

View file

@ -0,0 +1,208 @@
use std::fmt;
use futures::future::done;
use futures::{self, Future};
use hyper::header::ContentType;
use hyper::server::*;
use crate::mimes::*;
use crate::models::ArticleRevision;
use crate::site::Layout;
use crate::state::State;
use crate::theme;
use crate::web::{Resource, ResponseFuture};
use super::changes_resource;
use super::pagination::Pagination;
type BoxResource = Box<dyn Resource + Sync + Send>;
#[derive(Clone)]
pub struct DiffLookup {
state: State,
}
#[derive(Serialize, Deserialize)]
pub struct QueryParameters {
from: u32,
to: u32,
}
impl QueryParameters {
pub fn new(from: u32, to: u32) -> QueryParameters {
QueryParameters { from, to }
}
}
impl fmt::Display for QueryParameters {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(&serde_urlencoded::to_string(self).expect("Serializing to String cannot fail"))
}
}
impl DiffLookup {
pub fn new(state: State) -> DiffLookup {
Self { state }
}
pub fn lookup(
&self,
article_id: u32,
query: Option<&str>,
) -> Box<dyn Future<Item = Option<BoxResource>, Error = crate::web::Error>> {
let state = self.state.clone();
Box::new(
done(serde_urlencoded::from_str(query.unwrap_or("")).map_err(Into::into))
.and_then(move |params: QueryParameters| {
let from = state.get_article_revision(article_id as i32, params.from as i32);
let to = state.get_article_revision(article_id as i32, params.to as i32);
from.join(to)
})
.and_then(move |(from, to)| match (from, to) {
(Some(from), Some(to)) => {
Ok(Some(Box::new(DiffResource::new(from, to)) as BoxResource))
}
_ => Ok(None),
}),
)
}
}
pub struct DiffResource {
from: ArticleRevision,
to: ArticleRevision,
}
impl DiffResource {
pub fn new(from: ArticleRevision, to: ArticleRevision) -> Self {
assert_eq!(from.article_id, to.article_id);
Self { from, to }
}
}
impl Resource for DiffResource {
fn allow(&self) -> Vec<hyper::Method> {
use hyper::Method::*;
vec![Options, Head, Get]
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
#[derive(BartDisplay)]
#[template = "templates/diff.html"]
struct Template<'a> {
consecutive: bool,
article_id: u32,
author: Option<&'a str>,
author_link: &'a str,
article_history_link: &'a str,
from_link: &'a str,
to_link: &'a str,
title: &'a [Diff<char>],
lines: &'a [Diff<&'a str>],
}
#[derive(Default)]
struct Diff<T: fmt::Display> {
removed: Option<T>,
same: Option<T>,
added: Option<T>,
}
let head = self.head();
Box::new(head.and_then(move |head| {
let consecutive = self.to.revision - self.from.revision == 1;
let author = match consecutive {
true => self.to.author.as_deref(),
false => None,
};
let author_link = &format!(
"_changes{}",
changes_resource::QueryParameters::default()
.author(author.map(|x| x.to_owned()))
.pagination(Pagination::After(self.from.sequence_number))
.into_link()
);
let article_history_link = &format!(
"_changes{}",
changes_resource::QueryParameters::default()
.article_id(Some(self.from.article_id))
.pagination(Pagination::After(self.from.sequence_number))
.into_link()
);
let title = &diff::chars(&self.from.title, &self.to.title)
.into_iter()
.map(|x| match x {
diff::Result::Left(x) => Diff {
removed: Some(x),
..Default::default()
},
diff::Result::Both(x, _) => Diff {
same: Some(x),
..Default::default()
},
diff::Result::Right(x) => Diff {
added: Some(x),
..Default::default()
},
})
.collect::<Vec<_>>();
let lines = &diff::lines(&self.from.body, &self.to.body)
.into_iter()
.map(|x| match x {
diff::Result::Left(x) => Diff {
removed: Some(x),
..Default::default()
},
diff::Result::Both(x, _) => Diff {
same: Some(x),
..Default::default()
},
diff::Result::Right(x) => Diff {
added: Some(x),
..Default::default()
},
})
.collect::<Vec<_>>();
Ok(head.with_body(
Layout {
base: Some("../"), // Hmm, should perhaps accept `base` as argument
title: "Difference",
theme: theme::theme_from_str_hash("Difference"),
body: &Template {
consecutive,
article_id: self.from.article_id as u32,
author,
author_link,
article_history_link,
from_link: &format!(
"_revisions/{}/{}",
self.from.article_id, self.from.revision
),
to_link: &format!("_revisions/{}/{}", self.to.article_id, self.to.revision),
title,
lines,
},
}
.to_string(),
))
}))
}
}

View file

@ -0,0 +1,47 @@
use futures::{self, Future};
use hyper::header::ContentType;
use hyper::server::*;
use crate::mimes::*;
use crate::site::system_page;
use crate::web::{Resource, ResponseFuture};
pub struct HtmlResource {
base: Option<&'static str>,
title: &'static str,
html_body: &'static str,
}
impl HtmlResource {
pub fn new(base: Option<&'static str>, title: &'static str, html_body: &'static str) -> Self {
HtmlResource {
base,
title,
html_body,
}
}
}
impl Resource for HtmlResource {
fn allow(&self) -> Vec<hyper::Method> {
use hyper::Method::*;
vec![Options, Head, Get]
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
let head = self.head();
Box::new(head.and_then(move |head| {
Ok(head.with_body(system_page(self.base, self.title, self.html_body).to_string()))
}))
}
}

View file

@ -1,19 +1,25 @@
pub mod pagination;
mod article_redirect_resource;
mod article_revision_resource;
mod about_resource;
mod article_resource;
mod article_revision_resource;
mod changes_resource;
mod diff_resource;
mod html_resource;
mod new_article_resource;
mod read_only_resource;
mod search_resource;
mod sitemap_resource;
mod temporary_redirect_resource;
pub use self::article_redirect_resource::ArticleRedirectResource;
pub use self::article_revision_resource::ArticleRevisionResource;
pub use self::about_resource::AboutResource;
pub use self::article_resource::ArticleResource;
pub use self::article_revision_resource::ArticleRevisionResource;
pub use self::changes_resource::{ChangesLookup, ChangesResource};
pub use self::diff_resource::{DiffLookup, DiffResource};
pub use self::html_resource::HtmlResource;
pub use self::new_article_resource::NewArticleResource;
pub use self::read_only_resource::ReadOnlyResource;
pub use self::search_resource::SearchLookup;
pub use self::sitemap_resource::SitemapResource;
pub use self::temporary_redirect_resource::TemporaryRedirectResource;

View file

@ -1,16 +1,15 @@
use futures::{self, Future};
use hyper;
use hyper::header::ContentType;
use hyper::server::*;
use serde_json;
use serde_urlencoded;
use assets::ScriptJs;
use mimes::*;
use rendering::render_markdown;
use site::Layout;
use state::State;
use web::{Resource, ResponseFuture};
use hyper::header::{ContentType, Location};
use hyper::server::*;
use crate::assets::ScriptJs;
use crate::mimes::*;
use crate::rendering::render_markdown;
use crate::site::Layout;
use crate::state::State;
use crate::theme::{self, Theme};
use crate::web::{Resource, ResponseFuture};
const NEW: &str = "NEW";
@ -27,11 +26,20 @@ fn title_from_slug(slug: &str) -> String {
pub struct NewArticleResource {
state: State,
slug: Option<String>,
edit: bool,
}
#[derive(Deserialize)]
struct CreateArticle {
base_revision: String,
title: String,
body: String,
theme: Option<Theme>,
}
impl NewArticleResource {
pub fn new(state: State, slug: Option<String>) -> Self {
Self { state, slug }
pub fn new(state: State, slug: Option<String>, edit: bool) -> Self {
Self { state, slug, edit }
}
}
@ -42,15 +50,22 @@ impl Resource for NewArticleResource {
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::NotFound)
.with_header(ContentType(TEXT_HTML.clone()))
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::NotFound)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
// TODO Remove duplication with article_resource.rs:
struct SelectableTheme {
theme: Theme,
selected: bool,
}
#[derive(BartDisplay)]
#[template="templates/article.html"]
#[template = "templates/article.html"]
struct Template<'a> {
revision: &'a str,
last_updated: Option<&'a str>,
@ -60,53 +75,56 @@ impl Resource for NewArticleResource {
title: &'a str,
raw: &'a str,
rendered: &'a str,
script_js_checksum: &'a str,
themes: &'a [SelectableTheme],
}
impl<'a> Template<'a> {
fn script_js(&self) -> &'static str {
ScriptJs::resource_name()
}
}
let title = self.slug.as_ref()
let title = self
.slug
.as_ref()
.map_or("".to_owned(), |x| title_from_slug(x));
Box::new(self.head()
.and_then(move |head| {
Ok(head
.with_body(Layout {
base: None, // Hmm, should perhaps accept `base` as argument
Box::new(self.head().and_then(move |head| {
Ok(head.with_body(
Layout {
base: None, // Hmm, should perhaps accept `base` as argument
title: &title,
theme: theme::Theme::Gray,
body: &Template {
revision: NEW,
last_updated: None,
edit: self.edit,
cancel_url: self.slug.as_deref(),
title: &title,
body: &Template {
revision: NEW,
last_updated: None,
// Implicitly start in edit-mode when no slug is given. This
// currently directly corresponds to the /_new endpoint
edit: self.slug.is_none(),
cancel_url: self.slug.as_ref().map(|x| &**x),
title: &title,
raw: "",
rendered: EMPTY_ARTICLE_MESSAGE,
script_js_checksum: ScriptJs::checksum(),
},
}.to_string()))
}))
raw: "",
rendered: EMPTY_ARTICLE_MESSAGE,
themes: &theme::THEMES
.iter()
.map(|&x| SelectableTheme {
theme: x,
selected: false,
})
.collect::<Vec<_>>(),
},
}
.to_string(),
))
}))
}
fn put(self: Box<Self>, body: hyper::Body, identity: Option<String>) -> ResponseFuture {
// TODO Check incoming Content-Type
// TODO Refactor? Reduce duplication with ArticleResource::put?
use chrono::{TimeZone, Local};
use chrono::{Local, TimeZone};
use futures::Stream;
#[derive(Deserialize)]
struct CreateArticle {
base_revision: String,
title: String,
body: String,
}
#[derive(BartDisplay)]
#[template="templates/article_contents.html"]
#[template = "templates/article_contents.html"]
struct Template<'a> {
title: &'a str,
rendered: String,
@ -118,44 +136,92 @@ impl Resource for NewArticleResource {
article_id: i32,
revision: i32,
title: &'a str,
body: &'a str,
theme: Theme,
rendered: &'a str,
last_updated: &'a str,
}
Box::new(body
.concat2()
.map_err(Into::into)
.and_then(|body| {
serde_urlencoded::from_bytes(&body)
.map_err(Into::into)
})
.and_then(move |arg: CreateArticle| {
if arg.base_revision != NEW {
unimplemented!("Version update conflict");
}
self.state.create_article(self.slug.clone(), arg.title, arg.body, identity)
})
.and_then(|updated| {
futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(APPLICATION_JSON.clone()))
.with_body(serde_json::to_string(&PutResponse {
slug: &updated.slug,
article_id: updated.article_id,
revision: updated.revision,
title: &updated.title,
rendered: &Template {
title: &updated.title,
rendered: render_markdown(&updated.body),
}.to_string(),
last_updated: &super::article_resource::last_updated(
updated.article_id,
&Local.from_utc_datetime(&updated.created),
updated.author.as_ref().map(|x| &**x)
),
}).expect("Should never fail"))
)
})
Box::new(
body.concat2()
.map_err(Into::into)
.and_then(|body| serde_urlencoded::from_bytes(&body).map_err(Into::into))
.and_then(move |arg: CreateArticle| {
if arg.base_revision != NEW {
unimplemented!("Version update conflict");
}
let theme = arg.theme.unwrap_or_else(theme::random);
self.state.create_article(
self.slug.clone(),
arg.title,
arg.body,
identity,
theme,
)
})
.and_then(|updated| {
futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(APPLICATION_JSON.clone()))
.with_body(
serde_json::to_string(&PutResponse {
slug: &updated.slug,
article_id: updated.article_id,
revision: updated.revision,
title: &updated.title,
body: &updated.body,
theme: updated.theme,
rendered: &Template {
title: &updated.title,
rendered: render_markdown(&updated.body),
}
.to_string(),
last_updated: &super::article_resource::last_updated(
updated.article_id,
&Local.from_utc_datetime(&updated.created),
updated.author.as_deref(),
),
})
.expect("Should never fail"),
),
)
}),
)
}
fn post(self: Box<Self>, body: hyper::Body, identity: Option<String>) -> ResponseFuture {
// TODO Check incoming Content-Type
// TODO Refactor? Reduce duplication with ArticleResource::put?
use futures::Stream;
Box::new(
body.concat2()
.map_err(Into::into)
.and_then(|body| serde_urlencoded::from_bytes(&body).map_err(Into::into))
.and_then(move |arg: CreateArticle| {
if arg.base_revision != NEW {
unimplemented!("Version update conflict");
}
let theme = arg.theme.unwrap_or_else(theme::random);
self.state.create_article(
self.slug.clone(),
arg.title,
arg.body,
identity,
theme,
)
})
.and_then(|updated| {
futures::finished(
Response::new()
.with_status(hyper::StatusCode::SeeOther)
.with_header(ContentType(TEXT_PLAIN.clone()))
.with_header(Location::new(updated.link().to_owned()))
.with_body("See other"),
)
}),
)
}
}

View file

@ -8,15 +8,11 @@ pub struct Error;
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(f, "{}", (self as &error::Error).description())
write!(f, "`after` and `before` are mutually exclusive")
}
}
impl error::Error for Error {
fn description(&self) -> &str {
"`after` and `before` are mutually exclusive"
}
}
impl error::Error for Error {}
#[derive(Deserialize)]
struct PaginationStruct<T> {
@ -37,16 +33,16 @@ impl<T> PaginationStruct<T> {
(Some(x), None) => Ok(Pagination::After(x)),
(None, Some(x)) => Ok(Pagination::Before(x)),
(None, None) => Ok(Pagination::None),
_ => Err(Error)
_ => Err(Error),
}
}
}
pub fn _from_str<'a, T: serde::Deserialize<'a>>(s: &'a str) -> Result<Pagination<T>, Error> {
let pagination: PaginationStruct<T> = serde_urlencoded::from_str(s).map_err(|_| Error)?; // TODO Proper error reporting
Ok(pagination.into_enum()?)
pagination.into_enum()
}
pub fn from_fields<T>(after: Option<T>, before: Option<T>) -> Result<Pagination<T>, Error> {
Ok(PaginationStruct { after, before }.into_enum()?)
PaginationStruct { after, before }.into_enum()
}

View file

@ -0,0 +1,38 @@
use futures::Future;
use hyper::header::{CacheControl, CacheDirective, ContentLength, ContentType};
use hyper::server::*;
use hyper::StatusCode;
use crate::web::{Resource, ResponseFuture};
#[allow(unused)]
pub struct ReadOnlyResource {
pub content_type: ::hyper::mime::Mime,
pub body: Vec<u8>,
}
impl Resource for ReadOnlyResource {
fn allow(&self) -> Vec<::hyper::Method> {
use ::hyper::Method::*;
vec![Options, Head, Get]
}
fn head(&self) -> ResponseFuture {
Box::new(::futures::finished(
Response::new()
.with_status(StatusCode::Ok)
.with_header(ContentType(self.content_type.clone()))
.with_header(CacheControl(vec![
CacheDirective::MustRevalidate,
CacheDirective::NoStore,
])),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
Box::new(self.head().map(move |head| {
head.with_header(ContentLength(self.body.len() as u64))
.with_body(self.body.clone())
}))
}
}

View file

@ -1,20 +1,18 @@
use futures::{self, Future};
use hyper;
use hyper::header::{Accept, ContentType};
use hyper::server::*;
use serde_json;
use serde_urlencoded;
use mimes::*;
use models;
use site::Layout;
use state::State;
use web::{Resource, ResponseFuture};
use crate::mimes::*;
use crate::models::SearchResult;
use crate::site::system_page;
use crate::state::State;
use crate::web::{Resource, ResponseFuture};
const DEFAULT_LIMIT: u32 = 10;
const DEFAULT_SNIPPET_SIZE: u32 = 8;
const DEFAULT_SNIPPET_SIZE: u32 = 30;
type BoxResource = Box<Resource + Sync + Send>;
type BoxResource = Box<dyn Resource + Sync + Send>;
#[derive(Serialize, Deserialize, Default)]
pub struct QueryParameters {
@ -34,21 +32,29 @@ impl QueryParameters {
pub fn limit(self, limit: u32) -> Self {
Self {
limit: if limit != DEFAULT_LIMIT { Some(limit) } else { None },
limit: if limit != DEFAULT_LIMIT {
Some(limit)
} else {
None
},
..self
}
}
pub fn snippet_size(self, snippet_size: u32) -> Self {
Self {
snippet_size: if snippet_size != DEFAULT_SNIPPET_SIZE { Some(snippet_size) } else { None },
snippet_size: if snippet_size != DEFAULT_SNIPPET_SIZE {
Some(snippet_size)
} else {
None
},
..self
}
}
pub fn into_link(self) -> String {
let args = serde_urlencoded::to_string(self).expect("Serializing to String cannot fail");
if args.len() > 0 {
if !args.is_empty() {
format!("_search?{}", args)
} else {
"_search".to_owned()
@ -66,18 +72,16 @@ impl SearchLookup {
Self { state }
}
pub fn lookup(&self, query: Option<&str>) -> Result<Option<BoxResource>, ::web::Error> {
pub fn lookup(&self, query: Option<&str>) -> Result<Option<BoxResource>, crate::web::Error> {
let args: QueryParameters = serde_urlencoded::from_str(query.unwrap_or(""))?;
Ok(Some(Box::new(
SearchResource::new(
self.state.clone(),
args.q,
args.limit.unwrap_or(DEFAULT_LIMIT),
args.offset.unwrap_or(0),
args.snippet_size.unwrap_or(DEFAULT_SNIPPET_SIZE),
)
)))
Ok(Some(Box::new(SearchResource::new(
self.state.clone(),
args.q,
args.limit.unwrap_or(DEFAULT_LIMIT),
args.offset.unwrap_or(0),
args.snippet_size.unwrap_or(DEFAULT_SNIPPET_SIZE),
))))
}
}
@ -98,8 +102,21 @@ pub enum ResponseType {
}
impl SearchResource {
pub fn new(state: State, query: Option<String>, limit: u32, offset: u32, snippet_size: u32) -> Self {
Self { state, response_type: ResponseType::Html, query, limit, offset, snippet_size }
pub fn new(
state: State,
query: Option<String>,
limit: u32,
offset: u32,
snippet_size: u32,
) -> Self {
Self {
state,
response_type: ResponseType::Html,
query,
limit,
offset,
snippet_size,
}
}
fn query_args(&self) -> QueryParameters {
@ -107,9 +124,9 @@ impl SearchResource {
q: self.query.clone(),
..QueryParameters::default()
}
.offset(self.offset)
.limit(self.limit)
.snippet_size(self.snippet_size)
.offset(self.offset)
.limit(self.limit)
.snippet_size(self.snippet_size)
}
}
@ -126,21 +143,24 @@ impl Resource for SearchResource {
self.response_type = match accept.first() {
Some(&QualityItem { item: ref mime, .. })
if mime.type_() == mime::APPLICATION && mime.subtype() == mime::JSON
=> ResponseType::Json,
if mime.type_() == mime::APPLICATION && mime.subtype() == mime::JSON =>
{
ResponseType::Json
}
_ => ResponseType::Html,
};
}
fn head(&self) -> ResponseFuture {
let content_type = match &self.response_type {
&ResponseType::Json => ContentType(APPLICATION_JSON.clone()),
&ResponseType::Html => ContentType(TEXT_HTML.clone()),
let content_type = match self.response_type {
ResponseType::Json => ContentType(APPLICATION_JSON.clone()),
ResponseType::Html => ContentType(TEXT_HTML.clone()),
};
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(content_type)
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(content_type),
))
}
@ -148,93 +168,81 @@ impl Resource for SearchResource {
#[derive(Serialize)]
struct JsonResponse<'a> {
query: &'a str,
hits: &'a [models::SearchResult],
hits: &'a [SearchResult],
prev: Option<String>,
next: Option<String>,
}
struct Hit<'a> {
index: usize,
slug: &'a str,
title: &'a str,
snippet: &'a str,
}
impl<'a> Hit<'a> {
fn link(&self) -> &'a str {
if self.slug == "" {
"."
} else {
self.slug
}
}
}
#[derive(BartDisplay)]
#[template="templates/search.html"]
#[template = "templates/search.html"]
struct Template<'a> {
query: &'a str,
hits: &'a [Hit<'a>],
hits: &'a [(usize, &'a SearchResult)],
prev: Option<String>,
next: Option<String>,
}
// TODO: Show a search "front page" when no query is given:
let query = self.query.as_ref().map(|x| x.clone()).unwrap_or("".to_owned());
let query = self
.query
.as_ref()
.cloned()
.unwrap_or_else(|| "".to_owned());
let data = self.state.search_query(query, (self.limit + 1) as i32, self.offset as i32, self.snippet_size as i32);
let data = self.state.search_query(
query,
(self.limit + 1) as i32,
self.offset as i32,
self.snippet_size as i32,
);
let head = self.head();
Box::new(data.join(head)
.and_then(move |(mut data, head)| {
let prev = if self.offset > 0 {
Some(self.query_args()
Box::new(data.join(head).and_then(move |(mut data, head)| {
let prev = if self.offset > 0 {
Some(
self.query_args()
.offset(self.offset.saturating_sub(self.limit))
.into_link()
)
} else {
None
};
.into_link(),
)
} else {
None
};
let next = if data.len() > self.limit as usize {
data.pop();
Some(self.query_args()
let next = if data.len() > self.limit as usize {
data.pop();
Some(
self.query_args()
.offset(self.offset + self.limit)
.into_link()
)
} else {
None
};
.into_link(),
)
} else {
None
};
match &self.response_type {
&ResponseType::Json => Ok(head
.with_body(serde_json::to_string(&JsonResponse {
query: self.query.as_ref().map(|x| &**x).unwrap_or(""),
hits: &data,
match self.response_type {
ResponseType::Json => Ok(head.with_body(
serde_json::to_string(&JsonResponse {
query: self.query.as_deref().unwrap_or(""),
hits: &data,
prev,
next,
})
.expect("Should never fail"),
)),
ResponseType::Html => Ok(head.with_body(
system_page(
None, // Hmm, should perhaps accept `base` as argument
"Search",
&Template {
query: self.query.as_deref().unwrap_or(""),
hits: &data.iter().enumerate().collect::<Vec<_>>(),
prev,
next,
}).expect("Should never fail"))
),
&ResponseType::Html => Ok(head
.with_body(Layout {
base: None, // Hmm, should perhaps accept `base` as argument
title: "Search",
body: &Template {
query: self.query.as_ref().map(|x| &**x).unwrap_or(""),
hits: &data.iter()
.enumerate()
.map(|(i, result)| Hit {
index: i,
slug: &result.slug,
title: &result.title,
snippet: &result.snippet,
})
.collect::<Vec<_>>(),
prev,
next,
},
}.to_string())),
}
}))
},
)
.to_string(),
)),
}
}))
}
}

View file

@ -1,12 +1,13 @@
use futures::{self, Future};
use hyper;
use hyper::header::ContentType;
use hyper::server::*;
use mimes::*;
use site::Layout;
use state::State;
use web::{Resource, ResponseFuture};
use crate::mimes::*;
use crate::models::ArticleRevisionStub;
use crate::site::system_page;
use crate::state::State;
use crate::web::{Resource, ResponseFuture};
pub struct SitemapResource {
state: State,
@ -25,44 +26,34 @@ impl Resource for SitemapResource {
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone()))
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::Ok)
.with_header(ContentType(TEXT_HTML.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
#[derive(BartDisplay)]
#[template="templates/sitemap.html"]
#[template = "templates/sitemap.html"]
struct Template<'a> {
articles: &'a [ArticleReference],
}
struct ArticleReference {
link: String,
title: String,
articles: &'a [ArticleRevisionStub],
}
let data = self.state.get_latest_article_revision_stubs();
let head = self.head();
Box::new(data.join(head)
.and_then(move |(articles, head)| {
use std::iter::Iterator;
let articles = &articles.into_iter().map(|x| {
ArticleReference {
link: if x.slug.is_empty() { ".".to_owned() } else { x.slug },
title: x.title,
}
}).collect::<Vec<_>>();
Ok(head
.with_body(Layout {
base: None, // Hmm, should perhaps accept `base` as argument
title: "Sitemap",
body: &Template { articles },
}.to_string()))
}))
Box::new(data.join(head).and_then(move |(articles, head)| {
Ok(head.with_body(
system_page(
None, // Hmm, should perhaps accept `base` as argument
"Sitemap",
Template {
articles: &articles,
},
)
.to_string(),
))
}))
}
}

View file

@ -1,9 +1,9 @@
use futures::{self, Future};
use hyper;
use hyper::header::Location;
use hyper::server::*;
use web::{Resource, ResponseFuture};
use crate::web::{Resource, ResponseFuture};
pub struct TemporaryRedirectResource {
location: String,
@ -13,6 +13,20 @@ impl TemporaryRedirectResource {
pub fn new(location: String) -> Self {
Self { location }
}
pub fn from_slug<S: AsRef<str>>(slug: S, edit: bool) -> Self {
let base = if slug.as_ref().is_empty() {
"."
} else {
slug.as_ref()
};
let tail = if edit { "?edit" } else { "" };
Self {
location: format!("{}{}", base, tail),
}
}
}
impl Resource for TemporaryRedirectResource {
@ -22,25 +36,25 @@ impl Resource for TemporaryRedirectResource {
}
fn head(&self) -> ResponseFuture {
Box::new(futures::finished(Response::new()
.with_status(hyper::StatusCode::TemporaryRedirect)
.with_header(Location::new(self.location.clone()))
Box::new(futures::finished(
Response::new()
.with_status(hyper::StatusCode::TemporaryRedirect)
.with_header(Location::new(self.location.clone())),
))
}
fn get(self: Box<Self>) -> ResponseFuture {
Box::new(self.head()
.and_then(move |head| {
Ok(head
.with_body(format!("Moved to {}", self.location)))
}))
Box::new(
self.head()
.and_then(move |head| Ok(head.with_body(format!("Moved to {}", self.location)))),
)
}
fn put(self: Box<Self>, _body: hyper::Body, _identity: Option<String>) -> ResponseFuture {
Box::new(self.head()
.and_then(move |head| {
Ok(head
.with_body(format!("Moved to {}", self.location)))
}))
self.get()
}
fn post(self: Box<Self>, _body: hyper::Body, _identity: Option<String>) -> ResponseFuture {
self.get()
}
}

View file

@ -4,17 +4,20 @@
use std::fmt;
use futures::{self, Future};
use hyper::header::{Accept, ContentType};
use hyper::header::{Accept, ContentType, Server};
use hyper::mime;
use hyper::server::*;
use hyper;
use assets::{StyleCss, SearchJs};
use web::Lookup;
use wiki_lookup::WikiLookup;
use crate::assets::{SearchJs, StyleCss, ThemesCss};
use crate::build_config;
use crate::theme;
use crate::web::Lookup;
use crate::wiki_lookup::WikiLookup;
lazy_static! {
static ref TEXT_HTML: mime::Mime = "text/html;charset=utf-8".parse().unwrap();
static ref SERVER: Server = Server::new(build_config::HTTP_SERVER.as_str());
}
header! { (XIdentity, "X-Identity") => [String] }
@ -24,16 +27,52 @@ header! { (XIdentity, "X-Identity") => [String] }
pub struct Layout<'a, T: 'a + fmt::Display> {
pub base: Option<&'a str>,
pub title: &'a str,
pub body: &'a T,
pub theme: theme::Theme,
pub body: T,
}
impl<'a, T: 'a + fmt::Display> Layout<'a, T> {
pub fn style_css_checksum(&self) -> &str {
StyleCss::checksum()
pub fn themes_css(&self) -> &str {
ThemesCss::resource_name()
}
pub fn style_css(&self) -> &str {
StyleCss::resource_name()
}
pub fn search_js(&self) -> &str {
SearchJs::resource_name()
}
pub fn search_js_checksum(&self) -> &str {
SearchJs::checksum()
pub fn project_name(&self) -> &str {
build_config::PROJECT_NAME
}
pub fn version(&self) -> &str {
build_config::VERSION.as_str()
}
}
#[derive(BartDisplay)]
#[template = "templates/system_page_layout.html"]
pub struct SystemPageLayout<'a, T: 'a + fmt::Display> {
title: &'a str,
html_body: T,
}
pub fn system_page<'a, T>(
base: Option<&'a str>,
title: &'a str,
body: T,
) -> Layout<'a, SystemPageLayout<'a, T>>
where
T: 'a + fmt::Display,
{
Layout {
base,
title,
theme: theme::theme_from_str_hash(title),
body: SystemPageLayout {
title,
html_body: body,
},
}
}
@ -52,41 +91,39 @@ pub struct Site {
impl Site {
pub fn new(root: WikiLookup, trust_identity: bool) -> Site {
Site { root, trust_identity }
Site {
root,
trust_identity,
}
}
fn not_found(base: Option<&str>) -> Response {
Response::new()
.with_header(ContentType(TEXT_HTML.clone()))
.with_body(Layout {
base: base,
title: "Not found",
body: &NotFound,
}.to_string())
.with_body(system_page(base, "Not found", NotFound).to_string())
.with_status(hyper::StatusCode::NotFound)
}
fn internal_server_error(base: Option<&str>, err: Box<::std::error::Error + Send + Sync>) -> Response {
fn internal_server_error(
base: Option<&str>,
err: Box<dyn ::std::error::Error + Send + Sync>,
) -> Response {
eprintln!("Internal Server Error:\n{:#?}", err);
Response::new()
.with_header(ContentType(TEXT_HTML.clone()))
.with_body(Layout {
base,
title: "Internal server error",
body: &InternalServerError,
}.to_string())
.with_body(system_page(base, "Internal server error", InternalServerError).to_string())
.with_status(hyper::StatusCode::InternalServerError)
}
}
fn root_base_from_request_uri(path: &str) -> Option<String> {
assert!(path.starts_with("/"));
assert!(path.starts_with('/'));
let slashes = path[1..].matches('/').count();
match slashes {
0 => None,
n => Some(::std::iter::repeat("../").take(n).collect())
n => Some("../".repeat(n)),
}
}
@ -94,7 +131,7 @@ impl Service for Site {
type Request = Request;
type Response = Response;
type Error = hyper::Error;
type Future = Box<futures::Future<Item = Response, Error = Self::Error>>;
type Future = Box<dyn futures::Future<Item = Response, Error = Self::Error>>;
fn call(&self, req: Request) -> Self::Future {
let (method, uri, _http_version, headers, body) = req.deconstruct();
@ -106,27 +143,31 @@ impl Service for Site {
false => None,
};
let accept_header = headers.get().map(|x: &Accept| x.clone()).unwrap_or(Accept(vec![]));
let accept_header = headers.get().cloned().unwrap_or_else(|| Accept(vec![]));
let base = root_base_from_request_uri(uri.path());
let base2 = base.clone(); // Bah, stupid clone
Box::new(self.root.lookup(uri.path(), uri.query())
.and_then(move |resource| match resource {
Some(mut resource) => {
use hyper::Method::*;
resource.hacky_inject_accept_header(accept_header);
match method {
Options => Box::new(futures::finished(resource.options())),
Head => resource.head(),
Get => resource.get(),
Put => resource.put(body, identity),
_ => Box::new(futures::finished(resource.method_not_allowed()))
Box::new(
self.root
.lookup(uri.path(), uri.query())
.and_then(move |resource| match resource {
Some(mut resource) => {
use hyper::Method::*;
resource.hacky_inject_accept_header(accept_header);
match method {
Options => Box::new(futures::finished(resource.options())),
Head => resource.head(),
Get => resource.get(),
Put => resource.put(body, identity),
Post => resource.post(body, identity),
_ => Box::new(futures::finished(resource.method_not_allowed())),
}
}
},
None => Box::new(futures::finished(Self::not_found(base.as_ref().map(|x| &**x))))
})
.or_else(move |err| Ok(Self::internal_server_error(base2.as_ref().map(|x| &**x), err)))
None => Box::new(futures::finished(Self::not_found(base.as_deref()))),
})
.or_else(move |err| Ok(Self::internal_server_error(base2.as_deref(), err)))
.map(|response| response.with_header(SERVER.clone())),
)
}
}

File diff suppressed because it is too large Load diff

232
src/theme.rs Normal file
View file

@ -0,0 +1,232 @@
use std::io::Write;
use diesel::backend::Backend;
use diesel::deserialize::{self, FromSql};
use diesel::serialize::{self, Output, ToSql};
use diesel::sql_types::Text;
use diesel::sqlite::Sqlite;
#[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)] // Serde
#[serde(rename_all = "kebab-case")]
#[derive(AsExpression, FromSqlRow)] // Diesel
#[sql_type = "Text"]
pub enum Theme {
Red,
Pink,
Purple,
DeepPurple,
Indigo,
Blue,
LightBlue,
Cyan,
Teal,
Green,
LightGreen,
Lime,
Yellow,
Amber,
Orange,
DeepOrange,
Brown,
Gray,
BlueGray,
}
use self::Theme::*;
forward_display_to_serde!(Theme);
forward_from_str_to_serde!(Theme);
pub const THEMES: [Theme; 19] = [
Red, Pink, Purple, DeepPurple, Indigo, Blue, LightBlue, Cyan, Teal, Green, LightGreen, Lime,
Yellow, Amber, Orange, DeepOrange, Brown, Gray, BlueGray,
];
pub fn theme_from_str_hash(x: &str) -> Theme {
let hash = seahash::hash(x.as_bytes()) as usize;
let choice = hash % THEMES.len();
THEMES[choice]
}
pub fn random() -> Theme {
use rand::Rng;
*rand::thread_rng()
.choose(&THEMES)
.expect("Could only fail for an empty slice")
}
impl ToSql<Text, Sqlite> for Theme {
fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> serialize::Result {
ToSql::<Text, Sqlite>::to_sql(&self.to_string(), out)
}
}
impl FromSql<Text, Sqlite> for Theme {
fn from_sql(value: Option<&<Sqlite as Backend>::RawValue>) -> deserialize::Result<Self> {
// See Diesel's documentation on how to implement FromSql for Sqlite,
// especially with regards to the unsafe conversion below.
// http://docs.diesel.rs/diesel/deserialize/trait.FromSql.html
let text_ptr = <*const str as FromSql<Text, Sqlite>>::from_sql(value)?;
let text = unsafe { &*text_ptr };
text.parse().map_err(Into::into)
}
}
pub struct CssClass(Theme);
impl Theme {
pub fn css_class(self) -> CssClass {
CssClass(self)
}
}
use std::fmt::{self, Display, Formatter};
impl Display for CssClass {
fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
write!(fmt, "theme-{}", self.0)
}
}
#[cfg(test)]
mod test {
use std::error::Error;
use diesel::prelude::*;
use diesel::sql_query;
use diesel::sql_types::Text;
use super::*;
#[test]
fn basic_serialize() {
assert_eq!(serde_plain::to_string(&Theme::Red).unwrap(), "red");
}
#[test]
fn serialize_kebab_case() {
assert_eq!(
serde_plain::to_string(&Theme::LightGreen).unwrap(),
"light-green"
);
}
#[test]
fn serialize_json() {
#[derive(Serialize)]
struct Test {
x: Theme,
}
assert_eq!(
serde_json::to_string(&Test { x: Theme::Red }).unwrap(),
"{\"x\":\"red\"}"
);
}
#[test]
fn deserialize_json() {
#[derive(Deserialize, Debug, PartialEq, Eq)]
struct Test {
x: Theme,
}
assert_eq!(
serde_json::from_str::<Test>("{\"x\":\"red\"}").unwrap(),
Test { x: Theme::Red }
);
}
#[test]
fn serialize_urlencoded() {
#[derive(Serialize)]
struct Test {
x: Theme,
}
assert_eq!(
serde_urlencoded::to_string(&Test { x: Theme::Red }).unwrap(),
"x=red"
);
}
#[test]
fn deserialize_urlencoded() {
#[derive(Deserialize, Debug, PartialEq, Eq)]
struct Test {
x: Theme,
}
assert_eq!(
serde_urlencoded::from_str::<Test>("x=red").unwrap(),
Test { x: Theme::Red }
);
}
#[test]
fn basic_display() {
assert_eq!(&Theme::Red.to_string(), "red");
}
#[test]
fn display_kebab_case() {
assert_eq!(&Theme::LightGreen.to_string(), "light-green");
}
#[test]
fn basic_from_str() {
let indigo: Theme = "indigo".parse().unwrap();
assert_eq!(indigo, Theme::Indigo);
}
#[test]
fn to_number() {
assert_eq!(Theme::Red as i32, 0);
assert_eq!(Theme::LightGreen as i32, 10);
assert_eq!(Theme::BlueGray as i32, 18);
}
#[test]
fn from_str_hash() {
assert_eq!(theme_from_str_hash("Bartefjes"), Theme::Orange);
}
#[test]
fn css_class_display() {
assert_eq!(&Theme::Red.css_class().to_string(), "theme-red");
}
#[test]
fn basic_db_roundtrip() -> Result<(), Box<dyn Error>> {
let conn = SqliteConnection::establish(":memory:")?;
#[derive(QueryableByName, PartialEq, Eq, Debug)]
struct Row {
#[sql_type = "Text"]
theme: Theme,
}
let res = sql_query("SELECT ? as theme")
.bind::<Text, _>(DeepPurple)
.load::<Row>(&conn)?;
assert_eq!(&[Row { theme: DeepPurple }], res.as_slice());
Ok(())
}
#[test]
fn db_invalid_value_gives_error() -> Result<(), Box<dyn Error>> {
let conn = SqliteConnection::establish(":memory:")?;
#[derive(QueryableByName, PartialEq, Eq, Debug)]
struct Row {
#[sql_type = "Text"]
theme: Theme,
}
let res = sql_query("SELECT 'green' as theme").load::<Row>(&conn);
assert!(res.is_ok());
let res = sql_query("SELECT 'blueish-yellow' as theme").load::<Row>(&conn);
assert!(res.is_err());
Ok(())
}
}

View file

@ -1,9 +1,7 @@
use futures;
pub trait Lookup {
type Resource;
type Error;
type Future: futures::Future<Item=Option<Self::Resource>, Error=Self::Error>;
type Future: futures::Future<Item = Option<Self::Resource>, Error = Self::Error>;
fn lookup(&self, path: &str, query: Option<&str>) -> Self::Future;
}

View file

@ -1,5 +1,5 @@
mod resource;
mod lookup;
mod resource;
pub use self::resource::*;
pub use self::lookup::*;
pub use self::resource::*;

View file

@ -1,14 +1,13 @@
use futures;
use hyper::{self, header, mime, server};
use futures::{Future, Stream};
use hyper::server::Response;
use std;
use hyper::{self, header, mime, server};
lazy_static! {
static ref TEXT_PLAIN: mime::Mime = "text/plain;charset=utf-8".parse().unwrap();
}
pub type Error = Box<std::error::Error + Send + Sync>;
pub type ResponseFuture = Box<futures::Future<Item = server::Response, Error = Error>>;
pub type Error = Box<dyn std::error::Error + Send + Sync>;
pub type ResponseFuture = Box<dyn futures::Future<Item = server::Response, Error = Error>>;
pub trait Resource {
fn allow(&self) -> Vec<hyper::Method>;
@ -22,22 +21,24 @@ pub trait Resource {
}
fn put(self: Box<Self>, body: hyper::Body, _identity: Option<String>) -> ResponseFuture
where Self: 'static
where
Self: 'static,
{
use futures::{Future, Stream};
Box::new(
body.fold((), |_, _| -> Result<(), hyper::Error> { Ok(()) })
.map_err(Into::into)
.and_then(move |_| futures::finished(self.method_not_allowed())),
)
}
// TODO Cleanup by moving to the built in never type, !, when it stabilizes
enum Never {};
impl std::convert::From<Never> for hyper::Error {
fn from(_: Never) -> hyper::Error {
panic!()
}
}
Box::new(body
.fold((), |_, _| -> Result<(), Never> { Ok(()) })
.map_err(Into::into)
.and_then(move |_| futures::finished(self.method_not_allowed()))
fn post(self: Box<Self>, body: hyper::Body, _identity: Option<String>) -> ResponseFuture
where
Self: 'static,
{
Box::new(
body.fold((), |_, _| -> Result<(), hyper::Error> { Ok(()) })
.map_err(Into::into)
.and_then(move |_| futures::finished(self.method_not_allowed())),
)
}

View file

@ -2,44 +2,38 @@ use std::borrow::Cow;
use std::collections::HashMap;
use std::str::Utf8Error;
use futures::{Future, finished, failed, done};
use futures::future::FutureResult;
use futures::{done, failed, finished, Future};
use percent_encoding::percent_decode;
use slug::slugify;
use resources::*;
use assets::*;
use state::State;
use web::{Lookup, Resource};
use crate::resources::*;
use crate::state::State;
use crate::web::{Lookup, Resource};
type BoxResource = Box<Resource + Sync + Send>;
type ResourceFn = Box<Fn() -> BoxResource + Sync + Send>;
#[allow(unused)]
use crate::assets::*;
type BoxResource = Box<dyn Resource + Sync + Send>;
type ResourceFn = Box<dyn Fn() -> BoxResource + Sync + Send>;
lazy_static! {
static ref ASSETS_MAP: HashMap<String, ResourceFn> = {
let mut map = HashMap::new();
map.insert(
format!("style-{}.css", StyleCss::checksum()),
Box::new(|| Box::new(StyleCss) as BoxResource) as ResourceFn
);
map.insert(
format!("script-{}.js", ScriptJs::checksum()),
Box::new(|| Box::new(ScriptJs) as BoxResource) as ResourceFn
);
map.insert(
format!("search-{}.js", SearchJs::checksum()),
Box::new(|| Box::new(SearchJs) as BoxResource) as ResourceFn
);
map.insert(
format!("amatic-sc-v9-latin-regular.woff"),
Box::new(|| Box::new(AmaticFont) as BoxResource) as ResourceFn
);
map
static ref LICENSES_MAP: HashMap<&'static str, ResourceFn> = hashmap! {
"bsd-3-clause" => Box::new(|| Box::new(
HtmlResource::new(Some("../"), "The 3-Clause BSD License", include_str!("licenses/bsd-3-clause.html"))
) as BoxResource) as ResourceFn,
"gpl3" => Box::new(|| Box::new(
HtmlResource::new(Some("../"), "GNU General Public License", include_str!("licenses/gpl3.html"))
) as BoxResource) as ResourceFn,
"mit" => Box::new(|| Box::new(
HtmlResource::new(Some("../"), "The MIT License", include_str!("licenses/mit.html"))
) as BoxResource) as ResourceFn,
"mpl2" => Box::new(|| Box::new(
HtmlResource::new(Some("../"), "Mozilla Public License Version 2.0", include_str!("licenses/mpl2.html"))
) as BoxResource) as ResourceFn,
"sil-ofl-1.1" => Box::new(|| Box::new(
HtmlResource::new(Some("../"), "SIL Open Font License", include_str!("licenses/sil-ofl-1.1.html"))
) as BoxResource) as ResourceFn,
};
}
@ -47,6 +41,7 @@ lazy_static! {
pub struct WikiLookup {
state: State,
changes_lookup: ChangesLookup,
diff_lookup: DiffLookup,
search_lookup: SearchLookup,
}
@ -59,7 +54,10 @@ fn split_one(path: &str) -> Result<(Cow<str>, Option<&str>), Utf8Error> {
Ok((head, tail))
}
fn asset_lookup(path: &str) -> FutureResult<Option<BoxResource>, Box<::std::error::Error + Send + Sync>> {
fn map_lookup(
map: &HashMap<&str, ResourceFn>,
path: &str,
) -> FutureResult<Option<BoxResource>, Box<dyn ::std::error::Error + Send + Sync>> {
let (head, tail) = match split_one(path) {
Ok(x) => x,
Err(x) => return failed(x.into()),
@ -69,18 +67,55 @@ fn asset_lookup(path: &str) -> FutureResult<Option<BoxResource>, Box<::std::erro
return finished(None);
}
match ASSETS_MAP.get(head.as_ref()) {
match map.get(head.as_ref()) {
Some(resource_fn) => finished(Some(resource_fn())),
None => finished(None),
}
}
#[allow(unused)]
fn fs_lookup(
root: &str,
path: &str,
) -> FutureResult<Option<BoxResource>, Box<dyn ::std::error::Error + Send + Sync>> {
use std::fs::File;
use std::io::prelude::*;
let extension = path.rsplit_once('.').map(|x| x.1);
let content_type = match extension {
Some("html") => "text/html",
Some("css") => "text/css",
Some("js") => "application/javascript",
Some("woff") => "application/font-woff",
_ => "application/binary",
}
.parse()
.unwrap();
let mut filename = root.to_string();
filename.push_str(path);
let mut f = File::open(&filename).unwrap_or_else(|_| panic!("Not found: {}", filename));
let mut body = Vec::new();
f.read_to_end(&mut body).expect("Unable to read file");
finished(Some(Box::new(ReadOnlyResource { content_type, body })))
}
impl WikiLookup {
pub fn new(state: State) -> WikiLookup {
let changes_lookup = ChangesLookup::new(state.clone());
pub fn new(state: State, show_authors: bool) -> WikiLookup {
let changes_lookup = ChangesLookup::new(state.clone(), show_authors);
let diff_lookup = DiffLookup::new(state.clone());
let search_lookup = SearchLookup::new(state.clone());
WikiLookup { state, changes_lookup, search_lookup }
WikiLookup {
state,
changes_lookup,
diff_lookup,
search_lookup,
}
}
fn revisions_lookup(&self, path: &str, _query: Option<&str>) -> <Self as Lookup>::Future {
@ -98,12 +133,12 @@ impl WikiLookup {
};
Box::new(
self.state.get_article_revision(article_id, revision)
.and_then(|article_revision|
Ok(article_revision.map(move |x| Box::new(
ArticleRevisionResource::new(x)
) as BoxResource))
)
self.state
.get_article_revision(article_id, revision)
.and_then(|article_revision| {
Ok(article_revision
.map(move |x| Box::new(ArticleRevisionResource::new(x)) as BoxResource))
}),
)
}
@ -120,14 +155,27 @@ impl WikiLookup {
Err(_) => return Box::new(finished(None)),
};
Box::new(
self.state.get_article_slug(article_id)
.and_then(|slug|
Ok(slug.map(|slug| Box::new(
TemporaryRedirectResource::new(format!("../{}", slug))
) as BoxResource))
)
)
Box::new(self.state.get_article_slug(article_id).and_then(|slug| {
Ok(slug.map(|slug| {
Box::new(TemporaryRedirectResource::new(format!("../{}", slug))) as BoxResource
}))
}))
}
fn diff_lookup_f(&self, path: &str, query: Option<&str>) -> <Self as Lookup>::Future {
let article_id: u32 = match (|| -> Result<_, <Self as Lookup>::Error> {
let (article_id, tail) = split_one(path)?;
if tail.is_some() {
return Err("Not found".into());
}
Ok(article_id.parse()?)
})() {
Ok(x) => x,
Err(_) => return Box::new(finished(None)),
};
Box::new(self.diff_lookup.lookup(article_id, query))
}
fn reserved_lookup(&self, path: &str, query: Option<&str>) -> <Self as Lookup>::Future {
@ -137,20 +185,30 @@ impl WikiLookup {
};
match (head.as_ref(), tail) {
("_assets", Some(asset)) =>
Box::new(asset_lookup(asset)),
("_by_id", Some(tail)) =>
self.by_id_lookup(tail, query),
("_changes", None) =>
Box::new(self.changes_lookup.lookup(query)),
("_new", None) =>
Box::new(finished(Some(Box::new(NewArticleResource::new(self.state.clone(), None)) as BoxResource))),
("_revisions", Some(tail)) =>
self.revisions_lookup(tail, query),
("_search", None) =>
Box::new(done(self.search_lookup.lookup(query))),
("_sitemap", None) =>
Box::new(finished(Some(Box::new(SitemapResource::new(self.state.clone())) as BoxResource))),
("_about", None) => Box::new(finished(Some(
Box::new(AboutResource::new()) as BoxResource
))),
("_about", Some(license)) => Box::new(map_lookup(&LICENSES_MAP, license)),
#[cfg(feature = "dynamic-assets")]
("_assets", Some(asset)) => Box::new(fs_lookup(
concat!(env!("CARGO_MANIFEST_DIR"), "/assets/"),
asset,
)),
#[cfg(not(feature = "dynamic-assets"))]
("_assets", Some(asset)) => Box::new(map_lookup(&ASSETS_MAP, asset)),
("_by_id", Some(tail)) => self.by_id_lookup(tail, query),
("_changes", None) => Box::new(self.changes_lookup.lookup(query)),
("_diff", Some(tail)) => self.diff_lookup_f(tail, query),
("_new", None) => Box::new(finished(Some(Box::new(NewArticleResource::new(
self.state.clone(),
None,
true,
)) as BoxResource))),
("_revisions", Some(tail)) => self.revisions_lookup(tail, query),
("_search", None) => Box::new(done(self.search_lookup.lookup(query))),
("_sitemap", None) => Box::new(finished(Some(Box::new(SitemapResource::new(
self.state.clone(),
)) as BoxResource))),
_ => Box::new(finished(None)),
}
}
@ -166,42 +224,49 @@ impl WikiLookup {
return Box::new(finished(None));
}
let edit = query == Some("edit");
// Normalize all user-generated slugs:
let slugified_slug = slugify(&slug);
if slugified_slug != slug {
return Box::new(finished(Some(
Box::new(ArticleRedirectResource::new(slugified_slug)) as BoxResource
Box::new(TemporaryRedirectResource::from_slug(slugified_slug, edit)) as BoxResource,
)));
}
let state = self.state.clone();
let edit = query == Some("edit");
let slug = slug.into_owned();
use state::SlugLookup;
Box::new(self.state.lookup_slug(slug.clone())
.and_then(move |x| Ok(Some(match x {
SlugLookup::Miss =>
Box::new(NewArticleResource::new(state, Some(slug))) as BoxResource,
SlugLookup::Hit { article_id, revision } =>
Box::new(ArticleResource::new(state, article_id, revision, edit)) as BoxResource,
SlugLookup::Redirect(slug) =>
Box::new(ArticleRedirectResource::new(slug)) as BoxResource,
})))
)
use crate::state::SlugLookup;
Box::new(self.state.lookup_slug(slug.clone()).and_then(move |x| {
Ok(Some(match x {
SlugLookup::Miss => {
Box::new(NewArticleResource::new(state, Some(slug), edit)) as BoxResource
}
SlugLookup::Hit {
article_id,
revision,
} => {
Box::new(ArticleResource::new(state, article_id, revision, edit)) as BoxResource
}
SlugLookup::Redirect(slug) => {
Box::new(TemporaryRedirectResource::from_slug(slug, edit)) as BoxResource
}
}))
}))
}
}
impl Lookup for WikiLookup {
type Resource = BoxResource;
type Error = Box<::std::error::Error + Send + Sync>;
type Future = Box<Future<Item = Option<Self::Resource>, Error = Self::Error>>;
type Error = Box<dyn ::std::error::Error + Send + Sync>;
type Future = Box<dyn Future<Item = Option<Self::Resource>, Error = Self::Error>>;
fn lookup(&self, path: &str, query: Option<&str>) -> Self::Future {
assert!(path.starts_with("/"));
assert!(path.starts_with('/'));
let path = &path[1..];
if path.starts_with("_") {
if path.starts_with('_') {
self.reserved_lookup(path, query)
} else {
self.article_lookup(path, query)

35
templates/about.html Normal file
View file

@ -0,0 +1,35 @@
<p>This site is running Sausagewiki, a simple, self-contained wiki engine,
version {{version()}}.</p>
<p>Copyright &copy; 2017 Magnus Hovland Hoff.</p>
<p>
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 3 of the License, or (at your option) any later
version.
</p>
<p>
See also <a href="_about/gpl3">the full license text</a> and the
<a href="https://github.com/maghoff/sausagewiki">project home page</a>.
</p>
<p>
Without <a href="https://www.rust-lang.org/en-US/">Rust</a> and
<a href="https://www.sqlite.org/">SQLite</a>, Sausagewiki would never have
materialized. Huge thanks to the creators. Another big thanks for the support,
discussions and testing by the amazing developers at Revolverhuset.
</p>
<p>
Sausagewiki builds on a number of projects, copyright by their respective
copyright holders and distributed under various licenses:
</p>
<table>
<thead><tr><th>Project</th><th>Copyright notice</th><th>License</th></tr></thead>
<tbody>
{{#deps}}
<tr><td>{{#.link}}<a href="{{.}}">{{..name}}</a>{{/.link}}{{^.link}}{{..name}}{{/.link}}</td><td>{{.copyright}}</td><td><a href="_about/{{.license.link()}}">{{.license.name()}}</a></td></tr>
{{/deps}}
</tbody>
</table>

View file

@ -1,16 +1,24 @@
<script src="_assets/script-{{script_js_checksum}}.js" defer></script>
<script src="_assets/{{script_js()}}" defer></script>
<div class="container {{#edit?}}edit{{/edit}}">
<div class="rendered">
{{>article_contents.html}}
</div>
<div class="editor">
<form action="" method="POST">
<form autocomplete="off" id="article-editor" action="" method="POST">
<div class="editor">
<div class="hero">
<header>
<h1><input autocomplete=off type=text name=title value="{{title}}" placeholder="Title"></h1>
<h1><input autocomplete=off type=text name=title value="{{title}}" placeholder="Title" required></h1>
</header>
</div>
<div class="theme-picker">
{{#themes}}
<input autocomplete="off" type="radio" name="theme" value="{{.theme}}"{{#.selected?}} checked{{/.selected}} class="theme-picker--option {{.theme.css_class()}} themed">
{{/themes}}
</div>
<article>
<p>
@ -20,21 +28,34 @@
</p>
</article>
<div class="editor-controls">
{{#cancel_url}}
<a class="cancel" href="{{.}}">Cancel</a>
{{/cancel_url}}
<button type=submit>Save</button>
</div>
</form>
<div class="editor-controls">
{{#edit?}}
<div class="cancel-interaction-group {{#cancel_url}}interaction-group--root--enabled{{/cancel_url}}{{^cancel_url}}interaction-group--root--disabled{{/cancel_url}}">
<a class="interaction-group--enabled button button-cancel cancel" href="{{#cancel_url}}{{.}}{{/cancel_url}}">Cancel</a>
<button class="interaction-group--disabled button button-cancel" disabled>Cancel</a>
</div>
<button class="button button-default" type=submit {{^edit?}}disabled{{/edit}}>Save</button>
{{/edit}}
{{^edit?}}
<div class="cancel-interaction-group interaction-group--root--disabled">
<a class="interaction-group--enabled button button-cancel cancel" href="{{#cancel_url}}{{.}}{{/cancel_url}}">Cancel</a>
<button class="interaction-group--disabled button button-cancel" disabled>Cancel</a>
</div>
<button class="button button-default" type=submit disabled>Save</button>
{{/edit}}
</div>
</form>
</div>
<footer>
<ul class="dense"
><li class="last-updated {{^last_updated}}missing{{/last_updated}}">{{#last_updated}}{{{.}}}{{/last_updated}}</li
><li><a id="openEditor" href="?edit">Edit</a></li
><li><a id="openEditor" href="?edit" rel="nofollow">Edit</a></li
></ul>
{{>footer/items.html}}
</footer>
{{>dialog_prototypes.html}}

View file

@ -1,6 +1,8 @@
<div class="hero">
<header>
<h1>{{title}}</h1>
</header>
</div>
<article>
{{{rendered}}}

View file

@ -1,17 +1,12 @@
<div class="container">
<div class="notice">
<p>
You are viewing an historical version of <a href="{{link_current}}">this article</a>,
authored at {{{timestamp_and_author}}}.
</p>
<p>
{{#diff_link}}See <a href="{{.}}">the changes</a> made for this revision.{{/diff_link}}
{{^diff_link}}This is the first revision of the article.{{/diff_link}}
</p>
</div>
<div class="rendered">
{{>article_contents.html}}
</div>
</div>
<footer>
{{>footer/items.html}}
</footer>
{{{rendered}}}

View file

@ -1,11 +1,5 @@
<div class="container">
<header>
<h1>Changes</h1>
</header>
<article>
<p>
These are the {{^newer}}most recent{{/newer}} changes that have been
These are the {{^newer}}most recent{{/newer}} changes
made to{{{subject_clause()}}}{{#author()}} by {{.}}{{/author()}}.
</p>
@ -23,14 +17,16 @@
<tr>
<th>Article</th>
<th>Updated</th>
<th>Author</th>
{{#show_authors?}}<th>Author</th>{{/show_authors}}
<th></th>
</tr>
{{/changes}}
{{#changes}}
<tr>
<td><a href="_revisions/{{.article_id}}/{{.revision}}">{{.title}}</a></td>
<td>{{.created}}</td>
<td>{{#.author}}<a href="{{..author_link()}}">{{.}}</a>{{/.author}}{{^.author}}<i>Anonymous</i>{{/.author}}</td>
{{#show_authors?}}<td>{{#..author}}<a href="{{...author_link()}}">{{.}}</a>{{/..author}}{{^..author}}<i>Anonymous</i>{{/..author}}</td>{{/show_authors}}
<td>{{#.diff_link}}<a href="{{.}}">change</a>{{/.diff_link}}{{^.diff_link}}new{{/.diff_link}}</td>
</tr>
{{/changes}}
</table>
@ -42,7 +38,3 @@
><li><a rel="last" href="{{.end}}">First changes</a></li
></ul></nav>{{/older}}
{{#changes?}}{{^older}}<p>There are no older changes.</p>{{/older}}{{/changes}}
</article>
</div>
{{>footer/default.html}}

View file

@ -0,0 +1,35 @@
<div class=prototype id=login>
<div class=modal-block>
<div class=popup>
<div class=message>
<p>Your changes could not be saved</p>
<p>Log in and try again</p>
</div>
<div class=btn-row>
<button>Never mind</button>
<a class=primary href='' target=login>Open login page</a>
</div>
</div>
</div>
</div>
<div class=prototype id=alert>
<div class=modal-block>
<div class=popup>
<div class=message></div>
<div class=btn-row><button class=primary>OK</button></div>
</div>
</div>
</div>
<div class=prototype id=confirm-discard>
<div class=modal-block>
<div class=popup>
<div class=message>Discard changes?</div>
<div class=btn-row>
<button class=primary>No</button>
<button data-value=true>Yes</button>
</div>
</div>
</div>
</div>

30
templates/diff.html Normal file
View file

@ -0,0 +1,30 @@
<div class="container">
<div class="hero">
<header>
<h1>{{#title}}{{#.removed}}<span class="removed">{{.}}</span>{{/.removed}}{{#.same}}{{.}}{{/.same}}{{#.added}}<span class="added">{{.}}</span>{{/.added}}{{/title}}</h1>
</header>
</div>
<div class="notice">
<p>
You are viewing the difference between two {{#consecutive?}}consecutive{{/consecutive}}
revisions of <a href="_by_id/{{article_id}}">this article</a>.
{{#author}}This changeset was authored by <a href="{{..author_link}}">{{.}}</a>.{{/author}}
</p>
<p>
See also the <a href="{{article_history_link}}">list of all changes</a> to this article
or the article as it was <a href="{{from_link}}">before</a> and <a href="{{to_link}}">after</a> this change.
</p>
</div>
<article>
<pre class="diff">{{#lines}}{{#.removed}}<span class="removed">{{.}}
</span>{{/.removed}}{{#.same}}<span class="same">{{.}}
</span>{{/.same}}{{#.added}}<span class="added">{{.}}
</span>{{/.added}}{{/lines}}</pre>
</article>
</div>
{{>footer/default.html}}

View file

@ -1,11 +1 @@
<div class="container">
<header>
<h1>Not found</h1>
</header>
<article>
<p>This page was not found.</p>
</article>
</div>
{{>../footer/default.html}}
<p>This page was not found.</p>

View file

@ -1,11 +1 @@
<div class="container">
<header>
<h1>Internal server error</h1>
</header>
<article>
<p>An error has occurred.</p>
</article>
</div>
{{>../footer/default.html}}
<p>An error has occurred.</p>

View file

@ -4,4 +4,4 @@
><li><a href="_sitemap">Sitemap</a></li
><li><a href="_changes">Recent changes</a></li
></ul>
<p>Powered by <a href="https://github.com/maghoff/sausagewiki">Sausagewiki</a></p>
<p>Powered by <a href="_about">Sausagewiki</a></p>

View file

@ -3,11 +3,13 @@
<head>
<title>{{title}}</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
{{#base}}<base href="{{.}}">{{/base}}
<link rel=preload href="_assets/amatic-sc-v9-latin-regular.woff" as=font crossorigin>
<link href="_assets/style-{{style_css_checksum()}}.css" rel="stylesheet">
<link href="_assets/{{themes_css()}}" rel="stylesheet">
<link href="_assets/{{style_css()}}" rel="stylesheet">
<meta name="generator" content="{{project_name()}} {{version()}}" />
</head>
<body>
<body class="{{theme.css_class()}}">
{{>search_input.html}}
{{{body}}}
</body>

View file

@ -1,9 +1,3 @@
<div class="container">
<header>
<h1>Search</h1>
</header>
<article>
{{#hits?}}
<p>Search results for the query <b>{{query}}</b>:</p>
@ -13,7 +7,7 @@
<ul class="search-results default-keyboard-focus-control">
{{#hits}}
<li class="search-result"><a data-focusindex="{{.index}}" class="link" href="{{.link()}}"><p class="title">{{.title}}</p><p class="snippet">{{.snippet}}</p></a></li>
<li class="search-result"><a data-focusindex="{{.0}}" class="link" href="{{.1.link()}}"><p class="title">{{.1.title}}</p><p class="snippet">{{{.1.snippet}}}</p></a></li>
{{/hits}}
</ul>
{{/hits}}
@ -25,8 +19,3 @@
{{^hits?}}
<p>Your search for <b>{{query}}</b> gave no results.</p>
{{/hits}}
</article>
</div>
{{>footer/default.html}}

View file

@ -1,7 +1,11 @@
<div class="search-container">
<form class="search keyboard-focus-control" action=_search method=GET>
<input data-focusindex="0" type=search name=q placeholder=search autocomplete=off>
<ul class="live-results search-results">
</ul>
<div class="search-widget-container">
<input data-focusindex="0" type=search name=q placeholder=Search autocomplete=off>
<ul class="live-results search-results">
</ul>
</div>
</form>
<ul id="search-result-prototype" class="prototype"><li class="search-result"><a tabindex="0" class="link" href=""><span class="title"></span> &ndash; <span class="snippet"></span></a></li></ul>
<script src="_assets/search-{{search_js_checksum()}}.js" defer></script>
<script src="_assets/{{search_js()}}" defer></script>
</div>

View file

@ -1,15 +1,5 @@
<div class="container">
<header>
<h1>Sitemap</h1>
</header>
<article>
<ul class="dense"
{{#articles}}
><li><a href="{{.link}}">{{.title}}</a></li
><li><a href="{{.link()}}">{{.title}}</a></li
{{/articles}}
></ul>
</article>
</div>
{{>footer/default.html}}

View file

@ -0,0 +1,13 @@
<div class="container">
<div class="hero">
<header>
<h1>{{title}}</h1>
</header>
</div>
<article>
{{{html_body}}}
</article>
</div>
{{>footer/default.html}}

74
themes/generate.py Executable file
View file

@ -0,0 +1,74 @@
#!/usr/bin/env python3
import json, colorsys
colors = json.load(open("material-colors.json", "r"))
palettes = colors['palettes']
def hex_to_rgb(h):
return tuple(int(h[i:i+2], 16) / 255 for i in (0, 2 ,4))
def to_linear(x):
if x < 0.04045:
return x / 12.92
else:
return pow((x + 0.055) / 1.055, 2.4)
def rgb_to_linear(rgb):
return [to_linear(x) for x in rgb]
def luma(rgb):
r, g, b = rgb_to_linear(rgb)
return (0.2126*r + 0.7152*g + 0.0722*b)
def prep(x):
cols = x['colors']
rgb = [hex_to_rgb(c[1:]) for c in cols]
brightness = [luma(c) for c in rgb]
hue = [colorsys.rgb_to_hsv(*c)[0] * 360 for c in rgb]
sat = [colorsys.rgb_to_hsv(*c)[1] for c in rgb]
main_index = 5
if brightness[main_index] >= 0.4:
main_index = 6
dark_main = brightness[main_index] < 0.5
input_index = main_index + (-2 if dark_main else 1)
h = hue[main_index]
s = sat[main_index]
alt = blues
if s > 0.3 and (h < 40 or h >= 300):
alt = yellows
return {
"name": x['shade'].lower().replace(' ', '-'),
"main": cols[main_index],
"input": cols[input_index],
"text": "white",
"link": alt[2 if dark_main else 7],
}
blues = [x for x in palettes if x['shade'] == "Blue"][0]["colors"]
yellows = [x for x in palettes if x['shade'] == "Yellow"][0]["colors"]
themes = [prep(palette) for palette in palettes]
print(
"\n".join(
"\
.theme-{name} {{\n\
--theme-main: {main};\n\
--theme-text: {text};\n\
--theme-input: {input};\n\
--theme-link: {link};\n\
}}\n".format(**x)
for x in themes
)
)
print()
# print("[" + ', '.join('"'+x['name']+'"' for x in themes) + "]")

369
themes/material-colors.json Normal file
View file

@ -0,0 +1,369 @@
{
"names": [
"50",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"A100",
"A200",
"A400",
"A700"
],
"palettes": [
{
"shade": "Red",
"colors": [
"#FFEBEE",
"#FFCDD2",
"#EF9A9A",
"#E57373",
"#EF5350",
"#F44336",
"#E53935",
"#D32F2F",
"#C62828",
"#B71C1C",
"#FF8A80",
"#FF5252",
"#FF1744",
"#D50000"
]
},
{
"shade": "Pink",
"colors": [
"#FCE4EC",
"#F8BBD0",
"#F48FB1",
"#F06292",
"#EC407A",
"#E91E63",
"#D81B60",
"#C2185B",
"#AD1457",
"#880E4F",
"#FF80AB",
"#FF4081",
"#F50057",
"#C51162"
]
},
{
"shade": "Purple",
"colors": [
"#F3E5F5",
"#E1BEE7",
"#CE93D8",
"#BA68C8",
"#AB47BC",
"#9C27B0",
"#8E24AA",
"#7B1FA2",
"#6A1B9A",
"#4A148C",
"#EA80FC",
"#E040FB",
"#D500F9",
"#AA00FF"
]
},
{
"shade": "Deep purple",
"colors": [
"#EDE7F6",
"#D1C4E9",
"#B39DDB",
"#9575CD",
"#7E57C2",
"#673AB7",
"#5E35B1",
"#512DA8",
"#4527A0",
"#311B92",
"#B388FF",
"#7C4DFF",
"#651FFF",
"#6200EA"
]
},
{
"shade": "Indigo",
"colors": [
"#E8EAF6",
"#C5CAE9",
"#9FA8DA",
"#7986CB",
"#5C6BC0",
"#3F51B5",
"#3949AB",
"#303F9F",
"#283593",
"#1A237E",
"#8C9EFF",
"#536DFE",
"#3D5AFE",
"#304FFE"
]
},
{
"shade": "Blue",
"colors": [
"#E3F2FD",
"#BBDEFB",
"#90CAF9",
"#64B5F6",
"#42A5F5",
"#2196F3",
"#1E88E5",
"#1976D2",
"#1565C0",
"#0D47A1",
"#82B1FF",
"#448AFF",
"#2979FF",
"#2962FF"
]
},
{
"shade": "Light Blue",
"colors": [
"#E1F5FE",
"#B3E5FC",
"#81D4FA",
"#4FC3F7",
"#29B6F6",
"#03A9F4",
"#039BE5",
"#0288D1",
"#0277BD",
"#01579B",
"#80D8FF",
"#40C4FF",
"#00B0FF",
"#0091EA"
]
},
{
"shade": "Cyan",
"colors": [
"#E0F7FA",
"#B2EBF2",
"#80DEEA",
"#4DD0E1",
"#26C6DA",
"#00BCD4",
"#00ACC1",
"#0097A7",
"#00838F",
"#006064",
"#84FFFF",
"#18FFFF",
"#00E5FF",
"#00B8D4"
]
},
{
"shade": "Teal",
"colors": [
"#E0F2F1",
"#B2DFDB",
"#80CBC4",
"#4DB6AC",
"#26A69A",
"#009688",
"#00897B",
"#00796B",
"#00695C",
"#004D40",
"#A7FFEB",
"#64FFDA",
"#1DE9B6",
"#00BFA5"
]
},
{
"shade": "Green",
"colors": [
"#E8F5E9",
"#C8E6C9",
"#A5D6A7",
"#81C784",
"#66BB6A",
"#4CAF50",
"#43A047",
"#388E3C",
"#2E7D32",
"#1B5E20",
"#B9F6CA",
"#69F0AE",
"#00E676",
"#00C853"
]
},
{
"shade": "Light Green",
"colors": [
"#F1F8E9",
"#DCEDC8",
"#C5E1A5",
"#AED581",
"#9CCC65",
"#8BC34A",
"#7CB342",
"#689F38",
"#558B2F",
"#33691E",
"#CCFF90",
"#B2FF59",
"#76FF03",
"#64DD17"
]
},
{
"shade": "Lime",
"colors": [
"#F9FBE7",
"#F0F4C3",
"#E6EE9C",
"#DCE775",
"#D4E157",
"#CDDC39",
"#C0CA33",
"#AFB42B",
"#9E9D24",
"#827717",
"#F4FF81",
"#EEFF41",
"#C6FF00",
"#AEEA00"
]
},
{
"shade": "Yellow",
"colors": [
"#FFFDE7",
"#FFF9C4",
"#FFF59D",
"#FFF176",
"#FFEE58",
"#FFEB3B",
"#FDD835",
"#FBC02D",
"#F9A825",
"#F57F17",
"#FFFF8D",
"#FFFF00",
"#FFEA00",
"#FFD600"
]
},
{
"shade": "Amber",
"colors": [
"#FFF8E1",
"#FFECB3",
"#FFE082",
"#FFD54F",
"#FFCA28",
"#FFC107",
"#FFB300",
"#FFA000",
"#FF8F00",
"#FF6F00",
"#FFE57F",
"#FFD740",
"#FFC400",
"#FFAB00"
]
},
{
"shade": "Orange",
"colors": [
"#FFF3E0",
"#FFE0B2",
"#FFCC80",
"#FFB74D",
"#FFA726",
"#FF9800",
"#FB8C00",
"#F57C00",
"#EF6C00",
"#E65100",
"#FFD180",
"#FFAB40",
"#FF9100",
"#FF6D00"
]
},
{
"shade": "Deep Orange",
"colors": [
"#FBE9E7",
"#FFCCBC",
"#FFAB91",
"#FF8A65",
"#FF7043",
"#FF5722",
"#F4511E",
"#E64A19",
"#D84315",
"#BF360C",
"#FF9E80",
"#FF6E40",
"#FF3D00",
"#DD2C00"
]
},
{
"shade": "Brown",
"colors": [
"#EFEBE9",
"#D7CCC8",
"#BCAAA4",
"#A1887F",
"#8D6E63",
"#795548",
"#6D4C41",
"#5D4037",
"#4E342E",
"#3E2723"
]
},
{
"shade": "Gray",
"colors": [
"#FAFAFA",
"#F5F5F5",
"#EEEEEE",
"#E0E0E0",
"#BDBDBD",
"#9E9E9E",
"#757575",
"#616161",
"#424242",
"#212121"
]
},
{
"shade": "Blue Gray",
"colors": [
"#ECEFF1",
"#CFD8DC",
"#B0BEC5",
"#90A4AE",
"#78909C",
"#607D8B",
"#546E7A",
"#455A64",
"#37474F",
"#263238"
]
}
]
}