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

   1 /*****************************************************************************
   2  * plugins.hpp : 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/customwidgets.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 <QTextBrowser>
  48 #include <QHBoxLayout>
  49 #include <QVBoxLayout>
  50 #include <QSpacerItem>
  51 #include <QListView>
  52 #include <QPainter>
  53 #include <QStyleOptionViewItem>
  54 #include <QKeyEvent>
  55
  56
  57 PluginDialog::PluginDialog( intf_thread_t *_p_intf ) : QVLCFrame( _p_intf )
  58 {
  59     setWindowTitle( qtr( "Plugins and extensions" ) );
  60     setWindowRole( "vlc-plugins" );
  61
  62     QVBoxLayout *layout = new QVBoxLayout( this );
  63     tabs = new QTabWidget( this );
  64     tabs->addTab( extensionTab = new ExtensionTab( p_intf ),
  65                   qtr( "Extensions" ) );
  66     tabs->addTab( pluginTab = new PluginTab( p_intf ),
  67                   qtr( "Plugins" ) );
  68     layout->addWidget( tabs );
  69
  70     QDialogButtonBox *box = new QDialogButtonBox;
  71     QPushButton *okButton = new QPushButton( qtr( "&Close" ), this );
  72     box->addButton( okButton, QDialogButtonBox::AcceptRole );
  73     layout->addWidget( box );
  74     BUTTONACT( okButton, close() );
  75 }
  76
  77 PluginDialog::~PluginDialog()
  78 {
  79 }
  80
  81 /* Plugins tab */
  82
  83 PluginTab::PluginTab( intf_thread_t *p_intf )
  84         : QVLCFrame( p_intf )
  85 {
  86     QGridLayout *layout = new QGridLayout( this );
  87
  88     /* Main Tree for modules */
  89     treePlugins = new QTreeWidget;
  90     layout->addWidget( treePlugins, 0, 0, 1, -1 );
  91
  92     /* Users cannot move the columns around but we need to sort */
  93     treePlugins->header()->setMovable( false );
  94     treePlugins->header()->setSortIndicatorShown( true );
  95     //    treePlugins->header()->setResizeMode( QHeaderView::ResizeToContents );
  96     treePlugins->setAlternatingRowColors( true );
  97     treePlugins->setColumnWidth( 0, 200 );
  98
  99     QStringList headerNames;
 100     headerNames << qtr("Name") << qtr("Capability" ) << qtr( "Score" );
 101     treePlugins->setHeaderLabels( headerNames );
 102
 103     FillTree();
 104
 105     /* Set capability column to the correct Size*/
 106     treePlugins->resizeColumnToContents( 1 );
 107     treePlugins->header()->restoreState(
 108             getSettings()->value( "Plugins/Header-State" ).toByteArray() );
 109
 110     treePlugins->setSortingEnabled( true );
 111     treePlugins->sortByColumn( 1, Qt::AscendingOrder );
 112
 113     QLabel *label = new QLabel( qtr("&Search:"), this );
 114     edit = new SearchLineEdit( this );
 115     label->setBuddy( edit );
 116
 117     layout->addWidget( label, 1, 0 );
 118     layout->addWidget( edit, 1, 1, 1, 1 );
 119     CONNECT( edit, textChanged( const QString& ),
 120             this, search( const QString& ) );
 121
 122     setMinimumSize( 500, 300 );
 123     readSettings( "Plugins", QSize( 540, 400 ) );
 124 }
 125
 126 inline void PluginTab::FillTree()
 127 {
 128     module_t **p_list = module_list_get( NULL );
 129     module_t *p_module;
 130
 131     for( unsigned int i = 0; (p_module = p_list[i] ) != NULL; i++ )
 132     {
 133         QStringList qs_item;
 134         qs_item << qfu( module_get_name( p_module, true ) )
 135                 << qfu( module_get_capability( p_module ) )
 136                 << QString::number( module_get_score( p_module ) );
 137 #ifndef DEBUG
 138         if( qs_item.at(1).isEmpty() ) continue;
 139 #endif
 140
 141         QTreeWidgetItem *item = new PluginTreeItem( qs_item );
 142         treePlugins->addTopLevelItem( item );
 143     }
 144 }
 145
 146 void PluginTab::search( const QString& qs )
 147 {
 148     QList<QTreeWidgetItem *> items = treePlugins->findItems( qs, Qt::MatchContains );
 149     items += treePlugins->findItems( qs, Qt::MatchContains, 1 );
 150
 151     QTreeWidgetItem *item = NULL;
 152     for( int i = 0; i < treePlugins->topLevelItemCount(); i++ )
 153     {
 154         item = treePlugins->topLevelItem( i );
 155         item->setHidden( !items.contains( item ) );
 156     }
 157 }
 158
 159 PluginTab::~PluginTab()
 160 {
 161     writeSettings( "Plugins" );
 162     getSettings()->setValue( "Plugins/Header-State",
 163                              treePlugins->header()->saveState() );
 164 }
 165
 166 bool PluginTreeItem::operator< ( const QTreeWidgetItem & other ) const
 167 {
 168     int col = treeWidget()->sortColumn();
 169     if( col == 2 )
 170         return text( col ).toInt() < other.text( col ).toInt();
 171     return text( col ) < other.text( col );
 172 }
 173
 174 /* Extensions tab */
 175 ExtensionTab::ExtensionTab( intf_thread_t *p_intf )
 176         : QVLCFrame( p_intf )
 177 {
 178     // Layout
 179     QVBoxLayout *layout = new QVBoxLayout( this );
 180
 181     // ListView
 182     extList = new QListView( this );
 183     layout->addWidget( extList );
 184
 185     // List item delegate
 186     ExtensionItemDelegate *itemDelegate = new ExtensionItemDelegate( p_intf,
 187                                                                      extList );
 188     extList->setItemDelegate( itemDelegate );
 189
 190     // Extension list look & feeling
 191     extList->setAlternatingRowColors( true );
 192     extList->setSelectionMode( QAbstractItemView::SingleSelection );
 193
 194     // Model
 195     ExtensionListModel *model = new ExtensionListModel( extList, p_intf );
 196     extList->setModel( model );
 197
 198     // Buttons' layout
 199     QHBoxLayout *hbox = new QHBoxLayout;
 200     hbox->addItem( new QSpacerItem( 1, 1, QSizePolicy::Expanding,
 201                                     QSizePolicy::Fixed ) );
 202
 203     // More information button
 204     butMoreInfo = new QPushButton( QIcon( ":/menu/info" ),
 205                                    qtr( "More information..." ),
 206                                    this );
 207     CONNECT( butMoreInfo, clicked(),
 208              this, moreInformation() );
 209     hbox->addWidget( butMoreInfo );
 210
 211     // Reload button
 212     ExtensionsManager *EM = ExtensionsManager::getInstance( p_intf );
 213     QPushButton *reload = new QPushButton( QIcon( ":/update" ),
 214                                            qtr( "Reload extensions" ),
 215                                            this );
 216     CONNECT( reload, clicked(),
 217              EM, reloadExtensions() );
 218     hbox->addWidget( reload );
 219
 220     // Add buttons hbox
 221     layout->addItem( hbox );
 222 }
 223
 224 ExtensionTab::~ExtensionTab()
 225 {
 226 }
 227
 228 // Do not close on ESC or ENTER
 229 void ExtensionTab::keyPressEvent( QKeyEvent *keyEvent )
 230 {
 231     keyEvent->ignore();
 232 }
 233
 234 /* Safe copy of the extension_t struct */
 235 class ExtensionCopy
 236 {
 237 public:
 238     ExtensionCopy( extension_t *p_ext )
 239     {
 240         name = qfu( p_ext->psz_name );
 241         description = qfu( p_ext->psz_description );
 242         title = qfu( p_ext->psz_title );
 243         author = qfu( p_ext->psz_author );
 244         version = qfu( p_ext->psz_version );
 245         url = qfu( p_ext->psz_url );
 246     }
 247     ~ExtensionCopy() {}
 248
 249     QString name, title, description, author, version, url;
 250 };
 251
 252 /* Extensions list model for the QListView */
 253
 254 ExtensionListModel::ExtensionListModel( QListView *view, intf_thread_t *intf )
 255         : QAbstractListModel( view ), p_intf( intf )
 256 {
 257     // Connect to ExtensionsManager::extensionsUpdated()
 258     ExtensionsManager* EM = ExtensionsManager::getInstance( p_intf );
 259     CONNECT( EM, extensionsUpdated(), this, updateList() );
 260
 261     // Load extensions now if not already loaded
 262     EM->loadExtensions();
 263 }
 264
 265 ExtensionListModel::~ExtensionListModel()
 266 {
 267 }
 268
 269 void ExtensionListModel::updateList()
 270 {
 271     ExtensionCopy *ext;
 272
 273     // Clear extensions list
 274     while( !extensions.isEmpty() )
 275     {
 276         ext = extensions.takeLast();
 277         delete ext;
 278     }
 279
 280     // Find new extensions
 281     ExtensionsManager *EM = ExtensionsManager::getInstance( p_intf );
 282     extensions_manager_t *p_mgr = EM->getManager();
 283     if( !p_mgr )
 284         return;
 285
 286     vlc_mutex_lock( &p_mgr->lock );
 287     extension_t *p_ext;
 288     FOREACH_ARRAY( p_ext, p_mgr->extensions )
 289     {
 290         ext = new ExtensionCopy( p_ext );
 291         extensions.push_back( ext );
 292     }
 293     FOREACH_END()
 294     vlc_mutex_unlock( &p_mgr->lock );
 295     vlc_object_release( p_mgr );
 296
 297     emit dataChanged( index( 0 ), index( rowCount() - 1 ) );
 298 }
 299
 300 int ExtensionListModel::rowCount( const QModelIndex& parent ) const
 301 {
 302     int count = 0;
 303     ExtensionsManager *EM = ExtensionsManager::getInstance( p_intf );
 304     extensions_manager_t *p_mgr = EM->getManager();
 305     if( !p_mgr )
 306         return 0;
 307
 308     vlc_mutex_lock( &p_mgr->lock );
 309     count = p_mgr->extensions.i_size;
 310     vlc_mutex_unlock( &p_mgr->lock );
 311     vlc_object_release( p_mgr );
 312
 313     return count;
 314 }
 315
 316 QVariant ExtensionListModel::data( const QModelIndex& index, int role ) const
 317 {
 318     if( !index.isValid() )
 319         return QVariant();
 320
 321     switch( role )
 322     {
 323     default:
 324         return QVariant();
 325     }
 326 }
 327
 328 QModelIndex ExtensionListModel::index( int row, int column,
 329                                        const QModelIndex& parent ) const
 330 {
 331     if( column != 0 )
 332         return QModelIndex();
 333     if( row < 0 || row >= extensions.size() )
 334         return QModelIndex();
 335
 336     return createIndex( row, 0, extensions.at( row ) );
 337 }
 338
 339
 340 /* Extension List Widget Item */
 341 ExtensionItemDelegate::ExtensionItemDelegate( intf_thread_t *p_intf,
 342                                               QListView *view )
 343         : QStyledItemDelegate( view ), view( view ), p_intf( p_intf )
 344 {
 345 }
 346
 347 ExtensionItemDelegate::~ExtensionItemDelegate()
 348 {
 349 }
 350
 351 void ExtensionItemDelegate::paint( QPainter *painter,
 352                                    const QStyleOptionViewItem &option,
 353                                    const QModelIndex &index ) const
 354 {
 355     ExtensionCopy *ext = ( ExtensionCopy* ) index.internalPointer();
 356     assert( ext != NULL );
 357
 358     int width = option.rect.width();
 359     int height = option.rect.height();
 360
 361     // Pixmap: buffer where to draw
 362     QPixmap pix(option.rect.size());
 363
 364     // Draw background
 365     pix.fill( Qt::transparent ); // FIXME
 366
 367     // ItemView primitive style
 368     QApplication::style()->drawPrimitive( QStyle::PE_PanelItemViewItem,
 369                                           &option,
 370                                           painter );
 371
 372     // Painter on the pixmap
 373     QPainter *pixpaint = new QPainter(&pix);
 374
 375     // Text font & pen
 376     QFont font = painter->font();
 377     QPen pen = painter->pen();
 378     if( view->selectionModel()->selectedIndexes().contains( index ) )
 379     {
 380         pen.setBrush( option.palette.highlightedText() );
 381     }
 382     else
 383     {
 384         pen.setBrush( option.palette.text() );
 385     }
 386     pixpaint->setPen( pen );
 387
 388     // Title: bold
 389     font.setBold( true );
 390     pixpaint->setFont( font );
 391     pixpaint->drawText( QRect( 10, 5, width - 70, 20 ),
 392                         Qt::AlignLeft, ext->title );
 393
 394     // Short description: normal
 395     font.setBold( false );
 396     pixpaint->setFont( font );
 397     pixpaint->drawText( QRect( 10, 30, width - 40, 20 ),
 398                         Qt::AlignLeft, ext->description );
 399
 400     // Version: italic
 401     font.setItalic( true );
 402     pixpaint->setFont( font );
 403     pixpaint->drawText( QRect( width - 50, 5, 20, 20 ),
 404                         Qt::AlignLeft, ext->version );
 405
 406     // Flush paint operations
 407     delete pixpaint;
 408
 409     // Draw it on the screen!
 410     painter->drawPixmap( option.rect, pix );
 411 }
 412
 413 QSize ExtensionItemDelegate::sizeHint( const QStyleOptionViewItem &option,
 414                                        const QModelIndex &index ) const
 415 {
 416     if (index.isValid() && index.column() == 0)
 417     {
 418         QFontMetrics metrics = option.fontMetrics;
 419         return QSize( 200, 20 + 2 * metrics.height() );
 420     }
 421     else
 422         return QSize();
 423 }