chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #306 - Platform admin: Cleaning code in the user import script, for easier reading.

Browse Source
skala
Ivan Tcholakov 16 years ago
parent eb0a627e07
commit 2109615ac9
1 changed files with 141 additions and 138 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 279
      main/admin/user_import.php

279
main/admin/user_import.php
Unescape View File

@ -2,26 +2,28 @@
/* For licensing terms, see /dokeos_license.txt */
/**
==============================================================================
* This tool allows platform admins to add users by uploading a CSV or XML file
* This tool allows platform admins to add users by uploading a CSV or XML file
* @todo Add some langvars to DLTT
* @package dokeos.admin
* @package dokeos.admin
==============================================================================
*/
/**
* validate the imported data
* Validate the imported data.
*/
$language_file = array ('admin', 'registration');
require '../inc/global.inc.php';
require_once api_get_path(INCLUDE_PATH).'lib/mail.lib.inc.php';
require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php';
function validate_data($users) {
global $defined_auth_sources;
$errors = array ();
$usernames = array ();
$errors = array();
$usernames = array();
foreach ($users as $index => $user) {
//1. check if mandatory fields are set
$mandatory_fields = array ('LastName', 'FirstName');
// 1. check if mandatory fields are set
$mandatory_fields = array('LastName', 'FirstName');
if (api_get_setting('registration', 'email') == 'true') {
$mandatory_fields[] = 'Email';
}
@ -31,38 +33,38 @@ function validate_data($users) {
$errors[] = $user;
}
}
//2. check username
// 2. check username
if (isset ($user['UserName']) && strlen($user['UserName']) != 0) {
//2.1. check if no username was used twice in import file
// 2.1. check if no username was used twice in import file
if (isset ($usernames[$user['UserName']])) {
$user['error'] = get_lang('UserNameUsedTwice');
$errors[] = $user;
}
$usernames[$user['UserName']] = 1;
//2.2. check if username isn't allready in use in database
// 2.2. check if username isn't allready in use in database
if (!UserManager :: is_username_available($user['UserName'])) {
$user['error'] = get_lang('UserNameNotAvailable');
$errors[] = $user;
}
//2.3. check if username isn't longer than the 20 allowed characters
// 2.3. check if username isn't longer than the 20 allowed characters
if (api_strlen($user['UserName']) > 20) {
$user['error'] = get_lang('UserNameTooLong');
$errors[] = $user;
}
}
//3. check status
// 3. check status
if (isset ($user['Status']) && !api_status_exists($user['Status'])) {
$user['error'] = get_lang('WrongStatus');
$errors[] = $user;
}
//4. Check classname
// 4. Check classname
if (isset ($user['ClassName']) && strlen($user['ClassName']) != 0) {
if (!ClassManager :: class_name_exists($user['ClassName'])) {
$user['error'] = get_lang('ClassNameNotAvailable');
$errors[] = $user;
}
}
//5. Check authentication source
// 5. Check authentication source
if (isset ($user['AuthSource']) && strlen($user['AuthSource']) != 0) {
if (!in_array($user['AuthSource'], $defined_auth_sources)) {
$user['error'] = get_lang('AuthSourceNotAvailable');
@ -72,12 +74,12 @@ function validate_data($users) {
}
return $errors;
}
/**
* Add missing user-information (which isn't required, like password, username
* etc)
* Add missing user-information (which isn't required, like password, username etc).
*/
function complete_missing_data($user) {
//1. Create a username if necessary
// 1. Create a username if necessary.
if (!isset ($user['UserName']) || strlen($user['UserName']) == 0) {
$username = api_strtolower(api_ereg_replace('[^a-zA-Z]', '', api_substr($user['FirstName'], 0, 3).' '.api_substr($user['LastName'], 0, 4)));
if (!UserManager :: is_username_available($username)) {
@ -90,20 +92,21 @@ function complete_missing_data($user) {
}
$user['UserName'] = $username;
}
//2. generate a password if necessary
// 2. Generate a password if necessary.
if (!isset ($user['Password']) || strlen($user['Password']) == 0) {
$user['Password'] = api_generate_password();
}
//3. set status if not allready set
// 3. Set status if not allready set.
if (!isset ($user['Status']) || strlen($user['Status']) == 0) {
$user['Status'] = 'user';
}
//4. set authsource if not allready set
// 4. Set authsource if not allready set.
if (!isset ($user['AuthSource']) || strlen($user['AuthSource']) == 0) {
$user['AuthSource'] = PLATFORM_AUTH_SOURCE;
}
return $user;
}
/**
* Save the imported data
* @param array List of users
@ -111,72 +114,74 @@ function complete_missing_data($user) {
* @uses global variable $inserted_in_course, which returns the list of courses the user was inserted in
*/
function save_data($users) {
global $inserted_in_course;
// not all scripts declare the $inserted_in_course array (although they should)
if (!isset($inserted_in_course)) { $inserted_in_course = array(); }
require_once(api_get_path(INCLUDE_PATH).'lib/mail.lib.inc.php');
global $inserted_in_course;
// Not all scripts declare the $inserted_in_course array (although they should).
if (!isset($inserted_in_course)) {
$inserted_in_course = array();
}
require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php';
$user_table = Database :: get_main_table(TABLE_MAIN_USER);
$sendMail = $_POST['sendMail'] ? 1 : 0;
$send_mail = $_POST['sendMail'] ? 1 : 0;
if (is_array($users)) {
foreach ($users as $index => $user) {
$user = complete_missing_data($user);
$user['Status'] = api_status_key($user['Status']);
$user_id = UserManager :: create_user($user['FirstName'], $user['LastName'], $user['Status'], $user['Email'], $user['UserName'], $user['Password'], $user['OfficialCode'], api_get_setting('PlatformLanguage'), $user['PhoneNumber'], '', $user['AuthSource']);
if (!is_array($user['Courses']) && !empty($user['Courses'])) {
$user['Courses'] = array($user['Courses']);
}
if (is_array($user['Courses'])) {
foreach ($user['Courses'] as $index => $course) {
if (CourseManager :: course_exists($course)) {
CourseManager :: subscribe_user($user_id, $course,$user['Status']);
$c_info = CourseManager::get_course_information($course);
$inserted_in_course[$course] = $c_info['title'];
}
if (CourseManager :: course_exists($course,true)) {
// also subscribe to virtual courses through check on visual code
$list = CourseManager :: get_courses_info_from_visual_code($course);
foreach ($list as $vcourse) {
if ($vcourse['code'] == $course) {
//ignore, this has already been inserted
} else {
CourseManager :: subscribe_user($user_id, $vcourse['code'],$user['Status']);
$inserted_in_course[$vcourse['code']] = $vcourse['title'];
}
}
}
}
}
if (strlen($user['ClassName']) > 0) {
$class_id = ClassManager :: get_class_id($user['ClassName']);
ClassManager :: add_user($user_id, $class_id);
}
//saving extra fields
foreach ($users as $index => $user) {
$user = complete_missing_data($user);
$user['Status'] = api_status_key($user['Status']);
$user_id = UserManager :: create_user($user['FirstName'], $user['LastName'], $user['Status'], $user['Email'], $user['UserName'], $user['Password'], $user['OfficialCode'], api_get_setting('PlatformLanguage'), $user['PhoneNumber'], '', $user['AuthSource']);
if (!is_array($user['Courses']) && !empty($user['Courses'])) {
$user['Courses'] = array($user['Courses']);
}
if (is_array($user['Courses'])) {
foreach ($user['Courses'] as $index => $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 (CourseManager :: course_exists($course, true)) {
// Also subscribe to virtual courses through check on visual code.
$list = CourseManager :: get_courses_info_from_visual_code($course);
foreach ($list as $vcourse) {
if ($vcourse['code'] == $course) {
// Ignore, this has already been inserted.
} else {
CourseManager :: subscribe_user($user_id, $vcourse['code'],$user['Status']);
$inserted_in_course[$vcourse['code']] = $vcourse['title'];
}
}
}
}
}
if (strlen($user['ClassName']) > 0) {
$class_id = ClassManager :: get_class_id($user['ClassName']);
ClassManager :: add_user($user_id, $class_id);
}
// Saving extra fields.
global $extra_fields;
//print_R($user);
//we are sure the extra field exist
// 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);
$key = $extras[1];
$value = $user[$extras[1]];
UserManager::update_extra_field_value($user_id, $key,$value);
}
}
if ($sendMail) {
$recipient_name = api_get_person_name($user['FirstName'], $user['LastName'], null, PERSON_NAME_EMAIL_ADDRESS);
$emailsubject = '['.api_get_setting('siteName').'] '.get_lang('YourReg').' '.api_get_setting('siteName');
$emailbody = get_lang('Dear').api_get_person_name($user['FirstName'], $user['LastName']).",\n\n".get_lang('YouAreReg')." ".api_get_setting('siteName')." ".get_lang('Settings')." $user[UserName]\n".get_lang('Pass')." : $user[Password]\n\n".get_lang('Address')." ".api_get_setting('siteName')." ".get_lang('Is')." : ".api_get_path('WEB_PATH')." \n\n".get_lang('Problem')."\n\n".get_lang('Formula').",\n\n".api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'))."\n".get_lang('Manager')." ".api_get_setting('siteName')."\nT. ".api_get_setting('administratorTelephone')."\n".get_lang('Email')." : ".api_get_setting('emailAdministrator')."";
$sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
$email_admin = api_get_setting('emailAdministrator');
@api_mail($recipient_name, $user['Email'], $emailsubject, $emailbody, $sender_name,$email_admin);
}
}
}
if ($send_mail) {
$recipient_name = api_get_person_name($user['FirstName'], $user['LastName'], null, PERSON_NAME_EMAIL_ADDRESS);
$emailsubject = '['.api_get_setting('siteName').'] '.get_lang('YourReg').' '.api_get_setting('siteName');
$emailbody = get_lang('Dear').api_get_person_name($user['FirstName'], $user['LastName']).",\n\n".get_lang('YouAreReg')." ".api_get_setting('siteName')." ".get_lang('Settings')." $user[UserName]\n".get_lang('Pass')." : $user[Password]\n\n".get_lang('Address')." ".api_get_setting('siteName')." ".get_lang('Is')." : ".api_get_path('WEB_PATH')." \n\n".get_lang('Problem')."\n\n".get_lang('Formula').",\n\n".api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'))."\n".get_lang('Manager')." ".api_get_setting('siteName')."\nT. ".api_get_setting('administratorTelephone')."\n".get_lang('Email')." : ".api_get_setting('emailAdministrator')."";
$sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
$email_admin = api_get_setting('emailAdministrator');
@api_mail($recipient_name, $user['Email'], $emailsubject, $emailbody, $sender_name, $email_admin);
}
}
}
}
/**
* Read the CSV-file
* @param string $file Path to the CSV-file
@ -206,6 +211,7 @@ function element_start($parser, $data) {
$current_tag = $data;
}
}
/**
* XML-parser: handle end of element
*/
@ -213,15 +219,12 @@ function element_end($parser, $data) {
global $user;
global $users;
global $current_value;
switch ($data)
{
switch ($data) {
case 'Contact' :
if ($user['Status'] == '5')
{
if ($user['Status'] == '5') {
$user['Status'] = STUDENT;
}
if ($user['Status'] == '1')
{
if ($user['Status'] == '1') {
$user['Status'] = COURSEMANAGER;
}
$users[] = $user;
@ -231,6 +234,7 @@ function element_end($parser, $data) {
break;
}
}
/**
* XML-parser: handle character data
*/
@ -238,6 +242,7 @@ function character_data($parser, $data) {
global $current_value;
$current_value = $data;
}
/**
* Read the XML-file
* @param string $file Path to the XML-file
@ -248,27 +253,26 @@ function parse_xml_data($file) {
global $current_value;
global $user;
global $users;
$users = array ();
$users = array();
$parser = xml_parser_create();
xml_set_element_handler($parser, 'element_start', 'element_end');
xml_set_character_data_handler($parser, "character_data");
xml_set_character_data_handler($parser, 'character_data');
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
xml_parse($parser, file_get_contents($file));
xml_parser_free($parser);
return $users;
}
// name of the language file that needs to be included
$cidReset = true;
$this_section = SECTION_PLATFORM_ADMIN;
api_protect_admin_script();
require_once (api_get_path(LIBRARY_PATH).'fileManage.lib.php');
require_once (api_get_path(LIBRARY_PATH).'usermanager.lib.php');
require_once (api_get_path(LIBRARY_PATH).'classmanager.lib.php');
require_once (api_get_path(LIBRARY_PATH).'import.lib.php');
require_once (api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php');
$formSent = 0;
$errorMsg = '';
$defined_auth_sources[] = PLATFORM_AUTH_SOURCE;
if (is_array($extAuthSource)) {
$defined_auth_sources = array_merge($defined_auth_sources, array_keys($extAuthSource));
@ -276,46 +280,46 @@ if (is_array($extAuthSource)) {
$tool_name = get_lang('ImportUserListXMLCSV');
$interbreadcrumb[] = array ("url" => 'index.php', "name" => get_lang('PlatformAdmin'));
$interbreadcrumb[] = array ('url' => 'index.php', 'name' => get_lang('PlatformAdmin'));
set_time_limit(0);
$extra_fields = Usermanager::get_extra_fields(0, 0, 5, 'ASC',false);
$user_id_error=array();
$extra_fields = Usermanager::get_extra_fields(0, 0, 5, 'ASC', false);
$user_id_error = array();
if ($_POST['formSent'] AND $_FILES['import_file']['size'] !== 0) {
$file_type = $_POST['file_type'];
Security::clear_token();
$tok = Security::get_token();
$tok = Security::get_token();
if (strcmp($file_type,'csv')===0){ //&& strcmp($_FILES['import_file']['type'],'text/'.$file_type.'')===0) {
if (strcmp($file_type, 'csv') === 0) { //&& strcmp($_FILES['import_file']['type'],'text/'.$file_type.'')===0) {
$users = parse_csv_data($_FILES['import_file']['tmp_name']);
$errors = validate_data($users);
$error_kind_file=false;
} elseif (strcmp($file_type,'xml')===0){// && strcmp($_FILES['import_file']['type'],'text/'.$file_type.'')===0) {
$error_kind_file = false;
} elseif (strcmp($file_type, 'xml') === 0) { // && strcmp($_FILES['import_file']['type'],'text/'.$file_type.'')===0) {
$users = parse_xml_data($_FILES['import_file']['tmp_name']);
$errors = validate_data($users);
$error_kind_file=false;
$error_kind_file = false;
} else {
$error_kind_file=true;
$error_kind_file = true;
}
//list user id whith error
$user_id_error=array();
if (is_array($errors)){
// List user id whith error.
$user_id_error = array();
if (is_array($errors)) {
foreach ($errors as $my_errors) {
$user_id_error[]=$my_errors['UserName'];
$user_id_error[] = $my_errors['UserName'];
}
}
if (is_array($users)) {
if (is_array($users)) {
foreach ($users as $my_user) {
if (!in_array($my_user['UserName'],$user_id_error)) {
$users_to_insert[]=$my_user;
if (!in_array($my_user['UserName'], $user_id_error)) {
$users_to_insert[] = $my_user;
}
}
}
$inserted_in_course = array();
$inserted_in_course = array();
if (strcmp($_FILES['import_file']['type'],'text/'.$file_type.'') === 0) {
if (strcmp($_FILES['import_file']['type'], 'text/'.$file_type.'') === 0) {
save_data($users_to_insert);
} else {
$error_message = get_lang('YouMustImportAFileAccordingToSelectedOption');
@ -323,20 +327,20 @@ if ($_POST['formSent'] AND $_FILES['import_file']['size'] !== 0) {
exit ();
}
if ( count($errors)>0 ) {
$see_message_import=get_lang('FileImportedJustUsersThatAreNotRegistered');
if (count($errors) > 0) {
$see_message_import = get_lang('FileImportedJustUsersThatAreNotRegistered');
} else {
$see_message_import=get_lang('FileImported');
$see_message_import = get_lang('FileImported');
}
$msg2 = '';
if (count($inserted_in_course) > 1) {
$msg2 .= '<br>'.get_lang('UsersSubscribedToSeveralCoursesBecauseOfVirtualCourses').':';
foreach ($inserted_in_course as $course) {
$msg2 .= ' '.$course.',';
}
$msg2 = substr($msg2, 0, -1);
$msg2 .= '</br>';
}
$msg2 = '';
if (count($inserted_in_course)>1) {
$msg2 .="<br>".get_lang('UsersSubscribedToSeveralCoursesBecauseOfVirtualCourses').':';
foreach ($inserted_in_course as $course) {
$msg2 .= ' '.$course.',';
}
$msg2 = substr($msg2,0,-1);
$msg2 .= "</br>";
}
if (count($errors) != 0) {
$error_message = '<ul>';
@ -350,22 +354,22 @@ if ($_POST['formSent'] AND $_FILES['import_file']['size'] !== 0) {
header('Location: user_list.php?action=show_message&message='.urlencode($see_message_import).'&warn='.urlencode($error_message).'&sec_token='.$tok);
exit ();
}
Display :: display_header($tool_name);
//api_display_tool_title($tool_name);
if($_FILES['import_file']['size'] == 0 AND $_POST) {
if ($_FILES['import_file']['size'] == 0 AND $_POST) {
Display::display_error_message(get_lang('ThisFieldIsRequired'));
}
if ($error_kind_file===true) {
if ($error_kind_file === true) {
Display :: display_error_message(get_lang('YouMustImportAFileAccordingToSelectedOption'));
} else if (isset($_GET['warn'])) {
$error_message = Security::remove_XSS($_GET['warn']);
Display :: display_error_message($error_message);
}
$form = new FormValidator('user_import');
$form->addElement('header', '', $tool_name);
$form->addElement('hidden', 'formSent');
@ -377,25 +381,26 @@ $form->addElement('radio', 'file_type', get_lang('FileType'), 'XML (<a href="exe
$form->addElement('radio', 'file_type', null, 'CSV (<a href="exemple.csv" target="_blank">'.get_lang('ExampleCSVFile').'</a>)', 'csv');
$form->addElement('radio', 'sendMail', get_lang('SendMailToUsers'), get_lang('Yes'), 1);
$form->addElement('radio', 'sendMail', null, get_lang('No'), 0);
$form->addElement('style_submit_button', 'submit',get_lang('Import'),'class="save"');
$form->addElement('style_submit_button', 'submit', get_lang('Import'), 'class="save"');
$defaults['formSent'] = 1;
$defaults['file_type'] = 'xml';
$form->setDefaults($defaults);
$form->display();
$list=array();
$list_reponse=array();
$result_xml = '' ;
$i=0;
$list = array();
$list_reponse = array();
$result_xml = '';
$i = 0;
$count_fields = count($extra_fields);
if ($count_fields > 0) {
foreach($extra_fields as $extra) {
foreach ($extra_fields as $extra) {
$list[] = $extra[1];
$list_reponse[]='xxx';
$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/>';
$result_xml .= $spaces.'&lt;'.$extra[1].'&gt;xxx&lt;/'.$extra[1].'&gt;';
if ($i != $count_fields - 1) {
$result_xml .= '<br/>';
}
$i++;
}
}
@ -404,8 +409,8 @@ if ($count_fields > 0) {
<blockquote>
<pre>
<b>LastName</b>;<b>FirstName</b>;<b>Email</b>;UserName;Password;AuthSource;OfficialCode;PhoneNumber;Status;<font style="color:red;"><?php if(count($list)>0) echo implode(';', $list).';';?></font>Courses;ClassName;
<b>xxx</b>;<b>xxx</b>;<b>xxx</b>;xxx;xxx;<?php echo implode('/',$defined_auth_sources); ?>;xxx;xxx;user/teacher/drh;<font style="color:red;"><?php if(count($list_reponse)>0) echo implode(';', $list_reponse).';';?></font>xxx1|xxx2|xxx3;xxx;<br />
<b>LastName</b>;<b>FirstName</b>;<b>Email</b>;UserName;Password;AuthSource;OfficialCode;PhoneNumber;Status;<font style="color:red;"><?php if (count($list) > 0) echo implode(';', $list).';'; ?></font>Courses;ClassName;
<b>xxx</b>;<b>xxx</b>;<b>xxx</b>;xxx;xxx;<?php echo implode('/', $defined_auth_sources); ?>;xxx;xxx;user/teacher/drh;<font style="color:red;"><?php if (count($list_reponse) > 0) echo implode(';', $list_reponse).';'; ?></font>xxx1|xxx2|xxx3;xxx;<br />
</pre>
</blockquote>
@ -420,11 +425,11 @@ if ($count_fields > 0) {
<b>&lt;FirstName&gt;xxx&lt;/FirstName&gt;</b>
&lt;UserName&gt;xxx&lt;/UserName&gt;
&lt;Password&gt;xxx&lt;/Password&gt;
&lt;AuthSource&gt;<?php echo implode('/',$defined_auth_sources); ?>&lt;/AuthSource&gt;
&lt;AuthSource&gt;<?php echo implode('/', $defined_auth_sources); ?>&lt;/AuthSource&gt;
<b>&lt;Email&gt;xxx&lt;/Email&gt;</b>
&lt;OfficialCode&gt;xxx&lt;/OfficialCode&gt;
&lt;PhoneNumber&gt;xxx&lt;/PhoneNumber&gt;
&lt;Status&gt;user/teacher/drh&lt;/Status&gt; <?php if ($result_xml!='') { echo '<br /><font style="color:red;">',$result_xml;echo '</font>';} ?>
&lt;Status&gt;user/teacher/drh&lt;/Status&gt; <?php if ($result_xml != '') { echo '<br /><font style="color:red;">', $result_xml; echo '</font>'; } ?>
&lt;Courses&gt;xxx1|xxx2|xxx3&lt;/Courses&gt;
&lt;ClassName&gt;class 1&lt;/ClassName&gt;
&lt;/Contact&gt;
@ -433,8 +438,6 @@ if ($count_fields > 0) {
</blockquote>
<?php
/*
==============================================================================
FOOTER

Write Preview
Loading…
Cancel
Save