123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472 |
- <?php
- /* For licensing terms, see /license.txt */
- /**
- * This tool allows platform admins to add users by uploading a CSV or XML file
- * @package chamilo.admin
- */
- /**
- * Validate the imported data.
- */
- $cidReset = true;
- require_once __DIR__.'/../inc/global.inc.php';
- // Set this option to true to enforce strict purification for usenames.
- $purification_option_for_usernames = false;
- function validate_data($users)
- {
- global $defined_auth_sources;
- $errors = array();
- $usernames = array();
- // 1. Check if mandatory fields are set.
- $mandatory_fields = array('LastName', 'FirstName');
- if (api_get_setting('registration', 'email') == 'true') {
- $mandatory_fields[] = 'Email';
- }
- $classExistList = array();
- $usergroup = new UserGroup();
- foreach ($users as $user) {
- foreach ($mandatory_fields as $field) {
- if (isset($user[$field])) {
- if (empty($user[$field])) {
- $user['error'] = get_lang($field.'Mandatory');
- $errors[] = $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'])) {
- $user['error'] = get_lang('UserNameTooLong');
- $errors[] = $user;
- }
- // 2.2. Check whether the username was used twice in import file.
- if (isset($usernames[$user['NewUserName']])) {
- $user['error'] = get_lang('UserNameUsedTwice');
- $errors[] = $user;
- }
- $usernames[$user['UserName']] = 1;
- // 2.3. Check whether username is allready occupied.
- if (!UserManager::is_username_available($user['NewUserName']) && $user['NewUserName'] != $user['UserName']) {
- $user['error'] = get_lang('UserNameNotAvailable');
- $errors[] = $user;
- }
- }
- }
- // 3. Check status.
- if (isset($user['Status']) && !api_status_exists($user['Status'])) {
- $user['error'] = get_lang('WrongStatus');
- $errors[] = $user;
- }
- // 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)) {
- $user['error'] = sprintf(get_lang('ClassIdDoesntExists'), $id);
- $errors[] = $user;
- } else {
- $classExistList[] = $info['id'];
- }
- }
- }
- // 5. Check authentication source
- if (!empty($user['AuthSource'])) {
- if (!in_array($user['AuthSource'], $defined_auth_sources)) {
- $user['error'] = get_lang('AuthSourceNotAvailable');
- $errors[] = $user;
- }
- }
- }
- return $errors;
- }
- /**
- * Add missing user-information (which isn't required, like password, username etc).
- */
- function complete_missing_data($user)
- {
- global $purification_option_for_usernames;
- // 1. Create a username if necessary.
- if (UserManager::is_username_empty($user['UserName'])) {
- $user['UserName'] = UserManager::create_unique_username($user['FirstName'], $user['LastName']);
- } else {
- $user['UserName'] = UserManager::purify_username($user['UserName'], $purification_option_for_usernames);
- }
- // 2. Generate a password if necessary.
- if (empty($user['Password'])) {
- $user['Password'] = api_generate_password();
- }
- // 3. Set status if not allready set.
- if (empty($user['Status'])) {
- $user['Status'] = 'user';
- }
- // 4. Set authsource if not allready set.
- if (empty($user['AuthSource'])) {
- $user['AuthSource'] = PLATFORM_AUTH_SOURCE;
- }
- return $user;
- }
- /**
- * Update users from the imported data
- * @param array $users List of users
- * @return false|null
- * @uses global variable $inserted_in_course, which returns the list of courses the user was inserted in
- */
- function updateUsers($users)
- {
- global $insertedIn_course;
- // Not all scripts declare the $inserted_in_course array (although they should).
- if (!isset($inserted_in_course)) {
- $inserted_in_course = array();
- }
- $usergroup = new UserGroup();
- $send_mail = $_POST['sendMail'] ? true : false;
- if (is_array($users)) {
- foreach ($users as $user) {
- $user = complete_missing_data($user);
- $user['Status'] = api_status_key($user['Status']);
- $userName = $user['UserName'];
- $userInfo = api_get_user_info_from_username($userName);
- $user_id = $userInfo['user_id'];
- if ($user_id == 0) {
- return false;
- }
- $firstName = isset($user['FirstName']) ? $user['FirstName'] : $userInfo['firstname'];
- $lastName = isset($user['LastName']) ? $user['LastName'] : $userInfo['lastname'];
- $userName = isset($user['NewUserName']) ? $user['NewUserName'] : $userInfo['username'];
- $password = isset($user['Password']) ? $user['Password'] : $userInfo['password'];
- $authSource = isset($user['AuthSource']) ? $user['AuthSource'] : $userInfo['auth_source'];
- $email = isset($user['Email']) ? $user['Email'] : $userInfo['email'];
- $status = isset($user['Status']) ? $user['Status'] : $userInfo['status'];
- $officialCode = isset($user['OfficialCode']) ? $user['OfficialCode'] : $userInfo['official_code'];
- $phone = isset($user['PhoneNumber']) ? $user['PhoneNumber'] : $userInfo['phone'];
- $pictureUrl = isset($user['PictureUri']) ? $user['PictureUri'] : $userInfo['picture_uri'];
- $expirationDate = isset($user['ExpiryDate']) ? $user['ExpiryDate'] : $userInfo['expiration_date'];
- $active = isset($user['Active']) ? $user['Active'] : $userInfo['active'];
- $creatorId = $userInfo['creator_id'];
- $hrDeptId = $userInfo['hr_dept_id'];
- $language = isset($user['Language']) ? $user['Language'] : $userInfo['language'];
- $sendEmail = isset($user['SendEmail']) ? $user['SendEmail'] : $userInfo['language'];
- $userUpdated = UserManager :: update_user(
- $user_id,
- $firstName,
- $lastName,
- $userName,
- $password,
- $authSource,
- $email,
- $status,
- $officialCode,
- $phone,
- $pictureUrl,
- $expirationDate,
- $active,
- $creatorId,
- $hrDeptId,
- null,
- $language,
- '',
- '',
- ''
- );
- if (!is_array($user['Courses']) && !empty($user['Courses'])) {
- $user['Courses'] = array($user['Courses']);
- }
- if (is_array($user['Courses'])) {
- foreach ($user['Courses'] as $course) {
- if (CourseManager::course_exists($course)) {
- CourseManager::subscribe_user($user_id, $course, $user['Status']);
- $course_info = CourseManager::get_course_information($course);
- $inserted_in_course[$course] = $course_info['title'];
- }
- }
- }
- if (!empty($user['ClassId'])) {
- $classId = explode('|', trim($user['ClassId']));
- foreach ($classId as $id) {
- $usergroup->subscribe_users_to_usergroup(
- $id,
- array($user_id),
- false
- );
- }
- }
- // Saving extra fields.
- global $extra_fields;
- // We are sure that the extra field exists.
- foreach ($extra_fields as $extras) {
- if (isset($user[$extras[1]])) {
- $key = $extras[1];
- $value = $user[$extras[1]];
- UserManager::update_extra_field_value(
- $user_id,
- $key,
- $value
- );
- }
- }
- }
- }
- }
- /**
- * Read the CSV-file
- * @param string $file Path to the CSV-file
- * @return array All userinformation read from the file
- */
- function parse_csv_data($file)
- {
- $users = Import :: csvToArray($file);
- foreach ($users as $index => $user) {
- if (isset ($user['Courses'])) {
- $user['Courses'] = explode('|', trim($user['Courses']));
- }
- $users[$index] = $user;
- }
- return $users;
- }
- /**
- * XML-parser: handle start of element
- * @param string $parser Deprecated?
- * @param string $data The data to be parsed
- */
- function element_start($parser, $data)
- {
- $data = api_utf8_decode($data);
- global $user;
- global $current_tag;
- switch ($data) {
- case 'Contact':
- $user = array();
- break;
- default:
- $current_tag = $data;
- }
- }
- /**
- * XML-parser: handle end of element
- * @param string $parser Deprecated?
- * @param string $data The data to be parsed
- */
- function element_end($parser, $data)
- {
- $data = api_utf8_decode($data);
- global $user;
- global $users;
- global $current_value;
- switch ($data) {
- case 'Contact':
- if ($user['Status'] == '5') {
- $user['Status'] = STUDENT;
- }
- if ($user['Status'] == '1') {
- $user['Status'] = COURSEMANAGER;
- }
- $users[] = $user;
- break;
- default:
- $user[$data] = $current_value;
- break;
- }
- }
- /**
- * XML-parser: handle character data
- * @param string $parser Parser (deprecated?)
- * @param string $data The data to be parsed
- * @return void
- */
- function character_data($parser, $data)
- {
- $data = trim(api_utf8_decode($data));
- global $current_value;
- $current_value = $data;
- }
- /**
- * Read the XML-file
- * @param string $file Path to the XML-file
- * @return array All user information read from the file
- */
- function parse_xml_data($file)
- {
- global $users;
- $users = array();
- $parser = xml_parser_create('UTF-8');
- xml_set_element_handler($parser, 'element_start', 'element_end');
- xml_set_character_data_handler($parser, 'character_data');
- xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
- xml_parse($parser, api_utf8_encode_xml(file_get_contents($file)));
- xml_parser_free($parser);
- return $users;
- }
- $this_section = SECTION_PLATFORM_ADMIN;
- api_protect_admin_script(true, null, 'login');
- $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('ImportUserListXMLCSV');
- $interbreadcrumb[] = array("url" => 'index.php', "name" => get_lang('PlatformAdmin'));
- set_time_limit(0);
- $extra_fields = UserManager::get_extra_fields(0, 0, 5, 'ASC', true);
- $user_id_error = array();
- $error_message = '';
- if (isset($_POST['formSent']) && $_POST['formSent'] && $_FILES['import_file']['size'] !== 0) {
- $file_type = 'csv';
- Security::clear_token();
- $tok = Security::get_token();
- $allowed_file_mimetype = array('csv', 'xml');
- $error_kind_file = false;
- $uploadInfo = pathinfo($_FILES['import_file']['name']);
- $ext_import_file = $uploadInfo['extension'];
- if (in_array($ext_import_file, $allowed_file_mimetype)) {
- if (strcmp($file_type, 'csv') === 0 && $ext_import_file == $allowed_file_mimetype[0]) {
- $users = parse_csv_data($_FILES['import_file']['tmp_name']);
- $errors = validate_data($users);
- $error_kind_file = false;
- } elseif (strcmp($file_type, 'xml') === 0 && $ext_import_file == $allowed_file_mimetype[1]) {
- $users = parse_xml_data($_FILES['import_file']['tmp_name']);
- $errors = validate_data($users);
- $error_kind_file = false;
- } else {
- $error_kind_file = true;
- }
- } else {
- $error_kind_file = true;
- }
- // List user id with error.
- $users_to_insert = $user_id_error = array();
- if (is_array($errors)) {
- foreach ($errors as $my_errors) {
- $user_id_error[] = $my_errors['UserName'];
- }
- }
- if (is_array($users)) {
- foreach ($users as $my_user) {
- if (!in_array($my_user['UserName'], $user_id_error)) {
- $users_to_insert[] = $my_user;
- }
- }
- }
- $inserted_in_course = array();
- if (strcmp($file_type, 'csv') === 0) {
- updateUsers($users_to_insert);
- }
- if (count($errors) > 0) {
- $see_message_import = get_lang('FileImportedJustUsersThatAreNotRegistered');
- } else {
- $see_message_import = get_lang('FileImported');
- }
- if (count($errors) != 0) {
- $warning_message = '<ul>';
- foreach ($errors as $index => $error_user) {
- $warning_message .= '<li><b>'.$error_user['error'].'</b>: ';
- $warning_message .=
- '<strong>'.$error_user['UserName'].'</strong> ('.
- api_get_person_name($error_user['FirstName'], $error_user['LastName']).')';
- $warning_message .= '</li>';
- }
- $warning_message .= '</ul>';
- }
- // if the warning message is too long then we display the warning message trough a session
- Display::addFlash(Display::return_message($warning_message, 'warning', false));
- if ($error_kind_file) {
- Display::addFlash(Display::return_message(get_lang('YouMustImportAFileAccordingToSelectedOption'), 'error', false));
- } else {
- header('Location: '.api_get_path(WEB_CODE_PATH).'admin/user_list.php?sec_token='.$tok);
- exit;
- }
- }
- Display :: display_header($tool_name);
- if (!empty($error_message)) {
- Display::display_error_message($error_message);
- }
- $form = new FormValidator('user_update_import', 'post', api_get_self());
- $form->addElement('header', $tool_name);
- $form->addElement('hidden', 'formSent');
- $form->addElement('file', 'import_file', get_lang('ImportFileLocation'));
- $group = array();
- $form->addButtonImport(get_lang('Import'));
- $defaults['formSent'] = 1;
- $defaults['sendMail'] = 0;
- $defaults['file_type'] = 'csv';
- $form->setDefaults($defaults);
- $form->display();
- $list = array();
- $list_reponse = array();
- $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 = ' ';
- $result_xml .= $spaces.'<'.$extra[1].'>xxx</'.$extra[1].'>';
- 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;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();
|