[svn r15949] First web service provided by Dokeos - Proof of concept - Still needs a variable server-side file to work

main/webservices/user_import/import.lib.php

@@ -0,0 +1,175 @@
+<?php
+/**
+ * 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);
+	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);
+		}
+		
+		// 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']);
+	}
+}
+/**
+ * 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;
+}
+
+?>

main/webservices/user_import/service.php

@@ -0,0 +1,75 @@
+<?php //$id: $
+/** 
+ * See license terms in /dokeos_license.txt
+ * @author Eric Marguin <eric.marguin@dokeos.com>
+ */
+require_once('../../inc/global.inc.php');
+require_once(api_get_path(LIBRARY_PATH).'nusoap/nusoap.php');
+
+/**
+ * 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) {
+	
+	global $_configuration;
+	
+   	$errors_returned = array(
+	   			0=>'success', 
+	   			1=>'file import does not exist', 
+	   			2=>'no users to import', 
+	   			3=>'wrong datas in file',
+	   			4=>'security error'
+   			 );
+   	
+   	// check if this script is launch by server and if security key is ok
+   	if(empty($_SERVER['REMOTE_ADDR']) || $_SERVER['REMOTE_ADDR']!=$_SERVER['SERVER_ADDR'] || $security_key != $_configuration['security_key'])
+   	{
+   		return $errors_returned[4];
+   	}
+   	
+   	
+   	// libraries
+   	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');
+	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);
+?>