course.lib.php 153 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273
  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. $rs = Database::query($sql);
  892. $users = array();
  893. if (Database::num_rows($rs)) {
  894. while ($user = Database::fetch_array($rs)) {
  895. //$user_info = Database::get_user_info_from_id($user['user_id']);
  896. $user_info = $user;
  897. $user_info['status'] = $user['status'];
  898. if (isset($user['role'])) {
  899. $user_info['role'] = $user['role'];
  900. }
  901. if (isset($user['tutor_id'])) {
  902. $user_info['tutor_id'] = $user['tutor_id'];
  903. }
  904. if (!empty($session_id)) {
  905. $user_info['status_session'] = $user['status_session'];
  906. }
  907. $users[$user['user_id']] = $user_info;
  908. }
  909. }
  910. return $users;
  911. }
  912. /**
  913. * Gets subscribed users in a course or in a course/session
  914. *
  915. * @param string $course_code
  916. * @param int $session_id
  917. * @return int
  918. */
  919. public static function get_users_count_in_course($course_code, $session_id = 0) {
  920. global $_configuration;
  921. // variable initialisation
  922. $session_id = intval($session_id);
  923. $course_code = Database::escape_string($course_code);
  924. $sql .= 'SELECT DISTINCT count(*) as count FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  925. $where = array();
  926. if (!empty($session_id)) {
  927. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  928. ON user.user_id = session_course_user.id_user
  929. AND session_course_user.course_code = "'.$course_code.'"
  930. AND session_course_user.id_session = '.$session_id;
  931. $where[] = ' session_course_user.course_code IS NOT NULL ';
  932. } else {
  933. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  934. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  935. AND course_rel_user.course_code="'.$course_code.'"';
  936. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  937. }
  938. if ($_configuration['multiple_access_urls']) {
  939. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  940. }
  941. $sql .= ' WHERE '.implode(' OR ', $where);
  942. if ($_configuration['multiple_access_urls']) {
  943. $current_access_url_id = api_get_current_access_url_id();
  944. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  945. }
  946. $rs = Database::query($sql);
  947. $users = array();
  948. $count = 0;
  949. if (Database::num_rows($rs)) {
  950. $user = Database::fetch_array($rs);
  951. $count = $user['count'];
  952. }
  953. return $count;
  954. }
  955. /**
  956. * Get a list of coaches of a course and a session
  957. * @param string Course code
  958. * @param int Session ID
  959. * @return array List of users
  960. */
  961. public static function get_coach_list_from_course_code($course_code, $session_id) {
  962. if ($session_id != strval(intval($session_id))) {
  963. return array();
  964. }
  965. $course_code = Database::escape_string($course_code);
  966. $users = array();
  967. // We get the coach for the given course in a given session.
  968. $rs = Database::query('SELECT id_user FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  969. ' WHERE id_session="'.$session_id.'" AND course_code="'.$course_code.'" AND status = 2');
  970. while ($user = Database::fetch_array($rs)) {
  971. $user_info = Database::get_user_info_from_id($user['id_user']);
  972. $user_info['status'] = $user['status'];
  973. $user_info['role'] = $user['role'];
  974. $user_info['tutor_id'] = $user['tutor_id'];
  975. $user_info['email'] = $user['email'];
  976. $users[$user['id_user']] = $user_info;
  977. }
  978. // We get the session coach.
  979. $rs = Database::query('SELECT id_coach FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  980. ' WHERE id="'.$session_id.'"');
  981. $user_info = array();
  982. $session_id_coach = Database::result($rs, 0, 'id_coach');
  983. $user_info = Database::get_user_info_from_id($session_id_coach);
  984. $user_info['status'] = $user['status'];
  985. $user_info['role'] = $user['role'];
  986. $user_info['tutor_id'] = $user['tutor_id'];
  987. $user_info['email'] = $user['email'];
  988. $users[$session_id_coach] = $user_info;
  989. return $users;
  990. }
  991. /**
  992. * Return user info array of all users registered in the specified real or virtual course
  993. * This only returns the users that are registered in this actual course, not linked courses.
  994. *
  995. * @param string $course_code
  996. * @param boolean $full list to true if we want sessions students too
  997. * @return array with user id
  998. */
  999. public static function get_student_list_from_course_code($course_code, $with_session = false, $session_id = 0) {
  1000. $session_id = intval($session_id);
  1001. $course_code = Database::escape_string($course_code);
  1002. $students = array();
  1003. if ($session_id == 0) {
  1004. // students directly subscribed to the course
  1005. $rs = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1006. WHERE course_code = '$course_code' AND status = 5");
  1007. while ($student = Database::fetch_array($rs)) {
  1008. $students[$student['user_id']] = $student;
  1009. }
  1010. }
  1011. // students subscribed to the course through a session
  1012. if (api_get_setting('use_session_mode') == 'true' && $with_session) {
  1013. $sql_query = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE course_code = '$course_code' AND status<>2";
  1014. if ($session_id != 0) {
  1015. $sql_query .= ' AND id_session = '.$session_id;
  1016. }
  1017. $rs = Database::query($sql_query);
  1018. while($student = Database::fetch_array($rs)) {
  1019. $students[$student['id_user']] = $student;
  1020. }
  1021. }
  1022. return $students;
  1023. }
  1024. /**
  1025. * Return user info array of all teacher-users registered in the specified real or virtual course
  1026. * This only returns the users that are registered in this actual course, not linked courses.
  1027. *
  1028. * @param string $course_code
  1029. * @return array with user id
  1030. */
  1031. public static function get_teacher_list_from_course_code($course_code) {
  1032. $course_code = Database::escape_string($course_code);
  1033. // teachers directly subscribed to the course
  1034. $teachers = array();
  1035. // TODO: This query is not optimal.
  1036. $rs = Database::query("SELECT u.user_id, u.lastname, u.firstname, u.email, u.username, u.status " .
  1037. "FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." cu, ".Database::get_main_table(TABLE_MAIN_USER)." u ".
  1038. "WHERE cu.course_code = '$course_code' " .
  1039. "AND cu.status = 1 " .
  1040. "AND cu.user_id = u.user_id");
  1041. while ($teacher = Database::fetch_array($rs)) {
  1042. $teachers[$teacher['user_id']] = $teacher;
  1043. }
  1044. return $teachers;
  1045. }
  1046. /**
  1047. * Return user info array of all users registered in the specified course
  1048. * this includes the users of the course itsel and the users of all linked courses.
  1049. *
  1050. * @param array $course_info
  1051. * @return array with user info
  1052. */
  1053. public static function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id = 0) {
  1054. //get list of virtual courses
  1055. $virtual_course_list = self::get_virtual_courses_linked_to_real_course($course_code);
  1056. //get users from real course
  1057. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  1058. foreach ($user_list as $this_user) {
  1059. $complete_user_list[] = $this_user;
  1060. }
  1061. //get users from linked courses
  1062. foreach ($virtual_course_list as $this_course) {
  1063. $course_code = $this_course['code'];
  1064. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  1065. foreach ($user_list as $this_user) {
  1066. $complete_user_list[] = $this_user;
  1067. }
  1068. }
  1069. return $complete_user_list;
  1070. }
  1071. /**
  1072. * Return an array of arrays, listing course info of all courses in the list
  1073. * linked to the real course $real_course_code, to which the user $user_id is subscribed.
  1074. *
  1075. * @param $user_id, the id (int) of the user
  1076. * @param $real_course_code, the id (char) of the real course
  1077. *
  1078. * @return array of course info arrays
  1079. */
  1080. public static function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code) {
  1081. $result_array = array();
  1082. if ($user_id != strval(intval($user_id))) {
  1083. return $result_array;
  1084. }
  1085. $course_code = Database::escape_string($course_code);
  1086. $sql = "SELECT *
  1087. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  1088. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  1089. ON course.code = course_user.course_code
  1090. WHERE course.target_course_code = '$real_course_code' AND course_user.user_id = '$user_id' AND course_user.relation_type<>".COURSE_RELATION_TYPE_RRHH." ";
  1091. $sql_result = Database::query($sql);
  1092. while ($result = Database::fetch_array($sql_result)) {
  1093. $result_array[] = $result;
  1094. }
  1095. return $result_array;
  1096. }
  1097. /*
  1098. ==============================================================================
  1099. GROUP FUNCTIONS
  1100. ==============================================================================
  1101. */
  1102. /**
  1103. * Get the list of groups from the course
  1104. * @param string Course code
  1105. * @param int Session ID (optional)
  1106. * @return array List of groups info
  1107. */
  1108. public static function get_group_list_of_course($course_code, $session_id = 0) {
  1109. $course_info = Database::get_course_info($course_code);
  1110. $database_name = $course_info['db_name'];
  1111. $group_list = array();
  1112. $session_id != 0 ? $session_condition = ' WHERE g.session_id IN(1,'.intval($session_id).')' : $session_condition = ' WHERE g.session_id = 0';
  1113. $sql="SELECT g.id, g.name, COUNT(gu.id) userNb
  1114. FROM ".Database::get_course_table(TABLE_GROUP, $database_name)." AS g
  1115. LEFT JOIN ".Database::get_course_table(TABLE_GROUP_USER, $database_name)." gu
  1116. ON g.id = gu.group_id
  1117. $session_condition
  1118. GROUP BY g.id
  1119. ORDER BY g.name";
  1120. $result = Database::query($sql);
  1121. while ($group_data = Database::fetch_array($result)) {
  1122. $group_list[$group_data['id']] = $group_data;
  1123. }
  1124. return $group_list;
  1125. }
  1126. /**
  1127. * Checks all parameters needed to create a virtual course.
  1128. * If they are all set, the virtual course creation procedure is called.
  1129. *
  1130. * Call this function instead of create_virtual_course
  1131. * @param string Course code
  1132. * @param string Course title
  1133. * @param string Wanted course code
  1134. * @param string Course language
  1135. * @param string Course category
  1136. * @return bool True on success, false on error
  1137. */
  1138. public static function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1139. //better: create parameter list, check the entire list, when false display errormessage
  1140. self::check_parameter_or_fail($real_course_code, 'Unspecified parameter: real course id.');
  1141. self::check_parameter_or_fail($course_title, 'Unspecified parameter: course title.');
  1142. self::check_parameter_or_fail($wanted_course_code, 'Unspecified parameter: wanted course code.');
  1143. self::check_parameter_or_fail($course_language, 'Unspecified parameter: course language.');
  1144. self::check_parameter_or_fail($course_category, 'Unspecified parameter: course category.');
  1145. return self::create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
  1146. }
  1147. /**
  1148. * This function creates a virtual course.
  1149. * It assumes all parameters have been checked and are not empty.
  1150. * It checks wether a course with the $wanted_course_code already exists.
  1151. *
  1152. * Users of this library should consider this function private,
  1153. * please call attempt_create_virtual_course instead of this one.
  1154. *
  1155. * @note The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
  1156. * @param string Course code
  1157. * @param string Course title
  1158. * @param string Wanted course code
  1159. * @param string Course language
  1160. * @param string Course category
  1161. * @return true if the course creation succeeded, false otherwise
  1162. * @todo research: expiration date of a course
  1163. */
  1164. public static function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1165. global $firstExpirationDelay;
  1166. $user_id = api_get_user_id();
  1167. $real_course_info = Database::get_course_info($real_course_code);
  1168. $real_course_code = $real_course_info['system_code'];
  1169. //check: virtual course creation fails if another course has the same
  1170. //code, real or fake.
  1171. if (self::course_code_exists($wanted_course_code)) {
  1172. Display::display_error_message($wanted_course_code.' - '.get_lang('CourseCodeAlreadyExists'));
  1173. return false;
  1174. }
  1175. //add data to course table, course_rel_user
  1176. $course_sys_code = $wanted_course_code;
  1177. $course_screen_code = $wanted_course_code;
  1178. $course_repository = $real_course_info['directory'];
  1179. $course_db_name = $real_course_info['db_name'];
  1180. $responsible_teacher = $real_course_info['tutor_name'];
  1181. $faculty_shortname = $course_category;
  1182. // $course_title = $course_title;
  1183. // $course_language = $course_language;
  1184. $teacher_id = $user_id;
  1185. //HACK ----------------------------------------------------------------
  1186. $expiration_date = time() + $firstExpirationDelay;
  1187. //END HACK ------------------------------------------------------------
  1188. 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);
  1189. //above was the normal course creation table update call,
  1190. //now one more thing: fill in the target_course_code field
  1191. Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_COURSE)." SET target_course_code = '$real_course_code'
  1192. WHERE code = '".Database::escape_string($course_sys_code)."' LIMIT 1 ");
  1193. return true;
  1194. }
  1195. /**
  1196. * Delete a course
  1197. * This function deletes a whole course-area from the platform. When the
  1198. * given course is a virtual course, the database and directory will not be
  1199. * deleted.
  1200. * When the given course is a real course, also all virtual courses refering
  1201. * to the given course will be deleted.
  1202. * Considering the fact that we remove all traces of the course in the main
  1203. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1204. * so that a new course created with this code would not use the remains of an older
  1205. * course.
  1206. *
  1207. * @param string The code of the course to delete
  1208. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1209. * course from the groups in the real course if they are not subscribed in
  1210. * that real course.
  1211. * @todo Remove globals
  1212. */
  1213. public static function delete_course($code) {
  1214. global $_configuration;
  1215. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1216. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1217. $table_course_class = Database::get_main_table(TABLE_MAIN_COURSE_CLASS);
  1218. $user_role_table = Database::get_main_table(MAIN_USER_ROLE_TABLE);
  1219. $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
  1220. $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
  1221. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1222. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1223. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1224. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1225. $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1226. $stats = false;
  1227. if (Database::get_statistic_database() != ''){
  1228. $stats = true;
  1229. $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1230. $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1231. $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
  1232. $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1233. $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1234. $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1235. $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1236. $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1237. $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1238. $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1239. $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1240. }
  1241. $code = Database::escape_string($code);
  1242. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1243. $res = Database::query($sql);
  1244. if (Database::num_rows($res) == 0) {
  1245. return;
  1246. }
  1247. $this_course = Database::fetch_array($res);
  1248. $db_name = $this_course['db_name'];
  1249. self::create_database_dump($code);
  1250. if (!self::is_virtual_course_from_system_code($code)) {
  1251. // If this is not a virtual course, look for virtual courses that depend on this one, if any
  1252. $virtual_courses = self::get_virtual_courses_linked_to_real_course($code);
  1253. foreach ($virtual_courses as $index => $virtual_course) {
  1254. // Unsubscribe all classes from the virtual course
  1255. $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
  1256. Database::query($sql);
  1257. // Unsubscribe all users from the virtual course
  1258. $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
  1259. Database::query($sql);
  1260. // Delete the course from the sessions tables
  1261. $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
  1262. Database::query($sql);
  1263. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
  1264. Database::query($sql);
  1265. // Delete the course from the survey tables
  1266. $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
  1267. Database::query($sql);
  1268. $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
  1269. Database::query($sql);
  1270. $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
  1271. Database::query($sql);
  1272. // Delete the course from the stats tables
  1273. if ($stats) {
  1274. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
  1275. Database::query($sql);
  1276. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
  1277. Database::query($sql);
  1278. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
  1279. Database::query($sql);
  1280. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
  1281. Database::query($sql);
  1282. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
  1283. Database::query($sql);
  1284. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
  1285. Database::query($sql);
  1286. $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
  1287. Database::query($sql);
  1288. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
  1289. Database::query($sql);
  1290. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
  1291. Database::query($sql);
  1292. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
  1293. Database::query($sql);
  1294. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
  1295. Database::query($sql);
  1296. }
  1297. // Delete the course from the course table
  1298. $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
  1299. Database::query($sql);
  1300. }
  1301. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1302. $res = Database::query($sql);
  1303. $course = Database::fetch_array($res);
  1304. if (!$_configuration['single_database']) {
  1305. $sql = "DROP DATABASE IF EXISTS ".$course['db_name'];
  1306. Database::query($sql);
  1307. } else {
  1308. //TODO Clean the following code as currently it would probably delete another course
  1309. //similarly named, by mistake...
  1310. $db_pattern = $_configuration['table_prefix'].$course['db_name'].$_configuration['db_glue'];
  1311. $sql = "SHOW TABLES LIKE '$db_pattern%'";
  1312. $result = Database::query($sql);
  1313. while (list ($courseTable) = Database::fetch_array($result)) {
  1314. Database::query("DROP TABLE $courseTable");
  1315. }
  1316. }
  1317. $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
  1318. $archive_dir = api_get_path(SYS_ARCHIVE_PATH).$course['directory'].'_'.time();
  1319. if (is_dir($course_dir)) {
  1320. rename($course_dir, $archive_dir);
  1321. }
  1322. }
  1323. // Unsubscribe all classes from the course
  1324. $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1325. Database::query($sql);
  1326. // Unsubscribe all users from the course
  1327. $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
  1328. Database::query($sql);
  1329. // Delete the course from the sessions tables
  1330. $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
  1331. Database::query($sql);
  1332. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
  1333. Database::query($sql);
  1334. $sql = 'SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
  1335. $result_surveys = Database::query($sql);
  1336. while($surveys = Database::fetch_array($result_surveys)) {
  1337. $survey_id = $surveys[0];
  1338. $sql = 'DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
  1339. Database::query($sql);
  1340. $sql = 'DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
  1341. Database::query($sql);
  1342. $sql = 'DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
  1343. Database::query($sql);
  1344. }
  1345. // Delete the course from the stats tables
  1346. if ($stats) {
  1347. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
  1348. Database::query($sql);
  1349. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
  1350. Database::query($sql);
  1351. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
  1352. Database::query($sql);
  1353. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
  1354. Database::query($sql);
  1355. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
  1356. Database::query($sql);
  1357. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
  1358. Database::query($sql);
  1359. $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
  1360. Database::query($sql);
  1361. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
  1362. Database::query($sql);
  1363. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
  1364. Database::query($sql);
  1365. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
  1366. Database::query($sql);
  1367. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
  1368. Database::query($sql);
  1369. }
  1370. global $_configuration;
  1371. if ($_configuration['multiple_access_urls']) {
  1372. require_once api_get_path(LIBRARY_PATH).'urlmanager.lib.php';
  1373. $url_id = 1;
  1374. if (api_get_current_access_url_id() != -1) {
  1375. $url_id = api_get_current_access_url_id();
  1376. }
  1377. UrlManager::delete_url_rel_course($code, $url_id);
  1378. }
  1379. // Delete the course from the database
  1380. $sql = "DELETE FROM $table_course WHERE code='".$code."'";
  1381. Database::query($sql);
  1382. // delete extra course fields
  1383. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1384. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1385. $sql = "SELECT distinct field_id FROM $t_cfv WHERE course_code = '$code'";
  1386. $res_field_ids = @Database::query($sql);
  1387. while($row_field_id = Database::fetch_row($res_field_ids)){
  1388. $field_ids[] = $row_field_id[0];
  1389. }
  1390. //delete from table_course_field_value from a given course_code
  1391. $sql_course_field_value = "DELETE FROM $t_cfv WHERE course_code = '$code'";
  1392. @Database::query($sql_course_field_value);
  1393. $sql = "SELECT distinct field_id FROM $t_cfv";
  1394. $res_field_all_ids = @Database::query($sql);
  1395. while($row_field_all_id = Database::fetch_row($res_field_all_ids)){
  1396. $field_all_ids[] = $row_field_all_id[0];
  1397. }
  1398. if (is_array($field_ids) && count($field_ids) > 0) {
  1399. foreach ($field_ids as $field_id) {
  1400. // check if field id is used into table field value
  1401. if (is_array($field_all_ids)) {
  1402. if (in_array($field_id, $field_all_ids)) {
  1403. continue;
  1404. } else {
  1405. $sql_course_field = "DELETE FROM $t_cf WHERE id = '$field_id'";
  1406. Database::query($sql_course_field);
  1407. }
  1408. }
  1409. }
  1410. }
  1411. // add event to system log
  1412. $time = time();
  1413. $user_id = api_get_user_id();
  1414. event_system(LOG_COURSE_DELETE, LOG_COURSE_CODE, $code, $time, $user_id, $code);
  1415. }
  1416. /**
  1417. * Creates a file called mysql_dump.sql in the course folder
  1418. * @param $course_code The code of the course
  1419. * @todo Implementation for single database
  1420. */
  1421. public static function create_database_dump($course_code) {
  1422. global $_configuration;
  1423. if ($_configuration['single_database']) {
  1424. return;
  1425. }
  1426. $sql_dump = '';
  1427. $course_code = Database::escape_string($course_code);
  1428. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1429. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  1430. $res = Database::query($sql);
  1431. $course = Database::fetch_array($res);
  1432. $sql = "SHOW TABLES FROM ".$course['db_name'];
  1433. $res = Database::query($sql);
  1434. while ($table = Database::fetch_array($res)) {
  1435. $sql = "SELECT * FROM ".$course['db_name'].".".$table[0]."";
  1436. $res3 = Database::query($sql);
  1437. while ($row = Database::fetch_array($res3)) {
  1438. foreach ($row as $key => $value) {
  1439. $row[$key] = $key."='".addslashes($row[$key])."'";
  1440. }
  1441. $sql_dump .= "\nINSERT INTO $table[0] SET ".implode(', ', $row).';';
  1442. }
  1443. }
  1444. if (is_dir(api_get_path(SYS_COURSE_PATH).$course['directory'])) {
  1445. $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
  1446. $handle = fopen($file_name, 'a+');
  1447. if ($handle !== false) {
  1448. fwrite($handle, $sql_dump);
  1449. fclose($handle);
  1450. } else {
  1451. //TODO trigger exception in a try-catch
  1452. }
  1453. }
  1454. }
  1455. /**
  1456. * Sort courses for a specific user ??
  1457. * @param int User ID
  1458. * @param string Course code
  1459. * @return int Minimum course order
  1460. * @todo Review documentation
  1461. */
  1462. public static function userCourseSort($user_id, $course_code) {
  1463. if ($user_id != strval(intval($user_id))) {
  1464. return false;
  1465. }
  1466. $course_code = Database::escape_string($course_code);
  1467. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  1468. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1469. $course_title = Database::result(Database::query('SELECT title FROM '.$TABLECOURSE.
  1470. ' WHERE code="'.$course_code.'"'), 0, 0);
  1471. $result = Database::query('SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
  1472. WHERE course.code = cu.course_code
  1473. AND user_id = "'.$user_id.'"
  1474. AND cu.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  1475. AND user_course_cat=0 ORDER BY cu.sort');
  1476. $course_title_precedent = '';
  1477. $counter = 0;
  1478. $course_found = false;
  1479. $course_sort = 1;
  1480. while ($courses = Database::fetch_array($result)){
  1481. if ($course_title_precedent == '') {
  1482. $course_title_precedent = $courses['title'];
  1483. }
  1484. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  1485. $course_found = true;
  1486. $course_sort = $courses['sort'];
  1487. if ($counter == 0) {
  1488. $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.'"';
  1489. $course_sort++;
  1490. } else {
  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. }
  1493. Database::query($sql);
  1494. break;
  1495. } else {
  1496. $course_title_precedent = $courses['title'];
  1497. }
  1498. $counter++;
  1499. }
  1500. // We must register the course in the beginning of the list
  1501. if (Database::num_rows($result) > 0 && !$course_found) {
  1502. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.
  1503. ' WHERE user_id="'.$user_id.'" AND user_course_cat="0"'), 0, 0);
  1504. Database::query('UPDATE '.$TABLECOURSUSER.' SET sort = sort+1
  1505. WHERE user_id= "'.$user_id.'" AND user_course_cat="0"');
  1506. }
  1507. return $course_sort;
  1508. }
  1509. /**
  1510. * create recursively all categories as option of the select passed in paramater.
  1511. *
  1512. * @param object $select_element the quickform select where the options will be added
  1513. * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
  1514. * @param string $parent_code the parent category of the categories added (default=null for root category)
  1515. * @param string $padding the indent param (you shouldn't indicate something here)
  1516. */
  1517. public static function select_and_sort_categories($select_element, $category_selected_code = '', $parent_code = null , $padding = '') {
  1518. $sql = "SELECT code, name, auth_course_child, auth_cat_child
  1519. FROM ".Database::get_main_table(TABLE_MAIN_CATEGORY)."
  1520. WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
  1521. ORDER BY code";
  1522. $res = Database::query($sql);
  1523. while ($cat = Database::fetch_array($res)) {
  1524. $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
  1525. $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
  1526. $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
  1527. if ($cat['auth_cat_child']) {
  1528. self::select_and_sort_categories($select_element, $category_selected_code, $cat['code'], $padding.' - ');
  1529. }
  1530. }
  1531. }
  1532. /**
  1533. * check if course exists
  1534. * @param string course_code
  1535. * @param string whether to accept virtual course codes or not
  1536. * @return true if exists, false else
  1537. */
  1538. public static function course_exists($course_code, $accept_virtual = false) {
  1539. if ($accept_virtual === true) {
  1540. $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).'"';
  1541. } else {
  1542. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'"';
  1543. }
  1544. return Database::num_rows(Database::query($sql));
  1545. }
  1546. /**
  1547. * Send an email to tutor after the auth-suscription of a student in your course
  1548. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1549. * @param int $user_id the id of the user
  1550. * @param string $course_code the course code
  1551. * @param string $send_to_tutor_also
  1552. * @return string we return the message that is displayed when the action is succesfull
  1553. */
  1554. public static function email_to_tutor($user_id, $course_code, $send_to_tutor_also = false) {
  1555. if ($user_id != strval(intval($user_id))) {
  1556. return false;
  1557. }
  1558. $course_code = Database::escape_string($course_code);
  1559. $student = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1560. WHERE user_id='".$user_id."'"));
  1561. $information = self::get_course_information($course_code);
  1562. $name_course = $information['title'];
  1563. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." WHERE course_code='".$course_code."'";
  1564. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  1565. //if ($send_to_tutor_also = true) {
  1566. // Proposed change:
  1567. if ($send_to_tutor_also) {
  1568. //
  1569. $sql .= " AND tutor_id=1";
  1570. } else {
  1571. $sql .= " AND status=1";
  1572. }
  1573. $result = Database::query($sql);
  1574. while ($row = Database::fetch_array($result)) {
  1575. $tutor = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1576. WHERE user_id='".$row['user_id']."'"));
  1577. $emailto = $tutor['email'];
  1578. $emailsubject = get_lang('NewUserInTheCourse').': '.$name_course;
  1579. $emailbody = get_lang('Dear').': '. api_get_person_name($tutor['firstname'], $tutor['lastname'])."\n";
  1580. $emailbody .= get_lang('MessageNewUserInTheCourse').': '.$name_course."\n";
  1581. $emailbody .= get_lang('UserName').': '.$student['username']."\n";
  1582. if (api_is_western_name_order()) {
  1583. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1584. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1585. } else {
  1586. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1587. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1588. }
  1589. $emailbody .= get_lang('Email').': '.$student['email']."\n\n";
  1590. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1591. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  1592. $email_admin = api_get_setting('emailAdministrator');
  1593. @api_mail($recipient_name, $emailto, $emailsubject, $emailbody, $sender_name,$email_admin);
  1594. }
  1595. }
  1596. public static function get_special_course_list() {
  1597. $tbl_course_field = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD);
  1598. $tbl_course_field_value = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1599. //we filter the courses from the URL
  1600. $join_access_url = $where_access_url='';
  1601. global $_configuration;
  1602. if ($_configuration['multiple_access_urls']) {
  1603. $access_url_id = api_get_current_access_url_id();
  1604. if ($access_url_id != -1) {
  1605. $tbl_url_course = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  1606. $join_access_url= "LEFT JOIN $tbl_url_course url_rel_course ON url_rel_course.course_code= tcfv.course_code ";
  1607. $where_access_url =" AND access_url_id = $access_url_id ";
  1608. }
  1609. }
  1610. // get course list auto-register
  1611. $sql = "SELECT DISTINCT(tcfv.course_code) FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf
  1612. ON tcfv.field_id = tcf.id $join_access_url
  1613. WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 $where_access_url";
  1614. $special_course_result = Database::query($sql);
  1615. $special_course_list = array();
  1616. if (Database::num_rows($special_course_result)>0) {
  1617. $special_course_list = array();
  1618. while ($result_row = Database::fetch_array($special_course_result)) {
  1619. $special_course_list[] = $result_row['course_code'];
  1620. }
  1621. }
  1622. return $special_course_list;
  1623. }
  1624. /**
  1625. * Get list of courses for a given user
  1626. * @param int user ID
  1627. * @param boolean Whether to include courses from session or not
  1628. * @return array List of codes and db names
  1629. * @author isaac flores paz
  1630. */
  1631. public static function get_courses_list_by_user_id($user_id, $include_sessions = false) {
  1632. $user_id = intval($user_id);
  1633. $course_list = array();
  1634. $codes = array();
  1635. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1636. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1637. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  1638. $special_course_list = self::get_special_course_list();
  1639. $with_special_courses = $without_special_courses = '';
  1640. if (!empty($special_course_list)) {
  1641. $sc_string = '"'.implode('","',$special_course_list).'"';
  1642. $with_special_courses = ' course.code IN ('.$sc_string.')';
  1643. $without_special_courses = ' AND course.code NOT IN ('.$sc_string.')';
  1644. }
  1645. if (!empty($with_special_courses)) {
  1646. $sql = "SELECT DISTINCT(course.code), course.db_name db_name, course.title
  1647. FROM ".$tbl_course_user." course_rel_user
  1648. LEFT JOIN ".$tbl_course." course
  1649. ON course.code = course_rel_user.course_code
  1650. LEFT JOIN ".$tbl_user_course_category." user_course_category
  1651. ON course_rel_user.user_course_cat = user_course_category.id
  1652. WHERE $with_special_courses
  1653. GROUP BY course.code
  1654. ORDER BY user_course_category.sort,course.title,course_rel_user.sort ASC";
  1655. $rs_special_course = Database::query($sql);
  1656. if (Database::num_rows($rs_special_course) > 0) {
  1657. while ($result_row = Database::fetch_array($rs_special_course)) {
  1658. $result_row['special_course'] = 1;
  1659. $course_list[] = $result_row;
  1660. $codes[] = $result_row['code'];
  1661. }
  1662. }
  1663. }
  1664. // get course list not auto-register. Use Distinct to avoid multiple
  1665. // entries when a course is assigned to a HRD (DRH) as watcher
  1666. $sql = "SELECT DISTINCT(course.code),course.db_name,course.title
  1667. FROM $tbl_course course
  1668. INNER JOIN $tbl_course_user cru
  1669. ON course.code=cru.course_code
  1670. WHERE cru.user_id='$user_id' $without_special_courses";
  1671. $result = Database::query($sql);
  1672. if (Database::num_rows($result)) {
  1673. while ($row = Database::fetch_array($result, 'ASSOC')) {
  1674. $course_list[] = $row;
  1675. $codes[] = $row['code'];
  1676. }
  1677. }
  1678. if ($include_sessions === true) {
  1679. $r = Database::query("SELECT DISTINCT(c.code),c.db_name,c.title
  1680. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." s, ".Database::get_main_table(TABLE_MAIN_COURSE)." c
  1681. WHERE id_user = $user_id AND s.course_code=c.code");
  1682. while ($row = Database::fetch_array($r, 'ASSOC')) {
  1683. if (!in_array($row['code'], $codes)) {
  1684. $course_list[] = $row;
  1685. }
  1686. }
  1687. }
  1688. return $course_list;
  1689. }
  1690. /**
  1691. * Get course ID from a given course directory name
  1692. * @param string Course directory (without any slash)
  1693. * @return string Course code, or false if not found
  1694. */
  1695. public static function get_course_id_from_path ($path) {
  1696. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  1697. $res = Database::query("SELECT code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1698. WHERE directory LIKE BINARY '$path'");
  1699. if ($res === false) {
  1700. return false;
  1701. }
  1702. if (Database::num_rows($res) != 1) {
  1703. return false;
  1704. }
  1705. $row = Database::fetch_array($res);
  1706. return $row['code'];
  1707. }
  1708. /**
  1709. * Get course code(s) from visual code
  1710. * @param string Visual code
  1711. * @return array List of codes for the given visual code
  1712. */
  1713. public static function get_courses_info_from_visual_code($code) {
  1714. $result = array();
  1715. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1716. WHERE visual_code = '".Database::escape_string($code)."'");
  1717. while ($virtual_course = Database::fetch_array($sql_result)) {
  1718. $result[] = $virtual_course;
  1719. }
  1720. return $result;
  1721. }
  1722. /**
  1723. * Get emails of tutors to course
  1724. * @param string Visual code
  1725. * @return array List of emails of tutors to course
  1726. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1727. * */
  1728. public static function get_emails_of_tutors_to_course($code) {
  1729. $list = array();
  1730. $res = Database::query("SELECT user_id FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1731. WHERE course_code='".Database::escape_string($code)."' AND status=1");
  1732. while ($list_users = Database::fetch_array($res)) {
  1733. $result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1734. WHERE user_id=".$list_users['user_id']);
  1735. while ($row_user = Database::fetch_array($result)){
  1736. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1737. $list[] = array($row_user['email'] => $name_teacher);
  1738. }
  1739. }
  1740. return $list;
  1741. }
  1742. /**
  1743. * Get coachs' emails by session
  1744. * @param int session id
  1745. * @param string course code
  1746. * @return array array(email => name_tutor) by coach
  1747. * @author Carlos Vargas <carlos.vargas@dokeos.com>
  1748. */
  1749. public static function get_email_of_tutor_to_session($session_id,$course_code) {
  1750. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1751. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  1752. $coachs_emails = array();
  1753. $course_code = Database::escape_string($course_code);
  1754. $session_id = intval($session_id);
  1755. $sql = "SELECT id_user FROM $tbl_session_course_user WHERE id_session='$session_id' AND course_code='$course_code' AND status =2";
  1756. $rs = Database::query($sql);
  1757. if (Database::num_rows($rs) > 0) {
  1758. $user_ids = array();
  1759. while ($row = Database::fetch_array($rs)) {
  1760. $user_ids[] = $row['id_user'];
  1761. }
  1762. $sql = "SELECT firstname,lastname,email FROM $tbl_user WHERE user_id IN (".implode(",",$user_ids).")";
  1763. $rs_user = Database::query($sql);
  1764. while ($row_emails = Database::fetch_array($rs_user)) {
  1765. $name_tutor = api_get_person_name($row_emails['firstname'], $row_emails['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1766. $mail_tutor = array($row_emails['email'] => $name_tutor);
  1767. $coachs_emails[] = $mail_tutor;
  1768. }
  1769. }
  1770. return $coachs_emails;
  1771. }
  1772. /**
  1773. * Creates a new extra field for a given course
  1774. * @param string Field's internal variable name
  1775. * @param int Field's type
  1776. * @param string Field's language var name
  1777. * @return int new extra field id
  1778. */
  1779. public static function create_course_extra_field($fieldvarname, $fieldtype, $fieldtitle) {
  1780. // database table definition
  1781. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1782. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1783. $fieldvarname = Database::escape_string($fieldvarname);
  1784. $fieldtitle = Database::escape_string($fieldtitle);
  1785. $fieldtype = (int)$fieldtype;
  1786. $time = time();
  1787. $sql_field = "SELECT id FROM $t_cf WHERE field_variable = '$fieldvarname'";
  1788. $res_field = Database::query($sql_field);
  1789. $r_field = Database::fetch_row($res_field);
  1790. if (Database::num_rows($res_field) > 0) {
  1791. return $r_field[0];
  1792. }
  1793. // save new fieldlabel into course_field table
  1794. $sql = "SELECT MAX(field_order) FROM $t_cf";
  1795. $res = Database::query($sql);
  1796. $order = 0;
  1797. if (Database::num_rows($res) > 0) {
  1798. $row = Database::fetch_row($res);
  1799. $order = $row[0] + 1;
  1800. }
  1801. $sql = "INSERT INTO $t_cf
  1802. SET field_type = '$fieldtype',
  1803. field_variable = '$fieldvarname',
  1804. field_display_text = '$fieldtitle',
  1805. field_order = '$order',
  1806. tms = FROM_UNIXTIME($time)";
  1807. Database::query($sql);
  1808. return Database::insert_id();
  1809. }
  1810. /**
  1811. * Updates course attribute. Note that you need to check that your attribute is valid before you use this function
  1812. *
  1813. * @param int Course id
  1814. * @param string Attribute name
  1815. * @param string Attribute value
  1816. * @return bool True if attribute was successfully updated, false if course was not found or attribute name is invalid
  1817. */
  1818. public static function update_attribute($id, $name, $value) {
  1819. $id = (int)$id;
  1820. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1821. $sql = "UPDATE $table SET $name = '".Database::escape_string($value)."' WHERE id = '$id';";
  1822. return Database::query($sql);
  1823. }
  1824. /**
  1825. * 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
  1826. *
  1827. * @param int Course id
  1828. * @param array Associative array with field names as keys and field values as values
  1829. * @return bool True if update was successful, false otherwise
  1830. */
  1831. public static function update_attributes($id, $attributes) {
  1832. $id = (int)$id;
  1833. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1834. $sql = "UPDATE $table SET ";
  1835. $i = 0;
  1836. foreach($attributes as $name => $value) {
  1837. if($value != '') {
  1838. if($i > 0) {
  1839. $sql .= ", ";
  1840. }
  1841. $sql .= " $name = '".Database::escape_string($value)."'";
  1842. $i++;
  1843. }
  1844. }
  1845. $sql .= " WHERE id = '$id';";
  1846. return Database::query($sql);
  1847. }
  1848. /**
  1849. * Update an extra field value for a given course
  1850. * @param integer Course ID
  1851. * @param string Field variable name
  1852. * @param string Field value
  1853. * @return boolean true if field updated, false otherwise
  1854. */
  1855. public static function update_course_extra_field_value($course_code, $fname, $fvalue = '') {
  1856. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1857. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1858. $fname = Database::escape_string($fname);
  1859. $course_code = Database::escape_string($course_code);
  1860. $fvalues = '';
  1861. if (is_array($fvalue)) {
  1862. foreach ($fvalue as $val) {
  1863. $fvalues .= Database::escape_string($val).';';
  1864. }
  1865. if (!empty($fvalues)) {
  1866. $fvalues = substr($fvalues, 0, -1);
  1867. }
  1868. } else {
  1869. $fvalues = Database::escape_string($fvalue);
  1870. }
  1871. $sqlcf = "SELECT * FROM $t_cf WHERE field_variable='$fname'";
  1872. $rescf = Database::query($sqlcf);
  1873. if (Database::num_rows($rescf) == 1) {
  1874. // Ok, the field exists
  1875. // Check if enumerated field, if the option is available
  1876. $rowcf = Database::fetch_array($rescf);
  1877. $tms = time();
  1878. $sqlcfv = "SELECT * FROM $t_cfv WHERE course_code = '$course_code' AND field_id = '".$rowcf['id']."' ORDER BY id";
  1879. $rescfv = Database::query($sqlcfv);
  1880. $n = Database::num_rows($rescfv);
  1881. if ($n > 1) {
  1882. //problem, we already have to values for this field and user combination - keep last one
  1883. while ($rowcfv = Database::fetch_array($rescfv)) { // See the TODO note below.
  1884. if ($n > 1) {
  1885. $sqld = "DELETE FROM $t_cfv WHERE id = ".$rowcfv['id'];
  1886. $resd = Database::query($sqld);
  1887. $n--;
  1888. }
  1889. $rowcfv = Database::fetch_array($rescfv);
  1890. if ($rowcfv['field_value'] != $fvalues) {
  1891. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1892. $resu = Database::query($sqlu);
  1893. return ($resu ? true : false);
  1894. }
  1895. 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...
  1896. }
  1897. } elseif ($n == 1) {
  1898. //we need to update the current record
  1899. $rowcfv = Database::fetch_array($rescfv);
  1900. if ($rowcfv['field_value'] != $fvalues) {
  1901. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1902. //error_log('UM::update_extra_field_value: '.$sqlu);
  1903. $resu = Database::query($sqlu);
  1904. return ($resu ? true : false);
  1905. }
  1906. return true;
  1907. } else {
  1908. $sqli = "INSERT INTO $t_cfv (course_code,field_id,field_value,tms) " .
  1909. "VALUES ('$course_code',".$rowcf['id'].",'$fvalues',FROM_UNIXTIME($tms))";
  1910. //error_log('UM::update_extra_field_value: '.$sqli);
  1911. $resi = Database::query($sqli);
  1912. return ($resi ? true : false);
  1913. }
  1914. } else {
  1915. return false; //field not found
  1916. }
  1917. }
  1918. /**
  1919. * Get the course id of an course by the database name
  1920. * @param string The database name
  1921. * @return string The course id
  1922. */
  1923. public static function get_course_id_by_database_name($db_name) {
  1924. return Database::result(Database::query('SELECT code FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1925. ' WHERE db_name="'.Database::escape_string($db_name).'"'), 0, 'code');
  1926. }
  1927. public static function get_session_category_id_by_session_id($session_id) {
  1928. return Database::result(Database::query('SELECT sc.id session_category
  1929. FROM '.Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY).' sc
  1930. INNER JOIN '.Database::get_main_table(TABLE_MAIN_SESSION).' s
  1931. ON sc.id=s.session_category_id WHERE s.id="'.Database::escape_string($session_id).'"'),
  1932. 0, 'session_category');
  1933. }
  1934. /**
  1935. * Get the course id of an course by the database name
  1936. * @param string The database name
  1937. * @return string The course id
  1938. */
  1939. public static function get_course_extra_field_list($code) {
  1940. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1941. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1942. $sql_field = "SELECT id, field_type, field_variable, field_display_text, field_default_value
  1943. FROM $tbl_course_field WHERE field_visible = '1' ";
  1944. $res_field = Database::query($sql_field);
  1945. $extra_fields = array();
  1946. while($rowcf = Database::fetch_array($res_field)) {
  1947. $extra_field_id = $rowcf['id'];
  1948. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '$extra_field_id' ";
  1949. $res_field_value = Database::query($sql_field_value);
  1950. if(Database::num_rows($res_field_value) > 0 ) {
  1951. $r_field_value = Database::fetch_row($res_field_value);
  1952. $rowcf['extra_field_value'] = $r_field_value[0];
  1953. }
  1954. $extra_fields[] = $rowcf;
  1955. }
  1956. return $extra_fields;
  1957. }
  1958. /**
  1959. * Gets the value of a course extra field. Returns null if it was not found
  1960. *
  1961. * @param string Name of the extra field
  1962. * @param string Course code
  1963. * @return string Value
  1964. */
  1965. public static function get_course_extra_field_value($field_name, $code) {
  1966. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1967. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1968. $sql = "SELECT id FROM $tbl_course_field WHERE field_visible = '1' AND field_variable = '$field_name';";
  1969. $res = Database::query($sql);
  1970. $row = Database::fetch_object($res);
  1971. if(!$row) {
  1972. return null;
  1973. } else {
  1974. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '{$row->id}';";
  1975. $res_field_value = Database::query($sql_field_value);
  1976. $row_field_value = Database::fetch_object($res_field_value);
  1977. if(!$row_field_value) {
  1978. return null;
  1979. } else {
  1980. return $row_field_value['field_value'];
  1981. }
  1982. }
  1983. }
  1984. /**
  1985. * Get the database name of a course by the code
  1986. * @param string The course code
  1987. * @return string The database name
  1988. */
  1989. public static function get_name_database_course($course_code) {
  1990. return Database::result(Database::query('SELECT db_name FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1991. ' WHERE code="'.Database::escape_string($course_code).'"'), 0, 'db_name');
  1992. }
  1993. /**
  1994. * Lists details of the course description
  1995. * @param array The course description
  1996. * @param string The encoding
  1997. * @param bool If true is displayed if false is hidden
  1998. * @return string The course description in html
  1999. */
  2000. public static function get_details_course_description_html($descriptions, $charset, $action_show = true) {
  2001. if (isset($descriptions) && count($descriptions) > 0) {
  2002. $data = '';
  2003. foreach ($descriptions as $id => $description) {
  2004. $data .= '<div class="sectiontitle">';
  2005. if (api_is_allowed_to_edit() && $action_show) {
  2006. //delete
  2007. $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;">';
  2008. $data .= Display::return_icon('delete.gif', get_lang('Delete'), array('style' => 'vertical-align:middle;float:right;'));
  2009. $data .= '</a> ';
  2010. //edit
  2011. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;description_id='.$description->id.'">';
  2012. $data .= Display::return_icon('edit.png', get_lang('Edit'), array('style' => 'vertical-align:middle;float:right; padding-right:4px;'), 22);
  2013. $data .= '</a> ';
  2014. }
  2015. $data .= $description->title;
  2016. $data .= '</div>';
  2017. $data .= '<div class="sectioncomment">';
  2018. $data .= text_filter($description->content);
  2019. $data .= '</div>';
  2020. }
  2021. } else {
  2022. $data .= '<em>'.get_lang('ThisCourseDescriptionIsEmpty').'</em>';
  2023. }
  2024. return $data;
  2025. }
  2026. /**
  2027. * Returns the details of a course category
  2028. *
  2029. * @param string Category code
  2030. * @return array Course category
  2031. */
  2032. public static function get_course_category($code) {
  2033. $table_categories = Database::get_main_table(TABLE_MAIN_CATEGORY);
  2034. $sql = "SELECT * FROM $table_categories WHERE code = '$code';";
  2035. return Database::fetch_array(Database::query($sql));
  2036. }
  2037. /*
  2038. ==============================================================================
  2039. DEPRECATED METHODS
  2040. ==============================================================================
  2041. */
  2042. /**
  2043. * This code creates a select form element to let the user
  2044. * choose a real course to link to.
  2045. *
  2046. * A good non-display library should not use echo statements, but just return text/html
  2047. * so users of the library can choose when to display.
  2048. *
  2049. * We display the course code, but internally store the course id.
  2050. *
  2051. * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
  2052. * @param boolean $only_current_user_courses, true only the real courses of which the
  2053. * current user is course admin are displayed, false all real courses are shown.
  2054. * @param string $element_name the name of the select element
  2055. * @return a string containing html code for a form select element.
  2056. * @deprecated Function not in use
  2057. */
  2058. public static function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id) {
  2059. if ($only_current_user_courses) {
  2060. $real_course_list = self::get_real_course_list_of_user_as_course_admin($user_id);
  2061. } else {
  2062. $real_course_list = self::get_real_course_list();
  2063. }
  2064. if ($has_size) {
  2065. $size_element = "size=\"".SELECT_BOX_SIZE."\"";
  2066. } else {
  2067. $size_element = "";
  2068. }
  2069. $html_code = "<select name=\"$element_name\" $size_element >\n";
  2070. foreach ($real_course_list as $real_course) {
  2071. $course_code = $real_course["code"];
  2072. $html_code .= "<option value=\"".$course_code."\">";
  2073. $html_code .= $course_code;
  2074. $html_code .= "</option>\n";
  2075. }
  2076. $html_code .= "</select>\n";
  2077. return $html_code;
  2078. }
  2079. /**
  2080. * Get count rows of a table inside a course database
  2081. * @param string The table of which the rows should be counted
  2082. * @param int optionally count rows by session id
  2083. * @return int The number of rows in the given table.
  2084. */
  2085. public static function count_rows_course_table($table, $session_id = '') {
  2086. $condition_session = '';
  2087. if ($session_id !== '') {
  2088. $session_id = intval($session_id);
  2089. $condition_session = " WHERE session_id = '$session_id' ";
  2090. }
  2091. $sql = "SELECT COUNT(*) AS n FROM $table $condition_session ";
  2092. $rs = Database::query($sql);
  2093. $row = Database::fetch_row($rs);
  2094. return $row[0];
  2095. }
  2096. /**
  2097. * Subscribes courses to human resource manager (Dashboard feature)
  2098. * @param int Human Resource Manager id
  2099. * @param array Courses code
  2100. * @param int Relation type
  2101. **/
  2102. public static function suscribe_courses_to_hr_manager($hr_manager_id,$courses_list) {
  2103. global $_configuration;
  2104. // Database Table Definitions
  2105. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2106. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2107. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2108. $hr_manager_id = intval($hr_manager_id);
  2109. $affected_rows = 0;
  2110. //Deleting assigned courses to hrm_id
  2111. if ($_configuration['multiple_access_urls']) {
  2112. $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()."";
  2113. } else {
  2114. $sql = "SELECT course_code FROM $tbl_course_rel_user WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  2115. }
  2116. $result = Database::query($sql);
  2117. if (Database::num_rows($result) > 0) {
  2118. while ($row = Database::fetch_array($result)) {
  2119. $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." ";
  2120. Database::query($sql);
  2121. }
  2122. }
  2123. // inserting new courses list
  2124. if (is_array($courses_list)) {
  2125. foreach ($courses_list as $course_code) {
  2126. $course_code = Database::escape_string($course_code);
  2127. $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."')";
  2128. Database::query($insert_sql);
  2129. if (Database::affected_rows()) {
  2130. $affected_rows++;
  2131. }
  2132. }
  2133. }
  2134. return $affected_rows;
  2135. }
  2136. /**
  2137. * get courses followed by human resources manager
  2138. * @param int human resources manager id
  2139. * @return array courses
  2140. */
  2141. public static function get_courses_followed_by_drh($hr_dept_id) {
  2142. global $_configuration;
  2143. // Database Table Definitions
  2144. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2145. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2146. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2147. $hr_dept_id = intval($hr_dept_id);
  2148. $assigned_courses_to_hrm = array();
  2149. if ($_configuration['multiple_access_urls']) {
  2150. $sql = "SELECT * FROM $tbl_course c
  2151. 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()."";
  2152. } else {
  2153. $sql = "SELECT * FROM $tbl_course c
  2154. 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."' ";
  2155. }
  2156. $rs_assigned_courses = Database::query($sql);
  2157. if (Database::num_rows($rs_assigned_courses) > 0) {
  2158. while ($row_assigned_courses = Database::fetch_array($rs_assigned_courses)) {
  2159. $assigned_courses_to_hrm[$row_assigned_courses['code']] = $row_assigned_courses;
  2160. }
  2161. }
  2162. return $assigned_courses_to_hrm;
  2163. }
  2164. /**
  2165. * check if a course is special (autoregister)
  2166. * @param string course code
  2167. */
  2168. public static function is_special_course($course_code){
  2169. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2170. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2171. $is_special = false;
  2172. $sql = "SELECT course_code FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf ON " .
  2173. " tcfv.field_id = tcf.id WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 AND course_code='$course_code'";
  2174. $result = Database::query($sql);
  2175. $num_rows = Database::num_rows($result);
  2176. if ($num_rows > 0){
  2177. $is_special = true;
  2178. }
  2179. return $is_special;
  2180. }
  2181. /**
  2182. * Update course picture
  2183. * @param string Course code
  2184. * @param string File name
  2185. * @param string The full system name of the image from which course picture will be created.
  2186. * @return bool Returns the resulting. In case of internal error or negative validation returns FALSE.
  2187. */
  2188. public static function update_course_picture($course_code, $filename, $source_file = null) {
  2189. $course_info = api_get_course_info($course_code);
  2190. $store_path = api_get_path(SYS_COURSE_PATH).$course_info['path']; // course path
  2191. $course_image = $store_path.'/course-pic.png'; // image name for courses
  2192. $course_medium_image = $store_path.'/course-pic85x85.png';
  2193. $extension = strtolower(substr(strrchr($filename, '.'), 1));
  2194. $result = false;
  2195. $allowed_picture_types = array ('jpg', 'jpeg', 'png', 'gif');
  2196. if (in_array($extension, $allowed_picture_types)) {
  2197. if (file_exists($course_image)) {
  2198. @unlink($course_image);
  2199. }
  2200. if (file_exists($course_medium_image)) {
  2201. @unlink($course_medium_image);
  2202. }
  2203. if ($extension != 'png') {
  2204. // convert image to png extension
  2205. if ($extension == 'jpg' || $extension == 'jpeg') {
  2206. $image = imagecreatefromjpeg($source_file);
  2207. } else {
  2208. $image = imagecreatefromgif($source_file);
  2209. }
  2210. ob_start();
  2211. imagepng($image);
  2212. $imagevariable = ob_get_contents();
  2213. ob_end_clean();
  2214. // save picture
  2215. if (@file_put_contents($course_image, $imagevariable)) {
  2216. $result = true;
  2217. }
  2218. } else {
  2219. $result = @move_uploaded_file($source_file, $course_image);
  2220. }
  2221. }
  2222. // redimension image to 85x85
  2223. if ($result) {
  2224. $max_size_for_picture = 85;
  2225. if (!class_exists('image')) {
  2226. require_once api_get_path(LIBRARY_PATH).'image.lib.php';
  2227. }
  2228. $medium = new image($course_image);
  2229. $picture_infos = api_getimagesize($course_image);
  2230. if ($picture_infos[0] > $max_size_for_picture) {
  2231. $width = 100000;
  2232. $height = $max_size_for_picture;
  2233. $medium->resize($width, $height, 0);
  2234. }
  2235. $rs = $medium->send_image('PNG', $store_path.'/course-pic85x85.png');
  2236. }
  2237. return $result;
  2238. }
  2239. /**
  2240. * @deprecated See CourseManager::course_code_exists()
  2241. */
  2242. public static function is_existing_course_code($wanted_course_code) {
  2243. return self::course_code_exists($wanted_course_code);
  2244. }
  2245. /**
  2246. * Display special courses (and only these) as several HTML divs of class userportal-course-item
  2247. *
  2248. * Special courses are courses that stick on top of the list and are "auto-registerable"
  2249. * in the sense that any user clicking them is registered as a student
  2250. * @param int User id
  2251. * @return void
  2252. */
  2253. function display_special_courses ($user_id) {
  2254. $user_id = intval($user_id);
  2255. $user_info = api_get_user_info($user_id);
  2256. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2257. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2258. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2259. $special_course_list = self::get_special_course_list();
  2260. $with_special_courses = $without_special_courses = '';
  2261. if (!empty($special_course_list)) {
  2262. $with_special_courses = ' course.code IN ("'.implode('","',$special_course_list).'")';
  2263. }
  2264. if (!empty($with_special_courses)) {
  2265. $sql = "SELECT course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2266. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2267. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course_rel_user.user_id, course.visibility
  2268. FROM $TABLECOURS course
  2269. LEFT JOIN $TABLECOURSUSER course_rel_user ON course.code = course_rel_user.course_code AND course_rel_user.user_id = '$user_id'
  2270. WHERE $with_special_courses group by course.code";
  2271. $rs_special_course = Database::query($sql);
  2272. $number_of_courses = Database::num_rows($rs_special_course);
  2273. $key = 0;
  2274. $status_icon = '';
  2275. if ($number_of_courses > 0) {
  2276. while ($course = Database::fetch_array($rs_special_course)) {
  2277. // Get notifications.
  2278. $my_course = array();
  2279. $my_course['db'] = $course['db_name'];
  2280. $my_course['k'] = $course['code'];
  2281. $my_course['id_session'] = null;
  2282. $my_course['s'] = $course['status'];
  2283. $show_notification = Display::show_notification($my_course);
  2284. if (empty($course['user_id'])) {
  2285. $course['status'] = $user_info['status'];
  2286. }
  2287. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array('width'=>'48px'));
  2288. /*
  2289. if ($course['status'] == 1) {
  2290. $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;'));
  2291. }
  2292. if (($course['status'] == 5 && !api_is_coach()) || empty($course['status'])) {
  2293. $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;'));
  2294. }*/
  2295. echo '<div class="userportal-course-item">';
  2296. if (api_is_platform_admin()) {
  2297. 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>';
  2298. if ($course['status'] == COURSEMANAGER) {
  2299. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'),array('style'=>'width:11px; height:11px;'));
  2300. }
  2301. echo '</div>';
  2302. }
  2303. $course_visibility = $course['visibility'];
  2304. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2305. $course_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0&amp;autoreg=1">'.$course['title'].'</a>';
  2306. } else {
  2307. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2308. }
  2309. echo '<div style="float: left; margin-right: 10px;">'.$status_icon.'</div><span class="userportal-course-item-title">'.$course_title.'</span><br />';
  2310. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2311. echo $course['visual_code'];
  2312. }
  2313. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2314. echo ' - ';
  2315. }
  2316. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2317. echo $course['tutor'];
  2318. }
  2319. echo '&nbsp;';
  2320. echo Display::return_icon('klipper.png', get_lang('CourseAutoRegister'));
  2321. // Show notifications.
  2322. echo $show_notification;
  2323. echo '</div>';
  2324. $key++;
  2325. }
  2326. }
  2327. }
  2328. }
  2329. /**
  2330. * Display courses (without special courses) as several HTML divs
  2331. * of course categories, as class userportal-catalog-item.
  2332. * @uses display_courses_in_category() to display the courses themselves
  2333. * @param int user id
  2334. * @return void
  2335. */
  2336. function display_courses($user_id) {
  2337. global $_user, $_configuration;
  2338. // Building an array that contains all the id's of the user defined course categories.
  2339. // Initially this was inside the display_courses_in_category function but when we do it here we have fewer
  2340. // sql executions = performance increase.
  2341. $all_user_categories = self :: get_user_course_categories();
  2342. // Step 0: We display the course without a user category.
  2343. self :: display_courses_in_category(0, 'true');
  2344. // Step 1: We get all the categories of the user.
  2345. $tucc = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2346. $sql = "SELECT id, title FROM $tucc WHERE user_id='".$_user['user_id']."' ORDER BY sort ASC";
  2347. $result = Database::query($sql);
  2348. while ($row = Database::fetch_array($result)) {
  2349. // We simply display the title of the category.
  2350. echo '<div class="userportal-catalog-item">';
  2351. echo '<ul class="catalog_box">';
  2352. echo '<li>';
  2353. echo Display::return_icon('folder_yellow.png', get_lang('Category'), array('width' => '48px', 'align' => 'absmiddle'));
  2354. echo '<span>';
  2355. echo '<a name="category'.$row['id'].'"></a>'; // Display an internal anchor.
  2356. echo $row['title'];
  2357. echo '</span>';
  2358. echo '</li>';
  2359. self :: display_courses_in_category($row['id']);
  2360. echo '</ul>';
  2361. echo '</div>';
  2362. }
  2363. }
  2364. /**
  2365. * Display courses inside a category (without special courses) as HTML dics of
  2366. * class userportal-course-item.
  2367. * @param int User category id
  2368. * @return void
  2369. */
  2370. function display_courses_in_category($user_category_id) {
  2371. global $_user, $_configuration;
  2372. // Table definitions
  2373. $TABLECOURS = Database :: get_main_table(TABLE_MAIN_COURSE);
  2374. $TABLECOURSUSER = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
  2375. $TABLE_ACCESS_URL_REL_COURSE = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2376. $TABLE_USER_COURSE_CATEGORY = Database :: get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2377. $current_url_id = api_get_current_access_url_id();
  2378. // Get course list auto-register
  2379. $special_course_list = self::get_special_course_list();
  2380. $without_special_courses = '';
  2381. if (!empty($special_course_list)) {
  2382. $without_special_courses = ' AND course.code NOT IN ("'.implode('","',$special_course_list).'")';
  2383. }
  2384. $sql_select_courses = "SELECT course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2385. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2386. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course.visibility
  2387. FROM $TABLECOURS course,
  2388. $TABLECOURSUSER course_rel_user, ".$TABLE_ACCESS_URL_REL_COURSE." url
  2389. WHERE course.code = course_rel_user.course_code AND url.course_code = course.code
  2390. AND course_rel_user.user_id = '".$_user['user_id']."'
  2391. AND course_rel_user.relation_type<>".COURSE_RELATION_TYPE_RRHH."
  2392. AND course_rel_user.user_course_cat='".$user_category_id."' $without_special_courses ";
  2393. // If multiple URL access mode is enabled, only fetch courses
  2394. // corresponding to the current URL.
  2395. if ($_configuration['multiple_access_urls'] && $current_url_id != -1){
  2396. $sql_select_courses .= " AND url.course_code=course.code AND access_url_id='".$current_url_id."'";
  2397. }
  2398. // Use user's classification for courses (if any).
  2399. $sql_select_courses .= " ORDER BY course_rel_user.user_course_cat, course_rel_user.sort ASC";
  2400. $result = Database::query($sql_select_courses);
  2401. $number_of_courses = Database::num_rows($result);
  2402. $key = 0;
  2403. $status_icon = '';
  2404. // Browse through all courses.
  2405. while ($course = Database::fetch_array($result)) {
  2406. // Get notifications.
  2407. $my_course = array();
  2408. $my_course['db'] = $course['db_name'];
  2409. $my_course['k'] = $course['code'];
  2410. $my_course['id_session'] = null;
  2411. $my_course['s'] = $course['status'];
  2412. // For each course, get if there is any notification icon to show
  2413. // (something that would have changed since the user's last visit).
  2414. $show_notification = Display :: show_notification($my_course);
  2415. // New code displaying the user's status in respect to this course.
  2416. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array('width' => '48px'));
  2417. echo '<div class="userportal-course-item">';
  2418. if (api_is_platform_admin()) {
  2419. 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>';
  2420. if ($course['status'] == COURSEMANAGER) {
  2421. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  2422. }
  2423. echo '</div>';
  2424. }
  2425. // Function logic - act on the data (check if the course is virtual, if yes change the link).
  2426. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($course['code']);
  2427. if ($is_virtual_course) {
  2428. // If the current user is also subscribed in the real course to which this
  2429. // virtual course is linked, we don't need to display the virtual course entry in
  2430. // the course list - it is combined with the real course entry.
  2431. $target_course_code = CourseManager :: get_target_of_linked_course($course['code']);
  2432. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2433. if ($is_subscribed_in_target_course) {
  2434. return; // Do not display this course entry.
  2435. }
  2436. }
  2437. // Check if the course has virtual courses attached. If yes change the course title and display code.
  2438. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course['code'], api_get_user_id());
  2439. if ($has_virtual_courses) {
  2440. $course_info = api_get_course_info($course['code']);
  2441. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2442. $course_title = $return_result['title'];
  2443. $course_display_code = $return_result['code'];
  2444. } else {
  2445. $course_title = $course['title'];
  2446. $course_display_code = $course['visual_code'];
  2447. }
  2448. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2449. $course_visibility = $course['visibility'];
  2450. $course_title_url = '';
  2451. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2452. $course_title_url = api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0';
  2453. $course_title = Display::url($course['title'], $course_title_url);
  2454. } else {
  2455. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2456. }
  2457. if (!empty($course_title_url)) {
  2458. $status_icon = Display::url($status_icon, $course_title_url);
  2459. }
  2460. // Start displaying the course block itself.
  2461. echo '<div style="float: left; margin-right: 10px;">'.$status_icon.'</div><span class="userportal-course-item-title">'.$course_title.'</span><br />';
  2462. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2463. echo $course_display_code;
  2464. }
  2465. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2466. echo ' - ';
  2467. }
  2468. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2469. if (!empty($course['tutor']))
  2470. echo $course['tutor'];
  2471. }
  2472. // Show notifications.
  2473. echo $show_notification;
  2474. echo '</div>';
  2475. $key++;
  2476. }
  2477. }
  2478. /**
  2479. * Retrieves the user defined course categories
  2480. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  2481. * @return array containing all the titles of the user defined courses with the id as key of the array
  2482. */
  2483. function get_user_course_categories() {
  2484. global $_user;
  2485. $output = array();
  2486. $table_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2487. $sql = "SELECT * FROM ".$table_category." WHERE user_id='".Database::escape_string($_user['user_id'])."'";
  2488. $result = Database::query($sql);
  2489. while ($row = Database::fetch_array($result)) {
  2490. $output[$row['id']] = $row['title'];
  2491. }
  2492. return $output;
  2493. }
  2494. /**
  2495. * Get the course id based on the original id and field name in the extra fields. Returns 0 if course was not found
  2496. *
  2497. * @param string Original course id
  2498. * @param string Original field name
  2499. * @return int Course id
  2500. */
  2501. public static function get_course_id_from_original_id($original_course_id_value, $original_course_id_name) {
  2502. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2503. $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2504. $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'";
  2505. $res = Database::query($sql_course);
  2506. $row = Database::fetch_object($res);
  2507. if($row != false) {
  2508. return $row->id;
  2509. } else {
  2510. return 0;
  2511. }
  2512. }
  2513. /**
  2514. * Display code for one specific course a logged in user is subscribed to.
  2515. * Shows a link to the course, what's new icons...
  2516. *
  2517. * $my_course['d'] - course directory
  2518. * $my_course['i'] - course title
  2519. * $my_course['c'] - visual course code
  2520. * $my_course['k'] - system course code
  2521. * $my_course['db'] - course database
  2522. *
  2523. * @param array Course details
  2524. * @param integer Session ID
  2525. * @param string CSS class to apply to course entry
  2526. * @param boolean Whether the session is supposedly accessible now (not in the case it has passed and is in invisible/unaccessible mode)
  2527. * @return string The HTML to be printed for the course entry
  2528. *
  2529. * @version 1.0.3
  2530. * @todo refactor into different functions for database calls | logic | display
  2531. * @todo replace single-character $my_course['d'] indices
  2532. * @todo move code for what's new icons to a separate function to clear things up
  2533. * @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.
  2534. */
  2535. function get_logged_user_course_html($course, $session_id = 0, $class = 'courses', $session_accessible = true) {
  2536. global $nosession, $nbDigestEntries, $digest, $thisCourseSysCode, $orderKey;
  2537. $charset = api_get_system_encoding();
  2538. $current_uid = api_get_user_id();
  2539. $info = api_get_course_info($course['code']);
  2540. $status_course = CourseManager::get_user_in_course_status($current_uid, $course['code']);
  2541. if (!is_array($course['code'])) {
  2542. $my_course = api_get_course_info($course['code']);
  2543. $my_course['k'] = $my_course['id'];
  2544. $my_course['db'] = $my_course['dbName'];
  2545. $my_course['c'] = $my_course['official_code'];
  2546. $my_course['i'] = $my_course['name'];
  2547. $my_course['d'] = $my_course['path'];
  2548. $my_course['t'] = $my_course['titular'];
  2549. $my_course['id_session'] = $session_id;
  2550. $my_course['status'] = empty($session_id) ? $status_course : 5;
  2551. }
  2552. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2553. global $now, $date_start, $date_end;
  2554. }
  2555. // Initialise.
  2556. $result = '';
  2557. // Table definitions
  2558. //$statistic_database = Database::get_statistic_database();
  2559. $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
  2560. $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
  2561. $tbl_session_category = Database :: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  2562. $course_database = $my_course['db'];
  2563. $course_tool_table = Database :: get_course_table(TABLE_TOOL_LIST, $course_database);
  2564. $tool_edit_table = Database :: get_course_table(TABLE_ITEM_PROPERTY, $course_database);
  2565. $course_group_user_table = Database :: get_course_table(TOOL_USER, $course_database);
  2566. $user_id = api_get_user_id();
  2567. $course_system_code = $my_course['k'];
  2568. $course_visual_code = $my_course['c'];
  2569. $course_title = $my_course['i'];
  2570. $course_directory = $my_course['d'];
  2571. $course_teacher = $my_course['t'];
  2572. $course_teacher_email = isset($my_course['email']) ? $my_course['email'] : '';
  2573. $course_info = Database :: get_course_info($course_system_code);
  2574. $course_access_settings = CourseManager :: get_access_settings($course_system_code);
  2575. $course_id = isset($course_info['course_id']) ? $course_info['course_id'] : null;
  2576. $course_visibility = $course_access_settings['visibility'];
  2577. $user_in_course_status = CourseManager :: get_user_in_course_status(api_get_user_id(), $course_system_code);
  2578. // Function logic - act on the data.
  2579. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($my_course['k']);
  2580. if ($is_virtual_course) {
  2581. // If the current user is also subscribed in the real course to which this
  2582. // virtual course is linked, we don't need to display the virtual course entry in
  2583. // the course list - it is combined with the real course entry.
  2584. $target_course_code = CourseManager :: get_target_of_linked_course($course_system_code);
  2585. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2586. if ($is_subscribed_in_target_course) {
  2587. return; //do not display this course entry
  2588. }
  2589. }
  2590. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course_system_code, api_get_user_id());
  2591. if ($has_virtual_courses) {
  2592. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2593. $course_display_title = $return_result['title'];
  2594. $course_display_code = $return_result['code'];
  2595. } else {
  2596. $course_display_title = $course_title;
  2597. $course_display_code = $course_visual_code;
  2598. }
  2599. $s_course_status = $my_course['status'];
  2600. $is_coach = api_is_coach($my_course['id_session'],$course['code']);
  2601. $s_htlm_status_icon = Display::return_icon('blackboard_blue.png', get_lang('Course'), array('width' => '48px'));
  2602. /*
  2603. if ($s_course_status == 1) {
  2604. $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;'));
  2605. }
  2606. if ($s_course_status == 2 || ($is_coach && $s_course_status != 1)) {
  2607. $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;'));
  2608. }
  2609. if (($s_course_status == 5 && !$is_coach) || empty($s_course_status)) {
  2610. $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;'));
  2611. }
  2612. */
  2613. // Display course entry.
  2614. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2615. $session_url = '';
  2616. $session_title = '';
  2617. if ($session_accessible) {
  2618. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $user_in_course_status == COURSEMANAGER) {
  2619. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2620. if (empty($my_course['id_session'])) {
  2621. $my_course['id_session'] = 0;
  2622. }
  2623. if ($user_in_course_status == COURSEMANAGER || ($date_start <= $now && $date_end >= $now) || $date_start == '0000-00-00') {
  2624. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'];
  2625. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'].'">'.$course_display_title.'</a>';
  2626. }
  2627. } else {
  2628. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/';
  2629. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/">'.$course_display_title.'</a>';
  2630. }
  2631. } else {
  2632. $session_title = $course_display_title.' '.Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2633. }
  2634. } else {
  2635. $session_title = $course_display_title;
  2636. }
  2637. if (!empty($session_url)) {
  2638. $s_htlm_status_icon = Display::url($s_htlm_status_icon, $session_url);
  2639. }
  2640. $result .= '<li class="'.$class.'"><div class="coursestatusicons">'.$s_htlm_status_icon.'</div>';
  2641. $result .= $session_title;
  2642. // Show the course_code and teacher if chosen to display this.
  2643. if (api_get_setting('display_coursecode_in_courselist') == 'true' || api_get_setting('display_teacher_in_courselist') == 'true') {
  2644. $result .= '<br />';
  2645. }
  2646. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2647. $result .= $course_display_code;
  2648. }
  2649. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2650. if (api_get_setting('use_session_mode')=='true' && !$nosession) {
  2651. $coachs_course = api_get_coachs_from_course($my_course['id_session'], $course['code']);
  2652. $course_coachs = array();
  2653. if (is_array($coachs_course)) {
  2654. foreach ($coachs_course as $coach_course) {
  2655. $course_coachs[] = api_get_person_name($coach_course['firstname'], $coach_course['lastname']);
  2656. }
  2657. }
  2658. if ($s_course_status == 1 || ($s_course_status == 5 && empty($my_course['id_session'])) || empty($s_course_status)) {
  2659. $result .= $course_teacher;
  2660. }
  2661. if (($s_course_status == 5 && !empty($my_course['id_session'])) || ($is_coach && $s_course_status != 1)) {
  2662. if (is_array($course_coachs) && count($course_coachs)> 0 ) {
  2663. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2664. $result .= ' &ndash; ';
  2665. }
  2666. $result .= get_lang('Coachs').': '.implode(', ',$course_coachs);
  2667. }
  2668. }
  2669. } else {
  2670. $result .= $course_teacher;
  2671. }
  2672. if(!empty($course_teacher_email)) {
  2673. $result .= ' ('.$course_teacher_email.')';
  2674. }
  2675. }
  2676. $result .= isset($course['special_course']) ? ' '.Display::return_icon('klipper.png', get_lang('CourseAutoRegister')) : '';
  2677. $current_course_settings = CourseManager :: get_access_settings($my_course['k']);
  2678. // Display the "what's new" icons.
  2679. $result .= Display :: show_notification($my_course);
  2680. if ((CONFVAL_showExtractInfo == SCRIPTVAL_InCourseList || CONFVAL_showExtractInfo == SCRIPTVAL_Both) && $nbDigestEntries > 0) {
  2681. reset($digest);
  2682. $result .= '
  2683. <ul>';
  2684. while (list($key2) = each($digest[$thisCourseSysCode])) {
  2685. $result .= '<li>';
  2686. if ($orderKey[1] == 'keyTools') {
  2687. $result .= "<a href=\"$toolsList[$key2] [\"path\"] $thisCourseSysCode \">";
  2688. $result .= "$toolsList[$key2][\"name\"]</a>";
  2689. } else {
  2690. $result .= api_convert_and_format_date($key2, DATE_FORMAT_LONG, date_default_timezone_get());
  2691. }
  2692. $result .= '</li>';
  2693. $result .= '<ul>';
  2694. reset ($digest[$thisCourseSysCode][$key2]);
  2695. while (list ($key3, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2])) {
  2696. $result .= '<li>';
  2697. if ($orderKey[2] == 'keyTools') {
  2698. $result .= "<a href=\"$toolsList[$key3] [\"path\"] $thisCourseSysCode \">";
  2699. $result .= "$toolsList[$key3][\"name\"]</a>";
  2700. } else {
  2701. $result .= api_convert_and_format_date($key3, DATE_FORMAT_LONG, date_default_timezone_get());
  2702. }
  2703. $result .= '<ul compact="compact">';
  2704. reset($digest[$thisCourseSysCode][$key2][$key3]);
  2705. while (list ($key4, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2][$key3])) {
  2706. $result .= '<li>';
  2707. $result .= @htmlspecialchars(api_substr(strip_tags($dataFromCourse), 0, CONFVAL_NB_CHAR_FROM_CONTENT), ENT_QUOTES, $charset);
  2708. $result .= '</li>';
  2709. }
  2710. $result .= '</ul>';
  2711. $result .= '</li>';
  2712. }
  2713. $result .= '</ul>';
  2714. $result .= '</li>';
  2715. }
  2716. $result .= '</ul>';
  2717. }
  2718. $result .= '</li>';
  2719. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2720. $session = '';
  2721. $active = false;
  2722. if (!empty($my_course['session_name'])) {
  2723. // Request for the name of the general coach
  2724. $sql = 'SELECT lastname, firstname,sc.name
  2725. FROM '.$tbl_session.' ts
  2726. LEFT JOIN '.$main_user_table .' tu
  2727. ON ts.id_coach = tu.user_id
  2728. INNER JOIN '.$tbl_session_category.' sc ON ts.session_category_id = sc.id
  2729. WHERE ts.id='.(int) $my_course['id_session']. ' LIMIT 1';
  2730. $rs = Database::query($sql);
  2731. $sessioncoach = Database::store_result($rs);
  2732. $sessioncoach = $sessioncoach[0];
  2733. $session = array();
  2734. $session['title'] = $my_course['session_name'];
  2735. $session_category_id = CourseManager::get_session_category_id_by_session_id($my_course['id_session']);
  2736. $session['category'] = $sessioncoach['name'];
  2737. if ($my_course['date_start'] == '0000-00-00') {
  2738. //$session['dates'] = get_lang('WithoutTimeLimits');
  2739. $session['dates'] = '';
  2740. if (api_get_setting('show_session_coach') === 'true') {
  2741. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2742. }
  2743. $active = true;
  2744. } else {
  2745. $session ['dates'] = ' - '.get_lang('From').' '.$my_course['date_start'].' '.get_lang('To').' '.$my_course['date_end'];
  2746. if (api_get_setting('show_session_coach') === 'true') {
  2747. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2748. }
  2749. $active = ($date_start <= $now && $date_end >= $now);
  2750. }
  2751. }
  2752. $output = array ($my_course['user_course_cat'], $result, $my_course['id_session'], $session, 'active' => $active, 'session_category_id' => $session_category_id);
  2753. } else {
  2754. $output = array ($my_course['user_course_cat'], $result);
  2755. }
  2756. return $output;
  2757. }
  2758. /**
  2759. *
  2760. * @param string source course code
  2761. * @param int source session id
  2762. * @param string destination course code
  2763. * @param int destination session id
  2764. * @return bool
  2765. */
  2766. function copy_course($source_course_code, $source_session_id, $destination_course_code, $destination_session_id) {
  2767. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseBuilder.class.php';
  2768. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseRestorer.class.php';
  2769. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseSelectForm.class.php';
  2770. $course_info = api_get_course_info($source_course_code);
  2771. if (!empty($course_info)) {
  2772. $cb = new CourseBuilder('', $course_info);
  2773. $course = $cb->build($source_session_id, $source_course_code, true);
  2774. $course_restorer = new CourseRestorer($course);
  2775. $course_restorer->restore($destination_course_code, $destination_session_id, true, true);
  2776. return true;
  2777. }
  2778. return false;
  2779. }
  2780. /**
  2781. * A simpler version of the copy_course, the function creates an empty course
  2782. *
  2783. * @param string course title
  2784. * @param string source course code
  2785. * @param int source session id
  2786. * @return
  2787. */
  2788. function copy_course_simple($new_title, $source_course_code, $source_session_id = 0, $destination_session_id = 0) {
  2789. $source_course_info = api_get_course_info($source_course_code);
  2790. if (!empty($source_course_info)) {
  2791. $new_course_code = self::generate_nice_next_course_code($source_course_code);
  2792. if ($new_course_code) {
  2793. $new_course_info = self::create_course($new_title, $new_course_code, false);
  2794. if (!empty($new_course_info['code'])) {
  2795. $result = self::copy_course($source_course_code, $source_session_id, $new_course_info['code'], $destination_session_id);
  2796. if ($result) {
  2797. return $new_course_info;
  2798. }
  2799. }
  2800. }
  2801. }
  2802. return false;
  2803. }
  2804. /**
  2805. * Creates a new course code based in given code
  2806. *
  2807. * @param string wanted code
  2808. * @example $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3
  2809. * if the course code doest not exist in the DB the same course code will be returned
  2810. * @return string wanted unused code
  2811. */
  2812. function generate_nice_next_course_code($wanted_code) {
  2813. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2814. $course_code_ok = !self::course_code_exists($wanted_code);
  2815. if (!$course_code_ok) {
  2816. $wanted_code = generate_course_code($wanted_code);
  2817. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  2818. $wanted_code = Database::escape_string($wanted_code);
  2819. $sql = "SELECT count(*) as count FROM $table WHERE code LIKE '$wanted_code%'";
  2820. $result = Database::query($sql);
  2821. if (Database::num_rows($result) > 0 ) {
  2822. $row = Database::fetch_array($result);
  2823. $count = $row['count'] + 1;
  2824. $wanted_code = $wanted_code.'_'.$count;
  2825. $result = api_get_course_info($wanted_code);
  2826. if (empty($result)) {
  2827. return $wanted_code;
  2828. }
  2829. }
  2830. return false;
  2831. }
  2832. return $wanted_code;
  2833. }
  2834. /**
  2835. * Creates a course very fast (the function doesn't need a lot of parameters)
  2836. *
  2837. * @param string course title
  2838. * @param bool add example content or not
  2839. * @param mixed false if the course was not created, array with the course info
  2840. *
  2841. Coded found in create_course/add_course.php
  2842. */
  2843. function create_course($title, $wanted_code = '', $exemplary_content = false) {
  2844. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2845. global $_configuration, $firstExpirationDelay;
  2846. if (empty($title)) {
  2847. return false;
  2848. }
  2849. if (empty($wanted_code)) {
  2850. $wanted_code = $title;
  2851. // Check whether the requested course code has already been occupied.
  2852. $dbnamelength = strlen($_configuration['db_prefix']);
  2853. // Ensure the database prefix + database name do not get over 40 characters.
  2854. $maxlength = 40 - $dbnamelength;
  2855. $wanted_code = generate_course_code(api_substr($title, 0, $maxlength));
  2856. }
  2857. // Create the course immediately
  2858. $keys = define_course_keys($wanted_code, '', $_configuration['db_prefix']);
  2859. if (count($keys)) {
  2860. $visual_code = $keys['currentCourseCode'];
  2861. $code = $keys['currentCourseId'];
  2862. $db_name = $keys['currentCourseDbName'];
  2863. $directory = $keys['currentCourseRepository'];
  2864. $code_info = api_get_course_info($code);
  2865. if (empty($code_info)) {
  2866. $expiration_date = time() + $firstExpirationDelay;
  2867. prepare_course_repository($directory, $code);
  2868. update_Db_course($db_name);
  2869. $pictures_array = fill_course_repository($directory, $exemplary_content);
  2870. fill_Db_course($db_name, $directory, $course_language, $pictures_array, $exemplary_content);
  2871. $course_language = api_get_setting('platformLanguage');
  2872. $result = register_course($code, $visual_code, $directory, $db_name, '', '', $title, $course_language, api_get_user_id(), $expiration_date);
  2873. $course_info = api_get_course_info($code);
  2874. if (!empty($course_info)) {
  2875. return $course_info;
  2876. }
  2877. }
  2878. }
  2879. return false;
  2880. }
  2881. } //end class CourseManager