bn8/ldapsaisie
1
0
Fork 0
mirror of https://gitlab.easter-eggs.com/ee/ldapsaisie.git synced 2024-11-22 18:09:06 +01:00
Code Issues Projects Releases Wiki Activity

CLI search: add --all parameter to permit to disable pagination

Browse source
This commit is contained in:
Benjamin Renard 2020-12-22 11:00:49 +01:00
parent f6f2e352bc
commit 1c13aa7cdd
1 changed files with 53 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
src/includes/class/class.LSsearch.php
View file

@ -1325,11 +1325,11 @@ class LSsearch extends LSlog_staticLoggerClass {
} }
/** /**
* List objects name * List LSsearchEntry objects
* *
* @retval Array DN associate with name * @retval Array DN associate with name
**/ **/
public function listObjectsName() { public function listEntries() {
if (!LSsession::loadLSclass('LSsearchEntry')) { if (!LSsession::loadLSclass('LSsearchEntry')) {
LSerror::addErrorCode('LSsession_05',$this -> LSobject); LSerror::addErrorCode('LSsession_05',$this -> LSobject);
return; return;
@ -1348,13 +1348,28 @@ class LSsearch extends LSlog_staticLoggerClass {
$this -> result['list'], $this -> result['list'],
$id $id
); );
$retval[$entry -> dn] = $entry -> displayName; $retval[$entry -> dn] = $entry;
} }
} }
return $retval; return $retval;
} }
/**
* List objects name
*
* @retval Array DN associate with name
**/
public function listObjectsName() {
$entries = $this -> listEntries();
if (!is_array($entries))
return;
$retval = array();
foreach($entries as $entry)
$retval[$entry -> dn] = $entry -> displayName;
return $retval;
}
/** /**
* List LSldapObjects * List LSldapObjects
* *
@ -1432,6 +1447,7 @@ class LSsearch extends LSlog_staticLoggerClass {
'extraDisplayedColumns' => false, 'extraDisplayedColumns' => false,
); );
$page_nb = 1; $page_nb = 1;
$all = false;
for ($i=0; $i < count($command_args); $i++) { for ($i=0; $i < count($command_args); $i++) {
switch ($command_args[$i]) { switch ($command_args[$i]) {
case '-f': case '-f':
@ -1497,6 +1513,9 @@ class LSsearch extends LSlog_staticLoggerClass {
case '--page': case '--page':
$page_nb = intval($command_args[++$i]); $page_nb = intval($command_args[++$i]);
break; break;
case '--all':
$all = true;
break;
default: default:
if (is_null($objType)) { if (is_null($objType)) {
$objType = $command_args[$i]; $objType = $command_args[$i];
@ -1532,21 +1551,30 @@ class LSsearch extends LSlog_staticLoggerClass {
if (!$search -> run()) if (!$search -> run())
self :: log_fatal('Fail to run search.'); self :: log_fatal('Fail to run search.');
// Retrieve page
$page = $search -> getPage(($page_nb-1));
/*
* $page = array(
* 'nb' => $page,
* 'nbPages' => 1,
* 'list' => array(),
* 'total' => $this -> total
* );
*/
// Check page if ($all) {
if (!is_array($page) || $page_nb > $page['nbPages']) $entries = $search -> listEntries();
self :: log_fatal("Fail to retreive page #$page_nb."); if (!is_array($entries))
if (empty($page['list'])) { self :: log_fatal("Fail to retreive search result");
}
else {
// Retrieve page
$page = $search -> getPage(($page_nb-1));
/*
* $page = array(
* 'nb' => $page,
* 'nbPages' => 1,
* 'list' => array(),
* 'total' => $this -> total
* );
*/
// Check page
if (!is_array($page) || $page_nb > $page['nbPages'])
self :: log_fatal("Fail to retreive page #$page_nb.");
}
if (empty($all?$entries:$page['list'])) {
echo "No $objType object found.\n"; echo "No $objType object found.\n";
exit(0); exit(0);
} }
@ -1564,7 +1592,7 @@ class LSsearch extends LSlog_staticLoggerClass {
$tbl->setHeaders($headers); $tbl->setHeaders($headers);
// Add one line for each object found (in page) // Add one line for each object found (in page)
foreach($page['list'] as $obj) { foreach($all?$entries:$page['list'] as $obj) {
$row = array( $row = array(
$obj -> dn, $obj -> dn,
$obj -> displayName, $obj -> displayName,
@ -1579,7 +1607,11 @@ class LSsearch extends LSlog_staticLoggerClass {
$tbl->addRow($row); $tbl->addRow($row);
} }
echo $tbl->getTable(); echo $tbl->getTable();
echo "Page ".($page['nb']+1)." on ".$page['nbPages']."\n"; if ($all)
echo "Total: ".$search -> total."\n";
else
echo "Page ".($page['nb']+1)." on ".$page['nbPages']." / Total: ".$search -> total."\n";
return true; return true;
} }
@ -1610,6 +1642,7 @@ class LSsearch extends LSlog_staticLoggerClass {
'-W', '--without-cache', '-W', '--without-cache',
'-e', '--extra-columns', '-e', '--extra-columns',
'-p', '--page', '-p', '--page',
'--all',
); );
// Detect positional args // Detect positional args
@ -1786,6 +1819,7 @@ LScli :: add_command(
' - -W|--without-cache : Disable cache', ' - -W|--without-cache : Disable cache',
' - -e|--extra-columns : Display extra columns', ' - -e|--extra-columns : Display extra columns',
' - -p|--page : page number to show (starting by 1, default: first one)', ' - -p|--page : page number to show (starting by 1, default: first one)',
' - --all : list all matching objects (no pagination)',
), ),
true, true,
array('LSsearch', 'cli_search_args_autocompleter') array('LSsearch', 'cli_search_args_autocompleter')