user_import.php 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451
  1. <?php // $Id: user_import.php 21895 2009-07-08 15:51:31Z juliomontoya $
  2. /* For licensing terms, see /dokeos_license.txt */
  3. /**
  4. ==============================================================================
  5. * This tool allows platform admins to add users by uploading a CSV or XML file
  6. * @todo Add some langvars to DLTT
  7. * @package dokeos.admin
  8. ==============================================================================
  9. */
  10. /**
  11. * Validate the imported data.
  12. */
  13. $language_file = array ('admin', 'registration');
  14. $cidReset = true;
  15. require '../inc/global.inc.php';
  16. require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php';
  17. // Set this option to true to enforce strict purification for usenames.
  18. $purification_option_for_usernames = false;
  19. function validate_data($users) {
  20. global $defined_auth_sources;
  21. $errors = array();
  22. $usernames = array();
  23. // 1. Check if mandatory fields are set.
  24. $mandatory_fields = array('LastName', 'FirstName');
  25. if (api_get_setting('registration', 'email') == 'true') {
  26. $mandatory_fields[] = 'Email';
  27. }
  28. foreach ($users as $index => $user) {
  29. foreach ($mandatory_fields as $field) {
  30. if (empty($user[$field])) {
  31. $user['error'] = get_lang($field.'Mandatory');
  32. $errors[] = $user;
  33. }
  34. }
  35. // 2. Check username, first, check whether it is empty.
  36. if (!UserManager::is_username_empty($user['UserName'])) {
  37. // 2.1. Check whether username is too long.
  38. if (UserManager::is_username_too_long($user['UserName'])) {
  39. $user['error'] = get_lang('UserNameTooLong');
  40. $errors[] = $user;
  41. }
  42. // 2.2. Check whether the username was used twice in import file.
  43. if (isset($usernames[$user['UserName']])) {
  44. $user['error'] = get_lang('UserNameUsedTwice');
  45. $errors[] = $user;
  46. }
  47. $usernames[$user['UserName']] = 1;
  48. // 2.3. Check whether username is allready occupied.
  49. if (!UserManager::is_username_available($user['UserName'])) {
  50. $user['error'] = get_lang('UserNameNotAvailable');
  51. $errors[] = $user;
  52. }
  53. }
  54. // 3. Check status.
  55. if (isset($user['Status']) && !api_status_exists($user['Status'])) {
  56. $user['error'] = get_lang('WrongStatus');
  57. $errors[] = $user;
  58. }
  59. // 4. Check classname
  60. if (!empty($user['ClassName'])) {
  61. if (!ClassManager :: class_name_exists($user['ClassName'])) {
  62. $user['error'] = get_lang('ClassNameNotAvailable');
  63. $errors[] = $user;
  64. }
  65. }
  66. // 5. Check authentication source
  67. if (!empty($user['AuthSource'])) {
  68. if (!in_array($user['AuthSource'], $defined_auth_sources)) {
  69. $user['error'] = get_lang('AuthSourceNotAvailable');
  70. $errors[] = $user;
  71. }
  72. }
  73. }
  74. return $errors;
  75. }
  76. /**
  77. * Add missing user-information (which isn't required, like password, username etc).
  78. */
  79. function complete_missing_data($user) {
  80. global $purification_option_for_usernames;
  81. // 1. Create a username if necessary.
  82. if (UserManager::is_username_empty($user['UserName'])) {
  83. $user['UserName'] = UserManager::create_unique_username($user['FirstName'], $user['LastName']);
  84. } else {
  85. $user['UserName'] = UserManager::purify_username($user['UserName'], $purification_option_for_usernames);
  86. }
  87. // 2. Generate a password if necessary.
  88. if (empty($user['Password'])) {
  89. $user['Password'] = api_generate_password();
  90. }
  91. // 3. Set status if not allready set.
  92. if (empty($user['Status'])) {
  93. $user['Status'] = 'user';
  94. }
  95. // 4. Set authsource if not allready set.
  96. if (empty($user['AuthSource'])) {
  97. $user['AuthSource'] = PLATFORM_AUTH_SOURCE;
  98. }
  99. return $user;
  100. }
  101. /**
  102. * Save the imported data
  103. * @param array List of users
  104. * @return void
  105. * @uses global variable $inserted_in_course, which returns the list of courses the user was inserted in
  106. */
  107. function save_data($users) {
  108. global $inserted_in_course;
  109. // Not all scripts declare the $inserted_in_course array (although they should).
  110. if (!isset($inserted_in_course)) {
  111. $inserted_in_course = array();
  112. }
  113. require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php';
  114. $user_table = Database :: get_main_table(TABLE_MAIN_USER);
  115. $send_mail = $_POST['sendMail'] ? 1 : 0;
  116. if (is_array($users)) {
  117. foreach ($users as $index => $user) {
  118. $user = complete_missing_data($user);
  119. $user['Status'] = api_status_key($user['Status']);
  120. $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']);
  121. if (!is_array($user['Courses']) && !empty($user['Courses'])) {
  122. $user['Courses'] = array($user['Courses']);
  123. }
  124. if (is_array($user['Courses'])) {
  125. foreach ($user['Courses'] as $index => $course) {
  126. if (CourseManager :: course_exists($course)) {
  127. CourseManager :: subscribe_user($user_id, $course,$user['Status']);
  128. $course_info = CourseManager::get_course_information($course);
  129. $inserted_in_course[$course] = $course_info['title'];
  130. }
  131. if (CourseManager :: course_exists($course, true)) {
  132. // Also subscribe to virtual courses through check on visual code.
  133. $list = CourseManager :: get_courses_info_from_visual_code($course);
  134. foreach ($list as $vcourse) {
  135. if ($vcourse['code'] == $course) {
  136. // Ignore, this has already been inserted.
  137. } else {
  138. CourseManager :: subscribe_user($user_id, $vcourse['code'],$user['Status']);
  139. $inserted_in_course[$vcourse['code']] = $vcourse['title'];
  140. }
  141. }
  142. }
  143. }
  144. }
  145. if (!empty($user['ClassName'])) {
  146. $class_id = ClassManager :: get_class_id($user['ClassName']);
  147. ClassManager :: add_user($user_id, $class_id);
  148. }
  149. // Saving extra fields.
  150. global $extra_fields;
  151. // We are sure that the extra field exists.
  152. foreach($extra_fields as $extras) {
  153. if (isset($user[$extras[1]])) {
  154. $key = $extras[1];
  155. $value = $user[$extras[1]];
  156. UserManager::update_extra_field_value($user_id, $key,$value);
  157. }
  158. }
  159. if ($send_mail) {
  160. $recipient_name = api_get_person_name($user['FirstName'], $user['LastName'], null, PERSON_NAME_EMAIL_ADDRESS);
  161. $emailsubject = '['.api_get_setting('siteName').'] '.get_lang('YourReg').' '.api_get_setting('siteName');
  162. $emailbody = get_lang('Dear').' '.api_get_person_name($user['FirstName'], $user['LastName']).",\n\n".get_lang('YouAreReg')." ".api_get_setting('siteName')." ".get_lang('WithTheFollowingSettings')."\n\n".get_lang('Username')." : $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')."";
  163. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  164. $email_admin = api_get_setting('emailAdministrator');
  165. @api_mail($recipient_name, $user['Email'], $emailsubject, $emailbody, $sender_name, $email_admin);
  166. }
  167. }
  168. }
  169. }
  170. /**
  171. * Read the CSV-file
  172. * @param string $file Path to the CSV-file
  173. * @return array All userinformation read from the file
  174. */
  175. function parse_csv_data($file) {
  176. $users = Import :: csv_to_array($file);
  177. foreach ($users as $index => $user) {
  178. if (isset ($user['Courses'])) {
  179. $user['Courses'] = explode('|', trim($user['Courses']));
  180. }
  181. $users[$index] = $user;
  182. }
  183. return $users;
  184. }
  185. /**
  186. * XML-parser: handle start of element
  187. */
  188. function element_start($parser, $data) {
  189. $data = api_utf8_decode($data);
  190. global $user;
  191. global $current_tag;
  192. switch ($data) {
  193. case 'Contact' :
  194. $user = array ();
  195. break;
  196. default :
  197. $current_tag = $data;
  198. }
  199. }
  200. /**
  201. * XML-parser: handle end of element
  202. */
  203. function element_end($parser, $data) {
  204. $data = api_utf8_decode($data);
  205. global $user;
  206. global $users;
  207. global $current_value;
  208. switch ($data) {
  209. case 'Contact' :
  210. if ($user['Status'] == '5') {
  211. $user['Status'] = STUDENT;
  212. }
  213. if ($user['Status'] == '1') {
  214. $user['Status'] = COURSEMANAGER;
  215. }
  216. $users[] = $user;
  217. break;
  218. default :
  219. $user[$data] = $current_value;
  220. break;
  221. }
  222. }
  223. /**
  224. * XML-parser: handle character data
  225. */
  226. function character_data($parser, $data) {
  227. $data = trim(api_utf8_decode($data));
  228. global $current_value;
  229. $current_value = $data;
  230. }
  231. /**
  232. * Read the XML-file
  233. * @param string $file Path to the XML-file
  234. * @return array All userinformation read from the file
  235. */
  236. function parse_xml_data($file) {
  237. global $current_tag;
  238. global $current_value;
  239. global $user;
  240. global $users;
  241. $users = array();
  242. $parser = xml_parser_create('UTF-8');
  243. xml_set_element_handler($parser, 'element_start', 'element_end');
  244. xml_set_character_data_handler($parser, 'character_data');
  245. xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
  246. xml_parse($parser, api_utf8_encode_xml(file_get_contents($file)));
  247. xml_parser_free($parser);
  248. return $users;
  249. }
  250. $this_section = SECTION_PLATFORM_ADMIN;
  251. api_protect_admin_script(true);
  252. require_once api_get_path(LIBRARY_PATH).'fileManage.lib.php';
  253. require_once api_get_path(LIBRARY_PATH).'usermanager.lib.php';
  254. require_once api_get_path(LIBRARY_PATH).'classmanager.lib.php';
  255. require_once api_get_path(LIBRARY_PATH).'import.lib.php';
  256. require_once api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php';
  257. $defined_auth_sources[] = PLATFORM_AUTH_SOURCE;
  258. if (is_array($extAuthSource)) {
  259. $defined_auth_sources = array_merge($defined_auth_sources, array_keys($extAuthSource));
  260. }
  261. $tool_name = get_lang('ImportUserListXMLCSV');
  262. $interbreadcrumb[] = array ("url" => 'index.php', "name" => get_lang('PlatformAdmin'));
  263. set_time_limit(0);
  264. $extra_fields = Usermanager::get_extra_fields(0, 0, 5, 'ASC', false);
  265. $user_id_error = array();
  266. if ($_POST['formSent'] AND $_FILES['import_file']['size'] !== 0) {
  267. $file_type = $_POST['file_type'];
  268. Security::clear_token();
  269. $tok = Security::get_token();
  270. if (strcmp($file_type, 'csv') === 0) { //&& strcmp($_FILES['import_file']['type'],'text/'.$file_type.'')===0) {
  271. $users = parse_csv_data($_FILES['import_file']['tmp_name']);
  272. $errors = validate_data($users);
  273. $error_kind_file = false;
  274. } elseif (strcmp($file_type, 'xml') === 0) { // && strcmp($_FILES['import_file']['type'],'text/'.$file_type.'')===0) {
  275. $users = parse_xml_data($_FILES['import_file']['tmp_name']);
  276. $errors = validate_data($users);
  277. $error_kind_file = false;
  278. } else {
  279. $error_kind_file = true;
  280. }
  281. // List user id whith error.
  282. $user_id_error = array();
  283. if (is_array($errors)) {
  284. foreach ($errors as $my_errors) {
  285. $user_id_error[] = $my_errors['UserName'];
  286. }
  287. }
  288. if (is_array($users)) {
  289. foreach ($users as $my_user) {
  290. if (!in_array($my_user['UserName'], $user_id_error)) {
  291. $users_to_insert[] = $my_user;
  292. }
  293. }
  294. }
  295. $inserted_in_course = array();
  296. // this replace if (strcmp($_FILES['import_file']['type'], 'text/'.$file_type.'') === 0)
  297. if (strcmp($file_type, 'csv') === 0) {
  298. save_data($users_to_insert);
  299. } elseif (strcmp($file_type, 'xml') === 0) {
  300. save_data($users_to_insert);
  301. } else {
  302. $error_message = get_lang('YouMustImportAFileAccordingToSelectedOption');
  303. header('Location: '.api_get_path(WEB_CODE_PATH).'admin/user_import.php?warn='.urlencode($error_message).'&amp;file_type='.$file_type.'&amp;sec_token='.$tok);
  304. exit;
  305. }
  306. if (count($errors) > 0) {
  307. $see_message_import = get_lang('FileImportedJustUsersThatAreNotRegistered');
  308. } else {
  309. $see_message_import = get_lang('FileImported');
  310. }
  311. $msg2 = '';
  312. if (count($inserted_in_course) > 1) {
  313. $msg2 .= '<br>'.get_lang('UsersSubscribedToSeveralCoursesBecauseOfVirtualCourses').':';
  314. foreach ($inserted_in_course as $course) {
  315. $msg2 .= ' '.$course.',';
  316. }
  317. $msg2 = substr($msg2, 0, -1);
  318. $msg2 .= '</br>';
  319. }
  320. if (count($errors) != 0) {
  321. $error_message = '<ul>';
  322. foreach ($errors as $index => $error_user) {
  323. $error_message .= '<li><b>'.$error_user['error'].'</b>: ';
  324. $error_message .= '<strong>'.$error_user['UserName'].'</strong>&nbsp;('.api_get_person_name($error_user['FirstName'], $error_user['LastName']).')';
  325. $error_message .= '</li>';
  326. }
  327. $error_message .= '</ul>';
  328. }
  329. // if the warning message is too long then we display the warning message trough a session
  330. if (api_strlen($error_message) > 150) {
  331. $_SESSION['session_message_import_users'] = $error_message;
  332. $error_message = 'session_message';
  333. }
  334. header('Location: '.api_get_path(WEB_CODE_PATH).'admin/user_list.php?action=show_message&message='.urlencode($see_message_import).'&warn='.urlencode($error_message).'&sec_token='.$tok);
  335. exit;
  336. }
  337. Display :: display_header($tool_name);
  338. //api_display_tool_title($tool_name);
  339. if ($_FILES['import_file']['size'] == 0 AND $_POST) {
  340. Display::display_error_message(get_lang('ThisFieldIsRequired'));
  341. }
  342. if ($error_kind_file === true) {
  343. Display :: display_error_message(get_lang('YouMustImportAFileAccordingToSelectedOption'));
  344. } else if (isset($_GET['warn'])) {
  345. $error_message = Security::remove_XSS($_GET['warn']);
  346. Display :: display_error_message($error_message);
  347. }
  348. $form = new FormValidator('user_import','post','user_import.php');
  349. $form->addElement('header', '', $tool_name);
  350. $form->addElement('hidden', 'formSent');
  351. $form->addElement('file', 'import_file', get_lang('ImportFileLocation'));
  352. //$form->addRule('import_file', get_lang('ThisFieldIsRequired'), 'required'); // This rule does not work, probably due to the security mechanism here.
  353. $allowed_file_types = array ('xml', 'csv');
  354. //$form->addRule('import_file', get_lang('InvalidExtension').' ('.implode(',', $allowed_file_types).')', 'filetype', $allowed_file_types); // This rule does not work, probably due to the security mechanism here.
  355. $form->addElement('radio', 'file_type', get_lang('FileType'), 'XML (<a href="exemple.xml" target="_blank">'.get_lang('ExampleXMLFile').'</a>)', 'xml');
  356. $form->addElement('radio', 'file_type', null, 'CSV (<a href="exemple.csv" target="_blank">'.get_lang('ExampleCSVFile').'</a>)', 'csv');
  357. $form->addElement('radio', 'sendMail', get_lang('SendMailToUsers'), get_lang('Yes'), 1);
  358. $form->addElement('radio', 'sendMail', null, get_lang('No'), 0);
  359. $form->addElement('style_submit_button', 'submit', get_lang('Import'), 'class="save"');
  360. $defaults['formSent'] = 1;
  361. $defaults['sendMail'] = 0;
  362. $defaults['file_type'] = 'xml';
  363. $form->setDefaults($defaults);
  364. $form->display();
  365. $list = array();
  366. $list_reponse = array();
  367. $result_xml = '';
  368. $i = 0;
  369. $count_fields = count($extra_fields);
  370. if ($count_fields > 0) {
  371. foreach ($extra_fields as $extra) {
  372. $list[] = $extra[1];
  373. $list_reponse[] = 'xxx';
  374. $spaces = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
  375. $result_xml .= $spaces.'&lt;'.$extra[1].'&gt;xxx&lt;/'.$extra[1].'&gt;';
  376. if ($i != $count_fields - 1) {
  377. $result_xml .= '<br/>';
  378. }
  379. $i++;
  380. }
  381. }
  382. ?>
  383. <p><?php echo get_lang('CSVMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>
  384. <blockquote>
  385. <pre>
  386. <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;
  387. <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;<br />
  388. </pre>
  389. </blockquote>
  390. <p><?php echo get_lang('XMLMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>
  391. <blockquote>
  392. <pre>
  393. &lt;?xml version=&quot;1.0&quot; encoding=&quot;<?php echo api_refine_encoding_id(api_get_system_encoding()); ?>&quot;?&gt;
  394. &lt;Contacts&gt;
  395. &lt;Contact&gt;
  396. <b>&lt;LastName&gt;xxx&lt;/LastName&gt;</b>
  397. <b>&lt;FirstName&gt;xxx&lt;/FirstName&gt;</b>
  398. &lt;UserName&gt;xxx&lt;/UserName&gt;
  399. &lt;Password&gt;xxx&lt;/Password&gt;
  400. &lt;AuthSource&gt;<?php echo implode('/', $defined_auth_sources); ?>&lt;/AuthSource&gt;
  401. <b>&lt;Email&gt;xxx&lt;/Email&gt;</b>
  402. &lt;OfficialCode&gt;xxx&lt;/OfficialCode&gt;
  403. &lt;PhoneNumber&gt;xxx&lt;/PhoneNumber&gt;
  404. &lt;Status&gt;user/teacher/drh<?php if ($result_xml != '') { echo '<br /><font style="color:red;">', $result_xml; echo '</font>'; } ?>&lt;/Status&gt;
  405. &lt;Courses&gt;xxx1|xxx2|xxx3&lt;/Courses&gt;
  406. &lt;/Contact&gt;
  407. &lt;/Contacts&gt;
  408. </pre>
  409. </blockquote>
  410. <?php
  411. Display :: display_footer();
  412. ?>