Skip to content

N°9542 - Portal : add the possibility to choose subclass in search screen #894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
accognet wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

N°9542 - Portal : add the possibility to choose subclass in search screen #894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8797786
N°9542 - Portal : add the possibility to choose subclass in search sc…
accognet Apr 24, 2026
46222d7
N°9542 - remove the hard values
accognet Apr 24, 2026
bff6c95
display improvement
accognet May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions datamodels/2.x/itop-portal-base/portal/config/routes/object_brick.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ p_object_search_from_attribute:
sHostObjectClass: ~
sHostObjectId: ~

p_columns_from_attribute_with_class:
path: '/object/search/columns-from-attribute-with-class/{sTargetAttCode}/{sHostObjectClass}/{sHostObjectId}'
defaults:
_controller: 'Combodo\iTop\Portal\Controller\ObjectController::GetColumnsFromAttributeAction'
sHostObjectClass: ~
sHostObjectId: ~

p_object_search_autocomplete:
path: '/object/search/autocomplete/{sTargetAttCode}/{sHostObjectClass}/{sHostObjectId}'
defaults:
Expand Down
15 changes: 14 additions & 1 deletion datamodels/2.x/itop-portal-base/portal/public/css/pages/bricks/_object-brick.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
/* SCSS variables (can be overloaded) */
$ipb-object-brick--url-to-clipboard--opacity: 0.5 !default;
$ipb-object-brick--url-to-clipboard-tooltip-copied--margin-right: $common-spacing-200!default;
$ipb-object-brick--padding-small-horizontal: 10px!default;


.url-to-clipboard{
Expand All @@ -21,4 +22,16 @@ $ipb-object-brick--url-to-clipboard-tooltip-copied--margin-right: $common-spacin
// Used for clipboard's tooltip, which is not part of .url-to-clipboard element
.url-to-clipboard-tooltip-copied {
margin-right: $ipb-object-brick--url-to-clipboard-tooltip-copied--margin-right;
}
}

.form_filter_container{
position: relative;
height: 2.5em;
width: 100%;
}

.form_filter_class{
position: absolute;
right: 0;
padding-right: $ipb-object-brick--padding-small-horizontal;
}
182 changes: 160 additions & 22 deletions datamodels/2.x/itop-portal-base/portal/src/Controller/ObjectController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,6 +714,125 @@ public function SearchAutocompleteAction(Request $oRequest, $sTargetAttCode, $sH
return $oResponse;
}

