BuddyPlugin
From AzureusWiki
Azureus "Buddy" Plugin Functional Specification
Contents |
1. Introduction
By introducing its own tracker and later the 'share' functionalities, azureus has improved the ease to share contents with friends. The goal of the Buddy Plugin is to provide access to friends's torrents in an easy way. Working like an Instant Messaging application, you will be able to add 'friends', and once they accept you list (some of) their torrents. The goal of this document is to provide functional specifications for this plugin.
2. Im-like , login
The network to be used is not fixed yet, and won't be part of this specification. However, an IM or IM-like network would be good, allowing :
- login with user / pass
- online storage of buddy list
- ability to add / remove buddys
- ability to allow / disallow someone (often linked to the fact that people are in your buddy list, making the relations symetric)
- notification of buddys status (at least logged in / logged out)
3. Configuration Panel
The plugin will provide a configuration panel, allowing the user to store its username and its password, as well as any preference the plugin might provide Before using the plugin the user will have to configure its configuration panel. If possible, the plugin will provide a way to create an account from Azureus, or if the choosen network doesn't allow this, link to correct the web page.
4. Buddys list
The Buddys list will be part of the main window, certainly as in the IRC plugin as a list on the left / right. The buddy list will have -in a to be specified way- to show real buddys, buddys for which you need their authorisation, buddys waiting for yours, and blocked buddys.
5. Browsing
The first way to use the Buddy Plugin will be to browse torrents. A torrent list should be created locally, displayed as a tree table, where each node is a torrent, and each following leaves are the same torrent if seen on multiple buddys. Basic information should be available like : name, size, #seeds, #peers as well, as, if possible buddy's information like : connected peers, connected seeds, availability, overall speed(total) ... which could be usefull for users finally some specific 'plugin' field should be created, especially : comment (personal comment from your buddy) and recommendation level (represented graphically with stars for example)
Of course, the buddy will be displayed as a column too.
The table will provide a way to sort / filter on any value, and quick access buttons will provide some specific 'views' like : Higly recommended torrents Latest torrents Torrents from buddy X ...
6. Searching
A simple search will have to be proposed
7. Aggregation
- TO BE DISCUSSED
Aggregation of torrents consists on publishing under our name, our buddys torrents. To avoid 'divergence' a solution would be to publish them as being 'external', and when publishing other's torrents, not publishing 'external' ones. Aggregation, whatever is the way it is implemented will have to use two configurable parameters which are : 1. Allow my buddys to aggregate (publish) my torrents along with theirs 2. Aggregate my buddys' torrents when publishing
8. Instant Messaging
Even if this isn't the goal of this plugin, instant messaging could be added, Allowing messages from non-buddys users will have to be up to the end-user, as an option
9. Discovery
- TO BE DISCUSSED
The plugin should propose an easy discovery method, so that users using azureus AND this plugin might be able to publicly release their nickname while using bittorrent. The plugin could then contact other's azureus peers on each torrent, and see if their nickname is publicly available.
