Passed
Push — develop ( d0a329...633762 )
by nguereza
09:02
created

FileSystem::__construct()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 20
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 11
nc 3
nop 2
dl 0
loc 20
rs 9.9
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Platine Upload
5
 *
6
 * Platine Upload provides a flexible file uploads with extensible
7
 * validation and storage strategies.
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Upload
12
 * Copyright (c) 2014 Adrian Miu
13
 *
14
 * Permission is hereby granted, free of charge, to any person obtaining a copy
15
 * of this software and associated documentation files (the "Software"), to deal
16
 * in the Software without restriction, including without limitation the rights
17
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18
 * copies of the Software, and to permit persons to whom the Software is
19
 * furnished to do so, subject to the following conditions:
20
 *
21
 * The above copyright notice and this permission notice shall be included in all
22
 * copies or substantial portions of the Software.
23
 *
24
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30
 * SOFTWARE.
31
 */
32
33
/**
34
 *  @file FileSystem.php
35
 *
36
 *  The Upload File system storage class
37
 *
38
 *  @package    Platine\Upload\Storage
39
 *  @author Platine Developers Team
40
 *  @copyright  Copyright (c) 2020
41
 *  @license    http://opensource.org/licenses/MIT  MIT License
42
 *  @link   http://www.iacademy.cf
43
 *  @version 1.0.0
44
 *  @filesource
45
 */
46
47
declare(strict_types=1);
48
49
namespace Platine\Upload\Storage;
50
51
use InvalidArgumentException;
52
use Platine\Upload\Exception\StorageException;
53
use Platine\Upload\Exception\UploadException;
54
use Platine\Upload\File\File;
55
use Platine\Upload\File\UploadFileInfo;
56
57
/**
58
 * Class FileSystem
59
 * @package Platine\Upload\Storage
60
 */
61
class FileSystem implements StorageInterface
62
{
63
64
    /**
65
     * Path to move uploaded files
66
     * @var string
67
     */
68
    protected string $path;
69
70
    /**
71
     * Whether to overwrite existing file
72
     * @var bool
73
     */
74
    protected bool $overwrite = false;
75
76
    /**
77
     * Create new instance
78
     * @param string $path
79
     * @param bool $overwrite
80
     */
81
    public function __construct(string $path, bool $overwrite)
82
    {
83
        $this->overwrite = $overwrite;
84
        $directory = $this->normalizePath($path);
85
86
        if (!is_dir($directory)) {
87
            throw new InvalidArgumentException(sprintf(
88
                'Directory [%s] does not exist',
89
                $directory
90
            ));
91
        }
92
93
        if (!is_writable($directory)) {
94
            throw new InvalidArgumentException(sprintf(
95
                'Directory [%s] is not writable',
96
                $directory
97
            ));
98
        }
99
100
        $this->path = $directory;
101
    }
102
103
    /**
104
     * {@inheritdoc}
105
     */
106
    public function upload(File $file): UploadFileInfo
107
    {
108
        $destinationFile = $this->path . $file->getFullName();
109
        if (!$this->overwrite && file_exists($destinationFile)) {
110
            throw new StorageException(sprintf(
111
                'File [%s] already exists',
112
                $destinationFile
113
            ));
114
        }
115
116
        $uploaded = $this->moveUploadedFile($file->getPathname(), $destinationFile);
117
        if ($uploaded) {
118
            return new UploadFileInfo(
119
                $destinationFile,
120
                $file->getMimeType(),
121
                $file->getError(),
122
                $file->getSize()
123
            );
124
        }
125
126
        throw new UploadException(sprintf(
127
            'Error occured when move uploaded file [%s] to [%s]',
128
            $file->getPathname(),
129
            $destinationFile
130
        ));
131
    }
132
133
    /**
134
     * Move the uploaded file to final destination
135
     * @param string $source
136
     * @param string $destination
137
     * @return bool
138
     */
139
    protected function moveUploadedFile(string $source, string $destination): bool
140
    {
141
        return copy($source, $destination);
142
    }
143
144
    /**
145
     * Normalize the directory path
146
     * @param string $path
147
     * @return string
148
     */
149
    protected function normalizePath(string $path): string
150
    {
151
        $directory = rtrim($path, '\\/');
152
153
        return realpath($directory) . DIRECTORY_SEPARATOR;
154
    }
155
}
156