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