?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
MDL-36620 - Blog, RSS - Preventing Guests from viewing the RSS of site level blogs
[moodle.git] / course / lib.php
bloba58b86ad3c9fa9f26985bb3ea95d883e64ec988f
1 <?php
2
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18 /**
19 * Library of useful functions
20 *
21 * @copyright 1999 Martin Dougiamas http://dougiamas.com
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 * @package core
24 * @subpackage course
25 */
26
27 defined('MOODLE_INTERNAL') || die;
28
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
32 require_once($CFG->dirroot.'/course/format/lib.php');
33
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000); // records
35 define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds
36
37 /**
38 * Number of courses to display when summaries are included.
39 * @var int
40 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
41 */
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
43
44 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); // max courses in log dropdown before switching to optional
45 define('COURSE_MAX_USERS_PER_DROPDOWN',1000); // max users in log dropdown before switching to optional
46 define('FRONTPAGENEWS', '0');
47 define('FRONTPAGECOURSELIST', '1');
48 define('FRONTPAGECATEGORYNAMES', '2');
49 define('FRONTPAGETOPICONLY', '3');
50 define('FRONTPAGECATEGORYCOMBO', '4');
51 define('FRONTPAGECOURSELIMIT', 200); // maximum number of courses displayed on the frontpage
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
54
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
57
58 function make_log_url($module, $url) {
59 switch ($module) {
60 case 'course':
61 if (strpos($url, 'report/') === 0) {
62 // there is only one report type, course reports are deprecated
63 $url = "/$url";
64 break;
65 }
66 case 'file':
67 case 'login':
68 case 'lib':
69 case 'admin':
70 case 'calendar':
71 case 'mnet course':
72 if (strpos($url, '../') === 0) {
73 $url = ltrim($url, '.');
74 } else {
75 $url = "/course/$url";
76 }
77 break;
78 case 'user':
79 case 'blog':
80 $url = "/$module/$url";
81 break;
82 case 'upload':
83 $url = $url;
84 break;
85 case 'coursetags':
86 $url = '/'.$url;
87 break;
88 case 'library':
89 case '':
90 $url = '/';
91 break;
92 case 'message':
93 $url = "/message/$url";
94 break;
95 case 'notes':
96 $url = "/notes/$url";
97 break;
98 case 'tag':
99 $url = "/tag/$url";
100 break;
101 case 'role':
102 $url = '/'.$url;
103 break;
104 default:
105 $url = "/mod/$module/$url";
106 break;
107 }
108
109 //now let's sanitise urls - there might be some ugly nasties:-(
110 $parts = explode('?', $url);
111 $script = array_shift($parts);
112 if (strpos($script, 'http') === 0) {
113 $script = clean_param($script, PARAM_URL);
114 } else {
115 $script = clean_param($script, PARAM_PATH);
116 }
117
118 $query = '';
119 if ($parts) {
120 $query = implode('', $parts);
121 $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
122 $parts = explode('&', $query);
123 $eq = urlencode('=');
124 foreach ($parts as $key=>$part) {
125 $part = urlencode(urldecode($part));
126 $part = str_replace($eq, '=', $part);
127 $parts[$key] = $part;
128 }
129 $query = '?'.implode('&amp;', $parts);
130 }
131
132 return $script.$query;
133 }
134
135
136 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
137 $modname="", $modid=0, $modaction="", $groupid=0) {
138 global $CFG, $DB;
139
140 // It is assumed that $date is the GMT time of midnight for that day,
141 // and so the next 86400 seconds worth of logs are printed.
142
143 /// Setup for group handling.
144
145 // TODO: I don't understand group/context/etc. enough to be able to do
146 // something interesting with it here
147 // What is the context of a remote course?
148
149 /// If the group mode is separate, and this user does not have editing privileges,
150 /// then only the user's group can be viewed.
151 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
152 // $groupid = get_current_group($course->id);
153 //}
154 /// If this course doesn't have groups, no groupid can be specified.
155 //else if (!$course->groupmode) {
156 // $groupid = 0;
157 //}
158
159 $groupid = 0;
160
161 $joins = array();
162 $where = '';
163
164 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
165 FROM {mnet_log} l
166 LEFT JOIN {user} u ON l.userid = u.id
167 WHERE ";
168 $params = array();
169
170 $where .= "l.hostid = :hostid";
171 $params['hostid'] = $hostid;
172
173 // TODO: Is 1 really a magic number referring to the sitename?
174 if ($course != SITEID || $modid != 0) {
175 $where .= " AND l.course=:courseid";
176 $params['courseid'] = $course;
177 }
178
179 if ($modname) {
180 $where .= " AND l.module = :modname";
181 $params['modname'] = $modname;
182 }
183
184 if ('site_errors' === $modid) {
185 $where .= " AND ( l.action='error' OR l.action='infected' )";
186 } else if ($modid) {
187 //TODO: This assumes that modids are the same across sites... probably
188 //not true
189 $where .= " AND l.cmid = :modid";
190 $params['modid'] = $modid;
191 }
192
193 if ($modaction) {
194 $firstletter = substr($modaction, 0, 1);
195 if ($firstletter == '-') {
196 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
197 $params['modaction'] = '%'.substr($modaction, 1).'%';
198 } else {
199 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
200 $params['modaction'] = '%'.$modaction.'%';
201 }
202 }
203
204 if ($user) {
205 $where .= " AND l.userid = :user";
206 $params['user'] = $user;
207 }
208
209 if ($date) {
210 $enddate = $date + 86400;
211 $where .= " AND l.time > :date AND l.time < :enddate";
212 $params['date'] = $date;
213 $params['enddate'] = $enddate;
214 }
215
216 $result = array();
217 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
218 if(!empty($result['totalcount'])) {
219 $where .= " ORDER BY $order";
220 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
221 } else {
222 $result['logs'] = array();
223 }
224 return $result;
225 }
226
227 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
228 $modname="", $modid=0, $modaction="", $groupid=0) {
229 global $DB, $SESSION, $USER;
230 // It is assumed that $date is the GMT time of midnight for that day,
231 // and so the next 86400 seconds worth of logs are printed.
232
233 /// Setup for group handling.
234
235 /// If the group mode is separate, and this user does not have editing privileges,
236 /// then only the user's group can be viewed.
237 if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
238 if (isset($SESSION->currentgroup[$course->id])) {
239 $groupid = $SESSION->currentgroup[$course->id];
240 } else {
241 $groupid = groups_get_all_groups($course->id, $USER->id);
242 if (is_array($groupid)) {
243 $groupid = array_shift(array_keys($groupid));
244 $SESSION->currentgroup[$course->id] = $groupid;
245 } else {
246 $groupid = 0;
247 }
248 }
249 }
250 /// If this course doesn't have groups, no groupid can be specified.
251 else if (!$course->groupmode) {
252 $groupid = 0;
253 }
254
255 $joins = array();
256 $params = array();
257
258 if ($course->id != SITEID || $modid != 0) {
259 $joins[] = "l.course = :courseid";
260 $params['courseid'] = $course->id;
261 }
262
263 if ($modname) {
264 $joins[] = "l.module = :modname";
265 $params['modname'] = $modname;
266 }
267
268 if ('site_errors' === $modid) {
269 $joins[] = "( l.action='error' OR l.action='infected' )";
270 } else if ($modid) {
271 $joins[] = "l.cmid = :modid";
272 $params['modid'] = $modid;
273 }
274
275 if ($modaction) {
276 $firstletter = substr($modaction, 0, 1);
277 if ($firstletter == '-') {
278 $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
279 $params['modaction'] = '%'.substr($modaction, 1).'%';
280 } else {
281 $joins[] = $DB->sql_like('l.action', ':modaction', false);
282 $params['modaction'] = '%'.$modaction.'%';
283 }
284 }
285
286
287 /// Getting all members of a group.
288 if ($groupid and !$user) {
289 if ($gusers = groups_get_members($groupid)) {
290 $gusers = array_keys($gusers);
291 $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
292 } else {
293 $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
294 }
295 }
296 else if ($user) {
297 $joins[] = "l.userid = :userid";
298 $params['userid'] = $user;
299 }
300
301 if ($date) {
302 $enddate = $date + 86400;
303 $joins[] = "l.time > :date AND l.time < :enddate";
304 $params['date'] = $date;
305 $params['enddate'] = $enddate;
306 }
307
308 $selector = implode(' AND ', $joins);
309
310 $totalcount = 0; // Initialise
311 $result = array();
312 $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
313 $result['totalcount'] = $totalcount;
314 return $result;
315 }
316
317
318 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
319 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
320
321 global $CFG, $DB, $OUTPUT;
322
323 if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
324 $modname, $modid, $modaction, $groupid)) {
325 echo $OUTPUT->notification("No logs found!");
326 echo $OUTPUT->footer();
327 exit;
328 }
329
330 $courses = array();
331
332 if ($course->id == SITEID) {
333 $courses[0] = '';
334 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
335 foreach ($ccc as $cc) {
336 $courses[$cc->id] = $cc->shortname;
337 }
338 }
339 } else {
340 $courses[$course->id] = $course->shortname;
341 }
342
343 $totalcount = $logs['totalcount'];
344 $count=0;
345 $ldcache = array();
346 $tt = getdate(time());
347 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
348
349 $strftimedatetime = get_string("strftimedatetime");
350
351 echo "<div class=\"info\">\n";
352 print_string("displayingrecords", "", $totalcount);
353 echo "</div>\n";
354
355 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
356
357 $table = new html_table();
358 $table->classes = array('logtable','generalbox');
359 $table->align = array('right', 'left', 'left');
360 $table->head = array(
361 get_string('time'),
362 get_string('ip_address'),
363 get_string('fullnameuser'),
364 get_string('action'),
365 get_string('info')
366 );
367 $table->data = array();
368
369 if ($course->id == SITEID) {
370 array_unshift($table->align, 'left');
371 array_unshift($table->head, get_string('course'));
372 }
373
374 // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
375 if (empty($logs['logs'])) {
376 $logs['logs'] = array();
377 }
378
379 foreach ($logs['logs'] as $log) {
380
381 if (isset($ldcache[$log->module][$log->action])) {
382 $ld = $ldcache[$log->module][$log->action];
383 } else {
384 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
385 $ldcache[$log->module][$log->action] = $ld;
386 }
387 if ($ld && is_numeric($log->info)) {
388 // ugly hack to make sure fullname is shown correctly
389 if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
390 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
391 } else {
392 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
393 }
394 }
395
396 //Filter log->info
397 $log->info = format_string($log->info);
398
399 // If $log->url has been trimmed short by the db size restriction
400 // code in add_to_log, keep a note so we don't add a link to a broken url
401 $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
402
403 $row = array();
404 if ($course->id == SITEID) {
405 if (empty($log->course)) {
406 $row[] = get_string('site');
407 } else {
408 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
409 }
410 }
411
412 $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
413
414 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
415 $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
416
417 $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
418
419 $displayaction="$log->module $log->action";
420 if ($brokenurl) {
421 $row[] = $displayaction;
422 } else {
423 $link = make_log_url($log->module,$log->url);
424 $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
425 }
426 $row[] = $log->info;
427 $table->data[] = $row;
428 }
429
430 echo html_writer::table($table);
431 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
432 }
433
434
435 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
436 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
437
438 global $CFG, $DB, $OUTPUT;
439
440 if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
441 $modname, $modid, $modaction, $groupid)) {
442 echo $OUTPUT->notification("No logs found!");
443 echo $OUTPUT->footer();
444 exit;
445 }
446
447 if ($course->id == SITEID) {
448 $courses[0] = '';
449 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
450 foreach ($ccc as $cc) {
451 $courses[$cc->id] = $cc->shortname;
452 }
453 }
454 }
455
456 $totalcount = $logs['totalcount'];
457 $count=0;
458 $ldcache = array();
459 $tt = getdate(time());
460 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
461
462 $strftimedatetime = get_string("strftimedatetime");
463
464 echo "<div class=\"info\">\n";
465 print_string("displayingrecords", "", $totalcount);
466 echo "</div>\n";
467
468 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
469
470 echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
471 echo "<tr>";
472 if ($course->id == SITEID) {
473 echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
474 }
475 echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
476 echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
477 echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
478 echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
479 echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
480 echo "</tr>\n";
481
482 if (empty($logs['logs'])) {
483 echo "</table>\n";
484 return;
485 }
486
487 $row = 1;
488 foreach ($logs['logs'] as $log) {
489
490 $log->info = $log->coursename;
491 $row = ($row + 1) % 2;
492
493 if (isset($ldcache[$log->module][$log->action])) {
494 $ld = $ldcache[$log->module][$log->action];
495 } else {
496 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
497 $ldcache[$log->module][$log->action] = $ld;
498 }
499 if (0 && $ld && !empty($log->info)) {
500 // ugly hack to make sure fullname is shown correctly
501 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
502 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
503 } else {
504 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
505 }
506 }
507
508 //Filter log->info
509 $log->info = format_string($log->info);
510
511 echo '<tr class="r'.$row.'">';
512 if ($course->id == SITEID) {
513 $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
514 echo "<td class=\"r$row c0\" >\n";
515 echo " <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
516 echo "</td>\n";
517 }
518 echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
519 ' '.userdate($log->time, $strftimedatetime)."</td>\n";
520 echo "<td class=\"r$row c2\" >\n";
521 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
522 echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
523 echo "</td>\n";
524 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
525 echo "<td class=\"r$row c3\" >\n";
526 echo " <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
527 echo "</td>\n";
528 echo "<td class=\"r$row c4\">\n";
529 echo $log->action .': '.$log->module;
530 echo "</td>\n";;
531 echo "<td class=\"r$row c5\">{$log->info}</td>\n";
532 echo "</tr>\n";
533 }
534 echo "</table>\n";
535
536 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
537 }
538
539
540 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
541 $modid, $modaction, $groupid) {
542 global $DB, $CFG;
543
544 require_once($CFG->libdir . '/csvlib.class.php');
545
546 $csvexporter = new csv_export_writer('tab');
547
548 $header = array();
549 $header[] = get_string('course');
550 $header[] = get_string('time');
551 $header[] = get_string('ip_address');
552 $header[] = get_string('fullnameuser');
553 $header[] = get_string('action');
554 $header[] = get_string('info');
555
556 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
557 $modname, $modid, $modaction, $groupid)) {
558 return false;
559 }
560
561 $courses = array();
562
563 if ($course->id == SITEID) {
564 $courses[0] = '';
565 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
566 foreach ($ccc as $cc) {
567 $courses[$cc->id] = $cc->shortname;
568 }
569 }
570 } else {
571 $courses[$course->id] = $course->shortname;
572 }
573
574 $count=0;
575 $ldcache = array();
576 $tt = getdate(time());
577 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
578
579 $strftimedatetime = get_string("strftimedatetime");
580
581 $csvexporter->set_filename('logs', '.txt');
582 $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
583 $csvexporter->add_data($title);
584 $csvexporter->add_data($header);
585
586 if (empty($logs['logs'])) {
587 return true;
588 }
589
590 foreach ($logs['logs'] as $log) {
591 if (isset($ldcache[$log->module][$log->action])) {
592 $ld = $ldcache[$log->module][$log->action];
593 } else {
594 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
595 $ldcache[$log->module][$log->action] = $ld;
596 }
597 if ($ld && is_numeric($log->info)) {
598 // ugly hack to make sure fullname is shown correctly
599 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
600 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
601 } else {
602 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
603 }
604 }
605
606 //Filter log->info
607 $log->info = format_string($log->info);
608 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
609
610 $coursecontext = context_course::instance($course->id);
611 $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
612 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
613 $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
614 $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
615 $csvexporter->add_data($row);
616 }
617 $csvexporter->download_file();
618 return true;
619 }
620
621
622 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
623 $modid, $modaction, $groupid) {
624
625 global $CFG, $DB;
626
627 require_once("$CFG->libdir/excellib.class.php");
628
629 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
630 $modname, $modid, $modaction, $groupid)) {
631 return false;
632 }
633
634 $courses = array();
635
636 if ($course->id == SITEID) {
637 $courses[0] = '';
638 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
639 foreach ($ccc as $cc) {
640 $courses[$cc->id] = $cc->shortname;
641 }
642 }
643 } else {
644 $courses[$course->id] = $course->shortname;
645 }
646
647 $count=0;
648 $ldcache = array();
649 $tt = getdate(time());
650 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
651
652 $strftimedatetime = get_string("strftimedatetime");
653
654 $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
655 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
656 $filename .= '.xls';
657
658 $workbook = new MoodleExcelWorkbook('-');
659 $workbook->send($filename);
660
661 $worksheet = array();
662 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
663 get_string('fullnameuser'), get_string('action'), get_string('info'));
664
665 // Creating worksheets
666 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
667 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
668 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
669 $worksheet[$wsnumber]->set_column(1, 1, 30);
670 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
671 userdate(time(), $strftimedatetime));
672 $col = 0;
673 foreach ($headers as $item) {
674 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
675 $col++;
676 }
677 }
678
679 if (empty($logs['logs'])) {
680 $workbook->close();
681 return true;
682 }
683
684 $formatDate =& $workbook->add_format();
685 $formatDate->set_num_format(get_string('log_excel_date_format'));
686
687 $row = FIRSTUSEDEXCELROW;
688 $wsnumber = 1;
689 $myxls =& $worksheet[$wsnumber];
690 foreach ($logs['logs'] as $log) {
691 if (isset($ldcache[$log->module][$log->action])) {
692 $ld = $ldcache[$log->module][$log->action];
693 } else {
694 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
695 $ldcache[$log->module][$log->action] = $ld;
696 }
697 if ($ld && is_numeric($log->info)) {
698 // ugly hack to make sure fullname is shown correctly
699 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
700 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
701 } else {
702 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
703 }
704 }
705
706 // Filter log->info
707 $log->info = format_string($log->info);
708 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
709
710 if ($nroPages>1) {
711 if ($row > EXCELROWS) {
712 $wsnumber++;
713 $myxls =& $worksheet[$wsnumber];
714 $row = FIRSTUSEDEXCELROW;
715 }
716 }
717
718 $coursecontext = context_course::instance($course->id);
719
720 $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
721 $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
722 $myxls->write($row, 2, $log->ip, '');
723 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
724 $myxls->write($row, 3, $fullname, '');
725 $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
726 $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
727 $myxls->write($row, 5, $log->info, '');
728
729 $row++;
730 }
731
732 $workbook->close();
733 return true;
734 }
735
736 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
737 $modid, $modaction, $groupid) {
738
739 global $CFG, $DB;
740
741 require_once("$CFG->libdir/odslib.class.php");
742
743 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
744 $modname, $modid, $modaction, $groupid)) {
745 return false;
746 }
747
748 $courses = array();
749
750 if ($course->id == SITEID) {
751 $courses[0] = '';
752 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
753 foreach ($ccc as $cc) {
754 $courses[$cc->id] = $cc->shortname;
755 }
756 }
757 } else {
758 $courses[$course->id] = $course->shortname;
759 }
760
761 $count=0;
762 $ldcache = array();
763 $tt = getdate(time());
764 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
765
766 $strftimedatetime = get_string("strftimedatetime");
767
768 $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
769 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
770 $filename .= '.ods';
771
772 $workbook = new MoodleODSWorkbook('-');
773 $workbook->send($filename);
774
775 $worksheet = array();
776 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
777 get_string('fullnameuser'), get_string('action'), get_string('info'));
778
779 // Creating worksheets
780 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
781 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
782 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
783 $worksheet[$wsnumber]->set_column(1, 1, 30);
784 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
785 userdate(time(), $strftimedatetime));
786 $col = 0;
787 foreach ($headers as $item) {
788 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
789 $col++;
790 }
791 }
792
793 if (empty($logs['logs'])) {
794 $workbook->close();
795 return true;
796 }
797
798 $formatDate =& $workbook->add_format();
799 $formatDate->set_num_format(get_string('log_excel_date_format'));
800
801 $row = FIRSTUSEDEXCELROW;
802 $wsnumber = 1;
803 $myxls =& $worksheet[$wsnumber];
804 foreach ($logs['logs'] as $log) {
805 if (isset($ldcache[$log->module][$log->action])) {
806 $ld = $ldcache[$log->module][$log->action];
807 } else {
808 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
809 $ldcache[$log->module][$log->action] = $ld;
810 }
811 if ($ld && is_numeric($log->info)) {
812 // ugly hack to make sure fullname is shown correctly
813 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
814 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
815 } else {
816 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
817 }
818 }
819
820 // Filter log->info
821 $log->info = format_string($log->info);
822 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
823
824 if ($nroPages>1) {
825 if ($row > EXCELROWS) {
826 $wsnumber++;
827 $myxls =& $worksheet[$wsnumber];
828 $row = FIRSTUSEDEXCELROW;
829 }
830 }
831
832 $coursecontext = context_course::instance($course->id);
833
834 $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
835 $myxls->write_date($row, 1, $log->time);
836 $myxls->write_string($row, 2, $log->ip);
837 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
838 $myxls->write_string($row, 3, $fullname);
839 $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
840 $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
841 $myxls->write_string($row, 5, $log->info);
842
843 $row++;
844 }
845
846 $workbook->close();
847 return true;
848 }
849
850
851 function print_overview($courses, array $remote_courses=array()) {
852 global $CFG, $USER, $DB, $OUTPUT;
853
854 $htmlarray = array();
855 if ($modules = $DB->get_records('modules')) {
856 foreach ($modules as $mod) {
857 if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
858 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
859 $fname = $mod->name.'_print_overview';
860 if (function_exists($fname)) {
861 $fname($courses,$htmlarray);
862 }
863 }
864 }
865 }
866 foreach ($courses as $course) {
867 $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
868 echo $OUTPUT->box_start('coursebox');
869 $attributes = array('title' => s($fullname));
870 if (empty($course->visible)) {
871 $attributes['class'] = 'dimmed';
872 }
873 echo $OUTPUT->heading(html_writer::link(
874 new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
875 if (array_key_exists($course->id,$htmlarray)) {
876 foreach ($htmlarray[$course->id] as $modname => $html) {
877 echo $html;
878 }
879 }
880 echo $OUTPUT->box_end();
881 }
882
883 if (!empty($remote_courses)) {
884 echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
885 }
886 foreach ($remote_courses as $course) {
887 echo $OUTPUT->box_start('coursebox');
888 $attributes = array('title' => s($course->fullname));
889 echo $OUTPUT->heading(html_writer::link(
890 new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
891 format_string($course->shortname),
892 $attributes) . ' (' . format_string($course->hostname) . ')', 3);
893 echo $OUTPUT->box_end();
894 }
895 }
896
897
898 /**
899 * This function trawls through the logs looking for
900 * anything new since the user's last login
901 */
902 function print_recent_activity($course) {
903 // $course is an object
904 global $CFG, $USER, $SESSION, $DB, $OUTPUT;
905
906 $context = context_course::instance($course->id);
907
908 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
909
910 $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
911
912 if (!isguestuser()) {
913 if (!empty($USER->lastcourseaccess[$course->id])) {
914 if ($USER->lastcourseaccess[$course->id] > $timestart) {
915 $timestart = $USER->lastcourseaccess[$course->id];
916 }
917 }
918 }
919
920 echo '<div class="activitydate">';
921 echo get_string('activitysince', '', userdate($timestart));
922 echo '</div>';
923 echo '<div class="activityhead">';
924
925 echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
926
927 echo "</div>\n";
928
929 $content = false;
930
931 /// Firstly, have there been any new enrolments?
932
933 $users = get_recent_enrolments($course->id, $timestart);
934
935 //Accessibility: new users now appear in an <OL> list.
936 if ($users) {
937 echo '<div class="newusers">';
938 echo $OUTPUT->heading(get_string("newusers").':', 3);
939 $content = true;
940 echo "<ol class=\"list\">\n";
941 foreach ($users as $user) {
942 $fullname = fullname($user, $viewfullnames);
943 echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
944 }
945 echo "</ol>\n</div>\n";
946 }
947
948 /// Next, have there been any modifications to the course structure?
949
950 $modinfo = get_fast_modinfo($course);
951
952 $changelist = array();
953
954 $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
955 module = 'course' AND
956 (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
957 array($timestart, $course->id), "id ASC");
958
959 if ($logs) {
960 $actions = array('add mod', 'update mod', 'delete mod');
961 $newgones = array(); // added and later deleted items
962 foreach ($logs as $key => $log) {
963 if (!in_array($log->action, $actions)) {
964 continue;
965 }
966 $info = explode(' ', $log->info);
967
968 // note: in most cases I replaced hardcoding of label with use of
969 // $cm->has_view() but it was not possible to do this here because
970 // we don't necessarily have the $cm for it
971 if ($info[0] == 'label') { // Labels are ignored in recent activity
972 continue;
973 }
974
975 if (count($info) != 2) {
976 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
977 continue;
978 }
979
980 $modname = $info[0];
981 $instanceid = $info[1];
982
983 if ($log->action == 'delete mod') {
984 // unfortunately we do not know if the mod was visible
985 if (!array_key_exists($log->info, $newgones)) {
986 $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
987 $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
988 }
989 } else {
990 if (!isset($modinfo->instances[$modname][$instanceid])) {
991 if ($log->action == 'add mod') {
992 // do not display added and later deleted activities
993 $newgones[$log->info] = true;
994 }
995 continue;
996 }
997 $cm = $modinfo->instances[$modname][$instanceid];
998 if (!$cm->uservisible) {
999 continue;
1000 }
1001
1002 if ($log->action == 'add mod') {
1003 $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
1004 $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
1005
1006 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1007 $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1008 $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
1009 }
1010 }
1011 }
1012 }
1013
1014 if (!empty($changelist)) {
1015 echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1016 $content = true;
1017 foreach ($changelist as $changeinfo => $change) {
1018 echo '<p class="activity">'.$change['text'].'</p>';
1019 }
1020 }
1021
1022 /// Now display new things from each module
1023
1024 $usedmodules = array();
1025 foreach($modinfo->cms as $cm) {
1026 if (isset($usedmodules[$cm->modname])) {
1027 continue;
1028 }
1029 if (!$cm->uservisible) {
1030 continue;
1031 }
1032 $usedmodules[$cm->modname] = $cm->modname;
1033 }
1034
1035 foreach ($usedmodules as $modname) { // Each module gets it's own logs and prints them
1036 if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1037 include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1038 $print_recent_activity = $modname.'_print_recent_activity';
1039 if (function_exists($print_recent_activity)) {
1040 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1041 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1042 }
1043 } else {
1044 debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1045 }
1046 }
1047
1048 if (! $content) {
1049 echo '<p class="message">'.get_string('nothingnew').'</p>';
1050 }
1051 }
1052
1053 /**
1054 * For a given course, returns an array of course activity objects
1055 * Each item in the array contains he following properties:
1056 */
1057 function get_array_of_activities($courseid) {
1058 // cm - course module id
1059 // mod - name of the module (eg forum)
1060 // section - the number of the section (eg week or topic)
1061 // name - the name of the instance
1062 // visible - is the instance visible or not
1063 // groupingid - grouping id
1064 // groupmembersonly - is this instance visible to group members only
1065 // extra - contains extra string to include in any link
1066 global $CFG, $DB;
1067 if(!empty($CFG->enableavailability)) {
1068 require_once($CFG->libdir.'/conditionlib.php');
1069 }
1070
1071 $course = $DB->get_record('course', array('id'=>$courseid));
1072
1073 if (empty($course)) {
1074 throw new moodle_exception('courseidnotfound');
1075 }
1076
1077 $mod = array();
1078
1079 $rawmods = get_course_mods($courseid);
1080 if (empty($rawmods)) {
1081 return $mod; // always return array
1082 }
1083
1084 if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1085 foreach ($sections as $section) {
1086 if (!empty($section->sequence)) {
1087 $sequence = explode(",", $section->sequence);
1088 foreach ($sequence as $seq) {
1089 if (empty($rawmods[$seq])) {
1090 continue;
1091 }
1092 $mod[$seq] = new stdClass();
1093 $mod[$seq]->id = $rawmods[$seq]->instance;
1094 $mod[$seq]->cm = $rawmods[$seq]->id;
1095 $mod[$seq]->mod = $rawmods[$seq]->modname;
1096
1097 // Oh dear. Inconsistent names left here for backward compatibility.
1098 $mod[$seq]->section = $section->section;
1099 $mod[$seq]->sectionid = $rawmods[$seq]->section;
1100
1101 $mod[$seq]->module = $rawmods[$seq]->module;
1102 $mod[$seq]->added = $rawmods[$seq]->added;
1103 $mod[$seq]->score = $rawmods[$seq]->score;
1104 $mod[$seq]->idnumber = $rawmods[$seq]->idnumber;
1105 $mod[$seq]->visible = $rawmods[$seq]->visible;
1106 $mod[$seq]->visibleold = $rawmods[$seq]->visibleold;
1107 $mod[$seq]->groupmode = $rawmods[$seq]->groupmode;
1108 $mod[$seq]->groupingid = $rawmods[$seq]->groupingid;
1109 $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1110 $mod[$seq]->indent = $rawmods[$seq]->indent;
1111 $mod[$seq]->completion = $rawmods[$seq]->completion;
1112 $mod[$seq]->extra = "";
1113 $mod[$seq]->completiongradeitemnumber =
1114 $rawmods[$seq]->completiongradeitemnumber;
1115 $mod[$seq]->completionview = $rawmods[$seq]->completionview;
1116 $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1117 $mod[$seq]->availablefrom = $rawmods[$seq]->availablefrom;
1118 $mod[$seq]->availableuntil = $rawmods[$seq]->availableuntil;
1119 $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1120 $mod[$seq]->showdescription = $rawmods[$seq]->showdescription;
1121 if (!empty($CFG->enableavailability)) {
1122 condition_info::fill_availability_conditions($rawmods[$seq]);
1123 $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1124 $mod[$seq]->conditionsgrade = $rawmods[$seq]->conditionsgrade;
1125 $mod[$seq]->conditionsfield = $rawmods[$seq]->conditionsfield;
1126 }
1127
1128 $modname = $mod[$seq]->mod;
1129 $functionname = $modname."_get_coursemodule_info";
1130
1131 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1132 continue;
1133 }
1134
1135 include_once("$CFG->dirroot/mod/$modname/lib.php");
1136
1137 if ($hasfunction = function_exists($functionname)) {
1138 if ($info = $functionname($rawmods[$seq])) {
1139 if (!empty($info->icon)) {
1140 $mod[$seq]->icon = $info->icon;
1141 }
1142 if (!empty($info->iconcomponent)) {
1143 $mod[$seq]->iconcomponent = $info->iconcomponent;
1144 }
1145 if (!empty($info->name)) {
1146 $mod[$seq]->name = $info->name;
1147 }
1148 if ($info instanceof cached_cm_info) {
1149 // When using cached_cm_info you can include three new fields
1150 // that aren't available for legacy code
1151 if (!empty($info->content)) {
1152 $mod[$seq]->content = $info->content;
1153 }
1154 if (!empty($info->extraclasses)) {
1155 $mod[$seq]->extraclasses = $info->extraclasses;
1156 }
1157 if (!empty($info->iconurl)) {
1158 $mod[$seq]->iconurl = $info->iconurl;
1159 }
1160 if (!empty($info->onclick)) {
1161 $mod[$seq]->onclick = $info->onclick;
1162 }
1163 if (!empty($info->customdata)) {
1164 $mod[$seq]->customdata = $info->customdata;
1165 }
1166 } else {
1167 // When using a stdclass, the (horrible) deprecated ->extra field
1168 // is available for BC
1169 if (!empty($info->extra)) {
1170 $mod[$seq]->extra = $info->extra;
1171 }
1172 }
1173 }
1174 }
1175 // When there is no modname_get_coursemodule_info function,
1176 // but showdescriptions is enabled, then we use the 'intro'
1177 // and 'introformat' fields in the module table
1178 if (!$hasfunction && $rawmods[$seq]->showdescription) {
1179 if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1180 array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1181 // Set content from intro and introformat. Filters are disabled
1182 // because we filter it with format_text at display time
1183 $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1184 $modvalues, $rawmods[$seq]->id, false);
1185
1186 // To save making another query just below, put name in here
1187 $mod[$seq]->name = $modvalues->name;
1188 }
1189 }
1190 if (!isset($mod[$seq]->name)) {
1191 $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1192 }
1193
1194 // Minimise the database size by unsetting default options when they are
1195 // 'empty'. This list corresponds to code in the cm_info constructor.
1196 foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1197 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1198 'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1199 'availableuntil', 'conditionscompletion', 'conditionsgrade',
1200 'completionview', 'completionexpected', 'score', 'showdescription')
1201 as $property) {
1202 if (property_exists($mod[$seq], $property) &&
1203 empty($mod[$seq]->{$property})) {
1204 unset($mod[$seq]->{$property});
1205 }
1206 }
1207 // Special case: this value is usually set to null, but may be 0
1208 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1209 is_null($mod[$seq]->completiongradeitemnumber)) {
1210 unset($mod[$seq]->completiongradeitemnumber);
1211 }
1212 }
1213 }
1214 }
1215 }
1216 return $mod;
1217 }
1218
1219 /**
1220 * Returns the localised human-readable names of all used modules
1221 *
1222 * @param bool $plural if true returns the plural forms of the names
1223 * @return array where key is the module name (component name without 'mod_') and
1224 * the value is the human-readable string. Array sorted alphabetically by value
1225 */
1226 function get_module_types_names($plural = false) {
1227 static $modnames = null;
1228 global $DB, $CFG;
1229 if ($modnames === null) {
1230 $modnames = array(0 => array(), 1 => array());
1231 if ($allmods = $DB->get_records("modules")) {
1232 foreach ($allmods as $mod) {
1233 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1234 $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1235 $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1236 }
1237 }
1238 collatorlib::asort($modnames[0]);
1239 collatorlib::asort($modnames[1]);
1240 }
1241 }
1242 return $modnames[(int)$plural];
1243 }
1244
1245 /**
1246 * Set highlighted section. Only one section can be highlighted at the time.
1247 *
1248 * @param int $courseid course id
1249 * @param int $marker highlight section with this number, 0 means remove higlightin
1250 * @return void
1251 */
1252 function course_set_marker($courseid, $marker) {
1253 global $DB;
1254 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1255 format_base::reset_course_cache($courseid);
1256 }
1257
1258 /**
1259 * For a given course section, marks it visible or hidden,
1260 * and does the same for every activity in that section
1261 *
1262 * @param int $courseid course id
1263 * @param int $sectionnumber The section number to adjust
1264 * @param int $visibility The new visibility
1265 * @return array A list of resources which were hidden in the section
1266 */
1267 function set_section_visible($courseid, $sectionnumber, $visibility) {
1268 global $DB;
1269
1270 $resourcestotoggle = array();
1271 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1272 $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1273 if (!empty($section->sequence)) {
1274 $modules = explode(",", $section->sequence);
1275 foreach ($modules as $moduleid) {
1276 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1277 if ($visibility) {
1278 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1279 set_coursemodule_visible($moduleid, $cm->visibleold);
1280 } else {
1281 // We hide the section, so we hide the module but we store the original state in visibleold.
1282 set_coursemodule_visible($moduleid, 0);
1283 $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1284 }
1285 }
1286 }
1287 }
1288 rebuild_course_cache($courseid, true);
1289
1290 // Determine which modules are visible for AJAX update
1291 if (!empty($modules)) {
1292 list($insql, $params) = $DB->get_in_or_equal($modules);
1293 $select = 'id ' . $insql . ' AND visible = ?';
1294 array_push($params, $visibility);
1295 if (!$visibility) {
1296 $select .= ' AND visibleold = 1';
1297 }
1298 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1299 }
1300 }
1301 return $resourcestotoggle;
1302 }
1303
1304 /**
1305 * Obtains shared data that is used in print_section when displaying a
1306 * course-module entry.
1307 *
1308 * Calls format_text or format_string as appropriate, and obtains the correct icon.
1309 *
1310 * This data is also used in other areas of the code.
1311 * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1312 * @param object $course Moodle course object
1313 * @return array An array with the following values in this order:
1314 * $content (optional extra content for after link),
1315 * $instancename (text of link)
1316 */
1317 function get_print_section_cm_text(cm_info $cm, $course) {
1318 global $OUTPUT;
1319
1320 // Get content from modinfo if specified. Content displays either
1321 // in addition to the standard link (below), or replaces it if
1322 // the link is turned off by setting ->url to null.
1323 if (($content = $cm->get_content()) !== '') {
1324 // Improve filter performance by preloading filter setttings for all
1325 // activities on the course (this does nothing if called multiple
1326 // times)
1327 filter_preload_activities($cm->get_modinfo());
1328
1329 // Get module context
1330 $modulecontext = context_module::instance($cm->id);
1331 $labelformatoptions = new stdClass();
1332 $labelformatoptions->noclean = true;
1333 $labelformatoptions->overflowdiv = true;
1334 $labelformatoptions->context = $modulecontext;
1335 $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1336 } else {
1337 $content = '';
1338 }
1339
1340 // Get course context
1341 $coursecontext = context_course::instance($course->id);
1342 $stringoptions = new stdClass;
1343 $stringoptions->context = $coursecontext;
1344 $instancename = format_string($cm->name, true, $stringoptions);
1345 return array($content, $instancename);
1346 }
1347
1348 /**
1349 * Prints a section full of activity modules
1350 *
1351 * @param stdClass $course The course
1352 * @param stdClass|section_info $section The section object containing properties id and section
1353 * @param array $mods (argument not used)
1354 * @param array $modnamesused (argument not used)
1355 * @param bool $absolute All links are absolute
1356 * @param string $width Width of the container
1357 * @param bool $hidecompletion Hide completion status
1358 * @param int $sectionreturn The section to return to
1359 * @return void
1360 */
1361 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1362 global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1363
1364 static $initialised;
1365
1366 static $groupbuttons;
1367 static $groupbuttonslink;
1368 static $isediting;
1369 static $ismoving;
1370 static $strmovehere;
1371 static $strmovefull;
1372 static $strunreadpostsone;
1373
1374 if (!isset($initialised)) {
1375 $groupbuttons = ($course->groupmode or (!$course->groupmodeforce));
1376 $groupbuttonslink = (!$course->groupmodeforce);
1377 $isediting = $PAGE->user_is_editing();
1378 $ismoving = $isediting && ismoving($course->id);
1379 if ($ismoving) {
1380 $strmovehere = get_string("movehere");
1381 $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1382 }
1383 $initialised = true;
1384 }
1385
1386 $modinfo = get_fast_modinfo($course);
1387 $completioninfo = new completion_info($course);
1388
1389 //Accessibility: replace table with list <ul>, but don't output empty list.
1390 if (!empty($modinfo->sections[$section->section])) {
1391
1392 // Fix bug #5027, don't want style=\"width:$width\".
1393 echo "<ul class=\"section img-text\">\n";
1394
1395 foreach ($modinfo->sections[$section->section] as $modnumber) {
1396 $mod = $modinfo->cms[$modnumber];
1397
1398 if ($ismoving and $mod->id == $USER->activitycopy) {
1399 // do not display moving mod
1400 continue;
1401 }
1402
1403 // We can continue (because it will not be displayed at all)
1404 // if:
1405 // 1) The activity is not visible to users
1406 // and
1407 // 2a) The 'showavailability' option is not set (if that is set,
1408 // we need to display the activity so we can show
1409 // availability info)
1410 // or
1411 // 2b) The 'availableinfo' is empty, i.e. the activity was
1412 // hidden in a way that leaves no info, such as using the
1413 // eye icon.
1414 if (!$mod->uservisible &&
1415 (empty($mod->showavailability) ||
1416 empty($mod->availableinfo))) {
1417 // visibility shortcut
1418 continue;
1419 }
1420
1421 // In some cases the activity is visible to user, but it is
1422 // dimmed. This is done if viewhiddenactivities is true and if:
1423 // 1. the activity is not visible, or
1424 // 2. the activity has dates set which do not include current, or
1425 // 3. the activity has any other conditions set (regardless of whether
1426 // current user meets them)
1427 $modcontext = context_module::instance($mod->id);
1428 $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
1429 $accessiblebutdim = false;
1430 $conditionalhidden = false;
1431 if ($canviewhidden) {
1432 $accessiblebutdim = !$mod->visible;
1433 if (!empty($CFG->enableavailability)) {
1434 $conditionalhidden = $mod->availablefrom > time() ||
1435 ($mod->availableuntil && $mod->availableuntil < time()) ||
1436 count($mod->conditionsgrade) > 0 ||
1437 count($mod->conditionscompletion) > 0;
1438 }
1439 $accessiblebutdim = $conditionalhidden || $accessiblebutdim;
1440 }
1441
1442 $liclasses = array();
1443 $liclasses[] = 'activity';
1444 $liclasses[] = $mod->modname;
1445 $liclasses[] = 'modtype_'.$mod->modname;
1446 $extraclasses = $mod->get_extra_classes();
1447 if ($extraclasses) {
1448 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1449 }
1450 echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1451 if ($ismoving) {
1452 echo '<a title="'.$strmovefull.'"'.
1453 ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1454 '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1455 ' alt="'.$strmovehere.'" /></a><br />
1456 ';
1457 }
1458
1459 $classes = array('mod-indent');
1460 if (!empty($mod->indent)) {
1461 $classes[] = 'mod-indent-'.$mod->indent;
1462 if ($mod->indent > 15) {
1463 $classes[] = 'mod-indent-huge';
1464 }
1465 }
1466 echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1467
1468 // Get data about this course-module
1469 list($content, $instancename) =
1470 get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1471
1472 //Accessibility: for files get description via icon, this is very ugly hack!
1473 $altname = '';
1474 $altname = $mod->modfullname;
1475 // Avoid unnecessary duplication: if e.g. a forum name already
1476 // includes the word forum (or Forum, etc) then it is unhelpful
1477 // to include that in the accessible description that is added.
1478 if (false !== strpos(textlib::strtolower($instancename),
1479 textlib::strtolower($altname))) {
1480 $altname = '';
1481 }
1482 // File type after name, for alphabetic lists (screen reader).
1483 if ($altname) {
1484 $altname = get_accesshide(' '.$altname);
1485 }
1486
1487 // Start the div for the activity title, excluding the edit icons.
1488 echo html_writer::start_tag('div', array('class' => 'activityinstance'));
1489
1490 // We may be displaying this just in order to show information
1491 // about visibility, without the actual link
1492 $contentpart = '';
1493 if ($mod->uservisible) {
1494 // Nope - in this case the link is fully working for user
1495 $linkclasses = '';
1496 $textclasses = '';
1497 if ($accessiblebutdim) {
1498 $linkclasses .= ' dimmed';
1499 $textclasses .= ' dimmed_text';
1500 if ($conditionalhidden) {
1501 $linkclasses .= ' conditionalhidden';
1502 $textclasses .= ' conditionalhidden';
1503 }
1504 $accesstext = get_accesshide(get_string('hiddenfromstudents').': ');
1505 } else {
1506 $accesstext = '';
1507 }
1508 if ($linkclasses) {
1509 $linkcss = trim($linkclasses) . ' ';
1510 } else {
1511 $linkcss = '';
1512 }
1513 if ($textclasses) {
1514 $textcss = trim($textclasses) . ' ';
1515 } else {
1516 $textcss = '';
1517 }
1518
1519 // Get on-click attribute value if specified and decode the onclick - it
1520 // has already been encoded for display (puke).
1521 $onclick = htmlspecialchars_decode($mod->get_on_click(), ENT_QUOTES);
1522
1523 $groupinglabel = '';
1524 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
1525 $groupings = groups_get_all_groupings($course->id);
1526 $groupinglabel = html_writer::tag('span', '('.format_string($groupings[$mod->groupingid]->name).')',
1527 array('class' => 'groupinglabel'));
1528 }
1529
1530 if ($url = $mod->get_url()) {
1531 // Display link itself.
1532 $activitylink = html_writer::empty_tag('img', array('src' => $mod->get_icon_url(),
1533 'class' => 'iconlarge activityicon', 'alt' => $mod->modfullname)) . $accesstext .
1534 html_writer::tag('span', $instancename . $altname, array('class' => 'instancename'));
1535 echo html_writer::link($url, $activitylink, array('class' => $linkcss, 'onclick' => $onclick)) .
1536 $groupinglabel;
1537
1538 // If specified, display extra content after link.
1539 if ($content) {
1540 $contentpart = html_writer::tag('div', $content, array('class' =>
1541 trim('contentafterlink ' . $textclasses)));
1542 }
1543 } else {
1544 // No link, so display only content.
1545 $contentpart = html_writer::tag('div', $accesstext . $content, array('class' => $textcss));
1546 }
1547
1548 } else {
1549 $textclasses = $extraclasses;
1550 $textclasses .= ' dimmed_text';
1551 if ($textclasses) {
1552 $textcss = 'class="' . trim($textclasses) . '" ';
1553 } else {
1554 $textcss = '';
1555 }
1556 $accesstext = '<span class="accesshide">' .
1557 get_string('notavailableyet', 'condition') .
1558 ': </span>';
1559
1560 if ($url = $mod->get_url()) {
1561 // Display greyed-out text of link
1562 echo '<div ' . $textcss . $mod->extra .
1563 ' >' . '<img src="' . $mod->get_icon_url() .
1564 '" class="activityicon" alt="" /> <span>'. $instancename . $altname .
1565 '</span></div>';
1566
1567 // Do not display content after link when it is greyed out like this.
1568 } else {
1569 // No link, so display only content (also greyed)
1570 $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1571 $accesstext . $content . '</div>';
1572 }
1573 }
1574
1575 // Module can put text after the link (e.g. forum unread)
1576 echo $mod->get_after_link();
1577
1578 // Closing the tag which contains everything but edit icons. $contentpart should not be part of this.
1579 echo html_writer::end_tag('div');
1580
1581 // If there is content but NO link (eg label), then display the
1582 // content here (BEFORE any icons). In this case cons must be
1583 // displayed after the content so that it makes more sense visually
1584 // and for accessibility reasons, e.g. if you have a one-line label
1585 // it should work similarly (at least in terms of ordering) to an
1586 // activity.
1587 if (empty($url)) {
1588 echo $contentpart;
1589 }
1590
1591 if ($isediting) {
1592 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1593 if (! $mod->groupmodelink = $groupbuttonslink) {
1594 $mod->groupmode = $course->groupmode;
1595 }
1596
1597 } else {
1598 $mod->groupmode = false;
1599 }
1600 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
1601 echo $mod->get_after_edit_icons();
1602 }
1603
1604 // Completion
1605 $completion = $hidecompletion
1606 ? COMPLETION_TRACKING_NONE
1607 : $completioninfo->is_enabled($mod);
1608 if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1609 !isguestuser() && $mod->uservisible) {
1610 $completiondata = $completioninfo->get_data($mod,true);
1611 $completionicon = '';
1612 if ($isediting) {
1613 switch ($completion) {
1614 case COMPLETION_TRACKING_MANUAL :
1615 $completionicon = 'manual-enabled'; break;
1616 case COMPLETION_TRACKING_AUTOMATIC :
1617 $completionicon = 'auto-enabled'; break;
1618 default: // wtf
1619 }
1620 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1621 switch($completiondata->completionstate) {
1622 case COMPLETION_INCOMPLETE:
1623 $completionicon = 'manual-n'; break;
1624 case COMPLETION_COMPLETE:
1625 $completionicon = 'manual-y'; break;
1626 }
1627 } else { // Automatic
1628 switch($completiondata->completionstate) {
1629 case COMPLETION_INCOMPLETE:
1630 $completionicon = 'auto-n'; break;
1631 case COMPLETION_COMPLETE:
1632 $completionicon = 'auto-y'; break;
1633 case COMPLETION_COMPLETE_PASS:
1634 $completionicon = 'auto-pass'; break;
1635 case COMPLETION_COMPLETE_FAIL:
1636 $completionicon = 'auto-fail'; break;
1637 }
1638 }
1639 if ($completionicon) {
1640 $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1641 $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1642 $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
1643 if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1644 $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
1645 $newstate =
1646 $completiondata->completionstate==COMPLETION_COMPLETE
1647 ? COMPLETION_INCOMPLETE
1648 : COMPLETION_COMPLETE;
1649 // In manual mode the icon is a toggle form...
1650
1651 // If this completion state is used by the
1652 // conditional activities system, we need to turn
1653 // off the JS.
1654 if (!empty($CFG->enableavailability) &&
1655 condition_info::completion_value_used_as_condition($course, $mod)) {
1656 $extraclass = ' preventjs';
1657 } else {
1658 $extraclass = '';
1659 }
1660 echo html_writer::start_tag('form', array(
1661 'class' => 'togglecompletion' . $extraclass,
1662 'method' => 'post',
1663 'action' => $CFG->wwwroot . '/course/togglecompletion.php'));
1664 echo html_writer::start_tag('div');
1665 echo html_writer::empty_tag('input', array(
1666 'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
1667 echo html_writer::empty_tag('input', array(
1668 'type' => 'hidden', 'name' => 'modulename',
1669 'value' => $mod->name));
1670 echo html_writer::empty_tag('input', array(
1671 'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
1672 echo html_writer::empty_tag('input', array(
1673 'type' => 'hidden', 'name' => 'completionstate',
1674 'value' => $newstate));
1675 echo html_writer::empty_tag('input', array(
1676 'type' => 'image', 'src' => $imgsrc, 'alt' => $imgalt, 'title' => $imgtitle));
1677 echo html_writer::end_tag('div');
1678 echo html_writer::end_tag('form');
1679 } else {
1680 // In auto mode, or when editing, the icon is just an image
1681 echo "<span class='autocompletion'>";
1682 echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1683 }
1684 }
1685 }
1686
1687 // If there is content AND a link, then display the content here
1688 // (AFTER any icons). Otherwise it was displayed before
1689 if (!empty($url)) {
1690 echo $contentpart;
1691 }
1692
1693 // Show availability information (for someone who isn't allowed to
1694 // see the activity itself, or for staff)
1695 if (!$mod->uservisible) {
1696 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1697 } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1698 // Don't add availability information if user is not editing and activity is hidden.
1699 if ($mod->visible || $PAGE->user_is_editing()) {
1700 $hidinfoclass = '';
1701 if (!$mod->visible) {
1702 $hidinfoclass = 'hide';
1703 }
1704 $ci = new condition_info($mod);
1705 $fullinfo = $ci->get_full_information();
1706 if($fullinfo) {
1707 echo '<div class="availabilityinfo '.$hidinfoclass.'">'.get_string($mod->showavailability
1708 ? 'userrestriction_visible'
1709 : 'userrestriction_hidden','condition',
1710 $fullinfo).'</div>';
1711 }
1712 }
1713 }
1714
1715 echo html_writer::end_tag('div');
1716 echo html_writer::end_tag('li')."\n";
1717 }
1718
1719 } elseif ($ismoving) {
1720 echo "<ul class=\"section\">\n";
1721 }
1722
1723 if ($ismoving) {
1724 echo '<li><a title="'.$strmovefull.'"'.
1725 ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1726 '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1727 ' alt="'.$strmovehere.'" /></a></li>
1728 ';
1729 }
1730 if (!empty($modinfo->sections[$section->section]) || $ismoving) {
1731 echo "</ul><!--class='section'-->\n\n";
1732 }
1733 }
1734
1735 /**
1736 * Prints the menus to add activities and resources.
1737 *
1738 * @param stdClass $course The course
1739 * @param int $section relative section number (field course_sections.section)
1740 * @param null|array $modnames An array containing the list of modules and their names
1741 * if omitted will be taken from get_module_types_names()
1742 * @param bool $vertical Vertical orientation
1743 * @param bool $return Return the menus or send them to output
1744 * @param int $sectionreturn The section to link back to
1745 * @return void|string depending on $return
1746 */
1747 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1748 global $CFG, $OUTPUT;
1749
1750 if ($modnames === null) {
1751 $modnames = get_module_types_names();
1752 }
1753
1754 // check to see if user can add menus and there are modules to add
1755 if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
1756 || empty($modnames)) {
1757 if ($return) {
1758 return '';
1759 } else {
1760 return false;
1761 }
1762 }
1763
1764 // Retrieve all modules with associated metadata
1765 $modules = get_module_metadata($course, $modnames, $sectionreturn);
1766
1767 // We'll sort resources and activities into two lists
1768 $resources = array();
1769 $activities = array();
1770
1771 // We need to add the section section to the link for each module
1772 $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1773
1774 foreach ($modules as $module) {
1775 if (isset($module->types)) {
1776 // This module has a subtype
1777 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1778 $subtypes = array();
1779 foreach ($module->types as $subtype) {
1780 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1781 }
1782
1783 // Sort module subtypes into the list
1784 if (!empty($module->title)) {
1785 // This grouping has a name
1786 if ($module->archetype == MOD_CLASS_RESOURCE) {
1787 $resources[] = array($module->title=>$subtypes);
1788 } else {
1789 $activities[] = array($module->title=>$subtypes);
1790 }
1791 } else {
1792 // This grouping does not have a name
1793 if ($module->archetype == MOD_CLASS_RESOURCE) {
1794 $resources = array_merge($resources, $subtypes);
1795 } else {
1796 $activities = array_merge($activities, $subtypes);
1797 }
1798 }
1799 } else {
1800 // This module has no subtypes
1801 if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1802 $resources[$module->link . $sectionlink] = $module->title;
1803 } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1804 // System modules cannot be added by user, do not add to dropdown
1805 } else {
1806 $activities[$module->link . $sectionlink] = $module->title;
1807 }
1808 }
1809 }
1810
1811 $straddactivity = get_string('addactivity');
1812 $straddresource = get_string('addresource');
1813 $sectionname = get_section_name($course, $section);
1814 $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
1815 $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
1816
1817 $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1818
1819 if (!$vertical) {
1820 $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1821 }
1822
1823 if (!empty($resources)) {
1824 $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1825 $select->set_help_icon('resources');
1826 $select->set_label($strresourcelabel, array('class' => 'accesshide'));
1827 $output .= $OUTPUT->render($select);
1828 }
1829
1830 if (!empty($activities)) {
1831 $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1832 $select->set_help_icon('activities');
1833 $select->set_label($stractivitylabel, array('class' => 'accesshide'));
1834 $output .= $OUTPUT->render($select);
1835 }
1836
1837 if (!$vertical) {
1838 $output .= html_writer::end_tag('div');
1839 }
1840
1841 $output .= html_writer::end_tag('div');
1842
1843 if (course_ajax_enabled($course)) {
1844 $straddeither = get_string('addresourceoractivity');
1845 // The module chooser link
1846 $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1847 $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1848 $icon = $OUTPUT->pix_icon('t/add', '');
1849 $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1850 $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1851 $modchooser.= html_writer::end_tag('div');
1852 $modchooser.= html_writer::end_tag('div');
1853
1854 // Wrap the normal output in a noscript div
1855 $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1856 if ($usemodchooser) {
1857 $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1858 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1859 } else {
1860 // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1861 $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1862 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1863 }
1864 $output = $modchooser . $output;
1865 }
1866
1867 if ($return) {
1868 return $output;
1869 } else {
1870 echo $output;
1871 }
1872 }
1873
1874 /**
1875 * Retrieve all metadata for the requested modules
1876 *
1877 * @param object $course The Course
1878 * @param array $modnames An array containing the list of modules and their
1879 * names
1880 * @param int $sectionreturn The section to return to
1881 * @return array A list of stdClass objects containing metadata about each
1882 * module
1883 */
1884 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1885 global $CFG, $OUTPUT;
1886
1887 // get_module_metadata will be called once per section on the page and courses may show
1888 // different modules to one another
1889 static $modlist = array();
1890 if (!isset($modlist[$course->id])) {
1891 $modlist[$course->id] = array();
1892 }
1893
1894 $return = array();
1895 $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1896 foreach($modnames as $modname => $modnamestr) {
1897 if (!course_allowed_module($course, $modname)) {
1898 continue;
1899 }
1900 if (isset($modlist[$course->id][$modname])) {
1901 // This module is already cached
1902 $return[$modname] = $modlist[$course->id][$modname];
1903 continue;
1904 }
1905
1906 // Include the module lib
1907 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1908 if (!file_exists($libfile)) {
1909 continue;
1910 }
1911 include_once($libfile);
1912
1913 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1914 $gettypesfunc = $modname.'_get_types';
1915 if (function_exists($gettypesfunc)) {
1916 if ($types = $gettypesfunc()) {
1917 $group = new stdClass();
1918 $group->name = $modname;
1919 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1920 foreach($types as $type) {
1921 if ($type->typestr === '--') {
1922 continue;
1923 }
1924 if (strpos($type->typestr, '--') === 0) {
1925 $group->title = str_replace('--', '', $type->typestr);
1926 continue;
1927 }
1928 // Set the Sub Type metadata
1929 $subtype = new stdClass();
1930 $subtype->title = $type->typestr;
1931 $subtype->type = str_replace('&amp;', '&', $type->type);
1932 $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1933 $subtype->archetype = $type->modclass;
1934
1935 // The group archetype should match the subtype archetypes and all subtypes
1936 // should have the same archetype
1937 $group->archetype = $subtype->archetype;
1938
1939 if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1940 $subtype->help = get_string('help' . $subtype->name, $modname);
1941 }
1942 $subtype->link = $urlbase . $subtype->type;
1943 $group->types[] = $subtype;
1944 }
1945 $modlist[$course->id][$modname] = $group;
1946 }
1947 } else {
1948 $module = new stdClass();
1949 $module->title = get_string('modulename', $modname);
1950 $module->name = $modname;
1951 $module->link = $urlbase . $modname;
1952 $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1953 $sm = get_string_manager();
1954 if ($sm->string_exists('modulename_help', $modname)) {
1955 $module->help = get_string('modulename_help', $modname);
1956 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs
1957 $link = get_string('modulename_link', $modname);
1958 $linktext = get_string('morehelp');
1959 $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1960 }
1961 }
1962 $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1963 $modlist[$course->id][$modname] = $module;
1964 }
1965 $return[$modname] = $modlist[$course->id][$modname];
1966 }
1967
1968 return $return;
1969 }
1970
1971 /**
1972 * Return the course category context for the category with id $categoryid, except
1973 * that if $categoryid is 0, return the system context.
1974 *
1975 * @param integer $categoryid a category id or 0.
1976 * @return object the corresponding context
1977 */
1978 function get_category_or_system_context($categoryid) {
1979 if ($categoryid) {
1980 return context_coursecat::instance($categoryid, IGNORE_MISSING);
1981 } else {
1982 return context_system::instance();
1983 }
1984 }
1985
1986 /**
1987 * Gets the child categories of a given courses category. Uses a static cache
1988 * to make repeat calls efficient.
1989 *
1990 * @param int $parentid the id of a course category.
1991 * @return array all the child course categories.
1992 */
1993 function get_child_categories($parentid) {
1994 static $allcategories = null;
1995
1996 // only fill in this variable the first time
1997 if (null == $allcategories) {
1998 $allcategories = array();
1999
2000 $categories = get_categories();
2001 foreach ($categories as $category) {
2002 if (empty($allcategories[$category->parent])) {
2003 $allcategories[$category->parent] = array();
2004 }
2005 $allcategories[$category->parent][] = $category;
2006 }
2007 }
2008
2009 if (empty($allcategories[$parentid])) {
2010 return array();
2011 } else {
2012 return $allcategories[$parentid];
2013 }
2014 }
2015
2016 /**
2017 * This function recursively travels the categories, building up a nice list
2018 * for display. It also makes an array that list all the parents for each
2019 * category.
2020 *
2021 * For example, if you have a tree of categories like:
2022 * Miscellaneous (id = 1)
2023 * Subcategory (id = 2)
2024 * Sub-subcategory (id = 4)
2025 * Other category (id = 3)
2026 * Then after calling this function you will have
2027 * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2028 * 4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2029 * 3 => 'Other category');
2030 * $parents = array(2 => array(1), 4 => array(1, 2));
2031 *
2032 * If you specify $requiredcapability, then only categories where the current
2033 * user has that capability will be added to $list, although all categories
2034 * will still be added to $parents, and if you only have $requiredcapability
2035 * in a child category, not the parent, then the child catgegory will still be
2036 * included.
2037 *
2038 * If you specify the option $excluded, then that category, and all its children,
2039 * are omitted from the tree. This is useful when you are doing something like
2040 * moving categories, where you do not want to allow people to move a category
2041 * to be the child of itself.
2042 *
2043 * @param array $list For output, accumulates an array categoryid => full category path name
2044 * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2045 * @param string/array $requiredcapability if given, only categories where the current
2046 * user has this capability will be added to $list. Can also be an array of capabilities,
2047 * in which case they are all required.
2048 * @param integer $excludeid Omit this category and its children from the lists built.
2049 * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2050 * @param string $path For internal use, as part of recursive calls.
2051 */
2052 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2053 $excludeid = 0, $category = NULL, $path = "") {
2054
2055 // initialize the arrays if needed
2056 if (!is_array($list)) {
2057 $list = array();
2058 }
2059 if (!is_array($parents)) {
2060 $parents = array();
2061 }
2062
2063 if (empty($category)) {
2064 // Start at the top level.
2065 $category = new stdClass;
2066 $category->id = 0;
2067 } else {
2068 // This is the excluded category, don't include it.
2069 if ($excludeid > 0 && $excludeid == $category->id) {
2070 return;
2071 }
2072
2073 $context = context_coursecat::instance($category->id);
2074 $categoryname = format_string($category->name, true, array('context' => $context));
2075
2076 // Update $path.
2077 if ($path) {
2078 $path = $path.' / '.$categoryname;
2079 } else {
2080 $path = $categoryname;
2081 }
2082
2083 // Add this category to $list, if the permissions check out.
2084 if (empty($requiredcapability)) {
2085 $list[$category->id] = $path;
2086
2087 } else {
2088 $requiredcapability = (array)$requiredcapability;
2089 if (has_all_capabilities($requiredcapability, $context)) {
2090 $list[$category->id] = $path;
2091 }
2092 }
2093 }
2094
2095 // Add all the children recursively, while updating the parents array.
2096 if ($categories = get_child_categories($category->id)) {
2097 foreach ($categories as $cat) {
2098 if (!empty($category->id)) {
2099 if (isset($parents[$category->id])) {
2100 $parents[$cat->id] = $parents[$category->id];
2101 }
2102 $parents[$cat->id][] = $category->id;
2103 }
2104 make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2105 }
2106 }
2107 }
2108
2109 /**
2110 * This function generates a structured array of courses and categories.
2111 *
2112 * The depth of categories is limited by $CFG->maxcategorydepth however there
2113 * is no limit on the number of courses!
2114 *
2115 * Suitable for use with the course renderers course_category_tree method:
2116 * $renderer = $PAGE->get_renderer('core','course');
2117 * echo $renderer->course_category_tree(get_course_category_tree());
2118 *
2119 * @global moodle_database $DB
2120 * @param int $id
2121 * @param int $depth
2122 */
2123 function get_course_category_tree($id = 0, $depth = 0) {
2124 global $DB, $CFG;
2125 $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
2126 $categories = get_child_categories($id);
2127 $categoryids = array();
2128 foreach ($categories as $key => &$category) {
2129 if (!$category->visible && !$viewhiddencats) {
2130 unset($categories[$key]);
2131 continue;
2132 }
2133 $categoryids[$category->id] = $category;
2134 if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2135 list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2136 foreach ($subcategories as $subid=>$subcat) {
2137 $categoryids[$subid] = $subcat;
2138 }
2139 $category->courses = array();
2140 }
2141 }
2142
2143 if ($depth > 0) {
2144 // This is a recursive call so return the required array
2145 return array($categories, $categoryids);
2146 }
2147
2148 if (empty($categoryids)) {
2149 // No categories available (probably all hidden).
2150 return array();
2151 }
2152
2153 // The depth is 0 this function has just been called so we can finish it off
2154
2155 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2156 list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2157 $sql = "SELECT
2158 c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2159 $ccselect
2160 FROM {course} c
2161 $ccjoin
2162 WHERE c.category $catsql ORDER BY c.sortorder ASC";
2163 if ($courses = $DB->get_records_sql($sql, $catparams)) {
2164 // loop throught them
2165 foreach ($courses as $course) {
2166 if ($course->id == SITEID) {
2167 continue;
2168 }
2169 context_instance_preload($course);
2170 if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2171 $categoryids[$course->category]->courses[$course->id] = $course;
2172 }
2173 }
2174 }
2175 return $categories;
2176 }
2177
2178 /**
2179 * Recursive function to print out all the categories in a nice format
2180 * with or without courses included
2181 */
2182 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2183 global $CFG;
2184
2185 // maxcategorydepth == 0 meant no limit
2186 if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2187 return;
2188 }
2189
2190 if (!$displaylist) {
2191 make_categories_list($displaylist, $parentslist);
2192 }
2193
2194 if ($category) {
2195 if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
2196 print_category_info($category, $depth, $showcourses);
2197 } else {
2198 return; // Don't bother printing children of invisible categories
2199 }
2200
2201 } else {
2202 $category = new stdClass();
2203 $category->id = "0";
2204 }
2205
2206 if ($categories = get_child_categories($category->id)) { // Print all the children recursively
2207 $countcats = count($categories);
2208 $count = 0;
2209 $first = true;
2210 $last = false;
2211 foreach ($categories as $cat) {
2212 $count++;
2213 if ($count == $countcats) {
2214 $last = true;
2215 }
2216 $up = $first ? false : true;
2217 $down = $last ? false : true;
2218 $first = false;
2219
2220 print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2221 }
2222 }
2223 }
2224
2225 /**
2226 * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2227 */
2228 function make_categories_options() {
2229 make_categories_list($cats,$parents);
2230 foreach ($cats as $key => $value) {
2231 if (array_key_exists($key,$parents)) {
2232 if ($indent = count($parents[$key])) {
2233 for ($i = 0; $i < $indent; $i++) {
2234 $cats[$key] = '&nbsp;'.$cats[$key];
2235 }
2236 }
2237 }
2238 }
2239 return $cats;
2240 }
2241
2242 /**
2243 * Prints the category info in indented fashion
2244 * This function is only used by print_whole_category_list() above
2245 */
2246 function print_category_info($category, $depth=0, $showcourses = false) {
2247 global $CFG, $DB, $OUTPUT;
2248
2249 $strsummary = get_string('summary');
2250
2251 $catlinkcss = null;
2252 if (!$category->visible) {
2253 $catlinkcss = array('class'=>'dimmed');
2254 }
2255 static $coursecount = null;
2256 if (null === $coursecount) {
2257 // only need to check this once
2258 $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2259 }
2260
2261 if ($showcourses and $coursecount) {
2262 $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2263 } else {
2264 $catimage = "&nbsp;";
2265 }
2266
2267 $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2268 $context = context_coursecat::instance($category->id);
2269 $fullname = format_string($category->name, true, array('context' => $context));
2270
2271 if ($showcourses and $coursecount) {
2272 echo '<div class="categorylist clearfix">';
2273 $cat = '';
2274 $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2275 $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2276 $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2277
2278 $html = '';
2279 if ($depth > 0) {
2280 for ($i=0; $i< $depth; $i++) {
2281 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2282 $cat = '';
2283 }
2284 } else {
2285 $html = $cat;
2286 }
2287 echo html_writer::tag('div', $html, array('class'=>'category'));
2288 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2289
2290 // does the depth exceed maxcategorydepth
2291 // maxcategorydepth == 0 or unset meant no limit
2292 $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2293 if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2294 foreach ($courses as $course) {
2295 $linkcss = null;
2296 if (!$course->visible) {
2297 $linkcss = array('class'=>'dimmed');
2298 }
2299
2300 $coursename = get_course_display_name_for_list($course);
2301 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2302
2303 // print enrol info
2304 $courseicon = '';
2305 if ($icons = enrol_get_course_info_icons($course)) {
2306 foreach ($icons as $pix_icon) {
2307 $courseicon = $OUTPUT->render($pix_icon);
2308 }
2309 }
2310
2311 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2312
2313 if ($course->summary) {
2314 $link = new moodle_url('/course/info.php?id='.$course->id);
2315 $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2316 new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2317 array('title'=>$strsummary));
2318
2319 $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2320 }
2321
2322 $html = '';
2323 for ($i=0; $i <= $depth; $i++) {
2324 $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2325 $coursecontent = '';
2326 }
2327 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2328 }
2329 }
2330 echo '</div>';
2331 } else {
2332 echo '<div class="categorylist">';
2333 $html = '';
2334 $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2335 if (count($courses) > 0) {
2336 $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2337 }
2338
2339 if ($depth > 0) {
2340 for ($i=0; $i< $depth; $i++) {
2341 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2342 $cat = '';
2343 }
2344 } else {
2345 $html = $cat;
2346 }
2347
2348 echo html_writer::tag('div', $html, array('class'=>'category'));
2349 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2350 echo '</div>';
2351 }
2352 }
2353
2354 /**
2355 * Print the buttons relating to course requests.
2356 *
2357 * @param object $systemcontext the system context.
2358 */
2359 function print_course_request_buttons($systemcontext) {
2360 global $CFG, $DB, $OUTPUT;
2361 if (empty($CFG->enablecourserequests)) {
2362 return;
2363 }
2364 if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2365 /// Print a button to request a new course
2366 echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2367 }
2368 /// Print a button to manage pending requests
2369 if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2370 $disabled = !$DB->record_exists('course_request', array());
2371 echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2372 }
2373 }
2374
2375 /**
2376 * Does the user have permission to edit things in this category?
2377 *
2378 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2379 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2380 */
2381 function can_edit_in_category($categoryid = 0) {
2382 $context = get_category_or_system_context($categoryid);
2383 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2384 }
2385
2386 /**
2387 * Prints the turn editing on/off button on course/index.php or course/category.php.
2388 *
2389 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2390 * @return string HTML of the editing button, or empty string, if this user is not allowed
2391 * to see it.
2392 */
2393 function update_category_button($categoryid = 0) {
2394 global $CFG, $PAGE, $OUTPUT;
2395
2396 // Check permissions.
2397 if (!can_edit_in_category($categoryid)) {
2398 return '';
2399 }
2400
2401 // Work out the appropriate action.
2402 if ($PAGE->user_is_editing()) {
2403 $label = get_string('turneditingoff');
2404 $edit = 'off';
2405 } else {
2406 $label = get_string('turneditingon');
2407 $edit = 'on';
2408 }
2409
2410 // Generate the button HTML.
2411 $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2412 if ($categoryid) {
2413 $options['id'] = $categoryid;
2414 $page = 'category.php';
2415 } else {
2416 $page = 'index.php';
2417 }
2418 return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2419 }
2420
2421 /**
2422 * Category is 0 (for all courses) or an object
2423 */
2424 function print_courses($category) {
2425 global $CFG, $OUTPUT;
2426
2427 if (!is_object($category) && $category==0) {
2428 $categories = get_child_categories(0); // Parent = 0 ie top-level categories only
2429 if (is_array($categories) && count($categories) == 1) {
2430 $category = array_shift($categories);
2431 $courses = get_courses_wmanagers($category->id,
2432 'c.sortorder ASC',
2433 array('summary','summaryformat'));
2434 } else {
2435 $courses = get_courses_wmanagers('all',
2436 'c.sortorder ASC',
2437 array('summary','summaryformat'));
2438 }
2439 unset($categories);
2440 } else {
2441 $courses = get_courses_wmanagers($category->id,
2442 'c.sortorder ASC',
2443 array('summary','summaryformat'));
2444 }
2445
2446 if ($courses) {
2447 echo html_writer::start_tag('ul', array('class'=>'unlist'));
2448 foreach ($courses as $course) {
2449 $coursecontext = context_course::instance($course->id);
2450 if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2451 echo html_writer::start_tag('li');
2452 print_course($course);
2453 echo html_writer::end_tag('li');
2454 }
2455 }
2456 echo html_writer::end_tag('ul');
2457 } else {
2458 echo $OUTPUT->heading(get_string("nocoursesyet"));
2459 $context = context_system::instance();
2460 if (has_capability('moodle/course:create', $context)) {
2461 $options = array();
2462 if (!empty($category->id)) {
2463 $options['category'] = $category->id;
2464 } else {
2465 $options['category'] = $CFG->defaultrequestcategory;
2466 }
2467 echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2468 echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2469 echo html_writer::end_tag('div');
2470 }
2471 }
2472 }
2473
2474 /**
2475 * Print a description of a course, suitable for browsing in a list.
2476 *
2477 * @param object $course the course object.
2478 * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2479 */
2480 function print_course($course, $highlightterms = '') {
2481 global $CFG, $USER, $DB, $OUTPUT;
2482
2483 $context = context_course::instance($course->id);
2484
2485 // Rewrite file URLs so that they are correct
2486 $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2487
2488 echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2489 echo html_writer::start_tag('div', array('class'=>'info'));
2490 echo html_writer::start_tag('h3', array('class'=>'name'));
2491
2492 $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2493
2494 $coursename = get_course_display_name_for_list($course);
2495 $linktext = highlight($highlightterms, format_string($coursename));
2496 $linkparams = array('title'=>get_string('entercourse'));
2497 if (empty($course->visible)) {
2498 $linkparams['class'] = 'dimmed';
2499 }
2500 echo html_writer::link($linkhref, $linktext, $linkparams);
2501 echo html_writer::end_tag('h3');
2502
2503 /// first find all roles that are supposed to be displayed
2504 if (!empty($CFG->coursecontact)) {
2505 $managerroles = explode(',', $CFG->coursecontact);
2506 $rusers = array();
2507
2508 if (!isset($course->managers)) {
2509 list($sort, $sortparams) = users_order_by_sql('u');
2510 $rusers = get_role_users($managerroles, $context, true,
2511 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
2512 r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
2513 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
2514 } else {
2515 // use the managers array if we have it for perf reasosn
2516 // populate the datastructure like output of get_role_users();
2517 foreach ($course->managers as $manager) {
2518 $user = clone($manager->user);
2519 $user->roleid = $manager->roleid;
2520 $user->rolename = $manager->rolename;
2521 $user->roleshortname = $manager->roleshortname;
2522 $user->rolecoursealias = $manager->rolecoursealias;
2523 $rusers[$user->id] = $user;
2524 }
2525 }
2526
2527 $namesarray = array();
2528 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2529 foreach ($rusers as $ra) {
2530 if (isset($namesarray[$ra->id])) {
2531 // only display a user once with the higest sortorder role
2532 continue;
2533 }
2534
2535 $role = new stdClass();
2536 $role->id = $ra->roleid;
2537 $role->name = $ra->rolename;
2538 $role->shortname = $ra->roleshortname;
2539 $role->coursealias = $ra->rolecoursealias;
2540 $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
2541
2542 $fullname = fullname($ra, $canviewfullnames);
2543 $namesarray[$ra->id] = $rolename.': '.
2544 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2545 }
2546
2547 if (!empty($namesarray)) {
2548 echo html_writer::start_tag('ul', array('class'=>'teachers'));
2549 foreach ($namesarray as $name) {
2550 echo html_writer::tag('li', $name);
2551 }
2552 echo html_writer::end_tag('ul');
2553 }
2554 }
2555 echo html_writer::end_tag('div'); // End of info div
2556
2557 echo html_writer::start_tag('div', array('class'=>'summary'));
2558 $options = new stdClass();
2559 $options->noclean = true;
2560 $options->para = false;
2561 $options->overflowdiv = true;
2562 if (!isset($course->summaryformat)) {
2563 $course->summaryformat = FORMAT_MOODLE;
2564 }
2565 echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options, $course->id));
2566 if ($icons = enrol_get_course_info_icons($course)) {
2567 echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2568 foreach ($icons as $icon) {
2569 echo $OUTPUT->render($icon);
2570 }
2571 echo html_writer::end_tag('div'); // End of enrolmenticons div
2572 }
2573 echo html_writer::end_tag('div'); // End of summary div
2574 echo html_writer::end_tag('div'); // End of coursebox div
2575 }
2576
2577 /**
2578 * Prints custom user information on the home page.
2579 * Over time this can include all sorts of information
2580 */
2581 function print_my_moodle() {
2582 global $USER, $CFG, $DB, $OUTPUT;
2583
2584 if (!isloggedin() or isguestuser()) {
2585 print_error('nopermissions', '', '', 'See My Moodle');
2586 }
2587
2588 $courses = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2589 $rhosts = array();
2590 $rcourses = array();
2591 if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2592 $rcourses = get_my_remotecourses($USER->id);
2593 $rhosts = get_my_remotehosts();
2594 }
2595
2596 if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2597
2598 if (!empty($courses)) {
2599 echo '<ul class="unlist">';
2600 foreach ($courses as $course) {
2601 if ($course->id == SITEID) {
2602 continue;
2603 }
2604 echo '<li>';
2605 print_course($course);
2606 echo "</li>\n";
2607 }
2608 echo "</ul>\n";
2609 }
2610
2611 // MNET
2612 if (!empty($rcourses)) {
2613 // at the IDP, we know of all the remote courses
2614 foreach ($rcourses as $course) {
2615 print_remote_course($course, "100%");
2616 }
2617 } elseif (!empty($rhosts)) {
2618 // non-IDP, we know of all the remote servers, but not courses
2619 foreach ($rhosts as $host) {
2620 print_remote_host($host, "100%");
2621 }
2622 }
2623 unset($course);
2624 unset($host);
2625
2626 if ($DB->count_records("course") > (count($courses) + 1) ) { // Some courses not being displayed
2627 echo "<table width=\"100%\"><tr><td align=\"center\">";
2628 print_course_search("", false, "short");
2629 echo "</td><td align=\"center\">";
2630 echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2631 echo "</td></tr></table>\n";
2632 }
2633
2634 } else {
2635 if ($DB->count_records("course_categories") > 1) {
2636 echo $OUTPUT->box_start("categorybox");
2637 print_whole_category_list();
2638 echo $OUTPUT->box_end();
2639 } else {
2640 print_courses(0);
2641 }
2642 }
2643 }
2644
2645
2646 function print_course_search($value="", $return=false, $format="plain") {
2647 global $CFG;
2648 static $count = 0;
2649
2650 $count++;
2651
2652 $id = 'coursesearch';
2653
2654 if ($count > 1) {
2655 $id .= $count;
2656 }
2657
2658 $strsearchcourses= get_string("searchcourses");
2659
2660 if ($format == 'plain') {
2661 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2662 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2663 $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2664 $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2665 $output .= '<input type="submit" value="'.get_string('go').'" />';
2666 $output .= '</fieldset></form>';
2667 } else if ($format == 'short') {
2668 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2669 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2670 $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2671 $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2672 $output .= '<input type="submit" value="'.get_string('go').'" />';
2673 $output .= '</fieldset></form>';
2674 } else if ($format == 'navbar') {
2675 $output = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2676 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2677 $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2678 $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2679 $output .= '<input type="submit" value="'.get_string('go').'" />';
2680 $output .= '</fieldset></form>';
2681 }
2682
2683 if ($return) {
2684 return $output;
2685 }
2686 echo $output;
2687 }
2688
2689 function print_remote_course($course, $width="100%") {
2690 global $CFG, $USER;
2691
2692 $linkcss = '';
2693
2694 $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2695
2696 echo '<div class="coursebox remotecoursebox clearfix">';
2697 echo '<div class="info">';
2698 echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2699 $linkcss.' href="'.$url.'">'
2700 . format_string($course->fullname) .'</a><br />'
2701 . format_string($course->hostname) . ' : '
2702 . format_string($course->cat_name) . ' : '
2703 . format_string($course->shortname). '</div>';
2704 echo '</div><div class="summary">';
2705 $options = new stdClass();
2706 $options->noclean = true;
2707 $options->para = false;
2708 $options->overflowdiv = true;
2709 echo format_text($course->summary, $course->summaryformat, $options);
2710 echo '</div>';
2711 echo '</div>';
2712 }
2713
2714 function print_remote_host($host, $width="100%") {
2715 global $OUTPUT;
2716
2717 $linkcss = '';
2718
2719 echo '<div class="coursebox clearfix">';
2720 echo '<div class="info">';
2721 echo '<div class="name">';
2722 echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2723 echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2724 . s($host['name']).'</a> - ';
2725 echo $host['count'] . ' ' . get_string('courses');
2726 echo '</div>';
2727 echo '</div>';
2728 echo '</div>';
2729 }
2730
2731
2732 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2733
2734 function add_course_module($mod) {
2735 global $DB;
2736
2737 $mod->added = time();
2738 unset($mod->id);
2739
2740 $cmid = $DB->insert_record("course_modules", $mod);
2741 rebuild_course_cache($mod->course, true);
2742 return $cmid;
2743 }
2744
2745 /**
2746 * Creates missing course section(s) and rebuilds course cache
2747 *
2748 * @param int|stdClass $courseorid course id or course object
2749 * @param int|array $sections list of relative section numbers to create
2750 * @return bool if there were any sections created
2751 */
2752 function course_create_sections_if_missing($courseorid, $sections) {
2753 global $DB;
2754 if (!is_array($sections)) {
2755 $sections = array($sections);
2756 }
2757 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2758 if (is_object($courseorid)) {
2759 $courseorid = $courseorid->id;
2760 }
2761 $coursechanged = false;
2762 foreach ($sections as $sectionnum) {
2763 if (!in_array($sectionnum, $existing)) {
2764 $cw = new stdClass();
2765 $cw->course = $courseorid;
2766 $cw->section = $sectionnum;
2767 $cw->summary = '';
2768 $cw->summaryformat = FORMAT_HTML;
2769 $cw->sequence = '';
2770 $id = $DB->insert_record("course_sections", $cw);
2771 $coursechanged = true;
2772 }
2773 }
2774 if ($coursechanged) {
2775 rebuild_course_cache($courseorid, true);
2776 }
2777 return $coursechanged;
2778 }
2779
2780 /**
2781 * Adds an existing module to the section
2782 *
2783 * Updates both tables {course_sections} and {course_modules}
2784 *
2785 * @param int|stdClass $courseorid course id or course object
2786 * @param int $cmid id of the module already existing in course_modules table
2787 * @param int $sectionnum relative number of the section (field course_sections.section)
2788 * If section does not exist it will be created
2789 * @param int|stdClass $beforemod id or object with field id corresponding to the module
2790 * before which the module needs to be included. Null for inserting in the
2791 * end of the section
2792 * @return int The course_sections ID where the module is inserted
2793 */
2794 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
2795 global $DB, $COURSE;
2796 if (is_object($beforemod)) {
2797 $beforemod = $beforemod->id;
2798 }
2799 if (is_object($courseorid)) {
2800 $courseid = $courseorid->id;
2801 } else {
2802 $courseid = $courseorid;
2803 }
2804 course_create_sections_if_missing($courseorid, $sectionnum);
2805 // Do not try to use modinfo here, there is no guarantee it is valid!
2806 $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
2807 $modarray = explode(",", trim($section->sequence));
2808 if (empty($section->sequence)) {
2809 $newsequence = "$cmid";
2810 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2811 $insertarray = array($cmid, $beforemod);
2812 array_splice($modarray, $key[0], 1, $insertarray);
2813 $newsequence = implode(",", $modarray);
2814 } else {
2815 $newsequence = "$section->sequence,$cmid";
2816 }
2817 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2818 $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
2819 if (is_object($courseorid)) {
2820 rebuild_course_cache($courseorid->id, true);
2821 } else {
2822 rebuild_course_cache($courseorid, true);
2823 }
2824 return $section->id; // Return course_sections ID that was used.
2825 }
2826
2827 function set_coursemodule_groupmode($id, $groupmode) {
2828 global $DB;
2829 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2830 if ($cm->groupmode != $groupmode) {
2831 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2832 rebuild_course_cache($cm->course, true);
2833 }
2834 return ($cm->groupmode != $groupmode);
2835 }
2836
2837 function set_coursemodule_idnumber($id, $idnumber) {
2838 global $DB;
2839 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2840 if ($cm->idnumber != $idnumber) {
2841 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2842 rebuild_course_cache($cm->course, true);
2843 }
2844 return ($cm->idnumber != $idnumber);
2845 }
2846
2847 /**
2848 * Set the visibility of a module and inherent properties.
2849 *
2850 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2851 * has been moved to {@link set_section_visible()} which was the only place from which
2852 * the parameter was used.
2853 *
2854 * @param int $id of the module
2855 * @param int $visible state of the module
2856 * @return bool false when the module was not found, true otherwise
2857 */
2858 function set_coursemodule_visible($id, $visible) {
2859 global $DB, $CFG;
2860 require_once($CFG->libdir.'/gradelib.php');
2861
2862 // Trigger developer's attention when using the previously removed argument.
2863 if (func_num_args() > 2) {
2864 debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2865 has been removed.', DEBUG_DEVELOPER);
2866 }
2867
2868 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2869 return false;
2870 }
2871 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2872 return false;
2873 }
2874 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2875 foreach($events as $event) {
2876 if ($visible) {
2877 show_event($event);
2878 } else {
2879 hide_event($event);
2880 }
2881 }
2882 }
2883
2884 // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2885 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2886 if ($grade_items) {
2887 foreach ($grade_items as $grade_item) {
2888 $grade_item->set_hidden(!$visible);
2889 }
2890 }
2891
2892 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2893 // affect visibleold to allow for an original visibility restore. See set_section_visible().
2894 $cminfo = new stdClass();
2895 $cminfo->id = $id;
2896 $cminfo->visible = $visible;
2897 $cminfo->visibleold = $visible;
2898 $DB->update_record('course_modules', $cminfo);
2899
2900 rebuild_course_cache($cm->course, true);
2901 return true;
2902 }
2903
2904 /**
2905 * Delete a course module and any associated data at the course level (events)
2906 * Until 1.5 this function simply marked a deleted flag ... now it
2907 * deletes it completely.
2908 *
2909 */
2910 function delete_course_module($id) {
2911 global $CFG, $DB;
2912 require_once($CFG->libdir.'/gradelib.php');
2913 require_once($CFG->dirroot.'/blog/lib.php');
2914
2915 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2916 return true;
2917 }
2918 $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2919 //delete events from calendar
2920 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2921 foreach($events as $event) {
2922 delete_event($event->id);
2923 }
2924 }
2925 //delete grade items, outcome items and grades attached to modules
2926 if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2927 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2928 foreach ($grade_items as $grade_item) {
2929 $grade_item->delete('moddelete');
2930 }
2931 }
2932 // Delete completion and availability data; it is better to do this even if the
2933 // features are not turned on, in case they were turned on previously (these will be
2934 // very quick on an empty table)
2935 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2936 $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2937 $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2938 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2939 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2940
2941 delete_context(CONTEXT_MODULE, $cm->id);
2942 $DB->delete_records('course_modules', array('id'=>$cm->id));
2943 rebuild_course_cache($cm->course, true);
2944 return true;
2945 }
2946
2947 function delete_mod_from_section($modid, $sectionid) {
2948 global $DB;
2949
2950 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2951
2952 $modarray = explode(",", $section->sequence);
2953
2954 if ($key = array_keys ($modarray, $modid)) {
2955 array_splice($modarray, $key[0], 1);
2956 $newsequence = implode(",", $modarray);
2957 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2958 rebuild_course_cache($section->course, true);
2959 return true;
2960 } else {
2961 return false;
2962 }
2963
2964 }
2965 return false;
2966 }
2967
2968 /**
2969 * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2970 *
2971 * @param object $course course object
2972 * @param int $section Section number (not id!!!)
2973 * @param int $move (-1 or 1)
2974 * @return boolean true if section moved successfully
2975 * @todo MDL-33379 remove this function in 2.5
2976 */
2977 function move_section($course, $section, $move) {
2978 debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2979
2980 /// Moves a whole course section up and down within the course
2981 global $USER;
2982
2983 if (!$move) {
2984 return true;
2985 }
2986
2987 $sectiondest = $section + $move;
2988
2989 // compartibility with course formats using field 'numsections'
2990 $courseformatoptions = course_get_format($course)->get_format_options();
2991 if (array_key_exists('numsections', $courseformatoptions) &&
2992 $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2993 return false;
2994 }
2995
2996 $retval = move_section_to($course, $section, $sectiondest);
2997 return $retval;
2998 }
2999
3000 /**
3001 * Moves a section within a course, from a position to another.
3002 * Be very careful: $section and $destination refer to section number,
3003 * not id!.
3004 *
3005 * @param object $course
3006 * @param int $section Section number (not id!!!)
3007 * @param int $destination
3008 * @return boolean Result
3009 */
3010 function move_section_to($course, $section, $destination) {
3011 /// Moves a whole course section up and down within the course
3012 global $USER, $DB;
3013
3014 if (!$destination && $destination != 0) {
3015 return true;
3016 }
3017
3018 // compartibility with course formats using field 'numsections'
3019 $courseformatoptions = course_get_format($course)->get_format_options();
3020 if ((array_key_exists('numsections', $courseformatoptions) &&
3021 ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
3022 return false;
3023 }
3024
3025 // Get all sections for this course and re-order them (2 of them should now share the same section number)
3026 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3027 'section ASC, id ASC', 'id, section')) {
3028 return false;
3029 }
3030
3031 $movedsections = reorder_sections($sections, $section, $destination);
3032
3033 // Update all sections. Do this in 2 steps to avoid breaking database
3034 // uniqueness constraint
3035 $transaction = $DB->start_delegated_transaction();
3036 foreach ($movedsections as $id => $position) {
3037 if ($sections[$id] !== $position) {
3038 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3039 }
3040 }
3041 foreach ($movedsections as $id => $position) {
3042 if ($sections[$id] !== $position) {
3043 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3044 }
3045 }
3046
3047 // If we move the highlighted section itself, then just highlight the destination.
3048 // Adjust the higlighted section location if we move something over it either direction.
3049 if ($section == $course->marker) {
3050 course_set_marker($course->id, $destination);
3051 } elseif ($section > $course->marker && $course->marker >= $destination) {
3052 course_set_marker($course->id, $course->marker+1);
3053 } elseif ($section < $course->marker && $course->marker <= $destination) {
3054 course_set_marker($course->id, $course->marker-1);
3055 }
3056
3057 $transaction->allow_commit();
3058 rebuild_course_cache($course->id, true);
3059 return true;
3060 }
3061
3062 /**
3063 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3064 * an original position number and a target position number, rebuilds the array so that the
3065 * move is made without any duplication of section positions.
3066 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3067 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3068 *
3069 * @param array $sections
3070 * @param int $origin_position
3071 * @param int $target_position
3072 * @return array
3073 */
3074 function reorder_sections($sections, $origin_position, $target_position) {
3075 if (!is_array($sections)) {
3076 return false;
3077 }
3078
3079 // We can't move section position 0
3080 if ($origin_position < 1) {
3081 echo "We can't move section position 0";
3082 return false;
3083 }
3084
3085 // Locate origin section in sections array
3086 if (!$origin_key = array_search($origin_position, $sections)) {
3087 echo "searched position not in sections array";
3088 return false; // searched position not in sections array
3089 }
3090
3091 // Extract origin section
3092 $origin_section = $sections[$origin_key];
3093 unset($sections[$origin_key]);
3094
3095 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3096 $found = false;
3097 $append_array = array();
3098 foreach ($sections as $id => $position) {
3099 if ($found) {
3100 $append_array[$id] = $position;
3101 unset($sections[$id]);
3102 }
3103 if ($position == $target_position) {
3104 if ($target_position < $origin_position) {
3105 $append_array[$id] = $position;
3106 unset($sections[$id]);
3107 }
3108 $found = true;
3109 }
3110 }
3111
3112 // Append moved section
3113 $sections[$origin_key] = $origin_section;
3114
3115 // Append rest of array (if applicable)
3116 if (!empty($append_array)) {
3117 foreach ($append_array as $id => $position) {
3118 $sections[$id] = $position;
3119 }
3120 }
3121
3122 // Renumber positions
3123 $position = 0;
3124 foreach ($sections as $id => $p) {
3125 $sections[$id] = $position;
3126 $position++;
3127 }
3128
3129 return $sections;
3130
3131 }
3132
3133 /**
3134 * Move the module object $mod to the specified $section
3135 * If $beforemod exists then that is the module
3136 * before which $modid should be inserted
3137 * All parameters are objects
3138 */
3139 function moveto_module($mod, $section, $beforemod=NULL) {
3140 global $OUTPUT;
3141
3142 /// Remove original module from original section
3143 if (! delete_mod_from_section($mod->id, $mod->section)) {
3144 echo $OUTPUT->notification("Could not delete module from existing section");
3145 }
3146
3147 // if moving to a hidden section then hide module
3148 if (!$section->visible && $mod->visible) {
3149 set_coursemodule_visible($mod->id, 0);
3150 }
3151
3152 /// Add the module into the new section
3153 course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
3154 return true;
3155 }
3156
3157 /**
3158 * Produces the editing buttons for a module
3159 *
3160 * @global core_renderer $OUTPUT
3161 * @staticvar type $str
3162 * @param stdClass $mod The module to produce editing buttons for
3163 * @param bool $absolute_ignored ignored - all links are absolute
3164 * @param bool $moveselect If true a move seleciton process is used (default true)
3165 * @param int $indent The current indenting
3166 * @param int $section The section to link back to
3167 * @return string XHTML for the editing buttons
3168 */
3169 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3170 global $CFG, $OUTPUT, $COURSE;
3171
3172 static $str;
3173
3174 $coursecontext = context_course::instance($mod->course);
3175 $modcontext = context_module::instance($mod->id);
3176
3177 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3178 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3179
3180 // no permission to edit anything
3181 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3182 return false;
3183 }
3184
3185 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3186
3187 if (!isset($str)) {
3188 $str = new stdClass;
3189 $str->assign = get_string("assignroles", 'role');
3190 $str->delete = get_string("delete");
3191 $str->move = get_string("move");
3192 $str->moveup = get_string("moveup");
3193 $str->movedown = get_string("movedown");
3194 $str->moveright = get_string("moveright");
3195 $str->moveleft = get_string("moveleft");
3196 $str->update = get_string("update");
3197 $str->duplicate = get_string("duplicate");
3198 $str->hide = get_string("hide");
3199 $str->show = get_string("show");
3200 $str->groupsnone = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3201 $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3202 $str->groupsvisible = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3203 $str->forcedgroupsnone = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3204 $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3205 $str->forcedgroupsvisible = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3206 $str->edittitle = get_string('edittitle', 'moodle');
3207 }
3208
3209 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3210
3211 if ($section !== null) {
3212 $baseurl->param('sr', $section);
3213 }
3214 $actions = array();
3215
3216 // AJAX edit title
3217 if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3218 $actions[] = new action_link(
3219 new moodle_url($baseurl, array('update' => $mod->id)),
3220 new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3221 null,
3222 array('class' => 'editing_title', 'title' => $str->edittitle)
3223 );
3224 }
3225
3226 // leftright
3227 if ($hasmanageactivities) {
3228 if (right_to_left()) { // Exchange arrows on RTL
3229 $rightarrow = 't/left';
3230 $leftarrow = 't/right';
3231 } else {
3232 $rightarrow = 't/right';
3233 $leftarrow = 't/left';
3234 }
3235
3236 if ($indent > 0) {
3237 $actions[] = new action_link(
3238 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3239 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3240 null,
3241 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3242 );
3243 }
3244 if ($indent >= 0) {
3245 $actions[] = new action_link(
3246 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3247 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3248 null,
3249 array('class' => 'editing_moveright', 'title' => $str->moveright)
3250 );
3251 }
3252 }
3253
3254 // move
3255 if ($hasmanageactivities) {
3256 if ($moveselect) {
3257 $actions[] = new action_link(
3258 new moodle_url($baseurl, array('copy' => $mod->id)),
3259 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3260 null,
3261 array('class' => 'editing_move', 'title' => $str->move)
3262 );
3263 } else {
3264 $actions[] = new action_link(
3265 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3266 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3267 null,
3268 array('class' => 'editing_moveup', 'title' => $str->moveup)
3269 );
3270 $actions[] = new action_link(
3271 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3272 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3273 null,
3274 array('class' => 'editing_movedown', 'title' => $str->movedown)
3275 );
3276 }
3277 }
3278
3279 // Update
3280 if ($hasmanageactivities) {
3281 $actions[] = new action_link(
3282 new moodle_url($baseurl, array('update' => $mod->id)),
3283 new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3284 null,
3285 array('class' => 'editing_update', 'title' => $str->update)
3286 );
3287 }
3288
3289 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3290 if (has_all_capabilities($dupecaps, $coursecontext) && plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3291 $actions[] = new action_link(
3292 new moodle_url($baseurl, array('duplicate' => $mod->id)),
3293 new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3294 null,
3295 array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3296 );
3297 }
3298
3299 // Delete
3300 if ($hasmanageactivities) {
3301 $actions[] = new action_link(
3302 new moodle_url($baseurl, array('delete' => $mod->id)),
3303 new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3304 null,
3305 array('class' => 'editing_delete', 'title' => $str->delete)
3306 );
3307 }
3308
3309 // hideshow
3310 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3311 if ($mod->visible) {
3312 $actions[] = new action_link(
3313 new moodle_url($baseurl, array('hide' => $mod->id)),
3314 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3315 null,
3316 array('class' => 'editing_hide', 'title' => $str->hide)
3317 );
3318 } else {
3319 $actions[] = new action_link(
3320 new moodle_url($baseurl, array('show' => $mod->id)),
3321 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3322 null,
3323 array('class' => 'editing_show', 'title' => $str->show)
3324 );
3325 }
3326 }
3327
3328 // groupmode
3329 if ($hasmanageactivities and $mod->groupmode !== false) {
3330 if ($mod->groupmode == SEPARATEGROUPS) {
3331 $groupmode = 0;
3332 $grouptitle = $str->groupsseparate;
3333 $forcedgrouptitle = $str->forcedgroupsseparate;
3334 $groupclass = 'editing_groupsseparate';
3335 $groupimage = 't/groups';
3336 } else if ($mod->groupmode == VISIBLEGROUPS) {
3337 $groupmode = 1;
3338 $grouptitle = $str->groupsvisible;
3339 $forcedgrouptitle = $str->forcedgroupsvisible;
3340 $groupclass = 'editing_groupsvisible';
3341 $groupimage = 't/groupv';
3342 } else {
3343 $groupmode = 2;
3344 $grouptitle = $str->groupsnone;
3345 $forcedgrouptitle = $str->forcedgroupsnone;
3346 $groupclass = 'editing_groupsnone';
3347 $groupimage = 't/groupn';
3348 }
3349 if ($mod->groupmodelink) {
3350 $actions[] = new action_link(
3351 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3352 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3353 null,
3354 array('class' => $groupclass, 'title' => $grouptitle)
3355 );
3356 } else {
3357 $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3358 }
3359 }
3360
3361 // Assign
3362 if (has_capability('moodle/role:assign', $modcontext)){
3363 $actions[] = new action_link(
3364 new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3365 new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3366 null,
3367 array('class' => 'editing_assign', 'title' => $str->assign)
3368 );
3369 }
3370
3371 // The space added before the <span> is a ugly hack but required to set the CSS property white-space: nowrap
3372 // and having it to work without attaching the preceding text along with it. Hopefully the refactoring of
3373 // the course page HTML will allow this to be removed.
3374 $output = ' ' . html_writer::start_tag('span', array('class' => 'commands'));
3375 foreach ($actions as $action) {
3376 if ($action instanceof renderable) {
3377 $output .= $OUTPUT->render($action);
3378 } else {
3379 $output .= $action;
3380 }
3381 }
3382 $output .= html_writer::end_tag('span');
3383 return $output;
3384 }
3385
3386 /**
3387 * given a course object with shortname & fullname, this function will
3388 * truncate the the number of chars allowed and add ... if it was too long
3389 */
3390 function course_format_name ($course,$max=100) {
3391
3392 $context = context_course::instance($course->id);
3393 $shortname = format_string($course->shortname, true, array('context' => $context));
3394 $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3395 $str = $shortname.': '. $fullname;
3396 if (textlib::strlen($str) <= $max) {
3397 return $str;
3398 }
3399 else {
3400 return textlib::substr($str,0,$max-3).'...';
3401 }
3402 }
3403
3404 /**
3405 * Is the user allowed to add this type of module to this course?
3406 * @param object $course the course settings. Only $course->id is used.
3407 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3408 * @return bool whether the current user is allowed to add this type of module to this course.
3409 */
3410 function course_allowed_module($course, $modname) {
3411 if (is_numeric($modname)) {
3412 throw new coding_exception('Function course_allowed_module no longer
3413 supports numeric module ids. Please update your code to pass the module name.');
3414 }
3415
3416 $capability = 'mod/' . $modname . ':addinstance';
3417 if (!get_capability_info($capability)) {
3418 // Debug warning that the capability does not exist, but no more than once per page.
3419 static $warned = array();
3420 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3421 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3422 debugging('The module ' . $modname . ' does not define the standard capability ' .
3423 $capability , DEBUG_DEVELOPER);
3424 $warned[$modname] = 1;
3425 }
3426
3427 // If the capability does not exist, the module can always be added.
3428 return true;
3429 }
3430
3431 $coursecontext = context_course::instance($course->id);
3432 return has_capability($capability, $coursecontext);
3433 }
3434
3435 /**
3436 * Recursively delete category including all subcategories and courses.
3437 * @param stdClass $category
3438 * @param boolean $showfeedback display some notices
3439 * @return array return deleted courses
3440 */
3441 function category_delete_full($category, $showfeedback=true) {
3442 global $CFG, $DB;
3443 require_once($CFG->libdir.'/gradelib.php');
3444 require_once($CFG->libdir.'/questionlib.php');
3445 require_once($CFG->dirroot.'/cohort/lib.php');
3446
3447 if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3448 foreach ($children as $childcat) {
3449 category_delete_full($childcat, $showfeedback);
3450 }
3451 }
3452
3453 $deletedcourses = array();
3454 if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3455 foreach ($courses as $course) {
3456 if (!delete_course($course, false)) {
3457 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3458 }
3459 $deletedcourses[] = $course;
3460 }
3461 }
3462
3463 // move or delete cohorts in this context
3464 cohort_delete_category($category);
3465
3466 // now delete anything that may depend on course category context
3467 grade_course_category_delete($category->id, 0, $showfeedback);
3468 if (!question_delete_course_category($category, 0, $showfeedback)) {
3469 throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3470 }
3471
3472 // finally delete the category and it's context
3473 $DB->delete_records('course_categories', array('id'=>$category->id));
3474 delete_context(CONTEXT_COURSECAT, $category->id);
3475
3476 events_trigger('course_category_deleted', $category);
3477
3478 return $deletedcourses;
3479 }
3480
3481 /**
3482 * Delete category, but move contents to another category.
3483 * @param object $ccategory
3484 * @param int $newparentid category id
3485 * @return bool status
3486 */
3487 function category_delete_move($category, $newparentid, $showfeedback=true) {
3488 global $CFG, $DB, $OUTPUT;
3489 require_once($CFG->libdir.'/gradelib.php');
3490 require_once($CFG->libdir.'/questionlib.php');
3491 require_once($CFG->dirroot.'/cohort/lib.php');
3492
3493 if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3494 return false;
3495 }
3496
3497 if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3498 foreach ($children as $childcat) {
3499 move_category($childcat, $newparentcat);
3500 }
3501 }
3502
3503 if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3504 if (!move_courses(array_keys($courses), $newparentid)) {
3505 if ($showfeedback) {
3506 echo $OUTPUT->notification("Error moving courses");
3507 }
3508 return false;
3509 }
3510 if ($showfeedback) {
3511 echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3512 }
3513 }
3514
3515 // move or delete cohorts in this context
3516 cohort_delete_category($category);
3517
3518 // now delete anything that may depend on course category context
3519 grade_course_category_delete($category->id, $newparentid, $showfeedback);
3520 if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3521 if ($showfeedback) {
3522 echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3523 }
3524 return false;
3525 }
3526
3527 // finally delete the category and it's context
3528 $DB->delete_records('course_categories', array('id'=>$category->id));
3529 delete_context(CONTEXT_COURSECAT, $category->id);
3530
3531 events_trigger('course_category_deleted', $category);
3532
3533 if ($showfeedback) {
3534 echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3535 }
3536 return true;
3537 }
3538
3539 /**
3540 * Efficiently moves many courses around while maintaining
3541 * sortorder in order.
3542 *
3543 * @param array $courseids is an array of course ids
3544 * @param int $categoryid
3545 * @return bool success
3546 */
3547 function move_courses($courseids, $categoryid) {
3548 global $CFG, $DB, $OUTPUT;
3549
3550 if (empty($courseids)) {
3551 // nothing to do
3552 return;
3553 }
3554
3555 if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3556 return false;
3557 }
3558
3559 $courseids = array_reverse($courseids);
3560 $newparent = context_coursecat::instance($category->id);
3561 $i = 1;
3562
3563 foreach ($courseids as $courseid) {
3564 if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3565 $course = new stdClass();
3566 $course->id = $courseid;
3567 $course->category = $category->id;
3568 $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3569 if ($category->visible == 0) {
3570 // hide the course when moving into hidden category,
3571 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3572 $course->visible = 0;
3573 }
3574
3575 $DB->update_record('course', $course);
3576
3577 $context = context_course::instance($course->id);
3578 context_moved($context, $newparent);
3579 }
3580 }
3581 fix_course_sortorder();
3582
3583 return true;
3584 }
3585
3586 /**
3587 * Hide course category and child course and subcategories
3588 * @param stdClass $category
3589 * @return void
3590 */
3591 function course_category_hide($category) {
3592 global $DB;
3593
3594 $category->visible = 0;
3595 $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3596 $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3597 $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($category->id)); // store visible flag so that we can return to it if we immediately unhide
3598 $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3599 // get all child categories and hide too
3600 if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3601 foreach ($subcats as $cat) {
3602 $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3603 $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3604 $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3605 $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3606 }
3607 }
3608 }
3609
3610 /**
3611 * Show course category and child course and subcategories
3612 * @param stdClass $category
3613 * @return void
3614 */
3615 function course_category_show($category) {
3616 global $DB;
3617
3618 $category->visible = 1;
3619 $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3620 $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3621 $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3622 // get all child categories and unhide too
3623 if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3624 foreach ($subcats as $cat) {
3625 if ($cat->visibleold) {
3626 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3627 }
3628 $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3629 }
3630 }
3631 }
3632
3633 /**
3634 * Efficiently moves a category - NOTE that this can have
3635 * a huge impact access-control-wise...
3636 */
3637 function move_category($category, $newparentcat) {
3638 global $CFG, $DB;
3639
3640 $context = context_coursecat::instance($category->id);
3641
3642 $hidecat = false;
3643 if (empty($newparentcat->id)) {
3644 $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3645
3646 $newparent = context_system::instance();
3647
3648 } else {
3649 $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3650 $newparent = context_coursecat::instance($newparentcat->id);
3651
3652 if (!$newparentcat->visible and $category->visible) {
3653 // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3654 $hidecat = true;
3655 }
3656 }
3657
3658 context_moved($context, $newparent);
3659
3660 // now make it last in new category
3661 $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3662
3663 // and fix the sortorders
3664 fix_course_sortorder();
3665
3666 if ($hidecat) {
3667 course_category_hide($category);
3668 }
3669 }
3670
3671 /**
3672 * Returns the display name of the given section that the course prefers
3673 *
3674 * Implementation of this function is provided by course format
3675 * @see format_base::get_section_name()
3676 *
3677 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
3678 * @param int|stdClass $section Section object from database or just field course_sections.section
3679 * @return string Display name that the course format prefers, e.g. "Week 2"
3680 */
3681 function get_section_name($courseorid, $section) {
3682 return course_get_format($courseorid)->get_section_name($section);
3683 }
3684
3685 /**
3686 * Tells if current course format uses sections
3687 *
3688 * @param string $format Course format ID e.g. 'weeks' $course->format
3689 * @return bool
3690 */
3691 function course_format_uses_sections($format) {
3692 $course = new stdClass();
3693 $course->format = $format;
3694 return course_get_format($course)->uses_sections();
3695 }
3696
3697 /**
3698 * Returns the information about the ajax support in the given source format
3699 *
3700 * The returned object's property (boolean)capable indicates that
3701 * the course format supports Moodle course ajax features.
3702 * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3703 *
3704 * @param string $format
3705 * @return stdClass
3706 */
3707 function course_format_ajax_support($format) {
3708 $course = new stdClass();
3709 $course->format = $format;
3710 return course_get_format($course)->supports_ajax();
3711 }
3712
3713 /**
3714 * Can the current user delete this course?
3715 * Course creators have exception,
3716 * 1 day after the creation they can sill delete the course.
3717 * @param int $courseid
3718 * @return boolean
3719 */
3720 function can_delete_course($courseid) {
3721 global $USER, $DB;
3722
3723 $context = context_course::instance($courseid);
3724
3725 if (has_capability('moodle/course:delete', $context)) {
3726 return true;
3727 }
3728
3729 // hack: now try to find out if creator created this course recently (1 day)
3730 if (!has_capability('moodle/course:create', $context)) {
3731 return false;
3732 }
3733
3734 $since = time() - 60*60*24;
3735
3736 $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3737 $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3738
3739 return $DB->record_exists_select('log', $select, $params);
3740 }
3741
3742 /**
3743 * Save the Your name for 'Some role' strings.
3744 *
3745 * @param integer $courseid the id of this course.
3746 * @param array $data the data that came from the course settings form.
3747 */
3748 function save_local_role_names($courseid, $data) {
3749 global $DB;
3750 $context = context_course::instance($courseid);
3751
3752 foreach ($data as $fieldname => $value) {
3753 if (strpos($fieldname, 'role_') !== 0) {
3754 continue;
3755 }
3756 list($ignored, $roleid) = explode('_', $fieldname);
3757
3758 // make up our mind whether we want to delete, update or insert
3759 if (!$value) {
3760 $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3761
3762 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3763 $rolename->name = $value;
3764 $DB->update_record('role_names', $rolename);
3765
3766 } else {
3767 $rolename = new stdClass;
3768 $rolename->contextid = $context->id;
3769 $rolename->roleid = $roleid;
3770 $rolename->name = $value;
3771 $DB->insert_record('role_names', $rolename);
3772 }
3773 }
3774 }
3775
3776 /**
3777 * Create a course and either return a $course object
3778 *
3779 * Please note this functions does not verify any access control,
3780 * the calling code is responsible for all validation (usually it is the form definition).
3781 *
3782 * @param array $editoroptions course description editor options
3783 * @param object $data - all the data needed for an entry in the 'course' table
3784 * @return object new course instance
3785 */
3786 function create_course($data, $editoroptions = NULL) {
3787 global $CFG, $DB;
3788
3789 //check the categoryid - must be given for all new courses
3790 $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3791
3792 //check if the shortname already exist
3793 if (!empty($data->shortname)) {
3794 if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3795 throw new moodle_exception('shortnametaken');
3796 }
3797 }
3798
3799 //check if the id number already exist
3800 if (!empty($data->idnumber)) {
3801 if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3802 throw new moodle_exception('idnumbertaken');
3803 }
3804 }
3805
3806 $data->timecreated = time();
3807 $data->timemodified = $data->timecreated;
3808
3809 // place at beginning of any category
3810 $data->sortorder = 0;
3811
3812 if ($editoroptions) {
3813 // summary text is updated later, we need context to store the files first
3814 $data->summary = '';
3815 $data->summary_format = FORMAT_HTML;
3816 }
3817
3818 if (!isset($data->visible)) {
3819 // data not from form, add missing visibility info
3820 $data->visible = $category->visible;
3821 }
3822 $data->visibleold = $data->visible;
3823
3824 $newcourseid = $DB->insert_record('course', $data);
3825 $context = context_course::instance($newcourseid, MUST_EXIST);
3826
3827 if ($editoroptions) {
3828 // Save the files used in the summary editor and store
3829 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3830 $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3831 $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3832 }
3833
3834 // update course format options
3835 course_get_format($newcourseid)->update_course_format_options($data);
3836
3837 $course = course_get_format($newcourseid)->get_course();
3838
3839 // Setup the blocks
3840 blocks_add_default_course_blocks($course);
3841
3842 // Create a default section.
3843 course_create_sections_if_missing($course, 0);
3844
3845 fix_course_sortorder();
3846
3847 // new context created - better mark it as dirty
3848 mark_context_dirty($context->path);
3849
3850 // Save any custom role names.
3851 save_local_role_names($course->id, (array)$data);
3852
3853 // set up enrolments
3854 enrol_course_updated(true, $course, $data);
3855
3856 add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3857
3858 // Trigger events
3859 events_trigger('course_created', $course);
3860
3861 return $course;
3862 }
3863
3864 /**
3865 * Create a new course category and marks the context as dirty
3866 *
3867 * This function does not set the sortorder for the new category and
3868 * @see{fix_course_sortorder} should be called after creating a new course
3869 * category
3870 *
3871 * Please note that this function does not verify access control.
3872 *
3873 * @param object $category All of the data required for an entry in the course_categories table
3874 * @return object new course category
3875 */
3876 function create_course_category($category) {
3877 global $DB;
3878
3879 $category->timemodified = time();
3880 $category->id = $DB->insert_record('course_categories', $category);
3881 $category = $DB->get_record('course_categories', array('id' => $category->id));
3882
3883 // We should mark the context as dirty
3884 $category->context = context_coursecat::instance($category->id);
3885 $category->context->mark_dirty();
3886
3887 return $category;
3888 }
3889
3890 /**
3891 * Update a course.
3892 *
3893 * Please note this functions does not verify any access control,
3894 * the calling code is responsible for all validation (usually it is the form definition).
3895 *
3896 * @param object $data - all the data needed for an entry in the 'course' table
3897 * @param array $editoroptions course description editor options
3898 * @return void
3899 */
3900 function update_course($data, $editoroptions = NULL) {
3901 global $CFG, $DB;
3902
3903 $data->timemodified = time();
3904
3905 $oldcourse = course_get_format($data->id)->get_course();
3906 $context = context_course::instance($oldcourse->id);
3907
3908 if ($editoroptions) {
3909 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3910 }
3911
3912 if (!isset($data->category) or empty($data->category)) {
3913 // prevent nulls and 0 in category field
3914 unset($data->category);
3915 }
3916 $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3917
3918 if (!isset($data->visible)) {
3919 // data not from form, add missing visibility info
3920 $data->visible = $oldcourse->visible;
3921 }
3922
3923 if ($data->visible != $oldcourse->visible) {
3924 // reset the visibleold flag when manually hiding/unhiding course
3925 $data->visibleold = $data->visible;
3926 } else {
3927 if ($movecat) {
3928 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3929 if (empty($newcategory->visible)) {
3930 // make sure when moving into hidden category the course is hidden automatically
3931 $data->visible = 0;
3932 }
3933 }
3934 }
3935
3936 // Update with the new data
3937 $DB->update_record('course', $data);
3938 // make sure the modinfo cache is reset
3939 rebuild_course_cache($data->id);
3940
3941 // update course format options with full course data
3942 course_get_format($data->id)->update_course_format_options($data, $oldcourse);
3943
3944 $course = $DB->get_record('course', array('id'=>$data->id));
3945
3946 if ($movecat) {
3947 $newparent = context_coursecat::instance($course->category);
3948 context_moved($context, $newparent);
3949 }
3950
3951 fix_course_sortorder();
3952
3953 // Test for and remove blocks which aren't appropriate anymore
3954 blocks_remove_inappropriate($course);
3955
3956 // Save any custom role names.
3957 save_local_role_names($course->id, $data);
3958
3959 // update enrol settings
3960 enrol_course_updated(false, $course, $data);
3961
3962 add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3963
3964 // Trigger events
3965 events_trigger('course_updated', $course);
3966
3967 if ($oldcourse->format !== $course->format) {
3968 // Remove all options stored for the previous format
3969 // We assume that new course format migrated everything it needed watching trigger
3970 // 'course_updated' and in method format_XXX::update_course_format_options()
3971 $DB->delete_records('course_format_options',
3972 array('courseid' => $course->id, 'format' => $oldcourse->format));
3973 }
3974 }
3975
3976 /**
3977 * Average number of participants
3978 * @return integer
3979 */
3980 function average_number_of_participants() {
3981 global $DB, $SITE;
3982
3983 //count total of enrolments for visible course (except front page)
3984 $sql = 'SELECT COUNT(*) FROM (
3985 SELECT DISTINCT ue.userid, e.courseid
3986 FROM {user_enrolments} ue, {enrol} e, {course} c
3987 WHERE ue.enrolid = e.id
3988 AND e.courseid <> :siteid
3989 AND c.id = e.courseid
3990 AND c.visible = 1) total';
3991 $params = array('siteid' => $SITE->id);
3992 $enrolmenttotal = $DB->count_records_sql($sql, $params);
3993
3994
3995 //count total of visible courses (minus front page)
3996 $coursetotal = $DB->count_records('course', array('visible' => 1));
3997 $coursetotal = $coursetotal - 1 ;
3998
3999 //average of enrolment
4000 if (empty($coursetotal)) {
4001 $participantaverage = 0;
4002 } else {
4003 $participantaverage = $enrolmenttotal / $coursetotal;
4004 }
4005
4006 return $participantaverage;
4007 }
4008
4009 /**
4010 * Average number of course modules
4011 * @return integer
4012 */
4013 function average_number_of_courses_modules() {
4014 global $DB, $SITE;
4015
4016 //count total of visible course module (except front page)
4017 $sql = 'SELECT COUNT(*) FROM (
4018 SELECT cm.course, cm.module
4019 FROM {course} c, {course_modules} cm
4020 WHERE c.id = cm.course
4021 AND c.id <> :siteid
4022 AND cm.visible = 1
4023 AND c.visible = 1) total';
4024 $params = array('siteid' => $SITE->id);
4025 $moduletotal = $DB->count_records_sql($sql, $params);
4026
4027
4028 //count total of visible courses (minus front page)
4029 $coursetotal = $DB->count_records('course', array('visible' => 1));
4030 $coursetotal = $coursetotal - 1 ;
4031
4032 //average of course module
4033 if (empty($coursetotal)) {
4034 $coursemoduleaverage = 0;
4035 } else {
4036 $coursemoduleaverage = $moduletotal / $coursetotal;
4037 }
4038
4039 return $coursemoduleaverage;
4040 }
4041
4042 /**
4043 * This class pertains to course requests and contains methods associated with
4044 * create, approving, and removing course requests.
4045 *
4046 * Please note we do not allow embedded images here because there is no context
4047 * to store them with proper access control.
4048 *
4049 * @copyright 2009 Sam Hemelryk
4050 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4051 * @since Moodle 2.0
4052 *
4053 * @property-read int $id
4054 * @property-read string $fullname
4055 * @property-read string $shortname
4056 * @property-read string $summary
4057 * @property-read int $summaryformat
4058 * @property-read int $summarytrust
4059 * @property-read string $reason
4060 * @property-read int $requester
4061 */
4062 class course_request {
4063
4064 /**
4065 * This is the stdClass that stores the properties for the course request
4066 * and is externally accessed through the __get magic method
4067 * @var stdClass
4068 */
4069 protected $properties;
4070
4071 /**
4072 * An array of options for the summary editor used by course request forms.
4073 * This is initially set by {@link summary_editor_options()}
4074 * @var array
4075 * @static
4076 */
4077 protected static $summaryeditoroptions;
4078
4079 /**
4080 * Static function to prepare the summary editor for working with a course
4081 * request.
4082 *
4083 * @static
4084 * @param null|stdClass $data Optional, an object containing the default values
4085 * for the form, these may be modified when preparing the
4086 * editor so this should be called before creating the form
4087 * @return stdClass An object that can be used to set the default values for
4088 * an mforms form
4089 */
4090 public static function prepare($data=null) {
4091 if ($data === null) {
4092 $data = new stdClass;
4093 }
4094 $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
4095 return $data;
4096 }
4097
4098 /**
4099 * Static function to create a new course request when passed an array of properties
4100 * for it.
4101 *
4102 * This function also handles saving any files that may have been used in the editor
4103 *
4104 * @static
4105 * @param stdClass $data
4106 * @return course_request The newly created course request
4107 */
4108 public static function create($data) {
4109 global $USER, $DB, $CFG;
4110 $data->requester = $USER->id;
4111
4112 // Setting the default category if none set.
4113 if (empty($data->category) || empty($CFG->requestcategoryselection)) {
4114 $data->category = $CFG->defaultrequestcategory;
4115 }
4116
4117 // Summary is a required field so copy the text over
4118 $data->summary = $data->summary_editor['text'];
4119 $data->summaryformat = $data->summary_editor['format'];
4120
4121 $data->id = $DB->insert_record('course_request', $data);
4122
4123 // Create a new course_request object and return it
4124 $request = new course_request($data);
4125
4126 // Notify the admin if required.
4127 if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
4128
4129 $a = new stdClass;
4130 $a->link = "$CFG->wwwroot/course/pending.php";
4131 $a->user = fullname($USER);
4132 $subject = get_string('courserequest');
4133 $message = get_string('courserequestnotifyemail', 'admin', $a);
4134 foreach ($users as $user) {
4135 $request->notify($user, $USER, 'courserequested', $subject, $message);
4136 }
4137 }
4138
4139 return $request;
4140 }
4141
4142 /**
4143 * Returns an array of options to use with a summary editor
4144 *
4145 * @uses course_request::$summaryeditoroptions
4146 * @return array An array of options to use with the editor
4147 */
4148 public static function summary_editor_options() {
4149 global $CFG;
4150 if (self::$summaryeditoroptions === null) {
4151 self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
4152 }
4153 return self::$summaryeditoroptions;
4154 }
4155
4156 /**
4157 * Loads the properties for this course request object. Id is required and if
4158 * only id is provided then we load the rest of the properties from the database
4159 *
4160 * @param stdClass|int $properties Either an object containing properties
4161 * or the course_request id to load
4162 */
4163 public function __construct($properties) {
4164 global $DB;
4165 if (empty($properties->id)) {
4166 if (empty($properties)) {
4167 throw new coding_exception('You must provide a course request id when creating a course_request object');
4168 }
4169 $id = $properties;
4170 $properties = new stdClass;
4171 $properties->id = (int)$id;
4172 unset($id);
4173 }
4174 if (empty($properties->requester)) {
4175 if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
4176 print_error('unknowncourserequest');
4177 }
4178 } else {
4179 $this->properties = $properties;
4180 }
4181 $this->properties->collision = null;
4182 }
4183
4184 /**
4185 * Returns the requested property
4186 *
4187 * @param string $key
4188 * @return mixed
4189 */
4190 public function __get($key) {
4191 return $this->properties->$key;
4192 }
4193
4194 /**
4195 * Override this to ensure empty($request->blah) calls return a reliable answer...
4196 *
4197 * This is required because we define the __get method
4198 *
4199 * @param mixed $key
4200 * @return bool True is it not empty, false otherwise
4201 */
4202 public function __isset($key) {
4203 return (!empty($this->properties->$key));
4204 }
4205
4206 /**
4207 * Returns the user who requested this course
4208 *
4209 * Uses a static var to cache the results and cut down the number of db queries
4210 *
4211 * @staticvar array $requesters An array of cached users
4212 * @return stdClass The user who requested the course
4213 */
4214 public function get_requester() {
4215 global $DB;
4216 static $requesters= array();
4217 if (!array_key_exists($this->properties->requester, $requesters)) {
4218 $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
4219 }
4220 return $requesters[$this->properties->requester];
4221 }
4222
4223 /**
4224 * Checks that the shortname used by the course does not conflict with any other
4225 * courses that exist
4226 *
4227 * @param string|null $shortnamemark The string to append to the requests shortname
4228 * should a conflict be found
4229 * @return bool true is there is a conflict, false otherwise
4230 */
4231 public function check_shortname_collision($shortnamemark = '[*]') {
4232 global $DB;
4233
4234 if ($this->properties->collision !== null) {
4235 return $this->properties->collision;
4236 }
4237
4238 if (empty($this->properties->shortname)) {
4239 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
4240 $this->properties->collision = false;
4241 } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
4242 if (!empty($shortnamemark)) {
4243 $this->properties->shortname .= ' '.$shortnamemark;
4244 }
4245 $this->properties->collision = true;
4246 } else {
4247 $this->properties->collision = false;
4248 }
4249 return $this->properties->collision;
4250 }
4251
4252 /**
4253 * This function approves the request turning it into a course
4254 *
4255 * This function converts the course request into a course, at the same time
4256 * transferring any files used in the summary to the new course and then removing
4257 * the course request and the files associated with it.
4258 *
4259 * @return int The id of the course that was created from this request
4260 */
4261 public function approve() {
4262 global $CFG, $DB, $USER;
4263
4264 $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
4265
4266 $courseconfig = get_config('moodlecourse');
4267
4268 // Transfer appropriate settings
4269 $data = clone($this->properties);
4270 unset($data->id);
4271 unset($data->reason);
4272 unset($data->requester);
4273
4274 // If the category is not set, if the current user does not have the rights to change the category, or if the
4275 // category does not exist, we set the default category to the course to be approved.
4276 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
4277 if (empty($data->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
4278 (!$category = get_course_category($data->category))) {
4279 $category = get_course_category($CFG->defaultrequestcategory);
4280 }
4281
4282 // Set category
4283 $data->category = $category->id;
4284 $data->sortorder = $category->sortorder; // place as the first in category
4285
4286 // Set misc settings
4287 $data->requested = 1;
4288
4289 // Apply course default settings
4290 $data->format = $courseconfig->format;
4291 $data->newsitems = $courseconfig->newsitems;
4292 $data->showgrades = $courseconfig->showgrades;
4293 $data->showreports = $courseconfig->showreports;
4294 $data->maxbytes = $courseconfig->maxbytes;
4295 $data->groupmode = $courseconfig->groupmode;
4296 $data->groupmodeforce = $courseconfig->groupmodeforce;
4297 $data->visible = $courseconfig->visible;
4298 $data->visibleold = $data->visible;
4299 $data->lang = $courseconfig->lang;
4300
4301 $course = create_course($data);
4302 $context = context_course::instance($course->id, MUST_EXIST);
4303
4304 // add enrol instances
4305 if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
4306 if ($manual = enrol_get_plugin('manual')) {
4307 $manual->add_default_instance($course);
4308 }
4309 }
4310
4311 // enrol the requester as teacher if necessary
4312 if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
4313 enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
4314 }
4315
4316 $this->delete();
4317
4318 $a = new stdClass();
4319 $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
4320 $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
4321 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
4322
4323 return $course->id;
4324 }
4325
4326 /**
4327 * Reject a course request
4328 *
4329 * This function rejects a course request, emailing the requesting user the
4330 * provided notice and then removing the request from the database
4331 *
4332 * @param string $notice The message to display to the user
4333 */
4334 public function reject($notice) {
4335 global $USER, $DB;
4336 $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
4337 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
4338 $this->delete();
4339 }
4340
4341 /**
4342 * Deletes the course request and any associated files
4343 */
4344 public function delete() {
4345 global $DB;
4346 $DB->delete_records('course_request', array('id' => $this->properties->id));
4347 }
4348
4349 /**
4350 * Send a message from one user to another using events_trigger
4351 *
4352 * @param object $touser
4353 * @param object $fromuser
4354 * @param string $name
4355 * @param string $subject
4356 * @param string $message
4357 */
4358 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
4359 $eventdata = new stdClass();
4360 $eventdata->component = 'moodle';
4361 $eventdata->name = $name;
4362 $eventdata->userfrom = $fromuser;
4363 $eventdata->userto = $touser;
4364 $eventdata->subject = $subject;
4365 $eventdata->fullmessage = $message;
4366 $eventdata->fullmessageformat = FORMAT_PLAIN;
4367 $eventdata->fullmessagehtml = '';
4368 $eventdata->smallmessage = '';
4369 $eventdata->notification = 1;
4370 message_send($eventdata);
4371 }
4372 }
4373
4374 /**
4375 * Return a list of page types
4376 * @param string $pagetype current page type
4377 * @param stdClass $parentcontext Block's parent context
4378 * @param stdClass $currentcontext Current context of block
4379 */
4380 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
4381 // if above course context ,display all course fomats
4382 list($currentcontext, $course, $cm) = get_context_info_array($currentcontext->id);
4383 if ($course->id == SITEID) {
4384 return array('*'=>get_string('page-x', 'pagetype'));
4385 } else {
4386 return array('*'=>get_string('page-x', 'pagetype'),
4387 'course-*'=>get_string('page-course-x', 'pagetype'),
4388 'course-view-*'=>get_string('page-course-view-x', 'pagetype')
4389 );
4390 }
4391 }
4392
4393 /**
4394 * Determine whether course ajax should be enabled for the specified course
4395 *
4396 * @param stdClass $course The course to test against
4397 * @return boolean Whether course ajax is enabled or note
4398 */
4399 function course_ajax_enabled($course) {
4400 global $CFG, $PAGE, $SITE;
4401
4402 // Ajax must be enabled globally
4403 if (!$CFG->enableajax) {
4404 return false;
4405 }
4406
4407 // The user must be editing for AJAX to be included
4408 if (!$PAGE->user_is_editing()) {
4409 return false;
4410 }
4411
4412 // Check that the theme suports
4413 if (!$PAGE->theme->enablecourseajax) {
4414 return false;
4415 }
4416
4417 // Check that the course format supports ajax functionality
4418 // The site 'format' doesn't have information on course format support
4419 if ($SITE->id !== $course->id) {
4420 $courseformatajaxsupport = course_format_ajax_support($course->format);
4421 if (!$courseformatajaxsupport->capable) {
4422 return false;
4423 }
4424 }
4425
4426 // All conditions have been met so course ajax should be enabled
4427 return true;
4428 }
4429
4430 /**
4431 * Include the relevant javascript and language strings for the resource
4432 * toolbox YUI module
4433 *
4434 * @param integer $id The ID of the course being applied to
4435 * @param array $usedmodules An array containing the names of the modules in use on the page
4436 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
4437 * @param stdClass $config An object containing configuration parameters for ajax modules including:
4438 * * resourceurl The URL to post changes to for resource changes
4439 * * sectionurl The URL to post changes to for section changes
4440 * * pageparams Additional parameters to pass through in the post
4441 * @return bool
4442 */
4443 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
4444 global $PAGE, $SITE;
4445
4446 // Ensure that ajax should be included
4447 if (!course_ajax_enabled($course)) {
4448 return false;
4449 }
4450
4451 if (!$config) {
4452 $config = new stdClass();
4453 }
4454
4455 // The URL to use for resource changes
4456 if (!isset($config->resourceurl)) {
4457 $config->resourceurl = '/course/rest.php';
4458 }
4459
4460 // The URL to use for section changes
4461 if (!isset($config->sectionurl)) {
4462 $config->sectionurl = '/course/rest.php';
4463 }
4464
4465 // Any additional parameters which need to be included on page submission
4466 if (!isset($config->pageparams)) {
4467 $config->pageparams = array();
4468 }
4469
4470 // Include toolboxes
4471 $PAGE->requires->yui_module('moodle-course-toolboxes',
4472 'M.course.init_resource_toolbox',
4473 array(array(
4474 'courseid' => $course->id,
4475 'ajaxurl' => $config->resourceurl,
4476 'config' => $config,
4477 ))
4478 );
4479 $PAGE->requires->yui_module('moodle-course-toolboxes',
4480 'M.course.init_section_toolbox',
4481 array(array(
4482 'courseid' => $course->id,
4483 'format' => $course->format,
4484 'ajaxurl' => $config->sectionurl,
4485 'config' => $config,
4486 ))
4487 );
4488
4489 // Include course dragdrop
4490 if ($course->id != $SITE->id) {
4491 $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
4492 array(array(
4493 'courseid' => $course->id,
4494 'ajaxurl' => $config->sectionurl,
4495 'config' => $config,
4496 )), null, true);
4497
4498 $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
4499 array(array(
4500 'courseid' => $course->id,
4501 'ajaxurl' => $config->resourceurl,
4502 'config' => $config,
4503 )), null, true);
4504 }
4505
4506 // Include blocks dragdrop
4507 $params = array(
4508 'courseid' => $course->id,
4509 'pagetype' => $PAGE->pagetype,
4510 'pagelayout' => $PAGE->pagelayout,
4511 'subpage' => $PAGE->subpage,
4512 'regions' => $PAGE->blocks->get_regions(),
4513 );
4514 $PAGE->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true);
4515
4516 // Require various strings for the command toolbox
4517 $PAGE->requires->strings_for_js(array(
4518 'moveleft',
4519 'deletechecktype',
4520 'deletechecktypename',
4521 'edittitle',
4522 'edittitleinstructions',
4523 'show',
4524 'hide',
4525 'groupsnone',
4526 'groupsvisible',
4527 'groupsseparate',
4528 'clicktochangeinbrackets',
4529 'markthistopic',
4530 'markedthistopic',
4531 'move',
4532 'movesection',
4533 ), 'moodle');
4534
4535 // Include format-specific strings
4536 if ($course->id != $SITE->id) {
4537 $PAGE->requires->strings_for_js(array(
4538 'showfromothers',
4539 'hidefromothers',
4540 ), 'format_' . $course->format);
4541 }
4542
4543 // For confirming resource deletion we need the name of the module in question
4544 foreach ($usedmodules as $module => $modname) {
4545 $PAGE->requires->string_for_js('pluginname', $module);
4546 }
4547
4548 // Load drag and drop upload AJAX.
4549 dndupload_add_to_course($course, $enabledmodules);
4550
4551 // Add the module chooser
4552 $PAGE->requires->yui_module('moodle-course-modchooser',
4553 'M.course.init_chooser',
4554 array(array('courseid' => $course->id, 'closeButtonTitle' => get_string('close', 'editor')))
4555 );
4556 $PAGE->requires->strings_for_js(array(
4557 'addresourceoractivity',
4558 'modchooserenable',
4559 'modchooserdisable',
4560 ), 'moodle');
4561
4562 return true;
4563 }
4564
4565 /**
4566 * Returns the sorted list of available course formats, filtered by enabled if necessary
4567 *
4568 * @param bool $enabledonly return only formats that are enabled
4569 * @return array array of sorted format names
4570 */
4571 function get_sorted_course_formats($enabledonly = false) {
4572 global $CFG;
4573 $formats = get_plugin_list('format');
4574
4575 if (!empty($CFG->format_plugins_sortorder)) {
4576 $order = explode(',', $CFG->format_plugins_sortorder);
4577 $order = array_merge(array_intersect($order, array_keys($formats)),
4578 array_diff(array_keys($formats), $order));
4579 } else {
4580 $order = array_keys($formats);
4581 }
4582 if (!$enabledonly) {
4583 return $order;
4584 }
4585 $sortedformats = array();
4586 foreach ($order as $formatname) {
4587 if (!get_config('format_'.$formatname, 'disabled')) {
4588 $sortedformats[] = $formatname;
4589 }
4590 }
4591 return $sortedformats;
4592 }
4593
4594 /**
4595 * The URL to use for the specified course (with section)
4596 *
4597 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
4598 * @param int|stdClass $section Section object from database or just field course_sections.section
4599 * if omitted the course view page is returned
4600 * @param array $options options for view URL. At the moment core uses:
4601 * 'navigation' (bool) if true and section has no separate page, the function returns null
4602 * 'sr' (int) used by multipage formats to specify to which section to return
4603 * @return moodle_url The url of course
4604 */
4605 function course_get_url($courseorid, $section = null, $options = array()) {
4606 return course_get_format($courseorid)->get_view_url($section, $options);
4607 }
Read-only mirror of the Moodle CVS