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.
<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Preset Menu
 *
 * This is the page that is the menu item in the config database
 * pages.
 *
 * This file is part of the Database module for Moodle
 *
 * @copyright 2005 Martin Dougiamas  http://dougiamas.com
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @package mod_data
 */

require_once('../../config.php');
require_once($CFG->dirroot.'/mod/data/lib.php');
require_once($CFG->dirroot.'/mod/data/preset_form.php');
< require_once($CFG->libdir.'/xmlize.php');
< $id = optional_param('id', 0, PARAM_INT); // course module id
> $id = optional_param('id', 0, PARAM_INT); // The course module id. >
if ($id) { $cm = get_coursemodule_from_id('data', $id, null, null, MUST_EXIST); $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST); $data = $DB->get_record('data', array('id'=>$cm->instance), '*', MUST_EXIST); } else { $d = required_param('d', PARAM_INT); // database activity id $data = $DB->get_record('data', array('id'=>$d), '*', MUST_EXIST); $course = $DB->get_record('course', array('id'=>$data->course), '*', MUST_EXIST); $cm = get_coursemodule_from_instance('data', $data->id, $course->id, null, MUST_EXIST); }
> $action = optional_param('action', 'view', PARAM_ALPHA); // The page action. $context = context_module::instance($cm->id, MUST_EXIST); > $allowedactions = ['view', 'delete', 'confirmdelete', 'import', 'importzip', 'finishimport', require_login($course, false, $cm); > 'export']; require_capability('mod/data:managetemplates', $context); > if (!in_array($action, $allowedactions)) { $PAGE->set_url(new moodle_url('/mod/data/preset.php', array('d'=>$data->id))); > throw new moodle_exception('invalidaccess'); $PAGE->set_title(get_string('course') . ': ' . $course->fullname); > } $PAGE->set_heading($course->fullname); >
< $PAGE->set_url(new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
> > $url = new moodle_url('/mod/data/preset.php', array('d' => $data->id)); > > $PAGE->set_url($url);
> $PAGE->activityheader->disable();
// fill in missing properties needed for updating of instance $data->course = $cm->course; $data->cmidnumber = $cm->idnumber; $data->instance = $cm->instance;
< $presets = data_get_available_presets($context); < $strdelete = get_string('deleted', 'data'); < foreach ($presets as &$preset) { < if (!empty($preset->userid)) { < $userfieldsapi = \core_user\fields::for_name(); < $namefields = $userfieldsapi->get_sql('', false, '', '', false)->selects; < $presetuser = $DB->get_record('user', array('id' => $preset->userid), 'id, ' . $namefields, MUST_EXIST); < $preset->description = $preset->name.' ('.fullname($presetuser, true).')'; < } else { < $preset->userid = 0; < $preset->description = $preset->name; < if (data_user_can_delete_preset($context, $preset) && $preset->name != 'Image gallery') { < $delurl = new moodle_url('/mod/data/preset.php', array('d'=> $data->id, 'action'=>'confirmdelete', 'fullname'=>$preset->userid.'/'.$preset->shortname, 'sesskey'=>sesskey())); < $delicon = $OUTPUT->pix_icon('t/delete', $strdelete . ' ' . $preset->description); < $preset->description .= html_writer::link($delurl, $delicon); < } < } < if ($preset->userid > 0 && data_user_can_delete_preset($context, $preset)) { < $delurl = new moodle_url('/mod/data/preset.php', array('d'=> $data->id, 'action'=>'confirmdelete', 'fullname'=>$preset->userid.'/'.$preset->shortname, 'sesskey'=>sesskey())); < $delicon = $OUTPUT->pix_icon('t/delete', $strdelete . ' ' . $preset->description); < $preset->description .= html_writer::link($delurl, $delicon); < } < } < // This is required because its currently bound to the last element in the array. < // If someone were to inadvently use it again and this call were not here < unset($preset); < < $form_importexisting = new data_existing_preset_form(null, array('presets'=>$presets)); < $form_importexisting->set_data(array('d' => $data->id)); < < $form_importzip = new data_import_preset_zip_form(); < $form_importzip->set_data(array('d' => $data->id)); < < $form_export = new data_export_form(); < $form_export->set_data(array('d' => $data->id)); < < $form_save = new data_save_preset_form(); < $form_save->set_data(array('d' => $data->id, 'name'=>$data->name)); < < /* Output */ < if (!$form_export->is_submitted()) { < echo $OUTPUT->header(); < echo $OUTPUT->heading(format_string($data->name), 2); < < // Render the activity information. < $cminfo = cm_info::create($cm); < $completiondetails = \core_completion\cm_completion_details::get_instance($cminfo, $USER->id); < $activitydates = \core\activity_dates::get_dates_for_module($cminfo, $USER->id); < echo $OUTPUT->activity_information($cminfo, $completiondetails, $activitydates); < < // Needed for tabs.php < $currenttab = 'presets'; < $currentgroup = groups_get_activity_group($cm); < $groupmode = groups_get_activity_groupmode($cm); < echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro'); < < include('tabs.php'); < } < < if (optional_param('sesskey', false, PARAM_BOOL) && confirm_sesskey()) { <
$renderer = $PAGE->get_renderer('mod_data');
> $presets = data_get_available_presets($context);
< if ($formdata = $form_importexisting->get_data()) { < $importer = new data_preset_existing_importer($course, $cm, $data, $formdata->fullname); < echo $renderer->import_setting_mappings($data, $importer); < echo $OUTPUT->footer(); < exit(0); < } else if ($formdata = $form_importzip->get_data()) { < $file = new stdClass; < $file->name = $form_importzip->get_new_filename('importfile'); < $file->path = $form_importzip->save_temp_file('importfile'); < $importer = new data_preset_upload_importer($course, $cm, $data, $file->path); < echo $renderer->import_setting_mappings($data, $importer); < echo $OUTPUT->footer(); < exit(0); < } else if ($formdata = $form_export->get_data()) { <
> if ($action === 'export') {
if (headers_sent()) { print_error('headersent'); } $exportfile = data_presets_export($course, $cm, $data); $exportfilename = basename($exportfile); header("Content-Type: application/download\n"); header("Content-Disposition: attachment; filename=\"$exportfilename\""); header('Expires: 0'); header('Cache-Control: must-revalidate,post-check=0,pre-check=0'); header('Pragma: public'); // If this file was requested from a form, then mark download as complete. \core_form\util::form_download_complete(); $exportfilehandler = fopen($exportfile, 'rb'); print fread($exportfilehandler, filesize($exportfile)); fclose($exportfilehandler); unlink($exportfile); exit(0);
< < } else if ($formdata = $form_save->get_data()) { < if (!empty($formdata->overwrite)) { < $selectedpreset = new stdClass(); < foreach ($presets as $preset) { < if ($preset->name == $formdata->name) { < $selectedpreset = $preset; < break; < } < } < if (isset($selectedpreset->name)) { < if (data_user_can_delete_preset($context, $selectedpreset)) { < data_delete_site_preset($formdata->name); < } else { < print_error('cannotoverwritepreset', 'data'); < } < }
}
< // If the preset exists now then we need to throw an error. < $sitepresets = data_get_available_site_presets($context); < foreach ($sitepresets as $key=>$preset) { < if ($formdata->name == $preset->name) { < print_error('errorpresetexists', 'preset'); < }
> $formimportzip = new data_import_preset_zip_form(); > $formimportzip->set_data(array('d' => $data->id)); > > if ($formimportzip->is_cancelled()) { > redirect(new moodle_url('/mod/data/preset.php', ['d' => $data->id]));
}
< // Save the preset now < data_presets_save($course, $cm, $data, $formdata->name);
> echo $OUTPUT->header();
< echo $OUTPUT->notification(get_string('savesuccess', 'data'), 'notifysuccess'); < echo $OUTPUT->continue_button($PAGE->url);
> if ($formdata = $formimportzip->get_data()) { > echo $OUTPUT->heading(get_string('importpreset', 'data'), 2, 'mb-4'); > $file = new stdClass; > $file->name = $formimportzip->get_new_filename('importfile'); > $file->path = $formimportzip->save_temp_file('importfile'); > $importer = new data_preset_upload_importer($course, $cm, $data, $file->path); > echo $renderer->import_setting_mappings($data, $importer);
echo $OUTPUT->footer(); exit(0);
< } else { < $action = optional_param('action', null, PARAM_ALPHANUM); < $fullname = optional_param('fullname', '', PARAM_PATH); // directory the preset is in < // < // find out preset owner userid and shortname
> } > > if (in_array($action, ['confirmdelete', 'delete', 'finishimport'])) { > $fullname = optional_param('fullname', '' , PARAM_PATH); // The directory the preset is in. > // Find out preset owner userid and shortname.
$parts = explode('/', $fullname, 2); $userid = empty($parts[0]) ? 0 : (int)$parts[0]; $shortname = empty($parts[1]) ? '' : $parts[1];
> echo html_writer::start_div('overflow-hidden');
< if ($userid && ($userid != $USER->id) && !has_capability('mod/data:viewalluserpresets', $context)) { < print_error('cannotaccesspresentsother', 'data'); < } < < if ($action == 'confirmdelete') {
> if ($action === 'confirmdelete') {
$path = data_preset_path($course, $userid, $shortname); $strwarning = get_string('deletewarning', 'data').'<br />'.$shortname;
< $optionsyes = array('fullname' => $userid.'/'.$shortname,
> $optionsyes = [ > 'fullname' => $fullname,
'action' => 'delete',
< 'd' => $data->id); < $optionsno = array('d' => $data->id); < echo $OUTPUT->confirm($strwarning, new moodle_url('preset.php', $optionsyes), new moodle_url('preset.php', $optionsno));
> 'd' => $data->id, > ]; > $optionsno = ['d' => $data->id]; > echo $OUTPUT->confirm($strwarning, new moodle_url('/mod/data/preset.php', $optionsyes), > new moodle_url('/mod/data/preset.php', $optionsno));
echo $OUTPUT->footer(); exit(0);
< } else if ($action == 'delete') {
> } else if ($action === 'delete') { > if (!confirm_sesskey()) { > throw new moodle_exception('invalidsesskey'); > }
$selectedpreset = new stdClass(); foreach ($presets as $preset) { if ($preset->shortname == $shortname) { $selectedpreset = $preset; } } if (!isset($selectedpreset->shortname) || !data_user_can_delete_preset($context, $selectedpreset)) { print_error('invalidrequest'); } data_delete_site_preset($shortname);
<
$strdeleted = get_string('deleted', 'data'); echo $OUTPUT->notification("$shortname $strdeleted", 'notifysuccess');
< } else if ($action == 'finishimport') {
> } else if ($action === 'finishimport') { > if (!confirm_sesskey()) { > throw new moodle_exception('invalidsesskey'); > }
$overwritesettings = optional_param('overwritesettings', false, PARAM_BOOL); if (!$fullname) { $presetdir = $CFG->tempdir.'/forms/'.required_param('directory', PARAM_FILE); if (!file_exists($presetdir) || !is_dir($presetdir)) { print_error('cannotimport'); } $importer = new data_preset_upload_importer($course, $cm, $data, $presetdir); } else { $importer = new data_preset_existing_importer($course, $cm, $data, $fullname); } $importer->import($overwritesettings); $strimportsuccess = get_string('importsuccess', 'data'); $straddentries = get_string('addentries', 'data'); $strtodatabase = get_string('todatabase', 'data'); if (!$DB->get_records('data_records', array('dataid'=>$data->id))) { echo $OUTPUT->notification("$strimportsuccess <a href='edit.php?d=$data->id'>$straddentries</a> $strtodatabase", 'notifysuccess'); } else { echo $OUTPUT->notification("$strimportsuccess", 'notifysuccess'); } }
< echo $OUTPUT->continue_button($PAGE->url);
> echo $OUTPUT->continue_button(new moodle_url('/mod/data/preset.php', ['d' => $data->id])); > echo html_writer::end_div();
echo $OUTPUT->footer(); exit(0); }
< }
< // Export forms < echo $OUTPUT->heading(get_string('export', 'data'), 3); < $form_export->display(); < $form_save->display(); < < // Import forms < echo $OUTPUT->heading(get_string('import'), 3); < $form_importzip->display(); < $form_importexisting->display();
> if ($action === 'import') { > echo $OUTPUT->heading(get_string('importpreset', 'data'), 2, 'mb-4'); > echo $formimportzip->display(); > } else { > $actionbar = new \mod_data\output\action_bar($data->id, $url); > echo $actionbar->get_presets_action_bar(); > echo $OUTPUT->heading(get_string('presets', 'data'), 2, 'mb-4'); > $presets = new \mod_data\output\presets($data->id, $presets, new \moodle_url('/mod/data/field.php'), true); > echo $renderer->render_presets($presets); > }
echo $OUTPUT->footer();