包简介

talk with aria2

README 文档

README

Talking with aria2 through JSON-RPC

Install
Class Aria2
Docker Playground
Updates
Contributors

Install

1. Install aria2c

Make sure aria2c is running and rpc is enabled, You can add this into /etc/rc.local /usr/local/bin/aria2c --enable-rpc --rpc-allow-origin-all -c -D

Also See The Document of Aria2

2. Require Aria2.php

The codes just 82 lines but support all RPC methods. Using php's magic method __call

2.1 Install by composer

composer require daijie/aria2

2.2 Or copy Aria2.php

Class Aria2

Aria2 {
    __construct ( string $server [, string $token ] )
    __destruct ( void )
    __call(string $name, array $arg)
    public Object batch( [Callable $func ] )
    public bool inBatch( void )
    public array commit( void )
    protected string req ( array $data )
}

Usage

$aria2 = new Aria2('http://127.0.0.1:6800/jsonrpc'); 
// http://127.0.0.1:6800/jsonrpc is the default value, 
// equals to $aria2 = new Aria2
$aria2->getGlobalStat();
$aria2->tellActive();
$aria2->tellWaiting(0,1000);
$aria2->tellStopped(0,1000);
$aria2->addUri(
	['https://www.google.com.hk/images/srpr/logo3w.png'],
	['dir'=>'/tmp']
);
$aria2->tellStatus('1');
$aria2->removeDownloadResult('1');
//and more ...

Also See Manual of Aria2 RPC Interface To Get The Method List

.i.e, It's the example from Aria2 manual wrote in Python:

>>> import urllib2, json, base64
>>> metalink = base64.b64encode(open('file.meta4').read())
>>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
...                       'method':'aria2.addMetalink',
...                       'params':[metalink]})
>>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
>>> c.read()
'{"id":"qwer","jsonrpc":"2.0","result":["2089b05ecca3d829"]}'

If you are using php with php-aria2:

<?php
require 'vendor/autoload.php';
$metalink = file_get_contents('file.meta4');
$aria2 = new Aria2('http://localhost:6800/jsonrpc');
$c = $aria2->addMetalink($metalink);
#It means the method is aria2.addMetalink
print_r($c);

Batch requests

Now php-aria2 support JSON-RPC 2.0 Specification Batch requests In v1.2.0 batch requests have been introduced.

Aria2::batch - Start batch mode
Aria2::inBatch - Detect batch mode
Aria2::commit - End batch mode and commit commands

$aria2 = new Aria2('http://127.0.0.1:6800/jsonrpc');
$aria2->batch()
      ->getGlobalStat()
      ->tellActive()
      ->tellWaiting(0,1000)
      ->tellStopped(0,1000)
      ->addUri(
			['https://www.google.com.hk/images/srpr/logo3w.png'],
			['dir'=>'/tmp']
		)
		->commit();

Another ways is anonymous function, it also support method chaining. Don't forget commit.

$aria2 = new Aria2('http://aria2:6800/jsonrpc', "token:e6c3778f-6361-4ed0-b126-f2cf8fca06db");
$aria2->batch(function($aria2){
    $aria2->getGlobalStat();
    $aria2->system_listMethods();
});
$status = $aria2->commit();

System methods

system.multicall
system.listMethods
system.listNotifications

There are some system methods, you can call it using

Aria2::system_multicall
Aria2::system_listMethods
Aria2::system_listNotifications

php-aria2 convert _ to . automatically. If method name without a _, php-aria2 will auto prepend a aria2.

$aria2 = new Aria2('http://127.0.0.1:6800/jsonrpc');
$aria2->system_listMethods();
$aria2->getGlobalStat();

Example #1: Download File

$aria2->addUri(
	['https://www.google.com.hk/images/srpr/logo3w.png'],
	['dir'=>'/tmp']
);

More Options Here

Example #2: The Returned Data

Case: `Can't Download`

Array
(
    [id] => 1
    [jsonrpc] => 2.0
    [result] => Array
        (
            [completedLength] => 0
            [connections] => 0
            [dir] => /tmp
            [downloadSpeed] => 0
            [errorCode] => 1
            [files] => Array
                (
                    [0] => Array
                        (
                            [completedLength] => 0
                            [index] => 1
                            [length] => 0
                            [path] => 
                            [selected] => true
                            [uris] => Array
                                (
                                    [0] => Array
                                        (
                                            [status] => used
                                            [uri] => https://www.google.com.hk/images/srpr/logo3w.png
                                        )

                                )

                        )

                )
            [gid] => 2
            [numPieces] => 0
            [pieceLength] => 1048576
            [status] => error
            [totalLength] => 0
            [uploadLength] => 0
            [uploadSpeed] => 0
        )

)

Case: `Downloading (Active)`

Case: `Downloaded`

Docker Playground

require docker-compose

Docker playground: nginx (17 MB) + php7-fpm (82 MB) + aria2c (6 MB)

init playground

git clone https://github.com/shiny/php-aria2/
cd php-aria2/playground
docker-compose up

then open another terminal and enter playground

docker-compose exec php composer require daijie/aria2

for China user we suggest use the phpcomposer mirror

docker-compose exec php composer config repo.packagist composer https://packagist.phpcomposer.com
docker-compose exec php composer require daijie/aria2

After that, the playground structure:

├── aria2.conf # Aria2 conf file
├── data # Store downloaded file
├── docker-compose.yml
├── nginx.conf # nginx conf
└── www # Web dir
    ├── composer.json
    ├── composer.lock
    ├── index.php
    └── vendor
        ├── autoload.php
        ├── composer
        │   ├── ClassLoader.php
        │   ├── LICENSE
        │   ├── autoload_classmap.php
        │   ├── autoload_namespaces.php
        │   ├── autoload_psr4.php
        │   ├── autoload_real.php
        │   ├── autoload_static.php
        │   └── installed.json
        └── daijie
            └── aria2
                ├── Aria2.php
                ├── LICENSE.txt
                ├── README.md
                └── composer.json

Edit www/index.php and Open Browser To Visit http://127.0.0.1:8080

Updates

v1.2.1b

add batch anonymous function

v1.2.0b

Add system methods
Add batch mode

v1.1

Now support default token(secret) in php-aria2, compatible with v1.0

Before

$aria2 = new Aria2('http://aria2:6800/jsonrpc');
$aria2->addUri(
    "token:e6c3778f-6361-4ed0-b126-f2cf8fca06db",
    ['https://www.docker.com/sites/default/files/moby.svg']
);
$aria2->getGlobalStat("token:e6c3778f-6361-4ed0-b126-f2cf8fca06db");

After

$aria2 = new Aria2('http://aria2:6800/jsonrpc', "token:e6c3778f-6361-4ed0-b126-f2cf8fca06db");
$aria2->addUri(
    ['https://www.docker.com/sites/default/files/moby.svg']
);
$status = $aria2->getGlobalStat();

Contributors

Dai Jie daijie@php.net
Jon Skarpeteig

daijie/aria2 适用场景与选型建议

daijie/aria2 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 6.8k 次下载、GitHub Stars 达 73，最近一次更新时间为 2015 年 06 月 22 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「aria2」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 daijie/aria2 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 daijie/aria2 我们能提供哪些服务？

定制开发 / 二次开发

基于 daijie/aria2 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 daijie/aria2 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

viharm/php-aria2-rpc 3

A PHP library to interact with Aria2 download manager via the Aria2 RPC interface

daijie/aria2

包简介

关键字：

README 文档

README

Install

1. Install aria2c

2. Require Aria2.php

2.1 Install by composer

2.2 Or copy Aria2.php

Class Aria2

Usage

Also See Manual of Aria2 RPC Interface To Get The Method List

Batch requests

System methods

Example #1: Download File

Example #2: The Returned Data

Case: `Can't Download`

Case: `Downloading (Active)`

Case: `Downloaded`

Docker Playground

require docker-compose

init playground

After that, the playground structure:

Updates

v1.2.1b

v1.2.0b

v1.1

Contributors

daijie/aria2 适用场景与选型建议

与 daijie/aria2 相关的其它包

统计信息

GitHub 信息

其他信息

daijie/aria2

包简介

关键字：

README 文档

README

Install

1. Install aria2c

2. Require Aria2.php

2.1 Install by composer

2.2 Or copy Aria2.php

Class Aria2

Usage

Also See Manual of Aria2 RPC Interface To Get The Method List

Batch requests

System methods

Example #1: Download File

Example #2: The Returned Data

Case: Can't Download

Case: Downloading (Active)

Case: Downloaded

Docker Playground

require docker-compose

init playground

After that, the playground structure:

Updates

v1.2.1b

v1.2.0b

v1.1

Contributors

daijie/aria2 适用场景与选型建议

与 daijie/aria2 相关的其它包

统计信息

GitHub 信息

其他信息

Case: `Can't Download`

Case: `Downloading (Active)`

Case: `Downloaded`