65 Commits

Author SHA1 Message Date
VC
63830be0d5 Merge branch '9-refactor-text-status-building' into 'master'
Refactor text status building

Closes #9

See merge request veretcle/scootaloo!44
2022-11-24 22:14:55 +00:00
VC
5633bf9187 refactor: twitter threading no longer on top 2022-11-24 23:10:30 +01:00
VC
f42aa8cbb6 refactor: build status text more progressively 2022-11-24 15:41:50 +01:00
VC
1132f41b9e chore: bump version 2022-11-24 15:25:17 +01:00
VC
70f8c14e99 doc: regexp + alt services 2022-11-24 08:00:46 +01:00
VC
faab50d1ea feat: main logic for regex + url filtering 2022-11-24 08:00:45 +01:00
VC
9cafa2bf07 test: add tests for scootaloo alt services + regexp 2022-11-24 08:00:43 +01:00
VC
9227850c99 feat: add necessary changes to decode_urls fn 2022-11-23 13:09:00 +01:00
VC
64d72ea69d chore: bump version + add regex 2022-11-23 09:00:44 +01:00
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
VC
ffbe98f838 Merge branch 'generate_media_flow' into 'master'
Better media flow

See merge request veretcle/scootaloo!26
2022-11-14 13:41:07 +00:00
VC
822f4044c6 chore: bump version 2022-11-14 14:33:42 +01:00
VC
78924f6eeb refactor: simpler error bubbling inside async block 2022-11-14 14:33:39 +01:00
VC
9c14636735 refactor: avoid Box::new syntax, prefer into() 2022-11-14 14:25:08 +01:00
VC
01bac63fb9 Merge branch 'reply_improvements' into 'master'
refactor: improve reply/thread management

See merge request veretcle/scootaloo!25
2022-11-09 20:26:20 +00:00
VC
4f5663b450 feature: better error implementation for ScootalooError inside async block 2022-11-09 19:36:00 +01:00
VC
9a9c4b4809 chore: cargo update 2022-11-09 18:33:04 +01:00
VC
9970968b47 refactor: avoid panicking into thread, bubble up errors to main thread to be handled 2022-11-09 18:23:06 +01:00
VC
291c86677e refactor: get mastodon token after ensuring feed is not empty 2022-11-09 08:40:04 +01:00
VC
31afb1cf7d Merge branch 'async_media_upload' into 'master'
Async media upload

See merge request veretcle/scootaloo!24
2022-11-08 13:35:06 +00:00
VC
4415c4ac12 refactor: better logic flow for uploading/deleting media 2022-11-08 10:54:42 +01:00
VC
89f1372f9f bump: version v0.8.0 2022-11-08 08:54:36 +01:00
VC
06904434c8 fix: indentation error when registering 2022-11-08 08:54:36 +01:00
VC
3c64df23bc refactor: add info/debug 2022-11-08 08:54:32 +01:00
VC
c62f67c3b3 refactor: simpler mtask var 2022-11-08 08:37:26 +01:00
VC
3b0e7234af refactor: downloads/uploads every media from a tweet async way 2022-11-08 08:37:17 +01:00
VC
62011b4b81 refactor: downloads/uploads every media from a tweet async way 2022-11-07 21:47:12 +01:00
VC
5ce3bde3e7 fix: remove unecessary \n in TOML conf 2022-11-07 18:25:55 +01:00
VC
ab4184c0ed Merge branch 'async_multi_account' into 'master'
feat: attempt for async treatment of all accounts

See merge request veretcle/scootaloo!23
2022-11-05 09:36:55 +00:00
VC
de758c7bda refactor: separate function for media ids 2022-11-05 10:23:21 +01:00
VC
df75520175 feat: async treatment of all accounts 2022-11-04 15:26:27 +01:00
20 changed files with 1552 additions and 842 deletions

