123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391 |
- <?php // $Id: user_import.php 14792 2008-04-08 20:57:53Z yannoo $
- /*
- ==============================================================================
- Dokeos - elearning and course management software
- Copyright (c) 2004-2008 Dokeos SPRL
- Copyright (c) 2003 Ghent University (UGent)
- Copyright (c) 2001 Universite catholique de Louvain (UCL)
- Copyright (c) Olivier Brouckaert
- Copyright (c) 2005 Bart Mollet <bart.mollet@hogent.be>
- 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, rue du Corbeau, 108, B-1030 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']) && !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
- */
- function save_data($users)
- {
- $user_table = Database :: get_main_table(TABLE_MAIN_USER);
- $sendMail = $_POST['sendMail'] ? 1 : 0;
- 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']);
- foreach ($user['Courses'] as $index => $course)
- {
- if(CourseManager :: course_exists($course))
- CourseManager :: subscribe_user($user_id, $course,$user['Status']);
- }
- 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 = '['.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')."";
- $emailheaders = 'From: '.api_get_setting('administratorName').' '.api_get_setting('administratorSurname').' <'.api_get_setting('emailAdministrator').">\n";
- $emailheaders .= 'Reply-To: '.api_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']));
- }
- $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)
- {
- 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 = '<ul>';
- foreach ($errors as $index => $error_user)
- {
- $error_message .= '<li><b>'.$error_user['error'].'</b>: ';
- $error_message .= $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();
- ?>
- <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;Courses;ClassName
- <b>xxx</b>;<b>xxx</b>;<b>xxx</b>;xxx;xxx;<?php echo implode('/',$defined_auth_sources); ?>;xxx;xxx;user/teacher/drh;xxx1|xxx2|xxx3;xxx
- </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>
- <Courses>xxx1|xxx2|xxx3</Courses>
- <ClassName>class 1</ClassName>
- </Contact>
- </Contacts>
- </pre>
- </blockquote>
- <?php
- /*
- ==============================================================================
- FOOTER
- ==============================================================================
- */
- Display :: display_footer();
- ?>
|