first commit

grade/export/xls/classes/event/grade_exported.php

@@ -0,0 +1,38 @@
+<?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/>.
+
+/**
+ * Grade export event.
+ *
+ * @package    gradeexport_xls
+ * @copyright  2016 Zane Karl <zkarl@oid.ucla.edu>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace gradeexport_xls\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Grade export event class.
+ *
+ * @package    gradeexport_xls
+ * @since      Moodle 3.2
+ * @copyright  2016 Zane Karl <zkarl@oid.ucla.edu>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class grade_exported extends \core\event\grade_exported {
+}

grade/export/xls/classes/privacy/provider.php

@@ -0,0 +1,46 @@
+<?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/>.
+
+/**
+ * Privacy Subsystem implementation for gradeexport_xls.
+ *
+ * @package    gradeexport_xls
+ * @copyright  2018 Sara Arjona <sara@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace gradeexport_xls\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for gradeexport_xls implementing null_provider.
+ *
+ * @copyright  2018 Sara Arjona <sara@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

grade/export/xls/db/access.php

@@ -0,0 +1,51 @@
+<?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/>.
+
+/**
+ * Capabilities gradeexport plugin.
+ *
+ * @package    gradeexport_xls
+ * @copyright  2007 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$capabilities = array(
+
+    'gradeexport/xls:view' => array(
+        'riskbitmask' => RISK_PERSONAL,
+        'captype' => 'read',
+        'contextlevel' => CONTEXT_COURSE,
+        'archetypes' => array(
+            'teacher' => CAP_ALLOW,
+            'editingteacher' => CAP_ALLOW,
+            'manager' => CAP_ALLOW
+        )
+    ),
+
+    'gradeexport/xls:publish' => array(
+        'riskbitmask' => RISK_PERSONAL,
+        'captype' => 'read',
+        'contextlevel' => CONTEXT_COURSE,
+        'archetypes' => array(
+            'manager' => CAP_ALLOW
+        )
+    )
+
+);
+
+

grade/export/xls/dump.php

@@ -0,0 +1,56 @@
+<?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/>.
+
+define('NO_MOODLE_COOKIES', true); // session not used here
+require_once '../../../config.php';
+require_once($CFG->dirroot.'/grade/export/xls/grade_export_xls.php');
+
+$id                 = required_param('id', PARAM_INT);
+$groupid            = optional_param('groupid', 0, PARAM_INT);
+$itemids            = required_param('itemids', PARAM_RAW);
+$exportfeedback     = optional_param('export_feedback', 0, PARAM_BOOL);
+$displaytype        = optional_param('displaytype', $CFG->grade_export_displaytype, PARAM_RAW);
+$decimalpoints      = optional_param('decimalpoints', $CFG->grade_export_decimalpoints, PARAM_INT);
+$onlyactive         = optional_param('export_onlyactive', 0, PARAM_BOOL);
+
+if (!$course = $DB->get_record('course', array('id'=>$id))) {
+    throw new \moodle_exception('invalidcourseid');
+}
+
+require_user_key_login('grade/export', $id); // we want different keys for each course
+
+if (empty($CFG->gradepublishing)) {
+    throw new \moodle_exception('gradepubdisable');
+}
+
+$context = context_course::instance($id);
+require_capability('moodle/grade:export', $context);
+require_capability('gradeexport/xls:view', $context);
+require_capability('gradeexport/xls:publish', $context);
+
+if (!groups_group_visible($groupid, $COURSE)) {
+    throw new \moodle_exception('cannotaccessgroup', 'grades');
+}
+
+// Get all url parameters and create an object to simulate a form submission.
+$formdata = grade_export::export_bulk_export_data($id, $itemids, $exportfeedback, $onlyactive, $displaytype,
+        $decimalpoints);
+
+$export = new grade_export_xls($course, $groupid, $formdata);
+$export->print_grades();
+
+

grade/export/xls/export.php

@@ -0,0 +1,65 @@
+<?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 '../../../config.php';
+require_once $CFG->dirroot.'/grade/export/lib.php';
+require_once 'grade_export_xls.php';
+
+$id                = required_param('id', PARAM_INT); // course id
+$PAGE->set_url('/grade/export/xls/export.php', array('id'=>$id));
+
+if (!$course = $DB->get_record('course', array('id'=>$id))) {
+    throw new \moodle_exception('invalidcourseid');
+}
+
+require_login($course);
+$context = context_course::instance($id);
+$groupid = groups_get_course_group($course, true);
+
+require_capability('moodle/grade:export', $context);
+require_capability('gradeexport/xls:view', $context);
+
+// We need to call this method here before any print otherwise the menu won't display.
+// If you use this method without this check, will break the direct grade exporting (without publishing).
+$key = optional_param('key', '', PARAM_RAW);
+if (!empty($CFG->gradepublishing) && !empty($key)) {
+    $actionbar = new \core_grades\output\export_publish_action_bar($context, 'xls');
+    print_grade_page_head($COURSE->id, 'export', 'xls',
+        get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_xls'),
+        false, false, true, null, null, null, $actionbar);
+}
+
+if (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
+    if (!groups_is_member($groupid, $USER->id)) {
+        throw new \moodle_exception('cannotaccessgroup', 'grades');
+    }
+}
+$mform = new grade_export_form(null, array('publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true));
+$formdata = $mform->get_data();
+$export = new grade_export_xls($course, $groupid, $formdata);
+
+// If the gradepublishing is enabled and user key is selected print the grade publishing link.
+if (!empty($CFG->gradepublishing) && !empty($key)) {
+    groups_print_course_menu($course, 'index.php?id='.$id);
+    echo $export->get_grade_publishing_url();
+    echo $OUTPUT->footer();
+} else {
+    $event = \gradeexport_xls\event\grade_exported::create(array('context' => $context));
+    $event->trigger();
+    $export->print_grades();
+}
+

grade/export/xls/grade_export_xls.php

@@ -0,0 +1,132 @@
+<?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.'/grade/export/lib.php');
+
+class grade_export_xls extends grade_export {
+
+    public $plugin = 'xls';
+
+    /**
+     * Constructor should set up all the private variables ready to be pulled
+     * @param object $course
+     * @param int $groupid id of selected group, 0 means all
+     * @param stdClass $formdata The validated data from the grade export form.
+     */
+    public function __construct($course, $groupid, $formdata) {
+        parent::__construct($course, $groupid, $formdata);
+
+        // Overrides.
+        $this->usercustomfields = true;
+    }
+
+    /**
+     * To be implemented by child classes
+     */
+    public function print_grades() {
+        global $CFG;
+        require_once($CFG->dirroot.'/lib/excellib.class.php');
+
+        $export_tracking = $this->track_exports();
+
+        $strgrades = get_string('grades');
+
+        // If this file was requested from a form, then mark download as complete (before sending headers).
+        \core_form\util::form_download_complete();
+
+        // Calculate file name
+        $shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id)));
+        $downloadfilename = clean_filename("$shortname $strgrades.xls");
+        // Creating a workbook
+        $workbook = new MoodleExcelWorkbook("-");
+        // Sending HTTP headers
+        $workbook->send($downloadfilename);
+        // Adding the worksheet
+        $myxls = $workbook->add_worksheet($strgrades);
+
+        // Print names of all the fields
+        $profilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields);
+        foreach ($profilefields as $id => $field) {
+            $myxls->write_string(0, $id, $field->fullname);
+        }
+        $pos = count($profilefields);
+        if (!$this->onlyactive) {
+            $myxls->write_string(0, $pos++, get_string("suspended"));
+        }
+        foreach ($this->columns as $grade_item) {
+            foreach ($this->displaytype as $gradedisplayname => $gradedisplayconst) {
+                $myxls->write_string(0, $pos++, $this->format_column_name($grade_item, false, $gradedisplayname));
+            }
+            // Add a column_feedback column
+            if ($this->export_feedback) {
+                $myxls->write_string(0, $pos++, $this->format_column_name($grade_item, true));
+            }
+        }
+        // Last downloaded column header.
+        $myxls->write_string(0, $pos++, get_string('timeexported', 'gradeexport_xls'));
+
+        // Print all the lines of data.
+        $i = 0;
+        $geub = new grade_export_update_buffer();
+        $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()) {
+            $i++;
+            $user = $userdata->user;
+
+            foreach ($profilefields as $id => $field) {
+                $fieldvalue = grade_helper::get_user_field_value($user, $field);
+                $myxls->write_string($i, $id, $fieldvalue);
+            }
+            $j = count($profilefields);
+            if (!$this->onlyactive) {
+                $issuspended = ($user->suspendedenrolment) ? get_string('yes') : '';
+                $myxls->write_string($i, $j++, $issuspended);
+            }
+            foreach ($userdata->grades as $itemid => $grade) {
+                if ($export_tracking) {
+                    $status = $geub->track($grade);
+                }
+                foreach ($this->displaytype as $gradedisplayconst) {
+                    $gradestr = $this->format_grade($grade, $gradedisplayconst);
+                    if (is_numeric($gradestr)) {
+                        $myxls->write_number($i, $j++, $gradestr);
+                    } else {
+                        $myxls->write_string($i, $j++, $gradestr);
+                    }
+                }
+                // writing feedback if requested
+                if ($this->export_feedback) {
+                    $myxls->write_string($i, $j++, $this->format_feedback($userdata->feedbacks[$itemid], $grade));
+                }
+            }
+            // Time exported.
+            $myxls->write_string($i, $j++, time());
+        }
+        $gui->close();
+        $geub->close();
+
+    /// Close the workbook
+        $workbook->close();
+
+        exit;
+    }
+}
+
+

grade/export/xls/index.php

@@ -0,0 +1,69 @@
+<?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 '../../../config.php';
+require_once $CFG->dirroot.'/grade/export/lib.php';
+require_once 'grade_export_xls.php';
+
+$id = required_param('id', PARAM_INT); // course id
+
+$PAGE->set_url('/grade/export/xls/index.php', array('id'=>$id));
+
+if (!$course = $DB->get_record('course', array('id'=>$id))) {
+    throw new \moodle_exception('invalidcourseid');
+}
+
+require_login($course);
+$context = context_course::instance($id);
+
+require_capability('moodle/grade:export', $context);
+require_capability('gradeexport/xls:view', $context);
+
+$actionbar = new \core_grades\output\export_action_bar($context, null, 'xls');
+print_grade_page_head($COURSE->id, 'export', 'xls',
+    get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_xls'),
+    false, false, true, null, null, null, $actionbar);
+export_verify_grades($COURSE->id);
+
+if (!empty($CFG->gradepublishing)) {
+    $CFG->gradepublishing = has_capability('gradeexport/xls:publish', $context);
+}
+
+$actionurl = new moodle_url('/grade/export/xls/export.php');
+$formoptions = array(
+    'publishing' => true,
+    'simpleui' => true,
+    'multipledisplaytypes' => true
+);
+
+$mform = new grade_export_form($actionurl, $formoptions);
+
+$groupmode    = groups_get_course_groupmode($course);   // Groups are being used
+$currentgroup = groups_get_course_group($course, true);
+if ($groupmode == SEPARATEGROUPS and !$currentgroup and !has_capability('moodle/site:accessallgroups', $context)) {
+    echo $OUTPUT->heading(get_string("notingroup"));
+    echo $OUTPUT->footer();
+    die;
+}
+
+groups_print_course_menu($course, 'index.php?id='.$id);
+echo '<div class="clearer"></div>';
+
+$mform->display();
+
+echo $OUTPUT->footer();
+

