Skip to main content

active_call/
app.rs

1use crate::{
2    call::{ActiveCallRef, sip::Invitation},
3    callrecord::{
4        CallRecordFormatter, CallRecordManagerBuilder, CallRecordSender, DefaultCallRecordFormatter,
5    },
6    config::Config,
7    locator::RewriteTargetLocator,
8    useragent::{
9        RegisterOption,
10        invitation::{
11            FnCreateInvitationHandler, PendingDialog, PendingDialogGuard,
12            default_create_invite_handler,
13        },
14        peer_learning::{PeerAddressLearner, SharedLearnedPeers},
15        public_address::{
16            LearningMessageInspector, SharedPublicAddress, build_contact, build_public_contact_uri,
17            find_local_addr_for_uri,
18        },
19        registration::{RegistrationHandle, UserCredential},
20    },
21};
22
23use crate::media::{cache::set_cache_dir, engine::StreamEngine};
24use anyhow::Result;
25use arc_swap::ArcSwap;
26use async_trait::async_trait;
27use chrono::{DateTime, Local};
28use futures::FutureExt;
29use humantime::parse_duration;
30use rsipstack::rsip::prelude::HeadersExt;
31use rsipstack::rsip::{Accept, Method, typed};
32use rsipstack::transaction::{
33    Endpoint, TransactionReceiver,
34    endpoint::{TargetLocator, TransportEventInspector},
35};
36use rsipstack::transport::transport_layer::DomainResolver;
37use rsipstack::{dialog::dialog_layer::DialogLayer, transaction::endpoint::MessageInspector};
38use rsipstack::{
39    rsip::{Host, HostWithPort},
40    transport::SipAddr,
41};
42use std::future::pending;
43use std::panic::{AssertUnwindSafe, catch_unwind};
44use std::str::FromStr;
45use std::sync::{Arc, RwLock};
46use std::time::Duration;
47use std::{collections::HashMap, net::SocketAddr};
48use std::{collections::HashSet, time::Instant};
49use std::{
50    path::Path,
51    sync::atomic::{AtomicBool, AtomicU64, Ordering},
52};
53use tokio::select;
54use tokio::sync::Mutex;
55use tokio_util::sync::CancellationToken;
56use tracing::{debug, info, warn};
57
58/// Generates a short unique session id for incoming calls, e.g. `s.3f9a2b1c4d5e`,
59/// instead of reusing the raw SIP dialog-id string. Collisions with live
60/// sessions are retried (practically impossible with 48 bits of randomness).
61fn generate_short_session_id(invitation: &Invitation) -> String {
62    loop {
63        let uuid = uuid::Uuid::new_v4().simple().to_string();
64        let session_id = format!("s.{}", &uuid);
65        if !invitation.session_exists(&session_id) {
66            return session_id;
67        }
68    }
69}
70
71/// Extracts the network source of a received request from its top Via header:
72/// the IP comes from the `received` parameter (populated by our transport for
73/// NAT'd peers) or the sent-by host when it is an IP literal; the hostname is
74/// the sent-by host as written. Port is intentionally ignored (carrier source
75/// ports change between probes).
76fn extract_via_source(request: &rsipstack::rsip::Request) -> (Option<std::net::IpAddr>, String) {
77    use rsipstack::rsip::ToTypedHeader;
78    let Ok(via) = request.via_header().and_then(|v| v.typed()) else {
79        return (None, String::new());
80    };
81    let source_ip = via
82        .received()
83        .and_then(|r| r.ok())
84        .or_else(|| match &via.sent_by().host {
85            rsipstack::rsip::Host::IpAddr(ip) => Some(*ip),
86            _ => None,
87        });
88    (source_ip, via.sent_by().host.to_string())
89}
90
91pub struct AppStateInner {
92    pub config: Arc<Config>,
93    pub token: CancellationToken,
94    pub stream_engine: Arc<StreamEngine>,
95    pub callrecord_sender: Option<CallRecordSender>,
96    pub endpoint: Endpoint,
97    pub registration_handles: Mutex<HashMap<String, CancellationToken>>,
98    pub alive_users: Arc<RwLock<HashSet<String>>>,
99    pub dialog_layer: Arc<DialogLayer>,
100    pub create_invitation_handler: Option<FnCreateInvitationHandler>,
101    pub invitation: Invitation,
102    pub routing_state: Arc<crate::call::RoutingState>,
103    pub pending_playbooks: Arc<Mutex<HashMap<String, (String, Instant)>>>,
104    pub learned_public_address: SharedPublicAddress,
105    /// Peer source addresses learned from call traffic, used by the OPTIONS
106    /// ACL (`[options_response]`).
107    pub learned_peers: crate::useragent::peer_learning::SharedLearnedPeers,
108
109    pub active_calls: Arc<std::sync::Mutex<HashMap<String, ActiveCallRef>>>,
110    pub total_calls: AtomicU64,
111    pub total_failed_calls: AtomicU64,
112    pub uptime: DateTime<Local>,
113    pub shutting_down: Arc<AtomicBool>,
114}
115
116pub type AppState = Arc<AppStateInner>;
117
118pub struct AppStateBuilder {
119    pub config: Option<Config>,
120    pub stream_engine: Option<Arc<StreamEngine>>,
121    pub callrecord_sender: Option<CallRecordSender>,
122    pub callrecord_formatter: Option<Arc<dyn CallRecordFormatter>>,
123    pub cancel_token: Option<CancellationToken>,
124    pub create_invitation_handler: Option<FnCreateInvitationHandler>,
125    pub config_path: Option<String>,
126
127    pub message_inspector: Option<Box<dyn MessageInspector>>,
128    pub target_locator: Option<Box<dyn TargetLocator>>,
129    pub transport_inspector: Option<Box<dyn TransportEventInspector>>,
130}
131
132impl AppStateInner {
133    pub fn auto_learn_public_address_enabled(&self) -> bool {
134        self.config.auto_learn_public_address.unwrap_or(false)
135    }
136
137    /// Whether an OPTIONS probe from `source_ip`/`source_host` (as extracted
138    /// from the top Via header) should be answered: the source must match the
139    /// static ACL, a registered-server host, or a peer address learned from
140    /// call traffic within the configured TTL.
141    pub fn options_source_allowed(
142        &self,
143        source_ip: Option<std::net::IpAddr>,
144        source_host: &str,
145    ) -> bool {
146        if self.config.options_matches_static(source_ip, source_host) {
147            return true;
148        }
149        if !self.config.options_auto_learn() {
150            return false;
151        }
152        let ttl = self.config.options_learn_ttl();
153        match source_ip {
154            Some(ip) => self.learned_peers.contains_within(&ip, ttl),
155            None => false,
156        }
157    }
158
159    pub fn get_dump_events_file(&self, session_id: &String) -> String {
160        let recorder_root = self.config.recorder_path();
161        let root = Path::new(&recorder_root);
162        if !root.exists() {
163            match std::fs::create_dir_all(root) {
164                Ok(_) => {
165                    info!("created dump events root: {}", root.to_string_lossy());
166                }
167                Err(e) => {
168                    warn!(
169                        "Failed to create dump events root: {} {}",
170                        e,
171                        root.to_string_lossy()
172                    );
173                }
174            }
175        }
176        root.join(format!("{}.events.jsonl", session_id))
177            .to_string_lossy()
178            .to_string()
179    }
180
181    pub fn get_recorder_file(&self, session_id: &String) -> String {
182        let recorder_root = self.config.recorder_path();
183        let root = Path::new(&recorder_root);
184        if !root.exists() {
185            match std::fs::create_dir_all(root) {
186                Ok(_) => {
187                    info!("created recorder root: {}", root.to_string_lossy());
188                }
189                Err(e) => {
190                    warn!(
191                        "Failed to create recorder root: {} {}",
192                        e,
193                        root.to_string_lossy()
194                    );
195                }
196            }
197        }
198        let desired_ext = self.config.recorder_format().extension();
199        let mut filename = session_id.clone();
200        if !filename
201            .to_lowercase()
202            .ends_with(&format!(".{}", desired_ext.to_lowercase()))
203        {
204            filename = format!("{}.{}", filename, desired_ext);
205        }
206        root.join(filename).to_string_lossy().to_string()
207    }
208
209    pub async fn serve(self: Arc<Self>) -> Result<()> {
210        let incoming_txs = self.endpoint.incoming_transactions()?;
211        let token = self.token.child_token();
212        let endpoint_inner = self.endpoint.inner.clone();
213        let dialog_layer = self.dialog_layer.clone();
214        let app_state_clone = self.clone();
215
216        match self.start_registration().await {
217            Ok(count) => {
218                info!("registration started, count: {}", count);
219            }
220            Err(e) => {
221                warn!("failed to start registration: {:?}", e);
222            }
223        }
224
225        let pending_cleanup_state = self.clone();
226        let pending_cleanup_token = token.clone();
227        crate::spawn(async move {
228            let mut interval = tokio::time::interval(Duration::from_secs(60));
229            let ttl = Duration::from_secs(300);
230            loop {
231                tokio::select! {
232                    _ = pending_cleanup_token.cancelled() => break,
233                    _ = interval.tick() => {
234                        let mut pending = pending_cleanup_state.pending_playbooks.lock().await;
235                        let before = pending.len();
236                        pending.retain(|_, (_, created_at)| created_at.elapsed() < ttl);
237                        let removed = before - pending.len();
238                        if removed > 0 {
239                            info!(removed, remaining = pending.len(), "cleaned up stale pending_playbooks entries");
240                        }
241                    }
242                }
243            }
244        });
245
246        tokio::select! {
247            _ = token.cancelled() => {
248                info!("cancelled");
249            }
250            result = endpoint_inner.serve() => {
251                if let Err(e) = result {
252                    info!("endpoint serve error: {:?}", e);
253                }
254            }
255            result = app_state_clone.process_incoming_request(dialog_layer.clone(), incoming_txs) => {
256                if let Err(e) = result {
257                    info!("process incoming request error: {:?}", e);
258                }
259            },
260        }
261
262        let total_secs = self.config.graceful_shutdown_timeout.unwrap_or(30);
263        let timeout = self
264            .config
265            .graceful_shutdown
266            .map(|_| Duration::from_secs(total_secs));
267
268        match self.stop_registration(timeout).await {
269            Ok(_) => {
270                info!("registration stopped, waiting for clear");
271            }
272            Err(e) => {
273                warn!("failed to stop registration: {:?}", e);
274            }
275        }
276        info!("stopping");
277        Ok(())
278    }
279
280    async fn process_incoming_request(
281        self: Arc<Self>,
282        dialog_layer: Arc<DialogLayer>,
283        mut incoming: TransactionReceiver,
284    ) -> Result<()> {
285        while let Some(mut tx) = incoming.recv().await {
286            let key: &rsipstack::transaction::key::TransactionKey = &tx.key;
287            info!(?key, "received transaction");
288            if tx.original.to_header()?.tag()?.as_ref().is_some() {
289                match dialog_layer.match_dialog(&tx) {
290                    Some(mut d) => {
291                        crate::spawn(async move {
292                            match d.handle(&mut tx).await {
293                                Ok(_) => (),
294                                Err(e) => {
295                                    info!("error handling transaction: {:?}", e);
296                                }
297                            }
298                        });
299                        continue;
300                    }
301                    None => {
302                        info!("dialog not found: {}", tx.original);
303                        match tx
304                            .reply(rsipstack::rsip::StatusCode::CallTransactionDoesNotExist)
305                            .await
306                        {
307                            Ok(_) => (),
308                            Err(e) => {
309                                info!("error replying to request: {:?}", e);
310                            }
311                        }
312                        continue;
313                    }
314                }
315            }
316            // out dialog, new server dialog
317            let (state_sender, state_receiver) = dialog_layer.new_dialog_state_channel();
318            match tx.original.method {
319                rsipstack::rsip::Method::Invite | rsipstack::rsip::Method::Ack => {
320                    // Reject new INVITEs during graceful shutdown
321                    if self.shutting_down.load(Ordering::Relaxed) {
322                        info!(?key, "rejecting INVITE during graceful shutdown");
323                        match tx
324                            .reply_with(
325                                rsipstack::rsip::StatusCode::ServiceUnavailable,
326                                vec![rsipstack::rsip::Header::Other(
327                                    "Reason".into(),
328                                    "SIP;cause=503;text=\"Server shutting down\"".into(),
329                                )],
330                                None,
331                            )
332                            .await
333                        {
334                            Ok(_) => (),
335                            Err(e) => {
336                                info!("error replying to request: {:?}", e);
337                            }
338                        }
339                        continue;
340                    }
341
342                    let invitation_handler = match self.create_invitation_handler {
343                        Some(ref create_invitation_handler) => {
344                            create_invitation_handler(self.config.handler.as_ref()).ok()
345                        }
346                        _ => default_create_invite_handler(
347                            self.config.handler.as_ref(),
348                            Some(self.clone()),
349                        ),
350                    };
351                    let invitation_handler = match invitation_handler {
352                        Some(h) => h,
353                        None => {
354                            info!(?key, "no invite handler configured, rejecting INVITE");
355                            match tx
356                                .reply_with(
357                                    rsipstack::rsip::StatusCode::ServiceUnavailable,
358                                    vec![rsipstack::rsip::Header::Other(
359                                        "Reason".into(),
360                                        "SIP;cause=503;text=\"No invite handler configured\""
361                                            .into(),
362                                    )],
363                                    None,
364                                )
365                                .await
366                            {
367                                Ok(_) => (),
368                                Err(e) => {
369                                    info!("error replying to request: {:?}", e);
370                                }
371                            }
372                            continue;
373                        }
374                    };
375                    let local_addr = tx
376                        .connection
377                        .as_ref()
378                        .map(|connection| connection.get_addr().clone())
379                        .or_else(|| dialog_layer.endpoint.get_addrs().first().cloned());
380                    let contact_username =
381                        tx.original.uri.auth.as_ref().map(|auth| auth.user.as_str());
382                    let contact = local_addr.as_ref().map(|addr| {
383                        build_public_contact_uri(
384                            &self.learned_public_address,
385                            self.auto_learn_public_address_enabled(),
386                            addr,
387                            contact_username,
388                            None,
389                        )
390                    });
391
392                    let dialog = match dialog_layer.get_or_create_server_invite(
393                        &tx,
394                        state_sender,
395                        None,
396                        contact,
397                    ) {
398                        Ok(d) => d,
399                        Err(e) => {
400                            // 481 Dialog/Transaction Does Not Exist
401                            info!("failed to obtain dialog: {:?}", e);
402                            match tx
403                                .reply(rsipstack::rsip::StatusCode::CallTransactionDoesNotExist)
404                                .await
405                            {
406                                Ok(_) => (),
407                                Err(e) => {
408                                    info!("error replying to request: {:?}", e);
409                                }
410                            }
411                            continue;
412                        }
413                    };
414
415                    let dialog_id = dialog.id();
416                    let dialog_id_str = dialog_id.to_string();
417                    let session_id = if dialog_id_str.len() > 64 { generate_short_session_id(&self.invitation) } else { dialog_id_str.clone() };
418                    let dialog_id_for_cleanup = dialog_id.clone();
419                    let token = self.token.child_token();
420                    let pending_dialog = PendingDialog {
421                        token: token.clone(),
422                        dialog: dialog.clone(),
423                        state_receiver,
424                    };
425
426                    let guard = Arc::new(PendingDialogGuard::new_with_session(
427                        self.invitation.clone(),
428                        dialog_id,
429                        session_id.clone(),
430                        pending_dialog,
431                    ));
432
433                    let accept_timeout = self
434                        .config
435                        .accept_timeout
436                        .as_ref()
437                        .and_then(|t| parse_duration(t).ok())
438                        .unwrap_or_else(|| Duration::from_secs(60));
439
440                    let mut dialog_ref = dialog.clone();
441                    let routing_state = self.routing_state.clone();
442                    let dialog_for_reject = dialog.clone();
443                    let invitation_for_cleanup = self.invitation.clone();
444                    let session_id_for_task = session_id.clone();
445                    crate::spawn(async move {
446                        info!(
447                            session_id = session_id_for_task,
448                            id = dialog_id_str,
449                            "incoming invite task started"
450                        );
451                        let _pending_guard = guard;
452                        let token_ref = token.clone();
453                        let accept_timeout_sleep = tokio::time::sleep(accept_timeout);
454                        let invite_handler = invitation_handler.on_invite(
455                            session_id_for_task.clone(),
456                            token.clone(),
457                            dialog.clone(),
458                            routing_state,
459                        );
460                        let dialog_handle = dialog_ref.handle(&mut tx);
461                        tokio::pin!(accept_timeout_sleep);
462                        tokio::pin!(invite_handler);
463                        tokio::pin!(dialog_handle);
464
465                        let mut cancel_done = false;
466                        let mut accept_timeout_done = false;
467                        let mut invite_done = false;
468                        loop {
469                            let mut reject_request = None;
470
471                            select! {
472                                _ = token_ref.cancelled(), if !cancel_done => {
473                                    cancel_done = true;
474                                    reject_request = Some((
475                                        rsipstack::rsip::StatusCode::ServiceUnavailable,
476                                        "invite cancelled".to_string(),
477                                        "cancelled",
478                                    ));
479                                }
480                                _ = &mut accept_timeout_sleep, if !accept_timeout_done
481                                    && dialog_for_reject.state().can_cancel() => {
482                                    accept_timeout_done = true;
483                                    reject_request = Some((
484                                        rsipstack::rsip::StatusCode::RequestTimeout,
485                                        "accept timeout".to_string(),
486                                        "accept timeout",
487                                    ));
488                                }
489                                result = &mut invite_handler, if !invite_done => {
490                                    invite_done = true;
491                                    match result {
492                                        Ok(_) => {
493                                            info!(id = dialog_id_str, "invite handler completed");
494                                        }
495                                        Err(e) => {
496                                            info!(id = dialog_id_str, "error handling invite: {:?}", e);
497                                            reject_request = Some((
498                                                rsipstack::rsip::StatusCode::ServiceUnavailable,
499                                                format!("Failed to process invite: {}", e),
500                                                "invite handler error",
501                                            ));
502                                        }
503                                    }
504                                }
505                                result = &mut dialog_handle => {
506                                    match result {
507                                        Ok(_) => {
508                                            info!(id = dialog_id_str, "dialog handling finished");
509                                        }
510                                        Err(e) => {
511                                            info!(
512                                                id = dialog_id_str,
513                                                "dialog handling ended with error: {:?}", e
514                                            );
515                                        }
516                                    }
517                                    if matches!(
518                                        dialog_for_reject.state(),
519                                        rsipstack::dialog::dialog::DialogState::Terminated(_, _)
520                                    ) {
521                                        info!(
522                                            id = dialog_id_str,
523                                            "terminated invite dialog finished, cancelling invite token"
524                                        );
525                                        token_ref.cancel();
526                                    }
527                                    info!(id = dialog_id_str, "incoming invite task finished");
528                                    break;
529                                }
530                            }
531
532                            if let Some((code, reason, source)) = reject_request {
533                                if dialog_for_reject.state().can_cancel() {
534                                    info!(
535                                        id = dialog_id_str,
536                                        ?code,
537                                        %reason,
538                                        source,
539                                        "rejecting invite"
540                                    );
541                                    if let Err(e) =
542                                        dialog_for_reject.reject(Some(code), Some(reason))
543                                    {
544                                        info!(
545                                            id = dialog_id_str,
546                                            "error rejecting invite: {:?}", e
547                                        );
548                                    }
549                                    invitation_for_cleanup.get_pending_call(&dialog_id_for_cleanup);
550                                    invitation_for_cleanup
551                                        .dialog_layer
552                                        .remove_dialog(&dialog_id_for_cleanup);
553                                }
554                            }
555                        }
556                    });
557                }
558                rsipstack::rsip::Method::Options => {
559                    if self.config.options_response_enabled() {
560                        let (source_ip, source_host) = extract_via_source(&tx.original);
561                        if self.options_source_allowed(source_ip, &source_host) {
562                            info!(?key, %source_host, "responding to out-of-dialog OPTIONS request");
563                            let mut headers = vec![
564                                {
565                                    let allow_header: rsipstack::rsip::Header =
566                                        typed::Allow::from(Method::all()).into();
567                                    allow_header
568                                },
569                                rsipstack::rsip::Header::Accept(Accept::new("application/sdp")),
570                            ];
571                            let extra_headers = self.config.options_extra_headers();
572                            if !extra_headers.is_empty() {
573                                headers.extend(crate::sip_util::sip_headers_from_map(
574                                    &extra_headers.into_iter().collect::<HashMap<_, _>>(),
575                                ));
576                            }
577                            match tx
578                                .reply_with(rsipstack::rsip::StatusCode::OK, headers, None)
579                                .await
580                            {
581                                Ok(_) => (),
582                                Err(e) => {
583                                    info!("error replying to OPTIONS: {:?}", e);
584                                }
585                            }
586                        } else {
587                            debug!(
588                                ?key,
589                                %source_host,
590                                "dropping OPTIONS probe from non-allowed source"
591                            );
592                        }
593                    } else {
594                        info!(?key, "ignoring out-of-dialog OPTIONS request");
595                    }
596                    continue;
597                }
598                rsipstack::rsip::Method::Refer => {
599                    info!(?key, "ignoring out-of-dialog REFER");
600                    match tx.reply(rsipstack::rsip::StatusCode::BadRequest).await {
601                        Ok(_) => (),
602                        Err(e) => {
603                            info!("error replying to out-of-dialog REFER: {:?}", e);
604                        }
605                    }
606                    continue;
607                }
608                _ => {
609                    info!(?key, "received request: {:?}", tx.original.method);
610                    match tx.reply(rsipstack::rsip::StatusCode::OK).await {
611                        Ok(_) => (),
612                        Err(e) => {
613                            info!("error replying to request: {:?}", e);
614                        }
615                    }
616                }
617            }
618        }
619        Ok(())
620    }
621
622    pub fn stop(&self) {
623        if self.shutting_down.swap(true, Ordering::Relaxed) {
624            return;
625        }
626        info!("stopping, marking as shutting down");
627        self.token.cancel();
628    }
629
630    pub async fn graceful_stop(&self, total_timeout_secs: u64) -> Result<()> {
631        if self.shutting_down.swap(true, Ordering::Relaxed) {
632            return Ok(());
633        }
634
635        info!("graceful stopping, marking as shutting down");
636        let timeout = Duration::from_secs(total_timeout_secs);
637
638        let (reg_result, ()) = tokio::join!(
639            self.stop_registration(Some(timeout)),
640            self.wait_for_active_calls(timeout),
641        );
642        if let Err(e) = reg_result {
643            warn!("stop_registration error: {}", e);
644        }
645        self.token.cancel();
646        Ok(())
647    }
648
649    async fn wait_for_active_calls(&self, timeout: Duration) {
650        let active_calls = self.active_calls.clone();
651        let check_loop = async move {
652            let mut last_count = usize::MAX;
653            loop {
654                let count = active_calls.lock().unwrap().len();
655                if count == 0 {
656                    break;
657                }
658                if count != last_count {
659                    info!(active_calls = count, "waiting for active calls to finish");
660                    last_count = count;
661                }
662                tokio::time::sleep(Duration::from_millis(500)).await;
663            }
664        };
665        match tokio::time::timeout(timeout, check_loop).await {
666            Ok(()) => info!("all active calls finished"),
667            Err(_) => warn!("timed out waiting for active calls to finish, forcing shutdown"),
668        }
669    }
670
671    pub async fn start_registration(&self) -> Result<usize> {
672        let mut count = 0;
673        if let Some(register_users) = &self.config.register_users {
674            for option in register_users.iter() {
675                match self.register(option.clone()).await {
676                    Ok(_) => {
677                        count += 1;
678                    }
679                    Err(e) => {
680                        warn!("failed to register user: {:?} {:?}", e, option);
681                    }
682                }
683            }
684        }
685        Ok(count)
686    }
687
688    pub fn find_credentials_for_callee(&self, callee: &str) -> Option<UserCredential> {
689        let callee_uri = crate::sip_util::ensure_sip_scheme(callee.to_string());
690
691        let parsed_callee = match rsipstack::rsip::Uri::try_from(callee_uri.as_str()) {
692            Ok(uri) => uri,
693            Err(e) => {
694                warn!("failed to parse callee URI: {} {:?}", callee, e);
695                return None;
696            }
697        };
698
699        // Matching is host-kind-homogeneous: a domain callee matches domain
700        // servers, an IP callee matches IP servers.
701        match &parsed_callee.host_with_port.host {
702            rsipstack::rsip::Host::Domain(domain) => {
703                let domain = domain.0.clone();
704                self.find_credentials(
705                    callee,
706                    &format!("domain {}", domain),
707                    |host| matches!(host, rsipstack::rsip::Host::Domain(d) if d.0 == domain),
708                )
709            }
710            rsipstack::rsip::Host::IpAddr(ip) => {
711                let ip = *ip;
712                self.find_credentials(callee, "IP match", move |host| {
713                    matches!(host, rsipstack::rsip::Host::IpAddr(server_ip) if *server_ip == ip)
714                })
715            }
716        }
717    }
718
719    /// Scan registered users for the first server matching `pred` that has a
720    /// credential.
721    fn find_credentials(
722        &self,
723        callee: &str,
724        match_type: &str,
725        pred: impl Fn(&rsipstack::rsip::Host) -> bool,
726    ) -> Option<UserCredential> {
727        let register_users = self.config.register_users.as_ref()?;
728        for option in register_users.iter() {
729            let server = crate::sip_util::ensure_sip_scheme(option.server.clone());
730
731            let parsed_server = match rsipstack::rsip::Uri::try_from(server.as_str()) {
732                Ok(uri) => uri,
733                Err(e) => {
734                    warn!("failed to parse server URI: {} {:?}", option.server, e);
735                    continue;
736                }
737            };
738
739            if pred(&parsed_server.host_with_port.host) {
740                if let Some(cred) = &option.credential {
741                    info!(
742                        callee,
743                        username = cred.username,
744                        server = option.server,
745                        match_type,
746                        "Auto-injecting credentials from registered user for outbound call"
747                    );
748                    return Some(cred.clone());
749                }
750            }
751        }
752        None
753    }
754
755    pub async fn stop_registration(&self, wait_for_clear: Option<Duration>) -> Result<()> {
756        {
757            let mut handles = self.registration_handles.lock().await;
758            for (_, cancel_token) in handles.drain() {
759                cancel_token.cancel();
760            }
761        }
762
763        if let Some(duration) = wait_for_clear {
764            let live_users = self.alive_users.clone();
765            let check_loop = async move {
766                loop {
767                    let is_empty = {
768                        let users = live_users
769                            .read()
770                            .map_err(|_| anyhow::anyhow!("Lock poisoned"))?;
771                        users.is_empty()
772                    };
773                    if is_empty {
774                        break;
775                    }
776                    tokio::time::sleep(Duration::from_millis(50)).await;
777                }
778                Ok::<(), anyhow::Error>(())
779            };
780            match tokio::time::timeout(duration, check_loop).await {
781                Ok(_) => {}
782                Err(e) => {
783                    warn!("failed to wait for clear: {}", e);
784                    return Err(anyhow::anyhow!("failed to wait for clear: {}", e));
785                }
786            }
787        }
788        Ok(())
789    }
790
791    pub async fn register(&self, option: RegisterOption) -> Result<()> {
792        let user = option.aor();
793        let server = crate::sip_util::ensure_sip_scheme(option.server.clone());
794        let sip_server = match rsipstack::rsip::Uri::try_from(server) {
795            Ok(uri) => uri,
796            Err(e) => {
797                warn!("failed to parse server: {} {:?}", e, option.server);
798                return Err(anyhow::anyhow!("failed to parse server: {}", e));
799            }
800        };
801        let cancel_token = self.token.child_token();
802        let credential = option.credential.clone().map(|c| c.into());
803        let registration = rsipstack::dialog::registration::Registration::new(
804            self.endpoint.inner.clone(),
805            credential,
806        );
807        let mut handle = RegistrationHandle {
808            registration,
809            option,
810            cancel_token: cancel_token.clone(),
811            start_time: Instant::now(),
812            last_update: Instant::now(),
813            last_response: None,
814        };
815        self.registration_handles
816            .lock()
817            .await
818            .insert(user.clone(), cancel_token);
819        tracing::debug!(user = user.as_str(), "starting registration task");
820        let alive_users = self.alive_users.clone();
821
822        crate::spawn(async move {
823            handle.start_time = Instant::now();
824            let cancel_token = handle.cancel_token.clone();
825            let addrs = handle.registration.endpoint.get_addrs();
826            let local_bind_addr = if let Some(addr) = find_local_addr_for_uri(&addrs, &sip_server) {
827                addr
828            } else {
829                warn!(
830                    user = user.as_str(),
831                    server = %sip_server,
832                    "failed to get local bind address for registration transport"
833                );
834                alive_users.write().unwrap().remove(&user);
835                return;
836            };
837            let user = handle.option.aor();
838            alive_users.write().unwrap().remove(&user);
839            let mut contact_address = local_bind_addr.addr.clone();
840            let mut contact = build_contact(
841                &local_bind_addr,
842                Some(contact_address.clone()),
843                Some(handle.option.username.as_str()),
844                None,
845            );
846            let mut should_register = true;
847            let mut timer = pending().boxed();
848
849            loop {
850                select! {
851                    _ = cancel_token.cancelled() => {
852                        break;
853                    }
854                    _ = timer.as_mut(), if !should_register => {
855                        should_register = true;
856                        timer = Box::pin(pending());
857                    }
858                    result = handle.do_register(&sip_server, None, &contact), if should_register => {
859                        match result {
860                            Ok((expires, new_addr)) => {
861                                if handle
862                                    .should_retry_registration_now(
863                                        &local_bind_addr,
864                                        &contact_address,
865                                        new_addr.as_ref(),
866                                    )
867                                {
868                                    if let Some(next_contact_address) = new_addr {
869                                        info!(
870                                            user = user.as_str(),
871                                            current_contact = %contact_address,
872                                            next_contact = %next_contact_address,
873                                            "public address changed, retrying registration immediately",
874                                        );
875                                        contact_address = next_contact_address;
876                                        contact = build_contact(
877                                            &local_bind_addr,
878                                            Some(contact_address.clone()),
879                                            Some(handle.option.username.as_str()),
880                                            None,
881                                        );
882                                        continue;
883                                    }
884                                }
885                                info!(
886                                    user = user.as_str(),
887                                    expires = expires,
888                                    contact = %contact_address,
889                                    alive_users = alive_users.read().unwrap().len(),
890                                    "registration refreshed",
891                                );
892                                alive_users.write().unwrap().insert(user.clone());
893                                should_register = false;
894                                timer = Box::pin(tokio::time::sleep(Duration::from_secs(
895                                    (expires * 3 / 4) as u64,
896                                )));
897                            }
898                            Err(e) => {
899                                warn!(
900                                    user = user.as_str(),
901                                    alive_users = alive_users.read().unwrap().len(),
902                                    "registration failed: {:?}", e
903                                );
904                                should_register = false;
905                                timer = Box::pin(tokio::time::sleep(Duration::from_secs(60)));
906                            }
907                        }
908                    }
909                }
910            }
911            handle
912                .do_register(&sip_server, Some(0), &contact)
913                .await
914                .ok();
915            alive_users.write().unwrap().remove(&user);
916        });
917        Ok(())
918    }
919}
920
921impl Drop for AppStateInner {
922    fn drop(&mut self) {
923        self.stop();
924    }
925}
926
927struct SimpleDomainResolver;
928
929#[async_trait]
930impl DomainResolver for SimpleDomainResolver {
931    async fn resolve(&self, target: &SipAddr) -> rsipstack::Result<SipAddr> {
932        match &target.addr.host {
933            Host::Domain(domain) => {
934                let port: u16 = target.addr.port.map(|p| p.value()).unwrap_or(5060);
935                let addr_str = format!("{}:{}", domain, port);
936                match tokio::net::lookup_host(&addr_str).await {
937                    Ok(mut addrs) => {
938                        if let Some(addr) = addrs.next() {
939                            Ok(SipAddr {
940                                r#type: target.r#type,
941                                addr: HostWithPort {
942                                    host: Host::IpAddr(addr.ip()),
943                                    port: Some(rsipstack::rsip::Port(addr.port())),
944                                },
945                            })
946                        } else {
947                            Err(rsipstack::Error::DnsResolutionError(format!(
948                                "no addresses found for {}",
949                                domain
950                            )))
951                        }
952                    }
953                    Err(e) => Err(rsipstack::Error::DnsResolutionError(format!(
954                        "DNS resolution failed for {}: {}",
955                        domain, e
956                    ))),
957                }
958            }
959            _ => Ok(target.clone()),
960        }
961    }
962}
963
964impl AppStateBuilder {
965    pub fn new() -> Self {
966        Self {
967            config: None,
968            stream_engine: None,
969            callrecord_sender: None,
970            callrecord_formatter: None,
971            cancel_token: None,
972            create_invitation_handler: None,
973            config_path: None,
974            message_inspector: None,
975            target_locator: None,
976            transport_inspector: None,
977        }
978    }
979
980    pub fn with_config(mut self, config: Config) -> Self {
981        self.config = Some(config);
982        self
983    }
984
985    pub fn with_stream_engine(mut self, stream_engine: Arc<StreamEngine>) -> Self {
986        self.stream_engine = Some(stream_engine);
987        self
988    }
989
990    pub fn with_callrecord_sender(mut self, sender: CallRecordSender) -> Self {
991        self.callrecord_sender = Some(sender);
992        self
993    }
994
995    pub fn with_cancel_token(mut self, token: CancellationToken) -> Self {
996        self.cancel_token = Some(token);
997        self
998    }
999
1000    pub fn with_config_metadata(mut self, path: Option<String>) -> Self {
1001        self.config_path = path;
1002        self
1003    }
1004
1005    pub fn with_inspector(&mut self, inspector: Box<dyn MessageInspector>) -> &mut Self {
1006        self.message_inspector = Some(inspector);
1007        self
1008    }
1009    pub fn with_target_locator(&mut self, locator: Box<dyn TargetLocator>) -> &mut Self {
1010        self.target_locator = Some(locator);
1011        self
1012    }
1013
1014    pub fn with_transport_inspector(
1015        &mut self,
1016        inspector: Box<dyn TransportEventInspector>,
1017    ) -> &mut Self {
1018        self.transport_inspector = Some(inspector);
1019        self
1020    }
1021
1022    pub async fn build(mut self) -> Result<AppState> {
1023        let config: Arc<Config> = Arc::new(self.config.unwrap_or_default());
1024        let token = self
1025            .cancel_token
1026            .unwrap_or_else(|| CancellationToken::new());
1027        let _ = set_cache_dir(&config.media_cache_path);
1028        let local_ip = if !config.addr.is_empty() {
1029            std::net::IpAddr::from_str(config.addr.as_str())?
1030        } else {
1031            crate::net_tool::get_first_non_loopback_interface()?
1032        };
1033        let transport_layer = match catch_unwind(AssertUnwindSafe(|| {
1034            rsipstack::transport::TransportLayer::new(token.clone())
1035        })) {
1036            Ok(tl) => tl,
1037            Err(_) => {
1038                warn!(
1039                    "failed to initialize default DNS resolver with hickory-resolver, falling back to simple resolver via tokio::net::lookup_host"
1040                );
1041                rsipstack::transport::TransportLayer::new_with_domain_resolver(
1042                    token.clone(),
1043                    Box::new(SimpleDomainResolver),
1044                )
1045            }
1046        };
1047        let local_addr: SocketAddr = format!("{}:{}", local_ip, config.udp_port).parse()?;
1048
1049        // Create UDP socket with SO_REUSEPORT for graceful restarts
1050        #[cfg(unix)]
1051        let std_socket = {
1052            use socket2::{Domain, Protocol, SockAddr, Socket, Type};
1053
1054            let domain = if local_addr.is_ipv4() {
1055                Domain::IPV4
1056            } else {
1057                Domain::IPV6
1058            };
1059            let socket = Socket::new(domain, Type::DGRAM, Some(Protocol::UDP))
1060                .map_err(|err| anyhow::anyhow!("Failed to create UDP socket: {}", err))?;
1061
1062            socket
1063                .set_reuse_address(true)
1064                .map_err(|err| anyhow::anyhow!("Failed to set SO_REUSEADDR: {}", err))?;
1065
1066            // SO_REUSEPORT (Linux/BSD)
1067            #[cfg(not(any(target_os = "solaris", target_os = "illumos", target_os = "cygwin")))]
1068            socket
1069                .set_reuse_port(true)
1070                .map_err(|err| anyhow::anyhow!("Failed to set SO_REUSEPORT: {}", err))?;
1071
1072            socket
1073                .bind(&SockAddr::from(local_addr))
1074                .map_err(|err| anyhow::anyhow!("Failed to bind UDP socket: {}", err))?;
1075
1076            let std_socket: std::net::UdpSocket = socket.into();
1077            std_socket
1078        };
1079
1080        #[cfg(not(unix))]
1081        let std_socket = std::net::UdpSocket::bind(local_addr)?;
1082
1083        std_socket.set_nonblocking(true)?;
1084        let tokio_socket = tokio::net::UdpSocket::from_std(std_socket)?;
1085        // Use the actual bound address (important when port=0 lets OS assign a port)
1086        let actual_addr = tokio_socket.local_addr()?;
1087        let bind_addr = rsipstack::transport::SipConnection::resolve_bind_address(actual_addr);
1088        let mut learned_public_address: SharedPublicAddress =
1089            Arc::new(ArcSwap::from_pointee(bind_addr.into()));
1090        let learned_peers =
1091            SharedLearnedPeers::new(crate::useragent::peer_learning::LEARNED_PEERS_CAPACITY);
1092
1093        let udp_inner = rsipstack::transport::udp::UdpInner {
1094            conn: std::sync::Arc::new(tokio_socket),
1095            addr: rsipstack::transport::SipAddr {
1096                r#type: Some(rsipstack::rsip::transport::Transport::Udp),
1097                addr: bind_addr.into(),
1098            },
1099        };
1100
1101        let external = config
1102            .external_ip
1103            .as_ref()
1104            .map(|ip| {
1105                format!("{}:{}", ip, actual_addr.port())
1106                    .parse()
1107                    .map_err(|e| anyhow::anyhow!("Failed to parse external address: {}", e))
1108            })
1109            .transpose()?;
1110
1111        let udp_conn = rsipstack::transport::udp::UdpConnection::attach(
1112            udp_inner,
1113            external,
1114            Some(token.child_token()),
1115        )
1116        .await;
1117
1118        info!(
1119            "start useragent, addr: {} (SO_REUSEPORT enabled)",
1120            udp_conn.get_addr()
1121        );
1122
1123        transport_layer.add_transport(udp_conn.into());
1124
1125        // Optional SIP over TLS transport
1126        if let Some(tls_port) = config.tls_port {
1127            let tls_addr: std::net::SocketAddr = format!("{}:{}", local_ip, tls_port).parse()?;
1128            let mut tls_cfg = rsipstack::transport::tls::TlsConfig::default();
1129            if let Some(ref cert_path) = config.tls_cert_file {
1130                tls_cfg.cert = Some(
1131                    std::fs::read(cert_path)
1132                        .map_err(|e| anyhow::anyhow!("tls_cert_file: {}", e))?,
1133                );
1134            }
1135            if let Some(ref key_path) = config.tls_key_file {
1136                tls_cfg.key = Some(
1137                    std::fs::read(key_path).map_err(|e| anyhow::anyhow!("tls_key_file: {}", e))?,
1138                );
1139            }
1140            let external_tls_addr = config
1141                .external_ip
1142                .as_ref()
1143                .and_then(|ip| format!("{}:{}", ip, tls_port).parse().ok());
1144            match rsipstack::transport::tls::TlsListenerConnection::new(
1145                tls_addr,
1146                external_tls_addr,
1147                tls_cfg,
1148            )
1149            .await
1150            {
1151                Ok(tls_conn) => {
1152                    transport_layer.add_transport(tls_conn.into());
1153                    info!("TLS SIP transport started on {}:{}", local_ip, tls_port);
1154                }
1155                Err(e) => {
1156                    return Err(anyhow::anyhow!("Failed to start TLS SIP transport: {}", e));
1157                }
1158            }
1159        }
1160
1161        let endpoint_option = rsipstack::transaction::endpoint::EndpointOption::default();
1162        let mut endpoint_builder = rsipstack::EndpointBuilder::new();
1163        if let Some(ref user_agent) = config.useragent {
1164            endpoint_builder.with_user_agent(user_agent.as_str());
1165        }
1166
1167        let mut endpoint_builder = endpoint_builder
1168            .with_cancel_token(token.child_token())
1169            .with_transport_layer(transport_layer)
1170            .with_option(endpoint_option);
1171
1172        // Inspector chain (outermost runs first): public-address learning
1173        // (opt-in) -> call-traffic peer learning (for the OPTIONS ACL) ->
1174        // any caller-provided inspector.
1175        let mut next_inspector = self.message_inspector.take();
1176        if config.options_auto_learn() {
1177            info!("learning call-traffic peer addresses for OPTIONS ACL");
1178            next_inspector = Some(Box::new(PeerAddressLearner::new_with_next(
1179                learned_peers.clone(),
1180                next_inspector,
1181            )));
1182        }
1183        if config.auto_learn_public_address.unwrap_or_default() {
1184            let inspector = LearningMessageInspector::new(bind_addr.into(), next_inspector);
1185            learned_public_address = inspector.shared_public_address();
1186            next_inspector = Some(Box::new(inspector));
1187        }
1188        if let Some(inspector) = next_inspector {
1189            endpoint_builder = endpoint_builder.with_inspector(inspector);
1190        }
1191        if let Some(locator) = self.target_locator {
1192            endpoint_builder.with_target_locator(locator);
1193        } else if let Some(ref rules) = config.rewrites {
1194            endpoint_builder
1195                .with_target_locator(Box::new(RewriteTargetLocator::new(rules.clone())));
1196        }
1197
1198        if let Some(inspector) = self.transport_inspector {
1199            endpoint_builder = endpoint_builder.with_transport_inspector(inspector);
1200        }
1201
1202        let endpoint = endpoint_builder.build();
1203        let dialog_layer = Arc::new(DialogLayer::new(endpoint.inner.clone()));
1204
1205        let stream_engine = self.stream_engine.unwrap_or_default();
1206
1207        let callrecord_formatter = if let Some(formatter) = self.callrecord_formatter {
1208            formatter
1209        } else {
1210            let formatter = if let Some(ref callrecord) = config.callrecord {
1211                DefaultCallRecordFormatter::new_with_config(callrecord)
1212            } else {
1213                DefaultCallRecordFormatter::default()
1214            };
1215            Arc::new(formatter)
1216        };
1217
1218        let callrecord_sender = if let Some(sender) = self.callrecord_sender {
1219            Some(sender)
1220        } else if let Some(ref callrecord) = config.callrecord {
1221            let builder = CallRecordManagerBuilder::new()
1222                .with_cancel_token(token.child_token())
1223                .with_config(callrecord.clone())
1224                .with_max_concurrent(32)
1225                .with_formatter(callrecord_formatter.clone());
1226
1227            let mut callrecord_manager = builder.build();
1228            let sender = callrecord_manager.sender.clone();
1229            crate::spawn(async move {
1230                callrecord_manager.serve().await;
1231            });
1232            Some(sender)
1233        } else {
1234            None
1235        };
1236
1237        let app_state = Arc::new(AppStateInner {
1238            config,
1239            token,
1240            stream_engine,
1241            callrecord_sender,
1242            endpoint,
1243            registration_handles: Mutex::new(HashMap::new()),
1244            alive_users: Arc::new(RwLock::new(HashSet::new())),
1245            dialog_layer: dialog_layer.clone(),
1246            create_invitation_handler: self.create_invitation_handler,
1247            invitation: Invitation::new(dialog_layer),
1248            routing_state: Arc::new(crate::call::RoutingState::new()),
1249            pending_playbooks: Arc::new(Mutex::new(HashMap::new())),
1250            learned_public_address,
1251            learned_peers,
1252            active_calls: Arc::new(std::sync::Mutex::new(HashMap::new())),
1253            total_calls: AtomicU64::new(0),
1254            total_failed_calls: AtomicU64::new(0),
1255            uptime: Local::now(),
1256            shutting_down: Arc::new(AtomicBool::new(false)),
1257        });
1258
1259        Ok(app_state)
1260    }
1261}