1238
Cargo.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,20 +1,20 @@
[package] [package]
name = "scootaloo" name = "scootaloo"
version = "0.7.0" version = "0.11.1"
authors = ["VC <veretcle+framagit@mateu.be>"] authors = ["VC <veretcle+framagit@mateu.be>"]
edition = "2021" edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
chrono = "^0.4" regex = "^1"
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,24 @@ 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
## optional, this should be omitted the majority of the time
## sometimes, twitter try to use french inclusive writting, but instead of using `·` (median point), theyre using `.`
## this makes twitter interpret it as a URL, which is wrong
## this parameter allows you to catch such URLs and apply the `display_url` (i.e. `tout.es`) instead of the `expanded_url` (i.e. `http://tout.es`)
## in those particular cases
## (!) use with caution, it might have some undesired effects
show_url_as_display_url_for = "^http(s)://(.+)\\.es$"
## optional, this allows you to replace the host for popular services such as YouTube of Twitter, or any other
## with their more freely accessible equivalent
[scootaloo.alternative_services_for]
"tamere.lol" = "tonpere.mdr" ## quotes are necessary for both parameters
"you.pi" = "you.pla"
"www.you.pi" = "you.pla" ## this is an exact match, so youll need to lay out all the possibilities
[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"
@@ -45,7 +60,8 @@ 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 +71,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, Clone)]
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,9 @@ 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>,
pub show_url_as_display_url_for: Option<String>,
pub alternative_services_for: Option<HashMap<String, String>>,
} }
/// Parses the TOML file into a Config Struct /// Parses the TOML file into a Config Struct

View File

@@ -1,8 +1,12 @@
use std::{ use std::{
boxed::Box,
convert::From,
error::Error, error::Error,
fmt::{Display, Formatter, Result}, fmt::{Display, Formatter, Result},
}; };
use elefren::Error as elefrenError;
#[derive(Debug)] #[derive(Debug)]
pub struct ScootalooError { pub struct ScootalooError {
details: String, details: String,
@@ -23,3 +27,15 @@ impl Display for ScootalooError {
write!(f, "{}", self.details) write!(f, "{}", self.details)
} }
} }
impl From<Box<dyn Error>> for ScootalooError {
fn from(error: Box<dyn Error>) -> Self {
ScootalooError::new(&format!("Error in a subset crate: {}", error))
}
}
impl From<elefrenError> for ScootalooError {
fn from(error: elefrenError) -> Self {
ScootalooError::new(&format!("Error in elefren crate: {}", error))
}
}

View File

