flysystem-hash's Introduction

Flysystem Plugin for generating hash value of file

NOTE: Plugins were removed in Flysystem 2.0 and thus this library is only available for Flysystem 1.x.

A plugin for the Flysystem file system abstraction library to generate hash values of a file. See hash_algos() function for supported hash algorithms.

Tested with Local and WebDav adapters, but as the hash is built directly from the stream resource it should work for all other adapters as well.

Installation

composer require emgag/flysystem-hash

Usage

use Emgag\Flysystem\Hash\HashPlugin;
use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem; 

$fs = new Filesystem(new Local(__DIR__));
$fs->addPlugin(new HashPlugin);

// sha256 is default
$sha256 = $fs->hash('file.txt');
$sha256 = $fs->hash('file.txt', 'sha256');
$md5    = $fs->hash('file.txt', 'md5');
$sha1   = $fs->hash('file.txt', 'sha1');

License

flysystem-hash is licensed under the MIT License.

flysystem-hash's People

Contributors

Stargazers

Watchers

flysystem-hash's Issues

Consider S3 md5 without streaming bytes

For your consideration.

When the adapter is S3 and the request checksum 'md5' the following snippets should work without downloading the actual bytes as S3 calculates an MD5 hash to be used as ETAG.

(from deep within our code)

private function getChecksum(AdapterInterface $adapter, string $path): ?string
    {
        switch (true) {
            case $adapter instanceof AwsS3Adapter:

                /** @var \Aws\Result $result */
                $result = $adapter->getClient()->headObject([
                    'Bucket' => $adapter->getBucket(),
                    'Key' => \trim($adapter->getPathPrefix(), '/') . $path,
                ]);

                return \trim($result->get('ETag'), '"');
                break;
            default:
                return null;
        }
    }