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

   1 /*****************************************************************************
   2  * interaction.c: User interaction functions
   3  *****************************************************************************
   4  * Copyright © 2005-2008 the VideoLAN team
   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
  34 #ifdef HAVE_CONFIG_H
  35 # include "config.h"
  36 #endif
  37
  38 #include <vlc_common.h>
  39
  40 #include <vlc_interface.h>
  41 #include "interface.h"
  42 #include "libvlc.h"
  43
  44 #include <assert.h>
  45
  46 /*****************************************************************************
  47  * Local prototypes
  48  *****************************************************************************/
  49 static interaction_t *          InteractionGet( vlc_object_t * );
  50 static void                     InteractionSearchInterface( interaction_t * );
  51 static void                     InteractionLoop( vlc_object_t * );
  52 static void                     InteractionManage( interaction_t * );
  53
  54 static interaction_dialog_t    *DialogGetById( interaction_t* , int );
  55 static void                     DialogDestroy( interaction_dialog_t * );
  56 static int DialogSend( vlc_object_t *, interaction_dialog_t * );
  57
  58 #define DIALOG_INIT( type ) \
  59         DECMALLOC_ERR( p_new, interaction_dialog_t );       \
  60         memset( p_new, 0, sizeof( interaction_dialog_t ) ); \
  61         p_new->b_cancelled = false;                     \
  62         p_new->i_status = NEW_DIALOG;                       \
  63         p_new->i_flags = 0;                                 \
  64         p_new->i_type = INTERACT_DIALOG_##type;             \
  65         p_new->psz_returned[0] = NULL;                      \
  66         p_new->psz_returned[1] = NULL
  67
  68 #define FORMAT_DESC \
  69         va_start( args, psz_format ); \
  70         if( vasprintf( &p_new->psz_description, psz_format, args ) == -1 ) \
  71             return VLC_EGENERIC; \
  72         va_end( args )
  73
  74 /**
  75  * Send an error message, both in a blocking and non-blocking way
  76  *
  77  * \param p_this     Parent vlc_object
  78  * \param b_blocking Is this dialog blocking or not?
  79  * \param psz_title  Title for the dialog
  80  * \param psz_format The message to display
  81  * \return           VLC_SUCCESS or VLC_EGENERIC
  82  */
  83 int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking,
  84                        const char *psz_title,
  85                        const char *psz_format, ... )
  86 {
  87     va_list args;
  88     DIALOG_INIT( ONEWAY );
  89
  90     p_new->psz_title = strdup( psz_title );
  91     FORMAT_DESC;
  92
  93     if( b_blocking )
  94         p_new->i_flags = DIALOG_BLOCKING_ERROR;
  95     else
  96         p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
  97
  98     return DialogSend( p_this, p_new );
  99 }
 100
 101 /**
 102  * Helper function to send a warning, which is always shown non-blocking
 103  *
 104  * \param p_this     Parent vlc_object
 105  * \param psz_title  Title for the dialog
 106  * \param psz_format The message to display
 107  * \return           VLC_SUCCESS or VLC_EGENERIC
 108  */
 109 int __intf_UserWarn( vlc_object_t *p_this,
 110                      const char *psz_title,
 111                      const char *psz_format, ... )
 112 {
 113     va_list args;
 114     DIALOG_INIT( ONEWAY );
 115
 116     p_new->psz_title = strdup( psz_title );
 117     FORMAT_DESC;
 118
 119     p_new->i_flags = DIALOG_WARNING;
 120
 121     return DialogSend( p_this, p_new );
 122 }
 123
 124 /**
 125  * Helper function to ask a yes-no-cancel question
 126  *
 127  * \param p_this           Parent vlc_object
 128  * \param psz_title        Title for the dialog
 129  * \param psz_description  A description
 130  * \param psz_default      caption for the default button
 131  * \param psz_alternate    caption for the alternate button
 132  * \param psz_other        caption for the optional 3rd button (== cancel)
 133  * \return                 Clicked button code
 134  */
 135 int __intf_UserYesNo( vlc_object_t *p_this,
 136                       const char *psz_title,
 137                       const char *psz_description,
 138                       const char *psz_default,
 139                       const char *psz_alternate,
 140                       const char *psz_other )
 141 {
 142     DIALOG_INIT( TWOWAY );
 143
 144     p_new->psz_title = strdup( psz_title );
 145     p_new->psz_description = strdup( psz_description );
 146     p_new->i_flags = DIALOG_YES_NO_CANCEL;
 147     p_new->psz_default_button = strdup( psz_default );
 148     p_new->psz_alternate_button = strdup( psz_alternate );
 149     if( psz_other )
 150         p_new->psz_other_button = strdup( psz_other );
 151
 152     return DialogSend( p_this, p_new );
 153 }
 154
 155 /**
 156  * Helper function to create a dialogue showing a progress-bar with some info
 157  *
 158  * \param p_this           Parent vlc_object
 159  * \param psz_title        Title for the dialog (NULL implies main intf )
 160  * \param psz_status       Current status
 161  * \param f_position       Current position (0.0->100.0)
 162  * \param i_timeToGo       Time (in sec) to go until process is finished
 163  * \return                 Dialog id, to give to UserProgressUpdate
 164  */
 165 int __intf_Progress( vlc_object_t *p_this, const char *psz_title,
 166                      const char *psz_status, float f_pos, int i_time )
 167 {
 168     DIALOG_INIT( ONEWAY );
 169     p_new->psz_description = strdup( psz_status );
 170     p_new->val.f_float = f_pos;
 171     p_new->i_timeToGo = i_time;
 172     p_new->psz_alternate_button = strdup( _( "Cancel" ) );
 173
 174     if( psz_title )
 175     {
 176         p_new->psz_title = strdup( psz_title );
 177         p_new->i_flags = DIALOG_USER_PROGRESS;
 178     }
 179     else
 180         p_new->i_flags = DIALOG_INTF_PROGRESS;
 181
 182     DialogSend( p_this, p_new );
 183     return p_new->i_id;
 184 }
 185
 186 /**
 187  * Update a progress bar in a dialogue
 188  *
 189  * \param p_this           Parent vlc_object
 190  * \param i_id             Identifier of the dialog
 191  * \param psz_status       New status
 192  * \param f_position       New position (0.0->100.0)
 193  * \param i_timeToGo       Time (in sec) to go until process is finished
 194  * \return                 nothing
 195  */
 196 void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
 197                             const char *psz_status, float f_pos, int i_time )
 198 {
 199     interaction_t *p_interaction = InteractionGet( p_this );
 200     interaction_dialog_t *p_dialog;
 201
 202     if( !p_interaction ) return;
 203
 204     vlc_object_lock( p_interaction );
 205     p_dialog  =  DialogGetById( p_interaction, i_id );
 206
 207     if( !p_dialog )
 208     {
 209         vlc_object_unlock( p_interaction );
 210         vlc_object_release( p_interaction );
 211         return;
 212     }
 213
 214     free( p_dialog->psz_description );
 215     p_dialog->psz_description = strdup( psz_status );
 216
 217     p_dialog->val.f_float = f_pos;
 218     p_dialog->i_timeToGo = i_time;
 219
 220     p_dialog->i_status = UPDATED_DIALOG;
 221
 222     vlc_object_signal_unlocked( p_interaction );
 223     vlc_object_unlock( p_interaction );
 224     vlc_object_release( p_interaction );
 225 }
 226
 227 /**
 228  * Helper function to communicate dialogue cancellations between the
 229  * interface module and the caller
 230  *
 231  * \param p_this           Parent vlc_object
 232  * \param i_id             Identifier of the dialogue
 233  * \return                 Either true or false
 234  */
 235 bool __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
 236 {
 237     interaction_t *p_interaction = InteractionGet( p_this );
 238     interaction_dialog_t *p_dialog;
 239     bool b_cancel;
 240
 241     if( !p_interaction ) return true;
 242
 243     vlc_object_lock( p_interaction );
 244     p_dialog  =  DialogGetById( p_interaction, i_id );
 245     if( !p_dialog )
 246     {
 247         vlc_object_unlock( p_interaction ) ;
 248         vlc_object_release( p_interaction );
 249         return true;
 250     }
 251
 252     b_cancel = p_dialog->b_cancelled;
 253     vlc_object_unlock( p_interaction );
 254     vlc_object_release( p_interaction );
 255     return b_cancel;
 256 }
 257
 258 /**
 259  * Helper function to make a login/password dialogue
 260  *
 261  * \param p_this           Parent vlc_object
 262  * \param psz_title        Title for the dialog
 263  * \param psz_description  A description
 264  * \param ppsz_login       Returned login
 265  * \param ppsz_password    Returned password
 266  * \return                 Clicked button code
 267  */
 268 int __intf_UserLoginPassword( vlc_object_t *p_this,
 269         const char *psz_title,
 270         const char *psz_description,
 271         char **ppsz_login,
 272         char **ppsz_password )
 273 {
 274     int i_ret;
 275     DIALOG_INIT( TWOWAY );
 276     p_new->i_type = INTERACT_DIALOG_TWOWAY;
 277     p_new->psz_title = strdup( psz_title );
 278     p_new->psz_description = strdup( psz_description );
 279     p_new->psz_default_button = strdup( _("Ok" ) );
 280     p_new->psz_alternate_button = strdup( _("Cancel" ) );
 281
 282     p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
 283
 284     i_ret = DialogSend( p_this, p_new );
 285
 286     if( i_ret != DIALOG_CANCELLED && i_ret != VLC_EGENERIC )
 287     {
 288         *ppsz_login = p_new->psz_returned[0]?
 289             strdup( p_new->psz_returned[0] ) : NULL;
 290         *ppsz_password = p_new->psz_returned[1]?
 291             strdup( p_new->psz_returned[1] ) : NULL;
 292     }
 293     return i_ret;
 294 }
 295
 296 /**
 297  * Helper function to make a dialogue asking the user for !password string
 298  *
 299  * \param p_this           Parent vlc_object
 300  * \param psz_title        Title for the dialog
 301  * \param psz_description  A description
 302  * \param ppsz_usersString Returned login
 303  * \return                 Clicked button code
 304  */
 305 int __intf_UserStringInput( vlc_object_t *p_this,
 306         const char *psz_title,
 307         const char *psz_description,
 308         char **ppsz_usersString )
 309 {
 310     int i_ret;
 311     DIALOG_INIT( TWOWAY );
 312     p_new->i_type = INTERACT_DIALOG_TWOWAY;
 313     p_new->psz_title = strdup( psz_title );
 314     p_new->psz_description = strdup( psz_description );
 315
 316     p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL;
 317
 318     i_ret = DialogSend( p_this, p_new );
 319
 320     if( i_ret != DIALOG_CANCELLED )
 321     {
 322         *ppsz_usersString = p_new->psz_returned[0]?
 323             strdup( p_new->psz_returned[0] ) : NULL;
 324     }
 325     return i_ret;
 326 }
 327
 328 /**
 329  * Hide an interaction dialog
 330  *
 331  * \param p_this the parent vlc object
 332  * \param i_id the id of the item to hide
 333  * \return nothing
 334  */
 335 void __intf_UserHide( vlc_object_t *p_this, int i_id )
 336 {
 337     interaction_t *p_interaction = InteractionGet( p_this );
 338     interaction_dialog_t *p_dialog;
 339
 340     if( !p_interaction ) return;
 341
 342     vlc_object_lock( p_interaction );
 343     p_dialog = DialogGetById( p_interaction, i_id );
 344
 345     if( p_dialog )
 346         p_dialog->i_status = ANSWERED_DIALOG;
 347
 348     vlc_object_unlock( p_interaction );
 349     vlc_object_release( p_interaction );
 350 }
 351
 352 /**
 353  * Create the initial interaction object
 354  * (should only be used in libvlc_InternalInit, LibVLC private)
 355  *
 356  * \return a vlc_object_t that should be freed when done.
 357  */
 358 interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
 359 {
 360     interaction_t *p_interaction;
 361
 362     /* Make sure we haven't yet created an interaction object */
 363     assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
 364
 365     p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
 366                                        sizeof( *p_interaction ),
 367                                        VLC_OBJECT_GENERIC, "interaction" );
 368     if( !p_interaction )
 369         return NULL;
 370
 371     vlc_object_attach( p_interaction, p_libvlc );
 372     p_interaction->i_dialogs = 0;
 373     p_interaction->pp_dialogs = NULL;
 374     p_interaction->p_intf = NULL;
 375     p_interaction->i_last_id = 0;
 376
 377     if( vlc_thread_create( p_interaction, "Interaction control",
 378                            InteractionLoop, VLC_THREAD_PRIORITY_LOW,
 379                            false ) )
 380     {
 381         msg_Err( p_interaction, "Interaction control thread creation failed, "
 382                  "interaction will not be displayed" );
 383         vlc_object_detach( p_interaction );
 384         vlc_object_release( p_interaction );
 385         return NULL;
 386     }
 387
 388     return p_interaction;
 389 }
 390
 391 /**********************************************************************
 392  * The following functions are local
 393  **********************************************************************/
 394
 395 /* Get the interaction object. Create it if needed */
 396 static interaction_t * InteractionGet( vlc_object_t *p_this )
 397 {
 398     interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction;
 399     if( obj )
 400         vlc_object_yield( obj );
 401     return obj;
 402 }
 403
 404
 405 /* Look for an interface suitable for interaction */
 406 static void InteractionSearchInterface( interaction_t *p_interaction )
 407 {
 408     vlc_list_t  *p_list;
 409     int          i_index;
 410
 411     p_interaction->p_intf = NULL;
 412
 413     p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
 414     if( !p_list )
 415     {
 416         msg_Err( p_interaction, "unable to create module list" );
 417         return;
 418     }
 419
 420     for( i_index = 0; i_index < p_list->i_count; i_index ++ )
 421     {
 422         intf_thread_t *p_intf = (intf_thread_t *)
 423                                         p_list->p_values[i_index].p_object;
 424         if( p_intf->b_interaction )
 425         {
 426             p_interaction->p_intf = p_intf;
 427             break;
 428         }
 429     }
 430     vlc_list_release ( p_list );
 431 }
 432
 433 /* Find an interaction dialog by its id */
 434 static interaction_dialog_t *DialogGetById( interaction_t *p_interaction,
 435                                             int i_id )
 436 {
 437     int i;
 438     for( i = 0 ; i< p_interaction->i_dialogs; i++ )
 439     {
 440         if( p_interaction->pp_dialogs[i]->i_id == i_id )
 441             return p_interaction->pp_dialogs[i];
 442     }
 443     return NULL;
 444 }
 445
 446 /* Destroy a dialog */
 447 static void DialogDestroy( interaction_dialog_t *p_dialog )
 448 {
 449     free( p_dialog->psz_title );
 450     free( p_dialog->psz_description );
 451     free( p_dialog->psz_default_button );
 452     free( p_dialog->psz_alternate_button );
 453     free( p_dialog->psz_other_button );
 454     free( p_dialog );
 455 }
 456
 457 /* Ask for the dialog to be sent to the user. Wait for answer
 458  * if required */
 459 static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
 460 {
 461     interaction_t *p_interaction = InteractionGet( p_this );
 462
 463     /* Get an id, if we don't already have one */
 464     if( p_dialog->i_id == 0 )
 465         p_dialog->i_id = ++p_interaction->i_last_id;
 466
 467     if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC;
 468
 469     if( config_GetInt( p_this, "interact" ) ||
 470         p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
 471         p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
 472     {
 473         bool b_found = false;
 474         int i;
 475         p_dialog->p_interaction = p_interaction;
 476         p_dialog->p_parent = p_this;
 477
 478         /* Check if we have already added this dialog */
 479         vlc_object_lock( p_interaction );
 480         for( i = 0 ; i< p_interaction->i_dialogs; i++ )
 481         {
 482             if( p_interaction->pp_dialogs[i]->i_id == p_dialog->i_id )
 483                 b_found = true;
 484         }
 485         /* Add it to the queue, the main loop will send the orders to the
 486          * interface */
 487         if( ! b_found )
 488         {
 489             INSERT_ELEM( p_interaction->pp_dialogs,
 490                          p_interaction->i_dialogs,
 491                          p_interaction->i_dialogs,
 492                          p_dialog );
 493         }
 494         else
 495             p_dialog->i_status = UPDATED_DIALOG;
 496
 497         if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
 498         {
 499             vlc_object_signal_unlocked( p_interaction );
 500             while( p_dialog->i_status != ANSWERED_DIALOG &&
 501                    p_dialog->i_status != HIDING_DIALOG &&
 502                    p_dialog->i_status != HIDDEN_DIALOG &&
 503                    !p_dialog->p_parent->b_die )
 504             {
 505                 vlc_object_unlock( p_interaction );
 506                 msleep( 100000 );
 507                 vlc_object_lock( p_interaction );
 508             }
 509             if( p_dialog->p_parent->b_die )
 510             {
 511                 p_dialog->i_return = DIALOG_CANCELLED;
 512                 p_dialog->i_status = ANSWERED_DIALOG;
 513             }
 514             p_dialog->i_flags |= DIALOG_GOT_ANSWER;
 515             vlc_object_signal_unlocked( p_interaction );
 516             vlc_object_unlock( p_interaction );
 517             vlc_object_release( p_interaction );
 518             return p_dialog->i_return;
 519         }
 520         else
 521         {
 522             /* Pretend we already retrieved the "answer" */
 523             p_dialog->i_flags |=  DIALOG_GOT_ANSWER;
 524             vlc_object_signal_unlocked( p_interaction );
 525             vlc_object_unlock( p_interaction );
 526             vlc_object_release( p_interaction );
 527             return VLC_SUCCESS;
 528         }
 529     }
 530     else
 531     {
 532         vlc_object_release( p_interaction );
 533         return VLC_EGENERIC;
 534     }
 535 }
 536
 537 static void InteractionLoop( vlc_object_t *p_this )
 538 {
 539     int i;
 540     interaction_t *p_interaction = (interaction_t*) p_this;
 541
 542     vlc_object_lock( p_this );
 543     while( vlc_object_alive( p_this ) )
 544     {
 545         InteractionManage( p_interaction );
 546         vlc_object_wait( p_this );
 547     }
 548     vlc_object_unlock( p_this );
 549
 550     /* Remove all dialogs - Interfaces must be able to clean up their data */
 551     for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
 552     {
 553         interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
 554         DialogDestroy( p_dialog );
 555         REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
 556     }
 557 }
 558
 559 /**
 560  * The main interaction processing loop
 561  *
 562  * \param p_interaction the interaction object
 563  * \return nothing
 564  */
 565
 566 static void InteractionManage( interaction_t *p_interaction )
 567 {
 568     vlc_value_t val;
 569     int i_index;
 570
 571     /* Nothing to do */
 572     if( p_interaction->i_dialogs == 0 ) return;
 573
 574     InteractionSearchInterface( p_interaction );
 575     if( !p_interaction->p_intf )
 576     {
 577         /* We mark all dialogs as answered with their "default" answer */
 578         for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
 579         {
 580             interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
 581             p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */
 582
 583             /* Pretend we have hidden and destroyed it */
 584             if( p_dialog->i_status == HIDDEN_DIALOG )
 585                 p_dialog->i_status = DESTROYED_DIALOG;
 586             else
 587                 p_dialog->i_status = HIDING_DIALOG;
 588         }
 589     }
 590     else
 591         vlc_object_yield( p_interaction->p_intf );
 592
 593     for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
 594     {
 595         interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
 596         switch( p_dialog->i_status )
 597         {
 598         case ANSWERED_DIALOG:
 599             /* Ask interface to hide it */
 600             p_dialog->i_action = INTERACT_HIDE;
 601             val.p_address = p_dialog;
 602             if( p_interaction->p_intf )
 603                 var_Set( p_interaction->p_intf, "interaction", val );
 604             p_dialog->i_status = HIDING_DIALOG;
 605             break;
 606         case UPDATED_DIALOG:
 607             p_dialog->i_action = INTERACT_UPDATE;
 608             val.p_address = p_dialog;
 609             if( p_interaction->p_intf )
 610                 var_Set( p_interaction->p_intf, "interaction", val );
 611             p_dialog->i_status = SENT_DIALOG;
 612             break;
 613         case HIDDEN_DIALOG:
 614             if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
 615             p_dialog->i_action = INTERACT_DESTROY;
 616             val.p_address = p_dialog;
 617             if( p_interaction->p_intf )
 618                 var_Set( p_interaction->p_intf, "interaction", val );
 619             break;
 620         case DESTROYED_DIALOG:
 621             /* Interface has now destroyed it, remove it */
 622             REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
 623                          i_index);
 624             i_index--;
 625             DialogDestroy( p_dialog );
 626             break;
 627         case NEW_DIALOG:
 628             /* This is truly a new dialog, send it. */
 629
 630             p_dialog->i_action = INTERACT_NEW;
 631             val.p_address = p_dialog;
 632             if( p_interaction->p_intf )
 633                 var_Set( p_interaction->p_intf, "interaction", val );
 634             p_dialog->i_status = SENT_DIALOG;
 635             break;
 636         }
 637     }
 638
 639     if( p_interaction->p_intf )
 640         vlc_object_release( p_interaction->p_intf );
 641 }