File size: 10,387 Bytes
e4f4821 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
<?php
namespace Kanboard\Model;
use Exception;
use Kanboard\Core\Base;
use Kanboard\Core\Thumbnail;
use Kanboard\Core\ObjectStorage\ObjectStorageException;
/**
* Base File Model
*
* @package Kanboard\Model
* @author Frederic Guillot
*/
abstract class FileModel extends Base
{
/**
* Get the table
*
* @abstract
* @access protected
* @return string
*/
abstract protected function getTable();
/**
* Define the foreign key
*
* @abstract
* @access protected
* @return string
*/
abstract protected function getForeignKey();
/**
* Get the path prefix
*
* @abstract
* @access protected
* @return string
*/
abstract protected function getPathPrefix();
/**
* Fire file creation event
*
* @abstract
* @access protected
* @param integer $file_id
*/
abstract protected function fireCreationEvent($file_id);
/**
* Fire file destruction event
*
* @abstract
* @access protected
* @param integer $file_id
*/
abstract protected function fireDestructionEvent($file_id);
/**
* Get PicoDb query to get all files
*
* @access protected
* @return \PicoDb\Table
*/
protected function getQuery()
{
return $this->db
->table($this->getTable())
->columns(
$this->getTable().'.id',
$this->getTable().'.name',
$this->getTable().'.path',
$this->getTable().'.is_image',
$this->getTable().'.'.$this->getForeignKey(),
$this->getTable().'.date',
$this->getTable().'.user_id',
$this->getTable().'.size',
UserModel::TABLE.'.username',
UserModel::TABLE.'.name as user_name'
)
->join(UserModel::TABLE, 'id', 'user_id')
->asc($this->getTable().'.name');
}
/**
* Get a file by the id
*
* @access public
* @param integer $file_id File id
* @return array
*/
public function getById($file_id)
{
return $this->db->table($this->getTable())->eq('id', $file_id)->findOne();
}
/**
* Get all files
*
* @access public
* @param integer $id
* @return array
*/
public function getAll($id)
{
return $this->getQuery()->eq($this->getForeignKey(), $id)->findAll();
}
/**
* Get all images
*
* @access public
* @param integer $id
* @return array
*/
public function getAllImages($id)
{
return $this->getQuery()->eq($this->getForeignKey(), $id)->eq('is_image', 1)->findAll();
}
/**
* Get all files without images
*
* @access public
* @param integer $id
* @return array
*/
public function getAllDocuments($id)
{
return $this->getQuery()->eq($this->getForeignKey(), $id)->eq('is_image', 0)->findAll();
}
/**
* Create a file entry in the database
*
* @access public
* @param integer $foreign_key_id Foreign key
* @param string $name Filename
* @param string $path Path on the disk
* @param integer $size File size
* @return bool|integer
*/
public function create($foreign_key_id, $name, $path, $size)
{
$values = array(
$this->getForeignKey() => $foreign_key_id,
'name' => substr($name, 0, 255),
'path' => $path,
'is_image' => $this->isImage($name) ? 1 : 0,
'size' => $size,
'user_id' => $this->userSession->getId() ?: 0,
'date' => time(),
);
$result = $this->db->table($this->getTable())->insert($values);
if ($result) {
$file_id = (int) $this->db->getLastId();
$this->fireCreationEvent($file_id);
return $file_id;
}
return false;
}
/**
* Remove all files
*
* @access public
* @param integer $id
* @return bool
*/
public function removeAll($id)
{
$file_ids = $this->db->table($this->getTable())->eq($this->getForeignKey(), $id)->asc('id')->findAllByColumn('id');
$results = array();
foreach ($file_ids as $file_id) {
$results[] = $this->remove($file_id);
}
return ! in_array(false, $results, true);
}
/**
* Remove a file
*
* @access public
* @param integer $file_id File id
* @return bool
*/
public function remove($file_id)
{
try {
$this->fireDestructionEvent($file_id);
$file = $this->getById($file_id);
// Only remove files from disk attached to a single task.
$multiple_tasks_count = $this->db->table($this->getTable())->eq('path', $file['path'])->count();
if ($multiple_tasks_count === 1) {
$this->objectStorage->remove($file['path']);
if ($file['is_image'] == 1) {
$this->objectStorage->remove($this->getThumbnailPath($file['path']));
}
}
return $this->db->table($this->getTable())->eq('id', $file['id'])->remove();
} catch (ObjectStorageException $e) {
$this->logger->error($e->getMessage());
return false;
}
}
/**
* Check if a filename is an image (file types that can be shown as thumbnail)
*
* @access public
* @param string $filename Filename
* @return bool
*/
public function isImage($filename)
{
switch (get_file_extension($filename)) {
case 'jpeg':
case 'jpg':
case 'png':
case 'gif':
return true;
}
return false;
}
/**
* Generate the path for a thumbnails
*
* @access public
* @param string $key Storage key
* @return string
*/
public function getThumbnailPath($key)
{
return 'thumbnails'.DIRECTORY_SEPARATOR.$key;
}
/**
* Generate the path for a new filename
*
* @access public
* @param integer $id Foreign key
* @param string $filename Filename
* @return string
*/
public function generatePath($id, $filename)
{
return $this->getPathPrefix().DIRECTORY_SEPARATOR.$id.DIRECTORY_SEPARATOR.hash('sha1', $filename.time());
}
/**
* Upload multiple files
*
* @access public
* @param integer $id
* @param array $files
* @return bool
*/
public function uploadFiles($id, array $files)
{
try {
if (empty($files)) {
return false;
}
foreach (array_keys($files['error']) as $key) {
$file = array(
'name' => $files['name'][$key],
'tmp_name' => $files['tmp_name'][$key],
'size' => $files['size'][$key],
'error' => $files['error'][$key],
);
$this->uploadFile($id, $file);
}
return true;
} catch (Exception $e) {
$this->logger->error($e->getMessage());
return false;
}
}
/**
* Upload a file
*
* @access public
* @param integer $id
* @param array $file
* @throws Exception
*/
public function uploadFile($id, array $file)
{
if ($file['error'] == UPLOAD_ERR_OK && $file['size'] > 0) {
$destination_filename = $this->generatePath($id, $file['name']);
if ($this->isImage($file['name'])) {
$this->generateThumbnailFromFile($file['tmp_name'], $destination_filename);
}
$this->objectStorage->moveUploadedFile($file['tmp_name'], $destination_filename);
$this->create($id, $file['name'], $destination_filename, $file['size']);
} else {
throw new Exception('File not uploaded: '.var_export($file['error'], true));
}
}
/**
* Handle file upload (base64 encoded content)
*
* @access public
* @param integer $id
* @param string $originalFilename
* @param string $data
* @param bool $isEncoded
* @return bool|int
*/
public function uploadContent($id, $originalFilename, $data, $isEncoded = true)
{
try {
if ($isEncoded) {
$data = base64_decode($data);
}
if (empty($data)) {
$this->logger->error(__METHOD__.': Content upload with no data');
return false;
}
$destinationFilename = $this->generatePath($id, $originalFilename);
$this->objectStorage->put($destinationFilename, $data);
if ($this->isImage($originalFilename)) {
$this->generateThumbnailFromData($destinationFilename, $data);
}
return $this->create(
$id,
$originalFilename,
$destinationFilename,
strlen($data)
);
} catch (ObjectStorageException $e) {
$this->logger->error($e->getMessage());
return false;
}
}
/**
* Generate thumbnail from a blob
*
* @access public
* @param string $destination_filename
* @param string $data
*/
public function generateThumbnailFromData($destination_filename, &$data)
{
$blob = Thumbnail::createFromString($data)
->resize()
->toString();
$this->objectStorage->put($this->getThumbnailPath($destination_filename), $blob);
}
/**
* Generate thumbnail from a local file
*
* @access public
* @param string $uploaded_filename
* @param string $destination_filename
*/
public function generateThumbnailFromFile($uploaded_filename, $destination_filename)
{
$blob = Thumbnail::createFromFile($uploaded_filename)
->resize()
->toString();
$this->objectStorage->put($this->getThumbnailPath($destination_filename), $blob);
}
}
|