Subscribe support (#269)

Perondas · Perondas · Perondas · web-flow · commit 0e5256a41b33 · 2022-04-09T23:34:16.000+08:00
* Implemented subscribe support like here versatica/JsSIP#711 * Fixed type Errors * Made events consistant * Chore: Began Subscriber rework * Feat: Implemented subscribe support * Changed subscriber id to be the call id * Added termination to subscribers * Moved back sdk version to 2.14.0 * Fixed unrealted bug in hangup * Made imports relative Co-authored-by: Perondas <Pperondas@gmail.com> Co-authored-by: Perondas <114622@fhwn.ac.at>
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,6 @@ pubspec.lock
 doc/api/
 .DS_Store
 example/lib/generated_plugin_registrant.dart
+
+.flutter-plugins
+.flutter-plugins-dependencies
diff --git a/example/.gitignore b/example/.gitignore
@@ -71,3 +71,5 @@
 !**/ios/**/default.pbxuser
 !**/ios/**/default.perspectivev3
 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+
+.flutter-plugins-dependencies
diff --git a/example/lib/src/callscreen.dart b/example/lib/src/callscreen.dart
@@ -581,4 +581,9 @@ class _MyCallScreenWidget extends State<CallScreenWidget>
   void onNewMessage(SIPMessageRequest msg) {
     // NO OP
   }
+
+  @override
+  void onNewNotify(Notify ntf) {
+    // TODO: implement onNewNotify
+  }
 }
diff --git a/example/lib/src/dialpad.dart b/example/lib/src/dialpad.dart
@@ -311,4 +311,9 @@ class _MyDialPadWidget extends State<DialPadWidget>
       receivedMsg = msgBody;
     });
   }
+
+  @override
+  void onNewNotify(Notify ntf) {
+    // TODO: implement onNewNotify
+  }
 }
diff --git a/example/lib/src/register.dart b/example/lib/src/register.dart
@@ -293,4 +293,9 @@ class _MyRegisterWidget extends State<RegisterWidget>
   void onNewMessage(SIPMessageRequest msg) {
     // NO OP
   }
+
+  @override
+  void onNewNotify(Notify ntf) {
+    // TODO: implement onNewNotify
+  }
 }
diff --git a/lib/src/constants.dart b/lib/src/constants.dart
@@ -209,7 +209,7 @@ Map<int, String> REASON_PHRASE = <int, String>{
 };
 
 const String ALLOWED_METHODS =
-    'INVITE,ACK,CANCEL,BYE,UPDATE,MESSAGE,OPTIONS,REFER,INFO';
+    'INVITE,ACK,CANCEL,BYE,UPDATE,MESSAGE,OPTIONS,REFER,INFO,NOTIFY';
 const String ACCEPTED_BODY_TYPES = 'application/sdp, application/dtmf-relay';
 const int MAX_FORWARDS = 69;
 const int SESSION_EXPIRES = 90;
