README

PHP库，用于解码和编码BitTorrent BEncoded数据。

什么是BEncode？

Bencode（发音为B encode）是BitTorrent对等文件共享系统用于存储和传输松散结构化数据的编码。

它支持四种不同类型的值

• 字节字符串
• 整数
• 列表
• 字典（关联数组）

Bencoding最常用于种子文件。这些元数据文件只是bencoded字典。

虽然不如纯二进制编码高效，但bencoding简单，并且（因为数字以十进制文本编码）不受字节序的影响，这对于像BitTorrent这样的跨平台应用来说很重要。它也很灵活，只要应用程序忽略意外的字典键，就可以在不产生不兼容性的情况下添加新的键。

要求

Apache or Nginx = Latest production version
PHP >= 5.3.0

安装

在composer.json中添加此包并更新composer。

{
	"require": {
		"bhutanio/torrent-bencode": "dev-master"
	}
}

更新Composer

composer update或php composer.phar update

使用方法

使用Composer

	
	require 'vendor/autoload.php';

	$bcoder = new Bhutanio\BEncode;
	$bcoder->set([
		'announce'=>'http://www.private-tracker.com',
		'comment'=>'Downloaded from Private Tracker',
		'created_by'=>'PrivateTracker v1.0'
	]);

	// decode Torrent file
	$torrent = $bcoder->bdecode( File::get('AwesomeMovie.torrent'));
	print_r($torrent);

	// show Torrent contents
	$files = $bcoder->filelist( $torrent );
	print_r($files);
	
	// make Torrent private
	$torrent = $bcoder->make_private($torrent);
	print_r($torrent);

	$infohash = sha1($bcoder->bencode($torrent["info"]));
	$binhash = pack("H*", $bcoder->bencode($torrent["info"])));

不使用Composer

	require 'path/to/BEncode.php';

	// use above example

函数

/**
 * Data Setter
 * @param array $data [array of public variables]
 * eg:
 *  $bcoder = new \Bhutanio\BEncode;
 * 	$bcoder->set([
 *		'announce'=>'http://www.example.com',
 *		'comment'=>'Downloaded from example.com',
 *		'created_by'=>'TorrentSite v1.0'
 *	]);
 */
public function set($data=array()) {}

/**
 * Decode a torrent file into Bencoded data
 * @param  string  $s 	[link to torrent file]
 * @param  integer $pos [file position pointer]
 * @return array/null 	[Array of Bencoded data]
 * eg:
 * 		$bcoder = new \Bhutanio\BEncode;
 * 		$torrent = $bcoder->bdecode( File::get('MyAwesomeTorrent.torrent'));
 *  	var_dump($torrent);
 */
public function bdecode($s, &$pos=0) {}

/**
 * Created Torrent file from Bencoded data
 * @param  array $d [array data of a decoded torrent file]
 * @return string 	[data can be downloaded as torrent]
 */
public function bencode(&$d) {}

/**
 * Decode a torrent file into Bencoded data
 * @param  string $filename 	[File Path]
 * @return array/null 			[Array of Bencoded data]
 */
public function bdecode_file($filename) {}

/**
 * Generate list of files in a torrent
 * @param  array $data 	[array data of a decoded torrent file]
 * @return array 		[list of files in an array]
 */
public function filelist($data) {}

/**
 * Replace array data on Decoded torrent data so that it can be bencoded into a private torrent file.
 * Provide the custom data using $this->set();
 * @param  array $data 	[array data of a decoded torrent file]
 * @return array 		[array data for torrent file]
 */
public function make_private($data) {}