euv_ui/component/camera/hook/

impl.rs

use super::*;

thread_local! {
    /// Cache of the `BarcodeDetector#detect` `Function`. There is at
    /// most one active `BarcodeDetector` per scan session (created in
    /// `start_qr_scan`), so a single slot is enough. The `Function` is
    /// fetched once via `Reflect::get(detector, "detect")` and reused
    /// across every scan tick — the per-tick `Reflect::get` +
    /// `JsValue::from_str("detect")` allocation is eliminated.
    static DETECT_FN_CACHE: RefCell<Option<Function>> = const { RefCell::new(None) };
}

/// Implementation of camera functionality.
impl UseEuvCamera {
    /// Creates camera state for controlling camera stream and QR scanning.
    ///
    /// # Returns
    ///
    /// - `UseEuvCamera` - The camera state.
    pub fn use_camera_state() -> UseEuvCamera {
        UseEuvCamera::new(
            App::use_signal(|| false),
            App::use_signal(|| false),
            App::use_signal(String::new),
            App::use_signal(EuvCameraFacing::default),
            App::use_signal(String::new),
            App::use_signal(|| None),
        )
    }

    /// Requests camera access from the browser and binds the resulting
    /// media stream to the `<video>` element identified by the given CSS selector.
    ///
    /// Uses `navigator.mediaDevices.getUserMedia` with a video-only
    /// constraint. On success the stream is assigned as `srcObject` on
    /// the target video element and `play()` is called. Errors are
    /// returned as human-readable strings.
    ///
    /// # Arguments
    ///
    /// - `&str` - The CSS selector of the `<video>` element to bind the stream to.
    /// - `EuvCameraFacing` - The desired camera facing direction.
    ///
    /// # Returns
    ///
    /// - `Result<(), String>` - `Ok(())` on success, or an error message on failure.
    pub(crate) fn open(video_selector: &str, facing: EuvCameraFacing) -> Result<(), String> {
        let Some(window_value) = window() else {
            return Err(CAMERA_NO_WINDOW_ERROR.to_string());
        };
        let navigator: Navigator = window_value.navigator();
        let media_devices: MediaDevices = navigator
            .media_devices()
            .map_err(|error: JsValue| format!("{error:?}"))?;
        let constraints: MediaStreamConstraints = MediaStreamConstraints::new();
        let facing_mode: &str = match facing {
            EuvCameraFacing::User => CAMERA_FACING_MODE_USER,
            EuvCameraFacing::Environment => CAMERA_FACING_MODE_ENVIRONMENT,
        };
        let video_constraint: Object = Object::new();
        let _: Result<bool, JsValue> = Reflect::set(
            &video_constraint,
            &JsValue::from_str(CAMERA_FACING_MODE_KEY),
            &JsValue::from_str(facing_mode),
        );
        constraints.set_video(&video_constraint);
        constraints.set_audio(&JsValue::from_bool(false));
        let promise: Promise = media_devices
            .get_user_media_with_constraints(&constraints)
            .map_err(|error: JsValue| format!("{error:?}"))?;
        let selector: String = video_selector.to_string();
        let on_fulfilled: Closure<dyn FnMut(JsValue)> =
            Closure::wrap(Box::new(move |stream_value: JsValue| {
                let stream: MediaStream = stream_value.unchecked_into();
                let Some(window_value) = window() else {
                    return;
                };
                let Some(document) = window_value.document() else {
                    return;
                };
                if let Some(element) = document.query_selector(&selector).ok().flatten() {
                    let video_element: HtmlVideoElement = element.unchecked_into();
                    video_element.set_src_object(Some(&stream));
                    let _: Result<Promise, JsValue> = video_element.play();
                }
            }));
        let on_rejected: Closure<dyn FnMut(JsValue)> =
            Closure::wrap(Box::new(move |error: JsValue| {
                console::log_2(&JsValue::from_str(CAMERA_LOG_PREFIX), &error);
            }));
        let _: Promise = promise.then(&on_fulfilled).catch(&on_rejected);
        on_fulfilled.forget();
        on_rejected.forget();
        Ok(())
    }

