AmazonS3v3::createCollector() - Code Metrics - sebastianfeldmann/phpbu - Measure and Improve Code Quality continuously with Scrutinizer

AmazonS3v3::createCollector() A
last analyzed 2020-10-24 14:04 UTC

↳ Parent: AmazonS3v3

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
namespace phpbu\App\Backup\Sync;

use Aws\S3\MultipartUploader;
use Aws\S3\S3Client;
use phpbu\App\Backup\Collector;
use phpbu\App\Backup\Path;
use phpbu\App\Backup\Target;
use phpbu\App\Result;

/**
 * Amazon S3 Sync
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <[email protected]>
 * @copyright  Sebastian Feldmann <[email protected]>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 3.0.0
 */
class AmazonS3v3 extends AmazonS3
{
    use Cleanable;


    /**
     * Amazon S3 client.
     *
     * @var S3Client;
     */
    protected $client;

    /**
     * Configure the sync.
     *
     * @see    \phpbu\App\Backup\Sync::setup()
     * @param  array $config
     * @throws \phpbu\App\Backup\Sync\Exception
     * @throws \phpbu\App\Exception
     */
    public function setup(array $config)
    {
        parent::setup($config);

        $this->setUpCleanable($config);
    }

    /**
     * Execute the sync.
     *
     * @see    \phpbu\App\Backup\Sync::sync()
     * @param  \phpbu\App\Backup\Target $target
     * @param  \phpbu\App\Result        $result
     * @throws \phpbu\App\Backup\Sync\Exception
     */
    public function sync(Target $target, Result $result)
    {
        $this->client = $this->createClient();

        if (!$this->client->doesBucketExist($this->bucket)) {
            $result->debug('create s3 bucket');
            $this->createBucket($this->client);
        }

        try {
            $this->upload($target, $this->client);
            $result->debug('upload: done');

            // run remote cleanup
            $this->cleanup($target, $result);
        } catch (\Exception $e) {
            throw new Exception($e->getMessage(), null, $e);
        }
    }

    /**
     * Create the AWS client.
     *
     * @return \Aws\S3\S3Client
     */
    protected function createClient() : S3Client
    {
        return new S3Client([
            'region'      => $this->region,
            'version'     => '2006-03-01',
            'credentials' => [
                'key'    => $this->key,
                'secret' => $this->secret,
            ]
        ]);
    }

    /**
     * Create a multi part s3 file uploader.
     *
     * @param  \phpbu\App\Backup\Target $target
     * @param  \Aws\S3\S3Client         $s3
     * @return \Aws\S3\MultipartUploader
     */
    protected function createUploader(Target $target, S3Client $s3) : MultipartUploader
    {
        return new MultipartUploader($s3, $target->getPathname(), [
            'bucket' => $this->bucket,
            'key'    => $this->getUploadPath($target),
        ]);
    }

    /**
     * Creates collector for Amazon S3
     *
     * @param  \phpbu\App\Backup\Target $target
     * @return \phpbu\App\Backup\Collector
     */
    protected function createCollector(Target $target) : Collector
    {
        $path = new Path($this->pathRaw, $this->time);
        return new Collector\AmazonS3v3($target, $path, $this->client, $this->bucket);
    }

    /**
     * Simulate the sync execution.
     *
     * @param \phpbu\App\Backup\Target $target
     * @param \phpbu\App\Result        $result
     */
    public function simulate(Target $target, Result $result)
    {
        parent::simulate($target, $result);

        $this->simulateRemoteCleanup($target, $result);
    }

    /**
     * Create a s3 bucket.
     *
     * @param \Aws\S3\S3Client $s3
     */
    private function createBucket(S3Client $s3)
    {
        $s3->createBucket([
            'ACL'                       => $this->acl,
            'Bucket'                    => $this->bucket,
            'CreateBucketConfiguration' => [
                'LocationConstraint' => $this->region,
            ]
        ]);
    }

    /**
     * Upload backup to Amazon S3 bucket.
     *
     * @param  \phpbu\App\Backup\Target $target
     * @param  \Aws\S3\S3Client         $s3
     * @throws \phpbu\App\Backup\Sync\Exception
     * @throws \phpbu\App\Exception
     */
    private function upload(Target $target, S3Client $s3)
    {
        if ($this->useMultiPartUpload($target)) {
            $this->uploadMultiPart($target, $s3);
        } else {
            $this->uploadStream($target, $s3);
        }
    }

