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_Core
 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:  * Base html block
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Core
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Core_Block_Template extends Mage_Core_Block_Abstract
 36: {
 37:     const XML_PATH_DEBUG_TEMPLATE_HINTS         = 'dev/debug/template_hints';
 38:     const XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS  = 'dev/debug/template_hints_blocks';
 39:     const XML_PATH_TEMPLATE_ALLOW_SYMLINK       = 'dev/template/allow_symlink';
 40: 
 41:     /**
 42:      * View scripts directory
 43:      *
 44:      * @var string
 45:      */
 46:     protected $_viewDir = '';
 47: 
 48:     /**
 49:      * Assigned variables for view
 50:      *
 51:      * @var array
 52:      */
 53:     protected $_viewVars = array();
 54: 
 55:     protected $_baseUrl;
 56: 
 57:     protected $_jsUrl;
 58: 
 59:     /**
 60:      * Is allowed symlinks flag
 61:      *
 62:      * @var bool
 63:      */
 64:     protected $_allowSymlinks = null;
 65: 
 66:     protected static $_showTemplateHints;
 67:     protected static $_showTemplateHintsBlocks;
 68: 
 69:     /**
 70:      * Path to template file in theme.
 71:      *
 72:      * @var string
 73:      */
 74:     protected $_template;
 75: 
 76:     /**
 77:      * Internal constructor, that is called from real constructor
 78:      *
 79:      */
 80:     protected function _construct()
 81:     {
 82:         parent::_construct();
 83: 
 84:         /*
 85:          * In case template was passed through constructor
 86:          * we assign it to block's property _template
 87:          * Mainly for those cases when block created
 88:          * not via Mage_Core_Model_Layout::addBlock()
 89:          */
 90:         if ($this->hasData('template')) {
 91:             $this->setTemplate($this->getData('template'));
 92:         }
 93:     }
 94: 
 95:     /**
 96:      * Get relevant path to template
 97:      *
 98:      * @return string
 99:      */
100:     public function getTemplate()
101:     {
102:         return $this->_template;
103:     }
104: 
105:     /**
106:      * Set path to template used for generating block's output.
107:      *
108:      * @param string $template
109:      * @return Mage_Core_Block_Template
110:      */
111:     public function setTemplate($template)
112:     {
113:         $this->_template = $template;
114:         return $this;
115:     }
116: 
117:     /**
118:      * Get absolute path to template
119:      *
120:      * @return string
121:      */
122:     public function getTemplateFile()
123:     {
124:         $params = array('_relative'=>true);
125:         $area = $this->getArea();
126:         if ($area) {
127:             $params['_area'] = $area;
128:         }
129:         $templateName = Mage::getDesign()->getTemplateFilename($this->getTemplate(), $params);
130:         return $templateName;
131:     }
132: 
133:     /**
134:      * Get design area
135:      * @return string
136:      */
137:     public function getArea()
138:     {
139:         return $this->_getData('area');
140:     }
141: 
142:     /**
143:      * Assign variable
144:      *
145:      * @param   string|array $key
146:      * @param   mixed $value
147:      * @return  Mage_Core_Block_Template
148:      */
149:     public function assign($key, $value=null)
150:     {
151:         if (is_array($key)) {
152:             foreach ($key as $k=>$v) {
153:                 $this->assign($k, $v);
154:             }
155:         }
156:         else {
157:             $this->_viewVars[$key] = $value;
158:         }
159:         return $this;
160:     }
161: 
162:     /**
163:      * Set template location directory
164:      *
165:      * @param string $dir
166:      * @return Mage_Core_Block_Template
167:      */
168:     public function setScriptPath($dir)
169:     {
170:         $scriptPath = realpath($dir);
171:         if (strpos($scriptPath, realpath(Mage::getBaseDir('design'))) === 0 || $this->_getAllowSymlinks()) {
172:             $this->_viewDir = $dir;
173:         } else {
174:             Mage::log('Not valid script path:' . $dir, Zend_Log::CRIT, null, null, true);
175:         }
176:         return $this;
177:     }
178: 
179:     /**
180:      * Check if direct output is allowed for block
181:      *
182:      * @return bool
183:      */
184:     public function getDirectOutput()
185:     {
186:         if ($this->getLayout()) {
187:             return $this->getLayout()->getDirectOutput();
188:         }
189:         return false;
190:     }
191: 
192:     public function getShowTemplateHints()
193:     {
194:         if (is_null(self::$_showTemplateHints)) {
195:             self::$_showTemplateHints = Mage::getStoreConfig(self::XML_PATH_DEBUG_TEMPLATE_HINTS)
196:                 && Mage::helper('core')->isDevAllowed();
197:             self::$_showTemplateHintsBlocks = Mage::getStoreConfig(self::XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS)
198:                 && Mage::helper('core')->isDevAllowed();
199:         }
200:         return self::$_showTemplateHints;
201:     }
202: 
203:     /**
204:      * Retrieve block view from file (template)
205:      *
206:      * @param   string $fileName
207:      * @return  string
208:      */
209:     public function fetchView($fileName)
210:     {
211:         Varien_Profiler::start($fileName);
212: 
213:         // EXTR_SKIP protects from overriding
214:         // already defined variables
215:         extract ($this->_viewVars, EXTR_SKIP);
216:         $do = $this->getDirectOutput();
217: 
218:         if (!$do) {
219:             ob_start();
220:         }
221:         if ($this->getShowTemplateHints()) {
222:             echo <<<HTML
223: <div style="position:relative; border:1px dotted red; margin:6px 2px; padding:18px 2px 2px 2px; zoom:1;">
224: <div style="position:absolute; left:0; top:0; padding:2px 5px; background:red; color:white; font:normal 11px Arial;
225: text-align:left !important; z-index:998;" onmouseover="this.style.zIndex='999'"
226: onmouseout="this.style.zIndex='998'" title="{$fileName}">{$fileName}</div>
227: HTML;
228:             if (self::$_showTemplateHintsBlocks) {
229:                 $thisClass = get_class($this);
230:                 echo <<<HTML
231: <div style="position:absolute; right:0; top:0; padding:2px 5px; background:red; color:blue; font:normal 11px Arial;
232: text-align:left !important; z-index:998;" onmouseover="this.style.zIndex='999'" onmouseout="this.style.zIndex='998'"
233: title="{$thisClass}">{$thisClass}</div>
234: HTML;
235:             }
236:         }
237: 
238:         try {
239:             $includeFilePath = realpath($this->_viewDir . DS . $fileName);
240:             if (strpos($includeFilePath, realpath($this->_viewDir)) === 0 || $this->_getAllowSymlinks()) {
241:                 include $includeFilePath;
242:             } else {
243:                 Mage::log('Not valid template file:'.$fileName, Zend_Log::CRIT, null, null, true);
244:             }
245: 
246:         } catch (Exception $e) {
247:             ob_get_clean();
248:             throw $e;
249:         }
250: 
251:         if ($this->getShowTemplateHints()) {
252:             echo '</div>';
253:         }
254: 
255:         if (!$do) {
256:             $html = ob_get_clean();
257:         } else {
258:             $html = '';
259:         }
260:         Varien_Profiler::stop($fileName);
261:         return $html;
262:     }
263: 
264:     /**
265:      * Render block
266:      *
267:      * @return string
268:      */
269:     public function renderView()
270:     {
271:         $this->setScriptPath(Mage::getBaseDir('design'));
272:         $html = $this->fetchView($this->getTemplateFile());
273:         return $html;
274:     }
275: 
276:     /**
277:      * Render block HTML
278:      *
279:      * @return string
280:      */
281:     protected function _toHtml()
282:     {
283:         if (!$this->getTemplate()) {
284:             return '';
285:         }
286:         $html = $this->renderView();
287:         return $html;
288:     }
289: 
290:     /**
291:      * Get base url of the application
292:      *
293:      * @return string
294:      */
295:     public function getBaseUrl()
296:     {
297:         if (!$this->_baseUrl) {
298:             $this->_baseUrl = Mage::getBaseUrl();
299:         }
300:         return $this->_baseUrl;
301:     }
302: 
303:     /**
304:      * Get url of base javascript file
305:      *
306:      * To get url of skin javascript file use getSkinUrl()
307:      *
308:      * @param string $fileName
309:      * @return string
310:      */
311:     public function getJsUrl($fileName='')
312:     {
313:         if (!$this->_jsUrl) {
314:             $this->_jsUrl = Mage::getBaseUrl('js');
315:         }
316:         return $this->_jsUrl.$fileName;
317:     }
318: 
319:     /**
320:      * Get data from specified object
321:      *
322:      * @param Varien_Object $object
323:      * @param string $key
324:      * @return mixed
325:      */
326:     public function getObjectData(Varien_Object $object, $key)
327:     {
328:         return $object->getDataUsingMethod((string)$key);
329:     }
330: 
331:     /**
332:      * Get cache key informative items
333:      *
334:      * @return array
335:      */
336:     public function getCacheKeyInfo()
337:     {
338:         return array(
339:             'BLOCK_TPL',
340:             Mage::app()->getStore()->getCode(),
341:             $this->getTemplateFile(),
342:             'template' => $this->getTemplate()
343:         );
344:     }
345: 
346:     /**
347:      * Get is allowed symliks flag
348:      *
349:      * @return bool
350:      */
351:     protected function _getAllowSymlinks()
352:     {
353:         if (is_null($this->_allowSymlinks)) {
354:             $this->_allowSymlinks = Mage::getStoreConfigFlag(self::XML_PATH_TEMPLATE_ALLOW_SYMLINK);
355:         }
356:         return $this->_allowSymlinks;
357:     }
358: }
359: