amanda/reminder-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Help, messages, better parsing, packaging

Browse source 
Add help message, add support for attaching a message to a reminder, use
a better crate for parsing durations, add debian packaging.
This commit is contained in:
Amanda Graven 2021-06-12 22:57:31 +02:00
parent 45212da497
commit f0b3b2392e
Signed by: amanda
GPG key ID: 45C461CDC9286390
9 changed files with 437 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
Cargo.toml
View file

@ -1,5 +1,11 @@
[package]
name = "reminder-bot"
name = "am-reminder-bot"
description = "Matrix bot that gives you reminders"
repostirory = "https://git.nao.sh/amanda/reminder-bot"
keywords = ["matrix", "bot", "reminder"]
readme = "README.md"
license = "EUPL-1.2"
license-file = "LICENSE"
version = "0.1.0"
authors = ["Amanda Graven <amanda@amandag.net>"]
edition = "2018"
@ -7,9 +13,33 @@ edition = "2018"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
matrix-sdk = { git = "https://github.com/matrix-org/matrix-rust-sdk", rev = "dbf8cf2" }
ms-converter = "1.4"
#serde = { version = "1.0", features = ["derive"] }
humantime = "2.1"
rpassword = "5.0"
serde_json = "1.0"
time = "0.2"
tokio = { version = "1.0", features = ["macros", "time", "rt-multi-thread"]}
[dependencies.matrix-sdk]
git = "https://github.com/matrix-org/matrix-rust-sdk"
rev = "dbf8cf2"
default-features = false
features = ["encryption", "sled_cryptostore", "sled_state_store", "require_auth_for_profile_requests", "rustls-tls"]
[package.metadata.deb]
extended-description = "am-reminder-bot is a matrix bot that autojoins any matrix room its invited to, and lets you schedule reminders."
depends = "$auto, adduser"
priority = "optional"
section = "misc"
maintainer-scripts = "debian/"
conf-files = ["/etc/am-reminder-bot/session.json"]
assets = [
["target/release/am-reminder-bot", "usr/bin/", "755"],
["session.sample.json", "/etc/am-reminder-bot/session.json", "600"],
["README.md", "usr/share/doc/am-reminder-bot/README.md", "644"],
["debian/copyright", "usr/share/doc/am-reminder-bot/copyright", "644"]
]
[package.metadata.deb.systemd-units]
unit-scripts = "debian"
unit-name = "am-reminder-bot"
start = "false"

287
LICENSE Normal file
View file

@ -0,0 +1,287 @@
EUROPEAN UNION PUBLIC LICENCE v. 1.2
EUPL © the European Union 2007, 2016
This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
below) which is provided under the terms of this Licence. Any use of the Work,
other than as authorised under this Licence is prohibited (to the extent such
use is covered by a right of the copyright holder of the Work).
The Work is provided under the terms of this Licence when the Licensor (as
defined below) has placed the following notice immediately following the
copyright notice for the Work:
Licensed under the EUPL
or has expressed by any other means his willingness to license under the EUPL.
1. Definitions
In this Licence, the following terms have the following meaning:
- ‘The Licence’: this Licence.
- ‘The Original Work’: the work or software distributed or communicated by the
Licensor under this Licence, available as Source Code and also as Executable
Code as the case may be.
- ‘Derivative Works’: the works or software that could be created by the
Licensee, based upon the Original Work or modifications thereof. This Licence
does not define the extent of modification or dependence on the Original Work
required in order to classify a work as a Derivative Work; this extent is
determined by copyright law applicable in the country mentioned in Article 15.
- ‘The Work’: the Original Work or its Derivative Works.
- ‘The Source Code’: the human-readable form of the Work which is the most
convenient for people to study and modify.
- ‘The Executable Code’: any code which has generally been compiled and which is
meant to be interpreted by a computer as a program.
- ‘The Licensor’: the natural or legal person that distributes or communicates
the Work under the Licence.
- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
Licence, or otherwise contributes to the creation of a Derivative Work.
- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
the Work under the terms of the Licence.
- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
renting, distributing, communicating, transmitting, or otherwise making
available, online or offline, copies of the Work or providing access to its
essential functionalities at the disposal of any other natural or legal
person.
2. Scope of the rights granted by the Licence
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
sublicensable licence to do the following, for the duration of copyright vested
in the Original Work:
- use the Work in any circumstance and for all usage,
- reproduce the Work,
- modify the Work, and make Derivative Works based upon the Work,
- communicate to the public, including the right to make available or display
the Work or copies thereof to the public and perform publicly, as the case may
be, the Work,
- distribute the Work or copies thereof,
- lend and rent the Work or copies thereof,
- sublicense rights in the Work or copies thereof.
Those rights can be exercised on any media, supports and formats, whether now
known or later invented, as far as the applicable law permits so.
In the countries where moral rights apply, the Licensor waives his right to
exercise his moral right to the extent allowed by law in order to make effective
the licence of the economic rights here above listed.
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
any patents held by the Licensor, to the extent necessary to make use of the
rights granted on the Work under this Licence.
3. Communication of the Source Code
The Licensor may provide the Work either in its Source Code form, or as
Executable Code. If the Work is provided as Executable Code, the Licensor
provides in addition a machine-readable copy of the Source Code of the Work
along with each copy of the Work that the Licensor distributes or indicates, in
a notice following the copyright notice attached to the Work, a repository where
the Source Code is easily and freely accessible for as long as the Licensor
continues to distribute or communicate the Work.
4. Limitations on copyright
Nothing in this Licence is intended to deprive the Licensee of the benefits from
any exception or limitation to the exclusive rights of the rights owners in the
Work, of the exhaustion of those rights or of other applicable limitations
thereto.
5. Obligations of the Licensee
The grant of the rights mentioned above is subject to some restrictions and
obligations imposed on the Licensee. Those obligations are the following:
Attribution right: The Licensee shall keep intact all copyright, patent or
trademarks notices and all notices that refer to the Licence and to the
disclaimer of warranties. The Licensee must include a copy of such notices and a
copy of the Licence with every copy of the Work he/she distributes or
communicates. The Licensee must cause any Derivative Work to carry prominent
notices stating that the Work has been modified and the date of modification.
Copyleft clause: If the Licensee distributes or communicates copies of the
Original Works or Derivative Works, this Distribution or Communication will be
done under the terms of this Licence or of a later version of this Licence
unless the Original Work is expressly distributed only under this version of the
Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
(becoming Licensor) cannot offer or impose any additional terms or conditions on
the Work or Derivative Work that alter or restrict the terms of the Licence.
Compatibility clause: If the Licensee Distributes or Communicates Derivative
Works or copies thereof based upon both the Work and another work licensed under
a Compatible Licence, this Distribution or Communication can be done under the
terms of this Compatible Licence. For the sake of this clause, ‘Compatible
Licence’ refers to the licences listed in the appendix attached to this Licence.
Should the Licensee's obligations under the Compatible Licence conflict with
his/her obligations under this Licence, the obligations of the Compatible
Licence shall prevail.
Provision of Source Code: When distributing or communicating copies of the Work,
the Licensee will provide a machine-readable copy of the Source Code or indicate
a repository where this Source will be easily and freely available for as long
as the Licensee continues to distribute or communicate the Work.
Legal Protection: This Licence does not grant permission to use the trade names,
trademarks, service marks, or names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the copyright notice.
6. Chain of Authorship
The original Licensor warrants that the copyright in the Original Work granted
hereunder is owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
Each Contributor warrants that the copyright in the modifications he/she brings
to the Work are owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
Each time You accept the Licence, the original Licensor and subsequent
Contributors grant You a licence to their contributions to the Work, under the
terms of this Licence.
7. Disclaimer of Warranty
The Work is a work in progress, which is continuously improved by numerous
Contributors. It is not a finished work and may therefore contain defects or
‘bugs’ inherent to this type of development.
For the above reason, the Work is provided under the Licence on an ‘as is’ basis
and without warranties of any kind concerning the Work, including without
limitation merchantability, fitness for a particular purpose, absence of defects
or errors, accuracy, non-infringement of intellectual property rights other than
copyright as stated in Article 6 of this Licence.
This disclaimer of warranty is an essential part of the Licence and a condition
for the grant of any rights to the Work.
8. Disclaimer of Liability
Except in the cases of wilful misconduct or damages directly caused to natural
persons, the Licensor will in no event be liable for any direct or indirect,
material or moral, damages of any kind, arising out of the Licence or of the use
of the Work, including without limitation, damages for loss of goodwill, work
stoppage, computer failure or malfunction, loss of data or any commercial
damage, even if the Licensor has been advised of the possibility of such damage.
However, the Licensor will be liable under statutory product liability laws as
far such laws apply to the Work.
9. Additional agreements
While distributing the Work, You may choose to conclude an additional agreement,
defining obligations or services consistent with this Licence. However, if
accepting obligations, You may act only on your own behalf and on your sole
responsibility, not on behalf of the original Licensor or any other Contributor,
and only if You agree to indemnify, defend, and hold each Contributor harmless
for any liability incurred by, or claims asserted against such Contributor by
the fact You have accepted any warranty or additional liability.
10. Acceptance of the Licence
The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
placed under the bottom of a window displaying the text of this Licence or by
affirming consent in any other similar way, in accordance with the rules of
applicable law. Clicking on that icon indicates your clear and irrevocable
acceptance of this Licence and all of its terms and conditions.
Similarly, you irrevocably accept this Licence and all of its terms and
conditions by exercising any rights granted to You by Article 2 of this Licence,
such as the use of the Work, the creation by You of a Derivative Work or the
Distribution or Communication by You of the Work or copies thereof.
11. Information to the public
In case of any Distribution or Communication of the Work by means of electronic
communication by You (for example, by offering to download the Work from a
remote location) the distribution channel or media (for example, a website) must
at least provide to the public the information requested by the applicable law
regarding the Licensor, the Licence and the way it may be accessible, concluded,
stored and reproduced by the Licensee.
12. Termination of the Licence
The Licence and the rights granted hereunder will terminate automatically upon
any breach by the Licensee of the terms of the Licence.
Such a termination will not terminate the licences of any person who has
received the Work from the Licensee under the Licence, provided such persons
remain in full compliance with the Licence.
13. Miscellaneous
Without prejudice of Article 9 above, the Licence represents the complete
agreement between the Parties as to the Work.
If any provision of the Licence is invalid or unenforceable under applicable
law, this will not affect the validity or enforceability of the Licence as a
whole. Such provision will be construed or reformed so as necessary to make it
valid and enforceable.
The European Commission may publish other linguistic versions or new versions of
this Licence or updated versions of the Appendix, so far this is required and
reasonable, without reducing the scope of the rights granted by the Licence. New
versions of the Licence will be published with a unique version number.
All linguistic versions of this Licence, approved by the European Commission,
have identical value. Parties can take advantage of the linguistic version of
their choice.
14. Jurisdiction
Without prejudice to specific agreement between parties,
- any litigation resulting from the interpretation of this License, arising
between the European Union institutions, bodies, offices or agencies, as a
Licensor, and any Licensee, will be subject to the jurisdiction of the Court
of Justice of the European Union, as laid down in article 272 of the Treaty on
the Functioning of the European Union,
- any litigation arising between other parties and resulting from the
interpretation of this License, will be subject to the exclusive jurisdiction
of the competent court where the Licensor resides or conducts its primary
business.
15. Applicable Law
Without prejudice to specific agreement between parties,
- this Licence shall be governed by the law of the European Union Member State
where the Licensor has his seat, resides or has his registered office,
- this licence shall be governed by Belgian law if the Licensor has no seat,
residence or registered office inside a European Union Member State.
Appendix
‘Compatible Licences’ according to Article 5 EUPL are:
- GNU General Public License (GPL) v. 2, v. 3
- GNU Affero General Public License (AGPL) v. 3
- Open Software License (OSL) v. 2.1, v. 3.0
- Eclipse Public License (EPL) v. 1.0
- CeCILL v. 2.0, v. 2.1
- Mozilla Public Licence (MPL) v. 2
- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
works other than software
- European Union Public Licence (EUPL) v. 1.1, v. 1.2
- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
Reciprocity (LiLiQ-R+).
The European Commission may update this Appendix to later versions of the above
licences without producing a new version of the EUPL, as long as they provide
the rights granted in Article 2 of this Licence and protect the covered Source
Code from exclusive appropriation.
All other changes or additions to this Appendix require the production of a new
EUPL version.

