buffr-cef 0.1.1

CEF integration and browser host for buffr.
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

//! buffr internal pages served via the `buffr://` custom scheme.
//!
//! CEF requires custom schemes to be registered **before** `cef::initialize`
//! (via `App::on_register_custom_schemes`). After init, we register a
//! [`SchemeHandlerFactory`] that routes `buffr://` URLs:
//!
//! | URL                   | Content                                   |
//! |---------------------- |------------------------------------------ |
//! | `buffr://new`         | New-tab page (dynamic keybinds/splash).   |
//! | `buffr://settings`    | Settings scaffold (engine routing info).  |
//! | anything else         | Falls back to the new-tab page.           |
//!
//! # Usage
//!
//! 1. Call [`register_buffr_scheme`] from `on_register_custom_schemes`.
//! 2. Call [`register_buffr_handler_factory`] once after `cef::initialize`
//!    succeeds.
//! 3. Use [`NEW_TAB_URL`] wherever a new-tab URL is needed.
//! 4. Use [`SETTINGS_URL`] wherever the settings page URL is needed.

// The wrap_* macros expand to references to bare identifiers like
// `ImplSchemeHandlerFactory`, `WrapSchemeHandlerFactory`, `ResourceHandler`,
// etc. — mirroring how `app.rs` uses `use cef::*`.
use cef::*;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};

// Constants moved to buffr-engine::newtab (Phase 6e, #95).
// Re-exported here so existing `buffr_cef::NEW_TAB_*` imports keep resolving.
pub use buffr_engine::newtab::{
    NEW_TAB_HTML_TEMPLATE, NEW_TAB_KEYBINDS_MARKER, NEW_TAB_SPLASH_ART_MARKER, NEW_TAB_URL,
    SETTINGS_URL,
};

/// Closure invoked on each `buffr://new` request to produce the page
/// bytes. Returning a fresh `Vec<u8>` each call lets the apps layer
/// re-render the dynamic keybinding section without restarting CEF.
pub type NewTabHtmlProvider = Arc<dyn Fn() -> Vec<u8> + Send + Sync>;

/// Closure invoked on each `buffr://settings` request to produce the
/// settings page bytes. Returning a fresh `Vec<u8>` each call lets the
/// page reflect live config state without a restart.
pub type SettingsHtmlProvider = Arc<dyn Fn() -> Vec<u8> + Send + Sync>;