    /// Stops all tracks on the media stream currently attached to the
    /// `<video>` element identified by the given CSS selector.
    ///
    /// Iterates over `videoElement.srcObject.getTracks()` and calls
    /// `stop()` on each one, then clears `srcObject`.
    ///
    /// # Arguments
    ///
    /// - `&str` - The CSS selector of the `<video>` element whose stream should be stopped.
    pub(crate) fn close(video_selector: &str) {
        let Some(window_value) = window() else {
            return;
        };
        let Some(document) = window_value.document() else {
            return;
        };
        if let Some(element) = document.query_selector(video_selector).ok().flatten() {
            let video_element: HtmlVideoElement = element.unchecked_into();
            if let Some(stream) = video_element.src_object() {
                let stream: MediaStream = stream.unchecked_into();
                let tracks: Array = stream.get_tracks();
                for track_value in tracks.iter() {
                    let track: MediaStreamTrack = track_value.unchecked_into();
                    track.stop();
                }
            }
            video_element.set_src_object(None);
        }
    }

    /// Opens the camera, starts QR code scanning immediately, and updates
    /// the state signals accordingly.
    ///
    /// If the camera fails to open, the error message signal is set.
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    pub(crate) fn open_and_scan(self, config: Option<&EuvCameraConfig>) {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        self.get_camera_loading().set(true);
        self.get_error_message().set(String::new());
        self.get_scan_result().set(String::new());
        let facing: EuvCameraFacing = self.get_facing().get();
        let result: Result<(), String> = Self::open(cfg.video_selector, facing);
        match result {
            Ok(()) => {
                self.get_camera_open().set(true);
                self.get_camera_loading().set(false);
                if cfg.auto_scan {
                    self.start_qr_scan(config);
                }
            }
            Err(error) => {
                self.get_error_message().set(error);
                self.get_camera_loading().set(false);
                if let Some(ref on_error) = cfg.on_error {
                    on_error(self.get_error_message().get());
                }
            }
        }
    }

    /// Switches the camera to the opposite facing direction and restarts
    /// QR code scanning.
    ///
    /// Closes the current camera stream and reopens with the new facing
    /// mode. On success, QR code scanning is started automatically.
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    pub(crate) fn switch(self, config: Option<&EuvCameraConfig>) {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        self.stop_qr_scan();
        Self::close(cfg.video_selector);
        self.get_camera_open().set(false);
        let new_facing: EuvCameraFacing = match self.get_facing().get() {
            EuvCameraFacing::User => EuvCameraFacing::Environment,
            EuvCameraFacing::Environment => EuvCameraFacing::User,
        };
        self.get_facing().set(new_facing);
        self.get_camera_loading().set(true);
        self.get_error_message().set(String::new());
        let result: Result<(), String> = Self::open(cfg.video_selector, new_facing);
        match result {
            Ok(()) => {
                self.get_camera_open().set(true);
                self.get_camera_loading().set(false);
                if cfg.auto_scan {
                    self.start_qr_scan(config);
                }
            }
            Err(error) => {
                self.get_error_message().set(error);
                self.get_camera_loading().set(false);
            }
        }
    }

