runlight 0.1.0

Privacy friendly web analytics that lives inside your Rust app: mount a route, add a script tag, read your stats at /runlight
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

//! The Runlight's mail service, email reports, and the assistant's settings (runlight.ts).

use crate::assistant::{AssistantSettings, PROVIDERS};
use crate::error::Error;
use crate::goals::CodedError;
use crate::http::Url;
use crate::js::{self, Object, Value};
use crate::mail::secret::{seal, unseal};
use crate::mail::transports::{Message, SERVICES, check_config, send};
use crate::reports::{ReportPeriod, build_report, last_period};
use crate::runlight::{Runlight, is_email};
use crate::store::{ReportRow, SiteRow};

fn mail_error(message: &str, code: &str) -> Error {
    Error::Mail(CodedError::new(message, code, &[]))
}

impl Runlight {
    /// The mail service: from code, or as saved in the dashboard, with where it came from.
    pub async fn mail_settings(&self) -> Result<Option<(Object, &'static str)>, Error> {
        if let Some(code) = &self.0.mail_in_code {
            return Ok(Some((code.clone(), "code")));
        }
        self.init().await?;
        let Some(sealed) = self.store().setting("mail").await? else { return Ok(None) };
        let Some(opened) = unseal(&sealed, self.secret()) else { return Ok(None) };
        Ok(match js::parse(&opened) {
            Ok(Value::Object(o)) => Some((o, "dashboard")),
            _ => None,
        })
    }

    /// Saves the mail service from the dashboard. A secret field left blank keeps the saved value, so the
    /// browser never needs to see it. `None` removes it.
    pub async fn save_mail_settings(&self, input: Option<&Value>) -> Result<(), Error> {
        if self.0.mail_in_code.is_some() {
            return Err(mail_error("The mail service is set in code", "mail_in_code"));
        }
        let Some(input) = input else {
            self.store().set_setting("mail", None).await?;
            return Ok(());
        };
        let before = self.mail_settings().await?.map(|b| b.0);
        let Some(service) = SERVICES.iter().find(|s| input.get("service").and_then(Value::as_str) == Some(s.id)) else {
            return Err(mail_error("Pick a mail service", "mail_service"));
        };
        let text = |k: &str| js::trim(&js::str_or_empty(input.get(k))).to_string();
        let mut settings = Object::new();
        settings.set("service", service.id);
        for f in service.fields.iter().filter(|f| !f.secret) {
            settings.set(f.name, text(f.name));
        }
        // A blank secret keeps the saved one only while the connection is the same, so changing the host
        // cannot send a saved password somewhere new.
        let same = before.as_ref().is_some_and(|b| {
            b.get("service").and_then(Value::as_str) == Some(service.id)
                && service
                    .fields
                    .iter()
                    .all(|f| f.secret || js::str_or_empty(b.get(f.name)) == js::str_or_empty(settings.get(f.name)))
        });
        for f in service.fields.iter().filter(|f| f.secret) {
            let given = text(f.name);
            let value = if given.is_empty() && same {
                js::str_or_empty(before.as_ref().and_then(|b| b.get(f.name)))
            } else {
                given
            };
            settings.set(f.name, value);
        }
        let from = text("from");
        if !is_email(&from) {
            return Err(mail_error("Enter the address reports come from, like reports@example.com", "mail_from"));
        }
        let from_name = js::head16(&text("fromName"), 80);
        settings.set("from", from);
        if !from_name.is_empty() {
            settings.set("fromName", from_name);
        }
        check_config(&settings).map_err(Error::Mail)?;
        let sealed = seal(&settings.to_json(), self.secret());
        self.store().set_setting("mail", Some(&sealed)).await?;
        Ok(())
    }

    /// Sends one email through the mail service.
    pub async fn send_mail(&self, mut message: Message) -> Result<(), Error> {
        let Some((settings, _)) = self.mail_settings().await? else {
            return Err(mail_error("Set up a mail service first", "mail_unset"));
        };
        message.from = js::str_or_empty(settings.get("from"));
        message.from_name = settings.get("fromName").map(js::js_string);
        send(&settings, &message, self.fetcher(), self.now()).await.map_err(Error::Mail)
    }

    /// Sends every report that is due: last week's on Monday from 8am, last month's on the 1st, in each
    /// site's timezone. Safe to run often; each period goes out once. Gives how many went and failed.
    pub async fn send_reports(&self) -> Result<(i64, i64), Error> {
        self.init().await?;
        let (mut sent, mut failed) = (0, 0);
        let reports = self.store().reports(None).await?;
        if reports.is_empty() || self.mail_settings().await?.is_none() {
            return Ok((sent, failed));
        }
        let now = self.now();
        for r in reports {
            let Some(site) = self.site(Some(&r.site)) else { continue };
            let period = last_period(&r.frequency, now, &site.timezone);
            if now < period.due_at || r.last_period == period.key {
                continue;
            }
            if !self.store().claim_report(&r.id, &period.key, now).await? {
                continue;
            }
            match self.deliver_report(&r, &site, Some(&period)).await {
                Ok(()) => sent += 1,
                Err(error) => {
                    self.store().release_report(&r.id, &period.key, &r.last_period).await?;
                    eprintln!(
                        "Runlight: could not send the {} report for {} to {}: {}",
                        r.frequency,
                        site.name,
                        r.email,
                        error.message()
                    );
                    failed += 1;
                }
            }
        }
        Ok((sent, failed))
    }

    /// Builds and sends one report. Also used by "Send a sample now".
    pub async fn deliver_report(
        &self,
        r: &ReportRow,
        site: &SiteRow,
        period: Option<&ReportPeriod>,
    ) -> Result<(), Error> {
        let owned;
        let period = match period {
            Some(p) => p,
            None => {
                owned = last_period(&r.frequency, self.now(), &site.timezone);
                &owned
            }
        };
        let unsubscribe = format!("{}/unsubscribe/{}", r.origin, r.token);
        let dashboard = format!("{}/?site={}", r.origin, crate::sources::encode_uri_component(&site.id));
        let report = build_report(self.store(), site, &r.frequency, period, &r.lang, &dashboard, &unsubscribe).await?;
        self.send_mail(Message {
            to: r.email.clone(),
            subject: report.subject,
            html: report.html,
            text: report.text,
            headers: vec![
                ("List-Unsubscribe".into(), format!("<{unsubscribe}>")),
                ("List-Unsubscribe-Post".into(), "List-Unsubscribe=One-Click".into()),
            ],
            ..Message::default()
        })
        .await
    }

    /// The dashboard assistant's provider, model, and key, kept sealed like the mail keys.
    pub async fn assistant_settings(&self) -> Result<Option<AssistantSettings>, Error> {
        let Some(stored) = self.store().setting("assistant").await? else { return Ok(None) };
        let Some(opened) = unseal(&stored, self.secret()) else { return Ok(None) };
        let Ok(v) = js::parse(&opened) else { return Ok(None) };
        let s = |k: &str| js::str_or_empty(v.get(k));
        Ok(Some(AssistantSettings {
            provider: s("provider"),
            model: s("model"),
            base_url: s("baseUrl"),
            key: s("key"),
        }))
    }

    /// Saves the assistant's settings; an empty key keeps the one saved for the same provider. `None` removes them.
    pub async fn save_assistant_settings(&self, input: Option<&Value>) -> Result<(), Error> {
        let Some(input) = input else {
            self.store().set_setting("assistant", None).await?;
            return Ok(());
        };
        let Some(provider) = PROVIDERS.iter().find(|p| input.get("provider").and_then(Value::as_str) == Some(p.id))
        else {
            return Err(Error::settings("Choose a provider", "assistant_provider", &[]));
        };
        let base_url = js::trim(&js::str_or_empty(input.get("baseUrl"))).trim_end_matches('/').to_string();
        if !base_url.is_empty() {
            let ok = Url::parse(&base_url).is_some_and(|u| u.protocol() == "https:" || u.protocol() == "http:");
            if !ok {
                return Err(Error::settings(
                    "Enter the service's address, starting with https://",
                    "assistant_address_bad",
                    &[],
                ));
            }
        }
        if base_url.is_empty() && provider.base_url.is_empty() {
            return Err(Error::settings("Enter the service's address", "assistant_address", &[]));
        }
        let model = js::head16(js::trim(&js::str_or_empty(input.get("model"))), 200);
        if model.is_empty() && provider.model.is_empty() {
            return Err(Error::settings("Enter the model to use", "assistant_model", &[]));
        }
        let before = self.assistant_settings().await?;
        let mut key = js::trim(&js::str_or_empty(input.get("key"))).to_string();
        // A saved key is kept only for the same service at the same address, so it is never sent somewhere new.
        let address = |b: &str| if b.is_empty() { provider.base_url.to_string() } else { b.to_string() };
        if key.is_empty()
            && let Some(b) = &before
            && b.provider == provider.id
            && address(&b.base_url) == address(&base_url)
        {
            key = b.key.clone();
        }
        if key.is_empty() && provider.key == "yes" {
            return Err(Error::settings(
                format!("Enter your {} key", provider.name),
                "assistant_key",
                &[("provider", provider.name)],
            ));
        }
        let settings = crate::obj! { "provider" => provider.id, "model" => model, "baseUrl" => base_url, "key" => key };
        let sealed = seal(&settings.to_json(), self.secret());
        self.store().set_setting("assistant", Some(&sealed)).await?;
        Ok(())
    }
}