    /**
     * Upload via stream wrapper.
     *
     * @param  \phpbu\App\Backup\Target $target
     * @param  \Aws\S3\S3Client         $s3
     * @throws \phpbu\App\Backup\Sync\Exception
     */
    private function uploadStream(Target $target, S3Client $s3)
    {
        $s3->registerStreamWrapper();
        $source = $this->getFileHandle($target->getPathname(), 'r');
        $stream = $this->getFileHandle('s3://' . $this->bucket . '/' . $this->getUploadPath($target), 'w');
        while (!feof($source)) {
            fwrite($stream, fread($source, 4096));
        }
        fclose($stream);
    }

    /**
     * Upload via multi part.
     *
     * @param \phpbu\App\Backup\Target $target
     * @param \Aws\S3\S3Client         $s3
     * @throws \Aws\Exception\MultipartUploadException
     */
    private function uploadMultiPart(Target $target, S3Client $s3)
    {
        $uploader = $this->createUploader($target, $s3);
        $uploader->upload();
    }

    /**
     * Open stream and validate it.
     *
     * @param  string $path
     * @param  string $mode
     * @return resource
     * @throws \phpbu\App\Backup\Sync\Exception
     */
    private function getFileHandle($path, $mode)
    {
        $handle = fopen($path, $mode);
        if (!is_resource($handle)) {
            throw new Exception('fopen failed: could not open stream ' . $path);
        }
        return $handle;
    }

    /**
     * Get the s3 upload path
     *
     * @param  \phpbu\App\Backup\Target $target
     * @return string
     */
    public function getUploadPath(Target $target)
    {
        return (!empty($this->path) ? $this->path . '/' : '') . $target->getFilename();
    }
}