    /// Returns the cached `BarcodeDetector#detect` `Function`, populating
    /// the cache on first lookup.
    ///
    /// The original code called `Reflect::get(detector, "detect")` every
    /// scan tick, allocating a fresh `JsValue::from_str("detect")` JS
    /// string and crossing the FFI boundary. The cached `Function` is
    /// reused for the lifetime of the scan session.
    ///
    /// # Arguments
    ///
    /// - `&JsValue` - The `BarcodeDetector` instance.
    ///
    /// # Returns
    ///
    /// - `Function` - A clone of the cached `detect` function, or a
    ///   no-op `Promise.resolve([])` fallback when lookup fails.
    fn cached_detect_fn(detector: &JsValue) -> Function {
        DETECT_FN_CACHE.with(|cache: &RefCell<Option<Function>>| {
            // The read guard here and the write guard below are two separate
            // statements, so they never overlap: the `if let` scrutinee
            // temporary is dropped when the `if let` ends, before the
            // `Reflect::get` lookup. `Reflect::get` on a `BarcodeDetector` can
            // run a prototype getter installed by page code, which is why
            // nothing may hold a cache borrow across it.
            if let Some(function) = cache.borrow().as_ref() {
                return function.clone();
            }
            let function: Function =
                Reflect::get(detector, &JsValue::from_str(CAMERA_DETECT_FN_KEY))
                    .ok()
                    .and_then(|value: JsValue| value.dyn_into::<Function>().ok())
                    .unwrap_or_else(|| Function::new_no_args(CAMERA_DETECT_FALLBACK_BODY));
            *cache.borrow_mut() = Some(function.clone());
            function
        })
    }

