]> git.sesse.net Git - vlc/blob - src/interface/interaction.c
Handle removal
[vlc] / src / interface / interaction.c
1 /*****************************************************************************
2  * interaction.c: User interaction functions
3  *****************************************************************************
4  * Copyright (C) 1998-2004 VideoLAN
5  * $Id: interface.c 10147 2005-03-05 17:18:30Z gbazin $
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /**
25  *   \file
26  *   This file contains functions related to user interaction management
27  */
28
29 /*****************************************************************************
30  * Preamble
31  *****************************************************************************/
32 #include <stdlib.h>                                      /* free(), strtol() */
33 #include <stdio.h>                                                   /* FILE */
34 #include <string.h>                                            /* strerror() */
35
36 #include <vlc/vlc.h>
37 #include <vlc/input.h>
38
39 #include "vlc_interaction.h"
40 #include "vlc_interface.h"
41 #include "vlc_playlist.h"
42
43 /*****************************************************************************
44  * Local prototypes
45  *****************************************************************************/
46 static void                  intf_InteractionInit( playlist_t *p_playlist );
47 static interaction_t *       intf_InteractionGet( vlc_object_t *p_this );
48 static void                  intf_InteractionSearchInterface( interaction_t *
49                                                           p_interaction );
50 static int                   intf_WaitAnswer( interaction_t *p_interact,
51                              interaction_dialog_t *p_dialog );
52 static int                   intf_Send( interaction_t *p_interact,
53                              interaction_dialog_t *p_dialog );
54 static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* , int );
55 static void                  intf_InteractionDialogDestroy(
56                                               interaction_dialog_t *p_dialog );
57
58 /**
59  * Send an interaction element to the user
60  *
61  * \param p_this the calling vlc_object_t
62  * \param p_interact the interaction element
63  * \return VLC_SUCCESS or an error code
64  */
65 int  __intf_Interact( vlc_object_t *p_this, interaction_dialog_t *
66                                     p_dialog )
67 {
68     interaction_t *p_interaction = intf_InteractionGet( p_this );
69
70     /* Get an id, if we don't already have one */
71     if( p_dialog->i_id == 0 )
72     {
73         p_dialog->i_id = ++p_interaction->i_last_id;
74     }
75
76     p_dialog->p_interaction = p_interaction;
77     p_dialog->p_parent = p_this;
78
79     if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY )
80     {
81         return intf_WaitAnswer( p_interaction, p_dialog );
82     }
83     else
84     {
85         p_dialog->i_flags |=  DIALOG_GOT_ANSWER;
86         return intf_Send( p_interaction, p_dialog );
87     }
88 }
89
90 /**
91  * Destroy the interaction system
92  */
93 void intf_InteractionDestroy( interaction_t *p_interaction )
94 {
95     int i;
96
97     // Remove all dialogs - Interfaces must be able to clean up their data
98
99     for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
100     {
101         interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
102         intf_InteractionDialogDestroy( p_dialog );
103         REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
104     }
105
106     vlc_object_destroy( p_interaction );
107 }
108
109 /**
110  * The main interaction processing loop
111  * This function is called from the playlist loop
112  *
113  * \param p_playlist the parent playlist
114  * \return nothing
115  */
116 void intf_InteractionManage( playlist_t *p_playlist )
117 {
118     vlc_value_t val;
119     int i_index;
120     interaction_t *p_interaction;
121
122     p_interaction = p_playlist->p_interaction;
123
124     // Nothing to do
125     if( p_interaction->i_dialogs == 0 ) return;
126
127     vlc_mutex_lock( &p_interaction->object_lock );
128
129     intf_InteractionSearchInterface( p_interaction );
130
131     if( !p_interaction->p_intf )
132     {
133         // We mark all dialogs as answered with their "default" answer
134         for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
135         {
136             interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
137
138             // Give default answer
139             p_dialog->i_return = DIALOG_DEFAULT;
140             if( p_dialog->i_flags & DIALOG_OK_CANCEL )
141                 p_dialog->i_return = DIALOG_CANCELLED;
142             if( p_dialog->i_flags & DIALOG_YES_NO_CANCEL )
143                 p_dialog->i_return = DIALOG_CANCELLED;
144
145             // Pretend we have hidden and destroyed it
146             if( p_dialog->i_status == HIDDEN_DIALOG )
147             {
148                 p_dialog->i_status = DESTROYED_DIALOG;
149             }
150             else
151             {
152                 p_dialog->i_status = HIDING_DIALOG;
153             }
154         }
155     }
156     else
157     {
158         vlc_object_yield( p_interaction->p_intf );
159     }
160
161     for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
162     {
163         interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
164         switch( p_dialog->i_status )
165         {
166         case ANSWERED_DIALOG:
167             // Ask interface to hide it
168             msg_Dbg( p_interaction, "Hiding dialog %i", p_dialog->i_id );
169             p_dialog->i_action = INTERACT_HIDE;
170             val.p_address = p_dialog;
171             if( p_interaction->p_intf )
172                 var_Set( p_interaction->p_intf, "interaction", val );
173             p_dialog->i_status = HIDING_DIALOG;
174             break;
175         case UPDATED_DIALOG:
176             p_dialog->i_action = INTERACT_UPDATE;
177             val.p_address = p_dialog;
178             if( p_interaction->p_intf )
179                 var_Set( p_interaction->p_intf, "interaction", val );
180             p_dialog->i_status = SENT_DIALOG;
181             msg_Dbg( p_interaction, "Updating dialog %i, %i widgets",
182                                     p_dialog->i_id, p_dialog->i_widgets );
183             break;
184         case HIDDEN_DIALOG:
185             if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
186             if( !(p_dialog->i_flags & DIALOG_REUSABLE) )
187             {
188                 msg_Dbg( p_interaction, "Destroying dialog %i",
189                                                 p_dialog->i_id );
190                 p_dialog->i_action = INTERACT_DESTROY;
191                 val.p_address = p_dialog;
192                 if( p_interaction->p_intf )
193                     var_Set( p_interaction->p_intf, "interaction", val );
194             }
195             break;
196         case DESTROYED_DIALOG:
197             msg_Dbg( p_interaction, "Removing dialog %i",
198                                     p_dialog->i_id );
199             // Interface has now destroyed it, remove it
200             REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
201                          i_index);
202             i_index--;
203             intf_InteractionDialogDestroy( p_dialog );
204             break;
205         case NEW_DIALOG:
206             // This is truly a new dialog, send it.
207             p_dialog->i_action = INTERACT_NEW;
208             val.p_address = p_dialog;
209             if( p_interaction->p_intf )
210                 var_Set( p_interaction->p_intf, "interaction", val );
211             p_dialog->i_status = SENT_DIALOG;
212             break;
213         }
214     }
215
216     if( p_interaction->p_intf )
217     {
218         vlc_object_release( p_interaction->p_intf );
219     }
220
221     vlc_mutex_unlock( &p_playlist->p_interaction->object_lock );
222 }
223
224
225
226 #define INTERACT_INIT( new )                                            \
227         new = (interaction_dialog_t*)malloc(                            \
228                         sizeof( interaction_dialog_t ) );               \
229         new->i_widgets = 0;                                             \
230         new->pp_widgets = NULL;                                         \
231         new->psz_title = NULL;                                          \
232         new->psz_description = NULL;                                    \
233         new->i_id = 0;                                                  \
234         new->i_flags = 0;                                               \
235         new->i_status = NEW_DIALOG;
236
237 #define INTERACT_FREE( new )                                            \
238         if( new->psz_title ) free( new->psz_title );                    \
239         if( new->psz_description ) free( new->psz_description );
240
241 /** Helper function to send an error message
242  *  \param p_this     Parent vlc_object
243  *  \param i_id       A predefined ID, 0 if not applicable
244  *  \param psz_title  Title for the dialog
245  *  \param psz_format The message to display
246  *  */
247 void __intf_UserFatal( vlc_object_t *p_this,
248                        const char *psz_title,
249                        const char *psz_format, ... )
250 {
251     va_list args;
252     interaction_dialog_t *p_new = NULL;
253     user_widget_t *p_widget = NULL;
254     int i_id = DIALOG_ERRORS;
255
256     if( i_id > 0 )
257     {
258         p_new = intf_InteractionGetById( p_this, i_id );
259     }
260     if( !p_new )
261     {
262         INTERACT_INIT( p_new );
263         if( i_id > 0 ) p_new->i_id = i_id ;
264     }
265     else
266     {
267         p_new->i_status = UPDATED_DIALOG;
268     }
269
270     p_new->i_flags |= DIALOG_REUSABLE;
271
272     p_new->i_type = INTERACT_DIALOG_ONEWAY;
273     p_new->psz_title = strdup( psz_title );
274
275     p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
276
277     p_widget->i_type = WIDGET_TEXT;
278     p_widget->val.psz_string = NULL;
279
280     va_start( args, psz_format );
281     vasprintf( &p_widget->psz_text, psz_format, args );
282     va_end( args );
283
284     INSERT_ELEM ( p_new->pp_widgets,
285                   p_new->i_widgets,
286                   p_new->i_widgets,
287                   p_widget );
288
289     intf_Interact( p_this, p_new );
290 }
291
292 /** Helper function to make a login/password box
293  *  \param p_this           Parent vlc_object
294  *  \param psz_title        Title for the dialog
295  *  \param psz_description  A description
296  *  \param ppsz_login       Returned login
297  *  \param ppsz_password    Returned password
298  *  \return                 1 if user clicked Cancel, 0 if OK
299  */
300 int __intf_UserLoginPassword( vlc_object_t *p_this,
301                               const char *psz_title,
302                               const char *psz_description,
303                               char **ppsz_login,
304                               char **ppsz_password )
305 {
306     int i_ret;
307     interaction_dialog_t *p_new = NULL;
308     user_widget_t *p_widget = NULL;
309
310     INTERACT_INIT( p_new );
311
312     p_new->i_type = INTERACT_DIALOG_TWOWAY;
313     p_new->psz_title = strdup( psz_title );
314
315     /* Text */
316     p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
317     p_widget->i_type = WIDGET_TEXT;
318     p_widget->psz_text = strdup( psz_description );
319     p_widget->val.psz_string = NULL;
320     INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
321                   p_new->i_widgets,  p_widget );
322
323     /* Login */
324     p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
325     p_widget->i_type = WIDGET_INPUT_TEXT;
326     p_widget->psz_text = strdup( _("Login") );
327     p_widget->val.psz_string = NULL;
328     INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
329                   p_new->i_widgets,  p_widget );
330
331     /* Password */
332     p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
333     p_widget->i_type = WIDGET_INPUT_TEXT;
334     p_widget->psz_text = strdup( _("Password") );
335     p_widget->val.psz_string = NULL;
336     INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
337                   p_new->i_widgets,  p_widget );
338
339     p_new->i_flags = DIALOG_OK_CANCEL;
340
341     i_ret = intf_Interact( p_this, p_new );
342
343     if( i_ret != DIALOG_CANCELLED )
344     {
345         *ppsz_login = strdup( p_new->pp_widgets[1]->val.psz_string );
346         *ppsz_password = strdup( p_new->pp_widgets[2]->val.psz_string );
347     }
348     return i_ret;
349 }
350
351 /**********************************************************************
352  * The following functions are local
353  **********************************************************************/
354
355 /* Get the interaction object. Create it if needed */
356 static interaction_t * intf_InteractionGet( vlc_object_t *p_this )
357 {
358     playlist_t *p_playlist;
359     interaction_t *p_interaction;
360
361     p_playlist = (playlist_t*) vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
362                                                 FIND_ANYWHERE );
363
364     if( !p_playlist )
365     {
366         return NULL;
367     }
368
369     if( p_playlist->p_interaction == NULL )
370     {
371         intf_InteractionInit( p_playlist );
372     }
373
374     p_interaction = p_playlist->p_interaction;
375
376     vlc_object_release( p_playlist );
377
378     return p_interaction;
379 }
380
381 /* Create the interaction object in the given playlist object */
382 static void intf_InteractionInit( playlist_t *p_playlist )
383 {
384     interaction_t *p_interaction;
385
386     msg_Dbg( p_playlist, "initializing interaction system" );
387
388     p_interaction = vlc_object_create( VLC_OBJECT( p_playlist ),
389                                        sizeof( interaction_t ) );
390     if( !p_interaction )
391     {
392         msg_Err( p_playlist,"out of memory" );
393         return;
394     }
395
396     p_interaction->i_dialogs = 0;
397     p_interaction->pp_dialogs = NULL;
398     p_interaction->p_intf = NULL;
399     p_interaction->i_last_id = DIALOG_LAST_PREDEFINED + 1;
400
401     vlc_mutex_init( p_interaction , &p_interaction->object_lock );
402
403     p_playlist->p_interaction  = p_interaction;
404 }
405
406 /* Look for an interface suitable for interaction */
407 static void intf_InteractionSearchInterface( interaction_t *p_interaction )
408 {
409     vlc_list_t  *p_list;
410     int          i_index;
411
412     p_interaction->p_intf = NULL;
413
414     p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
415     if( !p_list )
416     {
417         msg_Err( p_interaction, "Unable to create module list" );
418         return;
419     }
420
421     for( i_index = 0; i_index < p_list->i_count; i_index ++ )
422     {
423         intf_thread_t *p_intf = (intf_thread_t *)
424                                         p_list->p_values[i_index].p_object;
425         if( p_intf->b_interaction )
426         {
427             p_interaction->p_intf = p_intf;
428             break;
429         }
430     }
431     vlc_list_release ( p_list );
432 }
433
434 /* Add a dialog to the queue and wait for answer */
435 static int intf_WaitAnswer( interaction_t *p_interact, interaction_dialog_t *p_dialog )
436 {
437     int i;
438     vlc_bool_t b_found = VLC_FALSE;
439     vlc_mutex_lock( &p_interact->object_lock );
440     for( i = 0 ; i< p_interact->i_dialogs; i++ )
441     {
442         if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id )
443         {
444             b_found = VLC_TRUE;
445         }
446     }
447     if( ! b_found )
448     {
449         INSERT_ELEM( p_interact->pp_dialogs,
450                      p_interact->i_dialogs,
451                      p_interact->i_dialogs,
452                      p_dialog );
453     }
454     else
455         p_dialog->i_status = UPDATED_DIALOG;
456     vlc_mutex_unlock( &p_interact->object_lock );
457
458     /// \todo Check that the initiating object is not dying
459     while( p_dialog->i_status != ANSWERED_DIALOG &&
460            p_dialog->i_status != HIDING_DIALOG &&
461            p_dialog->i_status != HIDDEN_DIALOG &&
462            !p_dialog->p_parent->b_die )
463     {
464         msleep( 100000 );
465     }
466     /// \todo locking
467     if( p_dialog->p_parent->b_die )
468     {
469         p_dialog->i_return = DIALOG_CANCELLED;
470         p_dialog->i_status = ANSWERED_DIALOG;
471     }
472     p_dialog->i_flags |= DIALOG_GOT_ANSWER;
473     return p_dialog->i_return;
474 }
475
476 /* Add a dialog to the queue and return */
477 static int intf_Send( interaction_t *p_interact, interaction_dialog_t *p_dialog )
478 {
479     int i;
480     vlc_bool_t b_found = VLC_FALSE;
481     vlc_mutex_lock( &p_interact->object_lock );
482
483     for( i = 0 ; i< p_interact->i_dialogs; i++ )
484     {
485         if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id )
486         {
487             b_found = VLC_TRUE;
488         }
489     }
490     if( !b_found )
491     {
492         INSERT_ELEM( p_interact->pp_dialogs,
493                      p_interact->i_dialogs,
494                      p_interact->i_dialogs,
495                      p_dialog );
496     }
497     else
498         p_dialog->i_status = UPDATED_DIALOG;
499     // Pretend we already retrieved the "answer"
500     p_dialog->i_flags |= DIALOG_GOT_ANSWER;
501     vlc_mutex_unlock( &p_interact->object_lock );
502     return VLC_SUCCESS;
503 }
504
505 /* Find an interaction dialog by its id */
506 static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* p_this,
507                                                        int i_id )
508 {
509     interaction_t *p_interaction = intf_InteractionGet( p_this );
510     int i;
511
512     if( !p_interaction ) return NULL;
513
514     for( i = 0 ; i< p_interaction->i_dialogs; i++ )
515     {
516         if( p_interaction->pp_dialogs[i]->i_id == i_id )
517         {
518             return p_interaction->pp_dialogs[i];
519         }
520     }
521     return NULL;
522 }
523
524 #define FREE( i ) { if( i ) free( i ); i = NULL; }
525
526 static void intf_InteractionDialogDestroy( interaction_dialog_t *p_dialog )
527 {
528     int i;
529     for( i = p_dialog->i_widgets - 1 ; i >= 0 ; i-- )
530     {
531         user_widget_t *p_widget = p_dialog->pp_widgets[i];
532         FREE( p_widget->psz_text );
533         FREE( p_widget->val.psz_string );
534
535         REMOVE_ELEM( p_dialog->pp_widgets, p_dialog->i_widgets, i );
536         free( p_widget );
537     }
538     FREE( p_dialog->psz_title );
539     FREE( p_dialog->psz_description );
540
541     free( p_dialog );
542 }