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_Adminhtml
 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:  * Adminhtml config data model
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Adminhtml
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: 
 35: class Mage_Adminhtml_Model_Config_Data extends Varien_Object
 36: {
 37:     /**
 38:      * Config data for sections
 39:      *
 40:      * @var array
 41:      */
 42:     protected $_configData;
 43: 
 44:     /**
 45:      * Root config node
 46:      *
 47:      * @var Mage_Core_Model_Config_Element
 48:      */
 49:     protected $_configRoot;
 50: 
 51:     /**
 52:      * Save config section
 53:      * Require set: section, website, store and groups
 54:      *
 55:      * @return Mage_Adminhtml_Model_Config_Data
 56:      */
 57:     public function save()
 58:     {
 59:         $this->_validate();
 60:         $this->_getScope();
 61: 
 62:         Mage::dispatchEvent('model_config_data_save_before', array('object' => $this));
 63: 
 64:         $section = $this->getSection();
 65:         $website = $this->getWebsite();
 66:         $store   = $this->getStore();
 67:         $groups  = $this->getGroups();
 68:         $scope   = $this->getScope();
 69:         $scopeId = $this->getScopeId();
 70: 
 71:         if (empty($groups)) {
 72:             return $this;
 73:         }
 74: 
 75:         $sections = Mage::getModel('adminhtml/config')->getSections();
 76:         /* @var $sections Mage_Core_Model_Config_Element */
 77: 
 78:         $oldConfig = $this->_getConfig(true);
 79: 
 80:         $deleteTransaction = Mage::getModel('core/resource_transaction');
 81:         /* @var $deleteTransaction Mage_Core_Model_Resource_Transaction */
 82:         $saveTransaction = Mage::getModel('core/resource_transaction');
 83:         /* @var $saveTransaction Mage_Core_Model_Resource_Transaction */
 84: 
 85:         // Extends for old config data
 86:         $oldConfigAdditionalGroups = array();
 87: 
 88:         foreach ($groups as $group => $groupData) {
 89:             /**
 90:              * Map field names if they were cloned
 91:              */
 92:             $groupConfig = $sections->descend($section.'/groups/'.$group);
 93: 
 94:             if ($clonedFields = !empty($groupConfig->clone_fields)) {
 95:                 if ($groupConfig->clone_model) {
 96:                     $cloneModel = Mage::getModel((string)$groupConfig->clone_model);
 97:                 } else {
 98:                     Mage::throwException('Config form fieldset clone model required to be able to clone fields');
 99:                 }
100:                 $mappedFields = array();
101:                 $fieldsConfig = $sections->descend($section.'/groups/'.$group.'/fields');
102: 
103:                 if ($fieldsConfig->hasChildren()) {
104:                     foreach ($fieldsConfig->children() as $field => $node) {
105:                         foreach ($cloneModel->getPrefixes() as $prefix) {
106:                             $mappedFields[$prefix['field'].(string)$field] = (string)$field;
107:                         }
108:                     }
109:                 }
110:             }
111:             // set value for group field entry by fieldname
112:             // use extra memory
113:             $fieldsetData = array();
114:             foreach ($groupData['fields'] as $field => $fieldData) {
115:                 $fieldsetData[$field] = (is_array($fieldData) && isset($fieldData['value']))
116:                     ? $fieldData['value'] : null;
117:             }
118: 
119:             foreach ($groupData['fields'] as $field => $fieldData) {
120:                 $fieldConfig = $sections->descend($section . '/groups/' . $group . '/fields/' . $field);
121:                 if (!$fieldConfig && $clonedFields && isset($mappedFields[$field])) {
122:                     $fieldConfig = $sections->descend($section . '/groups/' . $group . '/fields/'
123:                         . $mappedFields[$field]);
124:                 }
125:                 if (!$fieldConfig) {
126:                     $node = $sections->xpath($section .'//' . $group . '[@type="group"]/fields/' . $field);
127:                     if ($node) {
128:                         $fieldConfig = $node[0];
129:                     }
130:                 }
131: 
132:                 /**
133:                  * Get field backend model
134:                  */
135:                 $backendClass = $fieldConfig->backend_model;
136:                 if (!$backendClass) {
137:                     $backendClass = 'core/config_data';
138:                 }
139: 
140:                 /** @var $dataObject Mage_Core_Model_Config_Data */
141:                 $dataObject = Mage::getModel($backendClass);
142:                 if (!$dataObject instanceof Mage_Core_Model_Config_Data) {
143:                     Mage::throwException('Invalid config field backend model: '.$backendClass);
144:                 }
145: 
146:                 $dataObject
147:                     ->setField($field)
148:                     ->setGroups($groups)
149:                     ->setGroupId($group)
150:                     ->setStoreCode($store)
151:                     ->setWebsiteCode($website)
152:                     ->setScope($scope)
153:                     ->setScopeId($scopeId)
154:                     ->setFieldConfig($fieldConfig)
155:                     ->setFieldsetData($fieldsetData)
156:                 ;
157: 
158:                 if (!isset($fieldData['value'])) {
159:                     $fieldData['value'] = null;
160:                 }
161: 
162:                 $path = $section . '/' . $group . '/' . $field;
163: 
164:                 /**
165:                  * Look for custom defined field path
166:                  */
167:                 if (is_object($fieldConfig)) {
168:                     $configPath = (string)$fieldConfig->config_path;
169:                     if (!empty($configPath) && strrpos($configPath, '/') > 0) {
170:                         // Extend old data with specified section group
171:                         $groupPath = substr($configPath, 0, strrpos($configPath, '/'));
172:                         if (!isset($oldConfigAdditionalGroups[$groupPath])) {
173:                             $oldConfig = $this->extendConfig($groupPath, true, $oldConfig);
174:                             $oldConfigAdditionalGroups[$groupPath] = true;
175:                         }
176:                         $path = $configPath;
177:                     }
178:                 }
179: 
180:                 $inherit = !empty($fieldData['inherit']);
181: 
182:                 $dataObject->setPath($path)
183:                     ->setValue($fieldData['value']);
184: 
185:                 if (isset($oldConfig[$path])) {
186:                     $dataObject->setConfigId($oldConfig[$path]['config_id']);
187: 
188:                     /**
189:                      * Delete config data if inherit
190:                      */
191:                     if (!$inherit) {
192:                         $saveTransaction->addObject($dataObject);
193:                     }
194:                     else {
195:                         $deleteTransaction->addObject($dataObject);
196:                     }
197:                 }
198:                 elseif (!$inherit) {
199:                     $dataObject->unsConfigId();
200:                     $saveTransaction->addObject($dataObject);
201:                 }
202:             }
203:         }
204: 
205:         $deleteTransaction->delete();
206:         $saveTransaction->save();
207: 
208:         return $this;
209:     }
210: 
211:     /**
212:      * Load config data for section
213:      *
214:      * @return array
215:      */
216:     public function load()
217:     {
218:         if (is_null($this->_configData)) {
219:             $this->_validate();
220:             $this->_getScope();
221:             $this->_configData = $this->_getConfig(false);
222:         }
223:         return $this->_configData;
224:     }
225: 
226:     /**
227:      * Extend config data with additional config data by specified path
228:      *
229:      * @param string $path Config path prefix
230:      * @param bool $full Simple config structure or not
231:      * @param array $oldConfig Config data to extend
232:      * @return array
233:      */
234:     public function extendConfig($path, $full = true, $oldConfig = array())
235:     {
236:         $extended = $this->_getPathConfig($path, $full);
237:         if (is_array($oldConfig) && !empty($oldConfig)) {
238:             return $oldConfig + $extended;
239:         }
240:         return $extended;
241:     }
242: 
243:     /**
244:      * Validate isset required parametrs
245:      *
246:      */
247:     protected function _validate()
248:     {
249:         if (is_null($this->getSection())) {
250:             $this->setSection('');
251:         }
252:         if (is_null($this->getWebsite())) {
253:             $this->setWebsite('');
254:         }
255:         if (is_null($this->getStore())) {
256:             $this->setStore('');
257:         }
258:     }
259: 
260:     /**
261:      * Get scope name and scopeId
262:      *
263:      */
264:     protected function _getScope()
265:     {
266:         if ($this->getStore()) {
267:             $scope   = 'stores';
268:             $scopeId = (int)Mage::getConfig()->getNode('stores/' . $this->getStore() . '/system/store/id');
269:             $scopeCode = $this->getStore();
270:         } elseif ($this->getWebsite()) {
271:             $scope   = 'websites';
272:             $scopeId = (int)Mage::getConfig()->getNode('websites/' . $this->getWebsite() . '/system/website/id');
273:             $scopeCode = $this->getWebsite();
274:         } else {
275:             $scope   = 'default';
276:             $scopeId = 0;
277:             $scopeCode = '';
278:         }
279:         $this->setScope($scope);
280:         $this->setScopeId($scopeId);
281:         $this->setScopeCode($scopeCode);
282:     }
283: 
284:     /**
285:      * Return formatted config data for current section
286:      *
287:      * @param bool $full Simple config structure or not
288:      * @return array
289:      */
290:     protected function _getConfig($full = true)
291:     {
292:         return $this->_getPathConfig($this->getSection(), $full);
293:     }
294: 
295:     /**
296:      * Return formatted config data for specified path prefix
297:      *
298:      * @param string $path Config path prefix
299:      * @param bool $full Simple config structure or not
300:      * @return array
301:      */
302:     protected function _getPathConfig($path, $full = true)
303:     {
304:         $configDataCollection = Mage::getModel('core/config_data')
305:             ->getCollection()
306:             ->addScopeFilter($this->getScope(), $this->getScopeId(), $path);
307: 
308:         $config = array();
309:         foreach ($configDataCollection as $data) {
310:             if ($full) {
311:                 $config[$data->getPath()] = array(
312:                     'path'      => $data->getPath(),
313:                     'value'     => $data->getValue(),
314:                     'config_id' => $data->getConfigId()
315:                 );
316:             }
317:             else {
318:                 $config[$data->getPath()] = $data->getValue();
319:             }
320:         }
321:         return $config;
322:     }
323: 
324:     /**
325:      * Get config data value
326:      *
327:      * @param string $path
328:      * @param null|bool $inherit
329:      * @param null|array $configData
330:      * @return Varien_Simplexml_Element
331:      */
332:     public function getConfigDataValue($path, &$inherit = null, $configData = null)
333:     {
334:         $this->load();
335:         if (is_null($configData)) {
336:             $configData = $this->_configData;
337:         }
338:         if (isset($configData[$path])) {
339:             $data = $configData[$path];
340:             $inherit = false;
341:         } else {
342:             $data = $this->getConfigRoot()->descend($path);
343:             $inherit = true;
344:         }
345: 
346:         return $data;
347:     }
348: 
349:     /**
350:      * Get config root node for current scope
351:      *
352:      * @return Mage_Core_Model_Config_Element
353:      */
354:     public function getConfigRoot()
355:     {
356:         if (is_null($this->_configRoot)) {
357:             $this->load();
358:             $this->_configRoot = Mage::getConfig()->getNode(null, $this->getScope(), $this->getScopeCode());
359:         }
360:         return $this->_configRoot;
361:     }
362: }
363: