release/src/router/transmission/qt/torrent-delegate.cc

   1 /*
   2  * This file Copyright (C) Mnemosyne LLC
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2
   6  * as published by the Free Software Foundation.
   7  *
   8  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
   9  *
  10  * $Id: torrent-delegate.cc 13244 2012-03-04 13:15:43Z jordan $
  11  */
  12
  13 #include <iostream>
  14
  15 #include <QApplication>
  16 #include <QFont>
  17 #include <QFontMetrics>
  18 #include <QIcon>
  19 #include <QModelIndex>
  20 #include <QPainter>
  21 #include <QPixmap>
  22 #include <QPixmapCache>
  23 #include <QStyleOptionProgressBarV2>
  24
  25 #include "formatter.h"
  26 #include "torrent.h"
  27 #include "torrent-delegate.h"
  28 #include "torrent-model.h"
  29
  30 enum
  31 {
  32    GUI_PAD = 6,
  33    BAR_HEIGHT = 12
  34 };
  35
  36 QColor TorrentDelegate :: greenBrush;
  37 QColor TorrentDelegate :: blueBrush;
  38 QColor TorrentDelegate :: greenBack;
  39 QColor TorrentDelegate :: blueBack;
  40
  41 TorrentDelegate :: TorrentDelegate( QObject * parent ):
  42     QStyledItemDelegate( parent ),
  43     myProgressBarStyle( new QStyleOptionProgressBarV2 )
  44 {
  45     myProgressBarStyle->minimum = 0;
  46     myProgressBarStyle->maximum = 1000;
  47
  48     greenBrush = QColor("forestgreen");
  49     greenBack = QColor("darkseagreen");
  50
  51     blueBrush = QColor("steelblue");
  52     blueBack = QColor("lightgrey");
  53 }
  54
  55 TorrentDelegate :: ~TorrentDelegate( )
  56 {
  57     delete myProgressBarStyle;
  58 }
  59
  60 /***
  61 ****
  62 ***/
  63
  64 QSize
  65 TorrentDelegate :: margin( const QStyle& style ) const
  66 {
  67     Q_UNUSED( style );
  68
  69     return QSize( 4, 4 );
  70 }
  71
  72 QString
  73 TorrentDelegate :: progressString( const Torrent& tor ) const
  74 {
  75     const bool isMagnet( !tor.hasMetadata( ) );
  76     const bool isDone( tor.isDone( ) );
  77     const bool isSeed( tor.isSeed( ) );
  78     const uint64_t haveTotal( tor.haveTotal( ) );
  79     QString str;
  80     double seedRatio;
  81     const bool hasSeedRatio( tor.getSeedRatio( seedRatio ) );
  82
  83     if( isMagnet ) // magnet link with no metadata
  84     {
  85         /* %1 is the percentage of torrent metadata downloaded */
  86         str = tr( "Magnetized transfer - retrieving metadata (%1%)" )
  87             .arg( Formatter::percentToString( tor.metadataPercentDone() * 100.0 ) );
  88     }
  89     else if( !isDone ) // downloading
  90     {
  91         /* %1 is how much we've got,
  92            %2 is how much we'll have when done,
  93            %3 is a percentage of the two */
  94         str = tr( "%1 of %2 (%3%)" ).arg( Formatter::sizeToString( haveTotal ) )
  95                                     .arg( Formatter::sizeToString( tor.sizeWhenDone( ) ) )
  96                                     .arg( Formatter::percentToString( tor.percentDone( ) * 100.0 ) );
  97     }
  98     else if( !isSeed ) // partial seed
  99     {
 100         if( hasSeedRatio )
 101         {
 102             /* %1 is how much we've got,
 103                %2 is the torrent's total size,
 104                %3 is a percentage of the two,
 105                %4 is how much we've uploaded,
 106                %5 is our upload-to-download ratio
 107                %6 is the ratio we want to reach before we stop uploading */
 108             str = tr( "%1 of %2 (%3%), uploaded %4 (Ratio: %5 Goal: %6)" )
 109                   .arg( Formatter::sizeToString( haveTotal ) )
 110                   .arg( Formatter::sizeToString( tor.totalSize( ) ) )
 111                   .arg( Formatter::percentToString( tor.percentComplete( ) * 100.0 ) )
 112                   .arg( Formatter::sizeToString( tor.uploadedEver( ) ) )
 113                   .arg( Formatter::ratioToString( tor.ratio( ) ) )
 114                   .arg( Formatter::ratioToString( seedRatio ) );
 115         }
 116         else
 117         {
 118             /* %1 is how much we've got,
 119                %2 is the torrent's total size,
 120                %3 is a percentage of the two,
 121                %4 is how much we've uploaded,
 122                %5 is our upload-to-download ratio */
 123             str = tr( "%1 of %2 (%3%), uploaded %4 (Ratio: %5)" )
 124                   .arg( Formatter::sizeToString( haveTotal ) )
 125                   .arg( Formatter::sizeToString( tor.totalSize( ) ) )
 126                   .arg( Formatter::percentToString( tor.percentComplete( ) * 100.0 ) )
 127                   .arg( Formatter::sizeToString( tor.uploadedEver( ) ) )
 128                   .arg( Formatter::ratioToString( tor.ratio( ) ) );
 129         }
 130     }
 131     else // seeding
 132     {
 133         if( hasSeedRatio )
 134         {
 135             /* %1 is the torrent's total size,
 136                %2 is how much we've uploaded,
 137                %3 is our upload-to-download ratio,
 138                %4 is the ratio we want to reach before we stop uploading */
 139             str = tr( "%1, uploaded %2 (Ratio: %3 Goal: %4)" )
 140                   .arg( Formatter::sizeToString( haveTotal ) )
 141                   .arg( Formatter::sizeToString( tor.uploadedEver( ) ) )
 142                   .arg( Formatter::ratioToString( tor.ratio( ) ) )
 143                   .arg( Formatter::ratioToString( seedRatio ) );
 144         }
 145         else /* seeding w/o a ratio */
 146         {
 147             /* %1 is the torrent's total size,
 148                %2 is how much we've uploaded,
 149                %3 is our upload-to-download ratio */
 150             str = tr( "%1, uploaded %2 (Ratio: %3)" )
 151                   .arg( Formatter::sizeToString( haveTotal ) )
 152                   .arg( Formatter::sizeToString( tor.uploadedEver( ) ) )
 153                   .arg( Formatter::ratioToString( tor.ratio( ) ) );
 154         }
 155     }
 156
 157     /* add time when downloading */
 158     if( ( hasSeedRatio && tor.isSeeding( ) ) || tor.isDownloading( ) )
 159     {
 160         str += tr( " - " );
 161         if( tor.hasETA( ) )
 162             str += tr( "%1 left" ).arg( Formatter::timeToString( tor.getETA( ) ) );
 163         else
 164             str += tr( "Remaining time unknown" );
 165     }
 166
 167     return str;
 168 }
 169
 170 QString
 171 TorrentDelegate :: shortTransferString( const Torrent& tor ) const
 172 {
 173     static const QChar upArrow( 0x2191 );
 174     static const QChar downArrow( 0x2193 );
 175     const bool haveMeta( tor.hasMetadata( ) );
 176     const bool haveDown( haveMeta && tor.peersWeAreDownloadingFrom( ) > 0 );
 177     const bool haveUp( haveMeta && tor.peersWeAreUploadingTo( ) > 0 );
 178     QString downStr, upStr, str;
 179
 180     if( haveDown )
 181         downStr = Formatter::speedToString( tor.downloadSpeed( ) );
 182     if( haveUp )
 183         upStr = Formatter::speedToString( tor.uploadSpeed( ) );
 184
 185     if( haveDown && haveUp )
 186         str = tr( "%1 %2, %3 %4" ).arg(downArrow).arg(downStr).arg(upArrow).arg(upStr);
 187     else if( haveDown )
 188         str = tr( "%1 %2" ).arg(downArrow).arg(downStr);
 189     else if( haveUp )
 190         str = tr( "%1 %2" ).arg(upArrow).arg(upStr);
 191     else if( tor.isStalled( ) )
 192         str = tr( "Stalled" );
 193     else if( tor.hasMetadata( ) )
 194         str = tr( "Idle" );
 195
 196     return str;
 197 }
 198
 199 QString
 200 TorrentDelegate :: shortStatusString( const Torrent& tor ) const
 201 {
 202     QString str;
 203
 204     switch( tor.getActivity( ) )
 205     {
 206         case TR_STATUS_CHECK:
 207             str = tr( "Verifying local data (%1% tested)" ).arg( Formatter::percentToString( tor.getVerifyProgress()*100.0 ) );
 208             break;
 209
 210         case TR_STATUS_DOWNLOAD:
 211         case TR_STATUS_SEED:
 212             if( !tor.isDownloading( ) )
 213                 str = tr( "Ratio: %1, " ).arg( Formatter::ratioToString( tor.ratio( ) ) );
 214             str += shortTransferString( tor );
 215             break;
 216
 217         default:
 218             str = tor.activityString( );
 219             break;
 220     }
 221
 222     return str;
 223 }
 224
 225 QString
 226 TorrentDelegate :: statusString( const Torrent& tor ) const
 227 {
 228     QString str;
 229
 230     if( tor.hasError( ) )
 231     {
 232         str = tor.getError( );
 233     }
 234     else switch( tor.getActivity( ) )
 235     {
 236         case TR_STATUS_STOPPED:
 237         case TR_STATUS_CHECK_WAIT:
 238         case TR_STATUS_CHECK:
 239         case TR_STATUS_DOWNLOAD_WAIT:
 240         case TR_STATUS_SEED_WAIT:
 241             str = shortStatusString( tor );
 242             break;
 243
 244         case TR_STATUS_DOWNLOAD:
 245             if( tor.hasMetadata( ) )
 246                 str = tr( "Downloading from %1 of %n connected peer(s)", 0, tor.connectedPeersAndWebseeds( ) )
 247                         .arg( tor.peersWeAreDownloadingFrom( ) );
 248             else
 249                 str = tr( "Downloading metadata from %n peer(s) (%1% done)", 0, tor.peersWeAreDownloadingFrom( ) )
 250                         .arg( Formatter::percentToString( 100.0 * tor.metadataPercentDone( ) ) );
 251             break;
 252
 253         case TR_STATUS_SEED:
 254             str = tr( "Seeding to %1 of %n connected peer(s)", 0, tor.connectedPeers( ) )
 255                   .arg( tor.peersWeAreUploadingTo( ) );
 256             break;
 257
 258         default:
 259             str = tr( "Error" );
 260             break;
 261     }
 262
 263     if( tor.isReadyToTransfer( ) ) {
 264         QString s = shortTransferString( tor );
 265         if( !s.isEmpty( ) )
 266             str += tr( " - " ) + s;
 267     }
 268
 269     return str;
 270 }
 271
 272 /***
 273 ****
 274 ***/
 275
 276 namespace
 277 {
 278     int MAX3( int a, int b, int c )
 279     {
 280         const int ab( a > b ? a : b );
 281         return ab > c ? ab : c;
 282     }
 283 }
 284
 285 QSize
 286 TorrentDelegate :: sizeHint( const QStyleOptionViewItem& option, const Torrent& tor ) const
 287 {
 288     const QStyle* style( QApplication::style( ) );
 289     static const int iconSize( style->pixelMetric( QStyle::PM_MessageBoxIconSize ) );
 290
 291     QFont nameFont( option.font );
 292     nameFont.setWeight( QFont::Bold );
 293     const QFontMetrics nameFM( nameFont );
 294     const QString nameStr( tor.name( ) );
 295     const int nameWidth = nameFM.width( nameStr );
 296     QFont statusFont( option.font );
 297     statusFont.setPointSize( int( option.font.pointSize( ) * 0.9 ) );
 298     const QFontMetrics statusFM( statusFont );
 299     const QString statusStr( statusString( tor ) );
 300     const int statusWidth = statusFM.width( statusStr );
 301     QFont progressFont( statusFont );
 302     const QFontMetrics progressFM( progressFont );
 303     const QString progressStr( progressString( tor ) );
 304     const int progressWidth = progressFM.width( progressStr );
 305     const QSize m( margin( *style ) );
 306     return QSize( m.width()*2 + iconSize + GUI_PAD + MAX3( nameWidth, statusWidth, progressWidth ),
 307                   //m.height()*3 + nameFM.lineSpacing() + statusFM.lineSpacing()*2 + progressFM.lineSpacing() );
 308                   m.height()*3 + nameFM.lineSpacing() + statusFM.lineSpacing() + BAR_HEIGHT + progressFM.lineSpacing() );
 309 }
 310
 311 QSize
 312 TorrentDelegate :: sizeHint( const QStyleOptionViewItem  & option,
 313                              const QModelIndex           & index ) const
 314 {
 315     const Torrent * tor( index.data( TorrentModel::TorrentRole ).value<const Torrent*>() );
 316     return sizeHint( option, *tor );
 317 }
 318
 319 void
 320 TorrentDelegate :: paint( QPainter                    * painter,
 321                           const QStyleOptionViewItem  & option,
 322                           const QModelIndex           & index) const
 323 {
 324     const Torrent * tor( index.data( TorrentModel::TorrentRole ).value<const Torrent*>() );
 325     painter->save( );
 326     painter->setClipRect( option.rect );
 327     drawTorrent( painter, option, *tor );
 328     painter->restore( );
 329 }
 330
 331 void
 332 TorrentDelegate :: setProgressBarPercentDone( const QStyleOptionViewItem& option, const Torrent& tor ) const
 333 {
 334     double seedRatioLimit;
 335     if (tor.isSeeding() && tor.getSeedRatio(seedRatioLimit))
 336     {
 337         const double seedRateRatio = tor.ratio() / seedRatioLimit;
 338         const int scaledProgress = seedRateRatio * (myProgressBarStyle->maximum - myProgressBarStyle->minimum);
 339         myProgressBarStyle->progress = myProgressBarStyle->minimum + scaledProgress;
 340     }
 341     else
 342     {
 343         const bool isMagnet( !tor.hasMetadata( ) );
 344         myProgressBarStyle->direction = option.direction;
 345         myProgressBarStyle->progress = int(myProgressBarStyle->minimum + (((isMagnet ? tor.metadataPercentDone() : tor.percentDone()) * (myProgressBarStyle->maximum - myProgressBarStyle->minimum))));
 346     }
 347 }
 348
 349 void
 350 TorrentDelegate :: drawTorrent( QPainter * painter, const QStyleOptionViewItem& option, const Torrent& tor ) const
 351 {
 352     const QStyle * style( QApplication::style( ) );
 353     static const int iconSize( style->pixelMetric( QStyle::PM_LargeIconSize ) );
 354     QFont nameFont( option.font );
 355     nameFont.setWeight( QFont::Bold );
 356     const QFontMetrics nameFM( nameFont );
 357     const QString nameStr( tor.name( ) );
 358     const QSize nameSize( nameFM.size( 0, nameStr ) );
 359     QFont statusFont( option.font );
 360     statusFont.setPointSize( int( option.font.pointSize( ) * 0.9 ) );
 361     const QFontMetrics statusFM( statusFont );
 362     const QString statusStr( progressString( tor ) );
 363     QFont progressFont( statusFont );
 364     const QFontMetrics progressFM( progressFont );
 365     const QString progressStr( statusString( tor ) );
 366     const bool isPaused( tor.isPaused( ) );
 367
 368     painter->save( );
 369
 370     if (option.state & QStyle::State_Selected) {
 371         QPalette::ColorGroup cg = option.state & QStyle::State_Enabled
 372                                   ? QPalette::Normal : QPalette::Disabled;
 373         if (cg == QPalette::Normal && !(option.state & QStyle::State_Active))
 374             cg = QPalette::Inactive;
 375
 376         painter->fillRect(option.rect, option.palette.brush(cg, QPalette::Highlight));
 377     }
 378
 379     QIcon::Mode im;
 380     if( isPaused || !(option.state & QStyle::State_Enabled ) ) im = QIcon::Disabled;
 381     else if( option.state & QStyle::State_Selected ) im = QIcon::Selected;
 382     else im = QIcon::Normal;
 383
 384     QIcon::State qs;
 385     if( isPaused ) qs = QIcon::Off;
 386     else qs = QIcon::On;
 387
 388     QPalette::ColorGroup cg = QPalette::Normal;
 389     if( isPaused || !(option.state & QStyle::State_Enabled ) ) cg = QPalette::Disabled;
 390     if( cg == QPalette::Normal && !(option.state & QStyle::State_Active ) ) cg = QPalette::Inactive;
 391
 392     QPalette::ColorRole cr;
 393     if( option.state & QStyle::State_Selected ) cr = QPalette::HighlightedText;
 394     else cr = QPalette::Text;
 395
 396     QStyle::State progressBarState( option.state );
 397     if( isPaused ) progressBarState = QStyle::State_None;
 398     progressBarState |= QStyle::State_Small;
 399
 400     // layout
 401     const QSize m( margin( *style ) );
 402     QRect fillArea( option.rect );
 403     fillArea.adjust( m.width(), m.height(), -m.width(), -m.height() );
 404     QRect iconArea( fillArea.x( ), fillArea.y( ) + ( fillArea.height( ) - iconSize ) / 2, iconSize, iconSize );
 405     QRect nameArea( iconArea.x( ) + iconArea.width( ) + GUI_PAD, fillArea.y( ),
 406                     fillArea.width( ) - GUI_PAD - iconArea.width( ), nameSize.height( ) );
 407     QRect statusArea( nameArea );
 408     statusArea.moveTop( nameArea.y( ) + nameFM.lineSpacing( ) );
 409     statusArea.setHeight( nameSize.height( ) );
 410     QRect barArea( statusArea );
 411     barArea.setHeight( BAR_HEIGHT );
 412     barArea.moveTop( statusArea.y( ) + statusFM.lineSpacing( ) );
 413     QRect progArea( statusArea );
 414     progArea.moveTop( barArea.y( ) + barArea.height( ) );
 415
 416     // render
 417     if( tor.hasError( ) )
 418         painter->setPen( QColor( "red" ) );
 419     else
 420         painter->setPen( option.palette.color( cg, cr ) );
 421     tor.getMimeTypeIcon().paint( painter, iconArea, Qt::AlignCenter, im, qs );
 422     painter->setFont( nameFont );
 423     painter->drawText( nameArea, 0, nameFM.elidedText( nameStr, Qt::ElideRight, nameArea.width( ) ) );
 424     painter->setFont( statusFont );
 425     painter->drawText( statusArea, 0, statusFM.elidedText( statusStr, Qt::ElideRight, statusArea.width( ) ) );
 426     painter->setFont( progressFont );
 427     painter->drawText( progArea, 0, progressFM.elidedText( progressStr, Qt::ElideRight, progArea.width( ) ) );
 428     myProgressBarStyle->rect = barArea;
 429     if ( tor.isDownloading() ) {
 430         myProgressBarStyle->palette.setBrush( QPalette::Highlight, blueBrush );
 431         myProgressBarStyle->palette.setColor( QPalette::Base, blueBack );
 432         myProgressBarStyle->palette.setColor( QPalette::Background, blueBack );
 433     }
 434     else if ( tor.isSeeding() ) {
 435         myProgressBarStyle->palette.setBrush( QPalette::Highlight, greenBrush );
 436         myProgressBarStyle->palette.setColor( QPalette::Base, greenBack );
 437         myProgressBarStyle->palette.setColor( QPalette::Background, greenBack );
 438     }
 439     myProgressBarStyle->state = progressBarState;
 440     setProgressBarPercentDone( option, tor );
 441
 442     style->drawControl( QStyle::CE_ProgressBar, myProgressBarStyle, painter );
 443
 444     painter->restore( );
 445 }