Using multiple indexes for slightly increased performance
[moodle.git] / course / lib.php
CommitLineData
f9903ed0 1<? // $Id$
97c270e9 2 // Library of useful functions
f9903ed0 3
f9903ed0 4
3d891989 5if (defined('COURSE_MAX_LOG_DISPLAY')) { // Being included again - should never happen!!
9ae687af 6 return;
7}
8
3d891989 9define('COURSE_MAX_LOG_DISPLAY', 150); // days
d9d1c35d 10
3d891989 11define('COURSE_MAX_LOGS_PER_PAGE', 1000); // records
1c0200e0 12
3d891989 13define('COURSE_LIVELOG_REFRESH', 60); // Seconds
87ffed0d 14
10a95b43 15define('COURSE_MAX_RECENT_PERIOD', 604800); // A week, in seconds
ef58b822 16
f9903ed0 17
9ae687af 18
f9903ed0 19function print_log_selector_form($course, $selecteduser=0, $selecteddate="today") {
20
9481285b 21 global $USER, $CFG;
22
f9903ed0 23 // Get all the possible users
24 $users = array();
720a43ce 25
26 if ($course->category) {
30d6173e 27 if ($courseusers = get_course_users($course->id, "u.lastaccess DESC")) {
28 foreach ($courseusers as $courseuser) {
29 $users[$courseuser->id] = "$courseuser->firstname $courseuser->lastname";
30 }
f9903ed0 31 }
9fa49e22 32 if ($guest = get_guest()) {
30d6173e 33 $users[$guest->id] = "$guest->firstname $guest->lastname";
122cffc9 34 }
f9903ed0 35 }
720a43ce 36
37 if (isadmin()) {
9fa49e22 38 if ($ccc = get_records("course", "", "", "fullname")) {
720a43ce 39 foreach ($ccc as $cc) {
cfa5d3f2 40 if ($cc->category) {
41 $courses["$cc->id"] = "$cc->fullname";
42 } else {
43 $courses["$cc->id"] = " $cc->fullname (Site)";
44 }
720a43ce 45 }
f9903ed0 46 }
cfa5d3f2 47 asort($courses);
f9903ed0 48 }
49
dcde9f02 50
51 $strftimedate = get_string("strftimedate");
52 $strftimedaydate = get_string("strftimedaydate");
53
f9903ed0 54 asort($users);
55
56 // Get all the possible dates
9481285b 57 // Note that we are keeping track of real (GMT) time and user time
58 // User time is only used in displays - all calcs and passing is GMT
59
60 $timenow = time(); // GMT
61
62 // What day is it now for the user, and when is midnight that day (in GMT).
9604ccb1 63 $timemidnight = $today = usergetmidnight($timenow);
9481285b 64
65 // Put today up the top of the list
dcde9f02 66 $dates = array("$timemidnight" => get_string("today").", ".userdate($timenow, $strftimedate) );
9481285b 67
68 if (! $course->startdate) {
69 $course->startdate = $course->timecreated;
70 }
f9903ed0 71
9481285b 72 $numdates = 1;
73 while ($timemidnight > $course->startdate and $numdates < 365) {
f9903ed0 74 $timemidnight = $timemidnight - 86400;
9481285b 75 $timenow = $timenow - 86400;
dcde9f02 76 $dates["$timemidnight"] = userdate($timenow, $strftimedaydate);
9481285b 77 $numdates++;
f9903ed0 78 }
79
80 if ($selecteddate == "today") {
81 $selecteddate = $today;
82 }
83
84 echo "<CENTER>";
85 echo "<FORM ACTION=log.php METHOD=get>";
720a43ce 86 if (isadmin()) {
849bc02a 87 choose_from_menu ($courses, "id", $course->id, "");
720a43ce 88 } else {
89 echo "<INPUT TYPE=hidden NAME=id VALUE=\"$course->id\">";
90 }
91 if ($course->category) {
97c270e9 92 choose_from_menu ($users, "user", $selecteduser, get_string("allparticipants") );
720a43ce 93 }
97c270e9 94 choose_from_menu ($dates, "date", $selecteddate, get_string("alldays"));
95 echo "<INPUT TYPE=submit VALUE=\"".get_string("showtheselogs")."\">";
f9903ed0 96 echo "</FORM>";
97 echo "</CENTER>";
98}
99
600149be 100function make_log_url($module, $url) {
101 switch ($module) {
102 case "course":
103 case "user":
104 case "file":
105 case "login":
106 case "lib":
107 case "admin":
108 return "/$module/$url";
109 break;
110 default:
111 return "/mod/$module/$url";
112 break;
113 }
114}
115
116
f9903ed0 117function print_log($course, $user=0, $date=0, $order="ORDER BY l.time ASC") {
9481285b 118// It is assumed that $date is the GMT time of midnight for that day,
119// and so the next 86400 seconds worth of logs are printed.
f9903ed0 120
3d891989 121 global $CFG;
47f1da80 122
720a43ce 123 if ($course->category) {
ebc3bd2b 124 $selector = "WHERE l.course='$course->id' AND l.userid = u.id";
a2ab3b05 125
720a43ce 126 } else {
ebc3bd2b 127 $selector = "WHERE l.userid = u.id"; // Show all courses
9fa49e22 128 if ($ccc = get_courses(-1)) {
720a43ce 129 foreach ($ccc as $cc) {
130 $courses[$cc->id] = "$cc->shortname";
131 }
132 }
133 }
f9903ed0 134
135 if ($user) {
ebc3bd2b 136 $selector .= " AND l.userid = '$user'";
f9903ed0 137 }
138
139 if ($date) {
140 $enddate = $date + 86400;
141 $selector .= " AND l.time > '$date' AND l.time < '$enddate'";
142 }
143
6aeec7f8 144 if (!$logs = get_logs($selector, $order)) {
f9903ed0 145 notify("No logs found!");
146 print_footer($course);
147 exit;
148 }
149
150 $count=0;
151 $tt = getdate(time());
152 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
3d891989 153 if (($totalcountlogs = count($logs)) > COURSE_MAX_LOGS_PER_PAGE) {
154 $totalcountlogs = COURSE_MAX_LOGS_PER_PAGE."/$totalcountlogs";
1c0200e0 155 }
156
dcde9f02 157 $strftimedatetime = get_string("strftimedatetime");
158
9fa49e22 159 echo "<P ALIGN=CENTER>";
1c0200e0 160 print_string("displayingrecords", "", $totalcountlogs);
9fa49e22 161 echo "</P>";
1c0200e0 162
163 $countlogs = 0;
f9903ed0 164 echo "<TABLE BORDER=0 ALIGN=center CELLPADDING=3 CELLSPACING=3>";
165 foreach ($logs as $log) {
600149be 166
1c0200e0 167 $countlogs++;
168
3d891989 169 if ($countlogs > COURSE_MAX_LOGS_PER_PAGE) {
1c0200e0 170 break;
171 }
172
9fa49e22 173 if ($ld = get_record("log_display", "module", "$log->module", "action", "$log->action")) {
565f7a95 174 $log->info = get_field($ld->mtable, $ld->field, "id", $log->info);
600149be 175 }
176
f58d18bc 177 echo "<TR NOWRAP>";
720a43ce 178 if (! $course->category) {
f58d18bc 179 echo "<TD NOWRAP><FONT SIZE=2><A HREF=\"view.php?id=$log->course\">".$courses[$log->course]."</A></TD>";
720a43ce 180 }
f58d18bc 181 echo "<TD NOWRAP ALIGN=right><FONT SIZE=2>".userdate($log->time, "%A")."</TD>";
dcde9f02 182 echo "<TD NOWRAP><FONT SIZE=2>".userdate($log->time, $strftimedatetime)."</TD>";
ebea4e27 183 echo "<TD NOWRAP><FONT SIZE=2>";
47f1da80 184 link_to_popup_window("/lib/ipatlas/plot.php?address=$log->ip&user=$log->userid", "ipatlas","$log->ip", 400, 700);
ebea4e27 185 echo "</TD>";
ebc3bd2b 186 echo "<TD NOWRAP><FONT SIZE=2><A HREF=\"../user/view.php?id=$log->userid&course=$log->course\"><B>$log->firstname $log->lastname</B></TD>";
f58d18bc 187 echo "<TD NOWRAP><FONT SIZE=2>";
600149be 188 link_to_popup_window( make_log_url($log->module,$log->url), "fromloglive","$log->module $log->action", 400, 600);
f9903ed0 189 echo "</TD>";
f58d18bc 190 echo "<TD NOWRAP><FONT SIZE=2>$log->info</TD>";
f9903ed0 191 echo "</TR>";
192 }
193 echo "</TABLE>";
194}
195
196
776dc270 197function print_all_courses($category="all", $style="full", $maxcount=999, $width=180) {
0a263205 198 global $CFG, $USER;
d887b5a7 199
ba2e5d73 200 if ($category == "all") {
9fa49e22 201 $courses = get_courses();
0a263205 202
203 } else if ($category == "my") {
204 if (isset($USER->id)) {
9fa49e22 205 if ($courses = get_courses()) {
0a263205 206 foreach ($courses as $key => $course) {
207 if (!isteacher($course->id) and !isstudent($course->id)) {
208 unset($courses[$key]);
209 }
210 }
211 }
212 }
213
ba2e5d73 214 } else {
9fa49e22 215 $courses = get_courses($category);
ba2e5d73 216 }
217
393cc508 218 if ($style == "minimal") {
219 $count = 0;
220 $icon = "<IMG SRC=\"pix/i/course.gif\" HEIGHT=16 WIDTH=16 ALT=\"".get_string("course")."\">";
221 if ($courses) {
94361e02 222 foreach ($courses as $course) {
565f7a95 223 $moddata[]="<A TITLE=\"$course->shortname\" HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->fullname</A>";
94361e02 224 $modicon[]=$icon;
225 if ($count++ >= $maxcount) {
226 break;
227 }
228 }
229 $fulllist = "<P><A HREF=\"$CFG->wwwroot/course/\">".get_string("fulllistofcourses")."</A>...";
94361e02 230 } else {
393cc508 231 $moddata = array();
232 $modicon = array();
233 $fulllist = get_string("nocoursesyet");
234 }
235 print_side_block(get_string("courses"), "", $moddata, $modicon, $fulllist, $width);
236
237 } else if ($courses) {
238 foreach ($courses as $course) {
239 print_course($course);
240 echo "<BR>\n";
d887b5a7 241 }
242
243 } else {
393cc508 244 echo "<P>".get_string("nocoursesyet")."</P>";
d887b5a7 245 }
246}
247
248
f9903ed0 249function print_course($course) {
250
d887b5a7 251 global $CFG;
252
a83fded1 253 if (! $site = get_site()) {
f9903ed0 254 error("Could not find a site!");
255 }
256
d887b5a7 257 print_simple_box_start("CENTER", "100%");
f9903ed0 258
259 echo "<TABLE WIDTH=100%>";
da5c172a 260 echo "<TR VALIGN=top>";
261 echo "<TD VALIGN=top WIDTH=50%>";
7a302afc 262 echo "<P><FONT SIZE=3><B><A TITLE=\"".get_string("entercourse")."\"
9481285b 263 HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->fullname</A></B></FONT></P>";
0c71c9ae 264 if ($teachers = get_course_teachers($course->id)) {
f9903ed0 265 echo "<P><FONT SIZE=1>\n";
266 foreach ($teachers as $teacher) {
0c71c9ae 267 if ($teacher->authority > 0) {
b4d7002e 268 if (!$teacher->role) {
269 $teacher->role = $course->teacher;
270 }
271 echo "$teacher->role: <A HREF=\"$CFG->wwwroot/user/view.php?id=$teacher->id&course=$site->id\">$teacher->firstname $teacher->lastname</A><BR>";
0c71c9ae 272 }
f9903ed0 273 }
274 echo "</FONT></P>";
da5c172a 275 }
f25f1e1b 276 if ($course->guest) {
5e367a2d 277 $strallowguests = get_string("allowguests");
278 echo "<A TITLE=\"$strallowguests\" HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">";
279 echo "<IMG VSPACE=4 ALT=\"$strallowguests\" HEIGHT=16 WIDTH=16 BORDER=0 SRC=\"$CFG->wwwroot/user/user.gif\"></A>&nbsp;&nbsp;";
da5c172a 280 }
281 if ($course->password) {
5e367a2d 282 $strrequireskey = get_string("requireskey");
283 echo "<A TITLE=\"$strrequireskey\" HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">";
284 echo "<IMG VSPACE=4 ALT=\"$strrequireskey\" HEIGHT=16 WIDTH=16 BORDER=0 SRC=\"$CFG->wwwroot/pix/i/key.gif\"></A>";
da5c172a 285 }
286
287
288 echo "</TD><TD VALIGN=top WIDTH=50%>";
289 echo "<P><FONT SIZE=2>".text_to_html($course->summary)."</FONT></P>";
290 echo "</TD></TR>";
291 echo "</TABLE>";
f9903ed0 292
da5c172a 293 print_simple_box_end();
f9903ed0 294}
295
600149be 296function print_headline($text, $size=2) {
297 echo "<B><FONT SIZE=\"$size\">$text</FONT></B><BR>\n";
298}
299
300function print_recent_activity($course) {
301 // $course is an object
302 // This function trawls through the logs looking for
303 // anything new since the user's last login
304
3d891989 305 global $CFG, $USER;
600149be 306
307 if (! $USER->lastlogin ) {
3d891989 308 echo "<p align=center><font size=1>";
4b1371a7 309 print_string("welcometocourse", "", $course->shortname);
3d891989 310 echo "</font></p>";
600149be 311 return;
4c654ee3 312 } else {
3d891989 313 echo "<p align=center><font size=1>";
4c654ee3 314 echo get_string("yourlastlogin").":<BR>";
dcde9f02 315 echo userdate($USER->lastlogin, get_string("strftimerecentfull"));
3d891989 316 echo "</font></p>";
317 }
318
319 $timestart = $USER->lastlogin;
b1992e65 320 $timemaxrecent = time() - COURSE_MAX_RECENT_PERIOD;
321 if ($timestart < $timemaxrecent) {
322 $timestart = $timemaxrecent;
600149be 323 }
324
600149be 325
326 // Firstly, have there been any new enrolments?
327
328 $heading = false;
329 $content = false;
1b5910c4 330
331 $logs = get_records_select("log", "time > '$timestart' AND course = '$course->id' AND
332 module = 'course' AND action = 'enrol'", "time ASC");
333
334 if ($logs) {
335 foreach ($logs as $key => $log) {
600149be 336 if (! $heading) {
4c654ee3 337 print_headline(get_string("newusers").":");
600149be 338 $heading = true;
339 $content = true;
340 }
341 $user = get_record("user", "id", $log->info);
d578afc8 342 if (isstudent($course->id, $user->id)) {
3d891989 343 echo "<p><font size=1><a href=\"../user/view.php?id=$user->id&course=$course->id\">$user->firstname $user->lastname</a></font></p>";
d578afc8 344 }
600149be 345 }
346 }
347
1b5910c4 348 // Next, have there been any modifications to the course structure?
349
350 $logs = get_records_select("log", "time > '$timestart' AND course = '$course->id' AND
351 module = 'course' AND action LIKE '% mod'", "time ASC");
352
353 if ($logs) {
354 foreach ($logs as $key => $log) {
355 $info = split(" ", $log->info);
356 $modname = get_field($info[0], "name", "id", $info[1]);
357 //Create a temp valid module structure (course,id)
358 $tempmod->course = $log->course;
359 $tempmod->id = $info[1];
360 //Obtain the visible property from the instance
361 $modvisible = instance_is_visible($info[0],$tempmod);
362
363 //Only if the mod is visible
364 if ($modvisible) {
365 switch ($log->action) {
366 case "add mod":
367 $stradded = get_string("added", "moodle", get_string("modulename", $info[0]));
368 $changelist["$log->info"] = array ("operation" => "add", "text" => "$stradded:<BR><A HREF=\"$CFG->wwwroot/course/$log->url\">$modname</A>");
369 break;
370 case "update mod":
371 $strupdated = get_string("updated", "moodle", get_string("modulename", $info[0]));
372 if (empty($changelist["$log->info"])) {
373 $changelist["$log->info"] = array ("operation" => "update", "text" => "$strupdated:<BR><A HREF=\"$CFG->wwwroot/course/$log->url\">$modname</A>");
374 }
375 break;
376 case "delete mod":
377 if (!empty($changelist["$log->info"]["operation"]) and
378 $changelist["$log->info"]["operation"] == "add") {
379 $changelist["$log->info"] = NULL;
380 } else {
381 $strdeleted = get_string("deletedactivity", "moodle", get_string("modulename", $info[0]));
382 $changelist["$log->info"] = array ("operation" => "delete", "text" => $strdeleted);
383 }
384 break;
600149be 385 }
ef25340c 386 }
387 }
388 }
389
9c9f7d77 390 if (!empty($changelist)) {
ef25340c 391 foreach ($changelist as $changeinfo => $change) {
392 if ($change) {
393 $changes[$changeinfo] = $change;
394 }
395 }
396 if (count($changes) > 0) {
4c654ee3 397 print_headline(get_string("courseupdates").":");
ef25340c 398 $content = true;
399 foreach ($changes as $changeinfo => $change) {
3d891989 400 echo "<p><font size=1>".$change["text"]."</font></p>";
600149be 401 }
402 }
403 }
404
3869a2ac 405 // Now display new things from each module
600149be 406
3869a2ac 407 $mods = get_list_of_plugins("mod");
600149be 408
1b5910c4 409 $isteacher = isteacher($course->id);
410
411 foreach ($mods as $mod) { // Each module gets it's own logs and prints them
3869a2ac 412 include_once("$CFG->dirroot/mod/$mod/lib.php");
413 $print_recent_activity = $mod."_print_recent_activity";
1b5910c4 414 if (function_exists($print_recent_activity)) {
415 $modcontent = $print_recent_activity($course, $isteacher, $timestart);
3869a2ac 416 if ($modcontent) {
417 $content = true;
600149be 418 }
600149be 419 }
420 }
421
422 if (! $content) {
3d891989 423 echo "<font size=2>".get_string("nothingnew")."</font>";
600149be 424 }
600149be 425}
426
e1360728 427
d897cae4 428function get_array_of_activities($courseid) {
429// For a given course, returns an array of course activity objects
430// Each item in the array contains he following properties:
431// cm - course module id
432// mod - name of the module (eg forum)
433// section - the number of the section (eg week or topic)
434// name - the name of the instance
fec5a6a6 435// visible - when the instance is visible or no
d897cae4 436
437 $mod = array();
438
9fa49e22 439 if (!$rawmods = get_course_mods($courseid)) {
d897cae4 440 return NULL;
441 }
442
443 if ($sections = get_records("course_sections", "course", $courseid, "section ASC")) {
444 foreach ($sections as $section) {
74666583 445 if (!empty($section->sequence)) {
d897cae4 446 $sequence = explode(",", $section->sequence);
447 foreach ($sequence as $seq) {
7af6281f 448 if (empty($rawmods[$seq])) {
449 continue;
450 }
d897cae4 451 $mod[$seq]->cm = $rawmods[$seq]->id;
452 $mod[$seq]->mod = $rawmods[$seq]->modname;
453 $mod[$seq]->section = $section->section;
454 $mod[$seq]->name = urlencode(get_field($rawmods[$seq]->modname, "name", "id", $rawmods[$seq]->instance));
fec5a6a6 455 $mod[$seq]->visible = $rawmods[$seq]->visible;
d897cae4 456 }
457 }
458 }
459 }
460 return $mod;
461}
462
463
464
e1360728 465
90845098 466function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
467// Returns a number of useful structures for course displays
7468bf01 468
90845098 469 $mods = NULL; // course modules indexed by id
470 $modnames = NULL; // all course module names
94361e02 471 $modnamesplural= NULL; // all course module names (plural form)
90845098 472 $modnamesused = NULL; // course module names used
7468bf01 473
9fa49e22 474 if ($allmods = get_records("modules")) {
90845098 475 foreach ($allmods as $mod) {
476 $modnames[$mod->name] = get_string("modulename", "$mod->name");
477 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
478 }
479 asort($modnames);
480 } else {
481 error("No modules are installed!");
482 }
483
9fa49e22 484 if ($rawmods = get_course_mods($courseid)) {
7468bf01 485 foreach($rawmods as $mod) { // Index the mods
486 $mods[$mod->id] = $mod;
90845098 487 $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1acfbce5 488 if ($mod->visible or isteacher($courseid)) {
489 $modnamesused[$mod->modname] = $modnames[$mod->modname];
490 }
7468bf01 491 }
c7da6f7a 492 if ($modnamesused) {
493 asort($modnamesused);
494 }
7468bf01 495 }
7468bf01 496}
497
9fa49e22 498
7468bf01 499function get_all_sections($courseid) {
500
d26d7ed0 501 return get_records("course_sections", "course", "$courseid", "section",
9fa49e22 502 "section, id, course, summary, sequence");
7468bf01 503}
504
ba2e5d73 505
5e367a2d 506function print_section_block($heading, $course, $section, $mods, $modnames, $modnamesused,
507 $absolute=true, $width="100%", $isediting=false) {
508
509 global $CFG;
510
511 $modinfo = unserialize($course->modinfo);
512 $moddata = array();
513 $modicon = array();
514 $editbuttons = "";
515
74666583 516 if (!empty($section->sequence)) {
5e367a2d 517
518 $sectionmods = explode(",", $section->sequence);
519
520 foreach ($sectionmods as $modnumber) {
521 $mod = $mods[$modnumber];
522 if ($isediting) {
1acfbce5 523 $editbuttons = make_editing_buttons($mod->id, $absolute, $mod->visible);
524 }
525 if ($mod->visible or isteacher($course->id)) {
526 $instancename = urldecode($modinfo[$modnumber]->name);
527 if ($mod->visible) {
528 $link_css = "";
529 } else {
530 $link_css = " class=\"dimmed\" ";
531 }
532 $modicon[] = "<img src=\"$CFG->wwwroot/mod/$mod->modname/icon.gif\" height=\"16\" width=\"16\" alt=\"$mod->modfullname\">";
533 $moddata[] = "<a title=\"$mod->modfullname\" $link_css href=\"$CFG->wwwroot/mod/$mod->modname/view.php?id=$mod->id\">$instancename</a><BR>$editbuttons";
5e367a2d 534 }
5e367a2d 535 }
536 }
a44d18e7 537 if ($isediting) {
15ac9065 538 $editmenu = popup_form("$CFG->wwwroot/course/mod.php?id=$course->id&amp;section=$section->section&add=",
5e367a2d 539 $modnames, "section0", "", get_string("add")."...", "mods", get_string("activities"), true);
540 $editmenu = "<DIV ALIGN=right>$editmenu</DIV>";
47f1da80 541 } else {
542 $editmenu = "";
5e367a2d 543 }
544
545 print_side_block($heading, "", $moddata, $modicon, $editmenu, $width);
546}
547
548
d897cae4 549function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%") {
94361e02 550 global $CFG;
551
c408b0c4 552 $modinfo = unserialize($course->modinfo);
94361e02 553
19a55d67 554 echo "<TABLE WIDTH=\"$width\"><TR><TD>\n";
74666583 555 if (!empty($section->sequence)) {
94361e02 556
557 $sectionmods = explode(",", $section->sequence);
558
559 foreach ($sectionmods as $modnumber) {
9ae687af 560 if (empty($mods[$modnumber])) {
561 continue;
562 }
94361e02 563 $mod = $mods[$modnumber];
1acfbce5 564 if ($mod->visible or isteacher($course->id)) {
565 $instancename = urldecode($modinfo[$modnumber]->name);
566 if ($mod->visible) {
567 $link_css = "";
568 } else {
569 $link_css = " class=\"dimmed\" ";
570 }
571 echo "<IMG SRC=\"$CFG->wwwroot/mod/$mod->modname/icon.gif\" HEIGHT=16 WIDTH=16 ALT=\"$mod->modfullname\">";
572 echo " <FONT SIZE=2><A TITLE=\"$mod->modfullname\" $link_css";
573 echo " HREF=\"$CFG->wwwroot/mod/$mod->modname/view.php?id=$mod->id\">$instancename</A></FONT>";
574 }
d897cae4 575 if (isediting($course->id)) {
5e367a2d 576 echo "&nbsp;&nbsp;";
1acfbce5 577 echo make_editing_buttons($mod->id, $absolute, $mod->visible);
578 }
579 if ($mod->visible or isteacher($course->id)) {
580 echo "<BR>\n";
94361e02 581 }
94361e02 582 }
583 }
47ef8795 584 echo "</TD></TR></TABLE><BR>\n\n";
a7ad3ea6 585}
586
7541bc3e 587function print_heading_block($heading, $width="100%", $class="headingblock") {
5e367a2d 588 global $THEME;
589
7541bc3e 590 echo "<table width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"5\">";
591 echo "<tr><td bgcolor=\"$THEME->cellheading\" class=\"$class\">";
5e367a2d 592 echo stripslashes($heading);
593 echo "</td></tr></table>";
5e367a2d 594}
595
596function print_side_block($heading="", $content="", $list=NULL, $icons=NULL, $footer="", $width=180) {
597// Prints a nice side block with an optional header. The content can either
598// be a block of HTML or a list of text with optional icons.
a7ad3ea6 599
5e367a2d 600 global $THEME;
601
7541bc3e 602 print_side_block_start($heading, $width);
603
5e367a2d 604 if ($content) {
7541bc3e 605 echo "$content";
5e367a2d 606 } else {
5e367a2d 607 echo "<table width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"2\">";
608 foreach ($list as $key => $string) {
7541bc3e 609 echo "<tr bgcolor=\"$THEME->cellcontent2\">";
5e367a2d 610 if ($icons) {
7541bc3e 611 echo "<td class=\"sideblocklinks\" valign=\"top\" width=\"16\">".$icons[$key]."</td>";
a7ad3ea6 612 }
7541bc3e 613 echo "<td class=\"sideblocklinks\" valign=\"top\" width=\"*\"><font size=\"-1\">$string</font></td>";
5e367a2d 614 echo "</tr>";
a7ad3ea6 615 }
5e367a2d 616 if ($footer) {
7541bc3e 617 echo "<tr bgcolor=\"$THEME->cellcontent2\">";
5e367a2d 618 if ($icons) {
7541bc3e 619 echo "<td class=\"sideblocklinks\" valign=\"top\" width=\"16\">&nbsp;</td>";
5e367a2d 620 }
7541bc3e 621 echo "<td class=\"sideblocklinks\"><font size=\"-1\">$footer</td>";
5e367a2d 622 echo "</tr>";
623 }
624 echo "</table>";
a7ad3ea6 625 }
5e367a2d 626
7541bc3e 627 print_side_block_end();
628}
629
630function print_side_block_start($heading="", $width=180, $class="sideblockmain") {
631// Starts a nice side block with an optional header.
632
633 global $THEME;
634
635 echo "<table class=\"sideblock\" width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"5\">";
636 if ($heading) {
637 echo "<tr>";
638 echo "<td class=\"sideblockheading\" bgcolor=\"$THEME->cellheading\">$heading</td>";
639 echo "</tr>";
640 }
641 echo "<tr>";
642 echo "<td class=\"$class\" bgcolor=\"$THEME->cellcontent2\">";
643}
644
645function print_side_block_end() {
646 echo "</td></tr>";
5e367a2d 647 echo "</table><br \>";
94361e02 648}
649
5e367a2d 650
670fddf1 651function print_admin_links ($siteid, $width=180) {
b0e3a925 652 global $CFG;
2b25f2a0 653
2b25f2a0 654 $icon = "<IMG SRC=\"$CFG->wwwroot/pix/i/settings.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
1924074c 655 if (isadmin()) {
dae73c05 656 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/config.php\">".get_string("configvariables")."</A>";
1924074c 657 $modicon[]=$icon;
dae73c05 658 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/site.php\">".get_string("sitesettings")."</A>";
1924074c 659 $modicon[]=$icon;
660 $moddata[]="<A HREF=\"$CFG->wwwroot/course/log.php?id=$siteid\">".get_string("sitelogs")."</A>";
661 $modicon[]=$icon;
662 $moddata[]="<A HREF=\"$CFG->wwwroot/theme/index.php\">".get_string("choosetheme")."</A>";
663 $modicon[]=$icon;
dae73c05 664 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/lang.php\">".get_string("checklanguage")."</A>";
1924074c 665 $modicon[]=$icon;
be09831a 666 if (file_exists("$CFG->dirroot/$CFG->admin/$CFG->dbtype")) {
dae73c05 667 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/$CFG->dbtype/frame.php\">".get_string("managedatabase")."</A>";
1924074c 668 $modicon[]=$icon;
669 }
670 $moddata[]="<HR>";
671 $modicon[]="";
672 }
673 if (iscreator()) {
674 $moddata[]="<A HREF=\"$CFG->wwwroot/course/edit.php\">".get_string("addnewcourse")."</A>";
675 $modicon[]=$icon;
676 $moddata[]="<A HREF=\"$CFG->wwwroot/course/teacher.php\">".get_string("assignteachers")."</A>";
677 $modicon[]=$icon;
5b337cdf 678 $fulladmin = "";
1924074c 679 }
680 if (isadmin()) {
681 $moddata[]="<A HREF=\"$CFG->wwwroot/course/categories.php\">".get_string("categories")."</A>";
682 $modicon[]=$icon;
683 $moddata[]="<A HREF=\"$CFG->wwwroot/course/delete.php\">".get_string("deletecourse")."</A>";
684 $modicon[]=$icon;
685 $moddata[]="<HR>";
686 $modicon[]="";
3399a22c 687 if($CFG->auth == "email" || $CFG->auth == "none" || $CFG->auth == "manual"){
688 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/user.php?newuser=true\">".get_string("addnewuser")."</A>";
689 $modicon[]=$icon;
690 }
dae73c05 691 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/user.php\">".get_string("edituser")."</A>";
1924074c 692 $modicon[]=$icon;
dae73c05 693 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/admin.php\">".get_string("assignadmins")."</A>";
1924074c 694 $modicon[]=$icon;
dae73c05 695 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/creators.php\">".get_string("assigncreators")."</A>";
1924074c 696 $modicon[]=$icon;
dae73c05 697 $moddata[]="<A HREF=\"$CFG->wwwroot/$CFG->admin/auth.php\">".get_string("authentication")."</A>";
1924074c 698 $modicon[]=$icon;
dae73c05 699 $fulladmin = "<P><A HREF=\"$CFG->wwwroot/$CFG->admin/\">".get_string("admin")."</A>...";
1924074c 700 }
5e367a2d 701
702 print_side_block(get_string("administration"), "", $moddata, $modicon, $fulladmin, $width);
703
19a55d67 704 echo "<IMG SRC=\"$CFG->wwwroot/pix/spacer.gif\" WIDTH=\"$width\" HEIGHT=1><BR>";
2b25f2a0 705}
706
b4d7002e 707function print_course_admin_links($course, $width=180) {
b0e3a925 708 global $USER, $CFG;
44dad735 709
13469b82 710 if (isteacher($course->id)) {
711 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/edit.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
712 if (isediting($course->id)) {
713 $admindata[]="<A HREF=\"view.php?id=$course->id&edit=off\">".get_string("turneditingoff")."</A>";
714 } else {
715 $admindata[]="<A HREF=\"view.php?id=$course->id&edit=on\">".get_string("turneditingon")."</A>";
716 }
717 $admindata[]="<A HREF=\"edit.php?id=$course->id\">".get_string("settings")."...</A>";
718 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/settings.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
719 if (!$course->teachers) {
720 $course->teachers = get_string("defaultcourseteachers");
721 }
722 $admindata[]="<A HREF=\"teachers.php?id=$course->id\">$course->teachers...</A>";
723 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/settings.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
724
725 $admindata[]="<A HREF=\"grades.php?id=$course->id\">".get_string("grades")."...</A>";
726 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/grades.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
727
728 $admindata[]="<A HREF=\"log.php?id=$course->id\">".get_string("logs")."...</A>";
729 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/log.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
730 $admindata[]="<A HREF=\"$CFG->wwwroot/files/index.php?id=$course->id\">".get_string("files")."...</A>";
731 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/files/pix/files.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
732
733 $admindata[]="<A HREF=\"$CFG->wwwroot/doc/view.php?id=$course->id&file=teacher.html\">".get_string("help")."...</A>";
734 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/mod/resource/icon.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
b4d7002e 735
13469b82 736 if ($teacherforum = forum_get_course_forum($course->id, "teacher")) {
737 $admindata[]="<A HREF=\"$CFG->wwwroot/mod/forum/view.php?f=$teacherforum->id\">".get_string("nameteacher", "forum")."</A>";
738 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/mod/forum/icon.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
739 }
740 } else {
741 $admindata[]="<A HREF=\"grade.php?id=$course->id\">".get_string("grades")."...</A>";
742 $adminicon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/grades.gif\" HEIGHT=16 WIDTH=16 ALT=\"\">";
743 }
44dad735 744
5e367a2d 745 print_side_block(get_string("administration"), "", $admindata, $adminicon, "", $width);
44dad735 746}
2b25f2a0 747
ba2e5d73 748function print_course_categories($categories, $selected="none", $width=180) {
0a263205 749 global $CFG, $THEME, $USER;
85098089 750
751 $strallowguests = get_string("allowguests");
752 $strrequireskey = get_string("requireskey");
ba2e5d73 753
0c656181 754 if ($selected == "index") { // Print comprehensive index of categories with courses
9fa49e22 755 if ($courses = get_courses()) {
0c656181 756 if (isset($USER->id) and !isadmin()) {
39246b72 757 print_simple_box_start("CENTER", "100%", $THEME->cellheading);
0c656181 758 print_heading("<A HREF=\"course/index.php?category=my\">".get_string("mycourses")."</A>", "LEFT");
759 $some = false;
760 echo "<UL>";
761 foreach ($courses as $key => $course) {
762 if (isteacher($course->id) or isstudent($course->id)) {
85098089 763 echo "<A HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->fullname</A>";
764 echo "<BR>";
0c656181 765 $some = true;
766 }
767 }
768 if (!$some) {
769 print_string("nocoursesyet");
770 }
771 echo "</UL>";
772 print_simple_box_end();
773 print_spacer(8,1);
774 }
775 foreach ($categories as $category) {
bd4707bf 776 print_simple_box_start("CENTER", "100%");
7ef459eb 777 print_heading("<A HREF=\"course/index.php?category=$category->id\">$category->name</A>", "LEFT");
0c656181 778 $some = false;
779 echo "<UL>";
780 foreach ($courses as $key => $course) {
781 if ($course->category == $category->id) {
85098089 782 echo "<A HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->fullname</A>";
783 echo "&nbsp;&nbsp;";
0c656181 784 unset($courses[$key]);
85098089 785 if ($course->guest ) {
786 echo "<A TITLE=\"$strallowguests\" HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">";
787 echo "<IMG ALT=\"\" HEIGHT=16 WIDTH=16 BORDER=0 SRC=\"$CFG->wwwroot/user/user.gif\"></A>";
788 }
789 if ($course->password) {
790 echo "<A TITLE=\"$strrequireskey\" HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">";
791 echo "<IMG ALT=\"\" HEIGHT=16 WIDTH=16 BORDER=0 SRC=\"$CFG->wwwroot/pix/i/key.gif\"></A>";
792 }
793 echo "<BR>";
0c656181 794 $some = true;
795 }
796 }
797 if (!$some) {
798 print_string("nocoursesyet");
799 }
800 echo "</UL>";
801 print_simple_box_end();
802 print_spacer(8,1);
803 }
ba2e5d73 804 }
0c656181 805
806 } else { // Print short list of categories only
807 foreach ($categories as $cat) {
808 $caticon[]="<IMG SRC=\"$CFG->wwwroot/pix/i/course.gif\" HEIGHT=16 WIDTH=16>";
809 if ($cat->id == $selected) {
810 $catdata[]="$cat->name";
811 } else {
812 $catdata[]="<A HREF=\"$CFG->wwwroot/course/index.php?category=$cat->id\">$cat->name</A>";
813 }
814 }
815 $catdata[] = "<A HREF=\"$CFG->wwwroot/course/index.php?category=all\">".get_string("fulllistofcourses")."</A>";
13770d0c 816 $caticon[] = "";
0c656181 817 if (isset($USER->id)) {
818 $catdata[] = "<A HREF=\"$CFG->wwwroot/course/index.php?category=my\">".get_string("mycourses")."</A>";
13770d0c 819 $caticon[] = "";
0c656181 820 }
13770d0c 821 print_side_block(get_string("categories"), "", $catdata, $caticon, "", $width);
ba2e5d73 822 }
ba2e5d73 823}
94361e02 824
2b8cef80 825function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
826 global $CFG;
607809b3 827 if (empty($CFG->gdversion)) {
828 echo "(".get_string("gdneed").")";
829 } else {
830 echo "<IMG BORDER=0 SRC=\"$CFG->wwwroot/course/loggraph.php?id=$course->id&user=$userid&type=$type&date=$date\">";
831 }
2b8cef80 832}
833
11b0c469 834
835
836/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
837
838function add_course_module($mod) {
839 GLOBAL $db;
840
e5dfd0f3 841 $mod->added = time();
11b0c469 842
e5dfd0f3 843 return insert_record("course_modules", $mod);
11b0c469 844}
845
846function add_mod_to_section($mod) {
847// Returns the course_sections ID where the mod is inserted
848 GLOBAL $db;
849
9fa49e22 850 if ($section = get_record("course_sections", "course", "$mod->course", "section", "$mod->section")) {
74666583 851 if (!empty($section->sequence)) {
e5dfd0f3 852 $newsequence = "$section->sequence,$mod->coursemodule";
11b0c469 853 } else {
854 $newsequence = "$mod->coursemodule";
855 }
e5dfd0f3 856 if (set_field("course_sections", "sequence", $newsequence, "id", $section->id)) {
857 return $section->id; // Return course_sections ID that was used.
11b0c469 858 } else {
e5dfd0f3 859 return 0;
11b0c469 860 }
861
862 } else { // Insert a new record
e5dfd0f3 863 $section->course = $mod->course;
864 $section->section = $mod->section;
865 $section->summary = "";
866 $section->sequence = $mod->coursemodule;
867 return insert_record("course_sections", $section);
11b0c469 868 }
869}
870
1acfbce5 871function hide_course_module($mod) {
872 return set_field("course_modules", "visible", 0, "id", $mod);
873}
874
875function show_course_module($mod) {
876 return set_field("course_modules", "visible", 1, "id", $mod);
877}
878
11b0c469 879function delete_course_module($mod) {
880 return set_field("course_modules", "deleted", 1, "id", $mod);
881}
882
883function delete_mod_from_section($mod, $section) {
884 GLOBAL $db;
885
e5dfd0f3 886 if ($section = get_record("course_sections", "id", "$section") ) {
11b0c469 887
e5dfd0f3 888 $modarray = explode(",", $section->sequence);
11b0c469 889
890 if ($key = array_keys ($modarray, $mod)) {
891 array_splice($modarray, $key[0], 1);
892 $newsequence = implode(",", $modarray);
e5dfd0f3 893 return set_field("course_sections", "sequence", $newsequence, "id", $section->id);
11b0c469 894 } else {
895 return false;
896 }
897
898 } else {
899 return false;
900 }
901}
902
903
7c0f2984 904function move_module($cm, $move) {
11b0c469 905 GLOBAL $db;
906
907 if (!$move) {
908 return true;
909 }
910
11b0c469 911 if (! $thissection = get_record("course_sections", "id", $cm->section)) {
912 error("This course section doesn't exist");
913 }
914
915 $mods = explode(",", $thissection->sequence);
916
917 $len = count($mods);
918 $pos = array_keys($mods, $cm->id);
919 $thepos = $pos[0];
920
921 if ($len == 0 || count($pos) == 0 ) {
922 error("Very strange. Could not find the required module in this section.");
923 }
924
925 if ($len == 1) {
926 $first = true;
927 $last = true;
928 } else {
929 $first = ($thepos == 0);
930 $last = ($thepos == $len - 1);
931 }
932
933 if ($move < 0) { // Moving the module up
934
935 if ($first) {
936 if ($thissection->section == 1) { // First section, do nothing
937 return true;
938 } else { // Push onto end of previous section
939 $prevsectionnumber = $thissection->section - 1;
9fa49e22 940 if (! $prevsection = get_record("course_sections", "course", "$thissection->course",
941 "section", "$prevsectionnumber")) {
11b0c469 942 error("Previous section ($prevsection->id) doesn't exist");
943 }
944
74666583 945 if (!empty($prevsection->sequence)) {
11b0c469 946 $newsequence = "$prevsection->sequence,$cm->id";
947 } else {
948 $newsequence = "$cm->id";
949 }
950
951 if (! set_field("course_sections", "sequence", $newsequence, "id", $prevsection->id)) {
952 error("Previous section could not be updated");
953 }
954
955 if (! set_field("course_modules", "section", $prevsection->id, "id", $cm->id)) {
956 error("Module could not be updated");
957 }
958
959 array_splice($mods, 0, 1);
960 $newsequence = implode(",", $mods);
961 if (! set_field("course_sections", "sequence", $newsequence, "id", $thissection->id)) {
962 error("Module could not be updated");
963 }
964
965 return true;
966
967 }
968 } else { // move up within this section
969 $swap = $mods[$thepos-1];
970 $mods[$thepos-1] = $mods[$thepos];
971 $mods[$thepos] = $swap;
972
973 $newsequence = implode(",", $mods);
974 if (! set_field("course_sections", "sequence", $newsequence, "id", $thissection->id)) {
975 error("This section could not be updated");
976 }
977 return true;
978 }
979
980 } else { // Moving the module down
981
982 if ($last) {
983 $nextsectionnumber = $thissection->section + 1;
9fa49e22 984 if ($nextsection = get_record("course_sections", "course", "$thissection->course",
985 "section", "$nextsectionnumber")) {
11b0c469 986
74666583 987 if (!empty($nextsection->sequence)) {
11b0c469 988 $newsequence = "$cm->id,$nextsection->sequence";
989 } else {
990 $newsequence = "$cm->id";
991 }
992
993 if (! set_field("course_sections", "sequence", $newsequence, "id", $nextsection->id)) {
994 error("Next section could not be updated");
995 }
996
997 if (! set_field("course_modules", "section", $nextsection->id, "id", $cm->id)) {
998 error("Module could not be updated");
999 }
1000
1001 array_splice($mods, $thepos, 1);
1002 $newsequence = implode(",", $mods);
1003 if (! set_field("course_sections", "sequence", $newsequence, "id", $thissection->id)) {
1004 error("This section could not be updated");
1005 }
1006 return true;
1007
1008 } else { // There is no next section, so just return
1009 return true;
1010
1011 }
1012 } else { // move down within this section
1013 $swap = $mods[$thepos+1];
1014 $mods[$thepos+1] = $mods[$thepos];
1015 $mods[$thepos] = $swap;
1016
1017 $newsequence = implode(",", $mods);
1018 if (! set_field("course_sections", "sequence", $newsequence, "id", $thissection->id)) {
1019 error("This section could not be updated");
1020 }
1021 return true;
1022 }
1023 }
1024}
1025
1acfbce5 1026function make_editing_buttons($moduleid, $absolute=false, $visible=true, $str=NULL) {
94361e02 1027 global $CFG;
1028
1acfbce5 1029 if (empty($str)) {
1030 $str->delete = get_string("delete");
1031 $str->moveup = get_string("moveup");
1032 $str->movedown = get_string("movedown");
1033 $str->update = get_string("update");
1034 $str->hide = get_string("hide");
1035 $str->show = get_string("show");
1036 }
94361e02 1037
1038 if ($absolute) {
1039 $path = "$CFG->wwwroot/course/";
1040 } else {
1041 $path = "";
1042 }
1acfbce5 1043
1044 if ($visible) {
1045 $hideshow = " <A TITLE=\"$str->hide\" HREF=\"".$path."mod.php?hide=$moduleid\"><IMG
1046 SRC=".$path."../pix/t/hide.gif BORDER=0></A>";
1047 } else {
1048 $hideshow = " <A TITLE=\"$str->show\" HREF=\"".$path."mod.php?show=$moduleid\"><IMG
1049 SRC=".$path."../pix/t/show.gif BORDER=0></A>";
1050 }
1051
1052 return "<A TITLE=\"$str->delete\" HREF=\"".$path."mod.php?delete=$moduleid\"><IMG
97c270e9 1053 SRC=".$path."../pix/t/delete.gif BORDER=0></A>
1acfbce5 1054 <A TITLE=\"$str->moveup\" HREF=\"".$path."mod.php?id=$moduleid&move=-1\"><IMG
97c270e9 1055 SRC=".$path."../pix/t/up.gif BORDER=0></A>
1acfbce5 1056 <A TITLE=\"$str->movedown\" HREF=\"".$path."mod.php?id=$moduleid&move=1\"><IMG
97c270e9 1057 SRC=".$path."../pix/t/down.gif BORDER=0></A>
1acfbce5 1058 <A TITLE=\"$str->update\" HREF=\"".$path."mod.php?update=$moduleid\"><IMG
1059 SRC=".$path."../pix/t/edit.gif BORDER=0></A> $hideshow";
90845098 1060}
1061
f9903ed0 1062?>