public function GetColumnsFromAttributeAction(Request $oRequest, $sTargetAttCode, $sHostObjectClass, $sHostObjectId = null)
{
$sFinalClass = $this->oRequestManipulatorHelper->ReadParam('finalclass', null, FILTER_UNSAFE_RAW);
/** @var array $aCombodoPortalInstanceConf */
$aCombodoPortalInstanceConf = $this->getParameter('combodo.portal.instance.conf');

$aData = [
'sMode' => 'search_regular',
'sTargetAttCode' => $sTargetAttCode,
'sHostObjectClass' => $sHostObjectClass,
'sHostObjectId' => $sHostObjectId,
'sActionRulesToken' => $this->oRequestManipulatorHelper->ReadParam('ar_token', ''),
];

// Checking security layers
if (!$this->oSecurityHelper->IsActionAllowed(UR_ACTION_READ, $sHostObjectClass, $sHostObjectId)) {
IssueLog::Warning(__METHOD__.' at line '.__LINE__.' : User #'.UserRights::GetUserId().' not allowed to read '.$sHostObjectClass.'::'.$sHostObjectId.' object.');
throw new HttpException(Response::HTTP_NOT_FOUND, Dict::S('UI:ObjectDoesNotExist'));
}

// Retrieving host object for future DBSearch parameters
if ($sHostObjectId !== null) {
// Note : AllowAllData set to true here instead of checking scope's flag because we are displaying a value that has been set and validated
$oHostObject = MetaModel::GetObject($sHostObjectClass, $sHostObjectId, true, true);
} else {
$oHostObject = MetaModel::NewObject($sHostObjectClass);
// Retrieving action rules
//
// Note : The action rules must be a base64-encoded JSON object, this is just so users are tempted to changes values.
// But it would not be a security issue as it only presets values in the form.
$aActionRules = !empty($aData['sActionRulesToken']) ? ContextManipulatorHelper::DecodeRulesToken($aData['sActionRulesToken']) : [];
// Preparing object
$this->oContextManipulatorHelper->PrepareObject($aActionRules, $oHostObject);
}

// Updating host object with form data / values
$sFormManagerClass = $this->oRequestManipulatorHelper->ReadParam('formmanager_class', '', FILTER_UNSAFE_RAW);
$sFormManagerData = $this->oRequestManipulatorHelper->ReadParam('formmanager_data', '', FILTER_UNSAFE_RAW);
if (!empty($sFormManagerClass) && !empty($sFormManagerData)) {
/** @var \Combodo\iTop\Portal\Form\ObjectFormManager $oFormManager */
$oFormManager = $sFormManagerClass::FromJSON($sFormManagerData);
$oFormManager->SetObjectFormHandlerHelper($this->oObjectFormHandlerHelper);
$oFormManager->SetObject($oHostObject);

// Applying action rules if present
if (($oFormManager->GetActionRulesToken() !== null) && ($oFormManager->GetActionRulesToken() !== '')) {
$aActionRules = ContextManipulatorHelper::DecodeRulesToken($oFormManager->GetActionRulesToken());
$oObj = $oFormManager->GetObject();
$this->oContextManipulatorHelper->PrepareObject($aActionRules, $oObj);
$oFormManager->SetObject($oObj);
}

// Updating host object
$oFormManager->OnUpdate([
'currentValues' => $this->oRequestManipulatorHelper->ReadParam('current_values', [], FILTER_UNSAFE_RAW, FILTER_REQUIRE_ARRAY),
]);
$oHostObject = $oFormManager->GetObject();
}

// Retrieving request parameters
$sFieldId = $this->oRequestManipulatorHelper->ReadParam('sFieldId', '');

// Building search query
// - Retrieving target object class from attcode
$oTargetAttDef = MetaModel::GetAttributeDef($sHostObjectClass, $sTargetAttCode);
if ($oTargetAttDef->IsExternalKey()) {
/** @var \AttributeExternalKey $oTargetAttDef */
$sTargetObjectClass = $oTargetAttDef->GetTargetClass();
} elseif ($oTargetAttDef->IsLinkSet()) {
/** @var \AttributeLinkedSet $oTargetAttDef */
if (!$oTargetAttDef->IsIndirect()) {
$sTargetObjectClass = $oTargetAttDef->GetLinkedClass();
} else {
/** @var \AttributeLinkedSetIndirect $oTargetAttDef */
/** @var \AttributeExternalKey $oRemoteAttDef */
$oRemoteAttDef = MetaModel::GetAttributeDef($oTargetAttDef->GetLinkedClass(), $oTargetAttDef->GetExtKeyToRemote());
$sTargetObjectClass = $oRemoteAttDef->GetTargetClass();
}
} elseif ($oTargetAttDef->GetEditClass() === 'CustomFields') {
$oRequestTemplate = $oHostObject->Get($sTargetAttCode);
/** @var \DBSearch $oTemplateFieldSearch */
$oTemplateFieldSearch = $oRequestTemplate->GetForm()->GetField('user_data')->GetForm()->GetField($sFieldId)->GetSearch();
$sTargetObjectClass = $oTemplateFieldSearch->GetClass();
} else {
throw new Exception('Search from attribute can only apply on AttributeExternalKey or AttributeLinkedSet objects, '.get_class($oTargetAttDef).' given.');
}
if (!empty($sFinalClass)) {
if (!MetaModel::IsParentClass($sTargetObjectClass, $sFinalClass)) {
throw new Exception('The finalclass parameter should be a child class of the target object class');
}
} else {
$sFinalClass = $sTargetObjectClass;
}

// - Retrieving class attribute list
$aAttCodes = ApplicationHelper::GetLoadedListFromClass($aCombodoPortalInstanceConf['lists'], $sFinalClass, 'list');
// - Adding friendlyname attribute to the list is not already in it
$sTitleAttCode = 'friendlyname';
if (($sTitleAttCode !== null) && !in_array($sTitleAttCode, $aAttCodes)) {
$aAttCodes = array_merge([$sTitleAttCode], $aAttCodes);
}

// Retrieving results
// - Retrieving columns properties
$aColumnProperties = [];
foreach ($aAttCodes as $sAttCode) {
$oAttDef = MetaModel::GetAttributeDef($sFinalClass, $sAttCode);
$aColumnProperties[$sAttCode] = [
'title' => $oAttDef->GetLabel(),
];
}

// Preparing response
$aData = $aData + [
'levelsProperties' => $aColumnProperties,
];

return new JsonResponse($aData);
}
/**
* Handles the regular (table) search from an attribute
*
Expand All @@ -737,6 +856,7 @@ public function SearchAutocompleteAction(Request $oRequest, $sTargetAttCode, $sH
*/
public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $sHostObjectClass, $sHostObjectId = null)
{
$sFinalClass = $this->oRequestManipulatorHelper->ReadParam('finalclass', null, FILTER_UNSAFE_RAW);
/** @var array $aCombodoPortalInstanceConf */
$aCombodoPortalInstanceConf = $this->getParameter('combodo.portal.instance.conf');

Expand Down Expand Up @@ -826,9 +946,16 @@ public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $s
} else {
throw new Exception('Search from attribute can only apply on AttributeExternalKey or AttributeLinkedSet objects, '.get_class($oTargetAttDef).' given.');
}
if (utils::IsNotNullOrEmptyString($sFinalClass)) {
if (!MetaModel::IsParentClass($sTargetObjectClass, $sFinalClass)) {
throw new Exception('The finalclass parameter should be a child class of the target object class');
}
} else {
$sFinalClass = $sTargetObjectClass;
}

