First commit, version 0.1 beta base nibiru framework
This commit is contained in:
Stephan Kasdorf
276
core/l/Dwoo/Template/File.php
Normal file
276
core/l/Dwoo/Template/File.php
Normal file
@@ -0,0 +1,276 @@
|
||||
<?php
|
||||
/**
|
||||
* Copyright (c) 2013-2017
|
||||
*
|
||||
* @category Library
|
||||
* @package Dwoo\Template
|
||||
* @author Jordi Boggiano <j.boggiano@seld.be>
|
||||
* @author David Sanchez <david38sanchez@gmail.com>
|
||||
* @copyright 2008-2013 Jordi Boggiano
|
||||
* @copyright 2013-2017 David Sanchez
|
||||
* @license http://dwoo.org/LICENSE LGPLv3
|
||||
* @version 1.4.0
|
||||
* @date 2017-03-16
|
||||
* @link http://dwoo.org/
|
||||
*/
|
||||
|
||||
namespace Dwoo\Template;
|
||||
|
||||
use Dwoo\Exception as DwooException;
|
||||
use Dwoo\Core as Core;
|
||||
use Dwoo\ICompiler;
|
||||
use Dwoo\ITemplate as ITemplate;
|
||||
use Dwoo\Security\Exception as SecurityException;
|
||||
use Dwoo\Template\File as TemplateFile;
|
||||
|
||||
/**
|
||||
* Represents a Dwoo template contained in a file.
|
||||
* This software is provided 'as-is', without any express or implied warranty.
|
||||
* In no event will the authors be held liable for any damages arising from the use of this software.
|
||||
*/
|
||||
class File extends Str
|
||||
{
|
||||
/**
|
||||
* Template filename.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $file;
|
||||
|
||||
/**
|
||||
* Include path(s) to look into to find this template.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $includePath = array();
|
||||
|
||||
/**
|
||||
* Resolved path cache when looking for a file in multiple include paths.
|
||||
* this is reset when the include path is changed
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $resolvedPath = null;
|
||||
|
||||
/**
|
||||
* Creates a template from a file.
|
||||
*
|
||||
* @param string $file the path to the template file, make sure it exists
|
||||
* @param int $cacheTime duration of the cache validity for this template,
|
||||
* if null it defaults to the Dwoo instance that will
|
||||
* render this template
|
||||
* @param string $cacheId the unique cache identifier of this page or anything else that
|
||||
* makes this template's content unique, if null it defaults
|
||||
* to the current url
|
||||
* @param string $compileId the unique compiled identifier, which is used to distinguish this
|
||||
* template from others, if null it defaults to the filename+bits of the path
|
||||
* @param mixed $includePath a string for a single path to look into for the given file, or an array of paths
|
||||
*/
|
||||
public function __construct($file, $cacheTime = null, $cacheId = null, $compileId = null, $includePath = array())
|
||||
{
|
||||
parent::__construct($file, $cacheTime, $cacheId, $compileId);
|
||||
$this->template = null;
|
||||
$this->file = $file;
|
||||
$this->name = basename($file);
|
||||
$this->setIncludePath($includePath);
|
||||
$this->compileId = $this->getResourceIdentifier();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the include path(s) to where the given template filename must be looked up.
|
||||
*
|
||||
* @param mixed $paths the path to look into, can be string for a single path or an array of paths
|
||||
*/
|
||||
public function setIncludePath($paths)
|
||||
{
|
||||
if (is_array($paths) === false) {
|
||||
$paths = array($paths);
|
||||
}
|
||||
|
||||
$this->includePath = $paths;
|
||||
$this->resolvedPath = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the current include path(s).
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getIncludePath()
|
||||
{
|
||||
return $this->includePath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if compiled file is valid (exists and it's the modification is greater or
|
||||
* equal to the modification time of the template file).
|
||||
*
|
||||
* @param string file
|
||||
*
|
||||
* @return bool True cache file existance and it's modification time
|
||||
*/
|
||||
protected function isValidCompiledFile($file)
|
||||
{
|
||||
return parent::isValidCompiledFile($file) && (int)$this->getUid() <= filemtime($file);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the template source of this template.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSource()
|
||||
{
|
||||
return file_get_contents($this->getResourceIdentifier());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the resource name for this template class.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getResourceName()
|
||||
{
|
||||
return 'file';
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns this template's source filename.
|
||||
*
|
||||
* @return string
|
||||
* @throws DwooException
|
||||
*/
|
||||
public function getResourceIdentifier()
|
||||
{
|
||||
if ($this->resolvedPath !== null) {
|
||||
return $this->resolvedPath;
|
||||
} elseif (array_filter($this->getIncludePath()) == array()) {
|
||||
return $this->file;
|
||||
} else {
|
||||
foreach ($this->getIncludePath() as $path) {
|
||||
$path = rtrim($path, DIRECTORY_SEPARATOR);
|
||||
if (file_exists($path . DIRECTORY_SEPARATOR . $this->file) === true) {
|
||||
return $this->resolvedPath = $path . DIRECTORY_SEPARATOR . $this->file;
|
||||
}
|
||||
}
|
||||
|
||||
throw new DwooException('Template "' . $this->file . '" could not be found in any of your include path(s)');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an unique value identifying the current version of this template,
|
||||
* in this case it's the unix timestamp of the last modification.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUid()
|
||||
{
|
||||
return (string)filemtime($this->getResourceIdentifier());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a new template object from the given include name, null if no include is
|
||||
* possible (resource not found), or false if include is not permitted by this resource type.
|
||||
*
|
||||
* @param Core $core the dwoo instance requiring it
|
||||
* @param mixed $resourceId the filename (relative to this template's dir) of the template to
|
||||
* include
|
||||
* @param int $cacheTime duration of the cache validity for this template, if null it defaults
|
||||
* to the Dwoo instance that will render this template if null it
|
||||
* defaults to the Dwoo instance that will render this template if null
|
||||
* it defaults to the Dwoo instance that will render this template
|
||||
* @param string $cacheId the unique cache identifier of this page or anything else that makes
|
||||
* this template's content unique, if null it defaults to the current
|
||||
* url makes this template's content unique, if null it defaults to the
|
||||
* current url makes this template's content unique, if null it defaults
|
||||
* to the current url
|
||||
* @param string $compileId the unique compiled identifier, which is used to distinguish this
|
||||
* template from others, if null it defaults to the filename+bits of the
|
||||
* path template from others, if null it defaults to the filename+bits
|
||||
* of the path template from others, if null it defaults to the
|
||||
* filename+bits of the path
|
||||
* @param ITemplate $parentTemplate the template that is requesting a new template object (through an
|
||||
* include, extends or any other plugin) an include, extends or any
|
||||
* other plugin) an include, extends or any other plugin)
|
||||
*
|
||||
* @return TemplateFile|null
|
||||
* @throws DwooException
|
||||
* @throws SecurityException
|
||||
*/
|
||||
public static function templateFactory(Core $core, $resourceId, $cacheTime = null, $cacheId = null,
|
||||
$compileId = null, ITemplate $parentTemplate = null)
|
||||
{
|
||||
if (DIRECTORY_SEPARATOR === '\\') {
|
||||
$resourceId = str_replace(array("\t", "\n", "\r", "\f", "\v"), array(
|
||||
'\\t',
|
||||
'\\n',
|
||||
'\\r',
|
||||
'\\f',
|
||||
'\\v'
|
||||
), $resourceId);
|
||||
}
|
||||
$resourceId = strtr($resourceId, '\\', '/');
|
||||
|
||||
$includePath = null;
|
||||
|
||||
if (file_exists($resourceId) === false) {
|
||||
if ($parentTemplate === null) {
|
||||
$parentTemplate = $core->getTemplate();
|
||||
}
|
||||
if ($parentTemplate instanceof self) {
|
||||
if ($includePath = $parentTemplate->getIncludePath()) {
|
||||
if (strstr($resourceId, '../')) {
|
||||
throw new DwooException('When using an include path you can not reference a template into a parent directory (using ../)');
|
||||
}
|
||||
} else {
|
||||
$resourceId = dirname($parentTemplate->getResourceIdentifier()) . DIRECTORY_SEPARATOR . $resourceId;
|
||||
if (file_exists($resourceId) === false) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
if ($policy = $core->getSecurityPolicy()) {
|
||||
while (true) {
|
||||
if (preg_match('{^([a-z]+?)://}i', $resourceId)) {
|
||||
throw new SecurityException('The security policy prevents you to read files from external sources : <em>' . $resourceId . '</em>.');
|
||||
}
|
||||
|
||||
if ($includePath) {
|
||||
break;
|
||||
}
|
||||
|
||||
$resourceId = realpath($resourceId);
|
||||
$dirs = $policy->getAllowedDirectories();
|
||||
foreach ($dirs as $dir => $dummy) {
|
||||
if (strpos($resourceId, $dir) === 0) {
|
||||
break 2;
|
||||
}
|
||||
}
|
||||
throw new SecurityException('The security policy prevents you to read <em>' . $resourceId . '</em>');
|
||||
}
|
||||
}
|
||||
|
||||
$class = 'Dwoo\Template\File';
|
||||
if ($parentTemplate) {
|
||||
$class = get_class($parentTemplate);
|
||||
}
|
||||
|
||||
return new $class($resourceId, $cacheTime, $cacheId, $compileId, $includePath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns some php code that will check if this template has been modified or not.
|
||||
* if the function returns null, the template will be instanciated and then the Uid checked
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIsModifiedCode()
|
||||
{
|
||||
return '"' . $this->getUid() . '" == filemtime(' . var_export($this->getResourceIdentifier(), true) . ')';
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user