3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
10 * Copyright © 2006-2014 The Galette Team
12 * This file is part of Galette (http://galette.tuxfamily.org).
14 * Galette is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * Galette is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with Galette. If not, see <http://www.gnu.org/licenses/>.
30 * @author Frédéric Jaqcuot <unknown@unknow.com>
31 * @author Johan Cwiklinski <johan@x-tnd.be>
32 * @copyright 2006-2014 The Galette Team
33 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
35 * @link http://galette.tuxfamily.org
38 namespace Galette\Core
;
41 use Galette\Entity\Adherent
;
42 use Galette\Repository\Members
;
43 use Galette\IO\FileInterface
;
44 use Galette\IO\FileTrait
;
52 * @author Frédéric Jaqcuot <unknown@unknow.com>
53 * @author Johan Cwiklinski <johan@x-tnd.be>
54 * @copyright 2006-2014 The Galette Team
55 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
56 * @link http://galette.tuxfamily.org
58 class Picture
implements FileInterface
62 //constants that will not be overrided
63 const SQL_ERROR
= -10;
64 const SQL_BLOB_ERROR
= -11;
65 //constants that can be overrided
66 //(do not use self::CONSTANT, but get_class[$this]::CONSTANT)
67 const TABLE
= 'pictures';
68 const PK
= Adherent
::PK
;
70 protected $tbl_prefix = '';
75 protected $optimal_height;
76 protected $optimal_width;
80 protected $has_picture = true;
81 protected $store_path = GALETTE_PHOTOS_PATH
;
82 protected $max_width = 200;
83 protected $max_height = 200;
84 private $_insert_stmt;
87 * Default constructor.
89 * @param int $id_adh the id of the member
91 public function __construct($id_adh = '')
96 array('jpeg', 'jpg', 'png', 'gif'),
98 'jpg' => 'image/jpeg',
104 // '!==' needed, otherwise ''==0
105 if ( $id_adh !== '' ) {
107 if ( !isset ($this->db_id
) ) {
108 $this->db_id
= $id_adh;
111 //if file does not exists on the FileSystem, check for it in the database
112 if ( !$this->_checkFileOnFS() ) {
113 $this->_checkFileInDB();
117 // if we still have no picture, take the default one
118 if ( $this->file_path
== '' ) {
119 $this->getDefaultPicture();
122 //we should not have an empty file_path, but...
123 if ( $this->file_path
!== '' ) {
129 * "Magic" function called on unserialize
133 public function __wakeup()
135 //if file has been deleted since we store our object in the session,
136 //we try to retrieve it
137 if ( !$this->_checkFileOnFS() ) {
138 //if file does not exists on the FileSystem,
139 //check for it in the database
140 //$this->_checkFileInDB();
143 // if we still have no picture, take the default one
144 if ( $this->file_path
=='' ) {
145 $this->getDefaultPicture();
148 //we should not have an empty file_path, but...
149 if ( $this->file_path
!== '' ) {
155 * Check if current file is present on the File System
157 * @return boolean true if file is present on FS, false otherwise
159 private function _checkFileOnFS()
161 $file_wo_ext = $this->store_path
. $this->id
;
162 if ( file_exists($file_wo_ext . '.jpg') ) {
163 $this->file_path
= $file_wo_ext . '.jpg';
164 $this->format
= 'jpg';
165 $this->mime
= 'image/jpeg';
167 } elseif ( file_exists($file_wo_ext . '.png') ) {
168 $this->file_path
= $file_wo_ext . '.png';
169 $this->format
= 'png';
170 $this->mime
= 'image/png';
172 } elseif ( file_exists($file_wo_ext . '.gif') ) {
173 $this->file_path
= $file_wo_ext . '.gif';
174 $this->format
= 'gif';
175 $this->mime
= 'image/gif';
182 * Check if current file is present in the database,
183 * and copy it to the File System
185 * @return boolean true if file is present in the DB, false otherwise
187 private function _checkFileInDB()
192 $select = $this->getCheckFileQuery();
193 $results = $zdb->execute($select);
194 $pic = $results->current();
197 // we must regenerate the picture file
198 $file_wo_ext = $this->store_path
. $this->id
;
200 $file_wo_ext . '.' . $pic->format
,
204 $this->format
= $pic->format
;
205 switch ($this->format
) {
207 $this->mime
= 'image/jpeg';
210 $this->mime
= 'image/png';
213 $this->mime
= 'image/gif';
216 $this->file_path
= $file_wo_ext . '.' . $this->format
;
219 } catch (\Exception
$e) {
225 * Returns the relevant query to check if picture exists in database.
227 * @return string SELECT query
229 protected function getCheckFileQuery()
232 $class = get_class($this);
234 $select = $zdb->select($this->tbl_prefix
. $class::TABLE
);
241 $select->where(array($class::PK
=> $this->db_id
));
246 * Gets the default picture to show, anyways
250 protected function getDefaultPicture()
252 $this->file_path
= _CURRENT_TEMPLATE_PATH
. 'images/default.png';
253 $this->format
= 'png';
254 $this->mime
= 'image/png';
255 $this->has_picture
= false;
263 private function _setSizes()
265 list($width, $height) = getimagesize($this->file_path
);
266 $this->height
= $height;
267 $this->width
= $width;
268 $this->optimal_height
= $height;
269 $this->optimal_width
= $width;
271 if ($this->height
> $this->width
) {
272 if ($this->height
> $this->max_height
) {
273 $ratio = $this->max_height
/ $this->height
;
274 $this->optimal_height
= $this->max_height
;
275 $this->optimal_width
= $this->width
* $ratio;
278 if ($this->width
> $this->max_width
) {
279 $ratio = $this->max_width
/ $this->width
;
280 $this->optimal_width
= $this->max_width
;
281 $this->optimal_height
= $this->height
* $ratio;
287 * Set header and displays the picture.
289 * @return object the binary file
291 public function display()
293 header('Content-type: '.$this->mime
);
294 header('Content-Length: ' . filesize($this->file_path
));
297 readfile($this->file_path
);
301 * Deletes a picture, from both database and filesystem
303 * @param boolean $transaction Whether to use a transaction here or not
305 * @return boolean true if image was successfully deleted, false otherwise
307 public function delete($transaction = true)
310 $class = get_class($this);
313 if ( $transaction === true ) {
314 $zdb->connection
->beginTransaction();
317 $delete = $zdb->delete($this->tbl_prefix
. $class::TABLE
);
319 $class::PK
. ' = ' . $this->db_id
321 $del = $zdb->execute($delete);
323 if ( !$del->count() > 0 ) {
325 'Unable to remove picture database entry for ' . $this->db_id
,
328 //it may be possible image is missing in the database.
329 //let's try to remove file anyway.
332 $file_wo_ext = $this->store_path
. $this->id
;
334 // take back default picture
335 $this->getDefaultPicture();
341 if ( file_exists($file_wo_ext . '.jpg') ) {
342 //return unlink($file_wo_ext . '.jpg');
343 $_file = $file_wo_ext . '.jpg';
344 $success = unlink($_file);
345 } elseif ( file_exists($file_wo_ext . '.png') ) {
346 //return unlink($file_wo_ext . '.png');
347 $_file = $file_wo_ext . '.png';
348 $success = unlink($_file);
349 } elseif ( file_exists($file_wo_ext . '.gif') ) {
350 //return unlink($file_wo_ext . '.gif');
351 $_file = $file_wo_ext . '.gif';
352 $success = unlink($_file);
355 if ( $_file !== null && $success !== true ) {
356 //unable to remove file that exists!
357 if ( $transaction === true ) {
358 $zdb->connection
->rollBack();
361 'The file ' . $_file .
362 ' was found on the disk but cannot be removed.',
367 if ( $transaction === true ) {
368 $zdb->connection
->commit();
372 } catch (\Exception
$e) {
373 if ( $transaction === true ) {
374 $zdb->connection
->rollBack();
377 'An error occured attempting to delete picture ' . $this->db_id
.
378 'from database | ' . $e->getMessage(),
386 * Stores an image on the disk and in the database
388 * @param object $file the uploaded file
389 * @param boolean $ajax If the image cames from an ajax call (dnd)
391 * @return true|false result of the storage process
393 public function store($file, $ajax = false)
395 /** TODO: fix max size (by preferences ?) */
398 $class = get_class($this);
400 $name = $file['name'];
401 $tmpfile = $file['tmp_name'];
403 //First, does the file have a valid name?
404 $reg = "/^(.[^" . implode('', $this->bad_chars
) . "]+)\.(" .
405 implode('|', $this->allowed_extensions
) . ")$/i";
406 if ( preg_match($reg, $name, $matches) ) {
408 '[' . $class . '] Filename and extension are OK, proceed.',
411 $extension = strtolower($matches[2]);
412 if ( $extension == 'jpeg' ) {
413 //jpeg is an allowed extension,
414 //but we change it to jpg to reduce further tests :)
418 $erreg = "/^(.[^" . implode('', $this->bad_chars
) . "]+)\.(.*)/i";
419 $m = preg_match($erreg, $name, $errmatches);
421 $err_msg = '[' . $class . '] ';
423 //ok, we got a good filename and an extension. Extension is bad :)
424 $err_msg .= 'Invalid extension for file ' . $name . '.';
425 $ret = self
::INVALID_EXTENSION
;
427 $err_msg = 'Invalid filename `' . $name . '` (Tip: ';
428 $err_msg .= preg_replace(
430 htmlentities($this->getBadChars()),
431 "file name should not contain any of: %s). "
433 $ret = self
::INVALID_FILENAME
;
443 //Second, let's check file size
444 if ( $file['size'] > ( $this->maxlenght
* 1024 ) ) {
446 '[' . $class . '] File is too big (' . ( $file['size'] * 1024 ) .
447 'Ko for maximum authorized ' . ( $this->maxlenght
* 1024 ) .
451 return self
::FILE_TOO_BIG
;
453 Analog
::log('[' . $class . '] Filesize is OK, proceed', Analog
::DEBUG
);
456 $current = getimagesize($tmpfile);
458 if ( !in_array($current['mime'], $this->allowed_mimes
) ) {
460 '[' . $class . '] Mimetype `' . $current['mime'] . '` not allowed',
463 return self
::MIME_NOT_ALLOWED
;
466 '[' . $class . '] Mimetype is allowed, proceed',
473 $new_file = $this->store_path
.
474 $this->id
. '.' . $extension;
475 if ( $ajax === true ) {
476 rename($tmpfile, $new_file);
478 move_uploaded_file($tmpfile, $new_file);
481 // current[0] gives width ; current[1] gives height
482 if ( $current[0] > $this->max_width ||
$current[1] > $this->max_height
) {
483 /** FIXME: what if image cannot be resized?
484 Should'nt we want to stop the process here? */
485 $this->_resizeImage($new_file, $extension);
488 return $this->_storeInDb($zdb, $this->db_id
, $new_file, $extension);
492 * Stores an image in the database
494 * @param Db $zdb Database instance
495 * @param int $id Member ID
496 * @param string $file File path on disk
497 * @param string $ext File extension
501 private function _storeInDb(Db
$zdb, $id, $file, $ext)
503 $f = fopen($file, 'r');
505 while ( $r=fread($f, 8192) ) {
510 $class = get_class($this);
513 $zdb->connection
->beginTransaction();
514 $stmt = $this->_insert_stmt
;
515 if ( $stmt == null ) {
516 $insert = $zdb->insert($this->tbl_prefix
. $class::TABLE
);
520 'picture' => ':picture',
521 'format' => ':format'
524 $stmt = $zdb->sql
->prepareStatementForSqlObject($insert);
525 $container = $stmt->getParameterContainer();
526 $container->offsetSet(
530 $container->offsetSet(
535 $container->offsetSet(
539 $stmt->setParameterContainer($container);
540 $this->_insert_stmt
= $stmt;
546 'picture' => $picture,
550 $zdb->connection
->commit();
551 } catch (\Exception
$e) {
552 $zdb->connection
->rollBack();
554 'An error occured storing picture in database: ' .
558 return self
::SQL_ERROR
;
566 * Check for missing images in database
568 * @param Db $zdb Database instance
572 public function missingInDb(Db
$zdb)
574 $existing_disk = array();
576 //retrieve files on disk
577 if ( $handle = opendir($this->store_path
) ) {
578 while (false !== ($entry = readdir($handle))) {
579 $reg = "/^(\d+)\.(" .
580 implode('|', $this->allowed_extensions
) . ")$/i";
581 if ( preg_match($reg, $entry, $matches) ) {
583 $extension = strtolower($matches[2]);
584 if ( $extension == 'jpeg' ) {
585 //jpeg is an allowed extension,
586 //but we change it to jpg to reduce further tests :)
589 $existing_disk[$id] = array(
599 if ( count($existing_disk) === 0 ) {
600 //no image on disk, nothing to do :)
604 //retrieve files in database
605 $class = get_class($this);
606 $select = $zdb->select($this->tbl_prefix
. $class::TABLE
);
608 ->columns(array(self
::PK
))
609 ->where
->in(self
::PK
, array_keys($existing_disk));
611 $results = $zdb->execute($select);
613 $existing_db = array();
614 foreach ( $results as $result ) {
615 $existing_db[] = (int)$result[self
::PK
];
618 $existing_diff = array_diff(array_keys($existing_disk), $existing_db);
620 //retrieve valid members ids
621 $members = new Members();
622 $valids = $members->getArrayList(
630 foreach ( $valids as $valid ) {
631 $file = $existing_disk[$valid->id_adh
];
635 $this->store_path
. $file['id'] . '.' . $file['ext'],
641 'Something went wrong opening images directory ' .
649 * Resize the image if it exceed max allowed sizes
651 * @param string $source the source image
652 * @param string $ext file's extension
653 * @param string $dest the destination image.
654 * If null, we'll use the source image. Defaults to null
658 private function _resizeImage($source, $ext, $dest = null)
660 $class = get_class($this);
662 if (function_exists("gd_info")) {
664 $h = $this->max_height
;
665 $w = $this->max_width
;
666 if ( $dest == null ) {
670 switch(strtolower($ext)) {
672 if (!$gdinfo['JPEG Support']) {
674 '[' . $class . '] GD has no JPEG Support - ' .
675 'pictures could not be resized!',
682 if (!$gdinfo['PNG Support']) {
684 '[' . $class . '] GD has no PNG Support - ' .
685 'pictures could not be resized!',
692 if (!$gdinfo['GIF Create Support']) {
694 '[' . $class . '] GD has no GIF Support - ' .
695 'pictures could not be resized!',
705 list($cur_width, $cur_height, $cur_type, $curattr)
706 = getimagesize($source);
708 $ratio = $cur_width / $cur_height;
710 // calculate image size according to ratio
711 if ($cur_width>$cur_height) {
717 $thumb = imagecreatetruecolor($w, $h);
720 $image = ImageCreateFromJpeg($source);
722 $thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height
724 imagejpeg($thumb, $dest);
727 $image = ImageCreateFromPng($source);
728 // Turn off alpha blending and set alpha flag. That prevent alpha
729 // transparency to be saved as an arbitrary color (black in my tests)
730 imagealphablending($thumb, false);
731 imagealphablending($image, false);
732 imagesavealpha($thumb, true);
733 imagesavealpha($image, true);
735 $thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height
737 imagepng($thumb, $dest);
740 $image = ImageCreateFromGif($source);
742 $thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height
744 imagegif($thumb, $dest);
749 '[' . $class . '] GD is not present - ' .
750 'pictures could not be resized!',
757 * Returns current file optimal height (resized)
759 * @return int optimal height
761 public function getOptimalHeight()
763 return round($this->optimal_height
);
767 * Returns current file height
769 * @return int current height
771 public function getHeight()
773 return $this->height
;
777 * Returns current file optimal width (resized)
779 * @return int optimal width
781 public function getOptimalWidth()
783 return $this->optimal_width
;
787 * Returns current file width
789 * @return int current width
791 public function getWidth()
797 * Returns current file format
801 public function getFormat()
803 return $this->format
;
807 * Have we got a picture ?
809 * @return bool True if a picture matches adherent's id, false otherwise
811 public function hasPicture()
813 return $this->has_picture
;
817 * Returns current file full path
819 * @return string full file path
821 public function getPath()
823 return $this->file_path
;
827 * Returns current mime type
831 public function getMime()
837 * Return textual error message
839 * @param int $code The error code
841 * @return string Localized message
843 public function getErrorMessage($code)
847 case self
::SQL_ERROR
:
848 case self
::SQL_BLOB_ERROR
:
849 $error = _T("An SQL error has occured.");
853 if ( $error === null ) {
854 $error = $this->getErrorMessageFromCode($code);