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 = false;
81 protected $store_path = GALETTE_PHOTOS_PATH
;
82 protected $max_width = 200;
83 protected $max_height = 200;
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 !== '' && $id_adh !== null) {
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 if ($this->checkFileInDB()) {
114 $this->has_picture
= true;
117 $this->has_picture
= true;
121 // if we still have no picture, take the default one
122 if (empty($this->file_path
)) {
123 $this->getDefaultPicture();
126 //we should not have an empty file_path, but...
127 if (!empty($this->file_path
)) {
133 * "Magic" function called on unserialize
137 public function __wakeup()
139 //if file has been deleted since we store our object in the session,
140 //we try to retrieve it
141 if (!$this->checkFileOnFS()) {
142 //if file does not exists on the FileSystem,
143 //check for it in the database
144 //$this->checkFileInDB();
146 $this->has_picture
= false;
149 // if we still have no picture, take the default one
150 if (empty($this->file_path
)) {
151 $this->getDefaultPicture();
154 //we should not have an empty file_path, but...
155 if (!empty($this->file_path
)) {
161 * Check if current file is present on the File System
163 * @return boolean true if file is present on FS, false otherwise
165 private function checkFileOnFS()
167 $file_wo_ext = $this->store_path
. $this->id
;
168 if (file_exists($file_wo_ext . '.jpg')) {
169 $this->file_path
= realpath($file_wo_ext . '.jpg');
170 $this->format
= 'jpg';
171 $this->mime
= 'image/jpeg';
173 } elseif (file_exists($file_wo_ext . '.png')) {
174 $this->file_path
= realpath($file_wo_ext . '.png');
175 $this->format
= 'png';
176 $this->mime
= 'image/png';
178 } elseif (file_exists($file_wo_ext . '.gif')) {
179 $this->file_path
= realpath($file_wo_ext . '.gif');
180 $this->format
= 'gif';
181 $this->mime
= 'image/gif';
188 * Check if current file is present in the database,
189 * and copy it to the File System
191 * @return boolean true if file is present in the DB, false otherwise
193 private function checkFileInDB()
198 $select = $this->getCheckFileQuery();
199 $results = $zdb->execute($select);
200 $pic = $results->current();
203 // we must regenerate the picture file
204 $file_wo_ext = $this->store_path
. $this->id
;
206 $file_wo_ext . '.' . $pic->format
,
210 $this->format
= $pic->format
;
211 switch ($this->format
) {
213 $this->mime
= 'image/jpeg';
216 $this->mime
= 'image/png';
219 $this->mime
= 'image/gif';
222 $this->file_path
= realpath($file_wo_ext . '.' . $this->format
);
225 } catch (\Exception
$e) {
231 * Returns the relevant query to check if picture exists in database.
233 * @return string SELECT query
235 protected function getCheckFileQuery()
238 $class = get_class($this);
240 $select = $zdb->select($this->tbl_prefix
. $class::TABLE
);
247 $select->where(array($class::PK
=> $this->db_id
));
252 * Gets the default picture to show, anyways
256 protected function getDefaultPicture()
258 $this->file_path
= realpath(_CURRENT_THEME_PATH
. 'images/default.png');
259 $this->format
= 'png';
260 $this->mime
= 'image/png';
261 $this->has_picture
= false;
269 private function setSizes()
271 list($width, $height) = getimagesize($this->file_path
);
272 $this->height
= $height;
273 $this->width
= $width;
274 $this->optimal_height
= $height;
275 $this->optimal_width
= $width;
277 if ($this->height
> $this->width
) {
278 if ($this->height
> $this->max_height
) {
279 $ratio = $this->max_height
/ $this->height
;
280 $this->optimal_height
= $this->max_height
;
281 $this->optimal_width
= $this->width
* $ratio;
284 if ($this->width
> $this->max_width
) {
285 $ratio = $this->max_width
/ $this->width
;
286 $this->optimal_width
= $this->max_width
;
287 $this->optimal_height
= $this->height
* $ratio;
293 * Get image file contents
297 public function getContents()
299 readfile($this->file_path
);
303 * Set header and displays the picture.
305 * @return object the binary file
307 public function display()
309 header('Content-type: '.$this->mime
);
312 $this->getContents();
316 * Deletes a picture, from both database and filesystem
318 * @param boolean $transaction Whether to use a transaction here or not
320 * @return boolean true if image was successfully deleted, false otherwise
322 public function delete($transaction = true)
325 $class = get_class($this);
328 if ($transaction === true) {
329 $zdb->connection
->beginTransaction();
332 $delete = $zdb->delete($this->tbl_prefix
. $class::TABLE
);
334 $class::PK
. ' = ' . $this->db_id
336 $del = $zdb->execute($delete);
338 if (!$del->count() > 0) {
340 'Unable to remove picture database entry for ' . $this->db_id
,
343 //it may be possible image is missing in the database.
344 //let's try to remove file anyway.
347 $file_wo_ext = $this->store_path
. $this->id
;
349 // take back default picture
350 $this->getDefaultPicture();
356 if (file_exists($file_wo_ext . '.jpg')) {
357 //return unlink($file_wo_ext . '.jpg');
358 $_file = $file_wo_ext . '.jpg';
359 $success = unlink($_file);
360 } elseif (file_exists($file_wo_ext . '.png')) {
361 //return unlink($file_wo_ext . '.png');
362 $_file = $file_wo_ext . '.png';
363 $success = unlink($_file);
364 } elseif (file_exists($file_wo_ext . '.gif')) {
365 //return unlink($file_wo_ext . '.gif');
366 $_file = $file_wo_ext . '.gif';
367 $success = unlink($_file);
370 if ($_file !== null && $success !== true) {
371 //unable to remove file that exists!
372 if ($transaction === true) {
373 $zdb->connection
->rollBack();
376 'The file ' . $_file .
377 ' was found on the disk but cannot be removed.',
382 if ($transaction === true) {
383 $zdb->connection
->commit();
385 $this->has_picture
= false;
388 } catch (\Exception
$e) {
389 if ($transaction === true) {
390 $zdb->connection
->rollBack();
393 'An error occurred attempting to delete picture ' . $this->db_id
.
394 'from database | ' . $e->getMessage(),
402 * Stores an image on the disk and in the database
404 * @param object $file the uploaded file
405 * @param boolean $ajax If the image cames from an ajax call (dnd)
407 * @return true|false result of the storage process
409 public function store($file, $ajax = false)
411 /** TODO: fix max size (by preferences ?) */
414 $class = get_class($this);
416 $name = $file['name'];
417 $tmpfile = $file['tmp_name'];
419 //First, does the file have a valid name?
420 $reg = "/^([^" . implode('', $this->bad_chars
) . "]+)\.(" .
421 implode('|', $this->allowed_extensions
) . ")$/i";
422 if (preg_match($reg, $name, $matches)) {
424 '[' . $class . '] Filename and extension are OK, proceed.',
427 $extension = strtolower($matches[2]);
428 if ($extension == 'jpeg') {
429 //jpeg is an allowed extension,
430 //but we change it to jpg to reduce further tests :)
434 $erreg = "/^([^" . implode('', $this->bad_chars
) . "]+)\.(.*)/i";
435 $m = preg_match($erreg, $name, $errmatches);
437 $err_msg = '[' . $class . '] ';
439 //ok, we got a good filename and an extension. Extension is bad :)
440 $err_msg .= 'Invalid extension for file ' . $name . '.';
441 $ret = self
::INVALID_EXTENSION
;
443 $err_msg = 'Invalid filename `' . $name . '` (Tip: ';
444 $err_msg .= preg_replace(
446 htmlentities($this->getBadChars()),
447 "file name should not contain any of: %s). "
449 $ret = self
::INVALID_FILENAME
;
459 //Second, let's check file size
460 if ($file['size'] > ( $this->maxlenght
* 1024 )) {
462 '[' . $class . '] File is too big (' . ( $file['size'] * 1024 ) .
463 'Ko for maximum authorized ' . ( $this->maxlenght
* 1024 ) .
467 return self
::FILE_TOO_BIG
;
469 Analog
::log('[' . $class . '] Filesize is OK, proceed', Analog
::DEBUG
);
472 $current = getimagesize($tmpfile);
474 if (!in_array($current['mime'], $this->allowed_mimes
)) {
476 '[' . $class . '] Mimetype `' . $current['mime'] . '` not allowed',
479 return self
::MIME_NOT_ALLOWED
;
482 '[' . $class . '] Mimetype is allowed, proceed',
489 $new_file = $this->store_path
.
490 $this->id
. '.' . $extension;
491 if ($ajax === true) {
492 rename($tmpfile, $new_file);
494 move_uploaded_file($tmpfile, $new_file);
497 // current[0] gives width ; current[1] gives height
498 if ($current[0] > $this->max_width ||
$current[1] > $this->max_height
) {
499 /** FIXME: what if image cannot be resized?
500 Should'nt we want to stop the process here? */
501 $this->resizeImage($new_file, $extension);
504 return $this->storeInDb($zdb, $this->db_id
, $new_file, $extension);
508 * Stores an image in the database
510 * @param Db $zdb Database instance
511 * @param int $id Member ID
512 * @param string $file File path on disk
513 * @param string $ext File extension
517 private function storeInDb(Db
$zdb, $id, $file, $ext)
519 $f = fopen($file, 'r');
521 while ($r=fread($f, 8192)) {
526 $class = get_class($this);
529 $zdb->connection
->beginTransaction();
530 $stmt = $this->insert_stmt
;
532 $insert = $zdb->insert($this->tbl_prefix
. $class::TABLE
);
536 'picture' => ':picture',
537 'format' => ':format'
540 $stmt = $zdb->sql
->prepareStatementForSqlObject($insert);
541 $container = $stmt->getParameterContainer();
542 $container->offsetSet(
546 $container->offsetSet(
551 $container->offsetSet(
555 $stmt->setParameterContainer($container);
556 $this->insert_stmt
= $stmt;
562 'picture' => $picture,
566 $zdb->connection
->commit();
567 $this->has_picture
= true;
568 } catch (\Exception
$e) {
569 $zdb->connection
->rollBack();
571 'An error occurred storing picture in database: ' .
575 return self
::SQL_ERROR
;
582 * Check for missing images in database
584 * @param Db $zdb Database instance
588 public function missingInDb(Db
$zdb)
590 $existing_disk = array();
592 //retrieve files on disk
593 if ($handle = opendir($this->store_path
)) {
594 while (false !== ($entry = readdir($handle))) {
595 $reg = "/^(\d+)\.(" .
596 implode('|', $this->allowed_extensions
) . ")$/i";
597 if (preg_match($reg, $entry, $matches)) {
599 $extension = strtolower($matches[2]);
600 if ($extension == 'jpeg') {
601 //jpeg is an allowed extension,
602 //but we change it to jpg to reduce further tests :)
605 $existing_disk[$id] = array(
614 if (count($existing_disk) === 0) {
615 //no image on disk, nothing to do :)
619 //retrieve files in database
620 $class = get_class($this);
621 $select = $zdb->select($this->tbl_prefix
. $class::TABLE
);
623 ->columns(array($class::PK
))
624 ->where
->in($class::PK
, array_keys($existing_disk));
626 $results = $zdb->execute($select);
628 $existing_db = array();
629 foreach ($results as $result) {
630 $existing_db[] = (int)$result[self
::PK
];
633 $existing_diff = array_diff(array_keys($existing_disk), $existing_db);
635 //retrieve valid members ids
636 $members = new Members();
637 $valids = $members->getArrayList(
645 foreach ($valids as $valid) {
646 $file = $existing_disk[$valid->id_adh
];
650 $this->store_path
. $file['id'] . '.' . $file['ext'],
656 'Something went wrong opening images directory ' .
664 * Resize the image if it exceed max allowed sizes
666 * @param string $source the source image
667 * @param string $ext file's extension
668 * @param string $dest the destination image.
669 * If null, we'll use the source image. Defaults to null
673 private function resizeImage($source, $ext, $dest = null)
675 $class = get_class($this);
677 if (function_exists("gd_info")) {
679 $h = $this->max_height
;
680 $w = $this->max_width
;
685 switch (strtolower($ext)) {
687 if (!$gdinfo['JPEG Support']) {
689 '[' . $class . '] GD has no JPEG Support - ' .
690 'pictures could not be resized!',
697 if (!$gdinfo['PNG Support']) {
699 '[' . $class . '] GD has no PNG Support - ' .
700 'pictures could not be resized!',
707 if (!$gdinfo['GIF Create Support']) {
709 '[' . $class . '] GD has no GIF Support - ' .
710 'pictures could not be resized!',
720 list($cur_width, $cur_height, $cur_type, $curattr)
721 = getimagesize($source);
723 $ratio = $cur_width / $cur_height;
725 // calculate image size according to ratio
726 if ($cur_width>$cur_height) {
732 $thumb = imagecreatetruecolor($w, $h);
735 $image = ImageCreateFromJpeg($source);
736 imagecopyresampled($thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height);
737 imagejpeg($thumb, $dest);
740 $image = ImageCreateFromPng($source);
741 // Turn off alpha blending and set alpha flag. That prevent alpha
742 // transparency to be saved as an arbitrary color (black in my tests)
743 imagealphablending($thumb, false);
744 imagealphablending($image, false);
745 imagesavealpha($thumb, true);
746 imagesavealpha($image, true);
747 imagecopyresampled($thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height);
748 imagepng($thumb, $dest);
751 $image = ImageCreateFromGif($source);
752 imagecopyresampled($thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height);
753 imagegif($thumb, $dest);
758 '[' . $class . '] GD is not present - ' .
759 'pictures could not be resized!',
766 * Returns current file optimal height (resized)
768 * @return int optimal height
770 public function getOptimalHeight()
772 return (int)round($this->optimal_height
, 1);
776 * Returns current file height
778 * @return int current height
780 public function getHeight()
782 return $this->height
;
786 * Returns current file optimal width (resized)
788 * @return int optimal width
790 public function getOptimalWidth()
792 return (int)round($this->optimal_width
, 1);
796 * Returns current file width
798 * @return int current width
800 public function getWidth()
806 * Returns current file format
810 public function getFormat()
812 return $this->format
;
816 * Have we got a picture ?
818 * @return bool True if a picture matches adherent's id, false otherwise
820 public function hasPicture()
822 return $this->has_picture
;
826 * Returns current file full path
828 * @return string full file path
830 public function getPath()
832 return $this->file_path
;
836 * Returns current mime type
840 public function getMime()
846 * Return textual error message
848 * @param int $code The error code
850 * @return string Localized message
852 public function getErrorMessage($code)
856 case self
::SQL_ERROR
:
857 case self
::SQL_BLOB_ERROR
:
858 $error = _T("An SQL error has occurred.");
862 if ($error === null) {
863 $error = $this->getErrorMessageFromCode($code);