Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 7
 CRAP
0.00% covered (danger)
0.00%
0 / 1
FilesystemAwareTrait
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 7
 306
0.00% covered (danger)
0.00%
0 / 1
 getFileSystemService
n/a
0 / 0
n/a
0 / 0
 0
 saveFileToStorage
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 1
 56
 saveStreamToStorage
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 2
 saveStringToStorage
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 2
 getQueueStorage
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
 2
 deleteQueueStorageFile
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
 12
 isFileStoredInQueueStorage
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 6
 getQueueStorageFile
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
 6
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2017 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19 *
20 */
21
22namespace oat\tao\model\taskQueue\Task;
23
24use oat\oatbox\filesystem\Directory;
25use oat\oatbox\filesystem\File;
26use oat\oatbox\filesystem\FileSystemService;
27use oat\tao\model\taskQueue\QueueDispatcherInterface;
28use oat\tao\model\taskQueue\TaskLog\Entity\EntityInterface;
29
30/**
31 * Filesystem related functionalities in a task
32 *
33 * @author Gyula Szucs <gyula@taotesting.com>
34 */
35trait FilesystemAwareTrait
36{
37    /**
38     * @return FileSystemService
39     */
40    abstract protected function getFileSystemService();
41
42    /**
43     * Copies a locally stored file under filesystem of task queue storage for later use like:
44     * - user downloading an export file
45     * - saving a file for importing it later
46     *
47     * @param string|array $localFilePath The file path or an array containing 'path' key
48     * @param string|null $newFileName New name of the file under task queue filesystem
49     * @return string File name (prefix) of the filesystem file
50     * @throws \common_Exception
51     */
52    protected function saveFileToStorage($localFilePath, $newFileName = null)
53    {
54        if (is_array($localFilePath) && isset($localFilePath['path'])) {
55            $localFilePath = $localFilePath['path'];
56        }
57
58        if (!is_string($localFilePath) || !file_exists($localFilePath)) {
59            return '';
60        }
61
62        if (null === $newFileName) {
63            $newFileName = basename($localFilePath);
64        }
65
66        // saving the file under the storage
67        $file = $this->getQueueStorage()->getFile($newFileName);
68        $stream = fopen($localFilePath, 'r');
69        $file->put($stream);
70        if (is_resource($stream)) {
71            fclose($stream);
72        }
73
74        // delete the local file
75        @unlink($localFilePath);
76
77        return $newFileName;
78    }
79
80    /**
81     * @param $stream
82     * @param $fileName
83     * @return mixed
84     * @throws \common_Exception
85     */
86    protected function saveStreamToStorage($stream, $fileName)
87    {
88        $file = $this->getQueueStorage()->getFile($fileName);
89        $file->put($stream);
90        return $fileName;
91    }
92
93    /**
94     * Writes arbitrary string data into a filesystem file under task queue storage.
95     *
96     * @param string $string
97     * @param string $fileName
98     * @return string
99     *
100     * @throws \common_Exception
101     */
102    protected function saveStringToStorage($string, $fileName)
103    {
104        $file = $this->getQueueStorage()->getFile($fileName);
105
106        $file->write((string) $string);
107
108        return $file->getPrefix();
109    }
110
111    /**
112     * @return  Directory
113     */
114    protected function getQueueStorage()
115    {
116        return $this->getFileSystemService()
117            ->getDirectory(QueueDispatcherInterface::FILE_SYSTEM_ID);
118    }
119
120    /**
121     * Deletes a filesystem file stored under task queue storage
122     *
123     * @param EntityInterface $taskLogEntity
124     * @return bool
125     */
126    protected function deleteQueueStorageFile(EntityInterface $taskLogEntity)
127    {
128        if ($filename = $taskLogEntity->getFileNameFromReport()) {
129            $file = $this->getQueueStorage()
130                ->getFile($filename);
131
132            if ($file->exists()) {
133                $file->delete();
134            }
135        }
136
137        return false;
138    }
139
140    /**
141     * Checks if the file exist in task queue storage.
142     *
143     * @param string $fileName
144     * @return bool
145     */
146    protected function isFileStoredInQueueStorage($fileName)
147    {
148        if ($this->getQueueStorage()->getFile($fileName)->exists()) {
149            return true;
150        }
151
152        return false;
153    }
154
155    /**
156     * Tries to get the file if it exists.
157     *
158     * @param string $fileName
159     * @return null|File
160     */
161    protected function getQueueStorageFile($fileName)
162    {
163        $file = $this->getQueueStorage()->getFile($fileName);
164
165        if ($file->exists()) {
166            return $file;
167        }
168
169        return null;
170    }
171}