mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 07:24:13 +01:00
1742 lines
70 KiB
PHP
1742 lines
70 KiB
PHP
<?php
|
|
/*
|
|
* @copyright Copyright (C) 2010-2023 Combodo SARL
|
|
* @license http://opensource.org/licenses/AGPL-3.0
|
|
*/
|
|
|
|
use Combodo\iTop\Application\Helper\Session;
|
|
use Combodo\iTop\Application\TwigBase\Twig\TwigHelper;
|
|
use Combodo\iTop\Application\UI\Base\Component\Button\ButtonUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\DataTable\DataTableUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\Form\Form;
|
|
use Combodo\iTop\Application\UI\Base\Component\GlobalSearch\GlobalSearchHelper;
|
|
use Combodo\iTop\Application\UI\Base\Component\Input\InputUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\Panel\PanelUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\Title\TitleUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Component\Toolbar\ToolbarUIBlockFactory;
|
|
use Combodo\iTop\Application\UI\Base\Layout\PageContent\PageContentFactory;
|
|
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
|
|
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlockUIBlockFactory;
|
|
use Combodo\iTop\Application\WebPage\ErrorPage;
|
|
use Combodo\iTop\Application\WebPage\iTopWebPage;
|
|
use Combodo\iTop\Application\WebPage\WebPage;
|
|
use Combodo\iTop\Controller\Base\Layout\ObjectController;
|
|
use Combodo\iTop\Kernel;
|
|
use Combodo\iTop\Service\Router\Router;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
|
|
/**
|
|
* Displays a popup welcome message, once per session at maximum
|
|
* until the user unchecks the "Display welcome at startup"
|
|
*
|
|
* @param WebPage $oP The current web page for the display
|
|
*
|
|
* @return void
|
|
*/
|
|
function DisplayWelcomePopup(WebPage $oP)
|
|
{
|
|
if (!Session::IsSet('welcome'))
|
|
{
|
|
// Check, only once per session, if the popup should be displayed...
|
|
// If the user did not already ask for hiding it forever
|
|
$bPopup = appUserPreferences::GetPref('welcome_popup', true);
|
|
if ($bPopup)
|
|
{
|
|
TwigHelper::RenderIntoPage($oP, APPROOT.'/', 'templates/pages/backoffice/welcome_popup/welcome_popup');
|
|
Session::Set('welcome', 'ok');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Apply the 'next-action' to the given object or redirect to the page that prompts for additional information if needed
|
|
*
|
|
* @param $oP WebPage The page for the output
|
|
* @param $oObj CMDBObject The object to process
|
|
* @param $sNextAction string The code of the stimulus for the 'action' (i.e. Transition) to apply
|
|
*
|
|
* @throws \ApplicationException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
*/
|
|
function ApplyNextAction(Webpage $oP, CMDBObject $oObj, $sNextAction)
|
|
{
|
|
// Here handle the apply stimulus
|
|
$aTransitions = $oObj->EnumTransitions();
|
|
if (!isset($aTransitions[$sNextAction]))
|
|
{
|
|
// Invalid stimulus
|
|
throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sNextAction, $oObj->GetName(), $oObj->GetStateLabel()));
|
|
}
|
|
// Get the list of missing mandatory fields for the target state, considering only the changes from the previous form (i.e don't prompt twice)
|
|
$aExpectedAttributes = $oObj->GetTransitionAttributes($sNextAction);
|
|
|
|
if (count($aExpectedAttributes) == 0)
|
|
{
|
|
// If all the mandatory fields are already present, just apply the transition silently...
|
|
if ($oObj->ApplyStimulus($sNextAction))
|
|
{
|
|
$oObj->DBUpdate();
|
|
}
|
|
else
|
|
{
|
|
throw new ApplicationException(Dict::S('UI:FailedToApplyStimuli'));
|
|
}
|
|
ReloadAndDisplay($oP, $oObj);
|
|
}
|
|
else
|
|
{
|
|
// redirect to the 'stimulus' action
|
|
$oAppContext = new ApplicationContext();
|
|
//echo "<p>Missing Attributes <pre>".print_r($aExpectedAttributes, true)."</pre></p>\n";
|
|
|
|
$oP->add_header('Location: '.utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=stimulus&class='.get_class($oObj).'&stimulus='.$sNextAction.'&id='.$oObj->getKey().'&'.$oAppContext->GetForLink());
|
|
}
|
|
}
|
|
|
|
function ReloadAndDisplay($oPage, $oObj, $sMessageId = '', $sMessage = '', $sSeverity = null)
|
|
{
|
|
$oAppContext = new ApplicationContext();
|
|
if ($sMessageId != '')
|
|
{
|
|
cmdbAbstractObject::SetSessionMessage(get_class($oObj), $oObj->GetKey(), $sMessageId, $sMessage, $sSeverity, 0, true /* must not exist */);
|
|
}
|
|
$oPage->add_header('Location: '.utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=details&class='.get_class($oObj).'&id='.$oObj->getKey().'&'.$oAppContext->GetForLink());
|
|
}
|
|
|
|
/**
|
|
* Display the session messages relative to the object identified by its "message key" (class::id)
|
|
* @param string $sMessageKey
|
|
* @param WebPage $oPage
|
|
*/
|
|
function DisplayMessages(string $sMessageKey, WebPage $oPage)
|
|
{
|
|
$oPage->AddSessionMessages($sMessageKey);
|
|
}
|
|
|
|
/**
|
|
* Helper to update the breadrumb for the current object
|
|
* @param DBObject $oObj
|
|
* @param WebPage $oPage
|
|
* @throws \CoreException
|
|
* @throws \DictExceptionMissingString
|
|
*/
|
|
function SetObjectBreadCrumbEntry(DBObject $oObj, WebPage $oPage)
|
|
{
|
|
$sClass = get_class($oObj); // get the leaf class
|
|
$sIcon = MetaModel::GetClassIcon($sClass, false);
|
|
$sIconType = iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_IMAGE;
|
|
if ($sIcon == '')
|
|
{
|
|
$sIcon = 'fas fa-cube';
|
|
$sIconType = iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES;
|
|
}
|
|
$oPage->SetBreadCrumbEntry("ui-details-$sClass-".$oObj->GetKey(), $oObj->Get('friendlyname'), MetaModel::GetName($sClass).': '.$oObj->Get('friendlyname'), '', $sIcon, $sIconType);
|
|
}
|
|
|
|
/**
|
|
* Displays the result of a search request
|
|
* @param $oP WebPage Web page for the output
|
|
* @param $oFilter DBSearch The search of objects to display
|
|
* @param $bSearchForm boolean Whether or not to display the search form at the top the page
|
|
* @param $sBaseClass string The base class for the search (can be different from the actual class of the results)
|
|
* @param $sFormat string The format to use for the output: csv or html
|
|
* @param $bDoSearch bool True to display the search results below the search form
|
|
* @param $bSearchFormOpen bool True to display the search form fully expanded (only if $bSearchForm of course)
|
|
* @throws \CoreException
|
|
* @throws \DictExceptionMissingString
|
|
*/
|
|
function DisplaySearchSet($oP, $oFilter, $bSearchForm = true, $sBaseClass = '', $sFormat = '', $bDoSearch = true, $bSearchFormOpen = true, $aParams = [])
|
|
{
|
|
//search block
|
|
$oBlockForm = null;
|
|
if ($bSearchForm) {
|
|
$aParams['open'] = $bSearchFormOpen;
|
|
if (false === isset($aParams['table_id'])) {
|
|
$aParams['table_id'] = 'result_1';
|
|
}
|
|
if (!empty($sBaseClass)) {
|
|
$aParams['baseClass'] = $sBaseClass;
|
|
}
|
|
$oBlockForm = new DisplayBlock($oFilter, 'search', false /* Asynchronous */, $aParams);
|
|
|
|
if (!$bDoSearch) {
|
|
$oBlockForm->Display($oP, 0);
|
|
}
|
|
}
|
|
if ($bDoSearch) {
|
|
if (strtolower($sFormat) == 'csv') {
|
|
$oBlock = new DisplayBlock($oFilter, 'csv', false);
|
|
// Adjust the size of the Textarea containing the CSV to fit almost all the remaining space
|
|
$oP->add_ready_script(" $('#1>textarea').height($('#1').parent().height() - $('#0').outerHeight() - 30).width( $('#1').parent().width() - 20);"); // adjust the size of the block
|
|
} else {
|
|
$oBlock = new DisplayBlock($oFilter, 'list', false);
|
|
|
|
// Breadcrumb
|
|
//$iCount = $oBlock->GetDisplayedCount();
|
|
$sPageId = "ui-search-".$oFilter->GetClass();
|
|
$sLabel = MetaModel::GetName($oFilter->GetClass());
|
|
$oP->SetBreadCrumbEntry($sPageId, $sLabel, '', '', 'fas fa-search', iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES);
|
|
}
|
|
if ($bSearchForm) {
|
|
//add search block
|
|
$sTableId = utils::ReadParam('_table_id_', null, false, 'raw_data');
|
|
if ($sTableId == '') {
|
|
$sTableId = 'result_1';
|
|
}
|
|
$aExtraParams['table_id'] = $sTableId;
|
|
$aExtraParams['submit_on_load'] = false;
|
|
$oUIBlockForm = $oBlockForm->GetDisplay($oP, 'search_1', $aExtraParams);
|
|
//add result block
|
|
$oUIBlock = $oBlock->GetDisplay($oP, $sTableId);
|
|
$oUIBlock->AddCSSClasses(['display_block', 'sf_results_area']);
|
|
$oUIBlock->AddDataAttribute('target', 'search_results');
|
|
//$oUIBlockForm->AddSubBlock($oUIBlock);
|
|
$oP->AddUiBlock($oUIBlockForm);
|
|
$oUIBlockForm->AddSubBlock($oUIBlock);
|
|
} else {
|
|
$oBlock->Display($oP, 1);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Displays a form (checkboxes) to select the objects for which to apply a given action
|
|
* Only the objects for which the action is valid can be checked. By default all valid objects are checked
|
|
*
|
|
* @param WebPage $oP WebPage The page for output
|
|
* @param \DBSearch $oFilter DBSearch The filter that defines the list of objects
|
|
* @param string $sNextOperation string The next operation (code) to be executed when the form is submitted
|
|
* @param ActionChecker $oChecker ActionChecker The helper class/instance used to check for which object the action is valid
|
|
* @param array $aExtraFormParams
|
|
* @param array $aDisplayParams
|
|
*
|
|
* @since 3.0.0 $aDisplayParams parameter
|
|
*
|
|
* @throws \ApplicationException
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
*/
|
|
function DisplayMultipleSelectionForm(WebPage $oP, DBSearch $oFilter, string $sNextOperation, ActionChecker $oChecker, array $aExtraFormParams = [], array $aDisplayParams = [])
|
|
{
|
|
$oAppContext = new ApplicationContext();
|
|
$iBulkActionAllowed = $oChecker->IsAllowed();
|
|
$aExtraParams = array('selection_type' => 'multiple', 'selection_mode' => true, 'display_limit' => false, 'menu' => false);
|
|
if ($iBulkActionAllowed == UR_ALLOWED_DEPENDS) {
|
|
$aExtraParams['selection_enabled'] = $oChecker->GetAllowedIDs();
|
|
} else {
|
|
if (UR_ALLOWED_NO) {
|
|
throw new ApplicationException(Dict::Format('UI:ActionNotAllowed'));
|
|
}
|
|
}
|
|
|
|
$oForm = new Form();
|
|
$oForm->SetAction('./UI.php');
|
|
$oForm->AddSubBlock(InputUIBlockFactory::MakeForHidden('operation', $sNextOperation));
|
|
$oForm->AddSubBlock(InputUIBlockFactory::MakeForHidden('class', $oFilter->GetClass()));
|
|
$oForm->AddSubBlock(InputUIBlockFactory::MakeForHidden('filter', utils::HtmlEntities($oFilter->Serialize())));
|
|
$oForm->AddSubBlock(InputUIBlockFactory::MakeForHidden('transaction_id', utils::GetNewTransactionId()));
|
|
foreach ($aExtraFormParams as $sName => $sValue) {
|
|
$oForm->AddSubBlock(InputUIBlockFactory::MakeForHidden($sName, $sValue));
|
|
}
|
|
$oForm->AddSubBlock($oAppContext->GetForFormBlock());
|
|
$oDisplayBlock = new DisplayBlock($oFilter, 'list', false);
|
|
//by default all the elements are selected
|
|
$aExtraParams['selectionMode'] = 'negative';
|
|
if(array_key_exists('icon', $aDisplayParams) || array_key_exists('title', $aDisplayParams)){
|
|
$aExtraParams['surround_with_panel'] = true;
|
|
if(array_key_exists('icon', $aDisplayParams)){
|
|
$aExtraParams['panel_icon'] = $aDisplayParams['icon'];
|
|
}
|
|
if(array_key_exists('title', $aDisplayParams)){
|
|
$aExtraParams['panel_title'] = $aDisplayParams['title'];
|
|
}
|
|
}
|
|
$oForm->AddSubBlock($oDisplayBlock->GetDisplay($oP, 1, $aExtraParams));
|
|
$oToolbarButtons = ToolbarUIBlockFactory::MakeStandard(null);
|
|
$oToolbarButtons->AddCSSClass('ibo-toolbar--button');
|
|
$oForm->AddSubBlock($oToolbarButtons);
|
|
$oToolbarButtons->AddSubBlock(ButtonUIBlockFactory::MakeForCancel(Dict::S('UI:Button:Cancel'), 'cancel')->SetOnClickJsCode('window.history.back()'));
|
|
$oToolbarButtons->AddSubBlock(ButtonUIBlockFactory::MakeForPrimaryAction(Dict::S('UI:Button:Next'), 'next', Dict::S('UI:Button:Next'), true));
|
|
|
|
$oP->AddUiBlock($oForm);
|
|
}
|
|
|
|
/**
|
|
* @param $oP
|
|
* @param $aResults
|
|
* @param $sRelation
|
|
* @param $sDirection
|
|
* @param $oObj
|
|
* for operation : 'swf_navigator'
|
|
*
|
|
* @throws \DictExceptionMissingString
|
|
*/
|
|
function DisplayNavigatorListTab($oP, $aResults, $sRelation, $sDirection, $oObj)
|
|
{
|
|
$oP->SetCurrentTab('UI:RelationshipList');
|
|
$oImpactedObject = UIContentBlockUIBlockFactory::MakeStandard("impacted_objects", ['ibo-is-visible']);
|
|
$oP->AddSubBlock($oImpactedObject);
|
|
$oImpactedObjectList = UIContentBlockUIBlockFactory::MakeStandard("impacted_objects_lists", ['ibo-is-visible']);
|
|
$oImpactedObject->AddSubBlock($oImpactedObjectList);
|
|
$oImpactedObjectList->AddSubBlock(UIContentBlockUIBlockFactory::MakeStandard("impacted_objects_lists_placeholder", ['ibo-is-visible']));
|
|
}
|
|
|
|
function DisplayNavigatorGroupTab($oP)
|
|
{
|
|
$oP->SetCurrentTab('UI:RelationGroups');
|
|
$oP->add("<div id=\"impacted_groups\">");
|
|
$oP->add("<div id=\"impacted_groups_placeholder\"></div>");
|
|
|
|
/*
|
|
* Content is rendered asynchronously via pages/ajax.render.php?operation=relation_groups
|
|
*/
|
|
$oP->add("</div>");
|
|
}
|
|
|
|
/***********************************************************************************
|
|
*
|
|
* Main user interface page starts here
|
|
*
|
|
***********************************************************************************/
|
|
require_once('../approot.inc.php');
|
|
require_once(APPROOT.'/application/application.inc.php');
|
|
require_once(APPROOT.'/application/wizardhelper.class.inc.php');
|
|
|
|
require_once(APPROOT.'/application/startup.inc.php');
|
|
IssueLog::Trace('----- Request: '.utils::GetRequestUri(), LogChannels::WEB_REQUEST);
|
|
try
|
|
{
|
|
$oKPI = new ExecutionKPI();
|
|
$oKPI->ComputeAndReport('Data model loaded');
|
|
|
|
$oKPI = new ExecutionKPI();
|
|
|
|
require_once(APPROOT.'/application/loginwebpage.class.inc.php');
|
|
$sLoginMessage = LoginWebPage::DoLogin(); // Check user rights and prompt if needed
|
|
$oAppContext = new ApplicationContext();
|
|
|
|
$oKPI->ComputeAndReport('User login');
|
|
|
|
// First check if we can redirect the route to a dedicated controller
|
|
// IMPORTANT: Even though iTop router is deprecated, we must ensure old URLs keep working (for a while) as they can be used in received notifications, bookmarks, extensions, ...
|
|
$sRoute = utils::ReadParam('route', '', false, utils::ENUM_SANITIZATION_FILTER_ROUTE);
|
|
$oRouter = Router::GetInstance();
|
|
if ($oRouter->CanDispatchRoute($sRoute)) {
|
|
$mResponse = $oRouter->DispatchRoute($sRoute);
|
|
|
|
// If response isn't a WebPage, it is most likely that the output already occured, stop the script.
|
|
// Note that this is done here and not directly in the Router::DispatchRoute() so custom endpoint can handle null responses their own way.
|
|
if (false === ($mResponse instanceof WebPage)) {
|
|
die();
|
|
}
|
|
|
|
// Response is a WebPage, let's handle it like legacy operations
|
|
$oP = $mResponse;
|
|
}
|
|
// Otherwise, use legacy operation
|
|
else {
|
|
$operation = utils::ReadParam('operation', '', false, utils::ENUM_SANITIZATION_FILTER_OPERATION);
|
|
$bPrintable = (utils::ReadParam('printable', 0) == '1');
|
|
|
|
$oP = new iTopWebPage(Dict::S('UI:WelcomeToITop'), $bPrintable);
|
|
$oP->SetMessage($sLoginMessage);
|
|
|
|
//-----------------------------------------------------------------------------------------------------------------
|
|
//
|
|
// Mind that the following backward compatibility pattern is also present in the `pages/ajax.render.php` endpoint
|
|
//
|
|
//-----------------------------------------------------------------------------------------------------------------
|
|
//
|
|
// Kept for backward compatibility with iTop 3.1.x notification URLs, don't remove
|
|
// Non-dispatchable "routes" (iTop 3.1) are mapped to their old corresponding "operation" (iTop 3.0 and older), in order to be later redirected to the proper new URLs (iTop 3.2 and newer)
|
|
switch ($sRoute) {
|
|
case 'object.new':
|
|
case 'object.apply_new':
|
|
case 'object.modify':
|
|
case 'object.apply_modify':
|
|
$operation = str_ireplace("object.", "", $sRoute);
|
|
break;
|
|
}
|
|
|
|
if (utils::IsNotNullOrEmptyString($sRoute)) {
|
|
DeprecatedCallsLog::Debug("Calling UI.php with a deprecated \"route\" parameter that was migrated to Symfony router, redirecting to fallback \"operation\" parameter. If URI comes from a custom code, migrate it. If URI comes from an old notification, mind that it may not work in future versions.", LogChannels::ROUTER, [
|
|
"request_uri" => $_SERVER["REQUEST_URI"],
|
|
"route" => $sRoute,
|
|
"fallback_operation" => $operation,
|
|
]);
|
|
}
|
|
|
|
// Kept for backward compatibility with iTop 3.0 and older notification URLs, don't remove
|
|
// These operations have been migrated to Symfony router, we need to redirect to the proper new URLs
|
|
switch ($operation) {
|
|
/** @deprecated 3.1.0 Use the "b_object_new" Symfony route instead */
|
|
case 'new':
|
|
/** @deprecated 3.1.0 Use the "b_object_apply_new" Symfony route instead */
|
|
case 'apply_new':
|
|
/** @deprecated 3.1.0 Use the "b_object_modify" Symfony route instead */
|
|
case 'modify':
|
|
/** @deprecated 3.1.0 Use the "b_object_apply_new" Symfony route instead */
|
|
case 'apply_modify':
|
|
// Start a Symfony kernel and redirect to the corresponding route / controller
|
|
$oKernel = new Kernel("prod", false);
|
|
$oRequest = Request::createFromGlobals();
|
|
|
|
/** @var string $sRouteName Route name to redirect to */
|
|
$sRouteName = '';
|
|
/** @var string[] $aPath Parts of the Symfony route path (eg. for "/object/{sCLass}/{sId}", ["sClass" => "UserRequest", "sId" => "123"]) */
|
|
$aPath = [];
|
|
/** @var string[] $aQuery Query parameters of the request -parameters after the "?" of the URI- (eg. for "/object/UserRequest/123?a=1&b=2", ["a" => 1, "b" => 2]) */
|
|
$aQuery = $oRequest->query->all();
|
|
|
|
// Find controller corresponding to the old "operation"
|
|
switch ($operation) {
|
|
case 'new':
|
|
$sRouteName = 'b_object_new';
|
|
$aPath['_controller'] = ObjectController::class . "::OperationNew";
|
|
$aPath['sClass'] = utils::ReadParam('class', null, false, utils::ENUM_SANITIZATION_FILTER_CLASS);
|
|
break;
|
|
|
|
case 'apply_new':
|
|
$sRouteName = 'b_object_apply_new';
|
|
$aPath['_controller'] = ObjectController::class . "::OperationApplyNew";
|
|
break;
|
|
|
|
case 'modify':
|
|
$sRouteName = 'b_object_modify';
|
|
$aPath['_controller'] = ObjectController::class . "::OperationModify";
|
|
$aPath['sClass'] = utils::ReadParam('class', '', false, utils::ENUM_SANITIZATION_FILTER_CLASS);
|
|
$aPath['sId'] = utils::ReadParam('id', '');
|
|
break;
|
|
|
|
case 'apply_modify':
|
|
$sRouteName = 'b_object_apply_modify';
|
|
$aPath['_controller'] = ObjectController::class . "::OperationApplyModify";
|
|
break;
|
|
}
|
|
|
|
// Redirect
|
|
///** @var \Symfony\Component\Routing\Generator\UrlGeneratorInterface $oUrlGenerator */
|
|
//$oResponse = $oKernel->handle($oRequest);
|
|
//$oUrlGenerator = $oKernel->getContainer()->get('router');
|
|
|
|
// - Solution 1: Simplement redirection
|
|
// Pros:
|
|
// - Redirects to the new URL
|
|
// - Keeps query parameters
|
|
// - Uses the real Symfony kernel as it will be a complete new process
|
|
// Cons:
|
|
// - Loose posted parameters if any (but could be ok as we essentially do this for notifications / bookmarks); extensions will be migrated
|
|
// - Makes an HTTP redirection, could be an issue in some infras? I don't think so, we already do it in several places
|
|
/*$sRedirectUrl = $oUrlGenerator->generate($sRouteName, $aPath + $aQuery);
|
|
// Generated URL is based on the script the Kernel is instantiated in, so we have to correct it to point to the new unique endpoint
|
|
$sRedirectUrl = str_ireplace("pages/UI.php", "app.php", $sRedirectUrl);
|
|
header("location: $sRedirectUrl");
|
|
die();*/
|
|
|
|
// - Solution 2: Symfony redirection
|
|
// Pros:
|
|
// - Redirects to the new URL
|
|
// - Keeps query parameters
|
|
// - Uses the real Symfony kernel as it will be a complete new process
|
|
// - Keeps redirection working even though there are deprecated messages printed before headers are send (unlike with solution 1)
|
|
// Cons:
|
|
// - Loose posted parameters if any (but could be ok as we essentially do this for notifications / bookmarks); extensions will be migrated
|
|
// - Makes an HTTP redirection, could be an issue in some infras? I don't think so, we already do it in several places
|
|
/*$sRedirectUrl = $oUrlGenerator->generate($sRouteName, $aPath + $aQuery);
|
|
// Generated URL is based on the script the Kernel is instantiated in, so we have to correct it to point to the new unique endpoint
|
|
$sRedirectUrl = str_ireplace("pages/UI.php", "app.php", $sRedirectUrl);
|
|
$oResponse = new RedirectResponse($sRedirectUrl);
|
|
$oResponse->send();
|
|
$oKernel->terminate($oRequest, $oResponse);
|
|
die();*/
|
|
|
|
|
|
// - Solution 3: Internal redirection
|
|
// Pros:
|
|
// - Keeps query parameters
|
|
// - Keeps posted parameters (essential for submission URLs)
|
|
// Cons:
|
|
// - Still displays the old URL
|
|
// - Uses a not so well-formed Symfony kernel?
|
|
$oSubRequest = $oRequest->duplicate($aQuery, null, $aPath);
|
|
$oResponse = $oKernel->handle($oSubRequest, \Symfony\Component\HttpKernel\HttpKernelInterface::SUB_REQUEST);
|
|
$oResponse->send();
|
|
$oKernel->terminate($oSubRequest, $oResponse);
|
|
die();
|
|
}
|
|
|
|
// All the following operations use advanced forms that require more javascript to be loaded
|
|
switch($operation)
|
|
{
|
|
case 'new': // Form to create a new object
|
|
case 'form_for_modify_all': // Form to modify multiple objects (bulk modify)
|
|
case 'bulk_stimulus': // For to apply a stimulus to multiple objects
|
|
case 'stimulus': // Form displayed when applying a stimulus (state change)
|
|
case 'apply_stimulus': // Form displayed when applying a stimulus (state change)
|
|
foreach (ObjectController::EnumRequiredForModificationJsFilesRelPaths() as $sJsFileRelPath) {
|
|
$oP->add_linked_script(utils::GetAbsoluteUrlAppRoot() . "$sJsFileRelPath");
|
|
}
|
|
break;
|
|
}
|
|
|
|
switch($operation)
|
|
{
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'details': // Details of an object
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
|
|
if (empty($sClass)) {
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'class'));
|
|
}
|
|
|
|
$id = utils::ReadParam('id', null);
|
|
if (false === is_null($id)) {
|
|
if (is_numeric($id)) {
|
|
$oObj = MetaModel::GetObject($sClass, $id, false /* MustBeFound */);
|
|
} else {
|
|
$oObj = MetaModel::GetObjectByName($sClass, $id, false /* MustBeFound */);
|
|
}
|
|
} else {
|
|
$sAttCode = utils::ReadParam('attcode', '', false, utils::ENUM_SANITIZATION_FILTER_FIELD_NAME);
|
|
$sAttValue = utils::ReadParam('attvalue', '', false, utils::ENUM_SANITIZATION_FILTER_RAW_DATA);
|
|
|
|
if ((strlen($sAttCode) === 0) || (strlen($sAttValue) === 0)) {
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'id'));
|
|
}
|
|
|
|
$oObj = MetaModel::GetObjectByColumn($sClass, $sAttCode, $sAttValue, true);
|
|
}
|
|
|
|
if (is_null($oObj)) {
|
|
// Check anyhow if there is a message for this object (like you've just created it)
|
|
$sMessageKey = $sClass.'::'.$id;
|
|
DisplayMessages($sMessageKey, $oP);
|
|
$oP->set_title(Dict::S('UI:ErrorPageTitle'));
|
|
|
|
// Attempt to load the object in archive mode
|
|
utils::PushArchiveMode(true);
|
|
if (is_numeric($id)) {
|
|
$oObj = MetaModel::GetObject($sClass, $id, false /* MustBeFound */);
|
|
}
|
|
else
|
|
{
|
|
$oObj = MetaModel::GetObjectByName($sClass, $id, false /* MustBeFound */);
|
|
}
|
|
utils::PopArchiveMode();
|
|
if (is_null($oObj))
|
|
{
|
|
$oP->P(Dict::S('UI:ObjectDoesNotExist'));
|
|
}
|
|
else
|
|
{
|
|
SetObjectBreadCrumbEntry($oObj, $oP);
|
|
$oP->P(Dict::S('UI:ObjectArchived'));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
$oObj->Reload();
|
|
}
|
|
catch(Exception $e)
|
|
{
|
|
// Probably not allowed to see this instance of a derived class
|
|
|
|
// Check anyhow if there is a message for this object (like you've just created it)
|
|
$sMessageKey = $sClass.'::'.$id;
|
|
DisplayMessages($sMessageKey, $oP);
|
|
|
|
$oObj = null;
|
|
$oP->set_title(Dict::S('UI:ErrorPageTitle'));
|
|
$oP->P(Dict::S('UI:ObjectDoesNotExist'));
|
|
}
|
|
if (!is_null($oObj))
|
|
{
|
|
SetObjectBreadCrumbEntry($oObj, $oP);
|
|
|
|
// The object could be listed, check if it is actually allowed to view it
|
|
$oSet = CMDBObjectSet::FromObject($oObj);
|
|
if (UserRights::IsActionAllowed($sClass, UR_ACTION_READ, $oSet) == UR_ALLOWED_NO) {
|
|
throw new SecurityException('User not allowed to view this object', array('class' => $sClass, 'id' => $id));
|
|
}
|
|
|
|
$sClassLabel = MetaModel::GetName($sClass);
|
|
$oP->set_title(Dict::Format('UI:DetailsPageTitle', $oObj->GetRawName(), $sClassLabel)); // Set title will take care of the encoding
|
|
$oP->SetContentLayout(PageContentFactory::MakeForObjectDetails($oObj, $oP->IsPrintableVersion() ? cmdbAbstractObject::ENUM_DISPLAY_MODE_PRINT : cmdbAbstractObject::ENUM_DISPLAY_MODE_VIEW));
|
|
$oObj->DisplayDetails($oP);
|
|
}
|
|
}
|
|
break;
|
|
|
|
case 'release_lock_and_details':
|
|
$oP->DisableBreadCrumb();
|
|
|
|
// Retrieve object
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$id = utils::ReadParam('id', '');
|
|
$oObj = MetaModel::GetObject($sClass, $id);
|
|
|
|
// Retrieve ownership token
|
|
$sToken = utils::ReadParam('token', '');
|
|
if ($sToken != '')
|
|
{
|
|
iTopOwnershipLock::ReleaseLock($sClass, $id, $sToken);
|
|
}
|
|
|
|
$oP->SetContentLayout(PageContentFactory::MakeForObjectDetails($oObj, cmdbAbstractObject::ENUM_DISPLAY_MODE_VIEW));
|
|
cmdbAbstractObject::ReloadAndDisplay($oP, $oObj, array('operation' => 'details'));
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'search_oql': // OQL query
|
|
$oSearchContext = new ContextTag(ContextTag::TAG_OBJECT_SEARCH);
|
|
$sOQLClass = utils::ReadParam('oql_class', '', false, 'class');
|
|
$sBaseClass = utils::ReadParam('base_class', $sOQLClass, false, 'class');
|
|
$sOQLClause = utils::ReadParam('oql_clause', '', false, 'raw_data');
|
|
$sFormat = utils::ReadParam('format', '');
|
|
$bSearchForm = utils::ReadParam('search_form', true);
|
|
$sTitle = utils::ReadParam('title', 'UI:SearchResultsPageTitle');
|
|
if (empty($sOQLClass)) {
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'oql_class'));
|
|
}
|
|
$oP->set_title(Dict::S($sTitle));
|
|
$oP->add('<h1>'.Dict::S($sTitle).'</h1>');
|
|
$sOQL = "SELECT $sOQLClass $sOQLClause";
|
|
try {
|
|
$oFilter = DBObjectSearch::FromOQL($sOQL);
|
|
DisplaySearchSet($oP, $oFilter, $bSearchForm, $sBaseClass, $sFormat);
|
|
}
|
|
catch(CoreException $e) {
|
|
$oFilter = new DBObjectSearch($sOQLClass);
|
|
$oSet = new DBObjectSet($oFilter);
|
|
if ($bSearchForm) {
|
|
$oBlock = new DisplayBlock($oFilter, 'search', false);
|
|
$oBlock->Display($oP, 0, array('table_id' => 'search-widget-result-outer'));
|
|
}
|
|
$oP->add('<div id="search-widget-result-outer"><p><b>'.Dict::Format('UI:Error:IncorrectOQLQuery_Message', $e->getHtmlDesc()).'</b></p></div>');
|
|
}
|
|
catch(Exception $e) {
|
|
$oP->P('<b>'.Dict::Format('UI:Error:AnErrorOccuredWhileRunningTheQuery_Message', $e->getMessage()).'</b>');
|
|
}
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'search_form': // Search form
|
|
$oSearchContext = new ContextTag(ContextTag::TAG_OBJECT_SEARCH);
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$sFormat = utils::ReadParam('format', 'html');
|
|
$bSearchForm = utils::ReadParam('search_form', true);
|
|
$bDoSearch = utils::ReadParam('do_search', true);
|
|
if (empty($sClass)) {
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'class'));
|
|
}
|
|
$oP->set_title(Dict::S('UI:SearchResultsPageTitle'));
|
|
$oFilter = new DBObjectSearch($sClass);
|
|
DisplaySearchSet($oP, $oFilter, $bSearchForm, '' /* sBaseClass */, $sFormat, $bDoSearch, true /* Search Form Expanded */);
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'search': // Serialized DBSearch
|
|
$oSearchContext = new ContextTag(ContextTag::TAG_OBJECT_SEARCH);
|
|
$sFilter = utils::ReadParam('filter', '', false, 'raw_data');
|
|
$sFormat = utils::ReadParam('format', '');
|
|
$bSearchForm = utils::ReadParam('search_form', true);
|
|
if (empty($sFilter))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'filter'));
|
|
}
|
|
$oP->set_title(Dict::S('UI:SearchResultsPageTitle'));
|
|
$oFilter = DBSearch::unserialize($sFilter); // TO DO : check that the filter is valid
|
|
$oFilter->UpdateContextFromUser();
|
|
|
|
//FIXME Params won't work as expected :(
|
|
// During the ajax call fetching the datatable data, the URL is rewritten and the info are lost, and we are getting a worse result :(
|
|
// $sParams = utils::ReadParam('aParams', '{}', false, \utils::ENUM_SANITIZATION_FILTER_RAW_DATA);
|
|
// $aParams = json_decode($sParams, true);
|
|
|
|
DisplaySearchSet($oP, $oFilter, $bSearchForm, '' /* sBaseClass */, $sFormat); //, true, true, $aParams
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'full_text': // Global "google-like" search
|
|
$oP->DisableBreadCrumb();
|
|
$sQuery = trim(utils::ReadParam('text', '', false, 'raw_data'));
|
|
$iTune = utils::ReadParam('tune', 0);
|
|
if (empty($sQuery))
|
|
{
|
|
$oP->p(Dict::S('UI:Search:NoSearch'));
|
|
}
|
|
else
|
|
{
|
|
$iErrors = 0;
|
|
$sFullText = $sQuery;
|
|
|
|
// Check if a class name/label is supplied to limit the search
|
|
$sClassName = '';
|
|
if (preg_match('/^([^\"]+):(.+)$/', $sFullText, $aMatches))
|
|
{
|
|
$sClassName = $aMatches[1];
|
|
if (MetaModel::IsValidClass($sClassName))
|
|
{
|
|
$sFullText = trim($aMatches[2]);
|
|
}
|
|
elseif ($sClassName = MetaModel::GetClassFromLabel($sClassName, false /* => not case sensitive */))
|
|
{
|
|
$sFullText = trim($aMatches[2]);
|
|
}
|
|
}
|
|
if (preg_match('/^"(.*)"$/', $sFullText, $aMatches))
|
|
{
|
|
// The text is surrounded by double-quotes, remove the quotes and treat it as one single expression
|
|
$aFullTextNeedles = array($aMatches[1]);
|
|
}
|
|
else
|
|
{
|
|
// Split the text on the blanks and treat this as a search for <word1> AND <word2> AND <word3>
|
|
$aExplodedFullTextNeedles = explode(' ', $sFullText);
|
|
$aFullTextNeedles = [];
|
|
foreach ($aExplodedFullTextNeedles as $sValue) {
|
|
if (strlen($sValue) > 0) {
|
|
$aFullTextNeedles[] = $sValue;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Save search to history
|
|
// - Prepare icon
|
|
$sQueryIconUrl = null;
|
|
if(!empty($sClassName)) {
|
|
$sQueryIconUrl = MetaModel::GetClassIcon($sClassName, false);
|
|
}
|
|
// - Prepare label
|
|
$sQueryLabel = null;
|
|
if ($sQuery !== $sFullText) {
|
|
$sQueryLabel = $sFullText;
|
|
}
|
|
GlobalSearchHelper::AddQueryToHistory(utils::EscapeHtml($sQuery), $sQueryIconUrl, $sQueryLabel);
|
|
$oP->SetBlockParam('ibo-global-search.sQuery', utils::EscapeHtml($sQuery));
|
|
|
|
// Check the needle length
|
|
$iMinLenth = MetaModel::GetConfig()->Get('full_text_needle_min');
|
|
foreach ($aFullTextNeedles as $sNeedle) {
|
|
if (strlen($sNeedle) < $iMinLenth) {
|
|
$oP->p(Dict::Format('UI:Search:NeedleTooShort', $sNeedle, $iMinLenth));
|
|
$key = array_search($sNeedle, $aFullTextNeedles);
|
|
if ($key !== false)
|
|
{
|
|
unset($aFullTextNeedles[$key]);
|
|
}
|
|
}
|
|
}
|
|
if(empty($aFullTextNeedles))
|
|
{
|
|
$oP->p(Dict::S('UI:Search:NoSearch'));
|
|
break;
|
|
}
|
|
$sFullText = implode(' ', $aFullTextNeedles);
|
|
|
|
// Sanity check of the accelerators
|
|
/** @var array $aAccelerators */
|
|
$aAccelerators = MetaModel::GetConfig()->Get('full_text_accelerators');
|
|
foreach ($aAccelerators as $sClass => $aAccelerator)
|
|
{
|
|
try
|
|
{
|
|
$bSkip = array_key_exists('skip', $aAccelerator) ? $aAccelerator['skip'] : false;
|
|
if (!$bSkip)
|
|
{
|
|
$oSearch = DBObjectSearch::FromOQL($aAccelerator['query']);
|
|
if ($sClass != $oSearch->GetClass())
|
|
{
|
|
$oP->p("Full text accelerator for class '$sClass': searched class mismatch (".$oSearch->GetClass().")");
|
|
$iErrors++;
|
|
}
|
|
}
|
|
}
|
|
catch (OqlException $e)
|
|
{
|
|
$oP->p("Full text accelerator for class '$sClass': ".$e->getHtmlDesc());
|
|
$iErrors++;
|
|
}
|
|
}
|
|
|
|
if ($iErrors == 0)
|
|
{
|
|
$oP->set_title(Dict::S('UI:SearchResultsPageTitle'));
|
|
$sPageId = "ui-global-search";
|
|
$sLabel = Dict::S('UI:SearchResultsTitle');
|
|
$sDescription = Dict::S('UI:SearchResultsTitle+');
|
|
$oP->SetBreadCrumbEntry($sPageId, $sLabel, $sDescription, '', 'fas fa-search', iTopWebPage::ENUM_BREADCRUMB_ENTRY_ICON_TYPE_CSS_CLASSES);
|
|
$oP->add("<div style=\"padding: 10px;\">\n");
|
|
$oP->add("<div class=\"header_message\" id=\"full_text_progress\" style=\"position: fixed; background-color: #cccccc; opacity: 0.7; padding: 1.5em;\">\n");
|
|
$oP->add('<img id="full_text_indicator" src="' . utils::GetAbsoluteUrlAppRoot() . 'images/indicator.gif"> <span style="padding: 1.5em;">'.Dict::Format('UI:Search:Ongoing', utils::EscapeHtml($sFullText)).'</span>');
|
|
$oP->add("</div>\n");
|
|
$oP->add("<div id=\"full_text_results\">\n");
|
|
$oP->add("<div id=\"full_text_progress_placeholder\" style=\"padding: 1.5em;\"> </div>\n");
|
|
$oP->add("<h2>".Dict::Format('UI:FullTextSearchTitle_Text', utils::EscapeHtml($sFullText))."</h2>");
|
|
$oP->add("</div>\n");
|
|
$oP->add("</div>\n");
|
|
$sJSClass = addslashes($sClassName);
|
|
$sJSNeedles = json_encode($aFullTextNeedles);
|
|
$oP->add_ready_script(
|
|
<<<EOF
|
|
var oParams = {operation: 'full_text_search', position: 0, 'classname': '$sJSClass', needles: $sJSNeedles, tune: $iTune};
|
|
$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', oParams, function(data) {
|
|
$('#full_text_results').append(data);
|
|
});
|
|
EOF
|
|
);
|
|
if ($iTune > 0)
|
|
{
|
|
$oP->add_script("var oTimeStatistics = {};");
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'select_for_modify_all': // Select the list of objects to be modified (bulk modify)
|
|
UI::OperationSelectForModifyAll($oP);
|
|
break;
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'form_for_modify_all': // Form to modify multiple objects (bulk modify)
|
|
UI::OperationFormForModifyAll($oP, $oAppContext);
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'preview_or_modify_all': // Preview or apply bulk modify
|
|
UI::OperationPreviewOrModifyAll($oP, $oAppContext);
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'select_for_deletion': // Select multiple objects for deletion
|
|
$oP->DisableBreadCrumb();
|
|
$sFilter = utils::ReadParam('filter', '', false, 'raw_data');
|
|
if (empty($sFilter))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'filter'));
|
|
}
|
|
$oP->set_title(Dict::S('UI:BulkDeletePageTitle'));
|
|
|
|
$oFilter = DBSearch::unserialize($sFilter); // TO DO : check that the filter is valid
|
|
$oFilter->UpdateContextFromUser();
|
|
|
|
$sClass = $oFilter->GetClass();
|
|
|
|
$aDisplayParams = [
|
|
'icon' => MetaModel::GetClassIcon($sClass, false),
|
|
'title' => Dict::S('UI:BulkDeleteTitle'),
|
|
];
|
|
$oChecker = new ActionChecker($oFilter, UR_ACTION_BULK_DELETE);
|
|
DisplayMultipleSelectionForm($oP, $oFilter, 'bulk_delete', $oChecker, [], $aDisplayParams);
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'bulk_delete_confirmed': // Confirm bulk deletion of objects
|
|
$oP->DisableBreadCrumb();
|
|
$sTransactionId = utils::ReadPostedParam('transaction_id', '', 'transaction_id');
|
|
if (!utils::IsTransactionValid($sTransactionId))
|
|
{
|
|
$sUser = UserRights::GetUser();
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
IssueLog::Error("UI.php '$operation' : invalid transaction_id ! data: user='$sUser', class='$sClass'");
|
|
throw new ApplicationException(Dict::S('UI:Error:ObjectsAlreadyDeleted'));
|
|
}
|
|
// Fall through
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'delete':
|
|
case 'bulk_delete': // Actual bulk deletion (if confirmed)
|
|
$oP->DisableBreadCrumb();
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$sClassLabel = MetaModel::GetName($sClass);
|
|
$aObjects = array();
|
|
if ($operation == 'delete')
|
|
{
|
|
// Single object
|
|
$id = utils::ReadParam('id', '');
|
|
$oObj = MetaModel::GetObject($sClass, $id);
|
|
$aObjects[] = $oObj;
|
|
if (!UserRights::IsActionAllowed($sClass, UR_ACTION_DELETE, DBObjectSet::FromObject($oObj)))
|
|
{
|
|
throw new SecurityException(Dict::Format('UI:Error:DeleteNotAllowedOn_Class', $sClassLabel));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Several objects
|
|
$sFilter = utils::ReadPostedParam('filter', '', 'raw_data');
|
|
$oFullSetFilter = DBObjectSearch::unserialize($sFilter);
|
|
// Add user filter
|
|
$oFullSetFilter->UpdateContextFromUser();
|
|
$aSelectObject = utils::ReadMultipleSelection($oFullSetFilter);
|
|
if ( empty($sClass) || empty($aSelectObject)) // TO DO: check that the class name is valid !
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:2ParametersMissing', 'class', 'selectObject[]'));
|
|
}
|
|
foreach($aSelectObject as $iId)
|
|
{
|
|
$aObjects[] = MetaModel::GetObject($sClass, $iId);
|
|
}
|
|
if (count($aObjects) == 1)
|
|
{
|
|
if (!UserRights::IsActionAllowed($sClass, UR_ACTION_DELETE, DBObjectSet::FromArray($sClass, $aObjects)))
|
|
{
|
|
throw new SecurityException(Dict::Format('UI:Error:BulkDeleteNotAllowedOn_Class', $sClassLabel));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (!UserRights::IsActionAllowed($sClass, UR_ACTION_BULK_DELETE, DBObjectSet::FromArray($sClass, $aObjects)))
|
|
{
|
|
throw new SecurityException(Dict::Format('UI:Error:BulkDeleteNotAllowedOn_Class', $sClassLabel));
|
|
}
|
|
$oP->set_title(Dict::S('UI:BulkDeletePageTitle'));
|
|
}
|
|
}
|
|
// Go for the common part... (delete single, delete bulk, delete confirmed)
|
|
cmdbAbstractObject::DeleteObjects($oP, $sClass, $aObjects, ($operation != 'bulk_delete_confirmed'), 'bulk_delete_confirmed');
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'select_bulk_stimulus': // Form displayed when applying a stimulus to many objects
|
|
$oP->DisableBreadCrumb();
|
|
$sFilter = utils::ReadParam('filter', '', false, 'raw_data');
|
|
$sStimulus = utils::ReadParam('stimulus', '');
|
|
$sState = utils::ReadParam('state', '');
|
|
if (empty($sFilter) || empty($sStimulus) || empty($sState))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:3ParametersMissing', 'filter', 'stimulus', 'state'));
|
|
}
|
|
$oFilter = DBObjectSearch::unserialize($sFilter);
|
|
$oFilter->UpdateContextFromUser();
|
|
$sClass = $oFilter->GetClass();
|
|
$aStimuli = MetaModel::EnumStimuli($sClass);
|
|
$sActionLabel = $aStimuli[$sStimulus]->GetLabel();
|
|
$sActionDetails = $aStimuli[$sStimulus]->GetDescription();
|
|
$oP->set_title($sActionLabel);
|
|
$sClass = $oFilter->GetClass();
|
|
|
|
$aDisplayParams = [
|
|
'icon' => MetaModel::GetClassIcon($sClass, false),
|
|
'title' => $sActionLabel,
|
|
];
|
|
$oChecker = new StimulusChecker($oFilter, $sState, $sStimulus);
|
|
$aExtraFormParams = array('stimulus' => $sStimulus, 'state' => $sState);
|
|
DisplayMultipleSelectionForm($oP, $oFilter, 'bulk_stimulus', $oChecker, $aExtraFormParams, $aDisplayParams);
|
|
break;
|
|
|
|
case 'bulk_stimulus':
|
|
$oP->DisableBreadCrumb();
|
|
$sFilter = utils::ReadParam('filter', '', false, 'raw_data');
|
|
$sStimulus = utils::ReadParam('stimulus', '');
|
|
$sState = utils::ReadParam('state', '');
|
|
if (empty($sFilter) || empty($sStimulus) || empty($sState))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:3ParametersMissing', 'filter', 'stimulus', 'state'));
|
|
}
|
|
$oFilter = DBObjectSearch::unserialize($sFilter);
|
|
// Add user filter
|
|
$oFilter->UpdateContextFromUser();
|
|
$sClass = $oFilter->GetClass();
|
|
$aSelectObject = utils::ReadMultipleSelection($oFilter);
|
|
if (count($aSelectObject) == 0)
|
|
{
|
|
// Nothing to do, no object was selected !
|
|
throw new ApplicationException(Dict::S('UI:BulkAction:NoObjectSelected'));
|
|
}
|
|
else
|
|
{
|
|
$aTransitions = MetaModel::EnumTransitions($sClass, $sState);
|
|
$aStimuli = MetaModel::EnumStimuli($sClass);
|
|
|
|
$sActionLabel = $aStimuli[$sStimulus]->GetLabel();
|
|
$sActionDetails = $aStimuli[$sStimulus]->GetDescription();
|
|
$sTargetState = $aTransitions[$sStimulus]['target_state'];
|
|
$aStates = MetaModel::EnumStates($sClass);
|
|
$aTargetStateDef = $aStates[$sTargetState];
|
|
|
|
$oP->set_title(Dict::Format('UI:StimulusModify_N_ObjectsOf_Class', $sActionLabel, count($aSelectObject), $sClass));
|
|
$oP->add(<<<HTML
|
|
<!-- Beginning of objects-transition -->
|
|
<div class="object-transition" data-object-class="$sClass" data-object-current-state="$sState" data-object-target-state="$sTargetState">
|
|
HTML
|
|
);
|
|
$oP->AddUiBlock(TitleUIBlockFactory::MakeForPage(Dict::Format('UI:StimulusModify_N_ObjectsOf_Class', $sActionLabel, count($aSelectObject), $sClass)));
|
|
if (!empty($sActionDetails)) {
|
|
$oP->AddUiBlock(TitleUIBlockFactory::MakeForPage($sActionDetails));
|
|
}
|
|
|
|
|
|
|
|
$aExpectedAttributes = MetaModel::GetTransitionAttributes($sClass, $sStimulus, $sState);
|
|
$aDetails = array();
|
|
$sFormId = 'apply_stimulus';
|
|
$sFormPrefix = $sFormId.'_';
|
|
$iFieldIndex = 0;
|
|
$aFieldsMap = array();
|
|
$aValues = array();
|
|
$aObjects = array();
|
|
foreach($aSelectObject as $iId)
|
|
{
|
|
$aObjects[] = MetaModel::GetObject($sClass, $iId);
|
|
}
|
|
$oSet = DBObjectSet::FromArray($sClass, $aObjects);
|
|
$oObj = $oSet->ComputeCommonObject($aValues);
|
|
$sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
|
|
$oObj->Set($sStateAttCode,$sTargetState);
|
|
$sReadyScript = '';
|
|
foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
|
|
{
|
|
$sFieldInputId = $sFormPrefix.$sAttCode;
|
|
// Prompt for an attribute if
|
|
// - the attribute must be changed or must be displayed to the user for confirmation
|
|
// - or the field is mandatory and currently empty
|
|
if ( ($iExpectCode & (OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) ||
|
|
(($iExpectCode & OPT_ATT_MANDATORY) && ($oObj->Get($sAttCode) == '')) )
|
|
{
|
|
$aAttributesDef = MetaModel::ListAttributeDefs($sClass);
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
$aPrerequisites = MetaModel::GetPrerequisiteAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
|
|
if (count($aPrerequisites) > 0)
|
|
{
|
|
// When 'enabling' a field, all its prerequisites must be enabled too
|
|
$sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aPrerequisites)."']";
|
|
$oP->add_ready_script("$('#enable_{$sFieldInputId}').on('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, true); } );\n");
|
|
}
|
|
$aDependents = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
|
|
if (count($aDependents) > 0)
|
|
{
|
|
// When 'disabling' a field, all its dependent fields must be disabled too
|
|
$sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aDependents)."']";
|
|
$oP->add_ready_script("$('#enable_{$sFieldInputId}').on('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, false); } );\n");
|
|
}
|
|
$aArgs = array('this' => $oObj);
|
|
$sHTMLValue = cmdbAbstractObject::GetFormElementForField($oP, $sClass, $sAttCode, $oAttDef, $oObj->Get($sAttCode), $oObj->GetEditValue($sAttCode), $sFieldInputId, '', $iExpectCode, $aArgs);
|
|
$sComments = '<input type="checkbox" class="ibo-field--enable-bulk--checkbox" checked id="enable_'.$sFieldInputId.'" onClick="ToggleField(this.checked, \''.$sFieldInputId.'\')"/>';
|
|
if (!isset($aValues[$sAttCode]))
|
|
{
|
|
$aValues[$sAttCode] = array();
|
|
}
|
|
if (count($aValues[$sAttCode]) == 1)
|
|
{
|
|
$sComments = '<div class="mono_value ibo-field--enable-bulk ibo-pill ibo-is-success">1'.$sComments.'</div>';
|
|
}
|
|
else
|
|
{
|
|
// Non-homogenous value
|
|
$iMaxCount = 5;
|
|
$sTip = "<p><b>".Dict::Format('UI:BulkModify_Count_DistinctValues', count($aValues[$sAttCode]))."</b><ul>";
|
|
$index = 0;
|
|
foreach($aValues[$sAttCode] as $sCurrValue => $aVal)
|
|
{
|
|
$sDisplayValue = empty($aVal['display']) ? '<i>'.Dict::S('Enum:Undefined').'</i>' : str_replace(array("\n", "\r"), " ", $aVal['display']);
|
|
$sTip .= "<li>".Dict::Format('UI:BulkModify:Value_Exists_N_Times', $sDisplayValue, $aVal['count'])."</li>";
|
|
$index++;
|
|
if ($iMaxCount == $index)
|
|
{
|
|
$sTip .= "<li>".Dict::Format('UI:BulkModify:N_MoreValues', count($aValues[$sAttCode]) - $iMaxCount)."</li>";
|
|
break;
|
|
}
|
|
}
|
|
$sTip .= "</ul></p>";
|
|
$sTip = utils::HtmlEntities($sTip);
|
|
$sComments = '<div class="multi_values ibo-field--enable-bulk ibo-pill ibo-is-failure" id="multi_values_'.$sFieldInputId.'" data-tooltip-content="'.$sTip.'" data-tooltip-html-enabled="true">'.count($aValues[$sAttCode]).$sComments.'</div>';
|
|
}
|
|
$aDetails[] = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => "<span id=\"field_$sFieldInputId\">$sHTMLValue</span>", 'comments' => $sComments);
|
|
$aFieldsMap[$sAttCode] = $sFieldInputId;
|
|
$iFieldIndex++;
|
|
}
|
|
}
|
|
$oFormContainer = new UIContentBlock(null, ['ibo-wizard-container']);
|
|
$oP->AddUiBlock($oFormContainer);
|
|
$oForm = new Combodo\iTop\Application\UI\Base\Component\Form\Form($sFormId);
|
|
$oFormContainer->AddSubBlock($oForm);
|
|
$oForm->SetOnSubmitJsCode("return OnSubmit('{$sFormId}');")
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('class', $sClass))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('operation', 'bulk_apply_stimulus'))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('stimulus', $sStimulus))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('preview_mode', 1))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('filter', utils::HtmlEntities($sFilter)))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('state', $sState))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('selectObject', implode(',',$aSelectObject)))
|
|
->AddSubBlock(InputUIBlockFactory::MakeForHidden('transaction_id', utils::GetNewTransactionId()));
|
|
|
|
$aContextInputBlocks = $oAppContext->GetForUIForm();
|
|
foreach ($aContextInputBlocks as $oContextInputBlock){
|
|
$oForm->AddSubBlock($oContextInputBlock);
|
|
}
|
|
// Note: Remove the table if we want fields to occupy the whole width of the container
|
|
$oForm->AddHtml('<table><tr><td>');
|
|
$oForm->AddHtml($oP->GetDetails($aDetails));
|
|
$oForm->AddHtml('</td></tr></table>');
|
|
|
|
$sURL = "./UI.php?operation=search&filter=".urlencode($sFilter)."&".$oAppContext->GetForLink();
|
|
$oCancelButton = ButtonUIBlockFactory::MakeForCancel(Dict::S('UI:Button:Cancel'), 'cancel', 'cancel');
|
|
$oCancelButton->SetOnClickJsCode("window.location.href='$sURL'");
|
|
$oForm->AddSubBlock($oCancelButton);
|
|
|
|
$oSubmitButton = ButtonUIBlockFactory::MakeForPrimaryAction($sActionLabel, 'submit', 'submit', true);
|
|
$oForm->AddSubBlock($oSubmitButton);
|
|
|
|
$oP->add(<<<HTML
|
|
<!-- End of object-transition -->
|
|
</div>
|
|
HTML
|
|
);
|
|
|
|
$iFieldsCount = count($aFieldsMap);
|
|
$sJsonFieldsMap = json_encode($aFieldsMap);
|
|
|
|
$oP->add_script(
|
|
<<<EOF
|
|
// Initializes the object once at the beginning of the page...
|
|
var oWizardHelper = new WizardHelper('$sClass', '', '$sTargetState', '$sState', '$sStimulus');
|
|
oWizardHelper.SetFieldsMap($sJsonFieldsMap);
|
|
oWizardHelper.SetFieldsCount($iFieldsCount);
|
|
EOF
|
|
);
|
|
$oP->add_ready_script(
|
|
<<<EOF
|
|
// Starts the validation when the page is ready
|
|
CheckFields('{$sFormId}', false);
|
|
$sReadyScript
|
|
EOF
|
|
);
|
|
}
|
|
break;
|
|
|
|
case 'bulk_apply_stimulus':
|
|
$oP->DisableBreadCrumb();
|
|
$bPreviewMode = utils::ReadPostedParam('preview_mode', false);
|
|
$sFilter = utils::ReadPostedParam('filter', '', 'raw_data');
|
|
$sStimulus = utils::ReadPostedParam('stimulus', '');
|
|
$sState = utils::ReadPostedParam('state', '');
|
|
$sSelectObject = utils::ReadPostedParam('selectObject', '', 'raw_data');
|
|
$aSelectObject = explode(',', $sSelectObject);
|
|
|
|
if (empty($sFilter) || empty($sStimulus) || empty($sState))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:3ParametersMissing', 'filter', 'stimulus', 'state'));
|
|
}
|
|
$sTransactionId = utils::ReadPostedParam('transaction_id', '', 'transaction_id');
|
|
if (!utils::IsTransactionValid($sTransactionId))
|
|
{
|
|
$sUser = UserRights::GetUser();
|
|
IssueLog::Error("UI.php '$operation' : invalid transaction_id ! data: user='$sUser'");
|
|
$oP->p(Dict::S('UI:Error:ObjectAlreadyUpdated'));
|
|
}
|
|
else
|
|
{
|
|
// For archiving the modification
|
|
$oFilter = DBObjectSearch::unserialize($sFilter);
|
|
// Add user filter
|
|
$oFilter->UpdateContextFromUser();
|
|
$sClass = $oFilter->GetClass();
|
|
$aObjects = array();
|
|
foreach($aSelectObject as $iId)
|
|
{
|
|
$aObjects[] = MetaModel::GetObject($sClass, $iId);
|
|
}
|
|
|
|
$aTransitions = MetaModel::EnumTransitions($sClass, $sState);
|
|
$aStimuli = MetaModel::EnumStimuli($sClass);
|
|
|
|
$sActionLabel = $aStimuli[$sStimulus]->GetLabel();
|
|
$sActionDetails = $aStimuli[$sStimulus]->GetDescription();
|
|
|
|
$oP->set_title(Dict::Format('UI:StimulusModify_N_ObjectsOf_Class', $sActionLabel, count($aObjects), $sClass));
|
|
|
|
$oSet = DBObjectSet::FromArray($sClass, $aObjects);
|
|
|
|
// For reporting
|
|
$aHeaders = array(
|
|
'object' => array('label' => MetaModel::GetName($sClass), 'description' => Dict::S('UI:ModifiedObject')),
|
|
'status' => array('label' => Dict::S('UI:BulkModifyStatus'), 'description' => Dict::S('UI:BulkModifyStatus+')),
|
|
'errors' => array('label' => Dict::S('UI:BulkModifyErrors'), 'description' => Dict::S('UI:BulkModifyErrors+')),
|
|
);
|
|
$aRows = array();
|
|
while ($oObj = $oSet->Fetch())
|
|
{
|
|
$sError = Dict::S('UI:BulkModifyStatusOk');
|
|
try
|
|
{
|
|
$aTransitions = $oObj->EnumTransitions();
|
|
$aStimuli = MetaModel::EnumStimuli($sClass);
|
|
if (!isset($aTransitions[$sStimulus]))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
|
|
}
|
|
else
|
|
{
|
|
$sActionLabel = $aStimuli[$sStimulus]->GetLabel();
|
|
$sActionDetails = $aStimuli[$sStimulus]->GetDescription();
|
|
$sTargetState = $aTransitions[$sStimulus]['target_state'];
|
|
$aExpectedAttributes = $oObj->GetTransitionAttributes($sStimulus /* cureent state */);
|
|
$aDetails = array();
|
|
$aErrors = array();
|
|
foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
|
|
{
|
|
$iFlags = $oObj->GetTransitionFlags($sAttCode, $sStimulus);
|
|
if (($iExpectCode & (OPT_ATT_MUSTCHANGE|OPT_ATT_MUSTPROMPT)) || ($oObj->Get($sAttCode) == '') )
|
|
{
|
|
$paramValue = utils::ReadPostedParam("attr_$sAttCode", '', 'raw_data');
|
|
if ( ($iFlags & OPT_ATT_SLAVE) && ($paramValue != $oObj->Get($sAttCode)) )
|
|
{
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
$aErrors[] = Dict::Format('UI:AttemptingToSetASlaveAttribute_Name', $oAttDef->GetLabel(), $sAttCode);
|
|
unset($aExpectedAttributes[$sAttCode]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$oObj->UpdateObjectFromPostedForm('', array_keys($aExpectedAttributes), $aExpectedAttributes);
|
|
|
|
if (count($aErrors) == 0)
|
|
{
|
|
if ($oObj->ApplyStimulus($sStimulus))
|
|
{
|
|
list($bResult, $aErrors) = $oObj->CheckToWrite();
|
|
$sStatus = $bResult ? Dict::S('UI:BulkModifyStatusModified') : Dict::S('UI:BulkModifyStatusSkipped');
|
|
if ($bResult)
|
|
{
|
|
$oObj->DBUpdate();
|
|
}
|
|
else
|
|
{
|
|
$aErrorsToDisplay = array_map(function($sError) {
|
|
return utils::HtmlEntities($sError);
|
|
}, $aErrors);
|
|
$sError = '<p>'.implode('</p></p>',$aErrorsToDisplay)."</p>\n";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$sStatus = Dict::S('UI:BulkModifyStatusSkipped');
|
|
$sError = '<p>'.Dict::S('UI:FailedToApplyStimuli')."<p>\n";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$sStatus = Dict::S('UI:BulkModifyStatusSkipped');
|
|
$sError = '<p>'.implode('</p></p>',$aErrors)."</p>\n";
|
|
}
|
|
}
|
|
}
|
|
catch(Exception $e)
|
|
{
|
|
$sError = $e->getMessage();
|
|
$sStatus = Dict::S('UI:BulkModifyStatusSkipped');
|
|
}
|
|
$aRows[] = array(
|
|
'object' => $oObj->GetHyperlink(),
|
|
'status' => $sStatus,
|
|
'errors' => $sError,
|
|
);
|
|
}
|
|
$oBlock = PanelUIBlockFactory::MakeForClass($sClass, Dict::Format('UI:StimulusModify_N_ObjectsOf_Class', $sActionLabel, count($aObjects), $sClass));
|
|
$oBlock->SetIcon(MetaModel::GetClassIcon($sClass, false));
|
|
|
|
|
|
$oDataTable = DataTableUIBlockFactory::MakeForStaticData('', $aHeaders,$aRows);
|
|
$oBlock->AddSubBlock($oDataTable);
|
|
$oP->AddUiBlock($oBlock);
|
|
|
|
// Back to the list
|
|
$sURL = "./UI.php?operation=search&filter=".urlencode($sFilter)."&".$oAppContext->GetForLink();
|
|
$oSubmitButton = ButtonUIBlockFactory::MakeForSecondaryAction(Dict::S('UI:Button:Done'), 'submit', 'submit', true);
|
|
$oSubmitButton->SetOnClickJsCode("window.location.href='$sURL'");
|
|
$oToolbarButtons = ToolbarUIBlockFactory::MakeStandard(null);
|
|
$oToolbarButtons->AddCSSClass('ibo-toolbar--button');
|
|
$oToolbarButtons->AddSubBlock($oSubmitButton);
|
|
$oP->AddSubBlock($oToolbarButtons);
|
|
}
|
|
break;
|
|
|
|
case 'stimulus': // Form displayed when applying a stimulus (state change)
|
|
$oP->DisableBreadCrumb();
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$id = utils::ReadParam('id', '');
|
|
$sStimulus = utils::ReadParam('stimulus', '');
|
|
if ( empty($sClass) || empty($id) || empty($sStimulus) ) // TO DO: check that the class name is valid !
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:3ParametersMissing', 'class', 'id', 'stimulus'));
|
|
}
|
|
$aStimuli = MetaModel::EnumStimuli($sClass);
|
|
if ((get_class($aStimuli[$sStimulus]) !== 'StimulusUserAction') || (UserRights::IsStimulusAllowed($sClass, $sStimulus) === UR_ALLOWED_NO))
|
|
{
|
|
$sUser = UserRights::GetUser();
|
|
IssueLog::Error("UI.php '$operation' : Stimulus '$sStimulus' not allowed ! data: user='$sUser', class='$sClass'");
|
|
throw new ApplicationException(Dict::S('UI:Error:ActionNotAllowed'));
|
|
}
|
|
|
|
/** @var \cmdbAbstractObject $oObj */
|
|
$oObj = MetaModel::GetObject($sClass, $id, false);
|
|
if ($oObj != null)
|
|
{
|
|
$aPrefillFormParam = [
|
|
'user' => Session::Get('auth_user'),
|
|
'context' => $oAppContext->GetAsHash(),
|
|
'stimulus' => $sStimulus,
|
|
'origin' => 'console',
|
|
];
|
|
try {
|
|
$bApplyTransition = $oObj->DisplayStimulusForm($oP, $sStimulus, $aPrefillFormParam);
|
|
}
|
|
catch (ApplicationException $e) {
|
|
$bApplyTransition = false;
|
|
$sMessage = $e->getMessage();
|
|
$sSeverity = 'warning';
|
|
ReloadAndDisplay($oP, $oObj, 'stimulus', $sMessage, $sSeverity);
|
|
}
|
|
catch (CoreCannotSaveObjectException $e) {
|
|
$bApplyTransition = false;
|
|
$aIssues = $e->getIssues();
|
|
$sMessage = $e->getHtmlMessage();
|
|
$sSeverity = 'warning';
|
|
ReloadAndDisplay($oP, $oObj, 'stimulus', $sMessage, $sSeverity);
|
|
}
|
|
if ($bApplyTransition) {
|
|
$sMessage = Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName());
|
|
$sSeverity = 'ok';
|
|
//transition is ok, whe can display object with transition message
|
|
ReloadAndDisplay($oP, $oObj, 'apply_stimulus', $sMessage, $sSeverity);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$oP->set_title(Dict::S('UI:ErrorPageTitle'));
|
|
$oP->P(Dict::S('UI:ObjectDoesNotExist'));
|
|
}
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'apply_stimulus': // Actual state change
|
|
$oP->DisableBreadCrumb();
|
|
$sClass = utils::ReadPostedParam('class', '', 'class');
|
|
$id = utils::ReadPostedParam('id', '');
|
|
$sTransactionId = utils::ReadPostedParam('transaction_id', '', 'transaction_id');
|
|
$sStimulus = utils::ReadPostedParam('stimulus', '');
|
|
if ( empty($sClass) || empty($id) || empty($sStimulus) ) // TO DO: check that the class name is valid !
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:3ParametersMissing', 'class', 'id', 'stimulus'));
|
|
}
|
|
/** @var \cmdbAbstractObject $oObj */
|
|
$oObj = MetaModel::GetObject($sClass, $id, false);
|
|
if ($oObj != null)
|
|
{
|
|
$aTransitions = $oObj->EnumTransitions();
|
|
$aStimuli = MetaModel::EnumStimuli($sClass);
|
|
$sMessage = '';
|
|
$sSeverity = 'ok';
|
|
$bDisplayDetails = true;
|
|
if (!isset($aTransitions[$sStimulus]))
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
|
|
}
|
|
if (!utils::IsTransactionValid($sTransactionId))
|
|
{
|
|
$sUser = UserRights::GetUser();
|
|
IssueLog::Error("UI.php '$operation' : invalid transaction_id ! data: user='$sUser', class='$sClass'");
|
|
$sMessage = Dict::S('UI:Error:ObjectAlreadyUpdated');
|
|
$sSeverity = 'info';
|
|
}
|
|
elseif ((get_class($aStimuli[$sStimulus]) !== 'StimulusUserAction') || (UserRights::IsStimulusAllowed($sClass, $sStimulus) === UR_ALLOWED_NO))
|
|
{
|
|
$sUser = UserRights::GetUser();
|
|
IssueLog::Error("UI.php '$operation' : Stimulus '$sStimulus' not allowed ! data: user='$sUser', class='$sClass'");
|
|
$sMessage = Dict::S('UI:Error:ActionNotAllowed');
|
|
$sSeverity = 'error';
|
|
}
|
|
else
|
|
{
|
|
$sActionLabel = $aStimuli[$sStimulus]->GetLabel();
|
|
$sActionDetails = $aStimuli[$sStimulus]->GetDescription();
|
|
$sTargetState = $aTransitions[$sStimulus]['target_state'];
|
|
$aExpectedAttributes = $oObj->GetTransitionAttributes($sStimulus /*, current state*/);
|
|
$aDetails = array();
|
|
$aErrors = array();
|
|
foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
|
|
{
|
|
$iFlags = $oObj->GetTransitionFlags($sAttCode, $sStimulus);
|
|
if (($iExpectCode & (OPT_ATT_MUSTCHANGE|OPT_ATT_MUSTPROMPT)) || ($oObj->Get($sAttCode) == '') )
|
|
{
|
|
$paramValue = utils::ReadPostedParam("attr_$sAttCode", '', 'raw_data');
|
|
if ( ($iFlags & OPT_ATT_SLAVE) && ($paramValue != $oObj->Get($sAttCode)))
|
|
{
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
$aErrors[] = Dict::Format('UI:AttemptingToChangeASlaveAttribute_Name', $oAttDef->GetLabel());
|
|
unset($aExpectedAttributes[$sAttCode]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$oObj->UpdateObjectFromPostedForm('', array_keys($aExpectedAttributes), $aExpectedAttributes);
|
|
|
|
if (count($aErrors) == 0)
|
|
{
|
|
$sIssues = '';
|
|
$bApplyStimulus = true;
|
|
list($bRes, $aIssues) = $oObj->CheckToWrite(); // Check before trying to write the object
|
|
if ($bRes)
|
|
{
|
|
try
|
|
{
|
|
$bApplyStimulus = $oObj->ApplyStimulus($sStimulus); // will write the object in the DB
|
|
}
|
|
catch(CoreException $e)
|
|
{
|
|
// Rollback to the previous state... by reloading the object from the database and applying the modifications again
|
|
$oObj = MetaModel::GetObject(get_class($oObj), $oObj->GetKey());
|
|
$oObj->UpdateObjectFromPostedForm('', array_keys($aExpectedAttributes), $aExpectedAttributes);
|
|
$sIssues = $e->getMessage();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$sIssues = implode(' ', $aIssues);
|
|
}
|
|
|
|
if (!$bApplyStimulus)
|
|
{
|
|
$sMessage = Dict::S('UI:FailedToApplyStimuli');
|
|
$sSeverity = 'error';
|
|
|
|
$sOwnershipToken = utils::ReadPostedParam('ownership_token', null, 'raw_data');
|
|
if ($sOwnershipToken !== null)
|
|
{
|
|
// Release the concurrent lock, if any
|
|
iTopOwnershipLock::ReleaseLock(get_class($oObj), $oObj->GetKey(), $sOwnershipToken);
|
|
}
|
|
}
|
|
else if ($sIssues != '')
|
|
{
|
|
$sOwnershipToken = utils::ReadPostedParam('ownership_token', null, 'raw_data');
|
|
if ($sOwnershipToken !== null)
|
|
{
|
|
// Release the concurrent lock, if any, a new lock will be re-acquired by DisplayStimulusForm below
|
|
iTopOwnershipLock::ReleaseLock(get_class($oObj), $oObj->GetKey(), $sOwnershipToken);
|
|
}
|
|
|
|
$bDisplayDetails = false;
|
|
// Found issues, explain and give the user a second chance
|
|
//
|
|
try
|
|
{
|
|
$oObj->DisplayStimulusForm($oP, $sStimulus);
|
|
}
|
|
catch(ApplicationException $e)
|
|
{
|
|
$sMessage = $e->getMessage();
|
|
$sSeverity = 'info';
|
|
}
|
|
$sIssueDesc = Dict::Format('UI:ObjectCouldNotBeWritten',$sIssues);
|
|
$oP->add_ready_script("CombodoModal.OpenErrorModal('".addslashes($sIssueDesc)."');");
|
|
}
|
|
else
|
|
{
|
|
$sMessage = Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName());
|
|
$sSeverity = 'ok';
|
|
utils::RemoveTransaction($sTransactionId);
|
|
$bLockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
|
|
if ($bLockEnabled)
|
|
{
|
|
// Release the concurrent lock, if any
|
|
$sOwnershipToken = utils::ReadPostedParam('ownership_token', null, 'raw_data');
|
|
if ($sOwnershipToken !== null)
|
|
{
|
|
// We're done, let's release the lock
|
|
iTopOwnershipLock::ReleaseLock(get_class($oObj), $oObj->GetKey(), $sOwnershipToken);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$sMessage = implode('</p><p>', $aErrors);
|
|
$sSeverity = 'error';
|
|
}
|
|
}
|
|
if ($bDisplayDetails)
|
|
{
|
|
ReloadAndDisplay($oP, $oObj, 'apply_stimulus', $sMessage, $sSeverity);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$oP->set_title(Dict::S('UI:ErrorPageTitle'));
|
|
$oP->P(Dict::S('UI:ObjectDoesNotExist'));
|
|
}
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'swf_navigator': /** @deprecated SWF was removed in iTop */
|
|
case 'view_relations': // Graphical display of the relations "impact" / "depends on"
|
|
require_once(APPROOT.'core/simplegraph.class.inc.php');
|
|
require_once(APPROOT.'core/relationgraph.class.inc.php');
|
|
require_once(APPROOT.'core/displayablegraph.class.inc.php');
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$id = utils::ReadParam('id', 0);
|
|
$sRelation = utils::ReadParam('relation', 'impact');
|
|
$sDirection = utils::ReadParam('direction', 'down');
|
|
$iGroupingThreshold = utils::ReadParam('g', 5);
|
|
|
|
$bDirDown = ($sDirection === 'down');
|
|
$oObj = MetaModel::GetObject($sClass, $id);
|
|
$iMaxRecursionDepth = MetaModel::GetConfig()->Get('relations_max_depth');
|
|
$aSourceObjects = array($oObj);
|
|
|
|
$oP->set_title(MetaModel::GetRelationDescription($sRelation, $bDirDown).' '.$oObj->GetName());
|
|
|
|
$sPageId = "ui-relation-graph-".$sClass.'::'.$id;
|
|
$sLabel = $oObj->GetName().' '.MetaModel::GetRelationLabel($sRelation, $bDirDown);
|
|
$sDescription = MetaModel::GetRelationDescription($sRelation, $bDirDown).' '.$oObj->GetName();
|
|
$oP->SetBreadCrumbEntry($sPageId, $sLabel, $sDescription);
|
|
|
|
if ($sRelation == 'depends on') {
|
|
$sRelation = 'impacts';
|
|
$sDirection = 'up';
|
|
}
|
|
if ($sDirection == 'up') {
|
|
$oRelGraph = MetaModel::GetRelatedObjectsUp($sRelation, $aSourceObjects, $iMaxRecursionDepth);
|
|
} else {
|
|
$oRelGraph = MetaModel::GetRelatedObjectsDown($sRelation, $aSourceObjects, $iMaxRecursionDepth);
|
|
}
|
|
|
|
|
|
$aResults = $oRelGraph->GetObjectsByClass();
|
|
$oDisplayGraph = DisplayableGraph::FromRelationGraph($oRelGraph, $iGroupingThreshold, ($sDirection == 'down'));
|
|
$sTitle = MetaModel::GetRelationDescription($sRelation, $bDirDown).' '.$oObj->GetName();
|
|
$sClassIcon = MetaModel::GetClassIcon($sClass, false);
|
|
|
|
$sFirstTab = MetaModel::GetConfig()->Get('impact_analysis_first_tab');
|
|
$bLazyLoading = MetaModel::GetConfig()->Get('impact_analysis_lazy_loading');
|
|
$sContextKey = "itop-config-mgmt/relation_context/$sClass/$sRelation/$sDirection";
|
|
|
|
// Check if the current object supports Attachments, similar to AttachmentPlugin::IsTargetObject
|
|
$sClassForAttachment = null;
|
|
$iIdForAttachment = null;
|
|
if (class_exists('Attachment')) {
|
|
$aAllowedClasses = MetaModel::GetModuleSetting('itop-attachments', 'allowed_classes', array('Ticket'));
|
|
foreach ($aAllowedClasses as $sAllowedClass) {
|
|
if ($oObj instanceof $sAllowedClass) {
|
|
$iIdForAttachment = $id;
|
|
$sClassForAttachment = $sClass;
|
|
}
|
|
}
|
|
}
|
|
|
|
$oP->AddSubBlock($oDisplayGraph->DisplayFilterBox($oP, $aResults, $bLazyLoading));
|
|
$oPanel = PanelUIBlockFactory::MakeForClass($sClass, $sTitle);
|
|
$oPanel->SetIcon($sClassIcon);
|
|
|
|
$oP->AddSubBlock($oPanel);
|
|
$oP->AddTabContainer('Navigator', '', $oPanel);
|
|
$oP->SetCurrentTabContainer('Navigator');
|
|
|
|
// Display the tabs
|
|
if ($sFirstTab == 'list') {
|
|
DisplayNavigatorListTab($oP, $aResults, $sRelation, $sDirection, $oObj);
|
|
$oP->SetCurrentTab('UI:RelationshipGraph');
|
|
$oDisplayGraph->DisplayGraph($oP, $sRelation, $oAppContext, [], $sClassForAttachment, $iIdForAttachment, $sContextKey, array('this' => $oObj), $bLazyLoading);
|
|
DisplayNavigatorGroupTab($oP);
|
|
} else {
|
|
$oP->SetCurrentTab('UI:RelationshipGraph');
|
|
$oDisplayGraph->DisplayGraph($oP, $sRelation, $oAppContext, array(), $sClassForAttachment, $iIdForAttachment, $sContextKey, array('this' => $oObj), $bLazyLoading);
|
|
DisplayNavigatorListTab($oP, $aResults, $sRelation, $sDirection, $oObj);
|
|
DisplayNavigatorGroupTab($oP);
|
|
}
|
|
|
|
$oP->SetCurrentTab('');
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'kill_lock':
|
|
$oP->DisableBreadCrumb();
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$id = utils::ReadParam('id', '');
|
|
iTopOwnershipLock::KillLock($sClass, $id);
|
|
$oObj = MetaModel::GetObject($sClass, $id);
|
|
ReloadAndDisplay($oP, $oObj, 'concurrent_lock_killed', Dict::S('UI:ConcurrentLockKilled'), 'info');
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
case 'cancel': // An action was cancelled
|
|
$oP->DisableBreadCrumb();
|
|
$oP->set_title(Dict::S('UI:OperationCancelled'));
|
|
$oP->add('<h1>'.Dict::S('UI:OperationCancelled').'</h1>');
|
|
break;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
default: // Menu node rendering (templates)
|
|
ApplicationMenu::LoadAdditionalMenus();
|
|
$oMenuNode = ApplicationMenu::GetMenuNode(ApplicationMenu::GetMenuIndexById(ApplicationMenu::GetActiveNodeId()));
|
|
if (is_object($oMenuNode))
|
|
{
|
|
$oMenuNode->RenderContent($oP, $oAppContext->GetAsHash());
|
|
$oP->set_title($oMenuNode->GetLabel());
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
}
|
|
}
|
|
|
|
DisplayWelcomePopup($oP);
|
|
$oKPI->ComputeAndReport('Compute page');
|
|
$oP->output();
|
|
}
|
|
catch (Exception $e) {
|
|
$oErrorPage = new ErrorPage(Dict::S('UI:PageTitle:FatalError'));
|
|
if ($e instanceof SecurityException) {
|
|
$oErrorPage->add("<h1>".Dict::S('UI:SystemIntrusion')."</h1>\n");
|
|
} else {
|
|
$oErrorPage->add("<h1>".Dict::S('UI:FatalErrorMessage')."</h1>\n");
|
|
}
|
|
$sErrorDetails = ($e instanceof CoreException) ? $e->getHtmlDesc() : $e->getMessage();
|
|
$oErrorPage->error(Dict::Format('UI:Error_Details', $sErrorDetails));
|
|
$oErrorPage->output();
|
|
|
|
$sErrorStackTrace = ($e instanceof CoreException) ? $e->getFullStackTraceAsString() : $e->getTraceAsString();
|
|
if (MetaModel::IsLogEnabledIssue()) {
|
|
if (MetaModel::IsValidClass('EventIssue')) {
|
|
try {
|
|
$oLog = new EventIssue();
|
|
|
|
$oLog->Set('message', $e->getMessage());
|
|
$oLog->Set('userinfo', '');
|
|
$sIssue = ($e instanceof CoreException) ? $e->GetIssue() : 'PHP Exception';
|
|
$oLog->Set('issue', $sIssue);
|
|
$oLog->Set('impact', 'Page could not be displayed');
|
|
$oLog->Set('callstack', $sErrorStackTrace);
|
|
$aData = ($e instanceof CoreException) ? $e->getContextData() : [];
|
|
$oLog->Set('data', $aData);
|
|
$oLog->DBInsertNoReload();
|
|
}
|
|
catch (Exception $e) {
|
|
IssueLog::Error("Failed to log issue into the DB");
|
|
}
|
|
}
|
|
}
|
|
|
|
$sOperationToLog = $operation ?? 'N/A';
|
|
IssueLog::Debug('UI.php operation='.$sOperationToLog.', error='.$e->getMessage()."\n".$sErrorStackTrace, LogChannels::CONSOLE);
|
|
}
|
|
|
|
|
|
class UI
|
|
{
|
|
|
|
/**
|
|
* Operation select_for_modify_all
|
|
*
|
|
* @param iTopWebPage $oP
|
|
*
|
|
* @throws \ApplicationException
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \OQLException
|
|
*/
|
|
public static function OperationSelectForModifyAll(iTopWebPage $oP): void
|
|
{
|
|
$oP->DisableBreadCrumb();
|
|
$oP->set_title(Dict::S('UI:ModifyAllPageTitle'));
|
|
$sFilter = utils::ReadParam('filter', '', false, utils::ENUM_SANITIZATION_FILTER_RAW_DATA);
|
|
if (empty($sFilter)) {
|
|
throw new ApplicationException(Dict::Format('UI:Error:1ParametersMissing', 'filter'));
|
|
}
|
|
$oFilter = DBObjectSearch::unserialize($sFilter); //TODO : check that the filter is valid
|
|
// Add user filter
|
|
$oFilter->UpdateContextFromUser();
|
|
$oChecker = new ActionChecker($oFilter, UR_ACTION_BULK_MODIFY);
|
|
$sClass = $oFilter->GetClass();
|
|
$sClassName = MetaModel::GetName($sClass);
|
|
|
|
$aDisplayParams = [
|
|
'icon' => MetaModel::GetClassIcon($sClass, false),
|
|
'title' => Dict::Format('UI:Modify_ObjectsOf_Class', $sClassName),
|
|
];
|
|
DisplayMultipleSelectionForm($oP, $oFilter, 'form_for_modify_all', $oChecker, [], $aDisplayParams);
|
|
}
|
|
|
|
/**
|
|
* Operation form_for_modify_all
|
|
*
|
|
* @param iTopWebPage $oP
|
|
* @param \ApplicationContext $oAppContext
|
|
*
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreException
|
|
* @throws \CoreUnexpectedValue
|
|
* @throws \MySQLException
|
|
* @throws \OQLException
|
|
*/
|
|
public static function OperationFormForModifyAll(iTopWebPage $oP, ApplicationContext $oAppContext): void
|
|
{
|
|
$oP->DisableBreadCrumb();
|
|
$sFilter = utils::ReadParam('filter', '', false, utils::ENUM_SANITIZATION_FILTER_RAW_DATA);
|
|
$sClass = utils::ReadParam('class', '', false, utils::ENUM_SANITIZATION_FILTER_CLASS);
|
|
$oFullSetFilter = DBObjectSearch::unserialize($sFilter);
|
|
// Add user filter
|
|
$oFullSetFilter->UpdateContextFromUser();
|
|
$aSelectedObj = utils::ReadMultipleSelection($oFullSetFilter);
|
|
$sCancelUrl = "./UI.php?operation=search&filter=".urlencode($sFilter)."&".$oAppContext->GetForLink();
|
|
$aContext = array('filter' => utils::EscapeHtml($sFilter));
|
|
cmdbAbstractObject::DisplayBulkModifyForm($oP, $sClass, $aSelectedObj, 'preview_or_modify_all', $sCancelUrl, array(), $aContext);
|
|
}
|
|
|
|
/**
|
|
* Operation preview_or_modify_all
|
|
*
|
|
* @param iTopWebPage $oP
|
|
* @param \ApplicationContext $oAppContext
|
|
*
|
|
* @throws \ApplicationException
|
|
* @throws \ArchivedObjectException
|
|
* @throws \CoreCannotSaveObjectException
|
|
* @throws \CoreException
|
|
* @throws \DictExceptionMissingString
|
|
* @throws \OQLException
|
|
*/
|
|
public static function OperationPreviewOrModifyAll(iTopWebPage $oP, ApplicationContext $oAppContext): void
|
|
{
|
|
$oP->DisableBreadCrumb();
|
|
$sFilter = utils::ReadParam('filter', '', false, 'raw_data');
|
|
$oFilter = DBObjectSearch::unserialize($sFilter); // TO DO : check that the filter is valid
|
|
// Add user filter
|
|
$oFilter->UpdateContextFromUser();
|
|
|
|
$sClass = utils::ReadParam('class', '', false, 'class');
|
|
$bPreview = utils::ReadParam('preview_mode', '');
|
|
$sSelectedObj = utils::ReadParam('selectObj', '', false, 'raw_data');
|
|
if (empty($sClass) || empty($sSelectedObj)) // TO DO: check that the class name is valid !
|
|
{
|
|
throw new ApplicationException(Dict::Format('UI:Error:2ParametersMissing', 'class', 'selectObj'));
|
|
}
|
|
$aSelectedObj = explode(',', $sSelectedObj);
|
|
$sCancelUrl = "./UI.php?operation=search&filter=".urlencode($sFilter)."&".$oAppContext->GetForLink();
|
|
$aContext = array(
|
|
'filter' => utils::EscapeHtml($sFilter),
|
|
'selectObj' => $sSelectedObj,
|
|
);
|
|
cmdbAbstractObject::DoBulkModify($oP, $sClass, $aSelectedObj, 'preview_or_modify_all', $bPreview, $sCancelUrl, $aContext);
|
|
}
|
|
}
|