// - Retrieving class attribute list
$aAttCodes = ApplicationHelper::GetLoadedListFromClass($aCombodoPortalInstanceConf['lists'], $sTargetObjectClass, 'list');
$aAttCodes = ApplicationHelper::GetLoadedListFromClass($aCombodoPortalInstanceConf['lists'], $sFinalClass, 'list');
// - Adding friendlyname attribute to the list is not already in it
$sTitleAttCode = 'friendlyname';
if (($sTitleAttCode !== null) && !in_array($sTitleAttCode, $aAttCodes)) {
Expand All @@ -838,10 +965,10 @@ public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $s
// - Retrieving scope search
// Note : This do NOT apply to custom fields as the portal administrator is not supposed to know which objects will be put in the templates.
// It is the responsibility of the template designer to write the right query so the user see only what he should.
$oScopeSearch = $this->oScopeValidatorHelper->GetScopeFilterForProfiles(UserRights::ListProfiles(), $sTargetObjectClass, UR_ACTION_READ);
$oScopeSearch = $this->oScopeValidatorHelper->GetScopeFilterForProfiles(UserRights::ListProfiles(), $sFinalClass, UR_ACTION_READ);
$aInternalParams = [];
if (($oScopeSearch === null) && ($oTargetAttDef->GetEditClass() !== 'CustomFields')) {
IssueLog::Info(__METHOD__.' at line '.__LINE__.' : User #'.UserRights::GetUserId().' has no scope query for '.$sTargetObjectClass.' class.');
IssueLog::Info(__METHOD__.' at line '.__LINE__.' : User #'.UserRights::GetUserId().' has no scope query for '.$sFinalClass.' class.');
throw new HttpException(Response::HTTP_NOT_FOUND, Dict::S('UI:ObjectDoesNotExist'));
}

Expand All @@ -855,7 +982,9 @@ public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $s
// Note : $oTemplateFieldSearch has been defined in the "Retrieving target object class from attcode" part, it is not available otherwise
$oSearch = $oTemplateFieldSearch;
}

if ($sFinalClass != $sTargetObjectClass) {
$oSearch->AddCondition('finalclass', $sFinalClass, '=');
}
// - Filtering objects to ignore
if (($aObjectIdsToIgnore !== null) && (is_array($aObjectIdsToIgnore))) {
//$oSearch->AddConditionExpression('id', $aObjectIdsToIgnore, 'NOT IN');
Expand All @@ -877,7 +1006,7 @@ public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $s
/** @noinspection SlowArrayOperationsInLoopInspection */
for ($i = 0; $i < count($aAttCodes); $i++) {
// Checking if the current attcode is an external key in order to search on the friendlyname
$oAttDef = MetaModel::GetAttributeDef($sTargetObjectClass, $aAttCodes[$i]);
$oAttDef = MetaModel::GetAttributeDef($sFinalClass, $aAttCodes[$i]);
$sAttCode = (!$oAttDef->IsExternalKey()) ? $aAttCodes[$i] : $aAttCodes[$i].'_friendlyname';
// Building expression for the current attcode
// - For attributes that need conversion from their display value to storage value
Expand Down Expand Up @@ -933,38 +1062,25 @@ public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $s
}
}

