course.lib.php 172 KB

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