bairelay 1.1.1

RTSP Relay for Reolink Baichuan cameras
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
use anyhow::{Context, Result};
use bairelay_neolink_core::bc_protocol::CameraDriver;

use super::errors::UsageError;
use super::output::{Outcome, ServiceEntry};

/// Which camera network service to inspect or configure.
#[derive(Debug, Clone, Copy)]
pub enum Service {
	Baichuan,
	Http,
	Https,
	Rtmp,
	Rtsp,
	Onvif,
}

impl Service {
	fn label(self) -> &'static str {
		match self {
			Service::Baichuan => "baichuan",
			Service::Http => "http",
			Service::Https => "https",
			Service::Rtmp => "rtmp",
			Service::Rtsp => "rtsp",
			Service::Onvif => "onvif",
		}
	}
}

/// What to do with the service: read, enable, disable, set port, or both.
///
/// Port is `u16` (matching the CLI surface in `cli.rs::ServiceAction`).
/// `0` is rejected at dispatch time as `UsageError` (operator typo
/// guard); the cast to `u32` happens at the `CameraDriver` boundary
/// since bairelay_neolink_core's `set_http(set_on, set_port: Option<u32>)` etc.
/// take a wider type.
#[derive(Debug, Clone)]
pub enum Action {
	Get,
	On,
	Off,
	Port(u16),
	Set { port: u16, enabled: bool },
}

pub async fn run(cam: &dyn CameraDriver, service: Service, action: Action) -> Result<Outcome> {
	// Apply the mutation first (if any), then always read back so the
	// returned Outcome reflects the camera's current state.
	match &action {
		Action::Get => {}
		Action::On => apply_toggle(cam, service, Some(true), None).await?,
		Action::Off => apply_toggle(cam, service, Some(false), None).await?,
		Action::Port(p) => apply_toggle(cam, service, None, Some(*p)).await?,
		Action::Set { port, enabled } => {
			apply_toggle(cam, service, Some(*enabled), Some(*port)).await?
		}
	}

	let (port, enabled) = read(cam, service).await?;
	Ok(Outcome::Service {
		service: service.label().into(),
		port,
		enabled,
	})
}

/// Per-RPC timeout for `run_all`'s six sequential reads. The outer
/// `runner::OP_TIMEOUT = 30 s` covers the whole call; without an
/// inner cap a single hung RPC consumes the entire budget and the
/// operator gets zero partial results. 8 s × 6 = 48 s worst case,
/// 2 s above the outer cap — runner returns ConnectionTimeout
/// before the last RPC fires, which is fine: the operator sees a
/// useful "5 of 6 services answered" output.
const PER_RPC_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(8);

/// Read every service in one shot. Used by `bairelay services <cam>`
/// with no positional service argument. Each failed service becomes an
/// entry with `enabled = None` rather than failing the whole call —
/// older firmwares don't expose all six on every channel, and any
/// individual RPC that exceeds [`PER_RPC_TIMEOUT`] degrades to the
/// same "unknown" entry instead of starving the remaining reads.
pub async fn run_all(cam: &dyn CameraDriver) -> Result<Outcome> {
	const ALL: [Service; 6] = [
		Service::Baichuan,
		Service::Http,
		Service::Https,
		Service::Rtmp,
		Service::Rtsp,
		Service::Onvif,
	];
	let mut services = Vec::with_capacity(ALL.len());
	for svc in ALL {
		match tokio::time::timeout(PER_RPC_TIMEOUT, read(cam, svc)).await {
			Ok(Ok((port, enabled))) => services.push(ServiceEntry {
				name: svc.label().into(),
				port,
				enabled,
			}),
			Ok(Err(_)) | Err(_) => services.push(ServiceEntry {
				name: svc.label().into(),
				port: 0,
				enabled: None,
			}),
		}
	}
	Ok(Outcome::ServiceList { services })
}

