course.lib.php 157 KB

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