35 Commits

Author SHA1 Message Date
VC
9dd6ab8370 Merge branch 'fix_smart_mentions' into 'master'
Fix smart mentions

See merge request veretcle/scootaloo!37
2022-11-21 20:33:32 +00:00
VC
4679578101 chore: bump version 2022-11-21 21:28:09 +01:00
VC
2501d5990f fix: typo in the scootaloo_mentions var 2022-11-21 21:27:40 +01:00
VC
cb36730151 Merge branch 'fix_docs' into 'master'
docs: add mastodon_screen_name

See merge request veretcle/scootaloo!36
2022-11-21 09:31:56 +00:00
VC
a9942fad5c docs: add mastodon_screen_name 2022-11-21 10:31:38 +01:00
VC
522d4e3ea5 Merge branch '7-implement-smart-mentions' into 'master'
Implement smart mentions

Closes #7

See merge request veretcle/scootaloo!35
2022-11-21 09:29:05 +00:00
VC
91e3cd04a0 chore: bump version 2022-11-21 10:18:32 +01:00
VC
87a7574d42 feat: add mastodon_screen_name automatically/revise necessary permissions 2022-11-21 10:03:03 +01:00
VC
18e8b9d306 feat: add scootaloo_mentions hash from config file to be inserted into mentions 2022-11-21 08:40:52 +01:00
VC
1e9c768a74 test: add tests for mastodon_screen_name in config struct 2022-11-21 08:40:52 +01:00
VC
83a133bb86 feat: add mastodon_screen_name to config struct 2022-11-21 08:40:52 +01:00
VC
92d5fdffad Merge branch 'fix_lang' into 'master'
fix: visibility

See merge request veretcle/scootaloo!33
2022-11-19 16:46:06 +00:00
VC
331adec60f fix: visibility 2022-11-19 17:45:52 +01:00
VC
9a341310da Merge branch 'fix_lang' into 'master'
Fix lang

See merge request veretcle/scootaloo!32
2022-11-19 16:39:05 +00:00
VC
2c77a0e5fc chore: bump version 2022-11-19 17:34:09 +01:00
VC
032e3cf8dd fix: lang is not the default one anymore 2022-11-19 17:33:50 +01:00
VC
a854243cf6 Merge branch 'command_help' into 'master'
fix: remove unnecessary information in help commands

See merge request veretcle/scootaloo!31
2022-11-18 12:31:17 +00:00
VC
b33ffa4401 fix: remove unnecessary information in help commands 2022-11-18 13:27:18 +01:00
VC
77941e0b9a Merge branch 'filter_tweet' into 'master'
refactor: eliminate response tweet earlier

See merge request veretcle/scootaloo!30
2022-11-18 12:17:54 +00:00
VC
1489f89bdb chore: bump version 2022-11-18 13:12:24 +01:00
VC
93a27deae8 refactor: eliminate response tweet earlier 2022-11-18 12:48:40 +01:00
VC
fe3745d91f Merge branch '6-make-last-tweet-retrieved-configurable' into 'master'
test: add rate_limit

Closes #6

See merge request veretcle/scootaloo!29
2022-11-15 20:37:37 +00:00
VC
9a1e4c8e6c doc: add section about page_size 2022-11-15 21:24:34 +01:00
VC
8b12f83c5d chore: bump version 2022-11-15 21:14:21 +01:00
VC
f93bb5158b test: add page_size tests 2022-11-15 21:14:12 +01:00
VC
d5db8b0d85 feat: add customizable page_size to twitter timeline 2022-11-15 21:14:01 +01:00
VC
fe8e81b54d feat: add page_size both in twitter and mastodon config 2022-11-15 21:13:23 +01:00
VC
636ea8c85e test: add rate_limit 2022-11-15 19:36:48 +01:00
VC
b3e7ee9d84 Merge branch '5-migrate-from-tokio-loop-to-futures-stream' into 'master'
refactor: use futures instead of tokio for media upload

Closes #5

See merge request veretcle/scootaloo!28
2022-11-15 09:11:28 +00:00
VC
7f7219ea78 feat: turn tokio-based async logic into futures 2022-11-15 10:06:00 +01:00
VC
f371b8a297 feat: add default rate_limiting option 2022-11-15 10:06:00 +01:00
VC
ec3956eabb doc: add rate_limiting option 2022-11-15 10:06:00 +01:00
VC
ce84c05581 refactor: use futures instead of tokio for media upload 2022-11-15 10:05:57 +01:00
VC
b64621368b Merge branch '4-migrate-to-clap-v4' into 'master'
refactor: migrate from clap v2 to clap v4

Closes #4

See merge request veretcle/scootaloo!27
2022-11-14 19:57:32 +00:00
VC
89de1cf7a3 refactor: migrate from clap v2 to clap v4 2022-11-14 20:36:15 +01:00
14 changed files with 457 additions and 236 deletions

59
Cargo.lock generated
View File