grade/export/xls/lang/en/gradeexport_xls.php

@@ -0,0 +1,31 @@
+<?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/>.
+
+/**
+ * Strings for component 'gradeexport_xls', language 'en', branch 'MOODLE_20_STABLE'
+ *
+ * @package   gradeexport_xls
+ * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['eventgradeexported'] = 'XLS grade exported';
+$string['pluginname'] = 'Excel spreadsheet';
+$string['privacy:metadata'] = 'The Excel spreadsheet grade export plugin does not store any personal data.';
+$string['timeexported'] = 'Last downloaded from this course';
+$string['xls:publish'] = 'Publish XLS grade export';
+$string['xls:view'] = 'Use Excel grade export';

grade/export/xls/tests/event/events_test.php

@@ -0,0 +1,57 @@
+<?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/>.
+
+namespace gradeexport_xls\event;
+
+/**
+ * XLS grade export events test cases.
+ *
+ * @package    gradeexport_xls
+ * @copyright  2016 Zane Karl zkarl@oid.ucla.edu
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class events_test extends \advanced_testcase {
+
+    /**
+     * Setup is called before calling test case.
+     */
+    public function setUp(): void {
+        $this->resetAfterTest();
+    }
+
+    /**
+     * Test course_module_instance_list_viewed event.
+     */
+    public function test_logging(): void {
+        // There is no proper API to call to trigger this event, so what we are
+        // doing here is simply making sure that the events returns the right information.
+        $course = $this->getDataGenerator()->create_course();
+        $params = array(
+            'context' => \context_course::instance($course->id)
+        );
+        $event = \gradeexport_xls\event\grade_exported::create($params);
+        // Triggering and capturing the event.
+        $sink = $this->redirectEvents();
+        $event->trigger();
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+        // Checking that the event contains the expected values.
+        $this->assertInstanceOf('\gradeexport_xls\event\grade_exported', $event);
+        $this->assertEquals(\context_course::instance($course->id), $event->get_context());
+        $this->assertEquals('xls', $event->get_export_type());
+    }
+}

grade/export/xls/version.php

@@ -0,0 +1,30 @@
+<?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/>.
+
+/**
+ * Version details
+ *
+ * @package    gradeexport
+ * @subpackage xls
+ * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;        // The current plugin version (Date: YYYYMMDDXX).
+$plugin->requires  = 2024041600;        // Requires this Moodle version.
+$plugin->component = 'gradeexport_xls'; // Full name of the plugin (used for diagnostics)