2017-25 © Pedro Peláez
 

library seafile-php-sdk

This is a PHP package for accessing Seafile Web API

image

rsd/seafile-php-sdk

This is a PHP package for accessing Seafile Web API

  • Sunday, April 29, 2018
  • by rsdpkg
  • Repository
  • 5 Watchers
  • 16 Stars
  • 5,999 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 13 Forks
  • 3 Open issues
  • 13 Versions
  • 26 % Grown

The README.md

Seafile PHP SDK

This is a PHP package for accessing Seafile Web API., (*1)

German Web Application Developer Available for Hire!

No marketing skills whatsoever, but low rates, 20+ years of experience, and "german work attitude"., (*2)

Get in touch now: https://sdo.sh/#contact, (*3)

Unit tests License, (*4)

What is Seafile?

  • Open Source Cloud Storage for your teams and organizations
  • Built in File Encryption, better Protecting your Privacy
  • Collaboration around Files, file locking and other features make collaboration easy.

How to get Started

To get started with Seafile PHP SDK, you may either set up your own private Seafile server (see https://www.seafile.com/en/product/private_server/) or obtain a cloud account. Because the SDK is in its infancy it's highly recommended to set up a test server or create a test account., (*5)

It's not advisable yet to use your real server/account if you already got one., (*6)

After you have created your test account continue to the next step., (*7)

Roadmap and notes on development

Please note that this SDK currently is under active development and that things might change rather drastically., (*8)

If you are looking for stability please refer to stable tags., (*9)

Obtain API token

Please refer to the Seafile docs on how to obtain an API token., (*10)

This also applies to the token required for functional tests (TEST_SERVER_AUTHORIZATION_TOKEN)., (*11)

Installing Seafile-PHP-SDK

The recommended way to install seafile-php-sdk is through Composer., (*12)

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of seafile-php-sdk:, (*13)

composer.phar require rsd/seafile-php-sdk
# composer.phar dump-autoload -o # not required anymore

After installing, you need to require Composer's autoloader:, (*14)

require 'vendor/autoload.php';

You can then later update seafile-php-sdk using Composer:, (*15)

```bash composer.phar update, (*16)

composer.phar dump-autoload -o # not required anymore

```, (*17)

Using Seafile PHP SDK

~~Hint: Have a look at bin/example.php -- everything this SDK can do is covered there!~~, (*18)

Connecting to Seafile

First, you need to include the API token (see above):, (*19)

$client = new Client(
    [
        'base_uri' => 'https://your-seafile-server.example.com',
        'debug' => false,
        'headers' => [
            'Authorization' => 'Token ' . $token
        ]
    ]
);

List available libraries

$libraryResource = new Library($client);
$libs = $libraryResource->getAll();

foreach ($libs as $lib) {
    printf("Name: %s, ID: %s, is encrypted: %s\n", $lib->name, $lib->id, $lib->encrypted ? 'YES' : 'NO');
}

List directory contents

$directoryResource = new Directory($client);
$lib = $libraryResource->getById('some library ID of yours');
$items = $directoryResource->getAll($lib, '/'); // 2nd param is the name of the directory or '/' 

foreach ($items as $item) {
    printf("%s: %s (%d bytes)\n", $item->type, $item->name, $item->size);
}

Check if directory item exists

$parentDir = '/'; // DirectoryItem must exist within this directory
$directory = 'DirectoryName';
if($directoryResource->exists($lib, $directoryItemName, $parentDir) === false) {
 //  directory item does not exist
}

Be aware that because Seafile Web API does not provide a function to do this check on its own, all items of the directory will get loaded for iteration. So that's not very efficient., (*20)

Create directory

$parentDir = '/'; // Create directory within this folder
$directory = 'DirectoryName'; // name of the new Directory
$recursive = false; // recursive will create parentDir if not already existing
$success = $directoryResource->create($lib, $directory, $parentDir, $recursive);

Download file from unencrypted library

$dir = '/'; // dir in the library
$saveTo = '/tmp/'. $item->name; // save file to this local path
$fileResource = new File($client);
$downloadResponse = $fileResource->downloadFromDir($lib, $item, $saveTo, $dir);

Download file from encrypted library

Trying to download a file from an encrypted library without unlocking it first would inevitably fail, so just unlock (API docs say "decrypt") the library before attempting:, (*21)

$success = $libraryResource->decrypt($libId, ['query' => ['password' => $password]]);
// rest is the same as 'Download file from unencrypted library', see above

Upload file


$fileToUpload = '/path/to/file/to/be/uploaded.zip';
$dir = '/'; // directory in the library to save the file in
$response = $fileResource->upload($lib, $fileToUpload, $dir);
$uploadedFileId = (string)$response->getBody();

Update file

$response = $fileResource->update($lib, $newFilename, '/');
$updatedFileId = (string)$response->getBody();

Get file details

$directoryItem = $fileResource->getFileDetail($lib, '/' . basename($fullFilePath));

Get API user account info

$accountResource = new Account($client);

$accountType = $accountResource->getInfo();

print_r($accountType->toArray());

Get all accounts

$accountResource = new Account($client);

$accountTypes = $accountResource->getAll();

foreach ($accountTypes as $accountType) {
    print_r($accountType->toArray());
}

Create account

$newAccountType = (new AccountType)->fromArray([
    'email' => 'someone@example.com',
    'password' => 'password',
    'name' => 'Hugh Jazz',
    'note' => 'I will not waste chalk',
    'institution' => 'Duff Beer Inc.'
]);

$success = $accountResource->create($newAccountType);

Update account

$updateAccountType = (new AccountType)->fromArray([
    'name' => 'Divine Hugh Jazz',
    'email' => 'someone@example.com'
]);

$success = $accountResource->update($updateAccountType);

Get account info by email address

$accountResource = new Account($client);

$accountType = $accountResource->getByEmail('someone@example.com');

print_r($accountType->toArray());

Delete account

$accountResource = new Account($client);

$accountType = (new AccountType)->fromArray([
    'email' => 'someone@example.com'
]);

$success = $accountResource->remove($accountType);

or, (*22)

$accountResource = new Account($client);

$success = $accountResource->removeByEmail('someone@example.com');

Get avatar of an account

$accountType = (new AccountType)->fromArray([
   'email' => 'someone@example.com'
]);

$avatarResource = new Avatar($client);

print_r($avatarResource->getUserAvatar($accountType)->toArray());

or, (*23)

print_r($avatarResource->getUserAvatarByEmail('someone@example.com')->toArray());

$libraryResource = new Library($client);
$directoryResource = new Directory($client);
$fileResource = new File($client);
$shareLinkResource = new ShareLinks($client);

// create share link for a file
$expire = 5;
$p = "/" . basename($newFilename);
$password = 'qwertz123';

$defaultPermissions = new SharedLinkPermissions(SharedLinkPermissions::CAN_DOWNLOAD);
$extendedPermissions = new SharedLinkPermissions(SharedLinkPermissions::CAN_DOWNLOAD | SharedLinkPermissions::CAN_EDIT);

$shareLinkType = $shareLinkResource->create($lib, $p, $defaultPermissions, $expire, $password);

// remove shared link
$success = $shareLinkResource->remove($shareLinkType);

Get all starred files, star and unstar file

$libraryResource = new Library($client);
$starredFileResource = new StarredFile($client);

// get all starred files
$dirItems = $starredFileResource->getAll();

// unstar all starred files
foreach ($dirItems as $dirItem) {
    $lib = $libraryResource->getById($dirItem->repo);
    $starredFileResource->unstar($lib, $dirItem);
}

// re-star all files
foreach ($dirItems as $dirItem) {
    $lib = $libraryResource->getById($dirItem->repo);
    $starredFileResource->star($lib, $dirItem);
}

Debugging and how to enable logging of requests and responses

This example requires monolog. Log entries and Guzzle debug info will be written to stdout., (*24)

$logger = new Logger('Logger');

$stack = HandlerStack::create();
$stack->push(
    Middleware::log(
        $logger,
        new MessageFormatter("{hostname} {req_header_Authorization} - {req_header_User-Agent} - [{date_common_log}] \"{method} {host}{target} HTTP/{version}\" {code} {res_header_Content-Length} req_body: {req_body} response_body: {res_body}")
    )
);

$client = new Client(
    [
        'base_uri' => 'https://your-seafile-server.example.com',
        'debug' => true,
        'handler' => $stack,
        'headers' => [
            'Authorization' => 'Token ' . $token
        ]
    ]
);

Issues

  • File::upload(): Parameter $newFilename actually does not set a new file name when uploading a file (thanks to https://github.com/FlorientR)

Dependencies

  • PHP >=8.0 64 bits
  • Guzzle 7.2

Seafile Web API Support Matrix

Resource Web API Version Support grade
Account v2 ★★★☆
Avatar v2.1 ★★★★
Events v2 Yet to be done, contact me
File Share Link v2.1 ★★★☆
Group v2 ★☆☆☆
Library/Directory v2 ★★☆☆
Library/File v2 ★★☆☆
Library/Library v2 ★★☆☆
Library/Multiple Files v2 ★★★★
Organization v2 Yet to be done, contact me
Starred Files v2 ★★★★

Seafile server compatibility

Tested with:, (*25)

  • ~~Seafile Server 5.1.3 for generic Linux/Debian Jessie~~
  • ~~Seafile Server 5.1.3 for generic Linux/Debian Wheezy~~
  • ~~Seafile Server 5.1.4 for generic Linux/Ubuntu Xenial~~
  • ~~Seafile Server 6.0.3 for generic Linux/Ubuntu Xenial~~
  • Seafile Server 7.x+ for Ubuntu 20.04 LTS

Support

I'd be happy to implement new features for you at a competitive hourly rate. Get in touch now: https://sdo.sh/#contact, (*26)

Contributing

Please note that this package still is in its infancy. Only a part of the API has been implemented so far., (*27)

Pull requests are welcome. Please adhere to some very basic and simple principles:, (*28)

  • Follow "separation of concern" on all levels: 1 issue == 1 pull request. Do not cover multiple issues in a pull request.
  • Unit tests raise the chance of your pull request getting accepted.
  • The same goes for PHPDoc blocks.

Tests

There are two types of tests:, (*29)

  1. Unit tests that test a code unit without external dependencies and no data manipulation. Please always provide at least unit tests when contributing.
  2. Functional tests that run against a live server instance (=may have external dependencies) and also alter data. Disabled and thus skipped by default. Please refer to /phpunit/php in phpunit.xml.dist for information on how to enable functional tests.
  • https://seafile.com
  • https://download.seafile.com/published/seafile-manual/develop/web_api_v2.1.md
  • https://sdo.sh
  • https://luckycloud.de/de/ (Seafile server hosting in Germany)
  • https://www.yoursecurecloud.de/ (Seafile server hosting in Germany)

License

MIT © 2015-2023 Rene Schmidt DevOps UG (haftungsbeschränkt) & Co. KG, (*30)

The Versions

29/04 2018

dev-develop

dev-develop https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

by René Schmidt

php cloud sdk storage encrypted collaboration seafile

29/09 2017

dev-master

9999999-dev https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

by René Schmidt

php cloud sdk storage encrypted collaboration seafile

17/08 2017

dev-feature/SEAF-003

dev-feature/SEAF-003 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

by René Schmidt

php cloud sdk storage encrypted collaboration seafile

17/08 2017

dev-feature/SEAF-002

dev-feature/SEAF-002 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

by René Schmidt

php cloud sdk storage encrypted collaboration seafile

17/08 2017

dev-feature/SEAF-001

dev-feature/SEAF-001 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

by René Schmidt

php cloud sdk storage encrypted collaboration seafile

23/01 2017

v1.0.1

1.0.1.0 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

by René Schmidt

php cloud sdk storage encrypted collaboration seafile

16/01 2016

v1.0.0

1.0.0.0 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

php cloud sdk storage encrypted collaboration seafile

30/10 2015

dev-dev-stefanie

dev-dev-stefanie https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

php cloud sdk storage encrypted collaboration seafile

10/10 2015

v0.0.5

0.0.5.0 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

php cloud sdk storage encrypted collaboration seafile

10/10 2015

v0.0.4

0.0.4.0 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

php cloud sdk storage encrypted collaboration seafile

08/10 2015

v0.0.3

0.0.3.0 https://github.com/rene-s/Seafile-PHP-SDK

This is a PHP package for accessing Seafile Web API

  Sources   Download

MIT

The Requires

 

The Development Requires

php cloud sdk storage encrypted collaboration seafile

08/10 2015

0.0.2

0.0.2.0 http://example.com

  Sources   Download

proprietary

The Requires

 

The Development Requires

php cloud sdk storage encrypted collaboration seafile

08/10 2015

0.0.1

0.0.1.0 http://example.com

  Sources   Download

proprietary

The Requires

 

The Development Requires