pitchfork-cli 2.9.0

Daemons with DX
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

use axum::{Form, extract::Query, response::Html};
use serde::Deserialize;
use std::path::PathBuf;

use crate::pitchfork_toml::PitchforkToml;
use crate::web::bp;
use crate::web::helpers::html_escape;

fn base_html(title: &str, content: &str) -> String {
    let bp = bp();
    format!(
        r#"<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>{title} - pitchfork</title>
    <link rel="icon" type="image/x-icon" href="{bp}/static/favicon.ico">
    <script src="https://unpkg.com/htmx.org@2.0.4"></script>
    <script src="https://unpkg.com/lucide@latest"></script>
    <link rel="stylesheet" href="{bp}/static/style.css">
</head>
<body>
    <nav>
        <a href="{bp}/" class="nav-brand"><img src="{bp}/static/logo.png" alt="pitchfork" class="logo-icon"> pitchfork</a>
        <div class="nav-links">
            <a href="{bp}/">Dashboard</a>
            <a href="{bp}/logs">Logs</a>
            <a href="{bp}/config" class="active">Config</a>
        </div>
    </nav>
    <main>
        {content}
    </main>
    <script>
        // Initialize Lucide icons on page load
        lucide.createIcons();

        // Re-initialize Lucide icons after HTMX swaps content
        document.body.addEventListener('htmx:afterSwap', function(evt) {{
            lucide.createIcons();
        }});
    </script>
</body>
</html>"#
    )
}

fn get_allowed_paths() -> Vec<PathBuf> {
    PitchforkToml::list_paths()
}

/// Canonicalize a path, handling both existing and non-existing files/directories.
/// Walks up the path tree to find an existing ancestor and canonicalizes from there.
fn safe_canonicalize(path: &PathBuf) -> Option<PathBuf> {
    // First try to canonicalize the full path (works for existing files)
    if let Ok(canonical) = std::fs::canonicalize(path) {
        return Some(canonical);
    }

    // For non-existing paths, walk up the tree to find an existing ancestor
    let mut existing_ancestor = path.clone();
    let mut non_existing_parts: Vec<std::ffi::OsString> = Vec::new();

    while !existing_ancestor.exists() {
        if let Some(file_name) = existing_ancestor.file_name() {
            non_existing_parts.push(file_name.to_os_string());
        } else {
            // Reached root without finding existing ancestor
            return None;
        }
        existing_ancestor = existing_ancestor.parent()?.to_path_buf();
    }

    // Canonicalize the existing ancestor
    let canonical_base = std::fs::canonicalize(&existing_ancestor).ok()?;

    // Rebuild the path with non-existing parts
    let mut result = canonical_base;
    for part in non_existing_parts.into_iter().rev() {
        result = result.join(part);
    }

    Some(result)
}

/// Check if a path is in the allowed list and return the canonical path if valid.
/// Returns the canonical path to use for file operations, preventing TOCTOU attacks.
fn validate_path(path: &PathBuf) -> Option<PathBuf> {
    let allowed = get_allowed_paths();

    // Canonicalize the input path
    let canonical_input = safe_canonicalize(path)?;

    // Check against canonicalized allowed paths
    let is_allowed = allowed.iter().any(|allowed_path| {
        safe_canonicalize(allowed_path)
            .map(|canonical_allowed| canonical_allowed == canonical_input)
            .unwrap_or(false)
    });

    if is_allowed {
        Some(canonical_input)
    } else {
        None
    }
}

pub async fn list() -> Html<String> {
    let bp = bp();
    let paths = get_allowed_paths();

    let mut file_list = String::new();
    for path in paths {
        let exists = path.exists();
        let display = html_escape(&path.display().to_string());
        let status_class = if exists { "exists" } else { "not-created" };
        let status_text = if exists { "EXISTS" } else { "NOT CREATED" };

        let path_str = path.to_string_lossy();
        let encoded_path = urlencoding::encode(&path_str);
        file_list.push_str(&format!(
            r#"
            <div class="config-card {status_class}">
                <div class="config-path">{display}</div>
                <div class="config-status">
                    <span class="status-badge {status_class}">{status_text}</span>
                <a href="{bp}/config/edit?path={encoded_path}" class="btn btn-sm"><i data-lucide="edit" class="icon"></i> Edit</a>
                </div>
            </div>
        "#
        ));
    }

    let content = format!(
        r#"
        <div class="page-header">
            <div>
                <h1>Configuration Files</h1>
                <p class="subtitle">Pitchfork loads configuration from these locations (in order of precedence)</p>
            </div>
        </div>
        <div class="config-list">
            {file_list}
        </div>
        <div class="help-box">
            <strong>💡 Note:</strong> Later files override earlier ones. Click Edit to modify a configuration file.
        </div>
    "#
    );

    Html(base_html("Configuration", &content))
}

#[derive(Deserialize)]
pub struct EditQuery {
    path: String,
}

