git.sesse.net Git - vlc/blob - src/interface/interaction.c

   1 /*****************************************************************************
   2  * interaction.c: User interaction functions
   3  *****************************************************************************
   4  * Copyright (C) 2005-2006 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Felix Kühne <fkuehne@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /**
  26  *   \file
  27  *   This file contains functions related to user interaction management
  28  */
  29
  30 /*****************************************************************************
  31  * Preamble
  32  *****************************************************************************/
  33 #include <stdlib.h>                                      /* free(), strtol() */
  34 #include <stdio.h>                                                   /* FILE */
  35 #include <string.h>                                            /* strerror() */
  36
  37 #include <vlc/vlc.h>
  38 #include <vlc/input.h>
  39
  40 #include "vlc_interaction.h"
  41 #include "vlc_interface.h"
  42 #include "vlc_playlist.h"
  43
  44 /*****************************************************************************
  45  * Local prototypes
  46  *****************************************************************************/
  47 static void                  intf_InteractionInit( playlist_t *p_playlist );
  48 static interaction_t *       intf_InteractionGet( vlc_object_t *p_this );
  49 static void                  intf_InteractionSearchInterface( interaction_t *
  50                                                           p_interaction );
  51 static int                   intf_WaitAnswer( interaction_t *p_interact,
  52                              interaction_dialog_t *p_dialog );
  53 static int                   intf_Send( interaction_t *p_interact,
  54                              interaction_dialog_t *p_dialog );
  55 static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* , int );
  56 static void                  intf_InteractionDialogDestroy(
  57                                               interaction_dialog_t *p_dialog );
  58
  59 /**
  60  * Send an interaction element to the user
  61  *
  62  * \param p_this the calling vlc_object_t
  63  * \param p_interact the interaction element
  64  * \return VLC_SUCCESS or an error code
  65  */
  66 int  __intf_Interact( vlc_object_t *p_this, interaction_dialog_t *
  67                                     p_dialog )
  68 {
  69     interaction_t *p_interaction = intf_InteractionGet( p_this );
  70
  71     /* Get an id, if we don't already have one */
  72     if( p_dialog->i_id == 0 )
  73     {
  74         p_dialog->i_id = ++p_interaction->i_last_id;
  75     }
  76
  77     if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
  78     {
  79        return VLC_EGENERIC;
  80     }
  81
  82     p_dialog->p_interaction = p_interaction;
  83     p_dialog->p_parent = p_this;
  84
  85     if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY )
  86     {
  87         return intf_WaitAnswer( p_interaction, p_dialog );
  88     }
  89     else
  90     {
  91         p_dialog->i_flags |=  DIALOG_GOT_ANSWER;
  92         return intf_Send( p_interaction, p_dialog );
  93     }
  94 }
  95
  96 /**
  97  * Destroy the interaction system
  98  * \param The interaction object to destroy
  99  * \return nothing
 100  */
 101 void intf_InteractionDestroy( interaction_t *p_interaction )
 102 {
 103     int i;
 104
 105     // Remove all dialogs - Interfaces must be able to clean up their data
 106
 107     for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
 108     {
 109         interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
 110         intf_InteractionDialogDestroy( p_dialog );
 111         REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
 112     }
 113
 114     vlc_object_destroy( p_interaction );
 115 }
 116
 117 /**
 118  * The main interaction processing loop
 119  * This function is called from the playlist loop
 120  *
 121  * \param p_playlist the parent playlist
 122  * \return nothing
 123  */
 124 void intf_InteractionManage( playlist_t *p_playlist )
 125 {
 126     vlc_value_t val;
 127     int i_index;
 128     interaction_t *p_interaction;
 129
 130     p_interaction = p_playlist->p_interaction;
 131
 132     // Nothing to do
 133     if( p_interaction->i_dialogs == 0 ) return;
 134
 135     vlc_mutex_lock( &p_interaction->object_lock );
 136
 137     intf_InteractionSearchInterface( p_interaction );
 138
 139     if( !p_interaction->p_intf )
 140     {
 141         // We mark all dialogs as answered with their "default" answer
 142         for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
 143         {
 144             interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
 145
 146             // Give default answer
 147             p_dialog->i_return = DIALOG_DEFAULT;
 148             if( p_dialog->i_flags & DIALOG_OK_CANCEL )
 149                 p_dialog->i_return = DIALOG_CANCELLED;
 150
 151             // Pretend we have hidden and destroyed it
 152             if( p_dialog->i_status == HIDDEN_DIALOG )
 153             {
 154                 p_dialog->i_status = DESTROYED_DIALOG;
 155             }
 156             else
 157             {
 158                 p_dialog->i_status = HIDING_DIALOG;
 159             }
 160         }
 161     }
 162     else
 163     {
 164         vlc_object_yield( p_interaction->p_intf );
 165     }
 166
 167     for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
 168     {
 169         interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
 170         switch( p_dialog->i_status )
 171         {
 172         case ANSWERED_DIALOG:
 173             // Ask interface to hide it
 174             p_dialog->i_action = INTERACT_HIDE;
 175             val.p_address = p_dialog;
 176             if( p_interaction->p_intf )
 177                 var_Set( p_interaction->p_intf, "interaction", val );
 178             p_dialog->i_status = HIDING_DIALOG;
 179             break;
 180         case UPDATED_DIALOG:
 181             p_dialog->i_action = INTERACT_UPDATE;
 182             val.p_address = p_dialog;
 183             if( p_interaction->p_intf )
 184                 var_Set( p_interaction->p_intf, "interaction", val );
 185             p_dialog->i_status = SENT_DIALOG;
 186             break;
 187         case HIDDEN_DIALOG:
 188             if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
 189             if( !(p_dialog->i_flags & DIALOG_REUSABLE) )
 190             {
 191                 p_dialog->i_action = INTERACT_DESTROY;
 192                 val.p_address = p_dialog;
 193                 if( p_interaction->p_intf )
 194                     var_Set( p_interaction->p_intf, "interaction", val );
 195             }
 196             break;
 197         case DESTROYED_DIALOG:
 198             // Interface has now destroyed it, remove it
 199             REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
 200                          i_index);
 201             i_index--;
 202             intf_InteractionDialogDestroy( p_dialog );
 203             break;
 204         case NEW_DIALOG:
 205             // This is truly a new dialog, send it.
 206             p_dialog->i_action = INTERACT_NEW;
 207             val.p_address = p_dialog;
 208             if( p_interaction->p_intf )
 209                 var_Set( p_interaction->p_intf, "interaction", val );
 210             p_dialog->i_status = SENT_DIALOG;
 211             break;
 212         }
 213     }
 214
 215     if( p_interaction->p_intf )
 216     {
 217         vlc_object_release( p_interaction->p_intf );
 218     }
 219
 220     vlc_mutex_unlock( &p_playlist->p_interaction->object_lock );
 221 }
 222
 223
 224
 225 #define INTERACT_INIT( new )                                            \
 226         new = (interaction_dialog_t*)malloc(                            \
 227                         sizeof( interaction_dialog_t ) );               \
 228         new->i_widgets = 0;                                             \
 229         new->pp_widgets = NULL;                                         \
 230         new->psz_title = NULL;                                          \
 231         new->psz_description = NULL;                                    \
 232         new->p_private = 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     p_new->i_flags |= DIALOG_CLEAR_NOSHOW;
 290
 291     intf_Interact( p_this, p_new );
 292 }
 293
 294 /** Helper function to ask a yes-no question
 295  *  \param p_this           Parent vlc_object
 296  *  \param psz_title        Title for the dialog
 297  *  \param psz_description  A description
 298  *  \return                 Clicked button code
 299  */
 300 int __intf_UserYesNo( vlc_object_t *p_this,
 301                       const char *psz_title,
 302                       const char *psz_description )
 303 {
 304     int i_ret;
 305     interaction_dialog_t *p_new = NULL;
 306     user_widget_t *p_widget = NULL;
 307
 308     INTERACT_INIT( p_new );
 309
 310     p_new->i_type = INTERACT_DIALOG_TWOWAY;
 311     p_new->psz_title = strdup( psz_title );
 312
 313     /* Text */
 314     p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
 315     p_widget->i_type = WIDGET_TEXT;
 316     p_widget->psz_text = strdup( psz_description );
 317     p_widget->val.psz_string = NULL;
 318     INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
 319                   p_new->i_widgets,  p_widget );
 320
 321     p_new->i_flags = DIALOG_YES_NO_CANCEL;
 322
 323     i_ret = intf_Interact( p_this, p_new );
 324
 325     return i_ret;
 326 }
 327
 328 /** Helper function to make a progressbar box
 329  *  \param p_this           Parent vlc_object
 330  *  \param psz_title        Title for the dialog
 331  *  \param psz_status       Current status
 332  *  \param f_position       Current position (0.0->100.0)
 333  *  \return                 Dialog id, to give to UserProgressUpdate
 334  */
 335 int __intf_UserProgress( vlc_object_t *p_this,
 336                          const char *psz_title,
 337                          const char *psz_status,
 338                          float f_pos )
 339 {
 340     int i_ret;
 341     interaction_dialog_t *p_new = NULL;
 342
 343     INTERACT_INIT( p_new );
 344
 345     p_new->i_type = INTERACT_DIALOG_ONEWAY;
 346     p_new->psz_title = strdup( psz_title );
 347     p_new->psz_description = strdup( psz_status );
 348     p_new->val.f_float = f_pos;
 349
 350     p_new->i_flags = DIALOG_USER_PROGRESS;
 351
 352     i_ret = intf_Interact( p_this, p_new );
 353
 354     return p_new->i_id;
 355 }
 356
 357 /** Update a progress bar
 358  *  \param p_this           Parent vlc_object
 359  *  \param i_id             Identifier of the dialog
 360  *  \param psz_status       New status
 361  *  \param f_position       New position (0.0->100.0)
 362  *  \return                 nothing
 363  */
 364 void __intf_UserProgressUpdate( vlc_object_t *p_this, int i_id,
 365                                 const char *psz_status, float f_pos )
 366 {
 367     interaction_t *p_interaction = intf_InteractionGet( p_this );
 368     interaction_dialog_t *p_dialog;
 369
 370     if( !p_interaction ) return;
 371
 372     vlc_mutex_lock( &p_interaction->object_lock );
 373     p_dialog  =  intf_InteractionGetById( p_this, i_id );
 374
 375     if( !p_dialog )
 376     {
 377         vlc_mutex_unlock( &p_interaction->object_lock ) ;
 378         return;
 379     }
 380
 381     if( p_dialog->psz_description )
 382         free( p_dialog->psz_description );
 383     p_dialog->psz_description = strdup( psz_status );
 384
 385     p_dialog->val.f_float = f_pos;
 386
 387     p_dialog->i_status = UPDATED_DIALOG;
 388     vlc_mutex_unlock( &p_interaction->object_lock) ;
 389 }
 390
 391 /** Helper function to make a login/password box
 392  *  \param p_this           Parent vlc_object
 393  *  \param psz_title        Title for the dialog
 394  *  \param psz_description  A description
 395  *  \param ppsz_login       Returned login
 396  *  \param ppsz_password    Returned password
 397  *  \return                 Clicked button code
 398  */
 399 int __intf_UserLoginPassword( vlc_object_t *p_this,
 400                               const char *psz_title,
 401                               const char *psz_description,
 402                               char **ppsz_login,
 403                               char **ppsz_password )
 404 {
 405
 406     int i_ret;
 407     interaction_dialog_t *p_new = NULL;
 408
 409     INTERACT_INIT( p_new );
 410
 411     p_new->i_type = INTERACT_DIALOG_TWOWAY;
 412     p_new->psz_title = strdup( psz_title );
 413     p_new->psz_description = strdup( psz_description );
 414
 415     p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
 416
 417     i_ret = intf_Interact( p_this, p_new );
 418
 419     if( i_ret != DIALOG_CANCELLED )
 420     {
 421         *ppsz_login = strdup( p_new->psz_returned[0] );
 422         *ppsz_password = strdup( p_new->psz_returned[1] );
 423     }
 424     return i_ret;
 425 }
 426
 427 /** Hide an interaction dialog
 428  * \param p_this the parent vlc object
 429  * \param i_id the id of the item to hide
 430  * \return nothing
 431  */
 432 void __intf_UserHide( vlc_object_t *p_this, int i_id )
 433 {
 434     interaction_t *p_interaction = intf_InteractionGet( p_this );
 435     interaction_dialog_t *p_dialog;
 436
 437     if( !p_interaction ) return;
 438
 439     vlc_mutex_lock( &p_interaction->object_lock );
 440     p_dialog  =  intf_InteractionGetById( p_this, i_id );
 441
 442     if( !p_dialog )
 443     {
 444        vlc_mutex_unlock( &p_interaction->object_lock );
 445        return;
 446     }
 447
 448     p_dialog->i_status = ANSWERED_DIALOG;
 449     vlc_mutex_unlock( &p_interaction->object_lock );
 450 }
 451
 452
 453
 454 /**********************************************************************
 455  * The following functions are local
 456  **********************************************************************/
 457
 458 /* Get the interaction object. Create it if needed */
 459 static interaction_t * intf_InteractionGet( vlc_object_t *p_this )
 460 {
 461     playlist_t *p_playlist;
 462     interaction_t *p_interaction;
 463
 464     p_playlist = (playlist_t*) vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
 465                                                 FIND_ANYWHERE );
 466
 467     if( !p_playlist )
 468     {
 469         return NULL;
 470     }
 471
 472     if( p_playlist->p_interaction == NULL )
 473     {
 474         intf_InteractionInit( p_playlist );
 475     }
 476
 477     p_interaction = p_playlist->p_interaction;
 478
 479     vlc_object_release( p_playlist );
 480
 481     return p_interaction;
 482 }
 483
 484 /* Create the interaction object in the given playlist object */
 485 static void intf_InteractionInit( playlist_t *p_playlist )
 486 {
 487     interaction_t *p_interaction;
 488
 489     p_interaction = vlc_object_create( VLC_OBJECT( p_playlist ),
 490                                        sizeof( interaction_t ) );
 491     if( !p_interaction )
 492     {
 493         msg_Err( p_playlist,"out of memory" );
 494         return;
 495     }
 496
 497     p_interaction->i_dialogs = 0;
 498     p_interaction->pp_dialogs = NULL;
 499     p_interaction->p_intf = NULL;
 500     p_interaction->i_last_id = DIALOG_LAST_PREDEFINED + 1;
 501
 502     vlc_mutex_init( p_interaction , &p_interaction->object_lock );
 503
 504     p_playlist->p_interaction  = p_interaction;
 505 }
 506
 507 /* Look for an interface suitable for interaction */
 508 static void intf_InteractionSearchInterface( interaction_t *p_interaction )
 509 {
 510     vlc_list_t  *p_list;
 511     int          i_index;
 512
 513     p_interaction->p_intf = NULL;
 514
 515     p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
 516     if( !p_list )
 517     {
 518         msg_Err( p_interaction, "unable to create module list" );
 519         return;
 520     }
 521
 522     for( i_index = 0; i_index < p_list->i_count; i_index ++ )
 523     {
 524         intf_thread_t *p_intf = (intf_thread_t *)
 525                                         p_list->p_values[i_index].p_object;
 526         if( p_intf->b_interaction )
 527         {
 528             p_interaction->p_intf = p_intf;
 529             break;
 530         }
 531     }
 532     vlc_list_release ( p_list );
 533 }
 534
 535 /* Add a dialog to the queue and wait for answer */
 536 static int intf_WaitAnswer( interaction_t *p_interact,
 537                             interaction_dialog_t *p_dialog )
 538 {
 539     int i;
 540     vlc_bool_t b_found = VLC_FALSE;
 541     vlc_mutex_lock( &p_interact->object_lock );
 542     for( i = 0 ; i< p_interact->i_dialogs; i++ )
 543     {
 544         if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id )
 545         {
 546             b_found = VLC_TRUE;
 547         }
 548     }
 549     if( ! b_found )
 550     {
 551         INSERT_ELEM( p_interact->pp_dialogs,
 552                      p_interact->i_dialogs,
 553                      p_interact->i_dialogs,
 554                      p_dialog );
 555     }
 556     else
 557         p_dialog->i_status = UPDATED_DIALOG;
 558     vlc_mutex_unlock( &p_interact->object_lock );
 559
 560     /// \todo Check that the initiating object is not dying
 561     while( p_dialog->i_status != ANSWERED_DIALOG &&
 562            p_dialog->i_status != HIDING_DIALOG &&
 563            p_dialog->i_status != HIDDEN_DIALOG &&
 564            !p_dialog->p_parent->b_die )
 565     {
 566         msleep( 100000 );
 567     }
 568     /// \todo locking
 569     if( p_dialog->p_parent->b_die )
 570     {
 571         p_dialog->i_return = DIALOG_CANCELLED;
 572         p_dialog->i_status = ANSWERED_DIALOG;
 573     }
 574     p_dialog->i_flags |= DIALOG_GOT_ANSWER;
 575     return p_dialog->i_return;
 576 }
 577
 578 /* Add a dialog to the queue and return */
 579 static int intf_Send( interaction_t *p_interact,
 580                       interaction_dialog_t *p_dialog )
 581 {
 582     int i;
 583     vlc_bool_t b_found = VLC_FALSE;
 584     if( p_interact == NULL ) return VLC_ENOOBJ;
 585     vlc_mutex_lock( &p_interact->object_lock );
 586
 587     for( i = 0 ; i< p_interact->i_dialogs; i++ )
 588     {
 589         if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id )
 590         {
 591             b_found = VLC_TRUE;
 592         }
 593     }
 594     if( !b_found )
 595     {
 596         INSERT_ELEM( p_interact->pp_dialogs,
 597                      p_interact->i_dialogs,
 598                      p_interact->i_dialogs,
 599                      p_dialog );
 600     }
 601     else
 602         p_dialog->i_status = UPDATED_DIALOG;
 603     // Pretend we already retrieved the "answer"
 604     p_dialog->i_flags |= DIALOG_GOT_ANSWER;
 605     vlc_mutex_unlock( &p_interact->object_lock );
 606     return VLC_SUCCESS;
 607 }
 608
 609 /* Find an interaction dialog by its id */
 610 static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* p_this,
 611                                                        int i_id )
 612 {
 613     interaction_t *p_interaction = intf_InteractionGet( p_this );
 614     int i;
 615
 616     if( !p_interaction ) return NULL;
 617
 618     for( i = 0 ; i< p_interaction->i_dialogs; i++ )
 619     {
 620         if( p_interaction->pp_dialogs[i]->i_id == i_id )
 621         {
 622             return p_interaction->pp_dialogs[i];
 623         }
 624     }
 625     return NULL;
 626 }
 627
 628 #define FREE( i ) { if( i ) free( i ); i = NULL; }
 629
 630 static void intf_InteractionDialogDestroy( interaction_dialog_t *p_dialog )
 631 {
 632     int i;
 633     for( i = p_dialog->i_widgets - 1 ; i >= 0 ; i-- )
 634     {
 635         user_widget_t *p_widget = p_dialog->pp_widgets[i];
 636         FREE( p_widget->psz_text );
 637         if( p_widget->i_type == WIDGET_INPUT_TEXT )
 638         {
 639             FREE( p_widget->val.psz_string );
 640         }
 641
 642         REMOVE_ELEM( p_dialog->pp_widgets, p_dialog->i_widgets, i );
 643         free( p_widget );
 644     }
 645     FREE( p_dialog->psz_title );
 646     FREE( p_dialog->psz_description );
 647
 648     FREE( p_dialog->psz_returned[0] );
 649     FREE( p_dialog->psz_returned[1] );
 650
 651     free( p_dialog );
 652 }