GSoC 2009/Projects/BitTorrent plugin for Canola

(→Alpha version)
 
(28 intermediate revisions not shown)
Line 5: Line 5:
*'''Repository''': http://gitorious.org/canola-bittorrent-plugin
*'''Repository''': http://gitorious.org/canola-bittorrent-plugin
 +
== Intro ==
 +
The purpose of this project is to develop a BitTorrent plugin for Canola2.
-
===Project summary===
+
== Features ==
-
The purpose of this project is to develop a BitTorrent plugin for Canola. So far I can have list of RSS feeds and list of torrents for each. RSS feeds allow quick access to fresh torrents on several websites. The backend will be based on Transmission. Most used BitTorrent client for Maemo is Transmission, it exposes JSON based RPC interface which is easy to use from plugin. After completion of this feature I will also add libtransmission support so running Transmission separately is not required.
+
* Browse RSS feeds of several (legal) torrent sites. Includes detailed view of feed entry
 +
* Allow seaching torrent sites: The Pirate Bay, Mininova and LegalTorrents
 +
* Download torrents using built-in BitTorrent 3. Includes detailed view of download
 +
* Download torrents using locally running Transmission via JSON RPC interface
 +
* Manage torrent downloads on remote Transmission instance
 +
* Allows accessing password protected remote instances of Transmission via standard URL format: http://user:pass@host:9091
 +
* Respects your Canola settings of download folder
 +
* Allows adding, modifying, deleting and renaming RSS feeds
 +
* Allows adding, modifying, deleting and renaming Transmission hosts
-
==Alpha version==
+
== To-do ==
-
To install on your Nokia internet tablet, point your web browser to:
+
* Make possible to choose between built-in BitTorrent engine and running Transmission for local downloads
-
http://v6sa.itcollege.ee/shared/canola/canola2-torrent-plugin.deb
+
* Consistent terminology among the source code (leechers vs peers for example)
 +
* Save some of the runtime options to SQL database included in Canola (SQL table for dict perhaps?)
-
Follow your application manager dialogs and you're done!
+
== Other ideas ==
-
NB! You are expected to have Transmission and Canola2 installed on your device!
+
* Allow searching in RSS feed
-
License: BSD licence
+
* Allow browsing Torrent contents and playback of retrieved media.
-
[Image:http://v6sa.itcollege.ee/shared/canola/screenshot1.png]
+
* Clean up download view and feed entry view
-
[Image:http://v6sa.itcollege.ee/shared/canola/screenshot2.png]
+
* Clean up menus
-
[Image:http://v6sa.itcollege.ee/shared/canola/screenshot3.png]
+
* Debug
-
[Image:http://v6sa.itcollege.ee/shared/canola/screenshot4.png]
+
-
==Done==
+
==Installing and usage==
-
This is multi-purpose torrent plugin, so far I have completed
+
Please follow manual [http://v6sa.itcollege.ee/shared/canola/man here]
-
* Management of Transmission instances on several hosts:
+
-
** Pause, resume, remove torrents.
+
-
** Show done/total sizes and up/download speeds.
+
-
** Options panel includes Pause all and Resume all.  
+
-
** Hosts and their login information is stored in Canola's SQL database.
+
-
** This allows user to manage their downloads on desktop, laptop, router etc.
+
-
* Painless management of local Transmission instance on the tablet
+
-
** Starts Transmission minimized and paused if required.
+
-
** Reads Transmission settings automatically or resets them.
+
-
** Using separate process allows user to exit Canola while keeping their downloads running.
+
-
* Read RSS feeds of several (legal) torrent websites.
+
-
** Add linked torrents to running Transmission instances (currently adds to local Transmission only).
+
-
** Respects your download folder location set in Canola settings panel
+
-
** This allows user easily to browse new media availible and start downloading with single click.
+
-
* Manipulation of host list.
+
-
** You can also enter passworded Transmission instances in the standard URL format: http://user:pass@host:9091
+
-
* Manipulation of feed list
+
-
==To-Do==
+
==Reports==
-
* Fullscreen view of feed item:
+
[[GSoC_2009/Projects/BitTorrent_plugin_for_Canola/Report1|First report]], a bit late tough :P
-
** Long description
+
 
-
** In Options panel choice for download destination (which Transmission instance)
+
[[GSoC_2009/Projects/BitTorrent_plugin_for_Canola/Report2|Second report]], some new stuff
-
* Fullscreen view of torrent:
+
 
-
** Show detailed information about torrent while downloading (peer count, blocks done, verified, undone,etc).
+
[[GSoC_2009/Projects/BitTorrent_plugin_for_Canola/Report3|Third report]], we're approaching finish soon
-
** Otherwise allow browsing Torrent contents and playback of retrieved media.
+
 
-
* Add feature to search in RSS feeds
+
[[GSoC_2009/Projects/BitTorrent_plugin_for_Canola/Report4|Final report]]
-
* Finally add built-in torrent library support, so this plugin would not depend on the whole Transmission package
+
 
 +
[[Category:Google Summer of Code]]

Latest revision as of 09:57, 12 February 2010

Contents

[edit] BitTorrent plugin for Canola - GSoC 2009 Project

[edit] Intro

The purpose of this project is to develop a BitTorrent plugin for Canola2.

[edit] Features

  • Browse RSS feeds of several (legal) torrent sites. Includes detailed view of feed entry
  • Allow seaching torrent sites: The Pirate Bay, Mininova and LegalTorrents
  • Download torrents using built-in BitTorrent 3. Includes detailed view of download
  • Download torrents using locally running Transmission via JSON RPC interface
  • Manage torrent downloads on remote Transmission instance
  • Allows accessing password protected remote instances of Transmission via standard URL format: http://user:pass@host:9091
  • Respects your Canola settings of download folder
  • Allows adding, modifying, deleting and renaming RSS feeds
  • Allows adding, modifying, deleting and renaming Transmission hosts

[edit] To-do

  • Make possible to choose between built-in BitTorrent engine and running Transmission for local downloads
  • Consistent terminology among the source code (leechers vs peers for example)
  • Save some of the runtime options to SQL database included in Canola (SQL table for dict perhaps?)

[edit] Other ideas

  • Allow searching in RSS feed
  • Allow browsing Torrent contents and playback of retrieved media.
  • Clean up download view and feed entry view
  • Clean up menus
  • Debug

[edit] Installing and usage

Please follow manual here

[edit] Reports

First report, a bit late tough :P

Second report, some new stuff

Third report, we're approaching finish soon

Final report

Retrieved from "http://bugs.maemo.org/GSoC_2009/Projects/BitTorrent_plugin_for_Canola"