OXYGENHUB
# 6907a989e82a oxygenhub / crates / hub / src / web / home.rs
13.3 KiB · Rust · last changed feat(web): a denser sky, every change and run a mark; short links; the name above (refs #157) 23 days ago source blame history raw
1
//! The front page, explore, owner pages and small endpoints.
2
3
use super::{filters, Error, Page, Shell};
4
use crate::auth::Viewer;
5
use crate::{db, Shared};
6
use askama::Template;
7
use axum::extract::{Path, Query, State};
8
use axum::http::header;
9
use axum::response::{IntoResponse, Response};
10
use hub_api::Visibility;
11
use serde::Deserialize;
12
13
#[derive(Template)]
14
#[template(path = "home.html")]
15
pub struct HomePage {
16
    shell: Shell,
17
    description: String,
18
    repos: Vec<db::repos::RepoRow>,
19
    owner: Option<String>,
20
    /// Explore's controls: the filter text, the sort, the topic.
21
    q: String,
22
    sort: String,
23
    topic: String,
24
    stars: std::collections::HashMap<i64, i64>,
25
}
26
27
impl HomePage {
28
    fn star_count(&self, id: &i64) -> i64 {
29
        self.stars.get(id).copied().unwrap_or(0)
30
    }
31
}
32
33
/// `/explore?q=&sort=activity|stars|name&topic=`.
34
#[derive(Deserialize, Default)]
35
pub struct ExploreQuery {
36
    #[serde(default)]
37
    q: String,
38
    #[serde(default)]
39
    sort: String,
40
    #[serde(default)]
41
    topic: String,
42
}
43
44
/// The signed-in dashboard (hub spec §6): the review queue, the
45
/// viewer's own proposals and assigned issues, their repositories and
46
/// recent activity across everything they can see.
47
#[derive(Template)]
48
#[template(path = "dashboard.html")]
49
pub struct Dashboard {
50
    shell: Shell,
51
    mine: Vec<db::repos::RepoRow>,
52
    reviews: Vec<db::activity::ProposalLine>,
53
    authored: Vec<db::activity::ProposalLine>,
54
    assigned: Vec<db::activity::IssueLine>,
55
    feed: Vec<db::activity::Activity>,
56
    /// Your sky's data (docs/backgrounds.md §5), JSON safe inside a script.
57
    backdrop: String,
58
}
59
60
/// How many activity lines the dashboard shows.
61
const FEED_LIMIT: i64 = 40;
62
/// The most events Your sky reads, and how far back (docs/backgrounds.md §5).
63
const SKY_EVENTS: i64 = 1500;
64
const SKY_DAYS: i64 = 30;
65
66
/// Your sky's data (docs/backgrounds.md §5): the viewer's repositories and
67
/// their events of the last 30 days, newest first, as
68
/// `{now, repos: [slug], events: [[repo, kind, at_ms, n]]}` with kinds 0 a
69
/// push of `n` changes, 1 a proposal event, 2 an issue event, 3 a release,
70
/// 4 a Flow run. Only the database is read, never a repository's store;
71
/// `<` is escaped so the JSON is safe in a script.
72
fn sky_json(mine: &[db::repos::RepoRow], events: &[db::activity::SkyEvent], now: i64) -> String {
73
    let slugs: Vec<String> = mine.iter().map(|r| format!("{}/{}", r.owner, r.name)).collect();
74
    let evs: Vec<serde_json::Value> = events
75
        .iter()
76
        .filter_map(|e| {
77
            let repo = mine.iter().position(|r| r.id == e.repo_id)?;
78
            Some(serde_json::json!([repo, e.kind, e.at_ms, e.n]))
79
        })
80
        .collect();
81
    serde_json::json!({ "now": now, "repos": slugs, "events": evs }).to_string().replace('<', "\\u003c")
82
}
83
84
/// `/`: the dashboard when signed in, every visible repository otherwise.
85
pub async fn index(State(app): State<Shared>, viewer: Viewer) -> Result<Response, Error> {
86
    let Some(account) = viewer.account().cloned() else {
87
        return Ok(explore(State(app), viewer, Query(ExploreQuery::default())).await?.into_response());
88
    };
89
    let shell = Shell::new(&app, "/", &viewer);
90
    let db_err = |e| Error::from_db(shell.clone(), e);
91
    let all = db::repos::list(&app.db).await.map_err(db_err)?;
92
    let member: Vec<i64> = db::accounts::visible_repo_ids(&app.db, account.id).await.map_err(db_err)?;
93
    let seen = visible(&app, &shell, &viewer, all).await?;
94
    let seen_ids: Vec<i64> = seen.iter().map(|r| r.id).collect();
95
    let mut mine: Vec<db::repos::RepoRow> = seen.into_iter().filter(|r| member.contains(&r.id)).collect();
96
    mine.sort_by_key(|r| std::cmp::Reverse(r.updated_ms));
97
    let reviews = db::activity::awaiting_review(&app.db, account.id, &member).await.map_err(db_err)?;
98
    let authored = db::activity::authored(&app.db, account.id, &seen_ids).await.map_err(db_err)?;
99
    let assigned = db::activity::assigned(&app.db, account.id, &seen_ids).await.map_err(db_err)?;
100
    let feed = db::activity::feed(&app.db, &seen_ids, FEED_LIMIT).await.map_err(db_err)?;
101
    let mine_ids: Vec<i64> = mine.iter().map(|r| r.id).collect();
102
    let now = db::now_ms();
103
    let sky = db::activity::sky(&app.db, &mine_ids, now - SKY_DAYS * 86_400_000, SKY_EVENTS).await.map_err(db_err)?;
104
    let backdrop = sky_json(&mine, &sky, now);
105
    Ok(Page(Dashboard { shell, mine, reviews, authored, assigned, feed, backdrop }).into_response())
106
}
107
108
/// `/explore`: every repository the viewer may see, filtered by text and
109
/// topic, sorted by recent activity (the default), stars or name.
110
pub async fn explore(State(app): State<Shared>, viewer: Viewer, Query(q): Query<ExploreQuery>) -> Result<Page<HomePage>, Error> {
111
    let shell = Shell::new(&app, "/explore", &viewer);
112
    let db_err = |e| Error::from_db(shell.clone(), e);
113
    let mut repos = visible(&app, &shell, &viewer, db::repos::list(&app.db).await.map_err(db_err)?).await?;
114
    let stars = db::repos::star_counts(&app.db).await.map_err(db_err)?;
115
    let needle = q.q.trim().to_lowercase();
116
    if !needle.is_empty() {
117
        repos.retain(|r| {
118
            r.slug().to_lowercase().contains(&needle)
119
                || r.description.to_lowercase().contains(&needle)
120
                || r.topic_list().iter().any(|t| t.contains(&needle))
121
        });
122
    }
123
    let topic = q.topic.trim().to_lowercase();
124
    if !topic.is_empty() {
125
        repos.retain(|r| r.topic_list().contains(&topic.as_str()));
126
    }
127
    let sort = match q.sort.as_str() {
128
        "stars" | "name" => q.sort.clone(),
129
        _ => "activity".to_string(),
130
    };
131
    match sort.as_str() {
132
        "stars" => repos.sort_by_key(|r| (std::cmp::Reverse(stars.get(&r.id).copied().unwrap_or(0)), std::cmp::Reverse(r.updated_ms))),
133
        "name" => repos.sort_by_key(|r| (r.name.to_lowercase(), r.owner.to_lowercase())),
134
        _ => repos.sort_by_key(|r| std::cmp::Reverse(r.updated_ms)),
135
    }
136
    Ok(Page(HomePage { description: app.config.site.description.clone(), shell, repos, owner: None, q: q.q, sort, topic, stars }))
137
}
138
139
/// A person's page (hub spec §6): avatar, names, bio, linked signing
140
/// keys, organisations, repositories and what they did lately.
141
#[derive(Template)]
142
#[template(path = "profile.html")]
143
pub struct ProfilePage {
144
    shell: Shell,
145
    account: db::accounts::Account,
146
    keys: Vec<db::accounts::LinkedIdentity>,
147
    orgs: Vec<(db::accounts::Organisation, String)>,
148
    repos: Vec<db::repos::RepoRow>,
149
    feed: Vec<db::activity::Activity>,
150
    is_me: bool,
151
}
152
153
impl ProfilePage {
154
    /// The website as a link only when it is http(s).
155
    fn website_href(&self) -> Option<&str> {
156
        let w = self.account.website.trim();
157
        (w.starts_with("https://") || w.starts_with("http://")).then_some(w)
158
    }
159
}
160
161
/// An organisation's page: description, members with their roles, teams,
162
/// repositories and recent activity in them.
163
#[derive(Template)]
164
#[template(path = "org.html")]
165
pub struct OrgPage {
166
    shell: Shell,
167
    org: db::accounts::Organisation,
168
    members: Vec<(db::accounts::Account, String)>,
169
    teams: Vec<(db::accounts::Team, usize)>,
170
    repos: Vec<db::repos::RepoRow>,
171
    feed: Vec<db::activity::Activity>,
172
    can_admin: bool,
173
}
174
175
/// How many activity lines an owner page shows.
176
const OWNER_FEED: i64 = 20;
177
178
/// `/{owner}`: a person's profile, an organisation's page, or (for an
179
/// owner that is neither, such as repositories an administrator created
180
/// for a name nobody holds) the list of its repositories.
181
pub async fn owner(State(app): State<Shared>, viewer: Viewer, Path(owner): Path<String>) -> Result<Response, Error> {
182
    let shell = Shell::new(&app, &format!("/{owner}"), &viewer);
183
    if !crate::repos::names::valid_owner(&owner) {
184
        return Err(Error::not_found(shell));
185
    }
186
    let db_err = |e| Error::from_db(shell.clone(), e);
187
    let mut repos = visible(&app, &shell, &viewer, db::repos::list_by_owner(&app.db, &owner).await.map_err(db_err)?).await?;
188
    repos.sort_by_key(|r| std::cmp::Reverse(r.updated_ms));
189
    if let Some(account) = db::accounts::account_by_name(&app.db, &owner).await.map_err(db_err)? {
190
        // What they did anywhere the viewer can see, not only in their own repositories.
191
        let all = visible(&app, &shell, &viewer, db::repos::list(&app.db).await.map_err(db_err)?).await?;
192
        let ids: Vec<i64> = all.iter().map(|r| r.id).collect();
193
        let feed = db::activity::feed_by(&app.db, &ids, Some(&account.username), OWNER_FEED).await.map_err(db_err)?;
194
        let keys = db::accounts::identities_of(&app.db, account.id).await.map_err(db_err)?;
195
        let orgs = db::accounts::orgs_of(&app.db, account.id).await.map_err(db_err)?;
196
        let is_me = viewer.account().is_some_and(|a| a.id == account.id);
197
        return Ok(Page(ProfilePage { shell, account, keys, orgs, repos, feed, is_me }).into_response());
198
    }
199
    if let Some(org) = db::accounts::org_by_name(&app.db, &owner).await.map_err(db_err)? {
200
        let members = db::accounts::org_members(&app.db, org.id).await.map_err(db_err)?;
201
        let mut teams = Vec::new();
202
        for t in db::accounts::teams(&app.db, org.id).await.map_err(db_err)? {
203
            let n = db::accounts::team_members(&app.db, t.id).await.map_err(db_err)?.len();
204
            teams.push((t, n));
205
        }
206
        let ids: Vec<i64> = repos.iter().map(|r| r.id).collect();
207
        let feed = db::activity::feed(&app.db, &ids, OWNER_FEED).await.map_err(db_err)?;
208
        let can_admin =
209
            viewer.is_admin() || viewer.account().is_some_and(|a| members.iter().any(|(m, role)| m.id == a.id && role == "owner"));
210
        return Ok(Page(OrgPage { shell, org, members, teams, repos, feed, can_admin }).into_response());
211
    }
212
    if repos.is_empty() {
213
        return Err(Error::not_found(shell));
214
    }
215
    let stars = db::repos::star_counts(&app.db).await.unwrap_or_default();
216
    Ok(Page(HomePage {
217
        description: String::new(),
218
        shell,
219
        repos,
220
        owner: Some(owner),
221
        q: String::new(),
222
        sort: "activity".into(),
223
        topic: String::new(),
224
        stars,
225
    })
226
    .into_response())
227
}
228
229
/// The repositories among `rows` the viewer may see: public ones, internal
230
/// ones when signed in, and those the viewer owns or collaborates on.
231
pub(crate) async fn visible(
232
    app: &Shared,
233
    shell: &Shell,
234
    viewer: &Viewer,
235
    rows: Vec<db::repos::RepoRow>,
236
) -> Result<Vec<db::repos::RepoRow>, Error> {
237
    let mine: Vec<i64> = match viewer.account() {
238
        Some(a) if a.is_admin => rows.iter().map(|r| r.id).collect(),
239
        Some(a) => db::accounts::visible_repo_ids(&app.db, a.id).await.map_err(|e| Error::from_db(shell.clone(), e))?,
240
        None => vec![],
241
    };
242
    let signed_in = viewer.signed_in();
243
    Ok(rows
244
        .into_iter()
245
        .filter(|r| match r.visibility() {
246
            Visibility::Public => true,
247
            Visibility::Internal => signed_in,
248
            Visibility::Private => mine.contains(&r.id),
249
        })
250
        .collect())
251
}
252
253
pub async fn health(State(app): State<Shared>) -> Response {
254
    let body = serde_json::json!({
255
        "ok": true,
256
        "version": env!("CARGO_PKG_VERSION"),
257
        "build": env!("OXY_BUILD_ID"),
258
        "uptime_s": app.started.elapsed().as_secs(),
259
    });
260
    axum::Json(body).into_response()
261
}
262
263
/// The hub delegate identity object (hub spec §15.5), as `oxy identity
264
/// export` writes one, so policy holders can admit it.
265
pub async fn hub_key(State(app): State<Shared>) -> Response {
266
    (
267
        [(header::CONTENT_TYPE, "application/oxy-identity"), (header::CONTENT_DISPOSITION, "attachment; filename=\"hub.identity\"")],
268
        app.hub_key.bytes.clone(),
269
    )
270
        .into_response()
271
}
272
273
/// The hub's TLS certificate (hub spec §15.5), for clients of a
274
/// developer edition with a self-signed certificate: save it and point
275
/// `oxy` at it with `OXY_CA` or `oxy config remote.<name>.ca`.
276
pub async fn hub_ca(State(app): State<Shared>) -> Response {
277
    if !app.config.tls.self_signed {
278
        return (axum::http::StatusCode::NOT_FOUND, "this hub does not use a self-signed certificate").into_response();
279
    }
280
    match tokio::fs::read(app.config.tls_cert()).await {
281
        Ok(pem) => (
282
            [(header::CONTENT_TYPE, "application/x-pem-file"), (header::CONTENT_DISPOSITION, "attachment; filename=\"oxyhub-ca.pem\"")],
283
            pem,
284
        )
285
            .into_response(),
286
        Err(_) => (axum::http::StatusCode::NOT_FOUND, "no certificate").into_response(),
287
    }
288
}
289
290
/// What this hub is built from (hub spec §15): its version and build, and
291
/// the versions of the Oxygen and OxygenFlow libraries it links.
292
pub fn versions() -> serde_json::Value {
293
    serde_json::json!({
294
        "oxygenhub": { "version": env!("CARGO_PKG_VERSION"), "build": env!("OXY_BUILD_ID") },
295
        "oxy_core": oxy_core::VERSION,
296
        "flow_core": flow_core::VERSION,
297
    })
298
}
299
300
#[derive(askama::Template)]
301
#[template(path = "about.html")]
302
pub struct AboutPage {
303
    shell: Shell,
304
    oxy_core: &'static str,
305
    flow_core: &'static str,
306
    /// Runners and the versions they report, for administrators.
307
    runners: Vec<crate::db::runners::Runner>,
308
}
309
310
/// `GET /about`: the hub's version and what it is built on; runners too, for
311
/// administrators.
312
pub async fn about(State(app): State<Shared>, viewer: Viewer) -> Result<Page<AboutPage>, Error> {
313
    let shell = Shell::new(&app, "/about", &viewer);
314
    let runners = if viewer.is_admin() { crate::db::runners::list(&app.db).await.unwrap_or_default() } else { vec![] };
315
    Ok(Page(AboutPage { shell, oxy_core: oxy_core::VERSION, flow_core: flow_core::VERSION, runners }))
316
}