course.lib.php 160 KB

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