Merge branch 'wip-mdl-33367' of git://github.com/rajeshtaneja/moodle
[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.'/conditionlib.php');
9     require_once($CFG->libdir.'/completionlib.php');
11     $id          = optional_param('id', 0, PARAM_INT);
12     $name        = optional_param('name', '', PARAM_RAW);
13     $edit        = optional_param('edit', -1, PARAM_BOOL);
14     $hide        = optional_param('hide', 0, PARAM_INT);
15     $show        = optional_param('show', 0, PARAM_INT);
16     $idnumber    = optional_param('idnumber', '', PARAM_RAW);
17     $sectionid   = optional_param('sectionid', 0, PARAM_INT);
18     $section     = optional_param('section', 0, PARAM_INT);
19     $move        = optional_param('move', 0, PARAM_INT);
20     $marker      = optional_param('marker',-1 , PARAM_INT);
21     $switchrole  = optional_param('switchrole',-1, PARAM_INT);
22     $modchooser  = optional_param('modchooser', -1, PARAM_BOOL);
24     $params = array();
25     if (!empty($name)) {
26         $params = array('shortname' => $name);
27     } else if (!empty($idnumber)) {
28         $params = array('idnumber' => $idnumber);
29     } else if (!empty($id)) {
30         $params = array('id' => $id);
31     }else {
32         print_error('unspecifycourseid', 'error');
33     }
35     $course = $DB->get_record('course', $params, '*', MUST_EXIST);
37     $urlparams = array('id' => $course->id);
39     // Sectionid should get priority over section number
40     if ($sectionid) {
41         $section = $DB->get_field('course_sections', 'section', array('id' => $sectionid, 'course' => $course->id), MUST_EXIST);
42     }
43     if ($section) {
44         $urlparams['section'] = $section;
45     }
47     $PAGE->set_url('/course/view.php', $urlparams); // Defined here to avoid notices on errors etc
49     // Prevent caching of this page to stop confusion when changing page after making AJAX changes
50     $PAGE->set_cacheable(false);
52     preload_course_contexts($course->id);
53     $context = context_course::instance($course->id, MUST_EXIST);
55     // Remove any switched roles before checking login
56     if ($switchrole == 0 && confirm_sesskey()) {
57         role_switch($switchrole, $context);
58     }
60     require_login($course);
62     // Switchrole - sanity check in cost-order...
63     $reset_user_allowed_editing = false;
64     if ($switchrole > 0 && confirm_sesskey() &&
65         has_capability('moodle/role:switchroles', $context)) {
66         // is this role assignable in this context?
67         // inquiring minds want to know...
68         $aroles = get_switchable_roles($context);
69         if (is_array($aroles) && isset($aroles[$switchrole])) {
70             role_switch($switchrole, $context);
71             // Double check that this role is allowed here
72             require_login($course);
73         }
74         // reset course page state - this prevents some weird problems ;-)
75         $USER->activitycopy = false;
76         $USER->activitycopycourse = NULL;
77         unset($USER->activitycopyname);
78         unset($SESSION->modform);
79         $USER->editing = 0;
80         $reset_user_allowed_editing = true;
81     }
83     //If course is hosted on an external server, redirect to corresponding
84     //url with appropriate authentication attached as parameter
85     if (file_exists($CFG->dirroot .'/course/externservercourse.php')) {
86         include $CFG->dirroot .'/course/externservercourse.php';
87         if (function_exists('extern_server_course')) {
88             if ($extern_url = extern_server_course($course)) {
89                 redirect($extern_url);
90             }
91         }
92     }
95     require_once($CFG->dirroot.'/calendar/lib.php');    /// This is after login because it needs $USER
97     $logparam = 'id='. $course->id;
98     $loglabel = 'view';
99     $infoid = $course->id;
100     if(!empty($section)) {
101         $logparam .= '&section='. $section;
102         $loglabel = 'view section';
103         $sectionparams = array('course' => $course->id, 'section' => $section);
104         if ($coursesections = $DB->get_record('course_sections', $sectionparams, 'id', MUST_EXIST)) {
105             $infoid = $coursesections->id;
106     }
107     }
108     add_to_log($course->id, 'course', $loglabel, "view.php?". $logparam, $infoid);
110     $course->format = clean_param($course->format, PARAM_ALPHA);
111     if (!file_exists($CFG->dirroot.'/course/format/'.$course->format.'/format.php')) {
112         $course->format = 'weeks';  // Default format is weeks
113     }
115     $PAGE->set_pagelayout('course');
116     $PAGE->set_pagetype('course-view-' . $course->format);
117     $PAGE->set_other_editing_capability('moodle/course:manageactivities');
119     if ($reset_user_allowed_editing) {
120         // ugly hack
121         unset($PAGE->_user_allowed_editing);
122     }
124     if (!isset($USER->editing)) {
125         $USER->editing = 0;
126     }
127     if ($PAGE->user_allowed_editing()) {
128         if (($edit == 1) and confirm_sesskey()) {
129             $USER->editing = 1;
130             // Redirect to site root if Editing is toggled on frontpage
131             if ($course->id == SITEID) {
132                 redirect($CFG->wwwroot .'/?redirect=0');
133             } else {
134                 $url = new moodle_url($PAGE->url, array('editingenabled' => 1));
135                 redirect($url);
136             }
137         } else if (($edit == 0) and confirm_sesskey()) {
138             $USER->editing = 0;
139             if(!empty($USER->activitycopy) && $USER->activitycopycourse == $course->id) {
140                 $USER->activitycopy       = false;
141                 $USER->activitycopycourse = NULL;
142             }
143             // Redirect to site root if Editing is toggled on frontpage
144             if ($course->id == SITEID) {
145                 redirect($CFG->wwwroot .'/?redirect=0');
146             } else {
147                 redirect($PAGE->url);
148             }
149         }
150         if (($modchooser == 1) && confirm_sesskey()) {
151             set_user_preference('usemodchooser', $modchooser);
152         } else if (($modchooser == 0) && confirm_sesskey()) {
153             set_user_preference('usemodchooser', $modchooser);
154         }
156         if (has_capability('moodle/course:update', $context)) {
157             if ($hide && confirm_sesskey()) {
158                 set_section_visible($course->id, $hide, '0');
159                 redirect($PAGE->url);
160             }
162             if ($show && confirm_sesskey()) {
163                 set_section_visible($course->id, $show, '1');
164                 redirect($PAGE->url);
165             }
167             if (!empty($section)) {
168                 if (!empty($move) and confirm_sesskey()) {
169                     $destsection = $section + $move;
170                     if (move_section_to($course, $section, $destsection)) {
171                         // Rebuild course cache, after moving section
172                         rebuild_course_cache($course->id, true);
173                         if ($course->id == SITEID) {
174                             redirect($CFG->wwwroot . '/?redirect=0');
175                         } else {
176                             redirect(course_get_url($course));
177                         }
178                     } else {
179                         echo $OUTPUT->notification('An error occurred while moving a section');
180                     }
181                 }
182             }
183         }
184     } else {
185         $USER->editing = 0;
186     }
188     $SESSION->fromdiscussion = $PAGE->url->out(false);
191     if ($course->id == SITEID) {
192         // This course is not a real course.
193         redirect($CFG->wwwroot .'/');
194     }
196     $completion = new completion_info($course);
197     if ($completion->is_enabled() && ajaxenabled()) {
198         $PAGE->requires->string_for_js('completion-title-manual-y', 'completion');
199         $PAGE->requires->string_for_js('completion-title-manual-n', 'completion');
200         $PAGE->requires->string_for_js('completion-alt-manual-y', 'completion');
201         $PAGE->requires->string_for_js('completion-alt-manual-n', 'completion');
203         $PAGE->requires->js_init_call('M.core_completion.init');
204     }
206     // We are currently keeping the button here from 1.x to help new teachers figure out
207     // what to do, even though the link also appears in the course admin block.  It also
208     // means you can back out of a situation where you removed the admin block. :)
209     if ($PAGE->user_allowed_editing()) {
210         $buttons = $OUTPUT->edit_button($PAGE->url);
211         $PAGE->set_button($buttons);
212     }
214     $PAGE->set_title(get_string('course') . ': ' . $course->fullname);
215     $PAGE->set_heading($course->fullname);
216     echo $OUTPUT->header();
218     if ($completion->is_enabled() && ajaxenabled()) {
219         // This value tracks whether there has been a dynamic change to the page.
220         // It is used so that if a user does this - (a) set some tickmarks, (b)
221         // go to another page, (c) clicks Back button - the page will
222         // automatically reload. Otherwise it would start with the wrong tick
223         // values.
224         echo html_writer::start_tag('form', array('action'=>'.', 'method'=>'get'));
225         echo html_writer::start_tag('div');
226         echo html_writer::empty_tag('input', array('type'=>'hidden', 'id'=>'completion_dynamic_change', 'name'=>'completion_dynamic_change', 'value'=>'0'));
227         echo html_writer::end_tag('div');
228         echo html_writer::end_tag('form');
229     }
231     // Course wrapper start.
232     echo html_writer::start_tag('div', array('class'=>'course-content'));
234     $modinfo = get_fast_modinfo($COURSE);
235     get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
236     foreach($mods as $modid=>$unused) {
237         if (!isset($modinfo->cms[$modid])) {
238             rebuild_course_cache($course->id);
239             $modinfo = get_fast_modinfo($COURSE);
240             debugging('Rebuilding course cache', DEBUG_DEVELOPER);
241             break;
242         }
243     }
245     if (!$sections = $modinfo->get_section_info_all()) {   // No sections found
246         $section = new stdClass;
247         $section->course = $course->id;   // Create a default section.
248         $section->section = 0;
249         $section->visible = 1;
250         $section->summaryformat = FORMAT_HTML;
251         $section->id = $DB->insert_record('course_sections', $section);
252         rebuild_course_cache($course->id);
253         $modinfo = get_fast_modinfo($COURSE);
254         if (!$sections = $modinfo->get_section_info_all()) {      // Try again
255             print_error('cannotcreateorfindstructs', 'error');
256         }
257     }
259     // CAUTION, hacky fundamental variable defintion to follow!
260     // Note that because of the way course fromats are constructed though
261     // inclusion we pass parameters around this way..
262     $displaysection = $section;
264     // Include the actual course format.
265     require($CFG->dirroot .'/course/format/'. $course->format .'/format.php');
266     // Content wrapper end.
268     echo html_writer::end_tag('div');
270     // Include course AJAX
271     if (include_course_ajax($course, $modnamesused)) {
272         // Add the module chooser
273         $renderer = $PAGE->get_renderer('core', 'course');
274         echo $renderer->course_modchooser(get_module_metadata($course, $modnames), $course);
275     }
277     echo $OUTPUT->footer();