course.lib.php 174 KB

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