@@ -46,15 +46,6 @@ dependencies = [
"libc", "libc",
] ]
[[package]]
name = "ansi_term"
version = "0.12.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2"
dependencies = [
"winapi 0.3.9",
]
[[package]] [[package]]
name = "atty" name = "atty"
version = "0.2.14" version = "0.2.14"
@@ -261,9 +252,9 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
[[package]] [[package]]
name = "chrono" name = "chrono"
version = "0.4.22" version = "0.4.23"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bfd4d1b31faaa3a89d7934dbded3111da0d2ef28e3ebccdb4f0179f5929d1ef1" checksum = "16b0a3d9ed01224b22057780a37bb8c5dbfe1be8ba48678e7bf57ec4b385411f"
dependencies = [ dependencies = [
"iana-time-zone", "iana-time-zone",
"js-sys", "js-sys",
@@ -277,17 +268,24 @@ dependencies = [
[[package]] [[package]]
name = "clap" name = "clap"
version = "2.34.0" version = "4.0.24"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a0610544180c38b88101fecf2dd634b174a62eef6946f84dfc6a7127512b381c" checksum = "60494cedb60cb47462c0ff7be53de32c0e42a6fc2c772184554fa12bd9489c03"
dependencies = [ dependencies = [
"ansi_term",
"atty", "atty",
"bitflags", "bitflags",
"clap_lex",
"strsim", "strsim",
"textwrap", "termcolor",
"unicode-width", ]
"vec_map",
[[package]]
name = "clap_lex"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0d4198f73e42b4936b35b5bb248d81d2b595ecb170da0bac7655c54eedfa8da8"
dependencies = [
"os_str_bytes",
] ]
[[package]] [[package]]
@@ -1567,6 +1565,12 @@ dependencies = [
"vcpkg", "vcpkg",
] ]
[[package]]
name = "os_str_bytes"
version = "6.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7b5bf27447411e9ee3ff51186bf7a08e16c341efdde93f4d823e8844429bed7e"
[[package]] [[package]]
name = "parking_lot" name = "parking_lot"
version = "0.9.0" version = "0.9.0"
@@ -2099,7 +2103,7 @@ dependencies = [
[[package]] [[package]]
name = "scootaloo" name = "scootaloo"
version = "0.8.2" version = "0.10.1"
dependencies = [ dependencies = [
"chrono", "chrono",
"clap", "clap",
@@ -2368,9 +2372,9 @@ dependencies = [
[[package]] [[package]]
name = "strsim" name = "strsim"
version = "0.8.0" version = "0.10.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a" checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
[[package]] [[package]]
name = "subtle" name = "subtle"
@@ -2430,15 +2434,6 @@ dependencies = [
"winapi-util", "winapi-util",
] ]
[[package]]
name = "textwrap"
version = "0.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060"
dependencies = [
"unicode-width",
]
[[package]] [[package]]
name = "thiserror" name = "thiserror"
version = "1.0.37" version = "1.0.37"
@@ -2869,12 +2864,6 @@ version = "0.2.15"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
[[package]]
name = "vec_map"
version = "0.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f1bddf1187be692e79c5ffeab891132dfb0f236ed36a43c7ed39f1165ee20191"
[[package]] [[package]]
name = "version_check" name = "version_check"
version = "0.9.4" version = "0.9.4"

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "scootaloo" name = "scootaloo"
version = "0.8.2" version = "0.10.1"
authors = ["VC <veretcle+framagit@mateu.be>"] authors = ["VC <veretcle+framagit@mateu.be>"]
edition = "2021" edition = "2021"
@@ -10,11 +10,11 @@ edition = "2021"
chrono = "^0.4" chrono = "^0.4"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
toml = "^0.5" toml = "^0.5"
clap = "^2.34" clap = "^4"
futures = "^0.3"
egg-mode = "^0.16" egg-mode = "^0.16"
rusqlite = "^0.27" rusqlite = "^0.27"
tokio = { version = "1", features = ["full"]} tokio = { version = "^1", features = ["full"]}
futures = "^0.3"
elefren = "^0.22" elefren = "^0.22"
html-escape = "^0.2" html-escape = "^0.2"
reqwest = "^0.11" reqwest = "^0.11"

View File

@@ -18,9 +18,11 @@ First up, create a configuration file (default path is `/usr/local/etc/scootaloo
[scootaloo] [scootaloo]
db_path = "/var/lib/scootaloo/scootaloo.sqlite" ## file containing the SQLite Tweet corresponding Toot DB, must be writeable db_path = "/var/lib/scootaloo/scootaloo.sqlite" ## file containing the SQLite Tweet corresponding Toot DB, must be writeable
cache_path = "/tmp/scootaloo" ## a dir where the temporary files will be download, must be writeable cache_path = "/tmp/scootaloo" ## a dir where the temporary files will be download, must be writeable
rate_limiting = 4 ## optional, default 4, number of accounts handled simultaneously
[twitter] [twitter]
## Consumer/Access key for Twitter (can be generated at https://developer.twitter.com/en/apps) ## Consumer/Access key for Twitter (can be generated at https://developer.twitter.com/en/apps)
page_size = 20 ## optional, default 200, max number of tweet retrieved
consumer_key = "MYCONSUMERKEY" consumer_key = "MYCONSUMERKEY"
consumer_secret = "MYCONSUMERSECRET" consumer_secret = "MYCONSUMERSECRET"
access_key = "MYACCESSKEY" access_key = "MYACCESSKEY"
@@ -46,6 +48,7 @@ This will give you the end of the TOML file. It will look like this:
```toml ```toml
[mastodon.nintendojofr] ## account [mastodon.nintendojofr] ## account
twitter_screen_name = "NintendojoFR" ## User Timeline to copy twitter_screen_name = "NintendojoFR" ## User Timeline to copy
mastodon_screen_name = "nintendojofr" ## optional, Mastodon account name used for smart mentions
base = "https://m.nintendojo.fr" base = "https://m.nintendojo.fr"
client_id = "MYCLIENTID" client_id = "MYCLIENTID"
client_secret = "MYCLIENTSECRET" client_secret = "MYCLIENTSECRET"
@@ -55,6 +58,11 @@ token = "MYTOKEN"
You can add other account if you like, after the `[mastodon]` moniker. Scootaloo would theorically support an unlimited number of accounts. You can add other account if you like, after the `[mastodon]` moniker. Scootaloo would theorically support an unlimited number of accounts.
You can also add a custom twitter page size in this section that would override the global (under the `twitter` moniker) and default one (200), like so:
```
twitter_page_size = 40
```
## Running ## Running
You can then run the application via `cron` for example. Here is the generic usage: You can then run the application via `cron` for example. Here is the generic usage:

View File

@@ -16,11 +16,14 @@ pub struct TwitterConfig {
pub consumer_secret: String, pub consumer_secret: String,
pub access_key: String, pub access_key: String,
pub access_secret: String, pub access_secret: String,
pub page_size: Option<i32>,
} }
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]
pub struct MastodonConfig { pub struct MastodonConfig {
pub twitter_screen_name: String, pub twitter_screen_name: String,
pub mastodon_screen_name: Option<String>,
pub twitter_page_size: Option<i32>,
pub base: String, pub base: String,
pub client_id: String, pub client_id: String,
pub client_secret: String, pub client_secret: String,
@@ -32,6 +35,7 @@ pub struct MastodonConfig {
pub struct ScootalooConfig { pub struct ScootalooConfig {
pub db_path: String, pub db_path: String,
pub cache_path: String, pub cache_path: String,
pub rate_limit: Option<usize>,
} }
/// Parses the TOML file into a Config Struct /// Parses the TOML file into a Config Struct

View File

@@ -19,18 +19,19 @@ mod state;
pub use state::{init_db, migrate_db}; pub use state::{init_db, migrate_db};
use state::{read_state, write_state, TweetToToot}; use state::{read_state, write_state, TweetToToot};
use elefren::{prelude::*, status_builder::StatusBuilder}; use elefren::{prelude::*, status_builder::StatusBuilder, Language};
use futures::StreamExt;
use log::info; use log::info;
use rusqlite::Connection; use rusqlite::Connection;
use std::sync::Arc; use std::{collections::HashMap, sync::Arc};
use tokio::{spawn, sync::Mutex}; use tokio::{spawn, sync::Mutex};
const DEFAULT_RATE_LIMIT: usize = 4;
const DEFAULT_PAGE_SIZE: i32 = 200;
/// This is where the magic happens /// This is where the magic happens
#[tokio::main] #[tokio::main]
pub async fn run(config: Config) { pub async fn run(config: Config) {
// create the task vector for handling multiple accounts
let mut mtask = vec![];
// open the SQLite connection // open the SQLite connection
let conn = Arc::new(Mutex::new( let conn = Arc::new(Mutex::new(
Connection::open(&config.scootaloo.db_path).unwrap_or_else(|e| { Connection::open(&config.scootaloo.db_path).unwrap_or_else(|e| {
@@ -41,64 +42,73 @@ pub async fn run(config: Config) {
}), }),
)); ));
for mastodon_config in config.mastodon.into_values() { let scootaloo_mentions: HashMap<String, String> = config
.mastodon
.values()
.filter(|s| s.mastodon_screen_name.is_some())
.map(|s| {
(
format!("@{}", s.twitter_screen_name),
format!(
"@{}@{}",
s.mastodon_screen_name.as_ref().unwrap(),
s.base.split('/').last().unwrap()
),
)
})
.collect();
let mut stream = futures::stream::iter(config.mastodon.into_values())
.map(|mastodon_config| {
// calculate Twitter page size
let page_size = mastodon_config
.twitter_page_size
.unwrap_or_else(|| config.twitter.page_size.unwrap_or(DEFAULT_PAGE_SIZE));
// create temporary value for each task // create temporary value for each task
let scootaloo_cache_path = config.scootaloo.cache_path.clone(); let scootaloo_cache_path = config.scootaloo.cache_path.clone();
let scootaloo_mentions = scootaloo_mentions.clone();
let token = get_oauth2_token(&config.twitter); let token = get_oauth2_token(&config.twitter);
let task_conn = conn.clone(); let task_conn = conn.clone();
let task = spawn(async move { spawn(async move {
info!("Starting treating {}", &mastodon_config.twitter_screen_name); info!("Starting treating {}", &mastodon_config.twitter_screen_name);
// retrieve the last tweet ID for the username // retrieve the last tweet ID for the username
let lconn = task_conn.lock().await; let lconn = task_conn.lock().await;
let last_tweet_id = let last_tweet_id = read_state(&lconn, &mastodon_config.twitter_screen_name, None)?
read_state(&lconn, &mastodon_config.twitter_screen_name, None)?.map(|r| r.tweet_id); .map(|r| r.tweet_id);
drop(lconn); drop(lconn);
// get user timeline feed (Vec<tweet>) // get reversed, curated user timeline
let mut feed = let feed = get_user_timeline(
get_user_timeline(&mastodon_config.twitter_screen_name, &token, last_tweet_id) &mastodon_config.twitter_screen_name,
&token,
last_tweet_id,
page_size,
)
.await?; .await?;
// empty feed -> exiting
if feed.is_empty() {
info!("Nothing to retrieve since last time, exiting…");
return Ok(());
}
// get Mastodon instance // get Mastodon instance
let mastodon = get_mastodon_token(&mastodon_config); let mastodon = get_mastodon_token(&mastodon_config);
// order needs to be chronological
feed.reverse();
for tweet in &feed { for tweet in &feed {
info!("Treating Tweet {} inside feed", tweet.id); info!("Treating Tweet {} inside feed", tweet.id);
// initiate the toot_reply_id var
let mut toot_reply_id: Option<String> = None;
// determine if the tweet is part of a thread (response to self) or a standard response
if let Some(r) = &tweet.in_reply_to_screen_name {
if r.to_lowercase() != mastodon_config.twitter_screen_name.to_lowercase() {
// we are responding not threading
info!("Tweet is a direct response, skipping");
continue;
}
info!("Tweet is a thread");
// get the corresponding toot id
let lconn = task_conn.lock().await; let lconn = task_conn.lock().await;
toot_reply_id = read_state( // initiate the toot_reply_id var and retrieve the corresponding toot_id
let toot_reply_id: Option<String> = tweet.in_reply_to_user_id.and_then(|_| {
read_state(
&lconn, &lconn,
&mastodon_config.twitter_screen_name, &mastodon_config.twitter_screen_name,
tweet.in_reply_to_status_id, tweet.in_reply_to_status_id,
) )
.unwrap_or(None) .unwrap_or(None)
.map(|s| s.toot_id); .map(|s| s.toot_id)
});
drop(lconn); drop(lconn);
};
// build basic status by just yielding text and dereferencing contained urls // build basic status by just yielding text and dereferencing contained urls
let mut status_text = build_basic_status(tweet); let mut status_text = build_basic_status(tweet, &scootaloo_mentions);
// building associative media list // building associative media list
let (media_url, status_medias) = let (media_url, status_medias) =
@@ -112,10 +122,18 @@ pub async fn run(config: Config) {
status_builder.status(&status_text).media_ids(status_medias); status_builder.status(&status_text).media_ids(status_medias);
// theard if necessary
if let Some(i) = toot_reply_id { if let Some(i) = toot_reply_id {
status_builder.in_reply_to(&i); status_builder.in_reply_to(&i);
} }
// language if any
if let Some(l) = &tweet.lang {
if let Some(r) = Language::from_639_1(l) {
status_builder.language(r);
}
}
// can be activated for test purposes // can be activated for test purposes
// status_builder.visibility(elefren::status_builder::Visibility::Private); // status_builder.visibility(elefren::status_builder::Visibility::Private);
@@ -137,15 +155,13 @@ pub async fn run(config: Config) {
drop(lconn); drop(lconn);
} }
Ok::<(), ScootalooError>(()) Ok::<(), ScootalooError>(())
}); })
})
// push each task into the vec task .buffer_unordered(config.scootaloo.rate_limit.unwrap_or(DEFAULT_RATE_LIMIT));
mtask.push(task);
}
// launch and wait for every handle // launch and wait for every handle
for handle in mtask { while let Some(result) = stream.next().await {
match handle.await { match result {
Ok(Err(e)) => eprintln!("Error within thread: {}", e), Ok(Err(e)) => eprintln!("Error within thread: {}", e),
Err(e) => eprintln!("Error with thread: {}", e), Err(e) => eprintln!("Error with thread: {}", e),
_ => (), _ => (),

View File

@@ -1,5 +1,5 @@
use clap::{App, Arg, SubCommand}; use clap::{Arg, Command};
use log::{error, LevelFilter}; use log::LevelFilter;
use scootaloo::*; use scootaloo::*;
use simple_logger::SimpleLogger; use simple_logger::SimpleLogger;
use std::str::FromStr; use std::str::FromStr;
@@ -7,115 +7,118 @@ use std::str::FromStr;
const DEFAULT_CONFIG_PATH: &str = "/usr/local/etc/scootaloo.toml"; const DEFAULT_CONFIG_PATH: &str = "/usr/local/etc/scootaloo.toml";
fn main() { fn main() {
let matches = App::new(env!("CARGO_PKG_NAME")) let matches = Command::new(env!("CARGO_PKG_NAME"))
.version(env!("CARGO_PKG_VERSION")) .version(env!("CARGO_PKG_VERSION"))
.about("A Twitter to Mastodon bot") .about("A Twitter to Mastodon bot")
.arg( .arg(
Arg::with_name("config") Arg::new("config")
.short("c") .short('c')
.long("config") .long("config")
.value_name("CONFIG_FILE") .value_name("CONFIG_FILE")
.help(&format!( .help("TOML config file for scootaloo")
"TOML config file for scootaloo (default {})", .num_args(1)
DEFAULT_CONFIG_PATH .default_value(DEFAULT_CONFIG_PATH)
))
.takes_value(true)
.display_order(1), .display_order(1),
) )
.arg( .arg(
Arg::with_name("log_level") Arg::new("log_level")
.short("l") .short('l')
.long("loglevel") .long("loglevel")
.value_name("LOGLEVEL") .value_name("LOGLEVEL")
.help("Log level.Valid values are: Off, Warn, Error, Info, Debug") .help("Log level")
.takes_value(true) .num_args(1)
.value_parser(["Off", "Warn", "Error", "Info", "Debug"])
.display_order(2), .display_order(2),
) )
.subcommand( .subcommand(
SubCommand::with_name("register") Command::new("register")
.version(env!("CARGO_PKG_VERSION")) .version(env!("CARGO_PKG_VERSION"))
.about("Command to register to a Mastodon Instance") .about("Command to register to a Mastodon Instance")
.arg( .arg(
Arg::with_name("host") Arg::new("host")
.short("H") .short('H')
.long("host") .long("host")
.value_name("HOST") .value_name("HOST")
.help("Base URL of the Mastodon instance to register to (no default)") .help("Base URL of the Mastodon instance to register to (no default)")
.takes_value(true) .num_args(1)
.required(true) .required(true)
.display_order(1) .display_order(1)
) )
.arg( .arg(
Arg::with_name("name") Arg::new("name")
.short("n") .short('n')
.long("name") .long("name")
.help("Twitter Screen Name (like https://twitter.com/screen_name, no default)") .help("Twitter Screen Name (like https://twitter.com/screen_name, no default)")
.takes_value(true) .num_args(1)
.required(true) .required(true)
.display_order(2) .display_order(2)
), ),
) )
.subcommand( .subcommand(
SubCommand::with_name("init") Command::new("init")
.version(env!("CARGO_PKG_VERSION")) .version(env!("CARGO_PKG_VERSION"))
.about("Command to init Scootaloo DB") .about("Command to init Scootaloo DB")
.arg( .arg(
Arg::with_name("config") Arg::new("config")
.short("c") .short('c')
.long("config") .long("config")
.value_name("CONFIG_FILE") .value_name("CONFIG_FILE")
.help(&format!( .help(&format!(
"TOML config file for scootaloo (default {})", "TOML config file for scootaloo (default {})",
DEFAULT_CONFIG_PATH DEFAULT_CONFIG_PATH
)) ))
.takes_value(true) .default_value(DEFAULT_CONFIG_PATH)
.num_args(1)
.display_order(1), .display_order(1),
), ),
) )
.subcommand( .subcommand(
SubCommand::with_name("migrate") Command::new("migrate")
.version(env!("CARGO_PKG_VERSION")) .version(env!("CARGO_PKG_VERSION"))
.about("Command to migrate Scootaloo DB") .about("Command to migrate Scootaloo DB")
.arg( .arg(
Arg::with_name("config") Arg::new("config")
.short("c") .short('c')
.long("config") .long("config")
.value_name("CONFIG_FILE") .value_name("CONFIG_FILE")
.help(&format!("TOML config file for scootaloo (default {})", DEFAULT_CONFIG_PATH)) .help(&format!("TOML config file for scootaloo (default {})", DEFAULT_CONFIG_PATH))
.takes_value(true) .default_value(DEFAULT_CONFIG_PATH)
.num_args(1)
.display_order(1), .display_order(1),
) )
.arg( .arg(
Arg::with_name("name") Arg::new("name")
.short("n") .short('n')
.long("name") .long("name")
.help("Twitter Screen Name (like https://twitter.com/screen_name, no default)") .help("Twitter Screen Name (like https://twitter.com/screen_name, no default)")
.takes_value(true) .num_args(1)
.display_order(2) .display_order(2)
) )
) )
.get_matches(); .get_matches();
match matches.subcommand() { match matches.subcommand() {
("register", Some(sub_m)) => { Some(("register", sub_m)) => {
register( register(
sub_m.value_of("host").unwrap(), sub_m.get_one::<String>("host").unwrap(),
sub_m.value_of("name").unwrap(), sub_m.get_one::<String>("name").unwrap(),
); );
return; return;
} }
("init", Some(sub_m)) => { Some(("init", sub_m)) => {
let config = parse_toml(sub_m.value_of("config").unwrap_or(DEFAULT_CONFIG_PATH)); let config = parse_toml(sub_m.get_one::<String>("config").unwrap());
init_db(&config.scootaloo.db_path).unwrap(); init_db(&config.scootaloo.db_path).unwrap();
return; return;
} }
("migrate", Some(sub_m)) => { Some(("migrate", sub_m)) => {
let config = parse_toml(sub_m.value_of("config").unwrap_or(DEFAULT_CONFIG_PATH)); let config = parse_toml(sub_m.get_one::<String>("config").unwrap());
let config_twitter_screen_name = let config_twitter_screen_name =
&config.mastodon.values().next().unwrap().twitter_screen_name; &config.mastodon.values().next().unwrap().twitter_screen_name;
migrate_db( migrate_db(
&config.scootaloo.db_path, &config.scootaloo.db_path,
sub_m.value_of("name").unwrap_or(config_twitter_screen_name), sub_m
.get_one::<String>("name")
.unwrap_or(config_twitter_screen_name),
) )
.unwrap(); .unwrap();
return; return;
@@ -123,20 +126,14 @@ fn main() {
_ => (), _ => (),
} }
if matches.is_present("log_level") { if let Some(level) = matches.get_one::<String>("log_level") {
match LevelFilter::from_str(matches.value_of("log_level").unwrap()) {
Ok(level) => SimpleLogger::new().with_level(level).init().unwrap(),
Err(e) => {
SimpleLogger::new() SimpleLogger::new()
.with_level(LevelFilter::Error) .with_level(LevelFilter::from_str(level).unwrap())
.init() .init()
.unwrap(); .unwrap();
error!("Unknown log level filter: {}", e);
}
};
} }
let config = parse_toml(matches.value_of("config").unwrap_or(DEFAULT_CONFIG_PATH)); let config = parse_toml(matches.get_one::<String>("config").unwrap());
run(config); run(config);
} }

View File

@@ -4,7 +4,7 @@ use egg_mode::{
entities::{MentionEntity, UrlEntity}, entities::{MentionEntity, UrlEntity},
tweet::Tweet, tweet::Tweet,
}; };
use elefren::{apps::App, prelude::*, scopes::Scopes}; use elefren::{apps::App, prelude::*, scopes::Read, scopes::Scopes, scopes::Write};
use html_escape::decode_html_entities; use html_escape::decode_html_entities;
use std::{borrow::Cow, collections::HashMap, io::stdin}; use std::{borrow::Cow, collections::HashMap, io::stdin};
@@ -48,14 +48,18 @@ pub fn get_mastodon_token(masto: &MastodonConfig) -> Mastodon {
} }
/// Builds toot text from tweet /// Builds toot text from tweet
pub fn build_basic_status(tweet: &Tweet) -> String { pub fn build_basic_status(tweet: &Tweet, mentions: &HashMap<String, String>) -> String {
let mut toot = tweet.text.to_owned(); let mut toot = tweet.text.to_owned();
for decoded_url in decode_urls(&tweet.entities.urls) { for decoded_url in decode_urls(&tweet.entities.urls) {
toot = toot.replace(&decoded_url.0, &decoded_url.1); toot = toot.replace(&decoded_url.0, &decoded_url.1);
} }
for decoded_mention in twitter_mentions(&tweet.entities.user_mentions) { for decoded_mention in twitter_mentions(&tweet.entities.user_mentions)
.into_iter()
.chain(mentions.to_owned())
.collect::<HashMap<String, String>>()
{
toot = toot.replace(&decoded_mention.0, &decoded_mention.1); toot = toot.replace(&decoded_mention.0, &decoded_mention.1);
} }
@@ -70,7 +74,12 @@ pub fn register(host: &str, screen_name: &str) {
builder builder
.client_name(Cow::from(env!("CARGO_PKG_NAME").to_string())) .client_name(Cow::from(env!("CARGO_PKG_NAME").to_string()))
.redirect_uris(Cow::from("urn:ietf:wg:oauth:2.0:oob".to_string())) .redirect_uris(Cow::from("urn:ietf:wg:oauth:2.0:oob".to_string()))
.scopes(Scopes::write_all()) .scopes(
Scopes::write(Write::Accounts)
.and(Scopes::write(Write::Media))
.and(Scopes::write(Write::Statuses))
.and(Scopes::read(Read::Accounts)),
)
.website(Cow::from( .website(Cow::from(
"https://framagit.org/veretcle/scootaloo".to_string(), "https://framagit.org/veretcle/scootaloo".to_string(),
)); ));
@@ -99,13 +108,19 @@ pub fn register(host: &str, screen_name: &str) {
let toml = toml::to_string(&*mastodon).unwrap(); let toml = toml::to_string(&*mastodon).unwrap();
let current_account = mastodon
.verify_credentials()
.expect("Unable to access account information!");
println!( println!(
"Please insert the following block at the end of your configuration file: "Please insert the following block at the end of your configuration file:
[mastodon.{}] [mastodon.{}]
twitter_screen_name = \"{}\" twitter_screen_name = \"{}\"
mastodon_screen_name = \"{}\"
{}", {}",
screen_name.to_lowercase(), screen_name.to_lowercase(),
screen_name, screen_name,
current_account.username,
toml toml
); );
} }
@@ -192,7 +207,13 @@ mod tests {
range: (80, 95), range: (80, 95),
name: "Nintendo France".to_string(), name: "Nintendo France".to_string(),
screen_name: "NintendoFrance".to_string(), screen_name: "NintendoFrance".to_string(),
} },
MentionEntity {
id: 999999999,
range: (80, 95),
name: "Willy Wonka".to_string(),
screen_name: "WillyWonka".to_string(),
},
], ],
media: None, media: None,
}, },
@@ -213,7 +234,7 @@ mod tests {
retweeted: None, retweeted: None,
retweeted_status: None, retweeted_status: None,
source: None, source: None,
text: "Mother 1 &amp; 2 sur le NES/SNES online !\nDispo maintenant. cc @NintendoFrance https://t.co/zXw0FfX2Nt".to_string(), text: "Mother 1 &amp; 2 sur le NES/SNES online !\nDispo maintenant. cc @NintendoFrance @WillyWonka https://t.co/zXw0FfX2Nt".to_string(),
truncated: false, truncated: false,
user: None, user: None,
withheld_copyright: false, withheld_copyright: false,
@@ -221,8 +242,13 @@ mod tests {
withheld_scope: None, withheld_scope: None,
}; };
let t_out = build_basic_status(&t); let s: HashMap<String, String> = HashMap::from([(
"@WillyWonka".to_string(),
"@WillyWonka@chocolatefactory.org".to_string(),
)]);
assert_eq!(&t_out, "Mother 1 & 2 sur le NES/SNES online !\nDispo maintenant. cc @NintendoFrance@twitter.com https://www.youtube.com/watch?v=w5TrSaoYmZ8"); let t_out = build_basic_status(&t, &s);
assert_eq!(&t_out, "Mother 1 & 2 sur le NES/SNES online !\nDispo maintenant. cc @NintendoFrance@twitter.com @WillyWonka@chocolatefactory.org https://www.youtube.com/watch?v=w5TrSaoYmZ8");
} }
} }

View File

@@ -27,19 +27,31 @@ pub fn get_oauth2_token(config: &TwitterConfig) -> Token {
} }
} }
/// Gets Twitter user timeline /// Gets Twitter user timeline, eliminate responses to others and reverse it
pub async fn get_user_timeline( pub async fn get_user_timeline(
screen_name: &str, screen_name: &str,
token: &Token, token: &Token,
lid: Option<u64>, lid: Option<u64>,
page_size: i32,
) -> Result<Vec<Tweet>, Box<dyn Error>> { ) -> Result<Vec<Tweet>, Box<dyn Error>> {
// fix the page size to 200 as it is the maximum Twitter authorizes // fix the page size to 200 as it is the maximum Twitter authorizes
let (_, feed) = user_timeline(UserID::from(screen_name.to_owned()), true, false, token) let (_, feed) = user_timeline(UserID::from(screen_name.to_owned()), true, false, token)
.with_page_size(200) .with_page_size(page_size)
.older(lid) .older(lid)
.await?; .await?;
Ok(feed.to_vec()) let mut feed: Vec<Tweet> = feed
.iter()
.cloned()
.filter(|t| match &t.in_reply_to_screen_name {
Some(r) => r.to_lowercase() == screen_name.to_lowercase(),
None => true,
})
.collect();
feed.reverse();
Ok(feed)
} }
/// Retrieves a single media from a tweet and store it in a temporary file /// Retrieves a single media from a tweet and store it in a temporary file

View File

@@ -15,6 +15,8 @@ use tokio::{
io::copy, io::copy,
}; };
use futures::{stream, stream::StreamExt};
/// Generate associative table between media ids and tweet extended entities /// Generate associative table between media ids and tweet extended entities
pub async fn generate_media_ids( pub async fn generate_media_ids(
tweet: &Tweet, tweet: &Tweet,
@@ -25,24 +27,20 @@ pub async fn generate_media_ids(
let mut media_ids: Vec<String> = vec![]; let mut media_ids: Vec<String> = vec![];
if let Some(m) = &tweet.extended_entities { if let Some(m) = &tweet.extended_entities {
// create tasks list
let mut tasks = vec![];
// size of media_ids vector, should be equal to the media vector
media_ids.resize(m.media.len(), String::new());
info!("{} medias in tweet", m.media.len()); info!("{} medias in tweet", m.media.len());
for (i, media) in m.media.iter().enumerate() { let medias = m.media.clone();
let mut stream = stream::iter(medias)
.map(|media| {
// attribute media url // attribute media url
media_url = media.url.clone(); media_url = media.url.clone();
// clone everything we need // clone everything we need
let cache_path = String::from(cache_path); let cache_path = String::from(cache_path);
let media = media.clone();
let mastodon = mastodon.clone(); let mastodon = mastodon.clone();
let task = tokio::task::spawn(async move { tokio::task::spawn(async move {
info!("Start treating {}", media.media_url_https); info!("Start treating {}", media.media_url_https);
// get the tweet embedded media // get the tweet embedded media
let local_tweet_media_path = get_tweet_media(&media, &cache_path).await?; let local_tweet_media_path = get_tweet_media(&media, &cache_path).await?;
@@ -54,16 +52,15 @@ pub async fn generate_media_ids(
// it doesnt matter if we cant remove, cache_media fn is idempotent // it doesnt matter if we cant remove, cache_media fn is idempotent
remove_file(&local_tweet_media_path).await.ok(); remove_file(&local_tweet_media_path).await.ok();
Ok::<(usize, String), ScootalooError>((i, mastodon_media.id)) Ok::<String, ScootalooError>(mastodon_media.id)
}); })
})
.buffered(4); // there are max four medias per tweet and they need to be treated in
// order
tasks.push(task); while let Some(result) = stream.next().await {
} match result {
Ok(Ok(v)) => media_ids.push(v),
for task in tasks {
match task.await {
// insert the media at the right place
Ok(Ok((i, v))) => media_ids[i] = v,
Ok(Err(e)) => warn!("Cannot treat media: {}", e), Ok(Err(e)) => warn!("Cannot treat media: {}", e),
Err(e) => error!("Something went wrong when joining the main thread: {}", e), Err(e) => error!("Something went wrong when joining the main thread: {}", e),
} }

View File

@@ -1,5 +1,80 @@
use scootaloo::parse_toml; use scootaloo::parse_toml;
#[test]
fn test_page_size() {
const DEFAULT_PAGE_SIZE: i32 = 200;
let toml = parse_toml("tests/page_size.toml");
assert_eq!(toml.twitter.page_size, Some(100));
assert_eq!(toml.mastodon.get("0").unwrap().twitter_page_size, None);
assert_eq!(toml.mastodon.get("1").unwrap().twitter_page_size, Some(42));
// this is the exact line that is used inside fn run() to determine the twitter page size
// passed to fn get_user_timeline()
let page_size_for_0 = toml
.mastodon
.get("0")
.unwrap()
.twitter_page_size
.unwrap_or_else(|| toml.twitter.page_size.unwrap_or(DEFAULT_PAGE_SIZE));
let page_size_for_1 = toml
.mastodon
.get("1")
.unwrap()
.twitter_page_size
.unwrap_or_else(|| toml.twitter.page_size.unwrap_or(DEFAULT_PAGE_SIZE));
assert_eq!(page_size_for_0, 100);
assert_eq!(page_size_for_1, 42);
let toml = parse_toml("tests/no_page_size.toml");
assert_eq!(toml.twitter.page_size, None);
assert_eq!(toml.mastodon.get("0").unwrap().twitter_page_size, None);
// and same here
let page_size_for_0 = toml
.mastodon
.get("0")
.unwrap()
.twitter_page_size
.unwrap_or_else(|| toml.twitter.page_size.unwrap_or(DEFAULT_PAGE_SIZE));
assert_eq!(page_size_for_0, 200);
}
#[test]
fn test_parse_good_toml_rate_limit() {
let parse_good_toml = parse_toml("tests/good_test_rate_limit.toml");
assert_eq!(parse_good_toml.scootaloo.rate_limit, Some(69 as usize));
}
#[test]
fn test_parse_good_toml_mastodon_screen_name() {
let parse_good_toml = parse_toml("tests/good_test_mastodon_screen_name.toml");
assert_eq!(
parse_good_toml
.mastodon
.get("0")
.unwrap()
.mastodon_screen_name,
Some("tarace".to_string())
);
assert_eq!(
parse_good_toml
.mastodon
.get("1")
.unwrap()
.mastodon_screen_name,
None
);
}
#[test] #[test]
fn test_parse_good_toml() { fn test_parse_good_toml() {
let parse_good_toml = parse_toml("tests/good_test.toml"); let parse_good_toml = parse_toml("tests/good_test.toml");
@@ -9,6 +84,7 @@ fn test_parse_good_toml() {
"/var/random/scootaloo.sqlite" "/var/random/scootaloo.sqlite"
); );
assert_eq!(parse_good_toml.scootaloo.cache_path, "/tmp/scootaloo"); assert_eq!(parse_good_toml.scootaloo.cache_path, "/tmp/scootaloo");
assert_eq!(parse_good_toml.scootaloo.rate_limit, None);
assert_eq!(parse_good_toml.twitter.consumer_key, "rand consumer key"); assert_eq!(parse_good_toml.twitter.consumer_key, "rand consumer key");
assert_eq!(parse_good_toml.twitter.consumer_secret, "secret"); assert_eq!(parse_good_toml.twitter.consumer_secret, "secret");

View File

@@ -0,0 +1,28 @@
[scootaloo]
db_path="/var/random/scootaloo.sqlite"
cache_path="/tmp/scootaloo"
[twitter]
consumer_key="rand consumer key"
consumer_secret="secret"
access_key="rand access key"
access_secret="super secret"
[mastodon]
[mastodon.0]
twitter_screen_name="tamerelol"
mastodon_screen_name="tarace"
base = "https://m.nintendojo.fr"
client_id = "rand client id"
client_secret = "secret"
redirect = "urn:ietf:wg:oauth:2.0:oob"
token = "super secret"
[mastodon.1]
twitter_screen_name="tamerelol"
base = "https://m.nintendojo.fr"
client_id = "rand client id"
client_secret = "secret"
redirect = "urn:ietf:wg:oauth:2.0:oob"
token = "super secret"

View File

@@ -0,0 +1,20 @@
[scootaloo]
db_path="/var/random/scootaloo.sqlite"
cache_path="/tmp/scootaloo"
rate_limit=69
[twitter]
consumer_key="rand consumer key"
consumer_secret="secret"
access_key="rand access key"
access_secret="super secret"
[mastodon]
[mastodon.tamerelol]
twitter_screen_name="tamerelol"
base = "https://m.nintendojo.fr"
client_id = "rand client id"
client_secret = "secret"
redirect = "urn:ietf:wg:oauth:2.0:oob"
token = "super secret"

19
tests/no_page_size.toml Normal file
View File

@@ -0,0 +1,19 @@
[scootaloo]
db_path="/var/random/scootaloo.sqlite"
cache_path="/tmp/scootaloo"
[twitter]
consumer_key="rand consumer key"
consumer_secret="secret"
access_key="rand access key"
access_secret="super secret"
[mastodon]
[mastodon.0]
twitter_screen_name="tamerelol"
base = "https://m.nintendojo.fr"
client_id = "rand client id"
client_secret = "secret"
redirect = "urn:ietf:wg:oauth:2.0:oob"
token = "super secret"

29
tests/page_size.toml Normal file
View File

@@ -0,0 +1,29 @@
[scootaloo]
db_path="/var/random/scootaloo.sqlite"
cache_path="/tmp/scootaloo"
[twitter]
consumer_key="rand consumer key"
consumer_secret="secret"
access_key="rand access key"
access_secret="super secret"
page_size=100
[mastodon]
[mastodon.0]
twitter_screen_name="tamerelol"
base = "https://m.nintendojo.fr"
client_id = "rand client id"
client_secret = "secret"
redirect = "urn:ietf:wg:oauth:2.0:oob"
token = "super secret"
[mastodon.1]
twitter_screen_name="tonperemdr"
twitter_page_size=42
base = "https://m.nintendojo.fr"
client_id = "rand client id"
client_secret = "secret"
redirect = "urn:ietf:wg:oauth:2.0:oob"
token = "super secret"