chamilo-lms/main/admin/user_update_import.php

<?php

/* For licensing terms, see /license.txt */

/**
 * This tool allows platform admins to add users by uploading a CSV or XML file.
 */
$cidReset = true;
require_once __DIR__.'/../inc/global.inc.php';

// Set this option to true to enforce strict purification for usernames.
$purification_option_for_usernames = false;

/**
 * @param array $users
 *
 * @return array
 */
function validate_data($users)
{
    global $defined_auth_sources;
    $errors = [];
    $usernames = [];
    $classExistList = [];
    $usergroup = new UserGroup();

    foreach ($users as $user) {
        // 2. Check username, first, check whether it is empty.
        if (isset($user['NewUserName'])) {
            if (!UserManager::is_username_empty($user['NewUserName'])) {
                // 2.1. Check whether username is too long.
                if (UserManager::is_username_too_long($user['NewUserName'])) {
                    $errors[$user['UserName']][] = get_lang('UserNameTooLong');
                }
                // 2.2. Check whether the username was used twice in import file.
                if (isset($usernames[$user['NewUserName']])) {
                    $errors[$user['UserName']][] = get_lang('UserNameUsedTwice');
                }
                $usernames[$user['UserName']] = 1;
                // 2.3. Check whether username is allready occupied.
                if (!UserManager::is_username_available($user['NewUserName']) &&
                    $user['NewUserName'] != $user['UserName']
                ) {
                    $errors[$user['UserName']][] = get_lang('UserNameNotAvailable');
                }
            }
        }

        // 3. Check status.
        if (isset($user['Status']) && !api_status_exists($user['Status'])) {
            $errors[$user['UserName']][] = get_lang('WrongStatus');
        }

        // 4. Check ClassId
        if (!empty($user['ClassId'])) {
            $classId = explode('|', trim($user['ClassId']));
            foreach ($classId as $id) {
                if (in_array($id, $classExistList)) {
                    continue;
                }
                $info = $usergroup->get($id);
                if (empty($info)) {
                    $errors[$user['UserName']][] = sprintf(get_lang('ClassIdDoesntExists'), $id);
                } else {
                    $classExistList[] = $info['id'];
                }
            }
        }

        // 5. Check authentication source
        if (!empty($user['AuthSource'])) {
            if (!in_array($user['AuthSource'], $defined_auth_sources)) {
                $errors[$user['UserName']][] = get_lang('AuthSourceNotAvailable');
            }
        }
    }

    return $errors;
}

/**
 * Update users from the imported data.
 *
 * @param array $users         List of users.
 * @param bool  $resetPassword Optional.
 * @param bool  $sendEmail     Optional.
 */