// Retrieving results
// - Preparing object set
$oSet = new DBObjectSet($oSearch, [], $aInternalParams);
$oSet->OptimizeColumnLoad([$oSearch->GetClassAlias() => $aAttCodes]);
$oSet->SetLimit($iListLength, $iListLength * ($iPageNumber - 1));
// - Retrieving columns properties
$aColumnProperties = [];
foreach ($aAttCodes as $sAttCode) {
$oAttDef = MetaModel::GetAttributeDef($sTargetObjectClass, $sAttCode);
$oAttDef = MetaModel::GetAttributeDef($sFinalClass, $sAttCode);
$aColumnProperties[$sAttCode] = [
'title' => $oAttDef->GetLabel(),
];
}
// - Retrieving objects
$aItems = [];
while ($oItem = $oSet->Fetch()) {
$aItems[] = $this->PrepareObjectInformation($oItem, $aAttCodes);
}

// Preparing response
if ($bInitialPass) {
$aData = $aData + [
'sParentClassName' => Dict::S('Class:'.$sTargetObjectClass),
'form' => [
'id' => 'object_search_form_'.time(),
'title' => Dict::Format('Brick:Portal:Object:Search:Regular:Title', $oTargetAttDef->GetLabel()),
'title_complement' => MetaModel::GetName($sTargetObjectClass),
],
'aColumnProperties' => json_encode($aColumnProperties),
'aResults' => [
'aItems' => json_encode($aItems),
'iCount' => count($aItems),
],
'bMultipleSelect' => $oTargetAttDef->IsLinkSet(),
'aSource' => [
'sFormPath' => $sFormPath,
Expand All @@ -974,21 +1090,43 @@ public function SearchFromAttributeAction(Request $oRequest, $sTargetAttCode, $s
'sFormManagerData' => $sFormManagerData,
],
];

if (MetaModel::HasChildrenClasses($sTargetObjectClass)) {
$aEnumChildClasses = \MetaModel::EnumChildClasses($sTargetObjectClass);
$aChildClasses = [];
Comment on lines +1093 to +1095
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Hardcoded FunctionalCI breaks subclass enumeration for all other target classes

Line 1093 correctly checks HasChildrenClasses($sTargetObjectClass), but line 1094 ignores $sTargetObjectClass and hardcodes 'FunctionalCI'. Whenever a user opens the search screen for any external key whose target is not FunctionalCI (e.g. Contact, Organization), the dropdown will still list FunctionalCI subclasses. The fix is MetaModel::EnumChildClasses($sTargetObjectClass).

foreach ($aEnumChildClasses as $sClassName) {
$aChildClasses[$sClassName] = MetaModel::GetName($sClassName);
}
asort($aChildClasses);
$aData = $aData + [
'bHasSubClasses' => true,
'aSubClasses' => $aChildClasses,
];
} else {
$aData = $aData + ['bHasSubClasses' => false];
}
if ($oRequest->isXmlHttpRequest()) {
$oResponse = $this->render($this->GetTemplatePath('modal'), $aData);
} else {
//throw new HttpException(Response::HTTP_NOT_FOUND, Dict::S('UI:ObjectDoesNotExist'));
$oResponse = $this->render($this->GetTemplatePath('page'), $aData);
}
} else {
// Retrieving results
// - Preparing object set
$oSet = new DBObjectSet($oSearch, [], $aInternalParams);
$oSet->OptimizeColumnLoad([$oSearch->GetClassAlias() => $aAttCodes]);
$oSet->SetLimit($iListLength, $iListLength * ($iPageNumber - 1));
// - Retrieving objects
$aItems = [];
while ($oItem = $oSet->Fetch()) {
$aItems[] = $this->PrepareObjectInformation($oItem, $aAttCodes);
}
$aData = $aData + [
'levelsProperties' => $aColumnProperties,
'data' => $aItems,
'recordsTotal' => $oSet->Count(),
'recordsFiltered' => $oSet->Count(),
];

$oResponse = new JsonResponse($aData);
}

Expand Down
Loading