1		<?php
2		namespace phpbu\App\Backup\Sync;
3
4		use Aws\S3\MultipartUploader;
5		use Aws\S3\S3Client;
6		use phpbu\App\Backup\Collector;
7		use phpbu\App\Backup\Path;
8		use phpbu\App\Backup\Target;
9		use phpbu\App\Result;
10
11		/**
12		* Amazon S3 Sync
13		*
14		* @package phpbu
15		* @subpackage Backup
16		* @author Sebastian Feldmann <[email protected]>
17		* @copyright Sebastian Feldmann <[email protected]>
18		* @license https://opensource.org/licenses/MIT The MIT License (MIT)
19		* @link http://phpbu.de/
20		* @since Class available since Release 3.0.0
21		*/
22		class AmazonS3v3 extends AmazonS3
23		{
24		use Cleanable;
		0 ignored issues – show introduced 2019-11-14 22:38 UTC by Report Bug Copy Issue Report The trait `phpbu\App\Backup\Sync\Cleanable` requires some properties which are not provided by `phpbu\App\Backup\Sync\AmazonS3v3`: `$type`, `$options` Loading history...
25
26		/**
27		* Amazon S3 client.
28		*
29		* @var S3Client;
30		*/
31		protected $client;
32
33		/**
34		* Configure the sync.
35		*
36		* @see \phpbu\App\Backup\Sync::setup()
37		* @param array $config
38		* @throws \phpbu\App\Backup\Sync\Exception
39		* @throws \phpbu\App\Exception
40		*/
41	12	public function setup(array $config)
42		{
43	12	parent::setup($config);
44
45	7	$this->setUpCleanable($config);
46	7	}
47
48		/**
49		* Execute the sync.
50		*
51		* @see \phpbu\App\Backup\Sync::sync()
52		* @param \phpbu\App\Backup\Target $target
53		* @param \phpbu\App\Result $result
54		* @throws \phpbu\App\Backup\Sync\Exception
55		*/
56	3	public function sync(Target $target, Result $result)
57		{
58	3	$this->client = $this->createClient();
59
60	3	if (!$this->client->doesBucketExist($this->bucket)) {
61	2	$result->debug('create s3 bucket');
62	2	$this->createBucket($this->client);
63		}
64
65		try {
66	3	$this->upload($target, $this->client);
67	2	$result->debug('upload: done');
68
69		// run remote cleanup
70	2	$this->cleanup($target, $result);
71	1	} catch (\Exception $e) {
72	1	throw new Exception($e->getMessage(), null, $e);
73		}
74	2	}
75
76		/**
77		* Create the AWS client.
78		*
79		* @return \Aws\S3\S3Client
80		*/
81		protected function createClient() : S3Client
82		{
83		return new S3Client([
84		'region' => $this->region,
85		'version' => '2006-03-01',
86		'credentials' => [
87		'key' => $this->key,
88		'secret' => $this->secret,
89		]
90		]);
91		}
92
93		/**
94		* Create a multi part s3 file uploader.
95		*
96		* @param \phpbu\App\Backup\Target $target
97		* @param \Aws\S3\S3Client $s3
98		* @return \Aws\S3\MultipartUploader
99		*/
100		protected function createUploader(Target $target, S3Client $s3) : MultipartUploader
101		{
102		return new MultipartUploader($s3, $target->getPathname(), [
103		'bucket' => $this->bucket,
104		'key' => $this->getUploadPath($target),
105		]);
106		}
107
108		/**
109		* Creates collector for Amazon S3
110		*
111		* @param \phpbu\App\Backup\Target $target
112		* @return \phpbu\App\Backup\Collector
113		*/
114	1	protected function createCollector(Target $target) : Collector
115		{
116	1	$path = new Path($this->pathRaw, $this->time);
117	1	return new Collector\AmazonS3v3($target, $path, $this->client, $this->bucket);
118		}
119
120		/**
121		* Simulate the sync execution.
122		*
123		* @param \phpbu\App\Backup\Target $target
124		* @param \phpbu\App\Result $result
125		*/
126	1	public function simulate(Target $target, Result $result)
127		{
128	1	parent::simulate($target, $result);
129
130	1	$this->simulateRemoteCleanup($target, $result);
131	1	}
132
133		/**
134		* Create a s3 bucket.
135		*
136		* @param \Aws\S3\S3Client $s3
137		*/
138	2	private function createBucket(S3Client $s3)
139		{
140	2	$s3->createBucket([
141	2	'ACL' => $this->acl,
142	2	'Bucket' => $this->bucket,
143		'CreateBucketConfiguration' => [
144	2	'LocationConstraint' => $this->region,
145		]
146		]);
147	2	}
148
149		/**
150		* Upload backup to Amazon S3 bucket.
151		*
152		* @param \phpbu\App\Backup\Target $target
153		* @param \Aws\S3\S3Client $s3
154		* @throws \phpbu\App\Backup\Sync\Exception
155		* @throws \phpbu\App\Exception
156		*/
157	3	private function upload(Target $target, S3Client $s3)
158		{
159	3	if ($this->useMultiPartUpload($target)) {
160	3	$this->uploadMultiPart($target, $s3);
161		} else {
162		$this->uploadStream($target, $s3);
163		}
164	2	}
165
166		/**
167		* Upload via stream wrapper.
168		*
169		* @param \phpbu\App\Backup\Target $target
170		* @param \Aws\S3\S3Client $s3
171		* @throws \phpbu\App\Backup\Sync\Exception
172		*/
173		private function uploadStream(Target $target, S3Client $s3)
174		{
175		$s3->registerStreamWrapper();
176		$source = $this->getFileHandle($target->getPathname(), 'r');
177		$stream = $this->getFileHandle('s3://' . $this->bucket . '/' . $this->getUploadPath($target), 'w');
178		while (!feof($source)) {
179		fwrite($stream, fread($source, 4096));
180		}
181		fclose($stream);
182		}
183
184		/**
185		* Upload via multi part.
186		*
187		* @param \phpbu\App\Backup\Target $target
188		* @param \Aws\S3\S3Client $s3
189		* @throws \Aws\Exception\MultipartUploadException
190		*/
191	3	private function uploadMultiPart(Target $target, S3Client $s3)
192		{
193	3	$uploader = $this->createUploader($target, $s3);
194	3	$uploader->upload();
195	2	}
196
197		/**
198		* Open stream and validate it.
199		*
200		* @param string $path
201		* @param string $mode
202		* @return resource
203		* @throws \phpbu\App\Backup\Sync\Exception
204		*/
205		private function getFileHandle($path, $mode)
206		{
207		$handle = fopen($path, $mode);
208		if (!is_resource($handle)) {
209		throw new Exception('fopen failed: could not open stream ' . $path);
210		}
211		return $handle;
212		}
213
214		/**
215		* Get the s3 upload path
216		*
217		* @param \phpbu\App\Backup\Target $target
218		* @return string
219		*/
220	2	public function getUploadPath(Target $target)
221		{
222	2	return (!empty($this->path) ? $this->path . '/' : '') . $target->getFilename();
223		}
224		}
225

sebastianfeldmann / phpbu

AmazonS3v3::createCollector() A last analyzed 2020-10-24 14:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AmazonS3v3::createCollector() A
last analyzed 2020-10-24 14:04 UTC