Merge branch 'MDL-80544' of https://github.com/paulholden/moodle
[moodle.git] / course / edit.php
blob77d2497fae0e747ce066f8360509a08b8fa0c319
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17 /**
18 * Edit course settings
20 * @package core_course
21 * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 require_once('../config.php');
26 require_once('lib.php');
27 require_once('edit_form.php');
29 $id = optional_param('id', 0, PARAM_INT); // Course id.
30 $categoryid = optional_param('category', 0, PARAM_INT); // Course category - can be changed in edit form.
31 $returnto = optional_param('returnto', 0, PARAM_ALPHANUM); // Generic navigation return page switch.
32 $returnurl = optional_param('returnurl', '', PARAM_LOCALURL); // A return URL. returnto must also be set to 'url'.
34 if ($returnto === 'url' && confirm_sesskey() && $returnurl) {
35 // If returnto is 'url' then $returnurl may be used as the destination to return to after saving or cancelling.
36 // Sesskey must be specified, and would be set by the form anyway.
37 $returnurl = new moodle_url($returnurl);
38 } else {
39 if (!empty($id)) {
40 $returnurl = new moodle_url($CFG->wwwroot . '/course/view.php', array('id' => $id));
41 } else {
42 $returnurl = new moodle_url($CFG->wwwroot . '/course/');
44 if ($returnto !== 0) {
45 switch ($returnto) {
46 case 'category':
47 $returnurl = new moodle_url($CFG->wwwroot . '/course/index.php', array('categoryid' => $categoryid));
48 break;
49 case 'catmanage':
50 $returnurl = new moodle_url($CFG->wwwroot . '/course/management.php', array('categoryid' => $categoryid));
51 break;
52 case 'topcatmanage':
53 $returnurl = new moodle_url($CFG->wwwroot . '/course/management.php');
54 break;
55 case 'topcat':
56 $returnurl = new moodle_url($CFG->wwwroot . '/course/');
57 break;
58 case 'pending':
59 $returnurl = new moodle_url($CFG->wwwroot . '/course/pending.php');
60 break;
65 $PAGE->set_pagelayout('admin');
66 if ($id) {
67 $pageparams = array('id' => $id);
68 } else {
69 $pageparams = array('category' => $categoryid);
71 if ($returnto !== 0) {
72 $pageparams['returnto'] = $returnto;
73 if ($returnto === 'url' && $returnurl) {
74 $pageparams['returnurl'] = $returnurl;
77 $PAGE->set_url('/course/edit.php', $pageparams);
79 // Basic access control checks.
80 if ($id) {
81 // Editing course.
82 if ($id == SITEID){
83 // Don't allow editing of 'site course' using this from.
84 throw new \moodle_exception('cannoteditsiteform');
87 // Login to the course and retrieve also all fields defined by course format.
88 $course = get_course($id);
89 require_login($course);
90 $course = course_get_format($course)->get_course();
92 $category = $DB->get_record('course_categories', array('id'=>$course->category), '*', MUST_EXIST);
93 $coursecontext = context_course::instance($course->id);
94 require_capability('moodle/course:update', $coursecontext);
96 } else if ($categoryid) {
97 // Creating new course in this category.
98 $course = null;
99 require_login();
100 $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
101 $catcontext = context_coursecat::instance($category->id);
102 require_capability('moodle/course:create', $catcontext);
103 $PAGE->set_context($catcontext);
105 } else {
106 // Creating new course in default category.
107 $course = null;
108 require_login();
109 $category = core_course_category::get_default();
110 $catcontext = context_coursecat::instance($category->id);
111 require_capability('moodle/course:create', $catcontext);
112 $PAGE->set_context($catcontext);
115 // We are adding a new course and have a category context.
116 if (isset($catcontext)) {
117 $PAGE->set_secondary_active_tab('categorymain');
120 // Prepare course and the editor.
121 $editoroptions = array('maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes'=>$CFG->maxbytes, 'trusttext'=>false, 'noclean'=>true);
122 $overviewfilesoptions = course_overviewfiles_options($course);
123 if (!empty($course)) {
124 // Add context for editor.
125 $editoroptions['context'] = $coursecontext;
126 $editoroptions['subdirs'] = file_area_contains_subdirs($coursecontext, 'course', 'summary', 0);
127 $course = file_prepare_standard_editor($course, 'summary', $editoroptions, $coursecontext, 'course', 'summary', 0);
128 if ($overviewfilesoptions) {
129 file_prepare_standard_filemanager($course, 'overviewfiles', $overviewfilesoptions, $coursecontext, 'course', 'overviewfiles', 0);
132 // Populate course tags.
133 $course->tags = core_tag_tag::get_item_tags_array('core', 'course', $course->id);
135 } else {
136 // Editor should respect category context if course context is not set.
137 $editoroptions['context'] = $catcontext;
138 $editoroptions['subdirs'] = 0;
139 $course = file_prepare_standard_editor($course, 'summary', $editoroptions, null, 'course', 'summary', null);
140 if ($overviewfilesoptions) {
141 file_prepare_standard_filemanager($course, 'overviewfiles', $overviewfilesoptions, null, 'course', 'overviewfiles', 0);
145 // First create the form.
146 $args = array(
147 'course' => $course,
148 'category' => $category,
149 'editoroptions' => $editoroptions,
150 'returnto' => $returnto,
151 'returnurl' => $returnurl
153 $editform = new course_edit_form(null, $args);
154 if ($editform->is_cancelled()) {
155 // The form has been cancelled, take them back to what ever the return to is.
156 redirect($returnurl);
157 } else if ($data = $editform->get_data()) {
158 // Process data if submitted.
159 if (empty($course->id)) {
160 // In creating the course.
161 $course = create_course($data, $editoroptions);
163 // Get the context of the newly created course.
164 $context = context_course::instance($course->id, MUST_EXIST);
166 // Admins have all capabilities, so is_viewing is returning true for admins.
167 // We are checking 'enroladminnewcourse' setting to decide to enrol them or not.
168 if (is_siteadmin($USER->id)) {
169 $enroluser = $CFG->enroladminnewcourse;
170 } else {
171 $enroluser = !is_viewing($context, null, 'moodle/role:assign');
174 if (!empty($CFG->creatornewroleid) and $enroluser and !is_enrolled($context, null, 'moodle/role:assign')) {
175 // Deal with course creators - enrol them internally with default role.
176 // Note: This does not respect capabilities, the creator will be assigned the default role.
177 // This is an expected behaviour. See MDL-66683 for further details.
178 enrol_try_internal_enrol($course->id, $USER->id, $CFG->creatornewroleid);
181 // The URL to take them to if they chose save and display.
182 $courseurl = new moodle_url('/course/view.php', array('id' => $course->id));
183 } else {
184 // Save any changes to the files used in the editor.
185 update_course($data, $editoroptions);
186 // Set the URL to take them too if they choose save and display.
187 $courseurl = new moodle_url('/course/view.php', array('id' => $course->id));
190 if (isset($data->saveanddisplay)) {
191 // Redirect user to newly created/updated course.
192 redirect($courseurl);
193 } else {
194 // Save and return. Take them back to wherever.
195 redirect($returnurl);
199 // Print the form.
201 $site = get_site();
203 $streditcoursesettings = get_string("editcoursesettings");
204 $straddnewcourse = get_string("addnewcourse");
205 $stradministration = get_string("administration");
206 $strcategories = get_string("categories");
208 if (!empty($course->id)) {
209 // Navigation note: The user is editing a course, the course will exist within the navigation and settings.
210 // The navigation will automatically find the Edit settings page under course navigation.
211 $pagedesc = $streditcoursesettings;
212 $title = $streditcoursesettings;
213 $fullname = $course->fullname;
214 } else {
215 // The user is adding a course, this page isn't presented in the site navigation/admin.
216 // Adding a new course is part of course category management territory.
217 // We'd prefer to use the management interface URL without args.
218 $managementurl = new moodle_url('/course/management.php');
219 // These are the caps required in order to see the management interface.
220 $managementcaps = array('moodle/category:manage', 'moodle/course:create');
221 if ($categoryid && !has_any_capability($managementcaps, context_system::instance())) {
222 // If the user doesn't have either manage caps then they can only manage within the given category.
223 $managementurl->param('categoryid', $categoryid);
225 // Because the course category interfaces are buried in the admin tree and that is loaded by ajax
226 // we need to manually tell the navigation we need it loaded. The second arg does this.
227 navigation_node::override_active_url(new moodle_url('/course/index.php', ['categoryid' => $category->id]), true);
228 $PAGE->set_primary_active_tab('home');
229 $PAGE->navbar->add(get_string('coursemgmt', 'admin'), $managementurl);
231 $pagedesc = $straddnewcourse;
232 $title = $straddnewcourse;
233 $fullname = format_string($category->name);
234 $PAGE->navbar->add($pagedesc);
237 $PAGE->set_title($title);
238 $PAGE->add_body_class('limitedwidth');
239 $PAGE->set_heading($fullname);
241 echo $OUTPUT->header();
242 echo $OUTPUT->heading($pagedesc);
244 $editform->display();
246 echo $OUTPUT->footer();