kget/transfer-plugins/bittorrent/bttransfer.cpp

   1 /* This file is part of the KDE project
   2
   3    Copyright (C) 2007 Lukas Appelhans <l.appelhans@gmx.de>
   4    Copyright (C) 2007 Joris Guisson   <joris.guisson@gmail.com>
   5
   6    This program is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public
   8    License as published by the Free Software Foundation; either
   9    version 2 of the License, or (at your option) any later version.
  10 */
  11
  12 #include "bttransfer.h"
  13 #include "bittorrentsettings.h"
  14
  15 #include "core/kget.h"
  16
  17 #include <torrent/torrent.h>
  18 #include <peer/peermanager.h>
  19 #include <util/error.h>
  20 #include <torrent/globals.h>
  21 #include <torrent/server.h>
  22 #include <util/constants.h>
  23 #include <util/functions.h>
  24 #include <util/log.h>
  25 #include <peer/authenticationmonitor.h>
  26 #include <btdownload.h>
  27 #include <btversion.h>
  28
  29 #include <KDebug>
  30 #include <KLocale>
  31 #include <KIconLoader>
  32 #include <KStandardDirs>
  33 #include <KUrl>
  34 #include <KMessageBox>
  35
  36 #include <QFile>
  37 #include <QDomElement>
  38 #include <QFileInfo>
  39
  40 BTTransfer::BTTransfer(TransferGroup* parent, TransferFactory* factory,
  41                Scheduler* scheduler, const KUrl& src, const KUrl& dest,
  42                const QDomElement * e)
  43   : Transfer(parent, factory, scheduler, src, dest, e),
  44     torrent(0),
  45     m_tmp(0),
  46     m_dlLimit(BittorrentSettings::downloadLimit()),
  47     m_ulLimit(BittorrentSettings::uploadLimit()),
  48     m_ratio(BittorrentSettings::maxShareRatio()),
  49     m_ready(false)
  50 {
  51     kDebug(5001);
  52     if (m_source.url().isEmpty())
  53         return;
  54
  55     if (e)
  56         load(*e);
  57 }
  58
  59 BTTransfer::~BTTransfer()
  60 {
  61     kDebug(5001);
  62     if (torrent)
  63         delete torrent;
  64 }
  65
  66 /**Reimplemented functions from Transfer-Class (transfer.cpp)**/
  67 bool BTTransfer::isResumable() const
  68 {
  69     kDebug(5001);
  70     return true;
  71 }
  72
  73 void BTTransfer::start()
  74 {
  75     kDebug(5001);
  76     if (!torrent)
  77     {
  78         if (!m_source.isLocalFile())
  79         {
  80             kDebug(5001) << m_dest.path();
  81              BTDownload *download = new BTDownload(m_source);
  82
  83             setStatus(Job::Stopped, i18n("Downloading Torrent-File.."), SmallIcon("document-save"));
  84             setTransferChange(Tc_Status, true);
  85
  86             m_source = KStandardDirs::locateLocal("appdata", "tmp/") + m_source.fileName();
  87             connect(download, SIGNAL(finishedSuccessfully(KUrl)), SLOT(init(KUrl)));
  88         }
  89         else
  90             init();
  91     }
  92     else
  93         startTorrent();
  94 }
  95
  96 void BTTransfer::stop()
  97 {
  98     kDebug(5001);
  99     if (m_ready)
 100     {
 101         stopTorrent();
 102     }
 103 }
 104
 105 void BTTransfer::update()
 106 {
 107     kDebug(5001);
 108
 109     if (torrent)
 110     {
 111         QStringList files;
 112         if (torrent->hasMissingFiles(files))
 113         {
 114             kDebug(5001) << "Recreate Missing Files";
 115             torrent->recreateMissingFiles();
 116         }
 117         updateTorrent();
 118     }
 119     else
 120         timer.stop();
 121 }
 122
 123 void BTTransfer::load(const QDomElement &e)
 124 {
 125     kDebug(5001);
 126     m_source = KUrl(e.attribute("Source"));
 127     m_dest = KUrl(e.attribute("Dest"));
 128
 129     m_totalSize = e.attribute("TotalSize").toULongLong();
 130     m_processedSize = e.attribute("ProcessedSize").toULongLong();
 131
 132     if( m_totalSize != 0)
 133         m_percent = (int)((100.0 * m_processedSize) / m_totalSize);
 134     else
 135         m_percent = 0;
 136
 137     m_ulLimit = e.attribute("Upload-Limit").toInt();
 138     m_dlLimit = e.attribute("Download-Limit").toInt();
 139
 140     if((m_totalSize == m_processedSize) && (m_totalSize != 0))
 141     {
 142         setStatus(Job::Finished, i18n("Finished"), SmallIcon("dialog-ok"));
 143         // "ok" icon should probably be "dialog-success", but we don't have that icon in KDE 4.0
 144     }
 145     else
 146     {
 147         setStatus(status(), i18n("Stopped"), SmallIcon("process-stop"));
 148     }
 149 }
 150
 151 void BTTransfer::save(const QDomElement &element)
 152 {
 153     kDebug(5001);
 154
 155     QDomElement e = element;
 156
 157     Transfer::save(e);
 158
 159     e.setAttribute("Upload-Limit", ulLimit());
 160     e.setAttribute("Download-Limit", dlLimit());
 161 }
 162
 163 /**Public functions of BTTransfer**/
 164
 165 void BTTransfer::setPort(int port)
 166 {
 167     kDebug(5001);
 168     bt::Globals::instance().getServer().changePort(port);
 169 }
 170
 171 void BTTransfer::setTrafficLimits(int ulLimit, int dlLimit)
 172 {
 173     kDebug(5001);
 174     if (!torrent)
 175         return;
 176
 177     torrent->setTrafficLimits(ulLimit * 1000, dlLimit * 1000);
 178     m_dlLimit = dlLimit;
 179     m_ulLimit = ulLimit;
 180 }
 181
 182 void BTTransfer::setMaxShareRatio(float ratio)
 183 {
 184     if (m_ratio != ratio)
 185         m_ratio = ratio;
 186
 187     if (m_ratio != 0)
 188         torrent->setMaxShareRatio(m_ratio);
 189 }
 190
 191 void BTTransfer::addTracker(QString url)
 192 {
 193     kDebug(5001);
 194     if(torrent->getStats().priv_torrent)
 195     {
 196         KMessageBox::sorry(0, i18n("Cannot add a tracker to a private torrent."));
 197         return;
 198     }
 199
 200     if(!KUrl(url).isValid())
 201     {
 202         KMessageBox::error(0, i18n("Malformed URL."));
 203         return;
 204     }
 205
 206     torrent->getTrackersList()->addTracker(url,true);
 207 }
 208
 209 /**Private functions**/
 210
 211 void BTTransfer::startTorrent()
 212 {
 213     if (m_ready)
 214     {
 215         kDebug(5001) << "Going to download that stuff :-0";
 216         setTrafficLimits(m_ulLimit, m_dlLimit);//Set traffic-limits before starting
 217         kDebug(5001) << "Here we are";
 218         torrent->start();
 219         kDebug(5001) << "Got started??";
 220         timer.start(250);
 221         setStatus(Job::Running, i18n("Downloading.."), SmallIcon("media-playback-start"));
 222         kDebug(5001) << "Jepp, it does";
 223         m_totalSize = totalSize();
 224         setTransferChange(Tc_Status | Tc_TrackersList | Tc_TotalSize, true);
 225         kDebug(5001) << "Completely";
 226     }
 227 }
 228
 229 void BTTransfer::stopTorrent()
 230 {
 231     torrent->stop(true);
 232     m_speed = 0;
 233     timer.stop();
 234     setStatus(Job::Stopped, i18n("Stopped"), SmallIcon("process-stop"));
 235     setTransferChange(Tc_Status, true);
 236 }
 237
 238 void BTTransfer::updateTorrent()
 239 {
 240     kDebug(5001) << "Update torrent";
 241     bt::UpdateCurrentTime();
 242     bt::AuthenticationMonitor::instance().update();
 243     kDebug(5001) << "Ignore this ;)";
 244     torrent->update();
 245     kDebug(5001) << "Done";
 246     m_speed = dlRate();
 247     m_percent = percent();
 248     m_processedSize = processedSize();
 249
 250     setTransferChange(Tc_ProcessedSize | Tc_Speed | Tc_Percent, true);
 251 }
 252
 253 void BTTransfer::init(KUrl src)
 254 {
 255     kDebug(5001);
 256     if (src != m_source && !src.isEmpty())
 257         m_source = src;
 258
 259     setStatus(Job::Running, i18n("Analizing torrent.."), SmallIcon("document-preview")); // jpetso says: you should probably use the "process-working" icon here (from the animations category), but that's a multi-frame PNG so it's hard for me to test
 260     setTransferChange(Tc_Status, true);
 261
 262     bt::InitLog(KStandardDirs::locateLocal("appdata", "torrentlog.log"));//initialize the torrent-log
 263
 264     bt::SetClientInfo("KGet",2,0,0,bt::NORMAL,"KG");//Set client info to KGet, WARNING: Pls change this for every release
 265
 266     bt::Uint16 i = 0;
 267     do
 268     {
 269         kDebug(5001) << "Trying to set port to" << BittorrentSettings::port() + i;
 270         bt::Globals::instance().initServer(BittorrentSettings::port() + i);
 271         i++;
 272     }while (!bt::Globals::instance().getServer().isOK() && i < 10);
 273
 274     if (!bt::Globals::instance().getServer().isOK())
 275         return;
 276
 277     try
 278     {
 279         torrent = new bt::TorrentControl();
 280
 281         if (!BittorrentSettings::tmpDir().isEmpty())
 282         {
 283             m_tmp = BittorrentSettings::tmpDir();
 284             kDebug(5001) << "Trying to set" << m_tmp << " as tmpDir";
 285             if (!QFileInfo(m_tmp).isDir())
 286                 m_tmp = KStandardDirs::locateLocal("appdata", "tmp/");
 287         }
 288         else
 289             m_tmp = KStandardDirs::locateLocal("appdata", "tmp/");
 290
 291         m_ready = true;
 292
 293         torrent->init(0, m_source.url().remove("file://"), m_tmp + m_source.fileName().remove(".torrent"),
 294                                                              m_dest.directory().remove("file://"), 0);
 295
 296         if (torrent->getStats().multi_file_torrent)
 297             m_dest = torrent->getStats().output_path;
 298         else
 299             m_dest = torrent->getDataDir() + torrent->getStats().torrent_name;
 300
 301         torrent->createFiles();
 302
 303         torrent->setPreallocateDiskSpace(BittorrentSettings::preAlloc());
 304
 305         setMaxShareRatio(m_ratio);
 306         setTrafficLimits(m_ulLimit, m_dlLimit);
 307
 308         connect(torrent, SIGNAL(stoppedByError(bt::TorrentInterface*, QString)), SLOT(slotStoppedByError(bt::TorrentInterface*, QString)));
 309         connect(torrent, SIGNAL(finished(bt::TorrentInterface*)), this, SLOT(slotDownloadFinished(bt::TorrentInterface* )));
 310         //FIXME connect(tc,SIGNAL(corruptedDataFound( bt::TorrentInterface* )), this, SLOT(emitCorruptedData( bt::TorrentInterface* )));
 311     }
 312     catch (bt::Error &err)
 313     {
 314         kDebug(5001) << err.toString();
 315         //m_ready = false;
 316     }
 317     startTorrent();
 318     connect(&timer, SIGNAL(timeout()), SLOT(update()));
 319 }
 320
 321 void BTTransfer::slotStoppedByError(bt::TorrentInterface* error, QString errormsg)
 322 {
 323     kDebug(5001) << errormsg;
 324 }
 325
 326 void BTTransfer::slotDownloadFinished(bt::TorrentInterface* ti)
 327 {
 328     kDebug(5001);
 329     timer.stop();
 330     setStatus(Job::Finished, i18n("Finished"), SmallIcon("dialog-ok"));
 331     setTransferChange(Tc_Status, true);
 332 }
 333
 334 /**Property-Functions**/
 335 KUrl::List BTTransfer::trackersList() const
 336 {
 337     kDebug(5001);
 338     if (!torrent)
 339         return KUrl::List();
 340
 341     const KUrl::List trackers = torrent->getTrackersList()->getTrackerURLs();
 342     return trackers;
 343 }
 344
 345 int BTTransfer::dlRate() const
 346 {
 347     kDebug(5001);
 348     if (!torrent)
 349         return -1;
 350
 351     return torrent->getStats().download_rate;
 352 }
 353
 354 int BTTransfer::ulRate() const
 355 {
 356     kDebug(5001);
 357     if (!torrent)
 358         return -1;
 359
 360     return torrent->getStats().upload_rate;
 361 }
 362
 363 float BTTransfer::totalSize() const
 364 {
 365     kDebug(5001);
 366     if (!torrent)
 367         return -1;
 368
 369     return torrent->getStats().total_bytes_to_download;
 370 }
 371
 372 float BTTransfer::processedSize() const
 373 {
 374     kDebug(5001);
 375     if (!torrent)
 376         return -1;
 377
 378     return torrent->getStats().bytes_downloaded;
 379 }
 380
 381 int BTTransfer::sessionBytesDownloaded() const
 382 {
 383     kDebug(5001);
 384     if (!torrent)
 385         return -1;
 386
 387     return torrent->getStats().session_bytes_downloaded;
 388 }
 389
 390 int BTTransfer::sessionBytesUploaded() const
 391 {
 392     kDebug(5001);
 393     if (!torrent)
 394         return -1;
 395
 396     return torrent->getStats().session_bytes_uploaded;
 397 }
 398
 399 int BTTransfer::chunksTotal() const
 400 {
 401     kDebug(5001);
 402     if (!torrent)
 403         return -1;
 404
 405     return torrent->getTorrent().getNumChunks();
 406 }
 407
 408 int BTTransfer::chunksDownloaded() const
 409 {
 410     kDebug(5001);
 411     if (!torrent)
 412         return -1;
 413
 414     return torrent->downloadedChunksBitSet().numOnBits();
 415 }
 416
 417 int BTTransfer::chunksExcluded() const
 418 {
 419     kDebug(5001);
 420     if (!torrent)
 421         return -1;
 422
 423     return torrent->excludedChunksBitSet().numOnBits();
 424 }
 425
 426 int BTTransfer::chunksLeft() const
 427 {
 428     kDebug(5001);
 429     if (!torrent)
 430         return -1;
 431
 432     return chunksTotal() - chunksDownloaded();
 433 }
 434
 435 int BTTransfer::seedsConnected() const
 436 {
 437     kDebug(5001);
 438     if (!torrent)
 439         return -1;
 440
 441     return torrent->getStats().seeders_connected_to;
 442 }
 443
 444 int BTTransfer::seedsDisconnected() const
 445 {
 446     kDebug(5001);
 447     if (!torrent)
 448         return -1;
 449
 450     return torrent->getStats().seeders_total;
 451 }
 452
 453 int BTTransfer::leechesConnected() const
 454 {
 455     kDebug(5001);
 456     if (!torrent)
 457         return -1;
 458
 459     return torrent->getStats().leechers_connected_to;
 460 }
 461
 462 int BTTransfer::leechesDisconnected() const
 463 {
 464     kDebug(5001);
 465     if (!torrent)
 466         return -1;
 467
 468     return torrent->getStats().leechers_total;
 469 }
 470
 471 int BTTransfer::elapsedTime() const
 472 {
 473     if (!torrent)
 474         return -1;
 475
 476     kDebug(5001);
 477     return torrent->getRunningTimeDL();
 478 }
 479
 480 int BTTransfer::remainingTime() const
 481 {
 482     if (!torrent)
 483         return -1;
 484
 485     kDebug(5001);
 486     return torrent->getETA();
 487 }
 488
 489 int BTTransfer::ulLimit() const
 490 {
 491     kDebug(5001);
 492     if (!torrent)
 493         return -1;
 494     else
 495         return m_ulLimit;
 496 }
 497
 498 int BTTransfer::dlLimit() const
 499 {
 500     kDebug(5001);
 501     if (!torrent)
 502         return -1;
 503     else
 504         return m_dlLimit;
 505 }
 506
 507 bt::TorrentControl * BTTransfer::torrentControl()
 508 {
 509     kDebug(5001);
 510     return torrent;
 511 }
 512
 513 int BTTransfer::percent() const
 514 {
 515     kDebug(5001);
 516     if (!torrent)
 517         return -1;
 518
 519     return ((float) chunksDownloaded() / (float) chunksTotal()) * 100;
 520 }
 521
 522 bool BTTransfer::ready()
 523 {
 524     kDebug(5001);
 525     return m_ready;
 526 }
 527
 528 #include "bttransfer.moc"