@@ -7,158 +7,185 @@ use config::Config;
mod mastodon; mod mastodon;
pub use mastodon::register; pub use mastodon::register;
use mastodon::{build_basic_status, get_mastodon_token}; use mastodon::*;
mod twitter; mod twitter;
use twitter::*; use twitter::*;
mod util; mod util;
use crate::util::generate_media_ids;
mod state; 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 log::{debug, error, info, warn}; use futures::StreamExt;
use html_escape::decode_html_entities;
use log::info;
use regex::Regex;
use rusqlite::Connection; use rusqlite::Connection;
use std::borrow::Cow; use std::sync::Arc;
use tokio::fs::remove_file; 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) {
// get OAuth2 token // open the SQLite connection
let token = get_oauth2_token(&config.twitter); let conn = Arc::new(Mutex::new(
Connection::open(&config.scootaloo.db_path).unwrap_or_else(|e| {
for mastodon_config in config.mastodon.values() {
// open the SQLite connection
let conn = Connection::open(&config.scootaloo.db_path).unwrap_or_else(|e| {
panic!( panic!(
"Something went wrong when opening the DB {}: {}", "Something went wrong when opening the DB {}: {}",
&config.scootaloo.db_path, e &config.scootaloo.db_path, e
) )
}); }),
// retrieve the last tweet ID for the username ));
let last_tweet_id = read_state(&conn, &mastodon_config.twitter_screen_name, None)
.unwrap_or_else(|e| panic!("Cannot retrieve last_tweet_id: {}", e))
.map(|s| s.tweet_id);
// get Mastodon instance let global_mastodon_config = Arc::new(Mutex::new(config.mastodon.clone()));
let mastodon = get_mastodon_token(mastodon_config);
// get user timeline feed (Vec<tweet>) let display_url_re = config
let mut feed = get_user_timeline(mastodon_config, &token, last_tweet_id) .scootaloo
.await .show_url_as_display_url_for
.unwrap_or_else(|e| { .as_ref()
panic!( .map(|r|
"Something went wrong when trying to retrieve {}s timeline: {}", // we want to panic in case the RE is not valid
&mastodon_config.twitter_screen_name, e Regex::new(r).unwrap());
)
});
// empty feed -> exiting let mut stream = futures::stream::iter(config.mastodon.into_values())
if feed.is_empty() { .map(|mastodon_config| {
info!("Nothing to retrieve since last time, exiting…"); // calculate Twitter page size
return; let page_size = mastodon_config
} .twitter_page_size
.unwrap_or_else(|| config.twitter.page_size.unwrap_or(DEFAULT_PAGE_SIZE));
// order needs to be chronological // create temporary value for each task
feed.reverse(); let scootaloo_cache_path = config.scootaloo.cache_path.clone();
let scootaloo_alt_services = config.scootaloo.alternative_services_for.clone();
let display_url_re = display_url_re.clone();
let token = get_oauth2_token(&config.twitter);
let task_conn = conn.clone();
let global_mastodon_config = global_mastodon_config.clone();
for tweet in &feed { spawn(async move {
debug!("Treating Tweet {} inside feed", tweet.id); info!("Starting treating {}", &mastodon_config.twitter_screen_name);
// initiate the toot_reply_id var // retrieve the last tweet ID for the username
let mut toot_reply_id: Option<String> = None; let lconn = task_conn.lock().await;
// determine if the tweet is part of a thread (response to self) or a standard response let last_tweet_id = read_state(&lconn, &mastodon_config.twitter_screen_name, None)?
if let Some(r) = &tweet.in_reply_to_screen_name { .map(|r| r.tweet_id);
if r.to_lowercase() != mastodon_config.twitter_screen_name.to_lowercase() { drop(lconn);
// we are responding not threadin
info!("Tweet is a direct response, skipping"); // get reversed, curated user timeline
continue; let feed = get_user_timeline(
}
info!("Tweet is a thread");
toot_reply_id = read_state(
&conn,
&mastodon_config.twitter_screen_name, &mastodon_config.twitter_screen_name,
tweet.in_reply_to_status_id, &token,
last_tweet_id,
page_size,
) )
.unwrap_or(None) .await?;
.map(|s| s.toot_id);
};
// build basic status by just yielding text and dereferencing contained urls // get Mastodon instance
let mut status_text = build_basic_status(tweet); let mastodon = get_mastodon_token(&mastodon_config);
let mut status_medias: Vec<String> = vec![]; for tweet in &feed {
// reupload the attachments if any info!("Treating Tweet {} inside feed", tweet.id);
if let Some(m) = &tweet.extended_entities {
for media in &m.media {
let local_tweet_media_path =
match get_tweet_media(media, &config.scootaloo.cache_path).await {
Ok(m) => m,
Err(e) => {
error!("Cannot get tweet media for {}: {}", &media.url, e);
continue;
}
};
let mastodon_media_ids = match mastodon // basic toot text
.media(Cow::from(local_tweet_media_path.to_owned())) let mut status_text = tweet.text.clone();
{
Ok(m) => { // add mentions and smart mentions
remove_file(&local_tweet_media_path) if !&tweet.entities.user_mentions.is_empty() {
.await info!("Tweet contains mentions, add them!");
.unwrap_or_else(|e| let global_mastodon_config = global_mastodon_config.lock().await;
warn!("Attachment for {} has been uploaded, but Im unable to remove the existing file: {}", &local_tweet_media_path, e) twitter_mentions(
); &mut status_text,
m.id &tweet.entities.user_mentions,
&global_mastodon_config,
);
drop(global_mastodon_config);
}
if !&tweet.entities.urls.is_empty() {
info!("Tweet contains links, add them!");
let mut associated_urls =
associate_urls(&tweet.entities.urls, &display_url_re);
if let Some(a) = &scootaloo_alt_services {
replace_alt_services(&mut associated_urls, a);
} }
Err(e) => {
error!( decode_urls(&mut status_text, &associated_urls);
"Attachment {} cannot be uploaded to Mastodon Instance: {}", }
&local_tweet_media_path, e
); // building associative media list
continue; let (media_url, status_medias) =
generate_media_ids(tweet, &scootaloo_cache_path, &mastodon).await;
status_text = status_text.replace(&media_url, "");
// now that the text wont be altered anymore, we can safely remove HTML
// entities
status_text = decode_html_entities(&status_text).to_string();
info!("Building corresponding Mastodon status");
let mut status_builder = StatusBuilder::new();
status_builder.status(status_text).media_ids(status_medias);
// thread if necessary
if tweet.in_reply_to_user_id.is_some() {
let lconn = task_conn.lock().await;
if let Ok(Some(r)) = read_state(
&lconn,
&mastodon_config.twitter_screen_name,
tweet.in_reply_to_status_id,
) {
status_builder.in_reply_to(&r.toot_id);
} }
drop(lconn);
}
// 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
// status_builder.visibility(elefren::status_builder::Visibility::Private);
let status = status_builder.build()?;
let published_status = mastodon.new_status(status)?;
// this will return if it cannot publish the status preventing the last_tweet from
// being written into db
let ttt_towrite = TweetToToot {
twitter_screen_name: mastodon_config.twitter_screen_name.clone(),
tweet_id: tweet.id,
toot_id: published_status.id,
}; };
status_medias.push(mastodon_media_ids); // write the current state (tweet ID and toot ID) to avoid copying it another time
let lconn = task_conn.lock().await;
// last step, removing the reference to the media from with the toots text write_state(&lconn, ttt_towrite)?;
status_text = status_text.replace(&media.url, ""); drop(lconn);
} }
} Ok::<(), ScootalooError>(())
// finished reuploading attachments, now lets do the toot baby! })
})
.buffer_unordered(config.scootaloo.rate_limit.unwrap_or(DEFAULT_RATE_LIMIT));
debug!("Building corresponding Mastodon status"); // launch and wait for every handle
while let Some(result) = stream.next().await {
let mut status_builder = StatusBuilder::new(); match result {
Ok(Err(e)) => eprintln!("Error within thread: {}", e),
status_builder.status(&status_text).media_ids(status_medias); Err(e) => eprintln!("Error with thread: {}", e),
_ => (),
if let Some(i) = toot_reply_id {
status_builder.in_reply_to(&i);
}
let status = status_builder
.build()
.unwrap_or_else(|_| panic!("Cannot build status with text {}", &status_text));
// publish status
// again unwrap is safe here as we are in the main thread
let published_status = mastodon.new_status(status).unwrap();
// this will panic if it cannot publish the status, which is a good thing, it allows the
// last_tweet gathered not to be written
let ttt_towrite = TweetToToot {
twitter_screen_name: mastodon_config.twitter_screen_name.clone(),
tweet_id: tweet.id,
toot_id: published_status.id,
};
// write the current state (tweet ID and toot ID) to avoid copying it another time
write_state(&conn, ttt_towrite)
.unwrap_or_else(|e| panic!("Cant write the last tweet retrieved: {}", 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()) { SimpleLogger::new()
Ok(level) => SimpleLogger::new().with_level(level).init().unwrap(), .with_level(LevelFilter::from_str(level).unwrap())
Err(e) => { .init()
SimpleLogger::new() .unwrap();
.with_level(LevelFilter::Error)
.init()
.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

@@ -1,37 +1,84 @@
use crate::config::MastodonConfig; use crate::config::MastodonConfig;
use egg_mode::{ use egg_mode::entities::{MentionEntity, UrlEntity};
entities::{MentionEntity, UrlEntity}, use elefren::{apps::App, prelude::*, scopes::Read, scopes::Scopes, scopes::Write};
tweet::Tweet, use regex::Regex;
};
use elefren::{apps::App, prelude::*, scopes::Scopes};
use html_escape::decode_html_entities;
use std::{borrow::Cow, collections::HashMap, io::stdin}; use std::{borrow::Cow, collections::HashMap, io::stdin};
/// Decodes the Twitter mention to something that will make sense once Twitter has joined the /// Decodes the Twitter mention to something that will make sense once Twitter has joined the
/// Fediverse /// Fediverse. Users in the global user list of Scootaloo are rewritten, as they are Mastodon users
fn twitter_mentions(ums: &[MentionEntity]) -> HashMap<String, String> { /// as well
ums.iter() pub fn twitter_mentions(
toot: &mut String,
ums: &[MentionEntity],
masto: &HashMap<String, MastodonConfig>,
) {
let tm: HashMap<String, String> = ums
.iter()
.map(|s| { .map(|s| {
( (
format!("@{}", s.screen_name), format!("@{}", s.screen_name),
format!("@{}@twitter.com", s.screen_name), format!("@{}@twitter.com", s.screen_name),
) )
}) })
.collect() .chain(
masto
.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::<HashMap<String, String>>(),
)
.collect();
for (k, v) in tm {
*toot = toot.replace(&k, &v);
}
} }
/// Decodes urls from UrlEntities /// Decodes urls in toot
fn decode_urls(urls: &[UrlEntity]) -> HashMap<String, String> { pub fn decode_urls(toot: &mut String, urls: &HashMap<String, String>) {
for (k, v) in urls {
*toot = toot.replace(k, v);
}
}
/// Reassociates source url with destination url for rewritting
/// this takes a Teet UrlEntity and an optional Regex
pub fn associate_urls(urls: &[UrlEntity], re: &Option<Regex>) -> HashMap<String, String> {
urls.iter() urls.iter()
.filter(|s| s.expanded_url.is_some()) .filter(|s| s.expanded_url.is_some())
.map(|s| { .map(|s| {
( (s.url.to_owned(), {
s.url.to_owned(), let mut def = s.expanded_url.as_deref().unwrap().to_owned();
s.expanded_url.as_deref().unwrap().to_owned(),
) if let Some(r) = re {
if r.is_match(s.expanded_url.as_deref().unwrap()) {
def = s.display_url.to_owned();
}
}
def
})
}) })
.collect() .collect::<HashMap<String, String>>()
}
/// Replaces the commonly used services by mirrors, if asked to
pub fn replace_alt_services(urls: &mut HashMap<String, String>, alts: &HashMap<String, String>) {
for val in urls.values_mut() {
for (k, v) in alts {
*val = val.replace(&format!("/{}/", k), &format!("/{}/", v));
}
}
} }
/// Gets Mastodon Data /// Gets Mastodon Data
@@ -47,21 +94,6 @@ pub fn get_mastodon_token(masto: &MastodonConfig) -> Mastodon {
Mastodon::from(data) Mastodon::from(data)
} }
/// Builds toot text from tweet
pub fn build_basic_status(tweet: &Tweet) -> String {
let mut toot = tweet.text.to_owned();
for decoded_url in decode_urls(&tweet.entities.urls) {
toot = toot.replace(&decoded_url.0, &decoded_url.1);
}
for decoded_mention in twitter_mentions(&tweet.entities.user_mentions) {
toot = toot.replace(&decoded_mention.0, &decoded_mention.1);
}
decode_html_entities(&toot).to_string()
}
/// Generic register function /// Generic register function
/// As this function is supposed to be run only once, it will panic for every error it encounters /// As this function is supposed to be run only once, it will panic for every error it encounters
/// Most of this function is a direct copy/paste of the official `elefren` crate /// Most of this function is a direct copy/paste of the official `elefren` crate
@@ -70,7 +102,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 +136,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:
\n[mastodon.{}] [mastodon.{}]
\ntwitter_screen_name = \"{}\" twitter_screen_name = \"{}\"
\n{}", mastodon_screen_name = \"{}\"
{}",
screen_name.to_lowercase(), screen_name.to_lowercase(),
screen_name, screen_name,
current_account.username,
toml toml
); );
} }
@@ -114,115 +157,167 @@ pub fn register(host: &str, screen_name: &str) {
mod tests { mod tests {
use super::*; use super::*;
use chrono::prelude::*;
use egg_mode::tweet::TweetEntities;
#[test] #[test]
fn test_twitter_mentions() { fn test_twitter_mentions() {
let mention_entity = MentionEntity { let mention_entities = vec![
id: 12345, MentionEntity {
range: (1, 3), id: 12345,
name: "Ta Mere l0l".to_string(), range: (1, 3),
screen_name: "tamerelol".to_string(), name: "Ta Mere l0l".to_string(),
}; screen_name: "tamerelol".to_string(),
},
MentionEntity {
id: 6789,
range: (1, 3),
name: "TONPERE".to_string(),
screen_name: "tonpere".to_string(),
},
];
let twitter_ums = vec![mention_entity]; let mut toot = ":kikoo: @tamerelol @tonpere !".to_string();
let mut expected_mentions = HashMap::new(); let scootaloo_config = HashMap::from([(
expected_mentions.insert( "test".to_string(),
"@tamerelol".to_string(), (MastodonConfig {
"@tamerelol@twitter.com".to_string(), twitter_screen_name: "tonpere".to_string(),
); mastodon_screen_name: Some("lalali".to_string()),
twitter_page_size: None,
base: "https://mstdn.net".to_string(),
client_id: "".to_string(),
client_secret: "".to_string(),
redirect: "".to_string(),
token: "".to_string(),
}),
)]);
let decoded_mentions = twitter_mentions(&twitter_ums); twitter_mentions(&mut toot, &mention_entities, &scootaloo_config);
assert_eq!(expected_mentions, decoded_mentions); assert_eq!(&toot, ":kikoo: @tamerelol@twitter.com @lalali@mstdn.net !");
} }
#[test] #[test]
fn test_decode_urls() { fn test_decode_urls() {
let url_entity1 = UrlEntity { let urls = HashMap::from([
display_url: "tamerelol".to_string(), (
expanded_url: Some("https://www.nintendojo.fr/dojobar".to_string()), "https://t.co/thisisatest".to_string(),
range: (1, 3), "https://www.nintendojo.fr/dojobar".to_string(),
url: "https://t.me/tamerelol".to_string(), ),
}; (
"https://t.co/nopenotinclusive".to_string(),
"invité.es".to_string(),
),
]);
let url_entity2 = UrlEntity { let mut toot =
display_url: "tamerelol".to_string(), "Rendez-vous sur https://t.co/thisisatest avec nos https://t.co/nopenotinclusive !"
expanded_url: None, .to_string();
range: (1, 3),
url: "https://t.me/tamerelol".to_string(),
};
let twitter_urls = vec![url_entity1, url_entity2]; decode_urls(&mut toot, &urls);
let mut expected_urls = HashMap::new(); assert_eq!(
expected_urls.insert( &toot,
"https://t.me/tamerelol".to_string(), "Rendez-vous sur https://www.nintendojo.fr/dojobar avec nos invité.es !"
"https://www.nintendojo.fr/dojobar".to_string(),
); );
let decoded_urls = decode_urls(&twitter_urls);
assert_eq!(expected_urls, decoded_urls);
} }
#[test] #[test]
fn test_build_basic_status() { fn test_associate_urls() {
let t = Tweet { let urls = vec![
coordinates: None, UrlEntity {
created_at: Utc::now(), display_url: "tamerelol".to_string(),
current_user_retweet: None, expanded_url: Some("https://www.nintendojo.fr/dojobar".to_string()),
display_text_range: None, range: (1, 3),
entities: TweetEntities { url: "https://t.me/tamerelol".to_string(),
hashtags: vec![],
symbols: vec![],
urls: vec![
UrlEntity {
display_url: "youtube.com/watch?v=w5TrSa…".to_string(),
expanded_url: Some("https://www.youtube.com/watch?v=w5TrSaoYmZ8".to_string()),
range: (93, 116),
url: "https://t.co/zXw0FfX2Nt".to_string(),
}
],
user_mentions: vec![
MentionEntity {
id: 491500016,
range: (80, 95),
name: "Nintendo France".to_string(),
screen_name: "NintendoFrance".to_string(),
}
],
media: None,
}, },
extended_entities: None, UrlEntity {
favorite_count: 0, display_url: "sadcat".to_string(),
favorited: None, expanded_url: None,
filter_level: None, range: (1, 3),
id: 1491541246984306693, url: "https://t.me/sadcat".to_string(),
in_reply_to_user_id: None, },
in_reply_to_screen_name: None, UrlEntity {
in_reply_to_status_id: None, display_url: "invité.es".to_string(),
lang: None, expanded_url: Some("http://xn--invit-fsa.es".to_string()),
place: None, range: (85, 108),
possibly_sensitive: None, url: "https://t.co/WAUgnpHLmo".to_string(),
quoted_status: None, },
quoted_status_id: None, ];
retweet_count: 0,
retweeted: None,
retweeted_status: None,
source: None,
text: "Mother 1 &amp; 2 sur le NES/SNES online !\nDispo maintenant. cc @NintendoFrance https://t.co/zXw0FfX2Nt".to_string(),
truncated: false,
user: None,
withheld_copyright: false,
withheld_in_countries: None,
withheld_scope: None,
};
let t_out = build_basic_status(&t); let expected_urls = HashMap::from([
(
"https://t.me/tamerelol".to_string(),
"https://www.nintendojo.fr/dojobar".to_string(),
),
(
"https://t.co/WAUgnpHLmo".to_string(),
"invité.es".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 re = Regex::new("(.+)\\.es$").ok();
let associated_urls = associate_urls(&urls, &re);
assert_eq!(associated_urls, expected_urls);
}
#[test]
fn test_replace_alt_services() {
let mut associated_urls = HashMap::from([
(
"https://t.co/youplaboom".to_string(),
"https://www.youtube.com/watch?v=dQw4w9WgXcQ".to_string(),
),
(
"https://t.co/thisisfine".to_string(),
"https://twitter.com/Nintendo/status/1594590628771688448".to_string(),
),
(
"https://t.co/nopenope".to_string(),
"https://www.nintendojo.fr/dojobar".to_string(),
),
(
"https://t.co/broken".to_string(),
"http://youtu.be".to_string(),
),
(
"https://t.co/alsobroken".to_string(),
"https://youtube.com".to_string(),
),
]);
let alt_services = HashMap::from([
("twitter.com".to_string(), "nitter.net".to_string()),
("youtu.be".to_string(), "invidio.us".to_string()),
("www.youtube.com".to_string(), "invidio.us".to_string()),
("youtube.com".to_string(), "invidio.us".to_string()),
]);
let expected_urls = HashMap::from([
(
"https://t.co/youplaboom".to_string(),
"https://invidio.us/watch?v=dQw4w9WgXcQ".to_string(),
),
(
"https://t.co/thisisfine".to_string(),
"https://nitter.net/Nintendo/status/1594590628771688448".to_string(),
),
(
"https://t.co/nopenope".to_string(),
"https://www.nintendojo.fr/dojobar".to_string(),
),
(
"https://t.co/broken".to_string(),
"http://youtu.be".to_string(),
),
(
"https://t.co/alsobroken".to_string(),
"https://youtube.com".to_string(),
),
]);
replace_alt_services(&mut associated_urls, &alt_services);
assert_eq!(associated_urls, expected_urls);
} }
} }

View File

@@ -87,7 +87,7 @@ pub fn migrate_db(d: &str, s: &str) -> Result<(), Box<dyn Error>> {
match res { match res {
Err(e) => match e.to_string().as_str() { Err(e) => match e.to_string().as_str() {
"duplicate column name: twitter_screen_name" => Ok(()), "duplicate column name: twitter_screen_name" => Ok(()),
_ => Err(Box::new(e)), _ => Err(e.into()),
}, },
_ => Ok(()), _ => Ok(()),
} }

View File

@@ -1,4 +1,3 @@
use crate::config::MastodonConfig;
use crate::config::TwitterConfig; use crate::config::TwitterConfig;
use crate::util::cache_media; use crate::util::cache_media;
use crate::ScootalooError; use crate::ScootalooError;
@@ -28,24 +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(
config: &MastodonConfig, 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( let (_, feed) = user_timeline(UserID::from(screen_name.to_owned()), true, false, token)
UserID::from(config.twitter_screen_name.to_owned()), .with_page_size(page_size)
true, .older(lid)
false, .await?;
token,
)
.with_page_size(200)
.older(lid)
.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

@@ -1,11 +1,80 @@
use crate::ScootalooError; use crate::{twitter::get_tweet_media, ScootalooError};
use std::{borrow::Cow, error::Error};
use egg_mode::tweet::Tweet;
use elefren::prelude::*;
use log::{error, info, warn};
use reqwest::Url; use reqwest::Url;
use std::error::Error;
use tokio::{ use tokio::{
fs::{create_dir_all, File}, fs::{create_dir_all, remove_file, File},
io::copy, io::copy,
}; };
use futures::{stream, stream::StreamExt};
/// Generate associative table between media ids and tweet extended entities
pub async fn generate_media_ids(
tweet: &Tweet,
cache_path: &str,
mastodon: &Mastodon,
) -> (String, Vec<String>) {
let mut media_url = "".to_string();
let mut media_ids: Vec<String> = vec![];
if let Some(m) = &tweet.extended_entities {
info!("{} medias in tweet", m.media.len());
let medias = m.media.clone();
let mut stream = stream::iter(medias)
.map(|media| {
// attribute media url
media_url = media.url.clone();
// clone everything we need
let cache_path = String::from(cache_path);
let mastodon = mastodon.clone();
tokio::task::spawn(async move {
info!("Start treating {}", media.media_url_https);
// get the tweet embedded media
let local_tweet_media_path = get_tweet_media(&media, &cache_path).await?;
// upload media to Mastodon
let mastodon_media =
mastodon.media(Cow::from(local_tweet_media_path.to_owned()))?;
// at this point, we can safely erase the original file
// it doesnt matter if we cant remove, cache_media fn is idempotent
remove_file(&local_tweet_media_path).await.ok();
Ok::<String, ScootalooError>(mastodon_media.id)
})
})
.buffered(4); // there are max four medias per tweet and they need to be treated in
// order
while let Some(result) = stream.next().await {
match result {
Ok(Ok(v)) => media_ids.push(v),
Ok(Err(e)) => warn!("Cannot treat media: {}", e),
Err(e) => error!("Something went wrong when joining the main thread: {}", e),
}
}
} else {
info!("No media in tweet");
}
// in case some media_ids slot remained empty due to errors, remove them
media_ids.retain(|x| !x.is_empty());
(media_url, media_ids)
}
/// Gets and caches Twitter Media inside the determined temp dir /// Gets and caches Twitter Media inside the determined temp dir
pub async fn cache_media(u: &str, t: &str) -> Result<String, Box<dyn Error>> { pub async fn cache_media(u: &str, t: &str) -> Result<String, Box<dyn Error>> {
// create dir // create dir

View File

@@ -1,4 +1,108 @@
use scootaloo::parse_toml; use scootaloo::parse_toml;
use std::collections::HashMap;
#[test]
fn test_alt_services() {
let toml = parse_toml("tests/no_test_alt_services.toml");
assert_eq!(toml.scootaloo.alternative_services_for, None);
let toml = parse_toml("tests/test_alt_services.toml");
assert_eq!(
toml.scootaloo.alternative_services_for,
Some(HashMap::from([
("tamere.lol".to_string(), "tonpere.mdr".to_string()),
("you.pi".to_string(), "you.pla".to_string())
]))
);
}
#[test]
fn test_re_display() {
let toml = parse_toml("tests/no_show_url_as_display_url_for.toml");
assert_eq!(toml.scootaloo.show_url_as_display_url_for, None);
let toml = parse_toml("tests/show_url_as_display_url_for.toml");
assert_eq!(
toml.scootaloo.show_url_as_display_url_for,
Some("^(.+)\\.es$".to_string())
);
}
#[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() {
@@ -9,6 +113,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"

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.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"

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.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"

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"

View File

@@ -0,0 +1,20 @@
[scootaloo]
db_path="/var/random/scootaloo.sqlite"
cache_path="/tmp/scootaloo"
show_url_as_display_url_for = "^(.+)\\.es$"
[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"

View File

@@ -0,0 +1,22 @@
[scootaloo]
db_path="/var/random/scootaloo.sqlite"
cache_path="/tmp/scootaloo"
[scootaloo.alternative_services_for]
"tamere.lol" = "tonpere.mdr"
"you.pi" = "you.pla"
[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"