Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/verseles/flyclone
PHP wrapper for rclone. Supports Local disk, Dropbox, FTP, SFTP, Google Drive, MEGA, S3 (any compatible) and others. Progress support.
https://github.com/verseles/flyclone
cloudatlas disk dropbox flysystem hacktoberfest php php-wrapper rclone wrapper
Last synced: 4 days ago
JSON representation
PHP wrapper for rclone. Supports Local disk, Dropbox, FTP, SFTP, Google Drive, MEGA, S3 (any compatible) and others. Progress support.
- Host: GitHub
- URL: https://github.com/verseles/flyclone
- Owner: verseles
- License: other
- Created: 2020-06-02T03:19:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-10T05:50:42.000Z (8 months ago)
- Last Synced: 2024-03-16T23:43:02.058Z (8 months ago)
- Topics: cloudatlas, disk, dropbox, flysystem, hacktoberfest, php, php-wrapper, rclone, wrapper
- Language: PHP
- Homepage:
- Size: 228 KB
- Stars: 64
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Verseles\flyclone
PHP wrapper for [rclone](https://rclone.org/)
supports [local](https://rclone.org/local/) disk, [dropbox](https://rclone.org/dropbox/), [ftp](https://rclone.org/ftp/), [sftp](https://rclone.org/sftp/), [google drive](https://rclone.org/sftp/), [mega](https://rclone.org/mega/), [s3](https://rclone.org/s3/), [b2](https://rclone.org/b2/) ([any compatible](https://rclone.org/overview/)) and others can be easily added via pr.
progress support.
## installation
```shell script
composer require verseles/flyclone
```
## usage
list local files
```php
use Verseles\Flyclone\Rclone;
use Verseles\Flyclone\Providers\LocalProvider;
$left_side = new LocalProvider('mydisk'); // nickname
$rclone = new Rclone($left_side);
var_dump($rclone->ls('/home/')); // returns array
```
list files from mega server
```php
use Verseles\Flyclone\Rclone;
use Verseles\Flyclone\Providers\MegaProvider;
$left_side = new MegaProvider('myserver',[
'user'=>'[email protected]',
'pass'=> Rclone::obscure('applesux')
]);
$rclone = new Rclone($left_side);
var_dump($rclone->ls('/docs')); // returns array
```
copy from local disk to mega
```php
use Verseles\Flyclone\Rclone;
use Verseles\Flyclone\Providers\LocalProvider;
use Verseles\Flyclone\Providers\MegaProvider;
$left_side = new LocalProvider('mydisk'); // name
$right_side = new MegaProvider('myremote',[
'user'=>'[email protected]',
'pass'=> Rclone::obscure('4ppl35u*')
]);
$rclone = new Rclone($left_side, $right_side);
$rclone->copy('/home/appleinc/index.html', '/docs'); // always true, otherwise throws error
```
move from local disk to the same local disk
```php
use Verseles\Flyclone\Rclone;
use Verseles\Flyclone\Providers\LocalProvider;
$samedisk = new LocalProvider('mydisk'); // name
$rclone = new Rclone($samedisk);
$rclone->copy('/home/appleinc/index.html', '/home/www/'); // always true, otherwise throws error
```
copy to dropbox with progress every sec
```php
use Verseles\Flyclone\Rclone;
use Verseles\Flyclone\Providers\LocalProvider;
use Verseles\Flyclone\Providers\DropboxProvider;
$left_side = new LocalProvider('mydisk'); // nickname
$right_side = new DropboxProvider('myremote', [
'client_id' => 'your_dropbox_client_id',
'client_secret' => 'your_dropbox_client_secret',
'token' => 'your_dropbox_token',
]);
$rclone = new Rclone($left_side, $right_side);
$rclone->copy('/home/appleinc/index.html', '/home/www/', [], static function ($type, $buffer) use ($rclone) {
var_dump($rclone->getProgress());
});
```
## tips - read before use.
* of course, you need known how [rclone works](https://rclone.org/docs).
* rclone class and providers classes always support any flag listed at [rclone documentation](https://rclone.org/flags/), often as 3rd argument. but
* any flag, parameter or option passed like `--parameter-here`, in this lib is a array like `['parameter-here'='value', 'max-depth' => 3, 'any'=>'1']`
* if you inform only one provider (_'left side'_), in commands like `copy`/`move` we assume _'right side'_ as the same _'left side'_ provider. which means a copying/moving to the same disk.
* we don't have a great doc for now so open a issue always you have a doubt. remember to be descriptful.
## ~~wip~~ to-do
- [x] ~~add progress support~~
- [x] ~~add timeout support~~
- [x] ~~add more commands~~
- [x] ~~add tests~~
- [x] ~~use docker and docker compose for tests~~
- [ ] send meta details like file id in some storage system like google drive
## testing
install docker and docker compose, then run:
```shell
cp .env.example .env
make
```
> there are others tests (test_all, test_gdrive, etc), but you'll need fill `.env` file properly.
## contribution
> you know how to do that.
## license
[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](LICENSE.md)