course.lib.php 172 KB

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