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

Adding course_user_import_by_email.php (blocked by default) see BT#8672

Browse Source
1.9.x
Julio Montoya 11 years ago
parent 3fd48df439
commit f783b34701
1 changed files with 234 additions and 0 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. 234
      main/admin/course_user_import_by_email.php

234
main/admin/course_user_import_by_email.php
Unescape View File

@ -0,0 +1,234 @@
<?php
/* For licensing terms, see /license.txt */
exit;
/**
* This tool allows platform admins to update course-user relations by uploading
* a CSV file
* @package chamilo.admin
*/
/**
* Validates the imported data.
*/
function validate_data($users_courses)
{
$errors = array();
$coursecodes = array();
foreach ($users_courses as $index => $user_course) {
$user_course['line'] = $index + 1;
// 1. Check whether mandatory fields are set.
$mandatory_fields = array('Email', 'CourseCode', 'Status');
foreach ($mandatory_fields as $key => $field) {
if (!isset($user_course[$field]) || strlen($user_course[$field]) == 0) {
$user_course['error'] = get_lang($field.'Mandatory');
$errors[] = $user_course;
}
}
// 2. Check whether coursecode exists.
if (isset ($user_course['CourseCode']) && strlen($user_course['CourseCode']) != 0) {
// 2.1 Check whethher code has been allready used by this CVS-file.
if (!isset($coursecodes[$user_course['CourseCode']])) {
// 2.1.1 Check whether course with this code exists in the system.
$course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
$sql = "SELECT * FROM $course_table
WHERE code = '".Database::escape_string($user_course['CourseCode'])."'";
$res = Database::query($sql);
if (Database::num_rows($res) == 0) {
$user_course['error'] = get_lang('CodeDoesNotExists');
$errors[] = $user_course;
} else {
$coursecodes[$user_course['CourseCode']] = 1;
}
}
}
// 3. Check whether Email exists.
if (isset ($user_course['Email']) && strlen($user_course['Email']) !=
0) {
$user = api_get_user_info_from_email($user_course['Email']);
if (empty($user)) {
$user_course['error'] = get_lang('UnknownUser');
$errors[] = $user_course;
}
}
// 4. Check whether status is valid.
if (isset ($user_course['Status']) && strlen($user_course['Status']) != 0) {
if ($user_course['Status'] != COURSEMANAGER && $user_course['Status'] != STUDENT) {
$user_course['error'] = get_lang('UnknownStatus');
$errors[] = $user_course;
}
}
}
return $errors;
}
/**
* Saves imported data.
*/
function save_data($users_courses)
{
$user_table = Database::get_main_table(TABLE_MAIN_USER);
$course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
$csv_data = array();
$inserted_in_course = array();
foreach ($users_courses as $user_course) {
$csv_data[$user_course['Email']][$user_course['CourseCode']] =
$user_course['Status'];
}
foreach ($csv_data as $email => $csv_subscriptions) {
$sql = "SELECT * FROM $user_table u
WHERE u.email = '".Database::escape_string($email)."' LIMIT 1";
$res = Database::query($sql);
$obj = Database::fetch_object($res);
$user_id = $obj->user_id;
$sql = "SELECT * FROM $course_user_table cu
WHERE cu.user_id = $user_id AND cu.relation_type <> ".COURSE_RELATION_TYPE_RRHH." ";
$res = Database::query($sql);
$db_subscriptions = array();
while ($obj = Database::fetch_object($res)) {
$db_subscriptions[$obj->course_code] = $obj->status;
}
$to_subscribe = array_diff(array_keys($csv_subscriptions), array_keys($db_subscriptions));
$to_unsubscribe = array_diff(array_keys($db_subscriptions), array_keys($csv_subscriptions));
if ($_POST['subscribe']) {
foreach ($to_subscribe as $course_code) {
if (CourseManager :: course_exists($course_code)) {
$course_info = CourseManager::get_course_information($course_code);
$inserted_in_course[$course_code] = $course_info['title'];
CourseManager::subscribe_user(
$user_id,
$course_code,
$csv_subscriptions[$course_code]
);
$inserted_in_course[$course_info['code']] = $course_info['title'];
}
}
}
if ($_POST['unsubscribe']) {
foreach ($to_unsubscribe as $course_code) {
if (CourseManager :: course_exists($course_code)) {
CourseManager::unsubscribe_user($user_id, $course_code);
$course_info = CourseManager::get_course_information($course_code);
CourseManager::unsubscribe_user($user_id, $course_code);
$inserted_in_course[$course_info['code']] = $course_info['title'];
}
}
}
}
return $inserted_in_course;
}
/**
* Reads CSV-file.
* @param string $file Path to the CSV-file
* @return array All course-information read from the file
*/
function parse_csv_data($file)
{
$courses = Import :: csv_to_array($file);
return $courses;
}
// Language files that should be included,
$language_file = array('admin', 'registration');
$cidReset = true;
include '../inc/global.inc.php';
// Setting the section (for the tabs).
$this_section = SECTION_PLATFORM_ADMIN;
// Protecting the admin section.
api_protect_admin_script();
// Including additional libraries.
require_once api_get_path(LIBRARY_PATH).'fileManage.lib.php';
require_once api_get_path(LIBRARY_PATH).'import.lib.php';
$tool_name = get_lang('AddUsersToACourse').' CSV';
$interbreadcrumb[] = array('url' => 'index.php', 'name' => get_lang('PlatformAdmin'));
set_time_limit(0);
// Creating the form.
$form = new FormValidator('course_user_import');
$form->addElement('header', '', $tool_name);
$form->addElement('file', 'import_file', get_lang('ImportFileLocation'));
$form->addElement('checkbox', 'subscribe', get_lang('Action'), get_lang('SubscribeUserIfNotAllreadySubscribed'));
$form->addElement('checkbox', 'unsubscribe', '', get_lang('UnsubscribeUserIfSubscriptionIsNotInFile'));
$form->addElement('style_submit_button', 'submit', get_lang('Import'), 'class="save"');
$form->setDefaults(array('subscribe' => '1', 'unsubscribe' => 1));
$errors = array();
if ($form->validate()) {
$users_courses = parse_csv_data($_FILES['import_file']['tmp_name']);
$errors = validate_data($users_courses);
if (count($errors) == 0) {
$inserted_in_course = save_data($users_courses);
// Build the alert message in case there were visual codes subscribed to.
if ($_POST['subscribe']) {
$warn = get_lang('UsersSubscribedToBecauseVisualCode').': ';
} else {
$warn = get_lang('UsersUnsubscribedFromBecauseVisualCode').': ';
}
if (!empty($inserted_in_course)) {
$warn = $warn.' '.get_lang('FileImported');
// The users have been inserted in more than one course.
foreach ($inserted_in_course as $code => $info) {
$warn .= ' '.$info.' ('.$code.') ';
}
} else {
$warn = get_lang('ErrorsWhenImportingFile');
}
Security::clear_token();
$tok = Security::get_token();
header('Location: user_list.php?action=show_message&warn='.urlencode($warn).'&sec_token='.$tok);
exit();
}
}
// Displaying the header.
Display :: display_header($tool_name);
if (count($errors) != 0) {
$error_message = '<ul>';
foreach ($errors as $index => $error_course) {
$error_message .= '<li>'.get_lang('Line').' '.$error_course['line'].': <strong>'.$error_course['error'].'</strong>: ';
$error_message .= $error_course['Code'].' '.$error_course['Title'];
$error_message .= '</li>';
}
$error_message .= '</ul>';
Display :: display_error_message($error_message, false);
}
// Displaying the form.
$form->display();
?>
<p><?php echo get_lang('CSVMustLookLike').' ('.get_lang('MandatoryFields').')'; ?> :</p>
<blockquote>
<pre>
<b>Email</b>;<b>CourseCode</b>;<b>Status</b>
example1@example.org;course01;<?php echo COURSEMANAGER; ?>
example2@example.org;course01;<?php echo STUDENT; ?>
</pre>
<?php
echo COURSEMANAGER.': '.get_lang('Teacher').'<br />';
echo STUDENT.': '.get_lang('Student').'<br />';
?>
</blockquote>
<?php
Display :: display_footer();
Write Preview
Loading…
Cancel
Save