-fix crash observed on FreeBSD
[oweals/gnunet.git] / src / conversation / conversation_api_call.c
1 /*
2   This file is part of GNUnet
3   (C) 2013 Christian Grothoff (and other contributing authors)
4
5   GNUnet is free software; you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published
7   by the Free Software Foundation; either version 3, or (at your
8   option) any later version.
9
10   GNUnet is distributed in the hope that it will be useful, but
11   WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with GNUnet; see the file COPYING.  If not, write to the
17   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18   Boston, MA 02111-1307, USA.
19  */
20
21 /**
22  * @file conversation/conversation_api_call.c
23  * @brief call API to the conversation service
24  * @author Simon Dieterle
25  * @author Andreas Fuchs
26  * @author Christian Grothoff
27  */
28 #include "platform.h"
29 #include "gnunet_conversation_service.h"
30 #include "gnunet_gnsrecord_lib.h"
31 #include "gnunet_gns_service.h"
32 #include "conversation.h"
33
34
35 /**
36  * Possible states of the phone.
37  */
38 enum CallState
39 {
40   /**
41    * We still need to lookup the callee.
42    */
43   CS_LOOKUP = 0,
44
45   /**
46    * The call is ringing.
47    */
48   CS_RINGING,
49
50   /**
51    * The call is in an active conversation.
52    */
53   CS_ACTIVE,
54
55   /**
56    * The call is in termination.
57    */
58   CS_SHUTDOWN,
59
60   /**
61    * The call was suspended by the caller.
62    */
63   CS_SUSPENDED_CALLER,
64
65   /**
66    * The call was suspended by the callee.
67    */
68   CS_SUSPENDED_CALLEE,
69
70   /**
71    * The call was suspended by both caller and callee.
72    */
73   CS_SUSPENDED_BOTH
74 };
75
76
77 /**
78  * Handle for an outgoing call.
79  */
80 struct GNUNET_CONVERSATION_Call
81 {
82
83   /**
84    * Our configuration.
85    */
86   const struct GNUNET_CONFIGURATION_Handle *cfg;
87
88   /**
89    * Handle to talk with CONVERSATION service.
90    */
91   struct GNUNET_CLIENT_Connection *client;
92
93   /**
94    * Our caller identity.
95    */
96   struct GNUNET_IDENTITY_Ego *caller_id;
97
98   /**
99    * Target callee as a GNS address/name.
100    */
101   char *callee;
102
103   /**
104    * Our speaker.
105    */
106   struct GNUNET_SPEAKER_Handle *speaker;
107
108   /**
109    * Our microphone.
110    */
111   struct GNUNET_MICROPHONE_Handle *mic;
112
113   /**
114    * Function to call with events.
115    */
116   GNUNET_CONVERSATION_CallEventHandler event_handler;
117
118   /**
119    * Closure for @e event_handler
120    */
121   void *event_handler_cls;
122
123   /**
124    * Handle for transmitting to the CONVERSATION service.
125    */
126   struct GNUNET_MQ_Handle *mq;
127
128   /**
129    * Connection to GNS (can be NULL).
130    */
131   struct GNUNET_GNS_Handle *gns;
132
133   /**
134    * Active GNS lookup (or NULL).
135    */
136   struct GNUNET_GNS_LookupRequest *gns_lookup;
137
138   /**
139    * Target phone record, only valid after the lookup is done.
140    */
141   struct GNUNET_CONVERSATION_PhoneRecord phone_record;
142
143   /**
144    * State machine for the call.
145    */
146   enum CallState state;
147
148 };
149
150
151 /**
152  * The call got disconnected, reconnect to the service.
153  *
154  * @param call call to reconnect
155  */
156 static void
157 reconnect_call (struct GNUNET_CONVERSATION_Call *call);
158
159
160 /**
161  * Process recorded audio data.
162  *
163  * @param cls closure with the `struct GNUNET_CONVERSATION_Call`
164  * @param data_size number of bytes in @a data
165  * @param data audio data to play
166  */
167 static void
168 transmit_call_audio (void *cls,
169                      size_t data_size,
170                      const void *data)
171 {
172   struct GNUNET_CONVERSATION_Call *call = cls;
173   struct GNUNET_MQ_Envelope *e;
174   struct ClientAudioMessage *am;
175
176   GNUNET_assert (CS_ACTIVE == call->state);
177   e = GNUNET_MQ_msg_extra (am,
178                            data_size,
179                            GNUNET_MESSAGE_TYPE_CONVERSATION_CS_AUDIO);
180   memcpy (&am[1], data, data_size);
181   GNUNET_MQ_send (call->mq, e);
182 }
183
184
185 /**
186  * We received a `struct ClientPhoneSuspendMessage`
187  *
188  * @param cls the `struct GNUNET_CONVERSATION_Call`
189  * @param msg the message
190  */
191 static void
192 handle_call_suspend (void *cls,
193                      const struct GNUNET_MessageHeader *msg)
194 {
195   struct GNUNET_CONVERSATION_Call *call = cls;
196
197   switch (call->state)
198   {
199   case CS_LOOKUP:
200     GNUNET_break (0);
201     reconnect_call (call);
202     break;
203   case CS_RINGING:
204     GNUNET_break_op (0);
205     reconnect_call (call);
206     break;
207   case CS_SUSPENDED_CALLER:
208     call->state = CS_SUSPENDED_BOTH;
209     call->event_handler (call->event_handler_cls,
210                          GNUNET_CONVERSATION_EC_CALL_SUSPENDED);
211     break;
212   case CS_SUSPENDED_CALLEE:
213   case CS_SUSPENDED_BOTH:
214     GNUNET_break_op (0);
215     break;
216   case CS_ACTIVE:
217     call->state = CS_SUSPENDED_CALLEE;
218     call->speaker->disable_speaker (call->speaker->cls);
219     call->mic->disable_microphone (call->mic->cls);
220     call->event_handler (call->event_handler_cls,
221                          GNUNET_CONVERSATION_EC_CALL_SUSPENDED);
222     break;
223   case CS_SHUTDOWN:
224     GNUNET_CONVERSATION_call_stop (call);
225     break;
226   }
227 }
228
229
230 /**
231  * We received a `struct ClientPhoneResumeMessage`
232  *
233  * @param cls the `struct GNUNET_CONVERSATION_Call`
234  * @param msg the message
235  */
236 static void
237 handle_call_resume (void *cls,
238                      const struct GNUNET_MessageHeader *msg)
239 {
240   struct GNUNET_CONVERSATION_Call *call = cls;
241
242   switch (call->state)
243   {
244   case CS_LOOKUP:
245     GNUNET_break (0);
246     reconnect_call (call);
247     break;
248   case CS_RINGING:
249     GNUNET_break_op (0);
250     reconnect_call (call);
251     break;
252   case CS_SUSPENDED_CALLER:
253     GNUNET_break_op (0);
254     break;
255   case CS_SUSPENDED_CALLEE:
256     call->state = CS_ACTIVE;
257     call->speaker->enable_speaker (call->speaker->cls);
258     call->mic->enable_microphone (call->mic->cls,
259                                   &transmit_call_audio,
260                                   call);
261     call->event_handler (call->event_handler_cls,
262                          GNUNET_CONVERSATION_EC_CALL_RESUMED);
263     break;
264   case CS_SUSPENDED_BOTH:
265     call->state = CS_SUSPENDED_CALLER;
266     call->event_handler (call->event_handler_cls,
267                          GNUNET_CONVERSATION_EC_CALL_RESUMED);
268     break;
269   case CS_ACTIVE:
270     GNUNET_break_op (0);
271     break;
272   case CS_SHUTDOWN:
273     GNUNET_CONVERSATION_call_stop (call);
274     break;
275   }
276 }
277
278
279 /**
280  * We received a `struct ClientPhonePickedupMessage`
281  *
282  * @param cls the `struct GNUNET_CONVERSATION_Call`
283  * @param msg the message
284  */
285 static void
286 handle_call_picked_up (void *cls,
287                        const struct GNUNET_MessageHeader *msg)
288 {
289   struct GNUNET_CONVERSATION_Call *call = cls;
290
291   switch (call->state)
292   {
293   case CS_LOOKUP:
294     GNUNET_break (0);
295     reconnect_call (call);
296     break;
297   case CS_RINGING:
298     call->state = CS_ACTIVE;
299     call->speaker->enable_speaker (call->speaker->cls);
300     call->mic->enable_microphone (call->mic->cls,
301                                   &transmit_call_audio,
302                                   call);
303     call->event_handler (call->event_handler_cls,
304                          GNUNET_CONVERSATION_EC_CALL_PICKED_UP);
305     break;
306   case CS_SUSPENDED_CALLER:
307   case CS_SUSPENDED_CALLEE:
308   case CS_SUSPENDED_BOTH:
309   case CS_ACTIVE:
310     GNUNET_break (0);
311     reconnect_call (call);
312     break;
313   case CS_SHUTDOWN:
314     GNUNET_CONVERSATION_call_stop (call);
315     break;
316   }
317 }
318
319
320 /**
321  * We received a `struct ClientPhoneHangupMessage`
322  *
323  * @param cls the `struct GNUNET_CONVERSATION_Call`
324  * @param msg the message
325  */
326 static void
327 handle_call_hangup (void *cls,
328                     const struct GNUNET_MessageHeader *msg)
329 {
330   struct GNUNET_CONVERSATION_Call *call = cls;
331   GNUNET_CONVERSATION_CallEventHandler eh;
332   void *eh_cls;
333
334   switch (call->state)
335   {
336   case CS_LOOKUP:
337     GNUNET_break (0);
338     reconnect_call (call);
339     break;
340   case CS_RINGING:
341   case CS_SUSPENDED_CALLER:
342   case CS_SUSPENDED_CALLEE:
343   case CS_SUSPENDED_BOTH:
344   case CS_ACTIVE:
345     eh = call->event_handler;
346     eh_cls = call->event_handler_cls;
347     GNUNET_CONVERSATION_call_stop (call);
348     eh (eh_cls, GNUNET_CONVERSATION_EC_CALL_HUNG_UP);
349     return;
350   case CS_SHUTDOWN:
351     GNUNET_CONVERSATION_call_stop (call);
352     break;
353   }
354 }
355
356
357 /**
358  * We received a `struct ClientAudioMessage`
359  *
360  * @param cls the `struct GNUNET_CONVERSATION_Call`
361  * @param msg the message
362  */
363 static void
364 handle_call_audio_message (void *cls,
365                            const struct GNUNET_MessageHeader *msg)
366 {
367   struct GNUNET_CONVERSATION_Call *call = cls;
368   const struct ClientAudioMessage *am;
369
370   am = (const struct ClientAudioMessage *) msg;
371   switch (call->state)
372   {
373   case CS_LOOKUP:
374     GNUNET_break (0);
375     reconnect_call (call);
376     break;
377   case CS_RINGING:
378     GNUNET_break (0);
379     reconnect_call (call);
380     break;
381   case CS_SUSPENDED_CALLER:
382     /* can happen: we suspended, other peer did not yet
383        learn about this. */
384     break;
385   case CS_SUSPENDED_CALLEE:
386   case CS_SUSPENDED_BOTH:
387     /* can (rarely) also happen: other peer suspended, but cadet might
388        have had delayed data on the unreliable channel */
389     break;
390   case CS_ACTIVE:
391     call->speaker->play (call->speaker->cls,
392                          ntohs (msg->size) - sizeof (struct ClientAudioMessage),
393                          &am[1]);
394     break;
395   case CS_SHUTDOWN:
396     GNUNET_CONVERSATION_call_stop (call);
397     break;
398   }
399 }
400
401
402 /**
403  * Iterator called on obtained result for a GNS lookup.
404  *
405  * @param cls closure with the `struct GNUNET_CONVERSATION_Call`
406  * @param rd_count number of records in @a rd
407  * @param rd the records in reply
408  */
409 static void
410 handle_gns_response (void *cls,
411                      uint32_t rd_count,
412                      const struct GNUNET_GNSRECORD_Data *rd)
413 {
414   struct GNUNET_CONVERSATION_Call *call = cls;
415   uint32_t i;
416   struct GNUNET_MQ_Envelope *e;
417   struct ClientCallMessage *ccm;
418
419   GNUNET_break (NULL != call->gns_lookup);
420   GNUNET_break (CS_LOOKUP == call->state);
421   call->gns_lookup = NULL;
422   for (i=0;i<rd_count;i++)
423   {
424     if (GNUNET_GNSRECORD_TYPE_PHONE == rd[i].record_type)
425     {
426       if (rd[i].data_size != sizeof (struct GNUNET_CONVERSATION_PhoneRecord))
427       {
428         GNUNET_break_op (0);
429         continue;
430       }
431       memcpy (&call->phone_record,
432               rd[i].data,
433               rd[i].data_size);
434       e = GNUNET_MQ_msg (ccm, GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_CALL);
435       ccm->line = call->phone_record.line;
436       ccm->target = call->phone_record.peer;
437       ccm->caller_id = *GNUNET_IDENTITY_ego_get_private_key (call->caller_id);
438       GNUNET_MQ_send (call->mq, e);
439       call->state = CS_RINGING;
440       call->event_handler (call->event_handler_cls,
441                            GNUNET_CONVERSATION_EC_CALL_RINGING);
442       return;
443     }
444   }
445   /* not found */
446   call->event_handler (call->event_handler_cls,
447                        GNUNET_CONVERSATION_EC_CALL_GNS_FAIL);
448   GNUNET_CONVERSATION_call_stop (call);
449 }
450
451
452 /**
453  * We encountered an error talking with the conversation service.
454  *
455  * @param cls the `struct GNUNET_CONVERSATION_Call`
456  * @param error details about the error
457  */
458 static void
459 call_error_handler (void *cls,
460                     enum GNUNET_MQ_Error error)
461 {
462   struct GNUNET_CONVERSATION_Call *call = cls;
463
464   if (CS_SHUTDOWN == call->state)
465   {
466     GNUNET_CONVERSATION_call_stop (call);
467     return;
468   }
469   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
470               _("Connection to conversation service lost, trying to reconnect\n"));
471   reconnect_call (call);
472 }
473
474
475 /**
476  * The call got disconnected, reconnect to the service.
477  *
478  * @param call call to reconnect
479  */
480 static void
481 reconnect_call (struct GNUNET_CONVERSATION_Call *call)
482 {
483   static struct GNUNET_MQ_MessageHandler handlers[] =
484   {
485     { &handle_call_suspend,
486       GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_SUSPEND,
487       sizeof (struct ClientPhoneSuspendMessage) },
488     { &handle_call_resume,
489       GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_RESUME,
490       sizeof (struct ClientPhoneResumeMessage) },
491     { &handle_call_picked_up,
492       GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_PICKED_UP,
493       sizeof (struct ClientPhonePickedupMessage) },
494     { &handle_call_hangup,
495       GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_HANG_UP,
496       sizeof (struct ClientPhoneHangupMessage) },
497     { &handle_call_audio_message,
498       GNUNET_MESSAGE_TYPE_CONVERSATION_CS_AUDIO,
499       0 },
500     { NULL, 0, 0 }
501   };
502   struct GNUNET_CRYPTO_EcdsaPublicKey my_zone;
503
504   if (CS_ACTIVE == call->state)
505   {
506     call->speaker->disable_speaker (call->speaker->cls);
507     call->mic->disable_microphone (call->mic->cls);
508   }
509   if (NULL != call->mq)
510   {
511     GNUNET_MQ_destroy (call->mq);
512     call->mq = NULL;
513   }
514   if (NULL != call->client)
515   {
516     GNUNET_CLIENT_disconnect (call->client);
517     call->client = NULL;
518   }
519   call->state = CS_SHUTDOWN;
520   call->client = GNUNET_CLIENT_connect ("conversation", call->cfg);
521   if (NULL == call->client)
522   {
523     call->event_handler (call->event_handler_cls,
524                        GNUNET_CONVERSATION_EC_CALL_ERROR);
525     return;
526   }
527
528   call->mq = GNUNET_MQ_queue_for_connection_client (call->client,
529                                                     handlers,
530                                                     &call_error_handler,
531                                                     call);
532   call->state = CS_LOOKUP;
533   GNUNET_IDENTITY_ego_get_public_key (call->caller_id,
534                                       &my_zone);
535   call->gns_lookup = GNUNET_GNS_lookup (call->gns,
536                                         call->callee,
537                                         &my_zone,
538                                         GNUNET_GNSRECORD_TYPE_PHONE,
539                                         GNUNET_NO,
540                                         NULL /* FIXME: add shortening support */,
541                                         &handle_gns_response, call);
542   GNUNET_assert (NULL != call->gns_lookup);
543 }
544
545
546 /**
547  * Call the phone of another user.
548  *
549  * @param cfg configuration to use, specifies our phone service
550  * @param caller_id identity of the caller
551  * @param callee GNS name of the callee (used to locate the callee's record)
552  * @param speaker speaker to use (will be used automatically immediately once the
553  *        #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated); we will NOT generate
554  *        a ring tone on the speaker
555  * @param mic microphone to use (will be used automatically immediately once the
556  *        #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated)
557  * @param event_handler how to notify the owner of the phone about events
558  * @param event_handler_cls closure for @a event_handler
559  */
560 struct GNUNET_CONVERSATION_Call *
561 GNUNET_CONVERSATION_call_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
562                                 struct GNUNET_IDENTITY_Ego *caller_id,
563                                 const char *callee,
564                                 struct GNUNET_SPEAKER_Handle *speaker,
565                                 struct GNUNET_MICROPHONE_Handle *mic,
566                                 GNUNET_CONVERSATION_CallEventHandler event_handler,
567                                 void *event_handler_cls)
568 {
569   struct GNUNET_CONVERSATION_Call *call;
570
571   call = GNUNET_new (struct GNUNET_CONVERSATION_Call);
572   call->cfg = cfg;
573   call->caller_id = caller_id;
574   call->callee = GNUNET_strdup (callee);
575   call->speaker = speaker;
576   call->mic = mic;
577   call->event_handler = event_handler;
578   call->event_handler_cls = event_handler_cls;
579   call->gns = GNUNET_GNS_connect (cfg);
580   reconnect_call (call);
581
582   if ( (NULL == call->client) ||
583        (NULL == call->gns) )
584   {
585     GNUNET_CONVERSATION_call_stop (call);
586     return NULL;
587   }
588   return call;
589 }
590
591
592 /**
593  * Terminate a call.  The call may be ringing or ready at this time.
594  *
595  * @param call call to terminate
596  */
597 void
598 GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call)
599 {
600   if ( (NULL != call->speaker) &&
601        (CS_ACTIVE == call->state) )
602     call->speaker->disable_speaker (call->speaker->cls);
603   if ( (NULL != call->mic) &&
604        (CS_ACTIVE == call->state) )
605     call->mic->disable_microphone (call->mic->cls);
606   if (CS_SHUTDOWN != call->state)
607   {
608     call->state = CS_SHUTDOWN;
609   }
610   if (NULL != call->mq)
611   {
612     GNUNET_MQ_destroy (call->mq);
613     call->mq = NULL;
614   }
615   if (NULL != call->client)
616   {
617     GNUNET_CLIENT_disconnect (call->client);
618     call->client = NULL;
619   }
620   if (NULL != call->gns_lookup)
621   {
622     GNUNET_GNS_lookup_cancel (call->gns_lookup);
623     call->gns_lookup = NULL;
624   }
625   if (NULL != call->gns)
626   {
627     GNUNET_GNS_disconnect (call->gns);
628     call->gns = NULL;
629   }
630   GNUNET_free (call->callee);
631   GNUNET_free (call);
632 }
633
634
635 /**
636  * Pause a call.  Temporarily suspends the use of speaker and
637  * microphone.
638  *
639  * @param call call to pause
640  */
641 void
642 GNUNET_CONVERSATION_call_suspend (struct GNUNET_CONVERSATION_Call *call)
643 {
644   struct GNUNET_MQ_Envelope *e;
645   struct ClientPhoneSuspendMessage *suspend;
646
647   GNUNET_assert ( (CS_SUSPENDED_CALLEE == call->state) ||
648                   (CS_ACTIVE == call->state) );
649   if (CS_ACTIVE == call->state)
650   {
651     call->speaker->disable_speaker (call->speaker->cls);
652     call->mic->disable_microphone (call->mic->cls);
653   }
654   call->speaker = NULL;
655   call->mic = NULL;
656   e = GNUNET_MQ_msg (suspend, GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_SUSPEND);
657   GNUNET_MQ_send (call->mq, e);
658   if (CS_SUSPENDED_CALLER == call->state)
659     call->state = CS_SUSPENDED_BOTH;
660   else
661     call->state = CS_SUSPENDED_CALLER;
662 }
663
664
665 /**
666  * Resumes a call after #GNUNET_CONVERSATION_call_suspend.
667  *
668  * @param call call to resume
669  * @param speaker speaker to use
670  *        a ring tone on the speaker
671  * @param mic microphone to use
672  */
673 void
674 GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,
675                                  struct GNUNET_SPEAKER_Handle *speaker,
676                                  struct GNUNET_MICROPHONE_Handle *mic)
677 {
678   struct GNUNET_MQ_Envelope *e;
679   struct ClientPhoneResumeMessage *resume;
680
681   GNUNET_assert ( (CS_SUSPENDED_CALLER == call->state) ||
682                   (CS_SUSPENDED_BOTH == call->state) );
683   e = GNUNET_MQ_msg (resume, GNUNET_MESSAGE_TYPE_CONVERSATION_CS_PHONE_RESUME);
684   GNUNET_MQ_send (call->mq, e);
685   call->speaker = speaker;
686   call->mic = mic;
687   if (CS_SUSPENDED_CALLER == call->state)
688   {
689     call->state = CS_ACTIVE;
690     call->speaker->enable_speaker (call->speaker->cls);
691     call->mic->enable_microphone (call->mic->cls,
692                                   &transmit_call_audio,
693                                   call);
694   }
695   else
696   {
697     call->state = CS_SUSPENDED_CALLEE;
698   }
699 }
700
701
702 /* end of conversation_api_call.c */