MDL-32508 course/view.php: moderise with MUST_EXIST
[moodle.git] / course / view.php
1 <?php
3 //  Display the course home page.
5     require_once('../config.php');
6     require_once('lib.php');
7     require_once($CFG->dirroot.'/mod/forum/lib.php');
8     require_once($CFG->libdir.'/completionlib.php');
10     $id          = optional_param('id', 0, PARAM_INT);
11     $name        = optional_param('name', '', PARAM_RAW);
12     $edit        = optional_param('edit', -1, PARAM_BOOL);
13     $hide        = optional_param('hide', 0, PARAM_INT);
14     $show        = optional_param('show', 0, PARAM_INT);
15     $idnumber    = optional_param('idnumber', '', PARAM_RAW);
16     $section     = optional_param('section', 0, PARAM_INT);
17     $move        = optional_param('move', 0, PARAM_INT);
18     $marker      = optional_param('marker',-1 , PARAM_INT);
19     $switchrole  = optional_param('switchrole',-1, PARAM_INT);
21     $params = array();
22     if (!empty($name)) {
23         $params = array('shortname' => $name);
24     } else if (!empty($idnumber)) {
25         $params = array('idnumber' => $idnumber);
26     } else if (!empty($id)) {
27         $params = array('id' => $id);
28     }else {
29         print_error('unspecifycourseid', 'error');
30     }
32     $course = $DB->get_record('course', $params, '*', MUST_EXIST);
34     $PAGE->set_url('/course/view.php', array('id' => $course->id)); // Defined here to avoid notices on errors etc
36     preload_course_contexts($course->id);
37     $context = context_course::instance($course->id, MUST_EXIST);
39     // Remove any switched roles before checking login
40     if ($switchrole == 0 && confirm_sesskey()) {
41         role_switch($switchrole, $context);
42     }
44     require_login($course);
46     // Switchrole - sanity check in cost-order...
47     $reset_user_allowed_editing = false;
48     if ($switchrole > 0 && confirm_sesskey() &&
49         has_capability('moodle/role:switchroles', $context)) {
50         // is this role assignable in this context?
51         // inquiring minds want to know...
52         $aroles = get_switchable_roles($context);
53         if (is_array($aroles) && isset($aroles[$switchrole])) {
54             role_switch($switchrole, $context);
55             // Double check that this role is allowed here
56             require_login($course);
57         }
58         // reset course page state - this prevents some weird problems ;-)
59         $USER->activitycopy = false;
60         $USER->activitycopycourse = NULL;
61         unset($USER->activitycopyname);
62         unset($SESSION->modform);
63         $USER->editing = 0;
64         $reset_user_allowed_editing = true;
65     }
67     //If course is hosted on an external server, redirect to corresponding
68     //url with appropriate authentication attached as parameter
69     if (file_exists($CFG->dirroot .'/course/externservercourse.php')) {
70         include $CFG->dirroot .'/course/externservercourse.php';
71         if (function_exists('extern_server_course')) {
72             if ($extern_url = extern_server_course($course)) {
73                 redirect($extern_url);
74             }
75         }
76     }
79     require_once($CFG->dirroot.'/calendar/lib.php');    /// This is after login because it needs $USER
81     add_to_log($course->id, 'course', 'view', "view.php?id=$course->id", "$course->id");
83     $course->format = clean_param($course->format, PARAM_ALPHA);
84     if (!file_exists($CFG->dirroot.'/course/format/'.$course->format.'/format.php')) {
85         $course->format = 'weeks';  // Default format is weeks
86     }
88     $PAGE->set_pagelayout('course');
89     $PAGE->set_pagetype('course-view-' . $course->format);
90     $PAGE->set_other_editing_capability('moodle/course:manageactivities');
92     if ($reset_user_allowed_editing) {
93         // ugly hack
94         unset($PAGE->_user_allowed_editing);
95     }
97     if (!isset($USER->editing)) {
98         $USER->editing = 0;
99     }
100     if ($PAGE->user_allowed_editing()) {
101         if (($edit == 1) and confirm_sesskey()) {
102             $USER->editing = 1;
103             // Redirect to site root if Editing is toggled on frontpage
104             if ($course->id == SITEID) {
105                 redirect($CFG->wwwroot .'/?redirect=0');
106             } else {
107                 redirect($PAGE->url);
108             }
109         } else if (($edit == 0) and confirm_sesskey()) {
110             $USER->editing = 0;
111             if(!empty($USER->activitycopy) && $USER->activitycopycourse == $course->id) {
112                 $USER->activitycopy       = false;
113                 $USER->activitycopycourse = NULL;
114             }
115             // Redirect to site root if Editing is toggled on frontpage
116             if ($course->id == SITEID) {
117                 redirect($CFG->wwwroot .'/?redirect=0');
118             } else {
119                 redirect($PAGE->url);
120             }
121         }
123         if (has_capability('moodle/course:update', $context)) {
124             if ($hide && confirm_sesskey()) {
125                 set_section_visible($course->id, $hide, '0');
126             }
128             if ($show && confirm_sesskey()) {
129                 set_section_visible($course->id, $show, '1');
130             }
132             if (!empty($section)) {
133                 if (!empty($move) and confirm_sesskey()) {
134                     if (move_section($course, $section, $move)) {
135                         if ($course->id == SITEID) {
136                             redirect($CFG->wwwroot . '/?redirect=0');
137                         } else {
138                             redirect($PAGE->url);
139                         }
140                     } else {
141                         echo $OUTPUT->notification('An error occurred while moving a section');
142                     }
143                 }
144             }
145         }
146     } else {
147         $USER->editing = 0;
148     }
150     $SESSION->fromdiscussion = $CFG->wwwroot .'/course/view.php?id='. $course->id;
153     if ($course->id == SITEID) {
154         // This course is not a real course.
155         redirect($CFG->wwwroot .'/');
156     }
158     $completion = new completion_info($course);
159     if ($completion->is_enabled() && ajaxenabled()) {
160         $PAGE->requires->string_for_js('completion-title-manual-y', 'completion');
161         $PAGE->requires->string_for_js('completion-title-manual-n', 'completion');
162         $PAGE->requires->string_for_js('completion-alt-manual-y', 'completion');
163         $PAGE->requires->string_for_js('completion-alt-manual-n', 'completion');
165         $PAGE->requires->js_init_call('M.core_completion.init');
166     }
168     // We are currently keeping the button here from 1.x to help new teachers figure out
169     // what to do, even though the link also appears in the course admin block.  It also
170     // means you can back out of a situation where you removed the admin block. :)
171     if ($PAGE->user_allowed_editing()) {
172         $buttons = $OUTPUT->edit_button(new moodle_url('/course/view.php', array('id' => $course->id)));
173         $PAGE->set_button($buttons);
174     }
176     $PAGE->set_title(get_string('course') . ': ' . $course->fullname);
177     $PAGE->set_heading($course->fullname);
178     echo $OUTPUT->header();
180     if ($completion->is_enabled() && ajaxenabled()) {
181         // This value tracks whether there has been a dynamic change to the page.
182         // It is used so that if a user does this - (a) set some tickmarks, (b)
183         // go to another page, (c) clicks Back button - the page will
184         // automatically reload. Otherwise it would start with the wrong tick
185         // values.
186         echo html_writer::start_tag('form', array('action'=>'.', 'method'=>'get'));
187         echo html_writer::start_tag('div');
188         echo html_writer::empty_tag('input', array('type'=>'hidden', 'id'=>'completion_dynamic_change', 'name'=>'completion_dynamic_change', 'value'=>'0'));
189         echo html_writer::end_tag('div');
190         echo html_writer::end_tag('form');
191     }
193     // Course wrapper start.
194     echo html_writer::start_tag('div', array('class'=>'course-content'));
196     $modinfo = get_fast_modinfo($COURSE);
197     get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
198     foreach($mods as $modid=>$unused) {
199         if (!isset($modinfo->cms[$modid])) {
200             rebuild_course_cache($course->id);
201             $modinfo = get_fast_modinfo($COURSE);
202             debugging('Rebuilding course cache', DEBUG_DEVELOPER);
203             break;
204         }
205     }
207     if (! $sections = get_all_sections($course->id)) {   // No sections found
208         // Double-check to be extra sure
209         if (! $section = $DB->get_record('course_sections', array('course'=>$course->id, 'section'=>0))) {
210             $section->course = $course->id;   // Create a default section.
211             $section->section = 0;
212             $section->visible = 1;
213             $section->summaryformat = FORMAT_HTML;
214             $section->id = $DB->insert_record('course_sections', $section);
215         }
216         if (! $sections = get_all_sections($course->id) ) {      // Try again
217             print_error('cannotcreateorfindstructs', 'error');
218         }
219     }
221     // Include the actual course format.
222     require($CFG->dirroot .'/course/format/'. $course->format .'/format.php');
223     // Content wrapper end.
225     echo html_writer::end_tag('div');
227     // Include the command toolbox YUI module
228     include_course_ajax($course, $modnamesused);
230     echo $OUTPUT->footer();