1package eu.siacs.conversations.xmpp.jingle;
2
3import android.content.Intent;
4import android.util.Log;
5
6import com.google.common.collect.ImmutableList;
7import com.google.common.collect.ImmutableMap;
8
9import org.webrtc.IceCandidate;
10
11import java.util.ArrayDeque;
12import java.util.Arrays;
13import java.util.Collection;
14import java.util.Collections;
15import java.util.List;
16import java.util.Map;
17
18import eu.siacs.conversations.Config;
19import eu.siacs.conversations.ui.RtpSessionActivity;
20import eu.siacs.conversations.xml.Element;
21import eu.siacs.conversations.xml.Namespace;
22import eu.siacs.conversations.xmpp.jingle.stanzas.Group;
23import eu.siacs.conversations.xmpp.jingle.stanzas.IceUdpTransportInfo;
24import eu.siacs.conversations.xmpp.jingle.stanzas.JinglePacket;
25import eu.siacs.conversations.xmpp.stanzas.MessagePacket;
26import rocks.xmpp.addr.Jid;
27
28public class JingleRtpConnection extends AbstractJingleConnection implements WebRTCWrapper.EventCallback {
29
30 private static final Map<State, Collection<State>> VALID_TRANSITIONS;
31
32 static {
33 final ImmutableMap.Builder<State, Collection<State>> transitionBuilder = new ImmutableMap.Builder<>();
34 transitionBuilder.put(State.NULL, ImmutableList.of(State.PROPOSED, State.SESSION_INITIALIZED));
35 transitionBuilder.put(State.PROPOSED, ImmutableList.of(State.ACCEPTED, State.PROCEED));
36 transitionBuilder.put(State.PROCEED, ImmutableList.of(State.SESSION_INITIALIZED));
37 transitionBuilder.put(State.SESSION_INITIALIZED, ImmutableList.of(State.SESSION_ACCEPTED));
38 VALID_TRANSITIONS = transitionBuilder.build();
39 }
40
41 private final WebRTCWrapper webRTCWrapper = new WebRTCWrapper(this);
42 private final ArrayDeque<IceCandidate> pendingIceCandidates = new ArrayDeque<>();
43 private State state = State.NULL;
44 private RtpContentMap initiatorRtpContentMap;
45 private RtpContentMap responderRtpContentMap;
46
47
48 public JingleRtpConnection(JingleConnectionManager jingleConnectionManager, Id id, Jid initiator) {
49 super(jingleConnectionManager, id, initiator);
50 }
51
52 @Override
53 void deliverPacket(final JinglePacket jinglePacket) {
54 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": packet delivered to JingleRtpConnection");
55 switch (jinglePacket.getAction()) {
56 case SESSION_INITIATE:
57 receiveSessionInitiate(jinglePacket);
58 break;
59 case TRANSPORT_INFO:
60 receiveTransportInfo(jinglePacket);
61 break;
62 case SESSION_ACCEPT:
63 receiveSessionAccept(jinglePacket);
64 break;
65 default:
66 Log.d(Config.LOGTAG, String.format("%s: received unhandled jingle action %s", id.account.getJid().asBareJid(), jinglePacket.getAction()));
67 break;
68 }
69 }
70
71 private void receiveTransportInfo(final JinglePacket jinglePacket) {
72 if (isInState(State.SESSION_INITIALIZED, State.SESSION_ACCEPTED)) {
73 final RtpContentMap contentMap;
74 try {
75 contentMap = RtpContentMap.of(jinglePacket);
76 } catch (IllegalArgumentException | NullPointerException e) {
77 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": improperly formatted contents", e);
78 return;
79 }
80 final RtpContentMap rtpContentMap = isInitiator() ? this.initiatorRtpContentMap : this.responderRtpContentMap;
81 final Group originalGroup = rtpContentMap != null ? rtpContentMap.group : null;
82 final List<String> identificationTags = originalGroup == null ? Collections.emptyList() : originalGroup.getIdentificationTags();
83 if (identificationTags.size() == 0) {
84 Log.w(Config.LOGTAG, id.account.getJid().asBareJid() + ": no identification tags found in initial offer. we won't be able to calculate mLineIndices");
85 }
86 for (final Map.Entry<String, RtpContentMap.DescriptionTransport> content : contentMap.contents.entrySet()) {
87 final String ufrag = content.getValue().transport.getAttribute("ufrag");
88 for (final IceUdpTransportInfo.Candidate candidate : content.getValue().transport.getCandidates()) {
89 final String sdp = candidate.toSdpAttribute(ufrag);
90 final String sdpMid = content.getKey();
91 final int mLineIndex = identificationTags.indexOf(sdpMid);
92 final IceCandidate iceCandidate = new IceCandidate(sdpMid, mLineIndex, sdp);
93 Log.d(Config.LOGTAG, "received candidate: " + iceCandidate);
94 if (isInState(State.SESSION_ACCEPTED)) {
95 this.webRTCWrapper.addIceCandidate(iceCandidate);
96 } else {
97 this.pendingIceCandidates.push(iceCandidate);
98 }
99 }
100 }
101 } else {
102 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": received transport info while in state=" + this.state);
103 }
104 }
105
106 private void receiveSessionInitiate(final JinglePacket jinglePacket) {
107 if (isInitiator()) {
108 Log.d(Config.LOGTAG, String.format("%s: received session-initiate even though we were initiating", id.account.getJid().asBareJid()));
109 //TODO respond with out-of-order
110 return;
111 }
112 final RtpContentMap contentMap;
113 try {
114 contentMap = RtpContentMap.of(jinglePacket);
115 contentMap.requireContentDescriptions();
116 } catch (IllegalArgumentException | IllegalStateException | NullPointerException e) {
117 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": improperly formatted contents", e);
118 return;
119 }
120 Log.d(Config.LOGTAG, "processing session-init with " + contentMap.contents.size() + " contents");
121 final State oldState = this.state;
122 if (transition(State.SESSION_INITIALIZED)) {
123 this.initiatorRtpContentMap = contentMap;
124 if (oldState == State.PROCEED) {
125 Log.d(Config.LOGTAG, "automatically accepting");
126 sendSessionAccept();
127 } else {
128 Log.d(Config.LOGTAG, "start ringing");
129 //TODO start ringing
130 }
131 } else {
132 Log.d(Config.LOGTAG, String.format("%s: received session-initiate while in state %s", id.account.getJid().asBareJid(), state));
133 }
134 }
135
136 private void receiveSessionAccept(final JinglePacket jinglePacket) {
137 if (!isInitiator()) {
138 Log.d(Config.LOGTAG, String.format("%s: received session-accept even though we were responding", id.account.getJid().asBareJid()));
139 //TODO respond with out-of-order
140 return;
141 }
142 final RtpContentMap contentMap;
143 try {
144 contentMap = RtpContentMap.of(jinglePacket);
145 contentMap.requireContentDescriptions();
146 } catch (IllegalArgumentException | IllegalStateException | NullPointerException e) {
147 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": improperly formatted contents", e);
148 return;
149 }
150 Log.d(Config.LOGTAG, "processing session-accept with " + contentMap.contents.size() + " contents");
151 if (transition(State.SESSION_ACCEPTED)) {
152 receiveSessionAccept(contentMap);
153 } else {
154 Log.d(Config.LOGTAG, String.format("%s: received session-accept while in state %s", id.account.getJid().asBareJid(), state));
155 //TODO out-of-order
156 }
157 }
158
159 private void receiveSessionAccept(final RtpContentMap contentMap) {
160 this.responderRtpContentMap = contentMap;
161 org.webrtc.SessionDescription answer = new org.webrtc.SessionDescription(
162 org.webrtc.SessionDescription.Type.ANSWER,
163 SessionDescription.of(contentMap).toString()
164 );
165 try {
166 this.webRTCWrapper.setRemoteDescription(answer).get();
167 } catch (Exception e) {
168 Log.d(Config.LOGTAG, "unable to receive session accept", e);
169 }
170 }
171
172 private void sendSessionAccept() {
173 final RtpContentMap rtpContentMap = this.initiatorRtpContentMap;
174 if (rtpContentMap == null) {
175 throw new IllegalStateException("initiator RTP Content Map has not been set");
176 }
177 setupWebRTC();
178 final org.webrtc.SessionDescription offer = new org.webrtc.SessionDescription(
179 org.webrtc.SessionDescription.Type.OFFER,
180 SessionDescription.of(rtpContentMap).toString()
181 );
182 try {
183 this.webRTCWrapper.setRemoteDescription(offer).get();
184 org.webrtc.SessionDescription webRTCSessionDescription = this.webRTCWrapper.createAnswer().get();
185 final SessionDescription sessionDescription = SessionDescription.parse(webRTCSessionDescription.description);
186 final RtpContentMap respondingRtpContentMap = RtpContentMap.of(sessionDescription);
187 sendSessionAccept(respondingRtpContentMap);
188 this.webRTCWrapper.setLocalDescription(webRTCSessionDescription);
189 } catch (Exception e) {
190 Log.d(Config.LOGTAG, "unable to send session accept", e);
191
192 }
193 }
194
195 private void sendSessionAccept(final RtpContentMap rtpContentMap) {
196 this.responderRtpContentMap = rtpContentMap;
197 this.transitionOrThrow(State.SESSION_ACCEPTED);
198 final JinglePacket sessionAccept = rtpContentMap.toJinglePacket(JinglePacket.Action.SESSION_ACCEPT, id.sessionId);
199 Log.d(Config.LOGTAG, sessionAccept.toString());
200 send(sessionAccept);
201 }
202
203 void deliveryMessage(final Jid from, final Element message) {
204 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": delivered message to JingleRtpConnection " + message);
205 switch (message.getName()) {
206 case "propose":
207 receivePropose(from, message);
208 break;
209 case "proceed":
210 receiveProceed(from, message);
211 default:
212 break;
213 }
214 }
215
216 private void receivePropose(final Jid from, final Element propose) {
217 final boolean originatedFromMyself = from.asBareJid().equals(id.account.getJid().asBareJid());
218 //TODO we can use initiator logic here
219 if (originatedFromMyself) {
220 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": saw proposal from mysql. ignoring");
221 } else if (transition(State.PROPOSED)) {
222 startRinging();
223 } else {
224 Log.d(Config.LOGTAG, id.account.getJid() + ": ignoring session proposal because already in " + state);
225 }
226 }
227
228 private void startRinging() {
229 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": received call from " + id.with + ". start ringing");
230 final Intent intent = new Intent(xmppConnectionService, RtpSessionActivity.class);
231 intent.putExtra(RtpSessionActivity.EXTRA_ACCOUNT, id.account.getJid().asBareJid().toEscapedString());
232 intent.putExtra(RtpSessionActivity.EXTRA_WITH, id.with.toEscapedString());
233 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
234 xmppConnectionService.startActivity(intent);
235 }
236
237 private void receiveProceed(final Jid from, final Element proceed) {
238 if (from.equals(id.with)) {
239 if (isInitiator()) {
240 if (transition(State.PROCEED)) {
241 this.sendSessionInitiate();
242 } else {
243 Log.d(Config.LOGTAG, String.format("%s: ignoring proceed because already in %s", id.account.getJid().asBareJid(), this.state));
244 }
245 } else {
246 Log.d(Config.LOGTAG, String.format("%s: ignoring proceed because we were not initializing", id.account.getJid().asBareJid()));
247 }
248 } else {
249 Log.d(Config.LOGTAG, String.format("%s: ignoring proceed from %s. was expected from %s", id.account.getJid().asBareJid(), from, id.with));
250 }
251 }
252
253 private void sendSessionInitiate() {
254 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": prepare session-initiate");
255 setupWebRTC();
256 try {
257 org.webrtc.SessionDescription webRTCSessionDescription = this.webRTCWrapper.createOffer().get();
258 final SessionDescription sessionDescription = SessionDescription.parse(webRTCSessionDescription.description);
259 Log.d(Config.LOGTAG, "description: " + webRTCSessionDescription.description);
260 final RtpContentMap rtpContentMap = RtpContentMap.of(sessionDescription);
261 sendSessionInitiate(rtpContentMap);
262 this.webRTCWrapper.setLocalDescription(webRTCSessionDescription).get();
263 } catch (Exception e) {
264 Log.d(Config.LOGTAG, "unable to sendSessionInitiate", e);
265 }
266 }
267
268 private void sendSessionInitiate(RtpContentMap rtpContentMap) {
269 this.initiatorRtpContentMap = rtpContentMap;
270 this.transitionOrThrow(State.SESSION_INITIALIZED);
271 final JinglePacket sessionInitiate = rtpContentMap.toJinglePacket(JinglePacket.Action.SESSION_INITIATE, id.sessionId);
272 Log.d(Config.LOGTAG, sessionInitiate.toString());
273 send(sessionInitiate);
274 }
275
276 private void sendTransportInfo(final String contentName, IceUdpTransportInfo.Candidate candidate) {
277 final RtpContentMap transportInfo;
278 try {
279 final RtpContentMap rtpContentMap = isInitiator() ? this.initiatorRtpContentMap : this.responderRtpContentMap;
280 transportInfo = rtpContentMap.transportInfo(contentName, candidate);
281 } catch (Exception e) {
282 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": unable to prepare transport-info from candidate for content=" + contentName);
283 return;
284 }
285 final JinglePacket jinglePacket = transportInfo.toJinglePacket(JinglePacket.Action.TRANSPORT_INFO, id.sessionId);
286 Log.d(Config.LOGTAG, jinglePacket.toString());
287 send(jinglePacket);
288 }
289
290 private void send(final JinglePacket jinglePacket) {
291 jinglePacket.setTo(id.with);
292 //TODO track errors
293 xmppConnectionService.sendIqPacket(id.account, jinglePacket, null);
294 }
295
296
297 public void pickUpCall() {
298 switch (this.state) {
299 case PROPOSED:
300 pickupCallFromProposed();
301 break;
302 case SESSION_INITIALIZED:
303 pickupCallFromSessionInitialized();
304 break;
305 default:
306 throw new IllegalStateException("Can not pick up call from " + this.state);
307 }
308 }
309
310 private void setupWebRTC() {
311 this.webRTCWrapper.setup(this.xmppConnectionService);
312 this.webRTCWrapper.initializePeerConnection();
313 }
314
315 private void pickupCallFromProposed() {
316 transitionOrThrow(State.PROCEED);
317 final MessagePacket messagePacket = new MessagePacket();
318 messagePacket.setTo(id.with);
319 //Note that Movim needs 'accept', correct is 'proceed' https://github.com/movim/movim/issues/916
320 messagePacket.addChild("proceed", Namespace.JINGLE_MESSAGE).setAttribute("id", id.sessionId);
321 Log.d(Config.LOGTAG, messagePacket.toString());
322 xmppConnectionService.sendMessagePacket(id.account, messagePacket);
323 }
324
325 private void pickupCallFromSessionInitialized() {
326
327 }
328
329 private synchronized boolean isInState(State... state) {
330 return Arrays.asList(state).contains(this.state);
331 }
332
333 private synchronized boolean transition(final State target) {
334 final Collection<State> validTransitions = VALID_TRANSITIONS.get(this.state);
335 if (validTransitions != null && validTransitions.contains(target)) {
336 this.state = target;
337 Log.d(Config.LOGTAG, id.account.getJid().asBareJid() + ": transitioned into " + target);
338 return true;
339 } else {
340 return false;
341 }
342 }
343
344 public void transitionOrThrow(final State target) {
345 if (!transition(target)) {
346 throw new IllegalStateException(String.format("Unable to transition from %s to %s", this.state, target));
347 }
348 }
349
350 @Override
351 public void onIceCandidate(final IceCandidate iceCandidate) {
352 final IceUdpTransportInfo.Candidate candidate = IceUdpTransportInfo.Candidate.fromSdpAttribute(iceCandidate.sdp);
353 Log.d(Config.LOGTAG, "sending candidate: " + iceCandidate.toString());
354 sendTransportInfo(iceCandidate.sdpMid, candidate);
355 }
356}