course.lib.php 153 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275
  1. <?php
  2. /* For licensing terms, see /license.txt*/
  3. /**
  4. * This is the course library for Chamilo.
  5. *
  6. * All main course functions should be placed here.
  7. *
  8. * Many functions of this library deal with providing support for
  9. * virtual/linked/combined courses (this was already used in several universities
  10. * but not available in standard Chamilo).
  11. *
  12. * The implementation changed, initially a course was a real course
  13. * if target_course_code was 0 , this was changed to NULL.
  14. * There are probably some places left with the wrong code.
  15. *
  16. * @package chamilo.library
  17. */
  18. /*
  19. DOCUMENTATION
  20. (list not up to date, you can auto generate documentation with phpDocumentor)
  21. CourseManager::get_real_course_code_select_html($element_name, $has_size=true, $only_current_user_courses=true)
  22. CourseManager::check_parameter($parameter, $error_message)
  23. CourseManager::check_parameter_or_fail($parameter, $error_message)
  24. CourseManager::course_code_exists($wanted_course_code)
  25. CourseManager::get_real_course_list()
  26. CourseManager::get_virtual_course_list()
  27. GENERAL COURSE FUNCTIONS
  28. CourseManager::get_access_settings($course_code)
  29. CourseManager::set_course_tool_visibility($tool_table_id, $visibility)
  30. CourseManager::get_user_in_course_status($user_id, $course_code)
  31. CourseManager::add_user_to_course($user_id, $course_code)
  32. CourseManager::get_virtual_course_info($real_course_code)
  33. CourseManager::is_virtual_course_from_visual_code($visual_code)
  34. CourseManager::is_virtual_course_from_system_code($system_code)
  35. CourseManager::get_virtual_courses_linked_to_real_course($real_course_code)
  36. CourseManager::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)
  37. CourseManager::has_virtual_courses_from_code($real_course_code, $user_id)
  38. CourseManager::get_target_of_linked_course($virtual_course_code)
  39. TITLE AND CODE FUNCTIONS
  40. CourseManager::determine_course_title_from_course_info($user_id, $course_info)
  41. CourseManager::create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list)
  42. CourseManager::create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list)
  43. USER FUNCTIONS
  44. CourseManager::get_real_course_list_of_user_as_course_admin($user_id)
  45. CourseManager::get_course_list_of_user_as_course_admin($user_id)
  46. CourseManager::is_user_subscribed_in_course($user_id, $course_code)
  47. CourseManager::is_user_subscribed_in_real_or_linked_course($user_id, $course_code)
  48. CourseManager::get_user_list_from_course_code($course_code)
  49. CourseManager::get_real_and_linked_user_list($course_code);
  50. GROUP FUNCTIONS
  51. CourseManager::get_group_list_of_course($course_code)
  52. CREATION FUNCTIONS
  53. CourseManager::attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
  54. */
  55. /* INIT SECTION */
  56. /**
  57. * Configuration files
  58. */
  59. require_once api_get_path(CONFIGURATION_PATH).'add_course.conf.php';
  60. /**
  61. * Libraries (we assume main_api is also included...)
  62. */
  63. require_once api_get_path(LIBRARY_PATH).'database.lib.php';
  64. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  65. /**
  66. * Constants definition
  67. */
  68. //LOGIC: course visibility and registration settings
  69. /*
  70. COURSE VISIBILITY
  71. MAPPING OLD SETTINGS TO NEW SETTINGS
  72. -----------------------
  73. NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED
  74. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_NOT_ALLOWED
  75. NOT_VISIBLE_SUBSCRIPTION_ALLOWED
  76. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_ALLOWED
  77. VISIBLE_SUBSCRIPTION_ALLOWED
  78. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_ALLOWED
  79. VISIBLE_NO_SUBSCRIPTION_ALLOWED
  80. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_NOT_ALLOWED
  81. */
  82. //OLD SETTINGS
  83. define('NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED', 0);
  84. define('NOT_VISIBLE_SUBSCRIPTION_ALLOWED', 1);
  85. define('VISIBLE_SUBSCRIPTION_ALLOWED', 2);
  86. define('VISIBLE_NO_SUBSCRIPTION_ALLOWED', 3);
  87. /**
  88. * Variables
  89. */
  90. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  91. $TABLECOURSDOMAIN = Database::get_main_table(TABLE_MAIN_CATEGORY);
  92. $TABLEUSER = Database::get_main_table(TABLE_MAIN_USER);
  93. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  94. $TABLEANNOUNCEMENTS = 'announcement';
  95. $coursesRepositories = $_configuration['root_sys'];
  96. /**
  97. * CourseManager Class
  98. * @package chamilo.library
  99. */
  100. class CourseManager {
  101. /**
  102. * Returns all the information of a given coursecode
  103. * @param string $course_code, the course code
  104. * @return an array with all the fields of the course table
  105. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  106. */
  107. public static function get_course_information($course_code) {
  108. return Database::fetch_array(Database::query(
  109. "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  110. WHERE code='".Database::escape_string($course_code)."'"),'ASSOC'
  111. );
  112. }
  113. /**
  114. * Returns all the information of a given coursecode
  115. * @param int the course id
  116. * @return an array with all the fields of the course table
  117. */
  118. public static function get_course_information_by_id($course_id) {
  119. return Database::select('*', Database::get_main_table(TABLE_MAIN_COURSE), array('where'=>array('id = ?' =>intval($course_id))),'first');
  120. }
  121. /**
  122. * Returns a list of courses. Should work with quickform syntax
  123. * @param integer Offset (from the 7th = '6'). Optional.
  124. * @param integer Number of results we want. Optional.
  125. * @param string The column we want to order it by. Optional, defaults to first column.
  126. * @param string The direction of the order (ASC or DESC). Optional, defaults to ASC.
  127. * @param string The visibility of the course, or all by default.
  128. * @param string If defined, only return results for which the course *title* begins with this string
  129. */
  130. public static function get_courses_list($from = 0, $howmany = 0, $orderby = 1, $orderdirection = 'ASC', $visibility = -1, $startwith = '') {
  131. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." ";
  132. if (!empty($startwith)) {
  133. $sql .= "WHERE title LIKE '".Database::escape_string($startwith)."%' ";
  134. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  135. $sql .= " AND visibility = $visibility ";
  136. }
  137. } else {
  138. $sql .= "WHERE 1 ";
  139. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  140. $sql .= " AND visibility = $visibility ";
  141. }
  142. }
  143. if (!empty($orderby)) {
  144. $sql .= " ORDER BY ".Database::escape_string($orderby)." ";
  145. } else {
  146. $sql .= " ORDER BY 1 ";
  147. }
  148. if (!in_array($orderdirection, array('ASC', 'DESC'))) {
  149. $sql .= 'ASC';
  150. } else {
  151. $sql .= Database::escape_string($orderdirection);
  152. }
  153. if (!empty($howmany) && is_int($howmany) and $howmany > 0) {
  154. $sql .= ' LIMIT '.Database::escape_string($howmany);
  155. } else {
  156. $sql .= ' LIMIT 1000000'; //virtually no limit
  157. }
  158. if (!empty($from)) {
  159. $from = intval($from);
  160. $sql .= ' OFFSET '.Database::escape_string($from);
  161. } else {
  162. $sql .= ' OFFSET 0';
  163. }
  164. return Database::store_result(Database::query($sql));
  165. }
  166. /**
  167. * Returns the access settings of the course:
  168. * which visibility;
  169. * wether subscribing is allowed;
  170. * wether unsubscribing is allowed.
  171. *
  172. * @param string $course_code, the course code
  173. * @todo for more consistency: use course_info call from database API
  174. * @return an array with int fields "visibility", "subscribe", "unsubscribe"
  175. */
  176. public static function get_access_settings($course_code) {
  177. return Database::fetch_array(Database::query(
  178. "SELECT visibility, subscribe, unsubscribe from ".Database::get_main_table(TABLE_MAIN_COURSE)."
  179. WHERE code = '".Database::escape_string($course_code)."'")
  180. );
  181. }
  182. /**
  183. * Returns the status of a user in a course, which is COURSEMANAGER or STUDENT.
  184. * @param int User ID
  185. * @param string Course code
  186. * @return int the status of the user in that course
  187. */
  188. public static function get_user_in_course_status($user_id, $course_code) {
  189. $result = Database::fetch_array(Database::query(
  190. "SELECT status FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  191. WHERE course_code = '".Database::escape_string($course_code)."' AND user_id = ".Database::escape_string($user_id))
  192. );
  193. return $result['status'];
  194. }
  195. /**
  196. * Unsubscribe one or more users from a course
  197. *
  198. * @param mixed user_id or an array with user ids
  199. * @param int session id
  200. * @param string course code
  201. *
  202. */
  203. public static function unsubscribe_user($user_id, $course_code, $session_id = 0) {
  204. if (!is_array($user_id)) {
  205. $user_id = array($user_id);
  206. }
  207. if (count($user_id) == 0) {
  208. return;
  209. }
  210. $table_user = Database :: get_main_table(TABLE_MAIN_USER);
  211. if (!empty($session_id)) {
  212. $session_id = intval($session_id);
  213. } else {
  214. $session_id = intval($_SESSION['id_session']);
  215. }
  216. //Cleaning the $user_id variable
  217. if (is_array($user_id)) {
  218. $new_user_id_list = array();
  219. foreach($user_id as $my_user_id) {
  220. $new_user_id_list[]= intval($my_user_id);
  221. }
  222. $new_user_id_list = array_filter($new_user_id_list);
  223. $user_ids = implode(',', $new_user_id_list);
  224. } else {
  225. $user_ids = intval($user_id);
  226. }
  227. $course_code = Database::escape_string($course_code);
  228. $course = Database::fetch_object(Database::query("SELECT db_name FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  229. WHERE code = '".$course_code."'"));
  230. // Unsubscribe user from all groups in the course.
  231. Database::query("DELETE FROM ".Database::get_course_table(TABLE_GROUP_USER, $course->db_name)."
  232. WHERE user_id IN (".$user_ids.")");
  233. Database::query("DELETE FROM ".Database::get_course_table(TABLE_GROUP_TUTOR, $course->db_name)."
  234. WHERE user_id IN (".$user_ids.")");
  235. // Erase user student publications (works) in the course - by André Boivin
  236. //@todo field student_publication.author should be the user id
  237. $table_course_user_publication = Database :: get_course_table(TABLE_STUDENT_PUBLICATION, $course->db_name);
  238. $sqlu = "SELECT * FROM $table_user WHERE user_id IN (".$user_ids.")";
  239. $resu = Database::query($sqlu);
  240. $username = Database::fetch_array($resu,'ASSOC');
  241. $userfirstname = $username['firstname'];
  242. $userlastname = $username['lastname'];
  243. $publication_name = $userfirstname.' '.$userlastname ;
  244. $sql = "DELETE FROM $table_course_user_publication WHERE author = '".Database::escape_string($publication_name)."'";
  245. Database::query($sql);
  246. // Unsubscribe user from all blogs in the course.
  247. Database::query("DELETE FROM ".Database::get_course_table(TABLE_BLOGS_REL_USER, $course->db_name)."
  248. WHERE user_id IN (".$user_ids.")");
  249. Database::query("DELETE FROM ".Database::get_course_table(TABLE_BLOGS_TASKS_REL_USER, $course->db_name)."
  250. WHERE user_id IN (".$user_ids.")");
  251. //Deleting users in forum_notification and mailqueue course tables
  252. $sql_delete_forum_notification = "DELETE FROM ".Database::get_course_table(TABLE_FORUM_NOTIFICATION, $course->db_name)." WHERE user_id IN (".$user_ids.")";
  253. Database::query($sql_delete_forum_notification);
  254. $sql_delete_mail_queue = "DELETE FROM ".Database::get_course_table(TABLE_FORUM_MAIL_QUEUE, $course->db_name)." WHERE user_id IN (".$user_ids.")";
  255. Database::query($sql_delete_mail_queue);
  256. // Unsubscribe user from the course.
  257. if (!empty($session_id)) {
  258. // Delete in table session_rel_course_rel_user
  259. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  260. WHERE id_session ='".$session_id."' AND course_code = '".Database::escape_string($_SESSION['_course']['id'])."' AND id_user IN ($user_ids)");
  261. foreach ($user_id as $uid) {
  262. // check if a user is register in the session with other course
  263. $sql = "SELECT id_user FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session='$session_id' AND id_user='$uid'";
  264. $rs = Database::query($sql);
  265. if (Database::num_rows($rs) == 0) {
  266. // Delete in table session_rel_user
  267. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  268. WHERE id_session ='".$session_id."' AND id_user='$uid' AND relation_type<>".SESSION_RELATION_TYPE_RRHH."");
  269. }
  270. }
  271. // Update the table session
  272. $row = Database::fetch_array(Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  273. WHERE id_session = '".$session_id."' AND relation_type<>".SESSION_RELATION_TYPE_RRHH." "));
  274. $count = $row[0]; // number of users by session
  275. $result = Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION)." SET nbr_users = '$count'
  276. WHERE id = '".$session_id."'");
  277. // Update the table session_rel_course
  278. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session = '$session_id' AND course_code = '$course_code' AND status<>2" ));
  279. $count = $row[0]; // number of users by session and course
  280. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE)." SET nbr_users = '$count' WHERE id_session = '$session_id' AND course_code = '$course_code' ");
  281. } else {
  282. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  283. WHERE user_id IN (".$user_ids.") AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '".$course_code."'");
  284. // add event to system log
  285. $time = time();
  286. $user_id = api_get_user_id();
  287. event_system(LOG_UNSUBSCRIBE_USER_FROM_COURSE, LOG_COURSE_CODE, $course_code, $time, $user_id);
  288. }
  289. }
  290. /**
  291. * Subscribe a user to a course. No checks are performed here to see if
  292. * course subscription is allowed.
  293. * @param int User ID
  294. * @param string Course code
  295. * @param int Status (STUDENT, COURSEMANAGER, COURSE_ADMIN, NORMAL_COURSE_MEMBER)
  296. * @return bool True on success, false on failure
  297. * @see add_user_to_course
  298. */
  299. public static function subscribe_user($user_id, $course_code, $status = STUDENT, $session_id = 0) {
  300. if ($user_id != strval(intval($user_id))) {
  301. return false; //detected possible SQL injection
  302. }
  303. $course_code = Database::escape_string($course_code);
  304. if (empty ($user_id) || empty ($course_code)) {
  305. return false;
  306. }
  307. if (!empty($session_id)) {
  308. $session_id = intval($session_id);
  309. } else {
  310. $session_id = intval($_SESSION['id_session']);
  311. }
  312. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  313. $role_id = ($status == COURSEMANAGER) ? COURSE_ADMIN : NORMAL_COURSE_MEMBER;
  314. // A preliminary check whether the user has bben already registered on the platform.
  315. if (Database::num_rows(@Database::query("SELECT status FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  316. WHERE user_id = '$user_id' ")) == 0) {
  317. return false; // The user has not been registered to the platform.
  318. }
  319. // Check whether the user has not been already subscribed to the course.
  320. if (empty($session_id)) {
  321. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  322. WHERE user_id = '$user_id' AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '$course_code'")) > 0) {
  323. return false; // The user has been already subscribed to the course.
  324. }
  325. }
  326. if (!empty($session_id)) {
  327. // Check whether the user has not already been stored in the session_rel_course_user table
  328. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  329. WHERE course_code = '".$_SESSION['_course']['id']."'
  330. AND id_session ='".$session_id."'
  331. AND id_user = '".$user_id."'")) > 0) {
  332. return false;
  333. }
  334. // check if the user is registered in the session with other course
  335. $sql = "SELECT id_user FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session='".$session_id."' AND id_user='$user_id'";
  336. $rs = Database::query($sql);
  337. if (Database::num_rows($rs) == 0) {
  338. // Check whether the user has not already been stored in the session_rel_user table
  339. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  340. WHERE id_session ='".$session_id."'
  341. AND id_user = '".$user_id."' AND relation_type<>".SESSION_RELATION_TYPE_RRHH." ")) > 0) {
  342. return false;
  343. }
  344. }
  345. // Add him/her in the table session_rel_course_rel_user
  346. @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  347. SET id_session ='".$session_id."',
  348. course_code = '".$_SESSION['_course']['id']."',
  349. id_user = '".$user_id."'");
  350. // Add him/her in the table session_rel_user
  351. @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  352. SET id_session ='".$session_id."',
  353. id_user = '".$user_id."'");
  354. // Update the table session
  355. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)." WHERE id_session = '".$session_id."' AND relation_type<>".SESSION_RELATION_TYPE_RRHH.""));
  356. $count = $row[0]; // number of users by session
  357. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION)." SET nbr_users = '$count' WHERE id = '".$session_id."'");
  358. // Update the table session_rel_course
  359. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session = '".$session_id."' AND course_code = '$course_code' AND status<>2" ));
  360. $count = $row[0]; // number of users by session
  361. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE)." SET nbr_users = '$count' WHERE id_session = '".$session_id."' AND course_code = '$course_code' ");
  362. } else {
  363. $course_sort = self::userCourseSort($user_id, $course_code);
  364. $result = @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  365. SET course_code = '$course_code',
  366. user_id = '$user_id',
  367. status = '".$status."',
  368. sort = '". ($course_sort)."'");
  369. // Add event to the system log.
  370. $time = time();
  371. $user_id = api_get_user_id();
  372. event_system(LOG_SUBSCRIBE_USER_TO_COURSE, LOG_COURSE_CODE, $course_code, $time, $user_id);
  373. }
  374. return (bool)$result;
  375. }
  376. /**
  377. * Get the course id based on the original id and field name in the extra fields. Returns 0 if course was not found
  378. *
  379. * @param string Original course id
  380. * @param string Original field name
  381. * @return int Course id
  382. */
  383. public static function get_course_code_from_original_id($original_course_id_value, $original_course_id_name) {
  384. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  385. $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  386. $sql_course = "SELECT course_code FROM $table_field cf INNER JOIN $t_cfv cfv ON cfv.field_id=cf.id WHERE field_variable='$original_course_id_name' AND field_value='$original_course_id_value'";
  387. $res = Database::query($sql_course);
  388. $row = Database::fetch_object($res);
  389. if ($row) {
  390. return $row->course_code;
  391. } else {
  392. return 0;
  393. }
  394. }
  395. /**
  396. * Gets the course code from the course id. Returns null if course id was not found
  397. *
  398. * @param int Course id
  399. * @return string Course code
  400. */
  401. public static function get_course_code_from_course_id($id) {
  402. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  403. $sql = "SELECT code FROM course WHERE id = '$id';";
  404. $res = Database::query($sql);
  405. $row = Database::fetch_object($res);
  406. if ($row) {
  407. return $row->code;
  408. } else {
  409. return null;
  410. }
  411. }
  412. /**
  413. * Subscribe a user $user_id to a course $course_code.
  414. * @author Hugues Peeters
  415. * @author Roan Embrechts
  416. *
  417. * @param int $user_id the id of the user
  418. * @param string $course_code the course code
  419. * @param string $status (optional) The user's status in the course
  420. *
  421. * @return boolean true if subscription succeeds, boolean false otherwise.
  422. */
  423. public static function add_user_to_course($user_id, $course_code, $status = STUDENT) {
  424. $user_table = Database::get_main_table(TABLE_MAIN_USER);
  425. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  426. $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  427. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  428. if (empty($user_id) || empty($course_code) || ($user_id != strval(intval($user_id)))) {
  429. return false;
  430. }
  431. $course_code = Database::escape_string($course_code);
  432. // Check in advance whether the user has already been registered on the platform.
  433. if (Database::num_rows(Database::query("SELECT status FROM ".$user_table." WHERE user_id = '$user_id' ")) == 0) {
  434. return false; // Thehe user has not been registered to the platform.
  435. }
  436. // Check whether the user has already been subscribed to this course.
  437. if (Database::num_rows(Database::query("SELECT * FROM ".$course_user_table." WHERE user_id = '$user_id' AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '$course_code'")) > 0) {
  438. return false; // The user has been subscribed to the course.
  439. }
  440. // Check in advance whether subscription is allowed or not for this course.
  441. if (Database::num_rows(Database::query("SELECT code, visibility FROM ".$course_table." WHERE code = '$course_code' AND subscribe = '".SUBSCRIBE_NOT_ALLOWED."'")) > 0) {
  442. return false; // Subscription is not allowed for this course.
  443. }
  444. // Ok, subscribe the user.
  445. $max_sort = api_max_sort_value('0', $user_id);
  446. return (bool)Database::query("INSERT INTO ".$course_user_table."
  447. SET course_code = '$course_code',
  448. user_id = '$user_id',
  449. status = '".$status."',
  450. sort = '". ($max_sort + 1)."'");
  451. }
  452. /**
  453. * Checks wether a parameter exists.
  454. * If it doesn't, the function displays an error message.
  455. *
  456. * @return true if parameter is set and not empty, false otherwise
  457. * @todo move function to better place, main_api ?
  458. */
  459. public static function check_parameter($parameter, $error_message) {
  460. if (empty($parameter)) {
  461. Display::display_normal_message($error_message);
  462. return false;
  463. }
  464. return true;
  465. }
  466. /**
  467. * Lets the script die when a parameter check fails.
  468. * @todo move function to better place, main_api ?
  469. */
  470. public static function check_parameter_or_fail($parameter, $error_message) {
  471. if (!self::check_parameter($parameter, $error_message)) {
  472. die();
  473. }
  474. }
  475. /**
  476. * @return true if there already are one or more courses
  477. * with the same code OR visual_code (visualcode), false otherwise
  478. */
  479. public static function course_code_exists($wanted_course_code) {
  480. $wanted_course_code = Database::escape_string($wanted_course_code);
  481. $result = Database::fetch_array(Database::query("SELECT COUNT(*) as number FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."WHERE code = '$wanted_course_code' OR visual_code = '$wanted_course_code'"));
  482. return $result['number'] > 0;
  483. }
  484. /**
  485. * @return an array with the course info of all real courses on the platform
  486. */
  487. public static function get_real_course_list() {
  488. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE target_course_code IS NULL");
  489. $real_course_list = array();
  490. while ($result = Database::fetch_array($sql_result)) {
  491. $real_course_list[$result['code']] = $result;
  492. }
  493. return $real_course_list;
  494. }
  495. /**
  496. * Lists all virtual courses
  497. * @return array Course info (course code => details) of all virtual courses on the platform
  498. */
  499. public static function get_virtual_course_list() {
  500. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE target_course_code IS NOT NULL");
  501. $virtual_course_list = array();
  502. while ($result = Database::fetch_array($sql_result)) {
  503. $virtual_course_list[$result['code']] = $result;
  504. }
  505. return $virtual_course_list;
  506. }
  507. /**
  508. * Returns an array with the course info of the real courses of which
  509. * the current user is course admin
  510. * @return array A list of courses details for courses to which the user is subscribed as course admin (status = 1)
  511. */
  512. public static function get_real_course_list_of_user_as_course_admin($user_id) {
  513. $result_array = array();
  514. if ($user_id != strval(intval($user_id))) {
  515. return $result_array;
  516. }
  517. $sql_result = Database::query("SELECT *
  518. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  519. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  520. ON course.code = course_user.course_code
  521. WHERE course.target_course_code IS NULL
  522. AND course_user.user_id = '$user_id'
  523. AND course_user.status = '1'");
  524. if ($sql_result === false) { return $result_array; }
  525. while ($result = Database::fetch_array($sql_result)) {
  526. $result_array[] = $result;
  527. }
  528. return $result_array;
  529. }
  530. /**
  531. * @return an array with the course info of all the courses (real and virtual) of which
  532. * the current user is course admin
  533. */
  534. public static function get_course_list_of_user_as_course_admin($user_id) {
  535. global $_configuration;
  536. if ($user_id != strval(intval($user_id))) {
  537. return array();
  538. }
  539. // Definitions database tables and variables
  540. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  541. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  542. $user_id = intval($user_id);
  543. $data = array();
  544. $sql_nb_cours = "SELECT course_rel_user.course_code, course.title, course.id, course.db_name
  545. FROM $tbl_course_user as course_rel_user
  546. INNER JOIN $tbl_course as course
  547. ON course.code = course_rel_user.course_code
  548. WHERE course_rel_user.user_id='$user_id' AND course_rel_user.status='1'
  549. ORDER BY course.title";
  550. if ($_configuration['multiple_access_urls']) {
  551. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  552. $access_url_id = api_get_current_access_url_id();
  553. if ($access_url_id != -1) {
  554. $sql_nb_cours = " SELECT course_rel_user.course_code, course.title, course.id, course.db_name
  555. FROM $tbl_course_user as course_rel_user
  556. INNER JOIN $tbl_course as course
  557. ON course.code = course_rel_user.course_code
  558. INNER JOIN $tbl_course_rel_access_url course_rel_url
  559. ON (course_rel_url.course_code= course.code)
  560. WHERE access_url_id = $access_url_id AND course_rel_user.user_id='$user_id' AND course_rel_user.status='1'
  561. ORDER BY course.title";
  562. }
  563. }
  564. $result_nb_cours = Database::query($sql_nb_cours);
  565. if (Database::num_rows($result_nb_cours) > 0) {
  566. while ($row = Database::fetch_array($result_nb_cours,'ASSOC')) {
  567. $data[$row['course_code']] = $row;
  568. }
  569. }
  570. return $data;
  571. }
  572. /**
  573. * Find out for which courses the user is registered and determine a visual course code and course title from that.
  574. * Takes virtual courses into account
  575. *
  576. * Default case: the name and code stay what they are.
  577. *
  578. * Scenarios:
  579. * - User is registered in real course and virtual courses; name / code become a mix of all
  580. * - User is registered in real course only: name stays that of real course
  581. * - User is registered in virtual course only: name becomes that of virtual course
  582. * - user is not registered to any of the real/virtual courses: name stays that of real course
  583. * (I'm not sure about the last case, but this seems not too bad)
  584. *
  585. * @author Roan Embrechts
  586. * @param $user_id, the id of the user
  587. * @param $course_info, an array with course info that you get using Database::get_course_info($course_system_code);
  588. * @return an array with indices
  589. * $return_result['title'] - the course title of the combined courses
  590. * $return_result['code'] - the course code of the combined courses
  591. */
  592. public static function determine_course_title_from_course_info($user_id, $course_info) {
  593. if ($user_id != strval(intval($user_id))) {
  594. return array();
  595. }
  596. $real_course_id = $course_info['system_code'];
  597. $real_course_info = Database::get_course_info($real_course_id);
  598. $real_course_name = $real_course_info['title'];
  599. $real_course_visual_code = $real_course_info['visual_code'];
  600. $real_course_real_code = Database::escape_string($course_info['system_code']);
  601. //is the user registered in the real course?
  602. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  603. WHERE user_id = '$user_id' AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '$real_course_real_code'"));
  604. $user_is_registered_in_real_course = !empty($result);
  605. //get a list of virtual courses linked to the current real course and to which the current user is subscribed
  606. $user_subscribed_virtual_course_list = self::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_id);
  607. $virtual_courses_exist = count($user_subscribed_virtual_course_list) > 0;
  608. //now determine course code and name
  609. if ($user_is_registered_in_real_course && $virtual_courses_exist) {
  610. $course_info['name'] = self::create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
  611. $course_info['official_code'] = self::create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
  612. }
  613. elseif ($user_is_registered_in_real_course) {
  614. //course name remains real course name
  615. $course_info['name'] = $real_course_name;
  616. $course_info['official_code'] = $real_course_visual_code;
  617. }
  618. elseif ($virtual_courses_exist) {
  619. $course_info['name'] = self::create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
  620. $course_info['official_code'] = self::create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
  621. } else {
  622. //course name remains real course name
  623. $course_info['name'] = $real_course_name;
  624. $course_info['official_code'] = $real_course_visual_code;
  625. }
  626. $return_result['title'] = $course_info['name'];
  627. $return_result['code'] = $course_info['official_code'];
  628. return $return_result;
  629. }
  630. /**
  631. * Create a course title based on all real and virtual courses the user is registered in.
  632. * @param boolean $user_is_registered_in_real_course
  633. * @param string $real_course_name, the title of the real course
  634. * @param array $virtual_course_list, the list of virtual courses
  635. */
  636. public static function create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list) {
  637. $complete_course_name = array();
  638. if ($user_is_registered_in_real_course) {
  639. // Add the real name to the result.
  640. $complete_course_name[] = $real_course_name;
  641. }
  642. // Add course titles of all virtual courses.
  643. foreach ($virtual_course_list as $current_course) {
  644. $complete_course_name[] = $current_course['title'];
  645. }
  646. // 'CombinedCourse' is from course_home language file.
  647. return (($user_is_registered_in_real_course || count($virtual_course_list) > 1) ? get_lang('CombinedCourse').' ' : '').implode(' &amp; ', $complete_course_name);
  648. }
  649. /**
  650. * Create a course code based on all real and virtual courses the user is registered in.
  651. */
  652. public static function create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list) {
  653. $complete_course_code = array();
  654. if ($user_is_registered_in_real_course) {
  655. // Add the real code to the result
  656. $complete_course_code[] = $real_course_code;
  657. }
  658. // Add codes of all virtual courses.
  659. foreach ($virtual_course_list as $current_course) {
  660. $complete_course_code[] = $current_course['visual_code'];
  661. }
  662. return implode(' &amp; ', $complete_course_code);
  663. }
  664. /**
  665. * Return course info array of virtual course
  666. *
  667. * Note this is different from getting information about a real course!
  668. *
  669. * @param $real_course_code, the id of the real course which the virtual course is linked to
  670. */
  671. public static function get_virtual_course_info($real_course_code) {
  672. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  673. WHERE target_course_code = '".Database::escape_string($real_course_code)."'");
  674. $result = array();
  675. while ($virtual_course = Database::fetch_array($sql_result)) {
  676. $result[] = $virtual_course;
  677. }
  678. return $result;
  679. }
  680. /**
  681. * @param string $system_code, the system code of the course
  682. * @return true if the course is a virtual course, false otherwise
  683. */
  684. public static function is_virtual_course_from_system_code($system_code) {
  685. $result = Database::fetch_array(Database::query("SELECT target_course_code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  686. WHERE code = '".Database::escape_string($system_code)."'"));
  687. return !empty($result['target_course_code']);
  688. }
  689. /**
  690. * Returns whether the course code given is a visual code
  691. * @param string Visual course code
  692. * @return true if the course is a virtual course, false otherwise
  693. */
  694. public static function is_virtual_course_from_visual_code($visual_code) {
  695. $result = Database::fetch_array(Database::query("SELECT target_course_code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  696. WHERE visual_code = '".Database::escape_string($visual_code)."'"));
  697. return !empty($result['target_course_code']);
  698. }
  699. /**
  700. * @return true if the real course has virtual courses that the user is subscribed to, false otherwise
  701. */
  702. public static function has_virtual_courses_from_code($real_course_code, $user_id) {
  703. return count(self::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)) > 0;
  704. }
  705. /**
  706. * Return an array of arrays, listing course info of all virtual course
  707. * linked to the real course ID $real_course_code
  708. *
  709. * @param string The id of the real course which the virtual courses are linked to
  710. * @return array List of courses details
  711. */
  712. public static function get_virtual_courses_linked_to_real_course($real_course_code) {
  713. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  714. WHERE target_course_code = '".Database::get_main_table(TABLE_MAIN_COURSE)."'");
  715. $result_array = array();
  716. while ($result = Database::fetch_array($sql_result)) {
  717. $result_array[] = $result;
  718. }
  719. return $result_array;
  720. }
  721. /**
  722. * This function returns the course code of the real course
  723. * to which a virtual course is linked.
  724. *
  725. * @param the course code of the virtual course
  726. * @return the course code of the real course
  727. */
  728. public static function get_target_of_linked_course($virtual_course_code) {
  729. //get info about the virtual course
  730. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  731. WHERE code = '".Database::escape_string($virtual_course_code)."'"));
  732. return $result['target_course_code'];
  733. }
  734. /*
  735. ==============================================================================
  736. USER FUNCTIONS
  737. ==============================================================================
  738. */
  739. /**
  740. * Check if user is subscribed inside a course
  741. * @param int User id
  742. * @param string Course code, if this parameter is null, it'll check for all courses
  743. * @param bool True for checking inside sessions too, by default is not checked
  744. * @return bool true if the user is registered in the course, false otherwise
  745. */
  746. public static function is_user_subscribed_in_course($user_id, $course_code = null, $in_a_session = false) {
  747. $user_id = intval($user_id);
  748. $condition_course = '';
  749. if (isset($course_code)) {
  750. $course_code = Database::escape_string($course_code);
  751. $condition_course = ' AND course_code = "'.$course_code.'" ';
  752. }
  753. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  754. WHERE user_id = $user_id AND relation_type<>".COURSE_RELATION_TYPE_RRHH." $condition_course "));
  755. if (!empty($result)) {
  756. return true; // The user has been registered in this course.
  757. }
  758. if (!$in_a_session) {
  759. return false; // The user has not been registered in this course.
  760. }
  761. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  762. ' WHERE id_user = '.$user_id.' '.$condition_course.' ')) > 0) {
  763. return true;
  764. }
  765. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  766. ' WHERE id_user = '.$user_id.' AND status=2 '.$condition_course.' ')) > 0) {
  767. return true;
  768. }
  769. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  770. ' WHERE id='.intval($_SESSION['id_session']).' AND id_coach='.$user_id)) > 0) {
  771. return true;
  772. }
  773. return false;
  774. }
  775. /**
  776. * Is the user a teacher in the given course?
  777. *
  778. * @param $user_id, the id (int) of the user
  779. * @param $course_code, the course code
  780. *
  781. * @return true if the user is a teacher in the course, false otherwise
  782. */
  783. public static function is_course_teacher($user_id, $course_code) {
  784. if ($user_id != strval(intval($user_id))) {
  785. return false;
  786. }
  787. $sql_result = Database::query('SELECT status FROM '.Database::get_main_table(TABLE_MAIN_COURSE_USER).
  788. ' WHERE course_code="'.Database::escape_string($course_code).'" and user_id="'.$user_id.'"');
  789. if (Database::num_rows($sql_result) > 0) {
  790. return Database::result($sql_result, 0, 'status') == 1;
  791. }
  792. return false;
  793. }
  794. /**
  795. * Is the user subscribed in the real course or linked courses?
  796. *
  797. * @param int the id of the user
  798. * @param array info about the course (comes from course table, see database lib)
  799. *
  800. * @return true if the user is registered in the real course or linked courses, false otherwise
  801. */
  802. public static function is_user_subscribed_in_real_or_linked_course ($user_id, $course_code, $session_id = '') {
  803. if ($user_id != strval(intval($user_id))) {
  804. return false;
  805. }
  806. $course_code = Database::escape_string($course_code);
  807. if ($session_id == '') {
  808. $result = Database::fetch_array(Database::query("SELECT *
  809. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  810. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  811. ON course.code = course_user.course_code
  812. WHERE course_user.user_id = '$user_id' AND course_user.relation_type<>".COURSE_RELATION_TYPE_RRHH." AND ( course.code = '$course_code' OR target_course_code = '$course_code')"));
  813. return !empty($result);
  814. }
  815. // From here we trust session id.
  816. // Is he/she subscribed to the session's course?
  817. // A user?
  818. if (Database::num_rows(Database::query("SELECT id_user
  819. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  820. WHERE id_session='".$_SESSION['id_session']."'
  821. AND id_user='$user_id'"))) {
  822. return true;
  823. }
  824. // A course coach?
  825. if (Database::num_rows(Database::query("SELECT id_user
  826. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  827. WHERE id_session='".$_SESSION['id_session']."'
  828. AND id_user = '$user_id' AND status = 2
  829. AND course_code='$course_code'"))) {
  830. return true;
  831. }
  832. // A session coach?
  833. if (Database::num_rows(Database::query("SELECT id_coach
  834. FROM ".Database::get_main_table(TABLE_MAIN_SESSION)." AS session
  835. WHERE session.id='".$_SESSION['id_session']."'
  836. AND id_coach='$user_id'"))) {
  837. return true;
  838. }
  839. return false;
  840. }
  841. /**
  842. * Return user info array of all users registered in the specified real or virtual course
  843. * This only returns the users that are registered in this actual course, not linked courses.
  844. *
  845. * @param string $course_code the code of the course
  846. * @param boolean $with_session determines if the course is used in a session or not
  847. * @param integer $session_id the id of the session
  848. * @param string $limit the LIMIT statement of the sql statement
  849. * @param string $order_by the field to order the users by. Valid values are 'lastname', 'firstname', 'username', 'email', 'official_code' OR a part of a SQL statement that starts with ORDER BY ...
  850. * @return array
  851. */
  852. public static function get_user_list_from_course_code($course_code, $with_session = true, $session_id = 0, $limit = '', $order_by = '') {
  853. global $_configuration;
  854. // variable initialisation
  855. $session_id = intval($session_id);
  856. $course_code = Database::escape_string($course_code);
  857. $where = array();
  858. // if the $order_by does not contain 'ORDER BY' we have to check if it is a valid field that can be sorted on
  859. if (!strstr($order_by,'ORDER BY')) {
  860. if (!empty($order_by) AND in_array($order_by, array('lastname', 'firstname', 'username', 'email', 'official_code'))){
  861. $order_by = 'ORDER BY user.'.$order_by;
  862. } else {
  863. $order_by = '';
  864. }
  865. }
  866. $sql = $session_id == 0
  867. ? 'SELECT DISTINCT course_rel_user.status as status_rel, user.user_id, course_rel_user.role, course_rel_user.tutor_id, user.* '
  868. : 'SELECT DISTINCT user.user_id, session_course_user.status as status_session, user.* ';
  869. $sql .= ' FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  870. if (!empty($session_id)) {
  871. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  872. ON user.user_id = session_course_user.id_user
  873. AND session_course_user.course_code="'.$course_code.'"
  874. AND session_course_user.id_session = '.$session_id;
  875. $where[] = ' session_course_user.course_code IS NOT NULL ';
  876. } else {
  877. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  878. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  879. AND course_rel_user.course_code="'.$course_code.'"';
  880. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  881. }
  882. if ($_configuration['multiple_access_urls']) {
  883. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  884. }
  885. $sql .= ' WHERE '.implode(' OR ', $where);
  886. if ($_configuration['multiple_access_urls']) {
  887. $current_access_url_id = api_get_current_access_url_id();
  888. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  889. }
  890. $sql .= ' '.$order_by.' '.$limit;
  891. echo $sql;
  892. $rs = Database::query($sql);
  893. $users = array();
  894. if (Database::num_rows($rs)) {
  895. while ($user = Database::fetch_array($rs)) {
  896. //$user_info = Database::get_user_info_from_id($user['user_id']);
  897. $user_info = $user;
  898. $user_info['status'] = $user['status'];
  899. if (isset($user['role'])) {
  900. $user_info['role'] = $user['role'];
  901. }
  902. if (isset($user['tutor_id'])) {
  903. $user_info['tutor_id'] = $user['tutor_id'];
  904. }
  905. if (!empty($session_id)) {
  906. $user_info['status_session'] = $user['status_session'];
  907. }
  908. $users[$user['user_id']] = $user_info;
  909. }
  910. }
  911. return $users;
  912. }
  913. /**
  914. * Gets subscribed users in a course or in a course/session
  915. *
  916. * @param string $course_code
  917. * @param int $session_id
  918. * @return int
  919. */
  920. public static function get_users_count_in_course($course_code, $session_id = 0) {
  921. global $_configuration;
  922. // variable initialisation
  923. $session_id = intval($session_id);
  924. $course_code = Database::escape_string($course_code);
  925. $sql .= 'SELECT DISTINCT count(*) as count FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  926. $where = array();
  927. if (!empty($session_id)) {
  928. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  929. ON user.user_id = session_course_user.id_user
  930. AND session_course_user.course_code = "'.$course_code.'"
  931. AND session_course_user.id_session = '.$session_id;
  932. $where[] = ' session_course_user.course_code IS NOT NULL ';
  933. } else {
  934. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  935. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  936. AND course_rel_user.course_code="'.$course_code.'"';
  937. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  938. }
  939. if ($_configuration['multiple_access_urls']) {
  940. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  941. }
  942. $sql .= ' WHERE '.implode(' OR ', $where);
  943. if ($_configuration['multiple_access_urls']) {
  944. $current_access_url_id = api_get_current_access_url_id();
  945. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  946. }
  947. $rs = Database::query($sql);
  948. $users = array();
  949. $count = 0;
  950. if (Database::num_rows($rs)) {
  951. $user = Database::fetch_array($rs);
  952. $count = $user['count'];
  953. }
  954. return $count;
  955. }
  956. /**
  957. * Get a list of coaches of a course and a session
  958. * @param string Course code
  959. * @param int Session ID
  960. * @return array List of users
  961. */
  962. public static function get_coach_list_from_course_code($course_code, $session_id) {
  963. if ($session_id != strval(intval($session_id))) {
  964. return array();
  965. }
  966. $course_code = Database::escape_string($course_code);
  967. $users = array();
  968. // We get the coach for the given course in a given session.
  969. $rs = Database::query('SELECT id_user FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  970. ' WHERE id_session="'.$session_id.'" AND course_code="'.$course_code.'" AND status = 2');
  971. while ($user = Database::fetch_array($rs)) {
  972. $user_info = Database::get_user_info_from_id($user['id_user']);
  973. $user_info['status'] = $user['status'];
  974. $user_info['role'] = $user['role'];
  975. $user_info['tutor_id'] = $user['tutor_id'];
  976. $user_info['email'] = $user['email'];
  977. $users[$user['id_user']] = $user_info;
  978. }
  979. // We get the session coach.
  980. $rs = Database::query('SELECT id_coach FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  981. ' WHERE id="'.$session_id.'"');
  982. $user_info = array();
  983. $session_id_coach = Database::result($rs, 0, 'id_coach');
  984. $user_info = Database::get_user_info_from_id($session_id_coach);
  985. $user_info['status'] = $user['status'];
  986. $user_info['role'] = $user['role'];
  987. $user_info['tutor_id'] = $user['tutor_id'];
  988. $user_info['email'] = $user['email'];
  989. $users[$session_id_coach] = $user_info;
  990. return $users;
  991. }
  992. /**
  993. * Return user info array of all users registered in the specified real or virtual course
  994. * This only returns the users that are registered in this actual course, not linked courses.
  995. *
  996. * @param string $course_code
  997. * @param boolean $full list to true if we want sessions students too
  998. * @return array with user id
  999. */
  1000. public static function get_student_list_from_course_code($course_code, $with_session = false, $session_id = 0) {
  1001. $session_id = intval($session_id);
  1002. $course_code = Database::escape_string($course_code);
  1003. $students = array();
  1004. if ($session_id == 0) {
  1005. // students directly subscribed to the course
  1006. $rs = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1007. WHERE course_code = '$course_code' AND status = 5");
  1008. while ($student = Database::fetch_array($rs)) {
  1009. $students[$student['user_id']] = $student;
  1010. }
  1011. }
  1012. // students subscribed to the course through a session
  1013. if (api_get_setting('use_session_mode') == 'true' && $with_session) {
  1014. $sql_query = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE course_code = '$course_code' AND status<>2";
  1015. if ($session_id != 0) {
  1016. $sql_query .= ' AND id_session = '.$session_id;
  1017. }
  1018. $rs = Database::query($sql_query);
  1019. while($student = Database::fetch_array($rs)) {
  1020. $students[$student['id_user']] = $student;
  1021. }
  1022. }
  1023. return $students;
  1024. }
  1025. /**
  1026. * Return user info array of all teacher-users registered in the specified real or virtual course
  1027. * This only returns the users that are registered in this actual course, not linked courses.
  1028. *
  1029. * @param string $course_code
  1030. * @return array with user id
  1031. */
  1032. public static function get_teacher_list_from_course_code($course_code) {
  1033. $course_code = Database::escape_string($course_code);
  1034. // teachers directly subscribed to the course
  1035. $teachers = array();
  1036. // TODO: This query is not optimal.
  1037. $rs = Database::query("SELECT u.user_id, u.lastname, u.firstname, u.email, u.username, u.status " .
  1038. "FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." cu, ".Database::get_main_table(TABLE_MAIN_USER)." u ".
  1039. "WHERE cu.course_code = '$course_code' " .
  1040. "AND cu.status = 1 " .
  1041. "AND cu.user_id = u.user_id");
  1042. while ($teacher = Database::fetch_array($rs)) {
  1043. $teachers[$teacher['user_id']] = $teacher;
  1044. }
  1045. return $teachers;
  1046. }
  1047. /**
  1048. * Return user info array of all users registered in the specified course
  1049. * this includes the users of the course itsel and the users of all linked courses.
  1050. *
  1051. * @param array $course_info
  1052. * @return array with user info
  1053. */
  1054. public static function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id = 0) {
  1055. //get list of virtual courses
  1056. $virtual_course_list = self::get_virtual_courses_linked_to_real_course($course_code);
  1057. //get users from real course
  1058. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  1059. foreach ($user_list as $this_user) {
  1060. $complete_user_list[] = $this_user;
  1061. }
  1062. //get users from linked courses
  1063. foreach ($virtual_course_list as $this_course) {
  1064. $course_code = $this_course['code'];
  1065. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  1066. foreach ($user_list as $this_user) {
  1067. $complete_user_list[] = $this_user;
  1068. }
  1069. }
  1070. return $complete_user_list;
  1071. }
  1072. /**
  1073. * Return an array of arrays, listing course info of all courses in the list
  1074. * linked to the real course $real_course_code, to which the user $user_id is subscribed.
  1075. *
  1076. * @param $user_id, the id (int) of the user
  1077. * @param $real_course_code, the id (char) of the real course
  1078. *
  1079. * @return array of course info arrays
  1080. */
  1081. public static function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code) {
  1082. $result_array = array();
  1083. if ($user_id != strval(intval($user_id))) {
  1084. return $result_array;
  1085. }
  1086. $course_code = Database::escape_string($course_code);
  1087. $sql = "SELECT *
  1088. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  1089. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  1090. ON course.code = course_user.course_code
  1091. WHERE course.target_course_code = '$real_course_code' AND course_user.user_id = '$user_id' AND course_user.relation_type<>".COURSE_RELATION_TYPE_RRHH." ";
  1092. $sql_result = Database::query($sql);
  1093. while ($result = Database::fetch_array($sql_result)) {
  1094. $result_array[] = $result;
  1095. }
  1096. return $result_array;
  1097. }
  1098. /*
  1099. ==============================================================================
  1100. GROUP FUNCTIONS
  1101. ==============================================================================
  1102. */
  1103. /**
  1104. * Get the list of groups from the course
  1105. * @param string Course code
  1106. * @param int Session ID (optional)
  1107. * @return array List of groups info
  1108. */
  1109. public static function get_group_list_of_course($course_code, $session_id = 0) {
  1110. $course_info = Database::get_course_info($course_code);
  1111. $database_name = $course_info['db_name'];
  1112. $group_list = array();
  1113. $session_id != 0 ? $session_condition = ' WHERE g.session_id IN(1,'.intval($session_id).')' : $session_condition = ' WHERE g.session_id = 0';
  1114. $sql="SELECT g.id, g.name, COUNT(gu.id) userNb
  1115. FROM ".Database::get_course_table(TABLE_GROUP, $database_name)." AS g
  1116. LEFT JOIN ".Database::get_course_table(TABLE_GROUP_USER, $database_name)." gu
  1117. ON g.id = gu.group_id
  1118. $session_condition
  1119. GROUP BY g.id
  1120. ORDER BY g.name";
  1121. //var_dump($sql);
  1122. //exit();
  1123. $result = Database::query($sql);
  1124. while ($group_data = Database::fetch_array($result)) {
  1125. $group_list[$group_data['id']] = $group_data;
  1126. }
  1127. return $group_list;
  1128. }
  1129. /**
  1130. * Checks all parameters needed to create a virtual course.
  1131. * If they are all set, the virtual course creation procedure is called.
  1132. *
  1133. * Call this function instead of create_virtual_course
  1134. * @param string Course code
  1135. * @param string Course title
  1136. * @param string Wanted course code
  1137. * @param string Course language
  1138. * @param string Course category
  1139. * @return bool True on success, false on error
  1140. */
  1141. public static function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1142. //better: create parameter list, check the entire list, when false display errormessage
  1143. self::check_parameter_or_fail($real_course_code, 'Unspecified parameter: real course id.');
  1144. self::check_parameter_or_fail($course_title, 'Unspecified parameter: course title.');
  1145. self::check_parameter_or_fail($wanted_course_code, 'Unspecified parameter: wanted course code.');
  1146. self::check_parameter_or_fail($course_language, 'Unspecified parameter: course language.');
  1147. self::check_parameter_or_fail($course_category, 'Unspecified parameter: course category.');
  1148. return self::create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
  1149. }
  1150. /**
  1151. * This function creates a virtual course.
  1152. * It assumes all parameters have been checked and are not empty.
  1153. * It checks wether a course with the $wanted_course_code already exists.
  1154. *
  1155. * Users of this library should consider this function private,
  1156. * please call attempt_create_virtual_course instead of this one.
  1157. *
  1158. * @note The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
  1159. * @param string Course code
  1160. * @param string Course title
  1161. * @param string Wanted course code
  1162. * @param string Course language
  1163. * @param string Course category
  1164. * @return true if the course creation succeeded, false otherwise
  1165. * @todo research: expiration date of a course
  1166. */
  1167. public static function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1168. global $firstExpirationDelay;
  1169. $user_id = api_get_user_id();
  1170. $real_course_info = Database::get_course_info($real_course_code);
  1171. $real_course_code = $real_course_info['system_code'];
  1172. //check: virtual course creation fails if another course has the same
  1173. //code, real or fake.
  1174. if (self::course_code_exists($wanted_course_code)) {
  1175. Display::display_error_message($wanted_course_code.' - '.get_lang('CourseCodeAlreadyExists'));
  1176. return false;
  1177. }
  1178. //add data to course table, course_rel_user
  1179. $course_sys_code = $wanted_course_code;
  1180. $course_screen_code = $wanted_course_code;
  1181. $course_repository = $real_course_info['directory'];
  1182. $course_db_name = $real_course_info['db_name'];
  1183. $responsible_teacher = $real_course_info['tutor_name'];
  1184. $faculty_shortname = $course_category;
  1185. // $course_title = $course_title;
  1186. // $course_language = $course_language;
  1187. $teacher_id = $user_id;
  1188. //HACK ----------------------------------------------------------------
  1189. $expiration_date = time() + $firstExpirationDelay;
  1190. //END HACK ------------------------------------------------------------
  1191. register_course($course_sys_code, $course_screen_code, $course_repository, $course_db_name, $responsible_teacher, $faculty_shortname, $course_title, $course_language, $teacher_id, $expiration_date);
  1192. //above was the normal course creation table update call,
  1193. //now one more thing: fill in the target_course_code field
  1194. Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_COURSE)." SET target_course_code = '$real_course_code'
  1195. WHERE code = '".Database::escape_string($course_sys_code)."' LIMIT 1 ");
  1196. return true;
  1197. }
  1198. /**
  1199. * Delete a course
  1200. * This function deletes a whole course-area from the platform. When the
  1201. * given course is a virtual course, the database and directory will not be
  1202. * deleted.
  1203. * When the given course is a real course, also all virtual courses refering
  1204. * to the given course will be deleted.
  1205. * Considering the fact that we remove all traces of the course in the main
  1206. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1207. * so that a new course created with this code would not use the remains of an older
  1208. * course.
  1209. *
  1210. * @param string The code of the course to delete
  1211. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1212. * course from the groups in the real course if they are not subscribed in
  1213. * that real course.
  1214. * @todo Remove globals
  1215. */
  1216. public static function delete_course($code) {
  1217. global $_configuration;
  1218. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1219. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1220. $table_course_class = Database::get_main_table(TABLE_MAIN_COURSE_CLASS);
  1221. $user_role_table = Database::get_main_table(MAIN_USER_ROLE_TABLE);
  1222. $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
  1223. $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
  1224. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1225. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1226. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1227. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1228. $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1229. $stats = false;
  1230. if (Database::get_statistic_database() != ''){
  1231. $stats = true;
  1232. $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1233. $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1234. $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
  1235. $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1236. $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1237. $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1238. $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1239. $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1240. $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1241. $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1242. $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1243. }
  1244. $code = Database::escape_string($code);
  1245. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1246. $res = Database::query($sql);
  1247. if (Database::num_rows($res) == 0) {
  1248. return;
  1249. }
  1250. $this_course = Database::fetch_array($res);
  1251. $db_name = $this_course['db_name'];
  1252. self::create_database_dump($code);
  1253. if (!self::is_virtual_course_from_system_code($code)) {
  1254. // If this is not a virtual course, look for virtual courses that depend on this one, if any
  1255. $virtual_courses = self::get_virtual_courses_linked_to_real_course($code);
  1256. foreach ($virtual_courses as $index => $virtual_course) {
  1257. // Unsubscribe all classes from the virtual course
  1258. $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
  1259. Database::query($sql);
  1260. // Unsubscribe all users from the virtual course
  1261. $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
  1262. Database::query($sql);
  1263. // Delete the course from the sessions tables
  1264. $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
  1265. Database::query($sql);
  1266. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
  1267. Database::query($sql);
  1268. // Delete the course from the survey tables
  1269. $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
  1270. Database::query($sql);
  1271. $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
  1272. Database::query($sql);
  1273. $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
  1274. Database::query($sql);
  1275. // Delete the course from the stats tables
  1276. if ($stats) {
  1277. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
  1278. Database::query($sql);
  1279. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
  1280. Database::query($sql);
  1281. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
  1282. Database::query($sql);
  1283. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
  1284. Database::query($sql);
  1285. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
  1286. Database::query($sql);
  1287. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
  1288. Database::query($sql);
  1289. $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
  1290. Database::query($sql);
  1291. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
  1292. Database::query($sql);
  1293. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
  1294. Database::query($sql);
  1295. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
  1296. Database::query($sql);
  1297. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
  1298. Database::query($sql);
  1299. }
  1300. // Delete the course from the course table
  1301. $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
  1302. Database::query($sql);
  1303. }
  1304. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1305. $res = Database::query($sql);
  1306. $course = Database::fetch_array($res);
  1307. if (!$_configuration['single_database']) {
  1308. $sql = "DROP DATABASE IF EXISTS ".$course['db_name'];
  1309. Database::query($sql);
  1310. } else {
  1311. //TODO Clean the following code as currently it would probably delete another course
  1312. //similarly named, by mistake...
  1313. $db_pattern = $_configuration['table_prefix'].$course['db_name'].$_configuration['db_glue'];
  1314. $sql = "SHOW TABLES LIKE '$db_pattern%'";
  1315. $result = Database::query($sql);
  1316. while (list ($courseTable) = Database::fetch_array($result)) {
  1317. Database::query("DROP TABLE $courseTable");
  1318. }
  1319. }
  1320. $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
  1321. $archive_dir = api_get_path(SYS_ARCHIVE_PATH).$course['directory'].'_'.time();
  1322. if (is_dir($course_dir)) {
  1323. rename($course_dir, $archive_dir);
  1324. }
  1325. }
  1326. // Unsubscribe all classes from the course
  1327. $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1328. Database::query($sql);
  1329. // Unsubscribe all users from the course
  1330. $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
  1331. Database::query($sql);
  1332. // Delete the course from the sessions tables
  1333. $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
  1334. Database::query($sql);
  1335. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
  1336. Database::query($sql);
  1337. $sql = 'SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
  1338. $result_surveys = Database::query($sql);
  1339. while($surveys = Database::fetch_array($result_surveys)) {
  1340. $survey_id = $surveys[0];
  1341. $sql = 'DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
  1342. Database::query($sql);
  1343. $sql = 'DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
  1344. Database::query($sql);
  1345. $sql = 'DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
  1346. Database::query($sql);
  1347. }
  1348. // Delete the course from the stats tables
  1349. if ($stats) {
  1350. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
  1351. Database::query($sql);
  1352. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
  1353. Database::query($sql);
  1354. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
  1355. Database::query($sql);
  1356. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
  1357. Database::query($sql);
  1358. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
  1359. Database::query($sql);
  1360. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
  1361. Database::query($sql);
  1362. $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
  1363. Database::query($sql);
  1364. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
  1365. Database::query($sql);
  1366. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
  1367. Database::query($sql);
  1368. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
  1369. Database::query($sql);
  1370. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
  1371. Database::query($sql);
  1372. }
  1373. global $_configuration;
  1374. if ($_configuration['multiple_access_urls']) {
  1375. require_once api_get_path(LIBRARY_PATH).'urlmanager.lib.php';
  1376. $url_id = 1;
  1377. if (api_get_current_access_url_id() != -1) {
  1378. $url_id = api_get_current_access_url_id();
  1379. }
  1380. UrlManager::delete_url_rel_course($code, $url_id);
  1381. }
  1382. // Delete the course from the database
  1383. $sql = "DELETE FROM $table_course WHERE code='".$code."'";
  1384. Database::query($sql);
  1385. // delete extra course fields
  1386. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1387. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1388. $sql = "SELECT distinct field_id FROM $t_cfv WHERE course_code = '$code'";
  1389. $res_field_ids = @Database::query($sql);
  1390. while($row_field_id = Database::fetch_row($res_field_ids)){
  1391. $field_ids[] = $row_field_id[0];
  1392. }
  1393. //delete from table_course_field_value from a given course_code
  1394. $sql_course_field_value = "DELETE FROM $t_cfv WHERE course_code = '$code'";
  1395. @Database::query($sql_course_field_value);
  1396. $sql = "SELECT distinct field_id FROM $t_cfv";
  1397. $res_field_all_ids = @Database::query($sql);
  1398. while($row_field_all_id = Database::fetch_row($res_field_all_ids)){
  1399. $field_all_ids[] = $row_field_all_id[0];
  1400. }
  1401. if (is_array($field_ids) && count($field_ids) > 0) {
  1402. foreach ($field_ids as $field_id) {
  1403. // check if field id is used into table field value
  1404. if (is_array($field_all_ids)) {
  1405. if (in_array($field_id, $field_all_ids)) {
  1406. continue;
  1407. } else {
  1408. $sql_course_field = "DELETE FROM $t_cf WHERE id = '$field_id'";
  1409. Database::query($sql_course_field);
  1410. }
  1411. }
  1412. }
  1413. }
  1414. // add event to system log
  1415. $time = time();
  1416. $user_id = api_get_user_id();
  1417. event_system(LOG_COURSE_DELETE, LOG_COURSE_CODE, $code, $time, $user_id, $code);
  1418. }
  1419. /**
  1420. * Creates a file called mysql_dump.sql in the course folder
  1421. * @param $course_code The code of the course
  1422. * @todo Implementation for single database
  1423. */
  1424. public static function create_database_dump($course_code) {
  1425. global $_configuration;
  1426. if ($_configuration['single_database']) {
  1427. return;
  1428. }
  1429. $sql_dump = '';
  1430. $course_code = Database::escape_string($course_code);
  1431. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1432. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  1433. $res = Database::query($sql);
  1434. $course = Database::fetch_array($res);
  1435. $sql = "SHOW TABLES FROM ".$course['db_name'];
  1436. $res = Database::query($sql);
  1437. while ($table = Database::fetch_array($res)) {
  1438. $sql = "SELECT * FROM ".$course['db_name'].".".$table[0]."";
  1439. $res3 = Database::query($sql);
  1440. while ($row = Database::fetch_array($res3)) {
  1441. foreach ($row as $key => $value) {
  1442. $row[$key] = $key."='".addslashes($row[$key])."'";
  1443. }
  1444. $sql_dump .= "\nINSERT INTO $table[0] SET ".implode(', ', $row).';';
  1445. }
  1446. }
  1447. if (is_dir(api_get_path(SYS_COURSE_PATH).$course['directory'])) {
  1448. $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
  1449. $handle = fopen($file_name, 'a+');
  1450. if ($handle !== false) {
  1451. fwrite($handle, $sql_dump);
  1452. fclose($handle);
  1453. } else {
  1454. //TODO trigger exception in a try-catch
  1455. }
  1456. }
  1457. }
  1458. /**
  1459. * Sort courses for a specific user ??
  1460. * @param int User ID
  1461. * @param string Course code
  1462. * @return int Minimum course order
  1463. * @todo Review documentation
  1464. */
  1465. public static function userCourseSort($user_id, $course_code) {
  1466. if ($user_id != strval(intval($user_id))) {
  1467. return false;
  1468. }
  1469. $course_code = Database::escape_string($course_code);
  1470. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  1471. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1472. $course_title = Database::result(Database::query('SELECT title FROM '.$TABLECOURSE.
  1473. ' WHERE code="'.$course_code.'"'), 0, 0);
  1474. $result = Database::query('SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
  1475. WHERE course.code = cu.course_code
  1476. AND user_id = "'.$user_id.'"
  1477. AND cu.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  1478. AND user_course_cat=0 ORDER BY cu.sort');
  1479. $course_title_precedent = '';
  1480. $counter = 0;
  1481. $course_found = false;
  1482. $course_sort = 1;
  1483. while ($courses = Database::fetch_array($result)){
  1484. if ($course_title_precedent == '') {
  1485. $course_title_precedent = $courses['title'];
  1486. }
  1487. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  1488. $course_found = true;
  1489. $course_sort = $courses['sort'];
  1490. if ($counter == 0) {
  1491. $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND relation_type<>'.COURSE_RELATION_TYPE_RRHH.' AND user_course_cat="0" AND sort > "'.$course_sort.'"';
  1492. $course_sort++;
  1493. } else {
  1494. $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND relation_type<>'.COURSE_RELATION_TYPE_RRHH.' AND user_course_cat="0" AND sort >= "'.$course_sort.'"';
  1495. }
  1496. Database::query($sql);
  1497. break;
  1498. } else {
  1499. $course_title_precedent = $courses['title'];
  1500. }
  1501. $counter++;
  1502. }
  1503. // We must register the course in the beginning of the list
  1504. if (Database::num_rows($result) > 0 && !$course_found) {
  1505. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.
  1506. ' WHERE user_id="'.$user_id.'" AND user_course_cat="0"'), 0, 0);
  1507. Database::query('UPDATE '.$TABLECOURSUSER.' SET sort = sort+1
  1508. WHERE user_id= "'.$user_id.'" AND user_course_cat="0"');
  1509. }
  1510. return $course_sort;
  1511. }
  1512. /**
  1513. * create recursively all categories as option of the select passed in paramater.
  1514. *
  1515. * @param object $select_element the quickform select where the options will be added
  1516. * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
  1517. * @param string $parent_code the parent category of the categories added (default=null for root category)
  1518. * @param string $padding the indent param (you shouldn't indicate something here)
  1519. */
  1520. public static function select_and_sort_categories($select_element, $category_selected_code = '', $parent_code = null , $padding = '') {
  1521. $sql = "SELECT code, name, auth_course_child, auth_cat_child
  1522. FROM ".Database::get_main_table(TABLE_MAIN_CATEGORY)."
  1523. WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
  1524. ORDER BY code";
  1525. $res = Database::query($sql);
  1526. while ($cat = Database::fetch_array($res)) {
  1527. $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
  1528. $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
  1529. $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
  1530. if ($cat['auth_cat_child']) {
  1531. self::select_and_sort_categories($select_element, $category_selected_code, $cat['code'], $padding.' - ');
  1532. }
  1533. }
  1534. }
  1535. /**
  1536. * check if course exists
  1537. * @param string course_code
  1538. * @param string whether to accept virtual course codes or not
  1539. * @return true if exists, false else
  1540. */
  1541. public static function course_exists($course_code, $accept_virtual = false) {
  1542. if ($accept_virtual === true) {
  1543. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'" OR visual_code="'.Database::escape_string($course_code).'"';
  1544. } else {
  1545. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'"';
  1546. }
  1547. return Database::num_rows(Database::query($sql));
  1548. }
  1549. /**
  1550. * Send an email to tutor after the auth-suscription of a student in your course
  1551. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1552. * @param int $user_id the id of the user
  1553. * @param string $course_code the course code
  1554. * @param string $send_to_tutor_also
  1555. * @return string we return the message that is displayed when the action is succesfull
  1556. */
  1557. public static function email_to_tutor($user_id, $course_code, $send_to_tutor_also = false) {
  1558. if ($user_id != strval(intval($user_id))) {
  1559. return false;
  1560. }
  1561. $course_code = Database::escape_string($course_code);
  1562. $student = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1563. WHERE user_id='".$user_id."'"));
  1564. $information = self::get_course_information($course_code);
  1565. $name_course = $information['title'];
  1566. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." WHERE course_code='".$course_code."'";
  1567. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  1568. //if ($send_to_tutor_also = true) {
  1569. // Proposed change:
  1570. if ($send_to_tutor_also) {
  1571. //
  1572. $sql .= " AND tutor_id=1";
  1573. } else {
  1574. $sql .= " AND status=1";
  1575. }
  1576. $result = Database::query($sql);
  1577. while ($row = Database::fetch_array($result)) {
  1578. $tutor = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1579. WHERE user_id='".$row['user_id']."'"));
  1580. $emailto = $tutor['email'];
  1581. $emailsubject = get_lang('NewUserInTheCourse').': '.$name_course;
  1582. $emailbody = get_lang('Dear').': '. api_get_person_name($tutor['firstname'], $tutor['lastname'])."\n";
  1583. $emailbody .= get_lang('MessageNewUserInTheCourse').': '.$name_course."\n";
  1584. $emailbody .= get_lang('UserName').': '.$student['username']."\n";
  1585. if (api_is_western_name_order()) {
  1586. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1587. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1588. } else {
  1589. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1590. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1591. }
  1592. $emailbody .= get_lang('Email').': '.$student['email']."\n\n";
  1593. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1594. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  1595. $email_admin = api_get_setting('emailAdministrator');
  1596. @api_mail($recipient_name, $emailto, $emailsubject, $emailbody, $sender_name,$email_admin);
  1597. }
  1598. }
  1599. public static function get_special_course_list() {
  1600. $tbl_course_field = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD);
  1601. $tbl_course_field_value = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1602. //we filter the courses from the URL
  1603. $join_access_url = $where_access_url='';
  1604. global $_configuration;
  1605. if ($_configuration['multiple_access_urls']) {
  1606. $access_url_id = api_get_current_access_url_id();
  1607. if ($access_url_id != -1) {
  1608. $tbl_url_course = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  1609. $join_access_url= "LEFT JOIN $tbl_url_course url_rel_course ON url_rel_course.course_code= tcfv.course_code ";
  1610. $where_access_url =" AND access_url_id = $access_url_id ";
  1611. }
  1612. }
  1613. // get course list auto-register
  1614. $sql = "SELECT DISTINCT(tcfv.course_code) FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf
  1615. ON tcfv.field_id = tcf.id $join_access_url
  1616. WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 $where_access_url";
  1617. $special_course_result = Database::query($sql);
  1618. $special_course_list = array();
  1619. if (Database::num_rows($special_course_result)>0) {
  1620. $special_course_list = array();
  1621. while ($result_row = Database::fetch_array($special_course_result)) {
  1622. $special_course_list[] = $result_row['course_code'];
  1623. }
  1624. }
  1625. return $special_course_list;
  1626. }
  1627. /**
  1628. * Get list of courses for a given user
  1629. * @param int user ID
  1630. * @param boolean Whether to include courses from session or not
  1631. * @return array List of codes and db names
  1632. * @author isaac flores paz
  1633. */
  1634. public static function get_courses_list_by_user_id($user_id, $include_sessions = false) {
  1635. $user_id = intval($user_id);
  1636. $course_list = array();
  1637. $codes = array();
  1638. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1639. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1640. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  1641. $special_course_list = self::get_special_course_list();
  1642. $with_special_courses = $without_special_courses = '';
  1643. if (!empty($special_course_list)) {
  1644. $with_special_courses = ' course.code IN ("'.implode(',"', $special_course_list).'")';
  1645. $without_special_courses = ' AND course.code NOT IN ("'.implode(',"',$special_course_list).'")';
  1646. }
  1647. if (!empty($with_special_courses)) {
  1648. $sql = "SELECT DISTINCT(course.code), course.db_name db_name, course.title
  1649. FROM ".$tbl_course_user." course_rel_user
  1650. LEFT JOIN ".$tbl_course." course
  1651. ON course.code = course_rel_user.course_code
  1652. LEFT JOIN ".$tbl_user_course_category." user_course_category
  1653. ON course_rel_user.user_course_cat = user_course_category.id
  1654. WHERE $with_special_courses
  1655. GROUP BY course.code
  1656. ORDER BY user_course_category.sort,course.title,course_rel_user.sort ASC";
  1657. $rs_special_course = Database::query($sql);
  1658. if (Database::num_rows($rs_special_course) > 0) {
  1659. while ($result_row = Database::fetch_array($rs_special_course)) {
  1660. $result_row['special_course'] = 1;
  1661. $course_list[] = $result_row;
  1662. $codes[] = $result_row['code'];
  1663. }
  1664. }
  1665. }
  1666. // get course list not auto-register. Use Distinct to avoid multiple
  1667. // entries when a course is assigned to a HRD (DRH) as watcher
  1668. $sql = "SELECT DISTINCT(course.code),course.db_name,course.title
  1669. FROM $tbl_course course
  1670. INNER JOIN $tbl_course_user cru
  1671. ON course.code=cru.course_code
  1672. WHERE cru.user_id='$user_id' $without_special_courses";
  1673. $result = Database::query($sql);
  1674. if (Database::num_rows($result)) {
  1675. while ($row = Database::fetch_array($result, 'ASSOC')) {
  1676. $course_list[] = $row;
  1677. $codes[] = $row['code'];
  1678. }
  1679. }
  1680. if ($include_sessions === true) {
  1681. $r = Database::query("SELECT DISTINCT(c.code),c.db_name,c.title
  1682. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." s, ".Database::get_main_table(TABLE_MAIN_COURSE)." c
  1683. WHERE id_user = $user_id AND s.course_code=c.code");
  1684. while ($row = Database::fetch_array($r, 'ASSOC')) {
  1685. if (!in_array($row['code'], $codes)) {
  1686. $course_list[] = $row;
  1687. }
  1688. }
  1689. }
  1690. return $course_list;
  1691. }
  1692. /**
  1693. * Get course ID from a given course directory name
  1694. * @param string Course directory (without any slash)
  1695. * @return string Course code, or false if not found
  1696. */
  1697. public static function get_course_id_from_path ($path) {
  1698. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  1699. $res = Database::query("SELECT code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1700. WHERE directory LIKE BINARY '$path'");
  1701. if ($res === false) {
  1702. return false;
  1703. }
  1704. if (Database::num_rows($res) != 1) {
  1705. return false;
  1706. }
  1707. $row = Database::fetch_array($res);
  1708. return $row['code'];
  1709. }
  1710. /**
  1711. * Get course code(s) from visual code
  1712. * @param string Visual code
  1713. * @return array List of codes for the given visual code
  1714. */
  1715. public static function get_courses_info_from_visual_code($code) {
  1716. $result = array();
  1717. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1718. WHERE visual_code = '".Database::escape_string($code)."'");
  1719. while ($virtual_course = Database::fetch_array($sql_result)) {
  1720. $result[] = $virtual_course;
  1721. }
  1722. return $result;
  1723. }
  1724. /**
  1725. * Get emails of tutors to course
  1726. * @param string Visual code
  1727. * @return array List of emails of tutors to course
  1728. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1729. * */
  1730. public static function get_emails_of_tutors_to_course($code) {
  1731. $list = array();
  1732. $res = Database::query("SELECT user_id FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1733. WHERE course_code='".Database::escape_string($code)."' AND status=1");
  1734. while ($list_users = Database::fetch_array($res)) {
  1735. $result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1736. WHERE user_id=".$list_users['user_id']);
  1737. while ($row_user = Database::fetch_array($result)){
  1738. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1739. $list[] = array($row_user['email'] => $name_teacher);
  1740. }
  1741. }
  1742. return $list;
  1743. }
  1744. /**
  1745. * Get coachs' emails by session
  1746. * @param int session id
  1747. * @param string course code
  1748. * @return array array(email => name_tutor) by coach
  1749. * @author Carlos Vargas <carlos.vargas@dokeos.com>
  1750. */
  1751. public static function get_email_of_tutor_to_session($session_id,$course_code) {
  1752. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1753. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  1754. $coachs_emails = array();
  1755. $course_code = Database::escape_string($course_code);
  1756. $session_id = intval($session_id);
  1757. $sql = "SELECT id_user FROM $tbl_session_course_user WHERE id_session='$session_id' AND course_code='$course_code' AND status =2";
  1758. $rs = Database::query($sql);
  1759. if (Database::num_rows($rs) > 0) {
  1760. $user_ids = array();
  1761. while ($row = Database::fetch_array($rs)) {
  1762. $user_ids[] = $row['id_user'];
  1763. }
  1764. $sql = "SELECT firstname,lastname,email FROM $tbl_user WHERE user_id IN (".implode(",",$user_ids).")";
  1765. $rs_user = Database::query($sql);
  1766. while ($row_emails = Database::fetch_array($rs_user)) {
  1767. $name_tutor = api_get_person_name($row_emails['firstname'], $row_emails['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1768. $mail_tutor = array($row_emails['email'] => $name_tutor);
  1769. $coachs_emails[] = $mail_tutor;
  1770. }
  1771. }
  1772. return $coachs_emails;
  1773. }
  1774. /**
  1775. * Creates a new extra field for a given course
  1776. * @param string Field's internal variable name
  1777. * @param int Field's type
  1778. * @param string Field's language var name
  1779. * @return int new extra field id
  1780. */
  1781. public static function create_course_extra_field($fieldvarname, $fieldtype, $fieldtitle) {
  1782. // database table definition
  1783. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1784. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1785. $fieldvarname = Database::escape_string($fieldvarname);
  1786. $fieldtitle = Database::escape_string($fieldtitle);
  1787. $fieldtype = (int)$fieldtype;
  1788. $time = time();
  1789. $sql_field = "SELECT id FROM $t_cf WHERE field_variable = '$fieldvarname'";
  1790. $res_field = Database::query($sql_field);
  1791. $r_field = Database::fetch_row($res_field);
  1792. if (Database::num_rows($res_field) > 0) {
  1793. return $r_field[0];
  1794. }
  1795. // save new fieldlabel into course_field table
  1796. $sql = "SELECT MAX(field_order) FROM $t_cf";
  1797. $res = Database::query($sql);
  1798. $order = 0;
  1799. if (Database::num_rows($res) > 0) {
  1800. $row = Database::fetch_row($res);
  1801. $order = $row[0] + 1;
  1802. }
  1803. $sql = "INSERT INTO $t_cf
  1804. SET field_type = '$fieldtype',
  1805. field_variable = '$fieldvarname',
  1806. field_display_text = '$fieldtitle',
  1807. field_order = '$order',
  1808. tms = FROM_UNIXTIME($time)";
  1809. Database::query($sql);
  1810. return Database::insert_id();
  1811. }
  1812. /**
  1813. * Updates course attribute. Note that you need to check that your attribute is valid before you use this function
  1814. *
  1815. * @param int Course id
  1816. * @param string Attribute name
  1817. * @param string Attribute value
  1818. * @return bool True if attribute was successfully updated, false if course was not found or attribute name is invalid
  1819. */
  1820. public static function update_attribute($id, $name, $value) {
  1821. $id = (int)$id;
  1822. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1823. $sql = "UPDATE $table SET $name = '".Database::escape_string($value)."' WHERE id = '$id';";
  1824. return Database::query($sql);
  1825. }
  1826. /**
  1827. * Update course attributes. Will only update attributes with a non-empty value. Note that you NEED to check that your attributes are valid before using this function
  1828. *
  1829. * @param int Course id
  1830. * @param array Associative array with field names as keys and field values as values
  1831. * @return bool True if update was successful, false otherwise
  1832. */
  1833. public static function update_attributes($id, $attributes) {
  1834. $id = (int)$id;
  1835. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1836. $sql = "UPDATE $table SET ";
  1837. $i = 0;
  1838. foreach($attributes as $name => $value) {
  1839. if($value != '') {
  1840. if($i > 0) {
  1841. $sql .= ", ";
  1842. }
  1843. $sql .= " $name = '".Database::escape_string($value)."'";
  1844. $i++;
  1845. }
  1846. }
  1847. $sql .= " WHERE id = '$id';";
  1848. return Database::query($sql);
  1849. }
  1850. /**
  1851. * Update an extra field value for a given course
  1852. * @param integer Course ID
  1853. * @param string Field variable name
  1854. * @param string Field value
  1855. * @return boolean true if field updated, false otherwise
  1856. */
  1857. public static function update_course_extra_field_value($course_code, $fname, $fvalue = '') {
  1858. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1859. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1860. $fname = Database::escape_string($fname);
  1861. $course_code = Database::escape_string($course_code);
  1862. $fvalues = '';
  1863. if (is_array($fvalue)) {
  1864. foreach ($fvalue as $val) {
  1865. $fvalues .= Database::escape_string($val).';';
  1866. }
  1867. if (!empty($fvalues)) {
  1868. $fvalues = substr($fvalues, 0, -1);
  1869. }
  1870. } else {
  1871. $fvalues = Database::escape_string($fvalue);
  1872. }
  1873. $sqlcf = "SELECT * FROM $t_cf WHERE field_variable='$fname'";
  1874. $rescf = Database::query($sqlcf);
  1875. if (Database::num_rows($rescf) == 1) {
  1876. // Ok, the field exists
  1877. // Check if enumerated field, if the option is available
  1878. $rowcf = Database::fetch_array($rescf);
  1879. $tms = time();
  1880. $sqlcfv = "SELECT * FROM $t_cfv WHERE course_code = '$course_code' AND field_id = '".$rowcf['id']."' ORDER BY id";
  1881. $rescfv = Database::query($sqlcfv);
  1882. $n = Database::num_rows($rescfv);
  1883. if ($n > 1) {
  1884. //problem, we already have to values for this field and user combination - keep last one
  1885. while ($rowcfv = Database::fetch_array($rescfv)) { // See the TODO note below.
  1886. if ($n > 1) {
  1887. $sqld = "DELETE FROM $t_cfv WHERE id = ".$rowcfv['id'];
  1888. $resd = Database::query($sqld);
  1889. $n--;
  1890. }
  1891. $rowcfv = Database::fetch_array($rescfv);
  1892. if ($rowcfv['field_value'] != $fvalues) {
  1893. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1894. $resu = Database::query($sqlu);
  1895. return ($resu ? true : false);
  1896. }
  1897. return true; // TODO: Sure exit from the function occures in this "while" cycle. Logic should checked. Maybe "if" instead of "while"? It is not clear...
  1898. }
  1899. } elseif ($n == 1) {
  1900. //we need to update the current record
  1901. $rowcfv = Database::fetch_array($rescfv);
  1902. if ($rowcfv['field_value'] != $fvalues) {
  1903. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1904. //error_log('UM::update_extra_field_value: '.$sqlu);
  1905. $resu = Database::query($sqlu);
  1906. return ($resu ? true : false);
  1907. }
  1908. return true;
  1909. } else {
  1910. $sqli = "INSERT INTO $t_cfv (course_code,field_id,field_value,tms) " .
  1911. "VALUES ('$course_code',".$rowcf['id'].",'$fvalues',FROM_UNIXTIME($tms))";
  1912. //error_log('UM::update_extra_field_value: '.$sqli);
  1913. $resi = Database::query($sqli);
  1914. return ($resi ? true : false);
  1915. }
  1916. } else {
  1917. return false; //field not found
  1918. }
  1919. }
  1920. /**
  1921. * Get the course id of an course by the database name
  1922. * @param string The database name
  1923. * @return string The course id
  1924. */
  1925. public static function get_course_id_by_database_name($db_name) {
  1926. return Database::result(Database::query('SELECT code FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1927. ' WHERE db_name="'.Database::escape_string($db_name).'"'), 0, 'code');
  1928. }
  1929. public static function get_session_category_id_by_session_id($session_id) {
  1930. return Database::result(Database::query('SELECT sc.id session_category
  1931. FROM '.Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY).' sc
  1932. INNER JOIN '.Database::get_main_table(TABLE_MAIN_SESSION).' s
  1933. ON sc.id=s.session_category_id WHERE s.id="'.Database::escape_string($session_id).'"'),
  1934. 0, 'session_category');
  1935. }
  1936. /**
  1937. * Get the course id of an course by the database name
  1938. * @param string The database name
  1939. * @return string The course id
  1940. */
  1941. public static function get_course_extra_field_list($code) {
  1942. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1943. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1944. $sql_field = "SELECT id, field_type, field_variable, field_display_text, field_default_value
  1945. FROM $tbl_course_field WHERE field_visible = '1' ";
  1946. $res_field = Database::query($sql_field);
  1947. $extra_fields = array();
  1948. while($rowcf = Database::fetch_array($res_field)) {
  1949. $extra_field_id = $rowcf['id'];
  1950. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '$extra_field_id' ";
  1951. $res_field_value = Database::query($sql_field_value);
  1952. if(Database::num_rows($res_field_value) > 0 ) {
  1953. $r_field_value = Database::fetch_row($res_field_value);
  1954. $rowcf['extra_field_value'] = $r_field_value[0];
  1955. }
  1956. $extra_fields[] = $rowcf;
  1957. }
  1958. return $extra_fields;
  1959. }
  1960. /**
  1961. * Gets the value of a course extra field. Returns null if it was not found
  1962. *
  1963. * @param string Name of the extra field
  1964. * @param string Course code
  1965. * @return string Value
  1966. */
  1967. public static function get_course_extra_field_value($field_name, $code) {
  1968. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1969. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1970. $sql = "SELECT id FROM $tbl_course_field WHERE field_visible = '1' AND field_variable = '$field_name';";
  1971. $res = Database::query($sql);
  1972. $row = Database::fetch_object($res);
  1973. if(!$row) {
  1974. return null;
  1975. } else {
  1976. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '{$row->id}';";
  1977. $res_field_value = Database::query($sql_field_value);
  1978. $row_field_value = Database::fetch_object($res_field_value);
  1979. if(!$row_field_value) {
  1980. return null;
  1981. } else {
  1982. return $row_field_value['field_value'];
  1983. }
  1984. }
  1985. }
  1986. /**
  1987. * Get the database name of a course by the code
  1988. * @param string The course code
  1989. * @return string The database name
  1990. */
  1991. public static function get_name_database_course($course_code) {
  1992. return Database::result(Database::query('SELECT db_name FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1993. ' WHERE code="'.Database::escape_string($course_code).'"'), 0, 'db_name');
  1994. }
  1995. /**
  1996. * Lists details of the course description
  1997. * @param array The course description
  1998. * @param string The encoding
  1999. * @param bool If true is displayed if false is hidden
  2000. * @return string The course description in html
  2001. */
  2002. public static function get_details_course_description_html($descriptions, $charset, $action_show = true) {
  2003. if (isset($descriptions) && count($descriptions) > 0) {
  2004. $data = '';
  2005. foreach ($descriptions as $id => $description) {
  2006. $data .= '<div class="sectiontitle">';
  2007. if (api_is_allowed_to_edit() && $action_show) {
  2008. //delete
  2009. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;action=delete&amp;description_id='.$description->id.'" onclick="javascript:if(!confirm(\''.addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset)).'\')) return false;">';
  2010. $data .= Display::return_icon('delete.gif', get_lang('Delete'), array('style' => 'vertical-align:middle;float:right;'));
  2011. $data .= '</a> ';
  2012. //edit
  2013. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;description_id='.$description->id.'">';
  2014. $data .= Display::return_icon('edit.png', get_lang('Edit'), array('style' => 'vertical-align:middle;float:right; padding-right:4px;'), 22);
  2015. $data .= '</a> ';
  2016. }
  2017. $data .= $description->title;
  2018. $data .= '</div>';
  2019. $data .= '<div class="sectioncomment">';
  2020. $data .= text_filter($description->content);
  2021. $data .= '</div>';
  2022. }
  2023. } else {
  2024. $data .= '<em>'.get_lang('ThisCourseDescriptionIsEmpty').'</em>';
  2025. }
  2026. return $data;
  2027. }
  2028. /**
  2029. * Returns the details of a course category
  2030. *
  2031. * @param string Category code
  2032. * @return array Course category
  2033. */
  2034. public static function get_course_category($code) {
  2035. $table_categories = Database::get_main_table(TABLE_MAIN_CATEGORY);
  2036. $sql = "SELECT * FROM $table_categories WHERE code = '$code';";
  2037. return Database::fetch_array(Database::query($sql));
  2038. }
  2039. /*
  2040. ==============================================================================
  2041. DEPRECATED METHODS
  2042. ==============================================================================
  2043. */
  2044. /**
  2045. * This code creates a select form element to let the user
  2046. * choose a real course to link to.
  2047. *
  2048. * A good non-display library should not use echo statements, but just return text/html
  2049. * so users of the library can choose when to display.
  2050. *
  2051. * We display the course code, but internally store the course id.
  2052. *
  2053. * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
  2054. * @param boolean $only_current_user_courses, true only the real courses of which the
  2055. * current user is course admin are displayed, false all real courses are shown.
  2056. * @param string $element_name the name of the select element
  2057. * @return a string containing html code for a form select element.
  2058. * @deprecated Function not in use
  2059. */
  2060. public static function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id) {
  2061. if ($only_current_user_courses) {
  2062. $real_course_list = self::get_real_course_list_of_user_as_course_admin($user_id);
  2063. } else {
  2064. $real_course_list = self::get_real_course_list();
  2065. }
  2066. if ($has_size) {
  2067. $size_element = "size=\"".SELECT_BOX_SIZE."\"";
  2068. } else {
  2069. $size_element = "";
  2070. }
  2071. $html_code = "<select name=\"$element_name\" $size_element >\n";
  2072. foreach ($real_course_list as $real_course) {
  2073. $course_code = $real_course["code"];
  2074. $html_code .= "<option value=\"".$course_code."\">";
  2075. $html_code .= $course_code;
  2076. $html_code .= "</option>\n";
  2077. }
  2078. $html_code .= "</select>\n";
  2079. return $html_code;
  2080. }
  2081. /**
  2082. * Get count rows of a table inside a course database
  2083. * @param string The table of which the rows should be counted
  2084. * @param int optionally count rows by session id
  2085. * @return int The number of rows in the given table.
  2086. */
  2087. public static function count_rows_course_table($table, $session_id = '') {
  2088. $condition_session = '';
  2089. if ($session_id !== '') {
  2090. $session_id = intval($session_id);
  2091. $condition_session = " WHERE session_id = '$session_id' ";
  2092. }
  2093. $sql = "SELECT COUNT(*) AS n FROM $table $condition_session ";
  2094. $rs = Database::query($sql);
  2095. $row = Database::fetch_row($rs);
  2096. return $row[0];
  2097. }
  2098. /**
  2099. * Subscribes courses to human resource manager (Dashboard feature)
  2100. * @param int Human Resource Manager id
  2101. * @param array Courses code
  2102. * @param int Relation type
  2103. **/
  2104. public static function suscribe_courses_to_hr_manager($hr_manager_id,$courses_list) {
  2105. global $_configuration;
  2106. // Database Table Definitions
  2107. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2108. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2109. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2110. $hr_manager_id = intval($hr_manager_id);
  2111. $affected_rows = 0;
  2112. //Deleting assigned courses to hrm_id
  2113. if ($_configuration['multiple_access_urls']) {
  2114. $sql = "SELECT s.course_code FROM $tbl_course_rel_user s INNER JOIN $tbl_course_rel_access_url a ON (a.course_code = s.course_code) WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." AND access_url_id = ".api_get_current_access_url_id()."";
  2115. } else {
  2116. $sql = "SELECT course_code FROM $tbl_course_rel_user WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  2117. }
  2118. $result = Database::query($sql);
  2119. if (Database::num_rows($result) > 0) {
  2120. while ($row = Database::fetch_array($result)) {
  2121. $sql = "DELETE FROM $tbl_course_rel_user WHERE course_code = '{$row['course_code']}' AND user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  2122. Database::query($sql);
  2123. }
  2124. }
  2125. // inserting new courses list
  2126. if (is_array($courses_list)) {
  2127. foreach ($courses_list as $course_code) {
  2128. $course_code = Database::escape_string($course_code);
  2129. $insert_sql = "INSERT IGNORE INTO $tbl_course_rel_user(course_code, user_id, status, relation_type) VALUES('$course_code', $hr_manager_id, '".DRH."', '".COURSE_RELATION_TYPE_RRHH."')";
  2130. Database::query($insert_sql);
  2131. if (Database::affected_rows()) {
  2132. $affected_rows++;
  2133. }
  2134. }
  2135. }
  2136. return $affected_rows;
  2137. }
  2138. /**
  2139. * get courses followed by human resources manager
  2140. * @param int human resources manager id
  2141. * @return array courses
  2142. */
  2143. public static function get_courses_followed_by_drh($hr_dept_id) {
  2144. global $_configuration;
  2145. // Database Table Definitions
  2146. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2147. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2148. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2149. $hr_dept_id = intval($hr_dept_id);
  2150. $assigned_courses_to_hrm = array();
  2151. if ($_configuration['multiple_access_urls']) {
  2152. $sql = "SELECT * FROM $tbl_course c
  2153. INNER JOIN $tbl_course_rel_user cru ON (cru.course_code = c.code) LEFT JOIN $tbl_course_rel_access_url a ON (a.course_code = c.code) WHERE cru.user_id = '$hr_dept_id' AND status = ".DRH." AND relation_type = '".COURSE_RELATION_TYPE_RRHH."' AND access_url_id = ".api_get_current_access_url_id()."";
  2154. } else {
  2155. $sql = "SELECT * FROM $tbl_course c
  2156. INNER JOIN $tbl_course_rel_user cru ON cru.course_code = c.code AND cru.user_id = '$hr_dept_id' AND status = ".DRH." AND relation_type = '".COURSE_RELATION_TYPE_RRHH."' ";
  2157. }
  2158. $rs_assigned_courses = Database::query($sql);
  2159. if (Database::num_rows($rs_assigned_courses) > 0) {
  2160. while ($row_assigned_courses = Database::fetch_array($rs_assigned_courses)) {
  2161. $assigned_courses_to_hrm[$row_assigned_courses['code']] = $row_assigned_courses;
  2162. }
  2163. }
  2164. return $assigned_courses_to_hrm;
  2165. }
  2166. /**
  2167. * check if a course is special (autoregister)
  2168. * @param string course code
  2169. */
  2170. public static function is_special_course($course_code){
  2171. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2172. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2173. $is_special = false;
  2174. $sql = "SELECT course_code FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf ON " .
  2175. " tcfv.field_id = tcf.id WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 AND course_code='$course_code'";
  2176. $result = Database::query($sql);
  2177. $num_rows = Database::num_rows($result);
  2178. if ($num_rows > 0){
  2179. $is_special = true;
  2180. }
  2181. return $is_special;
  2182. }
  2183. /**
  2184. * Update course picture
  2185. * @param string Course code
  2186. * @param string File name
  2187. * @param string The full system name of the image from which course picture will be created.
  2188. * @return bool Returns the resulting. In case of internal error or negative validation returns FALSE.
  2189. */
  2190. public static function update_course_picture($course_code, $filename, $source_file = null) {
  2191. $course_info = api_get_course_info($course_code);
  2192. $store_path = api_get_path(SYS_COURSE_PATH).$course_info['path']; // course path
  2193. $course_image = $store_path.'/course-pic.png'; // image name for courses
  2194. $course_medium_image = $store_path.'/course-pic85x85.png';
  2195. $extension = strtolower(substr(strrchr($filename, '.'), 1));
  2196. $result = false;
  2197. $allowed_picture_types = array ('jpg', 'jpeg', 'png', 'gif');
  2198. if (in_array($extension, $allowed_picture_types)) {
  2199. if (file_exists($course_image)) {
  2200. @unlink($course_image);
  2201. }
  2202. if (file_exists($course_medium_image)) {
  2203. @unlink($course_medium_image);
  2204. }
  2205. if ($extension != 'png') {
  2206. // convert image to png extension
  2207. if ($extension == 'jpg' || $extension == 'jpeg') {
  2208. $image = imagecreatefromjpeg($source_file);
  2209. } else {
  2210. $image = imagecreatefromgif($source_file);
  2211. }
  2212. ob_start();
  2213. imagepng($image);
  2214. $imagevariable = ob_get_contents();
  2215. ob_end_clean();
  2216. // save picture
  2217. if (@file_put_contents($course_image, $imagevariable)) {
  2218. $result = true;
  2219. }
  2220. } else {
  2221. $result = @move_uploaded_file($source_file, $course_image);
  2222. }
  2223. }
  2224. // redimension image to 85x85
  2225. if ($result) {
  2226. $max_size_for_picture = 85;
  2227. if (!class_exists('image')) {
  2228. require_once api_get_path(LIBRARY_PATH).'image.lib.php';
  2229. }
  2230. $medium = new image($course_image);
  2231. $picture_infos = api_getimagesize($course_image);
  2232. if ($picture_infos[0] > $max_size_for_picture) {
  2233. $width = 100000;
  2234. $height = $max_size_for_picture;
  2235. $medium->resize($width, $height, 0);
  2236. }
  2237. $rs = $medium->send_image('PNG', $store_path.'/course-pic85x85.png');
  2238. }
  2239. return $result;
  2240. }
  2241. /**
  2242. * @deprecated See CourseManager::course_code_exists()
  2243. */
  2244. public static function is_existing_course_code($wanted_course_code) {
  2245. return self::course_code_exists($wanted_course_code);
  2246. }
  2247. /**
  2248. * Display special courses (and only these) as several HTML divs of class userportal-course-item
  2249. *
  2250. * Special courses are courses that stick on top of the list and are "auto-registerable"
  2251. * in the sense that any user clicking them is registered as a student
  2252. * @param int User id
  2253. * @return void
  2254. */
  2255. function display_special_courses ($user_id) {
  2256. $user_id = intval($user_id);
  2257. $user_info = api_get_user_info($user_id);
  2258. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2259. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2260. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2261. $special_course_list = self::get_special_course_list();
  2262. $with_special_courses = $without_special_courses = '';
  2263. if (!empty($special_course_list)) {
  2264. $with_special_courses = ' course.code IN ("'.implode(',"',$special_course_list).'")';
  2265. }
  2266. if (!empty($with_special_courses)) {
  2267. $sql = "SELECT course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2268. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2269. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course_rel_user.user_id, course.visibility
  2270. FROM $TABLECOURS course
  2271. LEFT JOIN $TABLECOURSUSER course_rel_user ON course.code = course_rel_user.course_code AND course_rel_user.user_id = '$user_id'
  2272. WHERE $with_special_courses group by course.code";
  2273. $rs_special_course = Database::query($sql);
  2274. $number_of_courses = Database::num_rows($rs_special_course);
  2275. $key = 0;
  2276. $status_icon = '';
  2277. if ($number_of_courses > 0) {
  2278. while ($course = Database::fetch_array($rs_special_course)) {
  2279. // Get notifications.
  2280. $my_course = array();
  2281. $my_course['db'] = $course['db_name'];
  2282. $my_course['k'] = $course['code'];
  2283. $my_course['id_session'] = null;
  2284. $my_course['s'] = $course['status'];
  2285. $show_notification = Display::show_notification($my_course);
  2286. if (empty($course['user_id'])) {
  2287. $course['status'] = $user_info['status'];
  2288. }
  2289. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array('width'=>'48px'));
  2290. /*
  2291. if ($course['status'] == 1) {
  2292. $status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style' => 'width: 11px; height: 11px;'));
  2293. }
  2294. if (($course['status'] == 5 && !api_is_coach()) || empty($course['status'])) {
  2295. $status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('students.gif', get_lang('Status').': '.get_lang('Student'), array('style' => 'width: 11px; height: 11px;'));
  2296. }*/
  2297. echo '<div class="userportal-course-item">';
  2298. if (api_is_platform_admin()) {
  2299. echo '<div style="float: right;"><a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'), 22).'</a>';
  2300. if ($course['status'] == COURSEMANAGER) {
  2301. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'),array('style'=>'width:11px; height:11px;'));
  2302. }
  2303. echo '</div>';
  2304. }
  2305. $course_visibility = $course['visibility'];
  2306. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2307. $course_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0&amp;autoreg=1">'.$course['title'].'</a>';
  2308. } else {
  2309. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2310. }
  2311. echo '<div style="float: left; margin-right: 10px;">'.$status_icon.'</div><span class="userportal-course-item-title">'.$course_title.'</span><br />';
  2312. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2313. echo $course['visual_code'];
  2314. }
  2315. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2316. echo ' - ';
  2317. }
  2318. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2319. echo $course['tutor'];
  2320. }
  2321. echo '&nbsp;';
  2322. echo Display::return_icon('klipper.png', get_lang('CourseAutoRegister'));
  2323. // Show notifications.
  2324. echo $show_notification;
  2325. echo '</div>';
  2326. $key++;
  2327. }
  2328. }
  2329. }
  2330. }
  2331. /**
  2332. * Display courses (without special courses) as several HTML divs
  2333. * of course categories, as class userportal-catalog-item.
  2334. * @uses display_courses_in_category() to display the courses themselves
  2335. * @param int user id
  2336. * @return void
  2337. */
  2338. function display_courses($user_id) {
  2339. global $_user, $_configuration;
  2340. // Building an array that contains all the id's of the user defined course categories.
  2341. // Initially this was inside the display_courses_in_category function but when we do it here we have fewer
  2342. // sql executions = performance increase.
  2343. $all_user_categories = self :: get_user_course_categories();
  2344. // Step 0: We display the course without a user category.
  2345. self :: display_courses_in_category(0, 'true');
  2346. // Step 1: We get all the categories of the user.
  2347. $tucc = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2348. $sql = "SELECT id, title FROM $tucc WHERE user_id='".$_user['user_id']."' ORDER BY sort ASC";
  2349. $result = Database::query($sql);
  2350. while ($row = Database::fetch_array($result)) {
  2351. // We simply display the title of the category.
  2352. echo '<div class="userportal-catalog-item">';
  2353. echo '<ul class="catalog_box">';
  2354. echo '<li>';
  2355. echo Display::return_icon('folder_yellow.png', get_lang('Category'), array('width' => '48px', 'align' => 'absmiddle'));
  2356. echo '<span>';
  2357. echo '<a name="category'.$row['id'].'"></a>'; // Display an internal anchor.
  2358. echo $row['title'];
  2359. echo '</span>';
  2360. echo '</li>';
  2361. self :: display_courses_in_category($row['id']);
  2362. echo '</ul>';
  2363. echo '</div>';
  2364. }
  2365. }
  2366. /**
  2367. * Display courses inside a category (without special courses) as HTML dics of
  2368. * class userportal-course-item.
  2369. * @param int User category id
  2370. * @return void
  2371. */
  2372. function display_courses_in_category($user_category_id) {
  2373. global $_user, $_configuration;
  2374. // Table definitions
  2375. $TABLECOURS = Database :: get_main_table(TABLE_MAIN_COURSE);
  2376. $TABLECOURSUSER = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
  2377. $TABLE_ACCESS_URL_REL_COURSE = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2378. $TABLE_USER_COURSE_CATEGORY = Database :: get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2379. $current_url_id = api_get_current_access_url_id();
  2380. // Get course list auto-register
  2381. $special_course_list = self::get_special_course_list();
  2382. $without_special_courses = '';
  2383. if (!empty($special_course_list)) {
  2384. $without_special_courses = ' AND course.code NOT IN ("'.implode(',"',$special_course_list).'")';
  2385. }
  2386. $sql_select_courses = "SELECT course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2387. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2388. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course.visibility
  2389. FROM $TABLECOURS course,
  2390. $TABLECOURSUSER course_rel_user, ".$TABLE_ACCESS_URL_REL_COURSE." url
  2391. WHERE course.code = course_rel_user.course_code AND url.course_code = course.code
  2392. AND course_rel_user.user_id = '".$_user['user_id']."'
  2393. AND course_rel_user.relation_type<>".COURSE_RELATION_TYPE_RRHH."
  2394. AND course_rel_user.user_course_cat='".$user_category_id."' $without_special_courses ";
  2395. // If multiple URL access mode is enabled, only fetch courses
  2396. // corresponding to the current URL.
  2397. if ($_configuration['multiple_access_urls'] && $current_url_id != -1){
  2398. $sql_select_courses .= " AND url.course_code=course.code AND access_url_id='".$current_url_id."'";
  2399. }
  2400. // Use user's classification for courses (if any).
  2401. $sql_select_courses .= " ORDER BY course_rel_user.user_course_cat, course_rel_user.sort ASC";
  2402. $result = Database::query($sql_select_courses);
  2403. $number_of_courses = Database::num_rows($result);
  2404. $key = 0;
  2405. $status_icon = '';
  2406. // Browse through all courses.
  2407. while ($course = Database::fetch_array($result)) {
  2408. // Get notifications.
  2409. $my_course = array();
  2410. $my_course['db'] = $course['db_name'];
  2411. $my_course['k'] = $course['code'];
  2412. $my_course['id_session'] = null;
  2413. $my_course['s'] = $course['status'];
  2414. // For each course, get if there is any notification icon to show
  2415. // (something that would have changed since the user's last visit).
  2416. $show_notification = Display :: show_notification($my_course);
  2417. // New code displaying the user's status in respect to this course.
  2418. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array('width' => '48px'));
  2419. echo '<div class="userportal-course-item">';
  2420. if (api_is_platform_admin()) {
  2421. echo '<div style="float:right;"><a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),22).'</a>';
  2422. if ($course['status'] == COURSEMANAGER) {
  2423. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  2424. }
  2425. echo '</div>';
  2426. }
  2427. // Function logic - act on the data (check if the course is virtual, if yes change the link).
  2428. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($course['code']);
  2429. if ($is_virtual_course) {
  2430. // If the current user is also subscribed in the real course to which this
  2431. // virtual course is linked, we don't need to display the virtual course entry in
  2432. // the course list - it is combined with the real course entry.
  2433. $target_course_code = CourseManager :: get_target_of_linked_course($course['code']);
  2434. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2435. if ($is_subscribed_in_target_course) {
  2436. return; // Do not display this course entry.
  2437. }
  2438. }
  2439. // Check if the course has virtual courses attached. If yes change the course title and display code.
  2440. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course['code'], api_get_user_id());
  2441. if ($has_virtual_courses) {
  2442. $course_info = api_get_course_info($course['code']);
  2443. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2444. $course_title = $return_result['title'];
  2445. $course_display_code = $return_result['code'];
  2446. } else {
  2447. $course_title = $course['title'];
  2448. $course_display_code = $course['visual_code'];
  2449. }
  2450. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2451. $course_visibility = $course['visibility'];
  2452. $course_title_url = '';
  2453. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2454. $course_title_url = api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0';
  2455. $course_title = Display::url($course['title'], $course_title_url);
  2456. } else {
  2457. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2458. }
  2459. if (!empty($course_title_url)) {
  2460. $status_icon = Display::url($status_icon, $course_title_url);
  2461. }
  2462. // Start displaying the course block itself.
  2463. echo '<div style="float: left; margin-right: 10px;">'.$status_icon.'</div><span class="userportal-course-item-title">'.$course_title.'</span><br />';
  2464. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2465. echo $course_display_code;
  2466. }
  2467. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2468. echo ' - ';
  2469. }
  2470. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2471. if (!empty($course['tutor']))
  2472. echo $course['tutor'];
  2473. }
  2474. // Show notifications.
  2475. echo $show_notification;
  2476. echo '</div>';
  2477. $key++;
  2478. }
  2479. }
  2480. /**
  2481. * Retrieves the user defined course categories
  2482. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  2483. * @return array containing all the titles of the user defined courses with the id as key of the array
  2484. */
  2485. function get_user_course_categories() {
  2486. global $_user;
  2487. $output = array();
  2488. $table_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2489. $sql = "SELECT * FROM ".$table_category." WHERE user_id='".Database::escape_string($_user['user_id'])."'";
  2490. $result = Database::query($sql);
  2491. while ($row = Database::fetch_array($result)) {
  2492. $output[$row['id']] = $row['title'];
  2493. }
  2494. return $output;
  2495. }
  2496. /**
  2497. * Get the course id based on the original id and field name in the extra fields. Returns 0 if course was not found
  2498. *
  2499. * @param string Original course id
  2500. * @param string Original field name
  2501. * @return int Course id
  2502. */
  2503. public static function get_course_id_from_original_id($original_course_id_value, $original_course_id_name) {
  2504. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2505. $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2506. $sql_course = "SELECT id FROM $table_field cf INNER JOIN $t_cfv cfv ON cfv.field_id=cf.id WHERE field_variable='$original_course_id_name' AND field_value='$original_course_id_value'";
  2507. $res = Database::query($sql_course);
  2508. $row = Database::fetch_object($res);
  2509. if($row != false) {
  2510. return $row->id;
  2511. } else {
  2512. return 0;
  2513. }
  2514. }
  2515. /**
  2516. * Display code for one specific course a logged in user is subscribed to.
  2517. * Shows a link to the course, what's new icons...
  2518. *
  2519. * $my_course['d'] - course directory
  2520. * $my_course['i'] - course title
  2521. * $my_course['c'] - visual course code
  2522. * $my_course['k'] - system course code
  2523. * $my_course['db'] - course database
  2524. *
  2525. * @param array Course details
  2526. * @param integer Session ID
  2527. * @param string CSS class to apply to course entry
  2528. * @param boolean Whether the session is supposedly accessible now (not in the case it has passed and is in invisible/unaccessible mode)
  2529. * @return string The HTML to be printed for the course entry
  2530. *
  2531. * @version 1.0.3
  2532. * @todo refactor into different functions for database calls | logic | display
  2533. * @todo replace single-character $my_course['d'] indices
  2534. * @todo move code for what's new icons to a separate function to clear things up
  2535. * @todo add a parameter user_id so that it is possible to show the courselist of other users (=generalisation). This will prevent having to write a new function for this.
  2536. */
  2537. function get_logged_user_course_html($course, $session_id = 0, $class = 'courses', $session_accessible = true) {
  2538. global $nosession, $nbDigestEntries, $digest, $thisCourseSysCode, $orderKey;
  2539. $charset = api_get_system_encoding();
  2540. $current_uid = api_get_user_id();
  2541. $info = api_get_course_info($course['code']);
  2542. $status_course = CourseManager::get_user_in_course_status($current_uid, $course['code']);
  2543. if (!is_array($course['code'])) {
  2544. $my_course = api_get_course_info($course['code']);
  2545. $my_course['k'] = $my_course['id'];
  2546. $my_course['db'] = $my_course['dbName'];
  2547. $my_course['c'] = $my_course['official_code'];
  2548. $my_course['i'] = $my_course['name'];
  2549. $my_course['d'] = $my_course['path'];
  2550. $my_course['t'] = $my_course['titular'];
  2551. $my_course['id_session'] = $session_id;
  2552. $my_course['status'] = empty($session_id) ? $status_course : 5;
  2553. }
  2554. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2555. global $now, $date_start, $date_end;
  2556. }
  2557. // Initialise.
  2558. $result = '';
  2559. // Table definitions
  2560. //$statistic_database = Database::get_statistic_database();
  2561. $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
  2562. $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
  2563. $tbl_session_category = Database :: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  2564. $course_database = $my_course['db'];
  2565. $course_tool_table = Database :: get_course_table(TABLE_TOOL_LIST, $course_database);
  2566. $tool_edit_table = Database :: get_course_table(TABLE_ITEM_PROPERTY, $course_database);
  2567. $course_group_user_table = Database :: get_course_table(TOOL_USER, $course_database);
  2568. $user_id = api_get_user_id();
  2569. $course_system_code = $my_course['k'];
  2570. $course_visual_code = $my_course['c'];
  2571. $course_title = $my_course['i'];
  2572. $course_directory = $my_course['d'];
  2573. $course_teacher = $my_course['t'];
  2574. $course_teacher_email = isset($my_course['email']) ? $my_course['email'] : '';
  2575. $course_info = Database :: get_course_info($course_system_code);
  2576. $course_access_settings = CourseManager :: get_access_settings($course_system_code);
  2577. $course_id = isset($course_info['course_id']) ? $course_info['course_id'] : null;
  2578. $course_visibility = $course_access_settings['visibility'];
  2579. $user_in_course_status = CourseManager :: get_user_in_course_status(api_get_user_id(), $course_system_code);
  2580. // Function logic - act on the data.
  2581. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($my_course['k']);
  2582. if ($is_virtual_course) {
  2583. // If the current user is also subscribed in the real course to which this
  2584. // virtual course is linked, we don't need to display the virtual course entry in
  2585. // the course list - it is combined with the real course entry.
  2586. $target_course_code = CourseManager :: get_target_of_linked_course($course_system_code);
  2587. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2588. if ($is_subscribed_in_target_course) {
  2589. return; //do not display this course entry
  2590. }
  2591. }
  2592. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course_system_code, api_get_user_id());
  2593. if ($has_virtual_courses) {
  2594. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2595. $course_display_title = $return_result['title'];
  2596. $course_display_code = $return_result['code'];
  2597. } else {
  2598. $course_display_title = $course_title;
  2599. $course_display_code = $course_visual_code;
  2600. }
  2601. $s_course_status = $my_course['status'];
  2602. $is_coach = api_is_coach($my_course['id_session'],$course['code']);
  2603. $s_htlm_status_icon = Display::return_icon('blackboard_blue.png', get_lang('Course'), array('width' => '48px'));
  2604. /*
  2605. if ($s_course_status == 1) {
  2606. $s_htlm_status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style' => 'width: 11px; height: 11px;'));
  2607. }
  2608. if ($s_course_status == 2 || ($is_coach && $s_course_status != 1)) {
  2609. $s_htlm_status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('coachs.gif', get_lang('Status').': '.get_lang('GeneralCoach'), array('style' => 'width: 11px; height: 11px;'));
  2610. }
  2611. if (($s_course_status == 5 && !$is_coach) || empty($s_course_status)) {
  2612. $s_htlm_status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('students.gif', get_lang('Status').': '.get_lang('Student'), array('style' => 'width: 11px; height: 11px;'));
  2613. }
  2614. */
  2615. // Display course entry.
  2616. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2617. $session_url = '';
  2618. $session_title = '';
  2619. if ($session_accessible) {
  2620. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $user_in_course_status == COURSEMANAGER) {
  2621. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2622. if (empty($my_course['id_session'])) {
  2623. $my_course['id_session'] = 0;
  2624. }
  2625. if ($user_in_course_status == COURSEMANAGER || ($date_start <= $now && $date_end >= $now) || $date_start == '0000-00-00') {
  2626. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'];
  2627. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'].'">'.$course_display_title.'</a>';
  2628. }
  2629. } else {
  2630. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/';
  2631. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/">'.$course_display_title.'</a>';
  2632. }
  2633. } else {
  2634. $session_title = $course_display_title.' '.Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2635. }
  2636. } else {
  2637. $session_title = $course_display_title;
  2638. }
  2639. if (!empty($session_url)) {
  2640. $s_htlm_status_icon = Display::url($s_htlm_status_icon, $session_url);
  2641. }
  2642. $result .= '<li class="'.$class.'"><div class="coursestatusicons">'.$s_htlm_status_icon.'</div>';
  2643. $result .= $session_title;
  2644. // Show the course_code and teacher if chosen to display this.
  2645. if (api_get_setting('display_coursecode_in_courselist') == 'true' || api_get_setting('display_teacher_in_courselist') == 'true') {
  2646. $result .= '<br />';
  2647. }
  2648. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2649. $result .= $course_display_code;
  2650. }
  2651. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2652. if (api_get_setting('use_session_mode')=='true' && !$nosession) {
  2653. $coachs_course = api_get_coachs_from_course($my_course['id_session'], $course['code']);
  2654. $course_coachs = array();
  2655. if (is_array($coachs_course)) {
  2656. foreach ($coachs_course as $coach_course) {
  2657. $course_coachs[] = api_get_person_name($coach_course['firstname'], $coach_course['lastname']);
  2658. }
  2659. }
  2660. if ($s_course_status == 1 || ($s_course_status == 5 && empty($my_course['id_session'])) || empty($s_course_status)) {
  2661. $result .= $course_teacher;
  2662. }
  2663. if (($s_course_status == 5 && !empty($my_course['id_session'])) || ($is_coach && $s_course_status != 1)) {
  2664. if (is_array($course_coachs) && count($course_coachs)> 0 ) {
  2665. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2666. $result .= ' &ndash; ';
  2667. }
  2668. $result .= get_lang('Coachs').': '.implode(', ',$course_coachs);
  2669. }
  2670. }
  2671. } else {
  2672. $result .= $course_teacher;
  2673. }
  2674. if(!empty($course_teacher_email)) {
  2675. $result .= ' ('.$course_teacher_email.')';
  2676. }
  2677. }
  2678. $result .= isset($course['special_course']) ? ' '.Display::return_icon('klipper.png', get_lang('CourseAutoRegister')) : '';
  2679. $current_course_settings = CourseManager :: get_access_settings($my_course['k']);
  2680. // Display the "what's new" icons.
  2681. $result .= Display :: show_notification($my_course);
  2682. if ((CONFVAL_showExtractInfo == SCRIPTVAL_InCourseList || CONFVAL_showExtractInfo == SCRIPTVAL_Both) && $nbDigestEntries > 0) {
  2683. reset($digest);
  2684. $result .= '
  2685. <ul>';
  2686. while (list($key2) = each($digest[$thisCourseSysCode])) {
  2687. $result .= '<li>';
  2688. if ($orderKey[1] == 'keyTools') {
  2689. $result .= "<a href=\"$toolsList[$key2] [\"path\"] $thisCourseSysCode \">";
  2690. $result .= "$toolsList[$key2][\"name\"]</a>";
  2691. } else {
  2692. $result .= api_convert_and_format_date($key2, DATE_FORMAT_LONG, date_default_timezone_get());
  2693. }
  2694. $result .= '</li>';
  2695. $result .= '<ul>';
  2696. reset ($digest[$thisCourseSysCode][$key2]);
  2697. while (list ($key3, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2])) {
  2698. $result .= '<li>';
  2699. if ($orderKey[2] == 'keyTools') {
  2700. $result .= "<a href=\"$toolsList[$key3] [\"path\"] $thisCourseSysCode \">";
  2701. $result .= "$toolsList[$key3][\"name\"]</a>";
  2702. } else {
  2703. $result .= api_convert_and_format_date($key3, DATE_FORMAT_LONG, date_default_timezone_get());
  2704. }
  2705. $result .= '<ul compact="compact">';
  2706. reset($digest[$thisCourseSysCode][$key2][$key3]);
  2707. while (list ($key4, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2][$key3])) {
  2708. $result .= '<li>';
  2709. $result .= @htmlspecialchars(api_substr(strip_tags($dataFromCourse), 0, CONFVAL_NB_CHAR_FROM_CONTENT), ENT_QUOTES, $charset);
  2710. $result .= '</li>';
  2711. }
  2712. $result .= '</ul>';
  2713. $result .= '</li>';
  2714. }
  2715. $result .= '</ul>';
  2716. $result .= '</li>';
  2717. }
  2718. $result .= '</ul>';
  2719. }
  2720. $result .= '</li>';
  2721. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2722. $session = '';
  2723. $active = false;
  2724. if (!empty($my_course['session_name'])) {
  2725. // Request for the name of the general coach
  2726. $sql = 'SELECT lastname, firstname,sc.name
  2727. FROM '.$tbl_session.' ts
  2728. LEFT JOIN '.$main_user_table .' tu
  2729. ON ts.id_coach = tu.user_id
  2730. INNER JOIN '.$tbl_session_category.' sc ON ts.session_category_id = sc.id
  2731. WHERE ts.id='.(int) $my_course['id_session']. ' LIMIT 1';
  2732. $rs = Database::query($sql);
  2733. $sessioncoach = Database::store_result($rs);
  2734. $sessioncoach = $sessioncoach[0];
  2735. $session = array();
  2736. $session['title'] = $my_course['session_name'];
  2737. $session_category_id = CourseManager::get_session_category_id_by_session_id($my_course['id_session']);
  2738. $session['category'] = $sessioncoach['name'];
  2739. if ($my_course['date_start'] == '0000-00-00') {
  2740. //$session['dates'] = get_lang('WithoutTimeLimits');
  2741. $session['dates'] = '';
  2742. if (api_get_setting('show_session_coach') === 'true') {
  2743. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2744. }
  2745. $active = true;
  2746. } else {
  2747. $session ['dates'] = ' - '.get_lang('From').' '.$my_course['date_start'].' '.get_lang('To').' '.$my_course['date_end'];
  2748. if (api_get_setting('show_session_coach') === 'true') {
  2749. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2750. }
  2751. $active = ($date_start <= $now && $date_end >= $now);
  2752. }
  2753. }
  2754. $output = array ($my_course['user_course_cat'], $result, $my_course['id_session'], $session, 'active' => $active, 'session_category_id' => $session_category_id);
  2755. } else {
  2756. $output = array ($my_course['user_course_cat'], $result);
  2757. }
  2758. return $output;
  2759. }
  2760. /**
  2761. *
  2762. * @param string source course code
  2763. * @param int source session id
  2764. * @param string destination course code
  2765. * @param int destination session id
  2766. * @return bool
  2767. */
  2768. function copy_course($source_course_code, $source_session_id, $destination_course_code, $destination_session_id) {
  2769. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseBuilder.class.php';
  2770. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseRestorer.class.php';
  2771. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseSelectForm.class.php';
  2772. $course_info = api_get_course_info($source_course_code);
  2773. if (!empty($course_info)) {
  2774. $cb = new CourseBuilder('', $course_info);
  2775. $course = $cb->build($source_session_id, $source_course_code, true);
  2776. $course_restorer = new CourseRestorer($course);
  2777. $course_restorer->restore($destination_course_code, $destination_session_id, true, true);
  2778. return true;
  2779. }
  2780. return false;
  2781. }
  2782. /**
  2783. * A simpler version of the copy_course, the function creates an empty course
  2784. *
  2785. * @param string course title
  2786. * @param string source course code
  2787. * @param int source session id
  2788. * @return
  2789. */
  2790. function copy_course_simple($new_title, $source_course_code, $source_session_id = 0, $destination_session_id = 0) {
  2791. $source_course_info = api_get_course_info($source_course_code);
  2792. if (!empty($source_course_info)) {
  2793. $new_course_code = self::generate_nice_next_course_code($source_course_code);
  2794. if ($new_course_code) {
  2795. $new_course_info = self::create_course($new_title, $new_course_code, false);
  2796. if (!empty($new_course_info['code'])) {
  2797. $result = self::copy_course($source_course_code, $source_session_id, $new_course_info['code'], $destination_session_id);
  2798. if ($result) {
  2799. return $new_course_info;
  2800. }
  2801. }
  2802. }
  2803. }
  2804. return false;
  2805. }
  2806. /**
  2807. * Creates a new course code based in given code
  2808. *
  2809. * @param string wanted code
  2810. * @example $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3
  2811. * if the course code doest not exist in the DB the same course code will be returned
  2812. * @return string wanted unused code
  2813. */
  2814. function generate_nice_next_course_code($wanted_code) {
  2815. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2816. $course_code_ok = !self::course_code_exists($wanted_code);
  2817. if (!$course_code_ok) {
  2818. $wanted_code = generate_course_code($wanted_code);
  2819. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  2820. $wanted_code = Database::escape_string($wanted_code);
  2821. $sql = "SELECT count(*) as count FROM $table WHERE code LIKE '$wanted_code%'";
  2822. $result = Database::query($sql);
  2823. if (Database::num_rows($result) > 0 ) {
  2824. $row = Database::fetch_array($result);
  2825. $count = $row['count'] + 1;
  2826. $wanted_code = $wanted_code.'_'.$count;
  2827. $result = api_get_course_info($wanted_code);
  2828. if (empty($result)) {
  2829. return $wanted_code;
  2830. }
  2831. }
  2832. return false;
  2833. }
  2834. return $wanted_code;
  2835. }
  2836. /**
  2837. * Creates a course very fast (the function doesn't need a lot of parameters)
  2838. *
  2839. * @param string course title
  2840. * @param bool add example content or not
  2841. * @param mixed false if the course was not created, array with the course info
  2842. *
  2843. Coded found in create_course/add_course.php
  2844. */
  2845. function create_course($title, $wanted_code = '', $exemplary_content = false) {
  2846. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2847. global $_configuration, $firstExpirationDelay;
  2848. if (empty($title)) {
  2849. return false;
  2850. }
  2851. if (empty($wanted_code)) {
  2852. $wanted_code = $title;
  2853. // Check whether the requested course code has already been occupied.
  2854. $dbnamelength = strlen($_configuration['db_prefix']);
  2855. // Ensure the database prefix + database name do not get over 40 characters.
  2856. $maxlength = 40 - $dbnamelength;
  2857. $wanted_code = generate_course_code(api_substr($title, 0, $maxlength));
  2858. }
  2859. // Create the course immediately
  2860. $keys = define_course_keys($wanted_code, '', $_configuration['db_prefix']);
  2861. if (count($keys)) {
  2862. $visual_code = $keys['currentCourseCode'];
  2863. $code = $keys['currentCourseId'];
  2864. $db_name = $keys['currentCourseDbName'];
  2865. $directory = $keys['currentCourseRepository'];
  2866. $code_info = api_get_course_info($code);
  2867. if (empty($code_info)) {
  2868. $expiration_date = time() + $firstExpirationDelay;
  2869. prepare_course_repository($directory, $code);
  2870. update_Db_course($db_name);
  2871. $pictures_array = fill_course_repository($directory, $exemplary_content);
  2872. fill_Db_course($db_name, $directory, $course_language, $pictures_array, $exemplary_content);
  2873. $course_language = api_get_setting('platformLanguage');
  2874. $result = register_course($code, $visual_code, $directory, $db_name, '', '', $title, $course_language, api_get_user_id(), $expiration_date);
  2875. $course_info = api_get_course_info($code);
  2876. if (!empty($course_info)) {
  2877. return $course_info;
  2878. }
  2879. }
  2880. }
  2881. return false;
  2882. }
  2883. } //end class CourseManager