/// Build the default settings page HTML. Contains scaffolding only —
/// engine-rules are listed as read-only text; editing is not yet wired.
///
/// Accepts `engines` (registered engine ids) and `rules` (one
/// `"<pattern> → <engine>"` string per routing rule) so the caller can
/// pass the router state at request time.
pub fn settings_html(engines: &[&str], rules: &[&str]) -> Vec<u8> {
    let engine_rows: String = if engines.is_empty() {
        "<li><em>(none registered)</em></li>".to_string()
    } else {
        engines
            .iter()
            .map(|id| format!("<li><code>{}</code></li>", html_escape(id)))
            .collect::<Vec<_>>()
            .join("\n")
    };
    let rule_rows: String = if rules.is_empty() {
        "<li><em>(no routing rules — all URLs use the default engine)</em></li>".to_string()
    } else {
        rules
            .iter()
            .map(|r| format!("<li><code>{}</code></li>", html_escape(r)))
            .collect::<Vec<_>>()
            .join("\n")
    };
    let html = format!(
        r#"<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8" />
  <title>buffr settings</title>
  <style>
    body {{ font-family: system-ui, sans-serif; margin: 2rem; color: #e0e0e0; background: #1a1a1a; }}
    h1 {{ font-size: 1.6rem; margin-bottom: 0.25rem; }}
    h2 {{ font-size: 1.1rem; margin-top: 1.5rem; color: #aaa; }}
    ul {{ list-style: disc; padding-left: 1.5rem; }}
    code {{ background: #2a2a2a; padding: 0.1em 0.4em; border-radius: 3px; font-size: 0.9em; }}
    .note {{ margin-top: 1.5rem; font-size: 0.85rem; color: #888; border-left: 3px solid #444; padding-left: 0.75rem; }}
  </style>
</head>
<body>
  <h1>buffr settings</h1>
  <h2>Engine routing</h2>
  <p>Registered engines:</p>
  <ul>
    {engine_rows}
  </ul>
  <p>Active routing rules (matched top-to-bottom against URL host):</p>
  <ul>
    {rule_rows}
  </ul>
  <p class="note">
    Editing rules in the UI is not yet implemented — edit <code>config.toml</code> directly
    and restart buffr to apply changes.
  </p>
</body>
</html>"#,
    );
    html.into_bytes()
}

/// HTML-escape `<`, `>`, and `&` in `s` to avoid injection in the
/// settings page. URLs and engine ids are untrusted user config.
fn html_escape(s: &str) -> String {
    s.replace('&', "&amp;")
        .replace('<', "&lt;")
        .replace('>', "&gt;")
}

/// Build a static settings provider that serves placeholder content.
/// Used when the apps layer hasn't wired a live provider yet.
fn static_settings_provider() -> SettingsHtmlProvider {
    Arc::new(|| settings_html(&[], &[]))
}

/// Fallback provider — serves the raw template (with the keybinds
/// marker still in it). Used by callers that don't supply a renderer
/// and by tests.
fn static_provider() -> NewTabHtmlProvider {
    Arc::new(|| NEW_TAB_HTML_TEMPLATE.as_bytes().to_vec())
}

/// Register the `buffr` scheme with CEF.
///
/// Must be called from within `ImplApp::on_register_custom_schemes` **before**
/// `cef::initialize`.
pub fn register_buffr_scheme(registrar: &mut cef::SchemeRegistrar) {
    let scheme = CefString::from("buffr");
    // Standard + Secure + CORS-enabled + Fetch-enabled mirrors the flags
    // Chromium gives its own chrome:// scheme.
    let opts = (SchemeOptions::STANDARD.get_raw()
        | SchemeOptions::SECURE.get_raw()
        | SchemeOptions::CORS_ENABLED.get_raw()
        | SchemeOptions::FETCH_ENABLED.get_raw()) as i32;
    registrar.add_custom_scheme(Some(&scheme), opts);
}

/// Register the scheme handler factory for `buffr://`.
///
/// `provider` is invoked on every `buffr://new` (and unknown path) request.
/// `settings_provider`, if `Some`, is invoked for `buffr://settings`; when
/// `None` a static placeholder is used. Must be called **after**
/// `cef::initialize` returns successfully.
pub fn register_buffr_handler_factory(provider: NewTabHtmlProvider) {
    register_buffr_handler_factory_with_settings(provider, None);
}

/// Register with both a new-tab provider and a settings page provider.
///
/// `settings_provider` is invoked on each `buffr://settings` request so the
/// page can reflect live router state without a restart.
pub fn register_buffr_handler_factory_with_settings(
    provider: NewTabHtmlProvider,
    settings_provider: Option<SettingsHtmlProvider>,
) {
    let settings = settings_provider.unwrap_or_else(static_settings_provider);
    let scheme = CefString::from("buffr");
    let mut factory = BuffrSchemeHandlerFactory::new(provider, settings);
    cef::register_scheme_handler_factory(Some(&scheme), None, Some(&mut factory));
}

/// Register with the static template only (no dynamic content). Useful
/// in tests and as a stop-gap before the apps layer wires its renderer
/// in.
pub fn register_buffr_handler_factory_static() {
    register_buffr_handler_factory(static_provider());
}

// ---------------------------------------------------------------------------
// Factory
// ---------------------------------------------------------------------------

wrap_scheme_handler_factory! {
    pub struct BuffrSchemeHandlerFactory {
        provider: NewTabHtmlProvider,
        settings_provider: SettingsHtmlProvider,
    }

    impl SchemeHandlerFactory {
        fn create(
            &self,
            _browser: Option<&mut cef::Browser>,
            _frame: Option<&mut cef::Frame>,
            _scheme_name: Option<&CefString>,
            request: Option<&mut cef::Request>,
        ) -> Option<cef::ResourceHandler> {
            // Dispatch based on the requested URL path.
            // `buffr://settings` → settings scaffold.
            // Everything else (including `buffr://new`) → new-tab provider.
            let url = request
                .map(|r| CefStringUtf16::from(&r.url()).to_string())
                .unwrap_or_default();
            let bytes = if url.starts_with("buffr://settings") {
                (self.settings_provider)()
            } else {
                (self.provider)()
            };
            Some(BuffrResourceHandler::new(
                Arc::new(bytes),
                Arc::new(AtomicUsize::new(0)),
            ))
        }
    }
}

// ---------------------------------------------------------------------------
// Handler
// ---------------------------------------------------------------------------

wrap_resource_handler! {
    pub struct BuffrResourceHandler {
        bytes: Arc<Vec<u8>>,
        cursor: Arc<AtomicUsize>,
    }

    impl ResourceHandler {
        fn open(
            &self,
            _request: Option<&mut cef::Request>,
            handle_request: Option<&mut ::std::os::raw::c_int>,
            _callback: Option<&mut cef::Callback>,
        ) -> ::std::os::raw::c_int {
            if let Some(hr) = handle_request {
                *hr = 1;
            }
            1
        }

        fn response_headers(
            &self,
            response: Option<&mut Response>,
            response_length: Option<&mut i64>,
            _redirect_url: Option<&mut CefString>,
        ) {
            if let Some(r) = response {
                r.set_status(200);
                let mime = CefString::from("text/html");
                r.set_mime_type(Some(&mime));
            }
            if let Some(len) = response_length {
                *len = self.bytes.len() as i64;
            }
        }

        #[allow(clippy::not_unsafe_ptr_arg_deref)]
        fn read(
            &self,
            data_out: *mut u8,
            bytes_to_read: ::std::os::raw::c_int,
            bytes_read: Option<&mut ::std::os::raw::c_int>,
            _callback: Option<&mut cef::ResourceReadCallback>,
        ) -> ::std::os::raw::c_int {
            let len = self.bytes.len();
            let pos = self.cursor.load(Ordering::SeqCst);
            if pos >= len || bytes_to_read <= 0 {
                if let Some(br) = bytes_read {
                    *br = 0;
                }
                // Return 0 to signal EOF — CEF stops calling read.
                return 0;
            }
            let remaining = len - pos;
            let to_copy = remaining.min(bytes_to_read as usize);
            // Safety: CEF guarantees `data_out` is a valid writable buffer
            // of at least `bytes_to_read` bytes.
            unsafe {
                std::ptr::copy_nonoverlapping(
                    self.bytes.as_ptr().add(pos),
                    data_out,
                    to_copy,
                );
            }
            self.cursor.store(pos + to_copy, Ordering::SeqCst);
            if let Some(br) = bytes_read {
                *br = to_copy as i32;
            }
            1
        }
    }
}