Compare commits

..

No commits in common. "master" and "v0.3.2" have entirely different histories.

71 changed files with 3522 additions and 9038 deletions

View File

@ -1,266 +0,0 @@
name: CI
# Trigger the workflow on push or pull request, but only for the master branch
on:
pull_request:
branches: [master]
push:
branches: [master]
# This ensures that previous jobs for the PR are canceled when the PR is
# updated.
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref }}
cancel-in-progress: true
# Env vars for tests
env:
MINIO_ACCESS_KEY: minio
MINIO_SECRET_KEY: minio123
MINIO_LOCAL: 1
jobs:
ormolu:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: haskell-actions/run-ormolu@v15
with:
version: "0.5.0.1"
hlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: "Set up HLint"
uses: haskell-actions/hlint-setup@v2
with:
version: "3.5"
- name: "Run HLint"
uses: haskell-actions/hlint-run@v2
with:
path: '["src/", "test/", "examples"]'
fail-on: warning
cabal:
name: ${{ matrix.os }} / ghc-${{ matrix.ghc }} / cabal-${{ matrix.cabal }}
runs-on: ${{ matrix.os }}
needs: ormolu
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
cabal: ["3.8", "latest"]
ghc:
- "9.8"
- "9.6"
- "9.4"
- "9.2"
- "9.0"
- "8.10"
exclude:
# macos llvm issue for versions less than 9.2
- os: macos-latest
ghc: "8.10"
- os: macos-latest
ghc: "9.0"
# Cabal 3.8 supports GHC < 9.6
- cabal: "3.8"
ghc: "9.6"
- cabal: "3.8"
ghc: "9.8"
steps:
- uses: actions/checkout@v4
if: github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.ref == 'refs/heads/master'
- uses: haskell-actions/setup@v2
id: setup
name: Setup Haskell
with:
ghc-version: ${{ matrix.ghc }}
cabal-version: ${{ matrix.cabal }}
cabal-update: true
- name: Configure
run: |
cabal configure --enable-tests --enable-benchmarks --test-show-details=direct -fexamples -fdev -flive-test
cabal build all --dry-run
# The last step generates dist-newstyle/cache/plan.json for the cache key.
- name: Restore cached dependencies
uses: actions/cache/restore@v4
id: cache
env:
key: ${{ runner.os }}-ghc-${{ steps.setup.outputs.ghc-version }}-cabal-${{ steps.setup.outputs.cabal-version }}
with:
path: ${{ steps.setup.outputs.cabal-store }}
key: ${{ env.key }}-plan-${{ hashFiles('**/plan.json') }}
restore-keys: ${{ env.key }}-
- name: Install dependencies
# If we had an exact cache hit, the dependencies will be up to date.
if: steps.cache.outputs.cache-hit != 'true'
run: cabal build all --only-dependencies
# Cache dependencies already here, so that we do not have to rebuild them should the subsequent steps fail.
- name: Save cached dependencies
uses: actions/cache/save@v4
# If we had an exact cache hit, trying to save the cache would error because of key clash.
if: steps.cache.outputs.cache-hit != 'true'
with:
path: ${{ steps.setup.outputs.cabal-store }}
key: ${{ steps.cache.outputs.cache-primary-key }}
- name: Build
run: |
cabal build all
- name: Setup TLS certs for MinIO for testing (Linux)
if: matrix.os == 'ubuntu-latest'
run: |
mkdir -p /tmp/minio /tmp/minio-config/certs
cp test/cert/* /tmp/minio-config/certs/
(cd /tmp/minio; wget -q https://dl.min.io/server/minio/release/linux-amd64/minio; chmod +x ./minio)
sudo cp /tmp/minio-config/certs/public.crt /usr/local/share/ca-certificates/
sudo update-ca-certificates
## Currently disable TLS setup for MacOS due to issues in trusting it on MacOS.
- name: Setup TLS certs for MinIO for testing (MacOS)
if: matrix.os == 'macos-latest'
run: |
mkdir -p /tmp/minio /tmp/minio-config/certs
cp test/cert/* /tmp/minio-config/certs/
(cd /tmp/minio; wget -q https://dl.min.io/server/minio/release/darwin-amd64/minio; chmod +x ./minio)
# sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/minio-config/certs/public.crt
- name: Setup MinIO for testing (Windows)
if: matrix.os == 'windows-latest'
run: |
New-Item -ItemType Directory -Path "$env:temp/minio-config/certs/"
Copy-Item -Path test\cert\* -Destination "$env:temp/minio-config/certs/"
Invoke-WebRequest -Uri https://dl.minio.io/server/minio/release/windows-amd64/minio.exe -OutFile $HOME/minio.exe
Import-Certificate -FilePath "$env:temp/minio-config/certs/public.crt" -CertStoreLocation Cert:\LocalMachine\Root
- name: Test (Linux)
if: matrix.os == 'ubuntu-latest'
env:
MINIO_SECURE: 1
run: |
/tmp/minio/minio server --quiet --certs-dir /tmp/minio-config/certs data1 data2 data3 data4 2>&1 > minio.log &
ghc --version
cabal --version
cabal test all
- name: Test (MacOS)
if: matrix.os == 'macos-latest'
# # Leave MINIO_SECURE unset to disable TLS in tests.
# env:
# MINIO_SECURE: 1
run: |
/tmp/minio/minio server --quiet data1 data2 data3 data4 2>&1 > minio.log &
ghc --version
cabal --version
cabal test all
- name: Test (Windows)
if: matrix.os == 'windows-latest'
env:
MINIO_SECURE: 1
run: |
Start-Process -NoNewWindow -FilePath "$HOME/minio.exe" -ArgumentList "--certs-dir", "$env:temp/minio-config/certs", "server", "$env:temp/data1", "$env:temp/data2", "$env:temp/data3", "$env:temp/data4"
ghc --version
cabal --version
cabal test all
stack:
name: stack / ghc ${{ matrix.ghc }}
runs-on: ${{ matrix.os }}
env:
MINIO_SECURE: 1
strategy:
matrix:
ghc:
- "8.10.7"
- "9.0.2"
- "9.2.8"
- "9.4.8"
- "9.6.5"
- "9.8.2"
os: [ubuntu-latest]
steps:
- uses: actions/checkout@v4
if: github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.ref == 'refs/heads/master'
- uses: haskell-actions/setup@v2
with:
ghc-version: ${{ matrix.ghc }}
enable-stack: true
stack-version: "latest"
- uses: actions/cache@v4
name: Cache ~/.stack
with:
path: ~/.stack
key: ${{ runner.os }}-stack-global-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
restore-keys: |
${{ runner.os }}-stack-global-
- uses: actions/cache@v4
name: Cache .stack-work
with:
path: .stack-work
key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}-${{ hashFiles('**/*.hs') }}
restore-keys: |
${{ runner.os }}-stack-work-
- name: Install dependencies
run: |
stack --version
stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies
- name: Build
run: |
stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --flag minio-hs:examples --flag minio-hs:live-test --flag minio-hs:dev
- name: Setup MinIO for testing (Linux)
if: matrix.os == 'ubuntu-latest'
run: |
mkdir -p /tmp/minio /tmp/minio-config/certs
cp test/cert/* /tmp/minio-config/certs/
(cd /tmp/minio; wget -q https://dl.min.io/server/minio/release/linux-amd64/minio; chmod +x ./minio)
sudo cp /tmp/minio-config/certs/public.crt /usr/local/share/ca-certificates/
sudo update-ca-certificates
- name: Setup MinIO for testing (MacOS)
if: matrix.os == 'macos-latest'
run: |
mkdir -p /tmp/minio /tmp/minio-config/certs
cp test/cert/* /tmp/minio-config/certs/
(cd /tmp/minio; wget -q https://dl.min.io/server/minio/release/darwin-amd64/minio; chmod +x ./minio)
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/minio-config/certs/public.crt
- name: Setup MinIO for testing (Windows)
if: matrix.os == 'windows-latest'
run: |
New-Item -ItemType Directory -Path "$env:temp/minio-config/certs/"
Copy-Item -Path test\cert\* -Destination "$env:temp/minio-config/certs/"
Invoke-WebRequest -Uri https://dl.minio.io/server/minio/release/windows-amd64/minio.exe -OutFile $HOME/minio.exe
Import-Certificate -FilePath "$env:temp/minio-config/certs/public.crt" -CertStoreLocation Cert:\LocalMachine\Root
- name: Test (Non-Windows)
if: matrix.os != 'windows-latest'
run: |
/tmp/minio/minio server --quiet --certs-dir /tmp/minio-config/certs data1 data2 data3 data4 2>&1 > minio.log &
ghc --version
stack --version
stack test --system-ghc --flag minio-hs:live-test --flag minio-hs:dev
- name: Test (Windows)
if: matrix.os == 'windows-latest'
run: |
Start-Process -NoNewWindow -FilePath "$HOME/minio.exe" -ArgumentList "--certs-dir", "$env:temp/minio-config/certs", "server", "$env:temp/data1", "$env:temp/data2", "$env:temp/data3", "$env:temp/data4"
ghc --version
cabal --version
stack test --system-ghc --flag minio-hs:live-test --flag minio-hs:dev

1
.gitignore vendored
View File

@ -17,4 +17,3 @@ cabal.sandbox.config
*.eventlog *.eventlog
.stack-work/ .stack-work/
cabal.project.local cabal.project.local
*~

40
.travis.yml Normal file
View File

@ -0,0 +1,40 @@
# This is the simple Travis configuration, which is intended for use
# on applications which do not require cross-platform and
# multiple-GHC-version support. For more information and other
# options, see:
#
# https://docs.haskellstack.org/en/stable/travis_ci/
#
# Copy these contents into the root directory of your Github project in a file
# named .travis.yml
# Use new container infrastructure to enable caching
sudo: false
# Do not choose a language; we provide our own build tools.
language: generic
# Caching so the next build will be fast too.
cache:
directories:
- $HOME/.stack
# Ensure necessary system libraries are present
addons:
apt:
packages:
- libgmp-dev
before_install:
# Download and unpack the stack executable
- mkdir -p ~/.local/bin
- export PATH=$HOME/.local/bin:$PATH
- travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
install:
# Build dependencies
- stack --no-terminal --install-ghc test --only-dependencies
script:
# Build the package, its tests, and its docs and run the tests
- stack --no-terminal test --haddock --no-haddock-deps --test-arguments --num-threads=1

View File

@ -1,120 +1,6 @@
Changelog Changelog
========== ==========
## Version 1.7.0 -- Unreleased
* Fix data type `EventMessage` to not export partial fields (#179)
* Bump up min bound on time dep and fix deprecation warnings (#181)
* Add `dev` flag to cabal for building with warnings as errors (#182)
* Fix AWS region map (#185)
* Fix XML generator tests (#187)
* Add support for STS Assume Role API (#188)
### Breaking changes in 1.7.0
* `Credentials` type has been removed. Use `CredentialValue` instead.
* `Provider` type has been replaced with `CredentialLoader`.
* `EventMessage` data type is updated.
## Version 1.6.0
* HLint fixes - some types were changed to newtype (#173)
* Fix XML generation test for S3 SELECT (#161)
* Use region specific endpoints for AWS S3 in presigned Urls (#164)
* Replace protolude with relude and build with GHC 9.0.2 (#168)
* Support aeson 2 (#169)
* CI updates and code formatting changes with ormolu 0.5.0.0
## Version 1.5.3
* Fix windows build
* Fix support for Yandex Storage (#147)
* Fix for HEAD requests to S3/Minio (#155)
* Bump up some dependencies, new code formatting, Github CI, example fixes and other minor improvements.
## Version 1.5.2
* Fix region `us-west-2` for AWS S3 (#139)
* Build examples in CI
* Disable live-server tests by default, but run them in CI
* Drop support for GHC 8.2.x
## Version 1.5.1
* Add support for GHC 8.8
## Version 1.5.0
* Switch to faster map data type - all previous usage of
Data.Map.Strict and Data.Set is replaced with Data.HashMap.Strict
and Data.HashSet.
* Add `oiUserMetadata` to parse and return user metadata stored with
an object.
* Add `GetObjectResponse` data type for the value returned by
`getObject`. It now contains parsed ObjectInfo along with the
conduit of object bytes.
## Version 1.4.0
* Expose runMinioRes and runMinioResWith (#129)
* Improve Haddocks (#127)
* Fix list objects APIs to return directory prefixes when run with
recurse set to False (#126)
* Use streaming signature for streaming payloads when on an insecure
connection (#123)
## Version 1.3.1
* Add TLS helpers to check if server uses TLS, and to disable
certificate validation for easier testing (#121)
## Version 1.3.0
* Retry requests that timeout using full-jitter backoff (#119)
* Accept GetObjectOptions in statObject (#112)
* Add encryption options to GetObjectOptions and PutObjectOptions (#111)
* Add missing Haddock documentation (#110)
* Add support for S3Select API (#108)
* New travis with support for multiple GHCs (#106)
* Fix region setting in presigned url functions (#107)
## Version 1.2.0
* Export Provider and findFirst to look for credentials (#103)
## Version 1.1.0
This version brings the following changes:
* Adds experimental Admin APIs (#88, #91, #93, #94, #95, #100)
* Adds support for using Google Compute Storage service when S3
compatibility mode is enabled (#96, #99)
This version also brings some breaking changes (via #101):
* Adds IsString instance to load server address, and updates
initialization API to be more user friendly
* Drops usage of data-default package and exposes explicit default
values for various types used in the library.
## Version 1.0.1
This version brings the following (non-breaking) changes:
* Remove dependency on text-format (#86)
* Remove direct dependency on exceptions (#87)
* Adds lower-bounds on dependencies.
## Version 1.0.0
This new release changes the following APIs to add new capabilities:
* Copy Object API now supports more options for source and destination (#73)
* get/put Object functions now support a wider set of options via a
separate settings parameter (#71, #72)
* getBucketPolicy and setBucketPolicy APIs are added (#82)
* The library now uses UnliftIO (#83)
## Version 0.3.2 ## Version 0.3.2
This release brings the following changes: This release brings the following changes:
@ -133,7 +19,7 @@ This release brings the following changes:
This is a bug-fix release: This is a bug-fix release:
* Fix concurrency bug in `limitedMapConcurrently` (#53) * Fix concurrency bug in `limitedMapConcurrently` (#53)
* Fix tests related to listing incomplete uploads to accommodate MinIO * Fix tests related to listing incomplete uploads to accommodate Minio
server's changed behaviour to not list incomplete uploads. Note that server's changed behaviour to not list incomplete uploads. Note that
running these tests against AWS S3 are expected to fail. (#54) running these tests against AWS S3 are expected to fail. (#54)

1
CNAME
View File

@ -1 +0,0 @@
minio-hs.min.io

177
README.md
View File

@ -1,94 +1,64 @@
# MinIO Haskell Client SDK for Amazon S3 Compatible Cloud Storage [![CI](https://github.com/minio/minio-hs/actions/workflows/ci.yml/badge.svg)](https://github.com/minio/minio-hs/actions/workflows/ci.yml)[![Hackage](https://img.shields.io/hackage/v/minio-hs.svg)](https://hackage.haskell.org/package/minio-hs)[![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) # Minio Client SDK for Haskell [![Build Status](https://travis-ci.org/minio/minio-hs.svg?branch=master)](https://travis-ci.org/minio/minio-hs)[![Hackage](https://img.shields.io/hackage/v/minio-hs.svg)](https://hackage.haskell.org/package/minio-hs)[![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io)
The MinIO Haskell Client SDK provides simple APIs to access [MinIO](https://min.io) and any Amazon S3 compatible object storage. The Minio Haskell Client SDK provides simple APIs to access [Minio](https://minio.io) and Amazon S3 compatible object storage server.
This guide assumes that you have a working [Haskell development environment](https://www.haskell.org/downloads/). ## Minimum Requirements
- The Haskell [stack](https://docs.haskellstack.org/en/stable/README/)
## Installation ## Installation
### Add to your project ```sh
git clone https://github.com/minio/minio-hs.git
Simply add `minio-hs` to your project's `.cabal` dependencies section or if you are using hpack, to your `package.yaml` file as usual. cd minio-hs/
### Try it out in a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) stack install
#### For a cabal based environment
Download the library source and change to the extracted directory:
``` sh
$ cabal get minio-hs
$ cd minio-hs-1.6.0/ # directory name could be different
``` ```
Then load the `ghci` REPL environment with the library and browse the available APIs: Tests can be run with:
``` sh
$ cabal repl
ghci> :browse Network.Minio
```
#### For a stack based environment
From your home folder or any non-haskell project directory, just run:
```sh ```sh
stack install minio-hs
stack test
``` ```
Then start an interpreter session and browse the available APIs with: A section of the tests use the remote Minio Play server at
`https://play.minio.io:9000` by default. For library development,
using this remote server maybe slow. To run the tests against a
locally running Minio live server at `http://localhost:9000`, just set
the environment `MINIO_LOCAL` to any value (and unset it to switch
back to Play).
Documentation can be locally built with:
```sh ```sh
$ stack ghci
> :browse Network.Minio stack haddock
``` ```
## Examples ## Quick-Start Example - File Uploader
The [examples](https://github.com/minio/minio-hs/tree/master/examples) folder contains many examples that you can try out and use to learn and to help with developing your own projects.
### Quick-Start Example - File Uploader
This example program connects to a MinIO object storage server, makes a bucket on the server and then uploads a file to the bucket.
We will use the MinIO server running at https://play.min.io in this example. Feel free to use this service for testing and development. Access credentials are present in the library and are open to the public.
### FileUploader.hs ### FileUploader.hs
``` haskell ``` haskell
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs --package optparse-applicative --package filepath -- stack --resolver lts-8.5 runghc --package minio-hs --package optparse-applicative --package filepath
-- {-# Language OverloadedStrings, ScopedTypeVariables #-}
-- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc. import Network.Minio
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
import Control.Monad.Catch (catchIf)
{-# LANGUAGE OverloadedStrings #-} import Control.Monad.IO.Class (liftIO)
{-# LANGUAGE ScopedTypeVariables #-} import Data.Monoid ((<>))
import Network.Minio import Data.Text (pack)
import Options.Applicative
import Data.Monoid ((<>)) import Prelude
import Data.Text (pack) import System.FilePath.Posix
import Options.Applicative
import System.FilePath.Posix
import UnliftIO (throwIO, try)
import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -98,7 +68,7 @@ import Prelude
fileNameArgs :: Parser FilePath fileNameArgs :: Parser FilePath
fileNameArgs = strArgument fileNameArgs = strArgument
(metavar "FILENAME" (metavar "FILENAME"
<> help "Name of file to upload to AWS S3 or a MinIO server") <> help "Name of file to upload to AWS S3 or a Minio server")
cmdParser = info cmdParser = info
(helper <*> fileNameArgs) (helper <*> fileNameArgs)
@ -107,30 +77,27 @@ cmdParser = info
<> header <> header
"FileUploader - a simple file-uploader program using minio-hs") "FileUploader - a simple file-uploader program using minio-hs")
ignoreMinioErr :: ServiceErr -> Minio ()
ignoreMinioErr = return . const ()
main :: IO () main :: IO ()
main = do main = do
let bucket = "my-bucket" let bucket = "my-bucket"
-- Parse command line argument -- Parse command line argument, namely --filename.
filepath <- execParser cmdParser filepath <- execParser cmdParser
let object = pack $ takeBaseName filepath let object = pack $ takeBaseName filepath
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
-- Make a bucket; catch bucket already exists exception if thrown. -- Make a bucket; catch bucket already exists exception if thrown.
bErr <- try $ makeBucket bucket Nothing catchIf (== BucketAlreadyOwnedByYou) (makeBucket bucket Nothing) ignoreMinioErr
-- If the bucket already exists, we would get a specific -- Upload filepath to bucket; object is derived from filepath.
-- `ServiceErr` exception thrown. fPutObject bucket object filepath
case bErr of
Left BucketAlreadyOwnedByYou -> return ()
Left e -> throwIO e
Right _ -> return ()
-- Upload filepath to bucket; object name is derived from filepath.
fPutObject bucket object filepath defaultPutObjectOptions
case res of case res of
Left e -> putStrLn $ "file upload failed due to " ++ show e Left e -> putStrLn $ "file upload failed due to " ++ (show e)
Right () -> putStrLn "file upload succeeded." Right () -> putStrLn "file upload succeeded."
``` ```
@ -144,55 +111,3 @@ main = do
## Contribute ## Contribute
[Contributors Guide](https://github.com/minio/minio-hs/blob/master/CONTRIBUTING.md) [Contributors Guide](https://github.com/minio/minio-hs/blob/master/CONTRIBUTING.md)
### Development
#### Download the source
```sh
$ git clone https://github.com/minio/minio-hs.git
$ cd minio-hs/
```
#### Build the package:
With `cabal`:
```sh
$ # Configure cabal for development enabling all optional flags defined by the package.
$ cabal configure --enable-tests --test-show-details=direct -fexamples -fdev -flive-test
$ cabal build
```
With `stack`:
``` sh
$ stack build --test --no-run-tests --flag minio-hs:live-test --flag minio-hs:dev --flag minio-hs:examples
```
#### Running tests:
A section of the tests use the remote MinIO Play server at `https://play.min.io` by default. For library development, using this remote server maybe slow. To run the tests against a locally running MinIO live server at `http://localhost:9000` with the credentials `access_key=minio` and `secret_key=minio123`, just set the environment `MINIO_LOCAL` to any value (and unset it to switch back to Play).
With `cabal`:
```sh
$ export MINIO_LOCAL=1 # to run live tests against local MinIO server
$ cabal test
```
With `stack`:
``` sh
$ export MINIO_LOCAL=1 # to run live tests against local MinIO server
stack test --flag minio-hs:live-test --flag minio-hs:dev
```
This will run all the test suites.
#### Building documentation:
```sh
$ cabal haddock
$ # OR
$ stack haddock
```

18
examples/GetConfig.hs → Setup.hs Executable file → Normal file
View File

@ -1,8 +1,5 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -17,14 +14,5 @@
-- limitations under the License. -- limitations under the License.
-- --
import Network.Minio import Distribution.Simple
import Network.Minio.AdminAPI main = defaultMain
import Prelude
main :: IO ()
main = do
res <-
runMinio
minioPlayCI
getConfig
print res

View File

@ -1,8 +1,8 @@
# MinIO Haskell SDK API Reference # Minio Haskell SDK API Reference
## Initialize MinIO Client object. ## Initialize Minio Client object.
### MinIO - for public Play server ### Minio - for public Play server
```haskell ```haskell
minioPlayCI :: ConnectInfo minioPlayCI :: ConnectInfo
@ -20,20 +20,20 @@ awsCI { connectAccesskey = "your-access-key"
``` ```
| Bucket operations | Object Operations | Presigned Operations | |Bucket operations|Object Operations|Presigned Operations|
|:--------------------------------------------------|:----------------------------------------------|:--------------------------------------------------| |:---|:---|:---|
| [`listBuckets`](#listBuckets) | [`getObject`](#getObject) | [`presignedGetObjectUrl`](#presignedGetObjectUrl) | |[`listBuckets`](#listBuckets) |[`getObject`](#getObject)|[`presignedGetObjectUrl`](#presignedGetObjectUrl)|
| [`makeBucket`](#makeBucket) | [`putObject`](#putObject) | [`presignedPutObjectUrl`](#presignedPutObjectUrl) | |[`makeBucket`](#makeBucket)|[`putObject`](#putObject)|[`presignedPutObjectUrl`](#presignedPutObjectUrl)|
| [`removeBucket`](#removeBucket) | [`fGetObject`](#fGetObject) | [`presignedPostPolicy`](#presignedPostPolicy) | |[`removeBucket`](#removeBucket)|[`fGetObject`](#fGetObject)|[`presignedPostPolicy`](#presignedPostPolicy)|
| [`listObjects`](#listObjects) | [`fPutObject`](#fPutObject) | | |[`listObjects`](#listObjects)|[`fPutObject`](#fPutObject)||
| [`listObjectsV1`](#listObjectsV1) | [`copyObject`](#copyObject) | | |[`listObjectsV1`](#listObjectsV1)|[`copyObject`](#copyObject)||
| [`listIncompleteUploads`](#listIncompleteUploads) | [`removeObject`](#removeObject) | | |[`listIncompleteUploads`](#listIncompleteUploads)|[`removeObject`](#removeObject)||
| [`bucketExists`](#bucketExists) | [`selectObjectContent`](#selectObjectContent) | | |[`bucketExists`](#bucketExists)|||
## 1. Connecting and running operations on the storage service ## 1. Connecting and running operations on the storage service
The Haskell MinIO SDK provides high-level functionality to perform The Haskell Minio SDK provides high-level functionality to perform
operations on a MinIO server or any AWS S3-like API compatible storage operations on a Minio server or any AWS S3-like API compatible storage
service. service.
### The `ConnectInfo` type ### The `ConnectInfo` type
@ -69,42 +69,42 @@ enable/disable the automatic region discovery behaviour.
The parameters in the expression `awsWithRegion region autoDiscover` are: The parameters in the expression `awsWithRegion region autoDiscover` are:
| Parameter | Type | Description | |Parameter|Type|Description|
|:---------------|:----------------------------|:---------------------------------------------------------------------------------------------------------------------------| |:---|:---|:---|
| `region` | _Region_ (alias for `Text`) | The region to connect to by default for all requests. | | `region` | _Region_ (alias for `Text`) | The region to connect to by default for all requests. |
| `autoDiscover` | _Bool_ | If `True`, region discovery will be enabled. If `False`, discovery is disabled, and all requests go the given region only. | | `autoDiscover` | _Bool_ | If `True`, region discovery will be enabled. If `False`, discovery is disabled, and all requests go the given region only.|
#### minioPlayCI :: ConnectInfo #### minioPlayCI :: ConnectInfo
This constructor provides connection and authentication information to This constructor provides connection and authentication information to
connect to the public MinIO Play server at connect to the public Minio Play server at
`https://play.min.io/`. `https://play.minio.io:9000/`.
#### minioCI :: Text -> Int -> Bool -> ConnectInfo #### minioCI :: Text -> Int -> Bool -> ConnectInfo
Use to connect to a MinIO server. Use to connect to a Minio server.
The parameters in the expression `minioCI host port isSecure` are: The parameters in the expression `minioCI host port isSecure` are:
| Parameter | Type | Description | |Parameter|Type|Description|
|:-----------|:-------|:--------------------------------------------------------| |:---|:---|:---|
| `host` | _Text_ | Hostname of the MinIO or other S3-API compatible server | | `host` | _Text_ | Hostname of the Minio or other S3-API compatible server |
| `port` | _Int_ | Port number to connect to | | `port` | _Int_ | Port number to connect to|
| `isSecure` | _Bool_ | Does the server use HTTPS? | | `isSecure` | _Bool_ | Does the server use HTTPS? |
#### The ConnectInfo fields and Default instance #### The ConnectInfo fields and Default instance
The following table shows the fields in the `ConnectInfo` record-type: The following table shows the fields in the `ConnectInfo` record-type:
| Field | Type | Description | | Field | Type | Description |
|:----------------------------|:----------------------------|:--------------------------------------------------------------------------------------------------| |:---|:---|:---|
| `connectHost` | _Text_ | Host name of the server. Defaults to `localhost`. | | `connectHost` | _Text_ | Host name of the server. Defaults to `localhost`. |
| `connectPort` | _Int_ | Port number on which the server listens. Defaults to `9000`. | | `connectPort` | _Int_ | Port number on which the server listens. Defaults to `9000`. |
| `connectAccessKey` | _Text_ | Access key to use in authentication. Defaults to `minio`. | | `connectAccessKey` | _Text_ | Access key to use in authentication. Defaults to `minio`. |
| `connectSecretkey` | _Text_ | Secret key to use in authentication. Defaults to `minio123`. | | `connectSecretkey` | _Text_ | Secret key to use in authentication. Defaults to `minio123`. |
| `connectIsSecure` | _Bool_ | Specifies if the server used TLS. Defaults to `False` | | `connectIsSecure` | _Bool_ | Specifies if the server used TLS. Defaults to `False` |
| `connectRegion` | _Region_ (alias for `Text`) | Specifies the region to use. Defaults to 'us-east-1' | | `connectRegion` | _Region_ (alias for `Text`) | Specifies the region to use. Defaults to 'us-east-1' |
| `connectAutoDiscoverRegion` | _Bool_ | Specifies if the library should automatically discover the region of a bucket. Defaults to `True` | | `connectAutoDiscoverRegion` | _Bool_ | Specifies if the library should automatically discover the region of a bucket. Defaults to `True`|
The `def` value of type `ConnectInfo` has all the above default The `def` value of type `ConnectInfo` has all the above default
values. values.
@ -112,7 +112,7 @@ values.
### The Minio Monad ### The Minio Monad
This monad provides the required environment to perform requests This monad provides the required environment to perform requests
against a MinIO or other S3 API compatible server. It uses the against a Minio or other S3 API compatible server. It uses the
connection information from the `ConnectInfo` value provided to it. It connection information from the `ConnectInfo` value provided to it. It
performs connection pooling, bucket location caching, error handling performs connection pooling, bucket location caching, error handling
and resource clean-up actions. and resource clean-up actions.
@ -148,17 +148,17 @@ Lists buckets.
__Return Value__ __Return Value__
| Return type | Description | |Return type |Description |
|:---------------------|:----------------| |:---|:---|
| _Minio [BucketInfo]_ | List of buckets | | _Minio [BucketInfo]_| List of buckets |
__BucketInfo record type__ __BucketInfo record type__
| Field | Type | Description | |Field |Type |Description |
|:-----------------|:---------------------------|:----------------------------| |:---|:---| :---|
| `biName` | _Bucket_ (alias of `Text`) | Name of the bucket | | `biName` | _Bucket_ (alias of `Text`) | Name of the bucket |
| `biCreationDate` | _UTCTime_ | Creation time of the bucket | | `biCreationDate` | _UTCTime_ | Creation time of the bucket |
<a name="makeBucket"></a> <a name="makeBucket"></a>
@ -171,10 +171,10 @@ __Parameters__
In the expression `makeBucket bucketName region` the arguments are: In the expression `makeBucket bucketName region` the arguments are:
| Param | Type | Description | | Param | Type | Description |
|--------------|-----------------------------|-----------------------------------------------------------------------------------------------------| |---|---|---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | |`bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `region` | _Maybe Region_ | Region where the bucket is to be created. If not specified, default to the region in `ConnectInfo`. | | `region` | _Maybe Region_ | Region where the bucket is to be created. If not specified, default to the region in `ConnectInfo`.|
__Example__ __Example__
@ -185,6 +185,7 @@ main :: IO ()
main = do main = do
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
makeBucket bucketName (Just "us-east-1") makeBucket bucketName (Just "us-east-1")
case res of case res of
Left err -> putStrLn $ "Failed to make bucket: " ++ (show res) Left err -> putStrLn $ "Failed to make bucket: " ++ (show res)
Right _ -> putStrLn $ "makeBucket successful." Right _ -> putStrLn $ "makeBucket successful."
@ -200,9 +201,9 @@ __Parameters__
In the expression `removeBucket bucketName` the arguments are: In the expression `removeBucket bucketName` the arguments are:
| Param | Type | Description | | Param | Type | Description |
|--------------|-----------------------------|--------------------| |---|---|---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | |`bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
__Example__ __Example__
@ -224,7 +225,7 @@ main = do
<a name="listObjects"></a> <a name="listObjects"></a>
### listObjects :: Bucket -> Maybe Text -> Bool -> C.ConduitM () ObjectInfo Minio () ### listObjects :: Bucket -> Maybe Text -> Bool -> C.Producer Minio ObjectInfo
List objects in the given bucket, implements version 2 of AWS S3 API. List objects in the given bucket, implements version 2 of AWS S3 API.
@ -233,44 +234,34 @@ __Parameters__
In the expression `listObjects bucketName prefix recursive` the In the expression `listObjects bucketName prefix recursive` the
arguments are: arguments are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have | | `prefix` | _Maybe Text_ | Optional prefix that listed objects should have |
| `recursive` | _Bool_ | `True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. | | `recursive` | _Bool_ |`True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. |
__Return Value__ __Return Value__
| Return type | Description | |Return type |Description |
|:------------------------------------|:------------------------------------------------------------------------| |:---|:---|
| _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. | | _C.Producer Minio ObjectInfo_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. |
__ObjectInfo record type__ __ObjectInfo record type__
| Field | Type | Description | |Field |Type |Description |
|:-------------|:----------------------------|:-------------------------------------| |:---|:---| :---|
| `oiObject` | _Object_ (alias for `Text`) | Name of object | |`oiObject` | _Object_ (alias for `Text`) | Name of object |
| `oiModTime` | _UTCTime_ | Last modified time of the object | |`oiModTime` | _UTCTime_ | Last modified time of the object |
| `oiETag` | _ETag_ (alias for `Text`) | ETag of the object | |`oiETag` | _ETag_ (alias for `Text`) | ETag of the object |
| `oiSize` | _Int64_ | Size of the object in bytes | |`oiSize` | _Int64_ | Size of the object in bytes |
| `oiMetadata` | _HashMap Text Text_ | Map of key-value user-metadata pairs |
__Example__ __Example__
``` haskell ``` haskell
{-# LANGUAGE OverloadedStrings #-} {-# Language OverloadedStrings #-}
import Network.Minio
import Conduit import Data.Conduit (($$))
import Prelude import Conduit.Combinators (sinkList)
-- | The following example uses MinIO play server at
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
@ -278,14 +269,15 @@ main = do
bucket = "test" bucket = "test"
-- Performs a recursive listing of all objects under bucket "test" -- Performs a recursive listing of all objects under bucket "test"
-- on play.min.io. -- on play.minio.io.
res <- runMinio minioPlayCI $ res <- runMinio minioPlayCI $ do
runConduit $ listObjects bucket Nothing True .| mapM_C (\v -> (liftIO $ print v)) listObjects bucket Nothing True $$ sinkList
print res print res
``` ```
<a name="listObjectsV1"></a> <a name="listObjectsV1"></a>
### listObjectsV1 :: Bucket -> Maybe Text -> Bool -> C.ConduitM () ObjectInfo Minio () ### listObjectsV1 :: Bucket -> Maybe Text -> Bool -> C.Producer Minio ObjectInfo
List objects in the given bucket, implements version 1 of AWS S3 API. This API List objects in the given bucket, implements version 1 of AWS S3 API. This API
is provided for legacy S3 compatible object storage endpoints. is provided for legacy S3 compatible object storage endpoints.
@ -295,43 +287,34 @@ __Parameters__
In the expression `listObjectsV1 bucketName prefix recursive` the In the expression `listObjectsV1 bucketName prefix recursive` the
arguments are: arguments are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have | | `prefix` | _Maybe Text_ | Optional prefix that listed objects should have |
| `recursive` | _Bool_ | `True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. | | `recursive` | _Bool_ |`True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. |
__Return Value__ __Return Value__
| Return type | Description | |Return type |Description |
|:------------------------------------|:------------------------------------------------------------------------| |:---|:---|
| _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. | | _C.Producer Minio ObjectInfo_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. |
__ObjectInfo record type__ __ObjectInfo record type__
| Field | Type | Description | |Field |Type |Description |
|:------------|:----------------------------|:---------------------------------| |:---|:---| :---|
| `oiObject` | _Object_ (alias for `Text`) | Name of object | |`oiObject` | _Object_ (alias for `Text`) | Name of object |
| `oiModTime` | _UTCTime_ | Last modified time of the object | |`oiModTime` | _UTCTime_ | Last modified time of the object |
| `oiETag` | _ETag_ (alias for `Text`) | ETag of the object | |`oiETag` | _ETag_ (alias for `Text`) | ETag of the object |
| `oiSize` | _Int64_ | Size of the object in bytes | |`oiSize` | _Int64_ | Size of the object in bytes |
__Example__ __Example__
``` haskell ``` haskell
{-# LANGUAGE OverloadedStrings #-} {-# Language OverloadedStrings #-}
import Network.Minio
import Conduit import Data.Conduit (($$))
import Prelude import Conduit.Combinators (sinkList)
-- | The following example uses MinIO play server at
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
@ -339,10 +322,11 @@ main = do
bucket = "test" bucket = "test"
-- Performs a recursive listing of all objects under bucket "test" -- Performs a recursive listing of all objects under bucket "test"
-- on play.min.io. -- on play.minio.io.
res <- runMinio minioPlayCI $ res <- runMinio minioPlayCI $ do
runConduit $ listObjectsV1 bucket Nothing True .| mapM_C (\v -> (liftIO $ print v)) listObjectsV1 bucket Nothing True $$ sinkList
print res print res
``` ```
<a name="listIncompleteUploads"></a> <a name="listIncompleteUploads"></a>
@ -355,51 +339,43 @@ __Parameters__
In the expression `listIncompleteUploads bucketName prefix recursive` In the expression `listIncompleteUploads bucketName prefix recursive`
the parameters are: the parameters are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have. | | `prefix` | _Maybe Text_ | Optional prefix that listed objects should have. |
| `recursive` | _Bool_ | `True` indicates recursive style listing and `Talse` indicates directory style listing delimited by '/'. | | `recursive` | _Bool_ |`True` indicates recursive style listing and `Talse` indicates directory style listing delimited by '/'. |
__Return Value__ __Return Value__
|Return type |Description | |Return type |Description |
|:---|:---| |:---|:---|
| _C.ConduitM () UploadInfo Minio ()_ | A Conduit Producer of `UploadInfo` values corresponding to each incomplete multipart upload | | _C.Producer Minio UploadInfo_ | A Conduit Producer of `UploadInfo` values corresponding to each incomplete multipart upload |
__UploadInfo record type__ __UploadInfo record type__
| Field | Type | Description | |Field |Type |Description |
|:-------------|:---------|:------------------------------------------| |:---|:---| :---|
| `uiKey` | _Object_ | Name of incompletely uploaded object | |`uiKey` | _Object_ |Name of incompletely uploaded object |
| `uiUploadId` | _String_ | Upload ID of incompletely uploaded object | |`uiUploadId` | _String_ |Upload ID of incompletely uploaded object |
| `uiSize` | _Int64_ | Size of incompletely uploaded object | |`uiSize` | _Int64_ |Size of incompletely uploaded object |
__Example__ __Example__
```haskell ```haskell
{-# LANGUAGE OverloadedStrings #-} {-# Language OverloadedStrings #-}
import Network.Minio
import Conduit import Data.Conduit (($$))
import Prelude import Conduit.Combinators (sinkList)
-- | The following example uses MinIO play server at
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let let
bucket = "test" bucket = "test"
-- Performs a recursive listing of incomplete uploads under bucket "test" -- Performs a recursive listing of all incompletely uploaded objects
-- on a local MinIO server. -- under bucket "test" on play.minio.io.
res <- runMinio minioPlayCI $ res <- runMinio minioPlayCI $ do
runConduit $ listIncompleteUploads bucket Nothing True .| mapM_C (\v -> (liftIO $ print v)) listIncompleteUploads bucket Nothing True $$ sinkList
print res print res
``` ```
@ -407,126 +383,97 @@ main = do
## 3. Object operations ## 3. Object operations
<a name="getObject"></a> <a name="getObject"></a>
### getObject :: Bucket -> Object -> GetObjectOptions -> Minio (C.ConduitM () ByteString Minio ()) ### getObject :: Bucket -> Object -> Minio (C.ResumableSource Minio ByteString)
Get an object from the S3 service, optionally object ranges can be provided as well. Get an object from the service.
__Parameters__ __Parameters__
In the expression `getObject bucketName objectName opts` the parameters In the expression `getObject bucketName objectName` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:----------------------------------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range |
__GetObjectOptions record type__
| Field | Type | Description |
|:-----------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------|
| `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object |
| `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match |
| `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match |
| `gooIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since object wasn't modified |
| `gooIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since object was modified |
__Return Value__ __Return Value__
The return value can be incrementally read to process the contents of The return value can be incrementally read to process the contents of
the object. the object.
| Return type | Description | |Return type |Description |
|:--------------------------------------------|:-----------------------------------------| |:---|:---|
| _Minio (C.ConduitM () ByteString Minio ())_ | A Conduit source of `ByteString` values. | | _C.ResumableSource Minio ByteString_ | A Conduit ResumableSource of `ByteString` values. |
__Example__ __Example__
```haskell ```haskell
{-# LANGUAGE OverloadedStrings #-} {-# Language OverloadedStrings #-}
import Network.Minio
import qualified Data.Conduit as C import Network.Minio
import qualified Data.Conduit.Binary as CB import Data.Conduit (($$+-))
import Data.Conduit.Binary (sinkLbs)
import Prelude import qualified Data.ByteString.Lazy as LB
-- | The following example uses MinIO play server at
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let let
bucket = "my-bucket" bucket = "mybucket"
object = "my-object" object = "myobject"
res <- runMinio minioPlayCI $ do
src <- getObject bucket object def
C.connect src $ CB.sinkFileCautious "/tmp/my-object"
case res of -- Lists the parts in an incompletely uploaded object identified by
Left e -> putStrLn $ "getObject failed." ++ (show e) -- bucket, object and upload ID.
Right _ -> putStrLn "getObject succeeded." res <- runMinio minioPlayCI $ do
source <- getObject bucket object
source $$+- sinkLbs
-- the following the prints the contents of the object.
putStrLn $ either
(("Failed to getObject: " ++) . show)
(("Read an object of length: " ++) . show . LB.length)
res
``` ```
<a name="putObject"></a> <a name="putObject"></a>
### putObject :: Bucket -> Object -> C.ConduitM () ByteString Minio () -> Maybe Int64 -> PutObjectOptions -> Minio () ### putObject :: Bucket -> Object -> C.Producer Minio ByteString -> Maybe Int64 -> Minio ()
Uploads an object to a bucket in the service, from the given input Uploads an object to a bucket in the service, from the given input
byte stream of optionally supplied length. Optionally you can also specify byte stream of optionally supplied length
additional metadata for the object.
__Parameters__ __Parameters__
In the expression `putObject bucketName objectName inputSrc` the parameters In the expression `putObject bucketName objectName inputSrc` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:------------------------------------|:------------------------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputSrc` | _C.ConduitM () ByteString Minio ()_ | A Conduit producer of `ByteString` values | | `inputSrc` | _C.Producer Minio ByteString_ | A Conduit Producer of `ByteString` values |
| `size` | _Int64_ | Provide stream size (optional) |
| `opts` | _PutObjectOptions_ | Optional parameters to provide additional metadata for the object |
__Example__ __Example__
```haskell ```haskell
{-# LANGUAGE OverloadedStrings #-} {-# Language OverloadedStrings #-}
import Network.Minio import Network.Minio
import qualified Data.Conduit.Combinators as CC import qualified Data.Conduit.Combinators as CC
import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let let
bucket = "test" bucket = "mybucket"
object = "obj" object = "myobject"
localFile = "/etc/lsb-release" kb15 = 15 * 1024
kb15 = 15 * 1024
res <- runMinio minioPlayCI $ do
putObject bucket object (CC.repeat "a") (Just kb15)
-- Eg 1. Upload a stream of repeating "a" using putObject with default options.
res <- runMinio minioPlayCI $
putObject bucket object (CC.repeat "a") (Just kb15) def
case res of case res of
Left e -> putStrLn $ "putObject failed." ++ show e Left e -> putStrLn $ "Failed to putObject " ++ show bucket ++ "/" ++ show object
Right () -> putStrLn "putObject succeeded." Right _ -> putStrLn "PutObject was successful"
``` ```
<a name="fGetObject"></a> <a name="fGetObject"></a>
### fGetObject :: Bucket -> Object -> FilePath -> GetObjectOptions -> Minio () ### fGetObject :: Bucket -> Object -> FilePath -> Minio ()
Downloads an object from a bucket in the service, to the given file Downloads an object from a bucket in the service, to the given file
__Parameters__ __Parameters__
@ -534,23 +481,11 @@ __Parameters__
In the expression `fGetObject bucketName objectName inputFile` the parameters In the expression `fGetObject bucketName objectName inputFile` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:----------------------------------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputFile` | _FilePath_ | Path to the file to be uploaded | | `inputFile` | _FilePath_ | Path to the file to be uploaded |
| `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range |
__GetObjectOptions record type__
| Field | Type | Description |
|:-----------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------|
| `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object |
| `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match |
| `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match |
| `gooIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since object wasn't modified |
| `gooIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since object was modified |
``` haskell ``` haskell
@ -561,8 +496,8 @@ import Data.Conduit (($$+-))
import Data.Conduit.Binary (sinkLbs) import Data.Conduit.Binary (sinkLbs)
import Prelude import Prelude
-- | The following example uses MinIO play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -576,7 +511,7 @@ main = do
localFile = "/etc/lsb-release" localFile = "/etc/lsb-release"
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
src <- fGetObject bucket object localFile def src <- fGetObject bucket object localFile
(src $$+- sinkLbs) (src $$+- sinkLbs)
case res of case res of
@ -593,11 +528,11 @@ __Parameters__
In the expression `fPutObject bucketName objectName inputFile` the parameters In the expression `fPutObject bucketName objectName inputFile` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:--------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputFile` | _FilePath_ | Path to the file to be uploaded | | `inputFile` | _FilePath_ | Path to the file to be uploaded |
__Example__ __Example__
@ -622,38 +557,31 @@ main = do
``` ```
<a name="copyObject"></a> <a name="copyObject"></a>
### copyObject :: DestinationInfo -> SourceInfo -> Minio () ### copyObject :: Bucket -> Object -> CopyPartSource -> Minio ()
Copies content of an object from the service to another Copies content of an object from the service to another
__Parameters__ __Parameters__
In the expression `copyObject dstInfo srcInfo` the parameters In the expression `copyObject bucketName objectName cps` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:----------|:------------------|:----------------------------------------------------------| |:---|:---| :---|
| `dstInfo` | _DestinationInfo_ | A value representing properties of the destination object | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `srcInfo` | _SourceInfo_ | A value representing properties of the source object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `cps` | _CopyPartSource_ | A value representing properties of the source object |
__SourceInfo record type__ __CopyPartSource record type__
| Field | Type | Description | |Field |Type |Description |
|:-----------------------|:-----------------------|:----------------------------------------------------------------------------------------------------------| |:---|:---| :---|
| `srcBucket` | `Bucket` | Name of source bucket | | `cpSource` | `Text`| Name of source object formatted as "/srcBucket/srcObject" |
| `srcObject` | `Object` | Name of source object | | `cpSourceRange` | `Maybe (Int64, Int64)` | Represents the byte range of source object. (0, 9) represents first ten bytes of source object|
| `srcRange` | `Maybe (Int64, Int64)` | (Optional) Represents the byte range of source object. (0, 9) represents first ten bytes of source object | | `cpSourceIfMatch` | `Maybe Text` | (Optional) ETag source object should match |
| `srcIfMatch` | `Maybe Text` | (Optional) ETag source object should match | | `cpSourceIfNoneMatch` | `Maybe Text` | (Optional) ETag source object shouldn't match |
| `srcIfNoneMatch` | `Maybe Text` | (Optional) ETag source object shouldn't match | | `cpSourceIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since source object wasn't modified |
| `srcIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since source object wasn't modified | | `cpSourceIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since source object was modified |
| `srcIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since source object was modified |
__Destination record type__
| Field | Type | Description |
|:------------|:---------|:-----------------------------------------------------|
| `dstBucket` | `Bucket` | Name of destination bucket in server-side copyObject |
| `dstObject` | `Object` | Name of destination object in server-side copyObject |
__Example__ __Example__
@ -666,13 +594,13 @@ main = do
let let
bucket = "mybucket" bucket = "mybucket"
object = "myobject" object = "myobject"
objectCopy = "obj-copy" srcObject = "/mybucket/srcObject"
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
copyObject def { dstBucket = bucket, dstObject = objectCopy } def { srcBucket = bucket, srcObject = object } copyObject bucket object def { cpSource = srcObject }
case res of case res of
Left e -> putStrLn $ "Failed to copyObject " ++ show bucket ++ show "/" ++ show object Left e -> putStrLn $ "Failed to copyObject " ++ show srcObject"
Right _ -> putStrLn "copyObject was successful" Right _ -> putStrLn "copyObject was successful"
``` ```
@ -685,10 +613,10 @@ __Parameters__
In the expression `removeObject bucketName objectName` the parameters In the expression `removeObject bucketName objectName` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:-------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
__Example__ __Example__
@ -719,10 +647,10 @@ __Parameters__
In the expression `removeIncompleteUpload bucketName objectName` the parameters In the expression `removeIncompleteUpload bucketName objectName` the parameters
are: are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:-------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
__Example__ __Example__
@ -744,59 +672,6 @@ main = do
Right _ -> putStrLn "Removed incomplete upload successfully" Right _ -> putStrLn "Removed incomplete upload successfully"
``` ```
<a name="selectObjectContent"></a>
### selectObjectContent :: Bucket -> Object -> SelectRequest -> Minio (ConduitT () EventMessage Minio ())
Removes an ongoing multipart upload of an object from the service
__Parameters__
In the expression `selectObjectContent bucketName objectName selReq`
the parameters are:
| Param | Type | Description |
|:-------------|:----------------------------|:--------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `selReq` | _SelectRequest_ | Select request parameters |
__SelectRequest record__
This record is created using `selectRequest`. Please refer to the Haddocks for further information.
__Return Value__
The return value can be used to read individual `EventMessage`s in the response. Please refer to the Haddocks for further information.
|Return type | Description |
|:---|:---|
| _Minio (C.conduitT () EventMessage Minio ())_ | A Conduit source of `EventMessage` values. |
__Example__
```haskell
{-# Language OverloadedStrings #-}
import Network.Minio
import qualified Conduit as C
main :: IO ()
main = do
let
bucket = "mybucket"
object = "myobject"
res <- runMinio minioPlayCI $ do
let sr = selectRequest "Select * from s3object"
defaultCsvInput defaultCsvOutput
res <- selectObjectContent bucket object sr
C.runConduit $ res C..| getPayloadBytes C..| C.stdoutC
case res of
Left _ -> putStrLn "Failed!"
Right _ -> putStrLn "Success!"
```
<a name="BucketExists"></a> <a name="BucketExists"></a>
### bucketExists :: Bucket -> Minio Bool ### bucketExists :: Bucket -> Minio Bool
Checks if a bucket exists. Checks if a bucket exists.
@ -805,9 +680,9 @@ __Parameters__
In the expression `bucketExists bucketName` the parameters are: In the expression `bucketExists bucketName` the parameters are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:----------------------------|:-------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
## 4. Presigned operations ## 4. Presigned operations
@ -829,22 +704,22 @@ __Parameters__
In the expression `presignedGetObjectUrl bucketName objectName expiry queryParams headers` In the expression `presignedGetObjectUrl bucketName objectName expiry queryParams headers`
the parameters are: the parameters are:
| Param | Type | Description | |Param |Type |Description |
|:--------------|:---------------------------------------------------------------|:------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds | | `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds |
| `queryParams` | _Query_ (from package `http-types:Network.HTTP.Types`) | Query parameters to add to the URL | | `queryParams` | _Query_ (from package `http-types:Network.HTTP.Types`) | Query parameters to add to the URL |
| `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL | | `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL |
__Return Value__ __Return Value__
Returns the generated URL - it will include authentication Returns the generated URL - it will include authentication
information. information.
| Return type | Description | |Return type |Description |
|:-------------|:------------------------| |:---|:---|
| _ByteString_ | Generated presigned URL | | _ByteString_ | Generated presigned URL |
__Example__ __Example__
@ -887,21 +762,21 @@ __Parameters__
In the expression `presignedPutObjectUrl bucketName objectName expiry headers` In the expression `presignedPutObjectUrl bucketName objectName expiry headers`
the parameters are: the parameters are:
| Param | Type | Description | |Param |Type |Description |
|:-------------|:---------------------------------------------------------------|:------------------------------------------------| |:---|:---| :---|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds | | `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds |
| `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL | | `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL |
__Return Value__ __Return Value__
Returns the generated URL - it will include authentication Returns the generated URL - it will include authentication
information. information.
| Return type | Description | |Return type |Description |
|:-------------|:------------------------| |:---|:---|
| _ByteString_ | Generated presigned URL | | _ByteString_ | Generated presigned URL |
__Example__ __Example__
@ -929,7 +804,7 @@ main = do
``` ```
<a name="presignedPostPolicy"></a> <a name="presignedPostPolicy"></a>
### presignedPostPolicy :: PostPolicy -> Minio (ByteString, HashMap Text ByteString) ### presignedPostPolicy :: PostPolicy -> Minio (ByteString, Map.Map Text ByteString)
Generate a presigned URL and POST policy to upload files via a POST Generate a presigned URL and POST policy to upload files via a POST
request. This is intended for browser uploads and generates form data request. This is intended for browser uploads and generates form data
@ -941,10 +816,10 @@ The `PostPolicy` argument is created using the `newPostPolicy` function:
In the expression `newPostPolicy expirationTime conditions` the parameters are: In the expression `newPostPolicy expirationTime conditions` the parameters are:
| Param | Type | Description | |Param | Type| Description |
|:-----------------|:--------------------------------------------------|:---------------------------------------------| |:---|:---|:---|
| `expirationTime` | _UTCTime_ (from package `time:Data.Time.UTCTime`) | The expiration time for the policy | | `expirationTime` | _UTCTime_ (from package `time:Data.Time.UTCTime`) | The expiration time for the policy |
| `conditions` | _[PostPolicyConditions]_ | List of conditions to be added to the policy | | `conditions` | _[PostPolicyConditions]_ | List of conditions to be added to the policy |
The policy conditions are created using various helper functions - The policy conditions are created using various helper functions -
please refer to the Haddocks for details. please refer to the Haddocks for details.
@ -966,7 +841,7 @@ import Network.Minio
import qualified Data.ByteString as B import qualified Data.ByteString as B
import qualified Data.ByteString.Char8 as Char8 import qualified Data.ByteString.Char8 as Char8
import qualified Data.HashMap.Strict as H import qualified Data.Map.Strict as Map
import qualified Data.Text.Encoding as Enc import qualified Data.Text.Encoding as Enc
import qualified Data.Time as Time import qualified Data.Time as Time
@ -1006,7 +881,7 @@ main = do
let let
formFn (k, v) = B.concat ["-F ", Enc.encodeUtf8 k, "=", formFn (k, v) = B.concat ["-F ", Enc.encodeUtf8 k, "=",
"'", v, "'"] "'", v, "'"]
formOptions = B.intercalate " " $ map formFn $ H.toList formData formOptions = B.intercalate " " $ map formFn $ Map.toList formData
return $ B.intercalate " " $ return $ B.intercalate " " $

View File

@ -1,47 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2023 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
{-# LANGUAGE OverloadedStrings #-}
import Control.Monad.IO.Class (liftIO)
import Network.Minio
import Prelude
main :: IO ()
main = do
-- Use play credentials for example.
let assumeRole =
STSAssumeRole
( CredentialValue
"Q3AM3UQ867SPQQA43P2F"
"zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
Nothing
)
$ defaultSTSAssumeRoleOptions
{ saroLocation = Just "us-east-1",
saroEndpoint = Just "https://play.min.io:9000"
}
-- Retrieve temporary credentials and print them.
cv <- requestSTSCredential assumeRole
print $ "Temporary credentials" ++ show (credentialValueText $ fst cv)
print $ "Expiry" ++ show (snd cv)
-- Configure 'ConnectInfo' to request temporary credentials on demand.
ci <- setSTSCredential assumeRole "https://play.min.io"
res <- runMinio ci $ do
buckets <- listBuckets
liftIO $ print $ "Top 5 buckets: " ++ show (take 5 buckets)
print res

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,17 +16,20 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
{-# Language OverloadedStrings #-}
import Network.Minio
import Control.Monad.IO.Class (liftIO) import Control.Monad.IO.Class (liftIO)
import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "missingbucket" let bucket = "missingbucket"

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,40 +16,44 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Network.Minio {-# Language OverloadedStrings #-}
import UnliftIO.Exception (catch, throwIO) import Network.Minio
import Control.Monad.Catch (catchIf)
import qualified Data.Text as T
import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
ignoreMinioErr :: ServiceErr -> Minio ()
ignoreMinioErr = return . const ()
main :: IO () main :: IO ()
main = do main = do
let bucket = "test" let
bucket = "test"
object = "obj" object = "obj"
objectCopy = "obj-copy" objectCopy = "obj-copy"
localFile = "/etc/lsb-release" localFile = "/etc/lsb-release"
res1 <- runMinio minioPlayCI $ do res1 <- runMinio minioPlayCI $ do
-- 1. Make a bucket; Catch BucketAlreadyOwnedByYou exception. -- 1. Make a bucket; Catch BucketAlreadyOwnedByYou exception.
catch catchIf (== BucketAlreadyOwnedByYou) (makeBucket bucket Nothing) ignoreMinioErr
(makeBucket bucket Nothing)
( \e -> case e of
BucketAlreadyOwnedByYou -> return ()
_ -> throwIO e
)
-- 2. Upload a file to bucket/object. -- 2. Upload a file to bucket/object.
fPutObject bucket object localFile defaultPutObjectOptions fPutObject bucket object localFile
-- 3. Copy bucket/object to bucket/objectCopy. -- 3. Copy bucket/object to bucket/objectCopy.
copyObject copyObject bucket objectCopy def {
defaultDestinationInfo {dstBucket = bucket, dstObject = objectCopy} cpSource = T.concat ["/", bucket, "/", object]
defaultSourceInfo {srcBucket = bucket, srcObject = object} }
case res1 of case res1 of
Left e -> putStrLn $ "copyObject failed." ++ show e Left e -> putStrLn $ "copyObject failed." ++ (show e)
Right () -> putStrLn "copyObject succeeded." Right () -> putStrLn "copyObject succeeded."

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs --package optparse-applicative --package filepath -- stack --resolver lts-8.5 runghc --package minio-hs --package optparse-applicative --package filepath
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,39 +16,42 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE ScopedTypeVariables #-}
import Data.Text (pack)
{-# Language OverloadedStrings, ScopedTypeVariables #-}
import Network.Minio import Network.Minio
import Control.Monad.Catch (catchIf)
import Control.Monad.IO.Class (liftIO)
import Data.Monoid ((<>))
import Data.Text (pack)
import Options.Applicative import Options.Applicative
import System.FilePath.Posix
import UnliftIO (throwIO, try)
import Prelude import Prelude
import System.FilePath.Posix
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
-- optparse-applicative package based command-line parsing. -- optparse-applicative package based command-line parsing.
fileNameArgs :: Parser FilePath fileNameArgs :: Parser FilePath
fileNameArgs = fileNameArgs = strArgument
strArgument (metavar "FILENAME"
( metavar "FILENAME" <> help "Name of file to upload to AWS S3 or a Minio server")
<> help "Name of file to upload to AWS S3 or a MinIO server"
) cmdParser = info
(helper <*> fileNameArgs)
(fullDesc
<> progDesc "FileUploader"
<> header
"FileUploader - a simple file-uploader program using minio-hs")
ignoreMinioErr :: ServiceErr -> Minio ()
ignoreMinioErr = return . const ()
cmdParser :: ParserInfo FilePath
cmdParser =
info
(helper <*> fileNameArgs)
( fullDesc
<> progDesc "FileUploader"
<> header
"FileUploader - a simple file-uploader program using minio-hs"
)
main :: IO () main :: IO ()
main = do main = do
@ -60,15 +63,11 @@ main = do
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
-- Make a bucket; catch bucket already exists exception if thrown. -- Make a bucket; catch bucket already exists exception if thrown.
bErr <- try $ makeBucket bucket Nothing catchIf (== BucketAlreadyOwnedByYou) (makeBucket bucket Nothing) ignoreMinioErr
case bErr of
Left BucketAlreadyOwnedByYou -> return ()
Left e -> throwIO e
Right _ -> return ()
-- Upload filepath to bucket; object is derived from filepath. -- Upload filepath to bucket; object is derived from filepath.
fPutObject bucket object filepath defaultPutObjectOptions fPutObject bucket object filepath
case res of case res of
Left e -> putStrLn $ "file upload failed due to " ++ show e Left e -> putStrLn $ "file upload failed due to " ++ (show e)
Right () -> putStrLn "file upload succeeded." Right () -> putStrLn "file upload succeeded."

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,26 +16,30 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import qualified Data.Conduit as C {-# Language OverloadedStrings #-}
import qualified Data.Conduit.Binary as CB
import Network.Minio import Network.Minio
import Data.Conduit (($$+-))
import Data.Conduit.Binary (sinkLbs)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "my-bucket" let
bucket = "my-bucket"
object = "my-object" object = "my-object"
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
src <- getObject bucket object defaultGetObjectOptions src <- getObject bucket object
C.connect (gorObjectStream src) $ CB.sinkFileCautious "/tmp/my-object" (src $$+- sinkLbs)
case res of case res of
Left e -> putStrLn $ "getObject failed." ++ show e Left e -> putStrLn $ "getObject failed." ++ (show e)
Right _ -> putStrLn "getObject succeeded." Right _ -> putStrLn "getObject succeeded."

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,24 +16,27 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Network.Minio {-# Language OverloadedStrings #-}
import Network.Minio.S3API import Network.Minio.S3API
import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "test" let
bucket = "test"
object = "passwd" object = "passwd"
res <- res <- runMinio minioPlayCI $
runMinio minioPlayCI $ headObject bucket object
headObject bucket object []
case res of case res of
Left e -> putStrLn $ "headObject failed." ++ show e Left e -> putStrLn $ "headObject failed." ++ show e

View File

@ -1,37 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
import Network.Minio
import Network.Minio.AdminAPI
import Prelude
main :: IO ()
main = do
res <- runMinio minioPlayCI $
do
hsr <-
startHeal
Nothing
Nothing
HealOpts
{ hoRecursive = True,
hoDryRun = False
}
getHealStatus Nothing Nothing (hsrClientToken hsr)
print res

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,17 +16,19 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
{-# Language OverloadedStrings #-}
import Network.Minio
import Control.Monad.IO.Class (liftIO) import Control.Monad.IO.Class (liftIO)
import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
-- This example list buckets that belongs to the user and returns -- This example list buckets that belongs to the user and returns
-- region of the first bucket returned. -- region of the first bucket returned.

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,36 +16,39 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Conduit {-# Language OverloadedStrings #-}
import Network.Minio import Network.Minio
import Data.Conduit (($$))
import Data.Conduit.Combinators (sinkList)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "test" let
bucket = "test"
-- Performs a recursive listing of incomplete uploads under bucket "test" -- Performs a recursive listing of incomplete uploads under bucket "test"
-- on a local minio server. -- on a local minio server.
res <- res <- runMinio minioPlayCI $
runMinio minioPlayCI $ listIncompleteUploads bucket Nothing True $$ sinkList
runConduit $
listIncompleteUploads bucket Nothing True .| mapM_C (liftIO . print)
print res print res
{- {-
Following is the output of the above program on a local MinIO server. Following is the output of the above program on a local Minio server.
Right [UploadInfo { uiKey = "go1.6.2.linux-amd64.tar.gz" Right [UploadInfo { uiKey = "go1.6.2.linux-amd64.tar.gz"
, uiUploadId = "063eb592-bdd7-4a0c-be48-34fb3ceb63e2" , uiUploadId = "063eb592-bdd7-4a0c-be48-34fb3ceb63e2"
, uiInitTime = 2017-03-01 10:16:25.698 UTC , uiInitTime = 2017-03-01 10:16:25.698 UTC
, uiSize = 17731794 , uiSize = 17731794
} }
] ]
-} -}

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,31 +16,35 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Conduit {-# Language OverloadedStrings #-}
import Network.Minio import Network.Minio
import Prelude
import qualified Data.Conduit as C
import qualified Data.Conduit.Combinators as CC
import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "test" let
bucket = "test"
-- Performs a recursive listing of all objects under bucket "test" -- Performs a recursive listing of all objects under bucket "test"
-- on play.min.io. -- on play.minio.io.
res <- res <- runMinio minioPlayCI $
runMinio minioPlayCI $ listObjects bucket Nothing True C.$$ CC.sinkList
runConduit $
listObjects bucket Nothing True .| mapM_C (liftIO . print)
print res print res
{- {-
Following is the output of the above program on a local MinIO server. Following is the output of the above program on a local Minio server.
Right [ObjectInfo {oiObject = "ADVANCED.png", oiModTime = 2017-02-10 05:33:24.816 UTC, oiETag = "\"a69f3af6bbb06fe1d42ac910ec30482f\"", oiSize = 94026},ObjectInfo {oiObject = "obj", oiModTime = 2017-02-10 08:49:26.777 UTC, oiETag = "\"715a872a253a3596652c1490081b4b6a-1\"", oiSize = 15728640}] Right [ObjectInfo {oiObject = "ADVANCED.png", oiModTime = 2017-02-10 05:33:24.816 UTC, oiETag = "\"a69f3af6bbb06fe1d42ac910ec30482f\"", oiSize = 94026},ObjectInfo {oiObject = "obj", oiModTime = 2017-02-10 08:49:26.777 UTC, oiETag = "\"715a872a253a3596652c1490081b4b6a-1\"", oiSize = 15728640}]
-} -}

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,21 +16,25 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Network.Minio
import Prelude {-# Language OverloadedStrings #-}
import Network.Minio
import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "my-bucket" let
res <- bucket = "my-bucket"
runMinio minioPlayCI $ res <- runMinio minioPlayCI $
-- N B the region provided for makeBucket is optional. -- N B the region provided for makeBucket is optional.
makeBucket bucket (Just "us-east-1") makeBucket bucket (Just "us-east-1")
print res print res

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-9.1 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,41 +16,42 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Control.Monad.IO.Class (liftIO) {-# LANGUAGE OverloadedStrings #-}
import qualified Data.ByteString.Char8 as B import Network.Minio
import Data.CaseInsensitive (original)
import Control.Monad.IO.Class (liftIO)
import qualified Data.ByteString.Char8 as B
import Data.CaseInsensitive (original)
import qualified Data.Conduit.Combinators as CC import qualified Data.Conduit.Combinators as CC
import qualified Data.Text.Encoding as E import qualified Data.Text.Encoding as E
import Network.Minio
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "my-bucket" let
object = "my-object" bucket = "my-bucket"
kb15 = 15 * 1024 object = "my-object"
-- Set query parameter to modify content disposition response kb15 = 15*1024
-- header
queryParam = -- Set query parameter to modify content disposition response
[ ( "response-content-disposition", -- header
Just "attachment; filename=\"your-filename.txt\"" queryParam = [("response-content-disposition",
) Just "attachment; filename=\"your-filename.txt\"")]
]
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
liftIO $ B.putStrLn "Upload a file that we will fetch with a presigned URL..." liftIO $ B.putStrLn "Upload a file that we will fetch with a presigned URL..."
putObject bucket object (CC.repeat "a") (Just kb15) defaultPutObjectOptions putObject bucket object (CC.repeat "a") (Just kb15)
liftIO $ putStrLn "Done. Object created at: my-bucket/my-object" liftIO $ putStrLn $ "Done. Object created at: my-bucket/my-object"
-- Extract Etag of uploaded object -- Extract Etag of uploaded object
oi <- statObject bucket object defaultGetObjectOptions (ObjectInfo _ _ etag _) <- statObject bucket object
let etag = oiETag oi
-- Set header to add an if-match constraint - this makes sure -- Set header to add an if-match constraint - this makes sure
-- the fetching fails if the object is changed on the server -- the fetching fails if the object is changed on the server
@ -59,29 +60,23 @@ main = do
-- Generate a URL with 7 days expiry time - note that the headers -- Generate a URL with 7 days expiry time - note that the headers
-- used above must be added to the request with the signed URL -- used above must be added to the request with the signed URL
-- generated. -- generated.
url <- url <- presignedGetObjectUrl "my-bucket" "my-object" (7*24*3600)
presignedGetObjectUrl queryParam headers
"my-bucket"
"my-object"
(7 * 24 * 3600)
queryParam
headers
return (headers, etag, url) return (headers, etag, url)
case res of case res of
Left e -> putStrLn $ "presignedPutObject URL failed." ++ show e Left e -> putStrLn $ "presignedPutObject URL failed." ++ show e
Right (headers, _, url) -> do Right (headers, etag, url) -> do
-- We generate a curl command to demonstrate usage of the signed -- We generate a curl command to demonstrate usage of the signed
-- URL. -- URL.
let hdrOpt (k, v) = B.concat ["-H '", original k, ": ", v, "'"] let
curlCmd = hdrOpt (k, v) = B.concat ["-H '", original k, ": ", v, "'"]
B.intercalate " " $ curlCmd = B.intercalate " " $
["curl --fail"] ["curl --fail"] ++ map hdrOpt headers ++
++ map hdrOpt headers ["-o /tmp/myfile", B.concat ["'", url, "'"]]
++ ["-o /tmp/myfile", B.concat ["'", url, "'"]]
putStrLn $ putStrLn $ "The following curl command would use the presigned " ++
"The following curl command would use the presigned " "URL to fetch the object and write it to \"/tmp/myfile\":"
++ "URL to fetch the object and write it to \"/tmp/myfile\":"
B.putStrLn curlCmd B.putStrLn curlCmd

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-9.1 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,72 +16,69 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import qualified Data.ByteString as B {-# LANGUAGE OverloadedStrings #-}
import Network.Minio
import qualified Data.ByteString as B
import qualified Data.ByteString.Char8 as Char8 import qualified Data.ByteString.Char8 as Char8
import qualified Data.HashMap.Strict as H import qualified Data.Map.Strict as Map
import qualified Data.Text.Encoding as Enc import qualified Data.Text.Encoding as Enc
import qualified Data.Time as Time import qualified Data.Time as Time
import Network.Minio
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
now <- Time.getCurrentTime now <- Time.getCurrentTime
let bucket = "my-bucket" let
object = "photos/my-object" bucket = "my-bucket"
-- set an expiration time of 10 days object = "my-object"
expireTime = Time.addUTCTime (3600 * 24 * 10) now
-- create a policy with expiration time and conditions - since the -- set an expiration time of 10 days
-- conditions are validated, newPostPolicy returns an Either value expireTime = Time.addUTCTime (3600 * 24 * 10) now
policyE =
newPostPolicy -- create a policy with expiration time and conditions - since the
expireTime -- conditions are validated, newPostPolicy returns an Either value
[ -- set the object name condition policyE = newPostPolicy expireTime
ppCondKey object, [ -- set the object name condition
-- set the bucket name condition ppCondKey "photos/my-object"
ppCondBucket bucket, -- set the bucket name condition
-- set the size range of object as 1B to 10MiB , ppCondBucket "my-bucket"
ppCondContentLengthRange 1 (10 * 1024 * 1024), -- set the size range of object as 1B to 10MiB
-- set content type as jpg image , ppCondContentLengthRange 1 (10*1024*1024)
ppCondContentType "image/jpeg", -- set content type as jpg image
-- on success set the server response code to 200 , ppCondContentType "image/jpeg"
ppCondSuccessActionStatus 200 -- on success set the server response code to 200
] , ppCondSuccessActionStatus 200
]
case policyE of case policyE of
Left err -> print err Left err -> putStrLn $ show err
Right policy -> do Right policy -> do
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
(url, formData) <- presignedPostPolicy policy (url, formData) <- presignedPostPolicy policy
-- a curl command is output to demonstrate using the generated -- a curl command is output to demonstrate using the generated
-- URL and form-data -- URL and form-data
let formFn (k, v) = let
B.concat formFn (k, v) = B.concat ["-F ", Enc.encodeUtf8 k, "=",
[ "-F ", "'", v, "'"]
Enc.encodeUtf8 k, formOptions = B.intercalate " " $ map formFn $ Map.toList formData
"=",
"'",
v,
"'"
]
formOptions = B.intercalate " " $ map formFn $ H.toList formData
return $
B.intercalate return $ B.intercalate " " $
" " ["curl", formOptions, "-F file=@/tmp/photo.jpg", url]
["curl", formOptions, "-F file=@/tmp/photo.jpg", url]
case res of case res of
Left e -> putStrLn $ "post-policy error: " ++ show e Left e -> putStrLn $ "post-policy error: " ++ (show e)
Right cmd -> do Right cmd -> do
putStrLn "Put a photo at /tmp/photo.jpg and run command:\n" putStrLn $ "Put a photo at /tmp/photo.jpg and run command:\n"
-- print the generated curl command -- print the generated curl command
Char8.putStrLn cmd Char8.putStrLn cmd

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-9.1 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,43 +16,44 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE OverloadedStrings #-}
import Network.Minio
import qualified Data.ByteString.Char8 as B import qualified Data.ByteString.Char8 as B
import Data.CaseInsensitive (original) import Data.CaseInsensitive (original)
import Network.Minio
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let -- Use headers to set user-metadata - note that this header will let
-- need to be set when the URL is used to make an upload. -- Use headers to set user-metadata - note that this header will
headers = -- need to be set when the URL is used to make an upload.
[ ( "x-amz-meta-url-creator", headers = [("x-amz-meta-url-creator",
"minio-hs-presigned-put-example" "minio-hs-presigned-put-example")]
)
]
res <- runMinio minioPlayCI $ do res <- runMinio minioPlayCI $ do
-- generate a URL with 7 days expiry time -- generate a URL with 7 days expiry time
presignedPutObjectUrl "my-bucket" "my-object" (7 * 24 * 3600) headers presignedPutObjectURL "my-bucket" "my-object" (7*24*3600) headers
case res of case res of
Left e -> putStrLn $ "presignedPutObject URL failed." ++ show e Left e -> putStrLn $ "presignedPutObject URL failed." ++ show e
Right url -> do Right url -> do
-- We generate a curl command to demonstrate usage of the signed -- We generate a curl command to demonstrate usage of the signed
-- URL. -- URL.
let hdrOpt (k, v) = B.concat ["-H '", original k, ": ", v, "'"] let
curlCmd = hdrOpt (k, v) = B.concat ["-H '", original k, ": ", v, "'"]
B.intercalate " " $ curlCmd = B.intercalate " " $
["curl "] ["curl "] ++ map hdrOpt headers ++
++ map hdrOpt headers ["-T /tmp/myfile", B.concat ["'", url, "'"]]
++ ["-T /tmp/myfile", B.concat ["'", url, "'"]]
putStrLn $ B.putStrLn $ "The following curl command would use the presigned " ++
"The following curl command would use the presigned " "URL to upload the file at \"/tmp/myfile\":"
++ "URL to upload the file at \"/tmp/myfile\":"
B.putStrLn curlCmd B.putStrLn curlCmd

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,36 +16,38 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE OverloadedStrings #-}
import Network.Minio
import qualified Data.Conduit.Combinators as CC import qualified Data.Conduit.Combinators as CC
import Network.Minio
import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "test" let
bucket = "test"
object = "obj" object = "obj"
localFile = "/etc/lsb-release" localFile = "/etc/lsb-release"
kb15 = 15 * 1024 kb15 = 15 * 1024
-- Eg 1. Upload a stream of repeating "a" using putObject with default options. -- Eg 1. Upload a stream of repeating "a" using putObject.
res1 <- res1 <- runMinio minioPlayCI $
runMinio minioPlayCI $ putObject bucket object (CC.repeat "a") (Just kb15)
putObject bucket object (CC.repeat "a") (Just kb15) defaultPutObjectOptions
case res1 of case res1 of
Left e -> putStrLn $ "putObject failed." ++ show e Left e -> putStrLn $ "putObject failed." ++ show e
Right () -> putStrLn "putObject succeeded." Right () -> putStrLn "putObject succeeded."
-- Eg 2. Upload a file using fPutObject with default options.
res2 <- -- Eg 2. Upload a file using fPutObject.
runMinio minioPlayCI $ res2 <- runMinio minioPlayCI $
fPutObject bucket object localFile defaultPutObjectOptions fPutObject bucket object localFile
case res2 of case res2 of
Left e -> putStrLn $ "fPutObject failed." ++ show e Left e -> putStrLn $ "fPutObject failed." ++ show e
Right () -> putStrLn "fPutObject succeeded." Right () -> putStrLn "fPutObject succeeded."

View File

@ -1,17 +0,0 @@
# Examples
The examples in this directory illustrate usage of various APIs provided by this library. Each file is self-contained and can be run like a script directly.
To build the examples, the build flag `examples` needs to be turned on:
```sh
stack build --flag minio-hs:examples
```
Now to run and example script [BucketExists.hs](https://github.com/minio/minio-hs/blob/master/examples/BucketExists.hs):
```sh
stack exec BucketExists
```
The CI system is configured to build these examples with every change, so they should be current.

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,24 +16,27 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
{-# Language OverloadedStrings #-}
import Network.Minio import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "mybucket" let
object = "myobject" bucket = "mybucket"
object = "myobject"
res <- res <- runMinio minioPlayCI $
runMinio minioPlayCI $ removeIncompleteUpload bucket object
removeIncompleteUpload bucket object
case res of case res of
Left _ -> putStrLn $ "Failed to remove " ++ show bucket ++ "/" ++ show object Left _ -> putStrLn $ "Failed to remove " ++ show bucket ++ "/" ++ show object

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,19 +16,20 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
{-# Language OverloadedStrings #-}
import Network.Minio import Network.Minio
import Prelude import Prelude
main :: IO () main :: IO ()
main = do main = do
let bucket = "mybucket" let
object = "myobject" bucket = "mybucket"
object = "myobject"
res <- res <- runMinio minioPlayCI $
runMinio minioPlayCI $ removeObject bucket object
removeObject bucket object
case res of case res of
Left _ -> putStrLn $ "Failed to remove " ++ show bucket ++ "/" ++ show object Left _ -> putStrLn $ "Failed to remove " ++ show bucket ++ "/" ++ show object

View File

@ -1,8 +1,8 @@
#!/usr/bin/env stack #!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs -- stack --resolver lts-8.5 runghc --package minio-hs
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,18 +16,23 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE OverloadedStrings #-}
import Network.Minio
import Prelude {-# Language OverloadedStrings #-}
import Network.Minio
import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated -- https://play.minio.io:9000. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
--
main :: IO () main :: IO ()
main = do main = do
let bucket = "my-bucket" let
bucket = "my-bucket"
res <- runMinio minioPlayCI $ removeBucket bucket res <- runMinio minioPlayCI $ removeBucket bucket
print res print res

View File

@ -1,47 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2019 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
{-# LANGUAGE OverloadedStrings #-}
import qualified Conduit as C
import Control.Monad (unless)
import Network.Minio
import Prelude
main :: IO ()
main = do
let bucket = "selectbucket"
object = "1.csv"
content =
"Name,Place,Temperature\n"
<> "James,San Jose,76\n"
<> "Alicia,San Leandro,88\n"
<> "Mark,San Carlos,90\n"
res <- runMinio minioPlayCI $ do
exists <- bucketExists bucket
unless exists $
makeBucket bucket Nothing
C.liftIO $ putStrLn "Uploading csv object"
putObject bucket object (C.sourceLazy content) Nothing defaultPutObjectOptions
let sr = selectRequest "Select * from s3object" defaultCsvInput defaultCsvOutput
res <- selectObjectContent bucket object sr
C.runConduit $ res C..| getPayloadBytes C..| C.stdoutC
print res

View File

@ -1,30 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
import Network.Minio
import Network.Minio.AdminAPI
import Prelude
main :: IO ()
main = do
res <-
runMinio
minioPlayCI
getServerInfo
print res

View File

@ -1,29 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
import Network.Minio
import Network.Minio.AdminAPI
import Prelude
main :: IO ()
main = do
res <-
runMinio minioPlayCI $
serviceSendAction ServiceActionRestart
print res

View File

@ -1,29 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
import Network.Minio
import Network.Minio.AdminAPI
import Prelude
main :: IO ()
main = do
res <-
runMinio minioPlayCI $
serviceSendAction ServiceActionStop
print res

View File

@ -1,30 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
import Network.Minio
import Network.Minio.AdminAPI
import Prelude
main :: IO ()
main = do
res <-
runMinio
minioPlayCI
serviceStatus
print res

View File

@ -1,31 +0,0 @@
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
{-# LANGUAGE OverloadedStrings #-}
import Network.Minio
import Network.Minio.AdminAPI
import Prelude
main :: IO ()
main = do
res <- runMinio minioPlayCI $
do
let config = "{\"version\":\"25\",\"credential\":{\"accessKey\":\"minio\",\"secretKey\":\"minio123\"},\"region\":\"\",\"browser\":\"on\",\"worm\":\"off\",\"domain\":\"\",\"storageclass\":{\"standard\":\"\",\"rrs\":\"\"},\"cache\":{\"drives\":[],\"expiry\":90,\"exclude\":[]},\"notify\":{\"amqp\":{\"2\":{\"enable\":false,\"url\":\"amqp://guest:guest@localhost:5672/\",\"exchange\":\"minio\",\"routingKey\":\"minio\",\"exchangeType\":\"direct\",\"deliveryMode\":0,\"mandatory\":false,\"immediate\":false,\"durable\":false,\"internal\":false,\"noWait\":false,\"autoDeleted\":false}},\"elasticsearch\":{\"1\":{\"enable\":false,\"format\":\"namespace\",\"url\":\"http://localhost:9200\",\"index\":\"minio_events\"}},\"kafka\":{\"1\":{\"enable\":false,\"brokers\":null,\"topic\":\"\"}},\"mqtt\":{\"1\":{\"enable\":false,\"broker\":\"\",\"topic\":\"\",\"qos\":0,\"clientId\":\"\",\"username\":\"\",\"password\":\"\",\"reconnectInterval\":0,\"keepAliveInterval\":0}},\"mysql\":{\"1\":{\"enable\":false,\"format\":\"namespace\",\"dsnString\":\"\",\"table\":\"\",\"host\":\"\",\"port\":\"\",\"user\":\"\",\"password\":\"\",\"database\":\"\"}},\"nats\":{\"1\":{\"enable\":false,\"address\":\"\",\"subject\":\"\",\"username\":\"\",\"password\":\"\",\"token\":\"\",\"secure\":false,\"pingInterval\":0,\"streaming\":{\"enable\":false,\"clusterID\":\"\",\"clientID\":\"\",\"async\":false,\"maxPubAcksInflight\":0}}},\"postgresql\":{\"1\":{\"enable\":false,\"format\":\"namespace\",\"connectionString\":\"\",\"table\":\"\",\"host\":\"\",\"port\":\"\",\"user\":\"\",\"password\":\"\",\"database\":\"\"}},\"redis\":{\"test1\":{\"enable\":true,\"format\":\"namespace\",\"address\":\"127.0.0.1:6379\",\"password\":\"\",\"key\":\"bucketevents_ns\"},\"test2\":{\"enable\":true,\"format\":\"access\",\"address\":\"127.0.0.1:6379\",\"password\":\"\",\"key\":\"bucketevents_log\"}},\"webhook\":{\"1\":{\"enable\":true,\"endpoint\":\"http://localhost:3000\"},\"2\":{\"enable\":true,\"endpoint\":\"http://localhost:3001\"}}}}"
setConfig config
print res

View File

@ -1,352 +1,245 @@
cabal-version: 2.4
name: minio-hs name: minio-hs
version: 1.7.0 version: 0.3.2
synopsis: A MinIO Haskell Library for Amazon S3 compatible cloud synopsis: A Minio Haskell Library for Amazon S3 compatible cloud
storage. storage.
description: The MinIO Haskell client library provides simple APIs to description: The Minio Haskell client library provides simple APIs to
access MinIO, Amazon S3 and other API compatible cloud access Minio, Amazon S3 and other API compatible cloud
storage servers. storage servers.
homepage: https://github.com/minio/minio-hs#readme homepage: https://github.com/minio/minio-hs#readme
license: Apache-2.0 license: Apache-2.0
license-file: LICENSE license-file: LICENSE
author: MinIO Dev Team author: Aditya Manthramurthy, Krishnan Parthasarathi
maintainer: dev@min.io maintainer: dev@minio.io
category: Network, AWS, Object Storage category: Network, AWS, Object Storage
build-type: Simple build-type: Simple
stability: Experimental stability: Experimental
extra-doc-files: -- extra-source-files:
CHANGELOG.md cabal-version: >=1.10
CONTRIBUTING.md
docs/API.md
README.md
extra-source-files:
examples/*.hs
stack.yaml
tested-with: GHC == 8.10.7
, GHC == 9.0.2
, GHC == 9.2.8
, GHC == 9.4.8
, GHC == 9.6.5
, GHC == 9.8.2
source-repository head library
type: git hs-source-dirs: src
location: https://github.com/minio/minio-hs.git
Flag dev
Description: Build package in development mode
Default: False
Manual: True
common base-settings
ghc-options: -Wall ghc-options: -Wall
-Wcompat exposed-modules: Network.Minio
-Widentities , Network.Minio.S3API
-Wincomplete-uni-patterns
-Wincomplete-record-updates
-haddock
if impl(ghc >= 8.0)
ghc-options: -Wredundant-constraints
if impl(ghc >= 8.2)
ghc-options: -fhide-source-paths
if impl(ghc >= 8.4)
ghc-options: -Wpartial-fields
-- -Wmissing-export-lists
if impl(ghc >= 8.8)
ghc-options: -Wmissing-deriving-strategies
-Werror=missing-deriving-strategies
-- if impl(ghc >= 8.10)
-- ghc-options: -Wunused-packages -- disabled due to bug related to mixin config
if impl(ghc >= 9.0)
ghc-options: -Winvalid-haddock
if impl(ghc >= 9.2)
ghc-options: -Wredundant-bang-patterns
if flag(dev)
ghc-options: -Werror
default-language: Haskell2010
default-extensions: BangPatterns
, DerivingStrategies
, FlexibleContexts
, FlexibleInstances
, LambdaCase
, MultiParamTypeClasses
, MultiWayIf
, OverloadedStrings
, RankNTypes
, ScopedTypeVariables
, TupleSections
other-modules: Lib.Prelude other-modules: Lib.Prelude
, Network.Minio.API , Network.Minio.API
, Network.Minio.APICommon
, Network.Minio.Data , Network.Minio.Data
, Network.Minio.Data.ByteString , Network.Minio.Data.ByteString
, Network.Minio.Data.Crypto , Network.Minio.Data.Crypto
, Network.Minio.Data.Time , Network.Minio.Data.Time
, Network.Minio.CopyObject
, Network.Minio.Errors , Network.Minio.Errors
, Network.Minio.ListOps , Network.Minio.ListOps
, Network.Minio.PresignedOperations , Network.Minio.PresignedOperations
, Network.Minio.PutObject , Network.Minio.PutObject
, Network.Minio.SelectAPI
, Network.Minio.Sign.V4 , Network.Minio.Sign.V4
, Network.Minio.Utils , Network.Minio.Utils
, Network.Minio.XmlGenerator , Network.Minio.XmlGenerator
, Network.Minio.XmlParser , Network.Minio.XmlParser
, Network.Minio.XmlCommon
, Network.Minio.JsonParser
, Network.Minio.Credentials.Types
, Network.Minio.Credentials.AssumeRole
, Network.Minio.Credentials
mixins: base hiding (Prelude)
, relude (Relude as Prelude)
, relude
build-depends: base >= 4.7 && < 5 build-depends: base >= 4.7 && < 5
, relude >= 0.7 && < 2 , protolude >= 0.1.6
, aeson >= 1.2 && < 3 , aeson
, base64-bytestring >= 1.0 , async
, binary >= 0.8.5.0 , base64-bytestring
, bytestring >= 0.10 , bytestring
, case-insensitive >= 1.2 , case-insensitive
, conduit >= 1.3 , conduit
, conduit-extra >= 1.3 , conduit-combinators
, crypton-connection , conduit-extra
, cryptonite >= 0.25 , containers
, cryptonite-conduit >= 0.2 , cryptonite
, digest >= 0.0.1 , cryptonite-conduit
, directory , data-default
, filepath >= 1.4 , exceptions
, http-client >= 0.5 , filepath
, http-client-tls , http-client
, http-conduit >= 2.3 , http-conduit
, http-types >= 0.12 , http-types
, ini , lifted-async
, memory >= 0.14 , lifted-base
, network-uri , memory
, resourcet >= 1.2 , monad-control
, retry , resourcet
, text >= 1.2 , text
, time >= 1.9 , text-format
, time-units ^>= 1.0.0 , time
, transformers >= 0.5 , transformers
, unliftio >= 0.2 && < 0.3 , transformers-base
, unliftio-core >= 0.2 && < 0.3 , vector
, unordered-containers >= 0.2 , xml-conduit
, xml-conduit >= 1.8 default-language: Haskell2010
default-extensions: FlexibleContexts
library , FlexibleInstances
import: base-settings , BangPatterns
hs-source-dirs: src , MultiParamTypeClasses
exposed-modules: Network.Minio , MultiWayIf
, Network.Minio.AdminAPI , NoImplicitPrelude
, Network.Minio.S3API , OverloadedStrings
, RankNTypes
, ScopedTypeVariables
, TypeFamilies
, TupleSections
Flag live-test Flag live-test
Description: Build the test suite that runs against a live MinIO server Default: True
Default: False
Manual: True Manual: True
test-suite minio-hs-live-server-test test-suite minio-hs-live-server-test
import: base-settings
type: exitcode-stdio-1.0 type: exitcode-stdio-1.0
hs-source-dirs: test, src hs-source-dirs: test, src
main-is: LiveServer.hs main-is: LiveServer.hs
ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N
other-modules: Network.Minio default-language: Haskell2010
default-extensions: BangPatterns
, FlexibleContexts
, FlexibleInstances
, OverloadedStrings
, NoImplicitPrelude
, MultiParamTypeClasses
, MultiWayIf
, ScopedTypeVariables
, RankNTypes
, TupleSections
, TypeFamilies
other-modules: Lib.Prelude
, Network.Minio
, Network.Minio.API
, Network.Minio.Data
, Network.Minio.Data.ByteString
, Network.Minio.Data.Crypto
, Network.Minio.Data.Time
, Network.Minio.Errors
, Network.Minio.ListOps
, Network.Minio.PresignedOperations
, Network.Minio.PutObject
, Network.Minio.S3API , Network.Minio.S3API
, Network.Minio.AdminAPI , Network.Minio.Sign.V4
, Network.Minio.API.Test , Network.Minio.Utils
, Network.Minio.JsonParser.Test
, Network.Minio.TestHelpers
, Network.Minio.Utils.Test , Network.Minio.Utils.Test
, Network.Minio.API.Test
, Network.Minio.XmlGenerator
, Network.Minio.XmlGenerator.Test , Network.Minio.XmlGenerator.Test
, Network.Minio.XmlParser
, Network.Minio.XmlParser.Test , Network.Minio.XmlParser.Test
, Network.Minio.Credentials build-depends: base
build-depends: minio-hs , minio-hs
, raw-strings-qq , protolude >= 0.1.6
, aeson
, async
, base64-bytestring
, bytestring
, case-insensitive
, conduit
, conduit-combinators
, conduit-extra
, containers
, cryptonite
, cryptonite-conduit
, data-default
, directory
, exceptions
, filepath
, http-client
, http-conduit
, http-types
, lifted-async
, lifted-base
, memory
, monad-control
, QuickCheck
, resourcet
, tasty , tasty
, tasty-hunit , tasty-hunit
, tasty-quickcheck , tasty-quickcheck
, tasty-smallcheck , tasty-smallcheck
, QuickCheck , temporary
, text
, text-format
, time
, transformers
, transformers-base
, vector
, xml-conduit
if !flag(live-test) if !flag(live-test)
buildable: False buildable: False
test-suite minio-hs-test test-suite minio-hs-test
import: base-settings
type: exitcode-stdio-1.0 type: exitcode-stdio-1.0
hs-source-dirs: test, src hs-source-dirs: test, src
main-is: Spec.hs main-is: Spec.hs
build-depends: minio-hs build-depends: base
, raw-strings-qq , minio-hs
, protolude >= 0.1.6
, aeson
, async
, base64-bytestring
, bytestring
, case-insensitive
, conduit
, conduit-combinators
, conduit-extra
, containers
, cryptonite
, cryptonite-conduit
, data-default
, directory
, exceptions
, filepath
, http-client
, http-conduit
, http-types
, lifted-async
, lifted-base
, memory
, monad-control
, QuickCheck , QuickCheck
, resourcet
, tasty , tasty
, tasty-hunit , tasty-hunit
, tasty-quickcheck , tasty-quickcheck
, tasty-smallcheck , tasty-smallcheck
ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N , temporary
other-modules: Lib.Prelude , text
, Network.Minio , text-format
, Network.Minio.S3API , time
, Network.Minio.AdminAPI , transformers
, Network.Minio.TestHelpers , transformers-base
, Network.Minio.API.Test , vector
, Network.Minio.JsonParser.Test , xml-conduit
, Network.Minio.Utils.Test
, Network.Minio.XmlGenerator.Test
, Network.Minio.XmlParser.Test
, Network.Minio.Credentials
Flag examples
Description: Build the examples
Default: False
Manual: True
common examples-settings
ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N
default-language: Haskell2010 default-language: Haskell2010
default-extensions: OverloadedStrings default-extensions: BangPatterns
build-depends: base >= 4.7 && < 5 , FlexibleContexts
, bytestring , FlexibleInstances
, case-insensitive , OverloadedStrings
, conduit , NoImplicitPrelude
, conduit-extra , MultiParamTypeClasses
, filepath , MultiWayIf
, minio-hs , ScopedTypeVariables
, optparse-applicative , RankNTypes
, text , TupleSections
, time , TypeFamilies
, unliftio other-modules: Lib.Prelude
, unordered-containers , Network.Minio
hs-source-dirs: examples , Network.Minio.API
if !flag(examples) , Network.Minio.Data
buildable: False , Network.Minio.Data.ByteString
, Network.Minio.Data.Crypto
, Network.Minio.Data.Time
, Network.Minio.Errors
, Network.Minio.ListOps
, Network.Minio.PresignedOperations
, Network.Minio.PutObject
, Network.Minio.S3API
, Network.Minio.Sign.V4
, Network.Minio.Utils
, Network.Minio.Utils.Test
, Network.Minio.API.Test
, Network.Minio.XmlGenerator
, Network.Minio.XmlGenerator.Test
, Network.Minio.XmlParser
, Network.Minio.XmlParser.Test
executable BucketExists
import: examples-settings
scope: private
main-is: BucketExists.hs
executable CopyObject source-repository head
import: examples-settings type: git
scope: private location: https://github.com/minio/minio-hs
main-is: CopyObject.hs
executable FileUploader
import: examples-settings
scope: private
main-is: FileUploader.hs
executable GetConfig
import: examples-settings
scope: private
main-is: GetConfig.hs
executable GetObject
import: examples-settings
scope: private
main-is: GetObject.hs
executable HeadObject
import: examples-settings
scope: private
main-is: HeadObject.hs
executable Heal
import: examples-settings
scope: private
main-is: Heal.hs
executable ListBuckets
import: examples-settings
scope: private
main-is: ListBuckets.hs
executable ListIncompleteUploads
import: examples-settings
scope: private
main-is: ListIncompleteUploads.hs
executable ListObjects
import: examples-settings
scope: private
main-is: ListObjects.hs
executable MakeBucket
import: examples-settings
scope: private
main-is: MakeBucket.hs
executable PresignedGetObject
import: examples-settings
scope: private
main-is: PresignedGetObject.hs
executable PresignedPostPolicy
import: examples-settings
scope: private
main-is: PresignedPostPolicy.hs
executable PresignedPutObject
import: examples-settings
scope: private
main-is: PresignedPutObject.hs
executable PutObject
import: examples-settings
scope: private
main-is: PutObject.hs
executable RemoveBucket
import: examples-settings
scope: private
main-is: RemoveBucket.hs
executable RemoveIncompleteUpload
import: examples-settings
scope: private
main-is: RemoveIncompleteUpload.hs
executable RemoveObject
import: examples-settings
scope: private
main-is: RemoveObject.hs
executable SelectObject
import: examples-settings
scope: private
main-is: SelectObject.hs
executable ServerInfo
import: examples-settings
scope: private
main-is: ServerInfo.hs
executable ServiceSendRestart
import: examples-settings
scope: private
main-is: ServiceSendRestart.hs
executable ServiceSendStop
import: examples-settings
scope: private
main-is: ServiceSendStop.hs
executable ServiceStatus
import: examples-settings
scope: private
main-is: ServiceStatus.hs
executable SetConfig
import: examples-settings
scope: private
main-is: SetConfig.hs
executable AssumeRole
import: examples-settings
scope: private
main-is: AssumeRole.hs

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,41 +15,32 @@
-- --
module Lib.Prelude module Lib.Prelude
( module Exports, ( module Exports
both, , both
showBS,
toStrictBS,
fromStrictBS,
lastMay,
)
where
import Control.Monad.Trans.Maybe as Exports (MaybeT (..), runMaybeT) , format
import qualified Data.ByteString.Lazy as LB , formatBS
import Data.Time as Exports ) where
( UTCTime (..),
diffUTCTime, import Protolude as Exports
)
import UnliftIO as Exports import Data.Time as Exports (UTCTime(..), diffUTCTime)
( Handler, import Control.Monad.Trans.Maybe as Exports (runMaybeT, MaybeT(..))
catch,
catches, import Control.Monad.Catch as Exports (throwM, MonadThrow, MonadCatch)
throwIO,
try, import Data.Text.Format as Exports (Shown(..))
) import qualified Data.Text.Format as TF
import Data.Text.Format.Params (Params)
format :: Params ps => TF.Format -> ps -> Text
format f args = toS $ TF.format f args
formatBS :: Params ps => TF.Format -> ps -> ByteString
formatBS f args = toS $ TF.format f args
-- import Data.Tuple as Exports (uncurry)
-- | Apply a function on both elements of a pair -- | Apply a function on both elements of a pair
both :: (a -> b) -> (a, a) -> (b, b) both :: (a -> b) -> (a, a) -> (b, b)
both f (a, b) = (f a, f b) both f (a, b) = (f a, f b)
showBS :: (Show a) => a -> ByteString
showBS a = encodeUtf8 (show a :: Text)
toStrictBS :: LByteString -> ByteString
toStrictBS = LB.toStrict
fromStrictBS :: ByteString -> LByteString
fromStrictBS = LB.fromStrict
lastMay :: [a] -> Maybe a
lastMay a = last <$> nonEmpty a

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -14,239 +14,143 @@
-- limitations under the License. -- limitations under the License.
-- --
-- |
-- Module: Network.Minio
-- Copyright: (c) 2017-2023 MinIO Dev Team
-- License: Apache 2.0
-- Maintainer: MinIO Dev Team <dev@min.io>
--
-- Types and functions to conveniently access S3 compatible object
-- storage servers like MinIO.
module Network.Minio module Network.Minio
( -- * Credentials (
CredentialValue (..),
credentialValueText,
AccessKey (..),
SecretKey (..),
SessionToken (..),
-- ** Credential Loaders -- * Connecting to object storage
---------------------------------
ConnectInfo(..)
, awsCI
-- | Run actions that retrieve 'CredentialValue's from the environment or -- ** Connection helpers
-- files or other custom sources. ------------------------
CredentialLoader, , awsWithRegionCI
fromAWSConfigFile, , minioPlayCI
fromAWSEnv, , minioCI
fromMinioEnv,
findFirst,
-- * Connecting to object storage -- * Minio Monad
ConnectInfo, ----------------
setRegion, -- | The Minio monad provides connection-reuse, bucket-location
setCreds, -- caching, resource management and simpler error handling
setCredsFrom, -- functionality. All actions on object storage are performed within
isConnectInfoSecure, -- this Monad.
disableTLSCertValidation,
MinioConn,
mkMinioConn,
-- ** Connection helpers , Minio
, runMinio
, def
-- | These are helpers to construct 'ConnectInfo' values for common -- * Bucket Operations
-- cases. ----------------------
minioPlayCI,
awsCI,
gcsCI,
-- ** STS Credential types -- ** Creation, removal and querying
STSAssumeRole (..), , Bucket
STSAssumeRoleOptions (..), , makeBucket
defaultSTSAssumeRoleOptions, , removeBucket
requestSTSCredential, , bucketExists
setSTSCredential, , Region
ExpiryTime (..), , getLocation
STSCredentialProvider,
-- * Minio Monad -- ** Listing
, BucketInfo(..)
, listBuckets
, ObjectInfo(..)
, listObjects
, listObjectsV1
, UploadId
, UploadInfo(..)
, listIncompleteUploads
, ObjectPartInfo(..)
, listIncompleteParts
---------------- -- ** Notifications
, Notification(..)
, NotificationConfig(..)
, Arn
, Event(..)
, Filter(..)
, FilterKey(..)
, FilterRules(..)
, FilterRule(..)
, getBucketNotification
, putBucketNotification
, removeAllBucketNotification
-- | The Minio Monad provides connection-reuse, bucket-location -- * Object Operations
-- caching, resource management and simpler error handling ----------------------
-- functionality. All actions on object storage are performed within
-- this Monad.
Minio,
runMinioWith,
runMinio,
runMinioResWith,
runMinioRes,
-- * Bucket Operations , Object
-- ** Creation, removal and querying -- ** File operations
Bucket, , fGetObject
makeBucket, , fPutObject
removeBucket,
bucketExists,
Region,
getLocation,
-- ** Listing buckets -- ** Conduit-based streaming operations
BucketInfo (..), , putObject
listBuckets, , getObject
-- ** Listing objects -- ** Server-side copying
listObjects, , CopyPartSource(..)
listObjectsV1, , copyObject
ListItem (..),
ObjectInfo,
oiObject,
oiModTime,
oiETag,
oiSize,
oiUserMetadata,
oiMetadata,
-- ** Listing incomplete uploads -- ** Querying
listIncompleteUploads, , statObject
UploadId,
UploadInfo (..),
listIncompleteParts,
ObjectPartInfo (..),
-- ** Bucket Notifications -- ** Object removal functions
getBucketNotification, , removeObject
putBucketNotification, , removeIncompleteUpload
removeAllBucketNotification,
Notification (..),
defaultNotification,
NotificationConfig (..),
Arn,
Event (..),
Filter (..),
defaultFilter,
FilterKey (..),
defaultFilterKey,
FilterRules (..),
defaultFilterRules,
FilterRule (..),
-- * Object Operations -- * Presigned Operations
Object, -------------------------
, UrlExpiry
, presignedPutObjectUrl
, presignedGetObjectUrl
, presignedHeadObjectUrl
-- ** File-based operations -- ** Utilities for POST (browser) uploads
fGetObject, , PostPolicy
fPutObject, , PostPolicyError(..)
, newPostPolicy
, presignedPostPolicy
, showPostPolicy
-- ** Conduit-based streaming operations -- *** Utilities to specify Post Policy conditions
putObject, , PostPolicyCondition
PutObjectOptions, , ppCondBucket
defaultPutObjectOptions, , ppCondContentLengthRange
pooContentType, , ppCondContentType
pooContentEncoding, , ppCondKey
pooContentDisposition, , ppCondKeyStartsWith
pooContentLanguage, , ppCondSuccessActionStatus
pooCacheControl,
pooStorageClass,
pooUserMetadata,
pooNumThreads,
pooSSE,
getObject,
GetObjectOptions,
defaultGetObjectOptions,
gooRange,
gooIfMatch,
gooIfNoneMatch,
gooIfModifiedSince,
gooIfUnmodifiedSince,
gooSSECKey,
GetObjectResponse,
gorObjectInfo,
gorObjectStream,
-- ** Server-side object copying -- * Error handling
copyObject, -----------------------
SourceInfo, -- | Data types representing various errors that may occur while working
defaultSourceInfo, -- with an object storage service.
srcBucket, , MinioErr(..)
srcObject, , MErrV(..)
srcRange, , ServiceErr(..)
srcIfMatch,
srcIfNoneMatch,
srcIfModifiedSince,
srcIfUnmodifiedSince,
DestinationInfo,
defaultDestinationInfo,
dstBucket,
dstObject,
-- ** Querying object info ) where
statObject,
-- ** Object removal operations
removeObject,
removeIncompleteUpload,
-- ** Select Object Content with SQL
module Network.Minio.SelectAPI,
-- * Server-Side Encryption Helpers
mkSSECKey,
SSECKey,
SSE (..),
-- * Presigned Operations
presignedPutObjectUrl,
presignedGetObjectUrl,
presignedHeadObjectUrl,
UrlExpiry,
-- ** POST (browser) upload helpers
-- | Please see
-- https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTConstructPolicy.html
-- for detailed information.
newPostPolicy,
presignedPostPolicy,
showPostPolicy,
PostPolicy,
PostPolicyError (..),
-- *** Post Policy condition helpers
PostPolicyCondition,
ppCondBucket,
ppCondContentLengthRange,
ppCondContentType,
ppCondKey,
ppCondKeyStartsWith,
ppCondSuccessActionStatus,
-- * Error handling
-- | Data types representing various errors that may occur while
-- working with an object storage service.
MinioErr (..),
MErrV (..),
ServiceErr (..),
)
where
{- {-
This module exports the high-level MinIO API for object storage. This module exports the high-level Minio API for object storage.
-} -}
import qualified Data.Conduit as C import qualified Data.Conduit as C
import qualified Data.Conduit.Binary as CB import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.Combinators as CC import qualified Data.Conduit.Combinators as CC
import Network.Minio.API import Data.Default (def)
import Network.Minio.CopyObject import qualified Data.Map as Map
import Network.Minio.Credentials
import Network.Minio.Data import Lib.Prelude
import Network.Minio.Errors
import Network.Minio.ListOps import Network.Minio.Data
import Network.Minio.PutObject import Network.Minio.Errors
import Network.Minio.S3API import Network.Minio.ListOps
import Network.Minio.SelectAPI import Network.Minio.PutObject
import Network.Minio.S3API
-- | Lists buckets. -- | Lists buckets.
listBuckets :: Minio [BucketInfo] listBuckets :: Minio [BucketInfo]
@ -255,65 +159,43 @@ listBuckets = getService
-- | Fetch the object and write it to the given file safely. The -- | Fetch the object and write it to the given file safely. The
-- object is first written to a temporary file in the same directory -- object is first written to a temporary file in the same directory
-- and then moved to the given path. -- and then moved to the given path.
fGetObject :: Bucket -> Object -> FilePath -> GetObjectOptions -> Minio () fGetObject :: Bucket -> Object -> FilePath -> Minio ()
fGetObject bucket object fp opts = do fGetObject bucket object fp = do
src <- getObject bucket object opts src <- getObject bucket object
C.connect (gorObjectStream src) $ CB.sinkFileCautious fp src C.$$+- CB.sinkFileCautious fp
-- | Upload the given file to the given object. -- | Upload the given file to the given object.
fPutObject :: fPutObject :: Bucket -> Object -> FilePath -> Minio ()
Bucket -> fPutObject bucket object f = void $ putObjectInternal bucket object $
Object -> ODFile f Nothing
FilePath ->
PutObjectOptions ->
Minio ()
fPutObject bucket object f opts =
void $ putObjectInternal bucket object opts $ ODFile f Nothing
-- | Put an object from a conduit source. The size can be provided if -- | Put an object from a conduit source. The size can be provided if
-- known; this helps the library select optimal part sizes to perform -- known; this helps the library select optimal part sizes to perform
-- a multipart upload. If not specified, it is assumed that the object -- a multipart upload. If not specified, it is assumed that the object
-- can be potentially 5TiB and selects multipart sizes appropriately. -- can be potentially 5TiB and selects multipart sizes appropriately.
putObject :: putObject :: Bucket -> Object -> C.Producer Minio ByteString
Bucket -> -> Maybe Int64 -> Minio ()
Object -> putObject bucket object src sizeMay =
C.ConduitM () ByteString Minio () -> void $ putObjectInternal bucket object $ ODStream src sizeMay
Maybe Int64 ->
PutObjectOptions ->
Minio ()
putObject bucket object src sizeMay opts =
void $ putObjectInternal bucket object opts $ ODStream src sizeMay
-- | Perform a server-side copy operation to create an object based on -- | Perform a server-side copy operation to create an object with the
-- the destination specification in DestinationInfo from the source -- given bucket and object name from the source specification in
-- specification in SourceInfo. This function performs a multipart -- CopyPartSource. This function performs a multipart copy operation
-- copy operation if the new object is to be greater than 5GiB in -- if the new object is to be greater than 5GiB in size.
-- size. copyObject :: Bucket -> Object -> CopyPartSource -> Minio ()
copyObject :: DestinationInfo -> SourceInfo -> Minio () copyObject bucket object cps = void $ copyObjectInternal bucket object cps
copyObject dstInfo srcInfo =
void $
copyObjectInternal
(dstBucket dstInfo)
(dstObject dstInfo)
srcInfo
-- | Remove an object from the object store. -- | Remove an object from the object store.
removeObject :: Bucket -> Object -> Minio () removeObject :: Bucket -> Object -> Minio ()
removeObject = deleteObject removeObject = deleteObject
-- | Get an object from the object store. -- | Get an object from the object store as a resumable source (conduit).
getObject :: getObject :: Bucket -> Object -> Minio (C.ResumableSource Minio ByteString)
Bucket -> getObject bucket object = snd <$> getObject' bucket object [] []
Object ->
GetObjectOptions ->
Minio GetObjectResponse
getObject bucket object opts =
getObject' bucket object [] $ gooToHeaders opts
-- | Get an object's metadata from the object store. It accepts the -- | Get an object's metadata from the object store.
-- same options as GetObject. statObject :: Bucket -> Object -> Minio ObjectInfo
statObject :: Bucket -> Object -> GetObjectOptions -> Minio ObjectInfo statObject = headObject
statObject b o opts = headObject b o $ gooToHeaders opts
-- | Creates a new bucket in the object store. The Region can be -- | Creates a new bucket in the object store. The Region can be
-- optionally specified. If not specified, it will use the region -- optionally specified. If not specified, it will use the region
@ -323,23 +205,21 @@ makeBucket :: Bucket -> Maybe Region -> Minio ()
makeBucket bucket regionMay = do makeBucket bucket regionMay = do
region <- maybe (asks $ connectRegion . mcConnInfo) return regionMay region <- maybe (asks $ connectRegion . mcConnInfo) return regionMay
putBucket bucket region putBucket bucket region
addToRegionCache bucket region modify (Map.insert bucket region)
-- | Removes a bucket from the object store. -- | Removes a bucket from the object store.
removeBucket :: Bucket -> Minio () removeBucket :: Bucket -> Minio ()
removeBucket bucket = do removeBucket bucket = do
deleteBucket bucket deleteBucket bucket
deleteFromRegionCache bucket modify (Map.delete bucket)
-- | Query the object store if a given bucket is present. -- | Query the object store if a given bucket is present.
bucketExists :: Bucket -> Minio Bool bucketExists :: Bucket -> Minio Bool
bucketExists = headBucket bucketExists = headBucket
-- | Removes an ongoing multipart upload of an object. -- | Removes an ongoing multipart upload of an object.
removeIncompleteUpload :: Bucket -> Object -> Minio () removeIncompleteUpload :: Bucket -> Object -> Minio ()
removeIncompleteUpload bucket object = do removeIncompleteUpload bucket object = do
uploads <- uploads <- listIncompleteUploads bucket (Just object) False C.$$ CC.sinkList
C.runConduit $
listIncompleteUploads bucket (Just object) False
C..| CC.sinkList
mapM_ (abortMultipartUpload bucket object) (uiUploadId <$> uploads) mapM_ (abortMultipartUpload bucket object) (uiUploadId <$> uploads)

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,340 +15,196 @@
-- --
module Network.Minio.API module Network.Minio.API
( connect, (
S3ReqInfo (..), connect
runMinio, , RequestInfo(..)
executeRequest, , runMinio
buildRequest, , executeRequest
mkStreamRequest, , mkStreamRequest
getLocation, , getLocation
isValidBucketName,
checkBucketNameValidity, , isValidBucketName
isValidObjectName, , checkBucketNameValidity
checkObjectNameValidity, , isValidObjectName
requestSTSCredential, , checkObjectNameValidity
) ) where
where
import Control.Retry
( fullJitterBackoff,
limitRetriesByCumulativeDelay,
retrying,
)
import qualified Data.ByteString as B
import qualified Data.Char as C
import qualified Data.Conduit as C import qualified Data.Conduit as C
import qualified Data.HashMap.Strict as H import Data.Conduit.Binary (sourceHandleRange)
import Data.Default (def)
import qualified Data.Map as Map
import qualified Data.Char as C
import qualified Data.Text as T import qualified Data.Text as T
import qualified Data.Time.Clock as Time import qualified Data.ByteString as B
import Lib.Prelude
import Network.HTTP.Client (defaultManagerSettings) import Network.HTTP.Conduit (Response)
import qualified Network.HTTP.Client as NClient
import Network.HTTP.Conduit (Response)
import qualified Network.HTTP.Conduit as NC import qualified Network.HTTP.Conduit as NC
import Network.HTTP.Types (simpleQueryToQuery)
import qualified Network.HTTP.Types as HT import qualified Network.HTTP.Types as HT
import Network.HTTP.Types.Header (hHost) import Network.HTTP.Types.Header (hHost)
import Network.Minio.APICommon
import Network.Minio.Credentials import Lib.Prelude
import Network.Minio.Data
import Network.Minio.Errors import Network.Minio.Data
import Network.Minio.Sign.V4 import Network.Minio.Data.Crypto
import Network.Minio.Utils import Network.Minio.Errors
import Network.Minio.XmlParser import Network.Minio.Sign.V4
import Network.Minio.Utils
import Network.Minio.XmlParser
sha256Header :: ByteString -> HT.Header
sha256Header = ("x-amz-content-sha256", )
getPayloadSHA256Hash :: (MonadIO m) => Payload -> m ByteString
getPayloadSHA256Hash (PayloadBS bs) = return $ hashSHA256 bs
getPayloadSHA256Hash (PayloadH h off size) = hashSHA256FromSource $
sourceHandleRange h
(return . fromIntegral $ off)
(return . fromIntegral $ size)
getRequestBody :: Payload -> NC.RequestBody
getRequestBody (PayloadBS bs) = NC.RequestBodyBS bs
getRequestBody (PayloadH h off size) =
NC.requestBodySource (fromIntegral size) $
sourceHandleRange h
(return . fromIntegral $ off)
(return . fromIntegral $ size)
-- | Fetch bucket location (region) -- | Fetch bucket location (region)
getLocation :: Bucket -> Minio Region getLocation :: Bucket -> Minio Region
getLocation bucket = do getLocation bucket = do
resp <- resp <- executeRequest $ def {
executeRequest $ riBucket = Just bucket
defaultS3ReqInfo , riQueryParams = [("location", Nothing)]
{ riBucket = Just bucket, , riNeedsLocation = False
riQueryParams = [("location", Nothing)], }
riNeedsLocation = False
}
parseLocation $ NC.responseBody resp parseLocation $ NC.responseBody resp
-- | Looks for region in RegionMap and updates it using getLocation if -- | Looks for region in RegionMap and updates it using getLocation if
-- absent. -- absent.
discoverRegion :: S3ReqInfo -> Minio (Maybe Region) discoverRegion :: RequestInfo -> Minio (Maybe Region)
discoverRegion ri = runMaybeT $ do discoverRegion ri = runMaybeT $ do
bucket <- MaybeT $ return $ riBucket ri bucket <- MaybeT $ return $ riBucket ri
regionMay <- lift $ lookupRegionCache bucket regionMay <- gets (Map.lookup bucket)
maybe maybe (do
( do l <- lift $ getLocation bucket
l <- lift $ getLocation bucket modify $ Map.insert bucket l
lift $ addToRegionCache bucket l return l
return l ) return regionMay
)
return
regionMay
-- | Returns the region to be used for the request.
getRegion :: S3ReqInfo -> Minio (Maybe Region)
getRegion ri = do
ci <- asks mcConnInfo
-- getService/makeBucket/getLocation -- don't need location buildRequest :: RequestInfo -> Minio NC.Request
if
| not $ riNeedsLocation ri ->
return $ Just $ connectRegion ci
-- if autodiscovery of location is disabled by user
| not $ connectAutoDiscoverRegion ci ->
return $ Just $ connectRegion ci
-- discover the region for the request
| otherwise -> discoverRegion ri
getRegionHost :: Region -> Minio Text
getRegionHost r = do
ci <- asks mcConnInfo
if "amazonaws.com" `T.isSuffixOf` connectHost ci
then
maybe
(throwIO $ MErrVRegionNotSupported r)
return
(H.lookup r awsRegionMap)
else return $ connectHost ci
-- | Computes the appropriate host, path and region for the request.
--
-- For AWS, always use virtual bucket style, unless bucket has periods. For
-- MinIO and other non-AWS, default to path style.
getHostPathRegion :: S3ReqInfo -> Minio (Text, ByteString, Maybe Region)
getHostPathRegion ri = do
ci <- asks mcConnInfo
regionMay <- getRegion ri
case riBucket ri of
Nothing ->
-- Implies a ListBuckets request.
return (connectHost ci, "/", regionMay)
Just bucket -> do
regionHost <- case regionMay of
Nothing -> return $ connectHost ci
Just "" -> return $ connectHost ci
Just r -> getRegionHost r
let pathStyle =
( regionHost,
getS3Path (riBucket ri) (riObject ri),
regionMay
)
virtualStyle =
( bucket <> "." <> regionHost,
encodeUtf8 $ "/" <> fromMaybe "" (riObject ri),
regionMay
)
( if isAWSConnectInfo ci
then
return $
if bucketHasPeriods bucket
then pathStyle
else virtualStyle
else return pathStyle
)
-- | requestSTSCredential requests temporary credentials using the Security Token
-- Service API. The returned credential will include a populated 'SessionToken'
-- and an 'ExpiryTime'.
requestSTSCredential :: (STSCredentialProvider p) => p -> IO (CredentialValue, ExpiryTime)
requestSTSCredential p = do
endpoint <- maybe (throwIO $ MErrValidation MErrVSTSEndpointNotFound) return $ getSTSEndpoint p
let endPt = NC.parseRequest_ $ toString endpoint
settings
| NC.secure endPt = NC.tlsManagerSettings
| otherwise = defaultManagerSettings
mgr <- NC.newManager settings
liftIO $ retrieveSTSCredentials p ("", 0, False) mgr
buildRequest :: S3ReqInfo -> Minio NC.Request
buildRequest ri = do buildRequest ri = do
maybe (return ()) checkBucketNameValidity $ riBucket ri maybe (return ()) checkBucketNameValidity $ riBucket ri
maybe (return ()) checkObjectNameValidity $ riObject ri maybe (return ()) checkObjectNameValidity $ riObject ri
ci <- asks mcConnInfo ci <- asks mcConnInfo
(host, path, regionMay) <- getHostPathRegion ri -- getService/makeBucket/getLocation -- don't need
-- location
region <- if | not $ riNeedsLocation ri ->
return $ Just $ connectRegion ci
let ci' = ci {connectHost = host} -- if autodiscovery of location is disabled by user
hostHeader = (hHost, getHostAddr ci') | not $ connectAutoDiscoverRegion ci ->
ri' = return $ Just $ connectRegion ci
ri
{ riHeaders = hostHeader : riHeaders ri,
riRegion = regionMay
}
-- Does not contain body and auth info.
baseRequest =
NC.defaultRequest
{ NC.method = riMethod ri',
NC.secure = connectIsSecure ci',
NC.host = encodeUtf8 $ connectHost ci',
NC.port = connectPort ci',
NC.path = path,
NC.requestHeaders = riHeaders ri',
NC.queryString = HT.renderQuery False $ riQueryParams ri'
}
timeStamp <- liftIO Time.getCurrentTime -- discover the region for the request
| otherwise -> discoverRegion ri
mgr <- asks mcConnManager regionHost <- case region of
cv <- liftIO $ getCredential (connectCreds ci') (getEndpoint ci') mgr Nothing -> return $ connectHost ci
Just r -> if "amazonaws.com" `T.isSuffixOf` connectHost ci
then maybe
(throwM $ MErrVRegionNotSupported r)
return
(Map.lookup r awsRegionMap)
else return $ connectHost ci
let sp = sha256Hash <- if | connectIsSecure ci ->
SignParams -- if secure connection
(coerce $ cvAccessKey cv) return "UNSIGNED-PAYLOAD"
(coerce $ cvSecretKey cv)
(coerce $ cvSessionToken cv)
ServiceS3
timeStamp
(riRegion ri')
(riPresignExpirySecs ri')
Nothing
-- Cases to handle: -- otherwise compute sha256
-- | otherwise -> getPayloadSHA256Hash (riPayload ri)
-- 0. Handle presign URL case.
--
-- 1. Connection is secure: use unsigned payload
--
-- 2. Insecure connection, streaming signature is enabled via use of
-- conduit payload: use streaming signature for request.
--
-- 3. Insecure connection, non-conduit payload: compute payload
-- sha256hash, buffer request in memory and perform request.
if let hostHeader = (hHost, formatBS "{}:{}" [connectHost ci,
| isJust (riPresignExpirySecs ri') -> show $ connectPort ci])
-- case 0 from above.
do
let signPairs = signV4QueryParams sp baseRequest
qpToAdd = simpleQueryToQuery signPairs
existingQueryParams = HT.parseQuery (NC.queryString baseRequest)
updatedQueryParams = existingQueryParams ++ qpToAdd
return $ NClient.setQueryString updatedQueryParams baseRequest
| isStreamingPayload (riPayload ri') && not (connectIsSecure ci') ->
-- case 2 from above.
do
(pLen, pSrc) <- case riPayload ri of
PayloadC l src -> return (l, src)
_ -> throwIO MErrVUnexpectedPayload
let reqFn = signV4Stream pLen sp baseRequest
return $ reqFn pSrc
| otherwise ->
do
sp' <-
( if connectIsSecure ci'
then -- case 1 described above.
return sp
else
( -- case 3 described above.
do
pHash <- getPayloadSHA256Hash $ riPayload ri'
return $ sp {spPayloadHash = Just pHash}
)
)
let signHeaders = signV4 sp' baseRequest newRi = ri { riPayloadHash = Just sha256Hash
return $ , riHeaders = hostHeader
baseRequest : sha256Header sha256Hash
{ NC.requestHeaders = : riHeaders ri
NC.requestHeaders baseRequest ++ signHeaders, , riRegion = region
NC.requestBody = getRequestBody (riPayload ri') }
} newCi = ci { connectHost = regionHost }
retryAPIRequest :: Minio a -> Minio a signHeaders <- liftIO $ signV4 newCi newRi Nothing
retryAPIRequest apiCall = do
resE <-
retrying retryPolicy (const shouldRetry) $
const $
try apiCall
either throwIO return resE
where
-- Retry using the full-jitter backoff method for up to 10 mins
-- total
retryPolicy =
limitRetriesByCumulativeDelay tenMins $
fullJitterBackoff oneMilliSecond
oneMilliSecond = 1000 -- in microseconds
tenMins = 10 * 60 * 1000000 -- in microseconds
-- retry on connection related failure
shouldRetry :: Either NC.HttpException a -> Minio Bool
shouldRetry resE =
case resE of
-- API request returned successfully
Right _ -> return False
-- API request failed with a retryable exception
Left httpExn@(NC.HttpExceptionRequest _ exn) ->
case (exn :: NC.HttpExceptionContent) of
NC.ResponseTimeout -> return True
NC.ConnectionTimeout -> return True
NC.ConnectionFailure _ -> return True
-- We received an unexpected exception
_ -> throwIO httpExn
-- We received an unexpected exception
Left someOtherExn -> throwIO someOtherExn
executeRequest :: S3ReqInfo -> Minio (Response LByteString) return NC.defaultRequest {
NC.method = riMethod newRi
, NC.secure = connectIsSecure newCi
, NC.host = encodeUtf8 $ connectHost newCi
, NC.port = connectPort newCi
, NC.path = getPathFromRI newRi
, NC.queryString = HT.renderQuery False $ riQueryParams newRi
, NC.requestHeaders = riHeaders newRi ++ mkHeaderFromPairs signHeaders
, NC.requestBody = getRequestBody (riPayload newRi)
}
executeRequest :: RequestInfo -> Minio (Response LByteString)
executeRequest ri = do executeRequest ri = do
req <- buildRequest ri req <- buildRequest ri
mgr <- asks mcConnManager mgr <- asks mcConnManager
retryAPIRequest $ httpLbs req mgr httpLbs req mgr
mkStreamRequest ::
S3ReqInfo -> mkStreamRequest :: RequestInfo
Minio (Response (C.ConduitM () ByteString Minio ())) -> Minio (Response (C.ResumableSource Minio ByteString))
mkStreamRequest ri = do mkStreamRequest ri = do
req <- buildRequest ri req <- buildRequest ri
mgr <- asks mcConnManager mgr <- asks mcConnManager
retryAPIRequest $ http req mgr http req mgr
-- Bucket name validity check according to AWS rules. -- Bucket name validity check according to AWS rules.
isValidBucketName :: Bucket -> Bool isValidBucketName :: Bucket -> Bool
isValidBucketName bucket = isValidBucketName bucket =
not not (or [ len < 3 || len > 63
( or , or (map labelCheck labels)
[ len < 3 || len > 63, , or (map labelCharsCheck labels)
any labelCheck labels, , isIPCheck
any labelCharsCheck labels, ])
isIPCheck
]
)
where where
len = T.length bucket len = T.length bucket
labels = T.splitOn "." bucket labels = T.splitOn "." bucket
-- does label `l` fail basic checks of length and start/end? -- does label `l` fail basic checks of length and start/end?
labelCheck l = T.length l == 0 || T.head l == '-' || T.last l == '-' labelCheck l = T.length l == 0 || T.head l == '-' || T.last l == '-'
-- does label `l` have non-allowed characters? -- does label `l` have non-allowed characters?
labelCharsCheck l = labelCharsCheck l = isJust $ T.find (\x -> not (C.isAsciiLower x ||
isJust $ x == '-' ||
T.find C.isDigit x)) l
( \x ->
not
( C.isAsciiLower x
|| x == '-'
|| C.isDigit x
)
)
l
-- does label `l` have non-digit characters? -- does label `l` have non-digit characters?
labelNonDigits l = isJust $ T.find (not . C.isDigit) l labelNonDigits l = isJust $ T.find (not . C.isDigit) l
labelAsNums = map (not . labelNonDigits) labels labelAsNums = map (not . labelNonDigits) labels
-- check if bucket name looks like an IP -- check if bucket name looks like an IP
isIPCheck = and labelAsNums && length labelAsNums == 4 isIPCheck = and labelAsNums && length labelAsNums == 4
-- Throws exception iff bucket name is invalid according to AWS rules. -- Throws exception iff bucket name is invalid according to AWS rules.
checkBucketNameValidity :: (MonadIO m) => Bucket -> m () checkBucketNameValidity :: MonadThrow m => Bucket -> m ()
checkBucketNameValidity bucket = checkBucketNameValidity bucket =
unless (isValidBucketName bucket) $ when (not $ isValidBucketName bucket) $
throwIO $ throwM $ MErrVInvalidBucketName bucket
MErrVInvalidBucketName bucket
isValidObjectName :: Object -> Bool isValidObjectName :: Object -> Bool
isValidObjectName object = isValidObjectName object =
T.length object > 0 && B.length (encodeUtf8 object) <= 1024 T.length object > 0 && B.length (encodeUtf8 object) <= 1024
checkObjectNameValidity :: (MonadIO m) => Object -> m () checkObjectNameValidity :: MonadThrow m => Object -> m ()
checkObjectNameValidity object = checkObjectNameValidity object =
unless (isValidObjectName object) $ when (not $ isValidObjectName object) $
throwIO $ throwM $ MErrVInvalidObjectName object
MErrVInvalidObjectName object

View File

@ -1,80 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.APICommon where
import qualified Conduit as C
import qualified Data.ByteString as BS
import qualified Data.ByteString.Lazy as LB
import Data.Conduit.Binary (sourceHandleRange)
import qualified Data.Text as T
import Lib.Prelude
import qualified Network.HTTP.Conduit as NC
import qualified Network.HTTP.Types as HT
import Network.Minio.Data
import Network.Minio.Data.Crypto
import Network.Minio.Errors
sha256Header :: ByteString -> HT.Header
sha256Header = ("x-amz-content-sha256",)
-- | This function throws an error if the payload is a conduit (as it
-- will not be possible to re-read the conduit after it is consumed).
getPayloadSHA256Hash :: Payload -> Minio ByteString
getPayloadSHA256Hash (PayloadBS bs) = return $ hashSHA256 bs
getPayloadSHA256Hash (PayloadH h off size) =
hashSHA256FromSource $
sourceHandleRange
h
(return . fromIntegral $ off)
(return . fromIntegral $ size)
getPayloadSHA256Hash (PayloadC _ _) = throwIO MErrVUnexpectedPayload
getRequestBody :: Payload -> NC.RequestBody
getRequestBody (PayloadBS bs) = NC.RequestBodyBS bs
getRequestBody (PayloadH h off size) =
NC.requestBodySource size $
sourceHandleRange
h
(return . fromIntegral $ off)
(return . fromIntegral $ size)
getRequestBody (PayloadC n src) = NC.requestBodySource n src
mkStreamingPayload :: Payload -> Payload
mkStreamingPayload payload =
case payload of
PayloadBS bs ->
PayloadC
(fromIntegral $ BS.length bs)
(C.sourceLazy $ LB.fromStrict bs)
PayloadH h off len ->
PayloadC len $
sourceHandleRange
h
(return . fromIntegral $ off)
(return . fromIntegral $ len)
_ -> payload
isStreamingPayload :: Payload -> Bool
isStreamingPayload (PayloadC _ _) = True
isStreamingPayload _ = False
-- | Checks if the connect info is for Amazon S3.
isAWSConnectInfo :: ConnectInfo -> Bool
isAWSConnectInfo ci = ".amazonaws.com" `T.isSuffixOf` connectHost ci
bucketHasPeriods :: Bucket -> Bool
bucketHasPeriods b = isJust $ T.find (== '.') b

View File

@ -1,711 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2018-2023 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.AdminAPI
( -- * MinIO Admin API
--------------------
-- | Provides MinIO admin API and related types. It is in
-- experimental state.
DriveInfo (..),
ErasureInfo (..),
Backend (..),
ConnStats (..),
HttpStats (..),
ServerProps (..),
CountNAvgTime (..),
StorageClass (..),
StorageInfo (..),
SIData (..),
ServerInfo (..),
getServerInfo,
HealOpts (..),
HealResultItem (..),
HealStatus (..),
HealStartResp (..),
startHeal,
forceStartHeal,
getHealStatus,
SetConfigResult (..),
NodeSummary (..),
setConfig,
getConfig,
ServerVersion (..),
ServiceStatus (..),
serviceStatus,
ServiceAction (..),
serviceSendAction,
)
where
import Data.Aeson
( FromJSON,
ToJSON,
Value (Object),
eitherDecode,
object,
pairs,
parseJSON,
toEncoding,
toJSON,
withObject,
withText,
(.:),
(.:?),
(.=),
)
import qualified Data.Aeson as A
import Data.Aeson.Types (typeMismatch)
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as LBS
import qualified Data.Text as T
import Data.Time (NominalDiffTime, getCurrentTime)
import Lib.Prelude
import Network.HTTP.Conduit (Response)
import qualified Network.HTTP.Conduit as NC
import qualified Network.HTTP.Types as HT
import Network.HTTP.Types.Header (hHost)
import Network.Minio.APICommon
import Network.Minio.Credentials
import Network.Minio.Data
import Network.Minio.Errors
import Network.Minio.Sign.V4
import Network.Minio.Utils
data DriveInfo = DriveInfo
{ diUuid :: Text,
diEndpoint :: Text,
diState :: Text
}
deriving stock (Show, Eq)
instance FromJSON DriveInfo where
parseJSON = withObject "DriveInfo" $ \v ->
DriveInfo
<$> v
.: "uuid"
<*> v
.: "endpoint"
<*> v
.: "state"
data StorageClass = StorageClass
{ scParity :: Int,
scData :: Int
}
deriving stock (Show, Eq)
data ErasureInfo = ErasureInfo
{ eiOnlineDisks :: Int,
eiOfflineDisks :: Int,
eiStandard :: StorageClass,
eiReducedRedundancy :: StorageClass,
eiSets :: [[DriveInfo]]
}
deriving stock (Show, Eq)
instance FromJSON ErasureInfo where
parseJSON = withObject "ErasureInfo" $ \v -> do
onlineDisks <- v .: "OnlineDisks"
offlineDisks <- v .: "OfflineDisks"
stdClass <-
StorageClass
<$> v
.: "StandardSCData"
<*> v
.: "StandardSCParity"
rrClass <-
StorageClass
<$> v
.: "RRSCData"
<*> v
.: "RRSCParity"
sets <- v .: "Sets"
return $ ErasureInfo onlineDisks offlineDisks stdClass rrClass sets
data Backend
= BackendFS
| BackendErasure ErasureInfo
deriving stock (Show, Eq)
instance FromJSON Backend where
parseJSON = withObject "Backend" $ \v -> do
typ <- v .: "Type"
case typ :: Int of
1 -> return BackendFS
2 -> BackendErasure <$> parseJSON (Object v)
_ -> typeMismatch "BackendType" (Object v)
data ConnStats = ConnStats
{ csTransferred :: Int64,
csReceived :: Int64
}
deriving stock (Show, Eq)
instance FromJSON ConnStats where
parseJSON = withObject "ConnStats" $ \v ->
ConnStats
<$> v
.: "transferred"
<*> v
.: "received"
data ServerProps = ServerProps
{ spUptime :: NominalDiffTime,
spVersion :: Text,
spCommitId :: Text,
spRegion :: Text,
spSqsArns :: [Text]
}
deriving stock (Show, Eq)
instance FromJSON ServerProps where
parseJSON = withObject "SIServer" $ \v -> do
uptimeNs <- v .: "uptime"
let uptime = uptimeNs / 1e9
ver <- v .: "version"
commitId <- v .: "commitID"
region <- v .: "region"
arn <- v .: "sqsARN"
return $ ServerProps uptime ver commitId region arn
data StorageInfo = StorageInfo
{ siUsed :: Int64,
siBackend :: Backend
}
deriving stock (Show, Eq)
instance FromJSON StorageInfo where
parseJSON = withObject "StorageInfo" $ \v ->
StorageInfo
<$> v
.: "Used"
<*> v
.: "Backend"
data CountNAvgTime = CountNAvgTime
{ caCount :: Int64,
caAvgDuration :: Text
}
deriving stock (Show, Eq)
instance FromJSON CountNAvgTime where
parseJSON = withObject "CountNAvgTime" $ \v ->
CountNAvgTime
<$> v
.: "count"
<*> v
.: "avgDuration"
data HttpStats = HttpStats
{ hsTotalHeads :: CountNAvgTime,
hsSuccessHeads :: CountNAvgTime,
hsTotalGets :: CountNAvgTime,
hsSuccessGets :: CountNAvgTime,
hsTotalPuts :: CountNAvgTime,
hsSuccessPuts :: CountNAvgTime,
hsTotalPosts :: CountNAvgTime,
hsSuccessPosts :: CountNAvgTime,
hsTotalDeletes :: CountNAvgTime,
hsSuccessDeletes :: CountNAvgTime
}
deriving stock (Show, Eq)
instance FromJSON HttpStats where
parseJSON = withObject "HttpStats" $ \v ->
HttpStats
<$> v
.: "totalHEADs"
<*> v
.: "successHEADs"
<*> v
.: "totalGETs"
<*> v
.: "successGETs"
<*> v
.: "totalPUTs"
<*> v
.: "successPUTs"
<*> v
.: "totalPOSTs"
<*> v
.: "successPOSTs"
<*> v
.: "totalDELETEs"
<*> v
.: "successDELETEs"
data SIData = SIData
{ sdStorage :: StorageInfo,
sdConnStats :: ConnStats,
sdHttpStats :: HttpStats,
sdProps :: ServerProps
}
deriving stock (Show, Eq)
instance FromJSON SIData where
parseJSON = withObject "SIData" $ \v ->
SIData
<$> v
.: "storage"
<*> v
.: "network"
<*> v
.: "http"
<*> v
.: "server"
data ServerInfo = ServerInfo
{ siError :: Text,
siAddr :: Text,
siData :: SIData
}
deriving stock (Show, Eq)
instance FromJSON ServerInfo where
parseJSON = withObject "ServerInfo" $ \v ->
ServerInfo
<$> v
.: "error"
<*> v
.: "addr"
<*> v
.: "data"
data ServerVersion = ServerVersion
{ svVersion :: Text,
svCommitId :: Text
}
deriving stock (Show, Eq)
instance FromJSON ServerVersion where
parseJSON = withObject "ServerVersion" $ \v ->
ServerVersion
<$> v
.: "version"
<*> v
.: "commitID"
data ServiceStatus = ServiceStatus
{ ssVersion :: ServerVersion,
ssUptime :: NominalDiffTime
}
deriving stock (Show, Eq)
instance FromJSON ServiceStatus where
parseJSON = withObject "ServiceStatus" $ \v -> do
serverVersion <- v .: "serverVersion"
uptimeNs <- v .: "uptime"
let uptime = uptimeNs / 1e9
return $ ServiceStatus serverVersion uptime
data ServiceAction
= ServiceActionRestart
| ServiceActionStop
deriving stock (Show, Eq)
instance ToJSON ServiceAction where
toJSON a = object ["action" .= serviceActionToText a]
serviceActionToText :: ServiceAction -> Text
serviceActionToText a = case a of
ServiceActionRestart -> "restart"
ServiceActionStop -> "stop"
adminPath :: ByteString
adminPath = "/minio/admin"
data HealStartResp = HealStartResp
{ hsrClientToken :: Text,
hsrClientAddr :: Text,
hsrStartTime :: UTCTime
}
deriving stock (Show, Eq)
instance FromJSON HealStartResp where
parseJSON = withObject "HealStartResp" $ \v ->
HealStartResp
<$> v
.: "clientToken"
<*> v
.: "clientAddress"
<*> v
.: "startTime"
data HealOpts = HealOpts
{ hoRecursive :: Bool,
hoDryRun :: Bool
}
deriving stock (Show, Eq)
instance ToJSON HealOpts where
toJSON (HealOpts r d) =
object ["recursive" .= r, "dryRun" .= d]
toEncoding (HealOpts r d) =
pairs ("recursive" .= r <> "dryRun" .= d)
instance FromJSON HealOpts where
parseJSON = withObject "HealOpts" $ \v ->
HealOpts
<$> v
.: "recursive"
<*> v
.: "dryRun"
data HealItemType
= HealItemMetadata
| HealItemBucket
| HealItemBucketMetadata
| HealItemObject
deriving stock (Show, Eq)
instance FromJSON HealItemType where
parseJSON = withText "HealItemType" $ \v -> case v of
"metadata" -> return HealItemMetadata
"bucket" -> return HealItemBucket
"object" -> return HealItemObject
"bucket-metadata" -> return HealItemBucketMetadata
_ -> typeMismatch "HealItemType" (A.String v)
data NodeSummary = NodeSummary
{ nsName :: Text,
nsErrSet :: Bool,
nsErrMessage :: Text
}
deriving stock (Show, Eq)
instance FromJSON NodeSummary where
parseJSON = withObject "NodeSummary" $ \v ->
NodeSummary
<$> v
.: "name"
<*> v
.: "errSet"
<*> v
.: "errMsg"
data SetConfigResult = SetConfigResult
{ scrStatus :: Bool,
scrNodeSummary :: [NodeSummary]
}
deriving stock (Show, Eq)
instance FromJSON SetConfigResult where
parseJSON = withObject "SetConfigResult" $ \v ->
SetConfigResult
<$> v
.: "status"
<*> v
.: "nodeResults"
data HealResultItem = HealResultItem
{ hriResultIdx :: Int,
hriType :: HealItemType,
hriBucket :: Bucket,
hriObject :: Object,
hriDetail :: Text,
hriParityBlocks :: Maybe Int,
hriDataBlocks :: Maybe Int,
hriDiskCount :: Int,
hriSetCount :: Int,
hriObjectSize :: Int,
hriBefore :: [DriveInfo],
hriAfter :: [DriveInfo]
}
deriving stock (Show, Eq)
instance FromJSON HealResultItem where
parseJSON = withObject "HealResultItem" $ \v ->
HealResultItem
<$> v
.: "resultId"
<*> v
.: "type"
<*> v
.: "bucket"
<*> v
.: "object"
<*> v
.: "detail"
<*> v
.:? "parityBlocks"
<*> v
.:? "dataBlocks"
<*> v
.: "diskCount"
<*> v
.: "setCount"
<*> v
.: "objectSize"
<*> ( do
before <- v .: "before"
before .: "drives"
)
<*> ( do
after <- v .: "after"
after .: "drives"
)
data HealStatus = HealStatus
{ hsSummary :: Text,
hsStartTime :: UTCTime,
hsSettings :: HealOpts,
hsNumDisks :: Int,
hsFailureDetail :: Maybe Text,
hsItems :: Maybe [HealResultItem]
}
deriving stock (Show, Eq)
instance FromJSON HealStatus where
parseJSON = withObject "HealStatus" $ \v ->
HealStatus
<$> v
.: "Summary"
<*> v
.: "StartTime"
<*> v
.: "Settings"
<*> v
.: "NumDisks"
<*> v
.:? "Detail"
<*> v
.: "Items"
healPath :: Maybe Bucket -> Maybe Text -> ByteString
healPath bucket prefix = do
if isJust bucket
then
encodeUtf8 $
"v1/heal/"
<> fromMaybe "" bucket
<> "/"
<> fromMaybe "" prefix
else encodeUtf8 ("v1/heal/" :: Text)
-- | Get server version and uptime.
serviceStatus :: Minio ServiceStatus
serviceStatus = do
rsp <-
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodGet,
ariPayload = PayloadBS B.empty,
ariPayloadHash = Nothing,
ariPath = "v1/service",
ariHeaders = [],
ariQueryParams = []
}
let rspBS = NC.responseBody rsp
case eitherDecode rspBS of
Right ss -> return ss
Left err -> throwIO $ MErrVJsonParse $ T.pack err
-- | Send service restart or stop action to MinIO server.
serviceSendAction :: ServiceAction -> Minio ()
serviceSendAction action = do
let payload = PayloadBS $ LBS.toStrict $ A.encode action
void $
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodPost,
ariPayload = payload,
ariPayloadHash = Nothing,
ariPath = "v1/service",
ariHeaders = [],
ariQueryParams = []
}
-- | Get the current config file from server.
getConfig :: Minio ByteString
getConfig = do
rsp <-
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodGet,
ariPayload = PayloadBS B.empty,
ariPayloadHash = Nothing,
ariPath = "v1/config",
ariHeaders = [],
ariQueryParams = []
}
return $ LBS.toStrict $ NC.responseBody rsp
-- | Set a new config to the server.
setConfig :: ByteString -> Minio SetConfigResult
setConfig config = do
rsp <-
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodPut,
ariPayload = PayloadBS config,
ariPayloadHash = Nothing,
ariPath = "v1/config",
ariHeaders = [],
ariQueryParams = []
}
let rspBS = NC.responseBody rsp
case eitherDecode rspBS of
Right scr -> return scr
Left err -> throwIO $ MErrVJsonParse $ T.pack err
-- | Get the progress of currently running heal task, this API should be
-- invoked right after `startHeal`. `token` is obtained after `startHeal`
-- which should be used to get the heal status.
getHealStatus :: Maybe Bucket -> Maybe Text -> Text -> Minio HealStatus
getHealStatus bucket prefix token = do
when (isNothing bucket && isJust prefix) $ throwIO MErrVInvalidHealPath
let qparams = HT.queryTextToQuery [("clientToken", Just token)]
rsp <-
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodPost,
ariPayload = PayloadBS B.empty,
ariPayloadHash = Nothing,
ariPath = healPath bucket prefix,
ariHeaders = [],
ariQueryParams = qparams
}
let rspBS = NC.responseBody rsp
case eitherDecode rspBS of
Right hs -> return hs
Left err -> throwIO $ MErrVJsonParse $ T.pack err
doHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Bool -> Minio HealStartResp
doHeal bucket prefix opts forceStart = do
when (isNothing bucket && isJust prefix) $ throwIO MErrVInvalidHealPath
let payload = PayloadBS $ LBS.toStrict $ A.encode opts
let qparams =
bool
[]
(HT.queryTextToQuery [("forceStart", Just "true")])
forceStart
rsp <-
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodPost,
ariPayload = payload,
ariPayloadHash = Nothing,
ariPath = healPath bucket prefix,
ariHeaders = [],
ariQueryParams = qparams
}
let rspBS = NC.responseBody rsp
case eitherDecode rspBS of
Right hsr -> return hsr
Left err -> throwIO $ MErrVJsonParse $ T.pack err
-- | Start a heal sequence that scans data under given (possible empty)
-- `bucket` and `prefix`. The `recursive` bool turns on recursive
-- traversal under the given path. `dryRun` does not mutate on-disk data,
-- but performs data validation. Two heal sequences on overlapping paths
-- may not be initiated. The progress of a heal should be followed using
-- the `HealStatus` API. The server accumulates results of the heal
-- traversal and waits for the client to receive and acknowledge
-- them using the status API
startHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Minio HealStartResp
startHeal bucket prefix opts = doHeal bucket prefix opts False
-- | Similar to start a heal sequence, but force start a new heal sequence
-- even if an active heal is under progress.
forceStartHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Minio HealStartResp
forceStartHeal bucket prefix opts = doHeal bucket prefix opts True
-- | Fetches information for all cluster nodes, such as server
-- properties, storage information, network statistics, etc.
getServerInfo :: Minio [ServerInfo]
getServerInfo = do
rsp <-
executeAdminRequest
AdminReqInfo
{ ariMethod = HT.methodGet,
ariPayload = PayloadBS B.empty,
ariPayloadHash = Nothing,
ariPath = "v1/info",
ariHeaders = [],
ariQueryParams = []
}
let rspBS = NC.responseBody rsp
case eitherDecode rspBS of
Right si -> return si
Left err -> throwIO $ MErrVJsonParse $ T.pack err
executeAdminRequest :: AdminReqInfo -> Minio (Response LByteString)
executeAdminRequest ari = do
req <- buildAdminRequest ari
mgr <- asks mcConnManager
httpLbs req mgr
buildAdminRequest :: AdminReqInfo -> Minio NC.Request
buildAdminRequest areq = do
ci <- asks mcConnInfo
sha256Hash <-
if connectIsSecure ci
then -- if secure connection
return "UNSIGNED-PAYLOAD"
else -- otherwise compute sha256
getPayloadSHA256Hash (ariPayload areq)
timeStamp <- liftIO getCurrentTime
mgr <- asks mcConnManager
cv <- liftIO $ getCredential (connectCreds ci) (getEndpoint ci) mgr
let hostHeader = (hHost, getHostAddr ci)
newAreq =
areq
{ ariPayloadHash = Just sha256Hash,
ariHeaders =
hostHeader
: sha256Header sha256Hash
: ariHeaders areq
}
signReq = toRequest ci newAreq
sp =
SignParams
(coerce $ cvAccessKey cv)
(coerce $ cvSecretKey cv)
(coerce $ cvSessionToken cv)
ServiceS3
timeStamp
Nothing
Nothing
(ariPayloadHash newAreq)
signHeaders = signV4 sp signReq
-- Update signReq with Authorization header containing v4 signature
return
signReq
{ NC.requestHeaders = ariHeaders newAreq ++ signHeaders
}
where
toRequest :: ConnectInfo -> AdminReqInfo -> NC.Request
toRequest ci aReq =
NC.defaultRequest
{ NC.method = ariMethod aReq,
NC.secure = connectIsSecure ci,
NC.host = encodeUtf8 $ connectHost ci,
NC.port = connectPort ci,
NC.path = B.intercalate "/" [adminPath, ariPath aReq],
NC.requestHeaders = ariHeaders aReq,
NC.queryString = HT.renderQuery False $ ariQueryParams aReq,
NC.requestBody = getRequestBody (ariPayload aReq)
}

View File

@ -1,106 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.CopyObject where
import qualified Data.List as List
import Lib.Prelude
import Network.Minio.Data
import Network.Minio.Errors
import Network.Minio.S3API
import Network.Minio.Utils
-- | Copy an object using single or multipart copy strategy.
copyObjectInternal ::
Bucket ->
Object ->
SourceInfo ->
Minio ETag
copyObjectInternal b' o srcInfo = do
let sBucket = srcBucket srcInfo
sObject = srcObject srcInfo
-- get source object size with a head request
oi <- headObject sBucket sObject []
let srcSize = oiSize oi
-- check that byte offsets are valid if specified in cps
let rangeMay = srcRange srcInfo
range = maybe (0, srcSize) identity rangeMay
startOffset = fst range
endOffset = snd range
when
( isJust rangeMay
&& ( (startOffset < 0)
|| (endOffset < startOffset)
|| (endOffset >= srcSize)
)
)
$ throwIO
$ MErrVInvalidSrcObjByteRange range
-- 1. If sz > 64MiB (minPartSize) use multipart copy, OR
-- 2. If startOffset /= 0 use multipart copy
let destSize =
(\(a, b) -> b - a + 1) $
maybe (0, srcSize - 1) identity rangeMay
if destSize > minPartSize || (endOffset - startOffset + 1 /= srcSize)
then multiPartCopyObject b' o srcInfo srcSize
else fst <$> copyObjectSingle b' o srcInfo {srcRange = Nothing} []
-- | Given the input byte range of the source object, compute the
-- splits for a multipart copy object procedure. Minimum part size
-- used is minPartSize.
selectCopyRanges :: (Int64, Int64) -> [(PartNumber, (Int64, Int64))]
selectCopyRanges (st, end) =
zip pns $
zipWith (\x y -> (st + x, st + x + y - 1)) startOffsets partSizes
where
size = end - st + 1
(pns, startOffsets, partSizes) = List.unzip3 $ selectPartSizes size
-- | Perform a multipart copy object action. Since we cannot verify
-- existing parts based on the source object, there is no resuming
-- copy action support.
multiPartCopyObject ::
Bucket ->
Object ->
SourceInfo ->
Int64 ->
Minio ETag
multiPartCopyObject b o cps srcSize = do
uid <- newMultipartUpload b o []
let byteRange = maybe (0, srcSize - 1) identity $ srcRange cps
partRanges = selectCopyRanges byteRange
partSources =
map
(\(x, (start, end)) -> (x, cps {srcRange = Just (start, end)}))
partRanges
dstInfo = defaultDestinationInfo {dstBucket = b, dstObject = o}
copiedParts <-
limitedMapConcurrently
10
( \(pn, cps') -> do
(etag, _) <- copyObjectPart dstInfo cps' uid pn []
return (pn, etag)
)
partSources
completeMultipartUpload b o uid copiedParts

View File

@ -1,77 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.Credentials
( CredentialValue (..),
credentialValueText,
STSCredentialProvider (..),
AccessKey (..),
SecretKey (..),
SessionToken (..),
ExpiryTime (..),
STSCredentialStore,
initSTSCredential,
getSTSCredential,
Creds (..),
getCredential,
Endpoint,
-- * STS Assume Role
defaultSTSAssumeRoleOptions,
STSAssumeRole (..),
STSAssumeRoleOptions (..),
)
where
import Data.Time (diffUTCTime, getCurrentTime)
import qualified Network.HTTP.Client as NC
import Network.Minio.Credentials.AssumeRole
import Network.Minio.Credentials.Types
import qualified UnliftIO.MVar as M
data STSCredentialStore = STSCredentialStore
{ cachedCredentials :: M.MVar (CredentialValue, ExpiryTime),
refreshAction :: Endpoint -> NC.Manager -> IO (CredentialValue, ExpiryTime)
}
initSTSCredential :: (STSCredentialProvider p) => p -> IO STSCredentialStore
initSTSCredential p = do
let action = retrieveSTSCredentials p
-- start with dummy credential, so that refresh happens for first request.
now <- getCurrentTime
mvar <- M.newMVar (CredentialValue mempty mempty mempty, coerce now)
return $
STSCredentialStore
{ cachedCredentials = mvar,
refreshAction = action
}
getSTSCredential :: STSCredentialStore -> Endpoint -> NC.Manager -> IO (CredentialValue, Bool)
getSTSCredential store ep mgr = M.modifyMVar (cachedCredentials store) $ \cc@(v, expiry) -> do
now <- getCurrentTime
if diffUTCTime now (coerce expiry) > 0
then do
res <- refreshAction store ep mgr
return (res, (fst res, True))
else return (cc, (v, False))
data Creds
= CredsStatic CredentialValue
| CredsSTS STSCredentialStore
getCredential :: Creds -> Endpoint -> NC.Manager -> IO CredentialValue
getCredential (CredsStatic v) _ _ = return v
getCredential (CredsSTS s) ep mgr = fst <$> getSTSCredential s ep mgr

View File

@ -1,266 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.Credentials.AssumeRole where
import qualified Data.ByteArray as BA
import qualified Data.ByteString.Lazy as LB
import qualified Data.Text as T
import qualified Data.Time as Time
import Data.Time.Units (Second)
import Lib.Prelude (UTCTime, throwIO)
import Network.HTTP.Client (RequestBody (RequestBodyBS))
import qualified Network.HTTP.Client as NC
import Network.HTTP.Types (hContentType, methodPost, renderSimpleQuery)
import Network.HTTP.Types.Header (hHost)
import Network.Minio.Credentials.Types
import Network.Minio.Data.Crypto (hashSHA256)
import Network.Minio.Errors (MErrV (..))
import Network.Minio.Sign.V4
import Network.Minio.Utils (getHostHeader, httpLbs)
import Network.Minio.XmlCommon
import Text.XML.Cursor hiding (bool)
stsVersion :: ByteString
stsVersion = "2011-06-15"
defaultDurationSeconds :: Second
defaultDurationSeconds = 3600
-- | Assume Role API argument.
--
-- @since 1.7.0
data STSAssumeRole = STSAssumeRole
{ -- | Credentials to use in the AssumeRole STS API.
sarCredentials :: CredentialValue,
-- | Optional settings.
sarOptions :: STSAssumeRoleOptions
}
-- | Options for STS Assume Role API.
data STSAssumeRoleOptions = STSAssumeRoleOptions
{ -- | STS endpoint to which the request will be made. For MinIO, this is the
-- same as the server endpoint. For AWS, this has to be the Security Token
-- Service endpoint. If using with 'setSTSCredential', this option can be
-- left as 'Nothing' and the endpoint in 'ConnectInfo' will be used.
saroEndpoint :: Maybe Text,
-- | Desired validity for the generated credentials.
saroDurationSeconds :: Maybe Second,
-- | IAM policy to apply for the generated credentials.
saroPolicyJSON :: Maybe ByteString,
-- | Location is usually required for AWS.
saroLocation :: Maybe Text,
saroRoleARN :: Maybe Text,
saroRoleSessionName :: Maybe Text
}
-- | Default STS Assume Role options - all options are Nothing, except for
-- duration which is set to 1 hour.
defaultSTSAssumeRoleOptions :: STSAssumeRoleOptions
defaultSTSAssumeRoleOptions =
STSAssumeRoleOptions
{ saroEndpoint = Nothing,
saroDurationSeconds = Just 3600,
saroPolicyJSON = Nothing,
saroLocation = Nothing,
saroRoleARN = Nothing,
saroRoleSessionName = Nothing
}
data AssumeRoleCredentials = AssumeRoleCredentials
{ arcCredentials :: CredentialValue,
arcExpiration :: UTCTime
}
deriving stock (Show, Eq)
data AssumeRoleResult = AssumeRoleResult
{ arrSourceIdentity :: Text,
arrAssumedRoleArn :: Text,
arrAssumedRoleId :: Text,
arrRoleCredentials :: AssumeRoleCredentials
}
deriving stock (Show, Eq)
-- | parseSTSAssumeRoleResult parses an XML response of the following form:
--
-- <AssumeRoleResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/">
-- <AssumeRoleResult>
-- <SourceIdentity>Alice</SourceIdentity>
-- <AssumedRoleUser>
-- <Arn>arn:aws:sts::123456789012:assumed-role/demo/TestAR</Arn>
-- <AssumedRoleId>ARO123EXAMPLE123:TestAR</AssumedRoleId>
-- </AssumedRoleUser>
-- <Credentials>
-- <AccessKeyId>ASIAIOSFODNN7EXAMPLE</AccessKeyId>
-- <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY</SecretAccessKey>
-- <SessionToken>
-- AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW
-- LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd
-- QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU
-- 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz
-- +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==
-- </SessionToken>
-- <Expiration>2019-11-09T13:34:41Z</Expiration>
-- </Credentials>
-- <PackedPolicySize>6</PackedPolicySize>
-- </AssumeRoleResult>
-- <ResponseMetadata>
-- <RequestId>c6104cbe-af31-11e0-8154-cbc7ccf896c7</RequestId>
-- </ResponseMetadata>
-- </AssumeRoleResponse>
parseSTSAssumeRoleResult :: (MonadIO m) => ByteString -> Text -> m AssumeRoleResult
parseSTSAssumeRoleResult xmldata namespace = do
r <- parseRoot $ LB.fromStrict xmldata
let s3Elem' = s3Elem namespace
sourceIdentity =
T.concat $
r
$/ s3Elem' "AssumeRoleResult"
&/ s3Elem' "SourceIdentity"
&/ content
roleArn =
T.concat $
r
$/ s3Elem' "AssumeRoleResult"
&/ s3Elem' "AssumedRoleUser"
&/ s3Elem' "Arn"
&/ content
roleId =
T.concat $
r
$/ s3Elem' "AssumeRoleResult"
&/ s3Elem' "AssumedRoleUser"
&/ s3Elem' "AssumedRoleId"
&/ content
convSB :: Text -> BA.ScrubbedBytes
convSB = BA.convert . (encodeUtf8 :: Text -> ByteString)
credsInfo = do
cr <-
maybe (Left $ MErrVXmlParse "No Credentials Element found") Right $
listToMaybe $
r $/ s3Elem' "AssumeRoleResult" &/ s3Elem' "Credentials"
let cur = fromNode $ node cr
return
( CredentialValue
{ cvAccessKey =
coerce $
T.concat $
cur $/ s3Elem' "AccessKeyId" &/ content,
cvSecretKey =
coerce $
convSB $
T.concat $
cur
$/ s3Elem' "SecretAccessKey"
&/ content,
cvSessionToken =
Just $
coerce $
convSB $
T.concat $
cur
$/ s3Elem' "SessionToken"
&/ content
},
T.concat $ cur $/ s3Elem' "Expiration" &/ content
)
creds <- either throwIO pure credsInfo
expiry <- parseS3XMLTime $ snd creds
let roleCredentials =
AssumeRoleCredentials
{ arcCredentials = fst creds,
arcExpiration = expiry
}
return
AssumeRoleResult
{ arrSourceIdentity = sourceIdentity,
arrAssumedRoleArn = roleArn,
arrAssumedRoleId = roleId,
arrRoleCredentials = roleCredentials
}
instance STSCredentialProvider STSAssumeRole where
getSTSEndpoint = saroEndpoint . sarOptions
retrieveSTSCredentials sar (host', port', isSecure') mgr = do
-- Assemble STS request
let requiredParams =
[ ("Action", "AssumeRole"),
("Version", stsVersion)
]
opts = sarOptions sar
durSecs :: Int =
fromIntegral $
fromMaybe defaultDurationSeconds $
saroDurationSeconds opts
otherParams =
[ ("RoleArn",) . encodeUtf8 <$> saroRoleARN opts,
("RoleSessionName",) . encodeUtf8 <$> saroRoleSessionName opts,
Just ("DurationSeconds", show durSecs),
("Policy",) <$> saroPolicyJSON opts
]
parameters = requiredParams ++ catMaybes otherParams
(host, port, isSecure) =
case getSTSEndpoint sar of
Just ep ->
let endPt = NC.parseRequest_ $ toString ep
in (NC.host endPt, NC.port endPt, NC.secure endPt)
Nothing -> (host', port', isSecure')
reqBody = renderSimpleQuery False parameters
req =
NC.defaultRequest
{ NC.host = host,
NC.port = port,
NC.secure = isSecure,
NC.method = methodPost,
NC.requestHeaders =
[ (hHost, getHostHeader (host, port)),
(hContentType, "application/x-www-form-urlencoded")
],
NC.requestBody = RequestBodyBS reqBody
}
-- Sign the STS request.
timeStamp <- liftIO Time.getCurrentTime
let sp =
SignParams
{ spAccessKey = coerce $ cvAccessKey $ sarCredentials sar,
spSecretKey = coerce $ cvSecretKey $ sarCredentials sar,
spSessionToken = coerce $ cvSessionToken $ sarCredentials sar,
spService = ServiceSTS,
spTimeStamp = timeStamp,
spRegion = saroLocation opts,
spExpirySecs = Nothing,
spPayloadHash = Just $ hashSHA256 reqBody
}
signHeaders = signV4 sp req
signedReq =
req
{ NC.requestHeaders = NC.requestHeaders req ++ signHeaders
}
-- Make the STS request
resp <- httpLbs signedReq mgr
result <-
parseSTSAssumeRoleResult
(toStrict $ NC.responseBody resp)
"https://sts.amazonaws.com/doc/2011-06-15/"
return
( arcCredentials $ arrRoleCredentials result,
coerce $ arcExpiration $ arrRoleCredentials result
)

View File

@ -1,90 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE StrictData #-}
module Network.Minio.Credentials.Types where
import qualified Data.ByteArray as BA
import Lib.Prelude (UTCTime)
import qualified Network.HTTP.Client as NC
-- | Access Key type.
newtype AccessKey = AccessKey {unAccessKey :: Text}
deriving stock (Show)
deriving newtype (Eq, IsString, Semigroup, Monoid)
-- | Secret Key type - has a show instance that does not print the value.
newtype SecretKey = SecretKey {unSecretKey :: BA.ScrubbedBytes}
deriving stock (Show)
deriving newtype (Eq, IsString, Semigroup, Monoid)
-- | Session Token type - has a show instance that does not print the value.
newtype SessionToken = SessionToken {unSessionToken :: BA.ScrubbedBytes}
deriving stock (Show)
deriving newtype (Eq, IsString, Semigroup, Monoid)
-- | Object storage credential data type. It has support for the optional
-- [SessionToken](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html)
-- for using temporary credentials requested via STS.
--
-- The show instance for this type does not print the value of secrets for
-- security.
--
-- @since 1.7.0
data CredentialValue = CredentialValue
{ cvAccessKey :: AccessKey,
cvSecretKey :: SecretKey,
cvSessionToken :: Maybe SessionToken
}
deriving stock (Eq, Show)
scrubbedToText :: BA.ScrubbedBytes -> Text
scrubbedToText =
let b2t :: ByteString -> Text
b2t = decodeUtf8
s2b :: BA.ScrubbedBytes -> ByteString
s2b = BA.convert
in b2t . s2b
-- | Convert a 'CredentialValue' to a text tuple. Use this to output the
-- credential to files or other programs.
credentialValueText :: CredentialValue -> (Text, Text, Maybe Text)
credentialValueText cv =
( coerce $ cvAccessKey cv,
(scrubbedToText . coerce) $ cvSecretKey cv,
scrubbedToText . coerce <$> cvSessionToken cv
)
-- | Endpoint represented by host, port and TLS enabled flag.
type Endpoint = (ByteString, Int, Bool)
-- | Typeclass for STS credential providers.
--
-- @since 1.7.0
class STSCredentialProvider p where
retrieveSTSCredentials ::
p ->
-- | STS Endpoint (host, port, isSecure)
Endpoint ->
NC.Manager ->
IO (CredentialValue, ExpiryTime)
getSTSEndpoint :: p -> Maybe Text
-- | 'ExpiryTime' represents a time at which a credential expires.
newtype ExpiryTime = ExpiryTime {unExpiryTime :: UTCTime}
deriving stock (Show)
deriving newtype (Eq)

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -13,21 +13,23 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE FlexibleInstances #-}
module Network.Minio.Data.ByteString module Network.Minio.Data.ByteString
( stripBS, (
UriEncodable (..), stripBS
) , UriEncodable(..)
where ) where
import qualified Data.ByteString as B import qualified Data.ByteString as B
import qualified Data.ByteString.Builder as BB import qualified Data.ByteString.Builder as BB
import qualified Data.ByteString.Char8 as BC8 import qualified Data.ByteString.Char8 as BC8
import qualified Data.ByteString.Lazy as LB import qualified Data.ByteString.Lazy as LB
import Data.Char (isAsciiLower, isAsciiUpper, isDigit, isSpace, toUpper) import Data.Char (isSpace, toUpper, isAsciiUpper, isAsciiLower, isDigit)
import qualified Data.Text as T import qualified Data.Text as T
import Numeric (showHex) import Numeric (showHex)
import Lib.Prelude
stripBS :: ByteString -> ByteString stripBS :: ByteString -> ByteString
stripBS = BC8.dropWhile isSpace . fst . BC8.spanEnd isSpace stripBS = BC8.dropWhile isSpace . fst . BC8.spanEnd isSpace
@ -37,10 +39,8 @@ class UriEncodable s where
instance UriEncodable [Char] where instance UriEncodable [Char] where
uriEncode encodeSlash payload = uriEncode encodeSlash payload =
LB.toStrict $ LB.toStrict $ BB.toLazyByteString $ mconcat $
BB.toLazyByteString $ map (`uriEncodeChar` encodeSlash) payload
mconcat $
map (`uriEncodeChar` encodeSlash) payload
instance UriEncodable ByteString where instance UriEncodable ByteString where
-- assumes that uriEncode is passed ASCII encoded strings. -- assumes that uriEncode is passed ASCII encoded strings.
@ -59,17 +59,16 @@ uriEncodeChar '/' True = BB.byteString "%2F"
uriEncodeChar '/' False = BB.char7 '/' uriEncodeChar '/' False = BB.char7 '/'
uriEncodeChar ch _ uriEncodeChar ch _
| isAsciiUpper ch | isAsciiUpper ch
|| isAsciiLower ch || isAsciiLower ch
|| isDigit ch || isDigit ch
|| (ch == '_') || (ch == '_')
|| (ch == '-') || (ch == '-')
|| (ch == '.') || (ch == '.')
|| (ch == '~') = || (ch == '~') = BB.char7 ch
BB.char7 ch
| otherwise = mconcat $ map f $ B.unpack $ encodeUtf8 $ T.singleton ch | otherwise = mconcat $ map f $ B.unpack $ encodeUtf8 $ T.singleton ch
where where
f :: Word8 -> BB.Builder f :: Word8 -> BB.Builder
f n = BB.char7 '%' <> BB.string7 hexStr f n = BB.char7 '%' <> BB.string7 hexStr
where where
hexStr = map toUpper $ showHex q $ showHex r "" hexStr = map toUpper $ showHex q $ showHex r ""
(q, r) = divMod n (16 :: Word8) (q, r) = divMod (fromIntegral n) (16::Word8)

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,54 +15,50 @@
-- --
module Network.Minio.Data.Crypto module Network.Minio.Data.Crypto
( hashSHA256, (
hashSHA256FromSource, hashSHA256
hashMD5, , hashSHA256FromSource
hashMD5ToBase64,
hashMD5FromSource,
hmacSHA256,
hmacSHA256RawBS,
digestToBS,
digestToBase16,
encodeToBase64,
)
where
import Crypto.Hash , hashMD5
( Digest, , hashMD5FromSource
MD5 (..),
SHA256 (..), , hmacSHA256
hashWith, , hmacSHA256RawBS
) , digestToBS
import Crypto.Hash.Conduit (sinkHash) , digestToBase16
import Crypto.MAC.HMAC (HMAC, hmac) ) where
import Data.ByteArray (ByteArrayAccess, convert)
import Data.ByteArray.Encoding (Base (Base16, Base64), convertToBase) import Crypto.Hash (SHA256(..), MD5(..), hashWith, Digest)
import Crypto.Hash.Conduit (sinkHash)
import Crypto.MAC.HMAC (hmac, HMAC)
import Data.ByteArray (ByteArrayAccess, convert)
import Data.ByteArray.Encoding (convertToBase, Base(Base16))
import qualified Data.Conduit as C import qualified Data.Conduit as C
import Lib.Prelude
hashSHA256 :: ByteString -> ByteString hashSHA256 :: ByteString -> ByteString
hashSHA256 = digestToBase16 . hashWith SHA256 hashSHA256 = digestToBase16 . hashWith SHA256
hashSHA256FromSource :: (Monad m) => C.ConduitM () ByteString m () -> m ByteString hashSHA256FromSource :: Monad m => C.Producer m ByteString -> m ByteString
hashSHA256FromSource src = do hashSHA256FromSource src = do
digest <- C.connect src sinkSHA256Hash digest <- src C.$$ sinkSHA256Hash
return $ digestToBase16 digest return $ digestToBase16 digest
where where
-- To help with type inference -- To help with type inference
sinkSHA256Hash :: (Monad m) => C.ConduitM ByteString Void m (Digest SHA256) sinkSHA256Hash :: Monad m => C.Consumer ByteString m (Digest SHA256)
sinkSHA256Hash = sinkHash sinkSHA256Hash = sinkHash
-- Returns MD5 hash hex encoded.
hashMD5 :: ByteString -> ByteString hashMD5 :: ByteString -> ByteString
hashMD5 = digestToBase16 . hashWith MD5 hashMD5 = digestToBase16 . hashWith MD5
hashMD5FromSource :: (Monad m) => C.ConduitM () ByteString m () -> m ByteString hashMD5FromSource :: Monad m => C.Producer m ByteString -> m ByteString
hashMD5FromSource src = do hashMD5FromSource src = do
digest <- C.connect src sinkMD5Hash digest <- src C.$$ sinkMD5Hash
return $ digestToBase16 digest return $ digestToBase16 digest
where where
-- To help with type inference -- To help with type inference
sinkMD5Hash :: (Monad m) => C.ConduitM ByteString Void m (Digest MD5) sinkMD5Hash :: Monad m => C.Consumer ByteString m (Digest MD5)
sinkMD5Hash = sinkHash sinkMD5Hash = sinkHash
hmacSHA256 :: ByteString -> ByteString -> HMAC SHA256 hmacSHA256 :: ByteString -> ByteString -> HMAC SHA256
@ -71,15 +67,8 @@ hmacSHA256 message key = hmac key message
hmacSHA256RawBS :: ByteString -> ByteString -> ByteString hmacSHA256RawBS :: ByteString -> ByteString -> ByteString
hmacSHA256RawBS message key = convert $ hmacSHA256 message key hmacSHA256RawBS message key = convert $ hmacSHA256 message key
digestToBS :: (ByteArrayAccess a) => a -> ByteString digestToBS :: ByteArrayAccess a => a -> ByteString
digestToBS = convert digestToBS = convert
digestToBase16 :: (ByteArrayAccess a) => a -> ByteString digestToBase16 :: ByteArrayAccess a => a -> ByteString
digestToBase16 = convertToBase Base16 digestToBase16 = convertToBase Base16
-- Returns MD5 hash base 64 encoded.
hashMD5ToBase64 :: (ByteArrayAccess a) => a -> ByteString
hashMD5ToBase64 = convertToBase Base64 . hashWith MD5
encodeToBase64 :: (ByteArrayAccess a) => a -> ByteString
encodeToBase64 = convertToBase Base64

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,24 +15,20 @@
-- --
module Network.Minio.Data.Time module Network.Minio.Data.Time
( awsTimeFormat, (
awsTimeFormatBS, awsTimeFormat
awsDateFormat, , awsTimeFormatBS
awsDateFormatBS, , awsDateFormat
awsParseTime, , awsDateFormatBS
iso8601TimeFormat, , awsParseTime
UrlExpiry, , iso8601TimeFormat
) ) where
where
import Data.ByteString.Char8 (pack)
import Data.ByteString.Char8 (pack)
import qualified Data.Time as Time import qualified Data.Time as Time
import Data.Time.Format.ISO8601 (iso8601Show)
import Lib.Prelude
-- | Time to expire for a presigned URL. It interpreted as a number of import Lib.Prelude
-- seconds. The maximum duration that can be specified is 7 days.
type UrlExpiry = Int
awsTimeFormat :: UTCTime -> [Char] awsTimeFormat :: UTCTime -> [Char]
awsTimeFormat = Time.formatTime Time.defaultTimeLocale "%Y%m%dT%H%M%SZ" awsTimeFormat = Time.formatTime Time.defaultTimeLocale "%Y%m%dT%H%M%SZ"
@ -50,4 +46,4 @@ awsParseTime :: [Char] -> Maybe UTCTime
awsParseTime = Time.parseTimeM False Time.defaultTimeLocale "%Y%m%dT%H%M%SZ" awsParseTime = Time.parseTimeM False Time.defaultTimeLocale "%Y%m%dT%H%M%SZ"
iso8601TimeFormat :: UTCTime -> [Char] iso8601TimeFormat :: UTCTime -> [Char]
iso8601TimeFormat = iso8601Show iso8601TimeFormat = Time.formatTime Time.defaultTimeLocale (Time.iso8601DateFormat $ Just "%T%QZ")

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -14,83 +14,69 @@
-- limitations under the License. -- limitations under the License.
-- --
module Network.Minio.Errors module Network.Minio.Errors where
( MErrV (..),
ServiceErr (..),
MinioErr (..),
toServiceErr,
)
where
import Control.Exception (IOException) import Control.Exception
import qualified Network.HTTP.Conduit as NC import qualified Network.HTTP.Conduit as NC
import Lib.Prelude
--------------------------------- ---------------------------------
-- Errors -- Errors
--------------------------------- ---------------------------------
-- | Various validation errors -- | Various validation errors
data MErrV data MErrV = MErrVSinglePUTSizeExceeded Int64
= MErrVSinglePUTSizeExceeded Int64 | MErrVPutSizeExceeded Int64
| MErrVPutSizeExceeded Int64 | MErrVETagHeaderNotFound
| MErrVETagHeaderNotFound | MErrVInvalidObjectInfoResponse
| MErrVInvalidObjectInfoResponse | MErrVInvalidSrcObjSpec Text
| MErrVInvalidSrcObjSpec Text | MErrVInvalidSrcObjByteRange (Int64, Int64)
| MErrVInvalidSrcObjByteRange (Int64, Int64) | MErrVCopyObjSingleNoRangeAccepted
| MErrVCopyObjSingleNoRangeAccepted | MErrVRegionNotSupported Text
| MErrVRegionNotSupported Text | MErrVXmlParse Text
| MErrVXmlParse Text | MErrVInvalidBucketName Text
| MErrVInvalidBucketName Text | MErrVInvalidObjectName Text
| MErrVInvalidObjectName Text | MErrVInvalidUrlExpiry Int
| MErrVInvalidUrlExpiry Int deriving (Show, Eq)
| MErrVJsonParse Text
| MErrVInvalidHealPath
| MErrVMissingCredentials
| MErrVInvalidEncryptionKeyLength
| MErrVStreamingBodyUnexpectedEOF
| MErrVUnexpectedPayload
| MErrVSTSEndpointNotFound
deriving stock (Show, Eq)
instance Exception MErrV instance Exception MErrV
-- | Errors returned by S3 compatible service -- | Errors returned by S3 compatible service
data ServiceErr data ServiceErr = BucketAlreadyExists
= BucketAlreadyExists | BucketAlreadyOwnedByYou
| BucketAlreadyOwnedByYou | NoSuchBucket
| NoSuchBucket | InvalidBucketName
| InvalidBucketName | NoSuchKey
| NoSuchKey | ServiceErr Text Text
| SelectErr Text Text deriving (Show, Eq)
| ServiceErr Text Text
deriving stock (Show, Eq)
instance Exception ServiceErr instance Exception ServiceErr
toServiceErr :: Text -> Text -> ServiceErr toServiceErr :: Text -> Text -> ServiceErr
toServiceErr "NoSuchKey" _ = NoSuchKey toServiceErr "NoSuchKey" _ = NoSuchKey
toServiceErr "NoSuchBucket" _ = NoSuchBucket toServiceErr "NoSuchBucket" _ = NoSuchBucket
toServiceErr "InvalidBucketName" _ = InvalidBucketName toServiceErr "InvalidBucketName" _ = InvalidBucketName
toServiceErr "BucketAlreadyOwnedByYou" _ = BucketAlreadyOwnedByYou toServiceErr "BucketAlreadyOwnedByYou" _ = BucketAlreadyOwnedByYou
toServiceErr "BucketAlreadyExists" _ = BucketAlreadyExists toServiceErr "BucketAlreadyExists" _ = BucketAlreadyExists
toServiceErr code message = ServiceErr code message toServiceErr code message = ServiceErr code message
-- | Errors thrown by the library -- | Errors thrown by the library
data MinioErr data MinioErr = MErrHTTP NC.HttpException
= MErrHTTP NC.HttpException | MErrIO IOException
| MErrIO IOException | MErrService ServiceErr
| MErrService ServiceErr | MErrValidation MErrV
| MErrValidation MErrV deriving (Show)
deriving stock (Show)
instance Eq MinioErr where instance Eq MinioErr where
MErrHTTP _ == MErrHTTP _ = True MErrHTTP _ == MErrHTTP _ = True
MErrHTTP _ == _ = False MErrHTTP _ == _ = False
MErrIO _ == MErrIO _ = True MErrIO _ == MErrIO _ = True
MErrIO _ == _ = False MErrIO _ == _ = False
MErrService a == MErrService b = a == b MErrService a == MErrService b = a == b
MErrService _ == _ = False MErrService _ == _ = False
MErrValidation a == MErrValidation b = a == b MErrValidation a == MErrValidation b = a == b
MErrValidation _ == _ = False MErrValidation _ == _ = False
instance Exception MinioErr instance Exception MinioErr

View File

@ -1,49 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.JsonParser
( parseErrResponseJSON,
)
where
import Data.Aeson
( FromJSON,
eitherDecode,
parseJSON,
withObject,
(.:),
)
import qualified Data.Text as T
import Lib.Prelude
import Network.Minio.Errors
data AdminErrJSON = AdminErrJSON
{ aeCode :: Text,
aeMessage :: Text
}
deriving stock (Eq, Show)
instance FromJSON AdminErrJSON where
parseJSON = withObject "AdminErrJSON" $ \v ->
AdminErrJSON
<$> v .: "Code"
<*> v .: "Message"
parseErrResponseJSON :: (MonadIO m) => LByteString -> m ServiceErr
parseErrResponseJSON jsondata =
case eitherDecode jsondata of
Right aErr -> return $ toServiceErr (aeCode aErr) (aeMessage aErr)
Left err -> throwIO $ MErrVJsonParse $ T.pack err

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -19,162 +19,80 @@ module Network.Minio.ListOps where
import qualified Data.Conduit as C import qualified Data.Conduit as C
import qualified Data.Conduit.Combinators as CC import qualified Data.Conduit.Combinators as CC
import qualified Data.Conduit.List as CL import qualified Data.Conduit.List as CL
import Network.Minio.Data
( Bucket,
ListObjectsResult
( lorCPrefixes,
lorHasMore,
lorNextToken,
lorObjects
),
ListObjectsV1Result
( lorCPrefixes',
lorHasMore',
lorNextMarker,
lorObjects'
),
ListPartsResult (lprHasMore, lprNextPart, lprParts),
ListUploadsResult
( lurHasMore,
lurNextKey,
lurNextUpload,
lurUploads
),
Minio,
Object,
ObjectInfo,
ObjectPartInfo (opiSize),
UploadId,
UploadInfo (UploadInfo),
)
import Network.Minio.S3API
( listIncompleteParts',
listIncompleteUploads',
listObjects',
listObjectsV1',
)
-- | Represents a list output item - either an object or an object import Lib.Prelude
-- prefix (i.e. a directory).
data ListItem
= ListItemObject ObjectInfo
| ListItemPrefix Text
deriving stock (Show, Eq)
-- | @'listObjects' bucket prefix recurse@ lists objects in a bucket import Network.Minio.Data
-- similar to a file system tree traversal. import Network.Minio.S3API
--
-- If @prefix@ is not 'Nothing', only items with the given prefix are -- | List objects in a bucket matching the given prefix. If recurse is
-- listed, otherwise items under the bucket are returned. -- set to True objects matching prefix are recursively listed.
-- listObjects :: Bucket -> Maybe Text -> Bool -> C.Producer Minio ObjectInfo
-- If @recurse@ is set to @True@ all directories under the prefix are
-- recursively traversed and only objects are returned.
--
-- If @recurse@ is set to @False@, objects and directories immediately
-- under the given prefix are returned (no recursive traversal is
-- performed).
listObjects :: Bucket -> Maybe Text -> Bool -> C.ConduitM () ListItem Minio ()
listObjects bucket prefix recurse = loop Nothing listObjects bucket prefix recurse = loop Nothing
where where
loop :: Maybe Text -> C.ConduitM () ListItem Minio () loop :: Maybe Text -> C.Producer Minio ObjectInfo
loop nextToken = do loop nextToken = do
let delimiter = bool (Just "/") Nothing recurse let
delimiter = bool (Just "/") Nothing recurse
res <- lift $ listObjects' bucket prefix nextToken delimiter Nothing res <- lift $ listObjects' bucket prefix nextToken delimiter Nothing
CL.sourceList $ map ListItemObject $ lorObjects res CL.sourceList $ lorObjects res
unless recurse $
CL.sourceList $
map ListItemPrefix $
lorCPrefixes res
when (lorHasMore res) $ when (lorHasMore res) $
loop (lorNextToken res) loop (lorNextToken res)
-- | Lists objects - similar to @listObjects@, however uses the older -- | List objects in a bucket matching the given prefix. If recurse is
-- V1 AWS S3 API. Prefer @listObjects@ to this. -- set to True objects matching prefix are recursively listed.
listObjectsV1 :: listObjectsV1 :: Bucket -> Maybe Text -> Bool -> C.Producer Minio ObjectInfo
Bucket ->
Maybe Text ->
Bool ->
C.ConduitM () ListItem Minio ()
listObjectsV1 bucket prefix recurse = loop Nothing listObjectsV1 bucket prefix recurse = loop Nothing
where where
loop :: Maybe Text -> C.ConduitM () ListItem Minio () loop :: Maybe Text -> C.Producer Minio ObjectInfo
loop nextMarker = do loop nextMarker = do
let delimiter = bool (Just "/") Nothing recurse let
delimiter = bool (Just "/") Nothing recurse
res <- lift $ listObjectsV1' bucket prefix nextMarker delimiter Nothing res <- lift $ listObjectsV1' bucket prefix nextMarker delimiter Nothing
CL.sourceList $ map ListItemObject $ lorObjects' res CL.sourceList $ lorObjects' res
unless recurse $
CL.sourceList $
map ListItemPrefix $
lorCPrefixes' res
when (lorHasMore' res) $ when (lorHasMore' res) $
loop (lorNextMarker res) loop (lorNextMarker res)
-- | List incomplete uploads in a bucket matching the given prefix. If -- | List incomplete uploads in a bucket matching the given prefix. If
-- recurse is set to True incomplete uploads for the given prefix are -- recurse is set to True incomplete uploads for the given prefix are
-- recursively listed. -- recursively listed.
listIncompleteUploads :: listIncompleteUploads :: Bucket -> Maybe Text -> Bool
Bucket -> -> C.Producer Minio UploadInfo
Maybe Text ->
Bool ->
C.ConduitM () UploadInfo Minio ()
listIncompleteUploads bucket prefix recurse = loop Nothing Nothing listIncompleteUploads bucket prefix recurse = loop Nothing Nothing
where where
loop :: Maybe Text -> Maybe Text -> C.ConduitM () UploadInfo Minio () loop :: Maybe Text -> Maybe Text -> C.Producer Minio UploadInfo
loop nextKeyMarker nextUploadIdMarker = do loop nextKeyMarker nextUploadIdMarker = do
let delimiter = bool (Just "/") Nothing recurse let
delimiter = bool (Just "/") Nothing recurse
res <- res <- lift $ listIncompleteUploads' bucket prefix delimiter
lift $ nextKeyMarker nextUploadIdMarker Nothing
listIncompleteUploads'
bucket
prefix
delimiter
nextKeyMarker
nextUploadIdMarker
Nothing
aggrSizes <- lift $ aggrSizes <- lift $ forM (lurUploads res) $ \(uKey, uId, _) -> do
forM (lurUploads res) $ \(uKey, uId, _) -> do partInfos <- listIncompleteParts bucket uKey uId C.$$ CC.sinkList
partInfos <- return $ foldl (\sizeSofar p -> opiSize p + sizeSofar) 0 partInfos
C.runConduit $
listIncompleteParts bucket uKey uId
C..| CC.sinkList
return $ foldl' (\sizeSofar p -> opiSize p + sizeSofar) 0 partInfos
CL.sourceList $ CL.sourceList $
zipWith map (\((uKey, uId, uInitTime), size) ->
( curry UploadInfo uKey uId uInitTime size
( \((uKey, uId, uInitTime), size) -> ) $ zip (lurUploads res) aggrSizes
UploadInfo uKey uId uInitTime size
)
)
(lurUploads res)
aggrSizes
when (lurHasMore res) $ when (lurHasMore res) $
loop (lurNextKey res) (lurNextUpload res) loop (lurNextKey res) (lurNextUpload res)
-- | List object parts of an ongoing multipart upload for given -- | List object parts of an ongoing multipart upload for given
-- bucket, object and uploadId. -- bucket, object and uploadId.
listIncompleteParts :: listIncompleteParts :: Bucket -> Object -> UploadId
Bucket -> -> C.Producer Minio ObjectPartInfo
Object ->
UploadId ->
C.ConduitM () ObjectPartInfo Minio ()
listIncompleteParts bucket object uploadId = loop Nothing listIncompleteParts bucket object uploadId = loop Nothing
where where
loop :: Maybe Text -> C.ConduitM () ObjectPartInfo Minio () loop :: Maybe Text -> C.Producer Minio ObjectPartInfo
loop nextPartMarker = do loop nextPartMarker = do
res <- res <- lift $ listIncompleteParts' bucket object uploadId Nothing
lift $ nextPartMarker
listIncompleteParts'
bucket
object
uploadId
Nothing
nextPartMarker
CL.sourceList $ lprParts res CL.sourceList $ lprParts res
when (lprHasMore res) $ when (lprHasMore res) $
loop (show <$> lprNextPart res) loop (show <$> lprNextPart res)

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -13,51 +13,45 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE CPP #-}
module Network.Minio.PresignedOperations module Network.Minio.PresignedOperations
( UrlExpiry, ( UrlExpiry
makePresignedUrl, , makePresignedUrl
presignedPutObjectUrl, , presignedPutObjectUrl
presignedGetObjectUrl, , presignedGetObjectUrl
presignedHeadObjectUrl, , presignedHeadObjectUrl
PostPolicyCondition (..),
ppCondBucket,
ppCondContentLengthRange,
ppCondContentType,
ppCondKey,
ppCondKeyStartsWith,
ppCondSuccessActionStatus,
PostPolicy (..),
PostPolicyError (..),
newPostPolicy,
showPostPolicy,
presignedPostPolicy,
)
where
import Data.Aeson ((.=)) , PostPolicyCondition(..)
import qualified Data.Aeson as Json , ppCondBucket
import Data.ByteString.Builder (byteString, toLazyByteString) , ppCondContentLengthRange
import qualified Data.HashMap.Strict as H , ppCondContentType
import qualified Data.Text as T , ppCondKey
import qualified Data.Time as Time , ppCondKeyStartsWith
import Lib.Prelude , ppCondSuccessActionStatus
import qualified Network.HTTP.Client as NClient
import qualified Network.HTTP.Types as HT
import Network.Minio.API (buildRequest)
import Network.Minio.Credentials
import Network.Minio.Data
import Network.Minio.Data.Time
import Network.Minio.Errors
import Network.Minio.Sign.V4
import Network.URI (uriToString)
{- ORMOLU_DISABLE -} , PostPolicy(..)
#if MIN_VERSION_aeson(2,0,0) , PostPolicyError(..)
import qualified Data.Aeson.Key as A , newPostPolicy
#endif , showPostPolicy
{- ORMOLU_ENABLE -} , presignedPostPolicy
) where
import Data.Aeson ((.=))
import qualified Data.Aeson as Json
import Data.ByteString.Builder (byteString, toLazyByteString)
import Data.Default (def)
import qualified Data.Map.Strict as Map
import qualified Data.Text as T
import qualified Data.Time as Time
import qualified Network.HTTP.Types as HT
import Network.HTTP.Types.Header (hHost)
import Lib.Prelude
import Network.Minio.Data
import Network.Minio.Data.Time
import Network.Minio.Errors
import Network.Minio.Sign.V4
-- | Generate a presigned URL. This function allows for advanced usage -- | Generate a presigned URL. This function allows for advanced usage
-- - for simple cases prefer the `presigned*Url` functions. -- - for simple cases prefer the `presigned*Url` functions.
@ -67,36 +61,35 @@ import qualified Data.Aeson.Key as A
-- --
-- All extra query parameters or headers are signed, and therefore are -- All extra query parameters or headers are signed, and therefore are
-- required to be sent when the generated URL is actually used. -- required to be sent when the generated URL is actually used.
makePresignedUrl :: makePresignedUrl :: UrlExpiry -> HT.Method -> Maybe Bucket -> Maybe Object
UrlExpiry -> -> Maybe Region -> HT.Query -> HT.RequestHeaders
HT.Method -> -> Minio ByteString
Maybe Bucket ->
Maybe Object ->
Maybe Region ->
HT.Query ->
HT.RequestHeaders ->
Minio ByteString
makePresignedUrl expiry method bucket object region extraQuery extraHeaders = do makePresignedUrl expiry method bucket object region extraQuery extraHeaders = do
when (expiry > 7 * 24 * 3600 || expiry < 0) $ when (expiry > 7*24*3600 || expiry < 0) $
throwIO $ throwM $ MErrVInvalidUrlExpiry expiry
MErrVInvalidUrlExpiry expiry
let s3ri = ci <- asks mcConnInfo
defaultS3ReqInfo
{ riPresignExpirySecs = Just expiry,
riMethod = method,
riBucket = bucket,
riObject = object,
riRegion = region,
riQueryParams = extraQuery,
riHeaders = extraHeaders
}
req <- buildRequest s3ri let
let uri = NClient.getUri req host = formatBS "{}:{}" (connectHost ci, connectPort ci)
uriString = uriToString identity uri "" hostHeader = (hHost, host)
ri = def { riMethod = method
, riBucket = bucket
, riObject = object
, riQueryParams = extraQuery
, riHeaders = hostHeader : extraHeaders
, riRegion = Just $ maybe (connectRegion ci) identity region
}
return $ encodeUtf8 uriString signPairs <- liftIO $ signV4 ci ri (Just expiry)
let
qpToAdd = (fmap . fmap) Just signPairs
queryStr = HT.renderQueryBuilder True (riQueryParams ri ++ qpToAdd)
scheme = byteString $ bool "http://" "https://" $ connectIsSecure ci
return $ toS $ toLazyByteString $
scheme <> byteString host <> byteString (getPathFromRI ri) <> queryStr
-- | Generate a URL with authentication signature to PUT (upload) an -- | Generate a URL with authentication signature to PUT (upload) an
-- object. Any extra headers if passed, are signed, and so they are -- object. Any extra headers if passed, are signed, and so they are
@ -105,22 +98,11 @@ makePresignedUrl expiry method bucket object region extraQuery extraHeaders = do
-- --
-- For a list of possible headers to pass, please refer to the PUT -- For a list of possible headers to pass, please refer to the PUT
-- object REST API AWS S3 documentation. -- object REST API AWS S3 documentation.
presignedPutObjectUrl :: presignedPutObjectUrl :: Bucket -> Object -> UrlExpiry -> HT.RequestHeaders
Bucket -> -> Minio ByteString
Object -> presignedPutObjectUrl bucket object expirySeconds extraHeaders =
UrlExpiry -> makePresignedUrl expirySeconds HT.methodPut
HT.RequestHeaders -> (Just bucket) (Just object) Nothing [] extraHeaders
Minio ByteString
presignedPutObjectUrl bucket object expirySeconds extraHeaders = do
region <- asks (Just . connectRegion . mcConnInfo)
makePresignedUrl
expirySeconds
HT.methodPut
(Just bucket)
(Just object)
region
[]
extraHeaders
-- | Generate a URL with authentication signature to GET (download) an -- | Generate a URL with authentication signature to GET (download) an
-- object. All extra query parameters and headers passed here will be -- object. All extra query parameters and headers passed here will be
@ -131,23 +113,11 @@ presignedPutObjectUrl bucket object expirySeconds extraHeaders = do
-- --
-- For a list of possible request parameters and headers, please refer -- For a list of possible request parameters and headers, please refer
-- to the GET object REST API AWS S3 documentation. -- to the GET object REST API AWS S3 documentation.
presignedGetObjectUrl :: presignedGetObjectUrl :: Bucket -> Object -> UrlExpiry -> HT.Query
Bucket -> -> HT.RequestHeaders -> Minio ByteString
Object -> presignedGetObjectUrl bucket object expirySeconds extraQuery extraHeaders =
UrlExpiry -> makePresignedUrl expirySeconds HT.methodGet
HT.Query -> (Just bucket) (Just object) Nothing extraQuery extraHeaders
HT.RequestHeaders ->
Minio ByteString
presignedGetObjectUrl bucket object expirySeconds extraQuery extraHeaders = do
region <- asks (Just . connectRegion . mcConnInfo)
makePresignedUrl
expirySeconds
HT.methodGet
(Just bucket)
(Just object)
region
extraQuery
extraHeaders
-- | Generate a URL with authentication signature to make a HEAD -- | Generate a URL with authentication signature to make a HEAD
-- request on an object. This is used to fetch metadata about an -- request on an object. This is used to fetch metadata about an
@ -156,74 +126,49 @@ presignedGetObjectUrl bucket object expirySeconds extraQuery extraHeaders = do
-- --
-- For a list of possible headers to pass, please refer to the HEAD -- For a list of possible headers to pass, please refer to the HEAD
-- object REST API AWS S3 documentation. -- object REST API AWS S3 documentation.
presignedHeadObjectUrl :: presignedHeadObjectUrl :: Bucket -> Object -> UrlExpiry
Bucket -> -> HT.RequestHeaders -> Minio ByteString
Object -> presignedHeadObjectUrl bucket object expirySeconds extraHeaders =
UrlExpiry -> makePresignedUrl expirySeconds HT.methodHead
HT.RequestHeaders -> (Just bucket) (Just object) Nothing [] extraHeaders
Minio ByteString
presignedHeadObjectUrl bucket object expirySeconds extraHeaders = do
region <- asks (Just . connectRegion . mcConnInfo)
makePresignedUrl
expirySeconds
HT.methodHead
(Just bucket)
(Just object)
region
[]
extraHeaders
-- | Represents individual conditions in a Post Policy document. -- | Represents individual conditions in a Post Policy document.
data PostPolicyCondition data PostPolicyCondition = PPCStartsWith Text Text
= PPCStartsWith Text Text | PPCEquals Text Text
| PPCEquals Text Text | PPCRange Text Int64 Int64
| PPCRange Text Int64 Int64 deriving (Show, Eq)
deriving stock (Show, Eq)
{- ORMOLU_DISABLE -}
instance Json.ToJSON PostPolicyCondition where instance Json.ToJSON PostPolicyCondition where
toJSON (PPCStartsWith k v) = Json.toJSON ["starts-with", k, v] toJSON (PPCStartsWith k v) = Json.toJSON ["starts-with", k, v]
#if MIN_VERSION_aeson(2,0,0)
toJSON (PPCEquals k v) = Json.object [(A.fromText k) .= v]
#else
toJSON (PPCEquals k v) = Json.object [k .= v] toJSON (PPCEquals k v) = Json.object [k .= v]
#endif
toJSON (PPCRange k minVal maxVal) = toJSON (PPCRange k minVal maxVal) =
Json.toJSON [Json.toJSON k, Json.toJSON minVal, Json.toJSON maxVal] Json.toJSON [Json.toJSON k, Json.toJSON minVal, Json.toJSON maxVal]
toEncoding (PPCStartsWith k v) = Json.foldable ["starts-with", k, v] toEncoding (PPCStartsWith k v) = Json.foldable ["starts-with", k, v]
#if MIN_VERSION_aeson(2,0,0)
toEncoding (PPCEquals k v) = Json.pairs ((A.fromText k) .= v)
#else
toEncoding (PPCEquals k v) = Json.pairs (k .= v) toEncoding (PPCEquals k v) = Json.pairs (k .= v)
#endif
toEncoding (PPCRange k minVal maxVal) = toEncoding (PPCRange k minVal maxVal) =
Json.foldable [Json.toJSON k, Json.toJSON minVal, Json.toJSON maxVal] Json.foldable [Json.toJSON k, Json.toJSON minVal, Json.toJSON maxVal]
{- ORMOLU_ENABLE -}
-- | A PostPolicy is required to perform uploads via browser forms. -- | A PostPolicy is required to perform uploads via browser forms.
data PostPolicy = PostPolicy data PostPolicy = PostPolicy {
{ expiration :: UTCTime, expiration :: UTCTime
conditions :: [PostPolicyCondition] , conditions :: [PostPolicyCondition]
} } deriving (Show, Eq)
deriving stock (Show, Eq)
instance Json.ToJSON PostPolicy where instance Json.ToJSON PostPolicy where
toJSON (PostPolicy e c) = toJSON (PostPolicy e c) =
Json.object Json.object $ [ "expiration" .= iso8601TimeFormat e
[ "expiration" .= iso8601TimeFormat e, , "conditions" .= c
"conditions" .= c ]
]
toEncoding (PostPolicy e c) = toEncoding (PostPolicy e c) =
Json.pairs ("expiration" .= iso8601TimeFormat e <> "conditions" .= c) Json.pairs ("expiration" .= iso8601TimeFormat e <> "conditions" .= c)
-- | Possible validation errors when creating a PostPolicy. -- | Possible validation errors when creating a PostPolicy.
data PostPolicyError data PostPolicyError = PPEKeyNotSpecified
= PPEKeyNotSpecified | PPEBucketNotSpecified
| PPEBucketNotSpecified | PPEConditionKeyEmpty
| PPEConditionKeyEmpty | PPERangeInvalid
| PPERangeInvalid deriving (Eq, Show)
deriving stock (Show, Eq)
-- | Set the bucket name that the upload should use. -- | Set the bucket name that the upload should use.
ppCondBucket :: Bucket -> PostPolicyCondition ppCondBucket :: Bucket -> PostPolicyCondition
@ -231,10 +176,8 @@ ppCondBucket = PPCEquals "bucket"
-- | Set the content length range constraint with minimum and maximum -- | Set the content length range constraint with minimum and maximum
-- byte count values. -- byte count values.
ppCondContentLengthRange :: ppCondContentLengthRange :: Int64 -> Int64
Int64 -> -> PostPolicyCondition
Int64 ->
PostPolicyCondition
ppCondContentLengthRange = PPCRange "content-length-range" ppCondContentLengthRange = PPCRange "content-length-range"
-- | Set the content-type header for the upload. -- | Set the content-type header for the upload.
@ -257,99 +200,82 @@ ppCondSuccessActionStatus n =
-- | This function creates a PostPolicy after validating its -- | This function creates a PostPolicy after validating its
-- arguments. -- arguments.
newPostPolicy :: newPostPolicy :: UTCTime -> [PostPolicyCondition]
UTCTime -> -> Either PostPolicyError PostPolicy
[PostPolicyCondition] ->
Either PostPolicyError PostPolicy
newPostPolicy expirationTime conds newPostPolicy expirationTime conds
-- object name condition must be present -- object name condition must be present
| not $ any (keyEquals "key") conds = | not $ any (keyEquals "key") conds =
Left PPEKeyNotSpecified Left PPEKeyNotSpecified
-- bucket name condition must be present -- bucket name condition must be present
| not $ any (keyEquals "bucket") conds = | not $ any (keyEquals "bucket") conds =
Left PPEBucketNotSpecified Left PPEBucketNotSpecified
-- a condition with an empty key is invalid -- a condition with an empty key is invalid
| any (keyEquals "") conds || any isEmptyRangeKey conds = | any (keyEquals "") conds || any isEmptyRangeKey conds =
Left PPEConditionKeyEmpty Left PPEConditionKeyEmpty
-- invalid range check -- invalid range check
| any isInvalidRange conds = | any isInvalidRange conds =
Left PPERangeInvalid Left PPERangeInvalid
-- all good! -- all good!
| otherwise = | otherwise =
return $ PostPolicy expirationTime conds return $ PostPolicy expirationTime conds
where where
keyEquals k' (PPCStartsWith k _) = k == k' keyEquals k' (PPCStartsWith k _) = k == k'
keyEquals k' (PPCEquals k _) = k == k' keyEquals k' (PPCEquals k _) = k == k'
keyEquals _ _ = False keyEquals _ _ = False
isEmptyRangeKey (PPCRange k _ _) = k == "" isEmptyRangeKey (PPCRange k _ _) = k == ""
isEmptyRangeKey _ = False isEmptyRangeKey _ = False
isInvalidRange (PPCRange _ mi ma) = mi < 0 || mi > ma isInvalidRange (PPCRange _ mi ma) = mi < 0 || mi > ma
isInvalidRange _ = False isInvalidRange _ = False
-- | Convert Post Policy to a string (e.g. for printing). -- | Convert Post Policy to a string (e.g. for printing).
showPostPolicy :: PostPolicy -> ByteString showPostPolicy :: PostPolicy -> ByteString
showPostPolicy = toStrictBS . Json.encode showPostPolicy = toS . Json.encode
-- | Generate a presigned URL and POST policy to upload files via a -- | Generate a presigned URL and POST policy to upload files via a
-- browser. On success, this function returns a URL and POST -- browser. On success, this function returns a URL and POST
-- form-data. -- form-data.
presignedPostPolicy :: presignedPostPolicy :: PostPolicy
PostPolicy -> -> Minio (ByteString, Map.Map Text ByteString)
Minio (ByteString, H.HashMap Text ByteString)
presignedPostPolicy p = do presignedPostPolicy p = do
ci <- asks mcConnInfo ci <- asks mcConnInfo
signTime <- liftIO Time.getCurrentTime signTime <- liftIO $ Time.getCurrentTime
mgr <- asks mcConnManager
cv <- liftIO $ getCredential (connectCreds ci) (getEndpoint ci) mgr
let extraConditions signParams = let
[ PPCEquals "x-amz-date" (toText $ awsTimeFormat signTime), extraConditions =
PPCEquals "x-amz-algorithm" "AWS4-HMAC-SHA256", [ PPCEquals "x-amz-date" (toS $ awsTimeFormat signTime)
PPCEquals , PPCEquals "x-amz-algorithm" "AWS4-HMAC-SHA256"
"x-amz-credential" , PPCEquals "x-amz-credential"
( T.intercalate (T.intercalate "/" [connectAccessKey ci,
"/" decodeUtf8 $ mkScope signTime region])
[ coerce $ cvAccessKey cv, ]
decodeUtf8 $ credentialScope signParams ppWithCreds = p {
] conditions = conditions p ++ extraConditions
) }
] signData = signV4PostPolicy (showPostPolicy ppWithCreds)
ppWithCreds signParams = signTime ci
p
{ conditions = conditions p ++ extraConditions signParams -- compute form-data
} mkPair (PPCStartsWith k v) = Just (k, v)
sp = mkPair (PPCEquals k v) = Just (k, v)
SignParams mkPair _ = Nothing
(coerce $ cvAccessKey cv) formFromPolicy = Map.map toS $ Map.fromList $ catMaybes $
(coerce $ cvSecretKey cv) mkPair <$> conditions ppWithCreds
(coerce $ cvSessionToken cv) formData = formFromPolicy `Map.union` signData
ServiceS3
signTime -- compute POST upload URL
(Just $ connectRegion ci) bucket = Map.findWithDefault "" "bucket" formData
Nothing scheme = byteString $ bool "http://" "https://" $ connectIsSecure ci
Nothing host = formatBS "{}:{}" (connectHost ci, connectPort ci)
signData = signV4PostPolicy (showPostPolicy $ ppWithCreds sp) sp region = connectRegion ci
-- compute form-data
mkPair (PPCStartsWith k v) = Just (k, v) url = toS $ toLazyByteString $ scheme <> byteString host <>
mkPair (PPCEquals k v) = Just (k, v) byteString "/" <> byteString (toS bucket) <> byteString "/"
mkPair _ = Nothing
formFromPolicy =
H.map encodeUtf8 $
H.fromList $
mapMaybe
mkPair
(conditions $ ppWithCreds sp)
formData = formFromPolicy `H.union` signData
-- compute POST upload URL
bucket = H.lookupDefault "" "bucket" formData
scheme = byteString $ bool "http://" "https://" $ connectIsSecure ci
url =
toStrictBS $
toLazyByteString $
scheme
<> byteString (getHostAddr ci)
<> byteString "/"
<> byteString bucket
<> byteString "/"
return (url, formData) return (url, formData)

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,24 +15,43 @@
-- --
module Network.Minio.PutObject module Network.Minio.PutObject
( putObjectInternal, (
ObjectData (..), putObjectInternal
selectPartSizes, , ObjectData(..)
) , selectPartSizes
where , copyObjectInternal
, selectCopyRanges
, minPartSize
) where
import Conduit (takeC)
import qualified Conduit as C import qualified Data.Conduit as C
import qualified Data.ByteString.Lazy as LBS
import qualified Data.Conduit.Binary as CB import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.Combinators as CC import qualified Data.Conduit.Combinators as CC
import qualified Data.Conduit.List as CL import qualified Data.Conduit.List as CL
import qualified Data.List as List import qualified Data.List as List
import Lib.Prelude
import Network.Minio.Data import Lib.Prelude
import Network.Minio.Errors
import Network.Minio.S3API import Network.Minio.Data
import Network.Minio.Utils import Network.Minio.Errors
import Network.Minio.S3API
import Network.Minio.Utils
-- | max obj size is 5TiB
maxObjectSize :: Int64
maxObjectSize = 5 * 1024 * 1024 * oneMiB
-- | minimum size of parts used in multipart operations.
minPartSize :: Int64
minPartSize = 64 * oneMiB
oneMiB :: Int64
oneMiB = 1024 * 1024
maxMultipartParts :: Int64
maxMultipartParts = 10000
-- | A data-type to represent the source data for an object. A -- | A data-type to represent the source data for an object. A
-- file-path or a producer-conduit may be provided. -- file-path or a producer-conduit may be provided.
@ -43,90 +62,70 @@ import Network.Minio.Utils
-- --
-- For streams also, a size may be provided. This is useful to limit -- For streams also, a size may be provided. This is useful to limit
-- the input - if it is not provided, upload will continue until the -- the input - if it is not provided, upload will continue until the
-- stream ends or the object reaches `maxObjectSize` size. -- stream ends or the object reaches `maxObjectsize` size.
data ObjectData m data ObjectData m =
= -- | Takes filepath and optional ODFile FilePath (Maybe Int64) -- ^ Takes filepath and optional size.
-- size. | ODStream (C.Producer m ByteString) (Maybe Int64) -- ^ Pass size in bytes as maybe if known.
ODFile FilePath (Maybe Int64)
| -- | Pass
-- size
-- (bytes)
-- if
-- known.
ODStream (C.ConduitM () ByteString m ()) (Maybe Int64)
-- | Put an object from ObjectData. This high-level API handles -- | Put an object from ObjectData. This high-level API handles
-- objects of all sizes, and even if the object size is unknown. -- objects of all sizes, and even if the object size is unknown.
putObjectInternal :: putObjectInternal :: Bucket -> Object -> ObjectData Minio -> Minio ETag
Bucket -> putObjectInternal b o (ODStream src sizeMay) = sequentialMultipartUpload b o sizeMay src
Object -> putObjectInternal b o (ODFile fp sizeMay) = do
PutObjectOptions ->
ObjectData Minio ->
Minio ETag
putObjectInternal b o opts (ODStream src sizeMay) = do
case sizeMay of
-- unable to get size, so assume non-seekable file
Nothing -> sequentialMultipartUpload b o opts Nothing src
-- got file size, so check for single/multipart upload
Just size ->
if
| size <= 64 * oneMiB -> do
bs <- C.runConduit $ src C..| takeC (fromIntegral size) C..| CB.sinkLbs
putObjectSingle' b o (pooToHeaders opts) $ LBS.toStrict bs
| size > maxObjectSize -> throwIO $ MErrVPutSizeExceeded size
| otherwise -> sequentialMultipartUpload b o opts (Just size) src
putObjectInternal b o opts (ODFile fp sizeMay) = do
hResE <- withNewHandle fp $ \h -> hResE <- withNewHandle fp $ \h ->
liftA2 (,) (isHandleSeekable h) (getFileSize h) liftM2 (,) (isHandleSeekable h) (getFileSize h)
(isSeekable, handleSizeMay) <- (isSeekable, handleSizeMay) <- either (const $ return (False, Nothing)) return
either hResE
(const $ return (False, Nothing))
return
hResE
-- prefer given size to queried size. -- prefer given size to queried size.
let finalSizeMay = listToMaybe $ catMaybes [sizeMay, handleSizeMay] let finalSizeMay = listToMaybe $ catMaybes [sizeMay, handleSizeMay]
case finalSizeMay of case finalSizeMay of
-- unable to get size, so assume non-seekable file -- unable to get size, so assume non-seekable file and max-object size
Nothing -> sequentialMultipartUpload b o opts Nothing $ CB.sourceFile fp Nothing -> sequentialMultipartUpload b o (Just maxObjectSize) $
CB.sourceFile fp
-- got file size, so check for single/multipart upload -- got file size, so check for single/multipart upload
Just size -> Just size ->
if if | size <= 64 * oneMiB -> either throwM return =<<
| size <= 64 * oneMiB -> withNewHandle fp (\h -> putObjectSingle b o [] h 0 size)
either throwIO return | size > maxObjectSize -> throwM $ MErrVPutSizeExceeded size
=<< withNewHandle fp (\h -> putObjectSingle b o (pooToHeaders opts) h 0 size) | isSeekable -> parallelMultipartUpload b o fp size
| size > maxObjectSize -> throwIO $ MErrVPutSizeExceeded size | otherwise -> sequentialMultipartUpload b o (Just size) $
| isSeekable -> parallelMultipartUpload b o opts fp size CB.sourceFile fp
| otherwise ->
sequentialMultipartUpload b o opts (Just size) $
CB.sourceFile fp
parallelMultipartUpload :: -- | Select part sizes - the logic is that the minimum part-size will
Bucket -> -- be 64MiB.
Object -> selectPartSizes :: Int64 -> [(PartNumber, Int64, Int64)]
PutObjectOptions -> selectPartSizes size = uncurry (List.zip3 [1..]) $
FilePath -> List.unzip $ loop 0 size
Int64 -> where
Minio ETag ceil :: Double -> Int64
parallelMultipartUpload b o opts filePath size = do ceil = ceiling
partSize = max minPartSize (ceil $ fromIntegral size /
fromIntegral maxMultipartParts)
m = fromIntegral partSize
loop st sz
| st > sz = []
| st + m >= sz = [(st, sz - st)]
| otherwise = (st, m) : loop (st + m) sz
parallelMultipartUpload :: Bucket -> Object -> FilePath -> Int64
-> Minio ETag
parallelMultipartUpload b o filePath size = do
-- get a new upload id. -- get a new upload id.
uploadId <- newMultipartUpload b o (pooToHeaders opts) uploadId <- newMultipartUpload b o []
let partSizeInfo = selectPartSizes size let partSizeInfo = selectPartSizes size
let threads = fromMaybe 10 $ pooNumThreads opts -- perform upload with 10 threads
uploadedPartsE <- limitedMapConcurrently 10
-- perform upload with 'threads' threads (uploadPart uploadId) partSizeInfo
uploadedPartsE <-
limitedMapConcurrently
(fromIntegral threads)
(uploadPart uploadId)
partSizeInfo
-- if there were any errors, rethrow exception. -- if there were any errors, rethrow exception.
mapM_ throwIO $ lefts uploadedPartsE mapM_ throwM $ lefts uploadedPartsE
-- if we get here, all parts were successfully uploaded. -- if we get here, all parts were successfully uploaded.
completeMultipartUpload b o uploadId $ rights uploadedPartsE completeMultipartUpload b o uploadId $ rights uploadedPartsE
@ -137,37 +136,96 @@ parallelMultipartUpload b o opts filePath size = do
putObjectPart b o uploadId partNum [] payload putObjectPart b o uploadId partNum [] payload
-- | Upload multipart object from conduit source sequentially -- | Upload multipart object from conduit source sequentially
sequentialMultipartUpload :: sequentialMultipartUpload :: Bucket -> Object -> Maybe Int64
Bucket -> -> C.Producer Minio ByteString -> Minio ETag
Object -> sequentialMultipartUpload b o sizeMay src = do
PutObjectOptions ->
Maybe Int64 ->
C.ConduitM () ByteString Minio () ->
Minio ETag
sequentialMultipartUpload b o opts sizeMay src = do
-- get a new upload id. -- get a new upload id.
uploadId <- newMultipartUpload b o (pooToHeaders opts) uploadId <- newMultipartUpload b o []
-- upload parts in loop -- upload parts in loop
let partSizes = selectPartSizes $ maybe maxObjectSize identity sizeMay let partSizes = selectPartSizes $ maybe maxObjectSize identity sizeMay
(pnums, _, sizes) = List.unzip3 partSizes (pnums, _, sizes) = List.unzip3 partSizes
uploadedParts <- uploadedParts <- src
C.runConduit $ C..| chunkBSConduit sizes
src C..| CL.map PayloadBS
C..| chunkBSConduit (map fromIntegral sizes) C..| uploadPart' uploadId pnums
C..| CL.map PayloadBS C.$$ CC.sinkList
C..| uploadPart' uploadId pnums
C..| CC.sinkList
-- complete multipart upload -- complete multipart upload
completeMultipartUpload b o uploadId uploadedParts completeMultipartUpload b o uploadId uploadedParts
where where
uploadPart' _ [] = return () uploadPart' _ [] = return ()
uploadPart' uid (pn : pns) = do uploadPart' uid (pn:pns) = do
payloadMay <- C.await payloadMay <- C.await
case payloadMay of case payloadMay of
Nothing -> return () Nothing -> return ()
Just payload -> do Just payload -> do pinfo <- lift $ putObjectPart b o uid pn [] payload
pinfo <- lift $ putObjectPart b o uid pn [] payload C.yield pinfo
C.yield pinfo uploadPart' uid pns
uploadPart' uid pns
-- | Copy an object using single or multipart copy strategy.
copyObjectInternal :: Bucket -> Object -> CopyPartSource
-> Minio ETag
copyObjectInternal b' o cps = do
-- validate and extract the src bucket and object
(srcBucket, srcObject) <- maybe
(throwM $ MErrVInvalidSrcObjSpec $ cpSource cps)
return $ cpsToObject cps
-- get source object size with a head request
(ObjectInfo _ _ _ srcSize) <- headObject srcBucket srcObject
-- check that byte offsets are valid if specified in cps
when (isJust (cpSourceRange cps) &&
or [fst range < 0, snd range < fst range,
snd range >= fromIntegral srcSize]) $
throwM $ MErrVInvalidSrcObjByteRange range
-- 1. If sz > 64MiB (minPartSize) use multipart copy, OR
-- 2. If startOffset /= 0 use multipart copy
let destSize = (\(a, b) -> b - a + 1 ) $
maybe (0, srcSize - 1) identity $ cpSourceRange cps
startOffset = maybe 0 fst $ cpSourceRange cps
endOffset = maybe (srcSize - 1) snd $ cpSourceRange cps
if destSize > minPartSize || (endOffset - startOffset + 1 /= srcSize)
then multiPartCopyObject b' o cps srcSize
else fst <$> copyObjectSingle b' o cps{cpSourceRange = Nothing} []
where
range = maybe (0, 0) identity $ cpSourceRange cps
-- | Given the input byte range of the source object, compute the
-- splits for a multipart copy object procedure. Minimum part size
-- used is minPartSize.
selectCopyRanges :: (Int64, Int64) -> [(PartNumber, (Int64, Int64))]
selectCopyRanges (st, end) = zip pns $
map (\(x, y) -> (st + x, st + x + y - 1)) $ zip startOffsets partSizes
where
size = end - st + 1
(pns, startOffsets, partSizes) = List.unzip3 $ selectPartSizes size
-- | Perform a multipart copy object action. Since we cannot verify
-- existing parts based on the source object, there is no resuming
-- copy action support.
multiPartCopyObject :: Bucket -> Object -> CopyPartSource -> Int64
-> Minio ETag
multiPartCopyObject b o cps srcSize = do
uid <- newMultipartUpload b o []
let byteRange = maybe (0, fromIntegral $ srcSize - 1) identity $
cpSourceRange cps
partRanges = selectCopyRanges byteRange
partSources = map (\(x, y) -> (x, cps {cpSourceRange = Just y}))
partRanges
copiedParts <- limitedMapConcurrently 10
(\(pn, cps') -> do
(etag, _) <- copyObjectPart b o cps' uid pn []
return (pn, etag)
)
partSources
completeMultipartUpload b o uid copiedParts

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -14,672 +14,409 @@
-- limitations under the License. -- limitations under the License.
-- --
-- |
-- Module: Network.Minio.S3API
-- Copyright: (c) 2017-2023 MinIO Dev Team
-- License: Apache 2.0
-- Maintainer: MinIO Dev Team <dev@min.io>
--
-- Lower-level API for S3 compatible object stores. Start with @Network.Minio@
-- and use this only if needed.
module Network.Minio.S3API module Network.Minio.S3API
( Region, (
getLocation, Region
, getLocation
-- * Listing buckets -- * Listing buckets
--------------------
, getService
-------------------- -- * Listing objects
getService, --------------------
, ListObjectsResult(..)
, ListObjectsV1Result(..)
, listObjects'
, listObjectsV1'
-- * Listing objects -- * Retrieving buckets
, headBucket
-------------------- -- * Retrieving objects
ListObjectsResult (..), -----------------------
ListObjectsV1Result (..), , getObject'
listObjects', , headObject
listObjectsV1',
-- * Retrieving buckets -- * Creating buckets and objects
headBucket, ---------------------------------
, putBucket
, ETag
, putObjectSingle
, copyObjectSingle
-- * Retrieving objects -- * Multipart Upload APIs
--------------------------
, UploadId
, PartTuple
, Payload(..)
, PartNumber
, CopyPartSource(..)
, newMultipartUpload
, putObjectPart
, copyObjectPart
, completeMultipartUpload
, abortMultipartUpload
, ListUploadsResult(..)
, listIncompleteUploads'
, ListPartsResult(..)
, listIncompleteParts'
----------------------- -- * Deletion APIs
getObject', --------------------------
headObject, , deleteBucket
, deleteObject
-- * Creating buckets and objects -- * Presigned Operations
-----------------------------
, module Network.Minio.PresignedOperations
--------------------------------- -- * Bucket Notifications
putBucket, -------------------------
ETag, , Notification(..)
maxSinglePutObjectSizeBytes, , NotificationConfig(..)
putObjectSingle', , Arn
putObjectSingle, , Event(..)
copyObjectSingle, , Filter(..)
, FilterKey(..)
, FilterRules(..)
, FilterRule(..)
, getBucketNotification
, putBucketNotification
, removeAllBucketNotification
) where
-- * Multipart Upload APIs import Control.Monad.Catch (catches, Handler(..))
import qualified Data.Conduit as C
-------------------------- import Data.Default (def)
UploadId,
PartTuple,
Payload (..),
PartNumber,
newMultipartUpload,
putObjectPart,
copyObjectPart,
completeMultipartUpload,
abortMultipartUpload,
ListUploadsResult (..),
listIncompleteUploads',
ListPartsResult (..),
listIncompleteParts',
-- * Deletion APIs
--------------------------
deleteBucket,
deleteObject,
-- * Presigned Operations
-----------------------------
module Network.Minio.PresignedOperations,
-- ** Bucket Policies
getBucketPolicy,
setBucketPolicy,
-- * Bucket Notifications
-------------------------
Notification (..),
NotificationConfig (..),
Arn,
Event (..),
Filter (..),
FilterKey (..),
FilterRules (..),
FilterRule (..),
getBucketNotification,
putBucketNotification,
removeAllBucketNotification,
)
where
import qualified Data.ByteString as BS
import qualified Data.Text as T
import Lib.Prelude
import qualified Network.HTTP.Conduit as NC import qualified Network.HTTP.Conduit as NC
import qualified Network.HTTP.Types as HT import qualified Network.HTTP.Types as HT
import Network.HTTP.Types.Status (status404) import Network.HTTP.Types.Status (status404)
import Network.Minio.API
import Network.Minio.APICommon import Lib.Prelude hiding (catches)
import Network.Minio.Data
import Network.Minio.Errors import Network.Minio.API
import Network.Minio.PresignedOperations import Network.Minio.Data
import Network.Minio.Utils import Network.Minio.Errors
import Network.Minio.XmlGenerator import Network.Minio.Utils
import Network.Minio.XmlParser import Network.Minio.XmlGenerator
import UnliftIO (Handler (Handler)) import Network.Minio.XmlParser
import Network.Minio.PresignedOperations
-- | Fetch all buckets from the service. -- | Fetch all buckets from the service.
getService :: Minio [BucketInfo] getService :: Minio [BucketInfo]
getService = do getService = do
resp <- resp <- executeRequest $ def {
executeRequest $ riNeedsLocation = False
defaultS3ReqInfo }
{ riNeedsLocation = False
}
parseListBuckets $ NC.responseBody resp parseListBuckets $ NC.responseBody resp
-- Parse headers from getObject and headObject calls. -- | GET an object from the service and return the response headers
parseGetObjectHeaders :: Object -> [HT.Header] -> Maybe ObjectInfo -- and a conduit source for the object content
parseGetObjectHeaders object headers = getObject' :: Bucket -> Object -> HT.Query -> [HT.Header]
let metadataPairs = getMetadata headers -> Minio ([HT.Header], C.ResumableSource Minio ByteString)
userMetadata = getUserMetadataMap metadataPairs
metadata = getNonUserMetadataMap metadataPairs
in ObjectInfo
<$> Just object
<*> getLastModifiedHeader headers
<*> getETagHeader headers
<*> getContentLength headers
<*> Just userMetadata
<*> Just metadata
-- | GET an object from the service and return parsed ObjectInfo and a
-- conduit source for the object content
getObject' ::
Bucket ->
Object ->
HT.Query ->
[HT.Header] ->
Minio GetObjectResponse
getObject' bucket object queryParams headers = do getObject' bucket object queryParams headers = do
resp <- mkStreamRequest reqInfo resp <- mkStreamRequest reqInfo
let objInfoMaybe = parseGetObjectHeaders object $ NC.responseHeaders resp return (NC.responseHeaders resp, NC.responseBody resp)
objInfo <-
maybe
(throwIO MErrVInvalidObjectInfoResponse)
return
objInfoMaybe
return $
GetObjectResponse
{ gorObjectInfo = objInfo,
gorObjectStream = NC.responseBody resp
}
where where
reqInfo = reqInfo = def { riBucket = Just bucket
defaultS3ReqInfo , riObject = Just object
{ riBucket = Just bucket, , riQueryParams = queryParams
riObject = Just object, , riHeaders = headers
riQueryParams = queryParams, }
riHeaders =
headers
-- This header is required for safety as otherwise http-client,
-- sends Accept-Encoding: gzip, and the server may actually gzip
-- body. In that case Content-Length header will be missing.
<> [("Accept-Encoding", "identity")]
}
-- | Creates a bucket via a PUT bucket call. -- | Creates a bucket via a PUT bucket call.
putBucket :: Bucket -> Region -> Minio () putBucket :: Bucket -> Region -> Minio ()
putBucket bucket location = do putBucket bucket location = void $
ns <- asks getSvcNamespace executeRequest $
void $ def { riMethod = HT.methodPut
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riPayload = PayloadBS $ mkCreateBucketConfig location
{ riMethod = HT.methodPut, , riNeedsLocation = False
riBucket = Just bucket,
riPayload = PayloadBS $ mkCreateBucketConfig ns location,
riNeedsLocation = False
} }
-- | Single PUT object size. -- | Single PUT object size.
maxSinglePutObjectSizeBytes :: Int64 maxSinglePutObjectSizeBytes :: Int64
maxSinglePutObjectSizeBytes = 5 * 1024 * 1024 * 1024 maxSinglePutObjectSizeBytes = 5 * 1024 * 1024 * 1024
-- | PUT an object into the service. This function performs a single
-- PUT object call and uses a strict ByteString as the object
-- data. `putObjectSingle` is preferable as the object data will not
-- be resident in memory.
putObjectSingle' :: Bucket -> Object -> [HT.Header] -> ByteString -> Minio ETag
putObjectSingle' bucket object headers bs = do
let size = fromIntegral (BS.length bs)
-- check length is within single PUT object size.
when (size > maxSinglePutObjectSizeBytes) $
throwIO $
MErrVSinglePUTSizeExceeded size
let payload = mkStreamingPayload $ PayloadBS bs
resp <-
executeRequest $
defaultS3ReqInfo
{ riMethod = HT.methodPut,
riBucket = Just bucket,
riObject = Just object,
riHeaders = headers,
riPayload = payload
}
let rheaders = NC.responseHeaders resp
etag = getETagHeader rheaders
maybe
(throwIO MErrVETagHeaderNotFound)
return
etag
-- | PUT an object into the service. This function performs a single -- | PUT an object into the service. This function performs a single
-- PUT object call, and so can only transfer objects upto 5GiB. -- PUT object call, and so can only transfer objects upto 5GiB.
putObjectSingle :: putObjectSingle :: Bucket -> Object -> [HT.Header] -> Handle -> Int64
Bucket -> -> Int64 -> Minio ETag
Object ->
[HT.Header] ->
Handle ->
Int64 ->
Int64 ->
Minio ETag
putObjectSingle bucket object headers h offset size = do putObjectSingle bucket object headers h offset size = do
-- check length is within single PUT object size. -- check length is within single PUT object size.
when (size > maxSinglePutObjectSizeBytes) $ when (size > maxSinglePutObjectSizeBytes) $
throwIO $ throwM $ MErrVSinglePUTSizeExceeded size
MErrVSinglePUTSizeExceeded size
-- content-length header is automatically set by library. -- content-length header is automatically set by library.
let payload = mkStreamingPayload $ PayloadH h offset size resp <- executeRequest $
resp <- def { riMethod = HT.methodPut
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riObject = Just object
{ riMethod = HT.methodPut, , riHeaders = headers
riBucket = Just bucket, , riPayload = PayloadH h offset size
riObject = Just object, }
riHeaders = headers,
riPayload = payload
}
let rheaders = NC.responseHeaders resp let rheaders = NC.responseHeaders resp
etag = getETagHeader rheaders etag = getETagHeader rheaders
maybe maybe
(throwIO MErrVETagHeaderNotFound) (throwM MErrVETagHeaderNotFound)
return return etag
etag
-- | List objects in a bucket matching prefix up to delimiter, -- | List objects in a bucket matching prefix up to delimiter,
-- starting from nextMarker. -- starting from nextMarker.
listObjectsV1' :: listObjectsV1' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Int
Bucket -> -> Minio ListObjectsV1Result
Maybe Text ->
Maybe Text ->
Maybe Text ->
Maybe Int ->
Minio ListObjectsV1Result
listObjectsV1' bucket prefix nextMarker delimiter maxKeys = do listObjectsV1' bucket prefix nextMarker delimiter maxKeys = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodGet
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riQueryParams = mkOptionalParams params
{ riMethod = HT.methodGet, }
riBucket = Just bucket,
riQueryParams = mkOptionalParams params
}
parseListObjectsV1Response $ NC.responseBody resp parseListObjectsV1Response $ NC.responseBody resp
where where
params = params = [
[ ("marker", nextMarker), ("marker", nextMarker)
("prefix", prefix), , ("prefix", prefix)
("delimiter", delimiter), , ("delimiter", delimiter)
("max-keys", show <$> maxKeys) , ("max-keys", show <$> maxKeys)
] ]
-- | List objects in a bucket matching prefix up to delimiter, -- | List objects in a bucket matching prefix up to delimiter,
-- starting from nextToken. -- starting from nextToken.
listObjects' :: listObjects' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Int
Bucket -> -> Minio ListObjectsResult
Maybe Text ->
Maybe Text ->
Maybe Text ->
Maybe Int ->
Minio ListObjectsResult
listObjects' bucket prefix nextToken delimiter maxKeys = do listObjects' bucket prefix nextToken delimiter maxKeys = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodGet
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riQueryParams = mkOptionalParams params
{ riMethod = HT.methodGet, }
riBucket = Just bucket,
riQueryParams = mkOptionalParams params
}
parseListObjectsResponse $ NC.responseBody resp parseListObjectsResponse $ NC.responseBody resp
where where
params = params = [
[ ("list-type", Just "2"), ("list-type", Just "2")
("continuation_token", nextToken), , ("continuation_token", nextToken)
("prefix", prefix), , ("prefix", prefix)
("delimiter", delimiter), , ("delimiter", delimiter)
("max-keys", show <$> maxKeys) , ("max-keys", show <$> maxKeys)
] ]
-- | DELETE a bucket from the service. -- | DELETE a bucket from the service.
deleteBucket :: Bucket -> Minio () deleteBucket :: Bucket -> Minio ()
deleteBucket bucket = deleteBucket bucket = void $
void $ executeRequest $
executeRequest $ def { riMethod = HT.methodDelete
defaultS3ReqInfo , riBucket = Just bucket
{ riMethod = HT.methodDelete,
riBucket = Just bucket
} }
-- | DELETE an object from the service. -- | DELETE an object from the service.
deleteObject :: Bucket -> Object -> Minio () deleteObject :: Bucket -> Object -> Minio ()
deleteObject bucket object = deleteObject bucket object = void $
void $ executeRequest $
executeRequest $ def { riMethod = HT.methodDelete
defaultS3ReqInfo , riBucket = Just bucket
{ riMethod = HT.methodDelete, , riObject = Just object
riBucket = Just bucket,
riObject = Just object
} }
-- | Create a new multipart upload. -- | Create a new multipart upload.
newMultipartUpload :: Bucket -> Object -> [HT.Header] -> Minio UploadId newMultipartUpload :: Bucket -> Object -> [HT.Header] -> Minio UploadId
newMultipartUpload bucket object headers = do newMultipartUpload bucket object headers = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodPost
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riObject = Just object
{ riMethod = HT.methodPost, , riQueryParams = [("uploads", Nothing)]
riBucket = Just bucket, , riHeaders = headers
riObject = Just object, }
riQueryParams = [("uploads", Nothing)],
riHeaders = headers
}
parseNewMultipartUpload $ NC.responseBody resp parseNewMultipartUpload $ NC.responseBody resp
-- | PUT a part of an object as part of a multipart upload. -- | PUT a part of an object as part of a multipart upload.
putObjectPart :: putObjectPart :: Bucket -> Object -> UploadId -> PartNumber -> [HT.Header]
Bucket -> -> Payload -> Minio PartTuple
Object ->
UploadId ->
PartNumber ->
[HT.Header] ->
Payload ->
Minio PartTuple
putObjectPart bucket object uploadId partNumber headers payload = do putObjectPart bucket object uploadId partNumber headers payload = do
-- transform payload to conduit to enable streaming signature resp <- executeRequest $
let payload' = mkStreamingPayload payload def { riMethod = HT.methodPut
resp <- , riBucket = Just bucket
executeRequest $ , riObject = Just object
defaultS3ReqInfo , riQueryParams = mkOptionalParams params
{ riMethod = HT.methodPut, , riHeaders = headers
riBucket = Just bucket, , riPayload = payload
riObject = Just object, }
riQueryParams = mkOptionalParams params,
riHeaders = headers,
riPayload = payload'
}
let rheaders = NC.responseHeaders resp let rheaders = NC.responseHeaders resp
etag = getETagHeader rheaders etag = getETagHeader rheaders
maybe maybe
(throwIO MErrVETagHeaderNotFound) (throwM MErrVETagHeaderNotFound)
(return . (partNumber,)) (return . (partNumber, )) etag
etag
where where
params = params = [
[ ("uploadId", Just uploadId), ("uploadId", Just uploadId)
("partNumber", Just $ show partNumber) , ("partNumber", Just $ show partNumber)
] ]
srcInfoToHeaders :: SourceInfo -> [HT.Header]
srcInfoToHeaders srcInfo =
( "x-amz-copy-source",
encodeUtf8 $
T.concat
[ "/",
srcBucket srcInfo,
"/",
srcObject srcInfo
]
)
: rangeHdr
++ zip names values
where
names =
[ "x-amz-copy-source-if-match",
"x-amz-copy-source-if-none-match",
"x-amz-copy-source-if-unmodified-since",
"x-amz-copy-source-if-modified-since"
]
values =
mapMaybe
(fmap encodeUtf8 . (srcInfo &))
[ srcIfMatch,
srcIfNoneMatch,
fmap formatRFC1123 . srcIfUnmodifiedSince,
fmap formatRFC1123 . srcIfModifiedSince
]
rangeHdr =
maybe [] ((\a -> [("x-amz-copy-source-range", HT.renderByteRanges [a])]) . toByteRange) (srcRange srcInfo)
toByteRange :: (Int64, Int64) -> HT.ByteRange
toByteRange (x, y) = HT.ByteRangeFromTo (fromIntegral x) (fromIntegral y)
-- | Performs server-side copy of an object or part of an object as an -- | Performs server-side copy of an object or part of an object as an
-- upload part of an ongoing multi-part upload. -- upload part of an ongoing multi-part upload.
copyObjectPart :: copyObjectPart :: Bucket -> Object -> CopyPartSource -> UploadId
DestinationInfo -> -> PartNumber -> [HT.Header] -> Minio (ETag, UTCTime)
SourceInfo -> copyObjectPart bucket object cps uploadId partNumber headers = do
UploadId -> resp <- executeRequest $
PartNumber -> def { riMethod = HT.methodPut
[HT.Header] -> , riBucket = Just bucket
Minio (ETag, UTCTime) , riObject = Just object
copyObjectPart dstInfo srcInfo uploadId partNumber headers = do , riQueryParams = mkOptionalParams params
resp <- , riHeaders = headers ++ cpsToHeaders cps
executeRequest $ }
defaultS3ReqInfo
{ riMethod = HT.methodPut,
riBucket = Just $ dstBucket dstInfo,
riObject = Just $ dstObject dstInfo,
riQueryParams = mkOptionalParams params,
riHeaders = headers ++ srcInfoToHeaders srcInfo
}
parseCopyObjectResponse $ NC.responseBody resp parseCopyObjectResponse $ NC.responseBody resp
where where
params = params = [
[ ("uploadId", Just uploadId), ("uploadId", Just uploadId)
("partNumber", Just $ show partNumber) , ("partNumber", Just $ show partNumber)
] ]
-- | Performs server-side copy of an object that is upto 5GiB in -- | Performs server-side copy of an object that is upto 5GiB in
-- size. If the object is greater than 5GiB, this function throws the -- size. If the object is greater than 5GiB, this function throws the
-- error returned by the server. -- error returned by the server.
copyObjectSingle :: copyObjectSingle :: Bucket -> Object -> CopyPartSource -> [HT.Header]
Bucket -> -> Minio (ETag, UTCTime)
Object -> copyObjectSingle bucket object cps headers = do
SourceInfo -> -- validate that cpSourceRange is Nothing for this API.
[HT.Header] -> when (isJust $ cpSourceRange cps) $
Minio (ETag, UTCTime) throwM MErrVCopyObjSingleNoRangeAccepted
copyObjectSingle bucket object srcInfo headers = do resp <- executeRequest $
-- validate that srcRange is Nothing for this API. def { riMethod = HT.methodPut
when (isJust $ srcRange srcInfo) $ , riBucket = Just bucket
throwIO MErrVCopyObjSingleNoRangeAccepted , riObject = Just object
resp <- , riHeaders = headers ++ cpsToHeaders cps
executeRequest $ }
defaultS3ReqInfo
{ riMethod = HT.methodPut,
riBucket = Just bucket,
riObject = Just object,
riHeaders = headers ++ srcInfoToHeaders srcInfo
}
parseCopyObjectResponse $ NC.responseBody resp parseCopyObjectResponse $ NC.responseBody resp
-- | Complete a multipart upload. -- | Complete a multipart upload.
completeMultipartUpload :: completeMultipartUpload :: Bucket -> Object -> UploadId -> [PartTuple]
Bucket -> -> Minio ETag
Object ->
UploadId ->
[PartTuple] ->
Minio ETag
completeMultipartUpload bucket object uploadId partTuple = do completeMultipartUpload bucket object uploadId partTuple = do
resp <- resp <- executeRequest $
executeRequest $ def { riMethod = HT.methodPost
defaultS3ReqInfo , riBucket = Just bucket
{ riMethod = HT.methodPost, , riObject = Just object
riBucket = Just bucket, , riQueryParams = mkOptionalParams params
riObject = Just object, , riPayload = PayloadBS $
riQueryParams = mkOptionalParams params, mkCompleteMultipartUploadRequest partTuple
riPayload = }
PayloadBS $
mkCompleteMultipartUploadRequest partTuple
}
parseCompleteMultipartUploadResponse $ NC.responseBody resp parseCompleteMultipartUploadResponse $ NC.responseBody resp
where where
params = [("uploadId", Just uploadId)] params = [("uploadId", Just uploadId)]
-- | Abort a multipart upload. -- | Abort a multipart upload.
abortMultipartUpload :: Bucket -> Object -> UploadId -> Minio () abortMultipartUpload :: Bucket -> Object -> UploadId -> Minio ()
abortMultipartUpload bucket object uploadId = abortMultipartUpload bucket object uploadId = void $
void $ executeRequest $ def { riMethod = HT.methodDelete
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riObject = Just object
{ riMethod = HT.methodDelete, , riQueryParams = mkOptionalParams params
riBucket = Just bucket, }
riObject = Just object,
riQueryParams = mkOptionalParams params
}
where where
params = [("uploadId", Just uploadId)] params = [("uploadId", Just uploadId)]
-- | List incomplete multipart uploads. -- | List incomplete multipart uploads.
listIncompleteUploads' :: listIncompleteUploads' :: Bucket -> Maybe Text -> Maybe Text -> Maybe Text
Bucket -> -> Maybe Text -> Maybe Int -> Minio ListUploadsResult
Maybe Text ->
Maybe Text ->
Maybe Text ->
Maybe Text ->
Maybe Int ->
Minio ListUploadsResult
listIncompleteUploads' bucket prefix delimiter keyMarker uploadIdMarker maxKeys = do listIncompleteUploads' bucket prefix delimiter keyMarker uploadIdMarker maxKeys = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodGet
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riQueryParams = params
{ riMethod = HT.methodGet, }
riBucket = Just bucket,
riQueryParams = params
}
parseListUploadsResponse $ NC.responseBody resp parseListUploadsResponse $ NC.responseBody resp
where where
-- build query params -- build query params
params = params = ("uploads", Nothing) : mkOptionalParams
("uploads", Nothing) [ ("prefix", prefix)
: mkOptionalParams , ("delimiter", delimiter)
[ ("prefix", prefix), , ("key-marker", keyMarker)
("delimiter", delimiter), , ("upload-id-marker", uploadIdMarker)
("key-marker", keyMarker), , ("max-uploads", show <$> maxKeys)
("upload-id-marker", uploadIdMarker), ]
("max-uploads", show <$> maxKeys)
]
-- | List parts of an ongoing multipart upload. -- | List parts of an ongoing multipart upload.
listIncompleteParts' :: listIncompleteParts' :: Bucket -> Object -> UploadId -> Maybe Text
Bucket -> -> Maybe Text -> Minio ListPartsResult
Object ->
UploadId ->
Maybe Text ->
Maybe Text ->
Minio ListPartsResult
listIncompleteParts' bucket object uploadId maxParts partNumMarker = do listIncompleteParts' bucket object uploadId maxParts partNumMarker = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodGet
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riObject = Just object
{ riMethod = HT.methodGet, , riQueryParams = mkOptionalParams params
riBucket = Just bucket, }
riObject = Just object,
riQueryParams = mkOptionalParams params
}
parseListPartsResponse $ NC.responseBody resp parseListPartsResponse $ NC.responseBody resp
where where
-- build optional query params -- build optional query params
params = params = [
[ ("uploadId", Just uploadId), ("uploadId", Just uploadId)
("part-number-marker", partNumMarker), , ("part-number-marker", partNumMarker)
("max-parts", maxParts) , ("max-parts", maxParts)
] ]
-- | Get metadata of an object. -- | Get metadata of an object.
headObject :: Bucket -> Object -> [HT.Header] -> Minio ObjectInfo headObject :: Bucket -> Object -> Minio ObjectInfo
headObject bucket object reqHeaders = do headObject bucket object = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodHead
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riObject = Just object
{ riMethod = HT.methodHead, }
riBucket = Just bucket,
riObject = Just object, let
riHeaders = headers = NC.responseHeaders resp
reqHeaders modTime = getLastModifiedHeader headers
-- This header is required for safety as otherwise http-client, etag = getETagHeader headers
-- sends Accept-Encoding: gzip, and the server may actually gzip size = getContentLength headers
-- body. In that case Content-Length header will be missing.
<> [("Accept-Encoding", "identity")] maybe (throwM MErrVInvalidObjectInfoResponse) return $
} ObjectInfo <$> Just object <*> modTime <*> etag <*> size
maybe (throwIO MErrVInvalidObjectInfoResponse) return $
parseGetObjectHeaders object $
NC.responseHeaders resp
-- | Query the object store if a given bucket exists. -- | Query the object store if a given bucket exists.
headBucket :: Bucket -> Minio Bool headBucket :: Bucket -> Minio Bool
headBucket bucket = headBucket bucket = headBucketEx `catches`
headBucketEx [ Handler handleNoSuchBucket
`catches` [ Handler handleNoSuchBucket, , Handler handleStatus404
Handler handleStatus404 ]
]
where where
handleNoSuchBucket :: ServiceErr -> Minio Bool handleNoSuchBucket :: ServiceErr -> Minio Bool
handleNoSuchBucket e handleNoSuchBucket e | e == NoSuchBucket = return False
| e == NoSuchBucket = return False | otherwise = throwM e
| otherwise = throwIO e
handleStatus404 :: NC.HttpException -> Minio Bool handleStatus404 :: NC.HttpException -> Minio Bool
handleStatus404 e@(NC.HttpExceptionRequest _ (NC.StatusCodeException res _)) = handleStatus404 e@(NC.HttpExceptionRequest _ (NC.StatusCodeException res _)) =
if NC.responseStatus res == status404 if NC.responseStatus res == status404
then return False then return False
else throwIO e else throwM e
handleStatus404 e = throwIO e handleStatus404 e = throwM e
headBucketEx = do headBucketEx = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodHead
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo }
{ riMethod = HT.methodHead,
riBucket = Just bucket
}
return $ NC.responseStatus resp == HT.ok200 return $ NC.responseStatus resp == HT.ok200
-- | Set the notification configuration on a bucket. -- | Set the notification configuration on a bucket.
putBucketNotification :: Bucket -> Notification -> Minio () putBucketNotification :: Bucket -> Notification -> Minio ()
putBucketNotification bucket ncfg = do putBucketNotification bucket ncfg =
ns <- asks getSvcNamespace void $ executeRequest $ def { riMethod = HT.methodPut
void $ , riBucket = Just bucket
executeRequest $ , riQueryParams = [("notification", Nothing)]
defaultS3ReqInfo , riPayload = PayloadBS $
{ riMethod = HT.methodPut, mkPutNotificationRequest ncfg
riBucket = Just bucket, }
riQueryParams = [("notification", Nothing)],
riPayload =
PayloadBS $
mkPutNotificationRequest ns ncfg
}
-- | Retrieve the notification configuration on a bucket. -- | Retrieve the notification configuration on a bucket.
getBucketNotification :: Bucket -> Minio Notification getBucketNotification :: Bucket -> Minio Notification
getBucketNotification bucket = do getBucketNotification bucket = do
resp <- resp <- executeRequest $ def { riMethod = HT.methodGet
executeRequest $ , riBucket = Just bucket
defaultS3ReqInfo , riQueryParams = [("notification", Nothing)]
{ riMethod = HT.methodGet, }
riBucket = Just bucket,
riQueryParams = [("notification", Nothing)]
}
parseNotification $ NC.responseBody resp parseNotification $ NC.responseBody resp
-- | Remove all notifications configured on a bucket. -- | Remove all notifications configured on a bucket.
removeAllBucketNotification :: Bucket -> Minio () removeAllBucketNotification :: Bucket -> Minio ()
removeAllBucketNotification = flip putBucketNotification defaultNotification removeAllBucketNotification = flip putBucketNotification def
-- | Fetch the policy if any on a bucket.
getBucketPolicy :: Bucket -> Minio Text
getBucketPolicy bucket = do
resp <-
executeRequest $
defaultS3ReqInfo
{ riMethod = HT.methodGet,
riBucket = Just bucket,
riQueryParams = [("policy", Nothing)]
}
return $ decodeUtf8Lenient $ toStrictBS $ NC.responseBody resp
-- | Set a new policy on a bucket.
-- As a special condition if the policy is empty
-- then we treat it as policy DELETE operation.
setBucketPolicy :: Bucket -> Text -> Minio ()
setBucketPolicy bucket policy = do
if T.null policy
then deleteBucketPolicy bucket
else putBucketPolicy bucket policy
-- | Save a new policy on a bucket.
putBucketPolicy :: Bucket -> Text -> Minio ()
putBucketPolicy bucket policy = do
void $
executeRequest $
defaultS3ReqInfo
{ riMethod = HT.methodPut,
riBucket = Just bucket,
riQueryParams = [("policy", Nothing)],
riPayload = PayloadBS $ encodeUtf8 policy
}
-- | Delete any policy set on a bucket.
deleteBucketPolicy :: Bucket -> Minio ()
deleteBucketPolicy bucket = do
void $
executeRequest $
defaultS3ReqInfo
{ riMethod = HT.methodDelete,
riBucket = Just bucket,
riQueryParams = [("policy", Nothing)]
}

View File

@ -1,294 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.SelectAPI
( -- | The `selectObjectContent` allows querying CSV, JSON or Parquet
-- format objects in AWS S3 and in MinIO using SQL Select
-- statements. This allows significant reduction of data transfer
-- from object storage for computation-intensive tasks, as relevant
-- data is filtered close to the storage.
selectObjectContent,
SelectRequest,
selectRequest,
-- *** Input Serialization
InputSerialization,
defaultCsvInput,
linesJsonInput,
documentJsonInput,
defaultParquetInput,
setInputCSVProps,
CompressionType (..),
setInputCompressionType,
-- *** CSV Format details
-- | CSV format options such as delimiters and quote characters are
-- specified using using the functions below. Options are combined
-- monoidally.
CSVProp,
recordDelimiter,
fieldDelimiter,
quoteCharacter,
quoteEscapeCharacter,
commentCharacter,
allowQuotedRecordDelimiter,
FileHeaderInfo (..),
fileHeaderInfo,
QuoteFields (..),
quoteFields,
-- *** Output Serialization
OutputSerialization,
defaultCsvOutput,
defaultJsonOutput,
outputCSVFromProps,
outputJSONFromRecordDelimiter,
-- *** Progress messages
setRequestProgressEnabled,
-- *** Interpreting Select output
-- | The conduit returned by `selectObjectContent` returns values of
-- the `EventMessage` data type. This returns the query output
-- messages formatted according to the chosen output serialization,
-- interleaved with progress messages (if enabled by
-- `setRequestProgressEnabled`), and at the end a statistics
-- message.
--
-- If the application is interested in only the payload, then
-- `getPayloadBytes` can be used. For example to simply print the
-- payload to stdout:
--
-- > resultConduit <- selectObjectContent bucket object mySelectRequest
-- > runConduit $ resultConduit .| getPayloadBytes .| stdoutC
--
-- Note that runConduit, the connect operator (.|) and stdoutC are
-- all from the "conduit" package.
getPayloadBytes,
EventMessage (..),
Progress (..),
Stats,
)
where
import Conduit ((.|))
import qualified Conduit as C
import qualified Data.Binary as Bin
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as LB
import Data.Digest.CRC32 (crc32, crc32Update)
import Lib.Prelude
import qualified Network.HTTP.Conduit as NC
import qualified Network.HTTP.Types as HT
import Network.Minio.API
import Network.Minio.Data
import Network.Minio.Errors
import Network.Minio.Utils
import Network.Minio.XmlGenerator
import Network.Minio.XmlParser
import UnliftIO (MonadUnliftIO)
data EventStreamException
= ESEPreludeCRCFailed
| ESEMessageCRCFailed
| ESEUnexpectedEndOfStream
| ESEDecodeFail [Char]
| ESEInvalidHeaderType
| ESEInvalidHeaderValueType
| ESEInvalidMessageType
deriving stock (Eq, Show)
instance Exception EventStreamException
-- chunkSize in bytes is 32KiB
chunkSize :: Int
chunkSize = 32 * 1024
parseBinary :: (Bin.Binary a) => ByteString -> IO a
parseBinary b = do
case Bin.decodeOrFail $ LB.fromStrict b of
Left (_, _, msg) -> throwIO $ ESEDecodeFail msg
Right (_, _, r) -> return r
bytesToHeaderName :: Text -> IO MsgHeaderName
bytesToHeaderName t = case t of
":message-type" -> return MessageType
":event-type" -> return EventType
":content-type" -> return ContentType
":error-code" -> return ErrorCode
":error-message" -> return ErrorMessage
_ -> throwIO ESEInvalidHeaderType
parseHeaders ::
(MonadUnliftIO m) =>
Word32 ->
C.ConduitM ByteString a m [MessageHeader]
parseHeaders 0 = return []
parseHeaders hdrLen = do
bs1 <- readNBytes 1
n :: Word8 <- liftIO $ parseBinary bs1
headerKeyBytes <- readNBytes $ fromIntegral n
let headerKey = decodeUtf8Lenient headerKeyBytes
headerName <- liftIO $ bytesToHeaderName headerKey
bs2 <- readNBytes 1
headerValueType :: Word8 <- liftIO $ parseBinary bs2
when (headerValueType /= 7) $ throwIO ESEInvalidHeaderValueType
bs3 <- readNBytes 2
vLen :: Word16 <- liftIO $ parseBinary bs3
headerValueBytes <- readNBytes $ fromIntegral vLen
let headerValue = decodeUtf8Lenient headerValueBytes
m = (headerName, headerValue)
k = 1 + fromIntegral n + 1 + 2 + fromIntegral vLen
ms <- parseHeaders (hdrLen - k)
return (m : ms)
-- readNBytes returns N bytes read from the string and throws an
-- exception if N bytes are not present on the stream.
readNBytes :: (MonadUnliftIO m) => Int -> C.ConduitM ByteString a m ByteString
readNBytes n = do
b <- LB.toStrict <$> (C.takeCE n .| C.sinkLazy)
if B.length b /= n
then throwIO ESEUnexpectedEndOfStream
else return b
crcCheck ::
(MonadUnliftIO m) =>
C.ConduitM ByteString ByteString m ()
crcCheck = do
b <- readNBytes 12
n :: Word32 <- liftIO $ parseBinary $ B.take 4 b
preludeCRC :: Word32 <- liftIO $ parseBinary $ B.drop 8 b
when (crc32 (B.take 8 b) /= preludeCRC) $
throwIO ESEPreludeCRCFailed
-- we do not yield the checksum
C.yield $ B.take 8 b
-- 12 bytes have been read off the current message. Now read the
-- next (n-12)-4 bytes and accumulate the checksum, and yield it.
let startCrc = crc32 b
finalCrc <- accumulateYield (fromIntegral n - 16) startCrc
bs <- readNBytes 4
expectedCrc :: Word32 <- liftIO $ parseBinary bs
when (finalCrc /= expectedCrc) $
throwIO ESEMessageCRCFailed
-- we unconditionally recurse - downstream figures out when to
-- quit reading the stream
crcCheck
where
accumulateYield n checkSum = do
let toRead = min n chunkSize
b <- readNBytes toRead
let c' = crc32Update checkSum b
n' = n - B.length b
C.yield b
if n' > 0
then accumulateYield n' c'
else return c'
handleMessage :: (MonadUnliftIO m) => C.ConduitT ByteString EventMessage m ()
handleMessage = do
b1 <- readNBytes 4
msgLen :: Word32 <- liftIO $ parseBinary b1
b2 <- readNBytes 4
hdrLen :: Word32 <- liftIO $ parseBinary b2
hs <- parseHeaders hdrLen
let payloadLen = msgLen - hdrLen - 16
getHdrVal h = fmap snd . find ((h ==) . fst)
eventHdrValue = getHdrVal EventType hs
msgHdrValue = getHdrVal MessageType hs
errCode = getHdrVal ErrorCode hs
errMsg = getHdrVal ErrorMessage hs
case msgHdrValue of
Just "event" -> do
case eventHdrValue of
Just "Records" -> passThrough $ fromIntegral payloadLen
Just "Cont" -> return ()
Just "Progress" -> do
bs <- readNBytes $ fromIntegral payloadLen
progress <- parseSelectProgress bs
C.yield $ ProgressEventMessage progress
Just "Stats" -> do
bs <- readNBytes $ fromIntegral payloadLen
stats <- parseSelectProgress bs
C.yield $ StatsEventMessage stats
Just "End" -> return ()
_ -> throwIO ESEInvalidMessageType
when (eventHdrValue /= Just "End") handleMessage
Just "error" -> do
let reqMsgMay = RequestLevelErrorMessage <$> errCode <*> errMsg
maybe (throwIO ESEInvalidMessageType) C.yield reqMsgMay
_ -> throwIO ESEInvalidMessageType
where
passThrough 0 = return ()
passThrough n = do
let c = min n chunkSize
b <- readNBytes c
C.yield $ RecordPayloadEventMessage b
passThrough $ n - B.length b
selectProtoConduit ::
(MonadUnliftIO m) =>
C.ConduitT ByteString EventMessage m ()
selectProtoConduit = crcCheck .| handleMessage
-- | selectObjectContent calls the SelectRequest on the given
-- object. It returns a Conduit of event messages that can be consumed
-- by the client.
selectObjectContent ::
Bucket ->
Object ->
SelectRequest ->
Minio (C.ConduitT () EventMessage Minio ())
selectObjectContent b o r = do
let reqInfo =
defaultS3ReqInfo
{ riMethod = HT.methodPost,
riBucket = Just b,
riObject = Just o,
riPayload = PayloadBS $ mkSelectRequest r,
riNeedsLocation = False,
riQueryParams = [("select", Nothing), ("select-type", Just "2")]
}
-- print $ mkSelectRequest r
resp <- mkStreamRequest reqInfo
return $ NC.responseBody resp .| selectProtoConduit
-- | A helper conduit that returns only the record payload bytes.
getPayloadBytes :: (MonadIO m) => C.ConduitT EventMessage ByteString m ()
getPayloadBytes = do
evM <- C.await
case evM of
Just v -> do
case v of
RecordPayloadEventMessage b -> C.yield b
RequestLevelErrorMessage c m -> liftIO $ throwIO $ SelectErr c m
_ -> return ()
getPayloadBytes
Nothing -> return ()

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -13,313 +13,219 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE BangPatterns #-}
module Network.Minio.Sign.V4 module Network.Minio.Sign.V4
( SignParams (..), (
signV4QueryParams, signV4
signV4, , signV4AtTime
signV4PostPolicy, , signV4PostPolicy
signV4Stream, , mkScope
Service (..), , getHeadersToSign
credentialScope, , mkCanonicalRequest
) , mkStringToSign
where , mkSigningKey
, computeSignature
, SignV4Data(..)
, debugPrintSignV4Data
) where
import qualified Conduit as C
import qualified Data.ByteArray as BA
import qualified Data.ByteString as B import qualified Data.ByteString as B
import qualified Data.ByteString.Base64 as Base64
import qualified Data.ByteString.Char8 as B8 import qualified Data.ByteString.Char8 as B8
import qualified Data.ByteString.Lazy as LB import Data.CaseInsensitive (mk)
import Data.CaseInsensitive (mk)
import qualified Data.CaseInsensitive as CI import qualified Data.CaseInsensitive as CI
import qualified Data.HashMap.Strict as Map import qualified Data.Set as Set
import qualified Data.HashSet as Set
import Data.List (partition)
import qualified Data.List.NonEmpty as NE
import qualified Data.Time as Time import qualified Data.Time as Time
import Lib.Prelude import qualified Data.ByteString.Base64 as Base64
import qualified Network.HTTP.Conduit as NC import qualified Data.Map.Strict as Map
import Network.HTTP.Types (Header, SimpleQuery, hContentEncoding, parseQuery) import Network.HTTP.Types (Header)
import qualified Network.HTTP.Types as H import qualified Network.HTTP.Types.Header as H
import Network.HTTP.Types.Header (RequestHeaders)
import Network.Minio.Data.ByteString import Lib.Prelude
import Network.Minio.Data.Crypto import Network.Minio.Data
import Network.Minio.Data.Time import Network.Minio.Data.ByteString
import Network.Minio.Errors import Network.Minio.Data.Crypto
import Text.Printf (printf) import Network.Minio.Data.Time
-- these headers are not included in the string to sign when signing a -- these headers are not included in the string to sign when signing a
-- request -- request
ignoredHeaders :: Set.HashSet ByteString ignoredHeaders :: Set ByteString
ignoredHeaders = ignoredHeaders = Set.fromList $ map CI.foldedCase
Set.fromList $ [ H.hAuthorization
map , H.hContentType
CI.foldedCase , H.hContentLength
[ H.hAuthorization, , H.hUserAgent
H.hContentType, ]
H.hUserAgent
]
data Service = ServiceS3 | ServiceSTS data SignV4Data = SignV4Data {
deriving stock (Eq, Show) sv4SignTime :: UTCTime
, sv4Scope :: ByteString
, sv4CanonicalRequest :: ByteString
, sv4HeadersToSign :: [(ByteString, ByteString)]
, sv4Output :: [(ByteString, ByteString)]
, sv4StringToSign :: ByteString
, sv4SigningKey :: ByteString
} deriving (Show)
toByteString :: Service -> ByteString debugPrintSignV4Data :: SignV4Data -> IO ()
toByteString ServiceS3 = "s3" debugPrintSignV4Data (SignV4Data t s cr h2s o sts sk) = do
toByteString ServiceSTS = "sts" B8.putStrLn "SignV4Data:"
B8.putStr "Timestamp: " >> print t
B8.putStr "Scope: " >> B8.putStrLn s
B8.putStrLn "Canonical Request:"
B8.putStrLn cr
B8.putStr "Headers to Sign: " >> print h2s
B8.putStr "Output: " >> print o
B8.putStr "StringToSign: " >> B8.putStrLn sts
B8.putStr "SigningKey: " >> printBytes sk
B8.putStrLn "END of SignV4Data ========="
where
printBytes b = do
mapM_ (\x -> B.putStr $ B.concat [show x, " "]) $ B.unpack b
B8.putStrLn ""
data SignParams = SignParams -- | Given MinioClient and request details, including request method,
{ spAccessKey :: Text,
spSecretKey :: BA.ScrubbedBytes,
spSessionToken :: Maybe BA.ScrubbedBytes,
spService :: Service,
spTimeStamp :: UTCTime,
spRegion :: Maybe Text,
spExpirySecs :: Maybe UrlExpiry,
spPayloadHash :: Maybe ByteString
}
deriving stock (Show)
mkAuthHeader :: Text -> ByteString -> ByteString -> ByteString -> H.Header
mkAuthHeader accessKey scope signedHeaderKeys sign =
let authValue =
B.concat
[ "AWS4-HMAC-SHA256 Credential=",
encodeUtf8 accessKey,
"/",
scope,
", SignedHeaders=",
signedHeaderKeys,
", Signature=",
sign
]
in (H.hAuthorization, authValue)
data IsStreaming = IsStreamingLength Int64 | NotStreaming
deriving stock (Eq, Show)
amzSecurityToken :: ByteString
amzSecurityToken = "X-Amz-Security-Token"
-- | Given SignParams and request details, including request method,
-- request path, headers, query params and payload hash, generates an -- request path, headers, query params and payload hash, generates an
-- updated set of headers, including the x-amz-date header and the -- updated set of headers, including the x-amz-date header and the
-- Authorization header, which includes the signature. -- Authorization header, which includes the signature.
-- signV4 :: ConnectInfo -> RequestInfo -> Maybe Int
-- For normal requests (i.e. without an expiry time), the output is -> IO [(ByteString, ByteString)]
-- the list of headers to add to authenticate the request. signV4 !ci !ri !expiry = do
timestamp <- Time.getCurrentTime
let signData = signV4AtTime timestamp ci ri expiry
-- debugPrintSignV4Data signData
return $ sv4Output signData
-- | Takes a timestamp, server params and request params and generates
-- AWS Sign V4 data. For normal requests (i.e. without an expiry
-- time), the output is the list of headers to add to authenticate the
-- request.
-- --
-- If `expiry` is not Nothing, it is assumed that a presigned request -- If `expiry` is not Nothing, it is assumed that a presigned request
-- is being created. The expiry is interpreted as an integer number of -- is being created. The expiry is interpreted as an integer number of
-- seconds. The output will be the list of query-parameters to add to -- seconds. The output will be the list of query-parameters to add to
-- the request. -- the request.
signV4QueryParams :: SignParams -> NC.Request -> SimpleQuery signV4AtTime :: UTCTime -> ConnectInfo -> RequestInfo -> Maybe Int
signV4QueryParams !sp !req = -> SignV4Data
let scope = credentialScope sp signV4AtTime ts ci ri expiry =
expiry = spExpirySecs sp let
region = maybe (connectRegion ci) identity $ riRegion ri
scope = mkScope ts region
accessKey = toS $ connectAccessKey ci
secretKey = toS $ connectSecretKey ci
headersToSign = getHeadersToSign $ NC.requestHeaders req -- headers to be added to the request
signedHeaderKeys = B.intercalate ";" $ sort $ map fst headersToSign datePair = ("X-Amz-Date", awsTimeFormatBS ts)
-- query-parameters to be added before signing for presigned URLs computedHeaders = riHeaders ri ++
-- (i.e. when `isJust expiry`) if isJust expiry
authQP = then []
[ ("X-Amz-Algorithm", "AWS4-HMAC-SHA256"), else [(\(x, y) -> (mk x, y)) datePair]
("X-Amz-Credential", B.concat [encodeUtf8 $ spAccessKey sp, "/", scope]), headersToSign = getHeadersToSign computedHeaders
("X-Amz-Date", awsTimeFormatBS $ spTimeStamp sp), signedHeaderKeys = B.intercalate ";" $ sort $ map fst headersToSign
("X-Amz-Expires", maybe "" showBS expiry),
("X-Amz-SignedHeaders", signedHeaderKeys)
]
++ maybeToList ((amzSecurityToken,) . BA.convert <$> spSessionToken sp)
finalQP =
parseQuery (NC.queryString req)
++ if isJust expiry
then (fmap . fmap) Just authQP
else []
-- 1. compute canonical request
canonicalRequest =
mkCanonicalRequest
False
sp
(NC.setQueryString finalQP req)
headersToSign
-- 2. compute string to sign -- query-parameters to be added before signing for presigned URLs
stringToSign = mkStringToSign (spTimeStamp sp) scope canonicalRequest -- (i.e. when `isJust expiry`)
-- 3.1 compute signing key authQP = [ ("X-Amz-Algorithm", "AWS4-HMAC-SHA256")
signingKey = getSigningKey sp , ("X-Amz-Credential", B.concat [accessKey, "/", scope])
-- 3.2 compute signature , datePair
signature = computeSignature stringToSign signingKey , ("X-Amz-Expires", maybe "" show expiry)
in ("X-Amz-Signature", signature) : authQP , ("X-Amz-SignedHeaders", signedHeaderKeys)
]
finalQP = riQueryParams ri ++
if isJust expiry
then (fmap . fmap) Just authQP
else []
-- | Given SignParams and request details, including request method, request -- 1. compute canonical request
-- path, headers, query params and payload hash, generates an updated set of canonicalRequest = mkCanonicalRequest (ri {riQueryParams = finalQP})
-- headers, including the x-amz-date header and the Authorization header, which headersToSign
-- includes the signature.
--
-- The output is the list of headers to be added to authenticate the request.
signV4 :: SignParams -> NC.Request -> [Header]
signV4 !sp !req =
let scope = credentialScope sp
-- extra headers to be added for signing purposes. -- 2. compute string to sign
extraHeaders = stringToSign = mkStringToSign ts scope canonicalRequest
("X-Amz-Date", awsTimeFormatBS $ spTimeStamp sp)
: ( -- payload hash is only used for S3 (not STS)
[ ( "x-amz-content-sha256",
fromMaybe "UNSIGNED-PAYLOAD" $ spPayloadHash sp
)
| spService sp == ServiceS3
]
)
++ maybeToList ((mk amzSecurityToken,) . BA.convert <$> spSessionToken sp)
-- 1. compute canonical request -- 3.1 compute signing key
reqHeaders = NC.requestHeaders req ++ extraHeaders signingKey = mkSigningKey ts region secretKey
(canonicalRequest, signedHeaderKeys) =
getCanonicalRequestAndSignedHeaders
NotStreaming
sp
req
reqHeaders
-- 2. compute string to sign -- 3.2 compute signature
stringToSign = mkStringToSign (spTimeStamp sp) scope canonicalRequest signature = computeSignature stringToSign signingKey
-- 3.1 compute signing key
signingKey = getSigningKey sp
-- 3.2 compute signature
signature = computeSignature stringToSign signingKey
-- 4. compute auth header
authHeader = mkAuthHeader (spAccessKey sp) scope signedHeaderKeys signature
in authHeader : extraHeaders
credentialScope :: SignParams -> ByteString -- 4. compute auth header
credentialScope sp = authValue = B.concat
let region = fromMaybe "" $ spRegion sp [ "AWS4-HMAC-SHA256 Credential="
in B.intercalate , accessKey
"/" , "/"
[ encodeUtf8 $ Time.formatTime Time.defaultTimeLocale "%Y%m%d" $ spTimeStamp sp, , scope
encodeUtf8 region, , ", SignedHeaders="
toByteString $ spService sp, , signedHeaderKeys
"aws4_request" , ", Signature="
] , signature
]
authHeader = (H.hAuthorization, authValue)
-- finally compute output pairs
output = if isJust expiry
then ("X-Amz-Signature", signature) : authQP
else [(\(x, y) -> (CI.foldedCase x, y)) authHeader,
datePair]
in
SignV4Data ts scope canonicalRequest headersToSign output
stringToSign signingKey
mkScope :: UTCTime -> Region -> ByteString
mkScope ts region = B.intercalate "/"
[ toS $ Time.formatTime Time.defaultTimeLocale "%Y%m%d" ts
, toS region
, "s3"
, "aws4_request"
]
-- Folds header name, trims whitespace in header values, skips ignored headers
-- and sorts headers.
getHeadersToSign :: [Header] -> [(ByteString, ByteString)] getHeadersToSign :: [Header] -> [(ByteString, ByteString)]
getHeadersToSign !h = getHeadersToSign !h =
filter ((\hdr -> not $ Set.member hdr ignoredHeaders) . fst) $ filter (flip Set.notMember ignoredHeaders . fst) $
map (bimap CI.foldedCase stripBS) h map (\(x, y) -> (CI.foldedCase x, stripBS y)) h
-- | Given the list of headers in the request, computes the canonical headers mkCanonicalRequest :: RequestInfo -> [(ByteString, ByteString)]
-- and the signed headers strings. -> ByteString
getCanonicalHeaders :: NonEmpty Header -> (ByteString, ByteString) mkCanonicalRequest !ri !headersForSign =
getCanonicalHeaders h = let
let -- Folds header name, trims spaces in header values, skips ignored canonicalQueryString = B.intercalate "&" $
-- headers and sorts headers by name (we must not re-order multi-valued map (\(x, y) -> B.concat [x, "=", y]) $
-- headers). sort $ map (\(x, y) ->
headersToSign = (uriEncode True x, maybe "" (uriEncode True) y)) $
NE.toList $ riQueryParams ri
NE.sortBy (\a b -> compare (fst a) (fst b)) $
NE.fromList $
NE.filter ((\hdr -> not $ Set.member hdr ignoredHeaders) . fst) $
NE.map (bimap CI.foldedCase stripBS) h
canonicalHeaders = mconcat $ map (\(a, b) -> a <> ":" <> b <> "\n") headersToSign sortedHeaders = sort headersForSign
signedHeaderKeys = B.intercalate ";" $ map fst headersToSign
in (canonicalHeaders, signedHeaderKeys)
getCanonicalRequestAndSignedHeaders :: canonicalHeaders = B.concat $
IsStreaming -> map (\(x, y) -> B.concat [x, ":", y, "\n"]) sortedHeaders
SignParams ->
NC.Request ->
[Header] ->
(ByteString, ByteString)
getCanonicalRequestAndSignedHeaders isStreaming sp req requestHeaders =
let httpMethod = NC.method req
canonicalUri = uriEncode False $ NC.path req signedHeaders = B.intercalate ";" $ map fst sortedHeaders
canonicalQueryString = in
B.intercalate "&" $ B.intercalate "\n"
map (\(x, y) -> B.concat [x, "=", y]) $ [ riMethod ri
sort $ , uriEncode False $ getPathFromRI ri
map , canonicalQueryString
( bimap (uriEncode True) (maybe "" (uriEncode True)) , canonicalHeaders
) , signedHeaders
(parseQuery $ NC.queryString req) , maybe "UNSIGNED-PAYLOAD" identity $ riPayloadHash ri
(canonicalHeaders, signedHeaderKeys) = getCanonicalHeaders $ NE.fromList requestHeaders
payloadHashStr =
case isStreaming of
IsStreamingLength _ -> "STREAMING-AWS4-HMAC-SHA256-PAYLOAD"
NotStreaming -> fromMaybe "UNSIGNED-PAYLOAD" $ spPayloadHash sp
canonicalRequest =
B.intercalate
"\n"
[ httpMethod,
canonicalUri,
canonicalQueryString,
canonicalHeaders,
signedHeaderKeys,
payloadHashStr
]
in (canonicalRequest, signedHeaderKeys)
mkCanonicalRequest ::
Bool ->
SignParams ->
NC.Request ->
[(ByteString, ByteString)] ->
ByteString
mkCanonicalRequest !isStreaming !sp !req !headersForSign =
let httpMethod = NC.method req
canonicalUri = uriEncode False $ NC.path req
canonicalQueryString =
B.intercalate "&" $
map (\(x, y) -> B.concat [x, "=", y]) $
sortBy (\a b -> compare (fst a) (fst b)) $
map
( bimap (uriEncode True) (maybe "" (uriEncode True))
)
(parseQuery $ NC.queryString req)
sortedHeaders = sort headersForSign
canonicalHeaders =
B.concat $
map (\(x, y) -> B.concat [x, ":", y, "\n"]) sortedHeaders
signedHeaders = B.intercalate ";" $ map fst sortedHeaders
payloadHashStr =
if isStreaming
then "STREAMING-AWS4-HMAC-SHA256-PAYLOAD"
else fromMaybe "UNSIGNED-PAYLOAD" $ spPayloadHash sp
in B.intercalate
"\n"
[ httpMethod,
canonicalUri,
canonicalQueryString,
canonicalHeaders,
signedHeaders,
payloadHashStr
]
mkStringToSign :: UTCTime -> ByteString -> ByteString -> ByteString
mkStringToSign ts !scope !canonicalRequest =
B.intercalate
"\n"
[ "AWS4-HMAC-SHA256",
awsTimeFormatBS ts,
scope,
hashSHA256 canonicalRequest
] ]
getSigningKey :: SignParams -> ByteString mkStringToSign :: UTCTime -> ByteString -> ByteString -> ByteString
getSigningKey sp = mkStringToSign ts !scope !canonicalRequest = B.intercalate "\n"
hmacSHA256RawBS "aws4_request" [ "AWS4-HMAC-SHA256"
. hmacSHA256RawBS (toByteString $ spService sp) , awsTimeFormatBS ts
. hmacSHA256RawBS (encodeUtf8 $ fromMaybe "" $ spRegion sp) , scope
. hmacSHA256RawBS (awsDateFormatBS $ spTimeStamp sp) , hashSHA256 canonicalRequest
$ B.concat ["AWS4", BA.convert $ spSecretKey sp] ]
mkSigningKey :: UTCTime -> Region -> ByteString -> ByteString
mkSigningKey ts region !secretKey = hmacSHA256RawBS "aws4_request"
. hmacSHA256RawBS "s3"
. hmacSHA256RawBS (toS region)
. hmacSHA256RawBS (awsDateFormatBS ts)
$ B.concat ["AWS4", secretKey]
computeSignature :: ByteString -> ByteString -> ByteString computeSignature :: ByteString -> ByteString -> ByteString
computeSignature !toSign !key = digestToBase16 $ hmacSHA256 toSign key computeSignature !toSign !key = digestToBase16 $ hmacSHA256 toSign key
@ -327,168 +233,15 @@ computeSignature !toSign !key = digestToBase16 $ hmacSHA256 toSign key
-- | Takes a validated Post Policy JSON bytestring, the signing time, -- | Takes a validated Post Policy JSON bytestring, the signing time,
-- and ConnInfo and returns form-data for the POST upload containing -- and ConnInfo and returns form-data for the POST upload containing
-- just the signature and the encoded post-policy. -- just the signature and the encoded post-policy.
signV4PostPolicy :: signV4PostPolicy :: ByteString -> UTCTime -> ConnectInfo
ByteString -> -> Map.Map Text ByteString
SignParams -> signV4PostPolicy !postPolicyJSON !signTime !ci =
Map.HashMap Text ByteString let
signV4PostPolicy !postPolicyJSON !sp = stringToSign = Base64.encode postPolicyJSON
let stringToSign = Base64.encode postPolicyJSON region = connectRegion ci
signingKey = getSigningKey sp signingKey = mkSigningKey signTime region $ toS $ connectSecretKey ci
signature = computeSignature stringToSign signingKey signature = computeSignature stringToSign signingKey
in Map.fromList $ in
[ ("x-amz-signature", signature), Map.fromList [ ("x-amz-signature", signature)
("policy", stringToSign) , ("policy", stringToSign)
] ]
++ maybeToList ((decodeUtf8 amzSecurityToken,) . BA.convert <$> spSessionToken sp)
chunkSizeConstant :: Int
chunkSizeConstant = 64 * 1024
-- base16Len computes the number of bytes required to represent @n (> 0)@ in
-- hexadecimal.
base16Len :: (Integral a) => a -> Int
base16Len n
| n == 0 = 0
| otherwise = 1 + base16Len (n `div` 16)
signedStreamLength :: Int64 -> Int64
signedStreamLength dataLen =
let chunkSzInt = fromIntegral chunkSizeConstant
(numChunks, lastChunkLen) = quotRem dataLen chunkSzInt
-- Structure of a chunk:
-- string(IntHexBase(chunk-size)) + ";chunk-signature=" + signature + \r\n + chunk-data + \r\n
encodedChunkLen csz = fromIntegral (base16Len csz) + 17 + 64 + 2 + csz + 2
fullChunkSize = encodedChunkLen chunkSzInt
lastChunkSize = bool 0 (encodedChunkLen lastChunkLen) $ lastChunkLen > 0
finalChunkSize = 1 + 17 + 64 + 2 + 2
in numChunks * fullChunkSize + lastChunkSize + finalChunkSize
-- For streaming S3, we need to update the content-encoding header.
addContentEncoding :: [Header] -> [Header]
addContentEncoding hs =
-- assume there is at most one content-encoding header.
let (ceHdrs, others) = partition ((== hContentEncoding) . fst) hs
in maybe
(hContentEncoding, "aws-chunked")
(\(k, v) -> (k, v <> ",aws-chunked"))
(listToMaybe ceHdrs)
: others
signV4Stream ::
Int64 ->
SignParams ->
NC.Request ->
(C.ConduitT () ByteString (C.ResourceT IO) () -> NC.Request)
signV4Stream !payloadLength !sp !req =
let ts = spTimeStamp sp
-- compute the updated list of headers to be added for signing purposes.
signedContentLength = signedStreamLength payloadLength
extraHeaders =
[ ("X-Amz-Date", awsTimeFormatBS $ spTimeStamp sp),
("x-amz-decoded-content-length", showBS payloadLength),
("content-length", showBS signedContentLength),
("x-amz-content-sha256", "STREAMING-AWS4-HMAC-SHA256-PAYLOAD")
]
++ maybeToList ((mk amzSecurityToken,) . BA.convert <$> spSessionToken sp)
requestHeaders =
addContentEncoding $
foldr setHeader (NC.requestHeaders req) extraHeaders
-- 1. Compute Seed Signature
-- 1.1 Canonical Request
(canonicalReq, signedHeaderKeys) =
getCanonicalRequestAndSignedHeaders
(IsStreamingLength payloadLength)
sp
req
requestHeaders
scope = credentialScope sp
accessKey = spAccessKey sp
-- 1.2 String toSign
stringToSign = mkStringToSign ts scope canonicalReq
-- 1.3 Compute signature
-- 1.3.1 compute signing key
signingKey = getSigningKey sp
-- 1.3.2 Compute signature
seedSignature = computeSignature stringToSign signingKey
-- 1.3.3 Compute Auth Header
authHeader = mkAuthHeader accessKey scope signedHeaderKeys seedSignature
-- 1.4 Updated headers for the request
finalReqHeaders = authHeader : requestHeaders
-- headersToAdd = authHeader : datePair : streamingHeaders
toHexStr n = B8.pack $ printf "%x" n
(numParts, lastPSize) = payloadLength `quotRem` fromIntegral chunkSizeConstant
-- Function to compute string to sign for each chunk.
chunkStrToSign prevSign currChunkHash =
B.intercalate
"\n"
[ "AWS4-HMAC-SHA256-PAYLOAD",
awsTimeFormatBS ts,
scope,
prevSign,
hashSHA256 "",
currChunkHash
]
-- Read n byte from upstream and return a strict bytestring.
mustTakeN n = do
bs <- LB.toStrict <$> (C.takeCE n C..| C.sinkLazy)
when (B.length bs /= n) $
throwIO MErrVStreamingBodyUnexpectedEOF
return bs
signerConduit n lps prevSign =
-- First case encodes a full chunk of length
-- 'chunkSizeConstant'.
if
| n > 0 -> do
bs <- mustTakeN chunkSizeConstant
let strToSign = chunkStrToSign prevSign (hashSHA256 bs)
nextSign = computeSignature strToSign signingKey
chunkBS =
toHexStr chunkSizeConstant
<> ";chunk-signature="
<> nextSign
<> "\r\n"
<> bs
<> "\r\n"
C.yield chunkBS
signerConduit (n - 1) lps nextSign
-- Second case encodes the last chunk which is smaller than
-- 'chunkSizeConstant'
| lps > 0 -> do
bs <- mustTakeN $ fromIntegral lps
let strToSign = chunkStrToSign prevSign (hashSHA256 bs)
nextSign = computeSignature strToSign signingKey
chunkBS =
toHexStr lps
<> ";chunk-signature="
<> nextSign
<> "\r\n"
<> bs
<> "\r\n"
C.yield chunkBS
signerConduit 0 0 nextSign
-- Last case encodes the final signature chunk that has no
-- data.
| otherwise -> do
let strToSign = chunkStrToSign prevSign (hashSHA256 "")
nextSign = computeSignature strToSign signingKey
lastChunkBS = "0;chunk-signature=" <> nextSign <> "\r\n\r\n"
C.yield lastChunkBS
in \src ->
req
{ NC.requestHeaders = finalReqHeaders,
NC.requestBody =
NC.requestBodySource signedContentLength $
src C..| signerConduit numParts lastPSize seedSignature
}
-- "setHeader r hdr" adds the hdr to r, replacing it in r if it already exists.
setHeader :: Header -> RequestHeaders -> RequestHeaders
setHeader hdr r =
let r' = filter (\(name, _) -> name /= fst hdr) r
in hdr : r'

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -16,146 +16,88 @@
module Network.Minio.Utils where module Network.Minio.Utils where
import qualified Conduit as C import qualified Control.Concurrent.Async.Lifted as A
import Control.Monad.IO.Unlift (MonadUnliftIO) import qualified Control.Concurrent.QSem.Lifted as Q
import qualified Control.Exception.Lifted as ExL
import qualified Control.Monad.Catch as MC
import qualified Control.Monad.Trans.Resource as R import qualified Control.Monad.Trans.Resource as R
import qualified Data.ByteString as B import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as LB import qualified Data.ByteString.Lazy as LB
import Data.CaseInsensitive (mk, original) import qualified Data.Conduit as C
import qualified Data.Conduit.Binary as CB import qualified Data.Conduit.Binary as CB
import qualified Data.HashMap.Strict as H
import qualified Data.Text as T import qualified Data.Text as T
import Data.Text.Read (decimal) import Data.Text.Encoding.Error (lenientDecode)
import Data.Time import Data.Text.Read (decimal)
( defaultTimeLocale, import Data.Time
parseTimeM, import Network.HTTP.Conduit (Response)
rfc822DateFormat,
)
import Lib.Prelude
import Network.HTTP.Conduit (Response)
import qualified Network.HTTP.Conduit as NC import qualified Network.HTTP.Conduit as NC
import qualified Network.HTTP.Types as HT import qualified Network.HTTP.Types as HT
import qualified Network.HTTP.Types.Header as Hdr import qualified Network.HTTP.Types.Header as Hdr
import Network.Minio.Data.ByteString
import Network.Minio.JsonParser (parseErrResponseJSON)
import Network.Minio.XmlCommon (parseErrResponse)
import qualified System.IO as IO import qualified System.IO as IO
import qualified UnliftIO as U import Data.CaseInsensitive (mk)
import qualified UnliftIO.Async as A
allocateReadFile ::
(MonadUnliftIO m, R.MonadResource m) => import Lib.Prelude
FilePath ->
m (R.ReleaseKey, Handle) import Network.Minio.XmlParser (parseErrResponse)
allocateReadFile :: (R.MonadResource m, R.MonadResourceBase m, MonadCatch m)
=> FilePath -> m (R.ReleaseKey, Handle)
allocateReadFile fp = do allocateReadFile fp = do
(rk, hdlE) <- R.allocate (openReadFile fp) cleanup (rk, hdlE) <- R.allocate (openReadFile fp) cleanup
either (\(e :: U.IOException) -> throwIO e) (return . (rk,)) hdlE either (\(e :: IOException) -> throwM e) (return . (rk,)) hdlE
where where
openReadFile f = U.try $ IO.openBinaryFile f IO.ReadMode openReadFile f = ExL.try $ IO.openBinaryFile f IO.ReadMode
cleanup = either (const $ return ()) IO.hClose cleanup = either (const $ return ()) IO.hClose
-- | Queries the file size from the handle. Catches any file operation -- | Queries the file size from the handle. Catches any file operation
-- exceptions and returns Nothing instead. -- exceptions and returns Nothing instead.
getFileSize :: getFileSize :: (R.MonadResourceBase m, R.MonadResource m)
(MonadUnliftIO m) => => Handle -> m (Maybe Int64)
Handle ->
m (Maybe Int64)
getFileSize h = do getFileSize h = do
resE <- liftIO $ try $ fromIntegral <$> IO.hFileSize h resE <- liftIO $ try $ fromIntegral <$> IO.hFileSize h
case resE of case resE of
Left (_ :: U.IOException) -> return Nothing Left (_ :: IOException) -> return Nothing
Right s -> return $ Just s Right s -> return $ Just s
-- | Queries if handle is seekable. Catches any file operation -- | Queries if handle is seekable. Catches any file operation
-- exceptions and return False instead. -- exceptions and return False instead.
isHandleSeekable :: isHandleSeekable :: (R.MonadResource m, R.MonadResourceBase m)
(R.MonadResource m) => => Handle -> m Bool
Handle ->
m Bool
isHandleSeekable h = do isHandleSeekable h = do
resE <- liftIO $ try $ IO.hIsSeekable h resE <- liftIO $ try $ IO.hIsSeekable h
case resE of case resE of
Left (_ :: U.IOException) -> return False Left (_ :: IOException) -> return False
Right v -> return v Right v -> return v
-- | Helper function that opens a handle to the filepath and performs -- | Helper function that opens a handle to the filepath and performs
-- the given action on it. Exceptions of type MError are caught and -- the given action on it. Exceptions of type MError are caught and
-- returned - both during file handle allocation and when the action -- returned - both during file handle allocation and when the action
-- is run. -- is run.
withNewHandle :: withNewHandle :: (R.MonadResourceBase m, R.MonadResource m, MonadCatch m)
(MonadUnliftIO m, R.MonadResource m) => => FilePath -> (Handle -> m a) -> m (Either IOException a)
FilePath ->
(Handle -> m a) ->
m (Either U.IOException a)
withNewHandle fp fileAction = do withNewHandle fp fileAction = do
-- opening a handle can throw MError exception. -- opening a handle can throw MError exception.
handleE <- try $ allocateReadFile fp handleE <- MC.try $ allocateReadFile fp
either (return . Left) doAction handleE either (return . Left) doAction handleE
where where
doAction (rkey, h) = do doAction (rkey, h) = do
-- fileAction may also throw MError exception, so we catch and -- fileAction may also throw MError exception, so we catch and
-- return it. -- return it.
resE <- try $ fileAction h resE <- MC.try $ fileAction h
R.release rkey R.release rkey
return resE return resE
mkHeaderFromPairs :: [(ByteString, ByteString)] -> [HT.Header] mkHeaderFromPairs :: [(ByteString, ByteString)] -> [HT.Header]
mkHeaderFromPairs = map (first mk) mkHeaderFromPairs = map ((\(x, y) -> (mk x, y)))
lookupHeader :: HT.HeaderName -> [HT.Header] -> Maybe ByteString lookupHeader :: HT.HeaderName -> [HT.Header] -> Maybe ByteString
lookupHeader hdr = listToMaybe . map snd . filter (\(h, _) -> h == hdr) lookupHeader hdr = headMay . map snd . filter (\(h, _) -> h == hdr)
getETagHeader :: [HT.Header] -> Maybe Text getETagHeader :: [HT.Header] -> Maybe Text
getETagHeader hs = decodeUtf8Lenient <$> lookupHeader Hdr.hETag hs getETagHeader hs = decodeUtf8Lenient <$> lookupHeader Hdr.hETag hs
getMetadata :: [HT.Header] -> [(Text, Text)]
getMetadata =
map (\(x, y) -> (decodeUtf8Lenient $ original x, decodeUtf8Lenient $ stripBS y))
-- | If the given header name has the @X-Amz-Meta-@ prefix, it is
-- stripped and a Just is returned.
userMetadataHeaderNameMaybe :: Text -> Maybe Text
userMetadataHeaderNameMaybe k =
let prefix = T.toCaseFold "X-Amz-Meta-"
n = T.length prefix
in if T.toCaseFold (T.take n k) == prefix
then Just (T.drop n k)
else Nothing
toMaybeMetadataHeader :: (Text, Text) -> Maybe (Text, Text)
toMaybeMetadataHeader (k, v) =
(,v) <$> userMetadataHeaderNameMaybe k
getNonUserMetadataMap :: [(Text, Text)] -> H.HashMap Text Text
getNonUserMetadataMap =
H.fromList
. filter
( isNothing
. userMetadataHeaderNameMaybe
. fst
)
addXAmzMetaPrefix :: Text -> Text
addXAmzMetaPrefix s
| isJust (userMetadataHeaderNameMaybe s) = s
| otherwise = "X-Amz-Meta-" <> s
mkHeaderFromMetadata :: [(Text, Text)] -> [HT.Header]
mkHeaderFromMetadata = map (\(x, y) -> (mk $ encodeUtf8 $ addXAmzMetaPrefix x, encodeUtf8 y))
-- | This function collects all headers starting with `x-amz-meta-`
-- and strips off this prefix, and returns a map.
getUserMetadataMap :: [(Text, Text)] -> H.HashMap Text Text
getUserMetadataMap =
H.fromList
. mapMaybe toMaybeMetadataHeader
getHostHeader :: (ByteString, Int) -> ByteString
getHostHeader (host_, port_) =
if port_ == 80 || port_ == 443
then host_
else host_ <> ":" <> show port_
getLastModifiedHeader :: [HT.Header] -> Maybe UTCTime getLastModifiedHeader :: [HT.Header] -> Maybe UTCTime
getLastModifiedHeader hs = do getLastModifiedHeader hs = do
modTimebs <- decodeUtf8Lenient <$> lookupHeader Hdr.hLastModified hs modTimebs <- decodeUtf8Lenient <$> lookupHeader Hdr.hLastModified hs
@ -164,103 +106,77 @@ getLastModifiedHeader hs = do
getContentLength :: [HT.Header] -> Maybe Int64 getContentLength :: [HT.Header] -> Maybe Int64
getContentLength hs = do getContentLength hs = do
nbs <- decodeUtf8Lenient <$> lookupHeader Hdr.hContentLength hs nbs <- decodeUtf8Lenient <$> lookupHeader Hdr.hContentLength hs
fst <$> either (const Nothing) Just (decimal nbs) fst <$> hush (decimal nbs)
decodeUtf8Lenient :: ByteString -> Text decodeUtf8Lenient :: ByteString -> Text
decodeUtf8Lenient = decodeUtf8With lenientDecode decodeUtf8Lenient = decodeUtf8With lenientDecode
isSuccessStatus :: HT.Status -> Bool isSuccessStatus :: HT.Status -> Bool
isSuccessStatus sts = isSuccessStatus sts = let s = HT.statusCode sts
let s = HT.statusCode sts in (s >= 200 && s < 300)
in (s >= 200 && s < 300)
httpLbs :: httpLbs :: (R.MonadThrow m, MonadIO m)
(MonadIO m) => => NC.Request -> NC.Manager
NC.Request -> -> m (NC.Response LByteString)
NC.Manager ->
m (NC.Response LByteString)
httpLbs req mgr = do httpLbs req mgr = do
respE <- liftIO $ tryHttpEx $ NC.httpLbs req mgr respE <- liftIO $ tryHttpEx $ NC.httpLbs req mgr
resp <- either throwIO return respE resp <- either throwM return respE
unless (isSuccessStatus $ NC.responseStatus resp) $ unless (isSuccessStatus $ NC.responseStatus resp) $
case contentTypeMay resp of case contentTypeMay resp of
Just "application/xml" -> do Just "application/xml" -> do
sErr <- parseErrResponse $ NC.responseBody resp sErr <- parseErrResponse $ NC.responseBody resp
throwIO sErr throwM sErr
Just "application/json" -> do
sErr <- parseErrResponseJSON $ NC.responseBody resp _ -> throwM $ NC.HttpExceptionRequest req $
throwIO sErr NC.StatusCodeException (void resp) (show resp)
_ ->
throwIO $
NC.HttpExceptionRequest req $
NC.StatusCodeException (void resp) (showBS resp)
return resp return resp
where where
tryHttpEx :: tryHttpEx :: IO (NC.Response LByteString)
IO (NC.Response LByteString) -> -> IO (Either NC.HttpException (NC.Response LByteString))
IO (Either NC.HttpException (NC.Response LByteString))
tryHttpEx = try tryHttpEx = try
contentTypeMay resp = contentTypeMay resp = lookupHeader Hdr.hContentType $
lookupHeader Hdr.hContentType $ NC.responseHeaders resp
NC.responseHeaders resp
http :: http :: (R.MonadResourceBase m, R.MonadResource m)
(MonadUnliftIO m, R.MonadResource m) => => NC.Request -> NC.Manager
NC.Request -> -> m (Response (C.ResumableSource m ByteString))
NC.Manager ->
m (Response (C.ConduitT () ByteString m ()))
http req mgr = do http req mgr = do
respE <- tryHttpEx $ NC.http req mgr respE <- tryHttpEx $ NC.http req mgr
resp <- either throwIO return respE resp <- either throwM return respE
unless (isSuccessStatus $ NC.responseStatus resp) $ unless (isSuccessStatus $ NC.responseStatus resp) $
case contentTypeMay resp of case contentTypeMay resp of
Just "application/xml" -> do Just "application/xml" -> do
respBody <- C.connect (NC.responseBody resp) CB.sinkLbs respBody <- NC.responseBody resp C.$$+- CB.sinkLbs
sErr <- parseErrResponse respBody sErr <- parseErrResponse respBody
throwIO sErr throwM sErr
_ -> do _ -> do
content <- LB.toStrict . NC.responseBody <$> NC.lbsResponse resp content <- LB.toStrict . NC.responseBody <$> NC.lbsResponse resp
throwIO $ throwM $ NC.HttpExceptionRequest req $
NC.HttpExceptionRequest req $ NC.StatusCodeException (void resp) content
NC.StatusCodeException (void resp) content
return resp return resp
where where
tryHttpEx :: tryHttpEx :: (R.MonadResourceBase m) => m a
(MonadUnliftIO m) => -> m (Either NC.HttpException a)
m a -> tryHttpEx = ExL.try
m (Either NC.HttpException a) contentTypeMay resp = lookupHeader Hdr.hContentType $ NC.responseHeaders resp
tryHttpEx = try
contentTypeMay resp =
lookupHeader Hdr.hContentType $
NC.responseHeaders resp
-- Similar to mapConcurrently but limits the number of threads that -- Similar to mapConcurrently but limits the number of threads that
-- can run using a quantity semaphore. -- can run using a quantity semaphore.
limitedMapConcurrently :: limitedMapConcurrently :: (MonadIO m, R.MonadBaseControl IO m)
(MonadUnliftIO m) => => Int -> (t -> m a) -> [t] -> m [a]
Int ->
(t -> m a) ->
[t] ->
m [a]
limitedMapConcurrently 0 _ _ = return []
limitedMapConcurrently count act args = do limitedMapConcurrently count act args = do
t' <- U.newTVarIO count qSem <- liftIO $ Q.newQSem count
threads <- mapM (A.async . wThread t') args threads <- mapM (A.async . wThread qSem) args
mapM A.wait threads mapM A.wait threads
where where
wThread t arg = -- grab 1 unit from semaphore, run action and release it
U.bracket_ (waitSem t) (signalSem t) $ act arg wThread qs arg =
-- quantity semaphore implementation using TVar ExL.bracket_ (Q.waitQSem qs) (Q.signalQSem qs) $ act arg
waitSem t = U.atomically $ do
v <- U.readTVar t
if v > 0
then U.writeTVar t (v - 1)
else U.retrySTM
signalSem t = U.atomically $ do
v <- U.readTVar t
U.writeTVar t (v + 1)
-- helper function to 'drop' empty optional parameter. -- helper function to 'drop' empty optional parameter.
mkQuery :: Text -> Maybe Text -> Maybe (Text, Text) mkQuery :: Text -> Maybe Text -> Maybe (Text, Text)
@ -269,17 +185,21 @@ mkQuery k mv = (k,) <$> mv
-- helper function to build query parameters that are optional. -- helper function to build query parameters that are optional.
-- don't use it with mandatory query params with empty value. -- don't use it with mandatory query params with empty value.
mkOptionalParams :: [(Text, Maybe Text)] -> HT.Query mkOptionalParams :: [(Text, Maybe Text)] -> HT.Query
mkOptionalParams params = HT.toQuery $ uncurry mkQuery <$> params mkOptionalParams params = HT.toQuery $ uncurry mkQuery <$> params
-- | Conduit that rechunks bytestrings into the given chunk chunkBSConduit :: (Monad m, Integral a)
-- lengths. Stops after given chunk lengths are yielded. Stops if => [a] -> C.Conduit ByteString m ByteString
-- there are no more chunks to yield or if a shorter chunk is chunkBSConduit s = loop 0 [] s
-- received. Does not throw any errors. where
chunkBSConduit :: (Monad m) => [Int] -> C.ConduitM ByteString ByteString m () loop _ _ [] = return ()
chunkBSConduit [] = return () loop n readChunks (size:sizes) = do
chunkBSConduit (s : ss) = do bsMay <- C.await
bs <- fmap LB.toStrict $ C.takeCE s C..| C.sinkLazy case bsMay of
if Nothing -> when (n > 0) $ C.yield $ B.concat readChunks
| B.length bs == s -> C.yield bs >> chunkBSConduit ss Just bs -> if n + fromIntegral (B.length bs) >= size
| B.length bs > 0 -> C.yield bs then do let (a, b) = B.splitAt (fromIntegral $ size - n) bs
| otherwise -> return () chunkBS = B.concat $ readChunks ++ [a]
C.yield chunkBS
loop (fromIntegral $ B.length b) [b] sizes
else loop (n + fromIntegral (B.length bs))
(readChunks ++ [bs]) (size:sizes)

View File

@ -1,65 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.XmlCommon where
import qualified Data.Text as T
import Data.Text.Read (decimal)
import Data.Time (UTCTime)
import Data.Time.Format.ISO8601 (iso8601ParseM)
import Lib.Prelude (throwIO)
import Network.Minio.Errors
import Text.XML (Name (Name), def, parseLBS)
import Text.XML.Cursor (Axis, Cursor, content, element, fromDocument, laxElement, ($/), (&/))
s3Name :: Text -> Text -> Name
s3Name ns s = Name s (Just ns) Nothing
uncurry4 :: (a -> b -> c -> d -> e) -> (a, b, c, d) -> e
uncurry4 f (a, b, c, d) = f a b c d
uncurry6 :: (a -> b -> c -> d -> e -> f -> g) -> (a, b, c, d, e, f) -> g
uncurry6 f (a, b, c, d, e, g) = f a b c d e g
-- | Parse time strings from XML
parseS3XMLTime :: (MonadIO m) => Text -> m UTCTime
parseS3XMLTime t =
maybe (throwIO $ MErrVXmlParse $ "timestamp parse failure: " <> t) return $
iso8601ParseM $
toString t
parseDecimal :: (MonadIO m, Integral a) => Text -> m a
parseDecimal numStr =
either (throwIO . MErrVXmlParse . show) return $
fst <$> decimal numStr
parseDecimals :: (MonadIO m, Integral a) => [Text] -> m [a]
parseDecimals numStr = forM numStr parseDecimal
s3Elem :: Text -> Text -> Axis
s3Elem ns = element . s3Name ns
parseRoot :: (MonadIO m) => LByteString -> m Cursor
parseRoot =
either (throwIO . MErrVXmlParse . show) (return . fromDocument)
. parseLBS def
parseErrResponse :: (MonadIO m) => LByteString -> m ServiceErr
parseErrResponse xmldata = do
r <- parseRoot xmldata
let code = T.concat $ r $/ laxElement "Code" &/ content
message = T.concat $ r $/ laxElement "Message" &/ content
return $ toServiceErr code message

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,217 +15,88 @@
-- --
module Network.Minio.XmlGenerator module Network.Minio.XmlGenerator
( mkCreateBucketConfig, ( mkCreateBucketConfig
mkCompleteMultipartUploadRequest, , mkCompleteMultipartUploadRequest
mkPutNotificationRequest, , mkPutNotificationRequest
mkSelectRequest, ) where
)
where
import qualified Data.ByteString.Lazy as LBS import qualified Data.ByteString.Lazy as LBS
import qualified Data.Text as T import qualified Data.Map as M
import Network.Minio.Data import qualified Data.Text as T
import Network.Minio.XmlCommon import Text.XML
import Text.XML
import Lib.Prelude
import Network.Minio.Data
-- | Create a bucketConfig request body XML -- | Create a bucketConfig request body XML
mkCreateBucketConfig :: Text -> Region -> ByteString mkCreateBucketConfig :: Region -> ByteString
mkCreateBucketConfig ns location = LBS.toStrict $ renderLBS def bucketConfig mkCreateBucketConfig location = LBS.toStrict $ renderLBS def bucketConfig
where where
s3Element n = Element (s3Name ns n) mempty s3Element n = Element (s3Name n) M.empty
root = root = s3Element "CreateBucketConfiguration"
s3Element [ NodeElement $ s3Element "LocationConstraint"
"CreateBucketConfiguration" [ NodeContent location]
[ NodeElement $
s3Element
"LocationConstraint"
[NodeContent location]
] ]
bucketConfig = Document (Prologue [] Nothing []) root [] bucketConfig = Document (Prologue [] Nothing []) root []
-- | Create a completeMultipartUpload request body XML -- | Create a completeMultipartUpload request body XML
mkCompleteMultipartUploadRequest :: [PartTuple] -> ByteString mkCompleteMultipartUploadRequest :: [PartTuple] -> ByteString
mkCompleteMultipartUploadRequest partInfo = mkCompleteMultipartUploadRequest partInfo =
LBS.toStrict $ renderLBS def cmur LBS.toStrict $ renderLBS def cmur
where where
root = root = Element "CompleteMultipartUpload" M.empty $
Element "CompleteMultipartUpload" mempty $ map (NodeElement . mkPart) partInfo
map (NodeElement . mkPart) partInfo mkPart (n, etag) = Element "Part" M.empty
mkPart (n, etag) = [ NodeElement $ Element "PartNumber" M.empty
Element [NodeContent $ T.pack $ show n]
"Part" , NodeElement $ Element "ETag" M.empty
mempty [NodeContent etag]
[ NodeElement $ ]
Element
"PartNumber"
mempty
[NodeContent $ T.pack $ show n],
NodeElement $
Element
"ETag"
mempty
[NodeContent etag]
]
cmur = Document (Prologue [] Nothing []) root [] cmur = Document (Prologue [] Nothing []) root []
-- Simplified XML representation without element attributes. -- Simplified XML representation without element attributes.
data XNode data XNode = XNode Text [XNode]
= XNode Text [XNode] | XLeaf Text Text
| XLeaf Text Text deriving (Eq, Show)
deriving stock (Eq, Show)
toXML :: Text -> XNode -> ByteString toXML :: XNode -> ByteString
toXML ns node = toXML node = LBS.toStrict $ renderLBS def $
LBS.toStrict $ Document (Prologue [] Nothing []) (xmlNode node) []
renderLBS def $
Document (Prologue [] Nothing []) (xmlNode node) []
where where
xmlNode :: XNode -> Element xmlNode :: XNode -> Element
xmlNode (XNode name nodes) = xmlNode (XNode name nodes) = Element (s3Name name) M.empty $
Element (s3Name ns name) mempty $ map (NodeElement . xmlNode) nodes
map (NodeElement . xmlNode) nodes xmlNode (XLeaf name content) = Element (s3Name name) M.empty
xmlNode (XLeaf name content) = [NodeContent content]
Element
(s3Name ns name)
mempty
[NodeContent content]
class ToXNode a where class ToXNode a where
toXNode :: a -> XNode toXNode :: a -> XNode
instance ToXNode Event where instance ToXNode Event where
toXNode = XLeaf "Event" . toText toXNode = XLeaf "Event" . show
instance ToXNode Notification where instance ToXNode Notification where
toXNode (Notification qc tc lc) = toXNode (Notification qc tc lc) = XNode "NotificationConfiguration" $
XNode "NotificationConfiguration" $ map (toXNodesWithArnName "QueueConfiguration" "Queue") qc ++
map (toXNodesWithArnName "QueueConfiguration" "Queue") qc map (toXNodesWithArnName "TopicConfiguration" "Topic") tc ++
++ map (toXNodesWithArnName "TopicConfiguration" "Topic") tc map (toXNodesWithArnName "CloudFunctionConfiguration" "CloudFunction") lc
++ map (toXNodesWithArnName "CloudFunctionConfiguration" "CloudFunction") lc
toXNodesWithArnName :: Text -> Text -> NotificationConfig -> XNode toXNodesWithArnName :: Text -> Text -> NotificationConfig -> XNode
toXNodesWithArnName eltName arnName (NotificationConfig itemId arn events fRule) = toXNodesWithArnName eltName arnName (NotificationConfig id arn events fRule) =
XNode eltName $ XNode eltName $ [XLeaf "Id" id, XLeaf arnName arn] ++ map toXNode events ++
[XLeaf "Id" itemId, XLeaf arnName arn] [toXNode fRule]
++ map toXNode events
++ [toXNode fRule]
instance ToXNode Filter where instance ToXNode Filter where
toXNode (Filter (FilterKey (FilterRules rules))) = toXNode (Filter (FilterKey (FilterRules rules))) =
XNode "Filter" [XNode "S3Key" (map getFRXNode rules)] XNode "Filter" [XNode "S3Key" (map getFRXNode rules)]
getFRXNode :: FilterRule -> XNode getFRXNode :: FilterRule -> XNode
getFRXNode (FilterRule n v) = getFRXNode (FilterRule n v) = XNode "FilterRule" [ XLeaf "Name" n
XNode , XLeaf "Value" v
"FilterRule" ]
[ XLeaf "Name" n,
XLeaf "Value" v
]
mkPutNotificationRequest :: Text -> Notification -> ByteString mkPutNotificationRequest :: Notification -> ByteString
mkPutNotificationRequest ns = toXML ns . toXNode mkPutNotificationRequest = toXML . toXNode
mkSelectRequest :: SelectRequest -> ByteString
mkSelectRequest r = LBS.toStrict $ renderLBS def sr
where
sr = Document (Prologue [] Nothing []) root []
root =
Element "SelectRequest" mempty $
[ NodeElement
( Element
"Expression"
mempty
[NodeContent $ srExpression r]
),
NodeElement
( Element
"ExpressionType"
mempty
[NodeContent $ show $ srExpressionType r]
),
NodeElement
( Element "InputSerialization" mempty $
inputSerializationNodes $
srInputSerialization r
),
NodeElement
( Element "OutputSerialization" mempty $
outputSerializationNodes $
srOutputSerialization r
)
]
++ maybe [] reqProgElem (srRequestProgressEnabled r)
reqProgElem enabled =
[ NodeElement
( Element
"RequestProgress"
mempty
[ NodeElement
( Element
"Enabled"
mempty
[ NodeContent
(if enabled then "TRUE" else "FALSE")
]
)
]
)
]
inputSerializationNodes is =
comprTypeNode (isCompressionType is)
++ [NodeElement $ formatNode (isFormatInfo is)]
comprTypeNode (Just c) =
[ NodeElement $
Element
"CompressionType"
mempty
[ NodeContent $ case c of
CompressionTypeNone -> "NONE"
CompressionTypeGzip -> "GZIP"
CompressionTypeBzip2 -> "BZIP2"
]
]
comprTypeNode Nothing = []
kvElement (k, v) = Element (Name k Nothing Nothing) mempty [NodeContent v]
formatNode (InputFormatCSV c) =
Element
"CSV"
mempty
(map (NodeElement . kvElement) (csvPropsList c))
formatNode (InputFormatJSON p) =
Element
"JSON"
mempty
[ NodeElement
( Element
"Type"
mempty
[ NodeContent $ case jsonipType p of
JSONTypeDocument -> "DOCUMENT"
JSONTypeLines -> "LINES"
]
)
]
formatNode InputFormatParquet = Element "Parquet" mempty []
outputSerializationNodes (OutputSerializationJSON j) =
[ NodeElement
( Element "JSON" mempty $
rdElem $
jsonopRecordDelimiter j
)
]
outputSerializationNodes (OutputSerializationCSV c) =
[ NodeElement $
Element
"CSV"
mempty
(map (NodeElement . kvElement) (csvPropsList c))
]
rdElem Nothing = []
rdElem (Just t) =
[ NodeElement $
Element
"RecordDelimiter"
mempty
[NodeContent t]
]

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,216 +15,228 @@
-- --
module Network.Minio.XmlParser module Network.Minio.XmlParser
( parseListBuckets, ( parseListBuckets
parseLocation, , parseLocation
parseNewMultipartUpload, , parseNewMultipartUpload
parseCompleteMultipartUploadResponse, , parseCompleteMultipartUploadResponse
parseCopyObjectResponse, , parseCopyObjectResponse
parseListObjectsResponse, , parseListObjectsResponse
parseListObjectsV1Response, , parseListObjectsV1Response
parseListUploadsResponse, , parseListUploadsResponse
parseListPartsResponse, , parseListPartsResponse
parseErrResponse, , parseErrResponse
parseNotification, , parseNotification
parseSelectProgress, ) where
)
where
import qualified Data.ByteString.Lazy as LB import Control.Monad.Trans.Resource
import qualified Data.HashMap.Strict as H import Data.List (zip3, zip4)
import Data.List (zip4, zip6) import qualified Data.Text as T
import qualified Data.Text as T import Data.Text.Read (decimal)
import Data.Time import Data.Time
import Network.Minio.Data import Text.XML
import Network.Minio.XmlCommon import Text.XML.Cursor hiding (bool)
import Text.XML.Cursor hiding (bool)
import Lib.Prelude
import Network.Minio.Data
import Network.Minio.Errors
-- | Represent the time format string returned by S3 API calls.
s3TimeFormat :: [Char]
s3TimeFormat = iso8601DateFormat $ Just "%T%QZ"
-- | Helper functions.
uncurry4 :: (a -> b -> c -> d -> e) -> (a, b, c, d) -> e
uncurry4 f (a, b, c, d) = f a b c d
-- | Parse time strings from XML
parseS3XMLTime :: (MonadThrow m) => Text -> m UTCTime
parseS3XMLTime = either (throwM . MErrVXmlParse) return
. parseTimeM True defaultTimeLocale s3TimeFormat
. T.unpack
parseDecimal :: (MonadThrow m, Integral a) => Text -> m a
parseDecimal numStr = either (throwM . MErrVXmlParse . show) return $
fst <$> decimal numStr
parseDecimals :: (MonadThrow m, Integral a) => [Text] -> m [a]
parseDecimals numStr = forM numStr parseDecimal
s3Elem :: Text -> Axis
s3Elem = element . s3Name
parseRoot :: (MonadThrow m) => LByteString -> m Cursor
parseRoot = either (throwM . MErrVXmlParse . show) (return . fromDocument)
. parseLBS def
-- | Parse the response XML of a list buckets call. -- | Parse the response XML of a list buckets call.
parseListBuckets :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m [BucketInfo] parseListBuckets :: (MonadThrow m) => LByteString -> m [BucketInfo]
parseListBuckets xmldata = do parseListBuckets xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let
let s3Elem' = s3Elem ns names = r $// s3Elem "Bucket" &// s3Elem "Name" &/ content
names = r $// s3Elem' "Bucket" &// s3Elem' "Name" &/ content timeStrings = r $// s3Elem "Bucket" &// s3Elem "CreationDate" &/ content
timeStrings = r $// s3Elem' "Bucket" &// s3Elem' "CreationDate" &/ content
times <- mapM parseS3XMLTime timeStrings times <- mapM parseS3XMLTime timeStrings
return $ zipWith BucketInfo names times return $ zipWith BucketInfo names times
-- | Parse the response XML of a location request. -- | Parse the response XML of a location request.
parseLocation :: (MonadIO m) => LByteString -> m Region parseLocation :: (MonadThrow m) => LByteString -> m Region
parseLocation xmldata = do parseLocation xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
let region = T.concat $ r $/ content let region = T.concat $ r $/ content
return $ bool "us-east-1" region $ region /= "" return $ bool "us-east-1" region $ region /= ""
-- | Parse the response XML of an newMultipartUpload call. -- | Parse the response XML of an newMultipartUpload call.
parseNewMultipartUpload :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m UploadId parseNewMultipartUpload :: (MonadThrow m) => LByteString -> m UploadId
parseNewMultipartUpload xmldata = do parseNewMultipartUpload xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace return $ T.concat $ r $// s3Elem "UploadId" &/ content
let s3Elem' = s3Elem ns
return $ T.concat $ r $// s3Elem' "UploadId" &/ content
-- | Parse the response XML of completeMultipartUpload call. -- | Parse the response XML of completeMultipartUpload call.
parseCompleteMultipartUploadResponse :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m ETag parseCompleteMultipartUploadResponse :: (MonadThrow m) => LByteString -> m ETag
parseCompleteMultipartUploadResponse xmldata = do parseCompleteMultipartUploadResponse xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace return $ T.concat $ r $// s3Elem "ETag" &/ content
let s3Elem' = s3Elem ns
return $ T.concat $ r $// s3Elem' "ETag" &/ content
-- | Parse the response XML of copyObject and copyObjectPart -- | Parse the response XML of copyObject and copyObjectPart
parseCopyObjectResponse :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m (ETag, UTCTime) parseCopyObjectResponse :: (MonadThrow m) => LByteString -> m (ETag, UTCTime)
parseCopyObjectResponse xmldata = do parseCopyObjectResponse xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let
let s3Elem' = s3Elem ns mtimeStr = T.concat $ r $// s3Elem "LastModified" &/ content
mtimeStr = T.concat $ r $// s3Elem' "LastModified" &/ content
mtime <- parseS3XMLTime mtimeStr mtime <- parseS3XMLTime mtimeStr
return (T.concat $ r $// s3Elem' "ETag" &/ content, mtime) return (T.concat $ r $// s3Elem "ETag" &/ content, mtime)
-- | Parse the response XML of a list objects v1 call. -- | Parse the response XML of a list objects v1 call.
parseListObjectsV1Response :: parseListObjectsV1Response :: (MonadThrow m)
(MonadReader env m, HasSvcNamespace env, MonadIO m) => => LByteString -> m ListObjectsV1Result
LByteString ->
m ListObjectsV1Result
parseListObjectsV1Response xmldata = do parseListObjectsV1Response xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let
let s3Elem' = s3Elem ns hasMore = ["true"] == (r $/ s3Elem "IsTruncated" &/ content)
hasMore = ["true"] == (r $/ s3Elem' "IsTruncated" &/ content)
nextMarker = listToMaybe $ r $/ s3Elem' "NextMarker" &/ content nextMarker = headMay $ r $/ s3Elem "NextMarker" &/ content
prefixes = r $/ s3Elem' "CommonPrefixes" &/ s3Elem' "Prefix" &/ content
keys = r $/ s3Elem' "Contents" &/ s3Elem' "Key" &/ content prefixes = r $/ s3Elem "CommonPrefixes" &/ s3Elem "Prefix" &/ content
modTimeStr = r $/ s3Elem' "Contents" &/ s3Elem' "LastModified" &/ content
etagsList = r $/ s3Elem' "Contents" &/ s3Elem' "ETag" &/ content keys = r $/ s3Elem "Contents" &/ s3Elem "Key" &/ content
-- if response xml contains empty etag response fill them with as modTimeStr = r $/ s3Elem "Contents" &/ s3Elem "LastModified" &/ content
-- many empty Text for the zip4 below to work as intended. etagsList = r $/ s3Elem "Contents" &/ s3Elem "ETag" &/ content
etags = etagsList ++ repeat "" -- if response xml contains empty etag response fill them with as
sizeStr = r $/ s3Elem' "Contents" &/ s3Elem' "Size" &/ content -- many empty Text for the zip4 below to work as intended.
etags = etagsList ++ repeat ""
sizeStr = r $/ s3Elem "Contents" &/ s3Elem "Size" &/ content
modTimes <- mapM parseS3XMLTime modTimeStr modTimes <- mapM parseS3XMLTime modTimeStr
sizes <- parseDecimals sizeStr sizes <- parseDecimals sizeStr
let objects = let
map (uncurry6 ObjectInfo) $ objects = map (uncurry4 ObjectInfo) $ zip4 keys modTimes etags sizes
zip6 keys modTimes etags sizes (repeat H.empty) (repeat H.empty)
return $ ListObjectsV1Result hasMore nextMarker objects prefixes return $ ListObjectsV1Result hasMore nextMarker objects prefixes
-- | Parse the response XML of a list objects call. -- | Parse the response XML of a list objects call.
parseListObjectsResponse :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m ListObjectsResult parseListObjectsResponse :: (MonadThrow m) => LByteString -> m ListObjectsResult
parseListObjectsResponse xmldata = do parseListObjectsResponse xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let
let s3Elem' = s3Elem ns hasMore = ["true"] == (r $/ s3Elem "IsTruncated" &/ content)
hasMore = ["true"] == (r $/ s3Elem' "IsTruncated" &/ content)
nextToken = listToMaybe $ r $/ s3Elem' "NextContinuationToken" &/ content nextToken = headMay $ r $/ s3Elem "NextContinuationToken" &/ content
prefixes = r $/ s3Elem' "CommonPrefixes" &/ s3Elem' "Prefix" &/ content
keys = r $/ s3Elem' "Contents" &/ s3Elem' "Key" &/ content prefixes = r $/ s3Elem "CommonPrefixes" &/ s3Elem "Prefix" &/ content
modTimeStr = r $/ s3Elem' "Contents" &/ s3Elem' "LastModified" &/ content
etagsList = r $/ s3Elem' "Contents" &/ s3Elem' "ETag" &/ content keys = r $/ s3Elem "Contents" &/ s3Elem "Key" &/ content
-- if response xml contains empty etag response fill them with as modTimeStr = r $/ s3Elem "Contents" &/ s3Elem "LastModified" &/ content
-- many empty Text for the zip4 below to work as intended. etagsList = r $/ s3Elem "Contents" &/ s3Elem "ETag" &/ content
etags = etagsList ++ repeat "" -- if response xml contains empty etag response fill them with as
sizeStr = r $/ s3Elem' "Contents" &/ s3Elem' "Size" &/ content -- many empty Text for the zip4 below to work as intended.
etags = etagsList ++ repeat ""
sizeStr = r $/ s3Elem "Contents" &/ s3Elem "Size" &/ content
modTimes <- mapM parseS3XMLTime modTimeStr modTimes <- mapM parseS3XMLTime modTimeStr
sizes <- parseDecimals sizeStr sizes <- parseDecimals sizeStr
let objects = let
map (uncurry6 ObjectInfo) $ objects = map (uncurry4 ObjectInfo) $ zip4 keys modTimes etags sizes
zip6 keys modTimes etags sizes (repeat H.empty) (repeat H.empty)
return $ ListObjectsResult hasMore nextToken objects prefixes return $ ListObjectsResult hasMore nextToken objects prefixes
-- | Parse the response XML of a list incomplete multipart upload call. -- | Parse the response XML of a list incomplete multipart upload call.
parseListUploadsResponse :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m ListUploadsResult parseListUploadsResponse :: (MonadThrow m) => LByteString -> m ListUploadsResult
parseListUploadsResponse xmldata = do parseListUploadsResponse xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let
let s3Elem' = s3Elem ns hasMore = ["true"] == (r $/ s3Elem "IsTruncated" &/ content)
hasMore = ["true"] == (r $/ s3Elem' "IsTruncated" &/ content) prefixes = r $/ s3Elem "CommonPrefixes" &/ s3Elem "Prefix" &/ content
prefixes = r $/ s3Elem' "CommonPrefixes" &/ s3Elem' "Prefix" &/ content nextKey = headMay $ r $/ s3Elem "NextKeyMarker" &/ content
nextKey = listToMaybe $ r $/ s3Elem' "NextKeyMarker" &/ content nextUpload = headMay $ r $/ s3Elem "NextUploadIdMarker" &/ content
nextUpload = listToMaybe $ r $/ s3Elem' "NextUploadIdMarker" &/ content uploadKeys = r $/ s3Elem "Upload" &/ s3Elem "Key" &/ content
uploadKeys = r $/ s3Elem' "Upload" &/ s3Elem' "Key" &/ content uploadIds = r $/ s3Elem "Upload" &/ s3Elem "UploadId" &/ content
uploadIds = r $/ s3Elem' "Upload" &/ s3Elem' "UploadId" &/ content uploadInitTimeStr = r $/ s3Elem "Upload" &/ s3Elem "Initiated" &/ content
uploadInitTimeStr = r $/ s3Elem' "Upload" &/ s3Elem' "Initiated" &/ content
uploadInitTimes <- mapM parseS3XMLTime uploadInitTimeStr uploadInitTimes <- mapM parseS3XMLTime uploadInitTimeStr
let uploads = zip3 uploadKeys uploadIds uploadInitTimes let
uploads = zip3 uploadKeys uploadIds uploadInitTimes
return $ ListUploadsResult hasMore nextKey nextUpload uploads prefixes return $ ListUploadsResult hasMore nextKey nextUpload uploads prefixes
parseListPartsResponse :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m ListPartsResult parseListPartsResponse :: (MonadThrow m) => LByteString -> m ListPartsResult
parseListPartsResponse xmldata = do parseListPartsResponse xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let
let s3Elem' = s3Elem ns hasMore = ["true"] == (r $/ s3Elem "IsTruncated" &/ content)
hasMore = ["true"] == (r $/ s3Elem' "IsTruncated" &/ content) nextPartNumStr = headMay $ r $/ s3Elem "NextPartNumberMarker" &/ content
nextPartNumStr = listToMaybe $ r $/ s3Elem' "NextPartNumberMarker" &/ content partNumberStr = r $/ s3Elem "Part" &/ s3Elem "PartNumber" &/ content
partNumberStr = r $/ s3Elem' "Part" &/ s3Elem' "PartNumber" &/ content partModTimeStr = r $/ s3Elem "Part" &/ s3Elem "LastModified" &/ content
partModTimeStr = r $/ s3Elem' "Part" &/ s3Elem' "LastModified" &/ content partETags = r $/ s3Elem "Part" &/ s3Elem "ETag" &/ content
partETags = r $/ s3Elem' "Part" &/ s3Elem' "ETag" &/ content partSizeStr = r $/ s3Elem "Part" &/ s3Elem "Size" &/ content
partSizeStr = r $/ s3Elem' "Part" &/ s3Elem' "Size" &/ content
partModTimes <- mapM parseS3XMLTime partModTimeStr partModTimes <- mapM parseS3XMLTime partModTimeStr
partSizes <- parseDecimals partSizeStr partSizes <- parseDecimals partSizeStr
partNumbers <- parseDecimals partNumberStr partNumbers <- parseDecimals partNumberStr
nextPartNum <- parseDecimals $ maybeToList nextPartNumStr nextPartNum <- parseDecimals $ maybeToList nextPartNumStr
let partInfos = let
map (uncurry4 ObjectPartInfo) $ partInfos = map (uncurry4 ObjectPartInfo) $
zip4 partNumbers partETags partSizes partModTimes zip4 partNumbers partETags partSizes partModTimes
return $ ListPartsResult hasMore (listToMaybe nextPartNum) partInfos return $ ListPartsResult hasMore (listToMaybe nextPartNum) partInfos
parseNotification :: (MonadReader env m, HasSvcNamespace env, MonadIO m) => LByteString -> m Notification
parseErrResponse :: (MonadThrow m) => LByteString -> m ServiceErr
parseErrResponse xmldata = do
r <- parseRoot xmldata
let code = T.concat $ r $/ element "Code" &/ content
message = T.concat $ r $/ element "Message" &/ content
return $ toServiceErr code message
parseNotification :: (MonadThrow m) => LByteString -> m Notification
parseNotification xmldata = do parseNotification xmldata = do
r <- parseRoot xmldata r <- parseRoot xmldata
ns <- asks getSvcNamespace let qcfg = map node $ r $/ s3Elem "QueueConfiguration"
let s3Elem' = s3Elem ns tcfg = map node $ r $/ s3Elem "TopicConfiguration"
qcfg = map node $ r $/ s3Elem' "QueueConfiguration" lcfg = map node $ r $/ s3Elem "CloudFunctionConfiguration"
tcfg = map node $ r $/ s3Elem' "TopicConfiguration" Notification <$> (mapM (parseNode "Queue") qcfg)
lcfg = map node $ r $/ s3Elem' "CloudFunctionConfiguration" <*> (mapM (parseNode "Topic") tcfg)
Notification <*> (mapM (parseNode "CloudFunction") lcfg)
<$> mapM (parseNode ns "Queue") qcfg
<*> mapM (parseNode ns "Topic") tcfg
<*> mapM (parseNode ns "CloudFunction") lcfg
where where
getFilterRule ns c =
let name = T.concat $ c $/ s3Elem ns "Name" &/ content
value = T.concat $ c $/ s3Elem ns "Value" &/ content
in FilterRule name value
parseNode ns arnName nodeData = do
let c = fromNode nodeData
itemId = T.concat $ c $/ s3Elem ns "Id" &/ content
arn = T.concat $ c $/ s3Elem ns arnName &/ content
events = mapMaybe textToEvent (c $/ s3Elem ns "Event" &/ content)
rules =
c
$/ s3Elem ns "Filter"
&/ s3Elem ns "S3Key"
&/ s3Elem ns "FilterRule"
&| getFilterRule ns
return $
NotificationConfig
itemId
arn
events
(Filter $ FilterKey $ FilterRules rules)
parseSelectProgress :: (MonadIO m) => ByteString -> m Progress getFilterRule c =
parseSelectProgress xmldata = do let name = T.concat $ c $/ s3Elem "Name" &/ content
r <- parseRoot $ LB.fromStrict xmldata value = T.concat $ c $/ s3Elem "Value" &/ content
let bScanned = T.concat $ r $/ element "BytesScanned" &/ content in FilterRule name value
bProcessed = T.concat $ r $/ element "BytesProcessed" &/ content
bReturned = T.concat $ r $/ element "BytesReturned" &/ content parseNode arnName nodeData = do
Progress let c = fromNode nodeData
<$> parseDecimal bScanned id = T.concat $ c $/ s3Elem "Id" &/ content
<*> parseDecimal bProcessed arn = T.concat $ c $/ s3Elem arnName &/ content
<*> parseDecimal bReturned events = catMaybes $ map textToEvent $ c $/ s3Elem "Event" &/ content
rules = c $/ s3Elem "Filter" &/ s3Elem "S3Key" &/
s3Elem "FilterRule" &| getFilterRule
return $ NotificationConfig id arn events
(Filter $ FilterKey $ FilterRules rules)

View File

@ -15,7 +15,7 @@
# resolver: # resolver:
# name: custom-snapshot # name: custom-snapshot
# location: "./custom-snapshot.yaml" # location: "./custom-snapshot.yaml"
resolver: lts-22.19 resolver: lts-9.1
# User packages to be built. # User packages to be built.
# Various formats can be used as shown in the example below. # Various formats can be used as shown in the example below.
@ -36,17 +36,17 @@ resolver: lts-22.19
# non-dependency (i.e. a user package), and its test suites and benchmarks # non-dependency (i.e. a user package), and its test suites and benchmarks
# will not be run. This is useful for tweaking upstream packages. # will not be run. This is useful for tweaking upstream packages.
packages: packages:
- "." - '.'
# Dependency packages to be pulled from upstream that are not in the resolver # Dependency packages to be pulled from upstream that are not in the resolver
# (e.g., acme-missiles-0.3) # (e.g., acme-missiles-0.3)
extra-deps: extra-deps: []
- crypton-connection-0.3.2
# Override default flag values for local packages and extra-deps # Override default flag values for local packages and extra-deps
flags: {} flags: {}
# Extra package databases containing global packages # Extra package databases containing global packages
extra-package-dbs: [] extra-package-dbs: []
# Control whether we use the GHC we find on the path # Control whether we use the GHC we find on the path
# system-ghc: true # system-ghc: true
# #

View File

@ -1,19 +0,0 @@
# This file was autogenerated by Stack.
# You should not edit this file by hand.
# For more information, please see the documentation at:
# https://docs.haskellstack.org/en/stable/lock_files
packages:
- completed:
hackage: crypton-connection-0.3.2@sha256:c7937edc25ab022bcf167703f2ec5ab73b62908e545bb587d2aa42b33cd6f6cc,1581
pantry-tree:
sha256: f986ad29b008cbe5732606e9cde1897191c486a2f1f169a4cb75fd915bce397c
size: 394
original:
hackage: crypton-connection-0.3.2
snapshots:
- completed:
sha256: e5cac927cf7ccbd52aa41476baa68b88c564ee6ddc3bc573dbf4210069287fe7
size: 713340
url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/19.yaml
original: lts-22.19

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,102 +15,36 @@
-- --
module Network.Minio.API.Test module Network.Minio.API.Test
( bucketNameValidityTests, ( bucketNameValidityTests
objectNameValidityTests, , objectNameValidityTests
parseServerInfoJSONTest, ) where
parseHealStatusTest,
parseHealStartRespTest,
)
where
import Data.Aeson (eitherDecode)
import Network.Minio.API
import Network.Minio.AdminAPI
import Test.Tasty import Test.Tasty
import Test.Tasty.HUnit import Test.Tasty.HUnit
assertBool' :: Bool -> Assertion import Lib.Prelude
import Network.Minio.API
assertBool' = assertBool "Test failed!" assertBool' = assertBool "Test failed!"
bucketNameValidityTests :: TestTree bucketNameValidityTests :: TestTree
bucketNameValidityTests = bucketNameValidityTests = testGroup "Bucket Name Validity Tests"
testGroup [ testCase "Too short 1" $ assertBool' $ not $ isValidBucketName ""
"Bucket Name Validity Tests" , testCase "Too short 2" $ assertBool' $ not $ isValidBucketName "ab"
[ testCase "Too short 1" $ assertBool' $ not $ isValidBucketName "", , testCase "Too long 1" $ assertBool' $ not $ isValidBucketName "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
testCase "Too short 2" $ assertBool' $ not $ isValidBucketName "ab", , testCase "Has upper case" $ assertBool' $ not $ isValidBucketName "ABCD"
testCase "Too long 1" $ assertBool' $ not $ isValidBucketName "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", , testCase "Has punctuation" $ assertBool' $ not $ isValidBucketName "abc,2"
testCase "Has upper case" $ assertBool' $ not $ isValidBucketName "ABCD", , testCase "Has hyphen at end" $ assertBool' $ not $ isValidBucketName "abc-"
testCase "Has punctuation" $ assertBool' $ not $ isValidBucketName "abc,2", , testCase "Has consecutive dot" $ assertBool' $ not $ isValidBucketName "abck..eedg"
testCase "Has hyphen at end" $ assertBool' $ not $ isValidBucketName "abc-", , testCase "Looks like IP" $ assertBool' $ not $ isValidBucketName "10.0.0.1"
testCase "Has consecutive dot" $ assertBool' $ not $ isValidBucketName "abck..eedg", , testCase "Valid bucket name 1" $ assertBool' $ isValidBucketName "abcd.pqeq.rea"
testCase "Looks like IP" $ assertBool' $ not $ isValidBucketName "10.0.0.1", , testCase "Valid bucket name 2" $ assertBool' $ isValidBucketName "abcdedgh1d"
testCase "Valid bucket name 1" $ assertBool' $ isValidBucketName "abcd.pqeq.rea", , testCase "Valid bucket name 3" $ assertBool' $ isValidBucketName "abc-de-dg-h1d"
testCase "Valid bucket name 2" $ assertBool' $ isValidBucketName "abcdedgh1d", ]
testCase "Valid bucket name 3" $ assertBool' $ isValidBucketName "abc-de-dg-h1d"
]
objectNameValidityTests :: TestTree objectNameValidityTests :: TestTree
objectNameValidityTests = objectNameValidityTests = testGroup "Object Name Validity Tests"
testGroup [ testCase "Empty name" $ assertBool' $ not $ isValidObjectName ""
"Object Name Validity Tests" , testCase "Has unicode characters" $ assertBool' $ isValidObjectName "日本国"
[ testCase "Empty name" $ assertBool' $ not $ isValidObjectName "", ]
testCase "Has unicode characters" $ assertBool' $ isValidObjectName "日本国"
]
parseServerInfoJSONTest :: TestTree
parseServerInfoJSONTest =
testGroup "Parse MinIO Admin API ServerInfo JSON test" $
map
( \(tName, tDesc, tfn, tVal) ->
testCase tName $
assertBool tDesc $
tfn (eitherDecode tVal :: Either [Char] [ServerInfo])
)
testCases
where
testCases =
[ ("FSBackend", "Verify server info json parsing for FS backend", isRight, fsJSON),
("Erasure Backend", "Verify server info json parsing for Erasure backend", isRight, erasureJSON),
("Unknown Backend", "Verify server info json parsing for invalid backend", isLeft, invalidJSON)
]
fsJSON = "[{\"error\":\"\",\"addr\":\"192.168.1.218:9000\",\"data\":{\"storage\":{\"Used\":20530,\"Backend\":{\"Type\":1,\"OnlineDisks\":0,\"OfflineDisks\":0,\"StandardSCData\":0,\"StandardSCParity\":0,\"RRSCData\":0,\"RRSCParity\":0,\"Sets\":null}},\"network\":{\"transferred\":808,\"received\":1160},\"http\":{\"totalHEADs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successHEADs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalGETs\":{\"count\":1,\"avgDuration\":\"0s\"},\"successGETs\":{\"count\":1,\"avgDuration\":\"0s\"},\"totalPUTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successPUTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalPOSTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successPOSTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalDELETEs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successDELETEs\":{\"count\":0,\"avgDuration\":\"0s\"}},\"server\":{\"uptime\":5992503019270,\"version\":\"DEVELOPMENT.GOGET\",\"commitID\":\"DEVELOPMENT.GOGET\",\"region\":\"\",\"sqsARN\":[]}}}]"
erasureJSON = "[{\"error\":\"\",\"addr\":\"192.168.1.218:9000\",\"data\":{\"storage\":{\"Used\":83084,\"Backend\":{\"Type\":2,\"OnlineDisks\":4,\"OfflineDisks\":0,\"StandardSCData\":2,\"StandardSCParity\":2,\"RRSCData\":2,\"RRSCParity\":2,\"Sets\":[[{\"uuid\":\"16ec6f2c-9197-4787-904a-36bb2c2683f8\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"4052e086-ef99-4aa5-ae2b-8e27559432f6\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"d0639950-ddd3-45b0-93ca-fd86f5d79f72\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"30ec68c0-37e1-4592-82c1-26b143c0ac10\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]]}},\"network\":{\"transferred\":404,\"received\":0},\"http\":{\"totalHEADs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successHEADs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalGETs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successGETs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalPUTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successPUTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalPOSTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successPOSTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalDELETEs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successDELETEs\":{\"count\":0,\"avgDuration\":\"0s\"}},\"server\":{\"uptime\":2738903073,\"version\":\"DEVELOPMENT.GOGET\",\"commitID\":\"DEVELOPMENT.GOGET\",\"region\":\"\",\"sqsARN\":[]}}}]"
invalidJSON = "[{\"error\":\"\",\"addr\":\"192.168.1.218:9000\",\"data\":{\"storage\":{\"Used\":83084,\"Backend\":{\"Type\":42,\"OnlineDisks\":4,\"OfflineDisks\":0,\"StandardSCData\":2,\"StandardSCParity\":2,\"RRSCData\":2,\"RRSCParity\":2,\"Sets\":[[{\"uuid\":\"16ec6f2c-9197-4787-904a-36bb2c2683f8\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"4052e086-ef99-4aa5-ae2b-8e27559432f6\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"d0639950-ddd3-45b0-93ca-fd86f5d79f72\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"30ec68c0-37e1-4592-82c1-26b143c0ac10\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]]}},\"network\":{\"transferred\":404,\"received\":0},\"http\":{\"totalHEADs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successHEADs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalGETs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successGETs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalPUTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successPUTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalPOSTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successPOSTs\":{\"count\":0,\"avgDuration\":\"0s\"},\"totalDELETEs\":{\"count\":0,\"avgDuration\":\"0s\"},\"successDELETEs\":{\"count\":0,\"avgDuration\":\"0s\"}},\"server\":{\"uptime\":2738903073,\"version\":\"DEVELOPMENT.GOGET\",\"commitID\":\"DEVELOPMENT.GOGET\",\"region\":\"\",\"sqsARN\":[]}}}]"
parseHealStatusTest :: TestTree
parseHealStatusTest =
testGroup "Parse MinIO Admin API HealStatus JSON test" $
map
( \(tName, tDesc, tfn, tVal) ->
testCase tName $
assertBool tDesc $
tfn (eitherDecode tVal :: Either [Char] HealStatus)
)
testCases
where
testCases =
[ ("Good", "Verify heal result item for erasure backend", isRight, erasureJSON'),
("Corrupted", "Verify heal result item for erasure backend", isLeft, invalidJSON'),
("Incorrect Value", "Verify heal result item for erasure backend", isLeft, invalidItemType)
]
erasureJSON' = "{\"Summary\":\"finished\",\"StartTime\":\"2018-06-05T08:09:47.644465513Z\",\"NumDisks\":4,\"Settings\":{\"recursive\":false,\"dryRun\":false},\"Items\":[{\"resultId\":1,\"type\":\"metadata\",\"bucket\":\"\",\"object\":\"\",\"detail\":\"disk-format\",\"diskCount\":4,\"setCount\":1,\"before\":{\"drives\":[{\"uuid\":\"c3487166-b8a4-481a-b1e7-fb9b249e2500\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"55a6e787-184f-4e4c-bf09-03dcada658a9\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"f035d8c3-fca1-4407-b89c-38c2bcf4a641\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"4f8b79d3-db90-4c1d-87c2-35a28b0d9a13\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]},\"after\":{\"drives\":[{\"uuid\":\"c3487166-b8a4-481a-b1e7-fb9b249e2500\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"55a6e787-184f-4e4c-bf09-03dcada658a9\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"f035d8c3-fca1-4407-b89c-38c2bcf4a641\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"4f8b79d3-db90-4c1d-87c2-35a28b0d9a13\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]},\"objectSize\":0}]}"
invalidJSON' = "{\"Summary\":\"finished\",\"StartTime\":\"2018-06-05T08:09:47.644465513Z\",\"NumDisks\":4,\"Settings\":{\"recursive\":false,\"dryRun\":false},\"Items\":[{\"resultId\":1,\"type\":\"metadata\",\"bucket\":\"\",\"object\":\"\",\"detail\":\"disk-format\",\"diskCount\":4,\"setCount\":1,\"before\":{\"drives\":[{\"uuid\":\"c3487166-b8a4-481a-b1e7-fb9b249e2500\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"55a6e787-184f-4e4c-bf09-03dcada658a9\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"f035d8c3-fca1-4407-b89c-38c2bcf4a641\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"4f8b79d3-db90-4c1d-87c2-35a28b0d9a13\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]},\"after\":{\"drives\":[{\"uuid\":\"c3487166-b8a4-481a-b1e7-fb9b249e2500\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"55a6e787-184f-4e4c-bf09-03dcada658a9\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"f035d8c3-fca1-4407-b89c-38c2bcf4a641\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"4f8b79d3-db90-4c1d-87c2-35a28b0d9a13\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]},\"objectSize\":0}]"
invalidItemType = "{\"Summary\":\"finished\",\"StartTime\":\"2018-06-05T08:09:47.644465513Z\",\"NumDisks\":4,\"Settings\":{\"recursive\":false,\"dryRun\":false},\"Items\":[{\"resultId\":1,\"type\":\"hello\",\"bucket\":\"\",\"object\":\"\",\"detail\":\"disk-format\",\"diskCount\":4,\"setCount\":1,\"before\":{\"drives\":[{\"uuid\":\"c3487166-b8a4-481a-b1e7-fb9b249e2500\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"55a6e787-184f-4e4c-bf09-03dcada658a9\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"f035d8c3-fca1-4407-b89c-38c2bcf4a641\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"4f8b79d3-db90-4c1d-87c2-35a28b0d9a13\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]},\"after\":{\"drives\":[{\"uuid\":\"c3487166-b8a4-481a-b1e7-fb9b249e2500\",\"endpoint\":\"/tmp/1\",\"state\":\"ok\"},{\"uuid\":\"55a6e787-184f-4e4c-bf09-03dcada658a9\",\"endpoint\":\"/tmp/2\",\"state\":\"ok\"},{\"uuid\":\"f035d8c3-fca1-4407-b89c-38c2bcf4a641\",\"endpoint\":\"/tmp/3\",\"state\":\"ok\"},{\"uuid\":\"4f8b79d3-db90-4c1d-87c2-35a28b0d9a13\",\"endpoint\":\"/tmp/4\",\"state\":\"ok\"}]},\"objectSize\":0}]}"
parseHealStartRespTest :: TestTree
parseHealStartRespTest =
testGroup "Parse MinIO Admin API HealStartResp JSON test" $
map
( \(tName, tDesc, tfn, tVal) ->
testCase tName $
assertBool tDesc $
tfn (eitherDecode tVal :: Either [Char] HealStartResp)
)
testCases
where
testCases =
[ ("Good", "Verify heal start response for erasure backend", isRight, hsrJSON),
("Missing Token", "Verify heal start response for erasure backend", isLeft, missingTokenJSON)
]
hsrJSON = "{\"clientToken\":\"3a3aca49-77dd-4b78-bba7-0978f119b23e\",\"clientAddress\":\"127.0.0.1\",\"startTime\":\"2018-06-05T08:09:47.644394493Z\"}"
missingTokenJSON = "{\"clientAddress\":\"127.0.0.1\",\"startTime\":\"2018-06-05T08:09:47.644394493Z\"}"

View File

@ -1,63 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.JsonParser.Test
( jsonParserTests,
)
where
import Lib.Prelude
import Network.Minio.Errors
import Network.Minio.JsonParser
import Test.Tasty
import Test.Tasty.HUnit
import UnliftIO (MonadUnliftIO)
jsonParserTests :: TestTree
jsonParserTests =
testGroup
"JSON Parser Tests"
[ testCase "Test parseErrResponseJSON" testParseErrResponseJSON
]
tryValidationErr :: (MonadUnliftIO m) => m a -> m (Either MErrV a)
tryValidationErr = try
assertValidationErr :: MErrV -> Assertion
assertValidationErr e = assertFailure $ "Failed due to validation error => " ++ show e
testParseErrResponseJSON :: Assertion
testParseErrResponseJSON = do
-- 1. Test parsing of an invalid error json.
parseResE <- tryValidationErr $ parseErrResponseJSON "ClearlyInvalidJSON"
when (isRight parseResE) $
assertFailure $
"Parsing should have failed => " ++ show parseResE
forM_ cases $ \(jsondata, sErr) -> do
parseErr <- tryValidationErr $ parseErrResponseJSON jsondata
either assertValidationErr (@?= sErr) parseErr
where
cases =
[ -- 2. Test parsing of a valid error json.
( "{\"Code\":\"InvalidAccessKeyId\",\"Message\":\"The access key ID you provided does not exist in our records.\",\"Key\":\"\",\"BucketName\":\"\",\"Resource\":\"/minio/admin/v1/info\",\"RequestId\":\"3L137\",\"HostId\":\"3L137\"}",
ServiceErr "InvalidAccessKeyId" "The access key ID you provided does not exist in our records."
),
-- 3. Test parsing of a valid, empty Resource.
( "{\"Code\":\"SignatureDoesNotMatch\",\"Message\":\"The request signature we calculated does not match the signature you provided. Check your key and signing method.\",\"Key\":\"\",\"BucketName\":\"\",\"Resource\":\"/minio/admin/v1/info\",\"RequestId\":\"3L137\",\"HostId\":\"3L137\"}",
ServiceErr "SignatureDoesNotMatch" "The request signature we calculated does not match the signature you provided. Check your key and signing method."
)
]

View File

@ -1,32 +0,0 @@
--
-- MinIO Haskell SDK, (C) 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
module Network.Minio.TestHelpers
( runTestNS,
)
where
import Network.Minio.Data
newtype TestNS = TestNS {testNamespace :: Text}
instance HasSvcNamespace TestNS where
getSvcNamespace = testNamespace
runTestNS :: ReaderT TestNS m a -> m a
runTestNS =
flip runReaderT $
TestNS "http://s3.amazonaws.com/doc/2006-03-01/"

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -15,31 +15,33 @@
-- --
module Network.Minio.Utils.Test module Network.Minio.Utils.Test
( limitedMapConcurrentlyTests, (
) limitedMapConcurrentlyTests
where ) where
import Network.Minio.Utils
import Test.Tasty import Test.Tasty
import Test.Tasty.HUnit import Test.Tasty.HUnit
import Lib.Prelude
import Network.Minio.Utils
limitedMapConcurrentlyTests :: TestTree limitedMapConcurrentlyTests :: TestTree
limitedMapConcurrentlyTests = limitedMapConcurrentlyTests = testGroup "limitedMapConcurrently Tests"
testGroup [ testCase "Test with various thread counts" testLMC
"limitedMapConcurrently Tests" ]
[ testCase "Test with various thread counts" testLMC
]
testLMC :: Assertion testLMC :: Assertion
testLMC = do testLMC = do
let maxNum = 50 let maxNum = 50
-- test with thread count of 1 to 2*maxNum -- test with thread count of 1 to 2*maxNum
forM_ [1 .. (2 * maxNum)] $ \threads -> do forM_ [1..(2*maxNum)] $ \threads -> do
res <- limitedMapConcurrently threads compute [1 .. maxNum] res <- limitedMapConcurrently threads compute [1..maxNum]
sum res @?= overallResultCheck maxNum sum res @?= overallResultCheck maxNum
where where
-- simple function to run in each thread -- simple function to run in each thread
compute :: Int -> IO Int compute :: Int -> IO Int
compute n = return $ sum [1 .. n] compute n = return $ sum [1..n]
-- function to check overall result -- function to check overall result
overallResultCheck n = sum $ map (\t -> (t * (t + 1)) `div` 2) [1 .. n] overallResultCheck n = sum $ map (\t -> (t * (t+1)) `div` 2) [1..n]

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -13,170 +13,83 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE QuasiQuotes #-}
module Network.Minio.XmlGenerator.Test module Network.Minio.XmlGenerator.Test
( xmlGeneratorTests, ( xmlGeneratorTests
) ) where
where
import qualified Data.ByteString.Lazy as LBS import Test.Tasty
import Lib.Prelude import Test.Tasty.HUnit
import Network.Minio.Data
import Network.Minio.TestHelpers import Lib.Prelude
import Network.Minio.XmlGenerator
import Network.Minio.XmlParser (parseNotification) import Data.Default (def)
import Test.Tasty
import Test.Tasty.HUnit import Network.Minio.Data
import Text.RawString.QQ (r) import Network.Minio.XmlGenerator
import Text.XML (def, parseLBS) import Network.Minio.XmlParser (parseNotification)
xmlGeneratorTests :: TestTree xmlGeneratorTests :: TestTree
xmlGeneratorTests = xmlGeneratorTests = testGroup "XML Generator Tests"
testGroup [ testCase "Test mkCreateBucketConfig" testMkCreateBucketConfig
"XML Generator Tests" , testCase "Test mkCompleteMultipartUploadRequest" testMkCompleteMultipartUploadRequest
[ testCase "Test mkCreateBucketConfig" testMkCreateBucketConfig, , testCase "Test mkPutNotificationRequest" testMkPutNotificationRequest
testCase "Test mkCompleteMultipartUploadRequest" testMkCompleteMultipartUploadRequest, ]
testCase "Test mkPutNotificationRequest" testMkPutNotificationRequest,
testCase "Test mkSelectRequest" testMkSelectRequest
]
testMkCreateBucketConfig :: Assertion testMkCreateBucketConfig :: Assertion
testMkCreateBucketConfig = do testMkCreateBucketConfig = do
let ns = "http://s3.amazonaws.com/doc/2006-03-01/"
assertEqual "CreateBucketConfiguration xml should match: " expected $ assertEqual "CreateBucketConfiguration xml should match: " expected $
mkCreateBucketConfig ns "EU" mkCreateBucketConfig "EU"
where where
expected = expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ \<CreateBucketConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<CreateBucketConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<LocationConstraint>EU</LocationConstraint>\
\<LocationConstraint>EU</LocationConstraint>\ \</CreateBucketConfiguration>"
\</CreateBucketConfiguration>"
testMkCompleteMultipartUploadRequest :: Assertion testMkCompleteMultipartUploadRequest :: Assertion
testMkCompleteMultipartUploadRequest = testMkCompleteMultipartUploadRequest =
assertEqual "completeMultipartUpload xml should match: " expected $ assertEqual "completeMultipartUpload xml should match: " expected $
mkCompleteMultipartUploadRequest [(1, "abc")] mkCompleteMultipartUploadRequest [(1, "abc")]
where where
expected = expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ \<CompleteMultipartUpload>\
\<CompleteMultipartUpload>\ \<Part>\
\<Part>\ \<PartNumber>1</PartNumber><ETag>abc</ETag>\
\<PartNumber>1</PartNumber><ETag>abc</ETag>\ \</Part>\
\</Part>\ \</CompleteMultipartUpload>"
\</CompleteMultipartUpload>"
testMkPutNotificationRequest :: Assertion testMkPutNotificationRequest :: Assertion
testMkPutNotificationRequest = testMkPutNotificationRequest =
forM_ cases $ \val -> do forM_ cases $ \val -> do
let ns = "http://s3.amazonaws.com/doc/2006-03-01/" let result = toS $ mkPutNotificationRequest val
result = fromStrictBS $ mkPutNotificationRequest ns val ntf <- runExceptT $ parseNotification result
ntf <- runExceptT $ runTestNS $ parseNotification result either (\_ -> assertFailure "XML Parse Error!")
either (@?= val) ntf
(\_ -> assertFailure "XML Parse Error!")
(@?= val)
ntf
where where
cases = cases = [ Notification []
[ Notification [ NotificationConfig
[] "YjVkM2Y0YmUtNGI3NC00ZjQyLWEwNGItNDIyYWUxY2I0N2M4"
[ NotificationConfig "arn:aws:sns:us-east-1:account-id:s3notificationtopic2"
"YjVkM2Y0YmUtNGI3NC00ZjQyLWEwNGItNDIyYWUxY2I0N2M4" [ReducedRedundancyLostObject, ObjectCreated] def
"arn:aws:sns:us-east-1:account-id:s3notificationtopic2" ]
[ReducedRedundancyLostObject, ObjectCreated] []
defaultFilter , Notification
] [ NotificationConfig
[], "1" "arn:aws:sqs:us-west-2:444455556666:s3notificationqueue"
Notification [ObjectCreatedPut]
[ NotificationConfig (Filter $ FilterKey $ FilterRules
"1" [ FilterRule "prefix" "images/"
"arn:aws:sqs:us-west-2:444455556666:s3notificationqueue" , FilterRule "suffix" ".jpg"])
[ObjectCreatedPut] , NotificationConfig
( Filter $ "" "arn:aws:sqs:us-east-1:356671443308:s3notificationqueue"
FilterKey $ [ObjectCreated] def
FilterRules ]
[ FilterRule "prefix" "images/", [ NotificationConfig
FilterRule "suffix" ".jpg" "" "arn:aws:sns:us-east-1:356671443308:s3notificationtopic2"
] [ReducedRedundancyLostObject] def
), ]
NotificationConfig [ NotificationConfig
"" "ObjectCreatedEvents" "arn:aws:lambda:us-west-2:35667example:function:CreateThumbnail"
"arn:aws:sqs:us-east-1:356671443308:s3notificationqueue" [ObjectCreated] def
[ObjectCreated] ]
defaultFilter ]
]
[ NotificationConfig
""
"arn:aws:sns:us-east-1:356671443308:s3notificationtopic2"
[ReducedRedundancyLostObject]
defaultFilter
]
[ NotificationConfig
"ObjectCreatedEvents"
"arn:aws:lambda:us-west-2:35667example:function:CreateThumbnail"
[ObjectCreated]
defaultFilter
]
]
testMkSelectRequest :: Assertion
testMkSelectRequest = mapM_ assertFn cases
where
assertFn (a, b) =
let generatedReqDoc = parseLBS def $ LBS.fromStrict $ mkSelectRequest a
expectedReqDoc = parseLBS def $ LBS.fromStrict b
in case (generatedReqDoc, expectedReqDoc) of
(Right genDoc, Right expDoc) -> assertEqual "selectRequest XML should match: " expDoc genDoc
(Left err, _) -> assertFailure $ "Generated selectRequest failed to parse as XML" ++ show err
(_, Left err) -> assertFailure $ "Expected selectRequest failed to parse as XML" ++ show err
cases =
[ ( SelectRequest
"Select * from S3Object"
SQL
( InputSerialization
(Just CompressionTypeGzip)
( InputFormatCSV $
fileHeaderInfo FileHeaderIgnore
<> recordDelimiter "\n"
<> fieldDelimiter ","
<> quoteCharacter "\""
<> quoteEscapeCharacter "\""
)
)
( OutputSerializationCSV $
quoteFields QuoteFieldsAsNeeded
<> recordDelimiter "\n"
<> fieldDelimiter ","
<> quoteCharacter "\""
<> quoteEscapeCharacter "\""
)
(Just False),
[r|<?xml version="1.0" encoding="UTF-8"?><SelectRequest><Expression>Select * from S3Object</Expression><ExpressionType>SQL</ExpressionType><InputSerialization><CompressionType>GZIP</CompressionType><CSV><FieldDelimiter>,</FieldDelimiter><FileHeaderInfo>IGNORE</FileHeaderInfo><QuoteCharacter>"</QuoteCharacter><QuoteEscapeCharacter>"</QuoteEscapeCharacter><RecordDelimiter>
</RecordDelimiter></CSV></InputSerialization><OutputSerialization><CSV><FieldDelimiter>,</FieldDelimiter><QuoteCharacter>"</QuoteCharacter><QuoteEscapeCharacter>"</QuoteEscapeCharacter><QuoteFields>ASNEEDED</QuoteFields><RecordDelimiter>
</RecordDelimiter></CSV></OutputSerialization><RequestProgress><Enabled>FALSE</Enabled></RequestProgress></SelectRequest>|]
),
( setRequestProgressEnabled False $
setInputCompressionType CompressionTypeGzip $
selectRequest
"Select * from S3Object"
documentJsonInput
(outputJSONFromRecordDelimiter "\n"),
[r|<?xml version="1.0" encoding="UTF-8"?><SelectRequest><Expression>Select * from S3Object</Expression><ExpressionType>SQL</ExpressionType><InputSerialization><CompressionType>GZIP</CompressionType><JSON><Type>DOCUMENT</Type></JSON></InputSerialization><OutputSerialization><JSON><RecordDelimiter>
</RecordDelimiter></JSON></OutputSerialization><RequestProgress><Enabled>FALSE</Enabled></RequestProgress></SelectRequest>|]
),
( setRequestProgressEnabled False $
setInputCompressionType CompressionTypeNone $
selectRequest
"Select * from S3Object"
defaultParquetInput
( outputCSVFromProps $
quoteFields QuoteFieldsAsNeeded
<> recordDelimiter "\n"
<> fieldDelimiter ","
<> quoteCharacter "\""
<> quoteEscapeCharacter "\""
),
[r|<?xml version="1.0" encoding="UTF-8"?><SelectRequest><Expression>Select * from S3Object</Expression><ExpressionType>SQL</ExpressionType><InputSerialization><CompressionType>NONE</CompressionType><Parquet/></InputSerialization><OutputSerialization><CSV><FieldDelimiter>,</FieldDelimiter><QuoteCharacter>"</QuoteCharacter><QuoteEscapeCharacter>"</QuoteEscapeCharacter><QuoteFields>ASNEEDED</QuoteFields><RecordDelimiter>
</RecordDelimiter></CSV></OutputSerialization><RequestProgress><Enabled>FALSE</Enabled></RequestProgress></SelectRequest>|]
)
]

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -13,49 +13,46 @@
-- See the License for the specific language governing permissions and -- See the License for the specific language governing permissions and
-- limitations under the License. -- limitations under the License.
-- --
{-# LANGUAGE QuasiQuotes #-}
module Network.Minio.XmlParser.Test module Network.Minio.XmlParser.Test
( xmlParserTests, (
) xmlParserTests
where ) where
import qualified Data.HashMap.Strict as H import qualified Control.Monad.Catch as MC
import Data.Time (fromGregorian) import Data.Time (fromGregorian)
import Lib.Prelude import Test.Tasty
import Network.Minio.Data import Test.Tasty.HUnit
import Network.Minio.Errors
import Network.Minio.TestHelpers import Lib.Prelude
import Network.Minio.XmlParser
import Test.Tasty import Data.Default (def)
import Test.Tasty.HUnit
import Text.RawString.QQ (r) import Network.Minio.Data
import UnliftIO (MonadUnliftIO) import Network.Minio.Errors
import Network.Minio.XmlParser
xmlParserTests :: TestTree xmlParserTests :: TestTree
xmlParserTests = xmlParserTests = testGroup "XML Parser Tests"
testGroup [ testCase "Test parseLocation" testParseLocation
"XML Parser Tests" , testCase "Test parseNewMultipartUpload" testParseNewMultipartUpload
[ testCase "Test parseLocation" testParseLocation, , testCase "Test parseListObjectsResponse" testParseListObjectsResult
testCase "Test parseNewMultipartUpload" testParseNewMultipartUpload, , testCase "Test parseListObjectsV1Response" testParseListObjectsV1Result
testCase "Test parseListObjectsResponse" testParseListObjectsResult, , testCase "Test parseListUploadsresponse" testParseListIncompleteUploads
testCase "Test parseListObjectsV1Response" testParseListObjectsV1Result, , testCase "Test parseCompleteMultipartUploadResponse" testParseCompleteMultipartUploadResponse
testCase "Test parseListUploadsresponse" testParseListIncompleteUploads, , testCase "Test parseListPartsResponse" testParseListPartsResponse
testCase "Test parseCompleteMultipartUploadResponse" testParseCompleteMultipartUploadResponse, , testCase "Test parseCopyObjectResponse" testParseCopyObjectResponse
testCase "Test parseListPartsResponse" testParseListPartsResponse, , testCase "Test parseNotification" testParseNotification
testCase "Test parseCopyObjectResponse" testParseCopyObjectResponse, ]
testCase "Test parseNotification" testParseNotification,
testCase "Test parseSelectProgress" testParseSelectProgress
]
tryValidationErr :: (MonadUnliftIO m) => m a -> m (Either MErrV a) tryValidationErr :: (MC.MonadCatch m) => m a -> m (Either MErrV a)
tryValidationErr = try tryValidationErr act = MC.try act
assertValidtionErr :: MErrV -> Assertion assertValidtionErr :: MErrV -> Assertion
assertValidtionErr e = assertFailure $ "Failed due to validation error => " ++ show e assertValidtionErr e = assertFailure $ "Failed due to validation error => " ++ show e
eitherValidationErr :: Either MErrV a -> (a -> Assertion) -> Assertion eitherValidationErr :: Either MErrV a -> (a -> Assertion) -> Assertion
eitherValidationErr (Left e) _ = assertValidtionErr e eitherValidationErr (Left e) _ = assertValidtionErr e
eitherValidationErr (Right a) f = f a eitherValidationErr (Right a) f = f a
testParseLocation :: Assertion testParseLocation :: Assertion
@ -63,341 +60,299 @@ testParseLocation = do
-- 1. Test parsing of an invalid location constraint xml. -- 1. Test parsing of an invalid location constraint xml.
parseResE <- tryValidationErr $ parseLocation "ClearlyInvalidXml" parseResE <- tryValidationErr $ parseLocation "ClearlyInvalidXml"
when (isRight parseResE) $ when (isRight parseResE) $
assertFailure $ assertFailure $ "Parsing should have failed => " ++ show parseResE
"Parsing should have failed => " ++ show parseResE
forM_ cases $ \(xmldata, expectedLocation) -> do forM_ cases $ \(xmldata, expectedLocation) -> do
parseLocE <- tryValidationErr $ parseLocation xmldata parseLocE <- tryValidationErr $ parseLocation xmldata
either assertValidtionErr (@?= expectedLocation) parseLocE either assertValidtionErr (@?= expectedLocation) parseLocE
where where
cases = cases = [
[ -- 2. Test parsing of a valid location xml. -- 2. Test parsing of a valid location xml.
( "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<LocationConstraint xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">EU</LocationConstraint>", \<LocationConstraint xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">EU</LocationConstraint>",
"EU" "EU"
), )
-- 3. Test parsing of a valid, empty location xml. ,
( "<LocationConstraint xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\"/>", -- 3. Test parsing of a valid, empty location xml.
"us-east-1" ("<LocationConstraint xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\"/>",
) "us-east-1"
)
] ]
testParseNewMultipartUpload :: Assertion testParseNewMultipartUpload :: Assertion
testParseNewMultipartUpload = do testParseNewMultipartUpload = do
forM_ cases $ \(xmldata, expectedUploadId) -> do forM_ cases $ \(xmldata, expectedUploadId) -> do
parsedUploadIdE <- tryValidationErr $ runTestNS $ parseNewMultipartUpload xmldata parsedUploadIdE <- tryValidationErr $ parseNewMultipartUpload xmldata
eitherValidationErr parsedUploadIdE (@?= expectedUploadId) eitherValidationErr parsedUploadIdE (@?= expectedUploadId)
where where
cases = cases = [
[ ( "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<InitiateMultipartUploadResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<InitiateMultipartUploadResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\ <Bucket>example-bucket</Bucket>\ \ <Bucket>example-bucket</Bucket>\
\ <Key>example-object</Key>\ \ <Key>example-object</Key>\
\ <UploadId>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>\ \ <UploadId>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>\
\</InitiateMultipartUploadResult>", \</InitiateMultipartUploadResult>",
"VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA" "VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA"
), ),
( "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<InitiateMultipartUploadResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<InitiateMultipartUploadResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\ <Bucket>example-bucket</Bucket>\ \ <Bucket>example-bucket</Bucket>\
\ <Key>example-object</Key>\ \ <Key>example-object</Key>\
\ <UploadId>EXAMPLEJZ6e0YupT2h66iePQCc9IEbYbDUy4RTpMeoSMLPRp8Z5o1u8feSRonpvnWsKKG35tI2LB9VDPiCgTy.Gq2VxQLYjrue4Nq.NBdqI-</UploadId>\ \ <UploadId>EXAMPLEJZ6e0YupT2h66iePQCc9IEbYbDUy4RTpMeoSMLPRp8Z5o1u8feSRonpvnWsKKG35tI2LB9VDPiCgTy.Gq2VxQLYjrue4Nq.NBdqI-</UploadId>\
\</InitiateMultipartUploadResult>", \</InitiateMultipartUploadResult>",
"EXAMPLEJZ6e0YupT2h66iePQCc9IEbYbDUy4RTpMeoSMLPRp8Z5o1u8feSRonpvnWsKKG35tI2LB9VDPiCgTy.Gq2VxQLYjrue4Nq.NBdqI-" "EXAMPLEJZ6e0YupT2h66iePQCc9IEbYbDUy4RTpMeoSMLPRp8Z5o1u8feSRonpvnWsKKG35tI2LB9VDPiCgTy.Gq2VxQLYjrue4Nq.NBdqI-"
) )
] ]
testParseListObjectsResult :: Assertion testParseListObjectsResult :: Assertion
testParseListObjectsResult = do testParseListObjectsResult = do
let xmldata = let
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ xmldata = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<Name>bucket</Name>\ \<Name>bucket</Name>\
\<Prefix/>\ \<Prefix/>\
\<NextContinuationToken>opaque</NextContinuationToken>\ \<NextContinuationToken>opaque</NextContinuationToken>\
\<KeyCount>1000</KeyCount>\ \<KeyCount>1000</KeyCount>\
\<MaxKeys>1000</MaxKeys>\ \<MaxKeys>1000</MaxKeys>\
\<IsTruncated>true</IsTruncated>\ \<IsTruncated>true</IsTruncated>\
\<Contents>\ \<Contents>\
\<Key>my-image.jpg</Key>\ \<Key>my-image.jpg</Key>\
\<LastModified>2009-10-12T17:50:30.000Z</LastModified>\ \<LastModified>2009-10-12T17:50:30.000Z</LastModified>\
\<ETag>&quot;fba9dede5f27731c9771645a39863328&quot;</ETag>\ \<ETag>&quot;fba9dede5f27731c9771645a39863328&quot;</ETag>\
\<Size>434234</Size>\ \<Size>434234</Size>\
\<StorageClass>STANDARD</StorageClass>\ \<StorageClass>STANDARD</StorageClass>\
\</Contents>\ \</Contents>\
\</ListBucketResult>" \</ListBucketResult>"
expectedListResult = ListObjectsResult True (Just "opaque") [object1] []
object1 = ObjectInfo "my-image.jpg" modifiedTime1 "\"fba9dede5f27731c9771645a39863328\"" 434234 H.empty H.empty
modifiedTime1 = flip UTCTime 64230 $ fromGregorian 2009 10 12
parsedListObjectsResult <- tryValidationErr $ runTestNS $ parseListObjectsResponse xmldata expectedListResult = ListObjectsResult True (Just "opaque") [object1] []
object1 = ObjectInfo "my-image.jpg" modifiedTime1 "\"fba9dede5f27731c9771645a39863328\"" 434234
modifiedTime1 = flip UTCTime 64230 $ fromGregorian 2009 10 12
parsedListObjectsResult <- tryValidationErr $ parseListObjectsResponse xmldata
eitherValidationErr parsedListObjectsResult (@?= expectedListResult) eitherValidationErr parsedListObjectsResult (@?= expectedListResult)
testParseListObjectsV1Result :: Assertion testParseListObjectsV1Result :: Assertion
testParseListObjectsV1Result = do testParseListObjectsV1Result = do
let xmldata = let
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ xmldata = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<Name>bucket</Name>\ \<Name>bucket</Name>\
\<Prefix/>\ \<Prefix/>\
\<NextMarker>my-image1.jpg</NextMarker>\ \<NextMarker>my-image1.jpg</NextMarker>\
\<KeyCount>1000</KeyCount>\ \<KeyCount>1000</KeyCount>\
\<MaxKeys>1000</MaxKeys>\ \<MaxKeys>1000</MaxKeys>\
\<IsTruncated>true</IsTruncated>\ \<IsTruncated>true</IsTruncated>\
\<Contents>\ \<Contents>\
\<Key>my-image.jpg</Key>\ \<Key>my-image.jpg</Key>\
\<LastModified>2009-10-12T17:50:30.000Z</LastModified>\ \<LastModified>2009-10-12T17:50:30.000Z</LastModified>\
\<ETag>&quot;fba9dede5f27731c9771645a39863328&quot;</ETag>\ \<ETag>&quot;fba9dede5f27731c9771645a39863328&quot;</ETag>\
\<Size>434234</Size>\ \<Size>434234</Size>\
\<StorageClass>STANDARD</StorageClass>\ \<StorageClass>STANDARD</StorageClass>\
\</Contents>\ \</Contents>\
\</ListBucketResult>" \</ListBucketResult>"
expectedListResult = ListObjectsV1Result True (Just "my-image1.jpg") [object1] []
object1 = ObjectInfo "my-image.jpg" modifiedTime1 "\"fba9dede5f27731c9771645a39863328\"" 434234 H.empty H.empty
modifiedTime1 = flip UTCTime 64230 $ fromGregorian 2009 10 12
parsedListObjectsV1Result <- tryValidationErr $ runTestNS $ parseListObjectsV1Response xmldata expectedListResult = ListObjectsV1Result True (Just "my-image1.jpg") [object1] []
object1 = ObjectInfo "my-image.jpg" modifiedTime1 "\"fba9dede5f27731c9771645a39863328\"" 434234
modifiedTime1 = flip UTCTime 64230 $ fromGregorian 2009 10 12
parsedListObjectsV1Result <- tryValidationErr $ parseListObjectsV1Response xmldata
eitherValidationErr parsedListObjectsV1Result (@?= expectedListResult) eitherValidationErr parsedListObjectsV1Result (@?= expectedListResult)
testParseListIncompleteUploads :: Assertion testParseListIncompleteUploads :: Assertion
testParseListIncompleteUploads = do testParseListIncompleteUploads = do
let xmldata = let
"<ListMultipartUploadsResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ xmldata = "<ListMultipartUploadsResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<Bucket>example-bucket</Bucket>\ \<Bucket>example-bucket</Bucket>\
\<KeyMarker/>\ \<KeyMarker/>\
\<UploadIdMarker/>\ \<UploadIdMarker/>\
\<NextKeyMarker>sample.jpg</NextKeyMarker>\ \<NextKeyMarker>sample.jpg</NextKeyMarker>\
\<NextUploadIdMarker>Xgw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1W99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--</NextUploadIdMarker>\ \<NextUploadIdMarker>Xgw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1W99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--</NextUploadIdMarker>\
\<Delimiter>/</Delimiter>\ \<Delimiter>/</Delimiter>\
\<Prefix/>\ \<Prefix/>\
\<MaxUploads>1000</MaxUploads>\ \<MaxUploads>1000</MaxUploads>\
\<IsTruncated>false</IsTruncated>\ \<IsTruncated>false</IsTruncated>\
\<Upload>\ \<Upload>\
\<Key>sample.jpg</Key>\ \<Key>sample.jpg</Key>\
\<UploadId>Agw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1N99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--</UploadId>\ \<UploadId>Agw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1N99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--</UploadId>\
\<Initiator>\ \<Initiator>\
\<ID>314133b66967d86f031c7249d1d9a80249109428335cd0ef1cdc487b4566cb1b</ID>\ \<ID>314133b66967d86f031c7249d1d9a80249109428335cd0ef1cdc487b4566cb1b</ID>\
\<DisplayName>s3-nickname</DisplayName>\ \<DisplayName>s3-nickname</DisplayName>\
\</Initiator>\ \</Initiator>\
\<Owner>\ \<Owner>\
\<ID>314133b66967d86f031c7249d1d9a80249109428335cd0ef1cdc487b4566cb1b</ID>\ \<ID>314133b66967d86f031c7249d1d9a80249109428335cd0ef1cdc487b4566cb1b</ID>\
\<DisplayName>s3-nickname</DisplayName>\ \<DisplayName>s3-nickname</DisplayName>\
\</Owner>\ \</Owner>\
\<StorageClass>STANDARD</StorageClass>\ \<StorageClass>STANDARD</StorageClass>\
\<Initiated>2010-11-26T19:24:17.000Z</Initiated>\ \<Initiated>2010-11-26T19:24:17.000Z</Initiated>\
\</Upload>\ \</Upload>\
\<CommonPrefixes>\ \<CommonPrefixes>\
\<Prefix>photos/</Prefix>\ \<Prefix>photos/</Prefix>\
\</CommonPrefixes>\ \</CommonPrefixes>\
\<CommonPrefixes>\ \<CommonPrefixes>\
\<Prefix>videos/</Prefix>\ \<Prefix>videos/</Prefix>\
\</CommonPrefixes>\ \</CommonPrefixes>\
\</ListMultipartUploadsResult>" \</ListMultipartUploadsResult>"
expectedListResult = ListUploadsResult False (Just "sample.jpg") (Just "Xgw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1W99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--") uploads prefixes expectedListResult = ListUploadsResult False (Just "sample.jpg") (Just "Xgw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1W99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--") uploads prefixes
uploads = [("sample.jpg", "Agw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1N99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--", initTime)] uploads = [("sample.jpg", "Agw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1N99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--", initTime)]
initTime = UTCTime (fromGregorian 2010 11 26) 69857 initTime = UTCTime (fromGregorian 2010 11 26) 69857
prefixes = ["photos/", "videos/"] prefixes = ["photos/", "videos/"]
parsedListUploadsResult <- tryValidationErr $ runTestNS $ parseListUploadsResponse xmldata parsedListUploadsResult <- tryValidationErr $ parseListUploadsResponse xmldata
eitherValidationErr parsedListUploadsResult (@?= expectedListResult) eitherValidationErr parsedListUploadsResult (@?= expectedListResult)
testParseCompleteMultipartUploadResponse :: Assertion testParseCompleteMultipartUploadResponse :: Assertion
testParseCompleteMultipartUploadResponse = do testParseCompleteMultipartUploadResponse = do
let xmldata = let
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ xmldata = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<CompleteMultipartUploadResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<CompleteMultipartUploadResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<Location>http://Example-Bucket.s3.amazonaws.com/Example-Object</Location>\ \<Location>http://Example-Bucket.s3.amazonaws.com/Example-Object</Location>\
\<Bucket>Example-Bucket</Bucket>\ \<Bucket>Example-Bucket</Bucket>\
\<Key>Example-Object</Key>\ \<Key>Example-Object</Key>\
\<ETag>\"3858f62230ac3c915f300c664312c11f-9\"</ETag>\ \<ETag>\"3858f62230ac3c915f300c664312c11f-9\"</ETag>\
\</CompleteMultipartUploadResult>" \</CompleteMultipartUploadResult>"
expectedETag = "\"3858f62230ac3c915f300c664312c11f-9\"" expectedETag = "\"3858f62230ac3c915f300c664312c11f-9\""
parsedETagE <- runExceptT $ runTestNS $ parseCompleteMultipartUploadResponse xmldata parsedETagE <- runExceptT $ parseCompleteMultipartUploadResponse xmldata
eitherValidationErr parsedETagE (@?= expectedETag) eitherValidationErr parsedETagE (@?= expectedETag)
testParseListPartsResponse :: Assertion testParseListPartsResponse :: Assertion
testParseListPartsResponse = do testParseListPartsResponse = do
let xmldata = let
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ xmldata = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<ListPartsResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<ListPartsResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<Bucket>example-bucket</Bucket>\ \<Bucket>example-bucket</Bucket>\
\<Key>example-object</Key>\ \<Key>example-object</Key>\
\<UploadId>XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA</UploadId>\ \<UploadId>XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA</UploadId>\
\<Initiator>\ \<Initiator>\
\<ID>arn:aws:iam::111122223333:user/some-user-11116a31-17b5-4fb7-9df5-b288870f11xx</ID>\ \<ID>arn:aws:iam::111122223333:user/some-user-11116a31-17b5-4fb7-9df5-b288870f11xx</ID>\
\<DisplayName>umat-user-11116a31-17b5-4fb7-9df5-b288870f11xx</DisplayName>\ \<DisplayName>umat-user-11116a31-17b5-4fb7-9df5-b288870f11xx</DisplayName>\
\</Initiator>\ \</Initiator>\
\<Owner>\ \<Owner>\
\<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>\ \<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>\
\<DisplayName>someName</DisplayName>\ \<DisplayName>someName</DisplayName>\
\</Owner>\ \</Owner>\
\<StorageClass>STANDARD</StorageClass>\ \<StorageClass>STANDARD</StorageClass>\
\<PartNumberMarker>1</PartNumberMarker>\ \<PartNumberMarker>1</PartNumberMarker>\
\<NextPartNumberMarker>3</NextPartNumberMarker>\ \<NextPartNumberMarker>3</NextPartNumberMarker>\
\<MaxParts>2</MaxParts>\ \<MaxParts>2</MaxParts>\
\<IsTruncated>true</IsTruncated>\ \<IsTruncated>true</IsTruncated>\
\<Part>\ \<Part>\
\<PartNumber>2</PartNumber>\ \<PartNumber>2</PartNumber>\
\<LastModified>2010-11-10T20:48:34.000Z</LastModified>\ \<LastModified>2010-11-10T20:48:34.000Z</LastModified>\
\<ETag>\"7778aef83f66abc1fa1e8477f296d394\"</ETag>\ \<ETag>\"7778aef83f66abc1fa1e8477f296d394\"</ETag>\
\<Size>10485760</Size>\ \<Size>10485760</Size>\
\</Part>\ \</Part>\
\<Part>\ \<Part>\
\<PartNumber>3</PartNumber>\ \<PartNumber>3</PartNumber>\
\<LastModified>2010-11-10T20:48:33.000Z</LastModified>\ \<LastModified>2010-11-10T20:48:33.000Z</LastModified>\
\<ETag>\"aaaa18db4cc2f85cedef654fccc4a4x8\"</ETag>\ \<ETag>\"aaaa18db4cc2f85cedef654fccc4a4x8\"</ETag>\
\<Size>10485760</Size>\ \<Size>10485760</Size>\
\</Part>\ \</Part>\
\</ListPartsResult>" \</ListPartsResult>"
expectedListResult = ListPartsResult True (Just 3) [part1, part2]
part1 = ObjectPartInfo 2 "\"7778aef83f66abc1fa1e8477f296d394\"" 10485760 modifiedTime1
modifiedTime1 = flip UTCTime 74914 $ fromGregorian 2010 11 10
part2 = ObjectPartInfo 3 "\"aaaa18db4cc2f85cedef654fccc4a4x8\"" 10485760 modifiedTime2
modifiedTime2 = flip UTCTime 74913 $ fromGregorian 2010 11 10
parsedListPartsResult <- runExceptT $ runTestNS $ parseListPartsResponse xmldata expectedListResult = ListPartsResult True (Just 3) [part1, part2]
part1 = ObjectPartInfo 2 "\"7778aef83f66abc1fa1e8477f296d394\"" 10485760 modifiedTime1
modifiedTime1 = flip UTCTime 74914 $ fromGregorian 2010 11 10
part2 = ObjectPartInfo 3 "\"aaaa18db4cc2f85cedef654fccc4a4x8\"" 10485760 modifiedTime2
modifiedTime2 = flip UTCTime 74913 $ fromGregorian 2010 11 10
parsedListPartsResult <- runExceptT $ parseListPartsResponse xmldata
eitherValidationErr parsedListPartsResult (@?= expectedListResult) eitherValidationErr parsedListPartsResult (@?= expectedListResult)
testParseCopyObjectResponse :: Assertion testParseCopyObjectResponse :: Assertion
testParseCopyObjectResponse = do testParseCopyObjectResponse = do
let cases = let
[ ( "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ cases = [ ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
\<CopyObjectResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<CopyObjectResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\<LastModified>2009-10-28T22:32:00.000Z</LastModified>\ \<LastModified>2009-10-28T22:32:00.000Z</LastModified>\
\<ETag>\"9b2cf535f27731c974343645a3985328\"</ETag>\ \<ETag>\"9b2cf535f27731c974343645a3985328\"</ETag>\
\</CopyObjectResult>", \</CopyObjectResult>",
( "\"9b2cf535f27731c974343645a3985328\"", ("\"9b2cf535f27731c974343645a3985328\"",
UTCTime (fromGregorian 2009 10 28) 81120 UTCTime (fromGregorian 2009 10 28) 81120))
) , ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\
), \<CopyPartResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
( "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\ \<LastModified>2009-10-28T22:32:00.000Z</LastModified>\
\<CopyPartResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \<ETag>\"9b2cf535f27731c974343645a3985328\"</ETag>\
\<LastModified>2009-10-28T22:32:00.000Z</LastModified>\ \</CopyPartResult>",
\<ETag>\"9b2cf535f27731c974343645a3985328\"</ETag>\ ("\"9b2cf535f27731c974343645a3985328\"",
\</CopyPartResult>", UTCTime (fromGregorian 2009 10 28) 81120))]
( "\"9b2cf535f27731c974343645a3985328\"",
UTCTime (fromGregorian 2009 10 28) 81120
)
)
]
forM_ cases $ \(xmldata, (etag, modTime)) -> do forM_ cases $ \(xmldata, (etag, modTime)) -> do
parseResult <- runExceptT $ runTestNS $ parseCopyObjectResponse xmldata parseResult <- runExceptT $ parseCopyObjectResponse xmldata
eitherValidationErr parseResult (@?= (etag, modTime)) eitherValidationErr parseResult (@?= (etag, modTime))
testParseNotification :: Assertion testParseNotification :: Assertion
testParseNotification = do testParseNotification = do
let cases = let
[ ( "<NotificationConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ cases = [ ("<NotificationConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
\ <TopicConfiguration>\ \ <TopicConfiguration>\
\ <Id>YjVkM2Y0YmUtNGI3NC00ZjQyLWEwNGItNDIyYWUxY2I0N2M4</Id>\ \ <Id>YjVkM2Y0YmUtNGI3NC00ZjQyLWEwNGItNDIyYWUxY2I0N2M4</Id>\
\ <Topic>arn:aws:sns:us-east-1:account-id:s3notificationtopic2</Topic>\ \ <Topic>arn:aws:sns:us-east-1:account-id:s3notificationtopic2</Topic>\
\ <Event>s3:ReducedRedundancyLostObject</Event>\ \ <Event>s3:ReducedRedundancyLostObject</Event>\
\ <Event>s3:ObjectCreated:*</Event>\ \ <Event>s3:ObjectCreated:*</Event>\
\ </TopicConfiguration>\ \ </TopicConfiguration>\
\</NotificationConfiguration>", \</NotificationConfiguration>",
Notification Notification []
[] [ NotificationConfig
[ NotificationConfig
"YjVkM2Y0YmUtNGI3NC00ZjQyLWEwNGItNDIyYWUxY2I0N2M4" "YjVkM2Y0YmUtNGI3NC00ZjQyLWEwNGItNDIyYWUxY2I0N2M4"
"arn:aws:sns:us-east-1:account-id:s3notificationtopic2" "arn:aws:sns:us-east-1:account-id:s3notificationtopic2"
[ReducedRedundancyLostObject, ObjectCreated] [ReducedRedundancyLostObject, ObjectCreated] def
defaultFilter ]
] [])
[] , ("<NotificationConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\
), \ <CloudFunctionConfiguration>\
( "<NotificationConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">\ \ <Id>ObjectCreatedEvents</Id>\
\ <CloudFunctionConfiguration>\ \ <CloudFunction>arn:aws:lambda:us-west-2:35667example:function:CreateThumbnail</CloudFunction>\
\ <Id>ObjectCreatedEvents</Id>\ \ <Event>s3:ObjectCreated:*</Event>\
\ <CloudFunction>arn:aws:lambda:us-west-2:35667example:function:CreateThumbnail</CloudFunction>\ \ </CloudFunctionConfiguration>\
\ <Event>s3:ObjectCreated:*</Event>\ \ <QueueConfiguration>\
\ </CloudFunctionConfiguration>\ \ <Id>1</Id>\
\ <QueueConfiguration>\ \ <Filter>\
\ <Id>1</Id>\ \ <S3Key>\
\ <Filter>\ \ <FilterRule>\
\ <S3Key>\ \ <Name>prefix</Name>\
\ <FilterRule>\ \ <Value>images/</Value>\
\ <Name>prefix</Name>\ \ </FilterRule>\
\ <Value>images/</Value>\ \ <FilterRule>\
\ </FilterRule>\ \ <Name>suffix</Name>\
\ <FilterRule>\ \ <Value>.jpg</Value>\
\ <Name>suffix</Name>\ \ </FilterRule>\
\ <Value>.jpg</Value>\ \ </S3Key>\
\ </FilterRule>\ \ </Filter>\
\ </S3Key>\ \ <Queue>arn:aws:sqs:us-west-2:444455556666:s3notificationqueue</Queue>\
\ </Filter>\ \ <Event>s3:ObjectCreated:Put</Event>\
\ <Queue>arn:aws:sqs:us-west-2:444455556666:s3notificationqueue</Queue>\ \ </QueueConfiguration>\
\ <Event>s3:ObjectCreated:Put</Event>\ \ <TopicConfiguration>\
\ </QueueConfiguration>\ \ <Topic>arn:aws:sns:us-east-1:356671443308:s3notificationtopic2</Topic>\
\ <TopicConfiguration>\ \ <Event>s3:ReducedRedundancyLostObject</Event>\
\ <Topic>arn:aws:sns:us-east-1:356671443308:s3notificationtopic2</Topic>\ \ </TopicConfiguration>\
\ <Event>s3:ReducedRedundancyLostObject</Event>\ \ <QueueConfiguration>\
\ </TopicConfiguration>\ \ <Queue>arn:aws:sqs:us-east-1:356671443308:s3notificationqueue</Queue>\
\ <QueueConfiguration>\ \ <Event>s3:ObjectCreated:*</Event>\
\ <Queue>arn:aws:sqs:us-east-1:356671443308:s3notificationqueue</Queue>\ \ </QueueConfiguration>)\
\ <Event>s3:ObjectCreated:*</Event>\ \</NotificationConfiguration>",
\ </QueueConfiguration>)\ Notification [ NotificationConfig
\</NotificationConfiguration>", "1" "arn:aws:sqs:us-west-2:444455556666:s3notificationqueue"
Notification [ObjectCreatedPut]
[ NotificationConfig (Filter $ FilterKey $ FilterRules
"1" [FilterRule "prefix" "images/",
"arn:aws:sqs:us-west-2:444455556666:s3notificationqueue" FilterRule "suffix" ".jpg"])
[ObjectCreatedPut] , NotificationConfig
( Filter $ "" "arn:aws:sqs:us-east-1:356671443308:s3notificationqueue"
FilterKey $ [ObjectCreated] def
FilterRules ]
[ FilterRule "prefix" "images/", [ NotificationConfig
FilterRule "suffix" ".jpg" "" "arn:aws:sns:us-east-1:356671443308:s3notificationtopic2"
] [ReducedRedundancyLostObject] def
), ]
NotificationConfig [ NotificationConfig
"" "ObjectCreatedEvents" "arn:aws:lambda:us-west-2:35667example:function:CreateThumbnail"
"arn:aws:sqs:us-east-1:356671443308:s3notificationqueue" [ObjectCreated] def
[ObjectCreated] ])
defaultFilter ]
]
[ NotificationConfig
""
"arn:aws:sns:us-east-1:356671443308:s3notificationtopic2"
[ReducedRedundancyLostObject]
defaultFilter
]
[ NotificationConfig
"ObjectCreatedEvents"
"arn:aws:lambda:us-west-2:35667example:function:CreateThumbnail"
[ObjectCreated]
defaultFilter
]
)
]
forM_ cases $ \(xmldata, val) -> do forM_ cases $ \(xmldata, val) -> do
result <- runExceptT $ runTestNS $ parseNotification xmldata result <- runExceptT $ parseNotification xmldata
eitherValidationErr result (@?= val) eitherValidationErr result (@?= val)
-- | Tests parsing of both progress and stats
testParseSelectProgress :: Assertion
testParseSelectProgress = do
let cases =
[ ( [r|<?xml version="1.0" encoding="UTF-8"?>
<Progress>
<BytesScanned>512</BytesScanned>
<BytesProcessed>1024</BytesProcessed>
<BytesReturned>1024</BytesReturned>
</Progress>|],
Progress 512 1024 1024
),
( [r|<?xml version="1.0" encoding="UTF-8"?>
<Stats>
<BytesScanned>512</BytesScanned>
<BytesProcessed>1024</BytesProcessed>
<BytesReturned>1024</BytesReturned>
</Stats>|],
Progress 512 1024 1024
)
]
forM_ cases $ \(xmldata, progress) -> do
result <- runExceptT $ parseSelectProgress xmldata
eitherValidationErr result (@?= progress)

View File

@ -1,5 +1,5 @@
-- --
-- MinIO Haskell SDK, (C) 2017-2023 MinIO, Inc. -- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -14,17 +14,18 @@
-- limitations under the License. -- limitations under the License.
-- --
import qualified Data.ByteString as B import Test.Tasty
import Test.Tasty.QuickCheck as QC
import qualified Data.List as L import qualified Data.List as L
import Lib.Prelude
import Network.Minio.API.Test import Lib.Prelude
import Network.Minio.CopyObject
import Network.Minio.Data import Network.Minio.API.Test
import Network.Minio.Utils.Test import Network.Minio.PutObject
import Network.Minio.XmlGenerator.Test import Network.Minio.Utils.Test
import Network.Minio.XmlParser.Test import Network.Minio.XmlGenerator.Test
import Test.Tasty import Network.Minio.XmlParser.Test
import Test.Tasty.QuickCheck as QC
main :: IO () main :: IO ()
main = defaultMain tests main = defaultMain tests
@ -47,87 +48,71 @@ properties = testGroup "Properties" [qcProps] -- [scProps]
-- ] -- ]
qcProps :: TestTree qcProps :: TestTree
qcProps = qcProps = testGroup "(checked by QuickCheck)"
testGroup [ QC.testProperty "selectPartSizes:" $
"(checked by QuickCheck)" \n -> let (pns, offs, sizes) = L.unzip3 (selectPartSizes n)
[ QC.testProperty "selectPartSizes:" $
\n ->
let (pns, offs, sizes) = L.unzip3 (selectPartSizes n)
-- check that pns increments from 1. -- check that pns increments from 1.
isPNumsAscendingFrom1 = all (uncurry (==)) $ zip pns [1 ..] isPNumsAscendingFrom1 = all (\(a, b) -> a == b) $ zip pns [1..]
consPairs [] = [] consPairs [] = []
consPairs [_] = [] consPairs [_] = []
consPairs (a : (b : c)) = (a, b) : consPairs (b : c) consPairs (a:(b:c)) = (a, b):(consPairs (b:c))
-- check `offs` is monotonically increasing. -- check `offs` is monotonically increasing.
isOffsetsAsc = all (uncurry (<)) $ consPairs offs isOffsetsAsc = all (\(a, b) -> a < b) $ consPairs offs
-- check sizes sums to n. -- check sizes sums to n.
isSumSizeOk = sum sizes == n isSumSizeOk = sum sizes == n
-- check sizes are constant except last -- check sizes are constant except last
isSizesConstantExceptLast = isSizesConstantExceptLast =
all (uncurry (==)) (consPairs $ L.init sizes) all (\(a, b) -> a == b) (consPairs $ L.init sizes)
-- check each part except last is at least minPartSize; -- check each part except last is at least minPartSize;
-- last part may be 0 only if it is the only part. -- last part may be 0 only if it is the only part.
nparts = length sizes nparts = length sizes
isMinPartSizeOk = isMinPartSizeOk =
if if | nparts > 1 -> -- last part can be smaller but > 0
| nparts > 1 -> -- last part can be smaller but > 0 all (>= minPartSize) (take (nparts - 1) sizes) &&
all (>= minPartSize) (take (nparts - 1) sizes) all (\s -> s > 0) (drop (nparts - 1) sizes)
&& all (> 0) (drop (nparts - 1) sizes) | nparts == 1 -> -- size may be 0 here.
| nparts == 1 -> -- size may be 0 here. maybe True (\x -> x >= 0 && x <= minPartSize) $
maybe True (\x -> x >= 0 && x <= minPartSize) $ headMay sizes
listToMaybe sizes | otherwise -> False
| otherwise -> False
in n < 0 in n < 0 ||
|| ( isPNumsAscendingFrom1 (isPNumsAscendingFrom1 && isOffsetsAsc && isSumSizeOk &&
&& isOffsetsAsc isSizesConstantExceptLast && isMinPartSizeOk)
&& isSumSizeOk
&& isSizesConstantExceptLast , QC.testProperty "selectCopyRanges:" $
&& isMinPartSizeOk \(start, end) ->
), let (_, pairs) = L.unzip (selectCopyRanges (start, end))
QC.testProperty "selectCopyRanges:" $
\(start, end) -> -- is last part's snd offset end?
let (_, pairs) = L.unzip (selectCopyRanges (start, end)) isLastPartOk = maybe False ((end ==) . snd) $ lastMay pairs
-- is last part's snd offset end? -- is first part's fst offset start
isLastPartOk = maybe False ((end ==) . snd) $ lastMay pairs isFirstPartOk = maybe False ((start ==) . fst) $ headMay pairs
-- is first part's fst offset start
isFirstPartOk = maybe False ((start ==) . fst) $ listToMaybe pairs -- each pair is >=64MiB except last, and all those parts
-- each pair is >=64MiB except last, and all those parts -- have same size.
-- have same size. initSizes = maybe [] (map (\(a, b) -> b - a + 1)) $ initMay pairs
initSizes = maybe [] (map (\(a, b) -> b - a + 1) . init) (nonEmpty pairs) isPartSizesOk = all (>= minPartSize) initSizes &&
isPartSizesOk = maybe True (\k -> all (== k) initSizes)
all (>= minPartSize) initSizes (headMay initSizes)
&& maybe
True -- returned offsets are contiguous.
(\k -> all (== k) initSizes) fsts = drop 1 $ map fst pairs
(listToMaybe initSizes) snds = take (length pairs - 1) $ map snd pairs
-- returned offsets are contiguous. isContParts = length fsts == length snds &&
fsts = drop 1 $ map fst pairs and (map (\(a, b) -> a == b + 1) $ zip fsts snds)
snds = take (length pairs - 1) $ map snd pairs
isContParts = in start < 0 || start > end ||
length fsts == length snds (isLastPartOk && isFirstPartOk && isPartSizesOk && isContParts)
&& all (\(a, b) -> a == b + 1) (zip fsts snds) ]
in start < 0
|| start > end
|| (isLastPartOk && isFirstPartOk && isPartSizesOk && isContParts),
QC.testProperty "mkSSECKey:" $
\w8s ->
let bs = B.pack w8s
r = mkSSECKey bs
in case r of
Just _ -> B.length bs == 32
Nothing -> B.length bs /= 32
]
unitTests :: TestTree unitTests :: TestTree
unitTests = unitTests = testGroup "Unit tests" [xmlGeneratorTests, xmlParserTests,
testGroup bucketNameValidityTests,
"Unit tests" objectNameValidityTests,
[ xmlGeneratorTests, limitedMapConcurrentlyTests]
xmlParserTests,
bucketNameValidityTests,
objectNameValidityTests,
parseServerInfoJSONTest,
parseHealStatusTest,
parseHealStartRespTest,
limitedMapConcurrentlyTests
]

View File

@ -1,28 +0,0 @@
-----BEGIN PRIVATE KEY-----
MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQC3G9IiC+adjf0p
i/2KYc+4dizeuzUFN7wraSdhiOMdQgCnu9Dc3t2YEsQhNdrARjOTyXd36KeM3TwI
rPJ61dRGQSuN12l+mzngFJQjE0sysZHUJOLQC3rVvIrHSQ57utPg8ifxt/SunlPY
fhcUcq03onMGq44yOfE6mIhoe0Y9wcPQ3RjjNNS44bgmXiXwa+Do0h2hEn6/essq
5KjHL8WW2vGg7G9edpYdxINA/A2fdLtr8BwPNrZhOx84eee2XcUNdBuTtUUxE+0L
9yRqItqddriRxJFwOXb5OPW8xx2WGaV2a0wbE4gB2PTwwDvfo72mo9HXHZUHM1A8
4TD/RXMbAgMBAAECggEBAJ7r1oUWLyGvinn0tijUm6RNbMQjVvEgXoCO008jr3pF
PqxVpgEMrOa/4tmwFBus0jcCNF4t3r2zhddBw3I5A/O1vEdvHnBz6NdDBQ8sP6fP
1fF50iEe1Y2MBibQkXFxxVMG2QRB1Gt5nuvXA9ELdqtCovK3EsMk5ukkWb/UvjH5
8hcmQsaSqvzFEF4wJSY2mkeGSGIJTphPhhuA22xbhaBMInQyhZu8EHsn0h6s/Wgy
C4Cp2+4qZTKaaf6x3/ZjJ8CuKiSX+ZsJKjOEv8sqx7j/Y7QFOmJPewInKDhwazr/
xIK+N0KXPbUzeSEz6ZvExNDTxtR5ZlQP2UrRDg28yQECgYEA4Is1O2BvKVzNFOkj
bTVz25a/bb0Xrcfgi0Y9rdfLzlNdItFjAkxLTVRSW2Hv9ICl0RDDAG+wTlktXRdh
rfvDjwG2CvLQo1VEdMWTTkKVg03SwMEy2hFiWV69lENFGSaY8Y6unZDbia5HQinA
EgSS4sCojS+a2jtzG5FVVHJDKlkCgYEA0MKhMhD4SUhr2y1idPBrmLxuW5mVozuW
8bYaBeSzmfS0BRsN4fP9JGODPBPDdNbfGfGC9ezWLgD/lmCgjIEyBOq8EmqWSsiS
Kihds1+Z7hXtbzGsFGAFJJTIh7blBCsK5QFuyuih2UG0fL9z6K/dy+UUJkzrYqph
vSfKixyM8pMCgYEAmUPLsNyw4325aeV8TeWnUCJERaZFDFQa21W1cfyS2yEhuEtN
llr3JzBACqn9vFk3VU1onNqfb8sE4L696KCpKeqUFEMK0AG6eS4Gzus53Gb5TKJS
kHA/PhshsZp9Bp7G1FJ8s4YVo5N2hh2zQVkn3Wh9Y+kzfHQJrK51nO9lEvkCgYBi
BuKWle1gzAcJdnhDHRoJMIJJtQbVDYhFnBMALXJAmu1lcFzGe0GlMq1PKqCfXr6I
eiXawQmZtJJP1LPPBmOsd2U06KQGHcS00xucvQmVCOrjSdnZ/3SqxsqbH8DOgj+t
ZUzXLwHA+N99rJEK9Hob4kfh7ECjpgobPnIXfKKazQKBgQChAuiXHtf/Qq18hY3u
x48zFWjGgfd6GpOBZYkXOwGdCJgnYjZbE26LZEnYbwPh8ZUA2vp7mgHRJkD5e3Fj
ERuJLCw86WqyYZmLEuBciYGjCZqR5nbavfwsziWD00jeNruds2ZwKxRfFm4V7o2S
WLd/RUatd2Uu9f3B2J78OUdnxg==
-----END PRIVATE KEY-----

View File

@ -1,19 +0,0 @@
-----BEGIN CERTIFICATE-----
MIIDCzCCAfOgAwIBAgIUaIUOMI78LCu+r1zl0mmFHK8n5/AwDQYJKoZIhvcNAQEL
BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MCAXDTE5MTAyNDE5NTMxOVoYDzIxMTkw
OTMwMTk1MzE5WjAUMRIwEAYDVQQDDAlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEB
AQUAA4IBDwAwggEKAoIBAQC3G9IiC+adjf0pi/2KYc+4dizeuzUFN7wraSdhiOMd
QgCnu9Dc3t2YEsQhNdrARjOTyXd36KeM3TwIrPJ61dRGQSuN12l+mzngFJQjE0sy
sZHUJOLQC3rVvIrHSQ57utPg8ifxt/SunlPYfhcUcq03onMGq44yOfE6mIhoe0Y9
wcPQ3RjjNNS44bgmXiXwa+Do0h2hEn6/essq5KjHL8WW2vGg7G9edpYdxINA/A2f
dLtr8BwPNrZhOx84eee2XcUNdBuTtUUxE+0L9yRqItqddriRxJFwOXb5OPW8xx2W
GaV2a0wbE4gB2PTwwDvfo72mo9HXHZUHM1A84TD/RXMbAgMBAAGjUzBRMB0GA1Ud
DgQWBBSEWXQ2JRD+OK7/KTmlD+OW16pGmzAfBgNVHSMEGDAWgBSEWXQ2JRD+OK7/
KTmlD+OW16pGmzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQCF
0zYRaabB3X0jzGI9/Lr3Phrb90GvoL1DFLRuiOuTlDkz0vrm/HrZskwHCgMNrkCj
OTD9Vpas4D1QZBbQbRzfnf3OOoG4bgmcCwLFZl3dy27yIDAhrmbUP++g9l1Jmy4v
vBR/M4lt2scQ8LcZYEPqhEaE5EzFQEjtaxDcKdWDNKY9W1NUzSIABhF9eHiAUNdH
AFNJlYeBlCHxcWIeqgon184Dqp/CsvKtz3z3Ni+rlwPM/zuJCFHh1VF+z++0LJjG
roBCV0Tro4XyiEz9yp7Cb5kQYMaj1KL9TqBG0tZx0pmv7y+lXc4TT6DEllXz6USy
rbIba9/uUet3BqeIMTqj
-----END CERTIFICATE-----