';
echo "
\n";
echo '';
include __DIR__ . '/../../lib/adminFooter.inc';
}
/**
* Runs the dry run and change actions.
*
* @param htmlResponsiveRow $container container
*/
function runActions(htmlResponsiveRow $container): void {
// LDAP suffix
$suffix = ($_POST['suffix'] === '-') ? trim($_POST['otherSuffix']) : $_POST['suffix'];
if (empty($suffix)) {
$error = new htmlStatusMessage('ERROR', _('LDAP Suffix is invalid!'));
$error->colspan = 5;
$container->add($error);
return;
}
// LDAP filter
$filter = trim($_POST['filter']);
// operations
$operations = [];
for ($i = 0; $i < $_POST['opcount']; $i++) {
if (!empty($_POST['attr_' . $i])) {
$operations[] = [$_POST['op_' . $i], strtolower(trim($_POST['attr_' . $i])), trim($_POST['val_' . $i])];
}
}
if (count($operations) === 0) {
$error = new htmlStatusMessage('ERROR', _('Please specify at least one operation.'));
$error->colspan = 5;
$container->add($error);
return;
}
$_SESSION['multiEdit_suffix'] = $suffix;
$_SESSION['multiEdit_filter'] = $filter;
$_SESSION['multiEdit_operations'] = $operations;
$_SESSION['multiEdit_status'] = ['stage' => STAGE_START];
$_SESSION['multiEdit_dryRun'] = isset($_POST['dryRun']);
// progress area
$container->add(new htmlSubTitle(_('Progress')));
$container->add(new htmlProgressbar('progressBar'));
$progressDiv = new htmlDiv('progressArea', new htmlOutputText(''));
$container->add($progressDiv);
// JS block for AJAX status update
$ajaxBlock = '
window.lam.multiedit.runActions();
';
$container->add(new htmlJavaScript($ajaxBlock));
}
/**
* Performs the modify operations.
*/
function runAjaxActions(): void {
$jsonReturn = [
'status' => STAGE_START,
'progress' => 0,
'content' => ''
];
switch ($_SESSION['multiEdit_status']['stage']) {
case STAGE_START:
$jsonReturn = readLDAPData();
break;
case STAGE_READ_FINISHED:
$jsonReturn = generateActions();
break;
case STAGE_ACTIONS_CALCULATED:
case STAGE_WRITING:
$jsonReturn = $_SESSION['multiEdit_dryRun'] ? dryRun() : doModify();
break;
}
echo json_encode($jsonReturn, JSON_THROW_ON_ERROR);
}
/**
* Reads the LDAP entries from the directory.
*
* @return array status
*/
function readLDAPData(): array {
$suffix = $_SESSION['multiEdit_suffix'];
$filter = $_SESSION['multiEdit_filter'];
if (empty($filter)) {
$filter = '(objectClass=*)';
}
$operations = $_SESSION['multiEdit_operations'];
$attributes = [];
foreach ($operations as $op) {
if (!in_array(strtolower($op[1]), $attributes)) {
$attributes[] = strtolower($op[1]);
$attributes = array_merge($attributes, extractWildcards($op[2]));
}
}
$attributes = array_values(array_unique($attributes));
// run LDAP query
$results = searchLDAP($suffix, $filter, $attributes);
// print error message if no data returned
if (empty($results)) {
$code = ldap_errno($_SESSION['ldap']->server());
if ($code !== 0) {
$msg = new htmlStatusMessage('ERROR', _('Encountered an error while performing search.'), getDefaultLDAPErrorString($_SESSION['ldap']->server()));
}
else {
$msg = new htmlStatusMessage('ERROR', _('No objects found!'));
}
$content = getMessageHTML($msg);
return [
'status' => STAGE_FINISHED,
'progress' => 100,
'content' => $content
];
}
// save LDAP data
$_SESSION['multiEdit_status']['entries'] = $results;
$_SESSION['multiEdit_status']['stage'] = STAGE_READ_FINISHED;
return [
'status' => STAGE_READ_FINISHED,
'progress' => 10,
'content' => ''
];
}
/**
* Generates the required actions based on the read LDAP data.
*
* @return array status
*/
function generateActions(): array {
$actions = [];
foreach ($_SESSION['multiEdit_status']['entries'] as $oldEntry) {
$dn = $oldEntry['dn'];
$newEntry = $oldEntry;
foreach ($_SESSION['multiEdit_operations'] as $op) {
$opType = $op[0];
$attr = $op[1];
$val = replaceWildcards($op[2], $oldEntry);
switch ($opType) {
case ADD:
if (empty($oldEntry[$attr]) || !in_array_ignore_case($val, $oldEntry[$attr])) {
$newEntry[$attr][] = $val;
}
break;
case MOD:
if (empty($oldEntry[$attr]) || !in_array_ignore_case($val, $oldEntry[$attr])) {
// attribute not yet exists, add it
$newEntry[$attr] = [$val];
}
break;
case DEL:
if (empty($val) && !empty($oldEntry[$attr])) {
unset($newEntry[$attr]);
}
elseif (!empty($val) && isset($oldEntry[$attr]) && in_array($val, $oldEntry[$attr])) {
$newEntry[$attr] = array_delete([$val], $newEntry[$attr]);
}
break;
}
}
unset($oldEntry['dn']);
unset($newEntry['dn']);
// cleanup
foreach ($newEntry as $name => &$values) {
// remove empty values
$values = array_values($values);
$count = count($values);
for ($i = 0; $i < $count; $i++) {
if ($values[$i] === '') {
unset($values[$i]);
}
}
$values = array_values($values);
// remove empty list of values
if (count($values) === 0) {
unset($newEntry[$name]);
}
}
// find deleted attributes (in $oldEntry but no longer in $newEntry)
foreach ($oldEntry as $name => $value) {
if (!isset($newEntry[$name])) {
$actions[$dn][$name] = [];
}
}
// find changed attributes
foreach ($newEntry as $name => $value) {
if (!isset($oldEntry[$name]) || !areArrayContentsEqual($value, $oldEntry[$name])) {
$actions[$dn][$name] = $value;
}
}
}
// save actions
$_SESSION['multiEdit_status']['actions'] = $actions;
$_SESSION['multiEdit_status']['stage'] = STAGE_ACTIONS_CALCULATED;
return [
'status' => STAGE_ACTIONS_CALCULATED,
'progress' => 20,
'content' => ''
];
}
/**
* Prints the dryRun output.
*
* @return array status
* @throws LAMException error simulating actions
*/
function dryRun(): array {
$pro = isLAMProVersion() ? ' Pro' : '';
$ldif = '# LDAP Account Manager' . $pro . ' ' . LAMVersion() . "\n\nversion: 1\n\n";
$log = '';
// fill LDIF and log file
foreach ($_SESSION['multiEdit_status']['actions'] as $dn => $changes) {
$log .= $dn . "\r\n";
$ldif .= 'dn: ' . $dn . "\n";
$ldif .= 'changetype: modify' . "\n";
$isFirstChange = true;
foreach ($changes as $attr => $values) {
$log .= '* ' . $attr . '=' . implode(', ', $values) . "\r\n";
if (!$isFirstChange) {
$ldif .= "-\n";
}
$ldif .= 'replace: ' . $attr . "\n";
foreach ($values as $value) {
$ldif .= $attr . ': ' . $value . "\n";
}
$isFirstChange = false;
}
$ldif .= "\n";
$log .= "\r\n";
}
// build meta HTML
$container = new htmlTable();
$container->addElement(new htmlOutputText(_('Dry run finished.')), true);
$container->addVerticalSpace('20px');
// store LDIF
$tempFilesManager = new LamTemporaryFilesManager();
$fileName = $tempFilesManager->registerTemporaryFile('.ldif', 'ldif_');
$out = $tempFilesManager->openTemporaryFileForWrite($fileName);
fwrite($out, $ldif);
$container->addElement(new htmlOutputText(_('LDIF file')), true);
$ldifLink = new htmlLink($fileName, $tempFilesManager->getDownloadLink($fileName));
$ldifLink->setTargetWindow('_blank');
$container->addElement($ldifLink, true);
$container->addVerticalSpace('20px');
$container->addElement(new htmlOutputText(_('Log output')), true);
$container->addElement(new htmlInputTextarea('log', $log, 100, 30), true);
// generate HTML
fclose ($out);
ob_start();
parseHtml(null, $container, [], true, 'user');
$content = ob_get_contents();
ob_end_clean();
return [
'status' => STAGE_FINISHED,
'progress' => 100,
'content' => $content
];
}
/**
* Error handler
*
* @param int $errno error number
* @param string $errstr error message
* @param string $errfile error file
* @param int $errline error line
* @return bool stop internal error handler
*/
function multiEditLdapErrorHandler($errno, $errstr, $errfile, $errline): bool {
if (($errno === E_USER_ERROR) || ($errno === E_ERROR)) {
logNewMessage(LOG_ERR, 'Error occurred: ' . $errstr . " ($errfile: $errline)");
$_REQUEST['multiEdit_error'] = true;
}
elseif (($errno === E_USER_WARNING) || ($errno === E_WARNING)) {
logNewMessage(LOG_WARNING, 'Error occurred: ' . $errstr . " ($errfile: $errline)");
$_REQUEST['multiEdit_error'] = true;
}
return true;
}
/**
* Runs the actual modifications.
*
* @return array status
*/
function doModify(): array {
set_error_handler(\LAM\TOOLS\MULTI_EDIT\multiEditLdapErrorHandler(...));
// initial action index
if (!isset($_SESSION['multiEdit_status']['index'])) {
$_SESSION['multiEdit_status']['index'] = 0;
$_SESSION['multiEdit_status']['dnList'] = array_keys($_SESSION['multiEdit_status']['actions']);
}
// initial content
if (!isset($_SESSION['multiEdit_status']['modContent'])) {
$_SESSION['multiEdit_status']['modContent'] = '';
}
// run 10 modifications in each call
$localCount = 0;
while (($localCount < 10) && ($_SESSION['multiEdit_status']['index'] < count($_SESSION['multiEdit_status']['dnList']))) {
$dn = $_SESSION['multiEdit_status']['dnList'][$_SESSION['multiEdit_status']['index']];
$changes = $_SESSION['multiEdit_status']['actions'][$dn];
$_SESSION['multiEdit_status']['modContent'] .= htmlspecialchars($dn) . "
";
// run LDAP commands
$success = ldap_modify($_SESSION['ldap']->server(), $dn, $changes);
if (!$success || isset($_REQUEST['multiEdit_error'])) {
$msg = new htmlStatusMessage('ERROR', getDefaultLDAPErrorString($_SESSION['ldap']->server()));
$_SESSION['multiEdit_status']['modContent'] .= getMessageHTML($msg);
}
$localCount++;
$_SESSION['multiEdit_status']['index']++;
}
// check if finished
if ($_SESSION['multiEdit_status']['index'] == count($_SESSION['multiEdit_status']['actions'])) {
$_SESSION['multiEdit_status']['modContent'] .= '
' . _('Finished all operations.');
return [
'status' => STAGE_FINISHED,
'progress' => 100,
'content' => $_SESSION['multiEdit_status']['modContent']
];
}
// return current status
return [
'status' => STAGE_WRITING,
'progress' => 20 + (($_SESSION['multiEdit_status']['index'] / count($_SESSION['multiEdit_status']['actions'])) * 80),
'content' => $_SESSION['multiEdit_status']['modContent']
];
}
/**
* Returns the HTML code for a htmlStatusMessage
*
* @param htmlStatusMessage $msg message
* @return string HTML code
*/
function getMessageHTML(htmlStatusMessage $msg): string {
ob_start();
parseHtml(null, $msg, [], true, 'user');
$content = ob_get_contents();
ob_end_clean();
if ($content === false) {
return '';
}
return $content;
}