function _updateUsers(
    $users,
    $resetPassword = false,
    $sendEmail = false,
    $askNewPassword = false
) {
    $usergroup = new UserGroup();
    $extraFieldValue = new ExtraFieldValue('user');
    if (is_array($users)) {
        foreach ($users as $user) {
            if (isset($user['Status'])) {
                $user['Status'] = api_status_key($user['Status']);
            }

            $userInfo = api_get_user_info_from_username($user['UserName']);

            if (empty($userInfo)) {
                continue;
            }
            /*
            // In specific cases, you might want to only update if the e-mail
            // in the CSV is different from the e-mail in the database
            if (!empty($user['Email'])) {
                if ($user['Email'] == $userInfo['email']) {
                    continue;
                }
            }
            */

            $user_id = $userInfo['user_id'];
            $firstName = $user['FirstName'] ?? $userInfo['firstname'];
            $lastName = $user['LastName'] ?? $userInfo['lastname'];
            $userName = $user['NewUserName'] ?? $userInfo['username'];
            $changePassMethod = 0;
            $password = null;
            $authSource = $userInfo['auth_source'];

            if ($resetPassword) {
                $changePassMethod = 1;
            } else {
                if (isset($user['Password'])) {
                    $changePassMethod = 2;
                    $password = $user['Password'];
                }

                if (isset($user['AuthSource']) && $user['AuthSource'] != $authSource) {
                    $authSource = $user['AuthSource'];
                    $changePassMethod = 3;
                }
            }

            $email = $user['Email'] ?? $userInfo['email'];
            $status = $user['Status'] ?? $userInfo['status'];
            $officialCode = $user['OfficialCode'] ?? $userInfo['official_code'];
            $phone = $user['PhoneNumber'] ?? $userInfo['phone'];
            $pictureUrl = $user['PictureUri'] ?? $userInfo['picture_uri'];
            $expirationDate = $user['ExpiryDate'] ?? $userInfo['expiration_date'];
            // Fix wrong date in DB for old users (sometimes would be expiration_date = '9999-12-31 ********') where it should be null
            if (substr($expirationDate, 0, 4) === '9999') {
                $expirationDate = null;
            }
            $active = $userInfo['active'];
            if (isset($user['Active'])) {
                $user['Active'] = (int) $user['Active'];
                if (-1 === $user['Active']) {
                    $user['Active'] = 0;
                }
                $active = $user['Active'];
            }

            $creatorId = $userInfo['creator_id'];
            $hrDeptId = $userInfo['hr_dept_id'];
            $language = $user['Language'] ?? $userInfo['language'];
            //$sendEmail = isset($user['SendEmail']) ? $user['SendEmail'] : $userInfo['language'];
            //$sendEmail = false;
            // see BT#17893
            if ($resetPassword && $sendEmail == false) {
                $sendEmail = true;
            }
            $extra = [];
            if ($askNewPassword) {
                $extra['ask_new_password'] = 1;
            }

            UserManager::update_user(
                $user_id,
                $firstName,
                $lastName,
                $userName,
                $password,
                $authSource,
                $email,
                $status,
                $officialCode,
                $phone,
                $pictureUrl,
                $expirationDate,
                $active,
                $creatorId,
                $hrDeptId,
                $extra,
                $language,
                '',
                $sendEmail,
                $changePassMethod
            );

            if (!empty($user['Courses']) && !is_array($user['Courses'])) {
                $user['Courses'] = [$user['Courses']];
            }
            if (!empty($user['Courses']) && is_array($user['Courses'])) {
                foreach ($user['Courses'] as $course) {
                    if (CourseManager::course_exists($course)) {
                        CourseManager::subscribeUser($user_id, $course, $user['Status']);
                    }
                }
            }
            if (!empty($user['ClassId'])) {
                $classId = explode('|', trim($user['ClassId']));
                foreach ($classId as $id) {
                    $usergroup->subscribe_users_to_usergroup(
                        $id,
                        [$user_id],
                        false
                    );
                }
            }

            // Saving extra fields.
            global $extra_fields;

            // We are sure that the extra field exists.
            $userExtraFields = [
                'item_id' => $user_id,
            ];
            $add = false;
            foreach ($extra_fields as $extras) {
                if (isset($user[$extras[1]])) {
                    $key = $extras[1];
                    $value = $user[$extras[1]];
                    $userExtraFields["extra_$key"] = $value;
                    $add = true;
                }
            }
            if ($add) {
                $extraFieldValue->saveFieldValues($userExtraFields, true);
            }

            $userUpdated = api_get_user_info($user_id);
            Display::addFlash(
                Display::return_message(get_lang('UserUpdated').': '.$userUpdated['complete_name_with_username'])
            );
        }
    }
}

/**
 * Read the CSV-file.
 *
 * @param string $file Path to the CSV-file
 *
 * @throws Exception
 *
 * @return array All userinformation read from the file
 */
function parse_csv_data($file)
{
    $data = Import::csv_reader($file);
    if (empty($data)) {
        throw new Exception(get_lang('NoDataAvailable'));
    }
    $users = [];
    foreach ($data as $row) {
        if (isset($row['Courses'])) {
            $row['Courses'] = explode('|', trim($row['Courses']));
        }
        if (!isset($row['UserName'])) {
            throw new Exception(get_lang('ThisFieldIsRequired').': UserName');
        }
        $users[] = $row;
    }

    return $users;
}

function parse_xml_data($file)
{
    $crawler = Import::xml($file);
    $crawler = $crawler->filter('Contacts > Contact ');
    $array = [];
    foreach ($crawler as $domElement) {
        $row = [];
        foreach ($domElement->childNodes as $node) {
            if ($node->nodeName != '#text') {
                $row[$node->nodeName] = $node->nodeValue;
            }
        }
        if (!empty($row)) {
            $array[] = $row;
        }
    }

    return $array;
}

$this_section = SECTION_PLATFORM_ADMIN;
api_protect_admin_script(true, null);

$defined_auth_sources[] = PLATFORM_AUTH_SOURCE;
if (isset($extAuthSource) && is_array($extAuthSource)) {
    $defined_auth_sources = array_merge($defined_auth_sources, array_keys($extAuthSource));
}

$tool_name = get_lang('UpdateUserListXMLCSV');
$interbreadcrumb[] = ["url" => 'index.php', "name" => get_lang('PlatformAdmin')];

set_time_limit(0);
$extra_fields = UserManager::get_extra_fields(0, 0, 5, 'ASC', true);