async fn apply_toggle(
	cam: &dyn CameraDriver,
	service: Service,
	set_on: Option<bool>,
	set_port: Option<u16>,
) -> Result<()> {
	if matches!(set_port, Some(0)) {
		return Err(UsageError::new(format!("port 0 is not valid for {}", service.label())).into());
	}
	let set_port = set_port.map(u32::from);
	match service {
		Service::Baichuan => cam
			.set_serverport(set_on, set_port)
			.await
			.context("set_serverport failed")?,
		Service::Http => cam
			.set_http(set_on, set_port)
			.await
			.context("set_http failed")?,
		Service::Https => cam
			.set_https(set_on, set_port)
			.await
			.context("set_https failed")?,
		Service::Rtmp => cam
			.set_rtmp(set_on, set_port)
			.await
			.context("set_rtmp failed")?,
		Service::Rtsp => cam
			.set_rtsp(set_on, set_port)
			.await
			.context("set_rtsp failed")?,
		Service::Onvif => cam
			.set_onvif(set_on, set_port)
			.await
			.context("set_onvif failed")?,
	}
	Ok(())
}

async fn read(cam: &dyn CameraDriver, service: Service) -> Result<(u32, Option<bool>)> {
	let (port, enable) = match service {
		Service::Baichuan => {
			let s = cam
				.get_serverport()
				.await
				.context("get_serverport failed")?;
			(s.port, s.enable)
		}
		Service::Http => {
			let s = cam.get_http().await.context("get_http failed")?;
			(s.port, s.enable)
		}
		Service::Https => {
			let s = cam.get_https().await.context("get_https failed")?;
			(s.port, s.enable)
		}
		Service::Rtmp => {
			let s = cam.get_rtmp().await.context("get_rtmp failed")?;
			(s.port, s.enable)
		}
		Service::Rtsp => {
			let s = cam.get_rtsp().await.context("get_rtsp failed")?;
			(s.port, s.enable)
		}
		Service::Onvif => {
			let s = cam.get_onvif().await.context("get_onvif failed")?;
			(s.port, s.enable)
		}
	};
	Ok((port, enable.map(|e| e != 0)))
}

#[cfg(test)]
mod tests {
	use super::*;
	use bairelay_neolink_core::bc::xml::{
		HttpPort, HttpsPort, OnvifPort, RtmpPort, RtspPort, ServerPort,
	};
	use bairelay_neolink_core::bc_protocol::{Error, FakeCameraBuilder};

	fn all_enabled_fake() -> std::sync::Arc<bairelay_neolink_core::bc_protocol::FakeCamera> {
		FakeCameraBuilder::new()
			.with_serverport(|| {
				Ok(ServerPort {
					port: 9000,
					enable: Some(1),
					..Default::default()
				})
			})
			.with_http(|| {
				Ok(HttpPort {
					port: 80,
					enable: Some(1),
					..Default::default()
				})
			})
			.with_https(|| {
				Ok(HttpsPort {
					port: 443,
					enable: Some(0),
					..Default::default()
				})
			})
			.with_rtsp(|| {
				Ok(RtspPort {
					port: 554,
					enable: Some(1),
					..Default::default()
				})
			})
			.with_rtmp(|| {
				Ok(RtmpPort {
					port: 1935,
					enable: Some(1),
					..Default::default()
				})
			})
			.with_onvif(|| {
				Ok(OnvifPort {
					port: 8000,
					enable: Some(1),
					..Default::default()
				})
			})
			.build()
	}

	#[tokio::test]
	async fn service_label_all_variants() {
		assert_eq!(Service::Baichuan.label(), "baichuan");
		assert_eq!(Service::Http.label(), "http");
		assert_eq!(Service::Https.label(), "https");
		assert_eq!(Service::Rtmp.label(), "rtmp");
		assert_eq!(Service::Rtsp.label(), "rtsp");
		assert_eq!(Service::Onvif.label(), "onvif");
	}

	#[tokio::test]
	async fn run_get_http_returns_current_state() {
		let fake = all_enabled_fake();
		let outcome = run(&*fake, Service::Http, Action::Get).await.unwrap();
		assert_eq!(
			outcome,
			Outcome::Service {
				service: "http".into(),
				port: 80,
				enabled: Some(true),
			}
		);
	}

	#[tokio::test]
	async fn run_on_baichuan_records_set_call() {
		let fake = all_enabled_fake();
		let _ = run(&*fake, Service::Baichuan, Action::On).await.unwrap();
		assert_eq!(
			*fake.calls().set_serverport.lock().unwrap(),
			vec![(Some(true), None)]
		);
	}

	#[tokio::test]
	async fn run_off_https_records_set_call() {
		let fake = all_enabled_fake();
		let _ = run(&*fake, Service::Https, Action::Off).await.unwrap();
		assert_eq!(
			*fake.calls().set_https.lock().unwrap(),
			vec![(Some(false), None)]
		);
	}

	#[tokio::test]
	async fn run_port_rtsp_records_set_call() {
		let fake = all_enabled_fake();
		let _ = run(&*fake, Service::Rtsp, Action::Port(8554))
			.await
			.unwrap();
		assert_eq!(
			*fake.calls().set_rtsp.lock().unwrap(),
			vec![(None, Some(8554))]
		);
	}

	#[tokio::test]
	async fn run_set_rtmp_records_both_args() {
		let fake = all_enabled_fake();
		let _ = run(
			&*fake,
			Service::Rtmp,
			Action::Set {
				port: 1935,
				enabled: false,
			},
		)
		.await
		.unwrap();
		assert_eq!(
			*fake.calls().set_rtmp.lock().unwrap(),
			vec![(Some(false), Some(1935))]
		);
	}

	#[tokio::test]
	async fn run_onvif_set_records_call() {
		let fake = all_enabled_fake();
		let _ = run(&*fake, Service::Onvif, Action::On).await.unwrap();
		assert_eq!(
			*fake.calls().set_onvif.lock().unwrap(),
			vec![(Some(true), None)]
		);
	}

	#[tokio::test]
	async fn run_http_set_records_call() {
		let fake = all_enabled_fake();
		let _ = run(&*fake, Service::Http, Action::On).await.unwrap();
		assert_eq!(
			*fake.calls().set_http.lock().unwrap(),
			vec![(Some(true), None)]
		);
	}

	#[tokio::test]
	async fn run_all_lists_all_six_services() {
		let fake = all_enabled_fake();
		let outcome = run_all(&*fake).await.unwrap();
		let Outcome::ServiceList { services } = outcome else {
			panic!("wrong variant");
		};
		assert_eq!(services.len(), 6);
		let names: Vec<_> = services.iter().map(|s| s.name.as_str()).collect();
		assert_eq!(
			names,
			vec!["baichuan", "http", "https", "rtmp", "rtsp", "onvif"]
		);
	}

	#[tokio::test]
	async fn run_all_failing_service_becomes_unknown_entry() {
		let fake = FakeCameraBuilder::new()
			.with_serverport(|| Err(Error::Other("bc down")))
			.with_http(|| {
				Ok(HttpPort {
					port: 80,
					enable: Some(1),
					..Default::default()
				})
			})
			.with_https(|| Err(Error::Other("none")))
			.with_rtsp(|| {
				Ok(RtspPort {
					port: 554,
					enable: None,
					..Default::default()
				})
			})
			.with_rtmp(|| Err(Error::Other("none")))
			.with_onvif(|| Err(Error::Other("none")))
			.build();
		let outcome = run_all(&*fake).await.unwrap();
		let Outcome::ServiceList { services } = outcome else {
			panic!("wrong variant");
		};
		// baichuan failed
		assert_eq!(services[0].name, "baichuan");
		assert_eq!(services[0].port, 0);
		assert!(services[0].enabled.is_none());
		// http ok
		assert_eq!(services[1].name, "http");
		assert_eq!(services[1].port, 80);
		assert_eq!(services[1].enabled, Some(true));
		// rtsp port returned but enable=None
		assert_eq!(services[4].name, "rtsp");
		assert_eq!(services[4].port, 554);
		assert!(services[4].enabled.is_none());
	}

	#[tokio::test]
	async fn run_port_zero_is_usage_error() {
		// Operator typo guard: `bairelay services cam http port 0` would
		// otherwise reach the camera and surface as an opaque
		// camera-side rejection. Map to UsageError → EXIT_USAGE = 2 so
		// CI scripts can branch cleanly.
		let fake = all_enabled_fake();
		let err = run(&*fake, Service::Http, Action::Port(0))
			.await
			.expect_err("port 0 must be rejected");
		assert!(format!("{err:#}").contains("port 0 is not valid"));
		// Camera was never asked.
		assert!(fake.calls().set_http.lock().unwrap().is_empty());
	}

	#[tokio::test]
	async fn run_set_with_port_zero_is_usage_error() {
		let fake = all_enabled_fake();
		let err = run(
			&*fake,
			Service::Rtsp,
			Action::Set {
				port: 0,
				enabled: true,
			},
		)
		.await
		.expect_err("port 0 must be rejected");
		assert!(format!("{err:#}").contains("port 0 is not valid"));
		assert!(fake.calls().set_rtsp.lock().unwrap().is_empty());
	}
}