cadey/maj
cadey
/
maj
1
0
Fork 1
Code Issues 4 Pull Requests Releases 7 Wiki Activity

Compare commits

base: cadey:main
Branches Tags
cadey:main
cadey:karnycukta
cadey:maj-async-std
cadey:majc-history
cadey:v0.6.2
cadey:v0.6.1
cadey:v0.6.0
cadey:v0.5.0
cadey:v0.4.0
cadey:v0.3.0
cadey:v0.2.0
cadey:v0.1.0
..
compare: cadey:maj-async-std
Branches Tags
cadey:main
cadey:karnycukta
cadey:maj-async-std
cadey:majc-history
cadey:v0.6.2
cadey:v0.6.1
cadey:v0.6.0
cadey:v0.5.0
cadey:v0.4.0
cadey:v0.3.0
cadey:v0.2.0
cadey:v0.1.0

No commits in common. "main" and "maj-async-std" have entirely different histories.
main ... maj-async-

41 changed files with 522 additions and 2385 deletions
Show Stats Expand all files Collapse all files

18
.drone.yml
View File

@ -7,25 +7,23 @@ steps:
pull: always pull: always
commands: commands:
- cargo test --all --all-features - cargo test --all --all-features
when:
event:
- push
- name: auto-release - name: auto-release
image: xena/gitea-release image: xena/gitea-release
pull: always pull: always
environment: settings:
RUST_LOG: debug auth_username: cadey
PLUGIN_AUTH_USERNAME: cadey gitea_server: https://tulpa.dev
PLUGIN_GITEA_SERVER: https://tulpa.dev gitea_token:
PLUGIN_GITEA_TOKEN:
from_secret: GITEA_TOKEN from_secret: GITEA_TOKEN
when: when:
event: event:
- push - push
branch: branch:
- main - main
trigger:
event:
- push
- pull_request
--- ---
@ -40,6 +38,6 @@ steps:
environment: environment:
CARGO_TOKEN: CARGO_TOKEN:
from_secret: CARGO_TOKEN from_secret: CARGO_TOKEN
trigger: when:
event: event:
- tag - tag

27
CHANGELOG.md
View File

@ -1,32 +1,5 @@
# Changelog # Changelog
## 0.6.2
Bump gemtext to 0.2.0
## 0.6.1
### FIXED
- [#9] Fixes from @boringcactus for gemtext rendering
## 0.6.0
### ADDED
- `maj::server` now has a CGI handler and majsite now has CGI enabled by default.
## 0.5.0
### ADDED
- A few more helper methods for making text/gemini nodes and responses.
`majsite` now serves static files and tests input from the user.
## 0.4.1
Oops
## 0.4.0 ## 0.4.0
Tokio has been somewhat purged. Tokio has been somewhat purged.

35
Cargo.toml
View File

@ -1,6 +1,6 @@
[package] [package]
name = "maj" name = "maj"
version = "0.6.2" version = "0.3.0"
authors = ["Christine Dodrill <me@christine.website>"] authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018" edition = "2018"
license = "0BSD" license = "0BSD"
@ -11,22 +11,21 @@ repository = "https://tulpa.dev/cadey/maj"
[dependencies] [dependencies]
async-trait = { version = "0", optional = true } async-trait = { version = "0", optional = true }
log = "0.4"
mime_guess = "2.0"
num = "0.2" num = "0.2"
num-derive = "0.3" num-derive = "0.3"
num-traits = "0.2" num-traits = "0.2"
once_cell = "1.4" rustls = { version = "0.18", optional = true, features = ["dangerous_configuration"] }
rustls = { version = "0.19", optional = true, features = ["dangerous_configuration"] } tokio-rustls = { version = "0.14", features = ["dangerous_configuration"], optional = true }
structopt = "0.3"
thiserror = "1"
tokio-rustls = { version = "0.21", features = ["dangerous_configuration"] }
tokio = { version = "0.3", features = ["full"] }
url = "2"
webpki-roots = { version = "0.20", optional = true }
webpki = { version = "0.21.0", optional = true } webpki = { version = "0.21.0", optional = true }
webpki-roots = { version = "0.20", optional = true }
gemtext = { path = "./gemtext" } tokio = { version = "0.2", features = ["full"], optional = true }
async-tls = { default-features = false, optional = true, git = "https://github.com/Xe/async-tls" }
async-std = { version = "1.6", optional = true }
log = "0.4"
url = "2"
thiserror = "1"
structopt = "0.3"
once_cell = "1.4"
[dev-dependencies] [dev-dependencies]
pretty_env_logger = "0.4" pretty_env_logger = "0.4"
@ -35,8 +34,12 @@ pretty_env_logger = "0.4"
default = ["client", "server"] default = ["client", "server"]
client = [ client = [
"tokio-rustls",
"webpki", "webpki",
"webpki-roots", "webpki-roots",
"tokio",
"async-std",
"async-tls/client"
] ]
server = [ server = [
@ -44,13 +47,13 @@ server = [
"webpki", "webpki",
"webpki-roots", "webpki-roots",
"async-trait", "async-trait",
"async-std",
"async-tls/server"
] ]
[workspace] [workspace]
members = [ members = [
"./gemtext",
"./majc", "./majc",
"./majd", "./majd",
"./site", "./site"
"./pilno/karnycukta"
] ]

2
VERSION
View File

@ -1 +1 @@
0.6.2 0.4.0

15
gemtext/Cargo.toml
View File

@ -1,15 +0,0 @@
[package]
name = "gemtext"
version = "0.2.1"
authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018"
license = "0BSD"
description = "A gemini client and server for Rust"
repository = "https://tulpa.dev/cadey/maj"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
[dev-dependencies]
pretty_env_logger = "0.4"

486
gemtext/src/lib.rs
View File

@ -1,486 +0,0 @@
/// This module implements a simple text/gemini parser based on the description
/// here: https://gemini.circumlunar.space/docs/specification.html
use std::io::{self, Write};
/// Build a gemini document up from a series of nodes.
#[derive(Default)]
pub struct Builder {
nodes: Vec<Node>,
}
impl Builder {
pub fn new() -> Builder {
Builder::default()
}
pub fn text<T: Into<String>>(mut self, data: T) -> Builder {
self.nodes.push(Node::Text(data.into()));
self
}
/// Append a single blank line to the document
///
/// This is equivilent to calling [`text()`] with an empty string, or pushing a blank
/// [`Node`]
///
/// ```
/// # use gemtext::Builder;
/// let greeting = Builder::new()
/// .text("Hello")
/// .blank_line()
/// .text("universe")
/// .to_string();
///
/// assert_eq!(greeting.trim(), "Hello\n\nuniverse");
/// ```
///
/// [`text()`]: Self::text()
pub fn blank_line(mut self) -> Self {
self.nodes.push(Node::blank());
self
}
pub fn link<T: Into<String>>(mut self, to: T, name: Option<String>) -> Builder {
self.nodes.push(Node::Link {
to: to.into(),
name: name,
});
self
}
pub fn preformatted<A, T>(mut self, alt_text: A, data: T) -> Builder
where
A: Into<String>,
T: Into<String>,
{
self.nodes.push(Node::Preformatted { alt: alt_text.into(), body: data.into() });
self
}
pub fn heading<T: Into<String>>(mut self, level: u8, body: T) -> Builder {
self.nodes.push(Node::Heading {
level: level,
body: body.into(),
});
self
}
pub fn list_item<T: Into<String>>(mut self, item: T) -> Builder {
self.nodes.push(Node::ListItem(item.into()));
self
}
pub fn quote<T: Into<String>>(mut self, body: T) -> Builder {
self.nodes.push(Node::Quote(body.into()));
self
}
pub fn build(self) -> Vec<Node> {
self.nodes
}
}
impl ToString for Builder {
/// Render a document to a string
///
/// This produces a text/gemini compliant text document, represented as a string
fn to_string(&self) -> String {
let len: usize = self.nodes.iter().map(Node::estimate_len).sum(); // sum up node lengths
let mut bytes = Vec::with_capacity(len + self.nodes.len()); // add in inter-node newlines
render(self, &mut bytes).unwrap(); // Writing to a string shouldn't produce errors
unsafe {
// This is safe because bytes is composed of Strings. We could have this as
// pure safe code by replicating the `render()` method and switching it to use
// a fmt::Write (or even `String::push()`)instead of a io::Write, but this has
// the same effect, with much DRYer code.
String::from_utf8_unchecked(bytes)
}
}
}
impl AsRef<[Node]> for Builder {
/// Get a reference to the internal node list of this builder
fn as_ref(&self) -> &[Node] {
self.nodes.as_ref()
}
}
impl AsMut<[Node]> for Builder {
/// Get a mutable reference to the internal node list of this builder
fn as_mut(&mut self) -> &mut [Node] {
self.nodes.as_mut()
}
}
impl From<Builder> for Vec<Node> {
/// Convert into a collection of [`Node`]s.
///
/// Equivilent to calling [`Builder::build()`]
fn from(builder: Builder) -> Self {
builder.build()
}
}
/// Render a set of nodes as a document to a writer.
pub fn render(nodes: impl AsRef<[Node]>, out: &mut impl Write) -> io::Result<()> {
use Node::*;
for node in nodes.as_ref() {
match node {
Text(body) => {
let special_prefixes = ["=>", "```", "#", "*", ">"];
if special_prefixes.iter().any(|prefix| body.starts_with(prefix)) {
write!(out, " ")?;
}
write!(out, "{}\n", body)?
},
Link { to, name } => match name {
Some(name) => write!(out, "=> {} {}\n", to, name)?,
None => write!(out, "=> {}\n", to)?,
},
Preformatted { alt, body } => write!(out, "```{}\n{}\n```\n", alt, body)?,
Heading { level, body } => write!(out, "{} {}\n", "#".repeat(*level as usize), body)?,
ListItem(body) => write!(out, "* {}\n", body)?,
Quote(body) => write!(out, "> {}\n", body)?,
};
}
Ok(())
}
/// Individual nodes of the document. Each node correlates to a line in the file.
#[derive(Debug, PartialEq, Eq, Clone)]
pub enum Node {
/// Text lines are the most fundamental line type - any line which does not
/// match the definition of another line type defined below defaults to
/// being a text line. The majority of lines in a typical text/gemini document will be text lines.
Text(String),
/// Lines beginning with the two characters "=>" are link lines, which have the following syntax:
///
/// ```gemini
/// =>[<whitespace>]<URL>[<whitespace><USER-FRIENDLY LINK NAME>]
/// ```
///
/// where:
///
/// * `<whitespace>` is any non-zero number of consecutive spaces or tabs
/// * Square brackets indicate that the enclosed content is optional.
/// * `<URL>` is a URL, which may be absolute or relative. If the URL
/// does not include a scheme, a scheme of `gemini://` is implied.
Link { to: String, name: Option<String> },
/// Any line whose first three characters are "```" (i.e. three consecutive
/// back ticks with no leading whitespace) are preformatted toggle lines.
/// These lines should NOT be included in the rendered output shown to the
/// user. Instead, these lines toggle the parser between preformatted mode
/// being "on" or "off". Preformatted mode should be "off" at the beginning
/// of a document. The current status of preformatted mode is the only
/// internal state a parser is required to maintain. When preformatted mode
/// is "on", the usual rules for identifying line types are suspended, and
/// all lines should be identified as preformatted text lines (see 5.4.4).
///
/// Preformatted text lines should be presented to the user in a "neutral",
/// monowidth font without any alteration to whitespace or stylistic
/// enhancements. Graphical clients should use scrolling mechanisms to present
/// preformatted text lines which are longer than the client viewport, in
/// preference to wrapping. In displaying preformatted text lines, clients
/// should keep in mind applications like ASCII art and computer source
/// code: in particular, source code in languages with significant whitespace
/// (e.g. Python) should be able to be copied and pasted from the client into
/// a file and interpreted/compiled without any problems arising from the
/// client's manner of displaying them.
///
/// The first preformatted toggle of a document is often followed by a short
/// string, which acts as alt-text for the preformatted block. This is also
/// often used to denote the language of code in a block of text. For example,
/// a block starting with the text `\`\`\`rust` may be interpreted as rust
/// code, and a block starting with `\`\`\` An ascii art owl` would be
/// described aptly to visually impaired users using a screen reader. The alt
/// text may be separated from the toggle by whitespace. `gemtext` currently
/// renders alt text without this separation.
///
/// To create a preformatted block with no alt text, simply pass a zero-length
/// string as alt text.
Preformatted { alt: String, body: String },
/// Lines beginning with "#" are heading lines. Heading lines consist of one,
/// two or three consecutive "#" characters, followed by optional whitespace,
/// followed by heading text. The number of # characters indicates the "level"
/// of header; #, ## and ### can be thought of as analogous to `<h1>`, `<h2>`
/// and `<h3>` in HTML.
///
/// Heading text should be presented to the user, and clients MAY use special
/// formatting, e.g. a larger or bold font, to indicate its status as a header
/// (simple clients may simply print the line, including its leading #s,
/// without any styling at all). However, the main motivation for the
/// definition of heading lines is not stylistic but to provide a
/// machine-readable representation of the internal structure of the document.
/// Advanced clients can use this information to, e.g. display an automatically
/// generated and hierarchically formatted "table of contents" for a long
/// document in a side-pane, allowing users to easily jump to specific sections
/// without excessive scrolling. CMS-style tools automatically generating menus
/// or Atom/RSS feeds for a directory of text/gemini files can use first
/// heading in the file as a human-friendly title.
Heading { level: u8, body: String },
/// Lines beginning with "* " are unordered list items. This line type exists
/// purely for stylistic reasons. The * may be replaced in advanced clients by
/// a bullet symbol. Any text after the "* " should be presented to the user as
/// if it were a text line, i.e. wrapped to fit the viewport and formatted
/// "nicely". Advanced clients can take the space of the bullet symbol into
/// account when wrapping long list items to ensure that all lines of text
/// corresponding to the item are offset an equal distance from the left of the screen.
ListItem(String),
/// Lines beginning with ">" are quote lines. This line type exists so that
/// advanced clients may use distinct styling to convey to readers the important
/// semantic information that certain text is being quoted from an external
/// source. For example, when wrapping long lines to the the viewport, each
/// resultant line may have a ">" symbol placed at the front.
Quote(String),
}
impl Node {
pub fn blank() -> Node {
Node::Text("".to_string())
}
/// Cheaply estimate the length of this node
///
/// This measures length in bytes, *not characters*. So if the user includes
/// non-ascii characters, a single one of these characters may add several bytes to
/// the length, despite only displaying as one character.
///
/// This does include any newlines, but not any trailing newlines. For example, a
/// preformatted text block containing a single line reading "trans rights! 🏳️‍⚧️"
/// would have a length of 30: 3 backticks, a newline, the text (including 16 bytes
/// for the trans flag), another newline, and another 3 backticks.
///
/// ```
/// # use gemtext::Node;
/// let simple_text = Node::Text(String::from("Henlo worl"));
/// let linky_link = Node::Link { to: "gemini://cetacean.club/maj/".to_string(), name: Some("Maj".to_string()) };
/// let human_rights = Node::Preformatted {
/// alt: "".to_string(),
/// body: "trans rights! 🏳️‍⚧️".to_string(),
/// };
///
/// assert_eq!(
/// simple_text.estimate_len(),
/// "Henlo worl".as_bytes().len()
/// );
/// assert_eq!(
/// linky_link.estimate_len(),
/// "=> gemini://cetacean.club/maj/ Maj".as_bytes().len()
/// );
/// assert_eq!(
/// human_rights.estimate_len(),
/// "```\ntrans rights! 🏳️‍⚧️\n```".as_bytes().len()
/// );
/// ```
pub fn estimate_len(&self) -> usize {
match self {
Self::Text(text) => text.len(),
Self::Link { to, name } => 3 + to.as_bytes().len() +
name.as_ref().map(|n| n.as_bytes().len() + 1).unwrap_or(0),
Self::Preformatted { alt, body } => alt.as_bytes().len()
+ body.as_bytes().len() + 8,
Self::Heading { level, body } => *level as usize + 1 + body.as_bytes().len(),
Self::ListItem(item) | Self::Quote(item)=> 2 + item.as_bytes().len(),
}
}
}
pub fn parse(doc: &str) -> Vec<Node> {
let mut result: Vec<Node> = vec![];
let mut collect_preformatted: bool = false;
let mut preformatted_buffer: Vec<u8> = vec![];
let mut alt = "";
for line in doc.lines() {
if let Some(trailing) = line.strip_prefix("```") {
collect_preformatted = !collect_preformatted;
if !collect_preformatted {
result.push(Node::Preformatted {
alt: alt.to_string(),
body: String::from_utf8(preformatted_buffer)
.unwrap()
.trim_end()
.to_string(),
});
preformatted_buffer = vec![];
} else {
alt = trailing.trim();
}
continue;
}
if collect_preformatted && line != "```" {
write!(preformatted_buffer, "{}\n", line).unwrap();
continue;
}
// Quotes
if line.starts_with(">") {
result.push(Node::Quote(line[1..].trim().to_string()));
continue;
}
// List items
if line.starts_with("*") {
result.push(Node::ListItem(line[1..].trim().to_string()));
continue;
}
// Headings
if line.starts_with("###") {
result.push(Node::Heading {
level: 3,
body: line[3..].trim().to_string(),
});
continue;
}
if line.starts_with("##") {
result.push(Node::Heading {
level: 2,
body: line[2..].trim().to_string(),
});
continue;
}
if line.starts_with("#") {
result.push(Node::Heading {
level: 1,
body: line[1..].trim().to_string(),
});
continue;
}
// Links
if line.starts_with("=>") {
let sp = line[2..].split_ascii_whitespace().collect::<Vec<&str>>();
match sp.len() {
1 => result.push(Node::Link {
to: sp[0].trim().to_string(),
name: None,
}),
_ => result.push(Node::Link {
to: sp[0].trim().to_string(),
name: Some(sp[1..].join(" ").trim().to_string()),
}),
}
continue;
}
result.push(Node::Text(line.to_string()));
}
result
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn basic() {
let _ = pretty_env_logger::try_init();
let msg = include_str!("../../majc/src/help.gmi");
let doc = super::parse(msg);
assert_ne!(doc.len(), 0);
}
#[test]
fn quote() {
let _ = pretty_env_logger::try_init();
let msg = ">hi there";
let expected: Vec<Node> = vec![Node::Quote("hi there".to_string())];
assert_eq!(expected, parse(msg));
}
#[test]
fn list() {
let _ = pretty_env_logger::try_init();
let msg = "*hi there";
let expected: Vec<Node> = vec![Node::ListItem("hi there".to_string())];
assert_eq!(expected, parse(msg));
}
#[test]
fn preformatted() {
let _ = pretty_env_logger::try_init();
let msg = "```hi there\n\
obi-wan kenobi\n\
```\n\
\n\
Test\n";
let expected: Vec<Node> = vec![
Node::Preformatted{ alt: "hi there".to_string(), body: "obi-wan kenobi".to_string() },
Node::Text(String::new()),
Node::Text("Test".to_string()),
];
assert_eq!(expected, parse(msg));
}
#[test]
fn header() {
let _ = pretty_env_logger::try_init();
let msg = "#hi\n##there\n### my friends";
let expected: Vec<Node> = vec![
Node::Heading {
level: 1,
body: "hi".to_string(),
},
Node::Heading {
level: 2,
body: "there".to_string(),
},
Node::Heading {
level: 3,
body: "my friends".to_string(),
},
];
assert_eq!(expected, parse(msg));
}
#[test]
fn link() {
let _ = pretty_env_logger::try_init();
let msg = "=>/\n=> / Go home";
let expected: Vec<Node> = vec![
Node::Link {
to: "/".to_string(),
name: None,
},
Node::Link {
to: "/".to_string(),
name: Some("Go home".to_string()),
},
];
assert_eq!(expected, parse(msg));
}
#[test]
fn ambiguous_preformatted() {
let _ = pretty_env_logger::try_init();
let msg = include_str!("../../testdata/ambig_preformatted.gmi");
let expected: Vec<Node> = vec![
Node::Preformatted { alt: "foo".to_string(), body: "FOO".to_string() },
Node::Text("Foo bar".to_string()),
];
assert_eq!(expected, parse(msg));
}
#[test]
fn ambiguous_text() {
let _ = pretty_env_logger::try_init();
let original = Node::Text("#1 World's Best Coder".to_string());
let expected = " #1 World's Best Coder\n";
let mut rendered: Vec<u8> = vec![];
render(vec![original], &mut rendered).unwrap();
let rendered = String::from_utf8(rendered).unwrap();
assert_eq!(expected, rendered)
}
}

4
majc/Cargo.toml
View File

@ -1,6 +1,6 @@
[package] [package]
name = "majc" name = "majc"
version = "0.2.1" version = "0.2.0"
authors = ["Christine Dodrill <me@christine.website>"] authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018" edition = "2018"
@ -11,7 +11,7 @@ cursive = "0.15"
log = "0.4" log = "0.4"
url = "2" url = "2"
webpki = "0.21.0" webpki = "0.21.0"
rustls = { version = "0.19", features = ["dangerous_configuration"] } rustls = { version = "0.18", features = ["dangerous_configuration"] }
smol = { version = "0.3", features = ["tokio02"] } smol = { version = "0.3", features = ["tokio02"] }
maj = { path = ".." } maj = { path = ".." }

10
majc/src/commands.rs
View File

@ -4,16 +4,6 @@ use cursive::{
Cursive, Cursive,
}; };
pub fn quit(siv: &mut Cursive) {
siv.add_layer(
Dialog::text("Are you sure you want to quit?")
.button("No", |s| {
s.pop_layer();
})
.button("Yes", Cursive::quit),
);
}
pub fn help(siv: &mut Cursive) { pub fn help(siv: &mut Cursive) {
let content = include_str!("./help.gmi"); let content = include_str!("./help.gmi");

20
majc/src/gemini.rs
View File

@ -1,14 +1,13 @@
use cursive::{ use cursive::{
theme::{BaseColor, Color, Effect, Style}, theme::{Effect, Style},
traits::*, traits::*,
utils::markup::StyledString, utils::markup::StyledString,
views::{Dialog, EditView, ResizedView, SelectView, TextView}, views::{Dialog, EditView, ResizedView, SelectView, TextView},
Cursive, Cursive,
}; };
use maj::{self, Response}; use maj::{self, Response};
use rustls::ClientConfig;
use std::str; use std::str;
use url::Url; use rustls::ClientConfig;
/// The state of the browser. /// The state of the browser.
#[derive(Clone)] #[derive(Clone)]
@ -154,17 +153,13 @@ pub fn show(siv: &mut Cursive, url: &str, resp: Response) {
TemporaryRedirect => { TemporaryRedirect => {
let st = siv.user_data::<State>().unwrap(); let st = siv.user_data::<State>().unwrap();
st.history.pop(); st.history.pop();
let u = Url::parse(url).unwrap(); open(siv, resp.meta.as_str());
let u = u.join(resp.meta.as_str()).unwrap();
open(siv, u.as_str());
} }
PermanentRedirect => { PermanentRedirect => {
let st = siv.user_data::<State>().unwrap(); let st = siv.user_data::<State>().unwrap();
st.history.pop(); st.history.pop();
let u = Url::parse(url).unwrap(); open(siv, resp.meta.as_str());
let u = u.join(resp.meta.as_str()).unwrap();
open(siv, u.as_str());
} }
Input => { Input => {
@ -224,16 +219,13 @@ pub fn render(body: &str) -> StyledString {
styled.append(StyledString::styled(name, Style::from(Effect::Underline))) styled.append(StyledString::styled(name, Style::from(Effect::Underline)))
} }
}, },
Preformatted { body, .. } => styled.append(StyledString::plain(body)), Preformatted(data) => styled.append(StyledString::plain(data)),
Heading { level, body } => styled.append(StyledString::styled( Heading { level, body } => styled.append(StyledString::styled(
format!("{} {}", "#".repeat(level as usize), body), format!("{} {}", "#".repeat(level as usize), body),
Style::from(Effect::Bold), Style::from(Effect::Bold),
)), )),
ListItem(item) => styled.append(StyledString::plain(format!("* {}", item))), ListItem(item) => styled.append(StyledString::plain(format!("* {}", item))),
Quote(quote) => styled.append(StyledString::styled( Quote(quote) => styled.append(StyledString::plain(format!("> {}", quote))),
format!("> {}", quote),
Style::from(Color::Dark(BaseColor::Green)),
)),
} }
styled.append(StyledString::plain("\n")); styled.append(StyledString::plain("\n"));
} }

6
majc/src/main.rs
View File

@ -1,4 +1,4 @@
use cursive::{event::Key, menu::MenuTree, Cursive}; use cursive::{event::Key, menu::MenuTree};
pub(crate) mod commands; pub(crate) mod commands;
pub(crate) mod gemini; pub(crate) mod gemini;
@ -17,8 +17,8 @@ fn main() {
siv.add_global_callback('c', |s| { siv.add_global_callback('c', |s| {
s.pop_layer(); s.pop_layer();
}); });
siv.add_global_callback('q', commands::quit); siv.add_global_callback('q', cursive::Cursive::quit);
siv.add_global_callback('~', Cursive::toggle_debug_console); siv.add_global_callback('~', cursive::Cursive::toggle_debug_console);
siv.add_global_callback('h', gemini::history); siv.add_global_callback('h', gemini::history);
siv.add_global_callback('l', gemini::links); siv.add_global_callback('l', gemini::links);
siv.add_global_callback('o', gemini::open_prompt); siv.add_global_callback('o', gemini::open_prompt);

2
pilno/karnycukta/.gitignore vendored
View File

@ -1,2 +0,0 @@
*.epub
*.mobi

21
pilno/karnycukta/Cargo.toml
View File

@ -1,21 +0,0 @@
[package]
name = "karnycukta"
version = "0.1.0"
authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
anyhow = "1"
async-trait = "0"
atom_syndication = "0.9"
chrono = "*"
log = "0"
pretty_env_logger = "0.4"
webpki = "0.21.0"
rustls = { version = "0.19", features = ["dangerous_configuration"] }
structopt = "0.3"
tokio = { version = "0.3", features = ["full"] }
maj = { path = "../..", features = ["server", "client"], default-features = false }

38
pilno/karnycukta/src/main.rs
View File

@ -1,38 +0,0 @@
use anyhow::Result;
use structopt::StructOpt;
mod selfu;
mod zbasu;
#[derive(StructOpt, Debug)]
#[structopt(about = "la .karnycukta. cu finti lo samcukta fo lo zo .gemlogs.")]
enum Cmd {
/// selfu la samse'u
Selfu {
#[structopt(flatten)]
opts: selfu::Options,
},
/// zbasu lo cukta
Zbasu {
#[structopt(long, short = "n")]
nuzyurli: Vec<String>,
/// How many days to look back
#[structopt(long, short = "d")]
seldei: usize,
},
}
#[tokio::main]
async fn main() -> Result<()> {
pretty_env_logger::init();
let cmd = Cmd::from_args();
log::debug!("{:?}", cmd);
match cmd {
Cmd::Selfu { opts } => selfu::run(opts).await?,
Cmd::Zbasu { nuzyurli, seldei } => zbasu::run(nuzyurli, seldei).await?,
}
Ok(())
}

66
pilno/karnycukta/src/selfu.rs
View File

@ -1,66 +0,0 @@
use anyhow::Result;
use rustls::internal::pemfile::{certs, rsa_private_keys};
use rustls::{
AllowAnyAnonymousOrAuthenticatedClient, Certificate, PrivateKey, RootCertStore, ServerConfig,
};
use std::fs::File;
use std::io::{self, BufReader};
use std::path::{Path, PathBuf};
use structopt::StructOpt;
#[derive(StructOpt, Debug)]
pub struct Options {
/// host to listen on
#[structopt(short = "H", long, env = "HOST", default_value = "10.77.2.8")]
host: String,
/// port to listen on
#[structopt(short = "p", long, env = "PORT", default_value = "1965")]
port: u16,
/// cert file
#[structopt(short = "c", long = "cert", env = "CERT_FILE")]
cert: PathBuf,
/// key file
#[structopt(short = "k", long = "key", env = "KEY_FILE")]
key: PathBuf,
/// server hostname
#[structopt(
long = "hostname",
env = "SERVER_HOSTNAME",
default_value = "shachi.wg.akua"
)]
hostname: String,
}
fn load_certs(path: &Path) -> io::Result<Vec<Certificate>> {
certs(&mut BufReader::new(File::open(path)?))
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid cert"))
}
fn load_keys(path: &Path) -> io::Result<Vec<PrivateKey>> {
rsa_private_keys(&mut BufReader::new(File::open(path)?))
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid key"))
}
pub async fn run(opts: Options) -> Result<()> {
let certs = load_certs(&opts.cert)?;
let mut keys = load_keys(&opts.key)?;
log::info!(
"serving gemini://{} on {}:{}",
opts.hostname,
opts.host,
opts.port
);
let mut config = ServerConfig::new(AllowAnyAnonymousOrAuthenticatedClient::new(
RootCertStore::empty(),
));
config
.set_single_cert(certs, keys.remove(0))
.map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err))?;
Ok(())
}

89
pilno/karnycukta/src/zbasu/mod.rs
View File

@ -1,89 +0,0 @@
use anyhow::{anyhow, Result};
use atom_syndication as atom;
use chrono::{prelude::*, Duration};
use maj::gemini::Node;
use rustls::ClientConfig;
use std::io::{self, BufReader, Cursor, Write};
use std::ops::Sub;
use std::str;
mod tls;
fn gem_to_md(tcana: Vec<Node>, out: &mut impl Write) -> io::Result<()> {
use Node::*;
for tcan in tcana {
match tcan {
Text(body) => {
if body == "---" {
break;
}
write!(out, "{}\n", body)?;
}
Link { to, name } => match name {
Some(name) => write!(out, "[{}]({})\n\n", name, to)?,
None => write!(out, "[{0}]({0})", to)?,
},
Preformatted { alt, body } => write!(out, "```{}\n{}\n```\n\n", alt, body)?,
Heading { level, body } => {
write!(out, "##{} {}\n\n", "#".repeat(level as usize), body)?
}
ListItem(body) => write!(out, "* {}\n", body)?,
Quote(body) => write!(out, "> {}\n\n", body)?,
}
}
Ok(())
}
async fn read_feed(gurl: String, cfg: ClientConfig) -> Result<atom::Feed> {
let resp = maj::get(gurl, cfg).await?;
if resp.status != maj::StatusCode::Success {
Err(anyhow!(
"expected success, got: {} {}",
resp.status as u8,
resp.meta
))?;
}
let body = Cursor::new(resp.body);
let feed = atom::Feed::read_from(BufReader::new(body))?;
Ok(feed)
}
pub async fn run(nuzyurli: Vec<String>, seldei: usize) -> Result<()> {
let cfg = tls::config();
let ca: atom::FixedDateTime = Utc::now().into();
for urli in nuzyurli {
let feed = read_feed(urli.clone(), cfg.clone()).await?;
log::info!("reading entries for {}: {}", urli, feed.title);
println!("## {}\nBy {}\n\n", feed.title, feed.authors[0].name);
println!("[Site link]({})\n\n", feed.id);
for entry in feed.entries {
if ca.sub(entry.updated) > Duration::days(seldei as i64) {
continue;
}
let href: String = entry.links()[0].href.clone();
let resp = maj::get(href, cfg.clone()).await?;
if resp.status != maj::StatusCode::Success {
return Err(anyhow!(
"expected success, got: {} {}",
resp.status as u8,
resp.meta
));
}
let body = str::from_utf8(&resp.body)?;
let body = maj::gemini::parse(body);
let mut buf: Vec<u8> = vec![];
gem_to_md(body, &mut buf)?;
println!("{}", str::from_utf8(&buf)?);
}
}
Ok(())
}

24
pilno/karnycukta/src/zbasu/tls.rs
View File

@ -1,24 +0,0 @@
use std::sync::Arc;
pub fn config() -> rustls::ClientConfig {
let mut config = rustls::ClientConfig::new();
config
.dangerous()
.set_certificate_verifier(Arc::new(NoCertificateVerification {}));
config
}
struct NoCertificateVerification {}
impl rustls::ServerCertVerifier for NoCertificateVerification {
fn verify_server_cert(
&self,
_roots: &rustls::RootCertStore,
_presented_certs: &[rustls::Certificate],
_dns_name: webpki::DNSNameRef<'_>,
_ocsp: &[u8],
) -> Result<rustls::ServerCertVerified, rustls::TLSError> {
Ok(rustls::ServerCertVerified::assertion())
}
}

17
shell.nix
View File

@ -1,19 +1,10 @@
let { pkgs ? import <nixpkgs> {} }:
moz_overlay = import (builtins.fetchTarball
"https://github.com/mozilla/nixpkgs-mozilla/archive/master.tar.gz"); pkgs.mkShell {
pkgs = import <nixpkgs> { overlays = [ moz_overlay ]; };
nur = import (builtins.fetchTarball
"https://github.com/nix-community/NUR/archive/master.tar.gz") {
inherit pkgs;
};
in pkgs.mkShell {
buildInputs = with pkgs; [ buildInputs = with pkgs; [
pkgs.latest.rustChannels.stable.rust rustc cargo rls rustfmt cargo-watch
cargo-watch
pkg-config pkg-config
ncurses ncurses
]; ];
RUST_LOG="info,majsite=debug,majsite::server=debug";
} }

20
site/Cargo.toml
View File

@ -3,30 +3,16 @@ name = "majsite"
version = "0.2.0" version = "0.2.0"
authors = ["Christine Dodrill <me@christine.website>"] authors = ["Christine Dodrill <me@christine.website>"]
edition = "2018" edition = "2018"
build = "build.rs"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
anyhow = "1" anyhow = "1"
async-std = "1.5"
async-trait = "0" async-trait = "0"
dnd_dice_roller = "0.3"
env_logger = "0"
log = "0" log = "0"
mime = "0.3.0" pretty_env_logger = "0.4"
percent-encoding = "2" rustls = { version = "0.18", features = ["dangerous_configuration"] }
rand = "0"
rustls = { version = "0.19", features = ["dangerous_configuration"] }
serde = { version = "1", features = ["derive"] }
serde_json = "1"
smol = { version = "0.3", features = ["tokio02"] }
structopt = "0.3" structopt = "0.3"
url = "2"
warp = "0.2"
tokio = { version = "0.3", features = ["rt"] }
maj = { path = "..", features = ["server"], default-features = false } maj = { path = "..", features = ["server"], default-features = false }
[build-dependencies]
anyhow = "1"
ructe = { version = "0.11", features = ["warp02"] }

15
site/build.rs
View File

@ -1,15 +0,0 @@
use anyhow::Result;
use ructe::Ructe;
use std::process::Command;
fn main() -> Result<()> {
let mut ructe = Ructe::from_env()?;
let mut statics = ructe.statics()?;
statics.add_files("static")?;
ructe.compile_templates("templates")?;
let output = Command::new("git").args(&["rev-parse", "HEAD"]).output()?;
let git_hash = String::from_utf8(output.stdout)?;
println!("cargo:rustc-env=GITHUB_SHA={}", git_hash);
Ok(())
}

6
site/cgi-bin/env.sh
View File

@ -1,6 +0,0 @@
#!/usr/bin/env bash
echo "20 text/plain"
echo "The following is the CGI environment of this program:"
echo
env

123
site/src/http.rs
View File

@ -1,123 +0,0 @@
use crate::templates::{self, statics::StaticFile, Html, RenderRucte, ToHtml};
use maj::server::Handler;
use maj::{gemini, server::Request as GemRequest, StatusCode};
use std::io::Write;
use std::sync::Arc;
use url::Url;
use warp::{filters::path::FullPath, http::Response, path, Filter, Rejection, Reply};
const HOST: &'static str = "cetacean.club"; // XXX(cadey): HACK
const APPLICATION_NAME: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
async fn route(args: (FullPath, Arc<crate::server::Handler>)) -> Result<impl Reply, Rejection> {
let (path, h) = args;
let u = Url::parse(&format!("gemini://{}{}", HOST, path.as_str())).unwrap();
let req = GemRequest {
url: u.clone(),
addr: "127.0.0.1:8080".parse().unwrap(),
certs: None,
};
let resp = h.clone().handle(req).await.unwrap();
match resp.status {
StatusCode::Success => {
if resp.meta.starts_with("text/gemini") {
let (title, body) = gemtext_to_html(resp.body);
Response::builder().html(|o| templates::page_html(o, title, body))
} else {
Response::builder()
.status(warp::http::StatusCode::INTERNAL_SERVER_ERROR)
.html(|o| {
templates::error_html(o, u.to_string(), "cannot proxy this yet".to_string())
})
}
}
StatusCode::PermanentRedirect => {
let uu = Url::parse(&resp.meta).expect("url parsing to work");
log::info!("uu: {}", uu.to_string());
Response::builder()
.status(warp::http::StatusCode::PERMANENT_REDIRECT)
.header("Location", uu.path())
.html(|o| {
templates::error_html(
o,
u.to_string(),
format!("forwarding you to {}", uu.path()),
)
})
}
_ => Response::builder()
.status(warp::http::StatusCode::INTERNAL_SERVER_ERROR)
.html(|o| templates::error_html(o, u.to_string(), resp.meta)),
}
}
fn gemtext_to_html(inp: Vec<u8>) -> (String, impl ToHtml) {
use gemini::Node::*;
let mut title: String = "Unknown Title".to_string();
let inp = std::str::from_utf8(&inp).unwrap();
let nodes = gemini::parse(inp);
let mut buf: Vec<u8> = Vec::new();
for node in &nodes {
match node {
Heading { level, body } => {
if *level == 1 {
title = body.to_string();
}
write!(buf, "<h{0}>{1}</h{0}>", level, body).unwrap();
}
Text(body) => write!(buf, "{}\n<br />", body).unwrap(),
Link { to, name } => write!(
buf,
r#"<a href="{}">{}</a><br />"#,
to,
name.as_ref().or(Some(&to.to_string())).unwrap()
)
.unwrap(),
Preformatted { alt, body } => write!(
buf,
"<code><pre title = \"{}\">{}</pre></code>",
alt.replace("\"", "\\\"").replace("\\", "\\\\"),
body
).unwrap(),
ListItem(body) => write!(buf, "<li>{}</li>", body).unwrap(),
Quote(body) => write!(buf, "<blockquote>{}</blockquote>", body).unwrap(),
}
}
(title, Html(String::from_utf8(buf).unwrap()))
}
pub fn run(h: Arc<crate::server::Handler>, port: u16) {
smol::run(async {
let h = h.clone();
let handler = warp::path::full()
.map(move |path: FullPath| (path, h.clone()))
.and_then(route);
let statics = path("static").and(path::param()).and_then(static_file);
let site = statics.or(handler).with(warp::log(APPLICATION_NAME));
warp::serve(site).run(([0, 0, 0, 0], port)).await;
});
}
/// Handler for static files.
/// Create a response from the file data with a correct content type
/// and a far expires header (or a 404 if the file does not exist).
async fn static_file(name: String) -> Result<impl Reply, Rejection> {
if let Some(data) = StaticFile::get(&name) {
Ok(Response::builder()
.status(warp::http::StatusCode::OK)
.header("content-type", data.mime.as_ref())
// TODO .header("expires", _far_expires)
.body(data.content))
} else {
println!("Static file {} not found", name);
Err(warp::reject::not_found())
}
}

21
site/src/index.gmi Normal file
View File

@ -0,0 +1,21 @@
# maj
```
__
_____ _____ |__|
/ \ \__ \ | |
| Y Y \ / __ \_ | |
|__|_| /(____ //\__| |
\/ \/ \______|
```
A gemini ecosystem for Rust
=> gemini://gemini.circumlunar.space/ Gemini homepage
## Homepage
The main homepage for maj is on tulpa.dev:
=> https://tulpa.dev/cadey/maj
## Projects
=> /majc majc, an interactive curses client
=> /majd majd, a high-power gemini server with Lua capabilities

118
site/src/main.rs
View File

@ -1,20 +1,20 @@
use async_std::task;
use maj::{
gemini::Builder,
route, seg,
server::{Error, Handler as MajHandler, Request},
split, Response,
};
use rustls::internal::pemfile::{certs, rsa_private_keys};
use rustls::{ use rustls::{
internal::pemfile::{certs, pkcs8_private_keys},
AllowAnyAnonymousOrAuthenticatedClient, Certificate, PrivateKey, RootCertStore, ServerConfig, AllowAnyAnonymousOrAuthenticatedClient, Certificate, PrivateKey, RootCertStore, ServerConfig,
}; };
use std::fs::File;
use std::{ use std::io::{self, BufReader};
fs::File, use std::path::{Path, PathBuf};
io::{self, BufReader}, use std::sync::Arc;
path::{Path, PathBuf},
sync::Arc,
thread,
};
use structopt::StructOpt; use structopt::StructOpt;
mod http;
mod server;
#[derive(StructOpt, Debug)] #[derive(StructOpt, Debug)]
struct Options { struct Options {
/// host to listen on /// host to listen on
@ -33,25 +33,13 @@ struct Options {
#[structopt(short = "k", long = "key", env = "KEY_FILE")] #[structopt(short = "k", long = "key", env = "KEY_FILE")]
key: PathBuf, key: PathBuf,
/// static path
#[structopt(short = "s", long, env = "STATIC_PATH", default_value = "./static")]
static_path: PathBuf,
/// CGI path
#[structopt(short = "C", long, env = "CGI_PATH", default_value = "./cgi-bin")]
cgi_path: PathBuf,
/// server hostname /// server hostname
#[structopt( #[structopt(
long = "hostname", long = "hostname",
env = "SERVER_HOSTNAME", env = "SERVER_HOSTNAME",
default_value = "cetacean.club" default_value = "maj.kahless.cetacean.club"
)] )]
hostname: String, hostname: String,
/// HTTP port
#[structopt(long, default_value = "34587")]
http_port: u16,
} }
fn load_certs(path: &Path) -> io::Result<Vec<Certificate>> { fn load_certs(path: &Path) -> io::Result<Vec<Certificate>> {
@ -60,16 +48,15 @@ fn load_certs(path: &Path) -> io::Result<Vec<Certificate>> {
} }
fn load_keys(path: &Path) -> io::Result<Vec<PrivateKey>> { fn load_keys(path: &Path) -> io::Result<Vec<PrivateKey>> {
pkcs8_private_keys(&mut BufReader::new(File::open(path)?)) rsa_private_keys(&mut BufReader::new(File::open(path)?))
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid key")) .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid key"))
} }
#[tokio::main] fn main() -> Result<(), maj::server::Error> {
async fn main() -> Result<(), maj::server::Error> { pretty_env_logger::init();
env_logger::init();
let opts = Options::from_args(); let opts = Options::from_args();
let certs = load_certs(&opts.cert).unwrap(); let certs = load_certs(&opts.cert)?;
let mut keys = load_keys(&opts.key).unwrap(); let mut keys = load_keys(&opts.key)?;
log::info!( log::info!(
"serving gemini://{} on {}:{}", "serving gemini://{} on {}:{}",
@ -85,21 +72,64 @@ async fn main() -> Result<(), maj::server::Error> {
.set_single_cert(certs, keys.remove(0)) .set_single_cert(certs, keys.remove(0))
.map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err))?; .map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err))?;
let h = Arc::new(server::Handler { task::block_on(maj::server::serve(
Arc::new(Handler {
hostname: opts.hostname, hostname: opts.hostname,
files: maj::server::files::Handler::new(opts.static_path), }),
cgi: maj::server::cgi::Handler::new(opts.cgi_path), config,
}); opts.host,
opts.port,
{ ))?;
let port = opts.http_port.clone();
let h = h.clone();
thread::spawn(move || http::run(h.clone(), port));
}
maj::server::serve(h.clone(), config, opts.host, opts.port).await?;
Ok(()) Ok(())
} }
include!(concat!(env!("OUT_DIR"), "/templates.rs")); struct Handler {
hostname: String,
}
async fn index() -> Result<maj::Response, maj::server::Error> {
let msg = include_bytes!("index.gmi");
Ok(Response::gemini(msg.to_vec()))
}
async fn majc() -> Result<maj::Response, maj::server::Error> {
let msg = include_bytes!("majc.gmi");
Ok(Response::gemini(msg.to_vec()))
}
async fn need_cert(req: Request) -> Result<Response, Error> {
match req.certs {
None => Ok(Response::need_cert("test")),
Some(certs) => Ok(Response::render(
Builder::new()
.heading(1, "Cert test")
.text(format!("{:?}", certs))
.build(),
)),
}
}
#[async_trait::async_trait]
impl MajHandler for Handler {
async fn handle(&self, req: Request) -> Result<Response, Error> {
if req.url.has_host() && req.url.host_str().unwrap().to_string() != self.hostname {
return Ok(Response::no_proxy());
}
if req.url.path() == "" {
return Ok(Response::perm_redirect(format!(
"gemini://{}/",
self.hostname
)));
}
route!(req.url.path(), {
(/) => index().await;
(/"cert") => need_cert(req).await;
(/"majc") => majc().await;
});
Ok(Response::not_found())
}
}

24
site/src/majc.gmi Normal file
View File

@ -0,0 +1,24 @@
```
__
_____ _____ |__| ____
/ \ \__ \ | |_/ ___\
| Y Y \ / __ \_ | |\ \___
|__|_| /(____ //\__| | \___ >
\/ \/ \______| \/
```
A curses client for Gemini!
## Homepage
The main homepage for majc is on tulpa.dev:
=> https://tulpa.dev/cadey/maj
## Important Keys
<esc>: opens the menubar
c: closes the active window
o: prompts to open a URL
h: shows history
l: shows active links in the page
q: quits majc
?: shows this screen
~: toggles the debug logging pane

90
site/src/server.rs
View File

@ -1,90 +0,0 @@
use dnd_dice_roller::{dice::Dice, error::DiceError};
use maj::{
gemini::Builder,
route, seg,
server::{Error, Handler as MajHandler, Request},
split, Response,
};
use percent_encoding::percent_decode_str;
use std::str::FromStr;
mod tarot;
pub struct Handler {
pub hostname: String,
pub files: maj::server::files::Handler,
pub cgi: maj::server::cgi::Handler,
}
async fn dice(req: Request) -> Result<Response, Error> {
fn dice_roll<T: Into<String>>(roll: T) -> Result<String, DiceError> {
let mut dice = Dice::from_str(&roll.into())?;
if dice.number_of_dice_to_roll > 100 {
dice.number_of_dice_to_roll = 100;
}
if dice.sides > 100 {
dice.sides = 100
}
if dice.sides == 0 {
dice.sides = 6;
}
let res = dice.roll_dice();
let reply = format!(
"{}{} = {}\n",
res.dice_results,
match dice.modifier {
Some(amt) => format!(" + {}", amt),
None => "".into(),
},
res.final_result[0]
);
Ok(reply)
}
match req.url.query() {
None => Ok(Response::input(
"What do you want to roll? [n]dn[+n] [adv|dadv]",
)),
Some(q) => Ok({
let dice = percent_decode_str(q).decode_utf8()?;
let b = Builder::new()
.heading(1, "Dice Results")
.text("")
.text(format!("You rolled {} and you got:", dice))
.text("")
.preformatted("", format!("{}", dice_roll(dice)?))
.text("")
.link("/dice", Some("Do another roll".to_string()));
Response::render(b.build())
}),
}
}
#[async_trait::async_trait]
impl MajHandler for Handler {
async fn handle(&self, req: Request) -> Result<Response, Error> {
if req.url.has_host() && req.url.host_str().unwrap().to_string() != self.hostname {
return Ok(Response::no_proxy());
}
if req.url.path() == "" {
return Ok(Response::perm_redirect(format!(
"gemini://{}/",
self.hostname
)));
}
route!(req.url.path(), {
(/"dice") => dice(req).await;
(/"tools"/"character_gen") => tarot::character().await;
(/"cgi-bin"[/rest..]) => self.cgi.handle(req).await;
});
self.files.handle(req).await
}
}

819
site/src/server/tarot.json
View File

@ -1,819 +0,0 @@
{
"count": 78,
"cards": [
{
"name": "The Magician",
"name_short": "ar01",
"value": "1",
"value_int": 1,
"meaning_up": "Skill, diplomacy, address, subtlety; sickness, pain, loss, disaster, snares of enemies; self-confidence, will; the Querent, if male. ",
"meaning_rev": "Physician, Magus, mental disease, disgrace, disquiet.",
"type": "major"
},
{
"name": "The High Priestess",
"name_short": "ar02",
"value": "2",
"value_int": 2,
"meaning_up": "Secrets, mystery, the future as yet unrevealed; the woman who interests the Querent, if male; the Querent herself, if female; silence, tenacity; mystery, wisdom, science. ",
"meaning_rev": "Passion, moral or physical ardour, conceit, surface knowledge.",
"type": "major"
},
{
"name": "The Empress",
"name_short": "ar03",
"value": "3",
"value_int": 3,
"meaning_up": "Fruitfulness, action, initiative, length of days; the unknown, clandestine; also difficulty, doubt, ignorance. ",
"meaning_rev": "Light, truth, the unravelling of involved matters, public rejoicings; according to another reading, vacillation.",
"type": "major"
},
{
"name": "The Emperor",
"name_short": "ar04",
"value": "4",
"value_int": 4,
"meaning_up": "Stability, power, protection, realization; a great person; aid, reason, conviction; also authority and will. ",
"meaning_rev": "Benevolence, compassion, credit; also confusion to enemies, obstruction, immaturity.",
"type": "major"
},
{
"name": "The Hierophant",
"name_short": "ar05",
"value": "5",
"value_int": 5,
"meaning_up": "Marriage, alliance, captivity, servitude; by another account, mercy and goodness; inspiration; the man to whom the Querent has recourse. ",
"meaning_rev": "Society, good understanding, concord, overkindness, weakness.",
"type": "major"
},
{
"name": "The Lovers",
"name_short": "ar06",
"value": "6",
"value_int": 6,
"meaning_up": "Attraction, love, beauty, trials overcome. ",
"meaning_rev": "Failure, foolish designs. Another account speaks of marriage frustrated and contrarieties of all kinds.",
"type": "major"
},
{
"name": "The Chariot",
"name_short": "ar07",
"value": "7",
"value_int": 7,
"meaning_up": "Succour, providence also war, triumph, presumption, vengeance, trouble. ",
"meaning_rev": "Riot, quarrel, dispute, litigation, defeat.",
"type": "major"
},
{
"name": "Fortitude",
"name_short": "ar08",
"value": "8",
"value_int": 8,
"meaning_up": "Power, energy, action, courage, magnanimity; also complete success and honours. ",
"meaning_rev": "Despotism, abuse if power, weakness, discord, sometimes even disgrace.",
"type": "major"
},
{
"name": "The Hermit",
"name_short": "ar09",
"value": "9",
"value_int": 9,
"meaning_up": "Prudence, circumspection; also and especially treason, dissimulation, roguery, corruption. ",
"meaning_rev": "Concealment, disguise, policy, fear, unreasoned caution.",
"type": "major"
},
{
"name": "Wheel Of Fortune",
"name_short": "ar10",
"value": "10",
"value_int": 10,
"meaning_up": "Destiny, fortune, success, elevation, luck, felicity. ",
"meaning_rev": "Increase, abundance, superfluity.",
"type": "major"
},
{
"name": "Justice",
"name_short": "ar11",
"value": "11",
"value_int": 11,
"meaning_up": "Equity, rightness, probity, executive; triumph of the deserving side in law. ",
"meaning_rev": "Law in all its departments, legal complications, bigotry, bias, excessive severity.",
"type": "major"
},
{
"name": "The Hanged Man",
"name_short": "ar12",
"value": "12",
"value_int": 12,
"meaning_up": "Wisdom, circumspection, discernment, trials, sacrifice, intuition, divination, prophecy. ",
"meaning_rev": "Selfishness, the crowd, body politic.",
"type": "major"
},
{
"name": "Death",
"name_short": "ar13",
"value": "13",
"value_int": 13,
"meaning_up": "End, mortality, destruction, corruption also, for a man, the loss of a benefactor for a woman, many contrarieties; for a maid, failure of marriage projects. ",
"meaning_rev": "Inertia, sleep, lethargy, petrifaction, somnambulism; hope destroyed.",
"type": "major"
},
{
"name": "Temperance",
"name_short": "ar14",
"value": "14",
"value_int": 14,
"meaning_up": "Economy, moderation, frugality, management, accommodation. ",
"meaning_rev": "Things connected with churches, religions, sects, the priesthood, sometimes even the priest who will marry the Querent; also disunion, unfortunate combinations, competing interests.",
"type": "major"
},
{
"name": "The Devil",
"name_short": "ar15",
"value": "15",
"value_int": 15,
"meaning_up": "Ravage, violence, vehemence, extraordinary efforts, force, fatality; that which is predestined but is not for this reason evil. ",
"meaning_rev": "Evil fatality, weakness, pettiness, blindness.",
"type": "major"
},
{
"name": "The Tower",
"name_short": "ar16",
"value": "16",
"value_int": 16,
"meaning_up": "Misery, distress, indigence, adversity, calamity, disgrace, deception, ruin. It is a card in particular of unforeseen catastrophe. ",
"meaning_rev": "According to one account, the same in a lesser degree also oppression, imprisonment, tyranny.",
"type": "major"
},
{
"name": "The Star",
"name_short": "ar17",
"value": "17",
"value_int": 17,
"meaning_up": "Loss, theft, privation, abandonment; another reading says-hope and bright prospects.",
"meaning_rev": "Arrogance, haughtiness, impotence.",
"type": "major"
},
{
"name": "The Moon",
"name_short": "ar18",
"value": "18",
"value_int": 18,
"meaning_up": "Hidden enemies, danger, calumny, darkness, terror, deception, occult forces, error. ",
"meaning_rev": "Instability, inconstancy, silence, lesser degrees of deception and error.",
"type": "major"
},
{
"name": "The Sun",
"name_short": "ar19",
"value": "19",
"value_int": 19,
"meaning_up": "Material happiness, fortunate marriage, contentment. ",
"meaning_rev": "The same in a lesser sense.",
"type": "major"
},
{
"name": "The Last Judgment",
"name_short": "ar20",
"value": "20",
"value_int": 20,
"meaning_up": "Change of position, renewal, outcome. Another account specifies total loss though lawsuit. ",
"meaning_rev": "Weakness, pusillanimity, simplicity; also deliberation, decision, sentence.",
"type": "major"
},
{
"name": "The Fool",
"name_short": "ar00",
"value": "zero",
"value_int": 0,
"meaning_up": "Folly, mania, extravagance, intoxication, delirium, frenzy, bewrayment. ",
"meaning_rev": "Negligence, absence, distribution, carelessness, apathy, nullity, vanity.",
"type": "major"
},
{
"name": "The World",
"name_short": "ar21",
"value": "21",
"value_int": 21,
"meaning_up": "Assured success, recompense, voyage, route, emigration, flight, change of place. ",
"meaning_rev": "Inertia, fixity, stagnation, permanence.",
"type": "major"
},
{
"value": "page",
"value_int": 11,
"name": "Page of Wands",
"name_short": "wapa",
"suit": "wands",
"meaning_up": "Dark young man, faithful, a lover, an envoy, a postman. Beside a man, he will bear favourable testimony concerning him. A dangerous rival, if followed by the Page of Cups. Has the chief qualities of his suit. He may signify family intelligence. ",
"meaning_rev": "Anecdotes, announcements, evil news. Also indecision and the instability which accompanies it.",
"type": "minor",
"desc": "In a scene similar to the former, a young man stands in the act of proclamation. He is unknown but faithful, and his tidings are strange. "
},
{
"value": "knight",
"value_int": 12,
"name": "Knight of Wands",
"name_short": "wakn",
"suit": "wands",
"meaning_up": "Departure, absence, flight, emigration. A dark young man, friendly. Change of residence. ",
"meaning_rev": "Rupture, division, interruption, discord.",
"type": "minor",
"desc": "He is shewn as if upon a journey, armed with a short wand, and although mailed is not on a warlike errand. He is passing mounds or pyramids. The motion of the horse is a key to the character of its rider, and suggests the precipitate mood, or things connected therewith. "
},
{
"value": "queen",
"value_int": 13,
"name": "Queen of Wands",
"name_short": "waqu",
"suit": "wands",
"meaning_up": "A dark woman, countrywoman, friendly, chaste, loving, honourable. If the card beside her signifies a man, she is well disposed towards him; if a woman, she is interested in the Querent. Also, love of money, or a certain success in business. ",
"meaning_rev": "Good, economical, obliging, serviceable. Signifies also--but in certain positions and in the neighbourhood of other cards tending in such directions--opposition, jealousy, even deceit and infidelity.",
"type": "minor",
"desc": "The Wands throughout this suit are always in leaf, as it is a suit of life and animation. Emotionally and otherwise, the Queen's personality corresponds to that of the King, but is more magnetic. "
},
{
"value": "king",
"value_int": 14,
"name": "King of Wands",
"name_short": "waki",
"suit": "wands",
"meaning_up": "Dark man, friendly, countryman, generally married, honest and conscientious. The card always signifies honesty, and may mean news concerning an unexpected heritage to fall in before very long. ",
"meaning_rev": "Good, but severe; austere, yet tolerant.",
"type": "minor",
"desc": "The physical and emotional nature to which this card is attributed is dark, ardent, lithe, animated, impassioned, noble. The King uplifts a flowering wand, and wears, like his three correspondences in the remaining suits, what is called a cap of maintenance beneath his crown. He connects with the symbol of the lion, which is emblazoned on the back of his throne. "
},
{
"value": "ace",
"value_int": 1,
"name": "Ace of Wands",
"name_short": "waac",
"suit": "wands",
"meaning_up": "Creation, invention, enterprise, the powers which result in these; principle, beginning, source; birth, family, origin, and in a sense the virility which is behind them; the starting point of enterprises; according to another account, money, fortune, inheritance. ",
"meaning_rev": "Fall, decadence, ruin, perdition, to perish also a certain clouded joy.",
"type": "minor",
"desc": "A hand issuing from a cloud grasps a stout wand or club. "
},
{
"value": "two",
"value_int": 2,
"name": "Two of Wands",
"name_short": "wa02",
"suit": "wands",
"meaning_up": "Between the alternative readings there is no marriage possible; on the one hand, riches, fortune, magnificence; on the other, physical suffering, disease, chagrin, sadness, mortification. The design gives one suggestion; here is a lord overlooking his dominion and alternately contemplating a globe; it looks like the malady, the mortification, the sadness of Alexander amidst the grandeur of this world's wealth. ",
"meaning_rev": "Surprise, wonder, enchantment, emotion, trouble, fear.",
"type": "minor",
"desc": "A tall man looks from a battlemented roof over sea and shore; he holds a globe in his right hand, while a staff in his left rests on the battlement; another is fixed in a ring. The Rose and Cross and Lily should be noticed on the left side. "
},
{
"value": "three",
"value_int": 3,
"name": "Three of Wands",
"name_short": "wa03",
"suit": "wands",
"meaning_up": "He symbolizes established strength, enterprise, effort, trade, commerce, discovery; those are his ships, bearing his merchandise, which are sailing over the sea. The card also signifies able co-operation in business, as if the successful merchant prince were looking from his side towards yours with a view to help you. ",
"meaning_rev": "The end of troubles, suspension or cessation of adversity, toil and disappointment.",
"type": "minor",
"desc": "A calm, stately personage, with his back turned, looking from a cliff's edge at ships passing over the sea. Three staves are planted in the ground, and he leans slightly on one of them. "
},
{
"value": "four",
"value_int": 4,
"name": "Four of Wands",
"name_short": "wa04",
"suit": "wands",
"meaning_up": "They are for once almost on the surface--country life, haven of refuge, a species of domestic harvest-home, repose, concord, harmony, prosperity, peace, and the perfected work of these. ",
"meaning_rev": "The meaning remains unaltered; it is prosperity, increase, felicity, beauty, embellishment.",
"type": "minor",
"desc": "From the four great staves planted in the foreground there is a great garland suspended; two female figures uplift nosegays; at their side is a bridge over a moat, leading to an old manorial house. "
},
{
"value": "five",
"value_int": 5,
"name": "Five of Wands",
"name_short": "wa05",
"suit": "wands",
"meaning_up": "Imitation, as, for example, sham fight, but also the strenuous competition and struggle of the search after riches and fortune. In this sense it connects with the battle of life. Hence some attributions say that it is a card of gold, gain, opulence. ",
"meaning_rev": "Litigation, disputes, trickery, contradiction.",
"type": "minor",
"desc": "A posse of youths, who are brandishing staves, as if in sport or strife. It is mimic warfare, and hereto correspond the "
},
{
"value": "six",
"value_int": 6,
"name": "Six of Wands",
"name_short": "wa06",
"suit": "wands",
"meaning_up": "The card has been so designed that it can cover several significations; on the surface, it is a victor triumphing, but it is also great news, such as might be carried in state by the King's courier; it is expectation crowned with its own desire, the crown of hope, and so forth. ",
"meaning_rev": "Apprehension, fear, as of a victorious enemy at the gate; treachery, disloyalty, as of gates being opened to the enemy; also indefinite delay.",
"type": "minor",
"desc": "A laurelled horseman bears one staff adorned with a laurel crown; footmen with staves are at his side. "
},
{
"value": "seven",
"value_int": 7,
"name": "Seven of Wands",
"name_short": "wa07",
"suit": "wands",
"meaning_up": "It is a card of valour, for, on the surface, six are attacking one, who has, however, the vantage position. On the intellectual plane, it signifies discussion, wordy strife; in business--negotiations, war of trade, barter, competition. It is further a card of success, for the combatant is on the top and his enemies may be unable to reach him. ",
"meaning_rev": "Perplexity, embarrassments, anxiety. It is also a caution against indecision.",
"type": "minor",
"desc": "A young man on a craggy eminence brandishing a staff; six other staves are raised towards him from below. "
},
{
"value": "eight",
"value_int": 8,
"name": "Eight of Wands",
"name_short": "wa08",
"suit": "wands",
"meaning_up": "Activity in undertakings, the path of such activity, swiftness, as that of an express messenger; great haste, great hope, speed towards an end which promises assured felicity; generally, that which is on the move; also the arrows of love. ",
"meaning_rev": "Arrows of jealousy, internal dispute, stingings of conscience, quarrels; and domestic disputes for persons who are married.",
"type": "minor",
"desc": "The card represents motion through the immovable-a flight of wands through an open country; but they draw to the term of their course. That which they signify is at hand; it may be even on the threshold. "
},
{
"value": "nine",
"value_int": 9,
"name": "Nine of Wands",
"name_short": "wa09",
"suit": "wands",
"meaning_up": "The card signifies strength in opposition. If attacked, the person will meet an onslaught boldly; and his build shews, that he may prove a formidable antagonist. With this main significance there are all its possible adjuncts--delay, suspension, adjournment. ",
"meaning_rev": "Obstacles, adversity, calamity.",
"type": "minor",
"desc": "The figure leans upon his staff and has an expectant look, as if awaiting an enemy. Behind are eight other staves--erect, in orderly disposition, like a palisade. "
},
{
"value": "ten",
"value_int": 10,
"name": "Ten of Wands",
"name_short": "wa10",
"suit": "wands",
"meaning_up": "A card of many significances, and some of the readings cannot be harmonized. I set aside that which connects it with honour and good faith. The chief meaning is oppression simply, but it is also fortune, gain, any kind of success, and then it is the oppression of these things. It is also a card of false-seeming, disguise, perfidy. The place which the figure is approaching may suffer from the rods that he carries. Success is stultified if the Nine of Swords follows, and if it is a question of a lawsuit, there will be certain loss. ",
"meaning_rev": "Contrarieties, difficulties, intrigues, and their analogies.",
"type": "minor",
"desc": "A man oppressed by the weight of the ten staves which he is carrying. "
},
{
"value": "page",
"value_int": 11,
"name": "Page of Cups",
"name_short": "cupa",
"suit": "cups",
"meaning_up": "Fair young man, one impelled to render service and with whom the Querent will be connected; a studious youth; news, message; application, reflection, meditation; also these things directed to business. ",
"meaning_rev": "Taste, inclination, attachment, seduction, deception, artifice.",
"type": "minor",
"desc": "A fair, pleasing, somewhat effeminate page, of studious and intent aspect, contemplates a fish rising from a cup to look at him. It is the pictures of the mind taking form. "
},
{
"value": "knight",
"value_int": 12,
"name": "Knight of Cups",
"name_short": "cukn",
"suit": "cups",
"meaning_up": "Arrival, approach--sometimes that of a messenger; advances, proposition, demeanour, invitation, incitement. ",
"meaning_rev": "Trickery, artifice, subtlety, swindling, duplicity, fraud.",
"type": "minor",
"desc": "Graceful, but not warlike; riding quietly, wearing a winged helmet, referring to those higher graces of the imagination which sometimes characterize this card. He too is a dreamer, but the images of the side of sense haunt him in his vision. "
},
{
"value": "queen",
"value_int": 13,
"name": "Queen of Cups",
"name_short": "cuqu",
"suit": "cups",
"meaning_up": "Good, fair woman; honest, devoted woman, who will do service to the Querent; loving intelligence, and hence the gift of vision; success, happiness, pleasure; also wisdom, virtue; a perfect spouse and a good mother. ",
"meaning_rev": "The accounts vary; good woman; otherwise, distinguished woman but one not to be trusted; perverse woman; vice, dishonour, depravity.",
"type": "minor",
"desc": "Beautiful, fair, dreamy--as one who sees visions in a cup. This is, however, only one of her aspects; she sees, but she also acts, and her activity feeds her dream. "
},
{
"value": "king",
"value_int": 14,
"name": "King of Cups",
"name_short": "cuki",
"suit": "cups",
"meaning_up": "Fair man, man of business, law, or divinity; responsible, disposed to oblige the Querent; also equity, art and science, including those who profess science, law and art; creative intelligence. ",
"meaning_rev": "Dishonest, double-dealing man; roguery, exaction, injustice, vice, scandal, pillage, considerable loss.",
"type": "minor",
"desc": "He holds a short sceptre in his left hand and a great cup in his right; his throne is set upon the sea; on one side a ship is riding and on the other a dolphin is leaping. The implicit is that the Sign of the Cup naturally refers to water, which appears in all the court cards. "
},
{
"value": "ace",
"value_int": 1,
"name": "Ace of Cups",
"name_short": "cuac",
"suit": "cups",
"meaning_up": "House of the true heart, joy, content, abode, nourishment, abundance, fertility; Holy Table, felicity hereof. ",
"meaning_rev": "House of the false heart, mutation, instability, revolution.",
"type": "minor",
"desc": "The waters are beneath, and thereon are water-lilies; the hand issues from the cloud, holding in its palm the cup, from which four streams are pouring; a dove, bearing in its bill a cross-marked Host, descends to place the Wafer in the Cup; the dew of water is falling on all sides. It is an intimation of that which may lie behind the Lesser Arcana. "
},
{
"value": "two",
"value_int": 2,
"name": "Two of Cups",
"name_short": "cu02",
"suit": "cups",
"meaning_up": "Love, passion, friendship, affinity, union, concord, sympathy, the interrelation of the sexes, and--as a suggestion apart from all offices of divination--that desire which is not in Nature, but by which Nature is sanctified",
"meaning_rev": " and maiden are pledging one another, and above their cups rises the Caduceus of Hermes, between the great wings of which there appears a lion's head. It is a variant of a sign which is found in a few old examples of this card. Some curious emblematical meanings are attached to it, but they do not concern us in this place. Divinatory Meanings: Love, passion, friendship, affinity, union, concord, sympathy, the interrelation of the sexes, and--as a suggestion apart from all offices of divination--that desire which is not in Nature, but by which Nature is sanctified.",
"type": "minor",
"desc": "A youth and maiden are pledging one another, and above their cups rises the Caduceus of Hermes, between the great wings of which there appears a lion's head. It is a variant of a sign which is found in a few old examples of this card. Some curious emblematical meanings are attached to it, but they do not concern us in this place. "
},
{
"value": "three",
"value_int": 3,
"name": "Three of Cups",
"name_short": "cu03",
"suit": "cups",
"meaning_up": "The conclusion of any matter in plenty, perfection and merriment; happy issue, victory, fulfilment, solace, healing, ",
"meaning_rev": "Expedition, dispatch, achievement, end. It signifies also the side of excess in physical enjoyment, and the pleasures of the senses.",
"type": "minor",
"desc": "Maidens in a garden-ground with cups uplifted, as if pledging one another. "
},
{
"value": "four",
"value_int": 4,
"name": "Four of Cups",
"name_short": "cu04",
"suit": "cups",
"meaning_up": "Weariness, disgust, aversion, imaginary vexations, as if the wine of this world had caused satiety only; another wine, as if a fairy gift, is now offered the wastrel, but he sees no consolation therein. This is also a card of blended pleasure. ",
"meaning_rev": "Novelty, presage, new instruction, new relations.",
"type": "minor",
"desc": "A young man is seated under a tree and contemplates three cups set on the grass before him; an arm issuing from a cloud offers him another cup. His expression notwithstanding is one of discontent with his environment. "
},
{
"value": "five",
"value_int": 5,
"name": "Five of Cups",
"name_short": "cu05",
"suit": "cups",
"meaning_up": "gure, looking sideways at three prone cups two others stand upright behind him; a bridge is in the background, leading to a small keep or holding. Divanatory Meanings: It is a card of loss, but something remains over; three have been taken, but two are left; it is a card of inheritance, patrimony, transmission, but not corresponding to expectations; with some interpreters it is a card of marriage, but not without bitterness or frustration. ",
"meaning_rev": "News, alliances, affinity, consanguinity, ancestry, return, false projects.",
"type": "minor",
"desc": "A dark, cloaked figure, looking sideways at three prone cups two others stand upright behind him; a bridge is in the background, leading to a small keep or holding. Divanatory Meanings: It is a card of loss, but something remains over; three have been taken, but two are left; it is a card of inheritance, patrimony, transmission, but not corresponding to expectations; with some interpreters it is a card of marriage, but not without bitterness or frustration. Reversed: News, alliances, affinity, consanguinity, ancestry, return, false projects"
},
{
"value": "six",
"value_int": 6,
"name": "Six of Cups",
"name_short": "cu06",
"suit": "cups",
"meaning_up": "A card of the past and of memories, looking back, as--for example--on childhood; happiness, enjoyment, but coming rather from the past; things that have vanished. Another reading reverses this, giving new relations, new knowledge, new environment, and then the children are disporting in an unfamiliar precinct. ",
"meaning_rev": "The future, renewal, that which will come to pass presently.",
"type": "minor",
"desc": "Children in an old garden, their cups filled with flowers. "
},
{
"value": "seven",
"value_int": 7,
"name": "Seven of Cups",
"name_short": "cu07",
"suit": "cups",
"meaning_up": "Fairy favours, images of reflection, sentiment, imagination, things seen in the glass of contemplation; some attainment in these degrees, but nothing permanent or substantial is suggested. ",
"meaning_rev": "Desire, will, determination, project.",
"type": "minor",
"desc": "Strange chalices of vision, but the images are more especially those of the fantastic spirit. "
},
{
"value": "eight",
"value_int": 8,
"name": "Eight of Cups",
"name_short": "cu08",
"suit": "cups",
"meaning_up": "The card speaks for itself on the surface, but other readings are entirely antithetical--giving joy, mildness, timidity, honour, modesty. In practice, it is usually found that the card shews the decline of a matter, or that a matter which has been thought to be important is really of slight consequence--either for good or evil. ",
"meaning_rev": "Great joy, happiness, feasting.",
"type": "minor",
"desc": "A man of dejected aspect is deserting the cups of his felicity, enterprise, undertaking or previous concern. "
},
{
"value": "nine",
"value_int": 9,
"name": "Nine of Cups",
"name_short": "cu09",
"suit": "cups",
"meaning_up": "Concord, contentment, physical bien-ĂŞtre; also victory, success, advantage; satisfaction for the Querent or person for whom the consultation is made. ",
"meaning_rev": "Truth, loyalty, liberty; but the readings vary and include mistakes, imperfections, etc.",
"type": "minor",
"desc": "A goodly personage has feasted to his heart's content, and abundant refreshment of wine is on the arched counter behind him, seeming to indicate that the future is also assured. The picture offers the material side only, but there are other aspects. "
},
{
"value": "ten",
"value_int": 10,
"name": "Ten of Cups",
"name_short": "cu10",
"suit": "cups",
"meaning_up": "Contentment, repose of the entire heart; the perfection of that state; also perfection of human love and friendship; if with several picture-cards, a person who is taking charge of the Querent's interests; also the town, village or country inhabited by the Querent. ",
"meaning_rev": "Repose of the false heart, indignation, violence.",
"type": "minor",
"desc": "Appearance of Cups in a rainbow; it is contemplated in wonder and ecstacy by a man and woman below, evidently husband and wife. His right arm is about her; his left is raised upward; she raises her right arm. The two children dancing near them have not observed the prodigy but are happy after their own manner. There is a home-scene beyond. "
},
{
"value": "page",
"value_int": 11,
"name": "Page of Pentacles",
"name_short": "pepa",
"suit": "pentacles",
"meaning_up": "Application, study, scholarship, reflection another reading says news, messages and the bringer thereof; also rule, management. ",
"meaning_rev": "Prodigality, dissipation, liberality, luxury; unfavourable news.",
"type": "minor",
"desc": "A youthful figure, looking intently at the pentacle which hovers over his raised hands. He moves slowly, insensible of that which is about him. "
},
{
"value": "knight",
"value_int": 12,
"name": "Knight of Pentacles",
"name_short": "pekn",
"suit": "pentacles",
"meaning_up": "Utility, serviceableness, interest, responsibility, rectitude-all on the normal and external plane. ",
"meaning_rev": "inertia, idleness, repose of that kind, stagnation; also placidity, discouragement, carelessness.",
"type": "minor",
"desc": "He rides a slow, enduring, heavy horse, to which his own aspect corresponds. He exhibits his symbol, but does not look therein. "
},
{
"value": "queen",
"value_int": 13,
"name": "Queen of Pentacles",
"name_short": "pequ",
"suit": "pentacles",
"meaning_up": "Opulence, generosity, magnificence, security, liberty. ",
"meaning_rev": "Evil, suspicion, suspense, fear, mistrust.",
"type": "minor",
"desc": "The face suggests that of a dark woman, whose qualities might be summed up in the idea of greatness of soul; she has also the serious cast of intelligence; she contemplates her symbol and may see worlds therein. "
},
{
"value": "king",
"value_int": 14,
"name": "King of Pentacles",
"name_short": "peki",
"suit": "pentacles",
"meaning_up": "Valour, realizing intelligence, business and normal intellectual aptitude, sometimes mathematical gifts and attainments of this kind; success in these paths. ",
"meaning_rev": "Vice, weakness, ugliness, perversity, corruption, peril.",
"type": "minor",
"desc": "The figure calls for no special description the face is rather dark, suggesting also courage, but somewhat lethargic in tendency. The bull's head should be noted as a recurrent symbol on the throne. The sign of this suit is represented throughout as engraved or blazoned with the pentagram, typifying the correspondence of the four elements in human nature and that by which they may be governed. In many old Tarot packs this suit stood for current coin, money, deniers. I have not invented the substitution of pentacles and I have no special cause to sustain in respect of the alternative. But the consensus of divinatory meanings is on the side of some change, because the cards do not happen to deal especially with questions of money. "
},
{
"value": "ace",
"value_int": 1,
"name": "Ace of Pentacles",
"name_short": "peac",
"suit": "pentacles",
"meaning_up": "Perfect contentment, felicity, ecstasy; also speedy intelligence; gold. ",
"meaning_rev": "The evil side of wealth, bad intelligence; also great riches. In any case it shews prosperity, comfortable material conditions, but whether these are of advantage to the possessor will depend on whether the card is reversed or not.",
"type": "minor",
"desc": "A hand--issuing, as usual, from a cloud--holds up a pentacle. "
},
{
"value": "two",
"value_int": 2,
"name": "Two of Pentacles",
"name_short": "pe02",
"suit": "pentacles",
"meaning_up": "On the one hand it is represented as a card of gaiety, recreation and its connexions, which is the subject of the design; but it is read also as news and messages in writing, as obstacles, agitation, trouble, embroilment. ",
"meaning_rev": "Enforced gaiety, simulated enjoyment, literal sense, handwriting, composition, letters of exchange.",
"type": "minor",
"desc": "A young man, in the act of dancing, has a pentacle in either hand, and they are joined by that endless cord which is like the number 8 reversed. "
},
{
"value": "three",
"value_int": 3,
"name": "Three of Pentacles",
"name_short": "pe03",
"suit": "pentacles",
"meaning_up": "MĂ©tier, trade, skilled labour; usually, however, regarded as a card of nobility, aristocracy, renown, glory. ",
"meaning_rev": "Mediocrity, in work and otherwise, puerility, pettiness, weakness.",
"type": "minor",
"desc": "A sculptor at his work in a monastery. Compare the design which illustrates the Eight of Pentacles. The apprentice or amateur therein has received his reward and is now at work in earnest. "
},
{
"value": "four",
"value_int": 4,
"name": "Four of Pentacles",
"name_short": "pe04",
"suit": "pentacles",
"meaning_up": "The surety of possessions, cleaving to that which one has, gift, legacy, inheritance. ",
"meaning_rev": "Suspense, delay, opposition.",
"type": "minor",
"desc": "A crowned figure, having a pentacle over his crown, clasps another with hands and arms; two pentacles are under his feet. He holds to that which he has. "
},
{
"value": "five",
"value_int": 5,
"name": "Five of Pentacles",
"name_short": "pe05",
"suit": "pentacles",
"meaning_up": "The card foretells material trouble above all, whether in the form illustrated--that is, destitution--or otherwise. For some cartomancists, it is a card of love and lovers-wife, husband, friend, mistress; also concordance, affinities. These alternatives cannot be harmonized. ",
"meaning_rev": "Disorder, chaos, ruin, discord, profligacy.",
"type": "minor",
"desc": "Two mendicants in a snow-storm pass a lighted casement. "
},
{
"value": "six",
"value_int": 6,
"name": "Six of Pentacles",
"name_short": "pe06",
"suit": "pentacles",
"meaning_up": "Presents, gifts, gratification another account says attention, vigilance now is the accepted time, present prosperity, etc. ",
"meaning_rev": "Desire, cupidity, envy, jealousy, illusion.",
"type": "minor",
"desc": "A person in the guise of a merchant weighs money in a pair of scales and distributes it to the needy and distressed. It is a testimony to his own success in life, as well as to his goodness of heart. "
},
{
"value": "seven",
"value_int": 7,
"name": "Seven of Pentacles",
"name_short": "pe07",
"suit": "pentacles",
"meaning_up": "These are exceedingly contradictory; in the main, it is a card of money, business, barter; but one reading gives altercation, quarrels--and another innocence, ingenuity, purgation. ",
"meaning_rev": "Cause for anxiety regarding money which it may be proposed to lend.",
"type": "minor",
"desc": "A young man, leaning on his staff, looks intently at seven pentacles attached to a clump of greenery on his right; one would say that these were his treasures and that his heart was there. "
},
{
"value": "eight",
"value_int": 8,
"name": "Eight of Pentacles",
"name_short": "pe08",
"suit": "pentacles",
"meaning_up": "Work, employment, commission, craftsmanship, skill in craft and business, perhaps in the preparatory stage. ",
"meaning_rev": "Voided ambition, vanity, cupidity, exaction, usury. It may also signify the possession of skill, in the sense of the ingenious mind turned to cunning and intrigue.",
"type": "minor",
"desc": "An artist in stone at his work, which he exhibits in the form of trophies. "
},
{
"value": "nine",
"value_int": 9,
"name": "Nine of Pentacles",
"name_short": "pe09",
"suit": "pentacles",
"meaning_up": "Prudence, safety, success, accomplishment, certitude, discernment. ",
"meaning_rev": "Roguery, deception, voided project, bad faith.",
"type": "minor",
"desc": "A woman, with a bird upon her wrist, stands amidst a great abundance of grapevines in the garden of a manorial house. It is a wide domain, suggesting plenty in all things. Possibly it is her own possession and testifies to material well-being. "
},
{
"value": "ten",
"value_int": 10,
"name": "Ten of Pentacles",
"name_short": "pe10",
"suit": "pentacles",
"meaning_up": "Gain, riches; family matters, archives, extraction, the abode of a family. ",
"meaning_rev": "Chance, fatality, loss, robbery, games of hazard; sometimes gift, dowry, pension.",
"type": "minor",
"desc": "A man and woman beneath an archway which gives entrance to a house and domain. They are accompanied by a child, who looks curiously at two dogs accosting an ancient personage seated in the foreground. The child's hand is on one of them. "
},
{
"value": "page",
"value_int": 11,
"name": "Page of Swords",
"name_short": "swpa",
"suit": "swords",
"meaning_up": "Authority, overseeing, secret service, vigilance, spying, examination, and the qualities thereto belonging. ",
"meaning_rev": "More evil side of these qualities; what is unforeseen, unprepared state; sickness is also intimated.",
"type": "minor",
"desc": "A lithe, active figure holds a sword upright in both hands, while in the act of swift walking. He is passing over rugged land, and about his way the clouds are collocated wildly. He is alert and lithe, looking this way and that, as if an expected enemy might appear at any moment. "
},
{
"value": "knight",
"value_int": 12,
"name": "Knight of Swords",
"name_short": "swkn",
"suit": "swords",
"meaning_up": "Skill, bravery, capacity, defence, address, enmity, wrath, war, destruction, opposition, resistance, ruin. There is therefore a sense in which the card signifies death, but it carries this meaning only in its proximity to other cards of fatality. ",
"meaning_rev": "Imprudence, incapacity, extravagance.",
"type": "minor",
"desc": "He is riding in full course, as if scattering his enemies. In the design he is really a prototypical hero of romantic chivalry. He might almost be Galahad, whose sword is swift and sure because he is clean of heart. "
},
{
"value": "queen",
"value_int": 13,
"name": "Queen of Swords",
"name_short": "swqu",
"suit": "swords",
"meaning_up": "Widowhood, female sadness and embarrassment, absence, sterility, mourning, privation, separation. ",
"meaning_rev": "Malice, bigotry, artifice, prudery, bale, deceit.",
"type": "minor",
"desc": "Her right hand raises the weapon vertically and the hilt rests on an arm of her royal chair the left hand is extended, the arm raised her countenance is severe but chastened; it suggests familiarity with sorrow. It does not represent mercy, and, her sword notwithstanding, she is scarcely a symbol of power. "
},
{
"value": "king",
"value_int": 14,
"name": "King of Swords",
"name_short": "swki",
"suit": "swords",
"meaning_up": "Whatsoever arises out of the idea of judgment and all its connexions-power, command, authority, militant intelligence, law, offices of the crown, and so forth. ",
"meaning_rev": "Cruelty, perversity, barbarity, perfidy, evil intention.",
"type": "minor",
"desc": "He sits in judgment, holding the unsheathed sign of his suit. He recalls, of course, the conventional Symbol of justice in the Trumps Major, and he may represent this virtue, but he is rather the power of life and death, in virtue of his office. "
},
{
"value": "ace",
"value_int": 1,
"name": "Ace of Swords",
"name_short": "swac",
"suit": "swords",
"meaning_up": "Triumph, the excessive degree in everything, conquest, triumph of force. It is a card of great force, in love as well as in hatred. The crown may carry a much higher significance than comes usually within the sphere of fortune-telling. ",
"meaning_rev": "The same, but the results are disastrous; another account says--conception, childbirth, augmentation, multiplicity.",
"type": "minor",
"desc": "A hand issues from a cloud, grasping as word, the point of which is encircled by a crown. "
},
{
"value": "two",
"value_int": 2,
"name": "Two of Swords",
"name_short": "sw02",
"suit": "swords",
"meaning_up": "Conformity and the equipoise which it suggests, courage, friendship, concord in a state of arms; another reading gives tenderness, affection, intimacy. The suggestion of harmony and other favourable readings must be considered in a qualified manner, as Swords generally are not symbolical of beneficent forces in human affairs. ",
"meaning_rev": "Imposture, falsehood, duplicity, disloyalty.",
"type": "minor",
"desc": "A hoodwinked female figure balances two swords upon her shoulders. "
},
{
"value": "three",
"value_int": 3,
"name": "Three of Swords",
"name_short": "sw03",
"suit": "swords",
"meaning_up": "Removal, absence, delay, division, rupture, dispersion, and all that the design signifies naturally, being too simple and obvious to call for specific enumeration. ",
"meaning_rev": "Mental alienation, error, loss, distraction, disorder, confusion.",
"type": "minor",
"desc": "Three swords piercing a heart; cloud and rain behind. "
},
{
"value": "four",
"value_int": 4,
"name": "Four of Swords",
"name_short": "sw04",
"suit": "swords",
"meaning_up": "Vigilance, retreat, solitude, hermit's repose, exile, tomb and coffin. It is these last that have suggested the design. ",
"meaning_rev": "Wise administration, circumspection, economy, avarice, precaution, testament.",
"type": "minor",
"desc": "The effigy of a knight in the attitude of prayer, at full length upon his tomb. "
},
{
"value": "five",
"value_int": 5,
"name": "Five of Swords",
"name_short": "sw05",
"suit": "swords",
"meaning_up": "Degradation, destruction, revocation, infamy, dishonour, loss, with the variants and analogues of these. ",
"meaning_rev": "The same; burial and obsequies.",
"type": "minor",
"desc": "A disdainful man looks after two retreating and dejected figures. Their swords lie upon the ground. He carries two others on his left shoulder, and a third sword is in his right hand, point to earth. He is the master in possession of the field. "
},
{
"value": "six",
"value_int": 6,
"name": "Six of Swords",
"name_short": "sw06",
"suit": "swords",
"meaning_up": "journey by water, route, way, envoy, commissionary, expedient. ",
"meaning_rev": "Declaration, confession, publicity; one account says that it is a proposal of love.",
"type": "minor",
"desc": "A ferryman carrying passengers in his punt to the further shore. The course is smooth, and seeing that the freight is light, it may be noted that the work is not beyond his strength. "
},
{
"value": "seven",
"value_int": 7,
"name": "Seven of Swords",
"name_short": "sw07",
"suit": "swords",
"meaning_up": "Design, attempt, wish, hope, confidence; also quarrelling, a plan that may fail, annoyance. The design is uncertain in its import, because the significations are widely at variance with each other. ",
"meaning_rev": "Good advice, counsel, instruction, slander, babbling.",
"type": "minor",
"desc": "A man in the act of carrying away five swords rapidly; the two others of the card remain stuck in the ground. A camp is close at hand. "
},
{
"value": "eight",
"value_int": 8,
"name": "Eight of Swords",
"name_short": "sw08",
"suit": "swords",
"meaning_up": "Bad news, violent chagrin, crisis, censure, power in trammels, conflict, calumny; also sickness. ",
"meaning_rev": "Disquiet, difficulty, opposition, accident, treachery; what is unforeseen; fatality.",
"type": "minor",
"desc": "A woman, bound and hoodwinked, with the swords of the card about her. Yet it is rather a card of temporary durance than of irretrievable bondage. "
},
{
"value": "nine",
"value_int": 9,
"name": "Nine of Swords",
"name_short": "sw09",
"suit": "swords",
"meaning_up": "Death, failure, miscarriage, delay, deception, disappointment, despair. ",
"meaning_rev": "Imprisonment, suspicion, doubt, reasonable fear, shame.",
"type": "minor",
"desc": "One seated on her couch in lamentation, with the swords over her. She is as one who knows no sorrow which is like unto hers. It is a card of utter desolation. "
},
{
"value": "ten",
"value_int": 10,
"name": "Ten of Swords",
"name_short": "sw10",
"suit": "swords",
"meaning_up": "Whatsoever is intimated by the design; also pain, affliction, tears, sadness, desolation. It is not especially a card of violent death. ",
"meaning_rev": "Advantage, profit, success, favour, but none of these are permanent; also power and authority.",
"type": "minor",
"desc": "A prostrate figure, pierced by all the swords belonging to the card. "
}
]
}

82
site/src/server/tarot.rs
View File

@ -1,82 +0,0 @@
use maj::{gemini, server::Error, Response};
use rand::seq::SliceRandom;
use rand::{thread_rng, Rng};
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize, Clone, Debug)]
struct Card {
name: String,
name_short: String,
#[serde(rename = "value_int")]
value: u16,
meaning_up: String,
meaning_rev: String,
meaning: Option<String>,
#[serde(rename = "type")]
kind: String,
#[serde(default)]
upright: bool,
}
struct Deck {
cards: Vec<Card>,
}
#[derive(Serialize, Deserialize, Clone, Debug)]
struct Container {
count: u32,
cards: Vec<Card>,
}
impl Deck {
fn new() -> Result<Self, serde_json::Error> {
let ctr: Container = serde_json::from_str(include_str!("./tarot.json"))?;
let mut deck = ctr.cards;
deck.shuffle(&mut thread_rng());
Ok(Deck { cards: deck })
}
fn draw(&mut self) -> Card {
let face = thread_rng().gen::<u8>() % 2;
let mut card = self.cards.pop().unwrap();
card.upright = face == 0;
if !card.upright {
card.name = format!("{} (reversed)", card.name);
card.meaning = Some(card.meaning_rev.clone());
} else {
card.meaning = Some(card.meaning_up.clone());
}
card
}
}
pub async fn character() -> Result<Response, Error> {
let mut d = Deck::new()?;
let history = d.draw();
let recent = d.draw();
let current = d.draw();
let b = gemini::Builder::new()
.heading(1, "RPG Character Backstory Generator")
.text("Stuck coming up with a plausible backstory for a character? Try this generator out. Each of these categories lists a series of descriptors describing various stages of the character's life: their life history, some recent major event in their life and their current state/mood. This should be all you need to flesh out a believeable NPC's dialogue.")
.text("")
.heading(2, "Background / History")
.text(format!("{}: {}", history.name, history.meaning.unwrap()))
.text("")
.heading(2, "Recent Events")
.text(format!("{}: {}", recent.name, recent.meaning.unwrap()))
.text("")
.heading(2, "Current Situation")
.text(format!("{}: {}", current.name, current.meaning.unwrap()))
.text("")
.link(
"/tools/character_gen",
Some("Make a new character".to_string()),
);
Ok(Response::render(b.build()))
}

3
site/static/foo.gmi
View File

@ -1,3 +0,0 @@
# foo
Hahaha static serving works

74
site/static/gruvbox.css
View File

@ -1,74 +0,0 @@
main {
font-family: monospace, monospace;
max-width: 38rem;
padding: 2rem;
margin: auto;
}
@media only screen and (max-device-width: 736px) {
main {
padding: 0rem;
}
}
::selection {
background: #d3869b;
}
body {
background: #282828;
color: #ebdbb2;
}
pre {
background-color: #3c3836;
padding: 1em;
border: 0;
}
a, a:active, a:visited {
color: #b16286;
background-color: #1d2021;
}
h1, h2, h3, h4, h5 {
margin-bottom: .1rem;
}
blockquote {
border-left: 1px solid #bdae93;
margin: 0.5em 10px;
padding: 0.5em 10px;
}
footer {
align: center;
}
@media (prefers-color-scheme: light) {
body {
background: #fbf1c7;
color: #3c3836;
}
pre {
background-color: #ebdbb2;
padding: 1em;
border: 0;
}
a, a:active, a:visited {
color: #b16286;
background-color: #f9f5d7;
}
h1, h2, h3, h4, h5 {
margin-bottom: .1rem;
}
blockquote {
border-left: 1px solid #655c54;
margin: 0.5em 10px;
padding: 0.5em 10px;
}
}

3
site/static/index.gmi
View File

@ -1,3 +0,0 @@
# test
Hi there

15
site/templates/error.rs.html
View File

@ -1,15 +0,0 @@
@use super::{header_html, footer_html};
@(url: String, why: String)
@:header_html("Error")
<h1>Error</h1>
<p>
There was an error proxying <code>@url</code>: @why.
</p>
<hr />
@:footer_html()

7
site/templates/footer.rs.html
View File

@ -1,7 +0,0 @@
@()
<footer>
<p><a href="https://tulpa.dev/cadey/maj">Source code here</a> - From <a href="gemini://cetacean.club">Within</a></p>
</footer>
</main>
</body>
</html>

13
site/templates/header.rs.html
View File

@ -1,13 +0,0 @@
@use super::statics::*;
@(title: &str)
<!DOCTYPE html>
<html>
<head>
<title>@title</title>
<link rel="stylesheet" href="/static/@gruvbox_css.name">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body id="top">
<main>

13
site/templates/page.rs.html
View File

@ -1,13 +0,0 @@
@use super::{header_html, footer_html};
@(title: String, body: impl ToHtml)
@:header_html(&title)
<p>
@body
</p>
<hr />
@:footer_html()

5
src/client.rs
View File

@ -4,7 +4,10 @@ use tokio::{
io::{AsyncReadExt, AsyncWriteExt}, io::{AsyncReadExt, AsyncWriteExt},
net::TcpStream, net::TcpStream,
}; };
use tokio_rustls::{rustls::TLSError, TlsConnector}; use tokio_rustls::{
rustls::{TLSError},
TlsConnector,
};
use url::Url; use url::Url;
#[derive(thiserror::Error, Debug)] #[derive(thiserror::Error, Debug)]

324
src/gemini.rs
View File

@ -1 +1,323 @@
pub use gemtext::*; /// This module implements a simple text/gemini parser based on the description
/// here: https://gemini.circumlunar.space/docs/specification.html
use std::io::{self, Write};
/// Build a gemini document up from a series of nodes.
#[derive(Default)]
pub struct Builder {
nodes: Vec<Node>,
}
impl Builder {
pub fn new() -> Builder {
Builder::default()
}
pub fn text<T: Into<String>>(mut self, data: T) -> Builder {
self.nodes.push(Node::Text(data.into()));
self
}
pub fn link<T: Into<String>>(mut self, to: T, name: Option<String>) -> Builder {
self.nodes.push(Node::Link {
to: to.into(),
name: name,
});
self
}
pub fn preformatted<T: Into<String>>(mut self, data: T) -> Builder {
self.nodes.push(Node::Preformatted(data.into()));
self
}
pub fn heading<T: Into<String>>(mut self, level: u8, body: T) -> Builder {
self.nodes.push(Node::Heading {
level: level,
body: body.into(),
});
self
}
pub fn list_item<T: Into<String>>(mut self, item: T) -> Builder {
self.nodes.push(Node::ListItem(item.into()));
self
}
pub fn quote<T: Into<String>>(mut self, body: T) -> Builder {
self.nodes.push(Node::Quote(body.into()));
self
}
pub fn build(self) -> Vec<Node> {
self.nodes
}
}
/// Render a set of nodes as a document to a writer.
pub fn render(nodes: Vec<Node>, out: &mut impl Write) -> io::Result<()> {
use Node::*;
for node in nodes {
match node {
Text(body) => write!(out, "{}\n", body)?,
Link{to, name} => match name {
Some(name) => write!(out, "{} {}\n", to, name)?,
None => write!(out, "{}\n", to)?,
},
Preformatted(body) => write!(out, "```\n{}\n```\n", body)?,
Heading { level, body} => write!(out, "{} {}\n", "#".repeat(level as usize), body)?,
ListItem(body) => write!(out, "* {}\n", body)?,
Quote(body) => write!(out, "> {}\n", body)?,
};
}
Ok(())
}
/// Individual nodes of the document. Each node correlates to a line in the file.
#[derive(Debug, PartialEq, Eq)]
pub enum Node {
/// Text lines are the most fundamental line type - any line which does not
/// match the definition of another line type defined below defaults to
/// being a text line. The majority of lines in a typical text/gemini document will be text lines.
Text(String),
/// Lines beginning with the two characters "=>" are link lines, which have the following syntax:
///
/// ```gemini
/// =>[<whitespace>]<URL>[<whitespace><USER-FRIENDLY LINK NAME>]
/// ```
///
/// where:
///
/// * `<whitespace>` is any non-zero number of consecutive spaces or tabs
/// * Square brackets indicate that the enclosed content is optional.
/// * `<URL>` is a URL, which may be absolute or relative. If the URL
/// does not include a scheme, a scheme of `gemini://` is implied.
Link { to: String, name: Option<String> },
/// Any line whose first three characters are "```" (i.e. three consecutive
/// back ticks with no leading whitespace) are preformatted toggle lines.
/// These lines should NOT be included in the rendered output shown to the
/// user. Instead, these lines toggle the parser between preformatted mode
/// being "on" or "off". Preformatted mode should be "off" at the beginning
/// of a document. The current status of preformatted mode is the only
/// internal state a parser is required to maintain. When preformatted mode
/// is "on", the usual rules for identifying line types are suspended, and
/// all lines should be identified as preformatted text lines (see 5.4.4).
///
/// Preformatted text lines should be presented to the user in a "neutral",
/// monowidth font without any alteration to whitespace or stylistic
/// enhancements. Graphical clients should use scrolling mechanisms to present
/// preformatted text lines which are longer than the client viewport, in
/// preference to wrapping. In displaying preformatted text lines, clients
/// should keep in mind applications like ASCII art and computer source
/// code: in particular, source code in languages with significant whitespace
/// (e.g. Python) should be able to be copied and pasted from the client into
/// a file and interpreted/compiled without any problems arising from the
/// client's manner of displaying them.
Preformatted(String),
/// Lines beginning with "#" are heading lines. Heading lines consist of one,
/// two or three consecutive "#" characters, followed by optional whitespace,
/// followed by heading text. The number of # characters indicates the "level"
/// of header; #, ## and ### can be thought of as analogous to `<h1>`, `<h2>`
/// and `<h3>` in HTML.
///
/// Heading text should be presented to the user, and clients MAY use special
/// formatting, e.g. a larger or bold font, to indicate its status as a header
/// (simple clients may simply print the line, including its leading #s,
/// without any styling at all). However, the main motivation for the
/// definition of heading lines is not stylistic but to provide a
/// machine-readable representation of the internal structure of the document.
/// Advanced clients can use this information to, e.g. display an automatically
/// generated and hierarchically formatted "table of contents" for a long
/// document in a side-pane, allowing users to easily jump to specific sections
/// without excessive scrolling. CMS-style tools automatically generating menus
/// or Atom/RSS feeds for a directory of text/gemini files can use first
/// heading in the file as a human-friendly title.
Heading { level: u8, body: String },
/// Lines beginning with "* " are unordered list items. This line type exists
/// purely for stylistic reasons. The * may be replaced in advanced clients by
/// a bullet symbol. Any text after the "* " should be presented to the user as
/// if it were a text line, i.e. wrapped to fit the viewport and formatted
/// "nicely". Advanced clients can take the space of the bullet symbol into
/// account when wrapping long list items to ensure that all lines of text
/// corresponding to the item are offset an equal distance from the left of the screen.
ListItem(String),
/// Lines beginning with ">" are quote lines. This line type exists so that
/// advanced clients may use distinct styling to convey to readers the important
/// semantic information that certain text is being quoted from an external
/// source. For example, when wrapping long lines to the the viewport, each
/// resultant line may have a ">" symbol placed at the front.
Quote(String),
}
pub fn parse(doc: &str) -> Vec<Node> {
let mut result: Vec<Node> = vec![];
let mut collect_preformatted: bool = false;
let mut preformatted_buffer: Vec<u8> = vec![];
for line in doc.lines() {
if line == "```" {
collect_preformatted = !collect_preformatted;
if !collect_preformatted {
result.push(Node::Preformatted(
String::from_utf8(preformatted_buffer)
.unwrap()
.trim_end()
.to_string(),
));
preformatted_buffer = vec![];
}
continue;
}
if collect_preformatted && line != "```" {
write!(preformatted_buffer, "{}\n", line).unwrap();
continue;
}
// Quotes
if line.starts_with(">") {
result.push(Node::Quote(line[1..].trim().to_string()));
continue;
}
// List items
if line.starts_with("*") {
result.push(Node::ListItem(line[1..].trim().to_string()));
continue;
}
// Headings
if line.starts_with("###") {
result.push(Node::Heading {
level: 3,
body: line[3..].trim().to_string(),
});
continue;
}
if line.starts_with("##") {
result.push(Node::Heading {
level: 2,
body: line[2..].trim().to_string(),
});
continue;
}
if line.starts_with("#") {
result.push(Node::Heading {
level: 1,
body: line[1..].trim().to_string(),
});
continue;
}
// Links
if line.starts_with("=>") {
let sp = line[2..].split_ascii_whitespace().collect::<Vec<&str>>();
match sp.len() {
1 => result.push(Node::Link {
to: sp[0].trim().to_string(),
name: None,
}),
_ => result.push(Node::Link {
to: sp[0].trim().to_string(),
name: Some(sp[1..].join(" ").trim().to_string()),
}),
}
continue;
}
result.push(Node::Text(line.to_string()));
}
result
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn basic() {
let _ = pretty_env_logger::try_init();
let msg = include_str!("../majc/src/help.gmi");
let doc = super::parse(msg);
assert_ne!(doc.len(), 0);
}
#[test]
fn quote() {
let _ = pretty_env_logger::try_init();
let msg = ">hi there";
let expected: Vec<Node> = vec![Node::Quote("hi there".to_string())];
assert_eq!(expected, parse(msg));
}
#[test]
fn list() {
let _ = pretty_env_logger::try_init();
let msg = "*hi there";
let expected: Vec<Node> = vec![Node::ListItem("hi there".to_string())];
assert_eq!(expected, parse(msg));
}
#[test]
fn preformatted() {
let _ = pretty_env_logger::try_init();
let msg = "```\n\
hi there\n\
```\n\
\n\
Test\n";
let expected: Vec<Node> = vec![
Node::Preformatted("hi there".to_string()),
Node::Text(String::new()),
Node::Text("Test".to_string()),
];
assert_eq!(expected, parse(msg));
}
#[test]
fn header() {
let _ = pretty_env_logger::try_init();
let msg = "#hi\n##there\n### my friends";
let expected: Vec<Node> = vec![
Node::Heading {
level: 1,
body: "hi".to_string(),
},
Node::Heading {
level: 2,
body: "there".to_string(),
},
Node::Heading {
level: 3,
body: "my friends".to_string(),
},
];
assert_eq!(expected, parse(msg));
}
#[test]
fn link() {
let _ = pretty_env_logger::try_init();
let msg = "=>/\n=> / Go home";
let expected: Vec<Node> = vec![
Node::Link {
to: "/".to_string(),
name: None,
},
Node::Link {
to: "/".to_string(),
name: Some("Go home".to_string()),
},
];
assert_eq!(expected, parse(msg));
}
}

