1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Catalog
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Catalog image helper
 29:  *
 30:  * @author      Magento Core Team <core@magentocommerce.com>
 31:  */
 32: class Mage_Catalog_Helper_Image extends Mage_Core_Helper_Abstract
 33: {
 34:     /**
 35:      * Current model
 36:      *
 37:      * @var Mage_Catalog_Model_Product_Image
 38:      */
 39:     protected $_model;
 40: 
 41:     /**
 42:      * Scheduled for resize image
 43:      *
 44:      * @var bool
 45:      */
 46:     protected $_scheduleResize = false;
 47: 
 48:     /**
 49:      * Scheduled for rotate image
 50:      *
 51:      * @var bool
 52:      */
 53:     protected $_scheduleRotate = false;
 54: 
 55:     /**
 56:      * Angle
 57:      *
 58:      * @var int
 59:      */
 60:     protected $_angle;
 61: 
 62:     /**
 63:      * Watermark file name
 64:      *
 65:      * @var string
 66:      */
 67:     protected $_watermark;
 68: 
 69:     /**
 70:      * Watermark Position
 71:      *
 72:      * @var string
 73:      */
 74:     protected $_watermarkPosition;
 75: 
 76:     /**
 77:      * Watermark Size
 78:      *
 79:      * @var string
 80:      */
 81:     protected $_watermarkSize;
 82: 
 83:     /**
 84:      * Watermark Image opacity
 85:      *
 86:      * @var int
 87:      */
 88:     protected $_watermarkImageOpacity;
 89: 
 90:     /**
 91:      * Current Product
 92:      *
 93:      * @var Mage_Catalog_Model_Product
 94:      */
 95:     protected $_product;
 96: 
 97:     /**
 98:      * Image File
 99:      *
100:      * @var string
101:      */
102:     protected $_imageFile;
103: 
104:     /**
105:      * Image Placeholder
106:      *
107:      * @var string
108:      */
109:     protected $_placeholder;
110: 
111:     /**
112:      * Reset all previous data
113:      *
114:      * @return Mage_Catalog_Helper_Image
115:      */
116:     protected function _reset()
117:     {
118:         $this->_model = null;
119:         $this->_scheduleResize = false;
120:         $this->_scheduleRotate = false;
121:         $this->_angle = null;
122:         $this->_watermark = null;
123:         $this->_watermarkPosition = null;
124:         $this->_watermarkSize = null;
125:         $this->_watermarkImageOpacity = null;
126:         $this->_product = null;
127:         $this->_imageFile = null;
128:         return $this;
129:     }
130: 
131:     /**
132:      * Initialize Helper to work with Image
133:      *
134:      * @param Mage_Catalog_Model_Product $product
135:      * @param string $attributeName
136:      * @param mixed $imageFile
137:      * @return Mage_Catalog_Helper_Image
138:      */
139:     public function init(Mage_Catalog_Model_Product $product, $attributeName, $imageFile=null)
140:     {
141:         $this->_reset();
142:         $this->_setModel(Mage::getModel('catalog/product_image'));
143:         $this->_getModel()->setDestinationSubdir($attributeName);
144:         $this->setProduct($product);
145: 
146:         $this->setWatermark(
147:             Mage::getStoreConfig("design/watermark/{$this->_getModel()->getDestinationSubdir()}_image")
148:         );
149:         $this->setWatermarkImageOpacity(
150:             Mage::getStoreConfig("design/watermark/{$this->_getModel()->getDestinationSubdir()}_imageOpacity")
151:         );
152:         $this->setWatermarkPosition(
153:             Mage::getStoreConfig("design/watermark/{$this->_getModel()->getDestinationSubdir()}_position")
154:         );
155:         $this->setWatermarkSize(
156:             Mage::getStoreConfig("design/watermark/{$this->_getModel()->getDestinationSubdir()}_size")
157:         );
158: 
159:         if ($imageFile) {
160:             $this->setImageFile($imageFile);
161:         } else {
162:             // add for work original size
163:             $this->_getModel()->setBaseFile($this->getProduct()->getData($this->_getModel()->getDestinationSubdir()));
164:         }
165:         return $this;
166:     }
167: 
168:     /**
169:      * Schedule resize of the image
170:      * $width *or* $height can be null - in this case, lacking dimension will be calculated.
171:      *
172:      * @see Mage_Catalog_Model_Product_Image
173:      * @param int $width
174:      * @param int $height
175:      * @return Mage_Catalog_Helper_Image
176:      */
177:     public function resize($width, $height = null)
178:     {
179:         $this->_getModel()->setWidth($width)->setHeight($height);
180:         $this->_scheduleResize = true;
181:         return $this;
182:     }
183: 
184:     /**
185:      * Set image quality, values in percentage from 0 to 100
186:      *
187:      * @param int $quality
188:      * @return Mage_Catalog_Helper_Image
189:      */
190:     public function setQuality($quality)
191:     {
192:         $this->_getModel()->setQuality($quality);
193:         return $this;
194:     }
195: 
196:     /**
197:      * Guarantee, that image picture width/height will not be distorted.
198:      * Applicable before calling resize()
199:      * It is true by default.
200:      *
201:      * @see Mage_Catalog_Model_Product_Image
202:      * @param bool $flag
203:      * @return Mage_Catalog_Helper_Image
204:      */
205:     public function keepAspectRatio($flag)
206:     {
207:         $this->_getModel()->setKeepAspectRatio($flag);
208:         return $this;
209:     }
210: 
211:     /**
212:      * Guarantee, that image will have dimensions, set in $width/$height
213:      * Applicable before calling resize()
214:      * Not applicable, if keepAspectRatio(false)
215:      *
216:      * $position - TODO, not used for now - picture position inside the frame.
217:      *
218:      * @see Mage_Catalog_Model_Product_Image
219:      * @param bool $flag
220:      * @param array $position
221:      * @return Mage_Catalog_Helper_Image
222:      */
223:     public function keepFrame($flag, $position = array('center', 'middle'))
224:     {
225:         $this->_getModel()->setKeepFrame($flag);
226:         return $this;
227:     }
228: 
229:     /**
230:      * Guarantee, that image will not lose transparency if any.
231:      * Applicable before calling resize()
232:      * It is true by default.
233:      *
234:      * $alphaOpacity - TODO, not used for now
235:      *
236:      * @see Mage_Catalog_Model_Product_Image
237:      * @param bool $flag
238:      * @param int $alphaOpacity
239:      * @return Mage_Catalog_Helper_Image
240:      */
241:     public function keepTransparency($flag, $alphaOpacity = null)
242:     {
243:         $this->_getModel()->setKeepTransparency($flag);
244:         return $this;
245:     }
246: 
247:     /**
248:      * Guarantee, that image picture will not be bigger, than it was.
249:      * Applicable before calling resize()
250:      * It is false by default
251:      *
252:      * @param bool $flag
253:      * @return Mage_Catalog_Helper_Image
254:      */
255:     public function constrainOnly($flag)
256:     {
257:         $this->_getModel()->setConstrainOnly($flag);
258:         return $this;
259:     }
260: 
261:     /**
262:      * Set color to fill image frame with.
263:      * Applicable before calling resize()
264:      * The keepTransparency(true) overrides this (if image has transparent color)
265:      * It is white by default.
266:      *
267:      * @see Mage_Catalog_Model_Product_Image
268:      * @param array $colorRGB
269:      * @return Mage_Catalog_Helper_Image
270:      */
271:     public function backgroundColor($colorRGB)
272:     {
273:         // assume that 3 params were given instead of array
274:         if (!is_array($colorRGB)) {
275:             $colorRGB = func_get_args();
276:         }
277:         $this->_getModel()->setBackgroundColor($colorRGB);
278:         return $this;
279:     }
280: 
281:     /**
282:      * Rotate image into specified angle
283:      *
284:      * @param int $angle
285:      * @return Mage_Catalog_Helper_Image
286:      */
287:     public function rotate($angle)
288:     {
289:         $this->setAngle($angle);
290:         $this->_getModel()->setAngle($angle);
291:         $this->_scheduleRotate = true;
292:         return $this;
293:     }
294: 
295:     /**
296:      * Add watermark to image
297:      * size param in format 100x200
298:      *
299:      * @param string $fileName
300:      * @param string $position
301:      * @param string $size
302:      * @param int $imageOpacity
303:      * @return Mage_Catalog_Helper_Image
304:      */
305:     public function watermark($fileName, $position, $size=null, $imageOpacity=null)
306:     {
307:         $this->setWatermark($fileName)
308:             ->setWatermarkPosition($position)
309:             ->setWatermarkSize($size)
310:             ->setWatermarkImageOpacity($imageOpacity);
311:         return $this;
312:     }
313: 
314:     /**
315:      * Set placeholder
316:      *
317:      * @param string $fileName
318:      * @return void
319:      */
320:     public function placeholder($fileName)
321:     {
322:         $this->_placeholder = $fileName;
323:     }
324: 
325:     /**
326:      * Get Placeholder
327:      *
328:      * @return string
329:      */
330:     public function getPlaceholder()
331:     {
332:         if (!$this->_placeholder) {
333:             $attr = $this->_getModel()->getDestinationSubdir();
334:             $this->_placeholder = 'images/catalog/product/placeholder/'.$attr.'.jpg';
335:         }
336:         return $this->_placeholder;
337:     }
338: 
339:     /**
340:      * Return Image URL
341:      *
342:      * @return string
343:      */
344:     public function __toString()
345:     {
346:         try {
347:             $model = $this->_getModel();
348: 
349:             if ($this->getImageFile()) {
350:                 $model->setBaseFile($this->getImageFile());
351:             } else {
352:                 $model->setBaseFile($this->getProduct()->getData($model->getDestinationSubdir()));
353:             }
354: 
355:             if ($model->isCached()) {
356:                 return $model->getUrl();
357:             } else {
358:                 if ($this->_scheduleRotate) {
359:                     $model->rotate($this->getAngle());
360:                 }
361: 
362:                 if ($this->_scheduleResize) {
363:                     $model->resize();
364:                 }
365: 
366:                 if ($this->getWatermark()) {
367:                     $model->setWatermark($this->getWatermark());
368:                 }
369: 
370:                 $url = $model->saveFile()->getUrl();
371:             }
372:         } catch (Exception $e) {
373:             $url = Mage::getDesign()->getSkinUrl($this->getPlaceholder());
374:         }
375:         return $url;
376:     }
377: 
378:     /**
379:      * Set current Image model
380:      *
381:      * @param Mage_Catalog_Model_Product_Image $model
382:      * @return Mage_Catalog_Helper_Image
383:      */
384:     protected function _setModel($model)
385:     {
386:         $this->_model = $model;
387:         return $this;
388:     }
389: 
390:     /**
391:      * Get current Image model
392:      *
393:      * @return Mage_Catalog_Model_Product_Image
394:      */
395:     protected function _getModel()
396:     {
397:         return $this->_model;
398:     }
399: 
400:     /**
401:      * Set Rotation Angle
402:      *
403:      * @param int $angle
404:      * @return Mage_Catalog_Helper_Image
405:      */
406:     protected function setAngle($angle)
407:     {
408:         $this->_angle = $angle;
409:         return $this;
410:     }
411: 
412:     /**
413:      * Get Rotation Angle
414:      *
415:      * @return int
416:      */
417:     protected function getAngle()
418:     {
419:         return $this->_angle;
420:     }
421: 
422:     /**
423:      * Set watermark file name
424:      *
425:      * @param string $watermark
426:      * @return Mage_Catalog_Helper_Image
427:      */
428:     protected function setWatermark($watermark)
429:     {
430:         $this->_watermark = $watermark;
431:         $this->_getModel()->setWatermarkFile($watermark);
432:         return $this;
433:     }
434: 
435:     /**
436:      * Get watermark file name
437:      *
438:      * @return string
439:      */
440:     protected function getWatermark()
441:     {
442:         return $this->_watermark;
443:     }
444: 
445:     /**
446:      * Set watermark position
447:      *
448:      * @param string $position
449:      * @return Mage_Catalog_Helper_Image
450:      */
451:     protected function setWatermarkPosition($position)
452:     {
453:         $this->_watermarkPosition = $position;
454:         $this->_getModel()->setWatermarkPosition($position);
455:         return $this;
456:     }
457: 
458:     /**
459:      * Get watermark position
460:      *
461:      * @return string
462:      */
463:     protected function getWatermarkPosition()
464:     {
465:         return $this->_watermarkPosition;
466:     }
467: 
468:     /**
469:      * Set watermark size
470:      * param size in format 100x200
471:      *
472:      * @param string $size
473:      * @return Mage_Catalog_Helper_Image
474:      */
475:     public function setWatermarkSize($size)
476:     {
477:         $this->_watermarkSize = $size;
478:         $this->_getModel()->setWatermarkSize($this->parseSize($size));
479:         return $this;
480:     }
481: 
482:     /**
483:      * Get watermark size
484:      *
485:      * @return string
486:      */
487:     protected function getWatermarkSize()
488:     {
489:         return $this->_watermarkSize;
490:     }
491: 
492:     /**
493:      * Set watermark image opacity
494:      *
495:      * @param int $imageOpacity
496:      * @return Mage_Catalog_Helper_Image
497:      */
498:     public function setWatermarkImageOpacity($imageOpacity)
499:     {
500:         $this->_watermarkImageOpacity = $imageOpacity;
501:         $this->_getModel()->setWatermarkImageOpacity($imageOpacity);
502:         return $this;
503:     }
504: 
505:     /**
506:      * Get watermark image opacity
507:      *
508:      * @return int
509:      */
510:     protected function getWatermarkImageOpacity()
511:     {
512:         if ($this->_watermarkImageOpacity) {
513:             return $this->_watermarkImageOpacity;
514:         }
515: 
516:         return $this->_getModel()->getWatermarkImageOpacity();
517:     }
518: 
519:     /**
520:      * Set current Product
521:      *
522:      * @param Mage_Catalog_Model_Product $product
523:      * @return Mage_Catalog_Helper_Image
524:      */
525:     protected function setProduct($product)
526:     {
527:         $this->_product = $product;
528:         return $this;
529:     }
530: 
531:     /**
532:      * Get current Product
533:      *
534:      * @return Mage_Catalog_Model_Product
535:      */
536:     protected function getProduct()
537:     {
538:         return $this->_product;
539:     }
540: 
541:     /**
542:      * Set Image file
543:      *
544:      * @param string $file
545:      * @return Mage_Catalog_Helper_Image
546:      */
547:     protected function setImageFile($file)
548:     {
549:         $this->_imageFile = $file;
550:         return $this;
551:     }
552: 
553:     /**
554:      * Get Image file
555:      *
556:      * @return string
557:      */
558:     protected function getImageFile()
559:     {
560:         return $this->_imageFile;
561:     }
562: 
563:     /**
564:      * Retrieve size from string
565:      *
566:      * @param string $string
567:      * @return array|bool
568:      */
569:     protected function parseSize($string)
570:     {
571:         $size = explode('x', strtolower($string));
572:         if (sizeof($size) == 2) {
573:             return array(
574:                 'width' => ($size[0] > 0) ? $size[0] : null,
575:                 'heigth' => ($size[1] > 0) ? $size[1] : null,
576:             );
577:         }
578:         return false;
579:     }
580: 
581:     /**
582:      * Retrieve original image width
583:      *
584:      * @return int|null
585:      */
586:     public function getOriginalWidth()
587:     {
588:         return $this->_getModel()->getImageProcessor()->getOriginalWidth();
589:     }
590: 
591:     /**
592:      * Retrieve original image height
593:      *
594:      * @deprecated
595:      * @return int|null
596:      */
597:     public function getOriginalHeigh()
598:     {
599:         return $this->getOriginalHeight();
600:     }
601: 
602:     /**
603:      * Retrieve original image height
604:      *
605:      * @return int|null
606:      */
607:     public function getOriginalHeight()
608:     {
609:         return $this->_getModel()->getImageProcessor()->getOriginalHeight();
610:     }
611: 
612:     /**
613:      * Retrieve Original image size as array
614:      * 0 - width, 1 - height
615:      *
616:      * @return array
617:      */
618:     public function getOriginalSizeArray()
619:     {
620:         return array(
621:             $this->getOriginalWidth(),
622:             $this->getOriginalHeight()
623:         );
624:     }
625: 
626:     /**
627:      * Check - is this file an image
628:      *
629:      * @param string $filePath
630:      * @return bool
631:      * @throws Mage_Core_Exception
632:      */
633:     public function validateUploadFile($filePath) {
634:         if (!getimagesize($filePath)) {
635:             Mage::throwException($this->__('Disallowed file type.'));
636:         }
637: 
638:         $_processor = new Varien_Image($filePath);
639:         return $_processor->getMimeType() !== null;
640:     }
641: 
642: }
643: