Window: Differentiate between window and container id

This commit is contained in:
Johannes Meyer 2020-01-14 09:42:33 +01:00
parent d459e58aca
commit 2d3fc218db

View File

@ -3,29 +3,63 @@
namespace Icinga\Web; namespace Icinga\Web;
use Icinga\Web\Session; use Icinga\Application\Icinga;
use Icinga\Web\Session\SessionNamespace;
class Window class Window
{ {
const UNDEFINED = 'undefined'; const UNDEFINED = 'undefined';
/** @var Window */
protected static $window;
/** @var string */
protected $id; protected $id;
/** @var string */
protected $containerId;
public function __construct($id) public function __construct($id)
{ {
$this->id = $id; $parts = explode('_', $id, 2);
if (isset($parts[1])) {
$this->id = $parts[0];
$this->containerId = $id;
} else {
$this->id = $id;
}
} }
/**
* Get whether the window's ID is undefined
*
* @return bool
*/
public function isUndefined() public function isUndefined()
{ {
return $this->id === self::UNDEFINED; return $this->id === self::UNDEFINED;
} }
/**
* Get the window's ID
*
* @return string
*/
public function getId() public function getId()
{ {
return $this->id; return $this->id;
} }
/**
* Get the container's ID
*
* @return string
*/
public function getContainerId()
{
return $this->containerId ?: $this->id;
}
/** /**
* Return a window-aware session by using the given prefix * Return a window-aware session by using the given prefix
* *
@ -38,29 +72,54 @@ class Window
{ {
$session = Session::getSession(); $session = Session::getSession();
$identifier = $prefix . '_' . $this->id; $identifier = $prefix . '_' . $this->getId();
if ($reset && $session->hasNamespace($identifier)) { if ($reset && $session->hasNamespace($identifier)) {
$session->removeNamespace($identifier); $session->removeNamespace($identifier);
} }
$namespace = $session->getNamespace($identifier); $namespace = $session->getNamespace($identifier);
$nsUndef = $prefix . '_' . self::UNDEFINED; $nsUndef = $prefix . '_' . self::UNDEFINED;
if (!$reset && $this->id !== self::UNDEFINED && $session->hasNamespace($nsUndef)) { if (! $reset && ! $this->isUndefined() && $session->hasNamespace($nsUndef)) {
// We do not have any window-id on the very first request. Now we add // We may not have any window-id on the very first request. Now we add
// all values from the namespace, that has been created in this case, // all values from the namespace, that has been created in this case,
// to the new one and remove it afterwards. // to the new one and remove it afterwards.
foreach ($session->getNamespace($nsUndef) as $name => $value) { foreach ($session->getNamespace($nsUndef) as $name => $value) {
$namespace->set($name, $value); $namespace->set($name, $value);
} }
$session->removeNamespace($nsUndef); $session->removeNamespace($nsUndef);
} }
return $namespace; return $namespace;
} }
/**
* Generate a random string
*
* @return string
*/
public static function generateId() public static function generateId()
{ {
$letters = 'abcefghijklmnopqrstuvwxyz'; $letters = 'abcefghijklmnopqrstuvwxyz';
return substr(str_shuffle($letters), 0, 12); return substr(str_shuffle($letters), 0, 12);
} }
/**
* @return Window
*/
public static function getInstance()
{
if (! isset(static::$window)) {
$id = Icinga::app()->getRequest()->getHeader('X-Icinga-WindowId');
if (empty($id) || $id === static::UNDEFINED) {
$id = static::generateId();
Icinga::app()->getResponse()->setHeader('X-Icinga-WindowId', $id);
}
static::$window = new Window($id);
}
return static::$window;
}
} }