25
src/response.rs
View File

@ -1,6 +1,5 @@
use crate::{gemini, StatusCode}; use crate::{gemini, StatusCode};
use num::FromPrimitive; use num::FromPrimitive;
use std::fmt;
use std::io::{self, prelude::*, ErrorKind}; use std::io::{self, prelude::*, ErrorKind};
/// A Gemini response as specified in [the spec](https://gemini.circumlunar.space/docs/specification.html). /// A Gemini response as specified in [the spec](https://gemini.circumlunar.space/docs/specification.html).
@ -11,31 +10,7 @@ pub struct Response {
pub body: Vec<u8>, pub body: Vec<u8>,
} }
#[derive(thiserror::Error, Debug)]
pub struct ResponseStatusError {
status: StatusCode,
meta: String,
}
impl fmt::Display for ResponseStatusError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"{:?} ({}): {}",
self.status, self.status as u8, self.meta
)
}
}
impl Response { impl Response {
pub fn with_body(meta: String, body: Vec<u8>) -> Response {
Response {
status: StatusCode::Success,
meta: meta,
body: body,
}
}
pub fn gemini(body: Vec<u8>) -> Response { pub fn gemini(body: Vec<u8>) -> Response {
Response { Response {
status: StatusCode::Success, status: StatusCode::Success,

79
src/server/cgi.rs
View File

@ -1,79 +0,0 @@
/// A simple handler for disk based files. Will optionally chop off a prefix.
use super::{Handler as MajHandler, Request, Result};
use crate::Response;
use crate::{route, seg, split};
use async_trait::async_trait;
use std::collections::HashMap;
use std::io::Cursor;
use std::path::PathBuf;
use std::process::Command;
pub struct Handler {
base_dir: PathBuf,
}
const APPLICATION_NAME: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));
#[async_trait]
impl MajHandler for Handler {
async fn handle(&self, r: Request) -> Result<Response> {
route!(r.url.path(), {
(/"cgi-bin"/[prog_name: String][/rest..]) => self.do_cgi(prog_name, rest.to_string(), r).await;
});
Ok(Response::not_found())
}
}
impl Handler {
pub fn new(base_dir: PathBuf) -> Self {
Handler { base_dir: base_dir }
}
async fn do_cgi(&self, prog_name: String, rest: String, r: Request) -> Result<Response> {
let mut path = PathBuf::from(&self.base_dir);
path.push(&prog_name);
log::debug!("path: {:?}", path);
let query = {
match r.url.query() {
Some(q) => q.clone(),
None => "",
}
};
if let Err(why) = std::fs::metadata(&path) {
log::error!("can't find {:?}: {}", path, why);
return Ok(Response::not_found());
}
let filtered_env: HashMap<String, String> = std::env::vars()
.filter(|&(ref k, _)| k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH")
.collect();
let remote_host = format!("{}", r.addr);
let output = Command::new(&path)
.env_clear()
.envs(filtered_env)
.env("GATEWAY_INTERFACE", "CGI/1.1")
.env("SERVER_PROTOCOL", "GEMINI")
.env("SERVER_SOFTWARE", APPLICATION_NAME)
.env("GEMINI_URL", format!("{}", r.url))
.env("SCRIPT_NAME", path)
.env("PATH_INFO", rest)
.env("QUERY_STRING", query)
.env("SERVER_NAME", r.url.host_str().unwrap())
.env("SERVER_HOSTNAME", r.url.host_str().unwrap())
.env("SERVER_PORT", format!("{}", r.url.port().unwrap_or(1965)))
.env("REMOTE_HOST", &remote_host)
.env("REMOTE_ADDR", remote_host)
.env("TLS_CIPHER", "Secure")
.env("TLS_VERSION", "TLSv1.3")
.output()?;
let resp = Response::parse(&mut Cursor::new(output.stdout))?;
Ok(resp)
}
}

60
src/server/files.rs
View File

@ -1,60 +0,0 @@
/// A simple handler for disk based files. Will optionally chop off a prefix.
use super::{Handler as MajHandler, Request, Result};
use crate::Response;
use async_trait::async_trait;
use std::ffi::OsStr;
use std::path::PathBuf;
pub struct Handler {
base_dir: PathBuf,
}
impl Handler {
/// Serves static files from an OS directory with a given prefix chopped off.
pub fn new(base_dir: PathBuf) -> Self {
Handler { base_dir: base_dir }
}
}
#[async_trait]
impl MajHandler for Handler {
async fn handle(&self, r: Request) -> Result<Response> {
let mut path = std::path::PathBuf::from(&self.base_dir);
if let Some(segments) = r.url.path_segments() {
path.extend(segments);
}
log::debug!("opening file {:?}", path);
match tokio::fs::metadata(&path).await {
Ok(stat) => {
if stat.is_dir() {
if r.url.as_str().ends_with('/') {
path.push("index.gmi");
} else {
// Send a redirect when the URL for a directory has no trailing slash.
return Ok(Response::perm_redirect(format!("{}/", r.url)));
}
}
}
Err(why) => {
log::error!("file {} not found: {}", path.to_str().unwrap(), why);
return Ok(Response::not_found());
}
}
let mut file = tokio::fs::File::open(&path).await?;
let mut buf: Vec<u8> = Vec::new();
tokio::io::copy(&mut file, &mut buf).await?;
// Send header.
if path.extension() == Some(OsStr::new("gmi"))
|| path.extension() == Some(OsStr::new("gemini"))
{
return Ok(Response::gemini(buf));
}
let mime = mime_guess::from_path(&path).first_or_octet_stream();
Ok(Response::with_body(mime.essence_str().to_string(), buf))
}
}

76
src/server/mod.rs
View File

@ -1,10 +1,11 @@
use crate::{Response, StatusCode}; use crate::{Response, StatusCode};
use tokio::{ use async_std::{
prelude::*, io::prelude::*,
net::{TcpListener, TcpStream}, net::{TcpListener, TcpStream},
stream::StreamExt,
task, task,
}; };
use tokio_rustls::TlsAcceptor; use async_tls::TlsAcceptor;
use async_trait::async_trait; use async_trait::async_trait;
use rustls::Certificate; use rustls::Certificate;
use std::{error::Error as StdError, net::SocketAddr, sync::Arc}; use std::{error::Error as StdError, net::SocketAddr, sync::Arc};
@ -14,7 +15,6 @@ use url::Url;
#[allow(dead_code)] #[allow(dead_code)]
pub struct Request { pub struct Request {
pub url: Url, pub url: Url,
pub addr: SocketAddr,
pub certs: Option<Vec<Certificate>>, pub certs: Option<Vec<Certificate>>,
} }
@ -34,9 +34,6 @@ enum RequestParsingError {
mod routes; mod routes;
pub use routes::*; pub use routes::*;
pub mod cgi;
pub mod files;
#[async_trait] #[async_trait]
pub trait Handler { pub trait Handler {
async fn handle(&self, r: Request) -> Result<Response>; async fn handle(&self, r: Request) -> Result<Response>;
@ -52,10 +49,12 @@ where
{ {
let cfg = Arc::new(cfg); let cfg = Arc::new(cfg);
let listener = TcpListener::bind(&format!("{}:{}", host, port)).await?; let listener = TcpListener::bind(&format!("{}:{}", host, port)).await?;
let mut incoming = listener.incoming();
let acceptor = Arc::new(TlsAcceptor::from(cfg.clone())); let acceptor = Arc::new(TlsAcceptor::from(cfg.clone()));
while let Ok((stream, addr)) = listener.accept().await { while let Some(Ok(stream)) = incoming.next().await {
let h = h.clone(); let h = h.clone();
let acceptor = acceptor.clone(); let acceptor = acceptor.clone();
let addr = stream.peer_addr().unwrap();
let port = port.clone(); let port = port.clone();
task::spawn(handle_request(h, stream, acceptor, addr, port)); task::spawn(handle_request(h, stream, acceptor, addr, port));
@ -79,54 +78,42 @@ async fn handle_request(
Ok(url) => { Ok(url) => {
if let Some(u_port) = url.port() { if let Some(u_port) = url.port() {
if port != u_port { if port != u_port {
let _ = write_header( let _ = respond(&mut stream, "53", &["Cannot proxy"]).await;
stream,
StatusCode::ProxyRequestRefused,
"Cannot proxy to that URL",
)
.await;
return Ok(()); return Ok(());
} }
} }
if url.scheme() != "gemini" { if url.scheme() != "gemini" {
let _ = write_header( let _ = respond(&mut stream, "53", &["Cannot proxy outside geminispace"]).await;
&mut stream,
StatusCode::ProxyRequestRefused,
"Cannot proxy to that URL",
)
.await;
Err(RequestParsingError::InvalidScheme(url.scheme().to_string()))? Err(RequestParsingError::InvalidScheme(url.scheme().to_string()))?
} }
let req = Request { let req = Request {
url: url, url: url,
addr: addr, certs: stream.peer_certificates(),
certs: None,
}; };
handle(h, req, &mut stream, addr).await; handle(h, req, &mut stream, addr).await;
} }
Err(e) => { Err(e) => {
let _ = write_header(&mut stream, StatusCode::BadRequest, "Invalid request").await; respond(&mut stream, "59", &["Invalid request."]).await?;
log::error!("error from {}: {}", addr, e); log::error!("error from {}: {:?}", addr, e);
} }
} }
Ok(()) Ok(())
} }
pub async fn write_header<W: AsyncWrite + Unpin>( async fn respond<W: Write + Unpin>(mut stream: W, status: &str, meta: &[&str]) -> Result {
mut stream: W, stream.write_all(status.as_bytes()).await?;
status: StatusCode, stream.write_all(b" ").await?;
meta: &str, for m in meta {
) -> Result { stream.write_all(m.as_bytes()).await?;
stream }
.write(format!("{} {}\r\n", status as u8, meta).as_bytes()) stream.write_all(b"\r\n").await?;
.await?;
Ok(()) Ok(())
} }
/// Return the URL requested by the client. /// Return the URL requested by the client.
async fn parse_request<R: AsyncRead + Unpin>(mut stream: R) -> Result<Url> { async fn parse_request<R: Read + Unpin>(mut stream: R) -> Result<Url> {
// Because requests are limited to 1024 bytes (plus 2 bytes for CRLF), we // Because requests are limited to 1024 bytes (plus 2 bytes for CRLF), we
// can use a fixed-sized buffer on the stack, avoiding allocations and // can use a fixed-sized buffer on the stack, avoiding allocations and
// copying, and stopping bad clients from making us use too much memory. // copying, and stopping bad clients from making us use too much memory.
@ -154,17 +141,13 @@ async fn parse_request<R: AsyncRead + Unpin>(mut stream: R) -> Result<Url> {
Url::parse(request)? Url::parse(request)?
}; };
// Validate the URL. // Validate the URL. TODO: Check the hostname and port.
Ok(url) Ok(url)
} }
async fn handle<T>( async fn handle<T>(h: Arc<(dyn Handler + Send + Sync)>, req: Request, stream: &mut T, addr: SocketAddr)
h: Arc<(dyn Handler + Send + Sync)>, where
req: Request, T: Write + Unpin,
stream: &mut T,
addr: SocketAddr,
) where
T: AsyncWrite + Unpin,
{ {
let u = req.url.clone(); let u = req.url.clone();
match h.handle(req).await { match h.handle(req).await {
@ -173,18 +156,11 @@ async fn handle<T>(
.write(format!("{} {}\r\n", resp.status as u8, resp.meta).as_bytes()) .write(format!("{} {}\r\n", resp.status as u8, resp.meta).as_bytes())
.await; .await;
let _ = stream.write(&resp.body).await; let _ = stream.write(&resp.body).await;
log::info!("{}: {} {:?} {}", addr, u, resp.status, resp.meta); log::info!("{}: {} {} {:?}", addr, u, resp.meta, resp.status);
} }
Err(why) => { Err(why) => {
let _ = stream let _ = stream
.write( .write(format!("{} {:?}\r\n", StatusCode::PermanentFailure as u8, why).as_bytes())
format!(
"{} {}\r\n",
StatusCode::PermanentFailure as u8,
why.to_string()
)
.as_bytes(),
)
.await; .await;
log::error!("{}: {}: {:?}", addr, u, why); log::error!("{}: {}: {:?}", addr, u, why);
} }

4
testdata/ambig_preformatted.gmi vendored
View File

@ -1,4 +0,0 @@
``` foo
FOO
```
Foo bar