course.lib.php 160 KB

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