Add WebSocketSettings, fix #103.

Author: cloudwebrtc

example/lib/src/register.dart

@@ -41,10 +41,12 @@ class _MyRegisterWidget extends State<RegisterWidget>
   }
 
   void _loadSettings() async {
-     _preferences = await SharedPreferences.getInstance();
+    _preferences = await SharedPreferences.getInstance();
     this.setState(() {
-      _wsUri = _preferences.getString('ws_uri') ?? 'wss://tryit.jssip.net:10443';
-      _sipUri = _preferences.getString('sip_uri') ?? '[email protected]';
+      _wsUri =
+          _preferences.getString('ws_uri') ?? 'wss://tryit.jssip.net:10443';
+      _sipUri =
+          _preferences.getString('sip_uri') ?? '[email protected]';
       _displayName = _preferences.getString('display_name') ?? 'Flutter SIP UA';
       _password = _preferences.getString('password');
       _authorizationUser = _preferences.getString('auth_user');
@@ -97,12 +99,14 @@ class _MyRegisterWidget extends State<RegisterWidget>
     UaSettings settings = UaSettings();
 
     settings.webSocketUrl = _wsUri;
+    settings.webSocketSettings.extraHeaders = _wsExtraHeaders;
+    settings.webSocketSettings.allowBadCertificate = true;
+    settings.webSocketSettings.userAgent = 'Dart/2.8 (dart:io) for OpenSIPS.';
+
     settings.uri = _sipUri;
     settings.authorizationUser = _authorizationUser;
     settings.password = _password;
     settings.displayName = _displayName;
-    settings.webSocketExtraHeaders = _wsExtraHeaders;
-    settings.allowBadCertificate = true;
     settings.userAgent = 'Dart SIP Client v1.0.0';
 
     helper.start(settings);
@@ -187,7 +191,6 @@ class _MyRegisterWidget extends State<RegisterWidget>
                       ),
                     ],
                   ),
