migration.custom.class.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. <?php
  2. /**
  3. * This file contains the MigrationCustom class, which defines methods to
  4. * alter the data from the original database when importing it to the Chamilo
  5. * database
  6. */
  7. /**
  8. * The custom migration class allows you to define rules to process data
  9. * during the migration
  10. */
  11. class MigrationCustom {
  12. const default_admin_id = 1;
  13. /**
  14. * The only required method is the 'none' method, which will not trigger
  15. * any process at all
  16. * @param mixed Data
  17. * @param mixed Unaltered data
  18. */
  19. public function none($data) {
  20. return $data;
  21. }
  22. public function join_horario($data, &$omigrate, $row_data) {
  23. return '('.$row_data['chrIdHorario'].') '.$row_data['chrHoraInicial'].' '.$row_data['chrHoraFinal'];
  24. }
  25. /**
  26. * Transform the uid identifiers from MSSQL to a string
  27. * @param string Field name
  28. * @return string SQL select string to include in the final select
  29. */
  30. public function sql_alter_unhash_50($field) {
  31. $as_field = explode('.', $field);
  32. if (isset($as_field[1])) {
  33. $as_field = $as_field[1];
  34. } else {
  35. $as_field = $field;
  36. }
  37. return " cast( $field as varchar(50)) as $as_field ";
  38. }
  39. /**
  40. * Log data from the original users table
  41. */
  42. public function log_original_user_unique_id($data, &$omigrate, $row_data) {
  43. //Temporarily commented (see how it goes without that)
  44. //$row = array('uidIdPersona' => $row_data['uidIdPersona'], 'uidIdAlumno' => $row_data['uidIdAlumno']);
  45. //$omigrate['users_alumno'][$row_data['uidIdAlumno']] = $row;
  46. return $row_data['uidIdAlumno'];
  47. }
  48. public function clean_utf8($value) {
  49. return utf8_encode($value);
  50. }
  51. public function clean_session_name($value, &$omigrate, $row_data) {
  52. return self::clean_utf8($row_data['session_name']);
  53. }
  54. /** @deprecated */
  55. public function log_original_persona_unique_id($data, &$omigrate, $row_data) {
  56. /* Temporarily commented
  57. if (isset($omigrate['users_persona'][$row_data['uidIdPersona']])) {
  58. $omigrate['users_persona'][$row_data['uidIdPersona']][] = $omigrate['users_persona'][$row_data['uidIdPersona']];
  59. //$omigrate['users_persona'][$row_data['uidIdPersona']][] = $row_data;
  60. //error_log(print_r($row_data, 1));
  61. //error_log(print_r($omigrate['users_persona'][$row_data['uidIdPersona']], 1));
  62. error_log('WHAT??');
  63. } else {
  64. //$omigrate['users_persona'][$row_data['uidIdPersona']] = $row_data;
  65. $omigrate['users_persona'][$row_data['uidIdPersona']] = $row_data['uidIdPersona'];
  66. }
  67. */
  68. return $data;
  69. }
  70. /** @deprecated */
  71. public function log_original_teacher_unique_id($data, &$omigrate, $row_data) {
  72. $row = array('uidIdPersona' => $row_data['uidIdPersona'], 'uidIdEmpleado' => $row_data['uidIdEmpleado']);
  73. $omigrate['users_empleado'][$row_data['uidIdEmpleado']] = $row;
  74. return $row_data['uidIdEmpleado'];
  75. }
  76. /**
  77. * Log data from the original users table
  78. @deprecated
  79. */
  80. public function log_original_course_unique_id($data, &$omigrate) {
  81. $omigrate['courses'][$data] = 0;
  82. return $data;
  83. }
  84. /**
  85. * Log data from the original users table
  86. * @deprecated
  87. */
  88. public function log_original_session_unique_id($data, &$omigrate, $row_data) {
  89. $omigrate['sessions'][$row_data['uidIdPrograma']] = $row_data;
  90. return $data;
  91. }
  92. public function get_real_course_code($data, &$omigrate, $row_data) {
  93. $extra_field = new ExtraFieldValue('course');
  94. $values = $extra_field->get_item_id_from_field_variable_and_field_value('uidIdCurso', $data);
  95. if ($values) {
  96. return $values['code'];
  97. } else {
  98. error_log("Course not found in DB");
  99. }
  100. }
  101. function get_session_id_by_programa_id($data, &$omigrate, $row_data) {
  102. /*error_log(print_r($data, 1));
  103. error_log(print_r($row_data, 1));
  104. error_log($omigrate['sessions'][$data]);*/
  105. if (!isset($omigrate['sessions'][$data])) {
  106. error_log(print_r($omigrate['sessions'], 1));
  107. error_log("Sessions not found in data_list array ");
  108. exit;
  109. }
  110. return $omigrate['sessions'][$data];
  111. }
  112. /* Not used */
  113. public function get_user_id($data, &$omigrate, $row_data) {
  114. //error_log('get_real_teacher_id');
  115. //error_log(print_r($data, 1));
  116. //error_log(print_r($omigrate['users_empleado'], 1));
  117. //error_log('get_real_teacher_id');
  118. //error_log($data);
  119. if (empty($omigrate['users_alumno'][$data])) {
  120. //error_log('not set');
  121. return 1;
  122. } else {
  123. $persona_id = $omigrate['users_alumno'][$data]['uidIdPersona'];
  124. if (!empty($persona_id)) {
  125. return $omigrate['users_persona'][$persona_id]['user_id'];
  126. }
  127. }
  128. return $omigrate['users_alumno'][$data]['user_id'];
  129. }
  130. public function get_real_teacher_id($uidIdPersona, &$omigrate, $row_data) {
  131. $default_teacher_id = self::default_admin_id;
  132. //error_log('get_real_teacher_id');
  133. //error_log(print_r($data, 1));
  134. //error_log(print_r($omigrate['users_empleado'], 1));
  135. //error_log('get_real_teacher_id');
  136. //error_log($data);
  137. if (empty($uidIdPersona)) {
  138. //error_log('No teacher provided');
  139. return $default_teacher_id;
  140. }
  141. $extra_field = new ExtraFieldValue('user');
  142. $values = $extra_field->get_item_id_from_field_variable_and_field_value('uidIdPersona', $uidIdPersona);
  143. if ($values) {
  144. return $values['user_id'];
  145. } else {
  146. return $default_teacher_id;
  147. }
  148. /*
  149. if (!isset($omigrate['users_empleado'][$data])) {
  150. //error_log(' Teacher not found big problem! ');
  151. //echo $data;
  152. //print_r($omigrate['users_empleado'][$data]);
  153. //echo $data;exit;
  154. return $default_teacher_id;
  155. } else {
  156. //error_log('Teacher found: '.$omigrate['users_empleado'][$data]['extra']['user_id']);
  157. return isset($omigrate['users_empleado'][$data]['extra']) ? $omigrate['users_empleado'][$data]['extra']['user_id'] : $default_teacher_id;
  158. } */
  159. }
  160. /**
  161. * Manage the user creation, including checking if the user hasn't been
  162. * created previously
  163. * @param array User data
  164. * @param object List of migrated things
  165. * @return array User info (from Chamilo DB)
  166. */
  167. public function create_user($data, $omigrate) {
  168. //error_log(print_r($data, 1));
  169. if (empty($data['uidIdPersona'])) {
  170. error_log('User does not have a uidIdPersona');
  171. error_log(print_r($data, 1));
  172. exit;
  173. }
  174. //Is a teacher
  175. if (isset($omigrate['users_empleado'][$data['uidIdEmpleado']])) {
  176. //error_log(print_r($omigrate['users_empleado'][$data['uidIdPersona']], 1));
  177. //error_log(print_r($data, 1));
  178. //error_log('teacher');
  179. //$data['username'] = UserManager::create_unique_username($data['firstname'], $data['lastname']);
  180. $data['status'] = COURSEMANAGER;
  181. } else {
  182. $data['status'] = STUDENT;
  183. }
  184. if (!isset($data['username']) || empty($data['username'])) {
  185. $data['firstname'] = (string) trim($data['firstname']);
  186. $data['lastname'] = (string) trim($data['lastname']);
  187. if (empty($data['firstname']) && empty($data['lastname'])) {
  188. $wanted_user_name = UserManager::purify_username($data['uidIdPersona']);
  189. //$wanted_user_name = UserManager::create_unique_username(null, null);
  190. } else {
  191. $wanted_user_name = UserManager::create_username($data['firstname'], $data['lastname']);
  192. }
  193. $extra_data = UserManager::get_extra_user_data_by_value('uidIdPersona', $data['uidIdPersona']);
  194. if ($extra_data) {
  195. $user_info = api_get_user_info($extra_data[0]);
  196. //print_r($extra_data);
  197. //error_log("User_already_added - {$user_info['user_id']} - {$user_info['username']} - {$user_info['firstname']} - {$user_info['lastname']}");
  198. return $user_info;
  199. }
  200. if (UserManager::is_username_available($wanted_user_name)) {
  201. $data['username'] = $wanted_user_name;
  202. error_log("username available $wanted_user_name");
  203. } else {
  204. //the user already exists?
  205. $user_info = UserManager::get_user_info_simple($wanted_user_name);
  206. $user_persona = UserManager::get_extra_user_data_by_field($user_info['user_id'], 'uidIdPersona');
  207. if (isset($user_persona['uidIdPersona']) && $data['uidIdPersona'] == $user_persona['uidIdPersona']) {
  208. error_log("Skip user already added: {$user_info['username']}");
  209. return $user_info;
  210. } else {
  211. error_log("homonym - wanted_username: $wanted_user_name - uidIdPersona: {$user_persona['uidIdPersona']} - username: {$user_info['username']}");
  212. print_r($data);
  213. //The user has the same firstname and lastname but it has another uiIdPersona could by an homonym
  214. $data['username'] = UserManager::create_unique_username($data['firstname'], $data['lastname']);
  215. error_log("homonym username created ". $data['username']);
  216. }
  217. }
  218. if (empty($data['username'])) {
  219. //Last chance to have a nice username
  220. if (empty($data['firstname']) && empty($data['lastname'])) {
  221. $data['username'] = UserManager::create_unique_username(uniqid());
  222. error_log("username empty 1". $data['username']);
  223. } else {
  224. $data['username'] = UserManager::create_unique_username($data['firstname'], $data['lastname']);
  225. error_log("username empty 2". $data['username']);
  226. }
  227. }
  228. } else {
  229. if (UserManager::is_username_available($data['username'])) {
  230. //error_log("username available {$data['username']} ");
  231. } else {
  232. //the user already exists?
  233. $user_info = UserManager::get_user_info_simple($data['username']);
  234. $user_persona = UserManager::get_extra_user_data_by_field($user_info['user_id'], 'uidIdPersona');
  235. if (isset($user_persona['uidIdPersona']) && (string)$data['uidIdPersona'] == (string)$user_persona['uidIdPersona']) {
  236. //error_log("2 Skip user already added: {$user_info['username']}");
  237. return $user_info;
  238. } else {
  239. //print_r($user_persona);
  240. //error_log("2 homonym - wanted_username: {$data['username']} - uidIdPersona: {$user_persona['uidIdPersona']} - username: {$user_info['username']}");
  241. //print_r($data);
  242. //The user has the same firstname and lastname but it has another uiIdPersona could by an homonym
  243. $data['username'] = UserManager::create_unique_username($data['firstname'], $data['lastname']);
  244. //error_log("2 homonym username created ". $data['username']);
  245. }
  246. }
  247. }
  248. if (empty($data['username'])) {
  249. error_log('No Username provided');
  250. error_log(print_r($data, 1));
  251. exit;
  252. }
  253. $id_persona = $data['uidIdPersona'];
  254. unset($data['uidIdPersona']);
  255. unset($data['uidIdAlumno']);
  256. unset($data['uidIdEmpleado']);
  257. global $api_failureList;
  258. $api_failureList = array();
  259. //error_log(print_r($data, 1));
  260. $user_info = UserManager::add($data);
  261. if (!$user_info) {
  262. echo 'error';
  263. }
  264. UserManager::update_extra_field_value($user_info['user_id'], 'uidIdPersona', $id_persona);
  265. return $user_info;
  266. }
  267. /**
  268. * Manages the course creation based on the rules in db_matches.php
  269. */
  270. public function create_course($data) {
  271. //Fixes wrong wanted codes
  272. $data['wanted_code'] = str_replace(array('-', '_'), '000', $data['wanted_code']);
  273. //Creates an evaluation
  274. $data['create_gradebook_evaluation'] = true;
  275. //Specific to ICPNA, set the default language to English
  276. $data['language'] = 'english';
  277. $data['visibility'] = COURSE_VISIBILITY_REGISTERED;
  278. $data['gradebook_params'] = array(
  279. 'name' => 'General evaluation',
  280. 'user_id' => self::default_admin_id,
  281. 'weight' => '20',
  282. 'max' => '20'
  283. );
  284. return CourseManager::create_course($data);
  285. }
  286. /**
  287. * Manages the session creation, based on data provided by the rules
  288. * in db_matches.php
  289. */
  290. public function create_session($data) {
  291. $session_id = SessionManager::add($data);
  292. if (!$session_id) {
  293. print_r($data);
  294. exit;
  295. }
  296. return $session_id;
  297. }
  298. /**
  299. * Assigns a user to a session based on rules in db_matches.php
  300. */
  301. public function add_user_to_session($data) {
  302. //error_log('add_user_to_session');
  303. ///print_r($data);
  304. //Search uidIdPrograma
  305. //Search uidIdAlumno
  306. $extra_field_value = new ExtraFieldValue('session');
  307. $result = $extra_field_value->get_item_id_from_field_variable_and_field_value('uidIdPrograma', $data['uidIdPrograma']);
  308. $session_id = null;
  309. $user_id = null;
  310. if ($result && $result['session_id']) {
  311. $session_id = $result['session_id'];
  312. }
  313. $extra_field_value = new ExtraFieldValue('user');
  314. $result = $extra_field_value->get_item_id_from_field_variable_and_field_value('uidIdPersona', $data['uidIdPersona']);
  315. if ($result && $result['user_id']) {
  316. $user_id = $result['user_id'];
  317. }
  318. if (!empty($session_id) && !empty($user_id)){
  319. error_log('Called: add_user_to_session - Subscribing: session_id: '.$session_id. ' user_id: '.$user_id);
  320. SessionManager::suscribe_users_to_session($session_id, array($user_id));
  321. } else {
  322. //error_log('Called: add_user_to_session - No idPrograma: '.$data['uidIdPrograma'].' - No uidIdPersona: '.$data['uidIdPersona']);
  323. }
  324. }
  325. }