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: /**
 29:  * Catalog Product Eav Attributes abstract indexer resource model
 30:  *
 31:  * @category    Mage
 32:  * @package     Mage_Catalog
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: abstract class Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
 36:     extends Mage_Catalog_Model_Resource_Product_Indexer_Abstract
 37: {
 38:     /**
 39:      * Rebuild all index data
 40:      *
 41:      *
 42:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
 43:      */
 44:     public function reindexAll()
 45:     {
 46:         $this->useIdxTable(true);
 47:         $this->beginTransaction();
 48:         try {
 49:             $this->clearTemporaryIndexTable();
 50:             $this->_prepareIndex();
 51:             $this->_prepareRelationIndex();
 52:             $this->_removeNotVisibleEntityFromIndex();
 53: 
 54:             $this->syncData();
 55:             $this->commit();
 56:         } catch (Exception $e) {
 57:             $this->rollBack();
 58:             throw $e;
 59:         }
 60: 
 61:         return $this;
 62:     }
 63: 
 64:     /**
 65:      * Rebuild index data by entities
 66:      *
 67:      *
 68:      * @param int|array $processIds
 69:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
 70:      * @throws Exception
 71:      */
 72:     public function reindexEntities($processIds)
 73:     {
 74:         $adapter = $this->_getWriteAdapter();
 75: 
 76:         $this->clearTemporaryIndexTable();
 77: 
 78:         if (!is_array($processIds)) {
 79:             $processIds = array($processIds);
 80:         }
 81: 
 82:         $parentIds = $this->getRelationsByChild($processIds);
 83:         if ($parentIds) {
 84:             $processIds = array_unique(array_merge($processIds, $parentIds));
 85:         }
 86:         $childIds  = $this->getRelationsByParent($processIds);
 87:         if ($childIds) {
 88:             $processIds = array_unique(array_merge($processIds, $childIds));
 89:         }
 90: 
 91:         $this->_prepareIndex($processIds);
 92:         $this->_prepareRelationIndex($processIds);
 93:         $this->_removeNotVisibleEntityFromIndex();
 94: 
 95:         $adapter->beginTransaction();
 96:         try {
 97:             // remove old index
 98:             $where = $adapter->quoteInto('entity_id IN(?)', $processIds);
 99:             $adapter->delete($this->getMainTable(), $where);
100: 
101:             // insert new index
102:             $this->useDisableKeys(false);
103:             $this->insertFromTable($this->getIdxTable(), $this->getMainTable());
104:             $this->useDisableKeys(true);
105: 
106:             $adapter->commit();
107:         } catch (Exception $e) {
108:             $adapter->rollBack();
109:             throw $e;
110:         }
111: 
112:         return $this;
113:     }
114: 
115:     /**
116:      * Rebuild index data by attribute id
117:      * If attribute is not indexable remove data by attribute
118:      *
119:      *
120:      * @param int $attributeId
121:      * @param bool $isIndexable
122:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
123:      */
124:     public function reindexAttribute($attributeId, $isIndexable = true)
125:     {
126:         if (!$isIndexable) {
127:             $this->_removeAttributeIndexData($attributeId);
128:         } else {
129:             $this->clearTemporaryIndexTable();
130: 
131:             $this->_prepareIndex(null, $attributeId);
132:             $this->_prepareRelationIndex();
133:             $this->_removeNotVisibleEntityFromIndex();
134: 
135:             $this->_synchronizeAttributeIndexData($attributeId);
136:         }
137: 
138:         return $this;
139:     }
140: 
141:     /**
142:      * Prepare data index for indexable attributes
143:      *
144:      * @param array $entityIds      the entity ids limitation
145:      * @param int $attributeId      the attribute id limitation
146:      */
147:     abstract protected function _prepareIndex($entityIds = null, $attributeId = null);
148: 
149:     /**
150:      * Remove Not Visible products from temporary data index
151:      *
152:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
153:      */
154:     protected function _removeNotVisibleEntityFromIndex()
155:     {
156:         $write      = $this->_getWriteAdapter();
157:         $idxTable   = $this->getIdxTable();
158: 
159:         $select = $write->select()
160:             ->from($idxTable, null);
161: 
162:         $condition = $write->quoteInto('=?',Mage_Catalog_Model_Product_Visibility::VISIBILITY_NOT_VISIBLE);
163:         $this->_addAttributeToSelect(
164:             $select,
165:             'visibility',
166:             $idxTable . '.entity_id',
167:             $idxTable . '.store_id',
168:             $condition
169:         );
170: 
171:         $query = $select->deleteFromSelect($idxTable);
172:         $write->query($query);
173: 
174:         return $this;
175:     }
176: 
177:     /**
178:      * Prepare data index for product relations
179:      *
180:      * @param array $parentIds  the parent entity ids limitation
181:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
182:      */
183:     protected function _prepareRelationIndex($parentIds = null)
184:     {
185:         $write      = $this->_getWriteAdapter();
186:         $idxTable   = $this->getIdxTable();
187: 
188:         $select = $write->select()
189:             ->from(array('l' => $this->getTable('catalog/product_relation')), 'parent_id')
190:             ->join(
191:                 array('cs' => $this->getTable('core/store')),
192:                 '',
193:                 array())
194:             ->join(
195:                 array('i' => $idxTable),
196:                 'l.child_id = i.entity_id AND cs.store_id = i.store_id',
197:                 array('attribute_id', 'store_id', 'value'))
198:             ->group(array(
199:                 'l.parent_id', 'i.attribute_id', 'i.store_id', 'i.value'
200:             ));
201:         if (!is_null($parentIds)) {
202:             $select->where('l.parent_id IN(?)', $parentIds);
203:         }
204: 
205:         /**
206:          * Add additional external limitation
207:          */
208:         Mage::dispatchEvent('prepare_catalog_product_index_select', array(
209:             'select'        => $select,
210:             'entity_field'  => new Zend_Db_Expr('l.parent_id'),
211:             'website_field' => new Zend_Db_Expr('cs.website_id'),
212:             'store_field'   => new Zend_Db_Expr('cs.store_id')
213:         ));
214: 
215:         $query = $write->insertFromSelect($select, $idxTable, array(), Varien_Db_Adapter_Interface::INSERT_IGNORE);
216:         $write->query($query);
217: 
218:         return $this;
219:     }
220: 
221:     /**
222:      * Retrieve condition for retrieve indexable attribute select
223:      * the catalog/eav_attribute table must have alias is ca
224:      *
225:      * @return string
226:      */
227:     protected function _getIndexableAttributesCondition()
228:     {
229:         $conditions = array(
230:             'ca.is_filterable_in_search > 0',
231:             'ca.is_visible_in_advanced_search > 0',
232:             'ca.is_filterable > 0'
233:         );
234: 
235:         return implode(' OR ', $conditions);
236:     }
237: 
238:     /**
239:      * Remove index data from index by attribute id
240:      *
241:      * @param int $attributeId
242:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
243:      */
244:     protected function _removeAttributeIndexData($attributeId)
245:     {
246:         $adapter = $this->_getWriteAdapter();
247:         $adapter->beginTransaction();
248:         try {
249:             $where = $adapter->quoteInto('attribute_id = ?', $attributeId);
250:             $adapter->delete($this->getMainTable(), $where);
251:             $adapter->commit();
252:         } catch (Exception $e) {
253:             $adapter->rollback();
254:             throw $e;
255:         }
256: 
257:         return $this;
258:     }
259: 
260:     /**
261:      * Synchronize temporary index table with index table by attribute id
262:      *
263:      * @param int $attributeId
264:      * @return Mage_Catalog_Model_Resource_Product_Indexer_Eav_Abstract
265:      * @throws Exception
266:      */
267:     protected function _synchronizeAttributeIndexData($attributeId)
268:     {
269:         $adapter = $this->_getWriteAdapter();
270:         $adapter->beginTransaction();
271:         try {
272:             // remove index by attribute
273:             $where = $adapter->quoteInto('attribute_id = ?', $attributeId);
274:             $adapter->delete($this->getMainTable(), $where);
275: 
276:             // insert new index
277:             $this->insertFromTable($this->getIdxTable(), $this->getMainTable());
278: 
279:             $adapter->commit();
280:         } catch (Exception $e) {
281:             $adapter->rollback();
282:             throw $e;
283:         }
284: 
285:         return $this;
286:     }
287: }
288: