cm_webservice_course.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. <?php
  2. require_once(dirname(__FILE__).'/../inc/global.inc.php');
  3. $libpath = api_get_path(LIBRARY_PATH);
  4. require_once $libpath.'course.lib.php';
  5. require_once $libpath.'add_course.lib.inc.php';
  6. require_once $libpath.'course_description.lib.php';
  7. require_once(dirname(__FILE__).'/cm_webservice.php');
  8. /**
  9. * Web services available for the Course module. This class extends the WS class
  10. */
  11. class WSCMCourse extends WSCM {
  12. /**
  13. * Deletes a course (helper method)
  14. *
  15. * @param string Course id field name
  16. * @param string Course id value
  17. * @return mixed True if the course was successfully deleted, WSError otherwise
  18. */
  19. protected function deleteCourseHelper($course_id_field_name, $course_id_value) {
  20. $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
  21. if($course_id instanceof WSCMError) {
  22. return $course_id;
  23. } else {
  24. $course_code = CourseManager::get_course_code_from_course_id($course_id);
  25. CourseManager::delete_course($course_code);
  26. return true;
  27. }
  28. }
  29. /**
  30. * Deletes a course
  31. *
  32. * @param string API secret key
  33. * @param string Course id field name
  34. * @param string Course id value
  35. */
  36. public function DeleteCourse($secret_key, $course_id_field_name, $course_id_value) {
  37. $verifKey = $this->verifyKey($secret_key);
  38. if($verifKey instanceof WSError) {
  39. $this->handleError($verifKey);
  40. } else {
  41. $result = $this->deleteCourseHelper($course_id_field_name, $course_id_value);
  42. if($result instanceof WSError) {
  43. $this->handleError($result);
  44. }
  45. }
  46. }
  47. /**
  48. * Deletes multiple courses
  49. *
  50. * @param string API secret key
  51. * @param array Array of courses with elements of the form array('course_id_field_name' => 'name_of_field', 'course_id_value' => 'value')
  52. * @return array Array with elements like array('course_id_value' => 'value', 'result' => array('code' => 0, 'message' => 'Operation was successful')). Note that if the result array contains a code different
  53. * than 0, an error occured
  54. */
  55. public function DeleteCourses($secret_key, $courses) {
  56. $verifKey = $this->verifyKey($secret_key);
  57. if($verifKey instanceof WSError) {
  58. $this->handleError($verifKey);
  59. } else {
  60. $results = array();
  61. foreach($courses as $course) {
  62. $result_tmp = array();
  63. $result_op = $this->deleteCourseHelper($course['course_id_field_name'], $course['course_id_value']);
  64. $result_tmp['course_id_value'] = $course['course_id_value'];
  65. if($result_op instanceof WSCMError) {
  66. // Return the error in the results
  67. $result_tmp['result'] = $result_op->toArray();
  68. } else {
  69. $result_tmp['result'] = $this->getSuccessfulResult();
  70. }
  71. $results[] = $result_tmp;
  72. }
  73. return $results;
  74. }
  75. }
  76. /**
  77. * Creates a course (helper method)
  78. *
  79. * @param string Title
  80. * @param string Category code
  81. * @param string Wanted code. If it's not defined, it will be generated automatically
  82. * @param string Tutor name
  83. * @param string Course admin user id field name
  84. * @param string Course admin user id value
  85. * @param string Course language
  86. * @param string Course id field name
  87. * @param string Course id value
  88. * @param array Course extra fields
  89. * @return mixed Generated id if creation was successful, WSError otherwise
  90. */
  91. protected function createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) {
  92. // Add the original course id field name and value to the extra fields if needed
  93. $extras_associative = array();
  94. if($course_id_field_name != "chamilo_course_id") {
  95. $extras_associative[$course_id_field_name] = $course_id_value;
  96. }
  97. foreach($extras as $extra) {
  98. $extras_associative[$extra['field_name']] = $extra['field_value'];
  99. }
  100. $course_admin_id = $this->getUserId($course_admin_user_id_field_name, $course_admin_user_id_value);
  101. if($course_admin_id instanceof WSError) {
  102. return $course_admin_id;
  103. }
  104. if($wanted_code == '') {
  105. $wanted_code = generate_course_code($title);
  106. }
  107. $result = create_course($wanted_code, $title, $tutor_name, $category_code, $language, $course_admin_id, $this->_configuration['db_prefix'], 0);
  108. if (!$result) {
  109. return new WSError(202, 'There was an error creating the course');
  110. } else {
  111. // Update extra fields
  112. foreach($extras_associative as $fname => $fvalue) {
  113. CourseManager::update_course_extra_field_value($result, $fname, $fvalue);
  114. }
  115. // Get course id
  116. $course_info = CourseManager::get_course_information($result);
  117. return $course_info['id'];
  118. }
  119. }
  120. /**
  121. * Creates a course
  122. *
  123. * @param string API secret key
  124. * @param string Title
  125. * @param string Category code
  126. * @param string Wanted code. If it's not defined, it will be generated automatically
  127. * @param string Tutor name
  128. * @param string Course admin user id field name
  129. * @param string Course admin user id value
  130. * @param string Course language
  131. * @param string Course id field name
  132. * @param string Course id value
  133. * @param array Course extra fields
  134. * @return int Course id generated
  135. */
  136. public function CreateCourse($secret_key, $title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras) {
  137. // First, verify the secret key
  138. $verifKey = $this->verifyKey($secret_key);
  139. if($verifKey instanceof WSError) {
  140. $this->handleError($verifKey);
  141. } else {
  142. $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras);
  143. if($result instanceof WSError) {
  144. $this->handleError($result);
  145. } else {
  146. return $result;
  147. }
  148. }
  149. }
  150. /**
  151. * Create multiple courses
  152. *
  153. * @param string API secret key
  154. * @param array Courses to be created, with elements following the structure presented in CreateCourse
  155. * @return array Array with elements of the form array('course_id_value' => 'original value sent', 'course_id_generated' => 'value_generated', 'result' => array('code' => 0, 'message' => 'Operation was successful'))
  156. */
  157. public function CreateCourses($secret_key, $courses) {
  158. // First, verify the secret key
  159. $verifKey = $this->verifyKey($secret_key);
  160. if($verifKey instanceof WSCMError) {
  161. $this->handleError($verifKey);
  162. } else {
  163. $results = array();
  164. foreach($courses as $course) {
  165. $result_tmp = array();
  166. //reinitialize variables just in case
  167. $title = $category_code = $wanted_code = $tutor_name = $course_admin_user_id_field_name = $course_admin_user_id_value = $language = $course_id_field_name = $course_id_value = $extras = null;
  168. extract($course);
  169. $result = $this->createCourseHelper($title, $category_code, $wanted_code, $tutor_name, $course_admin_user_id_field_name, $course_admin_user_id_value, $language, $course_id_field_name, $course_id_value, $extras);
  170. if($result instanceof WSCMError) {
  171. $result_tmp['result'] = $result->toArray();
  172. $result_tmp['course_id_value'] = $course_id_value;
  173. $result_tmp['course_id_generated'] = 0;
  174. } else {
  175. $result_tmp['result'] = $this->getSuccessfulResult();
  176. $result_tmp['course_id_value'] = $course_id_value;
  177. $result_tmp['course_id_generated'] = $result;
  178. }
  179. $results[] = $result_tmp;
  180. }
  181. return $results;
  182. }
  183. }
  184. /**
  185. * Edits a course (helper method)
  186. *
  187. * @param string Course id field name
  188. * @param string Course id value
  189. * @param string Title
  190. * @param string Category code
  191. * @param string Department name
  192. * @param string Department url
  193. * @param string Course language
  194. * @param int Visibility
  195. * @param int Subscribe (0 = denied, 1 = allowed)
  196. * @param int Unsubscribe (0 = denied, 1 = allowed)
  197. * @param string Visual code
  198. * @param array Course extra fields
  199. * @return mixed True in case of success, WSError otherwise
  200. */
  201. protected function editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) {
  202. $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
  203. if($course_id instanceof WSCMError) {
  204. return $course_id;
  205. } else {
  206. $attributes = array();
  207. if(!is_empty($title)) {
  208. $attributes['title'] = $title;
  209. }
  210. if(!is_empty($category_code)) {
  211. $attributes['category_code'] = $category_code;
  212. }
  213. if(!is_empty($department_name)) {
  214. $attributes['department_name'] = $department_name;
  215. }
  216. if(!is_empty($department_url)) {
  217. $attributes['department_url'] = $department_url;
  218. }
  219. if(!is_empty($language)) {
  220. $attributes['course_language'] = $language;
  221. }
  222. if($visibility != '') {
  223. $attributes['visibility'] = (int)$visibility;
  224. }
  225. if($subscribe != '') {
  226. $attributes['subscribe'] = (int)$subscribe;
  227. }
  228. if($unsubscribe != '') {
  229. $attributes['unsubscribe'] = (int)$unsubscribe;
  230. }
  231. if(!is_empty($visual_code)) {
  232. $attributes['visual_code'] = $visual_code;
  233. }
  234. if(!is_empty($attributes)) {
  235. CourseManager::update_attributes($course_id, $attributes);
  236. }
  237. if(!empty($extras)) {
  238. $course_code = CourseManager::get_course_code_from_course_id($course_id);
  239. $extras_associative = array();
  240. foreach($extras as $extra) {
  241. $extras_associative[$extra['field_name']] = $extra['field_value'];
  242. }
  243. foreach($extras_associative as $fname => $fvalue) {
  244. CourseManager::update_extra_field_value($course_code, $fname, $fvalue);
  245. }
  246. }
  247. return true;
  248. }
  249. }
  250. /**
  251. * Edits a course
  252. *
  253. * @param string API secret key
  254. * @param string Course id field name
  255. * @param string Course id value
  256. * @param string Title
  257. * @param string Category code
  258. * @param string Department name
  259. * @param string Department url
  260. * @param string Course language
  261. * @param int Visibility
  262. * @param int Subscribe (0 = denied, 1 = allowed)
  263. * @param int Unsubscribe (0 = denied, 1 = allowed)
  264. * @param string Visual code
  265. * @param array Course extra fields
  266. */
  267. public function EditCourse($secret_key, $course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras) {
  268. $verifKey = $this->verifyKey($secret_key);
  269. if($verifKey instanceof WSCMError) {
  270. $this->handleError($verifKey);
  271. } else {
  272. $result = $this->editCourseHelper($course_id_field_name, $course_id_value, $title, $category_code, $department_name, $department_url, $language, $visibility, $subscribe, $unsubscribe, $visual_code, $extras);
  273. if($result instanceof WSCMError) {
  274. $this->handleError($result);
  275. }
  276. }
  277. }
  278. /**
  279. * List courses
  280. *
  281. * @param string API secret key
  282. * @param string Course id field name. Use "chamilo_course_id" to use internal id
  283. * @return array An array with elements of the form ('id' => 'Course internal id', 'code' => 'Course code', 'title' => 'Course title', 'language' => 'Course language', 'visibility' => 'Course visibility',
  284. * 'category_name' => 'Name of the category of the course', 'number_students' => 'Number of students in the course', 'external_course_id' => 'External course id')
  285. */
  286. public function ListCourses($secret_key, $course_id_field_name) {
  287. $verifKey = $this->verifyKey($secret_key);
  288. if($verifKey instanceof WSError) {
  289. $this->handleError($verifKey);
  290. } else {
  291. $courses_result = array();
  292. $category_names = array();
  293. $courses = CourseManager::get_courses_list();
  294. foreach($courses as $course) {
  295. $course_tmp = array();
  296. $course_tmp['id'] = $course['id'];
  297. $course_tmp['code'] = $course['code'];
  298. $course_tmp['title'] = $course['title'];
  299. $course_tmp['language'] = $course['course_language'];
  300. $course_tmp['visibility'] = $course['visibility'];
  301. // Determining category name
  302. if($category_names[$course['category_code']]) {
  303. $course_tmp['category_name'] = $category_names[$course['category_code']];
  304. } else {
  305. $category = CourseManager::get_course_category($course['category_code']);
  306. $category_names[$course['category_code']] = $category['name'];
  307. $course_tmp['category_name'] = $category['name'];
  308. }
  309. // Determining number of students registered in course
  310. $user_list = CourseManager::get_user_list_from_course_code($course['code'], false);
  311. $course_tmp['number_students'] = count($user_list);
  312. // Determining external course id
  313. $course_tmp['external_course_id'] = CourseManager::get_course_extra_field_value($course_id_field_name, $course['code']);
  314. $courses_result[] = $course_tmp;
  315. }
  316. return $courses_result;
  317. }
  318. }
  319. /**
  320. * Subscribe or unsubscribe user to a course (helper method)
  321. *
  322. * @param string Course id field name. Use "chamilo_course_id" to use internal id
  323. * @param string Course id value.
  324. * @param string User id field name. Use "chamilo_user_id" to use internal id
  325. * @param string User id value
  326. * @param int Set to 1 to subscribe, 0 to unsubscribe
  327. * @param int Status (STUDENT or TEACHER) Used for subscription only
  328. * @return mixed True if subscription or unsubscription was successful, false otherwise
  329. */
  330. protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) {
  331. $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
  332. if($course_id instanceof WSError) {
  333. return $course_id;
  334. } else {
  335. $user_id = $this->getUserId($user_id_field_name, $user_id_value);
  336. if($user_id instanceof WSError) {
  337. return $user_id;
  338. } else {
  339. $course_code = CourseManager::get_course_code_from_course_id($course_id);
  340. if($state == 0) {
  341. // Unsubscribe user
  342. CourseManager::unsubscribe_user($user_id, $course_code);
  343. return true;
  344. } else {
  345. // Subscribe user
  346. if(CourseManager::subscribe_user($user_id, $course_code, $status)) {
  347. return true;
  348. } else {
  349. return new WSError(203, 'An error occured subscribing to this course');
  350. }
  351. }
  352. }
  353. }
  354. }
  355. /**
  356. * Subscribe user to a course
  357. *
  358. * @param string API secret key
  359. * @param string Course id field name. Use "chamilo_course_id" to use internal id
  360. * @param string Course id value.
  361. * @param string User id field name. Use "chamilo_user_id" to use internal id
  362. * @param string User id value
  363. * @param int Status (1 = Teacher, 5 = Student)
  364. */
  365. public function SubscribeUserToCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $status) {
  366. $verifKey = $this->verifyKey($secret_key);
  367. if($verifKey instanceof WSError) {
  368. $this->handleError($verifKey);
  369. } else {
  370. $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 1, $status);
  371. if($result instanceof WSError) {
  372. $this->handleError($result);
  373. }
  374. }
  375. }
  376. /**
  377. * Unsusbscribe user from course
  378. *
  379. * @param string API secret key
  380. * @param string Course id field name. Use "chamilo_course_id" to use internal id
  381. * @param string Course id value.
  382. * @param string User id field name. Use "chamilo_user_id" to use internal id
  383. * @param string User id value
  384. */
  385. public function UnsubscribeUserFromCourse($secret_key, $course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value) {
  386. $verifKey = $this->verifyKey($secret_key);
  387. if($verifKey instanceof WSError) {
  388. $this->handleError($verifKey);
  389. } else {
  390. $result = $this->changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, 0);
  391. if($result instanceof WSError) {
  392. $this->handleError($result);
  393. }
  394. }
  395. }
  396. /**
  397. * Returns the descriptions of a course, along with their id
  398. *
  399. * @param string API secret key
  400. * @param string Course id field name
  401. * @param string Course id value
  402. * @return array Returns an array with elements of the form ('course_desc_id' => 1, 'course_desc_title' => 'Title', 'course_desc_content' => 'Content')
  403. */
  404. public function GetCourseDescriptions($secret_key, $course_id_field_name, $course_id_value) {
  405. $verifKey = $this->verifyKey($secret_key);
  406. if($verifKey instanceof WSError) {
  407. $this->handleError($verifKey);
  408. } else {
  409. $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
  410. if($course_id instanceof WSError) {
  411. return $course_id;
  412. } else {
  413. // Course exists, get its descriptions
  414. $descriptions = CourseDescription::get_descriptions($course_id);
  415. $results = array();
  416. foreach($descriptions as $description) {
  417. $results[] = array('course_desc_id' => $description->get_description_type(),
  418. 'course_desc_title' => $description->get_title(),
  419. 'course_desc_content' => $description->get_content());
  420. }
  421. return $results;
  422. }
  423. }
  424. }
  425. /**
  426. * Edit course description
  427. *
  428. * @param string API secret key
  429. * @param string Course id field name
  430. * @param string Course id value
  431. * @param int Category id from course description
  432. * @param string Description title
  433. * @param string Course description content
  434. */
  435. public function EditCourseDescription($secret_key, $course_id_field_name, $course_id_value, $course_desc_id, $course_desc_title, $course_desc_content) {
  436. $verifKey = $this->verifyKey($secret_key);
  437. if($verifKey instanceof WSError) {
  438. $this->handleError($verifKey);
  439. } else {
  440. $course_id = $this->getCourseId($course_id_field_name, $course_id_value);
  441. if($course_id instanceof WSError) {
  442. return $course_id;
  443. } else {
  444. // Create the new course description
  445. $cd = new CourseDescription();
  446. $cd->set_description_type($course_desc_id);
  447. $cd->set_title($course_desc_title);
  448. $cd->set_content($course_desc_content);
  449. $cd->set_session_id(0);
  450. // Get course info
  451. $course_info = CourseManager::get_course_information(CourseManager::get_course_code_from_course_id($course_id));
  452. // Check if this course description exists
  453. $descriptions = CourseDescription::get_descriptions($course_id);
  454. $exists = false;
  455. foreach($descriptions as $description) {
  456. if($description->get_description_type() == $course_desc_id) {
  457. $exists = true;
  458. }
  459. }
  460. if (!$exists) {
  461. $cd->set_progress(0);
  462. $cd->insert($course_info['db_name']);
  463. } else {
  464. $cd->update($course_info['db_name']);
  465. }
  466. }
  467. }
  468. }
  469. public function unreadMessage($username, $password)
  470. {
  471. if($this->verifyUserPass($username, $password) == "valid")
  472. {
  473. $table_message = Database::get_main_table(TABLE_MESSAGE);
  474. $user_id = UserManager::get_user_id_from_username($username);
  475. $condition_msg_status = ' msg_status = 1 '; // define('MESSAGE_STATUS_UNREAD', '1');
  476. $sql_query = "SELECT COUNT(*) as number_messages FROM $table_message WHERE $condition_msg_status AND user_receiver_id=".$user_id;
  477. $sql_result = Database::query($sql_query);
  478. $result = Database::fetch_array($sql_result);
  479. return $result['number_messages'];
  480. }
  481. return "0";
  482. }
  483. public function get_message_data($username, $password)
  484. {
  485. if($this->verifyUserPass($username, $password) == "valid")
  486. {
  487. $user_id = get_user_id_from_username($username);
  488. }
  489. }
  490. public function nada($username, $password)
  491. {
  492. if($this->verifyUserPass($username, $password) == "valid")
  493. return $username.$password;
  494. return $username;
  495. }
  496. }