mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
521 lines
19 KiB
PHP
521 lines
19 KiB
PHP
<?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/>.
|
|
|
|
require_once($CFG->dirroot.'/lib/gradelib.php');
|
|
require_once($CFG->dirroot.'/grade/lib.php');
|
|
require_once($CFG->dirroot.'/grade/export/grade_export_form.php');
|
|
|
|
/**
|
|
* Base export class
|
|
*/
|
|
abstract class grade_export {
|
|
|
|
public $plugin; // plgin name - must be filled in subclasses!
|
|
|
|
public $grade_items; // list of all course grade items
|
|
public $groupid; // groupid, 0 means all groups
|
|
public $course; // course object
|
|
public $columns; // array of grade_items selected for export
|
|
|
|
public $export_letters; // export letters
|
|
public $export_feedback; // export feedback
|
|
public $userkey; // export using private user key
|
|
|
|
public $updatedgradesonly; // only export updated grades
|
|
|
|
/**
|
|
* Grade display type (real, percentages or letter).
|
|
*
|
|
* This attribute is an integer for XML file export. Otherwise is an array for all other formats (ODS, XLS and TXT).
|
|
*
|
|
* @var $displaytype Grade display type constant (1, 2 or 3) or an array of display types where the key is the name
|
|
* and the value is the grade display type constant or 0 for unchecked display types.
|
|
* @access public.
|
|
*/
|
|
public $displaytype;
|
|
public $decimalpoints; // number of decimal points for exports
|
|
public $onlyactive; // only include users with an active enrolment
|
|
public $usercustomfields; // include users custom fields
|
|
|
|
/**
|
|
* @deprecated since Moodle 2.8
|
|
* @var $previewrows Number of rows in preview.
|
|
*/
|
|
public $previewrows;
|
|
|
|
/**
|
|
* Constructor should set up all the private variables ready to be pulled.
|
|
*
|
|
* This constructor used to accept the individual parameters as separate arguments, in
|
|
* 2.8 this was simplified to just accept the data from the moodle form.
|
|
*
|
|
* @access public
|
|
* @param object $course
|
|
* @param int $groupid
|
|
* @param stdClass|null $formdata
|
|
* @note Exporting as letters will lead to data loss if that exported set it re-imported.
|
|
*/
|
|
public function __construct($course, $groupid, $formdata) {
|
|
if (func_num_args() != 3 || ($formdata != null && get_class($formdata) != "stdClass")) {
|
|
$args = func_get_args();
|
|
return call_user_func_array(array($this, "deprecated_constructor"), $args);
|
|
}
|
|
$this->course = $course;
|
|
$this->groupid = $groupid;
|
|
|
|
$this->grade_items = grade_item::fetch_all(array('courseid'=>$this->course->id));
|
|
|
|
$this->process_form($formdata);
|
|
}
|
|
|
|
/**
|
|
* Old deprecated constructor.
|
|
*
|
|
* This deprecated constructor accepts the individual parameters as separate arguments, in
|
|
* 2.8 this was simplified to just accept the data from the moodle form.
|
|
*
|
|
* @deprecated since 2.8 MDL-46548. Instead call the shortened constructor which accepts the data
|
|
* directly from the grade_export_form.
|
|
*/
|
|
protected function deprecated_constructor($course,
|
|
$groupid=0,
|
|
$itemlist='',
|
|
$export_feedback=false,
|
|
$updatedgradesonly = false,
|
|
$displaytype = GRADE_DISPLAY_TYPE_REAL,
|
|
$decimalpoints = 2,
|
|
$onlyactive = false,
|
|
$usercustomfields = false) {
|
|
|
|
debugging('Many argument constructor for class "grade_export" is deprecated. Call the 3 argument version instead.', DEBUG_DEVELOPER);
|
|
|
|
$this->course = $course;
|
|
$this->groupid = $groupid;
|
|
|
|
$this->grade_items = grade_item::fetch_all(array('courseid'=>$this->course->id));
|
|
//Populating the columns here is required by /grade/export/(whatever)/export.php
|
|
//however index.php, when the form is submitted, will construct the collection here
|
|
//with an empty $itemlist then reconstruct it in process_form() using $formdata
|
|
$this->columns = array();
|
|
if (!empty($itemlist)) {
|
|
if ($itemlist=='-1') {
|
|
//user deselected all items
|
|
} else {
|
|
$itemids = explode(',', $itemlist);
|
|
// remove items that are not requested
|
|
foreach ($itemids as $itemid) {
|
|
if (array_key_exists($itemid, $this->grade_items)) {
|
|
$this->columns[$itemid] =& $this->grade_items[$itemid];
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
foreach ($this->grade_items as $itemid=>$unused) {
|
|
$this->columns[$itemid] =& $this->grade_items[$itemid];
|
|
}
|
|
}
|
|
|
|
$this->export_feedback = $export_feedback;
|
|
$this->userkey = '';
|
|
$this->previewrows = false;
|
|
$this->updatedgradesonly = $updatedgradesonly;
|
|
|
|
$this->displaytype = $displaytype;
|
|
$this->decimalpoints = $decimalpoints;
|
|
$this->onlyactive = $onlyactive;
|
|
$this->usercustomfields = $usercustomfields;
|
|
}
|
|
|
|
/**
|
|
* Init object based using data from form
|
|
* @param object $formdata
|
|
*/
|
|
function process_form($formdata) {
|
|
global $USER;
|
|
|
|
$this->columns = array();
|
|
if (!empty($formdata->itemids)) {
|
|
if ($formdata->itemids=='-1') {
|
|
//user deselected all items
|
|
} else {
|
|
foreach ($formdata->itemids as $itemid=>$selected) {
|
|
if ($selected and array_key_exists($itemid, $this->grade_items)) {
|
|
$this->columns[$itemid] =& $this->grade_items[$itemid];
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
foreach ($this->grade_items as $itemid=>$unused) {
|
|
$this->columns[$itemid] =& $this->grade_items[$itemid];
|
|
}
|
|
}
|
|
|
|
if (isset($formdata->key)) {
|
|
if ($formdata->key == 1 && isset($formdata->iprestriction) && isset($formdata->validuntil)) {
|
|
// Create a new key
|
|
$formdata->key = create_user_key('grade/export', $USER->id, $this->course->id, $formdata->iprestriction, $formdata->validuntil);
|
|
}
|
|
$this->userkey = $formdata->key;
|
|
}
|
|
|
|
if (isset($formdata->decimals)) {
|
|
$this->decimalpoints = $formdata->decimals;
|
|
}
|
|
|
|
if (isset($formdata->export_letters)) {
|
|
$this->export_letters = $formdata->export_letters;
|
|
}
|
|
|
|
if (isset($formdata->export_feedback)) {
|
|
$this->export_feedback = $formdata->export_feedback;
|
|
}
|
|
|
|
if (isset($formdata->export_onlyactive)) {
|
|
$this->onlyactive = $formdata->export_onlyactive;
|
|
}
|
|
|
|
if (isset($formdata->previewrows)) {
|
|
$this->previewrows = $formdata->previewrows;
|
|
}
|
|
|
|
if (isset($formdata->display)) {
|
|
$this->displaytype = $formdata->display;
|
|
|
|
// Used by grade exports which accept multiple display types.
|
|
// If the checkbox value is 0 (unchecked) then remove it.
|
|
if (is_array($formdata->display)) {
|
|
$this->displaytype = array_filter($formdata->display);
|
|
}
|
|
}
|
|
|
|
if (isset($formdata->updatedgradesonly)) {
|
|
$this->updatedgradesonly = $formdata->updatedgradesonly;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update exported field in grade_grades table
|
|
* @return boolean
|
|
*/
|
|
public function track_exports() {
|
|
global $CFG;
|
|
|
|
/// Whether this plugin is entitled to update export time
|
|
if ($expplugins = explode(",", $CFG->gradeexport)) {
|
|
if (in_array($this->plugin, $expplugins)) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns string representation of final grade
|
|
* @param object $grade instance of grade_grade class
|
|
* @param integer $gradedisplayconst grade display type constant.
|
|
* @return string
|
|
*/
|
|
public function format_grade($grade, $gradedisplayconst = null) {
|
|
$displaytype = $this->displaytype;
|
|
if (is_array($this->displaytype) && !is_null($gradedisplayconst)) {
|
|
$displaytype = $gradedisplayconst;
|
|
}
|
|
return grade_format_gradevalue($grade->finalgrade, $this->grade_items[$grade->itemid], false, $displaytype, $this->decimalpoints);
|
|
}
|
|
|
|
/**
|
|
* Returns the name of column in export
|
|
* @param object $grade_item
|
|
* @param boolean $feedback feedback colum
|
|
* @param string $gradedisplayname grade display name.
|
|
* @return string
|
|
*/
|
|
public function format_column_name($grade_item, $feedback=false, $gradedisplayname = null) {
|
|
$column = new stdClass();
|
|
|
|
if ($grade_item->itemtype == 'mod') {
|
|
$column->name = get_string('modulename', $grade_item->itemmodule).get_string('labelsep', 'langconfig').$grade_item->get_name();
|
|
} else {
|
|
$column->name = $grade_item->get_name();
|
|
}
|
|
|
|
// We can't have feedback and display type at the same time.
|
|
$column->extra = ($feedback) ? get_string('feedback') : get_string($gradedisplayname, 'grades');
|
|
|
|
return html_to_text(get_string('gradeexportcolumntype', 'grades', $column), 0, false);
|
|
}
|
|
|
|
/**
|
|
* Returns formatted grade feedback
|
|
* @param object $feedback object with properties feedback and feedbackformat
|
|
* @return string
|
|
*/
|
|
public function format_feedback($feedback) {
|
|
return strip_tags(format_text($feedback->feedback, $feedback->feedbackformat));
|
|
}
|
|
|
|
/**
|
|
* Implemented by child class
|
|
*/
|
|
public abstract function print_grades();
|
|
|
|
/**
|
|
* Prints preview of exported grades on screen as a feedback mechanism
|
|
* @param bool $require_user_idnumber true means skip users without idnumber
|
|
* @deprecated since 2.8 MDL-46548. Previews are not useful on export.
|
|
*/
|
|
public function display_preview($require_user_idnumber=false) {
|
|
global $OUTPUT;
|
|
|
|
debugging('function grade_export::display_preview is deprecated.', DEBUG_DEVELOPER);
|
|
|
|
$userprofilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields);
|
|
$formatoptions = new stdClass();
|
|
$formatoptions->para = false;
|
|
|
|
echo $OUTPUT->heading(get_string('previewrows', 'grades'));
|
|
|
|
echo '<table>';
|
|
echo '<tr>';
|
|
foreach ($userprofilefields as $field) {
|
|
echo '<th>' . $field->fullname . '</th>';
|
|
}
|
|
if (!$this->onlyactive) {
|
|
echo '<th>'.get_string("suspended")."</th>";
|
|
}
|
|
foreach ($this->columns as $grade_item) {
|
|
echo '<th>'.$this->format_column_name($grade_item).'</th>';
|
|
|
|
/// add a column_feedback column
|
|
if ($this->export_feedback) {
|
|
echo '<th>'.$this->format_column_name($grade_item, true).'</th>';
|
|
}
|
|
}
|
|
echo '</tr>';
|
|
/// Print all the lines of data.
|
|
$i = 0;
|
|
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
|
|
$gui->require_active_enrolment($this->onlyactive);
|
|
$gui->allow_user_custom_fields($this->usercustomfields);
|
|
$gui->init();
|
|
while ($userdata = $gui->next_user()) {
|
|
// number of preview rows
|
|
if ($this->previewrows and $this->previewrows <= $i) {
|
|
break;
|
|
}
|
|
$user = $userdata->user;
|
|
if ($require_user_idnumber and empty($user->idnumber)) {
|
|
// some exports require user idnumber so we can match up students when importing the data
|
|
continue;
|
|
}
|
|
|
|
$gradeupdated = false; // if no grade is update at all for this user, do not display this row
|
|
$rowstr = '';
|
|
foreach ($this->columns as $itemid=>$unused) {
|
|
$gradetxt = $this->format_grade($userdata->grades[$itemid]);
|
|
|
|
// get the status of this grade, and put it through track to get the status
|
|
$g = new grade_export_update_buffer();
|
|
$grade_grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$user->id));
|
|
$status = $g->track($grade_grade);
|
|
|
|
if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) {
|
|
$rowstr .= '<td>'.get_string('unchangedgrade', 'grades').'</td>';
|
|
} else {
|
|
$rowstr .= "<td>$gradetxt</td>";
|
|
$gradeupdated = true;
|
|
}
|
|
|
|
if ($this->export_feedback) {
|
|
$rowstr .= '<td>'.$this->format_feedback($userdata->feedbacks[$itemid]).'</td>';
|
|
}
|
|
}
|
|
|
|
// if we are requesting updated grades only, we are not interested in this user at all
|
|
if (!$gradeupdated && $this->updatedgradesonly) {
|
|
continue;
|
|
}
|
|
|
|
echo '<tr>';
|
|
foreach ($userprofilefields as $field) {
|
|
$fieldvalue = grade_helper::get_user_field_value($user, $field);
|
|
// @see profile_field_base::display_data().
|
|
echo '<td>' . format_text($fieldvalue, FORMAT_MOODLE, $formatoptions) . '</td>';
|
|
}
|
|
if (!$this->onlyactive) {
|
|
$issuspended = ($user->suspendedenrolment) ? get_string('yes') : '';
|
|
echo "<td>$issuspended</td>";
|
|
}
|
|
echo $rowstr;
|
|
echo "</tr>";
|
|
|
|
$i++; // increment the counter
|
|
}
|
|
echo '</table>';
|
|
$gui->close();
|
|
}
|
|
|
|
/**
|
|
* Returns array of parameters used by dump.php and export.php.
|
|
* @return array
|
|
*/
|
|
public function get_export_params() {
|
|
$itemids = array_keys($this->columns);
|
|
$itemidsparam = implode(',', $itemids);
|
|
if (empty($itemidsparam)) {
|
|
$itemidsparam = '-1';
|
|
}
|
|
|
|
$params = array('id' =>$this->course->id,
|
|
'groupid' =>$this->groupid,
|
|
'itemids' =>$itemidsparam,
|
|
'export_letters' =>$this->export_letters,
|
|
'export_feedback' =>$this->export_feedback,
|
|
'updatedgradesonly' =>$this->updatedgradesonly,
|
|
'displaytype' =>$this->displaytype,
|
|
'decimalpoints' =>$this->decimalpoints,
|
|
'export_onlyactive' =>$this->onlyactive,
|
|
'usercustomfields' =>$this->usercustomfields);
|
|
|
|
return $params;
|
|
}
|
|
|
|
/**
|
|
* Either prints a "Export" box, which will redirect the user to the download page,
|
|
* or prints the URL for the published data.
|
|
*
|
|
* @deprecated since 2.8 MDL-46548. Call get_export_url and set the
|
|
* action of the grade_export_form instead.
|
|
* @return void
|
|
*/
|
|
public function print_continue() {
|
|
global $CFG, $OUTPUT;
|
|
|
|
debugging('function grade_export::print_continue is deprecated.', DEBUG_DEVELOPER);
|
|
$params = $this->get_export_params();
|
|
|
|
echo $OUTPUT->heading(get_string('export', 'grades'));
|
|
|
|
echo $OUTPUT->container_start('gradeexportlink');
|
|
|
|
if (!$this->userkey) {
|
|
// This button should trigger a download prompt.
|
|
$url = new moodle_url('/grade/export/'.$this->plugin.'/export.php', $params);
|
|
echo $OUTPUT->single_button($url, get_string('download', 'admin'));
|
|
|
|
} else {
|
|
$paramstr = '';
|
|
$sep = '?';
|
|
foreach($params as $name=>$value) {
|
|
$paramstr .= $sep.$name.'='.$value;
|
|
$sep = '&';
|
|
}
|
|
|
|
$link = $CFG->wwwroot.'/grade/export/'.$this->plugin.'/dump.php'.$paramstr.'&key='.$this->userkey;
|
|
|
|
echo get_string('download', 'admin').': ' . html_writer::link($link, $link);
|
|
}
|
|
echo $OUTPUT->container_end();
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This class is used to update the exported field in grade_grades.
|
|
* It does internal buffering to speedup the db operations.
|
|
*/
|
|
class grade_export_update_buffer {
|
|
public $update_list;
|
|
public $export_time;
|
|
|
|
/**
|
|
* Constructor - creates the buffer and initialises the time stamp
|
|
*/
|
|
public function grade_export_update_buffer() {
|
|
$this->update_list = array();
|
|
$this->export_time = time();
|
|
}
|
|
|
|
public function flush($buffersize) {
|
|
global $CFG, $DB;
|
|
|
|
if (count($this->update_list) > $buffersize) {
|
|
list($usql, $params) = $DB->get_in_or_equal($this->update_list);
|
|
$params = array_merge(array($this->export_time), $params);
|
|
|
|
$sql = "UPDATE {grade_grades} SET exported = ? WHERE id $usql";
|
|
$DB->execute($sql, $params);
|
|
$this->update_list = array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Track grade export status
|
|
* @param object $grade_grade
|
|
* @return string $status (unknow, new, regrade, nochange)
|
|
*/
|
|
public function track($grade_grade) {
|
|
|
|
if (empty($grade_grade->exported) or empty($grade_grade->timemodified)) {
|
|
if (is_null($grade_grade->finalgrade)) {
|
|
// grade does not exist yet
|
|
$status = 'unknown';
|
|
} else {
|
|
$status = 'new';
|
|
$this->update_list[] = $grade_grade->id;
|
|
}
|
|
|
|
} else if ($grade_grade->exported < $grade_grade->timemodified) {
|
|
$status = 'regrade';
|
|
$this->update_list[] = $grade_grade->id;
|
|
|
|
} else if ($grade_grade->exported >= $grade_grade->timemodified) {
|
|
$status = 'nochange';
|
|
|
|
} else {
|
|
// something is wrong?
|
|
$status = 'unknown';
|
|
}
|
|
|
|
$this->flush(100);
|
|
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* Flush and close the buffer.
|
|
*/
|
|
public function close() {
|
|
$this->flush(0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Verify that there is a valid set of grades to export.
|
|
* @param $courseid int The course being exported
|
|
*/
|
|
function export_verify_grades($courseid) {
|
|
$regraderesult = grade_regrade_final_grades($courseid);
|
|
if (is_array($regraderesult)) {
|
|
throw new moodle_exception('gradecantregrade', 'error', '', implode(', ', array_unique($regraderesult)));
|
|
}
|
|
}
|