2013-07-12 14:33:17 +02:00
|
|
|
<?php
|
2016-02-08 15:41:00 +01:00
|
|
|
/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
|
2013-07-12 14:33:17 +02:00
|
|
|
|
|
|
|
namespace Icinga\Web;
|
|
|
|
|
2015-01-23 09:36:45 +01:00
|
|
|
use Closure;
|
|
|
|
use Zend_View_Abstract;
|
2015-07-28 17:08:55 +02:00
|
|
|
use Icinga\Authentication\Auth;
|
2014-03-17 17:14:16 +01:00
|
|
|
use Icinga\Exception\ProgrammingError;
|
2014-05-27 23:41:46 +02:00
|
|
|
use Icinga\Util\Translator;
|
2013-07-12 14:33:17 +02:00
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Icinga view
|
2017-09-07 11:22:46 +02:00
|
|
|
*
|
|
|
|
* @method Url href($path = null, $params = null) {
|
|
|
|
* @param Url|string|null $path
|
|
|
|
* @param string[string]|null $params
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @method Url url($path = null, $params = null) {
|
|
|
|
* @param Url|string|null $path
|
|
|
|
* @param string[string]|null $params
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @method Url qlink($title, $url, $params = null, $properties = null, $escape = true) {
|
|
|
|
* @param string $title
|
|
|
|
* @param Url|string|null $url
|
|
|
|
* @param string[string]|null $params
|
|
|
|
* @param string[string]|null $properties
|
|
|
|
* @param bool $escape
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @method string img($url, $params = null, array $properties = array()) {
|
|
|
|
* @param Url|string|null $url
|
|
|
|
* @param string[string]|null $params
|
|
|
|
* @param string[string] $properties
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @method string icon($img, $title = null, array $properties = array()) {
|
|
|
|
* @param string $img
|
|
|
|
* @param string|null $title
|
|
|
|
* @param string[string] $properties
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @method string propertiesToString($properties) {
|
|
|
|
* @param string[string] $properties
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* @method string attributeToString($key, $value) {
|
|
|
|
* @param string $key
|
|
|
|
* @param string $value
|
|
|
|
* }
|
2013-08-20 19:26:44 +02:00
|
|
|
*/
|
|
|
|
class View extends Zend_View_Abstract
|
2013-07-12 14:33:17 +02:00
|
|
|
{
|
2014-03-17 17:14:16 +01:00
|
|
|
/**
|
|
|
|
* Charset to be used - we only support UTF-8
|
|
|
|
*/
|
|
|
|
const CHARSET = 'UTF-8';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The flags we use for htmlspecialchars depend on our PHP version
|
|
|
|
*/
|
|
|
|
private $replaceFlags;
|
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Flag to register stream wrapper
|
|
|
|
*
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
private $useViewStream = false;
|
2013-07-12 14:33:17 +02:00
|
|
|
|
2014-03-17 17:14:16 +01:00
|
|
|
/**
|
|
|
|
* Registered helper functions
|
|
|
|
*/
|
|
|
|
private $helperFunctions = array();
|
|
|
|
|
2015-01-23 09:36:45 +01:00
|
|
|
/**
|
|
|
|
* Authentication manager
|
|
|
|
*
|
2015-07-28 17:08:55 +02:00
|
|
|
* @var Auth|null
|
2015-01-23 09:36:45 +01:00
|
|
|
*/
|
|
|
|
private $auth;
|
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Create a new view object
|
|
|
|
*
|
|
|
|
* @param array $config
|
|
|
|
* @see Zend_View_Abstract::__construct
|
|
|
|
*/
|
2013-07-12 14:33:17 +02:00
|
|
|
public function __construct($config = array())
|
|
|
|
{
|
2013-08-20 19:26:44 +02:00
|
|
|
$this->useViewStream = (bool) ini_get('short_open_tag') ? false : true;
|
|
|
|
if ($this->useViewStream) {
|
2013-07-12 14:33:17 +02:00
|
|
|
if (!in_array('zend.view', stream_get_wrappers())) {
|
|
|
|
stream_wrapper_register('zend.view', '\Icinga\Web\ViewStream');
|
|
|
|
}
|
|
|
|
}
|
2014-03-17 17:14:16 +01:00
|
|
|
|
|
|
|
if (version_compare(PHP_VERSION, '5.4.0') >= 0) {
|
|
|
|
$this->replaceFlags = ENT_COMPAT | ENT_SUBSTITUTE | ENT_HTML5;
|
|
|
|
} else {
|
|
|
|
$this->replaceFlags = ENT_COMPAT | ENT_IGNORE;
|
|
|
|
}
|
|
|
|
|
2013-07-12 14:33:17 +02:00
|
|
|
parent::__construct($config);
|
|
|
|
}
|
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Initialize the view
|
|
|
|
*
|
|
|
|
* @see Zend_View_Abstract::init
|
|
|
|
*/
|
2013-07-12 14:33:17 +02:00
|
|
|
public function init()
|
|
|
|
{
|
|
|
|
$this->loadGlobalHelpers();
|
|
|
|
}
|
|
|
|
|
2014-03-17 17:14:16 +01:00
|
|
|
/**
|
|
|
|
* Escape the given value top be safely used in view scripts
|
|
|
|
*
|
|
|
|
* @param string $value The output to be escaped
|
|
|
|
* @return string
|
|
|
|
*/
|
2014-03-31 18:37:21 +02:00
|
|
|
public function escape($value)
|
|
|
|
{
|
2014-03-17 17:14:16 +01:00
|
|
|
return htmlspecialchars($value, $this->replaceFlags, self::CHARSET, true);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether a specific helper (closure) has been registered
|
|
|
|
*
|
|
|
|
* @param string $name The desired function name
|
|
|
|
* @return boolean
|
|
|
|
*/
|
|
|
|
public function hasHelperFunction($name)
|
|
|
|
{
|
|
|
|
return array_key_exists($name, $this->helperFunctions);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a new helper function
|
|
|
|
*
|
|
|
|
* @param string $name The desired function name
|
|
|
|
* @param Closure $function An anonymous function
|
2015-04-07 14:23:26 +02:00
|
|
|
* @return $this
|
2014-03-17 17:14:16 +01:00
|
|
|
*/
|
|
|
|
public function addHelperFunction($name, Closure $function)
|
|
|
|
{
|
|
|
|
if ($this->hasHelperFunction($name)) {
|
|
|
|
throw new ProgrammingError(
|
2014-08-26 11:15:19 +02:00
|
|
|
'Cannot assign the same helper function twice: "%s"',
|
|
|
|
$name
|
2014-03-31 18:37:21 +02:00
|
|
|
);
|
2014-03-17 17:14:16 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$this->helperFunctions[$name] = $function;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2016-07-11 09:07:01 +02:00
|
|
|
/**
|
|
|
|
* Set or overwrite a helper function
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
* @param Closure $function
|
|
|
|
*
|
|
|
|
* @return $this
|
|
|
|
*/
|
|
|
|
public function setHelperFunction($name, Closure $function)
|
|
|
|
{
|
|
|
|
$this->helperFunctions[$name] = $function;
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Drop a helper function
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
*
|
|
|
|
* @return $this
|
|
|
|
*/
|
|
|
|
public function dropHelperFunction($name)
|
|
|
|
{
|
|
|
|
unset($this->helperFunctions[$name]);
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2014-03-17 17:14:16 +01:00
|
|
|
/**
|
|
|
|
* Call a helper function
|
|
|
|
*
|
|
|
|
* @param string $name The desired function name
|
|
|
|
* @param Array $args Function arguments
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function callHelperFunction($name, $args)
|
|
|
|
{
|
|
|
|
return call_user_func_array(
|
|
|
|
$this->helperFunctions[$name],
|
|
|
|
$args
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2014-09-16 15:19:23 +02:00
|
|
|
public function translate($text, $context = null)
|
2014-05-27 23:41:46 +02:00
|
|
|
{
|
2014-09-16 15:19:23 +02:00
|
|
|
return Translator::translate($text, $this->translationDomain, $context);
|
2014-05-27 23:41:46 +02:00
|
|
|
}
|
|
|
|
|
2014-09-15 14:11:42 +02:00
|
|
|
/**
|
|
|
|
* Translate a plural string
|
|
|
|
*
|
|
|
|
* @see Translator::translatePlural()
|
|
|
|
*/
|
2014-09-16 15:19:23 +02:00
|
|
|
public function translatePlural($textSingular, $textPlural, $number, $context = null)
|
2014-09-11 18:04:10 +02:00
|
|
|
{
|
2014-09-16 15:19:23 +02:00
|
|
|
return Translator::translatePlural($textSingular, $textPlural, $number, $this->translationDomain, $context);
|
2014-09-11 18:04:10 +02:00
|
|
|
}
|
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Load helpers
|
|
|
|
*/
|
|
|
|
private function loadGlobalHelpers()
|
2013-07-12 14:33:17 +02:00
|
|
|
{
|
|
|
|
$pattern = dirname(__FILE__) . '/View/helpers/*.php';
|
|
|
|
$files = glob($pattern);
|
|
|
|
foreach ($files as $file) {
|
|
|
|
require_once $file;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-01-23 09:36:45 +01:00
|
|
|
/**
|
|
|
|
* Get the authentication manager
|
|
|
|
*
|
2015-07-28 17:08:55 +02:00
|
|
|
* @return Auth
|
2015-01-23 09:36:45 +01:00
|
|
|
*/
|
|
|
|
public function Auth()
|
|
|
|
{
|
|
|
|
if ($this->auth === null) {
|
2015-07-28 17:08:55 +02:00
|
|
|
$this->auth = Auth::getInstance();
|
2015-01-23 09:36:45 +01:00
|
|
|
}
|
|
|
|
return $this->auth;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Whether the current user has the given permission
|
|
|
|
*
|
|
|
|
* @param string $permission Name of the permission
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function hasPermission($permission)
|
|
|
|
{
|
|
|
|
return $this->Auth()->hasPermission($permission);
|
|
|
|
}
|
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Use to include the view script in a scope that only allows public
|
|
|
|
* members.
|
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*
|
|
|
|
* @see Zend_View_Abstract::run
|
|
|
|
*/
|
2013-07-12 14:33:17 +02:00
|
|
|
protected function _run()
|
|
|
|
{
|
|
|
|
foreach ($this->getVars() as $k => $v) {
|
|
|
|
// Exporting global variables to view scripts:
|
|
|
|
$$k = $v;
|
|
|
|
}
|
2013-08-20 19:26:44 +02:00
|
|
|
if ($this->useViewStream) {
|
|
|
|
include 'zend.view://' . func_get_arg(0);
|
2013-07-12 14:33:17 +02:00
|
|
|
} else {
|
|
|
|
include func_get_arg(0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-08-20 19:26:44 +02:00
|
|
|
/**
|
|
|
|
* Accesses a helper object from within a script
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
* @param array $args
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
2013-07-12 14:33:17 +02:00
|
|
|
public function __call($name, $args)
|
|
|
|
{
|
2014-03-17 17:14:16 +01:00
|
|
|
if ($this->hasHelperFunction($name)) {
|
|
|
|
return $this->callHelperFunction($name, $args);
|
2013-07-12 14:33:17 +02:00
|
|
|
} else {
|
|
|
|
return parent::__call($name, $args);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|