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:  * Abstract API2 class for product images resource
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Catalog
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: abstract class Mage_Catalog_Model_Api2_Product_Image_Rest extends Mage_Catalog_Model_Api2_Product_Rest
 35: {
 36:     /**
 37:      * Attribute code for media gallery
 38:      */
 39:     const GALLERY_ATTRIBUTE_CODE = 'media_gallery';
 40: 
 41:     /**
 42:      * Allowed MIME types for image
 43:      *
 44:      * @var array
 45:      */
 46:     protected $_mimeTypes = array(
 47:         'image/jpg'  => 'jpg',
 48:         'image/jpeg' => 'jpg',
 49:         'image/gif'  => 'gif',
 50:         'image/png'  => 'png'
 51:     );
 52: 
 53:     /**
 54:      * Retrieve product image data for customer and guest roles
 55:      *
 56:      * @throws Mage_Api2_Exception
 57:      * @return array
 58:      */
 59:     protected function _retrieve()
 60:     {
 61:         $imageData = array();
 62:         $imageId = (int)$this->getRequest()->getParam('image');
 63:         $galleryData = $this->_getProduct()->getData(self::GALLERY_ATTRIBUTE_CODE);
 64: 
 65:         if (!isset($galleryData['images']) || !is_array($galleryData['images'])) {
 66:             $this->_critical(self::RESOURCE_NOT_FOUND);
 67:         }
 68:         foreach ($galleryData['images'] as $image) {
 69:             if ($image['value_id'] == $imageId && !$image['disabled']) {
 70:                 $imageData = $this->_formatImageData($image);
 71:                 break;
 72:             }
 73:         }
 74:         if (empty($imageData)) {
 75:             $this->_critical(self::RESOURCE_NOT_FOUND);
 76:         }
 77:         return $imageData;
 78:     }
 79: 
 80:     /**
 81:      * Retrieve product images data for customer and guest
 82:      *
 83:      * @return array
 84:      */
 85:     protected function _retrieveCollection()
 86:     {
 87:         $images = array();
 88:         $galleryData = $this->_getProduct()->getData(self::GALLERY_ATTRIBUTE_CODE);
 89:         if (isset($galleryData['images']) && is_array($galleryData['images'])) {
 90:             foreach ($galleryData['images'] as $image) {
 91:                 if (!$image['disabled']) {
 92:                     $images[] = $this->_formatImageData($image);
 93:                 }
 94:             }
 95:         }
 96:         return $images;
 97:     }
 98: 
 99:     /**
100:      * Retrieve media gallery
101:      *
102:      * @throws Mage_Api2_Exception
103:      * @return Mage_Catalog_Model_Product_Attribute_Backend_Media
104:      */
105:     protected function _getMediaGallery()
106:     {
107:         $attributes = $this->_getProduct()->getTypeInstance(true)->getSetAttributes($this->_getProduct());
108: 
109:         if (!isset($attributes[self::GALLERY_ATTRIBUTE_CODE])
110:             || !$attributes[self::GALLERY_ATTRIBUTE_CODE] instanceof Mage_Eav_Model_Entity_Attribute_Abstract
111:         ) {
112:             $this->_critical('Requested product does not support images', Mage_Api2_Model_Server::HTTP_BAD_REQUEST);
113:         }
114:         $galleryAttribute = $attributes[self::GALLERY_ATTRIBUTE_CODE];
115:         /** @var $mediaGallery Mage_Catalog_Model_Product_Attribute_Backend_Media */
116:         $mediaGallery = $galleryAttribute->getBackend();
117:         return $mediaGallery;
118:     }
119: 
120:     /**
121:      * Create image data representation for API
122:      *
123:      * @param array $image
124:      * @return array
125:      */
126:     protected function _formatImageData($image)
127:     {
128:         $result = array(
129:             'id'        => $image['value_id'],
130:             'label'     => $image['label'],
131:             'position'  => $image['position'],
132:             'exclude'   => $image['disabled'],
133:             'url'       => $this->_getMediaConfig()->getMediaUrl($image['file']),
134:             'types'     => $this->_getImageTypesAssignedToProduct($image['file'])
135:         );
136:         return $result;
137:     }
138: 
139:     /**
140:      * Retrieve image types assigned to product (base, small, thumbnail)
141:      *
142:      * @param string $imageFile
143:      * @return array
144:      */
145:     protected function _getImageTypesAssignedToProduct($imageFile)
146:     {
147:         $types = array();
148:         foreach ($this->_getProduct()->getMediaAttributes() as $attribute) {
149:             if ($this->_getProduct()->getData($attribute->getAttributeCode()) == $imageFile) {
150:                 $types[] = $attribute->getAttributeCode();
151:             }
152:         }
153:         return $types;
154:     }
155: 
156:     /**
157:      * Retrieve media config
158:      *
159:      * @return Mage_Catalog_Model_Product_Media_Config
160:      */
161:     protected function _getMediaConfig()
162:     {
163:         return Mage::getSingleton('catalog/product_media_config');
164:     }
165: 
166:     /**
167:      * Create file name from received data
168:      *
169:      * @param array $data
170:      * @return string
171:      */
172:     protected function _getFileName($data)
173:     {
174:         $fileName = 'image';
175:         if (isset($data['file_name']) && $data['file_name']) {
176:             $fileName = $data['file_name'];
177:         }
178:         $fileName .= '.' . $this->_getExtensionByMimeType($data['file_mime_type']);
179:         return $fileName;
180:     }
181: 
182:     /**
183:      * Retrieve file extension using MIME type
184:      *
185:      * @throws Mage_Api2_Exception
186:      * @param string $mimeType
187:      * @return string
188:      */
189:     protected function _getExtensionByMimeType($mimeType)
190:     {
191:         if (!array_key_exists($mimeType, $this->_mimeTypes)) {
192:             $this->_critical('Unsuppoted image MIME type', Mage_Api2_Model_Server::HTTP_BAD_REQUEST);
193:         }
194:         return $this->_mimeTypes[$mimeType];
195:     }
196: 
197:     /**
198:      * Get file URI by its id. File URI is used by media backend to identify image
199:      *
200:      * @throws Mage_Api2_Exception
201:      * @param int $imageId
202:      * @return string
203:      */
204:     protected function _getImageFileById($imageId)
205:     {
206:         $file = null;
207:         $mediaGalleryData = $this->_getProduct()->getData('media_gallery');
208:         if (!isset($mediaGalleryData['images'])) {
209:             $this->_critical(self::RESOURCE_NOT_FOUND);
210:         }
211:         foreach ($mediaGalleryData['images'] as $image) {
212:             if ($image['value_id'] == $imageId) {
213:                 $file = $image['file'];
214:                 break;
215:             }
216:         }
217:         if (!($file && $this->_getMediaGallery()->getImage($this->_getProduct(), $file))) {
218:             $this->_critical(self::RESOURCE_NOT_FOUND);
219:         }
220:         return $file;
221:     }
222: }
223: