git.sesse.net Git - vlc/blob - modules/gui/qt4/dialogs/plugins.cpp

   1 /*****************************************************************************
   2  * plugins.cpp : Plug-ins and extensions listing
   3  ****************************************************************************
   4  * Copyright (C) 2008-2010 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Jean-Baptiste Kempf <jb (at) videolan.org>
   8  *          Jean-Philippe André <jpeg (at) 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 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include "plugins.hpp"
  30
  31 #include "util/searchlineedit.hpp"
  32 #include "extensions_manager.hpp"
  33
  34 #include <assert.h>
  35
  36 #include <vlc_modules.h>
  37
  38 #include <QTreeWidget>
  39 #include <QStringList>
  40 #include <QTabWidget>
  41 #include <QHeaderView>
  42 #include <QDialogButtonBox>
  43 #include <QLineEdit>
  44 #include <QLabel>
  45 #include <QVBoxLayout>
  46 #include <QComboBox>
  47 #include <QHBoxLayout>
  48 #include <QVBoxLayout>
  49 #include <QSpacerItem>
  50 #include <QListView>
  51 #include <QPainter>
  52 #include <QStyleOptionViewItem>
  53 #include <QKeyEvent>
  54 #include <QPushButton>
  55 #include <QPixmap>
  56
  57 static QPixmap *loadPixmapFromData( char *, int size );
  58
  59
  60 PluginDialog::PluginDialog( intf_thread_t *_p_intf ) : QVLCFrame( _p_intf )
  61 {
  62     setWindowTitle( qtr( "Plugins and extensions" ) );
  63     setWindowRole( "vlc-plugins" );
  64
  65     QVBoxLayout *layout = new QVBoxLayout( this );
  66     tabs = new QTabWidget( this );
  67     tabs->addTab( extensionTab = new ExtensionTab( p_intf ),
  68                   qtr( "Extensions" ) );
  69     tabs->addTab( pluginTab = new PluginTab( p_intf ),
  70                   qtr( "Plugins" ) );
  71     layout->addWidget( tabs );
  72
  73     QDialogButtonBox *box = new QDialogButtonBox;
  74     QPushButton *okButton = new QPushButton( qtr( "&Close" ), this );
  75     box->addButton( okButton, QDialogButtonBox::RejectRole );
  76     layout->addWidget( box );
  77     BUTTONACT( okButton, close() );
  78     restoreWidgetPosition( "PluginsDialog", QSize( 435, 280 ) );
  79 }
  80
  81 PluginDialog::~PluginDialog()
  82 {
  83     saveWidgetPosition( "PluginsDialog" );
  84 }
  85
  86 /* Plugins tab */
  87
  88 PluginTab::PluginTab( intf_thread_t *p_intf_ )
  89         : QVLCFrame( p_intf_ )
  90 {
  91     QGridLayout *layout = new QGridLayout( this );
  92
  93     /* Main Tree for modules */
  94     treePlugins = new QTreeWidget;
  95     layout->addWidget( treePlugins, 0, 0, 1, -1 );
  96
  97     /* Users cannot move the columns around but we need to sort */
  98     treePlugins->header()->setMovable( false );
  99     treePlugins->header()->setSortIndicatorShown( true );
 100     //    treePlugins->header()->setResizeMode( QHeaderView::ResizeToContents );
 101     treePlugins->setAlternatingRowColors( true );
 102     treePlugins->setColumnWidth( 0, 200 );
 103
 104     QStringList headerNames;
 105     headerNames << qtr("Name") << qtr("Capability" ) << qtr( "Score" );
 106     treePlugins->setHeaderLabels( headerNames );
 107
 108     FillTree();
 109
 110     /* Set capability column to the correct Size*/
 111     treePlugins->resizeColumnToContents( 1 );
 112     treePlugins->header()->restoreState(
 113             getSettings()->value( "Plugins/Header-State" ).toByteArray() );
 114
 115     treePlugins->setSortingEnabled( true );
 116     treePlugins->sortByColumn( 1, Qt::AscendingOrder );
 117
 118     QLabel *label = new QLabel( qtr("&Search:"), this );
 119     edit = new SearchLineEdit( this );
 120     label->setBuddy( edit );
 121
 122     layout->addWidget( label, 1, 0 );
 123     layout->addWidget( edit, 1, 1, 1, 1 );
 124     CONNECT( edit, textChanged( const QString& ),
 125             this, search( const QString& ) );
 126
 127     setMinimumSize( 500, 300 );
 128     restoreWidgetPosition( "Plugins", QSize( 540, 400 ) );
 129 }
 130
 131 inline void PluginTab::FillTree()
 132 {
 133     size_t count;
 134     module_t **p_list = module_list_get( &count );
 135
 136     for( unsigned int i = 0; i < count; i++ )
 137     {
 138         module_t *p_module = p_list[i];
 139
 140         QStringList qs_item;
 141         qs_item << qfu( module_get_name( p_module, true ) )
 142                 << qfu( module_get_capability( p_module ) )
 143                 << QString::number( module_get_score( p_module ) );
 144 #ifndef DEBUG
 145         if( qs_item.at(1).isEmpty() ) continue;
 146 #endif
 147
 148         QTreeWidgetItem *item = new PluginTreeItem( qs_item );
 149         treePlugins->addTopLevelItem( item );
 150     }
 151     module_list_free( p_list );
 152 }
 153
 154 void PluginTab::search( const QString& qs )
 155 {
 156     QList<QTreeWidgetItem *> items = treePlugins->findItems( qs, Qt::MatchContains );
 157     items += treePlugins->findItems( qs, Qt::MatchContains, 1 );
 158
 159     QTreeWidgetItem *item = NULL;
 160     for( int i = 0; i < treePlugins->topLevelItemCount(); i++ )
 161     {
 162         item = treePlugins->topLevelItem( i );
 163         item->setHidden( !items.contains( item ) );
 164     }
 165 }
 166
 167 PluginTab::~PluginTab()
 168 {
 169     saveWidgetPosition( "Plugins" );
 170     getSettings()->setValue( "Plugins/Header-State",
 171                              treePlugins->header()->saveState() );
 172 }
 173
 174 void PluginTab::keyPressEvent( QKeyEvent *keyEvent )
 175 {
 176     if( keyEvent->key() == Qt::Key_Return ||
 177         keyEvent->key() == Qt::Key_Enter )
 178         keyEvent->accept();
 179     else
 180         keyEvent->ignore();
 181 }
 182
 183 bool PluginTreeItem::operator< ( const QTreeWidgetItem & other ) const
 184 {
 185     int col = treeWidget()->sortColumn();
 186     if( col == PluginTab::SCORE )
 187         return text( col ).toInt() < other.text( col ).toInt();
 188     else if ( col == PluginTab::CAPABILITY )
 189     {
 190         if ( text( PluginTab::CAPABILITY ) == other.text( PluginTab::CAPABILITY ) )
 191             return text( PluginTab::NAME ) < other.text( PluginTab::NAME );
 192         else
 193             return text( PluginTab::CAPABILITY ) < other.text( PluginTab::CAPABILITY );
 194     }
 195     return text( col ) < other.text( col );
 196 }
 197
 198 /* Extensions tab */
 199 ExtensionTab::ExtensionTab( intf_thread_t *p_intf_ )
 200         : QVLCFrame( p_intf_ )
 201 {
 202     // Layout
 203     QVBoxLayout *layout = new QVBoxLayout( this );
 204
 205     QLabel *notice = new QLabel( qtr("Get more extensions from")
 206             + QString( " <a href=\"http://addons.videolan.org/\">"
 207                        "addons.videolan.org</a>." ) );
 208     notice->setOpenExternalLinks( true );
 209     layout->addWidget( notice );
 210
 211     // ListView
 212     extList = new QListView( this );
 213     CONNECT( extList, activated( const QModelIndex& ),
 214              this, moreInformation() );
 215     layout->addWidget( extList );
 216
 217     // List item delegate
 218     ExtensionItemDelegate *itemDelegate = new ExtensionItemDelegate( p_intf,
 219                                                                      extList );
 220     extList->setItemDelegate( itemDelegate );
 221
 222     // Extension list look & feeling
 223     extList->setAlternatingRowColors( true );
 224     extList->setSelectionMode( QAbstractItemView::SingleSelection );
 225
 226     // Model
 227     ExtensionListModel *model = new ExtensionListModel( extList, p_intf );
 228     extList->setModel( model );
 229
 230     // Buttons' layout
 231     QHBoxLayout *hbox = new QHBoxLayout;
 232     hbox->addItem( new QSpacerItem( 1, 1, QSizePolicy::Expanding,
 233                                     QSizePolicy::Fixed ) );
 234
 235     // More information button
 236     butMoreInfo = new QPushButton( QIcon( ":/menu/info" ),
 237                                    qtr( "More information..." ),
 238                                    this );
 239     CONNECT( butMoreInfo, clicked(), this, moreInformation() );
 240     hbox->addWidget( butMoreInfo );
 241
 242     // Reload button
 243     ExtensionsManager *EM = ExtensionsManager::getInstance( p_intf );
 244     QPushButton *reload = new QPushButton( QIcon( ":/update" ),
 245                                            qtr( "Reload extensions" ),
 246                                            this );
 247     CONNECT( reload, clicked(), EM, reloadExtensions() );
 248     CONNECT( reload, clicked(), this, updateButtons() );
 249     CONNECT( extList->selectionModel(),
 250              selectionChanged( const QItemSelection &, const QItemSelection & ),
 251              this,
 252              updateButtons() );
 253     hbox->addWidget( reload );
 254
 255     // Add buttons hbox
 256     layout->addItem( hbox );
 257     updateButtons();
 258 }
 259
 260 ExtensionTab::~ExtensionTab()
 261 {
 262 }
 263
 264 void ExtensionTab::updateButtons()
 265 {
 266     butMoreInfo->setEnabled( extList->selectionModel()->hasSelection() );
 267 }
 268
 269 // Do not close on ESC or ENTER
 270 void ExtensionTab::keyPressEvent( QKeyEvent *keyEvent )
 271 {
 272     if( keyEvent->key() == Qt::Key_Return ||
 273         keyEvent->key() == Qt::Key_Enter )
 274         keyEvent->accept();
 275     else
 276         keyEvent->ignore();
 277 }
 278
 279 // Show more information
 280 void ExtensionTab::moreInformation()
 281 {
 282     QModelIndex index = extList->selectionModel()->selectedIndexes().first();
 283     ExtensionCopy *ext = (ExtensionCopy*) index.internalPointer();
 284     if( !ext )
 285         return;
 286
 287     ExtensionInfoDialog dlg( *ext, p_intf, this );
 288     dlg.exec();
 289 }
 290
 291 /* Safe copy of the extension_t struct */
 292 class ExtensionCopy
 293 {
 294 public:
 295     ExtensionCopy( extension_t *p_ext )
 296     {
 297         name = qfu( p_ext->psz_name );
 298         description = qfu( p_ext->psz_description );
 299         shortdesc = qfu( p_ext->psz_shortdescription );
 300         if( description.isEmpty() )
 301             description = shortdesc;
 302         if( shortdesc.isEmpty() && !description.isEmpty() )
 303             shortdesc = description;
 304         title = qfu( p_ext->psz_title );
 305         author = qfu( p_ext->psz_author );
 306         version = qfu( p_ext->psz_version );
 307         url = qfu( p_ext->psz_url );
 308         icon = loadPixmapFromData( p_ext->p_icondata, p_ext->i_icondata_size );
 309     }
 310     ~ExtensionCopy() {}
 311
 312     QString name, title, description, shortdesc, author, version, url;
 313     QPixmap *icon;
 314 };
 315
 316 /* Extensions list model for the QListView */
 317
 318 ExtensionListModel::ExtensionListModel( QListView *view, intf_thread_t *intf )
 319         : QAbstractListModel( view ), p_intf( intf )
 320 {
 321     // Connect to ExtensionsManager::extensionsUpdated()
 322     ExtensionsManager* EM = ExtensionsManager::getInstance( p_intf );
 323     CONNECT( EM, extensionsUpdated(), this, updateList() );
 324
 325     // Load extensions now if not already loaded
 326     EM->loadExtensions();
 327 }
 328
 329 ExtensionListModel::~ExtensionListModel()
 330 {
 331     // Clear extensions list
 332     while( !extensions.isEmpty() )
 333         delete extensions.takeLast();
 334 }
 335
 336 void ExtensionListModel::updateList()
 337 {
 338     ExtensionCopy *ext;
 339
 340     // Clear extensions list
 341     while( !extensions.isEmpty() )
 342     {
 343         ext = extensions.takeLast();
 344         delete ext;
 345     }
 346
 347     // Find new extensions
 348     ExtensionsManager *EM = ExtensionsManager::getInstance( p_intf );
 349     extensions_manager_t *p_mgr = EM->getManager();
 350     if( !p_mgr )
 351         return;
 352
 353     vlc_mutex_lock( &p_mgr->lock );
 354     extension_t *p_ext;
 355     FOREACH_ARRAY( p_ext, p_mgr->extensions )
 356     {
 357         ext = new ExtensionCopy( p_ext );
 358         extensions.append( ext );
 359     }
 360     FOREACH_END()
 361     vlc_mutex_unlock( &p_mgr->lock );
 362     vlc_object_release( p_mgr );
 363
 364     emit dataChanged( index( 0 ), index( rowCount() - 1 ) );
 365 }
 366
 367 int ExtensionListModel::rowCount( const QModelIndex& ) const
 368 {
 369     int count = 0;
 370     ExtensionsManager *EM = ExtensionsManager::getInstance( p_intf );
 371     extensions_manager_t *p_mgr = EM->getManager();
 372     if( !p_mgr )
 373         return 0;
 374
 375     vlc_mutex_lock( &p_mgr->lock );
 376     count = p_mgr->extensions.i_size;
 377     vlc_mutex_unlock( &p_mgr->lock );
 378     vlc_object_release( p_mgr );
 379
 380     return count;
 381 }
 382
 383 QVariant ExtensionListModel::data( const QModelIndex& index, int role ) const
 384 {
 385     if( !index.isValid() )
 386         return QVariant();
 387
 388     switch( role )
 389     {
 390     default:
 391         return QVariant();
 392     }
 393 }
 394
 395 QModelIndex ExtensionListModel::index( int row, int column,
 396                                        const QModelIndex& ) const
 397 {
 398     if( column != 0 )
 399         return QModelIndex();
 400     if( row < 0 || row >= extensions.count() )
 401         return QModelIndex();
 402
 403     return createIndex( row, 0, extensions.at( row ) );
 404 }
 405
 406
 407 /* Extension List Widget Item */
 408 ExtensionItemDelegate::ExtensionItemDelegate( intf_thread_t *p_intf,
 409                                               QListView *view )
 410         : QStyledItemDelegate( view ), view( view ), p_intf( p_intf )
 411 {
 412 }
 413
 414 ExtensionItemDelegate::~ExtensionItemDelegate()
 415 {
 416 }
 417
 418 void ExtensionItemDelegate::paint( QPainter *painter,
 419                                    const QStyleOptionViewItem &option,
 420                                    const QModelIndex &index ) const
 421 {
 422     ExtensionCopy *ext = ( ExtensionCopy* ) index.internalPointer();
 423     assert( ext != NULL );
 424
 425     int width = option.rect.width();
 426
 427     // Pixmap: buffer where to draw
 428     QPixmap pix(option.rect.size());
 429
 430     // Draw background
 431     pix.fill( Qt::transparent ); // FIXME
 432
 433     // ItemView primitive style
 434     QApplication::style()->drawPrimitive( QStyle::PE_PanelItemViewItem,
 435                                           &option,
 436                                           painter );
 437
 438     // Painter on the pixmap
 439     QPainter *pixpaint = new QPainter(&pix);
 440
 441     // Text font & pen
 442     QFont font = painter->font();
 443     QPen pen = painter->pen();
 444     if( view->selectionModel()->selectedIndexes().contains( index ) )
 445     {
 446         pen.setBrush( option.palette.highlightedText() );
 447     }
 448     else
 449     {
 450         pen.setBrush( option.palette.text() );
 451     }
 452     pixpaint->setPen( pen );
 453     QFontMetrics metrics = option.fontMetrics;
 454
 455     // Icon
 456     if( ext->icon != NULL )
 457     {
 458         pixpaint->drawPixmap( 7, 7, 2*metrics.height(), 2*metrics.height(),
 459                               *ext->icon );
 460     }
 461
 462     // Title: bold
 463     pixpaint->setRenderHint( QPainter::TextAntialiasing );
 464     font.setBold( true );
 465     pixpaint->setFont( font );
 466     pixpaint->drawText( QRect( 17 + 2 * metrics.height(), 7,
 467                                width - 40 - 2 * metrics.height(),
 468                                metrics.height() ),
 469                         Qt::AlignLeft, ext->title );
 470
 471     // Short description: normal
 472     font.setBold( false );
 473     pixpaint->setFont( font );
 474     pixpaint->drawText( QRect( 17 + 2 * metrics.height(),
 475                                7 + metrics.height(), width - 40,
 476                                metrics.height() ),
 477                         Qt::AlignLeft, ext->shortdesc );
 478
 479     // Flush paint operations
 480     delete pixpaint;
 481
 482     // Draw it on the screen!
 483     painter->drawPixmap( option.rect, pix );
 484 }
 485
 486 QSize ExtensionItemDelegate::sizeHint( const QStyleOptionViewItem &option,
 487                                        const QModelIndex &index ) const
 488 {
 489     if (index.isValid() && index.column() == 0)
 490     {
 491         QFontMetrics metrics = option.fontMetrics;
 492         return QSize( 200, 14 + 2 * metrics.height() );
 493     }
 494     else
 495         return QSize();
 496 }
 497
 498 /* "More information" dialog */
 499
 500 ExtensionInfoDialog::ExtensionInfoDialog( const ExtensionCopy& extension,
 501                                           intf_thread_t *p_intf,
 502                                           QWidget *parent )
 503        : QVLCDialog( parent, p_intf )
 504 {
 505     // Let's be a modal dialog
 506     setWindowModality( Qt::WindowModal );
 507
 508     // Window title
 509     setWindowTitle( qtr( "About" ) + " " + extension.title );
 510
 511     // Layout
 512     QGridLayout *layout = new QGridLayout( this );
 513
 514     // Icon
 515     QLabel *icon = new QLabel( this );
 516     if( !extension.icon )
 517     {
 518         QPixmap pix( ":/logo/vlc48.png" );
 519         icon->setPixmap( pix );
 520     }
 521     else
 522     {
 523         icon->setPixmap( *extension.icon );
 524     }
 525     icon->setAlignment( Qt::AlignCenter );
 526     icon->setFixedSize( 48, 48 );
 527     layout->addWidget( icon, 1, 0, 2, 1 );
 528
 529     // Title
 530     QLabel *label = new QLabel( extension.title, this );
 531     QFont font = label->font();
 532     font.setBold( true );
 533     font.setPointSizeF( font.pointSizeF() * 1.3f );
 534     label->setFont( font );
 535     layout->addWidget( label, 0, 0, 1, -1 );
 536
 537     // Version
 538     label = new QLabel( "<b>" + qtr( "Version" ) + ":</b>", this );
 539     layout->addWidget( label, 1, 1, 1, 1, Qt::AlignBottom );
 540     label = new QLabel( extension.version, this );
 541     layout->addWidget( label, 1, 2, 1, 2, Qt::AlignBottom );
 542
 543     // Author
 544     label = new QLabel( "<b>" + qtr( "Author" ) + ":</b>", this );
 545     layout->addWidget( label, 2, 1, 1, 1, Qt::AlignTop );
 546     label = new QLabel( extension.author, this );
 547     layout->addWidget( label, 2, 2, 1, 2, Qt::AlignTop );
 548
 549
 550     // Description
 551     label = new QLabel( this );
 552     label->setText( extension.description );
 553     label->setWordWrap( true );
 554     label->setOpenExternalLinks( true );
 555     layout->addWidget( label, 4, 0, 1, -1 );
 556
 557     // URL
 558     label = new QLabel( "<b>" + qtr( "Website" ) + ":</b>", this );
 559     layout->addWidget( label, 5, 0, 1, 2 );
 560     label = new QLabel( QString("<a href=\"%1\">%2</a>")
 561                         .arg( extension.url ).arg( extension.url )
 562                         , this );
 563     label->setOpenExternalLinks( true );
 564     layout->addWidget( label, 5, 2, 1, -1 );
 565
 566     // Script file
 567     label = new QLabel( "<b>" + qtr( "File" ) + ":</b>", this );
 568     layout->addWidget( label, 6, 0, 1, 2 );
 569     QLineEdit *line = new QLineEdit( extension.name, this );
 570     line->setReadOnly( true );
 571     layout->addWidget( line, 6, 2, 1, -1 );
 572
 573     // Close button
 574     QDialogButtonBox *group = new QDialogButtonBox( this );
 575     QPushButton *closeButton = new QPushButton( qtr( "&Close" ) );
 576     group->addButton( closeButton, QDialogButtonBox::RejectRole );
 577     BUTTONACT( closeButton, close() );
 578
 579     layout->addWidget( group, 7, 0, 1, -1 );
 580
 581     // Fix layout
 582     layout->setColumnStretch( 2, 1 );
 583     layout->setRowStretch( 4, 1 );
 584     setMinimumSize( 450, 350 );
 585 }
 586
 587 static QPixmap *loadPixmapFromData( char *data, int size )
 588 {
 589     if( !data || size <= 0 )
 590         return NULL;
 591     QPixmap *pixmap = new QPixmap();
 592     if( !pixmap->loadFromData( (const uchar*) data, (uint) size ) )
 593     {
 594         delete pixmap;
 595         return NULL;
 596     }
 597     return pixmap;
 598 }