forked from projectmoon/tenebrous-dicebot
Compare commits
79 Commits
state-reva
...
master
Author | SHA1 | Date |
---|---|---|
projectmoon | 86df3c5d1f | |
projectmoon | 38a7e50c5c | |
projectmoon | e309fd1fc6 | |
projectmoon | 9262fe2cac | |
projectmoon | 724a781e7c | |
projectmoon | ef074beb96 | |
projectmoon | 81a69f329a | |
projectmoon | c9e7efa61d | |
projectmoon | f295f2b7b6 | |
projectmoon | 090ce9be45 | |
projectmoon | 2a6dff3e07 | |
projectmoon | 952f35d53a | |
projectmoon | 552daa4746 | |
projectmoon | c514b85510 | |
projectmoon | 6eb81f43d5 | |
projectmoon | 44b1e0f649 | |
projectmoon | a8ccdc9cce | |
projectmoon | 13ce7b3ee6 | |
projectmoon | 6f09a11586 | |
projectmoon | ee3ec18e06 | |
projectmoon | 126548d868 | |
Matthew Sparks | 7e7e9e534e | |
Matthew Sparks | 2d9853fbf0 | |
Matthew Sparks | 3d6210b32d | |
Matthew Sparks | 8b5973475f | |
Matthew Sparks | 1992ef4e08 | |
Matthew Sparks | f904e3a948 | |
Matthew Sparks | 8317f40f61 | |
Matthew Sparks | 069ee47364 | |
Matthew Sparks | dc242182f4 | |
Matthew Sparks | 15163ac11d | |
Matthew Sparks | 1860eaf378 | |
Matthew Sparks | 2654887d8c | |
projectmoon | 125f3d0cee | |
projectmoon | a4c3d34a97 | |
projectmoon | 86fbb05e54 | |
projectmoon | 661a943672 | |
projectmoon | d65715dee6 | |
projectmoon | 55a3bfb861 | |
projectmoon | 0050810182 | |
projectmoon | 3ba546d4a4 | |
projectmoon | ffded7b572 | |
projectmoon | cf93d14913 | |
projectmoon | cf6dd96b34 | |
projectmoon | c8c6f4d6f0 | |
projectmoon | 2488429edb | |
projectmoon | f68d5ffcc1 | |
projectmoon | 473e899275 | |
projectmoon | 1f03837bfe | |
projectmoon | 0059e3d133 | |
matthew | 915b82d0aa | |
projectmoon | cab856241d | |
projectmoon | 764426382a | |
projectmoon | b4321721c4 | |
projectmoon | 494d28486e | |
projectmoon | b7393c1907 | |
projectmoon | 3d2eb14cd3 | |
projectmoon | 53339282e0 | |
projectmoon | 7050cf037a | |
projectmoon | 0c0ddafd03 | |
projectmoon | 7f0bdc1e82 | |
projectmoon | 0ca7ad4db0 | |
projectmoon | 59be127430 | |
projectmoon | e9c0a184bd | |
projectmoon | 589d0e0dbf | |
projectmoon | 892ccf73e3 | |
projectmoon | 896acee5ba | |
projectmoon | d70df44d2a | |
projectmoon | 5f15e62c6d | |
projectmoon | ed3b582aad | |
projectmoon | 49db0062a3 | |
projectmoon | 4ae871224a | |
projectmoon | 1ebd13e912 | |
projectmoon | 8f5b6f0636 | |
projectmoon | 5b3d174edc | |
projectmoon | 495df13fe6 | |
projectmoon | de92fc8488 | |
projectmoon | b05129ad9f | |
projectmoon | 5d002e5063 |
|
@ -3,18 +3,20 @@ name: build-and-test
|
|||
|
||||
steps:
|
||||
- name: test
|
||||
image: rust:1.51
|
||||
image: rust:1.80
|
||||
commands:
|
||||
- apt-get update
|
||||
- apt-get install -y cmake
|
||||
- rustup component add rustfmt
|
||||
- cargo build --verbose --all
|
||||
- cargo test --verbose --all
|
||||
|
||||
- name: docker
|
||||
image: plugins/docker
|
||||
when:
|
||||
branch:
|
||||
- master
|
||||
ref:
|
||||
- refs/tags/v*
|
||||
- refs/heads/master
|
||||
settings:
|
||||
auto_tag: true
|
||||
username:
|
||||
|
|
File diff suppressed because it is too large
Load Diff
50
Cargo.toml
50
Cargo.toml
|
@ -1,46 +1,6 @@
|
|||
[package]
|
||||
name = "tenebrous-dicebot"
|
||||
version = "0.10.0"
|
||||
authors = ["Taylor C. Richberger <taywee@gmx.com>", "projectmoon <projectmoon@agnos.is>"]
|
||||
edition = "2018"
|
||||
license = 'AGPL-3.0-or-later'
|
||||
description = 'An async Matrix dice bot for role-playing games'
|
||||
readme = 'README.md'
|
||||
repository = 'https://git.agnos.is/projectmoon/matrix-dicebot'
|
||||
keywords = ["games", "dice", "matrix", "bot"]
|
||||
categories = ["games"]
|
||||
[workspace]
|
||||
|
||||
[dependencies]
|
||||
log = "0.4"
|
||||
tracing-subscriber = "0.2"
|
||||
toml = "0.5"
|
||||
nom = "5"
|
||||
rand = "0.8"
|
||||
rust-argon2 = "0.8"
|
||||
thiserror = "1.0"
|
||||
itertools = "0.10"
|
||||
async-trait = "0.1"
|
||||
url = "2.1"
|
||||
dirs = "3.0"
|
||||
indoc = "1.0"
|
||||
combine = "4.5"
|
||||
futures = "0.3"
|
||||
html2text = "0.2"
|
||||
phf = { version = "0.8", features = ["macros"] }
|
||||
matrix-sdk = { git = "https://github.com/matrix-org/matrix-rust-sdk", branch = "master" }
|
||||
refinery = { version = "0.5", features = ["rusqlite"]}
|
||||
barrel = { version = "0.6", features = ["sqlite3"] }
|
||||
tempfile = "3"
|
||||
substring = "1.4"
|
||||
|
||||
[dependencies.sqlx]
|
||||
version = "0.5"
|
||||
features = [ "offline", "sqlite", "runtime-tokio-native-tls" ]
|
||||
|
||||
[dependencies.serde]
|
||||
version = "1"
|
||||
features = ['derive']
|
||||
|
||||
[dependencies.tokio]
|
||||
version = "1"
|
||||
features = [ "full" ]
|
||||
members = [
|
||||
"dicebot",
|
||||
"rpc"
|
||||
]
|
||||
|
|
14
Dockerfile
14
Dockerfile
|
@ -1,16 +1,15 @@
|
|||
# Builder image with development dependencies.
|
||||
FROM bougyman/voidlinux:glibc as builder
|
||||
FROM ghcr.io/void-linux/void-linux:latest-mini-x86_64 as builder
|
||||
RUN xbps-install -S
|
||||
RUN xbps-install -yu xbps
|
||||
RUN xbps-install -Syu
|
||||
RUN xbps-install -Sy base-devel rustup cargo cmake wget gnupg
|
||||
RUN xbps-install -Sy base-devel rustup cmake wget gnupg
|
||||
RUN xbps-install -Sy openssl-devel libstdc++-devel
|
||||
RUN rustup-init -qy
|
||||
|
||||
# Install tini for signal processing and zombie killing
|
||||
ENV TINI_VERSION v0.19.0
|
||||
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /usr/local/bin/tini
|
||||
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini.asc /tini.asc
|
||||
RUN gpg --batch --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7 \
|
||||
&& gpg --batch --verify /tini.asc /usr/local/bin/tini
|
||||
RUN chmod +x /usr/local/bin/tini
|
||||
|
||||
# Build dicebot
|
||||
|
@ -20,7 +19,10 @@ ADD . ./
|
|||
RUN . /root/.cargo/env && cargo build --release
|
||||
|
||||
# Final image
|
||||
FROM bougyman/voidlinux:tiny
|
||||
FROM ghcr.io/void-linux/void-linux:latest-mini-x86_64
|
||||
RUN xbps-install -S
|
||||
RUN xbps-install -yu xbps
|
||||
RUN xbps-install -Syu
|
||||
RUN xbps-install -Sy ca-certificates libstdc++
|
||||
COPY --from=builder \
|
||||
/root/src/target/release/dicebot \
|
||||
|
|
14
LICENSE
14
LICENSE
|
@ -1,16 +1,12 @@
|
|||
This software project is governed by the terms of the Affero GNU
|
||||
General Public License. Portions of the code come from the original
|
||||
This software is governed by the terms of the Affero GNU General
|
||||
Public License. Portions of the code come from the original
|
||||
MIT-licensed project, and the terms of the MIT license also apply to
|
||||
those portions. Some portions of the code are also taken from the Rust
|
||||
Matrix SDK examples, which are governed by the MIT license. In files
|
||||
that are partially or wholly subject to the MIT license in addition to
|
||||
the Affero GNU General Public License, this is noted with a header at
|
||||
the top of the file.
|
||||
those portions. In files that are partially or wholly subject to the
|
||||
MIT license in addition to the Affero GNU General Public License, this
|
||||
is noted with a header at the top of the file.
|
||||
|
||||
Original upstream project: https://gitlab.com/Taywee/axfive-matrix-dicebot
|
||||
|
||||
Rust Matrix SDK: https://github.com/matrix-org/matrix-rust-sdk
|
||||
|
||||
For code from the original project that is governed by the MIT license
|
||||
in addition to the Affero GNU General Public License, the following
|
||||
terms apply:
|
||||
|
|
48
README.md
48
README.md
|
@ -1,6 +1,7 @@
|
|||
# Tenebrous Dicebot
|
||||
|
||||
[![Build Status](https://drone.agnos.is/api/badges/projectmoon/tenebrous-dicebot/status.svg)](https://drone.agnos.is/projectmoon/tenebrous-dicebot)
|
||||
[![Matrix Chat](https://img.shields.io/matrix/tenebrous:agnos.is?label=matrix&server_fqdn=matrix.org)][matrix-room]
|
||||
|
||||
_This repository is hosted on [Agnos.is Git][main-repo] and mirrored
|
||||
to [GitHub][github-repo]._
|
||||
|
@ -24,6 +25,23 @@ System.
|
|||
* Works in encrypted or unencrypted Matrix rooms.
|
||||
* Storing variables created by the user.
|
||||
|
||||
## Support and Community
|
||||
|
||||
The project has a Matrix room at [#tenebrous:agnos.is][matrix-room].
|
||||
It is also possible to make a post in [GitHub
|
||||
Discussions][github-discussions].
|
||||
|
||||
For reporting bugs, we prefer that you open an issue on
|
||||
[git.agnos.is][agnosis-git-issues]. However, you may also open an
|
||||
issue on [GitHub][github-issues].
|
||||
|
||||
### Development and Contributions
|
||||
|
||||
All development occurs on [git.agnos.is][main-repo]. If you wish to
|
||||
contribute, please open a pull request there. In some cases, pull
|
||||
requests from GitHub may be accepted. All contributions must be
|
||||
licensed under [AGPL 3.0 or later][agpl] to be accepted.
|
||||
|
||||
## Building and Installation
|
||||
|
||||
### Docker Image
|
||||
|
@ -46,6 +64,17 @@ root of the repository.
|
|||
After pulling or building the image, see [instructions on how to use
|
||||
the Docker image](#running-the-bot).
|
||||
|
||||
### Install from crates.io
|
||||
|
||||
The project can be from [crates.io][crates-io]. To install it, execute
|
||||
`cargo install tenebrous-dicebot`. This will make the following
|
||||
executables available on your system:
|
||||
|
||||
* `dicebot`: Main dicebot executable.
|
||||
* `dicebot-cmd`: Run dicebot commands from the command line.
|
||||
* `dicebot_migrate`: Standalone database migrator (not required).
|
||||
* `tonic_client`: Test client for the gRPC connection (not required).
|
||||
|
||||
### Build from Source
|
||||
|
||||
Precompiled executables are not yet available. Clone this repository
|
||||
|
@ -89,8 +118,16 @@ expressions.
|
|||
!r 3d12 - 5d2 + 3 - 7d3 + 20d20
|
||||
```
|
||||
|
||||
This system does not yet have the capability to handle things like D&D
|
||||
5e advantage or disadvantage.
|
||||
#### Keep/Drop Dice
|
||||
The bot supports either keeping the highest dice in a roll, or
|
||||
dropping the highest dice in a roll. This allows the bot to handle
|
||||
things like D&D 5e advantage or disadvantage.
|
||||
|
||||
```
|
||||
!roll 2d20k1
|
||||
!r 2d20dh1 + 5
|
||||
!r 10d10k5 + 10d10dh5 - 2
|
||||
```
|
||||
|
||||
### Storytelling System
|
||||
|
||||
|
@ -241,6 +278,7 @@ The most basic plans are:
|
|||
* Perhaps some sort of character sheet integration. But for that, we
|
||||
would need a sheet service.
|
||||
* Use environment variables instead of config file in Docker image.
|
||||
* Per-system game rules.
|
||||
|
||||
## Credits
|
||||
|
||||
|
@ -254,3 +292,9 @@ support added for Chronicles of Darkness and Call of Cthulhu.
|
|||
[main-repo]: https://git.agnos.is/projectmoon/tenebrous-dicebot
|
||||
[github-repo]: https://github.com/ProjectMoon/matrix-dicebot
|
||||
[roadmap]: https://git.agnos.is/projectmoon/tenebrous-dicebot/wiki/Roadmap
|
||||
[crates-io]: https://crates.io/crates/tenebrous-dicebot
|
||||
[matrix-room]: https://matrix.to/#/#tenebrous:agnos.is
|
||||
[agnosis-git-issues]: https://git.agnos.is/projectmoon/tenebrous-dicebot/issues
|
||||
[github-discussions]: https://github.com/ProjectMoon/matrix-dicebot/discussions
|
||||
[github-issues]: https://github.com/ProjectMoon/matrix-dicebot/issues
|
||||
[agpl]: https://www.gnu.org/licenses/agpl-3.0.en.html
|
||||
|
|
|
@ -0,0 +1,57 @@
|
|||
[package]
|
||||
name = "tenebrous-dicebot"
|
||||
version = "0.13.2"
|
||||
rust-version = "1.68"
|
||||
authors = ["projectmoon <projectmoon@agnos.is>", "Taylor C. Richberger <taywee@gmx.com>"]
|
||||
edition = "2018"
|
||||
license = 'AGPL-3.0-or-later'
|
||||
description = 'An async Matrix dice bot for role-playing games'
|
||||
readme = '../README.md'
|
||||
repository = 'https://git.agnos.is/projectmoon/matrix-dicebot'
|
||||
keywords = ["games", "dice", "matrix", "bot"]
|
||||
categories = ["games"]
|
||||
|
||||
[build-dependencies]
|
||||
tonic-build = "0.4"
|
||||
|
||||
[dependencies]
|
||||
# indexmap version locked fixes a dependency cycle.
|
||||
# indexmap = "=1.6.2"
|
||||
log = "0.4"
|
||||
tracing-subscriber = "0.2"
|
||||
toml = "0.5"
|
||||
nom = "5"
|
||||
rand = "0.8"
|
||||
rust-argon2 = "0.8"
|
||||
thiserror = "1.0"
|
||||
itertools = "0.10"
|
||||
async-trait = "0.1"
|
||||
url = "2.1"
|
||||
dirs = "3.0"
|
||||
indoc = "1.0"
|
||||
combine = "4.5"
|
||||
futures = "0.3"
|
||||
html2text = "0.2"
|
||||
phf = { version = "0.8", features = ["macros"] }
|
||||
matrix-sdk = { version = "0.6" }
|
||||
refinery = { version = "0.8", features = ["rusqlite"]}
|
||||
barrel = { version = "0.7", features = ["sqlite3"] }
|
||||
strum = { version = "0.22", features = ["derive"] }
|
||||
tempfile = "3"
|
||||
substring = "1.4"
|
||||
fuse-rust = "0.2"
|
||||
tonic = "0.4"
|
||||
prost = "0.7"
|
||||
tenebrous-rpc = { path = "../rpc", version = "0.1.0" }
|
||||
|
||||
[dependencies.sqlx]
|
||||
version = "0.6"
|
||||
features = [ "offline", "sqlite", "runtime-tokio-native-tls" ]
|
||||
|
||||
[dependencies.serde]
|
||||
version = "1"
|
||||
features = ['derive']
|
||||
|
||||
[dependencies.tokio]
|
||||
version = "1"
|
||||
features = [ "full" ]
|
|
@ -18,6 +18,26 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"26903a92a7de34df3e227fe599e41ae1bb61612eb80befad398383af36df0ce4": {
|
||||
"query": "DELETE FROM accounts WHERE user_id = ?",
|
||||
"describe": {
|
||||
"columns": [],
|
||||
"parameters": {
|
||||
"Right": 1
|
||||
},
|
||||
"nullable": []
|
||||
}
|
||||
},
|
||||
"2d4a32735da04509c2e3c4f99bef79ef699964f58ae332b0611f3de088596e1e": {
|
||||
"query": "INSERT INTO accounts (user_id, password, account_status)\n VALUES (?, ?, ?)\n ON CONFLICT(user_id) DO\n UPDATE SET password = ?, account_status = ?",
|
||||
"describe": {
|
||||
"columns": [],
|
||||
"parameters": {
|
||||
"Right": 5
|
||||
},
|
||||
"nullable": []
|
||||
}
|
||||
},
|
||||
"59313c67900a1a9399389720b522e572f181ae503559cd2b49d6305acb9e2207": {
|
||||
"query": "SELECT key, value as \"value: i32\" FROM user_variables\n WHERE room_id = ? AND user_id = ?",
|
||||
"describe": {
|
||||
|
@ -60,28 +80,14 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"64e137107139c56a43f7041db933671c210df4fa5110fe481d191fd63b2d3aeb": {
|
||||
"query": "SELECT user_id, password FROM accounts\n WHERE user_id = ?",
|
||||
"667b26343ce44e1c48ac689ce887ef6a0558a2ce199f7372a5dce58672499c5a": {
|
||||
"query": "INSERT INTO user_state (user_id, active_room)\n VALUES (?, ?)\n ON CONFLICT(user_id) DO\n UPDATE SET active_room = ?",
|
||||
"describe": {
|
||||
"columns": [
|
||||
{
|
||||
"name": "user_id",
|
||||
"ordinal": 0,
|
||||
"type_info": "Text"
|
||||
},
|
||||
{
|
||||
"name": "password",
|
||||
"ordinal": 1,
|
||||
"type_info": "Text"
|
||||
}
|
||||
],
|
||||
"columns": [],
|
||||
"parameters": {
|
||||
"Right": 1
|
||||
"Right": 3
|
||||
},
|
||||
"nullable": [
|
||||
false,
|
||||
false
|
||||
]
|
||||
"nullable": []
|
||||
}
|
||||
},
|
||||
"711d222911c1258365a6a0de1fe00eeec4686fd3589e976e225ad599e7cfc75d": {
|
||||
|
@ -102,66 +108,6 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"7248c8ae30bbe4bc5866e80cc277312c7f8cb9af5a8801fd8eaf178fd99eae18": {
|
||||
"query": "SELECT room_id FROM room_users\n WHERE username = ?",
|
||||
"describe": {
|
||||
"columns": [
|
||||
{
|
||||
"name": "room_id",
|
||||
"ordinal": 0,
|
||||
"type_info": "Text"
|
||||
}
|
||||
],
|
||||
"parameters": {
|
||||
"Right": 1
|
||||
},
|
||||
"nullable": [
|
||||
false
|
||||
]
|
||||
}
|
||||
},
|
||||
"97f5d58f62baca51efd8c295ca6737d1240923c69c973621cd0a718ac9eed99f": {
|
||||
"query": "SELECT room_id, room_name FROM room_info\n WHERE room_id = ?",
|
||||
"describe": {
|
||||
"columns": [
|
||||
{
|
||||
"name": "room_id",
|
||||
"ordinal": 0,
|
||||
"type_info": "Text"
|
||||
},
|
||||
{
|
||||
"name": "room_name",
|
||||
"ordinal": 1,
|
||||
"type_info": "Text"
|
||||
}
|
||||
],
|
||||
"parameters": {
|
||||
"Right": 1
|
||||
},
|
||||
"nullable": [
|
||||
false,
|
||||
false
|
||||
]
|
||||
}
|
||||
},
|
||||
"b302d586e5ac4c72c2970361ea5a5936c0b8c6dad10033c626a0ce0404cadb25": {
|
||||
"query": "SELECT username FROM room_users\n WHERE room_id = ?",
|
||||
"describe": {
|
||||
"columns": [
|
||||
{
|
||||
"name": "username",
|
||||
"ordinal": 0,
|
||||
"type_info": "Text"
|
||||
}
|
||||
],
|
||||
"parameters": {
|
||||
"Right": 1
|
||||
},
|
||||
"nullable": [
|
||||
false
|
||||
]
|
||||
}
|
||||
},
|
||||
"bba0fc255e7c30d1d2d9468c68ba38db6e8a13be035aa1152933ba9247b14f8c": {
|
||||
"query": "SELECT event_id FROM room_events\n WHERE room_id = ? AND event_id = ?",
|
||||
"describe": {
|
||||
|
@ -179,5 +125,15 @@
|
|||
false
|
||||
]
|
||||
}
|
||||
},
|
||||
"dce9bb45cf954054a920ee8b53852c6d562e3588d76bbfaa1433d8309d4e4921": {
|
||||
"query": "DELETE FROM user_state WHERE user_id = ?",
|
||||
"describe": {
|
||||
"columns": [],
|
||||
"parameters": {
|
||||
"Right": 1
|
||||
},
|
||||
"nullable": []
|
||||
}
|
||||
}
|
||||
}
|
|
@ -6,23 +6,52 @@
|
|||
use std::fmt;
|
||||
use std::ops::{Deref, DerefMut};
|
||||
|
||||
//Old stuff, for regular dice rolling. To be moved elsewhere.
|
||||
|
||||
/// A basic dice roll, in XdY notation, like "1d4" or "3d6".
|
||||
/// Optionally supports D&D advantage/disadvantge keep-or-drop
|
||||
/// functionality.
|
||||
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
|
||||
pub struct Dice {
|
||||
pub(crate) count: u32,
|
||||
pub(crate) sides: u32,
|
||||
pub(crate) keep_drop: KeepOrDrop,
|
||||
}
|
||||
|
||||
/// Enum indicating how to handle bonuses or penalties using extra
|
||||
/// dice. If set to Keep, the roll will keep the highest X number of
|
||||
/// dice in the roll, and add those together. If set to Drop, the
|
||||
/// opposite is performed, and the lowest X number of dice are added
|
||||
/// instead. If set to None, then all dice in the roll are added up as
|
||||
/// normal.
|
||||
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
|
||||
pub enum KeepOrDrop {
|
||||
/// Keep only the X highest dice for adding up to the total.
|
||||
Keep(u32),
|
||||
|
||||
/// Keep only the X lowest dice (i.e. drop the highest) for adding
|
||||
/// up to the total.
|
||||
Drop(u32),
|
||||
|
||||
/// Add up all dice in the roll for the total.
|
||||
None,
|
||||
}
|
||||
|
||||
impl fmt::Display for Dice {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "{}d{}", self.count, self.sides)
|
||||
match self.keep_drop {
|
||||
KeepOrDrop::Keep(keep) => write!(f, "{}d{}k{}", self.count, self.sides, keep),
|
||||
KeepOrDrop::Drop(drop) => write!(f, "{}d{}dh{}", self.count, self.sides, drop),
|
||||
KeepOrDrop::None => write!(f, "{}d{}", self.count, self.sides),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Dice {
|
||||
pub fn new(count: u32, sides: u32) -> Dice {
|
||||
Dice { count, sides }
|
||||
pub fn new(count: u32, sides: u32, keep_drop: KeepOrDrop) -> Dice {
|
||||
Dice {
|
||||
count,
|
||||
sides,
|
||||
keep_drop,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,360 @@
|
|||
/**
|
||||
* In addition to the terms of the AGPL, this file is governed by the
|
||||
* terms of the MIT license, from the original axfive-matrix-dicebot
|
||||
* project.
|
||||
*/
|
||||
use nom::bytes::complete::take_while;
|
||||
use nom::error::ErrorKind as NomErrorKind;
|
||||
use nom::Err as NomErr;
|
||||
use nom::{
|
||||
alt, bytes::complete::tag, character::complete::digit1, complete, many0, named,
|
||||
sequence::tuple, tag, IResult,
|
||||
};
|
||||
|
||||
use super::dice::*;
|
||||
|
||||
//******************************
|
||||
//Legacy Code
|
||||
//******************************
|
||||
|
||||
fn is_whitespace(input: char) -> bool {
|
||||
input == ' ' || input == '\n' || input == '\t' || input == '\r'
|
||||
}
|
||||
|
||||
/// Eat whitespace, returning it
|
||||
pub fn eat_whitespace(input: &str) -> IResult<&str, &str> {
|
||||
let (input, whitespace) = take_while(is_whitespace)(input)?;
|
||||
Ok((input, whitespace))
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
|
||||
enum Sign {
|
||||
Plus,
|
||||
Minus,
|
||||
}
|
||||
|
||||
/// Intermediate parsed value for a keep-drop expression to indicate
|
||||
/// which one it is.
|
||||
enum ParsedKeepOrDrop<'a> {
|
||||
Keep(&'a str),
|
||||
Drop(&'a str),
|
||||
NotPresent,
|
||||
}
|
||||
|
||||
macro_rules! too_big {
|
||||
($input: expr) => {
|
||||
NomErr::Error(($input, NomErrorKind::TooLarge))
|
||||
};
|
||||
}
|
||||
|
||||
/// Parse a dice expression. Does not eat whitespace
|
||||
fn parse_dice(input: &str) -> IResult<&str, Dice> {
|
||||
let (input, (count, _, sides)) = tuple((digit1, tag("d"), digit1))(input)?;
|
||||
let count: u32 = count.parse().map_err(|_| too_big!(count))?;
|
||||
let sides = sides.parse().map_err(|_| too_big!(sides))?;
|
||||
let (input, keep_drop) = parse_keep_or_drop(input, count)?;
|
||||
Ok((input, Dice::new(count, sides, keep_drop)))
|
||||
}
|
||||
|
||||
/// Extract keep/drop number as a string. Fails if the value is not a
|
||||
/// string.
|
||||
fn parse_keep_or_drop_text<'a>(
|
||||
symbol: &'a str,
|
||||
input: &'a str,
|
||||
) -> IResult<&'a str, ParsedKeepOrDrop<'a>> {
|
||||
let (parsed_kd, input) = match tuple::<&str, _, (_, _), _>((tag(symbol), digit1))(input) {
|
||||
// if ok, one of the expressions is present
|
||||
Ok((rest, (_, kd_expr))) => match symbol {
|
||||
"k" => (ParsedKeepOrDrop::Keep(kd_expr), rest),
|
||||
"dh" => (ParsedKeepOrDrop::Drop(kd_expr), rest),
|
||||
_ => panic!("Unrecogized keep-drop symbol: {}", symbol),
|
||||
},
|
||||
// otherwise absent (attempt to keep all dice)
|
||||
Err(_) => (ParsedKeepOrDrop::NotPresent, input),
|
||||
};
|
||||
|
||||
Ok((input, parsed_kd))
|
||||
}
|
||||
|
||||
/// Parse keep/drop expression, which consits of "k" or "dh" following
|
||||
/// a dice expression. For example, "1d4h3" or "1d4dh2".
|
||||
fn parse_keep_or_drop<'a>(input: &'a str, count: u32) -> IResult<&'a str, KeepOrDrop> {
|
||||
let (input, keep) = parse_keep_or_drop_text("k", input)?;
|
||||
let (input, drop) = parse_keep_or_drop_text("dh", input)?;
|
||||
|
||||
use ParsedKeepOrDrop::*;
|
||||
let keep_drop: KeepOrDrop = match (keep, drop) {
|
||||
//Potential valid Keep expression.
|
||||
(Keep(keep), NotPresent) => match keep.parse().map_err(|_| too_big!(input))? {
|
||||
_i if _i > count || _i == 0 => Ok(KeepOrDrop::None),
|
||||
i => Ok(KeepOrDrop::Keep(i)),
|
||||
},
|
||||
//Potential valid Drop expression.
|
||||
(NotPresent, Drop(drop)) => match drop.parse().map_err(|_| too_big!(input))? {
|
||||
_i if _i >= count => Ok(KeepOrDrop::None),
|
||||
i => Ok(KeepOrDrop::Drop(i)),
|
||||
},
|
||||
//No Keep or Drop specified; regular behavior.
|
||||
(NotPresent, NotPresent) => Ok(KeepOrDrop::None),
|
||||
//Anything else is an error.
|
||||
_ => Err(NomErr::Error((input, NomErrorKind::Many1))),
|
||||
}?;
|
||||
|
||||
Ok((input, keep_drop))
|
||||
}
|
||||
|
||||
// Parse a single digit expression. Does not eat whitespace
|
||||
fn parse_bonus(input: &str) -> IResult<&str, u32> {
|
||||
let (input, bonus) = digit1(input)?;
|
||||
Ok((input, bonus.parse().unwrap()))
|
||||
}
|
||||
|
||||
// Parse a sign expression. Eats whitespace.
|
||||
fn parse_sign(input: &str) -> IResult<&str, Sign> {
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
named!(sign(&str) -> Sign, alt!(
|
||||
complete!(tag!("+")) => { |_| Sign::Plus } |
|
||||
complete!(tag!("-")) => { |_| Sign::Minus }
|
||||
));
|
||||
|
||||
let (input, sign) = sign(input)?;
|
||||
Ok((input, sign))
|
||||
}
|
||||
|
||||
// Parse an element expression. Eats whitespace.
|
||||
fn parse_element(input: &str) -> IResult<&str, Element> {
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
named!(element(&str) -> Element, alt!(
|
||||
parse_dice => { |d| Element::Dice(d) } |
|
||||
parse_bonus => { |b| Element::Bonus(b) }
|
||||
));
|
||||
|
||||
let (input, element) = element(input)?;
|
||||
Ok((input, element))
|
||||
}
|
||||
|
||||
// Parse a signed element expression. Eats whitespace.
|
||||
fn parse_signed_element(input: &str) -> IResult<&str, SignedElement> {
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
let (input, sign) = parse_sign(input)?;
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
|
||||
let (input, element) = parse_element(input)?;
|
||||
let element = match sign {
|
||||
Sign::Plus => SignedElement::Positive(element),
|
||||
Sign::Minus => SignedElement::Negative(element),
|
||||
};
|
||||
Ok((input, element))
|
||||
}
|
||||
|
||||
// Parse a full element expression. Eats whitespace.
|
||||
pub fn parse_element_expression(input: &str) -> IResult<&str, ElementExpression> {
|
||||
named!(first_element(&str) -> SignedElement, alt!(
|
||||
parse_signed_element => { |e| e } |
|
||||
parse_element => { |e| SignedElement::Positive(e) }
|
||||
));
|
||||
let (input, first) = first_element(input)?;
|
||||
let (input, rest) = if input.trim().is_empty() {
|
||||
(input, vec![first])
|
||||
} else {
|
||||
named!(rest_elements(&str) -> Vec<SignedElement>, many0!(parse_signed_element));
|
||||
let (input, mut rest) = rest_elements(input)?;
|
||||
rest.insert(0, first);
|
||||
(input, rest)
|
||||
};
|
||||
|
||||
Ok((input, ElementExpression(rest)))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn dice_test() {
|
||||
assert_eq!(
|
||||
parse_dice("2d4"),
|
||||
Ok(("", Dice::new(2, 4, KeepOrDrop::None)))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("20d40"),
|
||||
Ok(("", Dice::new(20, 40, KeepOrDrop::None)))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("8d7"),
|
||||
Ok(("", Dice::new(8, 7, KeepOrDrop::None)))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("2d20k1"),
|
||||
Ok(("", Dice::new(2, 20, KeepOrDrop::Keep(1))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("100d10k90"),
|
||||
Ok(("", Dice::new(100, 10, KeepOrDrop::Keep(90))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("11d10k10"),
|
||||
Ok(("", Dice::new(11, 10, KeepOrDrop::Keep(10))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("12d10k11"),
|
||||
Ok(("", Dice::new(12, 10, KeepOrDrop::Keep(11))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("12d10k13"),
|
||||
Ok(("", Dice::new(12, 10, KeepOrDrop::None)))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("12d10k0"),
|
||||
Ok(("", Dice::new(12, 10, KeepOrDrop::None)))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("20d40dh5"),
|
||||
Ok(("", Dice::new(20, 40, KeepOrDrop::Drop(5))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("8d7dh9"),
|
||||
Ok(("", Dice::new(8, 7, KeepOrDrop::None)))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_dice("8d7dh8"),
|
||||
Ok(("", Dice::new(8, 7, KeepOrDrop::None)))
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cant_have_both_keep_and_drop_test() {
|
||||
let res = parse_dice("1d4k3dh2");
|
||||
assert!(res.is_err());
|
||||
match res {
|
||||
Err(NomErr::Error((_, kind))) => {
|
||||
assert_eq!(kind, NomErrorKind::Many1);
|
||||
}
|
||||
_ => panic!("Got success, expected error"),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn big_number_of_dice_doesnt_crash_test() {
|
||||
let res = parse_dice("64378631476346123874527551481376547657868536d4");
|
||||
assert!(res.is_err());
|
||||
match res {
|
||||
Err(NomErr::Error((input, kind))) => {
|
||||
assert_eq!(kind, NomErrorKind::TooLarge);
|
||||
assert_eq!(input, "64378631476346123874527551481376547657868536");
|
||||
}
|
||||
_ => panic!("Got success, expected error"),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn big_number_of_sides_doesnt_crash_test() {
|
||||
let res = parse_dice("1d423562312587425472658956278456298376234876");
|
||||
assert!(res.is_err());
|
||||
match res {
|
||||
Err(NomErr::Error((input, kind))) => {
|
||||
assert_eq!(kind, NomErrorKind::TooLarge);
|
||||
assert_eq!(input, "423562312587425472658956278456298376234876");
|
||||
}
|
||||
_ => panic!("Got success, expected error"),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn element_test() {
|
||||
assert_eq!(
|
||||
parse_element(" \t\n\r\n 8d7 \n"),
|
||||
Ok((" \n", Element::Dice(Dice::new(8, 7, KeepOrDrop::None))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element(" \t\n\r\n 3d20k2 \n"),
|
||||
Ok((" \n", Element::Dice(Dice::new(3, 20, KeepOrDrop::Keep(2)))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element(" \t\n\r\n 8 \n"),
|
||||
Ok((" \n", Element::Bonus(8)))
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn signed_element_test() {
|
||||
assert_eq!(
|
||||
parse_signed_element("+ 7"),
|
||||
Ok(("", SignedElement::Positive(Element::Bonus(7))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n- 8 \n"),
|
||||
Ok((" \n", SignedElement::Negative(Element::Bonus(8))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n- 8d4 \n"),
|
||||
Ok((
|
||||
" \n",
|
||||
SignedElement::Negative(Element::Dice(Dice::new(8, 4, KeepOrDrop::None)))
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n- 8d4k4 \n"),
|
||||
Ok((
|
||||
" \n",
|
||||
SignedElement::Negative(Element::Dice(Dice::new(8, 4, KeepOrDrop::Keep(4))))
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n+ 8d4 \n"),
|
||||
Ok((
|
||||
" \n",
|
||||
SignedElement::Positive(Element::Dice(Dice::new(8, 4, KeepOrDrop::None)))
|
||||
))
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn element_expression_test() {
|
||||
assert_eq!(
|
||||
parse_element_expression("8d4"),
|
||||
Ok((
|
||||
"",
|
||||
ElementExpression(vec![SignedElement::Positive(Element::Dice(Dice::new(
|
||||
8,
|
||||
4,
|
||||
KeepOrDrop::None
|
||||
)))])
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element_expression("\t2d20k1 + 5"),
|
||||
Ok((
|
||||
"",
|
||||
ElementExpression(vec![
|
||||
SignedElement::Positive(Element::Dice(Dice::new(2, 20, KeepOrDrop::Keep(1)))),
|
||||
SignedElement::Positive(Element::Bonus(5)),
|
||||
])
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element_expression(" - 8d4 \n "),
|
||||
Ok((
|
||||
" \n ",
|
||||
ElementExpression(vec![SignedElement::Negative(Element::Dice(Dice::new(
|
||||
8,
|
||||
4,
|
||||
KeepOrDrop::None
|
||||
)))])
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element_expression("\t3d4k2 + 7 - 5 - 6d12dh3 + 1d1 + 53 1d5 "),
|
||||
Ok((
|
||||
" 1d5 ",
|
||||
ElementExpression(vec![
|
||||
SignedElement::Positive(Element::Dice(Dice::new(3, 4, KeepOrDrop::Keep(2)))),
|
||||
SignedElement::Positive(Element::Bonus(7)),
|
||||
SignedElement::Negative(Element::Bonus(5)),
|
||||
SignedElement::Negative(Element::Dice(Dice::new(6, 12, KeepOrDrop::Drop(3)))),
|
||||
SignedElement::Positive(Element::Dice(Dice::new(1, 1, KeepOrDrop::None))),
|
||||
SignedElement::Positive(Element::Bonus(53)),
|
||||
])
|
||||
))
|
||||
);
|
||||
}
|
||||
}
|
|
@ -4,6 +4,7 @@
|
|||
* project.
|
||||
*/
|
||||
use crate::basic::dice;
|
||||
use crate::basic::dice::KeepOrDrop;
|
||||
use rand::prelude::*;
|
||||
use std::fmt;
|
||||
use std::ops::{Deref, DerefMut};
|
||||
|
@ -19,15 +20,27 @@ pub trait Rolled {
|
|||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Clone)]
|
||||
pub struct DiceRoll(pub Vec<u32>);
|
||||
/// array of rolls in order, how many dice to keep, and how many to drop
|
||||
/// keep indicates how many of the highest dice to keep
|
||||
/// drop indicates how many of the highest dice to drop
|
||||
pub struct DiceRoll (pub Vec<u32>, usize, usize);
|
||||
|
||||
impl DiceRoll {
|
||||
pub fn rolls(&self) -> &[u32] {
|
||||
&self.0
|
||||
}
|
||||
|
||||
pub fn keep(&self) -> usize {
|
||||
self.1
|
||||
}
|
||||
|
||||
pub fn drop(&self) -> usize {
|
||||
self.2
|
||||
}
|
||||
|
||||
// only count kept dice in total
|
||||
pub fn total(&self) -> u32 {
|
||||
self.0.iter().sum()
|
||||
self.0[self.2..self.1].iter().sum()
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -41,11 +54,21 @@ impl fmt::Display for DiceRoll {
|
|||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "{}", self.rolled_value())?;
|
||||
let rolls = self.rolls();
|
||||
let mut iter = rolls.iter();
|
||||
let keep = self.keep();
|
||||
let drop = self.drop();
|
||||
let mut iter = rolls.iter().enumerate();
|
||||
if let Some(first) = iter.next() {
|
||||
write!(f, " ({}", first)?;
|
||||
if drop != 0 {
|
||||
write!(f, " ([{}]", first.1)?;
|
||||
} else {
|
||||
write!(f, " ({}", first.1)?;
|
||||
}
|
||||
for roll in iter {
|
||||
write!(f, " + {}", roll)?;
|
||||
if roll.0 >= keep || roll.0 < drop {
|
||||
write!(f, " + [{}]", roll.1)?;
|
||||
} else {
|
||||
write!(f, " + {}", roll.1)?;
|
||||
}
|
||||
}
|
||||
write!(f, ")")?;
|
||||
}
|
||||
|
@ -58,11 +81,17 @@ impl Roll for dice::Dice {
|
|||
|
||||
fn roll(&self) -> DiceRoll {
|
||||
let mut rng = rand::thread_rng();
|
||||
let rolls: Vec<_> = (0..self.count)
|
||||
let mut rolls: Vec<_> = (0..self.count)
|
||||
.map(|_| rng.gen_range(1..=self.sides))
|
||||
.collect();
|
||||
// sort rolls in descending order
|
||||
rolls.sort_by(|a, b| b.cmp(a));
|
||||
|
||||
DiceRoll(rolls)
|
||||
match self.keep_drop {
|
||||
KeepOrDrop::Keep(k) => DiceRoll(rolls,k as usize, 0),
|
||||
KeepOrDrop::Drop(dh) => DiceRoll(rolls,self.count as usize, dh as usize),
|
||||
KeepOrDrop::None => DiceRoll(rolls,self.count as usize, 0),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -198,18 +227,26 @@ mod tests {
|
|||
use super::*;
|
||||
#[test]
|
||||
fn dice_roll_display_test() {
|
||||
assert_eq!(DiceRoll(vec![1, 3, 4]).to_string(), "8 (1 + 3 + 4)");
|
||||
assert_eq!(DiceRoll(vec![]).to_string(), "0");
|
||||
assert_eq!(DiceRoll(vec![1, 3, 4], 3, 0).to_string(), "8 (1 + 3 + 4)");
|
||||
assert_eq!(DiceRoll(vec![], 0, 0).to_string(), "0");
|
||||
assert_eq!(
|
||||
DiceRoll(vec![4, 7, 2, 10]).to_string(),
|
||||
DiceRoll(vec![4, 7, 2, 10], 4, 0).to_string(),
|
||||
"23 (4 + 7 + 2 + 10)"
|
||||
);
|
||||
assert_eq!(
|
||||
DiceRoll(vec![20, 13, 11, 10], 3, 0).to_string(),
|
||||
"44 (20 + 13 + 11 + [10])"
|
||||
);
|
||||
assert_eq!(
|
||||
DiceRoll(vec![20, 13, 11, 10], 4, 1).to_string(),
|
||||
"34 ([20] + 13 + 11 + 10)"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn element_roll_display_test() {
|
||||
assert_eq!(
|
||||
ElementRoll::Dice(DiceRoll(vec![1, 3, 4])).to_string(),
|
||||
ElementRoll::Dice(DiceRoll(vec![1, 3, 4], 3, 0)).to_string(),
|
||||
"8 (1 + 3 + 4)"
|
||||
);
|
||||
assert_eq!(ElementRoll::Bonus(7).to_string(), "7");
|
||||
|
@ -218,11 +255,11 @@ mod tests {
|
|||
#[test]
|
||||
fn signed_element_roll_display_test() {
|
||||
assert_eq!(
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![1, 3, 4]))).to_string(),
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![1, 3, 4], 3, 0))).to_string(),
|
||||
"8 (1 + 3 + 4)"
|
||||
);
|
||||
assert_eq!(
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![1, 3, 4]))).to_string(),
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![1, 3, 4], 3, 0))).to_string(),
|
||||
"-8 (1 + 3 + 4)"
|
||||
);
|
||||
assert_eq!(
|
||||
|
@ -239,14 +276,14 @@ mod tests {
|
|||
fn element_expression_roll_display_test() {
|
||||
assert_eq!(
|
||||
ElementExpressionRoll(vec![SignedElementRoll::Positive(ElementRoll::Dice(
|
||||
DiceRoll(vec![1, 3, 4])
|
||||
DiceRoll(vec![1, 3, 4], 3, 0)
|
||||
)),])
|
||||
.to_string(),
|
||||
"8 (1 + 3 + 4)"
|
||||
);
|
||||
assert_eq!(
|
||||
ElementExpressionRoll(vec![SignedElementRoll::Negative(ElementRoll::Dice(
|
||||
DiceRoll(vec![1, 3, 4])
|
||||
DiceRoll(vec![1, 3, 4], 3, 0)
|
||||
)),])
|
||||
.to_string(),
|
||||
"-8 (1 + 3 + 4)"
|
||||
|
@ -263,8 +300,8 @@ mod tests {
|
|||
);
|
||||
assert_eq!(
|
||||
ElementExpressionRoll(vec![
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![1, 3, 4]))),
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![1, 2]))),
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![1, 3, 4], 3, 0))),
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![1, 2], 2, 0))),
|
||||
SignedElementRoll::Positive(ElementRoll::Bonus(4)),
|
||||
SignedElementRoll::Negative(ElementRoll::Bonus(7)),
|
||||
])
|
||||
|
@ -273,13 +310,33 @@ mod tests {
|
|||
);
|
||||
assert_eq!(
|
||||
ElementExpressionRoll(vec![
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![1, 3, 4]))),
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![1, 2]))),
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![1, 3, 4], 3, 0))),
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![1, 2], 2, 0))),
|
||||
SignedElementRoll::Negative(ElementRoll::Bonus(4)),
|
||||
SignedElementRoll::Positive(ElementRoll::Bonus(7)),
|
||||
])
|
||||
.to_string(),
|
||||
"-2 (-8 (1 + 3 + 4) + 3 (1 + 2) - 4 + 7)"
|
||||
);
|
||||
assert_eq!(
|
||||
ElementExpressionRoll(vec![
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![4, 3, 1], 3, 0))),
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![12, 2], 1, 0))),
|
||||
SignedElementRoll::Negative(ElementRoll::Bonus(4)),
|
||||
SignedElementRoll::Positive(ElementRoll::Bonus(7)),
|
||||
])
|
||||
.to_string(),
|
||||
"7 (-8 (4 + 3 + 1) + 12 (12 + [2]) - 4 + 7)"
|
||||
);
|
||||
assert_eq!(
|
||||
ElementExpressionRoll(vec![
|
||||
SignedElementRoll::Negative(ElementRoll::Dice(DiceRoll(vec![4, 3, 1], 3, 1))),
|
||||
SignedElementRoll::Positive(ElementRoll::Dice(DiceRoll(vec![12, 2], 2, 0))),
|
||||
SignedElementRoll::Negative(ElementRoll::Bonus(4)),
|
||||
SignedElementRoll::Positive(ElementRoll::Bonus(7)),
|
||||
])
|
||||
.to_string(),
|
||||
"13 (-4 ([4] + 3 + 1) + 14 (12 + 2) - 4 + 7)"
|
||||
);
|
||||
}
|
||||
}
|
|
@ -1,9 +1,11 @@
|
|||
use matrix_sdk::identifiers::room_id;
|
||||
use matrix_sdk::ruma::room_id;
|
||||
use matrix_sdk::Client;
|
||||
use tenebrous_dicebot::commands;
|
||||
use tenebrous_dicebot::commands::ResponseExtractor;
|
||||
use tenebrous_dicebot::context::{Context, RoomContext};
|
||||
use tenebrous_dicebot::db::sqlite::Database;
|
||||
use tenebrous_dicebot::error::BotError;
|
||||
use tenebrous_dicebot::models::Account;
|
||||
use url::Url;
|
||||
|
||||
#[tokio::main]
|
||||
|
@ -25,10 +27,15 @@ async fn main() -> Result<(), BotError> {
|
|||
.await?;
|
||||
|
||||
let context = Context {
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver)
|
||||
.expect("Could not create matrix client"),
|
||||
room: RoomContext {
|
||||
db,
|
||||
account: Account::default(),
|
||||
matrix_client: Client::new(homeserver).await.expect("Could not create matrix client"),
|
||||
origin_room: RoomContext {
|
||||
id: &room_id!("!fakeroomid:example.com"),
|
||||
display_name: "fake room".to_owned(),
|
||||
secure: false,
|
||||
},
|
||||
active_room: RoomContext {
|
||||
id: &room_id!("!fakeroomid:example.com"),
|
||||
display_name: "fake room".to_owned(),
|
||||
secure: false,
|
|
@ -1,21 +1,36 @@
|
|||
//Needed for nested Result handling from tokio. Probably can go away after 1.47.0.
|
||||
#![type_length_limit = "7605144"]
|
||||
use futures::try_join;
|
||||
use log::error;
|
||||
use matrix_sdk::Client;
|
||||
use std::env;
|
||||
use std::sync::{Arc, RwLock};
|
||||
use tenebrous_dicebot::bot::DiceBot;
|
||||
use tenebrous_dicebot::config::*;
|
||||
use tenebrous_dicebot::db::sqlite::Database;
|
||||
use tenebrous_dicebot::error::BotError;
|
||||
use tenebrous_dicebot::rpc;
|
||||
use tenebrous_dicebot::state::DiceBotState;
|
||||
use tracing_subscriber::filter::EnvFilter;
|
||||
|
||||
/// Attempt to create config object and ddatabase connection pool from
|
||||
/// the given config path. An error is returned if config creation or
|
||||
/// database pool creation fails for some reason.
|
||||
async fn init(config_path: &str) -> Result<(Arc<Config>, Database, Client), BotError> {
|
||||
let cfg = read_config(config_path)?;
|
||||
let cfg = Arc::new(cfg);
|
||||
let sqlite_path = format!("{}/dicebot.sqlite", cfg.database_path());
|
||||
let db = Database::new(&sqlite_path).await?;
|
||||
let client = tenebrous_dicebot::matrix::create_client(&cfg).await?;
|
||||
Ok((cfg, db, client))
|
||||
}
|
||||
|
||||
#[tokio::main]
|
||||
async fn main() {
|
||||
async fn main() -> Result<(), BotError> {
|
||||
let filter = if env::var("RUST_LOG").is_ok() {
|
||||
EnvFilter::from_default_env()
|
||||
} else {
|
||||
EnvFilter::new("tenebrous_dicebot=info,dicebot=info,refinery=info")
|
||||
EnvFilter::new("tonic=info,tenebrous_dicebot=info,dicebot=info,refinery=info")
|
||||
};
|
||||
|
||||
tracing_subscriber::fmt().with_env_filter(filter).init();
|
||||
|
@ -23,7 +38,9 @@ async fn main() {
|
|||
match run().await {
|
||||
Ok(_) => (),
|
||||
Err(e) => error!("Error: {}", e),
|
||||
};
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn run() -> Result<(), BotError> {
|
||||
|
@ -32,12 +49,22 @@ async fn run() -> Result<(), BotError> {
|
|||
.next()
|
||||
.expect("Need a config as an argument");
|
||||
|
||||
let cfg = Arc::new(read_config(config_path)?);
|
||||
let sqlite_path = format!("{}/dicebot.sqlite", cfg.database_path());
|
||||
let db = Database::new(&sqlite_path).await?;
|
||||
let (cfg, db, client) = init(&config_path).await?;
|
||||
let grpc = rpc::serve_grpc(&cfg, &db, &client);
|
||||
let bot = run_bot(&cfg, &db, &client);
|
||||
|
||||
match try_join!(bot, grpc) {
|
||||
Ok(_) => (),
|
||||
Err(e) => error!("Error: {:?}", e),
|
||||
};
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn run_bot(cfg: &Arc<Config>, db: &Database, client: &Client) -> Result<(), BotError> {
|
||||
let state = Arc::new(RwLock::new(DiceBotState::new(&cfg)));
|
||||
|
||||
match DiceBot::new(&cfg, &state, &db) {
|
||||
match DiceBot::new(cfg, &state, db, client) {
|
||||
Ok(bot) => bot.run().await?,
|
||||
Err(e) => println!("Error connecting: {:?}", e),
|
||||
};
|
|
@ -0,0 +1,33 @@
|
|||
use tenebrous_rpc::protos::dicebot::UserIdRequest;
|
||||
use tenebrous_rpc::protos::dicebot::{dicebot_client::DicebotClient};
|
||||
use tonic::{metadata::MetadataValue, transport::Channel, Request};
|
||||
|
||||
async fn create_client(
|
||||
shared_secret: &str,
|
||||
) -> Result<DicebotClient<Channel>, Box<dyn std::error::Error>> {
|
||||
let channel = Channel::from_static("http://0.0.0.0:9090")
|
||||
.connect()
|
||||
.await?;
|
||||
|
||||
let bearer = MetadataValue::from_str(&format!("Bearer {}", shared_secret))?;
|
||||
|
||||
let client = DicebotClient::with_interceptor(channel, move |mut req: Request<()>| {
|
||||
req.metadata_mut().insert("authorization", bearer.clone());
|
||||
Ok(req)
|
||||
});
|
||||
|
||||
Ok(client)
|
||||
}
|
||||
|
||||
#[tokio::main]
|
||||
async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
let mut client = create_client("example-key").await?;
|
||||
|
||||
let request = tonic::Request::new(UserIdRequest {
|
||||
user_id: "@projectmoon:agnos.is".into(),
|
||||
});
|
||||
|
||||
let response = client.rooms_for_user(request).await?.into_inner();
|
||||
println!("Rooms: {:?}", response.rooms);
|
||||
Ok(())
|
||||
}
|
|
@ -0,0 +1,173 @@
|
|||
use crate::context::{Context, RoomContext};
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::error::BotError;
|
||||
use crate::logic;
|
||||
use crate::matrix;
|
||||
use crate::{
|
||||
commands::{execute_command, ExecutionResult, ResponseExtractor},
|
||||
models::Account,
|
||||
};
|
||||
use futures::stream::{self, StreamExt};
|
||||
use matrix_sdk::ruma::{OwnedEventId, RoomId};
|
||||
use matrix_sdk::{self, room::Joined, Client};
|
||||
use std::clone::Clone;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
/// Handle responding to a single command being executed. Wil print
|
||||
/// out the full result of that command.
|
||||
pub(super) async fn handle_single_result(
|
||||
client: &Client,
|
||||
cmd_result: &ExecutionResult,
|
||||
respond_to: &str,
|
||||
room: &Joined,
|
||||
event_id: OwnedEventId,
|
||||
) {
|
||||
let html = cmd_result.message_html(respond_to);
|
||||
let plain = cmd_result.message_plain(respond_to);
|
||||
matrix::send_message(client, room.room_id(), (&html, &plain), Some(event_id)).await;
|
||||
}
|
||||
|
||||
/// Format failure messages nicely in either HTML or plain text. If
|
||||
/// plain is true, plain-text will be returned. Otherwise, formatted
|
||||
/// HTML.
|
||||
fn format_failures(
|
||||
errors: &[(&str, &BotError)],
|
||||
commands_executed: usize,
|
||||
respond_to: &str,
|
||||
plain: bool,
|
||||
) -> String {
|
||||
let respond_to = match plain {
|
||||
true => respond_to.to_owned(),
|
||||
false => format!(
|
||||
"<a href=\"https://matrix.to/#/{}\">{}</a>",
|
||||
respond_to, respond_to
|
||||
),
|
||||
};
|
||||
|
||||
let failures: Vec<String> = errors
|
||||
.iter()
|
||||
.map(|&(cmd, err)| format!("<strong>{}:</strong> {}", cmd, err))
|
||||
.collect();
|
||||
|
||||
let message = format!(
|
||||
"{}: Executed {} commands ({} failed)\n\nFailures:\n{}",
|
||||
respond_to,
|
||||
commands_executed,
|
||||
errors.len(),
|
||||
failures.join("\n")
|
||||
)
|
||||
.replace("\n", "<br/>");
|
||||
|
||||
match plain {
|
||||
true => html2text::from_read(message.as_bytes(), message.len()),
|
||||
false => message,
|
||||
}
|
||||
}
|
||||
|
||||
/// Handle responding to multiple commands being executed. Will print
|
||||
/// out how many commands succeeded and failed (if any failed).
|
||||
pub(super) async fn handle_multiple_results(
|
||||
client: &Client,
|
||||
results: &[(String, ExecutionResult)],
|
||||
respond_to: &str,
|
||||
room: &Joined,
|
||||
) {
|
||||
let user_pill = format!(
|
||||
"<a href=\"https://matrix.to/#/{}\">{}</a>",
|
||||
respond_to, respond_to
|
||||
);
|
||||
|
||||
let errors: Vec<(&str, &BotError)> = results
|
||||
.into_iter()
|
||||
.filter_map(|(cmd, result)| match result {
|
||||
Err(e) => Some((cmd.as_ref(), e)),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
|
||||
let (message, plain) = if errors.len() == 0 {
|
||||
(
|
||||
format!("{}: Executed {} commands", user_pill, results.len()),
|
||||
format!("{}: Executed {} commands", respond_to, results.len()),
|
||||
)
|
||||
} else {
|
||||
(
|
||||
format_failures(&errors, results.len(), respond_to, false),
|
||||
format_failures(&errors, results.len(), respond_to, true),
|
||||
)
|
||||
};
|
||||
|
||||
matrix::send_message(client, room.room_id(), (&message, &plain), None).await;
|
||||
}
|
||||
|
||||
/// Map an account's active room value to an actual matrix room, if
|
||||
/// the account has an active room. This only retrieves the
|
||||
/// user-specified active room, and doesn't perform any further
|
||||
/// filtering.
|
||||
fn get_account_active_room(client: &Client, account: &Account) -> Result<Option<Joined>, BotError> {
|
||||
let active_room = account
|
||||
.registered_user()
|
||||
.and_then(|u| u.active_room.as_deref())
|
||||
.map(|room_id| <&RoomId>::try_from(room_id))
|
||||
.transpose()?
|
||||
.and_then(|active_room_id| client.get_joined_room(active_room_id));
|
||||
|
||||
Ok(active_room)
|
||||
}
|
||||
|
||||
/// Execute a single command in the list of commands. Can fail if the
|
||||
/// Account value cannot be created/fetched from the database, or if
|
||||
/// room display names cannot be calculated. Otherwise, the success or
|
||||
/// error of command execution itself is returned.
|
||||
async fn execute_single_command(
|
||||
command: &str,
|
||||
db: &Database,
|
||||
client: &Client,
|
||||
origin_room: &Joined,
|
||||
sender: &str,
|
||||
) -> ExecutionResult {
|
||||
let origin_ctx = RoomContext::new(origin_room, sender).await?;
|
||||
let account = logic::get_account(db, sender).await?;
|
||||
let active_room = get_account_active_room(client, &account)?;
|
||||
|
||||
// Active room is used in secure command-issuing rooms. In
|
||||
// "public" rooms, where other users are, treat origin as the
|
||||
// active room.
|
||||
let active_room = active_room
|
||||
.as_ref()
|
||||
.filter(|_| origin_ctx.secure)
|
||||
.unwrap_or(origin_room);
|
||||
|
||||
let active_ctx = RoomContext::new(active_room, sender).await?;
|
||||
|
||||
let ctx = Context {
|
||||
account,
|
||||
db: db.clone(),
|
||||
matrix_client: client.clone(),
|
||||
origin_room: origin_ctx,
|
||||
username: &sender,
|
||||
active_room: active_ctx,
|
||||
message_body: &command,
|
||||
};
|
||||
|
||||
execute_command(&ctx).await
|
||||
}
|
||||
|
||||
/// Attempt to execute all commands sent to the bot in a message. This
|
||||
/// asynchronously executes all commands given to it. A Vec of all
|
||||
/// commands and their execution results are returned.
|
||||
pub(super) async fn execute(
|
||||
commands: Vec<&str>,
|
||||
db: &Database,
|
||||
client: &Client,
|
||||
room: &Joined,
|
||||
sender: &str,
|
||||
) -> Vec<(String, ExecutionResult)> {
|
||||
stream::iter(commands)
|
||||
.then(|command| async move {
|
||||
let result = execute_single_command(command, db, client, room, sender).await;
|
||||
(command.to_owned(), result)
|
||||
})
|
||||
.collect()
|
||||
.await
|
||||
}
|
|
@ -0,0 +1,163 @@
|
|||
use super::DiceBot;
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::Rooms;
|
||||
use crate::error::BotError;
|
||||
use log::{debug, error, info, warn};
|
||||
use matrix_sdk::ruma::events::room::member::RoomMemberEventContent;
|
||||
use matrix_sdk::ruma::events::{StrippedStateEvent, SyncMessageLikeEvent};
|
||||
use matrix_sdk::{self, room::Room, ruma::events::room::message::RoomMessageEventContent};
|
||||
use matrix_sdk::{Client, DisplayName};
|
||||
use std::ops::Sub;
|
||||
use std::time::UNIX_EPOCH;
|
||||
use std::time::{Duration, SystemTime};
|
||||
|
||||
/// Check if a message is recent enough to actually process. If the
|
||||
/// message is within "oldest_message_age" seconds, this function
|
||||
/// returns true. If it's older than that, it returns false and logs a
|
||||
/// debug message.
|
||||
fn check_message_age(
|
||||
event: &SyncMessageLikeEvent<RoomMessageEventContent>,
|
||||
oldest_message_age: u64,
|
||||
) -> bool {
|
||||
let sending_time = event
|
||||
.origin_server_ts()
|
||||
.to_system_time()
|
||||
.unwrap_or(UNIX_EPOCH);
|
||||
|
||||
let oldest_timestamp = SystemTime::now().sub(Duration::from_secs(oldest_message_age));
|
||||
|
||||
if sending_time > oldest_timestamp {
|
||||
true
|
||||
} else {
|
||||
let age = match oldest_timestamp.duration_since(sending_time) {
|
||||
Ok(n) => format!("{} seconds too old", n.as_secs()),
|
||||
Err(_) => "before the UNIX epoch".to_owned(),
|
||||
};
|
||||
|
||||
debug!("Ignoring message because it is {}: {:?}", age, event);
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
/// Determine whether or not to process a received message. This check
|
||||
/// is necessary in addition to the event processing check because we
|
||||
/// may receive message events when entering a room for the first
|
||||
/// time, and we don't want to respond to things before the bot was in
|
||||
/// the channel, but we do want to respond to things that were sent if
|
||||
/// the bot left and rejoined quickly.
|
||||
async fn should_process_message<'a>(
|
||||
bot: &DiceBot,
|
||||
event: &SyncMessageLikeEvent<RoomMessageEventContent>,
|
||||
) -> Result<(String, String), BotError> {
|
||||
//Ignore messages that are older than configured duration.
|
||||
if !check_message_age(event, bot.config.oldest_message_age()) {
|
||||
let state_check = bot.state.read().unwrap();
|
||||
if !((*state_check).logged_skipped_old_messages()) {
|
||||
drop(state_check);
|
||||
let mut state = bot.state.write().unwrap();
|
||||
(*state).skipped_old_messages();
|
||||
}
|
||||
|
||||
return Err(BotError::ShouldNotProcessError);
|
||||
}
|
||||
|
||||
let msg_body: String = event
|
||||
.as_original()
|
||||
.map(|e| e.content.body())
|
||||
.map(str::to_string)
|
||||
.unwrap_or_else(|| String::new());
|
||||
|
||||
let sender_username: String = format!(
|
||||
"@{}:{}",
|
||||
event.sender().localpart(),
|
||||
event.sender().server_name()
|
||||
);
|
||||
|
||||
// Do not process messages from the bot itself. Otherwise it might
|
||||
// try to execute its own commands.
|
||||
let bot_username = bot
|
||||
.client
|
||||
.user_id()
|
||||
.map(|u| format!("@{}:{}", u.localpart(), u.server_name()))
|
||||
.unwrap_or_default();
|
||||
|
||||
if sender_username == bot_username {
|
||||
return Err(BotError::ShouldNotProcessError);
|
||||
}
|
||||
|
||||
Ok((msg_body, sender_username))
|
||||
}
|
||||
|
||||
async fn should_process_event(db: &Database, room_id: &str, event_id: &str) -> bool {
|
||||
db.should_process(room_id, event_id)
|
||||
.await
|
||||
.unwrap_or_else(|e| {
|
||||
error!(
|
||||
"Database error when checking if we should process an event: {}",
|
||||
e.to_string()
|
||||
);
|
||||
false
|
||||
})
|
||||
}
|
||||
|
||||
pub(super) async fn on_stripped_state_member(
|
||||
event: StrippedStateEvent<RoomMemberEventContent>,
|
||||
client: Client,
|
||||
room: Room,
|
||||
) {
|
||||
let room = match room {
|
||||
Room::Invited(invited_room) => invited_room,
|
||||
_ => return,
|
||||
};
|
||||
|
||||
if room.own_user_id().as_str() != event.state_key {
|
||||
return;
|
||||
}
|
||||
|
||||
info!(
|
||||
"Autojoining room {}",
|
||||
room.display_name()
|
||||
.await
|
||||
.ok()
|
||||
.unwrap_or_else(|| DisplayName::Named("[error]".to_string()))
|
||||
);
|
||||
|
||||
if let Err(e) = client.join_room_by_id(&room.room_id()).await {
|
||||
warn!("Could not join room: {}", e.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
pub(super) async fn on_room_message(
|
||||
event: SyncMessageLikeEvent<RoomMessageEventContent>,
|
||||
room: Room,
|
||||
bot: DiceBot,
|
||||
) {
|
||||
let room = match room {
|
||||
Room::Joined(joined_room) => joined_room,
|
||||
_ => return,
|
||||
};
|
||||
|
||||
let room_id = room.room_id().as_str();
|
||||
if !should_process_event(&bot.db, room_id, event.event_id().as_str()).await {
|
||||
return;
|
||||
}
|
||||
|
||||
let (msg_body, sender_username) =
|
||||
if let Ok((msg_body, sender_username)) = should_process_message(&bot, &event).await {
|
||||
(msg_body, sender_username)
|
||||
} else {
|
||||
return;
|
||||
};
|
||||
|
||||
let results = bot
|
||||
.execute_commands(&room, &sender_username, &msg_body)
|
||||
.await;
|
||||
|
||||
bot.handle_results(
|
||||
&room,
|
||||
&sender_username,
|
||||
event.event_id().to_owned(),
|
||||
results,
|
||||
)
|
||||
.await;
|
||||
}
|
|
@ -1,16 +1,18 @@
|
|||
use crate::commands::{ExecutionError, ExecutionResult};
|
||||
use crate::commands::ExecutionResult;
|
||||
use crate::config::*;
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::DbState;
|
||||
use crate::error::BotError;
|
||||
use crate::state::DiceBotState;
|
||||
use dirs;
|
||||
use log::info;
|
||||
use matrix_sdk::{self, identifiers::EventId, room::Joined, Client, ClientConfig, SyncSettings};
|
||||
use matrix_sdk::room::Room;
|
||||
use matrix_sdk::ruma::events::room::message::RoomMessageEventContent;
|
||||
use matrix_sdk::ruma::events::SyncMessageLikeEvent;
|
||||
use matrix_sdk::ruma::OwnedEventId;
|
||||
use matrix_sdk::{self, room::Joined, Client};
|
||||
use matrix_sdk::config::SyncSettings;
|
||||
use std::clone::Clone;
|
||||
use std::path::PathBuf;
|
||||
use std::sync::{Arc, RwLock};
|
||||
use url::Url;
|
||||
|
||||
mod command_execution;
|
||||
pub mod event_handlers;
|
||||
|
@ -21,6 +23,7 @@ const MAX_COMMANDS_PER_MESSAGE: usize = 50;
|
|||
|
||||
/// The DiceBot struct represents an active dice bot. The bot is not
|
||||
/// connected to Matrix until its run() function is called.
|
||||
#[derive(Clone)]
|
||||
pub struct DiceBot {
|
||||
/// A reference to the configuration read in on application start.
|
||||
config: Arc<Config>,
|
||||
|
@ -35,22 +38,6 @@ pub struct DiceBot {
|
|||
db: Database,
|
||||
}
|
||||
|
||||
fn cache_dir() -> Result<PathBuf, BotError> {
|
||||
let mut dir = dirs::cache_dir().ok_or(BotError::NoCacheDirectoryError)?;
|
||||
dir.push("matrix-dicebot");
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
/// Creates the matrix client.
|
||||
fn create_client(config: &Config) -> Result<Client, BotError> {
|
||||
let cache_dir = cache_dir()?;
|
||||
//let store = JsonStore::open(&cache_dir)?;
|
||||
let client_config = ClientConfig::new().store_path(cache_dir);
|
||||
let homeserver_url = Url::parse(&config.matrix_homeserver())?;
|
||||
|
||||
Ok(Client::new_with_config(homeserver_url, client_config)?)
|
||||
}
|
||||
|
||||
impl DiceBot {
|
||||
/// Create a new dicebot with the given configuration and state
|
||||
/// actor. This function returns a Result because it is possible
|
||||
|
@ -60,9 +47,10 @@ impl DiceBot {
|
|||
config: &Arc<Config>,
|
||||
state: &Arc<RwLock<DiceBotState>>,
|
||||
db: &Database,
|
||||
client: &Client,
|
||||
) -> Result<Self, BotError> {
|
||||
Ok(DiceBot {
|
||||
client: create_client(&config)?,
|
||||
client: client.clone(),
|
||||
config: config.clone(),
|
||||
state: state.clone(),
|
||||
db: db.clone(),
|
||||
|
@ -81,12 +69,14 @@ impl DiceBot {
|
|||
let device_id: Option<String> = self.db.get_device_id().await?;
|
||||
let device_id: Option<&str> = device_id.as_deref();
|
||||
|
||||
client
|
||||
.login(username, password, device_id, Some("matrix dice bot"))
|
||||
.await?;
|
||||
let no_device_ld_login = || client.login_username(username, password);
|
||||
let device_id_login = |id| client.login_username(username, password).device_id(id);
|
||||
let login = device_id.map_or_else(no_device_ld_login, device_id_login);
|
||||
|
||||
login.send().await?;
|
||||
|
||||
if device_id.is_none() {
|
||||
let device_id = client.device_id().await.ok_or(BotError::NoDeviceIdFound)?;
|
||||
let device_id = client.device_id().ok_or(BotError::NoDeviceIdFound)?;
|
||||
self.db.set_device_id(device_id.as_str()).await?;
|
||||
info!("Recorded new device ID: {}", device_id.as_str());
|
||||
} else {
|
||||
|
@ -97,19 +87,35 @@ impl DiceBot {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
async fn bind_events(&self) {
|
||||
//on room message: need closure to pass bot ref in.
|
||||
self.client
|
||||
.add_event_handler({
|
||||
let bot: DiceBot = self.clone();
|
||||
move |event: SyncMessageLikeEvent<RoomMessageEventContent>, room: Room| {
|
||||
let bot = bot.clone();
|
||||
async move { event_handlers::on_room_message(event, room, bot).await }
|
||||
}
|
||||
});
|
||||
|
||||
//auto-join handler
|
||||
self.client
|
||||
.add_event_handler(event_handlers::on_stripped_state_member);
|
||||
}
|
||||
|
||||
/// Logs the bot in to Matrix and listens for events until program
|
||||
/// terminated, or a panic occurs. Originally adapted from the
|
||||
/// matrix-rust-sdk command bot example.
|
||||
pub async fn run(self) -> Result<(), BotError> {
|
||||
let client = self.client.clone();
|
||||
self.login(&client).await?;
|
||||
self.bind_events().await;
|
||||
|
||||
client.set_event_handler(Box::new(self)).await;
|
||||
info!("Listening for commands");
|
||||
|
||||
// TODO replace with sync_with_callback for cleaner shutdown
|
||||
// process.
|
||||
client.sync(SyncSettings::default()).await;
|
||||
client.sync(SyncSettings::default()).await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -129,10 +135,7 @@ impl DiceBot {
|
|||
let results: Vec<(String, ExecutionResult)> = if commands.len() < MAX_COMMANDS_PER_MESSAGE {
|
||||
command_execution::execute(commands, &self.db, &self.client, room, sender).await
|
||||
} else {
|
||||
vec![(
|
||||
"".to_owned(),
|
||||
Err(ExecutionError(BotError::MessageTooLarge)),
|
||||
)]
|
||||
vec![("".to_owned(), Err(BotError::MessageTooLarge))]
|
||||
};
|
||||
|
||||
results
|
||||
|
@ -142,7 +145,7 @@ impl DiceBot {
|
|||
&self,
|
||||
room: &Joined,
|
||||
sender_username: &str,
|
||||
event_id: EventId,
|
||||
event_id: OwnedEventId,
|
||||
results: Vec<(String, ExecutionResult)>,
|
||||
) {
|
||||
if results.len() >= 1 {
|
|
@ -332,7 +332,7 @@ mod tests {
|
|||
macro_rules! dummy_room {
|
||||
() => {
|
||||
crate::context::RoomContext {
|
||||
id: &matrix_sdk::identifiers::room_id!("!fakeroomid:example.com"),
|
||||
id: &matrix_sdk::ruma::room_id!("!fakeroomid:example.com"),
|
||||
display_name: "displayname".to_owned(),
|
||||
secure: false,
|
||||
}
|
||||
|
@ -483,9 +483,11 @@ mod tests {
|
|||
.unwrap();
|
||||
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "username",
|
||||
message_body: "message",
|
||||
};
|
||||
|
@ -523,9 +525,11 @@ mod tests {
|
|||
|
||||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "username",
|
||||
message_body: "message",
|
||||
};
|
||||
|
@ -560,16 +564,23 @@ mod tests {
|
|||
|
||||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db.clone(),
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "username",
|
||||
message_body: "message",
|
||||
};
|
||||
|
||||
db.set_user_variable(&ctx.username, &ctx.room.id.as_str(), "myvariable", 10)
|
||||
.await
|
||||
.expect("could not set myvariable to 10");
|
||||
db.set_user_variable(
|
||||
&ctx.username,
|
||||
&ctx.origin_room.id.as_str(),
|
||||
"myvariable",
|
||||
10,
|
||||
)
|
||||
.await
|
||||
.expect("could not set myvariable to 10");
|
||||
|
||||
let amounts = vec![Amount {
|
||||
operator: Operator::Plus,
|
|
@ -45,13 +45,13 @@ pub fn parse_modifiers(input: &str) -> Result<DicePoolModifiers, DiceParsingErro
|
|||
let (result, rest) = parser.parse(input)?;
|
||||
|
||||
if rest.len() == 0 {
|
||||
convert_to_info(&result)
|
||||
convert_to_modifiers(&result)
|
||||
} else {
|
||||
Err(DiceParsingError::UnconsumedInput)
|
||||
}
|
||||
}
|
||||
|
||||
fn convert_to_info(parsed: &Vec<ParsedInfo>) -> Result<DicePoolModifiers, DiceParsingError> {
|
||||
fn convert_to_modifiers(parsed: &Vec<ParsedInfo>) -> Result<DicePoolModifiers, DiceParsingError> {
|
||||
use ParsedInfo::*;
|
||||
if parsed.len() == 0 {
|
||||
Ok(DicePoolModifiers::default())
|
||||
|
@ -79,19 +79,8 @@ fn convert_to_info(parsed: &Vec<ParsedInfo>) -> Result<DicePoolModifiers, DicePa
|
|||
}
|
||||
|
||||
pub fn parse_dice_pool(input: &str) -> Result<DicePool, BotError> {
|
||||
//The "modifiers:" part is optional. Assume amounts if no modifier
|
||||
//section found.
|
||||
let split = input.split(":").collect::<Vec<_>>();
|
||||
let (modifiers_str, amounts_str) = (match split[..] {
|
||||
[amounts] => Ok(("", amounts)),
|
||||
[modifiers, amounts] => Ok((modifiers, amounts)),
|
||||
_ => Err(BotError::DiceParsingError(
|
||||
DiceParsingError::UnconsumedInput,
|
||||
)),
|
||||
})?;
|
||||
|
||||
let (amounts, modifiers_str) = parse_amounts(input)?;
|
||||
let modifiers = parse_modifiers(modifiers_str)?;
|
||||
let amounts = parse_amounts(&amounts_str)?;
|
||||
Ok(DicePool::new(amounts, modifiers))
|
||||
}
|
||||
|
||||
|
@ -175,7 +164,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn dice_pool_number_with_quality() {
|
||||
let result = parse_dice_pool("n:8");
|
||||
let result = parse_dice_pool("8 n");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
|
@ -186,7 +175,7 @@ mod tests {
|
|||
#[test]
|
||||
fn dice_pool_number_with_success_change() {
|
||||
let modifiers = DicePoolModifiers::custom_exceptional_on(3);
|
||||
let result = parse_dice_pool("s3:8");
|
||||
let result = parse_dice_pool("8 s3");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(result.unwrap(), DicePool::easy_with_modifiers(8, modifiers));
|
||||
}
|
||||
|
@ -194,7 +183,7 @@ mod tests {
|
|||
#[test]
|
||||
fn dice_pool_with_quality_and_success_change() {
|
||||
let modifiers = DicePoolModifiers::custom(DicePoolQuality::Rote, 3);
|
||||
let result = parse_dice_pool("rs3:8");
|
||||
let result = parse_dice_pool("8 rs3");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(result.unwrap(), DicePool::easy_with_modifiers(8, modifiers));
|
||||
}
|
||||
|
@ -224,20 +213,20 @@ mod tests {
|
|||
|
||||
let expected = DicePool::new(amounts, modifiers);
|
||||
|
||||
let result = parse_dice_pool("rs3:8+10-2+varname");
|
||||
let result = parse_dice_pool("8+10-2+varname rs3");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(result.unwrap(), expected);
|
||||
|
||||
let result = parse_dice_pool("rs3:8+10- 2 + varname");
|
||||
let result = parse_dice_pool("8+10- 2 + varname rs3");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(result.unwrap(), expected);
|
||||
|
||||
let result = parse_dice_pool("rs3 : 8+ 10 -2 + varname");
|
||||
let result = parse_dice_pool("8+ 10 -2 + varname rs3");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(result.unwrap(), expected);
|
||||
|
||||
//This one has tabs in it.
|
||||
let result = parse_dice_pool(" r s3 : 8 + 10 -2 + varname");
|
||||
let result = parse_dice_pool(" 8 + 10 -2 + varname r s3");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(result.unwrap(), expected);
|
||||
}
|
|
@ -0,0 +1,48 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::basic::dice::ElementExpression;
|
||||
use crate::basic::parser::parse_element_expression;
|
||||
use crate::basic::roll::Roll;
|
||||
use crate::context::Context;
|
||||
use crate::error::BotError;
|
||||
use async_trait::async_trait;
|
||||
use nom::Err as NomErr;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
pub struct RollCommand(pub ElementExpression);
|
||||
|
||||
impl TryFrom<String> for RollCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
let result = parse_element_expression(&input);
|
||||
match result {
|
||||
Ok((rest, expression)) if rest.len() == 0 => Ok(RollCommand(expression)),
|
||||
//"Legacy code boundary": translates Nom errors into BotErrors.
|
||||
Ok(_) => Err(BotError::NomParserIncomplete),
|
||||
Err(NomErr::Error(e)) => Err(BotError::NomParserError(e.1)),
|
||||
Err(NomErr::Failure(e)) => Err(BotError::NomParserError(e.1)),
|
||||
Err(NomErr::Incomplete(_)) => Err(BotError::NomParserIncomplete),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for RollCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"roll regular dice"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
false
|
||||
}
|
||||
|
||||
async fn execute(&self, _ctx: &Context<'_>) -> ExecutionResult {
|
||||
let roll = self.0.roll();
|
||||
let html = format!(
|
||||
"<strong>Dice:</strong> {}</p><p><strong>Result</strong>: {}",
|
||||
self.0, roll
|
||||
);
|
||||
|
||||
Execution::success(html)
|
||||
}
|
||||
}
|
|
@ -1,10 +1,29 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::cofd::dice::{roll_pool, DicePool, DicePoolWithContext};
|
||||
use crate::cofd::parser::{create_chance_die, parse_dice_pool};
|
||||
use crate::context::Context;
|
||||
use crate::error::BotError;
|
||||
use async_trait::async_trait;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
pub struct PoolRollCommand(pub DicePool);
|
||||
|
||||
impl PoolRollCommand {
|
||||
pub fn chance_die() -> Result<PoolRollCommand, BotError> {
|
||||
let pool = create_chance_die()?;
|
||||
Ok(PoolRollCommand(pool))
|
||||
}
|
||||
}
|
||||
|
||||
impl TryFrom<String> for PoolRollCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
let pool = parse_dice_pool(&input)?;
|
||||
Ok(PoolRollCommand(pool))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for PoolRollCommand {
|
||||
fn name(&self) -> &'static str {
|
|
@ -4,10 +4,22 @@ use crate::cthulhu::dice::{
|
|||
advancement_roll, regular_roll, AdvancementRoll, AdvancementRollWithContext, DiceRoll,
|
||||
DiceRollWithContext,
|
||||
};
|
||||
use crate::cthulhu::parser::{parse_advancement_roll, parse_regular_roll};
|
||||
use crate::error::BotError;
|
||||
use async_trait::async_trait;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
pub struct CthRoll(pub DiceRoll);
|
||||
|
||||
impl TryFrom<String> for CthRoll {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
let roll = parse_regular_roll(&input)?;
|
||||
Ok(CthRoll(roll))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for CthRoll {
|
||||
fn name(&self) -> &'static str {
|
||||
|
@ -33,6 +45,15 @@ impl Command for CthRoll {
|
|||
|
||||
pub struct CthAdvanceRoll(pub AdvancementRoll);
|
||||
|
||||
impl TryFrom<String> for CthAdvanceRoll {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
let roll = parse_advancement_roll(&input)?;
|
||||
Ok(CthAdvanceRoll(roll))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for CthAdvanceRoll {
|
||||
fn name(&self) -> &'static str {
|
|
@ -0,0 +1,200 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::db::Users;
|
||||
use crate::error::BotError::{AccountDoesNotExist, PasswordCreationError};
|
||||
use crate::logic::hash_password;
|
||||
use crate::models::{AccountStatus, User};
|
||||
use crate::{context::Context, error::BotError};
|
||||
use async_trait::async_trait;
|
||||
use std::convert::{Into, TryFrom};
|
||||
|
||||
pub struct RegisterCommand;
|
||||
|
||||
impl TryFrom<String> for RegisterCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(_: String) -> Result<Self, Self::Error> {
|
||||
Ok(RegisterCommand)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for RegisterCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"register user account"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
if ctx.account.is_registered() {
|
||||
return Err(BotError::AccountAlreadyExists);
|
||||
}
|
||||
|
||||
let user = User {
|
||||
username: ctx.username.to_owned(),
|
||||
password: None,
|
||||
account_status: AccountStatus::Registered,
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
ctx.db.upsert_user(&user).await?;
|
||||
|
||||
Execution::success(format!(
|
||||
"User account {} registered for bot commands.",
|
||||
ctx.username
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
pub struct UnlinkCommand(pub String);
|
||||
|
||||
impl TryFrom<String> for UnlinkCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||
Ok(UnlinkCommand(value))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for UnlinkCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"unlink user accountx from external applications"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let mut user = ctx
|
||||
.db
|
||||
.get_user(&ctx.username)
|
||||
.await?
|
||||
.ok_or(BotError::AccountDoesNotExist)?;
|
||||
|
||||
user.password = None;
|
||||
ctx.db.upsert_user(&user).await?;
|
||||
|
||||
Execution::success(format!(
|
||||
"Accounted {} is now inaccessible to external applications.",
|
||||
ctx.username
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
pub struct LinkCommand(pub String);
|
||||
|
||||
impl TryFrom<String> for LinkCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||
Ok(LinkCommand(value))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for LinkCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"link user account to external applications"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let mut user = ctx
|
||||
.db
|
||||
.get_user(&ctx.username)
|
||||
.await?
|
||||
.ok_or(BotError::AccountDoesNotExist)?;
|
||||
|
||||
let pw_hash = hash_password(&self.0).map_err(|e| PasswordCreationError(e))?;
|
||||
user.password = Some(pw_hash);
|
||||
ctx.db.upsert_user(&user).await?;
|
||||
|
||||
Execution::success(format!(
|
||||
"Accounted now available for external use. Please log in to \
|
||||
external applications with username {} and the password you set.",
|
||||
ctx.username
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
pub struct CheckCommand;
|
||||
|
||||
impl TryFrom<String> for CheckCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(_: String) -> Result<Self, Self::Error> {
|
||||
Ok(CheckCommand)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for CheckCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"check user account status"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let user = ctx.db.get_user(&ctx.username).await?;
|
||||
|
||||
match user {
|
||||
Some(user) => match user.password {
|
||||
Some(_) => Execution::success(
|
||||
"Account exists, and is available to external applications with a password. \
|
||||
If you forgot your password, change it with !link."
|
||||
.to_string(),
|
||||
),
|
||||
None => Execution::success(
|
||||
"Account exists, but is not available to external applications.".to_string(),
|
||||
),
|
||||
},
|
||||
None => Execution::success(
|
||||
"No account registered. Only simple commands in public rooms are available."
|
||||
.to_string(),
|
||||
),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub struct UnregisterCommand;
|
||||
|
||||
impl TryFrom<String> for UnregisterCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(_: String) -> Result<Self, Self::Error> {
|
||||
Ok(UnregisterCommand)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for UnregisterCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"unregister user account"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let user = ctx.db.get_user(&ctx.username).await?;
|
||||
|
||||
match user {
|
||||
Some(_) => {
|
||||
ctx.db.delete_user(&ctx.username).await?;
|
||||
Execution::success("Your user account has been removed.".to_string())
|
||||
}
|
||||
None => Err(AccountDoesNotExist.into()),
|
||||
}
|
||||
}
|
||||
}
|
|
@ -1,10 +1,21 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::context::Context;
|
||||
use crate::help::HelpTopic;
|
||||
use crate::error::BotError;
|
||||
use crate::help::{parse_help_topic, HelpTopic};
|
||||
use async_trait::async_trait;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
pub struct HelpCommand(pub Option<HelpTopic>);
|
||||
|
||||
impl TryFrom<String> for HelpCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
let topic = parse_help_topic(&input);
|
||||
Ok(HelpCommand(topic))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for HelpCommand {
|
||||
fn name(&self) -> &'static str {
|
|
@ -3,7 +3,6 @@ use crate::error::BotError;
|
|||
use async_trait::async_trait;
|
||||
use log::{error, info};
|
||||
use thiserror::Error;
|
||||
use BotError::DataError;
|
||||
|
||||
pub mod basic_rolling;
|
||||
pub mod cofd;
|
||||
|
@ -11,6 +10,7 @@ pub mod cthulhu;
|
|||
pub mod management;
|
||||
pub mod misc;
|
||||
pub mod parser;
|
||||
pub mod rooms;
|
||||
pub mod variables;
|
||||
|
||||
/// A custom error type specifically related to parsing command text.
|
||||
|
@ -46,29 +46,9 @@ impl Execution {
|
|||
}
|
||||
}
|
||||
|
||||
/// Wraps a command execution failure. Provides HTML formatting for
|
||||
/// any error message from the BotError type, similar to how Execution
|
||||
/// provides formatting for successfully executed commands.
|
||||
#[derive(Error, Debug)]
|
||||
#[error("{0}")]
|
||||
pub struct ExecutionError(#[from] pub BotError);
|
||||
|
||||
impl From<crate::db::errors::DataError> for ExecutionError {
|
||||
fn from(error: crate::db::errors::DataError) -> Self {
|
||||
Self(DataError(error))
|
||||
}
|
||||
}
|
||||
|
||||
impl ExecutionError {
|
||||
/// Error message in bolded HTML.
|
||||
pub fn html(&self) -> String {
|
||||
format!("<p><strong>{}</strong></p>", self.0)
|
||||
}
|
||||
}
|
||||
|
||||
/// Wraps either a successful command execution response, or an error
|
||||
/// that occurred.
|
||||
pub type ExecutionResult = Result<Execution, ExecutionError>;
|
||||
pub type ExecutionResult = Result<Execution, BotError>;
|
||||
|
||||
/// Extract response messages out of a type, whether it is success or
|
||||
/// failure.
|
||||
|
@ -76,6 +56,8 @@ pub trait ResponseExtractor {
|
|||
/// HTML representation of the message, directly mentioning the
|
||||
/// username.
|
||||
fn message_html(&self, username: &str) -> String;
|
||||
|
||||
fn message_plain(&self, username: &str) -> String;
|
||||
}
|
||||
|
||||
impl ResponseExtractor for ExecutionResult {
|
||||
|
@ -89,10 +71,23 @@ impl ResponseExtractor for ExecutionResult {
|
|||
);
|
||||
|
||||
match self {
|
||||
Ok(resp) => format!("<p>{}</p><p>{}</p>", username, resp.html).replace("\n", "<br/>"),
|
||||
Err(e) => format!("<p>{}</p><p>{}</p>", username, e.html()).replace("\n", "<br/>"),
|
||||
Ok(resp) => format!("<p>{}</p>", resp.html).replace("\n", "<br/>"),
|
||||
Err(e) => format!("<p>{}: <strong>{}</strong></p>", username, e).replace("\n", "<br/>"),
|
||||
}
|
||||
}
|
||||
|
||||
fn message_plain(&self, username: &str) -> String {
|
||||
let message = match self {
|
||||
Ok(resp) => format!("{}", resp.html),
|
||||
Err(e) => format!("{}", e),
|
||||
};
|
||||
|
||||
format!(
|
||||
"{}:\n{}",
|
||||
username,
|
||||
html2text::from_read(message.as_bytes(), message.len())
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/// The trait that any command that can be executed must implement.
|
||||
|
@ -109,27 +104,22 @@ pub trait Command: Send + Sync {
|
|||
/// ever. Later, we can add stuff like admin/regular user power
|
||||
/// separation, etc.
|
||||
fn execution_allowed(cmd: &(impl Command + ?Sized), ctx: &Context<'_>) -> Result<(), CommandError> {
|
||||
if cmd.is_secure() {
|
||||
if ctx.is_secure() {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(CommandError::InsecureExecution)
|
||||
}
|
||||
} else {
|
||||
Ok(())
|
||||
match cmd {
|
||||
cmd if cmd.is_secure() && ctx.is_secure() => Ok(()),
|
||||
cmd if cmd.is_secure() && !ctx.is_secure() => Err(CommandError::InsecureExecution),
|
||||
_ => Ok(()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempt to execute a command, and return the content that should
|
||||
/// go back to Matrix, if the command was executed (successfully or
|
||||
/// not). If a command is determined to be ignored, this function will
|
||||
/// return None, signifying that we should not send a response.
|
||||
/// go back to Matrix, if the command was executed, whether or not the
|
||||
/// command was successful.
|
||||
pub async fn execute_command(ctx: &Context<'_>) -> ExecutionResult {
|
||||
let cmd = parser::parse_command(&ctx.message_body)?;
|
||||
|
||||
let result = match execution_allowed(cmd.as_ref(), ctx) {
|
||||
Ok(_) => cmd.execute(ctx).await,
|
||||
Err(e) => Err(ExecutionError(e.into())),
|
||||
Err(e) => Err(e.into()),
|
||||
};
|
||||
|
||||
log_command(cmd.as_ref(), ctx, &result);
|
||||
|
@ -141,25 +131,27 @@ fn log_command(cmd: &(impl Command + ?Sized), ctx: &Context, result: &ExecutionR
|
|||
use substring::Substring;
|
||||
let command = match cmd.is_secure() {
|
||||
true => cmd.name(),
|
||||
false => ctx.message_body.substring(0, 30),
|
||||
false => ctx.message_body,
|
||||
};
|
||||
|
||||
let dots = match ctx.message_body.len() {
|
||||
let dots = match command.len() {
|
||||
_len if _len > 30 => "[...]",
|
||||
_ => "",
|
||||
};
|
||||
|
||||
let command = command.substring(0, 30);
|
||||
|
||||
match result {
|
||||
Ok(_) => {
|
||||
info!(
|
||||
"[{}] {} <{}{}> - success",
|
||||
ctx.room.display_name, ctx.username, command, dots
|
||||
ctx.origin_room.display_name, ctx.username, command, dots
|
||||
);
|
||||
}
|
||||
Err(e) => {
|
||||
error!(
|
||||
"[{}] {} <{}{}> - {}",
|
||||
ctx.room.display_name, ctx.username, command, dots, e
|
||||
ctx.origin_room.display_name, ctx.username, command, dots, e
|
||||
);
|
||||
}
|
||||
};
|
||||
|
@ -170,11 +162,12 @@ mod tests {
|
|||
use super::*;
|
||||
use management::RegisterCommand;
|
||||
use url::Url;
|
||||
use matrix_sdk::ruma::room_id;
|
||||
|
||||
macro_rules! dummy_room {
|
||||
() => {
|
||||
crate::context::RoomContext {
|
||||
id: &matrix_sdk::identifiers::room_id!("!fakeroomid:example.com"),
|
||||
id: &room_id!("!fakeroomid:example.com"),
|
||||
display_name: "displayname".to_owned(),
|
||||
secure: false,
|
||||
}
|
||||
|
@ -184,7 +177,7 @@ mod tests {
|
|||
macro_rules! secure_room {
|
||||
() => {
|
||||
crate::context::RoomContext {
|
||||
id: &matrix_sdk::identifiers::room_id!("!fakeroomid:example.com"),
|
||||
id: &room_id!("!fakeroomid:example.com"),
|
||||
display_name: "displayname".to_owned(),
|
||||
secure: true,
|
||||
}
|
||||
|
@ -201,14 +194,16 @@ mod tests {
|
|||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: secure_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: secure_room!(),
|
||||
active_room: secure_room!(),
|
||||
username: "myusername",
|
||||
message_body: "!notacommand",
|
||||
};
|
||||
|
||||
let cmd = RegisterCommand("".to_owned());
|
||||
let cmd = RegisterCommand;
|
||||
assert_eq!(execution_allowed(&cmd, &ctx).is_ok(), true);
|
||||
}
|
||||
|
||||
|
@ -222,9 +217,11 @@ mod tests {
|
|||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: secure_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: secure_room!(),
|
||||
active_room: secure_room!(),
|
||||
username: "myusername",
|
||||
message_body: "!notacommand",
|
||||
};
|
||||
|
@ -243,9 +240,11 @@ mod tests {
|
|||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "myusername",
|
||||
message_body: "!notacommand",
|
||||
};
|
||||
|
@ -264,26 +263,19 @@ mod tests {
|
|||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "myusername",
|
||||
message_body: "!notacommand",
|
||||
};
|
||||
|
||||
let cmd = RegisterCommand("".to_owned());
|
||||
let cmd = RegisterCommand;
|
||||
assert_eq!(execution_allowed(&cmd, &ctx).is_err(), true);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn command_result_extractor_creates_bubble() {
|
||||
let result = Execution::success("test".to_string());
|
||||
let message = result.message_html("@myuser:example.com");
|
||||
assert!(message.contains(
|
||||
"<a href=\"https://matrix.to/#/@myuser:example.com\">@myuser:example.com</a>"
|
||||
));
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn unrecognized_command() {
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
|
@ -294,9 +286,11 @@ mod tests {
|
|||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "myusername",
|
||||
message_body: "!notacommand",
|
||||
};
|
|
@ -3,26 +3,22 @@
|
|||
* governed by the terms of the MIT license, from the original
|
||||
* axfive-matrix-dicebot project.
|
||||
*/
|
||||
use crate::basic::parser::parse_element_expression;
|
||||
use crate::cofd::parser::{create_chance_die, parse_dice_pool};
|
||||
use crate::commands::{
|
||||
basic_rolling::RollCommand,
|
||||
cofd::PoolRollCommand,
|
||||
cthulhu::{CthAdvanceRoll, CthRoll},
|
||||
management::{CheckCommand, RegisterCommand, UnregisterCommand},
|
||||
management::{CheckCommand, LinkCommand, RegisterCommand, UnlinkCommand, UnregisterCommand},
|
||||
misc::HelpCommand,
|
||||
rooms::{ListRoomsCommand, SetRoomCommand},
|
||||
variables::{
|
||||
DeleteVariableCommand, GetAllVariablesCommand, GetVariableCommand, SetVariableCommand,
|
||||
},
|
||||
Command,
|
||||
};
|
||||
use crate::cthulhu::parser::{parse_advancement_roll, parse_regular_roll};
|
||||
use crate::error::BotError;
|
||||
use crate::help::parse_help_topic;
|
||||
use crate::parser::variables::parse_set_variable;
|
||||
use combine::parser::char::{char, letter, space};
|
||||
use combine::{any, many1, optional, Parser};
|
||||
use nom::Err as NomErr;
|
||||
use std::convert::TryFrom;
|
||||
use thiserror::Error;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Error)]
|
||||
|
@ -34,73 +30,6 @@ pub enum CommandParsingError {
|
|||
InternalParseError(#[from] combine::error::StringStreamError),
|
||||
}
|
||||
|
||||
// Parse a roll expression.
|
||||
fn parse_roll(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
let result = parse_element_expression(input);
|
||||
match result {
|
||||
Ok((rest, expression)) if rest.len() == 0 => Ok(Box::new(RollCommand(expression))),
|
||||
//Legacy code boundary translates nom errors into BotErrors.
|
||||
Ok(_) => Err(BotError::NomParserIncomplete),
|
||||
Err(NomErr::Error(e)) => Err(BotError::NomParserError(e.1)),
|
||||
Err(NomErr::Failure(e)) => Err(BotError::NomParserError(e.1)),
|
||||
Err(NomErr::Incomplete(_)) => Err(BotError::NomParserIncomplete),
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_register_command(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
Ok(Box::new(RegisterCommand(input.to_owned())))
|
||||
}
|
||||
|
||||
fn parse_check_command(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
Ok(Box::new(CheckCommand(input.to_owned())))
|
||||
}
|
||||
|
||||
fn parse_unregister_command() -> Result<Box<dyn Command>, BotError> {
|
||||
Ok(Box::new(UnregisterCommand))
|
||||
}
|
||||
|
||||
fn parse_get_variable_command(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
Ok(Box::new(GetVariableCommand(input.to_owned())))
|
||||
}
|
||||
|
||||
fn parse_set_variable_command(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
let (variable_name, value) = parse_set_variable(input)?;
|
||||
Ok(Box::new(SetVariableCommand(variable_name, value)))
|
||||
}
|
||||
|
||||
fn parse_delete_variable_command(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
Ok(Box::new(DeleteVariableCommand(input.to_owned())))
|
||||
}
|
||||
|
||||
fn parse_pool_roll(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
let pool = parse_dice_pool(input)?;
|
||||
Ok(Box::new(PoolRollCommand(pool)))
|
||||
}
|
||||
|
||||
fn parse_cth_roll(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
let roll = parse_regular_roll(input)?;
|
||||
Ok(Box::new(CthRoll(roll)))
|
||||
}
|
||||
|
||||
fn parse_cth_advancement_roll(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
let roll = parse_advancement_roll(input)?;
|
||||
Ok(Box::new(CthAdvanceRoll(roll)))
|
||||
}
|
||||
|
||||
fn chance_die() -> Result<Box<dyn Command>, BotError> {
|
||||
let pool = create_chance_die()?;
|
||||
Ok(Box::new(PoolRollCommand(pool)))
|
||||
}
|
||||
|
||||
fn get_all_variables() -> Result<Box<dyn Command>, BotError> {
|
||||
Ok(Box::new(GetAllVariablesCommand))
|
||||
}
|
||||
|
||||
fn help(topic: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
let topic = parse_help_topic(topic);
|
||||
Ok(Box::new(HelpCommand(topic)))
|
||||
}
|
||||
|
||||
/// Split an input string into its constituent command and "everything
|
||||
/// else" parts. Extracts the command separately from its input (i.e.
|
||||
/// rest of the line) and returns a tuple of (command_input, command).
|
||||
|
@ -132,25 +61,37 @@ fn split_command(input: &str) -> Result<(String, String), CommandParsingError> {
|
|||
Ok((command, command_input))
|
||||
}
|
||||
|
||||
/// Atempt to convert text input to a Boxed command type. Shortens
|
||||
/// boilerplate.
|
||||
macro_rules! convert_to {
|
||||
($type:ident, $input: expr) => {
|
||||
$type::try_from($input).map(|cmd| Box::new(cmd) as Box<dyn Command>)
|
||||
};
|
||||
}
|
||||
|
||||
/// Potentially parse a command expression. If we recognize the
|
||||
/// command, an error should be raised if the command is misparsed. If
|
||||
/// we don't recognize the command, return an error.
|
||||
pub fn parse_command(input: &str) -> Result<Box<dyn Command>, BotError> {
|
||||
match split_command(input) {
|
||||
Ok((cmd, cmd_input)) => match cmd.to_lowercase().as_ref() {
|
||||
"variables" => get_all_variables(),
|
||||
"get" => parse_get_variable_command(&cmd_input),
|
||||
"set" => parse_set_variable_command(&cmd_input),
|
||||
"del" => parse_delete_variable_command(&cmd_input),
|
||||
"r" | "roll" => parse_roll(&cmd_input),
|
||||
"rp" | "pool" => parse_pool_roll(&cmd_input),
|
||||
"cthroll" => parse_cth_roll(&cmd_input),
|
||||
"cthadv" | "ctharoll" => parse_cth_advancement_roll(&cmd_input),
|
||||
"chance" => chance_die(),
|
||||
"help" => help(&cmd_input),
|
||||
"register" => parse_register_command(&cmd_input),
|
||||
"check" => parse_check_command(&cmd_input),
|
||||
"unregister" => parse_unregister_command(),
|
||||
"variables" => convert_to!(GetAllVariablesCommand, cmd_input),
|
||||
"get" => convert_to!(GetVariableCommand, cmd_input),
|
||||
"set" => convert_to!(SetVariableCommand, cmd_input),
|
||||
"del" => convert_to!(DeleteVariableCommand, cmd_input),
|
||||
"r" | "roll" => convert_to!(RollCommand, cmd_input),
|
||||
"rp" | "pool" => convert_to!(PoolRollCommand, cmd_input),
|
||||
"chance" => PoolRollCommand::chance_die().map(|cmd| Box::new(cmd) as Box<dyn Command>),
|
||||
"cthroll" => convert_to!(CthRoll, cmd_input),
|
||||
"cthadv" | "ctharoll" => convert_to!(CthAdvanceRoll, cmd_input),
|
||||
"help" => convert_to!(HelpCommand, cmd_input),
|
||||
"register" => convert_to!(RegisterCommand, cmd_input),
|
||||
"link" => convert_to!(LinkCommand, cmd_input),
|
||||
"unlink" => convert_to!(UnlinkCommand, cmd_input),
|
||||
"check" => convert_to!(CheckCommand, cmd_input),
|
||||
"unregister" => convert_to!(UnregisterCommand, cmd_input),
|
||||
"rooms" => convert_to!(ListRoomsCommand, cmd_input),
|
||||
"room" => convert_to!(SetRoomCommand, cmd_input),
|
||||
_ => Err(CommandParsingError::UnrecognizedCommand(cmd).into()),
|
||||
},
|
||||
//All other errors passed up.
|
||||
|
@ -280,9 +221,9 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn pool_whitespace_test() {
|
||||
parse_command("!pool ns3:8 ").expect("was error");
|
||||
parse_command(" !pool ns3:8").expect("was error");
|
||||
parse_command(" !pool ns3:8 ").expect("was error");
|
||||
parse_command("!pool 8 ns3 ").expect("was error");
|
||||
parse_command(" !pool 8 ns3").expect("was error");
|
||||
parse_command(" !pool 8 ns3 ").expect("was error");
|
||||
}
|
||||
|
||||
#[test]
|
|
@ -0,0 +1,187 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::context::Context;
|
||||
use crate::db::Users;
|
||||
use crate::error::BotError;
|
||||
use crate::matrix;
|
||||
use async_trait::async_trait;
|
||||
use fuse_rust::{Fuse, FuseProperty, Fuseable};
|
||||
use futures::stream::{self, StreamExt, TryStreamExt};
|
||||
use matrix_sdk::{ruma::OwnedUserId, Client};
|
||||
use std::convert::TryFrom;
|
||||
|
||||
/// Holds matrix room ID and display name as strings, for use with
|
||||
/// searching. See search_for_room.
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
struct RoomNameAndId {
|
||||
id: String,
|
||||
name: String,
|
||||
}
|
||||
|
||||
/// Allows searching for a room name and ID struct, instead of just
|
||||
/// searching room display names directly.
|
||||
impl Fuseable for RoomNameAndId {
|
||||
fn properties(&self) -> Vec<FuseProperty> {
|
||||
vec![FuseProperty {
|
||||
value: String::from("name"),
|
||||
weight: 1.0,
|
||||
}]
|
||||
}
|
||||
|
||||
fn lookup(&self, key: &str) -> Option<&str> {
|
||||
match key {
|
||||
"name" => Some(&self.name),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempt to find a room by either name or Matrix Room ID query
|
||||
/// string. It prefers the exact room ID first, and then falls back to
|
||||
/// fuzzy searching based on room display name. The best match is
|
||||
/// returned, or None if no matches were found.
|
||||
fn search_for_room<'a>(
|
||||
rooms_for_user: &'a [RoomNameAndId],
|
||||
search_for: &str,
|
||||
) -> Option<&'a RoomNameAndId> {
|
||||
//Lowest score is the best match.
|
||||
let best_fuzzy_match = || -> Option<&RoomNameAndId> {
|
||||
Fuse::default()
|
||||
.search_text_in_fuse_list(search_for, &rooms_for_user)
|
||||
.into_iter()
|
||||
.min_by(|r1, r2| r1.score.partial_cmp(&r2.score).unwrap())
|
||||
.and_then(|result| rooms_for_user.get(result.index))
|
||||
};
|
||||
|
||||
rooms_for_user
|
||||
.iter()
|
||||
.find(|room| room.id == search_for)
|
||||
.or_else(best_fuzzy_match)
|
||||
}
|
||||
|
||||
async fn get_rooms_for_user(
|
||||
client: &Client,
|
||||
user_id: &str,
|
||||
) -> Result<Vec<RoomNameAndId>, BotError> {
|
||||
let user_id = OwnedUserId::try_from(user_id)?;
|
||||
let rooms_for_user = matrix::get_rooms_for_user(client, &user_id).await?;
|
||||
let mut rooms_for_user: Vec<RoomNameAndId> = stream::iter(rooms_for_user)
|
||||
.filter_map(|room| async move {
|
||||
Some(room.display_name().await.map(|room_name| RoomNameAndId {
|
||||
id: room.room_id().to_string(),
|
||||
name: room_name.to_string(),
|
||||
}))
|
||||
})
|
||||
.try_collect()
|
||||
.await?;
|
||||
|
||||
//Alphabetically descending, symbols first, ignore case.
|
||||
let sort = |r1: &RoomNameAndId, r2: &RoomNameAndId| {
|
||||
r1.name.to_lowercase().cmp(&r2.name.to_lowercase())
|
||||
};
|
||||
|
||||
rooms_for_user.sort_by(sort);
|
||||
Ok(rooms_for_user)
|
||||
}
|
||||
|
||||
pub struct ListRoomsCommand;
|
||||
|
||||
impl TryFrom<String> for ListRoomsCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(_: String) -> Result<Self, Self::Error> {
|
||||
Ok(ListRoomsCommand)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for ListRoomsCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"list rooms"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let rooms_for_user: Vec<String> = get_rooms_for_user(&ctx.matrix_client, ctx.username)
|
||||
.await
|
||||
.map(|rooms| {
|
||||
rooms
|
||||
.into_iter()
|
||||
.map(|room| format!(" {} | {}", room.id, room.name))
|
||||
.collect()
|
||||
})?;
|
||||
|
||||
let html = format!("<pre>{}</pre>", rooms_for_user.join("\n"));
|
||||
Execution::success(html)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct SetRoomCommand(String);
|
||||
|
||||
impl TryFrom<String> for SetRoomCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
Ok(SetRoomCommand(input))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for SetRoomCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"set active room"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
if !ctx.account.is_registered() {
|
||||
return Err(BotError::AccountDoesNotExist);
|
||||
}
|
||||
|
||||
let rooms_for_user = get_rooms_for_user(&ctx.matrix_client, ctx.username).await?;
|
||||
let room = search_for_room(&rooms_for_user, &self.0);
|
||||
|
||||
if let Some(room) = room {
|
||||
let mut new_user = ctx
|
||||
.account
|
||||
.registered_user()
|
||||
.cloned()
|
||||
.ok_or(BotError::AccountDoesNotExist)?;
|
||||
|
||||
new_user.active_room = Some(room.id.clone());
|
||||
ctx.db.upsert_user(&new_user).await?;
|
||||
Execution::success(format!(r#"Active room set to "{}""#, room.name))
|
||||
} else {
|
||||
Err(BotError::RoomDoesNotExist)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn set_room_prefers_room_id_over_name() {
|
||||
let rooms = vec![
|
||||
RoomNameAndId {
|
||||
id: "roomid".to_string(),
|
||||
name: "room_name".to_string(),
|
||||
},
|
||||
RoomNameAndId {
|
||||
id: "anotherone".to_string(),
|
||||
name: "roomid".to_string(),
|
||||
},
|
||||
];
|
||||
|
||||
let found_room = search_for_room(&rooms, "roomid");
|
||||
|
||||
assert!(found_room.is_some());
|
||||
assert_eq!(found_room.unwrap(), &rooms[0]);
|
||||
}
|
||||
}
|
|
@ -2,10 +2,20 @@ use super::{Command, Execution, ExecutionResult};
|
|||
use crate::context::Context;
|
||||
use crate::db::errors::DataError;
|
||||
use crate::db::Variables;
|
||||
use crate::error::BotError;
|
||||
use async_trait::async_trait;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
pub struct GetAllVariablesCommand;
|
||||
|
||||
impl TryFrom<String> for GetAllVariablesCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(_: String) -> Result<Self, Self::Error> {
|
||||
Ok(GetAllVariablesCommand)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for GetAllVariablesCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
|
@ -19,7 +29,7 @@ impl Command for GetAllVariablesCommand {
|
|||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let variables = ctx
|
||||
.db
|
||||
.get_user_variables(&ctx.username, ctx.room_id().as_str())
|
||||
.get_user_variables(&ctx.username, ctx.active_room_id().as_str())
|
||||
.await?;
|
||||
|
||||
let mut variable_list: Vec<String> = variables
|
||||
|
@ -41,6 +51,14 @@ impl Command for GetAllVariablesCommand {
|
|||
|
||||
pub struct GetVariableCommand(pub String);
|
||||
|
||||
impl TryFrom<String> for GetVariableCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
Ok(GetVariableCommand(input))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for GetVariableCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
|
@ -55,7 +73,7 @@ impl Command for GetVariableCommand {
|
|||
let name = &self.0;
|
||||
let result = ctx
|
||||
.db
|
||||
.get_user_variable(&ctx.username, ctx.room_id().as_str(), name)
|
||||
.get_user_variable(&ctx.username, ctx.active_room_id().as_str(), name)
|
||||
.await;
|
||||
|
||||
let value = match result {
|
||||
|
@ -71,6 +89,15 @@ impl Command for GetVariableCommand {
|
|||
|
||||
pub struct SetVariableCommand(pub String, pub i32);
|
||||
|
||||
impl TryFrom<String> for SetVariableCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
let (variable_name, value) = crate::parser::variables::parse_set_variable(&input)?;
|
||||
Ok(SetVariableCommand(variable_name, value))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for SetVariableCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
|
@ -86,7 +113,7 @@ impl Command for SetVariableCommand {
|
|||
let value = self.1;
|
||||
|
||||
ctx.db
|
||||
.set_user_variable(&ctx.username, ctx.room_id().as_str(), name, value)
|
||||
.set_user_variable(&ctx.username, ctx.active_room_id().as_str(), name, value)
|
||||
.await?;
|
||||
|
||||
let content = format!("{} = {}", name, value);
|
||||
|
@ -97,6 +124,14 @@ impl Command for SetVariableCommand {
|
|||
|
||||
pub struct DeleteVariableCommand(pub String);
|
||||
|
||||
impl TryFrom<String> for DeleteVariableCommand {
|
||||
type Error = BotError;
|
||||
|
||||
fn try_from(input: String) -> Result<Self, Self::Error> {
|
||||
Ok(DeleteVariableCommand(input))
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Command for DeleteVariableCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
|
@ -111,7 +146,7 @@ impl Command for DeleteVariableCommand {
|
|||
let name = &self.0;
|
||||
let result = ctx
|
||||
.db
|
||||
.delete_user_variable(&ctx.username, ctx.room_id().as_str(), name)
|
||||
.delete_user_variable(&ctx.username, ctx.active_room_id().as_str(), name)
|
||||
.await;
|
||||
|
||||
let value = match result {
|
|
@ -4,10 +4,6 @@ use std::fs;
|
|||
use std::path::PathBuf;
|
||||
use thiserror::Error;
|
||||
|
||||
/// Shortcut to defining db migration versions. Will probably
|
||||
/// eventually be moved to a config file.
|
||||
const MIGRATION_VERSION: u32 = 5;
|
||||
|
||||
#[derive(Error, Debug)]
|
||||
pub enum ConfigError {
|
||||
#[error("i/o error: {0}")]
|
||||
|
@ -53,10 +49,19 @@ fn db_path_from_env() -> String {
|
|||
}
|
||||
|
||||
/// The "bot" section of the config file, for bot settings.
|
||||
#[derive(Serialize, Deserialize, Clone, Debug)]
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, Default)]
|
||||
struct BotConfig {
|
||||
/// How far back from current time should we process a message?
|
||||
oldest_message_age: Option<u64>,
|
||||
|
||||
/// What address and port to run the RPC service on. If not
|
||||
/// specified, RPC will not be enabled.
|
||||
rpc_addr: Option<String>,
|
||||
|
||||
/// The shared secret key between the bot and any RPC clients that
|
||||
/// want to connect to it. The RPC server will reject any clients
|
||||
/// that don't present the shared key.
|
||||
rpc_key: Option<String>,
|
||||
}
|
||||
|
||||
/// The "database" section of the config file.
|
||||
|
@ -84,6 +89,18 @@ impl BotConfig {
|
|||
self.oldest_message_age
|
||||
.unwrap_or(DEFAULT_OLDEST_MESSAGE_AGE)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
#[must_use]
|
||||
fn rpc_addr(&self) -> Option<String> {
|
||||
self.rpc_addr.clone()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
#[must_use]
|
||||
fn rpc_key(&self) -> Option<String> {
|
||||
self.rpc_key.clone()
|
||||
}
|
||||
}
|
||||
|
||||
/// Represents the toml config file for the dicebot. The sections of
|
||||
|
@ -128,15 +145,6 @@ impl Config {
|
|||
.unwrap_or_else(|| db_path_from_env())
|
||||
}
|
||||
|
||||
/// The current migration version we expect of the database. If
|
||||
/// this number is higher than the one in the database, we will
|
||||
/// execute migrations to update the data.
|
||||
#[inline]
|
||||
#[must_use]
|
||||
pub fn migration_version(&self) -> u32 {
|
||||
MIGRATION_VERSION
|
||||
}
|
||||
|
||||
/// Figure out the allowed oldest message age, in seconds. This will
|
||||
/// be the defined oldest message age in the bot config, if the bot
|
||||
/// configuration and associated "oldest_message_age" setting are
|
||||
|
@ -150,6 +158,18 @@ impl Config {
|
|||
.map(|bc| bc.oldest_message_age())
|
||||
.unwrap_or(DEFAULT_OLDEST_MESSAGE_AGE)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
#[must_use]
|
||||
pub fn rpc_addr(&self) -> Option<String> {
|
||||
self.bot.as_ref().and_then(|bc| bc.rpc_addr())
|
||||
}
|
||||
|
||||
#[inline]
|
||||
#[must_use]
|
||||
pub fn rpc_key(&self) -> Option<String> {
|
||||
self.bot.as_ref().and_then(|bc| bc.rpc_key())
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
@ -169,6 +189,7 @@ mod tests {
|
|||
}),
|
||||
bot: Some(BotConfig {
|
||||
oldest_message_age: None,
|
||||
..Default::default()
|
||||
}),
|
||||
};
|
||||
|
|
@ -1,7 +1,8 @@
|
|||
use crate::db::sqlite::Database;
|
||||
use crate::error::BotError;
|
||||
use matrix_sdk::identifiers::{RoomId, UserId};
|
||||
use crate::models::Account;
|
||||
use matrix_sdk::room::Joined;
|
||||
use matrix_sdk::ruma::{RoomId, UserId};
|
||||
use matrix_sdk::Client;
|
||||
use std::convert::TryFrom;
|
||||
|
||||
|
@ -10,19 +11,25 @@ use std::convert::TryFrom;
|
|||
#[derive(Clone)]
|
||||
pub struct Context<'a> {
|
||||
pub db: Database,
|
||||
pub matrix_client: &'a Client,
|
||||
pub room: RoomContext<'a>,
|
||||
pub matrix_client: Client,
|
||||
pub origin_room: RoomContext<'a>,
|
||||
pub active_room: RoomContext<'a>,
|
||||
pub username: &'a str,
|
||||
pub message_body: &'a str,
|
||||
pub account: Account,
|
||||
}
|
||||
|
||||
impl Context<'_> {
|
||||
pub fn active_room_id(&self) -> &RoomId {
|
||||
self.active_room.id
|
||||
}
|
||||
|
||||
pub fn room_id(&self) -> &RoomId {
|
||||
self.room.id
|
||||
self.origin_room.id
|
||||
}
|
||||
|
||||
pub fn is_secure(&self) -> bool {
|
||||
self.room.secure
|
||||
self.origin_room.secure
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -36,15 +43,22 @@ pub struct RoomContext<'a> {
|
|||
impl RoomContext<'_> {
|
||||
pub async fn new_with_name<'a>(
|
||||
room: &'a Joined,
|
||||
display_name: String,
|
||||
sending_user: &str,
|
||||
) -> Result<RoomContext<'a>, BotError> {
|
||||
// TODO is_direct is a hack; should set rooms to Direct
|
||||
// Message upon joining, if other contact has requested it.
|
||||
// Waiting on SDK support.
|
||||
let sending_user = UserId::try_from(sending_user)?;
|
||||
let user_in_room = room.get_member(&sending_user).await.ok().is_some();
|
||||
let is_direct = room.joined_members().await?.len() == 2;
|
||||
// TODO is_direct is a hack; the bot should set eligible rooms
|
||||
// to Direct Message upon joining, if other contact has
|
||||
// requested it. Waiting on SDK support.
|
||||
let display_name =
|
||||
room
|
||||
.display_name()
|
||||
.await
|
||||
.ok()
|
||||
.map(|d| d.to_string())
|
||||
.unwrap_or_default();
|
||||
|
||||
let sending_user = <&UserId>::try_from(sending_user)?;
|
||||
let user_in_room = room.get_member(sending_user).await.ok().is_some();
|
||||
let is_direct = room.active_members().await?.len() == 2;
|
||||
|
||||
Ok(RoomContext {
|
||||
id: room.room_id(),
|
||||
|
@ -55,17 +69,8 @@ impl RoomContext<'_> {
|
|||
|
||||
pub async fn new<'a>(
|
||||
room: &'a Joined,
|
||||
sending_user: &str,
|
||||
sending_user: &'a str,
|
||||
) -> Result<RoomContext<'a>, BotError> {
|
||||
Self::new_with_name(
|
||||
&room,
|
||||
room.display_name()
|
||||
.await
|
||||
.ok()
|
||||
.unwrap_or_default()
|
||||
.to_string(),
|
||||
sending_user,
|
||||
)
|
||||
.await
|
||||
Self::new_with_name(room, sending_user).await
|
||||
}
|
||||
}
|
|
@ -270,7 +270,7 @@ macro_rules! is_variable {
|
|||
element: Element::Variable(_),
|
||||
..
|
||||
}
|
||||
);
|
||||
)
|
||||
};
|
||||
}
|
||||
|
||||
|
@ -380,7 +380,12 @@ async fn update_skill(ctx: &Context<'_>, variable: &str, value: u32) -> Result<(
|
|||
use std::convert::TryInto;
|
||||
let value: i32 = value.try_into()?;
|
||||
ctx.db
|
||||
.set_user_variable(&ctx.username, &ctx.room_id().as_str(), variable, value)
|
||||
.set_user_variable(
|
||||
&ctx.username,
|
||||
&ctx.active_room_id().as_str(),
|
||||
variable,
|
||||
value,
|
||||
)
|
||||
.await?;
|
||||
Ok(())
|
||||
}
|
||||
|
@ -422,11 +427,12 @@ mod tests {
|
|||
use crate::db::sqlite::Database;
|
||||
use crate::parser::dice::{Amount, Element, Operator};
|
||||
use url::Url;
|
||||
use matrix_sdk::ruma::room_id;
|
||||
|
||||
macro_rules! dummy_room {
|
||||
() => {
|
||||
crate::context::RoomContext {
|
||||
id: &matrix_sdk::identifiers::room_id!("!fakeroomid:example.com"),
|
||||
id: &room_id!("!fakeroomid:example.com"),
|
||||
display_name: "displayname".to_owned(),
|
||||
secure: false,
|
||||
}
|
||||
|
@ -504,9 +510,11 @@ mod tests {
|
|||
|
||||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "username",
|
||||
message_body: "message",
|
||||
};
|
||||
|
@ -540,9 +548,11 @@ mod tests {
|
|||
|
||||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "username",
|
||||
message_body: "message",
|
||||
};
|
||||
|
@ -576,9 +586,11 @@ mod tests {
|
|||
|
||||
let homeserver = Url::parse("http://example.com").unwrap();
|
||||
let ctx = Context {
|
||||
account: crate::models::Account::default(),
|
||||
db: db,
|
||||
matrix_client: &matrix_sdk::Client::new(homeserver).unwrap(),
|
||||
room: dummy_room!(),
|
||||
matrix_client: matrix_sdk::Client::new(homeserver).await.unwrap(),
|
||||
origin_room: dummy_room!(),
|
||||
active_room: dummy_room!(),
|
||||
username: "username",
|
||||
message_body: "message",
|
||||
};
|
|
@ -4,16 +4,13 @@ use crate::parser::dice::DiceParsingError;
|
|||
//TOOD convert these to use parse_amounts from the common dice code.
|
||||
|
||||
fn parse_modifier(input: &str) -> Result<DiceRollModifier, DiceParsingError> {
|
||||
if input.ends_with("bb") {
|
||||
Ok(DiceRollModifier::TwoBonus)
|
||||
} else if input.ends_with("b") {
|
||||
Ok(DiceRollModifier::OneBonus)
|
||||
} else if input.ends_with("pp") {
|
||||
Ok(DiceRollModifier::TwoPenalty)
|
||||
} else if input.ends_with("p") {
|
||||
Ok(DiceRollModifier::OnePenalty)
|
||||
} else {
|
||||
Ok(DiceRollModifier::Normal)
|
||||
match input.trim() {
|
||||
"bb" => Ok(DiceRollModifier::TwoBonus),
|
||||
"b" => Ok(DiceRollModifier::OneBonus),
|
||||
"pp" => Ok(DiceRollModifier::TwoPenalty),
|
||||
"p" => Ok(DiceRollModifier::OnePenalty),
|
||||
"" => Ok(DiceRollModifier::Normal),
|
||||
_ => Err(DiceParsingError::InvalidModifiers),
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -21,32 +18,70 @@ fn parse_modifier(input: &str) -> Result<DiceRollModifier, DiceParsingError> {
|
|||
//Split based on :, send first part to parse_modifier.
|
||||
//Send second part to parse_amounts
|
||||
pub fn parse_regular_roll(input: &str) -> Result<DiceRoll, DiceParsingError> {
|
||||
let input: Vec<&str> = input.trim().split(":").collect();
|
||||
|
||||
let (modifiers_str, amounts_str) = match input[..] {
|
||||
[amounts] => Ok(("", amounts)),
|
||||
[modifiers, amounts] => Ok((modifiers, amounts)),
|
||||
_ => Err(DiceParsingError::UnconsumedInput),
|
||||
}?;
|
||||
|
||||
let (amount, modifiers_str) = crate::parser::dice::parse_single_amount(input)?;
|
||||
let modifier = parse_modifier(modifiers_str)?;
|
||||
let amount = crate::parser::dice::parse_single_amount(amounts_str)?;
|
||||
Ok(DiceRoll { modifier, amount })
|
||||
}
|
||||
|
||||
pub fn parse_advancement_roll(input: &str) -> Result<AdvancementRoll, DiceParsingError> {
|
||||
let input = input.trim();
|
||||
let amounts = crate::parser::dice::parse_single_amount(input)?;
|
||||
let (amounts, unconsumed_input) = crate::parser::dice::parse_single_amount(input)?;
|
||||
|
||||
Ok(AdvancementRoll {
|
||||
existing_skill: amounts,
|
||||
})
|
||||
if unconsumed_input.len() == 0 {
|
||||
Ok(AdvancementRoll {
|
||||
existing_skill: amounts,
|
||||
})
|
||||
} else {
|
||||
Err(DiceParsingError::InvalidAmount)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::parser::dice::{Amount, Element, Operator};
|
||||
use crate::parser::dice::{Amount, DiceParsingError, Element, Operator};
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_rejects_bad_value() {
|
||||
let modifier = parse_modifier("qqq");
|
||||
assert!(matches!(modifier, Err(DiceParsingError::InvalidModifiers)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_accepts_one_bonus() {
|
||||
let modifier = parse_modifier("b");
|
||||
assert!(matches!(modifier, Ok(DiceRollModifier::OneBonus)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_accepts_two_bonus() {
|
||||
let modifier = parse_modifier("bb");
|
||||
assert!(matches!(modifier, Ok(DiceRollModifier::TwoBonus)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_accepts_two_penalty() {
|
||||
let modifier = parse_modifier("pp");
|
||||
assert!(matches!(modifier, Ok(DiceRollModifier::TwoPenalty)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_accepts_one_penalty() {
|
||||
let modifier = parse_modifier("p");
|
||||
assert!(matches!(modifier, Ok(DiceRollModifier::OnePenalty)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_accepts_normal() {
|
||||
let modifier = parse_modifier("");
|
||||
assert!(matches!(modifier, Ok(DiceRollModifier::Normal)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_modifier_accepts_normal_unaffected_by_whitespace() {
|
||||
let modifier = parse_modifier(" ");
|
||||
assert!(matches!(modifier, Ok(DiceRollModifier::Normal)))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn regular_roll_accepts_single_number() {
|
||||
|
@ -72,7 +107,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn regular_roll_accepts_two_bonus() {
|
||||
let result = parse_regular_roll("bb:60");
|
||||
let result = parse_regular_roll("60 bb");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
DiceRoll {
|
||||
|
@ -88,7 +123,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn regular_roll_accepts_one_bonus() {
|
||||
let result = parse_regular_roll("b:60");
|
||||
let result = parse_regular_roll("60 b");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
DiceRoll {
|
||||
|
@ -104,7 +139,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn regular_roll_accepts_two_penalty() {
|
||||
let result = parse_regular_roll("pp:60");
|
||||
let result = parse_regular_roll("60 pp");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
DiceRoll {
|
||||
|
@ -120,7 +155,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn regular_roll_accepts_one_penalty() {
|
||||
let result = parse_regular_roll("p:60");
|
||||
let result = parse_regular_roll("60 p");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
DiceRoll {
|
||||
|
@ -140,21 +175,21 @@ mod tests {
|
|||
assert!(parse_regular_roll(" 60").is_ok());
|
||||
assert!(parse_regular_roll(" 60 ").is_ok());
|
||||
|
||||
assert!(parse_regular_roll("bb:60 ").is_ok());
|
||||
assert!(parse_regular_roll(" bb:60").is_ok());
|
||||
assert!(parse_regular_roll(" bb:60 ").is_ok());
|
||||
assert!(parse_regular_roll("60bb ").is_ok());
|
||||
assert!(parse_regular_roll(" 60 bb").is_ok());
|
||||
assert!(parse_regular_roll(" 60 bb ").is_ok());
|
||||
|
||||
assert!(parse_regular_roll("b:60 ").is_ok());
|
||||
assert!(parse_regular_roll(" b:60").is_ok());
|
||||
assert!(parse_regular_roll(" b:60 ").is_ok());
|
||||
assert!(parse_regular_roll("60b ").is_ok());
|
||||
assert!(parse_regular_roll(" 60 b").is_ok());
|
||||
assert!(parse_regular_roll(" 60 b ").is_ok());
|
||||
|
||||
assert!(parse_regular_roll("pp:60 ").is_ok());
|
||||
assert!(parse_regular_roll(" pp:60").is_ok());
|
||||
assert!(parse_regular_roll(" pp:60 ").is_ok());
|
||||
assert!(parse_regular_roll("60pp ").is_ok());
|
||||
assert!(parse_regular_roll(" 60 pp").is_ok());
|
||||
assert!(parse_regular_roll(" 60 pp ").is_ok());
|
||||
|
||||
assert!(parse_regular_roll("p:60 ").is_ok());
|
||||
assert!(parse_regular_roll(" p:60").is_ok());
|
||||
assert!(parse_regular_roll(" p:60 ").is_ok());
|
||||
assert!(parse_regular_roll("60p ").is_ok());
|
||||
assert!(parse_regular_roll(" 60p ").is_ok());
|
||||
assert!(parse_regular_roll(" 60 p ").is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
|
@ -0,0 +1,22 @@
|
|||
use crate::systems::GameSystem;
|
||||
use barrel::backend::Sqlite;
|
||||
use barrel::{types, types::Type, Migration};
|
||||
use itertools::Itertools;
|
||||
use strum::IntoEnumIterator;
|
||||
|
||||
fn primary_id() -> Type {
|
||||
types::text().unique(true).primary(true).nullable(false)
|
||||
}
|
||||
|
||||
pub fn migration() -> String {
|
||||
let mut m = Migration::new();
|
||||
|
||||
//Normally we would add a CHECK clause here, but types::custom requires a 'static string.
|
||||
//Which means we can't automagically generate one from the enum.
|
||||
m.create_table("room_info", move |t| {
|
||||
t.add_column("room_id", primary_id());
|
||||
t.add_column("game_system", types::text().nullable(false));
|
||||
});
|
||||
|
||||
m.make::<Sqlite>()
|
||||
}
|
|
@ -0,0 +1,18 @@
|
|||
use barrel::backend::Sqlite;
|
||||
use barrel::{types, types::Type, Migration};
|
||||
|
||||
fn primary_uuid() -> Type {
|
||||
types::text().unique(true).primary(true).nullable(false)
|
||||
}
|
||||
|
||||
pub fn migration() -> String {
|
||||
let mut m = Migration::new();
|
||||
|
||||
// Keep track of contextual user state.
|
||||
m.create_table("user_state", move |t| {
|
||||
t.add_column("user_id", primary_uuid());
|
||||
t.add_column("active_room", types::text().nullable(true));
|
||||
});
|
||||
|
||||
m.make::<Sqlite>()
|
||||
}
|
|
@ -0,0 +1,17 @@
|
|||
pub fn migration() -> String {
|
||||
// sqlite does really support alter column, and barrel does not
|
||||
// implement the required workaround, so we do it ourselves!
|
||||
r#"
|
||||
CREATE TABLE IF NOT EXISTS "accounts2" (
|
||||
"user_id" TEXT PRIMARY KEY NOT NULL UNIQUE,
|
||||
"password" TEXT NULL,
|
||||
"account_status" TEXT NOT NULL CHECK(
|
||||
account_status IN ('not_registered', 'registered', 'awaiting_activation'
|
||||
))
|
||||
);
|
||||
INSERT INTO accounts2 select *, 'registered' FROM accounts;
|
||||
DROP TABLE accounts;
|
||||
ALTER TABLE accounts2 RENAME TO accounts;
|
||||
"#
|
||||
.to_string()
|
||||
}
|
|
@ -0,0 +1 @@
|
|||
|
|
@ -5,7 +5,7 @@ use sqlx::ConnectOptions;
|
|||
use std::str::FromStr;
|
||||
use thiserror::Error;
|
||||
|
||||
pub mod migrations;
|
||||
//pub mod migrations;
|
||||
|
||||
#[derive(Error, Debug)]
|
||||
pub enum MigrationError {
|
||||
|
@ -16,6 +16,11 @@ pub enum MigrationError {
|
|||
RefineryError(#[from] refinery::Error),
|
||||
}
|
||||
|
||||
mod embedded {
|
||||
use refinery::embed_migrations;
|
||||
embed_migrations!("src/db/sqlite/migrator/migrations");
|
||||
}
|
||||
|
||||
/// Run database migrations against the sqlite database.
|
||||
pub async fn migrate(db_path: &str) -> Result<(), MigrationError> {
|
||||
//Create database if missing.
|
||||
|
@ -28,6 +33,6 @@ pub async fn migrate(db_path: &str) -> Result<(), MigrationError> {
|
|||
|
||||
let mut conn = Config::new(ConfigDbType::Sqlite).set_db_path(db_path);
|
||||
info!("Running migrations");
|
||||
migrations::runner().run(&mut conn)?;
|
||||
embedded::migrations::runner().run(&mut conn)?;
|
||||
Ok(())
|
||||
}
|
|
@ -53,34 +53,41 @@ impl Rooms for Database {
|
|||
mod tests {
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::Rooms;
|
||||
use std::future::Future;
|
||||
|
||||
async fn create_db() -> Database {
|
||||
async fn with_db<Fut>(f: impl FnOnce(Database) -> Fut)
|
||||
where
|
||||
Fut: Future<Output = ()>,
|
||||
{
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
crate::db::sqlite::migrator::migrate(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
Database::new(db_path.path().to_str().unwrap())
|
||||
let db = Database::new(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
|
||||
f(db).await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn should_process_test() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
let first_check = db
|
||||
.should_process("myroom", "myeventid")
|
||||
.await
|
||||
.expect("should_process failed in first insert");
|
||||
|
||||
let first_check = db
|
||||
.should_process("myroom", "myeventid")
|
||||
.await
|
||||
.expect("should_process failed in first insert");
|
||||
assert_eq!(first_check, true);
|
||||
|
||||
assert_eq!(first_check, true);
|
||||
let second_check = db
|
||||
.should_process("myroom", "myeventid")
|
||||
.await
|
||||
.expect("should_process failed in first insert");
|
||||
|
||||
let second_check = db
|
||||
.should_process("myroom", "myeventid")
|
||||
.await
|
||||
.expect("should_process failed in first insert");
|
||||
|
||||
assert_eq!(second_check, false);
|
||||
assert_eq!(second_check, false);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
}
|
|
@ -37,54 +37,64 @@ impl DbState for Database {
|
|||
mod tests {
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::DbState;
|
||||
use std::future::Future;
|
||||
|
||||
async fn create_db() -> Database {
|
||||
async fn with_db<Fut>(f: impl FnOnce(Database) -> Fut)
|
||||
where
|
||||
Fut: Future<Output = ()>,
|
||||
{
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
crate::db::sqlite::migrator::migrate(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
Database::new(db_path.path().to_str().unwrap())
|
||||
let db = Database::new(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
|
||||
f(db).await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn set_and_get_device_id() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
db.set_device_id("device_id")
|
||||
.await
|
||||
.expect("Could not set device ID");
|
||||
|
||||
db.set_device_id("device_id")
|
||||
.await
|
||||
.expect("Could not set device ID");
|
||||
let device_id = db.get_device_id().await.expect("Could not get device ID");
|
||||
|
||||
let device_id = db.get_device_id().await.expect("Could not get device ID");
|
||||
|
||||
assert!(device_id.is_some());
|
||||
assert_eq!(device_id.unwrap(), "device_id");
|
||||
assert!(device_id.is_some());
|
||||
assert_eq!(device_id.unwrap(), "device_id");
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn no_device_id_set_returns_none() {
|
||||
let db = create_db().await;
|
||||
let device_id = db.get_device_id().await.expect("Could not get device ID");
|
||||
assert!(device_id.is_none());
|
||||
with_db(|db| async move {
|
||||
let device_id = db.get_device_id().await.expect("Could not get device ID");
|
||||
assert!(device_id.is_none());
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_update_device_id() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
db.set_device_id("device_id")
|
||||
.await
|
||||
.expect("Could not set device ID");
|
||||
|
||||
db.set_device_id("device_id")
|
||||
.await
|
||||
.expect("Could not set device ID");
|
||||
db.set_device_id("device_id2")
|
||||
.await
|
||||
.expect("Could not set device ID");
|
||||
|
||||
db.set_device_id("device_id2")
|
||||
.await
|
||||
.expect("Could not set device ID");
|
||||
let device_id = db.get_device_id().await.expect("Could not get device ID");
|
||||
|
||||
let device_id = db.get_device_id().await.expect("Could not get device ID");
|
||||
|
||||
assert!(device_id.is_some());
|
||||
assert_eq!(device_id.unwrap(), "device_id2");
|
||||
assert!(device_id.is_some());
|
||||
assert_eq!(device_id.unwrap(), "device_id2");
|
||||
})
|
||||
.await;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,361 @@
|
|||
use super::Database;
|
||||
use crate::db::{errors::DataError, Users};
|
||||
use crate::error::BotError;
|
||||
use crate::models::User;
|
||||
use async_trait::async_trait;
|
||||
|
||||
#[async_trait]
|
||||
impl Users for Database {
|
||||
async fn upsert_user(&self, user: &User) -> Result<(), DataError> {
|
||||
let mut tx = self.conn.begin().await?;
|
||||
|
||||
sqlx::query!(
|
||||
r#"INSERT INTO accounts (user_id, password, account_status)
|
||||
VALUES (?, ?, ?)
|
||||
ON CONFLICT(user_id) DO
|
||||
UPDATE SET password = ?, account_status = ?"#,
|
||||
user.username,
|
||||
user.password,
|
||||
user.account_status,
|
||||
user.password,
|
||||
user.account_status
|
||||
)
|
||||
.execute(&mut tx)
|
||||
.await?;
|
||||
|
||||
sqlx::query!(
|
||||
r#"INSERT INTO user_state (user_id, active_room)
|
||||
VALUES (?, ?)
|
||||
ON CONFLICT(user_id) DO
|
||||
UPDATE SET active_room = ?"#,
|
||||
user.username,
|
||||
user.active_room,
|
||||
user.active_room
|
||||
)
|
||||
.execute(&mut tx)
|
||||
.await?;
|
||||
|
||||
tx.commit().await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn delete_user(&self, username: &str) -> Result<(), DataError> {
|
||||
let mut tx = self.conn.begin().await?;
|
||||
|
||||
sqlx::query!(r#"DELETE FROM accounts WHERE user_id = ?"#, username)
|
||||
.execute(&mut tx)
|
||||
.await?;
|
||||
|
||||
sqlx::query!(r#"DELETE FROM user_state WHERE user_id = ?"#, username)
|
||||
.execute(&mut tx)
|
||||
.await?;
|
||||
|
||||
tx.commit().await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn get_user(&self, username: &str) -> Result<Option<User>, DataError> {
|
||||
// Should be query_as! macro, but the left join breaks it with a
|
||||
// non existing error message.
|
||||
let user_row: Option<User> = sqlx::query_as(
|
||||
r#"SELECT
|
||||
a.user_id as "username",
|
||||
a.password,
|
||||
s.active_room,
|
||||
COALESCE(a.account_status, 'not_registered') as "account_status"
|
||||
FROM accounts a
|
||||
LEFT JOIN user_state s on a.user_id = s.user_id
|
||||
WHERE a.user_id = ?"#,
|
||||
)
|
||||
.bind(username)
|
||||
.fetch_optional(&self.conn)
|
||||
.await?;
|
||||
|
||||
Ok(user_row)
|
||||
}
|
||||
|
||||
async fn authenticate_user(
|
||||
&self,
|
||||
username: &str,
|
||||
raw_password: &str,
|
||||
) -> Result<Option<User>, BotError> {
|
||||
let user = self.get_user(username).await?;
|
||||
Ok(user.filter(|u| u.verify_password(raw_password)))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::Users;
|
||||
use crate::models::AccountStatus;
|
||||
use std::future::Future;
|
||||
|
||||
async fn with_db<Fut>(f: impl FnOnce(Database) -> Fut)
|
||||
where
|
||||
Fut: Future<Output = ()>,
|
||||
{
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
crate::db::sqlite::migrator::migrate(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let db = Database::new(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
f(db).await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn create_and_get_full_user_test() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some("abc".to_string()),
|
||||
account_status: AccountStatus::Registered,
|
||||
active_room: Some("myroom".to_string()),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
assert_eq!(user.password, Some("abc".to_string()));
|
||||
assert_eq!(user.account_status, AccountStatus::Registered);
|
||||
assert_eq!(user.active_room, Some("myroom".to_string()));
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_get_user_with_no_state_record() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some("abc".to_string()),
|
||||
account_status: AccountStatus::AwaitingActivation,
|
||||
active_room: Some("myroom".to_string()),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
sqlx::query("DELETE FROM user_state")
|
||||
.execute(&db.conn)
|
||||
.await
|
||||
.expect("Could not delete from user_state table.");
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
assert_eq!(user.password, Some("abc".to_string()));
|
||||
assert_eq!(user.account_status, AccountStatus::AwaitingActivation);
|
||||
|
||||
//These should be default values because the state record is missing.
|
||||
assert_eq!(user.active_room, None);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_insert_without_password() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: None,
|
||||
..Default::default()
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
assert_eq!(user.password, None);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_insert_without_active_room() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
active_room: None,
|
||||
..Default::default()
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
assert_eq!(user.active_room, None);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_update_user() {
|
||||
with_db(|db| async move {
|
||||
let insert_result1 = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some("abc".to_string()),
|
||||
..Default::default()
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result1.is_ok());
|
||||
|
||||
let insert_result2 = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some("123".to_string()),
|
||||
active_room: Some("room".to_string()),
|
||||
account_status: AccountStatus::AwaitingActivation,
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result2.is_ok());
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
|
||||
//From second upsert
|
||||
assert_eq!(user.password, Some("123".to_string()));
|
||||
assert_eq!(user.active_room, Some("room".to_string()));
|
||||
assert_eq!(user.account_status, AccountStatus::AwaitingActivation);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_delete_user() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some("abc".to_string()),
|
||||
..Default::default()
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
db.delete_user("myuser")
|
||||
.await
|
||||
.expect("User deletion query failed");
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_none());
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn username_not_in_db_returns_none() {
|
||||
with_db(|db| async move {
|
||||
let user = db
|
||||
.get_user("does not exist")
|
||||
.await
|
||||
.expect("Get user query failure");
|
||||
|
||||
assert!(user.is_none());
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn authenticate_user_is_some_with_valid_password() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some(
|
||||
crate::logic::hash_password("abc").expect("password hash error!"),
|
||||
),
|
||||
..Default::default()
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.authenticate_user("myuser", "abc")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn authenticate_user_is_none_with_wrong_password() {
|
||||
with_db(|db| async move {
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some(
|
||||
crate::logic::hash_password("abc").expect("password hash error!"),
|
||||
),
|
||||
..Default::default()
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.authenticate_user("myuser", "wrong-password")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_none());
|
||||
})
|
||||
.await;
|
||||
}
|
||||
}
|
|
@ -102,143 +102,156 @@ mod tests {
|
|||
use super::*;
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::Variables;
|
||||
use std::future::Future;
|
||||
|
||||
async fn create_db() -> Database {
|
||||
async fn with_db<Fut>(f: impl FnOnce(Database) -> Fut)
|
||||
where
|
||||
Fut: Future<Output = ()>,
|
||||
{
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
crate::db::sqlite::migrator::migrate(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
Database::new(db_path.path().to_str().unwrap())
|
||||
let db = Database::new(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
|
||||
f(db).await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn set_and_get_variable_test() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
db.set_user_variable("myuser", "myroom", "myvariable", 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
|
||||
db.set_user_variable("myuser", "myroom", "myvariable", 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
let value = db
|
||||
.get_user_variable("myuser", "myroom", "myvariable")
|
||||
.await
|
||||
.expect("Could not get variable");
|
||||
|
||||
let value = db
|
||||
.get_user_variable("myuser", "myroom", "myvariable")
|
||||
.await
|
||||
.expect("Could not get variable");
|
||||
|
||||
assert_eq!(value, 1);
|
||||
assert_eq!(value, 1);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn get_missing_variable_test() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
let value = db.get_user_variable("myuser", "myroom", "myvariable").await;
|
||||
|
||||
let value = db.get_user_variable("myuser", "myroom", "myvariable").await;
|
||||
|
||||
assert!(value.is_err());
|
||||
assert!(matches!(
|
||||
value.err().unwrap(),
|
||||
DataError::KeyDoesNotExist(_)
|
||||
));
|
||||
assert!(value.is_err());
|
||||
assert!(matches!(
|
||||
value.err().unwrap(),
|
||||
DataError::KeyDoesNotExist(_)
|
||||
));
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn get_other_user_variable_test() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
db.set_user_variable("myuser1", "myroom", "myvariable", 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
|
||||
db.set_user_variable("myuser1", "myroom", "myvariable", 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
let value = db
|
||||
.get_user_variable("myuser2", "myroom", "myvariable")
|
||||
.await;
|
||||
|
||||
let value = db
|
||||
.get_user_variable("myuser2", "myroom", "myvariable")
|
||||
.await;
|
||||
|
||||
assert!(value.is_err());
|
||||
assert!(matches!(
|
||||
value.err().unwrap(),
|
||||
DataError::KeyDoesNotExist(_)
|
||||
));
|
||||
assert!(value.is_err());
|
||||
assert!(matches!(
|
||||
value.err().unwrap(),
|
||||
DataError::KeyDoesNotExist(_)
|
||||
));
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn count_variables_test() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("myuser", "myroom", variable_name, 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("myuser", "myroom", variable_name, 1)
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
.expect("Could not get count.");
|
||||
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not get count.");
|
||||
|
||||
assert_eq!(count, 3);
|
||||
assert_eq!(count, 3);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn count_variables_respects_user_id() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("different-user", "myroom", variable_name, 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("different-user", "myroom", variable_name, 1)
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
.expect("Could not get count.");
|
||||
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not get count.");
|
||||
|
||||
assert_eq!(count, 0);
|
||||
assert_eq!(count, 0);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn count_variables_respects_room_id() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("myuser", "different-room", variable_name, 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("myuser", "different-room", variable_name, 1)
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
.expect("Could not get count.");
|
||||
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not get count.");
|
||||
|
||||
assert_eq!(count, 0);
|
||||
assert_eq!(count, 0);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn delete_variable_test() {
|
||||
let db = create_db().await;
|
||||
with_db(|db| async move {
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("myuser", "myroom", variable_name, 1)
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
|
||||
for variable_name in &["var1", "var2", "var3"] {
|
||||
db.set_user_variable("myuser", "myroom", variable_name, 1)
|
||||
db.delete_user_variable("myuser", "myroom", "var1")
|
||||
.await
|
||||
.expect("Could not set variable");
|
||||
}
|
||||
.expect("Could not delete variable.");
|
||||
|
||||
db.delete_user_variable("myuser", "myroom", "var1")
|
||||
.await
|
||||
.expect("Could not delete variable.");
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not get count");
|
||||
|
||||
let count = db
|
||||
.get_variable_count("myuser", "myroom")
|
||||
.await
|
||||
.expect("Could not get count");
|
||||
assert_eq!(count, 2);
|
||||
|
||||
assert_eq!(count, 2);
|
||||
|
||||
let var1 = db.get_user_variable("myuser", "myroom", "var1").await;
|
||||
assert!(var1.is_err());
|
||||
assert!(matches!(var1.err().unwrap(), DataError::KeyDoesNotExist(_)));
|
||||
let var1 = db.get_user_variable("myuser", "myroom", "var1").await;
|
||||
assert!(var1.is_err());
|
||||
assert!(matches!(var1.err().unwrap(), DataError::KeyDoesNotExist(_)));
|
||||
})
|
||||
.await;
|
||||
}
|
||||
}
|
|
@ -1,7 +1,10 @@
|
|||
use std::net::AddrParseError;
|
||||
|
||||
use crate::commands::CommandError;
|
||||
use crate::config::ConfigError;
|
||||
use crate::db::errors::DataError;
|
||||
use thiserror::Error;
|
||||
use tonic::metadata::errors::InvalidMetadataValue;
|
||||
|
||||
#[derive(Error, Debug)]
|
||||
pub enum BotError {
|
||||
|
@ -15,6 +18,12 @@ pub enum BotError {
|
|||
#[error("could not retrieve device id")]
|
||||
NoDeviceIdFound,
|
||||
|
||||
#[error("could not build client: {0}")]
|
||||
ClientBuildError(#[from] matrix_sdk::ClientBuildError),
|
||||
|
||||
#[error("could not open matrix store: {0}")]
|
||||
OpenStoreError(#[from] matrix_sdk::store::OpenStoreError),
|
||||
|
||||
#[error("command error: {0}")]
|
||||
CommandError(#[from] CommandError),
|
||||
|
||||
|
@ -30,15 +39,15 @@ pub enum BotError {
|
|||
#[error("could not parse URL")]
|
||||
UrlParseError(#[from] url::ParseError),
|
||||
|
||||
#[error("could not parse ID")]
|
||||
IdParseError(#[from] matrix_sdk::ruma::IdParseError),
|
||||
|
||||
#[error("error in matrix state store: {0}")]
|
||||
MatrixStateStoreError(#[from] matrix_sdk::StoreError),
|
||||
|
||||
#[error("uncategorized matrix SDK error: {0}")]
|
||||
MatrixError(#[from] matrix_sdk::Error),
|
||||
|
||||
#[error("uncategorized matrix SDK base error: {0}")]
|
||||
MatrixBaseError(#[from] matrix_sdk::BaseError),
|
||||
|
||||
#[error("future canceled")]
|
||||
FutureCanceledError,
|
||||
|
||||
|
@ -76,8 +85,8 @@ pub enum BotError {
|
|||
#[error("could not convert to proper integer type")]
|
||||
TryFromIntError(#[from] std::num::TryFromIntError),
|
||||
|
||||
#[error("identifier error: {0}")]
|
||||
IdentifierError(#[from] matrix_sdk::identifiers::Error),
|
||||
// #[error("identifier error: {0}")]
|
||||
// IdentifierError(#[from] matrix_sdk::ruma::Error),
|
||||
|
||||
#[error("password creation error: {0}")]
|
||||
PasswordCreationError(argon2::Error),
|
||||
|
@ -87,6 +96,21 @@ pub enum BotError {
|
|||
|
||||
#[error("user account does not exist, try registering")]
|
||||
AccountDoesNotExist,
|
||||
|
||||
#[error("user account already exists")]
|
||||
AccountAlreadyExists,
|
||||
|
||||
#[error("room name or id does not exist")]
|
||||
RoomDoesNotExist,
|
||||
|
||||
#[error("tonic transport error: {0}")]
|
||||
TonicTransportError(#[from] tonic::transport::Error),
|
||||
|
||||
#[error("address parsing error: {0}")]
|
||||
AddressParseError(#[from] AddrParseError),
|
||||
|
||||
#[error("invalid metadata value: {0}")]
|
||||
TonicInvalidMetadata(#[from] InvalidMetadataValue),
|
||||
}
|
||||
|
||||
#[derive(Error, Debug)]
|
|
@ -6,6 +6,9 @@ pub fn parse_help_topic(input: &str) -> Option<HelpTopic> {
|
|||
"dicepool" => Some(HelpTopic::DicePool),
|
||||
"dice" => Some(HelpTopic::RollingDice),
|
||||
"cthulhu" => Some(HelpTopic::Cthulhu),
|
||||
"variables" => Some(HelpTopic::Variables),
|
||||
"var" => Some(HelpTopic::Variables),
|
||||
"variable" => Some(HelpTopic::Variables),
|
||||
"" => Some(HelpTopic::General),
|
||||
_ => None,
|
||||
}
|
||||
|
@ -16,6 +19,7 @@ pub enum HelpTopic {
|
|||
DicePool,
|
||||
Cthulhu,
|
||||
RollingDice,
|
||||
Variables,
|
||||
General,
|
||||
}
|
||||
|
||||
|
@ -101,6 +105,34 @@ Note: If !cthadv is given a variable, and the roll is successful, it will
|
|||
update the variable with the new skill.
|
||||
"};
|
||||
|
||||
const VARIABLES_HELP: &'static str = indoc! {"
|
||||
Variables
|
||||
|
||||
Commands: !get, !set, !variables
|
||||
|
||||
Manage variables that can be substituted into roll commands.
|
||||
|
||||
Examples: !get myvar, !set myvar 10
|
||||
|
||||
!get <variable> = show variable of the given name
|
||||
!set <variable> <num> = set a variable to a number
|
||||
|
||||
The !variables command will list all variables for the room. The
|
||||
variables command cna be used in a secure room to avoid spamming the
|
||||
actual room that the variable is set in.
|
||||
|
||||
Variable names can be used in all types of dice rolls:
|
||||
|
||||
!pool myvar + 3
|
||||
!roll myvar
|
||||
|
||||
There are some limitations on variables: they cannot themselves be
|
||||
dice expressions (i.e. can only be numbers), and they must be uniquely
|
||||
parseable in an expression (i.e 'myvard6' does not work for the !roll
|
||||
command).
|
||||
|
||||
"};
|
||||
|
||||
const GENERAL_HELP: &'static str = indoc! {"
|
||||
General Help
|
||||
|
||||
|
@ -117,6 +149,7 @@ impl HelpTopic {
|
|||
HelpTopic::DicePool => DICEPOOL_HELP,
|
||||
HelpTopic::Cthulhu => CTHULHU_HELP,
|
||||
HelpTopic::RollingDice => DICE_HELP,
|
||||
HelpTopic::Variables => VARIABLES_HELP,
|
||||
HelpTopic::General => GENERAL_HELP,
|
||||
}
|
||||
}
|
|
@ -12,4 +12,6 @@ pub mod logic;
|
|||
pub mod matrix;
|
||||
pub mod models;
|
||||
mod parser;
|
||||
pub mod rpc;
|
||||
pub mod state;
|
||||
pub mod systems;
|
|
@ -0,0 +1,131 @@
|
|||
use crate::error::{BotError, DiceRollingError};
|
||||
use crate::parser::dice::{Amount, Element};
|
||||
use crate::{context::Context, models::Account};
|
||||
use crate::{
|
||||
db::{sqlite::Database, Users, Variables},
|
||||
models::TransientUser,
|
||||
};
|
||||
use argon2::{self, Config, Error as ArgonError};
|
||||
use futures::stream::{self, StreamExt, TryStreamExt};
|
||||
use rand::Rng;
|
||||
use std::slice;
|
||||
|
||||
/// Calculate the amount of dice to roll by consulting the database
|
||||
/// and replacing variables with corresponding the amount. Errors out
|
||||
/// if it cannot find a variable defined, or if the database errors.
|
||||
pub async fn calculate_single_die_amount(
|
||||
amount: &Amount,
|
||||
ctx: &Context<'_>,
|
||||
) -> Result<i32, BotError> {
|
||||
calculate_dice_amount(slice::from_ref(amount), ctx).await
|
||||
}
|
||||
|
||||
/// Calculate the amount of dice to roll by consulting the database
|
||||
/// and replacing variables with corresponding amounts. Errors out if
|
||||
/// it cannot find a variable defined, or if the database errors.
|
||||
pub async fn calculate_dice_amount(amounts: &[Amount], ctx: &Context<'_>) -> Result<i32, BotError> {
|
||||
let stream = stream::iter(amounts);
|
||||
let variables = &ctx
|
||||
.db
|
||||
.get_user_variables(&ctx.username, ctx.active_room_id().as_str())
|
||||
.await?;
|
||||
|
||||
use DiceRollingError::VariableNotFound;
|
||||
let dice_amount: i32 = stream
|
||||
.then(|amount| async move {
|
||||
match &amount.element {
|
||||
Element::Number(num_dice) => Ok(num_dice * amount.operator.mult()),
|
||||
Element::Variable(variable) => variables
|
||||
.get(variable)
|
||||
.ok_or_else(|| VariableNotFound(variable.clone()))
|
||||
.map(|i| *i),
|
||||
}
|
||||
})
|
||||
.try_fold(0, |total, num_dice| async move { Ok(total + num_dice) })
|
||||
.await?;
|
||||
|
||||
Ok(dice_amount)
|
||||
}
|
||||
|
||||
/// Hash a password using the argon2 algorithm with a 16 byte salt.
|
||||
pub(crate) fn hash_password(raw_password: &str) -> Result<String, ArgonError> {
|
||||
let salt = rand::thread_rng().gen::<[u8; 16]>();
|
||||
let config = Config::default();
|
||||
argon2::hash_encoded(raw_password.as_bytes(), &salt, &config)
|
||||
}
|
||||
|
||||
pub(crate) async fn get_account(db: &Database, username: &str) -> Result<Account, BotError> {
|
||||
Ok(db
|
||||
.get_user(username)
|
||||
.await?
|
||||
.map(|user| Account::Registered(user))
|
||||
.unwrap_or_else(|| {
|
||||
Account::Transient(TransientUser {
|
||||
username: username.to_owned(),
|
||||
})
|
||||
}))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::db::Users;
|
||||
use crate::models::{AccountStatus, User};
|
||||
use std::future::Future;
|
||||
|
||||
async fn with_db<Fut>(f: impl FnOnce(Database) -> Fut)
|
||||
where
|
||||
Fut: Future<Output = ()>,
|
||||
{
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
crate::db::sqlite::migrator::migrate(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let db = Database::new(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
f(db).await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn get_account_no_user_exists() {
|
||||
with_db(|db| async move {
|
||||
let account = get_account(&db, "@test:example.com")
|
||||
.await
|
||||
.expect("Account retrieval didn't work");
|
||||
|
||||
assert!(matches!(account, Account::Transient(_)));
|
||||
|
||||
let user = account.transient_user().unwrap();
|
||||
assert_eq!(user.username, "@test:example.com");
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn get_or_create_user_when_user_exists() {
|
||||
with_db(|db| async move {
|
||||
let user = User {
|
||||
username: "myuser".to_string(),
|
||||
password: Some("abc".to_string()),
|
||||
account_status: AccountStatus::Registered,
|
||||
active_room: Some("myroom".to_string()),
|
||||
};
|
||||
|
||||
let insert_result = db.upsert_user(&user).await;
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let account = get_account(&db, "myuser")
|
||||
.await
|
||||
.expect("Account retrieval did not work");
|
||||
|
||||
assert!(matches!(account, Account::Registered(_)));
|
||||
|
||||
let user_again = account.registered_user().unwrap();
|
||||
assert_eq!(user, *user_again);
|
||||
})
|
||||
.await;
|
||||
}
|
||||
}
|
|
@ -1,14 +1,22 @@
|
|||
use std::path::PathBuf;
|
||||
|
||||
use futures::stream::{self, StreamExt, TryStreamExt};
|
||||
use log::error;
|
||||
use matrix_sdk::{events::room::message::NoticeMessageEventContent, room::Joined};
|
||||
use matrix_sdk::{
|
||||
events::room::message::{InReplyTo, Relation},
|
||||
events::room::message::{MessageEventContent, MessageType},
|
||||
events::AnyMessageEventContent,
|
||||
identifiers::EventId,
|
||||
Error as MatrixError,
|
||||
};
|
||||
use matrix_sdk::{identifiers::RoomId, identifiers::UserId, Client};
|
||||
use matrix_sdk::ruma::events::room::message::{InReplyTo, RoomMessageEventContent, Relation};
|
||||
use matrix_sdk::ruma::events::AnyMessageLikeEventContent;
|
||||
use matrix_sdk::ruma::{RoomId, OwnedEventId, OwnedUserId};
|
||||
use matrix_sdk::Client;
|
||||
use matrix_sdk::Error as MatrixError;
|
||||
use matrix_sdk::room::Joined;
|
||||
use url::Url;
|
||||
|
||||
use crate::{config::Config, error::BotError};
|
||||
|
||||
fn cache_dir() -> Result<PathBuf, BotError> {
|
||||
let mut dir = dirs::cache_dir().ok_or(BotError::NoCacheDirectoryError)?;
|
||||
dir.push("matrix-dicebot");
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
/// Extracts more detailed error messages out of a matrix SDK error.
|
||||
fn extract_error_message(error: MatrixError) -> String {
|
||||
|
@ -20,6 +28,19 @@ fn extract_error_message(error: MatrixError) -> String {
|
|||
}
|
||||
}
|
||||
|
||||
/// Creates the matrix client.
|
||||
pub async fn create_client(config: &Config) -> Result<Client, BotError> {
|
||||
let cache_dir = cache_dir()?;
|
||||
let homeserver_url = Url::parse(&config.matrix_homeserver())?;
|
||||
|
||||
let client = Client::builder()
|
||||
.sled_store(cache_dir, None)?
|
||||
.homeserver_url(homeserver_url).build()
|
||||
.await?;
|
||||
|
||||
Ok(client)
|
||||
}
|
||||
|
||||
/// Retrieve a list of users in a given room.
|
||||
pub async fn get_users_in_room(
|
||||
client: &Client,
|
||||
|
@ -39,7 +60,7 @@ pub async fn get_users_in_room(
|
|||
|
||||
pub async fn get_rooms_for_user(
|
||||
client: &Client,
|
||||
user: &UserId,
|
||||
user: &OwnedUserId,
|
||||
) -> Result<Vec<Joined>, MatrixError> {
|
||||
// Carries errors through, in case we cannot load joined user IDs
|
||||
// from the room for some reason.
|
||||
|
@ -61,32 +82,32 @@ pub async fn get_rooms_for_user(
|
|||
Ok(rooms_for_user)
|
||||
}
|
||||
|
||||
/// Send a message. The message is a tuple of HTML and plain text
|
||||
/// responses.
|
||||
pub async fn send_message(
|
||||
client: &Client,
|
||||
room_id: &RoomId,
|
||||
message: &str,
|
||||
reply_to: Option<EventId>,
|
||||
message: (&str, &str),
|
||||
reply_to: Option<OwnedEventId>,
|
||||
) {
|
||||
let (html, plain) = message;
|
||||
let room = match client.get_joined_room(room_id) {
|
||||
Some(room) => room,
|
||||
_ => return,
|
||||
};
|
||||
|
||||
let plain = html2text::from_read(message.as_bytes(), message.len());
|
||||
let mut content = MessageEventContent::new(MessageType::Notice(
|
||||
NoticeMessageEventContent::html(plain.trim(), message),
|
||||
));
|
||||
let mut content = RoomMessageEventContent::notice_html(plain.trim(), html);
|
||||
|
||||
content.relates_to = reply_to.map(|event_id| Relation::Reply {
|
||||
in_reply_to: InReplyTo::new(event_id),
|
||||
in_reply_to: InReplyTo::new(event_id)
|
||||
});
|
||||
|
||||
let content = AnyMessageEventContent::RoomMessage(content);
|
||||
let content = AnyMessageLikeEventContent::RoomMessage(content);
|
||||
|
||||
let result = room.send(content, None).await;
|
||||
|
||||
if let Err(e) = result {
|
||||
let message = extract_error_message(e);
|
||||
error!("Error sending message: {}", message);
|
||||
let html = extract_error_message(e);
|
||||
error!("Error sending html: {}", html);
|
||||
};
|
||||
}
|
|
@ -0,0 +1,157 @@
|
|||
use serde::{Deserialize, Serialize};
|
||||
|
||||
/// RoomInfo has basic metadata about a room: its name, ID, etc.
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
|
||||
pub struct RoomInfo {
|
||||
pub room_id: String,
|
||||
pub room_name: String,
|
||||
}
|
||||
|
||||
#[derive(Eq, PartialEq, Clone, Copy, Debug, sqlx::Type)]
|
||||
#[sqlx(rename_all = "snake_case")]
|
||||
pub enum AccountStatus {
|
||||
/// Account is not registered, which means a transient "account"
|
||||
/// with limited information exists only for the duration of the
|
||||
/// command request.
|
||||
NotRegistered,
|
||||
|
||||
/// User account is fully registered, either via Matrix directly,
|
||||
/// or a web UI sign-up.
|
||||
Registered,
|
||||
|
||||
/// Account is awaiting activation with a registration
|
||||
/// code. Account cannot do privileged actions yet.
|
||||
AwaitingActivation,
|
||||
}
|
||||
|
||||
impl Default for AccountStatus {
|
||||
fn default() -> Self {
|
||||
AccountStatus::NotRegistered
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub enum Account {
|
||||
/// A registered user account, stored in the database.
|
||||
Registered(User),
|
||||
|
||||
/// A transient account. Not stored in the database. Represents a
|
||||
/// user in a public channel that has not registered directly with
|
||||
/// the bot yet.
|
||||
Transient(TransientUser),
|
||||
}
|
||||
|
||||
impl Account {
|
||||
/// Whether or not this account is a registered user account.
|
||||
pub fn is_registered(&self) -> bool {
|
||||
matches!(self, Self::Registered(_))
|
||||
}
|
||||
|
||||
/// Gets the account status. For registered users, this is their
|
||||
/// actual account status (fully registered or awaiting
|
||||
/// activation). For transient users, this is
|
||||
/// AccountStatus::NotRegistered.
|
||||
pub fn account_status(&self) -> AccountStatus {
|
||||
match self {
|
||||
Self::Registered(user) => user.account_status,
|
||||
Self::Transient(_) => AccountStatus::NotRegistered,
|
||||
}
|
||||
}
|
||||
|
||||
/// Consume self into an Option<User> instance, which will be Some
|
||||
/// if this account has a registered user, and None otherwise.
|
||||
pub fn registered_user(&self) -> Option<&User> {
|
||||
match self {
|
||||
Self::Registered(ref user) => Some(user),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// Consume self into an Option<TransientUser> instance, which
|
||||
/// will be Some if this account has a non-registered user, and
|
||||
/// None otherwise.
|
||||
pub fn transient_user(self) -> Option<TransientUser> {
|
||||
match self {
|
||||
Self::Transient(user) => Some(user),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for Account {
|
||||
fn default() -> Self {
|
||||
Account::Transient(TransientUser {
|
||||
username: "".to_string(),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct TransientUser {
|
||||
pub username: String,
|
||||
}
|
||||
|
||||
#[derive(Eq, PartialEq, Clone, Debug, Default, sqlx::FromRow)]
|
||||
pub struct User {
|
||||
pub username: String,
|
||||
pub password: Option<String>,
|
||||
pub active_room: Option<String>,
|
||||
pub account_status: AccountStatus,
|
||||
}
|
||||
|
||||
impl User {
|
||||
/// Create a new unregistered skeleton marker account for a
|
||||
/// username.
|
||||
pub fn unregistered(username: &str) -> User {
|
||||
User {
|
||||
username: username.to_owned(),
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
pub fn verify_password(&self, raw_password: &str) -> bool {
|
||||
self.password
|
||||
.as_ref()
|
||||
.and_then(|p| argon2::verify_encoded(p, raw_password.as_bytes()).ok())
|
||||
.unwrap_or(false)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn verify_password_passes_with_correct_password() {
|
||||
let user = User {
|
||||
password: Some(
|
||||
crate::logic::hash_password("mypassword").expect("Password hashing error!"),
|
||||
),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
assert_eq!(user.verify_password("mypassword"), true);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verify_password_fails_with_wrong_password() {
|
||||
let user = User {
|
||||
password: Some(
|
||||
crate::logic::hash_password("mypassword").expect("Password hashing error!"),
|
||||
),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
assert_eq!(user.verify_password("wrong-password"), false);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verify_password_fails_with_no_password() {
|
||||
let user = User {
|
||||
password: None,
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
assert_eq!(user.verify_password("wrong-password"), false);
|
||||
}
|
||||
}
|
|
@ -151,8 +151,9 @@ where
|
|||
/// should not have an operator, but every one after that should.
|
||||
/// Accepts expressions like "8", "10 + variablename", "variablename -
|
||||
/// 3", etc. This function is currently common to systems that don't
|
||||
/// deal with XdY rolls. Support for that will be added later.
|
||||
pub fn parse_amounts(input: &str) -> ParseResult<Vec<Amount>> {
|
||||
/// deal with XdY rolls. Support for that will be added later. Returns
|
||||
/// parsed amounts and unconsumed input (e.g. roll modifiers).
|
||||
pub fn parse_amounts(input: &str) -> ParseResult<(Vec<Amount>, &str)> {
|
||||
let input = input.trim();
|
||||
|
||||
let remaining_amounts = many(amount_parser()).map(|amounts: Vec<ParseResult<Amount>>| amounts);
|
||||
|
@ -169,31 +170,23 @@ pub fn parse_amounts(input: &str) -> ParseResult<Vec<Amount>> {
|
|||
(amounts, results.1)
|
||||
})?;
|
||||
|
||||
if rest.len() == 0 {
|
||||
// Any ParseResult errors will short-circuit the collect.
|
||||
results.into_iter().collect()
|
||||
} else {
|
||||
Err(DiceParsingError::UnconsumedInput)
|
||||
}
|
||||
// Any ParseResult errors will short-circuit the collect.
|
||||
let results: Vec<Amount> = results.into_iter().collect::<ParseResult<_>>()?;
|
||||
Ok((results, rest))
|
||||
}
|
||||
|
||||
/// Parse an expression that expects a single number or variable. No
|
||||
/// operators are allowed. This function is common to systems that
|
||||
/// don't deal with XdY rolls. Currently. this function does not
|
||||
/// support parsing negative numbers.
|
||||
pub fn parse_single_amount(input: &str) -> ParseResult<Amount> {
|
||||
/// support parsing negative numbers. Returns the parsed amount and
|
||||
/// any unconsumed input (useful for dice roll modifiers).
|
||||
pub fn parse_single_amount(input: &str) -> ParseResult<(Amount, &str)> {
|
||||
// TODO add support for negative numbers, as technically they
|
||||
// should be allowed.
|
||||
let input = input.trim();
|
||||
let mut parser = first_amount_parser().map(|amount: ParseResult<Amount>| amount);
|
||||
|
||||
let (result, rest) = parser.parse(input)?;
|
||||
|
||||
if rest.len() == 0 {
|
||||
result
|
||||
} else {
|
||||
Err(DiceParsingError::UnconsumedInput)
|
||||
}
|
||||
Ok((result?, rest))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
@ -206,10 +199,13 @@ mod parse_single_amount_tests {
|
|||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Variable("abc".to_string())
|
||||
}
|
||||
(
|
||||
Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Variable("abc".to_string())
|
||||
},
|
||||
""
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
|
@ -233,24 +229,15 @@ mod parse_single_amount_tests {
|
|||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Number(1)
|
||||
}
|
||||
(
|
||||
Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Number(1)
|
||||
},
|
||||
""
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_multiple_elements_test() {
|
||||
let result = parse_single_amount("1+abc");
|
||||
assert!(result.is_err());
|
||||
|
||||
let result = parse_single_amount("abc+1");
|
||||
assert!(result.is_err());
|
||||
|
||||
let result = parse_single_amount("-1-abc");
|
||||
assert!(result.is_err());
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
@ -263,20 +250,26 @@ mod parse_many_amounts_tests {
|
|||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Number(1)
|
||||
}]
|
||||
(
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Number(1)
|
||||
}],
|
||||
""
|
||||
)
|
||||
);
|
||||
|
||||
let result = parse_amounts("10");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Number(10)
|
||||
}]
|
||||
(
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Number(10)
|
||||
}],
|
||||
""
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
|
@ -295,20 +288,26 @@ mod parse_many_amounts_tests {
|
|||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Variable("asdf".to_string())
|
||||
}]
|
||||
(
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Variable("asdf".to_string())
|
||||
}],
|
||||
""
|
||||
)
|
||||
);
|
||||
|
||||
let result = parse_amounts("nosis");
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(
|
||||
result.unwrap(),
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Variable("nosis".to_string())
|
||||
}]
|
||||
(
|
||||
vec![Amount {
|
||||
operator: Operator::Plus,
|
||||
element: Element::Variable("nosis".to_string())
|
||||
}],
|
||||
""
|
||||
)
|
||||
);
|
||||
}
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
use crate::error::BotError;
|
||||
use crate::{config::Config, db::sqlite::Database};
|
||||
use log::{info, warn};
|
||||
use matrix_sdk::Client;
|
||||
use service::DicebotRpcService;
|
||||
use std::sync::Arc;
|
||||
use tenebrous_rpc::protos::dicebot::dicebot_server::DicebotServer;
|
||||
use tonic::{metadata::MetadataValue, transport::Server, Request, Status};
|
||||
|
||||
pub(crate) mod service;
|
||||
|
||||
pub async fn serve_grpc(
|
||||
config: &Arc<Config>,
|
||||
db: &Database,
|
||||
client: &Client,
|
||||
) -> Result<(), BotError> {
|
||||
match config.rpc_addr().zip(config.rpc_key()) {
|
||||
Some((addr, rpc_key)) => {
|
||||
let expected_bearer = MetadataValue::from_str(&format!("Bearer {}", rpc_key))?;
|
||||
let addr = addr.parse()?;
|
||||
|
||||
let rpc_service = DicebotRpcService {
|
||||
db: db.clone(),
|
||||
config: config.clone(),
|
||||
client: client.clone(),
|
||||
};
|
||||
|
||||
info!("Serving Dicebot gRPC service on {}", addr);
|
||||
|
||||
let interceptor = move |req: Request<()>| match req.metadata().get("authorization") {
|
||||
Some(bearer) if bearer == expected_bearer => Ok(req),
|
||||
_ => Err(Status::unauthenticated("No valid auth token")),
|
||||
};
|
||||
|
||||
let server = DicebotServer::with_interceptor(rpc_service, interceptor);
|
||||
|
||||
Server::builder()
|
||||
.add_service(server)
|
||||
.serve(addr)
|
||||
.await
|
||||
.map_err(|e| e.into())
|
||||
}
|
||||
_ => noop().await,
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn noop() -> Result<(), BotError> {
|
||||
warn!("RPC address or shared secret not specified. Not enabling gRPC.");
|
||||
Ok(())
|
||||
}
|
|
@ -0,0 +1,117 @@
|
|||
use crate::db::{errors::DataError, Variables};
|
||||
use crate::error::BotError;
|
||||
use crate::matrix;
|
||||
use crate::{config::Config, db::sqlite::Database};
|
||||
use futures::stream;
|
||||
use futures::{StreamExt, TryFutureExt, TryStreamExt};
|
||||
use matrix_sdk::ruma::OwnedUserId;
|
||||
use matrix_sdk::{room::Joined, Client};
|
||||
use std::convert::TryFrom;
|
||||
use std::sync::Arc;
|
||||
use tenebrous_rpc::protos::dicebot::{
|
||||
dicebot_server::Dicebot, rooms_list_reply::Room, GetAllVariablesReply, GetAllVariablesRequest,
|
||||
RoomsListReply, SetVariableReply, SetVariableRequest, UserIdRequest,
|
||||
};
|
||||
use tenebrous_rpc::protos::dicebot::{GetVariableReply, GetVariableRequest};
|
||||
use tonic::{Code, Request, Response, Status};
|
||||
|
||||
impl From<BotError> for Status {
|
||||
fn from(error: BotError) -> Status {
|
||||
Status::new(Code::Internal, error.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
impl From<DataError> for Status {
|
||||
fn from(error: DataError) -> Status {
|
||||
Status::new(Code::Internal, error.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
pub(super) struct DicebotRpcService {
|
||||
pub(super) config: Arc<Config>,
|
||||
pub(super) db: Database,
|
||||
pub(super) client: Client,
|
||||
}
|
||||
|
||||
#[tonic::async_trait]
|
||||
impl Dicebot for DicebotRpcService {
|
||||
async fn set_variable(
|
||||
&self,
|
||||
request: Request<SetVariableRequest>,
|
||||
) -> Result<Response<SetVariableReply>, Status> {
|
||||
let SetVariableRequest {
|
||||
user_id,
|
||||
room_id,
|
||||
variable_name,
|
||||
value,
|
||||
} = request.into_inner();
|
||||
|
||||
self.db
|
||||
.set_user_variable(&user_id, &room_id, &variable_name, value)
|
||||
.await?;
|
||||
|
||||
Ok(Response::new(SetVariableReply { success: true }))
|
||||
}
|
||||
|
||||
async fn get_variable(
|
||||
&self,
|
||||
request: Request<GetVariableRequest>,
|
||||
) -> Result<Response<GetVariableReply>, Status> {
|
||||
let request = request.into_inner();
|
||||
let value = self
|
||||
.db
|
||||
.get_user_variable(&request.user_id, &request.room_id, &request.variable_name)
|
||||
.await?;
|
||||
|
||||
Ok(Response::new(GetVariableReply { value }))
|
||||
}
|
||||
|
||||
async fn get_all_variables(
|
||||
&self,
|
||||
request: Request<GetAllVariablesRequest>,
|
||||
) -> Result<Response<GetAllVariablesReply>, Status> {
|
||||
let request = request.into_inner();
|
||||
let variables = self
|
||||
.db
|
||||
.get_user_variables(&request.user_id, &request.room_id)
|
||||
.await?;
|
||||
|
||||
Ok(Response::new(GetAllVariablesReply { variables }))
|
||||
}
|
||||
|
||||
async fn rooms_for_user(
|
||||
&self,
|
||||
request: Request<UserIdRequest>,
|
||||
) -> Result<Response<RoomsListReply>, Status> {
|
||||
let UserIdRequest { user_id } = request.into_inner();
|
||||
let user_id = OwnedUserId::try_from(user_id).map_err(BotError::from)?;
|
||||
|
||||
let rooms_for_user = matrix::get_rooms_for_user(&self.client, &user_id)
|
||||
.err_into::<BotError>()
|
||||
.await?;
|
||||
|
||||
let mut rooms: Vec<Room> = stream::iter(rooms_for_user)
|
||||
.filter_map(|room: Joined| async move {
|
||||
let room: Result<Room, _> = room.display_name().await.map(|room_name| Room {
|
||||
room_id: room.room_id().to_string(),
|
||||
display_name: room_name.to_string(),
|
||||
});
|
||||
|
||||
Some(room)
|
||||
})
|
||||
.err_into::<BotError>()
|
||||
.try_collect()
|
||||
.await?;
|
||||
|
||||
let sort = |r1: &Room, r2: &Room| {
|
||||
r1.display_name
|
||||
.to_lowercase()
|
||||
.cmp(&r2.display_name.to_lowercase())
|
||||
};
|
||||
|
||||
rooms.sort_by(sort);
|
||||
|
||||
Ok(Response::new(RoomsListReply { rooms }))
|
||||
}
|
||||
}
|
|
@ -0,0 +1,21 @@
|
|||
use strum::{AsRefStr, Display, EnumIter, EnumString};
|
||||
|
||||
#[derive(EnumString, EnumIter, AsRefStr, Display)]
|
||||
pub(crate) enum GameSystem {
|
||||
ChroniclesOfDarkness,
|
||||
Changeling,
|
||||
MageTheAwakening,
|
||||
WerewolfTheForsaken,
|
||||
DeviantTheRenegades,
|
||||
MummyTheCurse,
|
||||
PrometheanTheCreated,
|
||||
CallOfCthulhu,
|
||||
DungeonsAndDragons5e,
|
||||
DungeonsAndDragons4e,
|
||||
DungeonsAndDragons35e,
|
||||
DungeonsAndDragons2e,
|
||||
DungeonsAndDragons1e,
|
||||
None,
|
||||
}
|
||||
|
||||
impl GameSystem {}
|
|
@ -0,0 +1,18 @@
|
|||
[package]
|
||||
name = "tenebrous-rpc"
|
||||
version = "0.1.0"
|
||||
authors = ["projectmoon <projectmoon@agnos.is>"]
|
||||
edition = "2018"
|
||||
description = "gRPC protobuf models for Tenebrous."
|
||||
homepage = "https://git.agnos.is/projectmoon/tenebrous-dicebot"
|
||||
repository = "https://git.agnos.is/projectmoon/tenebrous-dicebot"
|
||||
license = "AGPL-3.0-or-later"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[build-dependencies]
|
||||
tonic-build = "0.4"
|
||||
|
||||
[dependencies]
|
||||
tonic = "0.4"
|
||||
prost = "0.7"
|
|
@ -0,0 +1,4 @@
|
|||
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
tonic_build::compile_protos("protos/dicebot.proto")?;
|
||||
Ok(())
|
||||
}
|
|
@ -0,0 +1,52 @@
|
|||
syntax = "proto3";
|
||||
package dicebot;
|
||||
|
||||
service Dicebot {
|
||||
rpc GetVariable(GetVariableRequest) returns (GetVariableReply);
|
||||
rpc GetAllVariables(GetAllVariablesRequest) returns (GetAllVariablesReply);
|
||||
rpc SetVariable(SetVariableRequest) returns (SetVariableReply);
|
||||
rpc RoomsForUser(UserIdRequest) returns (RoomsListReply);
|
||||
}
|
||||
|
||||
message GetVariableRequest {
|
||||
string user_id = 1;
|
||||
string room_id = 2;
|
||||
string variable_name = 3;
|
||||
}
|
||||
|
||||
message GetVariableReply {
|
||||
int32 value = 1;
|
||||
}
|
||||
|
||||
message GetAllVariablesRequest {
|
||||
string user_id = 1;
|
||||
string room_id = 2;
|
||||
}
|
||||
|
||||
message GetAllVariablesReply {
|
||||
map<string, int32> variables = 1;
|
||||
}
|
||||
|
||||
message SetVariableRequest {
|
||||
string user_id = 1;
|
||||
string room_id = 2;
|
||||
string variable_name = 3;
|
||||
int32 value = 4;
|
||||
}
|
||||
|
||||
message SetVariableReply {
|
||||
bool success = 1;
|
||||
}
|
||||
|
||||
message UserIdRequest {
|
||||
string user_id = 1;
|
||||
}
|
||||
|
||||
message RoomsListReply {
|
||||
message Room {
|
||||
string room_id = 1;
|
||||
string display_name = 2;
|
||||
}
|
||||
|
||||
repeated Room rooms = 1;
|
||||
}
|
|
@ -0,0 +1,5 @@
|
|||
pub mod protos {
|
||||
pub mod dicebot {
|
||||
tonic::include_proto!("dicebot");
|
||||
}
|
||||
}
|
|
@ -1,189 +0,0 @@
|
|||
/**
|
||||
* In addition to the terms of the AGPL, this file is governed by the
|
||||
* terms of the MIT license, from the original axfive-matrix-dicebot
|
||||
* project.
|
||||
*/
|
||||
use nom::bytes::complete::take_while;
|
||||
use nom::{
|
||||
alt, bytes::complete::tag, character::complete::digit1, complete, many0, named,
|
||||
sequence::tuple, tag, IResult,
|
||||
};
|
||||
|
||||
use super::dice::*;
|
||||
|
||||
//******************************
|
||||
//Legacy Code
|
||||
//******************************
|
||||
|
||||
fn is_whitespace(input: char) -> bool {
|
||||
input == ' ' || input == '\n' || input == '\t' || input == '\r'
|
||||
}
|
||||
|
||||
/// Eat whitespace, returning it
|
||||
pub fn eat_whitespace(input: &str) -> IResult<&str, &str> {
|
||||
let (input, whitespace) = take_while(is_whitespace)(input)?;
|
||||
Ok((input, whitespace))
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
|
||||
enum Sign {
|
||||
Plus,
|
||||
Minus,
|
||||
}
|
||||
|
||||
// Parse a dice expression. Does not eat whitespace
|
||||
fn parse_dice(input: &str) -> IResult<&str, Dice> {
|
||||
let (input, (count, _, sides)) = tuple((digit1, tag("d"), digit1))(input)?;
|
||||
Ok((
|
||||
input,
|
||||
Dice::new(count.parse().unwrap(), sides.parse().unwrap()),
|
||||
))
|
||||
}
|
||||
|
||||
// Parse a single digit expression. Does not eat whitespace
|
||||
fn parse_bonus(input: &str) -> IResult<&str, u32> {
|
||||
let (input, bonus) = digit1(input)?;
|
||||
Ok((input, bonus.parse().unwrap()))
|
||||
}
|
||||
|
||||
// Parse a sign expression. Eats whitespace.
|
||||
fn parse_sign(input: &str) -> IResult<&str, Sign> {
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
named!(sign(&str) -> Sign, alt!(
|
||||
complete!(tag!("+")) => { |_| Sign::Plus } |
|
||||
complete!(tag!("-")) => { |_| Sign::Minus }
|
||||
));
|
||||
|
||||
let (input, sign) = sign(input)?;
|
||||
Ok((input, sign))
|
||||
}
|
||||
|
||||
// Parse an element expression. Eats whitespace.
|
||||
fn parse_element(input: &str) -> IResult<&str, Element> {
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
named!(element(&str) -> Element, alt!(
|
||||
parse_dice => { |d| Element::Dice(d) } |
|
||||
parse_bonus => { |b| Element::Bonus(b) }
|
||||
));
|
||||
|
||||
let (input, element) = element(input)?;
|
||||
Ok((input, element))
|
||||
}
|
||||
|
||||
// Parse a signed element expression. Eats whitespace.
|
||||
fn parse_signed_element(input: &str) -> IResult<&str, SignedElement> {
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
let (input, sign) = parse_sign(input)?;
|
||||
let (input, _) = eat_whitespace(input)?;
|
||||
|
||||
let (input, element) = parse_element(input)?;
|
||||
let element = match sign {
|
||||
Sign::Plus => SignedElement::Positive(element),
|
||||
Sign::Minus => SignedElement::Negative(element),
|
||||
};
|
||||
Ok((input, element))
|
||||
}
|
||||
|
||||
// Parse a full element expression. Eats whitespace.
|
||||
pub fn parse_element_expression(input: &str) -> IResult<&str, ElementExpression> {
|
||||
named!(first_element(&str) -> SignedElement, alt!(
|
||||
parse_signed_element => { |e| e } |
|
||||
parse_element => { |e| SignedElement::Positive(e) }
|
||||
));
|
||||
let (input, first) = first_element(input)?;
|
||||
let (input, rest) = if input.trim().is_empty() {
|
||||
(input, vec![first])
|
||||
} else {
|
||||
named!(rest_elements(&str) -> Vec<SignedElement>, many0!(parse_signed_element));
|
||||
let (input, mut rest) = rest_elements(input)?;
|
||||
rest.insert(0, first);
|
||||
(input, rest)
|
||||
};
|
||||
|
||||
Ok((input, ElementExpression(rest)))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn dice_test() {
|
||||
assert_eq!(parse_dice("2d4"), Ok(("", Dice::new(2, 4))));
|
||||
assert_eq!(parse_dice("20d40"), Ok(("", Dice::new(20, 40))));
|
||||
assert_eq!(parse_dice("8d7"), Ok(("", Dice::new(8, 7))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn element_test() {
|
||||
assert_eq!(
|
||||
parse_element(" \t\n\r\n 8d7 \n"),
|
||||
Ok((" \n", Element::Dice(Dice::new(8, 7))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element(" \t\n\r\n 8 \n"),
|
||||
Ok((" \n", Element::Bonus(8)))
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn signed_element_test() {
|
||||
assert_eq!(
|
||||
parse_signed_element("+ 7"),
|
||||
Ok(("", SignedElement::Positive(Element::Bonus(7))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n- 8 \n"),
|
||||
Ok((" \n", SignedElement::Negative(Element::Bonus(8))))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n- 8d4 \n"),
|
||||
Ok((
|
||||
" \n",
|
||||
SignedElement::Negative(Element::Dice(Dice::new(8, 4)))
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_signed_element(" \t\n\r\n+ 8d4 \n"),
|
||||
Ok((
|
||||
" \n",
|
||||
SignedElement::Positive(Element::Dice(Dice::new(8, 4)))
|
||||
))
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn element_expression_test() {
|
||||
assert_eq!(
|
||||
parse_element_expression("8d4"),
|
||||
Ok((
|
||||
"",
|
||||
ElementExpression(vec![SignedElement::Positive(Element::Dice(Dice::new(
|
||||
8, 4
|
||||
)))])
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element_expression(" - 8d4 \n "),
|
||||
Ok((
|
||||
" \n ",
|
||||
ElementExpression(vec![SignedElement::Negative(Element::Dice(Dice::new(
|
||||
8, 4
|
||||
)))])
|
||||
))
|
||||
);
|
||||
assert_eq!(
|
||||
parse_element_expression("\t3d4 + 7 - 5 - 6d12 + 1d1 + 53 1d5 "),
|
||||
Ok((
|
||||
" 1d5 ",
|
||||
ElementExpression(vec![
|
||||
SignedElement::Positive(Element::Dice(Dice::new(3, 4))),
|
||||
SignedElement::Positive(Element::Bonus(7)),
|
||||
SignedElement::Negative(Element::Bonus(5)),
|
||||
SignedElement::Negative(Element::Dice(Dice::new(6, 12))),
|
||||
SignedElement::Positive(Element::Dice(Dice::new(1, 1))),
|
||||
SignedElement::Positive(Element::Bonus(53)),
|
||||
])
|
||||
))
|
||||
);
|
||||
}
|
||||
}
|
|
@ -1,106 +0,0 @@
|
|||
use crate::commands::{execute_command, ExecutionError, ExecutionResult, ResponseExtractor};
|
||||
use crate::context::{Context, RoomContext};
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::error::BotError;
|
||||
use crate::matrix;
|
||||
use futures::stream::{self, StreamExt};
|
||||
use matrix_sdk::{self, identifiers::EventId, room::Joined, Client};
|
||||
use std::clone::Clone;
|
||||
|
||||
/// Handle responding to a single command being executed. Wil print
|
||||
/// out the full result of that command.
|
||||
pub(super) async fn handle_single_result(
|
||||
client: &Client,
|
||||
cmd_result: &ExecutionResult,
|
||||
respond_to: &str,
|
||||
room: &Joined,
|
||||
event_id: EventId,
|
||||
) {
|
||||
let html = cmd_result.message_html(respond_to);
|
||||
matrix::send_message(client, room.room_id(), &html, Some(event_id)).await;
|
||||
}
|
||||
|
||||
/// Handle responding to multiple commands being executed. Will print
|
||||
/// out how many commands succeeded and failed (if any failed).
|
||||
pub(super) async fn handle_multiple_results(
|
||||
client: &Client,
|
||||
results: &[(String, ExecutionResult)],
|
||||
respond_to: &str,
|
||||
room: &Joined,
|
||||
) {
|
||||
let respond_to = format!(
|
||||
"<a href=\"https://matrix.to/#/{}\">{}</a>",
|
||||
respond_to, respond_to
|
||||
);
|
||||
|
||||
let errors: Vec<(&str, &ExecutionError)> = results
|
||||
.into_iter()
|
||||
.filter_map(|(cmd, result)| match result {
|
||||
Err(e) => Some((cmd.as_ref(), e)),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
|
||||
let message = if errors.len() == 0 {
|
||||
format!("{}: Executed {} commands", respond_to, results.len())
|
||||
} else {
|
||||
let failures: Vec<String> = errors
|
||||
.iter()
|
||||
.map(|&(cmd, err)| format!("<strong>{}:</strong> {}", cmd, err))
|
||||
.collect();
|
||||
|
||||
format!(
|
||||
"{}: Executed {} commands ({} failed)\n\nFailures:\n{}",
|
||||
respond_to,
|
||||
results.len(),
|
||||
errors.len(),
|
||||
failures.join("\n")
|
||||
)
|
||||
.replace("\n", "<br/>")
|
||||
};
|
||||
|
||||
matrix::send_message(client, room.room_id(), &message, None).await;
|
||||
}
|
||||
|
||||
/// Create a context for command execution. Can fai if the room
|
||||
/// context creation fails.
|
||||
async fn create_context<'a>(
|
||||
db: &'a Database,
|
||||
client: &'a Client,
|
||||
room: &'a Joined,
|
||||
sender: &'a str,
|
||||
command: &'a str,
|
||||
) -> Result<Context<'a>, BotError> {
|
||||
let room_ctx = RoomContext::new(room, sender).await?;
|
||||
Ok(Context {
|
||||
db: db.clone(),
|
||||
matrix_client: client,
|
||||
room: room_ctx,
|
||||
username: &sender,
|
||||
message_body: &command,
|
||||
})
|
||||
}
|
||||
|
||||
/// Attempt to execute all commands sent to the bot in a message. This
|
||||
/// asynchronously executes all commands given to it. A Vec of all
|
||||
/// commands and their execution results are returned.
|
||||
pub(super) async fn execute(
|
||||
commands: Vec<&str>,
|
||||
db: &Database,
|
||||
client: &Client,
|
||||
room: &Joined,
|
||||
sender: &str,
|
||||
) -> Vec<(String, ExecutionResult)> {
|
||||
stream::iter(commands)
|
||||
.then(|command| async move {
|
||||
match create_context(db, client, room, sender, command).await {
|
||||
Err(e) => (command.to_owned(), Err(ExecutionError(e))),
|
||||
Ok(ctx) => {
|
||||
let cmd_result = execute_command(&ctx).await;
|
||||
(command.to_owned(), cmd_result)
|
||||
}
|
||||
}
|
||||
})
|
||||
.collect()
|
||||
.await
|
||||
}
|
|
@ -1,163 +0,0 @@
|
|||
/**
|
||||
* In addition to the terms of the AGPL, portions of this file
|
||||
* are governed by the terms of the MIT license, from the Rust Matrix
|
||||
* SDK example code.
|
||||
*/
|
||||
use super::DiceBot;
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::Rooms;
|
||||
use crate::error::BotError;
|
||||
use async_trait::async_trait;
|
||||
use log::{debug, error, info, warn};
|
||||
use matrix_sdk::{
|
||||
self,
|
||||
events::{
|
||||
room::member::MemberEventContent,
|
||||
room::message::{MessageEventContent, MessageType, TextMessageEventContent},
|
||||
StrippedStateEvent, SyncMessageEvent,
|
||||
},
|
||||
room::Room,
|
||||
EventHandler,
|
||||
};
|
||||
use std::ops::Sub;
|
||||
use std::time::{Duration, SystemTime};
|
||||
use std::{clone::Clone, time::UNIX_EPOCH};
|
||||
|
||||
/// Check if a message is recent enough to actually process. If the
|
||||
/// message is within "oldest_message_age" seconds, this function
|
||||
/// returns true. If it's older than that, it returns false and logs a
|
||||
/// debug message.
|
||||
fn check_message_age(
|
||||
event: &SyncMessageEvent<MessageEventContent>,
|
||||
oldest_message_age: u64,
|
||||
) -> bool {
|
||||
let sending_time = event
|
||||
.origin_server_ts
|
||||
.to_system_time()
|
||||
.unwrap_or(UNIX_EPOCH);
|
||||
|
||||
let oldest_timestamp = SystemTime::now().sub(Duration::from_secs(oldest_message_age));
|
||||
|
||||
if sending_time > oldest_timestamp {
|
||||
true
|
||||
} else {
|
||||
let age = match oldest_timestamp.duration_since(sending_time) {
|
||||
Ok(n) => format!("{} seconds too old", n.as_secs()),
|
||||
Err(_) => "before the UNIX epoch".to_owned(),
|
||||
};
|
||||
|
||||
debug!("Ignoring message because it is {}: {:?}", age, event);
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
/// Determine whether or not to process a received message. This check
|
||||
/// is necessary in addition to the event processing check because we
|
||||
/// may receive message events when entering a room for the first
|
||||
/// time, and we don't want to respond to things before the bot was in
|
||||
/// the channel, but we do want to respond to things that were sent if
|
||||
/// the bot left and rejoined quickly.
|
||||
async fn should_process_message<'a>(
|
||||
bot: &DiceBot,
|
||||
event: &SyncMessageEvent<MessageEventContent>,
|
||||
) -> Result<(String, String), BotError> {
|
||||
//Ignore messages that are older than configured duration.
|
||||
if !check_message_age(event, bot.config.oldest_message_age()) {
|
||||
let state_check = bot.state.read().unwrap();
|
||||
if !((*state_check).logged_skipped_old_messages()) {
|
||||
drop(state_check);
|
||||
let mut state = bot.state.write().unwrap();
|
||||
(*state).skipped_old_messages();
|
||||
}
|
||||
|
||||
return Err(BotError::ShouldNotProcessError);
|
||||
}
|
||||
|
||||
let (msg_body, sender_username) = if let SyncMessageEvent {
|
||||
content:
|
||||
MessageEventContent {
|
||||
msgtype: MessageType::Text(TextMessageEventContent { body, .. }),
|
||||
..
|
||||
},
|
||||
sender,
|
||||
..
|
||||
} = event
|
||||
{
|
||||
(
|
||||
body.clone(),
|
||||
format!("@{}:{}", sender.localpart(), sender.server_name()),
|
||||
)
|
||||
} else {
|
||||
(String::new(), String::new())
|
||||
};
|
||||
|
||||
Ok((msg_body, sender_username))
|
||||
}
|
||||
|
||||
async fn should_process_event(db: &Database, room_id: &str, event_id: &str) -> bool {
|
||||
db.should_process(room_id, event_id)
|
||||
.await
|
||||
.unwrap_or_else(|e| {
|
||||
error!(
|
||||
"Database error when checking if we should process an event: {}",
|
||||
e.to_string()
|
||||
);
|
||||
false
|
||||
})
|
||||
}
|
||||
|
||||
/// This event emitter listens for messages with dice rolling commands.
|
||||
/// Originally adapted from the matrix-rust-sdk examples.
|
||||
#[async_trait]
|
||||
impl EventHandler for DiceBot {
|
||||
async fn on_stripped_state_member(
|
||||
&self,
|
||||
room: Room,
|
||||
event: &StrippedStateEvent<MemberEventContent>,
|
||||
_: Option<MemberEventContent>,
|
||||
) {
|
||||
let room = match room {
|
||||
Room::Invited(invited_room) => invited_room,
|
||||
_ => return,
|
||||
};
|
||||
|
||||
if room.own_user_id().as_str() != event.state_key {
|
||||
return;
|
||||
}
|
||||
|
||||
info!(
|
||||
"Autojoining room {}",
|
||||
room.display_name().await.ok().unwrap_or_default()
|
||||
);
|
||||
|
||||
if let Err(e) = self.client.join_room_by_id(&room.room_id()).await {
|
||||
warn!("Could not join room: {}", e.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
async fn on_room_message(&self, room: Room, event: &SyncMessageEvent<MessageEventContent>) {
|
||||
let room = match room {
|
||||
Room::Joined(joined_room) => joined_room,
|
||||
_ => return,
|
||||
};
|
||||
|
||||
let room_id = room.room_id().as_str();
|
||||
if !should_process_event(&self.db, room_id, event.event_id.as_str()).await {
|
||||
return;
|
||||
}
|
||||
|
||||
let (msg_body, sender_username) =
|
||||
if let Ok((msg_body, sender_username)) = should_process_message(self, &event).await {
|
||||
(msg_body, sender_username)
|
||||
} else {
|
||||
return;
|
||||
};
|
||||
|
||||
let results = self
|
||||
.execute_commands(&room, &sender_username, &msg_body)
|
||||
.await;
|
||||
|
||||
self.handle_results(&room, &sender_username, event.event_id.clone(), results)
|
||||
.await;
|
||||
}
|
||||
}
|
|
@ -1,28 +0,0 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::basic::dice::ElementExpression;
|
||||
use crate::basic::roll::Roll;
|
||||
use crate::context::Context;
|
||||
use async_trait::async_trait;
|
||||
|
||||
pub struct RollCommand(pub ElementExpression);
|
||||
|
||||
#[async_trait]
|
||||
impl Command for RollCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"roll regular dice"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
false
|
||||
}
|
||||
|
||||
async fn execute(&self, _ctx: &Context<'_>) -> ExecutionResult {
|
||||
let roll = self.0.roll();
|
||||
let html = format!(
|
||||
"<strong>Dice:</strong> {}</p><p><strong>Result</strong>: {}",
|
||||
self.0, roll
|
||||
);
|
||||
|
||||
Execution::success(html)
|
||||
}
|
||||
}
|
|
@ -1,82 +0,0 @@
|
|||
use super::{Command, Execution, ExecutionResult};
|
||||
use crate::context::Context;
|
||||
use crate::db::Users;
|
||||
use crate::error::BotError::{AccountDoesNotExist, AuthenticationError, PasswordCreationError};
|
||||
use crate::logic::hash_password;
|
||||
use crate::models::User;
|
||||
use async_trait::async_trait;
|
||||
|
||||
pub struct RegisterCommand(pub String);
|
||||
|
||||
#[async_trait]
|
||||
impl Command for RegisterCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"register user account"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let pw_hash = hash_password(&self.0).map_err(|e| PasswordCreationError(e))?;
|
||||
let user = User {
|
||||
username: ctx.username.to_owned(),
|
||||
password: pw_hash,
|
||||
};
|
||||
|
||||
ctx.db.upsert_user(&user).await?;
|
||||
Execution::success(format!(
|
||||
"User account registered/updated. Please log in to external applications \
|
||||
with username {} and the password you set.",
|
||||
ctx.username
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
pub struct CheckCommand(pub String);
|
||||
|
||||
#[async_trait]
|
||||
impl Command for CheckCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"check user password"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let user = ctx.db.authenticate_user(&ctx.username, &self.0).await?;
|
||||
|
||||
match user {
|
||||
Some(_) => Execution::success("Password is correct!".to_string()),
|
||||
None => Err(AuthenticationError.into()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub struct UnregisterCommand;
|
||||
|
||||
#[async_trait]
|
||||
impl Command for UnregisterCommand {
|
||||
fn name(&self) -> &'static str {
|
||||
"unregister user account"
|
||||
}
|
||||
|
||||
fn is_secure(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
async fn execute(&self, ctx: &Context<'_>) -> ExecutionResult {
|
||||
let user = ctx.db.get_user(&ctx.username).await?;
|
||||
|
||||
match user {
|
||||
Some(_) => {
|
||||
ctx.db.delete_user(&ctx.username).await?;
|
||||
Execution::success("Your user account has been removed.".to_string())
|
||||
}
|
||||
None => Err(AccountDoesNotExist.into()),
|
||||
}
|
||||
}
|
||||
}
|
|
@ -1,2 +0,0 @@
|
|||
use refinery::include_migration_mods;
|
||||
include_migration_mods!("src/db/sqlite/migrator/migrations");
|
|
@ -1,210 +0,0 @@
|
|||
use super::Database;
|
||||
use crate::db::{errors::DataError, Users};
|
||||
use crate::error::BotError;
|
||||
use crate::models::User;
|
||||
use async_trait::async_trait;
|
||||
|
||||
#[async_trait]
|
||||
impl Users for Database {
|
||||
async fn upsert_user(&self, user: &User) -> Result<(), DataError> {
|
||||
sqlx::query(
|
||||
r#"INSERT INTO accounts (user_id, password) VALUES (?, ?)
|
||||
ON CONFLICT(user_id) DO UPDATE SET password = ?"#,
|
||||
)
|
||||
.bind(&user.username)
|
||||
.bind(&user.password)
|
||||
.bind(&user.password)
|
||||
.execute(&self.conn)
|
||||
.await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn delete_user(&self, username: &str) -> Result<(), DataError> {
|
||||
sqlx::query(r#"DELETE FROM accounts WHERE user_id = ?"#)
|
||||
.bind(&username)
|
||||
.execute(&self.conn)
|
||||
.await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn get_user(&self, username: &str) -> Result<Option<User>, DataError> {
|
||||
let user_row = sqlx::query!(
|
||||
r#"SELECT user_id, password FROM accounts
|
||||
WHERE user_id = ?"#,
|
||||
username
|
||||
)
|
||||
.fetch_optional(&self.conn)
|
||||
.await?;
|
||||
|
||||
Ok(user_row.map(|u| User {
|
||||
username: u.user_id,
|
||||
password: u.password,
|
||||
}))
|
||||
}
|
||||
|
||||
async fn authenticate_user(
|
||||
&self,
|
||||
username: &str,
|
||||
raw_password: &str,
|
||||
) -> Result<Option<User>, BotError> {
|
||||
let user = self.get_user(username).await?;
|
||||
Ok(user.filter(|u| u.verify_password(raw_password)))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::db::sqlite::Database;
|
||||
use crate::db::Users;
|
||||
|
||||
async fn create_db() -> Database {
|
||||
let db_path = tempfile::NamedTempFile::new_in(".").unwrap();
|
||||
crate::db::sqlite::migrator::migrate(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
Database::new(db_path.path().to_str().unwrap())
|
||||
.await
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn create_and_get_user_test() {
|
||||
let db = create_db().await;
|
||||
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: "abc".to_string(),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
assert_eq!(user.password, "abc");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_update_user() {
|
||||
let db = create_db().await;
|
||||
|
||||
let insert_result1 = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: "abc".to_string(),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result1.is_ok());
|
||||
|
||||
let insert_result2 = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: "123".to_string(),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result2.is_ok());
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
assert_eq!(user.password, "123"); //From second upsert
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn can_delete_user() {
|
||||
let db = create_db().await;
|
||||
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: "abc".to_string(),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
db.delete_user("myuser")
|
||||
.await
|
||||
.expect("User deletion query failed");
|
||||
|
||||
let user = db
|
||||
.get_user("myuser")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_none());
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn username_not_in_db_returns_none() {
|
||||
let db = create_db().await;
|
||||
let user = db
|
||||
.get_user("does not exist")
|
||||
.await
|
||||
.expect("Get user query failure");
|
||||
|
||||
assert!(user.is_none());
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn authenticate_user_is_some_with_valid_password() {
|
||||
let db = create_db().await;
|
||||
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: crate::logic::hash_password("abc").expect("password hash error!"),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.authenticate_user("myuser", "abc")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_some());
|
||||
let user = user.unwrap();
|
||||
assert_eq!(user.username, "myuser");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
|
||||
async fn authenticate_user_is_none_with_wrong_password() {
|
||||
let db = create_db().await;
|
||||
|
||||
let insert_result = db
|
||||
.upsert_user(&User {
|
||||
username: "myuser".to_string(),
|
||||
password: crate::logic::hash_password("abc").expect("password hash error!"),
|
||||
})
|
||||
.await;
|
||||
|
||||
assert!(insert_result.is_ok());
|
||||
|
||||
let user = db
|
||||
.authenticate_user("myuser", "wrong-password")
|
||||
.await
|
||||
.expect("User retrieval query failed");
|
||||
|
||||
assert!(user.is_none());
|
||||
}
|
||||
}
|
52
src/logic.rs
52
src/logic.rs
|
@ -1,52 +0,0 @@
|
|||
use crate::context::Context;
|
||||
use crate::db::Variables;
|
||||
use crate::error::{BotError, DiceRollingError};
|
||||
use crate::parser::dice::{Amount, Element};
|
||||
use argon2::{self, Config, Error as ArgonError};
|
||||
use futures::stream::{self, StreamExt, TryStreamExt};
|
||||
use rand::Rng;
|
||||
use std::slice;
|
||||
|
||||
/// Calculate the amount of dice to roll by consulting the database
|
||||
/// and replacing variables with corresponding the amount. Errors out
|
||||
/// if it cannot find a variable defined, or if the database errors.
|
||||
pub async fn calculate_single_die_amount(
|
||||
amount: &Amount,
|
||||
ctx: &Context<'_>,
|
||||
) -> Result<i32, BotError> {
|
||||
calculate_dice_amount(slice::from_ref(amount), ctx).await
|
||||
}
|
||||
|
||||
/// Calculate the amount of dice to roll by consulting the database
|
||||
/// and replacing variables with corresponding amounts. Errors out if
|
||||
/// it cannot find a variable defined, or if the database errors.
|
||||
pub async fn calculate_dice_amount(amounts: &[Amount], ctx: &Context<'_>) -> Result<i32, BotError> {
|
||||
let stream = stream::iter(amounts);
|
||||
let variables = &ctx
|
||||
.db
|
||||
.get_user_variables(&ctx.username, ctx.room_id().as_str())
|
||||
.await?;
|
||||
|
||||
use DiceRollingError::VariableNotFound;
|
||||
let dice_amount: i32 = stream
|
||||
.then(|amount| async move {
|
||||
match &amount.element {
|
||||
Element::Number(num_dice) => Ok(num_dice * amount.operator.mult()),
|
||||
Element::Variable(variable) => variables
|
||||
.get(variable)
|
||||
.ok_or_else(|| VariableNotFound(variable.clone()))
|
||||
.map(|i| *i),
|
||||
}
|
||||
})
|
||||
.try_fold(0, |total, num_dice| async move { Ok(total + num_dice) })
|
||||
.await?;
|
||||
|
||||
Ok(dice_amount)
|
||||
}
|
||||
|
||||
/// Hash a password using the argon2 algorithm with a 16 byte salt.
|
||||
pub(crate) fn hash_password(raw_password: &str) -> Result<String, ArgonError> {
|
||||
let salt = rand::thread_rng().gen::<[u8; 16]>();
|
||||
let config = Config::default();
|
||||
argon2::hash_encoded(raw_password.as_bytes(), &salt, &config)
|
||||
}
|
|
@ -1,45 +0,0 @@
|
|||
use serde::{Deserialize, Serialize};
|
||||
|
||||
/// RoomInfo has basic metadata about a room: its name, ID, etc.
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
|
||||
pub struct RoomInfo {
|
||||
pub room_id: String,
|
||||
pub room_name: String,
|
||||
}
|
||||
|
||||
#[derive(Eq, PartialEq, Debug)]
|
||||
pub struct User {
|
||||
pub username: String,
|
||||
pub password: String,
|
||||
}
|
||||
|
||||
impl User {
|
||||
pub fn verify_password(&self, raw_password: &str) -> bool {
|
||||
argon2::verify_encoded(&self.password, raw_password.as_bytes()).unwrap_or(false)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn verify_password_passes_with_correct_password() {
|
||||
let user = User {
|
||||
username: "myuser".to_string(),
|
||||
password: crate::logic::hash_password("mypassword").expect("Password hashing error!"),
|
||||
};
|
||||
|
||||
assert_eq!(user.verify_password("mypassword"), true);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verify_password_fails_with_wrong_password() {
|
||||
let user = User {
|
||||
username: "myuser".to_string(),
|
||||
password: crate::logic::hash_password("mypassword").expect("Password hashing error!"),
|
||||
};
|
||||
|
||||
assert_eq!(user.verify_password("wrong-password"), false);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue