galette/lib/Galette/Core/Picture.php

   1 <?php
   2
   3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   4
   5 /**
   6  * Picture handling
   7  *
   8  * PHP version 5
   9  *
  10  * Copyright © 2006-2014 The Galette Team
  11  *
  12  * This file is part of Galette (http://galette.tuxfamily.org).
  13  *
  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.
  18  *
  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.
  23  *
  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/>.
  26  *
  27  * @category  Core
  28  * @package   Galette
  29  *
  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
  34  * @version   SVN: $Id$
  35  * @link      http://galette.tuxfamily.org
  36  */
  37
  38 namespace Galette\Core;
  39
  40 use Analog\Analog;
  41 use Galette\Entity\Adherent;
  42 use Galette\Repository\Members;
  43 use Galette\IO\FileInterface;
  44 use Galette\IO\FileTrait;
  45
  46 /**
  47  * Picture handling
  48  *
  49  * @name Picture
  50  * @category  Core
  51  * @package   Galette
  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
  57  */
  58 class Picture implements FileInterface
  59 {
  60     use FileTrait;
  61
  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;
  69
  70     protected $tbl_prefix = '';
  71
  72     protected $id;
  73     protected $height;
  74     protected $width;
  75     protected $optimal_height;
  76     protected $optimal_width;
  77     protected $file_path;
  78     protected $format;
  79     protected $mime;
  80     protected $has_picture = false;
  81     protected $store_path = GALETTE_PHOTOS_PATH;
  82     protected $max_width = 200;
  83     protected $max_height = 200;
  84     private $insert_stmt;
  85
  86     /**
  87      * Default constructor.
  88      *
  89      * @param int $id_adh the id of the member
  90      */
  91     public function __construct($id_adh = '')
  92     {
  93
  94         $this->init(
  95             null,
  96             array('jpeg', 'jpg', 'png', 'gif'),
  97             array(
  98                 'jpg'    =>    'image/jpeg',
  99                 'png'    =>    'image/png',
 100                 'gif'    =>    'image/gif'
 101             )
 102         );
 103
 104         // '!==' needed, otherwise ''==0
 105         if ($id_adh !== '' && $id_adh !== null) {
 106             $this->id = $id_adh;
 107             if (!isset($this->db_id)) {
 108                 $this->db_id = $id_adh;
 109             }
 110
 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;
 115                 }
 116             } else {
 117                 $this->has_picture = true;
 118             }
 119         }
 120
 121         // if we still have no picture, take the default one
 122         if (empty($this->file_path)) {
 123             $this->getDefaultPicture();
 124         }
 125
 126         //we should not have an empty file_path, but...
 127         if (!empty($this->file_path)) {
 128             $this->setSizes();
 129         }
 130     }
 131
 132     /**
 133      * "Magic" function called on unserialize
 134      *
 135      * @return void
 136      */
 137     public function __wakeup()
 138     {
 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();
 145         } else {
 146             $this->has_picture = false;
 147         }
 148
 149         // if we still have no picture, take the default one
 150         if (empty($this->file_path)) {
 151             $this->getDefaultPicture();
 152         }
 153
 154         //we should not have an empty file_path, but...
 155         if (!empty($this->file_path)) {
 156             $this->setSizes();
 157         }
 158     }
 159
 160     /**
 161      * Check if current file is present on the File System
 162      *
 163      * @return boolean true if file is present on FS, false otherwise
 164      */
 165     private function checkFileOnFS()
 166     {
 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';
 172             return true;
 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';
 177             return true;
 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';
 182             return true;
 183         }
 184         return false;
 185     }
 186
 187     /**
 188      * Check if current file is present in the database,
 189      *   and copy it to the File System
 190      *
 191      * @return boolean true if file is present in the DB, false otherwise
 192      */
 193     private function checkFileInDB()
 194     {
 195         global $zdb;
 196
 197         try {
 198             $select = $this->getCheckFileQuery();
 199             $results = $zdb->execute($select);
 200             $pic = $results->current();
 201
 202             if ($pic) {
 203                 // we must regenerate the picture file
 204                 $file_wo_ext = $this->store_path . $this->id;
 205                 file_put_contents(
 206                     $file_wo_ext . '.' . $pic->format,
 207                     $pic->picture
 208                 );
 209
 210                 $this->format = $pic->format;
 211                 switch ($this->format) {
 212                     case 'jpg':
 213                         $this->mime = 'image/jpeg';
 214                         break;
 215                     case 'png':
 216                         $this->mime = 'image/png';
 217                         break;
 218                     case 'gif':
 219                         $this->mime = 'image/gif';
 220                         break;
 221                 }
 222                 $this->file_path = realpath($file_wo_ext . '.' . $this->format);
 223                 return true;
 224             }
 225         } catch (\Exception $e) {
 226             return false;
 227         }
 228     }
 229
 230     /**
 231      * Returns the relevant query to check if picture exists in database.
 232      *
 233      * @return string SELECT query
 234      */
 235     protected function getCheckFileQuery()
 236     {
 237         global $zdb;
 238         $class = get_class($this);
 239
 240         $select = $zdb->select($this->tbl_prefix . $class::TABLE);
 241         $select->columns(
 242             array(
 243                 'picture',
 244                 'format'
 245             )
 246         );
 247         $select->where(array($class::PK => $this->db_id));
 248         return $select;
 249     }
 250
 251     /**
 252      * Gets the default picture to show, anyways
 253      *
 254      * @return void
 255      */
 256     protected function getDefaultPicture()
 257     {
 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;
 262     }
 263
 264     /**
 265      * Set picture sizes
 266      *
 267      * @return void
 268      */
 269     private function setSizes()
 270     {
 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;
 276
 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;
 282             }
 283         } else {
 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;
 288             }
 289         }
 290     }
 291
 292     /**
 293      * Set header and displays the picture.
 294      *
 295      * @return object the binary file
 296      */
 297     public function display()
 298     {
 299         header('Content-type: '.$this->mime);
 300         ob_clean();
 301         flush();
 302         readfile($this->file_path);
 303     }
 304
 305     /**
 306      * Deletes a picture, from both database and filesystem
 307      *
 308      * @param boolean $transaction Whether to use a transaction here or not
 309      *
 310      * @return boolean true if image was successfully deleted, false otherwise
 311      */
 312     public function delete($transaction = true)
 313     {
 314         global $zdb;
 315         $class = get_class($this);
 316
 317         try {
 318             if ($transaction === true) {
 319                 $zdb->connection->beginTransaction();
 320             }
 321
 322             $delete = $zdb->delete($this->tbl_prefix . $class::TABLE);
 323             $delete->where(
 324                 $class::PK . ' = ' . $this->db_id
 325             );
 326             $del = $zdb->execute($delete);
 327
 328             if (!$del->count() > 0) {
 329                 Analog::log(
 330                     'Unable to remove picture database entry for ' . $this->db_id,
 331                     Analog::ERROR
 332                 );
 333                 //it may be possible image is missing in the database.
 334                 //let's try to remove file anyway.
 335             }
 336
 337             $file_wo_ext = $this->store_path . $this->id;
 338
 339             // take back default picture
 340             $this->getDefaultPicture();
 341             // fix sizes
 342             $this->setSizes();
 343
 344             $success = false;
 345             $_file = null;
 346             if (file_exists($file_wo_ext . '.jpg')) {
 347                 //return unlink($file_wo_ext . '.jpg');
 348                 $_file = $file_wo_ext . '.jpg';
 349                 $success = unlink($_file);
 350             } elseif (file_exists($file_wo_ext . '.png')) {
 351                 //return unlink($file_wo_ext . '.png');
 352                 $_file = $file_wo_ext . '.png';
 353                 $success = unlink($_file);
 354             } elseif (file_exists($file_wo_ext . '.gif')) {
 355                 //return unlink($file_wo_ext . '.gif');
 356                 $_file = $file_wo_ext . '.gif';
 357                 $success = unlink($_file);
 358             }
 359
 360             if ($_file !== null && $success !== true) {
 361                 //unable to remove file that exists!
 362                 if ($transaction === true) {
 363                     $zdb->connection->rollBack();
 364                 }
 365                 Analog::log(
 366                     'The file ' . $_file .
 367                     ' was found on the disk but cannot be removed.',
 368                     Analog::ERROR
 369                 );
 370                 return false;
 371             } else {
 372                 if ($transaction === true) {
 373                     $zdb->connection->commit();
 374                 }
 375                 $this->has_picture = false;
 376                 return true;
 377             }
 378         } catch (\Exception $e) {
 379             if ($transaction === true) {
 380                 $zdb->connection->rollBack();
 381             }
 382             Analog::log(
 383                 'An error occurred attempting to delete picture ' . $this->db_id .
 384                 'from database | ' . $e->getMessage(),
 385                 Analog::ERROR
 386             );
 387             return false;
 388         }
 389     }
 390
 391     /**
 392      * Stores an image on the disk and in the database
 393      *
 394      * @param object  $file the uploaded file
 395      * @param boolean $ajax If the image cames from an ajax call (dnd)
 396      *
 397      * @return true|false result of the storage process
 398      */
 399     public function store($file, $ajax = false)
 400     {
 401         /** TODO: fix max size (by preferences ?) */
 402         global $zdb;
 403
 404         $class = get_class($this);
 405
 406         $name = $file['name'];
 407         $tmpfile = $file['tmp_name'];
 408
 409         //First, does the file have a valid name?
 410         $reg = "/^([^" . implode('', $this->bad_chars) . "]+)\.(" .
 411             implode('|', $this->allowed_extensions) . ")$/i";
 412         if (preg_match($reg, $name, $matches)) {
 413             Analog::log(
 414                 '[' . $class . '] Filename and extension are OK, proceed.',
 415                 Analog::DEBUG
 416             );
 417             $extension = strtolower($matches[2]);
 418             if ($extension == 'jpeg') {
 419                 //jpeg is an allowed extension,
 420                 //but we change it to jpg to reduce further tests :)
 421                 $extension = 'jpg';
 422             }
 423         } else {
 424             $erreg = "/^([^" . implode('', $this->bad_chars) . "]+)\.(.*)/i";
 425             $m = preg_match($erreg, $name, $errmatches);
 426
 427             $err_msg = '[' . $class . '] ';
 428             if ($m == 1) {
 429                 //ok, we got a good filename and an extension. Extension is bad :)
 430                 $err_msg .= 'Invalid extension for file ' . $name . '.';
 431                 $ret = self::INVALID_EXTENSION;
 432             } else {
 433                 $err_msg = 'Invalid filename `' . $name  . '` (Tip: ';
 434                 $err_msg .= preg_replace(
 435                     '|%s|',
 436                     htmlentities($this->getBadChars()),
 437                     "file name should not contain any of: %s). "
 438                 );
 439                 $ret = self::INVALID_FILENAME;
 440             }
 441
 442             Analog::log(
 443                 $err_msg,
 444                 Analog::ERROR
 445             );
 446             return $ret;
 447         }
 448
 449         //Second, let's check file size
 450         if ($file['size'] > ( $this->maxlenght * 1024 )) {
 451             Analog::log(
 452                 '[' . $class . '] File is too big (' . ( $file['size'] * 1024 ) .
 453                 'Ko for maximum authorized ' . ( $this->maxlenght * 1024 ) .
 454                 'Ko',
 455                 Analog::ERROR
 456             );
 457             return self::FILE_TOO_BIG;
 458         } else {
 459             Analog::log('[' . $class . '] Filesize is OK, proceed', Analog::DEBUG);
 460         }
 461
 462         $current = getimagesize($tmpfile);
 463
 464         if (!in_array($current['mime'], $this->allowed_mimes)) {
 465             Analog::log(
 466                 '[' . $class . '] Mimetype `' . $current['mime'] . '` not allowed',
 467                 Analog::ERROR
 468             );
 469             return self::MIME_NOT_ALLOWED;
 470         } else {
 471             Analog::log(
 472                 '[' . $class . '] Mimetype is allowed, proceed',
 473                 Analog::DEBUG
 474             );
 475         }
 476
 477         $this->delete();
 478
 479         $new_file = $this->store_path .
 480             $this->id . '.' . $extension;
 481         if ($ajax === true) {
 482             rename($tmpfile, $new_file);
 483         } else {
 484             move_uploaded_file($tmpfile, $new_file);
 485         }
 486
 487         // current[0] gives width ; current[1] gives height
 488         if ($current[0] > $this->max_width || $current[1] > $this->max_height) {
 489             /** FIXME: what if image cannot be resized?
 490                 Should'nt we want to stop the process here? */
 491             $this->resizeImage($new_file, $extension);
 492         }
 493
 494         return $this->storeInDb($zdb, $this->db_id, $new_file, $extension);
 495     }
 496
 497     /**
 498      * Stores an image in the database
 499      *
 500      * @param Db     $zdb  Database instance
 501      * @param int    $id   Member ID
 502      * @param string $file File path on disk
 503      * @param string $ext  File extension
 504      *
 505      * @return boolean
 506      */
 507     private function storeInDb(Db $zdb, $id, $file, $ext)
 508     {
 509         $f = fopen($file, 'r');
 510         $picture = '';
 511         while ($r=fread($f, 8192)) {
 512             $picture .= $r;
 513         }
 514         fclose($f);
 515
 516         $class = get_class($this);
 517
 518         try {
 519             $zdb->connection->beginTransaction();
 520             $stmt = $this->insert_stmt;
 521             if ($stmt == null) {
 522                 $insert = $zdb->insert($this->tbl_prefix . $class::TABLE);
 523                 $insert->values(
 524                     array(
 525                         $class::PK  => ':id',
 526                         'picture'   => ':picture',
 527                         'format'    => ':format'
 528                     )
 529                 );
 530                 $stmt = $zdb->sql->prepareStatementForSqlObject($insert);
 531                 $container = $stmt->getParameterContainer();
 532                 $container->offsetSet(
 533                     $class::PK,
 534                     ':id'
 535                 );
 536                 $container->offsetSet(
 537                     'picture',
 538                     ':picture',
 539                     $container::TYPE_LOB
 540                 );
 541                 $container->offsetSet(
 542                     'format',
 543                     ':format'
 544                 );
 545                 $stmt->setParameterContainer($container);
 546                 $this->insert_stmt = $stmt;
 547             }
 548
 549             $stmt->execute(
 550                 array(
 551                     $class::PK  => $id,
 552                     'picture'   => $picture,
 553                     'format'    => $ext
 554                 )
 555             );
 556             $zdb->connection->commit();
 557             $this->has_picture = true;
 558         } catch (\Exception $e) {
 559             $zdb->connection->rollBack();
 560             Analog::log(
 561                 'An error occurred storing picture in database: ' .
 562                 $e->getMessage(),
 563                 Analog::ERROR
 564             );
 565             return self::SQL_ERROR;
 566         }
 567
 568         return true;
 569     }
 570
 571     /**
 572      * Check for missing images in database
 573      *
 574      * @param Db $zdb Database instance
 575      *
 576      * @return void
 577      */
 578     public function missingInDb(Db $zdb)
 579     {
 580         $existing_disk = array();
 581
 582         //retrieve files on disk
 583         if ($handle = opendir($this->store_path)) {
 584             while (false !== ($entry = readdir($handle))) {
 585                 $reg = "/^(\d+)\.(" .
 586                     implode('|', $this->allowed_extensions) . ")$/i";
 587                 if (preg_match($reg, $entry, $matches)) {
 588                     $id = $matches[1];
 589                     $extension = strtolower($matches[2]);
 590                     if ($extension == 'jpeg') {
 591                         //jpeg is an allowed extension,
 592                         //but we change it to jpg to reduce further tests :)
 593                         $extension = 'jpg';
 594                     }
 595                     $existing_disk[$id] = array(
 596                         'name'  => $entry,
 597                         'id'    => $id,
 598                         'ext'   => $extension
 599                     );
 600                 }
 601             }
 602             closedir($handle);
 603
 604             if (count($existing_disk) === 0) {
 605                 //no image on disk, nothing to do :)
 606                 return;
 607             }
 608
 609             //retrieve files in database
 610             $class = get_class($this);
 611             $select = $zdb->select($this->tbl_prefix . $class::TABLE);
 612             $select
 613                 ->columns(array($class::PK))
 614                 ->where->in($class::PK, array_keys($existing_disk));
 615
 616             $results = $zdb->execute($select);
 617
 618             $existing_db = array();
 619             foreach ($results as $result) {
 620                 $existing_db[] = (int)$result[self::PK];
 621             }
 622
 623             $existing_diff = array_diff(array_keys($existing_disk), $existing_db);
 624
 625             //retrieve valid members ids
 626             $members = new Members();
 627             $valids = $members->getArrayList(
 628                 $existing_diff,
 629                 null,
 630                 false,
 631                 false,
 632                 array(self::PK)
 633             );
 634
 635             foreach ($valids as $valid) {
 636                 $file = $existing_disk[$valid->id_adh];
 637                 $this->storeInDb(
 638                     $zdb,
 639                     $file['id'],
 640                     $this->store_path . $file['id'] . '.' . $file['ext'],
 641                     $file['ext']
 642                 );
 643             }
 644         } else {
 645             Analog::log(
 646                 'Something went wrong opening images directory ' .
 647                 $this->store_path,
 648                 Analog::ERROR
 649             );
 650         }
 651     }
 652
 653     /**
 654      * Resize the image if it exceed max allowed sizes
 655      *
 656      * @param string $source the source image
 657      * @param string $ext    file's extension
 658      * @param string $dest   the destination image.
 659      *                       If null, we'll use the source image. Defaults to null
 660      *
 661      * @return void
 662      */
 663     private function resizeImage($source, $ext, $dest = null)
 664     {
 665         $class = get_class($this);
 666
 667         if (function_exists("gd_info")) {
 668             $gdinfo = gd_info();
 669             $h = $this->max_height;
 670             $w = $this->max_width;
 671             if ($dest == null) {
 672                 $dest = $source;
 673             }
 674
 675             switch (strtolower($ext)) {
 676                 case 'jpg':
 677                     if (!$gdinfo['JPEG Support']) {
 678                         Analog::log(
 679                             '[' . $class . '] GD has no JPEG Support - ' .
 680                             'pictures could not be resized!',
 681                             Analog::ERROR
 682                         );
 683                         return false;
 684                     }
 685                     break;
 686                 case 'png':
 687                     if (!$gdinfo['PNG Support']) {
 688                         Analog::log(
 689                             '[' . $class . '] GD has no PNG Support - ' .
 690                             'pictures could not be resized!',
 691                             Analog::ERROR
 692                         );
 693                         return false;
 694                     }
 695                     break;
 696                 case 'gif':
 697                     if (!$gdinfo['GIF Create Support']) {
 698                         Analog::log(
 699                             '[' . $class . '] GD has no GIF Support - ' .
 700                             'pictures could not be resized!',
 701                             Analog::ERROR
 702                         );
 703                         return false;
 704                     }
 705                     break;
 706                 default:
 707                     return false;
 708             }
 709
 710             list($cur_width, $cur_height, $cur_type, $curattr)
 711                 = getimagesize($source);
 712
 713             $ratio = $cur_width / $cur_height;
 714
 715             // calculate image size according to ratio
 716             if ($cur_width>$cur_height) {
 717                 $h = $w/$ratio;
 718             } else {
 719                 $w = $h*$ratio;
 720             }
 721
 722             $thumb = imagecreatetruecolor($w, $h);
 723             switch ($ext) {
 724                 case 'jpg':
 725                     $image = ImageCreateFromJpeg($source);
 726                     imagecopyresampled($thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height);
 727                     imagejpeg($thumb, $dest);
 728                     break;
 729                 case 'png':
 730                     $image = ImageCreateFromPng($source);
 731                     // Turn off alpha blending and set alpha flag. That prevent alpha
 732                     // transparency to be saved as an arbitrary color (black in my tests)
 733                     imagealphablending($thumb, false);
 734                     imagealphablending($image, false);
 735                     imagesavealpha($thumb, true);
 736                     imagesavealpha($image, true);
 737                     imagecopyresampled($thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height);
 738                     imagepng($thumb, $dest);
 739                     break;
 740                 case 'gif':
 741                     $image = ImageCreateFromGif($source);
 742                     imagecopyresampled($thumb, $image, 0, 0, 0, 0, $w, $h, $cur_width, $cur_height);
 743                     imagegif($thumb, $dest);
 744                     break;
 745             }
 746         } else {
 747             Analog::log(
 748                 '[' . $class . '] GD is not present - ' .
 749                 'pictures could not be resized!',
 750                 Analog::ERROR
 751             );
 752         }
 753     }
 754
 755     /**
 756      * Returns current file optimal height (resized)
 757      *
 758      * @return int optimal height
 759      */
 760     public function getOptimalHeight()
 761     {
 762         return (int)round($this->optimal_height, 1);
 763     }
 764
 765     /**
 766      * Returns current file height
 767      *
 768      * @return int current height
 769      */
 770     public function getHeight()
 771     {
 772         return $this->height;
 773     }
 774
 775     /**
 776      * Returns current file optimal width (resized)
 777      *
 778      * @return int optimal width
 779      */
 780     public function getOptimalWidth()
 781     {
 782         return (int)round($this->optimal_width, 1);
 783     }
 784
 785     /**
 786      * Returns current file width
 787      *
 788      * @return int current width
 789      */
 790     public function getWidth()
 791     {
 792         return $this->width;
 793     }
 794
 795     /**
 796      * Returns current file format
 797      *
 798      * @return string
 799      */
 800     public function getFormat()
 801     {
 802         return $this->format;
 803     }
 804
 805     /**
 806      * Have we got a picture ?
 807      *
 808      * @return bool True if a picture matches adherent's id, false otherwise
 809      */
 810     public function hasPicture()
 811     {
 812         return $this->has_picture;
 813     }
 814
 815     /**
 816      * Returns current file full path
 817      *
 818      * @return string full file path
 819      */
 820     public function getPath()
 821     {
 822         return $this->file_path;
 823     }
 824
 825     /**
 826      * Returns current mime type
 827      *
 828      * @return string
 829      */
 830     public function getMime()
 831     {
 832         return $this->mime;
 833     }
 834
 835     /**
 836      * Return textual error message
 837      *
 838      * @param int $code The error code
 839      *
 840      * @return string Localized message
 841      */
 842     public function getErrorMessage($code)
 843     {
 844         $error = null;
 845         switch ($code) {
 846             case self::SQL_ERROR:
 847             case self::SQL_BLOB_ERROR:
 848                 $error = _T("An SQL error has occurred.");
 849                 break;
 850         }
 851
 852         if ($error === null) {
 853             $error = $this->getErrorMessageFromCode($code);
 854         }
 855
 856         return $error;
 857     }
 858 }