pub async fn edit(Query(query): Query<EditQuery>) -> Html<String> {
    let bp = bp();
    let path = PathBuf::from(&query.path);

    // Validate and get canonical path to prevent TOCTOU attacks
    let canonical_path = match validate_path(&path) {
        Some(p) => p,
        None => {
            let content = format!(
                r#"
                <h1>Error</h1>
                <p class="error">This file path is not allowed.</p>
        <a href="{bp}/config" class="btn"><i data-lucide="arrow-left" class="icon"></i> Back to Config List</a>
            "#
            );
            return Html(base_html("Error", &content));
        }
    };

    // Use canonical path for file operations
    let content_value = if canonical_path.exists() {
        match std::fs::read_to_string(&canonical_path) {
            Ok(c) => html_escape(&c),
            Err(e) => format!("# Error reading file: {e}"),
        }
    } else {
        r#"# New pitchfork.toml configuration
# Example:
#
# [daemons.myapp]
# run = "npm start"
# retry = 3
# ready_delay = 5
"#
        .to_string()
    };

    let encoded_path = html_escape(&query.path);
    let display_path = html_escape(&path.display().to_string());

    let content = format!(
        r##"
        <div class="page-header">
            <h1>Edit: {display_path}</h1>
            <div class="header-actions">
            <a href="{bp}/config" class="btn btn-sm"><i data-lucide="arrow-left" class="icon"></i> Back</a>
            </div>
        </div>
        <form hx-post="{bp}/config/save" hx-target="#save-result">
            <input type="hidden" name="path" value="{encoded_path}">
            <div class="form-group">
                <textarea name="content" id="config-editor" rows="25">{content_value}</textarea>
            </div>
            <div class="form-actions">
            <button type="button" hx-post="{bp}/config/validate" hx-include="#config-editor, input[name=path]" hx-target="#validation-result" class="btn"><i data-lucide="check-circle" class="icon"></i> Validate</button>
            <button type="submit" class="btn btn-primary"><i data-lucide="save" class="icon"></i> Save</button>
            </div>
            <div id="validation-result"></div>
            <div id="save-result"></div>
        </form>
    "##
    );

    Html(base_html(&format!("Edit: {}", path.display()), &content))
}

#[derive(Deserialize)]
pub struct ConfigForm {
    path: String,
    content: String,
}

pub async fn validate(Form(form): Form<ConfigForm>) -> Html<String> {
    let path = PathBuf::from(&form.path);
    match PitchforkToml::parse_str(&form.content, &path) {
        Ok(config) => {
            let daemon_count = config.daemons.len();
            let daemon_names: Vec<String> = config
                .daemons
                .keys()
                .map(|id| html_escape(id.name()))
                .collect();
            Html(format!(
                r#"
                <div class="validation-success">
                    <strong>Valid!</strong>
                    <p>Found {daemon_count} daemon(s): {}</p>
                </div>
            "#,
                daemon_names.join(", ")
            ))
        }
        Err(e) => Html(format!(
            r#"
                <div class="validation-error">
                    <strong>Invalid config</strong>
                    <pre>{}</pre>
                </div>
            "#,
            html_escape(&format!("{e:?}"))
        )),
    }
}

pub async fn save(Form(form): Form<ConfigForm>) -> Html<String> {
    let path = PathBuf::from(&form.path);

    // Validate and get canonical path to prevent TOCTOU attacks
    let canonical_path = match validate_path(&path) {
        Some(p) => p,
        None => {
            return Html(r#"<div class="error">This file path is not allowed.</div>"#.to_string());
        }
    };

    // Validate config before saving using the real parser so we catch
    // invalid daemon names, bad field types, missing required fields, etc.
    if let Err(e) = PitchforkToml::parse_str(&form.content, &path) {
        return Html(format!(
            r#"
            <div class="validation-error">
                <strong>Cannot save: Invalid config</strong>
                <pre>{}</pre>
            </div>
        "#,
            html_escape(&format!("{e:?}"))
        ));
    }

    // Create parent directories if needed (using canonical path)
    if let Some(parent) = canonical_path.parent()
        && !parent.exists()
        && let Err(e) = std::fs::create_dir_all(parent)
    {
        return Html(format!(
            r#"<div class="error">Failed to create directory: {}</div>"#,
            html_escape(&e.to_string())
        ));
    }

    // Write the file using canonical path to prevent symlink attacks
    match std::fs::write(&canonical_path, &form.content) {
        Ok(_) => Html(format!(
            r#"
            <div class="save-success">
                <strong>Saved successfully!</strong>
                <p>Configuration saved to {}</p>
            </div>
        "#,
            html_escape(&canonical_path.display().to_string())
        )),
        Err(e) => Html(format!(
            r#"
            <div class="error">
                <strong>Failed to save</strong>
                <p>{}</p>
            </div>
        "#,
            html_escape(&e.to_string())
        )),
    }
}