upgrade

main/webservices/user_import/import.lib.php

@@ -0,0 +1,170 @@
+<?php
+/* For licensing terms, see /license.txt*/
+
+/**
+ * Validates imported data.
+ */
+function validate_data($users)
+{
+    global $defined_auth_sources;
+    $errors = [];
+    $usernames = [];
+    if (is_array($users)) {
+        foreach ($users as $index => $user) {
+            // 1. Check whether mandatory fields have been set.
+            $mandatory_fields = ['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 (!UserManager::is_username_empty($user['UserName'])) {
+                // 2.1. Check whether username was used twice in the import file.
+                if (isset($usernames[$user['UserName']])) {
+                    $user['error'] = get_lang('UserNameUsedTwice');
+                    $errors[] = $user;
+                }
+                $usernames[$user['UserName']] = 1;
+                // 2.2. Check whether username is allready in use in database.
+                if (!UserManager::is_username_available($user['UserName'])) {
+                    $user['error'] = get_lang('UserNameNotAvailable');
+                    $errors[] = $user;
+                }
+                // 2.3. Check whether username is too long.
+                if (UserManager::is_username_too_long($user['UserName'])) {
+                    $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;
+            }
+            // 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;
+}
+
+/**
+ * Adds missing user-information (which isn't required, like password, username, etc).
+ */
+function complete_missing_data($user)
+{
+    // 1. Create a username if necessary.
+    if (UserManager::is_username_empty($user['UserName'])) {
+        $user['UserName'] = UserManager::create_unique_username(
+            $user['FirstName'],
+            $user['LastName']
+        );
+    }
+    // 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
+ */
+function save_data($users)
+{
+    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 (!empty($user['Courses'])) {
+                foreach ($user['Courses'] as $course) {
+                    if (CourseManager::course_exists($course)) {
+                        CourseManager::subscribeUser(
+                            $user_id,
+                            $course,
+                            $user['Status']
+                        );
+                    }
+                }
+            }
+
+            // TODO: Hard-coded French texts.
+
+            // Qualite
+            if (!empty($user['Qualite'])) {
+                UserManager::update_extra_field_value($user_id, 'qualite', $user['Qualite']);
+            }
+
+            // Categorie
+            if (!empty($user['Categorie'])) {
+                UserManager::update_extra_field_value($user_id, 'categorie', $user['Categorie']);
+            }
+
+            // Etat
+            if (!empty($user['Etat'])) {
+                UserManager::update_extra_field_value($user_id, 'etat', $user['Etat']);
+            }
+
+            // Niveau
+            if (!empty($user['Niveau'])) {
+                UserManager::update_extra_field_value($user_id, 'niveau', $user['Niveau']);
+            }
+        }
+    }
+}
+
+/**
+ * Reads the CSV-file.
+ *
+ * @param string $file Path to the CSV-file
+ *
+ * @return array All user information read from the file
+ */
+function parse_csv_data($file)
+{
+    $users = Import::csvToArray($file);
+    foreach ($users as $index => $user) {
+        if (isset($user['Courses'])) {
+            $user['Courses'] = explode('|', trim($user['Courses']));
+        }
+        $users[$index] = $user;
+    }
+
+    return $users;
+}

main/webservices/user_import/index.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+<meta http-equiv="refresh" content="0; url=../gradebook.php">
+</head>
+<body>
+</body>
+</html>

main/webservices/user_import/service.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * See license terms in /license.txt.
+ *
+ * @author Eric Marguin <eric.marguin@dokeos.com>
+ */
+require_once __DIR__.'/../../inc/global.inc.php';
+
+api_protect_webservices();
+
+/**
+ * Import users into database from a file located on the server.
+ * Function registered as service.
+ *
+ * @param  string The csv (only csv) file containing users tom import
+ * @param  string Security key (as found in configuration file)
+ *
+ * @return string Error message
+ */
+function import_users_from_file($filepath, $security_key)
+{
+    $errors_returned = [
+        0 => 'success',
+        1 => 'file import does not exist',
+        2 => 'no users to import',
+        3 => 'wrong datas in file',
+        4 => 'security error',
+    ];
+
+    $key = api_get_configuration_value('security_key');
+
+    // Check whether this script is launch by server and security key is ok.
+    if (empty($_SERVER['REMOTE_ADDR']) || $_SERVER['REMOTE_ADDR'] != $_SERVER['SERVER_ADDR'] || $security_key != $key) {
+        return $errors_returned[4];
+    }
+
+    // Libraries
+    require_once 'import.lib.php';
+
+    // Check is users file exists.
+    if (!is_file($filepath)) {
+        return $errors_returned[1];
+    }
+
+    // Get list of users
+    $users = parse_csv_data($filepath);
+    if (count($users) == 0) {
+        return $errors_returned[2];
+    }
+
+    // Check the datas for each user
+    $errors = validate_data($users);
+    if (count($errors) > 0) {
+        return $errors_returned[3];
+    }
+
+    // Apply modifications in database
+    save_data($users);
+
+    return $errors_returned[0]; // Import successfull
+}
+
+$server = new soap_server();
+$server->register('import_users_from_file');
+$http_request = (isset($HTTP_RAW_POST_DATA) ? $HTTP_RAW_POST_DATA : '');
+$server->service($http_request);