$form = new FormValidator('user_update_import', 'post', api_get_self());
$form->addHeader($tool_name);
$form->addFile('import_file', get_lang('ImportFileLocation'), ['accept' => 'text/csv', 'id' => 'import_file']);
$form->addCheckBox('reset_password', '', get_lang('AutoGeneratePassword'));
if (api_get_configuration_value('force_renew_password_at_first_login') == true) {
    $form->addElement(
        'checkbox',
        'ask_new_password',
        '',
        get_lang('FirstLoginForceUsersToChangePassword')
    );
}

$group = [
    $form->createElement('radio', 'sendMail', '', get_lang('Yes'), 1),
    $form->createElement('radio', 'sendMail', null, get_lang('No'), 0),
];
$form->addGroup($group, '', get_lang('SendMailToUsers'));
$defaults['sendMail'] = 0;

if ($form->validate()) {
    if (Security::check_token()) {
        Security::clear_token();
        $formValues = $form->exportValues();

        if (empty($_FILES['import_file']) || empty($_FILES['import_file']['size'])) {
            header('Location: '.api_get_self());
            exit;
        }

        $uploadInfo = pathinfo($_FILES['import_file']['name']);

        if ($uploadInfo['extension'] !== 'csv') {
            Display::addFlash(
                Display::return_message(get_lang('YouMustImportAFileAccordingToSelectedOption'), 'error')
            );

            header('Location: '.api_get_self());
            exit;
        }

        try {
            $users = parse_csv_data($_FILES['import_file']['tmp_name']);
        } catch (Exception $exception) {
            Display::addFlash(
                Display::return_message($exception->getMessage(), 'error')
            );

            header('Location: '.api_get_self());
            exit;
        }

        $errors = validate_data($users);
        $errorUsers = array_keys($errors);
        $usersToUpdate = [];

        foreach ($users as $user) {
            if (!in_array($user['UserName'], $errorUsers)) {
                $usersToUpdate[] = $user;
            }
        }

        $sendEmail = $_POST['sendMail'] ? true : false;
        $askNewPassword = isset($formValues['ask_new_password']);

        _updateUsers($usersToUpdate, isset($formValues['reset_password']), $sendEmail, $askNewPassword);

        if (empty($errors)) {
            Display::addFlash(
                Display::return_message(get_lang('FileImported'), 'success')
            );
        } else {
            $warningMessage = '';
            foreach ($errors as $errorUsername => $errorUserMessages) {
                $warningMessage .= "<strong>$errorUsername</strong>";
                $warningMessage .= '<ul><li>'.implode('</li><li>', $errorUserMessages).'</li></ul>';
            }

            Display::addFlash(
                Display::return_message(get_lang('FileImportedJustUsersThatAreNotRegistered'), 'warning')
            );
            Display::addFlash(Display::return_message($warningMessage, 'warning', false));
        }
    } else {
        Display::addFlash(Display::return_message(get_lang('LinkExpired'), 'warning', false));
    }

    header('Location: '.api_get_self());
    exit;
}

Display::display_header($tool_name);
$token = Security::get_token();

$form->setDefaults($defaults);
$form->addHidden('sec_token', $token);
$form->addButtonImport(get_lang('Import'));
$form->display();

$list = [];
$list_reponse = [];
$result_xml = '';
$i = 0;
$count_fields = count($extra_fields);
if ($count_fields > 0) {
    foreach ($extra_fields as $extra) {
        $list[] = $extra[1];
        $list_reponse[] = 'xxx';
        $spaces = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
        $result_xml .= $spaces.'&lt;'.$extra[1].'&gt;xxx&lt;/'.$extra[1].'&gt;';
        if ($i != $count_fields - 1) {
            $result_xml .= '<br/>';
        }
        $i++;
    }
}

?>
    <p><?php echo get_lang('CSVMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>
    <blockquote>
    <pre>
        <b>UserName</b>;LastName;FirstName;Email;NewUserName;Password;AuthSource;OfficialCode;PhoneNumber;Status;ExpiryDate;Active;Language;<span style="color:red;"><?php if (count($list) > 0) {
    echo implode(';', $list).';';
} ?></span>Courses;ClassId;
        xxx;xxx;xxx;xxx;xxx;xxx;xxx;xxx;xxx;user/teacher/drh;YYYY-MM-DD 00:00:00;0/1;xxx;<span
            style="color:red;"><?php if (count($list_reponse) > 0) {
    echo implode(';', $list_reponse).';';
} ?></span>xxx1|xxx2|xxx3;1;<br/>
    </pre>
    </blockquote>
    <p>
<?php
Display::display_footer();