mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 07:24:13 +01:00
N°4621 Fix naming inconsistencies in sources/*
This commit is contained in:
Pierre Goiffon
178
sources/Application/Helper/Session.php
Normal file
178
sources/Application/Helper/Session.php
Normal file
@@ -0,0 +1,178 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (C) 2010-2021 Combodo SARL
|
||||
* @license http://opensource.org/licenses/AGPL-3.0
|
||||
*/
|
||||
|
||||
|
||||
namespace Combodo\iTop\Application\Helper;
|
||||
|
||||
/**
|
||||
* Session management
|
||||
* Allow early session close to have multiple ajax calls in parallel
|
||||
* When a session parameter is set, the session is re-opened if necessary
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
class Session
|
||||
{
|
||||
/** @var int|null */
|
||||
public static $iSessionId = null;
|
||||
/** @var bool */
|
||||
protected static $bIsInitialized = false;
|
||||
/** @var bool */
|
||||
protected static $bSessionStarted = false;
|
||||
|
||||
public static function Start()
|
||||
{
|
||||
self::$bIsInitialized = true;
|
||||
if (!self::$bSessionStarted) {
|
||||
session_name('itop-'.md5(APPROOT));
|
||||
if (!is_null(self::$iSessionId)) {
|
||||
session_id(self::$iSessionId);
|
||||
self::$bSessionStarted = session_start();
|
||||
} else {
|
||||
self::$bSessionStarted = session_start();
|
||||
self::$iSessionId = session_id();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public static function WriteClose()
|
||||
{
|
||||
if (self::$bSessionStarted) {
|
||||
session_write_close();
|
||||
self::$bSessionStarted = false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|array $key key to access to the session variable. To access to $_SESSION['a']['b'] $key must be ['a', 'b']
|
||||
* @param $value
|
||||
*/
|
||||
public static function Set($key, $value)
|
||||
{
|
||||
if (!isset($_SESSION) || self::Get($key) == $value) {
|
||||
return;
|
||||
}
|
||||
$aSession = $_SESSION;
|
||||
$sSessionVar = &$aSession;
|
||||
if (is_array($key)) {
|
||||
foreach ($key as $sKey) {
|
||||
$sSessionVar = &$sSessionVar[$sKey];
|
||||
}
|
||||
} else {
|
||||
$sSessionVar = &$sSessionVar[$key];
|
||||
}
|
||||
$sSessionVar = $value;
|
||||
if (!self::$bSessionStarted) {
|
||||
self::Start();
|
||||
$_SESSION = $aSession;
|
||||
self::WriteClose();
|
||||
} else {
|
||||
$_SESSION = $aSession;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|array $key key to access to the session variable. To access to $_SESSION['a']['b'] $key must be ['a', 'b']
|
||||
*/
|
||||
public static function Unset($key)
|
||||
{
|
||||
if (self::IsSet($key)) {
|
||||
$aSession = $_SESSION;
|
||||
$sSessionVar = &$aSession;
|
||||
$sKey = $key;
|
||||
// Get the array containing the last key in order to unset the correct variable
|
||||
if (is_array($key)) {
|
||||
$sPrevKey = null;
|
||||
foreach ($key as $sKey) {
|
||||
if (!is_null($sPrevKey)) {
|
||||
$sSessionVar = &$sSessionVar[$sPrevKey];
|
||||
}
|
||||
$sPrevKey = $sKey;
|
||||
}
|
||||
}
|
||||
if (!self::$bSessionStarted) {
|
||||
self::Start();
|
||||
unset($sSessionVar[$sKey]);
|
||||
$_SESSION = $aSession;
|
||||
self::WriteClose();
|
||||
} else {
|
||||
unset($sSessionVar[$sKey]);
|
||||
$_SESSION = $aSession;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|array $key key to access to the session variable. To access to $_SESSION['a']['b'] $key must be ['a', 'b']
|
||||
* @param $default
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public static function Get($key, $default = null)
|
||||
{
|
||||
if (isset($_SESSION)) {
|
||||
$aSession = $_SESSION;
|
||||
$sSessionVar = &$aSession;
|
||||
if (is_array($key)) {
|
||||
foreach ($key as $SKey) {
|
||||
$sSessionVar = &$sSessionVar[$SKey];
|
||||
}
|
||||
} else {
|
||||
$sSessionVar = &$sSessionVar[$key];
|
||||
}
|
||||
|
||||
if (isset($sSessionVar)) {
|
||||
return $sSessionVar;
|
||||
}
|
||||
}
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|array $key key to access to the session variable. To access to $_SESSION['a']['b'] $key must be ['a', 'b']
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function IsSet($key): bool
|
||||
{
|
||||
if (!isset($_SESSION)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$aSession = $_SESSION;
|
||||
$sSessionVar = &$aSession;
|
||||
if (is_array($key)) {
|
||||
foreach ($key as $SKey) {
|
||||
$sSessionVar = &$sSessionVar[$SKey];
|
||||
}
|
||||
} else {
|
||||
$sSessionVar = &$sSessionVar[$key];
|
||||
}
|
||||
|
||||
return isset($sSessionVar);
|
||||
}
|
||||
|
||||
public static function ListVariables(): array
|
||||
{
|
||||
return array_keys($_SESSION);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public static function IsInitialized(): bool
|
||||
{
|
||||
return self::$bIsInitialized;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool|string
|
||||
*/
|
||||
public static function GetLog()
|
||||
{
|
||||
return print_r($_SESSION, true);
|
||||
}
|
||||
}
|
||||
146
sources/Application/Helper/WebResourcesHelper.php
Normal file
146
sources/Application/Helper/WebResourcesHelper.php
Normal file
@@ -0,0 +1,146 @@
|
||||
<?php
|
||||
/*
|
||||
* @copyright Copyright (C) 2010-2021 Combodo SARL
|
||||
* @license http://opensource.org/licenses/AGPL-3.0
|
||||
*/
|
||||
|
||||
namespace Combodo\iTop\Application\Helper;
|
||||
|
||||
use WebPage;
|
||||
use utils;
|
||||
|
||||
/**
|
||||
* Class WebResourcesHelper
|
||||
*
|
||||
* This class aims at easing the import of web resources (external files, snippets) when necessary (opposite of imported them on all pages)
|
||||
*
|
||||
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
|
||||
* @package Combodo\iTop\Application\Helper
|
||||
* @since 3.0.0 N°3685
|
||||
*/
|
||||
class WebResourcesHelper
|
||||
{
|
||||
//---------------------------------
|
||||
// Fonts
|
||||
//---------------------------------
|
||||
|
||||
/**
|
||||
* Preload necessary fonts to display them as soon as possible when CSS rules are interpreted
|
||||
*
|
||||
* @return string[]
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function GetPreloadedFonts(): array
|
||||
{
|
||||
return [
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'css/font-combodo/combodo-webfont.woff2?v=2.1', 'type' => 'woff2'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'css/font-awesome/webfonts/fa-solid-900.woff2', 'type' => 'woff2'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'node_modules/@fontsource/raleway/files/raleway-all-400-normal.woff', 'type' => 'woff'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'node_modules/@fontsource/raleway/files/raleway-all-500-normal.woff', 'type' => 'woff'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'node_modules/@fontsource/raleway/files/raleway-all-600-normal.woff', 'type' => 'woff'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'node_modules/@fontsource/raleway/files/raleway-all-700-normal.woff', 'type' => 'woff'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'node_modules/@fontsource/raleway/files/raleway-all-400-italic.woff', 'type' => 'woff'],
|
||||
['font' => utils::GetAbsoluteUrlAppRoot().'node_modules/@fontsource/raleway/files/raleway-all-500-italic.woff', 'type' => 'woff'],
|
||||
];
|
||||
}
|
||||
|
||||
//---------------------------------
|
||||
// CKEditor
|
||||
//---------------------------------
|
||||
|
||||
/**
|
||||
* Add necessary files (JS) to be able to use CKEditor in the page
|
||||
*
|
||||
* @param \WebPage $oPage
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function EnableCKEditorToWebPage(WebPage &$oPage): void
|
||||
{
|
||||
//when ckeditor is loaded in ajax, CKEDITOR_BASEPATH is not well defined (this constant is used to load additional js)
|
||||
$oPage->add_script("if (! window.CKEDITOR_BASEPATH) { var CKEDITOR_BASEPATH = '".utils::GetAbsoluteUrlAppRoot()."js/ckeditor/';}");
|
||||
foreach (static::GetJSFilesRelPathsForCKEditor() as $sFile) {
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().$sFile);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[] Relative URLs to the JS files necessary for CKEditor
|
||||
*/
|
||||
public static function GetJSFilesRelPathsForCKEditor(): array
|
||||
{
|
||||
return [
|
||||
'js/ckeditor/ckeditor.js',
|
||||
'js/ckeditor/adapters/jquery.js',
|
||||
'js/ckeditor/plugins/codesnippet/lib/highlight/highlight.pack.js',
|
||||
'js/ckeditor.on-init.js',
|
||||
];
|
||||
}
|
||||
|
||||
//---------------------------------
|
||||
// D3/C3.js
|
||||
//---------------------------------
|
||||
|
||||
/**
|
||||
* Add necessary files (JS/CSS) to be able to use d3/c3.js in the page
|
||||
*
|
||||
* @param \WebPage $oPage
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function EnableC3JSToWebPage(WebPage &$oPage): void
|
||||
{
|
||||
foreach (static::GetCSSFilesRelPathsForC3JS() as $sFile) {
|
||||
$oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().$sFile);
|
||||
}
|
||||
|
||||
foreach (static::GetJSFilesRelPathsForC3JS() as $sFile) {
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().$sFile);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[] Relative URLs to the CSS files necessary for d3/c3.js
|
||||
*/
|
||||
public static function GetCSSFilesRelPathsForC3JS(): array
|
||||
{
|
||||
return [
|
||||
'css/c3.min.css',
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[] Relative URLs to the JS files necessary for d3/c3.js
|
||||
*/
|
||||
public static function GetJSFilesRelPathsForC3JS(): array
|
||||
{
|
||||
return [
|
||||
'js/d3.js',
|
||||
'js/c3.js',
|
||||
];
|
||||
}
|
||||
|
||||
//---------------------------------
|
||||
// SimpleGraph
|
||||
//---------------------------------
|
||||
|
||||
/**
|
||||
* Add necessary files (JS/CSS) to be able to use simple_graph in the page
|
||||
*
|
||||
* @param \WebPage $oPage
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function EnableSimpleGraphInWebPage(WebPage &$oPage): void
|
||||
{
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/raphael-min.js');
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/fraphael.js');
|
||||
$oPage->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/jquery.contextMenu.css');
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.contextMenu.js');
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.positionBy.js');
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.popupmenu.js');
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.mousewheel.js');
|
||||
$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/simple_graph.js');
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user