MDL-22388 Added some checks to kill these scripts dead with an unequivocal notice...
[moodle.git] / grade / export / grade_export_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 if (!defined('MOODLE_INTERNAL')) {
19     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
20 }
22 require_once $CFG->libdir.'/formslib.php';
24 class grade_export_form extends moodleform {
25     function definition() {
26         global $CFG, $COURSE, $USER, $DB;
28         $mform =& $this->_form;
29         if (isset($this->_customdata)) {  // hardcoding plugin names here is hacky
30             $features = $this->_customdata;
31         } else {
32             $features = array();
33         }
35         $mform->addElement('header', 'options', get_string('options', 'grades'));
37         $mform->addElement('advcheckbox', 'export_feedback', get_string('exportfeedback', 'grades'));
38         $mform->setDefault('export_feedback', 0);
40         $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
41         $mform->addElement('select', 'previewrows', get_string('previewrows', 'grades'), $options);
43         if (!empty($features['updategradesonly'])) {
44             $mform->addElement('advcheckbox', 'updatedgradesonly', get_string('updatedgradesonly', 'grades'));
45         }
46         /// selections for decimal points and format, MDL-11667, defaults to site settings, if set
47         //$default_gradedisplaytype = $CFG->grade_export_displaytype;
48         $options = array(GRADE_DISPLAY_TYPE_REAL       => get_string('real', 'grades'),
49                          GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'),
50                          GRADE_DISPLAY_TYPE_LETTER     => get_string('letter', 'grades'));
52         /*
53         foreach ($options as $key=>$option) {
54             if ($key == $default_gradedisplaytype) {
55                 $options[GRADE_DISPLAY_TYPE_DEFAULT] = get_string('defaultprev', 'grades', $option);
56                 break;
57             }
58         }
59         */
60         $mform->addElement('select', 'display', get_string('gradeexportdisplaytype', 'grades'), $options);
61         $mform->setDefault('display', $CFG->grade_export_displaytype);
63         //$default_gradedecimals = $CFG->grade_export_decimalpoints;
64         $options = array(0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5);
65         $mform->addElement('select', 'decimals', get_string('gradeexportdecimalpoints', 'grades'), $options);
66         $mform->setDefault('decimals', $CFG->grade_export_decimalpoints);
67         $mform->disabledIf('decimals', 'display', 'eq', GRADE_DISPLAY_TYPE_LETTER);
68         /*
69         if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) {
70             $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_DEFAULT);
71         }
72         */
74         if (!empty($features['includeseparator'])) {
75             $radio = array();
76             $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('septab', 'grades'), 'tab');
77             $radio[] = &MoodleQuickForm::createElement('radio', 'separator', null, get_string('sepcomma', 'grades'), 'comma');
78             $mform->addGroup($radio, 'separator', get_string('separator', 'grades'), ' ', false);
79             $mform->setDefault('separator', 'comma');
80         }
82         if (!empty($CFG->gradepublishing) and !empty($features['publishing'])) {
83             $mform->addElement('header', 'publishing', get_string('publishing', 'grades'));
84             $options = array(get_string('nopublish', 'grades'), get_string('createnewkey', 'userkey'));
85             $keys = $DB->get_records_select('user_private_key', "script='grade/export' AND instance=? AND userid=?",
86                             array($COURSE->id, $USER->id));
87             if ($keys) {
88                 foreach ($keys as $key) {
89                     $options[$key->value] = $key->value; // TODO: add more details - ip restriction, valid until ??
90                 }
91             }
92             $mform->addElement('select', 'key', get_string('userkey', 'userkey'), $options);
93             $mform->setHelpButton('key', array('userkey', get_string('userkey', 'userkey'), 'grade'));
94             $mform->addElement('static', 'keymanagerlink', get_string('keymanager', 'userkey'),
95                     '<a href="'.$CFG->wwwroot.'/grade/export/keymanager.php?id='.$COURSE->id.'">'.get_string('keymanager', 'userkey').'</a>');
97             $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80));
98             $mform->setHelpButton('iprestriction', array('keyiprestriction', get_string('keyiprestriction', 'userkey'), 'userkey'));
99             $mform->setDefault('iprestriction', getremoteaddr()); // own IP - just in case somebody does not know what user key is
101             $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true));
102             $mform->setHelpButton('validuntil', array('keyvaliduntil', get_string('keyvaliduntil', 'userkey'), 'userkey'));
103             $mform->setDefault('validuntil', time()+3600*24*7); // only 1 week default duration - just in case somebody does not know what user key is
105             $mform->disabledIf('iprestriction', 'key', 'noteq', 1);
106             $mform->disabledIf('validuntil', 'key', 'noteq', 1);
107         }
109         $mform->addElement('header', 'gradeitems', get_string('gradeitemsinc', 'grades'));
111         $switch = grade_get_setting($COURSE->id, 'aggregationposition', $CFG->grade_aggregationposition);
113         // Grab the grade_seq for this course
114         $gseq = new grade_seq($COURSE->id, $switch);
116         if ($grade_items = $gseq->items) {
117             $needs_multiselect = false;
118             foreach ($grade_items as $grade_item) {
119                 if (!empty($features['idnumberrequired']) and empty($grade_item->idnumber)) {
120                     $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name(), get_string('noidnumber', 'grades'));
121                     $mform->hardFreeze('itemids['.$grade_item->id.']');
122                 } else {
123                     $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name(), null, array('group' => 1));
124                     $mform->setDefault('itemids['.$grade_item->id.']', 1);
125                     $needs_multiselect = true;
126                 }
127                 }
129             if ($needs_multiselect) {
130                 $this->add_checkbox_controller(1, null, null, 1); // 1st argument is group name, 2nd is link text, 3rd is attributes and 4th is original value
131             }
132         }
134         $mform->addElement('hidden', 'id', $COURSE->id);
135         $mform->setType('id', PARAM_INT);
136         $this->add_action_buttons(false, get_string('submit'));
138     }