Skip to main content

dsc/api/
settings.rs

1use super::client::DiscourseClient;
2use super::error::http_error;
3use anyhow::{anyhow, Context, Result};
4use serde_json::Value;
5
6impl DiscourseClient {
7    /// Update a site setting by name (admin only).
8    pub fn update_site_setting(&self, setting: &str, value: &str) -> Result<()> {
9        let setting = setting.trim();
10        if setting.is_empty() {
11            return Err(anyhow!("missing site setting name for site setting update"));
12        }
13        if setting.chars().any(|ch| ch.is_whitespace() || ch == '/') {
14            return Err(anyhow!(
15                "site setting name contains invalid characters: {}",
16                setting
17            ));
18        }
19        let path = format!("/admin/site_settings/{}.json", setting);
20        let payload = [("value", value)];
21        let response = self.send_retrying(|| Ok(self.put(&path)?.form(&payload)))?;
22        let status = response.status();
23        let text = response
24            .text()
25            .context("reading site setting update response")?;
26        if !status.is_success() {
27            return Err(http_error("update site setting request", status, &text));
28        }
29        Ok(())
30    }
31
32    /// Fetch all site settings (admin only). Returns raw JSON value.
33    pub fn list_site_settings(&self) -> Result<Value> {
34        let response = self.get("/admin/site_settings.json")?;
35        let status = response.status();
36        let text = response
37            .text()
38            .context("reading site settings list response")?;
39        if !status.is_success() {
40            return Err(http_error("list site settings request", status, &text));
41        }
42        let value: Value =
43            serde_json::from_str(&text).context("parsing site settings list response")?;
44        Ok(value)
45    }
46
47    /// Fetch a single site setting by name (admin only).
48    /// Returns the value as a string, or an error if not found.
49    pub fn fetch_site_setting(&self, setting: &str) -> Result<String> {
50        let setting = setting.trim();
51        if setting.is_empty() {
52            return Err(anyhow!("missing site setting name"));
53        }
54        // The admin site settings API returns all settings; we filter by name.
55        let all = self.list_site_settings()?;
56        // Response shape: { "site_settings": [ { "setting": "...", "value": ... }, ... ] }
57        let settings = all
58            .get("site_settings")
59            .and_then(|v| v.as_array())
60            .cloned()
61            .unwrap_or_default();
62        for entry in &settings {
63            let name = entry.get("setting").and_then(|v| v.as_str()).unwrap_or("");
64            if name == setting {
65                let value = entry.get("value").cloned().unwrap_or(Value::Null);
66                let display = match &value {
67                    Value::String(s) => s.clone(),
68                    Value::Null => String::new(),
69                    other => other.to_string(),
70                };
71                return Ok(display);
72            }
73        }
74        Err(anyhow!("setting not found: {}", setting))
75    }
76}