Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/course/ -> view.php (source)

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

   1  <?php
   2  
   3  //  Display the course home page.
   4  
   5      require_once('../config.php');
   6      require_once ('lib.php');
   7      require_once($CFG->libdir.'/completionlib.php');
   8  
   9      $id          = optional_param('id', 0, PARAM_INT);
  10      $name        = optional_param('name', '', PARAM_TEXT);
  11      $edit        = optional_param('edit', -1, PARAM_BOOL);
  12      $hide        = optional_param('hide', 0, PARAM_INT);
  13      $show        = optional_param('show', 0, PARAM_INT);
  14      $idnumber    = optional_param('idnumber', '', PARAM_RAW);
  15      $sectionid   = optional_param('sectionid', 0, PARAM_INT);
  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); // Deprecated, use course/switchrole.php instead.
  20      $return      = optional_param('return', 0, PARAM_LOCALURL);
  21  
  22      $params = array();
  23      if (!empty($name)) {
  24          $params = array('shortname' => $name);
  25      } else if (!empty($idnumber)) {
  26          $params = array('idnumber' => $idnumber);
  27      } else if (!empty($id)) {
  28          $params = array('id' => $id);
  29      }else {
  30          print_error('unspecifycourseid', 'error');
  31      }
  32  
  33      $course = $DB->get_record('course', $params, '*', MUST_EXIST);
  34  
  35      $urlparams = array('id' => $course->id);
  36  
  37      // Sectionid should get priority over section number
  38      if ($sectionid) {
  39          $section = $DB->get_field('course_sections', 'section', array('id' => $sectionid, 'course' => $course->id), MUST_EXIST);
  40      }
  41      if ($section) {
  42          $urlparams['section'] = $section;
  43      }
  44  
  45      $PAGE->set_url('/course/view.php', $urlparams); // Defined here to avoid notices on errors etc
  46  
  47      // Prevent caching of this page to stop confusion when changing page after making AJAX changes
  48      $PAGE->set_cacheable(false);
  49  
  50      context_helper::preload_course($course->id);
  51      $context = context_course::instance($course->id, MUST_EXIST);
  52  
  53      // Remove any switched roles before checking login
  54      if ($switchrole == 0 && confirm_sesskey()) {
  55          role_switch($switchrole, $context);
  56      }
  57  
  58      require_login($course);
  59  
  60      // Switchrole - sanity check in cost-order...
  61      $reset_user_allowed_editing = false;
  62      if ($switchrole > 0 && confirm_sesskey() &&
  63          has_capability('moodle/role:switchroles', $context)) {
  64          // is this role assignable in this context?
  65          // inquiring minds want to know...
  66          $aroles = get_switchable_roles($context);
  67          if (is_array($aroles) && isset($aroles[$switchrole])) {
  68              role_switch($switchrole, $context);
  69              // Double check that this role is allowed here
  70              require_login($course);
  71          }
  72          // reset course page state - this prevents some weird problems ;-)
  73          $USER->activitycopy = false;
  74          $USER->activitycopycourse = NULL;
  75          unset($USER->activitycopyname);
  76          unset($SESSION->modform);
  77          $USER->editing = 0;
  78          $reset_user_allowed_editing = true;
  79      }
  80  
  81      //If course is hosted on an external server, redirect to corresponding
  82      //url with appropriate authentication attached as parameter
  83      if (file_exists($CFG->dirroot .'/course/externservercourse.php')) {
  84          include $CFG->dirroot .'/course/externservercourse.php';
  85          if (function_exists('extern_server_course')) {
  86              if ($extern_url = extern_server_course($course)) {
  87                  redirect($extern_url);
  88              }
  89          }
  90      }
  91  
  92  
  93      require_once($CFG->dirroot.'/calendar/lib.php');    /// This is after login because it needs $USER
  94  
  95      // Must set layout before gettting section info. See MDL-47555.
  96      $PAGE->set_pagelayout('course');
  97  
  98      if ($section and $section > 0) {
  99  
 100          // Get section details and check it exists.
 101          $modinfo = get_fast_modinfo($course);
 102          $coursesections = $modinfo->get_section_info($section, MUST_EXIST);
 103  
 104          // Check user is allowed to see it.
 105          if (!$coursesections->uservisible) {
 106              // Check if coursesection has conditions affecting availability and if
 107              // so, output availability info.
 108              if ($coursesections->visible && $coursesections->availableinfo) {
 109                  $sectionname     = get_section_name($course, $coursesections);
 110                  $message = get_string('notavailablecourse', '', $sectionname);
 111                  redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
 112              } else {
 113                  // Note: We actually already know they don't have this capability
 114                  // or uservisible would have been true; this is just to get the
 115                  // correct error message shown.
 116                  require_capability('moodle/course:viewhiddensections', $context);
 117              }
 118          }
 119      }
 120  
 121      // Fix course format if it is no longer installed
 122      $course->format = course_get_format($course)->get_format();
 123  
 124      $PAGE->set_pagetype('course-view-' . $course->format);
 125      $PAGE->set_other_editing_capability('moodle/course:update');
 126      $PAGE->set_other_editing_capability('moodle/course:manageactivities');
 127      $PAGE->set_other_editing_capability('moodle/course:activityvisibility');
 128      if (course_format_uses_sections($course->format)) {
 129          $PAGE->set_other_editing_capability('moodle/course:sectionvisibility');
 130          $PAGE->set_other_editing_capability('moodle/course:movesections');
 131      }
 132  
 133      // Preload course format renderer before output starts.
 134      // This is a little hacky but necessary since
 135      // format.php is not included until after output starts
 136      if (file_exists($CFG->dirroot.'/course/format/'.$course->format.'/renderer.php')) {
 137          require_once($CFG->dirroot.'/course/format/'.$course->format.'/renderer.php');
 138          if (class_exists('format_'.$course->format.'_renderer')) {
 139              // call get_renderer only if renderer is defined in format plugin
 140              // otherwise an exception would be thrown
 141              $PAGE->get_renderer('format_'. $course->format);
 142          }
 143      }
 144  
 145      if ($reset_user_allowed_editing) {
 146          // ugly hack
 147          unset($PAGE->_user_allowed_editing);
 148      }
 149  
 150      if (!isset($USER->editing)) {
 151          $USER->editing = 0;
 152      }
 153      if ($PAGE->user_allowed_editing()) {
 154          if (($edit == 1) and confirm_sesskey()) {
 155              $USER->editing = 1;
 156              // Redirect to site root if Editing is toggled on frontpage
 157              if ($course->id == SITEID) {
 158                  redirect($CFG->wwwroot .'/?redirect=0');
 159              } else if (!empty($return)) {
 160                  redirect($CFG->wwwroot . $return);
 161              } else {
 162                  $url = new moodle_url($PAGE->url, array('notifyeditingon' => 1));
 163                  redirect($url);
 164              }
 165          } else if (($edit == 0) and confirm_sesskey()) {
 166              $USER->editing = 0;
 167              if(!empty($USER->activitycopy) && $USER->activitycopycourse == $course->id) {
 168                  $USER->activitycopy       = false;
 169                  $USER->activitycopycourse = NULL;
 170              }
 171              // Redirect to site root if Editing is toggled on frontpage
 172              if ($course->id == SITEID) {
 173                  redirect($CFG->wwwroot .'/?redirect=0');
 174              } else if (!empty($return)) {
 175                  redirect($CFG->wwwroot . $return);
 176              } else {
 177                  redirect($PAGE->url);
 178              }
 179          }
 180  
 181          if (has_capability('moodle/course:sectionvisibility', $context)) {
 182              if ($hide && confirm_sesskey()) {
 183                  set_section_visible($course->id, $hide, '0');
 184                  redirect($PAGE->url);
 185              }
 186  
 187              if ($show && confirm_sesskey()) {
 188                  set_section_visible($course->id, $show, '1');
 189                  redirect($PAGE->url);
 190              }
 191          }
 192  
 193          if (!empty($section) && !empty($move) &&
 194                  has_capability('moodle/course:movesections', $context) && confirm_sesskey()) {
 195              $destsection = $section + $move;
 196              if (move_section_to($course, $section, $destsection)) {
 197                  if ($course->id == SITEID) {
 198                      redirect($CFG->wwwroot . '/?redirect=0');
 199                  } else {
 200                      redirect(course_get_url($course));
 201                  }
 202              } else {
 203                  echo $OUTPUT->notification('An error occurred while moving a section');
 204              }
 205          }
 206      } else {
 207          $USER->editing = 0;
 208      }
 209  
 210      $SESSION->fromdiscussion = $PAGE->url->out(false);
 211  
 212  
 213      if ($course->id == SITEID) {
 214          // This course is not a real course.
 215          redirect($CFG->wwwroot .'/');
 216      }
 217  
 218      // Determine whether the user has permission to download course content.
 219      $candownloadcourse = \core\content::can_export_context($context, $USER);
 220  
 221      // We are currently keeping the button here from 1.x to help new teachers figure out
 222      // what to do, even though the link also appears in the course admin block.  It also
 223      // means you can back out of a situation where you removed the admin block. :)
 224      if ($PAGE->user_allowed_editing()) {
 225          $buttons = $OUTPUT->edit_button($PAGE->url);
 226          $PAGE->set_button($buttons);
 227      } else if ($candownloadcourse) {
 228          // Show the download course content button if user has permission to access it.
 229          // Only showing this if user doesn't have edit rights, since those who do will access it via the actions menu.
 230          $buttonattr = \core_course\output\content_export_link::get_attributes($context);
 231          $button = new single_button($buttonattr->url, $buttonattr->displaystring, 'post', false, $buttonattr->elementattributes);
 232          $PAGE->set_button($OUTPUT->render($button));
 233      }
 234  
 235      // If viewing a section, make the title more specific
 236      if ($section and $section > 0 and course_format_uses_sections($course->format)) {
 237          $sectionname = get_string('sectionname', "format_$course->format");
 238          $sectiontitle = get_section_name($course, $section);
 239          $PAGE->set_title(get_string('coursesectiontitle', 'moodle', array('course' => $course->fullname, 'sectiontitle' => $sectiontitle, 'sectionname' => $sectionname)));
 240      } else {
 241          $PAGE->set_title(get_string('coursetitle', 'moodle', array('course' => $course->fullname)));
 242      }
 243  
 244      $PAGE->set_heading($course->fullname);
 245      echo $OUTPUT->header();
 246  
 247      if ($USER->editing == 1) {
 248  
 249          // MDL-65321 The backup libraries are quite heavy, only require the bare minimum.
 250          require_once($CFG->dirroot . '/backup/util/helper/async_helper.class.php');
 251  
 252          if (async_helper::is_async_pending($id, 'course', 'backup')) {
 253              echo $OUTPUT->notification(get_string('pendingasyncedit', 'backup'), 'warning');
 254          }
 255      }
 256  
 257      // Course wrapper start.
 258      echo html_writer::start_tag('div', array('class'=>'course-content'));
 259  
 260      // make sure that section 0 exists (this function will create one if it is missing)
 261      course_create_sections_if_missing($course, 0);
 262  
 263      // get information about course modules and existing module types
 264      // format.php in course formats may rely on presence of these variables
 265      $modinfo = get_fast_modinfo($course);
 266      $modnames = get_module_types_names();
 267      $modnamesplural = get_module_types_names(true);
 268      $modnamesused = $modinfo->get_used_module_names();
 269      $mods = $modinfo->get_cms();
 270      $sections = $modinfo->get_section_info_all();
 271  
 272      // CAUTION, hacky fundamental variable defintion to follow!
 273      // Note that because of the way course fromats are constructed though
 274      // inclusion we pass parameters around this way..
 275      $displaysection = $section;
 276  
 277      // Include the actual course format.
 278      require($CFG->dirroot .'/course/format/'. $course->format .'/format.php');
 279      // Content wrapper end.
 280  
 281      echo html_writer::end_tag('div');
 282  
 283      // Trigger course viewed event.
 284      // We don't trust $context here. Course format inclusion above executes in the global space. We can't assume
 285      // anything after that point.
 286      course_view(context_course::instance($course->id), $section);
 287  
 288      // Include course AJAX
 289      include_course_ajax($course, $modnamesused);
 290  
 291      // If available, include the JS to prepare the download course content modal.
 292      if ($candownloadcourse) {
 293          $PAGE->requires->js_call_amd('core_course/downloadcontent', 'init');
 294      }
 295  
 296      // Load the view JS module if completion tracking is enabled for this course.
 297      $completion = new completion_info($course);
 298      if ($completion->is_enabled()) {
 299          $PAGE->requires->js_call_amd('core_course/view', 'init');
 300      }
 301  
 302      echo $OUTPUT->footer();