-
                   Column(
                     children: <Widget>[
                       Padding(

lib/src/sip_ua_helper.dart

@@ -94,8 +94,8 @@ class SIPUAHelper extends EventManager {
     _uaSettings = uaSettings;
 
     _settings = Settings();
-    var socket = WebSocketInterface(uaSettings.webSocketUrl,
-        uaSettings.webSocketExtraHeaders, uaSettings.allowBadCertificate);
+    var socket = WebSocketInterface(
+        uaSettings.webSocketUrl, uaSettings.webSocketSettings);
     _settings.sockets = [socket];
     _settings.uri = uaSettings.uri;
     _settings.password = uaSettings.password;
@@ -516,10 +516,23 @@ abstract class SipUaHelperListener {
   void onNewMessage(SIPMessageRequest msg);
 }
 
+class WebSocketSettings {
+  /// Add additional HTTP headers, such as:'Origin','Host' or others
+  Map<String, dynamic> extraHeaders = {};
+
+  /// `User Agent` field for dart http client.
+  String userAgent;
+
+  /// Don‘t check the server certificate
+  /// for self-signed certificate.
+  bool allowBadCertificate = false;
+}
+
 class UaSettings {
   String webSocketUrl;
-  Map<String, dynamic> webSocketExtraHeaders;
-  bool allowBadCertificate = false;
+  WebSocketSettings webSocketSettings = WebSocketSettings();
+
+  /// `User Agent` field for sip message.
   String userAgent;
   String uri;
   String authorizationUser;

lib/src/transports/websocket_dart_impl.dart

@@ -2,6 +2,8 @@ import 'dart:io';
 import 'dart:math';
 import 'dart:convert';
 import 'dart:async';
+import 'package:sip_ua/src/sip_ua_helper.dart';
+
 import '../logger.dart';
 import '../grammar.dart';
 
@@ -19,19 +21,17 @@ class WebSocketImpl {
   WebSocketImpl(this._url);
 
   void connect(
-      {Iterable<String> protocols,
-      Map<String, String> extHeaders,
-      bool allowBadCertificate = false}) async {
-    logger.info('connect $_url, $extHeaders, $protocols');
+      {Iterable<String> protocols, WebSocketSettings webSocketSettings}) async {
+    logger.info('connect $_url, ${webSocketSettings.extraHeaders}, $protocols');
     try {
-      if (allowBadCertificate) {
+      if (webSocketSettings.allowBadCertificate) {
         /// Allow self-signed certificate, for test only.
         var parsed_url = Grammar.parse(_url, 'absoluteURI');
-        _socket = await _connectForBadCertificate(
-            parsed_url.scheme, parsed_url.host, parsed_url.port, extHeaders);
+        _socket = await _connectForBadCertificate(parsed_url.scheme,
+            parsed_url.host, parsed_url.port, webSocketSettings);
       } else {
         _socket = await WebSocket.connect(_url,
-            protocols: protocols, headers: extHeaders);
+            protocols: protocols, headers: webSocketSettings.extraHeaders);
       }
 
       this?.onOpen();
@@ -62,12 +62,17 @@ class WebSocketImpl {
 
   /// For test only.
   Future<WebSocket> _connectForBadCertificate(String scheme, String host,
-      int port, Map<String, String> extHeaders) async {
+      int port, WebSocketSettings webSocketSettings) async {
     try {
       var r = new Random();
       var key = base64.encode(List<int>.generate(8, (_) => r.nextInt(255)));
       var securityContext = new SecurityContext();
       var client = HttpClient(context: securityContext);
+
+      if (webSocketSettings.userAgent != null) {
+        client.userAgent = webSocketSettings.userAgent;
+      }
+
       client.badCertificateCallback =
           (X509Certificate cert, String host, int port) {
         logger.warn('Allow self-signed certificate => $host:$port. ');
@@ -86,7 +91,7 @@ class WebSocketImpl {
 
       //request.headers.add('Origin', 'http://localhost:5060');
       //request.headers.add('Sec-WebSocket-Protocol', 'sip');
-      extHeaders.forEach((key, value) {
+      webSocketSettings.extraHeaders.forEach((key, value) {
         request.headers.add(key, value);
       });
 

lib/src/transports/websocket_interface.dart

@@ -1,5 +1,7 @@
 import 'dart:async';
 import 'dart:convert';
+import 'package:sip_ua/sip_ua.dart';
+
 import 'websocket_dart_impl.dart'
     if (dart.library.js) 'websocket_web_impl.dart';
 import 'dart:math';
@@ -19,7 +21,7 @@ class WebSocketInterface implements Socket {
   var _closed = false;
   var _connected = false;
   var weight;
-  Map<String, dynamic> _wsExtraHeaders;
+  WebSocketSettings _webSocketSettings;
 
   final logger = Log();
   @override
@@ -31,8 +33,7 @@ class WebSocketInterface implements Socket {
   @override
   void Function(dynamic data) ondata;
 
-  WebSocketInterface(String url,
-      [Map<String, dynamic> wsExtraHeaders, bool allowBadCertificate]) {
+  WebSocketInterface(String url, [WebSocketSettings webSocketSettings]) {
     logger.debug('new() [url:' + url + ']');
     this._url = url;
     var parsed_url = Grammar.parse(url, 'absoluteURI');
@@ -49,8 +50,7 @@ class WebSocketInterface implements Socket {
       logger.debug('SIP URI: ${this._sip_uri}');
       this._via_transport = parsed_url.scheme.toUpperCase();
     }
-    this._wsExtraHeaders = wsExtraHeaders ?? {};
-    this._allowBadCertificate = allowBadCertificate ?? false;
+    this._webSocketSettings = webSocketSettings ?? WebSocketSettings();
   }
 
   @override
@@ -100,10 +100,9 @@ class WebSocketInterface implements Socket {
         this._onClose(true, closeCode, closeReason);
       };
 
-      await this._ws.connect(extHeaders: {
-        'Sec-WebSocket-Protocol': _websocket_protocol,
-        ...this._wsExtraHeaders
-      }, allowBadCertificate: this._allowBadCertificate);
+      await _ws.connect(
+          protocols: [_websocket_protocol],
+          webSocketSettings: _webSocketSettings);
     } catch (e, s) {
       Log.e(e.toString(), null, s);
       _connected = false;

lib/src/transports/websocket_web_impl.dart

@@ -1,5 +1,7 @@
 import 'dart:html';
 import 'dart:js_util' as JSUtils;
+import 'package:sip_ua/src/sip_ua_helper.dart';
+
 import '../logger.dart';
 
 typedef void OnMessageCallback(dynamic msg);
@@ -17,10 +19,8 @@ class WebSocketImpl {
   WebSocketImpl(this._url);
 
   void connect(
-      {Iterable<String> protocols,
-      Map<String, String> extHeaders,
-      bool allowBadCertificate = false}) async {
-    logger.info('connect $_url, $extHeaders, $protocols');
+      {Iterable<String> protocols, WebSocketSettings webSocketSettings}) async {
+    logger.info('connect $_url, ${webSocketSettings.extraHeaders}, $protocols');
     try {
       _socket = WebSocket(_url, 'sip');
       _socket.onOpen.listen((e) {