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: /**
 29:  * Admin configuration model
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Adminhtml
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Adminhtml_Model_Config extends Varien_Simplexml_Config
 36: {
 37: 
 38:     /**
 39:      * Enter description here...
 40:      *
 41:      * @var Varien_Simplexml_Element
 42:      */
 43:     protected $_sections;
 44: 
 45:     /**
 46:      * Tabs
 47:      *
 48:      * @var Varien_Simplexml_Element
 49:      */
 50:     protected $_tabs;
 51: 
 52:     /**
 53:      * Enter description here...
 54:      *
 55:      * @param string $sectionCode
 56:      * @param string $websiteCode
 57:      * @param string $storeCode
 58:      * @return Varien_Simplexml_Element
 59:      */
 60:     public function getSections($sectionCode=null, $websiteCode=null, $storeCode=null)
 61:     {
 62:         if (empty($this->_sections)) {
 63:             $this->_initSectionsAndTabs();
 64:         }
 65: 
 66:         return $this->_sections;
 67:     }
 68: 
 69:     /**
 70:      * Retrieve tabs
 71:      *
 72:      * @return Varien_Simplexml_Element
 73:      */
 74:     public function getTabs()
 75:     {
 76:         if (empty($this->_tabs)) {
 77:             $this->_initSectionsAndTabs();
 78:         }
 79: 
 80:         return $this->_tabs;
 81:     }
 82: 
 83:     /**
 84:      * Init modules configuration
 85:      *
 86:      * @return void
 87:      */
 88:     protected function _initSectionsAndTabs()
 89:     {
 90:         $config = Mage::getConfig()->loadModulesConfiguration('system.xml')
 91:             ->applyExtends();
 92: 
 93:         Mage::dispatchEvent('adminhtml_init_system_config', array('config' => $config));
 94:         $this->_sections = $config->getNode('sections');
 95:         $this->_tabs = $config->getNode('tabs');
 96:     }
 97: 
 98:     /**
 99:      * Enter description here...
100:      *
101:      * @param string $sectionCode
102:      * @param string $websiteCode
103:      * @param string $storeCode
104:      * @return Varien_Simplexml_Element
105:      */
106:     public function getSection($sectionCode=null, $websiteCode=null, $storeCode=null)
107:     {
108:         if ($sectionCode){
109:             return  $this->getSections()->$sectionCode;
110:         } elseif ($websiteCode) {
111:             return  $this->getSections()->$websiteCode;
112:         } elseif ($storeCode) {
113:             return  $this->getSections()->$storeCode;
114:         }
115:     }
116: 
117:     /**
118:      * Enter description here...
119:      *
120:      * @param Varien_Simplexml_Element $node
121:      * @param string $websiteCode
122:      * @param string $storeCode
123:      * @param boolean $isField
124:      * @return boolean
125:      */
126:     public function hasChildren ($node, $websiteCode=null, $storeCode=null, $isField=false)
127:     {
128:         $showTab = false;
129:         if ($storeCode) {
130:             if (isset($node->show_in_store)) {
131:                 if ((int)$node->show_in_store) {
132:                     $showTab=true;
133:                 }
134:             }
135:         } elseif ($websiteCode) {
136:             if (isset($node->show_in_website)) {
137:                 if ((int)$node->show_in_website) {
138:                     $showTab=true;
139:                 }
140:             }
141:         } elseif (isset($node->show_in_default)) {
142:                 if ((int)$node->show_in_default) {
143:                     $showTab=true;
144:                 }
145:         }
146:         if ($showTab) {
147:             if (isset($node->groups)) {
148:                 foreach ($node->groups->children() as $children){
149:                     if ($this->hasChildren ($children, $websiteCode, $storeCode)) {
150:                         return true;
151:                     }
152: 
153:                 }
154:             }elseif (isset($node->fields)) {
155: 
156:                 foreach ($node->fields->children() as $children){
157:                     if ($this->hasChildren ($children, $websiteCode, $storeCode, true)) {
158:                         return true;
159:                     }
160:                 }
161:             } else {
162:                 return true;
163:             }
164:         }
165:         return false;
166:     }
167: 
168:     /**
169:      * Get translate module name
170:      *
171:      * @param Varien_Simplexml_Element $sectionNode
172:      * @param Varien_Simplexml_Element $groupNode
173:      * @param Varien_Simplexml_Element $fieldNode
174:      * @return string
175:      */
176:     function getAttributeModule($sectionNode = null, $groupNode = null, $fieldNode = null)
177:     {
178:         $moduleName = 'adminhtml';
179:         if (is_object($sectionNode) && method_exists($sectionNode, 'attributes')) {
180:             $sectionAttributes = $sectionNode->attributes();
181:             $moduleName = isset($sectionAttributes['module']) ? (string)$sectionAttributes['module'] : $moduleName;
182:         }
183:         if (is_object($groupNode) && method_exists($groupNode, 'attributes')) {
184:             $groupAttributes = $groupNode->attributes();
185:             $moduleName = isset($groupAttributes['module']) ? (string)$groupAttributes['module'] : $moduleName;
186:         }
187:         if (is_object($fieldNode) && method_exists($fieldNode, 'attributes')) {
188:             $fieldAttributes = $fieldNode->attributes();
189:             $moduleName = isset($fieldAttributes['module']) ? (string)$fieldAttributes['module'] : $moduleName;
190:         }
191: 
192:         return $moduleName;
193:     }
194: 
195:     /**
196:      * System configuration section, fieldset or field label getter
197:      *
198:      * @param string $sectionName
199:      * @param string $groupName
200:      * @param string $fieldName
201:      * @return string
202:      */
203:     public function getSystemConfigNodeLabel($sectionName, $groupName = null, $fieldName = null)
204:     {
205:         $sectionName = trim($sectionName, '/');
206:         $path = '//sections/' . $sectionName;
207:         $groupNode = $fieldNode = null;
208:         $sectionNode = $this->_sections->xpath($path);
209:         if (!empty($groupName)) {
210:             $path .= '/groups/' . trim($groupName, '/');
211:             $groupNode = $this->_sections->xpath($path);
212:         }
213:         if (!empty($fieldName)) {
214:             if (!empty($groupName)) {
215:                 $path .= '/fields/' . trim($fieldName, '/');
216:                 $fieldNode = $this->_sections->xpath($path);
217:             }
218:             else {
219:                 Mage::throwException(Mage::helper('adminhtml')->__('The group node name must be specified with field node name.'));
220:             }
221:         }
222:         $moduleName = $this->getAttributeModule($sectionNode, $groupNode, $fieldNode);
223:         $systemNode = $this->_sections->xpath($path);
224:         foreach ($systemNode as $node) {
225:             return Mage::helper($moduleName)->__((string)$node->label);
226:         }
227:         return '';
228:     }
229: 
230:     /**
231:      * Look for encrypted node entries in all system.xml files and return them
232:      *
233:      * @return array $paths
234:      */
235:     public function getEncryptedNodeEntriesPaths($explodePathToEntities = false)
236:     {
237:         $paths = array();
238:         $configSections = $this->getSections();
239:         if ($configSections) {
240:             foreach ($configSections->xpath('//sections/*/groups/*/fields/*/backend_model') as $node) {
241:                 if ('adminhtml/system_config_backend_encrypted' === (string)$node) {
242:                     $section = $node->getParent()->getParent()->getParent()->getParent()->getParent()->getName();
243:                     $group   = $node->getParent()->getParent()->getParent()->getName();
244:                     $field   = $node->getParent()->getName();
245:                     if ($explodePathToEntities) {
246:                         $paths[] = array('section' => $section, 'group' => $group, 'field' => $field);
247:                     }
248:                     else {
249:                         $paths[] = $section . '/' . $group . '/' . $field;
250:                     }
251:                 }
252:             }
253:         }
254:         return $paths;
255:     }
256: }
257: