dsc-rs 0.10.15

Discourse CLI tool for managing multiple Discourse forums: track installs, run upgrades over SSH, manage emojis, sync topics and categories as Markdown, and more.
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
use super::client::DiscourseClient;
use super::error::http_error;
use super::models::{
    GroupDetail, GroupDetailResponse, GroupMember, GroupMembersResponse, GroupSummary,
};
use anyhow::{Context, Result, anyhow};
use reqwest::StatusCode;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashSet;

/// Result of a bulk add-members call.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct AddMembersOutcome {
    /// Usernames Discourse reported as added by the call.
    pub added_usernames: Vec<String>,
    /// Error strings Discourse returned (unknown emails, etc.).
    pub errors: Vec<String>,
}

impl DiscourseClient {
    /// Fetch all groups.
    pub fn fetch_groups(&self) -> Result<Vec<GroupSummary>> {
        if let Some(groups) = self.fetch_groups_admin()? {
            return Ok(groups);
        }
        self.fetch_groups_paginated("/groups.json")
    }

    /// Fetch group details by ID (fallbacks to name lookup if needed).
    pub fn fetch_group_detail(
        &self,
        group_id: u64,
        group_name: Option<&str>,
    ) -> Result<GroupDetail> {
        let id_path = format!("/groups/{}.json", group_id);
        if let Some(detail) = self.fetch_group_detail_by_path(&id_path)? {
            return Ok(detail);
        }
        if let Some(name) = group_name {
            let name_path = format!("/groups/{}.json", name);
            if let Some(detail) = self.fetch_group_detail_by_path(&name_path)? {
                return Ok(detail);
            }
        }
        Err(anyhow!("group not found: {}", group_id))
    }

    pub fn fetch_group_members(
        &self,
        group_id: u64,
        group_name: Option<&str>,
    ) -> Result<Vec<GroupMember>> {
        let id_path = format!("/groups/{}/members.json", group_id);
        if let Some(members) = self.fetch_group_members_by_path(&id_path)? {
            return Ok(members);
        }
        if let Some(name) = group_name {
            let name_path = format!("/groups/{}/members.json", name);
            if let Some(members) = self.fetch_group_members_by_path(&name_path)? {
                return Ok(members);
            }
        }
        Err(anyhow!("group not found: {}", group_id))
    }

    /// Create a group with detailed settings copied from a source group.
    pub fn create_group(&self, group: &GroupDetail) -> Result<u64> {
        let mut payload: Vec<(String, String)> = Vec::new();
        payload.push(("group[name]".to_string(), group.name.clone()));
        if let Some(full_name) = group.full_name.clone() {
            payload.push(("group[full_name]".to_string(), full_name));
        }
        push_opt(&mut payload, "group[title]", group.title.as_deref());
        push_opt(
            &mut payload,
            "group[grant_trust_level]",
            group
                .grant_trust_level
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[visibility_level]",
            group
                .visibility_level
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[mentionable_level]",
            group
                .mentionable_level
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[messageable_level]",
            group
                .messageable_level
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[default_notification_level]",
            group
                .default_notification_level
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[members_visibility_level]",
            group
                .members_visibility_level
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[primary_group]",
            group
                .primary_group
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[public_admission]",
            group
                .public_admission
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[public_exit]",
            group.public_exit.as_ref().map(|v| v.to_string()).as_deref(),
        );
        push_opt(
            &mut payload,
            "group[allow_membership_requests]",
            group
                .allow_membership_requests
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[automatic_membership_email_domains]",
            group.automatic_membership_email_domains.as_deref(),
        );
        push_opt(
            &mut payload,
            "group[automatic_membership_retroactive]",
            group
                .automatic_membership_retroactive
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[membership_request_template]",
            group.membership_request_template.as_deref(),
        );
        push_opt(
            &mut payload,
            "group[flair_icon]",
            group.flair_icon.as_deref(),
        );
        push_opt(
            &mut payload,
            "group[flair_upload_id]",
            group
                .flair_upload_id
                .as_ref()
                .map(|v| v.to_string())
                .as_deref(),
        );
        push_opt(
            &mut payload,
            "group[flair_color]",
            group.flair_color.as_deref(),
        );
        push_opt(
            &mut payload,
            "group[flair_background_color]",
            group.flair_background_color.as_deref(),
        );
        push_opt(&mut payload, "group[bio_raw]", group.bio_raw.as_deref());
        let response = self.send_retrying(|| Ok(self.post("/admin/groups")?.form(&payload)))?;
        let status = response.status();
        let text = response.text().context("reading group response body")?;
        if !status.is_success() {
            return Err(http_error("create group request", status, &text));
        }
        let value: Value = serde_json::from_str(&text).context("parsing group response json")?;
        let id = value
            .get("group")
            .and_then(|group| group.get("id"))
            .and_then(|id| id.as_u64())
            .or_else(|| {
                value
                    .get("basic_group")
                    .and_then(|g| g.get("id"))
                    .and_then(|id| id.as_u64())
            })
            .or_else(|| value.get("id").and_then(|id| id.as_u64()))
            .ok_or_else(|| anyhow!("missing group id in response: {}", text))?;
        Ok(id)
    }

    /// Add members to a group by username (PUT /groups/:id/members.json).
    pub fn add_group_members_by_username(
        &self,
        group_id: u64,
        usernames: &[String],
        notify_users: bool,
    ) -> Result<AddMembersOutcome> {
        if usernames.is_empty() {
            return Ok(AddMembersOutcome::default());
        }
        let path = format!("/groups/{}/members.json", group_id);
        let joined = usernames.join(",");
        let notify = if notify_users { "true" } else { "false" };
        let payload = [("usernames", joined.as_str()), ("notify_users", notify)];
        let response = self.send_retrying(|| Ok(self.put(&path)?.form(&payload)))?;
        let status = response.status();
        let text = response.text().context("reading add-members response")?;
        if !status.is_success() {
            return Err(http_error("add group members request", status, &text));
        }
        parse_add_members_outcome(&text)
    }

    /// Remove members from a group by username (DELETE /groups/:id/members.json).
    pub fn remove_group_members_by_username(
        &self,
        group_id: u64,
        usernames: &[String],
    ) -> Result<()> {
        if usernames.is_empty() {
            return Ok(());
        }
        let path = format!(
            "/groups/{}/members.json?usernames={}",
            group_id,
            usernames.join(",")
        );
        let response = self.send_retrying(|| Ok(self.delete_builder(&path)?))?;
        let status = response.status();
        if !status.is_success() {
            let text = response
                .text()
                .unwrap_or_else(|_| "<failed to read response body>".to_string());
            return Err(http_error("remove group members request", status, &text));
        }
        Ok(())
    }

    /// Return the list of groups a user belongs to, by username.
    pub fn fetch_user_groups(&self, username: &str) -> Result<Vec<GroupSummary>> {
        let path = format!("/u/{}.json", username);
        let response = self.get(&path)?;
        let status = response.status();
        let text = response.text().context("reading user response body")?;
        if !status.is_success() {
            return Err(http_error("user request", status, &text));
        }
        let value: Value = serde_json::from_str(&text).context("parsing user response json")?;
        let groups = value
            .get("user")
            .and_then(|u| u.get("groups"))
            .and_then(|g| g.as_array())
            .map(|arr| {
                arr.iter()
                    .filter_map(|v| serde_json::from_value::<GroupSummary>(v.clone()).ok())
                    .collect()
            })
            .unwrap_or_default();
        Ok(groups)
    }

    /// Add members to a group by email (PUT /groups/:id/members.json).
    ///
    /// Returns a tuple of (added_usernames, not_found_emails) parsed loosely
    /// from the response; both lists may be empty on success if the response
    /// doesn't surface them.
    pub fn add_group_members_by_email(
        &self,
        group_id: u64,
        emails: &[String],
        notify_users: bool,
    ) -> Result<AddMembersOutcome> {
        if emails.is_empty() {
            return Ok(AddMembersOutcome::default());
        }
        let path = format!("/groups/{}/members.json", group_id);
        let joined = emails.join(",");
        let notify = if notify_users { "true" } else { "false" };
        let payload = [("emails", joined.as_str()), ("notify_users", notify)];
        let response = self.send_retrying(|| Ok(self.put(&path)?.form(&payload)))?;
        let status = response.status();
        let text = response.text().context("reading add-members response")?;
        if !status.is_success() {
            return Err(http_error("add group members request", status, &text));
        }
        parse_add_members_outcome(&text)
    }

    fn fetch_group_detail_by_path(&self, path: &str) -> Result<Option<GroupDetail>> {
        let response = self.get(path)?;
        let status = response.status();
        let text = response.text().context("reading group detail body")?;
        if !status.is_success() {
            if status == StatusCode::NOT_FOUND {
                return Ok(None);
            }
            return Err(http_error("group detail request", status, &text));
        }
        let body: GroupDetailResponse =
            serde_json::from_str(&text).context("parsing group detail json")?;
        Ok(Some(body.group))
    }