    /// Starts a periodic QR code scan using the browser `BarcodeDetector` API.
    ///
    /// If the browser does not support `BarcodeDetector`, the scan is not
    /// started and the error signal is set. On each interval tick, captures
    /// the current video frame and attempts to detect a QR code. If a QR
    /// code is found, the result is stored in `scan_result`. If the result
    /// is an HTTP URL, the browser navigates directly to that URL.
    ///
    /// The on_detected / on_scan_error `Closure`s are created once per
    /// scan session and stored in `ON_QR_DETECTED_CLOSURE` /
    /// `ON_QR_SCAN_ERROR_CLOSURE` thread-locals; per-tick
    /// `Closure::wrap` + `.forget()` is eliminated (memory leak fix
    /// from audit #26). The `detect` method is cached in
    /// `DETECT_FN_CACHE` (audit #26 per-tick `Reflect::get` cost).
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    pub(crate) fn start_qr_scan(self, config: Option<&EuvCameraConfig>) {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        let Some(window_value) = window() else {
            return;
        };
        let barcode_detector_key: JsValue = JsValue::from_str(CAMERA_BARCODE_DETECTOR_KEY);
        let barcode_detector_constructor: Function =
            match Reflect::get(&window_value, &barcode_detector_key) {
                Ok(value) if !value.is_undefined() && !value.is_null() => value.unchecked_into(),
                _ => {
                    self.get_error_message()
                        .set(CAMERA_BARCODE_UNSUPPORTED_MESSAGE.to_string());
                    return;
                }
            };
        let formats_array: Array = Array::new();
        formats_array.push(&JsValue::from_str(CAMERA_BARCODE_FORMAT_QR_CODE));
        let init_object: Object = Object::new();
        let _: Result<bool, JsValue> = Reflect::set(
            &init_object,
            &JsValue::from_str(CAMERA_BARCODE_FORMATS_KEY),
            &formats_array,
        );
        let args_array: Array = Array::new();
        args_array.push(&init_object.into());
        let detector: JsValue = match Reflect::construct(&barcode_detector_constructor, &args_array)
        {
            Ok(value) => value,
            Err(error) => {
                self.get_error_message()
                    .set(format!("Failed to create BarcodeDetector: {error:?}"));
                return;
            }
        };
        let video_selector: Rc<String> = Rc::new(cfg.video_selector.to_string());
        let on_qr_detected: Option<QrDetectedCallback> = cfg.on_qr_detected.clone();
        let self_for_closure: UseEuvCamera = self;
        let video_selector_for_closure: Rc<String> = video_selector.clone();
        let on_qr_detected_for_closure: Option<QrDetectedCallback> = on_qr_detected.clone();
        let on_detected: Closure<dyn FnMut(JsValue)> =
            Closure::wrap(Box::new(move |barcodes_value: JsValue| {
                let barcodes: Array = match barcodes_value.dyn_into::<Array>() {
                    Ok(array) => array,
                    Err(_) => return,
                };
                if barcodes.length() == 0 {
                    return;
                }
                let text: Option<String> = barcodes.get(0).as_string().or_else(|| {
                    Reflect::get(
                        &barcodes.get(0),
                        &JsValue::from_str(CAMERA_BARCODE_RAW_VALUE_KEY),
                    )
                    .ok()
                    .and_then(|v: JsValue| v.as_string())
                });
                if let Some(text) = text {
                    self_for_closure.get_scan_result().set(text.clone());
                    if let Some(ref callback) = on_qr_detected_for_closure {
                        callback(&text);
                    }
                    if Self::is_valid_qr_url(&text) {
                        self_for_closure.stop_qr_scan();
                        Self::close(&video_selector_for_closure);
                        self_for_closure.get_camera_open().set(false);
                        Self::navigate_qr_url(&text);
                    }
                }
            }));
        let on_scan_error: Closure<dyn FnMut(JsValue)> =
            Closure::wrap(Box::new(move |_error: JsValue| {}));
        let detect_fn: Function = Self::cached_detect_fn(&detector);
        // Cache the video element across scan ticks: `query_selector` costs
        // one JS crossing plus a JS-side selector parse per tick; the element
        // is stable for a scan session and is re-validated cheaply via
        // `is_connected` (re-resolved if the DOM node was swapped).
        let video_element_cache: Rc<RefCell<Option<HtmlVideoElement>>> =
            Rc::new(RefCell::new(None));
        let handle: IntervalHandle = App::use_interval(cfg.scan_interval_millis, move || {
            let on_detected: &Closure<dyn FnMut(JsValue)> = &on_detected;
            let on_scan_error: &Closure<dyn FnMut(JsValue)> = &on_scan_error;
            let detect_fn: &Function = &detect_fn;
            let Some(window_value) = window() else {
                return;
            };
            let Some(document) = window_value.document() else {
                return;
            };
            let video_element: HtmlVideoElement = {
                // `is_connected` and `query_selector` cross into the DOM, and a
                // `Node.prototype.isConnected` getter installed by page code runs
                // arbitrary JS in between. Holding a `RefMut` across either lets a
                // re-entrant scan tick reach `borrow_mut` under a live guard and
                // abort the instance, so the cached element is cloned out under a
                // read borrow that is dropped before any DOM call. A contended
                // cell reports "no cache" and the element is simply re-resolved.
                let cached: Option<HtmlVideoElement> = video_element_cache
                    .try_borrow()
                    .map(|cache: Ref<'_, Option<HtmlVideoElement>>| cache.clone())
                    .unwrap_or_default();
                match cached {
                    Some(element) if element.is_connected() => element,
                    _ => {
                        let Some(element) = document.query_selector(&video_selector).ok().flatten()
                        else {
                            return;
                        };
                        let resolved: HtmlVideoElement = element.unchecked_into();
                        // Best-effort store: the element is only an optimisation
                        // and is re-validated by `is_connected` on the next tick.
                        // Skipping a contended write costs one `query_selector`;
                        // panicking would cost the whole instance.
                        if let Ok(mut cache) = video_element_cache.try_borrow_mut() {
                            *cache = Some(resolved.clone());
                        }
                        resolved
                    }
                }
            };
            if video_element.ready_state() != HtmlMediaElement::HAVE_ENOUGH_DATA {
                return;
            }
            let promise: Promise = match detect_fn.call1(&detector, &video_element) {
                Ok(result) => result.into(),
                Err(_) => return,
            };
            let _: Promise = promise.then(on_detected).catch(on_scan_error);
        });
        self_for_closure.get_scan_handle().set(Some(handle));
    }

    /// Stops the periodic QR code scan timer if it is running.
    pub(crate) fn stop_qr_scan(self) {
        if let Some(handle) = self.get_scan_handle().get() {
            handle.clear();
            self.get_scan_handle().set(None);
        }
        DETECT_FN_CACHE.with(|cache: &RefCell<Option<Function>>| {
            *cache.borrow_mut() = None;
        });
    }

    /// Checks whether the given string is a valid QR code URL that the
    /// camera scanner should navigate to.
    ///
    /// A valid URL must start with `http://` or `https://`.
    ///
    /// # Arguments
    ///
    /// - `&str` - The string to check.
    ///
    /// # Returns
    ///
    /// - `bool` - `true` if the string is a valid HTTP or HTTPS URL.
    pub(crate) fn is_valid_qr_url(text: &str) -> bool {
        text.starts_with(CAMERA_URL_PREFIX_HTTP) || text.starts_with(CAMERA_URL_PREFIX_HTTPS)
    }

    /// Extracts the hostname from an absolute URL string using pure Rust
    /// string parsing.
    ///
    /// Supports `http://` and `https://` schemes, strips IPv6 brackets,
    /// and ignores the port portion. Returns an empty string if the URL
    /// format is not recognised.
    ///
    /// # Arguments
    ///
    /// - `&str` - The absolute URL to parse.
    ///
    /// # Returns
    ///
    /// - `String` - The extracted hostname, or an empty string on failure.
    pub(crate) fn extract_hostname(url: &str) -> String {
        let rest: &str = if let Some(stripped) = url.strip_prefix(CAMERA_URL_PREFIX_HTTPS) {
            stripped
        } else if let Some(stripped) = url.strip_prefix(CAMERA_URL_PREFIX_HTTP) {
            stripped
        } else {
            return String::new();
        };
        let authority: &str = rest.split('/').next().unwrap_or("");
        let host_with_brackets: &str = authority.split(':').next().unwrap_or("");
        if let Some(stripped) = host_with_brackets.strip_prefix('[')
            && let Some(inner) = stripped.strip_suffix(']')
        {
            return inner.to_string();
        }
        host_with_brackets.to_string()
    }

    /// Checks whether the given hostname is a private or loopback IP
    /// address.
    ///
    /// Recognises loopback (`127.0.0.0/8`), link-local (`169.254.0.0/16`),
    /// RFC 1918 private ranges (`10.0.0.0/8`, `172.16.0.0/12`,
    /// `192.168.0.0/16`), and the `localhost` hostname.
    ///
    /// # Arguments
    ///
    /// - `&str` - The hostname to inspect.
    ///
    /// # Returns
    ///
    /// - `bool` - `true` if the hostname is a private/internal address.
    pub(crate) fn is_private_host(hostname: &str) -> bool {
        if hostname.is_empty() {
            return false;
        }
        if hostname.eq_ignore_ascii_case(CAMERA_LOCALHOST_HOSTNAME) {
            return true;
        }
        let octets: Vec<&str> = hostname.split('.').collect();
        if octets.len() != 4 {
            return false;
        }
        let Ok(first) = octets[0].parse::<u8>() else {
            return false;
        };
        let Ok(second) = octets[1].parse::<u8>() else {
            return false;
        };
        if first == 127 {
            return true;
        }
        if first == 10 {
            return true;
        }
        if first == 172 && (16..=31).contains(&second) {
            return true;
        }
        if first == 192 && second == 168 {
            return true;
        }
        if first == 169 && second == 254 {
            return true;
        }
        false
    }

    /// Navigates to the URL detected from a QR code.
    ///
    /// If the URL points to the same origin (current host), extracts the
    /// hash fragment route and navigates internally using `navigate`.
    /// If the URL host is a private/internal IP address, performs a full
    /// page navigation via `location.href` within the current browser.
    /// Otherwise (external public URL), opens the link in the system
    /// browser via `window.open` so the user stays in the app.
    ///
    /// # Arguments
    ///
    /// - `&str` - The URL to navigate to.
    pub(crate) fn navigate_qr_url(url: &str) {
        let Some(window_value) = window() else {
            return;
        };
        let location: Location = window_value.location();
        let current_hostname: String = location.hostname().unwrap_or_default();
        let url_hostname: String = Self::extract_hostname(url);
        if url_hostname == current_hostname
            && let Some(fragment) = url.split('#').nth(1)
        {
            let route: &str = if fragment.is_empty() { "/" } else { fragment };
            Router::navigate(route);
            return;
        }
        if Self::is_private_host(&url_hostname) {
            let _: Result<(), JsValue> = window_value.location().set_href(url);
            return;
        }
        if let Ok(open_fn) = Reflect::get(&window_value, &JsValue::from_str(CAMERA_WINDOW_OPEN_KEY))
            .and_then(|value: JsValue| value.dyn_into::<Function>())
        {
            let _: Result<JsValue, JsValue> = open_fn.call2(
                &window_value,
                &JsValue::from_str(url),
                &JsValue::from_str(SYSTEM_BROWSER_TARGET),
            );
        }
    }

    /// Creates a click event handler that closes the camera stream and
    /// stops the QR code scan.
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    ///
    /// # Returns
    ///
    /// - `Option<Rc<dyn Fn(Event)>>` - A click event handler.
    pub fn on_close(self, config: Option<&EuvCameraConfig>) -> Option<Rc<dyn Fn(Event)>> {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        Some(Rc::new(move |_: Event| {
            self.stop_qr_scan();
            Self::close(cfg.video_selector);
            self.get_camera_open().set(false);
            self.get_scan_result().set(String::new());
        }))
    }

    /// Creates a click event handler that switches the camera facing direction.
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    ///
    /// # Returns
    ///
    /// - `Option<Rc<dyn Fn(Event)>>` - A click event handler.
    pub fn on_switch(self, config: Option<&EuvCameraConfig>) -> Option<Rc<dyn Fn(Event)>> {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        Some(Rc::new(move |_: Event| {
            self.switch(Some(&cfg));
        }))
    }

    /// Creates a click event handler that opens the camera and starts QR scanning.
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    ///
    /// # Returns
    ///
    /// - `Option<Rc<dyn Fn(Event)>>` - A click event handler.
    pub fn on_open(self, config: Option<&EuvCameraConfig>) -> Option<Rc<dyn Fn(Event)>> {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        Some(Rc::new(move |_: Event| {
            self.open_and_scan(Some(&cfg));
        }))
    }

    /// Registers a cleanup callback that closes the camera stream and
    /// stops the QR code scan timer when the component unmounts or
    /// the page route switches away.
    ///
    /// # Arguments
    ///
    /// - `Option<&EuvCameraConfig>` - Optional camera configuration.
    pub fn cleanup(self, config: Option<&EuvCameraConfig>) {
        let cfg: EuvCameraConfig =
            config.map_or_else(EuvCameraConfig::default, |c: &EuvCameraConfig| c.clone());
        App::use_cleanup(move || {
            self.stop_qr_scan();
            Self::close(cfg.video_selector);
            self.get_camera_open().set(false);
            self.get_camera_loading().set(false);
            self.get_error_message().set(String::new());
            self.get_scan_result().set(String::new());
        });
    }
}

/// Default implementation for `EuvCameraConfig`.
impl Default for EuvCameraConfig {
    /// Constructs a default [`EuvCameraConfig`] value.
    fn default() -> Self {
        EuvCameraConfig {
            video_selector: CAMERA_VIDEO_SELECTOR,
            scan_interval_millis: CAMERA_SCAN_INTERVAL_MILLIS,
            auto_scan: true,
            on_qr_detected: None,
            on_error: None,
        }
    }
}