@babblevoice/babble-drachtio-callmanager 3.7.2 → 3.7.4

package/index.js

@@ -8,7 +8,7 @@ const default_options = {
   "preferedcodecs": "g722 ilbc pcmu pcma",
   //"transcode": true, - this never made it into the software - TODO
   "uactimeout": 30000, /* timeout when calling a client */
-  "seexpire": 120000, /* session expires timeout mS */
+  "seexpire": 1800*1000, /* session expires timeout mS recomended in RFC 4028 - 30 minutes */
   "rfc2833": true,  /* Enable RFC 2833 - DTMF */
   "late": false,  /* Late negotiation */
   "registrar": false, /* our registrar object or falsey */

package/lib/call.js

@@ -14,7 +14,12 @@ const net = require( "net" )
 const parseurire = /^(sips?):(?:([^\s>:@]+)(?::([^\s@>]+))?@)?([\w\-.]+)(?::(\d+))?((?:;[^\s=?>;]+(?:=[^\s?;]+)?)*)(?:\?(([^\s&=>]+=[^\s&=>]+)(&[^\s&=>]+=[^\s&=>]+)*))?$/
 const parseuriparamsre = /([^;=]+)(=([^;=]+))?/g
 const parseuriheadersre = /[^&=]+=[^&=]+/g
+const sessionexpirevaluere = /^(\d+)(?:;refresher=(uac|uas))?$/
 
+/**
+ * 
+ * @param { string } s 
+ */
 function parseuri( s ) {
   if( "object" === typeof s )
     return s
@@ -27,6 +32,7 @@ function parseuri( s ) {
       user: r[ 2 ],
       password: r[ 3 ],
       host: r[ 4 ],
+      uri: r[ 2 ] + "@" + r[ 4 ],
       port: +r[ 5 ],
       params: (r[ 6 ].match( parseuriparamsre ) || [] )
         .map( function( s ) { return s.split( "=" ) } )
@@ -153,6 +159,9 @@ let callmanager = {
 class call {
 
   #noack = false
+  #seexpire = callmanager.options.seexpire
+  #refresher = "uac"
+  #expirelasttouch = +new Date()
 
   /**
   * Construct our call object with all defaults, including a default UUID.
@@ -478,14 +487,19 @@ class call {
   }
 
   /**
-  @typedef remoteid
-  @property { string } host
-  @property { string } user
-  @property { string } name
-  @property { string } uri
-  @property { boolean } privacy
-  @property { string } type - "callerid" | "calledid"
-  */
+   * @typedef remoteid
+   * @property { string } [ schema ]
+   * @property { string } [ password ]
+   * @property { number } [ port ]
+   * @property { Array } [ headers ]
+   * @property { string } host
+   * @property { string } user
+   * @property { string } name
+   * @property { string } uri
+   * @property { boolean } privacy
+   * @property { object } [ params ]
+   * @property { string } type - "callerid" | "calledid"
+   */
 
 
   /**
@@ -494,6 +508,8 @@ class call {
    */
   #getremotefromheaders() {
     let parsed = {}
+    if( !this._req ) return parsed
+
     if( this._req.has( "p-asserted-identity" ) ) {
       parsed = this._req.getParsedHeader( "p-asserted-identity" )
     } else if( this._req.has( "remote-party-id" ) ) {
@@ -510,9 +526,14 @@ class call {
     return this._req.getParsedHeader( hdr )
   }
 
+  /**
+   * 
+   * @param { object } parsed 
+   * @returns 
+   */
   #fixparseduriobj( parsed ) {
 
-    if( !parsed ) parsed = { name: "" }
+    if( !parsed ) parsed = { name: "", user: "", host: "", uri: "", privacy: false, type: "callerid" }
     const name = parsed.name
 
     if( !parsed.uri && parsed.user && parsed.host ) parsed.uri = parsed.user + "@" + parsed.host
@@ -540,7 +561,7 @@ class call {
    */
   get direction() {
     if( this.options.partycalled ) return "inbound"
-    return "uas"==this.type?"inbound":"outbound"
+    return "uas"===this.type?"inbound":"outbound"
   }
 
   /**
@@ -572,6 +593,11 @@ class call {
     }
   }
 
+  /**
+   * 
+   * @param { object } startingpoint 
+   * @returns 
+   */
   #fromremoteheaders( startingpoint ) {
     const parsed = this.#fixparseduriobj( this.#getremotefromheaders() )
     if( parsed.uri ) startingpoint.uri = parsed.uri
@@ -580,7 +606,32 @@ class call {
     if( parsed.name ) startingpoint.name = parsed.name
   }
 
+  /**
+   * 
+   * @param { object } startingpoint 
+   * @returns { boolean }
+   */
+  #fromrefertouri( startingpoint ) {
+    if( !this.referingtouri ) return false
+
+    const referdest = parseuri( this.referingtouri )
+
+    if( !referdest ) return
+
+    if( referdest.uri ) startingpoint.uri = referdest.uri
+    if( referdest.user ) startingpoint.user = referdest.user
+    if( referdest.host ) startingpoint.host = referdest.host
+
+    return true
+  }
+  
+  /**
+   * 
+   * @param { object } startingpoint 
+   * @returns 
+   */
   #fromcontact( startingpoint ) {
+
     const dest = parseuri( this.options.contact )
     if( !dest ) return
     if( dest.uri ) startingpoint.uri = dest.uri
@@ -588,12 +639,22 @@ class call {
     if( dest.host ) startingpoint.host = dest.host
   }
 
+  /**
+   * 
+   * @param { object } startingpoint 
+   * @returns 
+   */
   #fromdestination( startingpoint ) {
     const dest = this.destination
     startingpoint.user = dest.user
     startingpoint.host = dest.host
   }
 
+  /**
+   * 
+   * @param { object } startingpoint 
+   * @returns 
+   */
   #fromoutentity( startingpoint ) {
 
     const entity = this.options.entity
@@ -608,18 +669,21 @@ class call {
     return false
   }
 
+  /**
+   * 
+   * @param { object } startingpoint 
+   * @returns 
+   */
   #frominentity( startingpoint ) {
     const entity = this._entity
+    if( !entity ) return false
 
-    if( entity ) {
-      startingpoint.name = entity.display
-      startingpoint.uri = entity.uri
-      startingpoint.user = entity.username
-      startingpoint.host = entity.realm
-      return true
-    }
+    startingpoint.name = entity.display
+    startingpoint.uri = entity.uri
+    startingpoint.user = entity.username
+    startingpoint.host = entity.realm
+    return true
 
-    return false
   }
 
   /**
@@ -675,18 +739,19 @@ class call {
       "type": "callerid"
     }
 
-    if( "uas" == this.type ) this.#calleridforuas( startingpoint )
+    if( "uas" === this.type ) this.#calleridforuas( startingpoint )
     else {
       if( this.options.partycalled ) {
         this.#calleridforuac( startingpoint )
       } else {
         const other = this.other
         if( other ) {
-          if( "uas" == other.type ) {
+          if( "uas" === other.type ) {
             other.#calleridforuas( startingpoint )
             other.#overridecallerid( startingpoint )
           } else {
             other.#calledidforuac( startingpoint )
+            if( this.type !== other.type ) other.#fromrefertouri( startingpoint )
           }
         } else {
 
@@ -800,10 +865,10 @@ class call {
   */
 
   /**
-  Return the destination of the call.
-  If not present returns the contact.
-  @return { destination }  destination - parsed uri
-  */
+   * Return the destination of the call.
+   * If not present returns the contact.
+   * @return { object }  destination - parsed uri
+   */
   get destination() {
     if( undefined !== this.referingtouri ) {
       const parsed = parseuri( this.referingtouri )
@@ -816,7 +881,7 @@ class call {
 
   /**
   Return the contact of the call.
-  @return { destination }  destination - parsed uri
+  @return { object }  destination - parsed uri
   */
   get contact() {
     if( "uac" == this.type ) {
@@ -1305,7 +1370,7 @@ class call {
   async _onearlybridge() {
     if( this.destroyed ) return
 
-    this._addevents( this._dialog )
+    this.#addevents( this._dialog )
 
     this.sdp.remote = sdpgen.create( this._dialog.remote.sdp )
 
@@ -1391,7 +1456,7 @@ class call {
 
     this._dialog = await this._dialog.ack( this.sdp.local.toString() )
     this.established = true
-    this._addevents( this._dialog )
+    this.#addevents( this._dialog )
 
     await this.#answerparent()
 
@@ -1793,19 +1858,23 @@ class call {
         return
       }
 
+      const headers = {
+        "User-Agent": "project",
+        "Supported": "replaces, timer",
+        "Require": "timer",
+        "Session-Expires": `${this.#seexpire/1000};refresher=${this.#refresher}`
+      }
+
       const dialog = await callmanager.options.srf.createUAS( this._req, this._res, {
         localSdp: this.sdp.local.toString(),
-        headers: {
-          "User-Agent": "project",
-          "Supported": "replaces"
-        }
+        headers
       } )
 
       this.#setdialog( dialog )
       this.sip.tags.local = dialog.sip.localTag
       callstore.set( this )
 
-      this._addevents( this._dialog )
+      this.#addevents( this._dialog )
       this._em.emit( "call.answered", this )
       callmanager.options.em.emit( "call.answered", this )
 
@@ -2406,51 +2475,77 @@ class call {
   }
 
   /**
-    Add events for the drachtio dialog object that this object requires.
-    @private
+   * Allow a good margin of error - but hangup if we have disappeared
+   */
+  #hasseexpiredexpired() {
+
+    const now = +new Date()
+    if( ( now - this.#expirelasttouch ) > ( this.#seexpire * 2 ) ) {
+      this.hangup( hangupcodes.USER_GONE )
+      return true
+    }
+    return false
+  }
+
+  /**
+   * 
+   */
+  #checkthischannelforwebrtcdirection() {
+    if( this._iswebrtc && this.channels && this.channels.audio ) {
+      /* we are sending invite so we MUST offer be actpass */
+      this.channels.secure.audio.offer = true
+      this.sdp.local
+        .secure( this.channels.audio.local.dtls.fingerprint, this.#getsrtpsetup( this.channels.secure.audio ) )
+    }
+  }
+
+  /**
+   * Add events for the drachtio dialog object that this object requires.
+   * @param { object } dialog 
   */
-  _addevents( dialog ) {
+  #addevents( dialog ) {
 
     /* Drachtio doesn't appear to have finished SE support, i.e. it sends
     a regular INVITE when we set the Supported: timer and Session-Expires headers
     but it doesn't appear to indicate to us when it does fail. It most cases our
     RTP stall timer will kick in first, but if a call is placed on hold followed
-    by AWOL... */
+    by AWOL... My new startegy is we perform teh reinvite - if we are the refresher
+    which should refresh any timer in Drachtio - and we check for revites and timeouts. */
     this._timers.seinterval = setInterval( async () => {
 
       try {
-        if( this.destroyed ) {
-          /* this should be done - but we are still running */
+        if( this.destroyed || this.#hasseexpiredexpired() ) {
           clearInterval( this._timers.seinterval )
           return
         }
 
+        if( this.#refresher !== this.type ) return
         if( "function" != typeof dialog.request ) return
 
-        if( this._iswebrtc && this.channels && this.channels.audio ) {
-          /* we are sending invite so we MUST offer be actpass */
-          this.channels.secure.audio.offer = true
-          this.sdp.local
-            .secure( this.channels.audio.local.dtls.fingerprint, this.#getsrtpsetup( this.channels.secure.audio ) )
-        }
+        this.#checkthischannelforwebrtcdirection()
 
         const opts = {
-          "method": "INVITE",
-          "body": this.sdp.local.toString()
+          method: "INVITE",
+          body: this.sdp.local.toString(),
+          headers: this.options.headers
         }
   
         const res = await dialog.request( opts )
-          .catch( ( e ) => {
-            console.trace( e )
-            this.hangup( hangupcodes.USER_GONE )
-          } )
-  
-        if( !this.destroyed && 200 != res.msg.status ) {
+
+        if( this.destroyed ) return
+        if( 200 != res.msg.status ) {
           this.hangup( hangupcodes.USER_GONE )
+          return
         }
-      } catch( e ) { /* empty */ }
 
-    }, callmanager.options.seexpire )
+        this.#expirelasttouch = +new Date()
+
+      } catch( e ) {
+        console.trace( e )
+      }
+
+    }, this.#seexpire * 0.45 )
+    this.#expirelasttouch = +new Date()
 
     dialog.on( "destroy", ( /* req */ ) => {
       if( this._state._hangup ) return
@@ -2483,6 +2578,7 @@ class call {
 
     dialog.on( "modify", ( req, res ) => {
       //  The application must respond, using the res parameter provided.
+      this.#expirelasttouch = +new Date()
       if( "INVITE" !== req.msg.method ) return
 
       this.channels.secure.audio.reinvite = true
@@ -2514,6 +2610,7 @@ class call {
 
     dialog.on( "refer", async ( req, res ) => {
       try {
+        this.#expirelasttouch = +new Date()
         /*
           We only support the xfer of 2 legged calls. The xfered call will pick up
           the auth from the transferee. For example, inbound anonymous call, gets handled
@@ -3576,19 +3673,17 @@ class call {
    */
   #configcalleridfornewuac() {
 
+    const callerid = this.callerid
+    const calleridrem = this.callerid
+
     let party = ";party=calling"
     if( this.options.partycalled ) {
       party = ";party=called"
+      this.#fromrefertouri( calleridrem )
     }
 
-    const callerid = this.callerid
-
-    let calleridstr = `<sip:${callerid.user}@${callerid.host}>`
-
-    if ( callerid.name )
-      calleridstr = `"${callerid.name}"` + " " + calleridstr
-    else
-      calleridstr = `"${callerid.user}"` + " " + calleridstr
+    const calleridstr = `"${callerid.name?callerid.name:callerid.user}" <sip:${callerid.user}@${callerid.host}>`
+    const calleridstrrem = `"${calleridrem.name?calleridrem.name:calleridrem.user}" <sip:${calleridrem.user}@${calleridrem.host}>`
 
     let privacy = ""
     if( true === this.options.privacy ) {
@@ -3599,7 +3694,7 @@ class call {
       RFC 3325 - should we also consider the P-Preferred-Identity header?
       P-Asserted-Identity?
     */
-    this.options.headers[ "remote-party-id" ] = calleridstr + party + ";screen=yes" + privacy
+    this.options.headers[ "remote-party-id" ] = calleridstrrem + party + ";screen=yes" + privacy
     this.options.headers[ "from" ] = calleridstr
 
     return { user: callerid.user, realm: callerid.host }
@@ -3693,7 +3788,7 @@ class call {
    * @property { boolean } [ clicktocall ] - if set to true, will set autoanswer to true and swap the source and desination on caller ID, set to true for both caller and called
    * @property { boolean } [ partycalled ] - reverses the direction of the call from the invite, from the point of view of the called in a 3pcc context
    * @property { boolean } [ partycaller ] - reverses the direction of the call from the invite, from the point of view of the caller in a 3pcc context
-  * @property { boolean } [ late ] - late negotiation
+   * @property { boolean } [ late ] - late negotiation
    * @property { boolean } [ privacy ] - sets the privacy
    * @property { entity } [ entity ] - used to store this call against and look up a contact string if not supplied.
    * @property { object } [ entity ]
@@ -3785,6 +3880,8 @@ class call {
     newcall.options.headers[ "allow-events" ] = "talk, hold, presence, as-feature-event, dialog, call-info, sla, include-session-description, message-summary, refer"
     newcall.options.headers[ "allow" ] = "INVITE, ACK, BYE, CANCEL, OPTIONS, MESSAGE, INFO, UPDATE, REGISTER, REFER, NOTIFY, PUBLISH, SUBSCRIBE"
     newcall.options.headers[ "supported" ] = "timer, path, replaces"
+    newcall.options.headers[ "min-se" ] = "90"
+    newcall.options.headers[ "session-expires" ] = `${callmanager.options.seexpire/1000}`
     
     newcall.#confignetwork( options )
     await newcall.#openchannelsfornewuac()
@@ -3860,6 +3957,7 @@ class call {
       return newcall
     }
 
+    newcall.#parsesessionexpires( newdialog.res )
     newcall.parseallow( newdialog.res )
 
     newcall.#setdialog( newdialog )
@@ -3892,10 +3990,30 @@ class call {
     this.established = true
   }
 
+  /**
+   * 
+   * @param { object } req 
+   */
+  #parsesessionexpires( req ) {
+    if( !req ) return
+    const se = req.get( "Session-Expires" )
+    if( !se ) return
+
+    const results = se.match( sessionexpirevaluere )
+    let expiresin = parseInt( results[ 1 ] )
+
+    /* min and max values */
+    if( 90 > expiresin ) expiresin = 90
+    if( 3600 < expiresin ) expiresin = 3600
+    this.#seexpire = expiresin * 1000 /* mS */
+
+    if( results[ 2 ] ) this.#refresher = results[ 2 ]
+  }
+
   /**
    * Take as input a request or a response.
-   *
    * @param { object } req
+   * @private - apart from test
    */
   parseallow( req ) {
     if( !req || !req.get ) return
@@ -3927,6 +4045,7 @@ class call {
     const c = new call()
 
     c.type = "uas"
+    c.#refresher = "uas"
 
     /**
       @typedef { Object } source
@@ -3956,6 +4075,7 @@ class call {
     */
     c._res = res
 
+    c.#parsesessionexpires( req )
     c.parseallow( req )
 
     await callstore.set( c )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "3.7.2",
+  "version": "3.7.4",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {