com.frostwire.jlibtorrent

Class FileStorage

java.lang.Object

com.frostwire.jlibtorrent.FileStorage

public final class FileStorage
extends java.lang.Object

This class represents a file list and the piece size. Everything necessary to interpret a regular bittorrent storage file structure.

Field Summary

Fields

Modifier and Type	Field and Description
static file_flags_t	FLAG_EXECUTABLE This file is executable (sets the executable bit on posix like systems).
static file_flags_t	FLAG_HIDDEN This file is hidden (sets the hidden attribute on windows).
static file_flags_t	FLAG_PAD_FILE This file is a pad file.
static file_flags_t	FLAG_SYMLINK This file is a symlink.

Constructor Summary

Constructors

Constructor and Description
FileStorage(file_storage fs)

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String p, long size) Adds a file to the file storage.
void	addFile(java.lang.String path, long size, file_flags_t flags) Adds a file to the file storage.
void	addFile(java.lang.String path, long size, file_flags_t flags, int mtime) Adds a file to the file storage.
void	addFile(java.lang.String path, long size, file_flags_t flags, int mtime, java.lang.String symlink) Adds a file to the file storage.
boolean	fileAbsolutePath(int index) Returns true if the file at the specified index has been renamed to have an absolute path, i.e.
file_flags_t	fileFlags(int index) Returns a bitmask of flags from file_flags_t that apply to file at index.
int	fileIndexAtOffset(long offset) Returns the index of the file at the given offset in the torrent.
java.lang.String	fileName(int index) Returns only the name of the file, whereas filePath(int) returns the path (inside the torrent file) with the filename appended.
long	fileOffset(int index) returns the byte offset within the torrent file where this file starts.
java.lang.String	filePath(int index) Returns the full path to a file.
java.lang.String	filePath(int index, java.lang.String savePath) returns the full path to a file.
long	fileSize(int index) returns the size of a file.
Sha1Hash	hash(int index) Is a sha-1 hash of the file, or 0 if none was provided in the torrent file.
boolean	isValid() Returns true if the piece length has been initialized on the file_storage.
java.util.ArrayList<FileSlice>	mapBlock(int piece, long offset, int size) Returns a list of FileSlice objects representing the portions of files the specified piece index, byte offset and size range overlaps.
PeerRequest	mapFile(int file, long offset, int size) Returns a PeerRequest representing the piece index, byte offset and size the specified file range overlaps.
java.lang.String	name() Get the name of this torrent.
void	name(java.lang.String name) Set the name of this torrent.
int	numFiles() Returns the number of files in the file_storage.
int	numPieces() Returns the number of pieces in the torrent.
void	numPieces(int n) Set the number of pieces in the torrent.
boolean	padFileAt(int index) returns true if the file at the given index is a pad-file.
java.util.ArrayList<java.lang.String>	paths()
int	pieceLength() Get the size of each piece in this torrent.
void	pieceLength(int l) Set the size of each piece in this torrent.
int	pieceSize(int index) Returns the piece size of index.
void	renameFile(int index, java.lang.String newFilename) Renames the file at index to newFilename.
void	reserve(int numFiles) Allocates space for numFiles in the internal file list.
file_storage	swig()
torrent_info	ti() This methods returns the internal torrent info or null if it was constructed without one.
long	totalSize() Returns the total number of bytes all the files in this torrent spans.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_PAD_FILE

public static final file_flags_t FLAG_PAD_FILE

This file is a pad file. The creator of the torrent promises the file is entirely filled with zeroes and does not need to be downloaded. The purpose is just to align the next file to either a block or piece boundary.

FLAG_HIDDEN

public static final file_flags_t FLAG_HIDDEN

This file is hidden (sets the hidden attribute on windows).

FLAG_EXECUTABLE

public static final file_flags_t FLAG_EXECUTABLE

This file is executable (sets the executable bit on posix like systems).

FLAG_SYMLINK

public static final file_flags_t FLAG_SYMLINK

This file is a symlink. The symlink target is specified in a separate field

Constructor Detail

FileStorage

public FileStorage(file_storage fs)

Parameters:

fs - the native object

Method Detail

swig

public file_storage swig()

Returns:

the native object

ti

public torrent_info ti()

This methods returns the internal torrent info or null if it was constructed without one.

This also prevent premature garbage collection in case the storage was created from a torrent info.

Returns:

the pinned torrent info

isValid

public boolean isValid()

Returns true if the piece length has been initialized on the file_storage. This is typically taken as a proxy of whether the file_storage as a whole is initialized or not.

Returns:

true if valid

reserve

public void reserve(int numFiles)

Allocates space for numFiles in the internal file list. This can be used to avoid reallocating the internal file list when the number of files to be added is known up-front.

Parameters:

numFiles - the number of files

addFile

public void addFile(java.lang.String path,
                    long size,
                    file_flags_t flags,
                    int mtime,
                    java.lang.String symlink)

Adds a file to the file storage. The flags argument sets attributes on the file. The file attributes is an extension and may not work in all bittorrent clients.

If more files than one are added, certain restrictions to their paths apply. In a multi-file file storage (torrent), all files must share the same root directory.

That is, the first path element of all files must be the same. This shared path element is also set to the name of the torrent. It can be changed by calling name(String).

The built in functions to traverse a directory to add files will make sure this requirement is fulfilled.

Parameters:

path - the path

size - the file size

flags - the file flags

mtime - the time

symlink - the symlink

addFile

public void addFile(java.lang.String path,
                    long size,
                    file_flags_t flags,
                    int mtime)

Adds a file to the file storage. The flags argument sets attributes on the file. The file attributes is an extension and may not work in all bittorrent clients.

If more files than one are added, certain restrictions to their paths apply. In a multi-file file storage (torrent), all files must share the same root directory.

That is, the first path element of all files must be the same. This shared path element is also set to the name of the torrent. It can be changed by calling name(String).

The built in functions to traverse a directory to add files will make sure this requirement is fulfilled.

Parameters:

path - the path

size - the file size

flags - the file flags

mtime - the time

addFile

public void addFile(java.lang.String path,
                    long size,
                    file_flags_t flags)

Adds a file to the file storage. The flags argument sets attributes on the file. The file attributes is an extension and may not work in all bittorrent clients.

If more files than one are added, certain restrictions to their paths apply. In a multi-file file storage (torrent), all files must share the same root directory.

That is, the first path element of all files must be the same. This shared path element is also set to the name of the torrent. It can be changed by calling name(String).

The built in functions to traverse a directory to add files will make sure this requirement is fulfilled.

Parameters:

path - the path

size - the file size

flags - the file flags

addFile

public void addFile(java.lang.String p,
                    long size)

Adds a file to the file storage.

If more files than one are added, certain restrictions to their paths apply. In a multi-file file storage (torrent), all files must share the same root directory.

That is, the first path element of all files must be the same. This shared path element is also set to the name of the torrent. It can be changed by calling name(String).

The built in functions to traverse a directory to add files will make sure this requirement is fulfilled.

Parameters:

p -

size -

renameFile

public void renameFile(int index,
                       java.lang.String newFilename)

Renames the file at index to newFilename. Keep in mind that filenames are expected to be UTF-8 encoded.

Parameters:

index -

newFilename -

mapBlock

public java.util.ArrayList<FileSlice> mapBlock(int piece,
                                               long offset,
                                               int size)

Returns a list of FileSlice objects representing the portions of files the specified piece index, byte offset and size range overlaps.

This is the inverse mapping of mapFile(int, long, int).

Parameters:

piece -

offset -

size -

Returns:

mapFile

public PeerRequest mapFile(int file,
                           long offset,
                           int size)

Returns a PeerRequest representing the piece index, byte offset and size the specified file range overlaps. This is the inverse mapping of mapBlock(int, long, int).

Note that the PeerRequest return type is meant to hold bittorrent block requests, which may not be larger than 16 kiB. Mapping a range larger than that may return an overflown integer.

Parameters:

file -

offset -

size -

Returns:

numFiles

public int numFiles()

Returns the number of files in the file_storage.

Returns:

totalSize

public long totalSize()

Returns the total number of bytes all the files in this torrent spans.

Returns:

numPieces

public int numPieces()

Returns the number of pieces in the torrent.

Returns:

the number of pieces in the torrent

numPieces

public void numPieces(int n)

Set the number of pieces in the torrent.

Parameters:

n -

pieceLength

public int pieceLength()

Get the size of each piece in this torrent. This size is typically an even power of 2. It doesn't have to be though. It should be divisible by 16kiB however.

Returns:

pieceLength

public void pieceLength(int l)

Set the size of each piece in this torrent. This size is typically an even power of 2. It doesn't have to be though. It should be divisible by 16kiB however.

Parameters:

l -

pieceSize

public int pieceSize(int index)

Returns the piece size of index. This will be the same as pieceLength(), except for the last piece, which may be shorter.

Parameters:

index -

Returns:

name

public java.lang.String name()

Get the name of this torrent. For multi-file torrents, this is also the name of the root directory all the files are stored in.

Returns:

name

public void name(java.lang.String name)

Set the name of this torrent. For multi-file torrents, this is also the name of the root directory all the files are stored in.

Parameters:

name -

hash

public Sha1Hash hash(int index)

Is a sha-1 hash of the file, or 0 if none was provided in the torrent file. This can potentially be used to join a bittorrent network with other file sharing networks.

Parameters:

index -

Returns:

filePath

public java.lang.String filePath(int index,
                                 java.lang.String savePath)

returns the full path to a file.

Parameters:

index -

savePath -

Returns:

filePath

public java.lang.String filePath(int index)

Returns the full path to a file.

Parameters:

index - the file index

Returns:

the full path

fileName

public java.lang.String fileName(int index)

Returns only the name of the file, whereas filePath(int) returns the path (inside the torrent file) with the filename appended.

Parameters:

index - the file index

Returns:

the file name

fileSize

public long fileSize(int index)

returns the size of a file.

Parameters:

index -

Returns:

padFileAt

public boolean padFileAt(int index)

returns true if the file at the given index is a pad-file.

Parameters:

index -

Returns:

fileOffset

public long fileOffset(int index)

returns the byte offset within the torrent file where this file starts. It can be used to map the file to a piece index (given the piece size).

Parameters:

index -

Returns:

paths

public java.util.ArrayList<java.lang.String> paths()

Returns:

fileFlags

public file_flags_t fileFlags(int index)

Returns a bitmask of flags from file_flags_t that apply to file at index.

Parameters:

index -

Returns:

the flags

fileAbsolutePath

public boolean fileAbsolutePath(int index)

Returns true if the file at the specified index has been renamed to have an absolute path, i.e. is not anchored in the save path of the torrent.

Parameters:

index -

Returns:

fileIndexAtOffset

public int fileIndexAtOffset(long offset)

Returns the index of the file at the given offset in the torrent.

Parameters:

offset -

Returns: