For a full list of contributors, see "credits.txt".
The full license can be read in "license.txt".
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
See the GNU General Public License for more details.
Contact: Dokeos, 181 rue Royale, B-1000 Brussels, Belgium, info@dokeos.com
==============================================================================
*/
/**
==============================================================================
* 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']) && ($user['Status'] != COURSEMANAGER && $user['Status'] != STUDENT))
{
$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($users)
{
foreach ($users as $index => $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;
}
$users[$index]['UserName'] = $username;
}
//2. generate a password if necessary
if (!isset ($user['Password']) || strlen($user['Password']) == 0)
{
$users[$index]['Password'] = api_generate_password();
}
//3. set status if not allready set
if (!isset ($user['Status']) || strlen($user['Status']) == 0)
{
$users[$index]['Status'] = 'user';
}
//4. set authsource if not allready set
if (!isset ($user['AuthSource']) || strlen($user['AuthSource']) == 0)
{
$users[$index]['AuthSource'] = PLATFORM_AUTH_SOURCE;
}
}
return $users;
}
/**
* Save the imported data
*/
function save_data($users)
{
$user_table = Database :: get_main_table(TABLE_MAIN_USER);
$sendMail = $_POST['sendMail'] ? 1 : 0;
foreach ($users as $index => $user)
{
$user_id = UserManager :: create_user($user['FirstName'], $user['LastName'], $user['Status'], $user['Email'], $user['UserName'], $user['Password'], $user['OfficialCode'], $user['PhoneNumber'], '', $user['AuthSource']);
foreach ($user['Courses'] as $index => $course)
{
CourseManager :: subscribe_user($user_id, $course);
}
if (strlen($user['ClassName']) > 0)
{
$class_id = ClassManager :: get_class_id($user['ClassName']);
ClassManager :: add_user($user_id, $class_id);
}
if ($sendMail)
{
$emailto = '"'.$user['FirstName'].' '.$user['LastName'].'" <'.$user['Email'].'>';
$emailsubject = '['.get_setting('siteName').'] '.get_lang('YourReg').' '.get_setting('siteName');
$emailbody = get_lang('Dear').$user['FirstName'].' '.$user['LastName'].",\n\n".get_lang('YouAreReg')." ".get_setting('siteName')." ".get_lang('Settings')." $user[UserName]\n".get_lang('Pass')." : $user[Password]\n\n".get_lang('Address')." ".get_setting('siteName')." ".get_lang('Is')." : ".api_get_path('WEB_PATH')." \n\n".get_lang('Problem')."\n\n".get_lang('Formula').",\n\n".get_setting('administratorName')." ".get_setting('administratorSurname')."\n".get_lang('Manager')." ".get_setting('siteName')."\nT. ".get_setting('administratorTelephone')."\n".get_lang('Email')." : ".get_setting('emailAdministrator')."";
$emailheaders = 'From: '.get_setting('administratorName').' '.get_setting('administratorSurname').' <'.get_setting('emailAdministrator').">\n";
$emailheaders .= 'Reply-To: '.get_setting('emailAdministrator');
@ api_send_mail($emailto, $emailsubject, $emailbody, $emailheaders);
}
}
}
/**
* 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']));
}
if ($user['Status'] == 'user')
{
$user['Status'] = STUDENT;
}
if ($user['Status'] == 'teacher')
{
$user['Status'] = COURSEMANAGER;
}
$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);
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)
{
$users = complete_missing_data($users);
save_data($users);
header('Location: user_list.php?action=show_message&message='.urlencode(get_lang('FileImported')));
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 = '';
foreach ($errors as $index => $error_user)
{
$error_message .= '- '.$error_user['error'].': ';
$error_message .= $error_user['FirstName'].' '.$error_user['LastName'];
$error_message .= '
';
}
$error_message .= '
';
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 ('.get_lang('ExampleXMLFile').')', 'xml');
$form->addElement('radio', 'file_type', null, 'CSV ('.get_lang('ExampleCSVFile').')', '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();
?>
:
LastName;FirstName;UserName;Password;AuthSource;Email;OfficialCode;PhoneNumber;Status;Courses;ClassName
xxx;xxx;xxx;xxx;;xxx;xxx;xxx;user/teacher;xxx1|xxx2|xxx3;xxx
:
<?xml version="1.0" encoding="ISO-8859-1"?>
<Contacts>
<Contact>
<LastName>xxx</LastName>
<FirstName>xxx</FirstName>
<UserName>xxx</UserName>
<Password>xxx</Password>
<AuthSource></AuthSource>
<Email>xxx</Email>
<OfficialCode>xxx</OfficialCode>
<PhoneNumber>xxx</PhoneNumber>
<Status>user/teacher</Status>
<Courses>xxx1|xxx2|xxx3</Courses>
<ClassName>class 1</ClassName>
</Contact>
</Contacts>