D-LAN

h1. Functional definition

This page will describes the scope and utilization of Aybabtu.

Some sections will describe a particular window from the user interface, it may refer to the [[GUI]] page.

h2. Description

The goal is to easily share some files and folders in a local area network environment like a LAN-Party. All clients are full-trusted. After you launched Aybabtu, you will see all other people and theirs sharing automatically without special configuration.

Aybabtu come with two executables, the Core and the GUI. It possible to launch one of them alone or both together on the same computer. The GUI is needed to command a Core, to tell it what you want to download, to share, to search, etc. To do that the user have to tell the GUI to connect to a given Core. The Core can be _local_ or _remote_, by default the GUI will try to connect to a local Core. If the connecting attempt to a local Core failed it will try to launch a local Core and connect to it.

The simple usage of Aybabtu is to launch the GUI which will automatically launch the Core. The user may not know there are two distinct process. The core will display an icon in the tray icon (if a tray icon exists). If the user close the GUI the core will continue to run, if he wants to stop the core he has to invoke a contextual menu from the tray icon and choose _Close the Core_. The user can launch the GUI by double-clicking on the tray icon.

To connect to a remote Core, the user have to explicitly enter an IP address and a password in the application settings. The password is mandatory for a remote Core. For one Core it cannot be more than one GUI connected (this limitation may be removed in further version of Aybabtu).

The [[GUI]] shows some default windows, a download windows, an upload window and a chat window. The others windows are the search window, the browse window and the settings window. All of them are described in the sections below.

h3. Downloading

You can download file or entire folder from the searching windows or from the browsing windows. The item will be enqueued to the download list and displayed in the download window.

When downloading a folder, all theirs containing folders and files will be downloaded recursively. The path will be preserved and recreated in the machine of the downloading peer.

When a file or a directory is being downloaded its name will finished by the tag ".unfinished". For example "my movie.mkv.unfinished".

The list of queued items can contains both file or folder, when a folder is downloaded its files and folders are retrieved from the peer and will replace the folder in the list. It calls lazy download.

h2. The main window

At the first launch of Aybabtu it will connect to all peers in the LAN and show them in a panel to the left. The information showed for a peer are its name and its amount of sharing. To view the files of a peer you have to double-click in its name or to invoke the action "browse" from the contextual menu.

The peers in the peer list can be sorted alphabetically or by their amount of sharing.

Above the peer list there is an input box for file searching. You can write something and hit 'return', a new search window will be created and displayed. Each known peer will be asked and the list is filled as a respond is received. You can change the pattern into the search window and relaunch the search. You can have as many search window as you want.

h2. The download window

The download window shows the downloading files and also the queued files and the completed files. The list order cannot be changed except for the queued file. A drop-list allow to set a filter against the status to see, for example, only the downloading files.

For each download the following information are displayed :

* Filename with path.

* File size.

* The status. Shows a progress bar when downloading.

* A list of peer. One per active download.

Here is the different states of the files and folders that this window shows.

# *Complete* : The complete files.

# *Invalid*

## *No source* : The incomplete files with no peers (auto-paused).

## *Not found* : The unfounded files or folders from the peer (a file or a directory has been removed).

## *Unknown peer* : File or folder from unknown peer.

# *Initializing* : When the hashes of a file are requested to a peer.

# *Downloading* : Downloading files. Shows a progress bar.

# *Queued* : Enqueued File or folder.

The state of a download is printed in the column _status_.

For the 2.2 point this can occur when a file or folder has been moved or deleted in the remote peer between the queuing time and the downloading time.

The user can remove all finished files from the list by invoking _clear complete file_ from the contextual menu.

The user can change the order of the enqueued file by selecting some of them and drag it up or down. Only the queued items can be dragged.

h2. The upload window

The upload window shows the list of the currently uploading chunk.

For each uploading chunk these information are displayed :

* The filename with path.

* A progress bar.

* The remote peer name.

h2. The chat window

This window offer a possibility to communicate with other peers via a single channel. It's possible to send messages and received message. Each message show the owner (peer name) and the sent time.

It's possible to create link to a specific file or folder inside a message like that : "(<peer id>,<folder>,<file>)". It can be done automatically from the searching or browsing window vie the contextual menu. A link act like an html-link, the user can click on it. If it's a folder it will be browsed and if it's a file its containing folder will be browsed.

The number of message stored is limited (1000, for example).

h2. The browse window

The browse window shows the shared folders of one peer. There may be several browse window opened in the same time. To open this window the action _browse_ can be invoked from the contextual menu of the peer list by selecting a peer.

The user can unfold recursively the folders to see theirs content. By invoking _download_ from a file or folder the user queue the item in the download window.

The files already owned by the user are displayed with a different background color.

h2. The search window

The _search window_ will search a term to all other peers and progressively display the result. A result can be a folder or a file. There may be several _search window_.

The user can select many file or folder and choose _download_ from a contextual menu. The files and folders will be queued in the _download window_.

The files already owned by the user are displayed with a different background color.

h3. Syntax

There is no special syntax except the quote character used to group some words. For example :

Reference : 'my dog is playing with a bone.avi'

* dog -> OK : my *dog* is playing with a bone.avi

* dog bone -> OK : my *dog* is playing with a *bone*.avi

* bone dog -> OK : my *dog* is playing with a *bone*.avi

* BONE dog -> OK : my *dog* is playing with a *bone*.avi

* BôNE dög -> OK : my *dog* is playing with a *bone*.avi

* "my DOG" -> OK : *my dog* is playing with a bone.avi

* dog "a bone" -> OK : my *dog* is playing with *a bone*.avi

* dog cat -> KO

* "my little dog" -> KO

* "my bone dog" -> KO

The words are split by space but also by other special characters like '.' or '#'. 

For example :

* "my car" matches *my#car*

* "my car" matches *my.car*

* "my.car" matches *my.car*

* "my#car" matches *my.car*

* "£my#$car." matches *my.car*

All special character are ignored in the pattern and in the source.

h2. The settings window

h3. Basic settings

The user can change his nick and define theirs shared and destination folders.

He can define several destination folder. When a new file is created the first folder with enough storage is taken.

h3. Advanced settings

The user can define the remote core to connect. By default it will connect to the local one and eventually try to launch it if necessary.

h2. The logging panel

The logging panel will show a list of information events like 'The file "debian.iso" is complete, <open its containing folder>.'. Like the chat window it must support url but also local url like "<a href="file://...">Open the folder</url>.

Each event is composed by a Time and a message like the chat window. The number of stored message is limited as the chat window.