diff --git a/lib/src/dialog.dart b/lib/src/dialog.dart
@@ -36,7 +36,7 @@ class Id {
 
 // RFC 3261 12.1.
 class Dialog {
-  Dialog(RTCSession owner, dynamic message, String type, [int? state]) {
+  Dialog(Owner owner, dynamic message, String type, [int? state]) {
     state = state ?? DialogStatus.STATUS_CONFIRMED;
     _owner = owner;
     _ua = owner.ua;
@@ -91,7 +91,7 @@ class Dialog {
         '$type dialog created with status ${_state == DialogStatus.STATUS_EARLY ? 'EARLY' : 'CONFIRMED'}');
   }
 
-  RTCSession? _owner;
+  Owner? _owner;
   UA? _ua;
   bool uac_pending_reply = false;
   bool uas_pending_reply = false;
@@ -108,7 +108,7 @@ class Dialog {
   UA? get ua => _ua;
   Id? get id => _id;
 
-  RTCSession? get owner => _owner;
+  Owner? get owner => _owner;
 
   void update(dynamic message, String type) {
     _state = DialogStatus.STATUS_CONFIRMED;
@@ -263,3 +263,10 @@ class Dialog {
     return true;
   }
 }
+
+abstract class Owner {
+  Function(IncomingRequest) get receiveRequest;
+  int? get status;
+  int get TerminatedCode;
+  UA? get ua;
+}
diff --git a/lib/src/dialog/request_sender.dart b/lib/src/dialog/request_sender.dart
@@ -91,7 +91,7 @@ class DialogRequestSender {
         _request.cseq = _dialog.local_seqnum!.toInt();
         _reattemptTimer = setTimeout(() {
           // TODO(cloudwebrtc): look at dialog state instead.
-          if (_dialog.owner!.status != RTCSession.C.STATUS_TERMINATED) {
+          if (_dialog.owner!.status != _dialog.owner!.TerminatedCode) {
             _reattempt = true;
             _request_sender.send();
           }
diff --git a/lib/src/event_manager/internal_events.dart b/lib/src/event_manager/internal_events.dart
@@ -161,3 +161,8 @@ class EventOnErrorResponse extends EventType {
   EventOnErrorResponse({this.response});
   IncomingMessage? response;
 }
+
+class EventOnNewSubscribe extends EventType {
+  EventOnNewSubscribe({this.request});
+  IncomingRequest? request;
+}
diff --git a/lib/src/event_manager/notifier_events.dart b/lib/src/event_manager/notifier_events.dart
@@ -0,0 +1,18 @@
+import 'package:sip_ua/src/sip_message.dart';
+
+import 'events.dart';
+
+class EventTerminated extends EventType {
+  EventTerminated({this.terminationCode, this.sendFinalNotify});
+  int? terminationCode;
+  bool? sendFinalNotify;
+}
+
+class EventSubscribe extends EventType {
+  EventSubscribe(
+      {this.isUnsubscribe, this.request, this.body, this.content_type});
+  bool? isUnsubscribe;
+  IncomingRequest? request;
+  String? body;
+  String? content_type;
+}
diff --git a/lib/src/event_manager/subscriber_events.dart b/lib/src/event_manager/subscriber_events.dart
@@ -0,0 +1,23 @@
+import '../sip_message.dart';
+import 'events.dart';
+
+class EventTerminated extends EventType {
+  EventTerminated({this.TerminationCode, this.reason, this.retryAfter});
+  int? TerminationCode;
+  String? reason;
+  int? retryAfter;
+}
+
+class EventPending extends EventType {}
+
+class EventActive extends EventType {}
+
+class EventNotify extends EventType {
+  EventNotify({this.isFinal, this.request, this.body, this.contentType});
+  bool? isFinal;
+  IncomingRequest? request;
+  String? body;
+  String? contentType;
+}
+
+class EventAccepted extends EventType {}
diff --git a/lib/src/grammar_parser.dart b/lib/src/grammar_parser.dart
@@ -17093,7 +17093,7 @@ class GrammarParser {
             _failure(_expect85);
           }
           if (success) {
-            final $1 = $$;
+            final $1 = $$[2];
             final $start = startPos1;
             var pos0 = _startPos;
             $$ = ((offset, expires) {
@@ -22438,7 +22438,7 @@ class GrammarParser {
     if (!success && _cursor > _testing) {
       _failure(_expect115);
     }
-    return $$;
+    return data;
   }
 
   dynamic parse_Supported() {
diff --git a/lib/src/rtc_session.dart b/lib/src/rtc_session.dart
@@ -64,7 +64,7 @@ class RFC4028Timers {
   Timer? timer;
 }
 
-class RTCSession extends EventManager {
+class RTCSession extends EventManager implements Owner {
   RTCSession(UA? ua) {
     logger.debug('new');
 
@@ -195,6 +195,9 @@ class RTCSession extends EventManager {
 
   RTCPeerConnection? get connection => _connection;
 
+  @override
+  int get TerminatedCode => C.STATUS_TERMINATED;
+
   RTCDTMFSender get dtmfSender =>
       _connection!.createDtmfSender(_localMediaStream!.getAudioTracks()[0]);
 
diff --git a/lib/src/sip_ua_helper.dart b/lib/src/sip_ua_helper.dart
@@ -3,14 +3,17 @@ import 'dart:async';
 import 'package:flutter_webrtc/flutter_webrtc.dart';
 import 'package:logger/logger.dart';
 
-import 'package:sip_ua/src/rtc_session/refer_subscriber.dart';
 import 'config.dart';
 import 'constants.dart' as DartSIP_C;
 import 'event_manager/event_manager.dart';
+import 'event_manager/subscriber_events.dart';
 import 'logger.dart';
 import 'message.dart';
 import 'rtc_session.dart';
+import 'rtc_session/refer_subscriber.dart';
+import 'sip_message.dart';
 import 'stack_trace_nj.dart';
+import 'subscriber.dart';
 import 'transports/websocket_interface.dart';
 import 'ua.dart';
 
@@ -328,6 +331,16 @@ class SIPUAHelper extends EventManager {
     return _ua!.sendMessage(target, body, options);
   }
 
+  void subscribe(String target, String event, String contentType) {
+    Subscriber s = _ua!.subscribe(target, event, contentType);
+
+    s.on(EventNotify(), (EventNotify event) {
+      _notifyNotifyListeners(event);
+    });
+
+    s.subscribe();
+  }
+
   void terminateSessions(Map<String, dynamic> options) {
     _ua!.terminateSessions(options as Map<String, Object>);
   }
@@ -372,6 +385,12 @@ class SIPUAHelper extends EventManager {
       listener.onNewMessage(msg);
     }
   }
+
+  void _notifyNotifyListeners(EventNotify event) {
+    for (SipUaHelperListener listener in _sipUaHelperListeners) {
+      listener.onNewNotify(Notify(request: event.request));
+    }
+  }
 }
 
 enum CallStateEnum {
@@ -422,7 +441,7 @@ class Call {
 
   void hangup([Map<String, dynamic>? options]) {
     assert(_session != null, 'ERROR(hangup): rtc session is invalid!');
-    _session.terminate(options as Map<String, Object>?);
+    _session.terminate(options);
   }
 
   void hold() {
@@ -584,8 +603,14 @@ abstract class SipUaHelperListener {
   void transportStateChanged(TransportState state);
   void registrationStateChanged(RegistrationState state);
   void callStateChanged(Call call, CallState state);
-  //For SIP messaga coming
+  //For SIP message coming
   void onNewMessage(SIPMessageRequest msg);
+  void onNewNotify(Notify ntf);
+}
+
+class Notify {
+  Notify({this.request});
+  IncomingRequest? request;
 }
 
 class RegisterParams {
diff --git a/lib/src/subscriber.dart b/lib/src/subscriber.dart
diff --git a/lib/src/ua.dart b/lib/src/ua.dart

Original file line number	Diff line number	Diff line change
`@@ -581,4 +581,9 @@ class _MyCallScreenWidget extends State<CallScreenWidget>`
`581`	`581`	`void onNewMessage(SIPMessageRequest msg) {`
`582`	`582`	`// NO OP`
`583`	`583`	`}`
	`584`	`+`
	`585`	`+ @override`
	`586`	`+ void onNewNotify(Notify ntf) {`
	`587`	`+ // TODO: implement onNewNotify`
	`588`	`+ }`
`584`	`589`	`}`
Original file line number	Diff line number	Diff line change
`@@ -311,4 +311,9 @@ class _MyDialPadWidget extends State<DialPadWidget>`
`311`	`311`	`receivedMsg = msgBody;`
`312`	`312`	`});`
`313`	`313`	`}`
	`314`	`+`
	`315`	`+ @override`
	`316`	`+ void onNewNotify(Notify ntf) {`
	`317`	`+ // TODO: implement onNewNotify`
	`318`	`+ }`
`314`	`319`	`}`
Original file line number	Diff line number	Diff line change
`@@ -293,4 +293,9 @@ class _MyRegisterWidget extends State<RegisterWidget>`
`293`	`293`	`void onNewMessage(SIPMessageRequest msg) {`
`294`	`294`	`// NO OP`
`295`	`295`	`}`
	`296`	`+`
	`297`	`+ @override`
	`298`	`+ void onNewNotify(Notify ntf) {`
	`299`	`+ // TODO: implement onNewNotify`
	`300`	`+ }`
`296`	`301`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ class DialogRequestSender {`
`91`	`91`	`_request.cseq = _dialog.local_seqnum!.toInt();`
`92`	`92`	`_reattemptTimer = setTimeout(() {`
`93`	`93`	`// TODO(cloudwebrtc): look at dialog state instead.`
`94`		`- if (_dialog.owner!.status != RTCSession.C.STATUS_TERMINATED) {`
	`94`	`+ if (_dialog.owner!.status != _dialog.owner!.TerminatedCode) {`
`95`	`95`	`_reattempt = true;`
`96`	`96`	`_request_sender.send();`
`97`	`97`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,3 +161,8 @@ class EventOnErrorResponse extends EventType {`
`161`	`161`	`EventOnErrorResponse({this.response});`
`162`	`162`	`IncomingMessage? response;`
`163`	`163`	`}`
	`164`	`+`
	`165`	`+class EventOnNewSubscribe extends EventType {`
	`166`	`+ EventOnNewSubscribe({this.request});`
	`167`	`+ IncomingRequest? request;`
	`168`	`+}`