You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
396 lines
15 KiB
396 lines
15 KiB
<?php // $Id: user_import.php 18648 2009-02-24 05:35:43Z yannoo $
|
|
/* For licensing terms, see /dokeos_license.txt */
|
|
/**
|
|
==============================================================================
|
|
* This tool allows platform admins to add users by uploading a CSV or XML file
|
|
* @todo Add some langvars to DLTT
|
|
* @package dokeos.admin
|
|
==============================================================================
|
|
*/
|
|
/**
|
|
* validate the imported data
|
|
*/
|
|
function validate_data($users) {
|
|
global $defined_auth_sources;
|
|
$errors = array ();
|
|
$usernames = array ();
|
|
foreach ($users as $index => $user) {
|
|
//1. check if mandatory fields are set
|
|
$mandatory_fields = array ('LastName', 'FirstName');
|
|
if (api_get_setting('registration', 'email') == 'true') {
|
|
$mandatory_fields[] = 'Email';
|
|
}
|
|
foreach ($mandatory_fields as $key => $field) {
|
|
if (!isset ($user[$field]) || strlen($user[$field]) == 0) {
|
|
$user['error'] = get_lang($field.'Mandatory');
|
|
$errors[] = $user;
|
|
}
|
|
}
|
|
//2. check username
|
|
if (isset ($user['UserName']) && strlen($user['UserName']) != 0) {
|
|
//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
|
|
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
|
|
if (strlen($user['UserName']) > 20) {
|
|
$user['error'] = get_lang('UserNameTooLong');
|
|
$errors[] = $user;
|
|
}
|
|
}
|
|
//3. check status
|
|
if (isset ($user['Status']) && !api_status_exists($user['Status'])) {
|
|
$user['error'] = get_lang('WrongStatus');
|
|
$errors[] = $user;
|
|
}
|
|
//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
|
|
if (isset ($user['AuthSource']) && strlen($user['AuthSource']) != 0) {
|
|
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) {
|
|
//1. Create a username if necessary
|
|
if (!isset ($user['UserName']) || strlen($user['UserName']) == 0) {
|
|
$username = strtolower(ereg_replace('[^a-zA-Z]', '', substr($user['FirstName'], 0, 3).' '.substr($user['LastName'], 0, 4)));
|
|
if (!UserManager :: is_username_available($username)) {
|
|
$i = 0;
|
|
$temp_username = $username.$i;
|
|
while (!UserManager :: is_username_available($temp_username)) {
|
|
$temp_username = $username.++$i;
|
|
}
|
|
$username = $temp_username;
|
|
}
|
|
$user['UserName'] = $username;
|
|
}
|
|
//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
|
|
if (!isset ($user['Status']) || strlen($user['Status']) == 0) {
|
|
$user['Status'] = 'user';
|
|
}
|
|
//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
|
|
* @return void
|
|
* @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');
|
|
$user_table = Database :: get_main_table(TABLE_MAIN_USER);
|
|
$sendMail = $_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
|
|
global $extra_fields;
|
|
//print_R($user);
|
|
//we are sure the extra field exist
|
|
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);
|
|
}
|
|
}
|
|
|
|
if ($sendMail) {
|
|
$recipient_name = $user['FirstName'].' '.$user['LastName'];
|
|
$emailsubject = '['.api_get_setting('siteName').'] '.get_lang('YourReg').' '.api_get_setting('siteName');
|
|
$emailbody = get_lang('Dear').$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_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 = get_setting('administratorName').' '.get_setting('administratorSurname');
|
|
$email_admin = 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
|
|
* @return array All userinformation read from the file
|
|
*/
|
|
function parse_csv_data($file) {
|
|
$users = Import :: csv_to_array($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
|
|
*/
|
|
function element_start($parser, $data) {
|
|
global $user;
|
|
global $current_tag;
|
|
switch ($data) {
|
|
case 'Contact' :
|
|
$user = array ();
|
|
break;
|
|
default :
|
|
$current_tag = $data;
|
|
}
|
|
}
|
|
/**
|
|
* XML-parser: handle end of element
|
|
*/
|
|
function element_end($parser, $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
|
|
*/
|
|
function character_data($parser, $data) {
|
|
global $current_value;
|
|
$current_value = $data;
|
|
}
|
|
/**
|
|
* Read the XML-file
|
|
* @param string $file Path to the XML-file
|
|
* @return array All userinformation read from the file
|
|
*/
|
|
function parse_xml_data($file) {
|
|
global $current_tag;
|
|
global $current_value;
|
|
global $user;
|
|
global $users;
|
|
$users = array ();
|
|
$parser = xml_parser_create();
|
|
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, file_get_contents($file));
|
|
xml_parser_free($parser);
|
|
return $users;
|
|
}
|
|
// name of the language file that needs to be included
|
|
$language_file = array ('admin', 'registration');
|
|
|
|
$cidReset = true;
|
|
include ('../inc/global.inc.php');
|
|
$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));
|
|
}
|
|
|
|
$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',false);
|
|
|
|
if ($_POST['formSent'] AND $_FILES['import_file']['size'] !== 0) {
|
|
$file_type = $_POST['file_type'];
|
|
if ($file_type == 'csv') {
|
|
$users = parse_csv_data($_FILES['import_file']['tmp_name']);
|
|
} else {
|
|
$users = parse_xml_data($_FILES['import_file']['tmp_name']);
|
|
}
|
|
$errors = validate_data($users);
|
|
if (count($errors) == 0) {
|
|
$inserted_in_course = array();
|
|
save_data($users);
|
|
$msg2 = '';
|
|
if (count($inserted_in_course)>1) {
|
|
$msg2 .= get_lang('UsersSubscribedToSeveralCoursesBecauseOfVirtualCourses').':';
|
|
foreach ($inserted_in_course as $course) {
|
|
$msg2 .= ' '.$course.',';
|
|
}
|
|
$msg2 = substr($msg2,0,-1);
|
|
}
|
|
Security::clear_token();
|
|
$tok = Security::get_token();
|
|
header('Location: user_list.php?action=show_message&message='.urlencode(get_lang('FileImported')).'&warn='.urlencode($msg2).'&sec_token='.$tok);
|
|
exit ();
|
|
}
|
|
}
|
|
Display :: display_header($tool_name);
|
|
//api_display_tool_title($tool_name);
|
|
|
|
if($_FILES['import_file']['size'] == 0 AND $_POST) {
|
|
Display::display_error_message(get_lang('ThisFieldIsRequired'));
|
|
}
|
|
|
|
if (count($errors) != 0) {
|
|
$error_message = '<ul>';
|
|
foreach ($errors as $index => $error_user) {
|
|
$error_message .= '<li><b>'.$error_user['error'].'</b>: ';
|
|
$error_message .= $error_user['UserName'].' ('.$error_user['FirstName'].' '.$error_user['LastName'].')';
|
|
$error_message .= '</li>';
|
|
}
|
|
$error_message .= '</ul>';
|
|
Display :: display_error_message($error_message, false);
|
|
}
|
|
$form = new FormValidator('user_import');
|
|
$form->addElement('hidden', 'formSent');
|
|
$form->addElement('file', 'import_file', get_lang('ImportFileLocation'));
|
|
$form->addRule('import_file', get_lang('ThisFieldIsRequired'), 'required');
|
|
$allowed_file_types = array ('xml', 'csv');
|
|
$form->addRule('file', get_lang('InvalidExtension').' ('.implode(',', $allowed_file_types).')', 'filetype', $allowed_file_types);
|
|
$form->addElement('radio', 'file_type', get_lang('FileType'), 'XML (<a href="exemple.xml" target="_blank">'.get_lang('ExampleXMLFile').'</a>)', 'xml');
|
|
$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('submit', 'submit', get_lang('Ok'));
|
|
$defaults['formSent'] = 1;
|
|
$defaults['file_type'] = 'xml';
|
|
$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>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>
|
|
|
|
<p><?php echo get_lang('XMLMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>
|
|
|
|
<blockquote>
|
|
<pre>
|
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<Contacts>
|
|
<Contact>
|
|
<b><LastName>xxx</LastName></b>
|
|
<b><FirstName>xxx</FirstName></b>
|
|
<UserName>xxx</UserName>
|
|
<Password>xxx</Password>
|
|
<AuthSource><?php echo implode('/',$defined_auth_sources); ?></AuthSource>
|
|
<b><Email>xxx</Email></b>
|
|
<OfficialCode>xxx</OfficialCode>
|
|
<PhoneNumber>xxx</PhoneNumber>
|
|
<Status>user/teacher/drh</Status> <?php if ($result_xml!='') { echo '<br /><font style="color:red;">',$result_xml;echo '</font>';} ?>
|
|
<Courses>xxx1|xxx2|xxx3</Courses>
|
|
<ClassName>class 1</ClassName>
|
|
</Contact>
|
|
</Contacts>
|
|
</pre>
|
|
</blockquote>
|
|
|
|
<?php
|
|
|
|
|
|
/*
|
|
==============================================================================
|
|
FOOTER
|
|
==============================================================================
|
|
*/
|
|
Display :: display_footer();
|