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_ready(false)
  49 {
  50     kDebug(5001);
  51     if (m_source.url().isEmpty())
  52         return;
  53
  54     if (!m_source.isLocalFile())
  55     {
  56         kDebug(5001) << m_dest.path();
  57         BTDownload *download = new BTDownload(m_source);
  58
  59         setStatus(Job::Stopped, i18n("Downloading Torrent-File.."), SmallIcon("document-save"));
  60         setTransferChange(Tc_Status, true);
  61
  62         m_source = KStandardDirs::locateLocal("appdata", "tmp/") + m_source.fileName();
  63         connect(download, SIGNAL(finishedSuccessfully(KUrl)), SLOT(init(KUrl)));
  64     }
  65     else
  66         init();
  67 }
  68
  69 void BTTransfer::init(KUrl src)
  70 {
  71     kDebug(5001);
  72     if (src != m_source && !src.isEmpty())
  73         m_source = src;
  74
  75     setStatus(Job::Stopped, i18n("Stopped"), SmallIcon("process-stop"));
  76     setTransferChange(Tc_Status, true);
  77
  78     bt::InitLog(KStandardDirs::locateLocal("appdata", "torrentlog.log"));//initialize the torrent-log
  79
  80     bt::SetClientInfo("KGet",2,0,1,bt::RELEASE_CANDIDATE,"KG");
  81
  82     bt::Uint16 i = 0;
  83     do
  84     {
  85         kDebug(5001) << "Trying to set port to" << BittorrentSettings::port() + i;
  86         bt::Globals::instance().initServer(BittorrentSettings::port() + i);
  87         i++;
  88     }while (!bt::Globals::instance().getServer().isOK() && i < 10);
  89
  90     if (!bt::Globals::instance().getServer().isOK())
  91         return;
  92
  93     try
  94     {
  95         torrent = new bt::TorrentControl();
  96
  97         if (!BittorrentSettings::tmpDir().isEmpty())
  98         {
  99             m_tmp = BittorrentSettings::tmpDir();
 100             kDebug(5001) << "Trying to set" << m_tmp << " as tmpDir";
 101             if (!QFileInfo(m_tmp).isDir())
 102                 m_tmp = KStandardDirs::locateLocal("appdata", "tmp/");
 103         }
 104         else
 105             m_tmp = KStandardDirs::locateLocal("appdata", "tmp/");
 106
 107         m_ready = true;
 108
 109         torrent->init(0, m_source.url().remove("file://"), m_tmp + m_source.fileName().remove(".torrent"),
 110                                                              m_dest.directory().remove("file://"), 0);
 111
 112         if (torrent->getStats().multi_file_torrent)
 113             m_dest = torrent->getStats().output_path;
 114         else
 115             m_dest = torrent->getDataDir() + torrent->getStats().torrent_name;
 116
 117         torrent->createFiles();
 118
 119         torrent->setPreallocateDiskSpace(BittorrentSettings::preAlloc());
 120         //torrent->setMaxShareRatio(1); //TODO: Make configurable...
 121         kDebug(5001) << "Source:" << m_source.url();
 122         kDebug(5001) << "Dest:" << m_dest.url();
 123         kDebug(5001) << "Temp:" << m_tmp;
 124
 125         connect(torrent, SIGNAL(stoppedByError(bt::TorrentInterface*, QString)), SLOT(slotStoppedByError(bt::TorrentInterface*, QString)));
 126         connect(torrent, SIGNAL(finished(bt::TorrentInterface*)), this, SLOT(slotDownloadFinished(bt::TorrentInterface* )));
 127         //FIXME connect(tc,SIGNAL(corruptedDataFound( bt::TorrentInterface* )), this, SLOT(emitCorruptedData( bt::TorrentInterface* )));
 128     }
 129     catch (bt::Error &err)
 130     {
 131         kDebug(5001) << err.toString();
 132     }
 133     connect(&timer, SIGNAL(timeout()), SLOT(update()));
 134 }
 135
 136 BTTransfer::~BTTransfer()
 137 {
 138     kDebug(5001);
 139     if (torrent)
 140         delete torrent;
 141 }
 142
 143 bool BTTransfer::isResumable() const
 144 {
 145     kDebug(5001);
 146     return true;
 147 }
 148
 149 void BTTransfer::start()
 150 {
 151     kDebug(5001);
 152
 153     if (m_ready)
 154     {
 155         kDebug(5001) << "Going to download that stuff :-0";
 156         kDebug(5001) << "Here we are";
 157         torrent->start();
 158         kDebug(5001) << "Got started??";
 159         timer.start(250);
 160         setStatus(Job::Running, i18n("Downloading.."), SmallIcon("media-playback-start"));
 161         kDebug(5001) << "Jepp, it does";
 162         m_totalSize = totalSize();
 163         setTransferChange(Tc_Status | Tc_TrackersList | Tc_TotalSize, true);
 164         kDebug(5001) << "Completely";
 165         setTrafficLimits(m_ulLimit, m_dlLimit);
 166     }
 167 }
 168
 169 void BTTransfer::stop()
 170 {
 171     kDebug(5001);
 172     if (m_ready)
 173     {
 174         torrent->stop(true);
 175         m_speed = 0;
 176         timer.stop();
 177         setStatus(Job::Stopped, i18n("Stopped"), SmallIcon("process-stop"));
 178         setTransferChange(Tc_Status, true);
 179     }
 180 }
 181
 182 void BTTransfer::update()
 183 {
 184     kDebug(5001);
 185
 186     if (torrent)
 187     {
 188         QStringList files;
 189         if (torrent->hasMissingFiles(files))
 190         {
 191             kDebug(5001) << "Recreate Missing Files";
 192             torrent->recreateMissingFiles();
 193         }
 194
 195         kDebug(5001) << "Update torrent";
 196         bt::UpdateCurrentTime();
 197         bt::AuthenticationMonitor::instance().update();
 198         kDebug(5001) << "Ignore this ;)";
 199         torrent->update();
 200         kDebug(5001) << "Done";
 201         m_speed = dlRate();
 202         m_percent = percent();
 203
 204         setTransferChange(Tc_ProcessedSize | Tc_Speed | Tc_Percent, true);
 205     }
 206     else
 207         timer.stop();
 208 }
 209
 210 void BTTransfer::save(const QDomElement &element)
 211 {
 212 }
 213
 214 void BTTransfer::load(const QDomElement &e)
 215 {
 216 }
 217
 218 void BTTransfer::slotStoppedByError(bt::TorrentInterface* error, QString errormsg)
 219 {
 220     kDebug(5001) << errormsg;
 221 }
 222
 223 void BTTransfer::setPort(int port)
 224 {
 225     kDebug(5001);
 226     bt::Globals::instance().getServer().changePort(port);
 227 }
 228
 229 void BTTransfer::slotDownloadFinished(bt::TorrentInterface* ti)
 230 {
 231     kDebug(5001);
 232     timer.stop();
 233     setStatus(Job::Finished, i18n("Finished"), SmallIcon("ok"));
 234     setTransferChange(Tc_Status, true);
 235 }
 236
 237 void BTTransfer::setTrafficLimits(int ulLimit, int dlLimit)
 238 {
 239     kDebug(5001);
 240     if (!torrent)
 241         return;
 242
 243     torrent->setTrafficLimits(ulLimit * 1000, dlLimit * 1000);
 244     m_dlLimit = dlLimit;
 245     m_ulLimit = ulLimit;
 246 }
 247
 248 void BTTransfer::addTracker(QString url)
 249 {
 250     kDebug(5001) << "YOU TOOOOOOOOOOOOOOOOOOOOOOOOO" << url;
 251     if(torrent->getStats().priv_torrent)
 252     {
 253         KMessageBox::sorry(0, i18n("Cannot add a tracker to a private torrent."));
 254         return;
 255     }
 256
 257     if(!KUrl(url).isValid())
 258     {
 259         KMessageBox::error(0, i18n("Malformed URL."));
 260         return;
 261     }
 262
 263     torrent->getTrackersList()->addTracker(url,true);
 264 }
 265
 266 /**Property-Functions**/
 267 KUrl::List BTTransfer::trackersList() const
 268 {
 269     kDebug(5001);
 270     if (!torrent)
 271         return KUrl::List();
 272
 273     const KUrl::List trackers = torrent->getTrackersList()->getTrackerURLs();
 274     return trackers;
 275 }
 276
 277 int BTTransfer::dlRate() const
 278 {
 279     kDebug(5001);
 280     if (!torrent)
 281         return -1;
 282
 283     return torrent->getStats().download_rate;
 284 }
 285
 286 int BTTransfer::ulRate() const
 287 {
 288     kDebug(5001);
 289     if (!torrent)
 290         return -1;
 291
 292     return torrent->getStats().upload_rate;
 293 }
 294
 295 int BTTransfer::totalSize() const
 296 {
 297     kDebug(5001);
 298     if (!torrent)
 299         return -1;
 300
 301     return torrent->getStats().total_bytes_to_download;
 302 }
 303
 304 int BTTransfer::sessionBytesDownloaded() const
 305 {
 306     kDebug(5001);
 307     if (!torrent)
 308         return -1;
 309
 310     return torrent->getStats().session_bytes_downloaded;
 311 }
 312
 313 int BTTransfer::sessionBytesUploaded() const
 314 {
 315     kDebug(5001);
 316     if (!torrent)
 317         return -1;
 318
 319     return torrent->getStats().session_bytes_uploaded;
 320 }
 321
 322 int BTTransfer::chunksTotal() const
 323 {
 324     kDebug(5001);
 325     if (!torrent)
 326         return -1;
 327
 328     return torrent->getTorrent().getNumChunks();
 329 }
 330
 331 int BTTransfer::chunksDownloaded() const
 332 {
 333     kDebug(5001);
 334     if (!torrent)
 335         return -1;
 336
 337     return torrent->downloadedChunksBitSet().numOnBits();
 338 }
 339
 340 int BTTransfer::chunksExcluded() const
 341 {
 342     kDebug(5001);
 343     if (!torrent)
 344         return -1;
 345
 346     return torrent->excludedChunksBitSet().numOnBits();
 347 }
 348
 349 int BTTransfer::chunksLeft() const
 350 {
 351     kDebug(5001);
 352     if (!torrent)
 353         return -1;
 354
 355     return chunksTotal() - chunksDownloaded();
 356 }
 357
 358 int BTTransfer::seedsConnected() const
 359 {
 360     kDebug(5001);
 361     if (!torrent)
 362         return -1;
 363
 364     return torrent->getStats().seeders_connected_to;
 365 }
 366
 367 int BTTransfer::seedsDisconnected() const
 368 {
 369     kDebug(5001);
 370     if (!torrent)
 371         return -1;
 372
 373     return torrent->getStats().seeders_total;
 374 }
 375
 376 int BTTransfer::leechesConnected() const
 377 {
 378     kDebug(5001);
 379     if (!torrent)
 380         return -1;
 381
 382     return torrent->getStats().leechers_connected_to;
 383 }
 384
 385 int BTTransfer::leechesDisconnected() const
 386 {
 387     kDebug(5001);
 388     if (!torrent)
 389         return -1;
 390
 391     return torrent->getStats().leechers_total;
 392 }
 393
 394 int BTTransfer::elapsedTime() const
 395 {
 396     if (!torrent)
 397         return -1;
 398
 399     kDebug(5001);
 400     return torrent->getRunningTimeDL();
 401 }
 402
 403 int BTTransfer::remainingTime() const
 404 {
 405     if (!torrent)
 406         return -1;
 407
 408     kDebug(5001);
 409     return torrent->getETA();
 410 }
 411
 412 int BTTransfer::ulLimit() const
 413 {
 414     kDebug(5001);
 415     if (!torrent)
 416         return -1;
 417     else
 418         return m_ulLimit;
 419 }
 420
 421 int BTTransfer::dlLimit() const
 422 {
 423     kDebug(5001);
 424     if (!torrent)
 425         return -1;
 426     else
 427         return m_dlLimit;
 428 }
 429
 430 bt::TorrentControl * BTTransfer::torrentControl()
 431 {
 432     kDebug(5001);
 433     return torrent;
 434 }
 435
 436 int BTTransfer::percent() const
 437 {
 438     kDebug(5001);
 439     if (!torrent)
 440         return -1;
 441
 442     return ((float) chunksDownloaded() / (float) chunksTotal()) * 100;
 443 }
 444
 445 bool BTTransfer::ready()
 446 {
 447     kDebug(5001);
 448     return m_ready;
 449 }
 450
 451 #include "bttransfer.moc"