course.lib.php 171 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723
  1. <?php
  2. /* For licensing terms, see /license.txt*/
  3. /**
  4. * This is the course library for Chamilo.
  5. *
  6. * All main course functions should be placed here.
  7. *
  8. * Many functions of this library deal with providing support for
  9. * virtual/linked/combined courses (this was already used in several universities
  10. * but not available in standard Chamilo).
  11. *
  12. * The implementation changed, initially a course was a real course
  13. * if target_course_code was 0 , this was changed to NULL.
  14. * There are probably some places left with the wrong code.
  15. *
  16. * @package chamilo.library
  17. */
  18. /**
  19. DOCUMENTATION
  20. (list not up to date, you can auto generate documentation with phpDocumentor)
  21. CourseManager::get_real_course_code_select_html($element_name, $has_size=true, $only_current_user_courses=true)
  22. CourseManager::check_parameter($parameter, $error_message)
  23. CourseManager::check_parameter_or_fail($parameter, $error_message)
  24. CourseManager::course_code_exists($wanted_course_code)
  25. CourseManager::get_real_course_list()
  26. CourseManager::get_virtual_course_list()
  27. GENERAL COURSE FUNCTIONS
  28. CourseManager::get_access_settings($course_code)
  29. CourseManager::set_course_tool_visibility($tool_table_id, $visibility)
  30. CourseManager::get_user_in_course_status($user_id, $course_code)
  31. CourseManager::add_user_to_course($user_id, $course_code)
  32. CourseManager::get_virtual_course_info($real_course_code)
  33. CourseManager::is_virtual_course_from_visual_code($visual_code)
  34. CourseManager::is_virtual_course_from_system_code($system_code)
  35. CourseManager::get_virtual_courses_linked_to_real_course($real_course_code)
  36. CourseManager::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)
  37. CourseManager::has_virtual_courses_from_code($real_course_code, $user_id)
  38. CourseManager::get_target_of_linked_course($virtual_course_code)
  39. TITLE AND CODE FUNCTIONS
  40. CourseManager::determine_course_title_from_course_info($user_id, $course_info)
  41. CourseManager::create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list)
  42. CourseManager::create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list)
  43. USER FUNCTIONS
  44. CourseManager::get_real_course_list_of_user_as_course_admin($user_id)
  45. CourseManager::get_course_list_of_user_as_course_admin($user_id)
  46. CourseManager::is_user_subscribed_in_course($user_id, $course_code)
  47. CourseManager::is_user_subscribed_in_real_or_linked_course($user_id, $course_code)
  48. CourseManager::get_user_list_from_course_code($course_code)
  49. CourseManager::get_real_and_linked_user_list($course_code);
  50. GROUP FUNCTIONS
  51. CourseManager::get_group_list_of_course($course_code)
  52. CREATION FUNCTIONS
  53. CourseManager::attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
  54. */
  55. /* INIT SECTION */
  56. /**
  57. * Configuration files
  58. */
  59. require_once api_get_path(CONFIGURATION_PATH).'add_course.conf.php';
  60. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  61. /**
  62. * Constants definition
  63. */
  64. //LOGIC: course visibility and registration settings
  65. /*
  66. COURSE VISIBILITY
  67. MAPPING OLD SETTINGS TO NEW SETTINGS
  68. -----------------------
  69. NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED
  70. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_NOT_ALLOWED
  71. NOT_VISIBLE_SUBSCRIPTION_ALLOWED
  72. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_ALLOWED
  73. VISIBLE_SUBSCRIPTION_ALLOWED
  74. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_ALLOWED
  75. VISIBLE_NO_SUBSCRIPTION_ALLOWED
  76. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_NOT_ALLOWED
  77. */
  78. //OLD SETTINGS
  79. define('NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED', 0);
  80. define('NOT_VISIBLE_SUBSCRIPTION_ALLOWED', 1);
  81. define('VISIBLE_SUBSCRIPTION_ALLOWED', 2);
  82. define('VISIBLE_NO_SUBSCRIPTION_ALLOWED', 3);
  83. /**
  84. * Variables
  85. */
  86. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  87. $TABLECOURSDOMAIN = Database::get_main_table(TABLE_MAIN_CATEGORY);
  88. $TABLEUSER = Database::get_main_table(TABLE_MAIN_USER);
  89. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  90. $TABLEANNOUNCEMENTS = 'announcement';
  91. $coursesRepositories = $_configuration['root_sys'];
  92. /**
  93. * CourseManager Class
  94. * @package chamilo.library
  95. */
  96. class CourseManager {
  97. var $columns = array();
  98. /**
  99. * Creates a course
  100. * @param array with the columns in the main.course table
  101. * @param mixed false if the course was not created, array with the course info
  102. */
  103. function create_course($params) {
  104. global $_configuration;
  105. if (empty($params['title'])) {
  106. return false;
  107. }
  108. if (empty($params['wanted_code'])) {
  109. $params['wanted_code'] = $params['title'];
  110. // Check whether the requested course code has already been occupied.
  111. $dbnamelength = strlen($_configuration['db_prefix']);
  112. // Ensure the database prefix + database name do not get over 40 characters.
  113. $maxlength = 40 - $dbnamelength;
  114. $params['wanted_code'] = generate_course_code(api_substr($params['title'], 0, $maxlength));
  115. }
  116. // Create the course immediately
  117. $keys = define_course_keys($params['wanted_code']);
  118. $params['exemplary_content'] = isset($params['exemplary_content']) ? $params['exemplary_content'] : false;
  119. if (count($keys)) {
  120. $params['code'] = $keys['currentCourseCode'];
  121. $params['visual_code'] = $keys['currentCourseId'];
  122. $params['directory'] = $keys['currentCourseRepository'];
  123. $course_info = api_get_course_info($params['code']);
  124. if (empty($course_info)) {
  125. $course_id = register_course($params);
  126. $course_info = api_get_course_info_by_id($course_id);
  127. if (!empty($course_info)) {
  128. prepare_course_repository($course_info['directory'], $course_info['code']);
  129. $pictures_array = fill_course_repository($course_info['directory'], $params['exemplary_content']);
  130. fill_Db_course($course_id, $course_info['directory'], $course_info['course_language'], $pictures_array, $params['exemplary_content']);
  131. self::update_course_ranking($course_info['real_id'], 0);
  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, course.id as real_id
  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, course.id as real_id
  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, $session_id = null) {
  852. $user_id = intval($user_id);
  853. if (empty($session_id)) {
  854. $session_id = api_get_session_id();
  855. } else {
  856. $session_id = intval($session_id);
  857. }
  858. $condition_course = '';
  859. if (isset($course_code)) {
  860. $course_code = Database::escape_string($course_code);
  861. $condition_course = ' AND course_code = "'.$course_code.'" ';
  862. }
  863. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  864. WHERE user_id = $user_id AND relation_type<>".COURSE_RELATION_TYPE_RRHH." $condition_course "));
  865. if (!empty($result)) {
  866. return true; // The user has been registered in this course.
  867. }
  868. if (!$in_a_session) {
  869. return false; // The user has not been registered in this course.
  870. }
  871. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  872. ' WHERE id_user = '.$user_id.' '.$condition_course.' ')) > 0) {
  873. return true;
  874. }
  875. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  876. ' WHERE id_user = '.$user_id.' AND status=2 '.$condition_course.' ')) > 0) {
  877. return true;
  878. }
  879. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  880. ' WHERE id='.$session_id.' AND id_coach='.$user_id)) > 0) {
  881. return true;
  882. }
  883. return false;
  884. }
  885. /**
  886. * Is the user a teacher in the given course?
  887. *
  888. * @param $user_id, the id (int) of the user
  889. * @param $course_code, the course code
  890. *
  891. * @return true if the user is a teacher in the course, false otherwise
  892. */
  893. public static function is_course_teacher($user_id, $course_code) {
  894. if ($user_id != strval(intval($user_id))) {
  895. return false;
  896. }
  897. $sql_result = Database::query('SELECT status FROM '.Database::get_main_table(TABLE_MAIN_COURSE_USER).
  898. ' WHERE course_code="'.Database::escape_string($course_code).'" and user_id="'.$user_id.'"');
  899. if (Database::num_rows($sql_result) > 0) {
  900. return Database::result($sql_result, 0, 'status') == 1;
  901. }
  902. return false;
  903. }
  904. /**
  905. * Is the user subscribed in the real course or linked courses?
  906. *
  907. * @param int the id of the user
  908. * @param array info about the course (comes from course table, see database lib)
  909. *
  910. * @return true if the user is registered in the real course or linked courses, false otherwise
  911. */
  912. public static function is_user_subscribed_in_real_or_linked_course ($user_id, $course_code, $session_id = '') {
  913. if ($user_id != strval(intval($user_id))) {
  914. return false;
  915. }
  916. $course_code = Database::escape_string($course_code);
  917. if ($session_id == '') {
  918. $result = Database::fetch_array(Database::query("SELECT *
  919. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  920. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  921. ON course.code = course_user.course_code
  922. 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')"));
  923. return !empty($result);
  924. }
  925. // From here we trust session id.
  926. // Is he/she subscribed to the session's course?
  927. // A user?
  928. if (Database::num_rows(Database::query("SELECT id_user
  929. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  930. WHERE id_session='".$_SESSION['id_session']."'
  931. AND id_user='$user_id'"))) {
  932. return true;
  933. }
  934. // A course coach?
  935. if (Database::num_rows(Database::query("SELECT id_user
  936. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  937. WHERE id_session='".$_SESSION['id_session']."'
  938. AND id_user = '$user_id' AND status = 2
  939. AND course_code='$course_code'"))) {
  940. return true;
  941. }
  942. // A session coach?
  943. if (Database::num_rows(Database::query("SELECT id_coach
  944. FROM ".Database::get_main_table(TABLE_MAIN_SESSION)." AS session
  945. WHERE session.id='".$_SESSION['id_session']."'
  946. AND id_coach='$user_id'"))) {
  947. return true;
  948. }
  949. return false;
  950. }
  951. /**
  952. * Return user info array of all users registered in the specified real or virtual course
  953. * This only returns the users that are registered in this actual course, not linked courses.
  954. *
  955. * @param string $course_code the code of the course
  956. * @param boolean $with_session determines if the course is used in a session or not
  957. * @param integer $session_id the id of the session
  958. * @param string $limit the LIMIT statement of the sql statement
  959. * @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 ...
  960. * @return array
  961. */
  962. public static function get_user_list_from_course_code($course_code, $session_id = 0, $limit = '', $order_by = '') {
  963. // variable initialisation
  964. $session_id = intval($session_id);
  965. $course_code = Database::escape_string($course_code);
  966. $where = array();
  967. // if the $order_by does not contain 'ORDER BY' we have to check if it is a valid field that can be sorted on
  968. if (!strstr($order_by,'ORDER BY')) {
  969. if (!empty($order_by) AND in_array($order_by, array('lastname', 'firstname', 'username', 'email', 'official_code'))){
  970. $order_by = 'ORDER BY user.'.$order_by;
  971. } else {
  972. $order_by = '';
  973. }
  974. }
  975. $sql = $session_id == 0
  976. ? 'SELECT DISTINCT course_rel_user.status as status_rel, user.user_id, course_rel_user.role, course_rel_user.tutor_id, user.* '
  977. : 'SELECT DISTINCT user.user_id, session_course_user.status as status_session, user.* ';
  978. $sql .= ' FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  979. if (!empty($session_id)) {
  980. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  981. ON user.user_id = session_course_user.id_user
  982. AND session_course_user.course_code="'.$course_code.'"
  983. AND session_course_user.id_session = '.$session_id;
  984. $where[] = ' session_course_user.course_code IS NOT NULL ';
  985. } else {
  986. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  987. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  988. AND course_rel_user.course_code="'.$course_code.'"';
  989. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  990. }
  991. $multiple_access_url = api_get_multiple_access_url();
  992. if ($multiple_access_url) {
  993. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  994. }
  995. $sql .= ' WHERE '.implode(' OR ', $where);
  996. if ($multiple_access_url) {
  997. $current_access_url_id = api_get_current_access_url_id();
  998. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  999. }
  1000. $sql .= ' '.$order_by.' '.$limit;
  1001. $rs = Database::query($sql);
  1002. $users = array();
  1003. if (Database::num_rows($rs)) {
  1004. while ($user = Database::fetch_array($rs)) {
  1005. //$user_info = Database::get_user_info_from_id($user['user_id']);
  1006. $user_info = $user;
  1007. $user_info['status'] = $user['status'];
  1008. if (isset($user['role'])) {
  1009. $user_info['role'] = $user['role'];
  1010. }
  1011. if (isset($user['tutor_id'])) {
  1012. $user_info['tutor_id'] = $user['tutor_id'];
  1013. }
  1014. if (!empty($session_id)) {
  1015. $user_info['status_session'] = $user['status_session'];
  1016. }
  1017. $users[$user['user_id']] = $user_info;
  1018. }
  1019. }
  1020. return $users;
  1021. }
  1022. /**
  1023. * Gets subscribed users in a course or in a course/session
  1024. *
  1025. * @param string $course_code
  1026. * @param int $session_id
  1027. * @return int
  1028. */
  1029. public static function get_users_count_in_course($course_code, $session_id = 0) {
  1030. // variable initialisation
  1031. $session_id = intval($session_id);
  1032. $course_code = Database::escape_string($course_code);
  1033. $sql .= 'SELECT DISTINCT count(*) as count FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  1034. $where = array();
  1035. if (!empty($session_id)) {
  1036. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  1037. ON user.user_id = session_course_user.id_user
  1038. AND session_course_user.course_code = "'.$course_code.'"
  1039. AND session_course_user.id_session = '.$session_id;
  1040. $where[] = ' session_course_user.course_code IS NOT NULL ';
  1041. } else {
  1042. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  1043. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  1044. AND course_rel_user.course_code="'.$course_code.'"';
  1045. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  1046. }
  1047. $multiple_access_url = api_get_multiple_access_url();
  1048. if ($multiple_access_url) {
  1049. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  1050. }
  1051. $sql .= ' WHERE '.implode(' OR ', $where);
  1052. if ($multiple_access_url) {
  1053. $current_access_url_id = api_get_current_access_url_id();
  1054. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  1055. }
  1056. $rs = Database::query($sql);
  1057. $users = array();
  1058. $count = 0;
  1059. if (Database::num_rows($rs)) {
  1060. $user = Database::fetch_array($rs);
  1061. $count = $user['count'];
  1062. }
  1063. return $count;
  1064. }
  1065. /**
  1066. * Get a list of coaches of a course and a session
  1067. * @param string Course code
  1068. * @param int Session ID
  1069. * @return array List of users
  1070. */
  1071. public static function get_coach_list_from_course_code($course_code, $session_id) {
  1072. if ($session_id != strval(intval($session_id))) {
  1073. return array();
  1074. }
  1075. $course_code = Database::escape_string($course_code);
  1076. $users = array();
  1077. // We get the coach for the given course in a given session.
  1078. $rs = Database::query('SELECT id_user FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  1079. ' WHERE id_session="'.$session_id.'" AND course_code="'.$course_code.'" AND status = 2');
  1080. while ($user = Database::fetch_array($rs)) {
  1081. $user_info = Database::get_user_info_from_id($user['id_user']);
  1082. $user_info['status'] = $user['status'];
  1083. $user_info['role'] = $user['role'];
  1084. $user_info['tutor_id'] = $user['tutor_id'];
  1085. $user_info['email'] = $user['email'];
  1086. $users[$user['id_user']] = $user_info;
  1087. }
  1088. // We get the session coach.
  1089. $rs = Database::query('SELECT id_coach FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  1090. ' WHERE id="'.$session_id.'"');
  1091. $user_info = array();
  1092. $session_id_coach = Database::result($rs, 0, 'id_coach');
  1093. $user_info = Database::get_user_info_from_id($session_id_coach);
  1094. $user_info['status'] = $user['status'];
  1095. $user_info['role'] = $user['role'];
  1096. $user_info['tutor_id'] = $user['tutor_id'];
  1097. $user_info['email'] = $user['email'];
  1098. $users[$session_id_coach] = $user_info;
  1099. return $users;
  1100. }
  1101. /**
  1102. * Return user info array of all users registered in the specified real or virtual course
  1103. * This only returns the users that are registered in this actual course, not linked courses.
  1104. *
  1105. * @param string $course_code
  1106. * @param boolean $full list to true if we want sessions students too
  1107. * @return array with user id
  1108. */
  1109. public static function get_student_list_from_course_code($course_code, $with_session = false, $session_id = 0) {
  1110. $session_id = intval($session_id);
  1111. $course_code = Database::escape_string($course_code);
  1112. $students = array();
  1113. if ($session_id == 0) {
  1114. // students directly subscribed to the course
  1115. $rs = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1116. WHERE course_code = '$course_code' AND status = 5");
  1117. while ($student = Database::fetch_array($rs)) {
  1118. $students[$student['user_id']] = $student;
  1119. }
  1120. }
  1121. // students subscribed to the course through a session
  1122. if (api_get_setting('use_session_mode') == 'true' && $with_session) {
  1123. $sql_query = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE course_code = '$course_code' AND status<>2";
  1124. if ($session_id != 0) {
  1125. $sql_query .= ' AND id_session = '.$session_id;
  1126. }
  1127. $rs = Database::query($sql_query);
  1128. while($student = Database::fetch_array($rs)) {
  1129. $students[$student['id_user']] = $student;
  1130. }
  1131. }
  1132. return $students;
  1133. }
  1134. /**
  1135. * Return user info array of all teacher-users registered in the specified real or virtual course
  1136. * This only returns the users that are registered in this actual course, not linked courses.
  1137. *
  1138. * @param string $course_code
  1139. * @return array with user id
  1140. */
  1141. public static function get_teacher_list_from_course_code($course_code) {
  1142. $course_code = Database::escape_string($course_code);
  1143. // teachers directly subscribed to the course
  1144. $teachers = array();
  1145. // TODO: This query is not optimal.
  1146. $rs = Database::query("SELECT u.user_id, u.lastname, u.firstname, u.email, u.username, u.status " .
  1147. "FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." cu, ".Database::get_main_table(TABLE_MAIN_USER)." u ".
  1148. "WHERE cu.course_code = '$course_code' " .
  1149. "AND cu.status = 1 " .
  1150. "AND cu.user_id = u.user_id");
  1151. while ($teacher = Database::fetch_array($rs)) {
  1152. $teachers[$teacher['user_id']] = $teacher;
  1153. }
  1154. return $teachers;
  1155. }
  1156. public static function get_teacher_list_from_course_code_to_string($course_code) {
  1157. $teacher_list = self::get_teacher_list_from_course_code($course_code);
  1158. $teacher_string = '';
  1159. $list = array();
  1160. if (!empty($teacher_list)) {
  1161. foreach($teacher_list as $teacher) {
  1162. $list[]= api_get_person_name($teacher['firstname'], $teacher['lastname']);
  1163. }
  1164. if (!empty($list)) {
  1165. $teacher_string = implode (', ', $list);
  1166. }
  1167. }
  1168. return $teacher_string;
  1169. }
  1170. function get_coach_list_from_course_code_to_string($course_code, $session_id) {
  1171. $tutor_data = '';
  1172. if ($session_id != 0) {
  1173. $coaches = self::get_email_of_tutor_to_session($session_id, $course_code);
  1174. $coach_list = array();
  1175. foreach ($coaches as $coach) {
  1176. $coach_list[] = $coach['complete_name'];
  1177. }
  1178. if (!empty($coach_list)) {
  1179. $tutor_data = implode (', ', $coach_list);
  1180. }
  1181. }
  1182. return $tutor_data;
  1183. }
  1184. /**
  1185. * Return user info array of all users registered in the specified course
  1186. * this includes the users of the course itsel and the users of all linked courses.
  1187. *
  1188. * @param array $course_info
  1189. * @return array with user info
  1190. */
  1191. public static function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id = 0) {
  1192. //get list of virtual courses
  1193. $virtual_course_list = self::get_virtual_courses_linked_to_real_course($course_code);
  1194. //get users from real course
  1195. $user_list = self::get_user_list_from_course_code($course_code, $session_id);
  1196. foreach ($user_list as $this_user) {
  1197. $complete_user_list[] = $this_user;
  1198. }
  1199. //get users from linked courses
  1200. foreach ($virtual_course_list as $this_course) {
  1201. $course_code = $this_course['code'];
  1202. $user_list = self::get_user_list_from_course_code($course_code, $session_id);
  1203. foreach ($user_list as $this_user) {
  1204. $complete_user_list[] = $this_user;
  1205. }
  1206. }
  1207. return $complete_user_list;
  1208. }
  1209. /**
  1210. * Return an array of arrays, listing course info of all courses in the list
  1211. * linked to the real course $real_course_code, to which the user $user_id is subscribed.
  1212. *
  1213. * @param $user_id, the id (int) of the user
  1214. * @param $real_course_code, the id (char) of the real course
  1215. *
  1216. * @return array of course info arrays
  1217. */
  1218. public static function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $course_code) {
  1219. $result_array = array();
  1220. if ($user_id != strval(intval($user_id))) {
  1221. return $result_array;
  1222. }
  1223. $course_code = Database::escape_string($course_code);
  1224. $sql = "SELECT *
  1225. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  1226. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  1227. ON course.code = course_user.course_code
  1228. WHERE course.target_course_code = '$course_code' AND course_user.user_id = '$user_id' AND course_user.relation_type<>".COURSE_RELATION_TYPE_RRHH." ";
  1229. $sql_result = Database::query($sql);
  1230. while ($result = Database::fetch_array($sql_result)) {
  1231. $result_array[] = $result;
  1232. }
  1233. return $result_array;
  1234. }
  1235. /*
  1236. GROUP FUNCTIONS
  1237. */
  1238. /**
  1239. * Get the list of groups from the course
  1240. * @param string Course code
  1241. * @param int Session ID (optional)
  1242. * @return array List of groups info
  1243. */
  1244. public static function get_group_list_of_course($course_code, $session_id = 0) {
  1245. $course_info = Database::get_course_info($course_code);
  1246. $course_id = $course_info['real_id'];
  1247. $group_list = array();
  1248. $session_id != 0 ? $session_condition = ' WHERE g.session_id IN(1,'.intval($session_id).')' : $session_condition = ' WHERE g.session_id = 0';
  1249. $sql = "SELECT g.id, g.name, COUNT(gu.id) userNb
  1250. FROM ".Database::get_course_table(TABLE_GROUP)." AS g
  1251. LEFT JOIN ".Database::get_course_table(TABLE_GROUP_USER)." gu
  1252. ON g.id = gu.group_id
  1253. $session_condition AND
  1254. g.c_id = $course_id
  1255. GROUP BY g.id
  1256. ORDER BY g.name";
  1257. $result = Database::query($sql);
  1258. while ($group_data = Database::fetch_array($result)) {
  1259. $group_list[$group_data['id']] = $group_data;
  1260. }
  1261. return $group_list;
  1262. }
  1263. /**
  1264. * Checks all parameters needed to create a virtual course.
  1265. * If they are all set, the virtual course creation procedure is called.
  1266. *
  1267. * Call this function instead of create_virtual_course
  1268. * @param string Course code
  1269. * @param string Course title
  1270. * @param string Wanted course code
  1271. * @param string Course language
  1272. * @param string Course category
  1273. * @return bool True on success, false on error
  1274. */
  1275. public static function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1276. //better: create parameter list, check the entire list, when false display errormessage
  1277. self::check_parameter_or_fail($real_course_code, 'Unspecified parameter: real course id.');
  1278. self::check_parameter_or_fail($course_title, 'Unspecified parameter: course title.');
  1279. self::check_parameter_or_fail($wanted_course_code, 'Unspecified parameter: wanted course code.');
  1280. self::check_parameter_or_fail($course_language, 'Unspecified parameter: course language.');
  1281. self::check_parameter_or_fail($course_category, 'Unspecified parameter: course category.');
  1282. return self::create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
  1283. }
  1284. /**
  1285. * This function creates a virtual course.
  1286. * It assumes all parameters have been checked and are not empty.
  1287. * It checks wether a course with the $wanted_course_code already exists.
  1288. *
  1289. * Users of this library should consider this function private,
  1290. * please call attempt_create_virtual_course instead of this one.
  1291. *
  1292. * note: The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
  1293. * @param string Course code
  1294. * @param string Course title
  1295. * @param string Wanted course code
  1296. * @param string Course language
  1297. * @param string Course category
  1298. * @return true if the course creation succeeded, false otherwise
  1299. * @todo research: expiration date of a course
  1300. */
  1301. public static function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1302. global $firstExpirationDelay;
  1303. $user_id = api_get_user_id();
  1304. $real_course_info = Database::get_course_info($real_course_code);
  1305. $real_course_code = $real_course_info['system_code'];
  1306. //check: virtual course creation fails if another course has the same
  1307. //code, real or fake.
  1308. if (self::course_code_exists($wanted_course_code)) {
  1309. Display::display_error_message($wanted_course_code.' - '.get_lang('CourseCodeAlreadyExists'));
  1310. return false;
  1311. }
  1312. //add data to course table, course_rel_user
  1313. $course_sys_code = $wanted_course_code;
  1314. $course_screen_code = $wanted_course_code;
  1315. $course_repository = $real_course_info['directory'];
  1316. $course_db_name = $real_course_info['db_name'];
  1317. $responsible_teacher = $real_course_info['tutor_name'];
  1318. $faculty_shortname = $course_category;
  1319. // $course_title = $course_title;
  1320. // $course_language = $course_language;
  1321. $teacher_id = $user_id;
  1322. //HACK ----------------------------------------------------------------
  1323. $expiration_date = time() + $firstExpirationDelay;
  1324. //END HACK ------------------------------------------------------------
  1325. 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);
  1326. //above was the normal course creation table update call,
  1327. //now one more thing: fill in the target_course_code field
  1328. Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_COURSE)." SET target_course_code = '$real_course_code'
  1329. WHERE code = '".Database::escape_string($course_sys_code)."' LIMIT 1 ");
  1330. return true;
  1331. }
  1332. /**
  1333. * Delete a course
  1334. * This function deletes a whole course-area from the platform. When the
  1335. * given course is a virtual course, the database and directory will not be
  1336. * deleted.
  1337. * When the given course is a real course, also all virtual courses refering
  1338. * to the given course will be deleted.
  1339. * Considering the fact that we remove all traces of the course in the main
  1340. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1341. * so that a new course created with this code would not use the remains of an older
  1342. * course.
  1343. *
  1344. * @param string The code of the course to delete
  1345. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1346. * course from the groups in the real course if they are not subscribed in
  1347. * that real course.
  1348. * @todo Remove globals
  1349. */
  1350. public static function delete_course($code) {
  1351. global $_configuration;
  1352. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1353. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1354. $table_course_class = Database::get_main_table(TABLE_MAIN_COURSE_CLASS);
  1355. $user_role_table = Database::get_main_table(MAIN_USER_ROLE_TABLE);
  1356. $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
  1357. $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
  1358. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1359. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1360. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1361. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1362. $table_course_survey_question_option= Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1363. $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1364. $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1365. $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
  1366. $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1367. $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1368. $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1369. $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1370. $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1371. $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1372. $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1373. $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1374. $code = Database::escape_string($code);
  1375. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1376. $res = Database::query($sql);
  1377. if (Database::num_rows($res) == 0) {
  1378. return;
  1379. }
  1380. $this_course = Database::fetch_array($res);
  1381. $db_name = $this_course['db_name'];
  1382. self::create_database_dump($code);
  1383. if (!self::is_virtual_course_from_system_code($code)) {
  1384. // If this is not a virtual course, look for virtual courses that depend on this one, if any
  1385. $virtual_courses = self::get_virtual_courses_linked_to_real_course($code);
  1386. foreach ($virtual_courses as $index => $virtual_course) {
  1387. // Unsubscribe all classes from the virtual course
  1388. $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
  1389. Database::query($sql);
  1390. // Unsubscribe all users from the virtual course
  1391. $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
  1392. Database::query($sql);
  1393. // Delete the course from the sessions tables
  1394. $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
  1395. Database::query($sql);
  1396. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
  1397. Database::query($sql);
  1398. // Delete the course from the survey tables
  1399. $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
  1400. Database::query($sql);
  1401. $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
  1402. Database::query($sql);
  1403. $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
  1404. Database::query($sql);
  1405. // Delete the course from the stats tables
  1406. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
  1407. Database::query($sql);
  1408. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
  1409. Database::query($sql);
  1410. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
  1411. Database::query($sql);
  1412. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
  1413. Database::query($sql);
  1414. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
  1415. Database::query($sql);
  1416. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
  1417. Database::query($sql);
  1418. $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
  1419. Database::query($sql);
  1420. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
  1421. Database::query($sql);
  1422. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
  1423. Database::query($sql);
  1424. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
  1425. Database::query($sql);
  1426. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
  1427. Database::query($sql);
  1428. // Delete the course from the course table
  1429. $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
  1430. Database::query($sql);
  1431. }
  1432. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1433. $res = Database::query($sql);
  1434. $course = Database::fetch_array($res);
  1435. $course_tables = get_course_tables();
  1436. //Cleaning c_x tables
  1437. if (!empty($course['id'])) {
  1438. foreach($course_tables as $table) {
  1439. $table = Database::get_course_table($table);
  1440. $sql = "DELETE FROM $table WHERE c_id = {$course['id']} ";
  1441. Database::query($sql);
  1442. }
  1443. }
  1444. $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
  1445. $archive_dir = api_get_path(SYS_ARCHIVE_PATH).$course['directory'].'_'.time();
  1446. if (is_dir($course_dir)) {
  1447. rename($course_dir, $archive_dir);
  1448. }
  1449. }
  1450. // Unsubscribe all classes from the course
  1451. $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1452. Database::query($sql);
  1453. // Unsubscribe all users from the course
  1454. $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
  1455. Database::query($sql);
  1456. // Delete the course from the sessions tables
  1457. $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
  1458. Database::query($sql);
  1459. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
  1460. Database::query($sql);
  1461. $sql = 'SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
  1462. $result_surveys = Database::query($sql);
  1463. while($surveys = Database::fetch_array($result_surveys)) {
  1464. $survey_id = $surveys[0];
  1465. $sql = 'DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
  1466. Database::query($sql);
  1467. $sql = 'DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
  1468. Database::query($sql);
  1469. $sql = 'DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
  1470. Database::query($sql);
  1471. }
  1472. // Delete the course from the stats tables
  1473. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
  1474. Database::query($sql);
  1475. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
  1476. Database::query($sql);
  1477. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
  1478. Database::query($sql);
  1479. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
  1480. Database::query($sql);
  1481. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
  1482. Database::query($sql);
  1483. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
  1484. Database::query($sql);
  1485. $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
  1486. Database::query($sql);
  1487. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
  1488. Database::query($sql);
  1489. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
  1490. Database::query($sql);
  1491. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
  1492. Database::query($sql);
  1493. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
  1494. Database::query($sql);
  1495. global $_configuration;
  1496. if ($_configuration['multiple_access_urls']) {
  1497. require_once api_get_path(LIBRARY_PATH).'urlmanager.lib.php';
  1498. $url_id = 1;
  1499. if (api_get_current_access_url_id() != -1) {
  1500. $url_id = api_get_current_access_url_id();
  1501. }
  1502. UrlManager::delete_url_rel_course($code, $url_id);
  1503. }
  1504. // Delete the course from the database
  1505. $sql = "DELETE FROM $table_course WHERE code='".$code."'";
  1506. Database::query($sql);
  1507. // delete extra course fields
  1508. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1509. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1510. $sql = "SELECT distinct field_id FROM $t_cfv WHERE course_code = '$code'";
  1511. $res_field_ids = @Database::query($sql);
  1512. while($row_field_id = Database::fetch_row($res_field_ids)){
  1513. $field_ids[] = $row_field_id[0];
  1514. }
  1515. //delete from table_course_field_value from a given course_code
  1516. $sql_course_field_value = "DELETE FROM $t_cfv WHERE course_code = '$code'";
  1517. @Database::query($sql_course_field_value);
  1518. $sql = "SELECT distinct field_id FROM $t_cfv";
  1519. $res_field_all_ids = @Database::query($sql);
  1520. while($row_field_all_id = Database::fetch_row($res_field_all_ids)){
  1521. $field_all_ids[] = $row_field_all_id[0];
  1522. }
  1523. if (is_array($field_ids) && count($field_ids) > 0) {
  1524. foreach ($field_ids as $field_id) {
  1525. // check if field id is used into table field value
  1526. if (is_array($field_all_ids)) {
  1527. if (in_array($field_id, $field_all_ids)) {
  1528. continue;
  1529. } else {
  1530. $sql_course_field = "DELETE FROM $t_cf WHERE id = '$field_id'";
  1531. Database::query($sql_course_field);
  1532. }
  1533. }
  1534. }
  1535. }
  1536. // Add event to system log
  1537. $user_id = api_get_user_id();
  1538. event_system(LOG_COURSE_DELETE, LOG_COURSE_CODE, $code, api_get_utc_datetime(), $user_id, $code);
  1539. }
  1540. /**
  1541. * Creates a file called mysql_dump.sql in the course folder
  1542. * @param $course_code The code of the course
  1543. * @todo Implementation for single database
  1544. */
  1545. public static function create_database_dump($course_code) {
  1546. global $_configuration;
  1547. if ($_configuration['single_database']) {
  1548. return;
  1549. }
  1550. $sql_dump = '';
  1551. $course_code = Database::escape_string($course_code);
  1552. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1553. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  1554. $res = Database::query($sql);
  1555. $course = Database::fetch_array($res);
  1556. $course_tables = get_course_tables();
  1557. if (!empty($course['id'])) {
  1558. //Cleaning c_x tables
  1559. foreach($course_tables as $table) {
  1560. $table = Database::get_course_table($table);
  1561. $sql = "SELECT * FROM $table WHERE c_id = {$course['id']} ";
  1562. $res_table = Database::query($sql);
  1563. while ($row = Database::fetch_array($res_table, 'ASSOC')) {
  1564. $row_to_save = array();
  1565. foreach ($row as $key => $value) {
  1566. $row_to_save[$key] = $key."='".Database::escape_string($row[$key])."'";
  1567. }
  1568. $sql_dump .= "\nINSERT INTO $table SET ".implode(', ', $row_to_save).';';
  1569. }
  1570. }
  1571. }
  1572. if (is_dir(api_get_path(SYS_COURSE_PATH).$course['directory'])) {
  1573. $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
  1574. $handle = fopen($file_name, 'a+');
  1575. if ($handle !== false) {
  1576. fwrite($handle, $sql_dump);
  1577. fclose($handle);
  1578. } else {
  1579. //TODO trigger exception in a try-catch
  1580. }
  1581. }
  1582. }
  1583. /**
  1584. * Sort courses for a specific user ??
  1585. * @param int User ID
  1586. * @param string Course code
  1587. * @return int Minimum course order
  1588. * @todo Review documentation
  1589. */
  1590. public static function userCourseSort($user_id, $course_code) {
  1591. if ($user_id != strval(intval($user_id))) {
  1592. return false;
  1593. }
  1594. $course_code = Database::escape_string($course_code);
  1595. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  1596. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1597. $course_title = Database::result(Database::query('SELECT title FROM '.$TABLECOURSE.
  1598. ' WHERE code="'.$course_code.'"'), 0, 0);
  1599. $result = Database::query('SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
  1600. WHERE course.code = cu.course_code
  1601. AND user_id = "'.$user_id.'"
  1602. AND cu.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  1603. AND user_course_cat=0 ORDER BY cu.sort');
  1604. $course_title_precedent = '';
  1605. $counter = 0;
  1606. $course_found = false;
  1607. $course_sort = 1;
  1608. while ($courses = Database::fetch_array($result)){
  1609. if ($course_title_precedent == '') {
  1610. $course_title_precedent = $courses['title'];
  1611. }
  1612. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  1613. $course_found = true;
  1614. $course_sort = $courses['sort'];
  1615. if ($counter == 0) {
  1616. $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.'"';
  1617. $course_sort++;
  1618. } else {
  1619. $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.'"';
  1620. }
  1621. Database::query($sql);
  1622. break;
  1623. } else {
  1624. $course_title_precedent = $courses['title'];
  1625. }
  1626. $counter++;
  1627. }
  1628. // We must register the course in the beginning of the list
  1629. if (Database::num_rows($result) > 0 && !$course_found) {
  1630. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.
  1631. ' WHERE user_id="'.$user_id.'" AND user_course_cat="0"'), 0, 0);
  1632. Database::query('UPDATE '.$TABLECOURSUSER.' SET sort = sort+1
  1633. WHERE user_id= "'.$user_id.'" AND user_course_cat="0"');
  1634. }
  1635. return $course_sort;
  1636. }
  1637. /**
  1638. * create recursively all categories as option of the select passed in paramater.
  1639. *
  1640. * @param object $select_element the quickform select where the options will be added
  1641. * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
  1642. * @param string $parent_code the parent category of the categories added (default=null for root category)
  1643. * @param string $padding the indent param (you shouldn't indicate something here)
  1644. */
  1645. public static function select_and_sort_categories($select_element, $category_selected_code = '', $parent_code = null , $padding = '') {
  1646. $sql = "SELECT code, name, auth_course_child, auth_cat_child
  1647. FROM ".Database::get_main_table(TABLE_MAIN_CATEGORY)."
  1648. WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
  1649. ORDER BY code";
  1650. $res = Database::query($sql);
  1651. while ($cat = Database::fetch_array($res)) {
  1652. $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
  1653. $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
  1654. $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
  1655. if ($cat['auth_cat_child']) {
  1656. self::select_and_sort_categories($select_element, $category_selected_code, $cat['code'], $padding.' - ');
  1657. }
  1658. }
  1659. }
  1660. /**
  1661. * check if course exists
  1662. * @param string course_code
  1663. * @param string whether to accept virtual course codes or not
  1664. * @return true if exists, false else
  1665. */
  1666. public static function course_exists($course_code, $accept_virtual = false) {
  1667. if ($accept_virtual === true) {
  1668. $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).'"';
  1669. } else {
  1670. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'"';
  1671. }
  1672. return Database::num_rows(Database::query($sql));
  1673. }
  1674. /**
  1675. * Send an email to tutor after the auth-suscription of a student in your course
  1676. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1677. * @param int $user_id the id of the user
  1678. * @param string $course_code the course code
  1679. * @param string $send_to_tutor_also
  1680. * @return string we return the message that is displayed when the action is succesfull
  1681. */
  1682. public static function email_to_tutor($user_id, $course_code, $send_to_tutor_also = false) {
  1683. if ($user_id != strval(intval($user_id))) {
  1684. return false;
  1685. }
  1686. $course_code = Database::escape_string($course_code);
  1687. $student = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1688. WHERE user_id='".$user_id."'"));
  1689. $information = self::get_course_information($course_code);
  1690. $name_course = $information['title'];
  1691. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." WHERE course_code='".$course_code."'";
  1692. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  1693. //if ($send_to_tutor_also = true) {
  1694. // Proposed change:
  1695. if ($send_to_tutor_also) {
  1696. //
  1697. $sql .= " AND tutor_id=1";
  1698. } else {
  1699. $sql .= " AND status=1";
  1700. }
  1701. $result = Database::query($sql);
  1702. while ($row = Database::fetch_array($result)) {
  1703. $tutor = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1704. WHERE user_id='".$row['user_id']."'"));
  1705. $emailto = $tutor['email'];
  1706. $emailsubject = get_lang('NewUserInTheCourse').': '.$name_course;
  1707. $emailbody = get_lang('Dear').': '. api_get_person_name($tutor['firstname'], $tutor['lastname'])."\n";
  1708. $emailbody .= get_lang('MessageNewUserInTheCourse').': '.$name_course."\n";
  1709. $emailbody .= get_lang('UserName').': '.$student['username']."\n";
  1710. if (api_is_western_name_order()) {
  1711. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1712. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1713. } else {
  1714. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1715. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1716. }
  1717. $emailbody .= get_lang('Email').': '.$student['email']."\n\n";
  1718. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1719. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  1720. $email_admin = api_get_setting('emailAdministrator');
  1721. @api_mail($recipient_name, $emailto, $emailsubject, $emailbody, $sender_name,$email_admin);
  1722. }
  1723. }
  1724. public static function get_special_course_list() {
  1725. $tbl_course_field = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD);
  1726. $tbl_course_field_value = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1727. //we filter the courses from the URL
  1728. $join_access_url = $where_access_url='';
  1729. if (api_get_multiple_access_url()) {
  1730. $access_url_id = api_get_current_access_url_id();
  1731. if ($access_url_id != -1) {
  1732. $tbl_url_course = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  1733. $join_access_url= "LEFT JOIN $tbl_url_course url_rel_course ON url_rel_course.course_code= tcfv.course_code ";
  1734. $where_access_url =" AND access_url_id = $access_url_id ";
  1735. }
  1736. }
  1737. // get course list auto-register
  1738. $sql = "SELECT DISTINCT(tcfv.course_code) FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf
  1739. ON tcfv.field_id = tcf.id $join_access_url
  1740. WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 $where_access_url";
  1741. $special_course_result = Database::query($sql);
  1742. $special_course_list = array();
  1743. if (Database::num_rows($special_course_result)>0) {
  1744. $special_course_list = array();
  1745. while ($result_row = Database::fetch_array($special_course_result)) {
  1746. $special_course_list[] = $result_row['course_code'];
  1747. }
  1748. }
  1749. return $special_course_list;
  1750. }
  1751. /**
  1752. * Get list of courses for a given user
  1753. * @param int user ID
  1754. * @param boolean Whether to include courses from session or not
  1755. * @return array List of codes and db names
  1756. * @author isaac flores paz
  1757. */
  1758. public static function get_courses_list_by_user_id($user_id, $include_sessions = false) {
  1759. $user_id = intval($user_id);
  1760. $course_list = array();
  1761. $codes = array();
  1762. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1763. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1764. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  1765. $special_course_list = self::get_special_course_list();
  1766. $with_special_courses = $without_special_courses = '';
  1767. if (!empty($special_course_list)) {
  1768. $sc_string = '"'.implode('","',$special_course_list).'"';
  1769. $with_special_courses = ' course.code IN ('.$sc_string.')';
  1770. $without_special_courses = ' AND course.code NOT IN ('.$sc_string.')';
  1771. }
  1772. if (!empty($with_special_courses)) {
  1773. $sql = "SELECT DISTINCT(course.code), course.db_name db_name, course.title , course.id as course_id, course.id as real_id
  1774. FROM ".$tbl_course_user." course_rel_user
  1775. LEFT JOIN ".$tbl_course." course
  1776. ON course.code = course_rel_user.course_code
  1777. LEFT JOIN ".$tbl_user_course_category." user_course_category
  1778. ON course_rel_user.user_course_cat = user_course_category.id
  1779. WHERE $with_special_courses
  1780. GROUP BY course.code
  1781. ORDER BY user_course_category.sort,course.title,course_rel_user.sort ASC";
  1782. $rs_special_course = Database::query($sql);
  1783. if (Database::num_rows($rs_special_course) > 0) {
  1784. while ($result_row = Database::fetch_array($rs_special_course)) {
  1785. $result_row['special_course'] = 1;
  1786. $course_list[] = $result_row;
  1787. $codes[] = $result_row['code'];
  1788. }
  1789. }
  1790. }
  1791. // get course list not auto-register. Use Distinct to avoid multiple
  1792. // entries when a course is assigned to a HRD (DRH) as watcher
  1793. $sql = "SELECT DISTINCT(course.code),course.db_name,course.title , course.id as course_id, course.id as real_id
  1794. FROM $tbl_course course
  1795. INNER JOIN $tbl_course_user cru
  1796. ON course.code=cru.course_code
  1797. WHERE cru.user_id='$user_id' $without_special_courses";
  1798. $result = Database::query($sql);
  1799. if (Database::num_rows($result)) {
  1800. while ($row = Database::fetch_array($result, 'ASSOC')) {
  1801. $course_list[] = $row;
  1802. $codes[] = $row['code'];
  1803. }
  1804. }
  1805. if ($include_sessions === true) {
  1806. $r = Database::query("SELECT DISTINCT(c.code), c.db_name, c.title, c.id as course_id, c.id as real_id
  1807. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." s, ".Database::get_main_table(TABLE_MAIN_COURSE)." c
  1808. WHERE id_user = $user_id AND s.course_code=c.code");
  1809. while ($row = Database::fetch_array($r, 'ASSOC')) {
  1810. if (!in_array($row['code'], $codes)) {
  1811. $course_list[] = $row;
  1812. }
  1813. }
  1814. }
  1815. return $course_list;
  1816. }
  1817. /**
  1818. * Get course ID from a given course directory name
  1819. * @param string Course directory (without any slash)
  1820. * @return string Course code, or false if not found
  1821. */
  1822. public static function get_course_id_from_path ($path) {
  1823. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  1824. $res = Database::query("SELECT code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1825. WHERE directory LIKE BINARY '$path'");
  1826. if ($res === false) {
  1827. return false;
  1828. }
  1829. if (Database::num_rows($res) != 1) {
  1830. return false;
  1831. }
  1832. $row = Database::fetch_array($res);
  1833. return $row['code'];
  1834. }
  1835. /**
  1836. * Get course code(s) from visual code
  1837. * @param string Visual code
  1838. * @return array List of codes for the given visual code
  1839. */
  1840. public static function get_courses_info_from_visual_code($code) {
  1841. $result = array();
  1842. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1843. WHERE visual_code = '".Database::escape_string($code)."'");
  1844. while ($virtual_course = Database::fetch_array($sql_result)) {
  1845. $result[] = $virtual_course;
  1846. }
  1847. return $result;
  1848. }
  1849. /**
  1850. * Get emails of tutors to course
  1851. * @param string Visual code
  1852. * @return array List of emails of tutors to course
  1853. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1854. * */
  1855. public static function get_emails_of_tutors_to_course($code) {
  1856. $list = array();
  1857. $res = Database::query("SELECT user_id FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1858. WHERE course_code='".Database::escape_string($code)."' AND status=1");
  1859. while ($list_users = Database::fetch_array($res)) {
  1860. $result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1861. WHERE user_id=".$list_users['user_id']);
  1862. while ($row_user = Database::fetch_array($result)){
  1863. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1864. $list[] = array($row_user['email'] => $name_teacher);
  1865. }
  1866. }
  1867. return $list;
  1868. }
  1869. /**
  1870. * Get coachs' emails by session
  1871. * @param int session id
  1872. * @param string course code
  1873. * @return array array(email => name_tutor) by coach
  1874. * @author Carlos Vargas <carlos.vargas@dokeos.com>
  1875. */
  1876. public static function get_email_of_tutor_to_session($session_id, $course_code) {
  1877. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1878. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  1879. $coachs_emails = array();
  1880. $course_code = Database::escape_string($course_code);
  1881. $session_id = intval($session_id);
  1882. $sql = "SELECT id_user FROM $tbl_session_course_user WHERE id_session='$session_id' AND course_code='$course_code' AND status =2";
  1883. $rs = Database::query($sql);
  1884. if (Database::num_rows($rs) > 0) {
  1885. $user_ids = array();
  1886. while ($row = Database::fetch_array($rs)) {
  1887. $user_ids[] = $row['id_user'];
  1888. }
  1889. $sql = "SELECT firstname, lastname, email FROM $tbl_user WHERE user_id IN (".implode(",",$user_ids).")";
  1890. $rs_user = Database::query($sql);
  1891. while ($row_emails = Database::fetch_array($rs_user)) {
  1892. //$name_tutor = api_get_person_name($row_emails['firstname'], $row_emails['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1893. $mail_tutor = array('email' => $row_emails['email'], 'complete_name' => api_get_person_name($row_emails['firstname'], $row_emails['lastname']));
  1894. $coachs_emails[] = $mail_tutor;
  1895. }
  1896. }
  1897. return $coachs_emails;
  1898. }
  1899. /**
  1900. * Creates a new extra field for a given course
  1901. * @param string Field's internal variable name
  1902. * @param int Field's type
  1903. * @param string Field's language var name
  1904. * @return int new extra field id
  1905. */
  1906. public static function create_course_extra_field($fieldvarname, $fieldtype, $fieldtitle) {
  1907. // database table definition
  1908. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1909. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1910. $fieldvarname = Database::escape_string($fieldvarname);
  1911. $fieldtitle = Database::escape_string($fieldtitle);
  1912. $fieldtype = (int)$fieldtype;
  1913. $time = time();
  1914. $sql_field = "SELECT id FROM $t_cf WHERE field_variable = '$fieldvarname'";
  1915. $res_field = Database::query($sql_field);
  1916. $r_field = Database::fetch_row($res_field);
  1917. if (Database::num_rows($res_field) > 0) {
  1918. return $r_field[0];
  1919. }
  1920. // save new fieldlabel into course_field table
  1921. $sql = "SELECT MAX(field_order) FROM $t_cf";
  1922. $res = Database::query($sql);
  1923. $order = 0;
  1924. if (Database::num_rows($res) > 0) {
  1925. $row = Database::fetch_row($res);
  1926. $order = $row[0] + 1;
  1927. }
  1928. $sql = "INSERT INTO $t_cf
  1929. SET field_type = '$fieldtype',
  1930. field_variable = '$fieldvarname',
  1931. field_display_text = '$fieldtitle',
  1932. field_order = '$order',
  1933. tms = FROM_UNIXTIME($time)";
  1934. Database::query($sql);
  1935. return Database::insert_id();
  1936. }
  1937. /**
  1938. * Updates course attribute. Note that you need to check that your attribute is valid before you use this function
  1939. *
  1940. * @param int Course id
  1941. * @param string Attribute name
  1942. * @param string Attribute value
  1943. * @return bool True if attribute was successfully updated, false if course was not found or attribute name is invalid
  1944. */
  1945. public static function update_attribute($id, $name, $value) {
  1946. $id = (int)$id;
  1947. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1948. $sql = "UPDATE $table SET $name = '".Database::escape_string($value)."' WHERE id = '$id';";
  1949. return Database::query($sql);
  1950. }
  1951. /**
  1952. * 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
  1953. *
  1954. * @param int Course id
  1955. * @param array Associative array with field names as keys and field values as values
  1956. * @return bool True if update was successful, false otherwise
  1957. */
  1958. public static function update_attributes($id, $attributes) {
  1959. $id = (int)$id;
  1960. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1961. $sql = "UPDATE $table SET ";
  1962. $i = 0;
  1963. foreach($attributes as $name => $value) {
  1964. if($value != '') {
  1965. if($i > 0) {
  1966. $sql .= ", ";
  1967. }
  1968. $sql .= " $name = '".Database::escape_string($value)."'";
  1969. $i++;
  1970. }
  1971. }
  1972. $sql .= " WHERE id = '$id';";
  1973. return Database::query($sql);
  1974. }
  1975. /**
  1976. * Update an extra field value for a given course
  1977. * @param integer Course ID
  1978. * @param string Field variable name
  1979. * @param string Field value
  1980. * @return boolean true if field updated, false otherwise
  1981. */
  1982. public static function update_course_extra_field_value($course_code, $fname, $fvalue = '') {
  1983. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1984. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1985. $fname = Database::escape_string($fname);
  1986. $course_code = Database::escape_string($course_code);
  1987. $fvalues = '';
  1988. if (is_array($fvalue)) {
  1989. foreach ($fvalue as $val) {
  1990. $fvalues .= Database::escape_string($val).';';
  1991. }
  1992. if (!empty($fvalues)) {
  1993. $fvalues = substr($fvalues, 0, -1);
  1994. }
  1995. } else {
  1996. $fvalues = Database::escape_string($fvalue);
  1997. }
  1998. $sqlcf = "SELECT * FROM $t_cf WHERE field_variable='$fname'";
  1999. $rescf = Database::query($sqlcf);
  2000. if (Database::num_rows($rescf) == 1) {
  2001. // Ok, the field exists
  2002. // Check if enumerated field, if the option is available
  2003. $rowcf = Database::fetch_array($rescf);
  2004. $tms = time();
  2005. $sqlcfv = "SELECT * FROM $t_cfv WHERE course_code = '$course_code' AND field_id = '".$rowcf['id']."' ORDER BY id";
  2006. $rescfv = Database::query($sqlcfv);
  2007. $n = Database::num_rows($rescfv);
  2008. if ($n > 1) {
  2009. //problem, we already have to values for this field and user combination - keep last one
  2010. while ($rowcfv = Database::fetch_array($rescfv)) { // See the TODO note below.
  2011. if ($n > 1) {
  2012. $sqld = "DELETE FROM $t_cfv WHERE id = ".$rowcfv['id'];
  2013. $resd = Database::query($sqld);
  2014. $n--;
  2015. }
  2016. $rowcfv = Database::fetch_array($rescfv);
  2017. if ($rowcfv['field_value'] != $fvalues) {
  2018. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  2019. $resu = Database::query($sqlu);
  2020. return ($resu ? true : false);
  2021. }
  2022. 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...
  2023. }
  2024. } elseif ($n == 1) {
  2025. //we need to update the current record
  2026. $rowcfv = Database::fetch_array($rescfv);
  2027. if ($rowcfv['field_value'] != $fvalues) {
  2028. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  2029. //error_log('UM::update_extra_field_value: '.$sqlu);
  2030. $resu = Database::query($sqlu);
  2031. return ($resu ? true : false);
  2032. }
  2033. return true;
  2034. } else {
  2035. $sqli = "INSERT INTO $t_cfv (course_code,field_id,field_value,tms) " .
  2036. "VALUES ('$course_code',".$rowcf['id'].",'$fvalues',FROM_UNIXTIME($tms))";
  2037. //error_log('UM::update_extra_field_value: '.$sqli);
  2038. $resi = Database::query($sqli);
  2039. return ($resi ? true : false);
  2040. }
  2041. } else {
  2042. return false; //field not found
  2043. }
  2044. }
  2045. /**
  2046. * Get the course id of an course by the database name
  2047. * @param string The database name
  2048. * @return string The course id
  2049. */
  2050. public static function get_course_id_by_database_name($db_name) {
  2051. return Database::result(Database::query('SELECT code FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  2052. ' WHERE db_name="'.Database::escape_string($db_name).'"'), 0, 'code');
  2053. }
  2054. public static function get_session_category_id_by_session_id($session_id) {
  2055. return Database::result(Database::query('SELECT sc.id session_category
  2056. FROM '.Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY).' sc
  2057. INNER JOIN '.Database::get_main_table(TABLE_MAIN_SESSION).' s
  2058. ON sc.id=s.session_category_id WHERE s.id="'.Database::escape_string($session_id).'"'),
  2059. 0, 'session_category');
  2060. }
  2061. /**
  2062. * Get the course id of an course by the database name
  2063. * @param string The database name
  2064. * @return string The course id
  2065. */
  2066. public static function get_course_extra_field_list($code) {
  2067. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2068. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2069. $sql_field = "SELECT id, field_type, field_variable, field_display_text, field_default_value
  2070. FROM $tbl_course_field WHERE field_visible = '1' ";
  2071. $res_field = Database::query($sql_field);
  2072. $extra_fields = array();
  2073. while($rowcf = Database::fetch_array($res_field)) {
  2074. $extra_field_id = $rowcf['id'];
  2075. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '$extra_field_id' ";
  2076. $res_field_value = Database::query($sql_field_value);
  2077. if(Database::num_rows($res_field_value) > 0 ) {
  2078. $r_field_value = Database::fetch_row($res_field_value);
  2079. $rowcf['extra_field_value'] = $r_field_value[0];
  2080. }
  2081. $extra_fields[] = $rowcf;
  2082. }
  2083. return $extra_fields;
  2084. }
  2085. /**
  2086. * Gets the value of a course extra field. Returns null if it was not found
  2087. *
  2088. * @param string Name of the extra field
  2089. * @param string Course code
  2090. * @return string Value
  2091. */
  2092. public static function get_course_extra_field_value($field_name, $code) {
  2093. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2094. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2095. $sql = "SELECT id FROM $tbl_course_field WHERE field_visible = '1' AND field_variable = '$field_name';";
  2096. $res = Database::query($sql);
  2097. $row = Database::fetch_object($res);
  2098. if(!$row) {
  2099. return null;
  2100. } else {
  2101. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '{$row->id}';";
  2102. $res_field_value = Database::query($sql_field_value);
  2103. $row_field_value = Database::fetch_object($res_field_value);
  2104. if(!$row_field_value) {
  2105. return null;
  2106. } else {
  2107. return $row_field_value['field_value'];
  2108. }
  2109. }
  2110. }
  2111. /**
  2112. * Get the database name of a course by the code
  2113. * @param string The course code
  2114. * @return string The database name
  2115. */
  2116. public static function get_name_database_course($course_code) {
  2117. return Database::result(Database::query('SELECT db_name FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  2118. ' WHERE code="'.Database::escape_string($course_code).'"'), 0, 'db_name');
  2119. }
  2120. /**
  2121. * Lists details of the course description
  2122. * @param array The course description
  2123. * @param string The encoding
  2124. * @param bool If true is displayed if false is hidden
  2125. * @return string The course description in html
  2126. */
  2127. public static function get_details_course_description_html($descriptions, $charset, $action_show = true) {
  2128. if (isset($descriptions) && count($descriptions) > 0) {
  2129. $data = '';
  2130. foreach ($descriptions as $id => $description) {
  2131. $data .= '<div class="sectiontitle">';
  2132. if (api_is_allowed_to_edit() && $action_show) {
  2133. //delete
  2134. $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;">';
  2135. $data .= Display::return_icon('delete.gif', get_lang('Delete'), array('style' => 'vertical-align:middle;float:right;'));
  2136. $data .= '</a> ';
  2137. //edit
  2138. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;description_id='.$description->id.'">';
  2139. $data .= Display::return_icon('edit.png', get_lang('Edit'), array('style' => 'vertical-align:middle;float:right; padding-right:4px;'), ICON_SIZE_SMALL);
  2140. $data .= '</a> ';
  2141. }
  2142. $data .= $description->title;
  2143. $data .= '</div>';
  2144. $data .= '<div class="sectioncomment">';
  2145. $data .= text_filter($description->content);
  2146. $data .= '</div>';
  2147. }
  2148. } else {
  2149. $data .= '<em>'.get_lang('ThisCourseDescriptionIsEmpty').'</em>';
  2150. }
  2151. return $data;
  2152. }
  2153. /**
  2154. * Returns the details of a course category
  2155. *
  2156. * @param string Category code
  2157. * @return array Course category
  2158. */
  2159. public static function get_course_category($code) {
  2160. $table_categories = Database::get_main_table(TABLE_MAIN_CATEGORY);
  2161. $sql = "SELECT * FROM $table_categories WHERE code = '$code';";
  2162. return Database::fetch_array(Database::query($sql));
  2163. }
  2164. /*
  2165. ==============================================================================
  2166. DEPRECATED METHODS
  2167. ==============================================================================
  2168. */
  2169. /**
  2170. * This code creates a select form element to let the user
  2171. * choose a real course to link to.
  2172. *
  2173. * A good non-display library should not use echo statements, but just return text/html
  2174. * so users of the library can choose when to display.
  2175. *
  2176. * We display the course code, but internally store the course id.
  2177. *
  2178. * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
  2179. * @param boolean $only_current_user_courses, true only the real courses of which the
  2180. * current user is course admin are displayed, false all real courses are shown.
  2181. * @param string $element_name the name of the select element
  2182. * @return a string containing html code for a form select element.
  2183. * @deprecated Function not in use
  2184. */
  2185. public static function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id) {
  2186. if ($only_current_user_courses) {
  2187. $real_course_list = self::get_real_course_list_of_user_as_course_admin($user_id);
  2188. } else {
  2189. $real_course_list = self::get_real_course_list();
  2190. }
  2191. if ($has_size) {
  2192. $size_element = "size=\"".SELECT_BOX_SIZE."\"";
  2193. } else {
  2194. $size_element = "";
  2195. }
  2196. $html_code = "<select name=\"$element_name\" $size_element >\n";
  2197. foreach ($real_course_list as $real_course) {
  2198. $course_code = $real_course["code"];
  2199. $html_code .= "<option value=\"".$course_code."\">";
  2200. $html_code .= $course_code;
  2201. $html_code .= "</option>\n";
  2202. }
  2203. $html_code .= "</select>\n";
  2204. return $html_code;
  2205. }
  2206. /**
  2207. * Get count rows of a table inside a course database
  2208. * @param string The table of which the rows should be counted
  2209. * @param int optionally count rows by session id
  2210. * @return int The number of rows in the given table.
  2211. */
  2212. public static function count_rows_course_table($table, $session_id = '', $course_id = null) {
  2213. $condition_session = '';
  2214. if ($session_id !== '') {
  2215. $session_id = intval($session_id);
  2216. $condition_session = " AND session_id = '$session_id' ";
  2217. }
  2218. if (!empty($course_id)) {
  2219. $course_id = intval($course_id);
  2220. } else {
  2221. $course_id = api_get_course_int_id();
  2222. }
  2223. $condition_session .= " AND c_id = '$course_id' ";
  2224. $sql = "SELECT COUNT(*) AS n FROM $table WHERE 1=1 $condition_session ";
  2225. $rs = Database::query($sql);
  2226. $row = Database::fetch_row($rs);
  2227. return $row[0];
  2228. }
  2229. /**
  2230. * Subscribes courses to human resource manager (Dashboard feature)
  2231. * @param int Human Resource Manager id
  2232. * @param array Courses code
  2233. * @param int Relation type
  2234. **/
  2235. public static function suscribe_courses_to_hr_manager($hr_manager_id,$courses_list) {
  2236. global $_configuration;
  2237. // Database Table Definitions
  2238. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2239. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2240. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2241. $hr_manager_id = intval($hr_manager_id);
  2242. $affected_rows = 0;
  2243. //Deleting assigned courses to hrm_id
  2244. if ($_configuration['multiple_access_urls']) {
  2245. $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()."";
  2246. } else {
  2247. $sql = "SELECT course_code FROM $tbl_course_rel_user WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  2248. }
  2249. $result = Database::query($sql);
  2250. if (Database::num_rows($result) > 0) {
  2251. while ($row = Database::fetch_array($result)) {
  2252. $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." ";
  2253. Database::query($sql);
  2254. }
  2255. }
  2256. // inserting new courses list
  2257. if (is_array($courses_list)) {
  2258. foreach ($courses_list as $course_code) {
  2259. $course_code = Database::escape_string($course_code);
  2260. $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."')";
  2261. Database::query($insert_sql);
  2262. if (Database::affected_rows()) {
  2263. $affected_rows++;
  2264. }
  2265. }
  2266. }
  2267. return $affected_rows;
  2268. }
  2269. /**
  2270. * get courses followed by human resources manager
  2271. * @param int human resources manager id
  2272. * @return array courses
  2273. */
  2274. public static function get_courses_followed_by_drh($hr_dept_id) {
  2275. // Database Table Definitions
  2276. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2277. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2278. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2279. $hr_dept_id = intval($hr_dept_id);
  2280. $assigned_courses_to_hrm = array();
  2281. if (api_get_multiple_access_url()) {
  2282. $sql = "SELECT * FROM $tbl_course c
  2283. 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()."";
  2284. } else {
  2285. $sql = "SELECT * FROM $tbl_course c
  2286. 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."' ";
  2287. }
  2288. $rs_assigned_courses = Database::query($sql);
  2289. if (Database::num_rows($rs_assigned_courses) > 0) {
  2290. while ($row_assigned_courses = Database::fetch_array($rs_assigned_courses)) {
  2291. $assigned_courses_to_hrm[$row_assigned_courses['code']] = $row_assigned_courses;
  2292. }
  2293. }
  2294. return $assigned_courses_to_hrm;
  2295. }
  2296. /**
  2297. * check if a course is special (autoregister)
  2298. * @param string course code
  2299. */
  2300. public static function is_special_course($course_code){
  2301. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2302. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2303. $is_special = false;
  2304. $sql = "SELECT course_code FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf ON " .
  2305. " tcfv.field_id = tcf.id WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 AND course_code='$course_code'";
  2306. $result = Database::query($sql);
  2307. $num_rows = Database::num_rows($result);
  2308. if ($num_rows > 0){
  2309. $is_special = true;
  2310. }
  2311. return $is_special;
  2312. }
  2313. /**
  2314. * Update course picture
  2315. * @param string Course code
  2316. * @param string File name
  2317. * @param string The full system name of the image from which course picture will be created.
  2318. * @return bool Returns the resulting. In case of internal error or negative validation returns FALSE.
  2319. */
  2320. public static function update_course_picture($course_code, $filename, $source_file = null) {
  2321. $course_info = api_get_course_info($course_code);
  2322. $store_path = api_get_path(SYS_COURSE_PATH).$course_info['path']; // course path
  2323. $course_image = $store_path.'/course-pic.png'; // image name for courses
  2324. $course_medium_image = $store_path.'/course-pic85x85.png';
  2325. //$extension = strtolower(substr(strrchr($filename, '.'), 1));
  2326. $result = false;
  2327. if (file_exists($course_image)) {
  2328. @unlink($course_image);
  2329. }
  2330. if (file_exists($course_medium_image)) {
  2331. @unlink($course_medium_image);
  2332. }
  2333. $my_course_image = new Image($source_file);
  2334. $result = $my_course_image->send_image($course_image, -1, 'png');
  2335. //Redimension image to 100x85
  2336. if ($result) {
  2337. $medium = new Image($course_image);
  2338. //$picture_infos = $medium->get_image_size();
  2339. $medium->resize(100, 85, 0, false);
  2340. $medium->send_image($store_path.'/course-pic85x85.png', -1, 'png');
  2341. }
  2342. return $result;
  2343. }
  2344. /**
  2345. * @deprecated See CourseManager::course_code_exists()
  2346. */
  2347. public static function is_existing_course_code($wanted_course_code) {
  2348. return self::course_code_exists($wanted_course_code);
  2349. }
  2350. public function course_item_html($params, $is_sub_content = false) {
  2351. $html = '';
  2352. // $html .= '<div class="span8">';
  2353. $class = "well";
  2354. if ($is_sub_content) {
  2355. $class = "";
  2356. }
  2357. $html .= '<div class="row-fluid">';
  2358. $html .= '<div class="span12">';
  2359. $html .= '<div class="well3">';
  2360. $html .= '<div class="span1">'.$params['icon'].'</div>';
  2361. $html .= '<div class="span8"><h4>'.$params['title'].'</h4></div>';
  2362. $html .= '<div class="span1 pull-right">'.$params['right_actions'].'</div>';
  2363. $html .= '</div>';
  2364. $html .= '</div>';
  2365. $html .= '</div>';
  2366. return $html;
  2367. }
  2368. public function course_item_parent($main_content, $sub_content, $sub_sub_content = null) {
  2369. return '<div class="well2">'.$main_content.$sub_content.$sub_sub_content.'</div>';
  2370. }
  2371. /**
  2372. * Display special courses (and only these) as several HTML divs of class userportal-course-item
  2373. *
  2374. * Special courses are courses that stick on top of the list and are "auto-registerable"
  2375. * in the sense that any user clicking them is registered as a student
  2376. * @param int User id
  2377. * @param bool Whether to show the document quick-loader or not
  2378. * @return void
  2379. */
  2380. function display_special_courses($user_id, $load_dirs = false) {
  2381. $user_id = intval($user_id);
  2382. $user_info = api_get_user_info($user_id);
  2383. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2384. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2385. $special_course_list = self::get_special_course_list();
  2386. $with_special_courses = $without_special_courses = '';
  2387. if (!empty($special_course_list)) {
  2388. $with_special_courses = ' course.code IN ("'.implode('","',$special_course_list).'")';
  2389. }
  2390. if (!empty($with_special_courses)) {
  2391. $sql = "SELECT course.id, course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2392. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2393. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course_rel_user.user_id, course.visibility
  2394. FROM $tbl_course course
  2395. LEFT JOIN $tbl_course_user course_rel_user ON course.code = course_rel_user.course_code AND course_rel_user.user_id = '$user_id'
  2396. WHERE $with_special_courses group by course.code";
  2397. $rs_special_course = Database::query($sql);
  2398. $number_of_courses = Database::num_rows($rs_special_course);
  2399. $key = 0;
  2400. $status_icon = '';
  2401. $html = '';
  2402. if ($number_of_courses > 0) {
  2403. while ($course = Database::fetch_array($rs_special_course)) {
  2404. $params = array();
  2405. // Get notifications.
  2406. $my_course = array();
  2407. $my_course['k'] = $course['code'];
  2408. $my_course['id_session'] = null;
  2409. $my_course['s'] = $course['status'];
  2410. $show_notification = Display::show_notification($my_course);
  2411. if (empty($course['user_id'])) {
  2412. $course['status'] = $user_info['status'];
  2413. }
  2414. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array(), ICON_SIZE_LARGE);
  2415. $params['right_actions'] = '';
  2416. if (api_is_platform_admin()) {
  2417. if ($load_dirs) {
  2418. $params['right_actions'] .= '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void(0);">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2419. $params['right_actions'] .= '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2420. $params['right_actions'] .= Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2421. } else {
  2422. $params['right_actions'] .= '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2423. }
  2424. if ($course['status'] == COURSEMANAGER) {
  2425. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  2426. }
  2427. } else {
  2428. if ($load_dirs) {
  2429. $params['right_actions'] .= '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void(0);">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2430. $params['right_actions'] .= Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2431. }
  2432. }
  2433. $course_visibility = $course['visibility'];
  2434. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2435. $course_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0&amp;autoreg=1">'.$course['title'].'</a>';
  2436. } else {
  2437. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2438. }
  2439. $params['image'] = $status_icon;
  2440. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2441. $course_title .= $course['visual_code'];
  2442. }
  2443. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2444. $course_title .= ' - ';
  2445. }
  2446. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2447. $course_title .= $course['tutor'];
  2448. }
  2449. $course_title .= '&nbsp;';
  2450. $course_title .= Display::return_icon('klipper.png', get_lang('CourseAutoRegister'));
  2451. // Show notifications.
  2452. $course_title .= $show_notification;
  2453. $params['image'] = $course_title;
  2454. $html .= self::course_item_html($params);
  2455. $key++;
  2456. }
  2457. }
  2458. }
  2459. return $html;
  2460. }
  2461. /**
  2462. * Display courses (without special courses) as several HTML divs
  2463. * of course categories, as class userportal-catalog-item.
  2464. * @uses display_courses_in_category() to display the courses themselves
  2465. * @param int user id
  2466. * @param bool Whether to show the document quick-loader or not
  2467. * @return void
  2468. */
  2469. function display_courses($user_id, $load_dirs = false) {
  2470. $user_id = intval($user_id);
  2471. if (empty($user_id)) {
  2472. $user_id = api_get_user_id();
  2473. }
  2474. // Step 0: We display the course without a user category.
  2475. $html = self :: display_courses_in_category(0, $load_dirs);
  2476. // Step 1: We get all the categories of the user.
  2477. $tucc = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2478. $sql = "SELECT id, title FROM $tucc WHERE user_id='".$user_id."' ORDER BY sort ASC";
  2479. $result = Database::query($sql);
  2480. while ($row = Database::fetch_array($result)) {
  2481. $params = array();
  2482. // We simply display the title of the category.
  2483. $params['icon'] = Display::return_icon('folder_yellow.png', get_lang('Category'), array(), ICON_SIZE_LARGE);
  2484. $params['title'] = $row['title'];
  2485. $html .= self::course_item_parent(self::course_item_html($params), self :: display_courses_in_category($row['id'], $load_dirs));
  2486. }
  2487. return $html;
  2488. }
  2489. /**
  2490. * Display courses inside a category (without special courses) as HTML dics of
  2491. * class userportal-course-item.
  2492. * @param int User category id
  2493. * @param bool Whether to show the document quick-loader or not
  2494. * @return void
  2495. */
  2496. function display_courses_in_category($user_category_id, $load_dirs = false) {
  2497. global $_user;
  2498. // Table definitions
  2499. $TABLECOURS = Database :: get_main_table(TABLE_MAIN_COURSE);
  2500. $TABLECOURSUSER = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
  2501. $TABLE_ACCESS_URL_REL_COURSE = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2502. $current_url_id = api_get_current_access_url_id();
  2503. // Get course list auto-register
  2504. $special_course_list = self::get_special_course_list();
  2505. $without_special_courses = '';
  2506. if (!empty($special_course_list)) {
  2507. $without_special_courses = ' AND course.code NOT IN ("'.implode('","',$special_course_list).'")';
  2508. }
  2509. $sql_select_courses = "SELECT course.id, course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2510. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2511. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course.visibility
  2512. FROM $TABLECOURS course,
  2513. $TABLECOURSUSER course_rel_user, ".$TABLE_ACCESS_URL_REL_COURSE." url
  2514. WHERE course.code = course_rel_user.course_code AND url.course_code = course.code
  2515. AND course_rel_user.user_id = '".$_user['user_id']."'
  2516. AND course_rel_user.relation_type<>".COURSE_RELATION_TYPE_RRHH."
  2517. AND course_rel_user.user_course_cat='".$user_category_id."' $without_special_courses ";
  2518. // If multiple URL access mode is enabled, only fetch courses
  2519. // corresponding to the current URL.
  2520. if (api_get_multiple_access_url() && $current_url_id != -1){
  2521. $sql_select_courses .= " AND url.course_code=course.code AND access_url_id='".$current_url_id."'";
  2522. }
  2523. // Use user's classification for courses (if any).
  2524. $sql_select_courses .= " ORDER BY course_rel_user.user_course_cat, course_rel_user.sort ASC";
  2525. $result = Database::query($sql_select_courses);
  2526. //$number_of_courses = Database::num_rows($result);
  2527. $key = 0;
  2528. $status_icon = '';
  2529. $html = '';
  2530. // Browse through all courses.
  2531. while ($course = Database::fetch_array($result)) {
  2532. // Get notifications.
  2533. $my_course = array();
  2534. $my_course['k'] = $course['code'];
  2535. $my_course['id_session'] = null;
  2536. $my_course['s'] = $course['status'];
  2537. // For each course, get if there is any notification icon to show
  2538. // (something that would have changed since the user's last visit).
  2539. $show_notification = Display :: show_notification($my_course);
  2540. // New code displaying the user's status in respect to this course.
  2541. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array(), ICON_SIZE_LARGE);
  2542. $params = array();
  2543. $params['right_actions'] = '';
  2544. if (api_is_platform_admin()) {
  2545. if ($load_dirs) {
  2546. $params['right_actions'] .= '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void(0);">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2547. $params['right_actions'] .= '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2548. $params['right_actions'] .= Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2549. } else {
  2550. $params['right_actions'].= '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2551. }
  2552. if ($course['status'] == COURSEMANAGER) {
  2553. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  2554. }
  2555. } else {
  2556. if ($load_dirs) {
  2557. $params['right_actions'] .= '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void(0);">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2558. $params['right_actions'] .= Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2559. }
  2560. }
  2561. // Function logic - act on the data (check if the course is virtual, if yes change the link).
  2562. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($course['code']);
  2563. if ($is_virtual_course) {
  2564. // If the current user is also subscribed in the real course to which this
  2565. // virtual course is linked, we don't need to display the virtual course entry in
  2566. // the course list - it is combined with the real course entry.
  2567. $target_course_code = CourseManager :: get_target_of_linked_course($course['code']);
  2568. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2569. if ($is_subscribed_in_target_course) {
  2570. return; // Do not display this course entry.
  2571. }
  2572. }
  2573. // Check if the course has virtual courses attached. If yes change the course title and display code.
  2574. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course['code'], api_get_user_id());
  2575. if ($has_virtual_courses) {
  2576. $course_info = api_get_course_info($course['code']);
  2577. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2578. $course_title = $return_result['title'];
  2579. $course_display_code = $return_result['code'];
  2580. } else {
  2581. $course_title = $course['title'];
  2582. $course_display_code = $course['visual_code'];
  2583. }
  2584. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2585. $course_visibility = $course['visibility'];
  2586. $course_title_url = '';
  2587. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2588. $course_title_url = api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0';
  2589. $course_title = Display::url($course['title'], $course_title_url);
  2590. } else {
  2591. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2592. }
  2593. if (!empty($course_title_url)) {
  2594. $status_icon = Display::url($status_icon, $course_title_url);
  2595. }
  2596. // Start displaying the course block itself.
  2597. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2598. $course_title .= $course_display_code;
  2599. }
  2600. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2601. $course_title .= ' - ';
  2602. }
  2603. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2604. if (!empty($course['tutor']))
  2605. $course_title .= $course['tutor'];
  2606. }
  2607. // Show notifications.
  2608. $course_title .= $show_notification;
  2609. $params['icon'] = $status_icon;
  2610. $params['title'] = $course_title;
  2611. $html .= self::course_item_html($params);
  2612. $key++;
  2613. }
  2614. return $html;
  2615. }
  2616. /**
  2617. * Retrieves the user defined course categories
  2618. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  2619. * @return array containing all the titles of the user defined courses with the id as key of the array
  2620. */
  2621. function get_user_course_categories() {
  2622. global $_user;
  2623. $output = array();
  2624. $table_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2625. $sql = "SELECT * FROM ".$table_category." WHERE user_id='".Database::escape_string($_user['user_id'])."'";
  2626. $result = Database::query($sql);
  2627. while ($row = Database::fetch_array($result)) {
  2628. $output[$row['id']] = $row['title'];
  2629. }
  2630. return $output;
  2631. }
  2632. /**
  2633. * Get the course id based on the original id and field name in the extra fields. Returns 0 if course was not found
  2634. *
  2635. * @param string Original course id
  2636. * @param string Original field name
  2637. * @return int Course id
  2638. */
  2639. public static function get_course_id_from_original_id($original_course_id_value, $original_course_id_name) {
  2640. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2641. $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2642. $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'";
  2643. $res = Database::query($sql_course);
  2644. $row = Database::fetch_object($res);
  2645. if($row != false) {
  2646. return $row->id;
  2647. } else {
  2648. return 0;
  2649. }
  2650. }
  2651. /**
  2652. * Display code for one specific course a logged in user is subscribed to.
  2653. * Shows a link to the course, what's new icons...
  2654. *
  2655. * $my_course['d'] - course directory
  2656. * $my_course['i'] - course title
  2657. * $my_course['c'] - visual course code
  2658. * $my_course['k'] - system course code
  2659. * $my_course['db'] - course database
  2660. *
  2661. * @param array Course details
  2662. * @param integer Session ID
  2663. * @param string CSS class to apply to course entry
  2664. * @param boolean Whether the session is supposedly accessible now (not in the case it has passed and is in invisible/unaccessible mode)
  2665. * @param bool Whether to show the document quick-loader or not
  2666. * @return string The HTML to be printed for the course entry
  2667. *
  2668. * @version 1.0.3
  2669. * @todo refactor into different functions for database calls | logic | display
  2670. * @todo replace single-character $my_course['d'] indices
  2671. * @todo move code for what's new icons to a separate function to clear things up
  2672. * @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.
  2673. */
  2674. function get_logged_user_course_html($course, $session_id = 0, $class = 'courses', $session_accessible = true, $load_dirs = false) {
  2675. global $nosession, $nbDigestEntries, $digest, $thisCourseSysCode, $orderKey;
  2676. $charset = api_get_system_encoding();
  2677. $current_uid = api_get_user_id();
  2678. $info = api_get_course_info($course['code']);
  2679. $status_course = CourseManager::get_user_in_course_status($current_uid, $course['code']);
  2680. if (!is_array($course['code'])) {
  2681. $my_course = api_get_course_info($course['code']);
  2682. $my_course['k'] = $my_course['id'];
  2683. $my_course['db'] = $my_course['dbName'];
  2684. $my_course['c'] = $my_course['official_code'];
  2685. $my_course['i'] = $my_course['name'];
  2686. $my_course['d'] = $my_course['path'];
  2687. $my_course['t'] = $my_course['titular'];
  2688. $my_course['id_session'] = $session_id;
  2689. $my_course['status'] = empty($session_id) ? $status_course : 5;
  2690. }
  2691. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2692. global $now, $date_start, $date_end;
  2693. }
  2694. // Initialise.
  2695. $result = '';
  2696. // Table definitions
  2697. $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
  2698. $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
  2699. $tbl_session_category = Database :: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  2700. $user_id = api_get_user_id();
  2701. $course_system_code = $my_course['k'];
  2702. $course_visual_code = $my_course['c'];
  2703. $course_title = $my_course['i'];
  2704. $course_directory = $my_course['d'];
  2705. $course_teacher = $my_course['t'];
  2706. $course_teacher_email = isset($my_course['email']) ? $my_course['email'] : '';
  2707. $course_info = Database :: get_course_info($course_system_code);
  2708. $course_access_settings = CourseManager :: get_access_settings($course_system_code);
  2709. $course_id = isset($course_info['course_id']) ? $course_info['course_id'] : null;
  2710. $course_visibility = $course_access_settings['visibility'];
  2711. $user_in_course_status = CourseManager :: get_user_in_course_status(api_get_user_id(), $course_system_code);
  2712. // Function logic - act on the data.
  2713. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($my_course['k']);
  2714. if ($is_virtual_course) {
  2715. // If the current user is also subscribed in the real course to which this
  2716. // virtual course is linked, we don't need to display the virtual course entry in
  2717. // the course list - it is combined with the real course entry.
  2718. $target_course_code = CourseManager :: get_target_of_linked_course($course_system_code);
  2719. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2720. if ($is_subscribed_in_target_course) {
  2721. return; //do not display this course entry
  2722. }
  2723. }
  2724. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course_system_code, api_get_user_id());
  2725. if ($has_virtual_courses) {
  2726. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2727. $course_display_title = $return_result['title'];
  2728. $course_display_code = $return_result['code'];
  2729. } else {
  2730. $course_display_title = $course_title;
  2731. $course_display_code = $course_visual_code;
  2732. }
  2733. $s_course_status = $my_course['status'];
  2734. $is_coach = api_is_coach($my_course['id_session'], $course['code']);
  2735. $s_htlm_status_icon = Display::return_icon('blackboard_blue.png', get_lang('Course'), array(), ICON_SIZE_LARGE);
  2736. // Display course entry.
  2737. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2738. $session_url = '';
  2739. $session_title = '';
  2740. if ($session_accessible) {
  2741. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $user_in_course_status == COURSEMANAGER) {
  2742. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2743. if (empty($my_course['id_session'])) {
  2744. $my_course['id_session'] = 0;
  2745. }
  2746. if ($user_in_course_status == COURSEMANAGER || ($date_start <= $now && $date_end >= $now) || $date_start == '0000-00-00') {
  2747. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'];
  2748. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'].'">'.$course_display_title.'</a>';
  2749. }
  2750. } else {
  2751. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/';
  2752. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/">'.$course_display_title.'</a>';
  2753. }
  2754. } else {
  2755. $session_title = $course_display_title.' '.Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2756. }
  2757. } else {
  2758. $session_title = $course_display_title;
  2759. }
  2760. if (!empty($session_url)) {
  2761. $s_htlm_status_icon = Display::url($s_htlm_status_icon, $session_url);
  2762. }
  2763. $params = array();
  2764. $params['icon'] = $s_htlm_status_icon;
  2765. $params['title'] = $session_title;
  2766. $params['right_actions'] = '';
  2767. if ($load_dirs) {
  2768. $params['right_actions'] .= '<div style="float:right;">';
  2769. $params['right_actions'] .= '<a id="document_preview_'.$info['real_id'].'_'.$my_course['id_session'].'" class="document_preview" href="javascript:void(0);">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),ICON_SIZE_SMALL).'</a>';
  2770. $params['right_actions'] .= Display::div('', array('id' => 'document_result_'.$info['real_id'].'_'.$my_course['id_session'], 'class'=>'document_preview_container'));
  2771. $params['right_actions'] .= '</div>';
  2772. }
  2773. // Show the course_code and teacher if chosen to display this.
  2774. if (api_get_setting('display_coursecode_in_courselist') == 'true' || api_get_setting('display_teacher_in_courselist') == 'true') {
  2775. $session_title .= '<br />';
  2776. }
  2777. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2778. $session_title .= $course_display_code;
  2779. }
  2780. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2781. if (api_get_setting('use_session_mode')=='true' && !$nosession) {
  2782. $coachs_course = api_get_coachs_from_course($my_course['id_session'], $course['code']);
  2783. $course_coachs = array();
  2784. if (is_array($coachs_course)) {
  2785. foreach ($coachs_course as $coach_course) {
  2786. $course_coachs[] = api_get_person_name($coach_course['firstname'], $coach_course['lastname']);
  2787. }
  2788. }
  2789. if ($s_course_status == 1 || ($s_course_status == 5 && empty($my_course['id_session'])) || empty($s_course_status)) {
  2790. $session_title .= $course_teacher;
  2791. }
  2792. if (($s_course_status == 5 && !empty($my_course['id_session'])) || ($is_coach && $s_course_status != 1)) {
  2793. if (is_array($course_coachs) && count($course_coachs)> 0 ) {
  2794. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2795. $session_title .= ' &ndash; ';
  2796. }
  2797. $session_title .= get_lang('Coachs').': '.implode(', ',$course_coachs);
  2798. }
  2799. }
  2800. } else {
  2801. $session_title .= $course_teacher;
  2802. }
  2803. if(!empty($course_teacher_email)) {
  2804. $session_title .= ' ('.$course_teacher_email.')';
  2805. }
  2806. }
  2807. $session_title .= isset($course['special_course']) ? ' '.Display::return_icon('klipper.png', get_lang('CourseAutoRegister')) : '';
  2808. //$current_course_settings = CourseManager :: get_access_settings($my_course['k']);
  2809. // Display the "what's new" icons.
  2810. $session_title .= Display :: show_notification($my_course);
  2811. $params['title'] = $session_title;
  2812. $params['extra'] = '';
  2813. if ((CONFVAL_showExtractInfo == SCRIPTVAL_InCourseList || CONFVAL_showExtractInfo == SCRIPTVAL_Both) && $nbDigestEntries > 0) {
  2814. reset($digest);
  2815. while (list($key2) = each($digest[$thisCourseSysCode])) {
  2816. $params['extra'] .= '<li>';
  2817. if ($orderKey[1] == 'keyTools') {
  2818. $params['extra'] .= "<a href=\"$toolsList[$key2] [\"path\"] $thisCourseSysCode \">";
  2819. $params['extra'] .= "$toolsList[$key2][\"name\"]</a>";
  2820. } else {
  2821. $params['extra'] .= api_convert_and_format_date($key2, DATE_FORMAT_LONG, date_default_timezone_get());
  2822. }
  2823. $params['extra'] .= '</li>';
  2824. $params['extra'] .= '<ul>';
  2825. reset ($digest[$thisCourseSysCode][$key2]);
  2826. while (list ($key3, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2])) {
  2827. $params['extra'] .= '<li>';
  2828. if ($orderKey[2] == 'keyTools') {
  2829. $params['extra'] .= "<a href=\"$toolsList[$key3] [\"path\"] $thisCourseSysCode \">";
  2830. $params['extra'] .= "$toolsList[$key3][\"name\"]</a>";
  2831. } else {
  2832. $params['extra'] .= api_convert_and_format_date($key3, DATE_FORMAT_LONG, date_default_timezone_get());
  2833. }
  2834. $params['extra'] .= '<ul compact="compact">';
  2835. reset($digest[$thisCourseSysCode][$key2][$key3]);
  2836. while (list ($key4, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2][$key3])) {
  2837. $params['extra'] .= '<li>';
  2838. $params['extra'] .= @htmlspecialchars(api_substr(strip_tags($dataFromCourse), 0, CONFVAL_NB_CHAR_FROM_CONTENT), ENT_QUOTES, $charset);
  2839. $params['extra'] .= '</li>';
  2840. }
  2841. $params['extra'] .= '</ul>';
  2842. $params['extra'] .= '</li>';
  2843. }
  2844. $params['extra'] .= '</ul>';
  2845. $params['extra'] .= '</li>';
  2846. }
  2847. $params['extra'] .= '</ul>';
  2848. }
  2849. $params['extra'] .= '</li>';
  2850. $html = self::course_item_html($params);
  2851. $session_category_id = null;
  2852. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2853. $session = '';
  2854. $active = false;
  2855. if (!empty($my_course['session_name'])) {
  2856. // Request for the name of the general coach
  2857. $sql = 'SELECT lastname, firstname,sc.name
  2858. FROM '.$tbl_session.' ts
  2859. LEFT JOIN '.$main_user_table .' tu
  2860. ON ts.id_coach = tu.user_id
  2861. INNER JOIN '.$tbl_session_category.' sc ON ts.session_category_id = sc.id
  2862. WHERE ts.id='.(int) $my_course['id_session']. ' LIMIT 1';
  2863. $rs = Database::query($sql);
  2864. $sessioncoach = Database::store_result($rs);
  2865. $sessioncoach = $sessioncoach[0];
  2866. $session = array();
  2867. $session['title'] = $my_course['session_name'];
  2868. $session_category_id = CourseManager::get_session_category_id_by_session_id($my_course['id_session']);
  2869. $session['category'] = $sessioncoach['name'];
  2870. if ($my_course['date_start'] == '0000-00-00') {
  2871. //$session['dates'] = get_lang('WithoutTimeLimits');
  2872. $session['dates'] = '';
  2873. if (api_get_setting('show_session_coach') === 'true') {
  2874. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2875. }
  2876. $active = true;
  2877. } else {
  2878. $session ['dates'] = ' - '.get_lang('From').' '.$my_course['date_start'].' '.get_lang('To').' '.$my_course['date_end'];
  2879. if (api_get_setting('show_session_coach') === 'true') {
  2880. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2881. }
  2882. $active = ($date_start <= $now && $date_end >= $now);
  2883. }
  2884. }
  2885. $user_course_category = '';
  2886. if (isset($my_course['user_course_cat'])) {
  2887. $user_course_category = $my_course['user_course_cat'];
  2888. }
  2889. $output = array ($user_course_category, $html, $my_course['id_session'], $session, 'active' => $active, 'session_category_id' => $session_category_id);
  2890. } else {
  2891. $output = array ($my_course['user_course_cat'], $html);
  2892. }
  2893. return $output;
  2894. }
  2895. /**
  2896. *
  2897. * @param string source course code
  2898. * @param int source session id
  2899. * @param string destination course code
  2900. * @param int destination session id
  2901. * @return bool
  2902. */
  2903. function copy_course($source_course_code, $source_session_id, $destination_course_code, $destination_session_id, $params = array()) {
  2904. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseBuilder.class.php';
  2905. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseRestorer.class.php';
  2906. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseSelectForm.class.php';
  2907. $course_info = api_get_course_info($source_course_code);
  2908. if (!empty($course_info)) {
  2909. $cb = new CourseBuilder('', $course_info);
  2910. $course = $cb->build($source_session_id, $source_course_code, true);
  2911. $course_restorer = new CourseRestorer($course);
  2912. $course_restorer->skip_content = $params;
  2913. $course_restorer->restore($destination_course_code, $destination_session_id, true, true);
  2914. return true;
  2915. }
  2916. return false;
  2917. }
  2918. /**
  2919. * A simpler version of the copy_course, the function creates an empty course with an autogenerated course code
  2920. *
  2921. * @param string new course title
  2922. * @param string source course code
  2923. * @param int source session id
  2924. * @param int destination session id
  2925. * @param bool new copied tools (Exercises and LPs)will be set to invisible by default?
  2926. *
  2927. * @return array
  2928. */
  2929. function copy_course_simple($new_title, $source_course_code, $source_session_id = 0, $destination_session_id = 0, $params = array()) {
  2930. $source_course_info = api_get_course_info($source_course_code);
  2931. if (!empty($source_course_info)) {
  2932. $new_course_code = self::generate_nice_next_course_code($source_course_code);
  2933. if ($new_course_code) {
  2934. $new_course_info = self::create_course($new_title, $new_course_code, false);
  2935. if (!empty($new_course_info['code'])) {
  2936. $result = self::copy_course($source_course_code, $source_session_id, $new_course_info['code'], $destination_session_id, $params);
  2937. if ($result) {
  2938. return $new_course_info;
  2939. }
  2940. }
  2941. }
  2942. }
  2943. return false;
  2944. }
  2945. /**
  2946. * Creates a new course code based in given code
  2947. *
  2948. * @param string wanted code
  2949. * <code> $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3</code>
  2950. * if the course code doest not exist in the DB the same course code will be returned
  2951. * @return string wanted unused code
  2952. */
  2953. function generate_nice_next_course_code($wanted_code) {
  2954. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2955. $course_code_ok = !self::course_code_exists($wanted_code);
  2956. if (!$course_code_ok) {
  2957. $wanted_code = generate_course_code($wanted_code);
  2958. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  2959. $wanted_code = Database::escape_string($wanted_code);
  2960. $sql = "SELECT count(*) as count FROM $table WHERE code LIKE '$wanted_code%'";
  2961. $result = Database::query($sql);
  2962. if (Database::num_rows($result) > 0 ) {
  2963. $row = Database::fetch_array($result);
  2964. $count = $row['count'] + 1;
  2965. $wanted_code = $wanted_code.'_'.$count;
  2966. $result = api_get_course_info($wanted_code);
  2967. if (empty($result)) {
  2968. return $wanted_code;
  2969. }
  2970. }
  2971. return false;
  2972. }
  2973. return $wanted_code;
  2974. }
  2975. function is_user_accepted_legal($user_id, $course_code, $session_id = null) {
  2976. $user_id = intval($user_id);
  2977. $course_code = Database::escape_string($course_code);
  2978. $session_id = intval($session_id);
  2979. if (empty($session_id)) {
  2980. $table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2981. $sql = "SELECT legal_agreement FROM $table
  2982. WHERE user_id = $user_id AND course_code ='$course_code' ";
  2983. $result = Database::query($sql);
  2984. if (Database::num_rows($result) > 0 ) {
  2985. $result = Database::fetch_array($result);
  2986. if ($result['legal_agreement'] == 1 ) {
  2987. return true;
  2988. }
  2989. }
  2990. return false;
  2991. } else {
  2992. $table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  2993. $sql = "SELECT legal_agreement FROM $table
  2994. WHERE id_user = $user_id AND course_code ='$course_code' AND id_session = $session_id";
  2995. $result = Database::query($sql);
  2996. if (Database::num_rows($result) > 0 ) {
  2997. $result = Database::fetch_array($result);
  2998. if ($result['legal_agreement'] == 1 ) {
  2999. return true;
  3000. }
  3001. }
  3002. return false;
  3003. }
  3004. return false;
  3005. }
  3006. function save_user_legal($user_id, $course_code, $session_id = null) {
  3007. $user_id = intval($user_id);
  3008. $course_code = Database::escape_string($course_code);
  3009. $session_id = intval($session_id);
  3010. if (empty($session_id)) {
  3011. $table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  3012. $sql = "UPDATE $table SET legal_agreement = '1'
  3013. WHERE user_id = $user_id AND course_code ='$course_code' ";
  3014. $result = Database::query($sql);
  3015. } else {
  3016. $table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  3017. $sql = "UPDATE $table SET legal_agreement = '1'
  3018. WHERE id_user = $user_id AND course_code = '$course_code' AND id_session = $session_id";
  3019. $result = Database::query($sql);
  3020. }
  3021. }
  3022. public function get_user_course_vote($user_id, $course_id, $session_id = null, $url_id = null) {
  3023. $table_user_course_vote = Database::get_main_table(TABLE_MAIN_USER_REL_COURSE_VOTE);
  3024. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3025. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3026. $user_id = intval($user_id);
  3027. if (empty($user_id)) {
  3028. return false;
  3029. }
  3030. $params = array(
  3031. 'user_id' => $user_id,
  3032. 'c_id' => $course_id,
  3033. 'session_id' => $session_id,
  3034. 'url_id' => $url_id
  3035. );
  3036. $result = Database::select('vote', $table_user_course_vote, array('where' => array('user_id = ? AND c_id = ? AND session_id = ? AND url_id = ?' => $params)), 'first');
  3037. if (!empty($result)) {
  3038. return $result['vote'];
  3039. }
  3040. return false;
  3041. }
  3042. public function get_course_ranking($course_id, $session_id = null, $url_id = null) {
  3043. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  3044. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3045. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3046. $params = array(
  3047. 'c_id' => $course_id,
  3048. 'session_id' => $session_id,
  3049. 'url_id' => $url_id,
  3050. 'creation_date' => $now,
  3051. );
  3052. $result = Database::select('c_id, accesses, total_score, users', $table_course_ranking, array('where' => array('c_id = ? AND session_id = ? AND url_id = ?' => $params)), 'first');
  3053. $point_average_in_percentage = 0;
  3054. $point_average_in_star = 0;
  3055. $users_who_voted = 0;
  3056. if (!empty($result['users'])) {
  3057. $users_who_voted = $result['users'];
  3058. $point_average_in_percentage = round($result['total_score']/$result['users'] * 100 / 5, 2);
  3059. $point_average_in_star = round($result['total_score']/$result['users'], 1);
  3060. }
  3061. $result['user_vote'] = false;
  3062. if (!api_is_anonymous()) {
  3063. $result['user_vote'] = self::get_user_course_vote(api_get_user_id(), $course_id, $session_id,$url_id);
  3064. }
  3065. $result['point_average'] = $point_average_in_percentage;
  3066. $result['point_average_star'] = $point_average_in_star;
  3067. $result['users_who_voted'] = $users_who_voted;
  3068. return $result;
  3069. }
  3070. /**
  3071. *
  3072. * Updates the course ranking
  3073. * @param int course id
  3074. * @param int session id
  3075. * @param id url id
  3076. *
  3077. **/
  3078. public static function update_course_ranking($course_id = null, $session_id = null, $url_id = null, $points_to_add = null, $add_access = true, $add_user = true) {
  3079. //Course catalog stats modifications see #4191
  3080. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  3081. $now = api_get_utc_datetime();
  3082. $course_id = empty($course_id) ? api_get_course_int_id() : intval($course_id);
  3083. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3084. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3085. $params = array(
  3086. 'c_id' => $course_id,
  3087. 'session_id' => $session_id,
  3088. 'url_id' => $url_id,
  3089. 'creation_date' => $now,
  3090. );
  3091. $result = Database::select('id, accesses, total_score, users', $table_course_ranking, array('where' => array('c_id = ? AND session_id = ? AND url_id = ?' => $params)), 'first');
  3092. // Problem here every thime we load the courses/XXXX/index.php course home page we update the access
  3093. if (empty($result)) {
  3094. if ($add_access) {
  3095. $params['accesses'] = 1;
  3096. }
  3097. //The votes and users are empty
  3098. if (isset($points_to_add) && !empty($points_to_add)) {
  3099. $params['total_score'] = intval($points_to_add);
  3100. }
  3101. if ($add_user) {
  3102. $params['users'] = 1;
  3103. }
  3104. $result = Database::insert($table_course_ranking, $params);
  3105. } else {
  3106. $my_params = array();
  3107. if ($add_access) {
  3108. $my_params['accesses'] = intval($result['accesses']) + 1;
  3109. }
  3110. if (isset($points_to_add) && !empty($points_to_add)) {
  3111. $my_params['total_score'] = $result['total_score'] + $points_to_add;
  3112. }
  3113. if ($add_user) {
  3114. $my_params['users'] = $result['users'] + 1;
  3115. }
  3116. if (!empty($my_params)) {
  3117. $result = Database::update($table_course_ranking, $my_params, array('c_id = ? AND session_id = ? AND url_id = ?' => $params));
  3118. }
  3119. }
  3120. return $result;
  3121. }
  3122. /**
  3123. * Add user vote to a course
  3124. *
  3125. * @param int user id
  3126. * @param int vote [1..5]
  3127. * @param int course id
  3128. * @param int session id
  3129. * @param int url id
  3130. * @return mixed 'added', 'updated' or 'nothing'
  3131. *
  3132. */
  3133. public function add_course_vote($user_id, $vote, $course_id, $session_id = null, $url_id = null) {
  3134. $table_user_course_vote = Database::get_main_table(TABLE_MAIN_USER_REL_COURSE_VOTE);
  3135. $course_id = empty($course_id) ? api_get_course_int_id() : intval($course_id);
  3136. if (empty($course_id) || empty($user_id)) {
  3137. return false;
  3138. }
  3139. if (!in_array($vote, array(1,2,3,4,5))) {
  3140. return false;
  3141. }
  3142. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3143. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3144. $vote = intval($vote);
  3145. $params = array(
  3146. 'user_id' => intval($user_id),
  3147. 'c_id' => $course_id,
  3148. 'session_id' => $session_id,
  3149. 'url_id' => $url_id,
  3150. 'vote' => $vote
  3151. );
  3152. $action_done = 'nothing';
  3153. $result = Database::select('id, vote', $table_user_course_vote, array('where' => array('user_id = ? AND c_id = ? AND session_id = ? AND url_id = ?' => $params)), 'first');
  3154. if (empty($result)) {
  3155. $result = Database::insert($table_user_course_vote, $params);
  3156. $points_to_add = $vote;
  3157. $add_user = true;
  3158. $action_done = 'added';
  3159. } else {
  3160. $my_params = array('vote' => $vote);
  3161. $points_to_add = $vote - $result['vote'];
  3162. $add_user = false;
  3163. $result = Database::update($table_user_course_vote, $my_params, array('user_id = ? AND c_id = ? AND session_id = ? AND url_id = ?' => $params));
  3164. $action_done = 'updated';
  3165. }
  3166. //Current points
  3167. if (!empty($points_to_add)) {
  3168. self::update_course_ranking($course_id, $session_id, $url_id, $points_to_add, false, $add_user);
  3169. }
  3170. return $action_done;
  3171. }
  3172. /**
  3173. * Remove course ranking + user votes
  3174. *
  3175. * @param int course id
  3176. * @param int session id
  3177. * @param int url id
  3178. *
  3179. */
  3180. public function remove_course_ranking($course_id, $session_id, $url_id = null) {
  3181. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  3182. $table_user_course_vote = Database::get_main_table(TABLE_MAIN_USER_REL_COURSE_VOTE);
  3183. if (!empty($course_id) && isset($session_id)) {
  3184. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3185. $params = array(
  3186. 'c_id' => $course_id,
  3187. 'session_id' => $session_id,
  3188. 'url_id' => $url_id,
  3189. );
  3190. Database::delete($table_course_ranking, array('c_id = ? AND session_id = ? AND url_id = ?' => $params));
  3191. Database::delete($table_user_course_vote, array('c_id = ? AND session_id = ? AND url_id = ?' => $params));
  3192. }
  3193. }
  3194. //Stats functions
  3195. function return_hot_courses($days = 30, $limit = 5) {
  3196. $limit = intval($limit);
  3197. $table_course_access = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  3198. //@todo all dates in the tracking_course_access, last_access are in the DB time (NOW) not UTC
  3199. /*
  3200. $today = api_get_utc_datetime();
  3201. $today_diff = time() -intval($days)*24*60*60;
  3202. $today_diff = api_get_utc_datetime($today_diff);
  3203. * */
  3204. //WHERE login_course_date <= '$today' AND login_course_date >= '$today_diff'
  3205. //$table_course_access table uses the now() and interval ...
  3206. $sql = "SELECT COUNT(course_access_id) course_count, course_code FROM $table_course_access
  3207. WHERE login_course_date <= now() AND login_course_date > DATE_SUB(now(), INTERVAL $days DAY)
  3208. GROUP BY course_code
  3209. ORDER BY course_count DESC
  3210. LIMIT $limit";
  3211. $result = Database::query($sql);
  3212. $courses = array();
  3213. if (Database::num_rows($result)) {
  3214. $courses = Database::store_result($result, 'ASSOC');
  3215. foreach ($courses as &$my_course) {
  3216. $course_info = api_get_course_info($my_course['course_code']);
  3217. $my_course['extra_info'] = $course_info;
  3218. $ajax_url = api_get_path(WEB_AJAX_PATH).'course.ajax.php?a=add_course_vote';
  3219. $point_info = self::get_course_ranking($course_info['real_id'], 0);
  3220. $my_course['extra_info']['rating_html'] = Display::return_rating_system('star_'.$course_info['real_id'], $ajax_url.'&amp;course_id='.$course_info['real_id'], $point_info);
  3221. }
  3222. }
  3223. return $courses;
  3224. }
  3225. function return_most_accessed_courses($limit = 5) {
  3226. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  3227. $params['url_id'] = api_get_current_access_url_id();
  3228. $result = Database::select('c_id, accesses, total_score, users', $table_course_ranking, array('where' => array('url_id = ?' => $params), 'order' => 'accesses DESC', 'limit' => $limit), 'all', true);
  3229. return $result;
  3230. }
  3231. } //end class CourseManager