    fn fetch_group_members_by_path(&self, path: &str) -> Result<Option<Vec<GroupMember>>> {
        let response = self.get(path)?;
        let status = response.status();
        let text = response.text().context("reading group members body")?;
        if !status.is_success() {
            if status == StatusCode::NOT_FOUND {
                return Ok(None);
            }
            return Err(http_error("group members request", status, &text));
        }
        let body: GroupMembersResponse =
            serde_json::from_str(&text).context("parsing group members json")?;
        Ok(Some(body.members))
    }

    fn fetch_groups_admin(&self) -> Result<Option<Vec<GroupSummary>>> {
        let response = self.get("/admin/groups.json")?;
        let status = response.status();
        let text = response.text().context("reading groups response body")?;
        if status.is_success() {
            if text.trim().is_empty() {
                return Ok(None);
            }
            let value: Value = serde_json::from_str(&text).context("parsing groups json")?;
            return Ok(Some(extract_groups_from_value(&value)?));
        }
        if status == StatusCode::NOT_FOUND {
            return Ok(None);
        }
        Err(http_error("groups request", status, &text))
    }

    fn fetch_groups_paginated(&self, path: &str) -> Result<Vec<GroupSummary>> {
        let mut out = Vec::new();
        let mut seen = HashSet::new();
        let mut next_path = Some(path.to_string());

        while let Some(path) = next_path.take() {
            let path = self.normalize_groups_path(&path);
            if !seen.insert(path.clone()) {
                return Err(anyhow!("groups request loop detected at {}", path));
            }
            let response = self.get(&path)?;
            let status = response.status();
            let text = response.text().context("reading groups response body")?;
            if !status.is_success() {
                return Err(http_error("groups request", status, &text));
            }
            if text.trim().is_empty() {
                return Err(anyhow!(
                    "groups request failed with {} (empty response)",
                    status
                ));
            }
            let value: Value = serde_json::from_str(&text).context("parsing groups json")?;
            let page_groups = extract_groups_from_value(&value)?;
            if page_groups.is_empty() {
                break;
            }
            out.extend(page_groups);
            next_path = extract_next_groups_path(&value);
        }

        Ok(out)
    }

    fn normalize_groups_path(&self, path: &str) -> String {
        let mut path = path.to_string();
        if let Some(stripped) = path.strip_prefix(self.baseurl()) {
            path = stripped.to_string();
        }
        if !path.starts_with('/') {
            path = format!("/{}", path);
        }
        if path.contains(".json") {
            return path;
        }
        if let Some((base, query)) = path.split_once('?') {
            format!("{}.json?{}", base, query)
        } else {
            format!("{}.json", path)
        }
    }
}

fn push_opt(payload: &mut Vec<(String, String)>, key: &str, value: Option<&str>) {
    if let Some(value) = value {
        payload.push((key.to_string(), value.to_string()));
    }
}

fn extract_groups_from_value(value: &Value) -> Result<Vec<GroupSummary>> {
    let groups = if let Some(arr) = value.as_array() {
        arr
    } else {
        value
            .get("groups")
            .and_then(|v| v.as_array())
            .ok_or_else(|| anyhow!("groups response missing groups array"))?
    };
    let mut out = Vec::with_capacity(groups.len());
    for group in groups {
        let parsed: GroupSummary =
            serde_json::from_value(group.clone()).context("parsing group summary")?;
        out.push(parsed);
    }
    Ok(out)
}

fn extract_next_groups_path(value: &Value) -> Option<String> {
    let direct = value
        .get("load_more_groups")
        .and_then(|v| v.as_str())
        .map(|s| s.to_string());
    if direct
        .as_deref()
        .map(|s| !s.trim().is_empty())
        .unwrap_or(false)
    {
        return direct;
    }
    value
        .get("extras")
        .and_then(|extras| extras.get("load_more_groups"))
        .and_then(|v| v.as_str())
        .map(|s| s.to_string())
        .filter(|s| !s.trim().is_empty())
}

fn parse_add_members_outcome(body: &str) -> Result<AddMembersOutcome> {
    let value: Value = serde_json::from_str(body).context("parsing add-members response json")?;
    let added_usernames = value
        .get("usernames")
        .and_then(|v| v.as_array())
        .map(|arr| {
            arr.iter()
                .filter_map(|v| v.as_str().map(|s| s.to_string()))
                .collect()
        })
        .unwrap_or_default();
    let errors = value
        .get("errors")
        .and_then(|v| v.as_array())
        .map(|arr| {
            arr.iter()
                .filter_map(|v| v.as_str().map(|s| s.to_string()))
                .collect()
        })
        .unwrap_or_default();
    Ok(AddMembersOutcome {
        added_usernames,
        errors,
    })
}