Merge pull request #80 from TatankaConCube/fixes_and_improvements

Fixes and improvements

Author: vukoye

.gitignore

@@ -9,3 +9,6 @@ build/
 
 # Directory created by dartdoc
 doc/api/
+
+# IDE directories
+/.idea/

README.md

@@ -37,7 +37,12 @@ __Actively working on:__
 import 'package:xmpp_stone/xmpp_stone.dart' as xmpp;
 
 main() {
-  xmpp.Connection connection = new xmpp.Connection("user@domain", "password", 5222);
+  xmpp.XmppAccountSettings accountSettings = xmpp.XmppAccountSettings.fromJid('nick@damain.com/resource', 'password');
+  accountSettings.port = kIsWeb ? 5291 : 5222;
+  accountSettings.wsPath = 'xmpp-websocket'; // null or your custom xmpp path
+  accountSettings.wsProtocols = ['xmpp']; // or your custom protocols
+
+  xmpp.Connection connection = xmpp.Connection.getInstance(accountSettings);
   connection.open();
 }
 ```

lib/src/Connection.dart

@@ -5,25 +5,19 @@ import 'package:collection/collection.dart' show IterableExtension;
 import 'package:xml/xml.dart' as xml;
 import 'package:synchronized/synchronized.dart';
 import 'package:xmpp_stone/src/ReconnectionManager.dart';
-import 'package:xmpp_stone/src/account/XmppAccountSettings.dart';
 
-import 'package:xmpp_stone/src/data/Jid.dart';
 import 'package:xmpp_stone/src/elements/nonzas/Nonza.dart';
-import 'package:xmpp_stone/src/elements/stanzas/AbstractStanza.dart';
-import 'package:xmpp_stone/src/extensions/ping/PingManager.dart';
 import 'package:xmpp_stone/src/features/ConnectionNegotatiorManager.dart';
 import 'package:xmpp_stone/src/features/servicediscovery/CarbonsNegotiator.dart';
 import 'package:xmpp_stone/src/features/servicediscovery/MAMNegotiator.dart';
 import 'package:xmpp_stone/src/features/servicediscovery/ServiceDiscoveryNegotiator.dart';
 import 'package:xmpp_stone/src/features/streammanagement/StreamManagmentModule.dart';
 import 'package:xmpp_stone/src/parser/StanzaParser.dart';
-import 'package:xmpp_stone/src/presence/PresenceManager.dart';
-import 'package:xmpp_stone/src/roster/RosterManager.dart';
 import 'package:xmpp_stone/xmpp_stone.dart';
 
 import 'connection/XmppWebsocketApi.dart'
-  if (dart.library.io) 'connection/XmppWebsocketIo.dart'
-  if (dart.library.html) 'connection/XmppWebsocketHtml.dart' as xmppSocket;
+    if (dart.library.io) 'connection/XmppWebsocketIo.dart'
+    if (dart.library.html) 'connection/XmppWebsocketHtml.dart' as xmppSocket;
 
 import 'logger/Log.dart';
 
@@ -151,13 +145,7 @@ class Connection {
   }
 
   void _openStream() {
-    var streamOpeningString = """
-<?xml version='1.0'?>
-<stream:stream xmlns='jabber:client' version='1.0' xmlns:stream='http://etherx.jabber.org/streams'
-to='${fullJid.domain}'
-xml:lang='en'
->
-""";
+    var streamOpeningString = _socket?.getStreamOpeningElement(fullJid.domain);
     write(streamOpeningString);
   }
 
@@ -208,16 +196,22 @@ xml:lang='en'
     connectionNegotatiorManager.init();
     setState(XmppConnectionState.SocketOpening);
     try {
-
       var socket = xmppSocket.createSocket();
 
-      return await socket.connect(account.host ?? account.domain, account.port, map: prepareStreamResponse).then((socket) {
+      return await socket
+          .connect(
+        account.host ?? account.domain,
+        account.port,
+        wsProtocols: account.wsProtocols,
+        wsPath: account.wsPath,
+        map: prepareStreamResponse,
+      )
+          .then((socket) {
         // if not closed in meantime
         if (_state != XmppConnectionState.Closed) {
           setState(XmppConnectionState.SocketOpened);
           _socket = socket;
-          socket
-              .listen(handleResponse, onDone: handleConnectionDone);
+          socket.listen(handleResponse, onDone: handleConnectionDone);
           _openStream();
         } else {
           Log.d(TAG, 'Closed in meantime');
@@ -251,10 +245,10 @@ xml:lang='en'
 
   /// Dispose of the connection so stops all activities and cannot be re-used.
   /// For the connection to be garbage collected.
-  /// 
+  ///
   /// If the Connection instance was created with [getInstance],
   /// you must also call [Connection.removeInstance] after calling [dispose].
-  /// 
+  ///
   /// If you intend to re-use the connection later, consider just calling [close] instead.
   void dispose() {
     close();
@@ -309,36 +303,30 @@ xml:lang='en'
     if (fullResponse.isNotEmpty) {
       xml.XmlNode? xmlResponse;
       try {
-        xmlResponse = xml.XmlDocument.parse(fullResponse).firstChild;
+        xmlResponse = xml.XmlDocument.parse(fullResponse.replaceAll('<?xml version=\'1.0\'?>', '')).firstChild;
       } catch (e) {
         _unparsedXmlResponse += fullResponse.substring(
             0, fullResponse.length - 13); //remove  xmpp_stone end tag
         xmlResponse = xml.XmlElement(xml.XmlName('error'));
       }
-//      xmlResponse.descendants.whereType<xml.XmlElement>().forEach((element) {
-//        Log.d("element: " + element.name.local);
-//      });
+
       //TODO: Improve parser for children only
-      xmlResponse!.descendants
-          .whereType<xml.XmlElement>()
+      xmlResponse!.childElements
           .where((element) => startMatcher(element))
           .forEach((element) => processInitialStream(element));
 
-      xmlResponse.children
-          .whereType<xml.XmlElement>()
+      xmlResponse.childElements
           .where((element) => stanzaMatcher(element))
           .map((xmlElement) => StanzaParser.parseStanza(xmlElement))
           .forEach((stanza) => _inStanzaStreamController.add(stanza));
 
-      xmlResponse.descendants
-          .whereType<xml.XmlElement>()
+      xmlResponse.childElements
           .where((element) => featureMatcher(element))
           .forEach((feature) =>
               connectionNegotatiorManager.negotiateFeatureList(feature));
 
       //TODO: Probably will introduce bugs!!!
-      xmlResponse.children
-          .whereType<xml.XmlElement>()
+      xmlResponse.childElements
           .where((element) => nonzaMatcher(element))
           .map((xmlElement) => Nonza.parse(xmlElement))
           .forEach((nonza) => _inNonzaStreamController.add(nonza));
@@ -405,9 +393,10 @@ xml:lang='en'
   void startSecureSocket() {
     Log.d(TAG, 'startSecureSocket');
 
-    _socket!.secure(onBadCertificate: _validateBadCertificate).
-        then((secureSocket) {
-          if(secureSocket == null) return;
+    _socket!
+        .secure(onBadCertificate: _validateBadCertificate)
+        .then((secureSocket) {
+      if (secureSocket == null) return;
 
       secureSocket
           .cast<List<int>>()

lib/src/account/XmppAccountSettings.dart

@@ -8,12 +8,14 @@ class XmppAccountSettings {
   String password;
   String? host;
   int port;
+  String? wsPath;
+  List<String>? wsProtocols;
   int totalReconnections = 3;
   int reconnectionTimeout = 1000;
   bool ackEnabled = true;
   bool smResumable = true;
 
-  XmppAccountSettings(this.name, this.username, this.domain, this.password, this.port, {this.host, this.resource} );
+  XmppAccountSettings(this.name, this.username, this.domain, this.password, this.port, {this.host, this.resource, this.wsPath, this.wsProtocols} );
 
   Jid get fullJid => Jid(username, domain, resource);
 

lib/src/connection/XmppWebsocketApi.dart

@@ -11,7 +11,7 @@ bool isTlsRequired() {
 
 abstract class XmppWebSocket extends Stream<String> {
   Future<XmppWebSocket> connect<S>(String host, int port,
-      {String Function(String event)? map});
+      {String Function(String event)? map, List<String>? wsProtocols, String? wsPath});
 
   void write(Object? message);
 
@@ -22,4 +22,6 @@ abstract class XmppWebSocket extends Stream<String> {
       SecurityContext? context,
       bool Function(X509Certificate certificate)? onBadCertificate,
       List<String>? supportedProtocols});
+
+  String getStreamOpeningElement(String domain);
 }

lib/src/connection/XmppWebsocketHtml.dart

@@ -17,22 +17,24 @@ bool isTlsRequired() {
 }
 
 class XmppWebSocketHtml extends XmppWebSocket {
+  static String TAG = 'XmppWebSocketIo';
+
   WebSocketChannel? _socket;
   late String Function(String event) _map;
 
   XmppWebSocketHtml();
 
   @override
   Future<XmppWebSocket> connect<S>(String host, int port,
-      {String Function(String event)? map}) {
-    print('[XmppWebSocketHtml][connect] host: $host, port: $port');
+      {String Function(String event)? map, List<String>? wsProtocols, String? wsPath}) {
     _socket = WebSocketChannel.connect(
       Uri(
         scheme: 'wss',
         host: host,
         port: port,
+        path: wsPath,
       ),
-      protocols: ['xmpp'],
+      protocols: wsProtocols,
     );
 
     if (map != null) {
@@ -73,4 +75,9 @@ class XmppWebSocketHtml extends XmppWebSocket {
     // return the `null`, cause for the 'html' socket initially creates as secured
     return Future.value(null);
   }
+
+  @override
+  String getStreamOpeningElement(String domain) {
+    return """<open xmlns='urn:ietf:params:xml:ns:xmpp-framing' to='$domain' version='1.0'/>""";
+  }
 }

lib/src/connection/XmppWebsocketIo.dart

@@ -15,14 +15,15 @@ bool isTlsRequired() {
 }
 
 class XmppWebSocketIo extends XmppWebSocket {
+  static String TAG = 'XmppWebSocketIo';
   Socket? _socket;
   late String Function(String event) _map;
 
   XmppWebSocketIo();
 
   @override
   Future<XmppWebSocket> connect<S>(String host, int port,
-      {String Function(String event)? map}) async {
+      {String Function(String event)? map, List<String>? wsProtocols, String? wsPath}) async {
     await Socket.connect(host, port).then((Socket socket) {
       _socket = socket;
 
@@ -64,4 +65,9 @@ class XmppWebSocketIo extends XmppWebSocket {
       List<String>? supportedProtocols}) {
     return SecureSocket.secure(_socket!, onBadCertificate: onBadCertificate);
   }
+
+  @override
+  String getStreamOpeningElement(String domain) {
+    return """<?xml version='1.0'?><stream:stream xmlns='jabber:client' version='1.0' xmlns:stream='http://etherx.jabber.org/streams' to='$domain' xml:lang='en'>""";
+  }
 }

lib/src/features/ConnectionNegotatiorManager.dart

@@ -43,10 +43,8 @@ class ConnectionNegotiatorManager {
 
   void negotiateFeatureList(xml.XmlElement element) {
     Log.d(TAG, 'Negotiating features');
-    var nonzas = element.descendants
-        .whereType<xml.XmlElement>()
-        .map((element) => Nonza.parse(element))
-        .toList();
+    var nonzas =
+        element.childElements.map((element) => Nonza.parse(element)).toList();
     supportedNegotiatorList.forEach((negotiator) {
       var matchingNonzas = negotiator.match(nonzas);
       if (matchingNonzas != null && matchingNonzas.isNotEmpty) {

pubspec.yaml

@@ -12,20 +12,20 @@ environment:
 #dependencies:
 #  path: ^1.4.1
 dependencies:
-  xml: ^5.1.0
+  xml: ^6.1.0
   cryptoutils: ^0.5.0
-  crypto: ^3.0.1
-  synchronized: ^3.0.0
+  crypto: ^3.0.2
+  synchronized: ^3.0.0+3
   tuple: ^2.0.0
   unorm_dart: ^0.2.0
-  image: ^3.0.8
-  quiver: ^3.0.1 #hash code generator
-  console: ^4.0.0 #for example
+  image: ^3.2.0
+  quiver: ^3.1.0 #hash code generator
+  console: ^4.1.0 #for example
   intl: ^0.17.0
-  collection: ^1.15.0
+  collection: ^1.16.0
   universal_io: ^2.0.4
-  web_socket_channel: 2.1.0
+  web_socket_channel: ^2.2.0
 
 dev_dependencies:
-  test: ^1.16.8
-  mockito: ^5.0.3
+  test: ^1.21.4
+  mockito: ^5.3.1