12
README.md
View file

@ -1,3 +1,11 @@
# reminder-bot
# am-reminder-bot
Reminder bot for matrix rooms
am-reminder-bot is a matrix bot that autojoins any matrix room its invited to, and lets you schedule reminders. It's made with matrix-rust-sdk.
## Setup
Build the bot with `cargo build --release`. Configure a session file, see `session.sample.json` file for an example. You can generate one by starting the bot with `login` as the first argument. If you want the bot to work properly in encrypted rooms, also give it a storage directory it can write to. You can configure paths with these environment variables:
* `SESSION_FILE`: The path of the session file. The session file shouldn't be readable by other users, since it contains the matrix acc
* `STORAGE_DIR`: The directory the bot will use for storing matrix data. Needs to be writable.
A systemd service file is provided with sane defaults. A debian package can be generated with the cargo-deb utility.

12
debian/am-reminder-bot.service vendored Normal file
View file

@ -0,0 +1,12 @@
[Unit]
Description=Matrix reminder bot
After=network.target
[Service]
ExecStart=/usr/bin/am-reminder-bot
Environment="SESSION_FILE=/etc/am-reminder-bot/session.json" "STORAGE_DIR=/var/lib/am-reminder-bot/store"
User=am-reminder-bot
Group=am-reminder-bot
[Install]
WantedBy=multi-user.target

19
debian/copyright vendored Normal file
View file

@ -0,0 +1,19 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: Reminder bot
Source: https://git.nao.sh/amanda/reminder-bot
Files: *
Copyright: 2021 Amanda Graven <amanda@amandag.net>
License: EUPL-1.2
Copyright 2021 Amanda Graven
Licensed under the EUPL, Version 1.2 or – as soon they will be approved by the
European Commission - subsequent versions of the EUPL (the "Licence"); You may
not use this work except in compliance with the Licence. You may obtain a copy
of the Licence at:
.
https://joinup.ec.europa.eu/software/page/eupl
.
Unless required by applicable law or agreed to in writing, software distributed
under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the Licence for the
specific language governing permissions and limitations under the Licence.

7
debian/postinst vendored Normal file
View file

@ -0,0 +1,7 @@
#!/bin/bash
set -e
adduser --quiet --system --group --home "/var/lib/am-reminder-bot" am-reminder-bot
chown -R am-reminder-bot: /etc/am-reminder-bot
#DEBHELPER#

2
debian/postrm vendored Normal file
View file

@ -0,0 +1,2 @@
#!/bin/bash
#DEBHELPER#

2
debian/prerm vendored Normal file
View file

@ -0,0 +1,2 @@
#!/bin/bash
#DEBHELPER#

88
src/main.rs
View file

@ -1,4 +1,4 @@
use std::{convert::TryFrom, fs::File};
use std::{convert::TryFrom, fs::File, time::Duration};
use matrix_sdk::{
events::{
@ -14,6 +14,20 @@ use matrix_sdk::{
Client, ClientConfig, LoopCtrl, Session, SyncSettings,
};
const HELP_MESSAGE_PLAIN: &str = r#"Help:
!remindme help - show this help message
!remindme <time string> - send a reminder after the amount of time
!remindme <time string>: <message> - send a reminder with a message
<time string> is a string like "1h" or "1 hour"
"#;
const HELP_MESSAGE_HTML: &str = r#"<b>Help:</b>
<ul>
<li><code>!remindme &lt;time string&gt;</code>: Send a reminder at the specified time</li>
<li><code>!remindme &lt;time string&gt;: &lt;message&gt;:</code>: Send a reminder with a message</li>
</ul>
Where <code>&lt;time string&gt;</code> is a string like <code>1 day 23 seconds</code> or <code>1h 5m</code>. The HTML part of messages is ignored.
"#;
#[tokio::main]
async fn main() {
if let Some("login") = std::env::args().nth(1).as_deref() {
@ -41,6 +55,9 @@ async fn main() {
sync(client).await
}
/// Constructs a client from an mxid with the appropriate configuration. A
/// storage directory will be set if the `STORAGE_DIR` environment variable is
/// set.
async fn client(user_id: UserId) -> matrix_sdk::Result<Client> {
match std::env::var_os("STORAGE_DIR") {
Some(dir) => {
@ -69,8 +86,9 @@ async fn login() -> Result<Session, Box<dyn std::error::Error>> {
Ok(session)
}
/// Restores a login from a session file. It gets the file path from the `SESSION_PATH` environment
/// variable if set, and defaults to looking for `session.json` in the current directory otherwise.
/// Restores a login from a session file. It gets the file path from the
/// `SESSION_PATH` environment variable if set, and defaults to looking for
/// `session.json` in the current directory otherwise.
async fn restore_login() -> Result<Client, Box<dyn std::error::Error>> {
let path = std::env::var("SESSION_FILE").unwrap_or_else(|_| String::from("session.json"));
let file = File::open(&path)?;
@ -132,8 +150,8 @@ async fn handle_invite(
Some(invited) => invited,
None => return,
};
// Retry the accept until an house passes because synapse is silly and sends the invite before
// it's ready for receiving a join.
// Retry the accept until an house passes because synapse is silly and sends the
// invite before it's ready for receiving a join.
let mut delay = std::time::Duration::from_secs(2);
while invited.accept_invitation().await.is_err() {
tokio::time::sleep(delay).await;
@ -144,6 +162,7 @@ async fn handle_invite(
}
}
/// Handles a message event and sets a reminder if a correctly invoked command is found.
async fn handle_message(client: Client, message: MessageEvent) {
let text = match message.content.msgtype {
MessageType::Text(ref text) => text,
@ -154,32 +173,47 @@ async fn handle_message(client: Client, message: MessageEvent) {
Some(time) => time,
None => return,
};
// Get the reminder message if it exists.
let (time, reminder) = match time.split_once(": ") {
Some((time, reminder)) => (time, Some(reminder.to_owned())),
None => (time, None),
};
// Get the room so we can send messages.
let room = client.get_joined_room(&message.room_id).unwrap();
// Parse the duration, send message if that fails.
let duration = match ms_converter::ms_into_time(time) {
Ok(time) => time,
Err(_) => {
let _ = room
.send(
AnyMessageEventContent::RoomMessage(MessageEventContent::notice_reply_plain(
"Sorry! I don't understand when you want me to remind you.",
// Check for a help message
if time.trim().to_ascii_lowercase().as_str() == "help" {
let response = AnyMessageEventContent::RoomMessage(MessageEventContent::notice_reply_html(
HELP_MESSAGE_PLAIN,
HELP_MESSAGE_HTML,
&message,
)),
None,
)
.await;
));
let _ = room.send(response, None).await;
return;
}
// Parse the duration, send message if that fails.
let duration = match humantime::parse_duration(time) {
Ok(time) => time,
Err(_) if time.trim() == "tomorrow" => Duration::new(60 * 60 * 24, 0),
Err(e) => {
let response =
AnyMessageEventContent::RoomMessage(MessageEventContent::notice_reply_plain(
format!("Sorry! I don't understand when you want me to remind you: {}. Say !remindme help for help.", e),
&message,
));
let _ = room.send(response, None).await;
return;
}
};
// Send a reaction so the sender knows their message was received
let remind_time = time::OffsetDateTime::now_utc() + duration;
let _ = room
.send(
AnyMessageEventContent::Reaction(ReactionEventContent::new(ReactionRelation::new(
message.event_id.clone(),
String::from("✅"),
remind_time.format("%d %b %T UTC"),
))),
None,
)
@ -187,10 +221,18 @@ async fn handle_message(client: Client, message: MessageEvent) {
tokio::task::spawn(async move {
tokio::time::sleep(duration).await;
// contruct the reminder message
let content = AnyMessageEventContent::RoomMessage(MessageEventContent::notice_reply_plain(
"Here's your reminder!",
&message,
));
let _ = room.send(content, None).await;
let content = match reminder {
Some(reminder) => format!("Here's your reminder: {}", reminder),
None => String::from("Here's your reminder!"),
};
let response = AnyMessageEventContent::RoomMessage(
MessageEventContent::notice_reply_plain(content, &message),
);
let _ = room.send(response, None).await;
});
}
#[test]
fn parsing_test() {
humantime::parse_duration("1 day 23 seconds").unwrap();
}